Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/odd-comics-push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/form-core': patch
---

Fix: Schema output type now properly guards against dynamically enabled validators
17 changes: 14 additions & 3 deletions packages/form-core/src/validation.public.ts
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,19 @@ type TryGetSchemaOutput<TValidator> = TValidator extends {
? TOutput
: undefined

type TryGetSubmitSchemaOutput<TValidator> =
TryGetSchemaOutput<TValidator> extends infer TOutput
? TValidator extends { readonly runOnSubmit: infer TRunOnSubmit }
? [TRunOnSubmit] extends [false]
? undefined // User explicitly set runOnSubmit: false -> guaranteed undefined
: TRunOnSubmit extends (...args: Array<any>) => boolean
? TOutput | undefined // Callback could dynamically be true or false -> union
: false extends TRunOnSubmit
? TOutput | undefined // the explicit variable is boolean, so also dynamic -> union
: TOutput
: TOutput // default, which is guaranteed present
: never

type ValidatorTriggers<TValidator> = TValidator extends {
readonly triggers: infer TTriggers
}
Expand Down Expand Up @@ -667,9 +680,7 @@ type MappedSchemaOutputs<in out TValidators extends ReadonlyArray<unknown>> = {
[K in keyof TValidators]: TValidators[K] extends {
readonly run: any
}
? TValidators[K] extends { readonly runOnSubmit: false }
? undefined
: TryGetSchemaOutput<TValidators[K]>
? TryGetSubmitSchemaOutput<TValidators[K]>
: never
}

Expand Down
66 changes: 66 additions & 0 deletions packages/form-core/tests/validation.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1285,6 +1285,72 @@ describe('validator type transforms', () => {
>()
})

it('makes schema outputs optional when runOnSubmit is dynamic', () => {
const dynamicRunOnSubmit = true as boolean
const vs = defineFormValidators([
{
run: z.object({ name: z.string() }),
triggers: [],
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: true,
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: false,
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: dynamicRunOnSubmit,
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: () => true,
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: () => false,
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: () => dynamicRunOnSubmit,
},
{
run: z.object({ name: z.string() }),
triggers: [],
runOnSubmit: undefined,
},
])

type Output = { name: string }
type Outputs = ToFormSchemaOutputs<typeof vs>
type Expected = readonly [
// An omitted runOnSubmit defaults to true, so the output is guaranteed.
Output,
// A literal true always runs the validator during submit.
Output,
// A literal false always skips the validator during submit.
undefined,
// A broad boolean may skip the validator at runtime.
Output | undefined,
// Predicates currently always assume dynamic results. Types are here if you plan to tighten it in the future.
Output | undefined,
Output | undefined,
Output | undefined,
// An explicit undefined receives the same true default as an omitted property.
Output,
]

expectTypeOf<Outputs>().toEqualTypeOf<Expected>()
})

it('should transform field validators', () => {
const vs = defineFieldValidators([
{
Expand Down
Loading