coveo.analytics 2.30.54 → 2.30.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { ClientOptions, AnalyticsClient } from '../client/analytics';
2
2
  import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
3
- 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';
3
+ 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, GeneratedAnswerInlineLinkMeta, GeneratedAnswerFollowupOpenSourceMeta } from './searchPageEvents';
4
4
  export interface SearchPageClientProvider {
5
5
  getBaseMetadata: () => Record<string, any>;
6
6
  getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -192,8 +192,12 @@ export declare class CoveoSearchPageClient {
192
192
  logDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
193
193
  makeOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<EventBuilder<CustomEventResponse>>;
194
194
  logOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<void | CustomEventResponse>;
195
+ makeGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta): Promise<EventBuilder<CustomEventResponse>>;
196
+ logGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta): Promise<void | CustomEventResponse>;
195
197
  makeGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise<EventBuilder<ClickEventResponse>>;
196
198
  logGeneratedAnswerCitationClick(info: PartialDocumentInformation, citation: GeneratedAnswerCitationClickMeta): Promise<void | ClickEventResponse>;
199
+ makeGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta): Promise<EventBuilder<CustomEventResponse>>;
200
+ logGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta): Promise<void | CustomEventResponse>;
197
201
  makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<EventBuilder<CustomEventResponse>>;
198
202
  logGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<void | CustomEventResponse>;
199
203
  makeGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
@@ -77,6 +77,7 @@ export declare enum SearchPageEvents {
77
77
  likeGeneratedAnswer = "likeGeneratedAnswer",
78
78
  dislikeGeneratedAnswer = "dislikeGeneratedAnswer",
79
79
  openGeneratedAnswerSource = "openGeneratedAnswerSource",
80
+ generatedAnswerOpenInlineLink = "generatedAnswerOpenInlineLink",
80
81
  generatedAnswerStreamEnd = "generatedAnswerStreamEnd",
81
82
  generatedAnswerSourceHover = "generatedAnswerSourceHover",
82
83
  generatedAnswerCopyToClipboard = "generatedAnswerCopyToClipboard",
@@ -88,6 +89,7 @@ export declare enum SearchPageEvents {
88
89
  rephraseGeneratedAnswer = "rephraseGeneratedAnswer",
89
90
  generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2",
90
91
  generatedAnswerCitationClick = "generatedAnswerCitationClick",
92
+ generatedAnswerFollowupOpenSource = "generatedAnswerFollowupOpenSource",
91
93
  generatedAnswerCitationDocumentAttach = "generatedAnswerCitationDocumentAttach"
92
94
  }
93
95
  export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
@@ -187,15 +189,18 @@ export interface SmartSnippetSuggestionMeta {
187
189
  answerSnippet: string;
188
190
  documentId: SmartSnippetDocumentIdentifier;
189
191
  }
190
- export interface SmartSnippetLinkMeta {
192
+ export interface LinkMeta {
191
193
  linkText: string;
192
194
  linkURL: string;
193
195
  }
196
+ export interface SmartSnippetLinkMeta extends LinkMeta {
197
+ }
194
198
  export interface SmartSnippetDocumentIdentifier {
195
199
  contentIdKey: string;
196
200
  contentIdValue: string;
197
201
  }
198
202
  export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
203
+ export type PartialCitationInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid' | 'documentPosition'>;
199
204
  interface AnswerGeneratedWithAnswerAPI {
200
205
  answerAPIStreamId: string;
201
206
  generativeQuestionAnsweringId?: never;
@@ -220,6 +225,7 @@ export type GeneratedAnswerCitationMeta = GeneratedAnswerBaseMeta & {
220
225
  permanentId: string;
221
226
  citationId: string;
222
227
  };
228
+ export type GeneratedAnswerInlineLinkMeta = GeneratedAnswerBaseMeta & LinkMeta;
223
229
  export type GeneratedAnswerCitationClickMeta = GeneratedAnswerBaseMeta & {
224
230
  citationId: string;
225
231
  documentId: GeneratedAnswerDocumentIdentifier;
@@ -233,6 +239,10 @@ export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'def
233
239
  export type GeneratedAnswerSourceHoverMeta = GeneratedAnswerCitationMeta & {
234
240
  citationHoverTimeMs: number;
235
241
  };
242
+ export type GeneratedAnswerFollowupOpenSourceMeta = PartialCitationInformation & AnswerGeneratedWithAgent & {
243
+ citationId: string;
244
+ permanentId: string;
245
+ };
236
246
  export type GeneratedAnswerRephraseMeta = GeneratedAnswerBaseMeta & {
237
247
  rephraseFormat: GeneratedAnswerRephraseFormat;
238
248
  };
@@ -1 +1 @@
1
- export declare const libVersion = "2.30.54";
1
+ export declare const libVersion = "2.30.56";
package/dist/library.cjs CHANGED
@@ -736,7 +736,7 @@ function sha1(bytes) {
736
736
  const v5 = v35('v5', 0x50, sha1);
737
737
  var uuidv5 = v5;
738
738
 
739
- var libVersion = "2.30.54";
739
+ var libVersion = "2.30.56";
740
740
 
741
741
  var getFormattedLocation = function (location) {
742
742
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84425,6 +84425,7 @@ exports.SearchPageEvents = void 0;
84425
84425
  SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
84426
84426
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
84427
84427
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
84428
+ SearchPageEvents["generatedAnswerOpenInlineLink"] = "generatedAnswerOpenInlineLink";
84428
84429
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
84429
84430
  SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
84430
84431
  SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
@@ -84436,6 +84437,7 @@ exports.SearchPageEvents = void 0;
84436
84437
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84437
84438
  SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
84438
84439
  SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
84440
+ SearchPageEvents["generatedAnswerFollowupOpenSource"] = "generatedAnswerFollowupOpenSource";
84439
84441
  SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
84440
84442
  })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
84441
84443
  var CustomEventsTypes = (_a = {},
@@ -84474,6 +84476,8 @@ var CustomEventsTypes = (_a = {},
84474
84476
  _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
84475
84477
  _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
84476
84478
  _a[exports.SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
84479
+ _a[exports.SearchPageEvents.generatedAnswerOpenInlineLink] = 'generatedAnswer',
84480
+ _a[exports.SearchPageEvents.generatedAnswerFollowupOpenSource] = 'generatedAnswer',
84477
84481
  _a[exports.SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
84478
84482
  _a[exports.SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
84479
84483
  _a[exports.SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
@@ -85814,6 +85818,21 @@ var CoveoSearchPageClient = (function () {
85814
85818
  });
85815
85819
  });
85816
85820
  };
85821
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerOpenInlineLink = function (metadata) {
85822
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerOpenInlineLink, metadata);
85823
+ };
85824
+ CoveoSearchPageClient.prototype.logGeneratedAnswerOpenInlineLink = function (metadata) {
85825
+ return __awaiter(this, void 0, void 0, function () {
85826
+ return __generator(this, function (_a) {
85827
+ switch (_a.label) {
85828
+ case 0: return [4, this.makeGeneratedAnswerOpenInlineLink(metadata)];
85829
+ case 1: return [2, (_a.sent()).log({
85830
+ searchUID: this.provider.getSearchUID(),
85831
+ })];
85832
+ }
85833
+ });
85834
+ });
85835
+ };
85817
85836
  CoveoSearchPageClient.prototype.makeGeneratedAnswerCitationClick = function (info, citation) {
85818
85837
  return this.makeClickEvent(exports.SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
85819
85838
  };
@@ -85829,6 +85848,21 @@ var CoveoSearchPageClient = (function () {
85829
85848
  });
85830
85849
  });
85831
85850
  };
85851
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerFollowupOpenSource = function (metadata) {
85852
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerFollowupOpenSource, metadata);
85853
+ };
85854
+ CoveoSearchPageClient.prototype.logGeneratedAnswerFollowupOpenSource = function (metadata) {
85855
+ return __awaiter(this, void 0, void 0, function () {
85856
+ return __generator(this, function (_a) {
85857
+ switch (_a.label) {
85858
+ case 0: return [4, this.makeGeneratedAnswerFollowupOpenSource(metadata)];
85859
+ case 1: return [2, (_a.sent()).log({
85860
+ searchUID: this.provider.getSearchUID(),
85861
+ })];
85862
+ }
85863
+ });
85864
+ });
85865
+ };
85832
85866
  CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
85833
85867
  return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
85834
85868
  };
@@ -603,7 +603,7 @@ function sha1(bytes) {
603
603
  const v5 = v35('v5', 0x50, sha1);
604
604
  var uuidv5 = v5;
605
605
 
606
- const libVersion = "2.30.54";
606
+ const libVersion = "2.30.56";
607
607
 
608
608
  const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
609
609
 
@@ -1822,6 +1822,7 @@ var SearchPageEvents;
1822
1822
  SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
1823
1823
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
1824
1824
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
1825
+ SearchPageEvents["generatedAnswerOpenInlineLink"] = "generatedAnswerOpenInlineLink";
1825
1826
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
1826
1827
  SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
1827
1828
  SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
@@ -1833,6 +1834,7 @@ var SearchPageEvents;
1833
1834
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
1834
1835
  SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
1835
1836
  SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
1837
+ SearchPageEvents["generatedAnswerFollowupOpenSource"] = "generatedAnswerFollowupOpenSource";
1836
1838
  SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
1837
1839
  })(SearchPageEvents || (SearchPageEvents = {}));
1838
1840
  const CustomEventsTypes = {
@@ -1871,6 +1873,8 @@ const CustomEventsTypes = {
1871
1873
  [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
1872
1874
  [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
1873
1875
  [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
1876
+ [SearchPageEvents.generatedAnswerOpenInlineLink]: 'generatedAnswer',
1877
+ [SearchPageEvents.generatedAnswerFollowupOpenSource]: 'generatedAnswer',
1874
1878
  [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
1875
1879
  [SearchPageEvents.generatedAnswerSourceHover]: 'generatedAnswer',
1876
1880
  [SearchPageEvents.generatedAnswerCopyToClipboard]: 'generatedAnswer',
@@ -2712,6 +2716,16 @@ class CoveoSearchPageClient {
2712
2716
  });
2713
2717
  });
2714
2718
  }
2719
+ makeGeneratedAnswerOpenInlineLink(metadata) {
2720
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerOpenInlineLink, metadata);
2721
+ }
2722
+ logGeneratedAnswerOpenInlineLink(metadata) {
2723
+ return __awaiter(this, void 0, void 0, function* () {
2724
+ return (yield this.makeGeneratedAnswerOpenInlineLink(metadata)).log({
2725
+ searchUID: this.provider.getSearchUID(),
2726
+ });
2727
+ });
2728
+ }
2715
2729
  makeGeneratedAnswerCitationClick(info, citation) {
2716
2730
  return this.makeClickEvent(SearchPageEvents.generatedAnswerCitationClick, Object.assign(Object.assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
2717
2731
  }
@@ -2722,6 +2736,16 @@ class CoveoSearchPageClient {
2722
2736
  });
2723
2737
  });
2724
2738
  }
2739
+ makeGeneratedAnswerFollowupOpenSource(metadata) {
2740
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFollowupOpenSource, metadata);
2741
+ }
2742
+ logGeneratedAnswerFollowupOpenSource(metadata) {
2743
+ return __awaiter(this, void 0, void 0, function* () {
2744
+ return (yield this.makeGeneratedAnswerFollowupOpenSource(metadata)).log({
2745
+ searchUID: this.provider.getSearchUID(),
2746
+ });
2747
+ });
2748
+ }
2725
2749
  makeGeneratedAnswerSourceHover(metadata) {
2726
2750
  return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
2727
2751
  }
package/dist/library.js CHANGED
@@ -736,7 +736,7 @@ function sha1(bytes) {
736
736
  const v5 = v35('v5', 0x50, sha1);
737
737
  var uuidv5 = v5;
738
738
 
739
- var libVersion = "2.30.54";
739
+ var libVersion = "2.30.56";
740
740
 
741
741
  var getFormattedLocation = function (location) {
742
742
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84425,6 +84425,7 @@ exports.SearchPageEvents = void 0;
84425
84425
  SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
84426
84426
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
84427
84427
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
84428
+ SearchPageEvents["generatedAnswerOpenInlineLink"] = "generatedAnswerOpenInlineLink";
84428
84429
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
84429
84430
  SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
84430
84431
  SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
@@ -84436,6 +84437,7 @@ exports.SearchPageEvents = void 0;
84436
84437
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84437
84438
  SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
84438
84439
  SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
84440
+ SearchPageEvents["generatedAnswerFollowupOpenSource"] = "generatedAnswerFollowupOpenSource";
84439
84441
  SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
84440
84442
  })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
84441
84443
  var CustomEventsTypes = (_a = {},
@@ -84474,6 +84476,8 @@ var CustomEventsTypes = (_a = {},
84474
84476
  _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
84475
84477
  _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
84476
84478
  _a[exports.SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
84479
+ _a[exports.SearchPageEvents.generatedAnswerOpenInlineLink] = 'generatedAnswer',
84480
+ _a[exports.SearchPageEvents.generatedAnswerFollowupOpenSource] = 'generatedAnswer',
84477
84481
  _a[exports.SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
84478
84482
  _a[exports.SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
84479
84483
  _a[exports.SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
@@ -85814,6 +85818,21 @@ var CoveoSearchPageClient = (function () {
85814
85818
  });
85815
85819
  });
85816
85820
  };
85821
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerOpenInlineLink = function (metadata) {
85822
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerOpenInlineLink, metadata);
85823
+ };
85824
+ CoveoSearchPageClient.prototype.logGeneratedAnswerOpenInlineLink = function (metadata) {
85825
+ return __awaiter(this, void 0, void 0, function () {
85826
+ return __generator(this, function (_a) {
85827
+ switch (_a.label) {
85828
+ case 0: return [4, this.makeGeneratedAnswerOpenInlineLink(metadata)];
85829
+ case 1: return [2, (_a.sent()).log({
85830
+ searchUID: this.provider.getSearchUID(),
85831
+ })];
85832
+ }
85833
+ });
85834
+ });
85835
+ };
85817
85836
  CoveoSearchPageClient.prototype.makeGeneratedAnswerCitationClick = function (info, citation) {
85818
85837
  return this.makeClickEvent(exports.SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
85819
85838
  };
@@ -85829,6 +85848,21 @@ var CoveoSearchPageClient = (function () {
85829
85848
  });
85830
85849
  });
85831
85850
  };
85851
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerFollowupOpenSource = function (metadata) {
85852
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerFollowupOpenSource, metadata);
85853
+ };
85854
+ CoveoSearchPageClient.prototype.logGeneratedAnswerFollowupOpenSource = function (metadata) {
85855
+ return __awaiter(this, void 0, void 0, function () {
85856
+ return __generator(this, function (_a) {
85857
+ switch (_a.label) {
85858
+ case 0: return [4, this.makeGeneratedAnswerFollowupOpenSource(metadata)];
85859
+ case 1: return [2, (_a.sent()).log({
85860
+ searchUID: this.provider.getSearchUID(),
85861
+ })];
85862
+ }
85863
+ });
85864
+ });
85865
+ };
85832
85866
  CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
85833
85867
  return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
85834
85868
  };
package/dist/library.mjs CHANGED
@@ -734,7 +734,7 @@ function sha1(bytes) {
734
734
  const v5 = v35('v5', 0x50, sha1);
735
735
  var uuidv5 = v5;
736
736
 
737
- var libVersion = "2.30.54";
737
+ var libVersion = "2.30.56";
738
738
 
739
739
  var getFormattedLocation = function (location) {
740
740
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84423,6 +84423,7 @@ var SearchPageEvents;
84423
84423
  SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
84424
84424
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
84425
84425
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
84426
+ SearchPageEvents["generatedAnswerOpenInlineLink"] = "generatedAnswerOpenInlineLink";
84426
84427
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
84427
84428
  SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
84428
84429
  SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
@@ -84434,6 +84435,7 @@ var SearchPageEvents;
84434
84435
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84435
84436
  SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
84436
84437
  SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
84438
+ SearchPageEvents["generatedAnswerFollowupOpenSource"] = "generatedAnswerFollowupOpenSource";
84437
84439
  SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
84438
84440
  })(SearchPageEvents || (SearchPageEvents = {}));
84439
84441
  var CustomEventsTypes = (_a = {},
@@ -84472,6 +84474,8 @@ var CustomEventsTypes = (_a = {},
84472
84474
  _a[SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
84473
84475
  _a[SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
84474
84476
  _a[SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
84477
+ _a[SearchPageEvents.generatedAnswerOpenInlineLink] = 'generatedAnswer',
84478
+ _a[SearchPageEvents.generatedAnswerFollowupOpenSource] = 'generatedAnswer',
84475
84479
  _a[SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
84476
84480
  _a[SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
84477
84481
  _a[SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
@@ -85812,6 +85816,21 @@ var CoveoSearchPageClient = (function () {
85812
85816
  });
85813
85817
  });
85814
85818
  };
85819
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerOpenInlineLink = function (metadata) {
85820
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerOpenInlineLink, metadata);
85821
+ };
85822
+ CoveoSearchPageClient.prototype.logGeneratedAnswerOpenInlineLink = function (metadata) {
85823
+ return __awaiter(this, void 0, void 0, function () {
85824
+ return __generator(this, function (_a) {
85825
+ switch (_a.label) {
85826
+ case 0: return [4, this.makeGeneratedAnswerOpenInlineLink(metadata)];
85827
+ case 1: return [2, (_a.sent()).log({
85828
+ searchUID: this.provider.getSearchUID(),
85829
+ })];
85830
+ }
85831
+ });
85832
+ });
85833
+ };
85815
85834
  CoveoSearchPageClient.prototype.makeGeneratedAnswerCitationClick = function (info, citation) {
85816
85835
  return this.makeClickEvent(SearchPageEvents.generatedAnswerCitationClick, __assign(__assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
85817
85836
  };
@@ -85827,6 +85846,21 @@ var CoveoSearchPageClient = (function () {
85827
85846
  });
85828
85847
  });
85829
85848
  };
85849
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerFollowupOpenSource = function (metadata) {
85850
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFollowupOpenSource, metadata);
85851
+ };
85852
+ CoveoSearchPageClient.prototype.logGeneratedAnswerFollowupOpenSource = function (metadata) {
85853
+ return __awaiter(this, void 0, void 0, function () {
85854
+ return __generator(this, function (_a) {
85855
+ switch (_a.label) {
85856
+ case 0: return [4, this.makeGeneratedAnswerFollowupOpenSource(metadata)];
85857
+ case 1: return [2, (_a.sent()).log({
85858
+ searchUID: this.provider.getSearchUID(),
85859
+ })];
85860
+ }
85861
+ });
85862
+ });
85863
+ };
85830
85864
  CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
85831
85865
  return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
85832
85866
  };
@@ -672,7 +672,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
672
672
  yield store.addElementAsync(historyElement);
673
673
  });
674
674
 
675
- const libVersion = "2.30.54";
675
+ const libVersion = "2.30.56";
676
676
 
677
677
  const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
678
678
 
@@ -1843,6 +1843,7 @@ var SearchPageEvents;
1843
1843
  SearchPageEvents["likeGeneratedAnswer"] = "likeGeneratedAnswer";
1844
1844
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
1845
1845
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
1846
+ SearchPageEvents["generatedAnswerOpenInlineLink"] = "generatedAnswerOpenInlineLink";
1846
1847
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
1847
1848
  SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
1848
1849
  SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
@@ -1854,6 +1855,7 @@ var SearchPageEvents;
1854
1855
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
1855
1856
  SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
1856
1857
  SearchPageEvents["generatedAnswerCitationClick"] = "generatedAnswerCitationClick";
1858
+ SearchPageEvents["generatedAnswerFollowupOpenSource"] = "generatedAnswerFollowupOpenSource";
1857
1859
  SearchPageEvents["generatedAnswerCitationDocumentAttach"] = "generatedAnswerCitationDocumentAttach";
1858
1860
  })(SearchPageEvents || (SearchPageEvents = {}));
1859
1861
  const CustomEventsTypes = {
@@ -1892,6 +1894,8 @@ const CustomEventsTypes = {
1892
1894
  [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
1893
1895
  [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
1894
1896
  [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
1897
+ [SearchPageEvents.generatedAnswerOpenInlineLink]: 'generatedAnswer',
1898
+ [SearchPageEvents.generatedAnswerFollowupOpenSource]: 'generatedAnswer',
1895
1899
  [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
1896
1900
  [SearchPageEvents.generatedAnswerSourceHover]: 'generatedAnswer',
1897
1901
  [SearchPageEvents.generatedAnswerCopyToClipboard]: 'generatedAnswer',
@@ -2733,6 +2737,16 @@ class CoveoSearchPageClient {
2733
2737
  });
2734
2738
  });
2735
2739
  }
2740
+ makeGeneratedAnswerOpenInlineLink(metadata) {
2741
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerOpenInlineLink, metadata);
2742
+ }
2743
+ logGeneratedAnswerOpenInlineLink(metadata) {
2744
+ return __awaiter(this, void 0, void 0, function* () {
2745
+ return (yield this.makeGeneratedAnswerOpenInlineLink(metadata)).log({
2746
+ searchUID: this.provider.getSearchUID(),
2747
+ });
2748
+ });
2749
+ }
2736
2750
  makeGeneratedAnswerCitationClick(info, citation) {
2737
2751
  return this.makeClickEvent(SearchPageEvents.generatedAnswerCitationClick, Object.assign(Object.assign({}, info), { documentPosition: 1 }), { contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue }, citation);
2738
2752
  }
@@ -2743,6 +2757,16 @@ class CoveoSearchPageClient {
2743
2757
  });
2744
2758
  });
2745
2759
  }
2760
+ makeGeneratedAnswerFollowupOpenSource(metadata) {
2761
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFollowupOpenSource, metadata);
2762
+ }
2763
+ logGeneratedAnswerFollowupOpenSource(metadata) {
2764
+ return __awaiter(this, void 0, void 0, function* () {
2765
+ return (yield this.makeGeneratedAnswerFollowupOpenSource(metadata)).log({
2766
+ searchUID: this.provider.getSearchUID(),
2767
+ });
2768
+ });
2769
+ }
2746
2770
  makeGeneratedAnswerSourceHover(metadata) {
2747
2771
  return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
2748
2772
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "coveo.analytics",
3
- "version": "2.30.54",
3
+ "version": "2.30.56",
4
4
  "description": "📈 Coveo analytics client (node and browser compatible) ",
5
5
  "main": "dist/library.cjs",
6
6
  "module": "dist/browser.mjs",
@@ -1519,6 +1519,29 @@ describe('SearchPageClient', () => {
1519
1519
  expectMatchDescription(built.description, SearchPageEvents.openGeneratedAnswerSource, meta);
1520
1520
  });
1521
1521
 
1522
+ it('should send proper payload for #logGeneratedAnswerOpenInlineLink', async () => {
1523
+ const meta = {
1524
+ generativeQuestionAnsweringId: fakeStreamId,
1525
+ conversationId: fakeConversationId,
1526
+ linkText: 'Read more',
1527
+ linkURL: 'https://example.com',
1528
+ };
1529
+ await client.logGeneratedAnswerOpenInlineLink(meta);
1530
+ expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerOpenInlineLink, meta);
1531
+ });
1532
+
1533
+ it('should send proper payload for #makeGeneratedAnswerOpenInlineLink', async () => {
1534
+ const meta = {
1535
+ generativeQuestionAnsweringId: fakeStreamId,
1536
+ linkText: 'Read more',
1537
+ linkURL: 'https://example.com',
1538
+ };
1539
+ const built = await client.makeGeneratedAnswerOpenInlineLink(meta);
1540
+ await built.log({searchUID: provider.getSearchUID()});
1541
+ expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerOpenInlineLink, meta);
1542
+ expectMatchDescription(built.description, SearchPageEvents.generatedAnswerOpenInlineLink, meta);
1543
+ });
1544
+
1522
1545
  it('should send proper payload for #logGeneratedAnswerCitationClick', async () => {
1523
1546
  const meta = {
1524
1547
  generativeQuestionAnsweringId: fakeStreamId,
@@ -1564,6 +1587,34 @@ describe('SearchPageClient', () => {
1564
1587
  expectMatchDescription(built.description, SearchPageEvents.generatedAnswerCitationClick, meta);
1565
1588
  });
1566
1589
 
1590
+ it('should send proper payload for #logGeneratedAnswerFollowupOpenSource', async () => {
1591
+ const meta = {
1592
+ ...fakeDocInfo,
1593
+ citationId: 'some-document-id',
1594
+ permanentId: 'perm-id',
1595
+ generativeQuestionAnsweringId: fakeStreamId,
1596
+ conversationId: fakeConversationId,
1597
+ };
1598
+
1599
+ await client.logGeneratedAnswerFollowupOpenSource(meta);
1600
+ expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerFollowupOpenSource, meta);
1601
+ });
1602
+
1603
+ it('should send proper payload for #makeGeneratedAnswerFollowupOpenSource', async () => {
1604
+ const meta = {
1605
+ ...fakeDocInfo,
1606
+ citationId: 'some-document-id',
1607
+ permanentId: 'perm-id',
1608
+ generativeQuestionAnsweringId: fakeStreamId,
1609
+ conversationId: fakeConversationId,
1610
+ };
1611
+
1612
+ const built = await client.makeGeneratedAnswerFollowupOpenSource(meta);
1613
+ await built.log({searchUID: provider.getSearchUID()});
1614
+ expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerFollowupOpenSource, meta);
1615
+ expectMatchDescription(built.description, SearchPageEvents.generatedAnswerFollowupOpenSource, meta);
1616
+ });
1617
+
1567
1618
  it('should send proper payload for #logGeneratedAnswerStreamEnd', async () => {
1568
1619
  const meta = {generativeQuestionAnsweringId: fakeStreamId, answerGenerated: true, answerTextIsEmpty: false};
1569
1620
  await client.logGeneratedAnswerStreamEnd(meta);
@@ -44,6 +44,8 @@ import {
44
44
  GeneratedAnswerRephraseMeta,
45
45
  GeneratedAnswerFeedbackMetaV2,
46
46
  GeneratedAnswerCitationClickMeta,
47
+ GeneratedAnswerInlineLinkMeta,
48
+ GeneratedAnswerFollowupOpenSourceMeta,
47
49
  } from './searchPageEvents';
48
50
  import {NoopAnalytics} from '../client/noopAnalytics';
49
51
  import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -916,6 +918,16 @@ export class CoveoSearchPageClient {
916
918
  });
917
919
  }
918
920
 
921
+ public makeGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta) {
922
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerOpenInlineLink, metadata);
923
+ }
924
+
925
+ public async logGeneratedAnswerOpenInlineLink(metadata: GeneratedAnswerInlineLinkMeta) {
926
+ return (await this.makeGeneratedAnswerOpenInlineLink(metadata)).log({
927
+ searchUID: this.provider.getSearchUID(),
928
+ });
929
+ }
930
+
919
931
  public makeGeneratedAnswerCitationClick(
920
932
  info: PartialDocumentInformation,
921
933
  citation: GeneratedAnswerCitationClickMeta,
@@ -937,6 +949,16 @@ export class CoveoSearchPageClient {
937
949
  });
938
950
  }
939
951
 
952
+ public makeGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta) {
953
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFollowupOpenSource, metadata);
954
+ }
955
+
956
+ public async logGeneratedAnswerFollowupOpenSource(metadata: GeneratedAnswerFollowupOpenSourceMeta) {
957
+ return (await this.makeGeneratedAnswerFollowupOpenSource(metadata)).log({
958
+ searchUID: this.provider.getSearchUID(),
959
+ });
960
+ }
961
+
940
962
  public makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta) {
941
963
  return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
942
964
  }
@@ -310,6 +310,10 @@ export enum SearchPageEvents {
310
310
  * Identifies the custom event that gets logged when a user opens a generated answer citation.
311
311
  */
312
312
  openGeneratedAnswerSource = 'openGeneratedAnswerSource',
313
+ /**
314
+ * Identifies the custom event that gets logged when a user clicks an inline link in a generated answer.
315
+ */
316
+ generatedAnswerOpenInlineLink = 'generatedAnswerOpenInlineLink',
313
317
  /**
314
318
  * Identified the custom event that gets logged when a generated answer stream is completed.
315
319
  */
@@ -354,6 +358,10 @@ export enum SearchPageEvents {
354
358
  * Identifies the click event that gets logged when the user clicks on a generated answer citation.
355
359
  */
356
360
  generatedAnswerCitationClick = 'generatedAnswerCitationClick',
361
+ /**
362
+ * Identifies the custom event that gets logged when the user clicks on a generated answer citation.
363
+ */
364
+ generatedAnswerFollowupOpenSource = 'generatedAnswerFollowupOpenSource',
357
365
  /**
358
366
  * Identifies the click event that gets logged when a user clicks the Attach Citation action.
359
367
  */
@@ -398,6 +406,8 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
398
406
  [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
399
407
  [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
400
408
  [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
409
+ [SearchPageEvents.generatedAnswerOpenInlineLink]: 'generatedAnswer',
410
+ [SearchPageEvents.generatedAnswerFollowupOpenSource]: 'generatedAnswer',
401
411
  [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
402
412
  [SearchPageEvents.generatedAnswerSourceHover]: 'generatedAnswer',
403
413
  [SearchPageEvents.generatedAnswerCopyToClipboard]: 'generatedAnswer',
@@ -536,11 +546,13 @@ export interface SmartSnippetSuggestionMeta {
536
546
  documentId: SmartSnippetDocumentIdentifier;
537
547
  }
538
548
 
539
- export interface SmartSnippetLinkMeta {
549
+ export interface LinkMeta {
540
550
  linkText: string;
541
551
  linkURL: string;
542
552
  }
543
553
 
554
+ export interface SmartSnippetLinkMeta extends LinkMeta {}
555
+
544
556
  export interface SmartSnippetDocumentIdentifier {
545
557
  contentIdKey: string;
546
558
  contentIdValue: string;
@@ -548,6 +560,11 @@ export interface SmartSnippetDocumentIdentifier {
548
560
 
549
561
  export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
550
562
 
563
+ export type PartialCitationInformation = Omit<
564
+ DocumentInformation,
565
+ 'actionCause' | 'searchQueryUid' | 'documentPosition'
566
+ >;
567
+
551
568
  interface AnswerGeneratedWithAnswerAPI {
552
569
  answerAPIStreamId: string;
553
570
  generativeQuestionAnsweringId?: never;
@@ -581,6 +598,8 @@ export type GeneratedAnswerCitationMeta = GeneratedAnswerBaseMeta & {
581
598
  citationId: string;
582
599
  };
583
600
 
601
+ export type GeneratedAnswerInlineLinkMeta = GeneratedAnswerBaseMeta & LinkMeta;
602
+
584
603
  export type GeneratedAnswerCitationClickMeta = GeneratedAnswerBaseMeta & {
585
604
  citationId: string;
586
605
  documentId: GeneratedAnswerDocumentIdentifier;
@@ -599,6 +618,12 @@ export type GeneratedAnswerSourceHoverMeta = GeneratedAnswerCitationMeta & {
599
618
  citationHoverTimeMs: number;
600
619
  };
601
620
 
621
+ export type GeneratedAnswerFollowupOpenSourceMeta = PartialCitationInformation &
622
+ AnswerGeneratedWithAgent & {
623
+ citationId: string;
624
+ permanentId: string;
625
+ };
626
+
602
627
  export type GeneratedAnswerRephraseMeta = GeneratedAnswerBaseMeta & {
603
628
  rephraseFormat: GeneratedAnswerRephraseFormat;
604
629
  };