node-server-engine 1.2.5 → 1.2.7

package/src/middleware/fileUploader/fileUploader.ts

@@ -1,303 +1,103 @@
-import Busboy from 'busboy';
 import { Request, Response, NextFunction } from 'express';
 import { Schema } from 'express-validator';
-import { compressAvatar } from './compressAvatar';
+import { WebError } from 'entities/WebError';
+import { reportDebug } from 'utils/report';
+import multer from 'multer';
 import { FileUploaderConfig } from './fileUploader.types';
-import { isMultipart } from './isMultiPart';
 import { validate } from './validate';
-import { Storage } from 'entities/Storage';
-import { WebError } from 'entities/WebError';
-import { reportError, reportDebug } from 'utils/report';
-import { Readable } from 'stream';
 
 const namespace = 'engine:middleware:fileUploader';
 
 /**
- * Generate a custom fileUploader middleware
+ * Middleware for handling file uploads.
+ * @param filesOptions Configuration options for expected files.
+ * @param validator Validation schema for request fields.
  */
 export function fileUploader(
-  options: Array<FileUploaderConfig>,
+  filesOptions: Array<FileUploaderConfig>,
   validator: Schema
 ) {
-  return (
+  return async (
     request: Request,
     response: Response,
     next: NextFunction
-  ): Busboy.Busboy =>
-    fileUploaderMiddleware(request, response, next, options, validator);
-}
-
-/** Handle file upload and generic multi-part parsing */
-export function fileUploaderMiddleware(
-  request: Request,
-  response: Response,
-  next: NextFunction,
-  filesOptions: Array<FileUploaderConfig>,
-  validator: Schema
-): Busboy.Busboy {
-  reportDebug({
-    namespace,
-    message: 'Received request to upload file',
-    data: { filesOptions, validator }
-  });
-  // Check that the request is a proper multipart request
-  if (!isMultipart(request))
-    throw new WebError({
-      statusCode: 415,
-      errorCode: 'invalid-content-type',
-      message: 'Request is not of type multipart/form-data',
-      data: { contentType: request.get('Content-Type') }
+  ): Promise<void> => {
+    reportDebug({
+      namespace,
+      message: 'Received request to upload file',
+      data: { filesOptions, validator }
     });
-  // If no files to handle ignore
-  if (!filesOptions.length) next();
-  // Parse multipart data with Busboy
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const busboy = new (Busboy as any)({
-    headers: {
-      ...request.headers,
-      'content-type': request.headers['content-type'] ?? ''
-    }
-  });
 
-  let hasError = false;
+    // Setup multer with memory storage
+    const storage = multer.memoryStorage();
+    const upload = multer({
+      storage,
+      limits: { fileSize: 10 * 1024 * 1024 } // Limit file size to 10MB
+    }).any();
 
-  /**
-   * Function called when an error happened in the process
-   * It immediately stops and drains all connection and deletes all files that have already been uploaded
-   */
-  function triggerError(error: unknown): void {
-    pendingWrites--;
-    if (hasError) return;
-    hasError = true;
-    request.unpipe(busboy);
-    request.on('readable', request.read.bind(request));
-    busboy.removeAllListeners();
-    next(error);
-    if (request.files) {
-      Object.values(request.files).forEach((files) => {
-        files.forEach((file) => {
-          Storage.delete(file.bucket, file.name).catch((error) => {
-            reportError(error);
-          });
+    upload(request, response, async (err) => {
+      if (err) {
+        reportDebug({
+          namespace,
+          message: 'Multer upload error',
+          data: { error: err.message }
         });
-      });
-    }
-  }
-
-  let readFinished = false;
-  let fieldsValidated = false;
-  let pendingWrites = 0;
-
-  /** Function called when all the body has been parsed */
-  function done(): void {
-    if (readFinished && pendingWrites === 0 && fieldsValidated && !hasError) {
-      const uploadedFiles = Object.keys(request.files ?? {});
-      if (
-        filesOptions.some(
-          (options) => options.required && !uploadedFiles.includes(options.key)
-        )
-      ) {
-        triggerError(
-          new WebError({
-            statusCode: 400,
-            errorCode: 'missing-field',
-            message: 'Some required files have not been uploaded',
-            data: { filesOptions, validator, uploadedFiles }
-          })
-        );
-        return;
+        return next(err);
       }
-      next();
-    }
-  }
 
-  /*
-   * On cancel request, while processing
-   */
-  request.connection.on('close', function () {
-    if (!response.writableEnded) triggerError(new Error('Request cancelled'));
-  });
+      // Ensure `request.files` is properly typed
+      let uploadedFiles: Express.Multer.File[] = [];
+      if (Array.isArray(request.files)) {
+        uploadedFiles = request.files;
+      } else if (typeof request.files === 'object') {
+        uploadedFiles = Object.values(request.files).flat();
+      }
 
-  /**
-   * Once all the fields have been read they are checked against the validation schema
-   */
-  async function validateFields(): Promise<void> {
-    try {
-      await validate(request, validator);
-    } catch (error) {
-      triggerError(error);
-    }
-    reportDebug({
-      namespace,
-      message: 'Validation processed',
-      data: { hasError, filesOptions, validator }
-    });
-    fieldsValidated = true;
-    done();
-  }
+      // Log uploaded files
+      reportDebug({
+        namespace,
+        message: 'Files Received',
+        data: { uploadedFiles: uploadedFiles.map((file) => file.originalname) }
+      });
 
-  busboy.on(
-    'file',
-    (
-      field: string,
-      file: Readable,
-      fileName: string,
-      encoding: unknown,
-      mimeType: string
-    ) => {
-      (async (): Promise<void> => {
-        reportDebug({
-          namespace,
-          message: 'Found file in request',
-          data: { hasError, field, fileName, encoding, mimeType, pendingWrites }
-        });
-        // Do not handle the stream if there has been an error previously
-        if (hasError) file.destroy();
-        pendingWrites++;
-        // Find related file options based on the field name
-        const options = filesOptions.find(
-          (fileOption) => fileOption.key === field
-        );
-        // Make sure that the field is in the config
-        if (!options) {
-          triggerError(
-            new WebError({
-              statusCode: 400,
-              errorCode: 'invalid-file-field',
-              message: 'Request contains a file at an invalid field',
-              hint: { field },
-              data: { field }
-            })
-          );
-          return;
-        }
+      // Validate request body fields
+      try {
+        await validate(request, validator);
+      } catch (error) {
         reportDebug({
           namespace,
-          message: 'Found options for file',
-          data: {
-            hasError,
-            field,
-            fileName,
-            encoding,
-            mimeType,
-            pendingWrites,
-            options
-          }
+          message: 'Validation failed',
+          data: { error }
         });
-        // If a specific MIME type is required check it
-        if (options.mimeTypes && !options.mimeTypes.includes(mimeType)) {
-          triggerError(
-            new WebError({
-              statusCode: 415,
-              errorCode: 'invalid-mime-type',
-              message: 'Request contains a file with an invalid MIME type',
-              hint: { field },
-              data: { field, mimeType, expected: options.mimeTypes }
-            })
-          );
-          return;
-        }
-        // Generate the destination path of the file and upload
+        return next(error);
+      }
+
+      // Extract uploaded field names
+      const uploadedFileKeys = uploadedFiles.map((file) => file.fieldname);
+
+      // Check for missing required files
+      const missingFiles = filesOptions.filter(
+        (option) => option.required && !uploadedFileKeys.includes(option.key)
+      );
+
+      if (missingFiles.length > 0) {
         reportDebug({
           namespace,
-          message: 'Starting file upload',
-          data: {
-            hasError,
-            field,
-            fileName,
-            encoding,
-            mimeType,
-            pendingWrites,
-            options
-          }
+          message: 'Missing required files',
+          data: { missingFiles, uploadedFileKeys }
         });
-        try {
-          const fileToUpload = options.image
-            ? compressAvatar(file, options.image)
-            : file;
-
-          const uploadedFile = await Storage.upload(
-            fileToUpload,
-            options.bucket,
-            {
-              directory: options.path,
-              mime: mimeType,
-              noExtension: options.noExtension
-            },
-            {
-              metadata: { contentType: mimeType }
-            },
-            { maxSize: options.maxSize }
-          );
 
-          reportDebug({
-            namespace,
-            message: 'File uploaded',
-            data: {
-              hasError,
-              field,
-              fileName,
-              encoding,
-              mimeType,
-              pendingWrites,
-              options,
-              uploadedFile
-            }
-          });
-          if (hasError) {
-            // If some other failed before this one terminated
-            // Delete file
-            await Storage.delete(uploadedFile.bucket, uploadedFile.name);
-          } else {
-            // Handle successful upload
-            // Add the file's data to the request
-            pendingWrites--;
-            if (!request.files) request.files = {};
-            if (!request.files[field]) request.files[field] = [];
-            request.files[field].push({
-              ...uploadedFile,
-              originalFileName: fileName
-            });
-            done();
-          }
-        } catch (error) {
-          triggerError(error);
-        }
-      })().catch((error) => {
-        triggerError(error);
-      });
-    }
-  );
-
-  /**
-   * Handle non file fields
-   * These fields will be pushed to the body as array of strings
-   */
-  busboy.on('field', (fieldName: string, value: unknown) => {
-    if (!request.body) request.body = {};
+        return next(
+          new WebError({
+            statusCode: 400,
+            errorCode: 'missing-field',
+            message: 'Some required files have not been uploaded',
+            data: { missingFiles, uploadedFileKeys }
+          })
+        );
+      }
 
-    if (request.body[fieldName]) {
-      request.body[fieldName].push(value);
-    } else {
-      request.body[fieldName] = [value];
-    }
-  });
-  busboy.on('error', function (error: unknown) {
-    triggerError(error);
-  });
-  busboy.on('finish', () => {
-    (async (): Promise<void> => {
-      reportDebug({
-        namespace,
-        message: 'Busboy finished reading',
-        data: { hasError, filesOptions, validator, pendingWrites }
-      });
-      readFinished = true;
-      await validateFields();
-      done();
-    })().catch((error) => {
-      triggerError(error);
+      next();
     });
-  });
-  return request.pipe(busboy);
+  };
 }

package/src/middleware/fileUploader/fileUploader.types.ts

@@ -1,52 +1,35 @@
-import { CompressionOptions } from './compressAvatar';
-import { StorageUploadedFile } from 'entities/Storage';
-
-// Override the Express request object to add the files
+// Extend Express request object to include `files`
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Express {
-    /** Express request object */
     interface Request {
-      /** Configuration for files that are uploaded with the request */
-      files?: { [key: string]: Array<UploadedFile> };
+      /** Uploaded files mapped by field name */
+      files?:
+        | { [key: string]: Express.Multer.File[] }
+        | Express.Multer.File[]
+        | undefined;
     }
   }
 }
 
 /** Custom uploaded file metadata */
-export interface UploadedFile extends StorageUploadedFile {
-  /** File name that was given to the file by the client */
+export interface UploadedFile extends Express.Multer.File {
+  /** Original file name (use `originalname` from `Express.Multer.File`) */
   originalFileName: string;
+  /** File data buffer (use `buffer` from `Express.Multer.File`) */
+  file: Buffer;
 }
 
-/** Outputs setting for the file upload. Defines where a file should be stored and how it should be processed. */
-interface FileUploaderOutputs {
-  /** Name of the output */
-  name: string;
-  /** Path to which this specific output is stored (defaults to default path if not set) */
-  path?: string;
-  /** Bucket to which this specific output is stored (defaults to default bucket if not set) */
-  bucket?: string;
-}
-
-/** Configuration for a file upload */
+/** Configuration for file upload */
 export interface FileUploaderConfig {
-  /** Field key for which this configuration applies */
+  /** Field name expected in the request */
   key: string;
-  /** A list of supported MIME Types for the file */
+  /** Allowed MIME types */
   mimeTypes?: Array<string>;
-  /** Base path where the file should be stored (default used when no output config is set, will be used as temporary storage when outputs are set) */
-  path?: string;
-  /** Bucket in which the file should be stored (will be used as temporary storage when outputs are set) */
-  bucket: string;
-  /** Maximum size of the file (ex: 2MB) */
+  /** Maximum file size (e.g., "2MB") */
   maxSize?: string;
-  /** Indicates that the file must be present */
+  /** Whether the file is required */
   required?: boolean;
-  /** Do not store with an extension (will simply be a uuid) */
+  /** Whether to store without an extension */
   noExtension?: boolean;
-  /** Specify multiple outputs with processing */
-  outputs?: Array<FileUploaderOutputs>;
-  /** @deprecated compression of images */
-  image?: CompressionOptions;
 }

package/test/env.ts

@@ -47,5 +47,6 @@ process.env = {
   SQL_DB: 'testDb',
   SQL_TYPE: 'mysql',
   DEFAULT_MESSAGE_AUDIENCE: audience,
+  GOOGLE_AI_KEY: 'AIKEY',
   ...process.env
 };

package/dist/middleware/fileUploader/compressAvatar/compressAvatar.d.ts

@@ -1,6 +0,0 @@
-import { Readable } from 'stream';
-import { CompressionOptions } from './compressAvatar.types';
-/**
- * Compress the user's avatar before uploading
- */
-export declare function compressAvatar(fileStream: Readable, options: CompressionOptions): Readable;

package/dist/middleware/fileUploader/compressAvatar/compressAvatar.js

@@ -1,28 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.compressAvatar = compressAvatar;
-var _sharp = _interopRequireDefault(require("sharp"));
-/**
- * Compress the user's avatar before uploading
- */
-function compressAvatar(fileStream, options) {
-  const {
-    resize: {
-      height,
-      width
-    },
-    quality
-  } = options;
-  const transform = (0, _sharp.default)().resize(width, height, {
-    fit: 'cover'
-  }).toFormat('jpeg', {
-    quality: quality
-  });
-  fileStream.pipe(transform);
-  return fileStream;
-}
-//# sourceMappingURL=compressAvatar.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"compressAvatar.js","names":["_sharp","_interopRequireDefault","require","compressAvatar","fileStream","options","resize","height","width","quality","transform","sharp","fit","toFormat","pipe"],"sources":["../../../../src/middleware/fileUploader/compressAvatar/compressAvatar.ts"],"sourcesContent":["import { Readable } from 'stream';\nimport sharp from 'sharp';\nimport { CompressionOptions } from './compressAvatar.types';\n\n/**\n * Compress the user's avatar before uploading\n */\nexport function compressAvatar(\n  fileStream: Readable,\n  options: CompressionOptions\n): Readable {\n  const {\n    resize: { height, width },\n    quality\n  } = options;\n  const transform = sharp()\n    .resize(width, height, {\n      fit: 'cover'\n    })\n    .toFormat('jpeg', {\n      quality: quality\n    });\n  fileStream.pipe(transform);\n  return fileStream;\n}\n"],"mappings":";;;;;;;AACA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AAGA;AACA;AACA;AACO,SAASC,cAAcA,CAC5BC,UAAoB,EACpBC,OAA2B,EACjB;EACV,MAAM;IACJC,MAAM,EAAE;MAAEC,MAAM;MAAEC;IAAM,CAAC;IACzBC;EACF,CAAC,GAAGJ,OAAO;EACX,MAAMK,SAAS,GAAG,IAAAC,cAAK,EAAC,CAAC,CACtBL,MAAM,CAACE,KAAK,EAAED,MAAM,EAAE;IACrBK,GAAG,EAAE;EACP,CAAC,CAAC,CACDC,QAAQ,CAAC,MAAM,EAAE;IAChBJ,OAAO,EAAEA;EACX,CAAC,CAAC;EACJL,UAAU,CAACU,IAAI,CAACJ,SAAS,CAAC;EAC1B,OAAON,UAAU;AACnB","ignoreList":[]}

package/dist/middleware/fileUploader/compressAvatar/compressAvatar.types.d.ts

@@ -1,12 +0,0 @@
-/** Options to compress image */
-export interface CompressionOptions {
-    /** Set dimensions in which the image will be resized */
-    resize: {
-        /** Height of the resized image */
-        height: number;
-        /** Width of the resized image */
-        width: number;
-    };
-    /** JPG quality factor to apply when compressing */
-    quality: number;
-}

package/dist/middleware/fileUploader/compressAvatar/compressAvatar.types.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=compressAvatar.types.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"compressAvatar.types.js","names":[],"sources":["../../../../src/middleware/fileUploader/compressAvatar/compressAvatar.types.ts"],"sourcesContent":["/** Options to compress image */\nexport interface CompressionOptions {\n  /** Set dimensions in which the image will be resized */\n  resize: {\n    /** Height of the resized image */\n    height: number;\n    /** Width of the resized image */\n    width: number;\n  };\n  /** JPG quality factor to apply when compressing */\n  quality: number;\n}\n"],"mappings":"","ignoreList":[]}

package/dist/middleware/fileUploader/compressAvatar/index.d.ts

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

package/dist/middleware/fileUploader/compressAvatar/index.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _compressAvatar = require("./compressAvatar");
-Object.keys(_compressAvatar).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _compressAvatar[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _compressAvatar[key];
-    }
-  });
-});
-var _compressAvatar2 = require("./compressAvatar.types");
-Object.keys(_compressAvatar2).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _compressAvatar2[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _compressAvatar2[key];
-    }
-  });
-});
-//# sourceMappingURL=index.js.map

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

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

package/src/middleware/fileUploader/compressAvatar/compressAvatar.ts

@@ -1,25 +0,0 @@
-import { Readable } from 'stream';
-import sharp from 'sharp';
-import { CompressionOptions } from './compressAvatar.types';
-
-/**
- * Compress the user's avatar before uploading
- */
-export function compressAvatar(
-  fileStream: Readable,
-  options: CompressionOptions
-): Readable {
-  const {
-    resize: { height, width },
-    quality
-  } = options;
-  const transform = sharp()
-    .resize(width, height, {
-      fit: 'cover'
-    })
-    .toFormat('jpeg', {
-      quality: quality
-    });
-  fileStream.pipe(transform);
-  return fileStream;
-}

package/src/middleware/fileUploader/compressAvatar/compressAvatar.types.ts

@@ -1,12 +0,0 @@
-/** Options to compress image */
-export interface CompressionOptions {
-  /** Set dimensions in which the image will be resized */
-  resize: {
-    /** Height of the resized image */
-    height: number;
-    /** Width of the resized image */
-    width: number;
-  };
-  /** JPG quality factor to apply when compressing */
-  quality: number;
-}

package/src/middleware/fileUploader/compressAvatar/index.ts

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