@jmartins-tillster/analytics-react-native 2.21.3

package/packages/plugins/plugin-firebase/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@segment/analytics-react-native-plugin-firebase",
+  "version": "0.4.3",
+  "description": "The hassle-free way to add Segment analytics to your React-Native app.",
+  "main": "lib/commonjs/index",
+  "scripts": {
+    "build": "bob build",
+    "test": "jest",
+    "typescript": "tsc --noEmit",
+    "clean": "rimraf lib node_modules"
+  },
+  "keywords": [
+    "segment",
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "module": "lib/module/index",
+  "types": "lib/typescript/src/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "segment-analytics-react-native.podspec",
+    "package.json",
+    "!src/**/*.e2e.mock.js",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/segmentio/analytics-react-native.git",
+    "directory": "packages/core"
+  },
+  "author": "Segment <hello@segment.com> (https://segment.com/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/segmentio/analytics-react-native/issues"
+  },
+  "homepage": "https://github.com/segmentio/analytics-react-native/tree/master/packages/plugins/plugin-firebase#readme",
+  "peerDependencies": {
+    "@react-native-firebase/analytics": ">=18.4.0",
+    "@react-native-firebase/app": ">=18.4.0",
+    "@segment/analytics-react-native": "^2.18.0"
+  },
+  "devDependencies": {
+    "@react-native-firebase/analytics": "^18.4.0",
+    "@react-native-firebase/app": "^18.4.0",
+    "@segment/analytics-react-native": "^2.18.0",
+    "@segment/analytics-rn-shared": "workspace:^",
+    "@segment/sovran-react-native": "^1.1.0",
+    "jest": "^29.7.0",
+    "react-native-builder-bob": "^0.23.1",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.2.2"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
+  },
+  "engines": {
+    "node": ">=12"
+  }
+}

package/packages/plugins/plugin-firebase/release.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['../../../release.config.js'],
+};

package/packages/plugins/plugin-firebase/src/FirebasePlugin.tsx

@@ -0,0 +1,96 @@
+import {
+  DestinationPlugin,
+  IdentifyEventType,
+  PluginType,
+  ScreenEventType,
+  SegmentError,
+  ErrorType,
+  TrackEventType,
+} from '@segment/analytics-react-native';
+import screen from './methods/screen';
+import track from './methods/track';
+import reset from './methods/reset';
+import firebaseAnalytics from '@react-native-firebase/analytics';
+export class FirebasePlugin extends DestinationPlugin {
+  type = PluginType.destination;
+  key = 'Firebase';
+
+  async identify(event: IdentifyEventType) {
+    if (event.userId !== undefined) {
+      await firebaseAnalytics().setUserId(event.userId);
+    }
+    if (event.traits) {
+      const eventTraits = event.traits;
+
+      const checkType = (value: unknown) => {
+        return typeof value === 'object' && !Array.isArray(value);
+      };
+      const safeTraits = Object.keys(eventTraits).reduce(
+        (acc: Record<string, string>, trait) => {
+          if (checkType(eventTraits[trait])) {
+            this.analytics?.logger.warn(
+              'We detected an object or array data type. Firebase does not accept nested traits.'
+            );
+
+            return acc;
+          }
+          if (trait !== undefined) {
+            acc[trait] =
+              typeof eventTraits[trait] === 'undefined'
+                ? ''
+                : eventTraits[trait]!.toString();
+          }
+          return acc;
+        },
+        {}
+      );
+
+      await firebaseAnalytics().setUserProperties(safeTraits);
+    }
+    return event;
+  }
+
+  async track(event: TrackEventType) {
+    try {
+      await track(event);
+    } catch (error) {
+      this.analytics?.reportInternalError(
+        new SegmentError(
+          ErrorType.PluginError,
+          'Error on Firebase Track',
+          error
+        )
+      );
+    }
+    return event;
+  }
+
+  async screen(event: ScreenEventType) {
+    try {
+      await screen(event);
+    } catch (error) {
+      this.analytics?.reportInternalError(
+        new SegmentError(
+          ErrorType.PluginError,
+          'Error on Firebase Track',
+          error
+        )
+      );
+    }
+    return event;
+  }
+
+  async reset() {
+    try {
+      await reset();
+    } catch (error) {
+      this.analytics?.reportInternalError(
+        new SegmentError(
+          ErrorType.PluginError,
+          'Error on Firebase Track',
+          error
+        )
+      );
+    }
+  }
+}

package/packages/plugins/plugin-firebase/src/index.ts

@@ -0,0 +1 @@
+export * from './FirebasePlugin';

package/packages/plugins/plugin-firebase/src/methods/___tests__/identify.test.ts

@@ -0,0 +1,73 @@
+import type { IdentifyEventType } from '@segment/analytics-react-native';
+import { FirebasePlugin } from '../../FirebasePlugin';
+
+const mockSetUserId = jest.fn();
+const mockSetUserProperties = jest.fn();
+
+jest.mock('@react-native-firebase/analytics', () => () => ({
+  setUserId: mockSetUserId,
+  setUserProperties: mockSetUserProperties,
+}));
+
+describe('#identify', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('forwards the identify event with ID only', async () => {
+    const plugin = new FirebasePlugin();
+    const event = {
+      type: 'identify',
+      userId: '123',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+    } as IdentifyEventType;
+
+    await plugin.identify(event);
+
+    expect(mockSetUserId).toHaveBeenCalledTimes(1);
+    expect(mockSetUserProperties).not.toHaveBeenCalled();
+    expect(mockSetUserId).toHaveBeenCalledWith('123');
+  });
+
+  it('forwards the identify event with ID and properties', async () => {
+    const plugin = new FirebasePlugin();
+    const event = {
+      type: 'identify',
+      userId: '123',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      traits: {
+        name: 'Mary',
+      },
+    } as IdentifyEventType;
+
+    await plugin.identify(event);
+
+    expect(mockSetUserId).toHaveBeenCalledTimes(1);
+    expect(mockSetUserProperties).toHaveBeenCalledTimes(1);
+    expect(mockSetUserId).toHaveBeenCalledWith('123');
+    expect(mockSetUserProperties).toHaveBeenCalledWith({ name: 'Mary' });
+  });
+
+  it('forwards the identify event without ID', async () => {
+    const plugin = new FirebasePlugin();
+    const event = {
+      type: 'identify',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      traits: {
+        name: 'Mary',
+      },
+    } as IdentifyEventType;
+
+    await plugin.identify(event);
+
+    expect(mockSetUserId).not.toHaveBeenCalled();
+    expect(mockSetUserProperties).toHaveBeenCalledTimes(1);
+    expect(mockSetUserProperties).toHaveBeenCalledWith({ name: 'Mary' });
+  });
+});

package/packages/plugins/plugin-firebase/src/methods/___tests__/reset.test.ts

@@ -0,0 +1,20 @@
+import reset from '../reset';
+
+const mockReset = jest.fn();
+
+jest.mock('@react-native-firebase/analytics', () => () => ({
+  resetAnalyticsData: mockReset,
+}));
+
+describe('#reset', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('forwards the reset event', async () => {
+    await reset();
+
+    expect(mockReset).toHaveBeenCalledTimes(1);
+    expect(mockReset).toHaveBeenCalledWith();
+  });
+});

package/packages/plugins/plugin-firebase/src/methods/___tests__/screen.test.ts

@@ -0,0 +1,33 @@
+import type { ScreenEventType } from '@segment/analytics-react-native';
+import screen from '../screen';
+
+const mockScreen = jest.fn();
+
+jest.mock('@react-native-firebase/analytics', () => () => ({
+  logScreenView: mockScreen,
+}));
+
+describe('#screen', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('forwards the screen event', async () => {
+    const event = {
+      type: 'screen',
+      name: 'HomeScreen',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      properties: {},
+    } as ScreenEventType;
+
+    await screen(event);
+
+    expect(mockScreen).toHaveBeenCalledTimes(1);
+    expect(mockScreen).toHaveBeenCalledWith({
+      screen_name: 'HomeScreen',
+      screen_class: 'HomeScreen',
+    });
+  });
+});

package/packages/plugins/plugin-firebase/src/methods/___tests__/track.test.ts

@@ -0,0 +1,85 @@
+import { EventType, TrackEventType } from '@segment/analytics-react-native';
+import track from '../track';
+
+jest.mock('uuid');
+
+const mockLogEvent = jest.fn();
+
+jest.mock('@react-native-firebase/analytics', () => () => ({
+  logEvent: mockLogEvent,
+}));
+
+describe('#track', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('forwards a track event with name only', async () => {
+    const event = {
+      type: EventType.TrackEvent,
+      event: 'test_event',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      properties: {},
+    } as TrackEventType;
+
+    await track(event);
+
+    expect(mockLogEvent).toHaveBeenCalledTimes(1);
+    expect(mockLogEvent).toHaveBeenCalledWith('test_event', {});
+  });
+
+  it('forwards a track event with name and properties', async () => {
+    const event = {
+      type: EventType.TrackEvent,
+      event: 'another_test_event',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      properties: { foo: 'bar' },
+    } as TrackEventType;
+
+    await track(event);
+
+    expect(mockLogEvent).toHaveBeenCalledTimes(1);
+    expect(mockLogEvent).toHaveBeenCalledWith('another_test_event', {
+      foo: 'bar',
+    });
+  });
+
+  it('removes non-alphanumeric characters from', async () => {
+    const event = {
+      type: EventType.TrackEvent,
+      event: 'yet another!!test$%^&event-CAPS',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      properties: {},
+    } as TrackEventType;
+
+    await track(event);
+
+    expect(mockLogEvent).toHaveBeenCalledTimes(1);
+    expect(mockLogEvent).toHaveBeenCalledWith(
+      'yet_another__test____event_CAPS',
+      {}
+    );
+  });
+
+  it('converts the event name to firebase event when applicable', async () => {
+    const event = {
+      type: EventType.TrackEvent,
+      event: 'Order Refunded',
+      anonymousId: 'anon',
+      messageId: 'message-id',
+      timestamp: '00000',
+      properties: {},
+    } as TrackEventType;
+
+    await track(event);
+
+    expect(mockLogEvent).toHaveBeenCalledTimes(1);
+    expect(mockLogEvent).toHaveBeenCalledWith('refund', {});
+  });
+});

package/packages/plugins/plugin-firebase/src/methods/parameterMapping.ts

@@ -0,0 +1,45 @@
+import { isString } from '@segment/analytics-react-native';
+
+const mapEventNames: { [key: string]: string } = {
+  'Product Clicked': 'select_content',
+  'Product Viewed': 'view_item',
+  'Product Added': 'add_to_cart',
+  'Product Removed': 'remove_from_cart',
+  'Checkout Started': 'begin_checkout',
+  'Promotion Viewed': 'view_promotion',
+  'Payment Info Entered': 'add_payment_info',
+  'Order Completed': 'purchase',
+  'Order Refunded': 'refund',
+  'Product List Viewed': 'view_item_list',
+  'Product Added to Wishlist': 'add_to_wishlist',
+  'Product Shared': 'share',
+  'Cart Shared': 'share',
+  'Products Searched': 'search',
+  'Cart Viewed': 'view_cart',
+};
+
+export const mapEventProps: { [key: string]: string } = {
+  price: 'price',
+  total: 'value',
+  products: 'items',
+  name: 'item_name',
+  product_id: 'item_id',
+  productId: 'item_id',
+  category: 'item_category',
+  query: 'search_term',
+  order_id: 'transaction_id',
+  quantity: 'quantity',
+  shipping: 'shipping',
+  tax: 'tax',
+  revenue: 'revenue',
+  currency: 'currency',
+};
+
+export const transformMap: { [key: string]: (value: unknown) => unknown } = {
+  event: (value: unknown) => {
+    if (isString(value) && value in mapEventNames) {
+      return mapEventNames[value];
+    }
+    return value;
+  },
+};

package/packages/plugins/plugin-firebase/src/methods/reset.ts

@@ -0,0 +1,5 @@
+import firebaseAnalytics from '@react-native-firebase/analytics';
+
+export default async () => {
+  await firebaseAnalytics().resetAnalyticsData();
+};

package/packages/plugins/plugin-firebase/src/methods/screen.ts

@@ -0,0 +1,12 @@
+import firebaseAnalytics from '@react-native-firebase/analytics';
+import type { ScreenEventType } from '@segment/analytics-react-native';
+
+export default async (event: ScreenEventType) => {
+  const screenProps = {
+    screen_name: event.name,
+    screen_class: event.name,
+    ...event.properties,
+  };
+
+  await firebaseAnalytics().logScreenView(screenProps);
+};

package/packages/plugins/plugin-firebase/src/methods/track.ts

@@ -0,0 +1,26 @@
+import firebaseAnalytics from '@react-native-firebase/analytics';
+import {
+  generateMapTransform,
+  TrackEventType,
+} from '@segment/analytics-react-native';
+import { mapEventProps, transformMap } from './parameterMapping';
+
+const mappedPropNames = generateMapTransform(mapEventProps, transformMap);
+
+const sanitizeName = (name: string) => {
+  return name.replace(/[^a-zA-Z0-9]/g, '_');
+};
+
+export default async (event: TrackEventType) => {
+  const safeEvent = mappedPropNames(
+    event as unknown as Record<string, unknown>
+  );
+  const convertedName = safeEvent.event as string;
+  let safeEventName = sanitizeName(convertedName);
+  const safeProps = safeEvent.properties as { [key: string]: unknown };
+  // Clip the event name if it exceeds 40 characters
+  if (safeEventName.length > 40) {
+    safeEventName = safeEventName.substring(0, 40);
+  }
+  await firebaseAnalytics().logEvent(safeEventName, safeProps);
+};

package/packages/plugins/plugin-firebase/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "lib/typescript",
+    "rootDir": ".",
+    "baseUrl": "."
+  },
+  "include": ["src/**/*", "types.d.ts"],
+  "references": [{ "path": "../../core" }]
+}

package/packages/plugins/plugin-idfa/CHANGELOG.md

@@ -0,0 +1,62 @@
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.19.1
+
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.19.0
+* **@segment/sovran-react-native:** upgraded to 1.1.1
+
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.18.0
+* **@segment/sovran-react-native:** upgraded to 1.1.0
+
+## [@segment/analytics-react-native-plugin-idfa-v0.6.2](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.6.1...@segment/analytics-react-native-plugin-idfa-v0.6.2) (2023-04-18)
+
+
+### Bug Fixes
+
+* stricter linting, improved handling of plugin errrors ([#795](https://github.com/segmentio/analytics-react-native/issues/795)) ([1ddb4d5](https://github.com/segmentio/analytics-react-native/commit/1ddb4d571df794bc7eaa5c5302ed27b90faf9a73)), closes [#799](https://github.com/segmentio/analytics-react-native/issues/799) [#803](https://github.com/segmentio/analytics-react-native/issues/803) [#802](https://github.com/segmentio/analytics-react-native/issues/802)
+
+## [@segment/analytics-react-native-plugin-idfa-v0.6.1](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.6.0...@segment/analytics-react-native-plugin-idfa-v0.6.1) (2023-03-15)
+
+
+### Bug Fixes
+
+* async-storage as optional peer dependency ([#779](https://github.com/segmentio/analytics-react-native/issues/779)) ([f3d5bc0](https://github.com/segmentio/analytics-react-native/commit/f3d5bc024fe3ae988386aac8b9f6f3fc6d84677a))
+
+## [@segment/analytics-react-native-plugin-idfa-v0.6.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.5.0...@segment/analytics-react-native-plugin-idfa-v0.6.0) (2023-01-09)
+
+
+### Features
+
+* added errorHandler option to client ([#713](https://github.com/segmentio/analytics-react-native/issues/713)) ([b95788b](https://github.com/segmentio/analytics-react-native/commit/b95788ba8ecb547ffc9f43ba94f628c25f3660d1))
+
+## [@segment/analytics-react-native-plugin-idfa-v0.5.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.4.1...@segment/analytics-react-native-plugin-idfa-v0.5.0) (2022-09-13)
+
+
+### Features
+
+* adds option to provide a custom logger object to consume library logs ([#670](https://github.com/segmentio/analytics-react-native/issues/670)) ([d40a315](https://github.com/segmentio/analytics-react-native/commit/d40a315e380cf2ce7a1f7805b85893b6370fbe6f))
+
+## [@segment/analytics-react-native-plugin-idfa-v0.4.1](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.4.0...@segment/analytics-react-native-plugin-idfa-v0.4.1) (2022-07-28)
+
+
+### Bug Fixes
+
+* replace allSettled shim, fix imports from plugins ([#620](https://github.com/segmentio/analytics-react-native/issues/620)) ([18f8ecd](https://github.com/segmentio/analytics-react-native/commit/18f8ecdb291d8c5ecb02e087aa0043df4fc72e97))
+
+## [@segment/analytics-react-native-plugin-idfa-v0.4.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.3.0...@segment/analytics-react-native-plugin-idfa-v0.4.0) (2022-07-15)
+
+
+### Features
+
+* spin off the queue handling into a reusable plugin ([#502](https://github.com/segmentio/analytics-react-native/issues/502)) ([55d7988](https://github.com/segmentio/analytics-react-native/commit/55d798821163d5a41902a6bc099b1bfcbd853a17))
+
+## [@segment/analytics-react-native-plugin-idfa-v0.3.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-idfa-v0.2.1...@segment/analytics-react-native-plugin-idfa-v0.3.0) (2022-06-24)
+
+
+### Features
+
+* plugin-idfa: Add support for iOS 13 and below ([#554](https://github.com/segmentio/analytics-react-native/issues/554)) ([40be1ab](https://github.com/segmentio/analytics-react-native/commit/40be1abbcff26871c89f0029250b3d4da7c37249))

package/packages/plugins/plugin-idfa/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Segment
+
+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.