clear-router 2.8.0 → 2.8.2

package/dist/index.d.mts

@@ -6,4 +6,5 @@ import { ClearRequest } from "./ClearRequest.mjs";
 import { Controller } from "./Controller.mjs";
 import { ClearRouterPlugin, ClearRouterPluginArgumentsContext, ClearRouterPluginContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, PluginArgumentsResolver, PluginBind, PluginBindFactory, PluginBindValue, PluginSetupResult, definePlugin } from "./core/plugins.mjs";
 import { CoreRouter } from "./core/router.mjs";
-export { ClearHttpContext, ClearRequest, ClearRouterPlugin, ClearRouterPluginArgumentsContext, ClearRouterPluginContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, Controller, CoreRouter, PluginArgumentsResolver, PluginBind, PluginBindFactory, PluginBindValue, PluginSetupResult, Request, Response, Route, RouteParameter, definePlugin };
+import { importFile, wrap } from "./core/helpers.mjs";
+export { ClearHttpContext, ClearRequest, ClearRouterPlugin, ClearRouterPluginArgumentsContext, ClearRouterPluginContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, Controller, CoreRouter, PluginArgumentsResolver, PluginBind, PluginBindFactory, PluginBindValue, PluginSetupResult, Request, Response, Route, RouteParameter, definePlugin, importFile, wrap };

package/dist/index.mjs

@@ -4,7 +4,8 @@ import { Route } from "./Route.mjs";
 import { Request } from "./core/Request.mjs";
 import { Response } from "./core/Response.mjs";
 import { definePlugin } from "./core/plugins.mjs";
+import { importFile, wrap } from "./core/helpers.mjs";
 import { CoreRouter } from "./core/router.mjs";
 import "./core/index.mjs";
 
-export { ClearRequest, Controller, CoreRouter, Request, Response, Route, definePlugin };
+export { ClearRequest, Controller, CoreRouter, Request, Response, Route, definePlugin, importFile, wrap };

package/dist/koa/router.cjs

@@ -157,8 +157,8 @@ var Router = class Router extends require_router.CoreRouter {
 	* @param callback
 	* @param middlewares
 	*/
-	static async group(prefix, callback, middlewares) {
-		await super.group(prefix, callback, middlewares);
+	static async group(prefix, source, middlewares) {
+		await super.group(prefix, source, middlewares);
 	}
 	/**
 	* Apply middlewares to a group of routes defined within the callback

package/dist/koa/router.d.cts

@@ -1,4 +1,4 @@
-import { ApiResourceMiddleware, ControllerAction, HttpMethod } from "../types/basic.cjs";
+import { ApiResourceMiddleware, HttpMethod, ResourceAction, RouteGroupSource } from "../types/basic.cjs";
 import { Handler, HttpContext, KoaRouterApp, Middleware } from "../types/koa.cjs";
 import { Route } from "../Route.cjs";
 import { ResourceRoutes } from "../ResourceRoutes.cjs";
@@ -34,8 +34,8 @@ declare class Router extends CoreRouter {
    * @param options
    */
   static apiResource(basePath: string, controller: any, options?: {
-    only?: ControllerAction[];
-    except?: ControllerAction[];
+    only?: ResourceAction[];
+    except?: ResourceAction[];
     middlewares?: ApiResourceMiddleware<Middleware>;
   }): ResourceRoutes<HttpContext, Middleware, Handler>;
   /**
@@ -102,7 +102,7 @@ declare class Router extends CoreRouter {
    * @param callback
    * @param middlewares
    */
-  static group(prefix: string, callback: () => void | Promise<void>, middlewares?: Middleware[]): Promise<void>;
+  static group(prefix: string, source: RouteGroupSource, middlewares?: Middleware[]): Promise<void>;
   /**
    * Apply middlewares to a group of routes defined within the callback
    *

package/dist/koa/router.d.mts

@@ -1,4 +1,4 @@
-import { ApiResourceMiddleware, ControllerAction, HttpMethod } from "../types/basic.mjs";
+import { ApiResourceMiddleware, HttpMethod, ResourceAction, RouteGroupSource } from "../types/basic.mjs";
 import { Handler, HttpContext, KoaRouterApp, Middleware } from "../types/koa.mjs";
 import { Route } from "../Route.mjs";
 import { ResourceRoutes } from "../ResourceRoutes.mjs";
@@ -34,8 +34,8 @@ declare class Router extends CoreRouter {
    * @param options
    */
   static apiResource(basePath: string, controller: any, options?: {
-    only?: ControllerAction[];
-    except?: ControllerAction[];
+    only?: ResourceAction[];
+    except?: ResourceAction[];
     middlewares?: ApiResourceMiddleware<Middleware>;
   }): ResourceRoutes<HttpContext, Middleware, Handler>;
   /**
@@ -102,7 +102,7 @@ declare class Router extends CoreRouter {
    * @param callback
    * @param middlewares
    */
-  static group(prefix: string, callback: () => void | Promise<void>, middlewares?: Middleware[]): Promise<void>;
+  static group(prefix: string, source: RouteGroupSource, middlewares?: Middleware[]): Promise<void>;
   /**
    * Apply middlewares to a group of routes defined within the callback
    *

package/dist/koa/router.mjs

@@ -157,8 +157,8 @@ var Router = class Router extends CoreRouter {
 	* @param callback
 	* @param middlewares
 	*/
-	static async group(prefix, callback, middlewares) {
-		await super.group(prefix, callback, middlewares);
+	static async group(prefix, source, middlewares) {
+		await super.group(prefix, source, middlewares);
 	}
 	/**
 	* Apply middlewares to a group of routes defined within the callback

package/dist/types/basic.d.cts

@@ -1,10 +1,13 @@
+import { JitiOptions, JitiResolveOptions } from "jiti";
+
 //#region src/types/basic.d.ts
 /**
  * Controller method reference
  */
 type ControllerHandler = [any, string];
 type MaybePromise<T = any> = T | Promise<T>;
-type ResourceAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
+type RouteGroupCallback = () => MaybePromise<void>;
+type RouteGroupSource = RouteGroupCallback | string;
 type MiddlewareHandle<Args extends any[] = any[], Return = any> = (...args: Args) => MaybePromise<Return>;
 type MiddlewareClass<M extends MiddlewareHandle = MiddlewareHandle> = new () => {
   handle: M;
@@ -18,14 +21,14 @@ type ClassMiddleware<M extends MiddlewareHandle = MiddlewareHandle> = Middleware
  */
 type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
 /**
- * Common controller action names
+ * Common resource action names
  */
-type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
+type ResourceAction = '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[] };
+type ApiResourceMiddleware<M = any> = M | M[] | { [K in ResourceAction]?: M | M[] };
 interface RouterConfig {
   /**
    * When enabled, API param name will be infered from the route path.
@@ -49,5 +52,12 @@ interface RouterConfig {
     autoDiscover?: boolean;
   };
 }
+interface FileImporter {
+  <T = unknown>(filePath: string): Promise<T>;
+  <T = unknown>(filePath: string, userOptions?: JitiOptions | undefined): Promise<T>;
+  <T = unknown>(filePath: string, userOptions?: JitiOptions | undefined, resolveOptions?: (JitiResolveOptions & {
+    default?: true;
+  })): Promise<T>;
+}
 //#endregion
-export { ApiResourceMiddleware, ClassMiddleware, ControllerAction, ControllerHandler, HttpMethod, MiddlewareHandle, RequestData, ResourceAction, RouterConfig };
+export { ApiResourceMiddleware, ClassMiddleware, ControllerHandler, FileImporter, HttpMethod, MiddlewareHandle, RequestData, ResourceAction, RouteGroupSource, RouterConfig };

package/dist/types/basic.d.mts

@@ -1,10 +1,13 @@
+import { JitiOptions, JitiResolveOptions } from "jiti";
+
 //#region src/types/basic.d.ts
 /**
  * Controller method reference
  */
 type ControllerHandler = [any, string];
 type MaybePromise<T = any> = T | Promise<T>;
-type ResourceAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
+type RouteGroupCallback = () => MaybePromise<void>;
+type RouteGroupSource = RouteGroupCallback | string;
 type MiddlewareHandle<Args extends any[] = any[], Return = any> = (...args: Args) => MaybePromise<Return>;
 type MiddlewareClass<M extends MiddlewareHandle = MiddlewareHandle> = new () => {
   handle: M;
@@ -18,14 +21,14 @@ type ClassMiddleware<M extends MiddlewareHandle = MiddlewareHandle> = Middleware
  */
 type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
 /**
- * Common controller action names
+ * Common resource action names
  */
-type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
+type ResourceAction = '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[] };
+type ApiResourceMiddleware<M = any> = M | M[] | { [K in ResourceAction]?: M | M[] };
 interface RouterConfig {
   /**
    * When enabled, API param name will be infered from the route path.
@@ -49,5 +52,12 @@ interface RouterConfig {
     autoDiscover?: boolean;
   };
 }
+interface FileImporter {
+  <T = unknown>(filePath: string): Promise<T>;
+  <T = unknown>(filePath: string, userOptions?: JitiOptions | undefined): Promise<T>;
+  <T = unknown>(filePath: string, userOptions?: JitiOptions | undefined, resolveOptions?: (JitiResolveOptions & {
+    default?: true;
+  })): Promise<T>;
+}
 //#endregion
-export { ApiResourceMiddleware, ClassMiddleware, ControllerAction, ControllerHandler, HttpMethod, MiddlewareHandle, RequestData, ResourceAction, RouterConfig };
+export { ApiResourceMiddleware, ClassMiddleware, ControllerHandler, FileImporter, HttpMethod, MaybePromise, MiddlewareClass, MiddlewareHandle, MiddlewareInstance, RequestData, ResourceAction, RouteGroupCallback, RouteGroupSource, RouterConfig };

package/dist/types/index.d.mts

@@ -0,0 +1 @@
+import { ApiResourceMiddleware, ClassMiddleware, ControllerHandler, FileImporter, HttpMethod, MaybePromise, MiddlewareClass, MiddlewareHandle, MiddlewareInstance, RequestData, ResourceAction, RouteGroupCallback, RouteGroupSource, RouterConfig } from "./basic.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "description": "Laravel-style routing for Node.js with support for Express, H3, Fastify, Hono, and Koa, including CommonJS, ESM, and TypeScript support.",
   "keywords": [
     "h3",
@@ -82,13 +82,13 @@
     "LICENSE"
   ],
   "peerDependencies": {
+    "@h3ravel/support": "^0.15.11",
     "@koa/router": "^15.0.0",
     "express": "^5.1.0",
     "fastify": "^5.0.0",
     "h3": "^2.0.1-rc.16",
     "hono": "^4.0.0",
     "koa": "^3.0.0",
-    "@h3ravel/support": "^0.15.11",
     "reflect-metadata": "^0.2.2"
   },
   "peerDependenciesMeta": {
@@ -144,6 +144,9 @@
   "engines": {
     "node": ">=20.0.0"
   },
+  "dependencies": {
+    "jiti": "^2.7.0"
+  },
   "scripts": {
     "test": "vitest run",
     "test:watch": "vitest --watch",