![](\"https://i.imgur.com/KVVR2dM.png\")
\r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r \r\nThis module provides routing capabilities, allowing for easy management of application routes and middleware.
\r\n\r\n## Table of Contents\r\n\r\n- [ZyroHub - Router Module](#zyrohub---router-module)\r\n- [Table of Contents](#table-of-contents)\r\n- [Getting Started](#getting-started)\r\n - [Using Module and Registering Controllers](#using-module-and-registering-controllers)\r\n - [TypeScript Configuration](#typescript-configuration)\r\n- [Creating a Controller](#creating-a-controller)\r\n- [Route Schema](#route-schema)\r\n - [Creating Schema](#creating-schema)\r\n - [Extending a Schema (`createBase`)](#extending-a-schema-createbase)\r\n - [Simple Routes (Without Schema)](#simple-routes-without-schema)\r\n- [Automatic Validation](#automatic-validation)\r\n - [Using Zod](#using-zod)\r\n - [Using Yup](#using-yup)\r\n - [Using Class-Validator](#using-class-validator)\r\n- [Receiving Files](#receiving-files)\r\n- [HttpResponse](#httpresponse)\r\n- [Creating Middleware](#creating-middleware)\r\n - [Using Middleware in Controllers or Routes](#using-middleware-in-controllers-or-routes)\r\n- [Getting generated routes](#getting-generated-routes)\r\n- [Declaring Request and Response types](#declaring-request-and-response-types)\r\n\r\n## Getting Started\r\n\r\nTo install the router module, use one of the following package managers:\r\n\r\n[NPM Repository](https://www.npmjs.com/package/@zyrohub/module-router)\r\n\r\n```bash\r\n# npm\r\nnpm install @zyrohub/module-router\r\n# yarn\r\nyarn add @zyrohub/module-router\r\n# pnpm\r\npnpm add @zyrohub/module-router\r\n# bun\r\nbun add @zyrohub/module-router\r\n```\r\n\r\n### Using Module and Registering Controllers\r\n\r\nTo use the router module, you need to install [`@zyrohub/core`](https://www.npmjs.com/package/@zyrohub/core) and register the `RouterModule`:\r\n\r\n```typescript\r\nconst core = new Core({\r\n\tmodules: [\r\n\t\tRouterModule.mount({\r\n\t\t\t// using manual controller registration\r\n\t\t\tcontrollers: [HomeController, AuthController, StoreController],\r\n\r\n\t\t\t// or using automatic controller registration by specifying the path\r\n\t\t\tloader: {\r\n\t\t\t\tpath: `${__dirname}/controllers`,\r\n\t\t\t\t// optional glob pattern to match controller files\r\n\t\t\t\tpattern: /\\.controller\\.ts$/\r\n\t\t\t}\r\n\t\t})\r\n\t],\r\n\tproviders: [\r\n\t\t// register any services or repositories here for dependency injection\r\n\t\t// see @zyrohub/core documentation for more details\r\n\t]\r\n});\r\n\r\ncore.init();\r\n```\r\n\r\n### TypeScript Configuration\r\n\r\n⚠️ **Important:** To use the Dependency Injection system, you **must** enable `emitDecoratorMetadata` in your `tsconfig.json`.\r\n\r\n```json\r\n{\r\n\t\"compilerOptions\": {\r\n\t\t\"experimentalDecorators\": true,\r\n\t\t\"emitDecoratorMetadata\": true\r\n\t}\r\n}\r\n```\r\n\r\n## Creating a Controller\r\n\r\nYou can create a controller by using the `@Controller` decorator and defining routes with decorators like `@Get`, `@Post`, `@Put`, etc.\r\n\r\n```typescript\r\nimport { Controller, Get, HttpResponse } from '@zyrohub/module-router';\r\n\r\nimport { ProductsRepository } from './repositories/ProductsRepository.js';\r\nimport { StoreProductsSchema } from './schemas/StoreProductsSchema.js';\r\n\r\n@Controller({\r\n\tpath: '/'\r\n})\r\nclass StoreController {\r\n\t// Dependency injection can be used in the constructor\r\n\tconstructor(\r\n\t\t// inject services or other dependencies here\r\n\t\tprivate readonly productsRepository: ProductsRepository\r\n\t) {}\r\n\r\n\t@Get('/products', StoreProductsSchema)\r\n\tgetProducts(context: typeof StoreProductsSchema.context) {\r\n\t\treturn HttpResponse.success({ products: this.productsRepository.findAll() });\r\n\t}\r\n}\r\n```\r\n\r\n## Route Schema\r\n\r\n### Creating Schema\r\n\r\n```typescript\r\nconst LoginSchema = new RouteSchema({\r\n\tbody: {}, // see supported validation below\r\n\tquery: {}, // see supported validation below\r\n\tparams: {}, // see supported validation below\r\n\r\n\tconsumes: [], // filter accepted content types (default: [\"application/json\"])\r\n\r\n\tfiles: {\r\n\t\t// see files configuration below\r\n\t\tfields: [],\r\n\t\toptions: {}\r\n\t},\r\n\r\n\t// Optional metadata for documentation purposes\r\n\tmeta: {\r\n\t\ttags: ['auth', 'login'],\r\n\t\tsummary: 'User login endpoint',\r\n\t\tdescription: 'Endpoint for user login that validates input data'\r\n\t}\r\n});\r\n```\r\n\r\nUsing the above schema, you can define the route schema and type the `context` parameter in your handler to ensure type safety and validation.\r\n\r\n```typescript\r\nimport { Controller, Post, HttpResponse } from '@zyrohub/module-router';\r\n\r\nimport { LoginSchema } from './schemas/LoginSchema.js';\r\n\r\n@Controller({\r\n\tpath: '/auth'\r\n})\r\nclass AuthController {\r\n\t@Post('/login', LoginSchema)\r\n\tlogin(context: typeof LoginSchema.context) {\r\n\t\tconst body = context.request.body; // Access typed and validated body\r\n\t\tconst query = context.request.query; // Access typed and validated query\r\n\t\tconst params = context.request.params; // Access typed and validated params\r\n\r\n\t\t// Your login logic here\r\n\r\n\t\treturn HttpResponse.success({ token: '