coveo.analytics 2.28.24 → 2.29.1

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

@@ -10,7 +10,5 @@ export declare class AnalyticsBeaconClient implements AnalyticsRequestClient {
     private encodeForEventType;
     private getQueryParamsForEventType;
     private isEventTypeLegacy;
-    private encodeForLegacyType;
-    private encodeForFormUrlEncoded;
-    private encodeValue;
+    private encodeEventToJson;
 }

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.24";
+export declare const libVersion = "2.29.1";

package/dist/library.cjs

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.24" ;
+var libVersion = "2.29.1" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -1268,8 +1268,8 @@ var AnalyticsBeaconClient = (function () {
     };
     AnalyticsBeaconClient.prototype.encodeForEventType = function (eventType, payload) {
         return this.isEventTypeLegacy(eventType)
-            ? this.encodeForLegacyType(eventType, payload)
-            : this.encodeForFormUrlEncoded(__assign({ access_token: this.opts.token }, payload));
+            ? this.encodeEventToJson(eventType, payload)
+            : this.encodeEventToJson(eventType, payload, this.opts.token);
     };
     AnalyticsBeaconClient.prototype.getQueryParamsForEventType = function (eventType) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1295,20 +1295,12 @@ var AnalyticsBeaconClient = (function () {
     AnalyticsBeaconClient.prototype.isEventTypeLegacy = function (eventType) {
         return [exports.EventType.click, exports.EventType.custom, exports.EventType.search, exports.EventType.view].indexOf(eventType) !== -1;
     };
-    AnalyticsBeaconClient.prototype.encodeForLegacyType = function (eventType, payload) {
-        return "".concat(eventType, "Event=").concat(encodeURIComponent(JSON.stringify(payload)));
-    };
-    AnalyticsBeaconClient.prototype.encodeForFormUrlEncoded = function (payload) {
-        var _this = this;
-        return Object.keys(payload)
-            .filter(function (key) { return !!payload[key]; })
-            .map(function (key) { return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(_this.encodeValue(payload[key]))); })
-            .join('&');
-    };
-    AnalyticsBeaconClient.prototype.encodeValue = function (value) {
-        return typeof value === 'number' || typeof value === 'string' || typeof value === 'boolean'
-            ? value
-            : JSON.stringify(value);
+    AnalyticsBeaconClient.prototype.encodeEventToJson = function (eventType, payload, access_token) {
+        var encoded = "".concat(eventType, "Event=").concat(encodeURIComponent(JSON.stringify(payload)));
+        if (access_token) {
+            encoded = "access_token=".concat(encodeURIComponent(access_token), "&").concat(encoded);
+        }
+        return encoded;
     };
     return AnalyticsBeaconClient;
 }());
@@ -83115,7 +83107,7 @@ var CoveoAnalyticsClient = (function () {
                 switch (_b.label) {
                     case 0:
                         _b.trys.push([0, 3, , 4]);
-                        _a = this.extractClientIdFromLink(window.location.href);
+                        _a = (hasWindow() && this.extractClientIdFromLink(window.location.href));
                         if (_a) return [3, 2];
                         return [4, this.storage.getItem('visitorId')];
                     case 1:

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.24" ;
+const libVersion = "2.29.1" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1052,8 +1052,8 @@ class AnalyticsBeaconClient {
     }
     encodeForEventType(eventType, payload) {
         return this.isEventTypeLegacy(eventType)
-            ? this.encodeForLegacyType(eventType, payload)
-            : this.encodeForFormUrlEncoded(Object.assign({ access_token: this.opts.token }, payload));
+            ? this.encodeEventToJson(eventType, payload)
+            : this.encodeEventToJson(eventType, payload, this.opts.token);
     }
     getQueryParamsForEventType(eventType) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1071,19 +1071,12 @@ class AnalyticsBeaconClient {
     isEventTypeLegacy(eventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     }
-    encodeForLegacyType(eventType, payload) {
-        return `${eventType}Event=${encodeURIComponent(JSON.stringify(payload))}`;
-    }
-    encodeForFormUrlEncoded(payload) {
-        return Object.keys(payload)
-            .filter((key) => !!payload[key])
-            .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(this.encodeValue(payload[key]))}`)
-            .join('&');
-    }
-    encodeValue(value) {
-        return typeof value === 'number' || typeof value === 'string' || typeof value === 'boolean'
-            ? value
-            : JSON.stringify(value);
+    encodeEventToJson(eventType, payload, access_token) {
+        let encoded = `${eventType}Event=${encodeURIComponent(JSON.stringify(payload))}`;
+        if (access_token) {
+            encoded = `access_token=${encodeURIComponent(access_token)}&${encoded}`;
+        }
+        return encoded;
     }
 }
 
@@ -1303,7 +1296,7 @@ class CoveoAnalyticsClient {
     determineVisitorId() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                return (this.extractClientIdFromLink(window.location.href) ||
+                return ((hasWindow() && this.extractClientIdFromLink(window.location.href)) ||
                     (yield this.storage.getItem('visitorId')) ||
                     v4());
             }

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.24" ;
+var libVersion = "2.29.1" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -1268,8 +1268,8 @@ var AnalyticsBeaconClient = (function () {
     };
     AnalyticsBeaconClient.prototype.encodeForEventType = function (eventType, payload) {
         return this.isEventTypeLegacy(eventType)
-            ? this.encodeForLegacyType(eventType, payload)
-            : this.encodeForFormUrlEncoded(__assign({ access_token: this.opts.token }, payload));
+            ? this.encodeEventToJson(eventType, payload)
+            : this.encodeEventToJson(eventType, payload, this.opts.token);
     };
     AnalyticsBeaconClient.prototype.getQueryParamsForEventType = function (eventType) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1295,20 +1295,12 @@ var AnalyticsBeaconClient = (function () {
     AnalyticsBeaconClient.prototype.isEventTypeLegacy = function (eventType) {
         return [exports.EventType.click, exports.EventType.custom, exports.EventType.search, exports.EventType.view].indexOf(eventType) !== -1;
     };
-    AnalyticsBeaconClient.prototype.encodeForLegacyType = function (eventType, payload) {
-        return "".concat(eventType, "Event=").concat(encodeURIComponent(JSON.stringify(payload)));
-    };
-    AnalyticsBeaconClient.prototype.encodeForFormUrlEncoded = function (payload) {
-        var _this = this;
-        return Object.keys(payload)
-            .filter(function (key) { return !!payload[key]; })
-            .map(function (key) { return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(_this.encodeValue(payload[key]))); })
-            .join('&');
-    };
-    AnalyticsBeaconClient.prototype.encodeValue = function (value) {
-        return typeof value === 'number' || typeof value === 'string' || typeof value === 'boolean'
-            ? value
-            : JSON.stringify(value);
+    AnalyticsBeaconClient.prototype.encodeEventToJson = function (eventType, payload, access_token) {
+        var encoded = "".concat(eventType, "Event=").concat(encodeURIComponent(JSON.stringify(payload)));
+        if (access_token) {
+            encoded = "access_token=".concat(encodeURIComponent(access_token), "&").concat(encoded);
+        }
+        return encoded;
     };
     return AnalyticsBeaconClient;
 }());
@@ -83115,7 +83107,7 @@ var CoveoAnalyticsClient = (function () {
                 switch (_b.label) {
                     case 0:
                         _b.trys.push([0, 3, , 4]);
-                        _a = this.extractClientIdFromLink(window.location.href);
+                        _a = (hasWindow() && this.extractClientIdFromLink(window.location.href));
                         if (_a) return [3, 2];
                         return [4, this.storage.getItem('visitorId')];
                     case 1:

package/dist/library.mjs

@@ -729,7 +729,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.24" ;
+var libVersion = "2.29.1" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -1266,8 +1266,8 @@ var AnalyticsBeaconClient = (function () {
     };
     AnalyticsBeaconClient.prototype.encodeForEventType = function (eventType, payload) {
         return this.isEventTypeLegacy(eventType)
-            ? this.encodeForLegacyType(eventType, payload)
-            : this.encodeForFormUrlEncoded(__assign({ access_token: this.opts.token }, payload));
+            ? this.encodeEventToJson(eventType, payload)
+            : this.encodeEventToJson(eventType, payload, this.opts.token);
     };
     AnalyticsBeaconClient.prototype.getQueryParamsForEventType = function (eventType) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1293,20 +1293,12 @@ var AnalyticsBeaconClient = (function () {
     AnalyticsBeaconClient.prototype.isEventTypeLegacy = function (eventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     };
-    AnalyticsBeaconClient.prototype.encodeForLegacyType = function (eventType, payload) {
-        return "".concat(eventType, "Event=").concat(encodeURIComponent(JSON.stringify(payload)));
-    };
-    AnalyticsBeaconClient.prototype.encodeForFormUrlEncoded = function (payload) {
-        var _this = this;
-        return Object.keys(payload)
-            .filter(function (key) { return !!payload[key]; })
-            .map(function (key) { return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(_this.encodeValue(payload[key]))); })
-            .join('&');
-    };
-    AnalyticsBeaconClient.prototype.encodeValue = function (value) {
-        return typeof value === 'number' || typeof value === 'string' || typeof value === 'boolean'
-            ? value
-            : JSON.stringify(value);
+    AnalyticsBeaconClient.prototype.encodeEventToJson = function (eventType, payload, access_token) {
+        var encoded = "".concat(eventType, "Event=").concat(encodeURIComponent(JSON.stringify(payload)));
+        if (access_token) {
+            encoded = "access_token=".concat(encodeURIComponent(access_token), "&").concat(encoded);
+        }
+        return encoded;
     };
     return AnalyticsBeaconClient;
 }());
@@ -83113,7 +83105,7 @@ var CoveoAnalyticsClient = (function () {
                 switch (_b.label) {
                     case 0:
                         _b.trys.push([0, 3, , 4]);
-                        _a = this.extractClientIdFromLink(window.location.href);
+                        _a = (hasWindow() && this.extractClientIdFromLink(window.location.href));
                         if (_a) return [3, 2];
                         return [4, this.storage.getItem('visitorId')];
                     case 1:

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.24" ;
+const libVersion = "2.29.1" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1114,8 +1114,8 @@ class AnalyticsBeaconClient {
     }
     encodeForEventType(eventType, payload) {
         return this.isEventTypeLegacy(eventType)
-            ? this.encodeForLegacyType(eventType, payload)
-            : this.encodeForFormUrlEncoded(Object.assign({ access_token: this.opts.token }, payload));
+            ? this.encodeEventToJson(eventType, payload)
+            : this.encodeEventToJson(eventType, payload, this.opts.token);
     }
     getQueryParamsForEventType(eventType) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1133,19 +1133,12 @@ class AnalyticsBeaconClient {
     isEventTypeLegacy(eventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     }
-    encodeForLegacyType(eventType, payload) {
-        return `${eventType}Event=${encodeURIComponent(JSON.stringify(payload))}`;
-    }
-    encodeForFormUrlEncoded(payload) {
-        return Object.keys(payload)
-            .filter((key) => !!payload[key])
-            .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(this.encodeValue(payload[key]))}`)
-            .join('&');
-    }
-    encodeValue(value) {
-        return typeof value === 'number' || typeof value === 'string' || typeof value === 'boolean'
-            ? value
-            : JSON.stringify(value);
+    encodeEventToJson(eventType, payload, access_token) {
+        let encoded = `${eventType}Event=${encodeURIComponent(JSON.stringify(payload))}`;
+        if (access_token) {
+            encoded = `access_token=${encodeURIComponent(access_token)}&${encoded}`;
+        }
+        return encoded;
     }
 }
 
@@ -1304,7 +1297,7 @@ class CoveoAnalyticsClient {
     determineVisitorId() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                return (this.extractClientIdFromLink(window.location.href) ||
+                return ((hasWindow() && this.extractClientIdFromLink(window.location.href)) ||
                     (yield this.storage.getItem('visitorId')) ||
                     v4());
             }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.28.24",
+    "version": "2.29.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.cjs",
     "module": "dist/browser.mjs",
@@ -11,8 +11,8 @@
         "lint:fix": "prettier --write .",
         "build": "rollup -c",
         "start": "rollup -c -w --environment SERVE",
-        "test": "jest --clearCache && jest --coverage",
-        "test:watch": "jest --clearCache && jest --watch",
+        "test": "jest --clearCache && jest --coverage --silent",
+        "test:watch": "jest --clearCache && jest --watch --silent",
         "prepare-deploy": "mkdir -p deploy && cp dist/coveoua*.js dist/coveoua*.js.map deploy",
         "clean": "rimraf -rf dist dist_test coverage"
     },

package/src/client/analytics.ts

@@ -214,7 +214,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     private async determineVisitorId() {
         try {
             return (
-                this.extractClientIdFromLink(window.location.href) ||
+                (hasWindow() && this.extractClientIdFromLink(window.location.href)) ||
                 (await this.storage.getItem('visitorId')) ||
                 uuidv4()
             );

package/src/client/analyticsBeaconClient.spec.ts

@@ -41,7 +41,7 @@ describe('AnalyticsBeaconClient', () => {
             `${baseUrl}/analytics/custom?access_token=👛&visitorId=${currentVisitorId}&discardVisitInfo=true`,
             expect.anything()
         );
-        expect(await getSendBeaconFirstCallBlobArgument()).toBe(`customEvent=${encodeURIComponent(`{"wow":"ok"}`)}`);
+        expect(await getSendBeaconFirstCallBlobArgument()).toBe(`customEvent=${encodeURIComponent('{"wow":"ok"}')}`);
     });
 
     it('can send a collect event with the proper payload', async () => {
@@ -66,7 +66,9 @@ describe('AnalyticsBeaconClient', () => {
             expect.anything()
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(
-            'access_token=%F0%9F%91%9B&pr1a=value&to%20encode=to%20encode'
+            `access_token=${encodeURIComponent('👛')}&collectEvent=${encodeURIComponent(
+                '{"pr1a":"value","to encode":"to encode"}'
+            )}`
         );
     });
 
@@ -95,7 +97,7 @@ describe('AnalyticsBeaconClient', () => {
             expect.anything()
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(
-            `access_token=%F0%9F%91%9B&value=${encodeURIComponent(JSON.stringify({subvalue: 'ok'}))}`
+            `access_token=${encodeURIComponent('👛')}&collectEvent=${encodeURIComponent('{"value":{"subvalue":"ok"}}')}`
         );
     });
 
@@ -131,7 +133,7 @@ describe('AnalyticsBeaconClient', () => {
 
             expect(clientOrigin!).toBe('analyticsBeacon');
             expect(sendBeaconMock).toHaveBeenCalledWith(processedRequest.url, expect.anything());
-            expect(await getSendBeaconFirstCallBlobArgument()).toContain('test=custom');
+            expect(await getSendBeaconFirstCallBlobArgument()).toContain('%22test%22%3A%22custom%22');
         });
 
         it('to modify the request body as a JSON string for a collect event', async () => {
@@ -144,7 +146,9 @@ describe('AnalyticsBeaconClient', () => {
             });
 
             await client.sendEvent(EventType.collect, {foo: 'bar'});
-            expect(await getSendBeaconFirstCallBlobArgument()).toContain(`foo=baz`);
+            expect(await getSendBeaconFirstCallBlobArgument()).toBe(
+                'access_token=%F0%9F%91%9B&collectEvent=%7B%22foo%22%3A%22baz%22%7D'
+            );
         });
 
         it('to modify the request body as a JSON string for a click event', async () => {
@@ -158,7 +162,7 @@ describe('AnalyticsBeaconClient', () => {
 
             await client.sendEvent(EventType.click, {actionCause: 'foo'});
             expect(await getSendBeaconFirstCallBlobArgument()).toContain(
-                `clickEvent=${encodeURIComponent(`{"actionCause":"bar"}`)}`
+                `clickEvent=${encodeURIComponent('{"actionCause":"bar"}')}`
             );
         });
 
@@ -172,7 +176,7 @@ describe('AnalyticsBeaconClient', () => {
 
             await client.sendEvent(EventType.click, {actionCause: 'foo'});
             expect(await getSendBeaconFirstCallBlobArgument()).toContain(
-                `clickEvent=${encodeURIComponent(`{"actionCause":"foo","aNewProperty":"bar"}`)}`
+                `clickEvent=${encodeURIComponent('{"actionCause":"foo","aNewProperty":"bar"}')}`
             );
         });
 

package/src/client/analyticsBeaconClient.ts

@@ -68,11 +68,8 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
 
     private encodeForEventType(eventType: EventType, payload: IRequestPayload): string {
         return this.isEventTypeLegacy(eventType)
-            ? this.encodeForLegacyType(eventType, payload)
-            : this.encodeForFormUrlEncoded({
-                  access_token: this.opts.token,
-                  ...payload,
-              });
+            ? this.encodeEventToJson(eventType, payload)
+            : this.encodeEventToJson(eventType, payload, this.opts.token);
     }
 
     private async getQueryParamsForEventType(eventType: EventType): Promise<string> {
@@ -91,20 +88,11 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     }
 
-    private encodeForLegacyType(eventType: EventType, payload: IRequestPayload): string {
-        return `${eventType}Event=${encodeURIComponent(JSON.stringify(payload))}`;
-    }
-
-    private encodeForFormUrlEncoded(payload: IRequestPayload): string {
-        return Object.keys(payload)
-            .filter((key) => !!payload[key])
-            .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(this.encodeValue(payload[key]))}`)
-            .join('&');
-    }
-
-    private encodeValue(value: any) {
-        return typeof value === 'number' || typeof value === 'string' || typeof value === 'boolean'
-            ? value
-            : JSON.stringify(value);
+    private encodeEventToJson(eventType: EventType, payload: IRequestPayload, access_token?: string): string {
+        let encoded = `${eventType}Event=${encodeURIComponent(JSON.stringify(payload))}`;
+        if (access_token) {
+            encoded = `access_token=${encodeURIComponent(access_token)}&${encoded}`;
+        }
+        return encoded;
     }
 }