coveo.analytics 2.27.3 → 2.27.5

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

@@ -73,6 +73,8 @@ export declare class CoveoInsightClient {
     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>;
+    logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logShowLessFoldedResults(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     private getBaseCustomEventRequest;
     private getBaseSearchEventRequest;
     private getBaseEventRequest;

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.27.3";
+export declare const libVersion = "2.27.5";

package/dist/library.es.js

@@ -262,7 +262,7 @@ class HistoryStore {
     }
     getMostRecentElement() {
         let currentHistory = this.getHistoryWithInternalTime();
-        if (currentHistory != null) {
+        if (Array.isArray(currentHistory)) {
             const sorted = currentHistory.sort((first, second) => {
                 return (second.internalTime || 0) - (first.internalTime || 0);
             });
@@ -284,10 +284,13 @@ class HistoryStore {
         return true;
     }
     stripInternalTime(history) {
-        return history.map((part) => {
-            const { name, time, value } = part;
-            return { name, time, value };
-        });
+        if (Array.isArray(history)) {
+            return history.map((part) => {
+                const { name, time, value } = part;
+                return { name, time, value };
+            });
+        }
+        return [];
     }
     stripEmptyQuery(part) {
         const { name, time, value } = part;
@@ -593,7 +596,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.27.3" ;
+const libVersion = "2.27.5" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -2976,6 +2979,16 @@ class CoveoInsightClient {
             return this.coveoAnalyticsClient.sendClickEvent(payload);
         });
     }
+    logShowMoreFoldedResults(info, identifier, metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.logClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+        });
+    }
+    logShowLessFoldedResults(metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.logCustomEvent(SearchPageEvents.showLessFoldedResults, metadata ? generateMetadataToSend(metadata, false) : undefined);
+        });
+    }
     getBaseCustomEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });

package/dist/library.js

@@ -380,7 +380,7 @@ var HistoryStore = (function () {
     };
     HistoryStore.prototype.getMostRecentElement = function () {
         var currentHistory = this.getHistoryWithInternalTime();
-        if (currentHistory != null) {
+        if (Array.isArray(currentHistory)) {
             var sorted = currentHistory.sort(function (first, second) {
                 return (second.internalTime || 0) - (first.internalTime || 0);
             });
@@ -402,10 +402,13 @@ var HistoryStore = (function () {
         return true;
     };
     HistoryStore.prototype.stripInternalTime = function (history) {
-        return history.map(function (part) {
-            var name = part.name, time = part.time, value = part.value;
-            return { name: name, time: time, value: value };
-        });
+        if (Array.isArray(history)) {
+            return history.map(function (part) {
+                var name = part.name, time = part.time, value = part.value;
+                return { name: name, time: time, value: value };
+            });
+        }
+        return [];
     };
     HistoryStore.prototype.stripEmptyQuery = function (part) {
         var name = part.name, time = part.time, value = part.value;
@@ -728,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.27.3" ;
+var libVersion = "2.27.5" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -85920,6 +85923,20 @@ var CoveoInsightClient = (function () {
             });
         });
     };
+    CoveoInsightClient.prototype.logShowMoreFoldedResults = function (info, identifier, metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2, this.logClickEvent(exports.SearchPageEvents.showMoreFoldedResults, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined)];
+            });
+        });
+    };
+    CoveoInsightClient.prototype.logShowLessFoldedResults = function (metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2, this.logCustomEvent(exports.SearchPageEvents.showLessFoldedResults, metadata ? generateMetadataToSend(metadata, false) : undefined)];
+            });
+        });
+    };
     CoveoInsightClient.prototype.getBaseCustomEventRequest = function (metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var _a;

package/dist/react-native.es.js

@@ -589,7 +589,7 @@ class HistoryStore {
     }
     getMostRecentElement() {
         let currentHistory = this.getHistoryWithInternalTime();
-        if (currentHistory != null) {
+        if (Array.isArray(currentHistory)) {
             const sorted = currentHistory.sort((first, second) => {
                 return (second.internalTime || 0) - (first.internalTime || 0);
             });
@@ -611,10 +611,13 @@ class HistoryStore {
         return true;
     }
     stripInternalTime(history) {
-        return history.map((part) => {
-            const { name, time, value } = part;
-            return { name, time, value };
-        });
+        if (Array.isArray(history)) {
+            return history.map((part) => {
+                const { name, time, value } = part;
+                return { name, time, value };
+            });
+        }
+        return [];
     }
     stripEmptyQuery(part) {
         const { name, time, value } = part;
@@ -655,7 +658,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.27.3" ;
+const libVersion = "2.27.5" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -2994,6 +2997,16 @@ class CoveoInsightClient {
             return this.coveoAnalyticsClient.sendClickEvent(payload);
         });
     }
+    logShowMoreFoldedResults(info, identifier, metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.logClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+        });
+    }
+    logShowLessFoldedResults(metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.logCustomEvent(SearchPageEvents.showLessFoldedResults, metadata ? generateMetadataToSend(metadata, false) : undefined);
+        });
+    }
     getBaseCustomEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });

package/package.json

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

package/src/history.spec.ts

@@ -184,4 +184,18 @@ describe('history', () => {
 
         expect(storageMock.setItem).toHaveBeenCalledTimes(2);
     });
+
+    it('should not throw when the content of localStorage is not an array', async () => {
+        storageMock.setItem(history.STORE_KEY, '{"foo":"bar"}');
+        let ex: any;
+        try {
+            const mostRecentElement = await historyStore.getMostRecentElement();
+            expect(mostRecentElement).toBeNull();
+            const localHistory = await historyStore.getHistoryAsync();
+            expect(localHistory).toStrictEqual([]);
+        } catch (err) {
+            ex = err;
+        }
+        expect(ex).toBeUndefined();
+    });
 });

package/src/history.ts

@@ -103,7 +103,7 @@ export class HistoryStore {
 
     getMostRecentElement(): HistoryElement | null {
         let currentHistory = this.getHistoryWithInternalTime();
-        if (currentHistory != null) {
+        if (Array.isArray(currentHistory)) {
             const sorted = currentHistory.sort((first: HistoryElement, second: HistoryElement) => {
                 // Internal time might not be set for all history element (on upgrade).
                 // Ensure to return the most recent element for which we have a value for internalTime.
@@ -132,10 +132,13 @@ export class HistoryStore {
     }
 
     private stripInternalTime(history: HistoryElement[]): HistoryElement[] {
-        return history.map((part) => {
-            const {name, time, value} = part;
-            return {name, time, value};
-        });
+        if (Array.isArray(history)) {
+            return history.map((part) => {
+                const {name, time, value} = part;
+                return {name, time, value};
+            });
+        }
+        return [];
     }
 
     private stripEmptyQuery(part: HistoryElement) {

package/src/insight/insightClient.spec.ts

@@ -478,6 +478,15 @@ describe('InsightClient', () => {
                 expectedMetadata
             );
         });
+        it('should send proper payload for #showMoreFoldedResults', async () => {
+            await client.logShowMoreFoldedResults(fakeDocInfo, fakeDocID);
+            expectMatchDocumentPayload(SearchPageEvents.showMoreFoldedResults, fakeDocInfo, fakeDocID);
+        });
+
+        it('should send proper payload for #showLessFoldedResults', async () => {
+            await client.logShowLessFoldedResults();
+            expectMatchCustomEventPayload(SearchPageEvents.showLessFoldedResults);
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -1026,6 +1035,23 @@ describe('InsightClient', () => {
                 expectedMetadata
             );
         });
+
+        it('should send proper payload for #showMoreFoldedResults', async () => {
+            const expectedMetadata = {
+                ...fakeDocID,
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logShowMoreFoldedResults(fakeDocInfo, fakeDocID, baseCaseMetadata);
+            expectMatchDocumentPayload(SearchPageEvents.showMoreFoldedResults, fakeDocInfo, expectedMetadata);
+        });
+
+        it('should send proper payload for #showLessFoldedResults', async () => {
+            const expectedMetadata = {
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logShowLessFoldedResults(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.showLessFoldedResults, expectedMetadata);
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -482,6 +482,26 @@ export class CoveoInsightClient {
         return this.coveoAnalyticsClient.sendClickEvent(payload);
     }
 
+    public async logShowMoreFoldedResults(
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.showMoreFoldedResults,
+            info,
+            identifier,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public async logShowLessFoldedResults(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.showLessFoldedResults,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
     private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
         return {
             ...(await this.getBaseEventRequest(metadata)),