coveo.analytics 2.21.27 → 2.22.2

package/dist/definitions/client/analytics.d.ts

@@ -45,6 +45,7 @@ export interface BufferedRequest {
     eventType: EventType;
     payload: any;
 }
+export declare function buildBaseUrl(endpoint?: string, apiVersion?: string): string;
 export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider {
     private get defaultOptions();
     runtime: IRuntimeEnvironment;

package/dist/definitions/insight/insightClient.d.ts

@@ -1,6 +1,6 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { FacetStateMetadata, SearchPageEvents } from '../searchPage/searchPageEvents';
+import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents } from '../searchPage/searchPageEvents';
 import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -47,8 +47,10 @@ export declare class CoveoInsightClient {
     logSearchboxSubmit(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
+    logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;
     private getBaseCustomEventRequest;
     private getBaseSearchEventRequest;
     private getBaseEventRequest;

package/dist/definitions/react-native/index.d.ts

@@ -1,2 +1,2 @@
-export { ReactNativeRuntime } from './react-native-runtime';
-export { ReactNativeStorage } from './react-native-storage';
+export { ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage } from './react-native-runtime';
+export * from '../coveoua/headless';

package/dist/definitions/react-native/react-native-runtime.d.ts

@@ -1,9 +1,18 @@
 import { WebStorage } from '../storage';
 import { AnalyticsFetchClient } from '../client/analyticsFetchClient';
 import { IRuntimeEnvironment } from '../client/runtimeEnvironment';
-import { IAnalyticsClientOptions } from '../client/analyticsRequestClient';
+import { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
+export declare type ReactNativeStorage = WebStorage;
+export interface ReactNativeRuntimeOptions {
+    storage: ReactNativeStorage;
+    visitorIdKey?: string;
+    token?: string;
+    version?: string;
+    endpoint?: string;
+    preprocessRequest?: PreprocessAnalyticsRequest;
+}
 export declare class ReactNativeRuntime implements IRuntimeEnvironment {
-    storage: WebStorage;
     client: AnalyticsFetchClient;
-    constructor(clientOptions: IAnalyticsClientOptions);
+    storage: ReactNativeStorage;
+    constructor(options: ReactNativeRuntimeOptions);
 }

package/dist/definitions/react-native/react-native-utils.d.ts

@@ -1,2 +1,2 @@
-export declare const ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please install @react-native-async-storage/async-storage and instantiate \n        your analytics client as follows:\n        \n        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';\n        \n        const analytics = new CoveoAnalyticsClient({\n            ...your options,\n            runtimeEnvironment: new ReactNativeRuntime({\n                baseUrl: '...',\n            });\n        })\n    ";
+export declare const ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please use the \"coveo.analytics/react-native\" subpackage.\n        Follow the Readme on how to set it up: https://github.com/coveo/coveo.analytics.js#using-react-native\n    ";
 export declare function isReactNative(): boolean;

package/dist/definitions/src/react-native/index.d.ts

@@ -1,2 +1,2 @@
-export { ReactNativeRuntime } from './react-native-runtime';
-export { ReactNativeStorage } from './react-native-storage';
+export { ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage } from './react-native-runtime';
+export * from '../coveoua/headless';

package/dist/definitions/src/react-native/react-native-runtime.d.ts

@@ -1,9 +1,18 @@
 import { WebStorage } from '../storage';
 import { AnalyticsFetchClient } from '../client/analyticsFetchClient';
 import { IRuntimeEnvironment } from '../client/runtimeEnvironment';
-import { IAnalyticsClientOptions } from '../client/analyticsRequestClient';
+import { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
+export declare type ReactNativeStorage = WebStorage;
+export interface ReactNativeRuntimeOptions {
+    storage: ReactNativeStorage;
+    visitorIdKey?: string;
+    token?: string;
+    version?: string;
+    endpoint?: string;
+    preprocessRequest?: PreprocessAnalyticsRequest;
+}
 export declare class ReactNativeRuntime implements IRuntimeEnvironment {
-    storage: WebStorage;
     client: AnalyticsFetchClient;
-    constructor(clientOptions: IAnalyticsClientOptions);
+    storage: ReactNativeStorage;
+    constructor(options: ReactNativeRuntimeOptions);
 }

package/dist/library.es.js

@@ -748,17 +748,8 @@ const isApiKey = (token) => (token === null || token === void 0 ? void 0 : token
 
 const ReactNativeRuntimeWarning = `
         We've detected you're using React Native but have not provided the corresponding runtime, 
-        for an optimal experience please install @react-native-async-storage/async-storage and instantiate 
-        your analytics client as follows:
-        
-        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';
-        
-        const analytics = new CoveoAnalyticsClient({
-            ...your options,
-            runtimeEnvironment: new ReactNativeRuntime({
-                baseUrl: '...',
-            });
-        })
+        for an optimal experience please use the "coveo.analytics/react-native" subpackage.
+        Follow the Readme on how to set it up: https://github.com/coveo/coveo.analytics.js#using-react-native
     `;
 function isReactNative() {
     return typeof navigator != 'undefined' && navigator.product == 'ReactNative';
@@ -781,6 +772,10 @@ const Endpoints = {
     production: 'https://analytics.cloud.coveo.com/rest/ua',
     hipaa: 'https://analyticshipaa.cloud.coveo.com/rest/ua',
 };
+function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version) {
+    const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
+    return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${apiVersion}`;
+}
 class CoveoAnalyticsClient {
     constructor(opts) {
         if (!opts) {
@@ -1077,9 +1072,7 @@ class CoveoAnalyticsClient {
         }
     }
     get baseUrl() {
-        const { version, endpoint } = this.options;
-        const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-        return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${version}`;
+        return buildBaseUrl(this.options.endpoint, this.options.version);
     }
 }
 
@@ -2198,6 +2191,9 @@ class CoveoInsightClient {
         const metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     }
+    logDocumentOpen(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
@@ -2210,6 +2206,12 @@ class CoveoInsightClient {
             return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
         });
     }
+    logClickEvent(event, info, identifier, metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = Object.assign(Object.assign(Object.assign({}, info), (yield this.getBaseEventRequest(Object.assign(Object.assign({}, identifier), metadata)))), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
+            return this.coveoAnalyticsClient.sendClickEvent(payload);
+        });
+    }
     getBaseCustomEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });

package/dist/library.js

@@ -20,7 +20,7 @@ var require$$4__default = /*#__PURE__*/_interopDefaultLegacy(require$$4);
 var require$$5__default = /*#__PURE__*/_interopDefaultLegacy(require$$5);
 var require$$6__default = /*#__PURE__*/_interopDefaultLegacy(require$$6);
 
-/*! *****************************************************************************
+/******************************************************************************
 Copyright (c) Microsoft Corporation.
 
 Permission to use, copy, modify, and/or distribute this software for any
@@ -78840,6 +78840,7 @@ var combiningMarksRegex = /[\u0300-\u036F\u0483-\u0489\u0591-\u05BD\u05BF\u05C1\
 function validateLabel(label, processing_option) {
   if (label.substr(0, 4) === "xn--") {
     label = punycode.toUnicode(label);
+    PROCESSING_OPTIONS.NONTRANSITIONAL;
   }
 
   var error = false;
@@ -82507,7 +82508,7 @@ var NoopRuntime = (function () {
 var API_KEY_PREFIX = 'xx';
 var isApiKey = function (token) { return (token === null || token === void 0 ? void 0 : token.startsWith(API_KEY_PREFIX)) || false; };
 
-var ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please install @react-native-async-storage/async-storage and instantiate \n        your analytics client as follows:\n        \n        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';\n        \n        const analytics = new CoveoAnalyticsClient({\n            ...your options,\n            runtimeEnvironment: new ReactNativeRuntime({\n                baseUrl: '...',\n            });\n        })\n    ";
+var ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please use the \"coveo.analytics/react-native\" subpackage.\n        Follow the Readme on how to set it up: https://github.com/coveo/coveo.analytics.js#using-react-native\n    ";
 function isReactNative() {
     return typeof navigator != 'undefined' && navigator.product == 'ReactNative';
 }
@@ -82535,6 +82536,12 @@ var Endpoints = {
     production: 'https://analytics.cloud.coveo.com/rest/ua',
     hipaa: 'https://analyticshipaa.cloud.coveo.com/rest/ua',
 };
+function buildBaseUrl(endpoint, apiVersion) {
+    if (endpoint === void 0) { endpoint = Endpoints.default; }
+    if (apiVersion === void 0) { apiVersion = Version; }
+    var endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
+    return "" + endpoint + (endpointIsCoveoProxy ? '' : '/rest') + "/" + apiVersion;
+}
 var CoveoAnalyticsClient = (function () {
     function CoveoAnalyticsClient(opts) {
         if (!opts) {
@@ -83034,9 +83041,7 @@ var CoveoAnalyticsClient = (function () {
     };
     Object.defineProperty(CoveoAnalyticsClient.prototype, "baseUrl", {
         get: function () {
-            var _a = this.options, version = _a.version, endpoint = _a.endpoint;
-            var endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-            return "" + endpoint + (endpointIsCoveoProxy ? '' : '/rest') + "/" + version;
+            return buildBaseUrl(this.options.endpoint, this.options.version);
         },
         enumerable: false,
         configurable: true
@@ -83048,6 +83053,7 @@ var analytics = /*#__PURE__*/Object.freeze({
     __proto__: null,
     Version: Version,
     Endpoints: Endpoints,
+    buildBaseUrl: buildBaseUrl,
     CoveoAnalyticsClient: CoveoAnalyticsClient,
     'default': CoveoAnalyticsClient
 });
@@ -84607,6 +84613,9 @@ var CoveoInsightClient = (function () {
         var metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     };
+    CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;
@@ -84636,6 +84645,21 @@ var CoveoInsightClient = (function () {
             });
         });
     };
+    CoveoInsightClient.prototype.logClickEvent = function (event, info, identifier, metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            var payload, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = [__assign({}, info)];
+                        return [4, this.getBaseEventRequest(__assign(__assign({}, identifier), metadata))];
+                    case 1:
+                        payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event }]);
+                        return [2, this.coveoAnalyticsClient.sendClickEvent(payload)];
+                }
+            });
+        });
+    };
     CoveoInsightClient.prototype.getBaseCustomEventRequest = function (metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var _a;