castled-js-sdk 0.0.1 → 0.0.3

package/src/integrations/Lytics/browser.js

@@ -0,0 +1,87 @@
+/* eslint-disable class-methods-use-this */
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class Lytics {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.accountId = config.accountId;
+    this.stream = config.stream;
+    this.blockload = config.blockload;
+    this.loadid = config.loadid;
+    this.name = NAME;
+    this.forFirstName = ['firstname', 'firstName'];
+    this.forLastName = ['lastname', 'lastName'];
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  loadLyticsScript() {
+    loadNativeSdk(this.loadid, this.blockload, this.stream, this.accountId);
+  }
+
+  init() {
+    this.loadLyticsScript();
+    logger.debug('===in init Lytics===');
+  }
+
+  isLoaded() {
+    logger.debug('in Lytics isLoaded');
+    logger.debug(!!(window.jstag && window.jstag.push !== Array.prototype.push));
+    return !!(window.jstag && window.jstag.push !== Array.prototype.push);
+  }
+
+  isReady() {
+    logger.debug('in Lytics isReady');
+    return !!(window.jstag && window.jstag.push !== Array.prototype.push);
+  }
+
+  identify(htElement) {
+    logger.debug('in Lytics identify');
+    const userId = htElement.message.userId || htElement.message.anonymousId;
+    const { traits } = htElement.message.context;
+    let payload = { user_id: userId, ...traits };
+    payload = this.handleName(payload);
+    window.jstag.send(this.stream, payload);
+  }
+
+  page(htElement) {
+    logger.debug('in Lytics page');
+    const { properties } = htElement.message;
+    let payload = { event: htElement.message.name, ...properties };
+    payload = this.handleName(payload);
+    window.jstag.pageView(this.stream, payload);
+  }
+
+  track(htElement) {
+    logger.debug('in Lytics track');
+    const { properties } = htElement.message;
+    let payload = { _e: htElement.message.event, ...properties };
+    payload = this.handleName(payload);
+    window.jstag.send(this.stream, payload);
+  }
+
+  handleName(payload) {
+    const params = payload;
+    this.forFirstName.forEach((key) => {
+      if (params[key]) {
+        params.first_name = payload[key];
+        delete params[key];
+      }
+    });
+    this.forLastName.forEach((key) => {
+      if (params[key]) {
+        params.last_name = payload[key];
+        delete params[key];
+      }
+    });
+    return params;
+  }
+}
+export default Lytics;

package/src/integrations/Lytics/constants.js

@@ -0,0 +1,8 @@
+const NAME = 'LYTICS';
+const CNameMapping = {
+  [NAME]: NAME,
+  Lytics: NAME,
+  lytics: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Lytics/index.js

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

package/src/integrations/Lytics/nativeSdkLoader.js

@@ -0,0 +1,77 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk(loadid, blockload, stream, accountId) {
+  (function () {
+    'use strict';
+    var o = window.jstag || (window.jstag = {}),
+      r = [];
+    function n(e) {
+      o[e] = function () {
+        for (var n = arguments.length, t = new Array(n), i = 0; i < n; i++) t[i] = arguments[i];
+        r.push([e, t]);
+      };
+    }
+    n('send'),
+      n('mock'),
+      n('identify'),
+      n('pageView'),
+      n('unblock'),
+      n('getid'),
+      n('setid'),
+      n('loadEntity'),
+      n('getEntity'),
+      n('on'),
+      n('once'),
+      n('call'),
+      (o.loadScript = function (n, t, i) {
+        var e = document.createElement('script');
+        (e.async = !0),
+          (e.src = n),
+          (e.onload = t),
+          (e.onerror = i),
+          e.setAttribute('data-loader', LOAD_ORIGIN);
+        var o = document.getElementsByTagName('script')[0],
+          r = (o && o.parentNode) || document.head || document.body,
+          c = o || r.lastChild;
+        return null != c ? r.insertBefore(e, c) : r.appendChild(e), this;
+      }),
+      (o.init = function n(t) {
+        return (
+          (this.config = t),
+          this.loadScript(t.src, function () {
+            if (o.init === n) throw new Error('Load error!');
+            // eslint-disable-next-line no-unused-expressions
+            o.init(o.config),
+              // eslint-disable-next-line func-names
+              (function () {
+                for (var n = 0; n < r.length; n++) {
+                  var t = r[n][0],
+                    i = r[n][1];
+                  o[t].apply(o, i);
+                }
+                r = void 0;
+              })();
+          }),
+          this
+        );
+      });
+  })();
+  // Define config and initialize Lytics tracking tag.
+  window.jstag.init({
+    loadid: loadid,
+    blocked: blockload,
+    stream: stream,
+    sessecs: 1800,
+    src:
+      document.location.protocol === 'https:'
+        ? `https://c.lytics.io/api/tag/${accountId}/latest.min.js`
+        : `http://c.lytics.io/api/tag/${accountId}/latest.min.js`,
+    pageAnalysis: {
+      dataLayerPull: {
+        disabled: true,
+      },
+    },
+  });
+}
+
+export { loadNativeSdk };

package/src/integrations/Lytics/test/script-test-lytics.html

@@ -0,0 +1,250 @@
+<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:
+
+      /**
+         * Allow UID Sharing Across Multiple Domains  --> true
+         * Ensure Entity --> false
+         * stream name --> test_file
+         * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?user_id=ruchu123&name=Ruchira%20Moitra&email=ruchira%40gmail.com&plan=Enterprise&company_len=2&company_json=%5B%7B%22id%22%3A%22abc123%22%2C%22name%22%3A%7B%22second_name%22%3A%22xyz%22%2C%22first_name%22%3A%22abc%22%7D%7D%2C%7B%22id%22%3A%22abc1234%22%2C%22name%22%3A%7B%22second_name%22%3A%22xyza%22%2C%22first_name%22%3A%22abcd%22%7D%7D%5D&company.id=abc123&company.name.second_name=xyz&company.name.first_name=abc&company.id=abc1234&company.name.second_name=xyza&company.name.first_name=abcd&createdAt=Thu%20Mar%2024%202016%2017%3A46%3A45%20GMT%2B0000%20(UTC)&_ts=1601466884276&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11
+          Allow UID Sharing Across Multiple Domains  --> true
+         * Ensure Entity --> true
+           http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?user_id=ruchu123&name=Ruchira%20Moitra&email=ruchira%40gmail.com&plan=Enterprise&company_len=2&company_json=%5B%7B%22id%22%3A%22abc123%22%2C%22name%22%3A%7B%22second_name%22%3A%22xyz%22%2C%22first_name%22%3A%22abc%22%7D%7D%2C%7B%22id%22%3A%22abc1234%22%2C%22name%22%3A%7B%22second_name%22%3A%22xyza%22%2C%22first_name%22%3A%22abcd%22%7D%7D%5D&company.id=abc123&company.name.second_name=xyz&company.name.first_name=abc&company.id=abc1234&company.name.second_name=xyza&company.name.first_name=abcd&createdAt=Thu%20Mar%2024%202016%2017%3A46%3A45%20GMT%2B0000%20(UTC)&_ts=1601468609900&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+         **/
+
+      window.hightouchevents.identify('Steven');
+
+      //Expected Result:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?user_id=Steven&_ts=1601466884280&_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?user_id=Steven&_ts=1601468609902&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      //PAGE CALLS
+
+      window.hightouchevents.page();
+
+      //Expected Result:
+
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601466884282&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601468609903&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      window.hightouchevents.page('category', 'name', {
+        url: 'ruchira url',
+        path: '/ruchirapath',
+        search: '?q=1',
+      });
+
+      //Expected Result:
+
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=name&url=localhost%2Fscript-test-lytics.html&path=%2Fruchirapath&search=%3Fq%3D1&name=name&category=category&referrer=&title=&_ts=1601466884282&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=name&url=localhost%2Fscript-test-lytics.html&path=%2Fruchirapath&search=%3Fq%3D1&name=name&category=category&referrer=&title=&_ts=1601468609903&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      window.hightouchevents.page('Name1');
+
+      //Expected Result:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=Name1&name=Name1&path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601466884283&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=Name1&name=Name1&path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601468609904&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      window.hightouchevents.page({
+        score: 211,
+        author: 'Author1',
+        postType: 'blog1',
+        section: 'News1',
+      });
+
+      //Expected Result:
+
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?score=211&author=Author1&postType=blog1&section=News1&path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601466884283&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?score=211&author=Author1&postType=blog1&section=News1&path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601468609904&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      window.hightouchevents.page('Category2', 'Name2');
+
+      //Expected Result:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=Name2&name=Name2&category=Category2&path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601466884284&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=Name2&name=Name2&category=Category2&path=%2Fscript-test-lytics.html&referrer=&search=&title=&url=localhost%2Fscript-test-lytics.html&_ts=1601468609905&_nmob=t&_device=desktop&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      //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:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=event1&_ts=1601466884285&_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?_e=event1&_ts=1601468609906&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       **/
+
+      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:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e%3DOrder%2520Completed%26checkout_id%3Dwhat%2520is%2520checkout%2520id%2520here%253F%253F%26order_id%3DtransactionId%26value%3D31.98%26revenue%3D31.98%26shipping%3D4%26coupon%3DAPPARELSALE%26currency%3DGBP%26products_len%3D3%26products_json%3D%255B%257B%2522product_id%2522%253A%2522product-bacon-jam%2522%252C%2522sku%2522%253A%2522sku-1%2522%252C%2522category%2522%253A%2522Merch%2522%252C%2522name%2522%253A%2522Food%252FDrink%2522%252C%2522brand%2522%253A%2522%2522%252C%2522variant%2522%253A%2522Extra%2520topped%2522%252C%2522price%2522%253A3%252C%2522quantity%2522%253A2%252C%2522currency%2522%253A%2522GBP%2522%252C%2522position%2522%253A1%252C%2522value%2522%253A6%252C%2522typeOfProduct%2522%253A%2522Food%2522%252C%2522url%2522%253A%2522https%253A%252F%252Fwww.example.com%252Fproduct%252Fbacon-jam%2522%252C%2522image_url%2522%253A%2522https%253A%252F%252Fwww.example.com%252Fproduct%252Fbacon-jam.jpg%2522%257D%252C%257B%2522product_id%2522%253A%2522product-t-shirt%2522%252C%2522sku%2522%253A%2522sku-2%2522%252C%2522category%2522%253A%2522Merch%2522%252C%2522name%2522%253A%2522T-Shirt%2522%252C%2522brand%2522%253A%2522Levis%2522%252C%2522variant%2522%253A%2522White%2522%252C%2522price%2522%253A12.99%252C%2522quantity%2522%253A1%252C%2522currency%2522%253A%2522GBP%2522%252C%2522position%2522%253A2%252C%2522value%2522%253A12.99%252C%2522typeOfProduct%2522%253A%2522Shirt%2522%252C%2522url%2522%253A%2522https%253A%252F%252Fwww.example.com%252Fproduct%252Ft-shirt%2522%252C%2522image_url%2522%253A%2522https%253A%252F%252Fwww.example.com%252Fproduct%252Ft-shirt.jpg%2522%257D%252C%257B%2522product_id%2522%253A%2522offer-t-shirt%2522%252C%2522sku%2522%253A%2522sku-3%2522%252C%2522category%2522%253A%2522Merch%2522%252C%2522name%2522%253A%2522T-Shirt-on-offer%2522%252C%2522brand%2522%253A%2522Levis%2522%252C%2522variant%2522%253A%2522Black%2522%252C%2522price%2522%253A12.99%252C%2522quantity%2522%253A1%252C%2522currency%2522%253A%2522GBP%2522%252C%2522position%2522%253A1%252C%2522value%2522%253A12.99%252C%2522coupon%2522%253A%2522APPARELSALE%2522%252C%2522typeOfProduct%2522%253A%2522Shirt%2522%252C%2522url%2522%253A%2522https%253A%252F%252Fwww.example.com%252Fproduct%252Foffer-t-shirt%2522%252C%2522image_url%2522%253A%2522https%253A%252F%252Fwww.example.com%252Fproduct%252Foffer-t-shirt.jpg%2522%257D%255D%26products.product_id%3Dproduct-bacon-jam%26products.sku%3Dsku-1%26products.category%3DMerch%26products.name%3DFood%252FDrink%26products.brand%3D%26products.variant%3DExtra%2520topped%26products.price%3D3%26products.quantity%3D2%26products.currency%3DGBP%26products.position%3D1%26products.value%3D6%26products.typeOfProduct%3DFood%26products.url%3Dhttps%253A%252F%252Fwww.example.com%252Fproduct%252Fbacon-jam%26products.image_url%3Dhttps%253A%252F%252Fwww.example.com%252Fproduct%252Fbacon-jam.jpg%26products.product_id%3Dproduct-t-shirt%26products.sku%3Dsku-2%26products.category%3DMerch%26products.name%3DT-Shirt%26products.brand%3DLevis%26products.variant%3DWhite%26products.price%3D12.99%26products.quantity%3D1%26products.currency%3DGBP%26products.position%3D2%26products.value%3D12.99%26products.typeOfProduct%3DShirt%26products.url%3Dhttps%253A%252F%252Fwww.example.com%252Fproduct%252Ft-shirt%26products.image_url%3Dhttps%253A%252F%252Fwww.example.com%252Fproduct%252Ft-shirt.jpg%26products.product_id%3Doffer-t-shirt%26products.sku%3Dsku-3%26products.category%3DMerch%26products.name%3DT-Shirt-on-offer%26products.brand%3DLevis%26products.variant%3DBlack%26products.price%3D12.99%26products.quantity%3D1%26products.currency%3DGBP%26products.position%3D1%26products.value%3D12.99%26products.coupon%3DAPPARELSALE%26products.typeOfProduct%3DShirt%26products.url%3Dhttps%253A%252F%252Fwww.example.com%252Fproduct%252Foffer-t-shirt%26products.image_url%3Dhttps%253A%252F%252Fwww.example.com%252Fproduct%252Foffer-t-shirt.jpg%26_ts%3D1601466884285%26_nmob%3Dt%26_device%3Ddesktop%26url%3Dlocalhost%252Fscript-test-lytics.html%26_uid%3Du_568832263937661300%26_v%3D3.0.11
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=Order%20Completed&checkout_id=what%20is%20checkout%20id%20here%3F%3F&order_id=transactionId&value=31.98&revenue=31.98&shipping=4&coupon=APPARELSALE&currency=GBP&products_len=3&products_json=%5B%7B%22product_id%22%3A%22product-bacon-jam%22%2C%22sku%22%3A%22sku-1%22%2C%22category%22%3A%22Merch%22%2C%22name%22%3A%22Food%2FDrink%22%2C%22brand%22%3A%22%22%2C%22variant%22%3A%22Extra%20topped%22%2C%22price%22%3A3%2C%22quantity%22%3A2%2C%22currency%22%3A%22GBP%22%2C%22position%22%3A1%2C%22value%22%3A6%2C%22typeOfProduct%22%3A%22Food%22%2C%22url%22%3A%22https%3A%2F%2Fwww.example.com%2Fproduct%2Fbacon-jam%22%2C%22image_url%22%3A%22https%3A%2F%2Fwww.example.com%2Fproduct%2Fbacon-jam.jpg%22%7D%2C%7B%22product_id%22%3A%22product-t-shirt%22%2C%22sku%22%3A%22sku-2%22%2C%22category%22%3A%22Merch%22%2C%22name%22%3A%22T-Shirt%22%2C%22brand%22%3A%22Levis%22%2C%22variant%22%3A%22White%22%2C%22price%22%3A12.99%2C%22quantity%22%3A1%2C%22currency%22%3A%22GBP%22%2C%22position%22%3A2%2C%22value%22%3A12.99%2C%22typeOfProduct%22%3A%22Shirt%22%2C%22url%22%3A%22https%3A%2F%2Fwww.example.com%2Fproduct%2Ft-shirt%22%2C%22image_url%22%3A%22https%3A%2F%2Fwww.example.com%2Fproduct%2Ft-shirt.jpg%22%7D%2C%7B%22product_id%22%3A%22offer-t-shirt%22%2C%22sku%22%3A%22sku-3%22%2C%22category%22%3A%22Merch%22%2C%22name%22%3A%22T-Shirt-on-offer%22%2C%22brand%22%3A%22Levis%22%2C%22variant%22%3A%22Black%22%2C%22price%22%3A12.99%2C%22quantity%22%3A1%2C%22currency%22%3A%22GBP%22%2C%22position%22%3A1%2C%22value%22%3A12.99%2C%22coupon%22%3A%22APPARELSALE%22%2C%22typeOfProduct%22%3A%22Shirt%22%2C%22url%22%3A%22https%3A%2F%2Fwww.example.com%2Fproduct%2Foffer-t-shirt%22%2C%22image_url%22%3A%22https%3A%2F%2Fwww.example.com%2Fproduct%2Foffer-t-shirt.jpg%22%7D%5D&products.product_id=product-bacon-jam&products.sku=sku-1&products.category=Merch&products.name=Food%2FDrink&products.brand=&products.variant=Extra%20topped&products.price=3&products.quantity=2&products.currency=GBP&products.position=1&products.value=6&products.typeOfProduct=Food&products.url=https%3A%2F%2Fwww.example.com%2Fproduct%2Fbacon-jam&products.image_url=https%3A%2F%2Fwww.example.com%2Fproduct%2Fbacon-jam.jpg&products.product_id=product-t-shirt&products.sku=sku-2&products.category=Merch&products.name=T-Shirt&products.brand=Levis&products.variant=White&products.price=12.99&products.quantity=1&products.currency=GBP&products.position=2&products.value=12.99&products.typeOfProduct=Shirt&products.url=https%3A%2F%2Fwww.example.com%2Fproduct%2Ft-shirt&products.image_url=https%3A%2F%2Fwww.example.com%2Fproduct%2Ft-shirt.jpg&products.product_id=offer-t-shirt&products.sku=sku-3&products.category=Merch&products.name=T-Shirt-on-offer&products.brand=Levis&products.variant=Black&products.price=12.99&products.quantity=1&products.currency=GBP&products.position=1&products.value=12.99&products.coupon=APPARELSALE&products.typeOfProduct=Shirt&products.url=https%3A%2F%2Fwww.example.com%2Fproduct%2Foffer-t-shirt&products.image_url=https%3A%2F%2Fwww.example.com%2Fproduct%2Foffer-t-shirt.jpg&_ts=1601468609906&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+
+      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:
+      /**
+       * http://c.lytics.io/c/850f5386f55ea22cd32b29a759dd3f8a/test_file?_e=Product%20Added&currency=CAD&quantity=1&price=24.75&name=my%20product&category=cat%201&sku=p-298&testDimension=true&testMetric=true&position=4&_ts=1601466884285&_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?_e=Product%20Added&currency=CAD&quantity=1&price=24.75&name=my%20product&category=cat%201&sku=p-298&testDimension=true&testMetric=true&position=4&_ts=1601468609907&_nmob=t&_device=desktop&url=localhost%2Fscript-test-lytics.html&_uid=u_568832263937661300&_v=3.0.11&_uido=u_568832263937661300
+       * **/
+    </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/Matomo/browser.js

@@ -0,0 +1,188 @@
+/* eslint-disable no-unused-vars */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import logger from '../../utils/logUtil';
+
+import { NAME } from './constants';
+import {
+  goalIdMapping,
+  ecommerceEventsMapping,
+  standardEventsMapping,
+  checkCustomDimensions,
+} from './util';
+import { getHashFromArrayWithDuplicate } from '../../utils/commonUtils';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class Matomo {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.serverUrl = config.serverUrl;
+    this.siteId = config.siteId;
+    this.eventsMapToGoalId = config.eventsMapToGoalId;
+    this.eventsToStandard = config.eventsToStandard;
+    this.name = NAME;
+    this.trackAllContentImpressions = config.trackAllContentImpressions;
+    this.trackVisibleContentImpressions = config.trackVisibleContentImpressions;
+    this.checkOnScroll = config.checkOnScroll;
+    this.timeIntervalInMs = config.timeIntervalInMs;
+    this.logAllContentBlocksOnPage = config.logAllContentBlocksOnPage;
+    this.enableHeartBeatTimer = config.enableHeartBeatTimer;
+    this.activeTimeInseconds = config.activeTimeInseconds;
+    this.enableLinkTracking = config.enableLinkTracking;
+    this.disablePerformanceTracking = config.disablePerformanceTracking;
+    this.enableCrossDomainLinking = config.enableCrossDomainLinking;
+    this.setCrossDomainLinkingTimeout = config.setCrossDomainLinkingTimeout;
+    this.timeout = config.timeout;
+    this.getCrossDomainLinkingUrlParameter = config.getCrossDomainLinkingUrlParameter;
+    this.disableBrowserFeatureDetection = config.disableBrowserFeatureDetection;
+
+    this.ecomEvents = {
+      SET_ECOMMERCE_VIEW: 'SET_ECOMMERCE_VIEW',
+      ADD_ECOMMERCE_ITEM: 'ADD_ECOMMERCE_ITEM',
+      REMOVE_ECOMMERCE_ITEM: 'REMOVE_ECOMMERCE_ITEM',
+      TRACK_ECOMMERCE_ORDER: 'TRACK_ECOMMERCE_ORDER',
+      CLEAR_ECOMMERCE_CART: 'CLEAR_ECOMMERCE_CART',
+      TRACK_ECOMMERCE_CART_UPDATE: 'TRACK_ECOMMERCE_CART_UPDATE',
+    };
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  loadScript() {
+    loadNativeSdk(this.serverUrl, this.siteId);
+  }
+
+  init() {
+    logger.debug('===In init Matomo===');
+    this.loadScript();
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded Matomo===');
+    return !!(window._paq && window._paq.push !== Array.prototype.push);
+  }
+
+  pushValues(condition, values) {
+    if (condition) {
+      window._paq.push(values);
+    }
+  }
+
+  isReady() {
+    logger.debug('===In isReady Matomo===');
+
+    // Dashboard Event Settings
+    if (window._paq && window._paq.push !== Array.prototype.push) {
+      // Scans the entire DOM for all content blocks and tracks all impressions once the DOM ready event has been triggered.
+      this.pushValues(this.trackAllContentImpressions, ['trackAllContentImpressions']);
+
+      // Scans the entire DOM for all content blocks when the page is loaded. Tracks an impression only if a content block is actually visible.
+      this.pushValues(
+        this.trackVisibleContentImpressions && this.checkOnScroll && this.timeIntervalInMs,
+        ['trackVisibleContentImpressions', this.checkOnScroll, this.timeIntervalInMs],
+      );
+
+      // Logs all content blocks found within a page to the console.
+      this.pushValues(this.logAllContentBlocksOnPage, ['logAllContentBlocksOnPage']);
+
+      // Installs a heart beat timer to send additional requests to Matomo to measure the time spent in the visit.
+      this.pushValues(this.enableHeartBeatTimer && this.activeTimeInseconds, [
+        'enableHeartBeatTimer',
+        this.activeTimeInseconds,
+      ]);
+
+      //  Installs link tracking on all applicable link elements.
+      this.pushValues(this.enableLinkTracking, ['enableLinkTracking', true]);
+
+      // Disables page performance tracking.
+      this.pushValues(this.disablePerformanceTracking, ['disablePerformanceTracking']);
+
+      // Enables cross domain linking. It is useful if you own multiple domains and would like to track all the actions and
+      // page views of a specific visitor into the same visit.
+      this.pushValues(this.enableCrossDomainLinking, ['enableCrossDomainLinking']);
+
+      // Sets the cross domain linking timeout (in seconds).
+      this.pushValues(this.setCrossDomainLinkingTimeout && this.timeout, [
+        'setCrossDomainLinkingTimeout',
+        this.timeout,
+      ]);
+
+      // Gets the query parameter to append to the links to handle cross domain linking.
+      this.pushValues(this.getCrossDomainLinkingUrlParameter, [
+        'getCrossDomainLinkingUrlParameter',
+      ]);
+
+      // Disables the browser feature detection.
+      this.pushValues(this.disableBrowserFeatureDetection, ['disableBrowserFeatureDetection']);
+    }
+    return false;
+  }
+
+  identify(htElement) {
+    logger.debug('===In Matomo Identify===');
+    const { anonymousId, userId } = htElement.message;
+    const matomoUserId = userId || anonymousId;
+    if (!matomoUserId) {
+      logger.error('User parameter (anonymousId or userId) is required for identify call');
+      return;
+    }
+    window._paq.push(['setUserId', matomoUserId]);
+  }
+
+  track(htElement) {
+    logger.debug('===In Matomo track===');
+
+    const { message } = htElement;
+    const { event } = message;
+    const goalListMap = getHashFromArrayWithDuplicate(this.eventsMapToGoalId);
+    const standardEventsMap = getHashFromArrayWithDuplicate(this.eventsToStandard);
+    const ecommerceMapping = new Map([
+      ['product viewed', this.ecomEvents.SET_ECOMMERCE_VIEW],
+      ['product added', this.ecomEvents.ADD_ECOMMERCE_ITEM],
+      ['product removed', this.ecomEvents.REMOVE_ECOMMERCE_ITEM],
+      ['order completed', this.ecomEvents.TRACK_ECOMMERCE_ORDER],
+      ['cart cleared', this.ecomEvents.CLEAR_ECOMMERCE_CART],
+      ['update cart', this.ecomEvents.TRACK_ECOMMERCE_CART_UPDATE],
+    ]);
+
+    if (!event) {
+      logger.error('Event name not present');
+      return;
+    }
+
+    // Checks for custom dimensions in the payload, if present makes appropriate calls
+    checkCustomDimensions(message);
+
+    const trimmedEvent = event.toLowerCase().trim();
+
+    // For every type of track calls we consider the trackGoal function.
+    if (goalListMap[trimmedEvent]) {
+      goalIdMapping(trimmedEvent, goalListMap, message);
+    }
+
+    // Mapping Standard Events
+    if (standardEventsMap[trimmedEvent]) {
+      standardEventsMapping(trimmedEvent, standardEventsMap, message);
+    }
+
+    // Mapping Ecommerce Events
+    if (ecommerceMapping.has(trimmedEvent)) {
+      ecommerceEventsMapping(ecommerceMapping.get(trimmedEvent), message);
+    } else {
+      ecommerceEventsMapping('trackEvent', message);
+    }
+  }
+
+  page(htElement) {
+    logger.debug('=== In Matomo Page ===');
+    window._paq.push(['trackPageView']);
+  }
+}
+
+export default Matomo;

package/src/integrations/Matomo/constants.js

@@ -0,0 +1,8 @@
+const NAME = 'MATOMO';
+const CNameMapping = {
+  [NAME]: NAME,
+  Matomo: NAME,
+  matomo: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Matomo/index.js

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

package/src/integrations/Matomo/nativeSdkLoader.js

@@ -0,0 +1,20 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk(serverUrl, siteId) {
+  window._paq = window._paq || [];
+  (function (serverUrl, siteId) {
+    let u = serverUrl;
+    window._paq.push(['setTrackerUrl', `${u}matomo.php`]);
+    window._paq.push(['setSiteId', siteId]);
+    const d = document;
+    const g = d.createElement('script');
+    const s = d.getElementsByTagName('script')[0];
+    g.async = true;
+    u = u.replace('https://', '');
+    g.src = `//cdn.matomo.cloud/${u}matomo.js`;
+    g.setAttribute('data-loader', LOAD_ORIGIN);
+    s.parentNode.insertBefore(g, s);
+  })(serverUrl, siteId);
+}
+
+export { loadNativeSdk };