clevertap-react-native 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -1,6 +1,31 @@
 Change Log
 ==========
 
+Version 1.2.1 *(25 October 2023)*
+-------------------------------------------
+**What's new**
+* **[Android Platform]**
+  * Supports [CleverTap Android SDK v5.2.1](https://github.com/CleverTap/clevertap-android-sdk/blob/master/docs/CTCORECHANGELOG.md#version-521-october-12-2023).
+  * Adds Custom Proxy Domain functionality for Push Impressions and Events raised from CleverTap Android SDK. Please refer to [Usage.md](docs/Usage.md#integrate-custom-proxy-domain) file to read more on how to configure custom proxy domains in Android.
+
+* **[iOS Platform]**
+  * Supports [CleverTap iOS SDK v5.2.1](https://github.com/CleverTap/clevertap-ios-sdk/releases/tag/5.2.1).
+  * Adds support to enable `NSFileProtectionComplete` to secure App’s document directory.
+  
+* **[Android and iOS Platform]**
+  * Adds in-built support to send the default locale(i.e.language and country) data to the dashboard and exposed public API `CleverTapPlugin.setLocale(Locale locale)` to set the custom locale, for LP Parity.
+  * Adds support for Integration Debugger to view errors and events on the dashboard when the debugLevel is set to 3 using `CleverTapPlugin.setDebugLevel(3)`.
+  * Adds support to configure first tab title in App Inbox.
+
+**Changes**
+* **[iOS Platform]**
+  * Updated logic to retrieve country code using NSLocale above iOS 16 as `CTCarrier` is deprecated above iOS 16 with no replacements, see [Apple Doc](https://developer.apple.com/documentation/coretelephony/ctcarrier).
+  * Updated logic to not send carrier name above iOS 16 in CTCarrier field.
+
+**Bug Fixes**
+* **[iOS Platform]**
+  * Fixes a crash in iOS 17/Xcode 15 related to alert inapps.
+
 Version 1.2.0 *(18th August 2023)*
 -------------------------------------------
 

package/android/build.gradle

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

package/android/src/main/java/com/clevertap/react/CleverTapModule.java

@@ -177,6 +177,16 @@ public class CleverTapModule extends ReactContextBaseJavaModule implements SyncL
             cleverTap.setCustomSdkVersion(libName,libVersion);
         }
     }
+    
+    @ReactMethod
+    private void setLocale(String locale) {
+        CleverTapAPI cleverTap = getCleverTapAPI();
+        if (cleverTap != null) {
+            cleverTap.setLocale(locale);
+        } else {
+            Log.e(TAG, ErrorMessages.CLEVERTAP_NOT_INITIALIZED.getErrorMessage());
+        }
+    }
 
     @ReactMethod
     public void activate() {
@@ -1998,6 +2008,10 @@ public class CleverTapModule extends ReactContextBaseJavaModule implements SyncL
                     String noMessageTitleColor = styleConfig.getString(styleConfigKey);
                     ctInboxStyleConfig.setNoMessageViewTextColor(noMessageTitleColor);
                 }
+                if ("firstTabTitle".equals(styleConfigKey) && readableType == ReadableType.String) {
+                    String firstTabTitle = styleConfig.getString(styleConfigKey);
+                    ctInboxStyleConfig.setFirstTabTitle(firstTabTitle);
+                }
 
             } catch (Throwable t) {
                 Log.e(TAG, t.getLocalizedMessage());

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.2.0'
+  s.dependency 'CleverTap-iOS-SDK', '5.2.1'
   s.dependency 'React-Core'
 end

package/docs/iospushtemplates.md

@@ -4,34 +4,151 @@ CleverTap Push Templates SDK helps you engage with your users using fancy push n
 
 # Table of contents
 
-- [Installation](#installation)
+- [Notification Service](#notification-service)
+- [Notification Content](#notification-content)
 - [Dashboard Usage](#dashboard-usage)
 - [Template Types](#template-types)
 - [Template Keys](#template-keys)
 
-# Installation
+# Notification Service
 
 [(Back to top)](#table-of-contents)
-- Add Notification Content Extension (Push Templates) in a React Native iOS Project
+## Installation
+- Go to File -> New -> Target -> Notification Service Extension and select Objective-C language
+
+![NotificationServiceTarget](https://github.com/CleverTap/clevertap-react-native/blob/master/static/NotificationServiceTarget.png)
+- Update Podfile as below and do `pod install`, refer [example](https://github.com/CleverTap/clevertap-react-native/blob/master/Example/ios/Podfile) for detailed Podfile.
+```
+target 'NotificationService' do
+  pod "CTNotificationService", :modular_headers => true
+end
+```
+- Update your `NotificationService.h` as:
+```
+#import <CTNotificationService/CTNotificationService.h>
+
+@interface NotificationService : CTNotificationServiceExtension
+@end
+```
+- Update your `NotificationService.m` file as:
+```
+#import "NotificationService.h"
+
+@implementation NotificationService
+
+- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
+  [super didReceiveNotificationRequest:request withContentHandler:contentHandler];
+}
+
+@end
+```
+
+## Push Impression
+- Add `pod "CleverTap-iOS-SDK" ` in podfile for notification service target as do `pod install`:
+```
+target 'NotificationService' do
+  pod "CleverTap-iOS-SDK", :modular_headers => true
+  pod "CTNotificationService", :modular_headers => true
+end
+```
+- Add CleverTap Account Id and Token in target `Info.plist` file as updated [here](https://github.com/CleverTap/clevertap-react-native/tree/master/Example/ios/Example/NotificationService/Info.plist)
+- Update your `NotificationService.m` file as:
+```
+#import "NotificationService.h"
+#import <CleverTap-iOS-SDK/CleverTap.h>
+
+@implementation NotificationService
+
+- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
+  // Add CleverTap Account ID and Account token in your target .plist file
+  [CleverTap setDebugLevel:2];
+  NSDictionary *profile = @{
+                              @"Name": @"testUserA1",
+                              @"Identity": @123456,
+                              @"Email": @"test@test.com"
+  };
+  [[CleverTap sharedInstance] profilePush:profile];
+  [[CleverTap sharedInstance] recordNotificationViewedEventWithData: request.content.userInfo];
+
+  [super didReceiveNotificationRequest:request withContentHandler:contentHandler];
+}
+
+@end
+```
+
+- Refer [example](https://github.com/CleverTap/clevertap-react-native/tree/master/Example/ios/Example/NotificationService) for more details if you are using Objective-C language for the target.
+
+## Add Notification Service target using Swift language
+- Go to File -> New -> Target -> Notification Service Extension and select Swift language
+- Update Podfile as below and `pod install`:
+```
+target 'NotificationService' do
+  pod "CTNotificationService", :modular_headers => true
+end
+```
+- Update your `NotificationService.swift` as
+```
+import CTNotificationService
+
+class NotificationService: CTNotificationServiceExtension {
+  override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
+    super.didReceive(request, withContentHandler: contentHandler)
+  }
+}
+```
+
+## Push Impression using Swift language target
+- Add `pod "CleverTap-iOS-SDK" ` in podfile for notification service target and do `pod install` as
+```
+target 'NotificationService' do
+  pod "CleverTap-iOS-SDK", :modular_headers => true
+  pod "CTNotificationService", :modular_headers => true
+end
+```
+- Add CleverTap Account Id and Token in target `Info.plist` file as updated [here](https://github.com/CleverTap/clevertap-react-native/tree/master/Example/ios/Example/NotificationService/Info.plist)
+- Update your `NotificationService.swift` file as:
+```
+import CTNotificationService
+import CleverTapSDK
+
+class NotificationService: CTNotificationServiceExtension {
+  override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
+    let profile: Dictionary<String, AnyObject> = [
+      "Name": "testUserA1" as AnyObject,
+      "Identity": 123456 as AnyObject,
+      "Email": "test@test.com" as AnyObject ]
+    CleverTap.sharedInstance()?.profilePush(profile)
+    CleverTap.sharedInstance()?.recordNotificationViewedEvent(withData: request.content.userInfo)
+    super.didReceive(request, withContentHandler: contentHandler)
+  }
+}
+```
+
+# Notification Content
+
+[(Back to top)](#table-of-contents)
+
+Add Notification Content Extension (Push Templates) in a React Native iOS Project
 Notification Content Extension is an app extension that provides a custom interface when a user previews your notification in the notification center. To enable the functionality of CleverTap iOS Push templates, we need this extension in the project which act as subclass to our CTNotificationContent framework.
 
-Open Example.xcodeproj (or your app’s .xcodeproj file) in the ios folder of React Native project. Go to File > New > Target… and search with the name “Notification Content Extension“
+## Installation
+- Open Example.xcodeproj (or your app’s .xcodeproj file) in the ios folder of React Native project. 
+- Go to File > New > Target… and search with the name “Notification Content Extension“
 
 ![NotificationContentTarget](https://github.com/CleverTap/clevertap-react-native/blob/task/SDK-2395-RN-pushtemplates-support/static/NotificationContentTarget.png)
 
-Add “Notification Content“ as target name.
+- Add “Notification Content“ as target name.
 
 ![NotificationContent](https://github.com/CleverTap/clevertap-react-native/blob/task/SDK-2395-RN-pushtemplates-support/static/NotificationContent.png)
 
-Refer to https://github.com/CleverTap/CTNotificationContent#-setup for setting up Notification Content target so that it imports CTNotificationContent framework in the code. Make sure to add the necessary key-values in  the Info.plist file of NotificationContent target so that it recognises the identifier of the incoming notification.  
+- Refer to https://github.com/CleverTap/CTNotificationContent#-setup for setting up Notification Content target so that it imports CTNotificationContent framework in the code. Make sure to add the necessary key-values in  the Info.plist file of NotificationContent target so that it recognises the identifier of the incoming notification.  
 
 Alternatively, go to finder and replace newly created NotificationContent  (or your content extension) folder with the NotificationContent folder in CTNotificationContent Example project repository.
 
 ![Finder](https://github.com/CleverTap/clevertap-react-native/blob/task/SDK-2395-RN-pushtemplates-support/static/Finder.png)
 
-Add the following to a file named Podfile in the ios directory of your project.
+- Add the following to a file named Podfile in the ios directory of your project.
 ```
-use_frameworks!
 target 'NotificationContent' do
     pod 'CTNotificationContent'
 end
@@ -139,6 +256,22 @@ target 'reactnativedemo' do
 end
 ```
 
+- Edit the Maininterface.storyboard in your NotificationContent target to a plain UIView. Steps: 
+  MainInterface.storyboard -> Expand View -> Click Label -> Delete
+
+![NotificationContentStoryboard](https://github.com/CleverTap/clevertap-react-native/blob/master/static/NotificationContentStoryboard.png)  
+
+- Update NotificationViewController.h, NotificationViewController.m and Info.plist as updated in [example app](https://github.com/CleverTap/clevertap-react-native/tree/master/Example/ios/Example/NotificationContent)
+- Set Notification categories from AppDelegate if you want to add category buttons in `didFinishLaunchingWithOptions:` method and add import `#import <UserNotifications/UserNotifications.h>`:
+```
+UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
+UNNotificationAction *action1 = [UNNotificationAction actionWithIdentifier:@"action_1" title:@"Back" options:UNNotificationActionOptionNone];
+UNNotificationAction *action2 = [UNNotificationAction actionWithIdentifier:@"action_2" title:@"Next" options:UNNotificationActionOptionNone];
+UNNotificationAction *action3 = [UNNotificationAction actionWithIdentifier:@"action_3" title:@"View In App" options:UNNotificationActionOptionNone];
+UNNotificationCategory *cat = [UNNotificationCategory categoryWithIdentifier:@"CTNotification" actions:@[action1, action2, action3] intentIdentifiers:@[] options:UNNotificationCategoryOptionNone];
+[center setNotificationCategories:[NSSet setWithObjects:cat, nil]];
+```
+
 ### Out of the box
 
 

package/docs/usage.md

@@ -66,6 +66,41 @@ CleverTap.profileDecrementValueForKey(1, "score");
 
 -----------
 
+## Integrate Custom Proxy Domain
+The custom proxy domain feature allows to proxy all events raised from the CleverTap SDK through your required domain,
+ideal for handling or relaying CleverTap events and Push Impression events with your application server.
+Refer following steps to configure the custom proxy domain(s) in the manifest file:
+
+#### [Android Platform] Configure Custom Proxy Domain(s) using Manifest file
+1. Add your CleverTap Account credentials in the Manifest file against the `CLEVERTAP_ACCOUNT_ID` and `CLEVERTAP_TOKEN` keys.
+2. Add the **CLEVERTAP_PROXY_DOMAIN** key with the proxy domain value for handling events through the custom proxy domain.
+3. Add the **CLEVERTAP_SPIKY_PROXY_DOMAIN** key with proxy domain value for handling push impression events.
+
+```xml
+        <meta-data
+            android:name="CLEVERTAP_ACCOUNT_ID"
+            android:value="YOUR ACCOUNT ID" />
+        <meta-data
+            android:name="CLEVERTAP_TOKEN"
+            android:value="YOUR ACCOUNT TOKEN" />
+        <meta-data
+            android:name="CLEVERTAP_PROXY_DOMAIN"
+            android:value="YOUR PROXY DOMAIN"/>  <!-- e.g., analytics.sdktesting.xyz -->
+        <meta-data
+            android:name="CLEVERTAP_SPIKY_PROXY_DOMAIN"
+            android:value="YOUR SPIKY PROXY DOMAIN"/>  <!-- e.g., spiky-analytics.sdktesting.xyz -->
+```
+#### [iOS Platform] Configure Custom Proxy Domain(s) using `CleverTap.autoIntegrate()` API
+1. Add your CleverTap Account credentials in the *Info.plist* file against the `CleverTapAccountID` and `CleverTapToken` keys.
+2. Add the `CleverTapProxyDomain` key with the proxy domain value for handling events through the custom proxy domain e.g., *analytics.sdktesting.xyz*.
+3. Add the `CleverTapSpikyProxyDomain` key with proxy domain value for handling push impression events e.g., *spiky-analytics.sdktesting.xyz*.
+4. Import the CleverTap SDK in your *AppDelegate* file and call the following method in the `didFinishLaunchingWithOptions:` method.
+    ``` swift
+      CleverTap.autoIntegrate()
+    ```
+
+-----------
+
 ## User Events
 
 #### Record an event  
@@ -120,7 +155,7 @@ CleverTap.initializeInbox();
 ```javascript
 CleverTap.showInbox({'tabs':['Offers','Promotions'],'navBarTitle':'My App Inbox','navBarTitleColor':'#FF0000','navBarColor':'#FFFFFF','inboxBackgroundColor':'#AED6F1','backButtonColor':'#00FF00'
                                 ,'unselectedTabColor':'#0000FF','selectedTabColor':'#FF0000','selectedTabIndicatorColor':'#000000',
-                                'noMessageText':'No message(s)','noMessageTextColor':'#FF0000'});
+                                'noMessageText':'No message(s)','noMessageTextColor':'#FF0000','firstTabTitle':'First Tab' });
  ```
 
 #### App Inbox Item Click Callback

package/index.d.ts

@@ -32,6 +32,12 @@
     */
    export function getInitialUrl(callback: Callback): void;
 
+  /**
+   * Call this method to set Locale. If Language is english and country is US the locale format which you can set is en_US
+   * @param locale {string}
+   */
+   export function setLocale(locale: string): void;
+
   /*******************
    * Personalization
    ******************/

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 = 10200; 
+const libVersion = 10201; 
 CleverTapReact.setLibrary(libName,libVersion);
 
 function defaultCallback(method, err, res) {
@@ -109,6 +109,14 @@ var CleverTap = {
         callWithCallback('getInitialUrl', null, callback);
     },
 
+    /**
+    * Call this method to set Locale. If Language is english and country is US the locale format which you can set is en_US
+    * @param {string} locale - the locale string
+    */
+    setLocale: function (locale) {
+        CleverTapReact.setLocale(locale);
+    },
+    
     /**
     * Registers the application to receive push notifications
     * only necessary for iOS.

package/ios/CleverTapReact/CleverTapReact.m

@@ -119,6 +119,12 @@ RCT_EXPORT_METHOD(setLibrary:(NSString*)name andVersion:(int)version) {
     [[self cleverTapInstance] setCustomSdkVersion:name version:version];
 }
 
+RCT_EXPORT_METHOD(setLocale:(NSString*)locale) {
+    RCTLogInfo(@"[CleverTap setLocale:%@]", locale);
+    NSLocale *userLocale = [NSLocale localeWithLocaleIdentifier:locale];
+    [[self cleverTapInstance] setLocale:userLocale];
+}
+
 #pragma mark - Push Notifications
 
 RCT_EXPORT_METHOD(registerForPush) {
@@ -683,6 +689,10 @@ RCT_EXPORT_METHOD(showInbox:(NSDictionary*)styleConfig) {
     if (noMessageText) {
         _config.noMessageViewText = noMessageText;
     }
+    NSString *firstTabTitle = [dict valueForKey:@"firstTabTitle"];
+    if (firstTabTitle) {
+        _config.firstTabTitle = firstTabTitle;
+    }
     return _config;
 }
 - (UIColor *)ct_colorWithHexString:(NSString *)string alpha:(CGFloat)alpha{

package/ios/CleverTapReact.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:">
+   </FileRef>
+</Workspace>

package/ios/CleverTapReact.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

package/ios/CleverTapReact.xcodeproj/xcuserdata/kushagra.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>SchemeUserState</key>
+	<dict>
+		<key>CleverTapReact.xcscheme_^#shared#^_</key>
+		<dict>
+			<key>orderHint</key>
+			<integer>0</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

package/package.json

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

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

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