@tanstack/form-core 1.15.1 → 1.17.0

package/src/FormApi.ts

@@ -11,12 +11,14 @@ import {
   isNonEmptyArray,
   setBy,
 } from './utils'
+import { defaultValidationLogic } from './ValidationLogic'
 
 import {
   isStandardSchemaValidator,
   standardSchemaValidators,
 } from './standardSchemaValidator'
 import { defaultFieldMeta, metaHelper } from './metaHelper'
+import type { ValidationLogicFn } from './ValidationLogic'
 import type {
   StandardSchemaV1,
   StandardSchemaV1Issue,
@@ -84,6 +86,8 @@ export type FormValidateFn<TFormData> = (props: {
     any,
     any,
     any,
+    any,
+    any,
     any
   >
 }) => unknown
@@ -120,6 +124,8 @@ export type FormValidateAsyncFn<TFormData> = (props: {
     any,
     any,
     any,
+    any,
+    any,
     any
   >
   signal: AbortSignal
@@ -164,6 +170,8 @@ export interface FormValidators<
   TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
 > {
   /**
    * Optional function that fires as soon as the component mounts.
@@ -195,6 +203,9 @@ export interface FormValidators<
   onBlurAsyncDebounceMs?: number
   onSubmit?: TOnSubmit
   onSubmitAsync?: TOnSubmitAsync
+  onDynamic?: TOnDynamic
+  onDynamicAsync?: TOnDynamicAsync
+  onDynamicAsyncDebounceMs?: number
 }
 
 /**
@@ -209,6 +220,8 @@ export interface FormTransform<
   TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
   TSubmitMeta = never,
 > {
@@ -222,6 +235,8 @@ export interface FormTransform<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >,
@@ -234,6 +249,8 @@ export interface FormTransform<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TOnServer,
     TSubmitMeta
   >
@@ -249,6 +266,8 @@ export interface FormListeners<
   TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
   TSubmitMeta = never,
 > {
@@ -262,6 +281,8 @@ export interface FormListeners<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >
@@ -279,6 +300,8 @@ export interface FormListeners<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >
@@ -296,6 +319,8 @@ export interface FormListeners<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >
@@ -311,9 +336,12 @@ export interface FormListeners<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >
+    meta: TSubmitMeta
   }) => void
 }
 
@@ -343,6 +371,8 @@ export interface FormOptions<
   in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  in out TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  in out TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TSubmitMeta = never,
 > extends BaseFormOptions<TFormData, TSubmitMeta> {
@@ -359,6 +389,8 @@ export interface FormOptions<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer
     >
   >
@@ -385,9 +417,13 @@ export interface FormOptions<
     TOnBlur,
     TOnBlurAsync,
     TOnSubmit,
-    TOnSubmitAsync
+    TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync
   >
 
+  validationLogic?: ValidationLogicFn
+
   /**
    * form level listeners
    */
@@ -400,6 +436,8 @@ export interface FormOptions<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TOnServer,
     TSubmitMeta
   >
@@ -418,6 +456,8 @@ export interface FormOptions<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >
@@ -437,9 +477,12 @@ export interface FormOptions<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >
+    meta: TSubmitMeta
   }) => void
   transform?: FormTransform<
     NoInfer<TFormData>,
@@ -450,6 +493,8 @@ export interface FormOptions<
     NoInfer<TOnBlurAsync>,
     NoInfer<TOnSubmit>,
     NoInfer<TOnSubmitAsync>,
+    NoInfer<TOnDynamic>,
+    NoInfer<TOnDynamicAsync>,
     NoInfer<TOnServer>,
     NoInfer<TSubmitMeta>
   >
@@ -491,6 +536,10 @@ export type FieldInfo<TFormData> = {
     any,
     any,
     any,
+    any,
+    any,
+    any,
+    any,
     any
   > | null
   /**
@@ -511,6 +560,8 @@ export type BaseFormState<
   in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  in out TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  in out TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
 > = {
   /**
@@ -528,6 +579,8 @@ export type BaseFormState<
     UnwrapFormAsyncValidateOrFn<TOnBlurAsync>,
     UnwrapFormValidateOrFn<TOnSubmit>,
     UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>,
+    UnwrapFormValidateOrFn<TOnDynamic>,
+    UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>,
     UnwrapFormAsyncValidateOrFn<TOnServer>
   >
   /**
@@ -586,6 +639,8 @@ export type DerivedFormState<
   in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  in out TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  in out TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
 > = {
   /**
@@ -607,6 +662,8 @@ export type DerivedFormState<
     | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
     | UnwrapFormValidateOrFn<TOnSubmit>
     | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
+    | UnwrapFormValidateOrFn<TOnDynamic>
+    | UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
     | UnwrapFormAsyncValidateOrFn<TOnServer>
   >
   /**
@@ -660,6 +717,8 @@ export interface FormState<
   in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  in out TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  in out TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
 > extends BaseFormState<
       TFormData,
@@ -670,6 +729,8 @@ export interface FormState<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer
     >,
     DerivedFormState<
@@ -681,6 +742,8 @@ export interface FormState<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer
     > {}
 
@@ -693,6 +756,8 @@ export type AnyFormState = FormState<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -705,6 +770,8 @@ function getDefaultFormState<
   TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
 >(
   defaultState: Partial<
@@ -717,6 +784,8 @@ function getDefaultFormState<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer
     >
   >,
@@ -729,6 +798,8 @@ function getDefaultFormState<
   TOnBlurAsync,
   TOnSubmit,
   TOnSubmitAsync,
+  TOnDynamic,
+  TOnDynamicAsync,
   TOnServer
 > {
   return {
@@ -746,6 +817,7 @@ function getDefaultFormState<
       onSubmit: undefined,
       onMount: undefined,
       onServer: undefined,
+      onDynamic: undefined,
     },
   }
 }
@@ -765,6 +837,8 @@ export type AnyFormApi = FormApi<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -784,6 +858,8 @@ export class FormApi<
   in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
   in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  in out TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
+  in out TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
   in out TSubmitMeta = never,
 > implements FieldManipulator<TFormData, TSubmitMeta>
@@ -800,6 +876,8 @@ export class FormApi<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TOnServer,
     TSubmitMeta
   > = {}
@@ -813,6 +891,8 @@ export class FormApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer
     >
   >
@@ -827,6 +907,8 @@ export class FormApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer
     >
   >
@@ -857,6 +939,8 @@ export class FormApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >,
@@ -889,6 +973,8 @@ export class FormApi<
           TOnBlurAsync,
           TOnSubmit,
           TOnSubmitAsync,
+          TOnDynamic,
+          TOnDynamicAsync,
           TOnServer
         >['fieldMeta']
 
@@ -990,6 +1076,8 @@ export class FormApi<
               TOnBlurAsync,
               TOnSubmit,
               TOnSubmitAsync,
+              TOnDynamic,
+              TOnDynamicAsync,
               TOnServer
             >
           | undefined
@@ -1122,6 +1210,8 @@ export class FormApi<
           TOnBlurAsync,
           TOnSubmit,
           TOnSubmitAsync,
+          TOnDynamic,
+          TOnDynamicAsync,
           TOnServer
         >
 
@@ -1203,6 +1293,8 @@ export class FormApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >,
@@ -1394,7 +1486,12 @@ export class FormApi<
       TOnSubmitAsync
     >
   } => {
-    const validates = getSyncValidatorArray(cause, this.options)
+    const validates = getSyncValidatorArray(cause, {
+      ...this.options,
+      form: this,
+      validationLogic: this.options.validationLogic || defaultValidationLogic,
+    })
+
     let hasErrored = false as boolean
 
     // This map will only include fields that have errors in the current validation cycle
@@ -1510,6 +1607,26 @@ export class FormApi<
           },
         }))
       }
+
+      /**
+       *  when we have an error for onServer in the state, we want
+       *  to clear the error as soon as the user enters a valid value in the field
+       */
+      const serverErrKey = getErrorMapKey('server')
+      if (
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        this.state.errorMap?.[serverErrKey] &&
+        cause !== 'server' &&
+        !hasErrored
+      ) {
+        this.baseStore.setState((prev) => ({
+          ...prev,
+          errorMap: {
+            ...prev.errorMap,
+            [serverErrKey]: undefined,
+          },
+        }))
+      }
     })
 
     return { hasErrored, fieldsErrorMap: currentValidationErrorMap }
@@ -1532,7 +1649,11 @@ export class FormApi<
       TOnSubmitAsync
     >
   > => {
-    const validates = getAsyncValidatorArray(cause, this.options)
+    const validates = getAsyncValidatorArray(cause, {
+      ...this.options,
+      form: this,
+      validationLogic: this.options.validationLogic || defaultValidationLogic,
+    })
 
     if (!this.state.isFormValidating) {
       this.baseStore.setState((prev) => ({ ...prev, isFormValidating: true }))
@@ -1772,6 +1893,9 @@ export class FormApi<
 
     if (!this.state.canSubmit) return
 
+    const submitMetaArg =
+      submitMeta ?? (this.options.onSubmitMeta as TSubmitMeta)
+
     this.baseStore.setState((d) => ({ ...d, isSubmitting: true }))
 
     const done = () => {
@@ -1785,6 +1909,7 @@ export class FormApi<
       this.options.onSubmitInvalid?.({
         value: this.state.values,
         formApi: this,
+        meta: submitMetaArg,
       })
       return
     }
@@ -1797,6 +1922,7 @@ export class FormApi<
       this.options.onSubmitInvalid?.({
         value: this.state.values,
         formApi: this,
+        meta: submitMetaArg,
       })
       return
     }
@@ -1812,15 +1938,15 @@ export class FormApi<
       )
     })
 
-    this.options.listeners?.onSubmit?.({ formApi: this })
+    this.options.listeners?.onSubmit?.({ formApi: this, meta: submitMetaArg })
 
     try {
       // Run the submit code
       await this.options.onSubmit?.({
         value: this.state.values,
         formApi: this,
-        meta: submitMeta ?? this.options.onSubmitMeta,
-      } as any)
+        meta: submitMetaArg,
+      })
 
       batch(() => {
         this.baseStore.setState((prev) => ({
@@ -1871,6 +1997,7 @@ export class FormApi<
         onSubmit: undefined,
         onMount: undefined,
         onServer: undefined,
+        onDynamic: undefined,
       },
     })
   }
@@ -2191,6 +2318,8 @@ export class FormApi<
       UnwrapFormAsyncValidateOrFn<TOnBlurAsync>,
       UnwrapFormValidateOrFn<TOnSubmit>,
       UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>,
+      UnwrapFormValidateOrFn<TOnDynamic>,
+      UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>,
       UnwrapFormAsyncValidateOrFn<TOnServer>
     >,
   ) {
@@ -2253,6 +2382,8 @@ export class FormApi<
         | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
         | UnwrapFormValidateOrFn<TOnSubmit>
         | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
+        | UnwrapFormValidateOrFn<TOnDynamic>
+        | UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
         | UnwrapFormAsyncValidateOrFn<TOnServer>
       >
       errorMap: ValidationErrorMap<
@@ -2263,6 +2394,8 @@ export class FormApi<
         UnwrapFormAsyncValidateOrFn<TOnBlurAsync>,
         UnwrapFormValidateOrFn<TOnSubmit>,
         UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>,
+        UnwrapFormValidateOrFn<TOnDynamic>,
+        UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>,
         UnwrapFormAsyncValidateOrFn<TOnServer>
       >
     }
@@ -2352,6 +2485,8 @@ function getErrorMapKey(cause: ValidationCause) {
       return 'onMount'
     case 'server':
       return 'onServer'
+    case 'dynamic':
+      return 'onDynamic'
     case 'change':
     default:
       return 'onChange'