coveo.analytics 2.19.9 → 2.19.12

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,10 @@ 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>;
+    logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
+    logShowLessSmartSnippetSuggestion(snippet: 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>;

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

@@ -53,6 +53,8 @@ export declare enum SearchPageEvents {
     sendSmartSnippetReason = "sendSmartSnippetReason",
     expandSmartSnippetSuggestion = "expandSmartSnippetSuggestion",
     collapseSmartSnippetSuggestion = "collapseSmartSnippetSuggestion",
+    showMoreSmartSnippetSuggestion = "showMoreSmartSnippetSuggestion",
+    showLessSmartSnippetSuggestion = "showLessSmartSnippetSuggestion",
     openSmartSnippetSource = "openSmartSnippetSource",
     recentQueryClick = "recentQueriesClick",
     clearRecentQueries = "clearRecentQueries",
@@ -148,6 +150,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

@@ -1111,6 +1111,8 @@ var SearchPageEvents;
     SearchPageEvents["sendSmartSnippetReason"] = "sendSmartSnippetReason";
     SearchPageEvents["expandSmartSnippetSuggestion"] = "expandSmartSnippetSuggestion";
     SearchPageEvents["collapseSmartSnippetSuggestion"] = "collapseSmartSnippetSuggestion";
+    SearchPageEvents["showMoreSmartSnippetSuggestion"] = "showMoreSmartSnippetSuggestion";
+    SearchPageEvents["showLessSmartSnippetSuggestion"] = "showLessSmartSnippetSuggestion";
     SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
@@ -1147,6 +1149,8 @@ const CustomEventsTypes = {
     [SearchPageEvents.sendSmartSnippetReason]: 'smartSnippet',
     [SearchPageEvents.expandSmartSnippetSuggestion]: 'smartSnippetSuggestions',
     [SearchPageEvents.collapseSmartSnippetSuggestion]: 'smartSnippetSuggestions',
+    [SearchPageEvents.showMoreSmartSnippetSuggestion]: 'smartSnippetSuggestions',
+    [SearchPageEvents.showLessSmartSnippetSuggestion]: 'smartSnippetSuggestions',
     [SearchPageEvents.clearRecentQueries]: 'recentQueries',
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
@@ -1409,11 +1413,17 @@ 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 });
+    }
+    logShowMoreSmartSnippetSuggestion(snippet) {
+        return this.logCustomEvent(SearchPageEvents.showMoreSmartSnippetSuggestion, snippet);
+    }
+    logShowLessSmartSnippetSuggestion(snippet) {
+        return this.logCustomEvent(SearchPageEvents.showLessSmartSnippetSuggestion, snippet);
     }
     logOpenSmartSnippetSource(info, identifier) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);

package/dist/library.js

@@ -83553,6 +83553,8 @@ var SearchPageEvents;
     SearchPageEvents["sendSmartSnippetReason"] = "sendSmartSnippetReason";
     SearchPageEvents["expandSmartSnippetSuggestion"] = "expandSmartSnippetSuggestion";
     SearchPageEvents["collapseSmartSnippetSuggestion"] = "collapseSmartSnippetSuggestion";
+    SearchPageEvents["showMoreSmartSnippetSuggestion"] = "showMoreSmartSnippetSuggestion";
+    SearchPageEvents["showLessSmartSnippetSuggestion"] = "showLessSmartSnippetSuggestion";
     SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
@@ -83589,6 +83591,8 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.sendSmartSnippetReason] = 'smartSnippet',
     _a[SearchPageEvents.expandSmartSnippetSuggestion] = 'smartSnippetSuggestions',
     _a[SearchPageEvents.collapseSmartSnippetSuggestion] = 'smartSnippetSuggestions',
+    _a[SearchPageEvents.showMoreSmartSnippetSuggestion] = 'smartSnippetSuggestions',
+    _a[SearchPageEvents.showLessSmartSnippetSuggestion] = 'smartSnippetSuggestions',
     _a[SearchPageEvents.clearRecentQueries] = 'recentQueries',
     _a[SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
@@ -83870,11 +83874,17 @@ 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.logShowMoreSmartSnippetSuggestion = function (snippet) {
+        return this.logCustomEvent(SearchPageEvents.showMoreSmartSnippetSuggestion, snippet);
+    };
+    CoveoSearchPageClient.prototype.logShowLessSmartSnippetSuggestion = function (snippet) {
+        return this.logCustomEvent(SearchPageEvents.showLessSmartSnippetSuggestion, 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.9",
+    "version": "2.19.12",
     "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.16.1",
+        "@react-native-async-storage/async-storage": "^1.17.3",
         "cross-fetch": "^3.1.5"
     },
     "devDependencies": {

package/src/searchPage/searchPageClient.spec.ts

@@ -524,19 +524,71 @@ 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'},
         });
     });
 
+    it('should send proper payload for #logShowMoreSmartSnippetSuggestion', async () => {
+        await client.logShowMoreSmartSnippetSuggestion({
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+        expectMatchCustomEventPayload(SearchPageEvents.showMoreSmartSnippetSuggestion, {
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+    });
+
+    it('should send proper payload for #logShowLessSmartSnippetSuggestion', async () => {
+        await client.logShowLessSmartSnippetSuggestion({
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+        expectMatchCustomEventPayload(SearchPageEvents.showLessSmartSnippetSuggestion, {
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        });
+    });
+
     it('should send proper payload for #logOpenSmartSnippetSource', async () => {
         await client.logOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);

package/src/searchPage/searchPageClient.ts

@@ -22,6 +22,7 @@ import {
     FacetStateMetadata,
     SmartSnippetFeedbackReason,
     SmartSnippetSuggestionMeta,
+    SmartSnippetDocumentIdentifier,
     StaticFilterMetadata,
     StaticFilterToggleValueMetadata,
 } from './searchPageEvents';
@@ -278,12 +279,26 @@ 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 logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta) {
+        return this.logCustomEvent(SearchPageEvents.showMoreSmartSnippetSuggestion, snippet);
+    }
+
+    public logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta) {
+        return this.logCustomEvent(SearchPageEvents.showLessSmartSnippetSuggestion, snippet);
     }
 
     public logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier) {

package/src/searchPage/searchPageEvents.ts

@@ -213,6 +213,14 @@ 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 the user presses "show more" on a snippet suggestion for a related question.
+     */
+    showMoreSmartSnippetSuggestion = 'showMoreSmartSnippetSuggestion',
+    /**
+     * Identifies the custom event that gets logged when the user presses "show less" on a snippet suggestion for a related question.
+     */
+    showLessSmartSnippetSuggestion = 'showLessSmartSnippetSuggestion',
     /**
      * Identifies the custom event that gets logged when a user clicks on the source of an answer in a smart snippet.
      */
@@ -274,6 +282,8 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents, string>> = {
     [SearchPageEvents.sendSmartSnippetReason]: 'smartSnippet',
     [SearchPageEvents.expandSmartSnippetSuggestion]: 'smartSnippetSuggestions',
     [SearchPageEvents.collapseSmartSnippetSuggestion]: 'smartSnippetSuggestions',
+    [SearchPageEvents.showMoreSmartSnippetSuggestion]: 'smartSnippetSuggestions',
+    [SearchPageEvents.showLessSmartSnippetSuggestion]: 'smartSnippetSuggestions',
     [SearchPageEvents.clearRecentQueries]: 'recentQueries',
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
@@ -386,6 +396,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;
 }