coveo.analytics 2.20.23 → 2.20.25
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/insight/insightClient.d.ts +24 -24
- package/dist/definitions/insight/insightEvents.d.ts +25 -7
- package/dist/library.es.js +103 -59
- package/dist/library.js +104 -59
- package/package.json +2 -2
- package/src/insight/insightClient.spec.ts +495 -151
- package/src/insight/insightClient.ts +131 -91
- package/src/insight/insightEvents.ts +37 -6
|
@@ -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
|
+
}
|
package/dist/library.es.js
CHANGED
|
@@ -1821,12 +1821,23 @@ class CaseAssistClient {
|
|
|
1821
1821
|
|
|
1822
1822
|
const extractContextFromMetadata = (meta) => {
|
|
1823
1823
|
const context = {};
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
1824
|
+
if (meta.caseContext) {
|
|
1825
|
+
Object.keys(meta.caseContext).forEach((contextKey) => {
|
|
1826
|
+
var _a;
|
|
1827
|
+
const value = (_a = meta.caseContext) === null || _a === void 0 ? void 0 : _a[contextKey];
|
|
1828
|
+
if (value) {
|
|
1829
|
+
const keyToBeSent = `context_${contextKey}`;
|
|
1830
|
+
context[keyToBeSent] = value;
|
|
1831
|
+
}
|
|
1832
|
+
});
|
|
1833
|
+
}
|
|
1828
1834
|
return context;
|
|
1829
1835
|
};
|
|
1836
|
+
const generateMetadataToSend = (metadata, includeContext = true) => {
|
|
1837
|
+
const { caseContext, caseId, caseNumber } = metadata, metadataWithoutContext = __rest(metadata, ["caseContext", "caseId", "caseNumber"]);
|
|
1838
|
+
const context = extractContextFromMetadata(metadata);
|
|
1839
|
+
return Object.assign(Object.assign(Object.assign({ CaseId: caseId, CaseNumber: caseNumber }, metadataWithoutContext), (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), (includeContext && context));
|
|
1840
|
+
};
|
|
1830
1841
|
class CoveoInsightClient {
|
|
1831
1842
|
constructor(opts, provider) {
|
|
1832
1843
|
this.opts = opts;
|
|
@@ -1843,90 +1854,123 @@ class CoveoInsightClient {
|
|
|
1843
1854
|
enable() {
|
|
1844
1855
|
this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.opts);
|
|
1845
1856
|
}
|
|
1846
|
-
logInterfaceLoad() {
|
|
1857
|
+
logInterfaceLoad(metadata) {
|
|
1858
|
+
if (metadata) {
|
|
1859
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1860
|
+
return this.logSearchEvent(SearchPageEvents.interfaceLoad, metadataToSend);
|
|
1861
|
+
}
|
|
1847
1862
|
return this.logSearchEvent(SearchPageEvents.interfaceLoad);
|
|
1848
1863
|
}
|
|
1849
1864
|
logInterfaceChange(metadata) {
|
|
1850
|
-
|
|
1865
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1866
|
+
return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
|
|
1851
1867
|
}
|
|
1852
|
-
logStaticFilterDeselect(
|
|
1853
|
-
|
|
1868
|
+
logStaticFilterDeselect(metadata) {
|
|
1869
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1870
|
+
return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, metadataToSend);
|
|
1854
1871
|
}
|
|
1855
|
-
logFetchMoreResults() {
|
|
1872
|
+
logFetchMoreResults(metadata) {
|
|
1873
|
+
if (metadata) {
|
|
1874
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1875
|
+
return this.logCustomEvent(SearchPageEvents.pagerScrolling, Object.assign(Object.assign({}, metadataToSend), { type: 'getMoreResults' }));
|
|
1876
|
+
}
|
|
1856
1877
|
return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
|
|
1857
1878
|
}
|
|
1858
1879
|
logBreadcrumbFacet(metadata) {
|
|
1859
|
-
|
|
1880
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1881
|
+
return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadataToSend);
|
|
1860
1882
|
}
|
|
1861
|
-
logBreadcrumbResetAll() {
|
|
1883
|
+
logBreadcrumbResetAll(metadata) {
|
|
1884
|
+
if (metadata) {
|
|
1885
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1886
|
+
return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll, metadataToSend);
|
|
1887
|
+
}
|
|
1862
1888
|
return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
|
|
1863
1889
|
}
|
|
1864
|
-
logFacetSelect(
|
|
1865
|
-
|
|
1890
|
+
logFacetSelect(metadata) {
|
|
1891
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1892
|
+
return this.logSearchEvent(SearchPageEvents.facetSelect, metadataToSend);
|
|
1866
1893
|
}
|
|
1867
|
-
logFacetDeselect(
|
|
1868
|
-
|
|
1894
|
+
logFacetDeselect(metadata) {
|
|
1895
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1896
|
+
return this.logSearchEvent(SearchPageEvents.facetDeselect, metadataToSend);
|
|
1869
1897
|
}
|
|
1870
|
-
logFacetUpdateSort(
|
|
1871
|
-
|
|
1898
|
+
logFacetUpdateSort(metadata) {
|
|
1899
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1900
|
+
return this.logSearchEvent(SearchPageEvents.facetUpdateSort, metadataToSend);
|
|
1872
1901
|
}
|
|
1873
|
-
logFacetClearAll(
|
|
1874
|
-
|
|
1902
|
+
logFacetClearAll(metadata) {
|
|
1903
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1904
|
+
return this.logSearchEvent(SearchPageEvents.facetClearAll, metadataToSend);
|
|
1875
1905
|
}
|
|
1876
|
-
logFacetShowMore(
|
|
1877
|
-
|
|
1906
|
+
logFacetShowMore(metadata) {
|
|
1907
|
+
const metadataToSend = generateMetadataToSend(metadata, false);
|
|
1908
|
+
return this.logCustomEvent(SearchPageEvents.facetShowMore, metadataToSend);
|
|
1878
1909
|
}
|
|
1879
|
-
logFacetShowLess(
|
|
1880
|
-
|
|
1910
|
+
logFacetShowLess(metadata) {
|
|
1911
|
+
const metadataToSend = generateMetadataToSend(metadata, false);
|
|
1912
|
+
return this.logCustomEvent(SearchPageEvents.facetShowLess, metadataToSend);
|
|
1881
1913
|
}
|
|
1882
|
-
logQueryError(
|
|
1883
|
-
|
|
1914
|
+
logQueryError(metadata) {
|
|
1915
|
+
const metadataToSend = generateMetadataToSend(metadata, false);
|
|
1916
|
+
return this.logCustomEvent(SearchPageEvents.queryError, metadataToSend);
|
|
1884
1917
|
}
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
|
|
1889
|
-
return this.coveoAnalyticsClient.sendCustomEvent(payload);
|
|
1890
|
-
});
|
|
1918
|
+
logPagerNumber(metadata) {
|
|
1919
|
+
const metadataToSend = generateMetadataToSend(metadata, false);
|
|
1920
|
+
return this.logCustomEvent(SearchPageEvents.pagerNumber, metadataToSend);
|
|
1891
1921
|
}
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
});
|
|
1922
|
+
logPagerNext(metadata) {
|
|
1923
|
+
const metadataToSend = generateMetadataToSend(metadata, false);
|
|
1924
|
+
return this.logCustomEvent(SearchPageEvents.pagerNext, metadataToSend);
|
|
1896
1925
|
}
|
|
1897
|
-
|
|
1898
|
-
|
|
1926
|
+
logPagerPrevious(metadata) {
|
|
1927
|
+
const metadataToSend = generateMetadataToSend(metadata, false);
|
|
1928
|
+
return this.logCustomEvent(SearchPageEvents.pagerPrevious, metadataToSend);
|
|
1899
1929
|
}
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
}
|
|
1906
|
-
logDidYouMeanAutomatic() {
|
|
1930
|
+
logDidYouMeanAutomatic(metadata) {
|
|
1931
|
+
if (metadata) {
|
|
1932
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1933
|
+
return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic, metadataToSend);
|
|
1934
|
+
}
|
|
1907
1935
|
return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
|
|
1908
1936
|
}
|
|
1909
|
-
logDidYouMeanClick() {
|
|
1937
|
+
logDidYouMeanClick(metadata) {
|
|
1938
|
+
if (metadata) {
|
|
1939
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1940
|
+
return this.logSearchEvent(SearchPageEvents.didyoumeanClick, metadataToSend);
|
|
1941
|
+
}
|
|
1910
1942
|
return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
|
|
1911
1943
|
}
|
|
1912
1944
|
logResultsSort(metadata) {
|
|
1913
|
-
|
|
1945
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1946
|
+
return this.logSearchEvent(SearchPageEvents.resultsSort, metadataToSend);
|
|
1914
1947
|
}
|
|
1915
|
-
logSearchboxSubmit() {
|
|
1948
|
+
logSearchboxSubmit(metadata) {
|
|
1949
|
+
if (metadata) {
|
|
1950
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1951
|
+
return this.logSearchEvent(SearchPageEvents.searchboxSubmit, metadataToSend);
|
|
1952
|
+
}
|
|
1916
1953
|
return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
|
|
1917
1954
|
}
|
|
1918
|
-
logContextChanged(
|
|
1919
|
-
const
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1955
|
+
logContextChanged(metadata) {
|
|
1956
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1957
|
+
return this.logSearchEvent(InsightEvents.contextChanged, metadataToSend);
|
|
1958
|
+
}
|
|
1959
|
+
logExpandToFullUI(metadata) {
|
|
1960
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
1961
|
+
return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
|
|
1962
|
+
}
|
|
1963
|
+
logCustomEvent(event, metadata) {
|
|
1964
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1965
|
+
const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
|
|
1966
|
+
const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
|
|
1967
|
+
return this.coveoAnalyticsClient.sendCustomEvent(payload);
|
|
1968
|
+
});
|
|
1969
|
+
}
|
|
1970
|
+
logSearchEvent(event, metadata) {
|
|
1971
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1972
|
+
return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
|
|
1973
|
+
});
|
|
1930
1974
|
}
|
|
1931
1975
|
getBaseCustomEventRequest(metadata) {
|
|
1932
1976
|
return __awaiter(this, void 0, void 0, function* () {
|
package/dist/library.js
CHANGED
|
@@ -84221,12 +84221,24 @@ var CaseAssistClient = (function () {
|
|
|
84221
84221
|
|
|
84222
84222
|
var extractContextFromMetadata = function (meta) {
|
|
84223
84223
|
var context = {};
|
|
84224
|
-
|
|
84225
|
-
|
|
84226
|
-
|
|
84227
|
-
|
|
84224
|
+
if (meta.caseContext) {
|
|
84225
|
+
Object.keys(meta.caseContext).forEach(function (contextKey) {
|
|
84226
|
+
var _a;
|
|
84227
|
+
var value = (_a = meta.caseContext) === null || _a === void 0 ? void 0 : _a[contextKey];
|
|
84228
|
+
if (value) {
|
|
84229
|
+
var keyToBeSent = "context_" + contextKey;
|
|
84230
|
+
context[keyToBeSent] = value;
|
|
84231
|
+
}
|
|
84232
|
+
});
|
|
84233
|
+
}
|
|
84228
84234
|
return context;
|
|
84229
84235
|
};
|
|
84236
|
+
var generateMetadataToSend = function (metadata, includeContext) {
|
|
84237
|
+
if (includeContext === void 0) { includeContext = true; }
|
|
84238
|
+
metadata.caseContext; var caseId = metadata.caseId, caseNumber = metadata.caseNumber, metadataWithoutContext = __rest(metadata, ["caseContext", "caseId", "caseNumber"]);
|
|
84239
|
+
var context = extractContextFromMetadata(metadata);
|
|
84240
|
+
return __assign(__assign(__assign({ CaseId: caseId, CaseNumber: caseNumber }, metadataWithoutContext), (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), (includeContext && context));
|
|
84241
|
+
};
|
|
84230
84242
|
var CoveoInsightClient = (function () {
|
|
84231
84243
|
function CoveoInsightClient(opts, provider) {
|
|
84232
84244
|
this.opts = opts;
|
|
@@ -84243,44 +84255,111 @@ var CoveoInsightClient = (function () {
|
|
|
84243
84255
|
CoveoInsightClient.prototype.enable = function () {
|
|
84244
84256
|
this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.opts);
|
|
84245
84257
|
};
|
|
84246
|
-
CoveoInsightClient.prototype.logInterfaceLoad = function () {
|
|
84258
|
+
CoveoInsightClient.prototype.logInterfaceLoad = function (metadata) {
|
|
84259
|
+
if (metadata) {
|
|
84260
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84261
|
+
return this.logSearchEvent(SearchPageEvents.interfaceLoad, metadataToSend);
|
|
84262
|
+
}
|
|
84247
84263
|
return this.logSearchEvent(SearchPageEvents.interfaceLoad);
|
|
84248
84264
|
};
|
|
84249
84265
|
CoveoInsightClient.prototype.logInterfaceChange = function (metadata) {
|
|
84250
|
-
|
|
84266
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84267
|
+
return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
|
|
84251
84268
|
};
|
|
84252
|
-
CoveoInsightClient.prototype.logStaticFilterDeselect = function (
|
|
84253
|
-
|
|
84269
|
+
CoveoInsightClient.prototype.logStaticFilterDeselect = function (metadata) {
|
|
84270
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84271
|
+
return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, metadataToSend);
|
|
84254
84272
|
};
|
|
84255
|
-
CoveoInsightClient.prototype.logFetchMoreResults = function () {
|
|
84273
|
+
CoveoInsightClient.prototype.logFetchMoreResults = function (metadata) {
|
|
84274
|
+
if (metadata) {
|
|
84275
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84276
|
+
return this.logCustomEvent(SearchPageEvents.pagerScrolling, __assign(__assign({}, metadataToSend), { type: 'getMoreResults' }));
|
|
84277
|
+
}
|
|
84256
84278
|
return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
|
|
84257
84279
|
};
|
|
84258
84280
|
CoveoInsightClient.prototype.logBreadcrumbFacet = function (metadata) {
|
|
84259
|
-
|
|
84281
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84282
|
+
return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadataToSend);
|
|
84260
84283
|
};
|
|
84261
|
-
CoveoInsightClient.prototype.logBreadcrumbResetAll = function () {
|
|
84284
|
+
CoveoInsightClient.prototype.logBreadcrumbResetAll = function (metadata) {
|
|
84285
|
+
if (metadata) {
|
|
84286
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84287
|
+
return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll, metadataToSend);
|
|
84288
|
+
}
|
|
84262
84289
|
return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
|
|
84263
84290
|
};
|
|
84264
|
-
CoveoInsightClient.prototype.logFacetSelect = function (
|
|
84265
|
-
|
|
84291
|
+
CoveoInsightClient.prototype.logFacetSelect = function (metadata) {
|
|
84292
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84293
|
+
return this.logSearchEvent(SearchPageEvents.facetSelect, metadataToSend);
|
|
84266
84294
|
};
|
|
84267
|
-
CoveoInsightClient.prototype.logFacetDeselect = function (
|
|
84268
|
-
|
|
84295
|
+
CoveoInsightClient.prototype.logFacetDeselect = function (metadata) {
|
|
84296
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84297
|
+
return this.logSearchEvent(SearchPageEvents.facetDeselect, metadataToSend);
|
|
84269
84298
|
};
|
|
84270
|
-
CoveoInsightClient.prototype.logFacetUpdateSort = function (
|
|
84271
|
-
|
|
84299
|
+
CoveoInsightClient.prototype.logFacetUpdateSort = function (metadata) {
|
|
84300
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84301
|
+
return this.logSearchEvent(SearchPageEvents.facetUpdateSort, metadataToSend);
|
|
84272
84302
|
};
|
|
84273
|
-
CoveoInsightClient.prototype.logFacetClearAll = function (
|
|
84274
|
-
|
|
84303
|
+
CoveoInsightClient.prototype.logFacetClearAll = function (metadata) {
|
|
84304
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84305
|
+
return this.logSearchEvent(SearchPageEvents.facetClearAll, metadataToSend);
|
|
84275
84306
|
};
|
|
84276
|
-
CoveoInsightClient.prototype.logFacetShowMore = function (
|
|
84277
|
-
|
|
84307
|
+
CoveoInsightClient.prototype.logFacetShowMore = function (metadata) {
|
|
84308
|
+
var metadataToSend = generateMetadataToSend(metadata, false);
|
|
84309
|
+
return this.logCustomEvent(SearchPageEvents.facetShowMore, metadataToSend);
|
|
84278
84310
|
};
|
|
84279
|
-
CoveoInsightClient.prototype.logFacetShowLess = function (
|
|
84280
|
-
|
|
84311
|
+
CoveoInsightClient.prototype.logFacetShowLess = function (metadata) {
|
|
84312
|
+
var metadataToSend = generateMetadataToSend(metadata, false);
|
|
84313
|
+
return this.logCustomEvent(SearchPageEvents.facetShowLess, metadataToSend);
|
|
84281
84314
|
};
|
|
84282
|
-
CoveoInsightClient.prototype.logQueryError = function (
|
|
84283
|
-
|
|
84315
|
+
CoveoInsightClient.prototype.logQueryError = function (metadata) {
|
|
84316
|
+
var metadataToSend = generateMetadataToSend(metadata, false);
|
|
84317
|
+
return this.logCustomEvent(SearchPageEvents.queryError, metadataToSend);
|
|
84318
|
+
};
|
|
84319
|
+
CoveoInsightClient.prototype.logPagerNumber = function (metadata) {
|
|
84320
|
+
var metadataToSend = generateMetadataToSend(metadata, false);
|
|
84321
|
+
return this.logCustomEvent(SearchPageEvents.pagerNumber, metadataToSend);
|
|
84322
|
+
};
|
|
84323
|
+
CoveoInsightClient.prototype.logPagerNext = function (metadata) {
|
|
84324
|
+
var metadataToSend = generateMetadataToSend(metadata, false);
|
|
84325
|
+
return this.logCustomEvent(SearchPageEvents.pagerNext, metadataToSend);
|
|
84326
|
+
};
|
|
84327
|
+
CoveoInsightClient.prototype.logPagerPrevious = function (metadata) {
|
|
84328
|
+
var metadataToSend = generateMetadataToSend(metadata, false);
|
|
84329
|
+
return this.logCustomEvent(SearchPageEvents.pagerPrevious, metadataToSend);
|
|
84330
|
+
};
|
|
84331
|
+
CoveoInsightClient.prototype.logDidYouMeanAutomatic = function (metadata) {
|
|
84332
|
+
if (metadata) {
|
|
84333
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84334
|
+
return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic, metadataToSend);
|
|
84335
|
+
}
|
|
84336
|
+
return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
|
|
84337
|
+
};
|
|
84338
|
+
CoveoInsightClient.prototype.logDidYouMeanClick = function (metadata) {
|
|
84339
|
+
if (metadata) {
|
|
84340
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84341
|
+
return this.logSearchEvent(SearchPageEvents.didyoumeanClick, metadataToSend);
|
|
84342
|
+
}
|
|
84343
|
+
return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
|
|
84344
|
+
};
|
|
84345
|
+
CoveoInsightClient.prototype.logResultsSort = function (metadata) {
|
|
84346
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84347
|
+
return this.logSearchEvent(SearchPageEvents.resultsSort, metadataToSend);
|
|
84348
|
+
};
|
|
84349
|
+
CoveoInsightClient.prototype.logSearchboxSubmit = function (metadata) {
|
|
84350
|
+
if (metadata) {
|
|
84351
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84352
|
+
return this.logSearchEvent(SearchPageEvents.searchboxSubmit, metadataToSend);
|
|
84353
|
+
}
|
|
84354
|
+
return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
|
|
84355
|
+
};
|
|
84356
|
+
CoveoInsightClient.prototype.logContextChanged = function (metadata) {
|
|
84357
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84358
|
+
return this.logSearchEvent(InsightEvents.contextChanged, metadataToSend);
|
|
84359
|
+
};
|
|
84360
|
+
CoveoInsightClient.prototype.logExpandToFullUI = function (metadata) {
|
|
84361
|
+
var metadataToSend = generateMetadataToSend(metadata);
|
|
84362
|
+
return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
|
|
84284
84363
|
};
|
|
84285
84364
|
CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
|
|
84286
84365
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -84311,40 +84390,6 @@ var CoveoInsightClient = (function () {
|
|
|
84311
84390
|
});
|
|
84312
84391
|
});
|
|
84313
84392
|
};
|
|
84314
|
-
CoveoInsightClient.prototype.logPagerNumber = function (meta) {
|
|
84315
|
-
return this.logCustomEvent(SearchPageEvents.pagerNumber, meta);
|
|
84316
|
-
};
|
|
84317
|
-
CoveoInsightClient.prototype.logPagerNext = function (meta) {
|
|
84318
|
-
return this.logCustomEvent(SearchPageEvents.pagerNext, meta);
|
|
84319
|
-
};
|
|
84320
|
-
CoveoInsightClient.prototype.logPagerPrevious = function (meta) {
|
|
84321
|
-
return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
|
|
84322
|
-
};
|
|
84323
|
-
CoveoInsightClient.prototype.logDidYouMeanAutomatic = function () {
|
|
84324
|
-
return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
|
|
84325
|
-
};
|
|
84326
|
-
CoveoInsightClient.prototype.logDidYouMeanClick = function () {
|
|
84327
|
-
return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
|
|
84328
|
-
};
|
|
84329
|
-
CoveoInsightClient.prototype.logResultsSort = function (metadata) {
|
|
84330
|
-
return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
|
|
84331
|
-
};
|
|
84332
|
-
CoveoInsightClient.prototype.logSearchboxSubmit = function () {
|
|
84333
|
-
return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
|
|
84334
|
-
};
|
|
84335
|
-
CoveoInsightClient.prototype.logContextChanged = function (meta) {
|
|
84336
|
-
var context = extractContextFromMetadata(meta);
|
|
84337
|
-
var caseId = meta.caseId, caseNumber = meta.caseNumber;
|
|
84338
|
-
var metaToBeSent = __assign(__assign({ CaseId: caseId, CaseNumber: caseNumber }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), context);
|
|
84339
|
-
return this.logSearchEvent(InsightEvents.contextChanged, metaToBeSent);
|
|
84340
|
-
};
|
|
84341
|
-
CoveoInsightClient.prototype.logExpandToFullUI = function (meta) {
|
|
84342
|
-
var context = extractContextFromMetadata(meta);
|
|
84343
|
-
var caseId = meta.caseId, caseNumber = meta.caseNumber, triggeredBy = meta.triggeredBy, fullSearchComponentName = meta.fullSearchComponentName;
|
|
84344
|
-
var metaToBeSent = __assign({ CaseId: caseId, CaseNumber: caseNumber, triggeredBy: triggeredBy,
|
|
84345
|
-
fullSearchComponentName: fullSearchComponentName }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject }));
|
|
84346
|
-
return this.logCustomEvent(InsightEvents.expandToFullUI, metaToBeSent);
|
|
84347
|
-
};
|
|
84348
84393
|
CoveoInsightClient.prototype.getBaseCustomEventRequest = function (metadata) {
|
|
84349
84394
|
return __awaiter(this, void 0, void 0, function () {
|
|
84350
84395
|
var _a;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "coveo.analytics",
|
|
3
|
-
"version": "2.20.
|
|
3
|
+
"version": "2.20.25",
|
|
4
4
|
"description": "📈 Coveo analytics client (node and browser compatible) ",
|
|
5
5
|
"main": "dist/library.js",
|
|
6
6
|
"module": "dist/library.es.js",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
},
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@react-native-async-storage/async-storage": "^1.17.
|
|
26
|
+
"@react-native-async-storage/async-storage": "^1.17.10",
|
|
27
27
|
"cross-fetch": "^3.1.5"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|