castled-js-sdk 0.0.1 → 0.0.3

package/src/integrations/VWO/browser.js

@@ -0,0 +1,131 @@
+/* eslint-disable no-undef */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+/* eslint-disable camelcase */
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class VWO {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.accountId = config.accountId; // 1549611
+    this.settingsTolerance = config.settingsTolerance;
+    this.isSPA = config.isSPA;
+    this.libraryTolerance = config.libraryTolerance;
+    this.useExistingJquery = config.useExistingJquery;
+    this.sendExperimentTrack = config.sendExperimentTrack;
+    this.sendExperimentIdentify = config.sendExperimentIdentify;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+    logger.debug('Config ', config);
+  }
+
+  init() {
+    logger.debug('===In init VWO===');
+    if (this.analytics.loadOnlyIntegrations?.VWO?.loadIntegration) {
+      const account_id = this.accountId;
+      const settings_tolerance = this.settingsTolerance;
+      const library_tolerance = this.libraryTolerance;
+      const use_existing_jquery = this.useExistingJquery;
+      const { isSPA } = this;
+      loadNativeSdk(account_id, settings_tolerance, library_tolerance, use_existing_jquery, isSPA);
+    } else {
+      logger.debug('===[VWO]loadIntegration flag is disabled===');
+    }
+    // Send track or iddentify when
+    if (this.sendExperimentTrack || this.experimentViewedIdentify) {
+      this.experimentViewed();
+    }
+  }
+
+  experimentViewed() {
+    window.VWO = window.VWO || [];
+    const self = this;
+    window.VWO.push([
+      'onVariationApplied',
+      (data) => {
+        if (!data) {
+          return;
+        }
+        logger.debug('Variation Applied');
+        const expId = data[1];
+        const variationId = data[2];
+        logger.debug(
+          'experiment id:',
+          expId,
+          'Variation Name:',
+          _vwo_exp[expId].comb_n[variationId],
+        );
+        if (
+          typeof _vwo_exp[expId].comb_n[variationId] !== 'undefined' &&
+          ['VISUAL_AB', 'VISUAL', 'SPLIT_URL', 'SURVEY'].indexOf(_vwo_exp[expId].type) > -1
+        ) {
+          try {
+            if (self.sendExperimentTrack) {
+              logger.debug('Tracking...');
+              this.analytics.track('Experiment Viewed', {
+                experimentId: expId,
+                variationName: _vwo_exp[expId].comb_n[variationId],
+                CampaignName: _vwo_exp[expId].name,
+                VariationId: variationId,
+              });
+            }
+          } catch (error) {
+            logger.error('[VWO] experimentViewed:: ', error);
+          }
+          try {
+            if (self.sendExperimentIdentify) {
+              logger.debug('Identifying...');
+              this.analytics.identify({
+                [`Experiment: ${expId}`]: _vwo_exp[expId].comb_n[variationId],
+              });
+            }
+          } catch (error) {
+            logger.error('[VWO] experimentViewed:: ', error);
+          }
+        }
+      },
+    ]);
+  }
+
+  identify() {
+    logger.debug('[VWO] identify:: method not supported');
+  }
+
+  track(htElement) {
+    logger.debug('===In VWO track===');
+    const eventName = htElement.message.event;
+    if (eventName === 'Order Completed') {
+      const total = htElement.message.properties
+        ? htElement.message.properties.total || htElement.message.properties.revenue
+        : 0;
+      logger.debug('Revenue', total);
+      window.VWO = window.VWO || [];
+      window.VWO.push(['track.revenueConversion', total]);
+    }
+  }
+
+  page() {
+    logger.debug('[VWO] page:: method not supported');
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded VWO===');
+    return !!window._vwo_code;
+  }
+
+  isReady() {
+    logger.debug('===In isReady VWO===');
+    return !!window._vwo_code;
+  }
+}
+
+export { VWO };

package/src/integrations/VWO/constants.js

@@ -0,0 +1,13 @@
+const NAME = 'VWO';
+const CNameMapping = {
+  [NAME]: NAME,
+  VisualWebsiteOptimizer: NAME,
+  Visualwebsiteoptimizer: NAME,
+  visualwebsiteoptimizer: NAME,
+  vwo: NAME,
+  'Visual Website Optimizer': NAME,
+  'Visual website optimizer': NAME,
+  'visual website optimizer': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/VWO/index.js

@@ -0,0 +1 @@
+export { VWO } from './browser';

package/src/integrations/VWO/nativeSdkLoader.js

@@ -0,0 +1,64 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk(
+  account_id,
+  settings_tolerance,
+  library_tolerance,
+  use_existing_jquery,
+  isSPA,
+) {
+  window._vwo_code = (function () {
+    let f = false;
+    const d = document;
+    return {
+      use_existing_jquery() {
+        return use_existing_jquery;
+      },
+      library_tolerance() {
+        return library_tolerance;
+      },
+      finish() {
+        if (!f) {
+          f = true;
+          const a = d.getElementById('_vis_opt_path_hides');
+          if (a) a.parentNode.removeChild(a);
+        }
+      },
+      finished() {
+        return f;
+      },
+      load(a) {
+        const b = d.createElement('script');
+        b.src = a;
+        b.type = 'text/javascript';
+        b.setAttribute('data-loader', LOAD_ORIGIN);
+        b.innerText;
+        b.onerror = function () {
+          _vwo_code.finish();
+        };
+        d.getElementsByTagName('head')[0].appendChild(b);
+      },
+      init() {
+        const settings_timer = setTimeout('_vwo_code.finish()', settings_tolerance);
+        const a = d.createElement('style');
+        const b =
+          'body{opacity:0 !important;filter:alpha(opacity=0) !important;background:none !important;}';
+        const h = d.getElementsByTagName('head')[0];
+        a.setAttribute('id', '_vis_opt_path_hides');
+        a.setAttribute('type', 'text/css');
+        if (a.styleSheet) a.styleSheet.cssText = b;
+        else a.appendChild(d.createTextNode(b));
+        h.appendChild(a);
+        this.load(
+          `//dev.visualwebsiteoptimizer.com/j.php?a=${account_id}&u=${encodeURIComponent(
+            d.URL,
+          )}&r=${Math.random()}&f=${+isSPA}`,
+        );
+        return settings_timer;
+      },
+    };
+  })();
+  window._vwo_settings_timer = window._vwo_code.init();
+}
+
+export { loadNativeSdk };

package/src/integrations/Vero/browser.js

@@ -0,0 +1,165 @@
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import { NAME } from './constants';
+import logger from '../../utils/logUtil';
+import { isDefinedAndNotNull } from '../../utils/commonUtils';
+import ScriptLoader from '../../utils/ScriptLoader';
+
+class Vero {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.apiKey = config.apiKey;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===In init Vero===');
+    window._veroq = window._veroq || [];
+    ScriptLoader('vero-integration', 'https://d3qxef4rp70elm.cloudfront.net/m.js');
+    window._veroq.push(['init', { api_key: this.apiKey }]);
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded Vero===');
+    return !!window._veroq && typeof window._veroq === 'object';
+  }
+
+  isReady() {
+    logger.debug('===In isReady Vero===');
+    return !!window._veroq && !!window._veroq.ready;
+  }
+
+  /**
+   * AddOrRemoveTags.
+   * This block handles any tag addition or removal requests.
+   * Ref - http://developers.getvero.com/?javascript#tags
+   *
+   * @param {Object} tags
+   */
+  addOrRemoveTags(message) {
+    const { integrations, anonymousId, userId } = message;
+    if (integrations?.[NAME]) {
+      const { tags } = integrations[NAME];
+      if (isDefinedAndNotNull(tags)) {
+        const id = userId || anonymousId;
+        const addTags = Array.isArray(tags.add) ? tags.add : [];
+        const removeTags = Array.isArray(tags.remove) ? tags.remove : [];
+        window._veroq.push([
+          'tags',
+          {
+            id,
+            add: addTags,
+            remove: removeTags,
+          },
+        ]);
+      }
+    }
+  }
+
+  /**
+   * Identify.
+   * Ref - https://developers.getvero.com/?javascript#users-identify
+   *
+   * @param {Identify} identify
+   */
+  identify(htElement) {
+    const { message } = htElement;
+    const { traits } = message.context || message;
+    const userId = message.userId || message.anonymousId;
+    let payload = traits;
+    if (userId) {
+      payload = { id: userId, ...payload };
+    }
+    window._veroq.push(['user', payload]);
+    this.addOrRemoveTags(message);
+  }
+
+  /**
+   * Track - tracks an event for a specific user
+   * for event `unsubscribe`
+   * Ref - https://developers.getvero.com/?javascript#users-unsubscribe
+   * for event `resubscribe`
+   * Ref - https://developers.getvero.com/?javascript#users-resubscribe
+   * else
+   * Ref - https://developers.getvero.com/?javascript#events-track
+   *
+   * @param {Track} track
+   */
+  track(htElement) {
+    logger.debug('=== In Vero track ===');
+
+    const { message } = htElement;
+    const { event, properties, anonymousId, userId } = message;
+    if (!event) {
+      logger.error('[Vero]: Event name from track call is missing!!===');
+      return;
+    }
+    const id = userId || anonymousId;
+    switch (event.toLowerCase()) {
+      case 'unsubscribe':
+        window._veroq.push(['unsubscribe', id]);
+        break;
+      case 'resubscribe':
+        window._veroq.push(['resubscribe', id]);
+        break;
+      default:
+        window._veroq.push(['track', event, properties]);
+    }
+    this.addOrRemoveTags(message);
+  }
+
+  /**
+   * Page.
+   *
+   * @param {Page} page
+   */
+  page(htElement) {
+    logger.debug('=== In Vero Page ===');
+    const { name, category } = htElement.message;
+    let eventName;
+    if (!name && !category) {
+      eventName = `Viewed Page`;
+    } else if (!name && category) {
+      eventName = `Viewed ${category} Page`;
+    } else if (name && !category) {
+      eventName = `Viewed ${name} Page`;
+    } else {
+      eventName = `Viewed ${category} ${name} Page`;
+    }
+    const elemClone = { ...htElement };
+    elemClone.message = { ...htElement.message };
+    elemClone.message.event = eventName;
+    this.track(elemClone);
+  }
+
+  /**
+   * Alias.
+   * Ref - https://www.getvero.com/api/http/#users
+   *
+   * @param {Alias} alias
+   */
+  alias(htElement) {
+    const { message } = htElement;
+    const { userId, previousId } = message;
+    if (!previousId) {
+      logger.error('===Vero: previousId is required for alias call===');
+      return;
+    }
+    if (!userId) {
+      logger.error('===Vero: userId is required for alias call===');
+      return;
+    }
+    window._veroq.push(['reidentify', userId, previousId]);
+    this.addOrRemoveTags(message);
+  }
+}
+
+export default Vero;

package/src/integrations/Vero/constants.js

@@ -0,0 +1,8 @@
+const NAME = 'VERO';
+const CNameMapping = {
+  [NAME]: NAME,
+  Vero: NAME,
+  vero: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Vero/index.js

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

package/src/integrations/Woopra/browser.js

@@ -0,0 +1,83 @@
+/* eslint-disable class-methods-use-this */
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class Woopra {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.projectName = config.projectName;
+    this.name = NAME;
+    this.cookieName = config.cookieName;
+    this.cookiePath = config.cookiePath;
+    this.cookieDomain = config.cookieDomain;
+    this.clickTracking = config.clickTracking;
+    this.downloadTracking = config.downloadTracking;
+    this.hideCampaign = config.hideCampaign;
+    this.idleTimeout = config.idleTimeout;
+    this.ignoreQueryUrl = config.ignoreQueryUrl;
+    this.outgoingIgnoreSubdomain = config.outgoingIgnoreSubdomain;
+    this.outgoingTracking = config.outgoingTracking;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===In init Woopra===');
+    loadNativeSdk();
+    window.Woopra.config({
+      domain: this.projectName,
+      cookie_name: this.cookieName,
+      cookie_path: this.cookiePath,
+      cookie_domain: this.cookieDomain,
+      click_tracking: this.clickTracking,
+      download_tracking: this.downloadTracking,
+      hide_campaign: this.hideCampaign,
+      idle_timeout: this.idleTimeout,
+      ignore_query_url: this.ignoreQueryUrl,
+      outgoing_ignore_subdomain: this.outgoingIgnoreSubdomain,
+      outgoing_tracking: this.outgoingTracking,
+    });
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded Woopra===');
+    return !!window?.Woopra?.loaded;
+  }
+
+  isReady() {
+    logger.debug('===In isReady Woopra===');
+    return !!window.Woopra;
+  }
+
+  identify(htElement) {
+    logger.debug('===In Woopra Identify===');
+    const { traits } = htElement.message.context;
+    if (traits) {
+      window.Woopra.identify(traits).push();
+    }
+  }
+
+  track(htElement) {
+    logger.debug('===In Woopra Track===');
+    const { event, properties } = htElement.message;
+    window.Woopra.track(event, properties);
+  }
+
+  page(htElement) {
+    logger.debug('===In Woopra Page ===');
+    const { name, properties, category } = htElement.message;
+    const pageCat = category ? `${category} ` : '';
+    const pageName = name ? `${name} ` : '';
+    const eventName = `Viewed ${pageCat}${pageName}Page`;
+    window.Woopra.track(eventName, properties);
+  }
+}
+
+export default Woopra;

package/src/integrations/Woopra/constants.js

@@ -0,0 +1,8 @@
+const NAME = 'WOOPRA';
+const CNameMapping = {
+  [NAME]: NAME,
+  Woopra: NAME,
+  woopra: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Woopra/index.js

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

package/src/integrations/Woopra/nativeSdkLoader.js

@@ -0,0 +1,43 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk() {
+  !(function () {
+    var t,
+      o,
+      c,
+      e = window,
+      n = document,
+      r = arguments,
+      a = 'script',
+      i = [
+        'call',
+        'cancelAction',
+        'config',
+        'identify',
+        'push',
+        'track',
+        'trackClick',
+        'trackForm',
+        'update',
+        'visit',
+      ],
+      s = function () {
+        var t,
+          o = this,
+          c = function (t) {
+            o[t] = function () {
+              return o._e.push([t].concat(Array.prototype.slice.call(arguments, 0))), o;
+            };
+          };
+        for (o._e = [], t = 0; t < i.length; t++) c(i[t]);
+      };
+    for (e.__woo = e.__woo || {}, t = 0; t < r.length; t++)
+      e.__woo[r[t]] = e[r[t]] = e[r[t]] || new s();
+    ((o = n.createElement(a)).async = 1),
+      (o.src = 'https://static.woopra.com/w.js'),
+      o.setAttribute('data-loader', LOAD_ORIGIN),
+      (c = n.getElementsByTagName(a)[0]).parentNode.insertBefore(o, c);
+  })('Woopra');
+}
+
+export { loadNativeSdk };

package/src/integrations/YandexMetrica/browser.js

@@ -0,0 +1,143 @@
+/* eslint-disable class-methods-use-this */
+import logger from '../../utils/logUtil';
+
+import { ecommEventPayload, sendEvent, ecommerceEventMapping } from './utils';
+import {
+  removeUndefinedAndNullValues,
+  getHashFromArrayWithDuplicate,
+} from '../../utils/commonUtils';
+import { NAME } from './constants';
+import { getDefinedTraits } from '../../utils/utils';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class YandexMetrica {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.tagId = config.tagId;
+    this.clickMap = config.clickMap;
+    this.trackLinks = config.trackLinks;
+    this.trackBounce = config.trackBounce;
+    this.webvisor = config.webvisor;
+    this.containerName = config.containerName || 'dataLayer';
+    this.goalId = config.goalId;
+    this.eventNameToYandexEvent = config.eventNameToYandexEvent;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  loadScript() {
+    loadNativeSdk(
+      this.tagId,
+      this.clickMap,
+      this.trackLinks,
+      this.accurateTrackBounce,
+      this.webvisor,
+      this.containerName,
+    );
+  }
+
+  init() {
+    logger.debug('===In init YandexMetrica===');
+    this.loadScript();
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded YandexMetrica===');
+    return !!window.ym && typeof window.ym === 'function';
+  }
+
+  isReady() {
+    logger.debug('===In isReady YandexMetrica===');
+    return !!window.ym;
+  }
+
+  // identify call to yandex.metrica
+  identify(htElement) {
+    logger.debug('===In YandexMetrica Identify===');
+
+    const { message } = htElement;
+    const { userId } = getDefinedTraits(message);
+    let payload = { UserID: userId };
+    if (!message?.context?.traits) {
+      logger.debug('user traits not present');
+    } else {
+      const { traits } = message.context;
+      payload = { ...payload, ...traits };
+    }
+    window.ym(this.tagId, 'setUserID', userId);
+    window.ym(this.tagId, 'userParams', payload);
+  }
+
+  // track call
+  track(htElement) {
+    logger.debug('===In YandexMetrica track===');
+
+    const { message } = htElement;
+    const { event, properties } = message;
+    const eventMappingFromConfigMap = getHashFromArrayWithDuplicate(
+      this.eventNameToYandexEvent,
+      'from',
+      'to',
+      false,
+    );
+
+    if (!event) {
+      logger.error('Event name not present');
+      return;
+    }
+    const ecomEvents = Object.keys(ecommerceEventMapping);
+
+    const trimmedEvent = event.trim().replace(/\s+/g, '_');
+    if (!properties) {
+      logger.error('Properties is not present in the payload');
+      return;
+    }
+
+    if (eventMappingFromConfigMap[event]) {
+      eventMappingFromConfigMap[event].forEach((eventType) => {
+        sendEvent(this.containerName, ecommEventPayload(eventType, properties, this.goalId));
+      });
+    } else if (ecomEvents.includes(trimmedEvent)) {
+      sendEvent(
+        this.containerName,
+        ecommEventPayload(ecommerceEventMapping[trimmedEvent], properties, this.goalId),
+      );
+    } else {
+      logger.error(
+        '[Yandex Metrica]: Event is neither mapped in UI nor it belongs to the supported ecommerce events',
+      );
+    }
+  }
+
+  // page call
+  page(htElement) {
+    logger.debug('===In YandexMetrica Page===');
+    const { message } = htElement;
+    if (!message?.context?.page) {
+      logger.error('page object containing page properties are not present in the payload');
+      return;
+    }
+    const { page } = message.context;
+    if (!page.url) {
+      logger.error('[Yandex Metrica]: url from page call is missing!!===');
+      return;
+    }
+    let payload = {};
+    payload = {
+      ...payload,
+      title: page.title,
+      referer: page.referrer,
+    };
+    payload = removeUndefinedAndNullValues(payload);
+    window.ym(this.tagId, 'hit', page.url, payload);
+  }
+}
+
+export default YandexMetrica;

package/src/integrations/YandexMetrica/constants.js

@@ -0,0 +1,10 @@
+const NAME = 'YANDEX_METRICA';
+const CNameMapping = {
+  [NAME]: NAME,
+  Yandexmetrica: NAME,
+  yandexmetrica: NAME,
+  yandexMetrica: NAME,
+  YandexMetrica: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/YandexMetrica/index.js

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