clear-router 2.7.7 → 2.8.0

package/dist/{Request-BhTJDR_5.d.mts → Request-Ci0UQ-Vl.d.mts}

@@ -40,6 +40,12 @@ declare class Response {
 }
 //#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$1 | Middleware$4, H = any> {
   ctx: X;
   body: RequestData;
@@ -61,9 +67,30 @@ declare class Route<X = any, M = Middleware$1 | Middleware$4, H = any> {
     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

package/dist/ResourceRouteSelection.cjs

@@ -0,0 +1,26 @@
+
+//#region src/ResourceRouteSelection.ts
+var ResourceRouteSelection = class {
+	constructor(routes) {
+		this.routes = routes;
+	}
+	/**
+	* Register one or more middleware that will be executed before the route.
+	* 
+	* @param middlewares 
+	* @returns 
+	*/
+	middleware(middlewares) {
+		for (const route of this.routes) route.middleware(middlewares);
+		return this;
+	}
+	all() {
+		return this.routes;
+	}
+	first() {
+		return this.routes[0];
+	}
+};
+
+//#endregion
+exports.ResourceRouteSelection = ResourceRouteSelection;

package/dist/ResourceRouteSelection.d.cts

@@ -0,0 +1,20 @@
+import { Middleware } from "./types/express.cjs";
+import { Middleware as Middleware$1 } from "./types/h3.cjs";
+import { Route } from "./Route.cjs";
+
+//#region src/ResourceRouteSelection.d.ts
+declare class ResourceRouteSelection<X = any, M = Middleware$1 | Middleware, H = any> {
+  readonly routes: Array<Route<X, M, H>>;
+  constructor(routes: Array<Route<X, M, H>>);
+  /**
+   * Register one or more middleware that will be executed before the route.
+   *
+   * @param middlewares
+   * @returns
+   */
+  middleware(middlewares: M[] | M): this;
+  all(): Array<Route<X, M, H>>;
+  first(): Route<X, M, H> | undefined;
+}
+//#endregion
+export { ResourceRouteSelection };

package/dist/ResourceRouteSelection.d.mts

@@ -0,0 +1,20 @@
+import { Middleware } from "./types/express.mjs";
+import { Middleware as Middleware$1 } from "./types/h3.mjs";
+import { Route } from "./Route.mjs";
+
+//#region src/ResourceRouteSelection.d.ts
+declare class ResourceRouteSelection<X = any, M = Middleware$1 | Middleware, H = any> {
+  readonly routes: Array<Route<X, M, H>>;
+  constructor(routes: Array<Route<X, M, H>>);
+  /**
+   * Register one or more middleware that will be executed before the route.
+   *
+   * @param middlewares
+   * @returns
+   */
+  middleware(middlewares: M[] | M): this;
+  all(): Array<Route<X, M, H>>;
+  first(): Route<X, M, H> | undefined;
+}
+//#endregion
+export { ResourceRouteSelection };

package/dist/ResourceRouteSelection.mjs

@@ -0,0 +1,25 @@
+//#region src/ResourceRouteSelection.ts
+var ResourceRouteSelection = class {
+	constructor(routes) {
+		this.routes = routes;
+	}
+	/**
+	* Register one or more middleware that will be executed before the route.
+	* 
+	* @param middlewares 
+	* @returns 
+	*/
+	middleware(middlewares) {
+		for (const route of this.routes) route.middleware(middlewares);
+		return this;
+	}
+	all() {
+		return this.routes;
+	}
+	first() {
+		return this.routes[0];
+	}
+};
+
+//#endregion
+export { ResourceRouteSelection };

package/dist/ResourceRoutes.cjs

@@ -0,0 +1,60 @@
+const require_ResourceRouteSelection = require('./ResourceRouteSelection.cjs');
+
+//#region src/ResourceRoutes.ts
+/**
+* @class clear-router ResourceRoutes
+* @description A ResourceRoutes creates a collection of resourceful routes in a single call
+* @author 3m1n3nc3
+* @repository https://github.com/arkstack-tmp/clear-router
+*/
+var ResourceRoutes = class {
+	constructor(routes) {
+		this.routes = routes;
+	}
+	/**
+	* Register one or more middleware that will be executed before the route.
+	* 
+	* @param middlewares 
+	* @returns 
+	*/
+	middleware(middlewares) {
+		for (const route of Object.values(this.routes)) route?.middleware(middlewares);
+		return this;
+	}
+	action(action) {
+		return this.routes[action];
+	}
+	index() {
+		return this.routes.index;
+	}
+	show() {
+		return this.routes.show;
+	}
+	create() {
+		return this.routes.create;
+	}
+	update() {
+		return this.routes.update;
+	}
+	destroy() {
+		return this.routes.destroy;
+	}
+	get() {
+		return this.byMethod("get");
+	}
+	post() {
+		return this.byMethod("post");
+	}
+	put() {
+		return this.byMethod("put");
+	}
+	delete() {
+		return this.byMethod("delete");
+	}
+	byMethod(method) {
+		return new require_ResourceRouteSelection.ResourceRouteSelection(Object.values(this.routes).filter((route) => Boolean(route?.methods.includes(method))));
+	}
+};
+
+//#endregion
+exports.ResourceRoutes = ResourceRoutes;

package/dist/ResourceRoutes.d.cts

@@ -0,0 +1,37 @@
+import { HttpMethod, ResourceAction } from "./types/basic.cjs";
+import { Middleware } from "./types/express.cjs";
+import { Middleware as Middleware$1 } from "./types/h3.cjs";
+import { Route } from "./Route.cjs";
+import { ResourceRouteSelection } from "./ResourceRouteSelection.cjs";
+
+//#region src/ResourceRoutes.d.ts
+/**
+ * @class clear-router ResourceRoutes
+ * @description A ResourceRoutes creates a collection of resourceful routes in a single call
+ * @author 3m1n3nc3
+ * @repository https://github.com/arkstack-tmp/clear-router
+ */
+declare class ResourceRoutes<X = any, M = Middleware$1 | Middleware, H = any> {
+  readonly routes: Partial<Record<ResourceAction, Route<X, M, H>>>;
+  constructor(routes: Partial<Record<ResourceAction, Route<X, M, H>>>);
+  /**
+   * Register one or more middleware that will be executed before the route.
+   *
+   * @param middlewares
+   * @returns
+   */
+  middleware(middlewares: M[] | M): this;
+  action(action: ResourceAction): Route<X, M, H> | undefined;
+  index(): Route<X, M, H> | undefined;
+  show(): Route<X, M, H> | undefined;
+  create(): Route<X, M, H> | undefined;
+  update(): Route<X, M, H> | undefined;
+  destroy(): Route<X, M, H> | undefined;
+  get(): ResourceRouteSelection<X, M, H>;
+  post(): ResourceRouteSelection<X, M, H>;
+  put(): ResourceRouteSelection<X, M, H>;
+  delete(): ResourceRouteSelection<X, M, H>;
+  protected byMethod(method: HttpMethod): ResourceRouteSelection<X, M, H>;
+}
+//#endregion
+export { ResourceRoutes };

package/dist/ResourceRoutes.d.mts

@@ -0,0 +1,37 @@
+import { HttpMethod, ResourceAction } from "./types/basic.mjs";
+import { Middleware } from "./types/express.mjs";
+import { Middleware as Middleware$1 } from "./types/h3.mjs";
+import { Route } from "./Route.mjs";
+import { ResourceRouteSelection } from "./ResourceRouteSelection.mjs";
+
+//#region src/ResourceRoutes.d.ts
+/**
+ * @class clear-router ResourceRoutes
+ * @description A ResourceRoutes creates a collection of resourceful routes in a single call
+ * @author 3m1n3nc3
+ * @repository https://github.com/arkstack-tmp/clear-router
+ */
+declare class ResourceRoutes<X = any, M = Middleware$1 | Middleware, H = any> {
+  readonly routes: Partial<Record<ResourceAction, Route<X, M, H>>>;
+  constructor(routes: Partial<Record<ResourceAction, Route<X, M, H>>>);
+  /**
+   * Register one or more middleware that will be executed before the route.
+   *
+   * @param middlewares
+   * @returns
+   */
+  middleware(middlewares: M[] | M): this;
+  action(action: ResourceAction): Route<X, M, H> | undefined;
+  index(): Route<X, M, H> | undefined;
+  show(): Route<X, M, H> | undefined;
+  create(): Route<X, M, H> | undefined;
+  update(): Route<X, M, H> | undefined;
+  destroy(): Route<X, M, H> | undefined;
+  get(): ResourceRouteSelection<X, M, H>;
+  post(): ResourceRouteSelection<X, M, H>;
+  put(): ResourceRouteSelection<X, M, H>;
+  delete(): ResourceRouteSelection<X, M, H>;
+  protected byMethod(method: HttpMethod): ResourceRouteSelection<X, M, H>;
+}
+//#endregion
+export { ResourceRoutes };

package/dist/ResourceRoutes.mjs

@@ -0,0 +1,60 @@
+import { ResourceRouteSelection } from "./ResourceRouteSelection.mjs";
+
+//#region src/ResourceRoutes.ts
+/**
+* @class clear-router ResourceRoutes
+* @description A ResourceRoutes creates a collection of resourceful routes in a single call
+* @author 3m1n3nc3
+* @repository https://github.com/arkstack-tmp/clear-router
+*/
+var ResourceRoutes = class {
+	constructor(routes) {
+		this.routes = routes;
+	}
+	/**
+	* Register one or more middleware that will be executed before the route.
+	* 
+	* @param middlewares 
+	* @returns 
+	*/
+	middleware(middlewares) {
+		for (const route of Object.values(this.routes)) route?.middleware(middlewares);
+		return this;
+	}
+	action(action) {
+		return this.routes[action];
+	}
+	index() {
+		return this.routes.index;
+	}
+	show() {
+		return this.routes.show;
+	}
+	create() {
+		return this.routes.create;
+	}
+	update() {
+		return this.routes.update;
+	}
+	destroy() {
+		return this.routes.destroy;
+	}
+	get() {
+		return this.byMethod("get");
+	}
+	post() {
+		return this.byMethod("post");
+	}
+	put() {
+		return this.byMethod("put");
+	}
+	delete() {
+		return this.byMethod("delete");
+	}
+	byMethod(method) {
+		return new ResourceRouteSelection(Object.values(this.routes).filter((route) => Boolean(route?.methods.includes(method))));
+	}
+};
+
+//#endregion
+export { ResourceRoutes };

package/dist/Route.cjs

@@ -1,5 +1,11 @@
 
 //#region src/Route.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
+*/
 var Route = class {
 	ctx;
 	body = {};
@@ -29,14 +35,40 @@ var Route = class {
 		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;
 		this.onName = options.onName;
+		this.normalizeMiddleware = options.normalizeMiddleware;
 	}
 	onName;
+	normalizeMiddleware;
+	/**
+	* Set the route name
+	* 
+	* @param name 
+	* @returns 
+	*/
 	name(name) {
 		const previousName = this.routeName;
 		this.routeName = name;
 		this.onName?.(name, this, previousName);
 		return this;
 	}
+	/**
+	* Register one or more middleware that will be executed before the route.
+	* 
+	* @param middlewares 
+	* @returns 
+	*/
+	middleware(middlewares) {
+		const normalized = (Array.isArray(middlewares) ? middlewares : [middlewares]).map((middleware) => this.normalizeMiddleware?.(middleware) ?? middleware);
+		this.middlewares.push(...normalized);
+		this.middlewareCount = this.middlewares.length;
+		return this;
+	}
+	/**
+	* Get the path generated and accessible by this route
+	* 
+	* @param params 
+	* @returns 
+	*/
 	toPath(params = {}) {
 		return this.path.replace(/\/?\{([^{}]+)\}/g, (segment, raw) => {
 			const optional = raw.endsWith("?");

package/dist/Route.d.cts

@@ -5,6 +5,12 @@ import { Middleware as Middleware$1 } from "./types/h3.cjs";
 import { ClearRequest } from "./ClearRequest.cjs";
 
 //#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$1 | Middleware, H = any> {
   ctx: X;
   body: RequestData;
@@ -26,9 +32,30 @@ declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
     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

package/dist/Route.d.mts

@@ -5,6 +5,12 @@ import { Middleware as Middleware$1 } from "./types/h3.mjs";
 import { ClearRequest } from "./ClearRequest.mjs";
 
 //#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$1 | Middleware, H = any> {
   ctx: X;
   body: RequestData;
@@ -26,9 +32,30 @@ declare class Route<X = any, M = Middleware$1 | Middleware, H = any> {
     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

package/dist/Route.mjs

@@ -1,4 +1,10 @@
 //#region src/Route.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
+*/
 var Route = class {
 	ctx;
 	body = {};
@@ -28,14 +34,40 @@ var Route = class {
 		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;
 		this.onName = options.onName;
+		this.normalizeMiddleware = options.normalizeMiddleware;
 	}
 	onName;
+	normalizeMiddleware;
+	/**
+	* Set the route name
+	* 
+	* @param name 
+	* @returns 
+	*/
 	name(name) {
 		const previousName = this.routeName;
 		this.routeName = name;
 		this.onName?.(name, this, previousName);
 		return this;
 	}
+	/**
+	* Register one or more middleware that will be executed before the route.
+	* 
+	* @param middlewares 
+	* @returns 
+	*/
+	middleware(middlewares) {
+		const normalized = (Array.isArray(middlewares) ? middlewares : [middlewares]).map((middleware) => this.normalizeMiddleware?.(middleware) ?? middleware);
+		this.middlewares.push(...normalized);
+		this.middlewareCount = this.middlewares.length;
+		return this;
+	}
+	/**
+	* Get the path generated and accessible by this route
+	* 
+	* @param params 
+	* @returns 
+	*/
 	toPath(params = {}) {
 		return this.path.replace(/\/?\{([^{}]+)\}/g, (segment, raw) => {
 			const optional = raw.endsWith("?");

package/dist/core/index.cjs

@@ -1,4 +1,10 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_Request = require('./Request.cjs');
 const require_Response = require('./Response.cjs');
 const require_plugins = require('./plugins.cjs');
 const require_router = require('./router.cjs');
+
+exports.CoreRouter = require_router.CoreRouter;
+exports.Request = require_Request.Request;
+exports.Response = require_Response.Response;
+exports.definePlugin = require_plugins.definePlugin;

package/dist/core/router.cjs

@@ -1,6 +1,7 @@
 const require_Request = require('./Request.cjs');
 const require_Response = require('./Response.cjs');
 const require_bindings = require('./bindings.cjs');
+const require_ResourceRoutes = require('../ResourceRoutes.cjs');
 const require_Route = require('../Route.cjs');
 let node_async_hooks = require("node:async_hooks");
 let node_module = require("node:module");
@@ -45,6 +46,51 @@ var CoreRouter = class {
 	static groupMiddlewares = [];
 	static globalMiddlewares = [];
 	/**
+	* Resolve middlewares before assigning to adapter
+	* 
+	* @param middleware 
+	* @returns 
+	*/
+	static resolveMiddleware(middleware) {
+		if (!middleware || typeof middleware === "function" && !require_bindings.isClass(middleware)) return middleware;
+		const instance = require_bindings.isClass(middleware) ? new middleware() : middleware;
+		if (instance && typeof instance.handle === "function") return instance.handle.bind(instance);
+		return middleware;
+	}
+	static resolveMiddlewares(middlewares = []) {
+		return middlewares.map((middleware) => this.resolveMiddleware(middleware));
+	}
+	static routeSpecificity(route) {
+		const path = route.registrationPaths.slice().sort((left, right) => right.length - left.length)[0] ?? route.path;
+		const segments = this.normalizePath(path).split("/").filter(Boolean);
+		return [
+			segments.filter((segment) => !segment.startsWith(":")).length,
+			segments.length,
+			path.length
+		];
+	}
+	static orderedRoutes() {
+		return Array.from(this.routes).sort((left, right) => {
+			const leftScore = this.routeSpecificity(left);
+			const rightScore = this.routeSpecificity(right);
+			for (let index = 0; index < leftScore.length; index++) {
+				const difference = rightScore[index] - leftScore[index];
+				if (difference !== 0) return difference;
+			}
+			return 0;
+		});
+	}
+	static removeRouteMethod(route, method, path) {
+		route.methods = route.methods.filter((existingMethod) => existingMethod !== method);
+		this.routesByPathMethod.delete(`${method.toUpperCase()} ${path}`);
+		const methodKey = method.toUpperCase();
+		this.routesByMethod.set(methodKey, (this.routesByMethod.get(methodKey) ?? []).filter((existingRoute) => existingRoute !== route));
+		if (!route.methods.some((existingMethod) => existingMethod !== "options")) {
+			this.routes.delete(route);
+			if (route.routeName && this.routesByName.get(route.routeName) === route) this.routesByName.delete(route.routeName);
+		}
+	}
+	/**
 	* Resets the router to it's default state
 	*/
 	static reset() {
@@ -456,17 +502,22 @@ var CoreRouter = class {
 		const fullPath = this.normalizePath(`${activePrefix}/${path}`);
 		const registrationPaths = this.routeRegistrationPaths(fullPath);
 		const parameters = this.parseRouteParameters(fullPath);
-		const route = new require_Route.Route(methods.includes("options") ? methods : methods.concat("options"), fullPath, handler, [
+		for (const method of methods) {
+			const existing = this.routesByPathMethod.get(`${method.toUpperCase()} ${fullPath}`);
+			if (existing) this.removeRouteMethod(existing, method, fullPath);
+		}
+		const route = new require_Route.Route(methods.includes("options") ? methods : methods.concat("options"), fullPath, handler, this.resolveMiddlewares([
 			...this.globalMiddlewares,
 			...activeGroupMiddlewares,
 			...middlewares || []
-		], {
+		]), {
 			registrationPaths,
 			parameters,
 			onName: (name, route, previousName) => {
 				if (previousName && this.routesByName.get(previousName) === route) this.routesByName.delete(previousName);
 				this.routesByName.set(name, route);
-			}
+			},
+			normalizeMiddleware: (middleware) => this.resolveMiddleware(middleware)
 		});
 		if (!methods.includes("options") && !this.routesByPathMethod.get(`OPTIONS ${fullPath}`)) this.options(path, this.createDefaultOptionsHandler());
 		this.routes.add(route);
@@ -486,6 +537,7 @@ var CoreRouter = class {
 	* @param options 
 	*/
 	static apiResource(basePath, controller, options) {
+		const resourceRoutes = {};
 		let paramName = "id";
 		if (!!this.config.inferParamName && this.hasPackageInstalled("@h3ravel/support")) {
 			const { str } = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href)("@h3ravel/support");
@@ -522,9 +574,10 @@ var CoreRouter = class {
 				const { method, path } = actions[action];
 				const actionMiddlewares = typeof options?.middlewares === "object" && !Array.isArray(options.middlewares) ? options.middlewares[action] : options?.middlewares;
 				const name = `${basePath}${path}`.replace(/\/:[^/]+|\/\{[^}]+\}/g, "").replace(/\{(\w+):[^}]+\}/g, "$1").replace(/\/|:|[{}]/g, ".").replace(/\.{2,}/g, ".").replace(/^\.|\.$/g, "");
-				this.add(method, `${basePath}${path}`, [controller, action], Array.isArray(actionMiddlewares) ? actionMiddlewares : actionMiddlewares ? [actionMiddlewares] : void 0).name(name + "." + action.toLowerCase());
+				resourceRoutes[action] = this.add(method, `${basePath}${path}`, [controller, action], Array.isArray(actionMiddlewares) ? actionMiddlewares : actionMiddlewares ? [actionMiddlewares] : void 0).name(name + "." + action.toLowerCase());
 			}
 		}
+		return new require_ResourceRoutes.ResourceRoutes(resourceRoutes);
 	}
 	/**
 	* Adds a new GET route to the router.

package/dist/core/router.d.cts

@@ -4,6 +4,7 @@ import { Route } from "../Route.cjs";
 import { Request } from "./Request.cjs";
 import { ClearRouterPluginArgumentsContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, PluginArgumentsResolver, PluginBind } from "./plugins.cjs";
 import { Controller } from "../Controller.cjs";
+import { ResourceRoutes } from "../ResourceRoutes.cjs";
 import { AsyncLocalStorage } from "node:async_hooks";
 
 //#region src/core/router.d.ts
@@ -37,6 +38,17 @@ declare abstract class CoreRouter {
   static prefix: string;
   static groupMiddlewares: any[];
   static globalMiddlewares: any[];
+  /**
+   * Resolve middlewares before assigning to adapter
+   *
+   * @param middleware
+   * @returns
+   */
+  protected static resolveMiddleware(middleware: any): any;
+  protected static resolveMiddlewares(middlewares?: any[]): any[];
+  protected static routeSpecificity(route: Route<any, any, any>): [number, number, number];
+  protected static orderedRoutes(): Array<Route<any, any, any>>;
+  protected static removeRouteMethod(route: Route<any, any, any>, method: HttpMethod, path: string): void;
   /**
    * Resets the router to it's default state
    */
@@ -134,7 +146,7 @@ declare abstract class CoreRouter {
     only?: ControllerAction[];
     except?: ControllerAction[];
     middlewares?: ApiResourceMiddleware<any>;
-  }): void;
+  }): ResourceRoutes<any, any, any>;
   /**
    * Adds a new GET route to the router.
    *