coveo.analytics 2.30.51 → 2.30.53

package/dist/definitions/events.d.ts

@@ -69,6 +69,7 @@ export interface DocumentInformation {
     documentAuthor?: string;
     queryPipeline?: string;
     rankingModifier?: string;
+    documentCategory?: string;
 }
 export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {
 }

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

@@ -63,7 +63,7 @@ export declare class CoveoInsightClient {
     logFeedItemTextPost(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>;
+    logCaseDetach(resultUriHash: string, metadata?: CaseMetadata, permanentId?: string): Promise<void | import("../events").CustomEventResponse>;
     logLikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDislikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logExpandSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.30.51";
+export declare const libVersion = "2.30.53";

package/dist/library.cjs

@@ -736,7 +736,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.51";
+var libVersion = "2.30.53";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -86357,8 +86357,9 @@ var CoveoInsightClient = (function () {
         };
         return this.logClickEvent(exports.SearchPageEvents.caseAttach, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     };
-    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
-        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
+    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata, permanentId) {
+        var generatedMetadata = __assign(__assign(__assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId: permanentId })), { resultUriHash: resultUriHash });
+        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, generatedMetadata);
     };
     CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
         return this.logCustomEvent(exports.SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);

package/dist/library.es.js

@@ -603,7 +603,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.30.51";
+const libVersion = "2.30.53";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -3242,8 +3242,9 @@ class CoveoInsightClient {
         };
         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 });
+    logCaseDetach(resultUriHash, metadata, permanentId) {
+        const generatedMetadata = Object.assign(Object.assign(Object.assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId })), { resultUriHash });
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     }
     logLikeSmartSnippet(metadata) {
         return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);

package/dist/library.js

@@ -736,7 +736,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.51";
+var libVersion = "2.30.53";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -86357,8 +86357,9 @@ var CoveoInsightClient = (function () {
         };
         return this.logClickEvent(exports.SearchPageEvents.caseAttach, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
     };
-    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
-        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
+    CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata, permanentId) {
+        var generatedMetadata = __assign(__assign(__assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId: permanentId })), { resultUriHash: resultUriHash });
+        return this.logCustomEvent(exports.SearchPageEvents.caseDetach, generatedMetadata);
     };
     CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
         return this.logCustomEvent(exports.SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);

package/dist/library.mjs

@@ -734,7 +734,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.30.51";
+var libVersion = "2.30.53";
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -86355,8 +86355,9 @@ var CoveoInsightClient = (function () {
         };
         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.logCaseDetach = function (resultUriHash, metadata, permanentId) {
+        var generatedMetadata = __assign(__assign(__assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId: permanentId })), { resultUriHash: resultUriHash });
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     };
     CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
         return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);

package/dist/react-native.es.js

@@ -672,7 +672,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.30.51";
+const libVersion = "2.30.53";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -3263,8 +3263,9 @@ class CoveoInsightClient {
         };
         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 });
+    logCaseDetach(resultUriHash, metadata, permanentId) {
+        const generatedMetadata = Object.assign(Object.assign(Object.assign({}, (metadata && generateMetadataToSend(metadata, false))), (permanentId && { permanentId })), { resultUriHash });
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     }
     logLikeSmartSnippet(metadata) {
         return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);

package/package.json

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

package/src/events.ts

@@ -84,6 +84,7 @@ export interface DocumentInformation {
     documentAuthor?: string;
     queryPipeline?: string;
     rankingModifier?: string;
+    documentCategory?: string;
 }
 
 export interface ClickEventRequest extends EventBaseRequest, DocumentInformation {}

package/src/insight/insightClient.spec.ts

@@ -126,6 +126,7 @@ describe('InsightClient', () => {
 
     const fakeDocInfo = {
         collectionName: 'collection',
+        documentCategory: 'category',
         documentAuthor: 'author',
         documentPosition: 1,
         documentTitle: 'title',
@@ -383,10 +384,13 @@ describe('InsightClient', () => {
         });
 
         it('should send proper payload for #caseDetach', async () => {
+            const mockResultUriHash = fakeDocInfo.documentUriHash;
+            const mockPermanentId = fakeDocID.contentIDValue;
             const expectedMetadata = {
-                resultUriHash: fakeDocInfo.documentUriHash,
+                resultUriHash: mockResultUriHash,
+                permanentId: mockPermanentId,
             };
-            await client.logCaseDetach(fakeDocInfo.documentUriHash);
+            await client.logCaseDetach(mockResultUriHash, undefined, mockPermanentId);
             expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
         });
 
@@ -1194,12 +1198,15 @@ describe('InsightClient', () => {
 
         it('should send proper payload for #caseDetach', async () => {
             const metadata = baseCaseMetadata;
+            const mockResultUriHash = fakeDocInfo.documentUriHash;
+            const mockPermanentId = fakeDocID.contentIDValue;
 
             const expectedMetadata = {
                 ...expectedBaseCaseMetadata,
-                resultUriHash: fakeDocInfo.documentUriHash,
+                resultUriHash: mockResultUriHash,
+                permanentId: mockPermanentId,
             };
-            await client.logCaseDetach(fakeDocInfo.documentUriHash, metadata);
+            await client.logCaseDetach(mockResultUriHash, metadata, mockPermanentId);
             expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
         });
 

package/src/insight/insightClient.ts

@@ -373,11 +373,13 @@ export class CoveoInsightClient {
         );
     }
 
-    public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.caseDetach,
-            metadata ? {...generateMetadataToSend(metadata, false), resultUriHash} : {resultUriHash},
-        );
+    public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata, permanentId?: string) {
+        const generatedMetadata = {
+            ...(metadata && generateMetadataToSend(metadata, false)),
+            ...(permanentId && {permanentId}),
+            resultUriHash,
+        };
+        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
     }
 
     public logLikeSmartSnippet(metadata?: CaseMetadata) {

package/src/searchPage/searchPageClient.spec.ts

@@ -26,6 +26,7 @@ const {fetchMock, fetchMockBeforeEach} = mockFetch();
 describe('SearchPageClient', () => {
     const fakeDocInfo = {
         collectionName: 'collection',
+        documentCategory: 'category',
         documentAuthor: 'author',
         documentPosition: 1,
         documentTitle: 'title',