coveo.analytics 2.18.55 → 2.18.62

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.18.55",
+    "version": "2.18.62",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -23,12 +23,13 @@
     },
     "license": "MIT",
     "dependencies": {
-        "@react-native-async-storage/async-storage": "^1.15.8",
-        "cross-fetch": "^3.1.4"
+        "@react-native-async-storage/async-storage": "^1.15.16",
+        "cross-fetch": "^3.1.5"
     },
     "devDependencies": {
         "@rollup/plugin-alias": "^3.1.2",
         "@rollup/plugin-commonjs": "^19.0.0",
+        "@rollup/plugin-json": "^4.1.0",
         "@rollup/plugin-node-resolve": "^13.0.0",
         "@types/fetch-mock": "^7.3.2",
         "@types/jest": "^25.1.1",

package/src/client/analytics.ts

@@ -71,6 +71,9 @@ export interface AnalyticsClient {
     registerAfterSendEventHook(hook: AnalyticsClientSendEventHook): void;
     addEventTypeMapping(eventType: string, eventConfig: EventTypeConfig): void;
     runtime: IRuntimeEnvironment;
+    /**
+     * @deprecated
+     */
     readonly currentVisitorId: string;
 }
 

package/src/events.ts

@@ -32,7 +32,8 @@ export interface EventBaseRequest {
     userDisplayName?: any;
     splitTestRunName?: string;
     splitTestRunVersion?: string;
-
+    clientId?: string;
+    originContext?: string;
     originLevel1?: string;
     originLevel2?: string;
     originLevel3?: string;

package/src/searchPage/searchPageClient.spec.ts

@@ -56,6 +56,7 @@ describe('SearchPageClient', () => {
         }),
         getSearchUID: () => 'my-uid',
         getPipeline: () => 'my-pipeline',
+        getOriginContext: () => 'origin-context',
         getOriginLevel1: () => 'origin-level-1',
         getOriginLevel2: () => 'origin-level-2',
         getOriginLevel3: () => 'origin-level-3',
@@ -68,9 +69,9 @@ describe('SearchPageClient', () => {
         fetchMockBeforeEach();
 
         client = initClient();
+        client.coveoAnalyticsClient.runtime.storage.setItem('visitorId', 'visitor-id');
         fetchMock.mock(/.*/, {
             visitId: 'visit-id',
-            visitorId: 'visitor-id',
         });
     });
 
@@ -83,6 +84,7 @@ describe('SearchPageClient', () => {
     };
 
     const expectOrigins = () => ({
+        originContext: 'origin-context',
         originLevel1: 'origin-level-1',
         originLevel2: 'origin-level-2',
         originLevel3: 'origin-level-3',
@@ -99,6 +101,7 @@ describe('SearchPageClient', () => {
             customData,
             facetState: fakeFacetState,
             language: 'en',
+            clientId: 'visitor-id',
             ...expectOrigins(),
         });
     };
@@ -111,6 +114,7 @@ describe('SearchPageClient', () => {
             customData,
             queryPipeline: 'my-pipeline',
             language: 'en',
+            clientId: 'visitor-id',
             ...doc,
             ...expectOrigins(),
         });
@@ -125,6 +129,7 @@ describe('SearchPageClient', () => {
             lastSearchQueryUid: 'my-uid',
             customData,
             language: 'en',
+            clientId: 'visitor-id',
             ...expectOrigins(),
         });
     };
@@ -138,6 +143,7 @@ describe('SearchPageClient', () => {
             lastSearchQueryUid: 'my-uid',
             customData,
             language: 'en',
+            clientId: 'visitor-id',
             ...expectOrigins(),
         });
     };

package/src/searchPage/searchPageClient.ts

@@ -33,6 +33,7 @@ export interface SearchPageClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
     getPipeline: () => string;
+    getOriginContext: () => string;
     getOriginLevel1: () => string;
     getOriginLevel2: () => string;
     getOriginLevel3: () => string;
@@ -305,11 +306,11 @@ export class CoveoSearchPageClient {
         return this.logSearchEvent(SearchPageEvents.noResultsBack);
     }
 
-    public logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
+    public async logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 
         const payload: CustomEventRequest = {
-            ...this.getBaseCustomEventRequest(customData),
+            ...(await this.getBaseCustomEventRequest(customData)),
             eventType: CustomEventsTypes[event]!,
             eventValue: event,
         };
@@ -317,22 +318,22 @@ export class CoveoSearchPageClient {
         return this.coveoAnalyticsClient.sendCustomEvent(payload);
     }
 
-    public logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>) {
+    public async logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 
         const payload: CustomEventRequest = {
-            ...this.getBaseCustomEventRequest(customData),
+            ...(await this.getBaseCustomEventRequest(customData)),
             eventType,
             eventValue,
         };
         return this.coveoAnalyticsClient.sendCustomEvent(payload);
     }
 
-    public logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
-        return this.coveoAnalyticsClient.sendSearchEvent(this.getBaseSearchEventRequest(event, metadata));
+    public async logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
+        return this.coveoAnalyticsClient.sendSearchEvent(await this.getBaseSearchEventRequest(event, metadata));
     }
 
-    public logClickEvent(
+    public async logClickEvent(
         event: SearchPageEvents,
         info: PartialDocumentInformation,
         identifier: DocumentIdentifier,
@@ -340,7 +341,7 @@ export class CoveoSearchPageClient {
     ) {
         const payload: ClickEventRequest = {
             ...info,
-            ...this.getBaseEventRequest({...identifier, ...metadata}),
+            ...(await this.getBaseEventRequest({...identifier, ...metadata})),
             searchQueryUid: this.provider.getSearchUID(),
             queryPipeline: this.provider.getPipeline(),
             actionCause: event,
@@ -349,9 +350,12 @@ export class CoveoSearchPageClient {
         return this.coveoAnalyticsClient.sendClickEvent(payload);
     }
 
-    private getBaseSearchEventRequest(event: SearchPageEvents, metadata?: Record<string, any>): SearchEventRequest {
+    private async getBaseSearchEventRequest(
+        event: SearchPageEvents,
+        metadata?: Record<string, any>
+    ): Promise<SearchEventRequest> {
         return {
-            ...this.getBaseEventRequest(metadata),
+            ...(await this.getBaseEventRequest(metadata)),
             ...this.provider.getSearchEventRequestPayload(),
             searchQueryUid: this.provider.getSearchUID(),
             queryPipeline: this.provider.getPipeline(),
@@ -359,14 +363,14 @@ export class CoveoSearchPageClient {
         };
     }
 
-    private getBaseCustomEventRequest(metadata?: Record<string, any>) {
+    private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
         return {
-            ...this.getBaseEventRequest(metadata),
+            ...(await this.getBaseEventRequest(metadata)),
             lastSearchQueryUid: this.provider.getSearchUID(),
         };
     }
 
-    private getBaseEventRequest(metadata?: Record<string, any>) {
+    private async getBaseEventRequest(metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
         return {
             ...this.getOrigins(),
@@ -374,14 +378,22 @@ export class CoveoSearchPageClient {
             language: this.provider.getLanguage(),
             facetState: this.provider.getFacetState ? this.provider.getFacetState() : [],
             anonymous: this.provider.getIsAnonymous(),
+            clientId: await this.getClientId(),
         };
     }
 
     private getOrigins() {
         return {
+            originContext: this.provider.getOriginContext(),
             originLevel1: this.provider.getOriginLevel1(),
             originLevel2: this.provider.getOriginLevel2(),
             originLevel3: this.provider.getOriginLevel3(),
         };
     }
+
+    private getClientId() {
+        return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
+            ? this.coveoAnalyticsClient.getCurrentVisitorId()
+            : undefined;
+    }
 }