@coveo/push-api-client 2.8.13 → 3.0.1

package/dist/validation/parseFile.js

@@ -8,6 +8,7 @@ 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);
@@ -46,12 +47,12 @@ const processDocument = (fileContent, documentPath, options) => {
     const documentBuilder = validateRequiredKeysAndGetDocumentBuilder(caseInsensitiveDoc, documentPath);
     try {
         processKnownKeys(caseInsensitiveDoc, documentBuilder);
-        processSecurityIdentities(caseInsensitiveDoc, documentBuilder, documentPath);
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, documentPath);
         processMetadata(caseInsensitiveDoc, documentBuilder, options);
     }
     catch (error) {
         if (typeof error === 'string') {
-            throw new validatorErrors_1.InvalidDocument(documentPath, error);
+            throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, error);
         }
         throw error;
     }
@@ -60,76 +61,48 @@ const processDocument = (fileContent, documentPath, options) => {
 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, requiredDocumentId.explanation);
+        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, requiredDocumentTitle.explanation);
+        throw new validatorErrors_1.InvalidDocument(documentPath, caseInsensitiveDoc.originalDocument, requiredDocumentTitle.explanation);
     }
-    delete caseInsensitiveDoc.documentRecord['documentid'];
-    delete caseInsensitiveDoc.documentRecord['uri'];
-    delete caseInsensitiveDoc.documentRecord['title'];
+    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);
-        delete caseInsensitiveDoc.documentRecord['author'];
+        caseInsensitiveDoc.remove('author');
     });
     new knownKey_1.KnownKeys('clickableuri', caseInsensitiveDoc).whenExists((clickuri) => {
         documentBuilder.withClickableUri(clickuri);
-        delete caseInsensitiveDoc.documentRecord['clickableuri'];
+        caseInsensitiveDoc.remove('clickableuri');
     });
     new knownKey_1.KnownKeys('data', caseInsensitiveDoc).whenExists((data) => {
         documentBuilder.withData(data);
-        delete caseInsensitiveDoc.documentRecord['data'];
+        caseInsensitiveDoc.remove('data');
     });
     new knownKey_1.KnownKeys('date', caseInsensitiveDoc).whenExists((date) => {
         documentBuilder.withDate(date);
-        delete caseInsensitiveDoc.documentRecord['date'];
+        caseInsensitiveDoc.remove('date');
     });
     new knownKey_1.KnownKeys('modifieddate', caseInsensitiveDoc).whenExists((modifiedDate) => {
         documentBuilder.withModifiedDate(modifiedDate);
-        delete caseInsensitiveDoc.documentRecord['modifieddate'];
+        caseInsensitiveDoc.remove('modifieddate');
     });
     new knownKey_1.KnownKeys('fileextension', caseInsensitiveDoc).whenExists((fileExtension) => {
         documentBuilder.withFileExtension(fileExtension);
-        delete caseInsensitiveDoc.documentRecord['fileextension'];
+        caseInsensitiveDoc.remove('fileextension');
     });
     new knownKey_1.KnownKeys('permanentid', caseInsensitiveDoc).whenExists((permanentId) => {
         documentBuilder.withPermanentId(permanentId);
-        delete caseInsensitiveDoc.documentRecord['permanentid'];
-    });
-};
-const processSecurityIdentities = (caseInsensitiveDoc, documentBuilder, documentPath) => {
-    new knownKey_1.KnownKeys('permissions', caseInsensitiveDoc).whenExists((permissions) => {
-        var _a, _b;
-        const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permissions);
-        const requiredAllowAnonymous = new requiredKeyValidator_1.RequiredKeyValidator('allowanonymous', caseInsensitivePermissions, new bueno_1.BooleanValue({ required: true }));
-        if (!requiredAllowAnonymous.isValid) {
-            throw new validatorErrors_1.InvalidDocument(documentPath, requiredAllowAnonymous.explanation);
-        }
-        const requiredAllowedPermissions = new requiredKeyValidator_1.RequiredKeyValidator('allowedpermissions', caseInsensitivePermissions, getSecurityIdentitySchemaValidation());
-        if (!requiredAllowedPermissions.isValid) {
-            throw new validatorErrors_1.InvalidDocument(documentPath, requiredAllowedPermissions.explanation);
-        }
-        const requiredDeniedPermissions = new requiredKeyValidator_1.RequiredKeyValidator('deniedpermissions', caseInsensitivePermissions, getSecurityIdentitySchemaValidation());
-        if (!requiredDeniedPermissions.isValid) {
-            throw new validatorErrors_1.InvalidDocument(documentPath, requiredDeniedPermissions.explanation);
-        }
-        documentBuilder.withAllowAnonymousUsers(permissions.allowAnonymous);
-        (_a = permissions === null || permissions === void 0 ? void 0 : permissions.allowedPermissions) === null || _a === void 0 ? void 0 : _a.forEach((p) => {
-            documentBuilder.withAllowedPermissions(new __1.AnySecurityIdentityBuilder(p.identityType, p.identity, p.securityProvider));
-        });
-        (_b = permissions === null || permissions === void 0 ? void 0 : permissions.deniedPermissions) === null || _b === void 0 ? void 0 : _b.forEach((p) => {
-            documentBuilder.withDeniedPermissions(new __1.AnySecurityIdentityBuilder(p.identityType, p.identity, p.securityProvider));
-        });
-        delete caseInsensitiveDoc.documentRecord['permissions'];
+        caseInsensitiveDoc.remove('permanentid');
     });
 };
 const processMetadata = (caseInsensitiveDoc, documentBuilder, options) => {
     const metadata = {};
-    Object.entries(caseInsensitiveDoc.documentRecord).forEach(([k, v]) => {
+    Object.entries(caseInsensitiveDoc.remainingRecord).forEach(([k, v]) => {
         metadata[k] = v;
     });
     documentBuilder.withMetadata(metadata, options === null || options === void 0 ? void 0 : options.fieldNameTransformer);
@@ -145,23 +118,4 @@ const isFile = (p) => {
     }
     return (0, fs_1.lstatSync)(p).isFile();
 };
-const getSecurityIdentitySchemaValidation = () => {
-    return new bueno_1.ArrayValue({
-        required: true,
-        each: new bueno_1.RecordValue({
-            values: {
-                identity: new bueno_1.StringValue({ required: true, emptyAllowed: false }),
-                identityType: new bueno_1.StringValue({
-                    constrainTo: ['UNKNOWN', 'USER', 'GROUP', 'VIRTUAL_GROUP'],
-                    required: true,
-                    emptyAllowed: false,
-                }),
-                securityProvider: new bueno_1.StringValue({
-                    emptyAllowed: false,
-                    required: true,
-                }),
-            },
-        }),
-    });
-};
 //# sourceMappingURL=parseFile.js.map

package/dist/validation/parseFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseFile.js","sourceRoot":"","sources":["../../src/validation/parseFile.ts"],"names":[],"mappings":";;;AAAA,wCAMsB;AACtB,0BAMY;AACZ,2BAAiE;AACjE,uEAAkE;AAClE,yCAAqC;AACrC,+DAImC;AACnC,iEAA4D;AAIrD,MAAM,0CAA0C,GAAG,KAAK,EAC7D,YAAsB,EACtB,OAA8B,EACF,EAAE;IAC9B,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAElC,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAEhD,MAAM,eAAe,GAAG,KAAK,EAAE,UAA2B,EAAE,EAAE;QAC5D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE;YACrB,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA,CAAC;SACnD;IACH,CAAC,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC9B,MAAM,WAAW,GAAsB,EAAE,CAAC;QAC1C,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;YAC7B,MAAM,UAAU,GAAG,eAAe,CAAC,GAAG,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;YAC/D,MAAM,eAAe,CAAC,UAAU,CAAC,CAAC;YAClC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC9B;QACD,OAAO,WAAW,CAAC;KACpB;SAAM;QACL,MAAM,UAAU,GAAG,eAAe,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACvE,eAAe,CAAC,UAAU,CAAC,CAAC;QAC5B,OAAO,CAAC,UAAU,CAAC,CAAC;KACrB;AACH,CAAC,CAAC;AA3BW,QAAA,0CAA0C,8CA2BrD;AAEF,MAAM,aAAa,GAAG,CAAC,YAAsB,EAAE,EAAE;IAC/C,MAAM,WAAW,GAAG,IAAA,iBAAY,EAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC1D,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAED,CAAC;KAC9B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,mCAAiB,CAAC,YAAY,CAAC,CAAC;KAC3C;AACH,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,WAA6C,EAC7C,YAAsB,EACtB,OAA8B,EAC9B,EAAE;IACF,MAAM,kBAAkB,GAAG,IAAI,iDAAuB,CAAC,WAAW,CAAC,CAAC;IAEpE,MAAM,eAAe,GAAG,yCAAyC,CAC/D,kBAAkB,EAClB,YAAY,CACb,CAAC;IACF,IAAI;QACF,gBAAgB,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;QACtD,yBAAyB,CACvB,kBAAkB,EAClB,eAAe,EACf,YAAY,CACb,CAAC;QACF,eAAe,CAAC,kBAAkB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;KAC/D;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,IAAI,iCAAe,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;SAChD;QACD,MAAM,KAAK,CAAC;KACb;IACD,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,yCAAyC,GAAG,CAChD,kBAA6D,EAC7D,YAAsB,EACtB,EAAE;IACF,MAAM,kBAAkB,GAAG,IAAI,2CAAoB,CACjD,CAAC,YAAY,EAAE,KAAK,CAAC,EACrB,kBAAkB,EAClB,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CACvD,CAAC;IAEF,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE;QAC/B,MAAM,IAAI,iCAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;KACzE;IAED,MAAM,qBAAqB,GAAG,IAAI,2CAAoB,CACpD,OAAO,EACP,kBAAkB,EAClB,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CACvD,CAAC;IACF,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE;QAClC,MAAM,IAAI,iCAAe,CAAC,YAAY,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAC;KAC5E;IAED,OAAO,kBAAkB,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IACvD,OAAO,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAChD,OAAO,kBAAkB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAElD,OAAO,IAAI,mBAAe,CACxB,kBAAkB,CAAC,KAAM,EACzB,qBAAqB,CAAC,KAAM,CAC7B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,kBAA6D,EAC7D,eAAgC,EAChC,EAAE;IACF,IAAI,oBAAS,CAAS,QAAQ,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE;QACxE,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,kBAAkB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,IAAI,oBAAS,CAAS,cAAc,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAClE,CAAC,QAAQ,EAAE,EAAE;QACX,eAAe,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC,CACF,CAAC;IACF,IAAI,oBAAS,CAAS,MAAM,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE;QACpE,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IACH,IAAI,oBAAS,CAAS,MAAM,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE;QACpE,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IACH,IAAI,oBAAS,CAAS,cAAc,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAClE,CAAC,YAAY,EAAE,EAAE;QACf,eAAe,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC,CACF,CAAC;IACF,IAAI,oBAAS,CAAS,eAAe,EAAE,kBAAkB,CAAC,CAAC,UAAU,CACnE,CAAC,aAAa,EAAE,EAAE;QAChB,eAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACjD,OAAO,kBAAkB,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC,CACF,CAAC;IACF,IAAI,oBAAS,CAAS,aAAa,EAAE,kBAAkB,CAAC,CAAC,UAAU,CACjE,CAAC,WAAW,EAAE,EAAE;QACd,eAAe,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC7C,OAAO,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAChC,kBAA6D,EAC7D,eAAgC,EAChC,YAAsB,EACtB,EAAE;IACF,IAAI,oBAAS,CACX,aAAa,EACb,kBAAkB,CACnB,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,EAAE;;QAC3B,MAAM,0BAA0B,GAAG,IAAI,iDAAuB,CAC5D,WAAY,CACb,CAAC;QACF,MAAM,sBAAsB,GAAG,IAAI,2CAAoB,CACrD,gBAAgB,EAChB,0BAA0B,EAC1B,IAAI,oBAAY,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CACnC,CAAC;QACF,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE;YACnC,MAAM,IAAI,iCAAe,CACvB,YAAY,EACZ,sBAAsB,CAAC,WAAW,CACnC,CAAC;SACH;QAED,MAAM,0BAA0B,GAAG,IAAI,2CAAoB,CACzD,oBAAoB,EACpB,0BAA0B,EAC1B,mCAAmC,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,0BAA0B,CAAC,OAAO,EAAE;YACvC,MAAM,IAAI,iCAAe,CACvB,YAAY,EACZ,0BAA0B,CAAC,WAAW,CACvC,CAAC;SACH;QAED,MAAM,yBAAyB,GAAG,IAAI,2CAAoB,CACxD,mBAAmB,EACnB,0BAA0B,EAC1B,mCAAmC,EAAE,CACtC,CAAC;QAEF,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE;YACtC,MAAM,IAAI,iCAAe,CACvB,YAAY,EACZ,yBAAyB,CAAC,WAAW,CACtC,CAAC;SACH;QAED,eAAe,CAAC,uBAAuB,CAAC,WAAY,CAAC,cAAc,CAAC,CAAC;QACrE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,kBAAkB,0CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC7C,eAAe,CAAC,sBAAsB,CACpC,IAAI,8BAA0B,CAC5B,CAAC,CAAC,YAAY,EACd,CAAC,CAAC,QAAQ,EACV,CAAC,CAAC,gBAAgB,CACnB,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,iBAAiB,0CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5C,eAAe,CAAC,qBAAqB,CACnC,IAAI,8BAA0B,CAC5B,CAAC,CAAC,YAAY,EACd,CAAC,CAAC,QAAQ,EACV,CAAC,CAAC,gBAAgB,CACnB,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,kBAA6D,EAC7D,eAAgC,EAChC,OAA8B,EAC9B,EAAE;IACF,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACnE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAA8C,CAAC;IAC/D,CAAC,CAAC,CAAC;IACH,eAAe,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB,CAAC,CAAC;AACxE,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,YAAsB,EAAE,EAAE;IACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;QACzB,MAAM,IAAI,+BAAa,CAAC,YAAY,CAAC,CAAC;KACvC;AACH,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAW,EAAE,EAAE;IAC7B,IAAI,CAAC,IAAA,eAAU,EAAC,CAAC,CAAC,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAA,cAAS,EAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,mCAAmC,GACvC,GAAiC,EAAE;IACjC,OAAO,IAAI,kBAAU,CAAC;QACpB,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,IAAI,mBAAW,CAAC;YACpB,MAAM,EAAE;gBACN,QAAQ,EAAE,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC;gBAChE,YAAY,EAAE,IAAI,mBAAW,CAAC;oBAC5B,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,CAAC;oBAC1D,QAAQ,EAAE,IAAI;oBACd,YAAY,EAAE,KAAK;iBACpB,CAAC;gBACF,gBAAgB,EAAE,IAAI,mBAAW,CAAC;oBAChC,YAAY,EAAE,KAAK;oBACnB,QAAQ,EAAE,IAAI;iBACf,CAAC;aACH;SACF,CAAC;KACH,CAAC,CAAC;AACL,CAAC,CAAC"}
+{"version":3,"file":"parseFile.js","sourceRoot":"","sources":["../../src/validation/parseFile.ts"],"names":[],"mappings":";;;AAAA,wCAA2D;AAC3D,0BAAkD;AAClD,2BAAiE;AACjE,uEAAkE;AAClE,yCAAqC;AACrC,+DAImC;AACnC,iEAA4D;AAG5D,yDAAyD;AAElD,MAAM,0CAA0C,GAAG,KAAK,EAC7D,YAAsB,EACtB,OAA8B,EACF,EAAE;IAC9B,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAElC,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAEhD,MAAM,eAAe,GAAG,KAAK,EAAE,UAA2B,EAAE,EAAE;QAC5D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE;YACrB,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA,CAAC;SACnD;IACH,CAAC,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC9B,MAAM,WAAW,GAAsB,EAAE,CAAC;QAC1C,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;YAC7B,MAAM,UAAU,GAAG,eAAe,CAAC,GAAG,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;YAC/D,MAAM,eAAe,CAAC,UAAU,CAAC,CAAC;YAClC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC9B;QACD,OAAO,WAAW,CAAC;KACpB;SAAM;QACL,MAAM,UAAU,GAAG,eAAe,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACvE,eAAe,CAAC,UAAU,CAAC,CAAC;QAC5B,OAAO,CAAC,UAAU,CAAC,CAAC;KACrB;AACH,CAAC,CAAC;AA3BW,QAAA,0CAA0C,8CA2BrD;AAEF,MAAM,aAAa,GAAG,CAAC,YAAsB,EAAE,EAAE;IAC/C,MAAM,WAAW,GAAG,IAAA,iBAAY,EAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC1D,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAED,CAAC;KAC9B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,mCAAiB,CAAC,YAAY,CAAC,CAAC;KAC3C;AACH,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,WAA6C,EAC7C,YAAsB,EACtB,OAA8B,EAC9B,EAAE;IACF,MAAM,kBAAkB,GAAG,IAAI,iDAAuB,CAAC,WAAW,CAAC,CAAC;IAEpE,MAAM,eAAe,GAAG,yCAAyC,CAC/D,kBAAkB,EAClB,YAAY,CACb,CAAC;IACF,IAAI;QACF,gBAAgB,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;QACtD,IAAA,wCAAqB,EAAC,kBAAkB,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QACzE,eAAe,CAAC,kBAAkB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;KAC/D;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,IAAI,iCAAe,CACvB,YAAY,EACZ,kBAAkB,CAAC,gBAAgB,EACnC,KAAK,CACN,CAAC;SACH;QACD,MAAM,KAAK,CAAC;KACb;IACD,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,yCAAyC,GAAG,CAChD,kBAA6D,EAC7D,YAAsB,EACtB,EAAE;IACF,MAAM,kBAAkB,GAAG,IAAI,2CAAoB,CACjD,CAAC,YAAY,EAAE,KAAK,CAAC,EACrB,kBAAkB,EAClB,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CACvD,CAAC;IAEF,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE;QAC/B,MAAM,IAAI,iCAAe,CACvB,YAAY,EACZ,kBAAkB,CAAC,gBAAgB,EACnC,kBAAkB,CAAC,WAAW,CAC/B,CAAC;KACH;IAED,MAAM,qBAAqB,GAAG,IAAI,2CAAoB,CACpD,OAAO,EACP,kBAAkB,EAClB,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CACvD,CAAC;IACF,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE;QAClC,MAAM,IAAI,iCAAe,CACvB,YAAY,EACZ,kBAAkB,CAAC,gBAAgB,EACnC,qBAAqB,CAAC,WAAW,CAClC,CAAC;KACH;IAED,kBAAkB,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAExD,OAAO,IAAI,mBAAe,CACxB,kBAAkB,CAAC,KAAM,EACzB,qBAAqB,CAAC,KAAM,CAC7B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,kBAA6D,EAC7D,eAAgC,EAChC,EAAE;IACF,IAAI,oBAAS,CAAS,QAAQ,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE;QACxE,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IACH,IAAI,oBAAS,CAAS,cAAc,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAClE,CAAC,QAAQ,EAAE,EAAE;QACX,eAAe,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC3C,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC,CACF,CAAC;IACF,IAAI,oBAAS,CAAS,MAAM,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE;QACpE,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,IAAI,oBAAS,CAAS,MAAM,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE;QACpE,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,IAAI,oBAAS,CAAS,cAAc,EAAE,kBAAkB,CAAC,CAAC,UAAU,CAClE,CAAC,YAAY,EAAE,EAAE;QACf,eAAe,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC/C,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC,CACF,CAAC;IACF,IAAI,oBAAS,CAAS,eAAe,EAAE,kBAAkB,CAAC,CAAC,UAAU,CACnE,CAAC,aAAa,EAAE,EAAE;QAChB,eAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACjD,kBAAkB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC7C,CAAC,CACF,CAAC;IACF,IAAI,oBAAS,CAAS,aAAa,EAAE,kBAAkB,CAAC,CAAC,UAAU,CACjE,CAAC,WAAW,EAAE,EAAE;QACd,eAAe,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC7C,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,kBAA6D,EAC7D,eAAgC,EAChC,OAA8B,EAC9B,EAAE;IACF,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACpE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAA8C,CAAC;IAC/D,CAAC,CAAC,CAAC;IACH,eAAe,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB,CAAC,CAAC;AACxE,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,YAAsB,EAAE,EAAE;IACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;QACzB,MAAM,IAAI,+BAAa,CAAC,YAAY,CAAC,CAAC;KACvC;AACH,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAW,EAAE,EAAE;IAC7B,IAAI,CAAC,IAAA,eAAU,EAAC,CAAC,CAAC,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAA,cAAS,EAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;AAC/B,CAAC,CAAC"}

package/dist/validation/parseFile.spec.js

@@ -4,6 +4,14 @@ 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);
@@ -40,15 +48,46 @@ describe('parseFile', () => {
         {
             title: 'should fail on identityType with an invalid value',
             fileName: 'identityTypeInvalidValue.json',
-            error: 'allowedpermissions:   value should be one of: UNKNOWN, USER, GROUP, VIRTUAL_GROUP.',
+            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);
-        await expect(parse(file)).rejects.toThrow(new validatorErrors_1.InvalidDocument(file, `Document contains an invalid value for ${error}`));
+        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');
-        await expect(parse(file)).rejects.toThrow(new validatorErrors_1.InvalidDocument(file, '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'));
+        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');

package/dist/validation/parseFile.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseFile.spec.js","sourceRoot":"","sources":["../../src/validation/parseFile.spec.ts"],"names":[],"mappings":";;AAAA,+BAA0B;AAC1B,qCAA4B;AAC5B,2CAAuE;AACvE,+DAA0D;AAE1D,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,IAAA,aAAG,GAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,EAAE,CACnC,IAAA,sDAA0C,EAAC,IAAI,CAAC,CAAC;IAEnD,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QAChE,MAAM,MAAM,CACV,IAAA,sDAA0C,EAAC,IAAI,CAAC,CACjD,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN;YACE,KAAK,EAAE,8BAA8B;YACrC,QAAQ,EAAE,cAAc;YACxB,KAAK,EAAE,2BAA2B;SACnC;QACD;YACE,KAAK,EAAE,mCAAmC;YAC1C,QAAQ,EAAE,WAAW;YACrB,KAAK,EAAE,gCAAgC;SACxC;QACD;YACE,KAAK,EAAE,iCAAiC;YACxC,QAAQ,EAAE,iBAAiB;YAC3B,KAAK,EAAE,sDAAsD;SAC9D;QACD;YACE,KAAK,EAAE,gDAAgD;YACvD,QAAQ,EAAE,yBAAyB;YACnC,KAAK,EAAE,8CAA8C;SACtD;QACD;YACE,KAAK,EAAE,wDAAwD;YAC/D,QAAQ,EAAE,wCAAwC;YAClD,KAAK,EAAE,yCAAyC;SACjD;QACD;YACE,KAAK,EAAE,mDAAmD;YAC1D,QAAQ,EAAE,+BAA+B;YACzC,KAAK,EACH,oFAAoF;SACvF;KACF,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAC,QAAQ,EAAE,KAAK,EAAC,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;QACzD,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACvC,IAAI,iCAAe,CACjB,IAAI,EACJ,0CAA0C,KAAK,EAAE,CAClD,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,sBAAsB,CAAC,CAAC;QACvE,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACvC,IAAI,iCAAe,CACjB,IAAI,EACJ,sKAAsK,CACvK,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;QACrE,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"parseFile.spec.js","sourceRoot":"","sources":["../../src/validation/parseFile.spec.ts"],"names":[],"mappings":";;AAAA,+BAA0B;AAC1B,qCAA4B;AAC5B,2CAAuE;AACvE,+DAA0D;AAC1D,2BAAgC;AAEhC,MAAM,yBAAyB,GAAG,GAAG,EAAE;IACrC,MAAM,sBAAsB,GAAG,IAAI,MAAM,CACvC,0CAA0C,CAC3C,CAAC;IACF,MAAM,CAAC,qBAAqB,CAAC;QAC3B,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QACjE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC;KAC/D,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,IAAA,aAAG,GAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,EAAE,CACnC,IAAA,sDAA0C,EAAC,IAAI,CAAC,CAAC;IAEnD,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QAChE,MAAM,MAAM,CACV,IAAA,sDAA0C,EAAC,IAAI,CAAC,CACjD,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN;YACE,KAAK,EAAE,8BAA8B;YACrC,QAAQ,EAAE,cAAc;YACxB,KAAK,EAAE,2BAA2B;SACnC;QACD;YACE,KAAK,EAAE,mCAAmC;YAC1C,QAAQ,EAAE,WAAW;YACrB,KAAK,EAAE,gCAAgC;SACxC;QACD;YACE,KAAK,EAAE,iCAAiC;YACxC,QAAQ,EAAE,iBAAiB;YAC3B,KAAK,EAAE,sDAAsD;SAC9D;QACD;YACE,KAAK,EAAE,gDAAgD;YACvD,QAAQ,EAAE,yBAAyB;YACnC,KAAK,EAAE,8CAA8C;SACtD;QACD;YACE,KAAK,EAAE,wDAAwD;YAC/D,QAAQ,EAAE,wCAAwC;YAClD,KAAK,EAAE,yCAAyC;SACjD;QACD;YACE,KAAK,EAAE,mDAAmD;YAC1D,QAAQ,EAAE,+BAA+B;YACzC,KAAK,EACH,6FAA6F;SAChG;QACD;YACE,KAAK,EAAE,8CAA8C;YACrD,QAAQ,EAAE,0BAA0B;YACpC,KAAK,EAAE,oCAAoC;SAC5C;QACD;YACE,KAAK,EAAE,8CAA8C;YACrD,QAAQ,EAAE,0BAA0B;YACpC,KAAK,EAAE,oCAAoC;SAC5C;QACD;YACE,KAAK,EAAE,8CAA8C;YACrD,QAAQ,EAAE,0BAA0B;YACpC,KAAK,EAAE,oCAAoC;SAC5C;QACD;YACE,KAAK,EAAE,8CAA8C;YACrD,QAAQ,EAAE,0BAA0B;YACpC,KAAK,EAAE,oCAAoC;SAC5C;KACF,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAC,QAAQ,EAAE,KAAK,EAAC,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,IAAA,iBAAY,EAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;QAClD,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACvC,IAAI,iCAAe,CACjB,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EACvB,0CAA0C,KAAK,EAAE,CAClD,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;QAC5E,MAAM,MAAM,CACV,IAAA,sDAA0C,EAAC,IAAI,CAAC,CACjD,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,sBAAsB,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,IAAA,iBAAY,EAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;QAClD,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACvC,IAAI,iCAAe,CACjB,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EACvB,sKAAsK,CACvK,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,kBAAkB,CAAC,CAAC;QACnE,yBAAyB,EAAE,CAAC;QAC5B,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;QACrE,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/validation/parsePermissions.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processPermissionList = void 0;
+const bueno_1 = require("@coveo/bueno");
+const securityIdentityBuilder_1 = require("../securityIdentityBuilder");
+const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
+const errors_1 = require("../errors");
+const knownKey_1 = require("./knownKey");
+const permissionSetBuilder_1 = require("../permissionSetBuilder");
+const requiredKeyValidator_1 = require("./requiredKeyValidator");
+const platform_client_1 = require("@coveo/platform-client");
+class PermissionParser {
+    constructor(caseInsensitiveDoc, documentBuilder, documentPath) {
+        this.caseInsensitiveDoc = caseInsensitiveDoc;
+        this.documentBuilder = documentBuilder;
+        this.documentPath = documentPath;
+        this.processPermissionSet = (permissionSet) => {
+            const permissionSetBuilder = this.validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permissionSet);
+            this.documentBuilder.withPermissionSet(permissionSetBuilder);
+        };
+    }
+    processPermissionList() {
+        this.ensurePermissionArray();
+        new knownKey_1.KnownKeys('permissions', this.caseInsensitiveDoc).whenExists((permissions) => {
+            permissions.forEach((permission) => {
+                const caseInsensitivePermission = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
+                new knownKey_1.KnownKeys('permissionsets', caseInsensitivePermission)
+                    .whenExists((permissionLevel) => this.processPermissionLevel(permissionLevel))
+                    .whenDoesNotExist((permissionSet) => this.processPermissionSet(permissionSet));
+            });
+            this.caseInsensitiveDoc.remove('permissions');
+        });
+    }
+    processPermissionLevel(permission) {
+        // TODO: require at least some permissions
+        const permissionSetBuilders = permission.permissionSets.map((permissionSet) => {
+            const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
+            const { isValid, explanation } = new requiredKeyValidator_1.RequiredKeyValidator('name', caseInsensitivePermissions, new bueno_1.StringValue({ required: true, emptyAllowed: false }));
+            if (!isValid) {
+                this.throwInvalidDocumentError(explanation);
+            }
+            return this.validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permissionSet);
+        });
+        // TODO: prevent empty permission set
+        this.documentBuilder.withPermissionLevel(permission.name, permissionSetBuilders);
+    }
+    validateAllowAnonymous(caseInsensitivePermissions) {
+        const { isValid, explanation, value } = new requiredKeyValidator_1.RequiredKeyValidator('allowanonymous', caseInsensitivePermissions, new bueno_1.BooleanValue({ required: true }));
+        if (!isValid) {
+            this.throwInvalidDocumentError(explanation);
+        }
+        return value;
+    }
+    validatePermission(permissionLogic, caseInsensitivePermissions) {
+        const { isValid, explanation, value } = new requiredKeyValidator_1.RequiredKeyValidator(permissionLogic, caseInsensitivePermissions, this.getSecurityIdentitySchemaValidation());
+        if (!isValid) {
+            this.throwInvalidDocumentError(explanation);
+        }
+        return value;
+    }
+    validateRequiredPermissionSetKeysAndGetPermissionSetBuilder(permission) {
+        const caseInsensitivePermissions = new caseInsensitiveDocument_1.CaseInsensitiveDocument(permission);
+        const allowAnonymous = this.validateAllowAnonymous(caseInsensitivePermissions);
+        const allowedPermissions = this.validatePermission('allowedpermissions', caseInsensitivePermissions);
+        const deniedPermissions = this.validatePermission('deniedpermissions', caseInsensitivePermissions);
+        const permissionSetBuilder = new permissionSetBuilder_1.PermissionSetBuilder(allowAnonymous);
+        allowedPermissions === null || allowedPermissions === void 0 ? void 0 : allowedPermissions.forEach(({ identity, identityType, securityProvider }) => {
+            permissionSetBuilder.withAllowedPermissions(new securityIdentityBuilder_1.AnySecurityIdentityBuilder(identityType, identity, securityProvider));
+        });
+        deniedPermissions === null || deniedPermissions === void 0 ? void 0 : deniedPermissions.forEach(({ identity, identityType, securityProvider }) => {
+            permissionSetBuilder.withDeniedPermissions(new securityIdentityBuilder_1.AnySecurityIdentityBuilder(identityType, identity, securityProvider));
+        });
+        return permissionSetBuilder;
+    }
+    get identityTypeRegex() {
+        const identityTypesValues = Object.values(platform_client_1.PermissionIdentityType);
+        return new RegExp(identityTypesValues.join('|'), 'i');
+    }
+    getSecurityIdentitySchemaValidation() {
+        return new bueno_1.ArrayValue({
+            required: false,
+            each: new bueno_1.RecordValue({
+                values: {
+                    identity: new bueno_1.StringValue({ required: true, emptyAllowed: false }),
+                    identityType: new bueno_1.StringValue({
+                        regex: this.identityTypeRegex,
+                        required: true,
+                        emptyAllowed: false,
+                    }),
+                    securityProvider: new bueno_1.StringValue({
+                        emptyAllowed: true,
+                        required: false,
+                    }),
+                },
+            }),
+        });
+    }
+    ensurePermissionArray() {
+        const validator = (schema) => new requiredKeyValidator_1.RequiredKeyValidator('permissions', this.caseInsensitiveDoc, schema);
+        const { isValid, explanation } = validator(new bueno_1.ArrayValue({ required: false }));
+        const requiredAtLeastOnePermission = validator(new bueno_1.ArrayValue({ min: 1 }));
+        if (!isValid) {
+            this.throwInvalidDocumentError(explanation);
+        }
+        if (!requiredAtLeastOnePermission.isValid) {
+            // simply discard empty array permission instead of throwing
+            this.caseInsensitiveDoc.remove('permissions');
+        }
+    }
+    throwInvalidDocumentError(explanation) {
+        throw new errors_1.InvalidDocument(this.documentPath, this.caseInsensitiveDoc.originalDocument, explanation);
+    }
+}
+const processPermissionList = (caseInsensitiveDoc, documentBuilder, documentPath) => {
+    const parser = new PermissionParser(caseInsensitiveDoc, documentBuilder, documentPath);
+    return parser.processPermissionList();
+};
+exports.processPermissionList = processPermissionList;
+//# sourceMappingURL=parsePermissions.js.map

package/dist/validation/parsePermissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsePermissions.js","sourceRoot":"","sources":["../../src/validation/parsePermissions.ts"],"names":[],"mappings":";;;AACA,wCAMsB;AAEtB,wEAAsE;AACtE,uEAA8E;AAE9E,sCAA0C;AAC1C,yCAAqC;AACrC,kEAAgF;AAChF,iEAA4D;AAC5D,4DAKgC;AAEhC,MAAM,gBAAgB;IACpB,YACU,kBAA6D,EAC7D,eAAgC,EAChC,YAAsB;QAFtB,uBAAkB,GAAlB,kBAAkB,CAA2C;QAC7D,oBAAe,GAAf,eAAe,CAAiB;QAChC,iBAAY,GAAZ,YAAY,CAAU;QA8BxB,yBAAoB,GAAG,CAAC,aAA4B,EAAE,EAAE;YAC9D,MAAM,oBAAoB,GACxB,IAAI,CAAC,2DAA2D,CAC9D,aAAa,CACd,CAAC;YAEJ,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;QAC/D,CAAC,CAAC;IApCC,CAAC;IAEG,qBAAqB;QAC1B,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,IAAI,oBAAS,CACX,aAAa,EACb,IAAI,CAAC,kBAAkB,CACxB,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,EAAE;YAC3B,WAAY,CAAC,OAAO,CAClB,CACE,UAAmE,EACnE,EAAE;gBACF,MAAM,yBAAyB,GAC7B,IAAI,iDAAuB,CAAmB,UAAU,CAAC,CAAC;gBAE5D,IAAI,oBAAS,CAAC,gBAAgB,EAAE,yBAAyB,CAAC;qBACvD,UAAU,CAAkB,CAAC,eAAe,EAAE,EAAE,CAC/C,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAC7C;qBACA,gBAAgB,CAAgB,CAAC,aAAa,EAAE,EAAE,CACjD,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,CACzC,CAAC;YACN,CAAC,CACF,CAAC;YAEF,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC;IAWO,sBAAsB,CAAC,UAAuC;QACpE,0CAA0C;QAC1C,MAAM,qBAAqB,GAAG,UAAU,CAAC,cAAe,CAAC,GAAG,CAC1D,CAAC,aAAa,EAAE,EAAE;YAChB,MAAM,0BAA0B,GAAG,IAAI,iDAAuB,CAC5D,UAAU,CACX,CAAC;YACF,MAAM,EAAC,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,2CAAoB,CACrD,MAAM,EACN,0BAA0B,EAC1B,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CACvD,CAAC;YACF,IAAI,CAAC,OAAO,EAAE;gBACZ,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;aAC7C;YACD,OAAO,IAAI,CAAC,2DAA2D,CACrE,aAAa,CACd,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,qCAAqC;QACrC,IAAI,CAAC,eAAe,CAAC,mBAAmB,CACtC,UAAU,CAAC,IAAK,EAChB,qBAAqB,CACtB,CAAC;IACJ,CAAC;IAEO,sBAAsB,CAC5B,0BAAqE;QAErE,MAAM,EAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAC,GAAG,IAAI,2CAAoB,CAC5D,gBAAgB,EAChB,0BAA0B,EAC1B,IAAI,oBAAY,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CACnC,CAAC;QACF,IAAI,CAAC,OAAO,EAAE;YACZ,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;SAC7C;QACD,OAAO,KAAM,CAAC;IAChB,CAAC;IAEO,kBAAkB,CACxB,eAA6C,EAC7C,0BAAqE;QAErE,MAAM,EAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAC,GAAG,IAAI,2CAAoB,CAC5D,eAAe,EACf,0BAA0B,EAC1B,IAAI,CAAC,mCAAmC,EAAE,CAC3C,CAAC;QAEF,IAAI,CAAC,OAAO,EAAE;YACZ,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;SAC7C;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,2DAA2D,CACjE,UAAqC;QAErC,MAAM,0BAA0B,GAAG,IAAI,iDAAuB,CAAC,UAAU,CAAC,CAAC;QAC3E,MAAM,cAAc,GAAG,IAAI,CAAC,sBAAsB,CAChD,0BAA0B,CAC3B,CAAC;QACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAChD,oBAAoB,EACpB,0BAA0B,CAC3B,CAAC;QACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAC/C,mBAAmB,EACnB,0BAA0B,CAC3B,CAAC;QAEF,MAAM,oBAAoB,GAAG,IAAI,2CAAoB,CAAC,cAAc,CAAC,CAAC;QAEtE,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,OAAO,CACzB,CAAC,EAAC,QAAQ,EAAE,YAAY,EAAE,gBAAgB,EAAa,EAAE,EAAE;YACzD,oBAAoB,CAAC,sBAAsB,CACzC,IAAI,oDAA0B,CAC5B,YAAa,EACb,QAAS,EACT,gBAAgB,CACjB,CACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CACxB,CAAC,EAAC,QAAQ,EAAE,YAAY,EAAE,gBAAgB,EAAa,EAAE,EAAE;YACzD,oBAAoB,CAAC,qBAAqB,CACxC,IAAI,oDAA0B,CAC5B,YAAa,EACb,QAAS,EACT,gBAAgB,CACjB,CACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,IAAY,iBAAiB;QAC3B,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,wCAAsB,CAAC,CAAC;QAClE,OAAO,IAAI,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;IAEO,mCAAmC;QACzC,OAAO,IAAI,kBAAU,CAAC;YACpB,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,IAAI,mBAAW,CAAC;gBACpB,MAAM,EAAE;oBACN,QAAQ,EAAE,IAAI,mBAAW,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC;oBAChE,YAAY,EAAE,IAAI,mBAAW,CAAC;wBAC5B,KAAK,EAAE,IAAI,CAAC,iBAAiB;wBAC7B,QAAQ,EAAE,IAAI;wBACd,YAAY,EAAE,KAAK;qBACpB,CAAC;oBACF,gBAAgB,EAAE,IAAI,mBAAW,CAAC;wBAChC,YAAY,EAAE,IAAI;wBAClB,QAAQ,EAAE,KAAK;qBAChB,CAAC;iBACH;aACF,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB;QAC3B,MAAM,SAAS,GAAG,CAAC,MAAoC,EAAE,EAAE,CACzD,IAAI,2CAAoB,CAAC,aAAa,EAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;QAC3E,MAAM,EAAC,OAAO,EAAE,WAAW,EAAC,GAAG,SAAS,CAAC,IAAI,kBAAU,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;QAC5E,MAAM,4BAA4B,GAAG,SAAS,CAAC,IAAI,kBAAU,CAAC,EAAC,GAAG,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;QAEzE,IAAI,CAAC,OAAO,EAAE;YACZ,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE;YACzC,4DAA4D;YAC5D,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;SAC/C;IACH,CAAC;IAEO,yBAAyB,CAAC,WAAmB;QACnD,MAAM,IAAI,wBAAe,CACvB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,EACxC,WAAW,CACZ,CAAC;IACJ,CAAC;CACF;AAEM,MAAM,qBAAqB,GAAG,CACnC,kBAA6D,EAC7D,eAAgC,EAChC,YAAsB,EACtB,EAAE;IACF,MAAM,MAAM,GAAG,IAAI,gBAAgB,CACjC,kBAAkB,EAClB,eAAe,EACf,YAAY,CACb,CAAC;IACF,OAAO,MAAM,CAAC,qBAAqB,EAAE,CAAC;AACxC,CAAC,CAAC;AAXW,QAAA,qBAAqB,yBAWhC"}

package/dist/validation/parsePermissions.spec.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const __1 = require("..");
+const caseInsensitiveDocument_1 = require("./caseInsensitiveDocument");
+const parsePermissions_1 = require("./parsePermissions");
+describe('parsePermissions', () => {
+    let documentBuilder;
+    const dummyPath = (0, path_1.join)('dummy', 'path');
+    const publicPermissionsSet = {
+        allowAnonymous: true,
+        deniedpermissions: [
+            {
+                identity: 'foo@example.com',
+                identityType: 'USER',
+            },
+        ],
+    };
+    const restrictedPermissionSet = {
+        allowAnonymous: false,
+        ALLOWEDPERMISSIONS: [
+            {
+                identity: 'asmith@example.com',
+                identityType: 'User',
+            },
+            {
+                identity: 'bjones@example.com',
+                identityType: 'USER',
+            },
+        ],
+    };
+    const complexPermissionSet = {
+        aLLowAnonyMOUS: false,
+        deniedpermissions: [
+            {
+                identity: 'foo',
+                identityType: 'VirtualGroup',
+            },
+        ],
+        allowedPERMISSIONS: [
+            {
+                identity: 'Sample_group',
+                identityType: 'Group',
+            },
+            {
+                identity: 'bjones@example.com',
+                identityType: 'user',
+            },
+        ],
+    };
+    beforeEach(() => {
+        documentBuilder = new __1.DocumentBuilder('https://foo.com', 'Some Document');
+    });
+    it('should not marhsal empty permssion when is empty array', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal()).not.toHaveProperty('permissions');
+    });
+    it('should marhsal denied permssion set', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [publicPermissionsSet],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
+    });
+    it('should marhsal allowed permssion set', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [restrictedPermissionSet],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
+    });
+    it('should marhsal combined permssion sets', () => {
+        const caseInsensitiveDoc = new caseInsensitiveDocument_1.CaseInsensitiveDocument({
+            permissions: [
+                publicPermissionsSet,
+                restrictedPermissionSet,
+                complexPermissionSet,
+            ],
+        });
+        (0, parsePermissions_1.processPermissionList)(caseInsensitiveDoc, documentBuilder, dummyPath);
+        expect(documentBuilder.marshal().permissions).toMatchSnapshot();
+    });
+});
+//# sourceMappingURL=parsePermissions.spec.js.map

package/dist/validation/parsePermissions.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsePermissions.spec.js","sourceRoot":"","sources":["../../src/validation/parsePermissions.spec.ts"],"names":[],"mappings":";;AACA,+BAA0B;AAC1B,0BAAmC;AACnC,uEAAkE;AAClE,yDAAyD;AAEzD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,eAAgC,CAAC;IACrC,MAAM,SAAS,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,oBAAoB,GAAG;QAC3B,cAAc,EAAE,IAAI;QACpB,iBAAiB,EAAE;YACjB;gBACE,QAAQ,EAAE,iBAAiB;gBAC3B,YAAY,EAAE,MAAM;aACrB;SACF;KACF,CAAC;IACF,MAAM,uBAAuB,GAAG;QAC9B,cAAc,EAAE,KAAK;QACrB,kBAAkB,EAAE;YAClB;gBACE,QAAQ,EAAE,oBAAoB;gBAC9B,YAAY,EAAE,MAAM;aACrB;YACD;gBACE,QAAQ,EAAE,oBAAoB;gBAC9B,YAAY,EAAE,MAAM;aACrB;SACF;KACF,CAAC;IAEF,MAAM,oBAAoB,GAAG;QAC3B,cAAc,EAAE,KAAK;QACrB,iBAAiB,EAAE;YACjB;gBACE,QAAQ,EAAE,KAAK;gBACf,YAAY,EAAE,cAAc;aAC7B;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,QAAQ,EAAE,cAAc;gBACxB,YAAY,EAAE,OAAO;aACtB;YACD;gBACE,QAAQ,EAAE,oBAAoB;gBAC9B,YAAY,EAAE,MAAM;aACrB;SACF;KACF,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,eAAe,GAAG,IAAI,mBAAe,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,kBAAkB,GAAG,IAAI,iDAAuB,CAAmB;YACvE,WAAW,EAAE,EAAE;SAChB,CAAC,CAAC;QACH,IAAA,wCAAqB,EAAC,kBAAkB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtE,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,kBAAkB,GAAG,IAAI,iDAAuB,CAAmB;YACvE,WAAW,EAAE,CAAC,oBAAoB,CAAC;SACpC,CAAC,CAAC;QACH,IAAA,wCAAqB,EAAC,kBAAkB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtE,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,kBAAkB,GAAG,IAAI,iDAAuB,CAAmB;YACvE,WAAW,EAAE,CAAC,uBAAuB,CAAC;SACvC,CAAC,CAAC;QACH,IAAA,wCAAqB,EAAC,kBAAkB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtE,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,kBAAkB,GAAG,IAAI,iDAAuB,CAAmB;YACvE,WAAW,EAAE;gBACX,oBAAoB;gBACpB,uBAAuB;gBACvB,oBAAoB;aACrB;SACF,CAAC,CAAC;QACH,IAAA,wCAAqB,EAAC,kBAAkB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtE,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,eAAe,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/validation/requiredKeyValidator.js

@@ -16,7 +16,7 @@ class RequiredKeyValidator {
     }
     doValidations() {
         this.validations = this.keys.map((k) => {
-            const value = this.doc.documentRecord[k.toLowerCase()];
+            const value = this.doc.getRecordValue(k);
             if (this.isValueCorrectType(value)) {
                 return { value, message: null };
             }

package/dist/validation/requiredKeyValidator.js.map

@@ -1 +1 @@
-{"version":3,"file":"requiredKeyValidator.js","sourceRoot":"","sources":["../../src/validation/requiredKeyValidator.ts"],"names":[],"mappings":";;;AAGA,MAAa,oBAAoB;IAI/B,YACE,CAAoB,EACZ,GAA8C,EAC9C,MAAsB;QADtB,QAAG,GAAH,GAAG,CAA2C;QAC9C,WAAM,GAAN,MAAM,CAAgB;QALxB,gBAAW,GAAmD,EAAE,CAAC;QAOvE,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACpB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;SACf;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;SACjB;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE;gBAClC,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAC,CAAC;aAC/B;YACD,OAAO;gBACL,KAAK,EAAE,KAAgB;gBACvB,OAAO,EAAE,0CAA0C,CAAC,KAAK,IAAI,CAAC,oBAAoB,CAChF,KAAK,CACN,EAAE;aACJ,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,IAAW,KAAK;QACd,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAU,CAAC;SACxC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,EAAE,CAAC;SACX;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAQ,CAAC;IACzC,CAAC;IAED,IAAY,YAAY;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED,IAAY,cAAc;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEO,oBAAoB,CAAC,KAAuB;QAClD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAU,CAAC,CAAC;IAC1C,CAAC;IAEO,kBAAkB,CAAC,KAAuB;QAChD,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC3D,IAAI,iBAAiB,EAAE;YACrB,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArED,oDAqEC"}
+{"version":3,"file":"requiredKeyValidator.js","sourceRoot":"","sources":["../../src/validation/requiredKeyValidator.ts"],"names":[],"mappings":";;;AAGA,MAAa,oBAAoB;IAI/B,YACE,CAAoB,EACZ,GAA8C,EAC9C,MAAsB;QADtB,QAAG,GAAH,GAAG,CAA2C;QAC9C,WAAM,GAAN,MAAM,CAAgB;QALxB,gBAAW,GAAmD,EAAE,CAAC;QAOvE,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACpB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;SACf;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;SACjB;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE;gBAClC,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAC,CAAC;aAC/B;YACD,OAAO;gBACL,KAAK,EAAE,KAAgB;gBACvB,OAAO,EAAE,0CAA0C,CAAC,KAAK,IAAI,CAAC,oBAAoB,CAChF,KAAK,CACN,EAAE;aACJ,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,IAAW,KAAK;QACd,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAU,CAAC;SACxC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,EAAE,CAAC;SACX;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAQ,CAAC;IACzC,CAAC;IAED,IAAY,YAAY;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED,IAAY,cAAc;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEO,oBAAoB,CAAC,KAAuB;QAClD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAU,CAAC,CAAC;IAC1C,CAAC;IAEO,kBAAkB,CAAC,KAAuB;QAChD,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC3D,IAAI,iBAAiB,EAAE;YACrB,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArED,oDAqEC"}

package/package.json

@@ -1,45 +1,52 @@
 {
   "name": "@coveo/push-api-client",
-  "version": "2.8.13",
+  "version": "3.0.1",
   "description": "Push API client",
   "main": "./dist/index.js",
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/definitions/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "type": "commonjs",
   "types": "./dist/definitions/index.d.ts",
   "dependencies": {
     "@coveo/bueno": "^0.43.0",
-    "@coveo/platform-client": "40.1.0",
-    "abortcontroller-polyfill": "^1.7.1",
-    "axios": "^1.2.0",
+    "@coveo/platform-client": "40.7.0",
     "dayjs": "^1.10.4",
     "exponential-backoff": "^3.1.0",
-    "isomorphic-fetch": "^3.0.0",
+    "fetch-undici-polyfill": "^1.1.2",
     "zod": "^3.20.2"
   },
   "devDependencies": {
-    "@coveo/push-api-client": "file:.",
-    "@types/jest": "29.2.5",
-    "@types/node": "18.11.18",
-    "@typescript-eslint/eslint-plugin": "5.48.1",
-    "@typescript-eslint/parser": "5.48.1",
+    "@coveo/semantic-monorepo-tools": "1.5.21",
+    "@octokit/auth-action": "^2.0.3",
+    "@types/jest": "29.4.0",
+    "@types/node": "18.11.19",
+    "@typescript-eslint/eslint-plugin": "5.50.0",
+    "@typescript-eslint/parser": "5.50.0",
+    "conventional-changelog-angular": "5.0.13",
     "cz-conventional-changelog": "3.3.0",
     "detect-indent": "7.0.1",
     "dotenv": "16.0.3",
-    "eslint": "8.32.0",
+    "eslint": "8.33.0",
     "eslint-config-prettier": "8.6.0",
     "gts": "3.1.1",
     "husky": "8.0.3",
-    "jest": "29.3.1",
+    "jest": "29.4.1",
     "lint-staged": "13.1.0",
     "nodemon": "2.0.20",
+    "octokit": "2.0.14",
     "prettier": "2.8.3",
-    "standard-version": "9.5.0",
     "ts-jest": "29.0.5",
     "ts-node": "10.9.1",
     "typedoc": "0.23.24",
-    "typescript": "4.9.4"
+    "typescript": "4.9.5",
+    "undici": "^5.16.0"
   },
   "husky": {
     "hooks": {
@@ -62,21 +69,20 @@
     "**/*.ts": "eslint --fix"
   },
   "engines": {
-    "node": ">=14.16.1"
+    "node": ">=16.x"
   },
   "scripts": {
     "build": "tsc",
     "test": "jest",
     "test:dev": "jest --watch",
     "dev": "nodemon --watch \"src/**\" --ext \"ts,json\" --ignore \"src/**/*.spec.ts\" --exec \"ts-node src/localtest.ts\"",
-    "lint": "prettier --config ./.prettierrc.js --check ./src && eslint ./src",
+    "lint": "prettier --config ./.prettierrc.js --check . && eslint .",
     "lint:check": "eslint .",
     "lint:fix": "eslint --fix .",
     "prettier:check": "prettier .",
     "prettier:fix": "prettier --write .",
     "commit": "git-cz",
-    "release": "standard-version && git push && git push --tags",
-    "prepublishOnly": "npm run release && npm run doc",
+    "release": "node release.mjs && npm run doc",
     "doc": "typedoc --out ./dist/docs ./src/index.ts"
   },
   "repository": {

package/dist/definitions/source/source.d.ts

@@ -1,5 +0,0 @@
-import { PushSource } from './push';
-/**
- * @deprecated This class has been replaced by {@link PushSource}
- */
-export declare const Source: typeof PushSource;

package/dist/docs/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.