coveo.analytics 2.19.8 → 2.19.11

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, 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 } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -76,8 +76,8 @@ export declare class CoveoSearchPageClient {
     logOpenSmartSnippetFeedbackModal(): Promise<void | import("../events").CustomEventResponse>;
     logCloseSmartSnippetFeedbackModal(): Promise<void | import("../events").CustomEventResponse>;
     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>;
+    logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | import("../events").CustomEventResponse>;
+    logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): 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>;

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

@@ -148,6 +148,11 @@ export interface QueryErrorMeta {
 }
 export declare type SmartSnippetFeedbackReason = 'does_not_answer' | 'partially_answers' | 'was_not_a_question' | 'other';
 export interface SmartSnippetSuggestionMeta {
+    question: string;
+    answerSnippet: string;
+    documentId: SmartSnippetDocumentIdentifier;
+}
+export interface SmartSnippetDocumentIdentifier {
     contentIdKey: string;
     contentIdValue: string;
 }

package/dist/library.es.js

@@ -1409,11 +1409,11 @@ class CoveoSearchPageClient {
     logSmartSnippetFeedbackReason(reason, details) {
         return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, { reason, details });
     }
-    logExpandSmartSnippetSuggestion(documentId) {
-        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, { documentId });
+    logExpandSmartSnippetSuggestion(snippet) {
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
     }
-    logCollapseSmartSnippetSuggestion(documentId) {
-        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, { documentId });
+    logCollapseSmartSnippetSuggestion(snippet) {
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
     }
     logOpenSmartSnippetSource(info, identifier) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);

package/dist/library.js

@@ -83870,11 +83870,11 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logSmartSnippetFeedbackReason = function (reason, details) {
         return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, { reason: reason, details: details });
     };
-    CoveoSearchPageClient.prototype.logExpandSmartSnippetSuggestion = function (documentId) {
-        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, { documentId: documentId });
+    CoveoSearchPageClient.prototype.logExpandSmartSnippetSuggestion = function (snippet) {
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
     };
-    CoveoSearchPageClient.prototype.logCollapseSmartSnippetSuggestion = function (documentId) {
-        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, { documentId: documentId });
+    CoveoSearchPageClient.prototype.logCollapseSmartSnippetSuggestion = function (snippet) {
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
     };
     CoveoSearchPageClient.prototype.logOpenSmartSnippetSource = function (info, identifier) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.19.8",
+    "version": "2.19.11",
     "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.17",
+        "@react-native-async-storage/async-storage": "^1.17.3",
         "cross-fetch": "^3.1.5"
     },
     "devDependencies": {

package/src/searchPage/searchPageClient.spec.ts

@@ -524,13 +524,39 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #logExpandSmartSnippetSuggestion', async () => {
-        await client.logExpandSmartSnippetSuggestion({contentIdKey: 'permanentid', contentIdValue: 'foo'});
+        await client.logExpandSmartSnippetSuggestion({
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
         expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippetSuggestion, {
+            question: 'Abc',
+            answerSnippet: 'Def',
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         });
     });
 
     it('should send proper payload for #logCollapseSmartSnippetSuggestion', async () => {
+        await client.logCollapseSmartSnippetSuggestion({
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+        expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippetSuggestion, {
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+    });
+
+    it('should send proper payload for #logExpandSmartSnippetSuggestion when called with only the documentId', async () => {
+        await client.logExpandSmartSnippetSuggestion({contentIdKey: 'permanentid', contentIdValue: 'foo'});
+        expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippetSuggestion, {
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+    });
+
+    it('should send proper payload for #logCollapseSmartSnippetSuggestion when called with only the documentId', async () => {
         await client.logCollapseSmartSnippetSuggestion({contentIdKey: 'permanentid', contentIdValue: 'foo'});
         expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippetSuggestion, {
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},

package/src/searchPage/searchPageClient.ts

@@ -22,6 +22,7 @@ import {
     FacetStateMetadata,
     SmartSnippetFeedbackReason,
     SmartSnippetSuggestionMeta,
+    SmartSnippetDocumentIdentifier,
     StaticFilterMetadata,
     StaticFilterToggleValueMetadata,
 } from './searchPageEvents';
@@ -278,12 +279,18 @@ export class CoveoSearchPageClient {
         return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, {reason, details});
     }
 
-    public logExpandSmartSnippetSuggestion(documentId: SmartSnippetSuggestionMeta) {
-        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, {documentId});
+    public logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier) {
+        return this.logCustomEvent(
+            SearchPageEvents.expandSmartSnippetSuggestion,
+            'documentId' in snippet ? snippet : {documentId: snippet}
+        );
     }
 
-    public logCollapseSmartSnippetSuggestion(documentId: SmartSnippetSuggestionMeta) {
-        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, {documentId});
+    public logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier) {
+        return this.logCustomEvent(
+            SearchPageEvents.collapseSmartSnippetSuggestion,
+            'documentId' in snippet ? snippet : {documentId: snippet}
+        );
     }
 
     public logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier) {

package/src/searchPage/searchPageEvents.ts

@@ -386,6 +386,12 @@ export interface QueryErrorMeta {
 export type SmartSnippetFeedbackReason = 'does_not_answer' | 'partially_answers' | 'was_not_a_question' | 'other';
 
 export interface SmartSnippetSuggestionMeta {
+    question: string;
+    answerSnippet: string;
+    documentId: SmartSnippetDocumentIdentifier;
+}
+
+export interface SmartSnippetDocumentIdentifier {
     contentIdKey: string;
     contentIdValue: string;
 }