castled-js-sdk 0.0.3 → 0.0.4

package/__tests__/integrations/GA4/browser.test.js

@@ -1,94 +0,0 @@
-import GA4 from '../../../src/integrations/GA4/browser';
-
-import { identifyEvents, trackEvents, pageEvents, groupEvents } from './__mocks__/data';
-
-afterAll(() => {
-  jest.restoreAllMocks();
-});
-const destinationInfo = {
-  areTransformationsConnected: false,
-  destinationId: 'sample-destination-id',
-};
-
-// jest.mock('this.analytics.getUserId', () => '1234');
-
-describe('Google Analytics 4 init tests', () => {
-  test('Testing init call of Google Analytics 4 with MeasurementId', () => {
-    const ga4 = new GA4(
-      { measurementId: 'G-123456', debugView: true },
-      { getUserId: () => '1234', getUserTraits: () => {} },
-      destinationInfo,
-    );
-    ga4.init();
-    expect(typeof window.gtag).toBe('function');
-  });
-});
-
-describe('Google Analytics 4 events tests', () => {
-  let ga4;
-  beforeEach(() => {
-    ga4 = new GA4(
-      { measurementId: 'G-123456', extendPageViewParams: true, capturePageView: 'rs' },
-      { getUserId: () => '1234', getUserTraits: () => {} },
-      destinationInfo,
-    );
-    ga4.init();
-    window.gtag = jest.fn();
-  });
-
-  trackEvents.forEach((event) => {
-    test(`Track : ${event.description}`, () => {
-      const { input, output } = event;
-      try {
-        ga4.track(input);
-        // verifying events
-        expect(window.gtag.mock.calls[0][1]).toEqual(output.event);
-        expect(window.gtag.mock.calls[0][2]).toEqual(output.params);
-      } catch (error) {
-        expect(error.message).toEqual(output.message);
-      }
-    });
-  });
-
-  identifyEvents.forEach((event) => {
-    test(`Identify : ${event.description}`, () => {
-      const { input, output } = event;
-      try {
-        ga4.identify(input);
-        // verifying events
-        expect(window.gtag.mock.calls[0][2]).toEqual(output.traits);
-        expect(window.gtag.mock.calls[1][2]).toEqual(output.userId);
-      } catch (error) {
-        expect(error.message).toEqual(output.message);
-      }
-    });
-  });
-
-  pageEvents.forEach((event) => {
-    test(`Page : ${event.description}`, () => {
-      const { input, output } = event;
-      try {
-        ga4.page(input);
-        // verifying events
-        expect(window.gtag.mock.calls[0][1]).toEqual(output.event);
-        expect(window.gtag.mock.calls[0][2]).toEqual(output.params);
-      } catch (error) {
-        expect(error.message).toEqual(output.message);
-      }
-    });
-  });
-
-  groupEvents.forEach((event) => {
-    test(`Group : ${event.description}`, () => {
-      const { input, output } = event;
-      try {
-        ga4.group(input);
-        // verifying events
-        expect(window.gtag.mock.calls[0][1]).toEqual(output.event);
-        expect(window.gtag.mock.calls[0][2]).toEqual(output.params);
-      } catch (error) {
-        expect(error.message).toEqual(output.message);
-      }
-    });
-  });
-});

package/__tests__/integrations/GA4/utils.test.js

@@ -1,337 +0,0 @@
-import {
-  getItem,
-  getItemList,
-  getItemsArray,
-  extractLastKey,
-  shouldSendUserId,
-  getExclusionFields,
-  removeInvalidParams,
-  isReservedEventName,
-  getCustomParameters,
-  formatAndValidateEventName,
-} from '../../../src/integrations/GA4/utils';
-
-import {
-  mapping,
-  expectedItemsArray,
-  inputProductsArray,
-  outputProductsArray,
-} from './__mocks__/data';
-
-import {
-  eventsConfig,
-  itemsArrayParams,
-  customParametersExclusion,
-} from '../../../src/integrations/GA4/config';
-
-describe('Google Analytics 4 utilities tests', () => {
-  describe('sendUserIdToGA4 function tests', () => {
-    test('Default integrationsObj', () => {
-      const sendUserIdToGA4 = shouldSendUserId({ All: true });
-      expect(sendUserIdToGA4).toEqual(true);
-    });
-
-    test('IntegrationsObj with GA4 and without sendUserId property', () => {
-      const sendUserIdToGA4 = shouldSendUserId({ All: true, GA4: { sessionId: '1782034567' } });
-      expect(sendUserIdToGA4).toEqual(true);
-    });
-
-    test('IntegrationsObj with GA4 and sendUserId set to true', () => {
-      const sendUserIdToGA4 = shouldSendUserId({
-        All: true,
-        GA4: { sessionId: '1782034567', sendUserId: true },
-      });
-      expect(sendUserIdToGA4).toEqual(true);
-    });
-
-    test('IntegrationsObj with GA4 and sendUserId set to false', () => {
-      const sendUserIdToGA4 = shouldSendUserId({
-        All: true,
-        GA4: { sessionId: '1782034567', sendUserId: false },
-      });
-      expect(sendUserIdToGA4).toEqual(false);
-    });
-  });
-
-  describe('isReservedEventName function tests', () => {
-    test('Standard Google Analytics 4 event name', () => {
-      const isReserved = isReservedEventName('Products Searched');
-      expect(isReserved).toEqual(false);
-    });
-
-    test('Custom Google Analytics 4 event name', () => {
-      const isReserved = isReservedEventName('Product page visit');
-      expect(isReserved).toEqual(false);
-    });
-
-    test('Reserved Google Analytics 4 event name', () => {
-      const isReserved = isReservedEventName('app_remove');
-      expect(isReserved).toEqual(true);
-    });
-  });
-
-  describe('extractLastKey function tests', () => {
-    test('Should extract last key from a string with dot', () => {
-      const lastKey = extractLastKey('properties.product_id');
-      expect(lastKey).toEqual('product_id');
-    });
-
-    test('Should return the input string when there is no dot', () => {
-      const lastKey = extractLastKey('currency');
-      expect(lastKey).toEqual('currency');
-    });
-  });
-
-  describe('formatAndValidateEventName function tests', () => {
-    test('Valid event name with spaces', () => {
-      // Test a valid event name with spaces
-      const eventName = 'product searched';
-      const result = formatAndValidateEventName(eventName);
-      // Expect the result to be the formatted event name with spaces replaced by underscores
-      expect(result).toEqual('product_searched');
-    });
-
-    test('Empty event name', () => {
-      // Test an empty event name
-      const eventName = '';
-      const result = formatAndValidateEventName(eventName);
-      // Expect the result to be null
-      expect(result).toBeNull();
-    });
-
-    test('Reserved event name', () => {
-      // Test a reserved event name
-      const eventName = 'click';
-      const result = formatAndValidateEventName(eventName);
-      // Expect the result to be null
-      expect(result).toBeNull();
-    });
-  });
-
-  describe('getCustomParameters function tests', () => {
-    test('Return an empty object when message is empty', () => {
-      const message = {};
-      const keys = [];
-      const exclusionFields = [];
-      const result = getCustomParameters(message, keys, exclusionFields);
-      expect(result).toEqual({});
-    });
-
-    test('Extract custom fields and flatten JSON', () => {
-      const message = {
-        properties: {
-          product_id: '12345',
-          price: 99.99,
-          category: 'electronics',
-        },
-        user: {
-          id: 'user123',
-          name: 'John Doe',
-        },
-      };
-      const keys = ['properties', 'user'];
-      const exclusionFields = [];
-      const result = getCustomParameters(message, keys, exclusionFields);
-      expect(result).toEqual({
-        product_id: '12345',
-        price: 99.99,
-        category: 'electronics',
-        id: 'user123',
-        name: 'John Doe',
-      });
-    });
-
-    test('Exclude specified fields from extraction', () => {
-      const message = {
-        properties: {
-          product_id: '12345',
-          price: 99.99,
-          category: 'electronics',
-        },
-        user: {
-          id: 'user123',
-          name: 'John Doe',
-        },
-      };
-      const keys = ['properties', 'user'];
-      const exclusionFields = ['price', 'name'];
-      const result = getCustomParameters(message, keys, exclusionFields);
-      expect(result).toEqual({
-        product_id: '12345',
-        category: 'electronics',
-        id: 'user123',
-      });
-    });
-
-    test('Handle root level extraction when keys parameter is "root"', () => {
-      const message = {
-        event: 'click',
-        timestamp: 1625102800000,
-        user: {
-          id: 'user123',
-          name: 'John Doe',
-        },
-      };
-      const keys = 'root';
-      const exclusionFields = [];
-      const result = getCustomParameters(message, keys, exclusionFields);
-      expect(result).toEqual({
-        event: 'click',
-        timestamp: 1625102800000,
-        user_id: 'user123',
-        user_name: 'John Doe',
-      });
-    });
-  });
-
-  describe('getExclusionFields function tests', () => {
-    test('Return exclusion fields for mapping with string source keys', () => {
-      const event = 'purchase';
-      const exclusionFields = getExclusionFields(false, mapping, event);
-      expect(exclusionFields).toEqual(['product_id', 'price', 'products']);
-    });
-
-    test('Include customParametersExclusion when mapRootLevelPropertiesToGA4ItemsArray is true and event supports root level products', () => {
-      const event = 'select_item';
-      const exclusionFields = getExclusionFields(true, mapping, event);
-      const expectedExclusionFields = [
-        'product_id',
-        'price',
-        'products',
-        ...customParametersExclusion,
-      ];
-      expect(exclusionFields).toEqual(expectedExclusionFields);
-    });
-
-    test('Exclude "products" for events supporting root level products, regardless of mapping or mapRootLevelPropertiesToGA4ItemsArray value', () => {
-      const event = 'purchase';
-      const exclusionFields1 = getExclusionFields(false, mapping, event);
-      const exclusionFields2 = getExclusionFields(true, mapping, event);
-      expect(exclusionFields1).toContain('products');
-      expect(exclusionFields2).toContain('products');
-    });
-  });
-
-  describe('getItemList function tests', () => {
-    test('Return an empty array if message properties.products is undefined', () => {
-      const message = { properties: {} };
-      const items = getItemList(message);
-      expect(items).toEqual([]);
-    });
-
-    test('Return an empty array if message properties.products is an empty array', () => {
-      const message = { properties: { products: [] } };
-      const items = getItemList(message);
-      expect(items).toEqual([]);
-    });
-
-    test('Construct payload and return an array of items', () => {
-      const message = {
-        properties: {
-          products: inputProductsArray,
-        },
-      };
-      const items = getItemList(message, itemsArrayParams);
-      expect(items).toEqual(outputProductsArray);
-    });
-
-    test('Products is an object and return an array of items', () => {
-      const message = {
-        properties: {
-          products: inputProductsArray[0],
-        },
-      };
-      const items = getItemList(message, itemsArrayParams);
-      expect(items).toEqual([outputProductsArray[0]]);
-    });
-  });
-
-  describe('getItem function tests', () => {
-    test('Return an empty array if properties is undefined', () => {
-      const message = {};
-      const item = getItem(message);
-      expect(item).toEqual([]);
-    });
-
-    test('Return an empty array if properties is an empty object', () => {
-      const message = {
-        properties: {},
-      };
-      const item = getItem(message);
-      expect(item).toEqual([]);
-    });
-
-    test('Return an array with a single item if properties is not empty', () => {
-      const message = {
-        properties: inputProductsArray[0],
-      };
-
-      const item = getItem(message);
-      expect(item).toEqual([expectedItemsArray[0]]);
-    });
-
-    test('Return an empty array if the constructed item is an empty object', () => {
-      const message = {
-        properties: {
-          invalidField: null,
-        },
-      };
-      const item = getItem(message);
-      expect(item).toEqual([]);
-    });
-  });
-
-  describe('getItemsArray function tests', () => {
-    test('Returns items array and mapRootLevelPropertiesToGA4ItemsArray as false when product parameter is supported', () => {
-      const message = {
-        properties: {
-          products: inputProductsArray,
-        },
-      };
-      const config = eventsConfig.PRODUCT_ADDED;
-
-      const itemsArray = getItemsArray(message, config);
-      expect(itemsArray).toEqual({
-        items: outputProductsArray,
-        mapRootLevelPropertiesToGA4ItemsArray: false,
-      });
-    });
-
-    test('Returns items array and mapRootLevelPropertiesToGA4ItemsArray as true when product parameter is not supported', () => {
-      const message = {
-        properties: inputProductsArray[1],
-      };
-      const config = eventsConfig.PRODUCTS_CLICKED;
-
-      const itemsArray = getItemsArray(message, config);
-      expect(itemsArray).toEqual({
-        items: [expectedItemsArray[1]],
-        mapRootLevelPropertiesToGA4ItemsArray: true,
-      });
-    });
-  });
-
-  describe('removeInvalidValues function tests', () => {
-    it('Should remove empty values except for "items"', () => {
-      const params = {
-        name: 'John',
-        age: 30,
-        email: '',
-        city: null,
-        items: [],
-        address: {},
-        phone: '123456789',
-      };
-
-      const expected = {
-        name: 'John',
-        items: [],
-        age: 30,
-        phone: '123456789',
-      };
-
-      const result = removeInvalidParams(params);
-      expect(result).toEqual(expected);
-    });
-  });
-});

package/__tests__/integrations/GoogleAds/__mocks__/data.js

@@ -1,235 +0,0 @@
-const productAdded = 'Product Added';
-const orderCompleted = 'Order Completed';
-const mockConversionId = 'AW-11071053757';
-const mockOrderId = '771c04b-2cb8-41dd-9609-330b37bcc62c';
-
-const products = [
-  {
-    product_id: 'abc',
-    category: 'Merch',
-    name: 'Food/Drink',
-    brand: '',
-    variant: 'Extra topped',
-    price: 3.0,
-    quantity: 2,
-    currency: 'GBP',
-    typeOfProduct: 'Food',
-  },
-];
-
-const mockEvents = [
-  { eventName: 'Product Viewed' },
-  { eventName: orderCompleted },
-  { eventName: 'Sign Up' },
-  { eventName: 'Lead' },
-];
-
-const mockEventTypeConversions = [
-  { conversionLabel: '15klCKLCs4gYETIBi58p', name: 'Sign Up' },
-  { conversionLabel: '9Hr5CKXCs4gYETIBi58p', name: 'Page View' },
-  { conversionLabel: 'TCBjCKjCs4gYETIBi58p', name: orderCompleted },
-  { conversionLabel: 'KhF2CKvCs4gYETIBi58p', name: productAdded },
-];
-
-const googleAdsConfigs = [
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    dynamicRemarketing: false,
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    dynamicRemarketing: true,
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    trackConversions: true,
-    trackDynamicRemarketing: true,
-    enableConversionEventsFiltering: false,
-    enableDynamicRemarketingEventsFiltering: false,
-    eventsToTrackConversions: [{ eventName: productAdded }],
-    eventsToTrackDynamicRemarketing: [{ eventName: 'Product Added To The List' }],
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    trackConversions: true,
-    trackDynamicRemarketing: false,
-    enableConversionEventsFiltering: false,
-    enableDynamicRemarketingEventsFiltering: false,
-    eventsToTrackConversions: [{ eventName: productAdded }],
-    eventsToTrackDynamicRemarketing: [{ eventName: 'Product Added To The List' }],
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    trackConversions: false,
-    trackDynamicRemarketing: true,
-    enableConversionEventsFiltering: false,
-    enableDynamicRemarketingEventsFiltering: false,
-    eventsToTrackConversions: [{ eventName: productAdded }],
-    eventsToTrackDynamicRemarketing: [{ eventName: 'Product Added To The List' }],
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    trackConversions: true,
-    trackDynamicRemarketing: true,
-    enableConversionEventsFiltering: true,
-    enableDynamicRemarketingEventsFiltering: true,
-    eventsToTrackConversions: [{ eventName: orderCompleted }],
-    eventsToTrackDynamicRemarketing: [{ eventName: 'Product Added To The List' }],
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-  {
-    conversionID: mockConversionId,
-    conversionLinker: true,
-    defaultPageConversion: '9Hr5CKXCs4gYEIXBi58p',
-    disableAdPersonalization: false,
-    eventFilteringOption: 'disable',
-    sendPageView: true,
-    dynamicRemarketing: false,
-    trackConversions: true,
-    trackDynamicRemarketing: true,
-    enableConversionEventsFiltering: true,
-    enableDynamicRemarketingEventsFiltering: true,
-    eventsToTrackConversions: [{ eventName: orderCompleted }],
-    eventsToTrackDynamicRemarketing: [{ eventName: 'Product Added To The List' }],
-    eventMappingFromConfig: [
-      { from: 'Sign Up', to: 'Signup' },
-      { to: 'Lead', from: orderCompleted },
-      { from: 'Page View', to: 'PageVisit' },
-      { from: productAdded, to: 'AddToCart' },
-    ],
-    clickEventConversions: [
-      { conversionLabel: '15klCKLCs4gYEIXBi58p', name: 'Sign Up' },
-      { conversionLabel: '9Hr5CKXCs4gYEIXBi58p', name: 'Page View' },
-      { conversionLabel: 'TCBjCKjCs4gYEIXBi58p', name: orderCompleted },
-      { conversionLabel: 'KhF2CKvCs4gYEIXBi58p', name: productAdded },
-    ],
-  },
-];
-
-const trackCallPayload = {
-  message: {
-    context: {},
-    event: orderCompleted,
-    properties: {
-      event_id: 'purchaseId',
-      order_id: mockOrderId,
-      value: 35.0,
-      shipping: 4.0,
-      currency: 'IND',
-      products,
-    },
-  },
-};
-
-export {
-  products,
-  mockEvents,
-  mockOrderId,
-  productAdded,
-  orderCompleted,
-  googleAdsConfigs,
-  trackCallPayload,
-  mockConversionId,
-  mockEventTypeConversions,
-};