@athenna/http 1.2.5 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "description": "The Athenna Http server. Built on top of fastify",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -160,7 +160,7 @@
   "dependencies": {
     "@athenna/config": "1.0.8",
     "@athenna/ioc": "1.1.3",
-    "@athenna/logger": "1.1.7",
+    "@athenna/logger": "1.1.8",
     "@secjs/utils": "1.8.3",
     "fastify": "3.27.4",
     "fastify-cors": "6.0.3",

package/src/Contracts/Context/Error/ErrorContextContract.d.ts

@@ -11,8 +11,8 @@ import { ResponseContract } from '../ResponseContract';
 export interface ErrorContextContract {
     request: RequestContract;
     response: ResponseContract;
-    params: Record<string, string>;
-    queries: Record<string, string>;
-    data?: Record<string, any>;
+    params: any;
+    queries: any;
+    data: any;
     error: any;
 }

package/src/Contracts/Context/Middlewares/Intercept/InterceptContextContract.d.ts

@@ -7,11 +7,13 @@
  * file that was distributed with this source code.
  */
 import { RequestContract } from '../../RequestContract';
+import { ResponseContract } from '../../ResponseContract';
 export interface InterceptContextContract {
     request: RequestContract;
+    response: ResponseContract;
     params: any;
     queries: any;
     body: any;
     status: number;
-    data: Record<string, any>;
+    data: any;
 }

package/src/Contracts/Context/Middlewares/Terminate/TerminateContextContract.d.ts

@@ -12,7 +12,7 @@ import { ResponseContract } from '../../ResponseContract';
 export interface TerminateContextContract {
     request: RequestContract;
     response: ResponseContract;
-    data?: any;
+    data: any;
     params: any;
     queries: any;
     body: any;

package/src/Handlers/FastifyHandler.d.ts

@@ -14,11 +14,11 @@ import { InterceptHandlerContract } from '../Contracts/Context/Middlewares/Inter
 import { TerminateHandlerContract } from '../Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';
 declare module 'fastify' {
     interface FastifyRequest {
-        data: Record<string, any>;
+        data: any;
     }
 }
 export declare class FastifyHandler {
-    static createOnSendHandler(handler: InterceptHandlerContract): (req: FastifyRequest, _res: any, payload: any) => Promise<any>;
+    static createOnSendHandler(handler: InterceptHandlerContract): (req: FastifyRequest, res: FastifyReply, payload: any) => Promise<any>;
     static createDoneHandler(handler: HandleHandlerContract): (req: FastifyRequest, res: FastifyReply, done: any) => any;
     static createResponseHandler(handler: TerminateHandlerContract): (req: FastifyRequest, res: FastifyReply, done: any) => any;
     static createErrorHandler(handler: ErrorHandlerContract): (error: any, req: FastifyRequest, res: FastifyReply) => any;

package/src/Handlers/FastifyHandler.js

@@ -15,8 +15,9 @@ const Request_1 = require("../Context/Request");
 const Response_1 = require("../Context/Response");
 class FastifyHandler {
     static createOnSendHandler(handler) {
-        return async (req, _res, payload) => {
+        return async (req, res, payload) => {
             const request = new Request_1.Request(req);
+            const response = new Response_1.Response(res);
             if (!req.data)
                 req.data = {};
             if (!req.query)
@@ -29,8 +30,9 @@ class FastifyHandler {
             }
             body = await handler({
                 request,
+                response,
                 body,
-                status: _res.statusCode,
+                status: res.statusCode,
                 params: req.params,
                 queries: req.query,
                 data: req.data,

package/src/Kernels/HttpKernel.d.ts

@@ -16,17 +16,33 @@ export declare abstract class HttpKernel {
      */
     protected abstract namedMiddlewares: Record<string, Promise<any> | MiddlewareContractClass>;
     /**
-     * Returns an instance of any class that extends HttpKernel.
-     * Also configure the error handler, detect environment and
-     * configure log intercept middleware for requests.
+     * Register all global and named middlewares to the server.
      *
-     * @return HttpKernel
+     * @return void
      */
-    constructor();
+    registerMiddlewares(): Promise<void>;
     /**
-     * Register all global and named middlewares to the server.
+     * Register cors plugin
      *
      * @return void
      */
-    registerMiddlewares(): Promise<void>;
+    registerCors(): Promise<void>;
+    /**
+     * Register rate limit plugin
+     *
+     * @return void
+     */
+    registerRateLimit(): Promise<void>;
+    /**
+     * Register the default error handler
+     *
+     * @return void
+     */
+    registerErrorHandler(): Promise<void>;
+    /**
+     * Register log terminate middleware
+     *
+     * @return void
+     */
+    registerLogMiddleware(): Promise<void>;
 }

package/src/Kernels/HttpKernel.js

@@ -3,43 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpKernel = void 0;
 const logger_1 = require("@athenna/logger");
 const config_1 = require("@athenna/config");
+const Server_1 = require("../Facades/Server");
 const utils_1 = require("@secjs/utils");
 const HttpErrorHandler_1 = require("../Handlers/HttpErrorHandler");
 class HttpKernel {
-    /**
-     * Returns an instance of any class that extends HttpKernel.
-     * Also configure the error handler, detect environment and
-     * configure log intercept middleware for requests.
-     *
-     * @return HttpKernel
-     */
-    constructor() {
-        const httpServer = ioc.safeUse('Athenna/Core/HttpServer');
-        httpServer.setErrorHandler(HttpErrorHandler_1.HttpErrorHandler.handler);
-        if (config_1.Config.get('http.log')) {
-            httpServer.use(async (ctx) => {
-                await logger_1.Log.channel('request').log(ctx);
-                return ctx.next();
-            }, 'terminate');
-        }
-    }
     /**
      * Register all global and named middlewares to the server.
      *
      * @return void
      */
     async registerMiddlewares() {
-        const httpServer = ioc.safeUse('Athenna/Core/HttpServer');
         /**
          * Binding the named middlewares inside the container and
          * creating a simple alias to use it inside Route.
          */
         for (const key of Object.keys(this.namedMiddlewares)) {
             const Middleware = utils_1.resolveModule(await this.namedMiddlewares[key]);
-            if (!ioc.hasDependency(`App/Middlewares/${Middleware.name}`)) {
-                ioc.bind(`App/Middlewares/${Middleware.name}`, Middleware);
+            if (!ioc.hasDependency(`App/Http/Middlewares/${Middleware.name}`)) {
+                ioc.bind(`App/Http/Middlewares/${Middleware.name}`, Middleware);
             }
-            ioc.alias(`App/Middlewares/Names/${key}`, `App/Middlewares/${Middleware.name}`);
+            ioc.alias(`App/Http/Middlewares/Names/${key}`, `App/Http/Middlewares/${Middleware.name}`);
         }
         /**
          * Binding the global middlewares inside the container and
@@ -47,20 +30,67 @@ class HttpKernel {
          */
         for (const module of this.globalMiddlewares) {
             let Middleware = utils_1.resolveModule(await module);
-            if (!ioc.hasDependency(`App/Middlewares/${Middleware.name}`)) {
-                ioc.bind(`App/Middlewares/${Middleware.name}`, Middleware);
+            if (!ioc.hasDependency(`App/Http/Middlewares/${Middleware.name}`)) {
+                ioc.bind(`App/Http/Middlewares/${Middleware.name}`, Middleware);
             }
-            Middleware = ioc.safeUse(`App/Middlewares/${Middleware.name}`);
+            Middleware = ioc.safeUse(`App/Http/Middlewares/${Middleware.name}`);
             if (Middleware.handle) {
-                httpServer.use(Middleware.handle, 'handle');
+                Server_1.Server.use(Middleware.handle, 'handle');
             }
             if (Middleware.intercept) {
-                httpServer.use(Middleware.intercept, 'intercept');
+                Server_1.Server.use(Middleware.intercept, 'intercept');
             }
             if (Middleware.terminate) {
-                httpServer.use(Middleware.terminate, 'terminate');
+                Server_1.Server.use(Middleware.terminate, 'terminate');
             }
         }
     }
+    /**
+     * Register cors plugin
+     *
+     * @return void
+     */
+    async registerCors() {
+        if (config_1.Config.get('http.noCors')) {
+            return;
+        }
+        Server_1.Server.registerCors(config_1.Config.get('http.cors'));
+    }
+    /**
+     * Register rate limit plugin
+     *
+     * @return void
+     */
+    async registerRateLimit() {
+        if (config_1.Config.get('http.noRateLimit')) {
+            return;
+        }
+        Server_1.Server.registerRateLimit(config_1.Config.get('http.rateLimit'));
+    }
+    /**
+     * Register the default error handler
+     *
+     * @return void
+     */
+    async registerErrorHandler() {
+        if (config_1.Config.get('http.noErrorHandler')) {
+            return;
+        }
+        Server_1.Server.setErrorHandler(HttpErrorHandler_1.HttpErrorHandler.handler);
+    }
+    /**
+     * Register log terminate middleware
+     *
+     * @return void
+     */
+    async registerLogMiddleware() {
+        if (!config_1.Config.get('http.logRequests')) {
+            return;
+        }
+        Server_1.Server.use(async (ctx) => {
+            await logger_1.Log.channel('request').log(ctx);
+            return ctx.next();
+        }, 'terminate');
+    }
 }
 exports.HttpKernel = HttpKernel;

package/src/Providers/ControllerProvider.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { ServiceProvider } from '@athenna/ioc';
+export declare class ControllerProvider extends ServiceProvider {
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    boot(): Promise<void>;
+}

package/src/Providers/ControllerProvider.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ControllerProvider = void 0;
+const ioc_1 = require("@athenna/ioc");
+const utils_1 = require("@secjs/utils");
+const getAppFiles_1 = require("../Utils/getAppFiles");
+class ControllerProvider extends ioc_1.ServiceProvider {
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    async boot() {
+        let controllers = getAppFiles_1.getAppFiles(utils_1.Path.app('Http/Controllers'));
+        controllers = await Promise.all(controllers.map(File => Promise.resolve().then(() => __importStar(require(File.path)))));
+        controllers.forEach(Module => {
+            const Controller = utils_1.resolveModule(Module);
+            this.container.bind(`App/Http/Controllers/${Controller.name}`, Controller);
+        });
+    }
+}
+exports.ControllerProvider = ControllerProvider;

package/src/Providers/MiddlewareProvider.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { ServiceProvider } from '@athenna/ioc';
+export declare class MiddlewareProvider extends ServiceProvider {
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    boot(): Promise<void>;
+}

package/src/Providers/MiddlewareProvider.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiddlewareProvider = void 0;
+const ioc_1 = require("@athenna/ioc");
+const utils_1 = require("@secjs/utils");
+const getAppFiles_1 = require("../Utils/getAppFiles");
+class MiddlewareProvider extends ioc_1.ServiceProvider {
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    async boot() {
+        let middlewares = getAppFiles_1.getAppFiles(utils_1.Path.app('Http/Middlewares'));
+        middlewares = await Promise.all(middlewares.map(File => Promise.resolve().then(() => __importStar(require(File.path)))));
+        middlewares.forEach(Module => {
+            const Controller = utils_1.resolveModule(Module);
+            this.container.bind(`App/Http/Middlewares/${Controller.name}`, Controller);
+        });
+    }
+}
+exports.MiddlewareProvider = MiddlewareProvider;

package/src/Router/Route.js

@@ -47,8 +47,8 @@ class Route {
         };
         const insertionType = prepend ? 'unshift' : 'push';
         if (utils_1.Is.String(middleware)) {
-            const mid = ioc.use(`App/Middlewares/Names/${middleware}`) ||
-                ioc.safeUse(`App/Middlewares/${middleware}`);
+            const mid = ioc.use(`App/Http/Middlewares/Names/${middleware}`) ||
+                ioc.safeUse(`App/Http/Middlewares/${middleware}`);
             if (!mid) {
                 throw new MiddlewareNotFoundException_1.MiddlewareNotFoundException(middleware);
             }
@@ -90,7 +90,7 @@ class Route {
         };
         if (utils_1.Is.String(this.handler)) {
             const [controller, method] = this.handler.split('.');
-            const dependency = ioc.safeUse(`App/Controllers/${controller}`);
+            const dependency = ioc.safeUse(`App/Http/Controllers/${controller}`);
             if (!dependency[method]) {
                 throw new UndefinedControllerMethodException_1.UndefinedControllerMethodException(method, controller);
             }

package/src/Router/RouteGroup.d.ts

@@ -16,9 +16,9 @@ import { TerminateHandlerContract } from '../Contracts/Context/Middlewares/Termi
 export declare class RouteGroup {
     routes: (Route | RouteResource | RouteGroup)[];
     constructor(routes: (Route | RouteResource | RouteGroup)[]);
-    private invoke;
     prefix(prefix: string): this;
     as(name: string): this;
     namespace(namespace: string): this;
     middleware(middleware: HandlerContract | MiddlewareContract | InterceptHandlerContract | TerminateHandlerContract | string, type?: MiddlewareTypes, prepend?: boolean): this;
+    private invoke;
 }

package/src/Router/RouteGroup.js

@@ -15,20 +15,6 @@ class RouteGroup {
     constructor(routes) {
         this.routes = routes;
     }
-    invoke(route, method, params) {
-        if (route instanceof RouteResource_1.RouteResource) {
-            route.routes.forEach(child => this.invoke(child, method, params));
-            return;
-        }
-        if (route instanceof RouteGroup) {
-            route.routes.forEach(child => this.invoke(child, method, params));
-            return;
-        }
-        if (method === 'as' && !route.name) {
-            throw new CannotDefineGroupException_1.CannotDefineGroupException();
-        }
-        route[method](...params);
-    }
     prefix(prefix) {
         this.routes.forEach(route => this.invoke(route, 'prefix', [prefix]));
         return this;
@@ -47,5 +33,19 @@ class RouteGroup {
         });
         return this;
     }
+    invoke(route, method, params) {
+        if (route instanceof RouteResource_1.RouteResource) {
+            route.routes.forEach(child => this.invoke(child, method, params));
+            return;
+        }
+        if (route instanceof RouteGroup) {
+            route.routes.forEach(child => this.invoke(child, method, params));
+            return;
+        }
+        if (method === 'as' && !route.name) {
+            throw new CannotDefineGroupException_1.CannotDefineGroupException();
+        }
+        route[method](...params);
+    }
 }
 exports.RouteGroup = RouteGroup;

package/src/Router/RouteResource.d.ts

@@ -8,10 +8,10 @@
  */
 import { Route } from './Route';
 import { MiddlewareTypes } from '../Contracts/MiddlewareTypes';
+import { MiddlewareContract } from '../Contracts/MiddlewareContract';
 import { HandlerContract } from '../Contracts/Context/HandlerContract';
 import { InterceptHandlerContract } from '../Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
 import { TerminateHandlerContract } from '../Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';
-import { MiddlewareContract } from '../Contracts/MiddlewareContract';
 export declare class RouteResource {
     routes: Route[];
     private resource;

package/src/Utils/getAppFiles.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { File } from '@secjs/utils';
+export declare function getAppFiles(path: string): File[];

package/src/Utils/getAppFiles.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppFiles = void 0;
+const fs_1 = require("fs");
+const utils_1 = require("@secjs/utils");
+function getAppFiles(path) {
+    if (!fs_1.existsSync(path))
+        return [];
+    return (new utils_1.Folder(path)
+        .loadSync()
+        // Get all .js and .ts files but not the .d.ts.
+        .getFilesByPattern('!(*.d)*.*(js|ts)'));
+}
+exports.getAppFiles = getAppFiles;