@amazon/vinyl-validation 1.2.0 → 2.0.0

package/dist/types/ts3.7/validation/JsonSchema.d.ts

@@ -0,0 +1,63 @@
+import { Validator } from './Validator';
+/**
+ * The `type` keyword value of a JSON Schema node.
+ */
+export type JsonSchemaType = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+/**
+ * A JSON Schema definition (a draft-07 compatible subset) describing the shape a value must take.
+ *
+ * This is the serializable representation produced by {@link toJsonSchema}, suitable for handing to
+ * an LLM as the shape it must produce. It intentionally mirrors zod-to-json-schema output for the
+ * node types this library supports.
+ */
+export interface JsonSchema {
+    readonly type?: JsonSchemaType | readonly JsonSchemaType[];
+    /**
+     * A human-readable description, attached to a schema node via its `describe` method.
+     */
+    readonly description?: string;
+    readonly properties?: Readonly<Record<string, JsonSchema>>;
+    readonly required?: readonly string[];
+    readonly additionalProperties?: boolean | JsonSchema;
+    readonly items?: JsonSchema | readonly JsonSchema[];
+    readonly additionalItems?: boolean;
+    readonly minItems?: number;
+    readonly maxItems?: number;
+    readonly uniqueItems?: boolean;
+    readonly minLength?: number;
+    readonly maxLength?: number;
+    readonly pattern?: string;
+    readonly minimum?: number;
+    readonly maximum?: number;
+    readonly exclusiveMinimum?: number;
+    readonly exclusiveMaximum?: number;
+    readonly enum?: readonly unknown[];
+    readonly anyOf?: readonly JsonSchema[];
+}
+/**
+ * A source that can produce its own JSON Schema definition. Schema nodes implement this so that
+ * per-node metadata (such as a `describe` description) is honored during serialization.
+ */
+export interface JsonSchemaProvider {
+    toJsonSchema(): JsonSchema;
+}
+/**
+ * Merges JSON Schema fragments into a single definition, later fragments taking precedence.
+ *
+ * This mirrors an intersection (`and`) of constraints: `properties` are combined and `required`
+ * keys are unioned, while all other keywords are overridden by the last fragment that defines them.
+ *
+ * @param fragments The fragments to merge. `undefined` fragments are ignored.
+ */
+export declare function mergeJsonSchema(...fragments: readonly (JsonSchema | undefined)[]): JsonSchema;
+/**
+ * Serializes a validator to a JSON Schema definition.
+ *
+ * Schema nodes ({@link JsonSchemaProvider}s) serialize themselves so that per-node metadata is
+ * honored; other validators contribute their attached JSON Schema fragment, defaulting to the empty
+ * schema (which matches any value) when none is attached.
+ *
+ * @param source The validator or schema node to serialize.
+ */
+export declare function toJsonSchema(source: Validator<any, any>): JsonSchema;
+//# sourceMappingURL=JsonSchema.d.ts.map

package/dist/types/ts3.7/validation/SchemaBase.d.ts

@@ -1,5 +1,6 @@
 import { ValidationErrorMessage, ValidationOptions, Validator } from './Validator';
 import { PropertyValidator, PropertyValidatorWithOptions } from './PropertyValidator';
+import { JsonSchema, JsonSchemaProvider } from './JsonSchema';
 /**
  * A base class for validation state.
  * Provides methods for chaining.
@@ -8,13 +9,14 @@ import { PropertyValidator, PropertyValidatorWithOptions } from './PropertyValid
  */
 export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
     readonly optional: false;
-}> {
+}>, JsonSchemaProvider {
     private readonly currentValidator;
     private readonly previousSchema?;
     private readonly operation?;
     __type: import("@amazon/vinyl-util").Invariant<T>;
     private readonly validator;
     private _options;
+    private _jsonSchemaDescription?;
     get options(): {
         readonly optional: false;
     };
@@ -33,6 +35,21 @@ export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
      */
     constructor(currentValidator: Validator<any, any>, previousSchema: SchemaBase<any>, operation: (validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>);
     get description(): string;
+    get jsonSchema(): (JsonSchema | undefined);
+    /**
+     * Attaches a human-readable description to this schema, akin to zod's `describe`.
+     * The description is metadata only; it does not affect validation, and surfaces in the output
+     * of {@link toJsonSchema}.
+     *
+     * @param description The description to attach.
+     * @return A clone of this schema carrying the description.
+     */
+    describe(description: string): this;
+    /**
+     * Serializes this schema to a JSON Schema definition, suitable for describing the shape to an
+     * LLM or other consumer. Works similarly to zod-to-json-schema.
+     */
+    toJsonSchema(): JsonSchema;
     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[];

package/dist/types/ts3.7/validation/Validator.d.ts

@@ -1,4 +1,5 @@
 import { Invariant } from '@amazon/vinyl-util';
+import { JsonSchema } from './JsonSchema';
 /**
  * Represents a validation failure.
  */
@@ -27,6 +28,15 @@ export interface Validator<Output extends Input, Input = unknown> {
      * A short description of the validator.
      */
     readonly description: string;
+    /**
+     * The JSON Schema fragment this validator contributes, if any.
+     *
+     * Fragments compose the same way the {@link description} does: chaining validators with `and`
+     * merges their fragments, and `or` unions them into an `anyOf`. Serialize a full schema with
+     * {@link toJsonSchema}. A validator with no meaningful shape (for example a bare type check)
+     * may omit this.
+     */
+    readonly jsonSchema?: JsonSchema | undefined;
     /**
      * Returns true if the input is valid according to this validator.
      *
@@ -74,8 +84,9 @@ export declare function createValidationExpectationMessage<Input>(expectationMes
  * @param isValid Returns true if the given input is valid.
  * @param inputStringify Stringifies the input for use as the actual `{actual}` token in the validation
  * expectation template. Default is `stringifyForPrint` with a 500 character max length.
+ * @param jsonSchema The JSON Schema fragment this validator contributes, if any.
  */
-export declare function createValidator<Output extends Input, Input = unknown>(expectationMessage: string, isValid: (input: Input) => boolean, inputStringify?: (input: Input) => string): Validator<Output, Input>;
+export declare function createValidator<Output extends Input, Input = unknown>(expectationMessage: string, isValid: (input: Input) => boolean, inputStringify?: (input: Input) => string, jsonSchema?: JsonSchema): Validator<Output, Input>;
 /**
  * Creates a new deep validator.
  *
@@ -83,6 +94,7 @@ export declare function createValidator<Output extends Input, Input = unknown>(e
  *
  * @param description Describes the validator.
  * @param validate Returns an array of validation failures.
+ * @param jsonSchema The JSON Schema fragment this validator contributes, if any.
  */
-export declare function createDeepValidator<Output extends Input, Input = unknown>(description: string, validate: (input: Input, options: ValidationOptions, path: readonly string[]) => readonly ValidationErrorMessage[]): Validator<Output, Input>;
+export declare function createDeepValidator<Output extends Input, Input = unknown>(description: string, validate: (input: Input, options: ValidationOptions, path: readonly string[]) => readonly ValidationErrorMessage[], jsonSchema?: JsonSchema): Validator<Output, Input>;
 //# sourceMappingURL=Validator.d.ts.map

package/dist/types/ts3.7/validation/ValueSchema.d.ts

@@ -4,6 +4,7 @@ export declare const valueValidators: {
     readonly any: () => Validator<any>;
     /**
      * Creates a validator that asserts that the input is nullish.
+     * JSON Schema has no representation for `undefined`, so only `null` is expressed.
      */
     readonly nullish: () => Validator<null | undefined>;
     /**

package/dist/types/ts4.1/index.d.ts

@@ -1,18 +1,19 @@
 /** Auto-generated from build scripts */
-export * from './validation/validators';
-export * from './validation/typeOfValidators';
-export * from './validation/orValidators';
 export * from './validation/andValidators';
-export * from './validation/ValueSchema';
-export * from './validation/ValidatorWithPartial';
-export * from './validation/Validator';
-export * from './validation/StringSchema';
-export * from './validation/SetSchema';
-export * from './validation/SchemaBase';
-export * from './validation/RecordSchema';
-export * from './validation/PropertyValidator';
-export * from './validation/ObjectSchema';
-export * from './validation/NumberSchema';
-export * from './validation/FunctionSchema';
 export * from './validation/ArraySchema';
+export * from './validation/FunctionSchema';
+export * from './validation/JsonSchema';
+export * from './validation/NumberSchema';
+export * from './validation/ObjectSchema';
+export * from './validation/orValidators';
+export * from './validation/PropertyValidator';
+export * from './validation/RecordSchema';
+export * from './validation/SchemaBase';
+export * from './validation/SetSchema';
+export * from './validation/StringSchema';
+export * from './validation/typeOfValidators';
+export * from './validation/Validator';
+export * from './validation/validators';
+export * from './validation/ValidatorWithPartial';
+export * from './validation/ValueSchema';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/ts4.1/validation/JsonSchema.d.ts

@@ -0,0 +1,63 @@
+import type { Validator } from './Validator';
+/**
+ * The `type` keyword value of a JSON Schema node.
+ */
+export type JsonSchemaType = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+/**
+ * A JSON Schema definition (a draft-07 compatible subset) describing the shape a value must take.
+ *
+ * This is the serializable representation produced by {@link toJsonSchema}, suitable for handing to
+ * an LLM as the shape it must produce. It intentionally mirrors zod-to-json-schema output for the
+ * node types this library supports.
+ */
+export interface JsonSchema {
+    readonly type?: JsonSchemaType | readonly JsonSchemaType[];
+    /**
+     * A human-readable description, attached to a schema node via its `describe` method.
+     */
+    readonly description?: string;
+    readonly properties?: Readonly<Record<string, JsonSchema>>;
+    readonly required?: readonly string[];
+    readonly additionalProperties?: boolean | JsonSchema;
+    readonly items?: JsonSchema | readonly JsonSchema[];
+    readonly additionalItems?: boolean;
+    readonly minItems?: number;
+    readonly maxItems?: number;
+    readonly uniqueItems?: boolean;
+    readonly minLength?: number;
+    readonly maxLength?: number;
+    readonly pattern?: string;
+    readonly minimum?: number;
+    readonly maximum?: number;
+    readonly exclusiveMinimum?: number;
+    readonly exclusiveMaximum?: number;
+    readonly enum?: readonly unknown[];
+    readonly anyOf?: readonly JsonSchema[];
+}
+/**
+ * A source that can produce its own JSON Schema definition. Schema nodes implement this so that
+ * per-node metadata (such as a `describe` description) is honored during serialization.
+ */
+export interface JsonSchemaProvider {
+    toJsonSchema(): JsonSchema;
+}
+/**
+ * Merges JSON Schema fragments into a single definition, later fragments taking precedence.
+ *
+ * This mirrors an intersection (`and`) of constraints: `properties` are combined and `required`
+ * keys are unioned, while all other keywords are overridden by the last fragment that defines them.
+ *
+ * @param fragments The fragments to merge. `undefined` fragments are ignored.
+ */
+export declare function mergeJsonSchema(...fragments: readonly (JsonSchema | undefined)[]): JsonSchema;
+/**
+ * Serializes a validator to a JSON Schema definition.
+ *
+ * Schema nodes ({@link JsonSchemaProvider}s) serialize themselves so that per-node metadata is
+ * honored; other validators contribute their attached JSON Schema fragment, defaulting to the empty
+ * schema (which matches any value) when none is attached.
+ *
+ * @param source The validator or schema node to serialize.
+ */
+export declare function toJsonSchema(source: Validator<any, any>): JsonSchema;
+//# sourceMappingURL=JsonSchema.d.ts.map

package/dist/types/ts4.1/validation/SchemaBase.d.ts

@@ -1,5 +1,6 @@
 import type { ValidationErrorMessage, ValidationOptions, Validator } from './Validator';
 import type { PropertyValidator, PropertyValidatorWithOptions } from './PropertyValidator';
+import type { JsonSchema, JsonSchemaProvider } from './JsonSchema';
 /**
  * A base class for validation state.
  * Provides methods for chaining.
@@ -8,13 +9,14 @@ import type { PropertyValidator, PropertyValidatorWithOptions } from './Property
  */
 export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
     readonly optional: false;
-}> {
+}>, JsonSchemaProvider {
     private readonly currentValidator;
     private readonly previousSchema?;
     private readonly operation?;
     __type: import("@amazon/vinyl-util").Invariant<T>;
     private readonly validator;
     private _options;
+    private _jsonSchemaDescription?;
     get options(): {
         readonly optional: false;
     };
@@ -33,6 +35,21 @@ export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
      */
     constructor(currentValidator: Validator<any, any>, previousSchema: SchemaBase<any>, operation: (validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>);
     get description(): string;
+    get jsonSchema(): (JsonSchema | undefined);
+    /**
+     * Attaches a human-readable description to this schema, akin to zod's `describe`.
+     * The description is metadata only; it does not affect validation, and surfaces in the output
+     * of {@link toJsonSchema}.
+     *
+     * @param description The description to attach.
+     * @return A clone of this schema carrying the description.
+     */
+    describe(description: string): this;
+    /**
+     * Serializes this schema to a JSON Schema definition, suitable for describing the shape to an
+     * LLM or other consumer. Works similarly to zod-to-json-schema.
+     */
+    toJsonSchema(): JsonSchema;
     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[];

package/dist/types/ts4.1/validation/Validator.d.ts

@@ -1,4 +1,5 @@
 import type { Invariant } from '@amazon/vinyl-util';
+import type { JsonSchema } from './JsonSchema';
 /**
  * Represents a validation failure.
  */
@@ -27,6 +28,15 @@ export interface Validator<Output extends Input, Input = unknown> {
      * A short description of the validator.
      */
     readonly description: string;
+    /**
+     * The JSON Schema fragment this validator contributes, if any.
+     *
+     * Fragments compose the same way the {@link description} does: chaining validators with `and`
+     * merges their fragments, and `or` unions them into an `anyOf`. Serialize a full schema with
+     * {@link toJsonSchema}. A validator with no meaningful shape (for example a bare type check)
+     * may omit this.
+     */
+    readonly jsonSchema?: JsonSchema | undefined;
     /**
      * Returns true if the input is valid according to this validator.
      *
@@ -74,8 +84,9 @@ export declare function createValidationExpectationMessage<Input>(expectationMes
  * @param isValid Returns true if the given input is valid.
  * @param inputStringify Stringifies the input for use as the actual `{actual}` token in the validation
  * expectation template. Default is `stringifyForPrint` with a 500 character max length.
+ * @param jsonSchema The JSON Schema fragment this validator contributes, if any.
  */
-export declare function createValidator<Output extends Input, Input = unknown>(expectationMessage: string, isValid: (input: Input) => boolean, inputStringify?: (input: Input) => string): Validator<Output, Input>;
+export declare function createValidator<Output extends Input, Input = unknown>(expectationMessage: string, isValid: (input: Input) => boolean, inputStringify?: (input: Input) => string, jsonSchema?: JsonSchema): Validator<Output, Input>;
 /**
  * Creates a new deep validator.
  *
@@ -83,6 +94,7 @@ export declare function createValidator<Output extends Input, Input = unknown>(e
  *
  * @param description Describes the validator.
  * @param validate Returns an array of validation failures.
+ * @param jsonSchema The JSON Schema fragment this validator contributes, if any.
  */
-export declare function createDeepValidator<Output extends Input, Input = unknown>(description: string, validate: (input: Input, options: ValidationOptions, path: readonly string[]) => readonly ValidationErrorMessage[]): Validator<Output, Input>;
+export declare function createDeepValidator<Output extends Input, Input = unknown>(description: string, validate: (input: Input, options: ValidationOptions, path: readonly string[]) => readonly ValidationErrorMessage[], jsonSchema?: JsonSchema): Validator<Output, Input>;
 //# sourceMappingURL=Validator.d.ts.map

package/dist/types/ts4.1/validation/ValueSchema.d.ts

@@ -4,6 +4,7 @@ export declare const valueValidators: {
     readonly any: () => Validator<any>;
     /**
      * Creates a validator that asserts that the input is nullish.
+     * JSON Schema has no representation for `undefined`, so only `null` is expressed.
      */
     readonly nullish: () => Validator<null | undefined>;
     /**

package/dist/types/ts4.7/index.d.ts

@@ -1,18 +1,19 @@
 /** Auto-generated from build scripts */
-export * from './validation/validators';
-export * from './validation/typeOfValidators';
-export * from './validation/orValidators';
 export * from './validation/andValidators';
-export * from './validation/ValueSchema';
-export * from './validation/ValidatorWithPartial';
-export * from './validation/Validator';
-export * from './validation/StringSchema';
-export * from './validation/SetSchema';
-export * from './validation/SchemaBase';
-export * from './validation/RecordSchema';
-export * from './validation/PropertyValidator';
-export * from './validation/ObjectSchema';
-export * from './validation/NumberSchema';
-export * from './validation/FunctionSchema';
 export * from './validation/ArraySchema';
+export * from './validation/FunctionSchema';
+export * from './validation/JsonSchema';
+export * from './validation/NumberSchema';
+export * from './validation/ObjectSchema';
+export * from './validation/orValidators';
+export * from './validation/PropertyValidator';
+export * from './validation/RecordSchema';
+export * from './validation/SchemaBase';
+export * from './validation/SetSchema';
+export * from './validation/StringSchema';
+export * from './validation/typeOfValidators';
+export * from './validation/Validator';
+export * from './validation/validators';
+export * from './validation/ValidatorWithPartial';
+export * from './validation/ValueSchema';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/ts4.7/validation/JsonSchema.d.ts

@@ -0,0 +1,63 @@
+import type { Validator } from './Validator';
+/**
+ * The `type` keyword value of a JSON Schema node.
+ */
+export type JsonSchemaType = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+/**
+ * A JSON Schema definition (a draft-07 compatible subset) describing the shape a value must take.
+ *
+ * This is the serializable representation produced by {@link toJsonSchema}, suitable for handing to
+ * an LLM as the shape it must produce. It intentionally mirrors zod-to-json-schema output for the
+ * node types this library supports.
+ */
+export interface JsonSchema {
+    readonly type?: JsonSchemaType | readonly JsonSchemaType[];
+    /**
+     * A human-readable description, attached to a schema node via its `describe` method.
+     */
+    readonly description?: string;
+    readonly properties?: Readonly<Record<string, JsonSchema>>;
+    readonly required?: readonly string[];
+    readonly additionalProperties?: boolean | JsonSchema;
+    readonly items?: JsonSchema | readonly JsonSchema[];
+    readonly additionalItems?: boolean;
+    readonly minItems?: number;
+    readonly maxItems?: number;
+    readonly uniqueItems?: boolean;
+    readonly minLength?: number;
+    readonly maxLength?: number;
+    readonly pattern?: string;
+    readonly minimum?: number;
+    readonly maximum?: number;
+    readonly exclusiveMinimum?: number;
+    readonly exclusiveMaximum?: number;
+    readonly enum?: readonly unknown[];
+    readonly anyOf?: readonly JsonSchema[];
+}
+/**
+ * A source that can produce its own JSON Schema definition. Schema nodes implement this so that
+ * per-node metadata (such as a `describe` description) is honored during serialization.
+ */
+export interface JsonSchemaProvider {
+    toJsonSchema(): JsonSchema;
+}
+/**
+ * Merges JSON Schema fragments into a single definition, later fragments taking precedence.
+ *
+ * This mirrors an intersection (`and`) of constraints: `properties` are combined and `required`
+ * keys are unioned, while all other keywords are overridden by the last fragment that defines them.
+ *
+ * @param fragments The fragments to merge. `undefined` fragments are ignored.
+ */
+export declare function mergeJsonSchema(...fragments: readonly (JsonSchema | undefined)[]): JsonSchema;
+/**
+ * Serializes a validator to a JSON Schema definition.
+ *
+ * Schema nodes ({@link JsonSchemaProvider}s) serialize themselves so that per-node metadata is
+ * honored; other validators contribute their attached JSON Schema fragment, defaulting to the empty
+ * schema (which matches any value) when none is attached.
+ *
+ * @param source The validator or schema node to serialize.
+ */
+export declare function toJsonSchema(source: Validator<any, any>): JsonSchema;
+//# sourceMappingURL=JsonSchema.d.ts.map

package/dist/types/ts4.7/validation/SchemaBase.d.ts

@@ -1,5 +1,6 @@
 import type { ValidationErrorMessage, ValidationOptions, Validator } from './Validator';
 import type { PropertyValidator, PropertyValidatorWithOptions } from './PropertyValidator';
+import type { JsonSchema, JsonSchemaProvider } from './JsonSchema';
 /**
  * A base class for validation state.
  * Provides methods for chaining.
@@ -8,13 +9,14 @@ import type { PropertyValidator, PropertyValidatorWithOptions } from './Property
  */
 export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
     readonly optional: false;
-}> {
+}>, JsonSchemaProvider {
     private readonly currentValidator;
     private readonly previousSchema?;
     private readonly operation?;
     __type: import("@amazon/vinyl-util").Invariant<T>;
     private readonly validator;
     private _options;
+    private _jsonSchemaDescription?;
     get options(): {
         readonly optional: false;
     };
@@ -33,6 +35,26 @@ export declare abstract class SchemaBase<T> implements PropertyValidator<T, {
      */
     constructor(currentValidator: Validator<any, any>, previousSchema: SchemaBase<any>, operation: (validatorA: Validator<any>, validatorB: Validator<any, any>) => Validator<T>);
     get description(): string;
+    /**
+     * The composed JSON Schema fragment for this schema, including any {@link describe} description.
+     * Composes through chaining the same way {@link description} does; serialize a complete
+     * definition with {@link toJsonSchema}.
+     */
+    get jsonSchema(): JsonSchema | undefined;
+    /**
+     * Attaches a human-readable description to this schema, akin to zod's `describe`.
+     * The description is metadata only; it does not affect validation, and surfaces in the output
+     * of {@link toJsonSchema}.
+     *
+     * @param description The description to attach.
+     * @return A clone of this schema carrying the description.
+     */
+    describe(description: string): this;
+    /**
+     * Serializes this schema to a JSON Schema definition, suitable for describing the shape to an
+     * LLM or other consumer. Works similarly to zod-to-json-schema.
+     */
+    toJsonSchema(): JsonSchema;
     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[];

package/dist/types/ts4.7/validation/Validator.d.ts

@@ -1,4 +1,5 @@
 import { type Invariant } from '@amazon/vinyl-util';
+import type { JsonSchema } from './JsonSchema';
 /**
  * Represents a validation failure.
  */
@@ -27,6 +28,15 @@ export interface Validator<Output extends Input, in Input = unknown> {
      * A short description of the validator.
      */
     readonly description: string;
+    /**
+     * The JSON Schema fragment this validator contributes, if any.
+     *
+     * Fragments compose the same way the {@link description} does: chaining validators with `and`
+     * merges their fragments, and `or` unions them into an `anyOf`. Serialize a full schema with
+     * {@link toJsonSchema}. A validator with no meaningful shape (for example a bare type check)
+     * may omit this.
+     */
+    readonly jsonSchema?: JsonSchema | undefined;
     /**
      * Returns true if the input is valid according to this validator.
      *
@@ -74,8 +84,9 @@ export declare function createValidationExpectationMessage<Input>(expectationMes
  * @param isValid Returns true if the given input is valid.
  * @param inputStringify Stringifies the input for use as the actual `{actual}` token in the validation
  * expectation template. Default is `stringifyForPrint` with a 500 character max length.
+ * @param jsonSchema The JSON Schema fragment this validator contributes, if any.
  */
-export declare function createValidator<Output extends Input, Input = unknown>(expectationMessage: string, isValid: (input: Input) => boolean, inputStringify?: (input: Input) => string): Validator<Output, Input>;
+export declare function createValidator<Output extends Input, Input = unknown>(expectationMessage: string, isValid: (input: Input) => boolean, inputStringify?: (input: Input) => string, jsonSchema?: JsonSchema): Validator<Output, Input>;
 /**
  * Creates a new deep validator.
  *
@@ -83,6 +94,7 @@ export declare function createValidator<Output extends Input, Input = unknown>(e
  *
  * @param description Describes the validator.
  * @param validate Returns an array of validation failures.
+ * @param jsonSchema The JSON Schema fragment this validator contributes, if any.
  */
-export declare function createDeepValidator<Output extends Input, Input = unknown>(description: string, validate: (input: Input, options: ValidationOptions, path: readonly string[]) => readonly ValidationErrorMessage[]): Validator<Output, Input>;
+export declare function createDeepValidator<Output extends Input, Input = unknown>(description: string, validate: (input: Input, options: ValidationOptions, path: readonly string[]) => readonly ValidationErrorMessage[], jsonSchema?: JsonSchema): Validator<Output, Input>;
 //# sourceMappingURL=Validator.d.ts.map

package/dist/types/ts4.7/validation/ValueSchema.d.ts

@@ -4,6 +4,7 @@ export declare const valueValidators: {
     readonly any: () => Validator<any>;
     /**
      * Creates a validator that asserts that the input is nullish.
+     * JSON Schema has no representation for `undefined`, so only `null` is expressed.
      */
     readonly nullish: () => Validator<null | undefined>;
     /**