coveo.analytics 2.28.21 → 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/insight/insightClient.d.ts

@@ -1,7 +1,7 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
 import { DocumentIdentifier, FacetStateMetadata, GeneratedAnswerBaseMeta, GeneratedAnswerCitationMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerStreamEndMeta, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
-import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata } from './insightEvents';
+import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata, CreateArticleMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -54,6 +54,7 @@ export declare class CoveoInsightClient {
     logShowFollowingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCaseSendEmail(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;

package/dist/definitions/insight/insightEvents.d.ts

@@ -6,7 +6,8 @@ export declare enum InsightEvents {
     showPrecedingSessions = "showPrecedingSessions",
     showFollowingSessions = "showFollowingSessions",
     clickViewedDocument = "clickViewedDocument",
-    clickPageView = "clickPageView"
+    clickPageView = "clickPageView",
+    createArticle = "createArticle"
 }
 export interface CaseMetadata {
     caseId?: string;
@@ -28,6 +29,10 @@ export interface UserActionsPageViewMetadata {
     contentIdKey: string;
     contentIdValue: string;
 }
+export interface CreateArticleMetadata {
+    articleType: string;
+    triggeredBy: string;
+}
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {
 }
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.21";
+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.21" ;
+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'");
@@ -84203,6 +84206,7 @@ exports.InsightEvents = void 0;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(exports.InsightEvents || (exports.InsightEvents = {}));
 
 var _a;
@@ -84325,12 +84329,6 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.showLessFoldedResults] = 'folding',
-    _a[exports.InsightEvents.expandToFullUI] = 'interface',
-    _a[exports.InsightEvents.openUserActions] = 'User Actions',
-    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
-    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
-    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
-    _a[exports.InsightEvents.clickPageView] = 'User Actions',
     _a[exports.SearchPageEvents.caseDetach] = 'case',
     _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
@@ -84341,6 +84339,13 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
+    _a[exports.InsightEvents.expandToFullUI] = 'interface',
+    _a[exports.InsightEvents.openUserActions] = 'User Actions',
+    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[exports.InsightEvents.clickPageView] = 'User Actions',
+    _a[exports.InsightEvents.createArticle] = 'createArticle',
     _a);
 
 var NoopAnalytics = (function () {
@@ -86062,6 +86067,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
         return this.logCustomEvent(exports.InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
     };
+    CoveoInsightClient.prototype.logCreateArticle = function (createArticleMetadata, metadata) {
+        return this.logCustomEvent(exports.InsightEvents.createArticle, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(exports.SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

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.21" ;
+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()) {
@@ -1689,6 +1693,7 @@ var InsightEvents;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(InsightEvents || (InsightEvents = {}));
 
 var SearchPageEvents;
@@ -1810,12 +1815,6 @@ const CustomEventsTypes = {
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
-    [InsightEvents.expandToFullUI]: 'interface',
-    [InsightEvents.openUserActions]: 'User Actions',
-    [InsightEvents.showPrecedingSessions]: 'User Actions',
-    [InsightEvents.showFollowingSessions]: 'User Actions',
-    [InsightEvents.clickViewedDocument]: 'User Actions',
-    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
@@ -1826,6 +1825,13 @@ const CustomEventsTypes = {
     [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
+    [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
+    [InsightEvents.createArticle]: 'createArticle',
 };
 
 class NoopAnalytics {
@@ -3074,6 +3080,9 @@ class CoveoInsightClient {
     logPageViewClick(pageView, metadata) {
         return this.logCustomEvent(InsightEvents.clickPageView, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { pageView }));
     }
+    logCreateArticle(createArticleMetadata, metadata) {
+        return this.logCustomEvent(InsightEvents.createArticle, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    }
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.21" ;
+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'");
@@ -84203,6 +84206,7 @@ exports.InsightEvents = void 0;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(exports.InsightEvents || (exports.InsightEvents = {}));
 
 var _a;
@@ -84325,12 +84329,6 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.showLessFoldedResults] = 'folding',
-    _a[exports.InsightEvents.expandToFullUI] = 'interface',
-    _a[exports.InsightEvents.openUserActions] = 'User Actions',
-    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
-    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
-    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
-    _a[exports.InsightEvents.clickPageView] = 'User Actions',
     _a[exports.SearchPageEvents.caseDetach] = 'case',
     _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
@@ -84341,6 +84339,13 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
+    _a[exports.InsightEvents.expandToFullUI] = 'interface',
+    _a[exports.InsightEvents.openUserActions] = 'User Actions',
+    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[exports.InsightEvents.clickPageView] = 'User Actions',
+    _a[exports.InsightEvents.createArticle] = 'createArticle',
     _a);
 
 var NoopAnalytics = (function () {
@@ -86062,6 +86067,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
         return this.logCustomEvent(exports.InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
     };
+    CoveoInsightClient.prototype.logCreateArticle = function (createArticleMetadata, metadata) {
+        return this.logCustomEvent(exports.InsightEvents.createArticle, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(exports.SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

package/dist/library.mjs

@@ -729,7 +729,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.21" ;
+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'");
@@ -84201,6 +84204,7 @@ var InsightEvents;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(InsightEvents || (InsightEvents = {}));
 
 var _a;
@@ -84323,12 +84327,6 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.showLessFoldedResults] = 'folding',
-    _a[InsightEvents.expandToFullUI] = 'interface',
-    _a[InsightEvents.openUserActions] = 'User Actions',
-    _a[InsightEvents.showPrecedingSessions] = 'User Actions',
-    _a[InsightEvents.showFollowingSessions] = 'User Actions',
-    _a[InsightEvents.clickViewedDocument] = 'User Actions',
-    _a[InsightEvents.clickPageView] = 'User Actions',
     _a[SearchPageEvents.caseDetach] = 'case',
     _a[SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
@@ -84339,6 +84337,13 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
     _a[SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
     _a[SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
+    _a[InsightEvents.expandToFullUI] = 'interface',
+    _a[InsightEvents.openUserActions] = 'User Actions',
+    _a[InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[InsightEvents.clickPageView] = 'User Actions',
+    _a[InsightEvents.createArticle] = 'createArticle',
     _a);
 
 var NoopAnalytics = (function () {
@@ -86060,6 +86065,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
         return this.logCustomEvent(InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
     };
+    CoveoInsightClient.prototype.logCreateArticle = function (createArticleMetadata, metadata) {
+        return this.logCustomEvent(InsightEvents.createArticle, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

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.21" ;
+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()) {
@@ -1710,6 +1714,7 @@ var InsightEvents;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(InsightEvents || (InsightEvents = {}));
 
 var SearchPageEvents;
@@ -1831,12 +1836,6 @@ const CustomEventsTypes = {
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
-    [InsightEvents.expandToFullUI]: 'interface',
-    [InsightEvents.openUserActions]: 'User Actions',
-    [InsightEvents.showPrecedingSessions]: 'User Actions',
-    [InsightEvents.showFollowingSessions]: 'User Actions',
-    [InsightEvents.clickViewedDocument]: 'User Actions',
-    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
@@ -1847,6 +1846,13 @@ const CustomEventsTypes = {
     [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
+    [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
+    [InsightEvents.createArticle]: 'createArticle',
 };
 
 class NoopAnalytics {
@@ -3095,6 +3101,9 @@ class CoveoInsightClient {
     logPageViewClick(pageView, metadata) {
         return this.logCustomEvent(InsightEvents.clickPageView, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { pageView }));
     }
+    logCreateArticle(createArticleMetadata, metadata) {
+        return this.logCustomEvent(InsightEvents.createArticle, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    }
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.28.21",
+    "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

@@ -622,6 +622,15 @@ describe('InsightClient', () => {
             await client.logGeneratedAnswerStreamEnd(exampleGeneratedAnswerMetadata);
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, exampleGeneratedAnswerMetadata);
         });
+
+        it('should send proper payload for #createArticle', async () => {
+            const exampleCreateArticleMetadata = {
+                articleType: 'Knowledge__kav',
+                triggeredBy: 'CreateArticleButton',
+            };
+            await client.logCreateArticle(exampleCreateArticleMetadata);
+            expectMatchCustomEventPayload(InsightEvents.createArticle, exampleCreateArticleMetadata);
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -1380,6 +1389,19 @@ describe('InsightClient', () => {
             await client.logGeneratedAnswerStreamEnd(exampleGeneratedAnswerMetadata, baseCaseMetadata);
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, expectedMetadata);
         });
+
+        it('should send proper payload for #createArticle', async () => {
+            const exampleCreateArticleMetadata = {
+                articleType: 'Knowledge__kav',
+                triggeredBy: 'CreateArticleButton',
+            };
+            const expectedMetadata = {
+                ...exampleCreateArticleMetadata,
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logCreateArticle(exampleCreateArticleMetadata, baseCaseMetadata);
+            expectMatchCustomEventPayload(InsightEvents.createArticle, expectedMetadata);
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -35,6 +35,7 @@ import {
     InsightResultsSortMetadata,
     UserActionsDocumentMetadata,
     UserActionsPageViewMetadata,
+    CreateArticleMetadata,
 } from './insightEvents';
 
 export interface InsightClientProvider {
@@ -266,6 +267,13 @@ export class CoveoInsightClient {
         });
     }
 
+    public logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            InsightEvents.createArticle,
+            metadata ? {...generateMetadataToSend(metadata, false), ...createArticleMetadata} : createArticleMetadata
+        );
+    }
+
     public logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
         return this.logClickEvent(
             SearchPageEvents.documentOpen,

package/src/insight/insightEvents.ts

@@ -40,6 +40,10 @@ export enum InsightEvents {
      * Identifies the event that gets logged when the user clicks a viewed page link on the user actions timeline.
      */
     clickPageView = 'clickPageView',
+    /**
+     * Identifies the event that gets logged when the user clicks the create article button.
+     */
+    createArticle = 'createArticle',
 }
 
 export interface CaseMetadata {
@@ -66,6 +70,11 @@ export interface UserActionsPageViewMetadata {
     contentIdValue: string;
 }
 
+export interface CreateArticleMetadata {
+    articleType: string;
+    triggeredBy: string;
+}
+
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {}
 
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {}