castled-js-sdk 0.0.3 → 0.0.4

package/src/integrations/ConvertFlow/utils.js

@@ -1,107 +0,0 @@
-import { getHashFromArray, isDefinedAndNotNullAndNotEmpty } from '../../utils/commonUtils';
-
-// default mapping for the events
-const standardEventsListMapping = {
-  cfReady: 'CTA Ready',
-  cfView: 'CTA Viewed',
-  cfConversion: 'CTA Converted',
-  cfCompletion: 'CTA Completed',
-  cfSubmit: 'CTA Form Submitted',
-  cfAddToCart: 'Product Added to Cart',
-  cfClose: 'CTA Closed',
-};
-
-const swapKeyValuePairs = (standardEventsMap) => {
-  const swappedEventsMap = {};
-  Object.keys(standardEventsMap).forEach((key) => {
-    swappedEventsMap[standardEventsMap[key]] = key;
-  });
-  return swappedEventsMap;
-};
-
-/**
- * This function is used to populate properties to be sent in track call using the event data
- * @param {*} data - data here, contains all the details about the event.
- * eg. For event CTA Viewed
- * data: {
- * cta_name: {cta.name}
- * cta_type: {cta.cta_type}
- * }
- */
-const populatingProperties = (data) => {
-  const rudderProperties = {};
-  if (data.cta) {
-    const { cta } = data;
-    rudderProperties.cta_name = cta.name;
-    rudderProperties.cta_type = cta.cta_type;
-    rudderProperties.cta_id = cta.id;
-  }
-  if (data.variant) {
-    rudderProperties.cta_variant = data.variant;
-  }
-  if (data.step) {
-    rudderProperties.cta_step = data.step;
-  }
-  return rudderProperties;
-};
-
-/**
- * This function is used to trigger a callback.
- * @param {*} standardEventsMap mapping of events done by the user
- * @param {*} eventName standard event name
- * @param {*} data data here, contains all the details about the event.
- * @param {*} analytics hightouchevents object
- * eg. For event CTA Viewed
- * data: {
- * cta_name: {cta.name}
- * cta_type: {cta.cta_type}
- * }
- */
-const makeACall = (standardEventsMap, eventName, data, analytics) => {
-  // Updating the event name with any mapping from the webapp if available else
-  // storing default event name in the updatedEvent
-  const updatedEvent = standardEventsMap[eventName]
-    ? standardEventsMap[eventName]
-    : standardEventsListMapping[eventName];
-
-  // Populating Properties
-  let properties = {};
-  if (data) {
-    properties = populatingProperties(data);
-  }
-  if (isDefinedAndNotNullAndNotEmpty(properties)) {
-    analytics.track(updatedEvent, properties);
-  } else {
-    analytics.track(updatedEvent);
-  }
-};
-
-/**
- * This function has event listeners for the occurring events and to make a call for the event after
- * collecting the data.
- * @param {*} userDefinedEventsMapping Mapping of events in the webapp by the user
- * @param {*} userDefinedEventsList List of requested events by the user.
- * @param {*} analytics hightouchevents object
- */
-const trigger = (userDefinedEventsMapping, userDefinedEventsList, analytics) => {
-  let standardEventsMap = getHashFromArray(userDefinedEventsMapping);
-  standardEventsMap = swapKeyValuePairs(standardEventsMap);
-  const standardEventsList = [
-    'cfReady',
-    'cfView',
-    'cfConversion',
-    'cfCompletion',
-    'cfSubmit',
-    'cfAddToCart',
-    'cfClose',
-  ];
-  standardEventsList.forEach((events) => {
-    if (userDefinedEventsList.includes(events)) {
-      window.addEventListener(events, (event) => {
-        makeACall(standardEventsMap, event.type, event.detail, analytics);
-      });
-    }
-  });
-};
-
-export { makeACall, trigger };

package/src/integrations/Criteo/browser.js

@@ -1,155 +0,0 @@
-/* eslint-disable class-methods-use-this */
-import logger from '../../utils/logUtil';
-import ScriptLoader from '../../utils/ScriptLoader';
-import {
-  getDeviceType,
-  handleListView,
-  handlingEventDuo,
-  handleProductView,
-  generateExtraData,
-  handleCommonFields,
-} from './utils';
-import { NAME, supportedEvents } from './constants';
-import { getHashFromArrayWithDuplicate } from '../../utils/commonUtils';
-
-class Criteo {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.analytics = analytics;
-    this.name = NAME;
-    this.hashMethod = config.hashMethod;
-    this.accountId = config.accountId;
-    this.url = config.homePageUrl;
-    this.deviceType = getDeviceType(navigator.userAgent);
-    this.fieldMapping = config.fieldMapping;
-    this.eventsToStandard = config.eventsToStandard;
-    this.OPERATOR_LIST = ['eq', 'gt', 'lt', 'ge', 'le', 'in'];
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-  }
-
-  init() {
-    logger.debug('===in init Criteo===');
-    if (!this.accountId) {
-      logger.debug('Account ID missing');
-      return;
-    }
-    window.criteo_q = window.criteo_q || [];
-
-    ScriptLoader('Criteo', `//dynamic.criteo.com/js/ld/ld.js?a=${this.accountId}`);
-    window.criteo_q.push({ event: 'setAccount', account: this.accountId });
-    window.criteo_q.push({ event: 'setSiteType', type: this.deviceType });
-  }
-
-  isLoaded() {
-    logger.debug('===in Criteo isLoaded===');
-    return !!(window.criteo_q && window.criteo_q.push !== Array.prototype.push);
-  }
-
-  isReady() {
-    logger.debug('===in Criteo isReady===');
-    return !!(window.criteo_q && window.criteo_q.push !== Array.prototype.push);
-  }
-
-  page(htElement) {
-    const { name, properties } = htElement.message;
-
-    const finalPayload = handleCommonFields(htElement, this.hashMethod);
-
-    if (
-      name === 'home' ||
-      (properties && properties.name === 'home') ||
-      (this.url && this.url === window.location.href) ||
-      (properties && properties.url === this.url)
-    ) {
-      const homeEvent = {
-        event: 'viewHome',
-      };
-      finalPayload.push(homeEvent);
-    } else {
-      logger.debug('[Criteo] Home page is not detected');
-      return;
-    }
-
-    const extraDataObject = generateExtraData(htElement, this.fieldMapping);
-    if (Object.keys(extraDataObject).length > 0) {
-      finalPayload.push({ event: 'setData', ...extraDataObject });
-    }
-
-    window.criteo_q.push(finalPayload);
-
-    // Final example payload supported by destination
-    // window.criteo_q.push(
-    //   { event: "setAccount", account: YOUR_PARTNER_ID},
-    //   {
-    //     event: "setEmail",
-    //     email: "##Email Address##",
-    //     hash_method: "##Hash Method##",
-    //   },
-    //   { event: "setSiteType", type: deviceType},
-    //   { event: "setCustomerId", id: "##Customer Id##" },
-    //   { event: "setRetailerVisitorId", id: "##Visitor Id##"},
-    //   { event: "setZipcode", zipcode: "##Zip Code##" },
-    //   { event: "viewHome" }
-    // );
-  }
-
-  track(htElement) {
-    const { event, properties } = htElement.message;
-
-    const finalPayload = handleCommonFields(htElement, this.hashMethod);
-
-    if (!event) {
-      logger.debug('[Criteo] Event name from track call is missing!!===');
-      return;
-    }
-
-    if (!properties || Object.keys(properties).length === 0) {
-      logger.debug('[Criteo] Either properties object is missing or empty in the track call');
-      return;
-    }
-
-    const eventMapping = getHashFromArrayWithDuplicate(this.eventsToStandard);
-    const trimmedEvent = event.toLowerCase().trim();
-
-    if (!supportedEvents.includes(trimmedEvent) && !eventMapping[trimmedEvent]) {
-      logger.debug(`[Criteo] event ${trimmedEvent} is not supported`);
-      return;
-    }
-    let events = [];
-    if (supportedEvents.includes(trimmedEvent)) {
-      events.push(trimmedEvent);
-    } else {
-      events = eventMapping[trimmedEvent];
-    }
-
-    events.forEach((eventType) => {
-      switch (eventType) {
-        case 'product viewed':
-          handleProductView(htElement.message, finalPayload);
-          break;
-        case 'cart viewed':
-        case 'order completed':
-          handlingEventDuo(htElement.message, finalPayload);
-          break;
-        case 'product list viewed':
-          handleListView(htElement.message, finalPayload, this.OPERATOR_LIST);
-          break;
-        default:
-          break;
-      }
-    });
-
-    const extraDataObject = generateExtraData(htElement, this.fieldMapping);
-    if (Object.keys(extraDataObject).length > 0) {
-      finalPayload.push({ event: 'setData', ...extraDataObject });
-    }
-    window.criteo_q.push(finalPayload);
-  }
-}
-export default Criteo;

package/src/integrations/Criteo/constants.js

@@ -1,11 +0,0 @@
-const NAME = 'CRITEO';
-
-const CNameMapping = {
-  [NAME]: NAME,
-  Criteo: NAME,
-  criteo: NAME,
-};
-
-const supportedEvents = ['product viewed', 'cart viewed', 'order completed', 'product list viewed'];
-
-export { NAME, CNameMapping, supportedEvents };

package/src/integrations/Criteo/index.js

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

package/src/integrations/Criteo/utils.js

@@ -1,343 +0,0 @@
-import md5 from 'md5';
-import { getHashFromArray, isDefinedAndNotNull } from '../../utils/commonUtils';
-import logger from '../../utils/logUtil';
-
-/**
- * Ref : https://help.criteo.com/kb/guide/en/all-criteo-onetag-events-and-parameters-vZbzbEeY86/Steps/775825,868657,868659
- * Ref : https://help.criteo.com/kb/guide/en/all-criteo-onetag-events-and-parameters-vZbzbEeY86/Steps/775825
- * @param {*} htElement
- * @param {*} hashMethod
- * @returns
- */
-const handleCommonFields = (htElement, hashMethod) => {
-  const { message } = htElement;
-  const { properties, userId, anonymousId } = message;
-
-  const setEmail = {};
-  const setZipcode = {};
-
-  const finalRequest = [
-    { event: 'setCustomerId', id: md5(userId).toString() },
-    { event: 'setRetailerVisitorId', id: md5(anonymousId).toString() },
-  ];
-
-  if (properties?.email) {
-    const email = properties.email.trim().toLowerCase();
-    setEmail.event = 'setEmail';
-    setEmail.hash_method = hashMethod;
-    setEmail.email = hashMethod === 'md5' ? md5(email) : email;
-    finalRequest.push(setEmail);
-  }
-
-  if (properties?.zipCode) {
-    setZipcode.event = 'setZipcode';
-    setZipcode.zipCode = properties.zipCode || properties.zip;
-    finalRequest.push(setZipcode);
-  }
-
-  return finalRequest;
-};
-const generateExtraData = (htElement, fieldMapping) => {
-  const { message } = htElement;
-  const extraData = {};
-  const fieldMapHashmap = getHashFromArray(fieldMapping, 'from', 'to', false);
-
-  Object.keys(fieldMapHashmap).forEach((field) => {
-    if (isDefinedAndNotNull(message.properties[field])) {
-      extraData[fieldMapHashmap[field]] = message.properties[field];
-    }
-  });
-  return extraData;
-};
-
-const handleProductView = (message, finalPayload) => {
-  const { properties } = message;
-  if (properties.product_id) {
-    const viewItemObject = {
-      event: 'viewItem',
-      item: String(properties.product_id),
-    };
-
-    if (properties.price && !Number.isNaN(parseFloat(properties.price))) {
-      viewItemObject.price = parseFloat(properties.price);
-    }
-
-    if (
-      properties.availability &&
-      (properties.availability === 1 || properties.availability === 0)
-    ) {
-      viewItemObject.availability = properties.availability;
-    }
-    finalPayload.push(viewItemObject);
-  } else {
-    logger.debug('[Criteo] product_id is a mandatory field to use Product Tag in criteo');
-  }
-
-  // Final example payload supported by destination
-  // window.criteo_q.push(
-  //   { event: "setAccount", account: YOUR_PARTNER_ID},
-  //   {
-  //     event: "setEmail",
-  //     email: "##Email Address##",
-  //     hash_method: "##Hash Method##",
-  //   },
-  //   { event: "setSiteType", type: deviceType},
-  //   { event: "setCustomerId", id: "##Customer Id##" },
-  //   { event: "setRetailerVisitorId", id: "##Visitor Id##"},
-  //   { event: "setZipcode", zipcode: "##Zip Code##" },
-  //   {
-  //     event: "viewItem",
-  //     item: "##Product ID##",
-  //     price: "##price##",
-  //     availability: "##Availability##",
-  //   }
-  // );
-};
-
-/**
- * Validates product properties
- * @param {*} product
- * @param {*} index
- * @returns
- */
-const validateProduct = (product, index) => {
-  if (product.product_id && product.price && product.quantity) {
-    const elementaryProduct = {
-      id: String(product.product_id),
-      price: parseFloat(product.price),
-      quantity: parseInt(product.quantity, 10),
-    };
-    return !Number.isNaN(elementaryProduct.price) && !Number.isNaN(elementaryProduct.quantity);
-  }
-  logger.debug(`[Criteo] product at index ${index} is skipped for insufficient information`);
-  return false;
-};
-
-/**
- * Returns transformed products array
- * @param {*} properties
- * @returns
- */
-const getProductInfo = (properties) => {
-  const productInfo = [];
-
-  if (properties?.products && properties.products.length > 0) {
-    properties.products.forEach((product, index) => {
-      if (validateProduct(product, index)) {
-        productInfo.push({
-          id: String(product.product_id),
-          price: parseFloat(product.price),
-          quantity: parseInt(product.quantity, 10),
-        });
-      }
-    });
-  } else {
-    logger.debug('[Criteo] Payload should consist of at least one product information');
-  }
-
-  return productInfo;
-};
-
-/**
- * Adds order completed event to finalPayload
- * @param {*} properties
- * @param {*} finalPayload
- * @param {*} productInfo
- * @returns
- */
-const processCompletedOrderEvent = (properties, finalPayload, productInfo) => {
-  const trackTransactionObject = {
-    event: 'trackTransaction',
-    id: String(properties.order_id),
-    item: productInfo,
-  };
-
-  if (!trackTransactionObject.id) {
-    logger.debug('[Criteo] order_id (Transaction Id) is a mandatory field');
-    return;
-  }
-
-  if (properties.new_customer === 1 || properties.new_customer === 0) {
-    trackTransactionObject.new_customer = properties.new_customer;
-  }
-
-  if (properties.deduplication === 1 || properties.deduplication === 0) {
-    trackTransactionObject.deduplication = properties.deduplication;
-  }
-
-  finalPayload.push(trackTransactionObject);
-};
-
-/**
- * Adds view cart event to finalPayload
- * @param {*} properties
- * @param {*} finalPayload
- * @param {*} productInfo
- */
-const processViewedCartEvent = (finalPayload, productInfo) => {
-  const viewBasketObject = {
-    event: 'viewBasket',
-    item: productInfo,
-  };
-  finalPayload.push(viewBasketObject);
-};
-
-/**
- * Handles events
- * @param {*} message
- * @param {*} finalPayload
- * @returns
- */
-const handlingEventDuo = (message, finalPayload) => {
-  const { event, properties } = message;
-  const eventType = event.toLowerCase().trim();
-  const productInfo = getProductInfo(properties);
-
-  if (productInfo.length === 0) {
-    logger.debug(
-      '[Criteo] None of the products had sufficient information or information is wrongly formatted',
-    );
-    return;
-  }
-
-  if (eventType === 'cart viewed') {
-    processViewedCartEvent(finalPayload, productInfo);
-    // final example payload supported by the destination
-    // window.criteo_q.push(
-    //   { event: "setAccount", account: YOUR_PARTNER_ID},
-    //   {
-    //     event: "setEmail",
-    //     email: "##Email Address##",
-    //     hash_method: "##Hash Method##",
-    //   },
-    //   { event: "setSiteType", type: deviceType},
-    //   { event: "setCustomerId", id: "##Customer Id##" },
-    //   { event: "setRetailerVisitorId", id: "##Visitor Id##"},
-    //   { event: "setZipcode", zipcode: "##Zip Code##" },
-    //   {
-    //     event: "viewBasket",
-    //     item: [
-    //       {
-    //         id: "##Product Id##",
-    //         price: "##Price##",
-    //         quantity: "##Quantity##",
-    //       },
-    //       // add a line for each additional line in the basket
-    //     ],
-    //   }
-    // );
-  }
-
-  if (eventType === 'order completed') {
-    processCompletedOrderEvent(properties, finalPayload, productInfo);
-    // final example payload supported by destination
-    //   window.criteo_q.push(
-    //     { event: "setAccount", account: YOUR_PARTNER_ID},
-    //     { event: "setEmail", email: "##Email Address##", hash_method: "##Hash Method##" },
-    //     { event: "setSiteType", type: deviceType},
-    //     { event: "setCustomerId", id: "##Customer Id##" },
-    //     { event: "setRetailerVisitorId", id: "##Visitor Id##"},
-    //     { event: "setZipcode", zipcode: "##Zip Code##" },
-    //     { event: "trackTransaction",
-    //       id: "##Transaction ID##",
-    //       new_customer: ##New Customer##,
-    //       deduplication: ##Deduplication##,
-    //       item: [
-    //        {id: "##Product Id##", price: "##Price##", quantity: "##Quantity##" }
-    //        //add a line for each additional line in the basket
-    //      ]}
-    //   );
-
-    // }
-  }
-};
-
-/**
- * Returns filterArray
- * @param {*} properties
- * @param {*} OPERATOR_LIST
- * @returns
- */
-const getFilterArray = (properties, OPERATOR_LIST) => {
-  const filterArray = [];
-  const FILTER_FIELDS = ['name', 'value'];
-  if (properties.filters) {
-    properties.filters.forEach((filter) => {
-      const filterObject = {};
-      Object.keys(filter).forEach((key) => {
-        if (
-          FILTER_FIELDS.includes(key) ||
-          (key === 'operator' && OPERATOR_LIST.includes(filter.operator))
-        ) {
-          filterObject[key] = filter[key];
-        }
-      });
-      filterArray.push(filterObject);
-    });
-  }
-
-  return filterArray;
-};
-
-const handleListView = (message, finalPayload, OPERATOR_LIST) => {
-  const { properties } = message;
-  const productIdList = [];
-  const viewListObj = {};
-
-  if (properties.products && properties.products.length > 0) {
-    properties.products.forEach((product) => {
-      if (product.product_id) {
-        productIdList.push(String(product.product_id));
-      }
-    });
-    if (productIdList.length === 0) {
-      logger.debug('[Criteo] None of the product information had product_id');
-      return;
-    }
-  } else {
-    logger.debug('[Criteo] The payload should consist of atleast one product information');
-    return;
-  }
-
-  viewListObj.event = 'viewList';
-  viewListObj.item = productIdList;
-  viewListObj.category = String(properties.category);
-  viewListObj.keywords = String(properties.keywords);
-  if (properties.page_number && !Number.isNaN(parseInt(properties.page_number, 10))) {
-    viewListObj.page_number = parseInt(properties.page_number, 10);
-  }
-
-  const filterArray = getFilterArray(properties, OPERATOR_LIST);
-  if (filterArray.length > 0) {
-    viewListObj.filters = filterArray;
-  }
-  finalPayload.push(viewListObj);
-};
-
-/**
- * Returns device type
- * @param {*} userAgent
- * @returns
- */
-const getDeviceType = (userAgent) => {
-  let deviceType;
-
-  if (/iPad/.test(userAgent)) {
-    deviceType = 't';
-  } else if (/Mobile|iP(hone|od)|Android|BlackBerry|IEMobile|Silk/.test(userAgent)) {
-    deviceType = 'm';
-  } else {
-    deviceType = 'd';
-  }
-
-  return deviceType;
-};
-
-export {
-  getDeviceType,
-  handleListView,
-  handlingEventDuo,
-  handleProductView,
-  generateExtraData,
-  handleCommonFields,
-};

package/src/integrations/CustomerIO/browser.js

@@ -1,74 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-/* eslint-disable class-methods-use-this */
-import logger from '../../utils/logUtil';
-import { NAME } from './constants';
-import { loadNativeSdk } from './nativeSdkLoader';
-
-class CustomerIO {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.analytics = analytics;
-    this.siteID = config.siteID;
-    this.apiKey = config.apiKey;
-    this.datacenterEU = config.datacenterEU;
-    this.sendPageNameInSDK = config.sendPageNameInSDK;
-    this.name = NAME;
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-  }
-
-  init() {
-    logger.debug('===in init Customer IO init===');
-    const { siteID, datacenterEU } = this;
-    loadNativeSdk(siteID, datacenterEU);
-  }
-
-  identify(htElement) {
-    logger.debug('in Customer IO identify');
-    const { userId, context } = htElement.message;
-    const { traits } = context || {};
-    if (!userId) {
-      logger.error('userId is required for Identify call.');
-      return;
-    }
-    const createAt = traits.createdAt;
-    if (createAt) {
-      traits.created_at = Math.floor(new Date(createAt).getTime() / 1000);
-    }
-    traits.id = userId;
-    window._cio.identify(traits);
-  }
-
-  track(htElement) {
-    logger.debug('in Customer IO track');
-
-    const eventName = htElement.message.event;
-    const { properties } = htElement.message;
-    window._cio.track(eventName, properties);
-  }
-
-  page(htElement) {
-    logger.debug('in Customer IO page');
-    if (this.sendPageNameInSDK === false) {
-      window._cio.page(htElement.message.properties);
-    } else {
-      const name = htElement.message.name || htElement.message.properties.url;
-      window._cio.page(name, htElement.message.properties);
-    }
-  }
-
-  isLoaded() {
-    return !!(window._cio && window._cio.push !== Array.prototype.push);
-  }
-
-  isReady() {
-    return !!(window._cio && window._cio.push !== Array.prototype.push);
-  }
-}
-
-export { CustomerIO };

package/src/integrations/CustomerIO/constants.js

@@ -1,10 +0,0 @@
-const NAME = 'CUSTOMERIO';
-const CNameMapping = {
-  [NAME]: NAME,
-  Customerio: NAME,
-  'Customer.io': NAME,
-  'CUSTOMER.IO': NAME,
-  'customer.io': NAME,
-};
-
-export { NAME, CNameMapping };