coveo.analytics 2.20.26 → 2.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.20.26",
+    "version": "2.22.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -23,7 +23,6 @@
     },
     "license": "MIT",
     "dependencies": {
-        "@react-native-async-storage/async-storage": "^1.17.10",
         "cross-fetch": "^3.1.5"
     },
     "devDependencies": {
@@ -51,10 +50,11 @@
         "rimraf": "^3.0.2",
         "rollup": "^2.50.6",
         "rollup-plugin-serve": "^1.0.1",
+        "rollup-plugin-terser": "^7.0.2",
         "rollup-plugin-typescript2": "^0.27.0",
-        "rollup-plugin-uglify": "^6.0.4",
+        "stylelint": "^13.6.1",
         "ts-jest": "^25.2.0",
-        "tsjs": "1.0.3",
+        "tsjs": "4.2.1",
         "typescript": "^3.8.3"
     },
     "overrides": {
@@ -65,6 +65,7 @@
         "dist/**/*.js",
         "dist/**/*.js.map",
         "src/**/*.ts",
+        "react-native/",
         "LICENSE"
     ],
     "husky": {

package/react-native/package.json

@@ -0,0 +1,9 @@
+{
+    "private": true,
+    "name": "react-native",
+    "description": "Coveo analytics client for React Native",
+    "main": "../dist/react-native.es.js",
+    "module": "../dist/react-native.es.js",
+    "types": "../dist/definitions/react-native/index.d.ts",
+    "license": "MIT"
+}

package/src/client/analytics.ts

@@ -87,6 +87,11 @@ export interface BufferedRequest {
 type ProcessPayloadStep = (currentPayload: any) => any;
 type AsyncProcessPayloadStep = (currentPayload: any) => Promise<any>;
 
+export function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version) {
+    const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
+    return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${apiVersion}`;
+}
+
 export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider {
     private get defaultOptions(): ClientOptions {
         return {
@@ -469,9 +474,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     private get baseUrl(): string {
-        const {version, endpoint} = this.options;
-        const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-        return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${version}`;
+        return buildBaseUrl(this.options.endpoint, this.options.version);
     }
 }
 

package/src/react-native/index.ts

@@ -1,3 +1,2 @@
-// TODO: v3 add in "coveo.analytics/react-native" subpackage
-export {ReactNativeRuntime} from './react-native-runtime';
-export {ReactNativeStorage} from './react-native-storage';
+export {ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage} from './react-native-runtime';
+export * from '../coveoua/headless';

package/src/react-native/react-native-runtime.ts

@@ -1,17 +1,45 @@
 import {WebStorage} from '../storage';
 import {AnalyticsFetchClient} from '../client/analyticsFetchClient';
-import {ReactNativeStorage} from './react-native-storage';
 import {IRuntimeEnvironment} from '../client/runtimeEnvironment';
-import {IAnalyticsClientOptions} from '../client/analyticsRequestClient';
+import {PreprocessAnalyticsRequest} from '../client/analyticsRequestClient';
+import {uuidv4} from '../client/crypto';
+import {buildBaseUrl} from '../client/analytics';
+
+export type ReactNativeStorage = WebStorage;
+
+export interface ReactNativeRuntimeOptions {
+    /**
+     * Mandatory Storage implementation.
+     *
+     * We recommend using a storage library. There are a few options presented in the readme: https://github.com/coveo/coveo.analytics.js#using-react-native
+     */
+    storage: ReactNativeStorage;
+    /**
+     * Key for storing the visitor ID value.
+     * @defaut visitorId
+     */
+    visitorIdKey?: string;
+    token?: string;
+    version?: string;
+    endpoint?: string;
+    preprocessRequest?: PreprocessAnalyticsRequest;
+}
 
 export class ReactNativeRuntime implements IRuntimeEnvironment {
-    public storage: WebStorage;
     public client: AnalyticsFetchClient;
+    public storage: ReactNativeStorage;
 
-    // TODO: v3 switch to ClientOptions type, add default options
-    // TODO: v3 reuse own ReactNativeStorage to implement VisitorIdProvider's getCurrentVisitorId, setCurrentVisitorId
-    constructor(clientOptions: IAnalyticsClientOptions) {
-        this.storage = new ReactNativeStorage();
-        this.client = new AnalyticsFetchClient(clientOptions);
+    constructor(options: ReactNativeRuntimeOptions) {
+        const visitorIdKey = options.visitorIdKey ?? 'visitorId';
+        this.storage = options.storage;
+        this.client = new AnalyticsFetchClient({
+            preprocessRequest: options.preprocessRequest,
+            token: options.token,
+            baseUrl: buildBaseUrl(options.endpoint, options.version),
+            visitorIdProvider: {
+                getCurrentVisitorId: async () => (await this.storage.getItem(visitorIdKey)) || uuidv4(),
+                setCurrentVisitorId: (visitorId: string) => this.storage.setItem(visitorIdKey, visitorId),
+            },
+        });
     }
 }

package/src/react-native/react-native-utils.ts

@@ -1,16 +1,7 @@
 export const ReactNativeRuntimeWarning = `
         We've detected you're using React Native but have not provided the corresponding runtime, 
-        for an optimal experience please install @react-native-async-storage/async-storage and instantiate 
-        your analytics client as follows:
-        
-        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';
-        
-        const analytics = new CoveoAnalyticsClient({
-            ...your options,
-            runtimeEnvironment: new ReactNativeRuntime({
-                baseUrl: '...',
-            });
-        })
+        for an optimal experience please use the "coveo.analytics/react-native" subpackage.
+        Follow the Readme on how to set it up: https://github.com/coveo/coveo.analytics.js#using-react-native
     `;
 
 export function isReactNative() {

package/src/react-native/react-native.spec.ts

@@ -7,8 +7,11 @@ describe('ReactNativeRuntime', () => {
 
     beforeEach(() => {
         runtimeEnvironment = new ReactNativeRuntime({
-            baseUrl: 'https://www.coveo.com',
-            visitorIdProvider: {getCurrentVisitorId: jest.fn(), setCurrentVisitorId: jest.fn()},
+            storage: {
+                getItem: jest.fn(),
+                setItem: jest.fn(),
+                removeItem: jest.fn(),
+            },
         });
         client = new CoveoAnalyticsClient({runtimeEnvironment});
     });

package/dist/definitions/react-native/react-native-storage.d.ts

@@ -1,6 +0,0 @@
-import { WebStorage } from '../storage';
-export declare class ReactNativeStorage implements WebStorage {
-    getItem(key: string): Promise<string | null>;
-    setItem(key: string, data: string): Promise<void>;
-    removeItem(key: string): Promise<void>;
-}

package/dist/definitions/src/react-native/react-native-storage.d.ts

@@ -1,6 +0,0 @@
-import { WebStorage } from '../storage';
-export declare class ReactNativeStorage implements WebStorage {
-    getItem(key: string): Promise<string | null>;
-    setItem(key: string, data: string): Promise<void>;
-    removeItem(key: string): Promise<void>;
-}

package/src/react-native/react-native-storage.ts

@@ -1,14 +0,0 @@
-import {WebStorage} from '../storage';
-import AsyncStorage from '@react-native-async-storage/async-storage';
-
-export class ReactNativeStorage implements WebStorage {
-    async getItem(key: string) {
-        return AsyncStorage.getItem(key);
-    }
-    async setItem(key: string, data: string) {
-        return AsyncStorage.setItem(key, data);
-    }
-    async removeItem(key: string) {
-        AsyncStorage.removeItem(key);
-    }
-}