@selligent-marketing-cloud/selligent-react-native 3.2.7 → 3.3.1

package/README.md

@@ -2,21 +2,22 @@
 
 This module provides an API for the usage of the Selligent Mobile SDKs in React Native.
 
-# SelligentMobileSDK-ReactNative Integration
-This module uses the native Selligent SDKs:
+## SelligentMobileSDK-ReactNative Integration
 
-| SDK                                                                     | Version |
-| ----------------------------------------------------------------------- | ------- |
-| [Android](https://github.com/SelligentMarketingCloud/MobileSDK-Android) | 4.2.0  |
-| [iOS](https://github.com/SelligentMarketingCloud/MobileSDK-iOS)         | 3.5.1   |
+This module supports the following SDK and tools:
 
+> **IMPORTANT** This module doesn't currently support REACT NATIVE'S NEW ARCHITECTURE! The following library contains React native modules, that are tailored to and can only be used in React Native's legacy architecture, that will be deprecated in the future when the new architecture will be stable.
 
-> **IMPORTANT:** Since version 2.6.0 of this module we require your app to use the Android Gradle Plugin version 4.2.0 or higher in order to build on Android. This is the default Android Gradle Plugin version since React Native version 0.64.0 but can be manually increased in older versions of React Native.
-
-> **IMPORTANT** Since version 2.10.0 of this module, we support React Native v0.70, but NOT REACT NATIVE'S NEW ARCHITECTURE! The following library contains React native modules, that are tailored to and can only be used in React Native's legacy architecture, that will be deprecated in the future when the new architecture will be stable.
+| SDK                                                                            | Version |
+| ------------------------------------------------------------------------------ | ------- |
+| [Android SDK](https://github.com/SelligentMarketingCloud/MobileSDK-Android)    | 4.3.0   |
+| [iOS SDK](https://github.com/SelligentMarketingCloud/MobileSDK-iOS)            | 3.6.1   |
+| ReactNative                                                                    | 0.71.8  |
+| Expo SDK                                                                       | 48      |
 
 ## Installation
-> Please refer to our <a href="documentation/#reactnative--using-the-sdk">SDK full documentation</a> for a step-by-step guide on how to use the SDK, after installation.
+
+> Please refer to our [SDK full documentation](documentation/#reactnative--using-the-sdk) for a step-by-step guide on how to use the SDK, after installation.
 
 1. Install the module
 
@@ -36,10 +37,12 @@ This module uses the native Selligent SDKs:
    }
    ```
 
-> Check all the options that can be used in our <a href="documentation/#selligent_json">SDK full documentation</a>
+> Check all the options that can be used in our [SDK full documentation](documentation/#working-with-the-selligentjson)
 
 ### Android Specific Installation
 
+> **IMPORTANT:** Since version 2.6.0 of this module we require your app to use the Android Gradle Plugin version 4.2.0 or higher in order to build on Android. This is the default Android Gradle Plugin version since React Native version 0.64.0 but can be manually increased in older versions of React Native.
+
 > ### **Attention for Huawei developers!**
 >
 > In order to use this module on Huawei devices (without Goggle Play services), you should add the following dependencies in the `build.gradle` files of the Android project in your React Native project:
@@ -153,7 +156,7 @@ This module uses the native Selligent SDKs:
    ```
 
 </details>
-<br>
+
 <details open>
 <summary>With autolinking (RN 0.60 and above)</summary>
 
@@ -172,14 +175,14 @@ This module uses the native Selligent SDKs:
    }
    ```
 
-4. Add the following in the `android/app/build.gradle` file (at the bottom):
+3. Add the following in the `android/app/build.gradle` file (at the bottom):
 
    ```groovy
    // Add the following:
    apply plugin: 'com.google.gms.google-services'
    ```
 
-5. Add the following in the `android/app/src/../MainApplication.java` file:
+4. Add the following in the `android/app/src/../MainApplication.java` file:
 
     ```java
     // Add the following import statements:
@@ -196,6 +199,7 @@ This module uses the native Selligent SDKs:
         }
     }
     ```
+
 </details>
 
 ### iOS Specific installation
@@ -209,7 +213,7 @@ This module uses the native Selligent SDKs:
 
     > Do not check the "copy if needed" option to make sure you only have to manage one selligent.json file
 
-3. Add the native iOS SDK dependency in your Podfile: `s.dependency "SelligentMobileSDK/Framework", "3.5.1"` or download it manually from [here](https://github.com/SelligentMarketingCloud/MobileSDK-iOS/tree/master/Framework) and drag and drop it into you **Xcode project**.
+3. Add the native iOS SDK dependency in your Podfile: `s.dependency "SelligentMobileSDK/Framework", "3.6.1"` or download it manually from [here](https://github.com/SelligentMarketingCloud/MobileSDK-iOS/tree/master/Framework) and drag and drop it into you **Xcode project**.
 
 4. Execute `pod install` in the `/ios` folder
 
@@ -230,7 +234,7 @@ This module uses the native Selligent SDKs:
     ```
 
 </details>
-<br>
+
 <details open>
 <summary>With autolinking (RN 0.60 and above)</summary>
 
@@ -251,4 +255,4 @@ This module uses the native Selligent SDKs:
     [RNSelligent configureWithLaunchOptions:launchOptions];
     ```
 
-</details>
+</details>

package/RNSelligentMapper.podspec

@@ -0,0 +1,22 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name          = "RNSelligentMapper"
+  s.authors       = package['author']
+  s.version       = package["version"]
+  s.summary       = package["description"]
+  s.description   = "React Native wrapper mapper for the Selligent Marketing Cloud Android and iOS SDKs"
+  s.homepage      = package['homepage']
+  s.license       = "MIT"
+  s.platform      = :ios, "12.0"
+  s.source        = { :git => "https://github.com/SelligentMarketingCloud/MobileSDK-ReactNative.git", :tag => "v" + s.version.to_s }
+  s.swift_version = "5.0"
+  
+  s.source_files  = "ios/*.{h,m}"
+  
+  s.dependency "React-Core"
+  s.dependency "RNSelligent"
+end
+	

package/android/build.gradle

@@ -53,7 +53,7 @@ dependencies {
         exclude group:'com.facebook.fbjni'
         exclude group:'com.facebook.yoga'
     }
-    implementation 'com.selligent.sdk:selligent_mobile_sdk:4.2.0'
+    implementation 'com.selligent.sdk:selligent_mobile_sdk:4.3.0'
     implementation 'com.google.code.gson:gson:2.9.0'
     implementation 'com.google.firebase:firebase-messaging:23.0.8'
     implementation 'androidx.work:work-runtime:2.8.1'

package/android/src/main/java/com/selligent/RNSelligent.java

@@ -101,7 +101,7 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
             inAppMessageRefreshType = settings.getInAppMessageRefreshType().getSmInAppRefreshType();
 
             final SMManager smManager = getSMManager();
-            SMManager.DEBUG = BuildConfig.BUILD_TYPE.equals("debug");
+            SMManager.DEBUG = BuildConfig.BUILD_TYPE.equals("debug") || settings.getEnableAndroidLogging();
             smManager.start(smSettings, application);
 
             final Resources resources = application.getResources();
@@ -346,6 +346,10 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
         }
     }
 
+    public static void enableNotifications() {
+        SMManager.getInstance().enableNotifications();
+    }
+
     @ReactMethod
     public void displayLastReceivedRemotePushNotification(String templateId) {
         final Activity currentActivity = getCurrentActivity();

package/android/src/main/java/com/selligent/Settings.java

@@ -22,6 +22,7 @@ class Settings {
     private String notificationChannelId = "SMChannel001";
     private String notificationChannelName = "SMDefaultChannel";
     private String notificationChannelDescription = "";
+    private Boolean enableAndroidLogging = false;
 
     private Settings() { }
 
@@ -85,6 +86,8 @@ class Settings {
         return notificationChannelDescription;
     }
 
+    public Boolean getEnableAndroidLogging() { return enableAndroidLogging; }
+
     public static Settings fromHashMap(Map<String, Object> settingsHashMap) {
         final Settings settings = new Settings();
 
@@ -101,7 +104,7 @@ class Settings {
             settings.notificationLargeIcon = (String) settingsHashMap.get("notificationLargeIcon");
         }
 
-        if(settingsHashMap.containsKey("notificationIconColor")) {
+        if (settingsHashMap.containsKey("notificationIconColor")) {
             settings.notificationIconColor = (String) settingsHashMap.get("notificationIconColor");
         }
 
@@ -120,24 +123,33 @@ class Settings {
         if (settingsHashMap.containsKey("loadCacheAsynchronously")) {
             settings.loadCacheAsynchronously = (Boolean) settingsHashMap.get("loadCacheAsynchronously");
         }
+
         if (settingsHashMap.containsKey("notificationChannelId")) {
             settings.notificationChannelId = (String) settingsHashMap.get("notificationChannelId");
         }
+
         if (settingsHashMap.containsKey("notificationChannelName")) {
             settings.notificationChannelName = (String) settingsHashMap.get("notificationChannelName");
         }
+
         if (settingsHashMap.containsKey("notificationChannelDescription")) {
             settings.notificationChannelDescription = (String) settingsHashMap.get("notificationChannelDescription");
         }
 
+        if (settingsHashMap.containsKey("enableAndroidLogging")) {
+            settings.enableAndroidLogging = (Boolean) settingsHashMap.get("enableAndroidLogging");
+        }
+
         final Double clearCacheIndex = (Double) settingsHashMap.get("clearCacheIntervalValue");
         if (clearCacheIndex != null) {
             settings.clearCacheIntervalValue = ClearCacheIntervalValue.valueOf(clearCacheIndex.intValue());
         }
+
         final Double inAppMsgRefreshIndex =  (Double) settingsHashMap.get("inAppMessageRefreshType");
         if (inAppMsgRefreshIndex != null) {
             settings.inAppMessageRefreshType = InAppMessageRefreshType.valueOf(inAppMsgRefreshIndex.intValue());
         }
+
         final Double remoteMsgRefreshIndex =  (Double) settingsHashMap.get("remoteMessageDisplayType");
         if (remoteMsgRefreshIndex != null) {
             settings.remoteMessageDisplayType = RemoteMessageDisplayType.valueOf(remoteMsgRefreshIndex.intValue());

package/documentation/README.md

@@ -25,6 +25,7 @@ Selligent welcomes any recommendations or suggestions regarding the manual, as i
   - [Push notifications](#push-notifications)
     - [Rich Push Notifications](#rich-push-notifications)
     - [Deep Linking](#deep-linking)
+      - [Background Modes](#background-modes)
       - [Universal Linking - iOS](#universal-linking---ios)
     - [Notification helper methods](#notification-helper-methods)
       - [Disable Selligent Push Notifications](#disable-selligent-push-notifications)
@@ -73,7 +74,9 @@ The following properties can be used in the `selligent.json` to further configur
 | remoteMessageDisplayType                    | [enum](#remotemessagesdisplaytype) | The behaviour when receiving a push notification with the app in foreground |
 | appGroupId                                  | string |(iOS Only) The appgroup id necessary for the correct communication between the app and the app extensions |
 | shouldClearBadge                            | boolean | (iOS Only) Whether or not, clicking a push notification should reset the badge number |
-| shouldDisplayRemoteNotification             | boolean | (iOS Only) Whether or not, the SDK should try to display the content linked to a push message (usually, inapp messages) or it will be handled customly |
+| shouldDisplayRemoteNotification             | boolean | (iOS Only) Whether or not, the SDK should try to display the content linked to a push message (usually, inapp messages) or it will be handled customly 
+| enableiOSLogging                            | [enum](#iosloglevel) | Log level used since the app launch |
+| enableAndroidLogging                        | boolean | (Android Only) Whether or not, the SDK logging will be enabled since the app launch |
 | doNotListenToThePush                        | boolean | (Android Only) Whether or not, the SDK will listen for pushs from google |
 | doNotFetchTheToken                          | boolean | (Android Only) Whether or not, the SDK will listen for push tokens from google |
 | loadCacheAsynchronously                     | boolean | (Android Only) Whether or not, the SDK load the cache asynchronously |
@@ -89,7 +92,44 @@ The following properties can be used in the `selligent.json` to further configur
 
 Follow the [iOS](https://github.com/SelligentMarketingCloud/MobileSDK-iOS/tree/master/Documentation#create-an-apns-key) & [Android](https://github.com/SelligentMarketingCloud/MobileSDK-Android/tree/master/Documentation#creating-an-application) native SDKs guides in order to optin for push notifications in Apple & Google.
 
-**For iOS**, there are some extra steps you need to follow in the native part of the ReactNative project:
+**For Android**, if targeting API level 33 and above:
+1. Add this to request the push permission and let the SDK know when it is accepted, in the activity where you want to:
+```java
+import com.selligent.RNSelligent;
+
+public class MainActivity extends ReactActivity {
+  final int NOTIFICATION_PERMISSION_REQUEST_CODE = 1111;
+
+  @Override
+  public void onStart()
+  {
+    if (Build.VERSION.SDK_INT > Build.VERSION_CODES.S_V2)
+    {
+      if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) != PackageManager.PERMISSION_GRANTED)
+      {
+        ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.POST_NOTIFICATIONS}, NOTIFICATION_PERMISSION_REQUEST_CODE);
+      }
+    }
+    
+    super.onStart();
+  }
+
+  @Override
+  public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults)
+  {
+      super.onRequestPermissionsResult(requestCode, permissions, grantResults);
+
+      if (requestCode == NOTIFICATION_PERMISSION_REQUEST_CODE)
+      {
+          if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED)
+          {
+              RNSelligent.enableNotifications();
+          }
+      }
+  }
+```
+
+**For iOS**:
 
 1. For push notifications you need to delegate some of the `AppDelegate.m` methods to the SDK:
 
@@ -158,14 +198,16 @@ Follow the [iOS](https://github.com/SelligentMarketingCloud/MobileSDK-iOS/tree/m
     ```javascript
     import Selligent from "@selligent-marketing-cloud/selligent-react-native"; // Add Selligent import
     
-    Selligent.enableNotifications(
-        (response) => { // success callback
-        },
-        (error) => { // error callback
-        },
-        true
-    )
-
+    if (Platform.OS === 'ios') {
+        Selligent.enableNotifications(
+            (response) => { // success callback
+            },
+            (error) => { // error callback
+            },
+            true
+        )
+    }
+    
     Selligent.registerForProvisionalRemoteNotification(
         () => { // success callback
         }
@@ -197,8 +239,8 @@ This is because the JS layer is loaded **after** the native iOS SDK executes the
 
     ```javascript
     // In DeeplinkHook.js
-    import { useEffect } from "react";
-    import { Alert, Linking } from "react-native";
+    import { useEffect } from "react"
+    import { Alert, Linking } from "react-native"
 
     const useHandleDeepLink = () => {
       useEffect(() => {
@@ -207,22 +249,22 @@ This is because the JS layer is loaded **after** the native iOS SDK executes the
                   Alert.alert('Deep Link', link || 'No link')
               }
           }).catch(err => {
-              console.warn('An error occurred', err);
-          });
+              console.warn('An error occurred', err)
+          })
 
-          const urlListener = Linking.addEventListener('url', ({url}) => Alert.alert('Deep Link', url || 'No link'));
+          const urlListener = Linking.addEventListener('url', ({url}) => Alert.alert('Deep Link', url || 'No link'))
 
-          return () => urlListener.remove();
+          return () => urlListener.remove()
       }, [])
-    };
+    }
 
-    export default useHandleDeepLink;
+    export default useHandleDeepLink
     ```
 
 3. Add a call to `Selligent.executePushAction()` in your main `App.js` file, after adding the ReactNative linking handler (and after calling `Selligent.subscribeToEvents`, if being used)
 
     ```javascript
-    import Selligent from "@selligent-marketing-cloud/selligent-react-native"; // Add Selligent import
+    import Selligent from "@selligent-marketing-cloud/selligent-react-native" // Add Selligent import
 
     const App = () => {
     // Deeplinking handling library (i.e Linking.getInitialURL() & Linking.addEventListener...)
@@ -237,6 +279,38 @@ This is because the JS layer is loaded **after** the native iOS SDK executes the
     }
     ```
 
+#### Background Modes
+
+**For iOS**, (if your app supports Background Modes) it is possible that after the app is launched from the background (location update, background push notification...) if the next action the user performs is executing a deeplink (via safari, push notification click...) the deeplink won't do anything. This is because the communication between the native part and the RN layer is not ready yet when the deeplink is executed from the native side. To workaround this, you can catch when the app is launched from the background and add a bit of delay before the `RCTLinkingManager openUrl` gets executed.
+
+```objective-c
+static BOOL launchedFromBackground = false;
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+  if ([[UIApplication sharedApplication] applicationState] == UIApplicationStateBackground) {
+    launchedFromBackground = true;
+  }
+  
+  // Other setup code
+  
+  return [super application:application didFinishLaunchingWithOptions:launchOptions];
+}
+
+- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
+  if (launchedFromBackground) {
+    launchedFromBackground = false;
+    
+    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 0.5 * NSEC_PER_SEC), dispatch_get_main_queue(), ^{
+      [RCTLinkingManager application:application openURL:url options:options];
+    });
+    
+    return [super application:application openURL:url options:options];
+  }
+  
+  return [super application:application openURL:url options:options] || [RCTLinkingManager application:application openURL:url options:options];
+}
+```
+
 #### Universal Linking - iOS
 
 By default, universal links in a button from a Push/IAM will open the default browser, to avoid this and catch them on the App and apply any logic you want, you will need to add a property `interceptSelligentUniversalLinks` in the `selligent.json` with `true` as value.
@@ -714,7 +788,7 @@ The `data` property is an object itself containing more information specific to
 Add the following import to work with the constants:
 
 ```javascript
-import SelligentConstants from "@selligent-marketing-cloud/selligent-react-native/constants";
+import SelligentConstants from "@selligent-marketing-cloud/selligent-react-native/constants"
 ```
 
 ### ClearCacheIntervalValue

package/package.json

@@ -4,7 +4,7 @@
   },
   "name": "@selligent-marketing-cloud/selligent-react-native",
   "title": "Selligent React Native",
-  "version": "3.2.7",
+  "version": "3.3.1",
   "description": "React Native wrapper for the Selligent Marketing Cloud Android and iOS SDKs",
   "main": "index.js",
   "repository": {
@@ -38,10 +38,9 @@
     "test": "jest"
   },
   "files": [
-    "/RNSelligent.podspec",
+    "/RNSelligentMapper.podspec",
     "/*.js",
     "/*.ts",
-    "/ios/RNSelligentMobileSDK.xcframework",
     "/ios/*.h",
     "/ios/*.m",
     "/android/src/main",

package/RNSelligent.podspec

@@ -1,21 +0,0 @@
-require "json"
-
-package = JSON.parse(File.read(File.join(__dir__, "package.json")))
-
-Pod::Spec.new do |s|
-  s.name         = "RNSelligent"
-  s.authors      = package['author']
-  s.version      = package["version"]
-  s.summary      = package["description"]
-  s.description  = "React Native wrapper for the Selligent Marketing Cloud Android and iOS SDKs"
-  s.homepage     = package['homepage']
-  s.license      = "MIT"
-  s.platform     = :ios, "11.0"
-  s.source       = { :git => "https://github.com/SelligentMarketingCloud/MobileSDK-ReactNative.git", :tag => "#{s.version}" }
-
-  s.vendored_frameworks = "ios/RNSelligentMobileSDK.xcframework"
-  s.source_files = "ios/*.{h,m}"
-  
-  s.dependency "React-Core"
-  s.dependency "SelligentMobileSDK/Framework", "3.5.1"
-end

package/ios/RNSelligentMobileSDK.xcframework/Info.plist

@@ -1,40 +0,0 @@
-<?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>AvailableLibraries</key>
-	<array>
-		<dict>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
-			<key>LibraryPath</key>
-			<string>RNSelligentMobileSDK.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-		</dict>
-		<dict>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
-			<key>LibraryPath</key>
-			<string>RNSelligentMobileSDK.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-				<string>x86_64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
-		</dict>
-	</array>
-	<key>CFBundlePackageType</key>
-	<string>XFWK</string>
-	<key>XCFrameworkFormatVersion</key>
-	<string>1.0</string>
-</dict>
-</plist>