coveo.analytics 2.20.17 → 2.20.18

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

@@ -1,6 +1,6 @@
 import { ClientOptions, AnalyticsClient } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata } from './searchPageEvents';
+import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -51,6 +51,7 @@ export declare class CoveoSearchPageClient {
     logTriggerNotify(meta: TriggerNotifyMetadata): Promise<void | import("../events").CustomEventResponse>;
     logTriggerExecute(meta: TriggerExecuteMetadata): Promise<void | import("../events").CustomEventResponse>;
     logTriggerQuery(): Promise<void | import("../events").CustomEventResponse>;
+    logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<void | import("../events").CustomEventResponse>;
     logTriggerRedirect(meta: TriggerRedirectMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPagerResize(meta: PagerResizeMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPagerNumber(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;

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

@@ -19,6 +19,7 @@ export declare enum SearchPageEvents {
     triggerNotify = "notify",
     triggerExecute = "execute",
     triggerQuery = "query",
+    undoTriggerQuery = "undoQuery",
     triggerRedirect = "redirect",
     pagerResize = "pagerResize",
     pagerNumber = "pagerNumber",
@@ -118,6 +119,9 @@ export interface TriggerNotifyMetadata {
 export interface TriggerExecuteMetadata {
     executed: string;
 }
+export interface UndoTriggerRedirectMetadata {
+    undoneQuery: string;
+}
 export interface TriggerRedirectMetadata {
     redirectedTo: string;
 }

package/dist/library.es.js

@@ -1109,6 +1109,7 @@ var SearchPageEvents;
     SearchPageEvents["triggerNotify"] = "notify";
     SearchPageEvents["triggerExecute"] = "execute";
     SearchPageEvents["triggerQuery"] = "query";
+    SearchPageEvents["undoTriggerQuery"] = "undoQuery";
     SearchPageEvents["triggerRedirect"] = "redirect";
     SearchPageEvents["pagerResize"] = "pagerResize";
     SearchPageEvents["pagerNumber"] = "pagerNumber";
@@ -1160,6 +1161,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerExecute]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerQuery]: 'queryPipelineTriggers',
+    [SearchPageEvents.undoTriggerQuery]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerRedirect]: 'queryPipelineTriggers',
     [SearchPageEvents.queryError]: 'errors',
     [SearchPageEvents.queryErrorBack]: 'errors',
@@ -1357,6 +1359,9 @@ class CoveoSearchPageClient {
         const meta = { query: this.provider.getSearchEventRequestPayload().queryText };
         return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
     }
+    logUndoTriggerQuery(meta) {
+        return this.logCustomEvent(SearchPageEvents.undoTriggerQuery, meta);
+    }
     logTriggerRedirect(meta) {
         const allMeta = Object.assign(Object.assign({}, meta), { query: this.provider.getSearchEventRequestPayload().queryText });
         return this.logCustomEvent(SearchPageEvents.triggerRedirect, allMeta);

package/dist/library.js

@@ -83569,6 +83569,7 @@ var SearchPageEvents;
     SearchPageEvents["triggerNotify"] = "notify";
     SearchPageEvents["triggerExecute"] = "execute";
     SearchPageEvents["triggerQuery"] = "query";
+    SearchPageEvents["undoTriggerQuery"] = "undoQuery";
     SearchPageEvents["triggerRedirect"] = "redirect";
     SearchPageEvents["pagerResize"] = "pagerResize";
     SearchPageEvents["pagerNumber"] = "pagerNumber";
@@ -83620,6 +83621,7 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
     _a[SearchPageEvents.triggerExecute] = 'queryPipelineTriggers',
     _a[SearchPageEvents.triggerQuery] = 'queryPipelineTriggers',
+    _a[SearchPageEvents.undoTriggerQuery] = 'queryPipelineTriggers',
     _a[SearchPageEvents.triggerRedirect] = 'queryPipelineTriggers',
     _a[SearchPageEvents.queryError] = 'errors',
     _a[SearchPageEvents.queryErrorBack] = 'errors',
@@ -83818,6 +83820,9 @@ var CoveoSearchPageClient = (function () {
         var meta = { query: this.provider.getSearchEventRequestPayload().queryText };
         return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
     };
+    CoveoSearchPageClient.prototype.logUndoTriggerQuery = function (meta) {
+        return this.logCustomEvent(SearchPageEvents.undoTriggerQuery, meta);
+    };
     CoveoSearchPageClient.prototype.logTriggerRedirect = function (meta) {
         var allMeta = __assign(__assign({}, meta), { query: this.provider.getSearchEventRequestPayload().queryText });
         return this.logCustomEvent(SearchPageEvents.triggerRedirect, allMeta);

package/package.json

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

package/src/searchPage/searchPageClient.spec.ts

@@ -285,6 +285,14 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.triggerQuery, meta);
     });
 
+    it('should send proper payload for #logUndoTriggerQuery', async () => {
+        const meta = {
+            undoneQuery: 'foo',
+        };
+        await client.logUndoTriggerQuery(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.undoTriggerQuery, meta);
+    });
+
     it('should send proper payload for #logTriggerRedirect', async () => {
         const meta = {
             redirectedTo: 'foo',

package/src/searchPage/searchPageClient.ts

@@ -25,6 +25,7 @@ import {
     SmartSnippetDocumentIdentifier,
     StaticFilterMetadata,
     StaticFilterToggleValueMetadata,
+    UndoTriggerRedirectMetadata,
 } from './searchPageEvents';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -170,6 +171,10 @@ export class CoveoSearchPageClient {
         return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
     }
 
+    public logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata) {
+        return this.logCustomEvent(SearchPageEvents.undoTriggerQuery, meta);
+    }
+
     public logTriggerRedirect(meta: TriggerRedirectMetadata) {
         const allMeta = {...meta, query: this.provider.getSearchEventRequestPayload().queryText};
         return this.logCustomEvent(SearchPageEvents.triggerRedirect, allMeta);

package/src/searchPage/searchPageEvents.ts

@@ -74,6 +74,10 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user action triggers a new query set in the effective query pipeline on the search page.
      */
     triggerQuery = 'query',
+    /**
+     * Identifies the custom event that gets logged when a user undoes a query set in the effective query pipeline on the search page.
+     */
+    undoTriggerQuery = 'undoQuery',
     /**
      * Identifies the custom event that gets logged when a user action redirects them to a URL set in the effective query pipeline on the search page.
      */
@@ -268,6 +272,7 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerExecute]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerQuery]: 'queryPipelineTriggers',
+    [SearchPageEvents.undoTriggerQuery]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerRedirect]: 'queryPipelineTriggers',
     [SearchPageEvents.queryError]: 'errors',
     [SearchPageEvents.queryErrorBack]: 'errors',
@@ -363,6 +368,10 @@ export interface TriggerExecuteMetadata {
     executed: string;
 }
 
+export interface UndoTriggerRedirectMetadata {
+    undoneQuery: string;
+}
+
 export interface TriggerRedirectMetadata {
     redirectedTo: string;
 }