@nest-openapi/validator 0.1.1 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 nest-openapi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,111 +1,194 @@
-<p align="center">
-  <img src="./docs/public/nest-openapi-logo.png" alt="nest-openapi-logo" height="84" />
-</p>
-
-<h1 align="center">@nest-openapi</h1>
-
-<p align="center"><strong>OpenAPI‑first utilities for NestJS</strong></p>
-
-<p align="center">
-  Single source of truth · Drop‑in for NestJS · Fast by design
-</p>
-
-![GitHub License](https://img.shields.io/github/license/ts-oas/nest-openapi)
-
-## Overview
-
-`@nest-openapi` is a modern, modular set of utilities for building OpenAPI‑driven NestJS apps.
-
-- **Single Source of Truth** — The OpenAPI spec is the contract; validation and serialization derive from it.
-- **Drop‑in for NestJS** — Works with existing controllers and routes.
-- **Fast by Design** — AJV validation and fast-json-stringify serialization with caching and precompilation.
-- **Express & Fastify** — Platform‑agnostic support.
-- **Fine‑Grained Control** — Per‑route opt‑out and overrides.
-
-### Packages
-
-- [**`@nest-openapi/validator`**](https://nest-openapi.github.io/validator/) — Automatic request/response validation using your OpenAPI specification.
-
-- [**`@nest-openapi/serializer`**](https://nest-openapi.github.io/serializer/) — High‑performance response serialization based on your OpenAPI 3.x specification.
-
----
-
-## Get Started
-
-### @nest-openapi/validator
-
-[![NPM – validator](https://img.shields.io/npm/v/%40nest-openapi%2Fvalidator.svg)](https://www.npmjs.com/package/%40nest-openapi%2Fvalidator)
-![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40nest-openapi%2Fvalidator.svg)
-
-Install:
-
-```bash
-npm i @nest-openapi/validator
-```
-
-Minimal setup:
-
-```typescript
-// app.module.ts
-import { Module } from "@nestjs/common";
-import { OpenAPIValidatorModule } from "@nest-openapi/validator";
-import * as openApiSpec from "./openapi.json";
-
-@Module({
-  imports: [
-    OpenAPIValidatorModule.forRoot({
-      specSource: { type: "object", spec: openApiSpec },
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-All routes are automatically validated. **For advanced configuration, see [the docs](https://nest-openapi.github.io/validator/)**.
-
-### @nest-openapi/serializer
-
-[![NPM – serializer](https://img.shields.io/npm/v/%40nest-openapi%2Fserializer.svg)](https://www.npmjs.com/package/%40nest-openapi%2Fserializer)
-![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40nest-openapi%2Fserializer.svg)
-
-Install:
-
-```bash
-npm i @nest-openapi/serializer
-```
-
-Minimal setup:
-
-```typescript
-// app.module.ts
-import { Module } from "@nestjs/common";
-import { OpenAPISerializerModule } from "@nest-openapi/serializer";
-import * as openApiSpec from "./openapi.json";
-
-@Module({
-  imports: [
-    OpenAPISerializerModule.forRoot({
-      specSource: { type: "object", spec: openApiSpec },
-      responseSerialization: { enable: true, skipErrorResponses: true },
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-Successful responses are automatically serialized. **For advanced configuration, see [the docs](https://nest-openapi.github.io/serializer/)**.
-
----
-
-## Compatibility
-
-- Works with NestJS v9+
-- Supports Express and Fastify adopters
-
-## Contributing
-
-Issues and PRs are welcome. Please check the package folders and docs before opening an issue.
-
-## License
-
-MIT © `@nest-openapi`
+<p align="center">
+  <img src="./docs/public/nest-openapi-logo.png" alt="nest-openapi-logo" height="84" />
+</p>
+
+<h1 align="center">@nest-openapi</h1>
+
+<p align="center"><strong>OpenAPI‑first utilities for NestJS</strong></p>
+
+<p align="center">
+  Single source of truth · Drop‑in for NestJS · Fast by design
+</p>
+
+<p align="center">
+  <a href="https://deepwiki.com/ts-oas/nest-openapi"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
+  <a href="https://github.com/ts-oas/nest-openapi/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/ts-oas/nest-openapi" alt="License" />
+  </a>
+</p>
+
+---
+
+## Features
+
+- **🎯 Single Source of Truth** — Your OpenAPI spec drives validation, serialization, mocking, and MCP tools.
+- **⚡ Fast by Design** — AJV validation and `fast-json-stringify` serialization with caching and precompilation.
+- **🔌 Drop-in Integration** — Works with existing NestJS controllers and routes
+- **🎛️ Fine-Grained Control** — Per-route opt-out and custom schema overrides
+- **🚀 Platform Agnostic** — Supports both Express and Fastify adapters
+
+## Packages
+
+| Package                                                                  | Description                                                        | Version                                                                                                                     |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
+| [`@nest-openapi/validator`](https://nest-openapi.github.io/validator/)   | Automatic request/response validation using your OpenAPI spec      | [![npm](https://img.shields.io/npm/v/@nest-openapi/validator.svg)](https://www.npmjs.com/package/@nest-openapi/validator)   |
+| [`@nest-openapi/serializer`](https://nest-openapi.github.io/serializer/) | High-performance response serialization based on your OpenAPI spec | [![npm](https://img.shields.io/npm/v/@nest-openapi/serializer.svg)](https://www.npmjs.com/package/@nest-openapi/serializer) |
+| [`@nest-openapi/mock`](https://nest-openapi.github.io/mock/)             | Spec-driven mock server for generating realistic mock responses    | [![npm](https://img.shields.io/npm/v/@nest-openapi/mock.svg)](https://www.npmjs.com/package/@nest-openapi/mock)             |
+| [`@nest-openapi/mcp`](https://nest-openapi.github.io/mcp/)               | Spec-driven MCP server for exposing OpenAPI operations as tools    | [![npm](https://img.shields.io/npm/v/@nest-openapi/mcp.svg)](https://www.npmjs.com/package/@nest-openapi/mcp)               |
+
+## Quick Start
+
+### Validator
+
+```bash
+npm i @nest-openapi/validator
+```
+
+```typescript
+import { Module } from "@nestjs/common";
+import { OpenAPIValidatorModule } from "@nest-openapi/validator";
+import * as openApiSpec from "./openapi.json";
+
+@Module({
+  imports: [
+    OpenAPIValidatorModule.forRoot({
+      specSource: { type: "object", spec: openApiSpec },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+**All routes are automatically validated.** See [full documentation](https://nest-openapi.github.io/validator/) for advanced configuration.
+
+### Serializer
+
+```bash
+npm i @nest-openapi/serializer
+```
+
+```typescript
+import { Module } from "@nestjs/common";
+import { OpenAPISerializerModule } from "@nest-openapi/serializer";
+import * as openApiSpec from "./openapi.json";
+
+@Module({
+  imports: [
+    OpenAPISerializerModule.forRoot({
+      specSource: { type: "object", spec: openApiSpec },
+      responseSerialization: { enable: true, skipErrorResponses: true },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+**Responses are automatically serialized.** See [full documentation](https://nest-openapi.github.io/serializer/) for advanced configuration.
+
+### Mock
+
+```bash
+npm i @nest-openapi/mock
+```
+
+```typescript
+import { Module } from "@nestjs/common";
+import { OpenAPIMockModule } from "@nest-openapi/mock";
+import * as openApiSpec from "./openapi.json";
+
+@Module({
+  imports: [
+    OpenAPIMockModule.forRoot({
+      specSource: { type: "object", spec: openApiSpec },
+      enable: process.env.NODE_ENV === "development",
+      mockByDefault: true,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+**Routes return mocked responses when enabled.** See [full documentation](https://nest-openapi.github.io/mock/) for advanced configuration.
+
+### MCP
+
+```bash
+npm i @nest-openapi/mcp
+```
+
+```typescript
+import { Module } from "@nestjs/common";
+import { OpenAPIMcpModule } from "@nest-openapi/mcp";
+import * as openApiSpec from "./openapi.json";
+
+@Module({
+  imports: [
+    OpenAPIMcpModule.forRoot({
+      specSource: { type: "object", spec: openApiSpec },
+      http: { path: "/mcp" },
+      executor: { baseUrl: "http://127.0.0.1:3000" },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+**Expose OpenAPI operations as MCP tools.** See [full documentation](https://nest-openapi.github.io/mcp/) for advanced configuration.
+
+## Usage Examples
+
+### Manual Validation
+
+```typescript
+import { Inject, Injectable } from "@nestjs/common";
+import {
+  OPENAPI_VALIDATOR,
+  OpenAPIValidatorService,
+} from "@nest-openapi/validator";
+
+@Injectable()
+export class MyService {
+  constructor(
+    @Inject(OPENAPI_VALIDATOR)
+    private readonly validator: OpenAPIValidatorService,
+  ) {}
+
+  validate(ctx: HttpArgumentsHost) {
+    const errors = this.validator.validateRequest(ctx, { body: true });
+    if (errors.length > 0) {
+      // Handle validation errors
+    }
+  }
+}
+```
+
+### Per-Route Overrides
+
+```typescript
+import { Controller, Post } from "@nestjs/common";
+import { Validate } from "@nest-openapi/validator";
+import { Serialize } from "@nest-openapi/serializer";
+
+@Controller("books")
+export class BooksController {
+  @Post()
+  @Validate({ request: { query: false }, response: true })
+  @Serialize({ disable: true })
+  create(@Body() dto: CreateBookDto): Book {
+    return this.booksService.create(dto);
+  }
+}
+```
+
+## Compatibility
+
+- Works with NestJS v9+
+- Supports Express and Fastify adapters
+
+## Contributing
+
+Issues and PRs are welcome. Please check the package folders and docs before opening an issue.
+
+## License
+
+MIT © [@nest-openapi](https://github.com/ts-oas/nest-openapi)

package/dist/index.cjs

@@ -301,7 +301,7 @@ ${JSON.stringify(data, null, 2)}`);
         });
         continue;
       }
-      if (value !== void 0 && param.schema) {
+      if (param.schema) {
         const schema = this.runtime.schemaResolver.resolveSchema(param.schema);
         if (schema) {
           const paramValue = { value };

package/dist/index.js

@@ -265,7 +265,7 @@ ${JSON.stringify(data, null, 2)}`);
         });
         continue;
       }
-      if (value !== void 0 && param.schema) {
+      if (param.schema) {
         const schema = this.runtime.schemaResolver.resolveSchema(param.schema);
         if (schema) {
           const paramValue = { value };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nest-openapi/validator",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Automatic request/response validation for NestJS using your OpenAPI specifications",
   "sideEffects": false,
   "keywords": [
@@ -13,6 +13,19 @@
     "typescript",
     "schema"
   ],
+  "homepage": "https://nest-openapi.github.io/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ts-oas/nest-openapi.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Alireza Malek",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ts-oas/nest-openapi/issues"
+  },
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -27,29 +40,6 @@
     "README.md",
     "LICENSE"
   ],
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts --target node20 --outDir dist --clean --external rxjs --external ajv --external @nestjs/common --external @nestjs/core",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "prepack": "node -e \"const fs=require('fs');const path=require('path');fs.copyFileSync(path.resolve(__dirname,'..','..','README.md'), path.resolve(__dirname,'README.md'));\"",
-    "postpack": "node -e \"const fs=require('fs');const path=require('path');try{fs.unlinkSync(path.resolve(__dirname,'README.md'))}catch(_){}\"",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "homepage": "https://nest-openapi.github.io/",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ts-oas/nest-openapi.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "author": "Alireza Malek",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ts-oas/nest-openapi/issues"
-  },
   "peerDependencies": {
     "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0",
     "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0",
@@ -62,12 +52,11 @@
     }
   },
   "dependencies": {
-    "@nest-openapi/runtime": "^0.1.1",
+    "@nest-openapi/runtime": "^0.1.2",
     "ajv": "^8.0.0",
     "rxjs": "^7.2.0"
   },
   "devDependencies": {
-    "@nest-openapi/runtime": "workspace:^",
     "@nestjs/common": "^11.0.0",
     "@nestjs/core": "^11.0.0",
     "@nestjs/platform-express": "^11.1.3",
@@ -82,7 +71,8 @@
     "supertest": "^7.1.0",
     "ts-jest": "^29.0.0",
     "tsup": "^8.5.0",
-    "typescript": "^5.9.0"
+    "typescript": "^5.9.0",
+    "@nest-openapi/runtime": "^0.1.2"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -101,5 +91,13 @@
     ],
     "coverageDirectory": "coverage",
     "testEnvironment": "node"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --target node20 --outDir dist --clean --external rxjs --external ajv --external @nestjs/common --external @nestjs/core",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
   }
-}
+}