coveo.analytics 2.28.10 → 2.28.12

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

@@ -1,6 +1,6 @@
 import { ClientOptions, AnalyticsClient } from '../client/analytics';
 import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } 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, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta } 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, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -193,4 +193,6 @@ export declare class CoveoSearchPageClient {
     logOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<void | CustomEventResponse>;
     makeRetryGeneratedAnswer(): Promise<EventBuilder<SearchEventResponse>>;
     logRetryGeneratedAnswer(): Promise<void | SearchEventResponse>;
+    makeGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta): Promise<void | CustomEventResponse>;
 }

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

@@ -76,7 +76,8 @@ export declare enum SearchPageEvents {
     retryGeneratedAnswer = "retryGeneratedAnswer",
     likeGeneratedAnswer = "likeGeneratedAnswer",
     dislikeGeneratedAnswer = "dislikeGeneratedAnswer",
-    openGeneratedAnswerSource = "openGeneratedAnswerSource"
+    openGeneratedAnswerSource = "openGeneratedAnswerSource",
+    generatedAnswerStreamEnd = "generatedAnswerStreamEnd"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {
@@ -184,9 +185,14 @@ export interface SmartSnippetDocumentIdentifier {
     contentIdValue: string;
 }
 export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
-export interface GeneratedAnswerFeedbackMeta {
+interface GeneratedAnswerBaseMeta {
     generativeQuestionAnsweringId: string;
 }
+export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
+}
+export interface GeneratedAnswerStreamEndMeta extends GeneratedAnswerBaseMeta {
+    answerGenerated: boolean;
+}
 export interface GeneratedAnswerCitationMeta {
     generativeQuestionAnsweringId: string;
     permanentId: string;

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.10";
+export declare const libVersion = "2.28.12";

package/dist/library.es.js

@@ -596,7 +596,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.28.10" ;
+const libVersion = "2.28.12" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1740,6 +1740,7 @@ var SearchPageEvents;
     SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
     SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
     SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
+    SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1784,6 +1785,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
+    [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
 };
 
 class NoopAnalytics {
@@ -2619,6 +2621,14 @@ class CoveoSearchPageClient {
             return (yield this.makeRetryGeneratedAnswer()).log({ searchUID: this.provider.getSearchUID() });
         });
     }
+    makeGeneratedAnswerStreamEnd(metadata) {
+        return this.makeCustomEvent(SearchPageEvents.generatedAnswerStreamEnd, metadata);
+    }
+    logGeneratedAnswerStreamEnd(metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.makeGeneratedAnswerStreamEnd(metadata)).log({ searchUID: this.provider.getSearchUID() });
+        });
+    }
 }
 
 const SVCPluginEventTypes = Object.assign({}, BasePluginEventTypes);

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.10" ;
+var libVersion = "2.28.12" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84255,6 +84255,7 @@ exports.SearchPageEvents = void 0;
     SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
     SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
     SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
+    SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
 })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84299,6 +84300,7 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
+    _a[exports.SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
     _a);
 
 var NoopAnalytics = (function () {
@@ -85638,6 +85640,19 @@ var CoveoSearchPageClient = (function () {
             });
         });
     };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerStreamEnd = function (metadata) {
+        return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerStreamEnd, metadata);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerStreamEnd = function (metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerStreamEnd(metadata)];
+                    case 1: return [2, (_a.sent()).log({ searchUID: this.provider.getSearchUID() })];
+                }
+            });
+        });
+    };
     return CoveoSearchPageClient;
 }());
 

package/dist/react-native.es.js

@@ -658,7 +658,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.28.10" ;
+const libVersion = "2.28.12" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1758,6 +1758,7 @@ var SearchPageEvents;
     SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
     SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
     SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
+    SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1802,6 +1803,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
+    [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
 };
 
 class NoopAnalytics {
@@ -2637,6 +2639,14 @@ class CoveoSearchPageClient {
             return (yield this.makeRetryGeneratedAnswer()).log({ searchUID: this.provider.getSearchUID() });
         });
     }
+    makeGeneratedAnswerStreamEnd(metadata) {
+        return this.makeCustomEvent(SearchPageEvents.generatedAnswerStreamEnd, metadata);
+    }
+    logGeneratedAnswerStreamEnd(metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.makeGeneratedAnswerStreamEnd(metadata)).log({ searchUID: this.provider.getSearchUID() });
+        });
+    }
 }
 
 const SVCPluginEventTypes = Object.assign({}, BasePluginEventTypes);

package/package.json

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

package/src/searchPage/searchPageClient.spec.ts

@@ -1457,4 +1457,18 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.openGeneratedAnswerSource, meta);
         expectMatchDescription(built.description, SearchPageEvents.openGeneratedAnswerSource, meta);
     });
+
+    it('should send proper payload for #logGeneratedAnswerStreamEnd', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, answerGenerated: true};
+        await client.logGeneratedAnswerStreamEnd(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, meta);
+    });
+
+    it('should send proper payload for #makeGeneratedAnswerStreamEnd', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, answerGenerated: true};
+        const built = await client.makeGeneratedAnswerStreamEnd(meta);
+        await built.log({searchUID: provider.getSearchUID()});
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, meta);
+        expectMatchDescription(built.description, SearchPageEvents.generatedAnswerStreamEnd, meta);
+    });
 });

package/src/searchPage/searchPageClient.ts

@@ -38,6 +38,7 @@ import {
     SmartSnippetLinkMeta,
     GeneratedAnswerFeedbackMeta,
     GeneratedAnswerCitationMeta,
+    GeneratedAnswerStreamEndMeta,
 } from './searchPageEvents';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -917,4 +918,12 @@ export class CoveoSearchPageClient {
     public async logRetryGeneratedAnswer() {
         return (await this.makeRetryGeneratedAnswer()).log({searchUID: this.provider.getSearchUID()});
     }
+
+    public makeGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta) {
+        return this.makeCustomEvent(SearchPageEvents.generatedAnswerStreamEnd, metadata);
+    }
+
+    public async logGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta) {
+        return (await this.makeGeneratedAnswerStreamEnd(metadata)).log({searchUID: this.provider.getSearchUID()});
+    }
 }

package/src/searchPage/searchPageEvents.ts

@@ -310,6 +310,10 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user opens a generated answer citation.
      */
     openGeneratedAnswerSource = 'openGeneratedAnswerSource',
+    /**
+     * Identified the custom event that gets logged when a generated answer stream is completed.
+     */
+    generatedAnswerStreamEnd = 'generatedAnswerStreamEnd',
 }
 
 export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {
@@ -355,6 +359,7 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
+    [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
 };
 
 export interface StaticFilterMetadata {
@@ -489,10 +494,16 @@ export interface SmartSnippetDocumentIdentifier {
 
 export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
 
-export interface GeneratedAnswerFeedbackMeta {
+interface GeneratedAnswerBaseMeta {
     generativeQuestionAnsweringId: string;
 }
 
+export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {}
+
+export interface GeneratedAnswerStreamEndMeta extends GeneratedAnswerBaseMeta {
+    answerGenerated: boolean;
+}
+
 export interface GeneratedAnswerCitationMeta {
     generativeQuestionAnsweringId: string;
     permanentId: string;