coveo.analytics 2.28.8 → 2.28.10

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

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

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.8";
+export declare const libVersion = "2.28.10";

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.8" ;
+const libVersion = "2.28.10" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -961,6 +961,7 @@ const coveoExtensionsKeys = [
     'searchUid',
     'permanentId',
     'contentLocale',
+    'trackingId',
 ];
 const baseMeasurementProtocolKeysMapping = Object.assign(Object.assign(Object.assign(Object.assign({}, globalParamKeysMapping), eventKeysMapping), contextInformationMapping), coveoExtensionsKeys.reduce((all, key) => (Object.assign(Object.assign({}, all), { [key]: key })), {}));
 
@@ -1384,6 +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.setTrackingIdIfTrackingIdNotPresent(currentPayload);
             const cleanPayloadStep = (currentPayload) => this.removeEmptyPayloadValues(currentPayload, eventType);
             const validateParams = (currentPayload) => this.validateParams(currentPayload, eventType);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
@@ -1392,6 +1394,7 @@ class CoveoAnalyticsClient {
                 ? this.processCustomParameters(currentPayload)
                 : this.mapCustomParametersToCustomData(currentPayload);
             const payloadToSend = yield [
+                addTrackingIdStep,
                 cleanPayloadStep,
                 validateParams,
                 processMeasurementProtocolConversionStep,
@@ -1620,6 +1623,23 @@ class CoveoAnalyticsClient {
             return payload;
         }
     }
+    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') {
             return input;

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.8" ;
+var libVersion = "2.28.10" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -1151,6 +1151,7 @@ var coveoExtensionsKeys = [
     'searchUid',
     'permanentId',
     'contentLocale',
+    'trackingId',
 ];
 var baseMeasurementProtocolKeysMapping = __assign(__assign(__assign(__assign({}, globalParamKeysMapping), eventKeysMapping), contextInformationMapping), coveoExtensionsKeys.reduce(function (all, key) {
     var _a;
@@ -83309,12 +83310,15 @@ var CoveoAnalyticsClient = (function () {
     };
     CoveoAnalyticsClient.prototype.resolvePayloadForParameters = function (eventType, parameters) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, usesMeasurementProtocol, cleanPayloadStep, validateParams, processMeasurementProtocolConversionStep, removeUnknownParameters, processCustomParameters, payloadToSend;
+            var _a, usesMeasurementProtocol, addTrackingIdStep, cleanPayloadStep, validateParams, processMeasurementProtocolConversionStep, removeUnknownParameters, processCustomParameters, payloadToSend;
             var _this = this;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         _a = (this.eventTypeMapping[eventType] || {}).usesMeasurementProtocol, usesMeasurementProtocol = _a === void 0 ? false : _a;
+                        addTrackingIdStep = function (currentPayload) {
+                            return _this.setTrackingIdIfTrackingIdNotPresent(currentPayload);
+                        };
                         cleanPayloadStep = function (currentPayload) {
                             return _this.removeEmptyPayloadValues(currentPayload, eventType);
                         };
@@ -83331,6 +83335,7 @@ var CoveoAnalyticsClient = (function () {
                                 : _this.mapCustomParametersToCustomData(currentPayload);
                         };
                         return [4, [
+                                addTrackingIdStep,
                                 cleanPayloadStep,
                                 validateParams,
                                 processMeasurementProtocolConversionStep,
@@ -83662,6 +83667,23 @@ var CoveoAnalyticsClient = (function () {
             return payload;
         }
     };
+    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') {
             return input;

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.8" ;
+const libVersion = "2.28.10" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1023,6 +1023,7 @@ const coveoExtensionsKeys = [
     'searchUid',
     'permanentId',
     'contentLocale',
+    'trackingId',
 ];
 const baseMeasurementProtocolKeysMapping = Object.assign(Object.assign(Object.assign(Object.assign({}, globalParamKeysMapping), eventKeysMapping), contextInformationMapping), coveoExtensionsKeys.reduce((all, key) => (Object.assign(Object.assign({}, all), { [key]: key })), {}));
 
@@ -1385,6 +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.setTrackingIdIfTrackingIdNotPresent(currentPayload);
             const cleanPayloadStep = (currentPayload) => this.removeEmptyPayloadValues(currentPayload, eventType);
             const validateParams = (currentPayload) => this.validateParams(currentPayload, eventType);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
@@ -1393,6 +1395,7 @@ class CoveoAnalyticsClient {
                 ? this.processCustomParameters(currentPayload)
                 : this.mapCustomParametersToCustomData(currentPayload);
             const payloadToSend = yield [
+                addTrackingIdStep,
                 cleanPayloadStep,
                 validateParams,
                 processMeasurementProtocolConversionStep,
@@ -1621,6 +1624,23 @@ class CoveoAnalyticsClient {
             return payload;
         }
     }
+    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') {
             return input;

package/package.json

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

package/src/client/analytics.spec.ts

@@ -439,6 +439,59 @@ describe('Analytics', () => {
         });
     });
 
+    describe('with context_website is set in customData', () => {
+        const contextWebsite = '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: {context_website: contextWebsite}});
+            const [body] = getParsedBodyCalls();
+            expect(body.trackingId).toBe(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);
+        });
+    });
+
     it('should support clearing cookies for visitorId and historyStore', () => {
         const visitorId = 'foo';
         const history = {name: 'foo', time: '123', value: 'bar'};

package/src/client/analytics.ts

@@ -344,6 +344,8 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     async resolvePayloadForParameters(eventType: EventType | string, parameters: any) {
         const {usesMeasurementProtocol = false} = this.eventTypeMapping[eventType] || {};
 
+        const addTrackingIdStep: ProcessPayloadStep = (currentPayload) =>
+            this.setTrackingIdIfTrackingIdNotPresent(currentPayload);
         const cleanPayloadStep: ProcessPayloadStep = (currentPayload) =>
             this.removeEmptyPayloadValues(currentPayload, eventType);
         const validateParams: ProcessPayloadStep = (currentPayload) => this.validateParams(currentPayload, eventType);
@@ -357,6 +359,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
                 : this.mapCustomParametersToCustomData(currentPayload);
 
         const payloadToSend = await [
+            addTrackingIdStep,
             cleanPayloadStep,
             validateParams,
             processMeasurementProtocolConversionStep,
@@ -378,7 +381,6 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
 
         const parametersToSend = await this.resolveParameters(eventType, ...payload);
         const payloadToSend = await this.resolvePayloadForParameters(eventType, parametersToSend);
-
         return {
             eventType: eventTypeToSend,
             payload: payloadToSend,
@@ -623,6 +625,27 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         }
     }
 
+    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 {
         if (typeof input !== 'string') {
             return input;

package/src/client/measurementProtocolMapping/baseMeasurementProtocolMapper.ts

@@ -44,6 +44,7 @@ const coveoExtensionsKeys = [
     'searchUid',
     'permanentId',
     'contentLocale',
+    'trackingId',
 ];
 
 export const baseMeasurementProtocolKeysMapping: {[name: string]: string} = {

package/src/coveoua/simpleanalytics.spec.ts

@@ -387,6 +387,30 @@ describe('simpleanalytics', () => {
             expect(result).toHaveProperty('somedata', 'something');
             expect(result).toHaveProperty('customData.context_website', 'MY_OTHER_WEBSITE');
         });
+
+        it('can set trackingId', async () => {
+            const trackingId = 'yourbestfriend';
+            coveoua('init', 'MYTOKEN');
+            coveoua('set', 'trackingId', trackingId);
+            await coveoua('send', someRandomEventName);
+
+            expect(fetchMock.calls().length).toBe(1);
+            expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/${someRandomEventName}`);
+            expect(JSON.parse(lastCallBody(fetchMock))).toHaveProperty('trackingId', trackingId);
+        });
+
+        it('context_website does not overwrite trackingId', async () => {
+            const trackingId = 'yourbestfriend';
+            const contextWebsite = 'yoursite';
+            coveoua('init', 'MYTOKEN');
+            coveoua('set', 'custom', {context_website: contextWebsite});
+            coveoua('set', 'trackingId', trackingId);
+            await coveoua('send', someRandomEventName);
+
+            expect(fetchMock.calls().length).toBe(1);
+            expect(fetchMock.lastUrl()).toBe(`${analyticsEndpoint}/${someRandomEventName}`);
+            expect(JSON.parse(lastCallBody(fetchMock))).toHaveProperty('trackingId', trackingId);
+        });
     });
 
     describe('onLoad', () => {