@athenna/http 1.2.3 → 1.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "1.2.3",
+  "version": "1.2.6",
   "description": "The Athenna Http server. Built on top of fastify",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -159,10 +159,12 @@
   },
   "dependencies": {
     "@athenna/config": "1.0.8",
-    "@athenna/ioc": "1.1.2",
-    "@athenna/logger": "1.1.6",
+    "@athenna/ioc": "1.1.3",
+    "@athenna/logger": "1.1.7",
     "@secjs/utils": "1.8.3",
     "fastify": "3.27.4",
+    "fastify-cors": "6.0.3",
+    "fastify-rate-limit": "5.8.0",
     "reflect-metadata": "0.1.13",
     "tscpaths": "0.0.9"
   }

package/src/Facades/Route.js

@@ -9,5 +9,5 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Route = void 0;
-const Handler_1 = require("../Utils/Handler");
-exports.Route = new Proxy({}, new Handler_1.Handler('Athenna/Core/HttpRoute'));
+const ioc_1 = require("@athenna/ioc");
+exports.Route = ioc_1.Facade.createFor('Athenna/Core/HttpRoute');

package/src/Facades/Server.js

@@ -9,5 +9,5 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Server = void 0;
-const Handler_1 = require("../Utils/Handler");
-exports.Server = new Proxy({}, new Handler_1.Handler('Athenna/Core/HttpServer'));
+const ioc_1 = require("@athenna/ioc");
+exports.Server = ioc_1.Facade.createFor('Athenna/Core/HttpServer');

package/src/Handlers/HttpErrorHandler.js

@@ -34,7 +34,7 @@ class HttpErrorHandler {
             delete body.stack;
         }
         if (isDebugMode) {
-            new logger_1.Logger().error(`Error: ${JSON.stringify(body, null, 2)}`, {
+            logger_1.Log.error(`Error: ${JSON.stringify(body, null, 2)}`, {
                 formatterConfig: {
                     context: HttpErrorHandler.name,
                 },

package/src/Http.d.ts

@@ -7,7 +7,9 @@
  * file that was distributed with this source code.
  */
 import LightMyRequest from 'light-my-request';
-import { FastifyInstance, InjectOptions, PrintRoutesOptions } from 'fastify';
+import { FastifyCorsOptions } from 'fastify-cors';
+import { RateLimitPluginOptions } from 'fastify-rate-limit';
+import { FastifyInstance, FastifyPluginCallback, FastifyPluginOptions, FastifyRegisterOptions, InjectOptions, PrintRoutesOptions } from 'fastify';
 import { HttpMethodTypes } from './Contracts/HttpMethodTypes';
 import { HandlerContract } from './Contracts/Context/HandlerContract';
 import { MiddlewareTypesContract } from './Contracts/MiddlewareTypesContract';
@@ -34,6 +36,20 @@ export declare class Http {
      * @return Http
      */
     setErrorHandler(handler: ErrorHandlerContract): void;
+    /**
+     * Register a new fastify plugin.
+     *
+     * @return FastifyInstance
+     */
+    register(plugin: FastifyPluginCallback<FastifyPluginOptions>, opts?: FastifyRegisterOptions<FastifyPluginOptions>): void;
+    /**
+     * Register the cors plugin to fastify server.
+     */
+    registerCors(opts?: FastifyCorsOptions): void;
+    /**
+     * Register the rateLimit plugin to fastify server.
+     */
+    registerRateLimit(opts?: RateLimitPluginOptions): void;
     /**
      * Get the fastify server instance.
      *

package/src/Http.js

@@ -12,6 +12,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Http = void 0;
+const fastify_cors_1 = __importDefault(require("fastify-cors"));
+const fastify_rate_limit_1 = __importDefault(require("fastify-rate-limit"));
 const fastify_1 = __importDefault(require("fastify"));
 const FastifyHandler_1 = require("./Handlers/FastifyHandler");
 class Http {
@@ -32,6 +34,26 @@ class Http {
         const fastifyErrorHandler = FastifyHandler_1.FastifyHandler.createErrorHandler(handler);
         this.server.setErrorHandler(fastifyErrorHandler);
     }
+    /**
+     * Register a new fastify plugin.
+     *
+     * @return FastifyInstance
+     */
+    register(plugin, opts) {
+        this.server.register(plugin, opts);
+    }
+    /**
+     * Register the cors plugin to fastify server.
+     */
+    registerCors(opts) {
+        this.register(fastify_cors_1.default, opts);
+    }
+    /**
+     * Register the rateLimit plugin to fastify server.
+     */
+    registerRateLimit(opts) {
+        this.register(fastify_rate_limit_1.default, opts);
+    }
     /**
      * Get the fastify server instance.
      *

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

@@ -1,35 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpKernel = void 0;
-const config_1 = require("@athenna/config");
 const logger_1 = require("@athenna/logger");
+const config_1 = require("@athenna/config");
 const utils_1 = require("@secjs/utils");
 const HttpErrorHandler_1 = require("../Handlers/HttpErrorHandler");
+const Server_1 = require("../Facades/Server");
 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 new logger_1.Logger().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.
@@ -52,15 +35,62 @@ class HttpKernel {
             }
             Middleware = ioc.safeUse(`App/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/Router/Router.d.ts

@@ -24,6 +24,7 @@ export declare class Router {
     route(url: string, methods: HttpMethodTypes[], handler: HandlerContract | string): Route;
     group(callback: () => void): RouteGroup;
     resource(resource: string, controller: any): RouteResource;
+    redirect(url: string, redirectTo: string, status?: number): Route;
     get(url: string, handler: HandlerContract | string): Route;
     head(url: string, handler: HandlerContract | string): Route;
     post(url: string, handler: HandlerContract | string): Route;

package/src/Router/Router.js

@@ -68,6 +68,9 @@ class Router {
         }
         return resourceInstance;
     }
+    redirect(url, redirectTo, status = 302) {
+        return this.any(url, ({ response }) => response.redirectTo(redirectTo, status));
+    }
     get(url, handler) {
         return this.route(url, ['GET', 'HEAD'], handler);
     }

package/src/Utils/Handler.d.ts

@@ -1,13 +0,0 @@
-/**
- * @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.
- */
-export declare class Handler {
-    private readonly alias;
-    constructor(alias: any);
-    get(_object: any, key: string): any;
-}

package/src/Utils/Handler.js

@@ -1,24 +0,0 @@
-"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.Handler = void 0;
-class Handler {
-    constructor(alias) {
-        this.alias = alias;
-    }
-    get(_object, key) {
-        const provider = ioc.use(this.alias);
-        if (!provider) {
-            return () => { };
-        }
-        return provider[key];
-    }
-}
-exports.Handler = Handler;