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

mountedForms.ts

116 lines3.6 KB

1import { uuid } from '@tanstack/form-core/internals'
2import { formDevtoolsEventClient } from '../../eventClient.lib'
3import type { AnyInternalFormApi } from '@tanstack/form-core/internals'
4import type { DevtoolsMountedForm } from '../../eventClientTypes'
5import type { FormId } from '../../types/branded'
6​
7export interface MountedFormsController {
8 dispose: () => void
9 getFormInstanceId: (form: AnyInternalFormApi) => FormId
10 getMountedForm: (formInstanceId: FormId) => AnyInternalFormApi | undefined
11 getMountedFormsSnapshot: () => Array<DevtoolsMountedForm>
12 isMounted: (form: AnyInternalFormApi) => boolean
13 mountForm: (form: AnyInternalFormApi) => boolean
14 unmountForm: (
15 form: AnyInternalFormApi,
16 onFinalUnmount: (formInstanceId: FormId) => void,
17 ) => boolean
18 updateForm: (form: AnyInternalFormApi) => void
20​
21export function createMountedFormsController(): MountedFormsController {
22 const formInstanceIds = new WeakMap<AnyInternalFormApi, FormId>()
23 const mountedForms = new Set<AnyInternalFormApi>()
24 const mountedFormRefCounts = new WeakMap<AnyInternalFormApi, number>()
25 const mountedFormIds = new WeakMap<AnyInternalFormApi, string>()
26 const mountedFormInstances = new Map<FormId, AnyInternalFormApi>()
27​
28 const getFormInstanceId = (form: AnyInternalFormApi): FormId => {
29 const existing = formInstanceIds.get(form)
30 if (existing) return existing
31​
32 const instanceId = uuid() as FormId
33 formInstanceIds.set(form, instanceId)
34 return instanceId
35 }
36​
37 const getMountedFormsSnapshot = (): Array<DevtoolsMountedForm> =>
38 Array.from(mountedForms, (form) => ({
39 label: form.formId,
40 instanceId: getFormInstanceId(form),
41 }))
42​
43 const emitMountedFormsChanged = (): void => {
44 formDevtoolsEventClient.emit('mounted-forms-changed', {
45 forms: getMountedFormsSnapshot(),
46 })
47 }
48​
49 const mountForm = (form: AnyInternalFormApi): boolean => {
50 const previousRefCount = mountedFormRefCounts.get(form) ?? 0
51 mountedFormRefCounts.set(form, previousRefCount + 1)
52​
53 if (previousRefCount > 0) return false
54​
55 mountedForms.add(form)
56 mountedFormInstances.set(getFormInstanceId(form), form)
57 mountedFormIds.set(form, form.formId)
58 emitMountedFormsChanged()
59 return true
60 }
61​
62 const unmountForm = (
63 form: AnyInternalFormApi,
64 onFinalUnmount: (formInstanceId: FormId) => void,
65 ): boolean => {
66 const previousRefCount = mountedFormRefCounts.get(form)
67 if (previousRefCount === undefined) return false
68​
69 const nextRefCount = previousRefCount - 1
70​
71 if (nextRefCount > 0) {
72 mountedFormRefCounts.set(form, nextRefCount)
73 return false
74 }
75​
76 const formInstanceId = formInstanceIds.get(form)
77​
78 mountedFormRefCounts.delete(form)
79 mountedForms.delete(form)
80 mountedFormIds.delete(form)
81 formInstanceIds.delete(form)
82​
83 if (formInstanceId) {
84 onFinalUnmount(formInstanceId)
85 mountedFormInstances.delete(formInstanceId)
86 }
87​
88 emitMountedFormsChanged()
89 return true
90 }
91​
92 const updateForm = (form: AnyInternalFormApi): void => {
93 if (!mountedForms.has(form)) return
94 if (mountedFormIds.get(form) === form.formId) return
95​
96 mountedFormIds.set(form, form.formId)
97 emitMountedFormsChanged()
98 }
99​
100 const cleanupRequestListener = formDevtoolsEventClient.on(
101 'request-mounted-forms',
102 emitMountedFormsChanged,
103 )
104​
105 return {
106 dispose: cleanupRequestListener,
107 getFormInstanceId,
108 getMountedForm: (formInstanceId) =>
109 mountedFormInstances.get(formInstanceId),
110 getMountedFormsSnapshot,
111 isMounted: (form) => mountedForms.has(form),
112 mountForm,
113 unmountForm,
114 updateForm,
115 }