coveo.analytics 2.21.27 → 2.22.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.21.27",
+    "version": "2.22.2",
     "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,8 +50,8 @@
         "rimraf": "^3.0.2",
         "rollup": "^2.50.6",
         "rollup-plugin-serve": "^1.0.1",
-        "rollup-plugin-typescript2": "^0.27.0",
         "rollup-plugin-terser": "^7.0.2",
+        "rollup-plugin-typescript2": "^0.27.0",
         "stylelint": "^13.6.1",
         "ts-jest": "^25.2.0",
         "tsjs": "4.2.1",
@@ -66,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/insight/insightClient.spec.ts

@@ -1,7 +1,12 @@
 import {mockFetch} from '../../tests/fetchMock';
 import CoveoAnalyticsClient from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
-import {CustomEventsTypes, SearchPageEvents, StaticFilterToggleValueMetadata} from '../searchPage/searchPageEvents';
+import {
+    CustomEventsTypes,
+    PartialDocumentInformation,
+    SearchPageEvents,
+    StaticFilterToggleValueMetadata,
+} from '../searchPage/searchPageEvents';
 import {CoveoInsightClient, InsightClientProvider} from './insightClient';
 import doNotTrack from '../donottrack';
 import {InsightEvents, InsightStaticFilterToggleValueMetadata} from './insightEvents';
@@ -101,6 +106,37 @@ describe('InsightClient', () => {
         });
     };
 
+    const expectMatchDocumentPayload = (actionCause: SearchPageEvents, doc: PartialDocumentInformation, meta = {}) => {
+        const [, {body}] = fetchMock.lastCall();
+        const customData = {foo: 'bar', ...meta};
+        expect(JSON.parse(body.toString())).toMatchObject({
+            actionCause,
+            customData,
+            language: 'en',
+            clientId: 'visitor-id',
+            ...doc,
+            ...expectOrigins(),
+        });
+    };
+
+    const fakeDocInfo = {
+        collectionName: 'collection',
+        documentAuthor: 'author',
+        documentPosition: 1,
+        documentTitle: 'title',
+        documentUri: 'uri',
+        documentUriHash: 'hash',
+        documentUrl: 'url',
+        queryPipeline: 'my-pipeline',
+        rankingModifier: 'modifier',
+        sourceName: 'source',
+    };
+
+    const fakeDocID = {
+        contentIDKey: 'permanentID',
+        contentIDValue: 'the-permanent-id',
+    };
+
     beforeEach(() => {
         fetchMockBeforeEach();
 
@@ -277,6 +313,11 @@ describe('InsightClient', () => {
             await client.logSearchboxSubmit();
             expectMatchPayload(SearchPageEvents.searchboxSubmit);
         });
+
+        it('should send proper payload for #documentOpen', async () => {
+            await client.logDocumentOpen(fakeDocInfo, fakeDocID);
+            expectMatchDocumentPayload(SearchPageEvents.documentOpen, fakeDocInfo, fakeDocID);
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -623,6 +664,17 @@ describe('InsightClient', () => {
             await client.logSearchboxSubmit(metadata);
             expectMatchPayload(SearchPageEvents.searchboxSubmit, expectedMetadata);
         });
+
+        it('should send proper payload for #documentOpen', async () => {
+            const metadata = baseCaseMetadata;
+
+            const expectedMetadata = {
+                ...fakeDocID,
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logDocumentOpen(fakeDocInfo, fakeDocID, metadata);
+            expectMatchDocumentPayload(SearchPageEvents.documentOpen, fakeDocInfo, expectedMetadata);
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -1,8 +1,14 @@
 import CoveoAnalyticsClient, {AnalyticsClient, ClientOptions} from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import doNotTrack from '../donottrack';
-import {CustomEventRequest, SearchEventRequest} from '../events';
-import {CustomEventsTypes, FacetStateMetadata, SearchPageEvents} from '../searchPage/searchPageEvents';
+import {ClickEventRequest, CustomEventRequest, SearchEventRequest} from '../events';
+import {
+    CustomEventsTypes,
+    DocumentIdentifier,
+    FacetStateMetadata,
+    PartialDocumentInformation,
+    SearchPageEvents,
+} from '../searchPage/searchPageEvents';
 import {
     ExpandToFullUIMetadata,
     InsightEvents,
@@ -213,6 +219,14 @@ export class CoveoInsightClient {
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     }
 
+    public logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
+        return this.logClickEvent(
+          SearchPageEvents.documentOpen,
+          info,
+          identifier,
+          metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+
     public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 
@@ -229,6 +243,23 @@ export class CoveoInsightClient {
         return this.coveoAnalyticsClient.sendSearchEvent(await this.getBaseSearchEventRequest(event, metadata));
     }
 
+    public async logClickEvent(
+        event: SearchPageEvents,
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        metadata?: Record<string, any>
+    ) {
+        const payload: ClickEventRequest = {
+            ...info,
+            ...(await this.getBaseEventRequest({...identifier, ...metadata})),
+            searchQueryUid: this.provider.getSearchUID(),
+            queryPipeline: this.provider.getPipeline(),
+            actionCause: event,
+        };
+
+        return this.coveoAnalyticsClient.sendClickEvent(payload);
+    }
+
     private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
         return {
             ...(await this.getBaseEventRequest(metadata)),

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);
-    }
-}