coveo.analytics 2.30.1 → 2.30.3

package/src/plugins/ec.spec.ts

@@ -45,12 +45,12 @@ describe('EC plugin', () => {
             expect(result).toEqual({...defaultResult, pr1id: 'C0V30'});
         });
 
-        it('should append the product with the pageview event', () => {
+        it('should not append the product with the pageview event', () => {
             ec.addProduct({name: 'Relevance T-Shirt'});
 
-            const result = executeRegisteredHook(ECPluginEventTypes.event, {});
+            const result = executeRegisteredHook(ECPluginEventTypes.pageview, {});
 
-            expect(result).toEqual({...defaultResult, pr1nm: 'Relevance T-Shirt'});
+            expect(result).toEqual({...defaultResult, hitType: ECPluginEventTypes.pageview});
         });
 
         it('should not append the product with a random event type', () => {
@@ -61,14 +61,15 @@ describe('EC plugin', () => {
             expect(result).toEqual({});
         });
 
-        it('should keep the products until a valid event type is used', () => {
+        it('should keep the products until an event type is used', () => {
             ec.addProduct({id: 'P12345'});
 
             executeRegisteredHook('🎲', {});
             executeRegisteredHook('🐟', {});
-            executeRegisteredHook('💀', {});
+            const pageviewResult = executeRegisteredHook(ECPluginEventTypes.pageview, {});
             const result = executeRegisteredHook(ECPluginEventTypes.event, {});
 
+            expect(pageviewResult).toEqual({...defaultResult, hitType: ECPluginEventTypes.pageview});
             expect(result).toEqual({...defaultResult, pr1id: 'P12345'});
         });
 
@@ -119,6 +120,18 @@ describe('EC plugin', () => {
             expect(secondResult).toEqual({...defaultResult});
         });
 
+        it('should not flush the products when the pageview is sent', () => {
+            ec.addProduct({name: 'boup'});
+
+            const result = executeRegisteredHook(ECPluginEventTypes.pageview, {});
+
+            expect(result).not.toEqual({});
+
+            const secondResult = executeRegisteredHook(ECPluginEventTypes.event, {});
+
+            expect(secondResult).toEqual({...defaultResult, pr1nm: 'boup'});
+        });
+
         it('should convert position to number if possible', () => {
             const validValues = ['13', '5.5'];
             for (const value of validValues) {
@@ -264,14 +277,14 @@ describe('EC plugin', () => {
             expect(result).toEqual({...defaultResult, il1pi1id: 'C0V30'});
         });
 
-        it('should append the impression with the pageview event', () => {
+        it('should not append the impression with the pageview event', () => {
             ec.addImpression({name: 'Relevance T-Shirt'});
 
-            const result = executeRegisteredHook(ECPluginEventTypes.event, {});
+            const result = executeRegisteredHook(ECPluginEventTypes.pageview, {});
 
             expect(result).toEqual({
                 ...defaultResult,
-                il1pi1nm: 'Relevance T-Shirt',
+                hitType: ECPluginEventTypes.pageview,
             });
         });
 
@@ -283,14 +296,15 @@ describe('EC plugin', () => {
             expect(result).toEqual({});
         });
 
-        it('should keep the impressions until a valid event type is used', () => {
+        it('should keep the impressions until an event type is used', () => {
             ec.addImpression({id: 'P12345'});
 
             executeRegisteredHook('🎲', {});
             executeRegisteredHook('🐟', {});
-            executeRegisteredHook('💀', {});
+            const pageviewResult = executeRegisteredHook(ECPluginEventTypes.pageview, {});
             const result = executeRegisteredHook(ECPluginEventTypes.event, {});
 
+            expect(pageviewResult).toEqual({...defaultResult, hitType: ECPluginEventTypes.pageview});
             expect(result).toEqual({...defaultResult, il1pi1id: 'P12345'});
         });
 
@@ -372,7 +386,7 @@ describe('EC plugin', () => {
             });
         });
 
-        it('should flush the products once they are sent', () => {
+        it('should flush the impressions once they are sent', () => {
             ec.addImpression({name: '🍟', price: 1.99});
             ec.addImpression({name: '🍿', price: 3});
 
@@ -385,6 +399,18 @@ describe('EC plugin', () => {
             expect(secondResult).toEqual({...defaultResult});
         });
 
+        it('should not flush the impressions when a pageview is sent', () => {
+            ec.addImpression({name: 'bap'});
+
+            const result = executeRegisteredHook(ECPluginEventTypes.pageview, {});
+
+            expect(result).not.toEqual({});
+
+            const secondResult = executeRegisteredHook(ECPluginEventTypes.event, {});
+
+            expect(secondResult).toEqual({...defaultResult, il1pi1nm: 'bap'});
+        });
+
         describe('when the position is invalid', () => {
             it('should warn when executing hook on added impression', () => {
                 jest.spyOn(console, 'warn').mockImplementation();
@@ -480,6 +506,17 @@ describe('EC plugin', () => {
         });
     });
 
+    it('should not set an action with a pageview', () => {
+        ec.setAction('ok');
+
+        const result = executeRegisteredHook(ECPluginEventTypes.pageview, {});
+
+        expect(result).toEqual({
+            ...defaultResult,
+            hitType: ECPluginEventTypes.pageview,
+        });
+    });
+
     it('should flush the action once it is sent', () => {
         ec.setAction('ok');
 
@@ -492,6 +529,18 @@ describe('EC plugin', () => {
         expect(secondResult).toEqual({...defaultResult});
     });
 
+    it('should not flush the action with the pageview', () => {
+        ec.setAction('ok');
+
+        const result = executeRegisteredHook(ECPluginEventTypes.pageview, {});
+
+        expect(result).not.toEqual({});
+
+        const secondResult = executeRegisteredHook(ECPluginEventTypes.event, {});
+
+        expect(secondResult).toEqual({...defaultResult, action: 'ok'});
+    });
+
     it('should be able to clear all the data', () => {
         ec.addProduct({name: '🍨', price: 2.99});
         ec.addImpression({id: '🍦', price: 3.49});

package/src/plugins/ec.ts

@@ -135,6 +135,14 @@ export class ECPlugin extends BasePlugin {
     }
 
     private addECDataToPayload(eventType: string, payload: any) {
+        if (eventType === ECPluginEventTypes.pageview) {
+            return {
+                ...this.getLocationInformation(eventType, payload),
+                ...this.getDefaultContextInformation(eventType),
+                ...payload,
+            };
+        }
+
         const ecPayload = {
             ...this.getLocationInformation(eventType, payload),
             ...this.getDefaultContextInformation(eventType),

package/src/searchPage/searchPageClient.spec.ts

@@ -1573,6 +1573,34 @@ describe('SearchPageClient', () => {
         expectMatchDescription(built.description, SearchPageEvents.generatedAnswerShowAnswers, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerExpand', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        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);
+        await built.log({searchUID: provider.getSearchUID()});
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerExpand, meta);
+        expectMatchDescription(built.description, SearchPageEvents.generatedAnswerExpand, meta);
+    });
+
+    it('should send proper payload for #logGeneratedAnswerCollapse', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        await client.logGeneratedAnswerCollapse(meta);
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerCollapse, meta);
+    });
+
+    it('should send proper payload for #makeGeneratedAnswerCollapse', async () => {
+        const meta = {generativeQuestionAnsweringId: fakeStreamId};
+        const built = await client.makeGeneratedAnswerCollapse(meta);
+        await built.log({searchUID: provider.getSearchUID()});
+        expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerCollapse, meta);
+        expectMatchDescription(built.description, SearchPageEvents.generatedAnswerCollapse, meta);
+    });
+
     it('should send proper payload for #logGeneratedAnswerFeedbackSubmit', async () => {
         const meta = {
             generativeQuestionAnsweringId: fakeStreamId,

package/src/searchPage/searchPageClient.ts

@@ -951,6 +951,22 @@ export class CoveoSearchPageClient {
         });
     }
 
+    public makeGeneratedAnswerExpand(metadata: GeneratedAnswerBaseMeta) {
+        return this.makeCustomEvent(SearchPageEvents.generatedAnswerExpand, metadata);
+    }
+
+    public async logGeneratedAnswerExpand(metadata: GeneratedAnswerBaseMeta) {
+        return (await this.makeGeneratedAnswerExpand(metadata)).log({searchUID: this.provider.getSearchUID()});
+    }
+
+    public makeGeneratedAnswerCollapse(metadata: GeneratedAnswerBaseMeta) {
+        return this.makeCustomEvent(SearchPageEvents.generatedAnswerCollapse, metadata);
+    }
+
+    public async logGeneratedAnswerCollapse(metadata: GeneratedAnswerBaseMeta) {
+        return (await this.makeGeneratedAnswerCollapse(metadata)).log({searchUID: this.provider.getSearchUID()});
+    }
+
     public makeGeneratedAnswerFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta) {
         return this.makeCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmit, meta);
     }

package/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.
+     */
+    generatedAnswerExpand = 'generatedAnswerExpand',
+    /**
+     * Identifies the custom event that gets logged when a user collapse a generated answer.
+     */
+    generatedAnswerCollapse = 'generatedAnswerCollapse',
     /**
      * 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.generatedAnswerExpand]: 'generatedAnswer',
+    [SearchPageEvents.generatedAnswerCollapse]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
     [InsightEvents.expandToFullUI]: 'interface',
     [InsightEvents.openUserActions]: 'User Actions',