@athenna/http 4.22.0 → 4.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.22.0",
+  "version": "4.23.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -72,17 +72,18 @@
     "#tests": "./tests/index.js"
   },
   "devDependencies": {
-    "@athenna/artisan": "^4.35.0",
+    "@athenna/artisan": "^4.37.0",
     "@athenna/common": "^4.34.0",
     "@athenna/config": "^4.16.0",
     "@athenna/ioc": "^4.16.0",
     "@athenna/logger": "^4.17.0",
     "@athenna/test": "^4.22.0",
     "@athenna/tsconfig": "^4.12.0",
-    "@athenna/view": "^4.14.0",
+    "@athenna/view": "^4.18.0",
     "@fastify/cors": "^8.4.2",
     "@fastify/helmet": "^11.1.1",
     "@fastify/rate-limit": "^8.1.1",
+    "@fastify/static": "^7.0.1",
     "@fastify/swagger": "^8.12.2",
     "@fastify/swagger-ui": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^6.7.4",

package/src/context/Response.d.ts

@@ -7,13 +7,19 @@
  * file that was distributed with this source code.
  */
 import type { FastifyReply } from 'fastify';
+import type { SendOptions } from '@fastify/static';
+import type { Request } from '#src/context/Request';
 import type { FastifyHelmetOptions } from '@fastify/helmet';
 export declare class Response {
     /**
      * The fastify response object.
      */
     response: FastifyReply;
-    constructor(response: FastifyReply);
+    /**
+     * The request object from request context.
+     */
+    request: Request;
+    constructor(response: FastifyReply, request?: Request);
     /**
      * Verify if the response has been already sent.
      */
@@ -34,10 +40,20 @@ export declare class Response {
      * Get the time in MS of how much the request has taken to response.
      */
     get responseTime(): number;
+    /**
+     * Terminated the request sending a view to be rendered.
+     */
+    view(view: string, data?: any): Promise<Response>;
     /**
      * Terminate the request sending the response body or not.
      */
     send(data?: any): Promise<Response>;
+    sendFile(filename: string, filepath?: string): Promise<Response>;
+    sendFile(filename: string, options?: string | SendOptions): Promise<Response>;
+    sendFile(filename: string, filepath?: string, options?: SendOptions): Promise<Response>;
+    download(filepath: string, filename?: string): Promise<Response>;
+    download(filepath: string, options?: string | SendOptions): Promise<Response>;
+    download(filename: string, filepath?: string, options?: SendOptions): Promise<Response>;
     /**
      * Set the response status code.
      */
@@ -51,7 +67,7 @@ export declare class Response {
      */
     hasHeader(header: string): boolean;
     /**
-     * Add some header safelly to the response. This means that the header is not
+     * Add some header safely to the response. This means that the header is not
      * going to be added if is already set.
      */
     safeHeader(header: string, value: any): Response;

package/src/context/Response.js

@@ -6,9 +6,11 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import { View } from '@athenna/view';
 export class Response {
-    constructor(response) {
+    constructor(response, request) {
         this.response = response;
+        this.request = request;
     }
     /**
      * Verify if the response has been already sent.
@@ -38,7 +40,16 @@ export class Response {
      * Get the time in MS of how much the request has taken to response.
      */
     get responseTime() {
-        return this.response.getResponseTime();
+        return this.response.elapsedTime;
+    }
+    /**
+     * Terminated the request sending a view to be rendered.
+     */
+    async view(view, data) {
+        const content = await View.render(view, { ...data, request: this.request });
+        await this.safeHeader('Content-Type', 'text/html; charset=utf-8').response.send(content);
+        this.response.body = content;
+        return this;
     }
     /**
      * Terminate the request sending the response body or not.
@@ -48,6 +59,17 @@ export class Response {
         this.response.body = data;
         return this;
     }
+    /**
+     * Terminated the request sending a file.
+     */
+    async sendFile(filename, filepath, options) {
+        await this.response.sendFile(filename, filepath, options);
+        return this;
+    }
+    async download(filepath, filename, options) {
+        await this.response.download(filename, filepath, options);
+        return this;
+    }
     /**
      * Set the response status code.
      */
@@ -69,7 +91,7 @@ export class Response {
         return this.response.hasHeader(header);
     }
     /**
-     * Add some header safelly to the response. This means that the header is not
+     * Add some header safely to the response. This means that the header is not
      * going to be added if is already set.
      */
     safeHeader(header, value) {

package/src/handlers/FastifyHandler.d.ts

@@ -6,9 +6,9 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import type { InterceptHandler, TerminateHandler } from '#src/types';
 import type { RequestHandler } from '#src/types/contexts/Context';
 import type { ErrorHandler } from '#src/types/contexts/ErrorContext';
+import type { InterceptHandler, TerminateHandler } from '#src/types';
 import type { FastifyReply, FastifyRequest, RouteHandlerMethod } from 'fastify';
 export declare class FastifyHandler {
     /**

package/src/handlers/FastifyHandler.js

@@ -17,10 +17,10 @@ export class FastifyHandler {
     static request(handler) {
         return async (req, res) => {
             const request = new Request(req);
-            const response = new Response(res);
             if (!req.data) {
                 req.data = {};
             }
+            const response = new Response(res, request);
             await handler({
                 request,
                 response,
@@ -44,7 +44,10 @@ export class FastifyHandler {
     static intercept(handler) {
         return async (req, res, payload) => {
             const request = new Request(req);
-            const response = new Response(res);
+            if (!req.data) {
+                req.data = {};
+            }
+            const response = new Response(res, request);
             if (Is.Json(payload)) {
                 payload = JSON.parse(payload);
             }
@@ -72,7 +75,10 @@ export class FastifyHandler {
     static terminate(handler) {
         return async (req, res) => {
             const request = new Request(req);
-            const response = new Response(res);
+            if (!req.data) {
+                req.data = {};
+            }
+            const response = new Response(res, request);
             await handler({
                 request,
                 response,
@@ -82,7 +88,7 @@ export class FastifyHandler {
                 body: res.body || req.body,
                 headers: res.getHeaders(),
                 status: res.statusCode,
-                responseTime: res.getResponseTime()
+                responseTime: res.elapsedTime
             });
         };
     }
@@ -92,7 +98,10 @@ export class FastifyHandler {
     static error(handler) {
         return async (error, req, res) => {
             const request = new Request(req);
-            const response = new Response(res);
+            if (!req.data) {
+                req.data = {};
+            }
+            const response = new Response(res, request);
             await handler({
                 request,
                 response,

package/src/kernels/HttpKernel.d.ts

@@ -24,6 +24,10 @@ export declare class HttpKernel {
      * Register the @fastify/rate-limit plugin in the Http server.
      */
     registerRateLimit(): Promise<void>;
+    /**
+     * Register the @fastify/static plugin in the Http server.
+     */
+    registerStatic(): Promise<void>;
     /**
      * Register the cls-rtracer plugin in the Http server.
      */

package/src/kernels/HttpKernel.js

@@ -20,6 +20,7 @@ const helmetPlugin = await Module.safeImport('@fastify/helmet');
 const swaggerPlugin = await Module.safeImport('@fastify/swagger');
 const swaggerUiPlugin = await Module.safeImport('@fastify/swagger-ui');
 const rateLimitPlugin = await Module.safeImport('@fastify/rate-limit');
+const staticPlugin = await Module.safeImport('@fastify/static');
 const rTracerPlugin = await Module.safeImport('cls-rtracer');
 export class HttpKernel {
     /**
@@ -90,6 +91,20 @@ export class HttpKernel {
         }
         await Server.plugin(rateLimitPlugin, this.getConfig('http.rateLimit'));
     }
+    /**
+     * Register the @fastify/static plugin in the Http server.
+     */
+    async registerStatic() {
+        if (Config.is('http.static.enabled', false)) {
+            debug('Not able to register static plugin. Set the http.static.enabled configuration as true.');
+            return;
+        }
+        if (!staticPlugin) {
+            debug('Not able to register static plugin. Install @fastify/static package.');
+            return;
+        }
+        await Server.plugin(staticPlugin, this.getConfig('http.static'));
+    }
     /**
      * Register the cls-rtracer plugin in the Http server.
      */