castled-js-sdk 0.0.1 → 0.0.2

package/src/integrations/Posthog/browser.js

@@ -0,0 +1,154 @@
+/* eslint-disable no-undef */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import get from 'get-value';
+import logger from '../../utils/logUtil';
+import { getXhrHeaders, getPropertyBlackList } from './utils';
+import { removeTrailingSlashes } from '../../utils/utils';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class Posthog {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.name = NAME;
+    this.analytics = analytics;
+    this.teamApiKey = config.teamApiKey;
+    this.yourInstance = removeTrailingSlashes(config.yourInstance) || 'https://app.posthog.com';
+    this.autocapture = config.autocapture || false;
+    this.capturePageView = config.capturePageView || false;
+    this.disableSessionRecording = config.disableSessionRecording || false;
+    this.disableCookie = config.disableCookie || false;
+    this.propertyBlackList = getPropertyBlackList(config);
+    this.xhrHeaders = getXhrHeaders(config);
+    this.enableLocalStoragePersistence = config.enableLocalStoragePersistence;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    const options = this.analytics.loadOnlyIntegrations[this.name];
+    if (options && !options.loadIntegration) {
+      logger.debug('===[POSTHOG]: loadIntegration flag is disabled===');
+      return;
+    }
+    loadNativeSdk();
+
+    const configObject = {
+      api_host: this.yourInstance,
+      autocapture: this.autocapture,
+      capture_pageview: this.capturePageView,
+      disable_session_recording: this.disableSessionRecording,
+      property_blacklist: this.propertyBlackList,
+      disable_cookie: this.disableCookie,
+    };
+
+    if (options?.loaded) {
+      configObject.loaded = options.loaded;
+    }
+    if (this.xhrHeaders && Object.keys(this.xhrHeaders).length > 0) {
+      configObject.xhr_headers = this.xhrHeaders;
+    }
+    if (this.enableLocalStoragePersistence) {
+      configObject.persistence = 'localStorage+cookie';
+    }
+
+    posthog.init(this.teamApiKey, configObject);
+  }
+
+  isLoaded() {
+    logger.debug('in Posthog isLoaded');
+    return !!window?.posthog?.__loaded;
+  }
+
+  isReady() {
+    return !!window?.posthog?.__loaded;
+  }
+
+  /**
+   * superproperties should be part of rudderelement.message.integrations.POSTHOG object.
+   * Once we call the posthog.register api, the corresponding property will be sent along with subsequent capture calls.
+   * To remove the superproperties, we call unregister api.
+   */
+  processSuperProperties(htElement) {
+    const { integrations } = htElement.message;
+    if (integrations?.POSTHOG) {
+      const { superProperties, setOnceProperties, unsetProperties } = integrations.POSTHOG;
+      if (superProperties && Object.keys(superProperties).length > 0) {
+        posthog.register(superProperties);
+      }
+      if (setOnceProperties && Object.keys(setOnceProperties).length > 0) {
+        posthog.register_once(setOnceProperties);
+      }
+      if (unsetProperties && unsetProperties.length > 0) {
+        unsetProperties.forEach((property) => {
+          if (property && property.trim() !== '') {
+            posthog.unregister(property);
+          }
+        });
+      }
+    }
+  }
+
+  identify(htElement) {
+    logger.debug('in Posthog identify');
+
+    // htElement.message.context will always be present as part of identify event payload.
+    const { traits } = htElement.message.context;
+    const { userId } = htElement.message;
+
+    if (userId) {
+      posthog.identify(userId, traits);
+    }
+
+    this.processSuperProperties(htElement);
+  }
+
+  track(htElement) {
+    logger.debug('in Posthog track');
+
+    const { event, properties } = htElement.message;
+
+    this.processSuperProperties(htElement);
+
+    posthog.capture(event, properties);
+  }
+
+  /**
+   *
+   *
+   * @memberof Posthog
+   */
+  page(htElement) {
+    logger.debug('in Posthog page');
+
+    this.processSuperProperties(htElement);
+
+    posthog.capture('$pageview');
+  }
+
+  group(htElement) {
+    logger.debug('in Posthog group');
+    const traits = get(htElement.message, 'traits');
+    const groupKey = get(htElement.message, 'groupId');
+    let groupType;
+    if (traits) {
+      groupType = get(traits, 'groupType');
+      delete traits.groupType;
+    }
+    if (!groupType || !groupKey) {
+      logger.error('groupType and groupKey is required for group call');
+      return;
+    }
+    posthog.group(groupType, groupKey, traits);
+
+    this.processSuperProperties(htElement);
+  }
+}
+
+export default Posthog;

package/src/integrations/Posthog/constants.js

@@ -0,0 +1,12 @@
+const NAME = 'POSTHOG';
+const CNameMapping = {
+  [NAME]: NAME,
+  PostHog: NAME,
+  Posthog: NAME,
+  posthog: NAME,
+  'Post Hog': NAME,
+  'Post hog': NAME,
+  'post hog': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Posthog/index.js

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

package/src/integrations/Posthog/nativeSdkLoader.js

@@ -0,0 +1,48 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk() {
+  !(function (t, e) {
+    var o, n, p, r;
+    e.__SV ||
+      ((window.posthog = e),
+      (e._i = []),
+      (e.init = function (i, s, a) {
+        function g(t, e) {
+          var o = e.split('.');
+          2 == o.length && ((t = t[o[0]]), (e = o[1])),
+            (t[e] = function () {
+              t.push([e].concat(Array.prototype.slice.call(arguments, 0)));
+            });
+        }
+        ((p = t.createElement('script')).type = 'text/javascript'),
+          (p.async = !0),
+          p.setAttribute('data-loader', LOAD_ORIGIN),
+          (p.src = s.api_host + '/static/array.js'),
+          (r = t.getElementsByTagName('script')[0]).parentNode.insertBefore(p, r);
+        var u = e;
+        for (
+          void 0 !== a ? (u = e[a] = []) : (a = 'posthog'),
+            u.people = u.people || [],
+            u.toString = function (t) {
+              var e = 'posthog';
+              return 'posthog' !== a && (e += '.' + a), t || (e += ' (stub)'), e;
+            },
+            u.people.toString = function () {
+              return u.toString(1) + '.people (stub)';
+            },
+            o =
+              'capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags'.split(
+                ' ',
+              ),
+            n = 0;
+          n < o.length;
+          n++
+        )
+          g(u, o[n]);
+        e._i.push([i, s, a]);
+      }),
+      (e.__SV = 1));
+  })(document, window.posthog || []);
+}
+
+export { loadNativeSdk };

package/src/integrations/Posthog/test/test_posthog.html

@@ -0,0 +1,77 @@
+<html>
+  <head>
+    <script type="text/javascript">
+      hightouchevents = window.hightouchevents = [];
+      var methods = ['load', 'page', 'identify', 'track', 'ready', 'group'];
+      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('1l90d23mEVIDyCeoZkE7X85DH0P', 'https://hosted.rudderlabs.com', {
+        logLevel: 'DEBUG',
+        configUrl: 'http://localhost:5000/sourceConfig',
+        loadIntegration: false,
+      });
+    </script>
+    <script src="https://cdn.rudderlabs.com/v1/events-staging.min.js"></script>
+    <script>
+      hightouchevents.page();
+      hightouchevents.identify(
+        'user123456',
+        { email: 'user@email.com', age: 22 },
+        {
+          integrations: {
+            Posthog: { unsetProperties: ['identifysuperprop1', 'identifysuperprop2'] },
+          },
+        },
+      );
+      hightouchevents.track('track without property');
+      hightouchevents.track(
+        'track with property',
+        { validProp: 'valid property', blackproperty: 'not valid' },
+        {
+          integrations: {
+            Posthog: {
+              superProperties: { superprop1: 'value1', superprop2: 'value2' },
+              setOnceProperties: { onceprop: 'value2' },
+            },
+          },
+        },
+      );
+      hightouchevents.track(
+        'track with property2',
+        { validProp: 'valid property', blackproperty: 'not valid' },
+        {
+          integrations: {
+            Posthog: { unsetProperties: ['identifysuperprop1', 'identifysuperprop2'] },
+          },
+        },
+      );
+      /*
+      The above calls will generate the following 3 base64 encoded payloads - 
+
+      eyIkc2V0Ijp7IiRvcyI6Ik1hYyBPUyBYIiwiJGJyb3dzZXIiOiJDaHJvbWUiLCIkYnJvd3Nlcl92ZXJzaW9uIjo4OCwiJGluaXRpYWxfcmVmZXJyZXIiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC8iLCIkaW5pdGlhbF9yZWZlcnJpbmdfZG9tYWluIjoibG9jYWxob3N0OjIyMjIiLCJlbWFpbCI6InVzZXJAZW1haWwuY29tIiwiYWdlIjoyMn0sIiR0b2tlbiI6IjhuZzA2RDcxdTRXMkNYbnE5T2N2dGtWTzBrbjlsaXNnVzNLVEEyRTg1VnMiLCIkZGlzdGluY3RfaWQiOiJ1c2VyMTIzNDU2IiwiJGRldmljZV9pZCI6IjE3NzZiZTc2ZDA4NGQ4LTBmMjE4MzlkMWZlMGJjLTE2M2U2NTVjLTFhZWFhMC0xNzc2YmU3NmQwOThlOSIsIiR1c2VyX2lkIjoidXNlcjEyMzQ1NiJ9
+      which is decoded as - 
+      {"$set":{"$os":"Mac OS X","$browser":"Chrome","$browser_version":88,"$initial_referrer":"http://localhost:2222/tests/html/","$initial_referring_domain":"localhost:2222","email":"user@email.com","age":22},"$token":"8ng06D71u4W2CXnq9OcvtkVO0kn9lisgW3KTA2E85Vs","$distinct_id":"user123456","$device_id":"1776be76d084d8-0f21839d1fe0bc-163e655c-1aeaa0-1776be76d098e9","$user_id":"user123456"}
+
+
+      eyJ0b2tlbiI6IjhuZzA2RDcxdTRXMkNYbnE5T2N2dGtWTzBrbjlsaXNnVzNLVEEyRTg1VnMiLCJkaXN0aW5jdF9pZCI6InVzZXIxMjM0NTYifQ%3D%3D
+      which is decoded as - 
+      {"token":"8ng06D71u4W2CXnq9OcvtkVO0kn9lisgW3KTA2E85Vs","distinct_id":"user123456"}
+
+
+      W3siZXZlbnQiOiIkcGFnZXZpZXciLCJwcm9wZXJ0aWVzIjp7IiRvcyI6Ik1hYyBPUyBYIiwiJGJyb3dzZXIiOiJDaHJvbWUiLCIkY3VycmVudF91cmwiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC90ZXN0X3Bvc3Rob2cuaHRtbCIsIiRob3N0IjoibG9jYWxob3N0OjIyMjIiLCIkcGF0aG5hbWUiOiIvdGVzdHMvaHRtbC90ZXN0X3Bvc3Rob2cuaHRtbCIsIiRicm93c2VyX3ZlcnNpb24iOjg4LCIkc2NyZWVuX2hlaWdodCI6MTA1MCwiJHNjcmVlbl93aWR0aCI6MTY4MCwiJGxpYiI6IndlYiIsIiRsaWJfdmVyc2lvbiI6IjEuOC4zIiwiJGluc2VydF9pZCI6IjR0bmI5dTNmaDN0bjdmYzYiLCIkdGltZSI6MTYxMjQzMDQ5MC41MiwiZGlzdGluY3RfaWQiOiJ1c2VyMTIzNDU2IiwiJGRldmljZV9pZCI6IjE3NzZiZTc2ZDA4NGQ4LTBmMjE4MzlkMWZlMGJjLTE2M2U2NTVjLTFhZWFhMC0xNzc2YmU3NmQwOThlOSIsIiRpbml0aWFsX3JlZmVycmVyIjoiaHR0cDovL2xvY2FsaG9zdDoyMjIyL3Rlc3RzL2h0bWwvIiwiJGluaXRpYWxfcmVmZXJyaW5nX2RvbWFpbiI6ImxvY2FsaG9zdDoyMjIyIiwiJHJlZmVycmVyIjoiaHR0cDovL2xvY2FsaG9zdDoyMjIyL3Rlc3RzL2h0bWwvIiwiJHJlZmVycmluZ19kb21haW4iOiJsb2NhbGhvc3Q6MjIyMiIsIiR1c2VyX2lkIjoidXNlcjEyMzQ1NiIsInN1cGVycHJvcDEiOiJ2YWx1ZTEiLCJzdXBlcnByb3AyIjoidmFsdWUyIiwiJGFjdGl2ZV9mZWF0dXJlX2ZsYWdzIjpbXSwib25jZXByb3AiOiJ2YWx1ZTEiLCJpZGVudGlmeW9uY2Vwcm9wIjoidmFsdWUxIiwidG9rZW4iOiI4bmcwNkQ3MXU0VzJDWG5xOU9jdnRrVk8wa245bGlzZ1czS1RBMkU4NVZzIn0sIm9mZnNldCI6MTZ9LHsiZXZlbnQiOiJ0cmFjayB3aXRob3V0IHByb3BlcnR5IiwicHJvcGVydGllcyI6eyIkb3MiOiJNYWMgT1MgWCIsIiRicm93c2VyIjoiQ2hyb21lIiwiJGN1cnJlbnRfdXJsIjoiaHR0cDovL2xvY2FsaG9zdDoyMjIyL3Rlc3RzL2h0bWwvdGVzdF9wb3N0aG9nLmh0bWwiLCIkaG9zdCI6ImxvY2FsaG9zdDoyMjIyIiwiJHBhdGhuYW1lIjoiL3Rlc3RzL2h0bWwvdGVzdF9wb3N0aG9nLmh0bWwiLCIkYnJvd3Nlcl92ZXJzaW9uIjo4OCwiJHNjcmVlbl9oZWlnaHQiOjEwNTAsIiRzY3JlZW5fd2lkdGgiOjE2ODAsIiRsaWIiOiJ3ZWIiLCIkbGliX3ZlcnNpb24iOiIxLjguMyIsIiRpbnNlcnRfaWQiOiJmbDhnYnQ3ODVjNndkZGZzIiwiJHRpbWUiOjE2MTI0MzA0OTAuNTI2LCJkaXN0aW5jdF9pZCI6InVzZXIxMjM0NTYiLCIkZGV2aWNlX2lkIjoiMTc3NmJlNzZkMDg0ZDgtMGYyMTgzOWQxZmUwYmMtMTYzZTY1NWMtMWFlYWEwLTE3NzZiZTc2ZDA5OGU5IiwiJGluaXRpYWxfcmVmZXJyZXIiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC8iLCIkaW5pdGlhbF9yZWZlcnJpbmdfZG9tYWluIjoibG9jYWxob3N0OjIyMjIiLCIkcmVmZXJyZXIiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC8iLCIkcmVmZXJyaW5nX2RvbWFpbiI6ImxvY2FsaG9zdDoyMjIyIiwiJHVzZXJfaWQiOiJ1c2VyMTIzNDU2Iiwic3VwZXJwcm9wMSI6InZhbHVlMSIsInN1cGVycHJvcDIiOiJ2YWx1ZTIiLCIkYWN0aXZlX2ZlYXR1cmVfZmxhZ3MiOltdLCJvbmNlcHJvcCI6InZhbHVlMSIsImlkZW50aWZ5b25jZXByb3AiOiJ2YWx1ZTEiLCJ0b2tlbiI6IjhuZzA2RDcxdTRXMkNYbnE5T2N2dGtWTzBrbjlsaXNnVzNLVEEyRTg1VnMifSwib2Zmc2V0IjoxMH0seyJldmVudCI6InRyYWNrIHdpdGggcHJvcGVydHkiLCJwcm9wZXJ0aWVzIjp7IiRvcyI6Ik1hYyBPUyBYIiwiJGJyb3dzZXIiOiJDaHJvbWUiLCIkY3VycmVudF91cmwiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC90ZXN0X3Bvc3Rob2cuaHRtbCIsIiRob3N0IjoibG9jYWxob3N0OjIyMjIiLCIkcGF0aG5hbWUiOiIvdGVzdHMvaHRtbC90ZXN0X3Bvc3Rob2cuaHRtbCIsIiRicm93c2VyX3ZlcnNpb24iOjg4LCIkc2NyZWVuX2hlaWdodCI6MTA1MCwiJHNjcmVlbl93aWR0aCI6MTY4MCwiJGxpYiI6IndlYiIsIiRsaWJfdmVyc2lvbiI6IjEuOC4zIiwiJGluc2VydF9pZCI6IjgzNHNnM2RlZTY0NHFybXYiLCIkdGltZSI6MTYxMjQzMDQ5MC41MjgsImRpc3RpbmN0X2lkIjoidXNlcjEyMzQ1NiIsIiRkZXZpY2VfaWQiOiIxNzc2YmU3NmQwODRkOC0wZjIxODM5ZDFmZTBiYy0xNjNlNjU1Yy0xYWVhYTAtMTc3NmJlNzZkMDk4ZTkiLCIkaW5pdGlhbF9yZWZlcnJlciI6Imh0dHA6Ly9sb2NhbGhvc3Q6MjIyMi90ZXN0cy9odG1sLyIsIiRpbml0aWFsX3JlZmVycmluZ19kb21haW4iOiJsb2NhbGhvc3Q6MjIyMiIsIiRyZWZlcnJlciI6Imh0dHA6Ly9sb2NhbGhvc3Q6MjIyMi90ZXN0cy9odG1sLyIsIiRyZWZlcnJpbmdfZG9tYWluIjoibG9jYWxob3N0OjIyMjIiLCIkdXNlcl9pZCI6InVzZXIxMjM0NTYiLCJzdXBlcnByb3AxIjoidmFsdWUxIiwic3VwZXJwcm9wMiI6InZhbHVlMiIsIiRhY3RpdmVfZmVhdHVyZV9mbGFncyI6W10sIm9uY2Vwcm9wIjoidmFsdWUxIiwiaWRlbnRpZnlvbmNlcHJvcCI6InZhbHVlMSIsInZhbGlkUHJvcCI6InZhbGlkIHByb3BlcnR5IiwidG9rZW4iOiI4bmcwNkQ3MXU0VzJDWG5xOU9jdnRrVk8wa245bGlzZ1czS1RBMkU4NVZzIn0sIm9mZnNldCI6OH0seyJldmVudCI6InRyYWNrIHdpdGggcHJvcGVydHkyIiwicHJvcGVydGllcyI6eyIkb3MiOiJNYWMgT1MgWCIsIiRicm93c2VyIjoiQ2hyb21lIiwiJGN1cnJlbnRfdXJsIjoiaHR0cDovL2xvY2FsaG9zdDoyMjIyL3Rlc3RzL2h0bWwvdGVzdF9wb3N0aG9nLmh0bWwiLCIkaG9zdCI6ImxvY2FsaG9zdDoyMjIyIiwiJHBhdGhuYW1lIjoiL3Rlc3RzL2h0bWwvdGVzdF9wb3N0aG9nLmh0bWwiLCIkYnJvd3Nlcl92ZXJzaW9uIjo4OCwiJHNjcmVlbl9oZWlnaHQiOjEwNTAsIiRzY3JlZW5fd2lkdGgiOjE2ODAsIiRsaWIiOiJ3ZWIiLCIkbGliX3ZlcnNpb24iOiIxLjguMyIsIiRpbnNlcnRfaWQiOiIwbmVrb2pqMjlqeHd6NzliIiwiJHRpbWUiOjE2MTI0MzA0OTAuNTI5LCJkaXN0aW5jdF9pZCI6InVzZXIxMjM0NTYiLCIkZGV2aWNlX2lkIjoiMTc3NmJlNzZkMDg0ZDgtMGYyMTgzOWQxZmUwYmMtMTYzZTY1NWMtMWFlYWEwLTE3NzZiZTc2ZDA5OGU5IiwiJGluaXRpYWxfcmVmZXJyZXIiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC8iLCIkaW5pdGlhbF9yZWZlcnJpbmdfZG9tYWluIjoibG9jYWxob3N0OjIyMjIiLCIkcmVmZXJyZXIiOiJodHRwOi8vbG9jYWxob3N0OjIyMjIvdGVzdHMvaHRtbC8iLCIkcmVmZXJyaW5nX2RvbWFpbiI6ImxvY2FsaG9zdDoyMjIyIiwiJHVzZXJfaWQiOiJ1c2VyMTIzNDU2Iiwic3VwZXJwcm9wMSI6InZhbHVlMSIsInN1cGVycHJvcDIiOiJ2YWx1ZTIiLCIkYWN0aXZlX2ZlYXR1cmVfZmxhZ3MiOltdLCJvbmNlcHJvcCI6InZhbHVlMSIsImlkZW50aWZ5b25jZXByb3AiOiJ2YWx1ZTEiLCJ2YWxpZFByb3AiOiJ2YWxpZCBwcm9wZXJ0eSIsInRva2VuIjoiOG5nMDZENzF1NFcyQ1hucTlPY3Z0a1ZPMGtuOWxpc2dXM0tUQTJFODVWcyJ9LCJvZmZzZXQiOjd9XQ==
+      which is decoded as - 
+      [{"event":"$pageview","properties":{"$os":"Mac OS X","$browser":"Chrome","$current_url":"http://localhost:2222/tests/html/test_posthog.html","$host":"localhost:2222","$pathname":"/tests/html/test_posthog.html","$browser_version":88,"$screen_height":1050,"$screen_width":1680,"$lib":"web","$lib_version":"1.8.3","$insert_id":"4tnb9u3fh3tn7fc6","$time":1612430490.52,"distinct_id":"user123456","$device_id":"1776be76d084d8-0f21839d1fe0bc-163e655c-1aeaa0-1776be76d098e9","$initial_referrer":"http://localhost:2222/tests/html/","$initial_referring_domain":"localhost:2222","$referrer":"http://localhost:2222/tests/html/","$referring_domain":"localhost:2222","$user_id":"user123456","superprop1":"value1","superprop2":"value2","$active_feature_flags":[],"onceprop":"value1","identifyonceprop":"value1","token":"8ng06D71u4W2CXnq9OcvtkVO0kn9lisgW3KTA2E85Vs"},"offset":16},{"event":"track without property","properties":{"$os":"Mac OS X","$browser":"Chrome","$current_url":"http://localhost:2222/tests/html/test_posthog.html","$host":"localhost:2222","$pathname":"/tests/html/test_posthog.html","$browser_version":88,"$screen_height":1050,"$screen_width":1680,"$lib":"web","$lib_version":"1.8.3","$insert_id":"fl8gbt785c6wddfs","$time":1612430490.526,"distinct_id":"user123456","$device_id":"1776be76d084d8-0f21839d1fe0bc-163e655c-1aeaa0-1776be76d098e9","$initial_referrer":"http://localhost:2222/tests/html/","$initial_referring_domain":"localhost:2222","$referrer":"http://localhost:2222/tests/html/","$referring_domain":"localhost:2222","$user_id":"user123456","superprop1":"value1","superprop2":"value2","$active_feature_flags":[],"onceprop":"value1","identifyonceprop":"value1","token":"8ng06D71u4W2CXnq9OcvtkVO0kn9lisgW3KTA2E85Vs"},"offset":10},{"event":"track with property","properties":{"$os":"Mac OS X","$browser":"Chrome","$current_url":"http://localhost:2222/tests/html/test_posthog.html","$host":"localhost:2222","$pathname":"/tests/html/test_posthog.html","$browser_version":88,"$screen_height":1050,"$screen_width":1680,"$lib":"web","$lib_version":"1.8.3","$insert_id":"834sg3dee644qrmv","$time":1612430490.528,"distinct_id":"user123456","$device_id":"1776be76d084d8-0f21839d1fe0bc-163e655c-1aeaa0-1776be76d098e9","$initial_referrer":"http://localhost:2222/tests/html/","$initial_referring_domain":"localhost:2222","$referrer":"http://localhost:2222/tests/html/","$referring_domain":"localhost:2222","$user_id":"user123456","superprop1":"value1","superprop2":"value2","$active_feature_flags":[],"onceprop":"value1","identifyonceprop":"value1","validProp":"valid property","token":"8ng06D71u4W2CXnq9OcvtkVO0kn9lisgW3KTA2E85Vs"},"offset":8},{"event":"track with property2","properties":{"$os":"Mac OS X","$browser":"Chrome","$current_url":"http://localhost:2222/tests/html/test_posthog.html","$host":"localhost:2222","$pathname":"/tests/html/test_posthog.html","$browser_version":88,"$screen_height":1050,"$screen_width":1680,"$lib":"web","$lib_version":"1.8.3","$insert_id":"0nekojj29jxwz79b","$time":1612430490.529,"distinct_id":"user123456","$device_id":"1776be76d084d8-0f21839d1fe0bc-163e655c-1aeaa0-1776be76d098e9","$initial_referrer":"http://localhost:2222/tests/html/","$initial_referring_domain":"localhost:2222","$referrer":"http://localhost:2222/tests/html/","$referring_domain":"localhost:2222","$user_id":"user123456","superprop1":"value1","superprop2":"value2","$active_feature_flags":[],"onceprop":"value1","identifyonceprop":"value1","validProp":"valid property","token":"8ng06D71u4W2CXnq9OcvtkVO0kn9lisgW3KTA2E85Vs"},"offset":7}]
+
+      */
+    </script>
+  </head>
+  <body>
+    <h1>Relax while I finish my testing process....</h1>
+  </body>
+</html>

package/src/integrations/Posthog/utils.js

@@ -0,0 +1,36 @@
+/**
+ * Returns xhrHeaders object
+ * @param {*} config
+ * @returns
+ */
+const getXhrHeaders = (config) => {
+  const xhrHeaders = {};
+  if (config.xhrHeaders && config.xhrHeaders.length > 0) {
+    config.xhrHeaders.forEach((header) => {
+      if (header?.key?.trim() !== '' && header?.value?.trim() !== '') {
+        xhrHeaders[header.key] = header.value;
+      }
+    });
+  }
+
+  return xhrHeaders;
+};
+
+/**
+ * Returns propertyBlackList array
+ * @param {*} config
+ * @returns
+ */
+const getPropertyBlackList = (config) => {
+  const propertyBlackList = [];
+  if (config.propertyBlackList && config.propertyBlackList.length > 0) {
+    config.propertyBlackList.forEach((element) => {
+      if (element?.property?.trim() !== '') {
+        propertyBlackList.push(element.property);
+      }
+    });
+  }
+  return propertyBlackList;
+};
+
+export { getXhrHeaders, getPropertyBlackList };

package/src/integrations/ProfitWell/browser.js

@@ -0,0 +1,72 @@
+/* eslint-disable class-methods-use-this */
+import get from 'get-value';
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class ProfitWell {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.publicApiKey = config.publicApiKey;
+    this.siteType = config.siteType;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===In init ProfitWell===');
+
+    if (!this.publicApiKey) {
+      logger.debug('===[ProfitWell]: Public API Key not found===');
+      return;
+    }
+    loadNativeSdk(this.publicApiKey);
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded ProfitWell===');
+    return !!(window.profitwell && window.profitwell.length > 0);
+  }
+
+  isReady() {
+    logger.debug('===In isReady ProfitWell===');
+    return !!(window.profitwell && window.profitwell.length > 0);
+  }
+
+  identify(htElement) {
+    logger.debug('===In ProfitWell identify===');
+
+    if (this.siteType === 'marketing') {
+      window.profitwell('start', {});
+      return;
+    }
+
+    const { message } = htElement;
+    const email = get(message, 'context.traits.email');
+    if (email) {
+      window.profitwell('start', {
+        user_email: email,
+      });
+      return;
+    }
+
+    const userId = get(message, 'userId');
+    if (userId) {
+      window.profitwell('start', {
+        user_id: userId,
+      });
+      return;
+    }
+
+    logger.debug('===[ProfitWell]: email or userId is required for identify===');
+  }
+}
+
+export default ProfitWell;

package/src/integrations/ProfitWell/constants.js

@@ -0,0 +1,12 @@
+const NAME = 'PROFITWELL';
+const CNameMapping = {
+  [NAME]: NAME,
+  ProfitWell: NAME,
+  profitwell: NAME,
+  Profitwell: NAME,
+  'Profit Well': NAME,
+  'profit well': NAME,
+  'Profit well': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/ProfitWell/index.js

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

package/src/integrations/ProfitWell/nativeSdkLoader.js

@@ -0,0 +1,25 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk(publicApiKey) {
+  window.publicApiKey = publicApiKey;
+
+  const scriptTag = document.createElement('script');
+  scriptTag.setAttribute('id', 'profitwell-js');
+  scriptTag.setAttribute('data-pw-auth', window.publicApiKey);
+  document.body.appendChild(scriptTag);
+  (function (i, s, o, g, r, a, m) {
+    i[o] =
+      i[o] ||
+      function () {
+        (i[o].q = i[o].q || []).push(arguments);
+      };
+    a = s.createElement(g);
+    m = s.getElementsByTagName(g)[0];
+    a.async = 1;
+    a.setAttribute('data-loader', LOAD_ORIGIN);
+    a.src = `${r}?auth=${window.publicApiKey}`;
+    m.parentNode.insertBefore(a, m);
+  })(window, document, 'profitwell', 'script', 'https://public.profitwell.com/js/profitwell.js');
+}
+
+export { loadNativeSdk };

package/src/integrations/Qualaroo/browser.js

@@ -0,0 +1,116 @@
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+import ScriptLoader from '../../utils/ScriptLoader';
+import { recordQualarooEvents, transformUserTraits } from './utils';
+import { isNotEmpty } from '../../utils/commonUtils';
+
+class Qualaroo {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.name = NAME;
+    this.customerId = config.customerId;
+    this.siteToken = config.siteToken;
+    this.recordQualarooEvents = config.recordQualarooEvents;
+    this.eventsToStandard = config.eventsToStandard;
+    this.updateEventNames = config.updateEventNames;
+    this.eventsList = config.eventsList;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  loadScript() {
+    window._kiq = window._kiq || [];
+    ScriptLoader(
+      'qualaroo-integration',
+      `https://cl.qualaroo.com/ki.js/${this.customerId}/${this.siteToken}.js`,
+    );
+  }
+
+  init() {
+    logger.debug('===In init Qualaroo===');
+    this.loadScript();
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded Qualaroo===');
+    return !!window._kiq && typeof window._kiq === 'object';
+  }
+
+  isReady() {
+    logger.debug('===In isReady Qualaroo===');
+    if (this.recordQualarooEvents) {
+      recordQualarooEvents(
+        this.updateEventNames,
+        this.eventsList,
+        this.eventsToStandard,
+        this.analytics,
+      );
+    }
+    return !!window._kiq && typeof window._kiq === 'object';
+  }
+
+  identify(htElement) {
+    logger.debug('===In Qualaroo identify===');
+    const { message } = htElement;
+    const { traits } = message.context;
+    const userId = traits?.email || message.userId || traits?.userId || traits?.Id || '';
+
+    if (traits?.email) {
+      delete traits.email;
+    }
+    const transformedTraits = transformUserTraits(traits);
+
+    // If userId is not passed in the request, an empty string will be send for unknown visitors.
+    // ref :- https://help.qualaroo.com/hc/en-us/articles/201956628-Using-the-Identity-API-call#:~:text=echo%20%24current_user%2D%3Eemail%20%3F%3E%27%5D)%3B-,Note,-%3A%20Our%20system
+    window._kiq.push(['identify', userId]);
+
+    if (isNotEmpty(transformedTraits)) {
+      window._kiq.push(['set', transformedTraits]);
+    }
+  }
+
+  track(htElement) {
+    logger.debug('===In Qualaroo track===');
+    const { message } = htElement;
+    const { event, context } = message;
+    if (!event) {
+      logger.error('[Qualaroo]:: event is required for track call');
+      return;
+    }
+
+    const integrationName = context.integration?.name;
+    if (integrationName && integrationName === 'Qualaroo') {
+      logger.debug(`[Qualaroo]:: dropping callback event: ${event}`);
+      return;
+    }
+
+    window._kiq.push(['set', { 'Triggered Event': event }]);
+  }
+
+  page(htElement) {
+    logger.debug('===In Qualaroo page===');
+    const { name, category } = htElement.message;
+    let pageFullName;
+    if (name && category) {
+      pageFullName = `${category} ${name}`;
+    } else if (name) {
+      pageFullName = name;
+    } else if (category) {
+      pageFullName = category;
+    }
+
+    if (pageFullName) {
+      window._kiq.push(['set', { 'Viewed Page': pageFullName }]);
+    }
+  }
+}
+
+export default Qualaroo;

package/src/integrations/Qualaroo/constants.js

@@ -0,0 +1,8 @@
+const NAME = 'QUALAROO';
+const CNameMapping = {
+  [NAME]: NAME,
+  Qualaroo: NAME,
+  qualaroo: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Qualaroo/index.js

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

package/src/integrations/Qualaroo/utils.js

@@ -0,0 +1,83 @@
+/* eslint-disable func-names */
+/* eslint-disable no-underscore-dangle */
+import { getHashFromArray } from '../../utils/commonUtils';
+
+const integrationContext = {
+  name: 'Qualaroo',
+  version: '1.0.0',
+};
+
+// supported callback events
+const standardEventsList = ['show', 'close', 'submit', 'noTargetMatch'];
+
+const swapKeyValuePairs = (standardEventsMap) => {
+  const swappedEventsMap = {};
+  Object.keys(standardEventsMap).forEach((key) => {
+    swappedEventsMap[standardEventsMap[key]] = key;
+  });
+  return swappedEventsMap;
+};
+
+/**
+ * This function is used to trigger a callback
+ * @param {*} standardEventsMap mapping of events done by the user
+ * @param {*} eventName standard event name
+ * @param {*} updateEventNames boolean variable to change eventName
+ * @param {*} analytics hightouchevents object
+ */
+const triggerCallback = (standardEventsMap, eventName, updateEventNames, analytics) => {
+  const updatedEvent =
+    standardEventsMap[eventName] && updateEventNames ? standardEventsMap[eventName] : eventName;
+  window._kiq.push([
+    'eventHandler',
+    eventName,
+    function () {
+      analytics.track(
+        `${updatedEvent}`,
+        {},
+        {
+          context: { integration: integrationContext },
+        },
+      );
+    },
+  ]);
+};
+
+/**
+ * This function has event listeners for the occurring events and to make a call for the event after collecting the data.
+ * @param {*} updateEventNames boolean variable to change eventName
+ * @param {*} userDefinedEventsList list of requested events by the user
+ * @param {*} userDefinedEventsMapping mapping of events in the webapp by the user
+ * @param {*} analytics hightouchevents object
+ */
+const recordQualarooEvents = (
+  updateEventNames,
+  userDefinedEventsList,
+  userDefinedEventsMapping,
+  analytics,
+) => {
+  let standardEventsMap = getHashFromArray(userDefinedEventsMapping);
+  standardEventsMap = swapKeyValuePairs(standardEventsMap);
+  standardEventsList.forEach((event) => {
+    if (userDefinedEventsList.includes(event)) {
+      triggerCallback(standardEventsMap, event, updateEventNames, analytics);
+    }
+  });
+};
+
+/**
+ * This function is used to replace all dashes(-) from user traits with underscore(_).
+ * ref :- https://help.qualaroo.com/hc/en-us/articles/201541187-Setting-Additional-User-Properties#:~:text=Notes
+ * @param {*} traits {"name":"John Doe","phone-number":"+9199999999"}
+ * @returns {"name":"John Doe","phone_number":"+9199999999"}
+ */
+const transformUserTraits = (traits) => {
+  const transformedTraits = {};
+  Object.keys(traits).forEach((traitName) => {
+    const transformedTrait = traitName.replace(/-/g, '_');
+    transformedTraits[transformedTrait] = traits[traitName];
+  });
+  return transformedTraits;
+};
+
+export { recordQualarooEvents, transformUserTraits };