coveo.analytics 2.23.6 → 2.23.7

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,4 +1,4 @@
1
- import { AnyEventResponse, ClickEventRequest, ClickEventResponse, CustomEventRequest, CustomEventResponse, EventType, HealthResponse, SearchEventRequest, SearchEventResponse, ViewEventRequest, ViewEventResponse, VisitResponse, VariableArgumentsPayload } from '../events';
1
+ import { AnyEventResponse, ClickEventRequest, ClickEventResponse, CustomEventRequest, CustomEventResponse, EventType, HealthResponse, SearchEventRequest, SearchEventResponse, ViewEventRequest, ViewEventResponse, VisitResponse, VariableArgumentsPayload, PreparedClickEventRequest, PreparedCustomEventRequest, PreparedViewEventRequest, PreparedSearchEventRequest } from '../events';
2
2
  import { PreprocessAnalyticsRequest, VisitorIdProvider } from './analyticsRequestClient';
3
3
  import { IRuntimeEnvironment } from './runtimeEnvironment';
4
4
  export declare const Version = "v15";
@@ -24,13 +24,21 @@ export declare type EventTypeConfig = {
24
24
  addClientIdParameter?: boolean;
25
25
  usesMeasurementProtocol?: boolean;
26
26
  };
27
+ export interface PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse> extends BufferedRequest {
28
+ log(remainingPayload: Omit<TCompleteRequest, keyof TPreparedRequest>): Promise<TResponse | void>;
29
+ }
27
30
  export interface AnalyticsClient {
28
31
  getPayload(eventType: string, ...payload: VariableArgumentsPayload): Promise<any>;
29
32
  getParameters(eventType: string, ...payload: VariableArgumentsPayload): Promise<any>;
33
+ makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(eventType: string, ...payload: VariableArgumentsPayload): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
30
34
  sendEvent(eventType: string, ...payload: VariableArgumentsPayload): Promise<AnyEventResponse | void>;
35
+ makeSearchEvent(request: PreparedSearchEventRequest): Promise<PreparedEvent<PreparedSearchEventRequest, SearchEventRequest, SearchEventResponse>>;
31
36
  sendSearchEvent(request: SearchEventRequest): Promise<SearchEventResponse | void>;
37
+ makeClickEvent(request: PreparedClickEventRequest): Promise<PreparedEvent<PreparedClickEventRequest, ClickEventRequest, ClickEventResponse>>;
32
38
  sendClickEvent(request: ClickEventRequest): Promise<ClickEventResponse | void>;
39
+ makeCustomEvent(request: PreparedCustomEventRequest): Promise<PreparedEvent<PreparedCustomEventRequest, CustomEventRequest, CustomEventResponse>>;
33
40
  sendCustomEvent(request: CustomEventRequest): Promise<CustomEventResponse | void>;
41
+ makeViewEvent(request: PreparedViewEventRequest): Promise<PreparedEvent<PreparedViewEventRequest, ViewEventRequest, ViewEventResponse>>;
34
42
  sendViewEvent(request: ViewEventRequest): Promise<ViewEventResponse | void>;
35
43
  getVisit(): Promise<VisitResponse>;
36
44
  getHealth(): Promise<HealthResponse>;
@@ -67,14 +75,19 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
67
75
  set currentVisitorId(visitorId: string);
68
76
  resolveParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<VariableArgumentsPayload>;
69
77
  resolvePayloadForParameters(eventType: EventType | string, parameters: any): Promise<any>;
70
- sendEvent(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<AnyEventResponse | void>;
78
+ makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
79
+ sendEvent(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<void | SearchEventResponse | ClickEventResponse | CustomEventResponse | ViewEventResponse>;
71
80
  private deferExecution;
72
81
  private sendFromBufferWithFetch;
73
82
  clear(): void;
74
83
  deleteHttpOnlyVisitorId(): void;
75
- sendSearchEvent(request: SearchEventRequest): Promise<SearchEventResponse | void>;
76
- sendClickEvent(request: ClickEventRequest): Promise<ClickEventResponse | void>;
77
- sendCustomEvent(request: CustomEventRequest): Promise<CustomEventResponse | void>;
84
+ makeSearchEvent(request: PreparedSearchEventRequest): Promise<PreparedEvent<PreparedSearchEventRequest, SearchEventRequest, SearchEventResponse>>;
85
+ sendSearchEvent({ searchQueryUid, ...preparedRequest }: SearchEventRequest): Promise<void | SearchEventResponse>;
86
+ makeClickEvent(request: PreparedClickEventRequest): Promise<PreparedEvent<PreparedClickEventRequest, ClickEventRequest, ClickEventResponse>>;
87
+ sendClickEvent({ searchQueryUid, ...preparedRequest }: ClickEventRequest): Promise<void | ClickEventResponse>;
88
+ makeCustomEvent(request: PreparedCustomEventRequest): Promise<PreparedEvent<PreparedCustomEventRequest, CustomEventRequest, CustomEventResponse>>;
89
+ sendCustomEvent({ lastSearchQueryUid, ...preparedRequest }: CustomEventRequest): Promise<void | CustomEventResponse>;
90
+ makeViewEvent(request: PreparedViewEventRequest): Promise<PreparedEvent<PreparedViewEventRequest, ViewEventRequest, ViewEventResponse>>;
78
91
  sendViewEvent(request: ViewEventRequest): Promise<ViewEventResponse | void>;
79
92
  getVisit(): Promise<VisitResponse>;
80
93
  getHealth(): Promise<HealthResponse>;
@@ -1,13 +1,18 @@
1
- import { AnalyticsClient } from './analytics';
2
- import { AnyEventResponse, SearchEventResponse, ClickEventResponse, CustomEventResponse, VisitResponse, HealthResponse, ViewEventResponse } from '../events';
1
+ import { AnalyticsClient, PreparedEvent } from './analytics';
2
+ import { AnyEventResponse, SearchEventResponse, ClickEventResponse, CustomEventResponse, VisitResponse, HealthResponse, ViewEventResponse, EventType, PreparedSearchEventRequest, SearchEventRequest, ClickEventRequest, CustomEventRequest, PreparedClickEventRequest, PreparedCustomEventRequest, PreparedViewEventRequest, ViewEventRequest } from '../events';
3
3
  import { NoopRuntime } from './runtimeEnvironment';
4
4
  export declare class NoopAnalytics implements AnalyticsClient {
5
5
  getPayload(): Promise<any>;
6
6
  getParameters(): Promise<any>;
7
+ makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(eventType: EventType | string): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
7
8
  sendEvent(): Promise<AnyEventResponse | void>;
9
+ makeSearchEvent(): Promise<PreparedEvent<PreparedSearchEventRequest, SearchEventRequest, SearchEventResponse>>;
8
10
  sendSearchEvent(): Promise<SearchEventResponse | void>;
11
+ makeClickEvent(): Promise<PreparedEvent<PreparedClickEventRequest, ClickEventRequest, ClickEventResponse>>;
9
12
  sendClickEvent(): Promise<ClickEventResponse | void>;
13
+ makeCustomEvent(): Promise<PreparedEvent<PreparedCustomEventRequest, CustomEventRequest, CustomEventResponse>>;
10
14
  sendCustomEvent(): Promise<CustomEventResponse | void>;
15
+ makeViewEvent(): Promise<PreparedEvent<PreparedViewEventRequest, ViewEventRequest, ViewEventResponse>>;
11
16
  sendViewEvent(): Promise<ViewEventResponse | void>;
12
17
  getVisit(): Promise<VisitResponse>;
13
18
  getHealth(): Promise<HealthResponse>;
@@ -54,6 +54,8 @@ export interface SearchEventRequest extends EventBaseRequest {
54
54
  userGroups?: string[];
55
55
  facetState?: FacetStateRequest[];
56
56
  }
57
+ export interface PreparedSearchEventRequest extends Omit<SearchEventRequest, 'searchQueryUid'> {
58
+ }
57
59
  export interface DocumentInformation {
58
60
  documentUri: string;
59
61
  documentUriHash: string;
@@ -70,11 +72,15 @@ export interface DocumentInformation {
70
72
  }
71
73
  export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {
72
74
  }
75
+ export interface PreparedClickEventRequest extends Omit<ClickEventRequest, 'searchQueryUid'> {
76
+ }
73
77
  export interface CustomEventRequest extends EventBaseRequest {
74
78
  eventType: string;
75
79
  eventValue: string;
76
80
  lastSearchQueryUid?: string;
77
81
  }
82
+ export interface PreparedCustomEventRequest extends Omit<CustomEventRequest, 'lastSearchQueryUid'> {
83
+ }
78
84
  export interface ViewEventRequest extends EventBaseRequest {
79
85
  location?: string;
80
86
  referrer?: string;
@@ -83,6 +89,8 @@ export interface ViewEventRequest extends EventBaseRequest {
83
89
  contentIdValue: string;
84
90
  contentType?: string;
85
91
  }
92
+ export interface PreparedViewEventRequest extends ViewEventRequest {
93
+ }
86
94
  export interface DefaultEventResponse {
87
95
  visitId: string;
88
96
  visitorId: string;
@@ -22,7 +22,9 @@ export interface SearchPageClientOptions extends ClientOptions {
22
22
  export declare type EventDescription = Pick<SearchEventRequest, 'actionCause' | 'customData'>;
23
23
  export interface EventBuilder<T extends AnyEventResponse = AnyEventResponse> {
24
24
  description: EventDescription;
25
- log: () => Promise<T | void>;
25
+ log(metadata: {
26
+ searchUID: string;
27
+ }): Promise<T | void>;
26
28
  }
27
29
  export declare class CoveoSearchPageClient {
28
30
  private opts;
@@ -31,158 +33,154 @@ export declare class CoveoSearchPageClient {
31
33
  constructor(opts: Partial<SearchPageClientOptions>, provider: SearchPageClientProvider);
32
34
  disable(): void;
33
35
  enable(): void;
34
- makeInterfaceLoad(): EventBuilder<SearchEventResponse>;
36
+ makeInterfaceLoad(): Promise<EventBuilder<SearchEventResponse>>;
35
37
  logInterfaceLoad(): Promise<void | SearchEventResponse>;
36
- makeRecommendationInterfaceLoad(): EventBuilder<SearchEventResponse>;
38
+ makeRecommendationInterfaceLoad(): Promise<EventBuilder<SearchEventResponse>>;
37
39
  logRecommendationInterfaceLoad(): Promise<void | SearchEventResponse>;
38
- makeRecommendation(): EventBuilder<CustomEventResponse>;
40
+ makeRecommendation(): Promise<EventBuilder<CustomEventResponse>>;
39
41
  logRecommendation(): Promise<void | CustomEventResponse>;
40
- makeRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
42
+ makeRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
41
43
  logRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
42
- makeStaticFilterClearAll(meta: StaticFilterMetadata): EventBuilder<SearchEventResponse>;
44
+ makeStaticFilterClearAll(meta: StaticFilterMetadata): Promise<EventBuilder<SearchEventResponse>>;
43
45
  logStaticFilterClearAll(meta: StaticFilterMetadata): Promise<void | SearchEventResponse>;
44
- makeStaticFilterSelect(meta: StaticFilterToggleValueMetadata): EventBuilder<SearchEventResponse>;
46
+ makeStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<EventBuilder<SearchEventResponse>>;
45
47
  logStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
46
- makeStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): EventBuilder<SearchEventResponse>;
48
+ makeStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<EventBuilder<SearchEventResponse>>;
47
49
  logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
48
- makeFetchMoreResults(): EventBuilder<CustomEventResponse>;
50
+ makeFetchMoreResults(): Promise<EventBuilder<CustomEventResponse>>;
49
51
  logFetchMoreResults(): Promise<void | CustomEventResponse>;
50
- makeInterfaceChange(metadata: InterfaceChangeMetadata): EventBuilder<SearchEventResponse>;
52
+ makeInterfaceChange(metadata: InterfaceChangeMetadata): Promise<EventBuilder<SearchEventResponse>>;
51
53
  logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | SearchEventResponse>;
52
- makeDidYouMeanAutomatic(): EventBuilder<SearchEventResponse>;
54
+ makeDidYouMeanAutomatic(): Promise<EventBuilder<SearchEventResponse>>;
53
55
  logDidYouMeanAutomatic(): Promise<void | SearchEventResponse>;
54
- makeDidYouMeanClick(): EventBuilder<SearchEventResponse>;
56
+ makeDidYouMeanClick(): Promise<EventBuilder<SearchEventResponse>>;
55
57
  logDidYouMeanClick(): Promise<void | SearchEventResponse>;
56
- makeResultsSort(metadata: ResultsSortMetadata): EventBuilder<SearchEventResponse>;
58
+ makeResultsSort(metadata: ResultsSortMetadata): Promise<EventBuilder<SearchEventResponse>>;
57
59
  logResultsSort(metadata: ResultsSortMetadata): Promise<void | SearchEventResponse>;
58
- makeSearchboxSubmit(): EventBuilder<SearchEventResponse>;
60
+ makeSearchboxSubmit(): Promise<EventBuilder<SearchEventResponse>>;
59
61
  logSearchboxSubmit(): Promise<void | SearchEventResponse>;
60
- makeSearchboxClear(): EventBuilder<SearchEventResponse>;
62
+ makeSearchboxClear(): Promise<EventBuilder<SearchEventResponse>>;
61
63
  logSearchboxClear(): Promise<void | SearchEventResponse>;
62
- makeSearchboxAsYouType(): EventBuilder<SearchEventResponse>;
64
+ makeSearchboxAsYouType(): Promise<EventBuilder<SearchEventResponse>>;
63
65
  logSearchboxAsYouType(): Promise<void | SearchEventResponse>;
64
- makeBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): EventBuilder<SearchEventResponse>;
66
+ makeBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
65
67
  logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<void | SearchEventResponse>;
66
- makeBreadcrumbResetAll(): EventBuilder<SearchEventResponse>;
68
+ makeBreadcrumbResetAll(): Promise<EventBuilder<SearchEventResponse>>;
67
69
  logBreadcrumbResetAll(): Promise<void | SearchEventResponse>;
68
- makeDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
70
+ makeDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
69
71
  logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
70
- makeDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
72
+ makeDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
71
73
  logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
72
- makeOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): EventBuilder<SearchEventResponse>;
74
+ makeOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<EventBuilder<SearchEventResponse>>;
73
75
  logOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
74
- makeOmniboxFromLink(meta: OmniboxSuggestionsMetadata): EventBuilder<SearchEventResponse>;
76
+ makeOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<EventBuilder<SearchEventResponse>>;
75
77
  logOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
76
- makeSearchFromLink(): EventBuilder<SearchEventResponse>;
78
+ makeSearchFromLink(): Promise<EventBuilder<SearchEventResponse>>;
77
79
  logSearchFromLink(): Promise<void | SearchEventResponse>;
78
- makeTriggerNotify(meta: TriggerNotifyMetadata): EventBuilder<CustomEventResponse>;
80
+ makeTriggerNotify(meta: TriggerNotifyMetadata): Promise<EventBuilder<CustomEventResponse>>;
79
81
  logTriggerNotify(meta: TriggerNotifyMetadata): Promise<void | CustomEventResponse>;
80
- makeTriggerExecute(meta: TriggerExecuteMetadata): EventBuilder<CustomEventResponse>;
82
+ makeTriggerExecute(meta: TriggerExecuteMetadata): Promise<EventBuilder<CustomEventResponse>>;
81
83
  logTriggerExecute(meta: TriggerExecuteMetadata): Promise<void | CustomEventResponse>;
82
- makeTriggerQuery(): EventBuilder<CustomEventResponse>;
84
+ makeTriggerQuery(): Promise<EventBuilder<CustomEventResponse>>;
83
85
  logTriggerQuery(): Promise<void | CustomEventResponse>;
84
- makeUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): EventBuilder<SearchEventResponse>;
86
+ makeUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<EventBuilder<SearchEventResponse>>;
85
87
  logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<void | SearchEventResponse>;
86
- makeTriggerRedirect(meta: TriggerRedirectMetadata): EventBuilder<CustomEventResponse>;
88
+ makeTriggerRedirect(meta: TriggerRedirectMetadata): Promise<EventBuilder<CustomEventResponse>>;
87
89
  logTriggerRedirect(meta: TriggerRedirectMetadata): Promise<void | CustomEventResponse>;
88
- makePagerResize(meta: PagerResizeMetadata): EventBuilder<CustomEventResponse>;
90
+ makePagerResize(meta: PagerResizeMetadata): Promise<EventBuilder<CustomEventResponse>>;
89
91
  logPagerResize(meta: PagerResizeMetadata): Promise<void | CustomEventResponse>;
90
- makePagerNumber(meta: PagerMetadata): EventBuilder<CustomEventResponse>;
92
+ makePagerNumber(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
91
93
  logPagerNumber(meta: PagerMetadata): Promise<void | CustomEventResponse>;
92
- makePagerNext(meta: PagerMetadata): EventBuilder<CustomEventResponse>;
94
+ makePagerNext(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
93
95
  logPagerNext(meta: PagerMetadata): Promise<void | CustomEventResponse>;
94
- makePagerPrevious(meta: PagerMetadata): EventBuilder<CustomEventResponse>;
96
+ makePagerPrevious(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
95
97
  logPagerPrevious(meta: PagerMetadata): Promise<void | CustomEventResponse>;
96
- makePagerScrolling(): EventBuilder<CustomEventResponse>;
98
+ makePagerScrolling(): Promise<EventBuilder<CustomEventResponse>>;
97
99
  logPagerScrolling(): Promise<void | CustomEventResponse>;
98
- makeFacetClearAll(meta: FacetBaseMeta): EventBuilder<SearchEventResponse>;
100
+ makeFacetClearAll(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
99
101
  logFacetClearAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
100
- makeFacetSearch(meta: FacetBaseMeta): EventBuilder<SearchEventResponse>;
102
+ makeFacetSearch(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
101
103
  logFacetSearch(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
102
- makeFacetSelect(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
104
+ makeFacetSelect(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
103
105
  logFacetSelect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
104
- makeFacetDeselect(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
106
+ makeFacetDeselect(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
105
107
  logFacetDeselect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
106
- makeFacetExclude(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
108
+ makeFacetExclude(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
107
109
  logFacetExclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
108
- makeFacetUnexclude(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
110
+ makeFacetUnexclude(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
109
111
  logFacetUnexclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
110
- makeFacetSelectAll(meta: FacetBaseMeta): EventBuilder<SearchEventResponse>;
112
+ makeFacetSelectAll(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
111
113
  logFacetSelectAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
112
- makeFacetUpdateSort(meta: FacetSortMeta): EventBuilder<SearchEventResponse>;
114
+ makeFacetUpdateSort(meta: FacetSortMeta): Promise<EventBuilder<SearchEventResponse>>;
113
115
  logFacetUpdateSort(meta: FacetSortMeta): Promise<void | SearchEventResponse>;
114
- makeFacetShowMore(meta: FacetBaseMeta): EventBuilder<CustomEventResponse>;
116
+ makeFacetShowMore(meta: FacetBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
115
117
  logFacetShowMore(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
116
- makeFacetShowLess(meta: FacetBaseMeta): EventBuilder<CustomEventResponse>;
118
+ makeFacetShowLess(meta: FacetBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
117
119
  logFacetShowLess(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
118
- makeQueryError(meta: QueryErrorMeta): EventBuilder<CustomEventResponse>;
120
+ makeQueryError(meta: QueryErrorMeta): Promise<EventBuilder<CustomEventResponse>>;
119
121
  logQueryError(meta: QueryErrorMeta): Promise<void | CustomEventResponse>;
120
- makeQueryErrorBack(): EventBuilder<SearchEventResponse>;
122
+ makeQueryErrorBack(): Promise<EventBuilder<SearchEventResponse>>;
121
123
  logQueryErrorBack(): Promise<void | SearchEventResponse>;
122
- makeQueryErrorRetry(): EventBuilder<SearchEventResponse>;
124
+ makeQueryErrorRetry(): Promise<EventBuilder<SearchEventResponse>>;
123
125
  logQueryErrorRetry(): Promise<void | SearchEventResponse>;
124
- makeQueryErrorClear(): EventBuilder<SearchEventResponse>;
126
+ makeQueryErrorClear(): Promise<EventBuilder<SearchEventResponse>>;
125
127
  logQueryErrorClear(): Promise<void | SearchEventResponse>;
126
- makeLikeSmartSnippet(): EventBuilder<CustomEventResponse>;
128
+ makeLikeSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
127
129
  logLikeSmartSnippet(): Promise<void | CustomEventResponse>;
128
- makeDislikeSmartSnippet(): EventBuilder<CustomEventResponse>;
130
+ makeDislikeSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
129
131
  logDislikeSmartSnippet(): Promise<void | CustomEventResponse>;
130
- makeExpandSmartSnippet(): EventBuilder<CustomEventResponse>;
132
+ makeExpandSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
131
133
  logExpandSmartSnippet(): Promise<void | CustomEventResponse>;
132
- makeCollapseSmartSnippet(): EventBuilder<CustomEventResponse>;
134
+ makeCollapseSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
133
135
  logCollapseSmartSnippet(): Promise<void | CustomEventResponse>;
134
- makeOpenSmartSnippetFeedbackModal(): EventBuilder<CustomEventResponse>;
136
+ makeOpenSmartSnippetFeedbackModal(): Promise<EventBuilder<CustomEventResponse>>;
135
137
  logOpenSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
136
- makeCloseSmartSnippetFeedbackModal(): EventBuilder<CustomEventResponse>;
138
+ makeCloseSmartSnippetFeedbackModal(): Promise<EventBuilder<CustomEventResponse>>;
137
139
  logCloseSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
138
- makeSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): EventBuilder<CustomEventResponse>;
140
+ makeSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<EventBuilder<CustomEventResponse>>;
139
141
  logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<void | CustomEventResponse>;
140
- makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): EventBuilder<CustomEventResponse>;
142
+ makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
141
143
  logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
142
- makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): EventBuilder<CustomEventResponse>;
144
+ makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
143
145
  logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
144
146
  private makeShowMoreSmartSnippetSuggestion;
145
147
  logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
146
148
  private makeShowLessSmartSnippetSuggestion;
147
149
  logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
148
- makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
150
+ makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
149
151
  logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
150
- makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): EventBuilder<ClickEventResponse>;
151
- makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
152
+ makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<EventBuilder<ClickEventResponse>>;
153
+ makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
152
154
  logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
153
155
  logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | ClickEventResponse>;
154
- makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): EventBuilder<ClickEventResponse>;
156
+ makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<EventBuilder<ClickEventResponse>>;
155
157
  logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
156
- makeOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): EventBuilder<ClickEventResponse>;
158
+ makeOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<EventBuilder<ClickEventResponse>>;
157
159
  logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
158
- makeRecentQueryClick(): EventBuilder<SearchEventResponse>;
160
+ makeRecentQueryClick(): Promise<EventBuilder<SearchEventResponse>>;
159
161
  logRecentQueryClick(): Promise<void | SearchEventResponse>;
160
- makeClearRecentQueries(): EventBuilder<CustomEventResponse>;
162
+ makeClearRecentQueries(): Promise<EventBuilder<CustomEventResponse>>;
161
163
  logClearRecentQueries(): Promise<void | CustomEventResponse>;
162
- makeRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<CustomEventResponse>;
164
+ makeRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
163
165
  logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | CustomEventResponse>;
164
- makeClearRecentResults(): EventBuilder<CustomEventResponse>;
166
+ makeClearRecentResults(): Promise<EventBuilder<CustomEventResponse>>;
165
167
  logClearRecentResults(): Promise<void | CustomEventResponse>;
166
- makeNoResultsBack(): EventBuilder<SearchEventResponse>;
168
+ makeNoResultsBack(): Promise<EventBuilder<SearchEventResponse>>;
167
169
  logNoResultsBack(): Promise<void | SearchEventResponse>;
168
- makeShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
170
+ makeShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
169
171
  logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
170
- makeShowLessFoldedResults(): EventBuilder<CustomEventResponse>;
172
+ makeShowLessFoldedResults(): Promise<EventBuilder<CustomEventResponse>>;
171
173
  logShowLessFoldedResults(): Promise<void | CustomEventResponse>;
172
- makeCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): EventBuilder<CustomEventResponse>;
174
+ private makeEventDescription;
175
+ makeCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<EventBuilder<CustomEventResponse>>;
173
176
  logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<void | CustomEventResponse>;
174
- makeCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): {
175
- description: Pick<SearchEventRequest, "actionCause" | "customData">;
176
- log: () => Promise<void | CustomEventResponse>;
177
- };
177
+ makeCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<EventBuilder<CustomEventResponse>>;
178
178
  logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | CustomEventResponse>;
179
179
  logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | SearchEventResponse>;
180
- private makeDescription;
181
- makeSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): EventBuilder<SearchEventResponse>;
180
+ makeSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<EventBuilder<SearchEventResponse>>;
181
+ makeClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<EventBuilder<ClickEventResponse>>;
182
182
  logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | ClickEventResponse>;
183
- makeClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): EventBuilder<ClickEventResponse>;
184
183
  private getBaseSearchEventRequest;
185
- private getBaseCustomEventRequest;
186
184
  private getBaseEventRequest;
187
185
  private getOrigins;
188
186
  private getClientId;