@tanstack/form-core 1.6.2 → 1.7.0

package/src/types.ts

@@ -40,6 +40,17 @@ export type ValidationErrorMap<
   onServer?: TOnServerReturn
 }
 
+/**
+ * @private allows tracking the source of the errors in the error map
+ */
+export type ValidationErrorMapSource = {
+  onMount?: ValidationSource
+  onChange?: ValidationSource
+  onBlur?: ValidationSource
+  onSubmit?: ValidationSource
+  onServer?: ValidationSource
+}
+
 /**
  * @private
  */

package/src/utils.ts

@@ -1,4 +1,9 @@
-import type { GlobalFormValidationError, ValidationCause } from './types'
+import type {
+  GlobalFormValidationError,
+  ValidationCause,
+  ValidationError,
+  ValidationSource,
+} from './types'
 import type { FormValidators } from './FormApi'
 import type { AnyFieldMeta, FieldValidators } from './FieldApi'
 
@@ -376,3 +381,65 @@ export function shallow<T>(objA: T, objB: T) {
   }
   return true
 }
+
+/**
+ * Determines the logic for determining the error source and value to set on the field meta within the form level sync/async validation.
+ * @private
+ */
+export const determineFormLevelErrorSourceAndValue = ({
+  newFormValidatorError,
+  isPreviousErrorFromFormValidator,
+  previousErrorValue,
+}: {
+  newFormValidatorError: ValidationError
+  isPreviousErrorFromFormValidator: boolean
+  previousErrorValue: ValidationError
+}): {
+  newErrorValue: ValidationError
+  newSource: ValidationSource | undefined
+} => {
+  // All falsy values are not considered errors
+  if (newFormValidatorError) {
+    return { newErrorValue: newFormValidatorError, newSource: 'form' }
+  }
+
+  // Clears form level error since it's now stale
+  if (isPreviousErrorFromFormValidator) {
+    return { newErrorValue: undefined, newSource: undefined }
+  }
+
+  // At this point, we have a preivous error which must have been set by the field validator, keep as is
+  if (previousErrorValue) {
+    return { newErrorValue: previousErrorValue, newSource: 'field' }
+  }
+
+  // No new or previous error, clear the error
+  return { newErrorValue: undefined, newSource: undefined }
+}
+
+/**
+ * Determines the logic for determining the error source and value to set on the field meta within the field level sync/async validation.
+ * @private
+ */
+export const determineFieldLevelErrorSourceAndValue = ({
+  formLevelError,
+  fieldLevelError,
+}: {
+  formLevelError: ValidationError
+  fieldLevelError: ValidationError
+}): {
+  newErrorValue: ValidationError
+  newSource: ValidationSource | undefined
+} => {
+  // At field level, we prioritize the field level error
+  if (fieldLevelError) {
+    return { newErrorValue: fieldLevelError, newSource: 'field' }
+  }
+
+  // If there is no field level error, and there is a form level error, we set the form level error
+  if (formLevelError) {
+    return { newErrorValue: formLevelError, newSource: 'form' }
+  }
+
+  return { newErrorValue: undefined, newSource: undefined }
+}