clear-router 2.2.0 → 2.3.1

package/dist/{router-C1jVRytA.d.mts → router-DLmimm_U.d.cts}

@@ -1,7 +1,72 @@
 import { AsyncLocalStorage } from "node:async_hooks";
-import { H3, H3Event, Middleware as Middleware$1, TypedServerRequest } from "h3";
 import { NextFunction, Request, Response as Response$1 } from "express";
+import { H3, H3Event, Middleware, TypedServerRequest } from "h3";
 
+//#region types/basic.d.ts
+/**
+ * Controller method reference
+ */
+type ControllerHandler = [any, string];
+/**
+ * HTTP methods supported by the router
+ */
+type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
+/**
+ * Common controller action names
+ */
+type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
+/**
+ * Generic Object type for request data
+ */
+type RequestData = Record<string, any>;
+type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
+interface RouterConfig {
+  /**
+   * Configuration for method override functionality, allowing clients to use a
+   * specific header or body parameter to override the HTTP method.
+   */
+  methodOverride?: {
+    /** Whether method override is enabled */enabled?: boolean; /** Keys in the request body to check for method override */
+    bodyKeys?: string[] | string; /** Keys in the request headers to check for method override */
+    headerKeys?: string[] | string;
+  };
+}
+//#endregion
+//#region types/express.d.ts
+interface RequestWithGetBody extends Request {
+  getBody: () => Record<string, any>;
+}
+/**
+ * HTTP context passed to route handlers
+ */
+interface HttpContext$1 {
+  req: RequestWithGetBody;
+  res: Response$1;
+  next: NextFunction;
+}
+/**
+ * Route handler function type
+ */
+type RouteHandler$1 = (
+/**
+ * Express context object containing req, res, and next
+ */
+
+ctx: HttpContext$1,
+/**
+ * ClearRequest instance
+ */
+
+req: ClearRequest) => any | Promise<any>;
+/**
+ * Handler can be either a function or controller reference
+ */
+type Handler$1 = RouteHandler$1 | ControllerHandler;
+/**
+ * Middleware function type
+ */
+type Middleware$1 = (req: Request, res: Response$1, next: NextFunction) => any | Promise<any>;
+//#endregion
 //#region types/h3.d.ts
 type H3App = Omit<H3['fetch'], 'fetch'> & {
   fetch: (request: TypedServerRequest) => Promise<Response>;
@@ -12,18 +77,18 @@ type HttpRequest = H3Event['req'] & {
 /**
  * HTTP context passed to route handlers
  */
-type HttpContext$1 = Omit<H3Event, 'req'> & {
+type HttpContext = Omit<H3Event, 'req'> & {
   req: HttpRequest;
 };
 /**
  * Route handler function type
  */
-type RouteHandler$1 = (
+type RouteHandler = (
 /**
  * H3 event context
  */
 
-ctx: HttpContext$1,
+ctx: HttpContext,
 /**
  * ClearRequest instance
  */
@@ -32,10 +97,10 @@ req: ClearRequest) => any | Promise<any>;
 /**
  * Handler can be either a function or controller reference
  */
-type Handler$1 = RouteHandler$1 | ControllerHandler;
+type Handler = RouteHandler | ControllerHandler;
 //#endregion
 //#region src/Route.d.ts
-declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
+declare class Route<X = any, M = Middleware | Middleware$1, H = any> {
   ctx: X;
   body: RequestData;
   query: RequestData;
@@ -53,7 +118,7 @@ declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
 }
 //#endregion
 //#region src/ClearRequest.d.ts
-declare class ClearRequest<X = any, M = Middleware$1 | Middleware> {
+declare class ClearRequest<X = any, M = Middleware | Middleware$1> {
   [key: string]: any;
   /**
    * @param body - Parsed request body
@@ -71,71 +136,6 @@ declare class ClearRequest<X = any, M = Middleware$1 | Middleware> {
   constructor(init?: Partial<ClearRequest>);
 }
 //#endregion
-//#region types/express.d.ts
-interface RequestWithGetBody extends Request {
-  getBody: () => Record<string, any>;
-}
-/**
- * HTTP context passed to route handlers
- */
-interface HttpContext {
-  req: RequestWithGetBody;
-  res: Response$1;
-  next: NextFunction;
-}
-/**
- * Route handler function type
- */
-type RouteHandler = (
-/**
- * Express context object containing req, res, and next
- */
-
-ctx: HttpContext,
-/**
- * ClearRequest instance
- */
-
-req: ClearRequest) => any | Promise<any>;
-/**
- * Handler can be either a function or controller reference
- */
-type Handler = RouteHandler | ControllerHandler;
-/**
- * Middleware function type
- */
-type Middleware = (req: Request, res: Response$1, next: NextFunction) => any | Promise<any>;
-//#endregion
-//#region types/basic.d.ts
-/**
- * Controller method reference
- */
-type ControllerHandler = [any, string];
-/**
- * HTTP methods supported by the router
- */
-type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
-/**
- * Common controller action names
- */
-type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
-/**
- * Generic Object type for request data
- */
-type RequestData = Record<string, any>;
-type ApiResourceMiddleware<M extends Middleware | Middleware$1> = M | M[] | { [K in ControllerAction]?: M | M[] };
-interface RouterConfig {
-  /**
-   * Configuration for method override functionality, allowing clients to use a
-   * specific header or body parameter to override the HTTP method.
-   */
-  methodOverride?: {
-    /** Whether method override is enabled */enabled?: boolean; /** Keys in the request body to check for method override */
-    bodyKeys?: string[] | string; /** Keys in the request headers to check for method override */
-    headerKeys?: string[] | string;
-  };
-}
-//#endregion
 //#region src/Controller.d.ts
 declare abstract class Controller<X = any> {
   [x: string]: any;
@@ -154,6 +154,7 @@ declare abstract class Controller<X = any> {
  * @repository https://github.com/toneflix/clear-router
  */
 declare abstract class CoreRouter {
+  protected static createDefaultOptionsHandler(): any;
   static config: RouterConfig;
   protected static groupContext: AsyncLocalStorage<{
     prefix: string;
@@ -295,7 +296,15 @@ declare abstract class CoreRouter {
    * @param this
    */
   static allRoutes(this: any): Array<Route<any, any, any>>;
+  /**
+   * @param this
+   * @param type  - 'path' to get routes organized by path
+   */
   static allRoutes(this: any, type: 'path'): Record<string, Route<any, any, any>>;
+  /**
+   * @param this
+   * @param type  - 'method' to get routes organized by method
+   */
   static allRoutes(this: any, type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
   protected static resolveHandler(route: Route<any, any, any>): {
     handlerFunction: ((ctx: any, req: ClearRequest) => any | Promise<any>) | null;
@@ -308,4 +317,4 @@ declare abstract class CoreRouter {
   }): void;
 }
 //#endregion
-export { Handler as a, Route as c, HttpContext$1 as d, Middleware$1 as f, HttpMethod as i, H3App as l, ApiResourceMiddleware as n, HttpContext as o, ControllerAction as r, Middleware as s, CoreRouter as t, Handler$1 as u };
+export { Handler as a, Handler$1 as c, ApiResourceMiddleware as d, ControllerAction as f, H3App as i, HttpContext$1 as l, HttpMethod as m, ClearRequest as n, HttpContext as o, ControllerHandler as p, Route as r, Middleware as s, CoreRouter as t, Middleware$1 as u };

package/dist/{router-CZIh1ZPJ.d.cts → router-cWYmcfTX.d.mts}

@@ -1,7 +1,72 @@
-import { NextFunction, Request, Response as Response$1 } from "express";
-import { H3, H3Event, Middleware as Middleware$1, TypedServerRequest } from "h3";
 import { AsyncLocalStorage } from "node:async_hooks";
+import { H3, H3Event, Middleware, TypedServerRequest } from "h3";
+import { NextFunction, Request, Response as Response$1 } from "express";
 
+//#region types/basic.d.ts
+/**
+ * Controller method reference
+ */
+type ControllerHandler = [any, string];
+/**
+ * HTTP methods supported by the router
+ */
+type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
+/**
+ * Common controller action names
+ */
+type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
+/**
+ * Generic Object type for request data
+ */
+type RequestData = Record<string, any>;
+type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
+interface RouterConfig {
+  /**
+   * Configuration for method override functionality, allowing clients to use a
+   * specific header or body parameter to override the HTTP method.
+   */
+  methodOverride?: {
+    /** Whether method override is enabled */enabled?: boolean; /** Keys in the request body to check for method override */
+    bodyKeys?: string[] | string; /** Keys in the request headers to check for method override */
+    headerKeys?: string[] | string;
+  };
+}
+//#endregion
+//#region types/express.d.ts
+interface RequestWithGetBody extends Request {
+  getBody: () => Record<string, any>;
+}
+/**
+ * HTTP context passed to route handlers
+ */
+interface HttpContext$1 {
+  req: RequestWithGetBody;
+  res: Response$1;
+  next: NextFunction;
+}
+/**
+ * Route handler function type
+ */
+type RouteHandler$1 = (
+/**
+ * Express context object containing req, res, and next
+ */
+
+ctx: HttpContext$1,
+/**
+ * ClearRequest instance
+ */
+
+req: ClearRequest) => any | Promise<any>;
+/**
+ * Handler can be either a function or controller reference
+ */
+type Handler$1 = RouteHandler$1 | ControllerHandler;
+/**
+ * Middleware function type
+ */
+type Middleware$1 = (req: Request, res: Response$1, next: NextFunction) => any | Promise<any>;
+//#endregion
 //#region types/h3.d.ts
 type H3App = Omit<H3['fetch'], 'fetch'> & {
   fetch: (request: TypedServerRequest) => Promise<Response>;
@@ -12,18 +77,18 @@ type HttpRequest = H3Event['req'] & {
 /**
  * HTTP context passed to route handlers
  */
-type HttpContext$1 = Omit<H3Event, 'req'> & {
+type HttpContext = Omit<H3Event, 'req'> & {
   req: HttpRequest;
 };
 /**
  * Route handler function type
  */
-type RouteHandler$1 = (
+type RouteHandler = (
 /**
  * H3 event context
  */
 
-ctx: HttpContext$1,
+ctx: HttpContext,
 /**
  * ClearRequest instance
  */
@@ -32,10 +97,10 @@ req: ClearRequest) => any | Promise<any>;
 /**
  * Handler can be either a function or controller reference
  */
-type Handler$1 = RouteHandler$1 | ControllerHandler;
+type Handler = RouteHandler | ControllerHandler;
 //#endregion
 //#region src/Route.d.ts
-declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
+declare class Route<X = any, M = Middleware | Middleware$1, H = any> {
   ctx: X;
   body: RequestData;
   query: RequestData;
@@ -53,7 +118,7 @@ declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
 }
 //#endregion
 //#region src/ClearRequest.d.ts
-declare class ClearRequest<X = any, M = Middleware$1 | Middleware> {
+declare class ClearRequest<X = any, M = Middleware | Middleware$1> {
   [key: string]: any;
   /**
    * @param body - Parsed request body
@@ -71,71 +136,6 @@ declare class ClearRequest<X = any, M = Middleware$1 | Middleware> {
   constructor(init?: Partial<ClearRequest>);
 }
 //#endregion
-//#region types/express.d.ts
-interface RequestWithGetBody extends Request {
-  getBody: () => Record<string, any>;
-}
-/**
- * HTTP context passed to route handlers
- */
-interface HttpContext {
-  req: RequestWithGetBody;
-  res: Response$1;
-  next: NextFunction;
-}
-/**
- * Route handler function type
- */
-type RouteHandler = (
-/**
- * Express context object containing req, res, and next
- */
-
-ctx: HttpContext,
-/**
- * ClearRequest instance
- */
-
-req: ClearRequest) => any | Promise<any>;
-/**
- * Handler can be either a function or controller reference
- */
-type Handler = RouteHandler | ControllerHandler;
-/**
- * Middleware function type
- */
-type Middleware = (req: Request, res: Response$1, next: NextFunction) => any | Promise<any>;
-//#endregion
-//#region types/basic.d.ts
-/**
- * Controller method reference
- */
-type ControllerHandler = [any, string];
-/**
- * HTTP methods supported by the router
- */
-type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
-/**
- * Common controller action names
- */
-type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
-/**
- * Generic Object type for request data
- */
-type RequestData = Record<string, any>;
-type ApiResourceMiddleware<M extends Middleware | Middleware$1> = M | M[] | { [K in ControllerAction]?: M | M[] };
-interface RouterConfig {
-  /**
-   * Configuration for method override functionality, allowing clients to use a
-   * specific header or body parameter to override the HTTP method.
-   */
-  methodOverride?: {
-    /** Whether method override is enabled */enabled?: boolean; /** Keys in the request body to check for method override */
-    bodyKeys?: string[] | string; /** Keys in the request headers to check for method override */
-    headerKeys?: string[] | string;
-  };
-}
-//#endregion
 //#region src/Controller.d.ts
 declare abstract class Controller<X = any> {
   [x: string]: any;
@@ -154,6 +154,7 @@ declare abstract class Controller<X = any> {
  * @repository https://github.com/toneflix/clear-router
  */
 declare abstract class CoreRouter {
+  protected static createDefaultOptionsHandler(): any;
   static config: RouterConfig;
   protected static groupContext: AsyncLocalStorage<{
     prefix: string;
@@ -295,7 +296,15 @@ declare abstract class CoreRouter {
    * @param this
    */
   static allRoutes(this: any): Array<Route<any, any, any>>;
+  /**
+   * @param this
+   * @param type  - 'path' to get routes organized by path
+   */
   static allRoutes(this: any, type: 'path'): Record<string, Route<any, any, any>>;
+  /**
+   * @param this
+   * @param type  - 'method' to get routes organized by method
+   */
   static allRoutes(this: any, type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
   protected static resolveHandler(route: Route<any, any, any>): {
     handlerFunction: ((ctx: any, req: ClearRequest) => any | Promise<any>) | null;
@@ -308,4 +317,4 @@ declare abstract class CoreRouter {
   }): void;
 }
 //#endregion
-export { Handler as a, Route as c, HttpContext$1 as d, Middleware$1 as f, HttpMethod as i, H3App as l, ApiResourceMiddleware as n, HttpContext as o, ControllerAction as r, Middleware as s, CoreRouter as t, Handler$1 as u };
+export { Handler as a, Handler$1 as c, ApiResourceMiddleware as d, ControllerAction as f, H3App as i, HttpContext$1 as l, HttpMethod as m, ClearRequest as n, HttpContext as o, ControllerHandler as p, Route as r, Middleware as s, CoreRouter as t, Middleware$1 as u };

package/dist/types/ClearRequest.d.mts

@@ -1,7 +1,7 @@
+import { RequestData } from "../types/basic.mjs";
 import { Middleware } from "../types/h3.mjs";
 import { Route } from "./Route.mjs";
 import { Middleware as Middleware$1 } from "../types/express.mjs";
-import { RequestData } from "../types/basic.mjs";
 
 //#region src/ClearRequest.d.ts
 declare class ClearRequest<X = any, M = Middleware | Middleware$1> {

package/dist/types/Route.d.mts

@@ -1,7 +1,7 @@
+import { HttpMethod, RequestData } from "../types/basic.mjs";
 import { Middleware } from "../types/h3.mjs";
 import { ClearRequest } from "./ClearRequest.mjs";
 import { Middleware as Middleware$1 } from "../types/express.mjs";
-import { HttpMethod, RequestData } from "../types/basic.mjs";
 
 //#region src/Route.d.ts
 declare class Route<X = any, M = Middleware | Middleware$1, H = any> {

package/dist/types/basic.d.mts

@@ -1,6 +1,3 @@
-import { Middleware } from "./h3.mjs";
-import { Middleware as Middleware$1 } from "./express.mjs";
-
 //#region types/basic.d.ts
 /**
  * Controller method reference
@@ -18,7 +15,7 @@ type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
  * Generic Object type for request data
  */
 type RequestData = Record<string, any>;
-type ApiResourceMiddleware<M extends Middleware$1 | Middleware> = M | M[] | { [K in ControllerAction]?: M | M[] };
+type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
 interface RouterConfig {
   /**
    * Configuration for method override functionality, allowing clients to use a

package/dist/types/express.d.mts

@@ -1,5 +1,5 @@
-import { ClearRequest } from "./ClearRequest.mjs";
 import { ControllerHandler } from "./basic.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
 import { NextFunction, Request, Response } from "express";
 
 //#region types/express.d.ts

package/dist/types/fastify.d.mts

@@ -0,0 +1,19 @@
+import { ControllerHandler } from "./basic.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
+import { FastifyInstance, FastifyReply, FastifyRequest } from "fastify";
+
+//#region types/fastify.d.ts
+interface RequestWithGetBody extends FastifyRequest {
+  getBody: () => Record<string, any>;
+}
+interface HttpContext {
+  req: RequestWithGetBody;
+  reply: FastifyReply;
+}
+type RouteHandler = (ctx: HttpContext, req: ClearRequest) => any | Promise<any>;
+type Handler = RouteHandler | ControllerHandler;
+type NextFunction = (err?: Error) => void;
+type Middleware = (req: RequestWithGetBody, reply: FastifyReply, next: NextFunction) => any | Promise<any>;
+type FastifyApp = FastifyInstance;
+//#endregion
+export { FastifyApp, Handler, HttpContext, Middleware, NextFunction, RequestWithGetBody, RouteHandler };

package/dist/types/fastify.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/types/h3.d.mts

@@ -1,5 +1,5 @@
-import { ClearRequest } from "./ClearRequest.mjs";
 import { ControllerHandler } from "./basic.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
 import { H3, H3Event, Middleware, TypedServerRequest } from "h3";
 
 //#region types/h3.d.ts

package/dist/types/hono.d.mts

@@ -0,0 +1,18 @@
+import { ControllerHandler } from "./basic.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
+import { Context, HonoRequest, MiddlewareHandler } from "hono";
+
+//#region types/hono.d.ts
+type RequestWithGetBody = HonoRequest & {
+  getBody: () => Record<string, any>;
+};
+type HttpContext = Context & {
+  req: RequestWithGetBody;
+};
+type RouteHandler = (ctx: HttpContext, req: ClearRequest) => any | Promise<any>;
+type Handler = RouteHandler | ControllerHandler;
+type NextFunction = () => Promise<void>;
+type Middleware = MiddlewareHandler;
+type HonoApp = { [K in 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head']: (path: string, ...handlers: Middleware[]) => any };
+//#endregion
+export { Handler, HonoApp, HttpContext, Middleware, NextFunction, RequestWithGetBody, RouteHandler };

package/dist/types/hono.mjs

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "clear-router",
-  "version": "2.2.0",
-  "description": "Laravel-style routing system for Express.js and H3, with CommonJS, ESM, and TypeScript support",
+  "version": "2.3.1",
+  "description": "Laravel-style routing for Node.js with support for Express, H3, Fastify, and Hono, including CommonJS, ESM, and TypeScript support.",
   "keywords": [
     "h3",
     "srvx",
@@ -44,13 +44,23 @@
       "import": "./dist/express/index.mjs",
       "require": "./dist/express/index.cjs"
     },
+    "./fastify": {
+      "import": "./dist/fastify/index.mjs",
+      "require": "./dist/fastify/index.cjs"
+    },
     "./h3": {
       "import": "./dist/h3/index.mjs",
       "require": "./dist/h3/index.cjs"
     },
+    "./hono": {
+      "import": "./dist/hono/index.mjs",
+      "require": "./dist/hono/index.cjs"
+    },
     "./types/basic": "./dist/types/basic.mjs",
     "./types/express": "./dist/types/express.mjs",
+    "./types/fastify": "./dist/types/fastify.mjs",
     "./types/h3": "./dist/types/h3.mjs",
+    "./types/hono": "./dist/types/hono.mjs",
     "./package.json": "./package.json"
   },
   "files": [
@@ -60,14 +70,22 @@
   ],
   "peerDependencies": {
     "express": "^5.1.0",
-    "h3": "^2.0.1-rc.16"
+    "fastify": "^5.0.0",
+    "h3": "^2.0.1-rc.16",
+    "hono": "^4.0.0"
   },
   "peerDependenciesMeta": {
     "express": {
       "optional": true
     },
+    "fastify": {
+      "optional": true
+    },
     "h3": {
       "optional": true
+    },
+    "hono": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -78,6 +96,8 @@
     "@types/supertest": "^6.0.3",
     "@vitest/coverage-v8": "4.0.18",
     "eslint": "^10.0.2",
+    "fastify": "^5.8.2",
+    "hono": "^4.12.8",
     "supertest": "^7.1.1",
     "tsdown": "^0.20.3",
     "tsx": "^4.21.0",