Skip to content

Commit

Permalink
all: prepare for 3.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
abarisain committed Jun 11, 2021
1 parent 764dc52 commit c62e0f2
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 4 deletions.
45 changes: 43 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,54 @@
Batch Cordova Plugin

## UPCOMING
## 3.0.0

**User**
This is a major release with breaking changes. Please see the [migration guide](https://doc.batch.com/cordova/advanced/2x-migration) for more info.

**Plugin**

- Renamed the plugin to `@batch.com/cordova-plugin`. It's cordova internal name is still `com.batch.cordova` due to cordova limitations.
The plugin cordova name is used when managing plugins after installation.
- Updated plugin for recent Cordova/Ionic versions.
Batch Cordova's new version requirements are:
- iOS >= 10.0
- Android >= 5.0 (API 21)
- Cordova CLI >= 9.0.0
- Ionic CLI (if used) >= 6.0.0
- cordova-android >= 9.0.0
- cordova-iOS >= 6.0.0
- Updated native Batch SDK to 1.17.0.
Native SDK version can be configured using the `BATCHSDK_ANDROID_VERSION` and `BATCHSDK_IOS_VERSION` preferences.
Please note that this version of the plugin will not work with earlier native Batch SDK versions.
- Added Ionic Capacitor support. Requires Capacitor 2.4 or higher.
- Fixed an issue where Cordova/Ionic would not properly write the required AndroidManifest lines.
- Added support for dates in event data.
- Removed event data tags/attributes limits from the Cordova plugin.
This does not mean that those limits are gone, but that the native SDK will now enforce them so that the plugin doesn't have to be updated if and then these limits change.
Current native limits are 15 attributes and 10 tags.

**Android**

- The plugin requires AndroidX to be enabled in your `config.xml` using `<preference name="AndroidXEnabled" value="true" />` (Cordova only).
Ionic users will need to add `cordova-plugin-androidx-adapter`.
- The plugin doesn't depend on Firebase and appcompat anymore. Batch expects androidx.appcompat and Firebase Cloud Messaging to be in your application.
This can be setup using the Firebase plugin of your choice:
- We recommend `cordova-plugin-firebase-messaging` for Cordova.
If you do not want to add Firebase to your iOS app, manual FCM integration steps are available in our integration documentation.
- Capacitor comes with appcompat and FCM support out of the box, no extra plugin is needed.

You will also be required to configure your `google-services.json` manually: this is described in the integration documentation and should be covered by your Firebase plugin's documentation.

**iOS**

- The native SDK isn't bundled anymore: Cocoapods is now used to integrate Batch's native component.
- The plugin now automatically sets a UNUserNotificationCenterDelegate to handle new iOS features.
This enables configuration of foreground push behaviour: they can now be displayed in an alert just like if the user was outside of the application.
It can be disabled by calling `BatchBridgeNotificationCenterDelegate.automaticallyRegister = false` as soon as possible in `application:didFinishLaunchingWithOptions:`.
- Fixed a bug where notification opens on cold start would not work.
- Fixed multiple mobile landings related bugs.
- Fixed multiple `batchPushReceived` related bugs.
- Fixed an issue where boolean custom data was saved as integers.

## 3.0.0-beta.2

Rerelease of 3.0.0-beta.1, fixing a NPM packaging issue.
Expand Down
2 changes: 1 addition & 1 deletion dist/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@batch.com/cordova-plugin",
"version": "3.0.0-beta.2",
"version": "3.0.0",
"description": "Batch.com SDK Cordova/Ionic plugin for Android and iOS",
"types": "index.d.ts",
"cordova": {
Expand Down
2 changes: 1 addition & 1 deletion dist/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
xmlns:android="http://schemas.android.com/apk/res/android"
id="com.batch.cordova"
version="3.0.0-beta.2">
version="3.0.0">
<engines>
<engine name="cordova" version=">=9.0.0" />
<engine name="cordova-android" version=">=9.0.0" />
Expand Down

0 comments on commit c62e0f2

Please sign in to comment.