coveo.analytics 2.30.38 → 2.30.40

package/dist/definitions/bundle/browser-fetch.d.ts

@@ -1 +1 @@
-export declare const fetch: ((input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>) & typeof globalThis.fetch;
+export declare const fetch: typeof globalThis.fetch;

package/dist/definitions/events.d.ts

@@ -58,7 +58,7 @@ export interface PreparedSearchEventRequest extends Omit<SearchEventRequest, 'se
 }
 export interface DocumentInformation {
     documentUri?: string;
-    documentUriHash: string;
+    documentUriHash?: string;
     collectionName?: string;
     sourceName: string;
     documentPosition: number;

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

@@ -1,6 +1,6 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { DocumentIdentifier, FacetStateMetadata, GeneratedAnswerBaseMeta, GeneratedAnswerCitationMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerFeedbackMetaV2, GeneratedAnswerRephraseMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerStreamEndMeta, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta, TriggerNotifyMetadata } from '../searchPage/searchPageEvents';
+import { DocumentIdentifier, FacetStateMetadata, GeneratedAnswerBaseMeta, GeneratedAnswerCitationClickMeta, GeneratedAnswerCitationMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerFeedbackMetaV2, GeneratedAnswerRephraseMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerStreamEndMeta, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta, TriggerNotifyMetadata } from '../searchPage/searchPageEvents';
 import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata, CreateArticleMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -78,6 +78,7 @@ export declare class CoveoInsightClient {
     logLikeGeneratedAnswer(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDislikeGeneratedAnswer(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logOpenGeneratedAnswerSource(generatedAnswerSourceMetadata: GeneratedAnswerCitationMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logGeneratedAnswerSourceHover(generatedAnswerSourceMetadata: GeneratedAnswerSourceHoverMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logGeneratedAnswerCopyToClipboard(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logGeneratedAnswerHideAnswers(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;

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

@@ -1,6 +1,6 @@
 import { ClientOptions, AnalyticsClient } from '../client/analytics';
 import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
-import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerBaseMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerFeedbackMetaV2 } from './searchPageEvents';
+import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerBaseMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerFeedbackMetaV2, GeneratedAnswerCitationClickMeta } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -192,6 +192,8 @@ export declare class CoveoSearchPageClient {
     logDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
     makeOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<EventBuilder<CustomEventResponse>>;
     logOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<void | CustomEventResponse>;
+    makeGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise<EventBuilder<ClickEventResponse>>;
+    logGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise<void | ClickEventResponse>;
     makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<EventBuilder<CustomEventResponse>>;
     logGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<void | CustomEventResponse>;
     makeGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;

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

@@ -86,7 +86,8 @@ export declare enum SearchPageEvents {
     generatedAnswerCollapse = "generatedAnswerCollapse",
     generatedAnswerFeedbackSubmit = "generatedAnswerFeedbackSubmit",
     rephraseGeneratedAnswer = "rephraseGeneratedAnswer",
-    generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2"
+    generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2",
+    generatedAnswerCitationClick = "generatedAnswerCitationClick"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {
@@ -211,6 +212,14 @@ export type GeneratedAnswerCitationMeta = GeneratedAnswerBaseMeta & {
     permanentId: string;
     citationId: string;
 };
+export type GeneratedAnswerCitationClickMeta = GeneratedAnswerBaseMeta & {
+    citationId: string;
+    documentId: GeneratedAnswerDocumentIdentifier;
+};
+type GeneratedAnswerDocumentIdentifier = {
+    contentIdKey: string;
+    contentIdValue: string;
+};
 export type GeneratedAnswerFeedbackReason = 'irrelevant' | 'notAccurate' | 'outOfDate' | 'harmful' | 'other';
 export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'default';
 export type GeneratedAnswerSourceHoverMeta = GeneratedAnswerCitationMeta & {

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.30.38";
+export declare const libVersion = "2.30.40";

package/dist/library.cjs

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.38" ;
+var libVersion = "2.30.40" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84339,6 +84339,7 @@ exports.SearchPageEvents = void 0;
     SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
+    SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
 })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -85717,6 +85718,21 @@ var CoveoSearchPageClient = (function () {
             });
         });
     };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerCitationClick = function (info, citation) {
+        return this.makeClickEvent(exports.SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerCitationClick = function (info, citation) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerCitationClick(info, citation)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
     CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
         return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
     };
@@ -86235,6 +86251,9 @@ var CoveoInsightClient = (function () {
         return this.logCustomEvent(exports.SearchPageEvents.openGeneratedAnswerSource, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);
     };
+    CoveoInsightClient.prototype.logGeneratedAnswerCitationClick = function (info, citation, metadata) {
+        return this.logClickEvent(exports.SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    };
     CoveoInsightClient.prototype.logGeneratedAnswerSourceHover = function (generatedAnswerSourceMetadata, metadata) {
         return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);

package/dist/library.es.js

@@ -596,7 +596,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.30.38" ;
+const libVersion = "2.30.40" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1135,7 +1135,7 @@ class NoopAnalyticsClient {
     }
 }
 
-const fetch$1 = window.fetch;
+const fetch$1 = globalThis.fetch;
 
 class AnalyticsFetchClient {
     constructor(opts) {
@@ -1824,6 +1824,7 @@ var SearchPageEvents;
     SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
+    SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -2703,6 +2704,16 @@ class CoveoSearchPageClient {
             });
         });
     }
+    makeGeneratedAnswerCitationClick(info, citation) {
+        return this.makeClickEvent(SearchPageEvents.generatedAnswerCitationClick, Object.assign(Object.assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
+    }
+    logGeneratedAnswerCitationClick(info, citation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.makeGeneratedAnswerCitationClick(info, citation)).log({
+                searchUID: this.provider.getSearchUID(),
+            });
+        });
+    }
     makeGeneratedAnswerSourceHover(metadata) {
         return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
     }
@@ -3232,6 +3243,9 @@ class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.openGeneratedAnswerSource, metadata
             ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);
     }
+    logGeneratedAnswerCitationClick(info, citation, metadata) {
+        return this.logClickEvent(SearchPageEvents.generatedAnswerCitationClick, 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);
+    }
     logGeneratedAnswerSourceHover(generatedAnswerSourceMetadata, metadata) {
         return this.logCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata
             ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.38" ;
+var libVersion = "2.30.40" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84339,6 +84339,7 @@ exports.SearchPageEvents = void 0;
     SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
+    SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
 })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -85717,6 +85718,21 @@ var CoveoSearchPageClient = (function () {
             });
         });
     };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerCitationClick = function (info, citation) {
+        return this.makeClickEvent(exports.SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerCitationClick = function (info, citation) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerCitationClick(info, citation)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
     CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
         return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
     };
@@ -86235,6 +86251,9 @@ var CoveoInsightClient = (function () {
         return this.logCustomEvent(exports.SearchPageEvents.openGeneratedAnswerSource, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);
     };
+    CoveoInsightClient.prototype.logGeneratedAnswerCitationClick = function (info, citation, metadata) {
+        return this.logClickEvent(exports.SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    };
     CoveoInsightClient.prototype.logGeneratedAnswerSourceHover = function (generatedAnswerSourceMetadata, metadata) {
         return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);

package/dist/library.mjs

@@ -729,7 +729,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.38" ;
+var libVersion = "2.30.40" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84337,6 +84337,7 @@ var SearchPageEvents;
     SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
+    SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
 })(SearchPageEvents || (SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -85715,6 +85716,21 @@ var CoveoSearchPageClient = (function () {
             });
         });
     };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerCitationClick = function (info, citation) {
+        return this.makeClickEvent(SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerCitationClick = function (info, citation) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerCitationClick(info, citation)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
     CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
         return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
     };
@@ -86233,6 +86249,9 @@ var CoveoInsightClient = (function () {
         return this.logCustomEvent(SearchPageEvents.openGeneratedAnswerSource, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);
     };
+    CoveoInsightClient.prototype.logGeneratedAnswerCitationClick = function (info, citation, metadata) {
+        return this.logClickEvent(SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), citation) : citation);
+    };
     CoveoInsightClient.prototype.logGeneratedAnswerSourceHover = function (generatedAnswerSourceMetadata, metadata) {
         return this.logCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata
             ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);

package/dist/react-native.es.js

@@ -665,7 +665,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.30.38" ;
+const libVersion = "2.30.40" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1845,6 +1845,7 @@ var SearchPageEvents;
     SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
     SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
     SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
+    SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -2724,6 +2725,16 @@ class CoveoSearchPageClient {
             });
         });
     }
+    makeGeneratedAnswerCitationClick(info, citation) {
+        return this.makeClickEvent(SearchPageEvents.generatedAnswerCitationClick, Object.assign(Object.assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
+    }
+    logGeneratedAnswerCitationClick(info, citation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.makeGeneratedAnswerCitationClick(info, citation)).log({
+                searchUID: this.provider.getSearchUID(),
+            });
+        });
+    }
     makeGeneratedAnswerSourceHover(metadata) {
         return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
     }
@@ -3253,6 +3264,9 @@ class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.openGeneratedAnswerSource, metadata
             ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);
     }
+    logGeneratedAnswerCitationClick(info, citation, metadata) {
+        return this.logClickEvent(SearchPageEvents.generatedAnswerCitationClick, 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);
+    }
     logGeneratedAnswerSourceHover(generatedAnswerSourceMetadata, metadata) {
         return this.logCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata
             ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerSourceMetadata) : generatedAnswerSourceMetadata);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.30.38",
+    "version": "2.30.40",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.cjs",
     "module": "dist/browser.mjs",

package/src/events.ts

@@ -72,7 +72,7 @@ export interface PreparedSearchEventRequest extends Omit<SearchEventRequest, 'se
 
 export interface DocumentInformation {
     documentUri?: string;
-    documentUriHash: string;
+    documentUriHash?: string;
     collectionName?: string;
     sourceName: string;
     documentPosition: number;

package/src/insight/insightClient.spec.ts

@@ -544,6 +544,23 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.openGeneratedAnswerSource, exampleGeneratedAnswerMetadata);
         });
 
+        it('should send proper payload for #generatedAnswerCitationClick', 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.logGeneratedAnswerCitationClick(fakeDocInfo, meta);
+            expectMatchDocumentPayload(SearchPageEvents.generatedAnswerCitationClick, fakeDocInfo, expectedMetadata);
+        });
+
         it('should send proper payload for #generatedAnswerSourceHover', async () => {
             const exampleGeneratedAnswerMetadata = {
                 generativeQuestionAnsweringId: '123',
@@ -1331,6 +1348,23 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.openGeneratedAnswerSource, expectedMetadata);
         });
 
+        it('should send proper payload for #generatedAnswerCitationClick', 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.logGeneratedAnswerCitationClick(fakeDocInfo, meta, baseCaseMetadata);
+            expectMatchDocumentPayload(SearchPageEvents.generatedAnswerCitationClick, fakeDocInfo, expectedMetadata);
+        });
+
         it('should send proper payload for #generatedAnswerSourceHover', async () => {
             const exampleGeneratedAnswerMetadata = {
                 generativeQuestionAnsweringId: '123',

package/src/insight/insightClient.ts

@@ -7,6 +7,7 @@ import {
     DocumentIdentifier,
     FacetStateMetadata,
     GeneratedAnswerBaseMeta,
+    GeneratedAnswerCitationClickMeta,
     GeneratedAnswerCitationMeta,
     GeneratedAnswerFeedbackMeta,
     GeneratedAnswerFeedbackMetaV2,
@@ -520,6 +521,19 @@ export class CoveoInsightClient {
         );
     }
 
+    public logGeneratedAnswerCitationClick(
+        info: PartialDocumentInformation,
+        citation: GeneratedAnswerCitationClickMeta,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.generatedAnswerCitationClick,
+            {...info, documentPosition: 1},
+            {contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
+            metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation
+        );
+    }
+
     public logGeneratedAnswerSourceHover(
         generatedAnswerSourceMetadata: GeneratedAnswerSourceHoverMeta,
         metadata?: CaseMetadata

package/src/searchPage/searchPageClient.spec.ts

@@ -1494,6 +1494,35 @@ describe('SearchPageClient', () => {
         expectMatchDescription(built.description, SearchPageEvents.openGeneratedAnswerSource, meta);
     });
 
+    it('should send proper payload for #logGeneratedAnswerCitationClick', async () => {
+        const meta = {
+            generativeQuestionAnsweringId: fakeStreamId,
+            citationId: 'some-document-id',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        };
+
+        await client.logGeneratedAnswerCitationClick(fakeDocInfo, meta);
+        expectMatchDocumentPayload(SearchPageEvents.generatedAnswerCitationClick, fakeDocInfo, {
+            ...meta,
+            contentIDKey: meta.documentId.contentIdKey,
+            contentIDValue: meta.documentId.contentIdValue,
+        });
+    });
+
+    it('should send proper payload for #makeGeneratedAnswerCitationClick', async () => {
+        const meta = {
+            generativeQuestionAnsweringId: fakeStreamId,
+            citationId: 'some-document-id',
+            contentIDKey: 'permanentid',
+            contentIDValue: 'foo',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        };
+        const built = await client.makeGeneratedAnswerCitationClick(fakeDocInfo, meta);
+        await built.log({searchUID: provider.getSearchUID()});
+        expectMatchDocumentPayload(SearchPageEvents.generatedAnswerCitationClick, fakeDocInfo, meta);
+        expectMatchDescription(built.description, SearchPageEvents.generatedAnswerCitationClick, meta);
+    });
+
     it('should send proper payload for #logGeneratedAnswerStreamEnd', async () => {
         const meta = {generativeQuestionAnsweringId: fakeStreamId, answerGenerated: true, answerTextIsEmpty: false};
         await client.logGeneratedAnswerStreamEnd(meta);

package/src/searchPage/searchPageClient.ts

@@ -43,6 +43,7 @@ import {
     GeneratedAnswerBaseMeta,
     GeneratedAnswerRephraseMeta,
     GeneratedAnswerFeedbackMetaV2,
+    GeneratedAnswerCitationClickMeta,
 } from './searchPageEvents';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -912,6 +913,27 @@ export class CoveoSearchPageClient {
         });
     }
 
+    public makeGeneratedAnswerCitationClick(
+        info: PartialDocumentInformation,
+        citation: GeneratedAnswerCitationClickMeta
+    ) {
+        return this.makeClickEvent(
+            SearchPageEvents.generatedAnswerCitationClick,
+            {...info, documentPosition: 1},
+            {contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
+            citation
+        );
+    }
+
+    public async logGeneratedAnswerCitationClick(
+        info: PartialDocumentInformation,
+        citation: GeneratedAnswerCitationClickMeta
+    ) {
+        return (await this.makeGeneratedAnswerCitationClick(info, citation)).log({
+            searchUID: this.provider.getSearchUID(),
+        });
+    }
+
     public makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta) {
         return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
     }

package/src/searchPage/searchPageEvents.ts

@@ -350,6 +350,10 @@ export enum SearchPageEvents {
      * Identifies the new version of custom event that gets logged when a user submits a feedback of a generated answer.
      */
     generatedAnswerFeedbackSubmitV2 = 'generatedAnswerFeedbackSubmitV2',
+    /**
+     * Identifies the click event that gets logged when the user clicks on a generated answer citation.
+     */
+    generatedAnswerCitationClick = 'generatedAnswerCitationClick',
 }
 
 export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {
@@ -561,6 +565,16 @@ export type GeneratedAnswerCitationMeta = GeneratedAnswerBaseMeta & {
     citationId: string;
 };
 
+export type GeneratedAnswerCitationClickMeta = GeneratedAnswerBaseMeta & {
+    citationId: string;
+    documentId: GeneratedAnswerDocumentIdentifier;
+};
+
+type GeneratedAnswerDocumentIdentifier = {
+    contentIdKey: string;
+    contentIdValue: string;
+};
+
 export type GeneratedAnswerFeedbackReason = 'irrelevant' | 'notAccurate' | 'outOfDate' | 'harmful' | 'other';
 
 export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'default';