coveo.analytics 2.23.7 → 2.23.8

package/dist/definitions/insight/insightClient.d.ts

@@ -50,6 +50,8 @@ export declare class CoveoInsightClient {
     logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCaseAttach(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCaseDetach(resultUriHash: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
     logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;

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

@@ -68,7 +68,9 @@ export declare enum SearchPageEvents {
     noResultsBack = "noResultsBack",
     showMoreFoldedResults = "showMoreFoldedResults",
     showLessFoldedResults = "showLessFoldedResults",
-    copyToClipboard = "copyToClipboard"
+    copyToClipboard = "copyToClipboard",
+    caseAttach = "caseAttach",
+    caseDetach = "caseDetach"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {

package/dist/library.es.js

@@ -1186,6 +1186,8 @@ var SearchPageEvents;
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
     SearchPageEvents["copyToClipboard"] = "copyToClipboard";
+    SearchPageEvents["caseAttach"] = "caseAttach";
+    SearchPageEvents["caseDetach"] = "caseDetach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1221,6 +1223,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [SearchPageEvents.caseDetach]: 'case',
 };
 
 class NoopAnalytics {
@@ -2429,6 +2432,17 @@ class CoveoInsightClient {
         };
         return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     }
+    logCaseAttach(info, identifier, caseMetadata) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+        return this.logClickEvent(SearchPageEvents.caseAttach, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    }
+    logCaseDetach(resultUriHash, metadata) {
+        return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { resultUriHash }) : { resultUriHash });
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);

package/dist/library.js

@@ -83694,6 +83694,8 @@ var SearchPageEvents;
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
     SearchPageEvents["copyToClipboard"] = "copyToClipboard";
+    SearchPageEvents["caseAttach"] = "caseAttach";
+    SearchPageEvents["caseDetach"] = "caseDetach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -83729,6 +83731,7 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.showLessFoldedResults] = 'folding',
     _a[InsightEvents.expandToFullUI] = 'interface',
+    _a[SearchPageEvents.caseDetach] = 'case',
     _a);
 
 var NoopAnalytics = (function () {
@@ -85279,6 +85282,17 @@ var CoveoInsightClient = (function () {
         };
         return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     };
+    CoveoInsightClient.prototype.logCaseAttach = function (info, identifier, caseMetadata) {
+        var metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+        return this.logClickEvent(SearchPageEvents.caseAttach, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    };
+    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
+        return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/react-native.es.js

@@ -1203,6 +1203,8 @@ var SearchPageEvents;
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
     SearchPageEvents["copyToClipboard"] = "copyToClipboard";
+    SearchPageEvents["caseAttach"] = "caseAttach";
+    SearchPageEvents["caseDetach"] = "caseDetach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1238,6 +1240,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [SearchPageEvents.caseDetach]: 'case',
 };
 
 class NoopAnalytics {
@@ -2446,6 +2449,17 @@ class CoveoInsightClient {
         };
         return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     }
+    logCaseAttach(info, identifier, caseMetadata) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+        return this.logClickEvent(SearchPageEvents.caseAttach, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    }
+    logCaseDetach(resultUriHash, metadata) {
+        return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { resultUriHash }) : { resultUriHash });
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);

package/package.json

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

package/src/insight/insightClient.spec.ts

@@ -333,6 +333,25 @@ describe('InsightClient', () => {
             await client.logDocumentQuickview(fakeDocInfo, fakeDocID);
             expectMatchDocumentPayload(SearchPageEvents.documentQuickview, fakeDocInfo, expectedMetadata);
         });
+
+        it('should send proper payload for #caseAttach', async () => {
+            const expectedMetadata = {
+                ...fakeDocID,
+                documentTitle: fakeDocInfo.documentTitle,
+                documentURL: fakeDocInfo.documentUrl,
+                resultUriHash: fakeDocInfo.documentUriHash,
+            };
+            await client.logCaseAttach(fakeDocInfo, fakeDocID);
+            expectMatchDocumentPayload(SearchPageEvents.caseAttach, fakeDocInfo, expectedMetadata);
+        });
+
+        it('should send proper payload for #caseDetach', async () => {
+            const expectedMetadata = {
+                resultUriHash: fakeDocInfo.documentUriHash,
+            };
+            await client.logCaseDetach(fakeDocInfo.documentUriHash);
+            expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -714,6 +733,31 @@ describe('InsightClient', () => {
             await client.logDocumentQuickview(fakeDocInfo, fakeDocID, metadata);
             expectMatchDocumentPayload(SearchPageEvents.documentQuickview, fakeDocInfo, expectedMetadata);
         });
+
+        it('should send proper payload for #caseAttach', async () => {
+            const metadata = baseCaseMetadata;
+
+            const expectedMetadata = {
+                ...fakeDocID,
+                ...expectedBaseCaseMetadata,
+                documentTitle: fakeDocInfo.documentTitle,
+                documentURL: fakeDocInfo.documentUrl,
+                resultUriHash: fakeDocInfo.documentUriHash,
+            };
+            await client.logCaseAttach(fakeDocInfo, fakeDocID, metadata);
+            expectMatchDocumentPayload(SearchPageEvents.caseAttach, fakeDocInfo, expectedMetadata);
+        });
+
+        it('should send proper payload for #caseDetach', async () => {
+            const metadata = baseCaseMetadata;
+
+            const expectedMetadata = {
+                ...expectedBaseCaseMetadata,
+                resultUriHash: fakeDocInfo.documentUriHash,
+            };
+            await client.logCaseDetach(fakeDocInfo.documentUriHash, metadata);
+            expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -258,6 +258,32 @@ export class CoveoInsightClient {
         );
     }
 
+    public logCaseAttach(
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        caseMetadata?: CaseMetadata
+    ) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+
+        return this.logClickEvent(
+            SearchPageEvents.caseAttach,
+            info,
+            identifier,
+            caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata
+        );
+    }
+
+    public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.caseDetach,
+            metadata ? {...generateMetadataToSend(metadata, false), resultUriHash} : {resultUriHash}
+        );
+    }
+
     public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 

package/src/searchPage/searchPageEvents.ts

@@ -278,6 +278,14 @@ export enum SearchPageEvents {
      * Identifies the click event that gets logged when a user clicks the Copy To Clipboard result action.
      */
     copyToClipboard = 'copyToClipboard',
+    /**
+     * Identifies the click event that gets logged when a user clicks the Attach To Case result action.
+     */
+    caseAttach = 'caseAttach',
+    /**
+     * Identifies the custom event that gets logged when a user clicks the Detach From Case result action.
+     */
+    caseDetach = 'caseDetach',
 }
 
 export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {
@@ -314,6 +322,7 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [SearchPageEvents.caseDetach]: 'case',
 };
 
 export interface StaticFilterMetadata {