@zola_do/seaweed 0.1.9 → 0.1.13

package/README.md

@@ -0,0 +1,80 @@
+# @zola_do/seaweed
+
+AWS S3-compatible object storage for NestJS (SeaweedFS, MinIO, or AWS S3).
+
+## Installation
+
+```bash
+# Install individually
+npm install @zola_do/seaweed
+
+# Or via meta package
+npm install @zola_do/nestjs-shared
+```
+
+## Usage
+
+### Module Setup
+
+```typescript
+import { Module } from '@nestjs/common';
+import { StorageModule } from '@zola_do/seaweed';
+
+@Module({
+  imports: [StorageModule],
+})
+export class AppModule {}
+```
+
+### Uploading Files
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { StorageService } from '@zola_do/seaweed';
+
+@Injectable()
+export class FileService {
+  constructor(private readonly storageService: StorageService) {}
+
+  async upload(file: Express.Multer.File, bucketName: string) {
+    return await this.storageService.upload(file, bucketName);
+    // Returns FileInfo: { filepath, bucketName, contentType, originalname }
+  }
+}
+```
+
+### Downloading Files
+
+```typescript
+await this.storageService.download(fileInfo, response);
+// Streams file to Express Response with appropriate headers
+```
+
+### Presigned URLs
+
+```typescript
+// Upload
+const uploadUrl = await this.storageService.generatePresignedUploadUrl(fileInfo);
+
+// Download
+const downloadUrl = await this.storageService.generatePresignedDownloadUrl(fileInfo);
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `AWS_ACCESS_KEY_ID` | S3/MinIO access key |
+| `AWS_SECRET_ACCESS_KEY` | S3/MinIO secret key |
+| `AWS_ENDPOINT` | S3-compatible endpoint URL |
+| `PRESIGNED_URL_EXPIRATION` | Presigned URL expiry in seconds |
+
+## Exports
+
+- `StorageModule` — Register the storage module
+- `StorageService` — Upload, download, presigned URLs
+- Types and exceptions for storage operations
+
+## Related Packages
+
+- [@zola_do/minio](../minio) — Alternative MinIO-specific module

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/seaweed",
-  "version": "0.1.9",
+  "version": "0.1.13",
   "description": "AWS S3-compatible 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"