castled-js-sdk 0.0.1 → 0.0.3

package/src/integrations/Podsights/browser.js

@@ -0,0 +1,178 @@
+/* eslint-disable prefer-rest-params */
+/* eslint-disable func-names */
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable class-methods-use-this */
+import get from 'get-value';
+import sha256 from 'crypto-js/sha256';
+import {
+  ADD_TO_CART_EVENT,
+  CHECK_OUT_EVENT,
+  LEAD_EVENT,
+  NAME,
+  PRODUCT_EVENT,
+  PURCHASE_EVENT,
+  standardEventsListMapping,
+} from './constants';
+import ScriptLoader from '../../utils/ScriptLoader';
+import logger from '../../utils/logUtil';
+import {
+  getHashFromArrayWithDuplicate,
+  removeUndefinedAndNullValues,
+} from '../../utils/commonUtils';
+import { constructPayload } from '../../utils/utils';
+import { payloadBuilder, payloadBuilderInList } from './utils';
+
+class Podsights {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.pixelId = config.pixelId;
+    this.eventsToPodsightsEvents = config.eventsToPodsightsEvents;
+    this.enableAliasCall = config.enableAliasCall;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===In init Podsights===');
+    window.pdst =
+      window.pdst ||
+      function () {
+        (window.pdst.q = window.pdst.q || []).push(arguments);
+      };
+    ScriptLoader('pdst-capture', 'https://cdn.pdst.fm/ping.min.js');
+    window.pdst('conf', { key: `${this.pixelId}` });
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded Podsights===');
+    return !!(window.pdst && typeof window.pdst === 'function');
+  }
+
+  isReady() {
+    logger.debug('===In isReady Podsights===');
+    return !!(window.pdst && typeof window.pdst === 'function');
+  }
+
+  loadAliasEvent(externalId) {
+    if (this.enableAliasCall && externalId) {
+      window.pdst('alias', {
+        id: sha256(externalId).toString(),
+      });
+    }
+  }
+
+  /**
+   * ref: https://podsights.com/docs#conversion-event-pixel-scripts
+   * Track - tracks an event for an user
+   * @param {Track} track
+   */
+  track(htElement) {
+    logger.debug('===In Podsights Track===');
+    const { message } = htElement;
+    const { event, properties } = message;
+    if (!event) {
+      logger.error('[Podsights]: event name from track call is missing.');
+      return;
+    }
+
+    const eventsMappingFromCustomEvents = getHashFromArrayWithDuplicate(
+      this.eventsToPodsightsEvents,
+      'from',
+      'to',
+      false,
+    );
+    const eventMappingFromStandardEvents = getHashFromArrayWithDuplicate(
+      standardEventsListMapping,
+      'from',
+      'to',
+      false,
+    );
+    const trimmedEvent = event.trim();
+    let events = [];
+    const customEvent = eventsMappingFromCustomEvents[trimmedEvent] || [];
+    const standardEvents = eventMappingFromStandardEvents[trimmedEvent] || [];
+    if (customEvent.length > 0) {
+      events = customEvent;
+    } else if (standardEvents.length > 0) {
+      events = standardEvents;
+    } else {
+      logger.error(`===No Podsights Pixel mapped event found. Aborting!===`);
+      return;
+    }
+    const externalId =
+      get(message, 'userId') ||
+      get(message, 'context.traits.userId') ||
+      get(message, 'context.traits.id');
+    let payload;
+    events.forEach((podsightEvent) => {
+      switch (podsightEvent.trim().toLowerCase()) {
+        case 'lead':
+          payload = constructPayload(properties, LEAD_EVENT);
+          window.pdst(podsightEvent, payload);
+          this.loadAliasEvent(externalId);
+          break;
+        case 'purchase': {
+          payload = payloadBuilder(properties, PURCHASE_EVENT);
+          window.pdst(podsightEvent, payload);
+          this.loadAliasEvent(externalId);
+          break;
+        }
+        case 'product': {
+          const payloadList = payloadBuilderInList(properties, PRODUCT_EVENT);
+          payloadList.forEach((payloadItem) => {
+            window.pdst(podsightEvent, payloadItem);
+            this.loadAliasEvent(externalId);
+          });
+          break;
+        }
+        case 'addtocart': {
+          const payloadList = payloadBuilderInList(properties, ADD_TO_CART_EVENT);
+          payloadList.forEach((payloadItem) => {
+            window.pdst(podsightEvent, payloadItem);
+            this.loadAliasEvent(externalId);
+          });
+          break;
+        }
+        case 'checkout': {
+          payload = payloadBuilder(properties, CHECK_OUT_EVENT);
+          window.pdst(podsightEvent, payload);
+          this.loadAliasEvent(externalId);
+          break;
+        }
+        default:
+          logger.error(`event name ${podsightEvent} not supported. Aborting!===`);
+          break;
+      }
+    });
+  }
+
+  /**
+   * Page.
+   * for supporting path of Page
+   * @param {Page} page
+   */
+  page(htElement) {
+    const { properties, context } = htElement.message;
+    logger.debug('===In Podsights Page===');
+    const { page } = context;
+    let payload = properties;
+    if (page) {
+      payload = {
+        url: page.url,
+        referrer: page.referrer,
+        ...payload,
+      };
+    }
+    payload = removeUndefinedAndNullValues(payload);
+    window.pdst('view', payload);
+  }
+}
+
+export default Podsights;

package/src/integrations/Podsights/constants.js

@@ -0,0 +1,206 @@
+const NAME = 'PODSIGHTS';
+const CNameMapping = {
+  [NAME]: NAME,
+  Podsights: NAME,
+  PodSights: NAME,
+  'pod Sights': NAME,
+  'Pod Sights': NAME,
+  'pod sights': NAME,
+  'POD SIGHTS': NAME,
+  'Pod sights': NAME,
+};
+
+// default mapping for the events
+const standardEventsListMapping = [
+  { to: 'lead', from: 'Signed Up' },
+  { to: 'product', from: 'Product Viewed' },
+  { to: 'addtocart', from: 'Product Added' },
+  { to: 'checkout', from: 'Checkout Started' },
+  { to: 'purchase', from: 'Order Completed' },
+];
+
+const LEAD_EVENT = [
+  {
+    destKey: 'value',
+    sourceKeys: 'value',
+  },
+  {
+    destKey: 'currency',
+    sourceKeys: 'currency',
+  },
+  {
+    destKey: 'type',
+    sourceKeys: 'type',
+  },
+  {
+    destKey: 'category',
+    sourceKeys: 'category',
+  },
+];
+
+const PRODUCT_EVENT = [
+  {
+    destKey: 'value',
+    sourceKeys: 'value',
+  },
+  {
+    destKey: 'currency',
+    sourceKeys: 'currency',
+  },
+  {
+    destKey: 'product_id',
+    sourceKeys: 'productId',
+  },
+  {
+    destKey: 'product_name',
+    sourceKeys: 'productName',
+  },
+  {
+    destKey: 'product_type',
+    sourceKeys: 'productType',
+  },
+  {
+    destKey: 'product_vendor',
+    sourceKeys: 'productVendor',
+  },
+];
+
+const ADD_TO_CART_EVENT = [
+  {
+    destKey: 'value',
+    sourceKeys: 'value',
+  },
+  {
+    destKey: 'currency',
+    sourceKeys: 'currency',
+  },
+  {
+    destKey: 'product_id',
+    sourceKeys: 'productId',
+  },
+  {
+    destKey: 'product_name',
+    sourceKeys: 'productName',
+  },
+  {
+    destKey: 'product_type',
+    sourceKeys: 'productType',
+  },
+  {
+    destKey: 'product_vendor',
+    sourceKeys: 'productVendor',
+  },
+  {
+    destKey: 'quantity',
+    sourceKeys: 'quantity',
+  },
+  {
+    destKey: 'variant_id',
+    sourceKeys: 'variantId',
+  },
+  {
+    destKey: 'variant_name',
+    sourceKeys: 'variantName',
+  },
+];
+
+const CHECK_OUT_EVENT = [
+  {
+    destKey: 'value',
+    sourceKeys: 'value',
+  },
+  {
+    destKey: 'currency',
+    sourceKeys: 'currency',
+  },
+  {
+    destKey: 'discount_code',
+    sourceKeys: 'discountCode',
+  },
+  {
+    destKey: 'quantity',
+    sourceKeys: 'quantity',
+  },
+  {
+    destKey: 'line_items',
+    sourceKeys: 'lineItems',
+  },
+];
+
+const PURCHASE_EVENT = [
+  {
+    destKey: 'value',
+    sourceKeys: 'value',
+  },
+  {
+    destKey: 'currency',
+    sourceKeys: 'currency',
+  },
+  {
+    destKey: 'discount_code',
+    sourceKeys: 'discountCode',
+  },
+  {
+    destKey: 'line_items',
+    sourceKeys: 'lineItems',
+  },
+  {
+    destKey: 'order_id',
+    sourceKeys: 'orderId',
+  },
+  {
+    destKey: 'is_new_customer',
+    sourceKeys: 'isNewCustomer',
+  },
+  {
+    destKey: 'quantity',
+    sourceKeys: 'quantity',
+  },
+];
+
+const LINE_ITEMS_CONFIG = [
+  {
+    destKey: 'product_id',
+    sourceKeys: 'productId',
+  },
+  {
+    destKey: 'product_name',
+    sourceKeys: 'productName',
+  },
+  {
+    destKey: 'product_type',
+    sourceKeys: 'productType',
+  },
+  {
+    destKey: 'product_vendor',
+    sourceKeys: 'productVendor',
+  },
+  {
+    destKey: 'variant_id',
+    sourceKeys: 'variantId',
+  },
+  {
+    destKey: 'variant_name',
+    sourceKeys: 'variantName',
+  },
+  {
+    destKey: 'value',
+    sourceKeys: 'value',
+  },
+  {
+    destKey: 'quantity',
+    sourceKeys: 'quantity',
+  },
+];
+
+export {
+  NAME,
+  CNameMapping,
+  standardEventsListMapping,
+  LEAD_EVENT,
+  PRODUCT_EVENT,
+  ADD_TO_CART_EVENT,
+  CHECK_OUT_EVENT,
+  PURCHASE_EVENT,
+  LINE_ITEMS_CONFIG,
+};

package/src/integrations/Podsights/index.js

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

package/src/integrations/Podsights/utils.js

@@ -0,0 +1,65 @@
+import { LINE_ITEMS_CONFIG } from './constants';
+import { constructPayload } from '../../utils/utils';
+import { removeUndefinedAndNullValues } from '../../utils/commonUtils';
+
+/**
+ * This function is used to build payload with line_items, it will search from
+ * properties.products if it's an array, then it will mapped the required fields
+ * and insert in line_items.
+ * @param {*} properties
+ * @param {*} CONFIG_EVENT
+ * return payload
+ */
+const payloadBuilder = (properties, CONFIG_EVENT) => {
+  const payload = constructPayload(properties, CONFIG_EVENT);
+  // if line_items is present in message.properties
+  if (payload.line_items) {
+    return payload;
+  }
+
+  const lineItems = [];
+  // mapping the line_items_payload from message.properties
+  const lineItemsPayload = constructPayload(properties, LINE_ITEMS_CONFIG);
+  // if products is an array of objects, then we'll build each line_items payload from products.
+  const productList = properties?.products;
+  if (productList && Array.isArray(productList)) {
+    productList.forEach((product) => {
+      const productDetails = constructPayload(product, LINE_ITEMS_CONFIG);
+      lineItems.push({
+        ...lineItemsPayload,
+        ...removeUndefinedAndNullValues(productDetails),
+      });
+    });
+  } else {
+    lineItems.push(lineItemsPayload);
+  }
+  return { ...payload, line_items: lineItems };
+};
+
+/**
+ * This function is used to build payload in an array.
+ * If properties.products is an array then it will take necessary fields
+ * and build payload and returns it with an array.
+ * @param {*} properties
+ * @param {*} CONFIG_EVENT
+ * return payloadList
+ */
+const payloadBuilderInList = (properties, CONFIG_EVENT) => {
+  const payloadList = [];
+  const productList = properties?.products;
+  const productPayload = constructPayload(properties, CONFIG_EVENT);
+  if (productList && Array.isArray(productList)) {
+    productList.forEach((product) => {
+      const productDetails = constructPayload(product, CONFIG_EVENT);
+      payloadList.push({
+        ...productPayload,
+        ...removeUndefinedAndNullValues(productDetails),
+      });
+    });
+  } else {
+    payloadList.push(productPayload);
+  }
+  return payloadList;
+};
+
+export { payloadBuilder, payloadBuilderInList };

package/src/integrations/PostAffiliatePro/browser.js

@@ -0,0 +1,133 @@
+/* eslint-disable class-methods-use-this */
+/* eslint-disable no-underscore-dangle */
+import get from 'get-value';
+import { updateSaleObject, getMergedProductIds } from './utils';
+import ScriptLoader from '../../utils/ScriptLoader';
+import logger from '../../utils/logUtil';
+import { NAME } from './constants';
+
+class PostAffiliatePro {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.name = NAME;
+    this.url = config.url;
+    this.mergeProducts = config.mergeProducts;
+    this.accountId = config.accountId;
+    this.affLinkId = config.affLinkId;
+    this.idName = config.idName;
+    this.cookieLinkId = config.cookieLinkId;
+    this.cookieName = config.cookieName;
+    this.affiliateToCustomField = config.affiliateToCustomField;
+    this.campaignToCustomField = config.campaignToCustomField;
+    this.cookieDomain = config.cookieDomain;
+    this.cookieToCustomField = config.cookieToCustomField;
+    this.disableTrackingMethod = config.disableTrackingMethod;
+    this.paramNameUserId = config.paramNameUserId;
+    this.clickEvents = config.clickEvents;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    logger.debug('===in init Post Affiliate Pro===');
+    if (!this.url) {
+      logger.debug('URL is missing');
+      return;
+    }
+    ScriptLoader('pap_x2s6df8d', this.url);
+  }
+
+  isLoaded() {
+    logger.debug('===In isLoaded Post Affiliate Pro===');
+    return !!window.PostAffTracker;
+  }
+
+  isReady() {
+    logger.debug('===In isReady Post Affiliate Pro===');
+
+    if (window.PostAffTracker) {
+      if (!this.disableTrackingMethod) window.PostAffTracker.disableTrackingMethod('F');
+      if (this.paramNameUserId) window.PostAffTracker.setParamNameUserId(this.paramNameUserId);
+      if (this.accountId) window.PostAffTracker.setAccountId(this.accountId);
+      if (this.cookieDomain) window.PostAffTracker.setCookieDomain(this.cookieDomain);
+      if (this.cookieToCustomField)
+        window.PostAffTracker.writeCookieToCustomField(this.cookieToCustomField);
+      if (this.affiliateToCustomField)
+        window.PostAffTracker.writeAffiliateToCustomField(this.affiliateToCustomField);
+      if (this.campaignToCustomField)
+        window.PostAffTracker.writeCampaignToCustomField(this.campaignToCustomField);
+      if (this.affLinkId && this.idName)
+        window.PostAffTracker.writeAffiliateToLink(this.affLinkId, this.idName);
+      if (this.cookieName && this.cookieLinkId)
+        window.PostAffTracker.writeCookieToLink(this.cookieLinkId, this.cookieName);
+      return true;
+    }
+    return false;
+  }
+
+  identify(htElement) {
+    logger.debug('===In Post Affiliate Pro identify===');
+    const { message } = htElement;
+    const visitorId = get(message, 'userId');
+    window.PostAffTracker.setVisitorId(visitorId);
+  }
+
+  track(htElement) {
+    logger.debug('===In Post Affiliate Pro track===');
+    const clickEventsArr = this.clickEvents ? this.clickEvents.split(',') : null;
+    const { message } = htElement;
+    const { event } = message;
+    const { properties } = message;
+
+    // We are going to call click event, for the event list given in dashboard only.
+    if (clickEventsArr?.includes(event)) {
+      if (properties) {
+        const rudderToWindowPropertiesMap = [
+          { property: 'data1', windowProperty: 'Data1' },
+          { property: 'data2', windowProperty: 'Data2' },
+          { property: 'affiliateId', windowProperty: 'AffiliateID' },
+          { property: 'bannerId', windowProperty: 'BannerID' },
+          { property: 'campaignId', windowProperty: 'CampaignID' },
+          { property: 'channel', windowProperty: 'Channel' },
+        ];
+
+        rudderToWindowPropertiesMap.forEach(({ property, windowProperty }) => {
+          if (Object.prototype.hasOwnProperty.call(properties, property)) {
+            window[windowProperty] = properties[property];
+          }
+        });
+      }
+      window.PostAffTracker.track();
+    }
+
+    // We are supporting only one event for sale.
+    if (event === 'Order Completed') {
+      const productsArr = properties?.products || null;
+      if (productsArr && this.mergeProducts) {
+        window.sale = window.PostAffTracker.createSale();
+        if (window.sale) updateSaleObject(window.sale, properties);
+        const merged = getMergedProductIds(productsArr);
+        window.sale.setProductID(merged);
+      } else if (productsArr) {
+        productsArr.forEach((product, index) => {
+          window[`sale${index}`] = window.PostAffTracker.createSale();
+          updateSaleObject(window[`sale${index}`], properties);
+          if (product.product_id) {
+            window[`sale${index}`].setProductID(product.product_id);
+          }
+        });
+      } else {
+        // If any product is not available
+        window.sale = window.PostAffTracker.createSale();
+      }
+      window.PostAffTracker.register();
+    }
+  }
+}
+export default PostAffiliatePro;

package/src/integrations/PostAffiliatePro/constants.js

@@ -0,0 +1,13 @@
+const NAME = 'POST_AFFILIATE_PRO';
+const CNameMapping = {
+  [NAME]: NAME,
+  PostAffiliatePro: NAME,
+  Post_affiliate_pro: NAME,
+  'Post Affiliate Pro': NAME,
+  'Post affiliate pro': NAME,
+  'post affiliate pro': NAME,
+  postaffiliatepro: NAME,
+  POSTAFFILIATEPRO: NAME,
+};
+
+export { NAME, CNameMapping };

package/src/integrations/PostAffiliatePro/index.js

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

package/src/integrations/PostAffiliatePro/utils.js

@@ -0,0 +1,40 @@
+// This function helps to populate the sale object
+const updateSaleObject = (sale, properties) => {
+  const saleMethodsMap = [
+    { property: 'total', method: 'setTotalCost' },
+    { property: 'fixedCost', method: 'setFixedCost' },
+    { property: 'order_id', method: 'setOrderID' },
+    { property: 'data1', method: 'setData1' },
+    { property: 'data2', method: 'setData2' },
+    { property: 'data3', method: 'setData3' },
+    { property: 'data4', method: 'setData4' },
+    { property: 'data5', method: 'setData5' },
+    { property: 'doNotDeleteCookies', method: 'doNotDeleteCookies' },
+    { property: 'status', method: 'setStatus' },
+    { property: 'currency', method: 'setCurrency' },
+    { property: 'customCommission', method: 'setCustomCommission' },
+    { property: 'channel', method: 'setChannelID' },
+    { property: 'coupon', method: 'setCoupon' },
+    { property: 'campaignId', method: 'setCampaignID' },
+    { property: 'affiliateId', method: 'setAffiliateID' },
+  ];
+
+  saleMethodsMap.forEach(({ property, method }) => {
+    if (Object.prototype.hasOwnProperty.call(properties, property)) {
+      if (method === 'doNotDeleteCookies') {
+        sale[method]();
+      } else {
+        sale[method](properties[property]);
+      }
+    }
+  });
+};
+
+const getMergedProductIds = (productsArr) => {
+  const mergedProductId = productsArr
+    .filter((product) => product.product_id)
+    .map((product) => product.product_id)
+    .join();
+  return mergedProductId;
+};
+export { updateSaleObject, getMergedProductIds };