coveo.analytics 2.18.62 → 2.18.65

package/dist/definitions/caseAssist/caseAssistActions.d.ts

@@ -58,6 +58,7 @@ export interface FieldSuggestion {
         value: string;
         confidence: number;
     };
+    autoSelection?: boolean;
 }
 export interface DocumentSuggestion {
     suggestionId: string;
@@ -69,4 +70,6 @@ export interface DocumentSuggestion {
         documentUrl: string;
         documentPosition: number;
     };
+    fromQuickview?: boolean;
+    openDocument?: boolean;
 }

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

@@ -6,7 +6,7 @@ export interface SearchPageClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
     getPipeline: () => string;
-    getOriginContext: () => string;
+    getOriginContext?: () => string;
     getOriginLevel1: () => string;
     getOriginLevel2: () => string;
     getOriginLevel3: () => string;

package/dist/library.es.js

@@ -1465,8 +1465,9 @@ class CoveoSearchPageClient {
         });
     }
     getOrigins() {
+        var _a, _b;
         return {
-            originContext: this.provider.getOriginContext(),
+            originContext: (_b = (_a = this.provider).getOriginContext) === null || _b === void 0 ? void 0 : _b.call(_a),
             originLevel1: this.provider.getOriginLevel1(),
             originLevel2: this.provider.getOriginLevel2(),
             originLevel3: this.provider.getOriginLevel3(),

package/dist/library.js

@@ -84160,8 +84160,9 @@ var CoveoSearchPageClient = (function () {
         });
     };
     CoveoSearchPageClient.prototype.getOrigins = function () {
+        var _a, _b;
         return {
-            originContext: this.provider.getOriginContext(),
+            originContext: (_b = (_a = this.provider).getOriginContext) === null || _b === void 0 ? void 0 : _b.call(_a),
             originLevel1: this.provider.getOriginLevel1(),
             originLevel2: this.provider.getOriginLevel2(),
             originLevel3: this.provider.getOriginLevel3(),

package/package.json

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

package/src/caseAssist/caseAssistActions.ts

@@ -71,6 +71,7 @@ export interface FieldSuggestion {
         value: string;
         confidence: number;
     };
+    autoSelection?: boolean;
 }
 
 export interface DocumentSuggestion {
@@ -83,4 +84,6 @@ export interface DocumentSuggestion {
         documentUrl: string;
         documentPosition: number;
     };
+    fromQuickview?: boolean;
+    openDocument?: boolean;
 }

package/src/caseAssist/caseAssistClient.spec.ts

@@ -50,26 +50,30 @@ describe('CaseAssistClient', () => {
         },
     };
 
-    const fakeFieldSuggestion: FieldSuggestion = {
-        classification: {
-            value: 'some-field-value',
-            confidence: 0.5,
-        },
-        classificationId: 'field-suggestion-id',
-        fieldName: 'some-field',
-        responseId: 'field-suggestion-response-id',
+    const fakeFieldSuggestion = (): FieldSuggestion => {
+        return {
+            classification: {
+                value: 'some-field-value',
+                confidence: 0.5,
+            },
+            classificationId: 'field-suggestion-id',
+            fieldName: 'some-field',
+            responseId: 'field-suggestion-response-id',
+        };
     };
 
-    const fakeDocumentSuggestion: DocumentSuggestion = {
-        responseId: 'document-suggestion-response-id',
-        suggestionId: 'document-suggestion-id',
-        suggestion: {
-            documentPosition: 0,
-            documentTitle: 'the document title',
-            documentUri: 'some-document-uri',
-            documentUriHash: 'documenturihash',
-            documentUrl: 'some-document-url',
-        },
+    const fakeDocumentSuggestion = (): DocumentSuggestion => {
+        return {
+            responseId: 'document-suggestion-response-id',
+            suggestionId: 'document-suggestion-id',
+            suggestion: {
+                documentPosition: 0,
+                documentTitle: 'the document title',
+                documentUri: 'some-document-uri',
+                documentUriHash: 'documenturihash',
+                documentUrl: 'some-document-url',
+            },
+        };
     };
 
     const expectMatchPayload = (actionName: CaseAssistActions, actionData: Object, ticket: TicketProperties) => {
@@ -181,20 +185,53 @@ describe('CaseAssistClient', () => {
 
     it('should send proper payload for #logSelectFieldSuggestion', async () => {
         await client.logSelectFieldSuggestion({
-            suggestion: fakeFieldSuggestion,
+            suggestion: fakeFieldSuggestion(),
             ticket: fakeTicket,
         });
 
-        expectMatchPayload(CaseAssistActions.fieldSuggestionClick, fakeFieldSuggestion, fakeTicket);
+        expectMatchPayload(CaseAssistActions.fieldSuggestionClick, fakeFieldSuggestion(), fakeTicket);
+    });
+
+    it('should send proper payload for #logSelectFieldSuggestion when the autoSelection property is set to true', async () => {
+        const myFakeFieldSuggestion = fakeFieldSuggestion();
+        myFakeFieldSuggestion.autoSelection = true;
+        await client.logSelectFieldSuggestion({
+            suggestion: myFakeFieldSuggestion,
+            ticket: fakeTicket,
+        });
+
+        expectMatchPayload(CaseAssistActions.fieldSuggestionClick, myFakeFieldSuggestion, fakeTicket);
     });
 
     it('should send proper payload for #logSelectDocumentSuggestion', async () => {
         await client.logSelectDocumentSuggestion({
-            suggestion: fakeDocumentSuggestion,
+            suggestion: fakeDocumentSuggestion(),
+            ticket: fakeTicket,
+        });
+
+        expectMatchPayload(CaseAssistActions.suggestionClick, fakeDocumentSuggestion(), fakeTicket);
+    });
+
+    it('should send proper payload for #logSelectDocumentSuggestion when the fromQuickview property is set to true', async () => {
+        const myFakeDocumentSuggestion = fakeDocumentSuggestion();
+        myFakeDocumentSuggestion.fromQuickview = true;
+        await client.logSelectDocumentSuggestion({
+            suggestion: myFakeDocumentSuggestion,
+            ticket: fakeTicket,
+        });
+
+        expectMatchPayload(CaseAssistActions.suggestionClick, myFakeDocumentSuggestion, fakeTicket);
+    });
+
+    it('should send proper payload for #logSelectDocumentSuggestion when the openDocument property is set to true', async () => {
+        const myFakeDocumentSuggestion = fakeDocumentSuggestion();
+        myFakeDocumentSuggestion.openDocument = true;
+        await client.logSelectDocumentSuggestion({
+            suggestion: myFakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
-        expectMatchPayload(CaseAssistActions.suggestionClick, fakeDocumentSuggestion, fakeTicket);
+        expectMatchPayload(CaseAssistActions.suggestionClick, myFakeDocumentSuggestion, fakeTicket);
     });
 
     it('should send proper payload for #logRateDocumentSuggestion', async () => {
@@ -202,14 +239,14 @@ describe('CaseAssistClient', () => {
 
         await client.logRateDocumentSuggestion({
             rating,
-            suggestion: fakeDocumentSuggestion,
+            suggestion: fakeDocumentSuggestion(),
             ticket: fakeTicket,
         });
 
         expectMatchPayload(
             CaseAssistActions.suggestionRate,
             {
-                ...fakeDocumentSuggestion,
+                ...fakeDocumentSuggestion(),
                 rate: rating,
             },
             fakeTicket

package/src/client/analytics.ts

@@ -320,6 +320,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     async getVisit(): Promise<VisitResponse> {
+        // deepcode ignore Ssrf: url is supplied by script owner
         const response = await fetch(`${this.baseUrl}/analytics/visit`);
         const visit = (await response.json()) as VisitResponse;
         this.visitorId = visit.visitorId;
@@ -327,6 +328,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     async getHealth(): Promise<HealthResponse> {
+        // deepcode ignore Ssrf: url is supplied by script owner
         const response = await fetch(`${this.baseUrl}/analytics/monitoring/health`);
         return (await response.json()) as HealthResponse;
     }

package/src/searchPage/searchPageClient.ts

@@ -33,7 +33,7 @@ export interface SearchPageClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
     getPipeline: () => string;
-    getOriginContext: () => string;
+    getOriginContext?: () => string;
     getOriginLevel1: () => string;
     getOriginLevel2: () => string;
     getOriginLevel3: () => string;
@@ -384,7 +384,7 @@ export class CoveoSearchPageClient {
 
     private getOrigins() {
         return {
-            originContext: this.provider.getOriginContext(),
+            originContext: this.provider.getOriginContext?.(),
             originLevel1: this.provider.getOriginLevel1(),
             originLevel2: this.provider.getOriginLevel2(),
             originLevel3: this.provider.getOriginLevel3(),