multermate 2.1.0 → 2.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Wasim Zaman
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Wasim Zaman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/index.js

@@ -8,6 +8,7 @@ exports.uploadSingle = uploadSingle;
 exports.uploadMultiple = uploadMultiple;
 exports.deleteFile = deleteFile;
 const promises_1 = __importDefault(require("fs/promises"));
+const fs_1 = require("fs");
 const multer_1 = __importDefault(require("multer"));
 const path_1 = __importDefault(require("path"));
 const uuid_1 = require("uuid");
@@ -166,9 +167,9 @@ const configureStorage = (destination) => {
     return multer_1.default.diskStorage({
         destination: (req, file, cb) => {
             const dir = destination || "uploads";
-            // Create directory synchronously to avoid callback issues
+            // Create directory synchronously - multer destination callback doesn't support async
             try {
-                require('fs').mkdirSync(dir, { recursive: true });
+                (0, fs_1.mkdirSync)(dir, { recursive: true });
                 cb(null, dir);
             }
             catch (error) {
@@ -177,7 +178,7 @@ const configureStorage = (destination) => {
                     cb(null, dir);
                 }
                 else {
-                    cb(new MultermateError(`Failed to create destination directory: ${dir}`, 'DESTINATION_ERROR'), '');
+                    cb(new MultermateError(`Failed to create destination directory: ${dir}. Error: ${error.message}`, 'DESTINATION_ERROR'), '');
                 }
             }
         },
@@ -198,6 +199,34 @@ const configureStorage = (destination) => {
         },
     });
 };
+const normalizePathForDb = (value) => value.replace(/\\/g, '/');
+const getPhysicalDestination = (destination, absoluteDestination) => {
+    if (!absoluteDestination) {
+        return destination || 'uploads';
+    }
+    if (!path_1.default.isAbsolute(absoluteDestination)) {
+        throw new MultermateError(`absoluteDestination must be an absolute path. Received: ${absoluteDestination}`, 'INVALID_ABSOLUTE_DESTINATION');
+    }
+    return absoluteDestination;
+};
+const sanitizeStoredPathsForDb = (req, destination, absoluteDestination) => {
+    if (!absoluteDestination) {
+        return;
+    }
+    const dbDestination = normalizePathForDb(destination || 'uploads');
+    if (req.file) {
+        req.file.destination = dbDestination;
+        req.file.path = normalizePathForDb(path_1.default.join(dbDestination, req.file.filename));
+    }
+    if (req.files && !Array.isArray(req.files)) {
+        Object.values(req.files).forEach((files) => {
+            files.forEach((file) => {
+                file.destination = dbDestination;
+                file.path = normalizePathForDb(path_1.default.join(dbDestination, file.filename));
+            });
+        });
+    }
+};
 /**
  * Function to configure file filter for Multer.
  *
@@ -232,9 +261,9 @@ const configureFileFilter = (allowedMimeTypes) => {
  * @param options - Configuration options for Multer.
  * @returns Multer instance configured with the provided options.
  */
-const configureMulter = ({ destination, filename, fileTypes = [], customMimeTypes = [], fileSizeLimit, preservePath = false, }) => {
+const configureMulter = ({ destination, absoluteDestination, filename, fileTypes = [], customMimeTypes = [], fileSizeLimit, preservePath = false, }) => {
     try {
-        const storage = configureStorage(destination);
+        const storage = configureStorage(getPhysicalDestination(destination, absoluteDestination));
         // Combine allowed MIME types based on fileTypes array
         let allowedMimeTypes = [];
         if (customMimeTypes.length > 0) {
@@ -273,13 +302,13 @@ const configureMulter = ({ destination, filename, fileTypes = [], customMimeType
  */
 function uploadSingle(options = {}) {
     try {
-        const destination = options.destination || 'uploads';
+        const storageDestination = getPhysicalDestination(options.destination, options.absoluteDestination);
         const multerInstance = configureMulter(options);
         const middleware = multerInstance.single(options.filename || "file");
         return (req, res, next) => {
             // Make sure the destination directory exists
             try {
-                require('fs').mkdirSync(destination, { recursive: true });
+                (0, fs_1.mkdirSync)(storageDestination, { recursive: true });
             }
             catch (error) {
                 // Directory might already exist, ignore error
@@ -312,6 +341,7 @@ function uploadSingle(options = {}) {
                     req.fileValidationError = errorMessage;
                     return next(multermateError);
                 }
+                sanitizeStoredPathsForDb(req, options.destination, options.absoluteDestination);
                 next();
             });
         };
@@ -328,7 +358,7 @@ function uploadSingle(options = {}) {
  */
 function uploadMultiple(options) {
     try {
-        const destination = options.destination || 'uploads';
+        const storageDestination = getPhysicalDestination(options.destination, options.absoluteDestination);
         // Map fields configuration to multer format
         const fieldConfigs = options.fields.map(field => ({
             name: field.name,
@@ -352,7 +382,8 @@ function uploadMultiple(options) {
             });
         }
         const multerConfig = {
-            destination,
+            destination: options.destination,
+            absoluteDestination: options.absoluteDestination,
             fileTypes: [],
             customMimeTypes: allowedFileTypes.length > 0 ? allowedFileTypes : [],
             fileSizeLimit: options.fileSizeLimit,
@@ -363,7 +394,7 @@ function uploadMultiple(options) {
         return (req, res, next) => {
             // Make sure the destination directory exists
             try {
-                require('fs').mkdirSync(destination, { recursive: true });
+                (0, fs_1.mkdirSync)(storageDestination, { recursive: true });
             }
             catch (error) {
                 // Directory might already exist, ignore error
@@ -400,6 +431,7 @@ function uploadMultiple(options) {
                     req.fileValidationError = errorMessage;
                     return next(multermateError);
                 }
+                sanitizeStoredPathsForDb(req, options.destination, options.absoluteDestination);
                 next();
             });
         };

package/dist/esm/index.js

@@ -1,4 +1,5 @@
 import fs from 'fs/promises';
+import { mkdirSync } from 'fs';
 import multer from 'multer';
 import path from 'path';
 import { v4 as uuidv4 } from 'uuid';
@@ -156,9 +157,9 @@ const configureStorage = (destination) => {
     return multer.diskStorage({
         destination: (req, file, cb) => {
             const dir = destination || "uploads";
-            // Create directory synchronously to avoid callback issues
+            // Create directory synchronously - multer destination callback doesn't support async
             try {
-                require('fs').mkdirSync(dir, { recursive: true });
+                mkdirSync(dir, { recursive: true });
                 cb(null, dir);
             }
             catch (error) {
@@ -167,7 +168,7 @@ const configureStorage = (destination) => {
                     cb(null, dir);
                 }
                 else {
-                    cb(new MultermateError(`Failed to create destination directory: ${dir}`, 'DESTINATION_ERROR'), '');
+                    cb(new MultermateError(`Failed to create destination directory: ${dir}. Error: ${error.message}`, 'DESTINATION_ERROR'), '');
                 }
             }
         },
@@ -188,6 +189,34 @@ const configureStorage = (destination) => {
         },
     });
 };
+const normalizePathForDb = (value) => value.replace(/\\/g, '/');
+const getPhysicalDestination = (destination, absoluteDestination) => {
+    if (!absoluteDestination) {
+        return destination || 'uploads';
+    }
+    if (!path.isAbsolute(absoluteDestination)) {
+        throw new MultermateError(`absoluteDestination must be an absolute path. Received: ${absoluteDestination}`, 'INVALID_ABSOLUTE_DESTINATION');
+    }
+    return absoluteDestination;
+};
+const sanitizeStoredPathsForDb = (req, destination, absoluteDestination) => {
+    if (!absoluteDestination) {
+        return;
+    }
+    const dbDestination = normalizePathForDb(destination || 'uploads');
+    if (req.file) {
+        req.file.destination = dbDestination;
+        req.file.path = normalizePathForDb(path.join(dbDestination, req.file.filename));
+    }
+    if (req.files && !Array.isArray(req.files)) {
+        Object.values(req.files).forEach((files) => {
+            files.forEach((file) => {
+                file.destination = dbDestination;
+                file.path = normalizePathForDb(path.join(dbDestination, file.filename));
+            });
+        });
+    }
+};
 /**
  * Function to configure file filter for Multer.
  *
@@ -222,9 +251,9 @@ const configureFileFilter = (allowedMimeTypes) => {
  * @param options - Configuration options for Multer.
  * @returns Multer instance configured with the provided options.
  */
-const configureMulter = ({ destination, filename, fileTypes = [], customMimeTypes = [], fileSizeLimit, preservePath = false, }) => {
+const configureMulter = ({ destination, absoluteDestination, filename, fileTypes = [], customMimeTypes = [], fileSizeLimit, preservePath = false, }) => {
     try {
-        const storage = configureStorage(destination);
+        const storage = configureStorage(getPhysicalDestination(destination, absoluteDestination));
         // Combine allowed MIME types based on fileTypes array
         let allowedMimeTypes = [];
         if (customMimeTypes.length > 0) {
@@ -263,13 +292,13 @@ const configureMulter = ({ destination, filename, fileTypes = [], customMimeType
  */
 export function uploadSingle(options = {}) {
     try {
-        const destination = options.destination || 'uploads';
+        const storageDestination = getPhysicalDestination(options.destination, options.absoluteDestination);
         const multerInstance = configureMulter(options);
         const middleware = multerInstance.single(options.filename || "file");
         return (req, res, next) => {
             // Make sure the destination directory exists
             try {
-                require('fs').mkdirSync(destination, { recursive: true });
+                mkdirSync(storageDestination, { recursive: true });
             }
             catch (error) {
                 // Directory might already exist, ignore error
@@ -302,6 +331,7 @@ export function uploadSingle(options = {}) {
                     req.fileValidationError = errorMessage;
                     return next(multermateError);
                 }
+                sanitizeStoredPathsForDb(req, options.destination, options.absoluteDestination);
                 next();
             });
         };
@@ -318,7 +348,7 @@ export function uploadSingle(options = {}) {
  */
 export function uploadMultiple(options) {
     try {
-        const destination = options.destination || 'uploads';
+        const storageDestination = getPhysicalDestination(options.destination, options.absoluteDestination);
         // Map fields configuration to multer format
         const fieldConfigs = options.fields.map(field => ({
             name: field.name,
@@ -342,7 +372,8 @@ export function uploadMultiple(options) {
             });
         }
         const multerConfig = {
-            destination,
+            destination: options.destination,
+            absoluteDestination: options.absoluteDestination,
             fileTypes: [],
             customMimeTypes: allowedFileTypes.length > 0 ? allowedFileTypes : [],
             fileSizeLimit: options.fileSizeLimit,
@@ -353,7 +384,7 @@ export function uploadMultiple(options) {
         return (req, res, next) => {
             // Make sure the destination directory exists
             try {
-                require('fs').mkdirSync(destination, { recursive: true });
+                mkdirSync(storageDestination, { recursive: true });
             }
             catch (error) {
                 // Directory might already exist, ignore error
@@ -390,6 +421,7 @@ export function uploadMultiple(options) {
                     req.fileValidationError = errorMessage;
                     return next(multermateError);
                 }
+                sanitizeStoredPathsForDb(req, options.destination, options.absoluteDestination);
                 next();
             });
         };

package/dist/esm/package.json

@@ -1 +1 @@
-{"type": "module"}
+'{"type": "module"}' 

package/index.d.ts

@@ -1,6 +1,6 @@
-// Main type definitions - re-export everything from types directory
-export * from './types/index';
-
-// Default export for CommonJS compatibility
-import multermateDefault from './types/index';
-export default multermateDefault;
+// Main type definitions - re-export everything from types directory
+export * from './types/index';
+
+// Default export for CommonJS compatibility
+import multermateDefault from './types/index';
+export default multermateDefault;

package/index.js

@@ -1,9 +1,9 @@
-// CommonJS entry point
-try {
-  module.exports = require("./dist/cjs/index.js");
-} catch (error) {
-  // Fallback if dist is not built yet
-  throw new Error(
-    'MulterMate: Please run "npm run build" to build the package before using it.'
-  );
-}
+// CommonJS entry point
+try {
+  module.exports = require("./dist/cjs/index.js");
+} catch (error) {
+  // Fallback if dist is not built yet
+  throw new Error(
+    'MulterMate: Please run "npm run build" to build the package before using it.'
+  );
+}

package/index.mjs

@@ -1,6 +1,6 @@
-// ES Module entry point
-export * from "./dist/esm/index.js";
-
-// Default export for better compatibility
-import multermateDefault from "./dist/esm/index.js";
-export default multermateDefault;
+// ES Module entry point
+export * from "./dist/esm/index.js";
+
+// Default export for better compatibility
+import multermateDefault from "./dist/esm/index.js";
+export default multermateDefault;

package/package.json

@@ -1,73 +1,73 @@
-{
-  "name": "multermate",
-  "version": "2.1.0",
-  "description": "A powerful and flexible file upload utility built on top of Multer with TypeScript support, comprehensive file type handling, custom error classes, and universal JavaScript module compatibility",
-  "main": "index.js",
-  "module": "index.mjs",
-  "types": "index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "default": "./dist/cjs/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "dist/",
-    "types/",
-    "index.js",
-    "index.mjs",
-    "index.d.ts",
-    "LICENSE",
-    "readme.md"
-  ],
-  "scripts": {
-    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:types && npm run build:entries",
-    "build:cjs": "tsc --module commonjs --outDir dist/cjs --target ES2018",
-    "build:esm": "tsc --module ES2020 --outDir dist/esm --target ES2020 && echo '{\"type\": \"module\"}' > dist/esm/package.json",
-    "build:types": "tsc --emitDeclarationOnly --outDir types",
-    "build:entries": "node -e \"console.log('Build entries completed')\"",
-    "clean": "node -e \"const fs=require('fs'); ['dist', 'types'].forEach(dir => { try { fs.rmSync(dir, {recursive: true, force: true}); } catch(e){} })\"",
-    "prepublishOnly": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "multer",
-    "file upload",
-    "middleware",
-    "node.js",
-    "typescript",
-    "express",
-    "file handling",
-    "form data",
-    "multipart",
-    "configurable",
-    "file validation",
-    "error handling"
-  ],
-  "author": "Wasim Zaman",
-  "license": "MIT",
-  "dependencies": {
-    "multer": "1.4.5-lts.1",
-    "uuid": "^10.0.0"
-  },
-  "devDependencies": {
-    "@types/express": "^5.0.3",
-    "@types/multer": "^1.4.11",
-    "@types/node": "^20.10.5",
-    "@types/uuid": "^9.0.7",
-    "express": "^5.1.0",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.3.3"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Wasim-Zaman/multermate.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Wasim-Zaman/multermate/issues"
-  },
-  "homepage": "https://github.com/Wasim-Zaman/multermate#readme"
-}
+{
+  "name": "multermate",
+  "version": "2.2.0",
+  "description": "A powerful and flexible file upload utility built on top of Multer with TypeScript support, comprehensive file type handling, custom error classes, and universal JavaScript module compatibility",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "types/",
+    "index.js",
+    "index.mjs",
+    "index.d.ts",
+    "LICENSE",
+    "readme.md"
+  ],
+  "scripts": {
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:types && npm run build:entries",
+    "build:cjs": "tsc --module commonjs --outDir dist/cjs --target ES2018",
+    "build:esm": "tsc --module ES2020 --outDir dist/esm --target ES2020 && echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "build:types": "tsc --emitDeclarationOnly --outDir types",
+    "build:entries": "node -e \"console.log('Build entries completed')\"",
+    "clean": "node -e \"const fs=require('fs'); ['dist', 'types'].forEach(dir => { try { fs.rmSync(dir, {recursive: true, force: true}); } catch(e){} })\"",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "multer",
+    "file upload",
+    "middleware",
+    "node.js",
+    "typescript",
+    "express",
+    "file handling",
+    "form data",
+    "multipart",
+    "configurable",
+    "file validation",
+    "error handling"
+  ],
+  "author": "Wasim Zaman",
+  "license": "MIT",
+  "dependencies": {
+    "multer": "1.4.5-lts.1",
+    "uuid": "^10.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.3",
+    "@types/multer": "^1.4.11",
+    "@types/node": "^20.10.5",
+    "@types/uuid": "^9.0.7",
+    "express": "^5.1.0",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Wasim-Zaman/multermate.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Wasim-Zaman/multermate/issues"
+  },
+  "homepage": "https://github.com/Wasim-Zaman/multermate#readme"
+}