notifly-sdk 2.3.3 → 2.3.5

package/.eslintrc.cjs

@@ -0,0 +1,40 @@
+module.exports = {
+    root: true,
+    env: {
+        es6: true,
+        jest: true,
+        node: true,
+        'react-native/react-native': true,
+    },
+    parser: '@babel/eslint-parser',
+    plugins: ['react', 'react-native'],
+    extends: ['eslint:recommended', 'plugin:react/recommended'],
+    rules: {
+        'react/prop-types': 'off',
+        'react/react-in-jsx-scope': 'off',
+        'no-console': 'off',
+        'no-unused-vars': 'warn',
+        'react-native/no-unused-styles': 'warn',
+        'react-native/split-platform-components': 'warn',
+        'react-native/no-inline-styles': 'warn',
+        'react-native/no-color-literals': 'warn',
+        'react-native/no-raw-text': 'warn',
+    },
+    settings: {
+        react: {
+            version: 'detect',
+        },
+    },
+    parserOptions: {
+        requireConfigFile: false,
+        ecmaVersion: 2021,
+        sourceType: 'module',
+        ecmaFeatures: {
+            jsx: true,
+        },
+        babelOptions: {
+            presets: ['@babel/preset-env', '@babel/preset-react'],
+            plugins: ['@babel/plugin-syntax-import-assertions'],
+        },
+    },
+};

package/.prettierrc.yml

@@ -0,0 +1,14 @@
+# .prettierrc or .prettierrc.yaml
+proseWrap: 'preserve'
+trailingComma: 'es5'
+tabWidth: 4
+semi: true
+singleQuote: true
+quoteProps: 'preserve'
+printWidth: 120
+overrides:
+    - files:
+          - '*.json'
+          - '*.yml'
+      options:
+          tabWidth: 2

package/README.md

@@ -19,9 +19,15 @@ or
 yarn add notifly-sdk@latest
 ```
 
+Also, please install the peer dependencies manually:
+
+```
+npm install @react-native-async-storage/async-storage@^1.17.11 @react-native-firebase/app@^16.4.3 @react-native-firebase/messaging@^16.4.3 react-native-device-info@^8.1.4 react-native-modal@^13.0.1 react-native-root-siblings@^4.1.1 react-native-webview@^11.26.1 uuid@^8.3.0
+```
+
 ## Usage
 
 Please refer to our official documentation: 
 
-* [English documentation](https://docs.notifly.tech/developer-guide/client-sdk/react-native-sdk)
-* [Korean documentation](https://docs.notifly.tech/ko/developer-guide/client-sdk/react-native-sdk)
+* [English documentation](https://docs.notifly.tech/client-sdk/react-native)
+* [Korean documentation](https://docs.notifly.tech/ko/client-sdk/react-native)

package/index.js

@@ -0,0 +1,190 @@
+import { Linking } from 'react-native';
+import RootSiblings from 'react-native-root-siblings';
+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 { base64Decode, clickHandler, sessionStart } from './src/utils';
+import { showInAppMessage } from './src/in_app_message';
+let isSetBackgroundHandler = false;
+let isNotiflyInitialized = false;
+const openedInAppWebViewCount = { count: 0 };
+
+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.
+ *
+ * @async
+ * @param {string} userID - The external user ID for the user.
+ * @returns {Promise<void>} - A promise that resolves when the user ID is set.
+ *
+ * @example
+ * await setUserId('123456789');
+ */
+exports.setUserId = async function (userID) {
+    try {
+        if (userID) {
+            await setUserProperties({
+                external_user_id: userID,
+            });
+            return;
+        }
+        await removeUserId();
+        return;
+    } catch (err) {
+        console.warn('[Notifly] setUserId failed.');
+    }
+};
+
+/**
+ * Initializes the Notifly SDK with the given project ID, user name, and password.
+ *
+ * @async
+ * @param {string} prjId - The project ID to use for initialization.
+ * @param {string} userName - The user name to use for authentication.
+ * @param {string} password - The password to use for authentication.
+ * @param {boolean} [useCustomClickHandler=false] - A flag indicating whether to use a custom click handler for push notifications.
+ * @returns {Promise<void>} A promise that resolves when initialization is complete, or rejects with an error.
+ *
+ * @example
+ * await initialize('myProjectId', 'myUserName', 'myPassword');
+ */
+exports.initialize = async function (prjId, userName, password, useCustomClickHandler = false) {
+    if (isNotiflyInitialized) {
+        return;
+    }
+    try {
+        await messaging().requestPermission();
+        // in-app-message
+        messaging().onMessage((remoteMessage) => {
+            new RootSiblings(null).destroy();
+            handleInAppMessage(remoteMessage, openedInAppWebViewCount);
+        });
+
+
+        messaging().onNotificationOpenedApp(handleNotificationOpened);
+
+        // custom push click handler
+        if (!useCustomClickHandler) {
+            const initialNotification = await messaging().getInitialNotification();
+            if (initialNotification) {
+                await clickHandler(initialNotification);
+            }
+        }
+
+        messaging().getToken();
+        messaging().setDeliveryMetricsExportToBigQuery(true);
+
+        await Promise.all([
+            AsyncStorage.setItem('notiflyProjectId', prjId),
+            AsyncStorage.setItem('notiflyUserName', userName),
+            AsyncStorage.setItem('notiflyUserPassword', password),
+        ]);
+        await sessionStart();
+        isNotiflyInitialized = true;
+    } catch (err) {
+        console.warn('[Notifly]: ', err);
+    }
+};
+
+async function handleInAppMessage(remoteMessage, openedInAppWebViewCount) {
+    try {
+        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);
+    }
+}
+
+async function handleNotificationOpened(remoteMessage) {
+    try {
+        if (remoteMessage.data?.notifly_message_type != 'push-notification') {
+            return;
+        }
+        const link = remoteMessage.data?.link;
+        if (link) {
+            Linking.openURL(link);
+        }
+        await logEvent(
+            'push_click',
+            {
+                type: 'message_event',
+                channel: 'push-notification',
+                campaign_id: remoteMessage.data.campaign_id,
+                notifly_message_id: remoteMessage.data?.notifly_message_id,
+                status: 'background',
+            },
+            null,
+            true
+        );
+    } catch (err) {
+        console.warn('[Notifly] Notification opened handling failed:', err);
+    }
+}
+
+exports.setNotiflyBackgroundMessageHandler = setNotiflyBackgroundMessageHandler;
+exports.notiflyBackgroundHandler = notiflyBackgroundHandler;

package/package.json

@@ -1,165 +1,35 @@
 {
   "name": "notifly-sdk",
-  "version": "2.3.3",
-  "description": "test",
-  "main": "lib/commonjs/index",
-  "module": "lib/module/index",
-  "types": "lib/typescript/index.d.ts",
-  "react-native": "src/index",
-  "source": "src/index",
-  "files": [
-    "src",
-    "lib",
-    "android",
-    "ios",
-    "cpp",
-    "*.podspec",
-    "!lib/typescript/example",
-    "!ios/build",
-    "!android/build",
-    "!android/gradle",
-    "!android/gradlew",
-    "!android/gradlew.bat",
-    "!android/local.properties",
-    "!**/__tests__",
-    "!**/__fixtures__",
-    "!**/__mocks__",
-    "!**/.*"
-  ],
+  "version": "2.3.5",
+  "description": "",
+  "main": "index.js",
   "scripts": {
-    "test": "jest",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepack": "bob build",
-    "release": "release-it",
-    "example": "yarn --cwd example",
-    "bootstrap": "yarn example && yarn install && yarn example pods",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build"
-  },
-  "keywords": [
-    "react-native",
-    "ios",
-    "android"
-  ],
-  "repository": "https://github.com/team-michael/notifly-react-native-sdk",
-  "author": "minyonglee <minyong@workmichael.com> (https://github.com/minyonglee)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/team-michael/notifly-react-native-sdk/issues"
-  },
-  "homepage": "https://github.com/team-michael/notifly-react-native-sdk#readme",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "devDependencies": {
-    "@commitlint/config-conventional": "^17.0.2",
-    "@evilmartians/lefthook": "^1.2.2",
-    "@react-native-community/eslint-config": "^3.0.2",
-    "@release-it/conventional-changelog": "^5.0.0",
-    "@types/jest": "^28.1.2",
-    "@types/react": "~17.0.21",
-    "@types/react-native": "0.70.0",
-    "commitlint": "^17.0.2",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^28.1.1",
-    "pod-install": "^0.1.0",
-    "prettier": "^2.0.5",
-    "react": "18.2.0",
-    "react-native": "0.71.8",
-    "react-native-builder-bob": "^0.20.4",
-    "release-it": "^15.0.0",
-    "typescript": "^5.0.2"
-  },
-  "resolutions": {
-    "@types/react": "17.0.21"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "pretty": "prettier --write \"**/*.{js,jsx,json}\"",
+    "lint": "eslint ."
   },
   "peerDependencies": {
-    "react": "*",
-    "react-native": "*"
-  },
-  "engines": {
-    "node": ">= 16.0.0"
-  },
-  "packageManager": "^yarn@1.22.15",
-  "jest": {
-    "preset": "react-native",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/example/node_modules",
-      "<rootDir>/lib/"
-    ]
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "release-it": {
-    "git": {
-      "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
-    },
-    "npm": {
-      "publish": true
-    },
-    "github": {
-      "release": true
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular"
-      }
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@react-native-community",
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/"
-  ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
-  "react-native-builder-bob": {
-    "source": "src",
-    "output": "lib",
-    "targets": [
-      "commonjs",
-      "module",
-      [
-        "typescript",
-        {
-          "project": "tsconfig.build.json"
-        }
-      ]
-    ]
-  },
-  "codegenConfig": {
-    "name": "RNNotiflySdkSpec",
-    "type": "modules",
-    "jsSrcsDir": "src"
+    "@react-native-async-storage/async-storage": "^1.17.11",
+    "@react-native-firebase/app": "^16.4.3",
+    "@react-native-firebase/messaging": "^16.4.3",
+    "react-native-device-info": "^8.1.4",
+    "react-native-modal": "^13.0.1",
+    "react-native-root-siblings": "^4.1.1",
+    "react-native-webview": "^11.26.1",
+    "uuid": "^8.3.0"
+  },
+  "author": "daeseongKim",
+  "license": "ISC",
+  "type": "module",
+  "devDependencies": {
+    "@babel/core": "^7.21.4",
+    "@babel/eslint-parser": "^7.21.3",
+    "@babel/plugin-syntax-import-assertions": "^7.20.0",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-react": "^7.18.6",
+    "eslint": "^8.38.0",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-native": "^4.0.0",
+    "prettier": "^2.8.7"
   }
 }

package/src/auth.js

@@ -0,0 +1,45 @@
+const NOTIFLY_AUTHORIZE_ENDPOINT = 'https://api.notifly.tech/authorize';
+/**
+ * Fetches a Cognito ID token for the given user name and password.
+ *
+ * @async
+ * @param {string} userName - The user name to use for authentication.
+ * @param {string} password - The password to use for authentication.
+ * @returns {Promise<string>} A promise that resolves with the Cognito ID token, or rejects with an error.
+ *
+ * @example
+ * const token = await getCognitoIdToken('myUserName', 'myPassword');
+ */
+export async function getCognitoIdToken(userName, password) {
+    try {
+        const headers = new Headers({
+            'Content-Type': 'application/json',
+        });
+
+        const body = JSON.stringify({
+            password: password,
+            userName: userName,
+        });
+
+        const requestOptions = {
+            method: 'POST',
+            headers,
+            body,
+            redirect: 'follow',
+        };
+
+        const response = await request(NOTIFLY_AUTHORIZE_ENDPOINT, requestOptions);
+        if (response.error || !response.data) {
+            throw new Error(response.error);
+        }
+        const token = response.data
+        return token;
+    } catch (error) {
+        console.warn('[Notifly]: ', error);
+    }
+}
+
+async function request(apiUrl, requestOptions) {
+    const result = await fetch(apiUrl, requestOptions);
+    return result.json();
+}

package/src/constant.js

@@ -0,0 +1,8 @@
+export const SDK_VERSION = '2.3.5';
+
+export const NAMESPACE = {
+    'EVENTID': '830b5f7b-e392-43db-a17b-d835f0bcab2b',
+    'REGISTERED_USERID': 'ce7c62f9-e8ae-4009-8fd6-468e9581fa21',
+    'UNREGISTERED_USERID': 'a6446dcf-c057-4de7-a360-56af8659d52f',
+    'DEVICEID': '830848b3-2444-467d-9cd8-3430d2738c57',
+};