coveo.analytics 2.30.50 → 2.30.52

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

@@ -63,7 +63,7 @@ export declare class CoveoInsightClient {
     logFeedItemTextPost(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>;
+    logCaseDetach(resultUriHash: string, metadata?: CaseMetadata, permanentId?: string): Promise<void | import("../events").CustomEventResponse>;
     logLikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDislikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logExpandSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
@@ -92,6 +92,7 @@ export declare class CoveoInsightClient {
     logRephraseGeneratedAnswer(generatedAnswerRephraseMetadata: GeneratedAnswerRephraseMeta, metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logRetryGeneratedAnswer(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logGeneratedAnswerStreamEnd(generatedAnswerStreamEndMetadata: GeneratedAnswerStreamEndMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logGeneratedAnswerCitationDocumentAttach(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     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

@@ -87,7 +87,8 @@ export declare enum SearchPageEvents {
     generatedAnswerFeedbackSubmit = "generatedAnswerFeedbackSubmit",
     rephraseGeneratedAnswer = "rephraseGeneratedAnswer",
     generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2",
-    generatedAnswerCitationClick = "generatedAnswerCitationClick"
+    generatedAnswerCitationClick = "generatedAnswerCitationClick",
+    generatedAnswerCitationDocumentAttach = "generatedAnswerCitationDocumentAttach"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.30.50";
+export declare const libVersion = "2.30.52";

package/dist/library.cjs

@@ -736,7 +736,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.50";
+var libVersion = "2.30.52";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84436,6 +84436,7 @@ exports.SearchPageEvents = void 0;
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
     SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
+    SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
 })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -86356,8 +86357,9 @@ var CoveoInsightClient = (function () {
         };
         return this.logClickEvent(exports.SearchPageEvents.caseAttach, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     };
-    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
-        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
+    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata, permanentId) {
+        var generatedMetadata = __assign(__assign(__assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId: permanentId })), { resultUriHash: resultUriHash });
+        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, generatedMetadata);
     };
     CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
         return this.logCustomEvent(exports.SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
@@ -86461,6 +86463,9 @@ var CoveoInsightClient = (function () {
         return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerStreamEnd, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerStreamEndMetadata) : generatedAnswerStreamEndMetadata);
     };
+    CoveoInsightClient.prototype.logGeneratedAnswerCitationDocumentAttach = function (info, citation, metadata) {
+        return this.logClickEvent(exports.SearchPageEvents.generatedAnswerCitationDocumentAttach, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/library.es.js

@@ -603,7 +603,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.30.50";
+const libVersion = "2.30.52";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1833,6 +1833,7 @@ var SearchPageEvents;
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
     SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
+    SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -3241,8 +3242,9 @@ class CoveoInsightClient {
         };
         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 });
+    logCaseDetach(resultUriHash, metadata, permanentId) {
+        const generatedMetadata = Object.assign(Object.assign(Object.assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId })), { resultUriHash });
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     }
     logLikeSmartSnippet(metadata) {
         return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
@@ -3346,6 +3348,9 @@ class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.generatedAnswerStreamEnd, metadata
             ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerStreamEndMetadata) : generatedAnswerStreamEndMetadata);
     }
+    logGeneratedAnswerCitationDocumentAttach(info, citation, metadata) {
+        return this.logClickEvent(SearchPageEvents.generatedAnswerCitationDocumentAttach, Object.assign(Object.assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    }
     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

@@ -736,7 +736,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.50";
+var libVersion = "2.30.52";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84436,6 +84436,7 @@ exports.SearchPageEvents = void 0;
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
     SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
+    SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
 })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -86356,8 +86357,9 @@ var CoveoInsightClient = (function () {
         };
         return this.logClickEvent(exports.SearchPageEvents.caseAttach, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     };
-    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
-        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
+    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata, permanentId) {
+        var generatedMetadata = __assign(__assign(__assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId: permanentId })), { resultUriHash: resultUriHash });
+        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, generatedMetadata);
     };
     CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
         return this.logCustomEvent(exports.SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
@@ -86461,6 +86463,9 @@ var CoveoInsightClient = (function () {
         return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerStreamEnd, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerStreamEndMetadata) : generatedAnswerStreamEndMetadata);
     };
+    CoveoInsightClient.prototype.logGeneratedAnswerCitationDocumentAttach = function (info, citation, metadata) {
+        return this.logClickEvent(exports.SearchPageEvents.generatedAnswerCitationDocumentAttach, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/library.mjs

@@ -734,7 +734,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.50";
+var libVersion = "2.30.52";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84434,6 +84434,7 @@ var SearchPageEvents;
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
     SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
+    SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -86354,8 +86355,9 @@ var CoveoInsightClient = (function () {
         };
         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.logCaseDetach = function (resultUriHash, metadata, permanentId) {
+        var generatedMetadata = __assign(__assign(__assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId: permanentId })), { resultUriHash: resultUriHash });
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     };
     CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
         return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
@@ -86459,6 +86461,9 @@ var CoveoInsightClient = (function () {
         return this.logCustomEvent(SearchPageEvents.generatedAnswerStreamEnd, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerStreamEndMetadata) : generatedAnswerStreamEndMetadata);
     };
+    CoveoInsightClient.prototype.logGeneratedAnswerCitationDocumentAttach = function (info, citation, metadata) {
+        return this.logClickEvent(SearchPageEvents.generatedAnswerCitationDocumentAttach, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/react-native.es.js

@@ -672,7 +672,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.30.50";
+const libVersion = "2.30.52";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1854,6 +1854,7 @@ var SearchPageEvents;
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
     SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
+    SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -3262,8 +3263,9 @@ class CoveoInsightClient {
         };
         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 });
+    logCaseDetach(resultUriHash, metadata, permanentId) {
+        const generatedMetadata = Object.assign(Object.assign(Object.assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId })), { resultUriHash });
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     }
     logLikeSmartSnippet(metadata) {
         return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
@@ -3367,6 +3369,9 @@ class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.generatedAnswerStreamEnd, metadata
             ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerStreamEndMetadata) : generatedAnswerStreamEndMetadata);
     }
+    logGeneratedAnswerCitationDocumentAttach(info, citation, metadata) {
+        return this.logClickEvent(SearchPageEvents.generatedAnswerCitationDocumentAttach, Object.assign(Object.assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    }
     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.30.50",
+    "version": "2.30.52",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.cjs",
     "module": "dist/browser.mjs",

package/src/insight/insightClient.spec.ts

@@ -383,10 +383,13 @@ describe('InsightClient', () => {
         });
 
         it('should send proper payload for #caseDetach', async () => {
+            const mockResultUriHash = fakeDocInfo.documentUriHash;
+            const mockPermanentId = fakeDocID.contentIDValue;
             const expectedMetadata = {
-                resultUriHash: fakeDocInfo.documentUriHash,
+                resultUriHash: mockResultUriHash,
+                permanentId: mockPermanentId,
             };
-            await client.logCaseDetach(fakeDocInfo.documentUriHash);
+            await client.logCaseDetach(mockResultUriHash, undefined, mockPermanentId);
             expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
         });
 
@@ -671,6 +674,27 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, exampleGeneratedAnswerMetadata);
         });
 
+        it('should send proper payload for #generatedAnswerCitationDocumentAttach', async () => {
+            const meta = {
+                generativeQuestionAnsweringId: '123',
+                citationId: 'bar',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+
+            const expectedMetadata = {
+                ...meta,
+                contentIDKey: meta.documentId.contentIdKey,
+                contentIDValue: meta.documentId.contentIdValue,
+            };
+
+            await client.logGeneratedAnswerCitationDocumentAttach(fakeDocInfo, meta);
+            expectMatchDocumentPayload(
+                SearchPageEvents.generatedAnswerCitationDocumentAttach,
+                fakeDocInfo,
+                expectedMetadata,
+            );
+        });
+
         it('should send proper payload for #createArticle', async () => {
             const exampleCreateArticleMetadata = {
                 articleType: 'Knowledge__kav',
@@ -1173,12 +1197,15 @@ describe('InsightClient', () => {
 
         it('should send proper payload for #caseDetach', async () => {
             const metadata = baseCaseMetadata;
+            const mockResultUriHash = fakeDocInfo.documentUriHash;
+            const mockPermanentId = fakeDocID.contentIDValue;
 
             const expectedMetadata = {
                 ...expectedBaseCaseMetadata,
-                resultUriHash: fakeDocInfo.documentUriHash,
+                resultUriHash: mockResultUriHash,
+                permanentId: mockPermanentId,
             };
-            await client.logCaseDetach(fakeDocInfo.documentUriHash, metadata);
+            await client.logCaseDetach(mockResultUriHash, metadata, mockPermanentId);
             expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
         });
 
@@ -1553,6 +1580,28 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, expectedMetadata);
         });
 
+        it('should send proper payload for #generatedAnswerCitationDocumentAttach', async () => {
+            const meta = {
+                generativeQuestionAnsweringId: '123',
+                citationId: 'bar',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+
+            const expectedMetadata = {
+                ...meta,
+                ...expectedBaseCaseMetadata,
+                contentIDKey: meta.documentId.contentIdKey,
+                contentIDValue: meta.documentId.contentIdValue,
+            };
+
+            await client.logGeneratedAnswerCitationDocumentAttach(fakeDocInfo, meta, baseCaseMetadata);
+            expectMatchDocumentPayload(
+                SearchPageEvents.generatedAnswerCitationDocumentAttach,
+                fakeDocInfo,
+                expectedMetadata,
+            );
+        });
+
         it('should send proper payload for #createArticle', async () => {
             const exampleCreateArticleMetadata = {
                 articleType: 'Knowledge__kav',

package/src/insight/insightClient.ts

@@ -373,11 +373,13 @@ export class CoveoInsightClient {
         );
     }
 
-    public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.caseDetach,
-            metadata ? {...generateMetadataToSend(metadata, false), resultUriHash} : {resultUriHash},
-        );
+    public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata, permanentId?: string) {
+        const generatedMetadata = {
+            ...(metadata && generateMetadataToSend(metadata, false)),
+            ...(permanentId && {permanentId}),
+            resultUriHash,
+        };
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     }
 
     public logLikeSmartSnippet(metadata?: CaseMetadata) {
@@ -668,6 +670,19 @@ export class CoveoInsightClient {
         );
     }
 
+    public logGeneratedAnswerCitationDocumentAttach(
+        info: PartialDocumentInformation,
+        citation: GeneratedAnswerCitationClickMeta,
+        metadata?: CaseMetadata,
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.generatedAnswerCitationDocumentAttach,
+            {...info, documentPosition: 1},
+            {contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
+            metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation,
+        );
+    }
+
     public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 

package/src/searchPage/searchPageEvents.ts

@@ -354,6 +354,10 @@ export enum SearchPageEvents {
      * Identifies the click event that gets logged when the user clicks on a generated answer citation.
      */
     generatedAnswerCitationClick = 'generatedAnswerCitationClick',
+    /**
+     * Identifies the click event that gets logged when a user clicks the Attach Citation action.
+     */
+    generatedAnswerCitationDocumentAttach = 'generatedAnswerCitationDocumentAttach',
 }
 
 export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {