@athenna/http 5.26.0 → 5.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "5.26.0",
+  "version": "5.28.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -85,6 +85,7 @@
     "@athenna/vite": "^5.13.0",
     "@fastify/cors": "^10.0.2",
     "@fastify/helmet": "^13.0.1",
+    "@fastify/multipart": "^9.0.3",
     "@fastify/rate-limit": "^10.2.2",
     "@fastify/static": "^8.0.4",
     "@fastify/swagger": "^9.4.2",

package/src/context/Request.d.ts

@@ -6,8 +6,10 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import type { SavedMultipartFile, FastifyMultipartBaseOptions } from '@fastify/multipart';
 import type { FastifyRequest } from 'fastify';
 import { Macroable } from '@athenna/common';
+import type { BusboyConfig } from '@fastify/busboy';
 export declare class Request extends Macroable {
     /**
      * The fastify request object.
@@ -245,6 +247,41 @@ export declare class Request extends Macroable {
      * ```
      */
     except(keys: string[]): any;
+    /**
+     * Check if the request is multipart.
+     */
+    isMultipart(): boolean;
+    /**
+     * Get the form data from the request.
+     */
+    formData(): Promise<FormData>;
+    /**
+     * Get the parts from the request.
+     */
+    parts(options?: Omit<BusboyConfig, 'headers'>): AsyncIterableIterator<import("@fastify/multipart").Multipart>;
+    /**
+     * Get the file from the request.
+     */
+    file(options?: Omit<BusboyConfig, 'headers'> | FastifyMultipartBaseOptions): Promise<import("@fastify/multipart").MultipartFile>;
+    /**
+     * Get the files from the request.
+     */
+    files(options?: Omit<BusboyConfig, 'headers'> | FastifyMultipartBaseOptions): AsyncIterableIterator<import("@fastify/multipart").MultipartFile>;
+    /**
+     * Save the files from the request.
+     */
+    saveRequestFiles(options?: Omit<BusboyConfig, 'headers'> & {
+        tmpdir?: string;
+    }): Promise<SavedMultipartFile[]>;
+    /**
+     * Clean the files from the request.
+     */
+    cleanRequestFiles(): Promise<void>;
+    /**
+     * This will get populated as soon as a call to `saveRequestFiles` gets resolved.
+     * Avoiding any future duplicate work
+     */
+    get savedRequestFiles(): SavedMultipartFile[] | null;
     /**
      * Get the original fastify request.
      */

package/src/context/Request.js

@@ -309,6 +309,55 @@ export class Request extends Macroable {
         });
         return body;
     }
+    /**
+     * Check if the request is multipart.
+     */
+    isMultipart() {
+        return this.request.isMultipart();
+    }
+    /**
+     * Get the form data from the request.
+     */
+    formData() {
+        return this.request.formData();
+    }
+    /**
+     * Get the parts from the request.
+     */
+    parts(options) {
+        return this.request.parts(options);
+    }
+    /**
+     * Get the file from the request.
+     */
+    file(options) {
+        return this.request.file(options);
+    }
+    /**
+     * Get the files from the request.
+     */
+    files(options) {
+        return this.request.files(options);
+    }
+    /**
+     * Save the files from the request.
+     */
+    saveRequestFiles(options) {
+        return this.request.saveRequestFiles(options);
+    }
+    /**
+     * Clean the files from the request.
+     */
+    cleanRequestFiles() {
+        return this.request.cleanRequestFiles();
+    }
+    /**
+     * This will get populated as soon as a call to `saveRequestFiles` gets resolved.
+     * Avoiding any future duplicate work
+     */
+    get savedRequestFiles() {
+        return this.request.savedRequestFiles;
+    }
     /**
      * Get the original fastify request.
      */

package/src/kernels/HttpKernel.d.ts

@@ -36,6 +36,10 @@ export declare class HttpKernel {
      * Register the @athenna/vite plugin in the Http server.
      */
     registerVite(trace?: boolean): Promise<void>;
+    /**
+     * Register the @fastify/multipart plugin in the Http server.
+     */
+    registerMultipart(): Promise<void>;
     /**
      * Register the global log terminator in the Http server.
      */

package/src/kernels/HttpKernel.js

@@ -15,19 +15,12 @@ import { sep, isAbsolute, resolve } from 'node:path';
 import { Annotation } from '@athenna/ioc';
 import { File, Path, Module, String } from '@athenna/common';
 import { HttpExceptionHandler } from '#src/handlers/HttpExceptionHandler';
-const corsPlugin = await Module.safeImport('@fastify/cors');
-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');
-const vitePlugin = await Module.safeImport('@athenna/vite/plugins/fastify');
 export class HttpKernel {
     /**
      * Register the @fastify/cors plugin in the Http server.
      */
     async registerCors() {
+        const corsPlugin = await Module.safeImport('@fastify/cors');
         if (Config.is('http.cors.enabled', false)) {
             debug('Not able to register cors plugin. Set the http.cors.enabled configuration as true.');
             return;
@@ -42,6 +35,7 @@ export class HttpKernel {
      * Register the @fastify/helmet plugin in the Http server.
      */
     async registerHelmet() {
+        const helmetPlugin = await Module.safeImport('@fastify/helmet');
         if (Config.is('http.helmet.enabled', false)) {
             debug('Not able to register helmet plugin. Set the http.helmet.enabled configuration as true.');
             return;
@@ -56,6 +50,8 @@ export class HttpKernel {
      * Register the @fastify/swagger plugin in the Http server.
      */
     async registerSwagger() {
+        const swaggerPlugin = await Module.safeImport('@fastify/swagger');
+        const swaggerUiPlugin = await Module.safeImport('@fastify/swagger-ui');
         if (Config.is('http.swagger.enabled', false)) {
             debug('Not able to register swagger plugin. Set the http.swagger.enabled configuration as true.');
             return;
@@ -86,6 +82,7 @@ export class HttpKernel {
      * Register the @fastify/rate-limit plugin in the Http server.
      */
     async registerRateLimit() {
+        const rateLimitPlugin = await Module.safeImport('@fastify/rate-limit');
         if (Config.is('http.rateLimit.enabled', false)) {
             debug('Not able to register rate limit plugin. Set the http.rateLimit.enabled configuration as true.');
             return;
@@ -100,6 +97,7 @@ export class HttpKernel {
      * Register the @fastify/static plugin in the Http server.
      */
     async registerStatic() {
+        const staticPlugin = await Module.safeImport('@fastify/static');
         if (Config.is('http.static.enabled', false)) {
             debug('Not able to register static plugin. Set the http.static.enabled configuration as true.');
             return;
@@ -114,6 +112,7 @@ export class HttpKernel {
      * Register the cls-rtracer plugin in the Http server.
      */
     async registerRTracer(trace) {
+        const rTracerPlugin = await Module.safeImport('cls-rtracer');
         if (trace === false) {
             debug('Not able to register rTracer plugin. Set the trace option as true in your http server options.');
             return;
@@ -133,6 +132,7 @@ export class HttpKernel {
      * Register the @athenna/vite plugin in the Http server.
      */
     async registerVite(trace) {
+        const vitePlugin = await Module.safeImport('@athenna/vite/plugins/fastify');
         if (trace === false) {
             debug('Not able to register vite plugin. Set the trace option as true in your http server options.');
             return;
@@ -147,6 +147,21 @@ export class HttpKernel {
         }
         await Server.plugin(vitePlugin, this.getConfig('http.vite'));
     }
+    /**
+     * Register the @fastify/multipart plugin in the Http server.
+     */
+    async registerMultipart() {
+        const multipartPlugin = await Module.safeImport('@fastify/multipart');
+        if (Config.is('http.multipart.enabled', false)) {
+            debug('Not able to register multipart plugin. Set the http.multipart.enabled configuration as true.');
+            return;
+        }
+        if (!multipartPlugin) {
+            debug('Not able to register multipart plugin. Install @fastify/multipart package.');
+            return;
+        }
+        await Server.plugin(multipartPlugin, this.getConfig('http.multipart'));
+    }
     /**
      * Register the global log terminator in the Http server.
      */

package/src/testing/plugins/request/TestRequest.js

@@ -39,10 +39,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async get(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'GET',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }
@@ -57,10 +60,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async head(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'HEAD',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }
@@ -75,10 +81,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async options(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'OPTIONS',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }
@@ -93,10 +102,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async post(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'POST',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }
@@ -111,10 +123,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async put(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'PUT',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }
@@ -129,10 +144,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async patch(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'PATCH',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }
@@ -147,10 +165,13 @@ export class TestRequest extends Macroable {
      * ```
      */
     async delete(url, options = {}) {
+        options.headers = {
+            ...this.headers,
+            ...options.headers
+        };
         return Server.request({
             url,
             method: 'DELETE',
-            ...this.headers,
             ...options
         }).then(res => this.createResponse(res));
     }