@coveo/push-api-client 3.0.117 → 3.0.122

package/dist/fieldAnalyser/fieldsUtils.spec.js

@@ -1,117 +1,117 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-jest.mock('@coveo/platform-client');
-const platform_client_1 = require("@coveo/platform-client");
-const inconsistencies_1 = require("./inconsistencies");
-const errors_1 = require("../errors");
-const Utils = require("./fieldUtils");
-const { createFields, listAllFieldsFromOrg, createFieldsFromReport } = Utils;
-const mockedPlatformClient = jest.mocked(platform_client_1.default);
-const mockedCreateField = jest.fn();
-const mockedListFields = jest.fn();
-const mockEvaluate = jest.fn();
-const dummyPlatformClient = () => {
-    return new platform_client_1.default({ accessToken: 'xxx' });
-};
-const doMockPlatformClient = () => {
-    mockedPlatformClient.mockImplementation(() => ({
-        privilegeEvaluator: { evaluate: mockEvaluate },
-        field: {
-            createFields: mockedCreateField,
-            list: mockedListFields,
-        },
-    }));
-};
-describe('fieldUtils', () => {
-    let client;
-    beforeAll(() => {
-        doMockPlatformClient();
-    });
-    beforeEach(async () => {
-        client = dummyPlatformClient();
-        mockEvaluate.mockResolvedValue({ approved: true });
-    });
-    describe('when listing fields', () => {
-        beforeEach(async () => {
-            mockedListFields
-                .mockReturnValueOnce({
-                items: [{ name: 'brand' }, { name: 'category' }],
-                totalPages: 2,
-            })
-                .mockReturnValueOnce({
-                items: [{ name: 'type' }],
-                totalPages: 2,
-            });
-            await listAllFieldsFromOrg(client);
-        });
-        it('should list all fields from org', async () => {
-            expect(mockedListFields).toHaveBeenCalledTimes(2);
-        });
-    });
-    describe('when creating fields', () => {
-        const fields = [
-            { name: 'field1' },
-            { name: 'field2' },
-            { name: 'field3' },
-            { name: 'field4' },
-            { name: 'field5' },
-            { name: 'field6' },
-        ];
-        it.each([
-            {
-                batchLimit: 4,
-                batches: [
-                    ['field1', 'field2', 'field3', 'field4'],
-                    ['field5', 'field6'],
-                ],
-            },
-            {
-                batchLimit: 6,
-                batches: [['field1', 'field2', 'field3', 'field4', 'field5', 'field6']],
-            },
-            {
-                batchLimit: 999,
-                batches: [['field1', 'field2', 'field3', 'field4', 'field5', 'field6']],
-            },
-        ])('should split fields into smaller batches', async ({ batchLimit, batches }) => {
-            await createFields(client, fields, batchLimit);
-            expect(mockedCreateField).toHaveBeenCalledTimes(batches.length);
-            batches.forEach((batch, index) => {
-                const field = batch.map((f) => ({
-                    name: f,
-                }));
-                expect(mockedCreateField).toHaveBeenNthCalledWith(index + 1, field);
-            });
-        });
-    });
-    describe('when creating fields from report', () => {
-        const fields = [
-            { name: 'field1' },
-            { name: 'field2' },
-            { name: 'field3' },
-        ];
-        it('should call #createFields', async () => {
-            const spy = jest.spyOn(Utils, 'createFields');
-            const inconsistencies = new inconsistencies_1.Inconsistencies();
-            await createFieldsFromReport(dummyPlatformClient(), {
-                fields,
-                inconsistencies,
-            });
-            expect(spy).toHaveBeenCalledWith(client, [
-                { name: 'field1' },
-                { name: 'field2' },
-                { name: 'field3' },
-            ]);
-        });
-        it('should throw if inconsistencies', async () => {
-            const inconsistencies = new inconsistencies_1.Inconsistencies();
-            inconsistencies.add('foo', [platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.DOUBLE]);
-            const create = () => createFieldsFromReport(dummyPlatformClient(), {
-                fields,
-                inconsistencies,
-            });
-            await expect(() => create()).rejects.toThrow(errors_1.FieldTypeInconsistencyError);
-        });
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('@coveo/platform-client');
+const platform_client_1 = require("@coveo/platform-client");
+const inconsistencies_1 = require("./inconsistencies");
+const errors_1 = require("../errors");
+const Utils = require("./fieldUtils");
+const { createFields, listAllFieldsFromOrg, createFieldsFromReport } = Utils;
+const mockedPlatformClient = jest.mocked(platform_client_1.default);
+const mockedCreateField = jest.fn();
+const mockedListFields = jest.fn();
+const mockEvaluate = jest.fn();
+const dummyPlatformClient = () => {
+    return new platform_client_1.default({ accessToken: 'xxx' });
+};
+const doMockPlatformClient = () => {
+    mockedPlatformClient.mockImplementation(() => ({
+        privilegeEvaluator: { evaluate: mockEvaluate },
+        field: {
+            createFields: mockedCreateField,
+            list: mockedListFields,
+        },
+    }));
+};
+describe('fieldUtils', () => {
+    let client;
+    beforeAll(() => {
+        doMockPlatformClient();
+    });
+    beforeEach(async () => {
+        client = dummyPlatformClient();
+        mockEvaluate.mockResolvedValue({ approved: true });
+    });
+    describe('when listing fields', () => {
+        beforeEach(async () => {
+            mockedListFields
+                .mockReturnValueOnce({
+                items: [{ name: 'brand' }, { name: 'category' }],
+                totalPages: 2,
+            })
+                .mockReturnValueOnce({
+                items: [{ name: 'type' }],
+                totalPages: 2,
+            });
+            await listAllFieldsFromOrg(client);
+        });
+        it('should list all fields from org', async () => {
+            expect(mockedListFields).toHaveBeenCalledTimes(2);
+        });
+    });
+    describe('when creating fields', () => {
+        const fields = [
+            { name: 'field1' },
+            { name: 'field2' },
+            { name: 'field3' },
+            { name: 'field4' },
+            { name: 'field5' },
+            { name: 'field6' },
+        ];
+        it.each([
+            {
+                batchLimit: 4,
+                batches: [
+                    ['field1', 'field2', 'field3', 'field4'],
+                    ['field5', 'field6'],
+                ],
+            },
+            {
+                batchLimit: 6,
+                batches: [['field1', 'field2', 'field3', 'field4', 'field5', 'field6']],
+            },
+            {
+                batchLimit: 999,
+                batches: [['field1', 'field2', 'field3', 'field4', 'field5', 'field6']],
+            },
+        ])('should split fields into smaller batches', async ({ batchLimit, batches }) => {
+            await createFields(client, fields, batchLimit);
+            expect(mockedCreateField).toHaveBeenCalledTimes(batches.length);
+            batches.forEach((batch, index) => {
+                const field = batch.map((f) => ({
+                    name: f,
+                }));
+                expect(mockedCreateField).toHaveBeenNthCalledWith(index + 1, field);
+            });
+        });
+    });
+    describe('when creating fields from report', () => {
+        const fields = [
+            { name: 'field1' },
+            { name: 'field2' },
+            { name: 'field3' },
+        ];
+        it('should call #createFields', async () => {
+            const spy = jest.spyOn(Utils, 'createFields');
+            const inconsistencies = new inconsistencies_1.Inconsistencies();
+            await createFieldsFromReport(dummyPlatformClient(), {
+                fields,
+                inconsistencies,
+            });
+            expect(spy).toHaveBeenCalledWith(client, [
+                { name: 'field1' },
+                { name: 'field2' },
+                { name: 'field3' },
+            ]);
+        });
+        it('should throw if inconsistencies', async () => {
+            const inconsistencies = new inconsistencies_1.Inconsistencies();
+            inconsistencies.add('foo', [platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.DOUBLE]);
+            const create = () => createFieldsFromReport(dummyPlatformClient(), {
+                fields,
+                inconsistencies,
+            });
+            await expect(() => create()).rejects.toThrow(errors_1.FieldTypeInconsistencyError);
+        });
+    });
+});
 //# sourceMappingURL=fieldsUtils.spec.js.map

package/dist/fieldAnalyser/inconsistencies.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Inconsistencies = void 0;
-class Inconsistencies extends Map {
-    constructor() {
-        super();
-    }
-    add(fieldName, types) {
-        const fieldTypeSet = this.get(fieldName) || [];
-        this.set(fieldName, new Set([...fieldTypeSet, ...types]));
-        return this;
-    }
-}
-exports.Inconsistencies = Inconsistencies;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Inconsistencies = void 0;
+class Inconsistencies extends Map {
+    constructor() {
+        super();
+    }
+    add(fieldName, types) {
+        const fieldTypeSet = this.get(fieldName) || [];
+        this.set(fieldName, new Set([...fieldTypeSet, ...types]));
+        return this;
+    }
+}
+exports.Inconsistencies = Inconsistencies;
 //# sourceMappingURL=inconsistencies.js.map

package/dist/fieldAnalyser/inconsistencies.spec.js

@@ -1,41 +1,41 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const platform_client_1 = require("@coveo/platform-client");
-const inconsistencies_1 = require("./inconsistencies");
-describe('Inconsistencies', () => {
-    const insconsitencies = new inconsistencies_1.Inconsistencies();
-    beforeAll(() => {
-        insconsitencies
-            .add('foo', [platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.VECTOR])
-            .add('foo', [platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.LONG_64])
-            .add('bar', [platform_client_1.FieldTypes.LONG, platform_client_1.FieldTypes.STRING]);
-    });
-    it('should return the inconsistencies count', () => {
-        expect(insconsitencies.size).toEqual(2);
-    });
-    it('should retrieve a specific inconsistency', () => {
-        const set = new Set([
-            platform_client_1.FieldTypes.STRING,
-            platform_client_1.FieldTypes.VECTOR,
-            platform_client_1.FieldTypes.LONG_64,
-        ]);
-        expect(insconsitencies.get('foo')).toEqual(set);
-    });
-    it('should return undefined when retrieving invalid inconsistencies key', () => {
-        expect(insconsitencies.get('invalid')).toBeUndefined();
-    });
-    it('should loop through inconsistencies', () => {
-        const types = [];
-        const fields = [];
-        insconsitencies.forEach((typeSet, field) => {
-            types.push(typeSet);
-            fields.push(field);
-        });
-        expect(types).toStrictEqual([
-            new Set([platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.VECTOR, platform_client_1.FieldTypes.LONG_64]),
-            new Set([platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.LONG]),
-        ]);
-        expect(fields).toStrictEqual(['foo', 'bar']);
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const platform_client_1 = require("@coveo/platform-client");
+const inconsistencies_1 = require("./inconsistencies");
+describe('Inconsistencies', () => {
+    const insconsitencies = new inconsistencies_1.Inconsistencies();
+    beforeAll(() => {
+        insconsitencies
+            .add('foo', [platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.VECTOR])
+            .add('foo', [platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.LONG_64])
+            .add('bar', [platform_client_1.FieldTypes.LONG, platform_client_1.FieldTypes.STRING]);
+    });
+    it('should return the inconsistencies count', () => {
+        expect(insconsitencies.size).toEqual(2);
+    });
+    it('should retrieve a specific inconsistency', () => {
+        const set = new Set([
+            platform_client_1.FieldTypes.STRING,
+            platform_client_1.FieldTypes.VECTOR,
+            platform_client_1.FieldTypes.LONG_64,
+        ]);
+        expect(insconsitencies.get('foo')).toEqual(set);
+    });
+    it('should return undefined when retrieving invalid inconsistencies key', () => {
+        expect(insconsitencies.get('invalid')).toBeUndefined();
+    });
+    it('should loop through inconsistencies', () => {
+        const types = [];
+        const fields = [];
+        insconsitencies.forEach((typeSet, field) => {
+            types.push(typeSet);
+            fields.push(field);
+        });
+        expect(types).toStrictEqual([
+            new Set([platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.VECTOR, platform_client_1.FieldTypes.LONG_64]),
+            new Set([platform_client_1.FieldTypes.STRING, platform_client_1.FieldTypes.LONG]),
+        ]);
+        expect(fields).toStrictEqual(['foo', 'bar']);
+    });
+});
 //# sourceMappingURL=inconsistencies.spec.js.map

package/dist/fieldAnalyser/typeUtils.js

@@ -1,62 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGuessedTypeFromValue = exports.getMostEnglobingType = void 0;
-const platform_client_1 = require("@coveo/platform-client");
-const acceptedNumericalTypeEvolutions = [
-    platform_client_1.FieldTypes.LONG,
-    platform_client_1.FieldTypes.LONG_64,
-    platform_client_1.FieldTypes.DOUBLE,
-];
-const acceptedAllTypeEvolutions = [
-    ...acceptedNumericalTypeEvolutions,
-    platform_client_1.FieldTypes.STRING,
-];
-function getMostEnglobingType(possibleType1, possibleType2, acceptedTypeEvolution = acceptedNumericalTypeEvolutions) {
-    if (possibleType1 === possibleType2) {
-        return possibleType1;
-    }
-    if (acceptedTypeEvolution.includes(possibleType1) &&
-        acceptedTypeEvolution.includes(possibleType2)) {
-        const idx1 = acceptedTypeEvolution.indexOf(possibleType1);
-        const idx2 = acceptedTypeEvolution.indexOf(possibleType2);
-        return acceptedTypeEvolution[Math.max(idx1, idx2)];
-    }
-    return null;
-}
-exports.getMostEnglobingType = getMostEnglobingType;
-function getGuessedTypeFromValue(obj) {
-    if (typeof obj === 'object') {
-        return getGuessedTypeFromObject(obj);
-    }
-    return getGuessedTypeFromPrimitive(obj);
-}
-exports.getGuessedTypeFromValue = getGuessedTypeFromValue;
-function getGuessedTypeFromPrimitive(obj) {
-    switch (typeof obj) {
-        case 'number':
-            return getSpecificNumericType(obj);
-        case 'string':
-            return platform_client_1.FieldTypes.STRING;
-        default:
-            return platform_client_1.FieldTypes.STRING;
-    }
-}
-function getGuessedTypeFromObject(obj) {
-    const initialType = acceptedAllTypeEvolutions[0];
-    const fallbackType = platform_client_1.FieldTypes.STRING;
-    if (obj === null) {
-        return fallbackType;
-    }
-    const array = Array.isArray(obj) ? obj : Object.values(obj);
-    return (array.reduce((previous, current) => getMostEnglobingType(previous, getGuessedTypeFromPrimitive(current), acceptedAllTypeEvolutions), initialType) || fallbackType);
-}
-function getSpecificNumericType(number) {
-    const is32BitInteger = (x) => (x | 0) === x;
-    if (Number.isInteger(number)) {
-        return is32BitInteger(number) ? platform_client_1.FieldTypes.LONG : platform_client_1.FieldTypes.LONG_64;
-    }
-    else {
-        return platform_client_1.FieldTypes.DOUBLE;
-    }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGuessedTypeFromValue = exports.getMostEnglobingType = void 0;
+const platform_client_1 = require("@coveo/platform-client");
+const acceptedNumericalTypeEvolutions = [
+    platform_client_1.FieldTypes.LONG,
+    platform_client_1.FieldTypes.LONG_64,
+    platform_client_1.FieldTypes.DOUBLE,
+];
+const acceptedAllTypeEvolutions = [
+    ...acceptedNumericalTypeEvolutions,
+    platform_client_1.FieldTypes.STRING,
+];
+function getMostEnglobingType(possibleType1, possibleType2, acceptedTypeEvolution = acceptedNumericalTypeEvolutions) {
+    if (possibleType1 === possibleType2) {
+        return possibleType1;
+    }
+    if (acceptedTypeEvolution.includes(possibleType1) &&
+        acceptedTypeEvolution.includes(possibleType2)) {
+        const idx1 = acceptedTypeEvolution.indexOf(possibleType1);
+        const idx2 = acceptedTypeEvolution.indexOf(possibleType2);
+        return acceptedTypeEvolution[Math.max(idx1, idx2)];
+    }
+    return null;
+}
+exports.getMostEnglobingType = getMostEnglobingType;
+function getGuessedTypeFromValue(obj) {
+    if (typeof obj === 'object') {
+        return getGuessedTypeFromObject(obj);
+    }
+    return getGuessedTypeFromPrimitive(obj);
+}
+exports.getGuessedTypeFromValue = getGuessedTypeFromValue;
+function getGuessedTypeFromPrimitive(obj) {
+    switch (typeof obj) {
+        case 'number':
+            return getSpecificNumericType(obj);
+        case 'string':
+            return platform_client_1.FieldTypes.STRING;
+        default:
+            return platform_client_1.FieldTypes.STRING;
+    }
+}
+function getGuessedTypeFromObject(obj) {
+    const initialType = acceptedAllTypeEvolutions[0];
+    const fallbackType = platform_client_1.FieldTypes.STRING;
+    if (obj === null) {
+        return fallbackType;
+    }
+    const array = Array.isArray(obj) ? obj : Object.values(obj);
+    return (array.reduce((previous, current) => getMostEnglobingType(previous, getGuessedTypeFromPrimitive(current), acceptedAllTypeEvolutions), initialType) || fallbackType);
+}
+function getSpecificNumericType(number) {
+    const is32BitInteger = (x) => (x | 0) === x;
+    if (Number.isInteger(number)) {
+        return is32BitInteger(number) ? platform_client_1.FieldTypes.LONG : platform_client_1.FieldTypes.LONG_64;
+    }
+    else {
+        return platform_client_1.FieldTypes.DOUBLE;
+    }
+}
 //# sourceMappingURL=typeUtils.js.map