notifly-sdk 2.1.3 → 2.2.4

package/index.js

@@ -6,11 +6,69 @@ import logEvent from './src/log_event';
 import { setUserProperties, removeUserId } from './src/user';
 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),
@@ -118,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.3",
+  "version": "2.2.4",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/constant.js

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

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);
 }
 
 /**