Open History to see the last commit
1import { visitFieldSubtree } from '@tanstack/form-core/internals'
2import { createFieldIdentityController } from './identity'
3import { createFieldDetailsController } from './details'
4import { createFieldErrorDebugReportsController } from './debugReports'
5import { createFieldDebugReportsController } from './fieldDebugReports'
6import { createFieldListController } from './list'
7import { createFieldActionsController } from './actions'
8import type {
9 AnyInternalFieldApi,
10 AnyInternalFormApi,
11 FieldDependencyChange,
12} from '@tanstack/form-core/internals'
13import type { DevtoolsMountedFieldScaffold } from '../../eventClientTypes'
14import type { FormId } from '../../types/branded'
15import type { MountedFormsController } from '../forms/mountedForms'
16β
17interface FieldsController {
18 dispose: () => void
19 mountForm: (form: AnyInternalFormApi) => void
20 unmountForm: (formInstanceId: FormId) => void
21 mountField: (field: AnyInternalFieldApi) => void
22 updateField: (field: AnyInternalFieldApi) => void
23 fieldAdded: (field: AnyInternalFieldApi) => void
24 fieldDependenciesChanged: (
25 changes: ReadonlyArray<FieldDependencyChange>,
26 ) => void
27 unmountField: (field: AnyInternalFieldApi, previousPath: string) => void
28 moveField: (field: AnyInternalFieldApi, previousPath: string) => void
29 removeFieldSubtree: (
30 form: AnyInternalFormApi,
31 fields: Array<{ field: AnyInternalFieldApi; previousPath: string }>,
32 ) => void
33 getFieldRowsSnapshot: (
34 form: AnyInternalFormApi,
35 ) => Array<DevtoolsMountedFieldScaffold>
36}
37β
38function addListenerForwardRelations(
39 fields: Set<AnyInternalFieldApi>,
40 field: AnyInternalFieldApi,
41): void {
42 field._listenerInstances?.forEach((listenerInstance) => {
43 listenerInstance.resolvedWatchFields?.forEach((sourceField) =>
44 fields.add(sourceField),
45 )
46 })
47}
48β
49function addValidatorForwardRelations(
50 fields: Set<AnyInternalFieldApi>,
51 field: AnyInternalFieldApi,
52): void {
53 field._validatorInstances?.forEach((validatorInstance) => {
54 validatorInstance.resolvedWatchFields?.forEach((sourceField) =>
55 fields.add(sourceField),
56 )
57 })
58}
59β
60function addReverseRelations(
61 fields: Set<AnyInternalFieldApi>,
62 relationGroups:
63 | AnyInternalFieldApi['_watchingListenerFields']
64 | AnyInternalFieldApi['_watchingValidatorFields'],
65): void {
66 relationGroups?.forEach((_indexes, watchingField) => {
67 fields.add(watchingField)
68 })
69}
70β
71function addRelationNeighborhood(
72 fields: Set<AnyInternalFieldApi>,
73 field: AnyInternalFieldApi,
74): void {
75 fields.add(field)
76 addListenerForwardRelations(fields, field)
77 addValidatorForwardRelations(fields, field)
78 addReverseRelations(fields, field._watchingListenerFields)
79 addReverseRelations(fields, field._watchingValidatorFields)
80}
81β
82export function createFieldsController(
83 mountedForms: MountedFormsController,
84): FieldsController {
85 const identity = createFieldIdentityController()
86 const fieldActions = createFieldActionsController({
87 identity,
88 mountedForms,
89 })
90 const fieldList = createFieldListController({ identity, mountedForms })
91 const fieldDetails = createFieldDetailsController({ identity, mountedForms })
92 const fieldErrorDebugReports = createFieldErrorDebugReportsController({
93 identity,
94 mountedForms,
95 })
96 const fieldDebugReports = createFieldDebugReportsController({
97 identity,
98 mountedForms,
99 })
100β
101 return {
102 dispose: () => {
103 fieldDebugReports.dispose()
104 fieldErrorDebugReports.dispose()
105 fieldDetails.dispose()
106 fieldList.dispose()
107 fieldActions.dispose()
108 },
109 getFieldRowsSnapshot: fieldList.getFieldRowsSnapshot,
110 mountForm: fieldList.formMounted,
111 unmountForm: (formInstanceId) => {
112 const form = mountedForms.getMountedForm(formInstanceId)
113 fieldDetails.formUnmounted(formInstanceId)
114 fieldList.formUnmounted(formInstanceId)
115 if (form) identity.deleteForm(form)
116 },
117 mountField: fieldList.fieldMounted,
118 updateField: fieldList.fieldUpdated,
119 fieldAdded: (field) => {
120 fieldList.fieldUpdated(field)
121β
122 const updatedFields = new Set<AnyInternalFieldApi>()
123 addRelationNeighborhood(updatedFields, field)
124 if (!field._parent._isRoot) updatedFields.add(field._parent)
125 fieldDetails.fieldsUpdated(updatedFields)
126 },
127 fieldDependenciesChanged: (changes) => {
128 const updatedFields = new Set<AnyInternalFieldApi>()
129 for (const { sourceField, watchingField } of changes) {
130 updatedFields.add(sourceField)
131 updatedFields.add(watchingField)
132 }
133 fieldDetails.fieldsUpdated(updatedFields)
134 },
135 unmountField: fieldList.fieldUnmounted,
136 moveField: (field, previousPath) => {
137 const updatedFields = new Set<AnyInternalFieldApi>()
138 visitFieldSubtree(field, (movedField) => {
139 fieldList.fieldMoved(movedField, previousPath)
140 addRelationNeighborhood(updatedFields, movedField)
141 })
142 fieldDetails.fieldsUpdated(updatedFields)
143 },
144 removeFieldSubtree: (form, fields) => {
145 const removedFields = fields.map(({ field }) => field)
146 const removedFieldSet = new Set(removedFields)
147 const updatedParents = new Set<AnyInternalFieldApi>()
148 for (const removedField of removedFields) {
149 const parent = removedField._parent
150 if (
151 !parent._isRoot &&
152 !parent._isKilled &&
153 !removedFieldSet.has(parent)
154 ) {
155 updatedParents.add(parent)
156 }
157 }
158β
159 fieldDetails.fieldSubtreeRemoved(removedFields)
160 fieldList.fieldSubtreeRemoved(form, removedFields)
161β
162 for (const { field } of fields) {
163 identity.deleteField(field)
164 }
165 fieldDetails.fieldsUpdated(updatedParents)
166 },
167 }
168}