next-zod-validation

This package provides a helper function to automatically validate Zod schemas and provide typesafety in route handlers

Installation

To install:

1npm install next-zod-validation

Usage

1// app/api/[slug]/route.ts
2import { withValidation } from 'next-zod-validation';
3import { z } from 'zod';
4
5const bodySchema = z.object({
6  name: z.string(),
7});
8
9const paramsSchema = z.object({
10  slug: z.string().max(5),
11});
12
13const querySchema = z.object({
14  limit: z.coerce.number(), // URL search params are strings by default
15});
16
17//POST http://localhost:3000/api/test?limit=10 (Body: "{"name": "john doe"}")
18export const POST = withValidation(
19  {
20    body: bodySchema,
21    params: paramsSchema,
22    query: querySchema,
23  },
24  async ({ req, body, params, query }) => {
25    const { name } = body;
26    const { slug } = params;
27    const { limit } = query;
28
29    return NextResponse.json(body);
30  },
31);

API

1withValidation({
2    body,   // (optional) Body schema
3    params, // (optional) URL params schema
4    query,   // (optional) Search params schema
5    options?: {
6        messages?: {
7            body?: "Custom body error return message",
8            params?: "Custom body params return message",
9            query?: "Custom body query return message",
10        }
11    }
12}, async ({ req, body params, query }) => {
13    return new Response(JSON.stringfy({ message: "Hello!" }))
14})

Note: Validation (and subsequently error responses) first handles the body, then params, and then query. Another note: By default, URL search params are strings

Contributing

All contributions are welcome! Please make an issue first for discussion.