clear-router 2.7.6 → 2.8.0

package/dist/Route.d.cts

@@ -0,0 +1,62 @@
+import { HttpMethod, RequestData } from "./types/basic.cjs";
+import { RouteParameter } from "./Contracts.cjs";
+import { Middleware } from "./types/express.cjs";
+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;
+  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 { Route };

package/dist/Route.d.mts

@@ -0,0 +1,62 @@
+import { HttpMethod, RequestData } from "./types/basic.mjs";
+import { RouteParameter } from "./Contracts.mjs";
+import { Middleware } from "./types/express.mjs";
+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;
+  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 { Route };

package/dist/Route.mjs

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

package/dist/core/Request.cjs

@@ -0,0 +1,35 @@
+const require_ClearRequest = require('../ClearRequest.cjs');
+
+//#region src/core/Request.ts
+var Request = class extends require_ClearRequest.ClearRequest {
+	original;
+	method = "GET";
+	path = "/";
+	url = "/";
+	headers = {};
+	constructor(init) {
+		super(init);
+		Object.assign(this, init);
+	}
+	getBody() {
+		return this.body ?? {};
+	}
+	header(name) {
+		if (typeof this.headers.get === "function") return this.headers.get(name) || "";
+		const headers = this.headers;
+		const value = headers[name] ?? headers[name.toLowerCase()];
+		return Array.isArray(value) ? String(value[0] ?? "") : String(value ?? "");
+	}
+	param(name) {
+		return this.params?.[name];
+	}
+	input(name) {
+		return this.body?.[name] ?? this.query?.[name] ?? this.params?.[name];
+	}
+	is(method) {
+		return this.method.toLowerCase() === String(method).toLowerCase();
+	}
+};
+
+//#endregion
+exports.Request = Request;

package/dist/core/Request.d.cts

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

package/dist/core/Request.d.mts

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

package/dist/core/Request.mjs

@@ -0,0 +1,35 @@
+import { ClearRequest } from "../ClearRequest.mjs";
+
+//#region src/core/Request.ts
+var Request = class extends ClearRequest {
+	original;
+	method = "GET";
+	path = "/";
+	url = "/";
+	headers = {};
+	constructor(init) {
+		super(init);
+		Object.assign(this, init);
+	}
+	getBody() {
+		return this.body ?? {};
+	}
+	header(name) {
+		if (typeof this.headers.get === "function") return this.headers.get(name) || "";
+		const headers = this.headers;
+		const value = headers[name] ?? headers[name.toLowerCase()];
+		return Array.isArray(value) ? String(value[0] ?? "") : String(value ?? "");
+	}
+	param(name) {
+		return this.params?.[name];
+	}
+	input(name) {
+		return this.body?.[name] ?? this.query?.[name] ?? this.params?.[name];
+	}
+	is(method) {
+		return this.method.toLowerCase() === String(method).toLowerCase();
+	}
+};
+
+//#endregion
+export { Request };

package/dist/core/Response.cjs

@@ -0,0 +1,59 @@
+
+//#region src/core/Response.ts
+var Response = class {
+	body;
+	headers = new Headers();
+	sent = false;
+	statusCode = 200;
+	statusText = "OK";
+	constructor(init) {
+		const { status: _, ...rest } = init ?? {};
+		Object.assign(this, rest);
+		if (init?.headers && !(init.headers instanceof Headers)) this.headers = new Headers(init.headers);
+		if (init?.status && typeof init.status === "number") this.statusCode = init?.status;
+	}
+	status(code) {
+		this.statusCode = code;
+		return this;
+	}
+	setStatusText(text) {
+		this.statusText = text;
+		return this;
+	}
+	code(code) {
+		return this.status(code);
+	}
+	setHeader(name, value) {
+		this.headers.set(name, value);
+		return this;
+	}
+	header(name, value) {
+		return this.setHeader(name, value);
+	}
+	set(name, value) {
+		return this.setHeader(name, value);
+	}
+	type(contentType) {
+		return this.setHeader("Content-Type", contentType);
+	}
+	send(body) {
+		this.body = body;
+		this.sent = true;
+		return this;
+	}
+	json(body) {
+		return this.type("application/json; charset=utf-8").send(body);
+	}
+	html(body) {
+		return this.type("text/html; charset=utf-8").send(body);
+	}
+	text(body) {
+		return this.type("text/plain; charset=utf-8").send(body);
+	}
+	noContent() {
+		return this.status(204).send(null);
+	}
+};
+
+//#endregion
+exports.Response = Response;

package/dist/core/Response.d.cts

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

package/dist/core/Response.d.mts

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

package/dist/core/Response.mjs

@@ -0,0 +1,58 @@
+//#region src/core/Response.ts
+var Response = class {
+	body;
+	headers = new Headers();
+	sent = false;
+	statusCode = 200;
+	statusText = "OK";
+	constructor(init) {
+		const { status: _, ...rest } = init ?? {};
+		Object.assign(this, rest);
+		if (init?.headers && !(init.headers instanceof Headers)) this.headers = new Headers(init.headers);
+		if (init?.status && typeof init.status === "number") this.statusCode = init?.status;
+	}
+	status(code) {
+		this.statusCode = code;
+		return this;
+	}
+	setStatusText(text) {
+		this.statusText = text;
+		return this;
+	}
+	code(code) {
+		return this.status(code);
+	}
+	setHeader(name, value) {
+		this.headers.set(name, value);
+		return this;
+	}
+	header(name, value) {
+		return this.setHeader(name, value);
+	}
+	set(name, value) {
+		return this.setHeader(name, value);
+	}
+	type(contentType) {
+		return this.setHeader("Content-Type", contentType);
+	}
+	send(body) {
+		this.body = body;
+		this.sent = true;
+		return this;
+	}
+	json(body) {
+		return this.type("application/json; charset=utf-8").send(body);
+	}
+	html(body) {
+		return this.type("text/html; charset=utf-8").send(body);
+	}
+	text(body) {
+		return this.type("text/plain; charset=utf-8").send(body);
+	}
+	noContent() {
+		return this.status(204).send(null);
+	}
+};
+
+//#endregion
+export { Response };

package/dist/{bindings-CLsZjOEy.cjs → core/bindings.cjs}

@@ -1,114 +1,6 @@
+const require_Request = require('./Request.cjs');
+const require_Response = require('./Response.cjs');
 
-//#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
-//#region src/core/Request.ts
-var Request = class extends ClearRequest {
-	original;
-	method = "GET";
-	path = "/";
-	url = "/";
-	headers = {};
-	constructor(init) {
-		super(init);
-		Object.assign(this, init);
-	}
-	getBody() {
-		return this.body ?? {};
-	}
-	header(name) {
-		if (typeof this.headers.get === "function") return this.headers.get(name) || "";
-		const headers = this.headers;
-		const value = headers[name] ?? headers[name.toLowerCase()];
-		return Array.isArray(value) ? String(value[0] ?? "") : String(value ?? "");
-	}
-	param(name) {
-		return this.params?.[name];
-	}
-	input(name) {
-		return this.body?.[name] ?? this.query?.[name] ?? this.params?.[name];
-	}
-	is(method) {
-		return this.method.toLowerCase() === String(method).toLowerCase();
-	}
-};
-
-//#endregion
-//#region src/core/Response.ts
-var Response = class {
-	body;
-	headers = new Headers();
-	sent = false;
-	statusCode = 200;
-	statusText = "OK";
-	constructor(init) {
-		const { status: _, ...rest } = init ?? {};
-		Object.assign(this, rest);
-		if (init?.headers && !(init.headers instanceof Headers)) this.headers = new Headers(init.headers);
-		if (init?.status && typeof init.status === "number") this.statusCode = init?.status;
-	}
-	status(code) {
-		this.statusCode = code;
-		return this;
-	}
-	setStatusText(text) {
-		this.statusText = text;
-		return this;
-	}
-	code(code) {
-		return this.status(code);
-	}
-	setHeader(name, value) {
-		this.headers.set(name, value);
-		return this;
-	}
-	header(name, value) {
-		return this.setHeader(name, value);
-	}
-	set(name, value) {
-		return this.setHeader(name, value);
-	}
-	type(contentType) {
-		return this.setHeader("Content-Type", contentType);
-	}
-	send(body) {
-		this.body = body;
-		this.sent = true;
-		return this;
-	}
-	json(body) {
-		return this.type("application/json; charset=utf-8").send(body);
-	}
-	html(body) {
-		return this.type("text/html; charset=utf-8").send(body);
-	}
-	text(body) {
-		return this.type("text/plain; charset=utf-8").send(body);
-	}
-	noContent() {
-		return this.status(204).send(null);
-	}
-};
-
-//#endregion
 //#region src/core/bindings.ts
 const metadataKey = Symbol.for("clear-router:binding-metadata");
 const bindings = /* @__PURE__ */ new WeakMap();
@@ -130,8 +22,8 @@ var Container = class {
 		return Object.fromEntries(this.registry.entries());
 	}
 	static async resolve(token, ctx, autoDiscover = false) {
-		if (token === Request) return ctx.clearRequest;
-		if (token === Response) return ctx.clearResponse;
+		if (token === require_Request.Request) return ctx.clearRequest;
+		if (token === require_Response.Response) return ctx.clearResponse;
 		const binding = this.getBinding(token);
 		if (binding) return this.resolveBinding(binding, ctx, autoDiscover);
 		if (autoDiscover && typeof token === "function") return new token();
@@ -259,51 +151,9 @@ function isClass(value) {
 }
 
 //#endregion
-Object.defineProperty(exports, 'Bind', {
-  enumerable: true,
-  get: function () {
-    return Bind;
-  }
-});
-Object.defineProperty(exports, 'Container', {
-  enumerable: true,
-  get: function () {
-    return Container;
-  }
-});
-Object.defineProperty(exports, 'Request', {
-  enumerable: true,
-  get: function () {
-    return Request;
-  }
-});
-Object.defineProperty(exports, 'Response', {
-  enumerable: true,
-  get: function () {
-    return Response;
-  }
-});
-Object.defineProperty(exports, 'getBindingMetadataFromTargets', {
-  enumerable: true,
-  get: function () {
-    return getBindingMetadataFromTargets;
-  }
-});
-Object.defineProperty(exports, 'getDesignParamTypes', {
-  enumerable: true,
-  get: function () {
-    return getDesignParamTypes;
-  }
-});
-Object.defineProperty(exports, 'getStandardMetadata', {
-  enumerable: true,
-  get: function () {
-    return getStandardMetadata;
-  }
-});
-Object.defineProperty(exports, 'isClass', {
-  enumerable: true,
-  get: function () {
-    return isClass;
-  }
-});
+exports.Bind = Bind;
+exports.Container = Container;
+exports.getBindingMetadataFromTargets = getBindingMetadataFromTargets;
+exports.getDesignParamTypes = getDesignParamTypes;
+exports.getStandardMetadata = getStandardMetadata;
+exports.isClass = isClass;

package/dist/{bindings-CNL7bpz5.d.mts → core/bindings.d.cts}

@@ -22,4 +22,4 @@ declare class Container {
 }
 declare function Bind(...tokens: BindToken[]): BindDecorator;
 //#endregion
-export { BindValue as a, BindToken as i, BindDecorator as n, Container as o, BindFactory as r, Bind as t };
+export { Bind, BindDecorator, BindFactory, BindToken, BindValue, Container };