coveo.analytics 2.28.9 → 2.28.11

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

@@ -111,7 +111,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     private lowercaseKeys;
     private validateParams;
     private ensureAnonymousUserWhenUsingApiKey;
-    private setTrackingIdFromContextWebsiteIfTrackingIdNotPresent;
+    private setTrackingIdIfTrackingIdNotPresent;
     private limit;
     private get baseUrl();
 }

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.9";
+export declare const libVersion = "2.28.11";

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.9" ;
+const libVersion = "2.28.11" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1385,7 +1385,7 @@ class CoveoAnalyticsClient {
     resolvePayloadForParameters(eventType, parameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const { usesMeasurementProtocol = false } = this.eventTypeMapping[eventType] || {};
-            const addTrackingIdStep = (currentPayload) => this.setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(currentPayload);
+            const addTrackingIdStep = (currentPayload) => this.setTrackingIdIfTrackingIdNotPresent(currentPayload);
             const cleanPayloadStep = (currentPayload) => this.removeEmptyPayloadValues(currentPayload, eventType);
             const validateParams = (currentPayload) => this.validateParams(currentPayload, eventType);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
@@ -1623,15 +1623,22 @@ class CoveoAnalyticsClient {
             return payload;
         }
     }
-    setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(payload) {
-        const { trackingId, custom } = payload, rest = __rest(payload, ["trackingId", "custom"]);
-        if (!trackingId && custom && isObject(custom) && 'context_website' in custom) {
-            rest['trackingId'] = custom.context_website;
-            return Object.assign({ custom: custom }, rest);
-        }
-        else {
+    setTrackingIdIfTrackingIdNotPresent(payload) {
+        const { trackingId } = payload, rest = __rest(payload, ["trackingId"]);
+        if (trackingId) {
             return payload;
         }
+        if (rest.hasOwnProperty('custom') && isObject(rest.custom)) {
+            if (rest.custom.hasOwnProperty('context_website') || rest.custom.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.custom.context_website || rest.custom.siteName;
+            }
+        }
+        if (rest.hasOwnProperty('customData') && isObject(rest.customData)) {
+            if (rest.customData.hasOwnProperty('context_website') || rest.customData.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.customData.context_website || rest.customData.siteName;
+            }
+        }
+        return rest;
     }
     limit(input, length) {
         if (typeof input !== 'string') {

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.9" ;
+var libVersion = "2.28.11" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -83317,7 +83317,7 @@ var CoveoAnalyticsClient = (function () {
                     case 0:
                         _a = (this.eventTypeMapping[eventType] || {}).usesMeasurementProtocol, usesMeasurementProtocol = _a === void 0 ? false : _a;
                         addTrackingIdStep = function (currentPayload) {
-                            return _this.setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(currentPayload);
+                            return _this.setTrackingIdIfTrackingIdNotPresent(currentPayload);
                         };
                         cleanPayloadStep = function (currentPayload) {
                             return _this.removeEmptyPayloadValues(currentPayload, eventType);
@@ -83667,15 +83667,22 @@ var CoveoAnalyticsClient = (function () {
             return payload;
         }
     };
-    CoveoAnalyticsClient.prototype.setTrackingIdFromContextWebsiteIfTrackingIdNotPresent = function (payload) {
-        var trackingId = payload.trackingId, custom = payload.custom, rest = __rest(payload, ["trackingId", "custom"]);
-        if (!trackingId && custom && isObject(custom) && 'context_website' in custom) {
-            rest['trackingId'] = custom.context_website;
-            return __assign({ custom: custom }, rest);
-        }
-        else {
+    CoveoAnalyticsClient.prototype.setTrackingIdIfTrackingIdNotPresent = function (payload) {
+        var trackingId = payload.trackingId, rest = __rest(payload, ["trackingId"]);
+        if (trackingId) {
             return payload;
         }
+        if (rest.hasOwnProperty('custom') && isObject(rest.custom)) {
+            if (rest.custom.hasOwnProperty('context_website') || rest.custom.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.custom.context_website || rest.custom.siteName;
+            }
+        }
+        if (rest.hasOwnProperty('customData') && isObject(rest.customData)) {
+            if (rest.customData.hasOwnProperty('context_website') || rest.customData.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.customData.context_website || rest.customData.siteName;
+            }
+        }
+        return rest;
     };
     CoveoAnalyticsClient.prototype.limit = function (input, length) {
         if (typeof input !== 'string') {

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.9" ;
+const libVersion = "2.28.11" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1386,7 +1386,7 @@ class CoveoAnalyticsClient {
     resolvePayloadForParameters(eventType, parameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const { usesMeasurementProtocol = false } = this.eventTypeMapping[eventType] || {};
-            const addTrackingIdStep = (currentPayload) => this.setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(currentPayload);
+            const addTrackingIdStep = (currentPayload) => this.setTrackingIdIfTrackingIdNotPresent(currentPayload);
             const cleanPayloadStep = (currentPayload) => this.removeEmptyPayloadValues(currentPayload, eventType);
             const validateParams = (currentPayload) => this.validateParams(currentPayload, eventType);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
@@ -1624,15 +1624,22 @@ class CoveoAnalyticsClient {
             return payload;
         }
     }
-    setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(payload) {
-        const { trackingId, custom } = payload, rest = __rest(payload, ["trackingId", "custom"]);
-        if (!trackingId && custom && isObject(custom) && 'context_website' in custom) {
-            rest['trackingId'] = custom.context_website;
-            return Object.assign({ custom: custom }, rest);
-        }
-        else {
+    setTrackingIdIfTrackingIdNotPresent(payload) {
+        const { trackingId } = payload, rest = __rest(payload, ["trackingId"]);
+        if (trackingId) {
             return payload;
         }
+        if (rest.hasOwnProperty('custom') && isObject(rest.custom)) {
+            if (rest.custom.hasOwnProperty('context_website') || rest.custom.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.custom.context_website || rest.custom.siteName;
+            }
+        }
+        if (rest.hasOwnProperty('customData') && isObject(rest.customData)) {
+            if (rest.customData.hasOwnProperty('context_website') || rest.customData.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.customData.context_website || rest.customData.siteName;
+            }
+        }
+        return rest;
     }
     limit(input, length) {
         if (typeof input !== 'string') {

package/package.json

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

package/src/client/analytics.spec.ts

@@ -439,9 +439,9 @@ describe('Analytics', () => {
         });
     });
 
-    describe('with context_website is set', () => {
+    describe('with context_website is set in customData', () => {
         const contextWebsite = 'yourbestfriend.com';
-        const trackingId = 'yourfavaritefood.ca ';
+        const trackingId = 'yourfavoritefood.ca ';
         beforeEach(() => {
             client = new CoveoAnalyticsClient({
                 token: 'xtoken',
@@ -452,13 +452,41 @@ describe('Analytics', () => {
         });
 
         it('should set trackingId when trackingId is not specified', async () => {
-            await client.sendEvent(EventType.view, {custom: {context_website: contextWebsite}});
+            await client.sendEvent(EventType.view, {customData: {context_website: contextWebsite}});
             const [body] = getParsedBodyCalls();
             expect(body.trackingId).toBe(contextWebsite);
         });
 
-        it('should not set trackingId when trackingId is specified', async () => {
-            await client.sendEvent(EventType.view, {trackingId: trackingId, custom: {context_website: contextWebsite}});
+        it('should not overwrite trackingId when trackingId is specified', async () => {
+            await client.sendEvent(EventType.view, {
+                trackingId: trackingId,
+                customData: {context_website: contextWebsite},
+            });
+            const [body] = getParsedBodyCalls();
+            expect(body.trackingId).toBe(trackingId);
+        });
+    });
+
+    describe('with siteName is set in customData', () => {
+        const website = 'yourbestfriend.com';
+        const trackingId = 'yourfavoritefood.ca ';
+        beforeEach(() => {
+            client = new CoveoAnalyticsClient({
+                token: 'xtoken',
+                endpoint: anEndpoint,
+                version: A_VERSION,
+            });
+            mockFetchRequestForEventType(EventType.view);
+        });
+
+        it('should set trackingId when trackingId is not specified', async () => {
+            await client.sendEvent(EventType.view, {customData: {siteName: website}});
+            const [body] = getParsedBodyCalls();
+            expect(body.trackingId).toBe(website);
+        });
+
+        it('should not overwrite trackingId when trackingId is specified', async () => {
+            await client.sendEvent(EventType.view, {trackingId: trackingId, customData: {siteName: website}});
             const [body] = getParsedBodyCalls();
             expect(body.trackingId).toBe(trackingId);
         });

package/src/client/analytics.ts

@@ -345,7 +345,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         const {usesMeasurementProtocol = false} = this.eventTypeMapping[eventType] || {};
 
         const addTrackingIdStep: ProcessPayloadStep = (currentPayload) =>
-            this.setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(currentPayload);
+            this.setTrackingIdIfTrackingIdNotPresent(currentPayload);
         const cleanPayloadStep: ProcessPayloadStep = (currentPayload) =>
             this.removeEmptyPayloadValues(currentPayload, eventType);
         const validateParams: ProcessPayloadStep = (currentPayload) => this.validateParams(currentPayload, eventType);
@@ -625,14 +625,25 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         }
     }
 
-    private setTrackingIdFromContextWebsiteIfTrackingIdNotPresent(payload: IRequestPayload): IRequestPayload {
-        const {trackingId, custom, ...rest} = payload;
-        if (!trackingId && custom && isObject(custom) && 'context_website' in custom) {
-            rest['trackingId'] = custom.context_website;
-            return {custom: custom, ...rest};
-        } else {
+    private setTrackingIdIfTrackingIdNotPresent(payload: IRequestPayload): IRequestPayload {
+        const {trackingId, ...rest} = payload;
+        if (trackingId) {
             return payload;
         }
+
+        if (rest.hasOwnProperty('custom') && isObject(rest.custom)) {
+            if (rest.custom.hasOwnProperty('context_website') || rest.custom.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.custom.context_website || rest.custom.siteName;
+            }
+        }
+
+        if (rest.hasOwnProperty('customData') && isObject(rest.customData)) {
+            if (rest.customData.hasOwnProperty('context_website') || rest.customData.hasOwnProperty('siteName')) {
+                rest['trackingId'] = rest.customData.context_website || rest.customData.siteName;
+            }
+        }
+
+        return rest;
     }
 
     private limit(input: string, length: number): string | undefined | null {