feat: class-base controllers added to AxonCore.

Feat class base controllers

Author: MR-MKZ

README.md

@@ -10,7 +10,37 @@ Currently Axon is 2X faster than Express. :D please checkout [Axon Benchmarks](.
 
 [Axon telegram channel](https://t.me/axonjs)
 
-Latest change: (v0.10.0) 
+Latest change: (v0.11.0)
+- Class-Based Controllers
+    You can use the new generation of controllers in Axon.
+    In class-based controllers you can use state managing of classes in your application without any instance making.
+    More organized controllers!
+    ```ts
+    class UsersController extends BaseController {
+        async index(req: Request<any>, res: Response) {
+            return res.status(200).body({});
+        }
+    }
+
+    // [Class, Method]
+    router.get("/users", [UsersController, "index"]);
+    ```
+
+    Your controller class must extends from BaseController, Otherwise the router will throw error.
+    ```ts
+    class UsersController {
+        async index(req: Request<any>, res: Response) {
+            return res.status(200).body({});
+        }
+    }
+
+    router.get("/users", [UsersController, "index"]);
+
+    // Error: Controller class must extends from BaseController
+    ```
+
+Past changes: 
+#### (v0.10.0) 
 - Cookie manager added to Axon.
     You can access cookie manager by importing AxonCookie class in your code.
     AxonCookie has some static methods for managing cookies easily.
@@ -22,8 +52,7 @@ Latest change: (v0.10.0)
     AxonCookie.parse(req);
     AxonCookie.clear(res, name, options);
     ```
-
-Past changes: (v0.9.0)
+#### (v0.9.0)
 - Plugin system updated.
 - Project environment state added to core config.
 - Validation system added to router.

examples/class-base-controllers/controllers/auth.controller.ts

@@ -0,0 +1,12 @@
+import { BaseController } from "../../../src";
+import type { Response, Request } from "../../../src";
+
+class AuthController extends BaseController {
+    async login(req: Request<any>, res: Response) {
+        res.status(200).body({
+            msg: "Axon Class-based Controller 🤙"
+        });
+    }
+}
+
+export default AuthController;

examples/class-base-controllers/main.ts

@@ -0,0 +1,8 @@
+import { Axon } from "../../src";
+import authRouter from "./routers/auth.route";
+
+const core = Axon();
+
+core.loadRoute(authRouter);
+
+core.listen();

examples/class-base-controllers/routers/auth.route.ts

@@ -0,0 +1,8 @@
+import { Router } from "../../../src";
+import AuthController from "../controllers/auth.controller";
+
+const router = Router("/api/auth");
+
+router.post("/login", [AuthController, "login"]);
+
+export default router;

examples/index.ts

@@ -3,8 +3,8 @@
  */
 
 import { Axon, Request, Response, NextFunc, axonLogger, Middleware} from "../src";
-import { v1Routes } from "./routes/v1";
-import { v2Routes } from "./routes/v2";
+import { v1Routes } from "./routers/v1";
+import { v2Routes } from "./routers/v2";
 import { LogPluginTest } from "./plugins/log"
 
 const core = Axon()

examples/routes/v1.ts examples/routers/v1.tsexamples/routes/v1.ts renamed to examples/routers/v1.ts

@@ -1,6 +1,6 @@
 {
   "name": "@axonlabs/core",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "A backend library that aims to be simple and powerful.",
   "author": "Mr.MKZ",
   "license": "ISC",

examples/routes/v2.ts examples/routers/v2.tsexamples/routes/v2.ts renamed to examples/routers/v2.ts

@@ -4,7 +4,8 @@ import { FuncController, Middleware, RouteParams, HttpMethods, MiddlewareStorage
 import { logger } from "../core/utils/coreLogger";
 import { resolveConfig } from "../core/config/AxonConfig";
 import { AxonValidator } from "../core/validation/AxonValidator";
-import type { ValidationObj } from "../types/RouterTypes";
+import type { ClassController, ValidationObj } from "../types/RouterTypes";
+import { BaseController } from "../core/classController";
 
 const duplicateError = (path: string, method: keyof HttpMethods) => {
     throw new RouterException({
@@ -17,15 +18,15 @@ const duplicateError = (path: string, method: keyof HttpMethods) => {
     })
 }
 
-let MIDDLEWARE_TIMEOUT: number; 
+let MIDDLEWARE_TIMEOUT: number;
 
 resolveConfig(false).then(config => MIDDLEWARE_TIMEOUT = config.MIDDLEWARE_TIMEOUT || 10000);
 
 export class AxonRouteHandler<P = {}> {
-    public _controller: FuncController<P>;
+    public _controller: FuncController<P> | ClassController<any, any>;
     public _middlewares: MiddlewareStorage[];
 
-    constructor(controller: FuncController<P>) {
+    constructor(controller: FuncController<P> | ClassController<any, any>) {
         this._controller = controller;
         this._middlewares = [];
     }
@@ -41,6 +42,7 @@ export class AxonRouteHandler<P = {}> {
     }
 }
 
+
 class AxonRouter {
     private routes: HttpMethods;
     public prefix: string | undefined;
@@ -86,11 +88,20 @@ class AxonRouter {
      *      }
      * ])
      */
-    public get<Path extends string>(path: Path, controller: FuncController<RouteParams<Path>>, validation?: ValidationObj[]) {
+    public get<Path extends string, C extends BaseController, M extends keyof C>(
+            path: Path,
+            controller: (
+            FuncController<RouteParams<Path>>
+            | ClassController<C, M>),
+            validation?: ValidationObj[]
+        ) {
+
         if (this.routes.GET[path]) {
             duplicateError(path, "GET")
         }
 
+        this.validateController(controller);
+
         path = this.handleRoutePrefix(path) as Path;
 
         const handler = new AxonRouteHandler(controller);
@@ -137,11 +148,20 @@ class AxonRouter {
      *      }
      * ])
      */
-    public post<Path extends string>(path: Path, controller: FuncController<RouteParams<Path>>, validation?: ValidationObj[]) {
+    public post<Path extends string, C extends BaseController, M extends keyof C>(
+            path: Path,
+            controller: (
+            FuncController<RouteParams<Path>>
+            | ClassController<C, M>),
+            validation?: ValidationObj[]
+        ) {
+            
         if (this.routes.POST[path]) {
             duplicateError(path, "POST")
         }
 
+        this.validateController(controller);
+
         path = this.handleRoutePrefix(path) as Path;
 
         const handler = new AxonRouteHandler(controller);
@@ -183,11 +203,20 @@ class AxonRouter {
      *      }
      * ])
      */
-    public put<Path extends string>(path: Path, controller: FuncController<RouteParams<Path>>, validation?: ValidationObj[]) {
+    public put<Path extends string, C extends BaseController, M extends keyof C>(
+            path: Path,
+            controller: (
+            FuncController<RouteParams<Path>>
+            | ClassController<C, M>),
+            validation?: ValidationObj[]
+        ) {
+
         if (this.routes.PUT[path]) {
             duplicateError(path, "PUT")
         }
 
+        this.validateController(controller);
+
         path = this.handleRoutePrefix(path) as Path;
 
         const handler = new AxonRouteHandler(controller);
@@ -233,11 +262,20 @@ class AxonRouter {
      *      }
      * ])
      */
-    public patch<Path extends string>(path: Path, controller: FuncController<RouteParams<Path>>, validation?: ValidationObj[]) {
+    public patch<Path extends string, C extends BaseController, M extends keyof C>(
+            path: Path,
+            controller: (
+            FuncController<RouteParams<Path>>
+            | ClassController<C, M>),
+            validation?: ValidationObj[]
+        ) {
+
         if (this.routes.PATCH[path]) {
             duplicateError(path, "PATCH")
         }
 
+        this.validateController(controller);
+
         path = this.handleRoutePrefix(path) as Path;
 
         const handler = new AxonRouteHandler(controller);
@@ -280,11 +318,20 @@ class AxonRouter {
      *      }
      * ])
      */
-    public delete<Path extends string>(path: Path, controller: FuncController<RouteParams<Path>>, validation?: ValidationObj[]) {
+    public delete<Path extends string, C extends BaseController, M extends keyof C>(
+            path: Path,
+            controller: (
+            FuncController<RouteParams<Path>>
+            | ClassController<C, M>),
+            validation?: ValidationObj[]
+        ) {
+
         if (this.routes.DELETE[path]) {
             duplicateError(path, "DELETE")
         }
 
+        this.validateController(controller);
+
         path = this.handleRoutePrefix(path) as Path;
 
         const handler = new AxonRouteHandler(controller);
@@ -316,11 +363,20 @@ class AxonRouter {
      *  res.send("Hello World");
      * });
      */
-    public options<Path extends string>(path: Path, controller: FuncController<RouteParams<Path>>, validation?: ValidationObj[]) {
+    public options<Path extends string, C extends BaseController, M extends keyof C>(
+            path: Path,
+            controller: (
+            FuncController<RouteParams<Path>>
+            | ClassController<C, M>),
+            validation?: ValidationObj[]
+        ) {
+
         if (this.routes.OPTIONS[path]) {
             duplicateError(path, "OPTIONS")
         }
 
+        this.validateController(controller);
+
         path = this.handleRoutePrefix(path) as Path;
 
         const handler = new AxonRouteHandler(controller);
@@ -363,16 +419,16 @@ class AxonRouter {
         let i = 0;
         while (i < path.length) {
             if (path[i] === '{') {
-                
+
                 const endBrace = path.indexOf('}', i);
                 if (endBrace === -1) {
                     throw new Error("Unclosed parameter brace in route: " + path);
                 }
-                
+
                 const paramName = path.slice(i + 1, endBrace);
                 paramNames.push(paramName);
                 i = endBrace + 1;
-                
+
                 if (i < path.length && path[i] === '(') {
                     const endParen = path.indexOf(')', i);
                     if (endParen === -1) {
@@ -382,11 +438,11 @@ class AxonRouter {
                     regexString += `(${customRegex})`;
                     i = endParen + 1;
                 } else {
-                    
+
                     regexString += '([^/]+)';
                 }
             } else {
-                
+
                 const nextBrace = path.indexOf('{', i);
                 const literal = nextBrace === -1 ? path.slice(i) : path.slice(i, nextBrace);
                 regexString += this.escapeRegExp(literal);
@@ -398,7 +454,7 @@ class AxonRouter {
     }
 
     private escapeRegExp(text: string): string {
-        
+
         return text.replace(/([.+*?=^!:${}()[\]|\/\\])/g, '\\$1');
     }
 
@@ -425,6 +481,22 @@ class AxonRouter {
             handler.middleware(AxonValidator.validate(validator.schema, validator.options, validator.target), undefined, true);
         }
     }
+
+    /**
+     * Check controller type and if it was class controller, it must be extends from BaseController.
+     * @param controller 
+     */
+    private validateController(controller: FuncController<any> | ClassController<any, any>) {
+        if (Array.isArray(controller)) {
+            const [ControllerClass, method] = controller;
+
+            if (!(ControllerClass?.prototype instanceof BaseController)) {
+                throw new Error(`Controller class must extends from BaseController`, {
+                    cause: ControllerClass
+                });
+            }
+        }
+    }
 }
 
 export default AxonRouter;