castled-js-sdk 0.0.3 → 0.0.4

package/src/integrations/Satismeter/browser.js

@@ -1,94 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-/* eslint-disable class-methods-use-this */
-import { NAME } from './constants';
-import Logger from '../../utils/logger';
-import { recordSatismeterEvents } from './util';
-import { loadNativeSdk } from './nativeSdkLoader';
-
-const logger = new Logger(NAME);
-class Satismeter {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.analytics = analytics;
-    this.name = NAME;
-    this.writeKey = config.writeKey;
-    this.identifyAnonymousUsers = config.identifyAnonymousUsers;
-    this.recordSatismeterEvents = config.recordSatismeterEvents;
-    this.eventsToStandard = config.eventsToStandard;
-    this.updateEventNames = config.updateEventNames;
-    this.eventsList = config.eventsList;
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-  }
-
-  init() {
-    logger.debug('===In init Satismeter===');
-    loadNativeSdk(this.writeKey);
-  }
-
-  isLoaded() {
-    logger.debug('===In isLoaded Satismeter===');
-    return !!window.satismeter;
-  }
-
-  isReady() {
-    logger.debug('===In isReady Satismeter===');
-    if (this.recordSatismeterEvents) {
-      recordSatismeterEvents(
-        this.updateEventNames,
-        this.eventsList,
-        this.eventsToStandard,
-        this.analytics,
-      );
-    }
-    return !!window.satismeter;
-  }
-
-  identify(htElement) {
-    logger.debug('===In Satismeter identify===');
-    const { message } = htElement;
-    const { traits } = message.context;
-    let userId = message.userId || traits.userId;
-    if (!userId && this.identifyAnonymousUsers) {
-      userId = message.anonymousId || traits?.anonymousId;
-    }
-    if (userId) {
-      if (!traits?.createdAt) {
-        window.satismeter({
-          writeKey: this.writeKey,
-          userId,
-          type: 'identify',
-          traits: { ...traits, createdAt: message.sentAt },
-        });
-      }
-      window.satismeter({
-        writeKey: this.writeKey,
-        userId,
-        type: 'identify',
-        traits,
-      });
-    }
-  }
-
-  track(htElement) {
-    logger.debug('===In Satismeter track===');
-    const { message } = htElement;
-    const { event, context } = message;
-    if (!event) {
-      logger.error('[Satismeter]:: event is required for track call');
-    }
-    const integrationName = context.integration?.name;
-    if (integrationName && integrationName.toLowerCase() === 'satismeter') {
-      logger.info(`[Satismeter]:: dropping callback event: ${event}`);
-      return;
-    }
-    window.satismeter('track', { event });
-  }
-}
-
-export default Satismeter;

package/src/integrations/Satismeter/constants.js

@@ -1,9 +0,0 @@
-const NAME = "SATISMETER";
-const CNameMapping = {
-  [NAME]: NAME,
-  Satismeter: NAME,
-  SatisMeter: NAME,
-  SATISMETER: NAME,
-};
-
-export { NAME, CNameMapping };

package/src/integrations/Satismeter/index.js

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

package/src/integrations/Satismeter/nativeSdkLoader.js

@@ -1,23 +0,0 @@
-import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
-
-function loadNativeSdk(writeKey) {
-  (function () {
-    window.satismeter =
-      window.satismeter ||
-      function () {
-        (window.satismeter.q = window.satismeter.q || []).push(arguments);
-      };
-    window.satismeter.l = 1 * new Date();
-    var script = document.createElement('script');
-    var parent = document.getElementsByTagName('script')[0].parentNode;
-    script.async = 1;
-    script.src = 'https://app.satismeter.com/js';
-    script.setAttribute('data-loader', LOAD_ORIGIN), parent.appendChild(script);
-  })();
-
-  window.satismeter({
-    writeKey: writeKey,
-  });
-}
-
-export { loadNativeSdk };

package/src/integrations/Satismeter/util.js

@@ -1,54 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-import { getHashFromArray } from '../../utils/commonUtils';
-
-const integrationContext = {
-  name: 'Satismeter',
-  version: '1.0.0',
-};
-
-// supported callback events
-const standardEventsList = ['display', 'progress', 'complete', 'dismiss'];
-
-/**
- * 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 {*} events list of events
- * @param {*} analytics hightouchevents object
- */
-const triggerCallback = (standardEventsMap, eventName, updateEventNames, events, analytics) => {
-  const updatedEvent =
-    standardEventsMap[eventName] && updateEventNames ? standardEventsMap[eventName] : eventName;
-  const updatedEvents = events;
-  updatedEvents[eventName] = (event) => {
-    analytics.track(`${updatedEvent}`, event, {
-      context: { integration: integrationContext },
-    });
-  };
-  return updatedEvents;
-};
-/**
- * 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 recordSatismeterEvents = (
-  updateEventNames,
-  userDefinedEventsList,
-  userDefinedEventsMapping,
-  analytics,
-) => {
-  const standardEventsMap = getHashFromArray(userDefinedEventsMapping);
-  let events = {};
-  standardEventsList.forEach((eventName) => {
-    if (userDefinedEventsList.includes(eventName)) {
-      events = triggerCallback(standardEventsMap, eventName, updateEventNames, events, analytics);
-    }
-  });
-  window.satismeter({ events });
-};
-
-export { recordSatismeterEvents };

package/src/integrations/Sendinblue/browser.js

@@ -1,111 +0,0 @@
-/* eslint-disable class-methods-use-this */
-import logger from '../../utils/logUtil';
-import { NAME } from './constants';
-import { prepareUserTraits, prepareTrackEventData, preparePagePayload } from './utils';
-import { validateEmail, validatePhoneWithCountryCode } from '../../utils/commonUtils';
-
-import { getDefinedTraits } from '../../utils/utils';
-import { loadNativeSdk } from './nativeSdkLoader';
-
-class Sendinblue {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.analytics = analytics;
-    this.name = NAME;
-    this.clientKey = config.clientKey;
-    this.contactAttributeMapping = config.contactAttributeMapping;
-    this.sendTraitsInTrack = config.sendTraitsInTrack;
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-  }
-
-  loadScript() {
-    const { clientKey } = this;
-    loadNativeSdk(clientKey);
-  }
-
-  init() {
-    logger.debug('===In init Sendinblue===');
-    this.loadScript();
-  }
-
-  isLoaded() {
-    logger.debug('===In isLoaded Sendinblue===');
-    return !!window.sendinblue;
-  }
-
-  isReady() {
-    logger.debug('===In isReady Sendinblue===');
-    return !!window.sendinblue;
-  }
-
-  identify(htElement) {
-    logger.debug('===In Sendinblue identify===');
-    const { message } = htElement;
-    const { email, phone } = getDefinedTraits(message);
-
-    if (!email) {
-      logger.error('[Sendinblue]:: email is missing');
-      return;
-    }
-
-    if (!validateEmail(email)) {
-      logger.error('[Sendinblue]:: provided email is invalid');
-      return;
-    }
-
-    if (phone && !validatePhoneWithCountryCode(phone)) {
-      logger.error(
-        '[Sendinblue]:: provided phone number is invalid. Please provide valid phone number with country code',
-      );
-      return;
-    }
-
-    const userTraits = prepareUserTraits(message, this.contactAttributeMapping);
-    window.sendinblue.identify(email, {
-      ...userTraits,
-    });
-  }
-
-  track(htElement) {
-    logger.debug('===In Sendinblue track===');
-    const { message } = htElement;
-    const { event } = message;
-    if (!event) {
-      logger.error('[Sendinblue]:: event is required for track call');
-      return;
-    }
-
-    let userTraits = {};
-    if (this.sendTraitsInTrack) {
-      const { phone } = getDefinedTraits(message);
-      if (phone && !validatePhoneWithCountryCode(phone)) {
-        logger.error(
-          '[Sendinblue]:: provided phone number is invalid. Please provide valid phone number with country code',
-        );
-        return;
-      }
-      userTraits = this.sendTraitsInTrack
-        ? prepareUserTraits(message, this.contactAttributeMapping)
-        : {};
-    }
-
-    const eventData = prepareTrackEventData(message);
-    window.sendinblue.track(event, userTraits, eventData);
-  }
-
-  page(htElement) {
-    logger.debug('===In Sendinblue page===');
-    const { message } = htElement;
-    const { name } = message;
-    const payload = preparePagePayload(message);
-    window.sendinblue.page(name, payload);
-  }
-}
-
-export default Sendinblue;

package/src/integrations/Sendinblue/constants.js

@@ -1,25 +0,0 @@
-const NAME = "SENDINBLUE";
-const CNameMapping = {
-  [NAME]: NAME,
-  Sendinblue: NAME,
-  sendinblue: NAME,
-  SendinBlue: NAME
-};
-
-const excludeReservedTraits = [
-  "firstName",
-  "firstname",
-  "first_name",
-  "lastName",
-  "lastname",
-  "last_name",
-  "phone",
-  "Phone",
-  "email",
-  "Email",
-  "E-mail",
-];
-
-const excludePageProperties = ["url", "title", "path", "referrer"];
-
-export { NAME, CNameMapping, excludeReservedTraits, excludePageProperties };

package/src/integrations/Sendinblue/index.js

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

package/src/integrations/Sendinblue/nativeSdkLoader.js

@@ -1,36 +0,0 @@
-import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
-
-function loadNativeSdk(clientKey) {
-  (function () {
-    window.sib = {
-      equeue: [],
-      client_key: clientKey,
-    };
-    window.sendinblue = {};
-    for (var j = ['track', 'identify', 'trackLink', 'page'], i = 0; i < j.length; i++) {
-      (function (k) {
-        window.sendinblue[k] = function () {
-          var arg = Array.prototype.slice.call(arguments);
-          (
-            window.sib[k] ||
-            function () {
-              var t = {};
-              t[k] = arg;
-              window.sib.equeue.push(t);
-            }
-          )(arg[0], arg[1], arg[2], arg[3]);
-        };
-      })(j[i]);
-    }
-    var n = document.createElement('script'),
-      i = document.getElementsByTagName('script')[0];
-    (n.type = 'text/javascript'),
-      (n.id = 'sendinblue-js'),
-      (n.async = !0),
-      (n.src = 'https://sibautomation.com/sa.js?key=' + clientKey),
-      n.setAttribute('data-loader', LOAD_ORIGIN),
-      i.parentNode.insertBefore(n, i);
-  })();
-}
-
-export { loadNativeSdk };

package/src/integrations/Sendinblue/utils.js

@@ -1,112 +0,0 @@
-import { getDefinedTraits } from '../../utils/utils';
-import { NAME, excludeReservedTraits, excludePageProperties } from './constants';
-import {
-  getHashFromArray,
-  removeUndefinedAndNullValues,
-  isNotEmpty,
-} from '../../utils/commonUtils';
-
-// FIRSTNAME, LASTNAME, SMS are the default created contact attributes in sendinblue
-const prepareDefaultContactAttributes = (message) => {
-  const { firstName, lastName, phone } = getDefinedTraits(message);
-  return { FIRSTNAME: firstName, LASTNAME: lastName, SMS: phone };
-};
-
-/**
- * Function to remove duplicate traits from user traits
- * @param {*} userTraits {"FIRSTNAME":"John","firstname":"John","location":"San Francisco","LOCATIOn":"San Francisco"}
- * @param {*} attributeMap {"area_code":"AREA","location":"LOCATION"}
- * @returns // {"FIRSTNAME":"John","LOCATIOn":"San Francisco"}
- */
-const refineUserTraits = (userTraits, attributeMap) => {
-  const refinedTraits = userTraits;
-  Object.keys(userTraits).forEach((key) => {
-    if (
-      excludeReservedTraits.includes(key) ||
-      Object.prototype.hasOwnProperty.call(attributeMap, key)
-    ) {
-      delete refinedTraits[key];
-    }
-  });
-  return refinedTraits;
-};
-
-/**
- * Function to prepare user traits for identify and track call.
- * User traits is a combination of some reserved traits and transformation of reset of the traits with the help of contact attribute mapping defined in webapp.
- * Reserved traits -> first name, last name, phone, email
- * Contact attribute mapping -> [{"from":"area_code","to":"AREA"},{"from":"location","to":"LOCATION"}]
- * @param {*} message
- * @param {*} contactAttributeMapping traits to Sendinblue contact attribute mapping defined in webapp
- * @returns
- */
-const prepareUserTraits = (message, contactAttributeMapping) => {
-  const { traits } = message.context;
-  const reservedTraits = prepareDefaultContactAttributes(message);
-
-  // convert destination.Config.contactAttributeMapping to hashMap
-  const attributeMap = getHashFromArray(contactAttributeMapping, 'from', 'to', false);
-
-  let userTraits = traits;
-  Object.keys(attributeMap).forEach((key) => {
-    const traitValue = traits[key];
-    if (traitValue) {
-      userTraits[attributeMap[key]] = traitValue;
-    }
-  });
-
-  userTraits = { ...reservedTraits, ...userTraits };
-  userTraits = refineUserTraits(userTraits, attributeMap);
-
-  // eslint-disable-next-line consistent-return
-  return removeUndefinedAndNullValues(userTraits);
-};
-
-// Prepare track event data. Event data consists `id` and `data`.
-// id -> from integration object or messageId
-// data -> properties
-const prepareTrackEventData = (message) => {
-  const { properties, integrations, messageId } = message;
-  let eventData = {};
-  if (isNotEmpty(properties)) {
-    let id;
-    if (integrations?.[NAME]) {
-      const key = integrations[NAME]?.propertiesIdKey;
-      if (key) {
-        id = properties[key];
-      }
-    }
-
-    id = id || messageId;
-    eventData = { id, data: removeUndefinedAndNullValues(properties) };
-  }
-  return eventData;
-};
-
-const refinePageProperties = (properties) => {
-  const refinedProperties = properties;
-  excludePageProperties.forEach((key) => delete refinedProperties[key]);
-  return refinedProperties;
-};
-
-const preparePagePayload = (message) => {
-  const { properties, context } = message;
-  const { page } = context;
-
-  const title = properties?.title || page?.title;
-  const url = properties?.url || page?.url;
-  const path = properties?.path || page?.path;
-  const referrer = properties?.referrer || page?.referrer;
-
-  const refinedProperties = refinePageProperties(properties);
-  const payload = {
-    ma_title: title,
-    ma_url: url,
-    ma_path: path,
-    ma_referrer: referrer,
-    ...refinedProperties,
-  };
-  return removeUndefinedAndNullValues(payload);
-};
-
-export { prepareUserTraits, prepareTrackEventData, preparePagePayload };

package/src/integrations/Sentry/browser.js

@@ -1,118 +0,0 @@
-/* eslint-disable class-methods-use-this */
-import get from 'get-value';
-import logger from '../../utils/logUtil';
-import { SentryScriptLoader, sentryInit } from './utils';
-import { removeUndefinedAndNullValues } from '../../utils/commonUtils';
-import { getDefinedTraits, isObject } from '../../utils/utils';
-import { NAME } from './constants';
-
-class Sentry {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.analytics = analytics;
-    this.name = NAME;
-    this.dsn = config.dsn;
-    this.debugMode = config.debugMode;
-    this.environment = config.environment;
-    this.ignoreErrors = config.ignoreErrors;
-    this.includePathsArray = config.includePaths;
-    this.logger = config.logger;
-    this.allowUrls = config.allowUrls;
-    this.denyUrls = config.denyUrls;
-    this.release = config.release;
-    this.customVersionProperty = config.customVersionProperty;
-    this.serverName = config.serverName;
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-  }
-
-  init() {
-    logger.debug('===in init Sentry===');
-    if (!this.dsn) {
-      logger.debug('DSN is a mandatory field');
-      return;
-    }
-    SentryScriptLoader(
-      'sentry',
-      `https://browser.sentry-cdn.com/6.13.1/bundle.min.js`,
-      `sha384-vUP3nL55ipf9vVr3gDgKyDuYwcwOC8nZGAksntVhezPcr2QXl1Ls81oolaVSkPm+`,
-    );
-
-    SentryScriptLoader(
-      'plugin',
-      `https://browser.sentry-cdn.com/6.13.1/rewriteframes.min.js`,
-      `sha384-WOm9k3kzVt1COFAB/zCXOFx4lDMtJh/2vmEizIwgog7OW0P/dPwl3s8f6MdwrD7q`,
-    );
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  isLoaded() {
-    logger.debug('===in Sentry isLoaded===');
-    return !!(
-      window.Sentry &&
-      isObject(window.Sentry) &&
-      window.Sentry.setUser &&
-      window.Sentry.Integrations.RewriteFrames
-    );
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  isReady() {
-    logger.debug('===in Sentry isReady===');
-    if (
-      window.Sentry &&
-      isObject(window.Sentry) &&
-      window.Sentry.setUser &&
-      window.Sentry.Integrations.RewriteFrames
-    ) {
-      const sentryConfig = sentryInit(
-        this.allowUrls,
-        this.denyUrls,
-        this.ignoreErrors,
-        this.includePathsArray,
-        this.customVersionProperty,
-        this.release,
-        this.dsn,
-        this.debugMode,
-        this.environment,
-        this.serverName,
-      );
-      window.Sentry.init(sentryConfig);
-      if (this.logger) {
-        window.Sentry.setTag('logger', this.logger);
-      }
-      return true;
-    }
-    return false;
-  }
-
-  identify(htElement) {
-    const { message } = htElement;
-    const { traits } = message.context;
-    const { email, name } = getDefinedTraits(message); // userId sent as id and username sent as name
-    const userId = get(message, 'userId');
-    const ipAddress = get(message, 'context.traits.ip_address');
-
-    if (!userId && !email && !name && !ipAddress) {
-      // if no user identification property is present the event will be dropped
-      logger.debug('===[Sentry]: Any one of userId, email, name and ip_address is mandatory===');
-      return;
-    }
-
-    const payload = {
-      id: userId,
-      email,
-      username: name,
-      ip_address: ipAddress,
-      ...traits,
-    };
-
-    window.Sentry.setUser(removeUndefinedAndNullValues(payload));
-  }
-}
-export default Sentry;

package/src/integrations/Sentry/constants.js

@@ -1,8 +0,0 @@
-const NAME = 'SENTRY';
-const CNameMapping = {
-  [NAME]: NAME,
-  sentry: NAME,
-  Sentry: NAME,
-};
-
-export { NAME, CNameMapping };

package/src/integrations/Sentry/index.js

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

package/src/integrations/Sentry/utils.js

@@ -1,80 +0,0 @@
-/* eslint-disable no-restricted-syntax */
-/* eslint-disable no-param-reassign */
-import logger from '../../utils/logUtil';
-import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
-import { isDefinedAndNotNullAndNotEmpty } from '../../utils/commonUtils';
-
-const convertObjectToArray = (objectInput, propertyName) =>
-  objectInput
-    .map((objectItem) => objectItem[propertyName])
-    .filter((e) => isDefinedAndNotNullAndNotEmpty(e));
-
-const SentryScriptLoader = (id, src, integrity) => {
-  logger.debug(`in script loader=== ${id}`);
-  const js = document.createElement('script');
-  js.src = src;
-  js.integrity = integrity;
-  js.crossOrigin = 'anonymous';
-  js.type = 'text/javascript';
-  js.id = id;
-  js.setAttribute('data-loader', LOAD_ORIGIN);
-  const e = document.getElementsByTagName('script')[0];
-  logger.debug('==parent script==', e);
-  logger.debug('==adding script==', js);
-  e.parentNode.insertBefore(js, e);
-};
-
-const sentryInit = (
-  allowUrls,
-  denyUrls,
-  ignoreErrors,
-  includePathsArray,
-  customVersionProperty,
-  release,
-  DSN,
-  debugMode,
-  environment,
-  serverName,
-) => {
-  const formattedAllowUrls = convertObjectToArray(allowUrls, 'allowUrls');
-  const formattedDenyUrls = convertObjectToArray(denyUrls, 'denyUrls');
-  const formattedIgnoreErrors = convertObjectToArray(ignoreErrors, 'ignoreErrors');
-  const formattedIncludePaths = convertObjectToArray(includePathsArray, 'includePaths');
-
-  const customRelease = customVersionProperty ? window[customVersionProperty] : null;
-
-  const sentryConfig = {
-    dsn: DSN,
-    debug: debugMode,
-    environment: environment || null,
-    release: customRelease || release || null,
-    serverName: serverName || null,
-    allowUrls: formattedAllowUrls,
-    denyUrls: formattedDenyUrls,
-    ignoreErrors: formattedIgnoreErrors,
-  };
-
-  if (formattedIncludePaths.length > 0) {
-    sentryConfig.integrations = [
-      new window.Sentry.Integrations.RewriteFrames({
-        iteratee(frame) {
-          for (const path of formattedIncludePaths) {
-            try {
-              if (frame.filename.match(new RegExp(path))) {
-                frame.in_app = true;
-                return frame;
-              }
-            } catch (e) {
-              // ignored
-            }
-          }
-          frame.in_app = false;
-          return frame;
-        },
-      }),
-    ];
-  }
-  return sentryConfig;
-};
-
-export { SentryScriptLoader, convertObjectToArray, sentryInit };