jsii 5.4.16-dev.2 → 5.4.16-dev.3

package/lib/tsconfig/validator.js

@@ -0,0 +1,301 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectValidator = exports.ValidationError = exports.Match = exports.RuleSet = exports.RuleType = void 0;
+var RuleType;
+(function (RuleType) {
+    RuleType[RuleType["PASS"] = 0] = "PASS";
+    RuleType[RuleType["FAIL"] = 1] = "FAIL";
+})(RuleType || (exports.RuleType = RuleType = {}));
+class RuleSet {
+    get rules() {
+        return this._rules;
+    }
+    /**
+     * Return all fields for which a rule exists
+     */
+    get fields() {
+        return [...new Set(this._rules.map((r) => r.field))];
+    }
+    /**
+     * Return a list of fields that are allowed, or undefined if all are allowed.
+     */
+    get allowedFields() {
+        if (this.options.unexpectedFields === RuleType.FAIL) {
+            return this.fields;
+        }
+        return undefined;
+    }
+    /**
+     * Find all required fields by evaluating every rule in th set against undefined.
+     * If the rule fails, the key must be required.
+     *
+     * @returns A list of keys that must be included or undefined
+     */
+    get requiredFields() {
+        const required = [];
+        for (const rule of this._rules) {
+            const key = rule.field;
+            const matcherResult = rule.matcher(undefined);
+            switch (rule.type) {
+                case RuleType.PASS:
+                    if (!matcherResult) {
+                        required.push(key);
+                    }
+                    break;
+                case RuleType.FAIL:
+                    if (matcherResult) {
+                        required.push(key);
+                    }
+                    break;
+                default:
+                    continue;
+            }
+        }
+        return required;
+    }
+    constructor(options = {
+        unexpectedFields: RuleType.PASS,
+    }) {
+        this.options = options;
+        this._rules = [];
+    }
+    /**
+     * Requires the matcher to pass for the given field.
+     * Otherwise a violation is detected.
+     *
+     * @param field The field the rule applies to
+     * @param matcher The matcher function
+     */
+    shouldPass(field, matcher) {
+        this._rules.push({ field, matcher, type: RuleType.PASS });
+    }
+    /**
+     * Detects a violation if the matcher is matching for a certain field.
+     *
+     * @param field The field the rule applies to
+     * @param matcher The matcher function
+     */
+    shouldFail(field, matcher) {
+        this._rules.push({ field, matcher, type: RuleType.FAIL });
+    }
+    /**
+     * Imports all rules from an other rule set.
+     * Note that any options from the other rule set will be ignored.
+     *
+     * @param other The other rule set to import rules from.
+     */
+    import(other) {
+        this._rules.push(...other.rules);
+    }
+    /**
+     * Records the field hints for the given rule set.
+     * Hints are values that are guaranteed to pass the rule.
+     * The list of hints is not guaranteed to be complete nor does it guarantee to return any values.
+     * This can be used to create synthetic values for testing for error messages.
+     *
+     * @returns A record of fields and allowed values
+     */
+    getFieldHints() {
+        const fieldHints = {};
+        for (const rule of this._rules) {
+            // We are only interested in PASS rules here.
+            // For FAILs we still don't know which values would pass.
+            if (rule.type === RuleType.PASS) {
+                // run the matcher to record hints
+                rule.matcher(undefined, {
+                    hints: (receivedHints) => {
+                        var _a;
+                        // if we have recorded hints, add them to the map
+                        if (receivedHints) {
+                            fieldHints[_a = rule.field] ?? (fieldHints[_a] = []);
+                            fieldHints[rule.field].push(...receivedHints);
+                        }
+                    },
+                });
+            }
+        }
+        return fieldHints;
+    }
+}
+exports.RuleSet = RuleSet;
+/**
+ * Helper to wrap a matcher with error reporting and hints
+ */
+function wrapMatcher(matcher, message, allowed) {
+    return (value, options) => {
+        options?.reporter?.(message(value));
+        if (allowed) {
+            options?.hints?.(allowed);
+        }
+        return matcher(value);
+    };
+}
+class Match {
+    /**
+     * Value is optional, but if present should match
+     */
+    static optional(matcher) {
+        return (value, options) => {
+            if (value == null) {
+                return true;
+            }
+            return matcher(value, options);
+        };
+    }
+    /**
+     * Value must be one of the allowed options
+     */
+    static oneOf(...allowed) {
+        return wrapMatcher((actual) => allowed.includes(actual), (actual) => `Expected value to be one of ${JSON.stringify(allowed)}, got: ${JSON.stringify(actual)}`, allowed);
+    }
+    /**
+     * Value must be loosely equal to the expected value
+     * Arrays are compared by elements
+     */
+    static eq(expected) {
+        return (actual, options) => {
+            if (Array.isArray(expected)) {
+                return Match.arrEq(expected)(actual, options);
+            }
+            try {
+                options?.hints?.([expected]);
+                options?.reporter?.(`Expected value ${JSON.stringify(expected)}, got: ${JSON.stringify(actual)}`);
+                return actual == expected;
+            }
+            catch {
+                // some values cannot compared using loose quality, in this case the matcher just fails
+                return false;
+            }
+        };
+    }
+    /**
+     * Value must be loosely equal to the expected value
+     * Arrays are compared by elements
+     */
+    static arrEq(expected) {
+        return wrapMatcher((actual) => {
+            try {
+                // if both are arrays and of the same length, compare elements
+                // if one of them is not, or they are a different length,
+                // skip comparing elements as the the equality check later will fail
+                if (Array.isArray(expected) && Array.isArray(actual) && expected.length == actual.length) {
+                    // compare all elements with loose typing
+                    return expected.every((e) => actual.some((a) => a == e));
+                }
+                // all other values and arrays of different shape
+                return actual == expected;
+            }
+            catch {
+                // some values cannot compared using loose quality, in this case the matcher just fails
+                return false;
+            }
+        }, (actual) => `Expected array matching ${JSON.stringify(expected)}, got: ${JSON.stringify(actual)}`, [expected]);
+    }
+    /**
+     * Compare strings, allows setting cases sensitivity
+     */
+    static strEq(expected, caseSensitive = false) {
+        return wrapMatcher((actual) => {
+            // case insensitive
+            if (!caseSensitive && typeof actual === 'string') {
+                return expected.toLowerCase() == actual.toLowerCase();
+            }
+            // case sensitive
+            return actual == expected;
+        }, (actual) => `Expected string ${JSON.stringify(expected)}, got ${JSON.stringify(actual)}`, [expected]);
+    }
+}
+exports.Match = Match;
+/**
+ * Allows any value
+ */
+Match.ANY = (_val, _options) => true;
+// eslint-disable-next-line @typescript-eslint/member-ordering
+Match.TRUE = Match.eq(true);
+// eslint-disable-next-line @typescript-eslint/member-ordering
+Match.FALSE = Match.eq(false);
+/**
+ * Missing (undefined) value
+ */
+// eslint-disable-next-line @typescript-eslint/member-ordering
+Match.MISSING = wrapMatcher((actual) => actual === null || actual === undefined, (actual) => `Expected value to be present, got ${JSON.stringify(actual)}`, [undefined, null]);
+class ValidationError extends Error {
+    constructor(violations) {
+        // error message is a list of violations
+        super('Data is invalid:\n' + violations.map((v) => v.field + ': ' + v.message).join('\n'));
+        this.violations = violations;
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, ValidationError.prototype);
+    }
+}
+exports.ValidationError = ValidationError;
+class ObjectValidator {
+    constructor(ruleSet, dataName = 'data') {
+        this.ruleSet = ruleSet;
+        this.dataName = dataName;
+    }
+    /**
+     * Validated the provided data against the set of rules.
+     *
+     * @throws when the data is invalid
+     *
+     * @param data the data to be validated
+     */
+    validate(data) {
+        // make sure data is an object
+        if (!(typeof data === 'object' && !Array.isArray(data) && data !== null)) {
+            throw new ValidationError([
+                { field: this.dataName, message: 'Provided data must be an object, got: ' + JSON.stringify(data) },
+            ]);
+        }
+        const checkedFields = new Set();
+        const violations = [];
+        // first check all defined rules
+        for (const rule of this.ruleSet.rules) {
+            const value = data[rule.field];
+            // Use a fallback message, but allow the matcher to report a better arrow
+            let violationMessage = 'Value is not allowed, got: ' + JSON.stringify(value);
+            const matchResult = rule.matcher(value, {
+                reporter: (message) => {
+                    violationMessage = message;
+                },
+            });
+            switch (rule.type) {
+                case RuleType.PASS:
+                    if (!matchResult) {
+                        violations.push({
+                            field: rule.field,
+                            message: violationMessage,
+                        });
+                    }
+                    break;
+                case RuleType.FAIL:
+                    if (matchResult) {
+                        violations.push({
+                            field: rule.field,
+                            message: violationMessage,
+                        });
+                    }
+                    break;
+                default:
+                    continue;
+            }
+            checkedFields.add(rule.field);
+        }
+        // finally check fields without any rules if they should fail the validation
+        if (this.ruleSet.options.unexpectedFields === RuleType.FAIL) {
+            const receivedFields = Object.keys(data);
+            for (const field of receivedFields) {
+                if (!checkedFields.has(field)) {
+                    violations.push({ field: field, message: `Unexpected field, got: ${field}` });
+                }
+            }
+        }
+        // if we have encountered a violation, throw an error
+        if (violations.length > 0) {
+            throw new ValidationError(violations);
+        }
+    }
+}
+exports.ObjectValidator = ObjectValidator;
+//# sourceMappingURL=validator.js.map

package/lib/tsconfig/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/tsconfig/validator.ts"],"names":[],"mappings":";;;AA2BA,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,uCAAI,CAAA;IACJ,uCAAI,CAAA;AACN,CAAC,EAHW,QAAQ,wBAAR,QAAQ,QAGnB;AAmBD,MAAa,OAAO;IAElB,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;YACpD,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,IAAW,cAAc;QACvB,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAE9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,QAAQ,CAAC,IAAI;oBAChB,IAAI,CAAC,aAAa,EAAE,CAAC;wBACnB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACrB,CAAC;oBACD,MAAM;gBACR,KAAK,QAAQ,CAAC,IAAI;oBAChB,IAAI,aAAa,EAAE,CAAC;wBAClB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACrB,CAAC;oBACD,MAAM;gBACR;oBACE,SAAS;YACb,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YACkB,UAA0B;QACxC,gBAAgB,EAAE,QAAQ,CAAC,IAAI;KAChC;QAFe,YAAO,GAAP,OAAO,CAEtB;QA1DK,WAAM,GAAgB,EAAE,CAAC;IA2D9B,CAAC;IAEJ;;;;;;OAMG;IACI,UAAU,CAAC,KAAa,EAAE,OAAgB;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,KAAa,EAAE,OAAgB;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAc;QAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACI,aAAa;QAClB,MAAM,UAAU,GAA0B,EAAE,CAAC;QAE7C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,6CAA6C;YAC7C,yDAAyD;YACzD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAChC,kCAAkC;gBAClC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;oBACtB,KAAK,EAAE,CAAC,aAAoB,EAAE,EAAE;;wBAC9B,iDAAiD;wBACjD,IAAI,aAAa,EAAE,CAAC;4BAClB,UAAU,MAAC,IAAI,CAAC,KAAK,MAArB,UAAU,OAAiB,EAAE,EAAC;4BAC9B,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;wBAChD,CAAC;oBACH,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AA3HD,0BA2HC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,OAAgB,EAAE,OAAgC,EAAE,OAAe;IACtF,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACxB,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC;AAED,MAAa,KAAK;IAChB;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,OAAgB;QACrC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACxB,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,GAAG,OAA+B;QACpD,OAAO,WAAW,CAChB,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EACpC,CAAC,MAAM,EAAE,EAAE,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACpG,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,EAAE,CAAC,QAAa;QAC5B,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YACzB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC7B,OAAO,EAAE,QAAQ,EAAE,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAClG,OAAO,MAAM,IAAI,QAAQ,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,uFAAuF;gBACvF,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,QAAe;QACjC,OAAO,WAAW,CAChB,CAAC,MAAM,EAAE,EAAE;YACT,IAAI,CAAC;gBACH,8DAA8D;gBAC9D,yDAAyD;gBACzD,oEAAoE;gBACpE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBACzF,yCAAyC;oBACzC,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC3D,CAAC;gBAED,iDAAiD;gBACjD,OAAO,MAAM,IAAI,QAAQ,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,uFAAuF;gBACvF,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC,EACD,CAAC,MAAM,EAAE,EAAE,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACjG,CAAC,QAAQ,CAAC,CACX,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,QAAgB,EAAE,aAAa,GAAG,KAAK;QACzD,OAAO,WAAW,CAChB,CAAC,MAAM,EAAE,EAAE;YACT,mBAAmB;YACnB,IAAI,CAAC,aAAa,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACjD,OAAO,QAAQ,CAAC,WAAW,EAAE,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACxD,CAAC;YAED,iBAAiB;YACjB,OAAO,MAAM,IAAI,QAAQ,CAAC;QAC5B,CAAC,EACD,CAAC,MAAW,EAAE,EAAE,CAAC,mBAAmB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAC7F,CAAC,QAAQ,CAAC,CACX,CAAC;IACJ,CAAC;;AA1FH,sBA+GC;AAnBC;;GAEG;AACW,SAAG,GAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC;AAEtD,8DAA8D;AAChD,UAAI,GAAY,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AAC7C,8DAA8D;AAChD,WAAK,GAAY,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AAE/C;;GAEG;AACH,8DAA8D;AAChD,aAAO,GAAG,WAAW,CACjC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EACnD,CAAC,MAAM,EAAE,EAAE,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACzE,CAAC,SAAS,EAAE,IAAI,CAAC,CAClB,CAAC;AAQJ,MAAa,eAAgB,SAAQ,KAAK;IACxC,YAA4B,UAAuB;QACjD,wCAAwC;QACxC,KAAK,CAAC,oBAAoB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAFjE,eAAU,GAAV,UAAU,CAAa;QAIjD,gCAAgC;QAChC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AARD,0CAQC;AAED,MAAa,eAAe;IAC1B,YAA0B,OAAgB,EAAmB,WAAmB,MAAM;QAA5D,YAAO,GAAP,OAAO,CAAS;QAAmB,aAAQ,GAAR,QAAQ,CAAiB;IAAG,CAAC;IAE1F;;;;;;OAMG;IACI,QAAQ,CAAC,IAA8B;QAC5C,8BAA8B;QAC9B,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACzE,MAAM,IAAI,eAAe,CAAC;gBACxB,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,wCAAwC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;aACnG,CAAC,CAAC;QACL,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;QAChC,MAAM,UAAU,GAAgB,EAAE,CAAC;QAEnC,gCAAgC;QAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE/B,yEAAyE;YACzE,IAAI,gBAAgB,GAAG,6BAA6B,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC7E,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;gBACtC,QAAQ,EAAE,CAAC,OAAe,EAAE,EAAE;oBAC5B,gBAAgB,GAAG,OAAO,CAAC;gBAC7B,CAAC;aACF,CAAC,CAAC;YAEH,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,QAAQ,CAAC,IAAI;oBAChB,IAAI,CAAC,WAAW,EAAE,CAAC;wBACjB,UAAU,CAAC,IAAI,CAAC;4BACd,KAAK,EAAE,IAAI,CAAC,KAAK;4BACjB,OAAO,EAAE,gBAAgB;yBAC1B,CAAC,CAAC;oBACL,CAAC;oBACD,MAAM;gBACR,KAAK,QAAQ,CAAC,IAAI;oBAChB,IAAI,WAAW,EAAE,CAAC;wBAChB,UAAU,CAAC,IAAI,CAAC;4BACd,KAAK,EAAE,IAAI,CAAC,KAAK;4BACjB,OAAO,EAAE,gBAAgB;yBAC1B,CAAC,CAAC;oBACL,CAAC;oBACD,MAAM;gBACR;oBACE,SAAS;YACb,CAAC;YAED,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,4EAA4E;QAC5E,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;gBACnC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC9B,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,0BAA0B,KAAK,EAAE,EAAE,CAAC,CAAC;gBAChF,CAAC;YACH,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;CACF;AAxED,0CAwEC","sourcesContent":["/**\n * A function that receives 3 arguments and validates if the provided value matches.\n * @param value The value to validate\n * @params options Additional options to influence the matcher behavior.\n * @returns true if the value matches\n */\ntype Matcher = (value: any, options?: MatcherOptions) => boolean;\n\ninterface MatcherOptions {\n  /**\n   * A function that will be called by the matcher with a a violation message.\n   * This function is always called, regardless of the outcome of the matcher.\n   * It is up to the caller of the matcher to decide if the message should be used or not.\n   *\n   * @param message The message describing the possible failure.\n   */\n  reporter?: (message: string) => void;\n  /**\n   * A function that might receive explicitly allowed values.\n   * This can be used to generate synthetics values that would match the matcher.\n   * It is not guaranteed that hints are received or that hints are complete.\n   *\n   * @param allowed The list values that a matcher offers as definitely allowed.\n   */\n  hints?: (allowed: any[]) => void;\n}\n\nexport enum RuleType {\n  PASS,\n  FAIL,\n}\n\nexport interface RuleSetOptions {\n  /**\n   * Defines the behavior for any encountered fields for which no rules are defined.\n   * The default is to pass these fields without validation,\n   * but this can also be set to fail any unexpected fields.\n   *\n   * @default RuleType.PASS\n   */\n  readonly unexpectedFields: RuleType;\n}\n\ninterface Rule {\n  field: string;\n  type: RuleType;\n  matcher: Matcher;\n}\n\nexport class RuleSet {\n  private _rules: Array<Rule> = [];\n  public get rules(): Array<Rule> {\n    return this._rules;\n  }\n\n  /**\n   * Return all fields for which a rule exists\n   */\n  public get fields(): Array<string> {\n    return [...new Set(this._rules.map((r) => r.field))];\n  }\n\n  /**\n   * Return a list of fields that are allowed, or undefined if all are allowed.\n   */\n  public get allowedFields(): Array<string> | undefined {\n    if (this.options.unexpectedFields === RuleType.FAIL) {\n      return this.fields;\n    }\n\n    return undefined;\n  }\n\n  /**\n   * Find all required fields by evaluating every rule in th set against undefined.\n   * If the rule fails, the key must be required.\n   *\n   * @returns A list of keys that must be included or undefined\n   */\n  public get requiredFields(): Array<string> {\n    const required: string[] = [];\n\n    for (const rule of this._rules) {\n      const key = rule.field;\n      const matcherResult = rule.matcher(undefined);\n\n      switch (rule.type) {\n        case RuleType.PASS:\n          if (!matcherResult) {\n            required.push(key);\n          }\n          break;\n        case RuleType.FAIL:\n          if (matcherResult) {\n            required.push(key);\n          }\n          break;\n        default:\n          continue;\n      }\n    }\n\n    return required;\n  }\n\n  public constructor(\n    public readonly options: RuleSetOptions = {\n      unexpectedFields: RuleType.PASS,\n    },\n  ) {}\n\n  /**\n   * Requires the matcher to pass for the given field.\n   * Otherwise a violation is detected.\n   *\n   * @param field The field the rule applies to\n   * @param matcher The matcher function\n   */\n  public shouldPass(field: string, matcher: Matcher) {\n    this._rules.push({ field, matcher, type: RuleType.PASS });\n  }\n\n  /**\n   * Detects a violation if the matcher is matching for a certain field.\n   *\n   * @param field The field the rule applies to\n   * @param matcher The matcher function\n   */\n  public shouldFail(field: string, matcher: Matcher) {\n    this._rules.push({ field, matcher, type: RuleType.FAIL });\n  }\n\n  /**\n   * Imports all rules from an other rule set.\n   * Note that any options from the other rule set will be ignored.\n   *\n   * @param other The other rule set to import rules from.\n   */\n  public import(other: RuleSet) {\n    this._rules.push(...other.rules);\n  }\n\n  /**\n   * Records the field hints for the given rule set.\n   * Hints are values that are guaranteed to pass the rule.\n   * The list of hints is not guaranteed to be complete nor does it guarantee to return any values.\n   * This can be used to create synthetic values for testing for error messages.\n   *\n   * @returns A record of fields and allowed values\n   */\n  public getFieldHints(): Record<string, any[]> {\n    const fieldHints: Record<string, any[]> = {};\n\n    for (const rule of this._rules) {\n      // We are only interested in PASS rules here.\n      // For FAILs we still don't know which values would pass.\n      if (rule.type === RuleType.PASS) {\n        // run the matcher to record hints\n        rule.matcher(undefined, {\n          hints: (receivedHints: any[]) => {\n            // if we have recorded hints, add them to the map\n            if (receivedHints) {\n              fieldHints[rule.field] ??= [];\n              fieldHints[rule.field].push(...receivedHints);\n            }\n          },\n        });\n      }\n    }\n\n    return fieldHints;\n  }\n}\n\n/**\n * Helper to wrap a matcher with error reporting and hints\n */\nfunction wrapMatcher(matcher: Matcher, message: (actual: any) => string, allowed?: any[]): Matcher {\n  return (value, options) => {\n    options?.reporter?.(message(value));\n    if (allowed) {\n      options?.hints?.(allowed);\n    }\n    return matcher(value);\n  };\n}\n\nexport class Match {\n  /**\n   * Value is optional, but if present should match\n   */\n  public static optional(matcher: Matcher): Matcher {\n    return (value, options) => {\n      if (value == null) {\n        return true;\n      }\n      return matcher(value, options);\n    };\n  }\n\n  /**\n   * Value must be one of the allowed options\n   */\n  public static oneOf(...allowed: Array<string | number>): Matcher {\n    return wrapMatcher(\n      (actual) => allowed.includes(actual),\n      (actual) => `Expected value to be one of ${JSON.stringify(allowed)}, got: ${JSON.stringify(actual)}`,\n      allowed,\n    );\n  }\n\n  /**\n   * Value must be loosely equal to the expected value\n   * Arrays are compared by elements\n   */\n  public static eq(expected: any): Matcher {\n    return (actual, options) => {\n      if (Array.isArray(expected)) {\n        return Match.arrEq(expected)(actual, options);\n      }\n\n      try {\n        options?.hints?.([expected]);\n        options?.reporter?.(`Expected value ${JSON.stringify(expected)}, got: ${JSON.stringify(actual)}`);\n        return actual == expected;\n      } catch {\n        // some values cannot compared using loose quality, in this case the matcher just fails\n        return false;\n      }\n    };\n  }\n\n  /**\n   * Value must be loosely equal to the expected value\n   * Arrays are compared by elements\n   */\n  public static arrEq(expected: any[]): Matcher {\n    return wrapMatcher(\n      (actual) => {\n        try {\n          // if both are arrays and of the same length, compare elements\n          // if one of them is not, or they are a different length,\n          // skip comparing elements as the the equality check later will fail\n          if (Array.isArray(expected) && Array.isArray(actual) && expected.length == actual.length) {\n            // compare all elements with loose typing\n            return expected.every((e) => actual.some((a) => a == e));\n          }\n\n          // all other values and arrays of different shape\n          return actual == expected;\n        } catch {\n          // some values cannot compared using loose quality, in this case the matcher just fails\n          return false;\n        }\n      },\n      (actual) => `Expected array matching ${JSON.stringify(expected)}, got: ${JSON.stringify(actual)}`,\n      [expected],\n    );\n  }\n\n  /**\n   * Compare strings, allows setting cases sensitivity\n   */\n  public static strEq(expected: string, caseSensitive = false): Matcher {\n    return wrapMatcher(\n      (actual) => {\n        // case insensitive\n        if (!caseSensitive && typeof actual === 'string') {\n          return expected.toLowerCase() == actual.toLowerCase();\n        }\n\n        // case sensitive\n        return actual == expected;\n      },\n      (actual: any) => `Expected string ${JSON.stringify(expected)}, got ${JSON.stringify(actual)}`,\n      [expected],\n    );\n  }\n\n  /**\n   * Allows any value\n   */\n  public static ANY: Matcher = (_val, _options) => true;\n\n  // eslint-disable-next-line @typescript-eslint/member-ordering\n  public static TRUE: Matcher = Match.eq(true);\n  // eslint-disable-next-line @typescript-eslint/member-ordering\n  public static FALSE: Matcher = Match.eq(false);\n\n  /**\n   * Missing (undefined) value\n   */\n  // eslint-disable-next-line @typescript-eslint/member-ordering\n  public static MISSING = wrapMatcher(\n    (actual) => actual === null || actual === undefined,\n    (actual) => `Expected value to be present, got ${JSON.stringify(actual)}`,\n    [undefined, null],\n  );\n}\n\nexport interface Violation {\n  field: string;\n  message: string;\n}\n\nexport class ValidationError extends Error {\n  constructor(public readonly violations: Violation[]) {\n    // error message is a list of violations\n    super('Data is invalid:\\n' + violations.map((v) => v.field + ': ' + v.message).join('\\n'));\n\n    // Set the prototype explicitly.\n    Object.setPrototypeOf(this, ValidationError.prototype);\n  }\n}\n\nexport class ObjectValidator {\n  public constructor(public ruleSet: RuleSet, private readonly dataName: string = 'data') {}\n\n  /**\n   * Validated the provided data against the set of rules.\n   *\n   * @throws when the data is invalid\n   *\n   * @param data the data to be validated\n   */\n  public validate(data: { [field: string]: any }) {\n    // make sure data is an object\n    if (!(typeof data === 'object' && !Array.isArray(data) && data !== null)) {\n      throw new ValidationError([\n        { field: this.dataName, message: 'Provided data must be an object, got: ' + JSON.stringify(data) },\n      ]);\n    }\n\n    const checkedFields = new Set();\n    const violations: Violation[] = [];\n\n    // first check all defined rules\n    for (const rule of this.ruleSet.rules) {\n      const value = data[rule.field];\n\n      // Use a fallback message, but allow the matcher to report a better arrow\n      let violationMessage = 'Value is not allowed, got: ' + JSON.stringify(value);\n      const matchResult = rule.matcher(value, {\n        reporter: (message: string) => {\n          violationMessage = message;\n        },\n      });\n\n      switch (rule.type) {\n        case RuleType.PASS:\n          if (!matchResult) {\n            violations.push({\n              field: rule.field,\n              message: violationMessage,\n            });\n          }\n          break;\n        case RuleType.FAIL:\n          if (matchResult) {\n            violations.push({\n              field: rule.field,\n              message: violationMessage,\n            });\n          }\n          break;\n        default:\n          continue;\n      }\n\n      checkedFields.add(rule.field);\n    }\n\n    // finally check fields without any rules if they should fail the validation\n    if (this.ruleSet.options.unexpectedFields === RuleType.FAIL) {\n      const receivedFields = Object.keys(data);\n      for (const field of receivedFields) {\n        if (!checkedFields.has(field)) {\n          violations.push({ field: field, message: `Unexpected field, got: ${field}` });\n        }\n      }\n    }\n\n    // if we have encountered a violation, throw an error\n    if (violations.length > 0) {\n      throw new ValidationError(violations);\n    }\n  }\n}\n"]}

package/lib/version.d.ts

@@ -1,7 +1,7 @@
 /** The short version number for this JSII compiler (e.g: `X.Y.Z`) */
-export declare const SHORT_VERSION = "5.4.16-dev.2";
+export declare const SHORT_VERSION = "5.4.16-dev.3";
 /** The qualified version number for this JSII compiler (e.g: `X.Y.Z (build #######)`) */
-export declare const VERSION = "5.4.16-dev.2 (build c762304)";
+export declare const VERSION = "5.4.16-dev.3 (build 14a51b9)";
 /** The release line identifier for this JSII compiler (e.g: `X.Y`) */
 export declare const RELEASE_LINE = "5.4";
 //# sourceMappingURL=version.d.ts.map

package/lib/version.js

@@ -4,9 +4,9 @@ exports.RELEASE_LINE = exports.VERSION = exports.SHORT_VERSION = void 0;
 const typescript_1 = require("typescript");
 // GENERATED: This file is generated by build-tools/code-gen.ts -- Do not edit by hand!
 /** The short version number for this JSII compiler (e.g: `X.Y.Z`) */
-exports.SHORT_VERSION = '5.4.16-dev.2';
+exports.SHORT_VERSION = '5.4.16-dev.3';
 /** The qualified version number for this JSII compiler (e.g: `X.Y.Z (build #######)`) */
-exports.VERSION = '5.4.16-dev.2 (build c762304)';
+exports.VERSION = '5.4.16-dev.3 (build 14a51b9)';
 /** The release line identifier for this JSII compiler (e.g: `X.Y`) */
 exports.RELEASE_LINE = typescript_1.versionMajorMinor;
 //# sourceMappingURL=version.js.map

package/lib/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA,2CAA8C;AAE9C,uFAAuF;AAEvF,qEAAqE;AACxD,QAAA,aAAa,GAAG,cAAc,CAAC;AAE5C,yFAAyF;AAC5E,QAAA,OAAO,GAAG,8BAA8B,CAAC;AAEtD,sEAAsE;AACzD,QAAA,YAAY,GAAG,8BAAiB,CAAC","sourcesContent":["import { versionMajorMinor } from 'typescript'\n\n// GENERATED: This file is generated by build-tools/code-gen.ts -- Do not edit by hand!\n\n/** The short version number for this JSII compiler (e.g: `X.Y.Z`) */\nexport const SHORT_VERSION = '5.4.16-dev.2';\n\n/** The qualified version number for this JSII compiler (e.g: `X.Y.Z (build #######)`) */\nexport const VERSION = '5.4.16-dev.2 (build c762304)';\n\n/** The release line identifier for this JSII compiler (e.g: `X.Y`) */\nexport const RELEASE_LINE = versionMajorMinor;\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAE/C,uFAAuF;AAEvF,qEAAqE;AACxD,QAAA,aAAa,GAAG,cAAc,CAAC;AAE5C,yFAAyF;AAC5E,QAAA,OAAO,GAAG,8BAA8B,CAAC;AAEtD,sEAAsE;AACzD,QAAA,YAAY,GAAG,8BAAiB,CAAC","sourcesContent":["import { versionMajorMinor } from 'typescript';\n\n// GENERATED: This file is generated by build-tools/code-gen.ts -- Do not edit by hand!\n\n/** The short version number for this JSII compiler (e.g: `X.Y.Z`) */\nexport const SHORT_VERSION = '5.4.16-dev.3';\n\n/** The qualified version number for this JSII compiler (e.g: `X.Y.Z (build #######)`) */\nexport const VERSION = '5.4.16-dev.3 (build 14a51b9)';\n\n/** The release line identifier for this JSII compiler (e.g: `X.Y`) */\nexport const RELEASE_LINE = versionMajorMinor;\n"]}

package/package.json

@@ -56,6 +56,7 @@
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-unicorn": "^46.0.1",
+    "fast-check": "^3.18.0",
     "glob": "^10.3.15",
     "jest": "^29.7.0",
     "jsii-1.x": "npm:jsii@1",
@@ -89,7 +90,7 @@
   "main": "lib/index.js",
   "license": "Apache-2.0",
   "homepage": "https://aws.github.io/jsii",
-  "version": "5.4.16-dev.2",
+  "version": "5.4.16-dev.3",
   "types": "lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",