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

with-fields.ts

210 lines6.0 KB

1import { Directive, PartType, directive } from 'lit/directive.js'
2import { createAtom, shallow } from '@tanstack/lit-store'
3import {
4 InternalFieldGroupApi,
5 defineFieldGroupFieldsRuntime,
6 fieldGroupHelperRuntime,
7} from '@tanstack/form-core/internals'
8import type {
9 FieldGroupFieldBindings,
10 FieldGroupFieldBindingsProps,
11 FieldGroupFieldData,
12 FieldGroupFields,
13 FieldGroupFieldsPropName,
14 FieldGroupHelper,
15 FormApiArrayMethods,
16 FormApiFieldMethods,
17 FormErrorTypes,
18 ValidationIssue,
19} from '@tanstack/form-core'
20import type { ReadonlyAtom } from '@tanstack/lit-store'
21import type { Part, PartInfo } from 'lit/directive.js'
22import type { InternalFieldGroupBindings } from '@tanstack/form-core/internals'
23import type {
24 LitFieldMethods,
25 LitSubscribeMethod,
26 TanStackFormController,
27} from './tanstack-form-controller.js'
28​
29declare const fieldGroupFieldsSymbol: unique symbol
30​
31export type LitFieldGroupApi<TFieldData> = LitFieldMethods<
32 TFieldData,
33 ValidationIssue,
34 unknown,
35 FormErrorTypes
36> &
37 LitSubscribeMethod<TFieldData> &
38 FormApiFieldMethods<TFieldData> &
39 FormApiArrayMethods<TFieldData> & {
40 atom: ReadonlyAtom<TFieldData>
41 }
42​
43export type FieldGroupFieldsOf<TFieldGroup> = TFieldGroup extends {
44 readonly [fieldGroupFieldsSymbol]: infer TFields extends FieldGroupFields
46 ? TFields
47 : never
48​
49export type LitFieldGroup<TFields extends FieldGroupFields> = LitFieldGroupApi<
50 FieldGroupFieldData<TFields>
51> & {
52 readonly [fieldGroupFieldsSymbol]: TFields
54​
55export type FieldGroupFieldBindingsOf<TFieldGroup, TFormData> =
56 FieldGroupFieldsOf<TFieldGroup> extends FieldGroupFields
57 ? FieldGroupFieldBindings<FieldGroupFieldsOf<TFieldGroup>, TFormData>
58 : never
59​
60type AnyLitForm<TFormData = any> = TanStackFormController<TFormData, any, any>
61​
62export type FieldGroupWithFieldsFn<
63 TFieldGroup extends {
64 readonly [fieldGroupFieldsSymbol]: FieldGroupFields
65 },
66> = <
67 TProps extends object,
68 TFieldsPropName extends FieldGroupFieldsPropName<TProps, TFieldGroup>,
69>(
70 render: (props: TProps) => unknown,
71 fieldsPropName: TFieldsPropName,
72) => <TFormData>(
73 props: Omit<TProps, TFieldsPropName | 'form'> & {
74 form: AnyLitForm<TFormData>
75 } & FieldGroupFieldBindingsProps<
76 FieldGroupFieldsOf<TFieldGroup>,
77 TFormData,
78 TFieldsPropName
79 >,
80) => unknown
81​
82export interface FieldGroupDefinition<TFields extends FieldGroupFields> {
83 /** The virtual field-group API injected into the bound renderer. */
84 fields: LitFieldGroup<TFields>
85 /** Binds a renderer's virtual field API to concrete paths in a form. */
86 bindComponent: FieldGroupWithFieldsFn<LitFieldGroup<TFields>>
88​
89export type DefineFieldGroupFn = <const TFields extends FieldGroupFields>(
90 defineFn: (helper: FieldGroupHelper) => TFields,
91) => FieldGroupDefinition<TFields>
92​
93function attachLitFieldGroupMethods(
94 group: InternalFieldGroupApi,
95 form: AnyLitForm,
96): LitFieldGroupApi<any> {
97 const resolveOptions = (options: { name: string }) =>
98 group._getFormFieldOptions(options, (base, overrides) => ({
99 ...base,
100 ...overrides,
101 }))
102​
103 return Object.assign(group, {
104 field: (options: { name: string }, render: (field: any) => unknown) =>
105 form.field(resolveOptions(options) as never, render),
106 arrayField: (options: { name: string }, render: (field: any) => unknown) =>
107 form.arrayField(resolveOptions(options) as never, render),
108 subscribe: (
109 selector: (value: any) => any,
110 render: (value: any) => unknown,
111 when?: (value: any) => boolean,
112 ) => form.subscribe(() => selector(group.atom.get()), render, when),
113 }) as never
115​
116class ReusableFieldGroupDirective extends Directive {
117 private form?: AnyLitForm
118 private fieldNames?: Array<string>
119 private bindings = createAtom<InternalFieldGroupBindings | undefined>(
120 undefined,
121 { compare: shallow },
122 )
123 private api?: LitFieldGroupApi<any>
124​
125 constructor(partInfo: PartInfo) {
126 super(partInfo)
127 if (partInfo.type !== PartType.CHILD) {
128 throw new Error('Field groups must be rendered in a child part')
129 }
130 }
131​
132 update(
133 _part: Part,
134 [form, bindings, fieldNames, render, propName, props]: Parameters<
135 this['render']
136 >,
137 ) {
138 this.bindings.set(bindings)
139 if (this.form !== form || this.fieldNames !== fieldNames || !this.api) {
140 this.form = form
141 this.fieldNames = fieldNames
142 this.api = attachLitFieldGroupMethods(
143 new InternalFieldGroupApi({
144 form: form.api as never,
145 fieldNames,
146 getBindings: () => this.bindings.get(),
147 }),
148 form,
149 )
150 }
151 return render({ ...props, [propName]: this.api })
152 }
153​
154 render(
155 form: AnyLitForm,
156 bindings: InternalFieldGroupBindings | undefined,
157 fieldNames: Array<string>,
158 render: (props: Record<string, unknown>) => unknown,
159 propName: string,
160 props: Record<string, unknown>,
161 ): unknown {
162 void form
163 void bindings
164 void fieldNames
165 void render
166 void propName
167 void props
168 return undefined
169 }
171​
172const reusableFieldGroupDirective = directive(ReusableFieldGroupDirective)
173​
174const withFieldsRuntime = (
175 fields: FieldGroupFields,
176 render: (props: Record<string, unknown>) => unknown,
177 fieldsPropName: string,
178) => {
179 const fieldNames = Object.keys(fields)
180 return (props: Record<string, unknown>) => {
181 const { form, [fieldsPropName]: bindings, ...rest } = props
182 if (!form) {
183 throw new Error('TanStack Form: Field groups must receive a `form` prop.')
184 }
185 return reusableFieldGroupDirective(
186 form as AnyLitForm,
187 bindings as InternalFieldGroupBindings | undefined,
188 fieldNames,
189 render,
190 fieldsPropName,
191 rest,
192 )
193 }
195​
196export const defineFieldGroup = ((
197 defineFn: (helper: FieldGroupHelper) => FieldGroupFields,
198) => {
199 const fields = defineFieldGroupFieldsRuntime(
200 defineFn(fieldGroupHelperRuntime as never),
201 )
202​
203 return {
204 fields,
205 bindComponent: (
206 render: (props: Record<string, unknown>) => unknown,
207 fieldsPropName: string,
208 ) => withFieldsRuntime(fields, render, fieldsPropName),
209 }
210}) as unknown as DefineFieldGroupFn