vortez 4.1.3 → 5.0.0-dev.15

package/build/server/router/HttpRule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpRule.js","sourceRoot":"","sources":["../../../src/server/router/HttpRule.ts"],"names":[],"mappings":"AAEA,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,cAAc,MAAM,gCAAgC,CAAC;AAG5D,MAAM,OAAO,QAAS,SAAQ,QAAyB;IASxC;IAES;IAVpB;;;;;;OAMG;IACH,YACW,MAAsB,EAC7B,OAAe,EAAE,MAAuB,EACxB,aAA6B,IAAI,cAAc,EAAE;QACjE,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAHhB,WAAM,GAAN,MAAM,CAAgB;QAEb,eAAU,GAAV,UAAU,CAAuC;IACzC,CAAC;IACtB,IAAI,CAAC,OAAgB,EAAE,QAAkB,EAAE,KAAwB;QACtE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IACM,IAAI,CAAC,OAAgB;QACxB,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,IAAK,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3F,CAAC;IACD;;;OAGG;IACI,GAAG,CAAC,MAA8B;QACrC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;OAGG;IACI,QAAQ,CAAC,MAAmC;QAC/C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,IAAY,EAAE,UAA2B;QAC3E,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,GAAG,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,IAAI,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5D,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,IAAY,EAAE,UAA2B;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5D,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,MAAsB,EAAE,OAAe,EAAE,MAAuB,EAAE,UAA2B;QAC9G,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IACD;;;;;OAKG;IACK,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,OAAgB,EAAE,MAAgB;QAC5E,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;QAC7C,MAAM,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IACD;;;;;OAKG;IACK,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,OAAgB,EAAE,MAAgB;QAC1E,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;CACJ;AAMD,eAAe,QAAQ,CAAC"}

package/build/server/router/Router.d.ts

@@ -0,0 +1,127 @@
+/**
+ * @author NetFeez <codefeez.dev@gmail.com>
+ * @description Manages the routing of the requests and WebSocket connections.
+ * @license Apache-2.0
+*/
+import HTTP from 'http';
+import { Duplex } from 'stream';
+import _Rule from './Rule.js';
+import _WsRule from './WsRule.js';
+import _HttpRule from './HttpRule.js';
+import _WsMiddleware from './middleware/WsMiddleware.js';
+import _HttpMiddleware from './middleware/HttpMiddleware.js';
+import _Middleware from './middleware/Middleware.js';
+import Request from '../Request.js';
+import Response from '../Response.js';
+import Websocket from '../websocket/Websocket.js';
+import Config from '../config/Config.js';
+export { Rule } from './Rule.js';
+export { WsRule } from './WsRule.js';
+export { HttpRule } from './HttpRule.js';
+export declare class Router {
+    config: Config;
+    httpRules: Router.HttpRule[];
+    wsRules: Router.WsRule[];
+    readonly httpMiddleware: Router.HttpMiddleware;
+    readonly wsMiddleware: Router.WsMiddleware;
+    /**
+     * Creates a router for rule management.
+     * @param config - The server configuration.
+     */
+    constructor(config?: Config, rules?: Router.rules[], middlewares?: Router.MiddlewareOptions);
+    /**
+     * Adds middleware actions to the router.
+     * @param middleware - The middleware to be added.
+     */
+    use(middleware: Router.HttpMiddleware | Router.WsMiddleware): this;
+    /**
+     * Adds middleware error actions to the router.
+     * @param middleware - The middleware to be added.
+     */
+    useError(middleware: Router.HttpMiddleware | Router.WsMiddleware): this;
+    /**
+     * Triggered when the server receives an HTTP request.
+     * @param HttpRequest - The incoming HTTP request.
+     * @param HttpResponse - The server response stream.
+     */
+    requestManager(HttpRequest: HTTP.IncomingMessage, HttpResponse: HTTP.ServerResponse): void;
+    /**
+     * Will be executed when the server receives an upgrade request.
+     * @param HttpRequest The request received by the server.
+     * @param Socket The socket to respond with (WebSocket upgrade).
+     */
+    upgradeManager(HttpRequest: HTTP.IncomingMessage, Socket: Duplex): void;
+    /**
+     * Routes incoming HTTP requests to be processed.
+     * @param request - The received HTTP request.
+     * @param response - The server response handler.
+     */
+    routeRequest(request: Request, response: Response): Promise<boolean>;
+    /**
+     * Routes WebSocket connection requests.
+     * @param request - The received HTTP request.
+     * @param webSocket - The WebSocket connection with the client.
+     */
+    routeWebSocket(request: Request, webSocket: Websocket): Promise<boolean>;
+    /**
+     * Adds one or more routing rules to the server.
+     * @param rules - The rule(s) to be added.
+     */
+    addRules(...rules: Router.rules[]): this;
+    /**
+     * Adds one or more routing rules to the server.
+     * @param rule - The rule(s) to be added.
+     */
+    addRule(rule: Router.rules): this;
+    /**
+     * Mount a router in this router
+     * this action merge the rules adding the provided url rule as a prefix to all rules.
+     * @param router - The router to mount.
+     * @param urlRule - The url rule to mount the router.
+     */
+    mount(router: Router, urlRule?: string): this;
+    /**
+     * Adds an action routing rule.
+     * @param method - The HTTP method to respond to.
+     * @param urlRule - The URL path for the action.
+     * @param action - The action to be executed.
+     */
+    addAction(method: Request.Method, urlRule: string, action: Router.HttpRule.action): Router.HttpRule;
+    /**
+     * Adds a file routing rule.
+     * @param urlRule - The URL path to listen on.
+     * @param source - The path to the file to be served.
+     */
+    addFile(urlRule: string, source: string): Router.HttpRule;
+    /**
+     * Adds a folder routing rule.
+     * @param urlRule - The URL path to listen on.
+     * @param source - The directory path to be served.
+     */
+    addFolder(urlRule: string, source: string): Router;
+    /**
+     * Adds a WebSocket routing rule.
+     * @param urlRule - The URL path to listen on.
+     * @param action - The action to be executed on connection.
+     */
+    addWebSocket(urlRule: string, action: Router.WsRule.action): Router.WsRule;
+    /**
+     * Creates a new router.
+     * @returns A new router.
+     */
+    createRouter(): Router;
+}
+export declare namespace Router {
+    export import Rule = _Rule;
+    export import WsRule = _WsRule;
+    export import HttpRule = _HttpRule;
+    export import WsMiddleware = _WsMiddleware;
+    export import HttpMiddleware = _HttpMiddleware;
+    export import Middleware = _Middleware;
+    interface MiddlewareOptions {
+        http?: HttpMiddleware;
+        ws?: WsMiddleware;
+    }
+    type rules = WsRule | HttpRule;
+}
+export default Router;

package/build/server/router/Router.js

@@ -0,0 +1,211 @@
+/**
+ * @author NetFeez <codefeez.dev@gmail.com>
+ * @description Manages the routing of the requests and WebSocket connections.
+ * @license Apache-2.0
+*/
+import _Rule from './Rule.js';
+import _WsRule from './WsRule.js';
+import _HttpRule from './HttpRule.js';
+import _WsMiddleware from './middleware/WsMiddleware.js';
+import _HttpMiddleware from './middleware/HttpMiddleware.js';
+import _Middleware from './middleware/Middleware.js';
+import Request from '../Request.js';
+import Response from '../Response.js';
+import Websocket from '../websocket/Websocket.js';
+import LoggerManager from '../LoggerManager.js';
+import Config from '../config/Config.js';
+export { Rule } from './Rule.js';
+export { WsRule } from './WsRule.js';
+export { HttpRule } from './HttpRule.js';
+const logger = LoggerManager.getInstance();
+export class Router {
+    config;
+    httpRules = [];
+    wsRules = [];
+    httpMiddleware;
+    wsMiddleware;
+    /**
+     * Creates a router for rule management.
+     * @param config - The server configuration.
+     */
+    constructor(config = new Config(), rules = [], middlewares = {}) {
+        this.config = config;
+        const { http: httpMiddleware = new Router.HttpMiddleware(), ws: wsMiddleware = new Router.WsMiddleware() } = middlewares;
+        this.httpMiddleware = httpMiddleware;
+        this.wsMiddleware = wsMiddleware;
+        this.addRules(...rules);
+    }
+    /**
+     * Adds middleware actions to the router.
+     * @param middleware - The middleware to be added.
+     */
+    use(middleware) {
+        if (middleware instanceof Router.HttpMiddleware)
+            this.httpMiddleware.use(middleware);
+        else
+            this.wsMiddleware.use(middleware);
+        return this;
+    }
+    /**
+     * Adds middleware error actions to the router.
+     * @param middleware - The middleware to be added.
+     */
+    useError(middleware) {
+        if (middleware instanceof Router.HttpMiddleware)
+            this.httpMiddleware.useError(middleware);
+        else
+            this.wsMiddleware.useError(middleware);
+        return this;
+    }
+    /**
+     * Triggered when the server receives an HTTP request.
+     * @param HttpRequest - The incoming HTTP request.
+     * @param HttpResponse - The server response stream.
+     */
+    requestManager(HttpRequest, HttpResponse) {
+        const request = new Request(HttpRequest);
+        const response = new Response(request, HttpResponse, this.config.templates);
+        const sessionID = request.cookies.get('Session');
+        logger.request.log(request.ip, request.method, request.url, sessionID);
+        const isRouted = this.routeRequest(request, response);
+        if (!isRouted)
+            response.sendError(400, `No router for: ${request.method} -> ${request.url}`);
+    }
+    ;
+    /**
+     * Will be executed when the server receives an upgrade request.
+     * @param HttpRequest The request received by the server.
+     * @param Socket The socket to respond with (WebSocket upgrade).
+     */
+    upgradeManager(HttpRequest, Socket) {
+        const request = new Request(HttpRequest);
+        const webSocket = new Websocket(request, Socket);
+        const sessionID = request.cookies.get('Session');
+        logger.webSocket.log(request.ip, request.method, request.url, sessionID);
+        const isRouted = this.routeWebSocket(request, webSocket);
+        if (!isRouted)
+            webSocket.reject(400, `No router for: ${request.method} -> ${request.url}`);
+    }
+    /**
+     * Routes incoming HTTP requests to be processed.
+     * @param request - The received HTTP request.
+     * @param response - The server response handler.
+     */
+    async routeRequest(request, response) {
+        const rule = this.httpRules.find((rule) => rule.test(request));
+        if (!rule)
+            return false;
+        rule.exec(request, response);
+        return true;
+    }
+    /**
+     * Routes WebSocket connection requests.
+     * @param request - The received HTTP request.
+     * @param webSocket - The WebSocket connection with the client.
+     */
+    async routeWebSocket(request, webSocket) {
+        const rule = this.wsRules.find((rule) => rule.test(request));
+        if (!rule)
+            return false;
+        rule.exec(request, webSocket);
+        return true;
+    }
+    /**
+     * Adds one or more routing rules to the server.
+     * @param rules - The rule(s) to be added.
+     */
+    addRules(...rules) {
+        for (const rule of rules)
+            this.addRule(rule);
+        return this;
+    }
+    /**
+     * Adds one or more routing rules to the server.
+     * @param rule - The rule(s) to be added.
+     */
+    addRule(rule) {
+        if (rule instanceof Router.WsRule) {
+            rule.middleware.mergeAtStart(this.wsMiddleware);
+            this.wsRules.push(rule);
+        }
+        else {
+            rule.middleware.mergeAtStart(this.httpMiddleware);
+            this.httpRules.push(rule);
+        }
+        return this;
+    }
+    /**
+     * Mount a router in this router
+     * this action merge the rules adding the provided url rule as a prefix to all rules.
+     * @param router - The router to mount.
+     * @param urlRule - The url rule to mount the router.
+     */
+    mount(router, urlRule) {
+        const httpRules = router.httpRules.map((rule) => {
+            const newUrlRule = urlRule ? `${urlRule}/${rule.urlRule}` : rule.urlRule;
+            return new Router.HttpRule(rule.method, newUrlRule, rule.action, rule.middleware.clone());
+        });
+        const wsRules = router.wsRules.map((rule) => {
+            const newUrlRule = urlRule ? `${urlRule}/${rule.urlRule}` : rule.urlRule;
+            return new Router.WsRule(newUrlRule, rule.action, rule.middleware.clone());
+        });
+        this.addRules(...httpRules, ...wsRules);
+        return this;
+    }
+    /**
+     * Adds an action routing rule.
+     * @param method - The HTTP method to respond to.
+     * @param urlRule - The URL path for the action.
+     * @param action - The action to be executed.
+     */
+    addAction(method, urlRule, action) {
+        const rule = new Router.HttpRule(method, urlRule, action);
+        this.addRule(rule);
+        return rule;
+    }
+    /**
+     * Adds a file routing rule.
+     * @param urlRule - The URL path to listen on.
+     * @param source - The path to the file to be served.
+     */
+    addFile(urlRule, source) {
+        const rule = Router.HttpRule.file(urlRule, source);
+        this.addRule(rule);
+        return rule;
+    }
+    /**
+     * Adds a folder routing rule.
+     * @param urlRule - The URL path to listen on.
+     * @param source - The directory path to be served.
+     */
+    addFolder(urlRule, source) {
+        const rule = Router.HttpRule.folder(urlRule, source);
+        this.addRule(rule);
+        return this;
+    }
+    /**
+     * Adds a WebSocket routing rule.
+     * @param urlRule - The URL path to listen on.
+     * @param action - The action to be executed on connection.
+     */
+    addWebSocket(urlRule, action) {
+        const rule = new Router.WsRule(urlRule, action);
+        this.addRules(rule);
+        return rule;
+    }
+    /**
+     * Creates a new router.
+     * @returns A new router.
+     */
+    createRouter() { return new Router(this.config); }
+}
+(function (Router) {
+    Router.Rule = _Rule;
+    Router.WsRule = _WsRule;
+    Router.HttpRule = _HttpRule;
+    Router.WsMiddleware = _WsMiddleware;
+    Router.HttpMiddleware = _HttpMiddleware;
+    Router.Middleware = _Middleware;
+})(Router || (Router = {}));
+export default Router;
+//# sourceMappingURL=Router.js.map

package/build/server/router/Router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Router.js","sourceRoot":"","sources":["../../../src/server/router/Router.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAKF,OAAO,KAAK,MAAM,WAAW,CAAC;AAC9B,OAAO,OAAO,MAAM,aAAa,CAAC;AAClC,OAAO,SAAuB,MAAM,eAAe,CAAC;AACpD,OAAO,aAAa,MAAM,8BAA8B,CAAC;AACzD,OAAO,eAAe,MAAM,gCAAgC,CAAC;AAC7D,OAAO,WAAW,MAAM,4BAA4B,CAAC;AAErD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAClD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,MAAM,MAAM,qBAAqB,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,MAAM,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;AAE3C,MAAM,OAAO,MAAM;IAUV;IATE,SAAS,GAAsB,EAAE,CAAC;IAClC,OAAO,GAAoB,EAAE,CAAC;IACxB,cAAc,CAAwB;IACtC,YAAY,CAAsB;IAClD;;;OAGG;IACA,YACK,SAAiB,IAAI,MAAM,EAAE,EACpC,QAAwB,EAAE,EAC1B,cAAwC,EAAE;QAFnC,WAAM,GAAN,MAAM,CAAuB;QAIpC,MAAM,EACL,IAAI,EAAE,cAAc,GAAG,IAAI,MAAM,CAAC,cAAc,EAAE,EAClD,EAAE,EAAE,YAAY,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,EAC5C,GAAG,WAAW,CAAC;QAChB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC;IACtB,CAAC;IACJ;;;OAGG;IACI,GAAG,CAAC,UAAuD;QACjE,IAAI,UAAU,YAAY,MAAM,CAAC,cAAc;YAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;;YAChF,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;OAGG;IACI,QAAQ,CAAC,UAAuD;QACtE,IAAI,UAAU,YAAY,MAAM,CAAC,cAAc;YAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;;YACrF,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,cAAc,CAAC,WAAiC,EAAE,YAAiC;QACzF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC5E,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ;YAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,kBAAkB,OAAO,CAAC,MAAM,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9F,CAAC;IAAA,CAAC;IACF;;;;OAIG;IACI,cAAc,CAAC,WAAiC,EAAE,MAAc;QACtE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,OAAO,CAAC,MAAM,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5F,CAAC;IACE;;;;OAIA;IACI,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,QAAkB;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,OAAgB,EAAE,SAAoB;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;OAGG;IACI,QAAQ,CAAC,GAAG,KAAqB;QACvC,KAAK,MAAM,IAAI,IAAI,KAAK;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;OAGG;IACI,OAAO,CAAC,IAAkB;QAChC,IAAI,IAAI,YAAY,MAAM,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAClD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,MAAc,EAAE,OAAgB;QAC5C,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YACzE,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3C,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YACzE,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;;OAKG;IACI,SAAS,CAAC,MAAsB,EAAE,OAAe,EAAE,MAA8B;QACvF,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,OAAO,CAAC,OAAe,EAAE,MAAc;QAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,SAAS,CAAC,OAAe,EAAE,MAAc;QAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,YAAY,CAAC,OAAe,EAAE,MAA4B;QAChE,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IACD;;;OAGG;IACI,YAAY,KAAa,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CACjE;AACD,WAAiB,MAAM;IACL,WAAI,GAAG,KAAK,CAAC;IAChB,aAAM,GAAG,OAAO,CAAC;IACjB,eAAQ,GAAG,SAAS,CAAC;IACrB,mBAAY,GAAG,aAAa,CAAC;IAC7B,qBAAc,GAAG,eAAe,CAAC;IACjC,iBAAU,GAAG,WAAW,CAAC;AAMxC,CAAC,EAZgB,MAAM,KAAN,MAAM,QAYtB;AAED,eAAe,MAAM,CAAC"}

package/build/server/router/Rule.d.ts

@@ -0,0 +1,71 @@
+/**
+ * @author NetFeez <codefeez.dev@gmail.com>
+ * @description Contains routing rule logic for Vortez.
+ * @license Apache-2.0
+ */
+import Request from '../Request.js';
+import Response from '../Response.js';
+import Websocket from '../websocket/Websocket.js';
+export declare abstract class Rule<T extends any> {
+    /** The UrlRule with which the routing rule was created */
+    private _urlRule;
+    /** The regular expression for the routing rule */
+    private _expression;
+    /** The executable content for the routing rule */
+    readonly action: T;
+    /**
+     * Creates a routing rule for Vortez.
+     * @param urlRule - The URL rule adopted by this Rule instance.
+     * @param action - The executable content of the rule.
+     */
+    constructor(urlRule: string, action: T);
+    get urlRule(): string;
+    set urlRule(urlRule: string);
+    get expression(): RegExp;
+    /**
+     * Executes the rule's content.
+     * @param request - The Request that matched the rule.
+     * @param client - The client that made the request.
+     */
+    abstract exec(request: Request, client: Rule.ClientType): void | Promise<void>;
+    /**
+     * Checks whether a URL matches this route.
+     * Also sets the Request.ruleParams.
+     * @param request - The incoming request.
+     */
+    test(request: Request): boolean;
+    /**
+     * Retrieves the ruleParams from the routing rule if available.
+     * @param path - The URL to resolve.
+     */
+    getParams(path: string): Rule.ruleParams;
+    /**
+     * Extracts the surplus URL using the rule's expression.
+     * @param url - The full URL to extract from.
+     */
+    getSurplus(url: string): string;
+    /**
+     * Creates a regular expression for route matching.
+     * @param urlRule - The UrlRule used to form the RegExp.
+     * @throws Invalid URL rule format
+     */
+    createExpression(urlRule: string): RegExp;
+    /**
+     * Cleans the URL rule.
+     * @param urlRule - The URL rule to clean.
+     */
+    private static cleanUrlRule;
+    /**
+     * Creates a regular expression for route matching.
+     * @param urlRule - The UrlRule used to form the RegExp.
+     * @throws Invalid URL rule format
+     */
+    private static createExpression;
+}
+export declare namespace Rule {
+    type ClientType = Websocket | Response;
+    interface ruleParams {
+        [name: string]: string | undefined;
+    }
+}
+export default Rule;

package/build/server/router/Rule.js

@@ -0,0 +1,113 @@
+/**
+ * @author NetFeez <codefeez.dev@gmail.com>
+ * @description Contains routing rule logic for Vortez.
+ * @license Apache-2.0
+ */
+export class Rule {
+    /** The UrlRule with which the routing rule was created */
+    _urlRule;
+    /** The regular expression for the routing rule */
+    _expression;
+    /** The executable content for the routing rule */
+    action;
+    /**
+     * Creates a routing rule for Vortez.
+     * @param urlRule - The URL rule adopted by this Rule instance.
+     * @param action - The executable content of the rule.
+     */
+    constructor(urlRule, action) {
+        urlRule = Rule.cleanUrlRule(urlRule);
+        this._urlRule = urlRule;
+        this._expression = this.createExpression(urlRule);
+        this.action = action;
+    }
+    get urlRule() { return this._urlRule; }
+    set urlRule(urlRule) {
+        urlRule = Rule.cleanUrlRule(urlRule);
+        this._urlRule = urlRule;
+        this._expression = this.createExpression(urlRule);
+    }
+    get expression() { return this._expression; }
+    /**
+     * Checks whether a URL matches this route.
+     * Also sets the Request.ruleParams.
+     * @param request - The incoming request.
+     */
+    test(request) { return this._expression.test(request.url); }
+    /**
+     * Retrieves the ruleParams from the routing rule if available.
+     * @param path - The URL to resolve.
+     */
+    getParams(path) {
+        const math = this._expression.exec(path);
+        if (!math)
+            return {};
+        return { ...math.groups };
+    }
+    /**
+     * Extracts the surplus URL using the rule's expression.
+     * @param url - The full URL to extract from.
+     */
+    getSurplus(url) {
+        const { $surplus = '' } = this.getParams(url);
+        return $surplus;
+    }
+    /**
+     * Creates a regular expression for route matching.
+     * @param urlRule - The UrlRule used to form the RegExp.
+     * @throws Invalid URL rule format
+     */
+    createExpression(urlRule) {
+        return Rule.createExpression(urlRule);
+    }
+    /**
+     * Cleans the URL rule.
+     * @param urlRule - The URL rule to clean.
+     */
+    static cleanUrlRule(urlRule) {
+        if (!urlRule.startsWith('/'))
+            urlRule = '/' + urlRule;
+        if (urlRule.endsWith('/'))
+            urlRule = urlRule.slice(0, -1);
+        urlRule = urlRule.replace(/\/+/g, '/');
+        return urlRule;
+    }
+    /**
+     * Creates a regular expression for route matching.
+     * @param urlRule - The UrlRule used to form the RegExp.
+     * @throws Invalid URL rule format
+     */
+    static createExpression(urlRule) {
+        const validators = {
+            paramRequired: /^\$(?<param>(?!\$).+)$/,
+            paramOptional: /^\$\?(?<param>(?!\$).+)$/,
+            escape: /\\(?![\$\[\]\*\+\?\.\(\)\{\}\^\|\-])|(?<!\\)[\$\[\]\*\+\?\.\(\)\{\}\^\|\-]/gi,
+        };
+        const zones = urlRule.split('/').slice(1);
+        let generated = '^';
+        for (let index = 0; index < zones.length; index++) {
+            const zone = zones[index];
+            if (zone == '*') {
+                const isLast = index == (zones.length - 1);
+                generated += isLast ? '(?<$surplus>/.+)?' : '(?:/[^/]+)';
+                continue;
+            }
+            const optional = zone.match(validators.paramOptional);
+            if (optional && optional.groups) {
+                const param = optional.groups['param'].replace(validators.escape, '');
+                generated += `(?:/(?<${param}>[^/]+))?`;
+                continue;
+            }
+            const required = zone.match(validators.paramRequired);
+            if (required && required.groups) {
+                const param = required.groups['param'].replace(validators.escape, '');
+                generated += `/(?<${param}>[^/]+)`;
+                continue;
+            }
+            generated += `/${zone}`;
+        }
+        return new RegExp(`${generated}/?$`);
+    }
+}
+export default Rule;
+//# sourceMappingURL=Rule.js.map

package/build/server/router/Rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rule.js","sourceRoot":"","sources":["../../../src/server/router/Rule.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,MAAM,OAAgB,IAAI;IACtB,0DAA0D;IAClD,QAAQ,CAAS;IACzB,kDAAkD;IAC1C,WAAW,CAAS;IAC5B,kDAAkD;IAClC,MAAM,CAAI;IAC1B;;;;OAIG;IACH,YAAmB,OAAe,EAAE,MAAS;QACzC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,IAAW,OAAO,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,IAAW,OAAO,CAAC,OAAe;QAC9B,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IACD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAO5D;;;;OAIG;IACI,IAAI,CAAC,OAAgB,IAAa,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrF;;;OAGG;IACI,SAAS,CAAC,IAAY;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IACD;;;OAGG;IACI,UAAU,CAAC,GAAW;QACzB,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD;;;;OAIG;IACI,gBAAgB,CAAC,OAAe;QACnC,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD;;;OAGG;IACK,MAAM,CAAC,YAAY,CAAC,OAAe;QACvC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,GAAG,GAAG,OAAO,CAAC;QACtD,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,OAAO,CAAC;IACnB,CAAC;IACD;;;;OAIG;IACK,MAAM,CAAC,gBAAgB,CAAC,OAAe;QAC3C,MAAM,UAAU,GAAG;YACf,aAAa,EAAE,wBAAwB;YACvC,aAAa,EAAE,0BAA0B;YACzC,MAAM,EAAE,8EAA8E;SACzF,CAAC;QACF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,SAAS,GAAG,GAAG,CAAC;QAEpB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAG,EAAE,CAAC;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YAE1B,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;gBACd,MAAM,MAAM,GAAG,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAC3C,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC;gBACzD,SAAS;YACb,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACtD,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC9B,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACtE,SAAS,IAAI,UAAU,KAAK,WAAW,CAAC;gBACxC,SAAS;YACb,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACtD,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC9B,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACtE,SAAS,IAAI,OAAO,KAAK,SAAS,CAAC;gBACnC,SAAS;YACb,CAAC;YAED,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,MAAM,CAAC,GAAG,SAAS,KAAK,CAAC,CAAC;IACzC,CAAC;CACJ;AASD,eAAe,IAAI,CAAC"}

package/build/server/router/WsRule.d.ts

@@ -0,0 +1,25 @@
+import Request from '../Request.js';
+import Websocket from '../websocket/Websocket.js';
+import Middleware from './middleware/Middleware.js';
+import WsMiddleware from './middleware/WsMiddleware.js';
+import Rule from './Rule.js';
+export declare class WsRule extends Rule<WsRule.action> {
+    readonly middleware: WsMiddleware;
+    constructor(urlRule: string, action: WsRule.action, middleware?: WsMiddleware);
+    exec(request: Request, client: Websocket, state?: Middleware.State): void;
+    test(request: Request): boolean;
+    /**
+     * Adds a middleware to this specific rule.
+     * @param action The middleware action.
+     */
+    use(action: Middleware.action.ws): this;
+    /**
+     * Adds a error middleware to this specific rule.
+     * @param action The middleware action.
+     */
+    useError(action: Middleware.errorAction.ws): this;
+}
+export declare namespace WsRule {
+    type action = (request: Request, client: Websocket, state: Middleware.State) => void;
+}
+export default WsRule;

package/build/server/router/WsRule.js

@@ -0,0 +1,34 @@
+import WsMiddleware from './middleware/WsMiddleware.js';
+import Rule from './Rule.js';
+export class WsRule extends Rule {
+    middleware;
+    constructor(urlRule, action, middleware = new WsMiddleware()) {
+        super(urlRule, action);
+        this.middleware = middleware;
+    }
+    exec(request, client, state) {
+        request.ruleParams = this.getParams(request.url);
+        this.middleware.run(request, client, this.action, state);
+    }
+    test(request) {
+        return super.test(request);
+    }
+    /**
+     * Adds a middleware to this specific rule.
+     * @param action The middleware action.
+     */
+    use(action) {
+        this.middleware.use(action);
+        return this;
+    }
+    /**
+     * Adds a error middleware to this specific rule.
+     * @param action The middleware action.
+     */
+    useError(action) {
+        this.middleware.useError(action);
+        return this;
+    }
+}
+export default WsRule;
+//# sourceMappingURL=WsRule.js.map

package/build/server/router/WsRule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsRule.js","sourceRoot":"","sources":["../../../src/server/router/WsRule.ts"],"names":[],"mappings":"AAGA,OAAO,YAAY,MAAM,8BAA8B,CAAC;AACxD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,OAAO,MAAO,SAAQ,IAAmB;IAGvB;IAFpB,YACI,OAAe,EAAE,MAAqB,EACtB,aAA2B,IAAI,YAAY,EAAE;QAC7D,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QADP,eAAU,GAAV,UAAU,CAAmC;IACrC,CAAC;IACtB,IAAI,CAAC,OAAgB,EAAE,MAAiB,EAAE,KAAwB;QACrE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;IACM,IAAI,CAAC,OAAgB;QACxB,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IACD;;;OAGG;IACI,GAAG,CAAC,MAA4B;QACnC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;OAGG;IACI,QAAQ,CAAC,MAAiC;QAC7C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAID,eAAe,MAAM,CAAC"}

package/build/server/router/middleware/HttpMiddleware.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @author NetFeez <codefeez.dev@gmail.com>
+ * @description Manages the middleware pipeline for HttpRules.
+ * @license Apache-2.0
+ */
+import Request from '../../Request.js';
+import Response from '../../Response.js';
+import HttpRule from '../HttpRule.js';
+import Middleware from './Middleware.js';
+export declare class HttpMiddleware extends Middleware<HttpRule> {
+    clone(): HttpMiddleware;
+    /**
+     * Runs the middleware pipeline.
+     * @param request - The request received by the server.
+     * @param response - The response to be sent by the server.
+     * @param action - The action to run.
+     * @param state - The state to pass to the action.
+     */
+    run(request: Request, response: Response, action: HttpRule.action, state?: Middleware.State): Promise<void>;
+    /**
+     * Runs the error pipeline.
+     * @param error - The error to handle.
+     * @param request - The request received by the server.
+     * @param response - The response to be sent by the server.
+     * @param state - The state to pass to the action.
+     */
+    runError(error: unknown, request: Request, response: Response, state?: Middleware.State): Promise<void>;
+    /**
+     * Handles errors.
+     * @param error - The error to handle.
+     */
+    protected errorHandler(error: unknown, request: Request, response: Response): Promise<void>;
+}
+export declare namespace HttpMiddleware { }
+export default HttpMiddleware;