coveo.analytics 2.20.8 → 2.20.9

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -13,6 +13,8 @@ export interface SearchPageClientProvider {
     getLanguage: () => string;
     getIsAnonymous: () => boolean;
     getFacetState?: () => FacetStateMetadata[];
+    getSplitTestRunName?: () => string | undefined;
+    getSplitTestRunVersion?: () => string | undefined;
 }
 export interface SearchPageClientOptions extends ClientOptions {
     enableAnalytics: boolean;
@@ -98,4 +100,5 @@ export declare class CoveoSearchPageClient {
     private getBaseEventRequest;
     private getOrigins;
     private getClientId;
+    private getSplitTestRun;
 }

package/dist/library.es.js

@@ -1492,7 +1492,7 @@ class CoveoSearchPageClient {
     getBaseEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
-            return Object.assign(Object.assign({}, this.getOrigins()), { customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous(), clientId: yield this.getClientId() });
+            return Object.assign(Object.assign(Object.assign({}, this.getOrigins()), this.getSplitTestRun()), { customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous(), clientId: yield this.getClientId() });
         });
     }
     getOrigins() {
@@ -1509,6 +1509,11 @@ class CoveoSearchPageClient {
             ? this.coveoAnalyticsClient.getCurrentVisitorId()
             : undefined;
     }
+    getSplitTestRun() {
+        const splitTestRunName = this.provider.getSplitTestRunName ? this.provider.getSplitTestRunName() : '';
+        const splitTestRunVersion = this.provider.getSplitTestRunVersion ? this.provider.getSplitTestRunVersion() : '';
+        return Object.assign(Object.assign({}, (splitTestRunName && { splitTestRunName })), (splitTestRunVersion && { splitTestRunVersion }));
+    }
 }
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;

package/dist/library.js

@@ -84008,7 +84008,7 @@ var CoveoSearchPageClient = (function () {
                 switch (_c.label) {
                     case 0:
                         customData = __assign(__assign({}, this.provider.getBaseMetadata()), metadata);
-                        _a = [__assign({}, this.getOrigins())];
+                        _a = [__assign(__assign({}, this.getOrigins()), this.getSplitTestRun())];
                         _b = { customData: customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous() };
                         return [4, this.getClientId()];
                     case 1: return [2, __assign.apply(void 0, _a.concat([(_b.clientId = _c.sent(), _b)]))];
@@ -84030,6 +84030,11 @@ var CoveoSearchPageClient = (function () {
             ? this.coveoAnalyticsClient.getCurrentVisitorId()
             : undefined;
     };
+    CoveoSearchPageClient.prototype.getSplitTestRun = function () {
+        var splitTestRunName = this.provider.getSplitTestRunName ? this.provider.getSplitTestRunName() : '';
+        var splitTestRunVersion = this.provider.getSplitTestRunVersion ? this.provider.getSplitTestRunVersion() : '';
+        return __assign(__assign({}, (splitTestRunName && { splitTestRunName: splitTestRunName })), (splitTestRunVersion && { splitTestRunVersion: splitTestRunVersion }));
+    };
     return CoveoSearchPageClient;
 }());
 

package/package.json

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

package/src/searchPage/searchPageClient.spec.ts

@@ -69,6 +69,8 @@ describe('SearchPageClient', () => {
         getLanguage: () => 'en',
         getFacetState: () => fakeFacetState,
         getIsAnonymous: () => false,
+        getSplitTestRunName: () => 'split-test-run-something',
+        getSplitTestRunVersion: () => 'split-test-run-something/foo',
     };
 
     beforeEach(() => {
@@ -96,6 +98,11 @@ describe('SearchPageClient', () => {
         originLevel3: 'origin-level-3',
     });
 
+    const expectSplitTestRun = () => ({
+        splitTestRunName: 'split-test-run-something',
+        splitTestRunVersion: 'split-test-run-something/foo',
+    });
+
     const expectMatchPayload = (actionCause: SearchPageEvents, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
         const customData = {foo: 'bar', ...meta};
@@ -109,6 +116,7 @@ describe('SearchPageClient', () => {
             language: 'en',
             clientId: 'visitor-id',
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 
@@ -123,6 +131,7 @@ describe('SearchPageClient', () => {
             clientId: 'visitor-id',
             ...doc,
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 
@@ -137,6 +146,7 @@ describe('SearchPageClient', () => {
             language: 'en',
             clientId: 'visitor-id',
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 
@@ -151,6 +161,7 @@ describe('SearchPageClient', () => {
             language: 'en',
             clientId: 'visitor-id',
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 

package/src/searchPage/searchPageClient.ts

@@ -42,6 +42,8 @@ export interface SearchPageClientProvider {
     getLanguage: () => string;
     getIsAnonymous: () => boolean;
     getFacetState?: () => FacetStateMetadata[];
+    getSplitTestRunName?: () => string | undefined;
+    getSplitTestRunVersion?: () => string | undefined;
 }
 
 export interface SearchPageClientOptions extends ClientOptions {
@@ -417,6 +419,7 @@ export class CoveoSearchPageClient {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
         return {
             ...this.getOrigins(),
+            ...this.getSplitTestRun(),
             customData,
             language: this.provider.getLanguage(),
             facetState: this.provider.getFacetState ? this.provider.getFacetState() : [],
@@ -439,4 +442,13 @@ export class CoveoSearchPageClient {
             ? this.coveoAnalyticsClient.getCurrentVisitorId()
             : undefined;
     }
+
+    private getSplitTestRun() {
+        const splitTestRunName = this.provider.getSplitTestRunName ? this.provider.getSplitTestRunName() : '';
+        const splitTestRunVersion = this.provider.getSplitTestRunVersion ? this.provider.getSplitTestRunVersion() : '';
+        return {
+            ...(splitTestRunName && {splitTestRunName}),
+            ...(splitTestRunVersion && {splitTestRunVersion}),
+        };
+    }
 }