castled-js-sdk 0.0.1 → 0.0.3

package/src/integrations/MoEngage/browser.js

@@ -0,0 +1,133 @@
+/* eslint-disable class-methods-use-this */
+import each from '@ndhoule/each';
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+// custom traits mapping context.traits --> moengage properties
+const traitsMap = {
+  firstName: 'first_name',
+  lastName: 'last_name',
+  firstname: 'first_name',
+  lastname: 'last_name',
+  email: 'email',
+  phone: 'mobile',
+  name: 'user_name',
+  username: 'user_name',
+  userName: 'user_name',
+  gender: 'gender',
+  birthday: 'birthday',
+  id: null,
+};
+class MoEngage {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.apiId = config.apiId;
+    this.debug = config.debug;
+    this.region = config.region;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    const self = this;
+    logger.debug('===in init MoEngage===');
+    loadNativeSdk();
+    // setting the region if us then not needed.
+    if (this.region !== 'US') {
+      self.moeClient = window.moe({
+        app_id: this.apiId,
+        debug_logs: this.debug ? 1 : 0,
+        cluster: this.region === 'EU' ? 'eu' : 'in',
+      });
+    } else {
+      self.moeClient = window.moe({
+        app_id: this.apiId,
+        debug_logs: this.debug ? 1 : 0,
+      });
+    }
+    this.initialUserId = this.analytics.getUserId();
+  }
+
+  isLoaded() {
+    logger.debug('in MoEngage isLoaded');
+    return !!window.moeBannerText;
+  }
+
+  isReady() {
+    logger.debug('in MoEngage isReady');
+    return !!window.moeBannerText;
+  }
+
+  track(htElement) {
+    logger.debug('inside track');
+    // Check if the user id is same as previous session if not a new session will start
+    if (!htElement.message) {
+      logger.error('Payload not correct');
+      return;
+    }
+    const { event, properties, userId } = htElement.message;
+    if (userId && this.initialUserId !== userId) {
+      this.reset();
+    }
+    // track event : https://docs.moengage.com/docs/tracking-events
+    if (!event) {
+      logger.error('Event name not present');
+      return;
+    }
+    if (properties) {
+      this.moeClient.track_event(event, properties);
+    } else {
+      this.moeClient.track_event(event);
+    }
+  }
+
+  reset() {
+    logger.debug('inside reset');
+    // reset the user id
+    this.initialUserId = this.analytics.getUserId();
+    this.moeClient.destroy_session();
+  }
+
+  identify(htElement) {
+    const self = this;
+    const { userId, context } = htElement.message;
+    let traits = null;
+    if (context) {
+      traits = context.traits;
+    }
+    // check if user id is same or not
+    if (this.initialUserId !== userId) {
+      this.reset();
+    }
+    // if user is present map
+    if (userId) {
+      this.moeClient.add_unique_user_id(userId);
+    }
+
+    // track user attributes : https://docs.moengage.com/docs/tracking-web-user-attributes
+    if (traits) {
+      each((value, key) => {
+        // check if name is present
+        if (key === 'name') {
+          self.moeClient.add_user_name(value);
+        }
+        if (Object.prototype.hasOwnProperty.call(traitsMap, key)) {
+          const method = `add_${traitsMap[key]}`;
+          self.moeClient[method](value);
+        } else {
+          self.moeClient.add_user_attribute(key, value);
+        }
+      }, traits);
+    }
+  }
+}
+
+export default MoEngage;

package/src/integrations/MoEngage/constants.js

@@ -0,0 +1,12 @@
+const NAME = 'MOENGAGE';
+const CNameMapping = {
+  [NAME]: NAME,
+  MoEngage: NAME,
+  moengage: NAME,
+  Moengage: NAME,
+  'Mo Engage': NAME,
+  'mo engage': NAME,
+  'Mo engage': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/MoEngage/index.js

@@ -0,0 +1 @@
+export { default as MoEngage } from './browser';

package/src/integrations/MoEngage/nativeSdkLoader.js

@@ -0,0 +1,66 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk() {
+  // loading the script for moengage web sdk
+  (function (i, s, o, g, r, a, m, n) {
+    i.moengage_object = r;
+    var t = {};
+    var q = function (f) {
+      return function () {
+        (i.moengage_q = i.moengage_q || []).push({ f, a: arguments });
+      };
+    };
+    var f = [
+      'track_event',
+      'add_user_attribute',
+      'add_first_name',
+      'add_last_name',
+      'add_email',
+      'add_mobile',
+      'add_user_name',
+      'add_gender',
+      'add_birthday',
+      'destroy_session',
+      'add_unique_user_id',
+      'moe_events',
+      'call_web_push',
+      'track',
+      'location_type_attribute',
+    ];
+    var h = { onsite: ['getData', 'registerCallback'] };
+    for (var k in f) {
+      t[f[k]] = q(f[k]);
+    }
+    for (var k in h)
+      for (var l in h[k]) {
+        null == t[k] && (t[k] = {}), (t[k][h[k][l]] = q(k + '.' + h[k][l]));
+      }
+    a = s.createElement(o);
+    m = s.getElementsByTagName(o)[0];
+    a.async = 1;
+    a.setAttribute('data-loader', LOAD_ORIGIN);
+    a.src = g;
+    m.parentNode.insertBefore(a, m);
+    i.moe =
+      i.moe ||
+      function () {
+        n = arguments[0];
+        return t;
+      };
+    a.onload = function () {
+      if (n) {
+        i[r] = moe(n);
+      }
+    };
+  })(
+    window,
+    document,
+    'script',
+    document.location.protocol === 'https:'
+      ? 'https://cdn.moengage.com/webpush/moe_webSdk.min.latest.js'
+      : 'http://cdn.moengage.com/webpush/moe_webSdk.min.latest.js',
+    'Moengage',
+  );
+}
+
+export { loadNativeSdk };

package/src/integrations/MoEngage/test/script-test-moengage.html

@@ -0,0 +1,216 @@
+<html>
+  <head>
+    <!--  <script src="//d2wy8f7a9ursnm.cloudfront.net/v6/bugsnag.min.js"></script>
+    <script>
+      window.bugsnagClient = bugsnag("API_KEY");
+    </script> -->
+    <script type="text/javascript">
+      // checking test commit 2
+      hightouchevents = window.hightouchevents = [];
+      var methods = ['load', 'ready', 'track'];
+
+      // this is required to be set before hightouchevents is loaded/run
+      window.hightouchevents.syncPixelCallback = (obj) => {};
+      var methods = ['load', 'page', 'identify', 'track', 'ready'];
+      for (var i = 0; i < methods.length; i++) {
+        var method = methods[i];
+        hightouchevents[method] = (function (methodName) {
+          return function () {
+            hightouchevents.push([methodName, ...arguments]);
+          };
+        })(method);
+      }
+
+      hightouchevents.load('1haY9AxJbyxwjLXEe9A5xQnvIQZ', 'http://localhost:8080', {
+        logLevel: 'DEBUG',
+        configUrl: 'https://api.dev.rudderlabs.com',
+      });
+    </script>
+
+    <script src="./browser.js"></script>
+
+    <script>
+      window.hightouchevents.ready(() => {
+        console.log('we are all set!!!');
+      });
+
+      //IDENTIFY CALLS
+
+      window.hightouchevents.identify('ruchu123', {
+        name: 'Ruchira Moitra',
+        email: 'ruchira@gmail.com',
+        plan: 'Enterprise',
+        company: [
+          {
+            id: 'abc123',
+            name: {
+              second_name: 'xyz',
+              first_name: 'abc',
+            },
+          },
+          {
+            id: 'abc1234',
+            name: {
+              second_name: 'xyza',
+              first_name: 'abcd',
+            },
+          },
+        ],
+        createdAt: 'Thu Mar 24 2016 17:46:45 GMT+0000 (UTC)',
+      });
+
+      //Expected Result:
+
+      /**
+       * debug --> true
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415021&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415023&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415024&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415026&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415028&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415260&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656415263&device_tz_offset=19800000&unique_id=55ad5f73-9921-4cce-83fd-3e173da0af2e&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       **/
+
+      window.hightouchevents.identify('Steven');
+
+      //Expected Result:
+      /**
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656777491&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656777496&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       *  **/
+
+      //TRACK CALLS
+      hightouchevents.track();
+
+      //Expected Result:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_ts=1601466884284&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_ts=1601468609905&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      window.hightouchevents.track('event1');
+
+      //Expected Result:
+      /**
+       * event name not present
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656912507&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604656912510&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * */
+
+      hightouchevents.track('Order Completed', {
+        checkout_id: 'what is checkout id here??',
+        order_id: 'transactionId',
+        value: 31.98,
+        revenue: 31.98,
+        shipping: 4.0,
+        coupon: 'APPARELSALE',
+        currency: 'GBP',
+        products: [
+          {
+            product_id: 'product-bacon-jam',
+            sku: 'sku-1',
+            category: 'Merch',
+            name: 'Food/Drink',
+            brand: '',
+            variant: 'Extra topped',
+            price: 3.0,
+            quantity: 2,
+            currency: 'GBP',
+            position: 1,
+            value: 6.0,
+            typeOfProduct: 'Food',
+            url: 'https://www.example.com/product/bacon-jam',
+            image_url: 'https://www.example.com/product/bacon-jam.jpg',
+          },
+          {
+            product_id: 'product-t-shirt',
+            sku: 'sku-2',
+            category: 'Merch',
+            name: 'T-Shirt',
+            brand: 'Levis',
+            variant: 'White',
+            price: 12.99,
+            quantity: 1,
+            currency: 'GBP',
+            position: 2,
+            value: 12.99,
+            typeOfProduct: 'Shirt',
+            url: 'https://www.example.com/product/t-shirt',
+            image_url: 'https://www.example.com/product/t-shirt.jpg',
+          },
+          {
+            product_id: 'offer-t-shirt',
+            sku: 'sku-3',
+            category: 'Merch',
+            name: 'T-Shirt-on-offer',
+            brand: 'Levis',
+            variant: 'Black',
+            price: 12.99,
+            quantity: 1,
+            currency: 'GBP',
+            position: 1,
+            value: 12.99,
+            coupon: 'APPARELSALE',
+            typeOfProduct: 'Shirt',
+            url: 'https://www.example.com/product/offer-t-shirt',
+            image_url: 'https://www.example.com/product/offer-t-shirt.jpg',
+          },
+        ],
+      });
+
+      //Expected Result:
+      /**
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604657091195&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604657091198&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604657091200&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * **/
+
+      window.hightouchevents.track('Product Added', {
+        currency: 'CAD',
+        quantity: 1,
+        price: 24.75,
+        name: 'my product',
+        category: 'cat 1',
+        sku: 'p-298',
+        testDimension: true,
+        testMetric: true,
+        position: 4,
+      });
+
+      //Expected Result:
+      /**
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604657171732&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604657171736&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       *
+       * https://websdk.moengage.com/v2/report/add?os=web&os_platform=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F86.0.4240.183%20Safari%2F537.36&is_incognito=false&app_id=RCH4GZ21MFGQXFLY66KN12XK_DEBUG&os_ver=Google%20Chrome&sdk_ver=2.6.0&model=Google%20Chrome&app_ver=1&device_ts=1604657171739&device_tz_offset=19800000&unique_id=ea35b11a-5dce-40bd-a681-4d4d5f0ce2a1&device_tz=-330&push_id=d8CpcJXvVrg%3AAPA91bG0EWIEW7N5FtTIfY0WJKRYKAUJDYSGbSMjybbLScRzCMZ5EjWW6nHdrtGjivQT0bT_dThQTcVh93AqSiBPN7UMjRVfoMIyjYz9n4sW-TVVHKsa0X6ni93fV6BApnmIuEtG2GFB&subscription_type=vapid&vapid_public=BHDQbI127Xr5vREQdi5EfL3lFQFlGs56TsFVKEHCl64atNkm1VRdz-yau_a2zdvR6fX4qYzQs2_eLke2ijJEMGM&sender_id=540868316921&keys_p256dh=BIyxrTLeArS5FKSYz91G5G8BAKqM4q9wf8M9xTPHlBbRiIFA7UbHYU94KQJGJcwyIKBfMSI-Sc_9l1lpdEQs31g&keys_auth=4AP-uNF8YZGNtrbsVl5BaA&endpoint=https%3A%2F%2Ffcm.googleapis.com%2Ffcm%2Fsend%2F&
+       **/
+    </script>
+  </head>
+
+  <body>
+    <h1>Relax while I finish my testing process....</h1>
+    <div id="id1">
+      <a id="link1" href="https://example.com">example 1</a>
+    </div>
+
+    <div id="id2">
+      <a id="link2" href="https://3a842fe106ca.ngrok.io/tests/html/script-test.html">example 2</a>
+    </div>
+  </body>
+</html>

package/src/integrations/Mouseflow/browser.js

@@ -0,0 +1,98 @@
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import { NAME } from './constants';
+import logger from '../../utils/logUtil';
+import ScriptLoader from '../../utils/ScriptLoader';
+import { setCustomVariables, addCustomVariables } from './utils';
+
+class Mouseflow {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.websiteId = config.websiteId;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===In init mouseflow===');
+    window._mfq = window._mfq || [];
+    ScriptLoader(
+      'mouseflow-integration',
+      `https://cdn.mouseflow.com/projects/${this.websiteId}.js`,
+    );
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded mouseflow===');
+    return !!window.mouseflow && typeof window.mouseflow === 'object';
+  }
+
+  isReady() {
+    logger.debug('===In isReady mouseflow===');
+    return !!window._mfq;
+  }
+
+  /**
+   * Identify.
+   * for supporting userId or email
+   * Ref: https://js-api-docs.mouseflow.com/#identifying-a-user
+   * for supporting user traits and customVariables
+   * Ref: https://js-api-docs.mouseflow.com/#setting-a-custom-variable
+   * @param {Identify} identify
+   */
+  identify(htElement) {
+    logger.debug('===In mouseflow Identify===');
+    const { message } = htElement;
+    const { context, traits: rootLevelTraits, anonymousId } = message;
+    const { traits } = context;
+    const email = traits?.email || rootLevelTraits?.email;
+    const userId = message?.userId || email || anonymousId;
+    window._mfq.push(['stop']);
+    if (userId) window.mouseflow.identify(userId);
+    window.mouseflow.start();
+    setCustomVariables(traits);
+    addCustomVariables(message);
+  }
+
+  /**
+   * Track - tracks an event for a specific user
+   * for supporting event
+   * Ref: https://js-api-docs.mouseflow.com/#tagging-a-recording
+   * for supporting properties and customVariables
+   * Ref: https://js-api-docs.mouseflow.com/#setting-a-custom-variable
+   * @param {Track} track
+   */
+  track(htElement) {
+    logger.debug('===In mouseflow Track===');
+    const { message } = htElement;
+    const { event, properties } = message;
+    if (!event) {
+      logger.error('[mouseflow]: Event name from track call is missing!!===');
+      return;
+    }
+    window._mfq.push(['tag', event]);
+    setCustomVariables(properties);
+    addCustomVariables(message);
+  }
+
+  /**
+   * Page.
+   * for supporting path of Page
+   * Ref: https://js-api-docs.mouseflow.com/#setting-a-virtual-path
+   * @param {Page} page
+   */
+  page(htElement) {
+    logger.debug('===In mouseflow Page===');
+    const tabPath = htElement.message.properties.path || htElement.message.context.path;
+    if (tabPath) window._mfq.push(['newPageView', tabPath]);
+  }
+}
+
+export default Mouseflow;

package/src/integrations/Mouseflow/constants.js

@@ -0,0 +1,14 @@
+const NAME = 'MOUSEFLOW';
+const CNameMapping = {
+  [NAME]: NAME,
+  Mouseflow: NAME,
+  mouseflow: NAME,
+  mouseFlow: NAME,
+  MouseFlow: NAME,
+  'Mouse flow': NAME,
+  'mouse flow': NAME,
+  'mouse Flow': NAME,
+  'Mouse Flow': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Mouseflow/index.js

@@ -0,0 +1 @@
+export { default as Mouseflow } from './browser';

package/src/integrations/Mouseflow/utils.js

@@ -0,0 +1,27 @@
+/* eslint-disable no-underscore-dangle */
+import get from 'get-value';
+import { NAME } from './constants';
+
+/*
+ * Here, we are iterating each key-value pair of object 'Obj' and
+ * checks if typeof value is string then we pass it as custom variable in mouseflow.
+ */
+const setCustomVariables = (userProperties) => {
+  if (userProperties && typeof userProperties === 'object') {
+    Object.entries(userProperties).forEach((item) => {
+      const [key, value] = item;
+      if (typeof value === 'string' || typeof value === 'number')
+        window._mfq.push(['setVariable', key, value]);
+    });
+  }
+};
+
+/*
+ * Set custom Variables from integrations Object
+ */
+const addCustomVariables = (message) => {
+  const customVariables = get(message, `integrations.${NAME}.customVariables`);
+  setCustomVariables(customVariables);
+};
+
+export { setCustomVariables, addCustomVariables };