Add ParseOptions argument to standardSchemaV1

[rehos]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Add optional ParseOptions argument to standardSchemaV1. This will make form validation in form libraries like @tanstack/form more usable (i.e. display all errors to the user instead of just the first)

[changeset-bot]

🦋 Changeset detected

Latest commit: 6295bb7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 36 packages

Name	Type
effect	Patch
@effect/cli	Patch
@effect/cluster-browser	Patch
@effect/cluster-node	Patch
@effect/cluster-workflow	Patch
@effect/cluster	Patch
@effect/experimental	Patch
@effect/opentelemetry	Patch
@effect/platform-browser	Patch
@effect/platform-bun	Patch
@effect/platform-node-shared	Patch
@effect/platform-node	Patch
@effect/platform	Patch
@effect/printer-ansi	Patch
@effect/printer	Patch
@effect/rpc-http	Patch
@effect/rpc	Patch
@effect/sql-clickhouse	Patch
@effect/sql-d1	Patch
@effect/sql-drizzle	Patch
@effect/sql-kysely	Patch
@effect/sql-libsql	Patch
@effect/sql-mssql	Patch
@effect/sql-mysql2	Patch
@effect/sql-pg	Patch
@effect/sql-sqlite-bun	Patch
@effect/sql-sqlite-do	Patch
@effect/sql-sqlite-node	Patch
@effect/sql-sqlite-react-native	Patch
@effect/sql-sqlite-wasm	Patch
@effect/sql	Patch
@effect/typeclass	Patch
@effect/vitest	Patch
@effect/ai	Patch
@effect/ai-anthropic	Patch
@effect/ai-openai	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[gcanti]

I wonder if we should make { errors: "all" } the default. AFAIK, the spec doesn't specify how many issues should be raised by default.

[rehos]

I would prefer the default with { errors: "all" }. Should we do something like:

export const standardSchemaV1 = <A, I>(
  schema: Schema<A, I, never>,
  overrideOptions?: AST.ParseOptions // Changed
): StandardSchemaV1<I, A> => {
  const decodeUnknown = ParseResult.decodeUnknown(schema, { errors: "all" }) // Changed
  return {
    "~standard": {
      version: 1,
      vendor: "effect",
      validate(value) {
        const scheduler = new scheduler_.SyncScheduler()
        const fiber = Effect.runFork(
          Effect.matchEffect(decodeUnknown(value, overrideOptions), { // Changed
            onFailure: makeStandardFailureFromParseIssue,
            onSuccess: (value) => Effect.succeed({ value })
          }),
          { scheduler }
        )
        scheduler.flush()
        const exit = fiber.unsafePoll()
        if (exit) {
          return makeStandardResult(exit)
        }
        return new Promise((resolve) => {
          fiber.addObserver((exit) => {
            resolve(makeStandardResult(exit))
          })
        })
      }
    }
  }
}

[gcanti]

Should we do something like:

Yes 👍

[rehos]

@gcanti I have changed the default to all errors with the possibility override the parse options. Also added an extra test for the override use case with{ errors: "first" }. And the incorrect import has been fixed.

[gcanti]

Thanks @rehos

[rehos]

Thank you @gcanti for your quick response and feedback.