@novice1/validator-zod

Zod validator to use with @novice1/routing.

It provides a middleware that can validate req.params, req.body, req.query, req.headers, req.cookies and req.files against a schema using Zod 4.

Installation

1npm install @novice1/validator-zod

Requirements

Zod4

1npm install zod@next

Usage

Set validator

1// router.ts
2
3import routing from '@novice1/routing'
4import { validatorZod } from '@novice1/validator-zod'
5
6export default const router = routing()
7
8router.setValidators(
9  validatorZod(
10    // parseAsync params
11    { },
12    // middleware in case validation fails
13    function onerror(err, req, res, next) {
14      res.status(400).json(err)
15    }
16    // name of the property containing the schema
17    'schema'
18  )
19)

Create schema

1// schema.ts
2
3import { z } from 'zod/v4'
4import { ValidatorZodSchema } from '@novice1/validator-zod'
5import router from './router'
6
7// schema for "req.body"
8const bodySchema = z.object({                
9  name: z.string()
10})
11
12// type for "req.body"
13export type BodyItem = z.infer<typeof bodySchema>
14
15export const routeSchema: ValidatorZodSchema = z.object({
16    body: bodySchema
17})
18
19// or
20/*
21export const routeSchema: ValidatorZodSchema = {
22    body: bodySchema
23}
24*/
25
26// or
27/*
28export const routeSchema: ValidatorZodSchema = {
29    body: {                
30        name: z.string()
31    }
32}
33*/

Create route

1import routing from '@novice1/routing'
2import express from 'express'
3import router from './router'
4import { BodyItem, routeSchema } from './schema'
5
6router.post(
7  {
8    name: 'Post item',
9    path: '/items',
10
11    parameters: {
12        // the schema to validate
13        schema: routeSchema
14    },
15
16    // body parser
17    preValidators: express.json()
18  },
19  function (req: routing.Request<unknown, { name: string }, BodyItem>, res) {
20    res.json({ name: req.body.name })
21  }
22)

Overrides

Override the validator's options and the error handler for a route.

1import routing from '@novice1/routing'
2import { ValidatorZodOptions } from '@novice1/validator-zod'
3import router from './router'
4
5const onerror: routing.ErrorRequestHandler = (err, req, res) => {
6  res.status(400).json(err)
7}
8
9const validatorZodOptions: ValidatorZodOptions = { }
10
11router.get(
12  {
13    path: '/override',
14    parameters: {
15      // overrides
16      onerror, 
17      validatorZodOptions
18
19    },
20  },
21  function (req, res) {
22    // ...
23  }
24)

References

• Zod 4
• @novice1/routing