iureiure 1.0.0

package/packages/analytics-js-integrations/src/integrations/GA/index.js

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

package/packages/analytics-js-integrations/src/integrations/GA360/browser.js

@@ -0,0 +1,58 @@
+/**
+ * Purpose of this integration:
+ * GA 360 is the enterprise version of Google Analytics. It is not different from GA. But in order Work GA 360 as
+ * device-mode integration and maintain the same structure with others created this integration.
+ * This GA360 class inherited all the properties from the GA class and whenever a method of this class is called,
+ * underlying GA method will get called.
+ */
+/* eslint-disable class-methods-use-this */
+import {
+  NAME,
+  DISPLAY_NAME,
+} from '@rudderstack/analytics-js-common/constants/integrations/GA360/constants';
+import Logger from '../../utils/logger';
+import { GA } from '../GA';
+
+const logger = new Logger(DISPLAY_NAME);
+
+class GA360 extends GA {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    super(config, analytics, destinationInfo);
+    this.analytics = analytics;
+    this.name = NAME;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  init() {
+    return super.init();
+  }
+
+  isLoaded() {
+    return super.isLoaded();
+  }
+
+  isReady() {
+    return super.isReady();
+  }
+
+  identify(rudderElement) {
+    return super.identify(rudderElement);
+  }
+
+  track(rudderElement) {
+    return super.track(rudderElement);
+  }
+
+  page(rudderElement) {
+    return super.page(rudderElement);
+  }
+}
+
+export default GA360;

package/packages/analytics-js-integrations/src/integrations/GA360/index.js

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

package/packages/analytics-js-integrations/src/integrations/GA4/browser.js

@@ -0,0 +1,264 @@
+/* eslint-disable prefer-rest-params */
+/* eslint-disable class-methods-use-this */
+import { ScriptLoader } from '@rudderstack/analytics-js-common/v1.1/utils/ScriptLoader';
+import {
+  NAME,
+  DISPLAY_NAME,
+} from '@rudderstack/analytics-js-common/constants/integrations/GA4/constants';
+import { Cookie } from '@rudderstack/analytics-js-common/v1.1/utils/storage/cookie';
+import Logger from '../../utils/logger';
+import { eventsConfig } from './config';
+import { constructPayload, flattenJsonPayload } from '../../utils/utils';
+import {
+  shouldSendUserId,
+  prepareParamsAndEventName,
+  filterUserTraits,
+  formatAndValidateEventName,
+} from './utils';
+
+const logger = new Logger(DISPLAY_NAME);
+
+export default class GA4 {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.name = NAME;
+    this.clientId = '';
+    this.sessionId = '';
+    this.sessionNumber = '';
+    this.cookie = Cookie;
+    this.sendUserId = true;
+    this.analytics = analytics;
+    this.measurementId = config.measurementId;
+    this.debugView = config.debugView || false;
+    this.capturePageView = config.capturePageView || 'rs';
+    this.isHybridModeEnabled = config.connectionMode === 'hybrid';
+    this.piiPropertiesToIgnore = config.piiPropertiesToIgnore || [];
+    this.extendPageViewParams = config.extendPageViewParams || false;
+    this.overrideClientAndSessionId = config.overrideClientAndSessionId || false;
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  loadScript(measurementId) {
+    window.dataLayer = window.dataLayer || [];
+    window.gtag =
+      window.gtag ||
+      function gt() {
+        window.dataLayer.push(arguments);
+      };
+    window.gtag('js', new Date());
+    const gtagParameterObject = {};
+
+    if (this.capturePageView === 'rs') {
+      gtagParameterObject.send_page_view = false;
+    }
+
+    // Setting the userId as part of the configuration
+    this.sendUserId = shouldSendUserId(this.analytics.loadOnlyIntegrations);
+    if (this.sendUserId && this.analytics.getUserId()) {
+      gtagParameterObject.user_id = this.analytics.getUserId();
+    }
+
+    if (this.isHybridModeEnabled && this.overrideClientAndSessionId) {
+      gtagParameterObject.cookie_prefix = 'rs';
+      gtagParameterObject.client_id = this.analytics.getAnonymousId();
+      gtagParameterObject.session_id = this.analytics.getSessionId();
+    } else {
+      // Cookie migration logic
+      const clientCookie = this.cookie.get('rs_ga');
+      const defaultGA4Cookie = this.cookie.get('_ga');
+      const measurementIdArray = this.measurementId.split('-');
+      const sessionCookie = this.cookie.get(`rs_ga_${measurementIdArray[1]}`);
+
+      // Only override when both cookie with rs prefix is available and default cookie is not available
+      if (!defaultGA4Cookie && clientCookie && sessionCookie) {
+        const clientCookieArray = clientCookie.split('.');
+
+        // client_id cookie : GA1.1.51545857.1686555747
+        // client_id cookie : GA1.1.48512441-5e44-4860-9900-a8f6e6bc4041
+        const clientId =
+          clientCookieArray.length > 3
+            ? `${clientCookieArray[2]}.${clientCookieArray[3]}`
+            : clientCookieArray[2];
+
+        // session_id cookie : GS1.1.1686558743.1.1.1686558965.7.0.0
+        const sessionCookieArray = sessionCookie.split('.');
+        const sessionId = sessionCookieArray[2];
+
+        // Use existing client and session ids
+        if (clientId) {
+          gtagParameterObject.client_id = clientId;
+        }
+        if (sessionId) {
+          gtagParameterObject.session_id = sessionId;
+        }
+      }
+
+      // Remove rs prefixed cookies so that it won't used again
+      this.cookie.remove('rs_ga');
+      this.cookie.remove(`rs_ga_${measurementIdArray[1]}`);
+    }
+
+    if (this.debugView) {
+      gtagParameterObject.debug_mode = true;
+    }
+
+    if (Object.keys(gtagParameterObject).length === 0) {
+      window.gtag('config', measurementId);
+    } else {
+      window.gtag('config', measurementId, gtagParameterObject);
+    }
+
+    /**
+     * Setting the parameter sessionId, clientId and session_number using gtag api
+     * Ref: https://developers.google.com/tag-platform/gtagjs/reference
+     */
+    window.gtag('get', this.measurementId, 'session_id', sessionId => {
+      this.sessionId = sessionId;
+    });
+    window.gtag('get', this.measurementId, 'client_id', clientId => {
+      this.clientId = clientId;
+    });
+    window.gtag('get', this.measurementId, 'session_number', sessionNumber => {
+      this.sessionNumber = sessionNumber;
+    });
+
+    ScriptLoader(
+      'google-analytics 4',
+      `https://www.googletagmanager.com/gtag/js?id=${measurementId}`,
+    );
+  }
+
+  init() {
+    this.loadScript(this.measurementId);
+  }
+
+  /**
+   * If the gtag is successfully initialized, client ID and session ID fields will have valid values for the given GA4 configuration
+   */
+  isLoaded() {
+    return !!(this.sessionId && this.clientId);
+  }
+
+  isReady() {
+    return this.isLoaded();
+  }
+
+  /**
+   *
+   * @param {*} rudderElement
+   */
+  identify(rudderElement) {
+    const { message } = rudderElement;
+    const { traits } = message.context;
+    const piiFilteredUserTraits = filterUserTraits(this.piiPropertiesToIgnore, traits);
+    if (Object.keys(piiFilteredUserTraits).length > 0) {
+      window.gtag('set', 'user_properties', piiFilteredUserTraits);
+    }
+
+    if (this.sendUserId && message.userId) {
+      const { userId } = message;
+      window.gtag('config', this.measurementId, { user_id: userId });
+    }
+  }
+
+  /**
+   *
+   * @param {*} rudderElement
+   */
+  track(rudderElement) {
+    // if Hybrid mode is enabled, don't send data to the device-mode
+    if (this.isHybridModeEnabled) {
+      return;
+    }
+
+    const { message } = rudderElement;
+
+    const eventName = formatAndValidateEventName(message?.event);
+    if (!eventName) {
+      logger.error('Event name is required');
+      return;
+    }
+
+    const data = prepareParamsAndEventName(message, eventName);
+    if (!data) {
+      return;
+    }
+
+    const { params, event } = data;
+    const parameters = this.addSendToAndMeasurementIdToPayload(params, rudderElement);
+
+    window.gtag('event', event, parameters);
+  }
+
+  /**
+   *
+   * @param {*} rudderElement
+   */
+  page(rudderElement) {
+    if (this.capturePageView === 'rs') {
+      const { message } = rudderElement;
+      const { properties } = message;
+
+      let payload = constructPayload(message, eventsConfig.PAGE.mapping);
+      payload = this.addSendToAndMeasurementIdToPayload(payload, rudderElement);
+
+      if (this.extendPageViewParams) {
+        window.gtag('event', 'page_view', {
+          ...flattenJsonPayload(properties),
+          ...payload,
+        });
+      } else {
+        window.gtag('event', 'page_view', payload);
+      }
+    }
+  }
+
+  /**
+   *
+   * @param {*} rudderElement
+   * @returns
+   */
+  group(rudderElement) {
+    if (this.isHybridModeEnabled) {
+      return;
+    }
+
+    const { groupId, traits } = rudderElement.message;
+    let payload = traits;
+    payload = this.addSendToAndMeasurementIdToPayload(payload, rudderElement);
+
+    const eventData = {
+      group_id: groupId,
+      ...payload,
+    };
+
+    window.gtag('event', 'join_group', eventData);
+  }
+
+  addSendToAndMeasurementIdToPayload(params, rudderElement) {
+    const { message } = rudderElement;
+    const { userId } = message;
+    const parameters = params;
+    parameters.send_to = this.measurementId;
+    if (this.sendUserId && userId) {
+      parameters.user_id = userId;
+    }
+    return parameters;
+  }
+
+  getDataForIntegrationsObject() {
+    return {
+      [DISPLAY_NAME]: {
+        clientId: this.clientId,
+        sessionId: this.sessionId,
+        sessionNumber: this.sessionNumber,
+      },
+    };
+  }
+}

package/packages/analytics-js-integrations/src/integrations/GA4/config.js

@@ -0,0 +1,296 @@
+const customParametersExclusion = [
+  'item_id',
+  'itemId',
+  'product_id',
+  'item_name',
+  'itemName',
+  'name',
+  'coupon',
+  'item_brand',
+  'itemBrand',
+  'brand',
+  'item_variant',
+  'itemVariant',
+  'variant',
+  'price',
+  'quantity',
+  'index',
+  'position',
+  'affiliation',
+  'discount',
+  'item_category',
+  'itemCategory',
+  'category',
+  'item_category2',
+  'item_category3',
+  'item_category4',
+  'item_category5',
+  'item_list_id',
+  'item_list_name',
+  'location_id',
+];
+
+const itemsArrayParams = [
+  { sourceKeys: ['product_id', 'itemId'], destKey: 'item_id' },
+  { sourceKeys: ['name', 'itemName'], destKey: 'item_name' },
+  { sourceKeys: 'coupon', destKey: 'coupon' },
+  { sourceKeys: ['brand', 'itemBrand'], destKey: 'item_brand' },
+  { sourceKeys: ['variant', 'itemVariant'], destKey: 'item_variant' },
+  { sourceKeys: 'price', destKey: 'price', metadata: { type: 'toNumber' } },
+  { sourceKeys: 'quantity', destKey: 'quantity', metadata: { type: 'toNumber' } },
+  { sourceKeys: 'position', destKey: 'index', metadata: { type: 'toNumber' } },
+  { sourceKeys: 'affiliation', destKey: 'affiliation' },
+  { sourceKeys: 'discount', destKey: 'discount' },
+  { sourceKeys: ['category', 'itemCategory'], destKey: 'item_category' },
+  { sourceKeys: 'item_category2', destKey: 'item_category2' },
+  { sourceKeys: 'item_category3', destKey: 'item_category3' },
+  { sourceKeys: 'item_category4', destKey: 'item_category4' },
+  { sourceKeys: 'item_category5', destKey: 'item_category5' },
+  { sourceKeys: 'item_list_id', destKey: 'item_list_id' },
+  { sourceKeys: 'item_list_name', destKey: 'item_list_name' },
+  { sourceKeys: 'location_id', destKey: 'location_id' },
+];
+
+const eventParams = {
+  method: { sourceKeys: 'properties.method', destKey: 'method' },
+  product_cart_shared_method: { sourceKeys: 'properties.share_via', destKey: 'method' },
+  currency: {
+    sourceKeys: 'properties.currency',
+    destKey: 'currency',
+    metadata: { defaultValue: 'USD' },
+  },
+  value: {
+    sourceKeys: ['properties.total', 'properties.value', 'properties.revenue', 'properties.price'],
+    destKey: 'value',
+    metadata: { type: 'toNumber' },
+  },
+  product_add_or_remove_value: {
+    sourceKeys: [
+      'properties.total',
+      'properties.value',
+      'properties.revenue',
+      {
+        operation: 'multiplication',
+        args: [
+          {
+            sourceKeys: 'properties.price',
+          },
+          {
+            sourceKeys: 'properties.quantity',
+            defaultVal: 1,
+          },
+        ],
+      },
+    ],
+    destKey: 'value',
+    metadata: { type: 'toNumber' },
+  },
+  search: { sourceKeys: 'properties.query', destKey: 'search_term' },
+  list_id: { sourceKeys: 'properties.list_id', destKey: 'item_list_id' },
+  list_name: { sourceKeys: 'properties.category', destKey: 'item_list_name' },
+  creative_name: {
+    sourceKeys: ['properties.creative_name', 'properties.creative'],
+    destKey: 'creative_name',
+  },
+  creative_slot: {
+    sourceKeys: ['properties.creative_slot', 'properties.position'],
+    destKey: 'creative_slot',
+  },
+  promotion_id: { sourceKeys: 'properties.promotion_id', destKey: 'promotion_id' },
+  promotion_name: {
+    sourceKeys: ['properties.promotion_name', 'properties.name'],
+    destKey: 'promotion_name',
+  },
+  coupon: { sourceKeys: 'properties.coupon', destKey: 'coupon' },
+  payment_method: { sourceKeys: 'properties.payment_method', destKey: 'payment_type' },
+  shipping_method: { sourceKeys: 'properties.shipping_method', destKey: 'shipping_tier' },
+  order_id: { sourceKeys: 'properties.order_id', destKey: 'transaction_id' },
+  shipping: {
+    sourceKeys: 'properties.shipping',
+    destKey: 'shipping',
+    metadata: { type: 'toNumber' },
+  },
+  tax: { sourceKeys: 'properties.tax', destKey: 'tax', metadata: { type: 'toNumber' } },
+  content_type: { sourceKeys: 'properties.content_type', destKey: 'content_type' },
+  item_id: {
+    sourceKeys: ['properties.item_id', 'properties.product_id', 'properties.sku'],
+    destKey: 'item_id',
+  },
+  cart_shared_item_id: {
+    sourceKeys: ['properties.item_id', 'properties.cart_id'],
+    destKey: 'item_id',
+  },
+  url: { sourceKeys: ['properties.url', 'context.page.url'], destKey: 'page_location' },
+  referrer: { sourceKeys: ['properties.referrer', 'context.page.referrer'], destKey: 'page_referrer' },
+  title: { sourceKeys: ['properties.title', 'context.page.title'], destKey: 'page_title' },
+};
+
+const eventsConfig = {
+  LOGIN: {
+    event: 'login',
+    mapping: [eventParams.method],
+  },
+  SIGN_UP: {
+    event: 'sign_up',
+    mapping: [eventParams.method],
+  },
+  GENERATE_LEAD: {
+    event: 'generate_lead',
+    mapping: [eventParams.currency, { ...eventParams.value, required: true }],
+  },
+  PRODUCTS_SEARCHED: {
+    event: 'search',
+    mapping: [eventParams.search],
+  },
+  PRODUCT_SEARCHED: {
+    event: 'search',
+    mapping: [eventParams.search],
+  },
+  PRODUCT_LIST_VIEWED: {
+    event: 'view_item_list',
+    itemList: 'YES',
+    mapping: [eventParams.list_id, eventParams.list_name],
+  },
+  PROMOTION_VIEWED: {
+    event: 'view_promotion',
+    itemList: 'YES',
+    mapping: [
+      eventParams.promotion_id,
+      eventParams.creative_slot,
+      eventParams.creative_name,
+      eventParams.promotion_name,
+    ],
+  },
+  PROMOTION_CLICKED: {
+    event: 'select_promotion',
+    itemList: 'NO',
+    mapping: [
+      eventParams.promotion_id,
+      eventParams.creative_slot,
+      eventParams.creative_name,
+      eventParams.promotion_name,
+    ],
+  },
+  PRODUCT_CLICKED: {
+    event: 'select_item',
+    item: 'YES',
+    mapping: [eventParams.list_id, eventParams.list_name],
+  },
+  PRODUCTS_CLICKED: {
+    event: 'select_item',
+    item: 'YES',
+    mapping: [eventParams.list_id, eventParams.list_name],
+  },
+  PRODUCT_VIEWED: {
+    event: 'view_item',
+    item: 'YES',
+    mapping: [eventParams.currency, { ...eventParams.value, required: true }],
+  },
+  PRODUCT_ADDED: {
+    event: 'add_to_cart',
+    itemList: 'NO',
+    item: 'YES',
+    mapping: [eventParams.currency, { ...eventParams.product_add_or_remove_value, required: true }],
+  },
+  PRODUCT_REMOVED: {
+    event: 'remove_from_cart',
+    itemList: 'NO',
+    item: 'YES',
+    mapping: [eventParams.currency, { ...eventParams.product_add_or_remove_value, required: true }],
+  },
+  CART_VIEWED: {
+    event: 'view_cart',
+    itemList: 'YES',
+    mapping: [eventParams.currency, { ...eventParams.value, required: true }],
+  },
+  CHECKOUT_STARTED: {
+    event: 'begin_checkout',
+    itemList: 'YES',
+    mapping: [eventParams.currency, eventParams.coupon, { ...eventParams.value, required: true }],
+  },
+  PAYMENT_INFO_ENTERED: {
+    event: 'add_payment_info',
+    itemList: 'YES',
+    mapping: [
+      eventParams.currency,
+      eventParams.coupon,
+      eventParams.payment_method,
+      { ...eventParams.value, required: true },
+    ],
+  },
+  CHECKOUT_STEP_COMPLETED: {
+    event: 'add_shipping_info',
+    itemList: 'YES',
+    mapping: [
+      eventParams.currency,
+      eventParams.coupon,
+      eventParams.shipping_method,
+      { ...eventParams.value, required: true },
+    ],
+  },
+  ORDER_COMPLETED: {
+    event: 'purchase',
+    itemList: 'YES',
+    mapping: [
+      eventParams.tax,
+      eventParams.coupon,
+      eventParams.shipping,
+      eventParams.currency,
+      { ...eventParams.value, required: true },
+      { ...eventParams.order_id, required: true },
+    ],
+  },
+  ORDER_REFUNDED: {
+    event: 'refund',
+    itemList: 'NO',
+    mapping: [
+      eventParams.tax,
+      eventParams.coupon,
+      eventParams.shipping,
+      eventParams.currency,
+      { ...eventParams.value, required: true },
+      { ...eventParams.order_id, required: true },
+    ],
+  },
+  PRODUCT_ADDED_TO_WISHLIST: {
+    event: 'add_to_wishlist',
+    itemList: 'NO',
+    item: 'YES',
+    mapping: [eventParams.currency, { ...eventParams.value, required: true }],
+  },
+  PRODUCT_SHARED: {
+    event: 'share',
+    mapping: [
+      eventParams.item_id,
+      eventParams.content_type,
+      eventParams.product_cart_shared_method,
+    ],
+  },
+  CART_SHARED: {
+    event: 'share',
+    mapping: [
+      eventParams.content_type,
+      eventParams.cart_shared_item_id,
+      eventParams.product_cart_shared_method,
+    ],
+  },
+  PAGE: {
+    event: 'page_view',
+    mapping: [eventParams.url, eventParams.title, eventParams.referrer],
+  },
+};
+
+const rootLevelProductsSupportedEventsList = [
+  eventsConfig.PRODUCT_CLICKED.event,
+  eventsConfig.PRODUCT_VIEWED.event,
+  eventsConfig.PRODUCT_ADDED.event,
+  eventsConfig.PRODUCT_REMOVED.event,
+  eventsConfig.PRODUCT_ADDED_TO_WISHLIST.event,
+];
+
+export {
+  eventsConfig,
+  itemsArrayParams,
+  customParametersExclusion,
+  rootLevelProductsSupportedEventsList,
+};

package/packages/analytics-js-integrations/src/integrations/GA4/index.js

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