notifly-sdk 2.1.2 → 2.1.4

package/index.js

@@ -4,13 +4,71 @@ import AsyncStorage from '@react-native-async-storage/async-storage';
 import messaging from '@react-native-firebase/messaging';
 import logEvent from './src/log_event';
 import { setUserProperties, removeUserId } from './src/user';
-import { clickHandler, sessionStart } from './src/utils';
+import { base64Decode, clickHandler, sessionStart } from './src/utils';
 import { showInAppMessage } from './src/in_app_message';
-
+let isSetBackgroundHandler = false;
 exports.trackEvent = logEvent;
 exports.setUserProperties = setUserProperties;
 exports.clickHandler = clickHandler;
 
+/**
+ * Sets the background message handler for the Notifly SDK.
+ * This method should be called in the index.js file of your app.
+ * Should be used when you don't have a custom background message handler.
+ * @returns {Promise<void>} - A promise that resolves when the background message handler is set.
+ * @example
+ * setNotiflyBackgroundMessageHandler();
+*/
+async function setNotiflyBackgroundMessageHandler() {
+    messaging().setBackgroundMessageHandler(notiflyBackgroundHandler);
+}
+
+/**
+ * The background message handler for the Notifly SDK.
+ * This method should be called in the index.js file of your app.
+ * Should be used when you have a custom background message handler.
+ * @param {Object} remoteMessage - The remote message to handle.
+ * @returns {Promise<void>} - A promise that resolves when the background message handler is set.
+ * @example
+ * messaging().setBackgroundMessageHandler(async remoteMessage => {
+       console.log('Existing handler: Background message received:', remoteMessage);
+       await notiflyBackgroundHandler(remoteMessage);
+    });
+*/
+async function notiflyBackgroundHandler(remoteMessage) {
+    if (!remoteMessage.notification) {
+        return; // TODO(minyong): Discuss if we should log only when notifly_message_type is push-notitification.
+    }
+    if (!isSetBackgroundHandler) {
+        await logEvent(
+            'push_delivered',
+            {
+                type: 'message_event',
+                channel: 'push-notification',
+                campaign_id: remoteMessage?.data?.campaign_id,
+                notifly_message_id: remoteMessage?.data?.notifly_message_id,
+                status: 'quit',
+            },
+            null,
+            true,
+        );
+        isSetBackgroundHandler = true;
+        return;
+    }
+    await logEvent(
+        'push_delivered',
+        {
+            type: 'message_event',
+            channel: 'push-notification',
+            campaign_id: remoteMessage?.data?.campaign_id,
+            notifly_message_id: remoteMessage.data?.notifly_message_id,
+            status: 'background',
+        },
+        null,
+        true,
+    );
+}
+
 /**
  * Sets the external user ID for the user.
  *
@@ -52,7 +110,6 @@ exports.setUserId = async function (userID) {
 exports.initialize = async function (prjId, userName, password, useCustomClickHandler = false) {
     try {
         await messaging().requestPermission();
-
         // in-app-message
         const openedInAppWebViewCount = { count: 0 };
         messaging().onMessage((remoteMessage) => {
@@ -72,6 +129,7 @@ exports.initialize = async function (prjId, userName, password, useCustomClickHa
         }
 
         messaging().getToken();
+        messaging().setDeliveryMetricsExportToBigQuery(true);
 
         await Promise.all([
             AsyncStorage.setItem('notiflyProjectId', prjId),
@@ -86,8 +144,10 @@ exports.initialize = async function (prjId, userName, password, useCustomClickHa
 
 async function handleInAppMessage(remoteMessage, openedInAppWebViewCount) {
     try {
-        if (remoteMessage.data?.notifly_message_type === 'in-app-message' && remoteMessage.data.url) {
-            showInAppMessage(remoteMessage.data, openedInAppWebViewCount);
+        if (remoteMessage.data?.notifly_message_type === 'in-app-message' && remoteMessage.data?.notifly_in_app_message_data) {
+            const decodedJsonString = base64Decode(remoteMessage.data?.notifly_in_app_message_data);
+            const notiflyInAppMessageData = JSON.parse(decodedJsonString);
+            showInAppMessage(notiflyInAppMessageData, openedInAppWebViewCount);
         }
     } catch (err) {
         console.warn('[Notifly] In-app message handling failed:', err);
@@ -106,6 +166,7 @@ async function handleNotificationOpened(remoteMessage) {
                 type: 'message_event',
                 channel: 'push-notification',
                 campaign_id: remoteMessage.data.campaign_id,
+                notifly_message_id: remoteMessage.data?.notifly_message_id,
                 status: 'background',
             },
             null,
@@ -115,3 +176,6 @@ async function handleNotificationOpened(remoteMessage) {
         console.warn('[Notifly] Notification opened handling failed:', err);
     }
 }
+
+exports.setNotiflyBackgroundMessageHandler = setNotiflyBackgroundMessageHandler;
+exports.notiflyBackgroundHandler = notiflyBackgroundHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifly-sdk",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/constant.js

@@ -1,4 +1,4 @@
-export const SDK_VERSION = '2.1.1';
+export const SDK_VERSION = '2.2.4';
 
 export const NAMESPACE = {
     'EVENTID': '830b5f7b-e392-43db-a17b-d835f0bcab2b',

package/src/in_app_message.js

@@ -25,7 +25,7 @@ export async function showInAppMessage(data, openedInAppWebViewCount) {
     if (!(data?.url && data?.modal_properties)) {
         return;
     }
-    const modalProperties = JSON.parse(data.modal_properties || '{}');
+    const modalProperties = data.modal_properties || {};
     const screenWidth = Dimensions.get('window').width;
     const screenHeight = Dimensions.get('window').height;
     const webViewProps = _translateWebviewProps(modalProperties, screenWidth, screenHeight);
@@ -54,6 +54,7 @@ export async function showInAppMessage(data, openedInAppWebViewCount) {
                     channel: 'in-app-message',
                     button_name: message.button_name,
                     campaign_id: data.campaign_id,
+                    notifly_message_id: data.notifly_message_id,
                 },
                 null,
                 true
@@ -66,6 +67,7 @@ export async function showInAppMessage(data, openedInAppWebViewCount) {
                     channel: 'in-app-message',
                     button_name: message.button_name,
                     campaign_id: data.campaign_id,
+                    notifly_message_id: data.notifly_message_id,
                 },
                 null,
                 true
@@ -85,6 +87,7 @@ export async function showInAppMessage(data, openedInAppWebViewCount) {
                     channel: 'in-app-message',
                     button_name: message.button_name,
                     campaign_id: data.campaign_id,
+                    notifly_message_id: data.notifly_message_id,
                 },
                 null,
                 true
@@ -101,7 +104,7 @@ export async function showInAppMessage(data, openedInAppWebViewCount) {
     openedInAppWebViewCount.count = openedInAppWebViewCount.count + 1;
     logEvent(
         'in_app_message_show',
-        { type: 'message_event', channel: 'in-app-message', campaign_id: data.campaign_id },
+        { type: 'message_event', channel: 'in-app-message', campaign_id: data.campaign_id, notifly_message_id: data.notifly_message_id },
         null,
         true
     ); // logging in app messaging delivered

package/src/utils.js

@@ -51,15 +51,17 @@ export async function sessionStart() {
     const brandPromise = rnDeviceInfo.getBrand();
     const modelPromise = rnDeviceInfo.getModel();
     const userAgentPromise = rnDeviceInfo.getUserAgent();
+    const notifAuthStatusPromise = messaging().hasPermission();
 
-    const [deviceModel, deviceBrand, apiLevel, userAgent] = await Promise.all([
+    const [deviceModel, deviceBrand, apiLevel, userAgent, notifAuthStatus] = await Promise.all([
         modelPromise,
         brandPromise,
         apiLevelPromise,
         userAgentPromise,
+        notifAuthStatusPromise,
     ]);
 
-    const openAppEventParams = {
+    const sessionStartEventParams = {
         platform,
         type: 'session_start_event',
         device_model: deviceModel,
@@ -68,8 +70,9 @@ export async function sessionStart() {
             api_level: apiLevel,
             user_agent: userAgent,
         },
+        notif_auth_status: notifAuthStatus,
     };
-    await logEvent('session_start', openAppEventParams, null, true);
+    await logEvent('session_start', sessionStartEventParams, null, true);
 }
 
 /**
@@ -97,14 +100,14 @@ export async function clickHandler(remoteMessage) {
     }
 
     try {
-        const { data: { link, campaign_id } = {} } = remoteMessage;
+        const { data: { link, campaign_id, notifly_message_id } = {} } = remoteMessage;
 
         if (link) {
             Linking.openURL(link);
         }
         await logEvent(
             'push_click',
-            { channel: 'push-notification', type: 'message_event', campaign_id, status: 'quit' },
+            { channel: 'push-notification', type: 'message_event', campaign_id, notifly_message_id, status: 'quit' },
             null,
             true
         );
@@ -112,3 +115,28 @@ export async function clickHandler(remoteMessage) {
         console.warn('[Notifly] custom click handler registration failed.');
     }
 }
+
+// React Native does not support Buffer out of the box, so we need to implement our own base64 decoder.
+export function base64Decode(input) {
+    const chars =
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+    let str = '';
+    let output = '';
+
+    for (let i = 0; i < input.length; i += 4) {
+        const encoded1 = chars.indexOf(input[i]);
+        const encoded2 = chars.indexOf(input[i + 1]);
+        const encoded3 = chars.indexOf(input[i + 2]);
+        const encoded4 = chars.indexOf(input[i + 3]);
+
+        const decoded1 = (encoded1 << 2) | (encoded2 >> 4);
+        const decoded2 = ((encoded2 & 15) << 4) | (encoded3 >> 2);
+        const decoded3 = ((encoded3 & 3) << 6) | encoded4;
+
+        output += String.fromCharCode(decoded1);
+        if (encoded3 !== 64) output += String.fromCharCode(decoded2);
+        if (encoded4 !== 64) output += String.fromCharCode(decoded3);
+    }
+
+    return output;
+}