Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

fieldSummaryMeta.ts

118 lines3.4 KB

1import { defaultFieldMeta } from '@tanstack/form-core/internals'
2import type { InternalFieldMeta } from '@tanstack/form-core/internals'
3import type {
4 DevtoolsMountedFieldSummary,
5 DevtoolsMountedFieldSummaryPatch,
6 DevtoolsMountedFieldValidity,
7} from './eventClientTypes'
8​
9interface DevtoolsMountedFieldSummaryProjection {
10 isLongValidating?: boolean
12​
13export const defaultDevtoolsMountedFieldSummary = Object.freeze({
14 isDirty: defaultFieldMeta.isDirty,
15 isTouched: defaultFieldMeta.isTouched,
16 isBlurred: defaultFieldMeta.isBlurred,
17 isLongValidating: false,
18 isDefaultValue: defaultFieldMeta.isDefaultValue,
19 hasSelfErrors: false,
20 validity: toDevtoolsMountedFieldValidity(defaultFieldMeta),
21}) satisfies DevtoolsMountedFieldSummary
22​
23function toDevtoolsMountedFieldSummary(
24 meta: InternalFieldMeta,
25 projection: DevtoolsMountedFieldSummaryProjection = {},
26): DevtoolsMountedFieldSummary {
27 return {
28 isDirty: meta.isDirty,
29 isTouched: meta.isTouched,
30 isBlurred: meta.isBlurred,
31 isLongValidating: projection.isLongValidating ?? false,
32 isDefaultValue: meta.isDefaultValue,
33 hasSelfErrors: meta.original.errors.length > 0,
34 validity: toDevtoolsMountedFieldValidity(meta),
35 }
37​
38function toDevtoolsMountedFieldValidity(
39 meta: InternalFieldMeta,
40): DevtoolsMountedFieldValidity {
41 // The public projection can be valid while original meta retains hidden errors.
42 if (!meta.isValid) return 'invalid'
43 if (!meta.original.isValid) return 'invalidHidden'
44 return 'valid'
46​
47export function createBaselinePatch<T extends object>(
48 value: T,
49 baseline: T,
50): Partial<T> | undefined {
51 let patch: Partial<T> | undefined
52​
53 for (const key of Object.keys(value) as Array<keyof T>) {
54 if (!Object.is(value[key], baseline[key])) {
55 const allocatedPatch = patch ?? (patch = {} as Partial<T>)
56 allocatedPatch[key] = value[key]
57 }
58 }
59​
60 return patch
62​
63export function toDevtoolsMountedFieldSummaryPatch(
64 meta: InternalFieldMeta,
65 projection?: DevtoolsMountedFieldSummaryProjection,
66): DevtoolsMountedFieldSummaryPatch | undefined {
67 return createBaselinePatch(
68 toDevtoolsMountedFieldSummary(meta, projection),
69 defaultDevtoolsMountedFieldSummary,
70 )
72​
73export function hydrateDevtoolsMountedFieldSummary(
74 patch?: DevtoolsMountedFieldSummaryPatch,
75): DevtoolsMountedFieldSummary {
76 if (!patch || Object.keys(patch).length === 0) {
77 return defaultDevtoolsMountedFieldSummary
78 }
79​
80 return {
81 ...defaultDevtoolsMountedFieldSummary,
82 ...patch,
83 }
85​
86interface BaselinePatchDifference<T extends object> {
87 set?: Partial<T>
88 clear?: Array<keyof T>
90​
91export function diffBaselinePatches<T extends object>(
92 previous: Partial<T> | undefined,
93 next: Partial<T> | undefined,
94): BaselinePatchDifference<T> {
95 let set: Partial<T> | undefined
96 let clear: Array<keyof T> | undefined
97 const keys = new Set<keyof T>([
98 ...(Object.keys(previous ?? {}) as Array<keyof T>),
99 ...(Object.keys(next ?? {}) as Array<keyof T>),
100 ])
101​
102 for (const key of keys) {
103 const hadPrevious = Object.hasOwn(previous ?? {}, key)
104 const hasNext = Object.hasOwn(next ?? {}, key)
105​
106 if (!hasNext) {
107 if (hadPrevious) (clear ??= []).push(key)
108 continue
109 }
110​
111 if (!hadPrevious || !Object.is(previous?.[key], next?.[key])) {
112 const allocatedSet = set ?? (set = {} as Partial<T>)
113 allocatedSet[key] = next![key]
114 }
115 }
116​
117 return { set, clear }