feat(standard-validator): Add standard schema validation

[muningis]

Group of different Schema Validation libraries authors has agreed on a standard schema, so other libraries, don't have even to care what validation library you're using, as typings and output must match spec.

[changeset-bot]

🦋 Changeset detected

Latest commit: 58693dd

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

This PR includes changesets to release 1 package

Name	Type
@hono/standard-validator	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

[EdamAme-x]

great!!

[yusukebe]

Hi @muningis

This is awesome! The code below actually works!

import { Hono } from 'hono'
import { sValidator } from '@hono/standard-validator'
import { type } from 'arktype'
import * as v from 'valibot'
import { z } from 'zod'

const aSchema = type({
  agent: 'string',
})

const vSchema = v.object({
  slag: v.string(),
})

const zSchema = z.object({
  name: z.string(),
})

const app = new Hono()

app.get(
  '/:slag',
  sValidator('header', aSchema),
  sValidator('param', vSchema),
  sValidator('query', zSchema),
  (c) => {
    const headerValue = c.req.valid('header')
    const paramValue = c.req.valid('param')
    const queryValue = c.req.valid('query')
    return c.json({ headerValue, paramValue, queryValue })
  }
)

const res = await app.request('/foo?name=foo', {
  headers: {
    agent: 'foo',
  },
})

console.log(await res.json())

/**
{
  headerValue: {
    agent: "foo",
  },
  paramValue: {
    slag: "foo",
  },
  queryValue: {
    name: "foo",
  },
}
 */

I'll review this. First, can you add the CI like this: https://github.com/honojs/middleware/blob/main/.github/workflows/ci-hello.yml

[muningis]

Hy! Sure, will do it later today once I'm back from work.

[yusukebe]

Hey @fabian-hiller ! Can you review this?

[fabian-hiller]

Yes, I will review it later. Make sure to add Hono to the Standard Schema ecosystem list once this is merged. 😎

[fabian-hiller]

Once Standard Schema is accepted by the JS community, Hono could try to implement it natively to remove the adapter altogether.

[fabian-hiller]

I think there is a mismatch in package names. Here @hono/standard-schema-validator is used but in the package.json it is named @hono/standard-validator.

[fabian-hiller]

Please use the latest RC version of the spec.

[fabian-hiller]

And I would probably add it as a direct dependency and not as under peerDependencies and devDependencies.

[muningis]

@yusukebe WDYT? For example, we have same with other validators, such as zod or valibot.

[fabian-hiller]

To clarify, when using the Hono Valibot adapter, you already have Valibot installed, otherwise the adapter makes no sense. With Standard Schema this is different, as any library that supports the spec is compatible. Users will never install Standard Schema themselves. Note that Standard Schema contains only types and no runtime code.

[fabian-hiller]

I have heard that dev dependencies may not be installed when a package is installed. So adding it as a dependency might be safer. But feel free to investigate and report back.

[yusukebe]

@muningis

I think you should add @standard-schema/spec as a direct dependency, as @fabian-hiller pointed out. It is used in packages/standard-validator/src/index.ts, so it's natural to do it.

[fabian-hiller]

schema['~standard'].types is always undefined at runtime because we just store type information here. This implementation should probably be changed or removed.

[muningis]

Hm, I guess tests has issues then if they passed. Will have to adjust.
And it will have to be changed, as we need to re-write keys of a schema/shape, so that all keys are lower-cased.

[fabian-hiller]

This is not possible. Standard Schema does not contain an AST-like structure. Why is it necessary to rewrite the keys? Shouldn't users take care of this when writing the schema?

[fabian-hiller]

Is type casting necessary here? result.value should already be typed after we know result.issues is undefined.

[muningis]

Unfortunately, yeah. (Same is required by zod and valibot validators).

It comes down to some type issues coming from hono/validator (haven't had chance to dive in yet).