react-native-moengage 8.4.0 → 8.5.1

package/src/models/MoEProperties.ts

@@ -1,4 +1,5 @@
 /// Helper class to track event attributes.
+import MoEngageLogger from "../logger/MoEngageLogger";
 import { MoEGeoLocationToJson } from "../utils/MoEObjectToJson";
 import MoEGeoLocation from "./MoEGeoLocation";
 
@@ -42,7 +43,7 @@ export default class MoEProperties {
     if (Array.isArray(value)) {
       value = (value as Array<any>).filter(e => (this.validateType(["string", "number"], e)));
     } else if (!this.validateType(["string", "number", "boolean"], value)) {
-      console.warn("MoEProperties->addAttribute: invalid attribute");
+      MoEngageLogger.warn("MoEProperties->addAttribute: invalid attribute");
       return
     }
 
@@ -60,7 +61,7 @@ export default class MoEProperties {
       return;
     }
     if (!this.validateType(["string"], date)) {
-      console.warn("MoEProperties->addDateAttribute:  invalid date attribute");
+      MoEngageLogger.warn("MoEProperties->addDateAttribute:  invalid date attribute");
       return
     }
     this.dateTimeAttributes[key.toString()] = date;
@@ -81,7 +82,7 @@ export default class MoEProperties {
     if (this.validateLatLong(location)) {
       this.locationAttributes[key.toString()] = MoEGeoLocationToJson(location)
     } else {
-      console.warn("MoEGeoLocation->addLocationAttribute: invalid coordinates");
+      MoEngageLogger.warn("MoEGeoLocation->addLocationAttribute: invalid coordinates");
     }
   }
 
@@ -103,10 +104,10 @@ export default class MoEProperties {
 
   private validateLatLong(location: MoEGeoLocation) {
     return (
-      location.latitude > -91 &&
-      location.latitude < 91 &&
-      location.longitude > -181 &&
-      location.longitude < 181
+      location.latitude.valueOf() > -91 &&
+      location.latitude.valueOf() < 91 &&
+      location.longitude.valueOf() > -181 &&
+      location.longitude.valueOf() < 181
     );
   }
 }

package/src/models/MoEPushCampaign.ts

@@ -2,10 +2,12 @@ export default class MoEPushCampaign {
   payload: Map<String, Object>;
   isDefaultAction: Boolean;
   clickAction: Map<String, Object>;
+  selfHandledPushRedirection: boolean;
 
-  constructor(payload: Map<String, Object>, isDefaultAction: Boolean, clickAction: Map<String, Object>) {
+  constructor(payload: Map<String, Object>, isDefaultAction: Boolean, clickAction: Map<String, Object>, selfHandledPushRedirection: boolean) {
     this.payload = payload;
     this.isDefaultAction = isDefaultAction;
     this.clickAction = clickAction;
+    this.selfHandledPushRedirection = selfHandledPushRedirection;
   }
 }

package/src/models/MoEPushConfig.ts

@@ -0,0 +1,25 @@
+/**
+ * Config class for Push Notification
+ * Note: This Config is only for Android platform and is a no-operation method for other plaforms.
+ */
+export default class MoEPushConfig {
+
+    shouldDeliverCallbackOnForegroundClick: boolean;
+
+    /**
+     * Create an instance of {@link MoEPushConfig}
+     * 
+     * @param shouldDeliverCallbackOnForegroundClick true to handle the callback in the hybrid side 
+     * if notification is clicked in foreground,
+     */
+    constructor (shouldDeliverCallbackOnForegroundClick: boolean) {
+        this.shouldDeliverCallbackOnForegroundClick = shouldDeliverCallbackOnForegroundClick;
+    }
+
+    /**
+     * Default Config for {@link MoEPushConfig}
+     */
+    static defaultConfig() {
+        return new MoEPushConfig(false);
+    }
+}

package/src/models/MoEngageLogConfig.ts

@@ -0,0 +1,69 @@
+import {
+    DEFAULT_CONFIG_LOG_LEVEL,
+    DEFAULT_CONFIG_RELEASE_BUILD_LOG_ENABLED
+} from "../utils/MoEConstants";
+
+/**
+ * Config class to configure the React-Native Plugin log.
+ * Notes: To configure Native Module log check on Android / iOS initialisation config.
+ */
+export default class MoEngageLogConfig {
+
+    logLevel: MoEngageLogLevel = DEFAULT_CONFIG_LOG_LEVEL;
+
+    isEnabledForReleaseBuild: boolean = DEFAULT_CONFIG_RELEASE_BUILD_LOG_ENABLED;
+
+    /**
+     * Create an instance for MoEngageLogConfig
+     * 
+     * @param logLevel - Min log level which need to be printed on console
+     * @param isEnabledForReleaseBuild - enable / disable the log in release build
+     */
+    constructor(logLevel: MoEngageLogLevel, isEnabledForReleaseBuild: boolean) {
+        this.logLevel = logLevel;
+        this.isEnabledForReleaseBuild = isEnabledForReleaseBuild;
+    }
+
+    /**
+     * Default config for the log
+     */
+    static defaultConfig() {
+        return new MoEngageLogConfig(DEFAULT_CONFIG_LOG_LEVEL, DEFAULT_CONFIG_RELEASE_BUILD_LOG_ENABLED);
+    }
+}
+
+/**
+ * Different Log Level Supported by the {@link MoEngageLogConfig}
+ */
+export const enum MoEngageLogLevel {
+
+    /**
+     * No logs from the SDK would be printed.
+     */
+    NO_LOG = 0,
+
+    /**
+     * Error logs from the SDK would be printed.
+     */
+    ERROR = 1,
+
+    /**
+     * Warning logs from the SDK would be printed.
+     */
+    WARN = 2,
+
+    /**
+     * Info logs from the SDK would be printed.
+     */
+    INFO = 3,
+
+    /**
+     * Debug logs from the SDK would be printed.
+     */
+    DEBUG = 4,
+
+    /**
+     * Verbose logs from the SDK would be printed.
+     */
+    VERBOSE = 5
+}

package/src/moeParser/MoEInAppParser.ts

@@ -1,3 +1,4 @@
+import MoEngageLogger from "../logger/MoEngageLogger";
 import MoEAccountMeta from "../models/MoEAccountMeta";
 import MoECampaignContext from "../models/MoECampaignContext";
 import MoECampaignData from "../models/MoECampaignData";
@@ -7,7 +8,27 @@ import MoEInAppData from "../models/MoEInAppData";
 import MoEInAppNavigation from "../models/MoEInAppNavigation";
 import MoESelfHandledCampaign from "../models/MoESelfHandledCampaign";
 import MoESelfHandledCampaignData from "../models/MoESelfHandledCampaignData";
-import { ACTION_TYPE, APP_ID, ATTRIBUTES, FORMATTED_CAMPAIGN_ID, MOE_CAMPAIGN_CONTEXT, MOE_CAMPAIGN_ID, MOE_CAMPAIGN_NAME, MOE_CUSTOM_ACTION, MOE_CUSTOM_ACTION_OBJ_ERROR, MOE_DISMISSINTERVAL, MOE_IN_APP_OBJECT_ERROR, MOE_IS_CANCELLABLE, MOE_KEY_VALUE_PAIR, MOE_NAVIGATION, MOE_NAVIGATION_OBJ_ERROR, MOE_NAVIGATION_TYPE, MOE_PAYLOAD, MOE_PLATFORM, MOE_SELF_HANDLED, MOE_SELF_HANDLED_OBJ_ERROR, MOE_NAVIGATION_VALUE, MOE_WIDGET_ID } from "../utils/MoEConstants";
+import {
+    ACTION_TYPE,
+    APP_ID,
+    FORMATTED_CAMPAIGN_ID,
+    MOE_CAMPAIGN_CONTEXT,
+    MOE_CAMPAIGN_ID,
+    MOE_CAMPAIGN_NAME,
+    MOE_CUSTOM_ACTION,
+    MOE_CUSTOM_ACTION_OBJ_ERROR,
+    MOE_DISMISSINTERVAL,
+    MOE_IN_APP_OBJECT_ERROR,
+    MOE_KEY_VALUE_PAIR,
+    MOE_NAVIGATION,
+    MOE_NAVIGATION_OBJ_ERROR,
+    MOE_NAVIGATION_TYPE,
+    MOE_PAYLOAD,
+    MOE_PLATFORM,
+    MOE_SELF_HANDLED,
+    MOE_SELF_HANDLED_OBJ_ERROR,
+    MOE_NAVIGATION_VALUE
+} from "../utils/MoEConstants";
 import { isValidObject } from "../utils/MoEHelper";
 
 /**
@@ -26,7 +47,7 @@ export function isMoEInAppCampaignValid(obj: { [k: string]: any }) {
         }
     }
     catch (error: any) {
-        console.log(error?.message);
+        MoEngageLogger.error(error?.message);
         return false;
     }
 }
@@ -37,7 +58,7 @@ function getMoEAccountMeta(accountMeta: { [k: string]: any }) {
 }
 
 function getMoECampaignData(json: { [k: string]: any }) {
-    console.log("getMoECampaignData(): Payload: ", json)
+    MoEngageLogger.verbose("getMoECampaignData(): Payload: ", json);
     var campaignId = json[MOE_CAMPAIGN_ID];
     var campaignName = json[MOE_CAMPAIGN_NAME];
     var campaignContext = json[MOE_CAMPAIGN_CONTEXT];
@@ -86,7 +107,7 @@ export function getMoEInAppData(json: { [k: string]: any }, accountMetaPayload:
  * this funtion creates MoESelfHandledCampaignData Object from json
  */
 export function getMoESelfHandledCampaignData(json: { [k: string]: any }, accountMetaPayload: { [k: string]: any }) {
-    console.log("getMoESelfHandledCampaignData(): Payload: ", json);
+    MoEngageLogger.verbose("getMoESelfHandledCampaignData(): Payload: ", json);
     if (isSelfHandledCampaignValid(json)) {
         var campaignData = getMoECampaignData(json);
         var platform = json[MOE_PLATFORM];
@@ -111,7 +132,7 @@ export function isInAppCustomActionValid(obj: { [k: string]: any }) {
         }
     }
     catch (error: any) {
-        console.log(error?.message);
+        MoEngageLogger.error(error?.message);
         return false;
     }
 }
@@ -153,7 +174,7 @@ export function isSelfHandledCampaignValid(obj: { [k: string]: any }) {
         }
     }
     catch (error: any) {
-        console.log(error?.message);
+        MoEngageLogger.error(error?.message);
         return false;
     }
 }
@@ -171,7 +192,7 @@ export function isNavigationValid(obj: { [k: string]: any }) {
         }
     }
     catch (error: any) {
-        console.log(error?.message);
+        MoEngageLogger.error(error?.message);
         return false;
     }
 }

package/src/moeParser/MoEPushNotificationParser.ts

@@ -1,8 +1,9 @@
+import MoEngageLogger from "../logger/MoEngageLogger";
 import MoEAccountMeta from "../models/MoEAccountMeta";
 import MoEPushCampaign from "../models/MoEPushCampaign";
 import MoEPushPayload from "../models/MoEPushPayload";
 import MoEPushToken from "../models/MoEPushToken";
-import { APP_ID, MOE_CLICKED_ACTION, MOE_IS_DEFAULT_ACTION, MOE_PAYLOAD, MOE_PLATFORM, MOE_PUSH_CAMPAIGN_OBJ_ERROR, MOE_PUSH_SERVICE, MOE_PUSH_TOKEN_OBJ_ERROR, MOE_TOKEN } from "../utils/MoEConstants";
+import { APP_ID, MOE_CLICKED_ACTION, MOE_IS_DEFAULT_ACTION, MOE_PAYLOAD, MOE_PLATFORM, MOE_PUSH_CAMPAIGN_OBJ_ERROR, MOE_PUSH_SERVICE, MOE_PUSH_TOKEN_OBJ_ERROR, MOE_TOKEN, SELF_HANDLED_PUSH_REDIRECTION_KEY } from "../utils/MoEConstants";
 
 
 /**
@@ -19,7 +20,7 @@ export function isPushTokenValid(tokenPayload: { [k: string]: any }) {
         }
     }
     catch (error: any) {
-        console.log(error?.message);
+        MoEngageLogger.error(error?.message);
         return false;
     }
 
@@ -54,7 +55,7 @@ export function isPushCampaignObjectValid(pushPayload: { [k: string]: any }) {
         }
     }
     catch (error: any) {
-        console.log(error?.message);
+        MoEngageLogger.error(error?.message);
         return false;
     }
 
@@ -68,7 +69,10 @@ export function getMoEPushPayload(pushPayload: { [k: string]: any },accountMetaP
         var payload = pushPayload[MOE_PAYLOAD];
         var isDefaultAction = pushPayload[MOE_IS_DEFAULT_ACTION];
         var clickAction = pushPayload[MOE_CLICKED_ACTION];
-        var pushCampaignPayload = new MoEPushCampaign(payload, isDefaultAction, clickAction);
+        var selfHandledPushRedirection = SELF_HANDLED_PUSH_REDIRECTION_KEY in pushPayload
+                ? pushPayload[SELF_HANDLED_PUSH_REDIRECTION_KEY]
+                : false;
+        var pushCampaignPayload = new MoEPushCampaign(payload, isDefaultAction, clickAction, selfHandledPushRedirection);
         var accountMeta = new MoEAccountMeta(accountMetaPayload[APP_ID])
         var platform = pushPayload[MOE_PLATFORM];
         return new MoEPushPayload(accountMeta, pushCampaignPayload,platform);

package/src/moeParser/MoEngagePayloadParser.ts

@@ -1,4 +1,3 @@
-import {MoEngagePermissionType} from "../models/MoEngagePermissionType";
 import MoEngagePersimissionResultData from "../models/MoEngagePersimissionResultData";
 import {MOE_PERMISSION_STATE, MOE_PERMISSION_TYPE, MOE_PLATFORM} from "../utils/MoEConstants";
 

package/src/platform/MoERNAndroid.ts

@@ -1,17 +1,8 @@
+import MoEngageLogger from "../logger/MoEngageLogger";
 import { MoEngagePermissionType } from "../models/MoEngagePermissionType";
-import {
-  getAdIdTrackingJson,
-  getAndroidIdTrackingJson,
-  getAppIdJson,
-  getMoEPushCampaignJson,
-  getMoEPushTokenJson,
-  getOptOutTrackingJson,
-  getPermissionResponseJson,
-  getSdkStateJson
-} from "../utils/MoEJsonBuilder";
+import { getPermissionResponseJson } from "../utils/MoEJsonBuilder";
 
 const MoEReactBridge = require("react-native").NativeModules.MoEReactBridge;
-const PLATFORM_ANDROID = "android";
 
 export class MoERNAndroid {
   static initialize(payload: { [k: string]: any }) {
@@ -96,7 +87,7 @@ export class MoERNAndroid {
 
   static validateSDKVersion() {
     MoEReactBridge.validateSdkVersion().catch((error: Error) => {
-      console.error(error.message);
+      MoEngageLogger.error(error.message);
     });
   }
 
@@ -116,7 +107,7 @@ export class MoERNAndroid {
     MoEReactBridge.deviceIdentifierTrackingStatusUpdate(JSON.stringify(payload))
   }
 
-  static disableAdIdTracking(payload: { [k: string]: any }) { 
+  static disableAdIdTracking(payload: { [k: string]: any }) {
     MoEReactBridge.deviceIdentifierTrackingStatusUpdate(JSON.stringify(payload))
   }
 
@@ -155,7 +146,4 @@ export class MoERNAndroid {
   static disableDeviceIdTracking(payload: { [k: string]: any }) {
     MoEReactBridge.deviceIdentifierTrackingStatusUpdate(JSON.stringify(payload))
   }
-}
-
-const PUSH_SERVICE_FCM = "FCM"
-const PUSH_SERVICE_PUSH_KIT = "PUSH_KIT"
+}

package/src/platform/MoERNiOS.ts

@@ -1,4 +1,4 @@
-import { getAppIdJson, getOptOutTrackingJson } from "../utils/MoEJsonBuilder";
+import MoEngageLogger from "../logger/MoEngageLogger";
 
 const MoEReactBridge = require("react-native").NativeModules.MoEReactBridge;
 
@@ -65,7 +65,7 @@ export class MoERNiOS {
 
   static validateSDKVersion() {
     MoEReactBridge.validateSDKVersion().catch((error: Error) => {
-      console.error(error.message);
+      MoEngageLogger.error(error.message);
     });
   }
 

package/src/utils/MoEConstants.ts

@@ -1,3 +1,5 @@
+import { MoEngageLogLevel } from "../models/MoEngageLogConfig"
+
 export const MOE_PLATFORM = 'platform'
 export const MOE_PAYLOAD = 'payload'
 export const MOE_DATA = 'data'
@@ -59,3 +61,17 @@ export const USER_ATTRIBUTE_USER_LOCATION = 'USER_ATTRIBUTE_USER_LOCATION';
 export const MOE_PERMISSION_TYPE = "type";
 export const MOE_PERMISSION_STATE = "isGranted";
 
+// INIT CONFIG
+export const KEY_MOE_CONFIG = "config";
+export const KEY_PUSH_CONFIG = "pushConfig";
+
+// PUSH CLICK KEY
+export const SELF_HANDLED_PUSH_REDIRECTION_KEY = "selfHandledPushRedirection";
+
+// Default Log Level For MoEngage React Plugin
+export const DEFAULT_CONFIG_LOG_LEVEL = MoEngageLogLevel.INFO;
+
+// Default Logging For Production Build
+export const DEFAULT_CONFIG_RELEASE_BUILD_LOG_ENABLED = false;
+
+

package/src/utils/MoEJsonBuilder.ts

@@ -5,6 +5,8 @@ import MoESelfHandledCampaignData from "../models/MoESelfHandledCampaignData";
 import { MOE_LOCATION } from "./MoEConstants";
 import { MoEPropertiesToJson} from "./MoEObjectToJson";
 import {MoEngagePermissionType} from "../models/MoEngagePermissionType";
+import MoEInitConfig from "../models/MoEInitConfig";
+import MoEngageLogger from "../logger/MoEngageLogger";
 
 export function getInAppCampaignJson(moEInAppData: MoEInAppData, type: string, appId: String) {
   var json: { [k: string]: any } = {
@@ -36,7 +38,7 @@ export function getSelfHandledJson(moESelfHandledCampaignData: MoESelfHandledCam
       platform: moESelfHandledCampaignData.platform
     }
   }
-  console.log("getSelfHandledJson(): payload json: ", json)
+  MoEngageLogger.verbose("getSelfHandledJson(): payload json: ", json);
   return json;
 }
 
@@ -250,4 +252,18 @@ export function getDeviceIdTrackingJson(isDeviceIdTrackingEnabled: Boolean, appI
     }
   }
   return json;
+}
+
+export function getInitConfigJson(appId: String, initConfig: MoEInitConfig) {
+  var json: { [k: string]: any } = {
+    accountMeta: {
+      appId: appId
+    },
+    initConfig: {
+      pushConfig: {
+        shouldDeliverCallbackOnForegroundClick: initConfig.pushConfig.shouldDeliverCallbackOnForegroundClick
+      }
+    }
+  }
+  return json;
 }

package/src/utils/MoEngageGlobalCache.ts

@@ -0,0 +1,22 @@
+import MoEInitConfig from "../models/MoEInitConfig";
+
+/**
+ * In Memory Cache for Plugin
+ */
+namespace MoEngageGlobalCache {
+
+    /**
+     * Plugin Init Config
+     */
+    let initConfig: MoEInitConfig = MoEInitConfig.defaultConfig();
+
+    export function updateInitConfig(updatedConfig: MoEInitConfig) {
+        initConfig = updatedConfig;
+    }
+
+    export function getInitConfig(): MoEInitConfig {
+        return initConfig;
+    }
+}
+
+export default MoEngageGlobalCache;