castled-js-sdk 0.0.2 → 0.0.4

package/LICENSE

@@ -1,67 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Castled Data
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
----
-MIT License
-
-Copyright (c) 2023 Hightouch
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
----
-MIT License
-
-Copyright (c) 2021 RudderStack
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/__mocks__/BraveBrowser.js

@@ -1,9 +0,0 @@
-class BraveBrowser {
-  constructor() {}
-
-  isBrave() {
-    return true;
-  }
-}
-
-export default BraveBrowser;

package/__mocks__/fixtures.js

@@ -1,130 +0,0 @@
-const dummyWriteKey = 'dummyWriteKey';
-
-const dummyDataplaneHost = 'https://dummy.dataplane.host.com';
-const sdkName = 'Events SDK JavaScript';
-const errorMessage = 'order number must be an integer';
-const actualErrorMessage = '[Transformation]:: order number must be an integer';
-
-const samplePageEvent = {
-  message: {
-    channel: 'web',
-    context: {
-      library: {
-        name: sdkName,
-        version: '2.5.2',
-      },
-    },
-    type: 'page',
-    messageId: 'a65e19c7-a937-4c7a-8349-8d1c7e9bbf9f',
-    originalTimestamp: '2022-07-23T15:18:36.998Z',
-    anonymousId: '1f7618d8-6ada-4d1c-b2c8-923fbfdd142d',
-    userId: '',
-    event: null,
-    properties: {
-      name: 'page view',
-      path: '/',
-      referrer: '$direct',
-      referring_domain: '',
-      search: '',
-      title: 'Document',
-      url: 'http://localhost:4000/',
-      tab_url: 'http://localhost:4000/',
-      initial_referrer: '$direct',
-      initial_referring_domain: '',
-    },
-    integrations: {
-      All: true,
-    },
-    user_properties: null,
-    name: 'page view',
-  },
-};
-
-const retryCount = 3;
-const samplePayloadSuccess = {
-  transformedBatch: [
-    {
-      id: '2CO2YmLozA3SZe6JtmdmMKTrCOl',
-      payload: [
-        {
-          orderNo: 1659505271417,
-          status: '200',
-          event: {
-            message: {
-              anonymousId: '7105960b-0174-4d31-a7a1-561925dedde3',
-              channel: 'web',
-              context: {
-                library: {
-                  name: sdkName,
-                  version: '2.9.2',
-                },
-              },
-              integrations: {
-                All: true,
-              },
-              messageId: '1659505271412300-2d882451-7f50-4f23-b5ac-919fa8a1957d',
-              name: 'page view 123',
-              originalTimestamp: '2022-08-03T05:41:11.412Z',
-              properties: {},
-              type: 'page',
-            },
-          },
-        },
-      ],
-    },
-  ],
-};
-
-const samplePayloadPartialSuccess = {
-  transformedBatch: [
-    {
-      id: '2CO2YmLozA3SZe6JtmdmMKTrCOl',
-      payload: [
-        {
-          orderNo: 1659505271417,
-          status: '200',
-          event: {
-            message: {
-              anonymousId: '7105960b-0174-4d31-a7a1-561925dedde3',
-              channel: 'web',
-              context: {
-                library: {
-                  name: sdkName,
-                  version: '2.9.2',
-                },
-              },
-              integrations: {
-                All: true,
-              },
-              messageId: '1659505271412300-2d882451-7f50-4f23-b5ac-919fa8a1957d',
-              name: 'page view 123',
-              originalTimestamp: '2022-08-03T05:41:11.412Z',
-              properties: {},
-              type: 'page',
-            },
-          },
-        },
-      ],
-    },
-    {
-      id: '2CO2YmLozA3SZe6JtmdmMKTrCKr',
-      payload: [
-        {
-          orderNo: 1659505271418,
-          status: '400',
-        },
-      ],
-    },
-  ],
-};
-
-export {
-  dummyWriteKey,
-  dummyDataplaneHost,
-  retryCount,
-  samplePageEvent,
-  samplePayloadSuccess,
-  samplePayloadPartialSuccess,
-  errorMessage,
-  actualErrorMessage,
-};

package/__mocks__/msw.handlers.js

@@ -1,34 +0,0 @@
-import { rest } from 'msw';
-import {
-  dummyDataplaneHost,
-  samplePayloadSuccess,
-  samplePayloadPartialSuccess,
-  errorMessage,
-} from './fixtures';
-
-const handlers = [
-  rest.post(`${dummyDataplaneHost}/success/transform`, (req, res, ctx) => {
-    return res(ctx.status(200), ctx.json(samplePayloadSuccess));
-  }),
-  rest.post(`${dummyDataplaneHost}/partialSuccess/transform`, (req, res, ctx) => {
-    return res(ctx.status(200), ctx.json(samplePayloadPartialSuccess));
-  }),
-  rest.post(`${dummyDataplaneHost}/invalidResponse/transform`, (req, res, ctx) => {
-    return res(
-      ctx.status(200),
-      ctx.text(samplePayloadSuccess),
-      ctx.set('Content-Type', 'application/json; charset=utf-8'),
-    );
-  }),
-  rest.post(`${dummyDataplaneHost}/badRequest/transform`, (req, res, ctx) => {
-    return res(ctx.status(400), ctx.text(errorMessage));
-  }),
-  rest.post(`${dummyDataplaneHost}/accessDenied/transform`, (req, res, ctx) => {
-    return res(ctx.status(404));
-  }),
-  rest.post(`${dummyDataplaneHost}/serverDown/transform`, (req, res, ctx) => {
-    return res(ctx.status(500));
-  }),
-];
-
-export { handlers };

package/__mocks__/msw.server.js

@@ -1,6 +0,0 @@
-import { setupServer } from 'msw/node';
-import { handlers } from './msw.handlers';
-
-const server = setupServer(...handlers);
-
-export { server };

package/__tests__/camelcase.test.js

@@ -1,29 +0,0 @@
-import camelcase from '../src/utils/camelcase';
-
-test('convert string with space to camelcase format', () => {
-  expect(camelcase('camel case')).toBe('camelCase');
-});
-
-test('convert string with underscore to camelcase format', () => {
-  expect(camelcase('camel_case')).toBe('camelCase');
-});
-
-test('convert string with first letter capital to camelcase format', () => {
-  expect(camelcase('Camelcase')).toBe('camelcase');
-});
-
-test('convert uppercase string to camelcase format', () => {
-  expect(camelcase('CAMELCASE')).toBe('camelcase');
-});
-
-test('convert string with first letter capital for each word to camelcase format', () => {
-  expect(camelcase('Camel Case')).toBe('camelCase');
-});
-
-test('convert non-string values', () => {
-  expect(camelcase(123)).toBe('123');
-});
-
-test('convert invalid values', () => {
-  expect(camelcase()).toBe('');
-});

package/__tests__/data-residency.test.js

@@ -1,238 +0,0 @@
-import { resolveDataPlaneUrl } from '../src/utils/utils';
-
-const usDataplaneUrl = 'https://sample.rudderlabs.com/us';
-const euDataplaneUrl = 'https://sample.rudderlabs.com/eu';
-const serverUrl = 'https://sample.rudderlabs.com';
-
-const sourceConfigWithBothDataPlane = {
-  source: {
-    dataplanes: {
-      US: [
-        {
-          url: usDataplaneUrl,
-          default: true,
-        },
-      ],
-      EU: [
-        {
-          url: euDataplaneUrl,
-          default: true,
-        },
-      ],
-    },
-  },
-};
-
-const sourceConfigWithUSDataPlane = {
-  source: {
-    dataplanes: {
-      US: [
-        {
-          url: usDataplaneUrl,
-          default: true,
-        },
-      ],
-    },
-  },
-};
-
-const sourceConfigWithEUDataPlane = {
-  source: {
-    dataplanes: {
-      EU: [
-        {
-          url: euDataplaneUrl,
-          default: true,
-        },
-      ],
-    },
-  },
-};
-const sourceConfigWithEmptyDataPlanes = { source: {} };
-
-const invalidResidencyServer1 = { residencyServer: 1234 };
-const invalidResidencyServer2 = { residencyServer: 'test' };
-const validResidencyServerUS = { residencyServer: 'US' };
-const validResidencyServerEU = { residencyServer: 'EU' };
-
-const testCaseData = [
-  // {
-  //   description:
-  //     'When dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-  //   input: {
-  //     response: sourceConfigWithEmptyDataPlanes,
-  //   },
-  //   output: DEFAULT_DATAPLANE_URL,
-  // },
-  {
-    description:
-      'When dataplane is not provided in source config but provided in load API, dataplane Url from load option will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      serverUrl: serverUrl,
-    },
-    output: serverUrl,
-  },
-  {
-    description: 'When dataplane is provided in source config that dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithBothDataPlane,
-      serverUrl: serverUrl,
-    },
-    output: usDataplaneUrl,
-  },
-  // {
-  //   description:
-  //     'In case of invalid residencyServer option: dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-  //   input: {
-  //     response: sourceConfigWithEmptyDataPlanes,
-  //     options: invalidResidencyServer1,
-  //   },
-  //   output: DEFAULT_DATAPLANE_URL,
-  // },
-  {
-    description:
-      'In case of invalid residencyServer option: dataplane is not provided in source config but provided in load API, dataplane Url from load option will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      serverUrl: serverUrl,
-      options: invalidResidencyServer2,
-    },
-    output: serverUrl,
-  },
-  {
-    description:
-      'In case of invalid residencyServer option: dataplane is provided in source config that dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithBothDataPlane,
-      serverUrl: serverUrl,
-      options: invalidResidencyServer1,
-    },
-    output: usDataplaneUrl,
-  },
-  // {
-  //   description:
-  //     'In case of valid residencyServer(US) option: dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-  //   input: {
-  //     response: sourceConfigWithEmptyDataPlanes,
-  //     options: validResidencyServerUS,
-  //   },
-  //   output: DEFAULT_DATAPLANE_URL,
-  // },
-  {
-    description:
-      'In case of valid residencyServer(US) option: dataplane is not provided in source config but provided in load API, dataplane Url from load option will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      serverUrl: serverUrl,
-      options: validResidencyServerUS,
-    },
-    output: serverUrl,
-  },
-  {
-    description:
-      'In case of valid residencyServer(US) option: dataplane is provided in source config that dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithBothDataPlane,
-      serverUrl: serverUrl,
-      options: validResidencyServerUS,
-    },
-    output: usDataplaneUrl,
-  },
-  {
-    description:
-      'In case of valid residencyServer(US) option: dataplane is provided but US region not available in source config then load API dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithEUDataPlane,
-      serverUrl: serverUrl,
-      options: validResidencyServerUS,
-    },
-    output: serverUrl,
-  },
-  // {
-  //   description:
-  //     'In case of valid residencyServer(EU) option: dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-  //   input: {
-  //     response: sourceConfigWithEmptyDataPlanes,
-  //     options: validResidencyServerEU,
-  //   },
-  //   output: DEFAULT_DATAPLANE_URL,
-  // },
-  {
-    description:
-      'In case of valid residencyServer(EU) option: dataplane is not provided in source config but provided in load API, dataplane Url from load option will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      serverUrl: serverUrl,
-      options: validResidencyServerEU,
-    },
-    output: serverUrl,
-  },
-  {
-    description:
-      'In case of valid residencyServer(EU) option: dataplane is provided in source config that dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithBothDataPlane,
-      serverUrl: serverUrl,
-      options: validResidencyServerEU,
-    },
-    output: euDataplaneUrl,
-  },
-  {
-    description:
-      'In case of valid residencyServer(EU) option: dataplane is provided only for US region not available in source config then US region dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithUSDataPlane,
-      serverUrl: serverUrl,
-      options: validResidencyServerEU,
-    },
-    output: usDataplaneUrl,
-  },
-];
-
-const testCaseDataWithInvalidDataplaneUrl = [
-  {
-    description:
-      'When dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      serverUrl: null
-    },
-  },
-  {
-    description:
-      'In case of invalid residencyServer option: dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      options: invalidResidencyServer1,
-    },
-  },
-   {
-    description:
-      'In case of valid residencyServer(US) option: dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      options: validResidencyServerUS,
-    },
-  },
-  {
-    description:
-      'In case of valid residencyServer(EU) option: dataplane is not provided in source config or in load API, default dataplane Url will be selected',
-    input: {
-      response: sourceConfigWithEmptyDataPlanes,
-      options: validResidencyServerEU,
-    },
-  },
-]
-
-test.each(testCaseData)('$description', ({ input, output }) => {
-  const url = resolveDataPlaneUrl(input.response, input.serverUrl, input.options);
-  expect(url).toEqual(output);
-});
-
-test.each(testCaseDataWithInvalidDataplaneUrl)('$description', ({ input }) => {
-  const url = () => resolveDataPlaneUrl(input.response, input.serverUrl, input.options);
-  expect(url).toThrow(
-    'Unable to load the SDK due to invalid data plane url'
-  );
-});

package/__tests__/features/core/metrics/errorReporting/ErrorReportingService.test.js

@@ -1,80 +0,0 @@
-import { ErrorReportingService } from '../../../../../src/features/core/metrics/errorReporting/ErrorReportingService';
-import logger from '../../../../../src/utils/logUtil';
-
-const errorReportingService = new ErrorReportingService(logger);
-const DEFAULT_ERROR_REPORT_PROVIDER = 'rs-bugsnag';
-const sourceId = 'random-source-id';
-
-describe('Error reporting service Test suite', () => {
-  test('Should print error message and return if source config or sourceId is not provided in init call', () => {
-    const outcome = errorReportingService.init();
-    expect(outcome).toBe(undefined);
-  });
-  test('Should not initialize provider if not enabled from source config in init call', () => {
-    errorReportingService.init({ statsCollection: { errors: { enabled: false } } }, sourceId);
-    expect(errorReportingService.isEnabled).toEqual(false);
-  });
-  test('Should initialize provider if enabled from source config in init call', async () => {
-    errorReportingService.init({ statsCollection: { errors: { enabled: true } } }, sourceId);
-    expect(errorReportingService.isEnabled).toEqual(true);
-  });
-  test('Should initialize default provider if enabled from source config but provider name is not there', async () => {
-    window.bugsnag = jest.fn(() => ({ notifier: { version: '6.0.0' } }));
-    errorReportingService.exposeToGlobal = jest.fn();
-    errorReportingService.onClientReady = jest.fn(() => errorReportingService.exposeToGlobal());
-    errorReportingService.init({ statsCollection: { errors: { enabled: true } } }, sourceId);
-    expect(errorReportingService.providerName).toEqual(DEFAULT_ERROR_REPORT_PROVIDER);
-    expect(errorReportingService.onClientReady).toHaveBeenCalledTimes(1);
-    expect(errorReportingService.exposeToGlobal).toHaveBeenCalledTimes(1);
-  });
-  test('Should not initialize provider if provider from source config does not match with SDK supported list', async () => {
-    window.bugsnag = undefined;
-    errorReportingService.init(
-      { statsCollection: { errors: { enabled: true, provider: 'test' } } },
-      sourceId,
-    );
-    expect(errorReportingService.provider.client).toEqual(undefined);
-    expect(errorReportingService.onClientReady).toHaveBeenCalledTimes(0);
-  });
-  test('Should not initialize provider if the enabled flag is missing from the source config (default state is to not load)', async () => {
-    window.bugsnag = undefined;
-    errorReportingService.init({ statsCollection: { errors: { provider: 'test' } } }, sourceId);
-    expect(errorReportingService.provider.client).toEqual(undefined);
-    expect(errorReportingService.onClientReady).toHaveBeenCalledTimes(0);
-  });
-  test('Should not initialize provider if the error collection enabled flag is not a boolean', async () => {
-    window.bugsnag = undefined;
-    errorReportingService.init(
-      { statsCollection: { errors: { enabled: 'true', provider: 'test' } } },
-      sourceId,
-    );
-    expect(errorReportingService.provider.client).toEqual(undefined);
-    expect(errorReportingService.onClientReady).toHaveBeenCalledTimes(0);
-  });
-});
-
-describe('Bugsnag Test suite', () => {
-  test('Should not initialize bugsnag if version > 6 of bugsnag is present in window scope', async () => {
-    window.bugsnag = { _client: { _notifier: { version: '7.0.0' } } };
-    errorReportingService.init({ statsCollection: { errors: { enabled: true } } }, sourceId);
-    expect(errorReportingService.provider.client).toEqual(undefined);
-  });
-  test('Should not initialize bugsnag if version <6 of bugsnag is present in window scope', async () => {
-    window.bugsnag = jest.fn(() => ({ notifier: { version: '4.0.0' } }));
-    errorReportingService.init({ statsCollection: { errors: { enabled: true } } }, sourceId);
-    expect(errorReportingService.provider.client).toEqual(undefined);
-  });
-  test('Should initialize bugsnag if version 6 of bugsnag is present in window scope', async () => {
-    window.bugsnag = jest.fn(() => ({ notifier: { version: '6.0.0' } }));
-    errorReportingService.init({ statsCollection: { errors: { enabled: true } } }, sourceId);
-    expect(errorReportingService.provider.client).not.toBe(undefined);
-  });
-  test('Should initialize Bugsnag if provider from source config matches with SDK supported list', async () => {
-    window.bugsnag = jest.fn(() => ({ notifier: { version: '6.0.0' } }));
-    errorReportingService.init(
-      { statsCollection: { errors: { enabled: true, provider: 'rs-bugsnag' } } },
-      sourceId,
-    );
-    expect(errorReportingService.provider.client).not.toEqual(undefined);
-  });
-});

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

@@ -1,17 +0,0 @@
-const event = 'Add to Cart';
-const query = 'Sport T-Shirt';
-const products = [
-  {
-    product_id: '123',
-    sku: 'G-14',
-    price: 14.99,
-    quantity: 2,
-  },
-  {
-    product_id: '345',
-    sku: 'G-32',
-    price: 3.99,
-  },
-];
-
-export { event, query, products };