@amazon/vinyl-validation 1.0.0

package/dist/types/current/validation/ArraySchema.js

@@ -0,0 +1,148 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { substitute } from '@amazon/vinyl-util';
+import { ValueSchema } from './ValueSchema';
+import { createDeepValidator, createValidator } from './Validator';
+/**
+ * @private
+ */
+const locale = {
+    array: 'array',
+    minLength: 'at least {value} elements',
+    maxLength: 'at most {value} elements',
+    exactlyLength: 'exactly {value} elements',
+    actualLength: 'length {value}',
+    withElements: '({value})[]',
+    tuple: '[{value}]',
+};
+export const arrayValidators = {
+    /**
+     * Creates a validator that asserts that the input is an array.
+     *
+     * Note: arrays can only be readonly by type system, there is no native readonly
+     * js array. This validator assumes mutability, use the ArraySchema readonly() method
+     * to cast to a readonly array.
+     */
+    isArray() {
+        return createValidator(locale.array, (input) => Array.isArray(input));
+    },
+    /**
+     * Creates a validator that asserts that every element passes the given validator.
+     *
+     * @param elementValidator
+     */
+    withElements(elementValidator) {
+        return createDeepValidator(substitute(locale.withElements, {
+            value: elementValidator.description,
+        }), (input, options, path) => {
+            const errors = [];
+            for (let i = 0; i < input.length; i++) {
+                const element = input[i];
+                errors.push(...elementValidator.validate(element, options, path.concat(i.toString())));
+                if (!options.all && errors.length)
+                    return errors;
+            }
+            return errors;
+        });
+    },
+    /**
+     * Creates a validator that asserts that the input array is a tuple whose elements match
+     * the given validators.
+     *
+     * @param validators
+     */
+    tuple(...validators) {
+        const lengthValidator = createValidator(substitute(locale.exactlyLength, {
+            value: validators.length,
+        }), (length) => length === validators.length);
+        return createDeepValidator(substitute(locale.tuple, { value: validators.join(', ') }), (input, options, path) => {
+            const errors = [];
+            errors.push(...lengthValidator.validate(input.length, options, path));
+            if (!options.all && errors.length)
+                return errors;
+            const n = Math.min(validators.length, input.length);
+            for (let i = 0; i < n; i++) {
+                const element = input[i];
+                const validator = validators[i];
+                errors.push(...validator.validate(element, options, path.concat(i.toString())));
+                if (!options.all && errors.length)
+                    return errors;
+            }
+            return errors;
+        });
+    },
+    /**
+     * Creates a validator that validates the input array has the given minimum length.
+     * @param min The minimum number of elements (inclusive)
+     */
+    minLength(min) {
+        return createValidator(substitute(locale.minLength, { value: min }), (input) => input.length >= min, (input) => substitute(locale.actualLength, { value: input.length }));
+    },
+    /**
+     *
+     * Creates a validator that validates the input array has the given maximum length.
+     * @param max The maximum number of elements (inclusive)
+     */
+    maxLength(max) {
+        return createValidator(substitute(locale.maxLength, { value: max }), (input) => input.length <= max, (input) => substitute(locale.actualLength, { value: input.length }));
+    },
+};
+export class ArraySchema extends ValueSchema {
+    static _base = null;
+    /**
+     * The base ArraySchema instance validating that the input is an Array.
+     */
+    static get base() {
+        if (this._base == null)
+            this._base = new ArraySchema(arrayValidators.isArray());
+        return this._base;
+    }
+    /**
+     * Creates a validator that asserts that every element passes the given validator.
+     *
+     * @param elementValidator
+     */
+    withElements(elementValidator) {
+        return this.chain(arrayValidators.withElements(elementValidator));
+    }
+    /**
+     * Creates a validator that asserts that the input array is a tuple whose elements match
+     * the given validators.
+     *
+     * @param validators
+     */
+    tuple(...validators) {
+        return this.chain(arrayValidators.tuple(...validators));
+    }
+    /**
+     * Creates a validator that validates the input array has the given minimum length.
+     * @param min The minimum number of elements (inclusive)
+     */
+    minLength(min) {
+        return this.chain(arrayValidators.minLength(min));
+    }
+    /**
+     *
+     * Creates a validator that validates the input array has the given maximum length.
+     * @param max The maximum number of elements (inclusive)
+     */
+    maxLength(max) {
+        return this.chain(arrayValidators.maxLength(max));
+    }
+    /**
+     * Casts to a readonly array.
+     * This is a shallow cast, elements of the array will not be changed.
+     */
+    readonly() {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        return this;
+    }
+    /**
+     * Casts the type parameter.
+     */
+    cast() {
+        return this;
+    }
+}

package/dist/types/current/validation/FunctionSchema.d.ts

@@ -0,0 +1,21 @@
+import type { Fun } from '@amazon/vinyl-util';
+import { ValueSchema } from './ValueSchema';
+import type { Validator } from './Validator';
+export declare const functionValidators: {
+    readonly length: (max: number) => Validator<Fun, Fun>;
+};
+export declare class FunctionSchema<T extends Fun> extends ValueSchema<T> {
+    private static _base;
+    /**
+     * The base Function validator validating that the input is a function.
+     */
+    static get base(): FunctionSchema<Fun>;
+    length(max: number): FunctionSchema<T>;
+    /**
+     * Casts the function signature.
+     * Function signatures, except for their required number of parameters, cannot be
+     * meaningfully validated.
+     */
+    cast<T extends Fun>(): FunctionSchema<T>;
+}
+//# sourceMappingURL=FunctionSchema.d.ts.map

package/dist/types/current/validation/FunctionSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionSchema.d.ts","sourceRoot":"","sources":["../../../../src/validation/FunctionSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAA;AAE7C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAY5C,eAAO,MAAM,kBAAkB;2BACf,MAAM,KAAG,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;CAOlC,CAAA;AAEV,qBAAa,cAAc,CAAC,CAAC,SAAS,GAAG,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IAC7D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAmC;IAEvD;;OAEG;IACH,MAAM,KAAK,IAAI,IAAI,cAAc,CAAC,GAAG,CAAC,CAIrC;IAED,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC;IAItC;;;;OAIG;IACH,IAAI,CAAC,CAAC,SAAS,GAAG,KAAK,cAAc,CAAC,CAAC,CAAC;CAG3C"}

package/dist/types/current/validation/FunctionSchema.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { substitute } from '@amazon/vinyl-util';
+import { ValueSchema } from './ValueSchema';
+import { createValidator } from './Validator';
+import { typeOfValidators } from '../validation/typeOfValidators';
+/**
+ * @private
+ */
+const locale = {
+    length: 'at most {value} arguments',
+    actualLength: '{value} arguments',
+};
+export const functionValidators = {
+    length(max) {
+        return createValidator(substitute(locale.length, { value: max }), (input) => input.length <= max, (input) => substitute(locale.actualLength, { value: input.length }));
+    },
+};
+export class FunctionSchema extends ValueSchema {
+    static _base = null;
+    /**
+     * The base Function validator validating that the input is a function.
+     */
+    static get base() {
+        if (this._base == null)
+            this._base = new FunctionSchema(typeOfValidators.func);
+        return this._base;
+    }
+    length(max) {
+        return this.chain(functionValidators.length(max));
+    }
+    /**
+     * Casts the function signature.
+     * Function signatures, except for their required number of parameters, cannot be
+     * meaningfully validated.
+     */
+    cast() {
+        return this;
+    }
+}

package/dist/types/current/validation/NumberSchema.d.ts

@@ -0,0 +1,100 @@
+import { ValueSchema } from './ValueSchema';
+import type { Validator } from './Validator';
+export declare const numberValidators: {
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * value.
+     *
+     * @param min The minimum (inclusive) the value may be.
+     */
+    readonly gte: (min: number) => Validator<number, number>;
+    /**
+     * Creates a validator that asserts that the input number is greater than the provided minimum
+     * value.
+     *
+     * @param min The minimum (exclusive) the value may be.
+     */
+    readonly gt: (min: number) => Validator<number, number>;
+    /**
+     * Creates a validator that asserts that the input number is at most the provided maximum
+     * value.
+     *
+     * @param max The maximum (inclusive) the value may be.
+     */
+    readonly lte: (max: number) => Validator<number, number>;
+    /**
+     * Creates a validator that asserts that the input number is less than the provided maximum
+     * value.
+     *
+     * @param max The maximum (exclusive) the value may be.
+     */
+    readonly lt: (max: number) => Validator<number, number>;
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * and at most the provided maximum values.
+     *
+     * @param min The minimum (inclusive) value the input may be.
+     * @param max The maximum (inclusive) value the input may be.
+     */
+    readonly within: (min: number, max: number) => Validator<number, number>;
+    /**
+     * Creates a validator that asserts that the input number is finite.
+     */
+    readonly finite: () => Validator<number, number>;
+    /**
+     * Creates a validator that asserts that the input number is a safe integer.
+     */
+    readonly safeInteger: () => Validator<number, number>;
+};
+export declare class NumberSchema extends ValueSchema<number> {
+    private static _base;
+    /**
+     * The base Object validator validating that the input is an object.
+     */
+    static get base(): NumberSchema;
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * value.
+     *
+     * @param min The minimum (inclusive) the value may be.
+     */
+    gte(min: number): this;
+    /**
+     * Creates a validator that asserts that the input number is greater than the provided minimum
+     * value.
+     *
+     * @param min The minimum (exclusive) the value may be.
+     */
+    gt(min: number): this;
+    /**
+     * Creates a validator that asserts that the input number is at most the provided maximum
+     * value.
+     *
+     * @param max The maximum (inclusive) the value may be.
+     */
+    lte(max: number): this;
+    /**
+     * Creates a validator that asserts that the input number is less than the provided maximum
+     * value.
+     *
+     * @param max The maximum (exclusive) the value may be.
+     */
+    lt(max: number): this;
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * and at most the provided maximum values.
+     *
+     * @param min The minimum (inclusive) value the input may be.
+     * @param max The maximum (inclusive) value the input may be.
+     */
+    within(min: number, max: number): this;
+    /**
+     * Creates a validator that asserts that the input number is finite.
+     */
+    finite(): this;
+    /**
+     * Creates a validator that asserts that the input number is a safe integer.
+     */
+    safeInteger(): this;
+}
+//# sourceMappingURL=NumberSchema.d.ts.map

package/dist/types/current/validation/NumberSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberSchema.d.ts","sourceRoot":"","sources":["../../../../src/validation/NumberSchema.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAa5C,eAAO,MAAM,gBAAgB;IACzB;;;;;OAKG;wBACM,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAO3C;;;;;OAKG;uBACK,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAO1C;;;;;OAKG;wBACM,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAO3C;;;;;OAKG;uBACK,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAO1C;;;;;;OAMG;2BACS,MAAM,OAAO,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAO3D;;OAEG;2BACO,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAInC;;OAEG;gCACY,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;CAKlC,CAAA;AAEV,qBAAa,YAAa,SAAQ,WAAW,CAAC,MAAM,CAAC;IACjD,OAAO,CAAC,MAAM,CAAC,KAAK,CAA4B;IAEhD;;OAEG;IACH,MAAM,KAAK,IAAI,IAAI,YAAY,CAI9B;IAED;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAItB;;;;;OAKG;IACH,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIrB;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAItB;;;;;OAKG;IACH,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIrB;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAItC;;OAEG;IACH,MAAM,IAAI,IAAI;IAId;;OAEG;IACH,WAAW,IAAI,IAAI;CAGtB"}

package/dist/types/current/validation/NumberSchema.js

@@ -0,0 +1,146 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { substitute } from '@amazon/vinyl-util';
+import { ValueSchema } from './ValueSchema';
+import { typeOfValidators } from './typeOfValidators';
+import { createValidator } from './Validator';
+const locale = {
+    gte: 'at least {value}',
+    gt: 'greater than {value}',
+    lte: 'at most {value}',
+    lt: 'less than {value}',
+    within: 'within {min} and {max}',
+    safeInteger: 'safe integer',
+    finite: 'finite',
+};
+export const numberValidators = {
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * value.
+     *
+     * @param min The minimum (inclusive) the value may be.
+     */
+    gte(min) {
+        return createValidator(substitute(locale.gte, { value: min }), (input) => input >= min);
+    },
+    /**
+     * Creates a validator that asserts that the input number is greater than the provided minimum
+     * value.
+     *
+     * @param min The minimum (exclusive) the value may be.
+     */
+    gt(min) {
+        return createValidator(substitute(locale.gt, { value: min }), (input) => input > min);
+    },
+    /**
+     * Creates a validator that asserts that the input number is at most the provided maximum
+     * value.
+     *
+     * @param max The maximum (inclusive) the value may be.
+     */
+    lte(max) {
+        return createValidator(substitute(locale.lte, { value: max }), (input) => input <= max);
+    },
+    /**
+     * Creates a validator that asserts that the input number is less than the provided maximum
+     * value.
+     *
+     * @param max The maximum (exclusive) the value may be.
+     */
+    lt(max) {
+        return createValidator(substitute(locale.lt, { value: max }), (input) => input < max);
+    },
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * and at most the provided maximum values.
+     *
+     * @param min The minimum (inclusive) value the input may be.
+     * @param max The maximum (inclusive) value the input may be.
+     */
+    within(min, max) {
+        return createValidator(substitute(locale.within, { min, max }), (input) => input >= min && input <= max);
+    },
+    /**
+     * Creates a validator that asserts that the input number is finite.
+     */
+    finite() {
+        return createValidator(locale.finite, (input) => Number.isFinite(input));
+    },
+    /**
+     * Creates a validator that asserts that the input number is a safe integer.
+     */
+    safeInteger() {
+        return createValidator(locale.safeInteger, (input) => Number.isSafeInteger(input));
+    },
+};
+export class NumberSchema extends ValueSchema {
+    static _base = null;
+    /**
+     * The base Object validator validating that the input is an object.
+     */
+    static get base() {
+        if (this._base == null)
+            this._base = new NumberSchema(typeOfValidators.number);
+        return this._base;
+    }
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * value.
+     *
+     * @param min The minimum (inclusive) the value may be.
+     */
+    gte(min) {
+        return this.chain(numberValidators.gte(min));
+    }
+    /**
+     * Creates a validator that asserts that the input number is greater than the provided minimum
+     * value.
+     *
+     * @param min The minimum (exclusive) the value may be.
+     */
+    gt(min) {
+        return this.chain(numberValidators.gt(min));
+    }
+    /**
+     * Creates a validator that asserts that the input number is at most the provided maximum
+     * value.
+     *
+     * @param max The maximum (inclusive) the value may be.
+     */
+    lte(max) {
+        return this.chain(numberValidators.lte(max));
+    }
+    /**
+     * Creates a validator that asserts that the input number is less than the provided maximum
+     * value.
+     *
+     * @param max The maximum (exclusive) the value may be.
+     */
+    lt(max) {
+        return this.chain(numberValidators.lt(max));
+    }
+    /**
+     * Creates a validator that asserts that the input number is at least the provided minimum
+     * and at most the provided maximum values.
+     *
+     * @param min The minimum (inclusive) value the input may be.
+     * @param max The maximum (inclusive) value the input may be.
+     */
+    within(min, max) {
+        return this.chain(numberValidators.within(min, max));
+    }
+    /**
+     * Creates a validator that asserts that the input number is finite.
+     */
+    finite() {
+        return this.chain(numberValidators.finite());
+    }
+    /**
+     * Creates a validator that asserts that the input number is a safe integer.
+     */
+    safeInteger() {
+        return this.chain(numberValidators.safeInteger());
+    }
+}

package/dist/types/current/validation/ObjectSchema.d.ts

@@ -0,0 +1,54 @@
+import type { AnyRecord, IsPropertyOptional, PartialDeep } from '@amazon/vinyl-util';
+import type { ValidatorWithPartial } from './ValidatorWithPartial';
+import { ValueSchema } from './ValueSchema';
+import type { PropertyValidator } from '../validation/PropertyValidator';
+import type { Equal } from '@amazon/vinyl-util/browserTestUtil';
+export declare const objectValidators: {
+    /**
+     * Creates a validator that validates the input has properties that pass their respective
+     * validators.
+     *
+     * @param propertyValidators
+     */
+    readonly properties: <U extends object>(propertyValidators: { readonly [P in keyof U]-?: PropertyValidator<Required<U>[P], {
+        optional: IsPropertyOptional<U, P>;
+    }>; }) => ValidatorWithPartial<U, object>;
+};
+/**
+ * Chainable object validators.
+ */
+export declare class ObjectSchema<T extends object> extends ValueSchema<T> implements ValidatorWithPartial<T, unknown> {
+    private static _base;
+    /**
+     * The base Object validator validating that the input is an object.
+     */
+    static get base(): ObjectSchema<AnyRecord>;
+    /**
+     * Creates a validator that validates the input has properties that pass their respective
+     * validators.
+     *
+     * @param propertyValidators
+     */
+    extend<U extends object>(propertyValidators: NoInfer<ExtendedPropertyValidators<T, U>>): ObjectSchema<U>;
+    /**
+     * Allows all properties to be undefined.
+     */
+    partial(): ObjectSchema<Partial<T>>;
+    /**
+     * Allows all recursive properties to be undefined.
+     */
+    partialDeep(): ObjectSchema<PartialDeep<T>>;
+    /**
+     * Casts the type parameter.
+     */
+    cast<T extends object>(): ObjectSchema<T>;
+}
+export type ExtendedPropertyValidators<T extends object, U extends object> = {
+    [K in keyof U as K extends keyof T ? Equal<U[K], T[K]> extends true ? never : K : K]-?: ExtendedPropertyValidator<U & T, K>;
+} & {
+    [K in keyof U as K extends keyof T ? Equal<U[K], T[K]> extends true ? K : never : never]?: ExtendedPropertyValidator<U & T, K>;
+};
+export type ExtendedPropertyValidator<U extends object, P extends keyof U> = PropertyValidator<Required<U>[P], {
+    optional: IsPropertyOptional<U, P>;
+}>;
+//# sourceMappingURL=ObjectSchema.d.ts.map

package/dist/types/current/validation/ObjectSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectSchema.d.ts","sourceRoot":"","sources":["../../../../src/validation/ObjectSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACR,SAAS,EACT,kBAAkB,EAClB,WAAW,EACd,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAElE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAI3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oCAAoC,CAAA;AAa/D,eAAO,MAAM,gBAAgB;IACzB;;;;;OAKG;0BACQ,CAAC,SAAS,MAAM,sBAAsB,EAC7C,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,iBAAiB,CACxC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACd;QAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;KAAE,CACzC,GACJ,KAAG,oBAAoB,CAAC,CAAC,EAAE,MAAM,CAAC;CAyE7B,CAAA;AAEV;;GAEG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CACtC,SAAQ,WAAW,CAAC,CAAC,CACrB,YAAW,oBAAoB,CAAC,CAAC,EAAE,OAAO,CAAC;IAE3C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAuC;IAE3D;;OAEG;IACH,MAAM,KAAK,IAAI,IAAI,YAAY,CAAC,SAAS,CAAC,CAIzC;IAED;;;;;OAKG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,EACnB,kBAAkB,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9D,YAAY,CAAC,CAAC,CAAC;IAIlB;;OAEG;IACH,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAInC;;OAEG;IACH,WAAW,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAI3C;;OAEG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC;CAG5C;AAED,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAIxE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAC5B,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC1B,KAAK,GACL,CAAC,GACL,CAAC,CAAC,CAAC,GAAG,yBAAyB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CAClD,GAAG;KAGC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAC5B,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC1B,CAAC,GACD,KAAK,GACT,KAAK,CAAC,CAAC,EAAE,yBAAyB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CACrD,CAAA;AAED,MAAM,MAAM,yBAAyB,CACjC,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,IACjB,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;IAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAAE,CAAC,CAAA"}

package/dist/types/current/validation/ObjectSchema.js

@@ -0,0 +1,125 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { merge, ownKeys, substitute } from '@amazon/vinyl-util';
+import { maybeToDeepPartial, maybeToPartial } from './ValidatorWithPartial';
+import { ValueSchema } from './ValueSchema';
+import { typeOfValidators } from './typeOfValidators';
+import { createDeepValidator } from './Validator';
+/**
+ * @private
+ */
+const locale = {
+    extend: '{\n{body}\n}',
+    prop: '{key}: {value}',
+    propSeparator: ',\n',
+    indent: '  ',
+    required: `property '{key}' is required`,
+};
+export const objectValidators = {
+    /**
+     * Creates a validator that validates the input has properties that pass their respective
+     * validators.
+     *
+     * @param propertyValidators
+     */
+    properties(propertyValidators) {
+        const propertiesDescriptions = [];
+        const keys = ownKeys(propertyValidators);
+        for (const key of keys) {
+            const validator = propertyValidators[key];
+            propertiesDescriptions.push(substitute(locale.prop, {
+                key: String(key) + (validator.options.optional ? '?' : ''),
+                value: validator.description,
+            }));
+        }
+        const description = substitute(locale.extend, {
+            body: propertiesDescriptions
+                .join(locale.propSeparator)
+                .split('\n')
+                .map((line) => locale.indent + line)
+                .join('\n'),
+        });
+        const validator = createDeepValidator(description, (input, options, path) => {
+            const errors = [];
+            for (const key of keys) {
+                const validator = propertyValidators[key];
+                if (key in input) {
+                    const value = input[key];
+                    errors.push(...validator.validate(value, options, path.concat(String(key))));
+                }
+                else {
+                    // Missing property
+                    if (!validator.options.optional) {
+                        errors.push({
+                            message: substitute(locale.required, { key }),
+                            path: path.concat(String(key)),
+                        });
+                    }
+                }
+                if (!options.all && errors.length)
+                    return errors;
+            }
+            return errors;
+        });
+        return merge(validator, {
+            partial() {
+                const optionalPropertyValidators = {};
+                for (const key of keys) {
+                    optionalPropertyValidators[key] =
+                        propertyValidators[key].optional();
+                }
+                return objectValidators.properties(optionalPropertyValidators);
+            },
+            partialDeep() {
+                const optionalPropertyValidators = {};
+                for (const key of keys) {
+                    optionalPropertyValidators[key] = maybeToDeepPartial(propertyValidators[key].optional());
+                }
+                return objectValidators.properties(optionalPropertyValidators);
+            },
+        });
+    },
+};
+/**
+ * Chainable object validators.
+ */
+export class ObjectSchema extends ValueSchema {
+    static _base = null;
+    /**
+     * The base Object validator validating that the input is an object.
+     */
+    static get base() {
+        if (this._base == null)
+            this._base = new ObjectSchema(typeOfValidators.object);
+        return this._base;
+    }
+    /**
+     * Creates a validator that validates the input has properties that pass their respective
+     * validators.
+     *
+     * @param propertyValidators
+     */
+    extend(propertyValidators) {
+        return this.chain(objectValidators.properties(propertyValidators));
+    }
+    /**
+     * Allows all properties to be undefined.
+     */
+    partial() {
+        return this.clone(maybeToPartial);
+    }
+    /**
+     * Allows all recursive properties to be undefined.
+     */
+    partialDeep() {
+        return this.clone(maybeToDeepPartial);
+    }
+    /**
+     * Casts the type parameter.
+     */
+    cast() {
+        return this;
+    }
+}

package/dist/types/current/validation/PropertyValidator.d.ts

@@ -0,0 +1,23 @@
+import type { Validator } from '../validation/Validator';
+import type { Merge } from '@amazon/vinyl-util';
+export interface PropertyValidatorOptions {
+    /**
+     * If true, when the property is omitted, the object schema should not fail validation.
+     */
+    readonly optional: boolean;
+}
+/**
+ * A utility type for overriding the options type on a validator.
+ * This will strip the types of the overridden options and set to the new types.
+ */
+export type PropertyValidatorWithOptions<ValidatorType extends PropertyValidator<any, any>, T, Options extends PropertyValidatorOptions> = Omit<ValidatorType, keyof PropertyValidator<any, any>> & PropertyValidator<T, Merge<ValidatorType['options'], Options>>;
+export interface PropertyValidator<T, PropertyOptionsType extends PropertyValidatorOptions> extends Validator<T> {
+    readonly options: PropertyOptionsType;
+    optional(): PropertyValidatorWithOptions<this, T, {
+        readonly optional: true;
+    }>;
+    required(): PropertyValidatorWithOptions<this, T, {
+        readonly optional: false;
+    }>;
+}
+//# sourceMappingURL=PropertyValidator.d.ts.map

package/dist/types/current/validation/PropertyValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyValidator.d.ts","sourceRoot":"","sources":["../../../../src/validation/PropertyValidator.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE/C,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,CACpC,aAAa,SAAS,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,EACjD,CAAC,EACD,OAAO,SAAS,wBAAwB,IACxC,IAAI,CAAC,aAAa,EAAE,MAAM,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GACtD,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC,CAAA;AAElE,MAAM,WAAW,iBAAiB,CAC9B,CAAC,EACD,mBAAmB,SAAS,wBAAwB,CACtD,SAAQ,SAAS,CAAC,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAA;IAErC,QAAQ,IAAI,4BAA4B,CACpC,IAAI,EACJ,CAAC,EACD;QAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;KAAE,CAC9B,CAAA;IAED,QAAQ,IAAI,4BAA4B,CACpC,IAAI,EACJ,CAAC,EACD;QAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAA;KAAE,CAC/B,CAAA;CACJ"}