castled-js-sdk 0.0.1 → 0.0.2

package/src/integrations/Chartbeat/browser.js

@@ -0,0 +1,148 @@
+/* eslint-disable compat/compat */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import onBody from 'on-body';
+import logger from '../../utils/logUtil';
+import {
+  MAX_WAIT_FOR_INTEGRATION_LOAD,
+  INTEGRATION_LOAD_CHECK_INTERVAL,
+} from '../../utils/constants';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class Chartbeat {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics; // use this to modify failed integrations or for passing events from callback to other destinations
+    window._sf_async_config = window._sf_async_config || {};
+    window._sf_async_config.useCanonical = true;
+    window._sf_async_config.uid = config.uid;
+    window._sf_async_config.domain = config.domain;
+    this._sf_async_config = window._sf_async_config;
+    this.isVideo = !!config.video;
+    this.sendNameAndCategoryAsTitle = config.sendNameAndCategoryAsTitle || true;
+    this.subscriberEngagementKeys = config.subscriberEngagementKeys || [];
+    this.replayEvents = [];
+    this.failed = false;
+    this.isFirstPageCallMade = false;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===in init Chartbeat===');
+  }
+
+  isLoaded() {
+    logger.debug('in Chartbeat isLoaded');
+    if (!this.isFirstPageCallMade) {
+      return true;
+    }
+    return !!window.pSUPERFLY;
+  }
+
+  isFailed() {
+    return this.failed;
+  }
+
+  isReady() {
+    return !!window.pSUPERFLY;
+  }
+
+  page(htElement) {
+    logger.debug('in Chartbeat page');
+    this.loadConfig(htElement);
+
+    if (!this.isFirstPageCallMade) {
+      this.isFirstPageCallMade = true;
+      this.initAfterPage();
+    } else {
+      if (this.failed) {
+        logger.debug('===ignoring cause failed integration===');
+        this.replayEvents = [];
+        return;
+      }
+      if (!this.isLoaded() && !this.failed) {
+        logger.debug('===pushing to replay queue for chartbeat===');
+        this.replayEvents.push(['page', htElement]);
+        return;
+      }
+      logger.debug('===processing page event in chartbeat===');
+      const { properties } = htElement.message;
+      window.pSUPERFLY.virtualPage(properties.path);
+    }
+  }
+
+  loadConfig(htElement) {
+    const { properties } = htElement.message;
+    const category = properties ? properties.category : undefined;
+    const { name } = htElement.message;
+    const author = properties ? properties.author : undefined;
+    let title;
+    if (this.sendNameAndCategoryAsTitle) {
+      title = category && name ? `${category} ${name}` : name;
+    }
+    if (category) window._sf_async_config.sections = category;
+    if (author) window._sf_async_config.authors = author;
+    if (title) window._sf_async_config.title = title;
+
+    window._cbq = window._cbq || [];
+    const { _cbq } = window;
+
+    Object.keys(properties)
+      .filter(
+        (key) =>
+          Object.prototype.hasOwnProperty.call(properties, key) &&
+          this.subscriberEngagementKeys.includes(key),
+      )
+      .forEach((key) => {
+        _cbq.push([key, properties[key]]);
+      });
+  }
+
+  initAfterPage() {
+    onBody(() => {
+      const script = this.isVideo ? 'chartbeat_video.js' : 'chartbeat.js';
+      loadNativeSdk(script);
+    });
+
+    this._isReady(this).then((instance) => {
+      logger.debug('===replaying on chartbeat===');
+      instance.replayEvents.forEach((event) => {
+        instance[event[0]](event[1]);
+      });
+    });
+  }
+
+  pause(time) {
+    return new Promise((resolve) => {
+      setTimeout(resolve, time);
+    });
+  }
+
+  _isReady(instance, time = 0) {
+    return new Promise((resolve) => {
+      if (this.isLoaded()) {
+        this.failed = false;
+        logger.debug('===chartbeat loaded successfully===');
+        resolve(instance);
+      }
+      if (time >= MAX_WAIT_FOR_INTEGRATION_LOAD) {
+        this.failed = true;
+        logger.debug('===chartbeat failed===');
+        resolve(instance);
+      }
+      this.pause(INTEGRATION_LOAD_CHECK_INTERVAL).then(() =>
+        this._isReady(instance, time + INTEGRATION_LOAD_CHECK_INTERVAL).then(resolve),
+      );
+    });
+  }
+}
+
+export { Chartbeat };

package/src/integrations/Chartbeat/constants.js

@@ -0,0 +1,10 @@
+const NAME = 'CHARTBEAT';
+const CNameMapping = {
+  [NAME]: NAME,
+  Chartbeat: NAME,
+  chartbeat: NAME,
+  'Chart Beat': NAME,
+  'chart beat': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Chartbeat/index.js

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

package/src/integrations/Chartbeat/nativeSdkLoader.js

@@ -0,0 +1,7 @@
+import ScriptLoader, { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk(script) {
+  ScriptLoader('chatbeat', `//static.chartbeat.com/js/${script}`);
+}
+
+export { loadNativeSdk };

package/src/integrations/Clevertap/browser.js

@@ -0,0 +1,206 @@
+/* eslint-disable class-methods-use-this */
+import get from 'get-value';
+import logger from '../../utils/logUtil';
+import ScriptLoader from '../../utils/ScriptLoader';
+import { extractCustomFields, getDefinedTraits, isArray, isObject } from '../../utils/utils';
+import { NAME } from './constants';
+
+class Clevertap {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.accountId = config.accountId;
+    this.apiKey = config.passcode;
+    this.name = NAME;
+    this.region = config.region;
+    this.keysToExtract = ['context.traits'];
+    this.exclusionKeys = [
+      'email',
+      'E-mail',
+      'Email',
+      'phone',
+      'Phone',
+      'name',
+      'Name',
+      'gender',
+      'Gender',
+      'birthday',
+      'Birthday',
+      'anonymousId',
+      'userId',
+      'lastName',
+      'lastname',
+      'last_name',
+      'firstName',
+      'firstname',
+      'first_name',
+      'employed',
+      'education',
+      'married',
+      'customerType',
+    ];
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===in init Clevertap===');
+    // START-NO-SONAR-SCAN
+    // disabled sonar scan here as http endpoint is discouraged by sonar
+    const sourceUrl =
+      document.location.protocol === 'https:'
+        ? 'https://d2r1yp2w7bby2u.cloudfront.net/js/clevertap.min.js'
+        : 'http://static.clevertap.com/js/clevertap.min.js';
+    // END-NO-SONAR-SCAN
+
+    window.clevertap = {
+      event: [],
+      profile: [],
+      account: [],
+      onUserLogin: [],
+      notifications: [],
+      privacy: [],
+    };
+    /*
+      Clevertap documentation: https://developer.clevertap.com/docs/web-quickstart-guide#integrate-sdk
+    */
+    const { CLEVERTAP } = this.analytics.loadOnlyIntegrations;
+    if (CLEVERTAP) {
+      this.optOut = CLEVERTAP.optOut;
+      this.useIP = CLEVERTAP.useIP;
+    }
+    window.clevertap.enablePersonalization = true;
+    window.clevertap.privacy.push({ optOut: this.optOut || false });
+    window.clevertap.privacy.push({ useIP: this.useIP || false });
+    window.clevertap.account.push({ id: this.accountId });
+    if (this.region && this.region !== 'none') {
+      window.clevertap.region.push(this.region);
+    }
+
+    ScriptLoader('clevertap-integration', sourceUrl);
+  }
+
+  isLoaded() {
+    logger.debug('in clevertap isLoaded');
+    return !!window.clevertap && window.clevertap.logout !== undefined;
+  }
+
+  isReady() {
+    logger.debug('in clevertap isReady');
+    return !!window.clevertap && window.clevertap.logout !== undefined;
+  }
+
+  identify(htElement) {
+    logger.debug('in clevertap identify');
+
+    const { message } = htElement;
+    const { context } = message;
+    if (!context?.traits) {
+      logger.error('user traits not present');
+      return;
+    }
+    const { userId, email, phone, name } = getDefinedTraits(message);
+    let payload = {
+      Name: name,
+      Identity: userId,
+      Email: email,
+      Phone: phone,
+      Gender: get(message, 'context.traits.gender'),
+      DOB: get(message, 'context.traits.birthday'),
+      Photo: get(message, 'context.traits.avatar'),
+      Employed: get(message, 'context.traits.employed'),
+      Education: get(message, 'context.traits.education'),
+      Married: get(message, 'context.traits.married'),
+      'Customer Type': get(message, 'context.traits.customerType'),
+    };
+
+    // with the exception of one of Identity, Email, or FBID (in Identity)
+    // other fields are optional
+    if (!userId && !email) {
+      logger.error('Either out of userId or email is required');
+      return;
+    }
+
+    // Extract other K-V property from traits about user custom properties
+    try {
+      payload = extractCustomFields(message, payload, this.keysToExtract, this.exclusionKeys);
+    } catch (err) {
+      logger.debug(`Error occured at extractCustomFields ${err}`);
+    }
+    Object.keys(payload).forEach((key) => {
+      if (isObject(payload[key])) {
+        logger.debug('cannot process, unsupported traits');
+      }
+    });
+    window.clevertap.onUserLogin.push({
+      Site: payload,
+    });
+  }
+
+  track(htElement) {
+    logger.debug('in clevertap track');
+    const { event, properties } = htElement.message;
+    if (properties) {
+      if (event === 'Order Completed') {
+        let ecomProperties = {
+          'Charged ID': properties.checkout_id,
+          Amount: properties.revenue,
+          Items: properties.products,
+        };
+        // Extract other K-V property from traits about user custom properties
+        try {
+          ecomProperties = extractCustomFields(
+            htElement.message,
+            ecomProperties,
+            ['properties'],
+            ['checkout_id', 'revenue', 'products'],
+          );
+        } catch (err) {
+          logger.debug(`Error occured at extractCustomFields ${err}`);
+        }
+        window.clevertap.event.push('Charged', ecomProperties);
+      } else {
+        Object.keys(properties).forEach((key) => {
+          if (isObject(properties[key]) || isArray(properties[key])) {
+            logger.debug('cannot process, unsupported event');
+          }
+        });
+        window.clevertap.event.push(event, properties);
+      }
+    } else if (event === 'Order Completed') {
+      window.clevertap.event.push('Charged');
+    } else {
+      window.clevertap.event.push(event);
+    }
+  }
+
+  page(htElement) {
+    logger.debug('in clevertap page');
+    const { name, properties } = htElement.message;
+    let eventName;
+    if (properties?.category && name) {
+      eventName = `WebPage Viewed ${name} ${properties.category}`;
+    } else if (name) {
+      eventName = `WebPage Viewed ${name}`;
+    } else {
+      eventName = 'WebPage Viewed';
+    }
+    if (properties) {
+      Object.keys(properties).forEach((key) => {
+        if (isObject(properties[key]) || isArray(properties[key])) {
+          logger.debug('cannot process, unsupported event');
+        }
+      });
+      window.clevertap.event.push(eventName, properties);
+    } else {
+      window.clevertap.event.push(eventName);
+    }
+  }
+}
+
+export default Clevertap;

package/src/integrations/Clevertap/constants.js

@@ -0,0 +1,8 @@
+const NAME = 'CLEVERTAP';
+const CNameMapping = {
+  [NAME]: NAME,
+  Clevertap: NAME,
+  clevertap: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Clevertap/index.js

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

package/src/integrations/Comscore/browser.js

@@ -0,0 +1,130 @@
+/* eslint-disable compat/compat */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import logger from '../../utils/logUtil';
+import {
+  MAX_WAIT_FOR_INTEGRATION_LOAD,
+  INTEGRATION_LOAD_CHECK_INTERVAL,
+} from '../../utils/constants';
+import { NAME } from './constants';
+import { loadNativeSdk } from './nativeSdkLoader';
+
+class Comscore {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.c2ID = config.c2ID;
+    this.analytics = analytics;
+    this.comScoreBeaconParam = config.comScoreBeaconParam ? config.comScoreBeaconParam : {};
+    this.isFirstPageCallMade = false;
+    this.failed = false;
+    this.comScoreParams = {};
+    this.replayEvents = [];
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===in init Comscore init===');
+  }
+
+  isLoaded() {
+    logger.debug('in Comscore isLoaded');
+    if (!this.isFirstPageCallMade) {
+      return true;
+    }
+    return !!window.COMSCORE;
+  }
+
+  isReady() {
+    return !!window.COMSCORE;
+  }
+
+  page(htElement) {
+    logger.debug('in Comscore page');
+
+    this.loadConfig(htElement);
+
+    if (!this.isFirstPageCallMade) {
+      this.isFirstPageCallMade = true;
+      this.initAfterPage();
+    } else {
+      if (this.failed) {
+        this.replayEvents = [];
+        return;
+      }
+      if (!this.isLoaded() && !this.failed) {
+        this.replayEvents.push(['page', htElement]);
+        return;
+      }
+      window.COMSCORE.beacon(this.comScoreParams);
+    }
+  }
+
+  loadConfig(htElement) {
+    logger.debug('=====in loadConfig=====');
+    this.comScoreParams = this.mapComscoreParams(htElement.message.properties);
+    window._comscore = window._comscore || [];
+    window._comscore.push(this.comScoreParams);
+  }
+
+  initAfterPage() {
+    logger.debug('=====in initAfterPage=====');
+    loadNativeSdk();
+
+    this._isReady(this).then((instance) => {
+      instance.replayEvents.forEach((event) => {
+        instance[event[0]](event[1]);
+      });
+    });
+  }
+
+  pause(time) {
+    return new Promise((resolve) => {
+      setTimeout(resolve, time);
+    });
+  }
+
+  _isReady(instance, time = 0) {
+    return new Promise((resolve) => {
+      if (this.isLoaded()) {
+        this.failed = false;
+        resolve(instance);
+      }
+      if (time >= MAX_WAIT_FOR_INTEGRATION_LOAD) {
+        this.failed = true;
+        resolve(instance);
+      }
+      this.pause(INTEGRATION_LOAD_CHECK_INTERVAL).then(() =>
+        this._isReady(instance, time + INTEGRATION_LOAD_CHECK_INTERVAL).then(resolve),
+      );
+    });
+  }
+
+  mapComscoreParams(properties) {
+    logger.debug('=====in mapComscoreParams=====');
+    const comScoreBeaconParamsMap = this.comScoreBeaconParam;
+
+    const comScoreParams = {};
+
+    Object.keys(comScoreBeaconParamsMap).forEach((property) => {
+      if (property in properties) {
+        const key = comScoreBeaconParamsMap[property];
+        const value = properties[property];
+        comScoreParams[key] = value;
+      }
+    });
+
+    comScoreParams.c1 = '2';
+    comScoreParams.c2 = this.c2ID;
+    logger.debug('=====in mapComscoreParams=====', comScoreParams);
+    return comScoreParams;
+  }
+}
+
+export { Comscore };

package/src/integrations/Comscore/constants.js

@@ -0,0 +1,11 @@
+const NAME = 'COMSCORE';
+const CNameMapping = {
+  [NAME]: NAME,
+  Comscore: NAME,
+  'Com Score': NAME,
+  'com Score': NAME,
+  'com score': NAME,
+  'Com score': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/Comscore/index.js

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

package/src/integrations/Comscore/nativeSdkLoader.js

@@ -0,0 +1,10 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk() {
+  const src = `${
+    document.location.protocol == 'https:' ? 'https://sb' : 'http://b'
+  }.scorecardresearch.com/beacon.js`;
+  ScriptLoader('comscore', src);
+}
+
+export { loadNativeSdk };

package/src/integrations/ConvertFlow/browser.js

@@ -0,0 +1,59 @@
+/* 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 { trigger } from './utils';
+
+class ConvertFlow {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.websiteId = config.websiteId;
+    this.toggleToSendData = config.toggleToSendData;
+    this.eventsList = config.eventsList;
+    this.eventsMappping = config.eventsMappping;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===In init convertflow===');
+    ScriptLoader(
+      'convertflow-integration',
+      `https://js.convertflow.co/production/websites/${this.websiteId}.js`,
+    );
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded convertflow===');
+    if (this.toggleToSendData) {
+      trigger(this.eventsMappping, this.eventsList, this.analytics);
+    }
+    return !!window.convertflow && typeof window.convertflow === 'object';
+  }
+
+  isReady() {
+    logger.debug('===In isReady convertflow===');
+    return !!window.convertflow;
+  }
+
+  identify(htElement) {
+    logger.debug('===In convertflow Identify===');
+    const { message } = htElement;
+    const email = message.context.traits?.email || message.traits?.email;
+    if (!email) {
+      logger.error('email is required for identify call');
+    }
+    const payload = { email, override: true };
+    window.convertflow.identify(payload);
+  }
+}
+
+export default ConvertFlow;

package/src/integrations/ConvertFlow/constants.js

@@ -0,0 +1,15 @@
+const NAME = 'CONVERTFLOW';
+const CNameMapping = {
+  [NAME]: NAME,
+  Convertflow: NAME,
+  convertflow: NAME,
+  convertFlow: NAME,
+  ConvertFlow: NAME,
+  'Convert flow': NAME,
+  'convert flow': NAME,
+  'convert Flow': NAME,
+  'Convert Flow': NAME,
+  'CONVERT FLOW': NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/ConvertFlow/index.js

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