coveo.analytics 2.20.5 → 2.20.8

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

@@ -1,6 +1,6 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { FacetBaseMeta, FacetMetadata, FacetSortMeta, FacetStateMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents } from '../searchPage/searchPageEvents';
+import { FacetBaseMeta, FacetMetadata, FacetSortMeta, FacetStateMetadata, PagerMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents, ResultsSortMetadata, FacetRangeMetadata, CategoryFacetMetadata } from '../searchPage/searchPageEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -27,6 +27,8 @@ export declare class CoveoInsightClient {
     logInterfaceLoad(): Promise<void | import("../events").SearchEventResponse>;
     logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFetchMoreResults(): Promise<void | import("../events").CustomEventResponse>;
+    logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logBreadcrumbResetAll(): Promise<void | import("../events").SearchEventResponse>;
     logFacetSelect(meta: FacetMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFacetDeselect(meta: FacetMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFacetUpdateSort(meta: FacetSortMeta): Promise<void | import("../events").SearchEventResponse>;
@@ -36,6 +38,10 @@ export declare class CoveoInsightClient {
     logQueryError(meta: QueryErrorMeta): Promise<void | import("../events").CustomEventResponse>;
     logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
+    logPagerNumber(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logPagerNext(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logPagerPrevious(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logResultsSort(metadata: ResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
     private getBaseCustomEventRequest;
     private getBaseSearchEventRequest;
     private getBaseEventRequest;

package/dist/library.es.js

@@ -1790,6 +1790,12 @@ class CoveoInsightClient {
     logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     }
+    logBreadcrumbFacet(metadata) {
+        return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadata);
+    }
+    logBreadcrumbResetAll() {
+        return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
+    }
     logFacetSelect(meta) {
         return this.logSearchEvent(SearchPageEvents.facetSelect, meta);
     }
@@ -1823,6 +1829,18 @@ class CoveoInsightClient {
             return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
         });
     }
+    logPagerNumber(meta) {
+        return this.logCustomEvent(SearchPageEvents.pagerNumber, meta);
+    }
+    logPagerNext(meta) {
+        return this.logCustomEvent(SearchPageEvents.pagerNext, meta);
+    }
+    logPagerPrevious(meta) {
+        return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
+    }
+    logResultsSort(metadata) {
+        return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
+    }
     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

@@ -84171,6 +84171,12 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logFetchMoreResults = function () {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     };
+    CoveoInsightClient.prototype.logBreadcrumbFacet = function (metadata) {
+        return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadata);
+    };
+    CoveoInsightClient.prototype.logBreadcrumbResetAll = function () {
+        return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
+    };
     CoveoInsightClient.prototype.logFacetSelect = function (meta) {
         return this.logSearchEvent(SearchPageEvents.facetSelect, meta);
     };
@@ -84221,6 +84227,18 @@ var CoveoInsightClient = (function () {
             });
         });
     };
+    CoveoInsightClient.prototype.logPagerNumber = function (meta) {
+        return this.logCustomEvent(SearchPageEvents.pagerNumber, meta);
+    };
+    CoveoInsightClient.prototype.logPagerNext = function (meta) {
+        return this.logCustomEvent(SearchPageEvents.pagerNext, meta);
+    };
+    CoveoInsightClient.prototype.logPagerPrevious = function (meta) {
+        return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
+    };
+    CoveoInsightClient.prototype.logResultsSort = function (metadata) {
+        return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
+    };
     CoveoInsightClient.prototype.getBaseCustomEventRequest = function (metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var _a;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.20.5",
+    "version": "2.20.8",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -23,7 +23,7 @@
     },
     "license": "MIT",
     "dependencies": {
-        "@react-native-async-storage/async-storage": "^1.17.5",
+        "@react-native-async-storage/async-storage": "^1.17.6",
         "cross-fetch": "^3.1.5"
     },
     "devDependencies": {

package/src/insight/insightClient.spec.ts

@@ -119,6 +119,22 @@ describe('InsightClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     });
 
+    it('should send proper payload for #breadcrumbResetAll', async () => {
+        await client.logBreadcrumbResetAll();
+        expectMatchPayload(SearchPageEvents.breadcrumbResetAll);
+    });
+
+    it('should send proper payload for #breadcrumbFacet', async () => {
+        const meta = {
+            facetField: '@foo',
+            facetId: 'bar',
+            facetTitle: 'title',
+            facetValue: 'qwerty',
+        };
+        await client.logBreadcrumbFacet(meta);
+        expectMatchPayload(SearchPageEvents.breadcrumbFacet, meta);
+    });
+
     it('should send proper payload for #logFacetSelect', async () => {
         const meta = {
             facetField: '@foo',
@@ -197,6 +213,29 @@ describe('InsightClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.queryError, meta);
     });
 
+    it('should send proper payload for #logPagerNumber', async () => {
+        const meta = {pagerNumber: 123};
+        await client.logPagerNumber(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.pagerNumber, meta);
+    });
+
+    it('should send proper payload for #logPagerNext', async () => {
+        const meta = {pagerNumber: 123};
+        await client.logPagerNext(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.pagerNext, meta);
+    });
+
+    it('should send proper payload for #logPagerPrevious', async () => {
+        const meta = {pagerNumber: 123};
+        await client.logPagerPrevious(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.pagerPrevious, meta);
+    });
+
+    it('should send proper payload for #resultsSort', async () => {
+        await client.logResultsSort({resultsSortBy: 'date ascending'});
+        expectMatchPayload(SearchPageEvents.resultsSort, {resultsSortBy: 'date ascending'});
+    });
+
     it('should enable analytics tracking by default', () => {
         const c = new CoveoInsightClient({}, provider);
         expect(c.coveoAnalyticsClient instanceof CoveoAnalyticsClient).toBe(true);

package/src/insight/insightClient.ts

@@ -8,9 +8,13 @@ import {
     FacetMetadata,
     FacetSortMeta,
     FacetStateMetadata,
+    PagerMetadata,
     InterfaceChangeMetadata,
     QueryErrorMeta,
     SearchPageEvents,
+    ResultsSortMetadata,
+    FacetRangeMetadata,
+    CategoryFacetMetadata,
 } from '../searchPage/searchPageEvents';
 
 export interface InsightClientProvider {
@@ -62,6 +66,14 @@ export class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     }
 
+    public logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata) {
+        return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadata);
+    }
+
+    public logBreadcrumbResetAll() {
+        return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
+    }
+
     public logFacetSelect(meta: FacetMetadata) {
         return this.logSearchEvent(SearchPageEvents.facetSelect, meta);
     }
@@ -106,6 +118,22 @@ export class CoveoInsightClient {
         return this.coveoAnalyticsClient.sendSearchEvent(await this.getBaseSearchEventRequest(event, metadata));
     }
 
+    public logPagerNumber(meta: PagerMetadata) {
+        return this.logCustomEvent(SearchPageEvents.pagerNumber, meta);
+    }
+
+    public logPagerNext(meta: PagerMetadata) {
+        return this.logCustomEvent(SearchPageEvents.pagerNext, meta);
+    }
+
+    public logPagerPrevious(meta: PagerMetadata) {
+        return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
+    }
+
+    public logResultsSort(metadata: ResultsSortMetadata) {
+        return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
+    }
+
     private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
         return {
             ...(await this.getBaseEventRequest(metadata)),