@tanstack/react-form 0.0.10 → 0.0.11

package/build/types/form-core/src/FieldApi.d.ts

@@ -1,17 +1,23 @@
-import type { DeepKeys, DeepValue, RequiredByKey, Updater } from './utils';
+import type { DeepKeys, DeepValue, Updater } from './utils';
 import type { FormApi, ValidationError } from './FormApi';
 import { Store } from '@tanstack/store';
 export type ValidationCause = 'change' | 'blur' | 'submit';
+type ValidateFn<TData, TFormData> = (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError;
+type ValidateAsyncFn<TData, TFormData> = (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError | Promise<ValidationError>;
 export interface FieldOptions<TData, TFormData> {
     name: unknown extends TFormData ? string : DeepKeys<TFormData>;
     index?: TData extends any[] ? number : never;
     defaultValue?: TData;
-    validate?: (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError;
-    validateAsync?: (value: TData, fieldApi: FieldApi<TData, TFormData>) => ValidationError | Promise<ValidationError>;
-    validatePristine?: boolean;
-    validateOn?: ValidationCause;
-    validateAsyncOn?: ValidationCause;
-    validateAsyncDebounceMs?: number;
+    asyncDebounceMs?: number;
+    asyncAlways?: boolean;
+    onMount?: (formApi: FieldApi<TData, TFormData>) => void;
+    onChange?: ValidateFn<TData, TFormData>;
+    onChangeAsync?: ValidateAsyncFn<TData, TFormData>;
+    onChangeAsyncDebounceMs?: number;
+    onBlur?: ValidateFn<TData, TFormData>;
+    onBlurAsync?: ValidateAsyncFn<TData, TFormData>;
+    onBlurAsyncDebounceMs?: number;
+    onSubmitAsync?: ValidateAsyncFn<TData, TFormData>;
     defaultMeta?: Partial<FieldMeta>;
 }
 export type FieldApiOptions<TData, TFormData> = FieldOptions<TData, TFormData> & {
@@ -33,7 +39,7 @@ export type UserInputProps = {
 };
 export type ChangeProps<TData> = {
     value: TData;
-    onChange: (updater: Updater<TData>) => void;
+    onChange: (value: TData) => void;
     onBlur: (event: any) => void;
 };
 export type InputProps = {
@@ -52,7 +58,7 @@ export declare class FieldApi<TData, TFormData> {
     name: DeepKeys<TFormData>;
     store: Store<FieldState<TData>>;
     state: FieldState<TData>;
-    options: RequiredByKey<FieldOptions<TData, TFormData>, 'validatePristine' | 'validateOn' | 'validateAsyncOn' | 'validateAsyncDebounceMs'>;
+    options: FieldOptions<TData, TFormData>;
     constructor(opts: FieldApiOptions<TData, TFormData>);
     mount: () => () => void;
     update: (opts: FieldApiOptions<TData, TFormData>) => void;
@@ -69,11 +75,11 @@ export declare class FieldApi<TData, TFormData> {
     removeValue: (index: number) => void;
     swapValues: (aIndex: number, bIndex: number) => void;
     getSubField: <TName extends DeepKeys<TData>>(name: TName) => FieldApi<DeepValue<TData, TName>, TFormData>;
-    validateSync: (value?: TData) => Promise<void>;
+    validateSync: (value: TData | undefined, cause: ValidationCause) => Promise<void>;
     cancelValidateAsync: () => void;
-    validateAsync: (value?: TData) => Promise<ValidationError>;
-    shouldValidate: (isAsync: boolean, cause?: ValidationCause) => boolean;
-    validate: (cause?: ValidationCause, value?: TData) => Promise<ValidationError>;
+    validateAsync: (value: TData | undefined, cause: ValidationCause) => Promise<ValidationError>;
+    validate: (cause: ValidationCause, value?: TData) => ValidationError | Promise<ValidationError>;
     getChangeProps: <T extends UserChangeProps<any>>(props?: T) => ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>>;
     getInputProps: <T extends UserInputProps>(props?: T) => InputProps & Omit<T, keyof InputProps>;
 }
+export {};

package/build/types/form-core/src/FormApi.d.ts

@@ -9,13 +9,18 @@ export type FormSubmitEvent = Register extends {
 export type FormOptions<TData> = {
     defaultValues?: TData;
     defaultState?: Partial<FormState<TData>>;
-    onSubmit?: (values: TData, formApi: FormApi<TData>) => void;
-    onInvalidSubmit?: (values: TData, formApi: FormApi<TData>) => void;
-    validate?: (values: TData, formApi: FormApi<TData>) => Promise<any>;
-    defaultValidatePristine?: boolean;
-    defaultValidateOn?: ValidationCause;
-    defaultValidateAsyncOn?: ValidationCause;
-    defaultValidateAsyncDebounceMs?: number;
+    asyncDebounceMs?: number;
+    onMount?: (values: TData, formApi: FormApi<TData>) => ValidationError;
+    onMountAsync?: (values: TData, formApi: FormApi<TData>) => ValidationError | Promise<ValidationError>;
+    onMountAsyncDebounceMs?: number;
+    onChange?: (values: TData, formApi: FormApi<TData>) => ValidationError;
+    onChangeAsync?: (values: TData, formApi: FormApi<TData>) => ValidationError | Promise<ValidationError>;
+    onChangeAsyncDebounceMs?: number;
+    onBlur?: (values: TData, formApi: FormApi<TData>) => ValidationError;
+    onBlurAsync?: (values: TData, formApi: FormApi<TData>) => ValidationError | Promise<ValidationError>;
+    onBlurAsyncDebounceMs?: number;
+    onSubmit?: (values: TData, formApi: FormApi<TData>) => any | Promise<any>;
+    onSubmitInvalid?: (values: TData, formApi: FormApi<TData>) => void;
 };
 export type FieldInfo<TFormData> = {
     instances: Record<string, FieldApi<any, TFormData>>;
@@ -55,8 +60,7 @@ export declare class FormApi<TFormData> {
     constructor(opts?: FormOptions<TFormData>);
     update: (options?: FormOptions<TFormData>) => void;
     reset: () => void;
-    validateAllFields: () => Promise<ValidationError[]>;
-    validateForm: () => Promise<ValidationError>;
+    validateAllFields: (cause: ValidationCause) => Promise<ValidationError[]>;
     handleSubmit: (e: FormSubmitEvent) => Promise<void>;
     getFieldValue: <TField extends DeepKeys<TFormData>>(field: TField) => DeepValue<TFormData, TField>;
     getFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField) => FieldMeta;