Open History to see the last commit
1import type {
2 DeepKeys,
3 DeepKeysWhereValueIncludes,
4 DeepValue,
5 FieldApi,
6 FieldApiOptions,
7 FieldValidators,
8 FormErrorTypes,
9 FormGroupApi,
10 FormGroupOptions,
11 FormGroupState,
12 FormGroupValidators,
13 FormState,
14 ToFieldError,
15 ToFormGroupErrorTypes,
16} from '@tanstack/form-core'
17import type {
18 Component,
19 ComponentConstructorOptions,
20 Snippet,
21 SvelteComponent,
22} from 'svelte'
23β
24export type WithoutFunction<T> = {
25 [K in keyof T as T[K] extends Function ? never : K]: T[K]
26}
27β
28type ExactFieldBrand<out TValue> = {
29 readonly __tanstackFieldExactType: TValue
30}
31type AcceptsFieldBrand<out TAcceptedValue> = {
32 readonly __tanstackFieldAcceptsType: TAcceptedValue
33}
34type CompatibleFieldKey<TKey, TComponent, TTargetValue> =
35 TComponent extends ExactFieldBrand<infer TExact>
36 ? [TExact] extends [TTargetValue]
37 ? [TTargetValue] extends [TExact]
38 ? TKey
39 : never
40 : never
41 : TComponent extends AcceptsFieldBrand<infer TLoose>
42 ? [TTargetValue] extends [TLoose]
43 ? TKey
44 : never
45 : TKey
46type FilteredFieldComponents<
47 TFieldComponents extends Record<string, Component<any>>,
48 TTargetValue,
49> = {
50 [
51 K in keyof TFieldComponents as CompatibleFieldKey<
52 K,
53 TFieldComponents[K],
54 TTargetValue
55 >
56 ]: TFieldComponents[K]
57}
58type FieldComponentsMatchingType<
59 TFieldComponents extends Record<string, Component<any>>,
60 TTargetValue,
61> = unknown extends TTargetValue
62 ? TFieldComponents
63 : string extends keyof TFieldComponents
64 ? TFieldComponents
65 : FilteredFieldComponents<TFieldComponents, TTargetValue>
66β
67export type SvelteFieldApi<
68 TFieldName,
69 TFieldValue,
70 TFieldError,
71 TFormData,
72 TFormErrorTypes extends FormErrorTypes,
73 TFieldComponents extends Record<string, Component<any>>,
74> = FieldApi<TFieldName, TFieldValue, TFieldError, TFormData, TFormErrorTypes> &
75 FieldComponentsMatchingType<TFieldComponents, TFieldValue>
76β
77interface SvelteSubscribeProps<TSourceData, TSelected> {
78 selector: (state: TSourceData) => TSelected
79 when?: (selected: NoInfer<TSelected>) => boolean
80 children: Snippet<[NoInfer<TSelected>]>
81}
82β
83export type SvelteFormSubscribeProps<
84 TFormData,
85 TFormErrorTypes extends FormErrorTypes,
86 TSelected,
87> = SvelteSubscribeProps<FormState<TFormData, TFormErrorTypes>, TSelected>
88β
89export type SvelteFormSubscribeComponent<
90 TFormData,
91 TFormErrorTypes extends FormErrorTypes,
92> = (new <const TSelected>(
93 options: ComponentConstructorOptions<
94 SvelteFormSubscribeProps<TFormData, TFormErrorTypes, TSelected>
95 >,
96) => SvelteComponent) &
97 Component<any> &
98 WithoutFunction<Component>
99β
100export interface SvelteFormFieldProps<
101 TFieldData,
102 TFieldName,
103 TFieldValue,
104 TFieldValidators extends FieldValidators<TFieldData, TFieldName, TFieldValue>,
105 TGroupFieldError,
106 TFormData,
107 TFormErrorTypes extends FormErrorTypes,
108 TFieldComponents extends Record<string, Component<any>>,
109> extends FieldApiOptions<
110 TFieldData,
111 TFieldName,
112 TFieldValue,
113 TFieldValidators,
114 TGroupFieldError,
115 TFormData,
116 TFormErrorTypes
117> {
118 children: Snippet<
119 [
120 SvelteFieldApi<
121 TFieldName,
122 TFieldValue,
123 ToFieldError<
124 NoInfer<TFieldValidators>,
125 TGroupFieldError,
126 TFormErrorTypes
127 >,
128 TFormData,
129 TFormErrorTypes,
130 TFieldComponents
131 >,
132 ]
133 >
134}
135β
136export type SvelteFormFieldComponent<
137 TFormData,
138 TFormErrorTypes extends FormErrorTypes,
139 TFieldComponents extends Record<string, Component<any>>,
140> = (new <
141 TFieldName extends DeepKeys<TFormData>,
142 const TFieldValidators extends FieldValidators<
143 TFormData,
144 TFieldName,
145 DeepValue<TFormData, TFieldName>
146 >,
147>(
148 options: ComponentConstructorOptions<
149 SvelteFormFieldProps<
150 TFormData,
151 TFieldName,
152 DeepValue<TFormData, TFieldName>,
153 TFieldValidators,
154 never,
155 TFormData,
156 TFormErrorTypes,
157 TFieldComponents
158 >
159 >,
160) => SvelteComponent) &
161 Component<any> &
162 WithoutFunction<Component>
163β
164export type SvelteFormArrayFieldComponent<
165 TFormData,
166 TFormErrorTypes extends FormErrorTypes,
167 TFieldComponents extends Record<string, Component<any>>,
168> = (new <
169 TFieldName extends DeepKeysWhereValueIncludes<TFormData, Array<any>>,
170 const TFieldValidators extends FieldValidators<
171 TFormData,
172 TFieldName,
173 DeepValue<TFormData, TFieldName>
174 >,
175>(
176 options: ComponentConstructorOptions<
177 SvelteFormFieldProps<
178 TFormData,
179 TFieldName,
180 DeepValue<TFormData, TFieldName>,
181 TFieldValidators,
182 never,
183 TFormData,
184 TFormErrorTypes,
185 TFieldComponents
186 >
187 >,
188) => SvelteComponent) &
189 Component<any> &
190 WithoutFunction<Component>
191β
192export type SvelteFormGroupSubscribeComponent<
193 TGroupValue,
194 TGroupErrorTypes extends FormErrorTypes,
195> = (new <const TSelected>(
196 options: ComponentConstructorOptions<
197 SvelteSubscribeProps<
198 FormGroupState<TGroupValue, TGroupErrorTypes>,
199 TSelected
200 >
201 >,
202) => SvelteComponent) &
203 Component<any> &
204 WithoutFunction<Component>
205β
206export type SvelteFormGroupFieldComponent<
207 TFormData,
208 TGroupValue,
209 TGroupErrorTypes extends FormErrorTypes,
210 TFormErrorTypes extends FormErrorTypes,
211 TFieldComponents extends Record<string, Component<any>>,
212> = (new <
213 TFieldName extends DeepKeys<TGroupValue>,
214 const TFieldValidators extends FieldValidators<
215 TGroupValue,
216 TFieldName,
217 DeepValue<TGroupValue, TFieldName>
218 >,
219>(
220 options: ComponentConstructorOptions<
221 SvelteFormFieldProps<
222 TGroupValue,
223 TFieldName,
224 DeepValue<TGroupValue, TFieldName>,
225 TFieldValidators,
226 TGroupErrorTypes['fieldError'],
227 TFormData,
228 TFormErrorTypes,
229 TFieldComponents
230 >
231 >,
232) => SvelteComponent) &
233 Component<any> &
234 WithoutFunction<Component>
235β
236export type SvelteFormGroupArrayFieldComponent<
237 TFormData,
238 TGroupValue,
239 TGroupErrorTypes extends FormErrorTypes,
240 TFormErrorTypes extends FormErrorTypes,
241 TFieldComponents extends Record<string, Component<any>>,
242> = (new <
243 TFieldName extends DeepKeysWhereValueIncludes<TGroupValue, Array<any>>,
244 const TFieldValidators extends FieldValidators<
245 TGroupValue,
246 TFieldName,
247 DeepValue<TGroupValue, TFieldName>
248 >,
249>(
250 options: ComponentConstructorOptions<
251 SvelteFormFieldProps<
252 TGroupValue,
253 TFieldName,
254 DeepValue<TGroupValue, TFieldName>,
255 TFieldValidators,
256 TGroupErrorTypes['fieldError'],
257 TFormData,
258 TFormErrorTypes,
259 TFieldComponents
260 >
261 >,
262) => SvelteComponent) &
263 Component<any> &
264 WithoutFunction<Component>
265β
266export interface SvelteFormGroupApi<
267 TFormData,
268 TGroupName,
269 TGroupValue,
270 TGroupErrorTypes extends FormErrorTypes,
271 TFormErrorTypes extends FormErrorTypes,
272 TFieldComponents extends Record<string, Component<any>>,
273> extends FormGroupApi<
274 TFormData,
275 TGroupName,
276 TGroupValue,
277 TGroupErrorTypes,
278 TFormErrorTypes
279> {
280 Field: SvelteFormGroupFieldComponent<
281 TFormData,
282 TGroupValue,
283 TGroupErrorTypes,
284 TFormErrorTypes,
285 TFieldComponents
286 >
287 ArrayField: SvelteFormGroupArrayFieldComponent<
288 TFormData,
289 TGroupValue,
290 TGroupErrorTypes,
291 TFormErrorTypes,
292 TFieldComponents
293 >
294 Subscribe: SvelteFormGroupSubscribeComponent<TGroupValue, TGroupErrorTypes>
295}
296β
297export interface SvelteFormGroupProps<
298 TFormData,
299 TGroupName,
300 TGroupValue,
301 TGroupValidators extends FormGroupValidators<TGroupValue>,
302 TFormErrorTypes extends FormErrorTypes,
303 TFieldComponents extends Record<string, Component<any>>,
304> extends Omit<
305 FormGroupOptions<
306 TFormData,
307 TGroupName,
308 TGroupValue,
309 TGroupValidators,
310 TFormErrorTypes
311 >,
312 'form'
313> {
314 children: Snippet<
315 [
316 SvelteFormGroupApi<
317 TFormData,
318 TGroupName,
319 TGroupValue,
320 ToFormGroupErrorTypes<NoInfer<TGroupValidators>>,
321 TFormErrorTypes,
322 TFieldComponents
323 >,
324 ]
325 >
326}
327β
328export type SvelteFormGroupComponent<
329 TFormData,
330 TFormErrorTypes extends FormErrorTypes,
331 TFieldComponents extends Record<string, Component<any>>,
332> = (new <
333 TGroupName extends DeepKeys<TFormData>,
334 TGroupValue extends DeepValue<TFormData, TGroupName>,
335 const TGroupValidators extends FormGroupValidators<TGroupValue>,
336>(
337 options: ComponentConstructorOptions<
338 SvelteFormGroupProps<
339 TFormData,
340 TGroupName,
341 TGroupValue,
342 TGroupValidators,
343 TFormErrorTypes,
344 TFieldComponents
345 >
346 >,
347) => SvelteComponent) &
348 Component<any> &
349 WithoutFunction<Component>
350β
351export interface SvelteTanStackFormComponents<
352 TFormData,
353 TFormErrorTypes extends FormErrorTypes,
354 TFieldComponents extends Record<string, Component<any>> = Record<
355 never,
356 never
357 >,
358> {
359 Field: SvelteFormFieldComponent<TFormData, TFormErrorTypes, TFieldComponents>
360 ArrayField: SvelteFormArrayFieldComponent<
361 TFormData,
362 TFormErrorTypes,
363 TFieldComponents
364 >
365 Subscribe: SvelteFormSubscribeComponent<TFormData, TFormErrorTypes>
366 FormGroup: SvelteFormGroupComponent<
367 TFormData,
368 TFormErrorTypes,
369 TFieldComponents
370 >
371}