clevertap-react-native 1.1.2 → 1.2.0

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

package/CHANGELOG.md

@@ -1,6 +1,41 @@
 Change Log
 ==========
 
+Version 1.2.0 *(18th August 2023)*
+-------------------------------------------
+
+**What's new**
+
+* **[Android Platform]**
+  * Supports [CleverTap Android SDK v5.2.0](https://github.com/CleverTap/clevertap-android-sdk/blob/master/docs/CTCORECHANGELOG.md#version-520-august-10-2023).
+  * ***Note: RenderMax Push SDK functionality is now supported directly within the CleverTap Core SDK***. Please remove the [integrated RenderMax SDK](https://developer.clevertap.com/docs/react-native-push-notification#integrate-rendermax-push-sdk-with-react-native) before you upgrade to CleverTap React Native SDK for this version.
+  * Adds support for developer defined default notification channel. Please refer to the [Usage.md](https://github.com/CleverTap/clevertap-react-native/blob/master/docs/usage.md#default-notification-channel) file to read more on how to setup default channel in your app. Also please note that this is only supported for CleverTap core notifications. Support for push templates will be released soon.
+
+* **[iOS Platform]**
+  * Supports [CleverTap iOS SDK v5.2.0](https://github.com/CleverTap/clevertap-ios-sdk/releases/tag/5.2.0).
+
+* **[Android and iOS Platform]**
+  * Adds support for encryption of PII data wiz. Email, Identity, Name and Phone. Please refer to [Usage.md](https://github.com/CleverTap/clevertap-react-native/blob/master/docs/usage.md#encryption-of-pii-data) file to read more on how to enable/disable encryption of PII data.
+  * Adds support for custom KV pairs common to all inbox messages in App Inbox.
+
+**API Changes**
+* **[Android Platform]**
+  * Adds `SCCampaignOptOut` Event to Restricted Events Name List for **internal use**.
+  * Adds custom sdk versions to `af` field for **internal use**.
+
+**Breaking API Changes**
+* **[Android Platform]**
+  * **CTFlushPushImpressionsWork breaks custom WorkerFactory implementation of an App**:
+    * If you are using custom `WorkFactory` implementation of `WorkManager` for Android platform then make sure that you correctly handle workers defined by CleverTap SDK and other third party dependencies.
+    * You must return `null` from `createWorker()` for any unknown workerClassName. Please check implementation provided in the blog [here](https://medium.com/androiddevelopers/customizing-workmanager-fundamentals-fdaa17c46dd2).
+
+**Bug Fixes**
+* **[Android Platform]**
+  * Fixes [#393](https://github.com/CleverTap/clevertap-android-sdk/issues/393) - push permission flow crash when context in CoreMetadata is null.
+  * Fixes [#428](https://github.com/CleverTap/clevertap-android-sdk/issues/428) - Race-condition when detecting if an in-app message should show.
+  * Fixes Push primer alert dialog freeze behavior, which became unresponsive when clicked outside the window.
+  * Fixes a bug where addMultiValueForKey and addMultiValuesForKey were overwriting the current values of the user properties instead of appending it.
+
 Version 1.1.2 *(31st July 2023)*
 -------------------------------------------
 **New Updates**

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Wed May 24 10:54:09 IST 2023
+gradle.version=6.1.1

package/android/build.gradle

@@ -21,8 +21,8 @@ android {
     defaultConfig {
         minSdkVersion 19
         targetSdkVersion 33
-        versionCode 111
-        versionName "1.1.1"
+        versionCode 120
+        versionName "1.2.0"
     }
     buildTypes {
         release {
@@ -39,7 +39,7 @@ dependencies {
         maven { url "$rootDir/../node_modules/react-native/android" }
     }
 
-    api 'com.clevertap.android:clevertap-android-sdk:5.0.0'
+    api 'com.clevertap.android:clevertap-android-sdk:5.2.0'
     implementation 'com.android.installreferrer:installreferrer:2.2'
     //compile 'com.android.support:appcompat-v7:28.0.0'
     implementation 'com.facebook.react:react-native:+'

package/clevertap-react-native.podspec

@@ -18,6 +18,6 @@ Pod::Spec.new do |s|
   s.preserve_paths = 'LICENSE.md', 'README.md', 'package.json', 'index.js'
   s.source_files   = 'ios/CleverTapReact/*.{h,m}'
 
-  s.dependency 'CleverTap-iOS-SDK', '5.1.2'
+  s.dependency 'CleverTap-iOS-SDK', '5.2.0'
   s.dependency 'React-Core'
 end

package/docs/usage.md

@@ -88,6 +88,25 @@ CleverTap.recordChargedEvent({'totalValue': 20, 'category': 'books'}, [{'title':
 
 -----------
 
+## Encryption of PII data
+PII data is stored across the SDK and could be sensitive information. From CleverTap SDK v5.2.0 onwards, you can enable encryption for PII data wiz. Email, Identity, Name and Phone.
+
+Currently 2 levels of encryption are supported i.e None(0) and Medium(1). Encryption level is None by default.
+**None** - All stored data is in plaintext
+**Medium** - PII data is encrypted completely.
+
+#### Android
+Add encryption level in the `AndroidManifest.xml` as following:
+```XML
+<meta-data
+    android:name="CLEVERTAP_ENCRYPTION_LEVEL"
+    android:value="1" />
+```
+#### iOS
+Add the `CleverTapEncryptionLevel` String key to `info.plist` file where value 1 means Medium and 0 means None. Encryption Level will be None if any other value is provided.
+
+-----------
+
 ## App Inbox
 
 #### Initialize the CleverTap App Inbox Method
@@ -213,6 +232,19 @@ Follow the [Push Primer integration doc](pushprimer.md).
 CleverTap.createNotificationChannel("CtRNS", "Clever Tap React Native Testing", "CT React Native Testing", 1, true);			
 ```
 
+#### Default Notification Channel
+Starting from CleverTap React Native SDK v1.2.0, we have introduced a new feature that allows developers to define a default notification channel for their app. This feature provides flexibility in handling push notifications. Please note that this is only supported for clevertap core notifications. Support for push templates will be released soon. To specify the default notification channel ID, you can add the following metadata in your app's manifest file:
+
+```XML
+<meta-data android:name="CLEVERTAP_DEFAULT_CHANNEL_ID" android:value="your_default_channel_id" />
+```
+
+By including this metadata, you can define a specific notification channel that CleverTap will use if the channel provided in push payload is not registered by your app. This ensures that push notifications are displayed consistently even if the app's notification channels are not set up.
+
+In case the SDK does not find the default channel ID specified in the manifest, it will automatically fallback to using a default channel called "Miscellaneous". This ensures that push notifications are still delivered, even if no specific default channel is specified in the manifest.
+
+This enhancement provides developers with greater control over the default notification channel used by CleverTap for push notifications, ensuring a seamless and customizable user experience.
+
 #### Delete Notification Channel
 
 ```javascript 

package/index.js

@@ -9,7 +9,7 @@ const EventEmitter = NativeModules.CleverTapReactEventEmitter ? new NativeEventE
 * @param {int} libVersion - The updated library version. If current version is 1.1.0 then pass as 10100  
 */
 const libName = 'React-Native';
-const libVersion = 10102; 
+const libVersion = 10200; 
 CleverTapReact.setLibrary(libName,libVersion);
 
 function defaultCallback(method, err, res) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clevertap-react-native",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "CleverTap React Native SDK.",
   "main": "index.js",
   "types": "index.d.ts",