coveo.analytics 2.23.7 → 2.23.9

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

@@ -99,6 +99,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     private removeEmptyPayloadValues;
     private removeUnknownParameters;
     private processCustomParameters;
+    private mapCustomParametersToCustomData;
     private lowercaseKeys;
     private validateParams;
     private ensureAnonymousUserWhenUsingApiKey;

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

@@ -1 +1,2 @@
 export declare const keysOf: <T>(o: T) => Extract<keyof T, string>[];
+export declare function isObject(o: any): boolean;

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

@@ -50,6 +50,8 @@ export declare class CoveoInsightClient {
     logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCaseAttach(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCaseDetach(resultUriHash: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
     logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;

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

@@ -68,7 +68,9 @@ export declare enum SearchPageEvents {
     noResultsBack = "noResultsBack",
     showMoreFoldedResults = "showMoreFoldedResults",
     showLessFoldedResults = "showLessFoldedResults",
-    copyToClipboard = "copyToClipboard"
+    copyToClipboard = "copyToClipboard",
+    caseAttach = "caseAttach",
+    caseDetach = "caseDetach"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {

package/dist/library.es.js

@@ -359,7 +359,10 @@ const getRandomValues = (rnds) => {
     return rnds;
 };
 
-const keysOf = Object.keys;
+const keysOf = Object.keys;
+function isObject(o) {
+    return o !== null && typeof o === 'object' && !Array.isArray(o);
+}
 
 const ticketKeysMapping = {
     id: 'svc_ticket_id',
@@ -912,7 +915,9 @@ class CoveoAnalyticsClient {
             const validateParams = (currentPayload) => this.validateParams(currentPayload);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
             const removeUnknownParameters = (currentPayload) => usesMeasurementProtocol ? this.removeUnknownParameters(currentPayload) : currentPayload;
-            const processCustomParameters = (currentPayload) => usesMeasurementProtocol ? this.processCustomParameters(currentPayload) : currentPayload;
+            const processCustomParameters = (currentPayload) => usesMeasurementProtocol
+                ? this.processCustomParameters(currentPayload)
+                : this.mapCustomParametersToCustomData(currentPayload);
             const payloadToSend = yield [
                 cleanPayloadStep,
                 validateParams,
@@ -1078,13 +1083,30 @@ class CoveoAnalyticsClient {
     }
     processCustomParameters(payload) {
         const { custom } = payload, rest = __rest(payload, ["custom"]);
-        const lowercasedCustom = this.lowercaseKeys(custom);
+        let lowercasedCustom = {};
+        if (custom && isObject(custom)) {
+            lowercasedCustom = this.lowercaseKeys(custom);
+        }
         const newPayload = convertCustomMeasurementProtocolKeys(rest);
         return Object.assign(Object.assign({}, lowercasedCustom), newPayload);
     }
+    mapCustomParametersToCustomData(payload) {
+        const { custom } = payload, rest = __rest(payload, ["custom"]);
+        if (custom && isObject(custom)) {
+            const lowercasedCustom = this.lowercaseKeys(custom);
+            return Object.assign(Object.assign({}, rest), { customData: Object.assign(Object.assign({}, lowercasedCustom), payload.customData) });
+        }
+        else {
+            return payload;
+        }
+    }
     lowercaseKeys(custom) {
-        const keys = Object.keys(custom || {});
-        return keys.reduce((all, key) => (Object.assign(Object.assign({}, all), { [key.toLowerCase()]: custom[key] })), {});
+        const keys = Object.keys(custom);
+        let result = {};
+        keys.forEach((key) => {
+            result[key.toLowerCase()] = custom[key];
+        });
+        return result;
     }
     validateParams(payload) {
         const { anonymizeIp } = payload, rest = __rest(payload, ["anonymizeIp"]);
@@ -1186,6 +1208,8 @@ var SearchPageEvents;
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
     SearchPageEvents["copyToClipboard"] = "copyToClipboard";
+    SearchPageEvents["caseAttach"] = "caseAttach";
+    SearchPageEvents["caseDetach"] = "caseDetach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1221,6 +1245,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [SearchPageEvents.caseDetach]: 'case',
 };
 
 class NoopAnalytics {
@@ -2429,6 +2454,17 @@ class CoveoInsightClient {
         };
         return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     }
+    logCaseAttach(info, identifier, caseMetadata) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+        return this.logClickEvent(SearchPageEvents.caseAttach, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    }
+    logCaseDetach(resultUriHash, metadata) {
+        return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { resultUriHash }) : { resultUriHash });
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);

package/dist/library.js

@@ -506,7 +506,10 @@ var getRandomValues = function (rnds) {
     return rnds;
 };
 
-var keysOf = Object.keys;
+var keysOf = Object.keys;
+function isObject(o) {
+    return o !== null && typeof o === 'object' && !Array.isArray(o);
+}
 
 var ticketKeysMapping = {
     id: 'svc_ticket_id',
@@ -82808,7 +82811,9 @@ var CoveoAnalyticsClient = (function () {
                             return usesMeasurementProtocol ? _this.removeUnknownParameters(currentPayload) : currentPayload;
                         };
                         processCustomParameters = function (currentPayload) {
-                            return usesMeasurementProtocol ? _this.processCustomParameters(currentPayload) : currentPayload;
+                            return usesMeasurementProtocol
+                                ? _this.processCustomParameters(currentPayload)
+                                : _this.mapCustomParametersToCustomData(currentPayload);
                         };
                         return [4, [
                                 cleanPayloadStep,
@@ -83078,16 +83083,30 @@ var CoveoAnalyticsClient = (function () {
     };
     CoveoAnalyticsClient.prototype.processCustomParameters = function (payload) {
         var custom = payload.custom, rest = __rest(payload, ["custom"]);
-        var lowercasedCustom = this.lowercaseKeys(custom);
+        var lowercasedCustom = {};
+        if (custom && isObject(custom)) {
+            lowercasedCustom = this.lowercaseKeys(custom);
+        }
         var newPayload = convertCustomMeasurementProtocolKeys(rest);
         return __assign(__assign({}, lowercasedCustom), newPayload);
     };
+    CoveoAnalyticsClient.prototype.mapCustomParametersToCustomData = function (payload) {
+        var custom = payload.custom, rest = __rest(payload, ["custom"]);
+        if (custom && isObject(custom)) {
+            var lowercasedCustom = this.lowercaseKeys(custom);
+            return __assign(__assign({}, rest), { customData: __assign(__assign({}, lowercasedCustom), payload.customData) });
+        }
+        else {
+            return payload;
+        }
+    };
     CoveoAnalyticsClient.prototype.lowercaseKeys = function (custom) {
-        var keys = Object.keys(custom || {});
-        return keys.reduce(function (all, key) {
-            var _a;
-            return (__assign(__assign({}, all), (_a = {}, _a[key.toLowerCase()] = custom[key], _a)));
-        }, {});
+        var keys = Object.keys(custom);
+        var result = {};
+        keys.forEach(function (key) {
+            result[key.toLowerCase()] = custom[key];
+        });
+        return result;
     };
     CoveoAnalyticsClient.prototype.validateParams = function (payload) {
         var anonymizeIp = payload.anonymizeIp, rest = __rest(payload, ["anonymizeIp"]);
@@ -83450,7 +83469,7 @@ var Plugins = (function () {
         }
         var actionFunction = plugin[fn];
         if (!actionFunction) {
-            throw new Error("The function \"" + fn + "\" does not exists on the plugin \"" + name + "\".");
+            throw new Error("The function \"" + fn + "\" does not exist on the plugin \"" + name + "\".");
         }
         if (typeof actionFunction !== 'function') {
             throw new Error("\"" + fn + "\" of the plugin \"" + name + "\" is not a function.");
@@ -83694,6 +83713,8 @@ var SearchPageEvents;
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
     SearchPageEvents["copyToClipboard"] = "copyToClipboard";
+    SearchPageEvents["caseAttach"] = "caseAttach";
+    SearchPageEvents["caseDetach"] = "caseDetach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -83729,6 +83750,7 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.showLessFoldedResults] = 'folding',
     _a[InsightEvents.expandToFullUI] = 'interface',
+    _a[SearchPageEvents.caseDetach] = 'case',
     _a);
 
 var NoopAnalytics = (function () {
@@ -85279,6 +85301,17 @@ var CoveoInsightClient = (function () {
         };
         return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     };
+    CoveoInsightClient.prototype.logCaseAttach = function (info, identifier, caseMetadata) {
+        var metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+        return this.logClickEvent(SearchPageEvents.caseAttach, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    };
+    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
+        return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/react-native.es.js

@@ -420,7 +420,10 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const keysOf = Object.keys;
+const keysOf = Object.keys;
+function isObject(o) {
+    return o !== null && typeof o === 'object' && !Array.isArray(o);
+}
 
 const ticketKeysMapping = {
     id: 'svc_ticket_id',
@@ -912,7 +915,9 @@ class CoveoAnalyticsClient {
             const validateParams = (currentPayload) => this.validateParams(currentPayload);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
             const removeUnknownParameters = (currentPayload) => usesMeasurementProtocol ? this.removeUnknownParameters(currentPayload) : currentPayload;
-            const processCustomParameters = (currentPayload) => usesMeasurementProtocol ? this.processCustomParameters(currentPayload) : currentPayload;
+            const processCustomParameters = (currentPayload) => usesMeasurementProtocol
+                ? this.processCustomParameters(currentPayload)
+                : this.mapCustomParametersToCustomData(currentPayload);
             const payloadToSend = yield [
                 cleanPayloadStep,
                 validateParams,
@@ -1078,13 +1083,30 @@ class CoveoAnalyticsClient {
     }
     processCustomParameters(payload) {
         const { custom } = payload, rest = __rest(payload, ["custom"]);
-        const lowercasedCustom = this.lowercaseKeys(custom);
+        let lowercasedCustom = {};
+        if (custom && isObject(custom)) {
+            lowercasedCustom = this.lowercaseKeys(custom);
+        }
         const newPayload = convertCustomMeasurementProtocolKeys(rest);
         return Object.assign(Object.assign({}, lowercasedCustom), newPayload);
     }
+    mapCustomParametersToCustomData(payload) {
+        const { custom } = payload, rest = __rest(payload, ["custom"]);
+        if (custom && isObject(custom)) {
+            const lowercasedCustom = this.lowercaseKeys(custom);
+            return Object.assign(Object.assign({}, rest), { customData: Object.assign(Object.assign({}, lowercasedCustom), payload.customData) });
+        }
+        else {
+            return payload;
+        }
+    }
     lowercaseKeys(custom) {
-        const keys = Object.keys(custom || {});
-        return keys.reduce((all, key) => (Object.assign(Object.assign({}, all), { [key.toLowerCase()]: custom[key] })), {});
+        const keys = Object.keys(custom);
+        let result = {};
+        keys.forEach((key) => {
+            result[key.toLowerCase()] = custom[key];
+        });
+        return result;
     }
     validateParams(payload) {
         const { anonymizeIp } = payload, rest = __rest(payload, ["anonymizeIp"]);
@@ -1203,6 +1225,8 @@ var SearchPageEvents;
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
     SearchPageEvents["copyToClipboard"] = "copyToClipboard";
+    SearchPageEvents["caseAttach"] = "caseAttach";
+    SearchPageEvents["caseDetach"] = "caseDetach";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1238,6 +1262,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [SearchPageEvents.caseDetach]: 'case',
 };
 
 class NoopAnalytics {
@@ -2446,6 +2471,17 @@ class CoveoInsightClient {
         };
         return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     }
+    logCaseAttach(info, identifier, caseMetadata) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+            resultUriHash: info.documentUriHash,
+        };
+        return this.logClickEvent(SearchPageEvents.caseAttach, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    }
+    logCaseDetach(resultUriHash, metadata) {
+        return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { resultUriHash }) : { resultUriHash });
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);

package/package.json

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

package/src/client/analytics.ts

@@ -34,6 +34,7 @@ import {isApiKey} from './token';
 import {isReactNative, ReactNativeRuntimeWarning} from '../react-native/react-native-utils';
 import {doNotTrack} from '../donottrack';
 import {NullStorage} from '../storage';
+import {isObject} from './utils';
 
 export const Version = 'v15';
 
@@ -294,7 +295,9 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         const removeUnknownParameters: ProcessPayloadStep = (currentPayload) =>
             usesMeasurementProtocol ? this.removeUnknownParameters(currentPayload) : currentPayload;
         const processCustomParameters: ProcessPayloadStep = (currentPayload) =>
-            usesMeasurementProtocol ? this.processCustomParameters(currentPayload) : currentPayload;
+            usesMeasurementProtocol
+                ? this.processCustomParameters(currentPayload)
+                : this.mapCustomParametersToCustomData(currentPayload);
 
         const payloadToSend = await [
             cleanPayloadStep,
@@ -489,8 +492,10 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
 
     private processCustomParameters(payload: IRequestPayload): IRequestPayload {
         const {custom, ...rest} = payload;
-
-        const lowercasedCustom = this.lowercaseKeys(custom);
+        let lowercasedCustom = {};
+        if (custom && isObject(custom)) {
+            lowercasedCustom = this.lowercaseKeys(custom);
+        }
 
         const newPayload = convertCustomMeasurementProtocolKeys(rest);
 
@@ -500,16 +505,23 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         };
     }
 
-    private lowercaseKeys(custom: any) {
-        const keys = Object.keys(custom || {});
+    private mapCustomParametersToCustomData(payload: IRequestPayload): IRequestPayload {
+        const {custom, ...rest} = payload;
+        if (custom && isObject(custom)) {
+            const lowercasedCustom = this.lowercaseKeys(custom);
+            return {...rest, customData: {...lowercasedCustom, ...payload.customData}};
+        } else {
+            return payload;
+        }
+    }
 
-        return keys.reduce(
-            (all, key) => ({
-                ...all,
-                [key.toLowerCase()]: custom[key],
-            }),
-            {}
-        );
+    private lowercaseKeys(custom: Record<string, unknown>) {
+        const keys = Object.keys(custom);
+        let result: Record<string, unknown> = {};
+        keys.forEach((key) => {
+            result[key.toLowerCase() as string] = custom[key];
+        });
+        return result;
     }
 
     private validateParams(payload: IRequestPayload): IRequestPayload {

package/src/client/utils.ts

@@ -1,3 +1,6 @@
 // Object.keys returns `string[]` this adds types
 // see https://github.com/microsoft/TypeScript/pull/12253#issuecomment-393954723
 export const keysOf = Object.keys as <T>(o: T) => Extract<keyof T, string>[];
+export function isObject(o: any): boolean {
+    return o !== null && typeof o === 'object' && !Array.isArray(o);
+}

package/src/coveoua/plugins.ts

@@ -38,7 +38,7 @@ export class Plugins {
         }
         const actionFunction = plugin[fn];
         if (!actionFunction) {
-            throw new Error(`The function "${fn}" does not exists on the plugin "${name}".`);
+            throw new Error(`The function "${fn}" does not exist on the plugin "${name}".`);
         }
         if (typeof actionFunction !== 'function') {
             throw new Error(`"${fn}" of the plugin "${name}" is not a function.`);