@tanstack/form-core 1.16.0 → 1.17.0

package/src/FieldApi.ts

@@ -10,6 +10,7 @@ import {
   getBy,
   getSyncValidatorArray,
 } from './utils'
+import { defaultValidationLogic } from './ValidationLogic'
 import type { DeepKeys, DeepValue, UnwrapOneLevelOfArray } from './util-types'
 import type {
   StandardSchemaV1,
@@ -100,6 +101,10 @@ export type FieldValidateFn<
     any,
     any,
     any,
+    any,
+    any,
+    any,
+    any,
     any
   >
 }) => unknown
@@ -183,6 +188,10 @@ export type FieldValidateAsyncFn<
     any,
     any,
     any,
+    any,
+    any,
+    any,
+    any,
     any
   >
   signal: AbortSignal
@@ -265,6 +274,10 @@ export type FieldListenerFn<
     any,
     any,
     any,
+    any,
+    any,
+    any,
+    any,
     any
   >
 }) => void
@@ -286,6 +299,10 @@ export interface FieldValidators<
   TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+  TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
 > {
   /**
    * An optional function, that runs on the mount event of input.
@@ -348,6 +365,9 @@ export interface FieldValidators<
    * @example z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
    */
   onSubmitAsync?: TOnSubmitAsync
+  onDynamic?: TOnDynamic
+  onDynamicAsync?: TOnDynamicAsync
+  onDynamicAsyncDebounceMs?: number
 }
 
 export interface FieldListeners<
@@ -383,6 +403,10 @@ export interface FieldOptions<
   TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+  TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
 > {
   /**
    * The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
@@ -413,7 +437,9 @@ export interface FieldOptions<
     TOnBlur,
     TOnBlurAsync,
     TOnSubmit,
-    TOnSubmitAsync
+    TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync
   >
   /**
    * An optional object with default metadata for the field.
@@ -430,6 +456,10 @@ export interface FieldOptions<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
+      any,
+      any,
       any,
       any,
       any,
@@ -477,6 +507,12 @@ export interface FieldApiOptions<
   in out TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  in out TOnDynamic extends
+    | undefined
+    | FieldValidateOrFn<TParentData, TName, TData>,
+  in out TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
   in out TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
   in out TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
   in out TFormOnChangeAsync extends
@@ -490,6 +526,10 @@ export interface FieldApiOptions<
   in out TFormOnSubmitAsync extends
     | undefined
     | FormAsyncValidateOrFn<TParentData>,
+  in out TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
+  in out TFormOnDynamicAsync extends
+    | undefined
+    | FormAsyncValidateOrFn<TParentData>,
   in out TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
   in out TParentSubmitMeta,
 > extends FieldOptions<
@@ -502,7 +542,9 @@ export interface FieldApiOptions<
     TOnBlur,
     TOnBlurAsync,
     TOnSubmit,
-    TOnSubmitAsync
+    TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync
   > {
   form: FormApi<
     TParentData,
@@ -513,6 +555,8 @@ export interface FieldApiOptions<
     TFormOnBlurAsync,
     TFormOnSubmit,
     TFormOnSubmitAsync,
+    TFormOnDynamic,
+    TFormOnDynamicAsync,
     TFormOnServer,
     TParentSubmitMeta
   >
@@ -535,6 +579,10 @@ export type FieldMetaBase<
   TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+  TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
   TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
@@ -542,6 +590,8 @@ export type FieldMetaBase<
   TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
   TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
   TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
+  TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
+  TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
 > = {
   /**
    * A flag indicating whether the field has been touched.
@@ -565,8 +615,11 @@ export type FieldMetaBase<
     UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>,
     UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>,
     UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>,
-    UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>
+    UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>,
+    UnwrapFieldValidateOrFn<TName, TOnDynamic, TFormOnDynamic>,
+    UnwrapFieldAsyncValidateOrFn<TName, TOnDynamicAsync, TFormOnDynamicAsync>
   >
+
   /**
    * @private allows tracking the source of the errors in the error map
    */
@@ -594,6 +647,10 @@ export type AnyFieldMetaBase = FieldMetaBase<
   any,
   any,
   any,
+  any,
+  any,
+  any,
+  any,
   any
 >
 
@@ -614,6 +671,10 @@ export type FieldMetaDerived<
   TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+  TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
   TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
@@ -621,6 +682,8 @@ export type FieldMetaDerived<
   TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
   TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
   TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
+  TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
+  TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
 > = {
   /**
    * An array of errors related to the field value.
@@ -647,6 +710,16 @@ export type FieldMetaDerived<
     | UnwrapOneLevelOfArray<
         UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>
       >
+    | UnwrapOneLevelOfArray<
+        UnwrapFieldValidateOrFn<TName, TOnDynamic, TFormOnDynamic>
+      >
+    | UnwrapOneLevelOfArray<
+        UnwrapFieldAsyncValidateOrFn<
+          TName,
+          TOnDynamicAsync,
+          TFormOnDynamicAsync
+        >
+      >
   >
   /**
    * A flag that is `true` if the field's value has not been modified by the user. Opposite of `isDirty`.
@@ -679,6 +752,10 @@ export type AnyFieldMetaDerived = FieldMetaDerived<
   any,
   any,
   any,
+  any,
+  any,
+  any,
+  any,
   any
 >
 
@@ -702,6 +779,10 @@ export type FieldMeta<
   TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+  TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
   TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
@@ -709,6 +790,8 @@ export type FieldMeta<
   TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
   TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
   TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
+  TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
+  TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
 > = FieldMetaBase<
   TParentData,
   TName,
@@ -720,13 +803,17 @@ export type FieldMeta<
   TOnBlurAsync,
   TOnSubmit,
   TOnSubmitAsync,
+  TOnDynamic,
+  TOnDynamicAsync,
   TFormOnMount,
   TFormOnChange,
   TFormOnChangeAsync,
   TFormOnBlur,
   TFormOnBlurAsync,
   TFormOnSubmit,
-  TFormOnSubmitAsync
+  TFormOnSubmitAsync,
+  TFormOnDynamic,
+  TFormOnDynamicAsync
 > &
   FieldMetaDerived<
     TParentData,
@@ -739,13 +826,17 @@ export type FieldMeta<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TFormOnMount,
     TFormOnChange,
     TFormOnChangeAsync,
     TFormOnBlur,
     TFormOnBlurAsync,
     TFormOnSubmit,
-    TFormOnSubmitAsync
+    TFormOnSubmitAsync,
+    TFormOnDynamic,
+    TFormOnDynamicAsync
   >
 
 export type AnyFieldMeta = FieldMeta<
@@ -765,6 +856,10 @@ export type AnyFieldMeta = FieldMeta<
   any,
   any,
   any,
+  any,
+  any,
+  any,
+  any,
   any
 >
 
@@ -788,6 +883,10 @@ export type FieldState<
   TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
+  TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
   TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
   TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
@@ -795,6 +894,8 @@ export type FieldState<
   TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
   TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
   TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
+  TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
+  TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
 > = {
   /**
    * The current value of the field.
@@ -814,13 +915,17 @@ export type FieldState<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TFormOnMount,
     TFormOnChange,
     TFormOnChangeAsync,
     TFormOnBlur,
     TFormOnBlurAsync,
     TFormOnSubmit,
-    TFormOnSubmitAsync
+    TFormOnSubmitAsync,
+    TFormOnDynamic,
+    TFormOnDynamicAsync
   >
 }
 
@@ -848,6 +953,10 @@ export type AnyFieldApi = FieldApi<
   any,
   any,
   any,
+  any,
+  any,
+  any,
+  any,
   any
 >
 
@@ -885,6 +994,12 @@ export class FieldApi<
   in out TOnSubmitAsync extends
     | undefined
     | FieldAsyncValidateOrFn<TParentData, TName, TData>,
+  in out TOnDynamic extends
+    | undefined
+    | FieldValidateOrFn<TParentData, TName, TData>,
+  in out TOnDynamicAsync extends
+    | undefined
+    | FieldAsyncValidateOrFn<TParentData, TName, TData>,
   in out TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
   in out TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
   in out TFormOnChangeAsync extends
@@ -898,6 +1013,10 @@ export class FieldApi<
   in out TFormOnSubmitAsync extends
     | undefined
     | FormAsyncValidateOrFn<TParentData>,
+  in out TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
+  in out TFormOnDynamicAsync extends
+    | undefined
+    | FormAsyncValidateOrFn<TParentData>,
   in out TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
   in out TParentSubmitMeta,
 > {
@@ -915,6 +1034,8 @@ export class FieldApi<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TFormOnMount,
     TFormOnChange,
     TFormOnChangeAsync,
@@ -922,6 +1043,8 @@ export class FieldApi<
     TFormOnBlurAsync,
     TFormOnSubmit,
     TFormOnSubmitAsync,
+    TFormOnDynamic,
+    TFormOnDynamicAsync,
     TFormOnServer,
     TParentSubmitMeta
   >['form']
@@ -943,6 +1066,8 @@ export class FieldApi<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TFormOnMount,
     TFormOnChange,
     TFormOnChangeAsync,
@@ -950,6 +1075,8 @@ export class FieldApi<
     TFormOnBlurAsync,
     TFormOnSubmit,
     TFormOnSubmitAsync,
+    TFormOnDynamic,
+    TFormOnDynamicAsync,
     TFormOnServer,
     TParentSubmitMeta
   > = {} as any
@@ -968,13 +1095,17 @@ export class FieldApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TFormOnMount,
       TFormOnChange,
       TFormOnChangeAsync,
       TFormOnBlur,
       TFormOnBlurAsync,
       TFormOnSubmit,
-      TFormOnSubmitAsync
+      TFormOnSubmitAsync,
+      TFormOnDynamic,
+      TFormOnDynamicAsync
     >
   >
   /**
@@ -1004,6 +1135,8 @@ export class FieldApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TFormOnMount,
       TFormOnChange,
       TFormOnChangeAsync,
@@ -1011,6 +1144,8 @@ export class FieldApi<
       TFormOnBlurAsync,
       TFormOnSubmit,
       TFormOnSubmitAsync,
+      TFormOnDynamic,
+      TFormOnDynamicAsync,
       TFormOnServer,
       TParentSubmitMeta
     >,
@@ -1046,13 +1181,17 @@ export class FieldApi<
           TOnBlurAsync,
           TOnSubmit,
           TOnSubmitAsync,
+          TOnDynamic,
+          TOnDynamicAsync,
           TFormOnMount,
           TFormOnChange,
           TFormOnChangeAsync,
           TFormOnBlur,
           TFormOnBlurAsync,
           TFormOnSubmit,
-          TFormOnSubmitAsync
+          TFormOnSubmitAsync,
+          TFormOnDynamic,
+          TFormOnDynamicAsync
         >
       },
     })
@@ -1154,6 +1293,8 @@ export class FieldApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TFormOnMount,
       TFormOnChange,
       TFormOnChangeAsync,
@@ -1161,6 +1302,8 @@ export class FieldApi<
       TFormOnBlurAsync,
       TFormOnSubmit,
       TFormOnSubmitAsync,
+      TFormOnDynamic,
+      TFormOnDynamicAsync,
       TFormOnServer,
       TParentSubmitMeta
     >,
@@ -1232,13 +1375,17 @@ export class FieldApi<
         TOnBlurAsync,
         TOnSubmit,
         TOnSubmitAsync,
+        TOnDynamic,
+        TOnDynamicAsync,
         TFormOnMount,
         TFormOnChange,
         TFormOnChangeAsync,
         TFormOnBlur,
         TFormOnBlurAsync,
         TFormOnSubmit,
-        TFormOnSubmitAsync
+        TFormOnSubmitAsync,
+        TFormOnDynamic,
+        TFormOnDynamicAsync
       >
     >,
   ) => this.form.setFieldMeta(this.name, updater)
@@ -1351,12 +1498,22 @@ export class FieldApi<
     cause: ValidationCause,
     errorFromForm: ValidationErrorMap,
   ) => {
-    const validates = getSyncValidatorArray(cause, this.options)
+    const validates = getSyncValidatorArray(cause, {
+      ...this.options,
+      form: this.form,
+      validationLogic:
+        this.form.options.validationLogic || defaultValidationLogic,
+    })
 
     const linkedFields = this.getLinkedFields(cause)
     const linkedFieldValidates = linkedFields.reduce(
       (acc, field) => {
-        const fieldValidates = getSyncValidatorArray(cause, field.options)
+        const fieldValidates = getSyncValidatorArray(cause, {
+          ...field.options,
+          form: field.form,
+          validationLogic:
+            field.form.options.validationLogic || defaultValidationLogic,
+        })
         fieldValidates.forEach((validate) => {
           ;(validate as any).field = field
         })
@@ -1477,7 +1634,12 @@ export class FieldApi<
       >
     >,
   ) => {
-    const validates = getAsyncValidatorArray(cause, this.options)
+    const validates = getAsyncValidatorArray(cause, {
+      ...this.options,
+      form: this.form,
+      validationLogic:
+        this.form.options.validationLogic || defaultValidationLogic,
+    })
 
     // Get the field-specific error messages that are coming from the form's validator
     const asyncFormValidationResults = await formValidationResultPromise
@@ -1485,7 +1647,12 @@ export class FieldApi<
     const linkedFields = this.getLinkedFields(cause)
     const linkedFieldValidates = linkedFields.reduce(
       (acc, field) => {
-        const fieldValidates = getAsyncValidatorArray(cause, field.options)
+        const fieldValidates = getAsyncValidatorArray(cause, {
+          ...field.options,
+          form: field.form,
+          validationLogic:
+            field.form.options.validationLogic || defaultValidationLogic,
+        })
         fieldValidates.forEach((validate) => {
           ;(validate as any).field = field
         })
@@ -1691,7 +1858,9 @@ export class FieldApi<
       UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>,
       UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>,
       UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>,
-      UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>
+      UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>,
+      UnwrapFieldValidateOrFn<TName, TOnDynamic, TFormOnDynamic>,
+      UnwrapFieldAsyncValidateOrFn<TName, TOnDynamicAsync, TFormOnDynamicAsync>
     >,
   ) {
     this.setMeta((prev) => ({
@@ -1826,6 +1995,8 @@ function getErrorMapKey(cause: ValidationCause) {
       return 'onMount'
     case 'server':
       return 'onServer'
+    case 'dynamic':
+      return 'onDynamic'
     case 'change':
     default:
       return 'onChange'

package/src/FieldGroupApi.ts

@@ -31,6 +31,8 @@ export type AnyFieldGroupApi = FieldGroupApi<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -57,6 +59,8 @@ export interface FieldGroupOptions<
   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,
 > {
@@ -70,6 +74,8 @@ export interface FieldGroupOptions<
         TOnBlurAsync,
         TOnSubmit,
         TOnSubmitAsync,
+        TOnDynamic,
+        TOnDynamicAsync,
         TOnServer,
         TSubmitMeta
       >
@@ -85,6 +91,8 @@ export interface FieldGroupOptions<
         any,
         any,
         any,
+        any,
+        any,
         TSubmitMeta
       >
   /**
@@ -114,6 +122,8 @@ export class FieldGroupApi<
   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<TFieldGroupData, TSubmitMeta>
@@ -130,6 +140,8 @@ export class FieldGroupApi<
     TOnBlurAsync,
     TOnSubmit,
     TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
     TOnServer,
     TSubmitMeta
   >
@@ -184,6 +196,8 @@ export class FieldGroupApi<
       TOnBlurAsync,
       TOnSubmit,
       TOnSubmitAsync,
+      TOnDynamic,
+      TOnDynamicAsync,
       TOnServer,
       TSubmitMeta
     >,