@oxog/vld 2.1.0 → 2.2.5

package/dist/validators/base.d.ts

@@ -121,6 +121,19 @@ export interface SuperRefineContext {
     }): void;
     path: (string | number)[];
 }
+export interface CheckPayload<T> {
+    value: T;
+    issues: Array<{
+        message?: string;
+        code?: string;
+    }>;
+    aborted?: boolean;
+}
+export type VldCheck<T> = ((payload: CheckPayload<T>) => void | Promise<void>) | {
+    _zod?: {
+        check?: (payload: CheckPayload<T>) => void | Promise<void>;
+    };
+};
 export type ErrorMap = (issue: {
     code?: string;
     input?: unknown;
@@ -131,6 +144,14 @@ export type ErrorParam = string | {
     message?: string;
 };
 export declare function resolveErrorMessage(error: ErrorParam | undefined, fallback: string): string;
+type ValueOrFactory<T> = T | (() => T);
+interface SchemaCompositionFactories {
+    array<TInput, TOutput>(schema: VldBase<TInput, TOutput>): VldBase<unknown[], TOutput[]>;
+    union<TInput, TOutput, TNext>(left: VldBase<TInput, TOutput>, right: VldBase<any, TNext>): VldBase<unknown, TOutput | TNext>;
+    intersection<TInput, TOutput, TNext>(left: VldBase<TInput, TOutput>, right: VldBase<any, TNext>): VldBase<unknown, TOutput & TNext>;
+    toJSONSchema(schema: VldBase<any, any>, options?: unknown): unknown;
+}
+export declare function configureSchemaCompositionFactories(factories: SchemaCompositionFactories): void;
 /**
  * Abstract base class for all validators
  * Implements immutable pattern to prevent memory leaks and race conditions
@@ -162,6 +183,26 @@ export declare abstract class VldBase<TInput, TOutput = TInput> {
     abstract safeParse(value: unknown): ParseResult<TOutput>;
     parseAsync(value: unknown): Promise<TOutput>;
     safeParseAsync(value: unknown): Promise<ParseResult<TOutput>>;
+    /** Strongly typed forward parse aliases from the Zod 4 codec API. */
+    decode(value: TInput): TOutput;
+    safeDecode(value: TInput): ParseResult<TOutput>;
+    decodeAsync(value: TInput): Promise<TOutput>;
+    safeDecodeAsync(value: TInput): Promise<ParseResult<TOutput>>;
+    /**
+     * Backward parse aliases. Primitive and validation-only schemas are
+     * bidirectional; codecs override these methods with their inverse transform.
+     */
+    encode(value: TOutput): TInput;
+    safeEncode(value: TOutput): ParseResult<TInput>;
+    encodeAsync(value: TOutput): Promise<TInput>;
+    safeEncodeAsync(value: TOutput): Promise<ParseResult<TInput>>;
+    /** Zod's short alias for safeParseAsync. */
+    spa(value: unknown): Promise<ParseResult<TOutput>>;
+    /** Compatibility helpers retained by Zod 4. */
+    isOptional(): boolean;
+    isNullable(): boolean;
+    /** VLD validators are immutable, so cloning can safely share the instance. */
+    clone(): this;
     /**
      * Check if a value is valid according to this validator
      * @param value The value to check
@@ -201,7 +242,16 @@ export declare abstract class VldBase<TInput, TOutput = TInput> {
      * @param defaultValue The default value
      * @returns A new validator with default
      */
-    default(defaultValue: TOutput): VldDefault<TInput, TOutput>;
+    default(defaultValue: ValueOrFactory<TOutput>): VldDefault<TInput, TOutput>;
+    /** Provide an input value before parsing when the input is undefined. */
+    prefault(defaultValue: ValueOrFactory<TInput>): VldPrefault<TInput, TOutput>;
+    nonoptional(message?: ErrorParam): VldRefine<TInput, TOutput, TOutput>;
+    array(): VldBase<unknown[], TOutput[]>;
+    or<TNext>(option: VldBase<any, TNext>): VldBase<unknown, TOutput | TNext>;
+    and<TNext>(incoming: VldBase<any, TNext>): VldBase<unknown, TOutput & TNext>;
+    overwrite(transformer: (value: TOutput) => TOutput): VldTransform<TInput, TOutput, TOutput>;
+    with(...checks: VldCheck<TOutput>[]): VldSuperRefine<TInput, TOutput>;
+    toJSONSchema(options?: unknown): unknown;
     /**
      * Create a new validator that catches errors and returns a fallback
      * @param fallbackValue The fallback value
@@ -236,7 +286,7 @@ export declare abstract class VldBase<TInput, TOutput = TInput> {
      * @param next The next validator to pipe into
      * @returns A new piped validator
      */
-    pipe<TNextOutput>(next: VldBase<TOutput, TNextOutput>): VldPipe<TInput, TOutput, TNextOutput>;
+    pipe<TNextOutput>(next: VldBase<any, TNextOutput>): VldPipe<TInput, TOutput, TNextOutput>;
     /**
      * Create a new validator that returns readonly output
      * Zod 4 API parity - marks output as readonly for TypeScript
@@ -266,7 +316,7 @@ export declare abstract class VldBase<TInput, TOutput = TInput> {
      * const withLength = (schema: VldBase<unknown, string>) => schema.transform(s => s.length);
      * const lengthSchema = v.string().apply(withLength); // validates string, returns number
      */
-    apply<TNewOutput>(fn: (schema: this) => VldBase<TInput, TNewOutput>): VldBase<TInput, TNewOutput>;
+    apply<TResult>(fn: (schema: this) => TResult): TResult;
     /**
      * Create a new validator that refines this one with a custom predicate
      * Alias for refine() - check() is the Zod 4 API name
@@ -302,6 +352,7 @@ export declare abstract class VldBase<TInput, TOutput = TInput> {
      * @returns A new validator with the description
      */
     describe(description: string): VldMeta<TInput, TOutput>;
+    get description(): string | undefined;
 }
 /**
  * Schema metadata interface for OpenAPI/JSON Schema compatibility
@@ -390,14 +441,16 @@ export declare class VldTransform<TInput, TBase, TOutput> extends VldBase<TInput
 export declare class VldDefault<TInput, TOutput> extends VldBase<TInput | undefined, TOutput> {
     private readonly baseValidator;
     private readonly defaultValue;
-    constructor(baseValidator: VldBase<TInput, TOutput>, defaultValue: TOutput);
+    constructor(baseValidator: VldBase<TInput, TOutput>, defaultValue: ValueOrFactory<TOutput>);
     parse(value: unknown): TOutput;
     safeParse(value: unknown): ParseResult<TOutput>;
     /**
      * Pre-parse default - validates the default value instead of returning it directly
      * This is useful when the default value needs to be validated against the schema
      */
-    prefault(): VldPrefault<TInput, TOutput>;
+    prefault(defaultValue?: ValueOrFactory<TInput>): VldPrefault<TInput, TOutput>;
+    unwrap(): VldBase<TInput, TOutput>;
+    removeDefault(): VldBase<TInput, TOutput>;
 }
 /**
  * Prefault validator - validates the default value instead of returning it directly
@@ -405,13 +458,14 @@ export declare class VldDefault<TInput, TOutput> extends VldBase<TInput | undefi
 export declare class VldPrefault<TInput, TOutput> extends VldBase<TInput | undefined, TOutput> {
     private readonly baseValidator;
     private readonly defaultValue;
-    constructor(baseValidator: VldBase<TInput, TOutput>, defaultValue: TOutput);
+    constructor(baseValidator: VldBase<TInput, TOutput>, defaultValue: ValueOrFactory<TInput>);
     parse(value: unknown): TOutput;
     safeParse(value: unknown): ParseResult<TOutput>;
     /**
      * Calling prefault multiple times should be safe - return self
      */
-    prefault(): VldPrefault<TInput, TOutput>;
+    prefault(defaultValue?: ValueOrFactory<TInput>): VldPrefault<TInput, TOutput>;
+    unwrap(): VldBase<TInput, TOutput>;
 }
 /**
  * Catch validator - provides fallback value on validation error
@@ -483,7 +537,7 @@ export declare class VldNullish<TInput, TOutput> extends VldBase<TInput | null |
 export declare class VldPipe<TInput, TIntermediate, TOutput> extends VldBase<TInput, TOutput> {
     private readonly first;
     private readonly second;
-    constructor(first: VldBase<TInput, TIntermediate>, second: VldBase<TIntermediate, TOutput>);
+    constructor(first: VldBase<TInput, TIntermediate>, second: VldBase<any, TOutput>);
     parse(value: unknown): TOutput;
     safeParse(value: unknown): ParseResult<TOutput>;
 }
@@ -510,3 +564,4 @@ export declare class VldPreprocess<TInput, TOutput> extends VldBase<unknown, TOu
     parse(value: unknown): TOutput;
     safeParse(value: unknown): ParseResult<TOutput>;
 }
+export {};