Skip to content
Open
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/form-errors-on-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/form-core': patch
---

Infer form-level `errors` from `onServerValidate` specified in `formOptions`.
12 changes: 6 additions & 6 deletions docs/framework/react/guides/ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,11 @@ export const formOpts = formOptions({
firstName: '',
age: 0,
},
onServerValidate: ({ value }) => {
if (value.age < 12) {
return 'Server validation: You must be at least 12 to sign up'
}
},
})
```

Expand All @@ -219,11 +224,6 @@ import { formOpts } from './shared-code'
// Create the server action that will infer the types of the form from `formOpts`
const serverValidate = createServerValidate({
...formOpts,
onServerValidate: ({ value }) => {
if (value.age < 12) {
return 'Server validation: You must be at least 12 to sign up'
}
},
})

export default async function someAction(prev: unknown, formData: FormData) {
Expand Down Expand Up @@ -278,7 +278,7 @@ export const ClientComp = () => {
return (
<form action={action as never} onSubmit={() => form.handleSubmit()}>
{formErrors.map((error) => (
<p key={error as string}>{error}</p>
<p key={error}>{error}</p>
))}

<form.Field
Expand Down
5 changes: 0 additions & 5 deletions examples/react/next-server-actions/src/app/action.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ import { formOpts } from './shared-code'

const serverValidate = createServerValidate({
...formOpts,
onServerValidate: ({ value }) => {
if (value.age < 12) {
return 'Server validation: You must be at least 12 to sign up'
}
},
})

export default async function someAction(prev: unknown, formData: FormData) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export const ClientComp = () => {
return (
<form action={action as never} onSubmit={() => form.handleSubmit()}>
{formErrors.map((error) => (
<p key={error as unknown as string}>{error}</p>
<p key={error}>{error}</p>
))}

<form.Field
Expand Down
5 changes: 5 additions & 0 deletions examples/react/next-server-actions/src/app/shared-code.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,9 @@ export const formOpts = formOptions({
firstName: '',
age: 0,
},
onServerValidate: ({ value }) => {
if (value.age < 12) {
return 'Server validation: You must be at least 12 to sign up'
}
},
})
6 changes: 6 additions & 0 deletions packages/form-core/src/FormApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,12 @@ export interface FormOptions<
TOnDynamic,
TOnDynamicAsync
>
/**
* Server-only validator used by `createServerValidate`. Specify it in shared
* `formOptions` so the client form infers `state.errors` / `errorMap.onServer`
* from the same function. This is not executed in the browser.
*/
onServerValidate?: TOnServer

validationLogic?: ValidationLogicFn

Expand Down
29 changes: 29 additions & 0 deletions packages/form-core/tests/formOptions.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,4 +319,33 @@ describe('formOptions', () => {
('Too short!' | 'I just need an error')[]
>()
})

it('should infer form error types from onServerValidate in formOptions', () => {
const formOpts = formOptions({
defaultValues: {
firstName: '',
age: 0,
},
onServerValidate: ({ value }) => {
expectTypeOf(value.age).toEqualTypeOf<number>()
if (value.age < 12) {
return 'Server validation: You must be at least 12 to sign up' as const
}
return undefined
},
})

const form = new FormApi(formOpts)
expectTypeOf(form.state.errors).toEqualTypeOf<
'Server validation: You must be at least 12 to sign up'[]
>()
expectTypeOf(form.state.errorMap.onServer).toEqualTypeOf<
'Server validation: You must be at least 12 to sign up' | undefined
>()

const form2 = new FormApi({ ...formOpts })
expectTypeOf(form2.state.errors).toEqualTypeOf<
'Server validation: You must be at least 12 to sign up'[]
>()
})
})
22 changes: 22 additions & 0 deletions packages/react-form/tests/useForm.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,26 @@ describe('useForm', () => {

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

it('should infer form error types from onServerValidate in formOptions', () => {
const formOpts = formOptions({
defaultValues: {
firstName: '',
age: 0,
},
onServerValidate: ({ value }) => {
expectTypeOf(value.age).toEqualTypeOf<number>()
if (value.age < 12) {
return 'Server validation: You must be at least 12 to sign up' as const
}
return undefined
},
})

const form = useForm({ ...formOpts })

expectTypeOf(form.state.errors).toEqualTypeOf<
'Server validation: You must be at least 12 to sign up'[]
>()
})
})