coveo.analytics 2.28.22 → 2.28.23

package/dist/definitions/events.d.ts

@@ -57,18 +57,18 @@ export interface SearchEventRequest extends EventBaseRequest {
 export interface PreparedSearchEventRequest extends Omit<SearchEventRequest, 'searchQueryUid'> {
 }
 export interface DocumentInformation {
-    documentUri: string;
+    documentUri?: string;
     documentUriHash: string;
-    collectionName: string;
+    collectionName?: string;
     sourceName: string;
     documentPosition: number;
     actionCause: string;
     searchQueryUid: string;
-    documentTitle: string;
-    documentUrl: string;
-    documentAuthor: string;
-    queryPipeline: string;
-    rankingModifier: string;
+    documentTitle?: string;
+    documentUrl?: string;
+    documentAuthor?: string;
+    queryPipeline?: string;
+    rankingModifier?: string;
 }
 export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {
 }

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.22";
+export declare const libVersion = "2.28.23";

package/dist/library.cjs

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.22" ;
+var libVersion = "2.28.23" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -83061,6 +83061,10 @@ var CoveoAnalyticsClient = (function () {
             this.clear();
             this.runtime.storage = new NullStorage();
         }
+        this.addEventTypeMapping(exports.EventType.view, { newEventType: exports.EventType.view, addClientIdParameter: true });
+        this.addEventTypeMapping(exports.EventType.click, { newEventType: exports.EventType.click, addClientIdParameter: true });
+        this.addEventTypeMapping(exports.EventType.custom, { newEventType: exports.EventType.custom, addClientIdParameter: true });
+        this.addEventTypeMapping(exports.EventType.search, { newEventType: exports.EventType.search, addClientIdParameter: true });
     }
     Object.defineProperty(CoveoAnalyticsClient.prototype, "defaultOptions", {
         get: function () {
@@ -84046,7 +84050,6 @@ var CoveoUA = (function () {
                 return _this.plugins.require(pluginKey, pluginOptions_1);
             });
             this.client.registerBeforeSendEventHook(function (eventType, payload) { return (__assign(__assign({}, payload), _this.params)); });
-            this.client.addEventTypeMapping(exports.EventType.view, { newEventType: exports.EventType.view, addClientIdParameter: true });
         }
         else {
             throw new Error("You must pass either your token or a valid object when you call 'init'");

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.22" ;
+const libVersion = "2.28.23" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1279,6 +1279,10 @@ class CoveoAnalyticsClient {
             this.clear();
             this.runtime.storage = new NullStorage();
         }
+        this.addEventTypeMapping(EventType.view, { newEventType: EventType.view, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.click, { newEventType: EventType.click, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.custom, { newEventType: EventType.custom, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.search, { newEventType: EventType.search, addClientIdParameter: true });
     }
     initRuntime(clientsOptions) {
         if (hasWindow() && hasDocument()) {

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.22" ;
+var libVersion = "2.28.23" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -83061,6 +83061,10 @@ var CoveoAnalyticsClient = (function () {
             this.clear();
             this.runtime.storage = new NullStorage();
         }
+        this.addEventTypeMapping(exports.EventType.view, { newEventType: exports.EventType.view, addClientIdParameter: true });
+        this.addEventTypeMapping(exports.EventType.click, { newEventType: exports.EventType.click, addClientIdParameter: true });
+        this.addEventTypeMapping(exports.EventType.custom, { newEventType: exports.EventType.custom, addClientIdParameter: true });
+        this.addEventTypeMapping(exports.EventType.search, { newEventType: exports.EventType.search, addClientIdParameter: true });
     }
     Object.defineProperty(CoveoAnalyticsClient.prototype, "defaultOptions", {
         get: function () {
@@ -84046,7 +84050,6 @@ var CoveoUA = (function () {
                 return _this.plugins.require(pluginKey, pluginOptions_1);
             });
             this.client.registerBeforeSendEventHook(function (eventType, payload) { return (__assign(__assign({}, payload), _this.params)); });
-            this.client.addEventTypeMapping(exports.EventType.view, { newEventType: exports.EventType.view, addClientIdParameter: true });
         }
         else {
             throw new Error("You must pass either your token or a valid object when you call 'init'");

package/dist/library.mjs

@@ -729,7 +729,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.22" ;
+var libVersion = "2.28.23" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -83059,6 +83059,10 @@ var CoveoAnalyticsClient = (function () {
             this.clear();
             this.runtime.storage = new NullStorage();
         }
+        this.addEventTypeMapping(EventType.view, { newEventType: EventType.view, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.click, { newEventType: EventType.click, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.custom, { newEventType: EventType.custom, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.search, { newEventType: EventType.search, addClientIdParameter: true });
     }
     Object.defineProperty(CoveoAnalyticsClient.prototype, "defaultOptions", {
         get: function () {
@@ -84044,7 +84048,6 @@ var CoveoUA = (function () {
                 return _this.plugins.require(pluginKey, pluginOptions_1);
             });
             this.client.registerBeforeSendEventHook(function (eventType, payload) { return (__assign(__assign({}, payload), _this.params)); });
-            this.client.addEventTypeMapping(EventType.view, { newEventType: EventType.view, addClientIdParameter: true });
         }
         else {
             throw new Error("You must pass either your token or a valid object when you call 'init'");

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.22" ;
+const libVersion = "2.28.23" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1280,6 +1280,10 @@ class CoveoAnalyticsClient {
             this.clear();
             this.runtime.storage = new NullStorage();
         }
+        this.addEventTypeMapping(EventType.view, { newEventType: EventType.view, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.click, { newEventType: EventType.click, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.custom, { newEventType: EventType.custom, addClientIdParameter: true });
+        this.addEventTypeMapping(EventType.search, { newEventType: EventType.search, addClientIdParameter: true });
     }
     initRuntime(clientsOptions) {
         if (hasWindow() && hasDocument()) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.28.22",
+    "version": "2.28.23",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.cjs",
     "module": "dist/browser.mjs",

package/src/client/analytics.spec.ts

@@ -1,4 +1,11 @@
-import {DefaultEventResponse, EventType, ViewEventRequest} from '../events';
+import {
+    ClickEventRequest,
+    CustomEventRequest,
+    DefaultEventResponse,
+    EventType,
+    SearchEventRequest,
+    ViewEventRequest,
+} from '../events';
 import {CoveoAnalyticsClient} from './analytics';
 import {IAnalyticsRequestOptions} from './analyticsRequestClient';
 import {CookieAndLocalStorage, CookieStorage, NullStorage} from '../storage';
@@ -29,6 +36,24 @@ describe('Analytics', () => {
         contentIdValue: 'value',
         language: 'en',
     };
+    const searchEvent: SearchEventRequest = {
+        searchQueryUid: 'sqUid',
+        actionCause: 'interfaceLoad',
+        queryText: 'test',
+        responseTime: 50,
+    };
+    const clickEvent: ClickEventRequest = {
+        searchQueryUid: 'sqUid',
+        actionCause: 'documentOpen',
+        documentPosition: 1,
+        documentUriHash: 'docUriHash',
+        sourceName: 'source',
+    };
+    const customEvent: CustomEventRequest = {
+        eventType: 'custom',
+        eventValue: 'value',
+    };
+
     const eventResponse: DefaultEventResponse = {
         visitId: 'firsttimevisiting',
         visitorId: aVisitorId,
@@ -158,7 +183,46 @@ describe('Analytics', () => {
         const [body] = getParsedBodyCalls();
 
         expect(body).toMatchObject({
-            language: 'en',
+            clientId: '123',
+            userAgent: navigator.userAgent,
+        });
+    });
+
+    it('should append default values to the search event', async () => {
+        mockFetchRequestForEventType(EventType.search);
+
+        await client.sendSearchEvent(searchEvent);
+
+        const [body] = getParsedBodyCalls();
+
+        expect(body).toMatchObject({
+            clientId: '123',
+            userAgent: navigator.userAgent,
+        });
+    });
+
+    it('should append default values to the click event', async () => {
+        mockFetchRequestForEventType(EventType.click);
+
+        await client.sendClickEvent(clickEvent);
+
+        const [body] = getParsedBodyCalls();
+
+        expect(body).toMatchObject({
+            clientId: '123',
+            userAgent: navigator.userAgent,
+        });
+    });
+
+    it('should append default values to the custom event', async () => {
+        mockFetchRequestForEventType(EventType.custom);
+
+        await client.sendCustomEvent(customEvent);
+
+        const [body] = getParsedBodyCalls();
+
+        expect(body).toMatchObject({
+            clientId: '123',
             userAgent: navigator.userAgent,
         });
     });

package/src/client/analytics.ts

@@ -187,6 +187,11 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
             this.clear();
             this.runtime.storage = new NullStorage();
         }
+
+        this.addEventTypeMapping(EventType.view, {newEventType: EventType.view, addClientIdParameter: true});
+        this.addEventTypeMapping(EventType.click, {newEventType: EventType.click, addClientIdParameter: true});
+        this.addEventTypeMapping(EventType.custom, {newEventType: EventType.custom, addClientIdParameter: true});
+        this.addEventTypeMapping(EventType.search, {newEventType: EventType.search, addClientIdParameter: true});
     }
 
     private initRuntime(clientsOptions: IAnalyticsClientOptions) {

package/src/coveoua/simpleanalytics.ts

@@ -48,7 +48,6 @@ export class CoveoUA {
                 ...payload,
                 ...this.params,
             }));
-            this.client.addEventTypeMapping(EventType.view, {newEventType: EventType.view, addClientIdParameter: true});
         } else {
             throw new Error(`You must pass either your token or a valid object when you call 'init'`);
         }

package/src/events.ts

@@ -71,19 +71,19 @@ export interface SearchEventRequest extends EventBaseRequest {
 export interface PreparedSearchEventRequest extends Omit<SearchEventRequest, 'searchQueryUid'> {}
 
 export interface DocumentInformation {
-    documentUri: string;
+    documentUri?: string;
     documentUriHash: string;
-    collectionName: string;
+    collectionName?: string;
     sourceName: string;
     documentPosition: number;
     actionCause: string;
 
     searchQueryUid: string;
-    documentTitle: string;
-    documentUrl: string;
-    documentAuthor: string;
-    queryPipeline: string;
-    rankingModifier: string;
+    documentTitle?: string;
+    documentUrl?: string;
+    documentAuthor?: string;
+    queryPipeline?: string;
+    rankingModifier?: string;
 }
 
 export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {}

package/src/insight/insightClient.spec.ts

@@ -1390,7 +1390,7 @@ describe('InsightClient', () => {
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, expectedMetadata);
         });
 
-        it.only('should send proper payload for #createArticle', async () => {
+        it('should send proper payload for #createArticle', async () => {
             const exampleCreateArticleMetadata = {
                 articleType: 'Knowledge__kav',
                 triggeredBy: 'CreateArticleButton',