coveo.analytics 2.23.7 → 2.23.9

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 {