Type and Runtime validated request utils

[pi0]

Currently, we have utils such as readBody(event) and getParams(event) which both have any or unspecific types and have no runtime validation.

The idea is to expose request utils that are both runtime and type safe.

We might expose some core request validation utils (that require a custom validator function and have default strict unknown type) + h3/zod integration that provides them.

Current solutions:

• h3-zod by @wobsoriano ❤️
• h3-typebox by @kevinmarrec ❤️

Related discussions:

• support additional generic for typing incoming body & query #129
• readBody has a default returnType of Promise<any> instead of Promise<unknown> #386 / fix(readBody): set default return type to unknown #387

[Hebilicious]

We could accept a validator function as the 2nd argument. Thenh3/zod or h3/typebox can directly integrate.

import { validator } from "h3/zod"
 const bodySchema = z//...
 const paramSchema = z//...
 const body = await readBody(event, validator(bodySchema, (result) => { if(!result.sucess) return createError() })) 
 const params = await getParams(event, validator(paramSchema, (result) => { if(!result.sucess) return createError() })) 

Btw we could add readParams for consistency.

[wobsoriano]

Saw this package that might be helpful - https://github.com/decs/typeschema

Basically allows you to use any validation library you want:

import type { Infer, Schema } from '@decs/typeschema';
import { assert}  from '@decs/typeschema';

// Use your favorite validation library, e.g. `zod`, `arktype`, `typia`
const schema: Schema<string> = z.string();
const schema: Schema<string> = type('string');
const schema: Schema<string> = typia.createAssert<string>();

// Extracts the schema type
type Type = Infer<typeof schema>; // `string`

[Hebilicious]

Saw this package that might be helpful - decs/typeschema

Basically allows you to use any validation library you want:

import type { Infer, Schema } from '@decs/typeschema';
import { assert}  from '@decs/typeschema';

// Use your favorite validation library, e.g. `zod`, `arktype`, `typia`
const schema: Schema<string> = z.string();
const schema: Schema<string> = type('string');
const schema: Schema<string> = typia.createAssert<string>();

// Extracts the schema type
type Type = Infer<typeof schema>; // `string`

This is absolutely great. We can have something like this that works with every validation library.

 const body = await readBody(event, validator(schema, (error) => createError())) 

@wobsoriano do you have another suggestion for the API design ?

[wobsoriano]

@Hebilicious assuming validator function in there accepts different validation libraries, it looks good!

[Hebilicious]

@wobsoriano It does ! Look at #431

[pi0]

Core utils landing in next version #459