castled-js-sdk 0.0.3 → 0.0.4

package/src/integrations/PinterestTag/browser.js

@@ -1,241 +0,0 @@
-/* eslint-disable class-methods-use-this */
-import get from 'get-value';
-import sha256 from 'crypto-js/sha256';
-import logger from '../../utils/logUtil';
-import {
-  propertyMapping,
-  searchPropertyMapping,
-  productPropertyMapping,
-  pinterestPropertySupport,
-} from './propertyMappingConfig';
-import {
-  getDefinedTraits,
-  getDataFromSource,
-  flattenJsonPayload,
-  isDefinedAndNotNull,
-} from '../../utils/utils';
-import { NAME } from './constants';
-import { getDestinationEventName } from './utils';
-import { loadNativeSdk } from './nativeSdkLoader';
-
-export default class PinterestTag {
-  constructor(config, analytics, destinationInfo) {
-    if (analytics.logLevel) {
-      logger.setLogLevel(analytics.logLevel);
-    }
-    this.analytics = analytics;
-    this.tagId = !config.tagId ? '' : config.tagId;
-    this.enhancedMatch = config.enhancedMatch || false;
-    this.customProperties = config.customProperties || [];
-    this.userDefinedEventsMapping = config.eventsMapping || [];
-    this.name = NAME;
-    this.deduplicationKey = config.deduplicationKey;
-    ({
-      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
-      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
-      destinationId: this.destinationId,
-    } = destinationInfo ?? {});
-    this.sendAsCustomEvent = config.sendAsCustomEvent || false;
-  }
-
-  loadScript() {
-    loadNativeSdk();
-  }
-
-  handleEnhancedMatch() {
-    const userTraits = this.analytics.getUserTraits();
-    const { email } = userTraits;
-    if (email && this.enhancedMatch) {
-      window.pintrk('load', this.tagId, {
-        em: email,
-      });
-    } else {
-      window.pintrk('load', this.tagId);
-    }
-    window.pintrk('page');
-  }
-
-  init() {
-    logger.debug('===in init Pinterest Tag===');
-    this.loadScript();
-    this.handleEnhancedMatch();
-  }
-
-  /* utility functions ---Start here ---  */
-  isLoaded() {
-    logger.debug('===in isLoaded Pinterest Tag===');
-
-    return !!(window.pintrk && window.pintrk.push !== Array.prototype.push);
-  }
-
-  // ref :- https://developers.pinterest.com/docs/conversions/conversion-management/#Understanding%20Limited%20Data%20Processing#%0A%2CCPRA%20Related%20Data%20Fields:~:text=using%20SHA%2D256.-,%3C,%3E,-To%20specifically%20not
-  generateLdpObject(message) {
-    if (!message) {
-      const { userTraits } = this.analytics;
-      const optOutType = userTraits?.optOutType || '';
-      const state =
-        userTraits?.state ||
-        userTraits?.State ||
-        userTraits?.address?.state ||
-        userTraits?.address?.State ||
-        '';
-      const country =
-        userTraits?.country ||
-        userTraits?.Country ||
-        userTraits?.address?.country ||
-        userTraits?.address?.Country ||
-        '';
-      return {
-        opt_out_type: optOutType,
-        st: optOutType ? sha256(state).toString() : '',
-        country: optOutType ? sha256(country).toString() : '',
-      };
-    }
-
-    const optOutType = message.context.traits?.optOutType || message.properties?.optOutType || '';
-    const { state, country } = getDefinedTraits(message);
-    return {
-      opt_out_type: optOutType,
-      st: optOutType ? sha256(state || '').toString() : '',
-      country: optOutType ? sha256(country || '').toString() : '',
-    };
-  }
-
-  setLdp(message) {
-    window.pintrk('set', this.generateLdpObject(message));
-  }
-
-  isReady() {
-    logger.debug('===in isReady Pinterest Tag===');
-
-    return !!(window.pintrk && window.pintrk.push !== Array.prototype.push);
-  }
-  /* utility functions --- Ends here ---  */
-
-  sendPinterestTrack(eventName, pinterestObject) {
-    window.pintrk('track', eventName, pinterestObject);
-  }
-
-  /**
-   * Send rudder property and mappings array. This function will return data mapping destination property
-   * @param {*} properties
-   * @param {*} mappings
-   * @returns Pinterest Products
-   */
-  getMappingObject(properties, mappings, isPersist = false) {
-    let pinterestObject = {};
-    mappings.forEach((mapping) => {
-      pinterestObject = {
-        ...getDataFromSource(mapping.src, mapping.dest, properties),
-        ...pinterestObject,
-      };
-    });
-    if (isPersist) {
-      return {
-        ...pinterestObject,
-        ...properties,
-      };
-    }
-    return pinterestObject;
-  }
-
-  /**
-   * This function  simply copies data from rudder payload to new object provided all
-   * the key in properties is present in pinterestPropertySupport
-   * @param {rudder properties} properties
-   * @returns
-   */
-  getRawPayload(properties) {
-    const data = {};
-    const mappedProps = this.getMappingObject(properties, propertyMapping, true);
-    Object.keys(mappedProps).forEach((p) => {
-      if (pinterestPropertySupport.includes(p)) {
-        data[p] = mappedProps[p];
-      }
-    });
-    // This logic maps rudder query to search_query for Products Searched events
-    if (isDefinedAndNotNull(properties[searchPropertyMapping.src])) {
-      data[searchPropertyMapping.dest] = properties[searchPropertyMapping.src];
-    }
-    return data;
-  }
-
-  /**
-   * This function will generate required pinterest object to be sent.
-   * getRawPayload() will generate all the destination property excepts lineItems.
-   * If rudder payload has products array then line_items is generated
-   * If it does not have product array, it will move the whole message.properties into line items. ex: Product Added
-   *
-   * @param {rudder payload} properties
-   * @returns
-   */
-  generatePinterestObject(properties) {
-    const pinterestObject = this.getRawPayload(properties);
-
-    let { products } = properties;
-    if (!products) {
-      products = [properties];
-    }
-    if (products) {
-      const lineItems = [];
-      products.forEach((p) => {
-        const product = this.getMappingObject(p, productPropertyMapping);
-        lineItems.push(product);
-      });
-      pinterestObject.line_items = lineItems;
-    }
-
-    if (this.customProperties.length > 0 && Object.keys(properties).length > 0) {
-      const flattenPayload = flattenJsonPayload(properties);
-
-      this.customProperties.forEach((custom) => {
-        // This check fails if user is sending boolean value as false
-        // Adding toString because if the property value is boolean then it never gets reflected in destination
-        if (isDefinedAndNotNull(flattenPayload[custom.properties])) {
-          pinterestObject[custom.properties] = flattenPayload[custom.properties].toString();
-        }
-      });
-    }
-    return pinterestObject;
-  }
-
-  track(htElement) {
-    const { message } = htElement;
-    if (!message?.event) {
-      return;
-    }
-    const { properties, event, messageId } = message;
-    const destEventArray = getDestinationEventName(
-      event,
-      this.userDefinedEventsMapping,
-      this.sendAsCustomEvent,
-    );
-    destEventArray.forEach((eventName) => {
-      const pinterestObject = this.generatePinterestObject(properties);
-      pinterestObject.event_id = get(message, `${this.deduplicationKey}`) || messageId;
-      this.setLdp(message);
-      this.sendPinterestTrack(eventName, pinterestObject);
-    });
-  }
-
-  page(htElement) {
-    const { category, name } = htElement.message;
-    const pageObject = { name: name || '' };
-    let event = 'PageVisit';
-    if (category) {
-      pageObject.category = category;
-      event = 'ViewCategory';
-    }
-    this.setLdp(htElement.message);
-    window.pintrk('track', event, pageObject);
-  }
-
-  identify() {
-    const userTraits = this.analytics.getUserTraits();
-    const { email } = userTraits;
-    if (email) {
-      const ldpObject = this.generateLdpObject();
-      window.pintrk('set', { em: email, ...ldpObject });
-    }
-  }
-}

package/src/integrations/PinterestTag/constants.js

@@ -1,19 +0,0 @@
-const NAME = 'PINTEREST_TAG';
-const CNameMapping = {
-  [NAME]: NAME,
-  PinterestTag: NAME,
-  Pinterest_Tag: NAME,
-  PINTERESTTAG: NAME,
-  pinterest: NAME,
-  PinterestAds: NAME,
-  Pinterest_Ads: NAME,
-  Pinterest: NAME,
-  'Pinterest Tag': NAME,
-  'Pinterest tag': NAME,
-  'PINTEREST TAG': NAME,
-  'pinterest tag': NAME,
-  'Pinterest Ads': NAME,
-  'Pinterest ads': NAME,
-};
-
-export { NAME, CNameMapping };

package/src/integrations/PinterestTag/index.js

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

package/src/integrations/PinterestTag/nativeSdkLoader.js

@@ -1,19 +0,0 @@
-import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
-
-function loadNativeSdk(e) {
-  !(function (e) {
-    if (!window.pintrk) {
-      window.pintrk = function () {
-        window.pintrk.queue.push(Array.prototype.slice.call(arguments));
-      };
-      const n = window.pintrk;
-      (n.queue = []), (n.version = '3.0');
-      const t = document.createElement('script');
-      (t.async = !0), (t.src = e), t.setAttribute('data-loader', LOAD_ORIGIN);
-      const r = document.getElementsByTagName('script')[0];
-      r.parentNode.insertBefore(t, r);
-    }
-  })('https://s.pinimg.com/ct/core.js');
-}
-
-export { loadNativeSdk };

package/src/integrations/PinterestTag/propertyMappingConfig.js

@@ -1,57 +0,0 @@
-const eventMapping = [
-  {
-    src: ['order completed'],
-    dest: 'Checkout',
-  },
-  {
-    src: ['product added'],
-    dest: 'AddToCart',
-    hasEmptyProducts: true,
-  },
-  {
-    src: ['products searched', 'product list filtered'],
-    dest: 'Search',
-  },
-];
-
-const searchPropertyMapping = { src: 'query', dest: 'search_query' };
-
-const productPropertyMapping = [
-  { src: ['product_id', 'sku'], dest: 'product_id' },
-  { src: 'name', dest: 'product_name' },
-  { src: 'price', dest: 'product_price' },
-  { src: 'category', dest: 'product_category' },
-  { src: 'variant', dest: 'product_variant' },
-  { src: 'quantity', dest: 'product_quantity' },
-  { src: 'brand', dest: 'product_brand' },
-];
-
-const propertyMapping = [{ src: 'revenue', dest: 'value' }];
-
-const pinterestPropertySupport = [
-  'value',
-  'order_quantity',
-  'currency',
-  'order_id',
-  'product_name',
-  'product_id',
-  'product_category',
-  'product_variant',
-  'product_variant_id',
-  'product_price',
-  'product_quantity',
-  'product_brand',
-  'promo_code',
-  'property',
-  'video_title',
-  'lead_type',
-  'coupon',
-];
-
-export {
-  eventMapping,
-  searchPropertyMapping,
-  productPropertyMapping,
-  propertyMapping,
-  pinterestPropertySupport,
-};

package/src/integrations/PinterestTag/test/input.js

@@ -1,180 +0,0 @@
-const hightouchevents = [];
-
-hightouchevents.track('Products Searched', {
-  query: 'HDMI cable',
-});
-
-hightouchevents.track('Products Searched', {
-  query: 'HDMI cable',
-  properties: {
-    date: '7 january',
-  },
-});
-
-hightouchevents.track('Product List Filtered', {
-  list_id: 'todays_deals_may_11_2019',
-  filters: [
-    {
-      type: 'department',
-      value: 'beauty',
-    },
-    {
-      type: 'price',
-      value: 'under-$25',
-    },
-  ],
-  sorts: [
-    {
-      type: 'price',
-      value: 'desc',
-    },
-  ],
-  products: [
-    {
-      product_id: '507f1f77bcf86cd798439011',
-      sku: '45360-32',
-      name: 'Special Facial Soap',
-      price: 12.6,
-      position: 1,
-      category: 'Beauty',
-      url: 'https://www.example.com/product/path',
-      image_url: 'https://www.example.com/product/path.jpg',
-    },
-    {
-      product_id: '505bd76785ebb509fc283733',
-      sku: '46573-32',
-      name: 'Fancy Hairbrush',
-      price: 7.6,
-      position: 2,
-      category: 'Beauty',
-    },
-  ],
-});
-
-hightouchevents.track('Product Added', {
-  product_id: '123',
-  sku: 'F15',
-  category: 'Games',
-  name: 'Game',
-  brand: 'Gamepro',
-  variant: '111',
-  price: 13.49,
-  quantity: 11,
-  coupon: 'DISC21',
-  position: 1,
-  url: 'https://www.website.com/product/path',
-  image_url: 'https://www.website.com/product/path.png',
-});
-
-hightouchevents.track('Order Completed', {
-  checkout_id: 'fksdjfsdjfisjf9sdfjsd9f',
-  order_id: '50314b8e9bcf000000000000',
-  affiliation: 'Google Store',
-  total: 27.5,
-  subtotal: 22.5,
-  revenue: 25.0,
-  shipping: 3,
-  tax: 2,
-  discount: 2.5,
-  coupon: 'hasbros',
-  currency: 'USD',
-  products: [
-    {
-      product_id: '507f1f77bcf86cd799439011',
-      sku: '45790-32',
-      name: 'Monopoly: 3rd Edition',
-      price: 19,
-      quantity: 1,
-      category: 'Games',
-      url: 'https://www.example.com/product/path',
-      image_url: 'https:///www.example.com/product/path.jpg',
-    },
-    {
-      product_id: '505bd76785ebb509fc183733',
-      sku: '46493-32',
-      name: 'Uno Card Game',
-      price: 3,
-      quantity: 2,
-      category: 'Games',
-    },
-  ],
-});
-
-hightouchevents.page('Alert! I am raising a bug', 'testing you', {
-  path: 'path',
-  url: 'url',
-  title: 'title',
-  search: 'search',
-  referrer: 'referrer',
-  testDimension: 'true',
-});
-hightouchevents.page('I am no one', {
-  score: 21,
-  author: 'Author',
-  postType: 'blog',
-  section: 'News',
-});
-
-hightouchevents.identify('user123456', { email: 'user@email.com', age: 22 });
-
-// Tests With Custom Properties added
-hightouchevents.track('Order Completed', {
-  checkout_id: '12345',
-  order_id: '1234',
-  affiliation: 'Apple Store',
-  total: 20,
-  revenue: 15.0,
-  shipping: 22,
-  tax: 1,
-  discount: 1.5,
-  isUserAuthenticated: true, // custom properties
-  isDomainLocked: false, // custom properties
-  coupon: 'ImagePro',
-  currency: 'USD',
-  products: [
-    {
-      product_id: '123',
-      sku: 'G-32',
-      name: 'Monopoly',
-      price: 14,
-      quantity: 1,
-      category: 'Games',
-      url: 'https://www.website.com/product/path',
-      image_url: 'https://www.website.com/product/path.jpg',
-    },
-    {
-      product_id: '345',
-      sku: 'F-32',
-      name: 'UNO',
-      price: 3.45,
-      quantity: 2,
-      category: 'Games',
-    },
-  ],
-});
-// This event will map to Signup for Pinterest because there is a property mapping associated  with it.
-hightouchevents.track('register', {
-  checkout_id: '12345',
-  order_id: '1234',
-  isUserAuthenticated: true, // custom properties
-  isDomainLocked: false, // custom properties
-  coupon: 'ImagePro',
-  currency: 'USD',
-  products: [
-    {
-      product_id: '123',
-      sku: 'G-32',
-      name: 'Monopoly',
-      price: 14,
-      quantity: 1,
-      category: 'Games',
-    },
-    {
-      sku: 'F-32-sku-value',
-      name: 'UNO',
-      price: 3.45,
-      quantity: 2,
-      category: 'Games',
-    },
-  ],
-});

package/src/integrations/PinterestTag/test/output.js

@@ -1,129 +0,0 @@
-const pintrk = [];
-
-pintrk('track', 'search', { search_query: 'HDMI cable' });
-
-pintrk('track', 'search', {
-  search_query: 'HDMI cable',
-  'properties.date': '7 january',
-});
-
-pintrk('track', 'search', {
-  line_items: [
-    {
-      product_id: '45360-32',
-      product_name: 'Special Facial Soap',
-      product_price: 12.6,
-      product_category: 'Beauty',
-    },
-    {
-      product_id: '46573-32',
-      product_name: 'Fancy Hairbrush',
-      product_price: 7.6,
-      product_category: 'Beauty',
-    },
-  ],
-});
-
-pintrk('track', 'addtocart', {
-  coupon: 'DISC21',
-  line_items: [
-    {
-      product_id: 'F15',
-      product_name: 'Game',
-      product_price: 13.49,
-      product_category: 'Games',
-      product_variant: '111',
-      product_quantity: 11,
-      product_brand: 'Gamepro',
-    },
-  ],
-});
-
-pintrk('track', 'checkout', {
-  order_id: '50314b8e9bcf000000000000',
-  currency: 'USD',
-  'coupon or promo_code': 'hasbros',
-  line_items: [
-    {
-      product_id: '45790-32',
-      product_name: 'Monopoly: 3rd Edition',
-      product_price: 19,
-      product_category: 'Games',
-      product_quantity: 1,
-    },
-    {
-      product_id: '46493-32',
-      product_name: 'Uno Card Game',
-      product_price: 3,
-      product_category: 'Games',
-      product_quantity: 2,
-    },
-  ],
-});
-
-pintrk('track', 'ViewCategory', {
-  name: 'testing you',
-  category: 'Alert! I am raising a bug',
-});
-
-pintrk('track', 'PageVisit', {
-  name: 'I am no one',
-});
-
-pintrk('set', {
-  np: 'rudderstack',
-  em: 'user@email.com',
-});
-
-pintrk('track', 'Checkout', {
-  coupon: 'ImagePro',
-  currency: 'USD',
-  order_id: '1234',
-  line_items: [
-    {
-      product_quantity: '1',
-      product_category: 'Games',
-      product_price: '14',
-      product_name: 'Monopoly',
-      product_id: '123',
-    },
-    {
-      product_quantity: '2',
-      product_category: 'Games',
-      product_price: '3.45',
-      product_name: 'UNO',
-      product_id: '345',
-    },
-  ],
-  isUserAuthenticated: 'true',
-  isDomainLocked: 'false',
-});
-
-pintrk(
-  'track',
-  'Signup',
-
-  {
-    order_id: '1234',
-    coupon: 'ImagePro',
-    currency: 'USD',
-    line_items: [
-      {
-        product_quantity: '1',
-        product_category: 'Games',
-        product_price: '14',
-        product_name: 'Monopoly',
-        product_id: '123',
-      },
-      {
-        product_quantity: '2',
-        product_category: 'Games',
-        product_price: '3.45',
-        product_name: 'UNO',
-        product_id: 'F-32-sku-value',
-      },
-    ],
-    isUserAuthenticated: 'true',
-    isDomainLocked: 'false',
-  },
-);

package/src/integrations/PinterestTag/utils.js

@@ -1,47 +0,0 @@
-import logger from '../../utils/logUtil';
-import { getHashFromArrayWithDuplicate } from '../../utils/commonUtils';
-import { isDefinedAndNotNull } from '../../utils/utils';
-import { eventMapping } from './propertyMappingConfig';
-
-function getDestinationEventName(event, userDefinedEventsMapping, sendAsCustomEvent) {
-  let eventNames;
-  /*
-    Step 1: At first we will look for
-            the event mapping in the UI. In case it is similar, will map to that.
-     */
-  if (userDefinedEventsMapping.length > 0) {
-    const keyMap = getHashFromArrayWithDuplicate(userDefinedEventsMapping, 'from', 'to', false);
-    eventNames = keyMap[event];
-  }
-  if (eventNames) {
-    return eventNames;
-  }
-  /*
-    Step 2: To find if the particular event is amongst the list of standard
-            Rudderstack ecommerce events, used specifically for Pinterest Conversion API
-            mappings.
-    */
-  const eventMapInfo = eventMapping.find((eventMap) => eventMap.src.includes(event.toLowerCase()));
-  if (isDefinedAndNotNull(eventMapInfo)) {
-    return [eventMapInfo.dest];
-  }
-
-  /*
-    Step 3: In case both of the above stated cases fail, will check if sendAsCustomEvent toggle is enabled in UI. 
-            If yes, then we will send it as custom event
-    */
-  if (sendAsCustomEvent) {
-    return ['Custom'];
-  }
-
-  /*
-    Step 4: In case all of the above stated cases fail, will send the event name as it is.
-          This is going to be reflected as "unknown" event in pinterest tag dashboard.
-    */
-  logger.warn(
-    `'${event}' is not mapped in UI. Make sure to mapped the event in UI or enable the 'send as custom event' setting`,
-  );
-  return [event];
-}
-
-export { getDestinationEventName };