@selligent-marketing-cloud/selligent-react-native 3.1.0 → 3.2.6

package/index.js

@@ -1,8 +1,9 @@
-import { NativeModules, Platform } from 'react-native'
+import { NativeEventEmitter, NativeModules, Platform } from 'react-native'
 import SelligentConstants from './constants'
 import SelligentHelpers from './helpers'
 
 const { RNSelligent } = NativeModules
+export const RNSEventEmitter = new NativeEventEmitter(RNSelligent)
 
 // Check if Native version of Selligent found
 SelligentHelpers.isNativeSelligentFound(RNSelligent)
@@ -11,7 +12,7 @@ SelligentHelpers.isNativeSelligentFound(RNSelligent)
 // export default RNSelligent;
 
 // platform specific code
-var platformSpecificMethods = {}
+let platformSpecificMethods = {};
 
 if (Platform.OS === 'android') {
 	platformSpecificMethods = require('./index.android.js').default
@@ -27,30 +28,27 @@ export default Object.assign(
 		// Basic SMManager
 
 		/**
-		 * Returns the version of the underlying Selligent SDK.
+		 * Returns the version of the underlying Selligent native SDK.
 		 * 
 		 * @param {function} successCallback Callback function on success.
 		 */
 		getVersionLib: function (successCallback) {
 			RNSelligent.getVersionLib(successCallback)
-			return
 		},
-		// DataTransaction
 
 		// InAppMessage
 
 		/**
-		 * Get in app messages.
+		 * Gets all known (and not deleted/expired) in app messages.
 		 *  
 		 * @param {function} successCallback Callback function on success.
 		 */
 		getInAppMessages: function (successCallback) {
 			RNSelligent.getInAppMessages(successCallback)
-			return
 		},
 
 		/**
-		 * Set in app message as seen
+		 * Sets an in app message as seen
 		 *  
 		 * @param {function} successCallback Callback function on success.
 		 * @param {function} errorCallback Callback function on error.
@@ -69,7 +67,50 @@ export default Object.assign(
 			}
 
 			RNSelligent.setInAppMessageAsSeen(messageId, _successCallback, errorCallback)
-			return
+		},
+
+		/**
+		 * Sets an in app message as unseen
+		 *  
+		 * @param {function} successCallback Callback function on success.
+		 * @param {function} errorCallback Callback function on error.
+		 * @param {string} messageId Message id to identify the message which has been unseen.
+		 */
+		setInAppMessageAsUnseen: function (successCallback, errorCallback, messageId) {
+			// check if required options are valid
+			if (!SelligentHelpers.typeMatches(messageId, 'string')) {
+				errorCallback(SelligentHelpers.wrongArgumentError('Expected a string.'))
+				return
+			}
+
+			// continue if options are valid
+			const _successCallback = () => {
+				successCallback(SelligentHelpers.SUCCESS)
+			}
+
+			RNSelligent.setInAppMessageAsUnseen(messageId, _successCallback, errorCallback)
+		},
+		
+		/**
+		 * Sets an in app message as deleted
+		 *  
+		 * @param {function} successCallback Callback function on success.
+		 * @param {function} errorCallback Callback function on error.
+		 * @param {string} messageId Message id to identify the message which has been deleted.
+		 */
+		setInAppMessageAsDeleted: function (successCallback, errorCallback, messageId) {
+			// check if required options are valid
+			if (!SelligentHelpers.typeMatches(messageId, 'string')) {
+				errorCallback(SelligentHelpers.wrongArgumentError('Expected a string.'))
+				return
+			}
+
+			// continue if options are valid
+			const _successCallback = () => {
+				successCallback(SelligentHelpers.SUCCESS)
+			}
+
+			RNSelligent.setInAppMessageAsDeleted(messageId, _successCallback, errorCallback)
 		},
 
 		/**
@@ -77,7 +118,7 @@ export default Object.assign(
 		 *  
 		 * @param {function} successCallback Callback function on success.
 		 * @param {function} errorCallback Callback function on error.
-		 * @param {string} buttonId Button id to identify the message.
+		 * @param {string} buttonId Button id to identify the button.
 		 * @param {string} messageId Message id to identify the message.
 		 */
 		executeButtonAction: function (successCallback, errorCallback, buttonId, messageId) {
@@ -85,7 +126,7 @@ export default Object.assign(
 				errorCallback(SelligentHelpers.wrongArgumentError('Expected buttonId to be a string.'))
 				return
 			}
-			if (!SelligentHelpers.typeMatches(messageId, 'string')) {
+			else if (!SelligentHelpers.typeMatches(messageId, 'string')) {
 				errorCallback(SelligentHelpers.wrongArgumentError('Expected messageId to be a string.'))
 				return
 			}
@@ -95,39 +136,43 @@ export default Object.assign(
 			}
 
 			RNSelligent.executeButtonAction(buttonId, messageId, _successCallback, errorCallback)
-			return
 		},
 
-		// Location
+		/**
+		 * Displays an inapp message given its id, (optionally with a specific templateId to use custom styles).
+		 * @deprecated Use displayMessage instead.
+		 * 
+		 * @param {function} successCallback Callback function on success.
+		 * @param {function} errorCallback Callback function on error.
+		 * @param {string} notificationId Id of the notification.
+		 * @param {string} templateId Id of the template from where to get the styles.
+		 */
+		displayNotification: function (successCallback, errorCallback, notificationId, templateId) {
+			this.displayMessage(successCallback, errorCallback, notificationId, templateId)
+		},
 
 		/**
-		 * Enable/disable geolocation.
-		 *  
+		 * Displays an inapp message given its id, (optionally with a specific templateId to use custom styles for iOS).
+		 * 
 		 * @param {function} successCallback Callback function on success.
 		 * @param {function} errorCallback Callback function on error.
-		 * @param {boolean} enabled Boolean to enable or disable geolocation.
+		 * @param {string} messageId Id of the message.
+		 * @param {string} templateId Id of the template from where to get the styles (iOS only).
 		 */
-		 enableGeolocation: function (successCallback, errorCallback, enabled) {
-			// check if required options are valid
-			if (!SelligentHelpers.typeMatches(enabled, 'boolean')) {
-				errorCallback(SelligentHelpers.wrongArgumentError('Expected a boolean.'))
+		displayMessage: function (successCallback, errorCallback, messageId, templateId) {
+			if (!SelligentHelpers.typeMatches(messageId, 'string') || messageId.length === 0) {
+				errorCallback(SelligentHelpers.wrongArgumentError('Expected a string (not empty) messageId.'))
 				return
 			}
 
-			// continue if options are valid
 			successCallback(SelligentHelpers.SUCCESS)
-			RNSelligent.enableGeolocation(enabled)
-			return
-		},
 
-		/**
-		 * Check if geolocation is enabled or disabled.
-		 *  
-		 * @param {function} successCallback Callback function on success.
-		 */
-		isGeolocationEnabled: function (successCallback) {
-			RNSelligent.isGeolocationEnabled(successCallback)
-			return
+			if (Platform.OS === 'ios') {
+				RNSelligent.displayNotification(messageId, templateId)
+			}
+			else if (Platform.OS === 'android') {
+				RNSelligent.displayMessage(messageId)
+			}
 		},
 
 		// Event
@@ -159,11 +204,10 @@ export default Object.assign(
 				if (event.hasOwnProperty('email')) {
 					console.warn("Email prop is not used with \"custom\" event type and will be ignored.");
 				}
-			} else {
-				if (!SelligentHelpers.hasRequiredParameterAndMatchesType(event, 'email', 'string')) {
-					errorCallback(SelligentHelpers.wrongArgumentError('Expected an object with the key "email".'))
-					return
-				}
+			} 
+			else if (!SelligentHelpers.hasRequiredParameterAndMatchesType(event, 'email', 'string')) {
+				errorCallback(SelligentHelpers.wrongArgumentError('Expected an object with the key "email".'))
+				return
 			}
 
 			if (!SelligentHelpers.hasOptionalParameterAndMatchesType(event, 'shouldCache', 'boolean')) {
@@ -173,7 +217,6 @@ export default Object.assign(
 
 			// continue if options are valid
 			RNSelligent.sendEvent(event, successCallback, errorCallback)
-			return
 		},
 		// Device Id
 		/**
@@ -183,7 +226,6 @@ export default Object.assign(
 		 */
 		 getDeviceId: function (successCallback) {
 			RNSelligent.getDeviceId(successCallback)
-			return
 		},
 
 		// Remote Notifications
@@ -205,18 +247,24 @@ export default Object.assign(
 			// continue if options are valid
 			successCallback(SelligentHelpers.SUCCESS)
 			RNSelligent.enableNotifications(enabled)
-			return
 		},
 
 		/**
-		 * Display the last received remote push notification
+		 * Displays the last received remote push notification content (optionally, on iOS, with a specific templateId to use custom styles).
 		 *  
 		 * @param {function} successCallback Callback function on success.
+		 * @param {string} templateId Id of the template from where to get the styles.
 		 */
-		displayLastReceivedRemotePushNotification: function (successCallback) {
+		displayLastReceivedRemotePushNotification: function (successCallback, templateId) {
 			successCallback(SelligentHelpers.SUCCESS)
-			RNSelligent.displayLastReceivedRemotePushNotification()
-			return
+			RNSelligent.displayLastReceivedRemotePushNotification(templateId)
+		},
+
+		/**
+		 * Displays the last received remote push notification (if any).
+		 */
+		displayLastReceivedNotification: function() {
+			RNSelligent.displayLastReceivedNotification()
 		},
 
 		/**
@@ -226,7 +274,67 @@ export default Object.assign(
 		 */
 		getLastRemotePushNotification: function (successCallback) {
 			RNSelligent.getLastRemotePushNotification(successCallback)
-			return
+		},
+
+		/**
+		 * Subscribe to events.
+		 *
+		 * @param {function} successCallback Callback function on success.
+		 * @param {function} errorCallback Callback function on error.
+		 * @param {function} eventCallback Callback function on event.
+		 * @param {array} customEvents Array of custom events to subscribe to.
+		 */
+		subscribeToEvents: function (successCallback, errorCallback, eventCallback, customEvents = []) {
+			if (customEvents !== undefined) {
+				if (!SelligentHelpers.typeMatches(customEvents, 'array')) {
+					errorCallback(SelligentHelpers.createTypeErrorMessage('customEvents', customEvents, 'array'))
+					return
+				}
+
+				// check if values are all strings
+				const arrayLength = customEvents.length;
+				for (let i = 0; i < arrayLength; i++) {
+					if (!SelligentHelpers.typeMatches(customEvents[i], 'string')) {
+						errorCallback(SelligentHelpers.wrongArgumentError('Expected an array of strings.'))
+						return
+					}
+				}
+			}
+
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.BUTTON_CLICKED, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_IN_APP_MESSAGE, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.WILL_DISPLAY_NOTIFICATION, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.WILL_DISMISS_NOTIFICATION, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_DEVICE_ID, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_REMOTE_NOTIFICATION, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.TRIGGERED_CUSTOM_EVENT, eventCallback);
+
+			if (Platform.OS === "ios") {
+				RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.UNIVERSAL_LINK_EXECUTED, eventCallback);
+			}
+			else if (Platform.OS === "android") {
+				RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_GCM_TOKEN, eventCallback);
+			}
+			
+			successCallback(SelligentHelpers.SUCCESS)
+			RNSelligent.subscribeToEvents(customEvents)
+		},
+
+		/**
+		 * Subscribe to event.
+		 *
+		 * @param {function} eventCallback Callback function on event.
+		 * @param {string} eventName Name of the custom event to subscribe to.
+		 */
+		subscribeToEvent: function (eventCallback, eventName) {
+			if (Object.values(SelligentConstants.BroadcastEventType).includes(eventName)) {
+				RNSEventEmitter.addListener(eventName, eventCallback)
+			}
+			else {
+				RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.TRIGGERED_CUSTOM_EVENT, eventCallback)
+			}
+
+			RNSelligent.subscribeToEvents([eventName])
 		}
 	},
 	{ ...platformSpecificMethods }

package/ios/RNSelligentMapper.h

@@ -0,0 +1,21 @@
+//
+//  RNSelligentMapper.h
+//  SelligentDevAppRN
+//
+//  Created by Marc Biosca on 16/5/23.
+//  Copyright © 2023 Facebook. All rights reserved.
+//
+
+#if __has_include(<React/RCTBridgeModule.h>)
+    #import <React/RCTBridgeModule.h>
+    #import <React/RCTEventEmitter.h>
+#else
+    #import "RCTBridgeModule.h"
+    #import <RCTEventEmitter.h>
+#endif
+
+@import RNSelligentMobileSDK;
+
+@interface RNSelligentMapper : RCTEventEmitter <RCTBridgeModule, RNSelligentEventHandlerProtocol>
+
+@end

package/ios/RNSelligentMapper.m

@@ -0,0 +1,151 @@
+#import "RNSelligentMapper.h"
+
+@implementation RNSelligentMapper
+
+RCT_EXPORT_MODULE(RNSelligent)
+
+- (instancetype) init {
+  self = [super init];
+  
+  RNSelligent.eventDelegate = self;
+  
+  return self;
+}
+
++ (BOOL) requiresMainQueueSetup {
+  return true;
+}
+
+#pragma mark - Helpers
+
+RCT_EXPORT_METHOD(getVersionLib:(RCTResponseSenderBlock)callback) {
+  callback(@[[RNSelligent getVersionLib], [NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(getDeviceId:(RCTResponseSenderBlock)callback) {
+  callback(@[[RNSelligent getDeviceId], [NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(executePushAction) {
+  [RNSelligent executePushAction];
+}
+
+RCT_EXPORT_METHOD(applyLogLevel:(NSArray<NSNumber *> *)logLevels) {
+  [RNSelligent applyLogLevel:logLevels];
+}
+
+#pragma mark - Push
+
+RCT_EXPORT_METHOD(enableNotifications:(BOOL)enable) {
+  [RNSelligent enableNotifications:enable];
+}
+
+RCT_EXPORT_METHOD(registerForProvisionalRemoteNotification) {
+  [RNSelligent registerForProvisionalRemoteNotification];
+}
+
+RCT_EXPORT_METHOD(displayLastReceivedRemotePushNotification:(NSString *)templateId) {
+  [RNSelligent displayLastReceivedRemotePushNotificationWithTemplateId:templateId];
+}
+
+RCT_EXPORT_METHOD(getLastRemotePushNotification:(RCTResponseSenderBlock)callback) {
+  callback(@[[RNSelligent getLastRemotePushNotification] ?: [NSNull null], [NSNull null]]);
+}
+
+#pragma mark - IAM
+
+RCT_EXPORT_METHOD(enableInAppMessages:(BOOL)enabled) {
+  [RNSelligent enableInAppMessages:enabled];
+}
+
+RCT_EXPORT_METHOD(getInAppMessages:(RCTResponseSenderBlock)callback) {
+  callback(@[[RNSelligent getInAppMessages] ?: [NSNull null], [NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(setInAppMessageAsSeen:(NSString *)messageId successCallback:(RCTResponseSenderBlock)successCallback errorCallback:(RCTResponseSenderBlock)errorCallback) {
+  NSString* errorMessage = [RNSelligent setInAppMessageAsSeen:messageId seen:true];
+  
+  if (errorMessage) {
+    errorCallback(@[errorMessage]);
+    return;
+  }
+  
+  successCallback(@[[NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(setInAppMessageAsUnseen:(NSString *)messageId successCallback:(RCTResponseSenderBlock)successCallback errorCallback:(RCTResponseSenderBlock)errorCallback) {
+  NSString* errorMessage = [RNSelligent setInAppMessageAsSeen:messageId seen:false];
+  
+  if (errorMessage) {
+    errorCallback(@[errorMessage]);
+    return;
+  }
+  
+  successCallback(@[[NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(setInAppMessageAsDeleted:(NSString *)messageId successCallback:(RCTResponseSenderBlock)successCallback errorCallback:(RCTResponseSenderBlock)errorCallback) {
+  NSString* errorMessage = [RNSelligent setInAppMessageAsDeleted:messageId];
+  
+  if (errorMessage) {
+    errorCallback(@[errorMessage]);
+    return;
+  }
+  
+  successCallback(@[[NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(executeButtonAction: (NSString *)buttonId messageId:(NSString *)messageId successCallback:(RCTResponseSenderBlock)successCallback errorCallback:(RCTResponseSenderBlock)errorCallback) {
+  NSString* errorMessage = [RNSelligent executeButtonAction:buttonId messageId:messageId];
+  
+  if (errorMessage) {
+    errorCallback(@[errorMessage]);
+    return;
+  }
+  
+  successCallback(@[[NSNull null]]);
+}
+
+RCT_EXPORT_METHOD(displayNotification:(NSString *)notificationId templateId:(NSString *)templateId) {
+  [RNSelligent displayNotification:notificationId templateId:templateId];
+}
+
+#pragma mark - Events
+
+RCT_EXPORT_METHOD(sendEvent:(NSDictionary *)data successCallback:(RCTResponseSenderBlock)successCallback errorCallback:(RCTResponseSenderBlock)errorCallback) {
+  [RNSelligent sendEvent:data completion:^(BOOL status, NSString *message) {
+    if (status) {
+      successCallback(@[message, [NSNull null]]);
+      return;
+    }
+    
+    errorCallback(@[message, [NSNull null]]);
+  }];
+}
+
+RCT_EXPORT_METHOD(subscribeToEvents:(NSArray<NSString *> *)events) {
+  [RNSelligent subscribeToEvents:events];
+}
+
+RCT_EXPORT_METHOD(displayLastReceivedNotification) {
+  [RNSelligent displayLastReceivedNotification];
+}
+
+- (void) sendBroadcastEventWithName:(NSString * _Nonnull)name type:(NSString * _Nonnull)type data:(NSDictionary * _Nullable)data {
+  [self sendEventWithName:name body:@{@"data": data ?: [NSNull null], @"broadcastEventType": type}];
+}
+
+- (NSArray<NSString *> *) supportedEvents {
+    return @[
+        @"ButtonClicked",
+        @"ReceivedInAppMessage",
+        @"WillDisplayNotification",
+        @"WillDismissNotification",
+        @"ReceivedRemoteNotification",
+        @"ReceivedDeviceId",
+        @"UniversalLinkExecuted",
+        @"TriggeredCustomEvent"
+     ];
+}
+
+@end

package/ios/RNSelligentMobileSDK.xcframework/Info.plist

@@ -0,0 +1,40 @@
+<?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_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>
+		<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>
+	</array>
+	<key>CFBundlePackageType</key>
+	<string>XFWK</string>
+	<key>XCFrameworkFormatVersion</key>
+	<string>1.0</string>
+</dict>
+</plist>