coveo.analytics 2.20.7 → 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, PagerMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents, ResultsSortMetadata } 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>;

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

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

package/package.json

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

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

package/src/insight/insightClient.ts

@@ -13,6 +13,8 @@ import {
     QueryErrorMeta,
     SearchPageEvents,
     ResultsSortMetadata,
+    FacetRangeMetadata,
+    CategoryFacetMetadata,
 } from '../searchPage/searchPageEvents';
 
 export interface InsightClientProvider {
@@ -64,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);
     }