validator-fns 2.0.5 → 3.0.0-next.0

package/dist/index.d.ts

@@ -1,51 +1,52 @@
+//#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.
  * @typeParam T The value type
  * @category Types
  */
-type ValidatorResult<T = any, E = any> = ValidResult<T> | InvalidResult<E>;
+type ValidatorResult<T = unknown, E = unknown> = ValidResult<T> | InvalidResult<E>;
 /**
  * Validation test function.
  * @typeParam T The value type
  * @category Types
  */
-type ValidatorTest<T = any, E = any> = (value?: unknown, field?: string) => Promise<ValidatorResult<T, E>>;
+type ValidatorTest<T = unknown, E = unknown> = (value?: unknown, field?: string) => Promise<ValidatorResult<T, E>>;
 /**
  * Extracts the generic error type from a ValidatorTest.
  * @typeParam T a ValidatorTest
  * @category Types
  */
-type ExtractError<T extends ValidatorTest> = T extends ValidatorTest<any, infer E> ? E : unknown;
+type ExtractError<T extends ValidatorTest> = T extends ValidatorTest<unknown, infer E> ? E : unknown;
 /**
  * Extracts the generic value type from a ValidatorTest.
  * @typeParam T a ValidatorTest
@@ -57,29 +58,27 @@ 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
  * @category Types
  */
-type ValidatorFactory<C, T, E> = (config?: Partial<C> | ValidatorTest, ...tests: ValidatorTest[]) => ValidatorTest<T, E>;
+type ValidatorFactory<C, T, E> = (config?: Partial<C> | ValidatorTest<unknown, E>, ...tests: ValidatorTest<unknown, E>[]) => ValidatorTest<T, E>;
 /**
  * Base configuration type.
  * @typeParam T The target type.
  * @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>({ value, field }: {
+  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 = never, 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;
 }): 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, never>;
 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, never>;
 /**
  * Configuration for date validation.
  * @category Types
@@ -313,75 +233,164 @@ 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, never>;
 /**
  * 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>;
-
-type ObjectParameter = Record<string, ValidatorTest<unknown, unknown>>;
+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/objects.d.ts
+type ObjectParameter = Record<string, ValidatorTest>;
 /**
  * Validates an object.
  * @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 { [K in keyof P]?: ExtractValue<P[K]>; }, E extends { [K in keyof P]?: ExtractError<P[K]>; }>(properties: P): ValidatorTest<V, E>;
+//#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, never>;
+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, never>;
+//#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 = unknown, E = never, 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, never>;
+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, never>;
+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, never>;
+//#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 +398,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, never>;
 /**
  * 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, never>;
+/**
+ * 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, never>;
 /**
  * Ensures a string value is a valid URL
  * @param message Error message
@@ -403,11 +419,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, never>;
 /**
  * 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 };

package/dist/index.js

@@ -1,2 +1,2 @@
-function T(e){return Object.prototype.toString.call(e)==="[object Object]"}function x(e,r){return Object.prototype.hasOwnProperty.call(e,r)}var I=/{(\w+)}/g;function P(e,r){return typeof e=="string"?e.replaceAll(I,(t,a)=>String(r[a])):e(r)}async function m({value:e,field:r}){return{isValid:!0,state:"valid",value:e,field:r}}async function p({errors:e,field:r,message:t,value:a,extras:n}){return{isValid:!1,state:"invalid",message:P(t,{...n,value:a,field:r}),value:a,field:r,errors:e}}function g(e,r){return(t,...a)=>{let n=e,o=a;return t!==void 0&&(typeof t=="function"?o=[t,...a]:n={...e,...t}),async(i,s)=>{try{let d=r(i,n);for(let f of o){let l=await f(d,s);if(l.state==="invalid")return l}return await m({value:d,field:s})}catch(d){return p({message:d instanceof Error?d.message:String(d),value:i,field:s})}}}}function u(e,r,t){return async(a,n)=>e(a,n)?m({value:a,field:n}):p({message:r,value:a,field:n,extras:t?t(a):void 0})}function R(e,r){return u(t=>r&&t===null||t!=null&&!(typeof t=="string"&&t==="")&&!(typeof t=="number"&&Number.isNaN(t))&&!(t instanceof Date&&Number.isNaN(t.valueOf())),e)}function c(e){return typeof e=="string"||Array.isArray(e)?e.length:e}function B(e,r,t){return u(a=>{let n=c(a);return n==null||a===""||(t?n<e:n<=e)},r,a=>({max:e,limit:e,amount:c(a),exclusive:t}))}function j(e,r,t){return u(a=>{let n=c(a);return n==null||a===""||(t?n>e:n>=e)},r,a=>({min:e,limit:e,amount:c(a),exclusive:t}))}function z(e,r){return u(t=>{let a=c(t);return a==null||t===""||a===e},r,t=>({amount:c(t),limit:e,exact:e}))}function F(e,r){return u(t=>t==null||e.includes(t)||t instanceof Date&&e.some(a=>a.valueOf()===t.valueOf()),r,()=>({values:e}))}function M(e){if(Array.isArray(e)||e==null)return e;let r=e;return r[Symbol.iterator]?[...r]:[]}function w(e,r){let t=e.parser(r);return e.default!==void 0&&(t==null||t.length===0)&&(t=e.default),t}async function Z(e,r,t){for(let a of e){let n=await a(r,t);if(n.state==="invalid")return n}}async function $(e,r,t){let a=!0,n=[];if(!r||!e)return{isValid:a,errors:n};for(let[o,i]of r.entries()){let s=await e(i,t?`${t}[${o}]`:`[${o}]`);s.state==="invalid"?(a=!1,n.push(s.message||s.errors)):n.push(null)}return{isValid:a,errors:n}}function K(e,...r){let t=r,a={parser:M};return e!==void 0&&(typeof e=="function"?t=[e,...r]:a={...a,...e}),async(n,o)=>{let i=w(a,n),[s,...d]=t,f=await Z(d,i,o),l=await $(s,i,o);return!f&&l.isValid?m({value:i,field:o}):p({message:f?f.message:"",value:n,field:o,errors:l.errors})}}function D(e){return e==null||typeof e=="boolean"?e:!!e}function E(e,r){let t=r.parser(e);return r.default!==void 0&&t==null&&(t=r.default),t}var U=g({parser:D},E);var b=new Date(""),q=/^(\d{4})(?:-([0-2]\d)(?:-([0-3]\d)(?:[ T]([0-2]\d):([0-5]\d)(?::([0-5]\d)(\.\d+)?(Z|[+-][0-2]\d:?[0-5]\d)?)?)?)?)?$/,L=/^([+-])([0-2]\d):?([0-5]\d)$/;function _(e){let r=L.exec(e);if(e==="Z"||!r)return 0;let[,t,a="0",n="0"]=r,o=t==="-"?-1:1,s=Number.parseInt(a,10)*60+Number.parseInt(n,10);return o*s}var V=10,G=[()=>0,(e="0")=>Number.parseInt(e,V),(e="1")=>Number.parseInt(e,V)-1,(e="1")=>Number.parseInt(e,V),(e="0")=>Number.parseInt(e,V),(e="0")=>Number.parseInt(e,V),(e="0")=>Number.parseInt(e,V),(e="0")=>Number.parseFloat(e)*1e3];function y(e){return e==null||e instanceof Date?e:typeof e=="number"?new Date(e):typeof e=="string"?H(e):b}function H(e){let r=q.exec(e);if(r===null)return b;let[,t=0,a=0,n=0,o=0,i=0,s=0,d=0]=G.map((l,O)=>l(r[O])),f=r[8];return f?new Date(Date.UTC(t,a,n,o,i+_(f),s,d)):new Date(t,a,n,o,i,s,d)}function h(e,r){let t=r.parser(e);return r.default!==void 0&&(t==null||Number.isNaN(t.getTime()))&&(t=r.default),t}function J(e,r,t){let a=y(e);return u(n=>a!=null&&(n==null||n instanceof Date&&(t?n>a:n>=a)),r,()=>({min:a,limit:a,exclusive:t}))}function Q(e,r,t){let a=y(e);return u(n=>a!=null&&(n==null||n instanceof Date&&(t?n<a:n<=a)),r,()=>({max:a,limit:a,exclusive:t}))}var W=g({parser:y},h);function C(e){return e==null||typeof e=="number"?e:e instanceof Date?e.getTime():typeof e=="string"?Number.parseFloat(e):Number.parseFloat(String(e))}function k(e,r){let t=r.parser(e);if(r.default!==void 0&&(t==null||Number.isNaN(t))&&(t=r.default),r.round&&typeof t=="number")switch(r.round){case"nearest":{t=Math.round(t);break}case"ceil":{t=Math.ceil(t);break}case"floor":{t=Math.floor(t);break}default:throw new Error(`Unknown round type: ${String(r.round)}`)}return t}function X(e){return async(r,t)=>r==null||typeof r=="number"&&Number.isFinite(r)&&Math.floor(r)===r?m({value:r,field:t}):p({message:e,value:r,field:t})}var Y=g({parser:C},k);function v(e){if(typeof e!="object"||e===null)throw new TypeError("`properties` must be a configuration object");return async(r,t)=>{let a=r??{},n={},o={},i=!0;for(let s in e)if(x(e,s)){let d=e[s],f=a[s],l=typeof d=="function"?await d(f,s):await p({field:s,message:"No validator set",value:f});o[s]=l.value,l.state==="invalid"&&(i=!1,n[s]=l.message||l.errors)}return i?m({value:o,field:t}):p({message:"",value:r,field:t,errors:n})}}var ee=/^[\w!#$%&'*+./=?^`{|}~-]+@[\dA-Za-z](?:[\dA-Za-z-]{0,61}[\dA-Za-z])?(?:\.[\dA-Za-z](?:[\dA-Za-z-]{0,61}[\dA-Za-z])?)*$/;function S(e){if(e==null||typeof e=="string")return e;if(e instanceof Date)return e.toISOString();if(T(e))throw new TypeError("Failed to parse value to string.");return String(e)}function N(e,r){let t=r.parser(e);return r.default!==void 0&&(t==null||t==="")&&(t=r.default),r.trim&&typeof t=="string"&&(t=t.trim()),t}function A(e,r){let t=new RegExp(e);return u(a=>(t.lastIndex=0,a==null||a===""||typeof a=="string"&&t.test(a)),r,()=>({pattern:e}))}function te(e){return A(ee,e)}function re(e,r){return u(t=>{try{let a;if(t==null||t===""||typeof t=="string"&&(a=new URL(t)))return!(a&&r&&!r.includes(a.protocol))}catch{}return!1},e,()=>({protocols:r}))}var ae=g({parser:S},N);export{w as applyArrayConfig,E as applyBooleanConfig,h as applyDateConfig,k as applyNumberConfig,N as applyStringConfig,K as array,U as boolean,g as createTypeValidatorTest,u as createValidatorTest,W as date,te as email,z as exact,P as formatMessage,x as hasOwnProperty,X as integer,p as invalid,b as invalidDate,T as isObject,A as matches,B as max,Q as maxDate,j as min,J as minDate,Y as number,v as object,F as oneOf,M as parseArray,D as parseBoolean,y as parseDate,C as parseNumber,S as parseString,R as required,ae as string,re as url,m as valid};
+function e(e){return Object.prototype.toString.call(e)===`[object Object]`}function t(e,t){return Object.prototype.hasOwnProperty.call(e,t)}function n(e){return!!Reflect.get(Object(e),Symbol.iterator)}const r=/{(\w+)}/g;function i(e,t){return typeof e==`string`?e.replaceAll(r,(e,n)=>String(Reflect.get(t,n))):e(t)}async function a({value:e,field:t}){return{isValid:!0,state:`valid`,value:e,field:t}}async function o({errors:e,field:t,message:n,value:r,extras:a}){return{isValid:!1,state:`invalid`,message:i(n,{...a,value:r,field:t}),value:r,field:t,errors:e}}function s(e){return Array.isArray(e)||e==null?e:n(e)?[...e]:[]}function c(e,t){let n=e.parser(t);return e.default!==void 0&&(n==null||n.length===0)&&(n=e.default),n}async function l(e,t,n){for(let r of e){let e=await r(t,n);if(e.state===`invalid`)return e}}async function u(e,t,n){let r=!0,i=[];if(!t||!e)return{isValid:r,errors:i};for(let[a,o]of t.entries()){let t=await e(o,n?`${n}[${a}]`:`[${a}]`);t.state===`invalid`?(r=!1,i.push(t.message||t.errors)):i.push(null)}return{isValid:r,errors:i}}function d(e,...t){let n=t,r={parser:s};return e!==void 0&&(typeof e==`function`?n=[e,...t]:r={...r,...e}),async(e,t)=>{let i=c(r,e),[s,...d]=n,f=await l(d,i,t),p=await u(s,i,t);return!f&&p.isValid?a({value:i,field:t}):o({message:f?f.message:``,value:e,field:t,errors:p.errors})}}function f(e,t){return(n,...r)=>{let i=e,s=r;return n!==void 0&&(typeof n==`function`?s=[n,...r]:i={...e,...n}),async(e,n)=>{try{let r=t(e,i);for(let e of s){let t=await e(r,n);if(t.state===`invalid`)return t}return await a({value:r,field:n})}catch(t){return o({message:t instanceof Error?t.message:String(t),value:e,field:n})}}}}function p(e,t,n){return async(r,i)=>e(r,i)?a({value:r,field:i}):o({message:t,value:r,field:i,extras:n?n(r):void 0})}function m(e){return e==null||typeof e==`boolean`?e:!!e}function h(e,t){let n=t.parser(e);return t.default!==void 0&&n==null&&(n=t.default),n}const g=f({parser:m},h),_=/* @__PURE__ */ new Date(``),v=/^(\d{4})(?:-([0-2]\d)(?:-([0-3]\d)(?:[ T]([0-2]\d):([0-5]\d)(?::([0-5]\d)(\.\d+)?(Z|[+-][0-2]\d:?[0-5]\d)?)?)?)?)?$/,y=/^([+-])([0-2]\d):?([0-5]\d)$/;function b(e){let t=y.exec(e);if(e===`Z`||!t)return 0;let[,n,r=`0`,i=`0`]=t;return(n===`-`?-1:1)*(Number.parseInt(r,10)*60+Number.parseInt(i,10))}const x=[()=>0,(e=`0`)=>Number.parseInt(e,10),(e=`1`)=>Number.parseInt(e,10)-1,(e=`1`)=>Number.parseInt(e,10),(e=`0`)=>Number.parseInt(e,10),(e=`0`)=>Number.parseInt(e,10),(e=`0`)=>Number.parseInt(e,10),(e=`0`)=>Number.parseFloat(e)*1e3];function S(e){return e==null||e instanceof Date?e:typeof e==`number`?new Date(e):typeof e==`string`?C(e):_}function C(e){let t=v.exec(e);if(t===null)return _;let[,n=0,r=0,i=0,a=0,o=0,s=0,c=0]=x.map((e,n)=>e(t[n])),l=t[8];return l?new Date(Date.UTC(n,r,i,a,o+b(l),s,c)):new Date(n,r,i,a,o,s,c)}function w(e,t){let n=t.parser(e);return t.default!==void 0&&(n==null||Number.isNaN(n.getTime()))&&(n=t.default),n}function T(e,t,n){let r=S(e);return p(e=>r!=null&&(e==null||e instanceof Date&&(n?e>r:e>=r)),t,()=>({min:r,limit:r,exclusive:n}))}function E(e,t,n){let r=S(e);return p(e=>r!=null&&(e==null||e instanceof Date&&(n?e<r:e<=r)),t,()=>({max:r,limit:r,exclusive:n}))}const D=f({parser:S},w);function O(e){return e==null||typeof e==`number`?e:e instanceof Date?e.getTime():typeof e==`string`?Number.parseFloat(e):Number.parseFloat(String(e))}function k(e,t){let n=t.parser(e);if(t.default!==void 0&&(n==null||Number.isNaN(n))&&(n=t.default),t.round&&typeof n==`number`)switch(t.round){case`nearest`:n=Math.round(n);break;case`ceil`:n=Math.ceil(n);break;case`floor`:n=Math.floor(n);break;default:throw Error(`Unknown round type: ${String(t.round)}`)}return n}function A(e){return async(t,n)=>t==null||typeof t==`number`&&Number.isFinite(t)&&Math.floor(t)===t?a({value:t,field:n}):o({message:e,value:t,field:n})}const j=f({parser:O},k);function M(e){if(typeof e!=`object`||!e)throw TypeError("`properties` must be a configuration object");return async(n,r)=>{let i={},s={},c=!0;for(let r in e)if(t(e,r)){let t=e[r],a=Reflect.get(Object(n),r),l=await(typeof t==`function`?t(a,r):o({field:r,message:`No validator set`,value:a}));s[r]=l.value,l.state===`invalid`&&(c=!1,i[r]=l.message||l.errors)}return c?a({value:s,field:r}):o({message:``,value:n,field:r,errors:i})}}function N(e,t){return p(e=>t&&e===null||e!=null&&(typeof e!=`string`||e!==``)&&!(typeof e==`number`&&Number.isNaN(e))&&!(e instanceof Date&&Number.isNaN(e.valueOf())),e)}function P(e,t){let n=e;return p(t=>t==null||n.includes(t)||t instanceof Date&&e.some(e=>e.valueOf()===t.valueOf()),t,()=>({values:e}))}function F(e){return typeof e==`string`||Array.isArray(e)?e.length:e}function I(e,t,n){return p(t=>{let r=F(t);return r==null||t===``||(n?r<e:r<=e)},t,t=>({max:e,limit:e,amount:F(t),exclusive:n}))}function L(e,t,n){return p(t=>{let r=F(t);return r==null||t===``||(n?r>e:r>=e)},t,t=>({min:e,limit:e,amount:F(t),exclusive:n}))}function R(e,t){return p(t=>{let n=F(t);return n==null||t===``||n===e},t,t=>({amount:F(t),limit:e,exact:e}))}const z=/^[\w!#$%&'*+./=?^`{|}~-]+@[\dA-Za-z](?:[\dA-Za-z-]{0,61}[\dA-Za-z])?(?:\.[\dA-Za-z](?:[\dA-Za-z-]{0,61}[\dA-Za-z])?)*$/,B=/^(?:[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}|0{8}-0{4}-0{4}-0{4}-0{12}|f{8}-f{4}-f{4}-f{4}-f{12})$/i;function V(t){if(t==null||typeof t==`string`)return t;if(t instanceof Date)return t.toISOString();if(e(t))throw TypeError(`Failed to parse value to string.`);return String(t)}function H(e,t){let n=t.parser(e);return t.default!==void 0&&(n==null||n===``)&&(n=t.default),t.trim&&typeof n==`string`&&(n=n.trim()),n}function U(e,t){let n=new RegExp(e);return p(e=>(n.lastIndex=0,e==null||e===``||typeof e==`string`&&n.test(e)),t,()=>({pattern:e}))}function W(e){return U(z,e)}function G(e){return U(B,e)}function K(e,t){return p(e=>{try{let n;if(e==null||e===``||typeof e==`string`&&(n=new URL(e)))return!(n&&t&&!t.includes(n.protocol))}catch{}return!1},e,()=>({protocols:t}))}const q=f({parser:V},H);export{c as applyArrayConfig,h as applyBooleanConfig,w as applyDateConfig,k as applyNumberConfig,H as applyStringConfig,d as array,g as boolean,f as createTypeValidatorTest,p as createValidatorTest,D as date,W as email,R as exact,i as formatMessage,t as hasOwnProperty,A as integer,o as invalid,_ as invalidDate,e as isObject,U as matches,I as max,E as maxDate,L as min,T as minDate,j as number,M as object,P as oneOf,s as parseArray,m as parseBoolean,S as parseDate,O as parseNumber,V as parseString,N as required,q as string,K as url,G as uuid,a as valid};
 //# sourceMappingURL=index.js.map