@tanstack/form-core 1.28.0 → 1.28.2

package/src/transform.ts

@@ -0,0 +1,155 @@
+import { batch } from '@tanstack/store'
+import { deepCopy } from './utils'
+import type {
+  AnyBaseFormState,
+  FormApi,
+  FormAsyncValidateOrFn,
+  FormValidateOrFn,
+} from './FormApi'
+
+/**
+ * @private
+ */
+export type FormTransform<
+  TFormData,
+  TOnMount extends undefined | FormValidateOrFn<TFormData>,
+  TOnChange extends undefined | FormValidateOrFn<TFormData>,
+  TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  TOnBlur extends undefined | FormValidateOrFn<TFormData>,
+  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,
+> = (
+  formBase: FormApi<
+    TFormData,
+    TOnMount,
+    TOnChange,
+    TOnChangeAsync,
+    TOnBlur,
+    TOnBlurAsync,
+    TOnSubmit,
+    TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
+    TOnServer,
+    TSubmitMeta
+  >,
+) => FormApi<
+  TFormData,
+  TOnMount,
+  TOnChange,
+  TOnChangeAsync,
+  TOnBlur,
+  TOnBlurAsync,
+  TOnSubmit,
+  TOnSubmitAsync,
+  TOnDynamic,
+  TOnDynamicAsync,
+  TOnServer,
+  TSubmitMeta
+>
+
+/**
+ * @private
+ */
+export function mergeAndUpdate<
+  TFormData,
+  TOnMount extends undefined | FormValidateOrFn<TFormData>,
+  TOnChange extends undefined | FormValidateOrFn<TFormData>,
+  TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
+  TOnBlur extends undefined | FormValidateOrFn<TFormData>,
+  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,
+>(
+  form: FormApi<
+    TFormData,
+    TOnMount,
+    TOnChange,
+    TOnChangeAsync,
+    TOnBlur,
+    TOnBlurAsync,
+    TOnSubmit,
+    TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
+    TOnServer,
+    TSubmitMeta
+  >,
+  fn?: FormTransform<
+    TFormData,
+    TOnMount,
+    TOnChange,
+    TOnChangeAsync,
+    TOnBlur,
+    TOnBlurAsync,
+    TOnSubmit,
+    TOnSubmitAsync,
+    TOnDynamic,
+    TOnDynamicAsync,
+    TOnServer,
+    TSubmitMeta
+  >,
+) {
+  // Run the `transform` function on `form.state`, diff it, and update the relevant parts with what needs updating
+  if (!fn) return
+
+  const newObj = Object.assign({}, form, {
+    state: deepCopy(form.state),
+  })
+
+  fn(newObj)
+
+  if (newObj.fieldInfo !== form.fieldInfo) {
+    form.fieldInfo = newObj.fieldInfo
+  }
+
+  if (newObj.options !== form.options) {
+    form.options = newObj.options
+  }
+
+  const baseFormKeys = Object.keys({
+    values: null,
+    validationMetaMap: null,
+    fieldMetaBase: null,
+    isSubmitting: null,
+    isSubmitted: null,
+    isValidating: null,
+    submissionAttempts: null,
+    isSubmitSuccessful: null,
+    _force_re_eval: null,
+    // Do not remove this, it ensures that we have all the keys in `BaseFormState`
+  } satisfies Record<
+    // Exclude errorMap since we need to handle that uniquely
+    Exclude<keyof AnyBaseFormState, 'errorMap'>,
+    null
+  >) as Array<keyof AnyBaseFormState>
+
+  const diffedObject = baseFormKeys.reduce((prev, key) => {
+    if (form.state[key] !== newObj.state[key]) {
+      prev[key] = newObj.state[key]
+    }
+    return prev
+  }, {} as Partial<AnyBaseFormState>)
+
+  batch(() => {
+    if (Object.keys(diffedObject).length) {
+      form.baseStore.setState((prev) => ({ ...prev, ...diffedObject }))
+    }
+
+    if (newObj.state.errorMap !== form.state.errorMap) {
+      // Check if we need to update `fieldMetaBase` with `errorMaps` set by
+      form.setErrorMap(newObj.state.errorMap)
+    }
+  })
+
+  return newObj
+}

package/src/utils.ts

@@ -615,3 +615,47 @@ export const throttleFormState = liteThrottle(
     wait: 300,
   },
 )
+
+// Do not use a serialize and deserialize method like JSON.stringify/parse
+// as that will drop functions, dates, undefined, Infinity, NaN, etc.
+export function deepCopy<T>(obj: T): T {
+  if (obj === null || typeof obj !== 'object') {
+    return obj
+  }
+
+  if (obj instanceof Date) {
+    return new Date(obj.getTime()) as any
+  }
+
+  if (Array.isArray(obj)) {
+    const arrCopy = [] as any[]
+    for (let i = 0; i < obj.length; i++) {
+      arrCopy[i] = deepCopy(obj[i])
+    }
+    return arrCopy as any
+  }
+
+  if (obj instanceof Map) {
+    const mapCopy = new Map()
+    obj.forEach((value, key) => {
+      mapCopy.set(key, deepCopy(value))
+    })
+    return mapCopy as any
+  }
+
+  if (obj instanceof Set) {
+    const setCopy = new Set()
+    obj.forEach((value) => {
+      setCopy.add(deepCopy(value))
+    })
+    return setCopy as any
+  }
+
+  const copy: { [key: string]: any } = {}
+  for (const key in obj) {
+    if (Object.prototype.hasOwnProperty.call(obj, key)) {
+      copy[key] = deepCopy((obj as any)[key])
+    }
+  }
+  return copy as T
+}