@coveo/push-api-client 3.0.122 → 3.0.124

package/dist/validation/parseFile.js

@@ -1,121 +1,121 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseAndGetDocumentBuilderFromJSONDocument = void 0;
-const bueno_1 = require("@coveo/bueno");
-const __1 = require("..");
-const fs_1 = require("fs");
-const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
-const knownKey_1 = require("./knownKey");
-const validatorErrors_1 = require("../errors/validatorErrors");
-const requiredKeyValidator_1 = require("./requiredKeyValidator");
-const parsePermissions_1 = require("./parsePermissions");
-const parseAndGetDocumentBuilderFromJSONDocument = async (documentPath, options) => {
-    ensureFileIntegrity(documentPath);
-    const fileContent = safeJSONParse(documentPath);
-    const executeCallback = async (docBuilder) => {
-        if (options === null || options === void 0 ? void 0 : options.callback) {
-            await (options === null || options === void 0 ? void 0 : options.callback(docBuilder, documentPath));
-        }
-    };
-    if (Array.isArray(fileContent)) {
-        const docBuilders = [];
-        for (const doc of fileContent) {
-            const docBuilder = processDocument(doc, documentPath, options);
-            await executeCallback(docBuilder);
-            docBuilders.push(docBuilder);
-        }
-        return docBuilders;
-    }
-    else {
-        const docBuilder = processDocument(fileContent, documentPath, options);
-        executeCallback(docBuilder);
-        return [docBuilder];
-    }
-};
-exports.parseAndGetDocumentBuilderFromJSONDocument = parseAndGetDocumentBuilderFromJSONDocument;
-const safeJSONParse = (documentPath) => {
-    const fileContent = (0, fs_1.readFileSync)(documentPath).toString();
-    try {
-        return JSON.parse(fileContent);
-    }
-    catch (error) {
-        throw new validatorErrors_1.NotAJsonFileError(documentPath);
-    }
-};
-const processDocument = (fileContent, documentPath, options) => {
-    const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument(fileContent);
-    const documentBuilder = validateRequiredKeysAndGetDocumentBuilder(caseInsensitiveDoc, documentPath);
-    try {
-        processKnownKeys(caseInsensitiveDoc, documentBuilder);
-        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, documentPath);
-        processMetadata(caseInsensitiveDoc, documentBuilder, options);
-    }
-    catch (error) {
-        if (typeof error === 'string') {
-            throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, error);
-        }
-        throw error;
-    }
-    return documentBuilder;
-};
-const validateRequiredKeysAndGetDocumentBuilder = (caseInsensitiveDoc, documentPath) => {
-    const requiredDocumentId = new requiredKeyValidator_1.RequiredKeyValidator(['documentid', 'uri'], caseInsensitiveDoc, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
-    if (!requiredDocumentId.isValid) {
-        throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, requiredDocumentId.explanation);
-    }
-    const requiredDocumentTitle = new requiredKeyValidator_1.RequiredKeyValidator('title', caseInsensitiveDoc, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
-    if (!requiredDocumentTitle.isValid) {
-        throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, requiredDocumentTitle.explanation);
-    }
-    caseInsensitiveDoc.remove('documentid', 'uri', 'title');
-    return new __1.DocumentBuilder(requiredDocumentId.value, requiredDocumentTitle.value);
-};
-const processKnownKeys = (caseInsensitiveDoc, documentBuilder) => {
-    new knownKey_1.KnownKeys('author', caseInsensitiveDoc).whenExists((author) => {
-        documentBuilder.withAuthor(author);
-        caseInsensitiveDoc.remove('author');
-    });
-    new knownKey_1.KnownKeys('clickableuri', caseInsensitiveDoc).whenExists((clickuri) => {
-        documentBuilder.withClickableUri(clickuri);
-        caseInsensitiveDoc.remove('clickableuri');
-    });
-    new knownKey_1.KnownKeys('data', caseInsensitiveDoc).whenExists((data) => {
-        documentBuilder.withData(data);
-        caseInsensitiveDoc.remove('data');
-    });
-    new knownKey_1.KnownKeys('date', caseInsensitiveDoc).whenExists((date) => {
-        documentBuilder.withDate(date);
-        caseInsensitiveDoc.remove('date');
-    });
-    new knownKey_1.KnownKeys('modifieddate', caseInsensitiveDoc).whenExists((modifiedDate) => {
-        documentBuilder.withModifiedDate(modifiedDate);
-        caseInsensitiveDoc.remove('modifieddate');
-    });
-    new knownKey_1.KnownKeys('fileextension', caseInsensitiveDoc).whenExists((fileExtension) => {
-        documentBuilder.withFileExtension(fileExtension);
-        caseInsensitiveDoc.remove('fileextension');
-    });
-    new knownKey_1.KnownKeys('permanentid', caseInsensitiveDoc).whenExists((permanentId) => {
-        documentBuilder.withPermanentId(permanentId);
-        caseInsensitiveDoc.remove('permanentid');
-    });
-};
-const processMetadata = (caseInsensitiveDoc, documentBuilder, options) => {
-    const metadata = {};
-    Object.entries(caseInsensitiveDoc.remainingRecord).forEach(([k, v]) => {
-        metadata[k] = v;
-    });
-    documentBuilder.withMetadata(metadata, options === null || options === void 0 ? void 0 : options.fieldNameTransformer);
-};
-const ensureFileIntegrity = (documentPath) => {
-    if (!isFile(documentPath)) {
-        throw new validatorErrors_1.NotAFileError(documentPath);
-    }
-};
-const isFile = (p) => {
-    if (!(0, fs_1.existsSync)(p)) {
-        return false;
-    }
-    return (0, fs_1.lstatSync)(p).isFile();
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAndGetDocumentBuilderFromJSONDocument = void 0;
+const bueno_1 = require("@coveo/bueno");
+const __1 = require("..");
+const fs_1 = require("fs");
+const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
+const knownKey_1 = require("./knownKey");
+const validatorErrors_1 = require("../errors/validatorErrors");
+const requiredKeyValidator_1 = require("./requiredKeyValidator");
+const parsePermissions_1 = require("./parsePermissions");
+const parseAndGetDocumentBuilderFromJSONDocument = async (documentPath, options) => {
+    ensureFileIntegrity(documentPath);
+    const fileContent = safeJSONParse(documentPath);
+    const executeCallback = async (docBuilder) => {
+        if (options === null || options === void 0 ? void 0 : options.callback) {
+            await (options === null || options === void 0 ? void 0 : options.callback(docBuilder, documentPath));
+        }
+    };
+    if (Array.isArray(fileContent)) {
+        const docBuilders = [];
+        for (const doc of fileContent) {
+            const docBuilder = processDocument(doc, documentPath, options);
+            await executeCallback(docBuilder);
+            docBuilders.push(docBuilder);
+        }
+        return docBuilders;
+    }
+    else {
+        const docBuilder = processDocument(fileContent, documentPath, options);
+        executeCallback(docBuilder);
+        return [docBuilder];
+    }
+};
+exports.parseAndGetDocumentBuilderFromJSONDocument = parseAndGetDocumentBuilderFromJSONDocument;
+const safeJSONParse = (documentPath) => {
+    const fileContent = (0, fs_1.readFileSync)(documentPath).toString();
+    try {
+        return JSON.parse(fileContent);
+    }
+    catch (error) {
+        throw new validatorErrors_1.NotAJsonFileError(documentPath);
+    }
+};
+const processDocument = (fileContent, documentPath, options) => {
+    const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument(fileContent);
+    const documentBuilder = validateRequiredKeysAndGetDocumentBuilder(caseInsensitiveDoc, documentPath);
+    try {
+        processKnownKeys(caseInsensitiveDoc, documentBuilder);
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, documentPath);
+        processMetadata(caseInsensitiveDoc, documentBuilder, options);
+    }
+    catch (error) {
+        if (typeof error === 'string') {
+            throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, error);
+        }
+        throw error;
+    }
+    return documentBuilder;
+};
+const validateRequiredKeysAndGetDocumentBuilder = (caseInsensitiveDoc, documentPath) => {
+    const requiredDocumentId = new requiredKeyValidator_1.RequiredKeyValidator(['documentid', 'uri'], caseInsensitiveDoc, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
+    if (!requiredDocumentId.isValid) {
+        throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, requiredDocumentId.explanation);
+    }
+    const requiredDocumentTitle = new requiredKeyValidator_1.RequiredKeyValidator('title', caseInsensitiveDoc, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
+    if (!requiredDocumentTitle.isValid) {
+        throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, requiredDocumentTitle.explanation);
+    }
+    caseInsensitiveDoc.remove('documentid', 'uri', 'title');
+    return new __1.DocumentBuilder(requiredDocumentId.value, requiredDocumentTitle.value);
+};
+const processKnownKeys = (caseInsensitiveDoc, documentBuilder) => {
+    new knownKey_1.KnownKeys('author', caseInsensitiveDoc).whenExists((author) => {
+        documentBuilder.withAuthor(author);
+        caseInsensitiveDoc.remove('author');
+    });
+    new knownKey_1.KnownKeys('clickableuri', caseInsensitiveDoc).whenExists((clickuri) => {
+        documentBuilder.withClickableUri(clickuri);
+        caseInsensitiveDoc.remove('clickableuri');
+    });
+    new knownKey_1.KnownKeys('data', caseInsensitiveDoc).whenExists((data) => {
+        documentBuilder.withData(data);
+        caseInsensitiveDoc.remove('data');
+    });
+    new knownKey_1.KnownKeys('date', caseInsensitiveDoc).whenExists((date) => {
+        documentBuilder.withDate(date);
+        caseInsensitiveDoc.remove('date');
+    });
+    new knownKey_1.KnownKeys('modifieddate', caseInsensitiveDoc).whenExists((modifiedDate) => {
+        documentBuilder.withModifiedDate(modifiedDate);
+        caseInsensitiveDoc.remove('modifieddate');
+    });
+    new knownKey_1.KnownKeys('fileextension', caseInsensitiveDoc).whenExists((fileExtension) => {
+        documentBuilder.withFileExtension(fileExtension);
+        caseInsensitiveDoc.remove('fileextension');
+    });
+    new knownKey_1.KnownKeys('permanentid', caseInsensitiveDoc).whenExists((permanentId) => {
+        documentBuilder.withPermanentId(permanentId);
+        caseInsensitiveDoc.remove('permanentid');
+    });
+};
+const processMetadata = (caseInsensitiveDoc, documentBuilder, options) => {
+    const metadata = {};
+    Object.entries(caseInsensitiveDoc.remainingRecord).forEach(([k, v]) => {
+        metadata[k] = v;
+    });
+    documentBuilder.withMetadata(metadata, options === null || options === void 0 ? void 0 : options.fieldNameTransformer);
+};
+const ensureFileIntegrity = (documentPath) => {
+    if (!isFile(documentPath)) {
+        throw new validatorErrors_1.NotAFileError(documentPath);
+    }
+};
+const isFile = (p) => {
+    if (!(0, fs_1.existsSync)(p)) {
+        return false;
+    }
+    return (0, fs_1.lstatSync)(p).isFile();
+};
 //# sourceMappingURL=parseFile.js.map

package/dist/validation/parseFile.spec.js

@@ -1,97 +1,97 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const process_1 = require("process");
-const parseFile_1 = require("./parseFile");
-const validatorErrors_1 = require("../errors/validatorErrors");
-const fs_1 = require("fs");
-const stripFilePathFromSnapshot = () => {
-    const fileJsonFileErrorRegex = new RegExp(/^.*?(\w+\.json)(?= is not a valid JSON)/m);
-    expect.addSnapshotSerializer({
-        test: (val) => Boolean(val.match(fileJsonFileErrorRegex)),
-        print: (val) => `${val}`.replace(fileJsonFileErrorRegex, '$1'),
-    });
-};
-describe('parseFile', () => {
-    const pathToStub = (0, path_1.join)((0, process_1.cwd)(), 'src', '__stub__');
-    const parse = (file) => () => (0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(file);
-    it('should accept non-url documentIDs', async () => {
-        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'notAnUrl.json');
-        await expect((0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(file)).resolves.not.toThrow();
-    });
-    it.each([
-        {
-            title: 'should fail on missing title',
-            fileName: 'noTitle.json',
-            error: 'title: value is required.',
-        },
-        {
-            title: 'should fail on missing documentID',
-            fileName: 'noID.json',
-            error: 'documentid: value is required.',
-        },
-        {
-            title: 'should fail on missing identity',
-            fileName: 'noIdentity.json',
-            error: 'allowedpermissions:  value does not contain identity',
-        },
-        {
-            title: 'should fail on identity with an invalid string',
-            fileName: 'identityNotAString.json',
-            error: 'allowedpermissions:   value is not a string.',
-        },
-        {
-            title: 'should fail on allow anonymous with an invalid boolean',
-            fileName: 'identityAllowAnonymousNotABoolean.json',
-            error: 'allowanonymous: value is not a boolean.',
-        },
-        {
-            title: 'should fail on identityType with an invalid value',
-            fileName: 'identityTypeInvalidValue.json',
-            error: 'allowedpermissions:   value did not match provided regex /Unknown|User|Group|VirtualGroup/i',
-        },
-        {
-            title: 'should fail on permission not being an array',
-            fileName: 'notAPermissionArray.json',
-            error: 'permissions: value is not an array',
-        },
-        {
-            title: 'should fail on permission not being an array',
-            fileName: 'notAPermissionArray.json',
-            error: 'permissions: value is not an array',
-        },
-        {
-            title: 'should fail on permission not being an array',
-            fileName: 'notAPermissionArray.json',
-            error: 'permissions: value is not an array',
-        },
-        {
-            title: 'should fail on permission not being an array',
-            fileName: 'notAPermissionArray.json',
-            error: 'permissions: value is not an array',
-        },
-    ])('$title', async ({ fileName, error }) => {
-        const file = (0, path_1.join)(pathToStub, 'jsondocuments', fileName);
-        const fileContent = (0, fs_1.readFileSync)(file).toString();
-        await expect(parse(file)).rejects.toThrow(new validatorErrors_1.InvalidDocument(file, JSON.parse(fileContent), `Document contains an invalid value for ${error}`));
-    });
-    it('should not throw if allowedPermissions or deniedPermissions are omitted', async () => {
-        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'limitedPermissionSet.json');
-        await expect((0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(file)).resolves.not.toThrow();
-    });
-    it('should fail on reserved keyword', async () => {
-        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'reservedKeyword.json');
-        const fileContent = (0, fs_1.readFileSync)(file).toString();
-        await expect(parse(file)).rejects.toThrow(new validatorErrors_1.InvalidDocument(file, JSON.parse(fileContent), 'Cannot use parentid as a metadata key: It is a reserved key name. See https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names'));
-    });
-    it('should fail on reserved keyword', async () => {
-        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'brokenBatch.json');
-        stripFilePathFromSnapshot();
-        await expect(parse(file)).rejects.toThrowErrorMatchingSnapshot();
-    });
-    it('should fail on unsupported metadata key', async () => {
-        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'invalidFields.json');
-        await expect(parse(file)).rejects.toThrowErrorMatchingSnapshot();
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const process_1 = require("process");
+const parseFile_1 = require("./parseFile");
+const validatorErrors_1 = require("../errors/validatorErrors");
+const fs_1 = require("fs");
+const stripFilePathFromSnapshot = () => {
+    const fileJsonFileErrorRegex = new RegExp(/^.*?(\w+\.json)(?= is not a valid JSON)/m);
+    expect.addSnapshotSerializer({
+        test: (val) => Boolean(val.match(fileJsonFileErrorRegex)),
+        print: (val) => `${val}`.replace(fileJsonFileErrorRegex, '$1'),
+    });
+};
+describe('parseFile', () => {
+    const pathToStub = (0, path_1.join)((0, process_1.cwd)(), 'src', '__stub__');
+    const parse = (file) => () => (0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(file);
+    it('should accept non-url documentIDs', async () => {
+        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'notAnUrl.json');
+        await expect((0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(file)).resolves.not.toThrow();
+    });
+    it.each([
+        {
+            title: 'should fail on missing title',
+            fileName: 'noTitle.json',
+            error: 'title: value is required.',
+        },
+        {
+            title: 'should fail on missing documentID',
+            fileName: 'noID.json',
+            error: 'documentid: value is required.',
+        },
+        {
+            title: 'should fail on missing identity',
+            fileName: 'noIdentity.json',
+            error: 'allowedpermissions:  value does not contain identity',
+        },
+        {
+            title: 'should fail on identity with an invalid string',
+            fileName: 'identityNotAString.json',
+            error: 'allowedpermissions:   value is not a string.',
+        },
+        {
+            title: 'should fail on allow anonymous with an invalid boolean',
+            fileName: 'identityAllowAnonymousNotABoolean.json',
+            error: 'allowanonymous: value is not a boolean.',
+        },
+        {
+            title: 'should fail on identityType with an invalid value',
+            fileName: 'identityTypeInvalidValue.json',
+            error: 'allowedpermissions:   value did not match provided regex /Unknown|User|Group|VirtualGroup/i',
+        },
+        {
+            title: 'should fail on permission not being an array',
+            fileName: 'notAPermissionArray.json',
+            error: 'permissions: value is not an array',
+        },
+        {
+            title: 'should fail on permission not being an array',
+            fileName: 'notAPermissionArray.json',
+            error: 'permissions: value is not an array',
+        },
+        {
+            title: 'should fail on permission not being an array',
+            fileName: 'notAPermissionArray.json',
+            error: 'permissions: value is not an array',
+        },
+        {
+            title: 'should fail on permission not being an array',
+            fileName: 'notAPermissionArray.json',
+            error: 'permissions: value is not an array',
+        },
+    ])('$title', async ({ fileName, error }) => {
+        const file = (0, path_1.join)(pathToStub, 'jsondocuments', fileName);
+        const fileContent = (0, fs_1.readFileSync)(file).toString();
+        await expect(parse(file)).rejects.toThrow(new validatorErrors_1.InvalidDocument(file, JSON.parse(fileContent), `Document contains an invalid value for ${error}`));
+    });
+    it('should not throw if allowedPermissions or deniedPermissions are omitted', async () => {
+        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'limitedPermissionSet.json');
+        await expect((0, parseFile_1.parseAndGetDocumentBuilderFromJSONDocument)(file)).resolves.not.toThrow();
+    });
+    it('should fail on reserved keyword', async () => {
+        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'reservedKeyword.json');
+        const fileContent = (0, fs_1.readFileSync)(file).toString();
+        await expect(parse(file)).rejects.toThrow(new validatorErrors_1.InvalidDocument(file, JSON.parse(fileContent), 'Cannot use parentid as a metadata key: It is a reserved key name. See https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names'));
+    });
+    it('should fail on reserved keyword', async () => {
+        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'brokenBatch.json');
+        stripFilePathFromSnapshot();
+        await expect(parse(file)).rejects.toThrowErrorMatchingSnapshot();
+    });
+    it('should fail on unsupported metadata key', async () => {
+        const file = (0, path_1.join)(pathToStub, 'jsondocuments', 'invalidFields.json');
+        await expect(parse(file)).rejects.toThrowErrorMatchingSnapshot();
+    });
+});
 //# sourceMappingURL=parseFile.spec.js.map