clear-router 2.8.3 → 2.8.5

package/dist/types/h3.d.mts

@@ -1,13 +1,14 @@
+import { ClassMiddleware, ControllerHandler } from "./basic.mjs";
 import { ClearHttpContext } from "../Contracts.mjs";
 import { Response as Response$1 } from "../core/Response.mjs";
-import { ClassMiddleware, ControllerHandler } from "./basic.mjs";
 import { Request } from "../core/Request.mjs";
-import { EventHandlerRequest, H3, H3Event, Middleware, TypedServerRequest } from "h3";
+import { EventHandlerRequest, H3, H3Event, Middleware as Middleware$1, TypedServerRequest } from "h3";
 
 //#region src/types/h3.d.ts
 type H3App = Omit<H3, 'fetch'> & {
   fetch: (request: TypedServerRequest<EventHandlerRequest>) => Promise<Response>;
 };
+type MaybePromise<T = unknown> = T | Promise<T>;
 interface HttpRequest extends TypedServerRequest<EventHandlerRequest> {
   getBody: () => Record<string, any>;
 }
@@ -36,11 +37,12 @@ req: Request) => any | Promise<any>;
 /**
  * Handler can be either a function or controller reference
  */
-type Handler = RouteHandler | ControllerHandler;
+type Handler<T = any> = RouteHandler | ControllerHandler<T>;
+type NextFunction = () => MaybePromise<unknown | undefined>;
 /**
  * Middleware function type
  */
-type MiddlewareFunction = Middleware;
-type Middleware$1 = MiddlewareFunction | ClassMiddleware<MiddlewareFunction>;
+type MiddlewareFunction = Middleware$1;
+type Middleware = MiddlewareFunction | ClassMiddleware<MiddlewareFunction>;
 //#endregion
-export { H3App, Handler, HttpContext, Middleware$1 as Middleware };
+export { H3App, Handler, HttpContext, HttpRequest, MaybePromise, Middleware, MiddlewareFunction, NextFunction, RouteHandler };

package/dist/types/hono.d.cts

@@ -1,8 +1,23 @@
-import { ClassMiddleware } from "./basic.cjs";
-import { MiddlewareHandler } from "hono";
+import { ClassMiddleware, ControllerHandler } from "./basic.cjs";
+import { ClearHttpContext } from "../Contracts.cjs";
+import { Response } from "../core/Response.cjs";
+import { Request } from "../core/Request.cjs";
+import { Context, HonoRequest, MiddlewareHandler } from "hono";
 
 //#region src/types/hono.d.ts
+type RequestWithGetBody = HonoRequest & {
+  getBody: () => Record<string, any>;
+};
+interface HttpContext extends Context, ClearHttpContext {
+  req: RequestWithGetBody;
+  clearRequest: Request;
+  clearResponse: Response;
+}
+type RouteHandler = (ctx: HttpContext, req: Request) => any | Promise<any>;
+type Handler<T = any> = RouteHandler | ControllerHandler<T>;
+type NextFunction = () => Promise<void>;
 type MiddlewareFunction = MiddlewareHandler;
 type Middleware = MiddlewareFunction | ClassMiddleware<MiddlewareFunction>;
+type HonoApp = { [K in 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head']: (path: string, ...handlers: MiddlewareFunction[]) => any };
 //#endregion
-export { Middleware };
+export { Handler, HonoApp, HttpContext, Middleware, MiddlewareFunction, NextFunction, RequestWithGetBody, RouteHandler };

package/dist/types/hono.d.mts

@@ -1,6 +1,6 @@
+import { ClassMiddleware, ControllerHandler } from "./basic.mjs";
 import { ClearHttpContext } from "../Contracts.mjs";
 import { Response } from "../core/Response.mjs";
-import { ClassMiddleware, ControllerHandler } from "./basic.mjs";
 import { Request } from "../core/Request.mjs";
 import { Context, HonoRequest, MiddlewareHandler } from "hono";
 
@@ -14,9 +14,10 @@ interface HttpContext extends Context, ClearHttpContext {
   clearResponse: Response;
 }
 type RouteHandler = (ctx: HttpContext, req: Request) => any | Promise<any>;
-type Handler = RouteHandler | ControllerHandler;
+type Handler<T = any> = RouteHandler | ControllerHandler<T>;
+type NextFunction = () => Promise<void>;
 type MiddlewareFunction = MiddlewareHandler;
 type Middleware = MiddlewareFunction | ClassMiddleware<MiddlewareFunction>;
 type HonoApp = { [K in 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head']: (path: string, ...handlers: MiddlewareFunction[]) => any };
 //#endregion
-export { Handler, HonoApp, HttpContext, Middleware };
+export { Handler, HonoApp, HttpContext, Middleware, MiddlewareFunction, NextFunction, RequestWithGetBody, RouteHandler };

package/dist/types/koa.d.cts

@@ -1,8 +1,27 @@
-import { ClassMiddleware } from "./basic.cjs";
+import { ClassMiddleware, ControllerHandler } from "./basic.cjs";
+import { ClearHttpContext } from "../Contracts.cjs";
+import { Response } from "../core/Response.cjs";
+import { Request } from "../core/Request.cjs";
 import Koa from "koa";
+import Router from "@koa/router";
 
 //#region src/types/koa.d.ts
+interface RequestWithGetBody extends Koa.Request {
+  getBody: () => Record<string, any>;
+  body?: any;
+}
+interface HttpContext extends Koa.Context, ClearHttpContext {
+  request: RequestWithGetBody;
+  clearRequest: Request;
+  clearResponse: Response;
+  params: Record<string, any>;
+  query: Record<string, any>;
+}
+type RouteHandler = (ctx: HttpContext, req: Request) => any | Promise<any>;
+type Handler<T = any> = RouteHandler | ControllerHandler<T>;
+type NextFunction = Koa.Next;
 type MiddlewareFunction = Koa.Middleware<any, any>;
 type Middleware = MiddlewareFunction | ClassMiddleware<MiddlewareFunction>;
+type KoaRouterApp = Router<any, any>;
 //#endregion
-export { Middleware };
+export { Handler, HttpContext, KoaRouterApp, Middleware, NextFunction, RequestWithGetBody, RouteHandler };

package/dist/types/koa.d.mts

@@ -1,6 +1,6 @@
+import { ClassMiddleware, ControllerHandler } from "./basic.mjs";
 import { ClearHttpContext } from "../Contracts.mjs";
 import { Response } from "../core/Response.mjs";
-import { ClassMiddleware, ControllerHandler } from "./basic.mjs";
 import { Request } from "../core/Request.mjs";
 import Koa from "koa";
 import Router from "@koa/router";
@@ -18,9 +18,10 @@ interface HttpContext extends Koa.Context, ClearHttpContext {
   query: Record<string, any>;
 }
 type RouteHandler = (ctx: HttpContext, req: Request) => any | Promise<any>;
-type Handler = RouteHandler | ControllerHandler;
+type Handler<T = any> = RouteHandler | ControllerHandler<T>;
+type NextFunction = Koa.Next;
 type MiddlewareFunction = Koa.Middleware<any, any>;
 type Middleware = MiddlewareFunction | ClassMiddleware<MiddlewareFunction>;
 type KoaRouterApp = Router<any, any>;
 //#endregion
-export { Handler, HttpContext, KoaRouterApp, Middleware };
+export { Handler, HttpContext, KoaRouterApp, Middleware, NextFunction, RequestWithGetBody, RouteHandler };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.8.3",
+  "version": "2.8.5",
   "description": "Laravel-style routing for Node.js with support for Express, H3, Fastify, Hono, and Koa, including CommonJS, ESM, and TypeScript support.",
   "keywords": [
     "h3",
@@ -68,12 +68,30 @@
       "import": "./dist/koa/index.mjs",
       "require": "./dist/koa/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",
-    "./types/koa": "./dist/types/koa.mjs",
+    "./types/basic": {
+      "import": "./dist/types/basic.mjs",
+      "require": "./dist/types/basic.cjs"
+    },
+    "./types/express": {
+      "import": "./dist/types/express.mjs",
+      "require": "./dist/types/express.cjs"
+    },
+    "./types/fastify": {
+      "import": "./dist/types/fastify.mjs",
+      "require": "./dist/types/fastify.cjs"
+    },
+    "./types/h3": {
+      "import": "./dist/types/h3.mjs",
+      "require": "./dist/types/h3.cjs"
+    },
+    "./types/hono": {
+      "import": "./dist/types/hono.mjs",
+      "require": "./dist/types/hono.cjs"
+    },
+    "./types/koa": {
+      "import": "./dist/types/koa.mjs",
+      "require": "./dist/types/koa.cjs"
+    },
     "./package.json": "./package.json"
   },
   "files": [

package/dist/Route-tq-rge1g.d.mts

@@ -1,136 +0,0 @@
-import { Middleware } from "./types/express.mjs";
-import { Middleware as Middleware$1 } from "./types/fastify.mjs";
-import { Middleware as Middleware$2 } from "./types/h3.mjs";
-import { Middleware as Middleware$3 } from "./types/hono.mjs";
-import { Middleware as Middleware$4 } from "./types/koa.mjs";
-import { HttpMethod, RequestData } from "./types/basic.mjs";
-
-//#region src/Contracts.d.ts
-/**
- * HTTP context passed to route handlers
- */
-interface ClearHttpContext {}
-interface RouteParameter {
-  name: string;
-  field?: string;
-  optional: boolean;
-}
-//#endregion
-//#region src/core/Request.d.ts
-declare class Request<X = any, M = any> extends ClearRequest<X, M> {
-  original?: any;
-  method: string;
-  path: string;
-  url: string;
-  headers: Headers | Record<string, any>;
-  constructor(init?: Partial<Request<X, M>> & {
-    body?: RequestData;
-    query?: RequestData;
-    params?: RequestData;
-    route?: Route<X, M>;
-  });
-  getBody(): RequestData;
-  header(name: string): string;
-  param(name: string): any;
-  input(name: string): any;
-  is(method: HttpMethod | string): boolean;
-}
-//#endregion
-//#region src/core/Response.d.ts
-declare class Response {
-  [key: string]: any;
-  body: any;
-  headers: Headers;
-  sent: boolean;
-  statusCode: number;
-  statusText: string;
-  constructor(init?: Partial<Response | globalThis.Response>);
-  status(code: number): this;
-  setStatusText(text: string): this;
-  code(code: number): this;
-  setHeader(name: string, value: string): this;
-  header(name: string, value: string): this;
-  set(name: string, value: string): this;
-  type(contentType: string): this;
-  send(body?: any): this;
-  json(body: any): this;
-  html(body: string): this;
-  text(body: string): this;
-  noContent(): this;
-}
-//#endregion
-//#region src/ClearRequest.d.ts
-declare class ClearRequest<X = any, M = Middleware$2 | Middleware | Middleware$1 | Middleware$3 | Middleware$4> {
-  [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/Route.d.ts
-/**
- * @class clear-router Route
- * @description A route describes a single enpoint on clear-router
- * @author 3m1n3nc3
- * @repository https://github.com/arkstack-tmp/clear-router
- */
-declare class Route<X = any, M = Middleware$2 | Middleware, H = any> {
-  ctx: X;
-  body: RequestData;
-  query: RequestData;
-  params: RequestData;
-  clearRequest: ClearRequest;
-  methods: HttpMethod[];
-  path: string;
-  registrationPaths: string[];
-  parameters: RouteParameter[];
-  routeName?: string;
-  handler: H;
-  middlewares: M[];
-  controllerName?: string;
-  actionName?: string;
-  handlerType: 'function' | 'controller';
-  middlewareCount: number;
-  constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[], options?: {
-    registrationPaths?: string[];
-    parameters?: RouteParameter[];
-    onName?: (name: string, route: Route<X, M, H>, previousName?: string) => void;
-    normalizeMiddleware?: (middleware: M) => M;
-  });
-  private onName?;
-  private normalizeMiddleware?;
-  /**
-   * Set the route name
-   *
-   * @param name
-   * @returns
-   */
-  name(name: string): this;
-  /**
-   * Register one or more middleware that will be executed before the route.
-   *
-   * @param middlewares
-   * @returns
-   */
-  middleware(middlewares: M[] | M): this;
-  /**
-   * Get the path generated and accessible by this route
-   *
-   * @param params
-   * @returns
-   */
-  toPath(params?: RequestData): string;
-}
-//#endregion
-export { ClearHttpContext as i, Response as n, Request as r, Route as t };

package/dist/types/index.d.mts

@@ -1 +0,0 @@
-import { ApiResourceMiddleware, ClassMiddleware, ControllerHandler, FileImporter, HttpMethod, MaybePromise, MiddlewareClass, MiddlewareHandle, MiddlewareInstance, RequestData, ResourceAction, ResourceRouteDefinition, ResourceRouteRegistrar, ResourceRouteRemover, ResourceRoutesOptions, RouteGroupCallback, RouteGroupCondition, RouteGroupContext, RouteGroupEntry, RouteGroupOptions, RouteGroupSource, RouterConfig } from "./basic.mjs";