coveo.analytics 2.28.18 → 2.28.19

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 } 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 } from './searchPageEvents';
4
4
  export interface SearchPageClientProvider {
5
5
  getBaseMetadata: () => Record<string, any>;
6
6
  getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -15,6 +15,7 @@ export interface SearchPageClientProvider {
15
15
  getFacetState?: () => FacetStateMetadata[];
16
16
  getSplitTestRunName?: () => string | undefined;
17
17
  getSplitTestRunVersion?: () => string | undefined;
18
+ getGeneratedAnswerMetadata?: () => Record<string, any>;
18
19
  }
19
20
  export interface SearchPageClientOptions extends ClientOptions {
20
21
  enableAnalytics: boolean;
@@ -185,12 +186,24 @@ export declare class CoveoSearchPageClient {
185
186
  private getOrigins;
186
187
  private getClientId;
187
188
  private getSplitTestRun;
188
- makeLikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
189
- logLikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
190
- makeDislikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
191
- logDislikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
189
+ makeLikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
190
+ logLikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
191
+ makeDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
192
+ logDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
192
193
  makeOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<EventBuilder<CustomEventResponse>>;
193
194
  logOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<void | CustomEventResponse>;
195
+ makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<EventBuilder<CustomEventResponse>>;
196
+ logGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<void | CustomEventResponse>;
197
+ makeGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
198
+ logGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
199
+ makeGeneratedAnswerHideAnswers(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
200
+ logGeneratedAnswerHideAnswers(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
201
+ makeGeneratedAnswerShowAnswers(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
202
+ logGeneratedAnswerShowAnswers(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
203
+ makeGenerativeQuestionFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
204
+ logGenerativeQuestionFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
205
+ makeRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise<EventBuilder<SearchEventResponse>>;
206
+ logRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise<void | SearchEventResponse>;
194
207
  makeRetryGeneratedAnswer(): Promise<EventBuilder<SearchEventResponse>>;
195
208
  logRetryGeneratedAnswer(): Promise<void | SearchEventResponse>;
196
209
  makeGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta): Promise<EventBuilder<CustomEventResponse>>;
@@ -77,7 +77,13 @@ export declare enum SearchPageEvents {
77
77
  likeGeneratedAnswer = "likeGeneratedAnswer",
78
78
  dislikeGeneratedAnswer = "dislikeGeneratedAnswer",
79
79
  openGeneratedAnswerSource = "openGeneratedAnswerSource",
80
- generatedAnswerStreamEnd = "generatedAnswerStreamEnd"
80
+ generatedAnswerStreamEnd = "generatedAnswerStreamEnd",
81
+ generatedAnswerSourceHover = "generatedAnswerSourceHover",
82
+ generatedAnswerCopyToClipboard = "generatedAnswerCopyToClipboard",
83
+ generatedAnswerHideAnswers = "generatedAnswerHideAnswers",
84
+ generatedAnswerShowAnswers = "generatedAnswerShowAnswers",
85
+ generativeQuestionFeedbackSubmit = "generativeQuestionFeedbackSubmit",
86
+ rephraseGeneratedAnswer = "rephraseGeneratedAnswer"
81
87
  }
82
88
  export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
83
89
  export interface StaticFilterMetadata {
@@ -185,17 +191,27 @@ export interface SmartSnippetDocumentIdentifier {
185
191
  contentIdValue: string;
186
192
  }
187
193
  export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
188
- interface GeneratedAnswerBaseMeta {
194
+ export interface GeneratedAnswerBaseMeta {
189
195
  generativeQuestionAnsweringId: string;
190
196
  }
191
- export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
192
- }
193
197
  export interface GeneratedAnswerStreamEndMeta extends GeneratedAnswerBaseMeta {
194
198
  answerGenerated: boolean;
195
199
  }
196
200
  export interface GeneratedAnswerCitationMeta {
197
201
  generativeQuestionAnsweringId: string;
198
202
  permanentId: string;
199
- id: string;
203
+ citationId: string;
204
+ }
205
+ export type GeneratedAnswerFeedbackReason = 'irrelevant' | 'notAccurate' | 'outOfDate' | 'harmful' | 'other';
206
+ export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'default';
207
+ export interface GeneratedAnswerSourceHoverMeta extends GeneratedAnswerCitationMeta {
208
+ citationHoverTimeMs: number;
209
+ }
210
+ export interface GeneratedAnswerRephraseMeta extends GeneratedAnswerBaseMeta {
211
+ rephraseFormat: GeneratedAnswerRephraseFormat;
212
+ }
213
+ export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
214
+ reason: GeneratedAnswerFeedbackReason;
215
+ details?: string;
200
216
  }
201
217
  export {};
@@ -1 +1 @@
1
- export declare const libVersion = "2.28.18";
1
+ export declare const libVersion = "2.28.19";
package/dist/library.cjs CHANGED
@@ -731,7 +731,7 @@ function sha1(bytes) {
731
731
  const v5 = v35('v5', 0x50, sha1);
732
732
  var uuidv5 = v5;
733
733
 
734
- var libVersion = "2.28.18" ;
734
+ var libVersion = "2.28.19" ;
735
735
 
736
736
  var getFormattedLocation = function (location) {
737
737
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84285,6 +84285,12 @@ exports.SearchPageEvents = void 0;
84285
84285
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
84286
84286
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
84287
84287
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
84288
+ SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
84289
+ SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
84290
+ SearchPageEvents["generatedAnswerHideAnswers"] = "generatedAnswerHideAnswers";
84291
+ SearchPageEvents["generatedAnswerShowAnswers"] = "generatedAnswerShowAnswers";
84292
+ SearchPageEvents["generativeQuestionFeedbackSubmit"] = "generativeQuestionFeedbackSubmit";
84293
+ SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84288
84294
  })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
84289
84295
  var CustomEventsTypes = (_a = {},
84290
84296
  _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84330,6 +84336,11 @@ var CustomEventsTypes = (_a = {},
84330
84336
  _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
84331
84337
  _a[exports.SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
84332
84338
  _a[exports.SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
84339
+ _a[exports.SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
84340
+ _a[exports.SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
84341
+ _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
84342
+ _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
84343
+ _a[exports.SearchPageEvents.generativeQuestionFeedbackSubmit] = 'generatedAnswer',
84333
84344
  _a);
84334
84345
 
84335
84346
  var NoopAnalytics = (function () {
@@ -85568,14 +85579,15 @@ var CoveoSearchPageClient = (function () {
85568
85579
  });
85569
85580
  };
85570
85581
  CoveoSearchPageClient.prototype.getBaseSearchEventRequest = function (event, metadata) {
85582
+ var _a, _b;
85571
85583
  return __awaiter(this, void 0, void 0, function () {
85572
- var _a;
85573
- return __generator(this, function (_b) {
85574
- switch (_b.label) {
85584
+ var _c;
85585
+ return __generator(this, function (_d) {
85586
+ switch (_d.label) {
85575
85587
  case 0:
85576
- _a = [{}];
85577
- return [4, this.getBaseEventRequest(metadata)];
85578
- case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
85588
+ _c = [{}];
85589
+ return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a)))];
85590
+ case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
85579
85591
  }
85580
85592
  });
85581
85593
  });
@@ -85656,6 +85668,94 @@ var CoveoSearchPageClient = (function () {
85656
85668
  });
85657
85669
  });
85658
85670
  };
85671
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
85672
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
85673
+ };
85674
+ CoveoSearchPageClient.prototype.logGeneratedAnswerSourceHover = function (metadata) {
85675
+ return __awaiter(this, void 0, void 0, function () {
85676
+ return __generator(this, function (_a) {
85677
+ switch (_a.label) {
85678
+ case 0: return [4, this.makeGeneratedAnswerSourceHover(metadata)];
85679
+ case 1: return [2, (_a.sent()).log({
85680
+ searchUID: this.provider.getSearchUID(),
85681
+ })];
85682
+ }
85683
+ });
85684
+ });
85685
+ };
85686
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerCopyToClipboard = function (metadata) {
85687
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerCopyToClipboard, metadata);
85688
+ };
85689
+ CoveoSearchPageClient.prototype.logGeneratedAnswerCopyToClipboard = function (metadata) {
85690
+ return __awaiter(this, void 0, void 0, function () {
85691
+ return __generator(this, function (_a) {
85692
+ switch (_a.label) {
85693
+ case 0: return [4, this.makeGeneratedAnswerCopyToClipboard(metadata)];
85694
+ case 1: return [2, (_a.sent()).log({
85695
+ searchUID: this.provider.getSearchUID(),
85696
+ })];
85697
+ }
85698
+ });
85699
+ });
85700
+ };
85701
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerHideAnswers = function (metadata) {
85702
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerHideAnswers, metadata);
85703
+ };
85704
+ CoveoSearchPageClient.prototype.logGeneratedAnswerHideAnswers = function (metadata) {
85705
+ return __awaiter(this, void 0, void 0, function () {
85706
+ return __generator(this, function (_a) {
85707
+ switch (_a.label) {
85708
+ case 0: return [4, this.makeGeneratedAnswerHideAnswers(metadata)];
85709
+ case 1: return [2, (_a.sent()).log({
85710
+ searchUID: this.provider.getSearchUID(),
85711
+ })];
85712
+ }
85713
+ });
85714
+ });
85715
+ };
85716
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerShowAnswers = function (metadata) {
85717
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerShowAnswers, metadata);
85718
+ };
85719
+ CoveoSearchPageClient.prototype.logGeneratedAnswerShowAnswers = function (metadata) {
85720
+ return __awaiter(this, void 0, void 0, function () {
85721
+ return __generator(this, function (_a) {
85722
+ switch (_a.label) {
85723
+ case 0: return [4, this.makeGeneratedAnswerShowAnswers(metadata)];
85724
+ case 1: return [2, (_a.sent()).log({
85725
+ searchUID: this.provider.getSearchUID(),
85726
+ })];
85727
+ }
85728
+ });
85729
+ });
85730
+ };
85731
+ CoveoSearchPageClient.prototype.makeGenerativeQuestionFeedbackSubmit = function (meta) {
85732
+ return this.makeCustomEvent(exports.SearchPageEvents.generativeQuestionFeedbackSubmit, meta);
85733
+ };
85734
+ CoveoSearchPageClient.prototype.logGenerativeQuestionFeedbackSubmit = function (meta) {
85735
+ return __awaiter(this, void 0, void 0, function () {
85736
+ return __generator(this, function (_a) {
85737
+ switch (_a.label) {
85738
+ case 0: return [4, this.makeGenerativeQuestionFeedbackSubmit(meta)];
85739
+ case 1: return [2, (_a.sent()).log({
85740
+ searchUID: this.provider.getSearchUID(),
85741
+ })];
85742
+ }
85743
+ });
85744
+ });
85745
+ };
85746
+ CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
85747
+ return this.makeSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, meta);
85748
+ };
85749
+ CoveoSearchPageClient.prototype.logRephraseGeneratedAnswer = function (meta) {
85750
+ return __awaiter(this, void 0, void 0, function () {
85751
+ return __generator(this, function (_a) {
85752
+ switch (_a.label) {
85753
+ case 0: return [4, this.makeRephraseGeneratedAnswer(meta)];
85754
+ case 1: return [2, (_a.sent()).log({ searchUID: this.provider.getSearchUID() })];
85755
+ }
85756
+ });
85757
+ });
85758
+ };
85659
85759
  CoveoSearchPageClient.prototype.makeRetryGeneratedAnswer = function () {
85660
85760
  return this.makeSearchEvent(exports.SearchPageEvents.retryGeneratedAnswer);
85661
85761
  };
@@ -596,7 +596,7 @@ function sha1(bytes) {
596
596
  const v5 = v35('v5', 0x50, sha1);
597
597
  var uuidv5 = v5;
598
598
 
599
- const libVersion = "2.28.18" ;
599
+ const libVersion = "2.28.19" ;
600
600
 
601
601
  const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
602
602
 
@@ -1770,6 +1770,12 @@ var SearchPageEvents;
1770
1770
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
1771
1771
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
1772
1772
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
1773
+ SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
1774
+ SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
1775
+ SearchPageEvents["generatedAnswerHideAnswers"] = "generatedAnswerHideAnswers";
1776
+ SearchPageEvents["generatedAnswerShowAnswers"] = "generatedAnswerShowAnswers";
1777
+ SearchPageEvents["generativeQuestionFeedbackSubmit"] = "generativeQuestionFeedbackSubmit";
1778
+ SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
1773
1779
  })(SearchPageEvents || (SearchPageEvents = {}));
1774
1780
  const CustomEventsTypes = {
1775
1781
  [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1815,6 +1821,11 @@ const CustomEventsTypes = {
1815
1821
  [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
1816
1822
  [SearchPageEvents.openGeneratedAnswerSource]: 'generatedAnswer',
1817
1823
  [SearchPageEvents.generatedAnswerStreamEnd]: 'generatedAnswer',
1824
+ [SearchPageEvents.generatedAnswerSourceHover]: 'generatedAnswer',
1825
+ [SearchPageEvents.generatedAnswerCopyToClipboard]: 'generatedAnswer',
1826
+ [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
1827
+ [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
1828
+ [SearchPageEvents.generativeQuestionFeedbackSubmit]: 'generatedAnswer',
1818
1829
  };
1819
1830
 
1820
1831
  class NoopAnalytics {
@@ -2587,8 +2598,9 @@ class CoveoSearchPageClient {
2587
2598
  });
2588
2599
  }
2589
2600
  getBaseSearchEventRequest(event, metadata) {
2601
+ var _a, _b;
2590
2602
  return __awaiter(this, void 0, void 0, function* () {
2591
- return Object.assign(Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), this.provider.getSearchEventRequestPayload()), { queryPipeline: this.provider.getPipeline(), actionCause: event });
2603
+ return Object.assign(Object.assign(Object.assign({}, (yield this.getBaseEventRequest(Object.assign(Object.assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a))))), this.provider.getSearchEventRequestPayload()), { queryPipeline: this.provider.getPipeline(), actionCause: event });
2592
2604
  });
2593
2605
  }
2594
2606
  getBaseEventRequest(metadata) {
@@ -2642,6 +2654,64 @@ class CoveoSearchPageClient {
2642
2654
  });
2643
2655
  });
2644
2656
  }
2657
+ makeGeneratedAnswerSourceHover(metadata) {
2658
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
2659
+ }
2660
+ logGeneratedAnswerSourceHover(metadata) {
2661
+ return __awaiter(this, void 0, void 0, function* () {
2662
+ return (yield this.makeGeneratedAnswerSourceHover(metadata)).log({
2663
+ searchUID: this.provider.getSearchUID(),
2664
+ });
2665
+ });
2666
+ }
2667
+ makeGeneratedAnswerCopyToClipboard(metadata) {
2668
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerCopyToClipboard, metadata);
2669
+ }
2670
+ logGeneratedAnswerCopyToClipboard(metadata) {
2671
+ return __awaiter(this, void 0, void 0, function* () {
2672
+ return (yield this.makeGeneratedAnswerCopyToClipboard(metadata)).log({
2673
+ searchUID: this.provider.getSearchUID(),
2674
+ });
2675
+ });
2676
+ }
2677
+ makeGeneratedAnswerHideAnswers(metadata) {
2678
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerHideAnswers, metadata);
2679
+ }
2680
+ logGeneratedAnswerHideAnswers(metadata) {
2681
+ return __awaiter(this, void 0, void 0, function* () {
2682
+ return (yield this.makeGeneratedAnswerHideAnswers(metadata)).log({
2683
+ searchUID: this.provider.getSearchUID(),
2684
+ });
2685
+ });
2686
+ }
2687
+ makeGeneratedAnswerShowAnswers(metadata) {
2688
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerShowAnswers, metadata);
2689
+ }
2690
+ logGeneratedAnswerShowAnswers(metadata) {
2691
+ return __awaiter(this, void 0, void 0, function* () {
2692
+ return (yield this.makeGeneratedAnswerShowAnswers(metadata)).log({
2693
+ searchUID: this.provider.getSearchUID(),
2694
+ });
2695
+ });
2696
+ }
2697
+ makeGenerativeQuestionFeedbackSubmit(meta) {
2698
+ return this.makeCustomEvent(SearchPageEvents.generativeQuestionFeedbackSubmit, meta);
2699
+ }
2700
+ logGenerativeQuestionFeedbackSubmit(meta) {
2701
+ return __awaiter(this, void 0, void 0, function* () {
2702
+ return (yield this.makeGenerativeQuestionFeedbackSubmit(meta)).log({
2703
+ searchUID: this.provider.getSearchUID(),
2704
+ });
2705
+ });
2706
+ }
2707
+ makeRephraseGeneratedAnswer(meta) {
2708
+ return this.makeSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, meta);
2709
+ }
2710
+ logRephraseGeneratedAnswer(meta) {
2711
+ return __awaiter(this, void 0, void 0, function* () {
2712
+ return (yield this.makeRephraseGeneratedAnswer(meta)).log({ searchUID: this.provider.getSearchUID() });
2713
+ });
2714
+ }
2645
2715
  makeRetryGeneratedAnswer() {
2646
2716
  return this.makeSearchEvent(SearchPageEvents.retryGeneratedAnswer);
2647
2717
  }
package/dist/library.js CHANGED
@@ -731,7 +731,7 @@ function sha1(bytes) {
731
731
  const v5 = v35('v5', 0x50, sha1);
732
732
  var uuidv5 = v5;
733
733
 
734
- var libVersion = "2.28.18" ;
734
+ var libVersion = "2.28.19" ;
735
735
 
736
736
  var getFormattedLocation = function (location) {
737
737
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84285,6 +84285,12 @@ exports.SearchPageEvents = void 0;
84285
84285
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
84286
84286
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
84287
84287
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
84288
+ SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
84289
+ SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
84290
+ SearchPageEvents["generatedAnswerHideAnswers"] = "generatedAnswerHideAnswers";
84291
+ SearchPageEvents["generatedAnswerShowAnswers"] = "generatedAnswerShowAnswers";
84292
+ SearchPageEvents["generativeQuestionFeedbackSubmit"] = "generativeQuestionFeedbackSubmit";
84293
+ SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84288
84294
  })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
84289
84295
  var CustomEventsTypes = (_a = {},
84290
84296
  _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84330,6 +84336,11 @@ var CustomEventsTypes = (_a = {},
84330
84336
  _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
84331
84337
  _a[exports.SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
84332
84338
  _a[exports.SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
84339
+ _a[exports.SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
84340
+ _a[exports.SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
84341
+ _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
84342
+ _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
84343
+ _a[exports.SearchPageEvents.generativeQuestionFeedbackSubmit] = 'generatedAnswer',
84333
84344
  _a);
84334
84345
 
84335
84346
  var NoopAnalytics = (function () {
@@ -85568,14 +85579,15 @@ var CoveoSearchPageClient = (function () {
85568
85579
  });
85569
85580
  };
85570
85581
  CoveoSearchPageClient.prototype.getBaseSearchEventRequest = function (event, metadata) {
85582
+ var _a, _b;
85571
85583
  return __awaiter(this, void 0, void 0, function () {
85572
- var _a;
85573
- return __generator(this, function (_b) {
85574
- switch (_b.label) {
85584
+ var _c;
85585
+ return __generator(this, function (_d) {
85586
+ switch (_d.label) {
85575
85587
  case 0:
85576
- _a = [{}];
85577
- return [4, this.getBaseEventRequest(metadata)];
85578
- case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
85588
+ _c = [{}];
85589
+ return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a)))];
85590
+ case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
85579
85591
  }
85580
85592
  });
85581
85593
  });
@@ -85656,6 +85668,94 @@ var CoveoSearchPageClient = (function () {
85656
85668
  });
85657
85669
  });
85658
85670
  };
85671
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
85672
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
85673
+ };
85674
+ CoveoSearchPageClient.prototype.logGeneratedAnswerSourceHover = function (metadata) {
85675
+ return __awaiter(this, void 0, void 0, function () {
85676
+ return __generator(this, function (_a) {
85677
+ switch (_a.label) {
85678
+ case 0: return [4, this.makeGeneratedAnswerSourceHover(metadata)];
85679
+ case 1: return [2, (_a.sent()).log({
85680
+ searchUID: this.provider.getSearchUID(),
85681
+ })];
85682
+ }
85683
+ });
85684
+ });
85685
+ };
85686
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerCopyToClipboard = function (metadata) {
85687
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerCopyToClipboard, metadata);
85688
+ };
85689
+ CoveoSearchPageClient.prototype.logGeneratedAnswerCopyToClipboard = function (metadata) {
85690
+ return __awaiter(this, void 0, void 0, function () {
85691
+ return __generator(this, function (_a) {
85692
+ switch (_a.label) {
85693
+ case 0: return [4, this.makeGeneratedAnswerCopyToClipboard(metadata)];
85694
+ case 1: return [2, (_a.sent()).log({
85695
+ searchUID: this.provider.getSearchUID(),
85696
+ })];
85697
+ }
85698
+ });
85699
+ });
85700
+ };
85701
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerHideAnswers = function (metadata) {
85702
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerHideAnswers, metadata);
85703
+ };
85704
+ CoveoSearchPageClient.prototype.logGeneratedAnswerHideAnswers = function (metadata) {
85705
+ return __awaiter(this, void 0, void 0, function () {
85706
+ return __generator(this, function (_a) {
85707
+ switch (_a.label) {
85708
+ case 0: return [4, this.makeGeneratedAnswerHideAnswers(metadata)];
85709
+ case 1: return [2, (_a.sent()).log({
85710
+ searchUID: this.provider.getSearchUID(),
85711
+ })];
85712
+ }
85713
+ });
85714
+ });
85715
+ };
85716
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerShowAnswers = function (metadata) {
85717
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerShowAnswers, metadata);
85718
+ };
85719
+ CoveoSearchPageClient.prototype.logGeneratedAnswerShowAnswers = function (metadata) {
85720
+ return __awaiter(this, void 0, void 0, function () {
85721
+ return __generator(this, function (_a) {
85722
+ switch (_a.label) {
85723
+ case 0: return [4, this.makeGeneratedAnswerShowAnswers(metadata)];
85724
+ case 1: return [2, (_a.sent()).log({
85725
+ searchUID: this.provider.getSearchUID(),
85726
+ })];
85727
+ }
85728
+ });
85729
+ });
85730
+ };
85731
+ CoveoSearchPageClient.prototype.makeGenerativeQuestionFeedbackSubmit = function (meta) {
85732
+ return this.makeCustomEvent(exports.SearchPageEvents.generativeQuestionFeedbackSubmit, meta);
85733
+ };
85734
+ CoveoSearchPageClient.prototype.logGenerativeQuestionFeedbackSubmit = function (meta) {
85735
+ return __awaiter(this, void 0, void 0, function () {
85736
+ return __generator(this, function (_a) {
85737
+ switch (_a.label) {
85738
+ case 0: return [4, this.makeGenerativeQuestionFeedbackSubmit(meta)];
85739
+ case 1: return [2, (_a.sent()).log({
85740
+ searchUID: this.provider.getSearchUID(),
85741
+ })];
85742
+ }
85743
+ });
85744
+ });
85745
+ };
85746
+ CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
85747
+ return this.makeSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, meta);
85748
+ };
85749
+ CoveoSearchPageClient.prototype.logRephraseGeneratedAnswer = function (meta) {
85750
+ return __awaiter(this, void 0, void 0, function () {
85751
+ return __generator(this, function (_a) {
85752
+ switch (_a.label) {
85753
+ case 0: return [4, this.makeRephraseGeneratedAnswer(meta)];
85754
+ case 1: return [2, (_a.sent()).log({ searchUID: this.provider.getSearchUID() })];
85755
+ }
85756
+ });
85757
+ });
85758
+ };
85659
85759
  CoveoSearchPageClient.prototype.makeRetryGeneratedAnswer = function () {
85660
85760
  return this.makeSearchEvent(exports.SearchPageEvents.retryGeneratedAnswer);
85661
85761
  };
package/dist/library.mjs CHANGED
@@ -729,7 +729,7 @@ function sha1(bytes) {
729
729
  const v5 = v35('v5', 0x50, sha1);
730
730
  var uuidv5 = v5;
731
731
 
732
- var libVersion = "2.28.18" ;
732
+ var libVersion = "2.28.19" ;
733
733
 
734
734
  var getFormattedLocation = function (location) {
735
735
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84283,6 +84283,12 @@ var SearchPageEvents;
84283
84283
  SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
84284
84284
  SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
84285
84285
  SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
84286
+ SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
84287
+ SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
84288
+ SearchPageEvents["generatedAnswerHideAnswers"] = "generatedAnswerHideAnswers";
84289
+ SearchPageEvents["generatedAnswerShowAnswers"] = "generatedAnswerShowAnswers";
84290
+ SearchPageEvents["generativeQuestionFeedbackSubmit"] = "generativeQuestionFeedbackSubmit";
84291
+ SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84286
84292
  })(SearchPageEvents || (SearchPageEvents = {}));
84287
84293
  var CustomEventsTypes = (_a = {},
84288
84294
  _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84328,6 +84334,11 @@ var CustomEventsTypes = (_a = {},
84328
84334
  _a[SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
84329
84335
  _a[SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
84330
84336
  _a[SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
84337
+ _a[SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
84338
+ _a[SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
84339
+ _a[SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
84340
+ _a[SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
84341
+ _a[SearchPageEvents.generativeQuestionFeedbackSubmit] = 'generatedAnswer',
84331
84342
  _a);
84332
84343
 
84333
84344
  var NoopAnalytics = (function () {
@@ -85566,14 +85577,15 @@ var CoveoSearchPageClient = (function () {
85566
85577
  });
85567
85578
  };
85568
85579
  CoveoSearchPageClient.prototype.getBaseSearchEventRequest = function (event, metadata) {
85580
+ var _a, _b;
85569
85581
  return __awaiter(this, void 0, void 0, function () {
85570
- var _a;
85571
- return __generator(this, function (_b) {
85572
- switch (_b.label) {
85582
+ var _c;
85583
+ return __generator(this, function (_d) {
85584
+ switch (_d.label) {
85573
85585
  case 0:
85574
- _a = [{}];
85575
- return [4, this.getBaseEventRequest(metadata)];
85576
- case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
85586
+ _c = [{}];
85587
+ return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a)))];
85588
+ case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
85577
85589
  }
85578
85590
  });
85579
85591
  });
@@ -85654,6 +85666,94 @@ var CoveoSearchPageClient = (function () {
85654
85666
  });
85655
85667
  });
85656
85668
  };
85669
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
85670
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerSourceHover, metadata);
85671
+ };
85672
+ CoveoSearchPageClient.prototype.logGeneratedAnswerSourceHover = function (metadata) {
85673
+ return __awaiter(this, void 0, void 0, function () {
85674
+ return __generator(this, function (_a) {
85675
+ switch (_a.label) {
85676
+ case 0: return [4, this.makeGeneratedAnswerSourceHover(metadata)];
85677
+ case 1: return [2, (_a.sent()).log({
85678
+ searchUID: this.provider.getSearchUID(),
85679
+ })];
85680
+ }
85681
+ });
85682
+ });
85683
+ };
85684
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerCopyToClipboard = function (metadata) {
85685
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerCopyToClipboard, metadata);
85686
+ };
85687
+ CoveoSearchPageClient.prototype.logGeneratedAnswerCopyToClipboard = function (metadata) {
85688
+ return __awaiter(this, void 0, void 0, function () {
85689
+ return __generator(this, function (_a) {
85690
+ switch (_a.label) {
85691
+ case 0: return [4, this.makeGeneratedAnswerCopyToClipboard(metadata)];
85692
+ case 1: return [2, (_a.sent()).log({
85693
+ searchUID: this.provider.getSearchUID(),
85694
+ })];
85695
+ }
85696
+ });
85697
+ });
85698
+ };
85699
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerHideAnswers = function (metadata) {
85700
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerHideAnswers, metadata);
85701
+ };
85702
+ CoveoSearchPageClient.prototype.logGeneratedAnswerHideAnswers = function (metadata) {
85703
+ return __awaiter(this, void 0, void 0, function () {
85704
+ return __generator(this, function (_a) {
85705
+ switch (_a.label) {
85706
+ case 0: return [4, this.makeGeneratedAnswerHideAnswers(metadata)];
85707
+ case 1: return [2, (_a.sent()).log({
85708
+ searchUID: this.provider.getSearchUID(),
85709
+ })];
85710
+ }
85711
+ });
85712
+ });
85713
+ };
85714
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerShowAnswers = function (metadata) {
85715
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerShowAnswers, metadata);
85716
+ };
85717
+ CoveoSearchPageClient.prototype.logGeneratedAnswerShowAnswers = function (metadata) {
85718
+ return __awaiter(this, void 0, void 0, function () {
85719
+ return __generator(this, function (_a) {
85720
+ switch (_a.label) {
85721
+ case 0: return [4, this.makeGeneratedAnswerShowAnswers(metadata)];
85722
+ case 1: return [2, (_a.sent()).log({
85723
+ searchUID: this.provider.getSearchUID(),
85724
+ })];
85725
+ }
85726
+ });
85727
+ });
85728
+ };
85729
+ CoveoSearchPageClient.prototype.makeGenerativeQuestionFeedbackSubmit = function (meta) {
85730
+ return this.makeCustomEvent(SearchPageEvents.generativeQuestionFeedbackSubmit, meta);
85731
+ };
85732
+ CoveoSearchPageClient.prototype.logGenerativeQuestionFeedbackSubmit = function (meta) {
85733
+ return __awaiter(this, void 0, void 0, function () {
85734
+ return __generator(this, function (_a) {
85735
+ switch (_a.label) {
85736
+ case 0: return [4, this.makeGenerativeQuestionFeedbackSubmit(meta)];
85737
+ case 1: return [2, (_a.sent()).log({
85738
+ searchUID: this.provider.getSearchUID(),
85739
+ })];
85740
+ }
85741
+ });
85742
+ });
85743
+ };
85744
+ CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
85745
+ return this.makeSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, meta);
85746
+ };
85747
+ CoveoSearchPageClient.prototype.logRephraseGeneratedAnswer = function (meta) {
85748
+ return __awaiter(this, void 0, void 0, function () {
85749
+ return __generator(this, function (_a) {
85750
+ switch (_a.label) {
85751
+ case 0: return [4, this.makeRephraseGeneratedAnswer(meta)];
85752
+ case 1: return [2, (_a.sent()).log({ searchUID: this.provider.getSearchUID() })];
85753
+ }
85754
+ });
85755
+ });
85756
+ };
85657
85757
  CoveoSearchPageClient.prototype.makeRetryGeneratedAnswer = function () {
85658
85758
  return this.makeSearchEvent(SearchPageEvents.retryGeneratedAnswer);
85659
85759
  };