Multer Mate

A robust and flexible file upload utility built on top of Multer, providing advanced file handling capabilities for Node.js applications.

Features

• 📁 Flexible file storage configuration
• 🔒 Built-in file type validation
• 📦 Single and multiple file uploads
• 🎯 Field-specific file type restrictions
• 🗑️ File deletion utility
• ⚡ Configurable file size limits
• 🎨 Custom MIME type support
• 🔄 Unique file naming with UUID
• 🛡️ Path sanitization
• 📝 Comprehensive error handling

Installation

npm install multermate

Basic Usage

const { uploadSingle, uploadMultiple, deleteFile } = require("multermate");

Upload Configurations

Single File Upload

// Basic single file upload
app.post("/upload", uploadSingle(), (req, res) => {
  res.json({ file: req.file });
});

// Advanced single file upload
app.post(
  "/upload/advanced",
  uploadSingle({
    destination: "uploads/images",
    filename: "profile",
    fileTypes: ["images"],
    fileSizeLimit: 5 * 1024 * 1024, // 5MB
    preservePath: false,
  }),
  (req, res) => {
    res.json({ file: req.file });
  }
);

Multiple Files Upload

// Multiple fields with different configurations
app.post(
  "/upload/multiple",
  uploadMultiple({
    fields: [
      {
        name: "avatar",
        maxCount: 1,
        fileTypes: ["images"],
      },
      {
        name: "documents",
        maxCount: 5,
        fileTypes: ["pdfs"],
      },
      {
        name: "media",
        maxCount: 3,
        fileTypes: ["images", "videos"],
      },
    ],
    destination: "uploads/mixed",
    fileSizeLimit: 10 * 1024 * 1024, // 10MB per file
  }),
  (req, res) => {
    res.json({ files: req.files });
  }
);

Custom MIME Types

app.post(
  "/upload/custom",
  uploadSingle({
    destination: "uploads/custom",
    customMimeTypes: [
      "application/vnd.ms-excel",
      "application/json",
      "text/csv",
    ],
    fileSizeLimit: 1024 * 1024, // 1MB
  })
);

File Deletion

// Simple file deletion
app.delete("/files/:filename", async (req, res) => {
  const isDeleted = await deleteFile(`uploads/${req.params.filename}`);
  res.json({ success: isDeleted });
});

// Advanced file deletion with error handling
app.delete("/files/:type/:filename", async (req, res) => {
  try {
    const filePath = path.join("uploads", req.params.type, req.params.filename);
    const isDeleted = await deleteFile(filePath);

    if (isDeleted) {
      res.json({
        success: true,
        message: "File deleted successfully",
      });
    } else {
      res.status(404).json({
        success: false,
        message: "File not found or unable to delete",
      });
    }
  } catch (error) {
    res.status(500).json({
      success: false,
      message: error.message,
    });
  }
});

API Reference

uploadSingle(options)

Configures single file upload with the following options:

| Option | Type | Default | Description | | --------------- | -------- | --------- | ---------------------- | | destination | string | 'uploads' | Upload directory path | | filename | string | 'file' | Form field name | | fileTypes | string[] | ['all'] | Allowed file types | | customMimeTypes | string[] | [] | Custom MIME types | | fileSizeLimit | number | 50MB | Max file size in bytes | | preservePath | boolean | false | Preserve original path |

uploadMultiple(options)

Configures multiple file uploads with the following options:

| Option | Type | Default | Description | | --------------- | -------- | --------- | -------------------- | | fields | Field[] | [] | Field configurations | | destination | string | 'uploads' | Upload directory | | customMimeTypes | string[] | [] | Custom MIME types | | fileSizeLimit | number | 50MB | Max file size | | preservePath | boolean | false | Preserve paths |

Field Configuration

| Option | Type | Default | Description | | --------- | -------- | ------- | --------------------- | | name | string | - | Field name (required) | | maxCount | number | 10 | Max files per field | | fileTypes | string[] | ['all'] | Allowed types |

deleteFile(filePath)

Deletes a file from the filesystem:

| Parameter | Type | Description | | --------- | ---------------- | ---------------- | | filePath | string | Path to file | | Returns | Promise | Deletion success |

Supported File Types

const ALLOWED_FILE_TYPES = {
  images: ["jpeg", "jpg", "png", "gif"],
  videos: ["mp4", "mpeg", "ogg", "webm", "avi"],
  pdfs: ["pdf"],
};

Error Handling

app.post("/upload", uploadSingle(), (req, res) => {
  try {
    // File size validation
    if (req.fileValidationError) {
      return res.status(400).json({
        error: req.fileValidationError,
      });
    }

    // File existence check
    if (!req.file) {
      return res.status(400).json({
        error: "No file uploaded",
      });
    }

    // Success response
    res.json({
      success: true,
      file: {
        filename: req.file.filename,
        path: req.file.path,
        size: req.file.size,
        mimetype: req.file.mimetype,
      },
    });
  } catch (error) {
    res.status(500).json({
      error: error.message,
    });
  }
});

Best Practices

1. Always implement proper error handling
2. Set appropriate file size limits
3. Validate file types on the server
4. Use custom storage destinations for different file types
5. Implement file cleanup mechanisms
6. Consider implementing file type verification beyond MIME types

License

MIT

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

Author

Your Name

Support

For support, please open an issue in the GitHub repository.