Overview + installation

Before starting you need to be authenticated, since the package is hosted within a private npm registry, the authentication steps are described before.

Authentication

The Storage Manager Package is a generic storage solution built with NestJS, designed to provide flexible and extendable storage strategies for various providers, including Local, S3, and MinIO. This package simplifies file management with features such as uploading, generating URLs, and creating pre-signed URLs.

Quick Start

1. Import the Module:

   Use the StorageManagerModule.register method to configure the storage strategy during module registration.

import { StorageManagerModule } from 'storage-manager-package';

@Module({
    imports: [
        StorageManagerModule.register({
            useFactory: async () => ({
                provider: 'LOCAL',
                uploadDir: './uploads',
                baseUrl: 'http://localhost:3000/uploads',
            }),
        }),
    ],
})
export class AppModule {}

2. Inject the Service:

Use the StorageManagerService to interact with the storage system

import { StorageManagerService } from 'storage-manager-package';

@Injectable()
export class FileService {
    constructor(private readonly storageService: StorageManagerService) {}

    async uploadFile(file: UploadedFile) {
        return this.storageService.upload(file);
    }
}

Features

1. Upload Files

Upload a single file or multiple files to the storage.

async upload(file: UploadedFile | UploadedFile[]): Promise<StorageFile | StorageFile[]>;

Example:

const file: UploadedFile = {
    buffer: Buffer.from('file content'),
    originalName: 'example.txt',
    mimeType: 'text/plain',
    size: 12345,
};

const result = await storageService.upload(file);
console.log(result);

2. Get File URL

Retrieve the URL of a stored file using its ID.

async getUrl(fileId: string): Promise<string>;

Example:

const fileUrl = await storageService.getUrl('file-id-123');

3. Delete Files

Delete a file by its ID.

async delete(fileId: string): Promise<void>;

Example:

await storageService.delete('file-id-123');

4. Generate Pre-signed URLs

Create a pre-signed URL for file operations (e.g., read or write).

async createPresignedUrl(options: PresignedUrlOptions): Promise<string>;

Example:

const presignedUrl = await storageService.createPresignedUrl({
    operation: PresignedUrlOperation.WRITE,
    path: 'example.txt',
    expiresIn: 3600,
    contentType: 'text/plain',
});
console.log(presignedUrl);

Install the package in your app:

npm i @tradinos/cms-backend-storage-manager