Open History to see the last commit
1import { describe, expectTypeOf, it } from 'vitest'
2import { formOptions, serverValidateHelper } from '@tanstack/form-core'
3import { start } from '../src'
4import type { ServerFormState, ServerValidateResult } from '@tanstack/form-core'
5β
6describe('start server validation types', () => {
7 it('preserves discriminated result generics through the helper', async () => {
8 const options = formOptions({
9 defaultValues: { name: '' },
10 validators: [
11 {
12 run: () => ({
13 fields: {
14 name: 'Name is required',
15 },
16 }),
17 triggers: ['server'],
18 },
19 ],
20 })
21β
22 const { createServerValidate } = serverValidateHelper({
23 framework: start(),
24 })
25 const validate = createServerValidate(options)
26 const result = await validate({ formData: {} as FormData })
27β
28 if (result.success) {
29 expectTypeOf(result.values).toEqualTypeOf<{ name: string }>()
30 } else {
31 type Values = { name: string }
32 type Validators = NonNullable<typeof options.validators>
33β
34 expectTypeOf(result.serverState).toEqualTypeOf<
35 ServerFormState<Values, Validators>
36 >()
37 }
38 })
39β
40 it('preserves start helpers and custom callback return types', async () => {
41 const options = formOptions({
42 defaultValues: { name: '' },
43 validators: [
44 {
45 run: () => undefined,
46 triggers: ['server'],
47 },
48 ],
49 })
50β
51 const { createServerValidate, getFormData } = serverValidateHelper({
52 framework: start({
53 onInvalid: () => ({ status: 'invalid' as const }),
54 onValid: () => ({ status: 'valid' as const }),
55 }),
56 })
57β
58 const serverState = await getFormData()
59 expectTypeOf(serverState).toEqualTypeOf<ServerFormState<any, any>>()
60β
61 const validate = createServerValidate(options)
62 const result = await validate({ formData: {} as FormData })
63β
64 if ('success' in result) {
65 expectTypeOf(result).toEqualTypeOf<
66 ServerValidateResult<
67 { name: string },
68 NonNullable<typeof options.validators>
69 >
70 >()
71 } else {
72 expectTypeOf(result).toEqualTypeOf<
73 { status: 'invalid' } | { status: 'valid' }
74 >()
75 }
76 })
77β
78 it('types form-bound helpers and form data info from values', async () => {
79 const options = formOptions({
80 defaultValues: { firstName: '', age: 0 },
81 validators: [
82 {
83 run: () => undefined,
84 triggers: ['server'],
85 },
86 ],
87 })
88β
89 const { createServerValidate } = serverValidateHelper({
90 framework: start(),
91 })
92 const validate = createServerValidate(options, {
93 info: {
94 numbers: ['age'],
95 },
96 })
97β
98 // @ts-expect-error String fields cannot be configured as numbers.
99 createServerValidate(options, { info: { numbers: ['firstName'] } })
100β
101 await validate({
102 formData: {} as FormData,
103 info: {
104 numbers: ['age'],
105 },
106 })
107β
108 await validate({
109 formData: {} as FormData,
110 // @ts-expect-error Invocation info is also typed against form values.
111 info: { numbers: ['firstName'] },
112 })
113β
114 expectTypeOf(validate.getFormData()).toEqualTypeOf<
115 Promise<
116 ServerFormState<
117 { firstName: string; age: number },
118 NonNullable<typeof options.validators>
119 >
120 >
121 >()
122 })
123})