react-native-moengage 7.4.0 → 8.0.0

package/src/models/MoEAction.ts

@@ -0,0 +1,4 @@
+
+export default class MoEAction {
+
+}

package/src/models/MoEActionType.ts

@@ -0,0 +1,4 @@
+export enum MoEActionType {
+  NAVIGATION = "navigation",
+  CUSTOM = "customAction"
+}

package/src/models/MoECampaignContext.ts

@@ -0,0 +1,10 @@
+export default class MoECampaignContext {
+     formattedCampaignId:string;
+     attributes: Map<String, Object>;
+  
+    constructor(formattedCampaignId: string, attributes:  Map<String, Object>) {
+      this.formattedCampaignId = formattedCampaignId;
+      this.attributes = attributes;
+    }
+  
+  }

package/src/models/MoECampaignData.ts

@@ -0,0 +1,14 @@
+import MoECampaignContext from "./MoECampaignContext";
+
+export default class MoECampaignData {
+    campaignId: string;
+    campaignName: string;
+    context: MoECampaignContext;
+
+    constructor(campaignId: string, campaignName: string, context: MoECampaignContext) {
+        this.campaignId = campaignId;
+        this.campaignName = campaignName;
+        this.context = context;
+    }
+
+}

package/src/models/MoEClickData.ts

@@ -0,0 +1,18 @@
+import MoEAccountMeta from "./MoEAccountMeta";
+import MoECampaignData from "./MoECampaignData";
+import MoEAction from "./MoEAction";
+import { MoEPlatform } from "./MoEPlatform";
+
+export default class MoEClickData {
+    accountMeta: MoEAccountMeta;
+    platform: MoEPlatform;
+    campaignData: MoECampaignData;
+    action: MoEAction;
+    constructor(accountMeta: MoEAccountMeta, platform: MoEPlatform, campaignData: MoECampaignData, action: MoEAction) {
+        this.accountMeta = accountMeta;
+        this.platform = platform;
+        this.campaignData = campaignData;
+        this.action = action;
+    }
+
+}

package/src/models/MoEGeoLocation.ts

@@ -3,16 +3,8 @@ export default class MoEGeoLocation {
   longitude: Number;
 
   constructor(latitude: Number, longitude: Number) {
-    if (typeof latitude == "number" && typeof longitude == "number") {
-      this.latitude = latitude;
-      this.longitude = longitude;
-    }
+    this.latitude = latitude;
+    this.longitude = longitude;
   }
 
-  toJSON(): Object {
-    return {
-      latitude: this.latitude,
-      longitude: this.longitude,
-    };
-  }
 }

package/src/models/MoEInAppCustomAction.ts

@@ -1,19 +1,14 @@
-import { isValidObject } from "../utils/MoEHelper";
+import MoEAction from "./MoEAction";
+import { MoEActionType } from "./MoEActionType";
 
-export default class MoEInAppCustomAction {
+export default class MoEInAppCustomAction extends MoEAction{
   keyValuePair: Map<String, Object>;
+  actionType: MoEActionType;
 
-  constructor(customAction: Object) {
-    if (isValidObject(customAction)) {
-      if (isValidObject(customAction["kvPair"])) {
-        this.keyValuePair = customAction["kvPair"];
-      }
-    }
+  constructor(keyValuePair: Map<String, Object>, actionType: MoEActionType) {
+    super();
+    this.keyValuePair = keyValuePair;
+    this.actionType = actionType
   }
 
-  toJSON(): Object {
-    return {
-      kvPair: this.keyValuePair,
-    };
-  }
 }

package/src/models/MoEInAppData.ts

@@ -0,0 +1,16 @@
+import MoEAccountMeta from "./MoEAccountMeta";
+import MoECampaignData from "./MoECampaignData";
+import { MoEPlatform } from "./MoEPlatform";
+
+export default class MoEInAppData {
+    accountMeta: MoEAccountMeta;
+    platform: MoEPlatform;
+    campaignData: MoECampaignData;
+
+    constructor(accountMeta: MoEAccountMeta, platform: MoEPlatform, campaignData: MoECampaignData) {
+        this.accountMeta = accountMeta;
+        this.platform = platform;
+        this.campaignData = campaignData;
+    }
+
+}

package/src/models/MoEInAppNavigation.ts

@@ -1,29 +1,19 @@
-import { isValidObject, isValidString } from "../utils/MoEHelper";
+import MoEAction from "./MoEAction";
+import { MoEActionType } from "./MoEActionType";
+import { MoENavigationType } from "./MoENavigationType";
 
-export default class MoEInAppNavigation {
-  navigationType: String;
-  url: String;
-  keyValuePair: Map<String, Object>;
+export default class MoEInAppNavigation extends MoEAction {
+  navigationType: MoENavigationType;
+  navigationUrl: String;
+  keyValuePair?: Map<String, Object>;
+  actionType :MoEActionType;
 
-  constructor(navigation: Object) {
-    if (isValidObject(navigation)) {
-      if (isValidString(navigation["navigationType"])) {
-        this.navigationType = navigation["navigationType"];
-      }
-      if (isValidString(navigation["value"])) {
-        this.url = navigation["value"];
-      }
-      if (isValidObject(navigation["kvPair"])) {
-        this.keyValuePair = navigation["kvPair"];
-      }
-    }
+  constructor(navigationType: MoENavigationType, navigationUrl: String, keyValuePair: Map<String, Object>,actionType:MoEActionType) {
+    super();
+    this.navigationType = navigationType;
+    this.navigationUrl = navigationUrl;
+    this.keyValuePair = keyValuePair;
+    this.actionType = actionType;
   }
 
-  toJSON(): Object {
-    return {
-      navigationType: this.navigationType,
-      value: this.url,
-      kvPair: this.keyValuePair,
-    };
-  }
 }

package/src/models/MoENavigationType.ts

@@ -0,0 +1,4 @@
+export enum MoENavigationType {
+    SCREEN = "screen",
+    DEEP_LINK = "deep_linking"
+  }

package/src/models/MoEPlatform.ts

@@ -0,0 +1,4 @@
+export enum MoEPlatform {
+    Android = "android",
+    IOS = "iOS"
+  }

package/src/models/MoEProperties.ts

@@ -1,10 +1,11 @@
 /// Helper class to track event attributes.
+import { MoEGeoLocationToJson } from "../utils/MoEObjectToJson";
 import MoEGeoLocation from "./MoEGeoLocation";
 
 export default class MoEProperties {
-  private generalAttributes: Object;
-  private locationAttributes: Object;
-  private dateTimeAttributes: Object;
+  private generalAttributes: { [k: string]: any }
+  private locationAttributes: { [k: string]: any};
+  private dateTimeAttributes: { [k: string]: any };
   private isNonInteractive: Boolean;
 
   constructor() {
@@ -14,15 +15,18 @@ export default class MoEProperties {
     this.isNonInteractive = false;
   }
 
-  toJSON(): Object {
-    return {
-      eventAttributes: {
-        generalAttributes: this.generalAttributes,
-        locationAttributes: this.locationAttributes,
-        dateTimeAttributes: this.dateTimeAttributes,
-      },
-      isNonInteractive: this.isNonInteractive,
-    };
+  getGeneralAttributes() {
+    return this.generalAttributes;
+  }
+
+  getLocationAttributess() {
+    return this.locationAttributes;
+  }
+  getDateTimeAttributes() {
+    return this.dateTimeAttributes;
+  }
+  getIsNonInteractive() {
+    return this.isNonInteractive;
   }
 
   /**
@@ -36,12 +40,12 @@ export default class MoEProperties {
       return;
     }
     if (Array.isArray(value)) {
-      value = (value as Array<any>).filter( e => (this.validateType(["string", "number"], e)));
+      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");
       return
     }
-    
+
     this.generalAttributes[key.toString()] = value;
   }
 
@@ -75,7 +79,7 @@ export default class MoEProperties {
       return;
     }
     if (this.validateLatLong(location)) {
-      this.locationAttributes[key.toString()] = location.toJSON();
+      this.locationAttributes[key.toString()] = MoEGeoLocationToJson(location)
     } else {
       console.warn("MoEGeoLocation->addLocationAttribute: invalid coordinates");
     }

package/src/models/MoEPushCampaign.ts

@@ -1,27 +1,11 @@
-import { isValidObject, isValidString } from "../utils/MoEHelper";
-
 export default class MoEPushCampaign {
-  platform: String;
   payload: Map<String, Object>;
-  isDefaultAction: Boolean
-  clickAction: Map<String, Object>
+  isDefaultAction: Boolean;
+  clickAction: Map<String, Object>;
 
-  constructor(pushPayload: Object) {
-    if (isValidObject(pushPayload)) {
-      if (isValidString(pushPayload["platform"])) {
-        this.platform = pushPayload["platform"];
-      }
-      if (isValidObject(pushPayload["payload"])) {
-        this.payload = pushPayload["payload"];
-      }
-      if("isDefaultAction" in pushPayload){
-        this.isDefaultAction = pushPayload["isDefaultAction"]
-      }else{
-        this.isDefaultAction = false
-      }
-      if("clickedAction" in pushPayload){
-        this.clickAction = pushPayload["clickedAction"]
-      }
-    }
+  constructor(payload: Map<String, Object>, isDefaultAction: Boolean, clickAction: Map<String, Object>) {
+    this.payload = payload;
+    this.isDefaultAction = isDefaultAction;
+    this.clickAction = clickAction;
   }
 }

package/src/models/MoEPushPayload.ts

@@ -0,0 +1,14 @@
+import MoEAccountMeta from "./MoEAccountMeta";
+import { MoEPlatform } from "./MoEPlatform";
+import MoEPushCampaign from "./MoEPushCampaign";
+
+export default class MoEPushPayload {
+  accountMeta: MoEAccountMeta;
+  data: MoEPushCampaign;
+  platform: MoEPlatform;
+  constructor(accountMeta:  MoEAccountMeta, data: MoEPushCampaign, platform: MoEPlatform) {
+    this.accountMeta = accountMeta;
+    this.data = data;
+    this.platform = platform;
+  }
+}

package/src/models/MoEPushService.ts

@@ -1,6 +1,6 @@
 export enum MoEPushService {
-  APNS,
-  FCM,
-  MI_PUSH,
-  PUSH_KIT,
+  APNS = "APNS",
+  FCM = "FCM",
+  MI_PUSH = "MI_PUSH",
+  PUSH_KIT = "PUSH_KIT",
 }

package/src/models/MoEPushToken.ts

@@ -1,23 +1,14 @@
-import { isValidObject, isValidString } from "../utils/MoEHelper";
+import { MoEPlatform } from "./MoEPlatform";
 import { MoEPushService } from "./MoEPushService";
 
 export default class MoEPushToken {
-  platform: String;
+  platform: MoEPlatform;
   pushService: MoEPushService;
   token: String;
 
-  constructor(tokenPayload: Object) {
-    if (isValidObject(tokenPayload)) {
-      if (isValidString(tokenPayload["platform"])) {
-        this.platform = tokenPayload["platform"];
-      }
-      if (isValidString(tokenPayload["token"])) {
-          this.token = tokenPayload["token"];
-       }
-      if (isValidString(tokenPayload["pushService"])) {
-        this.pushService = tokenPayload["pushService"] as MoEPushService;
-      }
-    }
+  constructor(platform: MoEPlatform, pushService: MoEPushService, token: String) {
+    this.platform = platform;
+    this.pushService = pushService;
+    this.token = token;
   }
 }
-  

package/src/models/MoESelfHandledCampaign.ts

@@ -0,0 +1,10 @@
+export default class MoESelfHandledCampaign {
+    payload: string;
+    dismissInterval: Number;
+
+    constructor(payload: string, dismissInterval: Number) {
+        this.payload = payload;
+        this.dismissInterval = dismissInterval;
+    }
+
+}

package/src/models/MoESelfHandledCampaignData.ts

@@ -0,0 +1,18 @@
+import MoEAccountMeta from "./MoEAccountMeta";
+import MoECampaignData from "./MoECampaignData";
+import { MoEPlatform } from "./MoEPlatform";
+import MoESelfHandledCampaign from "./MoESelfHandledCampaign";
+
+export default class MoESelfHandledCampaignData {
+    campaignData:MoECampaignData;
+    accountMeta: MoEAccountMeta;
+    platform: MoEPlatform;
+    campaign: MoESelfHandledCampaign
+    constructor(accountMeta: MoEAccountMeta, platform: MoEPlatform, campaign: MoESelfHandledCampaign,campaignData:MoECampaignData) {
+        this.accountMeta = accountMeta;
+        this.platform = platform;
+        this.campaign = campaign;
+        this.campaignData = campaignData;
+    }
+
+}

package/src/moeParser/MoEInAppParser.ts

@@ -0,0 +1,192 @@
+import MoEAccountMeta from "../models/MoEAccountMeta";
+import MoECampaignContext from "../models/MoECampaignContext";
+import MoECampaignData from "../models/MoECampaignData";
+import MoEClickData from "../models/MoEClickData";
+import MoEInAppCustomAction from "../models/MoEInAppCustomAction";
+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 { isValidObject } from "../utils/MoEHelper";
+
+/**
+ * 
+ * @param obj is a json that has InApp details
+ * @returns true if obj is a valid InApp Object else false
+ */
+export function isMoEInAppCampaignValid(obj: { [k: string]: any }) {
+    try {
+        if (obj != undefined && obj[MOE_CAMPAIGN_ID] != undefined && obj[MOE_CAMPAIGN_NAME] != undefined && obj[MOE_CAMPAIGN_CONTEXT]
+            && obj[MOE_PLATFORM]) {
+            return true;
+        }
+        else {
+            throw new Error(MOE_IN_APP_OBJECT_ERROR);
+        }
+    }
+    catch (error: any) {
+        console.log(error?.message);
+        return false;
+    }
+}
+
+
+function getMoEAccountMeta(accountMeta: { [k: string]: any }) {
+    return new MoEAccountMeta(accountMeta[APP_ID]);
+}
+
+function getMoECampaignData(json: { [k: string]: any }) {
+    console.log("getMoECampaignData(): Payload: ", json)
+    var campaignId = json[MOE_CAMPAIGN_ID];
+    var campaignName = json[MOE_CAMPAIGN_NAME];
+    var campaignContext = json[MOE_CAMPAIGN_CONTEXT];
+    var formattedCampaignId = campaignContext[FORMATTED_CAMPAIGN_ID];
+    var campaignContextObj = new MoECampaignContext(formattedCampaignId, campaignContext);
+    return new MoECampaignData(campaignId, campaignName, campaignContextObj);
+}
+
+function getMoESelfHandledCampaign(json: { [k: string]: any }) {
+    var selfHandled = json[MOE_SELF_HANDLED];
+    var payload = selfHandled[MOE_PAYLOAD];
+    var dismissInterval = selfHandled[MOE_DISMISSINTERVAL];
+    return new MoESelfHandledCampaign(payload, dismissInterval);
+}
+
+function getMoEInAppCustomAction(json: { [k: string]: any }) {
+    var customAction = json[MOE_CUSTOM_ACTION]
+    var keyValuePair = customAction[MOE_KEY_VALUE_PAIR]
+    var actionType = json[ACTION_TYPE]
+    return new MoEInAppCustomAction(keyValuePair, actionType)
+}
+
+function getMoEInAppNavigation(json: { [k: string]: any }) {
+    var navigation = json[MOE_NAVIGATION]
+    var navigationType = navigation[MOE_NAVIGATION_TYPE]
+    var url = navigation[MOE_NAVIGATION_VALUE]
+    var keyValuePair = navigation[MOE_KEY_VALUE_PAIR]
+    var actionType = json[ACTION_TYPE]
+    return new MoEInAppNavigation(navigationType, url, keyValuePair, actionType)
+
+}
+/**
+ * this funtion creates MoEInAppData Object from json
+ */
+export function getMoEInAppData(json: { [k: string]: any }, accountMetaPayload: { [k: string]: any }) {
+    if (isMoEInAppCampaignValid(json)) {
+        var campaignData = getMoECampaignData(json);
+        var platform = json[MOE_PLATFORM];
+        var accountMeta = getMoEAccountMeta(accountMetaPayload);
+        return new MoEInAppData(accountMeta, platform, campaignData);
+    }
+    else return undefined
+}
+
+/**
+ * this funtion creates MoESelfHandledCampaignData Object from json
+ */
+export function getMoESelfHandledCampaignData(json: { [k: string]: any }, accountMetaPayload: { [k: string]: any }) {
+    console.log("getMoESelfHandledCampaignData(): Payload: ", json);
+    if (isSelfHandledCampaignValid(json)) {
+        var campaignData = getMoECampaignData(json);
+        var platform = json[MOE_PLATFORM];
+        var accountMeta = getMoEAccountMeta(accountMetaPayload);
+        var campaign = getMoESelfHandledCampaign(json);
+        return new MoESelfHandledCampaignData(accountMeta, platform, campaign, campaignData);
+    }
+    else return undefined
+}
+
+
+/**
+ * This function checks weather customAction key exists or not. And also checks value is a type of object
+ */
+export function isInAppCustomActionValid(obj: { [k: string]: any }) {
+    try {
+        if (obj[MOE_CUSTOM_ACTION] != undefined && isValidObject(obj[MOE_CUSTOM_ACTION])) {
+            return true;
+        }
+        else {
+            throw new Error(MOE_CUSTOM_ACTION_OBJ_ERROR);
+        }
+    }
+    catch (error: any) {
+        console.log(error?.message);
+        return false;
+    }
+}
+
+/**
+ * this funtion creates MoEInAppCustomAction Object from json
+ */
+export function getCustomActionObj(json: { [k: string]: any }, accountMetaPayload: { [k: string]: any }) {
+    if (isInAppCustomActionValid(json)) {
+        var campaignData = getMoECampaignData(json);
+        var platform = json[MOE_PLATFORM];
+        var accountMeta = getMoEAccountMeta(accountMetaPayload);
+        var action = getMoEInAppCustomAction(json);
+
+        return new MoEClickData(accountMeta, platform, campaignData, action);
+    }
+    else return undefined
+
+
+}
+
+
+/**
+ * This function checks weather selfHandled key exists or not. 
+ * checks value is a type of object
+ * checks mandatory keys of selfHandled exist or not 
+ */
+export function isSelfHandledCampaignValid(obj: { [k: string]: any }) {
+    try {
+        if (obj[MOE_SELF_HANDLED] != undefined && isValidObject(obj[MOE_SELF_HANDLED])) {
+            var selfHandled = obj[MOE_SELF_HANDLED];
+            if (selfHandled[MOE_PAYLOAD] != undefined && selfHandled[MOE_DISMISSINTERVAL] != undefined)
+                return true;
+            else throw new Error(MOE_SELF_HANDLED_OBJ_ERROR);
+
+        }
+        else {
+            throw new Error(MOE_SELF_HANDLED_OBJ_ERROR);
+        }
+    }
+    catch (error: any) {
+        console.log(error?.message);
+        return false;
+    }
+}
+
+/**
+ * This function checks weather navigation key exists or not. And also checks value is a type of object
+ */
+export function isNavigationValid(obj: { [k: string]: any }) {
+    try {
+        if (obj[MOE_NAVIGATION] != undefined && isValidObject(obj[MOE_NAVIGATION])) {
+            return true;
+        }
+        else {
+            throw new Error(MOE_NAVIGATION_OBJ_ERROR);
+        }
+    }
+    catch (error: any) {
+        console.log(error?.message);
+        return false;
+    }
+}
+
+/**
+ * this funtion creates MoEInAppNavigation Object from json
+ */
+export function getNavigationObj(json: { [k: string]: any }, accountMetaPayload: { [k: string]: any }) {
+    if (isNavigationValid(json)) {
+        var campaignData = getMoECampaignData(json);
+        var platform = json[MOE_PLATFORM];
+        var accountMeta = getMoEAccountMeta(accountMetaPayload);
+        var action = getMoEInAppNavigation(json);
+        return new MoEClickData(accountMeta, platform, campaignData, action);
+
+    }
+    else return undefined
+}

package/src/moeParser/MoEPushNotificationParser.ts

@@ -0,0 +1,78 @@
+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";
+
+
+/**
+ * 
+ * @param obj is a json  that has MoEPushToken details
+ * @returns true if obj is a valid MoEPushToken Object else false
+ */
+export function isPushTokenValid(tokenPayload: { [k: string]: any }) {
+    try {
+        if (tokenPayload != undefined && tokenPayload[MOE_PLATFORM] != undefined && tokenPayload[MOE_PUSH_SERVICE] != undefined && tokenPayload[MOE_TOKEN] != undefined)
+            return true;
+        else {
+            throw new Error(MOE_PUSH_TOKEN_OBJ_ERROR);
+        }
+    }
+    catch (error: any) {
+        console.log(error?.message);
+        return false;
+    }
+
+}
+
+/**
+ * this funtion creates MoEPushToken Object from json
+ */
+export function getMoEPushToken(tokenPayload: { [k: string]: any }) {
+    if (isPushTokenValid(tokenPayload)) {
+        var platform = tokenPayload[MOE_PLATFORM];
+        var pushService = tokenPayload[MOE_PUSH_SERVICE];
+        var token = tokenPayload[MOE_TOKEN];
+        return new MoEPushToken(platform, pushService, token)
+    }
+    else return undefined
+
+}
+
+
+/**
+ * 
+ * @param obj is a json  that has MoEPushCampaign details
+ * @returns true if obj is a valid MoEPushCampaign Object else false
+ */
+export function isPushCampaignObjectValid(pushPayload: { [k: string]: any }) {
+    try {
+        if (pushPayload[MOE_PLATFORM] != undefined && pushPayload[MOE_PAYLOAD] != undefined)
+            return true;
+        else {
+            throw new Error(MOE_PUSH_CAMPAIGN_OBJ_ERROR);
+        }
+    }
+    catch (error: any) {
+        console.log(error?.message);
+        return false;
+    }
+
+}
+
+/**
+ * this funtion creates MoEPushCampaign Object from json
+ */
+export function getMoEPushPayload(pushPayload: { [k: string]: any },accountMetaPayload:{ [k: string]: any }) {
+    if (isPushCampaignObjectValid(pushPayload)) {
+        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 accountMeta = new MoEAccountMeta(accountMetaPayload[APP_ID])
+        var platform = pushPayload[MOE_PLATFORM];
+        return new MoEPushPayload(accountMeta, pushCampaignPayload,platform);
+    }
+    else return undefined
+
+}