coveo.analytics 2.20.21 → 2.20.23

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, UndoTriggerRedirectMetadata } 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, SmartSnippetLinkMeta } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -85,6 +85,8 @@ export declare class CoveoSearchPageClient {
     logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
     logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
     logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<void | import("../events").ClickEventResponse>;
     logRecentQueryClick(): Promise<void | import("../events").SearchEventResponse>;
     logClearRecentQueries(): Promise<void | import("../events").CustomEventResponse>;
     logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").CustomEventResponse>;
@@ -92,7 +94,7 @@ export declare class CoveoSearchPageClient {
     logNoResultsBack(): Promise<void | import("../events").SearchEventResponse>;
     logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
     logShowLessFoldedResults(): Promise<void | import("../events").CustomEventResponse>;
-    logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
+    logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<void | import("../events").CustomEventResponse>;
     logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
     logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;

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

@@ -59,6 +59,8 @@ export declare enum SearchPageEvents {
     showLessSmartSnippetSuggestion = "showLessSmartSnippetSuggestion",
     openSmartSnippetSource = "openSmartSnippetSource",
     openSmartSnippetSuggestionSource = "openSmartSnippetSuggestionSource",
+    openSmartSnippetInlineLink = "openSmartSnippetInlineLink",
+    openSmartSnippetSuggestionInlineLink = "openSmartSnippetSuggestionInlineLink",
     recentQueryClick = "recentQueriesClick",
     clearRecentQueries = "clearRecentQueries",
     recentResultClick = "recentResultClick",
@@ -160,6 +162,10 @@ export interface SmartSnippetSuggestionMeta {
     answerSnippet: string;
     documentId: SmartSnippetDocumentIdentifier;
 }
+export interface SmartSnippetLinkMeta {
+    linkText: string;
+    linkURL: string;
+}
 export interface SmartSnippetDocumentIdentifier {
     contentIdKey: string;
     contentIdValue: string;

package/dist/library.es.js

@@ -1149,6 +1149,8 @@ var SearchPageEvents;
     SearchPageEvents["showLessSmartSnippetSuggestion"] = "showLessSmartSnippetSuggestion";
     SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["openSmartSnippetSuggestionSource"] = "openSmartSnippetSuggestionSource";
+    SearchPageEvents["openSmartSnippetInlineLink"] = "openSmartSnippetInlineLink";
+    SearchPageEvents["openSmartSnippetSuggestionInlineLink"] = "openSmartSnippetSuggestionInlineLink";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -1356,7 +1358,7 @@ class CoveoSearchPageClient {
     }
     logTriggerQuery() {
         const meta = { query: this.provider.getSearchEventRequestPayload().queryText };
-        return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
+        return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
     }
     logUndoTriggerQuery(meta) {
         return this.logSearchEvent(SearchPageEvents.undoTriggerQuery, meta);
@@ -1470,6 +1472,15 @@ class CoveoSearchPageClient {
     logOpenSmartSnippetSuggestionSource(info, snippet) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
     }
+    logOpenSmartSnippetInlineLink(info, identifierAndLink) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, identifierAndLink);
+    }
+    logOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
+            contentIDKey: snippetAndLink.documentId.contentIdKey,
+            contentIDValue: snippetAndLink.documentId.contentIdValue,
+        }, snippetAndLink);
+    }
     logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }
@@ -1491,10 +1502,10 @@ class CoveoSearchPageClient {
     logShowLessFoldedResults() {
         return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
     }
-    logCustomEvent(event, metadata) {
+    logCustomEvent(event, metadata, eventType = CustomEventsTypes[event]) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
-            const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
+            const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType, eventValue: event });
             return this.coveoAnalyticsClient.sendCustomEvent(payload);
         });
     }

package/dist/library.js

@@ -83609,6 +83609,8 @@ var SearchPageEvents;
     SearchPageEvents["showLessSmartSnippetSuggestion"] = "showLessSmartSnippetSuggestion";
     SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["openSmartSnippetSuggestionSource"] = "openSmartSnippetSuggestionSource";
+    SearchPageEvents["openSmartSnippetInlineLink"] = "openSmartSnippetInlineLink";
+    SearchPageEvents["openSmartSnippetSuggestionInlineLink"] = "openSmartSnippetSuggestionInlineLink";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -83817,7 +83819,7 @@ var CoveoSearchPageClient = (function () {
     };
     CoveoSearchPageClient.prototype.logTriggerQuery = function () {
         var meta = { query: this.provider.getSearchEventRequestPayload().queryText };
-        return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
+        return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
     };
     CoveoSearchPageClient.prototype.logUndoTriggerQuery = function (meta) {
         return this.logSearchEvent(SearchPageEvents.undoTriggerQuery, meta);
@@ -83949,6 +83951,15 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logOpenSmartSnippetSuggestionSource = function (info, snippet) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
     };
+    CoveoSearchPageClient.prototype.logOpenSmartSnippetInlineLink = function (info, identifierAndLink) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, identifierAndLink);
+    };
+    CoveoSearchPageClient.prototype.logOpenSmartSnippetSuggestionInlineLink = function (info, snippetAndLink) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
+            contentIDKey: snippetAndLink.documentId.contentIdKey,
+            contentIDValue: snippetAndLink.documentId.contentIdValue,
+        }, snippetAndLink);
+    };
     CoveoSearchPageClient.prototype.logRecentQueryClick = function () {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     };
@@ -83970,7 +83981,8 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logShowLessFoldedResults = function () {
         return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
     };
-    CoveoSearchPageClient.prototype.logCustomEvent = function (event, metadata) {
+    CoveoSearchPageClient.prototype.logCustomEvent = function (event, metadata, eventType) {
+        if (eventType === void 0) { eventType = CustomEventsTypes[event]; }
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;
             return __generator(this, function (_b) {
@@ -83980,7 +83992,7 @@ var CoveoSearchPageClient = (function () {
                         _a = [{}];
                         return [4, this.getBaseCustomEventRequest(customData)];
                     case 1:
-                        payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), { eventType: CustomEventsTypes[event], eventValue: event }]);
+                        payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), { eventType: eventType, eventValue: event }]);
                         return [2, this.coveoAnalyticsClient.sendCustomEvent(payload)];
                 }
             });

package/package.json

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

package/src/searchPage/searchPageClient.spec.ts

@@ -135,12 +135,16 @@ describe('SearchPageClient', () => {
         });
     };
 
-    const expectMatchCustomEventPayload = (actionCause: SearchPageEvents, meta = {}) => {
+    const expectMatchCustomEventPayload = (
+        actionCause: SearchPageEvents,
+        meta = {},
+        eventType = CustomEventsTypes[actionCause]
+    ) => {
         const [, {body}] = fetchMock.lastCall();
         const customData = {foo: 'bar', ...meta};
         expect(JSON.parse(body.toString())).toMatchObject({
             eventValue: actionCause,
-            eventType: CustomEventsTypes[actionCause],
+            eventType,
             lastSearchQueryUid: 'my-uid',
             customData,
             language: 'en',
@@ -282,7 +286,7 @@ describe('SearchPageClient', () => {
             query: 'queryText',
         };
         await client.logTriggerQuery();
-        expectMatchCustomEventPayload(SearchPageEvents.triggerQuery, meta);
+        expectMatchCustomEventPayload(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
     });
 
     it('should send proper payload for #logUndoTriggerQuery', async () => {
@@ -633,6 +637,32 @@ describe('SearchPageClient', () => {
         });
     });
 
+    it('should send proper payload for #logOpenSmartSnippetInlineLink', async () => {
+        const meta = {
+            ...fakeDocID,
+            linkText: 'Some text',
+            linkURL: 'https://invalid.com',
+        };
+        await client.logOpenSmartSnippetInlineLink(fakeDocInfo, meta);
+        expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetInlineLink, fakeDocInfo, meta);
+    });
+
+    it('should send proper payload for #logOpenSmartSnippetSuggestionInlineLink', async () => {
+        const meta = {
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            linkText: 'Some text',
+            linkURL: 'https://invalid.com',
+        };
+        await client.logOpenSmartSnippetSuggestionInlineLink(fakeDocInfo, meta);
+        expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSuggestionInlineLink, fakeDocInfo, {
+            ...meta,
+            contentIDKey: meta.documentId.contentIdKey,
+            contentIDValue: meta.documentId.contentIdValue,
+        });
+    });
+
     it('should send proper payload for #logRecentQueryClick', async () => {
         await client.logRecentQueryClick();
         expectMatchPayload(SearchPageEvents.recentQueryClick);

package/src/searchPage/searchPageClient.ts

@@ -26,6 +26,7 @@ import {
     StaticFilterMetadata,
     StaticFilterToggleValueMetadata,
     UndoTriggerRedirectMetadata,
+    SmartSnippetLinkMeta,
 } from './searchPageEvents';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -168,7 +169,7 @@ export class CoveoSearchPageClient {
 
     public logTriggerQuery() {
         const meta = {query: this.provider.getSearchEventRequestPayload().queryText};
-        return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
+        return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
     }
 
     public logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata) {
@@ -328,6 +329,33 @@ export class CoveoSearchPageClient {
         );
     }
 
+    public logOpenSmartSnippetInlineLink(
+        info: PartialDocumentInformation,
+        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetInlineLink,
+            info,
+            {contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue},
+            identifierAndLink
+        );
+    }
+
+    public logOpenSmartSnippetSuggestionInlineLink(
+        info: PartialDocumentInformation,
+        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetSuggestionInlineLink,
+            info,
+            {
+                contentIDKey: snippetAndLink.documentId.contentIdKey,
+                contentIDValue: snippetAndLink.documentId.contentIdValue,
+            },
+            snippetAndLink
+        );
+    }
+
     public logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }
@@ -356,12 +384,16 @@ export class CoveoSearchPageClient {
         return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
     }
 
-    public async logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
+    public async logCustomEvent(
+        event: SearchPageEvents,
+        metadata?: Record<string, any>,
+        eventType: string = CustomEventsTypes[event]!
+    ) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 
         const payload: CustomEventRequest = {
             ...(await this.getBaseCustomEventRequest(customData)),
-            eventType: CustomEventsTypes[event]!,
+            eventType,
             eventValue: event,
         };
 

package/src/searchPage/searchPageEvents.ts

@@ -238,6 +238,14 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user clicks on the source of a snippet suggestion for a related question.
      */
     openSmartSnippetSuggestionSource = 'openSmartSnippetSuggestionSource',
+    /**
+     * Identifies the custom event that gets logged when a user clicks on a link in the answer of a smart snippet.
+     */
+    openSmartSnippetInlineLink = 'openSmartSnippetInlineLink',
+    /**
+     * Identifies the custom event that gets logged when a user clicks on a link in the snippet suggestion for a related question.
+     */
+    openSmartSnippetSuggestionInlineLink = 'openSmartSnippetSuggestionInlineLink',
     /**
      * Identifies the search event that gets logged when a recent queries list item gets clicked.
      */
@@ -419,6 +427,11 @@ export interface SmartSnippetSuggestionMeta {
     documentId: SmartSnippetDocumentIdentifier;
 }
 
+export interface SmartSnippetLinkMeta {
+    linkText: string;
+    linkURL: string;
+}
+
 export interface SmartSnippetDocumentIdentifier {
     contentIdKey: string;
     contentIdValue: string;