@adobe/react-native-aepmessaging 1.0.0-beta.2 → 1.0.0

package/js/models/Message.js

@@ -0,0 +1,80 @@
+"use strict";
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_native_1 = require("react-native");
+const RCTAEPMessaging = react_native_1.NativeModules.AEPMessaging;
+class Message {
+    constructor(id, autoTrack) {
+        this.id = id;
+        this.autoTrack = autoTrack;
+    }
+    /**
+    * Update the value of property "autoTrack"
+    * This function works only for the Message objects that were saved by calling "Messaging.saveMessage"
+    * @param {boolean} autoTrack: New value of property autoTrack.
+     */
+    setAutoTrack(autoTrack) {
+        this.autoTrack = autoTrack;
+        RCTAEPMessaging.setAutoTrack(this.id, autoTrack);
+    }
+    ;
+    /**
+    * Signals to the UIServices that the message should be shown.
+    * If autoTrack is true, calling this method will result in an "inapp.display" Edge Event being dispatched.
+    */
+    show() {
+        RCTAEPMessaging.show(this.id);
+    }
+    ;
+    /**
+    * Signals to the UIServices that the message should be dismissed.
+    * If `autoTrack` is true, calling this method will result in an "inapp.dismiss" Edge Event being dispatched.
+    * @param {boolean?} suppressAutoTrack: if set to true, the inapp.dismiss Edge Event will not be sent regardless
+    * of the autoTrack setting.
+    */
+    dismiss(suppressAutoTrack) {
+        RCTAEPMessaging.dismiss(this.id, suppressAutoTrack ? true : false);
+    }
+    ;
+    /**
+    * Generates an Edge Event for the provided interaction and eventType.
+    * @param {string?} interaction: a custom String value to be recorded in the interaction
+    * @param {MessagingEdgeEventType} eventType: the MessagingEdgeEventType to be used for the ensuing Edge Event
+     */
+    track(interaction, eventType) {
+        RCTAEPMessaging.track(this.id, interaction, eventType);
+    }
+    ;
+    /**
+    * Adds a handler for Javascript messages sent from the message's webview.
+    * The parameter passed to `handler` will contain the body of the message passed from the webview's Javascript.
+    * @param {string} name: the name of the message that should be handled by `handler`
+    * @return {Promise<any?>}: the Promise to be resolved with the body of the message passed by the Javascript message in the WebView
+    */
+    handleJavascriptMessage(name) {
+        return Promise.resolve(RCTAEPMessaging.handleJavascriptMessage(this.id, name));
+    }
+    ;
+    /**
+    * Clears the reference to the Message object.
+    * This function must be called if Message was saved by calling "Messaging.saveMessage" but no longer needed.
+    * Failure to call this function leads to memory leaks.
+     */
+    clear() {
+        RCTAEPMessaging.clear(this.id);
+    }
+    ;
+}
+;
+exports.default = Message;
+//# sourceMappingURL=Message.js.map

package/js/models/Message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Message.js","sourceRoot":"","sources":["../../ts/models/Message.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;EAUE;;AAEF,+CAA6C;AAC7C,MAAM,eAAe,GAAG,4BAAa,CAAC,YAAY,CAAC;AAEnD,MAAM,OAAO;IAIT,YAAY,EAAU,EAAE,SAAkB;QACtC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAkB;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAAA,CAAC;IAEF;;;MAGE;IACF,IAAI;QACA,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IAAA,CAAC;IAEF;;;;;MAKE;IACF,OAAO,CAAC,iBAA2B;QAC/B,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACH,KAAK,CAAC,WAAmB,EAAE,SAAiB;QACxC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAAA,CAAC;IAEF;;;;;MAKE;IACF,uBAAuB,CAAC,IAAY;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACnF,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACH,KAAK;QACD,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC;IAAA,CAAC;CACL;AAAA,CAAC;AAEF,kBAAe,OAAO,CAAC"}

package/js/models/MessagingDelegate.d.ts

@@ -0,0 +1,25 @@
+import Message from "./Message";
+export type MessagingDelegate = {
+    /**
+    * Invoked when the any message is displayed
+    * @param {Message} message: Message that is being displayed.
+    */
+    onShow(message: Message): void;
+    /**
+     * Invoked when any message is dismissed
+     * @param {Message} message: Message that is being dismissed
+     */
+    onDismiss(message: Message): void;
+    /**
+     * Used to find whether messages should be shown or not
+     * @param {Message} message: Message that is about to get displayed
+     * @returns {boolean}: true if the message should be shown else false
+     */
+    shouldShowMessage(message: Message): boolean;
+    /**
+    * Called when message loads a URL
+    * @param {string} url: the URL being loaded by the message
+    * @param {Message} message: the Message loading a URL
+    */
+    urlLoaded(url: string, message: Message): void;
+};

package/js/models/MessagingDelegate.js

@@ -0,0 +1,14 @@
+"use strict";
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MessagingDelegate.js.map

package/js/models/MessagingDelegate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagingDelegate.js","sourceRoot":"","sources":["../../ts/models/MessagingDelegate.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;EAUE"}

package/js/models/MessagingEdgeEventType.d.ts

@@ -0,0 +1,9 @@
+declare enum MessagingEdgeEventType {
+    IN_APP_DISMISS = 0,
+    IN_APP_INTERACT = 1,
+    IN_APP_TRIGGER = 2,
+    IN_APP_DISPLAY = 3,
+    PUSH_APPLICATION_OPENED = 4,
+    PUSH_CUSTOM_ACTION = 5
+}
+export default MessagingEdgeEventType;

package/js/models/MessagingEdgeEventType.js

@@ -0,0 +1,25 @@
+"use strict";
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+var MessagingEdgeEventType;
+(function (MessagingEdgeEventType) {
+    MessagingEdgeEventType[MessagingEdgeEventType["IN_APP_DISMISS"] = 0] = "IN_APP_DISMISS";
+    MessagingEdgeEventType[MessagingEdgeEventType["IN_APP_INTERACT"] = 1] = "IN_APP_INTERACT";
+    MessagingEdgeEventType[MessagingEdgeEventType["IN_APP_TRIGGER"] = 2] = "IN_APP_TRIGGER";
+    MessagingEdgeEventType[MessagingEdgeEventType["IN_APP_DISPLAY"] = 3] = "IN_APP_DISPLAY";
+    MessagingEdgeEventType[MessagingEdgeEventType["PUSH_APPLICATION_OPENED"] = 4] = "PUSH_APPLICATION_OPENED";
+    MessagingEdgeEventType[MessagingEdgeEventType["PUSH_CUSTOM_ACTION"] = 5] = "PUSH_CUSTOM_ACTION";
+})(MessagingEdgeEventType || (MessagingEdgeEventType = {}));
+;
+exports.default = MessagingEdgeEventType;
+//# sourceMappingURL=MessagingEdgeEventType.js.map

package/js/models/MessagingEdgeEventType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagingEdgeEventType.js","sourceRoot":"","sources":["../../ts/models/MessagingEdgeEventType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;EAUE;;AAEF,IAAK,sBAOJ;AAPD,WAAK,sBAAsB;IACvB,uFAAkB,CAAA;IAClB,yFAAmB,CAAA;IACnB,uFAAkB,CAAA;IAClB,uFAAkB,CAAA;IAClB,yGAA2B,CAAA;IAC3B,+FAAsB,CAAA;AAC1B,CAAC,EAPI,sBAAsB,KAAtB,sBAAsB,QAO1B;AAAA,CAAC;AAEF,kBAAe,sBAAsB,CAAC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@adobe/react-native-aepmessaging",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0",
   "description": "Adobe Experience Platform support for React Native apps.",
-  "homepage": "https://aep-sdks.gitbook.io/docs/",
+  "homepage": "https://developer.adobe.com/client-sdks/documentation/",
   "license": "Apache-2.0",
   "main": "./ts/index.ts",
   "scripts": {
@@ -27,13 +27,13 @@
     "name": "Adobe Experience Platform SDK Team"
   },
   "peerDependencies": {
-    "@adobe/react-native-aepcore": "^1.0.0-beta",
-    "@adobe/react-native-aepedge": "^1.0.0-beta",
-    "@adobe/react-native-aepedgeidentity": "^1.0.0-beta",
+    "@adobe/react-native-aepcore": "^2.0.0",
+    "@adobe/react-native-aepedge": "^2.0.0",
+    "@adobe/react-native-aepedgeidentity": "^2.0.0",
     "react-native": ">=0.60.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a7d0febed8bcb7c58025bff4daa6a974953f3de4"
+  "gitHead": "6a766c2b35eda5ce16d7e0cb9deb698da5d89379"
 }

package/ts/Messaging.ts

@@ -10,22 +10,90 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { NativeModules } from 'react-native';
+import { NativeModules, NativeEventEmitter, NativeModule } from 'react-native';
+import Message from './models/Message';
+import { MessagingDelegate } from "./models/MessagingDelegate";
 
-interface IMessaging {
+export interface IMessaging {
   extensionVersion: () => Promise<string>;
+  refreshInAppMessages: () => void;
+  setMessagingDelegate: (delegate?: MessagingDelegate) => void;
+  shouldShowMessage: (shouldShowMessage: boolean, shouldSaveMessage: boolean) => void;
+  saveMessage: (message: Message) => void;
 }
 
-const RCTAEPMessaging: IMessaging = NativeModules.AEPMessaging;
+const RCTAEPMessaging: NativeModule & IMessaging = NativeModules.AEPMessaging;
 
-const Messaging: IMessaging = {
+declare var messagingDelegate: MessagingDelegate
+declare var savedMessageId: string;
+
+var messagingDelegate: MessagingDelegate;
+var savedMessageId: string = null;
+
+const Messaging = {
   /**
    * Returns the version of the AEPMessaging extension
-   * @param  {string} Promise a promise that resolves with the extension version
+   * @returns {string} Promise a promise that resolves with the extension version
    */
-  extensionVersion(): Promise<string> {
+  extensionVersion(): Promise<string> {    
     return Promise.resolve(RCTAEPMessaging.extensionVersion());
-  }
+  },
+
+  /**
+  * Initiates a network call to retrieve remote In-App Message definitions.
+  */
+  refreshInAppMessages() {
+    RCTAEPMessaging.refreshInAppMessages();
+  },
+
+  /**
+  * Function to set the UI Message delegate to listen the Message lifecycle events.
+  */
+  setMessagingDelegate(delegate: MessagingDelegate) {    
+    messagingDelegate = delegate;
+    RCTAEPMessaging.setMessagingDelegate();            
+    const eventEmitter = new NativeEventEmitter(RCTAEPMessaging);    
+    eventEmitter.addListener('onShow', (event) => {      
+      if(messagingDelegate){
+        const message = new Message(event.id, event.autoTrack === "true" ? true: false);
+        messagingDelegate.onShow(message);
+      }  
+    });
+
+    eventEmitter.addListener('onDismiss', (event) => {      
+      if(messagingDelegate){
+        const message = new Message(event.id, event.autoTrack === "true" ? true: false);
+        messagingDelegate.onDismiss(message);
+      }
+    });
+
+    eventEmitter.addListener('shouldShowMessage', (event) => {            
+      if (messagingDelegate){        
+        const message = new Message(event.id, event.autoTrack === "true" ? true: false);        
+        const shouldShowMessage: boolean = messagingDelegate.shouldShowMessage(message);        
+        RCTAEPMessaging.shouldShowMessage(shouldShowMessage, savedMessageId ? true : false);
+        savedMessageId = null;
+      }
+    });
+
+    eventEmitter.addListener('urlLoaded', (event) => {      
+      if(messagingDelegate){
+        const url = event.url;
+        const message = new Message(event.id, event.autoTrack === "true" ? true: false);        
+        messagingDelegate.urlLoaded(url, message);
+      }
+    });    
+  },
+
+  /**
+  * Cache the Message object in-memory to use later. 
+  * If there is a requirement to call the Message functions like show, dismiss etc. The Message object should be saved first before calling it's functions.
+  * If the Message is saved using this API then it is responsibility of App to free it after using.
+  * To remove the Message from memory call clearMessage function of Message. Failure to call clearMessage will cause the Memory leak of Message object.
+  */
+  saveMessage(message: Message) {
+    savedMessageId = message.id;
+  },  
 };
 
 export default Messaging;

package/ts/index.ts

@@ -11,5 +11,8 @@ governing permissions and limitations under the License.
 */
 
 import Messaging from './Messaging';
+import Message from './models/Message';
+import { MessagingDelegate } from './models/MessagingDelegate';
+import MessagingEdgeEventType from './models/MessagingEdgeEventType';
 
-export { Messaging };
+export { Messaging, Message, MessagingDelegate, MessagingEdgeEventType };

package/ts/models/Message.ts

@@ -0,0 +1,82 @@
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { NativeModules } from 'react-native';
+const RCTAEPMessaging = NativeModules.AEPMessaging;
+
+class Message {    
+    id: string;
+    autoTrack: boolean;    
+
+    constructor(id: string, autoTrack: boolean) {
+        this.id = id;
+        this.autoTrack = autoTrack;                
+    }
+
+    /** 
+    * Update the value of property "autoTrack"
+    * This function works only for the Message objects that were saved by calling "Messaging.saveMessage"
+    * @param {boolean} autoTrack: New value of property autoTrack.
+     */
+    setAutoTrack(autoTrack: boolean) {
+        this.autoTrack = autoTrack;
+        RCTAEPMessaging.setAutoTrack(this.id, autoTrack);
+    };
+
+    /**
+    * Signals to the UIServices that the message should be shown.
+    * If autoTrack is true, calling this method will result in an "inapp.display" Edge Event being dispatched.
+    */
+    show() {        
+        RCTAEPMessaging.show(this.id);
+    };
+
+    /**
+    * Signals to the UIServices that the message should be dismissed.
+    * If `autoTrack` is true, calling this method will result in an "inapp.dismiss" Edge Event being dispatched.
+    * @param {boolean?} suppressAutoTrack: if set to true, the inapp.dismiss Edge Event will not be sent regardless
+    * of the autoTrack setting.
+    */
+    dismiss(suppressAutoTrack?: boolean) {
+        RCTAEPMessaging.dismiss(this.id, suppressAutoTrack ? true : false);
+    };
+
+    /**
+    * Generates an Edge Event for the provided interaction and eventType.        
+    * @param {string?} interaction: a custom String value to be recorded in the interaction
+    * @param {MessagingEdgeEventType} eventType: the MessagingEdgeEventType to be used for the ensuing Edge Event
+     */
+    track(interaction: string, eventType: number) {
+        RCTAEPMessaging.track(this.id, interaction, eventType);
+    };
+
+    /**
+    * Adds a handler for Javascript messages sent from the message's webview.    
+    * The parameter passed to `handler` will contain the body of the message passed from the webview's Javascript.        
+    * @param {string} name: the name of the message that should be handled by `handler`
+    * @return {Promise<any?>}: the Promise to be resolved with the body of the message passed by the Javascript message in the WebView
+    */
+    handleJavascriptMessage(name: string) : Promise<any> {
+        return Promise.resolve(RCTAEPMessaging.handleJavascriptMessage(this.id, name));
+    };
+
+    /**
+    * Clears the reference to the Message object. 
+    * This function must be called if Message was saved by calling "Messaging.saveMessage" but no longer needed. 
+    * Failure to call this function leads to memory leaks.
+     */
+    clear() {
+        RCTAEPMessaging.clear(this.id);
+    };    
+};
+
+export default Message;

package/ts/models/MessagingDelegate.ts

@@ -0,0 +1,41 @@
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import Message from "./Message";
+
+export type MessagingDelegate = {    
+    /**
+    * Invoked when the any message is displayed
+    * @param {Message} message: Message that is being displayed.
+    */
+    onShow(message: Message): void;
+
+    /**
+     * Invoked when any message is dismissed
+     * @param {Message} message: Message that is being dismissed
+     */
+    onDismiss(message: Message): void;
+
+    /**
+     * Used to find whether messages should be shown or not
+     * @param {Message} message: Message that is about to get displayed
+     * @returns {boolean}: true if the message should be shown else false 
+     */
+    shouldShowMessage(message: Message): boolean;
+
+    /**
+    * Called when message loads a URL
+    * @param {string} url: the URL being loaded by the message
+    * @param {Message} message: the Message loading a URL
+    */
+    urlLoaded(url: string, message: Message): void;
+};

package/ts/models/MessagingEdgeEventType.ts

@@ -0,0 +1,22 @@
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+enum MessagingEdgeEventType {
+    IN_APP_DISMISS = 0,
+    IN_APP_INTERACT = 1,
+    IN_APP_TRIGGER = 2,
+    IN_APP_DISPLAY = 3,
+    PUSH_APPLICATION_OPENED = 4,
+    PUSH_CUSTOM_ACTION = 5    
+};
+
+export default MessagingEdgeEventType;

package/tsconfig.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "noEmit": false,
     "rootDir": "./ts",
-    "outDir": "./js"
+    "outDir": "./js",
+    "noImplicitAny": false
   },
   "exclude": ["__tests__", "js"]
 }