validator-fns 1.10.0 → 2.0.0

package/dist/index.d.ts

@@ -1,409 +0,0 @@
-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;
-};
-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;
-    /** Extra error details */
-    errors?: E;
-};
-/**
- * The result of a validation.
- * @typeParam T The value type
- * @category Types
- */
-type ValidatorResult<T = any, E = any> = 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>>;
-/**
- * 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;
-/**
- * Extracts the generic value type from a ValidatorTest.
- * @typeParam T a ValidatorTest
- * @category Types
- */
-type ExtractValue<T extends ValidatorTest> = T extends ValidatorTest<infer V> ? V : unknown;
-/**
- * Make a deep partial type.
- * @typeParam T any object type
- * @category Types
- */
-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>;
-/**
- * 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;
-}
-interface ValidatorMessageParameters<T> {
-    value: T | null | undefined;
-    field: string | undefined;
-}
-/**
- * Validation message. May be a plain string or a function that accepts arguments.
- * While using a string, values in squiggly brackets `{}` are replaced.
- * @category Types
- */
-type ValidatorMessage<T, P extends ValidatorMessageParameters<T> = ValidatorMessageParameters<T>> = string | ((parameters: P) => string);
-/**
- * Simple check for objects.
- * @param value Value to test
- */
-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;
-/**
- * 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;
-/**
- * Creates a valid result
- * @param value Parsed value
- * @param field Field name
- * @category Helpers
- */
-declare function valid<T, E = never>({ value, field, }: {
-    value: T | null | undefined;
-    field: string | undefined;
-}): Promise<ValidatorResult<T, E>>;
-/**
- * Creates an invalid result.
- * @param message Error message
- * @param value Parsed value
- * @param field Field name
- * @param 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;
-    extras?: Except<P, 'field' | 'value'>;
-}): 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) => Except<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;
-}
-/**
- * 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;
-}
-/**
- * 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>;
-
-/**
- * Invalid validation result for an item in the array
- * @category Types
- */
-type ArrayItemValidatorResult<E = unknown> = null | string | E;
-/**
- * Configuration for array validation.
- * @category Types
- */
-type ArrayConfig = ConfigBase<unknown[]>;
-/**
- * Parses a value into an array.
- * @param value Value to parse
- * @category Parsers
- */
-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;
-/**
- * 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>[]>;
-
-/**
- * Parses a value into a boolean.
- * @param value Value to parse
- * @category Parsers
- */
-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;
-/**
- * Configuration for boolean validation.
- * @category Types
- */
-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;
-/**
- * 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;
-type SharedDateValueType = Date | string | number;
-interface MinDateValidatorMessageParameters extends ValidatorMessageParameters<Date> {
-    min: Date | null | undefined;
-    limit: Date | null | undefined;
-    exclusive?: boolean;
-}
-/**
- * Ensures a date value is on or after a date.
- * @param limit Minimum date
- * @param message Error message
- * @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>;
-interface MaxDateValidatorMessageParameters extends ValidatorMessageParameters<Date> {
-    max: Date | null | undefined;
-    limit: Date | null | undefined;
-    exclusive?: boolean;
-}
-/**
- * Ensures a date value is on or before a date.
- * @param limit Maximum date
- * @param message Error message
- * @param exclusive Makes comparison exclusive instead of inclusive
- * @category Validation Tests
- */
-declare function maxDate(limit: SharedDateValueType, message: ValidatorMessage<Date, MaxDateValidatorMessageParameters>, exclusive?: boolean): ValidatorTest<Date>;
-/**
- * Configuration for date validation.
- * @category Types
- */
-type DateConfig = ConfigBase<Date>;
-/**
- * Validates a date value.
- * @category Type Validators
- */
-declare const date: ValidatorFactory<DateConfig, Date, string>;
-
-/**
- * Parses a value into a number.
- * @param value Value to parse
- * @category Parsers
- */
-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;
-/**
- * Ensures a number value is an integer.
- * @param message Error message
- * @category Validation Tests
- */
-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';
-}
-/**
- * Validates a number value.
- * @category Type Validators
- */
-declare const number: ValidatorFactory<NumberConfig, number, string>;
-
-type ObjectParameter = Record<string, ValidatorTest<unknown, unknown>>;
-/**
- * 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>;
-
-/**
- * Configuration for string validation.
- * @category Types
- */
-interface StringConfig extends ConfigBase<string> {
-    /** 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;
-/**
- * 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;
-interface MatchesValidatorMessageParameters extends ValidatorMessageParameters<string> {
-    pattern: RegExp;
-}
-/**
- * Ensures a string value matches a pattern
- * @param pattern Pattern to match
- * @param message Error message
- * @category Validation Tests
- */
-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>;
-/**
- * Ensures a string value is a valid URL
- * @param message Error message
- * @param protocols Optional list of protocols to allow
- * @category Validation Tests
- */
-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 { 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, 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 };