@coveo/push-api-client 3.0.117 → 3.0.122

package/dist/fieldAnalyser/typeUtils.spec.js

@@ -1,143 +1,143 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const platform_client_1 = require("@coveo/platform-client");
-const typeUtils_1 = require("./typeUtils");
-describe('typeUtils', () => {
-    const signedIntegerLimit = 0b1111111111111111111111111111111;
-    it.each([
-        // String
-        { value: 'over 9000', type: platform_client_1.FieldTypes.STRING },
-        // LONG
-        { value: 0, type: platform_client_1.FieldTypes.LONG },
-        { value: -10, type: platform_client_1.FieldTypes.LONG },
-        { value: signedIntegerLimit, type: platform_client_1.FieldTypes.LONG },
-        { value: 10.0, type: platform_client_1.FieldTypes.LONG },
-        // LONG 64
-        { value: signedIntegerLimit + 1, type: platform_client_1.FieldTypes.LONG_64 },
-        { value: signedIntegerLimit * -1 - 2, type: platform_client_1.FieldTypes.LONG_64 },
-        // DOUBLE
-        { value: 3.14, type: platform_client_1.FieldTypes.DOUBLE },
-        { value: -1.23, type: platform_client_1.FieldTypes.DOUBLE },
-        { value: 9.164e-17, type: platform_client_1.FieldTypes.DOUBLE },
-        { value: -9.1642346778e-175, type: platform_client_1.FieldTypes.DOUBLE },
-    ])('value $value should be of type $type', ({ value, type }) => {
-        expect((0, typeUtils_1.getGuessedTypeFromValue)(value)).toBe(type);
-    });
-    describe('when the transition is authorized', () => {
-        it.each([
-            {
-                from: platform_client_1.FieldTypes.LONG,
-                to: platform_client_1.FieldTypes.LONG,
-                expectation: platform_client_1.FieldTypes.LONG,
-            },
-            {
-                from: platform_client_1.FieldTypes.LONG,
-                to: platform_client_1.FieldTypes.LONG_64,
-                expectation: platform_client_1.FieldTypes.LONG_64,
-            },
-            {
-                from: platform_client_1.FieldTypes.LONG,
-                to: platform_client_1.FieldTypes.DOUBLE,
-                expectation: platform_client_1.FieldTypes.DOUBLE,
-            },
-            {
-                from: platform_client_1.FieldTypes.LONG_64,
-                to: platform_client_1.FieldTypes.DOUBLE,
-                expectation: platform_client_1.FieldTypes.DOUBLE,
-            },
-            {
-                from: platform_client_1.FieldTypes.DOUBLE,
-                to: platform_client_1.FieldTypes.DOUBLE,
-                expectation: platform_client_1.FieldTypes.DOUBLE,
-            },
-            {
-                from: platform_client_1.FieldTypes.LONG_64,
-                to: platform_client_1.FieldTypes.LONG,
-                expectation: platform_client_1.FieldTypes.LONG_64,
-            },
-            {
-                from: platform_client_1.FieldTypes.DOUBLE,
-                to: platform_client_1.FieldTypes.LONG_64,
-                expectation: platform_client_1.FieldTypes.DOUBLE,
-            },
-        ])('From $from to $to should return $expectation', ({ from, to, expectation }) => {
-            expect((0, typeUtils_1.getMostEnglobingType)(from, to)).toBe(expectation);
-        });
-    });
-    describe('when the transition is not authorized', () => {
-        it.each([
-            {
-                from: platform_client_1.FieldTypes.LONG_64,
-                to: platform_client_1.FieldTypes.STRING,
-            },
-            {
-                from: platform_client_1.FieldTypes.STRING,
-                to: platform_client_1.FieldTypes.LONG,
-            },
-        ])('From $from to $to should return $expectation', ({ from, to }) => {
-            expect((0, typeUtils_1.getMostEnglobingType)(from, to)).toBe(null);
-        });
-    });
-    describe('when the value is not a primitive', () => {
-        describe('when the object contains inconsistencies', () => {
-            it.each([
-                {
-                    object: {
-                        key1: 42,
-                        key2: '123',
-                        key3: 12.23,
-                    },
-                    mostEnglobingType: platform_client_1.FieldTypes.STRING,
-                },
-                {
-                    object: [42, '123', 12.23],
-                    mostEnglobingType: platform_client_1.FieldTypes.STRING,
-                },
-                {
-                    object: {
-                        key1: 12,
-                        key2: 42.32,
-                    },
-                    mostEnglobingType: platform_client_1.FieldTypes.DOUBLE,
-                },
-                {
-                    object: [12, 42.32],
-                    mostEnglobingType: platform_client_1.FieldTypes.DOUBLE,
-                },
-            ])('should fallback on the most englobing type', ({ object, mostEnglobingType }) => {
-                expect((0, typeUtils_1.getGuessedTypeFromValue)(object)).toEqual(mostEnglobingType);
-            });
-        });
-        describe('when the object does not contain inconsistencies', () => {
-            it.each([
-                {
-                    object: {
-                        key1: 12,
-                        key2: 0,
-                    },
-                    objectType: platform_client_1.FieldTypes.LONG,
-                },
-                {
-                    object: [12, 0],
-                    objectType: platform_client_1.FieldTypes.LONG,
-                },
-            ])('should fallback on the type of all the object values/elements', ({ object, objectType }) => {
-                expect((0, typeUtils_1.getGuessedTypeFromValue)(object)).toEqual(objectType);
-            });
-        });
-        describe('when the value is a multi-level object', () => {
-            it('should return a string type', () => {
-                const multiLevelObject = {
-                    level: {
-                        anotherLevel: {
-                            anotherLevelDeep: 123,
-                        },
-                    },
-                };
-                const guessedType = (0, typeUtils_1.getGuessedTypeFromValue)(multiLevelObject);
-                expect(guessedType).toEqual(platform_client_1.FieldTypes.STRING);
-            });
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const platform_client_1 = require("@coveo/platform-client");
+const typeUtils_1 = require("./typeUtils");
+describe('typeUtils', () => {
+    const signedIntegerLimit = 0b1111111111111111111111111111111;
+    it.each([
+        // String
+        { value: 'over 9000', type: platform_client_1.FieldTypes.STRING },
+        // LONG
+        { value: 0, type: platform_client_1.FieldTypes.LONG },
+        { value: -10, type: platform_client_1.FieldTypes.LONG },
+        { value: signedIntegerLimit, type: platform_client_1.FieldTypes.LONG },
+        { value: 10.0, type: platform_client_1.FieldTypes.LONG },
+        // LONG 64
+        { value: signedIntegerLimit + 1, type: platform_client_1.FieldTypes.LONG_64 },
+        { value: signedIntegerLimit * -1 - 2, type: platform_client_1.FieldTypes.LONG_64 },
+        // DOUBLE
+        { value: 3.14, type: platform_client_1.FieldTypes.DOUBLE },
+        { value: -1.23, type: platform_client_1.FieldTypes.DOUBLE },
+        { value: 9.164e-17, type: platform_client_1.FieldTypes.DOUBLE },
+        { value: -9.1642346778e-175, type: platform_client_1.FieldTypes.DOUBLE },
+    ])('value $value should be of type $type', ({ value, type }) => {
+        expect((0, typeUtils_1.getGuessedTypeFromValue)(value)).toBe(type);
+    });
+    describe('when the transition is authorized', () => {
+        it.each([
+            {
+                from: platform_client_1.FieldTypes.LONG,
+                to: platform_client_1.FieldTypes.LONG,
+                expectation: platform_client_1.FieldTypes.LONG,
+            },
+            {
+                from: platform_client_1.FieldTypes.LONG,
+                to: platform_client_1.FieldTypes.LONG_64,
+                expectation: platform_client_1.FieldTypes.LONG_64,
+            },
+            {
+                from: platform_client_1.FieldTypes.LONG,
+                to: platform_client_1.FieldTypes.DOUBLE,
+                expectation: platform_client_1.FieldTypes.DOUBLE,
+            },
+            {
+                from: platform_client_1.FieldTypes.LONG_64,
+                to: platform_client_1.FieldTypes.DOUBLE,
+                expectation: platform_client_1.FieldTypes.DOUBLE,
+            },
+            {
+                from: platform_client_1.FieldTypes.DOUBLE,
+                to: platform_client_1.FieldTypes.DOUBLE,
+                expectation: platform_client_1.FieldTypes.DOUBLE,
+            },
+            {
+                from: platform_client_1.FieldTypes.LONG_64,
+                to: platform_client_1.FieldTypes.LONG,
+                expectation: platform_client_1.FieldTypes.LONG_64,
+            },
+            {
+                from: platform_client_1.FieldTypes.DOUBLE,
+                to: platform_client_1.FieldTypes.LONG_64,
+                expectation: platform_client_1.FieldTypes.DOUBLE,
+            },
+        ])('From $from to $to should return $expectation', ({ from, to, expectation }) => {
+            expect((0, typeUtils_1.getMostEnglobingType)(from, to)).toBe(expectation);
+        });
+    });
+    describe('when the transition is not authorized', () => {
+        it.each([
+            {
+                from: platform_client_1.FieldTypes.LONG_64,
+                to: platform_client_1.FieldTypes.STRING,
+            },
+            {
+                from: platform_client_1.FieldTypes.STRING,
+                to: platform_client_1.FieldTypes.LONG,
+            },
+        ])('From $from to $to should return $expectation', ({ from, to }) => {
+            expect((0, typeUtils_1.getMostEnglobingType)(from, to)).toBe(null);
+        });
+    });
+    describe('when the value is not a primitive', () => {
+        describe('when the object contains inconsistencies', () => {
+            it.each([
+                {
+                    object: {
+                        key1: 42,
+                        key2: '123',
+                        key3: 12.23,
+                    },
+                    mostEnglobingType: platform_client_1.FieldTypes.STRING,
+                },
+                {
+                    object: [42, '123', 12.23],
+                    mostEnglobingType: platform_client_1.FieldTypes.STRING,
+                },
+                {
+                    object: {
+                        key1: 12,
+                        key2: 42.32,
+                    },
+                    mostEnglobingType: platform_client_1.FieldTypes.DOUBLE,
+                },
+                {
+                    object: [12, 42.32],
+                    mostEnglobingType: platform_client_1.FieldTypes.DOUBLE,
+                },
+            ])('should fallback on the most englobing type', ({ object, mostEnglobingType }) => {
+                expect((0, typeUtils_1.getGuessedTypeFromValue)(object)).toEqual(mostEnglobingType);
+            });
+        });
+        describe('when the object does not contain inconsistencies', () => {
+            it.each([
+                {
+                    object: {
+                        key1: 12,
+                        key2: 0,
+                    },
+                    objectType: platform_client_1.FieldTypes.LONG,
+                },
+                {
+                    object: [12, 0],
+                    objectType: platform_client_1.FieldTypes.LONG,
+                },
+            ])('should fallback on the type of all the object values/elements', ({ object, objectType }) => {
+                expect((0, typeUtils_1.getGuessedTypeFromValue)(object)).toEqual(objectType);
+            });
+        });
+        describe('when the value is a multi-level object', () => {
+            it('should return a string type', () => {
+                const multiLevelObject = {
+                    level: {
+                        anotherLevel: {
+                            anotherLevelDeep: 123,
+                        },
+                    },
+                };
+                const guessedType = (0, typeUtils_1.getGuessedTypeFromValue)(multiLevelObject);
+                expect(guessedType).toEqual(platform_client_1.FieldTypes.STRING);
+            });
+        });
+    });
+});
 //# sourceMappingURL=typeUtils.spec.js.map

package/dist/help/file.js

@@ -1,38 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAllJsonFilesFromEntries = exports.isJsonFile = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const isJsonFile = (documentPath) => {
-    return documentPath.toString().endsWith('.json');
-};
-exports.isJsonFile = isJsonFile;
-const getAllJsonFilesFromEntries = (filesOrDirectories, fileNames = []) => {
-    const uniqueFileNames = [];
-    filesOrDirectories.flatMap((entry) => {
-        if ((0, fs_1.lstatSync)(entry).isDirectory()) {
-            recursiveDirectoryRead(entry, fileNames);
-        }
-        else {
-            fileNames.push(entry);
-        }
-    });
-    for (const file of fileNames) {
-        if (!uniqueFileNames.includes(file) && (0, exports.isJsonFile)(file)) {
-            uniqueFileNames.push(file);
-        }
-    }
-    return uniqueFileNames;
-};
-exports.getAllJsonFilesFromEntries = getAllJsonFilesFromEntries;
-const recursiveDirectoryRead = (folder, accumulator = []) => {
-    (0, fs_1.readdirSync)(folder, { withFileTypes: true }).map((dirent) => {
-        if (dirent.isDirectory()) {
-            recursiveDirectoryRead((0, path_1.join)(folder, dirent.name), accumulator);
-        }
-        else if (dirent.isFile()) {
-            accumulator.push((0, path_1.join)(folder, dirent.name));
-        }
-    });
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllJsonFilesFromEntries = exports.isJsonFile = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const isJsonFile = (documentPath) => {
+    return documentPath.toString().endsWith('.json');
+};
+exports.isJsonFile = isJsonFile;
+const getAllJsonFilesFromEntries = (filesOrDirectories, fileNames = []) => {
+    const uniqueFileNames = [];
+    filesOrDirectories.flatMap((entry) => {
+        if ((0, fs_1.lstatSync)(entry).isDirectory()) {
+            recursiveDirectoryRead(entry, fileNames);
+        }
+        else {
+            fileNames.push(entry);
+        }
+    });
+    for (const file of fileNames) {
+        if (!uniqueFileNames.includes(file) && (0, exports.isJsonFile)(file)) {
+            uniqueFileNames.push(file);
+        }
+    }
+    return uniqueFileNames;
+};
+exports.getAllJsonFilesFromEntries = getAllJsonFilesFromEntries;
+const recursiveDirectoryRead = (folder, accumulator = []) => {
+    (0, fs_1.readdirSync)(folder, { withFileTypes: true }).map((dirent) => {
+        if (dirent.isDirectory()) {
+            recursiveDirectoryRead((0, path_1.join)(folder, dirent.name), accumulator);
+        }
+        else if (dirent.isFile()) {
+            accumulator.push((0, path_1.join)(folder, dirent.name));
+        }
+    });
+};
 //# sourceMappingURL=file.js.map

package/dist/help/file.spec.js

@@ -1,68 +1,68 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const process_1 = require("process");
-const file_1 = require("./file");
-describe('file', () => {
-    const fileList = [
-        'na/na/na/na/batman.json',
-        'not/a/json/file.txt',
-        'another/json/file.json',
-    ];
-    const pathToStub = (0, path_1.join)((0, process_1.cwd)(), 'src', '__stub__');
-    it('should filter out non JSON documents', () => {
-        const validFiles = fileList.filter(file_1.isJsonFile);
-        expect(validFiles).toEqual([
-            'na/na/na/na/batman.json',
-            'another/json/file.json',
-        ]);
-    });
-    it('should return a list of JSON files', () => {
-        const folders = [(0, path_1.join)(pathToStub, 'mixdocuments')];
-        const files = [
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
-        ];
-        const entries = [...files, ...folders];
-        const validJsonFiles = (0, file_1.getAllJsonFilesFromEntries)(entries);
-        expect(validJsonFiles).toEqual([
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
-            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
-        ]);
-    });
-    it('should return an array of unique files', () => {
-        const folders = [(0, path_1.join)(pathToStub, 'mixdocuments')];
-        const files = [
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
-        ];
-        const entries = [...files, ...folders];
-        const validJsonFiles = (0, file_1.getAllJsonFilesFromEntries)(entries);
-        expect(validJsonFiles).toEqual([
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
-        ]);
-    });
-    it('should recursively read all JSON files in a directory', () => {
-        const folders = [
-            (0, path_1.join)(pathToStub, 'multiplelevelfolder'),
-            (0, path_1.join)(pathToStub, 'mixdocuments'),
-        ];
-        const files = [
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
-        ];
-        const entries = [...files, ...folders];
-        const validJsonFiles = (0, file_1.getAllJsonFilesFromEntries)(entries);
-        expect(validJsonFiles).toEqual([
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
-            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
-            (0, path_1.join)(pathToStub, 'multiplelevelfolder', 'parent.json'),
-            (0, path_1.join)(pathToStub, 'multiplelevelfolder', 'subfolder', 'child.json'),
-            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
-        ]);
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const process_1 = require("process");
+const file_1 = require("./file");
+describe('file', () => {
+    const fileList = [
+        'na/na/na/na/batman.json',
+        'not/a/json/file.txt',
+        'another/json/file.json',
+    ];
+    const pathToStub = (0, path_1.join)((0, process_1.cwd)(), 'src', '__stub__');
+    it('should filter out non JSON documents', () => {
+        const validFiles = fileList.filter(file_1.isJsonFile);
+        expect(validFiles).toEqual([
+            'na/na/na/na/batman.json',
+            'another/json/file.json',
+        ]);
+    });
+    it('should return a list of JSON files', () => {
+        const folders = [(0, path_1.join)(pathToStub, 'mixdocuments')];
+        const files = [
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
+        ];
+        const entries = [...files, ...folders];
+        const validJsonFiles = (0, file_1.getAllJsonFilesFromEntries)(entries);
+        expect(validJsonFiles).toEqual([
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
+            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
+        ]);
+    });
+    it('should return an array of unique files', () => {
+        const folders = [(0, path_1.join)(pathToStub, 'mixdocuments')];
+        const files = [
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
+        ];
+        const entries = [...files, ...folders];
+        const validJsonFiles = (0, file_1.getAllJsonFilesFromEntries)(entries);
+        expect(validJsonFiles).toEqual([
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
+        ]);
+    });
+    it('should recursively read all JSON files in a directory', () => {
+        const folders = [
+            (0, path_1.join)(pathToStub, 'multiplelevelfolder'),
+            (0, path_1.join)(pathToStub, 'mixdocuments'),
+        ];
+        const files = [
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
+        ];
+        const entries = [...files, ...folders];
+        const validJsonFiles = (0, file_1.getAllJsonFilesFromEntries)(entries);
+        expect(validJsonFiles).toEqual([
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'batman.json'),
+            (0, path_1.join)(pathToStub, 'jsondocuments', 'fightclub.json'),
+            (0, path_1.join)(pathToStub, 'multiplelevelfolder', 'parent.json'),
+            (0, path_1.join)(pathToStub, 'multiplelevelfolder', 'subfolder', 'child.json'),
+            (0, path_1.join)(pathToStub, 'mixdocuments', 'valid.json'),
+        ]);
+    });
+});
 //# sourceMappingURL=file.spec.js.map