coveo.analytics 2.30.45 → 2.30.46

package/src/searchPage/searchPageClient.spec.ts

@@ -104,7 +104,7 @@ describe('SearchPageClient', () => {
                         Promise.resolve({...payload, customData: {...payload.customData, ...customDataFromMiddleware}}),
                 ],
             },
-            provider
+            provider,
         );
     };
 
@@ -151,7 +151,7 @@ describe('SearchPageClient', () => {
     const expectSearchEventToMatchDescription = (
         description: EventDescription,
         actionCause: SearchPageEvents,
-        meta = {}
+        meta = {},
     ) => {
         expectMatchDescription(description, actionCause, {...meta, genQaMetadata: 'bar'});
     };
@@ -177,7 +177,7 @@ describe('SearchPageClient', () => {
     const expectMatchCustomEventPayload = (
         actionCause: SearchPageEvents,
         meta = {},
-        eventType = CustomEventsTypes[actionCause]
+        eventType = CustomEventsTypes[actionCause],
     ) => {
         const body: string = lastCallBody(fetchMock);
         const customData = {foo: 'bar', ...customDataFromMiddleware, ...meta};

package/src/searchPage/searchPageClient.ts

@@ -80,7 +80,10 @@ export interface EventBuilder<T extends AnyEventResponse = AnyEventResponse> {
 export class CoveoSearchPageClient {
     public coveoAnalyticsClient: AnalyticsClient;
 
-    constructor(private opts: Partial<SearchPageClientOptions>, private provider: SearchPageClientProvider) {
+    constructor(
+        private opts: Partial<SearchPageClientOptions>,
+        private provider: SearchPageClientProvider,
+    ) {
         const shouldDisableAnalytics = opts.enableAnalytics === false || doNotTrack();
         this.coveoAnalyticsClient = shouldDisableAnalytics ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
     }
@@ -289,7 +292,7 @@ export class CoveoSearchPageClient {
         return this.makeCustomEvent(
             SearchPageEvents.triggerQuery,
             {query: this.provider.getSearchEventRequestPayload().queryText},
-            'queryPipelineTriggers'
+            'queryPipelineTriggers',
         );
     }
 
@@ -550,7 +553,7 @@ export class CoveoSearchPageClient {
     public makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier) {
         return this.makeCustomEvent(
             SearchPageEvents.expandSmartSnippetSuggestion,
-            'documentId' in snippet ? snippet : {documentId: snippet}
+            'documentId' in snippet ? snippet : {documentId: snippet},
         );
     }
 
@@ -561,12 +564,12 @@ export class CoveoSearchPageClient {
     public makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier) {
         return this.makeCustomEvent(
             SearchPageEvents.collapseSmartSnippetSuggestion,
-            'documentId' in snippet ? snippet : {documentId: snippet}
+            'documentId' in snippet ? snippet : {documentId: snippet},
         );
     }
 
     public async logCollapseSmartSnippetSuggestion(
-        snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier
+        snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
     ) {
         return (await this.makeCollapseSmartSnippetSuggestion(snippet)).log({searchUID: this.provider.getSearchUID()});
     }
@@ -612,7 +615,7 @@ export class CoveoSearchPageClient {
             SearchPageEvents.openSmartSnippetSuggestionSource,
             info,
             {contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue},
-            snippet
+            snippet,
         );
     }
 
@@ -626,7 +629,7 @@ export class CoveoSearchPageClient {
 
     public async logOpenSmartSnippetSuggestionSource(
         info: PartialDocumentInformation,
-        snippet: SmartSnippetSuggestionMeta
+        snippet: SmartSnippetSuggestionMeta,
     ) {
         return (await this.makeOpenSmartSnippetSuggestionSource(info, snippet)).log({
             searchUID: this.provider.getSearchUID(),
@@ -635,19 +638,19 @@ export class CoveoSearchPageClient {
 
     public makeOpenSmartSnippetInlineLink(
         info: PartialDocumentInformation,
-        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta
+        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta,
     ) {
         return this.makeClickEvent(
             SearchPageEvents.openSmartSnippetInlineLink,
             info,
             {contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue},
-            identifierAndLink
+            identifierAndLink,
         );
     }
 
     public async logOpenSmartSnippetInlineLink(
         info: PartialDocumentInformation,
-        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta
+        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta,
     ) {
         return (await this.makeOpenSmartSnippetInlineLink(info, identifierAndLink)).log({
             searchUID: this.provider.getSearchUID(),
@@ -656,7 +659,7 @@ export class CoveoSearchPageClient {
 
     public makeOpenSmartSnippetSuggestionInlineLink(
         info: PartialDocumentInformation,
-        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta
+        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta,
     ) {
         return this.makeClickEvent(
             SearchPageEvents.openSmartSnippetSuggestionInlineLink,
@@ -665,13 +668,13 @@ export class CoveoSearchPageClient {
                 contentIDKey: snippetAndLink.documentId.contentIdKey,
                 contentIDValue: snippetAndLink.documentId.contentIdValue,
             },
-            snippetAndLink
+            snippetAndLink,
         );
     }
 
     public async logOpenSmartSnippetSuggestionInlineLink(
         info: PartialDocumentInformation,
-        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta
+        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta,
     ) {
         return (await this.makeOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink)).log({
             searchUID: this.provider.getSearchUID(),
@@ -736,7 +739,7 @@ export class CoveoSearchPageClient {
 
     private makeEventDescription(
         preparedEvent: PreparedEvent<unknown, unknown, AnyEventResponse>,
-        actionCause: SearchPageEvents
+        actionCause: SearchPageEvents,
     ): EventDescription {
         return {actionCause, customData: preparedEvent.payload?.customData};
     }
@@ -744,7 +747,7 @@ export class CoveoSearchPageClient {
     public async makeCustomEvent(
         event: SearchPageEvents,
         metadata?: Record<string, any>,
-        eventType: string = CustomEventsTypes[event]!
+        eventType: string = CustomEventsTypes[event]!,
     ): Promise<EventBuilder<CustomEventResponse>> {
         this.coveoAnalyticsClient.getParameters;
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
@@ -763,7 +766,7 @@ export class CoveoSearchPageClient {
     public async logCustomEvent(
         event: SearchPageEvents,
         metadata?: Record<string, any>,
-        eventType: string = CustomEventsTypes[event]!
+        eventType: string = CustomEventsTypes[event]!,
     ) {
         return (await this.makeCustomEvent(event, metadata, eventType)).log({searchUID: this.provider.getSearchUID()});
     }
@@ -771,7 +774,7 @@ export class CoveoSearchPageClient {
     public async makeCustomEventWithType(
         eventValue: string,
         eventType: string,
-        metadata?: Record<string, any>
+        metadata?: Record<string, any>,
     ): Promise<EventBuilder<CustomEventResponse>> {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
         const payload: CustomEventRequest = {
@@ -798,7 +801,7 @@ export class CoveoSearchPageClient {
 
     public async makeSearchEvent(
         event: SearchPageEvents,
-        metadata?: Record<string, any>
+        metadata?: Record<string, any>,
     ): Promise<EventBuilder<SearchEventResponse>> {
         const request = await this.getBaseSearchEventRequest(event, metadata);
         const preparedEvent = await this.coveoAnalyticsClient.makeSearchEvent(request);
@@ -812,7 +815,7 @@ export class CoveoSearchPageClient {
         event: SearchPageEvents,
         info: PartialDocumentInformation,
         identifier: DocumentIdentifier,
-        metadata?: Record<string, any>
+        metadata?: Record<string, any>,
     ): Promise<EventBuilder<ClickEventResponse>> {
         const request: PreparedClickEventRequest = {
             ...info,
@@ -831,7 +834,7 @@ export class CoveoSearchPageClient {
         event: SearchPageEvents,
         info: PartialDocumentInformation,
         identifier: DocumentIdentifier,
-        metadata?: Record<string, any>
+        metadata?: Record<string, any>,
     ) {
         return (await this.makeClickEvent(event, info, identifier, metadata)).log({
             searchUID: this.provider.getSearchUID(),
@@ -840,7 +843,7 @@ export class CoveoSearchPageClient {
 
     private async getBaseSearchEventRequest(
         event: SearchPageEvents,
-        metadata?: Record<string, any>
+        metadata?: Record<string, any>,
     ): Promise<PreparedSearchEventRequest> {
         return {
             ...(await this.getBaseEventRequest({...metadata, ...this.provider.getGeneratedAnswerMetadata?.()})),
@@ -915,19 +918,19 @@ export class CoveoSearchPageClient {
 
     public makeGeneratedAnswerCitationClick(
         info: PartialDocumentInformation,
-        citation: GeneratedAnswerCitationClickMeta
+        citation: GeneratedAnswerCitationClickMeta,
     ) {
         return this.makeClickEvent(
             SearchPageEvents.generatedAnswerCitationClick,
             {...info, documentPosition: 1},
             {contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
-            citation
+            citation,
         );
     }
 
     public async logGeneratedAnswerCitationClick(
         info: PartialDocumentInformation,
-        citation: GeneratedAnswerCitationClickMeta
+        citation: GeneratedAnswerCitationClickMeta,
     ) {
         return (await this.makeGeneratedAnswerCitationClick(info, citation)).log({
             searchUID: this.provider.getSearchUID(),

package/src/searchPage/searchPageEvents.ts

@@ -361,7 +361,8 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.triggerExecute]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerQuery]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerRedirect]: 'queryPipelineTriggers',
-    [SearchPageEvents.queryError]: 'errors',
+    // This value is the same as SearchPageEvents.triggerQuery, which is very likely a mistake.
+    //[SearchPageEvents.queryError]: 'errors',
     [SearchPageEvents.queryErrorBack]: 'errors',
     [SearchPageEvents.queryErrorClear]: 'errors',
     [SearchPageEvents.queryErrorRetry]: 'errors',

package/src/version.ts

@@ -1 +1 @@
-export const libVersion = process.env.PKG_VERSION || 'local'; // processed by @rollup/plugin-replace
+export const libVersion = 'local'; // processed by @rollup/plugin-replace