node-server-engine 1.2.9 → 1.3.0

package/.env.example

@@ -167,4 +167,7 @@ SMTP_PORT=587
 SMTP_USER=your-email@example.com
 
 # SMTP authentication password (your email password or app password)
-SMTP_PASS=your-email-password
+SMTP_PASS=your-email-password
+
+
+FILE_STORAGE_FOLDER=./uploads

package/README.md

@@ -2,7 +2,7 @@
 
 Framework used to develop Node backend services. This package ships with a lot of features to standardize the creation of services, letting you focus on the business logic.
 
-- [Node Server Engine](#Node-server-engine)
+- [Node Server Engine](#node-server-engine)
   - [Install](#install)
   - [Entities](#entities)
     - [Server](#server)
@@ -12,6 +12,18 @@ Framework used to develop Node backend services. This package ships with a lot o
       - [Methods](#methods)
       - [Authentication](#authentication)
       - [File Upload Middleware](#file-upload-middleware)
+        - [Usage](#usage)
+        - [Example](#example)
+        - [Middleware Output](#middleware-output)
+        - [Features](#features)
+      - [Multipart File Upload Middleware](#multipart-file-upload-middleware)
+        - [Usage](#usage-1)
+        - [Configuration Options](#configuration-options)
+        - [Expected Request Format](#expected-request-format)
+        - [Middleware Output](#middleware-output-1)
+        - [When all chunks are not yet received, req.multipartFile has the below JSON:](#when-all-chunks-are-not-yet-received-reqmultipartfile-has-the-below-json)
+        - [When the upload is complete, req.multipartFile has the below JSON:](#when-the-upload-is-complete-reqmultipartfile-has-the-below-json)
+        - [Example](#example-1)
     - [Socket Client](#socket-client)
       - [Socket Client Options](#socket-client-options)
       - [Properties](#properties)
@@ -35,15 +47,22 @@ Framework used to develop Node backend services. This package ships with a lot o
       - [Schemas and Responses](#schemas-and-responses)
     - [User Resolver](#user-resolver)
     - [Gemini File Upload](#gemini-file-upload)
-    - [Multipart File Uploader](#multipart-file-uploader)
-    - [checkPermission](#check-permission-middleware)
+    - [Check Permission Middleware](#check-permission-middleware)
   - [Utilities](#utilities)
     - [Request](#request)
     - [TLS Request](#tls-request)
     - [TLS Config](#tls-config)
     - [Send Push Notification](#send-push-notification)
     - [Send Email](#send-email)
-    - [Gemini File Upload](#gemini-file-upload)
+    - [Parameters](#parameters)
+    - [Return Status](#return-status)
+    - [Gemini File Upload](#gemini-file-upload-1)
+    - [Parameters](#parameters-1)
+    - [Response](#response)
+      - [**Success Response**](#success-response)
+      - [**Failure Response**](#failure-response)
+    - [Return Fields](#return-fields)
+    - [Error Handling](#error-handling)
     - [Filter](#filter)
     - [Database Migration](#database-migration)
     - [Environment Variables Verification](#environment-variables-verification)
@@ -203,11 +222,11 @@ The server engine exposes an enumeration for auth types.
 
 <!-- markdownlint-enable MD033 -->
 
-### File Upload Middleware
+#### File Upload Middleware
 
 This middleware handles multipart file uploads in an Express application. It processes files in memory, validates them based on configuration options, and ensures that required files are uploaded.
 
-## Usage
+##### Usage
 
 The request must be made using `multipart/form-data`. The uploaded files will be available in `req.files`.
 
@@ -221,7 +240,7 @@ The following settings can be used on each object the Endpoint's `options.files`
 | required    | boolean        | Will fail the request and not store the files if this one is missing | false        |
 | noExtension | boolean        | Store the file with no extension                                     | false        |
 
-## Example
+##### Example
 
 ```typescript
 import { body } from 'express-validator';
@@ -243,7 +262,30 @@ new Endpoint({
 });
 ```
 
-## Features
+##### Middleware Output
+
+The middleware adds a `files` object to the `req` object, which contains information about the uploaded file.
+
+```json
+ [
+    {
+      "fieldname": "avatar",
+      "originalname": "profile.png",
+      "mimetype": "image/png",
+      "size": 204800,
+      "buffer":[]
+    },
+    {
+      "fieldname": "document",
+      "originalname": "resume.pdf",
+      "mimetype": "application/pdf",
+      "size": 512000,
+      "buffer":[]
+    }
+  ]
+```
+
+##### Features
 
 - Supports multiple file uploads.
 - Validates file types and sizes.
@@ -254,6 +296,82 @@ This middleware simplifies file handling in Express, making it easy to manage up
 
 ---
 
+#### Multipart File Upload Middleware
+
+This middleware enables chunked file uploads in an Express application. It allows uploading large files by splitting them into smaller chunks, validating them, and merging them once all parts are received.
+
+##### Usage
+
+The request must be made using `multipart/form-data`. The uploaded chunks are processed in memory before being stored in temporary directories. Once all chunks are uploaded, they are merged into a single file.
+
+##### Configuration Options
+
+The following settings can be used when configuring file uploads:
+
+| Property | Type    | Description                                         | Default  |
+| -------- | ------- | --------------------------------------------------- | -------- |
+| maxSize  | string  | Maximum allowed size for each chunk (e.g., `"5MB"`) | No limit |
+| required | boolean | Whether the file is mandatory for the request       | `false`  |
+
+##### Expected Request Format
+
+The client must send the following fields in the `multipart/form-data` request:
+
+| Field         | Type   | Description                              |
+| ------------- | ------ | ---------------------------------------- |
+| `file`        | File   | The chunked file data                    |
+| `filename`    | String | Name of the original file                |
+| `uniqueID`    | String | Unique identifier for the upload session |
+| `chunkIndex`  | Number | Current chunk number (0-based index)     |
+| `totalChunks` | Number | Total number of chunks for the file      |
+
+##### Middleware Output
+
+The middleware adds a `multipartFile` object to the `req` object, which contains information about the uploaded file.
+
+##### When all chunks are not yet received, req.multipartFile has the below JSON:
+
+```json
+{
+  "isPending": true,
+  "originalname": "example.pdf",
+  "uniqueID": "abc123",
+  "chunkIndex": 2,
+  "totalChunks": 5
+}
+```
+
+##### When the upload is complete, req.multipartFile has the below JSON:
+
+```json
+{
+  "isPending": false,
+  "originalname": "example.pdf",
+  "uniqueID": "abc123",
+  "filePath": "/uploads/completed_files/abc123_example.pdf"
+}
+```
+
+##### Example
+
+```typescript
+import { body } from 'express-validator';
+import { Endpoint, middleware, AuthType, Method } from 'node-server-engine';
+
+const fileConfig = { maxSize: '10MB', required: true };
+
+new Endpoint({
+  path: '/upload',
+  method: Method.POST,
+  authType: AuthType.JWT,
+  multipartFile: fileConfig,
+  handler: (req, res) => {
+    console.log(req.multipartFile);
+  }
+});
+```
+---
+
 ### Socket Client
 
 The socket server start if the [Server](#server)'s webSocket option is not undefined.
@@ -704,7 +822,7 @@ new Endpoint({
 
 ---
 
-#### Gemini File Upload
+### Gemini File Upload
 
 An endpoint can upload a file to a google gemini AI
 
@@ -716,104 +834,7 @@ The file's data will be available at `req.body.fileUri req.body.mimeType  req.bo
 
 ---
 
-#### Multipart File Uploader
-
-This middleware handles multipart file uploads by accepting file chunks, storing them temporarily, and merging them once all chunks are uploaded.
-
-## Usage
-
-The request must be made using `multipart/form-data`.
-The file should be uploaded under the key `file`.
-
-Once the upload is complete, the following data will be available in `req.body.uploadDetails`:
-
-- **status**: `"pending"` (if chunk upload is in progress) or `"completed"` (if file is fully uploaded and merged).
-- **message**: Status message.
-- **details**:
-  - `filename`: Original filename.
-  - `uniqueID`: Unique identifier for the upload session.
-  - `chunkIndex`: The current chunk index (if upload is still in progress).
-  - `totalChunks`: Total number of chunks for the file (if upload is still in progress).
-
-## Request Format
-
-### **Endpoint:**
-
-```http
-POST /upload
-```
-
-### **Headers:**
-
-```http
-Content-Type: multipart/form-data
-```
-
-### **Form Data:**
-
-| Key           | Type   | Description                                       |
-| ------------- | ------ | ------------------------------------------------- |
-| `file`        | File   | The chunk of the file being uploaded              |
-| `filename`    | String | The original filename                             |
-| `uniqueID`    | String | A unique identifier for the file upload session   |
-| `totalChunks` | Number | The total number of chunks the file is split into |
-| `chunkIndex`  | Number | The index of the current chunk being uploaded     |
-
-## Response Format
-
-### **If chunk upload is successful but not completed:**
-
-```json
-{
-  "status": "pending",
-  "message": "Chunk uploaded successfully",
-  "details": {
-    "filename": "example.pdf",
-    "uniqueID": "123456",
-    "chunkIndex": 2,
-    "totalChunks": 5
-  }
-}
-```
-
-### **If all chunks are uploaded and merged successfully:**
-
-```json
-{
-  "status": "completed",
-  "message": "File uploaded and merged successfully",
-  "details": {
-    "filename": "example.pdf",
-    "uniqueID": "123456"
-  }
-}
-```
-
-## Error Handling
-
-If an error occurs (e.g., missing fields, failed write operations), the middleware will return an error response with details.
-
-Example:
-
-```json
-{
-  "status": "failed",
-  "message": "Missing required fields",
-  "details": {
-    "filename": null,
-    "totalChunks": null,
-    "chunkIndex": null,
-    "uniqueID": null,
-    "receivedChunk": false
-  }
-}
-```
-
-This middleware ensures smooth handling of large file uploads by splitting them into smaller chunks and merging them once all chunks are received. 🚀
-
----
-
-#### Check Permission Middleware
+### Check Permission Middleware
 
 /!\ **Must be used in combination with AuthType.JWT**
 

package/dist/entities/Endpoint/Endpoint.d.ts

@@ -18,6 +18,8 @@ export declare class Endpoint<T extends EndpointAuthType> {
     private authParams?;
     /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */
     private files?;
+    /** Settings to upload file parts (Chunks) through this endpoint (this will automatically switch the expected request to be a multipart) */
+    private multiPartFile?;
     /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */
     private middleware?;
     /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */

package/dist/entities/Endpoint/Endpoint.js

@@ -36,6 +36,8 @@ let Endpoint = exports.Endpoint = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "authParams", void 0);
     /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */
     (0, _defineProperty2.default)(this, "files", void 0);
+    /** Settings to upload file parts (Chunks) through this endpoint (this will automatically switch the expected request to be a multipart) */
+    (0, _defineProperty2.default)(this, "multiPartFile", void 0);
     /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */
     (0, _defineProperty2.default)(this, "middleware", void 0);
     /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */
@@ -48,7 +50,9 @@ let Endpoint = exports.Endpoint = /*#__PURE__*/function () {
         path: config.path,
         authType: config.authType,
         authParams: config.authParams,
-        file: config.file
+        file: config.file,
+        files: config.files,
+        multiPartFile: config.multiPartFile
       }
     });
     if (typeof config.path !== 'string') throw new _EngineError.EngineError({
@@ -92,10 +96,15 @@ let Endpoint = exports.Endpoint = /*#__PURE__*/function () {
         // Register file upload
         // Validation is included in the file upload process as this uses multipart/form-data
         middlewareChain.push((0, _middleware.fileUploader)(this.files, this.validator));
-      } else {
+      }
+      if (this.multiPartFile) {
+        middlewareChain.push((0, _middleware.multiPartFileUploader)(this.multiPartFile, this.validator));
+      }
+      if (!this.files && !this.multiPartFile) {
         // Register validator for regular cases
         middlewareChain.push((0, _middleware.validate)(this.validator));
       }
+
       // Register additional middleware
       if (this.middleware) {
         middlewareChain.push(...this.middleware);

package/dist/entities/Endpoint/Endpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"Endpoint.js","names":["_EngineError","require","_Endpoint2","_const","_middleware","_report","namespace","Endpoint","exports","config","_classCallCheck2","default","_defineProperty2","reportDebug","message","method","path","data","authType","authParams","file","EngineError","EndpointMethods","includes","handler","EndpointAuthTypes","validator","files","middleware","Array","errorMiddleware","_createClass2","key","value","register","app","middlewareChain","requestMetrics","push","getAuthMiddleware","fileUploader","validate","safeMiddlewareChain","catchExceptionForExpress","flat","map","req","res","next","err","catch","error","reportError","type","EndpointAuthHandlers","reportInfo","severity","LogSeverity","WARNING","request","response","acceptInvalid"],"sources":["../../../src/entities/Endpoint/Endpoint.ts"],"sourcesContent":["import {\n  RequestHandler,\n  ErrorRequestHandler,\n  Application,\n  Request,\n  Response,\n  NextFunction\n} from 'express';\nimport { Schema } from 'express-validator';\nimport { EngineError } from '../EngineError';\nimport {\n  EndpointOptions,\n  EndpointAuthType,\n  EndpointAuthTypes,\n  EndpointMethod,\n  EndpointMethods,\n  EndpointAuthParams,\n  Middleware,\n  MiddlewareChainElement,\n  SafeMiddleWareChain,\n  EndpointAuthHandlers,\n  EndpointAuthHandler,\n  EndpointRequestType,\n  EndpointHandler\n} from './Endpoint.types';\nimport { LogSeverity } from 'const';\nimport { validate, fileUploader, requestMetrics } from 'middleware';\nimport { FileUploaderConfig } from 'middleware/fileUploader';\nimport { reportDebug, reportError, reportInfo } from 'utils/report';\n\nconst namespace = 'engine:Endpoint';\n\n/**\n * Object representing a REST endpoint served by server\n */\nexport class Endpoint<T extends EndpointAuthType> {\n  /** Path at which the endpoint is reachable */\n  public readonly path: string;\n  /** HTTP method of the endpoint */\n  public readonly method: EndpointMethod;\n  /** Authentication system required by this endpoint */\n  public readonly authType: T;\n  /** Function handling the endpoint's business logic */\n  private handler: EndpointHandler<T>;\n  /** Validation schema that the request must pass before reaching the handler */\n  private validator: Schema;\n  /** Authentication related options for this endpoint */\n  private authParams?: EndpointAuthParams<T>;\n  /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */\n  private files?: Array<FileUploaderConfig>;\n  /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */\n  private middleware?: Array<Middleware<T>>;\n  /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */\n  private errorMiddleware?: Array<ErrorRequestHandler>;\n\n  /** Create a REST endpoint */\n  public constructor(config: EndpointOptions<T>) {\n    reportDebug({\n      namespace,\n      message: `Creating Endpoint [${config.method} - ${config.path}]`,\n      data: {\n        method: config.method,\n        path: config.path,\n        authType: config.authType,\n        authParams: config.authParams,\n        file: config.file\n      }\n    });\n\n    if (typeof config.path !== 'string')\n      throw new EngineError({\n        message: 'Endpoint path was not declared as a string'\n      });\n    this.path = config.path;\n\n    if (!EndpointMethods.includes(config.method))\n      throw new EngineError({\n        message: 'Endpoint method is not a valid HTTP method'\n      });\n    this.method = config.method;\n\n    if (typeof config.handler !== 'function')\n      throw new EngineError({ message: 'Endpoint handler is not a function' });\n    this.handler = config.handler;\n\n    if (!EndpointAuthTypes.includes(config.authType))\n      throw new EngineError({ message: 'Endpoint auth type is not valid' });\n    this.authType = config.authType;\n\n    this.validator = config.validator;\n    this.authParams = config.authParams;\n    this.files = config.file ? [config.file] : config.files;\n\n    // Middleware can both be function or arrays\n    if (typeof config.middleware === 'function')\n      this.middleware = [config.middleware];\n    if (config.middleware instanceof Array) this.middleware = config.middleware;\n    if (typeof config.errorMiddleware === 'function')\n      this.errorMiddleware = [config.errorMiddleware];\n    if (config.errorMiddleware instanceof Array)\n      this.errorMiddleware = config.errorMiddleware;\n  }\n\n  /**\n   * Register the endpoint to a react app\n   */\n  public register(app: Application): void {\n    // First initialize the handling calculation\n    const middlewareChain: Array<MiddlewareChainElement<T>> = [requestMetrics];\n    // Register auth middleware\n    middlewareChain.push(...this.getAuthMiddleware(this.authType));\n    if (this.files) {\n      // Register file upload\n      // Validation is included in the file upload process as this uses multipart/form-data\n      middlewareChain.push(fileUploader(this.files, this.validator));\n    } else {\n      // Register validator for regular cases\n      middlewareChain.push(validate(this.validator));\n    }\n    // Register additional middleware\n    if (this.middleware) {\n      middlewareChain.push(...this.middleware);\n    }\n    // Register handler\n    middlewareChain.push(this.handler);\n    // Wrap middleware to await any async execution and catch any errors thrown\n    const safeMiddlewareChain: SafeMiddleWareChain =\n      this.catchExceptionForExpress(middlewareChain);\n    // Register error middleware\n    if (this.errorMiddleware) {\n      safeMiddlewareChain.push(...this.errorMiddleware);\n    }\n    app[this.method](\n      this.path,\n      ...(safeMiddlewareChain.flat() as Array<\n        RequestHandler | ErrorRequestHandler\n      >)\n    );\n  }\n\n  /**\n   * Catch exceptions thrown inside of middleware and pass them properly to express\n   */\n  private catchExceptionForExpress(\n    middlewareChain: Array<MiddlewareChainElement<T>>\n  ): SafeMiddleWareChain {\n    return middlewareChain.map((middleware) => {\n      if (middleware instanceof Array) {\n        return this.catchExceptionForExpress(middleware);\n      }\n      if (typeof middleware === 'function') {\n        return (req: Request, res: Response, next: NextFunction) => {\n          (async (): Promise<void> => {\n            try {\n              await middleware(req as EndpointRequestType[T], res, next);\n            } catch (err) {\n              next(err);\n            }\n          })().catch((error) => {\n            reportError(error);\n          });\n        };\n      }\n      throw new EngineError({\n        message: 'Middleware is not a function nor an array',\n        data: { type: typeof middleware }\n      });\n    });\n  }\n\n  /**\n   * Get the authentication middleware for a given type of authentication\n   */\n  private getAuthMiddleware(authType: EndpointAuthType): Array<RequestHandler> {\n    const middlewareChain: Array<RequestHandler> = [];\n\n    const handler = EndpointAuthHandlers[authType] as EndpointAuthHandler<T>;\n    if (!handler) {\n      reportInfo({\n        severity: LogSeverity.WARNING,\n        message: `Endpoint \"${this.method} - ${this.path}\" was declared with no authentication method`\n      });\n      return [];\n    }\n\n    const middleware = handler(this.authParams);\n\n    middlewareChain.push(\n      async (request: Request, response: Response, next: NextFunction) => {\n        try {\n          await middleware(request, response, next);\n        } catch (error) {\n          if (!this.authParams?.acceptInvalid) throw error;\n          reportError(error);\n          next();\n        }\n      }\n    );\n\n    return middlewareChain;\n  }\n}\n"],"mappings":";;;;;;;;;;AASA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAeA,IAAAE,MAAA,GAAAF,OAAA;AACA,IAAAG,WAAA,GAAAH,OAAA;AAEA,IAAAI,OAAA,GAAAJ,OAAA;AAEA,MAAMK,SAAS,GAAG,iBAAiB;;AAEnC;AACA;AACA;AAFA,IAGaC,QAAQ,GAAAC,OAAA,CAAAD,QAAA;EAoBnB;EACA,SAAAA,SAAmBE,MAA0B,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAJ,QAAA;IApB/C;IAAA,IAAAK,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAKE,IAAAE,mBAAW,EAAC;MACVP,SAAS;MACTQ,OAAO,EAAE,sBAAsBL,MAAM,CAACM,MAAM,MAAMN,MAAM,CAACO,IAAI,GAAG;MAChEC,IAAI,EAAE;QACJF,MAAM,EAAEN,MAAM,CAACM,MAAM;QACrBC,IAAI,EAAEP,MAAM,CAACO,IAAI;QACjBE,QAAQ,EAAET,MAAM,CAACS,QAAQ;QACzBC,UAAU,EAAEV,MAAM,CAACU,UAAU;QAC7BC,IAAI,EAAEX,MAAM,CAACW;MACf;IACF,CAAC,CAAC;IAEF,IAAI,OAAOX,MAAM,CAACO,IAAI,KAAK,QAAQ,EACjC,MAAM,IAAIK,wBAAW,CAAC;MACpBP,OAAO,EAAE;IACX,CAAC,CAAC;IACJ,IAAI,CAACE,IAAI,GAAGP,MAAM,CAACO,IAAI;IAEvB,IAAI,CAACM,0BAAe,CAACC,QAAQ,CAACd,MAAM,CAACM,MAAM,CAAC,EAC1C,MAAM,IAAIM,wBAAW,CAAC;MACpBP,OAAO,EAAE;IACX,CAAC,CAAC;IACJ,IAAI,CAACC,MAAM,GAAGN,MAAM,CAACM,MAAM;IAE3B,IAAI,OAAON,MAAM,CAACe,OAAO,KAAK,UAAU,EACtC,MAAM,IAAIH,wBAAW,CAAC;MAAEP,OAAO,EAAE;IAAqC,CAAC,CAAC;IAC1E,IAAI,CAACU,OAAO,GAAGf,MAAM,CAACe,OAAO;IAE7B,IAAI,CAACC,4BAAiB,CAACF,QAAQ,CAACd,MAAM,CAACS,QAAQ,CAAC,EAC9C,MAAM,IAAIG,wBAAW,CAAC;MAAEP,OAAO,EAAE;IAAkC,CAAC,CAAC;IACvE,IAAI,CAACI,QAAQ,GAAGT,MAAM,CAACS,QAAQ;IAE/B,IAAI,CAACQ,SAAS,GAAGjB,MAAM,CAACiB,SAAS;IACjC,IAAI,CAACP,UAAU,GAAGV,MAAM,CAACU,UAAU;IACnC,IAAI,CAACQ,KAAK,GAAGlB,MAAM,CAACW,IAAI,GAAG,CAACX,MAAM,CAACW,IAAI,CAAC,GAAGX,MAAM,CAACkB,KAAK;;IAEvD;IACA,IAAI,OAAOlB,MAAM,CAACmB,UAAU,KAAK,UAAU,EACzC,IAAI,CAACA,UAAU,GAAG,CAACnB,MAAM,CAACmB,UAAU,CAAC;IACvC,IAAInB,MAAM,CAACmB,UAAU,YAAYC,KAAK,EAAE,IAAI,CAACD,UAAU,GAAGnB,MAAM,CAACmB,UAAU;IAC3E,IAAI,OAAOnB,MAAM,CAACqB,eAAe,KAAK,UAAU,EAC9C,IAAI,CAACA,eAAe,GAAG,CAACrB,MAAM,CAACqB,eAAe,CAAC;IACjD,IAAIrB,MAAM,CAACqB,eAAe,YAAYD,KAAK,EACzC,IAAI,CAACC,eAAe,GAAGrB,MAAM,CAACqB,eAAe;EACjD;;EAEA;AACF;AACA;EAFE,WAAAC,aAAA,CAAApB,OAAA,EAAAJ,QAAA;IAAAyB,GAAA;IAAAC,KAAA,EAGA,SAAOC,QAAQA,CAACC,GAAgB,EAAQ;MACtC;MACA,MAAMC,eAAiD,GAAG,CAACC,0BAAc,CAAC;MAC1E;MACAD,eAAe,CAACE,IAAI,CAAC,GAAG,IAAI,CAACC,iBAAiB,CAAC,IAAI,CAACrB,QAAQ,CAAC,CAAC;MAC9D,IAAI,IAAI,CAACS,KAAK,EAAE;QACd;QACA;QACAS,eAAe,CAACE,IAAI,CAAC,IAAAE,wBAAY,EAAC,IAAI,CAACb,KAAK,EAAE,IAAI,CAACD,SAAS,CAAC,CAAC;MAChE,CAAC,MAAM;QACL;QACAU,eAAe,CAACE,IAAI,CAAC,IAAAG,oBAAQ,EAAC,IAAI,CAACf,SAAS,CAAC,CAAC;MAChD;MACA;MACA,IAAI,IAAI,CAACE,UAAU,EAAE;QACnBQ,eAAe,CAACE,IAAI,CAAC,GAAG,IAAI,CAACV,UAAU,CAAC;MAC1C;MACA;MACAQ,eAAe,CAACE,IAAI,CAAC,IAAI,CAACd,OAAO,CAAC;MAClC;MACA,MAAMkB,mBAAwC,GAC5C,IAAI,CAACC,wBAAwB,CAACP,eAAe,CAAC;MAChD;MACA,IAAI,IAAI,CAACN,eAAe,EAAE;QACxBY,mBAAmB,CAACJ,IAAI,CAAC,GAAG,IAAI,CAACR,eAAe,CAAC;MACnD;MACAK,GAAG,CAAC,IAAI,CAACpB,MAAM,CAAC,CACd,IAAI,CAACC,IAAI,EACT,GAAI0B,mBAAmB,CAACE,IAAI,CAAC,CAG/B,CAAC;IACH;;IAEA;AACF;AACA;EAFE;IAAAZ,GAAA;IAAAC,KAAA,EAGA,SAAQU,wBAAwBA,CAC9BP,eAAiD,EAC5B;MACrB,OAAOA,eAAe,CAACS,GAAG,CAAEjB,UAAU,IAAK;QACzC,IAAIA,UAAU,YAAYC,KAAK,EAAE;UAC/B,OAAO,IAAI,CAACc,wBAAwB,CAACf,UAAU,CAAC;QAClD;QACA,IAAI,OAAOA,UAAU,KAAK,UAAU,EAAE;UACpC,OAAO,CAACkB,GAAY,EAAEC,GAAa,EAAEC,IAAkB,KAAK;YAC1D,CAAC,YAA2B;cAC1B,IAAI;gBACF,MAAMpB,UAAU,CAACkB,GAAG,EAA4BC,GAAG,EAAEC,IAAI,CAAC;cAC5D,CAAC,CAAC,OAAOC,GAAG,EAAE;gBACZD,IAAI,CAACC,GAAG,CAAC;cACX;YACF,CAAC,EAAE,CAAC,CAACC,KAAK,CAAEC,KAAK,IAAK;cACpB,IAAAC,mBAAW,EAACD,KAAK,CAAC;YACpB,CAAC,CAAC;UACJ,CAAC;QACH;QACA,MAAM,IAAI9B,wBAAW,CAAC;UACpBP,OAAO,EAAE,2CAA2C;UACpDG,IAAI,EAAE;YAAEoC,IAAI,EAAE,OAAOzB;UAAW;QAClC,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;EAFE;IAAAI,GAAA;IAAAC,KAAA,EAGA,SAAQM,iBAAiBA,CAACrB,QAA0B,EAAyB;MAC3E,MAAMkB,eAAsC,GAAG,EAAE;MAEjD,MAAMZ,OAAO,GAAG8B,+BAAoB,CAACpC,QAAQ,CAA2B;MACxE,IAAI,CAACM,OAAO,EAAE;QACZ,IAAA+B,kBAAU,EAAC;UACTC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;UAC7B5C,OAAO,EAAE,aAAa,IAAI,CAACC,MAAM,MAAM,IAAI,CAACC,IAAI;QAClD,CAAC,CAAC;QACF,OAAO,EAAE;MACX;MAEA,MAAMY,UAAU,GAAGJ,OAAO,CAAC,IAAI,CAACL,UAAU,CAAC;MAE3CiB,eAAe,CAACE,IAAI,CAClB,OAAOqB,OAAgB,EAAEC,QAAkB,EAAEZ,IAAkB,KAAK;QAClE,IAAI;UACF,MAAMpB,UAAU,CAAC+B,OAAO,EAAEC,QAAQ,EAAEZ,IAAI,CAAC;QAC3C,CAAC,CAAC,OAAOG,KAAK,EAAE;UACd,IAAI,CAAC,IAAI,CAAChC,UAAU,EAAE0C,aAAa,EAAE,MAAMV,KAAK;UAChD,IAAAC,mBAAW,EAACD,KAAK,CAAC;UAClBH,IAAI,CAAC,CAAC;QACR;MACF,CACF,CAAC;MAED,OAAOZ,eAAe;IACxB;EAAC;AAAA","ignoreList":[]}
+{"version":3,"file":"Endpoint.js","names":["_EngineError","require","_Endpoint2","_const","_middleware","_report","namespace","Endpoint","exports","config","_classCallCheck2","default","_defineProperty2","reportDebug","message","method","path","data","authType","authParams","file","files","multiPartFile","EngineError","EndpointMethods","includes","handler","EndpointAuthTypes","validator","middleware","Array","errorMiddleware","_createClass2","key","value","register","app","middlewareChain","requestMetrics","push","getAuthMiddleware","fileUploader","multiPartFileUploader","validate","safeMiddlewareChain","catchExceptionForExpress","flat","map","req","res","next","err","catch","error","reportError","type","EndpointAuthHandlers","reportInfo","severity","LogSeverity","WARNING","request","response","acceptInvalid"],"sources":["../../../src/entities/Endpoint/Endpoint.ts"],"sourcesContent":["import {\n  RequestHandler,\n  ErrorRequestHandler,\n  Application,\n  Request,\n  Response,\n  NextFunction\n} from 'express';\nimport { Schema } from 'express-validator';\nimport { EngineError } from '../EngineError';\nimport {\n  EndpointOptions,\n  EndpointAuthType,\n  EndpointAuthTypes,\n  EndpointMethod,\n  EndpointMethods,\n  EndpointAuthParams,\n  Middleware,\n  MiddlewareChainElement,\n  SafeMiddleWareChain,\n  EndpointAuthHandlers,\n  EndpointAuthHandler,\n  EndpointRequestType,\n  EndpointHandler\n} from './Endpoint.types';\nimport { LogSeverity } from 'const';\nimport {\n  validate,\n  fileUploader,\n  requestMetrics,\n  multiPartFileUploader\n} from 'middleware';\nimport { FileUploaderConfig } from 'middleware/fileUploader';\nimport { MultiPartFileUploaderConfig } from 'middleware/multiPartFileUploader';\nimport { reportDebug, reportError, reportInfo } from 'utils/report';\n\nconst namespace = 'engine:Endpoint';\n\n/**\n * Object representing a REST endpoint served by server\n */\nexport class Endpoint<T extends EndpointAuthType> {\n  /** Path at which the endpoint is reachable */\n  public readonly path: string;\n  /** HTTP method of the endpoint */\n  public readonly method: EndpointMethod;\n  /** Authentication system required by this endpoint */\n  public readonly authType: T;\n  /** Function handling the endpoint's business logic */\n  private handler: EndpointHandler<T>;\n  /** Validation schema that the request must pass before reaching the handler */\n  private validator: Schema;\n  /** Authentication related options for this endpoint */\n  private authParams?: EndpointAuthParams<T>;\n  /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */\n  private files?: Array<FileUploaderConfig>;\n  /** Settings to upload file parts (Chunks) through this endpoint (this will automatically switch the expected request to be a multipart) */\n  private multiPartFile?: MultiPartFileUploaderConfig;\n  /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */\n  private middleware?: Array<Middleware<T>>;\n  /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */\n  private errorMiddleware?: Array<ErrorRequestHandler>;\n\n  /** Create a REST endpoint */\n  public constructor(config: EndpointOptions<T>) {\n    reportDebug({\n      namespace,\n      message: `Creating Endpoint [${config.method} - ${config.path}]`,\n      data: {\n        method: config.method,\n        path: config.path,\n        authType: config.authType,\n        authParams: config.authParams,\n        file: config.file,\n        files: config.files,\n        multiPartFile: config.multiPartFile\n      }\n    });\n\n    if (typeof config.path !== 'string')\n      throw new EngineError({\n        message: 'Endpoint path was not declared as a string'\n      });\n    this.path = config.path;\n\n    if (!EndpointMethods.includes(config.method))\n      throw new EngineError({\n        message: 'Endpoint method is not a valid HTTP method'\n      });\n    this.method = config.method;\n\n    if (typeof config.handler !== 'function')\n      throw new EngineError({ message: 'Endpoint handler is not a function' });\n    this.handler = config.handler;\n\n    if (!EndpointAuthTypes.includes(config.authType))\n      throw new EngineError({ message: 'Endpoint auth type is not valid' });\n    this.authType = config.authType;\n\n    this.validator = config.validator;\n    this.authParams = config.authParams;\n    this.files = config.file ? [config.file] : config.files;\n\n    // Middleware can both be function or arrays\n    if (typeof config.middleware === 'function')\n      this.middleware = [config.middleware];\n    if (config.middleware instanceof Array) this.middleware = config.middleware;\n    if (typeof config.errorMiddleware === 'function')\n      this.errorMiddleware = [config.errorMiddleware];\n    if (config.errorMiddleware instanceof Array)\n      this.errorMiddleware = config.errorMiddleware;\n  }\n\n  /**\n   * Register the endpoint to a react app\n   */\n  public register(app: Application): void {\n    // First initialize the handling calculation\n    const middlewareChain: Array<MiddlewareChainElement<T>> = [requestMetrics];\n    // Register auth middleware\n    middlewareChain.push(...this.getAuthMiddleware(this.authType));\n    if (this.files) {\n      // Register file upload\n      // Validation is included in the file upload process as this uses multipart/form-data\n      middlewareChain.push(fileUploader(this.files, this.validator));\n    }\n\n    if (this.multiPartFile) {\n      middlewareChain.push(\n        multiPartFileUploader(this.multiPartFile, this.validator)\n      );\n    }\n\n    if (!this.files && !this.multiPartFile) {\n      // Register validator for regular cases\n      middlewareChain.push(validate(this.validator));\n    }\n\n    // Register additional middleware\n    if (this.middleware) {\n      middlewareChain.push(...this.middleware);\n    }\n    // Register handler\n    middlewareChain.push(this.handler);\n    // Wrap middleware to await any async execution and catch any errors thrown\n    const safeMiddlewareChain: SafeMiddleWareChain =\n      this.catchExceptionForExpress(middlewareChain);\n    // Register error middleware\n    if (this.errorMiddleware) {\n      safeMiddlewareChain.push(...this.errorMiddleware);\n    }\n    app[this.method](\n      this.path,\n      ...(safeMiddlewareChain.flat() as Array<\n        RequestHandler | ErrorRequestHandler\n      >)\n    );\n  }\n\n  /**\n   * Catch exceptions thrown inside of middleware and pass them properly to express\n   */\n  private catchExceptionForExpress(\n    middlewareChain: Array<MiddlewareChainElement<T>>\n  ): SafeMiddleWareChain {\n    return middlewareChain.map((middleware) => {\n      if (middleware instanceof Array) {\n        return this.catchExceptionForExpress(middleware);\n      }\n      if (typeof middleware === 'function') {\n        return (req: Request, res: Response, next: NextFunction) => {\n          (async (): Promise<void> => {\n            try {\n              await middleware(req as EndpointRequestType[T], res, next);\n            } catch (err) {\n              next(err);\n            }\n          })().catch((error) => {\n            reportError(error);\n          });\n        };\n      }\n      throw new EngineError({\n        message: 'Middleware is not a function nor an array',\n        data: { type: typeof middleware }\n      });\n    });\n  }\n\n  /**\n   * Get the authentication middleware for a given type of authentication\n   */\n  private getAuthMiddleware(authType: EndpointAuthType): Array<RequestHandler> {\n    const middlewareChain: Array<RequestHandler> = [];\n\n    const handler = EndpointAuthHandlers[authType] as EndpointAuthHandler<T>;\n    if (!handler) {\n      reportInfo({\n        severity: LogSeverity.WARNING,\n        message: `Endpoint \"${this.method} - ${this.path}\" was declared with no authentication method`\n      });\n      return [];\n    }\n\n    const middleware = handler(this.authParams);\n\n    middlewareChain.push(\n      async (request: Request, response: Response, next: NextFunction) => {\n        try {\n          await middleware(request, response, next);\n        } catch (error) {\n          if (!this.authParams?.acceptInvalid) throw error;\n          reportError(error);\n          next();\n        }\n      }\n    );\n\n    return middlewareChain;\n  }\n}\n"],"mappings":";;;;;;;;;;AASA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAeA,IAAAE,MAAA,GAAAF,OAAA;AACA,IAAAG,WAAA,GAAAH,OAAA;AAQA,IAAAI,OAAA,GAAAJ,OAAA;AAEA,MAAMK,SAAS,GAAG,iBAAiB;;AAEnC;AACA;AACA;AAFA,IAGaC,QAAQ,GAAAC,OAAA,CAAAD,QAAA;EAsBnB;EACA,SAAAA,SAAmBE,MAA0B,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAJ,QAAA;IAtB/C;IAAA,IAAAK,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAEA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAKE,IAAAE,mBAAW,EAAC;MACVP,SAAS;MACTQ,OAAO,EAAE,sBAAsBL,MAAM,CAACM,MAAM,MAAMN,MAAM,CAACO,IAAI,GAAG;MAChEC,IAAI,EAAE;QACJF,MAAM,EAAEN,MAAM,CAACM,MAAM;QACrBC,IAAI,EAAEP,MAAM,CAACO,IAAI;QACjBE,QAAQ,EAAET,MAAM,CAACS,QAAQ;QACzBC,UAAU,EAAEV,MAAM,CAACU,UAAU;QAC7BC,IAAI,EAAEX,MAAM,CAACW,IAAI;QACjBC,KAAK,EAAEZ,MAAM,CAACY,KAAK;QACnBC,aAAa,EAAEb,MAAM,CAACa;MACxB;IACF,CAAC,CAAC;IAEF,IAAI,OAAOb,MAAM,CAACO,IAAI,KAAK,QAAQ,EACjC,MAAM,IAAIO,wBAAW,CAAC;MACpBT,OAAO,EAAE;IACX,CAAC,CAAC;IACJ,IAAI,CAACE,IAAI,GAAGP,MAAM,CAACO,IAAI;IAEvB,IAAI,CAACQ,0BAAe,CAACC,QAAQ,CAAChB,MAAM,CAACM,MAAM,CAAC,EAC1C,MAAM,IAAIQ,wBAAW,CAAC;MACpBT,OAAO,EAAE;IACX,CAAC,CAAC;IACJ,IAAI,CAACC,MAAM,GAAGN,MAAM,CAACM,MAAM;IAE3B,IAAI,OAAON,MAAM,CAACiB,OAAO,KAAK,UAAU,EACtC,MAAM,IAAIH,wBAAW,CAAC;MAAET,OAAO,EAAE;IAAqC,CAAC,CAAC;IAC1E,IAAI,CAACY,OAAO,GAAGjB,MAAM,CAACiB,OAAO;IAE7B,IAAI,CAACC,4BAAiB,CAACF,QAAQ,CAAChB,MAAM,CAACS,QAAQ,CAAC,EAC9C,MAAM,IAAIK,wBAAW,CAAC;MAAET,OAAO,EAAE;IAAkC,CAAC,CAAC;IACvE,IAAI,CAACI,QAAQ,GAAGT,MAAM,CAACS,QAAQ;IAE/B,IAAI,CAACU,SAAS,GAAGnB,MAAM,CAACmB,SAAS;IACjC,IAAI,CAACT,UAAU,GAAGV,MAAM,CAACU,UAAU;IACnC,IAAI,CAACE,KAAK,GAAGZ,MAAM,CAACW,IAAI,GAAG,CAACX,MAAM,CAACW,IAAI,CAAC,GAAGX,MAAM,CAACY,KAAK;;IAEvD;IACA,IAAI,OAAOZ,MAAM,CAACoB,UAAU,KAAK,UAAU,EACzC,IAAI,CAACA,UAAU,GAAG,CAACpB,MAAM,CAACoB,UAAU,CAAC;IACvC,IAAIpB,MAAM,CAACoB,UAAU,YAAYC,KAAK,EAAE,IAAI,CAACD,UAAU,GAAGpB,MAAM,CAACoB,UAAU;IAC3E,IAAI,OAAOpB,MAAM,CAACsB,eAAe,KAAK,UAAU,EAC9C,IAAI,CAACA,eAAe,GAAG,CAACtB,MAAM,CAACsB,eAAe,CAAC;IACjD,IAAItB,MAAM,CAACsB,eAAe,YAAYD,KAAK,EACzC,IAAI,CAACC,eAAe,GAAGtB,MAAM,CAACsB,eAAe;EACjD;;EAEA;AACF;AACA;EAFE,WAAAC,aAAA,CAAArB,OAAA,EAAAJ,QAAA;IAAA0B,GAAA;IAAAC,KAAA,EAGA,SAAOC,QAAQA,CAACC,GAAgB,EAAQ;MACtC;MACA,MAAMC,eAAiD,GAAG,CAACC,0BAAc,CAAC;MAC1E;MACAD,eAAe,CAACE,IAAI,CAAC,GAAG,IAAI,CAACC,iBAAiB,CAAC,IAAI,CAACtB,QAAQ,CAAC,CAAC;MAC9D,IAAI,IAAI,CAACG,KAAK,EAAE;QACd;QACA;QACAgB,eAAe,CAACE,IAAI,CAAC,IAAAE,wBAAY,EAAC,IAAI,CAACpB,KAAK,EAAE,IAAI,CAACO,SAAS,CAAC,CAAC;MAChE;MAEA,IAAI,IAAI,CAACN,aAAa,EAAE;QACtBe,eAAe,CAACE,IAAI,CAClB,IAAAG,iCAAqB,EAAC,IAAI,CAACpB,aAAa,EAAE,IAAI,CAACM,SAAS,CAC1D,CAAC;MACH;MAEA,IAAI,CAAC,IAAI,CAACP,KAAK,IAAI,CAAC,IAAI,CAACC,aAAa,EAAE;QACtC;QACAe,eAAe,CAACE,IAAI,CAAC,IAAAI,oBAAQ,EAAC,IAAI,CAACf,SAAS,CAAC,CAAC;MAChD;;MAEA;MACA,IAAI,IAAI,CAACC,UAAU,EAAE;QACnBQ,eAAe,CAACE,IAAI,CAAC,GAAG,IAAI,CAACV,UAAU,CAAC;MAC1C;MACA;MACAQ,eAAe,CAACE,IAAI,CAAC,IAAI,CAACb,OAAO,CAAC;MAClC;MACA,MAAMkB,mBAAwC,GAC5C,IAAI,CAACC,wBAAwB,CAACR,eAAe,CAAC;MAChD;MACA,IAAI,IAAI,CAACN,eAAe,EAAE;QACxBa,mBAAmB,CAACL,IAAI,CAAC,GAAG,IAAI,CAACR,eAAe,CAAC;MACnD;MACAK,GAAG,CAAC,IAAI,CAACrB,MAAM,CAAC,CACd,IAAI,CAACC,IAAI,EACT,GAAI4B,mBAAmB,CAACE,IAAI,CAAC,CAG/B,CAAC;IACH;;IAEA;AACF;AACA;EAFE;IAAAb,GAAA;IAAAC,KAAA,EAGA,SAAQW,wBAAwBA,CAC9BR,eAAiD,EAC5B;MACrB,OAAOA,eAAe,CAACU,GAAG,CAAElB,UAAU,IAAK;QACzC,IAAIA,UAAU,YAAYC,KAAK,EAAE;UAC/B,OAAO,IAAI,CAACe,wBAAwB,CAAChB,UAAU,CAAC;QAClD;QACA,IAAI,OAAOA,UAAU,KAAK,UAAU,EAAE;UACpC,OAAO,CAACmB,GAAY,EAAEC,GAAa,EAAEC,IAAkB,KAAK;YAC1D,CAAC,YAA2B;cAC1B,IAAI;gBACF,MAAMrB,UAAU,CAACmB,GAAG,EAA4BC,GAAG,EAAEC,IAAI,CAAC;cAC5D,CAAC,CAAC,OAAOC,GAAG,EAAE;gBACZD,IAAI,CAACC,GAAG,CAAC;cACX;YACF,CAAC,EAAE,CAAC,CAACC,KAAK,CAAEC,KAAK,IAAK;cACpB,IAAAC,mBAAW,EAACD,KAAK,CAAC;YACpB,CAAC,CAAC;UACJ,CAAC;QACH;QACA,MAAM,IAAI9B,wBAAW,CAAC;UACpBT,OAAO,EAAE,2CAA2C;UACpDG,IAAI,EAAE;YAAEsC,IAAI,EAAE,OAAO1B;UAAW;QAClC,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;EAFE;IAAAI,GAAA;IAAAC,KAAA,EAGA,SAAQM,iBAAiBA,CAACtB,QAA0B,EAAyB;MAC3E,MAAMmB,eAAsC,GAAG,EAAE;MAEjD,MAAMX,OAAO,GAAG8B,+BAAoB,CAACtC,QAAQ,CAA2B;MACxE,IAAI,CAACQ,OAAO,EAAE;QACZ,IAAA+B,kBAAU,EAAC;UACTC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;UAC7B9C,OAAO,EAAE,aAAa,IAAI,CAACC,MAAM,MAAM,IAAI,CAACC,IAAI;QAClD,CAAC,CAAC;QACF,OAAO,EAAE;MACX;MAEA,MAAMa,UAAU,GAAGH,OAAO,CAAC,IAAI,CAACP,UAAU,CAAC;MAE3CkB,eAAe,CAACE,IAAI,CAClB,OAAOsB,OAAgB,EAAEC,QAAkB,EAAEZ,IAAkB,KAAK;QAClE,IAAI;UACF,MAAMrB,UAAU,CAACgC,OAAO,EAAEC,QAAQ,EAAEZ,IAAI,CAAC;QAC3C,CAAC,CAAC,OAAOG,KAAK,EAAE;UACd,IAAI,CAAC,IAAI,CAAClC,UAAU,EAAE4C,aAAa,EAAE,MAAMV,KAAK;UAChD,IAAAC,mBAAW,EAACD,KAAK,CAAC;UAClBH,IAAI,CAAC,CAAC;QACR;MACF,CACF,CAAC;MAED,OAAOb,eAAe;IACxB;EAAC;AAAA","ignoreList":[]}

package/dist/entities/Endpoint/Endpoint.types.d.ts

@@ -3,6 +3,7 @@ import { ParamsDictionary } from 'express-serve-static-core';
 import { Schema } from 'express-validator';
 import { ParsedQs } from 'qs';
 import { authJwt, authHmac, authTls, authStatic, FileUploaderConfig } from '../../middleware';
+import { MultiPartFileUploaderConfig } from '../../middleware/multiPartFileUploader/multiPartFileUploader.types';
 export declare enum EndpointMethod {
     GET = "get",
     POST = "post",
@@ -84,6 +85,8 @@ export interface EndpointOptions<T extends EndpointAuthType> {
     file?: FileUploaderConfig;
     /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */
     files?: Array<FileUploaderConfig>;
+    /** Settings to upload file parts (Chunks) through this endpoint (this will automatically switch the expected request to be a multipart) */
+    multiPartFile?: MultiPartFileUploaderConfig;
     /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */
     middleware?: MiddlewareChainElement<T>;
     /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */

package/dist/entities/Endpoint/Endpoint.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"Endpoint.types.js","names":["_middleware","require","EndpointMethod","exports","EndpointMethods","Object","values","EndpointAuthType","EndpointAuthTypes","EndpointAuthHandlers","NONE","undefined","JWT","authJwt","TLS","authTls","HMAC","authHmac","STATIC","authStatic"],"sources":["../../../src/entities/Endpoint/Endpoint.types.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n  ErrorRequestHandler,\n  Request,\n  Response,\n  NextFunction,\n  RequestHandler\n} from 'express';\nimport { ParamsDictionary } from 'express-serve-static-core';\nimport { Schema } from 'express-validator';\nimport { ParsedQs } from 'qs';\n\nimport {\n  authJwt,\n  authHmac,\n  authTls,\n  authStatic,\n  FileUploaderConfig\n} from 'middleware';\n\nexport enum EndpointMethod {\n  GET = 'get',\n  POST = 'post',\n  PUT = 'put',\n  PATCH = 'patch',\n  DELETE = 'delete',\n  HEAD = 'head',\n  ALL = 'all'\n}\n\nexport const EndpointMethods = Object.values(EndpointMethod);\n\nexport enum EndpointAuthType {\n  NONE = 'none',\n  JWT = 'jwt',\n  TLS = 'tls',\n  HMAC = 'hmac',\n  STATIC = 'static'\n}\n\nexport const EndpointAuthTypes = Object.values(EndpointAuthType);\n\nexport type Middleware<T extends EndpointAuthType> = (\n  request: EndpointRequestType[T],\n  response: Response,\n  next: NextFunction\n) => unknown | Promise<unknown>;\n\nexport type MiddlewareChainElement<T extends EndpointAuthType> =\n  | Array<Middleware<T>>\n  | Middleware<T>\n  | any;\n\n/** Auth related parameters used with HMAC authentication  */\ninterface EndpointAuthHmacParams {\n  /** [HMAC] Secret used for signature */\n  secret?: string;\n  /** [HMAC] For Github webhook, the standard differs slightly, so this option must be selected */\n  isGithub?: boolean;\n}\n\n/** Auth related parameters used with mTLS authentication  */\ninterface EndpointAuthTlsParams {\n  /** [TLS] List oh hosts that are allowed to use the endpoint, this is compared to the claims in the certificate */\n  whitelist?: Array<string>;\n}\n\n/** Mapping used to get auth specific parameters depending on the auth type used  */\ninterface EndpointAuthSpecificParams {\n  /** Auth parameters for no authentication */\n  [EndpointAuthType.NONE]: any;\n  /** Auth parameters for JWT authentication */\n  [EndpointAuthType.JWT]: any;\n  /** Auth parameters for mTLS authentication */\n  [EndpointAuthType.TLS]: EndpointAuthTlsParams;\n  /** Auth parameters for HMAC authentication */\n  [EndpointAuthType.HMAC]: EndpointAuthHmacParams;\n  /** Auth parameters for static authentication */\n  [EndpointAuthType.STATIC]: any;\n}\n\nexport type EndpointAuthParams<T extends EndpointAuthType> =\n  EndpointAuthSpecificParams[T] & {\n    /** This will allow the business logic to run event if the authentication fails */\n    acceptInvalid?: boolean;\n  };\n\nexport type EndpointAuthHandler<T extends EndpointAuthType> = (\n  options?: EndpointAuthParams<T>\n) => (\n  request: Request,\n  response: Response,\n  next: NextFunction\n) => void | Promise<void>;\n\nexport const EndpointAuthHandlers = {\n  /** Auth handler for no authentication */\n  [EndpointAuthType.NONE]: undefined,\n  /** Auth handler for JWT authentication */\n  [EndpointAuthType.JWT]: authJwt,\n  /** Auth handler for mTLS authentication */\n  [EndpointAuthType.TLS]: authTls,\n  /** Auth handler for HMAC authentication */\n  [EndpointAuthType.HMAC]: authHmac,\n  /** Auth handler for static authentication */\n  [EndpointAuthType.STATIC]: authStatic\n};\n\nexport type EndpointHandler<T extends EndpointAuthType> = (\n  request: EndpointRequestType[T],\n  response: Response\n) => void | Promise<void>;\n\n/** Endpoint initialization options */\nexport interface EndpointOptions<T extends EndpointAuthType> {\n  /** Path at which the endpoint is reachable */\n  path: string;\n  /** HTTP method of the endpoint */\n  method: EndpointMethod;\n  /** Function handling the endpoint's business logic */\n  handler: EndpointHandler<T>;\n  /** Validation schema that the request must pass before reaching the handler */\n  validator: Schema;\n  /** Authentication system required by this endpoint */\n  authType: T;\n  /** Authentication related options for this endpoint */\n  authParams?: EndpointAuthParams<T>;\n  /** @deprecated Setting to upload a file through this endpoint */\n  file?: FileUploaderConfig;\n  /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */\n  files?: Array<FileUploaderConfig>;\n  /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */\n  middleware?: MiddlewareChainElement<T>;\n  /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */\n  errorMiddleware?: ErrorRequestHandler | Array<ErrorRequestHandler>;\n}\n\n/** Request type when using JWT authentication */\nexport interface JwtRequest<\n  P = ParamsDictionary,\n  ResBody = any,\n  ReqBody = any,\n  ReqQuery = ParsedQs,\n  Locals extends Record<string, any> = Record<string, any>\n> extends Request<P, ResBody, ReqBody, ReqQuery, Locals> {\n  /** User that identified using a JWT */\n  user: Record<string, any> | any;\n}\n\n/** Request type when using mTLS authentication */\nexport interface TlsRequest<\n  P = ParamsDictionary,\n  ResBody = any,\n  ReqBody = any,\n  ReqQuery = ParsedQs,\n  Locals extends Record<string, any> = Record<string, any>\n> extends Request<P, ResBody, ReqBody, ReqQuery, Locals> {\n  /** Host names provided by the mTLS authenticated client */\n  hosts: Array<string>;\n}\n\n/** Mapping of request types in endpoints based on auth type used */\nexport interface EndpointRequestType {\n  /** Request type for no authentication */\n  [EndpointAuthType.NONE]: Request;\n  /** Request type when using JWT authentication */\n  [EndpointAuthType.JWT]: JwtRequest;\n  /** Request type when using mTLS authentication */\n  [EndpointAuthType.TLS]: TlsRequest;\n  /** Request type when using HMAC authentication */\n  [EndpointAuthType.HMAC]: Request;\n  /** Auth handler for static authentication */\n  [EndpointAuthType.STATIC]: Request;\n}\n\nexport type SafeMiddleWareChain = Array<\n  RequestHandler | ErrorRequestHandler | SafeMiddleWareChain\n>;\n"],"mappings":";;;;;;AAYA,IAAAA,WAAA,GAAAC,OAAA;AAZA;AAAA,IAoBYC,cAAc,GAAAC,OAAA,CAAAD,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAUnB,MAAME,eAAe,GAAAD,OAAA,CAAAC,eAAA,GAAGC,MAAM,CAACC,MAAM,CAACJ,cAAc,CAAC;AAAC,IAEjDK,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAQrB,MAAMC,iBAAiB,GAAAL,OAAA,CAAAK,iBAAA,GAAGH,MAAM,CAACC,MAAM,CAACC,gBAAgB,CAAC;;AAahE;;AAQA;;AAMA;;AA4BO,MAAME,oBAAoB,GAAAN,OAAA,CAAAM,oBAAA,GAAG;EAClC;EACA,CAACF,gBAAgB,CAACG,IAAI,GAAGC,SAAS;EAClC;EACA,CAACJ,gBAAgB,CAACK,GAAG,GAAGC,mBAAO;EAC/B;EACA,CAACN,gBAAgB,CAACO,GAAG,GAAGC,mBAAO;EAC/B;EACA,CAACR,gBAAgB,CAACS,IAAI,GAAGC,oBAAQ;EACjC;EACA,CAACV,gBAAgB,CAACW,MAAM,GAAGC;AAC7B,CAAC;;AAOD;;AAwBA;;AAYA;;AAYA","ignoreList":[]}
+{"version":3,"file":"Endpoint.types.js","names":["_middleware","require","EndpointMethod","exports","EndpointMethods","Object","values","EndpointAuthType","EndpointAuthTypes","EndpointAuthHandlers","NONE","undefined","JWT","authJwt","TLS","authTls","HMAC","authHmac","STATIC","authStatic"],"sources":["../../../src/entities/Endpoint/Endpoint.types.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n  ErrorRequestHandler,\n  Request,\n  Response,\n  NextFunction,\n  RequestHandler\n} from 'express';\nimport { ParamsDictionary } from 'express-serve-static-core';\nimport { Schema } from 'express-validator';\nimport { ParsedQs } from 'qs';\n\nimport {\n  authJwt,\n  authHmac,\n  authTls,\n  authStatic,\n  FileUploaderConfig\n} from 'middleware';\nimport { MultiPartFileUploaderConfig } from 'middleware/multiPartFileUploader/multiPartFileUploader.types';\n\nexport enum EndpointMethod {\n  GET = 'get',\n  POST = 'post',\n  PUT = 'put',\n  PATCH = 'patch',\n  DELETE = 'delete',\n  HEAD = 'head',\n  ALL = 'all'\n}\n\nexport const EndpointMethods = Object.values(EndpointMethod);\n\nexport enum EndpointAuthType {\n  NONE = 'none',\n  JWT = 'jwt',\n  TLS = 'tls',\n  HMAC = 'hmac',\n  STATIC = 'static'\n}\n\nexport const EndpointAuthTypes = Object.values(EndpointAuthType);\n\nexport type Middleware<T extends EndpointAuthType> = (\n  request: EndpointRequestType[T],\n  response: Response,\n  next: NextFunction\n) => unknown | Promise<unknown>;\n\nexport type MiddlewareChainElement<T extends EndpointAuthType> =\n  | Array<Middleware<T>>\n  | Middleware<T>\n  | any;\n\n/** Auth related parameters used with HMAC authentication  */\ninterface EndpointAuthHmacParams {\n  /** [HMAC] Secret used for signature */\n  secret?: string;\n  /** [HMAC] For Github webhook, the standard differs slightly, so this option must be selected */\n  isGithub?: boolean;\n}\n\n/** Auth related parameters used with mTLS authentication  */\ninterface EndpointAuthTlsParams {\n  /** [TLS] List oh hosts that are allowed to use the endpoint, this is compared to the claims in the certificate */\n  whitelist?: Array<string>;\n}\n\n/** Mapping used to get auth specific parameters depending on the auth type used  */\ninterface EndpointAuthSpecificParams {\n  /** Auth parameters for no authentication */\n  [EndpointAuthType.NONE]: any;\n  /** Auth parameters for JWT authentication */\n  [EndpointAuthType.JWT]: any;\n  /** Auth parameters for mTLS authentication */\n  [EndpointAuthType.TLS]: EndpointAuthTlsParams;\n  /** Auth parameters for HMAC authentication */\n  [EndpointAuthType.HMAC]: EndpointAuthHmacParams;\n  /** Auth parameters for static authentication */\n  [EndpointAuthType.STATIC]: any;\n}\n\nexport type EndpointAuthParams<T extends EndpointAuthType> =\n  EndpointAuthSpecificParams[T] & {\n    /** This will allow the business logic to run event if the authentication fails */\n    acceptInvalid?: boolean;\n  };\n\nexport type EndpointAuthHandler<T extends EndpointAuthType> = (\n  options?: EndpointAuthParams<T>\n) => (\n  request: Request,\n  response: Response,\n  next: NextFunction\n) => void | Promise<void>;\n\nexport const EndpointAuthHandlers = {\n  /** Auth handler for no authentication */\n  [EndpointAuthType.NONE]: undefined,\n  /** Auth handler for JWT authentication */\n  [EndpointAuthType.JWT]: authJwt,\n  /** Auth handler for mTLS authentication */\n  [EndpointAuthType.TLS]: authTls,\n  /** Auth handler for HMAC authentication */\n  [EndpointAuthType.HMAC]: authHmac,\n  /** Auth handler for static authentication */\n  [EndpointAuthType.STATIC]: authStatic\n};\n\nexport type EndpointHandler<T extends EndpointAuthType> = (\n  request: EndpointRequestType[T],\n  response: Response\n) => void | Promise<void>;\n\n/** Endpoint initialization options */\nexport interface EndpointOptions<T extends EndpointAuthType> {\n  /** Path at which the endpoint is reachable */\n  path: string;\n  /** HTTP method of the endpoint */\n  method: EndpointMethod;\n  /** Function handling the endpoint's business logic */\n  handler: EndpointHandler<T>;\n  /** Validation schema that the request must pass before reaching the handler */\n  validator: Schema;\n  /** Authentication system required by this endpoint */\n  authType: T;\n  /** Authentication related options for this endpoint */\n  authParams?: EndpointAuthParams<T>;\n  /** @deprecated Setting to upload a file through this endpoint */\n  file?: FileUploaderConfig;\n  /** Settings to upload files through this endpoint (this will automatically switch the expected request to be a multipart) */\n  files?: Array<FileUploaderConfig>;\n  /** Settings to upload file parts (Chunks) through this endpoint (this will automatically switch the expected request to be a multipart) */\n  multiPartFile?: MultiPartFileUploaderConfig;\n  /** Express request handlers that should run on this endpoint before the business logic, they will run after the global middleware */\n  middleware?: MiddlewareChainElement<T>;\n  /** Express error handlers that should be registered for this endpoint. they will run before the global error handler */\n  errorMiddleware?: ErrorRequestHandler | Array<ErrorRequestHandler>;\n}\n\n/** Request type when using JWT authentication */\nexport interface JwtRequest<\n  P = ParamsDictionary,\n  ResBody = any,\n  ReqBody = any,\n  ReqQuery = ParsedQs,\n  Locals extends Record<string, any> = Record<string, any>\n> extends Request<P, ResBody, ReqBody, ReqQuery, Locals> {\n  /** User that identified using a JWT */\n  user: Record<string, any> | any;\n}\n\n/** Request type when using mTLS authentication */\nexport interface TlsRequest<\n  P = ParamsDictionary,\n  ResBody = any,\n  ReqBody = any,\n  ReqQuery = ParsedQs,\n  Locals extends Record<string, any> = Record<string, any>\n> extends Request<P, ResBody, ReqBody, ReqQuery, Locals> {\n  /** Host names provided by the mTLS authenticated client */\n  hosts: Array<string>;\n}\n\n/** Mapping of request types in endpoints based on auth type used */\nexport interface EndpointRequestType {\n  /** Request type for no authentication */\n  [EndpointAuthType.NONE]: Request;\n  /** Request type when using JWT authentication */\n  [EndpointAuthType.JWT]: JwtRequest;\n  /** Request type when using mTLS authentication */\n  [EndpointAuthType.TLS]: TlsRequest;\n  /** Request type when using HMAC authentication */\n  [EndpointAuthType.HMAC]: Request;\n  /** Auth handler for static authentication */\n  [EndpointAuthType.STATIC]: Request;\n}\n\nexport type SafeMiddleWareChain = Array<\n  RequestHandler | ErrorRequestHandler | SafeMiddleWareChain\n>;\n"],"mappings":";;;;;;AAYA,IAAAA,WAAA,GAAAC,OAAA;AAZA;AAAA,IAqBYC,cAAc,GAAAC,OAAA,CAAAD,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAUnB,MAAME,eAAe,GAAAD,OAAA,CAAAC,eAAA,GAAGC,MAAM,CAACC,MAAM,CAACJ,cAAc,CAAC;AAAC,IAEjDK,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAQrB,MAAMC,iBAAiB,GAAAL,OAAA,CAAAK,iBAAA,GAAGH,MAAM,CAACC,MAAM,CAACC,gBAAgB,CAAC;;AAahE;;AAQA;;AAMA;;AA4BO,MAAME,oBAAoB,GAAAN,OAAA,CAAAM,oBAAA,GAAG;EAClC;EACA,CAACF,gBAAgB,CAACG,IAAI,GAAGC,SAAS;EAClC;EACA,CAACJ,gBAAgB,CAACK,GAAG,GAAGC,mBAAO;EAC/B;EACA,CAACN,gBAAgB,CAACO,GAAG,GAAGC,mBAAO;EAC/B;EACA,CAACR,gBAAgB,CAACS,IAAI,GAAGC,oBAAQ;EACjC;EACA,CAACV,gBAAgB,CAACW,MAAM,GAAGC;AAC7B,CAAC;;AAOD;;AA0BA;;AAYA;;AAYA","ignoreList":[]}

package/dist/middleware/fileUploader/fileUploader.js

@@ -9,6 +9,8 @@ var _WebError = require("../../entities/WebError");
 var _report = require("../../utils/report");
 var _multer = _interopRequireDefault(require("multer"));
 var _validate = require("./validate");
+var _path = _interopRequireDefault(require("path"));
+var _bytes = _interopRequireDefault(require("bytes"));
 const namespace = 'engine:middleware:fileUploader';
 
 /**
@@ -32,8 +34,8 @@ function fileUploader(filesOptions, validator) {
     const upload = (0, _multer.default)({
       storage,
       limits: {
-        fileSize: 10 * 1024 * 1024
-      } // Limit file size to 10MB
+        fileSize: 32 * 1024 * 1024
+      } // Default global limit (10MB)
     }).any();
     upload(request, response, async err => {
       if (err) {
@@ -102,7 +104,47 @@ function fileUploader(filesOptions, validator) {
           }
         }));
       }
-      request.body.files = uploadedFiles;
+
+      // Validate each uploaded file
+      for (const file of uploadedFiles) {
+        const fileOption = filesOptions.find(option => option.key === file.fieldname);
+        if (!fileOption) continue;
+
+        // MIME Type Validation
+        if (fileOption.mimeTypes && !fileOption.mimeTypes.includes(file.mimetype)) {
+          return next(new _WebError.WebError({
+            statusCode: 400,
+            errorCode: 'invalid-mime-type',
+            message: `Invalid file type for ${file.fieldname}`,
+            data: {
+              expected: fileOption.mimeTypes,
+              received: file.mimetype
+            }
+          }));
+        }
+
+        // Max File Size Validation
+        if (fileOption.maxSize) {
+          const maxSizeInBytes = (0, _bytes.default)(fileOption.maxSize);
+          if (maxSizeInBytes && file.size > maxSizeInBytes) {
+            return next(new _WebError.WebError({
+              statusCode: 400,
+              errorCode: 'file-too-large',
+              message: `File ${file.originalname} exceeds the allowed size`,
+              data: {
+                maxSize: fileOption.maxSize,
+                receivedSize: file.size
+              }
+            }));
+          }
+        }
+
+        // No Extension Handling
+        if (fileOption.noExtension) {
+          file.originalname = _path.default.basename(file.originalname, _path.default.extname(file.originalname));
+        }
+      }
+      request.files = uploadedFiles;
       next();
     });
   };

package/dist/middleware/fileUploader/fileUploader.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileUploader.js","names":["_WebError","require","_report","_multer","_interopRequireDefault","_validate","namespace","fileUploader","filesOptions","validator","request","response","next","reportDebug","message","data","storage","multer","memoryStorage","upload","limits","fileSize","any","err","error","uploadedFiles","Array","isArray","files","Object","values","flat","map","file","originalname","validate","uploadedFileKeys","fieldname","missingFiles","filter","option","required","includes","key","length","WebError","statusCode","errorCode","body"],"sources":["../../../src/middleware/fileUploader/fileUploader.ts"],"sourcesContent":["import { Request, Response, NextFunction } from 'express';\nimport { Schema } from 'express-validator';\nimport { WebError } from 'entities/WebError';\nimport { reportDebug } from 'utils/report';\nimport multer from 'multer';\nimport { FileUploaderConfig } from './fileUploader.types';\nimport { validate } from './validate';\n\nconst namespace = 'engine:middleware:fileUploader';\n\n/**\n * Middleware for handling file uploads.\n * @param filesOptions Configuration options for expected files.\n * @param validator Validation schema for request fields.\n */\nexport function fileUploader(\n  filesOptions: Array<FileUploaderConfig>,\n  validator: Schema\n) {\n  return async (\n    request: Request,\n    response: Response,\n    next: NextFunction\n  ): Promise<void> => {\n    reportDebug({\n      namespace,\n      message: 'Received request to upload file',\n      data: { filesOptions, validator }\n    });\n\n    // Setup multer with memory storage\n    const storage = multer.memoryStorage();\n    const upload = multer({\n      storage,\n      limits: { fileSize: 10 * 1024 * 1024 } // Limit file size to 10MB\n    }).any();\n\n    upload(request, response, async (err) => {\n      if (err) {\n        reportDebug({\n          namespace,\n          message: 'Multer upload error',\n          data: { error: err.message }\n        });\n        return next(err);\n      }\n\n      // Ensure `request.files` is properly typed\n      let uploadedFiles: Express.Multer.File[] = [];\n      if (Array.isArray(request.files)) {\n        uploadedFiles = request.files;\n      } else if (typeof request.files === 'object') {\n        uploadedFiles = Object.values(request.files).flat();\n      }\n\n      // Log uploaded files\n      reportDebug({\n        namespace,\n        message: 'Files Received',\n        data: { uploadedFiles: uploadedFiles.map((file) => file.originalname) }\n      });\n\n      // Validate request body fields\n      try {\n        await validate(request, validator);\n      } catch (error) {\n        reportDebug({\n          namespace,\n          message: 'Validation failed',\n          data: { error }\n        });\n        return next(error);\n      }\n\n      // Extract uploaded field names\n      const uploadedFileKeys = uploadedFiles.map((file) => file.fieldname);\n\n      // Check for missing required files\n      const missingFiles = filesOptions.filter(\n        (option) => option.required && !uploadedFileKeys.includes(option.key)\n      );\n\n      if (missingFiles.length > 0) {\n        reportDebug({\n          namespace,\n          message: 'Missing required files',\n          data: { missingFiles, uploadedFileKeys }\n        });\n\n        return next(\n          new WebError({\n            statusCode: 400,\n            errorCode: 'missing-field',\n            message: 'Some required files have not been uploaded',\n            data: { missingFiles, uploadedFileKeys }\n          })\n        );\n      }\n\n      request.body.files = uploadedFiles;\n\n      next();\n    });\n  };\n}\n"],"mappings":";;;;;;;AAEA,IAAAA,SAAA,GAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,OAAA,GAAAC,sBAAA,CAAAH,OAAA;AAEA,IAAAI,SAAA,GAAAJ,OAAA;AAEA,MAAMK,SAAS,GAAG,gCAAgC;;AAElD;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAC1BC,YAAuC,EACvCC,SAAiB,EACjB;EACA,OAAO,OACLC,OAAgB,EAChBC,QAAkB,EAClBC,IAAkB,KACA;IAClB,IAAAC,mBAAW,EAAC;MACVP,SAAS;MACTQ,OAAO,EAAE,iCAAiC;MAC1CC,IAAI,EAAE;QAAEP,YAAY;QAAEC;MAAU;IAClC,CAAC,CAAC;;IAEF;IACA,MAAMO,OAAO,GAAGC,eAAM,CAACC,aAAa,CAAC,CAAC;IACtC,MAAMC,MAAM,GAAG,IAAAF,eAAM,EAAC;MACpBD,OAAO;MACPI,MAAM,EAAE;QAAEC,QAAQ,EAAE,EAAE,GAAG,IAAI,GAAG;MAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC;IAERH,MAAM,CAACT,OAAO,EAAEC,QAAQ,EAAE,MAAOY,GAAG,IAAK;MACvC,IAAIA,GAAG,EAAE;QACP,IAAAV,mBAAW,EAAC;UACVP,SAAS;UACTQ,OAAO,EAAE,qBAAqB;UAC9BC,IAAI,EAAE;YAAES,KAAK,EAAED,GAAG,CAACT;UAAQ;QAC7B,CAAC,CAAC;QACF,OAAOF,IAAI,CAACW,GAAG,CAAC;MAClB;;MAEA;MACA,IAAIE,aAAoC,GAAG,EAAE;MAC7C,IAAIC,KAAK,CAACC,OAAO,CAACjB,OAAO,CAACkB,KAAK,CAAC,EAAE;QAChCH,aAAa,GAAGf,OAAO,CAACkB,KAAK;MAC/B,CAAC,MAAM,IAAI,OAAOlB,OAAO,CAACkB,KAAK,KAAK,QAAQ,EAAE;QAC5CH,aAAa,GAAGI,MAAM,CAACC,MAAM,CAACpB,OAAO,CAACkB,KAAK,CAAC,CAACG,IAAI,CAAC,CAAC;MACrD;;MAEA;MACA,IAAAlB,mBAAW,EAAC;QACVP,SAAS;QACTQ,OAAO,EAAE,gBAAgB;QACzBC,IAAI,EAAE;UAAEU,aAAa,EAAEA,aAAa,CAACO,GAAG,CAAEC,IAAI,IAAKA,IAAI,CAACC,YAAY;QAAE;MACxE,CAAC,CAAC;;MAEF;MACA,IAAI;QACF,MAAM,IAAAC,kBAAQ,EAACzB,OAAO,EAAED,SAAS,CAAC;MACpC,CAAC,CAAC,OAAOe,KAAK,EAAE;QACd,IAAAX,mBAAW,EAAC;UACVP,SAAS;UACTQ,OAAO,EAAE,mBAAmB;UAC5BC,IAAI,EAAE;YAAES;UAAM;QAChB,CAAC,CAAC;QACF,OAAOZ,IAAI,CAACY,KAAK,CAAC;MACpB;;MAEA;MACA,MAAMY,gBAAgB,GAAGX,aAAa,CAACO,GAAG,CAAEC,IAAI,IAAKA,IAAI,CAACI,SAAS,CAAC;;MAEpE;MACA,MAAMC,YAAY,GAAG9B,YAAY,CAAC+B,MAAM,CACrCC,MAAM,IAAKA,MAAM,CAACC,QAAQ,IAAI,CAACL,gBAAgB,CAACM,QAAQ,CAACF,MAAM,CAACG,GAAG,CACtE,CAAC;MAED,IAAIL,YAAY,CAACM,MAAM,GAAG,CAAC,EAAE;QAC3B,IAAA/B,mBAAW,EAAC;UACVP,SAAS;UACTQ,OAAO,EAAE,wBAAwB;UACjCC,IAAI,EAAE;YAAEuB,YAAY;YAAEF;UAAiB;QACzC,CAAC,CAAC;QAEF,OAAOxB,IAAI,CACT,IAAIiC,kBAAQ,CAAC;UACXC,UAAU,EAAE,GAAG;UACfC,SAAS,EAAE,eAAe;UAC1BjC,OAAO,EAAE,4CAA4C;UACrDC,IAAI,EAAE;YAAEuB,YAAY;YAAEF;UAAiB;QACzC,CAAC,CACH,CAAC;MACH;MAEA1B,OAAO,CAACsC,IAAI,CAACpB,KAAK,GAAGH,aAAa;MAElCb,IAAI,CAAC,CAAC;IACR,CAAC,CAAC;EACJ,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"fileUploader.js","names":["_WebError","require","_report","_multer","_interopRequireDefault","_validate","_path","_bytes","namespace","fileUploader","filesOptions","validator","request","response","next","reportDebug","message","data","storage","multer","memoryStorage","upload","limits","fileSize","any","err","error","uploadedFiles","Array","isArray","files","Object","values","flat","map","file","originalname","validate","uploadedFileKeys","fieldname","missingFiles","filter","option","required","includes","key","length","WebError","statusCode","errorCode","fileOption","find","mimeTypes","mimetype","expected","received","maxSize","maxSizeInBytes","bytes","size","receivedSize","noExtension","path","basename","extname"],"sources":["../../../src/middleware/fileUploader/fileUploader.ts"],"sourcesContent":["import { Request, Response, NextFunction } from 'express';\nimport { Schema } from 'express-validator';\nimport { WebError } from 'entities/WebError';\nimport { reportDebug } from 'utils/report';\nimport multer from 'multer';\nimport { FileUploaderConfig } from './fileUploader.types';\nimport { validate } from './validate';\nimport path from 'path';\nimport bytes from 'bytes';\n\nconst namespace = 'engine:middleware:fileUploader';\n\n/**\n * Middleware for handling file uploads.\n * @param filesOptions Configuration options for expected files.\n * @param validator Validation schema for request fields.\n */\nexport function fileUploader(\n  filesOptions: Array<FileUploaderConfig>,\n  validator: Schema\n) {\n  return async (\n    request: Request,\n    response: Response,\n    next: NextFunction\n  ): Promise<void> => {\n    reportDebug({\n      namespace,\n      message: 'Received request to upload file',\n      data: { filesOptions, validator }\n    });\n\n    // Setup multer with memory storage\n    const storage = multer.memoryStorage();\n    const upload = multer({\n      storage,\n      limits: { fileSize: 32 * 1024 * 1024 } // Default global limit (10MB)\n    }).any();\n\n    upload(request, response, async (err) => {\n      if (err) {\n        reportDebug({\n          namespace,\n          message: 'Multer upload error',\n          data: { error: err.message }\n        });\n        return next(err);\n      }\n\n      // Ensure `request.files` is properly typed\n      let uploadedFiles: Express.Multer.File[] = [];\n      if (Array.isArray(request.files)) {\n        uploadedFiles = request.files;\n      } else if (typeof request.files === 'object') {\n        uploadedFiles = Object.values(request.files).flat();\n      }\n\n      // Log uploaded files\n      reportDebug({\n        namespace,\n        message: 'Files Received',\n        data: { uploadedFiles: uploadedFiles.map((file) => file.originalname) }\n      });\n\n      // Validate request body fields\n      try {\n        await validate(request, validator);\n      } catch (error) {\n        reportDebug({\n          namespace,\n          message: 'Validation failed',\n          data: { error }\n        });\n        return next(error);\n      }\n\n      // Extract uploaded field names\n      const uploadedFileKeys = uploadedFiles.map((file) => file.fieldname);\n\n      // Check for missing required files\n      const missingFiles = filesOptions.filter(\n        (option) => option.required && !uploadedFileKeys.includes(option.key)\n      );\n\n      if (missingFiles.length > 0) {\n        reportDebug({\n          namespace,\n          message: 'Missing required files',\n          data: { missingFiles, uploadedFileKeys }\n        });\n\n        return next(\n          new WebError({\n            statusCode: 400,\n            errorCode: 'missing-field',\n            message: 'Some required files have not been uploaded',\n            data: { missingFiles, uploadedFileKeys }\n          })\n        );\n      }\n\n      // Validate each uploaded file\n      for (const file of uploadedFiles) {\n        const fileOption = filesOptions.find(\n          (option) => option.key === file.fieldname\n        );\n\n        if (!fileOption) continue;\n\n        // MIME Type Validation\n        if (\n          fileOption.mimeTypes &&\n          !fileOption.mimeTypes.includes(file.mimetype)\n        ) {\n          return next(\n            new WebError({\n              statusCode: 400,\n              errorCode: 'invalid-mime-type',\n              message: `Invalid file type for ${file.fieldname}`,\n              data: { expected: fileOption.mimeTypes, received: file.mimetype }\n            })\n          );\n        }\n\n        // Max File Size Validation\n        if (fileOption.maxSize) {\n          const maxSizeInBytes = bytes(fileOption.maxSize);\n          if (maxSizeInBytes && file.size > maxSizeInBytes) {\n            return next(\n              new WebError({\n                statusCode: 400,\n                errorCode: 'file-too-large',\n                message: `File ${file.originalname} exceeds the allowed size`,\n                data: { maxSize: fileOption.maxSize, receivedSize: file.size }\n              })\n            );\n          }\n        }\n\n        // No Extension Handling\n        if (fileOption.noExtension) {\n          file.originalname = path.basename(\n            file.originalname,\n            path.extname(file.originalname)\n          );\n        }\n      }\n\n      request.files = uploadedFiles;\n\n      next();\n    });\n  };\n}\n"],"mappings":";;;;;;;AAEA,IAAAA,SAAA,GAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,OAAA,GAAAC,sBAAA,CAAAH,OAAA;AAEA,IAAAI,SAAA,GAAAJ,OAAA;AACA,IAAAK,KAAA,GAAAF,sBAAA,CAAAH,OAAA;AACA,IAAAM,MAAA,GAAAH,sBAAA,CAAAH,OAAA;AAEA,MAAMO,SAAS,GAAG,gCAAgC;;AAElD;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAC1BC,YAAuC,EACvCC,SAAiB,EACjB;EACA,OAAO,OACLC,OAAgB,EAChBC,QAAkB,EAClBC,IAAkB,KACA;IAClB,IAAAC,mBAAW,EAAC;MACVP,SAAS;MACTQ,OAAO,EAAE,iCAAiC;MAC1CC,IAAI,EAAE;QAAEP,YAAY;QAAEC;MAAU;IAClC,CAAC,CAAC;;IAEF;IACA,MAAMO,OAAO,GAAGC,eAAM,CAACC,aAAa,CAAC,CAAC;IACtC,MAAMC,MAAM,GAAG,IAAAF,eAAM,EAAC;MACpBD,OAAO;MACPI,MAAM,EAAE;QAAEC,QAAQ,EAAE,EAAE,GAAG,IAAI,GAAG;MAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC;IAERH,MAAM,CAACT,OAAO,EAAEC,QAAQ,EAAE,MAAOY,GAAG,IAAK;MACvC,IAAIA,GAAG,EAAE;QACP,IAAAV,mBAAW,EAAC;UACVP,SAAS;UACTQ,OAAO,EAAE,qBAAqB;UAC9BC,IAAI,EAAE;YAAES,KAAK,EAAED,GAAG,CAACT;UAAQ;QAC7B,CAAC,CAAC;QACF,OAAOF,IAAI,CAACW,GAAG,CAAC;MAClB;;MAEA;MACA,IAAIE,aAAoC,GAAG,EAAE;MAC7C,IAAIC,KAAK,CAACC,OAAO,CAACjB,OAAO,CAACkB,KAAK,CAAC,EAAE;QAChCH,aAAa,GAAGf,OAAO,CAACkB,KAAK;MAC/B,CAAC,MAAM,IAAI,OAAOlB,OAAO,CAACkB,KAAK,KAAK,QAAQ,EAAE;QAC5CH,aAAa,GAAGI,MAAM,CAACC,MAAM,CAACpB,OAAO,CAACkB,KAAK,CAAC,CAACG,IAAI,CAAC,CAAC;MACrD;;MAEA;MACA,IAAAlB,mBAAW,EAAC;QACVP,SAAS;QACTQ,OAAO,EAAE,gBAAgB;QACzBC,IAAI,EAAE;UAAEU,aAAa,EAAEA,aAAa,CAACO,GAAG,CAAEC,IAAI,IAAKA,IAAI,CAACC,YAAY;QAAE;MACxE,CAAC,CAAC;;MAEF;MACA,IAAI;QACF,MAAM,IAAAC,kBAAQ,EAACzB,OAAO,EAAED,SAAS,CAAC;MACpC,CAAC,CAAC,OAAOe,KAAK,EAAE;QACd,IAAAX,mBAAW,EAAC;UACVP,SAAS;UACTQ,OAAO,EAAE,mBAAmB;UAC5BC,IAAI,EAAE;YAAES;UAAM;QAChB,CAAC,CAAC;QACF,OAAOZ,IAAI,CAACY,KAAK,CAAC;MACpB;;MAEA;MACA,MAAMY,gBAAgB,GAAGX,aAAa,CAACO,GAAG,CAAEC,IAAI,IAAKA,IAAI,CAACI,SAAS,CAAC;;MAEpE;MACA,MAAMC,YAAY,GAAG9B,YAAY,CAAC+B,MAAM,CACrCC,MAAM,IAAKA,MAAM,CAACC,QAAQ,IAAI,CAACL,gBAAgB,CAACM,QAAQ,CAACF,MAAM,CAACG,GAAG,CACtE,CAAC;MAED,IAAIL,YAAY,CAACM,MAAM,GAAG,CAAC,EAAE;QAC3B,IAAA/B,mBAAW,EAAC;UACVP,SAAS;UACTQ,OAAO,EAAE,wBAAwB;UACjCC,IAAI,EAAE;YAAEuB,YAAY;YAAEF;UAAiB;QACzC,CAAC,CAAC;QAEF,OAAOxB,IAAI,CACT,IAAIiC,kBAAQ,CAAC;UACXC,UAAU,EAAE,GAAG;UACfC,SAAS,EAAE,eAAe;UAC1BjC,OAAO,EAAE,4CAA4C;UACrDC,IAAI,EAAE;YAAEuB,YAAY;YAAEF;UAAiB;QACzC,CAAC,CACH,CAAC;MACH;;MAEA;MACA,KAAK,MAAMH,IAAI,IAAIR,aAAa,EAAE;QAChC,MAAMuB,UAAU,GAAGxC,YAAY,CAACyC,IAAI,CACjCT,MAAM,IAAKA,MAAM,CAACG,GAAG,KAAKV,IAAI,CAACI,SAClC,CAAC;QAED,IAAI,CAACW,UAAU,EAAE;;QAEjB;QACA,IACEA,UAAU,CAACE,SAAS,IACpB,CAACF,UAAU,CAACE,SAAS,CAACR,QAAQ,CAACT,IAAI,CAACkB,QAAQ,CAAC,EAC7C;UACA,OAAOvC,IAAI,CACT,IAAIiC,kBAAQ,CAAC;YACXC,UAAU,EAAE,GAAG;YACfC,SAAS,EAAE,mBAAmB;YAC9BjC,OAAO,EAAE,yBAAyBmB,IAAI,CAACI,SAAS,EAAE;YAClDtB,IAAI,EAAE;cAAEqC,QAAQ,EAAEJ,UAAU,CAACE,SAAS;cAAEG,QAAQ,EAAEpB,IAAI,CAACkB;YAAS;UAClE,CAAC,CACH,CAAC;QACH;;QAEA;QACA,IAAIH,UAAU,CAACM,OAAO,EAAE;UACtB,MAAMC,cAAc,GAAG,IAAAC,cAAK,EAACR,UAAU,CAACM,OAAO,CAAC;UAChD,IAAIC,cAAc,IAAItB,IAAI,CAACwB,IAAI,GAAGF,cAAc,EAAE;YAChD,OAAO3C,IAAI,CACT,IAAIiC,kBAAQ,CAAC;cACXC,UAAU,EAAE,GAAG;cACfC,SAAS,EAAE,gBAAgB;cAC3BjC,OAAO,EAAE,QAAQmB,IAAI,CAACC,YAAY,2BAA2B;cAC7DnB,IAAI,EAAE;gBAAEuC,OAAO,EAAEN,UAAU,CAACM,OAAO;gBAAEI,YAAY,EAAEzB,IAAI,CAACwB;cAAK;YAC/D,CAAC,CACH,CAAC;UACH;QACF;;QAEA;QACA,IAAIT,UAAU,CAACW,WAAW,EAAE;UAC1B1B,IAAI,CAACC,YAAY,GAAG0B,aAAI,CAACC,QAAQ,CAC/B5B,IAAI,CAACC,YAAY,EACjB0B,aAAI,CAACE,OAAO,CAAC7B,IAAI,CAACC,YAAY,CAChC,CAAC;QACH;MACF;MAEAxB,OAAO,CAACkB,KAAK,GAAGH,aAAa;MAE7Bb,IAAI,CAAC,CAAC;IACR,CAAC,CAAC;EACJ,CAAC;AACH","ignoreList":[]}

package/dist/middleware/multiPartFileUploader/index.d.ts

@@ -1 +1,2 @@
 export * from './multiPartFileUploader';
+export * from './multiPartFileUploader.types';

package/dist/middleware/multiPartFileUploader/index.js

@@ -14,4 +14,15 @@ Object.keys(_multiPartFileUploader).forEach(function (key) {
     }
   });
 });
+var _multiPartFileUploader2 = require("./multiPartFileUploader.types");
+Object.keys(_multiPartFileUploader2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _multiPartFileUploader2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _multiPartFileUploader2[key];
+    }
+  });
+});
 //# sourceMappingURL=index.js.map

package/dist/middleware/multiPartFileUploader/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["_multiPartFileUploader","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["../../../src/middleware/multiPartFileUploader/index.ts"],"sourcesContent":["export * from './multiPartFileUploader';\n"],"mappings":";;;;;AAAA,IAAAA,sBAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,sBAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,sBAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,sBAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["_multiPartFileUploader","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_multiPartFileUploader2"],"sources":["../../../src/middleware/multiPartFileUploader/index.ts"],"sourcesContent":["export * from './multiPartFileUploader';\nexport * from './multiPartFileUploader.types';\n"],"mappings":";;;;;AAAA,IAAAA,sBAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,sBAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,sBAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,sBAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,uBAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,uBAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,uBAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,uBAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/middleware/multiPartFileUploader/multiPartFileUploader.d.ts

@@ -1,3 +1,4 @@
-import express from 'express';
-declare function multiPartFileUploader(req: express.Request, res: express.Response, next: express.NextFunction): Promise<void>;
-export { multiPartFileUploader };
+import { Request, Response, NextFunction } from 'express';
+import { Schema } from 'express-validator';
+import { MultiPartFileUploaderConfig } from './multiPartFileUploader.types';
+export declare function multiPartFileUploader(filesOption: MultiPartFileUploaderConfig, validator: Schema): (req: Request, res: Response, next: NextFunction) => Promise<void>;