coveo.analytics 2.18.55 → 2.18.62

package/dist/definitions/events.d.ts

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

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -6,6 +6,7 @@ export interface SearchPageClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
     getPipeline: () => string;
+    getOriginContext: () => string;
     getOriginLevel1: () => string;
     getOriginLevel2: () => string;
     getOriginLevel3: () => string;
@@ -90,4 +91,5 @@ export declare class CoveoSearchPageClient {
     private getBaseCustomEventRequest;
     private getBaseEventRequest;
     private getOrigins;
+    private getClientId;
 }

package/dist/library.es.js

@@ -1423,40 +1423,60 @@ class CoveoSearchPageClient {
         return this.logSearchEvent(SearchPageEvents.noResultsBack);
     }
     logCustomEvent(event, metadata) {
-        const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
-        const payload = Object.assign(Object.assign({}, this.getBaseCustomEventRequest(customData)), { eventType: CustomEventsTypes[event], eventValue: event });
-        return this.coveoAnalyticsClient.sendCustomEvent(payload);
+        return __awaiter(this, void 0, void 0, function* () {
+            const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
+            const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
+            return this.coveoAnalyticsClient.sendCustomEvent(payload);
+        });
     }
     logCustomEventWithType(eventValue, eventType, metadata) {
-        const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
-        const payload = Object.assign(Object.assign({}, this.getBaseCustomEventRequest(customData)), { eventType,
-            eventValue });
-        return this.coveoAnalyticsClient.sendCustomEvent(payload);
+        return __awaiter(this, void 0, void 0, function* () {
+            const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
+            const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType,
+                eventValue });
+            return this.coveoAnalyticsClient.sendCustomEvent(payload);
+        });
     }
     logSearchEvent(event, metadata) {
-        return this.coveoAnalyticsClient.sendSearchEvent(this.getBaseSearchEventRequest(event, metadata));
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
+        });
     }
     logClickEvent(event, info, identifier, metadata) {
-        const payload = Object.assign(Object.assign(Object.assign({}, info), this.getBaseEventRequest(Object.assign(Object.assign({}, identifier), metadata))), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
-        return this.coveoAnalyticsClient.sendClickEvent(payload);
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = Object.assign(Object.assign(Object.assign({}, info), (yield this.getBaseEventRequest(Object.assign(Object.assign({}, identifier), metadata)))), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
+            return this.coveoAnalyticsClient.sendClickEvent(payload);
+        });
     }
     getBaseSearchEventRequest(event, metadata) {
-        return Object.assign(Object.assign(Object.assign({}, this.getBaseEventRequest(metadata)), this.provider.getSearchEventRequestPayload()), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
+        return __awaiter(this, void 0, void 0, function* () {
+            return Object.assign(Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), this.provider.getSearchEventRequestPayload()), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
+        });
     }
     getBaseCustomEventRequest(metadata) {
-        return Object.assign(Object.assign({}, this.getBaseEventRequest(metadata)), { lastSearchQueryUid: this.provider.getSearchUID() });
+        return __awaiter(this, void 0, void 0, function* () {
+            return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });
+        });
     }
     getBaseEventRequest(metadata) {
-        const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
-        return Object.assign(Object.assign({}, this.getOrigins()), { customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous() });
+        return __awaiter(this, void 0, void 0, function* () {
+            const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
+            return Object.assign(Object.assign({}, this.getOrigins()), { customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous(), clientId: yield this.getClientId() });
+        });
     }
     getOrigins() {
         return {
+            originContext: this.provider.getOriginContext(),
             originLevel1: this.provider.getOriginLevel1(),
             originLevel2: this.provider.getOriginLevel2(),
             originLevel3: this.provider.getOriginLevel3(),
         };
     }
+    getClientId() {
+        return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
+            ? this.coveoAnalyticsClient.getCurrentVisitorId()
+            : undefined;
+    }
 }
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;