Standard schema validator

[gabrielgrant]

What is it?

Feature / enhancement

Description

Moves forward the work started previously in #7518 and #7281 to add Standard Schema support

Checklist

• My code follows the developer guidelines of this project
• I performed a self-review of my own code
• I added a changeset with pnpm change
• I made corresponding changes to the Qwik docs
• I added new tests to cover the fix / functionality

[changeset-bot]

🦋 Changeset detected

Latest commit: dba8561

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

This PR includes changesets to release 5 packages

Name	Type
@qwik.dev/router	Minor
eslint-plugin-qwik	Minor
@qwik.dev/core	Minor
create-qwik	Minor
@qwik.dev/react	Minor

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

[github-actions]

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name	Status	Preview	Last Commit
qwik-docs	✅ Ready (View Log)	Visit Preview	dba8561

[gabrielgrant]

AFAICT these CI failures seem to be timeouts setting up playwright, not actual failures, but I don't believe I'm able to re-run the jobs without pushing dummy commits to the branch

[gabrielgrant]

Would be great if @wmertens and @fabian-hiller could take a look at this when you have a moment. Thank you!

A few specific design questions:

1. This adds types etc into the repo to avoid an additional dependency as suggested in feat: Add Standard Schema validator to qwik-city #7518 (comment) -- this is a question of Qwik policy/preferences (personally I'd generally go the other way and rely on upstream deps whenever possible, but I'm generally building projects, not frameworks)
2. You'll probably notice StandardSchemaValidatorErrorKeyDotNotation is pretty verbose/complicated. Seems to work for nicer typing feedback than just Record<string, string[]>, but would certainly understand if the implementation complexity is deemed too high
3. this implementation only gives access to the simplified dot notation -- it does not preserve the original Standard Schema issues array. May be worth changing that to also expose the original array too

[pkg-pr-new]

Open in StackBlitz

@qwik.dev/core

npm i https://pkg.pr.new/QwikDev/qwik/@qwik.dev/core@8707

@qwik.dev/router

npm i https://pkg.pr.new/QwikDev/qwik/@qwik.dev/router@8707

eslint-plugin-qwik

npm i https://pkg.pr.new/QwikDev/qwik/eslint-plugin-qwik@8707

create-qwik

npm i https://pkg.pr.new/QwikDev/qwik/create-qwik@8707

@qwik.dev/optimizer

npm i https://pkg.pr.new/QwikDev/qwik/@qwik.dev/optimizer@8707

commit: dba8561

[gabrielgrant]

This is now rebased onto/PRed against build/v2

Since this was originally against v1, I left the existing explicit integrations with Valibot & Zod intact. If this is going to be added as part of the v2 transition, though, it's possible we may want to remove/deprecate those lib-specific integrations, and promote schema$ as the primary API. Thoughts?

[wmertens]

you have to import * as z from 'zod' so that tree shaking works

[wmertens]

QRLs can hold objects with functions in them, so maybe that would be a more ergonomic definition?

schema$({ validate: v => ({ value: { id:  Number((value as { id: string }).id) } })})

(no idea what I'm doing)