coveo.analytics 2.20.24 → 2.20.26
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.
- package/dist/coveoua.browser.js +1 -1
- package/dist/coveoua.browser.js.map +1 -1
- package/dist/coveoua.js +1 -1
- package/dist/coveoua.js.map +1 -1
- package/dist/definitions/coveoua/library.d.ts +1 -1
- package/dist/definitions/insight/insightClient.d.ts +24 -24
- package/dist/definitions/insight/insightEvents.d.ts +25 -7
- package/dist/definitions/searchPage/searchPageClient.d.ts +154 -73
- package/dist/definitions/src/coveoua/library.d.ts +1 -1
- package/dist/library.es.js +432 -150
- package/dist/library.js +477 -186
- package/package.json +1 -1
- package/src/coveoua/library.ts +6 -1
- package/src/insight/insightClient.spec.ts +495 -151
- package/src/insight/insightClient.ts +131 -91
- package/src/insight/insightEvents.ts +37 -6
- package/src/searchPage/searchPageClient.spec.ts +650 -5
- package/src/searchPage/searchPageClient.ts +460 -97
|
@@ -7,7 +7,7 @@ export { CoveoAnalyticsClient, AnalyticsClientSendEventHook } from '../client/an
|
|
|
7
7
|
export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
|
|
8
8
|
export { IRuntimeEnvironment } from '../client/runtimeEnvironment';
|
|
9
9
|
export { CoveoUA, getCurrentClient, handleOneAnalyticsEvent } from './simpleanalytics';
|
|
10
|
-
export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
|
|
10
|
+
export { CoveoSearchPageClient, SearchPageClientProvider, EventDescription, EventBuilder, } from '../searchPage/searchPageClient';
|
|
11
11
|
export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
|
|
12
12
|
export { CoveoInsightClient, InsightClientProvider } from '../insight/insightClient';
|
|
13
13
|
export { analytics, donottrack, history, SimpleAnalytics, storage };
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AnalyticsClient, ClientOptions } from '../client/analytics';
|
|
2
2
|
import { SearchEventRequest } from '../events';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
3
|
+
import { FacetStateMetadata, SearchPageEvents } from '../searchPage/searchPageEvents';
|
|
4
|
+
import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata } from './insightEvents';
|
|
5
5
|
export interface InsightClientProvider {
|
|
6
6
|
getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
|
|
7
7
|
getSearchUID: () => string;
|
|
@@ -25,30 +25,30 @@ export declare class CoveoInsightClient {
|
|
|
25
25
|
constructor(opts: Partial<InsightClientOptions>, provider: InsightClientProvider);
|
|
26
26
|
disable(): void;
|
|
27
27
|
enable(): void;
|
|
28
|
-
logInterfaceLoad(): Promise<void | import("../events").SearchEventResponse>;
|
|
29
|
-
logInterfaceChange(metadata:
|
|
30
|
-
logStaticFilterDeselect(
|
|
31
|
-
logFetchMoreResults(): Promise<void | import("../events").CustomEventResponse>;
|
|
32
|
-
logBreadcrumbFacet(metadata:
|
|
33
|
-
logBreadcrumbResetAll(): Promise<void | import("../events").SearchEventResponse>;
|
|
34
|
-
logFacetSelect(
|
|
35
|
-
logFacetDeselect(
|
|
36
|
-
logFacetUpdateSort(
|
|
37
|
-
logFacetClearAll(
|
|
38
|
-
logFacetShowMore(
|
|
39
|
-
logFacetShowLess(
|
|
40
|
-
logQueryError(
|
|
28
|
+
logInterfaceLoad(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
29
|
+
logInterfaceChange(metadata: InsightInterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
30
|
+
logStaticFilterDeselect(metadata: InsightStaticFilterToggleValueMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
31
|
+
logFetchMoreResults(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
32
|
+
logBreadcrumbFacet(metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
33
|
+
logBreadcrumbResetAll(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
34
|
+
logFacetSelect(metadata: InsightFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
35
|
+
logFacetDeselect(metadata: InsightFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
36
|
+
logFacetUpdateSort(metadata: InsightFacetSortMeta): Promise<void | import("../events").SearchEventResponse>;
|
|
37
|
+
logFacetClearAll(metadata: InsightFacetBaseMeta): Promise<void | import("../events").SearchEventResponse>;
|
|
38
|
+
logFacetShowMore(metadata: InsightFacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
|
|
39
|
+
logFacetShowLess(metadata: InsightFacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
|
|
40
|
+
logQueryError(metadata: InsightQueryErrorMeta): Promise<void | import("../events").CustomEventResponse>;
|
|
41
|
+
logPagerNumber(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
42
|
+
logPagerNext(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
43
|
+
logPagerPrevious(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
44
|
+
logDidYouMeanAutomatic(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
45
|
+
logDidYouMeanClick(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
46
|
+
logResultsSort(metadata: InsightResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
47
|
+
logSearchboxSubmit(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
48
|
+
logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
49
|
+
logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
41
50
|
logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
|
|
42
51
|
logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
|
|
43
|
-
logPagerNumber(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
44
|
-
logPagerNext(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
45
|
-
logPagerPrevious(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
46
|
-
logDidYouMeanAutomatic(): Promise<void | import("../events").SearchEventResponse>;
|
|
47
|
-
logDidYouMeanClick(): Promise<void | import("../events").SearchEventResponse>;
|
|
48
|
-
logResultsSort(metadata: ResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
49
|
-
logSearchboxSubmit(): Promise<void | import("../events").SearchEventResponse>;
|
|
50
|
-
logContextChanged(meta: ContextChangedMetadata): Promise<void | import("../events").SearchEventResponse>;
|
|
51
|
-
logExpandToFullUI(meta: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
|
|
52
52
|
private getBaseCustomEventRequest;
|
|
53
53
|
private getBaseSearchEventRequest;
|
|
54
54
|
private getBaseEventRequest;
|
|
@@ -1,16 +1,34 @@
|
|
|
1
|
+
import { CategoryFacetMetadata, FacetBaseMeta, FacetMetadata, FacetRangeMetadata, FacetSortMeta, InterfaceChangeMetadata, PagerMetadata, QueryErrorMeta, ResultsSortMetadata, StaticFilterToggleValueMetadata } from '../searchPage/searchPageEvents';
|
|
1
2
|
export declare enum InsightEvents {
|
|
2
3
|
contextChanged = "contextChanged",
|
|
3
4
|
expandToFullUI = "expandToFullUI"
|
|
4
5
|
}
|
|
5
|
-
interface CaseMetadata {
|
|
6
|
-
caseId
|
|
7
|
-
caseNumber
|
|
8
|
-
caseContext
|
|
9
|
-
}
|
|
10
|
-
export interface ContextChangedMetadata extends CaseMetadata {
|
|
6
|
+
export interface CaseMetadata {
|
|
7
|
+
caseId?: string;
|
|
8
|
+
caseNumber?: string;
|
|
9
|
+
caseContext?: Record<string, string>;
|
|
11
10
|
}
|
|
12
11
|
export interface ExpandToFullUIMetadata extends CaseMetadata {
|
|
13
12
|
fullSearchComponentName: string;
|
|
14
13
|
triggeredBy: string;
|
|
15
14
|
}
|
|
16
|
-
export {
|
|
15
|
+
export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {
|
|
16
|
+
}
|
|
17
|
+
export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {
|
|
18
|
+
}
|
|
19
|
+
export interface InsightStaticFilterToggleValueMetadata extends StaticFilterToggleValueMetadata, CaseMetadata {
|
|
20
|
+
}
|
|
21
|
+
export interface InsightFacetRangeMetadata extends FacetRangeMetadata, CaseMetadata {
|
|
22
|
+
}
|
|
23
|
+
export interface InsightCategoryFacetMetadata extends CategoryFacetMetadata, CaseMetadata {
|
|
24
|
+
}
|
|
25
|
+
export interface InsightFacetSortMeta extends FacetSortMeta, CaseMetadata {
|
|
26
|
+
}
|
|
27
|
+
export interface InsightFacetBaseMeta extends FacetBaseMeta, CaseMetadata {
|
|
28
|
+
}
|
|
29
|
+
export interface InsightQueryErrorMeta extends QueryErrorMeta, CaseMetadata {
|
|
30
|
+
}
|
|
31
|
+
export interface InsightPagerMetadata extends PagerMetadata, CaseMetadata {
|
|
32
|
+
}
|
|
33
|
+
export interface InsightResultsSortMetadata extends ResultsSortMetadata, CaseMetadata {
|
|
34
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ClientOptions, AnalyticsClient } from '../client/analytics';
|
|
2
|
-
import { SearchEventRequest } from '../events';
|
|
2
|
+
import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
|
|
3
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 } from './searchPageEvents';
|
|
4
4
|
export interface SearchPageClientProvider {
|
|
5
5
|
getBaseMetadata: () => Record<string, any>;
|
|
@@ -19,6 +19,11 @@ export interface SearchPageClientProvider {
|
|
|
19
19
|
export interface SearchPageClientOptions extends ClientOptions {
|
|
20
20
|
enableAnalytics: boolean;
|
|
21
21
|
}
|
|
22
|
+
export declare type EventDescription = Pick<SearchEventRequest, 'actionCause' | 'customData'>;
|
|
23
|
+
export interface EventBuilder<T extends AnyEventResponse = AnyEventResponse> {
|
|
24
|
+
description: EventDescription;
|
|
25
|
+
log: () => Promise<T | void>;
|
|
26
|
+
}
|
|
22
27
|
export declare class CoveoSearchPageClient {
|
|
23
28
|
private opts;
|
|
24
29
|
private provider;
|
|
@@ -26,78 +31,154 @@ export declare class CoveoSearchPageClient {
|
|
|
26
31
|
constructor(opts: Partial<SearchPageClientOptions>, provider: SearchPageClientProvider);
|
|
27
32
|
disable(): void;
|
|
28
33
|
enable(): void;
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
34
|
+
makeInterfaceLoad(): EventBuilder<SearchEventResponse>;
|
|
35
|
+
logInterfaceLoad(): Promise<void | SearchEventResponse>;
|
|
36
|
+
makeRecommendationInterfaceLoad(): EventBuilder<SearchEventResponse>;
|
|
37
|
+
logRecommendationInterfaceLoad(): Promise<void | SearchEventResponse>;
|
|
38
|
+
makeRecommendation(): EventBuilder<CustomEventResponse>;
|
|
39
|
+
logRecommendation(): Promise<void | CustomEventResponse>;
|
|
40
|
+
makeRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
|
|
41
|
+
logRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
|
|
42
|
+
makeStaticFilterClearAll(meta: StaticFilterMetadata): EventBuilder<SearchEventResponse>;
|
|
43
|
+
logStaticFilterClearAll(meta: StaticFilterMetadata): Promise<void | SearchEventResponse>;
|
|
44
|
+
makeStaticFilterSelect(meta: StaticFilterToggleValueMetadata): EventBuilder<SearchEventResponse>;
|
|
45
|
+
logStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
|
|
46
|
+
makeStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): EventBuilder<SearchEventResponse>;
|
|
47
|
+
logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
|
|
48
|
+
makeFetchMoreResults(): EventBuilder<CustomEventResponse>;
|
|
49
|
+
logFetchMoreResults(): Promise<void | CustomEventResponse>;
|
|
50
|
+
makeInterfaceChange(metadata: InterfaceChangeMetadata): EventBuilder<SearchEventResponse>;
|
|
51
|
+
logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | SearchEventResponse>;
|
|
52
|
+
makeDidYouMeanAutomatic(): EventBuilder<SearchEventResponse>;
|
|
53
|
+
logDidYouMeanAutomatic(): Promise<void | SearchEventResponse>;
|
|
54
|
+
makeDidYouMeanClick(): EventBuilder<SearchEventResponse>;
|
|
55
|
+
logDidYouMeanClick(): Promise<void | SearchEventResponse>;
|
|
56
|
+
makeResultsSort(metadata: ResultsSortMetadata): EventBuilder<SearchEventResponse>;
|
|
57
|
+
logResultsSort(metadata: ResultsSortMetadata): Promise<void | SearchEventResponse>;
|
|
58
|
+
makeSearchboxSubmit(): EventBuilder<SearchEventResponse>;
|
|
59
|
+
logSearchboxSubmit(): Promise<void | SearchEventResponse>;
|
|
60
|
+
makeSearchboxClear(): EventBuilder<SearchEventResponse>;
|
|
61
|
+
logSearchboxClear(): Promise<void | SearchEventResponse>;
|
|
62
|
+
makeSearchboxAsYouType(): EventBuilder<SearchEventResponse>;
|
|
63
|
+
logSearchboxAsYouType(): Promise<void | SearchEventResponse>;
|
|
64
|
+
makeBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): EventBuilder<SearchEventResponse>;
|
|
65
|
+
logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<void | SearchEventResponse>;
|
|
66
|
+
makeBreadcrumbResetAll(): EventBuilder<SearchEventResponse>;
|
|
67
|
+
logBreadcrumbResetAll(): Promise<void | SearchEventResponse>;
|
|
68
|
+
makeDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
|
|
69
|
+
logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
|
|
70
|
+
makeDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
|
|
71
|
+
logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
|
|
72
|
+
makeOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): EventBuilder<SearchEventResponse>;
|
|
73
|
+
logOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
|
|
74
|
+
makeOmniboxFromLink(meta: OmniboxSuggestionsMetadata): EventBuilder<SearchEventResponse>;
|
|
75
|
+
logOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
|
|
76
|
+
makeSearchFromLink(): EventBuilder<SearchEventResponse>;
|
|
77
|
+
logSearchFromLink(): Promise<void | SearchEventResponse>;
|
|
78
|
+
makeTriggerNotify(meta: TriggerNotifyMetadata): EventBuilder<CustomEventResponse>;
|
|
79
|
+
logTriggerNotify(meta: TriggerNotifyMetadata): Promise<void | CustomEventResponse>;
|
|
80
|
+
makeTriggerExecute(meta: TriggerExecuteMetadata): EventBuilder<CustomEventResponse>;
|
|
81
|
+
logTriggerExecute(meta: TriggerExecuteMetadata): Promise<void | CustomEventResponse>;
|
|
82
|
+
makeTriggerQuery(): EventBuilder<CustomEventResponse>;
|
|
83
|
+
logTriggerQuery(): Promise<void | CustomEventResponse>;
|
|
84
|
+
makeUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): EventBuilder<SearchEventResponse>;
|
|
85
|
+
logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<void | SearchEventResponse>;
|
|
86
|
+
makeTriggerRedirect(meta: TriggerRedirectMetadata): EventBuilder<CustomEventResponse>;
|
|
87
|
+
logTriggerRedirect(meta: TriggerRedirectMetadata): Promise<void | CustomEventResponse>;
|
|
88
|
+
makePagerResize(meta: PagerResizeMetadata): EventBuilder<CustomEventResponse>;
|
|
89
|
+
logPagerResize(meta: PagerResizeMetadata): Promise<void | CustomEventResponse>;
|
|
90
|
+
makePagerNumber(meta: PagerMetadata): EventBuilder<CustomEventResponse>;
|
|
91
|
+
logPagerNumber(meta: PagerMetadata): Promise<void | CustomEventResponse>;
|
|
92
|
+
makePagerNext(meta: PagerMetadata): EventBuilder<CustomEventResponse>;
|
|
93
|
+
logPagerNext(meta: PagerMetadata): Promise<void | CustomEventResponse>;
|
|
94
|
+
makePagerPrevious(meta: PagerMetadata): EventBuilder<CustomEventResponse>;
|
|
95
|
+
logPagerPrevious(meta: PagerMetadata): Promise<void | CustomEventResponse>;
|
|
96
|
+
makePagerScrolling(): EventBuilder<CustomEventResponse>;
|
|
97
|
+
logPagerScrolling(): Promise<void | CustomEventResponse>;
|
|
98
|
+
makeFacetClearAll(meta: FacetBaseMeta): EventBuilder<SearchEventResponse>;
|
|
99
|
+
logFacetClearAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
|
|
100
|
+
makeFacetSearch(meta: FacetBaseMeta): EventBuilder<SearchEventResponse>;
|
|
101
|
+
logFacetSearch(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
|
|
102
|
+
makeFacetSelect(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
|
|
103
|
+
logFacetSelect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
|
|
104
|
+
makeFacetDeselect(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
|
|
105
|
+
logFacetDeselect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
|
|
106
|
+
makeFacetExclude(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
|
|
107
|
+
logFacetExclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
|
|
108
|
+
makeFacetUnexclude(meta: FacetMetadata): EventBuilder<SearchEventResponse>;
|
|
109
|
+
logFacetUnexclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
|
|
110
|
+
makeFacetSelectAll(meta: FacetBaseMeta): EventBuilder<SearchEventResponse>;
|
|
111
|
+
logFacetSelectAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
|
|
112
|
+
makeFacetUpdateSort(meta: FacetSortMeta): EventBuilder<SearchEventResponse>;
|
|
113
|
+
logFacetUpdateSort(meta: FacetSortMeta): Promise<void | SearchEventResponse>;
|
|
114
|
+
makeFacetShowMore(meta: FacetBaseMeta): EventBuilder<CustomEventResponse>;
|
|
115
|
+
logFacetShowMore(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
|
|
116
|
+
makeFacetShowLess(meta: FacetBaseMeta): EventBuilder<CustomEventResponse>;
|
|
117
|
+
logFacetShowLess(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
|
|
118
|
+
makeQueryError(meta: QueryErrorMeta): EventBuilder<CustomEventResponse>;
|
|
119
|
+
logQueryError(meta: QueryErrorMeta): Promise<void | CustomEventResponse>;
|
|
120
|
+
makeQueryErrorBack(): EventBuilder<SearchEventResponse>;
|
|
121
|
+
logQueryErrorBack(): Promise<void | SearchEventResponse>;
|
|
122
|
+
makeQueryErrorRetry(): EventBuilder<SearchEventResponse>;
|
|
123
|
+
logQueryErrorRetry(): Promise<void | SearchEventResponse>;
|
|
124
|
+
makeQueryErrorClear(): EventBuilder<SearchEventResponse>;
|
|
125
|
+
logQueryErrorClear(): Promise<void | SearchEventResponse>;
|
|
126
|
+
makeLikeSmartSnippet(): EventBuilder<CustomEventResponse>;
|
|
127
|
+
logLikeSmartSnippet(): Promise<void | CustomEventResponse>;
|
|
128
|
+
makeDislikeSmartSnippet(): EventBuilder<CustomEventResponse>;
|
|
129
|
+
logDislikeSmartSnippet(): Promise<void | CustomEventResponse>;
|
|
130
|
+
makeExpandSmartSnippet(): EventBuilder<CustomEventResponse>;
|
|
131
|
+
logExpandSmartSnippet(): Promise<void | CustomEventResponse>;
|
|
132
|
+
makeCollapseSmartSnippet(): EventBuilder<CustomEventResponse>;
|
|
133
|
+
logCollapseSmartSnippet(): Promise<void | CustomEventResponse>;
|
|
134
|
+
makeOpenSmartSnippetFeedbackModal(): EventBuilder<CustomEventResponse>;
|
|
135
|
+
logOpenSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
|
|
136
|
+
makeCloseSmartSnippetFeedbackModal(): EventBuilder<CustomEventResponse>;
|
|
137
|
+
logCloseSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
|
|
138
|
+
makeSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): EventBuilder<CustomEventResponse>;
|
|
139
|
+
logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<void | CustomEventResponse>;
|
|
140
|
+
makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): EventBuilder<CustomEventResponse>;
|
|
141
|
+
logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
|
|
142
|
+
makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): EventBuilder<CustomEventResponse>;
|
|
143
|
+
logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
|
|
144
|
+
private makeShowMoreSmartSnippetSuggestion;
|
|
145
|
+
logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
|
|
146
|
+
private makeShowLessSmartSnippetSuggestion;
|
|
147
|
+
logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
|
|
148
|
+
makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
|
|
149
|
+
logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
|
|
150
|
+
makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): EventBuilder<ClickEventResponse>;
|
|
151
|
+
logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | ClickEventResponse>;
|
|
152
|
+
makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): EventBuilder<ClickEventResponse>;
|
|
153
|
+
logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
|
|
154
|
+
makeOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): EventBuilder<ClickEventResponse>;
|
|
155
|
+
logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
|
|
156
|
+
makeRecentQueryClick(): EventBuilder<SearchEventResponse>;
|
|
157
|
+
logRecentQueryClick(): Promise<void | SearchEventResponse>;
|
|
158
|
+
makeClearRecentQueries(): EventBuilder<CustomEventResponse>;
|
|
159
|
+
logClearRecentQueries(): Promise<void | CustomEventResponse>;
|
|
160
|
+
makeRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<CustomEventResponse>;
|
|
161
|
+
logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | CustomEventResponse>;
|
|
162
|
+
makeClearRecentResults(): EventBuilder<CustomEventResponse>;
|
|
163
|
+
logClearRecentResults(): Promise<void | CustomEventResponse>;
|
|
164
|
+
makeNoResultsBack(): EventBuilder<SearchEventResponse>;
|
|
165
|
+
logNoResultsBack(): Promise<void | SearchEventResponse>;
|
|
166
|
+
makeShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
|
|
167
|
+
logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
|
|
168
|
+
makeShowLessFoldedResults(): EventBuilder<CustomEventResponse>;
|
|
169
|
+
logShowLessFoldedResults(): Promise<void | CustomEventResponse>;
|
|
170
|
+
makeCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): EventBuilder<CustomEventResponse>;
|
|
171
|
+
logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<void | CustomEventResponse>;
|
|
172
|
+
makeCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): {
|
|
173
|
+
description: Pick<SearchEventRequest, "actionCause" | "customData">;
|
|
174
|
+
log: () => Promise<void | CustomEventResponse>;
|
|
175
|
+
};
|
|
176
|
+
logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | CustomEventResponse>;
|
|
177
|
+
logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | SearchEventResponse>;
|
|
178
|
+
private makeDescription;
|
|
179
|
+
makeSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): EventBuilder<SearchEventResponse>;
|
|
180
|
+
logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | ClickEventResponse>;
|
|
181
|
+
makeClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): EventBuilder<ClickEventResponse>;
|
|
101
182
|
private getBaseSearchEventRequest;
|
|
102
183
|
private getBaseCustomEventRequest;
|
|
103
184
|
private getBaseEventRequest;
|
|
@@ -7,7 +7,7 @@ export { CoveoAnalyticsClient, AnalyticsClientSendEventHook } from '../client/an
|
|
|
7
7
|
export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
|
|
8
8
|
export { IRuntimeEnvironment } from '../client/runtimeEnvironment';
|
|
9
9
|
export { CoveoUA, getCurrentClient, handleOneAnalyticsEvent } from './simpleanalytics';
|
|
10
|
-
export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
|
|
10
|
+
export { CoveoSearchPageClient, SearchPageClientProvider, EventDescription, EventBuilder, } from '../searchPage/searchPageClient';
|
|
11
11
|
export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
|
|
12
12
|
export { CoveoInsightClient, InsightClientProvider } from '../insight/insightClient';
|
|
13
13
|
export { analytics, donottrack, history, SimpleAnalytics, storage };
|