coveo.analytics 2.28.13 → 2.28.14

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

@@ -85,7 +85,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
     sendEvent(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<void | AnyEventResponse>;
     private deferExecution;
-    private sendFromBufferWithFetch;
+    private sendFromBuffer;
     clear(): void;
     deleteHttpOnlyVisitorId(): void;
     makeSearchEvent(request: PreparedSearchEventRequest): Promise<PreparedEvent<PreparedSearchEventRequest, SearchEventRequest, SearchEventResponse>>;

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

@@ -4,6 +4,7 @@ export declare class AnalyticsBeaconClient implements AnalyticsRequestClient {
     private opts;
     constructor(opts: IAnalyticsClientOptions);
     sendEvent(eventType: EventType, payload: IRequestPayload): Promise<void>;
+    isAvailable(): boolean;
     deleteHttpCookieVisitorId(): Promise<void>;
     private encodeForEventType;
     private getQueryParamsForEventType;

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

@@ -1,23 +1,29 @@
 import { WebStorage, NullStorage } from '../storage';
+import { AnalyticsBeaconClient } from './analyticsBeaconClient';
 import { AnalyticsRequestClient, IAnalyticsClientOptions, NoopAnalyticsClient } from './analyticsRequestClient';
 import { AnalyticsFetchClient } from './analyticsFetchClient';
 import { BufferedRequest } from './analytics';
+import { EventType } from '../events';
 export interface IRuntimeEnvironment {
     storage: WebStorage;
     client: AnalyticsRequestClient;
+    getClientDependingOnEventType(eventType: EventType): AnalyticsRequestClient;
 }
 export declare class BrowserRuntime implements IRuntimeEnvironment {
     storage: WebStorage;
     client: AnalyticsFetchClient;
     private beaconClient;
     constructor(clientOptions: IAnalyticsClientOptions, getUnprocessedRequests: () => Array<BufferedRequest>);
+    getClientDependingOnEventType(eventType: EventType): AnalyticsFetchClient | AnalyticsBeaconClient;
 }
 export declare class NodeJSRuntime implements IRuntimeEnvironment {
     storage: WebStorage;
     client: AnalyticsFetchClient;
     constructor(clientOptions: IAnalyticsClientOptions, storage?: WebStorage);
+    getClientDependingOnEventType(eventType: EventType): AnalyticsRequestClient;
 }
 export declare class NoopRuntime implements IRuntimeEnvironment {
     storage: NullStorage;
     client: NoopAnalyticsClient;
+    getClientDependingOnEventType(eventType: EventType): AnalyticsRequestClient;
 }

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

@@ -15,4 +15,5 @@ export declare class ReactNativeRuntime implements IRuntimeEnvironment {
     client: AnalyticsFetchClient;
     storage: ReactNativeStorage;
     constructor(options: ReactNativeRuntimeOptions);
+    getClientDependingOnEventType(): AnalyticsFetchClient;
 }

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

@@ -15,4 +15,5 @@ export declare class ReactNativeRuntime implements IRuntimeEnvironment {
     client: AnalyticsFetchClient;
     storage: ReactNativeStorage;
     constructor(options: ReactNativeRuntimeOptions);
+    getClientDependingOnEventType(): AnalyticsFetchClient;
 }

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.13";
+export declare const libVersion = "2.28.14";

package/dist/library.es.js

@@ -596,7 +596,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.28.13" ;
+const libVersion = "2.28.14" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1009,7 +1009,7 @@ class AnalyticsBeaconClient {
     }
     sendEvent(eventType, payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!navigator.sendBeacon) {
+            if (!this.isAvailable()) {
                 throw new Error(`navigator.sendBeacon is not supported in this browser. Consider adding a polyfill like "sendbeacon-polyfill".`);
             }
             const { baseUrl, preprocessRequest } = this.opts;
@@ -1022,11 +1022,13 @@ class AnalyticsBeaconClient {
                 }),
             };
             const { url, body } = Object.assign(Object.assign({}, defaultOptions), (preprocessRequest ? yield preprocessRequest(defaultOptions, 'analyticsBeacon') : {}));
-            console.log(`Sending beacon for "${eventType}" with: `, JSON.stringify(payload));
             navigator.sendBeacon(url, body);
             return;
         });
     }
+    isAvailable() {
+        return 'sendBeacon' in navigator;
+    }
     deleteHttpCookieVisitorId() {
         return Promise.resolve();
     }
@@ -1162,18 +1164,27 @@ class BrowserRuntime {
             }
         });
     }
+    getClientDependingOnEventType(eventType) {
+        return eventType === 'click' && this.beaconClient.isAvailable() ? this.beaconClient : this.client;
+    }
 }
 class NodeJSRuntime {
     constructor(clientOptions, storage) {
         this.storage = storage || new NullStorage();
         this.client = new AnalyticsFetchClient(clientOptions);
     }
+    getClientDependingOnEventType(eventType) {
+        return this.client;
+    }
 }
 class NoopRuntime {
     constructor() {
         this.storage = new NullStorage();
         this.client = new NoopAnalyticsClient();
     }
+    getClientDependingOnEventType(eventType) {
+        return this.client;
+    }
 }
 
 const API_KEY_PREFIX = 'xx';
@@ -1422,7 +1433,7 @@ class CoveoAnalyticsClient {
                     });
                     yield Promise.all(this.afterSendHooks.map((hook) => hook(eventType, Object.assign(Object.assign({}, parametersToSend), remainingPayload))));
                     yield this.deferExecution();
-                    return (yield this.sendFromBufferWithFetch());
+                    return (yield this.sendFromBuffer());
                 }),
             };
         });
@@ -1435,12 +1446,12 @@ class CoveoAnalyticsClient {
     deferExecution() {
         return new Promise((resolve) => setTimeout(resolve, 0));
     }
-    sendFromBufferWithFetch() {
+    sendFromBuffer() {
         return __awaiter(this, void 0, void 0, function* () {
             const popped = this.bufferedRequests.shift();
             if (popped) {
                 const { eventType, payload } = popped;
-                return this.runtime.client.sendEvent(eventType, payload);
+                return this.runtime.getClientDependingOnEventType(eventType).sendEvent(eventType, payload);
             }
         });
     }

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.13" ;
+var libVersion = "2.28.14" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -1211,7 +1211,7 @@ var AnalyticsBeaconClient = (function () {
             return __generator(this, function (_e) {
                 switch (_e.label) {
                     case 0:
-                        if (!navigator.sendBeacon) {
+                        if (!this.isAvailable()) {
                             throw new Error("navigator.sendBeacon is not supported in this browser. Consider adding a polyfill like \"sendbeacon-polyfill\".");
                         }
                         _a = this.opts, baseUrl = _a.baseUrl, preprocessRequest = _a.preprocessRequest;
@@ -1236,13 +1236,15 @@ var AnalyticsBeaconClient = (function () {
                         _e.label = 4;
                     case 4:
                         _b = __assign.apply(void 0, _c.concat([(_d)])), url = _b.url, body = _b.body;
-                        console.log("Sending beacon for \"".concat(eventType, "\" with: "), JSON.stringify(payload));
                         navigator.sendBeacon(url, body);
                         return [2];
                 }
             });
         });
     };
+    AnalyticsBeaconClient.prototype.isAvailable = function () {
+        return 'sendBeacon' in navigator;
+    };
     AnalyticsBeaconClient.prototype.deleteHttpCookieVisitorId = function () {
         return Promise.resolve();
     };
@@ -82949,6 +82951,9 @@ var BrowserRuntime = (function () {
             }
         });
     }
+    BrowserRuntime.prototype.getClientDependingOnEventType = function (eventType) {
+        return eventType === 'click' && this.beaconClient.isAvailable() ? this.beaconClient : this.client;
+    };
     return BrowserRuntime;
 }());
 var NodeJSRuntime = (function () {
@@ -82956,6 +82961,9 @@ var NodeJSRuntime = (function () {
         this.storage = storage || new NullStorage();
         this.client = new AnalyticsFetchClient(clientOptions);
     }
+    NodeJSRuntime.prototype.getClientDependingOnEventType = function (eventType) {
+        return this.client;
+    };
     return NodeJSRuntime;
 }());
 var NoopRuntime = (function () {
@@ -82963,6 +82971,9 @@ var NoopRuntime = (function () {
         this.storage = new NullStorage();
         this.client = new NoopAnalyticsClient();
     }
+    NoopRuntime.prototype.getClientDependingOnEventType = function (eventType) {
+        return this.client;
+    };
     return NoopRuntime;
 }());
 
@@ -83395,7 +83406,7 @@ var CoveoAnalyticsClient = (function () {
                                                 return [4, this.deferExecution()];
                                             case 2:
                                                 _a.sent();
-                                                return [4, this.sendFromBufferWithFetch()];
+                                                return [4, this.sendFromBuffer()];
                                             case 3: return [2, (_a.sent())];
                                         }
                                     });
@@ -83422,14 +83433,14 @@ var CoveoAnalyticsClient = (function () {
     CoveoAnalyticsClient.prototype.deferExecution = function () {
         return new Promise(function (resolve) { return setTimeout(resolve, 0); });
     };
-    CoveoAnalyticsClient.prototype.sendFromBufferWithFetch = function () {
+    CoveoAnalyticsClient.prototype.sendFromBuffer = function () {
         return __awaiter(this, void 0, void 0, function () {
             var popped, eventType, payload;
             return __generator(this, function (_a) {
                 popped = this.bufferedRequests.shift();
                 if (popped) {
                     eventType = popped.eventType, payload = popped.payload;
-                    return [2, this.runtime.client.sendEvent(eventType, payload)];
+                    return [2, this.runtime.getClientDependingOnEventType(eventType).sendEvent(eventType, payload)];
                 }
                 return [2];
             });

package/dist/react-native.es.js

@@ -658,7 +658,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.28.13" ;
+const libVersion = "2.28.14" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1071,7 +1071,7 @@ class AnalyticsBeaconClient {
     }
     sendEvent(eventType, payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!navigator.sendBeacon) {
+            if (!this.isAvailable()) {
                 throw new Error(`navigator.sendBeacon is not supported in this browser. Consider adding a polyfill like "sendbeacon-polyfill".`);
             }
             const { baseUrl, preprocessRequest } = this.opts;
@@ -1084,11 +1084,13 @@ class AnalyticsBeaconClient {
                 }),
             };
             const { url, body } = Object.assign(Object.assign({}, defaultOptions), (preprocessRequest ? yield preprocessRequest(defaultOptions, 'analyticsBeacon') : {}));
-            console.log(`Sending beacon for "${eventType}" with: `, JSON.stringify(payload));
             navigator.sendBeacon(url, body);
             return;
         });
     }
+    isAvailable() {
+        return 'sendBeacon' in navigator;
+    }
     deleteHttpCookieVisitorId() {
         return Promise.resolve();
     }
@@ -1163,18 +1165,27 @@ class BrowserRuntime {
             }
         });
     }
+    getClientDependingOnEventType(eventType) {
+        return eventType === 'click' && this.beaconClient.isAvailable() ? this.beaconClient : this.client;
+    }
 }
 class NodeJSRuntime {
     constructor(clientOptions, storage) {
         this.storage = storage || new NullStorage();
         this.client = new AnalyticsFetchClient(clientOptions);
     }
+    getClientDependingOnEventType(eventType) {
+        return this.client;
+    }
 }
 class NoopRuntime {
     constructor() {
         this.storage = new NullStorage();
         this.client = new NoopAnalyticsClient();
     }
+    getClientDependingOnEventType(eventType) {
+        return this.client;
+    }
 }
 
 const API_KEY_PREFIX = 'xx';
@@ -1423,7 +1434,7 @@ class CoveoAnalyticsClient {
                     });
                     yield Promise.all(this.afterSendHooks.map((hook) => hook(eventType, Object.assign(Object.assign({}, parametersToSend), remainingPayload))));
                     yield this.deferExecution();
-                    return (yield this.sendFromBufferWithFetch());
+                    return (yield this.sendFromBuffer());
                 }),
             };
         });
@@ -1436,12 +1447,12 @@ class CoveoAnalyticsClient {
     deferExecution() {
         return new Promise((resolve) => setTimeout(resolve, 0));
     }
-    sendFromBufferWithFetch() {
+    sendFromBuffer() {
         return __awaiter(this, void 0, void 0, function* () {
             const popped = this.bufferedRequests.shift();
             if (popped) {
                 const { eventType, payload } = popped;
-                return this.runtime.client.sendEvent(eventType, payload);
+                return this.runtime.getClientDependingOnEventType(eventType).sendEvent(eventType, payload);
             }
         });
     }
@@ -1667,6 +1678,9 @@ class ReactNativeRuntime {
             },
         });
     }
+    getClientDependingOnEventType() {
+        return this.client;
+    }
 }
 
 var InsightEvents;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.28.13",
+    "version": "2.28.14",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/client/analytics.ts

@@ -393,7 +393,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
                     this.afterSendHooks.map((hook) => hook(eventType, {...parametersToSend, ...remainingPayload}))
                 );
                 await this.deferExecution();
-                return (await this.sendFromBufferWithFetch()) as TResponse | void;
+                return (await this.sendFromBuffer()) as TResponse | void;
             },
         };
     }
@@ -406,11 +406,11 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         return new Promise((resolve) => setTimeout(resolve, 0));
     }
 
-    private async sendFromBufferWithFetch(): Promise<AnyEventResponse | void> {
+    private async sendFromBuffer(): Promise<AnyEventResponse | void> {
         const popped = this.bufferedRequests.shift();
         if (popped) {
             const {eventType, payload} = popped;
-            return this.runtime.client.sendEvent(eventType, payload);
+            return this.runtime.getClientDependingOnEventType(eventType).sendEvent(eventType, payload);
         }
     }
 

package/src/client/analyticsBeaconClient.ts

@@ -5,7 +5,7 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
     constructor(private opts: IAnalyticsClientOptions) {}
 
     public async sendEvent(eventType: EventType, payload: IRequestPayload): Promise<void> {
-        if (!navigator.sendBeacon) {
+        if (!this.isAvailable()) {
             throw new Error(
                 `navigator.sendBeacon is not supported in this browser. Consider adding a polyfill like "sendbeacon-polyfill".`
             );
@@ -25,12 +25,14 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
             ...(preprocessRequest ? await preprocessRequest(defaultOptions, 'analyticsBeacon') : {}),
         };
 
-        // tslint:disable-next-line: no-console
-        console.log(`Sending beacon for "${eventType}" with: `, JSON.stringify(payload));
         navigator.sendBeacon(url, body as any); // https://github.com/microsoft/TypeScript/issues/38715
         return;
     }
 
+    public isAvailable() {
+        return 'sendBeacon' in navigator;
+    }
+
     public deleteHttpCookieVisitorId() {
         return Promise.resolve();
     }

package/src/client/runtimeEnvironment.ts

@@ -4,10 +4,12 @@ import {hasLocalStorage, hasCookieStorage} from '../detector';
 import {AnalyticsRequestClient, IAnalyticsClientOptions, NoopAnalyticsClient} from './analyticsRequestClient';
 import {AnalyticsFetchClient} from './analyticsFetchClient';
 import {BufferedRequest} from './analytics';
+import {EventType} from '../events';
 
 export interface IRuntimeEnvironment {
     storage: WebStorage;
     client: AnalyticsRequestClient;
+    getClientDependingOnEventType(eventType: EventType): AnalyticsRequestClient;
 }
 
 export class BrowserRuntime implements IRuntimeEnvironment {
@@ -33,6 +35,10 @@ export class BrowserRuntime implements IRuntimeEnvironment {
             }
         });
     }
+
+    public getClientDependingOnEventType(eventType: EventType) {
+        return eventType === 'click' && this.beaconClient.isAvailable() ? this.beaconClient : this.client;
+    }
 }
 
 export class NodeJSRuntime implements IRuntimeEnvironment {
@@ -43,9 +49,17 @@ export class NodeJSRuntime implements IRuntimeEnvironment {
         this.storage = storage || new NullStorage();
         this.client = new AnalyticsFetchClient(clientOptions);
     }
+
+    getClientDependingOnEventType(eventType: EventType): AnalyticsRequestClient {
+        return this.client;
+    }
 }
 
 export class NoopRuntime implements IRuntimeEnvironment {
     public storage = new NullStorage();
     public client = new NoopAnalyticsClient();
+
+    getClientDependingOnEventType(eventType: EventType): AnalyticsRequestClient {
+        return this.client;
+    }
 }

package/src/react-native/react-native-runtime.ts

@@ -42,4 +42,8 @@ export class ReactNativeRuntime implements IRuntimeEnvironment {
             },
         });
     }
+
+    public getClientDependingOnEventType() {
+        return this.client;
+    }
 }