formstand 0.7.0 → 0.9.0

package/dist/index.d.cts

@@ -67,6 +67,7 @@ type CreateFormOptions<TSchema extends z.ZodType> = Readonly<{
     mode?: ValidationMode;
     reValidateMode?: ValidationMode;
     validateOnMount?: boolean;
+    devtools?: boolean | string;
 }>;
 type SubmitHandler<TSchema extends z.ZodType> = (data: z.output<TSchema>) => void | Promise<void>;
 type InvalidSubmitHandler = (errors: ErrorMap) => void;
@@ -149,6 +150,24 @@ declare const parsePath: (path: string) => readonly PathSegment[];
 declare const getAtPath: (obj: unknown, path: string) => unknown;
 declare const setAtPath: <T>(obj: T, path: string, value: unknown) => T;
 
+type PersistStorage = Readonly<{
+    getItem: (key: string) => string | null;
+    setItem: (key: string, value: string) => void;
+    removeItem: (key: string) => void;
+}>;
+type PersistOptions<TSchema extends z.ZodType> = Readonly<{
+    key: string;
+    storage?: PersistStorage;
+    debounceMs?: number;
+    apply?: "adopt" | "restore" | "manual";
+}>;
+type PersistHandle = Readonly<{
+    restore: () => boolean;
+    clear: () => void;
+    dispose: () => void;
+}>;
+declare const persistForm: <TSchema extends z.ZodType>(form: Form<TSchema>, options: PersistOptions<TSchema>) => PersistHandle;
+
 declare const useForm: <TSchema extends z.ZodType>(schema: TSchema, options: CreateFormOptions<TSchema>) => Form<TSchema>;
 
 type FormProviderProps<TSchema extends z.ZodType> = Readonly<{
@@ -198,6 +217,16 @@ declare function useField<TValue = unknown>(form: FieldFormApi & {
 }, path: string | ((state: FormState<unknown>) => string), options?: UseFieldOptions): UseFieldReturn<TValue>;
 declare function useField<TSchema extends z.ZodType, P extends FieldPath<z.input<TSchema>>>(form: Form<TSchema>, path: P, options?: UseFieldOptions): UseFieldReturn<FieldValue<z.input<TSchema>, P>>;
 
+type VariantFieldValue<V, TField extends string> = V extends unknown ? TField extends keyof V ? V[TField] : never : never;
+type CommonKeys<V> = keyof V;
+type AllKeys<V> = V extends unknown ? keyof V : never;
+type VariantKeys<V> = Exclude<AllKeys<V>, CommonKeys<V>> & string;
+type UnionValueAt<TValues, P extends string> = P extends keyof TValues ? NonNullable<TValues[P]> : P extends `${infer Head}.${infer Tail}` ? Head extends keyof TValues ? UnionValueAt<NonNullable<TValues[Head]>, Tail> : never : never;
+declare function useVariantField<TSchema extends z.ZodType, P extends string, TField extends VariantKeys<UnionValueAt<z.input<TSchema>, P>>>(form: Form<TSchema>, unionPath: P, field: TField): UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
+declare function useVariantField<TValue = unknown>(form: FieldFormApi & {
+    readonly schema?: undefined;
+}, unionPath: string, field: string): UseFieldReturn<TValue | undefined>;
+
 type ReadonlyStore$1<T> = Pick<StoreApi<T>, "getState" | "getInitialState" | "subscribe">;
 type FieldArrayFormApi = Readonly<{
     store: ReadonlyStore$1<FormState<unknown>>;
@@ -233,6 +262,7 @@ type BoundUseField<TSchema extends z.ZodType> = {
     (pathSelector: (state: FormState<z.input<TSchema>>) => string, options?: UseFieldOptions): UseFieldReturn<unknown>;
     <P extends FieldPath<z.input<TSchema>>>(path: P, options?: UseFieldOptions): UseFieldReturn<FieldValue<z.input<TSchema>, P>>;
 };
+type BoundUseVariantField<TSchema extends z.ZodType> = <P extends string, TField extends VariantKeys<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField) => UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
 type BoundUseFieldArray<TSchema extends z.ZodType> = {
     (pathSelector: (state: FormState<z.input<TSchema>>) => string): UseFieldArrayReturn<unknown>;
     <P extends FieldPath<z.input<TSchema>>>(path: P): UseFieldArrayReturn<ArrayItemOf<FieldValue<z.input<TSchema>, P>>>;
@@ -241,6 +271,8 @@ type BoundUseSelector<TSchema extends z.ZodType> = <U>(selector: (state: FormSta
 type BoundUseFlag<TSchema extends z.ZodType> = (path?: FieldPath<z.input<TSchema>>) => boolean;
 type FormHooks<TSchema extends z.ZodType, N extends string> = Readonly<{
     [K in `use${Capitalize<N>}Field`]: BoundUseField<TSchema>;
+} & {
+    [K in `use${Capitalize<N>}VariantField`]: BoundUseVariantField<TSchema>;
 } & {
     [K in `use${Capitalize<N>}FieldArray`]: BoundUseFieldArray<TSchema>;
 } & {
@@ -300,6 +332,15 @@ type TextFieldProps<F extends FieldFormApi = FieldFormApi> = Readonly<{
     ref?: FieldRef<HTMLInputElement>;
 }>;
 declare const TextField: <F extends FieldFormApi>({ form, path, label, placeholder, type, autoComplete, ref, }: TextFieldProps<F>) => react.JSX.Element;
+type DateFieldProps<F extends FieldFormApi = FieldFormApi> = Readonly<{
+    form: F;
+    path: PathsOf<F>;
+    label?: ReactNode;
+    min?: string;
+    max?: string;
+    ref?: FieldRef<HTMLInputElement>;
+}>;
+declare const DateField: <F extends FieldFormApi>({ form, path, label, min, max, ref, }: DateFieldProps<F>) => react.JSX.Element;
 type NumberFieldProps<F extends FieldFormApi = FieldFormApi> = Readonly<{
     form: F;
     path: PathsOf<F>;
@@ -347,6 +388,14 @@ type NumberInputProps = Readonly<{
     onChange: (e: ChangeEvent<HTMLInputElement>) => void;
     onBlur: () => void;
 }>;
+type DateInputProps = Readonly<{
+    type: "date";
+    name: string;
+    value: string;
+    "aria-invalid": true | undefined;
+    onChange: (e: ChangeEvent<HTMLInputElement>) => void;
+    onBlur: () => void;
+}>;
 type CheckboxProps = Readonly<{
     type: "checkbox";
     name: string;
@@ -374,7 +423,18 @@ type ParsedNumberText = Readonly<{
 declare const parseNumberText: (text: string) => ParsedNumberText;
 declare const textInputProps: <T extends string | null | undefined>(field: UseFieldReturn<T>) => TextInputProps;
 declare const numberInputProps: <T extends number | null | undefined>(field: UseFieldReturn<T>) => NumberInputProps;
+declare const dateToInputText: (value: Date | null | undefined) => string;
+type ParsedDateText = Readonly<{
+    kind: "empty";
+}> | Readonly<{
+    kind: "date";
+    value: Date;
+}> | Readonly<{
+    kind: "invalid";
+}>;
+declare const parseDateText: (text: string) => ParsedDateText;
+declare const dateInputProps: <T extends Date | null | undefined>(field: UseFieldReturn<T>) => DateInputProps;
 declare const checkboxProps: <T extends boolean | null | undefined>(field: UseFieldReturn<T>) => CheckboxProps;
 declare const selectProps: <T extends string | null | undefined>(field: UseFieldReturn<T>) => SelectProps;
 
-export { type BoolMap, type BoundUseField, type BoundUseFieldArray, type BoundUseFlag, type BoundUseSelector, CheckboxField, type CheckboxFieldProps, type CheckboxProps, type CreateFormOptions, type ErrorMap, type FieldArrayEntry, type FieldArrayFormApi, type FieldFormApi, type FieldPath, type FieldPathArg, type FieldRef, type FieldSnapshot, type FieldValidationResult, type FieldValue, type Form, type FormContextApi, type FormHooks, type FormProviderProps, type FormState, type FormStateApi, type InvalidSubmitHandler, NumberField, type NumberFieldProps, type NumberInputProps, type ParsedNumberText, type PathSegment, type PathsOf, type ReadonlyStoreApi, type ResetOptions, SelectField, type SelectFieldOption, type SelectFieldProps, type SelectProps, type SettledFieldValidationResult, type SettledValidationResult, type SubmitHandler, type SubmitOptions, type SubmitResult, TextField, type TextFieldProps, type TextInputProps, type UseFieldArrayReturn, type UseFieldOptions, type UseFieldReturn, type ValidationMode, type ValidationResult, type ValidationTrigger, checkboxProps, createForm, createFormContext, createFormHooks, emptyValueForSchema, flattenIssues, focusField, focusFirstError, getAtPath, isAsyncRequiredError, numberInputProps, numberToInputText, parseNumberText, parsePath, selectProps, setAtPath, shouldValidateOn, textInputProps, useField, useFieldArray, useForm, useFormError, useFormSelector, useFormSelectorShallow, useIsDirty, useIsSubmitting, useIsValid, useSubmitCount, validateAsync, validateSync };
+export { type BoolMap, type BoundUseField, type BoundUseFieldArray, type BoundUseFlag, type BoundUseSelector, CheckboxField, type CheckboxFieldProps, type CheckboxProps, type CreateFormOptions, DateField, type DateFieldProps, type DateInputProps, type ErrorMap, type FieldArrayEntry, type FieldArrayFormApi, type FieldFormApi, type FieldPath, type FieldPathArg, type FieldRef, type FieldSnapshot, type FieldValidationResult, type FieldValue, type Form, type FormContextApi, type FormHooks, type FormProviderProps, type FormState, type FormStateApi, type InvalidSubmitHandler, NumberField, type NumberFieldProps, type NumberInputProps, type ParsedDateText, type ParsedNumberText, type PathSegment, type PathsOf, type PersistHandle, type PersistOptions, type PersistStorage, type ReadonlyStoreApi, type ResetOptions, SelectField, type SelectFieldOption, type SelectFieldProps, type SelectProps, type SettledFieldValidationResult, type SettledValidationResult, type SubmitHandler, type SubmitOptions, type SubmitResult, TextField, type TextFieldProps, type TextInputProps, type UseFieldArrayReturn, type UseFieldOptions, type UseFieldReturn, type ValidationMode, type ValidationResult, type ValidationTrigger, checkboxProps, createForm, createFormContext, createFormHooks, dateInputProps, dateToInputText, emptyValueForSchema, flattenIssues, focusField, focusFirstError, getAtPath, isAsyncRequiredError, numberInputProps, numberToInputText, parseDateText, parseNumberText, parsePath, persistForm, selectProps, setAtPath, shouldValidateOn, textInputProps, useField, useFieldArray, useForm, useFormError, useFormSelector, useFormSelectorShallow, useIsDirty, useIsSubmitting, useIsValid, useSubmitCount, useVariantField, validateAsync, validateSync };

package/dist/index.d.ts

@@ -67,6 +67,7 @@ type CreateFormOptions<TSchema extends z.ZodType> = Readonly<{
     mode?: ValidationMode;
     reValidateMode?: ValidationMode;
     validateOnMount?: boolean;
+    devtools?: boolean | string;
 }>;
 type SubmitHandler<TSchema extends z.ZodType> = (data: z.output<TSchema>) => void | Promise<void>;
 type InvalidSubmitHandler = (errors: ErrorMap) => void;
@@ -149,6 +150,24 @@ declare const parsePath: (path: string) => readonly PathSegment[];
 declare const getAtPath: (obj: unknown, path: string) => unknown;
 declare const setAtPath: <T>(obj: T, path: string, value: unknown) => T;
 
+type PersistStorage = Readonly<{
+    getItem: (key: string) => string | null;
+    setItem: (key: string, value: string) => void;
+    removeItem: (key: string) => void;
+}>;
+type PersistOptions<TSchema extends z.ZodType> = Readonly<{
+    key: string;
+    storage?: PersistStorage;
+    debounceMs?: number;
+    apply?: "adopt" | "restore" | "manual";
+}>;
+type PersistHandle = Readonly<{
+    restore: () => boolean;
+    clear: () => void;
+    dispose: () => void;
+}>;
+declare const persistForm: <TSchema extends z.ZodType>(form: Form<TSchema>, options: PersistOptions<TSchema>) => PersistHandle;
+
 declare const useForm: <TSchema extends z.ZodType>(schema: TSchema, options: CreateFormOptions<TSchema>) => Form<TSchema>;
 
 type FormProviderProps<TSchema extends z.ZodType> = Readonly<{
@@ -198,6 +217,16 @@ declare function useField<TValue = unknown>(form: FieldFormApi & {
 }, path: string | ((state: FormState<unknown>) => string), options?: UseFieldOptions): UseFieldReturn<TValue>;
 declare function useField<TSchema extends z.ZodType, P extends FieldPath<z.input<TSchema>>>(form: Form<TSchema>, path: P, options?: UseFieldOptions): UseFieldReturn<FieldValue<z.input<TSchema>, P>>;
 
+type VariantFieldValue<V, TField extends string> = V extends unknown ? TField extends keyof V ? V[TField] : never : never;
+type CommonKeys<V> = keyof V;
+type AllKeys<V> = V extends unknown ? keyof V : never;
+type VariantKeys<V> = Exclude<AllKeys<V>, CommonKeys<V>> & string;
+type UnionValueAt<TValues, P extends string> = P extends keyof TValues ? NonNullable<TValues[P]> : P extends `${infer Head}.${infer Tail}` ? Head extends keyof TValues ? UnionValueAt<NonNullable<TValues[Head]>, Tail> : never : never;
+declare function useVariantField<TSchema extends z.ZodType, P extends string, TField extends VariantKeys<UnionValueAt<z.input<TSchema>, P>>>(form: Form<TSchema>, unionPath: P, field: TField): UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
+declare function useVariantField<TValue = unknown>(form: FieldFormApi & {
+    readonly schema?: undefined;
+}, unionPath: string, field: string): UseFieldReturn<TValue | undefined>;
+
 type ReadonlyStore$1<T> = Pick<StoreApi<T>, "getState" | "getInitialState" | "subscribe">;
 type FieldArrayFormApi = Readonly<{
     store: ReadonlyStore$1<FormState<unknown>>;
@@ -233,6 +262,7 @@ type BoundUseField<TSchema extends z.ZodType> = {
     (pathSelector: (state: FormState<z.input<TSchema>>) => string, options?: UseFieldOptions): UseFieldReturn<unknown>;
     <P extends FieldPath<z.input<TSchema>>>(path: P, options?: UseFieldOptions): UseFieldReturn<FieldValue<z.input<TSchema>, P>>;
 };
+type BoundUseVariantField<TSchema extends z.ZodType> = <P extends string, TField extends VariantKeys<UnionValueAt<z.input<TSchema>, P>>>(unionPath: P, field: TField) => UseFieldReturn<VariantFieldValue<UnionValueAt<z.input<TSchema>, P>, TField> | undefined>;
 type BoundUseFieldArray<TSchema extends z.ZodType> = {
     (pathSelector: (state: FormState<z.input<TSchema>>) => string): UseFieldArrayReturn<unknown>;
     <P extends FieldPath<z.input<TSchema>>>(path: P): UseFieldArrayReturn<ArrayItemOf<FieldValue<z.input<TSchema>, P>>>;
@@ -241,6 +271,8 @@ type BoundUseSelector<TSchema extends z.ZodType> = <U>(selector: (state: FormSta
 type BoundUseFlag<TSchema extends z.ZodType> = (path?: FieldPath<z.input<TSchema>>) => boolean;
 type FormHooks<TSchema extends z.ZodType, N extends string> = Readonly<{
     [K in `use${Capitalize<N>}Field`]: BoundUseField<TSchema>;
+} & {
+    [K in `use${Capitalize<N>}VariantField`]: BoundUseVariantField<TSchema>;
 } & {
     [K in `use${Capitalize<N>}FieldArray`]: BoundUseFieldArray<TSchema>;
 } & {
@@ -300,6 +332,15 @@ type TextFieldProps<F extends FieldFormApi = FieldFormApi> = Readonly<{
     ref?: FieldRef<HTMLInputElement>;
 }>;
 declare const TextField: <F extends FieldFormApi>({ form, path, label, placeholder, type, autoComplete, ref, }: TextFieldProps<F>) => react.JSX.Element;
+type DateFieldProps<F extends FieldFormApi = FieldFormApi> = Readonly<{
+    form: F;
+    path: PathsOf<F>;
+    label?: ReactNode;
+    min?: string;
+    max?: string;
+    ref?: FieldRef<HTMLInputElement>;
+}>;
+declare const DateField: <F extends FieldFormApi>({ form, path, label, min, max, ref, }: DateFieldProps<F>) => react.JSX.Element;
 type NumberFieldProps<F extends FieldFormApi = FieldFormApi> = Readonly<{
     form: F;
     path: PathsOf<F>;
@@ -347,6 +388,14 @@ type NumberInputProps = Readonly<{
     onChange: (e: ChangeEvent<HTMLInputElement>) => void;
     onBlur: () => void;
 }>;
+type DateInputProps = Readonly<{
+    type: "date";
+    name: string;
+    value: string;
+    "aria-invalid": true | undefined;
+    onChange: (e: ChangeEvent<HTMLInputElement>) => void;
+    onBlur: () => void;
+}>;
 type CheckboxProps = Readonly<{
     type: "checkbox";
     name: string;
@@ -374,7 +423,18 @@ type ParsedNumberText = Readonly<{
 declare const parseNumberText: (text: string) => ParsedNumberText;
 declare const textInputProps: <T extends string | null | undefined>(field: UseFieldReturn<T>) => TextInputProps;
 declare const numberInputProps: <T extends number | null | undefined>(field: UseFieldReturn<T>) => NumberInputProps;
+declare const dateToInputText: (value: Date | null | undefined) => string;
+type ParsedDateText = Readonly<{
+    kind: "empty";
+}> | Readonly<{
+    kind: "date";
+    value: Date;
+}> | Readonly<{
+    kind: "invalid";
+}>;
+declare const parseDateText: (text: string) => ParsedDateText;
+declare const dateInputProps: <T extends Date | null | undefined>(field: UseFieldReturn<T>) => DateInputProps;
 declare const checkboxProps: <T extends boolean | null | undefined>(field: UseFieldReturn<T>) => CheckboxProps;
 declare const selectProps: <T extends string | null | undefined>(field: UseFieldReturn<T>) => SelectProps;
 
-export { type BoolMap, type BoundUseField, type BoundUseFieldArray, type BoundUseFlag, type BoundUseSelector, CheckboxField, type CheckboxFieldProps, type CheckboxProps, type CreateFormOptions, type ErrorMap, type FieldArrayEntry, type FieldArrayFormApi, type FieldFormApi, type FieldPath, type FieldPathArg, type FieldRef, type FieldSnapshot, type FieldValidationResult, type FieldValue, type Form, type FormContextApi, type FormHooks, type FormProviderProps, type FormState, type FormStateApi, type InvalidSubmitHandler, NumberField, type NumberFieldProps, type NumberInputProps, type ParsedNumberText, type PathSegment, type PathsOf, type ReadonlyStoreApi, type ResetOptions, SelectField, type SelectFieldOption, type SelectFieldProps, type SelectProps, type SettledFieldValidationResult, type SettledValidationResult, type SubmitHandler, type SubmitOptions, type SubmitResult, TextField, type TextFieldProps, type TextInputProps, type UseFieldArrayReturn, type UseFieldOptions, type UseFieldReturn, type ValidationMode, type ValidationResult, type ValidationTrigger, checkboxProps, createForm, createFormContext, createFormHooks, emptyValueForSchema, flattenIssues, focusField, focusFirstError, getAtPath, isAsyncRequiredError, numberInputProps, numberToInputText, parseNumberText, parsePath, selectProps, setAtPath, shouldValidateOn, textInputProps, useField, useFieldArray, useForm, useFormError, useFormSelector, useFormSelectorShallow, useIsDirty, useIsSubmitting, useIsValid, useSubmitCount, validateAsync, validateSync };
+export { type BoolMap, type BoundUseField, type BoundUseFieldArray, type BoundUseFlag, type BoundUseSelector, CheckboxField, type CheckboxFieldProps, type CheckboxProps, type CreateFormOptions, DateField, type DateFieldProps, type DateInputProps, type ErrorMap, type FieldArrayEntry, type FieldArrayFormApi, type FieldFormApi, type FieldPath, type FieldPathArg, type FieldRef, type FieldSnapshot, type FieldValidationResult, type FieldValue, type Form, type FormContextApi, type FormHooks, type FormProviderProps, type FormState, type FormStateApi, type InvalidSubmitHandler, NumberField, type NumberFieldProps, type NumberInputProps, type ParsedDateText, type ParsedNumberText, type PathSegment, type PathsOf, type PersistHandle, type PersistOptions, type PersistStorage, type ReadonlyStoreApi, type ResetOptions, SelectField, type SelectFieldOption, type SelectFieldProps, type SelectProps, type SettledFieldValidationResult, type SettledValidationResult, type SubmitHandler, type SubmitOptions, type SubmitResult, TextField, type TextFieldProps, type TextInputProps, type UseFieldArrayReturn, type UseFieldOptions, type UseFieldReturn, type ValidationMode, type ValidationResult, type ValidationTrigger, checkboxProps, createForm, createFormContext, createFormHooks, dateInputProps, dateToInputText, emptyValueForSchema, flattenIssues, focusField, focusFirstError, getAtPath, isAsyncRequiredError, numberInputProps, numberToInputText, parseDateText, parseNumberText, parsePath, persistForm, selectProps, setAtPath, shouldValidateOn, textInputProps, useField, useFieldArray, useForm, useFormError, useFormSelector, useFormSelectorShallow, useIsDirty, useIsSubmitting, useIsValid, useSubmitCount, useVariantField, validateAsync, validateSync };