feat(standard-validator): Add standard schema validation (#887)

* feat(standard-validator): Add standard schema validation

* feat(standard-validator): add changeset

* feat(standard-validator): reintroduce type tests

* feat(standard-validator): simplif tests

* build(standard-validator): add gitlab pipeline

* chore(standard-validator): remove redundant files

* feat(standard-validator): cleanup tests, adjust comments

* fix(standard-validator): adjust versions, fix doc

* build: fix lockfile

* feat(standard-validator): drop headers lower-casing, update readme

* check types in test dir and add `tsc` to the test command

Author: muningis

.changeset/modern-bugs-search.md

@@ -0,0 +1,5 @@
+---
+'@hono/standard-validator': minor
+---
+
+Initial implementation for Standard Schema support

.github/workflows/ci-standard-validator.yml

@@ -0,0 +1,25 @@
+name: ci-standard-validator
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'packages/standard-validator/**'
+  pull_request:
+    branches: ['*']
+    paths:
+      - 'packages/standard-validator/**'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/standard-validator
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - run: yarn test

package.json

@@ -41,6 +41,7 @@
     "build:ajv-validator": "yarn workspace @hono/ajv-validator build",
     "build:tsyringe": "yarn workspace @hono/tsyringe build",
     "build:cloudflare-access": "yarn workspace @hono/cloudflare-access build",
+    "build:standard-validator": "yarn workspace @hono/standard-validator build",
     "build": "run-p 'build:*'",
     "lint": "eslint 'packages/**/*.{ts,tsx}'",
     "lint:fix": "eslint --fix 'packages/**/*.{ts,tsx}'",

packages/node-ws/package.json

@@ -48,4 +48,4 @@
   "engines": {
     "node": ">=18.14.1"
   }
-}
+}

packages/standard-validator/README.md

@@ -0,0 +1,65 @@
+# Standard Schema validator middleware for Hono
+
+The validator middleware using [Standard Schema Spec](https://github.com/standard-schema/standard-schema) for [Hono](https://honojs.dev) applications.
+You can write a schema with any validation library supporting Standard Schema and validate the incoming values.
+
+## Usage
+
+
+### Basic:
+```ts
+import { z } from 'zod'
+import { sValidator } from '@hono/standard-validator'
+
+const schema = z.object({
+  name: z.string(),
+  age: z.number(),
+});
+
+app.post('/author', sValidator('json', schema), (c) => {
+  const data = c.req.valid('json')
+  return c.json({
+    success: true,
+    message: `${data.name} is ${data.age}`,
+  })
+})
+```
+
+### Hook:
+```ts
+app.post(
+  '/post',
+  sValidator('json', schema, (result, c) => {
+    if (!result.success) {
+      return c.text('Invalid!', 400)
+    }
+  })
+  //...
+)
+```
+
+### Headers:
+Headers are internally transformed to lower-case in Hono. Hence, you will have to make them lower-cased in validation object.
+```ts
+import { object, string } from 'valibot'
+import { sValidator } from '@hono/standard-validator'
+
+const schema = object({
+  'content-type': string(),
+  'user-agent': string()
+});
+
+app.post('/author', sValidator('header', schema), (c) => {
+  const headers = c.req.valid('header')
+  // do something with headers
+})
+```
+
+
+## Author
+
+Rokas Muningis <https://github.com/muningis>
+
+## License
+
+MIT

packages/standard-validator/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hono/standard-validator",
+  "version": "0.0.0",
+  "description": "Validator middleware using Standard Schema",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "tsc --noEmit && vitest --run",
+    "build": "tsup ./src/index.ts --format esm,cjs --dts",
+    "publint": "publint",
+    "prerelease": "yarn build && yarn test",
+    "release": "yarn publish"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/honojs/middleware.git"
+  },
+  "homepage": "https://github.com/honojs/middleware",
+  "peerDependencies": {
+    "@standard-schema/spec": "1.0.0",
+    "hono": ">=3.9.0"
+  },
+  "devDependencies": {
+    "@standard-schema/spec": "1.0.0",
+    "arktype": "^2.0.0-rc.26",
+    "hono": "^4.0.10",
+    "publint": "^0.2.7",
+    "tsup": "^8.1.0",
+    "typescript": "^5.7.3",
+    "valibot": "^1.0.0-beta.9",
+    "vitest": "^1.4.0",
+    "zod": "^3.24.0"
+  }
+}

packages/standard-validator/src/index.ts

@@ -0,0 +1,84 @@
+import type { Context, Env, Input, MiddlewareHandler, TypedResponse, ValidationTargets } from 'hono'
+import { validator } from 'hono/validator'
+import type { StandardSchemaV1 } from '@standard-schema/spec'
+
+type HasUndefined<T> = undefined extends T ? true : false
+type TOrPromiseOfT<T> = T | Promise<T>
+
+type Hook<
+  T,
+  E extends Env,
+  P extends string,
+  Target extends keyof ValidationTargets = keyof ValidationTargets,
+  O = {}
+> = (
+  result: (
+    | { success: boolean; data: T }
+    | { success: boolean; error: ReadonlyArray<StandardSchemaV1.Issue>; data: T }
+  ) & {
+    target: Target
+  },
+  c: Context<E, P>
+) => TOrPromiseOfT<Response | void | TypedResponse<O>>
+
+const isStandardSchemaValidator = (validator: unknown): validator is StandardSchemaV1 =>
+  !!validator && typeof validator === 'object' && '~standard' in validator
+
+const sValidator = <
+  Schema extends StandardSchemaV1,
+  Target extends keyof ValidationTargets,
+  E extends Env,
+  P extends string,
+  In = StandardSchemaV1.InferInput<Schema>,
+  Out = StandardSchemaV1.InferOutput<Schema>,
+  I extends Input = {
+    in: HasUndefined<In> extends true
+      ? {
+          [K in Target]?: In extends ValidationTargets[K]
+            ? In
+            : { [K2 in keyof In]?: ValidationTargets[K][K2] }
+        }
+      : {
+          [K in Target]: In extends ValidationTargets[K]
+            ? In
+            : { [K2 in keyof In]: ValidationTargets[K][K2] }
+        }
+    out: { [K in Target]: Out }
+  },
+  V extends I = I
+>(
+  target: Target,
+  schema: Schema,
+  hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>
+): MiddlewareHandler<E, P, V> =>
+  // @ts-expect-error not typed well
+  validator(target, async (value, c) => {
+    const result = await schema['~standard'].validate(value)
+
+    if (hook) {
+      const hookResult = await hook(
+        !!result.issues
+          ? { data: value, error: result.issues, success: false, target }
+          : { data: value, success: true, target },
+        c
+      )
+      if (hookResult) {
+        if (hookResult instanceof Response) {
+          return hookResult
+        }
+
+        if ('response' in hookResult) {
+          return hookResult.response
+        }
+      }
+    }
+
+    if (result.issues) {
+      return c.json({ data: value, error: result.issues, success: false }, 400)
+    }
+
+    return result.value as StandardSchemaV1.InferOutput<Schema>
+  })
+
+export type { Hook }
+export { sValidator }

packages/standard-validator/test/__schemas__/arktype.ts

@@ -0,0 +1,36 @@
+import { type } from 'arktype'
+
+const personJSONSchema = type({
+  name: 'string',
+  age: 'number',
+})
+
+const postJSONSchema = type({
+  id: 'number',
+  title: 'string',
+})
+
+const idJSONSchema = type({
+  id: 'string',
+})
+
+const queryNameSchema = type({
+  'name?': 'string',
+})
+
+const queryPaginationSchema = type({
+  page: type('unknown').pipe((p) => Number(p)),
+})
+
+const querySortSchema = type({
+  order: "'asc'|'desc'",
+})
+
+export {
+  idJSONSchema,
+  personJSONSchema,
+  postJSONSchema,
+  queryNameSchema,
+  queryPaginationSchema,
+  querySortSchema,
+}

packages/standard-validator/test/__schemas__/valibot.ts

@@ -0,0 +1,38 @@
+import { object, string, number, optional, pipe, unknown, transform, picklist } from 'valibot'
+
+const personJSONSchema = object({
+  name: string(),
+  age: number(),
+})
+
+const postJSONSchema = object({
+  id: number(),
+  title: string(),
+})
+
+const idJSONSchema = object({
+  id: string(),
+})
+
+const queryNameSchema = optional(
+  object({
+    name: optional(string()),
+  })
+)
+
+const queryPaginationSchema = object({
+  page: pipe(unknown(), transform(Number)),
+})
+
+const querySortSchema = object({
+  order: picklist(['asc', 'desc']),
+})
+
+export {
+  idJSONSchema,
+  personJSONSchema,
+  postJSONSchema,
+  queryNameSchema,
+  queryPaginationSchema,
+  querySortSchema,
+}

packages/standard-validator/test/__schemas__/zod.ts

@@ -0,0 +1,38 @@
+import { z } from 'zod'
+
+const personJSONSchema = z.object({
+  name: z.string(),
+  age: z.number(),
+})
+
+const postJSONSchema = z.object({
+  id: z.number(),
+  title: z.string(),
+})
+
+const idJSONSchema = z.object({
+  id: z.string(),
+})
+
+const queryNameSchema = z
+  .object({
+    name: z.string().optional(),
+  })
+  .optional()
+
+const queryPaginationSchema = z.object({
+  page: z.coerce.number(),
+})
+
+const querySortSchema = z.object({
+  order: z.enum(['asc', 'desc']),
+})
+
+export {
+  idJSONSchema,
+  personJSONSchema,
+  postJSONSchema,
+  queryNameSchema,
+  queryPaginationSchema,
+  querySortSchema,
+}