coveo.analytics 2.19.1 → 2.19.4

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

@@ -78,6 +78,7 @@ export declare class CoveoSearchPageClient {
     logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<void | import("../events").CustomEventResponse>;
     logExpandSmartSnippetSuggestion(documentId: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
     logCollapseSmartSnippetSuggestion(documentId: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
+    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): 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>;

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

@@ -53,6 +53,7 @@ export declare enum SearchPageEvents {
     sendSmartSnippetReason = "sendSmartSnippetReason",
     expandSmartSnippetSuggestion = "expandSmartSnippetSuggestion",
     collapseSmartSnippetSuggestion = "collapseSmartSnippetSuggestion",
+    openSmartSnippetSource = "openSmartSnippetSource",
     recentQueryClick = "recentQueriesClick",
     clearRecentQueries = "clearRecentQueries",
     recentResultClick = "recentResultClick",
@@ -143,12 +144,7 @@ export interface QueryErrorMeta {
     errorType: string;
     errorMessage: string;
 }
-export declare enum SmartSnippetFeedbackReason {
-    DoesNotAnswer = "does_not_answer",
-    PartiallyAnswers = "partially_answers",
-    WasNotAQuestion = "was_not_a_question",
-    Other = "other"
-}
+export declare type SmartSnippetFeedbackReason = 'does_not_answer' | 'partially_answers' | 'was_not_a_question' | 'other';
 export interface SmartSnippetSuggestionMeta {
     contentIdKey: string;
     contentIdValue: string;

package/dist/library.es.js

@@ -1111,6 +1111,7 @@ var SearchPageEvents;
     SearchPageEvents["sendSmartSnippetReason"] = "sendSmartSnippetReason";
     SearchPageEvents["expandSmartSnippetSuggestion"] = "expandSmartSnippetSuggestion";
     SearchPageEvents["collapseSmartSnippetSuggestion"] = "collapseSmartSnippetSuggestion";
+    SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -1147,14 +1148,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentQueries]: 'recentQueries',
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
-};
-var SmartSnippetFeedbackReason;
-(function (SmartSnippetFeedbackReason) {
-    SmartSnippetFeedbackReason["DoesNotAnswer"] = "does_not_answer";
-    SmartSnippetFeedbackReason["PartiallyAnswers"] = "partially_answers";
-    SmartSnippetFeedbackReason["WasNotAQuestion"] = "was_not_a_question";
-    SmartSnippetFeedbackReason["Other"] = "other";
-})(SmartSnippetFeedbackReason || (SmartSnippetFeedbackReason = {}));
+};
 
 class NoopAnalytics {
     constructor() {
@@ -1418,6 +1412,9 @@ class CoveoSearchPageClient {
     logCollapseSmartSnippetSuggestion(documentId) {
         return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, { documentId });
     }
+    logOpenSmartSnippetSource(info, identifier) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
+    }
     logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }

package/dist/library.js

@@ -83728,6 +83728,7 @@ var SearchPageEvents;
     SearchPageEvents["sendSmartSnippetReason"] = "sendSmartSnippetReason";
     SearchPageEvents["expandSmartSnippetSuggestion"] = "expandSmartSnippetSuggestion";
     SearchPageEvents["collapseSmartSnippetSuggestion"] = "collapseSmartSnippetSuggestion";
+    SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -83764,14 +83765,7 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.clearRecentQueries] = 'recentQueries',
     _a[SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
-    _a);
-var SmartSnippetFeedbackReason;
-(function (SmartSnippetFeedbackReason) {
-    SmartSnippetFeedbackReason["DoesNotAnswer"] = "does_not_answer";
-    SmartSnippetFeedbackReason["PartiallyAnswers"] = "partially_answers";
-    SmartSnippetFeedbackReason["WasNotAQuestion"] = "was_not_a_question";
-    SmartSnippetFeedbackReason["Other"] = "other";
-})(SmartSnippetFeedbackReason || (SmartSnippetFeedbackReason = {}));
+    _a);
 
 var NoopAnalytics = (function () {
     function NoopAnalytics() {
@@ -84054,6 +84048,9 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logCollapseSmartSnippetSuggestion = function (documentId) {
         return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, { documentId: documentId });
     };
+    CoveoSearchPageClient.prototype.logOpenSmartSnippetSource = function (info, identifier) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
+    };
     CoveoSearchPageClient.prototype.logRecentQueryClick = function () {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.19.1",
+    "version": "2.19.4",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -23,7 +23,7 @@
     },
     "license": "MIT",
     "dependencies": {
-        "@react-native-async-storage/async-storage": "^1.15.16",
+        "@react-native-async-storage/async-storage": "^1.15.17",
         "cross-fetch": "^3.1.5"
     },
     "devDependencies": {

package/src/searchPage/searchPageClient.spec.ts

@@ -506,10 +506,10 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #logSmartSnippetFeedbackReason', async () => {
-        await client.logSmartSnippetFeedbackReason(SmartSnippetFeedbackReason.DoesNotAnswer, 'this is irrelevant');
+        await client.logSmartSnippetFeedbackReason('does_not_answer', 'this is irrelevant');
         expectMatchCustomEventPayload(SearchPageEvents.sendSmartSnippetReason, {
             details: 'this is irrelevant',
-            reason: SmartSnippetFeedbackReason.DoesNotAnswer,
+            reason: 'does_not_answer',
         });
     });
 
@@ -527,6 +527,11 @@ describe('SearchPageClient', () => {
         });
     });
 
+    it('should send proper payload for #logOpenSmartSnippetSource', async () => {
+        await client.logOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
+        expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);
+    });
+
     it('should send proper payload for #logRecentQueryClick', async () => {
         await client.logRecentQueryClick();
         expectMatchPayload(SearchPageEvents.recentQueryClick);

package/src/searchPage/searchPageClient.ts

@@ -286,6 +286,10 @@ export class CoveoSearchPageClient {
         return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, {documentId});
     }
 
+    public logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
+    }
+
     public logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }

package/src/searchPage/searchPageEvents.ts

@@ -213,6 +213,10 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a snippet suggestion for a related question is collapsed.
      */
     collapseSmartSnippetSuggestion = 'collapseSmartSnippetSuggestion',
+    /**
+     * Identifies the custom event that gets logged when a user clicks on the source of an answer in a smart snippet.
+     */
+    openSmartSnippetSource = 'openSmartSnippetSource',
     /**
      * Identifies the search event that gets logged when a recent queries list item gets clicked.
      */
@@ -370,12 +374,7 @@ export interface QueryErrorMeta {
     errorMessage: string;
 }
 
-export enum SmartSnippetFeedbackReason {
-    DoesNotAnswer = 'does_not_answer',
-    PartiallyAnswers = 'partially_answers',
-    WasNotAQuestion = 'was_not_a_question',
-    Other = 'other',
-}
+export type SmartSnippetFeedbackReason = 'does_not_answer' | 'partially_answers' | 'was_not_a_question' | 'other';
 
 export interface SmartSnippetSuggestionMeta {
     contentIdKey: string;