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
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@ export default function App() {
errorMap.onSubmit ? (
<div>
<em>
There was an error on the form:{' '}
{errorMap.onSubmit?.toString()}
There was an error on the form: {errorMap.onSubmit.toString()}
</em>
</div>
) : null
Expand Down
29 changes: 18 additions & 11 deletions packages/form-core/src/FieldApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1671,17 +1671,24 @@ export class FieldApi<
/**
* Updates the field's errorMap
*/
setErrorMap(errorMap: ValidationErrorMap) {
this.setMeta(
(prev) =>
({
...prev,
errorMap: {
...prev.errorMap,
...errorMap,
},
}) as never,
)
setErrorMap(
errorMap: ValidationErrorMap<
UnwrapFieldValidateOrFn<TName, TOnMount, TFormOnMount>,
UnwrapFieldValidateOrFn<TName, TOnChange, TFormOnChange>,
UnwrapFieldAsyncValidateOrFn<TName, TOnChangeAsync, TFormOnChangeAsync>,
UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>,
UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>,
UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>,
UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>
>,
) {
this.setMeta((prev) => ({
...prev,
errorMap: {
...prev.errorMap,
...errorMap,
},
}))
}

/**
Expand Down
32 changes: 15 additions & 17 deletions packages/form-core/src/FormApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2123,25 +2123,23 @@ export class FormApi<
*/
setErrorMap(
errorMap: ValidationErrorMap<
TOnMount,
TOnChange,
TOnChangeAsync,
TOnBlur,
TOnBlurAsync,
TOnSubmit,
TOnSubmitAsync
UnwrapFormValidateOrFn<TOnMount>,
UnwrapFormValidateOrFn<TOnChange>,
UnwrapFormAsyncValidateOrFn<TOnChangeAsync>,
UnwrapFormValidateOrFn<TOnBlur>,
UnwrapFormAsyncValidateOrFn<TOnBlurAsync>,
UnwrapFormValidateOrFn<TOnSubmit>,
UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>,
UnwrapFormAsyncValidateOrFn<TOnServer>
>,
) {
this.baseStore.setState(
(prev) =>
({
...prev,
errorMap: {
...prev.errorMap,
...errorMap,
},
}) as never,
)
this.baseStore.setState((prev) => ({
...prev,
errorMap: {
...prev.errorMap,
...errorMap,
},
}))
}

/**
Expand Down
20 changes: 5 additions & 15 deletions packages/form-core/tests/FieldApi.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1785,9 +1785,7 @@ describe('field api', () => {
name: 'name',
})
nameField.mount()
nameField.setErrorMap({
onChange: "name can't be Josh",
})
nameField.setErrorMap({ onChange: "name can't be Josh" as never })
expect(nameField.getMeta().isValid).toBe(false)
expect(nameField.getMeta().errorMap.onChange).toEqual("name can't be Josh")
})
Expand All @@ -1802,14 +1800,10 @@ describe('field api', () => {
name: 'name',
})
nameField.mount()
nameField.setErrorMap({
onChange: "name can't be Josh",
})
nameField.setErrorMap({ onChange: "name can't be Josh" as never })
expect(nameField.getMeta().isValid).toBe(false)
expect(nameField.getMeta().errorMap.onChange).toEqual("name can't be Josh")
nameField.setErrorMap({
onBlur: 'name must begin with uppercase',
})
nameField.setErrorMap({ onBlur: 'name must begin with uppercase' as never })
expect(nameField.getMeta().isValid).toBe(false)
expect(nameField.getMeta().errorMap.onChange).toEqual("name can't be Josh")
expect(nameField.getMeta().errorMap.onBlur).toEqual(
Expand All @@ -1827,14 +1821,10 @@ describe('field api', () => {
name: 'name',
})
nameField.mount()
nameField.setErrorMap({
onChange: "name can't be Josh",
})
nameField.setErrorMap({ onChange: "name can't be Josh" as never })
expect(nameField.getMeta().isValid).toBe(false)
expect(nameField.getMeta().errorMap.onChange).toEqual("name can't be Josh")
nameField.setErrorMap({
onChange: 'other validation error',
})
nameField.setErrorMap({ onChange: 'other validation error' as never })
expect(nameField.getMeta().errorMap.onChange).toEqual(
'other validation error',
)
Expand Down
64 changes: 64 additions & 0 deletions packages/form-core/tests/FieldApi.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -394,3 +394,67 @@ it('should only have field-level error types returned from parseValueWithSchema
Promise<StandardSchemaV1Issue[] | undefined>
>()
})

it("should allow setting manual errors according to the validator's return type", () => {
const form = new FormApi({
defaultValues: {
firstName: '',
lastName: '',
},
validators: {
onChange: () => {
return {
fields: {
firstName: '123' as const,
},
}
},
},
})

const field = new FieldApi({
form,
name: 'firstName',
validators: {
onChange: () => 10 as const,
onBlur: () => ['onBlur'] as const,
},
})

field.setErrorMap({
onChange: '123',
})

expectTypeOf(field.setErrorMap).parameter(0).toEqualTypeOf<{
onMount: undefined
onChange: '123' | 10 | undefined
onBlur: readonly ['onBlur'] | undefined
onSubmit: undefined
onServer: unknown
}>
})

it('should allow setting manual errors with standard schema validators on the field level', () => {
const form = new FormApi({
defaultValues: {
firstName: '',
lastName: '',
},
})

const field = new FieldApi({
form,
name: 'firstName',
validators: {
onChange: z.string(),
},
})

expectTypeOf(field.setErrorMap).parameter(0).toEqualTypeOf<{
onMount: undefined
onChange: { message: string }[] | undefined
onBlur: undefined
onSubmit: undefined
onServer: unknown
}>
})
2 changes: 1 addition & 1 deletion packages/form-core/tests/FormApi.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,7 @@ describe('form api', () => {
field2.mount()

field1.handleBlur()
field1.setErrorMap({ onSubmit: 'test' })
field1.setErrorMap({ onSubmit: 'test' as never })

expect(field0.state.meta.isBlurred).toBe(false)
expect(field1.state.meta.isBlurred).toBe(true)
Expand Down
43 changes: 43 additions & 0 deletions packages/form-core/tests/FormApi.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,46 @@ it('should only have form-level error types returned from parseFieldValuesWithSc
Promise<FormLevelStandardSchemaIssue | undefined>
>()
})

it("should allow setting manual errors according to the validator's return type", () => {
const form = new FormApi({
defaultValues: {
firstName: '',
lastName: '',
},
validators: {
onChange: () => ['onChange'] as const,
onMount: () => 10 as const,
onBlur: () => ({ onBlur: true as const, onBlurNumber: 1 }),
onSubmit: () => 'onSubmit' as const,
onBlurAsync: () => Promise.resolve('onBlurAsync' as const),
onChangeAsync: () => Promise.resolve('onChangeAsync' as const),
onSubmitAsync: () => Promise.resolve('onSubmitAsync' as const),
},
})

expectTypeOf(form.setErrorMap).parameter(0).toEqualTypeOf<{
onMount: 10 | undefined
onChange: readonly ['onChange'] | 'onChangeAsync' | undefined
onBlur: { onBlur: true; onBlurNumber: number } | 'onBlurAsync' | undefined
onSubmit: 'onSubmit' | 'onSubmitAsync' | undefined
onServer: undefined
}>
})

it('should not allow setting manual errors if no validator is specified', () => {
const form = new FormApi({
defaultValues: {
firstName: '',
lastName: '',
},
})

expectTypeOf(form.setErrorMap).parameter(0).toEqualTypeOf<{
onMount: undefined
onChange: undefined
onBlur: undefined
onSubmit: undefined
onServer: undefined
}>
})