Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaldziuba03/nestjs-zod
Zod Validation Pipe for NestJS framework
https://github.com/michaldziuba03/nestjs-zod
nest nest-pipe nestjs nestjs-zod zod zod-nestjs
Last synced: about 2 months ago
JSON representation
Zod Validation Pipe for NestJS framework
- Host: GitHub
- URL: https://github.com/michaldziuba03/nestjs-zod
- Owner: michaldziuba03
- License: mit
- Created: 2023-09-07T18:21:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-08T14:41:25.000Z (over 1 year ago)
- Last Synced: 2024-10-12T09:46:22.732Z (3 months ago)
- Topics: nest, nest-pipe, nestjs, nestjs-zod, zod, zod-nestjs
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS Zod Pipe
> This library is in experimental stage of development.
Zod pipe for NestJS framework. Replacement for default `class-validator`.
## Installation
> Library is not available in npm registry yet.
```sh
# with npm:
npm install zod @md03/nestjs-zod
# with pnpm:
pnpm add zod @md03/nestjs-zod
# with yarn:
yarn add zod @md03/nestjs-zod
```
## Usage
### Register Zod Pipe globally
```ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ZodValidationPipe } from '@md03/nestjs-zod';
export async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useGlobalPipes(new ZodValidationPipe());
await app.listen(3000);
}
```
### Define Zod schemas and DTOs
```ts
import { z } from 'zod';
import { createDto } from '@md03/nestjs-zod';
const registerSchema = z.object({
email: z.string().email(),
password: z.string().min(8).max(128),
age: z.number().int().default(18),
});
export class RegisterDto extends createDto(registerSchema) {}
const createPostSchema = z.object({
title: z.string().min(3).max(64),
content: z.string().max(500).optional(),
});
export class CreatePostDto extends createDto(createPostSchema) {}
```
### Use DTOs in Controller
```ts
import { Body, Controller, Post } from '@nestjs/common';
import { CreatePostDto, RegisterDto } from './app.schemas';
@Controller()
export class AppController {
@Post('register')
registerUser(@Body() body: RegisterDto) {
return body;
}
@Post('posts')
createPost(@Body() body: CreatePostDto) {
return body;
}
}
```
## HTTP Error example
For now it's not possible to customize HTTP response error shape.
```json
{
"error": "Bad Request",
"message": "Validation error",
"statusCode": 400,
"fields": {
"title": [
"String must contain at least 3 character(s)"
]
}
}
```
## Usage with Swagger
```ts
import { generateSwagger } from '@md03/nestjs-zod';
const complexSchema = z.object({
id: z.string().uuid(),
username: z.string().min(3).max(64),
bio: z.string().max(100).default('my default value'),
email: z.string().email(),
role: z.nativeEnum(Role),
addresses: z.array(z.string().max(100).nonempty()).max(10).nonempty(),
links: z
.array(
z.object({
logo: z.enum(['twitter', 'facebook', 'tiktok']),
link: z.string().url(),
nestedObj: z.object({ key: z.string() }),
}),
)
.max(5),
hashmap: z.record(z.number()).optional(),
createdAt: z.string().datetime(),
});
export class ComplexSchemaDto extends createDto(complexSchema) {}
// Attach NestJS Swagger metadata to the class:
generateSwagger(ComplexSchemaDto);
```
### Generated schema:
## License
Distributed under the MIT License. See `LICENSE` for more information.