[FEAT] Allow returning anything in a validator, not just a string #1104

crutchcorn · 2025-01-09T08:43:23Z

This PR allows you to return non-string values from validators:

<form.Field name="password" validators={{onChange: () => ({hasUppercase: false, hasLowercase: true}) }} />

In addition, it also enforces type safety on the returned value on both errorMap and the errors array:

const form = new FormApi({
  defaultValues: {
    name: 'test',
  },
} as const)

const field = new FieldApi({
  form,
  name: 'name',
  validators: {
    onChange: () => {
      return 123 as const
    },
  },
})

assertType<123 | undefined>(field.state.meta.errorMap.onChange)

assertType<Array<123 | undefined>>(field.state.meta.errors)

Breaking Changes

Removes all validatorAdapters (packages, code, and props alike)
- Instead, you can use our Standard Schema support for Valibot, Zod, and ArkType
- As a result, however, Yup is no longer supported until this community PR is merged
When using Standard Schema validators:
- form.errors is now Record<string, StandardSchemaIssue[]>
- field.errors is now StandardSchemaIssue[] (flattened)
Vue 3.4 is the new minimum version
Vue JSX usage no longer works (fixes SFC usage)
TanStack Start adapter API changed (fixes Update TanStack Start adapter #1023)

TODO

Future work

Add standard schema validation for SSR adapters
Add examples for standard schema for other libraries

nx-cloud · 2025-01-09T08:43:48Z

View your CI Pipeline Execution ↗ for commit b6de203.

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	1m 29s	View ↗
`nx run-many --target=build --exclude=examples/**`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2025-02-21 03:23:36 UTC

pkg-pr-new · 2025-01-09T10:20:38Z

Open in Stackblitz

More templates

@tanstack/angular-form

npm i https://pkg.pr.new/@tanstack/angular-form@1104

@tanstack/form-core

npm i https://pkg.pr.new/@tanstack/form-core@1104

@tanstack/react-form

npm i https://pkg.pr.new/@tanstack/react-form@1104

@tanstack/lit-form

npm i https://pkg.pr.new/@tanstack/lit-form@1104

@tanstack/solid-form

npm i https://pkg.pr.new/@tanstack/solid-form@1104

@tanstack/vue-form

npm i https://pkg.pr.new/@tanstack/vue-form@1104

commit: b6de203

TODO: Refactor form adapters

…TanStack/form into return-anything-not-just-string

# Conflicts: # docs/reference/functions/mergeform.md # examples/angular/valibot/package.json # examples/angular/yup/package.json # examples/angular/zod/package.json # examples/react/query-integration/package.json # examples/react/standard-schema/package.json # examples/react/tanstack-start/package.json # examples/react/ui-libraries/package.json # examples/react/valibot/package.json # examples/react/yup/package.json # examples/react/zod/package.json # examples/solid/array/package.json # examples/solid/simple/package.json # examples/solid/valibot/package.json # examples/solid/yup/package.json # examples/solid/zod/package.json # examples/vue/array/package.json # examples/vue/simple/package.json # examples/vue/valibot/package.json # examples/vue/yup/package.json # examples/vue/zod/package.json # packages/valibot-form-adapter/package.json # packages/yup-form-adapter/package.json # packages/zod-form-adapter/package.json # pnpm-lock.yaml

Balastrong

Let's do it! 🚀

* chore: WIP adding in inferencing to validator's return type * chore: more work on fixing types * chore: wip on things more * chore: fix issues with FormApi and FieldApi * chore: add more fields to infer * chore: change typed from unknown to undefined * chore: more fixes * chore: add some new type tests * chore: add more type tests * ci: apply automated fixes and generate docs * chore: migrate React components to use new prop types * chore: move useTransform hook to new types * chore: add convinience type for AnyFormAPI and AnyFieldAPI * ci: apply automated fixes and generate docs * chore: fix NextJS and Remix adapters * chore: fix build of Start adapter * ci: apply automated fixes and generate docs * ci: apply automated fixes and generate docs * chore: fix issues with Nx on Windows * chore: fix issues with FieldAny in examples * chore: upgrade React packages to stable * chore: WIP attempt to fix Start package * chore: fix mergeForm typing * ci: apply automated fixes and generate docs * chore: migrate Angular adapter to use new API * ci: apply automated fixes and generate docs * chore: migrate Lit adapter to new generics * ci: apply automated fixes and generate docs * chore: attempt 1 at fixing Vue's types * chore: fix Vue types for JSX and Vue SFCs alike * chore: migrate Vue type to use new generics * chore: fix Vue test types * chore: fix Vue examples * ci: apply automated fixes and generate docs * chore: migrate Solid to new generics system * chore: fix Solid examples * ci: apply automated fixes and generate docs * ci: apply automated fixes and generate docs (attempt 2/3) * chore: fix issues with Solid library * chore: fix knip * chore: fix issues with error casting * chore: fix issue with ESLint * docs: show errorMap and errorarray * chore: upgrade all deps * ci: apply automated fixes and generate docs * ci: apply automated fixes and generate docs * chore: address PR feedback * ci: apply automated fixes and generate docs * chore: fix build * ci: apply automated fixes and generate docs * chore: infer from SchemaV1 * ci: apply automated fixes and generate docs * chore: fix zod form adapter test * fix: legacy validators now work as intended for fields and onChange only * Revert "fix: legacy validators now work as intended for fields and onChange only" This reverts commit 266ea98. * chore: wip migrate field away from return type to validator fn inferrencing * chore: wip handle updating meta props * chore: noinfer nothing * chore: other cleanup on the API idea * chore: revert adapter typing fix attempts * chore: delete all form adapter codebases * chore: remove now deleted packages from package.json * chore: remove Yup examples Yup does not yet support Standard Schema, so we're dropping support until it does * feat: make standard schema return Issue objects, not a single string, add `disableErrorFlat` option, remove validators props * chore: fix adapters types * chore: remove old Zod and Valibot examples Now we simply support standard schema * chore: fix CI * ci: apply automated fixes and generate docs * chore: wip fixing issues with return types * chore: WIP refactor return types TODO: Refactor form adapters * chore: add failing tests for `fields` type errors * chore: fix edgecase with "fields" return type * chore: fix standard schema typing edgecase * ci: apply automated fixes and generate docs * chore: fix Angular adapter's types * ci: apply automated fixes and generate docs * chore: fix Lit adapter * ci: apply automated fixes and generate docs * chore: fix react form types, add Standard Schema support to SSR adapters * chore: fix typing problems with errors array * chore: fix TS types for solid * chore: fix Vue TS types * chore: fix CI * ci: apply automated fixes and generate docs * docs: remove validatorAdapter mentions * ci: apply automated fixes and generate docs * docs: improve TanStack Start docs * chore: fix build artifacts * ci: apply automated fixes and generate docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

crutchcorn added the enhancement label Jan 9, 2025

crutchcorn requested a review from fulopkovacs January 9, 2025 08:43

crutchcorn mentioned this pull request Jan 9, 2025

feat: return an array of errors from a single validator (custom & schema library) #1090

Closed

crutchcorn changed the title ~~[FIX] Allow returning anything in a validator, not just a string~~ [WIP] [FIX] Allow returning anything in a validator, not just a string Jan 9, 2025

crutchcorn marked this pull request as draft January 9, 2025 08:56

This was referenced Jan 9, 2025

[Tracking] The Road to 1.x #813

Closed

chore(deps): lock file maintenance #1093

Closed

crutchcorn changed the title ~~[WIP] [FIX] Allow returning anything in a validator, not just a string~~ [WIP] [FEAT] Allow returning anything in a validator, not just a string Jan 10, 2025

This was referenced Jan 10, 2025

Update TanStack Start adapter #1023

Closed

[WIP] fix: fix issues with Vue's typings in SFC format #816

Closed

crutchcorn and others added 18 commits January 11, 2025 09:55

chore: WIP adding in inferencing to validator's return type

44a71cf

chore: more work on fixing types

d9ef915

chore: wip on things more

8b87404

chore: fix issues with FormApi and FieldApi

d2544c7

chore: add more fields to infer

9c1caef

chore: change typed from unknown to undefined

901efb3

chore: more fixes

9b18dbd

chore: add some new type tests

97767f4

chore: add more type tests

5263c16

ci: apply automated fixes and generate docs

e321a09

chore: migrate React components to use new prop types

05e3e99

chore: move useTransform hook to new types

00963bd

chore: add convinience type for AnyFormAPI and AnyFieldAPI

be575af

ci: apply automated fixes and generate docs

f2e0d00

chore: fix NextJS and Remix adapters

6de25f3

chore: fix build of Start adapter

65c31b6

ci: apply automated fixes and generate docs

e902f69

ci: apply automated fixes and generate docs

0035012

crutchcorn and others added 12 commits February 17, 2025 04:31

chore: WIP refactor return types

1babf8b

TODO: Refactor form adapters

chore: add failing tests for fields type errors

557e38e

chore: fix edgecase with "fields" return type

281a6a5

chore: fix standard schema typing edgecase

00aa775

ci: apply automated fixes and generate docs

9b35d68

chore: fix Angular adapter's types

b5625df

ci: apply automated fixes and generate docs

2326b61

chore: fix Lit adapter

d376907

Merge branch 'return-anything-not-just-string' of https://github.com/…

bd80301

…TanStack/form into return-anything-not-just-string

ci: apply automated fixes and generate docs

de50637

chore: fix react form types, add Standard Schema support to SSR adapters

b4dbdaf

Merge branch 'return-anything-not-just-string' of https://github.com/…

5cacd55

…TanStack/form into return-anything-not-just-string

Balastrong mentioned this pull request Feb 20, 2025

feat(core): add getAllErrors to form api #1155

Merged

2 tasks

crutchcorn and others added 6 commits February 20, 2025 17:44

chore: fix typing problems with errors array

0c60ab3

chore: fix TS types for solid

76c66f2

chore: fix Vue TS types

bf95c7e

chore: fix CI

fcf65a7

ci: apply automated fixes and generate docs

85039de

crutchcorn changed the title ~~[WIP] [FEAT] Allow returning anything in a validator, not just a string~~ [FEAT] Allow returning anything in a validator, not just a string Feb 21, 2025

crutchcorn and others added 3 commits February 20, 2025 18:39

docs: remove validatorAdapter mentions

d860383

ci: apply automated fixes and generate docs

39d64dc

docs: improve TanStack Start docs

41c6275

crutchcorn marked this pull request as ready for review February 21, 2025 02:50

crutchcorn and others added 2 commits February 20, 2025 19:20

chore: fix build artifacts

2c4bb17

ci: apply automated fixes and generate docs

b6de203

Balastrong approved these changes Feb 21, 2025

View reviewed changes

crutchcorn merged commit d8ed149 into main Feb 21, 2025
7 of 8 checks passed

crutchcorn deleted the return-anything-not-just-string branch February 21, 2025 11:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEAT] Allow returning anything in a validator, not just a string #1104

[FEAT] Allow returning anything in a validator, not just a string #1104

crutchcorn commented Jan 9, 2025 •

edited

Loading

nx-cloud bot commented Jan 9, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 9, 2025 •

edited

Loading

Balastrong left a comment

[FEAT] Allow returning anything in a validator, not just a string #1104

[FEAT] Allow returning anything in a validator, not just a string #1104

Conversation

crutchcorn commented Jan 9, 2025 • edited Loading

Breaking Changes

TODO

Future work

nx-cloud bot commented Jan 9, 2025 • edited Loading

pkg-pr-new bot commented Jan 9, 2025 • edited Loading

Balastrong left a comment

Choose a reason for hiding this comment

crutchcorn commented Jan 9, 2025 •

edited

Loading

nx-cloud bot commented Jan 9, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 9, 2025 •

edited

Loading