clear-router 2.1.3 → 2.1.4

package/dist/express/{index.d.ts → index.d.cts}

@@ -1,4 +1,4 @@
-import { d as RouteInfo, i as Route, l as ControllerAction, n as HttpContext, r as Middleware, t as Handler, u as HttpMethod } from "../express-C77arBZx.js";
+import { d as RouteInfo, i as Route, l as ControllerAction, n as HttpContext, r as Middleware, t as Handler, u as HttpMethod } from "../express-sjYra4oE.cjs";
 import { Router as Router$1 } from "express";
 
 //#region src/express/router.d.ts

package/dist/express/index.d.mts

@@ -0,0 +1,133 @@
+import { d as RouteInfo, i as Route, l as ControllerAction, n as HttpContext, r as Middleware, t as Handler, u as HttpMethod } from "../express-WiUTZlHA.mjs";
+import { Router as Router$1 } from "express";
+
+//#region src/express/router.d.ts
+/**
+ * @class clear-router
+ * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
+ * @author Refkinscallv
+ * @author 3m1n3nc3
+ * @repository https://github.com/toneflix/clear-router
+ */
+declare class Router {
+  /**
+   * All registered routes
+   */
+  static routes: Array<Route<HttpContext, Middleware>>;
+  /**
+   * Current route prefix
+   */
+  static prefix: string;
+  /**
+   * Group-level middlewares
+   */
+  static groupMiddlewares: Middleware[];
+  /**
+   * Global-level middlewares
+   */
+  static globalMiddlewares: Middleware[];
+  /**
+   * Normalize path by removing duplicate slashes and ensuring leading slash
+   * @param path - Path to normalize
+   * @returns Normalized path
+   */
+  static normalizePath(path: string): string;
+  /**
+    * Add a route with specified HTTP methods, path, handler, and middlewares
+    * @param methods - HTTP method(s) for the route
+    * @param path - Route path
+    * @param handler - Route handler function or controller reference
+    * @param middlewares - Array of middleware functions
+    */
+  static add(methods: HttpMethod | HttpMethod[], path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register RESTful API resource routes for a controller with optional action filtering
+   *
+   * @param basePath - Base path for the resource
+   * @param controller - Controller object containing action methods
+   * @param options - Optional filtering options for actions
+   */
+  static apiResource(basePath: string, controller: any, options?: {
+    only?: ControllerAction[];
+    except?: ControllerAction[];
+  }): void;
+  /**
+   * Register a GET route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static get(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a POST route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static post(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a PUT route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static put(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a DELETE route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static delete(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a PATCH route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static patch(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register an OPTIONS route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static options(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a HEAD route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static head(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Group routes with a common prefix and middlewares
+   * @param prefix - URL prefix for grouped routes
+   * @param callback - Function containing route definitions
+   * @param middlewares - Middleware functions applied to all routes in group
+   */
+  static group(prefix: string, callback: () => void, middlewares?: Middleware[]): void;
+  /**
+   * Apply global middlewares for the duration of the callback
+   * @param middlewares - Middleware functions
+   * @param callback - Function containing route definitions
+   */
+  static middleware(middlewares: Middleware[], callback: () => void): void;
+  /**
+   * Get all registered routes with their information
+   * @returns Array of route information objects
+   */
+  static allRoutes(): RouteInfo[];
+  /**
+   * Apply all registered routes to the provided Express Router instance
+   * Handles controller-method binding and middleware application
+   * All errors are thrown to Express error handling middleware
+   *
+   * @param router - Express Router instance
+   */
+  static apply(router: Router$1): void;
+  static apply(router: Router$1): Promise<void>;
+  private static bindRequestToInstance;
+}
+//#endregion
+export { Router };

package/dist/h3/{index.d.ts → index.d.cts}

@@ -1,4 +1,4 @@
-import { a as H3App, c as Middleware, d as RouteInfo, i as Route, l as ControllerAction, o as Handler, s as HttpContext, u as HttpMethod } from "../express-DyZ-2KK1.js";
+import { a as H3App, c as Middleware, d as RouteInfo, i as Route, l as ControllerAction, o as Handler, s as HttpContext, u as HttpMethod } from "../express-sjYra4oE.cjs";
 import { H3 } from "h3";
 
 //#region src/h3/router.d.ts

package/dist/h3/index.d.mts

@@ -0,0 +1,131 @@
+import { a as H3App, c as Middleware, d as RouteInfo, i as Route, l as ControllerAction, o as Handler, s as HttpContext, u as HttpMethod } from "../express-WiUTZlHA.mjs";
+import { H3 } from "h3";
+
+//#region src/h3/router.d.ts
+/**
+ * @class clear-router
+ * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
+ * @author 3m1n3nc3
+ * @repository https://github.com/toneflix/clear-router
+ */
+declare class Router {
+  /**
+   * All registered routes
+   */
+  static routes: Array<Route<HttpContext, Middleware>>;
+  /**
+   * Current route prefix
+   */
+  static prefix: string;
+  /**
+   * Group-level middlewares
+   */
+  static groupMiddlewares: Middleware[];
+  /**
+   * Global-level middlewares
+   */
+  static globalMiddlewares: Middleware[];
+  /**
+   * Normalize path by removing duplicate slashes and ensuring leading slash
+   * @param path - Path to normalize
+   * @returns Normalized path
+   */
+  static normalizePath(path: string): string;
+  /**
+    * Add a route with specified HTTP methods, path, handler, and middlewares
+    * @param methods - HTTP method(s) for the route
+    * @param path - Route path
+    * @param handler - Route handler function or controller reference
+    * @param middlewares - Array of middleware functions
+    */
+  static add(methods: HttpMethod | HttpMethod[], path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register RESTful API resource routes for a controller with optional action filtering
+   *
+   * @param basePath - Base path for the resource
+   * @param controller - Controller object containing action methods
+   * @param options - Optional filtering options for actions
+   */
+  static apiResource(basePath: string, controller: any, options?: {
+    only?: ControllerAction[];
+    except?: ControllerAction[];
+  }): void;
+  /**
+   * Register a GET route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static get(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a POST route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static post(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a PUT route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static put(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a DELETE route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static delete(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a PATCH route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static patch(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register an OPTIONS route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static options(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Register a HEAD route
+   * @param path - Route path
+   * @param handler - Route handler
+   * @param middlewares - Middleware functions
+   */
+  static head(path: string, handler: Handler, middlewares?: Middleware[]): void;
+  /**
+   * Group routes with a common prefix and middlewares
+   * @param prefix - URL prefix for grouped routes
+   * @param callback - Function containing route definitions
+   * @param middlewares - Middleware functions applied to all routes in group
+   */
+  static group(prefix: string, callback: () => void, middlewares?: Middleware[]): void;
+  /**
+   * Apply global middlewares for the duration of the callback
+   * @param middlewares - Middleware functions
+   * @param callback - Function containing route definitions
+   */
+  static middleware(middlewares: Middleware[], callback: () => void): void;
+  /**
+   * Get all registered routes with their information
+   * @returns Array of route information objects
+   */
+  static allRoutes(): RouteInfo[];
+  /**
+   * Apply all registered routes to the provided H3 Router instance
+   * Handles controller-method binding and middleware application
+   * All errors are thrown to H3 error handling middleware
+   *
+   * @param app - H3 app instance
+   */
+  static apply(app: H3): H3App;
+  private static bindRequestToInstance;
+}
+//#endregion
+export { Router };

package/dist/index.d.mts

@@ -0,0 +1,91 @@
+import { NextFunction, Request, Response as Response$1 } from "express";
+import { H3Event, Middleware } 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';
+/**
+ * Generic Object type for request data
+ */
+type RequestData = Record<string, any>;
+//#endregion
+//#region types/express.d.ts
+/**
+ * Middleware function type
+ */
+type Middleware$1 = (req: Request, res: Response$1, next: NextFunction) => any | Promise<any>;
+//#endregion
+//#region types/h3.d.ts
+/**
+ * HTTP context passed to route handlers
+ */
+type HttpContext = H3Event & {};
+/**
+ * Route handler function type
+ */
+type RouteHandler = (
+/**
+ * H3 event context
+ */
+
+ctx: HttpContext,
+/**
+ * ClearRequest instance
+ */
+
+req: ClearRequest) => any | Promise<any>;
+/**
+ * Handler can be either a function or controller reference
+ */
+type Handler = RouteHandler | ControllerHandler;
+//#endregion
+//#region src/Route.d.ts
+declare class Route<X = any, M = Middleware | Middleware$1> {
+  ctx: X;
+  body: RequestData;
+  query: RequestData;
+  params: RequestData;
+  clearRequest: ClearRequest;
+  methods: HttpMethod[];
+  path: string;
+  handler: Handler;
+  middlewares: M[];
+  constructor(methods: HttpMethod[], path: string, handler: Handler, middlewares?: M[]);
+}
+//#endregion
+//#region src/ClearRequest.d.ts
+declare class ClearRequest<X = any, M = Middleware | Middleware$1> {
+  [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 src/Controller.d.ts
+declare abstract class Controller<X = any> {
+  [x: string]: any;
+  ctx: X;
+  body: RequestData;
+  query: RequestData;
+  params: RequestData;
+  clearRequest: ClearRequest;
+}
+//#endregion
+export { ClearRequest, Controller, Route };

package/dist/types/ClearRequest.d.mts

@@ -0,0 +1,25 @@
+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";
+
+//#region src/ClearRequest.d.ts
+declare class ClearRequest<X = any, M = Middleware | Middleware$1> {
+  [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
+export { ClearRequest };

package/dist/types/Route.d.mts

@@ -0,0 +1,20 @@
+import { HttpMethod, RequestData } from "../types/basic.mjs";
+import { Handler, Middleware } from "../types/h3.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
+import { Middleware as Middleware$1 } from "../types/express.mjs";
+
+//#region src/Route.d.ts
+declare class Route<X = any, M = Middleware | Middleware$1> {
+  ctx: X;
+  body: RequestData;
+  query: RequestData;
+  params: RequestData;
+  clearRequest: ClearRequest;
+  methods: HttpMethod[];
+  path: string;
+  handler: Handler;
+  middlewares: M[];
+  constructor(methods: HttpMethod[], path: string, handler: Handler, middlewares?: M[]);
+}
+//#endregion
+export { Route };

package/dist/types/{express.d.ts → express.d.mts}

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

package/dist/types/{h3.d.ts → h3.d.mts}

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Laravel-style routing system for Express.js and H3, with CommonJS, ESM, and TypeScript support",
   "keywords": [
     "h3",
@@ -30,20 +30,17 @@
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
       "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts",
       "require": "./dist/index.cjs"
     },
     "./express": {
-      "types": "./dist/express/index.d.ts",
       "import": "./dist/express/index.mjs",
       "require": "./dist/express/index.cjs"
     },
     "./h3": {
-      "types": "./dist/h3/index.d.ts",
       "import": "./dist/h3/index.mjs",
       "require": "./dist/h3/index.cjs"
     },