coveo.analytics 2.30.44 → 2.30.46

package/src/caseAssist/caseAssistActions.ts

@@ -9,7 +9,8 @@ export enum CaseAssistActions {
     enterInterface = 'ticket_create_start',
     fieldUpdate = 'ticket_field_update',
     fieldSuggestionClick = 'ticket_classification_click',
-    suggestionClick = 'suggestion_click',
+    documentSuggestionClick = 'documentSuggestionClick',
+    documentSuggestionQuickview = 'documentSuggestionQuickview',
     suggestionRate = 'suggestion_rate',
     nextCaseStep = 'ticket_next_stage',
     caseCancelled = 'ticket_cancel',
@@ -78,12 +79,14 @@ export interface FieldSuggestion {
 export interface DocumentSuggestion {
     suggestionId: string;
     responseId: string;
+    permanentId: string;
     suggestion: {
         documentUri: string;
         documentUriHash: string;
         documentTitle: string;
         documentUrl: string;
         documentPosition: number;
+        sourceName: string;
     };
     fromQuickview?: boolean;
     openDocument?: boolean;

package/src/caseAssist/caseAssistClient.spec.ts

@@ -11,6 +11,7 @@ import {TicketProperties} from '../plugins/svc';
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 import doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
+import {PartialDocumentInformation} from '../searchPage/searchPageEvents';
 jest.mock('../donottrack', () => {
     return {
         default: jest.fn(),
@@ -19,17 +20,31 @@ jest.mock('../donottrack', () => {
 });
 
 describe('CaseAssistClient', () => {
-    const defaultSearchHub = 'origin-level-1';
+    const exampleSearchHub = 'example origin-level-1';
+    const exampleOriginLevel2 = 'example origin-level-2';
+    const exampleOriginLevel3 = 'example origin-level-3';
+    const exampleOriginContext = 'example origin-context';
+    const exampleSearchUID = 'foo';
+    const exampleLanguage = 'en';
+    const exampleClientId = '123-456';
+
     let client: CaseAssistClient;
 
     const provider: CaseAssistClientProvider = {
-        getOriginLevel1: () => defaultSearchHub,
+        getOriginLevel1: () => exampleSearchHub,
+        getOriginLevel2: () => exampleOriginLevel2,
+        getOriginLevel3: () => exampleOriginLevel3,
+        getOriginContext: () => exampleOriginContext,
+        getIsAnonymous: () => false,
+        getSearchUID: () => exampleSearchUID,
+        getLanguage: () => exampleLanguage,
     };
 
     beforeEach(() => {
         fetchMockBeforeEach();
 
         client = initClient();
+        client.coveoAnalyticsClient.runtime.storage.setItem('visitorId', exampleClientId);
         fetchMock.mock(/.*/, {
             visitorId: 'visitor-id',
         });
@@ -44,7 +59,7 @@ describe('CaseAssistClient', () => {
             {
                 enableAnalytics: true,
             },
-            provider
+            provider,
         );
     };
 
@@ -76,18 +91,18 @@ describe('CaseAssistClient', () => {
         };
     };
 
-    const fakeDocumentSuggestion = (): DocumentSuggestion => {
-        return {
-            responseId: 'document-suggestion-response-id',
-            suggestionId: 'document-suggestion-id',
-            suggestion: {
-                documentPosition: 0,
-                documentTitle: 'the document title',
-                documentUri: 'some-document-uri',
-                documentUriHash: 'documenturihash',
-                documentUrl: 'some-document-url',
-            },
-        };
+    const fakeDocumentSuggestion: DocumentSuggestion = {
+        responseId: 'document-suggestion-response-id',
+        suggestionId: 'document-suggestion-id',
+        permanentId: 'example permanent-id',
+        suggestion: {
+            documentPosition: 0,
+            documentTitle: 'the document title',
+            documentUri: 'some-document-uri',
+            documentUriHash: 'documenturihash',
+            documentUrl: 'some-document-url',
+            sourceName: 'example source-name',
+        },
     };
 
     const expectMatchPayload = (actionName: CaseAssistActions, actionData: Object, ticket: TicketProperties) => {
@@ -96,13 +111,29 @@ describe('CaseAssistClient', () => {
 
         expectMatchActionPayload(content, actionName, actionData);
         expectMatchTicketPayload(content, ticket);
-        expectMatchProperty(content, 'searchHub', defaultSearchHub);
+        expectMatchProperty(content, 'searchHub', exampleSearchHub);
+    };
+
+    const expectMatchDocumentPayload = (actionCause: CaseAssistActions, doc: PartialDocumentInformation, meta = {}) => {
+        const body: string = lastCallBody(fetchMock);
+        const customData = {...meta};
+        expect(JSON.parse(body.toString())).toMatchObject({
+            actionCause,
+            customData,
+            language: exampleLanguage,
+            clientId: exampleClientId,
+            originContext: exampleOriginContext,
+            originLevel1: exampleSearchHub,
+            originLevel2: exampleOriginLevel2,
+            originLevel3: exampleOriginLevel3,
+            ...doc,
+        });
     };
 
     const expectMatchActionPayload = (
         content: Record<string, unknown>,
         actionName: CaseAssistActions,
-        actionData: Object
+        actionData: Object,
     ) => {
         expectMatchProperty(content, 'ec', 'svc');
         expectMatchProperty(content, 'svc_action', actionName);
@@ -241,33 +272,26 @@ describe('CaseAssistClient', () => {
 
     it('should send proper payload for #logSelectDocumentSuggestion', async () => {
         await client.logSelectDocumentSuggestion({
-            suggestion: fakeDocumentSuggestion(),
+            suggestion: fakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
-        expectMatchPayload(CaseAssistActions.suggestionClick, fakeDocumentSuggestion(), fakeTicket);
-    });
-
-    it('should send proper payload for #logSelectDocumentSuggestion when the fromQuickview property is set to true', async () => {
-        const myFakeDocumentSuggestion = fakeDocumentSuggestion();
-        myFakeDocumentSuggestion.fromQuickview = true;
-        await client.logSelectDocumentSuggestion({
-            suggestion: myFakeDocumentSuggestion,
-            ticket: fakeTicket,
+        expectMatchDocumentPayload(CaseAssistActions.documentSuggestionClick, fakeDocumentSuggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: fakeDocumentSuggestion.permanentId,
         });
-
-        expectMatchPayload(CaseAssistActions.suggestionClick, myFakeDocumentSuggestion, fakeTicket);
     });
 
-    it('should send proper payload for #logSelectDocumentSuggestion when the openDocument property is set to true', async () => {
-        const myFakeDocumentSuggestion = fakeDocumentSuggestion();
-        myFakeDocumentSuggestion.openDocument = true;
-        await client.logSelectDocumentSuggestion({
-            suggestion: myFakeDocumentSuggestion,
+    it('should send proper payload for #logQuickviewDocumentSuggestion', async () => {
+        await client.logQuickviewDocumentSuggestion({
+            suggestion: fakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
-        expectMatchPayload(CaseAssistActions.suggestionClick, myFakeDocumentSuggestion, fakeTicket);
+        expectMatchDocumentPayload(CaseAssistActions.documentSuggestionQuickview, fakeDocumentSuggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: fakeDocumentSuggestion.permanentId,
+        });
     });
 
     it('should send proper payload for #logRateDocumentSuggestion', async () => {
@@ -275,17 +299,17 @@ describe('CaseAssistClient', () => {
 
         await client.logRateDocumentSuggestion({
             rating,
-            suggestion: fakeDocumentSuggestion(),
+            suggestion: fakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
         expectMatchPayload(
             CaseAssistActions.suggestionRate,
             {
-                ...fakeDocumentSuggestion(),
+                ...fakeDocumentSuggestion,
                 rate: rating,
             },
-            fakeTicket
+            fakeTicket,
         );
     });
 
@@ -310,7 +334,7 @@ describe('CaseAssistClient', () => {
             {
                 reason: CaseCancelledReasons.quit,
             },
-            fakeTicket
+            fakeTicket,
         );
     });
 
@@ -324,7 +348,7 @@ describe('CaseAssistClient', () => {
             {
                 reason: CaseCancelledReasons.solved,
             },
-            fakeTicket
+            fakeTicket,
         );
     });
 

package/src/caseAssist/caseAssistClient.ts

@@ -1,7 +1,9 @@
 import CoveoAnalyticsClient, {AnalyticsClient, ClientOptions} from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import doNotTrack from '../donottrack';
+import {ClickEventRequest} from '../events';
 import {SVCPlugin} from '../plugins/svc';
+import {DocumentIdentifier, PartialDocumentInformation, SearchPageEvents} from '../searchPage/searchPageEvents';
 import {
     CaseAssistActions,
     CaseAssistEvents,
@@ -19,6 +21,12 @@ import {
 
 export interface CaseAssistClientProvider {
     getOriginLevel1: () => string;
+    getOriginLevel2: () => string;
+    getOriginLevel3: () => string;
+    getOriginContext: () => string;
+    getIsAnonymous: () => boolean;
+    getSearchUID: () => string;
+    getLanguage: () => string;
 }
 
 export interface CaseAssistClientOptions extends ClientOptions {
@@ -29,7 +37,10 @@ export class CaseAssistClient {
     public coveoAnalyticsClient: AnalyticsClient;
     private svc: SVCPlugin;
 
-    constructor(private options: Partial<CaseAssistClientOptions>, private provider?: CaseAssistClientProvider) {
+    constructor(
+        private options: Partial<CaseAssistClientOptions>,
+        private provider?: CaseAssistClientProvider,
+    ) {
         const analyticsEnabled = (options.enableAnalytics ?? true) && !doNotTrack();
 
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
@@ -67,9 +78,17 @@ export class CaseAssistClient {
     }
 
     public logSelectDocumentSuggestion(meta: SelectDocumentSuggestionMetadata) {
-        this.svc.setAction(CaseAssistActions.suggestionClick, meta.suggestion);
-        this.svc.setTicket(meta.ticket);
-        return this.sendClickEvent();
+        return this.logClickEvent(CaseAssistActions.documentSuggestionClick, meta.suggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: meta.suggestion.permanentId,
+        });
+    }
+
+    public logQuickviewDocumentSuggestion(meta: SelectDocumentSuggestionMetadata) {
+        return this.logClickEvent(CaseAssistActions.documentSuggestionQuickview, meta.suggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: meta.suggestion.permanentId,
+        });
     }
 
     public logRateDocumentSuggestion(meta: RateDocumentSuggestionMetadata) {
@@ -120,7 +139,7 @@ export class CaseAssistClient {
                 ? {
                       searchHub: this.provider.getOriginLevel1(),
                   }
-                : null
+                : null,
         );
     }
 
@@ -133,7 +152,49 @@ export class CaseAssistClient {
                 ? {
                       searchHub: this.provider.getOriginLevel1(),
                   }
-                : null
+                : null,
         );
     }
+
+    private async getBaseEventRequest(metadata?: Record<string, any>) {
+        const customData = {...metadata};
+        return {
+            ...this.getOrigins(),
+            customData,
+            language: this.provider?.getLanguage(),
+            anonymous: this.provider?.getIsAnonymous(),
+            clientId: await this.getClientId(),
+        };
+    }
+
+    private getClientId() {
+        return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
+            ? this.coveoAnalyticsClient.getCurrentVisitorId()
+            : undefined;
+    }
+
+    private getOrigins() {
+        return {
+            originContext: this.provider?.getOriginContext?.(),
+            originLevel1: this.provider?.getOriginLevel1(),
+            originLevel2: this.provider?.getOriginLevel2(),
+            originLevel3: this.provider?.getOriginLevel3(),
+        };
+    }
+
+    private async logClickEvent(
+        event: CaseAssistActions,
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        metadata?: Record<string, any>,
+    ) {
+        const payload: ClickEventRequest = {
+            ...info,
+            ...(await this.getBaseEventRequest({...identifier, ...metadata})),
+            searchQueryUid: this.provider?.getSearchUID() ?? '',
+            actionCause: event,
+        };
+
+        return this.coveoAnalyticsClient.sendClickEvent(payload);
+    }
 }

package/src/client/analytics.spec.ts

@@ -713,7 +713,7 @@ describe('custom clientId', () => {
         const client = new CoveoAnalyticsClient({});
         expect.assertions(1);
         await expect(client.setClientId('somestring')).rejects.toEqual(
-            Error('Cannot generate uuid client id without a specific namespace string.')
+            Error('Cannot generate uuid client id without a specific namespace string.'),
         );
         //uuid v5 specific uuid generation
     });

package/src/client/analytics.ts

@@ -79,19 +79,19 @@ export interface AnalyticsClient {
     ): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
     sendEvent(eventType: string, ...payload: VariableArgumentsPayload): Promise<AnyEventResponse | void>;
     makeSearchEvent(
-        request: PreparedSearchEventRequest
+        request: PreparedSearchEventRequest,
     ): Promise<PreparedEvent<PreparedSearchEventRequest, SearchEventRequest, SearchEventResponse>>;
     sendSearchEvent(request: SearchEventRequest): Promise<SearchEventResponse | void>;
     makeClickEvent(
-        request: PreparedClickEventRequest
+        request: PreparedClickEventRequest,
     ): Promise<PreparedEvent<PreparedClickEventRequest, ClickEventRequest, ClickEventResponse>>;
     sendClickEvent(request: ClickEventRequest): Promise<ClickEventResponse | void>;
     makeCustomEvent(
-        request: PreparedCustomEventRequest
+        request: PreparedCustomEventRequest,
     ): Promise<PreparedEvent<PreparedCustomEventRequest, CustomEventRequest, CustomEventResponse>>;
     sendCustomEvent(request: CustomEventRequest): Promise<CustomEventResponse | void>;
     makeViewEvent(
-        request: PreparedViewEventRequest
+        request: PreparedViewEventRequest,
     ): Promise<PreparedEvent<PreparedViewEventRequest, ViewEventRequest, ViewEventResponse>>;
     sendViewEvent(request: ViewEventRequest): Promise<ViewEventResponse | void>;
     getVisit(): Promise<VisitResponse>;
@@ -220,7 +220,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         } catch (err) {
             console.log(
                 'Could not get visitor ID from the current runtime environment storage. Using a random ID instead.',
-                err
+                err,
             );
             return uuidv4();
         }
@@ -394,7 +394,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
                     payload: {...payloadToSend, ...remainingPayload},
                 });
                 await Promise.all(
-                    this.afterSendHooks.map((hook) => hook(eventType, {...parametersToSend, ...remainingPayload}))
+                    this.afterSendHooks.map((hook) => hook(eventType, {...parametersToSend, ...remainingPayload})),
                 );
                 await this.deferExecution();
                 return (await this.sendFromBuffer()) as TResponse | void;
@@ -431,7 +431,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     async makeSearchEvent(request: PreparedSearchEventRequest) {
         return this.makeEvent<PreparedSearchEventRequest, SearchEventRequest, SearchEventResponse>(
             EventType.search,
-            request
+            request,
         );
     }
 
@@ -442,7 +442,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     async makeClickEvent(request: PreparedClickEventRequest) {
         return this.makeEvent<PreparedClickEventRequest, ClickEventRequest, ClickEventResponse>(
             EventType.click,
-            request
+            request,
         );
     }
 
@@ -453,7 +453,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     async makeCustomEvent(request: PreparedCustomEventRequest) {
         return this.makeEvent<PreparedCustomEventRequest, CustomEventRequest, CustomEventResponse>(
             EventType.custom,
-            request
+            request,
         );
     }
 
@@ -535,7 +535,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
                     ...newPayload,
                     [key]: payload[key],
                 }),
-                {}
+                {},
             );
     }
 
@@ -553,7 +553,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
                     ...newPayload,
                     [key]: payload[key],
                 }),
-                {}
+                {},
             );
         return newPayload;
     }

package/src/client/analyticsBeaconClient.spec.ts

@@ -39,7 +39,7 @@ describe('AnalyticsBeaconClient', () => {
 
         expect(sendBeaconMock).toHaveBeenCalledWith(
             `${baseUrl}/analytics/custom?access_token=👛&visitorId=${currentVisitorId}&discardVisitInfo=true`,
-            expect.anything()
+            expect.anything(),
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(`customEvent=${encodeURIComponent('{"wow":"ok"}')}`);
     });
@@ -63,12 +63,12 @@ describe('AnalyticsBeaconClient', () => {
 
         expect(sendBeaconMock).toHaveBeenCalledWith(
             `${baseUrl}/analytics/collect?visitorId=${currentVisitorId}&discardVisitInfo=true`,
-            expect.anything()
+            expect.anything(),
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(
             `access_token=${encodeURIComponent('👛')}&collectEvent=${encodeURIComponent(
-                '{"pr1a":"value","to encode":"to encode"}'
-            )}`
+                '{"pr1a":"value","to encode":"to encode"}',
+            )}`,
         );
     });
 
@@ -94,10 +94,10 @@ describe('AnalyticsBeaconClient', () => {
 
         expect(sendBeaconMock).toHaveBeenCalledWith(
             `${baseUrl}/analytics/collect?visitorId=${currentVisitorId}&discardVisitInfo=true`,
-            expect.anything()
+            expect.anything(),
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(
-            `access_token=${encodeURIComponent('👛')}&collectEvent=${encodeURIComponent('{"value":{"subvalue":"ok"}}')}`
+            `access_token=${encodeURIComponent('👛')}&collectEvent=${encodeURIComponent('{"value":{"subvalue":"ok"}}')}`,
         );
     });
 
@@ -147,7 +147,7 @@ describe('AnalyticsBeaconClient', () => {
 
             await client.sendEvent(EventType.collect, {foo: 'bar'});
             expect(await getSendBeaconFirstCallBlobArgument()).toBe(
-                'access_token=%F0%9F%91%9B&collectEvent=%7B%22foo%22%3A%22baz%22%7D'
+                'access_token=%F0%9F%91%9B&collectEvent=%7B%22foo%22%3A%22baz%22%7D',
             );
         });
 
@@ -162,7 +162,7 @@ describe('AnalyticsBeaconClient', () => {
 
             await client.sendEvent(EventType.click, {actionCause: 'foo'});
             expect(await getSendBeaconFirstCallBlobArgument()).toContain(
-                `clickEvent=${encodeURIComponent('{"actionCause":"bar"}')}`
+                `clickEvent=${encodeURIComponent('{"actionCause":"bar"}')}`,
             );
         });
 
@@ -176,7 +176,7 @@ describe('AnalyticsBeaconClient', () => {
 
             await client.sendEvent(EventType.click, {actionCause: 'foo'});
             expect(await getSendBeaconFirstCallBlobArgument()).toContain(
-                `clickEvent=${encodeURIComponent('{"actionCause":"foo","aNewProperty":"bar"}')}`
+                `clickEvent=${encodeURIComponent('{"actionCause":"foo","aNewProperty":"bar"}')}`,
             );
         });
 
@@ -188,7 +188,7 @@ describe('AnalyticsBeaconClient', () => {
 
             await client.sendEvent(EventType.click, {actionCause: 'bar'});
             expect(await getSendBeaconFirstCallBlobArgument()).toContain(
-                `clickEvent=${encodeURIComponent(`{"actionCause":"bar"}`)}`
+                `clickEvent=${encodeURIComponent(`{"actionCause":"bar"}`)}`,
             );
         });
     });

package/src/client/analyticsBeaconClient.ts

@@ -7,7 +7,7 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
     public async sendEvent(eventType: EventType, originalPayload: IRequestPayload): Promise<void> {
         if (!this.isAvailable()) {
             throw new Error(
-                `navigator.sendBeacon is not supported in this browser. Consider adding a polyfill like "sendbeacon-polyfill".`
+                `navigator.sendBeacon is not supported in this browser. Consider adding a polyfill like "sendbeacon-polyfill".`,
             );
         }
 
@@ -18,7 +18,7 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
         const {url, payload} = await this.preProcessRequestAsPotentialJSONString(
             `${baseUrl}/analytics/${eventType}?${paramsFragments}`,
             originalPayload,
-            preprocessRequest
+            preprocessRequest,
         );
 
         const parsedRequestData = this.encodeForEventType(eventType, payload);
@@ -41,7 +41,7 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
     private async preProcessRequestAsPotentialJSONString(
         originalURL: string,
         originalPayload: IRequestPayload,
-        preprocessRequest?: PreprocessAnalyticsRequest
+        preprocessRequest?: PreprocessAnalyticsRequest,
     ): Promise<{url: string; payload: IRequestPayload}> {
         let returnedUrl = originalURL;
         let returnedPayload = originalPayload;
@@ -49,7 +49,7 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
         if (preprocessRequest) {
             const processedRequest = await preprocessRequest(
                 {url: originalURL, body: JSON.stringify(originalPayload)},
-                'analyticsBeacon'
+                'analyticsBeacon',
             );
             const {url: processedURL, body: processedBody} = processedRequest;
             returnedUrl = processedURL || originalURL;

package/src/client/analyticsFetchClient.ts

@@ -47,7 +47,7 @@ export class AnalyticsFetchClient implements AnalyticsRequestClient {
             }
             console.error(`An error has occured when sending the "${eventType}" event.`, response, payload);
             throw new Error(
-                `An error has occurred when sending the "${eventType}" event. Check the console logs for more details.`
+                `An error has occurred when sending the "${eventType}" event. Check the console logs for more details.`,
             );
         }
     }

package/src/client/analyticsRequestClient.ts

@@ -21,7 +21,7 @@ export type AnalyticsClientOrigin = 'analyticsFetch' | 'analyticsBeacon';
 
 export type PreprocessAnalyticsRequest = (
     request: IAnalyticsRequestOptions,
-    clientOrigin: AnalyticsClientOrigin
+    clientOrigin: AnalyticsClientOrigin,
 ) => IAnalyticsRequestOptions | Promise<IAnalyticsRequestOptions>;
 
 export interface IAnalyticsRequestOptions extends RequestInit {

package/src/client/measurementProtocolMapper.ts

@@ -24,7 +24,7 @@ export const convertKeysToMeasurementProtocol = (params: any) => {
 };
 
 const measurementProtocolKeysMappingValues = keysOf(measurementProtocolKeysMapping).map(
-    (key) => measurementProtocolKeysMapping[key]
+    (key) => measurementProtocolKeysMapping[key],
 );
 
 const isKnownMeasurementProtocolKey = (key: string) => measurementProtocolKeysMappingValues.indexOf(key) !== -1;
@@ -66,6 +66,6 @@ const convertCustomObject = (prefix: string, customData: {[name: string]: string
             ...allCustom,
             [`${prefix}${currentCustomKey}`]: customData[currentCustomKey],
         }),
-        {}
+        {},
     );
 };

package/src/client/measurementProtocolMapping/baseMeasurementProtocolMapper.ts

@@ -56,6 +56,6 @@ export const baseMeasurementProtocolKeysMapping: {[name: string]: string} = {
             ...all,
             [key]: key,
         }),
-        {}
+        {},
     ),
 };

package/src/client/measurementProtocolMapping/commerceMeasurementProtocolMapper.ts

@@ -112,7 +112,7 @@ export const convertProductToMeasurementProtocol = (product: Product, index: num
 export const convertImpressionListToMeasurementProtocol = (
     impressionList: ImpressionList,
     listIndex: number,
-    prefix: string
+    prefix: string,
 ) => {
     const payload: {[name: string]: any} = impressionList.impressions.reduce(
         (mappedImpressions, impression, productIndex) => {
@@ -121,7 +121,7 @@ export const convertImpressionListToMeasurementProtocol = (
                 ...convertImpressionToMeasurementProtocol(impression, listIndex, productIndex, prefix),
             };
         },
-        {}
+        {},
     );
 
     if (impressionList.listName) {
@@ -135,7 +135,7 @@ const convertImpressionToMeasurementProtocol = (
     impression: BaseImpression,
     listIndex: number,
     productIndex: number,
-    prefix: string
+    prefix: string,
 ) => {
     return keysOf(impression).reduce((mappedImpression, key) => {
         const newKey = `il${listIndex + 1}${prefix}${productIndex + 1}${impressionKeysMapping[key] || key}`;
@@ -150,7 +150,7 @@ const productKeysMappingValues = keysOf(productKeysMapping).map((key) => product
 const impressionKeysMappingValues = keysOf(impressionKeysMapping).map((key) => impressionKeysMapping[key]);
 const productActionsKeysMappingValues = keysOf(productActionsKeysMapping).map((key) => productActionsKeysMapping[key]);
 const transactionActionsKeysMappingValues = keysOf(transactionActionsKeysMapping).map(
-    (key) => transactionActionsKeysMapping[key]
+    (key) => transactionActionsKeysMapping[key],
 );
 const reviewKeysMappingValues = keysOf(reviewActionsKeysMapping).map((key) => reviewActionsKeysMapping[key]);
 const quoteKeysMappingValues = keysOf(quoteActionsKeysMapping).map((key) => quoteActionsKeysMapping[key]);
@@ -166,7 +166,7 @@ const transactionActionsKeyRegex = new RegExp(`^(${transactionActionsKeysMapping
 const customProductKeyRegex = new RegExp(`^${productPrefixMatchGroup}custom$`);
 const customImpressionKeyRegex = new RegExp(`^${impressionPrefixMatchGroup}custom$`);
 const coveoCommerceExtensionKeysRegex = new RegExp(
-    `^(${[...coveoCommerceExtensionKeys, ...reviewKeysMappingValues, ...quoteKeysMappingValues].join('|')})$`
+    `^(${[...coveoCommerceExtensionKeys, ...reviewKeysMappingValues, ...quoteKeysMappingValues].join('|')})$`,
 );
 
 const isProductKey = (key: string) => productKeyRegex.test(key);

package/src/client/noopAnalytics.ts

@@ -28,7 +28,7 @@ export class NoopAnalytics implements AnalyticsClient {
         return Promise.resolve();
     }
     makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(
-        eventType: EventType | string
+        eventType: EventType | string,
     ): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>> {
         return Promise.resolve({eventType: eventType as EventType, payload: null, log: () => Promise.resolve()});
     }