coveo.analytics 2.20.16 → 2.20.19

package/dist/definitions/client/analytics.d.ts

@@ -21,6 +21,7 @@ export declare type EventTypeConfig = {
     newEventType: EventType;
     variableLengthArgumentsNames?: string[];
     addVisitorIdParameter?: boolean;
+    addClientIdParameter?: boolean;
     usesMeasurementProtocol?: boolean;
 };
 export interface AnalyticsClient {
@@ -38,6 +39,7 @@ export interface AnalyticsClient {
     addEventTypeMapping(eventType: string, eventConfig: EventTypeConfig): void;
     runtime: IRuntimeEnvironment;
     readonly currentVisitorId: string;
+    getCurrentVisitorId?(): Promise<string>;
 }
 export interface BufferedRequest {
     eventType: EventType;

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").SearchEventResponse>;
     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

@@ -879,13 +879,19 @@ class CoveoAnalyticsClient {
     }
     resolveParameters(eventType, ...payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { variableLengthArgumentsNames = [], addVisitorIdParameter = false, usesMeasurementProtocol = false } = this.eventTypeMapping[eventType] || {};
+            const { variableLengthArgumentsNames = [], addVisitorIdParameter = false, usesMeasurementProtocol = false, addClientIdParameter = false, } = this.eventTypeMapping[eventType] || {};
             const processVariableArgumentNamesStep = (currentPayload) => variableLengthArgumentsNames.length > 0
                 ? this.parseVariableArgumentsPayload(variableLengthArgumentsNames, currentPayload)
                 : currentPayload[0];
             const addVisitorIdStep = (currentPayload) => __awaiter(this, void 0, void 0, function* () {
                 return (Object.assign(Object.assign({}, currentPayload), { visitorId: addVisitorIdParameter ? yield this.getCurrentVisitorId() : '' }));
             });
+            const addClientIdStep = (currentPayload) => __awaiter(this, void 0, void 0, function* () {
+                if (addClientIdParameter) {
+                    return Object.assign(Object.assign({}, currentPayload), { clientId: yield this.getCurrentVisitorId() });
+                }
+                return currentPayload;
+            });
             const setAnonymousUserStep = (currentPayload) => usesMeasurementProtocol ? this.ensureAnonymousUserWhenUsingApiKey(currentPayload) : currentPayload;
             const processBeforeSendHooksStep = (currentPayload) => this.beforeSendHooks.reduce((promisePayload, current) => __awaiter(this, void 0, void 0, function* () {
                 const payload = yield promisePayload;
@@ -894,6 +900,7 @@ class CoveoAnalyticsClient {
             const parametersToSend = yield [
                 processVariableArgumentNamesStep,
                 addVisitorIdStep,
+                addClientIdStep,
                 setAnonymousUserStep,
                 processBeforeSendHooksStep,
             ].reduce((payloadPromise, step) => __awaiter(this, void 0, void 0, function* () {
@@ -1102,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";
@@ -1350,6 +1358,9 @@ class CoveoSearchPageClient {
         const meta = { query: this.provider.getSearchEventRequestPayload().queryText };
         return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
     }
+    logUndoTriggerQuery(meta) {
+        return this.logSearchEvent(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

@@ -82696,12 +82696,12 @@ var CoveoAnalyticsClient = (function () {
             payload[_i - 1] = arguments[_i];
         }
         return __awaiter(this, void 0, void 0, function () {
-            var _a, _b, variableLengthArgumentsNames, _c, addVisitorIdParameter, _d, usesMeasurementProtocol, processVariableArgumentNamesStep, addVisitorIdStep, setAnonymousUserStep, processBeforeSendHooksStep, parametersToSend;
+            var _a, _b, variableLengthArgumentsNames, _c, addVisitorIdParameter, _d, usesMeasurementProtocol, _e, addClientIdParameter, processVariableArgumentNamesStep, addVisitorIdStep, addClientIdStep, setAnonymousUserStep, processBeforeSendHooksStep, parametersToSend;
             var _this = this;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
+            return __generator(this, function (_f) {
+                switch (_f.label) {
                     case 0:
-                        _a = this.eventTypeMapping[eventType] || {}, _b = _a.variableLengthArgumentsNames, variableLengthArgumentsNames = _b === void 0 ? [] : _b, _c = _a.addVisitorIdParameter, addVisitorIdParameter = _c === void 0 ? false : _c, _d = _a.usesMeasurementProtocol, usesMeasurementProtocol = _d === void 0 ? false : _d;
+                        _a = this.eventTypeMapping[eventType] || {}, _b = _a.variableLengthArgumentsNames, variableLengthArgumentsNames = _b === void 0 ? [] : _b, _c = _a.addVisitorIdParameter, addVisitorIdParameter = _c === void 0 ? false : _c, _d = _a.usesMeasurementProtocol, usesMeasurementProtocol = _d === void 0 ? false : _d, _e = _a.addClientIdParameter, addClientIdParameter = _e === void 0 ? false : _e;
                         processVariableArgumentNamesStep = function (currentPayload) {
                             return variableLengthArgumentsNames.length > 0
                                 ? _this.parseVariableArgumentsPayload(variableLengthArgumentsNames, currentPayload)
@@ -82726,6 +82726,20 @@ var CoveoAnalyticsClient = (function () {
                                 }
                             });
                         }); };
+                        addClientIdStep = function (currentPayload) { return __awaiter(_this, void 0, void 0, function () {
+                            var _a, _b;
+                            return __generator(this, function (_c) {
+                                switch (_c.label) {
+                                    case 0:
+                                        if (!addClientIdParameter) return [3, 2];
+                                        _a = [__assign({}, currentPayload)];
+                                        _b = {};
+                                        return [4, this.getCurrentVisitorId()];
+                                    case 1: return [2, __assign.apply(void 0, _a.concat([(_b.clientId = _c.sent(), _b)]))];
+                                    case 2: return [2, currentPayload];
+                                }
+                            });
+                        }); };
                         setAnonymousUserStep = function (currentPayload) {
                             return usesMeasurementProtocol ? _this.ensureAnonymousUserWhenUsingApiKey(currentPayload) : currentPayload;
                         };
@@ -82746,6 +82760,7 @@ var CoveoAnalyticsClient = (function () {
                         return [4, [
                                 processVariableArgumentNamesStep,
                                 addVisitorIdStep,
+                                addClientIdStep,
                                 setAnonymousUserStep,
                                 processBeforeSendHooksStep,
                             ].reduce(function (payloadPromise, step) { return __awaiter(_this, void 0, void 0, function () {
@@ -82761,7 +82776,7 @@ var CoveoAnalyticsClient = (function () {
                                 });
                             }); }, Promise.resolve(payload))];
                     case 1:
-                        parametersToSend = _e.sent();
+                        parametersToSend = _f.sent();
                         return [2, parametersToSend];
                 }
             });
@@ -83397,6 +83412,7 @@ var CoveoUA = (function () {
                 return _this.plugins.require(pluginKey, pluginOptions_1);
             });
             this.client.registerBeforeSendEventHook(function (eventType, payload) { return (__assign(__assign({}, payload), _this.params)); });
+            this.client.addEventTypeMapping(EventType.view, { newEventType: EventType.view, addClientIdParameter: true });
         }
         else {
             throw new Error("You must pass either your token or a valid object when you call 'init'");
@@ -83553,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";
@@ -83802,6 +83819,9 @@ var CoveoSearchPageClient = (function () {
         var meta = { query: this.provider.getSearchEventRequestPayload().queryText };
         return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
     };
+    CoveoSearchPageClient.prototype.logUndoTriggerQuery = function (meta) {
+        return this.logSearchEvent(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.16",
+    "version": "2.20.19",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/client/analytics.ts

@@ -54,6 +54,7 @@ export type EventTypeConfig = {
     newEventType: EventType;
     variableLengthArgumentsNames?: string[];
     addVisitorIdParameter?: boolean;
+    addClientIdParameter?: boolean;
     usesMeasurementProtocol?: boolean;
 };
 
@@ -75,6 +76,7 @@ export interface AnalyticsClient {
      * @deprecated
      */
     readonly currentVisitorId: string;
+    getCurrentVisitorId?(): Promise<string>; // TODO: v3 make required
 }
 
 export interface BufferedRequest {
@@ -205,8 +207,12 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     async resolveParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload) {
-        const {variableLengthArgumentsNames = [], addVisitorIdParameter = false, usesMeasurementProtocol = false} =
-            this.eventTypeMapping[eventType] || {};
+        const {
+            variableLengthArgumentsNames = [],
+            addVisitorIdParameter = false,
+            usesMeasurementProtocol = false,
+            addClientIdParameter = false,
+        } = this.eventTypeMapping[eventType] || {};
 
         const processVariableArgumentNamesStep: ProcessPayloadStep = (currentPayload) =>
             variableLengthArgumentsNames.length > 0
@@ -216,6 +222,15 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
             ...currentPayload,
             visitorId: addVisitorIdParameter ? await this.getCurrentVisitorId() : '',
         });
+        const addClientIdStep: AsyncProcessPayloadStep = async (currentPayload) => {
+            if (addClientIdParameter) {
+                return {
+                    ...currentPayload,
+                    clientId: await this.getCurrentVisitorId(),
+                };
+            }
+            return currentPayload;
+        };
         const setAnonymousUserStep: ProcessPayloadStep = (currentPayload) =>
             usesMeasurementProtocol ? this.ensureAnonymousUserWhenUsingApiKey(currentPayload) : currentPayload;
         const processBeforeSendHooksStep: AsyncProcessPayloadStep = (currentPayload) =>
@@ -227,6 +242,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         const parametersToSend = await [
             processVariableArgumentNamesStep,
             addVisitorIdStep,
+            addClientIdStep,
             setAnonymousUserStep,
             processBeforeSendHooksStep,
         ].reduce(async (payloadPromise, step) => {

package/src/coveoua/simpleanalytics.spec.ts

@@ -1,11 +1,12 @@
 import {handleOneAnalyticsEvent} from './simpleanalytics';
-import {createAnalyticsClientMock} from '../../tests/analyticsClientMock';
+import {createAnalyticsClientMock, visitorIdMock} from '../../tests/analyticsClientMock';
 import {EC} from '../plugins/ec';
 import {SVC} from '../plugins/svc';
 import {TestPlugin} from '../../tests/pluginMock';
 import {uuidv4} from '../client/crypto';
 import {PluginOptions} from '../plugins/BasePlugin';
 import {mockFetch} from '../../tests/fetchMock';
+import {CookieStorage} from '../storage';
 
 jest.mock('../plugins/svc', () => {
     const SVC = jest.fn().mockImplementation(() => {});
@@ -22,6 +23,11 @@ jest.mock('../plugins/ec', () => {
     };
 });
 
+const uuidv4Mock = jest.fn();
+jest.mock('../client/crypto', () => ({
+    uuidv4: () => uuidv4Mock(),
+}));
+
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 
 class TestPluginWithSpy extends TestPlugin {
@@ -46,7 +52,10 @@ describe('simpleanalytics', () => {
         jest.clearAllMocks();
         fetchMockBeforeEach();
 
+        new CookieStorage().removeItem('visitorId');
+        localStorage.clear();
         fetchMock.mock('*', {});
+        uuidv4Mock.mockImplementationOnce(() => visitorIdMock);
         handleOneAnalyticsEvent('reset');
     });
 
@@ -199,7 +208,16 @@ describe('simpleanalytics', () => {
 
             expect(fetchMock.calls().length).toBe(1);
             expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/pageview`);
-            expect(JSON.parse(fetchMock.lastCall()[1].body.toString())).toEqual({somedata: 'asd'});
+            expect(JSON.parse(fetchMock.lastCall()![1]!.body!.toString())).toEqual({somedata: 'asd'});
+        });
+
+        it('can send view event with clientId', async () => {
+            handleOneAnalyticsEvent('init', 'MYTOKEN', {plugins: []});
+            await handleOneAnalyticsEvent('send', 'view');
+
+            expect(fetchMock.calls().length).toBe(1);
+            expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/view?visitor=${visitorIdMock}`);
+            expect(JSON.parse(fetchMock.lastCall()![1]!.body!.toString()).clientId).toBe(visitorIdMock);
         });
 
         it('can send any event to the endpoint', async () => {
@@ -227,7 +245,7 @@ describe('simpleanalytics', () => {
 
             expect(fetchMock.calls().length).toBe(1);
             expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/${someRandomEventName}`);
-            expect(JSON.parse(fetchMock.lastCall()[1].body.toString())).toEqual({userId: 'something'});
+            expect(JSON.parse(fetchMock.lastCall()![1]!.body!.toString())).toEqual({userId: 'something'});
         });
 
         it('can set parameters using an object', async () => {
@@ -239,7 +257,7 @@ describe('simpleanalytics', () => {
 
             expect(fetchMock.calls().length).toBe(1);
             expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/${someRandomEventName}`);
-            expect(JSON.parse(fetchMock.lastCall()[1].body.toString())).toEqual({userId: 'something'});
+            expect(JSON.parse(fetchMock.lastCall()![1]!.body!.toString())).toEqual({userId: 'something'});
         });
     });
 
@@ -360,7 +378,7 @@ describe('simpleanalytics', () => {
 
             expect(fetchMock.calls().length).toBe(1);
             expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/${someRandomEventName}`);
-            expect(JSON.parse(fetchMock.lastCall()[1].body.toString())).toEqual({});
+            expect(JSON.parse(fetchMock.lastCall()![1]!.body!.toString())).toEqual({});
         });
     });
 

package/src/coveoua/simpleanalytics.ts

@@ -1,4 +1,4 @@
-import {AnyEventResponse, SendEventArguments, VariableArgumentsPayload} from '../events';
+import {AnyEventResponse, EventType, SendEventArguments, VariableArgumentsPayload} from '../events';
 import {AnalyticsClient, CoveoAnalyticsClient, Endpoints} from '../client/analytics';
 import {Plugins} from './plugins';
 import {PluginOptions} from '../plugins/BasePlugin';
@@ -45,6 +45,7 @@ export class CoveoUA {
                 ...payload,
                 ...this.params,
             }));
+            this.client.addEventTypeMapping(EventType.view, {newEventType: EventType.view, addClientIdParameter: true});
         } else {
             throw new Error(`You must pass either your token or a valid object when you call 'init'`);
         }

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);
+        expectMatchPayload(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.logSearchEvent(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.
      */
@@ -363,6 +367,10 @@ export interface TriggerExecuteMetadata {
     executed: string;
 }
 
+export interface UndoTriggerRedirectMetadata {
+    undoneQuery: string;
+}
+
 export interface TriggerRedirectMetadata {
     redirectedTo: string;
 }