Storage Configuration

Overview

This module provides types and configurations to define the storage provider and its settings. It supports multiple storage options, including Local, S3, and MinIO, enabling flexible integration with different storage backends.

Types

1. StorageProvider

Specifies the type of storage backend.

Definition

export type StorageProvider = 'LOCAL' | 'S3' | 'MINIO';

Values

• LOCAL: Indicates local file storage.

• S3: Refers to Amazon S3 cloud storage.

• MINIO: Denotes MinIO, an S3-compatible storage service

2. LocalStorageConfig

Defines configuration for local file storage.

Definition

export type LocalStorageConfig = {
    provider: 'LOCAL';
    uploadDir: string;
    baseUrl: string;
};

Properties

• provider: Always set to 'LOCAL' for local storage.

• uploadDir: Directory path where files will be stored locally.

• baseUrl: Base URL used to access files (e.g., http://example.com/uploads).

Example

const localConfig: LocalStorageConfig = {
    provider: 'LOCAL',
    uploadDir: '/uploads',
    baseUrl: 'http://localhost:3000',
};

3. S3StorageConfig

Defines configuration for Amazon S3 storage.

Definition

export type S3StorageConfig = {
    provider: 'S3';
    accessKeyId: string;
    secretAccessKey: string;
    region: string;
    bucket: string;
};

Properties

• provider: Always set to 'S3' for Amazon S3 storage.

• accessKeyId: AWS access key ID.

• secretAccessKey: AWS secret access key.

• region: AWS region where the S3 bucket resides.

• bucket: Name of the S3 bucket.

Example

const s3Config: S3StorageConfig = {
    provider: 'S3',
    accessKeyId: 'your-access-key-id',
    secretAccessKey: 'your-secret-access-key',
    region: 'us-west-1',
    bucket: 'my-bucket',
};

4. MinioStorageConfig

Defines configuration for MinIO, an S3-compatible storage service.

Definition

export type MinioStorageConfig = {
    provider: 'MINIO';
    endPoint: string;
    port?: number;
    useSSL: boolean;
    accessKey: string;
    secretKey: string;
    bucket: string;
};

Properties

• provider: Always set to 'MINIO' for MinIO storage.

• endPoint: Hostname or IP address of the MinIO server.

• port?: (Optional) Port number of the MinIO server.

• useSSL: Indicates whether SSL/TLS should be used for communication.

• accessKey: MinIO access key.

• secretKey: MinIO secret key.

• bucket: Name of the storage bucket.

Example

const minioConfig: MinioStorageConfig = {
    provider: 'MINIO',
    endPoint: 'minio.example.com',
    port: 9000,
    useSSL: true,
    accessKey: 'your-access-key',
    secretKey: 'your-secret-key',
    bucket: 'my-bucket',
};

5. StorageConfig

A union type that combines all storage configuration types.

Definition

export type StorageConfig =
    | MinioStorageConfig
    | LocalStorageConfig
    | S3StorageConfig;

Usage

The StorageConfig type allows for flexible assignment depending on the chosen provider.

Example

let storageConfig: StorageConfig;

storageConfig = {
    provider: 'LOCAL',
    uploadDir: '/uploads',
    baseUrl: 'http://localhost:3000',
};

Interfaces

1. AsyncStorageManagerModuleFactoryOptions

Defines the configuration for asynchronously loading storage settings.

Definition

export interface AsyncStorageManagerModuleFactoryOptions
    extends Pick<ModuleMetadata, 'imports'> {
    useFactory: (...args: any[]) => Promise<StorageConfig> | StorageConfig;
    inject?: any[];
}

Properties

• imports: (Optional) Modules to import for dependency injection.

• useFactory: A factory function to provide the StorageConfig either synchronously or asynchronously.

• inject?: (Optional) Dependencies to inject into the factory function.

Example

const asyncOptions: AsyncStorageManagerModuleFactoryOptions = {
    imports: [ConfigModule],
    useFactory: async (configService: ConfigService) => {
        return {
            provider: 'S3',
            accessKeyId: configService.get('S3_ACCESS_KEY_ID'),
            secretAccessKey: configService.get('S3_SECRET_ACCESS_KEY'),
            region: configService.get('S3_REGION'),
            bucket: configService.get('S3_BUCKET'),
        };
    },
    inject: [ConfigService],
};