validator-fns 2.0.5 → 2.2.0

package/dist/index.d.ts

@@ -1,32 +1,33 @@
+//#region src/shared.d.ts
 type ValidResult<T> = {
-    /**
-     * True if the original value is valid according to all validation tests
-     * @deprecated Use `state` instead.
-     */
-    isValid: true;
-    /** This is preferred to use over `isValid` as it works better for type guards. */
-    state: 'valid';
-    /** The parsed value. Note that may be different than the original value. */
-    value: T | null | undefined;
-    /** Field name if provided. Automatically provided if using object validation. */
-    field?: string | undefined;
+  /**
+   * True if the original value is valid according to all validation tests
+   * @deprecated Use `state` instead.
+   */
+  isValid: true;
+  /** This is preferred to use over `isValid` as it works better for type guards. */
+  state: 'valid';
+  /** The parsed value. Note that may be different than the original value. */
+  value: T | null | undefined;
+  /** Field name if provided. Automatically provided if using object validation. */
+  field?: string | undefined;
 };
 type InvalidResult<E> = {
-    /**
-     * True if the original value is valid according to all validation tests.
-     * @deprecated Use `state` instead.
-     */
-    isValid: false;
-    /** This is preferred to use over `isValid` as it works better for type guards. */
-    state: 'invalid';
-    /** The parsed value. Note that may be different than the original value. */
-    value: unknown;
-    /** Error message if `state` is invalid. */
-    message: string;
-    /** Field name if provided. Automatically provided if using object validation. */
-    field?: string | undefined;
-    /** Extra error details */
-    errors?: E | undefined;
+  /**
+   * True if the original value is valid according to all validation tests.
+   * @deprecated Use `state` instead.
+   */
+  isValid: false;
+  /** This is preferred to use over `isValid` as it works better for type guards. */
+  state: 'invalid';
+  /** The parsed value. Note that may be different than the original value. */
+  value: unknown;
+  /** Error message if `state` is invalid. */
+  message: string;
+  /** Field name if provided. Automatically provided if using object validation. */
+  field?: string | undefined;
+  /** Extra error details */
+  errors?: E | undefined;
 };
 /**
  * The result of a validation.
@@ -57,9 +58,7 @@ type ExtractValue<T extends ValidatorTest> = T extends ValidatorTest<infer V> ?
  * @typeParam T any object type
  * @category Types
  */
-type DeepPartial<T> = {
-    [P in keyof T]?: DeepPartial<T[P]>;
-};
+type DeepPartial<T> = { [P in keyof T]?: DeepPartial<T[P]>; };
 /**
  * Validation factory function.
  * @typeParam C The configuration type
@@ -72,14 +71,14 @@ type ValidatorFactory<C, T, E> = (config?: Partial<C> | ValidatorTest, ...tests:
  * @category Types
  */
 interface ConfigBase<T> {
-    /** Parser to convert value into the designated type. */
-    parser: (value: unknown) => T | null | undefined;
-    /** Provide a fallback value in case the original value is undefined. */
-    default?: T;
+  /** Parser to convert value into the designated type. */
+  parser: (value: unknown) => T | null | undefined;
+  /** Provide a fallback value in case the original value is undefined. */
+  default?: T;
 }
 interface ValidatorMessageParameters<T> {
-    value: T | null | undefined;
-    field: string | undefined;
+  value: T | null | undefined;
+  field: string | undefined;
 }
 /**
  * Validation message. May be a plain string or a function that accepts arguments.
@@ -91,20 +90,20 @@ type ValidatorMessage<T, P extends ValidatorMessageParameters<T> = ValidatorMess
  * Simple check for objects.
  * @param value Value to test
  */
-declare function isObject(value: unknown): boolean;
+export declare function isObject(value: unknown): boolean;
 /**
  * Safe hasOwnProperty check
  * @param object Object to check
  * @param property Property to look for
  */
-declare function hasOwnProperty(object: unknown, property: string | number | symbol): boolean;
+export declare function hasOwnProperty(object: unknown, property: string | number | symbol): boolean;
 /**
  * Formats a message using a squiggly bracket `{}` template.
  * @param template Message template as string or function
  * @param parameters Params to inject into template
  * @category Helpers
  */
-declare function formatMessage<T, P extends ValidatorMessageParameters<T>>(template: ValidatorMessage<T, P>, parameters: P): string;
+export declare function formatMessage<T, P extends ValidatorMessageParameters<T>>(template: ValidatorMessage<T, P>, parameters: P): string;
 /**
  * Creates a valid result
  * @param result Result fields
@@ -112,9 +111,9 @@ declare function formatMessage<T, P extends ValidatorMessageParameters<T>>(templ
  * @param result.field Field name
  * @category Helpers
  */
-declare function valid<T, E = never>({ value, field, }: {
-    value: T | null | undefined;
-    field: string | undefined;
+export declare function valid<T, E = never>(result: {
+  value: T | null | undefined;
+  field: string | undefined;
 }): Promise<ValidatorResult<T, E>>;
 /**
  * Creates an invalid result.
@@ -126,88 +125,15 @@ declare function valid<T, E = never>({ value, field, }: {
  * @param result.extras Extra message params
  * @category Helpers
  */
-declare function invalid<T, E, P extends ValidatorMessageParameters<T> = ValidatorMessageParameters<T>>({ errors, field, message, value, extras, }: {
-    message: ValidatorMessage<T, P>;
-    value: unknown;
-    field: string | undefined;
-    errors?: E | undefined;
-    extras?: Omit<P, 'field' | 'value'> | undefined;
+export declare function invalid<T, E, P extends ValidatorMessageParameters<T> = ValidatorMessageParameters<T>>(result: {
+  message: ValidatorMessage<T, P>;
+  value: unknown;
+  field: string | undefined;
+  errors?: E | undefined;
+  extras?: Omit<P, 'field' | 'value'> | undefined;
 }): Promise<ValidatorResult<T, E>>;
-/**
- * Creates a type validator.
- * @typeParam T The basic type for the final value to be validated.
- * @typeParam C The configuration type.
- * @param defaultParser Parser to convert value into type.
- * @param applyConfig Function that applies configuration to value.
- * @category Helpers
- */
-declare function createTypeValidatorTest<T, C extends ConfigBase<T>>(defaultConfig: C, applyConfig: (value: unknown, config: C) => T | null | undefined): ValidatorFactory<C, T, string>;
-/**
- * Captures basic validator test pattern
- * @param test Test function
- * @param message Error message
- * @param getExtras Optional extra fields for error message
- */
-declare function createValidatorTest<T = any, E = any, P extends ValidatorMessageParameters<T> = ValidatorMessageParameters<T>>(test: (value: unknown, field?: string) => boolean, message: ValidatorMessage<T, P>, getExtras?: (value: T | null | undefined) => Omit<P, 'value' | 'field'>): ValidatorTest<T, E>;
-/**
- * Ensures a value is not undefined, null, empty string, NaN, nor invalid date.
- * @param message Error message
- * @param nullable Allow null values
- * @category Validation Tests
- */
-declare function required<T, P extends ValidatorMessageParameters<T>>(message: ValidatorMessage<T, P>, nullable?: boolean): ValidatorTest<T>;
-type SharedValueType = string | number | unknown[];
-interface MaxValidatorMessageParameters extends ValidatorMessageParameters<SharedValueType> {
-    max: number;
-    amount: number | null | undefined;
-    limit: number;
-    exclusive?: boolean | undefined;
-}
-/**
- * Ensures a string, number, or array value is at most a certain amount.
- * @param limit Size or value limit
- * @param message Error message
- * @param exclusive Use exclusive comparison instead of inclusive
- * @category Validation Tests
- */
-declare function max(limit: number, message: ValidatorMessage<SharedValueType, MaxValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<SharedValueType>;
-interface MinValidatorMessageParameters extends ValidatorMessageParameters<SharedValueType> {
-    min: number;
-    limit: number;
-    amount: number | null | undefined;
-    exclusive?: boolean | undefined;
-}
-/**
- * Ensures a string, number, or array value is at most a certain amount.
- * @param limit Size or value limit
- * @param message Error message
- * @param exclusive Use exclusive comparison instead of inclusive
- * @category Validation Tests
- */
-declare function min(limit: number, message: ValidatorMessage<SharedValueType, MinValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<SharedValueType>;
-interface ExactValidatorMessageParameters extends ValidatorMessageParameters<SharedValueType> {
-    limit: number;
-    amount: number | null | undefined;
-    exact: number;
-}
-/**
- * Ensures a string, number, or array value is exactly a certain amount.
- * @param limit Size or value limit
- * @param message Error message
- * @category Validation Tests
- */
-declare function exact(limit: number, message: ValidatorMessage<SharedValueType, ExactValidatorMessageParameters>): ValidatorTest<SharedValueType>;
-interface OneOfValidatorMessageParameters<T> extends ValidatorMessageParameters<T> {
-    values: readonly T[];
-}
-/**
- * Ensures a value is one in a predefined list.
- * @param values List of allowed values.
- * @param message Error message
- * @category Validation Tests
- */
-declare function oneOf<T extends string | number | boolean | Date>(values: readonly T[], message: ValidatorMessage<T, OneOfValidatorMessageParameters<T>>): ValidatorTest<T>;
-
+//#endregion
+//#region src/arrays.d.ts
 /**
  * Invalid validation result for an item in the array
  * @category Types
@@ -223,34 +149,35 @@ type ArrayConfig = ConfigBase<unknown[]>;
  * @param value Value to parse
  * @category Parsers
  */
-declare function parseArray(value: unknown): unknown[] | null | undefined;
+export declare function parseArray(value: unknown): unknown[] | null | undefined;
 /**
  * Applies a configuration to the array value.
  * @param value Value to modify
  * @param config Configuration to apply
  * @category Helpers
  */
-declare function applyArrayConfig<T>(config: ArrayConfig, value: unknown): T[] | null | undefined;
+export declare function applyArrayConfig<T>(config: ArrayConfig, value: unknown): T[] | null | undefined;
 /**
  * Validates an array. The first passed validator is used to validate individual
  * items. The remaining validators target the array itself.
  * @category Type Validators
  */
-declare function array<T, E>(config?: Partial<ArrayConfig> | ValidatorTest<T, E>, ...tests: ValidatorTest[]): ValidatorTest<T[], string | ArrayItemValidatorResult<E>[]>;
-
+export declare function array<T, E>(config?: Partial<ArrayConfig> | ValidatorTest<T, E>, ...tests: ValidatorTest[]): ValidatorTest<T[], string | ArrayItemValidatorResult<E>[]>;
+//#endregion
+//#region src/booleans.d.ts
 /**
  * Parses a value into a boolean.
  * @param value Value to parse
  * @category Parsers
  */
-declare function parseBoolean(value: unknown): boolean | null | undefined;
+export declare function parseBoolean(value: unknown): boolean | null | undefined;
 /**
  * Applies a configuration to the boolean value.
  * @param value Value to modify
  * @param config Configuration to apply
  * @category Helpers
  */
-declare function applyBooleanConfig(value: unknown, config: BooleanConfig): boolean | null | undefined;
+export declare function applyBooleanConfig(value: unknown, config: BooleanConfig): boolean | null | undefined;
 /**
  * Configuration for boolean validation.
  * @category Types
@@ -260,28 +187,21 @@ type BooleanConfig = ConfigBase<boolean>;
  * Validates a boolean value.
  * @category Type Validators
  */
-declare const boolean: ValidatorFactory<BooleanConfig, boolean, string>;
-
-/** Badly formatted date for internal use. */
-declare const invalidDate: Date;
-/**
- * Parses a value into a date.
- * @param value Value to parse
- * @category Parsers
- */
-declare function parseDate(value: unknown): Date | null | undefined;
+export declare const boolean: ValidatorFactory<BooleanConfig, boolean, string>;
+//#endregion
+//#region src/dates.d.ts
 /**
  * Applies a configuration to the date value.
  * @param value Value to modify
  * @param config Configuration to apply
  * @category Helpers
  */
-declare function applyDateConfig(value: unknown, config: DateConfig): Date | null | undefined;
+export declare function applyDateConfig(value: unknown, config: DateConfig): Date | null | undefined;
 type SharedDateValueType = Date | string | number;
 interface MinDateValidatorMessageParameters extends ValidatorMessageParameters<Date> {
-    min: Date | null | undefined;
-    limit: Date | null | undefined;
-    exclusive?: boolean | undefined;
+  min: Date | null | undefined;
+  limit: Date | null | undefined;
+  exclusive?: boolean | undefined;
 }
 /**
  * Ensures a date value is on or after a date.
@@ -290,11 +210,11 @@ interface MinDateValidatorMessageParameters extends ValidatorMessageParameters<D
  * @param exclusive Makes comparison exclusive instead of inclusive
  * @category Validation Tests
  */
-declare function minDate(limit: SharedDateValueType, message: ValidatorMessage<Date, MinDateValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<Date, null>;
+export declare function minDate(limit: SharedDateValueType, message: ValidatorMessage<Date, MinDateValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<Date, null>;
 interface MaxDateValidatorMessageParameters extends ValidatorMessageParameters<Date> {
-    max: Date | null | undefined;
-    limit: Date | null | undefined;
-    exclusive?: boolean | undefined;
+  max: Date | null | undefined;
+  limit: Date | null | undefined;
+  exclusive?: boolean | undefined;
 }
 /**
  * Ensures a date value is on or before a date.
@@ -303,7 +223,7 @@ interface MaxDateValidatorMessageParameters extends ValidatorMessageParameters<D
  * @param exclusive Makes comparison exclusive instead of inclusive
  * @category Validation Tests
  */
-declare function maxDate(limit: SharedDateValueType, message: ValidatorMessage<Date, MaxDateValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<Date>;
+export declare function maxDate(limit: SharedDateValueType, message: ValidatorMessage<Date, MaxDateValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<Date>;
 /**
  * Configuration for date validation.
  * @category Types
@@ -313,75 +233,300 @@ type DateConfig = ConfigBase<Date>;
  * Validates a date value.
  * @category Type Validators
  */
-declare const date: ValidatorFactory<DateConfig, Date, string>;
-
+export declare const date: ValidatorFactory<DateConfig, Date, string>;
+//#endregion
+//#region src/numbers.d.ts
 /**
  * Parses a value into a number.
  * @param value Value to parse
  * @category Parsers
  */
-declare function parseNumber(value: unknown): number | null | undefined;
+export declare function parseNumber(value: unknown): number | null | undefined;
 /**
  * Applies a configuration to the number value.
  * @param value Value to modify
  * @param config Configuration to apply
  * @category Helpers
  */
-declare function applyNumberConfig(value: unknown, config: NumberConfig): number | null | undefined;
+export declare function applyNumberConfig(value: unknown, config: NumberConfig): number | null | undefined;
 /**
  * Ensures a number value is an integer.
  * @param message Error message
  * @category Validation Tests
  */
-declare function integer(message: ValidatorMessage<number>): ValidatorTest<number>;
+export declare function integer(message: ValidatorMessage<number>): ValidatorTest<number>;
 /**
  * Configuration for number validation.
  * @category Types
  */
 interface NumberConfig extends ConfigBase<number> {
-    /** Apply rounding mechanism before validation. */
-    round?: 'nearest' | 'floor' | 'ceil';
+  /** Apply rounding mechanism before validation. */
+  round?: 'nearest' | 'floor' | 'ceil';
 }
 /**
  * Validates a number value.
  * @category Type Validators
  */
-declare const number: ValidatorFactory<NumberConfig, number, string>;
-
+export declare const number: ValidatorFactory<NumberConfig, number, string>;
+//#endregion
+//#region src/parse-date.d.ts
+/** Badly formatted date for internal use. */
+export declare const invalidDate: Date;
+/**
+ * Parses a value into a date.
+ * @param value Value to parse
+ * @category Parsers
+ */
+export declare function parseDate(value: unknown): Date | null | undefined;
+//#endregion
+//#region src/check.d.ts
+/**
+ * An object-level test for `object()`. It fails when `test` returns false for
+ * the parsed object. The message goes to the error at `path`, a property name
+ * or a list of names into nested objects, or to the object's own message
+ * without a path. The message gets the parsed object as `value` and the
+ * object's `field`.
+ * @category Validation Tests
+ */
+export declare function check<T, E = never>(test: (value: T) => boolean, message: ValidatorMessage<T>): ValidatorTest<T, E>;
+export declare function check<T, E = never>(path: string | readonly string[], test: (value: T) => boolean, message: ValidatorMessage<T>): ValidatorTest<T, E>;
+//#endregion
+//#region src/objects.d.ts
 type ObjectParameter = Record<string, ValidatorTest<unknown, unknown>>;
+/** @internal */
+type ObjectValue<P extends ObjectParameter> = { [K in keyof P]?: ExtractValue<P[K]>; };
+/** @internal */
+type ObjectErrors<P extends ObjectParameter> = { [K in keyof P]?: ExtractError<P[K]>; };
 /**
- * Validates an object.
+ * Validates an object. The remaining `tests` run on the parsed object, in
+ * order, once every property is valid, and the first failure is the result.
  * @category Type Validators
  */
-declare function object<P extends ObjectParameter, V extends {
-    [K in keyof P]?: ExtractValue<P[K]>;
-}, E extends {
-    [K in keyof P]?: ExtractError<P[K]>;
-}>(properties: P): ValidatorTest<V, E>;
-
+export declare function object<P extends ObjectParameter, V extends ObjectValue<P>, E extends ObjectErrors<P>>(properties: P, ...tests: ValidatorTest<ObjectValue<P>, ObjectErrors<P>>[]): ValidatorTest<V, E>;
+//#endregion
+//#region src/standard-schema.d.ts
+/**
+ * @license
+ * The StandardTypedV1 and StandardSchemaV1 types below are copied from
+ * @standard-schema/spec 1.1.0 (https://standardschema.dev), which invites
+ * libraries to copy them instead of depending on the package. Two changes:
+ * `validate`'s optional `options` parameter drops its redundant `| undefined`,
+ * which lint rejects, with the same type; and only StandardSchemaV1 is
+ * exported, since nothing else imports StandardTypedV1. They are under its
+ * license:
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 Colin McDonnell
+ *
+ * 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.
+ */
+/** The Standard Typed interface. This is a base type extended by other specs. */
+interface StandardTypedV1<Input = unknown, Output = Input> {
+  /** The Standard properties. */
+  readonly '~standard': StandardTypedV1.Props<Input, Output>;
+}
+declare namespace StandardTypedV1 {
+  /** The Standard Typed properties interface. */
+  interface Props<Input = unknown, Output = Input> {
+    /** The version number of the standard. */
+    readonly version: 1;
+    /** The vendor name of the schema library. */
+    readonly vendor: string;
+    /** Inferred types associated with the schema. */
+    readonly types?: Types<Input, Output> | undefined;
+  }
+  /** The Standard Typed types interface. */
+  interface Types<Input = unknown, Output = Input> {
+    /** The input type of the schema. */
+    readonly input: Input;
+    /** The output type of the schema. */
+    readonly output: Output;
+  }
+  /** Infers the input type of a Standard Typed. */
+  type InferInput<Schema extends StandardTypedV1> = NonNullable<Schema['~standard']['types']>['input'];
+  /** Infers the output type of a Standard Typed. */
+  type InferOutput<Schema extends StandardTypedV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+  /** The Standard Schema properties. */
+  readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+  /** The Standard Schema properties interface. */
+  interface Props<Input = unknown, Output = Input> extends StandardTypedV1.Props<Input, Output> {
+    /** Validates unknown input values. */
+    readonly validate: (value: unknown, options?: StandardSchemaV1.Options) => Result<Output> | Promise<Result<Output>>;
+  }
+  /** The result interface of the validate function. */
+  type Result<Output> = SuccessResult<Output> | FailureResult;
+  /** The result interface if validation succeeds. */
+  interface SuccessResult<Output> {
+    /** The typed output value. */
+    readonly value: Output;
+    /** A falsy value for `issues` indicates success. */
+    readonly issues?: undefined;
+  }
+  interface Options {
+    /** Explicit support for additional vendor-specific parameters, if needed. */
+    readonly libraryOptions?: Record<string, unknown> | undefined;
+  }
+  /** The result interface if validation fails. */
+  interface FailureResult {
+    /** The issues of failed validation. */
+    readonly issues: ReadonlyArray<Issue>;
+  }
+  /** The issue interface of the failure output. */
+  interface Issue {
+    /** The error message of the issue. */
+    readonly message: string;
+    /** The path of the issue, if any. */
+    readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+  }
+  /** The path segment interface of the issue. */
+  interface PathSegment {
+    /** The key representing a path segment. */
+    readonly key: PropertyKey;
+  }
+  /** The Standard types interface. */
+  interface Types<Input = unknown, Output = Input> extends StandardTypedV1.Types<Input, Output> {}
+  /** Infers the input type of a Standard. */
+  type InferInput<Schema extends StandardTypedV1> = StandardTypedV1.InferInput<Schema>;
+  /** Infers the output type of a Standard. */
+  type InferOutput<Schema extends StandardTypedV1> = StandardTypedV1.InferOutput<Schema>;
+}
+//#endregion
+//#region src/standard.d.ts
+/**
+ * Adds the Standard Schema interface (https://standardschema.dev) to a
+ * validator, so libraries that accept any Standard Schema can use it. Returns a
+ * new validator; the one passed in is unchanged. `validate` always returns a
+ * promise, since every validator here is async.
+ * @category Helpers
+ */
+export declare function standard<T, E>(validator: ValidatorTest<T, E>): ValidatorTest<T, E> & StandardSchemaV1<unknown, T | null | undefined>;
+//#endregion
+//#region src/common.d.ts
+/**
+ * Ensures a value is not undefined, null, empty string, NaN, nor invalid date.
+ * @param message Error message
+ * @param nullable Allow null values
+ * @category Validation Tests
+ */
+export declare function required<T, P extends ValidatorMessageParameters<T>>(message: ValidatorMessage<T, P>, nullable?: boolean): ValidatorTest<T>;
+interface OneOfValidatorMessageParameters<T> extends ValidatorMessageParameters<T> {
+  values: readonly T[];
+}
+/**
+ * Ensures a value is one in a predefined list.
+ * @param values List of allowed values.
+ * @param message Error message
+ * @category Validation Tests
+ */
+export declare function oneOf<T extends string | number | boolean | Date>(values: readonly T[], message: ValidatorMessage<T, OneOfValidatorMessageParameters<T>>): ValidatorTest<T>;
+//#endregion
+//#region src/factories.d.ts
+/**
+ * Creates a type validator.
+ * @typeParam T The basic type for the final value to be validated.
+ * @typeParam C The configuration type.
+ * @param defaultParser Parser to convert value into type.
+ * @param applyConfig Function that applies configuration to value.
+ * @category Helpers
+ */
+export declare function createTypeValidatorTest<T, C extends ConfigBase<T>>(defaultConfig: C, applyConfig: (value: unknown, config: C) => T | null | undefined): ValidatorFactory<C, T, string>;
+/**
+ * Captures basic validator test pattern
+ * @param test Test function
+ * @param message Error message
+ * @param getExtras Optional extra fields for error message
+ */
+export declare function createValidatorTest<T = any, E = any, P extends ValidatorMessageParameters<T> = ValidatorMessageParameters<T>>(test: (value: unknown, field?: string) => boolean, message: ValidatorMessage<T, P>, getExtras?: (value: T | null | undefined) => Omit<P, 'value' | 'field'>): ValidatorTest<T, E>;
+//#endregion
+//#region src/limits.d.ts
+type SharedValueType = string | number | unknown[];
+interface MaxValidatorMessageParameters extends ValidatorMessageParameters<SharedValueType> {
+  max: number;
+  amount: number | null | undefined;
+  limit: number;
+  exclusive?: boolean | undefined;
+}
+/**
+ * Ensures a string, number, or array value is at most a certain amount.
+ * @param limit Size or value limit
+ * @param message Error message
+ * @param exclusive Use exclusive comparison instead of inclusive
+ * @category Validation Tests
+ */
+export declare function max(limit: number, message: ValidatorMessage<SharedValueType, MaxValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<SharedValueType>;
+interface MinValidatorMessageParameters extends ValidatorMessageParameters<SharedValueType> {
+  min: number;
+  limit: number;
+  amount: number | null | undefined;
+  exclusive?: boolean | undefined;
+}
+/**
+ * Ensures a string, number, or array value is at most a certain amount.
+ * @param limit Size or value limit
+ * @param message Error message
+ * @param exclusive Use exclusive comparison instead of inclusive
+ * @category Validation Tests
+ */
+export declare function min(limit: number, message: ValidatorMessage<SharedValueType, MinValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<SharedValueType>;
+interface ExactValidatorMessageParameters extends ValidatorMessageParameters<SharedValueType> {
+  limit: number;
+  amount: number | null | undefined;
+  exact: number;
+}
+/**
+ * Ensures a string, number, or array value is exactly a certain amount.
+ * @param limit Size or value limit
+ * @param message Error message
+ * @category Validation Tests
+ */
+export declare function exact(limit: number, message: ValidatorMessage<SharedValueType, ExactValidatorMessageParameters>): ValidatorTest<SharedValueType>;
+//#endregion
+//#region src/strings.d.ts
 /**
  * Configuration for string validation.
  * @category Types
  */
 interface StringConfig extends ConfigBase<string> {
-    /** Apply trim to string before validation. */
-    trim?: boolean;
+  /** Apply trim to string before validation. */
+  trim?: boolean;
 }
 /**
  * Parses a value into a string.
  * @param value Value to parse
  * @category Parsers
  */
-declare function parseString(value: unknown): string | null | undefined;
+export declare function parseString(value: unknown): string | null | undefined;
 /**
  * Applies a configuration to the string value.
  * @param value Value to modify
  * @param config Configuration to apply
  * @category Helpers
  */
-declare function applyStringConfig(value: unknown, config: StringConfig): string | null | undefined;
+export declare function applyStringConfig(value: unknown, config: StringConfig): string | null | undefined;
 interface MatchesValidatorMessageParameters extends ValidatorMessageParameters<string> {
-    pattern: RegExp;
+  pattern: RegExp;
 }
 /**
  * Ensures a string value matches a pattern
@@ -389,13 +534,20 @@ interface MatchesValidatorMessageParameters extends ValidatorMessageParameters<s
  * @param message Error message
  * @category Validation Tests
  */
-declare function matches(pattern: RegExp, message: ValidatorMessage<string, MatchesValidatorMessageParameters>): ValidatorTest<string>;
+export declare function matches(pattern: RegExp, message: ValidatorMessage<string, MatchesValidatorMessageParameters>): ValidatorTest<string>;
 /**
  * Ensures a string value matches an email pattern
  * @param message Error message
  * @category Validation Tests
  */
-declare function email(message: ValidatorMessage<string>): ValidatorTest<string>;
+export declare function email(message: ValidatorMessage<string>): ValidatorTest<string>;
+/**
+ * Ensures a string value is an RFC 9562 UUID, any version from 1 to 8, or the
+ * nil or max UUID. Case-insensitive, without braces or a `urn:uuid:` prefix.
+ * @param message Error message
+ * @category Validation Tests
+ */
+export declare function uuid(message: ValidatorMessage<string>): ValidatorTest<string>;
 /**
  * Ensures a string value is a valid URL
  * @param message Error message
@@ -403,11 +555,11 @@ declare function email(message: ValidatorMessage<string>): ValidatorTest<string>
  * and `data:` URLs are valid; use `['http:', 'https:']` for values rendered as links.
  * @category Validation Tests
  */
-declare function url(message: ValidatorMessage<string>, protocols?: string[]): ValidatorTest<string>;
+export declare function url(message: ValidatorMessage<string>, protocols?: string[]): ValidatorTest<string>;
 /**
  * Validates a string value.
  * @category Type Validators
  */
-declare const string: ValidatorFactory<StringConfig, string, string>;
-
-export { type ArrayConfig, type ArrayItemValidatorResult, type BooleanConfig, type ConfigBase, type DateConfig, type DeepPartial, type ExactValidatorMessageParameters, type ExtractError, type ExtractValue, type InvalidResult, type MatchesValidatorMessageParameters, type MaxDateValidatorMessageParameters, type MaxValidatorMessageParameters, type MinDateValidatorMessageParameters, type MinValidatorMessageParameters, type NumberConfig, type ObjectParameter as ObjectParam, type OneOfValidatorMessageParameters, type SharedDateValueType, type SharedValueType, type StringConfig, type ValidResult, type ValidatorFactory, type ValidatorMessage, type ValidatorMessageParameters, type ValidatorResult, type ValidatorTest, applyArrayConfig, applyBooleanConfig, applyDateConfig, applyNumberConfig, applyStringConfig, array, boolean, createTypeValidatorTest, createValidatorTest, date, email, exact, formatMessage, hasOwnProperty, integer, invalid, invalidDate, isObject, matches, max, maxDate, min, minDate, number, object, oneOf, parseArray, parseBoolean, parseDate, parseNumber, parseString, required, string, url, valid };
+export declare const string: ValidatorFactory<StringConfig, string, string>;
+//#endregion
+export type { ArrayConfig, ArrayItemValidatorResult, BooleanConfig, ConfigBase, DateConfig, DeepPartial, ExactValidatorMessageParameters, ExtractError, ExtractValue, InvalidResult, MatchesValidatorMessageParameters, MaxDateValidatorMessageParameters, MaxValidatorMessageParameters, MinDateValidatorMessageParameters, MinValidatorMessageParameters, NumberConfig, ObjectParameter as ObjectParam, OneOfValidatorMessageParameters, SharedDateValueType, SharedValueType, StringConfig, ValidResult, ValidatorFactory, ValidatorMessage, ValidatorMessageParameters, ValidatorResult, ValidatorTest };