coveo.analytics 2.22.1 → 2.22.2

package/dist/definitions/insight/insightClient.d.ts

@@ -1,6 +1,6 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { FacetStateMetadata, SearchPageEvents } from '../searchPage/searchPageEvents';
+import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents } from '../searchPage/searchPageEvents';
 import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -47,8 +47,10 @@ export declare class CoveoInsightClient {
     logSearchboxSubmit(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
+    logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;
     private getBaseCustomEventRequest;
     private getBaseSearchEventRequest;
     private getBaseEventRequest;

package/dist/library.es.js

@@ -2191,6 +2191,9 @@ class CoveoInsightClient {
         const metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     }
+    logDocumentOpen(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
@@ -2203,6 +2206,12 @@ class CoveoInsightClient {
             return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
         });
     }
+    logClickEvent(event, info, identifier, metadata) {
+        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);
+        });
+    }
     getBaseCustomEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });

package/dist/library.js

@@ -84613,6 +84613,9 @@ var CoveoInsightClient = (function () {
         var metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     };
+    CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;
@@ -84642,6 +84645,21 @@ var CoveoInsightClient = (function () {
             });
         });
     };
+    CoveoInsightClient.prototype.logClickEvent = function (event, info, identifier, metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            var payload, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = [__assign({}, info)];
+                        return [4, this.getBaseEventRequest(__assign(__assign({}, identifier), metadata))];
+                    case 1:
+                        payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event }]);
+                        return [2, this.coveoAnalyticsClient.sendClickEvent(payload)];
+                }
+            });
+        });
+    };
     CoveoInsightClient.prototype.getBaseCustomEventRequest = function (metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var _a;

package/dist/react-native.es.js

@@ -2208,6 +2208,9 @@ class CoveoInsightClient {
         const metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     }
+    logDocumentOpen(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
@@ -2220,6 +2223,12 @@ class CoveoInsightClient {
             return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
         });
     }
+    logClickEvent(event, info, identifier, metadata) {
+        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);
+        });
+    }
     getBaseCustomEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.22.1",
+    "version": "2.22.2",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

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)),