@zola_do/minio 0.1.9 → 0.1.13

package/README.md

@@ -0,0 +1,103 @@
+# @zola_do/minio
+
+MinIO object storage integration for NestJS applications.
+
+## Installation
+
+```bash
+# Install individually
+npm install @zola_do/minio
+
+# Or via meta package
+npm install @zola_do/nestjs-shared
+```
+
+**Note:** If installation fails due to `nestjs-minio-client` postinstall script, use `npm install --ignore-scripts`.
+
+## Usage
+
+### Module Setup
+
+```typescript
+import { Module } from '@nestjs/common';
+import { MinIoModule } from '@zola_do/minio';
+
+@Module({
+  imports: [MinIoModule],
+})
+export class AppModule {}
+```
+
+### Uploading Files
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { MinIOService, BucketNameEnum } from '@zola_do/minio';
+
+@Injectable()
+export class FileUploadService {
+  constructor(private readonly minioService: MinIOService) {}
+
+  async uploadFile(file: Express.Multer.File, bucketName: string) {
+    return await this.minioService.upload(file, bucketName);
+    // Returns { filepath, bucketName, contentType, originalname }
+  }
+
+  async uploadBuffer(
+    buffer: Buffer,
+    originalname: string,
+    mimetype: string,
+    bucketName: string,
+  ) {
+    return await this.minioService.uploadBuffer(
+      buffer,
+      originalname,
+      mimetype,
+      bucketName,
+    );
+  }
+}
+```
+
+### Presigned URLs
+
+Generate presigned upload URLs for client-side uploads:
+
+```typescript
+const { presignedUrl, file } = await this.minioService.generatePresignedUploadUrl(
+  { originalname: 'document.pdf', contentType: 'application/pdf' },
+  'documents/',
+);
+// Send presignedUrl to client; they upload directly to MinIO
+```
+
+### Downloading Files
+
+```typescript
+const stream = await this.minioService.downloadBuffer({
+  filepath: 'path/to/file.pdf',
+  bucketName: BucketNameEnum.MEGP,
+});
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `MINIO_ENDPOINT` | MinIO server endpoint |
+| `MINIO_PORT` | MinIO port (default: 443) |
+| `MINIO_USESSL` | Use SSL (default: true) |
+| `MINIO_ACCESSKEY` | MinIO access key |
+| `MINIO_SECRETKEY` | MinIO secret key |
+| `DURATION_OF_PRE_SIGNED_DOCUMENT` | Presigned URL expiry in seconds (default: 120) |
+
+## Exports
+
+- `MinIoModule` — Register the MinIO module
+- `MinIOService` — Upload, download, presigned URLs
+- `BucketNameEnum` — Bucket name constants
+- `PresignedFileUploadDto` — DTO for presigned upload responses
+
+## Related Packages
+
+- [@zola_do/document-manipulator](../document-manipulator) — Uses MinIO for document storage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/minio",
-  "version": "0.1.9",
+  "version": "0.1.13",
   "description": "MinIO object storage for NestJS",
   "author": "zolaDO",
   "license": "ISC",
@@ -15,7 +15,10 @@
       "default": "./dist/index.js"
     }
   },
-  "files": ["dist", "README.md"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
     "build": "rimraf dist && tsc",
     "prepublishOnly": "npm run build"