multermate 1.1.0 → 1.1.1

package/dist/cjs/index.js

@@ -0,0 +1,211 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALLOWED_FILE_TYPES = void 0;
+exports.uploadSingle = uploadSingle;
+exports.uploadMultiple = uploadMultiple;
+exports.deleteFile = deleteFile;
+const promises_1 = __importDefault(require("fs/promises"));
+const multer_1 = __importDefault(require("multer"));
+const path_1 = __importDefault(require("path"));
+const uuid_1 = require("uuid");
+// Define allowed MIME types
+const ALLOWED_MIME_TYPES = {
+    images: ["image/jpeg", "image/jpg", "image/png", "image/gif"],
+    videos: ["video/mp4", "video/mpeg", "video/ogg", "video/webm", "video/avi"],
+    pdfs: ["application/pdf"],
+    all: [
+        "image/jpeg",
+        "image/jpg",
+        "image/png",
+        "image/gif",
+        "video/mp4",
+        "video/mpeg",
+        "video/ogg",
+        "video/webm",
+        "video/avi",
+        "application/pdf",
+    ],
+};
+/**
+ * Function to configure storage for Multer.
+ *
+ * @param destination - The destination folder where files will be stored.
+ * @returns Multer storage configuration object.
+ */
+const configureStorage = (destination) => {
+    return multer_1.default.diskStorage({
+        destination: (_req, _file, cb) => {
+            cb(null, destination || "uploads"); // Default folder is "uploads" if none is provided.
+        },
+        filename: (_req, file, cb) => {
+            const sanitizedFilename = file.originalname.replace(/\\/g, "/");
+            const extension = path_1.default.extname(sanitizedFilename);
+            const fieldName = file.fieldname || "file"; // Use the field name as part of the filename.
+            const uniqueName = (0, uuid_1.v4)(); // Generate a unique name using uuid.
+            let fileName = `${uniqueName}-${fieldName}${extension}`;
+            // Replace backslashes with forward slashes in the final filename
+            fileName = fileName.replace(/\\/g, "/");
+            cb(null, fileName); // Set the final filename.
+        },
+    });
+};
+/**
+ * Function to configure file filter for Multer.
+ *
+ * @param allowedMimeTypes - Array of allowed MIME types.
+ * @returns File filter function for Multer.
+ */
+const configureFileFilter = (allowedMimeTypes) => {
+    return (_req, file, cb) => {
+        if (allowedMimeTypes.includes(file.mimetype)) {
+            cb(null, true); // Allow the file if its MIME type is allowed.
+        }
+        else {
+            const error = new Error("Invalid file type. Only specified file types are allowed.");
+            error.code = 'INVALID_FILE_TYPE';
+            cb(error); // Reject the file if its MIME type is not allowed.
+        }
+    };
+};
+/**
+ * Function to configure Multer with the provided options.
+ *
+ * @param options - Configuration options for Multer.
+ * @returns Multer instance configured with the provided options.
+ */
+const configureMulter = ({ destination, filename, fileTypes = [], customMimeTypes = [], fileSizeLimit, preservePath = false, }) => {
+    const storage = configureStorage(destination);
+    // Combine allowed MIME types based on fileTypes array
+    let allowedMimeTypes = [];
+    if (customMimeTypes.length > 0) {
+        // Use custom MIME types if provided
+        allowedMimeTypes = customMimeTypes;
+    }
+    else {
+        // Use default MIME types for specified fileTypes
+        fileTypes.forEach((type) => {
+            if (ALLOWED_MIME_TYPES[type]) {
+                allowedMimeTypes = allowedMimeTypes.concat(ALLOWED_MIME_TYPES[type]);
+            }
+        });
+        // If no specific file types are provided, use all allowed MIME types
+        if (allowedMimeTypes.length === 0) {
+            allowedMimeTypes = ALLOWED_MIME_TYPES.all;
+        }
+    }
+    const fileFilter = configureFileFilter(allowedMimeTypes);
+    return (0, multer_1.default)({
+        storage,
+        fileFilter,
+        limits: { fileSize: fileSizeLimit || 1024 * 1024 * 50 }, // Default 50MB file size limit
+        preservePath,
+    });
+};
+/**
+ * Function to handle a single file upload.
+ *
+ * @param options - Configuration options for the single file upload.
+ * @returns Multer middleware configured for single file upload.
+ */
+function uploadSingle(options = {}) {
+    // Create destination directory if it doesn't exist
+    const destination = options.destination || 'uploads';
+    const multerInstance = configureMulter(options);
+    const middleware = multerInstance.single(options.filename || "file");
+    return (req, res, next) => {
+        // Make sure the destination directory exists
+        require('fs').mkdirSync(destination, { recursive: true });
+        middleware(req, res, (err) => {
+            if (err) {
+                if (err.code === 'LIMIT_FILE_SIZE') {
+                    req.fileValidationError = 'File size limit exceeded';
+                }
+                else if (err.code === 'INVALID_FILE_TYPE') {
+                    req.fileValidationError = 'Invalid file type';
+                }
+                else {
+                    req.fileValidationError = err.message;
+                }
+            }
+            next();
+        });
+    };
+}
+/**
+ * Function to handle multiple file uploads across multiple fields.
+ *
+ * @param options - Configuration options for multiple file uploads.
+ * @returns Multer middleware configured for multiple file uploads.
+ */
+function uploadMultiple(options) {
+    const destination = options.destination || 'uploads';
+    // Map fields configuration to multer format
+    const fieldConfigs = options.fields.map(field => ({
+        name: field.name,
+        maxCount: field.maxCount || 10, // Default maxCount is 10 if not specified.
+    }));
+    let allowedFileTypes = [];
+    options.fields.forEach((field) => {
+        const types = field.fileTypes || [];
+        types.forEach((type) => {
+            if (ALLOWED_MIME_TYPES[type]) {
+                allowedFileTypes = allowedFileTypes.concat(ALLOWED_MIME_TYPES[type]);
+            }
+        });
+    });
+    const multerConfig = {
+        destination,
+        fileTypes: [],
+        customMimeTypes: options.customMimeTypes || [],
+        fileSizeLimit: options.fileSizeLimit,
+        preservePath: options.preservePath
+    };
+    const multerInstance = configureMulter(multerConfig);
+    const middleware = multerInstance.fields(fieldConfigs);
+    return (req, res, next) => {
+        // Make sure the destination directory exists
+        require('fs').mkdirSync(destination, { recursive: true });
+        middleware(req, res, (err) => {
+            if (err) {
+                if (err.code === 'LIMIT_FILE_SIZE') {
+                    req.fileValidationError = 'File size limit exceeded';
+                }
+                else if (err.code === 'INVALID_FILE_TYPE') {
+                    req.fileValidationError = 'Invalid file type';
+                }
+                else {
+                    req.fileValidationError = err.message;
+                }
+            }
+            next();
+        });
+    };
+}
+/**
+ * Utility function to delete a file from the filesystem
+ *
+ * @param filePath - The path to the file that needs to be deleted
+ * @returns Promise that resolves to true if deletion was successful, false otherwise
+ */
+async function deleteFile(filePath) {
+    try {
+        await promises_1.default.unlink(filePath);
+        return true;
+    }
+    catch (error) {
+        console.error(`Error deleting file: ${error.message}`);
+        return false;
+    }
+}
+// Export the allowed file types for reference
+exports.ALLOWED_FILE_TYPES = Object.keys(ALLOWED_MIME_TYPES);
+// Export your functions
+exports.default = {
+    uploadSingle,
+    uploadMultiple,
+    deleteFile,
+    ALLOWED_FILE_TYPES: exports.ALLOWED_FILE_TYPES
+};

package/dist/esm/index.js

@@ -0,0 +1,202 @@
+import fs from 'fs/promises';
+import multer from 'multer';
+import path from 'path';
+import { v4 as uuidv4 } from 'uuid';
+// Define allowed MIME types
+const ALLOWED_MIME_TYPES = {
+    images: ["image/jpeg", "image/jpg", "image/png", "image/gif"],
+    videos: ["video/mp4", "video/mpeg", "video/ogg", "video/webm", "video/avi"],
+    pdfs: ["application/pdf"],
+    all: [
+        "image/jpeg",
+        "image/jpg",
+        "image/png",
+        "image/gif",
+        "video/mp4",
+        "video/mpeg",
+        "video/ogg",
+        "video/webm",
+        "video/avi",
+        "application/pdf",
+    ],
+};
+/**
+ * Function to configure storage for Multer.
+ *
+ * @param destination - The destination folder where files will be stored.
+ * @returns Multer storage configuration object.
+ */
+const configureStorage = (destination) => {
+    return multer.diskStorage({
+        destination: (_req, _file, cb) => {
+            cb(null, destination || "uploads"); // Default folder is "uploads" if none is provided.
+        },
+        filename: (_req, file, cb) => {
+            const sanitizedFilename = file.originalname.replace(/\\/g, "/");
+            const extension = path.extname(sanitizedFilename);
+            const fieldName = file.fieldname || "file"; // Use the field name as part of the filename.
+            const uniqueName = uuidv4(); // Generate a unique name using uuid.
+            let fileName = `${uniqueName}-${fieldName}${extension}`;
+            // Replace backslashes with forward slashes in the final filename
+            fileName = fileName.replace(/\\/g, "/");
+            cb(null, fileName); // Set the final filename.
+        },
+    });
+};
+/**
+ * Function to configure file filter for Multer.
+ *
+ * @param allowedMimeTypes - Array of allowed MIME types.
+ * @returns File filter function for Multer.
+ */
+const configureFileFilter = (allowedMimeTypes) => {
+    return (_req, file, cb) => {
+        if (allowedMimeTypes.includes(file.mimetype)) {
+            cb(null, true); // Allow the file if its MIME type is allowed.
+        }
+        else {
+            const error = new Error("Invalid file type. Only specified file types are allowed.");
+            error.code = 'INVALID_FILE_TYPE';
+            cb(error); // Reject the file if its MIME type is not allowed.
+        }
+    };
+};
+/**
+ * Function to configure Multer with the provided options.
+ *
+ * @param options - Configuration options for Multer.
+ * @returns Multer instance configured with the provided options.
+ */
+const configureMulter = ({ destination, filename, fileTypes = [], customMimeTypes = [], fileSizeLimit, preservePath = false, }) => {
+    const storage = configureStorage(destination);
+    // Combine allowed MIME types based on fileTypes array
+    let allowedMimeTypes = [];
+    if (customMimeTypes.length > 0) {
+        // Use custom MIME types if provided
+        allowedMimeTypes = customMimeTypes;
+    }
+    else {
+        // Use default MIME types for specified fileTypes
+        fileTypes.forEach((type) => {
+            if (ALLOWED_MIME_TYPES[type]) {
+                allowedMimeTypes = allowedMimeTypes.concat(ALLOWED_MIME_TYPES[type]);
+            }
+        });
+        // If no specific file types are provided, use all allowed MIME types
+        if (allowedMimeTypes.length === 0) {
+            allowedMimeTypes = ALLOWED_MIME_TYPES.all;
+        }
+    }
+    const fileFilter = configureFileFilter(allowedMimeTypes);
+    return multer({
+        storage,
+        fileFilter,
+        limits: { fileSize: fileSizeLimit || 1024 * 1024 * 50 }, // Default 50MB file size limit
+        preservePath,
+    });
+};
+/**
+ * Function to handle a single file upload.
+ *
+ * @param options - Configuration options for the single file upload.
+ * @returns Multer middleware configured for single file upload.
+ */
+export function uploadSingle(options = {}) {
+    // Create destination directory if it doesn't exist
+    const destination = options.destination || 'uploads';
+    const multerInstance = configureMulter(options);
+    const middleware = multerInstance.single(options.filename || "file");
+    return (req, res, next) => {
+        // Make sure the destination directory exists
+        require('fs').mkdirSync(destination, { recursive: true });
+        middleware(req, res, (err) => {
+            if (err) {
+                if (err.code === 'LIMIT_FILE_SIZE') {
+                    req.fileValidationError = 'File size limit exceeded';
+                }
+                else if (err.code === 'INVALID_FILE_TYPE') {
+                    req.fileValidationError = 'Invalid file type';
+                }
+                else {
+                    req.fileValidationError = err.message;
+                }
+            }
+            next();
+        });
+    };
+}
+/**
+ * Function to handle multiple file uploads across multiple fields.
+ *
+ * @param options - Configuration options for multiple file uploads.
+ * @returns Multer middleware configured for multiple file uploads.
+ */
+export function uploadMultiple(options) {
+    const destination = options.destination || 'uploads';
+    // Map fields configuration to multer format
+    const fieldConfigs = options.fields.map(field => ({
+        name: field.name,
+        maxCount: field.maxCount || 10, // Default maxCount is 10 if not specified.
+    }));
+    let allowedFileTypes = [];
+    options.fields.forEach((field) => {
+        const types = field.fileTypes || [];
+        types.forEach((type) => {
+            if (ALLOWED_MIME_TYPES[type]) {
+                allowedFileTypes = allowedFileTypes.concat(ALLOWED_MIME_TYPES[type]);
+            }
+        });
+    });
+    const multerConfig = {
+        destination,
+        fileTypes: [],
+        customMimeTypes: options.customMimeTypes || [],
+        fileSizeLimit: options.fileSizeLimit,
+        preservePath: options.preservePath
+    };
+    const multerInstance = configureMulter(multerConfig);
+    const middleware = multerInstance.fields(fieldConfigs);
+    return (req, res, next) => {
+        // Make sure the destination directory exists
+        require('fs').mkdirSync(destination, { recursive: true });
+        middleware(req, res, (err) => {
+            if (err) {
+                if (err.code === 'LIMIT_FILE_SIZE') {
+                    req.fileValidationError = 'File size limit exceeded';
+                }
+                else if (err.code === 'INVALID_FILE_TYPE') {
+                    req.fileValidationError = 'Invalid file type';
+                }
+                else {
+                    req.fileValidationError = err.message;
+                }
+            }
+            next();
+        });
+    };
+}
+/**
+ * Utility function to delete a file from the filesystem
+ *
+ * @param filePath - The path to the file that needs to be deleted
+ * @returns Promise that resolves to true if deletion was successful, false otherwise
+ */
+export async function deleteFile(filePath) {
+    try {
+        await fs.unlink(filePath);
+        return true;
+    }
+    catch (error) {
+        console.error(`Error deleting file: ${error.message}`);
+        return false;
+    }
+}
+// Export the allowed file types for reference
+export const ALLOWED_FILE_TYPES = Object.keys(ALLOWED_MIME_TYPES);
+// Export your functions
+export default {
+    uploadSingle,
+    uploadMultiple,
+    deleteFile,
+    ALLOWED_FILE_TYPES
+};

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type": "module"}

package/index.d.ts

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

package/index.js

@@ -0,0 +1,2 @@
+// CommonJS entry point
+module.exports = require("./dist/cjs/index");

package/index.mjs

@@ -0,0 +1,15 @@
+// ES Module entry point
+export * from "./dist/esm/index.js";
+
+// This pattern ensures better compatibility with various Node.js environments
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const multermate = require("./dist/cjs/index.js");
+
+// Re-export everything from the CJS module
+export const uploadSingle = multermate.uploadSingle;
+export const uploadMultiple = multermate.uploadMultiple;
+export const deleteFile = multermate.deleteFile;
+
+// Default export
+export default multermate;

package/package.json

@@ -1,23 +1,59 @@
 {
   "name": "multermate",
-  "version": "1.1.0",
-  "description": "A flexible and customizable npm package for configuring Multer",
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.mjs",
+  "version": "1.1.1",
+  "description": "A flexible and customizable file upload utility built on top of Multer with TypeScript support",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/",
+    "types/",
+    "index.js",
+    "index.mjs",
+    "index.d.ts"
+  ],
   "scripts": {
-    "build:cjs": "babel src --out-dir dist --extensions \".js\" --plugins=@babel/plugin-transform-modules-commonjs",
-    "build:esm": "babel src --out-dir dist --extensions \".js\"",
-    "build": "npm run build:cjs && npm run build:esm",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc --module commonjs --outDir dist/cjs",
+    "build:esm": "tsc --module ES2020 --outDir dist/esm && echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "build:types": "tsc --emitDeclarationOnly",
+    "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",
+    "configurable"
+  ],
+  "author": "Wasim Zaman",
+  "license": "MIT",
   "dependencies": {
     "multer": "1.4.5-lts.1",
     "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.25.6",
-    "@babel/core": "^7.25.2",
-    "@babel/plugin-transform-modules-commonjs": "^7.24.8",
-    "@babel/preset-env": "^7.25.4"
-  }
+    "@types/multer": "^1.4.11",
+    "@types/node": "^20.10.5",
+    "@types/uuid": "^9.0.7",
+    "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"
 }