Open History to see the last commit
1import { describe, expectTypeOf, it } from 'vitest'
2import { formOptions, useForm } from '../src/index'
3import type { FormAsyncValidateOrFn, FormValidateOrFn } from '../src/index'
4import type { ReactFormExtendedApi } from '../src/useForm'
5β
6describe('useForm', () => {
7 it('should type onSubmit properly', () => {
8 function Comp() {
9 const form = useForm({
10 defaultValues: {
11 firstName: 'test',
12 age: 84,
13 // as const is required here
14 } as const,
15 onSubmit({ value }) {
16 expectTypeOf(value.age).toEqualTypeOf<84>()
17 },
18 })
19 }
20 })
21β
22 it('should type a validator properly', () => {
23 function Comp() {
24 const form = useForm({
25 defaultValues: {
26 firstName: 'test',
27 age: 84,
28 // as const is required here
29 } as const,
30 validators: {
31 onChange({ value }) {
32 expectTypeOf(value.age).toEqualTypeOf<84>()
33 return undefined
34 },
35 },
36 })
37 }
38 })
39β
40 it('should not have recursion problems and type register properly', () => {
41 const register = <
42 TFormData,
43 TOnMount extends undefined | FormValidateOrFn<TFormData>,
44 TOnChange extends undefined | FormValidateOrFn<TFormData>,
45 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
46 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
47 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
48 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
49 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
50 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
51 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
52 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
53 TSubmitMeta,
54 >(
55 f: ReactFormExtendedApi<
56 TFormData,
57 TOnMount,
58 TOnChange,
59 TOnChangeAsync,
60 TOnBlur,
61 TOnBlurAsync,
62 TOnSubmit,
63 TOnSubmitAsync,
64 TOnDynamic,
65 TOnDynamicAsync,
66 TOnServer,
67 TSubmitMeta
68 >,
69 ) => f
70β
71 function Comp() {
72 const form = useForm({
73 defaultValues: {
74 name: '',
75 title: '',
76 },
77 })
78β
79 const x = register(form)
80β
81 return null
82 }
83 })
84β
85 it('types should be properly inferred when using formOptions', () => {
86 type Person = {
87 firstName: string
88 lastName: string
89 }
90β
91 const formOpts = formOptions({
92 defaultValues: {
93 firstName: 'FirstName',
94 lastName: 'LastName',
95 } as Person,
96 })
97β
98 const form = useForm(formOpts)
99β
100 expectTypeOf(form.state.values).toEqualTypeOf<Person>()
101 })
102β
103 it('types should be properly inferred when passing args alongside formOptions', () => {
104 type Person = {
105 firstName: string
106 lastName: string
107 }
108β
109 const formOpts = formOptions({
110 defaultValues: {
111 firstName: 'FirstName',
112 lastName: 'LastName',
113 } as Person,
114 })
115β
116 const form = useForm({
117 ...formOpts,
118 onSubmitMeta: {
119 test: 'test',
120 },
121 })
122β
123 expectTypeOf(form.handleSubmit).toEqualTypeOf<{
124 (): Promise<void>
125 (submitMeta: { test: string }): Promise<void>
126 }>()
127 })
128β
129 it('types should be properly inferred when formOptions are being overridden', () => {
130 type Person = {
131 firstName: string
132 lastName: string
133 }
134β
135 type PersonWithAge = Person & {
136 age: number
137 }
138β
139 const formOpts = formOptions({
140 defaultValues: {
141 firstName: 'FirstName',
142 lastName: 'LastName',
143 } as Person,
144 })
145β
146 const form = useForm({
147 ...formOpts,
148 defaultValues: {
149 firstName: 'FirstName',
150 lastName: 'LastName',
151 age: 10,
152 },
153 })
154β
155 expectTypeOf(form.state.values).toExtend<PersonWithAge>()
156 })
157})