clear-router 2.7.6 → 2.8.0

package/dist/ClearRequest.cjs

@@ -0,0 +1,23 @@
+
+//#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
+exports.ClearRequest = ClearRequest;

package/dist/ClearRequest.d.cts

@@ -0,0 +1,28 @@
+import { RequestData } from "./types/basic.cjs";
+import { Middleware } from "./types/express.cjs";
+import { Middleware as Middleware$1 } from "./types/fastify.cjs";
+import { Middleware as Middleware$2 } from "./types/h3.cjs";
+import { Middleware as Middleware$3 } from "./types/hono.cjs";
+import { Middleware as Middleware$4 } from "./types/koa.cjs";
+import { Route } from "./Route.cjs";
+
+//#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
+export { ClearRequest };

package/dist/ClearRequest.d.mts

@@ -0,0 +1,28 @@
+import { RequestData } from "./types/basic.mjs";
+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 { Route } from "./Route.mjs";
+
+//#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
+export { ClearRequest };

package/dist/ClearRequest.mjs

@@ -0,0 +1,22 @@
+//#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
+export { ClearRequest };

package/dist/Contracts.d.cts

@@ -0,0 +1,12 @@
+//#region src/Contracts.d.ts
+/**
+ * HTTP context passed to route handlers
+ */
+interface ClearHttpContext {}
+interface RouteParameter {
+  name: string;
+  field?: string;
+  optional: boolean;
+}
+//#endregion
+export { ClearHttpContext, RouteParameter };

package/dist/Contracts.d.mts

@@ -0,0 +1,12 @@
+//#region src/Contracts.d.ts
+/**
+ * HTTP context passed to route handlers
+ */
+interface ClearHttpContext {}
+interface RouteParameter {
+  name: string;
+  field?: string;
+  optional: boolean;
+}
+//#endregion
+export { ClearHttpContext, RouteParameter };

package/dist/Controller.cjs

@@ -0,0 +1,12 @@
+
+//#region src/Controller.ts
+var Controller = class {
+	ctx;
+	body;
+	query;
+	params;
+	clearRequest;
+};
+
+//#endregion
+exports.Controller = Controller;

package/dist/Controller.d.cts

@@ -0,0 +1,14 @@
+import { RequestData } from "./types/basic.cjs";
+import { ClearRequest } from "./ClearRequest.cjs";
+
+//#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 { Controller };

package/dist/Controller.d.mts

@@ -0,0 +1,14 @@
+import { RequestData } from "./types/basic.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
+
+//#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 { Controller };

package/dist/Controller.mjs

@@ -0,0 +1,11 @@
+//#region src/Controller.ts
+var Controller = class {
+	ctx;
+	body;
+	query;
+	params;
+	clearRequest;
+};
+
+//#endregion
+export { Controller };

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

@@ -10,6 +10,11 @@ import { Middleware as Middleware$4 } from "./types/express.mjs";
  * HTTP context passed to route handlers
  */
 interface ClearHttpContext {}
+interface RouteParameter {
+  name: string;
+  field?: string;
+  optional: boolean;
+}
 //#endregion
 //#region src/core/Response.d.ts
 declare class Response {
@@ -35,11 +40,12 @@ declare class Response {
 }
 //#endregion
 //#region src/Route.d.ts
-interface RouteParameter {
-  name: string;
-  field?: string;
-  optional: boolean;
-}
+/**
+ * @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

@@ -0,0 +1,90 @@
+
+//#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 = {};
+	query = {};
+	params = {};
+	clearRequest;
+	methods;
+	path;
+	registrationPaths;
+	parameters;
+	routeName;
+	handler;
+	middlewares;
+	controllerName;
+	actionName;
+	handlerType;
+	middlewareCount;
+	constructor(methods, path, handler, middlewares = [], options = {}) {
+		this.methods = methods;
+		this.path = path;
+		this.registrationPaths = options.registrationPaths || [path];
+		this.parameters = options.parameters || [];
+		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;
+		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("?");
+			const [rawName, rawField] = (optional ? raw.slice(0, -1) : raw).split(":", 2);
+			const name = rawName.trim();
+			const field = rawField?.trim();
+			const value = params[name];
+			const resolved = field && value && typeof value === "object" ? value[field] : value;
+			if (typeof resolved === "undefined" || resolved === null || resolved === "") {
+				if (optional) return "";
+				throw new Error(`Missing required route parameter: ${name}`);
+			}
+			return `${segment.startsWith("/") ? "/" : ""}${encodeURIComponent(String(resolved))}`;
+		}) || "/";
+	}
+};
+
+//#endregion
+exports.Route = Route;