@fgv/ts-utils 1.2.0 → 1.3.1

package/validation/field.js

@@ -0,0 +1,72 @@
+"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 result_1 = require("../result");
+const validatorBase_1 = require("./validatorBase");
+const utils_1 = require("../utils");
+/**
+ * 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, utils_1.isKeyOf)(this.fieldName, from)) {
+                if ((!optional) || (from[this.fieldName] !== undefined)) {
+                    const result = this.fieldValidator.validate(from[this.fieldName], context).onFailure((message) => {
+                        return (0, result_1.fail)(`${this.fieldName}: ${message}`);
+                    });
+                    return result.success ? true : result;
+                }
+            }
+            return optional
+                ? true
+                : (0, result_1.fail)(`"${this.fieldName}": Field not found in "${JSON.stringify(from)}`);
+        }
+        // istanbul ignore next -- defense in depth
+        return (0, result_1.fail)(`Cannot validate field '${this.fieldName}' from non-object "${JSON.stringify(from)}"`);
+    }
+}
+exports.FieldValidator = FieldValidator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmllbGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdmFsaWRhdGlvbi9maWVsZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQ0E7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHOzs7QUFFSCxzQ0FBMEM7QUFFMUMsbURBQWdEO0FBQ2hELG9DQUFtQztBQVVuQzs7OztHQUlHO0FBQ0gsTUFBYSxjQUFnQyxTQUFRLDZCQUFvQjtJQWNyRTs7Ozs7OztPQU9HO0lBQ0gsWUFDSSxTQUFpQixFQUNqQixjQUFnQyxFQUNoQyxPQUFtQztRQUVuQyxLQUFLLENBQUMsRUFBRSxPQUFPLEVBQUUsQ0FBQyxDQUFDO1FBQ25CLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxjQUFjLEdBQUcsY0FBYyxDQUFDO1FBQ3JDLHVCQUF1QjtRQUN2QixJQUFJLENBQUMsYUFBYSxHQUFHLE9BQU8sYUFBUCxPQUFPLGNBQVAsT0FBTyxHQUFJLEVBQUUsQ0FBQztJQUN2QyxDQUFDO0lBRUQ7O09BRUc7SUFDTyxTQUFTLENBQUMsSUFBYSxFQUFFLE9BQVk7UUFDM0MsSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLElBQUksS0FBSyxJQUFJLEVBQUU7WUFDbkUsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLGFBQWEsQ0FBQyxRQUFRLEtBQUssSUFBSSxDQUFDO1lBRXRELElBQUksSUFBQSxlQUFPLEVBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxJQUFJLENBQUMsRUFBRTtnQkFDL0IsSUFBSSxDQUFDLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLFNBQVMsQ0FBQyxFQUFFO29CQUNyRCxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsY0FBYyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDLE9BQWUsRUFBRSxFQUFFO3dCQUNyRyxPQUFPLElBQUEsYUFBSSxFQUFDLEdBQUcsSUFBSSxDQUFDLFNBQVMsS0FBSyxPQUFPLEVBQUUsQ0FBQyxDQUFDO29CQUNqRCxDQUFDLENBQUMsQ0FBQztvQkFFSCxPQUFPLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDO2lCQUN6QzthQUNKO1lBRUQsT0FBTyxRQUFRO2dCQUNYLENBQUMsQ0FBQyxJQUFJO2dCQUNOLENBQUMsQ0FBQyxJQUFBLGFBQUksRUFBQyxJQUFJLElBQUksQ0FBQyxTQUFTLDBCQUEwQixJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztTQUNsRjtRQUNELDJDQUEyQztRQUMzQyxPQUFPLElBQUEsYUFBSSxFQUFDLDBCQUEwQixJQUFJLENBQUMsU0FBUyxzQkFBc0IsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDdkcsQ0FBQztDQUNKO0FBMURELHdDQTBEQyIsInNvdXJjZXNDb250ZW50IjpbIlxuLypcbiAqIENvcHlyaWdodCAoYykgMjAyMCBFcmlrIEZvcnR1bmVcbiAqXG4gKiBQZXJtaXNzaW9uIGlzIGhlcmVieSBncmFudGVkLCBmcmVlIG9mIGNoYXJnZSwgdG8gYW55IHBlcnNvbiBvYnRhaW5pbmcgYSBjb3B5XG4gKiBvZiB0aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmlsZXMgKHRoZSBcIlNvZnR3YXJlXCIpLCB0byBkZWFsXG4gKiBpbiB0aGUgU29mdHdhcmUgd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRhdGlvbiB0aGUgcmlnaHRzXG4gKiB0byB1c2UsIGNvcHksIG1vZGlmeSwgbWVyZ2UsIHB1Ymxpc2gsIGRpc3RyaWJ1dGUsIHN1YmxpY2Vuc2UsIGFuZC9vciBzZWxsXG4gKiBjb3BpZXMgb2YgdGhlIFNvZnR3YXJlLCBhbmQgdG8gcGVybWl0IHBlcnNvbnMgdG8gd2hvbSB0aGUgU29mdHdhcmUgaXNcbiAqIGZ1cm5pc2hlZCB0byBkbyBzbywgc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6XG4gKlxuICogVGhlIGFib3ZlIGNvcHlyaWdodCBub3RpY2UgYW5kIHRoaXMgcGVybWlzc2lvbiBub3RpY2Ugc2hhbGwgYmUgaW5jbHVkZWQgaW4gYWxsXG4gKiBjb3BpZXMgb3Igc3Vic3RhbnRpYWwgcG9ydGlvbnMgb2YgdGhlIFNvZnR3YXJlLlxuICpcbiAqIFRIRSBTT0ZUV0FSRSBJUyBQUk9WSURFRCBcIkFTIElTXCIsIFdJVEhPVVQgV0FSUkFOVFkgT0YgQU5ZIEtJTkQsIEVYUFJFU1MgT1JcbiAqIElNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLFxuICogRklUTkVTUyBGT1IgQSBQQVJUSUNVTEFSIFBVUlBPU0UgQU5EIE5PTklORlJJTkdFTUVOVC4gSU4gTk8gRVZFTlQgU0hBTEwgVEhFXG4gKiBBVVRIT1JTIE9SIENPUFlSSUdIVCBIT0xERVJTIEJFIExJQUJMRSBGT1IgQU5ZIENMQUlNLCBEQU1BR0VTIE9SIE9USEVSXG4gKiBMSUFCSUxJVFksIFdIRVRIRVIgSU4gQU4gQUNUSU9OIE9GIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLFxuICogT1VUIE9GIE9SIElOIENPTk5FQ1RJT04gV0lUSCBUSEUgU09GVFdBUkUgT1IgVEhFIFVTRSBPUiBPVEhFUiBERUFMSU5HUyBJTiBUSEVcbiAqIFNPRlRXQVJFLlxuICovXG5cbmltcG9ydCB7IEZhaWx1cmUsIGZhaWwgfSBmcm9tICcuLi9yZXN1bHQnO1xuaW1wb3J0IHsgVmFsaWRhdG9yLCBWYWxpZGF0b3JPcHRpb25zIH0gZnJvbSAnLi92YWxpZGF0b3InO1xuaW1wb3J0IHsgVmFsaWRhdG9yQmFzZSB9IGZyb20gJy4vdmFsaWRhdG9yQmFzZSc7XG5pbXBvcnQgeyBpc0tleU9mIH0gZnJvbSAnLi4vdXRpbHMnO1xuXG4vKipcbiAqIFBhcmFtZXRlcnMgdXNlZCB0byBjb25zdHJ1Y3QgYSB7QGxpbmsgVmFsaWRhdGlvbi5GaWVsZFZhbGlkYXRvciB8IEZpZWxkVmFsaWRhdG9yfS5cbiAqIEBwdWJsaWNcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBGaWVsZFZhbGlkYXRvck9wdGlvbnM8VEM+IGV4dGVuZHMgVmFsaWRhdG9yT3B0aW9uczxUQz4ge1xuICAgIG9wdGlvbmFsPzogYm9vbGVhbjtcbn1cblxuLyoqXG4gKiBBbiBpbi1wbGFjZSB7QGxpbmsgVmFsaWRhdGlvbi5WYWxpZGF0b3IgfCBWYWxpZGF0b3J9IGZvciBwcm9wZXJ0aWVzXG4gKiBhbiBhbiBvYmplY3QuXG4gKiBAcHVibGljXG4gKi9cbmV4cG9ydCBjbGFzcyBGaWVsZFZhbGlkYXRvcjxULCBUQz11bmRlZmluZWQ+IGV4dGVuZHMgVmFsaWRhdG9yQmFzZTxULCBUQz4ge1xuICAgIC8qKlxuICAgICAqIFRoZSBuYW1lIG9mIHRoZSBwcm9wZXJ0eSB0aGF0IHRoaXMgdmFsaWRhdG9yIHNob3VsZCB2YWxpZGF0ZS5cbiAgICAgKi9cbiAgICBwdWJsaWMgcmVhZG9ubHkgZmllbGROYW1lOiBzdHJpbmc7XG4gICAgLyoqXG4gICAgICogVGhlIHtAbGluayBWYWxpZGF0aW9uLlZhbGlkYXRvciB8IFZhbGlkYXRvcn0gdG8gYmUgYXBwbGllZCBhZ2FpbnN0IHRoZSBuYW1lZCBwcm9wZXJ0eS5cbiAgICAgKi9cbiAgICBwdWJsaWMgcmVhZG9ubHkgZmllbGRWYWxpZGF0b3I6IFZhbGlkYXRvcjxULCBUQz47XG4gICAgLyoqXG4gICAgICogQGludGVybmFsXG4gICAgICovXG4gICAgcHJvdGVjdGVkIHJlYWRvbmx5IF9maWVsZE9wdGlvbnM6IEZpZWxkVmFsaWRhdG9yT3B0aW9uczxUQz47XG5cbiAgICAvKipcbiAgICAgKiBDb25zdHJ1Y3RzIGEgbmV3IHtAbGluayBWYWxpZGF0aW9uLkZpZWxkVmFsaWRhdG9yIHwgRmllbGRWYWxpZGF0b3IufS5cbiAgICAgKiBAcGFyYW0gZmllbGROYW1lIC0gVGhlIG5hbWUgb2YgdGhlIHByb3BlcnR5IHRoYXQgdGhpcyB2YWxpZGF0b3Igc2hvdWxkIHZhbGlkYXRlLlxuICAgICAqIEBwYXJhbSBmaWVsZFZhbGlkYXRvciAtIFRoZSB7QGxpbmsgVmFsaWRhdGlvbi5WYWxpZGF0b3IgfCBWYWxpZGF0b3J9IHRvIGJlIGFwcGxpZWRcbiAgICAgKiBhZ2FpbnN0IHRoZSBuYW1lZCBwcm9wZXJ0eS5cbiAgICAgKiBAcGFyYW0gb3B0aW9ucyAtIEFkZGl0aW9uYWwge0BsaW5rIFZhbGlkYXRpb24uRmllbGRWYWxpZGF0b3JPcHRpb25zIHwgb3B0aW9uc30gdG8gYmVcbiAgICAgKiBhcHBsaWVkIHRvIHRoaXMgdmFsaWRhdGlvbi5cbiAgICAgKi9cbiAgICBwdWJsaWMgY29uc3RydWN0b3IoXG4gICAgICAgIGZpZWxkTmFtZTogc3RyaW5nLFxuICAgICAgICBmaWVsZFZhbGlkYXRvcjogVmFsaWRhdG9yPFQsIFRDPixcbiAgICAgICAgb3B0aW9ucz86IEZpZWxkVmFsaWRhdG9yT3B0aW9uczxUQz4sXG4gICAgKSB7XG4gICAgICAgIHN1cGVyKHsgb3B0aW9ucyB9KTtcbiAgICAgICAgdGhpcy5maWVsZE5hbWUgPSBmaWVsZE5hbWU7XG4gICAgICAgIHRoaXMuZmllbGRWYWxpZGF0b3IgPSBmaWVsZFZhbGlkYXRvcjtcbiAgICAgICAgLy8gaXN0YW5idWwgaWdub3JlIG5leHRcbiAgICAgICAgdGhpcy5fZmllbGRPcHRpb25zID0gb3B0aW9ucyA/PyB7fTtcbiAgICB9XG5cbiAgICAvKipcbiAgICAgKiB7QGluaGVyaXRkb2MgVmFsaWRhdGlvbi5WYWxpZGF0b3JCYXNlLl92YWxpZGF0ZX1cbiAgICAgKi9cbiAgICBwcm90ZWN0ZWQgX3ZhbGlkYXRlKGZyb206IHVua25vd24sIGNvbnRleHQ/OiBUQyk6IGJvb2xlYW4gfCBGYWlsdXJlPFQ+IHtcbiAgICAgICAgaWYgKHR5cGVvZiBmcm9tID09PSAnb2JqZWN0JyAmJiAhQXJyYXkuaXNBcnJheShmcm9tKSAmJiBmcm9tICE9PSBudWxsKSB7XG4gICAgICAgICAgICBjb25zdCBvcHRpb25hbCA9IHRoaXMuX2ZpZWxkT3B0aW9ucy5vcHRpb25hbCA9PT0gdHJ1ZTtcblxuICAgICAgICAgICAgaWYgKGlzS2V5T2YodGhpcy5maWVsZE5hbWUsIGZyb20pKSB7XG4gICAgICAgICAgICAgICAgaWYgKCghb3B0aW9uYWwpIHx8IChmcm9tW3RoaXMuZmllbGROYW1lXSAhPT0gdW5kZWZpbmVkKSkge1xuICAgICAgICAgICAgICAgICAgICBjb25zdCByZXN1bHQgPSB0aGlzLmZpZWxkVmFsaWRhdG9yLnZhbGlkYXRlKGZyb21bdGhpcy5maWVsZE5hbWVdLCBjb250ZXh0KS5vbkZhaWx1cmUoKG1lc3NhZ2U6IHN0cmluZykgPT4ge1xuICAgICAgICAgICAgICAgICAgICAgICAgcmV0dXJuIGZhaWwoYCR7dGhpcy5maWVsZE5hbWV9OiAke21lc3NhZ2V9YCk7XG4gICAgICAgICAgICAgICAgICAgIH0pO1xuXG4gICAgICAgICAgICAgICAgICAgIHJldHVybiByZXN1bHQuc3VjY2VzcyA/IHRydWUgOiByZXN1bHQ7XG4gICAgICAgICAgICAgICAgfVxuICAgICAgICAgICAgfVxuXG4gICAgICAgICAgICByZXR1cm4gb3B0aW9uYWxcbiAgICAgICAgICAgICAgICA/IHRydWVcbiAgICAgICAgICAgICAgICA6IGZhaWwoYFwiJHt0aGlzLmZpZWxkTmFtZX1cIjogRmllbGQgbm90IGZvdW5kIGluIFwiJHtKU09OLnN0cmluZ2lmeShmcm9tKX1gKTtcbiAgICAgICAgfVxuICAgICAgICAvLyBpc3RhbmJ1bCBpZ25vcmUgbmV4dCAtLSBkZWZlbnNlIGluIGRlcHRoXG4gICAgICAgIHJldHVybiBmYWlsKGBDYW5ub3QgdmFsaWRhdGUgZmllbGQgJyR7dGhpcy5maWVsZE5hbWV9JyBmcm9tIG5vbi1vYmplY3QgXCIke0pTT04uc3RyaW5naWZ5KGZyb20pfVwiYCk7XG4gICAgfVxufVxuIl19

package/validation/genericValidator.d.ts

@@ -0,0 +1,84 @@
+import { Constraint, Validator, ValidatorOptions } from './validator';
+import { ConstraintTrait, ValidatorTraits } from './traits';
+import { Failure, Result } from '../result';
+import { Brand } from '../brand';
+/**
+ * Type for a validation function, which validates that a supplied `unknown`
+ * value is a valid value of type `<T>`, possibly as influenced by
+ * an optionally-supplied validation context of type `<TC>`.
+ * @public
+ */
+export declare type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;
+/**
+ * Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.
+ * @public
+ */
+export interface GenericValidatorConstructorParams<T, TC> {
+    options?: ValidatorOptions<TC>;
+    traits?: Partial<ValidatorTraits>;
+    validator?: ValidatorFunc<T, TC>;
+}
+/**
+ * Generic base implementation for an in-place {@link Validation.Validator | Validator}.
+ * @public
+ */
+export declare class GenericValidator<T, TC = undefined> implements Validator<T, TC> {
+    /**
+     * {@inheritdoc Validation.Validator.traits}
+     */
+    readonly traits: ValidatorTraits;
+    /**
+     * @internal
+     */
+    protected readonly _validator: ValidatorFunc<T, TC>;
+    /**
+     * @internal
+     */
+    protected readonly _options: ValidatorOptions<TC>;
+    /**
+     * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.
+     * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}
+     * used to configure validation.
+     */
+    constructor(params: Partial<GenericValidatorConstructorParams<T, TC>>);
+    /**
+     * {@inheritdoc Validation.Validator.isOptional}
+     */
+    get isOptional(): boolean;
+    /**
+     * {@inheritdoc Validation.Validator.brand}
+     */
+    get brand(): string | undefined;
+    /**
+     * {@inheritdoc Validation.Validator.validate}
+     */
+    validate(from: unknown, context?: TC): Result<T>;
+    /**
+     * {@inheritdoc Validation.Validator.validateOptional}
+     */
+    validateOptional(from: unknown, context?: TC): Result<T | undefined>;
+    /**
+     * {@inheritdoc Validation.Validator.guard}
+     */
+    guard(from: unknown, context?: TC): from is T;
+    /**
+     * {@inheritdoc Validation.Validator.optional}
+     */
+    optional(): Validator<T | undefined, TC>;
+    /**
+     * {@inheritdoc Validation.Validator.withConstraint}
+     */
+    withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC>;
+    /**
+     * {@inheritdoc Validation.Validator.brand}
+     */
+    withBrand<B extends string>(brand: B): Validator<Brand<T, B>, TC>;
+    /**
+     * Gets a default or explicit context.
+     * @param explicitContext - Optional explicit context.
+     * @returns The appropriate context to use.
+     * @internal
+     */
+    protected _context(explicitContext?: TC): TC | undefined;
+}
+//# sourceMappingURL=genericValidator.d.ts.map

package/validation/genericValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"genericValidator.d.ts","sourceRoot":"","sources":["../../src/validation/genericValidator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAiB,MAAM,WAAW,CAAC;AAE3D,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC;;;;;GAKG;AACH,oBAAY,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;AACH,MAAM,WAAW,iCAAiC,CAAC,CAAC,EAAE,EAAE;IACpD,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,CAAA;CACnC;AAED;;;GAGG;AACH,qBAAa,gBAAgB,CAAC,CAAC,EAAE,EAAE,GAAG,SAAS,CAAE,YAAW,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IACxE;;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;IAU/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;CAG3D"}

package/validation/genericValidator.js

@@ -0,0 +1,138 @@
+"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 traits_1 = require("./traits");
+const result_1 = require("../result");
+/**
+ * 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, result_1.succeed)(from) : (0, result_1.fail)('Invalid value');
+        }
+        return result;
+    }
+    /**
+     * {@inheritdoc Validation.Validator.validateOptional}
+     */
+    validateOptional(from, context) {
+        return (from === undefined) ? (0, result_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, result_1.fail)(`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=data:application/json;base64,{"version":3,"file":"genericValidator.js","sourceRoot":"","sources":["../../src/validation/genericValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAGH,qCAA4D;AAC5D,sCAA2D;AAsB3D;;;GAGG;AACH,MAAa,gBAAgB;IAezB;;;;OAIG;IACH,YAAmB,MAAyD;;QACxE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACrD;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;IACrD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAa,EAAE,OAAY;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,aAAI,EAAI,eAAe,CAAC,CAAC;SACjE;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAa,EAAE,OAAY;QAC/C,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAa,EAAE,OAAY;QACpC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACI,QAAQ;QACX,OAAO,IAAI,gBAAgB,CAAC;YACxB,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACvC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;uBACpB,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SAC/B,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAAyB,EAAE,KAAuB;QACpE,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACtC,OAAO,IAAI,gBAAgB,CAAC;YACxB,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;gBAC7D,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;oBACxD,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAS,CAAC,CAAC;oBAC/C,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;wBACvC,OAAO,gBAAgB;4BACnB,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,IAAA,aAAI,EAAC,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;qBACzE;oBACD,OAAO,gBAAgB,CAAC;iBAC3B;gBACD,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE;SACnC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACvC,IAAI,IAAI,CAAC,KAAK,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;SACrF;QAED,OAAO,IAAI,gBAAgB,CAAkB;YACzC,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACvC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmC,CAAC;YAC3F,CAAC;YACD,MAAM,EAAE,EAAE,KAAK,EAAE;SACpB,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,eAAoB;QACnC,OAAO,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IAC3D,CAAC;CACJ;AAhID,4CAgIC","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 { Constraint, Validator, ValidatorOptions } from './validator';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\nimport { Failure, Result, fail, succeed } from '../result';\n\nimport { Brand } from '../brand';\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 */\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)\n                    || 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(`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/validation/index.d.ts

@@ -0,0 +1,7 @@
+export * from './traits';
+export * from './validator';
+import * as Base from './genericValidator';
+import * as Classes from './classes';
+import * as Validators from './validators';
+export { Base, Classes, Validators };
+//# sourceMappingURL=index.d.ts.map

package/validation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validation/index.ts"],"names":[],"mappings":"AAsBA,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/index.js

@@ -0,0 +1,59 @@
+"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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validators = exports.Classes = exports.Base = void 0;
+__exportStar(require("./traits"), exports);
+__exportStar(require("./validator"), exports);
+const Base = __importStar(require("./genericValidator"));
+exports.Base = Base;
+const Classes = __importStar(require("./classes"));
+exports.Classes = Classes;
+const Validators = __importStar(require("./validators"));
+exports.Validators = Validators;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdmFsaWRhdGlvbi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUVILDJDQUF5QjtBQUN6Qiw4Q0FBNEI7QUFFNUIseURBQTJDO0FBR2xDLG9CQUFJO0FBRmIsbURBQXFDO0FBRXRCLDBCQUFPO0FBRHRCLHlEQUEyQztBQUNuQixnQ0FBVSIsInNvdXJjZXNDb250ZW50IjpbIi8qXG4gKiBDb3B5cmlnaHQgKGMpIDIwMjEgRXJpayBGb3J0dW5lXG4gKlxuICogUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBvZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weVxuICogb2YgdGhpcyBzb2Z0d2FyZSBhbmQgYXNzb2NpYXRlZCBkb2N1bWVudGF0aW9uIGZpbGVzICh0aGUgXCJTb2Z0d2FyZVwiKSwgdG8gZGVhbFxuICogaW4gdGhlIFNvZnR3YXJlIHdpdGhvdXQgcmVzdHJpY3Rpb24sIGluY2x1ZGluZyB3aXRob3V0IGxpbWl0YXRpb24gdGhlIHJpZ2h0c1xuICogdG8gdXNlLCBjb3B5LCBtb2RpZnksIG1lcmdlLCBwdWJsaXNoLCBkaXN0cmlidXRlLCBzdWJsaWNlbnNlLCBhbmQvb3Igc2VsbFxuICogY29waWVzIG9mIHRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25zIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzXG4gKiBmdXJuaXNoZWQgdG8gZG8gc28sIHN1YmplY3QgdG8gdGhlIGZvbGxvd2luZyBjb25kaXRpb25zOlxuICpcbiAqIFRoZSBhYm92ZSBjb3B5cmlnaHQgbm90aWNlIGFuZCB0aGlzIHBlcm1pc3Npb24gbm90aWNlIHNoYWxsIGJlIGluY2x1ZGVkIGluIGFsbFxuICogY29waWVzIG9yIHN1YnN0YW50aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS5cbiAqXG4gKiBUSEUgU09GVFdBUkUgSVMgUFJPVklERUQgXCJBUyBJU1wiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBLSU5ELCBFWFBSRVNTIE9SXG4gKiBJTVBMSUVELCBJTkNMVURJTkcgQlVUIE5PVCBMSU1JVEVEIFRPIFRIRSBXQVJSQU5USUVTIE9GIE1FUkNIQU5UQUJJTElUWSxcbiAqIEZJVE5FU1MgRk9SIEEgUEFSVElDVUxBUiBQVVJQT1NFIEFORCBOT05JTkZSSU5HRU1FTlQuIElOIE5PIEVWRU5UIFNIQUxMIFRIRVxuICogQVVUSE9SUyBPUiBDT1BZUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdFUyBPUiBPVEhFUlxuICogTElBQklMSVRZLCBXSEVUSEVSIElOIEFOIEFDVElPTiBPRiBDT05UUkFDVCwgVE9SVCBPUiBPVEhFUldJU0UsIEFSSVNJTkcgRlJPTSxcbiAqIE9VVCBPRiBPUiBJTiBDT05ORUNUSU9OIFdJVEggVEhFIFNPRlRXQVJFIE9SIFRIRSBVU0UgT1IgT1RIRVIgREVBTElOR1MgSU4gVEhFXG4gKiBTT0ZUV0FSRS5cbiAqL1xuXG5leHBvcnQgKiBmcm9tICcuL3RyYWl0cyc7XG5leHBvcnQgKiBmcm9tICcuL3ZhbGlkYXRvcic7XG5cbmltcG9ydCAqIGFzIEJhc2UgZnJvbSAnLi9nZW5lcmljVmFsaWRhdG9yJztcbmltcG9ydCAqIGFzIENsYXNzZXMgZnJvbSAnLi9jbGFzc2VzJztcbmltcG9ydCAqIGFzIFZhbGlkYXRvcnMgZnJvbSAnLi92YWxpZGF0b3JzJztcbmV4cG9ydCB7IEJhc2UsIENsYXNzZXMsIFZhbGlkYXRvcnMgfTtcbiJdfQ==

package/validation/number.d.ts

@@ -0,0 +1,27 @@
+import { Failure } from '../result';
+import { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';
+/**
+ * Parameters used to construct a {@link Validation.Classes.NumberValidator | NumberValidator}.
+ * @public
+ */
+export declare type NumberValidatorConstructorParams<T extends number = number, TC = unknown> = GenericValidatorConstructorParams<T, TC>;
+/**
+ * An in-place {@link Validation.Validator | Validator} for `number` values.
+ * @public
+ */
+export declare class NumberValidator<T extends number = number, TC = unknown> extends GenericValidator<T, TC> {
+    /**
+     * 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?: NumberValidatorConstructorParams<T, TC>);
+    /**
+     * 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<T extends number>(from: unknown): boolean | Failure<T>;
+}
+//# sourceMappingURL=number.d.ts.map

package/validation/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../src/validation/number.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAEzF;;;GAGG;AACH,oBAAY,gCAAgC,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,IAAI,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAGjI;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IACjG;;;;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;CAMtF"}

package/validation/number.js

@@ -0,0 +1,57 @@
+"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 result_1 = require("../result");
+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({
+            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, result_1.fail)(`"${from}": not a number`);
+    }
+}
+exports.NumberValidator = NumberValidator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnVtYmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3ZhbGlkYXRpb24vbnVtYmVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvQkc7OztBQUVILHNDQUEwQztBQUMxQyx5REFBeUY7QUFTekY7OztHQUdHO0FBQ0gsTUFBYSxlQUF5RCxTQUFRLG1DQUF1QjtJQUNqRzs7OztPQUlHO0lBQ0gsWUFBbUIsTUFBZ0Q7UUFDL0QsS0FBSyxDQUFDO1lBQ0YsU0FBUyxFQUFFLGVBQWUsQ0FBQyxjQUFjO1lBQ3pDLEdBQUcsQ0FBQyxNQUFNLGFBQU4sTUFBTSxjQUFOLE1BQU0sR0FBSSxFQUFFLENBQUM7U0FDcEIsQ0FBQyxDQUFDO0lBQ1AsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksTUFBTSxDQUFDLGNBQWMsQ0FBbUIsSUFBYTtRQUN4RCxJQUFJLE9BQU8sSUFBSSxLQUFLLFFBQVEsRUFBRTtZQUMxQixPQUFPLElBQUksQ0FBQztTQUNmO1FBQ0QsT0FBTyxJQUFBLGFBQUksRUFBSSxJQUFJLElBQUksaUJBQWlCLENBQUMsQ0FBQztJQUM5QyxDQUFDO0NBQ0o7QUF6QkQsMENBeUJDIiwic291cmNlc0NvbnRlbnQiOlsiLypcbiAqIENvcHlyaWdodCAoYykgMjAyMSBFcmlrIEZvcnR1bmVcbiAqXG4gKiBQZXJtaXNzaW9uIGlzIGhlcmVieSBncmFudGVkLCBmcmVlIG9mIGNoYXJnZSwgdG8gYW55IHBlcnNvbiBvYnRhaW5pbmcgYSBjb3B5XG4gKiBvZiB0aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmlsZXMgKHRoZSBcIlNvZnR3YXJlXCIpLCB0byBkZWFsXG4gKiBpbiB0aGUgU29mdHdhcmUgd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRhdGlvbiB0aGUgcmlnaHRzXG4gKiB0byB1c2UsIGNvcHksIG1vZGlmeSwgbWVyZ2UsIHB1Ymxpc2gsIGRpc3RyaWJ1dGUsIHN1YmxpY2Vuc2UsIGFuZC9vciBzZWxsXG4gKiBjb3BpZXMgb2YgdGhlIFNvZnR3YXJlLCBhbmQgdG8gcGVybWl0IHBlcnNvbnMgdG8gd2hvbSB0aGUgU29mdHdhcmUgaXNcbiAqIGZ1cm5pc2hlZCB0byBkbyBzbywgc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6XG4gKlxuICogVGhlIGFib3ZlIGNvcHlyaWdodCBub3RpY2UgYW5kIHRoaXMgcGVybWlzc2lvbiBub3RpY2Ugc2hhbGwgYmUgaW5jbHVkZWQgaW4gYWxsXG4gKiBjb3BpZXMgb3Igc3Vic3RhbnRpYWwgcG9ydGlvbnMgb2YgdGhlIFNvZnR3YXJlLlxuICpcbiAqIFRIRSBTT0ZUV0FSRSBJUyBQUk9WSURFRCBcIkFTIElTXCIsIFdJVEhPVVQgV0FSUkFOVFkgT0YgQU5ZIEtJTkQsIEVYUFJFU1MgT1JcbiAqIElNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLFxuICogRklUTkVTUyBGT1IgQSBQQVJUSUNVTEFSIFBVUlBPU0UgQU5EIE5PTklORlJJTkdFTUVOVC4gSU4gTk8gRVZFTlQgU0hBTEwgVEhFXG4gKiBBVVRIT1JTIE9SIENPUFlSSUdIVCBIT0xERVJTIEJFIExJQUJMRSBGT1IgQU5ZIENMQUlNLCBEQU1BR0VTIE9SIE9USEVSXG4gKiBMSUFCSUxJVFksIFdIRVRIRVIgSU4gQU4gQUNUSU9OIE9GIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLFxuICogT1VUIE9GIE9SIElOIENPTk5FQ1RJT04gV0lUSCBUSEUgU09GVFdBUkUgT1IgVEhFIFVTRSBPUiBPVEhFUiBERUFMSU5HUyBJTiBUSEVcbiAqIFNPRlRXQVJFLlxuICovXG5cbmltcG9ydCB7IEZhaWx1cmUsIGZhaWwgfSBmcm9tICcuLi9yZXN1bHQnO1xuaW1wb3J0IHsgR2VuZXJpY1ZhbGlkYXRvciwgR2VuZXJpY1ZhbGlkYXRvckNvbnN0cnVjdG9yUGFyYW1zIH0gZnJvbSAnLi9nZW5lcmljVmFsaWRhdG9yJztcblxuLyoqXG4gKiBQYXJhbWV0ZXJzIHVzZWQgdG8gY29uc3RydWN0IGEge0BsaW5rIFZhbGlkYXRpb24uQ2xhc3Nlcy5OdW1iZXJWYWxpZGF0b3IgfCBOdW1iZXJWYWxpZGF0b3J9LlxuICogQHB1YmxpY1xuICovXG5leHBvcnQgdHlwZSBOdW1iZXJWYWxpZGF0b3JDb25zdHJ1Y3RvclBhcmFtczxUIGV4dGVuZHMgbnVtYmVyID0gbnVtYmVyLCBUQyA9IHVua25vd24+ID0gR2VuZXJpY1ZhbGlkYXRvckNvbnN0cnVjdG9yUGFyYW1zPFQsIFRDPjtcblxuXG4vKipcbiAqIEFuIGluLXBsYWNlIHtAbGluayBWYWxpZGF0aW9uLlZhbGlkYXRvciB8IFZhbGlkYXRvcn0gZm9yIGBudW1iZXJgIHZhbHVlcy5cbiAqIEBwdWJsaWNcbiAqL1xuZXhwb3J0IGNsYXNzIE51bWJlclZhbGlkYXRvcjxUIGV4dGVuZHMgbnVtYmVyID0gbnVtYmVyLCBUQyA9IHVua25vd24+IGV4dGVuZHMgR2VuZXJpY1ZhbGlkYXRvcjxULCBUQz4ge1xuICAgIC8qKlxuICAgICAqIENvbnN0cnVjdHMgYSBuZXcge0BsaW5rIFZhbGlkYXRpb24uQ2xhc3Nlcy5OdW1iZXJWYWxpZGF0b3IgfCBOdW1iZXJWYWxpZGF0b3J9LlxuICAgICAqIEBwYXJhbSBwYXJhbXMgLSBPcHRpb25hbCB7QGxpbmsgVmFsaWRhdGlvbi5DbGFzc2VzLk51bWJlclZhbGlkYXRvckNvbnN0cnVjdG9yUGFyYW1zIHwgaW5pdCBwYXJhbXN9IGZvciB0aGVcbiAgICAgKiBuZXcge0BsaW5rIFZhbGlkYXRpb24uQ2xhc3Nlcy5OdW1iZXJWYWxpZGF0b3IgfCBOdW1iZXJWYWxpZGF0b3J9LlxuICAgICAqL1xuICAgIHB1YmxpYyBjb25zdHJ1Y3RvcihwYXJhbXM/OiBOdW1iZXJWYWxpZGF0b3JDb25zdHJ1Y3RvclBhcmFtczxULCBUQz4pIHtcbiAgICAgICAgc3VwZXIoe1xuICAgICAgICAgICAgdmFsaWRhdG9yOiBOdW1iZXJWYWxpZGF0b3IudmFsaWRhdGVOdW1iZXIsXG4gICAgICAgICAgICAuLi4ocGFyYW1zID8/IHt9KSxcbiAgICAgICAgfSk7XG4gICAgfVxuXG4gICAgLyoqXG4gICAgICogU3RhdGljIG1ldGhvZCB3aGljaCB2YWxpZGF0ZXMgdGhhdCBhIHN1cHBsaWVkIGB1bmtub3duYCB2YWx1ZSBpcyBhIGBudW1iZXJgLlxuICAgICAqIEBwYXJhbSBmcm9tIC0gVGhlIGB1bmtub3duYCB2YWx1ZSB0byBiZSB0ZXN0ZWQuXG4gICAgICogQHJldHVybnMgUmV0dXJucyBgdHJ1ZWAgaWYgYGZyb21gIGlzIGEgYG51bWJlcmAsIG9yIHtAbGluayBGYWlsdXJlfSB3aXRoIGFuIGVycm9yXG4gICAgICogbWVzc2FnZSBpZiBub3QuXG4gICAgICovXG4gICAgcHVibGljIHN0YXRpYyB2YWxpZGF0ZU51bWJlcjxUIGV4dGVuZHMgbnVtYmVyPihmcm9tOiB1bmtub3duKTogYm9vbGVhbiB8IEZhaWx1cmU8VD4ge1xuICAgICAgICBpZiAodHlwZW9mIGZyb20gPT09ICdudW1iZXInKSB7XG4gICAgICAgICAgICByZXR1cm4gdHJ1ZTtcbiAgICAgICAgfVxuICAgICAgICByZXR1cm4gZmFpbDxUPihgXCIke2Zyb219XCI6IG5vdCBhIG51bWJlcmApO1xuICAgIH1cbn1cbiJdfQ==

package/validation/object.d.ts

@@ -0,0 +1,115 @@
+import { Failure } from '../result';
+import { Validator, ValidatorOptions } from './validator';
+import { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';
+/**
+ * Per-property {@link Validation.Validator | validators} for each of the properties in `<T>`.
+ * @public
+ */
+export declare type FieldValidators<T, TC = unknown> = {
+    [key in keyof T]: Validator<T[key], TC>;
+};
+/**
+ * Options for an {@link Validation.Classes.ObjectValidator | ObjectValidator}.
+ * @public
+ */
+export interface ObjectValidatorOptions<T, TC> extends ValidatorOptions<TC> {
+    /**
+     * If present, lists optional fields. Missing non-optional fields cause an error.
+     */
+    optionalFields?: (keyof T)[];
+    /**
+     * If true, unrecognized fields yield an error.  If false or undefined (default),
+     * unrecognized fields are ignored.
+     */
+    strict?: boolean;
+}
+/**
+ * Options for the {@link Validation.Classes.ObjectValidator | ObjectValidator} constructor.
+ * @public
+ */
+export interface ObjectValidatorConstructorParams<T, TC> extends ValidatorBaseConstructorParams<T, TC> {
+    /**
+     * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a
+     * {@link Validation.Validator | Validator} for each of the expected properties
+     * of a result object.
+     */
+    fields: FieldValidators<T>;
+    /**
+     * Optional additional {@link Validation.Classes.ObjectValidatorOptions | ValidatorOptions} to
+     * configure validation.
+     */
+    options?: ObjectValidatorOptions<T, TC>;
+}
+/**
+ * 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
+ */
+export declare class ObjectValidator<T, TC = unknown> extends ValidatorBase<T, TC> {
+    /**
+     * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a
+     * {@link Validation.Validator | Validator} for each of the expected properties
+     */
+    readonly fields: FieldValidators<T>;
+    /**
+     * {@link Validation.Classes.ObjectValidatorOptions | Options} which apply to this
+     * validator.
+     */
+    readonly options: ObjectValidatorOptions<T, TC>;
+    /**
+     * @internal
+     */
+    protected readonly _innerValidators: FieldValidators<T>;
+    /**
+     * @internal
+     */
+    protected readonly _allowedFields?: Set<keyof T>;
+    /**
+     * 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: ObjectValidatorConstructorParams<T, TC>);
+    /**
+     * 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
+     */
+    protected static _resolveValidators<T, TC>(fields: FieldValidators<T, TC>, options?: ObjectValidatorOptions<T, TC>): FieldValidators<T, TC>;
+    /**
+     * 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?: ObjectValidatorOptions<T, TC>): ObjectValidator<Partial<T>, TC>;
+    /**
+     * 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: (keyof T)[]): ObjectValidator<Partial<T>, TC>;
+    /**
+     * {@inheritdoc Validation.ValidatorBase._validate}
+     * @internal
+     */
+    protected _validate(from: unknown, context?: TC): boolean | Failure<T>;
+}
+//# sourceMappingURL=object.d.ts.map

package/validation/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/validation/object.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAQ,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAIhF;;;GAGG;AACH,oBAAY,eAAe,CAAC,CAAC,EAAE,EAAE,GAAC,OAAO,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;CAAE,CAAC;AAEzF;;;GAGG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,gBAAgB,CAAC,EAAE,CAAC;IACvE;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,8BAA8B,CAAC,CAAC,EAAE,EAAE,CAAC;IAClG;;;;OAIG;IACH,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAC3C;AAED;;;;;;;GAOG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,GAAC,OAAO,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC;IACpE;;;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;IAWlE;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,EAAE,EACrC,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAC9B,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,GACxC,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;CA2BzE"}