castled-js-sdk 0.0.1 → 0.0.2

package/src/integrations/YandexMetrica/nativeSdkLoader.js

@@ -0,0 +1,35 @@
+import { LOAD_ORIGIN } from '../../utils/ScriptLoader';
+
+function loadNativeSdk(tagId, clickmap, trackLinks, accurateTrackBounce, webvisor, ecommerce) {
+  (function (m, e, t, r, i, k, a) {
+    m[i] =
+      m[i] ||
+      function () {
+        (m[i].a = m[i].a || []).push(arguments);
+      };
+    m[i].l = 1 * new Date();
+    for (var j = 0; j < document.scripts.length; j++) {
+      if (document.scripts[j].src === r) {
+        return;
+      }
+    }
+    (k = e.createElement(t)),
+      (a = e.getElementsByTagName(t)[0]),
+      (k.async = 1),
+      (k.src = r),
+      k.setAttribute('data-loader', LOAD_ORIGIN),
+      a.parentNode.insertBefore(k, a);
+  })(window, document, 'script', 'https://mc.yandex.ru/metrika/tag.js', 'ym');
+
+  ym(tagId, 'init', {
+    clickmap,
+    trackLinks,
+    accurateTrackBounce,
+    webvisor,
+    ecommerce,
+  });
+  window[`${ecommerce}`] = window[`${ecommerce}`] || [];
+  window[`${ecommerce}`].push({});
+}
+
+export { loadNativeSdk };

package/src/integrations/YandexMetrica/utils.js

@@ -0,0 +1,138 @@
+import logger from '../../utils/logUtil';
+
+import {
+  removeUndefinedAndNullValues,
+  removeUndefinedAndNullAndEmptyValues,
+} from '../../utils/commonUtils';
+
+// This function is used for sending the track event to yandex.metrica
+const sendEvent = (container, payload) => {
+  window[container].push(payload);
+};
+
+// This object is defined to map the default rudder event to yandex.metrica event
+const ecommerceEventMapping = {
+  order_completed: 'purchase',
+  product_viewed: 'detail',
+  product_list_viewed: 'detail',
+  product_added: 'add',
+  product_removed: 'remove',
+};
+
+// This function is used to map the product properties
+const itemProperties = (properties) => {
+  const productProperties = {
+    id: properties.product_id || properties.sku,
+    name: properties.name,
+    brand: properties.brand,
+    category: properties.category,
+    coupon: properties.coupon,
+    position: properties.position,
+    price: parseFloat(properties.price),
+    quantity: parseInt(properties.price, 10),
+    variant: properties.variant,
+  };
+  return removeUndefinedAndNullValues(productProperties);
+};
+
+/**
+ *This function is used to populate the payload with ecommerce object with each product's properties
+ * @param {*} eventType
+ * @param {*} properties
+ * @param {*} products
+ * @returns
+ */
+
+const populatePayload = (eventType, properties, products) => {
+  const payload = {};
+  products.push(itemProperties(properties));
+  payload.ecommerce = {
+    ...payload.ecommerce,
+    currencyCode: properties.currency,
+    [eventType]: { products },
+  };
+  return payload;
+};
+
+/**
+ * Returns actionField
+ * @param {*} properties
+ * @param {*} goalId
+ * @returns
+ */
+const getActionField = (properties, goalId) => {
+  const { order_id: orderId, coupon, revenue } = properties;
+  const actionField = {
+    id: orderId,
+    coupon,
+    goal_id: goalId,
+    revenue,
+  };
+
+  // converting the goal_id and revenue in actionField to int and float type
+  actionField.goal_id = actionField.goal_id
+    ? parseInt(actionField.goal_id, 10)
+    : actionField.goal_id;
+  actionField.revenue = actionField.revenue ? parseFloat(actionField.revenue) : actionField.revenue;
+
+  return actionField;
+};
+
+/**
+ * Returns response payload
+ * @param {*} properties
+ * @param {*} eventType
+ * @returns
+ */
+const getResponsePayload = (properties, eventType) => {
+  let responsePayload = {};
+  const productsArray = [];
+  const { products, product_id: productId, name } = properties;
+
+  /**
+   * checking for products array if available each of the product inside is used
+   * populate the final payload else the product information inside the properties is used
+   */
+  if (products && Array.isArray(products)) {
+    products.forEach((element, index) => {
+      if (!(element.product_id || element.name)) {
+        logger.error(`None of product_id or name is present for product at index ${index}`);
+      } else {
+        responsePayload = populatePayload(eventType, element, productsArray);
+      }
+    });
+  } else if (!(productId || name)) {
+    logger.error(`None of product_id or name is present for the product`);
+  } else {
+    responsePayload = populatePayload(eventType, properties, productsArray);
+  }
+
+  return responsePayload;
+};
+
+/**
+ * This function is used to prepare and return the final payload to be sent
+ * @param {*} eventType - This is the e-commerce event type of yandex.metrica
+ * @param {*} properties - Properties passed in the track call
+ * @param {*} goalId - goalId taken from UI
+ * @returns the responsePayload to be sent to yandex.metrica
+ */
+const ecommEventPayload = (eventType, properties, goalId) => {
+  const { order_id: orderId } = properties;
+
+  const responsePayload = getResponsePayload(properties, eventType);
+
+  // populating actionField object required for purchase event type
+  if (eventType === 'purchase') {
+    if (!orderId) {
+      logger.error('order_id is required for event type purchase');
+    }
+    responsePayload.ecommerce[eventType].actionField = removeUndefinedAndNullAndEmptyValues(
+      getActionField(properties, goalId),
+    );
+  }
+
+  return removeUndefinedAndNullValues(responsePayload);
+};
+
+export { sendEvent, ecommEventPayload, ecommerceEventMapping };

package/src/integrations/index.js

@@ -0,0 +1,155 @@
+import * as AdobeAnalytics from './AdobeAnalytics';
+import * as Amplitude from './Amplitude';
+import * as Appcues from './Appcues';
+import * as BingAds from './BingAds';
+import * as Braze from './Braze';
+import * as Bugsnag from './Bugsnag';
+import * as Chartbeat from './Chartbeat';
+import * as Clevertap from './Clevertap';
+import * as Comscore from './Comscore';
+import * as Criteo from './Criteo';
+import * as CustomerIO from './CustomerIO';
+import * as Drip from './Drip';
+import * as FBPixel from './FacebookPixel';
+import * as Fullstory from './Fullstory';
+import * as GA from './GA';
+import * as GA4 from './GA4';
+import * as GoogleAds from './GoogleAds';
+import * as GoogleTagManager from './GoogleTagManager';
+import * as Heap from './Heap';
+import * as Hotjar from './Hotjar';
+import * as HubSpot from './HubSpot';
+import * as INTERCOM from './INTERCOM';
+import * as Keen from './Keen';
+import * as Kissmetrics from './Kissmetrics';
+import * as Klaviyo from './Klaviyo';
+import * as LinkedInInsightTag from './LinkedInInsightTag';
+import * as Lotame from './Lotame';
+import * as Lytics from './Lytics';
+import * as Mixpanel from './Mixpanel';
+import * as MoEngage from './MoEngage';
+import * as Optimizely from './Optimizely';
+import * as Pendo from './Pendo';
+import * as PinterestTag from './PinterestTag';
+import * as QuantumMetric from './QuantumMetric';
+import * as Posthog from './Posthog';
+import * as ProfitWell from './ProfitWell';
+import * as Qualtrics from './Qualtrics';
+import * as RedditPixel from './RedditPixel';
+import * as Sentry from './Sentry';
+import * as SnapPixel from './SnapPixel';
+import * as TVSquared from './TVSquared';
+import * as VWO from './VWO';
+import * as GoogleOptimize from './GoogleOptimize';
+import * as PostAffiliatePro from './PostAffiliatePro';
+import * as LaunchDarkly from './LaunchDarkly';
+import * as GA360 from './GA360';
+import * as DCMFloodlight from './DCMFloodlight';
+import * as Adroll from './Adroll';
+import * as Vero from './Vero';
+import * as Matomo from './Matomo';
+import * as Rockerbox from './Rockerbox';
+import * as Mouseflow from './Mouseflow';
+import * as ConvertFlow from './ConvertFlow';
+import * as SnapEngage from './SnapEngage';
+import * as LiveChat from './LiveChat';
+import * as Shynet from './Shynet';
+import * as Woopra from './Woopra';
+import * as RollBar from './RollBar';
+import * as QuoraPixel from './QuoraPixel';
+import * as Iterable from './Iterable';
+import * as Engage from './Engage';
+import * as June from './June';
+import * as Refiner from './Refiner';
+import * as YandexMetrica from './YandexMetrica';
+import * as Podsights from './Podsights';
+import * as Qualaroo from './Qualaroo';
+import * as Axeptio from './Axeptio';
+import * as Satismeter from './Satismeter';
+import * as MicrosoftClarity from './MicrosoftClarity';
+import * as Sendinblue from './Sendinblue';
+import * as Olark from './Olark';
+import * as Lemnisk from './Lemnisk';
+import * as TiktokAds from './TiktokAds';
+import * as ActiveCampaign from './ActiveCampaign';
+// the key names should match the destination.name value to keep parity everywhere
+// (config-plan name, native destination.name , exported integration name(this one below))
+
+const integrations = {
+  ADOBE_ANALYTICS: AdobeAnalytics.default,
+  AM: Amplitude.default,
+  APPCUES: Appcues.default,
+  BINGADS: BingAds.default,
+  BRAZE: Braze.default,
+  BUGSNAG: Bugsnag.default,
+  CHARTBEAT: Chartbeat.default,
+  CLEVERTAP: Clevertap.default,
+  COMSCORE: Comscore.default,
+  CRITEO: Criteo.default,
+  CUSTOMERIO: CustomerIO.default,
+  DCM_FLOODLIGHT: DCMFloodlight.default,
+  DRIP: Drip.default,
+  FACEBOOK_PIXEL: FBPixel.default,
+  FULLSTORY: Fullstory.default,
+  GA4: GA4.default,
+  GA: GA.default,
+  GOOGLEADS: GoogleAds.default,
+  GTM: GoogleTagManager.default,
+  HEAP: Heap.default,
+  HOTJAR: Hotjar.default,
+  HS: HubSpot.default,
+  INTERCOM: INTERCOM.default,
+  KEEN: Keen.default,
+  KISSMETRICS: Kissmetrics.default,
+  KLAVIYO: Klaviyo.default,
+  LINKEDIN_INSIGHT_TAG: LinkedInInsightTag.default,
+  LOTAME: Lotame.default,
+  LYTICS: Lytics.default,
+  MOENGAGE: MoEngage.default,
+  MP: Mixpanel.default,
+  OPTIMIZELY: Optimizely.default,
+  PENDO: Pendo.default,
+  PINTEREST_TAG: PinterestTag.default,
+  QUANTUMMETRIC: QuantumMetric.default,
+  POSTHOG: Posthog.default,
+  PROFITWELL: ProfitWell.default,
+  QUALTRICS: Qualtrics.default,
+  REDDIT_PIXEL: RedditPixel.default,
+  SENTRY: Sentry.default,
+  SNAP_PIXEL: SnapPixel.default,
+  TVSQUARED: TVSquared.default,
+  VWO: VWO.default,
+  GOOGLE_OPTIMIZE: GoogleOptimize.default,
+  POST_AFFILIATE_PRO: PostAffiliatePro.default,
+  LAUNCHDARKLY: LaunchDarkly.default,
+  GA360: GA360.default,
+  ADROLL: Adroll.default,
+  VERO: Vero.default,
+  MATOMO: Matomo.default,
+  ROCKERBOX: Rockerbox.default,
+  MOUSEFLOW: Mouseflow.default,
+  CONVERTFLOW: ConvertFlow.default,
+  SNAPENGAGE: SnapEngage.default,
+  LIVECHAT: LiveChat.default,
+  SHYNET: Shynet.default,
+  WOOPRA: Woopra.default,
+  ROLLBAR: RollBar.default,
+  QUORA_PIXEL: QuoraPixel.default,
+  ITERABLE: Iterable.default,
+  ENGAGE: Engage.default,
+  JUNE: June.default,
+  REFINER: Refiner.default,
+  YANDEX_METRICA: YandexMetrica.default,
+  PODSIGHTS: Podsights.default,
+  QUALAROO: Qualaroo.default,
+  AXEPTIO: Axeptio.default,
+  SATISMETER: Satismeter.default,
+  MICROSOFT_CLARITY: MicrosoftClarity.default,
+  SENDINBLUE: Sendinblue.default,
+  OLARK: Olark.default,
+  LEMNISK: Lemnisk.default,
+  TIKTOK_ADS: TiktokAds.default,
+  ACTIVE_CAMPAIGN: ActiveCampaign.default,
+};
+
+export { integrations };