feat(SFINT-5504): new methods to expand and collapse generated answer added to search and insight client

src/insight/insightClient.spec.ts

@@ -585,6 +585,24 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerShowAnswers, exampleGeneratedAnswerMetadata);
         });
 
+        it('should send proper payload for #expandGeneratedAnswer', async () => {
+            const exampleGeneratedAnswerMetadata = {
+                generativeQuestionAnsweringId: '123',
+            };
+
+            await client.logExpandGeneratedAnswer(exampleGeneratedAnswerMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.expandGeneratedAnswer, exampleGeneratedAnswerMetadata);
+        });
+
+        it('should send proper payload for #collapseGeneratedAnswer', async () => {
+            const exampleGeneratedAnswerMetadata = {
+                generativeQuestionAnsweringId: '123',
+            };
+
+            await client.logCollapseGeneratedAnswer(exampleGeneratedAnswerMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.collapseGeneratedAnswer, exampleGeneratedAnswerMetadata);
+        });
+
         it('should send proper payload for #generatedAnswerFeedbackSubmit', async () => {
             const exampleGeneratedAnswerMetadata = {
                 generativeQuestionAnsweringId: '123',
@@ -1340,6 +1358,32 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerShowAnswers, expectedMetadata);
         });
 
+        it('should send proper payload for #expandGeneratedAnswer', async () => {
+            const exampleGeneratedAnswerMetadata = {
+                generativeQuestionAnsweringId: '123',
+            };
+            const expectedMetadata = {
+                ...exampleGeneratedAnswerMetadata,
+                ...expectedBaseCaseMetadata,
+            };
+
+            await client.logExpandGeneratedAnswer(exampleGeneratedAnswerMetadata, baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.expandGeneratedAnswer, expectedMetadata);
+        });
+
+        it('should send proper payload for #collapseGeneratedAnswer', async () => {
+            const exampleGeneratedAnswerMetadata = {
+                generativeQuestionAnsweringId: '123',
+            };
+            const expectedMetadata = {
+                ...exampleGeneratedAnswerMetadata,
+                ...expectedBaseCaseMetadata,
+            };
+
+            await client.logCollapseGeneratedAnswer(exampleGeneratedAnswerMetadata, baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.collapseGeneratedAnswer, expectedMetadata);
+        });
+
         it('should send proper payload for #generatedAnswerFeedbackSubmit', async () => {
             const exampleGeneratedAnswerMetadata = {
                 generativeQuestionAnsweringId: '123',

src/insight/insightClient.ts

@@ -560,6 +560,24 @@ export class CoveoInsightClient {
         );
     }
 
+    public logExpandGeneratedAnswer(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.expandGeneratedAnswer,
+            metadata
+                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
+                : generatedAnswerMetadata
+        );
+    }
+
+    public logCollapseGeneratedAnswer(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.collapseGeneratedAnswer,
+            metadata
+                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
+                : generatedAnswerMetadata
+        );
+    }
+
     public logGeneratedAnswerFeedbackSubmit(
         generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMeta,
         metadata?: CaseMetadata

src/searchPage/searchPageClient.spec.ts

@@ -1573,6 +1573,34 @@ describe('SearchPageClient', () => {
         expectMatchDescription(built.description, SearchPageEvents.generatedAnswerShowAnswers, meta);
     });
 
+    it('should send proper payload for #logExpandGeneratedAnswer', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        await client.logExpandGeneratedAnswer(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.expandGeneratedAnswer, meta);
+    });
+
+    it('should send proper payload for #makeExpandGeneratedAnswer', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        const built = await client.makeExpandGeneratedAnswer(meta);
+        await built.log({searchUID: provider.getSearchUID()});
+        expectMatchCustomEventPayload(SearchPageEvents.expandGeneratedAnswer, meta);
+        expectMatchDescription(built.description, SearchPageEvents.expandGeneratedAnswer, meta);
+    });
+
+    it('should send proper payload for #logCollapseGeneratedAnswer', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        await client.logCollapseGeneratedAnswer(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.collapseGeneratedAnswer, meta);
+    });
+
+    it('should send proper payload for #makeCollapseGeneratedAnswer', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        const built = await client.makeCollapseGeneratedAnswer(meta);
+        await built.log({searchUID: provider.getSearchUID()});
+        expectMatchCustomEventPayload(SearchPageEvents.collapseGeneratedAnswer, meta);
+        expectMatchDescription(built.description, SearchPageEvents.collapseGeneratedAnswer, meta);
+    });
+
     it('should send proper payload for #logGeneratedAnswerFeedbackSubmit', async () => {
         const meta = {
             generativeQuestionAnsweringId: fakeStreamId,

src/searchPage/searchPageClient.ts

@@ -951,6 +951,22 @@ export class CoveoSearchPageClient {
         });
     }
 
+    public makeExpandGeneratedAnswer(metadata: GeneratedAnswerBaseMeta) {
+        return this.makeCustomEvent(SearchPageEvents.expandGeneratedAnswer, metadata);
+    }
+
+    public async logExpandGeneratedAnswer(metadata: GeneratedAnswerBaseMeta) {
+        return (await this.makeExpandGeneratedAnswer(metadata)).log({searchUID: this.provider.getSearchUID()});
+    }
+
+    public makeCollapseGeneratedAnswer(metadata: GeneratedAnswerBaseMeta) {
+        return this.makeCustomEvent(SearchPageEvents.collapseGeneratedAnswer, metadata);
+    }
+
+    public async logCollapseGeneratedAnswer(metadata: GeneratedAnswerBaseMeta) {
+        return (await this.makeCollapseGeneratedAnswer(metadata)).log({searchUID: this.provider.getSearchUID()});
+    }
+
     public makeGeneratedAnswerFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta) {
         return this.makeCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmit, meta);
     }

src/searchPage/searchPageEvents.ts

@@ -330,6 +330,14 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user activates the genQA feature.
      */
     generatedAnswerShowAnswers = 'generatedAnswerShowAnswers',
+    /**
+     * Identifies the custom event that gets logged when a user expand a generated answer.
+     */
+    expandGeneratedAnswer = 'expandGeneratedAnswer',
+    /**
+     * Identifies the custom event that gets logged when a user collapse a generated answer.
+     */
+    collapseGeneratedAnswer = 'collapseGeneratedAnswer',
     /**
      * Identifies the custom event that gets logged when a user submits a feedback of a generated answer.
      */
@@ -382,6 +390,8 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.generatedAnswerCopyToClipboard]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
+    [SearchPageEvents.expandGeneratedAnswer]: 'generatedAnswer',
+    [SearchPageEvents.collapseGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
     [InsightEvents.expandToFullUI]: 'interface',
     [InsightEvents.openUserActions]: 'User Actions',