@fgv/ts-utils 1.9.4 → 2.0.0

package/lib/packlets/validation/field.js

@@ -0,0 +1,71 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldValidator = void 0;
+const base_1 = require("../base");
+const validatorBase_1 = require("./validatorBase");
+/**
+ * An in-place {@link Validation.Validator | Validator} for properties
+ * an an object.
+ * @public
+ */
+class FieldValidator extends validatorBase_1.ValidatorBase {
+    /**
+     * Constructs a new {@link Validation.FieldValidator | FieldValidator.}.
+     * @param fieldName - The name of the property that this validator should validate.
+     * @param fieldValidator - The {@link Validation.Validator | Validator} to be applied
+     * against the named property.
+     * @param options - Additional {@link Validation.FieldValidatorOptions | options} to be
+     * applied to this validation.
+     */
+    constructor(fieldName, fieldValidator, options) {
+        super({ options });
+        this.fieldName = fieldName;
+        this.fieldValidator = fieldValidator;
+        // istanbul ignore next
+        this._fieldOptions = options !== null && options !== void 0 ? options : {};
+    }
+    /**
+     * {@inheritdoc Validation.ValidatorBase._validate}
+     */
+    _validate(from, context) {
+        if (typeof from === 'object' && !Array.isArray(from) && from !== null) {
+            const optional = this._fieldOptions.optional === true;
+            if ((0, base_1.isKeyOf)(this.fieldName, from)) {
+                if (!optional || from[this.fieldName] !== undefined) {
+                    const result = this.fieldValidator
+                        .validate(from[this.fieldName], context)
+                        .onFailure((message) => {
+                        return (0, base_1.fail)(`${this.fieldName}: ${message}`);
+                    });
+                    return result.success ? true : result;
+                }
+            }
+            return optional ? true : (0, base_1.fail)(`"${this.fieldName}": Field not found in "${JSON.stringify(from)}`);
+        }
+        // istanbul ignore next -- defense in depth
+        return (0, base_1.fail)(`Cannot validate field '${this.fieldName}' from non-object "${JSON.stringify(from)}"`);
+    }
+}
+exports.FieldValidator = FieldValidator;
+//# sourceMappingURL=field.js.map

package/lib/packlets/validation/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../../../src/packlets/validation/field.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAWhD;;;;GAIG;AACH,MAAa,cAAkC,SAAQ,6BAAoB;IAczE;;;;;;;OAOG;IACH,YACE,SAAiB,EACjB,cAAgC,EAChC,OAAmC;QAEnC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,uBAAuB;QACvB,IAAI,CAAC,aAAa,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;YACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,IAAI,CAAC;YAEtD,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;gBACjC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;oBACnD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc;yBAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;yBACvC,SAAS,CAAC,CAAC,OAAe,EAAE,EAAE;wBAC7B,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;oBAC/C,CAAC,CAAC,CAAC;oBAEL,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;iBACvC;aACF;YAED,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,IAAI,IAAI,CAAC,SAAS,0BAA0B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnG;QACD,2CAA2C;QAC3C,OAAO,IAAA,WAAI,EAAC,0BAA0B,IAAI,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrG,CAAC;CACF;AA1DD,wCA0DC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail, isKeyOf } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.FieldValidator | FieldValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface FieldValidatorOptions<TC> extends ValidatorOptions<TC> {\n  optional?: boolean;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} for properties\n * an an object.\n * @public\n */\nexport class FieldValidator<T, TC = undefined> extends ValidatorBase<T, TC> {\n  /**\n   * The name of the property that this validator should validate.\n   */\n  public readonly fieldName: string;\n  /**\n   * The {@link Validation.Validator | Validator} to be applied against the named property.\n   */\n  public readonly fieldValidator: Validator<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _fieldOptions: FieldValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.FieldValidator | FieldValidator.}.\n   * @param fieldName - The name of the property that this validator should validate.\n   * @param fieldValidator - The {@link Validation.Validator | Validator} to be applied\n   * against the named property.\n   * @param options - Additional {@link Validation.FieldValidatorOptions | options} to be\n   * applied to this validation.\n   */\n  public constructor(\n    fieldName: string,\n    fieldValidator: Validator<T, TC>,\n    options?: FieldValidatorOptions<TC>\n  ) {\n    super({ options });\n    this.fieldName = fieldName;\n    this.fieldValidator = fieldValidator;\n    // istanbul ignore next\n    this._fieldOptions = options ?? {};\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n      const optional = this._fieldOptions.optional === true;\n\n      if (isKeyOf(this.fieldName, from)) {\n        if (!optional || from[this.fieldName] !== undefined) {\n          const result = this.fieldValidator\n            .validate(from[this.fieldName], context)\n            .onFailure((message: string) => {\n              return fail(`${this.fieldName}: ${message}`);\n            });\n\n          return result.success ? true : result;\n        }\n      }\n\n      return optional ? true : fail(`\"${this.fieldName}\": Field not found in \"${JSON.stringify(from)}`);\n    }\n    // istanbul ignore next -- defense in depth\n    return fail(`Cannot validate field '${this.fieldName}' from non-object \"${JSON.stringify(from)}\"`);\n  }\n}\n"]}

package/{validation → lib/packlets/validation}/genericValidator.d.ts

@@ -1,7 +1,6 @@
-import { Constraint, Validator, ValidatorOptions } from './validator';
+import { Brand, Failure, Result } from '../base';
 import { ConstraintTrait, ValidatorTraits } from './traits';
-import { Failure, Result } from '../result';
-import { Brand } from '../brand';
+import { Constraint, Validator, ValidatorOptions } from './validator';
 /**
  * Type for a validation function, which validates that a supplied `unknown`
  * value is a valid value of type `<T>`, possibly as influenced by

package/lib/packlets/validation/genericValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"genericValidator.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEtE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEzF;;;GAGG;AAEH,MAAM,WAAW,iCAAiC,CAAC,CAAC,EAAE,EAAE;IACtD,OAAO,CAAC,EAAE,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,qBAAa,gBAAgB,CAAC,CAAC,EAAE,EAAE,GAAG,SAAS,CAAE,YAAW,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAC1E;;OAEG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC;IAExC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACpD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAElD;;;;OAIG;gBACgB,MAAM,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAS5E;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;IAQvD;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAI3E;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,IAAI,CAAC;IAIpD;;OAEG;IACI,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC;IAS/C;;OAEG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAmB3F;;OAEG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAaxE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS;CAGzD"}

package/lib/packlets/validation/genericValidator.js

@@ -0,0 +1,137 @@
+"use strict";
+/*
+ * Copyright (c) 2021 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenericValidator = void 0;
+const base_1 = require("../base");
+const traits_1 = require("./traits");
+/**
+ * Generic base implementation for an in-place {@link Validation.Validator | Validator}.
+ * @public
+ */
+class GenericValidator {
+    /**
+     * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.
+     * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}
+     * used to configure validation.
+     */
+    constructor(params) {
+        var _a;
+        if (!params.validator) {
+            throw new Error('No validator function supplied');
+        }
+        this._validator = params.validator;
+        this._options = (_a = params.options) !== null && _a !== void 0 ? _a : {};
+        this.traits = new traits_1.ValidatorTraits(params.traits);
+    }
+    /**
+     * {@inheritdoc Validation.Validator.isOptional}
+     */
+    get isOptional() {
+        return this.traits.isOptional;
+    }
+    /**
+     * {@inheritdoc Validation.Validator.brand}
+     */
+    get brand() {
+        return this.traits.brand;
+    }
+    /**
+     * {@inheritdoc Validation.Validator.validate}
+     */
+    validate(from, context) {
+        const result = this._validator(from, this._context(context));
+        if (typeof result === 'boolean') {
+            return result ? (0, base_1.succeed)(from) : (0, base_1.fail)('Invalid value');
+        }
+        return result;
+    }
+    /**
+     * {@inheritdoc Validation.Validator.validateOptional}
+     */
+    validateOptional(from, context) {
+        return from === undefined ? (0, base_1.succeed)(undefined) : this.validate(from, context);
+    }
+    /**
+     * {@inheritdoc Validation.Validator.guard}
+     */
+    guard(from, context) {
+        return this._validator(from, this._context(context)) === true;
+    }
+    /**
+     * {@inheritdoc Validation.Validator.optional}
+     */
+    optional() {
+        return new GenericValidator({
+            validator: (from, context) => {
+                return from === undefined || this._validator(from, this._context(context));
+            },
+            traits: { isOptional: true }
+        });
+    }
+    /**
+     * {@inheritdoc Validation.Validator.withConstraint}
+     */
+    withConstraint(constraint, trait) {
+        trait = trait !== null && trait !== void 0 ? trait : { type: 'function' };
+        return new GenericValidator({
+            validator: (from, context) => {
+                if (this._validator(from, this._context(context)) === true) {
+                    const constraintResult = constraint(from);
+                    if (typeof constraintResult === 'boolean') {
+                        return constraintResult
+                            ? true
+                            : (0, base_1.fail)(`Invalid value "${JSON.stringify(from)}":  does not meet constraint.`);
+                    }
+                    return constraintResult;
+                }
+                return false;
+            },
+            traits: { constraints: [trait] }
+        });
+    }
+    /**
+     * {@inheritdoc Validation.Validator.brand}
+     */
+    withBrand(brand) {
+        if (this.brand) {
+            throw new Error(`Cannot replace existing brand "${this.brand}" with "${brand}".`);
+        }
+        return new GenericValidator({
+            validator: (from, context) => {
+                return this._validator(from, this._context(context));
+            },
+            traits: { brand }
+        });
+    }
+    /**
+     * Gets a default or explicit context.
+     * @param explicitContext - Optional explicit context.
+     * @returns The appropriate context to use.
+     * @internal
+     */
+    _context(explicitContext) {
+        return explicitContext !== null && explicitContext !== void 0 ? explicitContext : this._options.defaultContext;
+    }
+}
+exports.GenericValidator = GenericValidator;
+//# sourceMappingURL=genericValidator.js.map

package/lib/packlets/validation/genericValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genericValidator.js","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgE;AAChE,qCAA4D;AAsB5D;;;GAGG;AACH,MAAa,gBAAgB;IAe3B;;;;OAIG;IACH,YAAmB,MAAyD;;QAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAa,EAAE,OAAY;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC/B,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;SAC/D;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAa,EAAE,OAAY;QACjD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAa,EAAE,OAAY;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAAyB,EAAE,KAAuB;QACtE,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACtC,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;gBAC/D,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;oBAC1D,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAS,CAAC,CAAC;oBAC/C,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;wBACzC,OAAO,gBAAgB;4BACrB,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;qBACjF;oBACD,OAAO,gBAAgB,CAAC;iBACzB;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,gBAAgB,CAAkB;YAC3C,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmC,CAAC;YACzF,CAAC;YACD,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,eAAoB;QACrC,OAAO,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACzD,CAAC;CACF;AA/HD,4CA+HC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Brand, Failure, Result, fail, succeed } from '../base';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\nimport { Constraint, Validator, ValidatorOptions } from './validator';\n\n/**\n * Type for a validation function, which validates that a supplied `unknown`\n * value is a valid value of type `<T>`, possibly as influenced by\n * an optionally-supplied validation context of type `<TC>`.\n * @public\n */\nexport type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;\n\n/**\n * Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface GenericValidatorConstructorParams<T, TC> {\n  options?: ValidatorOptions<TC>;\n  traits?: Partial<ValidatorTraits>;\n  validator?: ValidatorFunc<T, TC>;\n}\n\n/**\n * Generic base implementation for an in-place {@link Validation.Validator | Validator}.\n * @public\n */\nexport class GenericValidator<T, TC = undefined> implements Validator<T, TC> {\n  /**\n   * {@inheritdoc Validation.Validator.traits}\n   */\n  public readonly traits: ValidatorTraits;\n\n  /**\n   * @internal\n   */\n  protected readonly _validator: ValidatorFunc<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _options: ValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.\n   * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}\n   * used to configure validation.\n   */\n  public constructor(params: Partial<GenericValidatorConstructorParams<T, TC>>) {\n    if (!params.validator) {\n      throw new Error('No validator function supplied');\n    }\n    this._validator = params.validator;\n    this._options = params.options ?? {};\n    this.traits = new ValidatorTraits(params.traits);\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.isOptional}\n   */\n  public get isOptional(): boolean {\n    return this.traits.isOptional;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.brand}\n   */\n  public get brand(): string | undefined {\n    return this.traits.brand;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.validate}\n   */\n  public validate(from: unknown, context?: TC): Result<T> {\n    const result = this._validator(from, this._context(context));\n    if (typeof result === 'boolean') {\n      return result ? succeed(from as T) : fail<T>('Invalid value');\n    }\n    return result;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.validateOptional}\n   */\n  public validateOptional(from: unknown, context?: TC): Result<T | undefined> {\n    return from === undefined ? succeed(undefined) : this.validate(from, context);\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.guard}\n   */\n  public guard(from: unknown, context?: TC): from is T {\n    return this._validator(from, this._context(context)) === true;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.optional}\n   */\n  public optional(): Validator<T | undefined, TC> {\n    return new GenericValidator({\n      validator: (from: unknown, context?: TC) => {\n        return from === undefined || this._validator(from, this._context(context));\n      },\n      traits: { isOptional: true }\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.withConstraint}\n   */\n  public withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC> {\n    trait = trait ?? { type: 'function' };\n    return new GenericValidator({\n      validator: (from: unknown, context?: TC): boolean | Failure<T> => {\n        if (this._validator(from, this._context(context)) === true) {\n          const constraintResult = constraint(from as T);\n          if (typeof constraintResult === 'boolean') {\n            return constraintResult\n              ? true\n              : fail(`Invalid value \"${JSON.stringify(from)}\":  does not meet constraint.`);\n          }\n          return constraintResult;\n        }\n        return false;\n      },\n      traits: { constraints: [trait] }\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.brand}\n   */\n  public withBrand<B extends string>(brand: B): Validator<Brand<T, B>, TC> {\n    if (this.brand) {\n      throw new Error(`Cannot replace existing brand \"${this.brand}\" with \"${brand}\".`);\n    }\n\n    return new GenericValidator<Brand<T, B>, TC>({\n      validator: (from: unknown, context?: TC) => {\n        return this._validator(from, this._context(context)) as boolean | Failure<Brand<T, B>>;\n      },\n      traits: { brand }\n    });\n  }\n\n  /**\n   * Gets a default or explicit context.\n   * @param explicitContext - Optional explicit context.\n   * @returns The appropriate context to use.\n   * @internal\n   */\n  protected _context(explicitContext?: TC): TC | undefined {\n    return explicitContext ?? this._options.defaultContext;\n  }\n}\n"]}

package/lib/packlets/validation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/index.ts"],"names":[],"mappings":"AAsBA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAE5B,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/{validation → lib/packlets/validation}/index.js

@@ -57,4 +57,4 @@ const Classes = __importStar(require("./classes"));
 exports.Classes = Classes;
 const Validators = __importStar(require("./validators"));
 exports.Validators = Validators;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdmFsaWRhdGlvbi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUVILDJDQUF5QjtBQUN6QiwyQ0FBeUI7QUFDekIsOENBQTRCO0FBRTVCLHlEQUEyQztBQUdsQyxvQkFBSTtBQUZiLG1EQUFxQztBQUV0QiwwQkFBTztBQUR0Qix5REFBMkM7QUFDbkIsZ0NBQVUiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IChjKSAyMDIxIEVyaWsgRm9ydHVuZVxuICpcbiAqIFBlcm1pc3Npb24gaXMgaGVyZWJ5IGdyYW50ZWQsIGZyZWUgb2YgY2hhcmdlLCB0byBhbnkgcGVyc29uIG9idGFpbmluZyBhIGNvcHlcbiAqIG9mIHRoaXMgc29mdHdhcmUgYW5kIGFzc29jaWF0ZWQgZG9jdW1lbnRhdGlvbiBmaWxlcyAodGhlIFwiU29mdHdhcmVcIiksIHRvIGRlYWxcbiAqIGluIHRoZSBTb2Z0d2FyZSB3aXRob3V0IHJlc3RyaWN0aW9uLCBpbmNsdWRpbmcgd2l0aG91dCBsaW1pdGF0aW9uIHRoZSByaWdodHNcbiAqIHRvIHVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwgcHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGxcbiAqIGNvcGllcyBvZiB0aGUgU29mdHdhcmUsIGFuZCB0byBwZXJtaXQgcGVyc29ucyB0byB3aG9tIHRoZSBTb2Z0d2FyZSBpc1xuICogZnVybmlzaGVkIHRvIGRvIHNvLCBzdWJqZWN0IHRvIHRoZSBmb2xsb3dpbmcgY29uZGl0aW9uczpcbiAqXG4gKiBUaGUgYWJvdmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGljZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGxcbiAqIGNvcGllcyBvciBzdWJzdGFudGlhbCBwb3J0aW9ucyBvZiB0aGUgU29mdHdhcmUuXG4gKlxuICogVEhFIFNPRlRXQVJFIElTIFBST1ZJREVEIFwiQVMgSVNcIiwgV0lUSE9VVCBXQVJSQU5UWSBPRiBBTlkgS0lORCwgRVhQUkVTUyBPUlxuICogSU1QTElFRCwgSU5DTFVESU5HIEJVVCBOT1QgTElNSVRFRCBUTyBUSEUgV0FSUkFOVElFUyBPRiBNRVJDSEFOVEFCSUxJVFksXG4gKiBGSVRORVNTIEZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklOR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEVcbiAqIEFVVEhPUlMgT1IgQ09QWVJJR0hUIEhPTERFUlMgQkUgTElBQkxFIEZPUiBBTlkgQ0xBSU0sIERBTUFHRVMgT1IgT1RIRVJcbiAqIExJQUJJTElUWSwgV0hFVEhFUiBJTiBBTiBBQ1RJT04gT0YgQ09OVFJBQ1QsIFRPUlQgT1IgT1RIRVJXSVNFLCBBUklTSU5HIEZST00sXG4gKiBPVVQgT0YgT1IgSU4gQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBUSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRVxuICogU09GVFdBUkUuXG4gKi9cblxuZXhwb3J0ICogZnJvbSAnLi9jb21tb24nO1xuZXhwb3J0ICogZnJvbSAnLi90cmFpdHMnO1xuZXhwb3J0ICogZnJvbSAnLi92YWxpZGF0b3InO1xuXG5pbXBvcnQgKiBhcyBCYXNlIGZyb20gJy4vZ2VuZXJpY1ZhbGlkYXRvcic7XG5pbXBvcnQgKiBhcyBDbGFzc2VzIGZyb20gJy4vY2xhc3Nlcyc7XG5pbXBvcnQgKiBhcyBWYWxpZGF0b3JzIGZyb20gJy4vdmFsaWRhdG9ycyc7XG5leHBvcnQgeyBCYXNlLCBDbGFzc2VzLCBWYWxpZGF0b3JzIH07XG4iXX0=
+//# sourceMappingURL=index.js.map

package/lib/packlets/validation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/validation/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,2CAAyB;AACzB,2CAAyB;AACzB,8CAA4B;AAE5B,yDAA2C;AAGlC,oBAAI;AAFb,mDAAqC;AAEtB,0BAAO;AADtB,yDAA2C;AACnB,gCAAU","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './common';\nexport * from './traits';\nexport * from './validator';\n\nimport * as Base from './genericValidator';\nimport * as Classes from './classes';\nimport * as Validators from './validators';\nexport { Base, Classes, Validators };\n"]}

package/{validation → lib/packlets/validation}/number.d.ts

@@ -1,4 +1,4 @@
-import { Failure } from '../result';
+import { Failure } from '../base';
 import { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';
 /**
  * Parameters used to construct a {@link Validation.Classes.NumberValidator | NumberValidator}.

package/lib/packlets/validation/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAC1C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,EAAE,GAAG,OAAO,IACV,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACnG;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;IAOnE;;;;;OAKG;WACW,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CAMpF"}

package/lib/packlets/validation/number.js

@@ -0,0 +1,54 @@
+"use strict";
+/*
+ * Copyright (c) 2021 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberValidator = void 0;
+const base_1 = require("../base");
+const genericValidator_1 = require("./genericValidator");
+/**
+ * An in-place {@link Validation.Validator | Validator} for `number` values.
+ * @public
+ */
+class NumberValidator extends genericValidator_1.GenericValidator {
+    /**
+     * Constructs a new {@link Validation.Classes.NumberValidator | NumberValidator}.
+     * @param params - Optional {@link Validation.Classes.NumberValidatorConstructorParams | init params} for the
+     * new {@link Validation.Classes.NumberValidator | NumberValidator}.
+     */
+    constructor(params) {
+        super(Object.assign({ validator: NumberValidator.validateNumber }, (params !== null && params !== void 0 ? params : {})));
+    }
+    /**
+     * Static method which validates that a supplied `unknown` value is a `number`.
+     * @param from - The `unknown` value to be tested.
+     * @returns Returns `true` if `from` is a `number`, or {@link Failure} with an error
+     * message if not.
+     */
+    static validateNumber(from) {
+        if (typeof from === 'number') {
+            return true;
+        }
+        return (0, base_1.fail)(`"${from}": not a number`);
+    }
+}
+exports.NumberValidator = NumberValidator;
+//# sourceMappingURL=number.js.map

package/lib/packlets/validation/number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzBD,0CAyBC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.NumberValidator | NumberValidator}.\n * @public\n */\nexport type NumberValidatorConstructorParams<\n  T extends number = number,\n  TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `number` values.\n * @public\n */\nexport class NumberValidator<T extends number = number, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.NumberValidator | NumberValidator}.\n   * @param params - Optional {@link Validation.Classes.NumberValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.NumberValidator | NumberValidator}.\n   */\n  public constructor(params?: NumberValidatorConstructorParams<T, TC>) {\n    super({\n      validator: NumberValidator.validateNumber,\n      ...(params ?? {})\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `number`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `number`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateNumber<T extends number>(from: unknown): boolean | Failure<T> {\n    if (typeof from === 'number') {\n      return true;\n    }\n    return fail<T>(`\"${from}\": not a number`);\n  }\n}\n"]}

package/{validation → lib/packlets/validation}/object.d.ts

@@ -1,4 +1,4 @@
-import { Failure } from '../result';
+import { Failure } from '../base';
 import { Validator, ValidatorOptions } from './validator';
 import { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';
 /**

package/lib/packlets/validation/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/object.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAIhF;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;CAAE,CAAC;AAE3F;;;GAGG;AAEH,MAAM,WAAW,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,gBAAgB,CAAC,EAAE,CAAC;IACzE;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AAEH,MAAM,WAAW,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,8BAA8B,CAAC,CAAC,EAAE,EAAE,CAAC;IACpG;;;;OAIG;IACH,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC;IACxE;;;OAGG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC3C;;;OAGG;IACH,SAAgB,OAAO,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACvD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IACxD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjD;;;;;;OAMG;gBACgB,MAAM,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;IAUlE;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,EAAE,EACvC,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAC9B,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,GACtC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;IAYzB;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAaxF;;;;;;OAMG;IACI,UAAU,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAMlF;;;OAGG;IACH,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CA0BvE"}

package/lib/packlets/validation/object.js

@@ -0,0 +1,139 @@
+"use strict";
+/*
+ * Copyright (c) 2021 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectValidator = void 0;
+const base_1 = require("../base");
+const validatorBase_1 = require("./validatorBase");
+const field_1 = require("./field");
+/**
+ * In-place {@link Validation.Validator | Validator} for an object of type `<T>`.
+ * @remarks
+ * By default, succeeds if all of the required fields exist and are validate, and fails if
+ * any required fields do not exist or are invalid.  See {@link Validation.Classes.ObjectValidatorOptions}
+ * for other validation options.
+ * @public
+ */
+class ObjectValidator extends validatorBase_1.ValidatorBase {
+    /**
+     * Constructs a new {@link Validation.Classes.ObjectValidator | ObjectValidator<T>}.
+     * @param fields - A {@link Validation.Classes.FieldValidators | FieldValidators<T>} containing
+     * a {@link Validation.Validator | Validator} for each field.
+     * @param options - An optional {@link Validation.Classes.ObjectValidatorOptions} to configure
+     * validation.
+     */
+    constructor(params) {
+        var _a;
+        super(params);
+        this.fields = params.fields;
+        this.options = (_a = params.options) !== null && _a !== void 0 ? _a : {};
+        this._innerValidators = ObjectValidator._resolveValidators(this.fields, this.options);
+        this._allowedFields =
+            this.options.strict === true ? new Set(Object.keys(this.fields)) : undefined;
+    }
+    /**
+     * Creates the actual {@link Validation.Classes.FieldValidators | FieldValidators<T>} to be
+     * used by this converter by applying any options or traits defined in the options
+     * to the field converters passed to the constructor.
+     * @param fields - The base {@link Validation.Classes.FieldValidators | FieldValidators<T>} passed
+     * in to the constructor.
+     * @param options - The {@link Validation.Classes.ObjectValidatorOptions | object validator options}
+     * passed in to the constructor.
+     * @returns A new {@link Validation.Classes.FieldValidators | FieldValidators} with the fully-configured
+     * individual {@link Validation.Validator | field validators} to be applied.
+     * @internal
+     */
+    static _resolveValidators(fields, options) {
+        var _a;
+        const resolved = {};
+        for (const key in fields) {
+            if (fields[key]) {
+                // istanbul ignore next
+                const optional = fields[key].isOptional || ((_a = options === null || options === void 0 ? void 0 : options.optionalFields) === null || _a === void 0 ? void 0 : _a.includes(key));
+                resolved[key] = new field_1.FieldValidator(key, fields[key], { optional });
+            }
+        }
+        return resolved;
+    }
+    /**
+     * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with
+     * new optional properties as specified by a supplied
+     * {@link Validation.Classes.ObjectValidatorOptions | ObjectValidatorOptions<T>}.
+     * @param options - The {@link Validation.Classes.ObjectValidatorOptions | options} to be applied to the new
+     * {@link Validation.Classes.ObjectValidator | validator}.
+     * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional
+     * source properties.
+     */
+    partial(options) {
+        // istanbul ignore next
+        options = options !== null && options !== void 0 ? options : {};
+        return new ObjectValidator({
+            fields: this.fields,
+            options: Object.assign(Object.assign({}, this.options), options),
+            traits: this.traits
+        });
+    }
+    /**
+     * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with
+     * new optional properties as specified by a supplied array of `keyof T`.
+     * @param addOptionalProperties - The keys to be made optional.
+     * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional
+     * source properties.
+     */
+    addPartial(addOptionalFields) {
+        var _a;
+        return this.partial({
+            optionalFields: [...((_a = this.options.optionalFields) !== null && _a !== void 0 ? _a : []), ...addOptionalFields]
+        });
+    }
+    /**
+     * {@inheritdoc Validation.ValidatorBase._validate}
+     * @internal
+     */
+    _validate(from, context) {
+        if (typeof from !== 'object' || from === null || Array.isArray(from)) {
+            return (0, base_1.fail)('source is not an object');
+        }
+        // eslint bug thinks key is used before defined
+        // eslint-disable-next-line no-use-before-define
+        const converted = {};
+        const errors = [];
+        for (const key in this._innerValidators) {
+            if (this._innerValidators[key]) {
+                const result = this._innerValidators[key].validate(from, context);
+                if (result.success && result.value !== undefined) {
+                    converted[key] = result.value;
+                }
+                else if (result.isFailure()) {
+                    errors.push(result.message);
+                }
+            }
+        }
+        if (this._allowedFields) {
+            const invalid = Object.keys(from).filter((k) => !this._allowedFields.has(k));
+            invalid.forEach((key) => errors.push(`${key}: unexpected field in source object.`));
+        }
+        return errors.length === 0 ? true : (0, base_1.fail)(errors.join('\n'));
+    }
+}
+exports.ObjectValidator = ObjectValidator;
+//# sourceMappingURL=object.js.map

package/lib/packlets/validation/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/packlets/validation/object.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAEhF,mCAAyC;AA4CzC;;;;;;;GAOG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IAoBxE;;;;;;OAMG;IACH,YAAmB,MAA+C;;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtF,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,kBAAkB,CACjC,MAA8B,EAC9B,OAAuC;;QAEvC,MAAM,QAAQ,GAAoC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;gBACf,uBAAuB;gBACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC;gBAClF,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAc,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpE;SACF;QACD,OAAO,QAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAuC;QACpD,uBAAuB;QACvB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,OAAO,IAAI,eAAe,CAAiB;YACzC,MAAM,EAAE,IAAI,CAAC,MAAyC;YACtD,OAAO,kCACF,IAAI,CAAC,OAAO,GACZ,OAAO,CACX;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,iBAA8B;;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,cAAc,EAAE,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,iBAAiB,CAAC;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpE,OAAO,IAAA,WAAI,EAAC,yBAAyB,CAAC,CAAC;SACxC;QAED,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAClE,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;oBAChD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;iBAC/B;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBAC7B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC7B;aACF;SACF;QAED,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,cAAe,CAAC,GAAG,CAAC,CAAY,CAAC,CAAC,CAAC;YACzF,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAC,CAAC;SACrF;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AAjID,0CAiIC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { FieldValidator } from './field';\n\n/**\n * Per-property {@link Validation.Validator | validators} for each of the properties in `<T>`.\n * @public\n */\nexport type FieldValidators<T, TC = unknown> = { [key in keyof T]: Validator<T[key], TC> };\n\n/**\n * Options for an {@link Validation.Classes.ObjectValidator | ObjectValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorOptions<T, TC> extends ValidatorOptions<TC> {\n  /**\n   * If present, lists optional fields. Missing non-optional fields cause an error.\n   */\n  optionalFields?: (keyof T)[];\n  /**\n   * If true, unrecognized fields yield an error.  If false or undefined (default),\n   * unrecognized fields are ignored.\n   */\n  strict?: boolean;\n}\n\n/**\n * Options for the {@link Validation.Classes.ObjectValidator | ObjectValidator} constructor.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorConstructorParams<T, TC> extends ValidatorBaseConstructorParams<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   * of a result object.\n   */\n  fields: FieldValidators<T>;\n  /**\n   * Optional additional {@link Validation.Classes.ObjectValidatorOptions | ValidatorOptions} to\n   * configure validation.\n   */\n  options?: ObjectValidatorOptions<T, TC>;\n}\n\n/**\n * In-place {@link Validation.Validator | Validator} for an object of type `<T>`.\n * @remarks\n * By default, succeeds if all of the required fields exist and are validate, and fails if\n * any required fields do not exist or are invalid.  See {@link Validation.Classes.ObjectValidatorOptions}\n * for other validation options.\n * @public\n */\nexport class ObjectValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   */\n  public readonly fields: FieldValidators<T>;\n  /**\n   * {@link Validation.Classes.ObjectValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ObjectValidatorOptions<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _innerValidators: FieldValidators<T>;\n  /**\n   * @internal\n   */\n  protected readonly _allowedFields?: Set<keyof T>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ObjectValidator | ObjectValidator<T>}.\n   * @param fields - A {@link Validation.Classes.FieldValidators | FieldValidators<T>} containing\n   * a {@link Validation.Validator | Validator} for each field.\n   * @param options - An optional {@link Validation.Classes.ObjectValidatorOptions} to configure\n   * validation.\n   */\n  public constructor(params: ObjectValidatorConstructorParams<T, TC>) {\n    super(params);\n\n    this.fields = params.fields;\n    this.options = params.options ?? {};\n    this._innerValidators = ObjectValidator._resolveValidators(this.fields, this.options);\n    this._allowedFields =\n      this.options.strict === true ? new Set(Object.keys(this.fields) as (keyof T)[]) : undefined;\n  }\n\n  /**\n   * Creates the actual {@link Validation.Classes.FieldValidators | FieldValidators<T>} to be\n   * used by this converter by applying any options or traits defined in the options\n   * to the field converters passed to the constructor.\n   * @param fields - The base {@link Validation.Classes.FieldValidators | FieldValidators<T>} passed\n   * in to the constructor.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | object validator options}\n   * passed in to the constructor.\n   * @returns A new {@link Validation.Classes.FieldValidators | FieldValidators} with the fully-configured\n   * individual {@link Validation.Validator | field validators} to be applied.\n   * @internal\n   */\n  protected static _resolveValidators<T, TC>(\n    fields: FieldValidators<T, TC>,\n    options?: ObjectValidatorOptions<T, TC>\n  ): FieldValidators<T, TC> {\n    const resolved: Partial<FieldValidators<T, TC>> = {};\n    for (const key in fields) {\n      if (fields[key]) {\n        // istanbul ignore next\n        const optional = fields[key].isOptional || options?.optionalFields?.includes(key);\n        resolved[key] = new FieldValidator(key, fields[key], { optional });\n      }\n    }\n    return resolved as FieldValidators<T, TC>;\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied\n   * {@link Validation.Classes.ObjectValidatorOptions | ObjectValidatorOptions<T>}.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | options} to be applied to the new\n   * {@link Validation.Classes.ObjectValidator | validator}.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public partial(options?: ObjectValidatorOptions<T, TC>): ObjectValidator<Partial<T>, TC> {\n    // istanbul ignore next\n    options = options ?? {};\n    return new ObjectValidator<Partial<T>, TC>({\n      fields: this.fields as FieldValidators<Partial<T>, TC>,\n      options: {\n        ...this.options,\n        ...options\n      },\n      traits: this.traits\n    });\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied array of `keyof T`.\n   * @param addOptionalProperties - The keys to be made optional.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public addPartial(addOptionalFields: (keyof T)[]): ObjectValidator<Partial<T>, TC> {\n    return this.partial({\n      optionalFields: [...(this.options.optionalFields ?? []), ...addOptionalFields]\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail('source is not an object');\n    }\n\n    // eslint bug thinks key is used before defined\n    // eslint-disable-next-line no-use-before-define\n    const converted = {} as { [key in keyof T]: T[key] };\n    const errors: string[] = [];\n    for (const key in this._innerValidators) {\n      if (this._innerValidators[key]) {\n        const result = this._innerValidators[key].validate(from, context);\n        if (result.success && result.value !== undefined) {\n          converted[key] = result.value;\n        } else if (result.isFailure()) {\n          errors.push(result.message);\n        }\n      }\n    }\n\n    if (this._allowedFields) {\n      const invalid = Object.keys(from).filter((k) => !this._allowedFields!.has(k as keyof T));\n      invalid.forEach((key) => errors.push(`${key}: unexpected field in source object.`));\n    }\n    return errors.length === 0 ? true : fail(errors.join('\\n'));\n  }\n}\n"]}

package/{validation → lib/packlets/validation}/string.d.ts

@@ -1,4 +1,4 @@
-import { Failure } from '../result';
+import { Failure } from '../base';
 import { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';
 /**
  * Parameters used to construct a {@link Validation.Classes.StringValidator | StringValidator}.

package/lib/packlets/validation/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAC1C,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,EAAE,GAAG,OAAO,IACV,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACnG;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC;IAOnE;;;;;OAKG;WACW,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CAMpF"}

package/lib/packlets/validation/string.js

@@ -0,0 +1,54 @@
+"use strict";
+/*
+ * Copyright (c) 2021 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringValidator = void 0;
+const base_1 = require("../base");
+const genericValidator_1 = require("./genericValidator");
+/**
+ * An in-place {@link Validation.Validator | Validator} for `string` values.
+ * @public
+ */
+class StringValidator extends genericValidator_1.GenericValidator {
+    /**
+     * Constructs a new {@link Validation.Classes.StringValidator | StringValidator}.
+     * @param params - Optional {@link Validation.Classes.StringValidatorConstructorParams | init params}
+     * for the new {@link Validation.Classes.StringValidator | StringValidator}.
+     */
+    constructor(params) {
+        super(Object.assign({ validator: StringValidator.validateString }, (params !== null && params !== void 0 ? params : {})));
+    }
+    /**
+     * Static method which validates that a supplied `unknown` value is a `string`.
+     * @param from - The `unknown` value to be tested.
+     * @returns Returns `true` if `from` is a `string`, or {@link Failure} with an error
+     * message if not.
+     */
+    static validateString(from) {
+        if (typeof from === 'string') {
+            return true;
+        }
+        return (0, base_1.fail)(`"${from}": not a string`);
+    }
+}
+exports.StringValidator = StringValidator;
+//# sourceMappingURL=string.js.map

package/lib/packlets/validation/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzBD,0CAyBC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.StringValidator | StringValidator}.\n * @public\n */\nexport type StringValidatorConstructorParams<\n  T extends string = string,\n  TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `string` values.\n * @public\n */\nexport class StringValidator<T extends string = string, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.StringValidator | StringValidator}.\n   * @param params - Optional {@link Validation.Classes.StringValidatorConstructorParams | init params}\n   * for the new {@link Validation.Classes.StringValidator | StringValidator}.\n   */\n  public constructor(params?: StringValidatorConstructorParams<T, TC>) {\n    super({\n      validator: StringValidator.validateString,\n      ...(params ?? {})\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `string`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `string`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateString<T extends string>(from: unknown): boolean | Failure<T> {\n    if (typeof from === 'string') {\n      return true;\n    }\n    return fail<T>(`\"${from}\": not a string`);\n  }\n}\n"]}

package/lib/packlets/validation/traits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traits.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/traits.ts"],"names":[],"mappings":"AAsBA;;;;;GAKG;AAEH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,uBAAuB,CAAC;AAEtD;;;GAGG;AAEH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,eAAe,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,oBAGpC,CAAC;AAEF;;;GAGG;AACH,qBAAa,eAAgB,YAAW,oBAAoB;IAC1D;;OAEG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAgB,WAAW,EAAE,eAAe,EAAE,CAAC;IAE/C;;;;;;;OAOG;gBACgB,IAAI,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC,EAAE,oBAAoB;CASrF"}