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

getFormHookHelpers.public.ts

114 lines3.4 KB

1import { brandComponentFactory, wrapField } from './fieldComponentHelpers.lib'
2import type { CrossVersionPreactNode } from '../preactTypes.public'
3import type { FieldWithValue } from '@tanstack/form-core'
4​
5type ExactFieldBrand<out TValue> = {
6 readonly __tanstackFieldExactType: TValue
7}
8​
9type AcceptsFieldBrand<out TAcceptedValue> = {
10 readonly __tanstackFieldAcceptsType: TAcceptedValue
12​
13type AnyFieldComponent = (props: any) => CrossVersionPreactNode
14​
15type PropsOf<TComponent> = TComponent extends (
16 props: infer TProps,
17) => CrossVersionPreactNode
18 ? TProps
19 : never
20​
21type FieldValuePropKeys<TProps> = {
22 [K in keyof TProps]-?: TProps[K] extends FieldWithValue<any> ? K : never
23}[keyof TProps]
24​
25type FieldValueFromProp<TProp> =
26 TProp extends FieldWithValue<infer TValue> ? TValue : never
27​
28type FieldValueFromComponentProp<
29 TProps,
30 TFieldPropKey extends keyof TProps,
31> = FieldValueFromProp<TProps[TFieldPropKey]>
32​
33type PublicPropsReplacingField<
34 TProps,
35 TFieldPropKey extends keyof TProps,
36> = Omit<TProps, TFieldPropKey>
37​
38type StrictInjectedFieldComponent<
39 TComponent extends AnyFieldComponent,
40 TProps = PropsOf<TComponent>,
41 TFieldPropKey extends FieldValuePropKeys<TProps> = FieldValuePropKeys<TProps>,
42> = ((
43 props: PublicPropsReplacingField<TProps, TFieldPropKey>,
44) => CrossVersionPreactNode) &
45 ExactFieldBrand<FieldValueFromComponentProp<TProps, TFieldPropKey>>
46​
47type LooseInjectedFieldComponent<
48 TComponent extends AnyFieldComponent,
49 TProps = PropsOf<TComponent>,
50 TFieldPropKey extends FieldValuePropKeys<TProps> = FieldValuePropKeys<TProps>,
51> = ((
52 props: PublicPropsReplacingField<TProps, TFieldPropKey>,
53) => CrossVersionPreactNode) &
54 AcceptsFieldBrand<FieldValueFromComponentProp<TProps, TFieldPropKey>>
55​
56type StrictBrandedFieldComponent<
57 TComponent extends AnyFieldComponent,
58 TValue,
59> = TComponent & ExactFieldBrand<TValue>
60​
61type LooseBrandedFieldComponent<
62 TComponent extends AnyFieldComponent,
63 TAcceptedValue,
64> = TComponent & AcceptsFieldBrand<TAcceptedValue>
65​
66interface FieldComponentHelper {
67 strict: <
68 TComponent extends AnyFieldComponent,
69 TProps = PropsOf<TComponent>,
70 TFieldPropKey extends FieldValuePropKeys<TProps> =
71 FieldValuePropKeys<TProps>,
72 >(
73 Component: TComponent,
74 fieldPropKey: TFieldPropKey,
75 ) => StrictInjectedFieldComponent<TComponent, TProps, TFieldPropKey>
76​
77 loose: <
78 TComponent extends AnyFieldComponent,
79 TProps = PropsOf<TComponent>,
80 TFieldPropKey extends FieldValuePropKeys<TProps> =
81 FieldValuePropKeys<TProps>,
82 >(
83 Component: TComponent,
84 fieldPropKey: TFieldPropKey,
85 ) => LooseInjectedFieldComponent<TComponent, TProps, TFieldPropKey>
87​
88interface FieldBrandHelper {
89 strict: <TValue>() => <TComponent extends AnyFieldComponent>(
90 Component: TComponent,
91 ) => StrictBrandedFieldComponent<TComponent, TValue>
92​
93 loose: <TValue>() => <TComponent extends AnyFieldComponent>(
94 Component: TComponent,
95 ) => LooseBrandedFieldComponent<TComponent, TValue>
97​
98export interface FormHookHelpers {
99 fieldBrand: FieldBrandHelper
100 fieldComponent: FieldComponentHelper
102​
103export function getFormHookHelpers(): FormHookHelpers {
104 return {
105 fieldComponent: {
106 loose: wrapField as FieldComponentHelper['loose'],
107 strict: wrapField as FieldComponentHelper['strict'],
108 },
109 fieldBrand: {
110 loose: brandComponentFactory as FieldBrandHelper['loose'],
111 strict: brandComponentFactory as FieldBrandHelper['strict'],
112 },
113 }