formstand 0.26.0 → 0.26.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { P as PathDepth, D as DefaultPathDepth, F as Form, C as CreateFormOptions, a as FormState, b as FieldValidationResult, S as SettledFieldValidationResult, c as FieldPath, d as FieldValue, I as InvalidSubmitHandler, A as ArrayFieldPath, e as ArrayItemOf, E as ErrorMap } from './createForm-RE6Bjnfv.cjs';
-export { B as BoolMap, f as ErrorPath, g as FieldSnapshot, h as FieldsValidationResult, R as ReadonlyStoreApi, i as ResetOptions, j as SettledFieldsValidationResult, k as SettledValidationResult, l as SubmitHandler, m as SubmitOptions, n as SubmitResult, V as ValidationMode, o as ValidationResult, p as ValidationTrigger, q as createForm, r as emptyValueForSchema, s as flattenIssues, t as isAsyncRequiredError, u as isClearableSchema, v as shouldValidateOn, w as validateAsync, x as validateSync } from './createForm-RE6Bjnfv.cjs';
+import { P as PathDepth, D as DefaultPathDepth, F as Form, C as CreateFormOptions, a as FormState, b as FieldValidationResult, S as SettledFieldValidationResult, c as FieldPath, d as FieldValue, I as InvalidSubmitHandler, A as ArrayFieldPath, e as ArrayItemOf, E as ErrorMap } from './createForm-BXDd9Tg4.cjs';
+export { B as BoolMap, f as ErrorPath, g as FieldSnapshot, h as FieldsValidationResult, R as ReadonlyStoreApi, i as ResetOptions, j as SettledFieldsValidationResult, k as SettledValidationResult, l as SubmitHandler, m as SubmitOptions, n as SubmitResult, V as ValidationMode, o as ValidationResult, p as ValidationTrigger, q as createForm, r as emptyValueForSchema, s as flattenIssues, t as isAsyncRequiredError, u as isClearableSchema, v as shouldValidateOn, w as validateAsync, x as validateSync } from './createForm-BXDd9Tg4.cjs';
 import { z } from 'zod';
 import * as react from 'react';
 import { ChangeEvent, ReactNode } from 'react';
@@ -133,6 +133,7 @@ type FormActionStateHandler<TSchema extends z.ZodType, S> = (prevState: S, data:
 type FormActionOptions = Readonly<{
     onInvalid?: InvalidSubmitHandler;
     onError?: (error: unknown) => void;
+    force?: boolean;
 }>;
 declare const useFormAction: <TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, onValid: FormActionHandler<TSchema>, options?: FormActionOptions) => ((formData: FormData) => Promise<void>);
 declare const useFormActionState: <TSchema extends z.ZodType, S, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, action: FormActionStateHandler<TSchema, S>, initialState: S, options?: FormActionOptions) => [state: S, formAction: (formData: FormData) => void, isPending: boolean];
@@ -152,18 +153,24 @@ type CommonKeys<V> = keyof V;
 type AllKeys<V> = V extends unknown ? keyof V : never;
 type VariantKeys<V> = Exclude<AllKeys<V>, CommonKeys<V>> & string;
 type VariantFieldPath<V, D extends PathDepth = DefaultPathDepth> = Exclude<V extends unknown ? FieldPath<V, D> : never, (CommonKeys<V> & string) | `${CommonKeys<V> & string}.${string}`> & string;
-type UnionValueAt<TValues, P extends string> = P extends keyof TValues ? NonNullable<TValues[P]> : TValues extends readonly (infer Item)[] ? P extends `${number}` ? NonNullable<Item> : P extends `${infer Head}.${infer Tail}` ? Head extends keyof TValues ? UnionValueAt<NonNullable<TValues[Head]>, Tail> : Head extends `${number}` ? UnionValueAt<NonNullable<Item>, Tail> : never : never : P extends `${infer Head}.${infer Tail}` ? Head extends keyof TValues ? UnionValueAt<NonNullable<TValues[Head]>, Tail> : never : never;
+type MemberValueAt<TValues, K extends string> = TValues extends unknown ? K extends keyof TValues ? TValues[K] : never : never;
+type UnionValueAt<TValues, P extends string> = [
+    MemberValueAt<TValues, P>
+] extends [never] ? UnionValueAtDeep<TValues, P> : NonNullable<MemberValueAt<TValues, P>>;
+type UnionValueAtDeep<TValues, P extends string> = P extends keyof TValues ? NonNullable<TValues[P]> : TValues extends readonly (infer Item)[] ? P extends `${number}` ? NonNullable<Item> : P extends `${infer Head}.${infer Tail}` ? [
+    MemberValueAt<TValues, Head>
+] extends [never] ? Head extends `${number}` ? UnionValueAt<NonNullable<Item>, Tail> : never : UnionValueAt<NonNullable<MemberValueAt<TValues, Head>>, Tail> : never : P extends `${infer Head}.${infer Tail}` ? [MemberValueAt<TValues, Head>] extends [never] ? never : UnionValueAt<NonNullable<MemberValueAt<TValues, Head>>, Tail> : never;
 declare const inferredCallsOnly$2: unique symbol;
 interface InferredTypeArg$2 {
     readonly [inferredCallsOnly$2]: typeof inferredCallsOnly$2;
 }
 declare function useVariantField<TValue = InferredTypeArg$2>(form: FieldFormApi & Readonly<{
     schema: z.ZodType;
-}>, unionPath: TValue extends InferredTypeArg$2 ? never : "Remove the explicit type argument: a schema-typed form infers the variant value from the union path and field", field: string): UseFieldReturn<TValue | undefined>;
+}>, unionPath: TValue extends InferredTypeArg$2 ? never : "Remove the explicit type argument: a schema-typed form infers the variant value from the union path and field", field: string, options?: UseFieldOptions): UseFieldReturn<TValue | undefined>;
 declare function useVariantField<TValue = unknown>(form: FieldFormApi & {
     readonly schema?: undefined;
-}, unionPath: string, field: string): UseFieldReturn<TValue | undefined>;
-declare function useVariantField<TSchema extends z.ZodType, P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, unionPath: P, field: TField): UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
+}, unionPath: string, field: string, options?: UseFieldOptions): UseFieldReturn<TValue | undefined>;
+declare function useVariantField<TSchema extends z.ZodType, P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, unionPath: P, field: TField, options?: UseFieldOptions): UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
 
 type ReadonlyStore$1<T> = Pick<StoreApi<T>, "getState" | "getInitialState" | "subscribe">;
 type FieldArrayFormApi = Readonly<{
@@ -174,6 +181,7 @@ type FieldArrayFormApi = Readonly<{
     arrayMove(path: string, from: number, to: number): void;
     arraySwap(path: string, a: number, b: number): void;
     validateField?(path: string): FieldValidationResult;
+    validateFieldAsync?(path: string): Promise<SettledFieldValidationResult>;
     setError?(path: string, errors: string | readonly string[]): void;
     clearErrors?(path?: string): void;
     setTouched?(path: string, touched?: boolean): void;
@@ -198,6 +206,7 @@ type UseFieldArrayReturn<TItem> = Readonly<{
     setTouched: (touched?: boolean) => void;
     onBlur: () => void;
     validate: () => FieldValidationResult;
+    validateAsync: () => Promise<SettledFieldValidationResult>;
     push: (item: TItem) => void;
     remove: (index: number) => void;
     insert: (index: number, item: TItem) => void;
@@ -248,8 +257,8 @@ type UseFieldsReturn<TFields extends readonly unknown[]> = Readonly<{
 }>;
 declare function useFields(form: FieldFormApi & {
     readonly schema?: undefined;
-}, paths: readonly string[]): UseFieldsReturn<readonly UseFieldReturn<unknown>[]>;
-declare function useFields<TSchema extends z.ZodType, const P extends readonly FieldPath<z.input<TSchema>, D>[], D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, paths: P): UseFieldsReturn<{
+}, paths: readonly string[], options?: UseFieldOptions): UseFieldsReturn<readonly UseFieldReturn<unknown>[]>;
+declare function useFields<TSchema extends z.ZodType, const P extends readonly FieldPath<z.input<TSchema>, D>[], D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, paths: P, options?: UseFieldOptions): UseFieldsReturn<{
     readonly [K in keyof P]: UseFieldReturn<FieldValue<z.input<TSchema>, P[K] & string>>;
 }>;
 
@@ -257,7 +266,7 @@ type BoundUseField<TSchema extends z.ZodType, D extends PathDepth = DefaultPathD
     (pathSelector: (state: FormState<z.input<TSchema>>) => string, options?: UseFieldOptions): UseFieldReturn<unknown>;
     <P extends FieldPath<z.input<TSchema>, D>>(path: P, options?: UseFieldOptions): UseFieldReturn<FieldValue<z.input<TSchema>, P>>;
 };
-type BoundUseVariantField<TSchema extends z.ZodType> = <P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField) => UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
+type BoundUseVariantField<TSchema extends z.ZodType> = <P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField, options?: UseFieldOptions) => UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
 type BoundUseVariantFieldArray<TSchema extends z.ZodType> = <P extends string, TField extends VariantArrayFieldPath<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField) => UseFieldArrayReturn<ArrayItemOf<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField>>>;
 type BoundUseFieldArray<TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth> = {
     (pathSelector: (state: FormState<z.input<TSchema>>) => string): UseFieldArrayReturn<unknown>;
@@ -305,7 +314,7 @@ type FormHooks<TSchema extends z.ZodType, N extends string, D extends PathDepth
 } & {
     [K in `use${Capitalize<N>}Persist`]: BoundUsePersist<TSchema>;
 }>;
-type BoundUseFields<TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth> = <const P extends readonly FieldPath<z.input<TSchema>, D>[]>(paths: P) => UseFieldsReturn<{
+type BoundUseFields<TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth> = <const P extends readonly FieldPath<z.input<TSchema>, D>[]>(paths: P, options?: UseFieldOptions) => UseFieldsReturn<{
     readonly [K in keyof P]: UseFieldReturn<FieldValue<z.input<TSchema>, P[K] & string>>;
 }>;
 declare const createFormHooks: <TSchema extends z.ZodType, N extends string = "", D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, name?: N) => FormHooks<TSchema, N, D>;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PathDepth, D as DefaultPathDepth, F as Form, C as CreateFormOptions, a as FormState, b as FieldValidationResult, S as SettledFieldValidationResult, c as FieldPath, d as FieldValue, I as InvalidSubmitHandler, A as ArrayFieldPath, e as ArrayItemOf, E as ErrorMap } from './createForm-RE6Bjnfv.js';
-export { B as BoolMap, f as ErrorPath, g as FieldSnapshot, h as FieldsValidationResult, R as ReadonlyStoreApi, i as ResetOptions, j as SettledFieldsValidationResult, k as SettledValidationResult, l as SubmitHandler, m as SubmitOptions, n as SubmitResult, V as ValidationMode, o as ValidationResult, p as ValidationTrigger, q as createForm, r as emptyValueForSchema, s as flattenIssues, t as isAsyncRequiredError, u as isClearableSchema, v as shouldValidateOn, w as validateAsync, x as validateSync } from './createForm-RE6Bjnfv.js';
+import { P as PathDepth, D as DefaultPathDepth, F as Form, C as CreateFormOptions, a as FormState, b as FieldValidationResult, S as SettledFieldValidationResult, c as FieldPath, d as FieldValue, I as InvalidSubmitHandler, A as ArrayFieldPath, e as ArrayItemOf, E as ErrorMap } from './createForm-BXDd9Tg4.js';
+export { B as BoolMap, f as ErrorPath, g as FieldSnapshot, h as FieldsValidationResult, R as ReadonlyStoreApi, i as ResetOptions, j as SettledFieldsValidationResult, k as SettledValidationResult, l as SubmitHandler, m as SubmitOptions, n as SubmitResult, V as ValidationMode, o as ValidationResult, p as ValidationTrigger, q as createForm, r as emptyValueForSchema, s as flattenIssues, t as isAsyncRequiredError, u as isClearableSchema, v as shouldValidateOn, w as validateAsync, x as validateSync } from './createForm-BXDd9Tg4.js';
 import { z } from 'zod';
 import * as react from 'react';
 import { ChangeEvent, ReactNode } from 'react';
@@ -133,6 +133,7 @@ type FormActionStateHandler<TSchema extends z.ZodType, S> = (prevState: S, data:
 type FormActionOptions = Readonly<{
     onInvalid?: InvalidSubmitHandler;
     onError?: (error: unknown) => void;
+    force?: boolean;
 }>;
 declare const useFormAction: <TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, onValid: FormActionHandler<TSchema>, options?: FormActionOptions) => ((formData: FormData) => Promise<void>);
 declare const useFormActionState: <TSchema extends z.ZodType, S, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, action: FormActionStateHandler<TSchema, S>, initialState: S, options?: FormActionOptions) => [state: S, formAction: (formData: FormData) => void, isPending: boolean];
@@ -152,18 +153,24 @@ type CommonKeys<V> = keyof V;
 type AllKeys<V> = V extends unknown ? keyof V : never;
 type VariantKeys<V> = Exclude<AllKeys<V>, CommonKeys<V>> & string;
 type VariantFieldPath<V, D extends PathDepth = DefaultPathDepth> = Exclude<V extends unknown ? FieldPath<V, D> : never, (CommonKeys<V> & string) | `${CommonKeys<V> & string}.${string}`> & string;
-type UnionValueAt<TValues, P extends string> = P extends keyof TValues ? NonNullable<TValues[P]> : TValues extends readonly (infer Item)[] ? P extends `${number}` ? NonNullable<Item> : P extends `${infer Head}.${infer Tail}` ? Head extends keyof TValues ? UnionValueAt<NonNullable<TValues[Head]>, Tail> : Head extends `${number}` ? UnionValueAt<NonNullable<Item>, Tail> : never : never : P extends `${infer Head}.${infer Tail}` ? Head extends keyof TValues ? UnionValueAt<NonNullable<TValues[Head]>, Tail> : never : never;
+type MemberValueAt<TValues, K extends string> = TValues extends unknown ? K extends keyof TValues ? TValues[K] : never : never;
+type UnionValueAt<TValues, P extends string> = [
+    MemberValueAt<TValues, P>
+] extends [never] ? UnionValueAtDeep<TValues, P> : NonNullable<MemberValueAt<TValues, P>>;
+type UnionValueAtDeep<TValues, P extends string> = P extends keyof TValues ? NonNullable<TValues[P]> : TValues extends readonly (infer Item)[] ? P extends `${number}` ? NonNullable<Item> : P extends `${infer Head}.${infer Tail}` ? [
+    MemberValueAt<TValues, Head>
+] extends [never] ? Head extends `${number}` ? UnionValueAt<NonNullable<Item>, Tail> : never : UnionValueAt<NonNullable<MemberValueAt<TValues, Head>>, Tail> : never : P extends `${infer Head}.${infer Tail}` ? [MemberValueAt<TValues, Head>] extends [never] ? never : UnionValueAt<NonNullable<MemberValueAt<TValues, Head>>, Tail> : never;
 declare const inferredCallsOnly$2: unique symbol;
 interface InferredTypeArg$2 {
     readonly [inferredCallsOnly$2]: typeof inferredCallsOnly$2;
 }
 declare function useVariantField<TValue = InferredTypeArg$2>(form: FieldFormApi & Readonly<{
     schema: z.ZodType;
-}>, unionPath: TValue extends InferredTypeArg$2 ? never : "Remove the explicit type argument: a schema-typed form infers the variant value from the union path and field", field: string): UseFieldReturn<TValue | undefined>;
+}>, unionPath: TValue extends InferredTypeArg$2 ? never : "Remove the explicit type argument: a schema-typed form infers the variant value from the union path and field", field: string, options?: UseFieldOptions): UseFieldReturn<TValue | undefined>;
 declare function useVariantField<TValue = unknown>(form: FieldFormApi & {
     readonly schema?: undefined;
-}, unionPath: string, field: string): UseFieldReturn<TValue | undefined>;
-declare function useVariantField<TSchema extends z.ZodType, P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, unionPath: P, field: TField): UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
+}, unionPath: string, field: string, options?: UseFieldOptions): UseFieldReturn<TValue | undefined>;
+declare function useVariantField<TSchema extends z.ZodType, P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>, D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, unionPath: P, field: TField, options?: UseFieldOptions): UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
 
 type ReadonlyStore$1<T> = Pick<StoreApi<T>, "getState" | "getInitialState" | "subscribe">;
 type FieldArrayFormApi = Readonly<{
@@ -174,6 +181,7 @@ type FieldArrayFormApi = Readonly<{
     arrayMove(path: string, from: number, to: number): void;
     arraySwap(path: string, a: number, b: number): void;
     validateField?(path: string): FieldValidationResult;
+    validateFieldAsync?(path: string): Promise<SettledFieldValidationResult>;
     setError?(path: string, errors: string | readonly string[]): void;
     clearErrors?(path?: string): void;
     setTouched?(path: string, touched?: boolean): void;
@@ -198,6 +206,7 @@ type UseFieldArrayReturn<TItem> = Readonly<{
     setTouched: (touched?: boolean) => void;
     onBlur: () => void;
     validate: () => FieldValidationResult;
+    validateAsync: () => Promise<SettledFieldValidationResult>;
     push: (item: TItem) => void;
     remove: (index: number) => void;
     insert: (index: number, item: TItem) => void;
@@ -248,8 +257,8 @@ type UseFieldsReturn<TFields extends readonly unknown[]> = Readonly<{
 }>;
 declare function useFields(form: FieldFormApi & {
     readonly schema?: undefined;
-}, paths: readonly string[]): UseFieldsReturn<readonly UseFieldReturn<unknown>[]>;
-declare function useFields<TSchema extends z.ZodType, const P extends readonly FieldPath<z.input<TSchema>, D>[], D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, paths: P): UseFieldsReturn<{
+}, paths: readonly string[], options?: UseFieldOptions): UseFieldsReturn<readonly UseFieldReturn<unknown>[]>;
+declare function useFields<TSchema extends z.ZodType, const P extends readonly FieldPath<z.input<TSchema>, D>[], D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, paths: P, options?: UseFieldOptions): UseFieldsReturn<{
     readonly [K in keyof P]: UseFieldReturn<FieldValue<z.input<TSchema>, P[K] & string>>;
 }>;
 
@@ -257,7 +266,7 @@ type BoundUseField<TSchema extends z.ZodType, D extends PathDepth = DefaultPathD
     (pathSelector: (state: FormState<z.input<TSchema>>) => string, options?: UseFieldOptions): UseFieldReturn<unknown>;
     <P extends FieldPath<z.input<TSchema>, D>>(path: P, options?: UseFieldOptions): UseFieldReturn<FieldValue<z.input<TSchema>, P>>;
 };
-type BoundUseVariantField<TSchema extends z.ZodType> = <P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField) => UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
+type BoundUseVariantField<TSchema extends z.ZodType> = <P extends string, TField extends VariantFieldPath<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField, options?: UseFieldOptions) => UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
 type BoundUseVariantFieldArray<TSchema extends z.ZodType> = <P extends string, TField extends VariantArrayFieldPath<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField) => UseFieldArrayReturn<ArrayItemOf<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField>>>;
 type BoundUseFieldArray<TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth> = {
     (pathSelector: (state: FormState<z.input<TSchema>>) => string): UseFieldArrayReturn<unknown>;
@@ -305,7 +314,7 @@ type FormHooks<TSchema extends z.ZodType, N extends string, D extends PathDepth
 } & {
     [K in `use${Capitalize<N>}Persist`]: BoundUsePersist<TSchema>;
 }>;
-type BoundUseFields<TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth> = <const P extends readonly FieldPath<z.input<TSchema>, D>[]>(paths: P) => UseFieldsReturn<{
+type BoundUseFields<TSchema extends z.ZodType, D extends PathDepth = DefaultPathDepth> = <const P extends readonly FieldPath<z.input<TSchema>, D>[]>(paths: P, options?: UseFieldOptions) => UseFieldsReturn<{
     readonly [K in keyof P]: UseFieldReturn<FieldValue<z.input<TSchema>, P[K] & string>>;
 }>;
 declare const createFormHooks: <TSchema extends z.ZodType, N extends string = "", D extends PathDepth = DefaultPathDepth>(form: Form<TSchema, D>, name?: N) => FormHooks<TSchema, N, D>;