coveo.analytics 2.30.52 → 2.30.54

package/dist/definitions/events.d.ts

@@ -69,6 +69,7 @@ export interface DocumentInformation {
     documentAuthor?: string;
     queryPipeline?: string;
     rankingModifier?: string;
+    documentCategory?: string;
 }
 export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {
 }

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

@@ -199,12 +199,19 @@ export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause'
 interface AnswerGeneratedWithAnswerAPI {
     answerAPIStreamId: string;
     generativeQuestionAnsweringId?: never;
+    conversationId?: never;
 }
 interface AnswerGeneratedWithSearchAPI {
     answerAPIStreamId?: never;
     generativeQuestionAnsweringId: string;
+    conversationId?: never;
 }
-export type GeneratedAnswerBaseMeta = AnswerGeneratedWithAnswerAPI | AnswerGeneratedWithSearchAPI;
+interface AnswerGeneratedWithAgent {
+    answerAPIStreamId?: never;
+    generativeQuestionAnsweringId: string;
+    conversationId: string;
+}
+export type GeneratedAnswerBaseMeta = AnswerGeneratedWithAnswerAPI | AnswerGeneratedWithSearchAPI | AnswerGeneratedWithAgent;
 export type GeneratedAnswerStreamEndMeta = GeneratedAnswerBaseMeta & {
     answerGenerated: boolean;
     answerTextIsEmpty?: boolean;

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.30.52";
+export declare const libVersion = "2.30.54";

package/dist/library.cjs

@@ -736,7 +736,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.52";
+var libVersion = "2.30.54";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);

package/dist/library.es.js

@@ -603,7 +603,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.30.52";
+const libVersion = "2.30.54";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 

package/dist/library.js

@@ -736,7 +736,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.52";
+var libVersion = "2.30.54";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);

package/dist/library.mjs

@@ -734,7 +734,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.52";
+var libVersion = "2.30.54";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);

package/dist/react-native.es.js

@@ -672,7 +672,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.30.52";
+const libVersion = "2.30.54";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.30.52",
+    "version": "2.30.54",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.cjs",
     "module": "dist/browser.mjs",

package/src/events.ts

@@ -84,6 +84,7 @@ export interface DocumentInformation {
     documentAuthor?: string;
     queryPipeline?: string;
     rankingModifier?: string;
+    documentCategory?: string;
 }
 
 export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {}

package/src/insight/insightClient.spec.ts

@@ -126,6 +126,7 @@ describe('InsightClient', () => {
 
     const fakeDocInfo = {
         collectionName: 'collection',
+        documentCategory: 'category',
         documentAuthor: 'author',
         documentPosition: 1,
         documentTitle: 'title',

package/src/searchPage/searchPageClient.spec.ts

@@ -26,6 +26,7 @@ const {fetchMock, fetchMockBeforeEach} = mockFetch();
 describe('SearchPageClient', () => {
     const fakeDocInfo = {
         collectionName: 'collection',
+        documentCategory: 'category',
         documentAuthor: 'author',
         documentPosition: 1,
         documentTitle: 'title',
@@ -57,6 +58,7 @@ describe('SearchPageClient', () => {
     ];
 
     const fakeStreamId = 'some-stream-id-123';
+    const fakeConversationId = 'some-conversation-id-123';
 
     let client: CoveoSearchPageClient;
 
@@ -1450,6 +1452,12 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.likeGeneratedAnswer, meta);
     });
 
+    it('should send proper payload for #logLikeGeneratedAnswer with agent metadata', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, conversationId: fakeConversationId};
+        await client.logLikeGeneratedAnswer(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.likeGeneratedAnswer, meta);
+    });
+
     it('should send proper payload for #makeLikeGeneratedAnswer', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId};
         const built = await client.makeLikeGeneratedAnswer(meta);
@@ -1464,6 +1472,12 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.dislikeGeneratedAnswer, meta);
     });
 
+    it('should send proper payload for #logDislikeGeneratedAnswer with agent metadata', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, conversationId: fakeConversationId};
+        await client.logDislikeGeneratedAnswer(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.dislikeGeneratedAnswer, meta);
+    });
+
     it('should send proper payload for #makeDislikeGeneratedAnswer', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId};
         const built = await client.makeDislikeGeneratedAnswer(meta);
@@ -1482,6 +1496,17 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.openGeneratedAnswerSource, meta);
     });
 
+    it('should send proper payload for #logOpenGeneratedAnswerSource with agent metadata', async () => {
+        const meta = {
+            generativeQuestionAnsweringId: fakeStreamId,
+            conversationId: fakeConversationId,
+            citationId: 'some-document-id',
+            permanentId: 'perm-id',
+        };
+        await client.logOpenGeneratedAnswerSource(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.openGeneratedAnswerSource, meta);
+    });
+
     it('should send proper payload for #makeOpenGeneratedAnswerSource', async () => {
         const meta = {
             generativeQuestionAnsweringId: fakeStreamId,
@@ -1509,6 +1534,22 @@ describe('SearchPageClient', () => {
         });
     });
 
+    it('should send proper payload for #logGeneratedAnswerCitationClick with agent metadata', async () => {
+        const meta = {
+            generativeQuestionAnsweringId: fakeStreamId,
+            conversationId: fakeConversationId,
+            citationId: 'some-document-id',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        };
+
+        await client.logGeneratedAnswerCitationClick(fakeDocInfo, meta);
+        expectMatchDocumentPayload(SearchPageEvents.generatedAnswerCitationClick, fakeDocInfo, {
+            ...meta,
+            contentIDKey: meta.documentId.contentIdKey,
+            contentIDValue: meta.documentId.contentIdValue,
+        });
+    });
+
     it('should send proper payload for #makeGeneratedAnswerCitationClick', async () => {
         const meta = {
             generativeQuestionAnsweringId: fakeStreamId,
@@ -1529,6 +1570,17 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerStreamEnd with agent metadata', async () => {
+        const meta = {
+            generativeQuestionAnsweringId: fakeStreamId,
+            conversationId: fakeConversationId,
+            answerGenerated: true,
+            answerTextIsEmpty: false,
+        };
+        await client.logGeneratedAnswerStreamEnd(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, meta);
+    });
+
     it('should send proper payload for #makeGeneratedAnswerStreamEnd', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId, answerGenerated: true, answerTextIsEmpty: false};
         const built = await client.makeGeneratedAnswerStreamEnd(meta);
@@ -1548,6 +1600,18 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerSourceHover, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerSourceHover with agent metadata', async () => {
+        const meta = {
+            generativeQuestionAnsweringId: fakeStreamId,
+            conversationId: fakeConversationId,
+            citationId: 'some-document-id',
+            permanentId: 'perm-id',
+            citationHoverTimeMs: 100,
+        };
+        await client.logGeneratedAnswerSourceHover(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerSourceHover, meta);
+    });
+
     it('should send proper payload for #makeGeneratedAnswerSourceHover', async () => {
         const meta = {
             generativeQuestionAnsweringId: fakeStreamId,
@@ -1567,6 +1631,12 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerCopyToClipboard, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerCopyToClipboard with agent metadata', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, conversationId: fakeConversationId};
+        await client.logGeneratedAnswerCopyToClipboard(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerCopyToClipboard, meta);
+    });
+
     it('should send proper payload for #makeGeneratedAnswerCopyToClipboard', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId};
         const built = await client.makeGeneratedAnswerCopyToClipboard(meta);
@@ -1581,6 +1651,12 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerHideAnswers, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerHideAnswers with agent metadata', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, conversationId: fakeConversationId};
+        await client.logGeneratedAnswerHideAnswers(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerHideAnswers, meta);
+    });
+
     it('should send proper payload for #makeGeneratedAnswerHideAnswers', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId};
         const built = await client.makeGeneratedAnswerHideAnswers(meta);
@@ -1595,6 +1671,12 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerShowAnswers, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerShowAnswers with agent metadata', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, conversationId: fakeConversationId};
+        await client.logGeneratedAnswerShowAnswers(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerShowAnswers, meta);
+    });
+
     it('should send proper payload for #makeGeneratedAnswerShowAnswers', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId};
         const built = await client.makeGeneratedAnswerShowAnswers(meta);
@@ -1609,6 +1691,12 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerExpand, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerExpand with agent metadata', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId, conversationId: fakeConversationId};
+        await client.logGeneratedAnswerExpand(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerExpand, meta);
+    });
+
     it('should send proper payload for #makeGeneratedAnswerExpand', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId};
         const built = await client.makeGeneratedAnswerExpand(meta);

package/src/searchPage/searchPageEvents.ts

@@ -551,14 +551,25 @@ export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause'
 interface AnswerGeneratedWithAnswerAPI {
     answerAPIStreamId: string;
     generativeQuestionAnsweringId?: never;
+    conversationId?: never;
 }
 
 interface AnswerGeneratedWithSearchAPI {
     answerAPIStreamId?: never;
     generativeQuestionAnsweringId: string;
+    conversationId?: never;
 }
 
-export type GeneratedAnswerBaseMeta = AnswerGeneratedWithAnswerAPI | AnswerGeneratedWithSearchAPI;
+interface AnswerGeneratedWithAgent {
+    answerAPIStreamId?: never;
+    generativeQuestionAnsweringId: string;
+    conversationId: string;
+}
+
+export type GeneratedAnswerBaseMeta =
+    | AnswerGeneratedWithAnswerAPI
+    | AnswerGeneratedWithSearchAPI
+    | AnswerGeneratedWithAgent;
 
 export type GeneratedAnswerStreamEndMeta = GeneratedAnswerBaseMeta & {
     answerGenerated: boolean;