@amazon/vinyl-validation 1.0.0

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

@@ -0,0 +1,5 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

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

@@ -0,0 +1,58 @@
+import type { ReadonlyRecord } from '@amazon/vinyl-util';
+import { ValueSchema } from './ValueSchema';
+import type { Validator } from './Validator';
+export declare const recordValidators: {
+    /**
+     * Returns a validator that asserts that the object's own enumerable properties has keys and
+     * values that match their respective validators.
+     *
+     * Prototype members are not included.
+     * Numeric keys are validated as strings. For example the object `{ [0]: 1 }` will be passed
+     * to the key validator as '0'.
+     *
+     * @param keyValidator Validates each key.
+     * @param valueValidator Validates each value.
+     */
+    readonly record: <K extends string | symbol, V>(keyValidator: Validator<K>, valueValidator: Validator<V>) => Validator<Record<K, V>, object>;
+};
+/**
+ * Chainable object validators for the Record type.
+ */
+export declare class RecordSchema<T extends ReadonlyRecord<keyof any, any>> extends ValueSchema<T> {
+    private static _base;
+    /**
+     * The base Object validator validating that the input is an object.
+     */
+    static get base(): RecordSchema<Record<keyof any, unknown>>;
+    private static get defaultKeyValidator();
+    /**
+     * Returns a validator that asserts that the object's own enumerable properties has keys and
+     * values that match their respective validators.
+     *
+     * Prototype members are not included.
+     * Numeric keys are validated as strings. For example the object `{ [0]: 1 }` will be passed
+     * to the key validator as '0'.
+     *
+     * @param keyValidator Validates each key.
+     * @param valueValidator Validates each value.
+     */
+    record<K extends string | symbol, V>(keyValidator: Validator<K>, valueValidator: Validator<V>): RecordSchema<ReadonlyRecord<K, V>>;
+    /**
+     * Returns a validator that asserts that the object's own enumerable properties has
+     * string keys and values that match the given validator.
+     *
+     * Prototype members are not included.
+     *
+     * @param valueValidator Validates each value.
+     */
+    recordValues<V>(valueValidator: Validator<V>): RecordSchema<Record<string, V>>;
+    /**
+     * Casts to a ReadonlyRecord
+     */
+    readonly(): RecordSchema<T extends Record<infer K, infer V> ? ReadonlyRecord<K, V> : never>;
+    /**
+     * Casts the type parameter.
+     */
+    cast<T extends ReadonlyRecord<keyof any, unknown>>(): RecordSchema<T>;
+}
+//# sourceMappingURL=RecordSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RecordSchema.d.ts","sourceRoot":"","sources":["../../../../src/validation/RecordSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAG3C,OAAO,KAAK,EAA0B,SAAS,EAAE,MAAM,aAAa,CAAA;AAUpE,eAAO,MAAM,gBAAgB;IACzB;;;;;;;;;;OAUG;sBACI,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,gBACjB,SAAS,CAAC,CAAC,CAAC,kBACV,SAAS,CAAC,CAAC,CAAC,KAC7B,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC;CAgC5B,CAAA;AAEV;;GAEG;AACH,qBAAa,YAAY,CACrB,CAAC,SAAS,cAAc,CAAC,MAAM,GAAG,EAAE,GAAG,CAAC,CAC1C,SAAQ,WAAW,CAAC,CAAC,CAAC;IACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAwD;IAE5E;;OAEG;IACH,MAAM,KAAK,IAAI,IAAI,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC,CAI1D;IAED,OAAO,CAAC,MAAM,KAAK,mBAAmB,GAErC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,EAC/B,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC,EAC1B,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,GAC7B,YAAY,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAIrC;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,EACV,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,GAC7B,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAIlC;;OAEG;IACH,QAAQ,IAAI,YAAY,CACpB,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CACpE;IAID;;OAEG;IACH,IAAI,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC;CAGxE"}

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

@@ -0,0 +1,101 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ownKeys, substitute } from '@amazon/vinyl-util';
+import { ValueSchema } from './ValueSchema';
+import { StringSchema } from './StringSchema';
+import { typeOfValidators } from './typeOfValidators';
+import { createDeepValidator } from './Validator';
+/**
+ * @private
+ */
+const locale = {
+    record: '{ [key: {key}]: {value} }',
+};
+export const recordValidators = {
+    /**
+     * Returns a validator that asserts that the object's own enumerable properties has keys and
+     * values that match their respective validators.
+     *
+     * Prototype members are not included.
+     * Numeric keys are validated as strings. For example the object `{ [0]: 1 }` will be passed
+     * to the key validator as '0'.
+     *
+     * @param keyValidator Validates each key.
+     * @param valueValidator Validates each value.
+     */
+    record(keyValidator, valueValidator) {
+        return createDeepValidator(substitute(locale.record, {
+            key: keyValidator.description,
+            value: valueValidator.description,
+        }), (input, options, path) => {
+            const errors = [];
+            for (const key of ownKeys(input)) {
+                const keyStr = String(key);
+                errors.push(...keyValidator.validate(key, options, path.concat(`[${keyStr}]`)));
+                if (!options.all && errors.length)
+                    return errors;
+                const value = input[key];
+                errors.push(...valueValidator.validate(value, options, path.concat(keyStr)));
+                if (!options.all && errors.length)
+                    return errors;
+            }
+            return errors;
+        });
+    },
+};
+/**
+ * Chainable object validators for the Record type.
+ */
+export class RecordSchema 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 RecordSchema(typeOfValidators.object);
+        return this._base;
+    }
+    static get defaultKeyValidator() {
+        return StringSchema.base;
+    }
+    /**
+     * Returns a validator that asserts that the object's own enumerable properties has keys and
+     * values that match their respective validators.
+     *
+     * Prototype members are not included.
+     * Numeric keys are validated as strings. For example the object `{ [0]: 1 }` will be passed
+     * to the key validator as '0'.
+     *
+     * @param keyValidator Validates each key.
+     * @param valueValidator Validates each value.
+     */
+    record(keyValidator, valueValidator) {
+        return this.chain(recordValidators.record(keyValidator, valueValidator));
+    }
+    /**
+     * Returns a validator that asserts that the object's own enumerable properties has
+     * string keys and values that match the given validator.
+     *
+     * Prototype members are not included.
+     *
+     * @param valueValidator Validates each value.
+     */
+    recordValues(valueValidator) {
+        return this.record(RecordSchema.defaultKeyValidator, valueValidator);
+    }
+    /**
+     * Casts to a ReadonlyRecord
+     */
+    readonly() {
+        return this;
+    }
+    /**
+     * Casts the type parameter.
+     */
+    cast() {
+        return this;
+    }
+}

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

@@ -0,0 +1,65 @@
+import type { ValidationErrorMessage, ValidationOptions, Validator } from './Validator';
+import type { PropertyValidator, PropertyValidatorWithOptions } from './PropertyValidator';
+/**
+ * A base class for validation state.
+ * Provides methods for chaining.
+ *
+ * Subclasses should not override constructors.
+ */
+export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
+    readonly optional: false;
+}> {
+    private readonly currentValidator;
+    private readonly previousSchema?;
+    private readonly operation?;
+    __type: import("@amazon/vinyl-util").Invariant<T>;
+    private readonly validator;
+    private _options;
+    get options(): {
+        readonly optional: false;
+    };
+    /**
+     * Constructs the first link in a schema chain.
+     *
+     * @param currentValidator
+     */
+    constructor(currentValidator: Validator<any, any>);
+    /**
+     * Constructs linking to the given previous schema.
+     *
+     * @param currentValidator
+     * @param previousSchema
+     * @param operation
+     */
+    constructor(currentValidator: Validator<any, any>, previousSchema: SchemaBase<any>, operation: (validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>);
+    get description(): string;
+    readonly assert: (input: unknown, origin?: string, path?: readonly string[]) => asserts input is T;
+    readonly isValid: (input: unknown) => input is T;
+    readonly validate: (input: unknown, options?: ValidationOptions, path?: readonly string[]) => readonly ValidationErrorMessage[];
+    /**
+     * Clones this schema, transforming all validators with the given mutator.
+     *
+     * @param transform A transformer which takes an existing validator in the chain and returns
+     * a new one. Validators should be considered to be immutable; transform should not change the
+     * input but instead return a new validator.
+     */
+    protected clone(transform?: (validator: Validator<any>) => Validator<any>): any;
+    protected self(current: Validator<any, any>): any;
+    protected self(currentValidator: Validator<any, any>, previousSchema: SchemaBase<any> | undefined, operation: ((validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>) | undefined): any;
+    /**
+     * Constructs a new schema with a validator chaining the current validator with the
+     * provided next in an AND operation.
+     *
+     * @param nextValidator The validator to run after the current.
+     * @return Returns a new Schema instance the same class with a new validator chaining the
+     * current validator with the given next in an AND operation.
+     */
+    protected chain(nextValidator: Validator<any, any>): any;
+    optional(): PropertyValidatorWithOptions<this, T, {
+        readonly optional: true;
+    }>;
+    required(): PropertyValidatorWithOptions<this, T, {
+        readonly optional: false;
+    }>;
+}
+//# sourceMappingURL=SchemaBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaBase.d.ts","sourceRoot":"","sources":["../../../../src/validation/SchemaBase.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACR,sBAAsB,EACtB,iBAAiB,EACjB,SAAS,EACZ,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EACR,iBAAiB,EAEjB,4BAA4B,EAC/B,MAAM,qBAAqB,CAAA;AAM5B;;;;;GAKG;AACH,8BAAsB,UAAU,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAC5D,CAAC,EACD;IAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAA;CAAE,CAC/B;IAkCO,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAnC/B,MAAM,4CAAiB;IAEvB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,QAAQ,CAA4B;IAE5C,IAAI,OAAO;;MAEV;IAED;;;;OAIG;gBACS,gBAAgB,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAEjD;;;;;;OAMG;gBAEC,gBAAgB,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EACrC,cAAc,EAAE,UAAU,CAAC,GAAG,CAAC,EAC/B,SAAS,EAAE,CACP,UAAU,EAAE,SAAS,CAAC,GAAG,CAAC,EAC1B,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,KAC9B,SAAS,CAAC,CAAC,CAAC;IAmBrB,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,QAAQ,CAAC,MAAM,EAAE,CACb,KAAK,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,KACvB,OAAO,CAAC,KAAK,IAAI,CAAC,CAEtB;IAED,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAEF;IAE9C,QAAQ,CAAC,QAAQ,GACb,OAAO,OAAO,EACd,UAAU,iBAAiB,EAC3B,OAAO,SAAS,MAAM,EAAE,KACzB,SAAS,sBAAsB,EAAE,CACa;IAEjD;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,CACX,SAAS,GAAE,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,CAAY,GACpE,GAAG;IAYN,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG;IAEjD,SAAS,CAAC,IAAI,CACV,gBAAgB,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EACrC,cAAc,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,SAAS,EAC3C,SAAS,EACH,CAAC,CACG,UAAU,EAAE,SAAS,CAAC,GAAG,CAAC,EAC1B,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,KAC9B,SAAS,CAAC,CAAC,CAAC,CAAC,GAClB,SAAS,GAChB,GAAG;IAkBN;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG;IAIxD,QAAQ,IAAI,4BAA4B,CACpC,IAAI,EACJ,CAAC,EACD;QAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;KAAE,CAC9B;IASD,QAAQ,IAAI,4BAA4B,CACpC,IAAI,EACJ,CAAC,EACD;QAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAA;KAAE,CAC/B;CAQJ"}

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

@@ -0,0 +1,90 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IllegalArgumentError, invariant } from '@amazon/vinyl-util';
+import { andValidators } from './andValidators';
+const requiredValidationOptions = {
+    optional: false,
+};
+/**
+ * A base class for validation state.
+ * Provides methods for chaining.
+ *
+ * Subclasses should not override constructors.
+ */
+export class SchemaBase {
+    currentValidator;
+    previousSchema;
+    operation;
+    __type = invariant();
+    validator;
+    _options = requiredValidationOptions;
+    get options() {
+        return this._options;
+    }
+    constructor(currentValidator, previousSchema, operation) {
+        this.currentValidator = currentValidator;
+        this.previousSchema = previousSchema;
+        this.operation = operation;
+        this.validator =
+            operation == null
+                ? currentValidator
+                : operation(previousSchema, currentValidator);
+    }
+    get description() {
+        return this.validator.description;
+    }
+    assert = (input, origin, path) => {
+        this.validator.assert(input, origin, path);
+    };
+    isValid = (input) => this.validator.isValid(input);
+    validate = (input, options, path) => this.validator.validate(input, options, path);
+    /**
+     * Clones this schema, transforming all validators with the given mutator.
+     *
+     * @param transform A transformer which takes an existing validator in the chain and returns
+     * a new one. Validators should be considered to be immutable; transform should not change the
+     * input but instead return a new validator.
+     */
+    clone(transform = (v) => v) {
+        const cloned = this.operation
+            ? this.self(transform(this.currentValidator), this.previousSchema.clone(transform), this.operation)
+            : this.self(transform(this.currentValidator));
+        cloned._options = this._options;
+        return cloned;
+    }
+    self(current, previous, operation) {
+        if (this.constructor.length > 3) {
+            throw new IllegalArgumentError('constructor should have at most three required arguments');
+        }
+        return new this.constructor(current, previous, operation);
+    }
+    /**
+     * Constructs a new schema with a validator chaining the current validator with the
+     * provided next in an AND operation.
+     *
+     * @param nextValidator The validator to run after the current.
+     * @return Returns a new Schema instance the same class with a new validator chaining the
+     * current validator with the given next in an AND operation.
+     */
+    chain(nextValidator) {
+        return this.self(nextValidator, this, andValidators);
+    }
+    optional() {
+        const cloned = this.clone();
+        cloned._options = {
+            ...cloned.options,
+            optional: true,
+        };
+        return cloned;
+    }
+    required() {
+        const cloned = this.clone();
+        cloned._options = {
+            ...cloned.options,
+            optional: false,
+        };
+        return cloned;
+    }
+}

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

@@ -0,0 +1,38 @@
+import type { SetElementType } from '@amazon/vinyl-util';
+import type { Validator } from './Validator';
+import { ValueSchema } from './ValueSchema';
+export declare const setValidators: {
+    /**
+     * Creates a validator that asserts that the input is a set.
+     */
+    readonly isSet: () => Validator<Set<unknown>>;
+    /**
+     * Creates a validator that asserts that every element passes the given validator.
+     *
+     * @param elementValidator
+     */
+    readonly withElements: <U>(elementValidator: Validator<U>) => Validator<Set<U>, ReadonlySet<unknown>>;
+};
+export declare class SetSchema<T extends ReadonlySet<unknown>> extends ValueSchema<T> {
+    private static _base;
+    /**
+     * The base SetSchema instance validating that the input is a Set.
+     */
+    static get base(): SetSchema<Set<unknown>>;
+    /**
+     * Creates a validator that asserts that every element passes the given validator.
+     *
+     * @param elementValidator
+     */
+    withElements<U>(elementValidator: Validator<U>): SetSchema<Set<SetElementType<T> & U>>;
+    /**
+     * Casts to a readonly set.
+     * This is a shallow cast, elements of the array will not be changed.
+     */
+    readonly(): SetSchema<ReadonlySet<SetElementType<T>>>;
+    /**
+     * Casts the parameter type.
+     */
+    cast<T extends ReadonlySet<unknown>>(): SetSchema<T>;
+}
+//# sourceMappingURL=SetSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SetSchema.d.ts","sourceRoot":"","sources":["../../../../src/validation/SetSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,OAAO,KAAK,EAA0B,SAAS,EAAE,MAAM,aAAa,CAAA;AAEpE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAU3C,eAAO,MAAM,aAAa;IACtB;;OAEG;0BACM,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAOhC;;;;OAIG;4BACU,CAAC,oBACQ,SAAS,CAAC,CAAC,CAAC,KAC/B,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;CAuBpC,CAAA;AAEV,qBAAa,SAAS,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IACzE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAuC;IAE3D;;OAEG;IACH,MAAM,KAAK,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAIzC;IAED;;;;OAIG;IACH,YAAY,CAAC,CAAC,EACV,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC,GAC/B,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAIxC;;;OAGG;IACH,QAAQ,IAAI,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAIrD;;OAEG;IACH,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;CAGvD"}

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

@@ -0,0 +1,74 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { substitute } from '@amazon/vinyl-util';
+import { createDeepValidator, createValidator } from './Validator';
+import { ValueSchema } from './ValueSchema';
+/**
+ * @private
+ */
+const locale = {
+    set: 'Set',
+    withElements: 'Set<{value}>',
+};
+export const setValidators = {
+    /**
+     * Creates a validator that asserts that the input is a set.
+     */
+    isSet() {
+        return createValidator(locale.set, (input) => input instanceof Set);
+    },
+    /**
+     * 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 = [];
+            let i = 0;
+            for (const element of input) {
+                errors.push(...elementValidator.validate(element, options, path.concat(i.toString())));
+                if (!options.all && errors.length)
+                    return errors;
+                i++;
+            }
+            return errors;
+        });
+    },
+};
+export class SetSchema extends ValueSchema {
+    static _base = null;
+    /**
+     * The base SetSchema instance validating that the input is a Set.
+     */
+    static get base() {
+        if (this._base == null)
+            this._base = new SetSchema(setValidators.isSet());
+        return this._base;
+    }
+    /**
+     * Creates a validator that asserts that every element passes the given validator.
+     *
+     * @param elementValidator
+     */
+    withElements(elementValidator) {
+        return this.chain(setValidators.withElements(elementValidator));
+    }
+    /**
+     * Casts to a readonly set.
+     * This is a shallow cast, elements of the array will not be changed.
+     */
+    readonly() {
+        return this;
+    }
+    /**
+     * Casts the parameter type.
+     */
+    cast() {
+        return this;
+    }
+}

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

@@ -0,0 +1,68 @@
+import { ValueSchema } from './ValueSchema';
+import type { Validator } from './Validator';
+export declare const stringValidators: {
+    /**
+     * Creates a validator that asserts that the input is not empty.
+     */
+    readonly notEmpty: () => Validator<string, string>;
+    /**
+     * Creates a validator that asserts that the input string has at least the given minimum
+     * length.
+     *
+     * @param min The string must be at least this length.
+     */
+    readonly minLength: (min: number) => Validator<string, string>;
+    /**
+     * Creates a validator that asserts that the input string has at most the given maximum
+     * length.
+     *
+     * @param max The string must be at most this length.
+     */
+    readonly maxLength: (max: number) => Validator<string, string>;
+    /**
+     * Creates a validator that asserts that the input string has no whitespace characters.
+     * Whitespace characters include space, new line, carriage return, and tab.
+     */
+    readonly noWhitespace: () => Validator<string, string>;
+    /**
+     * Creates a validator that asserts that the input string matches the given regex.
+     * @param regex
+     */
+    readonly matches: (regex: RegExp) => Validator<string, string>;
+};
+export declare class StringSchema extends ValueSchema<string> {
+    private static _base;
+    /**
+     * The base SetSchema instance validating that the input is a Set.
+     */
+    static get base(): StringSchema;
+    /**
+     * Creates a validator that asserts that the input is not empty.
+     */
+    notEmpty(): StringSchema;
+    /**
+     * Creates a validator that asserts that the input string has at least the given minimum
+     * length.
+     *
+     * @param min The string must be at least this length.
+     */
+    minLength(min: number): StringSchema;
+    /**
+     * Creates a validator that asserts that the input string has at most the given maximum
+     * length.
+     *
+     * @param max The string must be at most this length.
+     */
+    maxLength(max: number): StringSchema;
+    /**
+     * Creates a validator that asserts that the input string has no whitespace characters.
+     * Whitespace characters include space, new line, carriage return, and tab.
+     */
+    noWhitespace(): StringSchema;
+    /**
+     * Creates a validator that asserts that the input string matches the given regex.
+     * @param regex
+     */
+    matches(regex: RegExp): StringSchema;
+}
+//# sourceMappingURL=StringSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StringSchema.d.ts","sourceRoot":"","sources":["../../../../src/validation/StringSchema.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAc5C,eAAO,MAAM,gBAAgB;IACzB;;OAEG;6BACS,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAIrC;;;;;OAKG;8BACY,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAOjD;;;;;OAKG;8BACY,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAOjD;;;OAGG;iCACa,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAOzC;;;OAGG;8BACY,MAAM,KAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;CAQ3C,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;;OAEG;IACH,QAAQ,IAAI,YAAY;IAIxB;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAIpC;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAIpC;;;OAGG;IACH,YAAY,IAAI,YAAY;IAI5B;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;CAGvC"}

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

@@ -0,0 +1,109 @@
+/*
+ * 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';
+/**
+ * @private
+ */
+const locale = {
+    notEmpty: 'not empty',
+    minLength: 'at least {value} characters',
+    maxLength: 'at most {value} characters',
+    noWhitespace: 'no whitespace characters',
+    matches: 'matches {value}',
+};
+export const stringValidators = {
+    /**
+     * Creates a validator that asserts that the input is not empty.
+     */
+    notEmpty() {
+        return createValidator(locale.notEmpty, (input) => input !== '');
+    },
+    /**
+     * Creates a validator that asserts that the input string has at least the given minimum
+     * length.
+     *
+     * @param min The string must be at least this length.
+     */
+    minLength(min) {
+        return createValidator(substitute(locale.minLength, { value: min }), (input) => input.length >= min);
+    },
+    /**
+     * Creates a validator that asserts that the input string has at most the given maximum
+     * length.
+     *
+     * @param max The string must be at most this length.
+     */
+    maxLength(max) {
+        return createValidator(substitute(locale.maxLength, { value: max }), (input) => input.length <= max);
+    },
+    /**
+     * Creates a validator that asserts that the input string has no whitespace characters.
+     * Whitespace characters include space, new line, carriage return, and tab.
+     */
+    noWhitespace() {
+        return createValidator(locale.noWhitespace, (input) => input.search(/\s/g) === -1);
+    },
+    /**
+     * Creates a validator that asserts that the input string matches the given regex.
+     * @param regex
+     */
+    matches(regex) {
+        return createValidator(substitute(locale.matches, { value: regex.toString() }), (input) => {
+            return regex.test(input);
+        });
+    },
+};
+export class StringSchema extends ValueSchema {
+    static _base = null;
+    /**
+     * The base SetSchema instance validating that the input is a Set.
+     */
+    static get base() {
+        if (this._base == null)
+            this._base = new StringSchema(typeOfValidators.string);
+        return this._base;
+    }
+    /**
+     * Creates a validator that asserts that the input is not empty.
+     */
+    notEmpty() {
+        return this.chain(stringValidators.notEmpty());
+    }
+    /**
+     * Creates a validator that asserts that the input string has at least the given minimum
+     * length.
+     *
+     * @param min The string must be at least this length.
+     */
+    minLength(min) {
+        return this.chain(stringValidators.minLength(min));
+    }
+    /**
+     * Creates a validator that asserts that the input string has at most the given maximum
+     * length.
+     *
+     * @param max The string must be at most this length.
+     */
+    maxLength(max) {
+        return this.chain(stringValidators.maxLength(max));
+    }
+    /**
+     * Creates a validator that asserts that the input string has no whitespace characters.
+     * Whitespace characters include space, new line, carriage return, and tab.
+     */
+    noWhitespace() {
+        return this.chain(stringValidators.noWhitespace());
+    }
+    /**
+     * Creates a validator that asserts that the input string matches the given regex.
+     * @param regex
+     */
+    matches(regex) {
+        return this.chain(stringValidators.matches(regex));
+    }
+}