coveo.analytics 2.20.4 → 2.20.5

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, QueryErrorMeta, SearchPageEvents } from '../searchPage/searchPageEvents';
+import { FacetBaseMeta, FacetMetadata, FacetSortMeta, FacetStateMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents } from '../searchPage/searchPageEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -25,6 +25,7 @@ export declare class CoveoInsightClient {
     disable(): void;
     enable(): void;
     logInterfaceLoad(): Promise<void | import("../events").SearchEventResponse>;
+    logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFetchMoreResults(): Promise<void | import("../events").CustomEventResponse>;
     logFacetSelect(meta: FacetMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFacetDeselect(meta: FacetMetadata): Promise<void | import("../events").SearchEventResponse>;

package/dist/library.es.js

@@ -1784,6 +1784,9 @@ class CoveoInsightClient {
     logInterfaceLoad() {
         return this.logSearchEvent(SearchPageEvents.interfaceLoad);
     }
+    logInterfaceChange(metadata) {
+        return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
+    }
     logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     }

package/dist/library.js

@@ -84165,6 +84165,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logInterfaceLoad = function () {
         return this.logSearchEvent(SearchPageEvents.interfaceLoad);
     };
+    CoveoInsightClient.prototype.logInterfaceChange = function (metadata) {
+        return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
+    };
     CoveoInsightClient.prototype.logFetchMoreResults = function () {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     };

package/package.json

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

package/src/insight/insightClient.spec.ts

@@ -107,6 +107,13 @@ describe('InsightClient', () => {
         expectMatchPayload(SearchPageEvents.interfaceLoad);
     });
 
+    it('should send proper payload for #interfaceChange', async () => {
+        await client.logInterfaceChange({
+            interfaceChangeTo: 'bob',
+        });
+        expectMatchPayload(SearchPageEvents.interfaceChange, {interfaceChangeTo: 'bob'});
+    });
+
     it('should send proper payload for #fetchMoreResults', async () => {
         await client.logFetchMoreResults();
         expectMatchCustomEventPayload(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});

package/src/insight/insightClient.ts

@@ -8,6 +8,7 @@ import {
     FacetMetadata,
     FacetSortMeta,
     FacetStateMetadata,
+    InterfaceChangeMetadata,
     QueryErrorMeta,
     SearchPageEvents,
 } from '../searchPage/searchPageEvents';
@@ -53,6 +54,10 @@ export class CoveoInsightClient {
         return this.logSearchEvent(SearchPageEvents.interfaceLoad);
     }
 
+    public logInterfaceChange(metadata: InterfaceChangeMetadata) {
+        return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
+    }
+
     public logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     }