@minisylar/express-typed-router 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +207 -22
- package/dist/zod-router.cjs +1 -179
- package/dist/zod-router.cjs.map +1 -1
- package/dist/zod-router.d.cts +73 -56
- package/dist/zod-router.d.ts +73 -56
- package/dist/zod-router.js +1 -154
- package/dist/zod-router.js.map +1 -1
- package/package.json +6 -5
package/dist/zod-router.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zod-router.cjs","names":["middleware: TypedMiddleware<TReq, TLocals>","path: string","optionsOrHandler: any","handler?: any","method: HttpMethod","middlewares: any[]","schema: ZodType<any, any, any>","req: Request","res: Response","next: NextFunction","z","config?: RouterConfig"],"sources":["../src/zod-router.ts"],"sourcesContent":["/**\n * @packageDocumentation\n * @module @minisylar/express-typed-router\n *\n * @title @minisylar/express-typed-router\n *\n * A strongly-typed Express router with Zod validation and automatic type inference for params, body, query, and middleware.\n *\n * @example\n * // Example 1: Basic usage with router-level middleware\n * const router = createTypedRouter()\n * .useTypedMiddleware(timestampMiddleware)\n * .useTypedMiddleware(requestIdMiddleware)\n *\n * router.get('/posts/:postId', (req, res) => {\n * const { postId } = req.params // Typed as { postId: string }\n * const { timestamp, requestId } = req // Both properties are now typed correctly!\n * res.json({ postId, timestamp, requestId })\n * })\n *\n * @example\n * // Example 2: Per-route middleware with automatic type inference\n * router.post(\n * '/posts',\n * {\n * bodySchema: CreatePostSchema,\n * middleware: [timestampMiddleware, requestIdMiddleware] as const\n * },\n * (req, res) => {\n * const { title, content, tags } = req.body // From schema validation\n * const { timestamp, requestId } = req // From middleware - should be automatically typed!\n * res.json({ title, content, tags, timestamp, requestId })\n * }\n * )\n *\n * @example\n * // Example 3: Mixed middleware\n * const router = createTypedRouter().useTypedMiddleware(requestIdMiddleware)\n * router.get(\n * '/posts/:postId',\n * {\n * middleware: [authMiddleware] as const\n * },\n * (req, res) => {\n * const { postId } = req.params\n * const { requestId } = req // From router-level middleware\n * const { userId, hasPermission } = req // From per-route middleware\n * res.json({ postId, requestId, userId, hasPermission })\n * }\n * )\n *\n * @example\n * // Example 4: Using factory with pre-configured middleware\n * const router = createTypedRouterWithMiddleware(timestampMiddleware, requestIdMiddleware)\n * router.get('/simple/:id', (req, res) => {\n * const { id } = req.params\n * const { timestamp, requestId } = req // Already available from factory setup!\n * res.json({ id, timestamp, requestId })\n * })\n *\n * @example\n * // Example 5: Demonstrating all HTTP methods\n * const router = createTypedRouter().useTypedMiddleware(requestIdMiddleware)\n *\n * // GET with query validation\n * router.get('/posts', { querySchema: QuerySchema }, (req, res) => {\n * const { limit, offset } = req.query // Typed from schema\n * const { requestId } = req // From router middleware\n * res.json({ posts: [], limit, offset, requestId })\n * })\n *\n * // POST with body validation and middleware\n * router.post(\n * '/posts',\n * {\n * bodySchema: CreatePostSchema,\n * middleware: [timestampMiddleware] as const\n * },\n * (req, res) => {\n * const { title, content } = req.body // From body schema\n * const { requestId, timestamp } = req // From middleware\n * res.json({ id: 'new-post', title, content, requestId, timestamp })\n * }\n * )\n *\n * // PUT for full updates\n * router.put(\n * '/posts/:postId',\n * {\n * bodySchema: CreatePostSchema,\n * middleware: [authMiddleware] as const\n * },\n * (req, res) => {\n * const { postId } = req.params\n * const { title, content } = req.body\n * const { requestId, userId, hasPermission } = req\n * res.json({ postId, title, content, requestId, userId, hasPermission })\n * }\n * )\n *\n * // PATCH for partial updates\n * router.patch('/posts/:postId', { bodySchema: UpdatePostSchema }, (req, res) => {\n * const { postId } = req.params\n * const updates = req.body // Partial update object\n * const { requestId } = req\n * res.json({ postId, updates, requestId })\n * })\n *\n * // DELETE\n * router.delete('/posts/:postId', (req, res) => {\n * const { postId } = req.params\n * const { requestId } = req\n * res.json({ deleted: postId, requestId })\n * })\n *\n * // OPTIONS for CORS preflight\n * router.options('/posts/*', (req, res) => {\n * res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,PATCH,DELETE')\n * res.header('Access-Control-Allow-Headers', 'Content-Type')\n * res.status(200).end()\n * })\n *\n * // HEAD for metadata only\n * router.head('/posts/:postId', (req, res) => {\n * const { postId } = req.params\n * res.header('X-Post-ID', postId)\n * res.status(200).end()\n * })\n *\n * // ALL method for catch-all routes\n * router.all('/debug/*', (req, res) => {\n * const { requestId } = req\n * res.json({\n * method: req.method,\n * path: req.path,\n * requestId\n * })\n * })\n */\n/* eslint-disable @typescript-eslint/no-empty-object-type */\nimport express, {\n type Request,\n type Response,\n type NextFunction,\n} from \"express\";\nimport { z, type ZodType } from \"zod\";\n\n/**\n * Extract route parameters from Express.js route patterns.\n *\n * Supports all Express.js routing patterns:\n * - Named parameters: /users/:userId → { userId: string }\n * - Multiple parameters: /users/:userId/books/:bookId → { userId: string; bookId: string }\n * - Parameters with separators: /flights/:from-:to → { from: string; to: string }\n * - Dot notation: /plantae/:genus.:species → { genus: string; species: string }\n * - Regex constraints: /user/:id(\\\\d+) → { id: string }\n * - Optional parameters: /posts/:year/:month? → { year: string; month?: string }\n * - Wildcard parameters: /files/* → { \"0\": string }\n * - Multiple wildcards: /a/star/b/star → { \"0\": string; \"1\": string }\n */\nexport type ExtractRouteParams<Path extends string> = string extends Path\n ? Record<string, string>\n : ExtractParams<Path>;\n\n/**\n * Main parameter extraction logic - enhanced for Express 5 support\n */\ntype ExtractParams<Path extends string> =\n // Handle Express 5 braces for optional segments: {/:param} or {/path/:param}\n Path extends `${infer Before}{${infer OptionalContent}}${infer After}`\n ? ExtractOptionalSegment<OptionalContent> &\n ExtractParams<`${Before}${After}`>\n : // Handle named parameters :paramName\n Path extends `${infer _Before}:${infer Rest}`\n ? ExtractSingleParam<Rest> & ExtractParams<RemoveFirstParam<Path>>\n : // Handle wildcards *\n Path extends `${infer _Before}*${infer After}`\n ? { [K in CountWildcards<_Before>]: string } & ExtractParams<After>\n : // No more parameters\n {};\n\n/**\n * Extract parameters from Express 5 optional segments in braces\n * Handles patterns like {/:param}, {.:ext}, {/optional/:param}\n */\ntype ExtractOptionalSegment<Content extends string> =\n // Handle optional parameter patterns like /:param\n Content extends `/:${infer Rest}`\n ? ExtractOptionalParam<Rest>\n : Content extends `.:${infer Rest}`\n ? ExtractOptionalParam<Rest>\n : Content extends `${infer _Path}:${infer Rest}`\n ? ExtractOptionalParam<Rest>\n : {};\n\n/**\n * Extract a single optional parameter from brace content\n */\ntype ExtractOptionalParam<Rest extends string> =\n Rest extends `${infer ParamName}/${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}-${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}.${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}`\n ? { [K in ParamName]?: string }\n : {};\n\n/**\n * Extract a single parameter name from the rest of the path\n * Enhanced to handle Express 5 patterns and optional parameters correctly\n * Special handling for consecutive parameters like :from-:to\n * Order matters: regex constraints must be handled before repeating parameters\n */\ntype ExtractSingleParam<Rest extends string> =\n // Handle regex constraints FIRST (before +, *, ?) to avoid conflicts\n Rest extends `${infer ParamName}(${infer _Constraint})${infer _After}`\n ? { [K in ParamName]: string } // Handle consecutive parameters with separators first: param-:nextParam\n : Rest extends `${infer ParamName}-:${infer _NextParam}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}.:${infer _NextParam}`\n ? { [K in ParamName]: string }\n : // Handle optional parameters followed by delimiters (before regular delimiters)\n Rest extends `${infer ParamName}?/${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?-${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?.${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?#${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?:${infer _After}`\n ? { [K in ParamName]?: string }\n : // Then handle regular delimiters (after optional parameter patterns)\n Rest extends `${infer ParamName}/${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}-${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}.${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}#${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}:${infer _After}`\n ? { [K in ParamName]: string }\n : // Handle Express 5 repeating parameters (after regular delimiters)\n Rest extends `${infer ParamName}+${infer _After}`\n ? { [K in ParamName]: string[] }\n : Rest extends `${infer ParamName}*${infer _After}`\n ? { [K in ParamName]?: string[] }\n : // Handle optional parameters with ? (Express 4) - only at the end of a segment\n Rest extends `${infer ParamName}?${infer _After}`\n ? { [K in ParamName]?: string } // Parameter at absolute end of string\n : Rest extends string\n ? Rest extends \"\"\n ? {}\n : Rest extends `${infer ParamName}?`\n ? { [K in ParamName]?: string } // ParamName here doesn't include the ?\n : Rest extends `${infer ParamName}+`\n ? { [K in ParamName]: string[] }\n : Rest extends `${infer ParamName}*`\n ? { [K in ParamName]?: string[] }\n : { [K in Rest]: string }\n : {};\n\n/**\n * Remove the first parameter from path to continue parsing\n * Enhanced to handle Express 5 patterns and optional parameters\n * Handles patterns like :from-:to by removing just :from and keeping -:to\n * Order matters: regex constraints must be handled before repeating parameters\n */\ntype RemoveFirstParam<Path extends string> =\n Path extends `${infer Before}:${infer Rest}`\n ? // Handle regex constraints FIRST (before +, *, ?) to avoid conflicts\n Rest extends `${infer _ParamName}(${infer _Constraint})${infer After}`\n ? `${Before}${After}` // Handle consecutive parameters: :param-:nextParam -> -:nextParam\n : Rest extends `${infer _ParamName}-:${infer After}`\n ? `${Before}-:${After}`\n : Rest extends `${infer _ParamName}.:${infer After}`\n ? `${Before}.:${After}`\n : // Handle optional parameters followed by delimiters (before regular delimiters)\n Rest extends `${infer _ParamName}?/${infer After}`\n ? `${Before}/${After}`\n : Rest extends `${infer _ParamName}?-${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}?.${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}?#${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}?:${infer After}`\n ? `${Before}:${After}`\n : // Handle regular separators (after optional parameter patterns)\n Rest extends `${infer _ParamName}/${infer After}`\n ? `${Before}/${After}`\n : Rest extends `${infer _ParamName}-${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}.${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}#${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}:${infer After}`\n ? `${Before}:${After}`\n : // Handle Express 5 repeating parameters (after regular separators)\n Rest extends `${infer _ParamName}+${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}*${infer After}`\n ? `${Before}${After}`\n : // Handle optional parameters with ?\n Rest extends `${infer _ParamName}?${infer After}`\n ? `${Before}${After}`\n : Before\n : Path;\n\n/**\n * Count wildcards to assign proper numeric indices\n */\ntype CountWildcards<\n Path extends string,\n Count extends string = \"0\"\n> = Path extends `${infer _Before}*${infer Rest}`\n ? CountWildcards<Rest, IncrementWildcard<Count>>\n : Count;\n\n/**\n * Helper type to increment wildcard count as string\n */\ntype IncrementWildcard<T extends string> = T extends \"0\"\n ? \"1\"\n : T extends \"1\"\n ? \"2\"\n : T extends \"2\"\n ? \"3\"\n : T extends \"3\"\n ? \"4\"\n : T extends \"4\"\n ? \"5\"\n : T extends \"5\"\n ? \"6\"\n : T extends \"6\"\n ? \"7\"\n : T extends \"7\"\n ? \"8\"\n : T extends \"8\"\n ? \"9\"\n : \"10\"; // Reasonable limit for wildcards\n\n/**\n * Express middleware that adds custom properties to the request object and/or response locals.\n *\n * @template TReq - The shape of the properties added to the request object.\n * @template TLocals - The shape of the properties added to response.locals.\n * @param req - The Express request object, extended with TReq.\n * @param res - The Express response object with typed locals.\n * @param next - The next middleware function.\n */\nexport type TypedMiddleware<\n TReq extends Record<string, any> = {},\n TLocals extends Record<string, any> = {}\n> = (\n req: Request & TReq,\n res: Response<any, TLocals>,\n next: NextFunction\n) => void | Promise<void>;\n\n/**\n * Simplified TypedMiddleware for request-only extensions (backward compatibility)\n */\nexport type RequestOnlyMiddleware<TReq extends Record<string, any>> =\n TypedMiddleware<TReq, {}>;\n\n/**\n * Simplified TypedMiddleware for response locals-only extensions\n */\nexport type LocalsOnlyMiddleware<TLocals extends Record<string, any>> =\n TypedMiddleware<{}, TLocals>;\n\n// Utility type to infer props from middleware array\ntype InferMiddlewareProps<T extends readonly TypedMiddleware<any, any>[]> =\n T extends readonly [infer First, ...infer Rest]\n ? First extends TypedMiddleware<infer FirstReq, any>\n ? Rest extends readonly TypedMiddleware<any, any>[]\n ? FirstReq & InferMiddlewareProps<Rest>\n : FirstReq\n : {}\n : {};\n\n// Utility type to infer locals from middleware array\ntype InferMiddlewareLocals<T extends readonly TypedMiddleware<any, any>[]> =\n T extends readonly [infer First, ...infer Rest]\n ? First extends TypedMiddleware<any, infer FirstLocals>\n ? Rest extends readonly TypedMiddleware<any, any>[]\n ? FirstLocals & InferMiddlewareLocals<Rest>\n : FirstLocals\n : {}\n : {};\n\n// Enhanced Request type with proper inference\nexport type ZodRequest<\n Path extends string = string,\n BodySchema extends ZodType<any, any, any> | unknown = unknown,\n QuerySchema extends ZodType<any, any, any> | unknown = unknown,\n MiddlewareProps extends Record<string, any> = {}\n> = Omit<Request, \"params\" | \"query\" | \"body\"> & {\n params: ExtractRouteParams<Path>;\n body: BodySchema extends ZodType<any, any, any>\n ? z.infer<BodySchema>\n : unknown;\n query: QuerySchema extends ZodType<any, any, any>\n ? z.infer<QuerySchema>\n : unknown;\n} & MiddlewareProps;\n\n// Route handler type\nexport type ZodRouteHandler<\n Path extends string = string,\n BodySchema extends ZodType<any, any, any> | unknown = unknown,\n QuerySchema extends ZodType<any, any, any> | unknown = unknown,\n MiddlewareProps extends Record<string, any> = {},\n ResponseLocals extends Record<string, any> = {}\n> = (\n req: ZodRequest<Path, BodySchema, QuerySchema, MiddlewareProps>,\n res: Response<any, ResponseLocals>,\n next?: NextFunction\n) => void | Promise<void> | Response | Promise<Response>;\n\n/**\n * Options for defining a typed route, including schemas and middleware.\n *\n * @template BodySchema - Zod schema for request body validation.\n * @template QuerySchema - Zod schema for query parameter validation.\n * @property bodySchema - Optional Zod schema for validating the request body.\n * @property querySchema - Optional Zod schema for validating the query string.\n * @property middleware - Optional array of TypedMiddleware for this route.\n */\nexport interface RouteOptions<\n BodySchema extends ZodType<any, any, any> | unknown = unknown,\n QuerySchema extends ZodType<any, any, any> | unknown = unknown\n> {\n bodySchema?: BodySchema extends ZodType<any, any, any> ? BodySchema : never;\n querySchema?: QuerySchema extends ZodType<any, any, any>\n ? QuerySchema\n : never;\n middleware?: readonly TypedMiddleware<any, any>[];\n}\n\n// HTTP methods\nexport type HttpMethod =\n | \"get\"\n | \"post\"\n | \"put\"\n | \"delete\"\n | \"patch\"\n | \"options\"\n | \"head\"\n | \"all\";\n\n// Main typed router class\nclass TypedRouter<\n RouterMiddlewareProps extends Record<string, any> = {},\n RouterLocals extends Record<string, any> = {}\n> {\n private router: express.Router;\n\n constructor() {\n this.router = express.Router();\n }\n /**\n * Add typed middleware that extends the request with additional properties\n * and/or adds properties to response.locals\n */\n useTypedMiddleware<\n TReq extends Record<string, any> = {},\n TLocals extends Record<string, any> = {}\n >(\n middleware: TypedMiddleware<TReq, TLocals>\n ): TypedRouter<RouterMiddlewareProps & TReq, RouterLocals & TLocals> {\n this.router.use(middleware as any);\n return this as any;\n }\n /**\n * Get the underlying Express router\n */\n getRouter(): express.Router {\n return this.router;\n }\n // Method overloads for GET requests with automatic middleware type inference\n get<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n get<\n Path extends string,\n BodySchema extends ZodType<any, any, any> | unknown,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Special overload for middleware type inference\n get<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Combined overload for body/query schema + middleware\n get<\n Path extends string,\n BodySchema extends ZodType<any, any, any> | unknown,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema> & { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n // Implementation\n get(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"get\", path, optionsOrHandler, handler);\n }\n // Combined overload for body/query schema + middleware (most specific first)\n post<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body schema only + middleware\n post<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n post<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body + Query schema without middleware\n post<\n Path extends string,\n BodySchema extends ZodType<any, any, any> | unknown,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Just handler, no options\n post<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n post(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"post\", path, optionsOrHandler, handler);\n }\n // PUT method with all the same overloads as POST\n put<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<\n Path extends string,\n BodySchema extends ZodType<any, any, any> | unknown,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n put(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"put\", path, optionsOrHandler, handler);\n }\n // PATCH method with all the same overloads as POST\n patch<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<\n Path extends string,\n BodySchema extends ZodType<any, any, any> | unknown,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n patch(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"patch\", path, optionsOrHandler, handler);\n } // DELETE method (typically no body, but can have query params and middleware)\n // Most specific first: query schema + middleware\n delete<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema only\n delete<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: { querySchema: QuerySchema },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n delete<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n delete<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n delete(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"delete\", path, optionsOrHandler, handler);\n } // OPTIONS method (typically no body, used for CORS preflight)\n // Most specific first: query schema + middleware\n options<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema only\n options<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: { querySchema: QuerySchema },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n options<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n options<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n options(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"options\", path, optionsOrHandler, handler);\n } // HEAD method (like GET but only returns headers)\n // Most specific first: query schema + middleware\n head<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema only\n head<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: { querySchema: QuerySchema },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n head<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n head<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n head(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"head\", path, optionsOrHandler, handler);\n } // ALL method (matches all HTTP methods)\n // Most specific first: body + query + middleware\n all<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body schema + middleware (no query)\n all<\n Path extends string,\n BodySchema extends ZodType<any, any, any>,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema + middleware (no body)\n all<\n Path extends string,\n QuerySchema extends ZodType<any, any, any> | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body + query schemas (no middleware)\n all<\n Path extends string,\n BodySchema extends ZodType<any, any, any> | unknown,\n QuerySchema extends ZodType<any, any, any> | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only (no schemas)\n all<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n all<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n all(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"all\", path, optionsOrHandler, handler);\n }\n // Helper method to register routes\n private registerRoute(\n method: HttpMethod,\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n const middlewares: any[] = [];\n\n if (typeof optionsOrHandler === \"object\") {\n const options = optionsOrHandler as RouteOptions<any, any>;\n\n // Add per-route middleware first\n if (options.middleware) {\n middlewares.push(...options.middleware);\n }\n\n // Add schema validation middleware\n if (options.bodySchema) {\n middlewares.push(\n this.createBodyValidationMiddleware(options.bodySchema)\n );\n }\n if (options.querySchema) {\n middlewares.push(\n this.createQueryValidationMiddleware(options.querySchema)\n );\n }\n\n // Add the main handler\n middlewares.push(handler);\n } else {\n // Direct handler without options\n middlewares.push(optionsOrHandler);\n }\n\n // Register with Express router\n (this.router as any)[method](path, ...middlewares);\n\n return this;\n }\n\n private createBodyValidationMiddleware(schema: ZodType<any, any, any>) {\n return (req: Request, res: Response, next: NextFunction) => {\n try {\n req.body = schema.parse(req.body);\n next();\n } catch (error) {\n if (error instanceof z.ZodError) {\n res.status(400).json({\n error: \"Validation failed\",\n details: error.errors,\n });\n } else {\n next(error);\n }\n }\n };\n }\n\n private createQueryValidationMiddleware(schema: ZodType<any, any, any>) {\n return (req: Request, res: Response, next: NextFunction) => {\n try {\n req.query = schema.parse(req.query);\n next();\n } catch (error) {\n if (error instanceof z.ZodError) {\n res.status(400).json({\n error: \"Validation failed\",\n details: error.errors,\n });\n } else {\n next(error);\n }\n }\n };\n }\n}\n\n/**\n * Create a new strongly-typed Express router instance.\n *\n * This is the simplest way to get started with @minisylar/express-typed-router.\n *\n * @example\n * import { createTypedRouter } from '@minisylar/express-typed-router';\n *\n * // Create a router and add a typed GET route\n * const router = createTypedRouter();\n * router.get('/hello/:name', (req, res) => {\n * // req.params.name is typed as string\n * res.json({ message: `Hello, ${req.params.name}!` });\n * });\n *\n * // Use with Express\n * import express from 'express';\n * const app = express();\n * app.use('/api', router.getRouter());\n */\nexport function createTypedRouter<\n RouterMiddlewareProps extends Record<string, any> = {},\n RouterLocals extends Record<string, any> = {}\n>(): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return new TypedRouter<RouterMiddlewareProps, RouterLocals>();\n}\n\n// Option 2: Factory with optional configuration\n\n/**\n * Configuration options for createTypedRouterWithConfig.\n *\n * @property validateInput - (Future) Whether to enable global input validation.\n * @property errorHandler - Optional global error handler middleware for the router.\n */\nexport interface RouterConfig {\n validateInput?: boolean;\n errorHandler?: (\n error: any,\n req: Request,\n res: Response,\n next: NextFunction\n ) => void;\n}\n\n/**\n * Create a new typed router with optional configuration.\n *\n * Use this if you want to add a global error handler or future global options.\n *\n * @param config - Optional configuration for the router (e.g. error handler).\n * @returns A new TypedRouter instance.\n *\n * @example\n * import { createTypedRouterWithConfig } from '@minisylar/express-typed-router';\n *\n * const router = createTypedRouterWithConfig({\n * errorHandler: (err, req, res, next) => {\n * res.status(500).json({ error: 'Something went wrong', details: err });\n * }\n * });\n */\nexport function createTypedRouterWithConfig<\n RouterMiddlewareProps extends Record<string, any> = {},\n RouterLocals extends Record<string, any> = {}\n>(config?: RouterConfig): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n const router = new TypedRouter<RouterMiddlewareProps, RouterLocals>();\n if (config?.errorHandler) {\n router.getRouter().use(config.errorHandler);\n }\n return router;\n}\n\n// Option 3: Factory with pre-configured middleware\n\n/**\n * Create a new typed router with pre-configured middleware.\n *\n * This is useful for setting up router-level middleware in a single call.\n *\n * @param middleware - One or more TypedMiddleware functions to apply to all routes.\n * @returns A new TypedRouter instance with the middleware applied.\n *\n * @example\n * import { createTypedRouterWithMiddleware } from '@minisylar/express-typed-router';\n *\n * const router = createTypedRouterWithMiddleware(authMiddleware, loggingMiddleware);\n */\nexport function createTypedRouterWithMiddleware<T extends Record<string, any>>(\n ...middleware: TypedMiddleware<any, any>[]\n): TypedRouter<T> {\n let router = new TypedRouter() as any;\n for (const mw of middleware) {\n router = router.useTypedMiddleware(mw);\n }\n return router;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAycA,IAAM,cAAN,MAGE;CACA,AAAQ;CAER,cAAc;AACZ,OAAK,SAAS,gBAAQ,QAAQ;CAC/B;;;;;CAKD,mBAIEA,YACmE;AACnE,OAAK,OAAO,IAAI,WAAkB;AAClC,SAAO;CACR;;;;CAID,YAA4B;AAC1B,SAAO,KAAK;CACb;CA+DD,IACEC,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,OAAO,MAAM,kBAAkB,QAAQ;CAClE;CAqFD,KACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,QAAQ,MAAM,kBAAkB,QAAQ;CACnE;CAgFD,IACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,OAAO,MAAM,kBAAkB,QAAQ;CAClE;CAgFD,MACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,SAAS,MAAM,kBAAkB,QAAQ;CACpE;CA6DD,OACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,UAAU,MAAM,kBAAkB,QAAQ;CACrE;CA6DD,QACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,WAAW,MAAM,kBAAkB,QAAQ;CACtE;CA6DD,KACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,QAAQ,MAAM,kBAAkB,QAAQ;CACnE;CAqGD,IACEF,MACAC,kBACAC,SACkD;AAClD,SAAO,KAAK,cAAc,OAAO,MAAM,kBAAkB,QAAQ;CAClE;CAED,AAAQ,cACNC,QACAH,MACAC,kBACAC,SACkD;EAClD,MAAME,cAAqB,CAAE;AAE7B,aAAW,qBAAqB,UAAU;GACxC,MAAM,UAAU;AAGhB,OAAI,QAAQ,WACV,aAAY,KAAK,GAAG,QAAQ,WAAW;AAIzC,OAAI,QAAQ,WACV,aAAY,KACV,KAAK,+BAA+B,QAAQ,WAAW,CACxD;AAEH,OAAI,QAAQ,YACV,aAAY,KACV,KAAK,gCAAgC,QAAQ,YAAY,CAC1D;AAIH,eAAY,KAAK,QAAQ;EAC1B,MAEC,aAAY,KAAK,iBAAiB;AAIpC,EAAC,KAAK,OAAe,QAAQ,MAAM,GAAG,YAAY;AAElD,SAAO;CACR;CAED,AAAQ,+BAA+BC,QAAgC;AACrE,SAAO,CAACC,KAAcC,KAAeC,SAAuB;AAC1D,OAAI;AACF,QAAI,OAAO,OAAO,MAAM,IAAI,KAAK;AACjC,UAAM;GACP,SAAQ,OAAO;AACd,QAAI,iBAAiBC,MAAE,SACrB,KAAI,OAAO,IAAI,CAAC,KAAK;KACnB,OAAO;KACP,SAAS,MAAM;IAChB,EAAC;QAEF,MAAK,MAAM;GAEd;EACF;CACF;CAED,AAAQ,gCAAgCJ,QAAgC;AACtE,SAAO,CAACC,KAAcC,KAAeC,SAAuB;AAC1D,OAAI;AACF,QAAI,QAAQ,OAAO,MAAM,IAAI,MAAM;AACnC,UAAM;GACP,SAAQ,OAAO;AACd,QAAI,iBAAiBC,MAAE,SACrB,KAAI,OAAO,IAAI,CAAC,KAAK;KACnB,OAAO;KACP,SAAS,MAAM;IAChB,EAAC;QAEF,MAAK,MAAM;GAEd;EACF;CACF;AACF;;;;;;;;;;;;;;;;;;;;;AAsBD,SAAgB,oBAGsC;AACpD,QAAO,IAAI;AACZ;;;;;;;;;;;;;;;;;;AAqCD,SAAgB,4BAGdC,QAAyE;CACzE,MAAM,SAAS,IAAI;AACnB,KAAI,QAAQ,aACV,QAAO,WAAW,CAAC,IAAI,OAAO,aAAa;AAE7C,QAAO;AACR;;;;;;;;;;;;;;AAiBD,SAAgB,gCACd,GAAG,YACa;CAChB,IAAI,SAAS,IAAI;AACjB,MAAK,MAAM,MAAM,WACf,UAAS,OAAO,mBAAmB,GAAG;AAExC,QAAO;AACR"}
|
|
1
|
+
{"version":3,"file":"zod-router.cjs","names":["middleware: TypedMiddleware<TReq, TLocals>","path: string","optionsOrHandler: any","handler?: any","method: HttpMethod","middlewares: any[]","schema: AnyZodType","req: Request","res: Response","next: NextFunction","z","config?: RouterConfig"],"sources":["../src/zod-router.ts"],"sourcesContent":["/**\n * @packageDocumentation\n * @module @minisylar/express-typed-router\n *\n * @title @minisylar/express-typed-router\n *\n * A strongly-typed Express router with Zod validation and automatic type inference for params, body, query, and middleware.\n *\n * @example\n * // Example 1: Basic usage with router-level middleware\n * const router = createTypedRouter()\n * .useMiddleware(timestampMiddleware)\n * .useMiddleware(requestIdMiddleware)\n *\n * router.get('/posts/:postId', (req, res) => {\n * const { postId } = req.params // Typed as { postId: string }\n * const { timestamp, requestId } = req // Both properties are now typed correctly!\n * res.json({ postId, timestamp, requestId })\n * })\n *\n * @example\n * // Example 2: Per-route middleware with automatic type inference\n * router.post(\n * '/posts',\n * {\n * bodySchema: CreatePostSchema,\n * middleware: [timestampMiddleware, requestIdMiddleware] as const\n * },\n * (req, res) => {\n * const { title, content, tags } = req.body // From schema validation\n * const { timestamp, requestId } = req // From middleware - should be automatically typed!\n * res.json({ title, content, tags, timestamp, requestId })\n * }\n * )\n *\n * @example\n * // Example 3: Mixed middleware\n * const router = createTypedRouter().useMiddleware(requestIdMiddleware)\n * router.get(\n * '/posts/:postId',\n * {\n * middleware: [authMiddleware] as const\n * },\n * (req, res) => {\n * const { postId } = req.params\n * const { requestId } = req // From router-level middleware\n * const { userId, hasPermission } = req // From per-route middleware\n * res.json({ postId, requestId, userId, hasPermission })\n * }\n * )\n *\n * @example\n * // Example 4: Using factory with pre-configured middleware\n * const router = createTypedRouterWithMiddleware(timestampMiddleware, requestIdMiddleware)\n * router.get('/simple/:id', (req, res) => {\n * const { id } = req.params\n * const { timestamp, requestId } = req // Already available from factory setup!\n * res.json({ id, timestamp, requestId })\n * })\n *\n * @example\n * // Example 5: Demonstrating all HTTP methods\n * const router = createTypedRouter().useMiddleware(requestIdMiddleware)\n *\n * // GET with query validation\n * router.get('/posts', { querySchema: QuerySchema }, (req, res) => {\n * const { limit, offset } = req.query // Typed from schema\n * const { requestId } = req // From router middleware\n * res.json({ posts: [], limit, offset, requestId })\n * })\n *\n * // POST with body validation and middleware\n * router.post(\n * '/posts',\n * {\n * bodySchema: CreatePostSchema,\n * middleware: [timestampMiddleware] as const\n * },\n * (req, res) => {\n * const { title, content } = req.body // From body schema\n * const { requestId, timestamp } = req // From middleware\n * res.json({ id: 'new-post', title, content, requestId, timestamp })\n * }\n * )\n *\n * // PUT for full updates\n * router.put(\n * '/posts/:postId',\n * {\n * bodySchema: CreatePostSchema,\n * middleware: [authMiddleware] as const\n * },\n * (req, res) => {\n * const { postId } = req.params\n * const { title, content } = req.body\n * const { requestId, userId, hasPermission } = req\n * res.json({ postId, title, content, requestId, userId, hasPermission })\n * }\n * )\n *\n * // PATCH for partial updates\n * router.patch('/posts/:postId', { bodySchema: UpdatePostSchema }, (req, res) => {\n * const { postId } = req.params\n * const updates = req.body // Partial update object\n * const { requestId } = req\n * res.json({ postId, updates, requestId })\n * })\n *\n * // DELETE\n * router.delete('/posts/:postId', (req, res) => {\n * const { postId } = req.params\n * const { requestId } = req\n * res.json({ deleted: postId, requestId })\n * })\n *\n * // OPTIONS for CORS preflight\n * router.options('/posts/*', (req, res) => {\n * res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,PATCH,DELETE')\n * res.header('Access-Control-Allow-Headers', 'Content-Type')\n * res.status(200).end()\n * })\n *\n * // HEAD for metadata only\n * router.head('/posts/:postId', (req, res) => {\n * const { postId } = req.params\n * res.header('X-Post-ID', postId)\n * res.status(200).end()\n * })\n *\n * // ALL method for catch-all routes\n * router.all('/debug/*', (req, res) => {\n * const { requestId } = req\n * res.json({\n * method: req.method,\n * path: req.path,\n * requestId\n * })\n * })\n */\n/* eslint-disable @typescript-eslint/no-empty-object-type */\nimport express, {\n type Request,\n type Response,\n type NextFunction,\n} from \"express\";\nimport { z, type ZodType } from \"zod\";\n\n// Compatibility layer for Zod v3/v4\n// This type works with both ZodType<Output, Def, Input> (v3) and ZodType<Output, Input> (v4)\nexport type AnyZodType =\n | ZodType<any, any, any> // Zod v3\n | ZodType<any, any>; // Zod v4\n\n/**\n * Extract route parameters from Express.js route patterns.\n *\n * Supports all Express.js routing patterns:\n * - Named parameters: /users/:userId → { userId: string }\n * - Multiple parameters: /users/:userId/books/:bookId → { userId: string; bookId: string }\n * - Parameters with separators: /flights/:from-:to → { from: string; to: string }\n * - Dot notation: /plantae/:genus.:species → { genus: string; species: string }\n * - Regex constraints: /user/:id(\\\\d+) → { id: string }\n * - Optional parameters: /posts/:year/:month? → { year: string; month?: string }\n * - Wildcard parameters: /files/* → { \"0\": string }\n * - Multiple wildcards: /a/star/b/star → { \"0\": string; \"1\": string }\n */\nexport type ExtractRouteParams<Path extends string> = string extends Path\n ? Record<string, string>\n : ExtractParams<Path>;\n\n/**\n * Main parameter extraction logic - enhanced for Express 5 support\n */\ntype ExtractParams<Path extends string> =\n // Handle Express 5 braces for optional segments: {/:param} or {/path/:param}\n Path extends `${infer Before}{${infer OptionalContent}}${infer After}`\n ? ExtractOptionalSegment<OptionalContent> &\n ExtractParams<`${Before}${After}`>\n : // Handle named parameters :paramName\n Path extends `${infer _Before}:${infer Rest}`\n ? ExtractSingleParam<Rest> & ExtractParams<RemoveFirstParam<Path>>\n : // Handle wildcards *\n Path extends `${infer _Before}*${infer After}`\n ? { [K in CountWildcards<_Before>]: string } & ExtractParams<After>\n : // No more parameters\n {};\n\n/**\n * Extract parameters from Express 5 optional segments in braces\n * Handles patterns like {/:param}, {.:ext}, {/optional/:param}\n */\ntype ExtractOptionalSegment<Content extends string> =\n // Handle optional parameter patterns like /:param\n Content extends `/:${infer Rest}`\n ? ExtractOptionalParam<Rest>\n : Content extends `.:${infer Rest}`\n ? ExtractOptionalParam<Rest>\n : Content extends `${infer _Path}:${infer Rest}`\n ? ExtractOptionalParam<Rest>\n : {};\n\n/**\n * Extract a single optional parameter from brace content\n */\ntype ExtractOptionalParam<Rest extends string> =\n Rest extends `${infer ParamName}/${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}-${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}.${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}`\n ? { [K in ParamName]?: string }\n : {};\n\n/**\n * Extract a single parameter name from the rest of the path\n * Enhanced to handle Express 5 patterns and optional parameters correctly\n * Special handling for consecutive parameters like :from-:to\n * Order matters: regex constraints must be handled before repeating parameters\n */\ntype ExtractSingleParam<Rest extends string> =\n // Handle regex constraints FIRST (before +, *, ?) to avoid conflicts\n Rest extends `${infer ParamName}(${infer _Constraint})${infer _After}`\n ? { [K in ParamName]: string } // Handle consecutive parameters with separators first: param-:nextParam\n : Rest extends `${infer ParamName}-:${infer _NextParam}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}.:${infer _NextParam}`\n ? { [K in ParamName]: string }\n : // Handle optional parameters followed by delimiters (before regular delimiters)\n Rest extends `${infer ParamName}?/${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?-${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?.${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?#${infer _After}`\n ? { [K in ParamName]?: string }\n : Rest extends `${infer ParamName}?:${infer _After}`\n ? { [K in ParamName]?: string }\n : // Then handle regular delimiters (after optional parameter patterns)\n Rest extends `${infer ParamName}/${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}-${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}.${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}#${infer _After}`\n ? { [K in ParamName]: string }\n : Rest extends `${infer ParamName}:${infer _After}`\n ? { [K in ParamName]: string }\n : // Handle Express 5 repeating parameters (after regular delimiters)\n Rest extends `${infer ParamName}+${infer _After}`\n ? { [K in ParamName]: string[] }\n : Rest extends `${infer ParamName}*${infer _After}`\n ? { [K in ParamName]?: string[] }\n : // Handle optional parameters with ? (Express 4) - only at the end of a segment\n Rest extends `${infer ParamName}?${infer _After}`\n ? { [K in ParamName]?: string } // Parameter at absolute end of string\n : Rest extends string\n ? Rest extends \"\"\n ? {}\n : Rest extends `${infer ParamName}?`\n ? { [K in ParamName]?: string } // ParamName here doesn't include the ?\n : Rest extends `${infer ParamName}+`\n ? { [K in ParamName]: string[] }\n : Rest extends `${infer ParamName}*`\n ? { [K in ParamName]?: string[] }\n : { [K in Rest]: string }\n : {};\n\n/**\n * Remove the first parameter from path to continue parsing\n * Enhanced to handle Express 5 patterns and optional parameters\n * Handles patterns like :from-:to by removing just :from and keeping -:to\n * Order matters: regex constraints must be handled before repeating parameters\n */\ntype RemoveFirstParam<Path extends string> =\n Path extends `${infer Before}:${infer Rest}`\n ? // Handle regex constraints FIRST (before +, *, ?) to avoid conflicts\n Rest extends `${infer _ParamName}(${infer _Constraint})${infer After}`\n ? `${Before}${After}` // Handle consecutive parameters: :param-:nextParam -> -:nextParam\n : Rest extends `${infer _ParamName}-:${infer After}`\n ? `${Before}-:${After}`\n : Rest extends `${infer _ParamName}.:${infer After}`\n ? `${Before}.:${After}`\n : // Handle optional parameters followed by delimiters (before regular delimiters)\n Rest extends `${infer _ParamName}?/${infer After}`\n ? `${Before}/${After}`\n : Rest extends `${infer _ParamName}?-${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}?.${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}?#${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}?:${infer After}`\n ? `${Before}:${After}`\n : // Handle regular separators (after optional parameter patterns)\n Rest extends `${infer _ParamName}/${infer After}`\n ? `${Before}/${After}`\n : Rest extends `${infer _ParamName}-${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}.${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}#${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}:${infer After}`\n ? `${Before}:${After}`\n : // Handle Express 5 repeating parameters (after regular separators)\n Rest extends `${infer _ParamName}+${infer After}`\n ? `${Before}${After}`\n : Rest extends `${infer _ParamName}*${infer After}`\n ? `${Before}${After}`\n : // Handle optional parameters with ?\n Rest extends `${infer _ParamName}?${infer After}`\n ? `${Before}${After}`\n : Before\n : Path;\n\n/**\n * Count wildcards to assign proper numeric indices\n */\ntype CountWildcards<\n Path extends string,\n Count extends string = \"0\"\n> = Path extends `${infer _Before}*${infer Rest}`\n ? CountWildcards<Rest, IncrementWildcard<Count>>\n : Count;\n\n/**\n * Helper type to increment wildcard count as string\n */\ntype IncrementWildcard<T extends string> = T extends \"0\"\n ? \"1\"\n : T extends \"1\"\n ? \"2\"\n : T extends \"2\"\n ? \"3\"\n : T extends \"3\"\n ? \"4\"\n : T extends \"4\"\n ? \"5\"\n : T extends \"5\"\n ? \"6\"\n : T extends \"6\"\n ? \"7\"\n : T extends \"7\"\n ? \"8\"\n : T extends \"8\"\n ? \"9\"\n : \"10\"; // Reasonable limit for wildcards\n\n/**\n * Express middleware that adds custom properties to the request object and/or response locals.\n *\n * @template TReq - The shape of the properties added to the request object.\n * @template TLocals - The shape of the properties added to response.locals.\n * @param req - The Express request object, extended with TReq.\n * @param res - The Express response object with typed locals.\n * @param next - The next middleware function.\n */\nexport type TypedMiddleware<\n TReq extends Record<string, any> = {},\n TLocals extends Record<string, any> = {}\n> = (\n req: Request & TReq,\n res: Response<any, TLocals>,\n next: NextFunction\n) => void | Promise<void>;\n\n/**\n * Simplified TypedMiddleware for request-only extensions (backward compatibility)\n */\nexport type RequestOnlyMiddleware<TReq extends Record<string, any>> =\n TypedMiddleware<TReq, {}>;\n\n/**\n * Simplified TypedMiddleware for response locals-only extensions\n */\nexport type LocalsOnlyMiddleware<TLocals extends Record<string, any>> =\n TypedMiddleware<{}, TLocals>;\n\n// Utility type to infer props from middleware array\ntype InferMiddlewareProps<T extends readonly TypedMiddleware<any, any>[]> =\n T extends readonly [infer First, ...infer Rest]\n ? First extends TypedMiddleware<infer FirstReq, any>\n ? Rest extends readonly TypedMiddleware<any, any>[]\n ? FirstReq & InferMiddlewareProps<Rest>\n : FirstReq\n : {}\n : {};\n\n// Utility type to infer locals from middleware array\ntype InferMiddlewareLocals<T extends readonly TypedMiddleware<any, any>[]> =\n T extends readonly [infer First, ...infer Rest]\n ? First extends TypedMiddleware<any, infer FirstLocals>\n ? Rest extends readonly TypedMiddleware<any, any>[]\n ? FirstLocals & InferMiddlewareLocals<Rest>\n : FirstLocals\n : {}\n : {};\n\n// Enhanced Request type with proper inference\nexport type ZodRequest<\n Path extends string = string,\n BodySchema extends AnyZodType | unknown = unknown,\n QuerySchema extends AnyZodType | unknown = unknown,\n MiddlewareProps extends Record<string, any> = {}\n> = Omit<Request, \"params\" | \"query\" | \"body\"> & {\n params: ExtractRouteParams<Path>;\n body: BodySchema extends { _output: infer O } ? O : unknown;\n query: QuerySchema extends { _output: infer O } ? O : unknown;\n} & MiddlewareProps;\n\n// Route handler type\nexport type ZodRouteHandler<\n Path extends string = string,\n BodySchema extends AnyZodType | unknown = unknown,\n QuerySchema extends AnyZodType | unknown = unknown,\n MiddlewareProps extends Record<string, any> = {},\n ResponseLocals extends Record<string, any> = {}\n> = (\n req: ZodRequest<Path, BodySchema, QuerySchema, MiddlewareProps>,\n res: Response<any, ResponseLocals>,\n next?: NextFunction\n) => void | Promise<void> | Response | Promise<Response>;\n\n/**\n * Options for defining a typed route, including schemas and middleware.\n *\n * @template BodySchema - Zod schema for request body validation.\n * @template QuerySchema - Zod schema for query parameter validation.\n * @property bodySchema - Optional Zod schema for validating the request body.\n * @property querySchema - Optional Zod schema for validating the query string.\n * @property middleware - Optional array of TypedMiddleware for this route.\n */\nexport interface RouteOptions<\n BodySchema extends AnyZodType | unknown = unknown,\n QuerySchema extends AnyZodType | unknown = unknown\n> {\n bodySchema?: BodySchema;\n querySchema?: QuerySchema;\n middleware?: TypedMiddleware<any, any>[];\n}\n\n// HTTP methods\nexport type HttpMethod =\n | \"get\"\n | \"post\"\n | \"put\"\n | \"delete\"\n | \"patch\"\n | \"options\"\n | \"head\"\n | \"all\";\n\n// Main typed router class\nclass TypedRouter<\n RouterMiddlewareProps extends Record<string, any> = {},\n RouterLocals extends Record<string, any> = {}\n> {\n private router: express.Router;\n\n constructor() {\n this.router = express.Router();\n }\n /**\n * Add typed middleware that extends the request with additional properties\n * and/or adds properties to response.locals\n */ /**\n * Add typed middleware to the router.\n * This middleware will apply to all routes defined after this call.\n *\n * @template TReq - Type extensions for the request object\n * @template TLocals - Type extensions for response.locals\n * @param middleware - The typed middleware function\n * @returns A new router instance with updated types\n */\n useMiddleware<\n TReq extends Record<string, any> = {},\n TLocals extends Record<string, any> = {}\n >(\n middleware: TypedMiddleware<TReq, TLocals>\n ): TypedRouter<RouterMiddlewareProps & TReq, RouterLocals & TLocals> {\n this.router.use(middleware as any);\n return this as any;\n }\n /**\n * Get the underlying Express router\n */\n getRouter(): express.Router {\n return this.router;\n }\n // Method overloads for GET requests with automatic middleware type inference\n get<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n get<\n Path extends string,\n BodySchema extends AnyZodType | unknown,\n QuerySchema extends AnyZodType | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Special overload for middleware type inference\n get<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n // Combined overload for body/query schema + middleware\n get<\n Path extends string,\n BodySchema extends AnyZodType | unknown,\n QuerySchema extends AnyZodType | unknown,\n M extends TypedMiddleware<any, any>[] // Using array type for JS compatibility\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema> & { middleware: [...M] }, // Using tuple spread pattern\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>, // Make it readonly for type inference\n RouterLocals & InferMiddlewareLocals<readonly [...M]>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n // Implementation\n get(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"get\", path, optionsOrHandler, handler);\n } // Combined overload for body/query schema + middleware (most specific first)\n post<\n Path extends string,\n BodySchema extends AnyZodType,\n QuerySchema extends AnyZodType | unknown,\n M extends TypedMiddleware<any, any>[] // Using array type for JS compatibility\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: [...M]; // Using tuple spread pattern\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>, // Make it readonly for type inference\n RouterLocals & InferMiddlewareLocals<readonly [...M]>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body schema only + middleware\n post<\n Path extends string,\n BodySchema extends AnyZodType,\n M extends TypedMiddleware<any, any>[] // Using array type for JS compatibility\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: [...M] }, // Using tuple spread pattern\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>, // Make it readonly for type inference\n RouterLocals & InferMiddlewareLocals<readonly [...M]>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n post<\n Path extends string,\n M extends TypedMiddleware<any, any>[] // Using array type for JS compatibility\n >(\n path: Path,\n options: { middleware: [...M] }, // Using tuple spread pattern\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>, // Make it readonly for type inference\n RouterLocals & InferMiddlewareLocals<readonly [...M]>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body + Query schema without middleware\n post<\n Path extends string,\n BodySchema extends AnyZodType | unknown,\n QuerySchema extends AnyZodType | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Just handler, no options\n post<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n post(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"post\", path, optionsOrHandler, handler);\n }\n // PUT method with all the same overloads as POST\n put<\n Path extends string,\n BodySchema extends AnyZodType,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<\n Path extends string,\n BodySchema extends AnyZodType,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<\n Path extends string,\n BodySchema extends AnyZodType | unknown,\n QuerySchema extends AnyZodType | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n put<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n put(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"put\", path, optionsOrHandler, handler);\n }\n // PATCH method with all the same overloads as POST\n patch<\n Path extends string,\n BodySchema extends AnyZodType,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<\n Path extends string,\n BodySchema extends AnyZodType,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<\n Path extends string,\n BodySchema extends AnyZodType | unknown,\n QuerySchema extends AnyZodType | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n patch<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n patch(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"patch\", path, optionsOrHandler, handler);\n } // DELETE method (typically no body, but can have query params and middleware)\n // Most specific first: query schema + middleware\n delete<\n Path extends string,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema only\n delete<Path extends string, QuerySchema extends AnyZodType | unknown>(\n path: Path,\n options: { querySchema: QuerySchema },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n delete<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n delete<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n delete(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"delete\", path, optionsOrHandler, handler);\n } // OPTIONS method (typically no body, used for CORS preflight)\n // Most specific first: query schema + middleware\n options<\n Path extends string,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema only\n options<Path extends string, QuerySchema extends AnyZodType | unknown>(\n path: Path,\n options: { querySchema: QuerySchema },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n options<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n options<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n options(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"options\", path, optionsOrHandler, handler);\n } // HEAD method (like GET but only returns headers)\n // Most specific first: query schema + middleware\n head<\n Path extends string,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema only\n head<Path extends string, QuerySchema extends AnyZodType | unknown>(\n path: Path,\n options: { querySchema: QuerySchema },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only\n head<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n head<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n head(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"head\", path, optionsOrHandler, handler);\n } // ALL method (matches all HTTP methods)\n // Most specific first: body + query + middleware\n all<\n Path extends string,\n BodySchema extends AnyZodType,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: {\n bodySchema: BodySchema;\n querySchema?: QuerySchema;\n middleware: Middleware;\n },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body schema + middleware (no query)\n all<\n Path extends string,\n BodySchema extends AnyZodType,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { bodySchema: BodySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Query schema + middleware (no body)\n all<\n Path extends string,\n QuerySchema extends AnyZodType | unknown,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { querySchema: QuerySchema; middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n QuerySchema,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Body + query schemas (no middleware)\n all<\n Path extends string,\n BodySchema extends AnyZodType | unknown,\n QuerySchema extends AnyZodType | unknown\n >(\n path: Path,\n options: RouteOptions<BodySchema, QuerySchema>,\n handler: ZodRouteHandler<\n Path,\n BodySchema,\n QuerySchema,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Middleware only (no schemas)\n all<\n Path extends string,\n Middleware extends readonly TypedMiddleware<any, any>[]\n >(\n path: Path,\n options: { middleware: Middleware },\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps & InferMiddlewareProps<Middleware>,\n RouterLocals & InferMiddlewareLocals<Middleware>\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n\n // Basic overload with no options\n all<Path extends string>(\n path: Path,\n handler: ZodRouteHandler<\n Path,\n unknown,\n unknown,\n RouterMiddlewareProps,\n RouterLocals\n >\n ): TypedRouter<RouterMiddlewareProps, RouterLocals>;\n all(\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return this.registerRoute(\"all\", path, optionsOrHandler, handler);\n }\n // Helper method to register routes\n private registerRoute(\n method: HttpMethod,\n path: string,\n optionsOrHandler: any,\n handler?: any\n ): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n const middlewares: any[] = [];\n\n if (typeof optionsOrHandler === \"object\") {\n const options = optionsOrHandler as RouteOptions<any, any>;\n\n // Add per-route middleware first\n if (options.middleware) {\n middlewares.push(...options.middleware);\n }\n\n // Add schema validation middleware\n if (options.bodySchema) {\n middlewares.push(\n this.createBodyValidationMiddleware(options.bodySchema)\n );\n }\n if (options.querySchema) {\n middlewares.push(\n this.createQueryValidationMiddleware(options.querySchema)\n );\n }\n\n // Add the main handler\n middlewares.push(handler);\n } else {\n // Direct handler without options\n middlewares.push(optionsOrHandler);\n }\n\n // Register with Express router\n (this.router as any)[method](path, ...middlewares);\n\n return this;\n }\n private createBodyValidationMiddleware(schema: AnyZodType) {\n return (req: Request, res: Response, next: NextFunction) => {\n try {\n req.body = schema.parse(req.body);\n next();\n } catch (error) {\n // Check for ZodError from both v3 and v4 by looking for the issues/errors property\n if (\n error instanceof z.ZodError ||\n (error && typeof error === \"object\" && \"issues\" in error)\n ) {\n res.status(400).json({\n error: \"Validation failed\",\n details: (error as any).errors || (error as any).issues,\n });\n } else {\n next(error);\n }\n }\n };\n }\n private createQueryValidationMiddleware(schema: AnyZodType) {\n return (req: Request, res: Response, next: NextFunction) => {\n try {\n req.query = schema.parse(req.query);\n next();\n } catch (error) {\n // Check for ZodError from both v3 and v4 by looking for the issues/errors property\n if (\n error instanceof z.ZodError ||\n (error && typeof error === \"object\" && \"issues\" in error)\n ) {\n res.status(400).json({\n error: \"Validation failed\",\n details: (error as any).errors || (error as any).issues,\n });\n } else {\n next(error);\n }\n }\n };\n }\n}\n\n/**\n * Create a new strongly-typed Express router instance.\n *\n * This is the simplest way to get started with @minisylar/express-typed-router.\n *\n * @example\n * import { createTypedRouter } from '@minisylar/express-typed-router';\n *\n * // Create a router and add a typed GET route\n * const router = createTypedRouter();\n * router.get('/hello/:name', (req, res) => {\n * // req.params.name is typed as string\n * res.json({ message: `Hello, ${req.params.name}!` });\n * });\n *\n * // Use with Express\n * import express from 'express';\n * const app = express();\n * app.use('/api', router.getRouter());\n */\nexport function createTypedRouter<\n RouterMiddlewareProps extends Record<string, any> = {},\n RouterLocals extends Record<string, any> = {}\n>(): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n return new TypedRouter<RouterMiddlewareProps, RouterLocals>();\n}\n\n// Option 2: Factory with optional configuration\n\n/**\n * Configuration options for createTypedRouterWithConfig.\n *\n * @property validateInput - (Future) Whether to enable global input validation.\n * @property errorHandler - Optional global error handler middleware for the router.\n */\nexport interface RouterConfig {\n validateInput?: boolean;\n errorHandler?: (\n error: any,\n req: Request,\n res: Response,\n next: NextFunction\n ) => void;\n}\n\n/**\n * Create a new typed router with optional configuration.\n *\n * Use this if you want to add a global error handler or future global options.\n *\n * @param config - Optional configuration for the router (e.g. error handler).\n * @returns A new TypedRouter instance.\n *\n * @example\n * import { createTypedRouterWithConfig } from '@minisylar/express-typed-router';\n *\n * const router = createTypedRouterWithConfig({\n * errorHandler: (err, req, res, next) => {\n * res.status(500).json({ error: 'Something went wrong', details: err });\n * }\n * });\n */\nexport function createTypedRouterWithConfig<\n RouterMiddlewareProps extends Record<string, any> = {},\n RouterLocals extends Record<string, any> = {}\n>(config?: RouterConfig): TypedRouter<RouterMiddlewareProps, RouterLocals> {\n const router = new TypedRouter<RouterMiddlewareProps, RouterLocals>();\n if (config?.errorHandler) {\n router.getRouter().use(config.errorHandler);\n }\n return router;\n}\n\n// Option 3: Factory with pre-configured middleware\n\n/**\n * Create a new typed router with pre-configured middleware.\n *\n * This is useful for setting up router-level middleware in a single call.\n *\n * @param middleware - One or more TypedMiddleware functions to apply to all routes.\n * @returns A new TypedRouter instance with the middleware applied.\n *\n * @example\n * import { createTypedRouterWithMiddleware } from '@minisylar/express-typed-router';\n *\n * const router = createTypedRouterWithMiddleware(authMiddleware, loggingMiddleware);\n */\nexport function createTypedRouterWithMiddleware<T extends Record<string, any>>(\n ...middleware: TypedMiddleware<any, any>[]\n): TypedRouter<T> {\n let router = new TypedRouter() as any;\n for (const mw of middleware) {\n router = router.useMiddleware(mw);\n }\n return router;\n}\n"],"mappings":"ghBAycA,IAAM,EAAN,KAGE,CACA,OAEA,aAAc,CACZ,KAAK,OAAS,EAAA,QAAQ,QAAQ,AAC/B,CAaD,cAIEA,EACmE,CAEnE,MADA,MAAK,OAAO,IAAI,EAAkB,CAC3B,IACR,CAID,WAA4B,CAC1B,OAAO,KAAK,MACb,CA8DD,IACEC,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,MAAO,EAAM,EAAkB,EAAQ,AAClE,CAoFD,KACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,OAAQ,EAAM,EAAkB,EAAQ,AACnE,CAgFD,IACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,MAAO,EAAM,EAAkB,EAAQ,AAClE,CAgFD,MACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,QAAS,EAAM,EAAkB,EAAQ,AACpE,CA0DD,OACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,SAAU,EAAM,EAAkB,EAAQ,AACrE,CA0DD,QACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,UAAW,EAAM,EAAkB,EAAQ,AACtE,CA0DD,KACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,OAAQ,EAAM,EAAkB,EAAQ,AACnE,CAqGD,IACEF,EACAC,EACAC,EACkD,CAClD,MAAO,MAAK,cAAc,MAAO,EAAM,EAAkB,EAAQ,AAClE,CAED,cACEC,EACAH,EACAC,EACAC,EACkD,CAClD,IAAME,EAAqB,CAAE,EAE7B,UAAW,GAAqB,SAAU,CACxC,IAAM,EAAU,EAoBhB,AAjBI,EAAQ,YACV,EAAY,KAAK,GAAG,EAAQ,WAAW,CAIrC,EAAQ,YACV,EAAY,KACV,KAAK,+BAA+B,EAAQ,WAAW,CACxD,CAEC,EAAQ,aACV,EAAY,KACV,KAAK,gCAAgC,EAAQ,YAAY,CAC1D,CAIH,EAAY,KAAK,EAAQ,AAC1B,MAEC,EAAY,KAAK,EAAiB,CAMpC,MAFC,MAAK,OAAe,GAAQ,EAAM,GAAG,EAAY,CAE3C,IACR,CACD,+BAAuCC,EAAoB,CACzD,MAAO,CAACC,EAAcC,EAAeC,IAAuB,CAC1D,GAAI,CAEF,AADA,EAAI,KAAO,EAAO,MAAM,EAAI,KAAK,CACjC,GAAM,AACP,OAAQ,EAAO,CAEd,AACE,aAAiBC,EAAAA,EAAE,UAClB,UAAgB,GAAU,UAAY,WAAY,EAEnD,EAAI,OAAO,IAAI,CAAC,KAAK,CACnB,MAAO,oBACP,QAAU,EAAc,QAAW,EAAc,MAClD,EAAC,CAEF,EAAK,EAAM,AAEd,CACF,CACF,CACD,gCAAwCJ,EAAoB,CAC1D,MAAO,CAACC,EAAcC,EAAeC,IAAuB,CAC1D,GAAI,CAEF,AADA,EAAI,MAAQ,EAAO,MAAM,EAAI,MAAM,CACnC,GAAM,AACP,OAAQ,EAAO,CAEd,AACE,aAAiBC,EAAAA,EAAE,UAClB,UAAgB,GAAU,UAAY,WAAY,EAEnD,EAAI,OAAO,IAAI,CAAC,KAAK,CACnB,MAAO,oBACP,QAAU,EAAc,QAAW,EAAc,MAClD,EAAC,CAEF,EAAK,EAAM,AAEd,CACF,CACF,CACF,EAsBD,SAAgB,GAGsC,CACpD,OAAO,IAAI,CACZ,CAqCD,SAAgB,EAGdC,EAAyE,CACzE,IAAM,EAAS,IAAI,EAInB,OAHI,GAAQ,cACV,EAAO,WAAW,CAAC,IAAI,EAAO,aAAa,CAEtC,CACR,CAiBD,SAAgB,EACd,GAAG,EACa,CAChB,IAAI,EAAS,IAAI,EACjB,IAAK,IAAM,KAAM,EACf,EAAS,EAAO,cAAc,EAAG,CAEnC,OAAO,CACR"}
|
package/dist/zod-router.d.cts
CHANGED
|
@@ -1,21 +1,9 @@
|
|
|
1
1
|
import express, { NextFunction, Request, Response } from "express";
|
|
2
|
-
import { ZodType
|
|
2
|
+
import { ZodType } from "zod";
|
|
3
3
|
|
|
4
4
|
//#region src/zod-router.d.ts
|
|
5
|
-
/**
|
|
6
|
-
* Extract route parameters from Express.js route patterns.
|
|
7
|
-
*
|
|
8
|
-
* Supports all Express.js routing patterns:
|
|
9
|
-
* - Named parameters: /users/:userId → { userId: string }
|
|
10
|
-
* - Multiple parameters: /users/:userId/books/:bookId → { userId: string; bookId: string }
|
|
11
|
-
* - Parameters with separators: /flights/:from-:to → { from: string; to: string }
|
|
12
|
-
* - Dot notation: /plantae/:genus.:species → { genus: string; species: string }
|
|
13
|
-
* - Regex constraints: /user/:id(\\d+) → { id: string }
|
|
14
|
-
* - Optional parameters: /posts/:year/:month? → { year: string; month?: string }
|
|
15
|
-
* - Wildcard parameters: /files/* → { "0": string }
|
|
16
|
-
* - Multiple wildcards: /a/star/b/star → { "0": string; "1": string }
|
|
17
|
-
*/
|
|
18
5
|
|
|
6
|
+
type AnyZodType = ZodType<any, any, any> | ZodType<any, any>;
|
|
19
7
|
/**
|
|
20
8
|
* Extract route parameters from Express.js route patterns.
|
|
21
9
|
*
|
|
@@ -85,12 +73,16 @@ type RequestOnlyMiddleware<TReq extends Record<string, any>> = TypedMiddleware<T
|
|
|
85
73
|
type LocalsOnlyMiddleware<TLocals extends Record<string, any>> = TypedMiddleware<{}, TLocals>;
|
|
86
74
|
type InferMiddlewareProps<T extends readonly TypedMiddleware<any, any>[]> = T extends readonly [infer First, ...infer Rest] ? First extends TypedMiddleware<infer FirstReq, any> ? Rest extends readonly TypedMiddleware<any, any>[] ? FirstReq & InferMiddlewareProps<Rest> : FirstReq : {} : {};
|
|
87
75
|
type InferMiddlewareLocals<T extends readonly TypedMiddleware<any, any>[]> = T extends readonly [infer First, ...infer Rest] ? First extends TypedMiddleware<any, infer FirstLocals> ? Rest extends readonly TypedMiddleware<any, any>[] ? FirstLocals & InferMiddlewareLocals<Rest> : FirstLocals : {} : {};
|
|
88
|
-
type ZodRequest<Path extends string = string, BodySchema extends
|
|
76
|
+
type ZodRequest<Path extends string = string, BodySchema extends AnyZodType | unknown = unknown, QuerySchema extends AnyZodType | unknown = unknown, MiddlewareProps extends Record<string, any> = {}> = Omit<Request, "params" | "query" | "body"> & {
|
|
89
77
|
params: ExtractRouteParams<Path>;
|
|
90
|
-
body: BodySchema extends
|
|
91
|
-
|
|
78
|
+
body: BodySchema extends {
|
|
79
|
+
_output: infer O;
|
|
80
|
+
} ? O : unknown;
|
|
81
|
+
query: QuerySchema extends {
|
|
82
|
+
_output: infer O;
|
|
83
|
+
} ? O : unknown;
|
|
92
84
|
} & MiddlewareProps;
|
|
93
|
-
type ZodRouteHandler<Path extends string = string, BodySchema extends
|
|
85
|
+
type ZodRouteHandler<Path extends string = string, BodySchema extends AnyZodType | unknown = unknown, QuerySchema extends AnyZodType | unknown = unknown, MiddlewareProps extends Record<string, any> = {}, ResponseLocals extends Record<string, any> = {}> = (req: ZodRequest<Path, BodySchema, QuerySchema, MiddlewareProps>, res: Response<any, ResponseLocals>, next?: NextFunction) => void | Promise<void> | Response | Promise<Response>;
|
|
94
86
|
/**
|
|
95
87
|
* Options for defining a typed route, including schemas and middleware.
|
|
96
88
|
*
|
|
@@ -100,10 +92,10 @@ type ZodRouteHandler<Path extends string = string, BodySchema extends ZodType<an
|
|
|
100
92
|
* @property querySchema - Optional Zod schema for validating the query string.
|
|
101
93
|
* @property middleware - Optional array of TypedMiddleware for this route.
|
|
102
94
|
*/
|
|
103
|
-
interface RouteOptions<BodySchema extends
|
|
104
|
-
bodySchema?: BodySchema
|
|
105
|
-
querySchema?: QuerySchema
|
|
106
|
-
middleware?:
|
|
95
|
+
interface RouteOptions<BodySchema extends AnyZodType | unknown = unknown, QuerySchema extends AnyZodType | unknown = unknown> {
|
|
96
|
+
bodySchema?: BodySchema;
|
|
97
|
+
querySchema?: QuerySchema;
|
|
98
|
+
middleware?: TypedMiddleware<any, any>[];
|
|
107
99
|
}
|
|
108
100
|
type HttpMethod = "get" | "post" | "put" | "delete" | "patch" | "options" | "head" | "all";
|
|
109
101
|
declare class TypedRouter<RouterMiddlewareProps extends Record<string, any> = {}, RouterLocals extends Record<string, any> = {}> {
|
|
@@ -112,109 +104,135 @@ declare class TypedRouter<RouterMiddlewareProps extends Record<string, any> = {}
|
|
|
112
104
|
/**
|
|
113
105
|
* Add typed middleware that extends the request with additional properties
|
|
114
106
|
* and/or adds properties to response.locals
|
|
115
|
-
*/
|
|
116
|
-
|
|
107
|
+
*/ /**
|
|
108
|
+
* Add typed middleware to the router.
|
|
109
|
+
* This middleware will apply to all routes defined after this call.
|
|
110
|
+
*
|
|
111
|
+
* @template TReq - Type extensions for the request object
|
|
112
|
+
* @template TLocals - Type extensions for response.locals
|
|
113
|
+
* @param middleware - The typed middleware function
|
|
114
|
+
* @returns A new router instance with updated types
|
|
115
|
+
*/
|
|
116
|
+
useMiddleware<TReq extends Record<string, any> = {}, TLocals extends Record<string, any> = {}>(middleware: TypedMiddleware<TReq, TLocals>): TypedRouter<RouterMiddlewareProps & TReq, RouterLocals & TLocals>;
|
|
117
117
|
/**
|
|
118
118
|
* Get the underlying Express router
|
|
119
119
|
*/
|
|
120
120
|
getRouter(): express.Router;
|
|
121
121
|
get<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
122
|
-
get<Path extends string, BodySchema extends
|
|
122
|
+
get<Path extends string, BodySchema extends AnyZodType | unknown, QuerySchema extends AnyZodType | unknown>(path: Path, options: RouteOptions<BodySchema, QuerySchema>, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
123
123
|
get<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
124
124
|
middleware: Middleware;
|
|
125
125
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
126
|
-
get<Path extends string, BodySchema extends
|
|
127
|
-
middleware:
|
|
128
|
-
},
|
|
129
|
-
|
|
126
|
+
get<Path extends string, BodySchema extends AnyZodType | unknown, QuerySchema extends AnyZodType | unknown, M extends TypedMiddleware<any, any>[]>(path: Path, options: RouteOptions<BodySchema, QuerySchema> & {
|
|
127
|
+
middleware: [...M];
|
|
128
|
+
},
|
|
129
|
+
// Using tuple spread pattern
|
|
130
|
+
handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>,
|
|
131
|
+
// Make it readonly for type inference
|
|
132
|
+
// Make it readonly for type inference
|
|
133
|
+
RouterLocals & InferMiddlewareLocals<readonly [...M]>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
134
|
+
post<Path extends string, BodySchema extends AnyZodType, QuerySchema extends AnyZodType | unknown, M extends TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
130
135
|
bodySchema: BodySchema;
|
|
131
136
|
querySchema?: QuerySchema;
|
|
132
|
-
middleware:
|
|
133
|
-
}, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<
|
|
134
|
-
|
|
137
|
+
middleware: [...M];
|
|
138
|
+
}, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>,
|
|
139
|
+
// Make it readonly for type inference
|
|
140
|
+
// Make it readonly for type inference
|
|
141
|
+
RouterLocals & InferMiddlewareLocals<readonly [...M]>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
142
|
+
post<Path extends string, BodySchema extends AnyZodType, M extends TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
135
143
|
bodySchema: BodySchema;
|
|
136
|
-
middleware:
|
|
137
|
-
},
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
144
|
+
middleware: [...M];
|
|
145
|
+
},
|
|
146
|
+
// Using tuple spread pattern
|
|
147
|
+
handler: ZodRouteHandler<Path, BodySchema, unknown, RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>,
|
|
148
|
+
// Make it readonly for type inference
|
|
149
|
+
// Make it readonly for type inference
|
|
150
|
+
RouterLocals & InferMiddlewareLocals<readonly [...M]>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
151
|
+
post<Path extends string, M extends TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
152
|
+
middleware: [...M];
|
|
153
|
+
},
|
|
154
|
+
// Using tuple spread pattern
|
|
155
|
+
handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<readonly [...M]>,
|
|
156
|
+
// Make it readonly for type inference
|
|
157
|
+
// Make it readonly for type inference
|
|
158
|
+
RouterLocals & InferMiddlewareLocals<readonly [...M]>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
159
|
+
post<Path extends string, BodySchema extends AnyZodType | unknown, QuerySchema extends AnyZodType | unknown>(path: Path, options: RouteOptions<BodySchema, QuerySchema>, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
142
160
|
post<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
143
|
-
put<Path extends string, BodySchema extends
|
|
161
|
+
put<Path extends string, BodySchema extends AnyZodType, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
144
162
|
bodySchema: BodySchema;
|
|
145
163
|
querySchema?: QuerySchema;
|
|
146
164
|
middleware: Middleware;
|
|
147
165
|
}, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
148
|
-
put<Path extends string, BodySchema extends
|
|
166
|
+
put<Path extends string, BodySchema extends AnyZodType, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
149
167
|
bodySchema: BodySchema;
|
|
150
168
|
middleware: Middleware;
|
|
151
169
|
}, handler: ZodRouteHandler<Path, BodySchema, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
152
170
|
put<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
153
171
|
middleware: Middleware;
|
|
154
172
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
155
|
-
put<Path extends string, BodySchema extends
|
|
173
|
+
put<Path extends string, BodySchema extends AnyZodType | unknown, QuerySchema extends AnyZodType | unknown>(path: Path, options: RouteOptions<BodySchema, QuerySchema>, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
156
174
|
put<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
157
|
-
patch<Path extends string, BodySchema extends
|
|
175
|
+
patch<Path extends string, BodySchema extends AnyZodType, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
158
176
|
bodySchema: BodySchema;
|
|
159
177
|
querySchema?: QuerySchema;
|
|
160
178
|
middleware: Middleware;
|
|
161
179
|
}, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
162
|
-
patch<Path extends string, BodySchema extends
|
|
180
|
+
patch<Path extends string, BodySchema extends AnyZodType, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
163
181
|
bodySchema: BodySchema;
|
|
164
182
|
middleware: Middleware;
|
|
165
183
|
}, handler: ZodRouteHandler<Path, BodySchema, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
166
184
|
patch<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
167
185
|
middleware: Middleware;
|
|
168
186
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
169
|
-
patch<Path extends string, BodySchema extends
|
|
187
|
+
patch<Path extends string, BodySchema extends AnyZodType | unknown, QuerySchema extends AnyZodType | unknown>(path: Path, options: RouteOptions<BodySchema, QuerySchema>, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
170
188
|
patch<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
171
|
-
delete<Path extends string, QuerySchema extends
|
|
189
|
+
delete<Path extends string, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
172
190
|
querySchema: QuerySchema;
|
|
173
191
|
middleware: Middleware;
|
|
174
192
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
175
|
-
delete<Path extends string, QuerySchema extends
|
|
193
|
+
delete<Path extends string, QuerySchema extends AnyZodType | unknown>(path: Path, options: {
|
|
176
194
|
querySchema: QuerySchema;
|
|
177
195
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
178
196
|
delete<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
179
197
|
middleware: Middleware;
|
|
180
198
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
181
199
|
delete<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
182
|
-
options<Path extends string, QuerySchema extends
|
|
200
|
+
options<Path extends string, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
183
201
|
querySchema: QuerySchema;
|
|
184
202
|
middleware: Middleware;
|
|
185
203
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
186
|
-
options<Path extends string, QuerySchema extends
|
|
204
|
+
options<Path extends string, QuerySchema extends AnyZodType | unknown>(path: Path, options: {
|
|
187
205
|
querySchema: QuerySchema;
|
|
188
206
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
189
207
|
options<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
190
208
|
middleware: Middleware;
|
|
191
209
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
192
210
|
options<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
193
|
-
head<Path extends string, QuerySchema extends
|
|
211
|
+
head<Path extends string, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
194
212
|
querySchema: QuerySchema;
|
|
195
213
|
middleware: Middleware;
|
|
196
214
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
197
|
-
head<Path extends string, QuerySchema extends
|
|
215
|
+
head<Path extends string, QuerySchema extends AnyZodType | unknown>(path: Path, options: {
|
|
198
216
|
querySchema: QuerySchema;
|
|
199
217
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
200
218
|
head<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
201
219
|
middleware: Middleware;
|
|
202
220
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
203
221
|
head<Path extends string>(path: Path, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
204
|
-
all<Path extends string, BodySchema extends
|
|
222
|
+
all<Path extends string, BodySchema extends AnyZodType, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
205
223
|
bodySchema: BodySchema;
|
|
206
224
|
querySchema?: QuerySchema;
|
|
207
225
|
middleware: Middleware;
|
|
208
226
|
}, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
209
|
-
all<Path extends string, BodySchema extends
|
|
227
|
+
all<Path extends string, BodySchema extends AnyZodType, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
210
228
|
bodySchema: BodySchema;
|
|
211
229
|
middleware: Middleware;
|
|
212
230
|
}, handler: ZodRouteHandler<Path, BodySchema, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
213
|
-
all<Path extends string, QuerySchema extends
|
|
231
|
+
all<Path extends string, QuerySchema extends AnyZodType | unknown, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
214
232
|
querySchema: QuerySchema;
|
|
215
233
|
middleware: Middleware;
|
|
216
234
|
}, handler: ZodRouteHandler<Path, unknown, QuerySchema, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
217
|
-
all<Path extends string, BodySchema extends
|
|
235
|
+
all<Path extends string, BodySchema extends AnyZodType | unknown, QuerySchema extends AnyZodType | unknown>(path: Path, options: RouteOptions<BodySchema, QuerySchema>, handler: ZodRouteHandler<Path, BodySchema, QuerySchema, RouterMiddlewareProps, RouterLocals>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
218
236
|
all<Path extends string, Middleware extends readonly TypedMiddleware<any, any>[]>(path: Path, options: {
|
|
219
237
|
middleware: Middleware;
|
|
220
238
|
}, handler: ZodRouteHandler<Path, unknown, unknown, RouterMiddlewareProps & InferMiddlewareProps<Middleware>, RouterLocals & InferMiddlewareLocals<Middleware>>): TypedRouter<RouterMiddlewareProps, RouterLocals>;
|
|
@@ -286,7 +304,6 @@ declare function createTypedRouterWithConfig<RouterMiddlewareProps extends Recor
|
|
|
286
304
|
* const router = createTypedRouterWithMiddleware(authMiddleware, loggingMiddleware);
|
|
287
305
|
*/
|
|
288
306
|
declare function createTypedRouterWithMiddleware<T extends Record<string, any>>(...middleware: TypedMiddleware<any, any>[]): TypedRouter<T>;
|
|
289
|
-
|
|
290
307
|
//#endregion
|
|
291
|
-
export { ExtractRouteParams, HttpMethod, LocalsOnlyMiddleware, RequestOnlyMiddleware, RouteOptions, RouterConfig, TypedMiddleware, ZodRequest, ZodRouteHandler, createTypedRouter, createTypedRouterWithConfig, createTypedRouterWithMiddleware };
|
|
308
|
+
export { AnyZodType, ExtractRouteParams, HttpMethod, LocalsOnlyMiddleware, RequestOnlyMiddleware, RouteOptions, RouterConfig, TypedMiddleware, ZodRequest, ZodRouteHandler, createTypedRouter, createTypedRouterWithConfig, createTypedRouterWithMiddleware };
|
|
292
309
|
//# sourceMappingURL=zod-router.d.cts.map
|