Common Image Upload Package

Overview

The Common Image Upload Package provides functionality to upload multiple image files to various storage services seamlessly. Supported storage platforms include:

• Local Server
• Google Cloud Platform (GCP)
• Amazon Web Services (AWS) (Currently Under Maintenance)
• Azure (Currently Under Maintenance)

This package also supports optional image compression by specifying a dynamic quality ratio based on image size.

Installation

To install the package, use the following command:

npm install nest-image-upload

Ensure that you have the necessary dependencies installed based on your storage provider.

Configuration and Usage

To enable image uploading, register the ImageUploaderModule in your application module with the desired storage configuration.

Local Server Storage

import { ImageUploaderModule } from 'nest-image-uploader';

@Module({
  imports: [
    ImageUploaderModule.register({
      storageType: 'local',
      localPath: 'path-to-upload-folder',
    }),
  ],
})
export class AppModule {}

Google Cloud Platform (GCP) Storage

import { ImageUploaderModule } from 'nest-image-uploader';

@Module({
  imports: [
    ImageUploaderModule.register({
      storageType: 'gcp',
      gcp: {
        bucketName: 'cloud-bucket-name',
        credentials: 'gcp-credentials-json-object',
      },
    }),
  ],
})
export class AppModule {}

Amazon Web Services (AWS) S3 Storage (Under Maintenance)

import { ImageUploaderModule } from 'nest-image-uploader';

@Module({
  imports: [
    ImageUploaderModule.register({
      storageType: 's3',
      s3: {
        accessKeyId: 'your-access-key-id',
        secretAccessKey: 'your-secret-access-key',
        region: 'your-region',
        bucket: 'your-bucket-name',
      },
    }),
  ],
})
export class AppModule {}

Microsoft Azure Blob Storage (Under Maintenance)

import { ImageUploaderModule } from 'nest-image-uploader';

@Module({
  imports: [
    ImageUploaderModule.register({
      storageType: 'azure',
      azure: {
        connectionString: 'azure-connection-string',
        containerName: 'storage-container-name',
      },
    }),
  ],
})
export class AppModule {}

Dynamic Image Compression

You can enable dynamic image compression by specifying quality ratios based on file size:

import { ImageUploaderModule } from 'nest-image-uploader';

@Module({
  imports: [
    ImageUploaderModule.register({
      // Other storage config
      compressionNeeded: true,
      compressionRatio: [
        { fileSize: [0, 500000], ratio: 90 }, // 90% quality for files ≤ 500KB
        { fileSize: [500001, 2000000], ratio: 70 }, // 70% quality for files between 500KB - 2MB
        { fileSize: [2000001, Infinity], ratio: 50 }, // 50% quality for files > 2MB
      ],
    }),
  ],
})
export class AppModule {}

Upload Functionality

Once the module is registered, you can inject the ImageUploaderService into your service class to handle image uploads.

@Injectable()
export class YourService {
  constructor(private readonly imageUploaderService: ImageUploaderService) {}

  async uploadImage(files: Express.Multer.File[]): Promise<string[]> {
    return this.imageUploaderService.upload(files);
  }
}

Features

• ✅ Supports multiple storage providers
• ✅ Modular and scalable integration for NestJS applications
• ✅ Easy configuration for different cloud platforms
• ✅ Handles multiple file uploads efficiently
• ✅ Supports conditional image compression based on file size ranges

Roadmap

• ✅ Support for Local and GCP storage
• 🔧 AWS and Azure support (Currently under maintenance)
• 🚀 Future enhancements including image processing and metadata handling