clear-router 2.1.11 → 2.2.0

package/dist/router-CZIh1ZPJ.d.cts

@@ -0,0 +1,311 @@
+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";
+
+//#region types/h3.d.ts
+type H3App = Omit<H3['fetch'], 'fetch'> & {
+  fetch: (request: TypedServerRequest) => Promise<Response>;
+};
+type HttpRequest = H3Event['req'] & {
+  getBody: () => Record<string, any>;
+};
+/**
+ * HTTP context passed to route handlers
+ */
+type HttpContext$1 = Omit<H3Event, 'req'> & {
+  req: HttpRequest;
+};
+/**
+ * Route handler function type
+ */
+type RouteHandler$1 = (
+/**
+ * H3 event context
+ */
+
+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;
+//#endregion
+//#region src/Route.d.ts
+declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
+  ctx: X;
+  body: RequestData;
+  query: RequestData;
+  params: RequestData;
+  clearRequest: ClearRequest;
+  methods: HttpMethod[];
+  path: string;
+  handler: H;
+  middlewares: M[];
+  controllerName?: string;
+  actionName?: string;
+  handlerType: 'function' | 'controller';
+  middlewareCount: number;
+  constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[]);
+}
+//#endregion
+//#region src/ClearRequest.d.ts
+declare class ClearRequest<X = any, M = Middleware$1 | Middleware> {
+  [key: string]: any;
+  /**
+   * @param body - Parsed request body
+   */
+  body: RequestData;
+  /**
+   * @param query - Parsed query parameters
+   */
+  query: RequestData;
+  /**
+   * @param params - Parsed route parameters
+   */
+  params: RequestData;
+  route: Route<X, M>;
+  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;
+  ctx: X;
+  body: RequestData;
+  query: RequestData;
+  params: RequestData;
+  clearRequest: ClearRequest;
+}
+//#endregion
+//#region src/core/router.d.ts
+/**
+ * @class clear-router CoreRouter
+ * @description Core routing logic for clear-router, shared between all supported adapters (Express.js, H3, etc.)
+ * @author 3m1n3nc3
+ * @repository https://github.com/toneflix/clear-router
+ */
+declare abstract class CoreRouter {
+  static config: RouterConfig;
+  protected static groupContext: AsyncLocalStorage<{
+    prefix: string;
+    groupMiddlewares: any[];
+  }>;
+  static routes: Array<Route<any, any, any>>;
+  static routesByPathMethod: Record<string, Route<any, any, any>>;
+  static routesByMethod: { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
+  static prefix: string;
+  static groupMiddlewares: any[];
+  static globalMiddlewares: any[];
+  protected static ensureState(this: any): void;
+  /**
+   * Normalizes a path by ensuring it starts with a single slash and does not have trailing
+   * slashes, while preserving dynamic segments and parameters.
+   *
+   * @param path  The path to normalize.
+   * @returns     The normalized path.
+   */
+  static normalizePath(path: string): string;
+  /**
+   * Configures the router with the given options, such as method override settings.
+   *
+   * @param this
+   * @param options
+   * @returns
+   */
+  static configure(this: any, options?: RouterConfig): void;
+  protected static resolveMethodOverride(this: any, method: string, headers: Headers | Record<string, any>, body: unknown): HttpMethod | null;
+  /**
+   * Adds a new route to the router with the specified methods, path, handler, and middlewares.
+   *
+   * @param this
+   * @param methods
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static add(this: any, methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new API resource route to the router for the specified base path and controller, with
+   * options to include/exclude specific actions and apply middlewares.
+   *
+   * @param this
+   * @param basePath
+   * @param controller
+   * @param options
+   */
+  static apiResource(this: any, basePath: string, controller: any, options?: {
+    only?: ControllerAction[];
+    except?: ControllerAction[];
+    middlewares?: ApiResourceMiddleware<any>;
+  }): void;
+  /**
+   * Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this          The router instance.
+   * @param path          The path for the GET route.
+   * @param handler       The handler function for the GET route.
+   * @param middlewares   Optional middlewares to apply to the GET route.
+   */
+  static get(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static post(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static put(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static delete(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static patch(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static options(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static head(this: any, path: string, handler: any, middlewares?: any[] | any): void;
+  /**
+   * Defines a group of routes with a common prefix and optional middlewares, allowing for better
+   * organization and reuse of route configurations.
+   *
+   * @param this
+   * @param prefix
+   * @param callback
+   * @param middlewares
+   */
+  static group(this: any, prefix: string, callback: () => void | Promise<void>, middlewares?: any[]): Promise<void>;
+  /**
+   * Adds global middlewares to the router, which will be applied to all routes.
+   *
+   * @param this
+   * @param middlewares
+   * @param callback
+   */
+  static middleware(this: any, middlewares: any[], callback: () => void): void;
+  /**
+   * Retrieves all registered routes in the router, optionally organized by path or method
+   * for easier access and management.
+   *
+   * @param this
+   */
+  static allRoutes(this: any): Array<Route<any, any, any>>;
+  static allRoutes(this: any, type: 'path'): Record<string, Route<any, any, any>>;
+  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;
+    instance: Controller<any> | null;
+  };
+  protected static bindRequestToInstance(ctx: any, instance: Controller<any> | Route<any, any, any> | null, route: Route<any, any, any>, payload: {
+    body: Record<string, any>;
+    query: Record<string, any>;
+    params: Record<string, any>;
+  }): 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 };

package/dist/types/Route.d.mts

@@ -1,10 +1,10 @@
-import { Handler, Middleware } from "../types/h3.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> {
+declare class Route<X = any, M = Middleware | Middleware$1, H = any> {
   ctx: X;
   body: RequestData;
   query: RequestData;
@@ -12,13 +12,13 @@ declare class Route<X = any, M = Middleware | Middleware$1> {
   clearRequest: ClearRequest;
   methods: HttpMethod[];
   path: string;
-  handler: Handler;
+  handler: H;
   middlewares: M[];
   controllerName?: string;
   actionName?: string;
   handlerType: 'function' | 'controller';
   middlewareCount: number;
-  constructor(methods: HttpMethod[], path: string, handler: Handler, middlewares?: M[]);
+  constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[]);
 }
 //#endregion
 export { Route };

package/dist/types/express.d.mts

@@ -3,11 +3,14 @@ import { ControllerHandler } from "./basic.mjs";
 import { NextFunction, Request, Response } from "express";
 
 //#region types/express.d.ts
+interface RequestWithGetBody extends Request {
+  getBody: () => Record<string, any>;
+}
 /**
  * HTTP context passed to route handlers
  */
 interface HttpContext {
-  req: Request;
+  req: RequestWithGetBody;
   res: Response;
   next: NextFunction;
 }
@@ -34,4 +37,4 @@ type Handler = RouteHandler | ControllerHandler;
  */
 type Middleware = (req: Request, res: Response, next: NextFunction) => any | Promise<any>;
 //#endregion
-export { Handler, HttpContext, Middleware, RouteHandler };
+export { Handler, HttpContext, Middleware, RequestWithGetBody, RouteHandler };

package/dist/types/h3.d.mts

@@ -7,10 +7,15 @@ type H3App = Omit<H3['fetch'], 'fetch'> & {
   fetch: (request: TypedServerRequest) => Promise<Response>;
 };
 type MaybePromise<T = unknown> = T | Promise<T>;
+type HttpRequest = H3Event['req'] & {
+  getBody: () => Record<string, any>;
+};
 /**
  * HTTP context passed to route handlers
  */
-type HttpContext = H3Event & {};
+type HttpContext = Omit<H3Event, 'req'> & {
+  req: HttpRequest;
+};
 /**
  * Route handler function type
  */
@@ -31,4 +36,4 @@ req: ClearRequest) => any | Promise<any>;
 type Handler = RouteHandler | ControllerHandler;
 type NextFunction = () => MaybePromise<unknown | undefined>;
 //#endregion
-export { H3App, Handler, HttpContext, MaybePromise, type Middleware, NextFunction, RouteHandler };
+export { H3App, Handler, HttpContext, HttpRequest, MaybePromise, type Middleware, NextFunction, RouteHandler };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.1.11",
+  "version": "2.2.0",
   "description": "Laravel-style routing system for Express.js and H3, with CommonJS, ESM, and TypeScript support",
   "keywords": [
     "h3",
@@ -36,6 +36,10 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     },
+    "./core": {
+      "import": "./dist/core/index.mjs",
+      "require": "./dist/core/index.cjs"
+    },
     "./express": {
       "import": "./dist/express/index.mjs",
       "require": "./dist/express/index.cjs"
@@ -56,7 +60,7 @@
   ],
   "peerDependencies": {
     "express": "^5.1.0",
-    "h3": "2.0.1-rc.14"
+    "h3": "^2.0.1-rc.16"
   },
   "peerDependenciesMeta": {
     "express": {
@@ -80,6 +84,7 @@
     "typescript": "^5.3.3",
     "typescript-eslint": "^8.56.1",
     "vite-tsconfig-paths": "^6.1.1",
+    "vitepress": "^1.6.4",
     "vitest": "^4.0.18"
   },
   "engines": {
@@ -88,6 +93,9 @@
   "scripts": {
     "test": "vitest",
     "lint": "eslint",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
     "test:esm": "vitest tests/esm.test.ts",
     "test:ts": "vitest tests/typescript.test.ts",
     "test:coverage": "vitest run --coverage",

package/dist/Route-BbPXcDGX.mjs

@@ -1,50 +0,0 @@
-//#region src/ClearRequest.ts
-var ClearRequest = class {
-	/**
-	* @param body - Parsed request body
-	*/
-	body;
-	/**
-	* @param query - Parsed query parameters
-	*/
-	query;
-	/**
-	* @param params - Parsed route parameters
-	*/
-	params;
-	route;
-	constructor(init) {
-		Object.assign(this, init);
-	}
-};
-
-//#endregion
-//#region src/Route.ts
-var Route = class {
-	ctx;
-	body = {};
-	query = {};
-	params = {};
-	clearRequest;
-	methods;
-	path;
-	handler;
-	middlewares;
-	controllerName;
-	actionName;
-	handlerType;
-	middlewareCount;
-	constructor(methods, path, handler, middlewares = []) {
-		this.methods = methods;
-		this.path = path;
-		this.handler = handler;
-		this.middlewares = middlewares;
-		this.handlerType = Array.isArray(handler) ? "controller" : "function";
-		this.middlewareCount = middlewares.length;
-		this.controllerName = Array.isArray(handler) ? handler[0]?.name : void 0;
-		this.actionName = Array.isArray(handler) ? handler[1] : typeof handler === "function" ? handler.constructor.name ?? handler.name : void 0;
-	}
-};
-
-//#endregion
-export { ClearRequest as n, Route as t };

package/dist/Route-DhC4kNPX.cjs

@@ -1,62 +0,0 @@
-
-//#region src/ClearRequest.ts
-var ClearRequest = class {
-	/**
-	* @param body - Parsed request body
-	*/
-	body;
-	/**
-	* @param query - Parsed query parameters
-	*/
-	query;
-	/**
-	* @param params - Parsed route parameters
-	*/
-	params;
-	route;
-	constructor(init) {
-		Object.assign(this, init);
-	}
-};
-
-//#endregion
-//#region src/Route.ts
-var Route = class {
-	ctx;
-	body = {};
-	query = {};
-	params = {};
-	clearRequest;
-	methods;
-	path;
-	handler;
-	middlewares;
-	controllerName;
-	actionName;
-	handlerType;
-	middlewareCount;
-	constructor(methods, path, handler, middlewares = []) {
-		this.methods = methods;
-		this.path = path;
-		this.handler = handler;
-		this.middlewares = middlewares;
-		this.handlerType = Array.isArray(handler) ? "controller" : "function";
-		this.middlewareCount = middlewares.length;
-		this.controllerName = Array.isArray(handler) ? handler[0]?.name : void 0;
-		this.actionName = Array.isArray(handler) ? handler[1] : typeof handler === "function" ? handler.constructor.name ?? handler.name : void 0;
-	}
-};
-
-//#endregion
-Object.defineProperty(exports, 'ClearRequest', {
-  enumerable: true,
-  get: function () {
-    return ClearRequest;
-  }
-});
-Object.defineProperty(exports, 'Route', {
-  enumerable: true,
-  get: function () {
-    return Route;
-  }
-});

package/dist/basic-DXbqD6cP.d.cts

@@ -1,130 +0,0 @@
-import { NextFunction, Request, Response as Response$1 } from "express";
-import { H3, H3Event, Middleware as Middleware$1, TypedServerRequest } from "h3";
-
-//#region types/h3.d.ts
-type H3App = Omit<H3['fetch'], 'fetch'> & {
-  fetch: (request: TypedServerRequest) => Promise<Response>;
-};
-/**
- * HTTP context passed to route handlers
- */
-type HttpContext$1 = H3Event & {};
-/**
- * Route handler function type
- */
-type RouteHandler$1 = (
-/**
- * H3 event context
- */
-
-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;
-//#endregion
-//#region src/Route.d.ts
-declare class Route<X = any, M = Middleware$1 | Middleware> {
-  ctx: X;
-  body: RequestData;
-  query: RequestData;
-  params: RequestData;
-  clearRequest: ClearRequest;
-  methods: HttpMethod[];
-  path: string;
-  handler: Handler$1;
-  middlewares: M[];
-  controllerName?: string;
-  actionName?: string;
-  handlerType: 'function' | 'controller';
-  middlewareCount: number;
-  constructor(methods: HttpMethod[], path: string, handler: Handler$1, middlewares?: M[]);
-}
-//#endregion
-//#region src/ClearRequest.d.ts
-declare class ClearRequest<X = any, M = Middleware$1 | Middleware> {
-  [key: string]: any;
-  /**
-   * @param body - Parsed request body
-   */
-  body: RequestData;
-  /**
-   * @param query - Parsed query parameters
-   */
-  query: RequestData;
-  /**
-   * @param params - Parsed route parameters
-   */
-  params: RequestData;
-  route: Route<X, M>;
-  constructor(init?: Partial<ClearRequest>);
-}
-//#endregion
-//#region types/express.d.ts
-/**
- * HTTP context passed to route handlers
- */
-interface HttpContext {
-  req: Request;
-  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
-export { Handler as a, Route as c, HttpContext$1 as d, Middleware$1 as f, RouterConfig as i, H3App as l, ControllerAction as n, HttpContext as o, HttpMethod as r, Middleware as s, ApiResourceMiddleware as t, Handler$1 as u };