Skip to content

fix(core): fix formOptions type inferance #1687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 14, 2025
Merged

fix(core): fix formOptions type inferance #1687

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f24b44b
fix(core): fix formOptions type inferance
harry-whorlow Aug 11, 2025
9e7e9db
chore: add all generics to formOptions
LeCarbonator Aug 12, 2025
b2727ac
chore: add unit tests
LeCarbonator Aug 12, 2025
eb9d5da
chore: missing generics
harry-whorlow Aug 12, 2025
bc9d88a
chore: add additional type checks to unit tests
LeCarbonator Aug 13, 2025
71c7e62
chore: extra tests?
harry-whorlow Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions packages/form-core/src/FormApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ type FormErrorMapFromValidator<
TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
> = Partial<
Record<
DeepKeys<TFormData>,
Expand All @@ -67,7 +69,9 @@ type FormErrorMapFromValidator<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
>
>
>
Expand Down Expand Up @@ -1491,7 +1495,9 @@ export class FormApi<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
>
} => {
const validates = getSyncValidatorArray(cause, {
Expand All @@ -1511,7 +1517,9 @@ export class FormApi<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
> = {}

batch(() => {
Expand Down Expand Up @@ -1654,7 +1662,9 @@ export class FormApi<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
>
> => {
const validates = getAsyncValidatorArray(cause, {
Expand Down Expand Up @@ -1801,7 +1811,9 @@ export class FormApi<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
> = {}
if (promises.length) {
results = await Promise.all(promises)
Expand Down Expand Up @@ -1846,7 +1858,9 @@ export class FormApi<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
>
| Promise<
FormErrorMapFromValidator<
Expand All @@ -1857,7 +1871,9 @@ export class FormApi<
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync
>
> => {
// Attempt to sync validate first
Expand Down
54 changes: 32 additions & 22 deletions packages/form-core/src/formOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,45 @@ export function formOptions<
TOptions extends Partial<
FormOptions<
TFormData,
undefined | FormValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync,
TOnServer,
TSubmitMeta
>
>,
TFormData = TOptions['defaultValues'],
TSubmitMeta = TOptions['onSubmitMeta'],
TFormData,
TOnMount extends undefined | FormValidateOrFn<TFormData>,
TOnChange extends undefined | FormValidateOrFn<TFormData>,
TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnBlur extends undefined | FormValidateOrFn<TFormData>,
TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
TSubmitMeta = never,
>(
defaultOpts: Partial<
FormOptions<
TFormData,
undefined | FormValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
undefined | FormAsyncValidateOrFn<TFormData>,
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync,
TOnDynamic,
TOnDynamicAsync,
TOnServer,
TSubmitMeta
>
> &
Expand Down
208 changes: 206 additions & 2 deletions packages/form-core/tests/formOptions.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { describe, expectTypeOf, it } from 'vitest'
import { FormApi, formOptions } from '../src/index'
import type { FormAsyncValidateOrFn, FormValidateOrFn } from '../src/index'

describe('formOptions', () => {
it('types should be properly inferred', () => {
Expand All @@ -15,11 +16,13 @@ describe('formOptions', () => {
} as Person,
})

const form = new FormApi({
const form1 = new FormApi(formOpts)
const form2 = new FormApi({
...formOpts,
})

expectTypeOf(form.state.values).toEqualTypeOf<Person>()
expectTypeOf(form1.state.values).toEqualTypeOf<Person>()
expectTypeOf(form2.state.values).toEqualTypeOf<Person>()
})

it('types should be properly inferred when passing args alongside formOptions', () => {
Expand Down Expand Up @@ -65,6 +68,9 @@ describe('formOptions', () => {
} as Person,
})

const formOnly = new FormApi(formOpts)
expectTypeOf(formOnly.state.values).toEqualTypeOf<Person>()

const form = new FormApi({
...formOpts,
defaultValues: {
Expand All @@ -76,4 +82,202 @@ describe('formOptions', () => {

expectTypeOf(form.state.values).toExtend<PersonWithAge>()
})

it('types should infer submitMeta', () => {
type FormData = {
firstName: string
lastName: string
}
type SubmitMeta = { bool: boolean }

const formOpts = formOptions({
defaultValues: {
firstName: '',
lastName: '',
} as FormData,
onSubmitMeta: { bool: false } as SubmitMeta,
onSubmit: ({ meta }) => {
expectTypeOf(meta).toEqualTypeOf<SubmitMeta>()
},
})

const form = new FormApi(formOpts)
const form2 = new FormApi({ ...formOpts })
})

it('types should infer validator types', () => {
type FormData = {
firstName: string
lastName: string
}

type formApiValidators = FormApi<
FormData,
any,
any,
any,
any,
any,
any,
any,
any,
any,
any,
any
>

const formOpts = formOptions({
defaultValues: {
firstName: '',
lastName: '',
} as FormData,
validators: {
onChange: ({ value, formApi }) => {
expectTypeOf(value).toEqualTypeOf<FormData>()
expectTypeOf(formApi).toEqualTypeOf<formApiValidators>()
},
},
})

const form = new FormApi(formOpts)
const form2 = new FormApi({ ...formOpts })
})

it('types should infer listeners types', () => {
type FormData = {
firstName: string
lastName: string
}

type FormApiListeners = FormApi<
FormData,
FormValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined
>

const formOpts = formOptions({
defaultValues: {
firstName: '',
lastName: '',
} as FormData,
listeners: {
onSubmit: ({ formApi, meta }) => {
expectTypeOf(formApi).toEqualTypeOf<FormApiListeners>()
expectTypeOf(meta).toEqualTypeOf<never>()
},
},
})

const form = new FormApi(formOpts)
const form2 = new FormApi({ ...formOpts })
})

it('types should infer listeners types with submitMeta', () => {
type FormData = {
firstName: string
lastName: string
}
type SubmitMeta = { bool: boolean }

type FormApiListeners = FormApi<
FormData,
FormValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
FormAsyncValidateOrFn<FormData> | undefined,
SubmitMeta
>

const formOpts = formOptions({
defaultValues: {
firstName: '',
lastName: '',
} as FormData,
onSubmitMeta: { bool: false } as SubmitMeta,
listeners: {
onSubmit: ({ formApi, meta }) => {
expectTypeOf(formApi).toEqualTypeOf<FormApiListeners>()
expectTypeOf(meta).toEqualTypeOf<SubmitMeta>()
},
},
})

const form = new FormApi(formOpts)
const form2 = new FormApi({ ...formOpts })
})

it('should allow overriding formOptions values', () => {
type FormData = {
firstName: string
lastName: string
}

const formOpts = formOptions({
defaultValues: {
firstName: '',
lastName: '',
} as FormData,
validators: {
onSubmit: ({ formApi }) => {
if (formApi.formId === undefined) {
return 'needs formId'
}
return undefined
},
},
})

const form = new FormApi(formOpts)

expectTypeOf(form.state.errors).toEqualTypeOf<
('needs formId' | undefined)[]
>()

const form2 = new FormApi({
...formOpts,
validators: {
onChange: (params) => {
if (params.value.firstName.length === 0) {
return 'Too short!'
}
return undefined
},
},
})

expectTypeOf(form2.state.errors).toEqualTypeOf<
(undefined | 'Too short!')[]
>()

const form3 = new FormApi({
...formOpts,
validators: {
...formOpts.validators,
onChange: (params) => {
if (params.value.firstName.length === 0) {
return 'Too short!'
}
return undefined
},
},
})

expectTypeOf(form3.state.errors).toEqualTypeOf<
(undefined | 'Too short!' | 'needs formId')[]
>()
})
})
5 changes: 5 additions & 0 deletions pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ packages:
- 'examples/vue/**'
- 'examples/lit/**'
- 'examples/svelte/**'
catalog:
'@tanstack/store': ^0.7.2
arktype: ^2.1.20
valibot: ^1.1.0
zod: ^3.25.76