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

index.ts

230 lines5.8 KB

1import { decode } from 'decode-formdata'
2import { validateServerValues } from '@tanstack/form-core/internals'
3import { getFormData } from './getFormData'
4import { setInternalTanStackCookie } from './utils'
5import type {
6 DeepKeysWhereValueIncludes,
7 FormOptions,
8 FormValidators,
9 ServerFormState,
10 ServerValidateFailure,
11 ServerValidateResult,
12 ServerValidateSuccess,
13} from '@tanstack/form-core'
14import type { FormDataInfo } from 'decode-formdata'
15​
16export { getFormData }
17​
18export type TypedFormDataInfo<TFormData> = Omit<FormDataInfo, 'numbers'> & {
19 numbers?: Array<DeepKeysWhereValueIncludes<TFormData, number>>
21​
22export interface StartServerValidateContext<TFormData = any> {
23 formData: FormData
24 info?: TypedFormDataInfo<TFormData>
26​
27export type StartServerValidateResult<
28 TFormData,
29 TFormValidators extends FormValidators<TFormData>,
30 TOnInvalidReturn = never,
31 TOnValidReturn = never,
32> =
33 | ServerValidateResult<TFormData, TFormValidators>
34 | TOnInvalidReturn
35 | TOnValidReturn
36​
37export interface StartServerValidateOptions<
38 TOnInvalidReturn = never,
39 TOnValidReturn = never,
40> {
41 info?: FormDataInfo
42 onInvalid?: (args: {
43 result: ServerValidateFailure<any, any>
44 serverState: ServerFormState<any, any>
45 }) => TOnInvalidReturn | Promise<TOnInvalidReturn>
46 onValid?: (args: {
47 result: ServerValidateSuccess<any, any>
48 }) => TOnValidReturn | Promise<TOnValidReturn>
50​
51export interface StartCreateServerValidateOptions<TFormData> {
52 info?: TypedFormDataInfo<TFormData>
53 inferFormDataInfo?: boolean
55​
56export type StartServerValidateAction<
57 TFormData,
58 TFormValidators extends FormValidators<TFormData>,
59 TOnInvalidReturn = never,
60 TOnValidReturn = never,
61> = {
62 (
63 context: StartServerValidateContext<TFormData>,
64 ): Promise<
65 StartServerValidateResult<
66 TFormData,
67 TFormValidators,
68 TOnInvalidReturn,
69 TOnValidReturn
70 >
71 >
72 getFormData: () => Promise<ServerFormState<TFormData, TFormValidators>>
74​
75export type StartCreateServerValidate<
76 TOnInvalidReturn = never,
77 TOnValidReturn = never,
78> = <
79 TFormData,
80 const TFormValidators extends FormValidators<TFormData>,
81 TSubmitReturn,
82>(
83 formOptions: FormOptions<TFormData, TFormValidators, TSubmitReturn, unknown>,
84 options?: StartCreateServerValidateOptions<TFormData>,
85) => StartServerValidateAction<
86 TFormData,
87 TFormValidators,
88 TOnInvalidReturn,
89 TOnValidReturn
91​
92function decodeFormData<TFormData>(
93 formData: FormData,
94 info: FormDataInfo | undefined,
95): TFormData {
96 return (info ? decode(formData, info) : decode(formData)) as TFormData
98​
99function isPlainObject(value: unknown): value is Record<string, unknown> {
100 if (typeof value !== 'object' || value === null || Array.isArray(value)) {
101 return false
102 }
103​
104 const prototype = Object.getPrototypeOf(value)
105 return prototype === Object.prototype || prototype === null
107​
108function inferFormDataInfo(defaultValues: unknown): FormDataInfo | undefined {
109 const numbers: Array<string> = []
110​
111 const visit = (value: unknown, path: string) => {
112 if (typeof value === 'number') {
113 if (path) numbers.push(path)
114 return
115 }
116​
117 if (!isPlainObject(value)) return
118​
119 for (const [key, child] of Object.entries(value)) {
120 visit(child, path ? `${path}.${key}` : key)
121 }
122 }
123​
124 visit(defaultValues, '')
125​
126 return numbers.length ? { numbers } : undefined
128​
129function mergeFormDataInfo(
130 ...infos: Array<FormDataInfo | undefined>
131): FormDataInfo | undefined {
132 let result: Record<string, unknown> | undefined
133​
134 for (const info of infos) {
135 if (!info) continue
136​
137 for (const [key, value] of Object.entries(info)) {
138 if (value === undefined) continue
139​
140 result ??= {}
141​
142 const previous = result[key]
143 if (Array.isArray(previous) && Array.isArray(value)) {
144 result[key] = Array.from(new Set([...previous, ...value]))
145 } else if (Array.isArray(value)) {
146 result[key] = Array.from(new Set(value))
147 } else {
148 result[key] = value
149 }
150 }
151 }
152​
153 return result
155​
156export function start<TOnInvalidReturn = never, TOnValidReturn = never>(
157 options: StartServerValidateOptions<TOnInvalidReturn, TOnValidReturn> = {},
158) {
159 const createServerValidate = <
160 TFormData,
161 const TFormValidators extends FormValidators<TFormData>,
162 TSubmitReturn,
163 >(
164 formOptions: FormOptions<
165 TFormData,
166 TFormValidators,
167 TSubmitReturn,
168 unknown
169 >,
170 formValidateOptions?: StartCreateServerValidateOptions<TFormData>,
171 ): StartServerValidateAction<
172 TFormData,
173 TFormValidators,
174 TOnInvalidReturn,
175 TOnValidReturn
176 > => {
177 const inferredInfo =
178 formValidateOptions?.inferFormDataInfo === false
179 ? undefined
180 : inferFormDataInfo(formOptions.defaultValues)
181​
182 const validate = async (
183 context: StartServerValidateContext<TFormData>,
184 ): Promise<
185 StartServerValidateResult<
186 TFormData,
187 TFormValidators,
188 TOnInvalidReturn,
189 TOnValidReturn
190 >
191 > => {
192 const values = decodeFormData<TFormData>(
193 context.formData,
194 mergeFormDataInfo(
195 inferredInfo,
196 options.info,
197 formValidateOptions?.info,
198 context.info,
199 ),
200 )
201​
202 const result = await validateServerValues(formOptions, values)
203​
204 if (result.success) {
205 return options.onValid ? options.onValid({ result }) : result
206 }
207​
208 setInternalTanStackCookie(result.serverState)
209​
210 return options.onInvalid
211 ? options.onInvalid({
212 result,
213 serverState: result.serverState,
214 })
215 : result
216 }
217​
218 return Object.assign(validate, {
219 getFormData: getFormData as unknown as () => Promise<
220 ServerFormState<TFormData, TFormValidators>
221 >,
222 })
223 }
224​
225 return {
226 id: 'react-form-start' as const,
227 createServerValidate,
228 getFormData,
229 }