notifly-sdk 2.2.6 → 2.3.0

package/.eslintrc.cjs

@@ -1,40 +0,0 @@
-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

@@ -1,14 +0,0 @@
-# .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/index.js

@@ -1,190 +0,0 @@
-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/src/auth.js

@@ -1,42 +0,0 @@
-/**
- * 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) {
-    const headers = new Headers({
-        'X-Amz-Target': 'AWSCognitoIdentityProviderService.InitiateAuth',
-        'Content-Type': 'application/x-amz-json-1.1',
-    });
-
-    const body = JSON.stringify({
-        AuthFlow: 'USER_PASSWORD_AUTH',
-        AuthParameters: {
-            PASSWORD: password,
-            USERNAME: userName,
-        },
-        ClientId: '2pc5pce21ec53csf8chafknqve',
-    });
-
-    const requestOptions = {
-        method: 'POST',
-        headers,
-        body,
-        redirect: 'follow',
-    };
-
-    try {
-        const response = await fetch('https://cognito-idp.ap-northeast-2.amazonaws.com/', requestOptions);
-        const result = await response.text();
-        const token = JSON.parse(result).AuthenticationResult.IdToken;
-        return token;
-    } catch (error) {
-        console.warn('[Notifly]: ', error);
-    }
-}

package/src/constant.js

@@ -1,8 +0,0 @@
-export const SDK_VERSION = '2.2.6';
-
-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',
-};

package/src/in_app_message.js

@@ -1,258 +0,0 @@
-import React from 'react';
-import { View, Linking, Dimensions } from 'react-native';
-import RootSiblings from 'react-native-root-siblings';
-import Modal from 'react-native-modal';
-import WebView from 'react-native-webview';
-import logEvent from './log_event';
-import { setUserProperties } from './user';
-
-/**
- * Displays an in-app message in a modal WebView.
- *
- * @async
- * @param {Object} data - An object containing information about the in-app message to display.
- * @param {Object} openedInAppWebViewCount - An object containing the count of opened in-app web views.
- * @returns {Promise<void>} A promise that resolves when the in-app message has been displayed, or rejects with an error.
- *
- * @example
- * const data = { campaign_id: 'myCampaign', url: 'https://example.com' };
- * const openedInAppWebViewCount = { count: 0 };
- * await showInAppMessage(data, openedInAppWebViewCount);
- */
-export async function showInAppMessage(data, openedInAppWebViewCount) {
-    if (openedInAppWebViewCount.count > 0) {
-        return;
-    }
-    if (!(data?.url && data?.modal_properties)) {
-        return;
-    }
-    const modalProperties = data.modal_properties || {};
-    const screenWidth = Dimensions.get('window').width;
-    const screenHeight = Dimensions.get('window').height;
-    const webViewProps = _translateWebviewProps(modalProperties, screenWidth, screenHeight);
-    const link = data.url; // default html link for only testing.
-    const injectedJavaScript = `
-        const button_trigger = document.getElementById('notifly-button-trigger');
-        button_trigger.addEventListener('click', function(event){
-            if (!event.notifly_button_click_type) return;
-            window.ReactNativeWebView.postMessage(JSON.stringify({
-                type: event.notifly_button_click_type,
-                button_name: event.notifly_button_name,
-                link: event.notifly_button_click_link,
-                extra_data: event.notifly_extra_data,
-            }));
-        });
-    `;
-    const backdropOpacity = _getBackgroundOpacity(modalProperties?.backgroundOpacity);
-
-    const webviewMessageHandler = (e) => {
-        const message = JSON.parse(e.nativeEvent.data);
-        if (message.type === 'close') {
-            modal.destroy();
-            openedInAppWebViewCount.count = openedInAppWebViewCount.count - 1;
-            logEvent(
-                'close_button_click',
-                {
-                    type: 'message_event',
-                    channel: 'in-app-message',
-                    button_name: message.button_name,
-                    campaign_id: data.campaign_id,
-                    notifly_message_id: data.notifly_message_id,
-                },
-                null,
-                true
-            );
-        } else if (message.type === 'main_button') {
-            logEvent(
-                'main_button_click',
-                {
-                    type: 'message_event',
-                    channel: 'in-app-message',
-                    button_name: message.button_name,
-                    campaign_id: data.campaign_id,
-                    notifly_message_id: data.notifly_message_id,
-                },
-                null,
-                true
-            );
-            if (message.link) {
-                modal.destroy();
-                openedInAppWebViewCount.count = openedInAppWebViewCount.count - 1;
-                Linking.openURL(message.link);
-            }
-        } else if (message.type === 'hide_in_app_message') {
-            modal.destroy();
-            openedInAppWebViewCount.count = openedInAppWebViewCount.count - 1;
-            logEvent(
-                'hide_in_app_message_button_click',
-                {
-                    type: 'message_event',
-                    channel: 'in-app-message',
-                    button_name: message.button_name,
-                    campaign_id: data.campaign_id,
-                    notifly_message_id: data.notifly_message_id,
-                },
-                null,
-                true
-            );
-            if (modalProperties.template_name) {
-                const key = `hide_in_app_message_${modalProperties.template_name}`;
-                setUserProperties({
-                    [key]: true,
-                });
-            }
-        } else if (message.type === 'survey_submit_button') {
-            modal.destroy();
-            openedInAppWebViewCount.count = openedInAppWebViewCount.count - 1;
-            logEvent(
-                'survey_submit_button_click', {
-                    type: 'message_event',
-                    channel: 'in-app-message',
-                    button_name: message.button_name,
-                    campaign_id: data.campaign_id,
-                    notifly_message_id: data.notifly_message_id,
-                    notifly_extra_data: message.extra_data,
-                },
-                null,
-                true
-            );
-        }
-    };
-
-    openedInAppWebViewCount.count = openedInAppWebViewCount.count + 1;
-    logEvent(
-        'in_app_message_show',
-        { 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
-    const modal = new RootSiblings(
-        (
-            <Modal
-                isVisible={true}
-                transparent={true}
-                onBackdropPress={() => {
-                    openedInAppWebViewCount.count = openedInAppWebViewCount.count - 1;
-                    modal.destroy();
-                }}
-                onBackButtonPress={() => {
-                    openedInAppWebViewCount.count = openedInAppWebViewCount.count - 1;
-                    modal.destroy();
-                }}
-                backdropOpacity={backdropOpacity}
-                style={webViewProps.modalStyle}
-            >
-                <View>
-                    <View style={webViewProps.viewStyle}>
-                        <WebView
-                            originWhitelist={['*']}
-                            source={{
-                                uri: link,
-                            }}
-                            style={{
-                                width: screenWidth,
-                                height: screenHeight,
-                            }}
-                            onMessage={webviewMessageHandler}
-                            javaScriptEnabled={true}
-                            injectedJavaScript={injectedJavaScript}
-                        />
-                    </View>
-                </View>
-            </Modal>
-        )
-    );
-}
-
-function _translateWebviewProps(modalProps, screenWidth, screenHeight) {
-    const modalStyle = {
-        margin: 0,
-        justifyContent: 'center',
-        alignItems: 'center',
-        ...(modalProps?.position === 'bottom' && {
-            position: 'absolute',
-            bottom: 0,
-        }),
-    };
-
-    const viewStyle = {
-        borderTopLeftRadius: modalProps?.borderTopLeftRadius || 0,
-        borderTopRightRadius: modalProps?.borderTopRightRadius || 0,
-        borderBottomLeftRadius: modalProps?.borderBottomLeftRadius || 0,
-        borderBottomRightRadius: modalProps?.borderBottomRightRadius || 0,
-        overflow: 'hidden',
-        width: _getViewWidth(modalProps, screenWidth, screenHeight),
-        height: _getViewHeight(modalProps, screenWidth, screenHeight),
-        justifyContent: 'center',
-        alignItems: 'center',
-    };
-
-    return {
-        modalStyle,
-        viewStyle,
-    };
-}
-
-function _getViewWidth(modalProps, screenWidth, screenHeight) {
-    let viewWidth;
-
-    if (modalProps.width) {
-        viewWidth = modalProps.width;
-    } else if (!screenWidth) {
-        console.error('screenWidth is not defined');
-        viewWidth = '100%';
-    } else if (modalProps.width_vw) {
-        viewWidth = screenWidth * (modalProps.width_vw / 100);
-    } else if (modalProps.width_vh && screenHeight) {
-        viewWidth = screenHeight * (modalProps.width_vh / 100);
-    } else {
-        viewWidth = '100%';
-    }
-
-    if (modalProps.min_width && viewWidth < modalProps.min_width) {
-        viewWidth = modalProps.minWidth;
-    }
-    if (modalProps.max_width && viewWidth > modalProps.max_width) {
-        viewWidth = modalProps.maxWidth;
-    }
-
-    return viewWidth;
-}
-
-function _getViewHeight(modalProps, screenWidth, screenHeight) {
-    let viewHeight;
-
-    if (modalProps.height) {
-        viewHeight = modalProps.height;
-    } else if (!screenHeight) {
-        console.error('screenHeight is not defined');
-        viewHeight = '100%';
-    } else if (modalProps.height_vh) {
-        viewHeight = screenHeight * (modalProps.height_vh / 100);
-    } else if (modalProps.height_vw && screenWidth) {
-        viewHeight = screenWidth * (modalProps.height_vw / 100);
-    } else {
-        viewHeight = '100%';
-    }
-
-    if (modalProps.min_height && viewHeight < modalProps.min_height) {
-        viewHeight = modalProps.min_height;
-    }
-    if (modalProps.max_height && viewHeight > modalProps.max_height) {
-        viewHeight = modalProps.max_height;
-    }
-
-    return viewHeight;
-}
-
-function _getBackgroundOpacity(backgroundOpacity) {
-    // if backgroundOpacity is not defined, default value is 0.2
-    if (backgroundOpacity === undefined) {
-        return 0.2;
-    }
-    // if backgroundOpacity is not between 0 and 1, default value is 0.2
-    if (backgroundOpacity < 0 || backgroundOpacity > 1) {
-        return 0.2;
-    }
-    return backgroundOpacity;
-}