@zola_do/seaweed 0.2.5 → 0.2.7

package/README.md

@@ -1,7 +1,21 @@
 # @zola_do/seaweed
 
+[![npm version](https://img.shields.io/npm/v/@zola_do/seaweed.svg)](https://www.npmjs.com/package/@zola_do/seaweed)
+[![npm downloads](https://img.shields.io/npm/dm/@zola_do/seaweed.svg)](https://www.npmjs.com/package/@zola_do/seaweed)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
+
 AWS S3-compatible object storage for NestJS (SeaweedFS, MinIO, or AWS S3).
 
+## Overview
+
+`@zola_do/seaweed` provides a unified interface for S3-compatible storage:
+
+- **Upload** — Files, buffers, and streams
+- **Download** — Streaming and buffered downloads
+- **Presigned URLs** — Secure upload/download links
+- **Abstract S3 Class** — Implement custom providers
+- **TypeScript Types** — Full type safety
+
 ## Installation
 
 ```bash
@@ -12,25 +26,29 @@ npm install @zola_do/seaweed
 npm install @zola_do/nestjs-shared
 ```
 
-## Recommended Imports
-
-`@zola_do/seaweed` root imports remain fully supported for backward compatibility.
-For new code, prefer focused subpath imports:
+### Dependencies
 
-```typescript
-import { StorageModule } from '@zola_do/seaweed/module';
-import { StorageService, AwsS3 } from '@zola_do/seaweed/services';
-import type { FileInfo } from '@zola_do/seaweed/types';
-import { FileNotFoundException } from '@zola_do/seaweed/exceptions';
+```bash
+npm install @aws-sdk/client-s3 @aws-sdk/s3-request-presigner
 ```
 
-## Usage
+## Quick Start
 
-### Module Setup
+### 1. Configure Environment
+
+```bash
+# .env
+AWS_ACCESS_KEY_ID=your-access-key
+AWS_SECRET_ACCESS_KEY=your-secret-key
+AWS_ENDPOINT=https://your-s3-endpoint.com
+AWS_REGION=us-east-1
+```
+
+### 2. Register Module
 
 ```typescript
-import { Module } from '@nestjs/common';
-import { StorageModule } from '@zola_do/seaweed';
+import { Module } from "@nestjs/common";
+import { StorageModule } from "@zola_do/seaweed";
 
 @Module({
   imports: [StorageModule],
@@ -38,61 +56,373 @@ import { StorageModule } from '@zola_do/seaweed';
 export class AppModule {}
 ```
 
-### Uploading Files
+### 3. Use Storage Service
 
 ```typescript
-import { Injectable } from '@nestjs/common';
-import { StorageService } from '@zola_do/seaweed';
+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) {
+  async uploadFile(file: Express.Multer.File, bucketName: string) {
     return await this.storageService.upload(file, bucketName);
-    // Returns FileInfo: { filepath, bucketName, contentType, originalname }
   }
+
+  async downloadFile(fileInfo: FileInfo, response: Response) {
+    await this.storageService.download(fileInfo, response);
+  }
+}
+```
+
+## Storage Architecture
+
+```
+┌─────────────────────────────────────────────────────────────────────┐
+│                      Storage Flow                                    │
+├─────────────────────────────────────────────────────────────────────┤
+│                                                                      │
+│  ┌──────────┐                                                       │
+│  │  Client  │                                                       │
+│  └────┬─────┘                                                       │
+│       │                                                             │
+│       │ 1. Request presigned URL                                    │
+│       ├─────────────────────────────────────┐                       │
+│       │                                     │                       │
+│       ▼                                     ▼                       │
+│  ┌───────────────┐                    ┌───────────────┐             │
+│  │  Controller   │                    │   Storage     │             │
+│  │  GET /upload  │                    │   Service     │             │
+│  └───────┬───────┘                    └───────┬───────┘             │
+│          │                                     │                     │
+│          │ 2. Generate presigned URL           │                     │
+│          ├─────────────────────────────────────┤                     │
+│          │                                     │                     │
+│          ▼                                     ▼                     │
+│  ┌───────────────┐                    ┌───────────────┐             │
+│  │  Response     │                    │   AWS SDK     │             │
+│  │  { url }      │                    │   S3Client    │             │
+│  └───────────────┘                    └───────┬───────┘             │
+│                                                │                     │
+│                                                │                     │
+│          ┌─────────────────────────────────────┤                     │
+│          │                                     │                     │
+│          ▼                                     ▼                     │
+│  ┌───────────────┐                    ┌───────────────┐             │
+│  │  Direct PUT   │───────────────────► │   S3 Bucket   │             │
+│  │  to S3        │   3. Upload file    │   (any S3)    │             │
+│  └───────────────┘                    └───────────────┘             │
+│                                                                      │
+└─────────────────────────────────────────────────────────────────────┘
+```
+
+## Upload Operations
+
+### File Upload
+
+```typescript
+async uploadFile(file: Express.Multer.File, bucketName: string) {
+  const result = await this.storageService.upload(file, bucketName);
+  return result;
+  // Returns: { filepath, bucketName, contentType, originalname }
+}
+```
+
+### Buffer Upload
+
+```typescript
+async uploadBuffer(
+  buffer: Buffer,
+  originalname: string,
+  mimetype: string,
+  bucketName: string,
+) {
+  const result = await this.storageService.uploadBuffer(
+    buffer,
+    originalname,
+    mimetype,
+    bucketName,
+  );
+  return result;
 }
 ```
 
-### Downloading Files
+### Stream Upload
 
 ```typescript
-await this.storageService.download(fileInfo, response);
-// Streams file to Express Response with appropriate headers
+async uploadStream(
+  stream: ReadableStream,
+  filename: string,
+  mimetype: string,
+  bucketName: string,
+) {
+  return await this.storageService.uploadStream(
+    stream,
+    filename,
+    mimetype,
+    bucketName,
+  );
+}
 ```
 
-### Presigned URLs
+## Download Operations
+
+### Download to Response
 
 ```typescript
-// Upload
-const uploadUrl = await this.storageService.generatePresignedUploadUrl(fileInfo);
+async downloadToResponse(fileInfo: FileInfo, response: Response) {
+  response.setHeader('Content-Type', fileInfo.contentType);
+  response.setHeader('Content-Disposition', `attachment; filename="${fileInfo.originalname}"`);
+
+  await this.storageService.download(fileInfo, response);
+}
+```
+
+### Download to Buffer
 
-// Download
-const downloadUrl = await this.storageService.generatePresignedDownloadUrl(fileInfo);
+```typescript
+async downloadToBuffer(fileInfo: FileInfo): Promise<Buffer> {
+  return await this.storageService.downloadBuffer(fileInfo);
+}
+```
+
+## Presigned URLs
+
+### Generate Upload URL
+
+```typescript
+async getUploadUrl(fileInfo: FileInfo): Promise<string> {
+  const presignedUrl = await this.storageService.generatePresignedUploadUrl(
+    fileInfo,
+    3600, // URL expires in 1 hour
+  );
+  return presignedUrl;
+}
+```
+
+### Generate Download URL
+
+```typescript
+async getDownloadUrl(fileInfo: FileInfo): Promise<string> {
+  const downloadUrl = await this.storageService.generatePresignedDownloadUrl(
+    fileInfo,
+    3600, // URL expires in 1 hour
+  );
+  return downloadUrl;
+}
+```
+
+### Usage with Client
+
+```typescript
+// Server generates URL
+const { presignedUrl, file } =
+  await this.storageService.generatePresignedUploadUrl({
+    originalname: "document.pdf",
+    contentType: "application/pdf",
+  });
+
+// Client uploads directly
+fetch(presignedUrl, {
+  method: "PUT",
+  body: fileBuffer,
+  headers: { "Content-Type": "application/pdf" },
+});
+```
+
+## FileInfo Type
+
+```typescript
+interface FileInfo {
+  filepath: string; // Key/path in bucket
+  bucketName: string; // Target bucket
+  contentType: string; // MIME type
+  originalname: string; // Original filename
+}
+```
+
+## Custom S3 Provider
+
+Implement a custom storage provider:
+
+```typescript
+import { S3, FileInfo } from "@zola_do/seaweed";
+
+class CustomS3Provider extends S3 {
+  constructor() {
+    super({
+      region: "custom-region",
+      credentials: {
+        accessKeyId: process.env.CUSTOM_KEY!,
+        secretAccessKey: process.env.CUSTOM_SECRET!,
+      },
+      endpoint: process.env.CUSTOM_ENDPOINT,
+    });
+  }
+
+  async upload(
+    file: Express.Multer.File,
+    bucketName: string,
+  ): Promise<FileInfo> {
+    // Custom upload logic
+    const filepath = `${Date.now()}-${file.originalname}`;
+    await this.client.putObject({
+      Bucket: bucketName,
+      Key: filepath,
+      Body: file.buffer,
+      ContentType: file.mimetype,
+    });
+    return {
+      filepath,
+      bucketName,
+      contentType: file.mimetype,
+      originalname: file.originalname,
+    };
+  }
+}
 ```
 
 ## 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 |
+| Variable                   | Description                     | Required                  |
+| -------------------------- | ------------------------------- | ------------------------- |
+| `AWS_ACCESS_KEY_ID`        | S3/MinIO access key             | Yes                       |
+| `AWS_SECRET_ACCESS_KEY`    | S3/MinIO secret key             | Yes                       |
+| `AWS_ENDPOINT`             | S3-compatible endpoint URL      | Yes                       |
+| `AWS_REGION`               | AWS region                      | No (default: `us-east-1`) |
+| `PRESIGNED_URL_EXPIRATION` | Presigned URL expiry in seconds | No (default: `3600`)      |
+
+## Supported Providers
+
+| Provider            | Endpoint Example                      |
+| ------------------- | ------------------------------------- |
+| AWS S3              | `https://s3.amazonaws.com`            |
+| MinIO               | `http://localhost:9000`               |
+| SeaweedFS           | `http://localhost:8888`               |
+| DigitalOcean Spaces | `https://nyc3.digitaloceanspaces.com` |
+| Wasabi              | `https://s3.wasabisys.com`            |
 
-## Exports
+## API Reference
 
-- `StorageModule` — Register the storage module
-- `StorageService` — Upload, download, presigned URLs
-- Types and exceptions for storage operations
-- Subpath entrypoints: `@zola_do/seaweed/module`, `@zola_do/seaweed/services`, `@zola_do/seaweed/types`, `@zola_do/seaweed/exceptions`
-- Root entrypoint: `@zola_do/seaweed` (supported for backward compatibility)
+### Module
+
+```typescript
+StorageModule.forRoot(options?: StorageModuleOptions)
+StorageModule.forRootAsync(options?: StorageModuleAsyncOptions)
+```
+
+### Service
+
+```typescript
+class StorageService {
+  upload(file: Express.Multer.File, bucketName: string): Promise<FileInfo>;
+  uploadBuffer(
+    buffer: Buffer,
+    filename: string,
+    mimetype: string,
+    bucketName: string,
+  ): Promise<FileInfo>;
+  uploadStream(
+    stream: Readable,
+    filename: string,
+    mimetype: string,
+    bucketName: string,
+  ): Promise<FileInfo>;
+
+  download(fileInfo: FileInfo, response: Response): Promise<void>;
+  downloadBuffer(fileInfo: FileInfo): Promise<Buffer>;
+
+  generatePresignedUploadUrl(
+    fileInfo: Partial<FileInfo>,
+    expiresIn?: number,
+  ): Promise<string>;
+  generatePresignedDownloadUrl(
+    fileInfo: FileInfo,
+    expiresIn?: number,
+  ): Promise<string>;
+}
+```
+
+### Types
+
+```typescript
+interface FileInfo {
+  filepath: string;
+  bucketName: string;
+  contentType: string;
+  originalname: string;
+}
+
+class S3 {
+  constructor(config: S3ClientConfig);
+  // Override methods for custom implementation
+}
+```
+
+### Exceptions
+
+```typescript
+class FileNotFoundException extends NotFoundException {
+  constructor(message?: string);
+}
+```
+
+## Recommended Imports
+
+Subpath imports are recommended for tree-shaking:
+
+```typescript
+import { StorageModule } from "@zola_do/seaweed/module";
+import { StorageService, AwsS3 } from "@zola_do/seaweed/services";
+import type { FileInfo } from "@zola_do/seaweed/types";
+import { FileNotFoundException } from "@zola_do/seaweed/exceptions";
+```
+
+Root import is supported for backward compatibility:
+
+```typescript
+import { StorageModule, StorageService, FileInfo } from "@zola_do/seaweed";
+```
+
+## Troubleshooting
+
+### Q: Upload fails with CORS error?
+
+Configure CORS on your S3 bucket:
+
+```json
+{
+  "CORSRules": [
+    {
+      "AllowedHeaders": ["*"],
+      "AllowedMethods": ["GET", "PUT", "POST", "DELETE"],
+      "AllowedOrigins": ["*"]
+    }
+  ]
+}
+```
+
+### Q: Presigned URL returns 403?
+
+Check:
+
+1. IAM permissions for the bucket
+2. Correct access key and secret
+3. URL hasn't expired
+
+### Q: Connection timeout?
+
+Verify `AWS_ENDPOINT` is correct and accessible from your server.
 
 ## Related Packages
 
 - [@zola_do/minio](../minio) — Alternative MinIO-specific module
 
+## License
+
+ISC
+
 ## Community
 
 - [Contributing](../../CONTRIBUTING.md)

package/dist/index.d.ts

@@ -1,4 +1,6 @@
+export * from './zola-object-storage';
 export * from './storage.module';
 export * from './types';
 export * from './services/storage.service';
+export * from './services/seaweed.zola-object-storage';
 export * from './exceptions';

package/dist/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./zola-object-storage"), exports);
 __exportStar(require("./storage.module"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./services/storage.service"), exports);
+__exportStar(require("./services/seaweed.zola-object-storage"), exports);
 __exportStar(require("./exceptions"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,0CAAwB;AACxB,6DAA2C;AAC3C,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,mDAAiC;AACjC,0CAAwB;AACxB,6DAA2C;AAC3C,yEAAuD;AACvD,+CAA6B"}

package/dist/services/index.d.ts

@@ -1,2 +1,3 @@
 export * from './aws-s3.service';
 export * from './storage.service';
+export * from './seaweed.zola-object-storage';

package/dist/services/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./aws-s3.service"), exports);
 __exportStar(require("./storage.service"), exports);
+__exportStar(require("./seaweed.zola-object-storage"), exports);
 //# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,oDAAkC;AAClC,gEAA8C"}

package/dist/services/seaweed.zola-object-storage.d.ts

@@ -0,0 +1,16 @@
+import { ZolaObjectStorage, ZolaStoredFileRef } from '../zola-object-storage';
+import { StorageService } from './storage.service';
+export declare class SeaweedZolaObjectStorage implements ZolaObjectStorage {
+    private readonly storage;
+    constructor(storage: StorageService);
+    uploadFile(file: Express.Multer.File, bucketName: string, _metaData?: Record<string, string>): Promise<ZolaStoredFileRef>;
+    uploadBuffer(buffer: Buffer, originalname: string, mimetype: string, bucketName: string): Promise<ZolaStoredFileRef>;
+    generatePresignedUploadUrl(fileInfo: {
+        originalname: string;
+        contentType?: string;
+    }, bucketName: string): Promise<{
+        presignedUrl: string;
+        file: ZolaStoredFileRef;
+    }>;
+    generatePresignedDownloadUrl(fileInfo: Pick<ZolaStoredFileRef, 'bucketName' | 'filepath' | 'contentType' | 'originalname'>): Promise<string>;
+}

package/dist/services/seaweed.zola-object-storage.js

@@ -0,0 +1,47 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeaweedZolaObjectStorage = void 0;
+const common_1 = require("@nestjs/common");
+const storage_service_1 = require("./storage.service");
+let SeaweedZolaObjectStorage = class SeaweedZolaObjectStorage {
+    constructor(storage) {
+        this.storage = storage;
+    }
+    uploadFile(file, bucketName, _metaData) {
+        return this.storage.upload(file, bucketName);
+    }
+    uploadBuffer(buffer, originalname, mimetype, bucketName) {
+        return this.storage.uploadBuffer(buffer, originalname, mimetype, bucketName);
+    }
+    async generatePresignedUploadUrl(fileInfo, bucketName) {
+        var _a;
+        const result = await this.storage.generatePresignedUploadUrlWithRef({
+            originalname: fileInfo.originalname,
+            contentType: (_a = fileInfo.contentType) !== null && _a !== void 0 ? _a : 'application/octet-stream',
+            bucketName,
+            filepath: '',
+        });
+        return {
+            presignedUrl: result.presignedUrl,
+            file: result.file,
+        };
+    }
+    async generatePresignedDownloadUrl(fileInfo) {
+        return this.storage.generatePresignedDownloadUrl(fileInfo);
+    }
+};
+exports.SeaweedZolaObjectStorage = SeaweedZolaObjectStorage;
+exports.SeaweedZolaObjectStorage = SeaweedZolaObjectStorage = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [storage_service_1.StorageService])
+], SeaweedZolaObjectStorage);
+//# sourceMappingURL=seaweed.zola-object-storage.js.map

package/dist/services/seaweed.zola-object-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seaweed.zola-object-storage.js","sourceRoot":"","sources":["../../src/services/seaweed.zola-object-storage.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,uDAAmD;AAG5C,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IACnC,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;IAAG,CAAC;IAExD,UAAU,CACR,IAAyB,EACzB,UAAkB,EAClB,SAAkC;QAElC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAA+B,CAAC;IAC7E,CAAC;IAED,YAAY,CACV,MAAc,EACd,YAAoB,EACpB,QAAgB,EAChB,UAAkB;QAElB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAC9B,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,UAAU,CACmB,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,QAAwD,EACxD,UAAkB;;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,iCAAiC,CAAC;YAClE,YAAY,EAAE,QAAQ,CAAC,YAAY;YACnC,WAAW,EAAE,MAAA,QAAQ,CAAC,WAAW,mCAAI,0BAA0B;YAC/D,UAAU;YACV,QAAQ,EAAE,EAAE;SACb,CAAC,CAAC;QACH,OAAO;YACL,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,IAAI,EAAE,MAAM,CAAC,IAAyB;SACvC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,4BAA4B,CAChC,QAGC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;CACF,CAAA;AAjDY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;qCAE2B,gCAAc;GADzC,wBAAwB,CAiDpC"}

package/dist/services/storage.service.d.ts

@@ -7,4 +7,9 @@ export declare class StorageService {
     download(fileInfo: FileInfo, response: Response): Promise<any>;
     generatePresignedDownloadUrl(fileInfo: FileInfo): Promise<string>;
     generatePresignedUploadUrl(fileInfo: FileInfo): Promise<string>;
+    generatePresignedUploadUrlWithRef(fileInfo: FileInfo): Promise<{
+        presignedUrl: string;
+        file: FileInfo;
+    }>;
+    uploadBuffer(buffer: Buffer, originalname: string, mimetype: string, bucketName: string): Promise<FileInfo>;
 }

package/dist/services/storage.service.js

@@ -44,6 +44,26 @@ let StorageService = class StorageService {
         const normalizedFileName = `${(0, crypto_1.randomUUID)()}${ext}`;
         return await this.s3.presignedPutObject(fileInfo.bucketName, normalizedFileName, fileInfo.contentType, +process.env.PRESIGNED_URL_EXPIRATION);
     }
+    async generatePresignedUploadUrlWithRef(fileInfo) {
+        const ext = (0, path_1.extname)(fileInfo.originalname);
+        const normalizedFileName = `${(0, crypto_1.randomUUID)()}${ext}`;
+        const presignedUrl = await this.s3.presignedPutObject(fileInfo.bucketName, normalizedFileName, fileInfo.contentType, +process.env.PRESIGNED_URL_EXPIRATION);
+        return {
+            presignedUrl,
+            file: Object.assign(Object.assign({}, fileInfo), { filepath: normalizedFileName }),
+        };
+    }
+    async uploadBuffer(buffer, originalname, mimetype, bucketName) {
+        const ext = (0, path_1.extname)(originalname);
+        const normalizedFileName = `${(0, crypto_1.randomUUID)()}${ext}`;
+        await this.s3.putObject(bucketName, normalizedFileName, buffer);
+        return {
+            filepath: normalizedFileName,
+            bucketName,
+            contentType: mimetype,
+            originalname,
+        };
+    }
 };
 exports.StorageService = StorageService;
 exports.StorageService = StorageService = __decorate([

package/dist/services/storage.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../../src/services/storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,oCAAwC;AACxC,mCAAoC;AACpC,+BAA+B;AAGxB,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YAA6B,EAAM;QAAN,OAAE,GAAF,EAAE,CAAI;IAAG,CAAC;IAEvC,KAAK,CAAC,MAAM,CACV,IAAyB,EACzB,UAAkB;QAElB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEvC,MAAM,kBAAkB,GAAG,GAAG,IAAA,mBAAU,GAAE,GAAG,GAAG,EAAE,CAAC;QAEnD,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAErE,OAAO;YACL,QAAQ,EAAE,kBAAkB;YAC5B,UAAU;YACV,WAAW,EAAE,IAAI,CAAC,QAAQ;YAC1B,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,QAAkB,EAAE,QAAkB;;QACnD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CACpC,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,QAAQ,CAClB,CAAC;QAEF,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;QACzD,QAAQ,CAAC,SAAS,CAChB,qBAAqB,EACrB,wBAAwB,MAAA,QAAQ,CAAC,YAAY,mCAAI,QAAQ,CAAC,QAAQ,EAAE,CACrE,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,4BAA4B,CAAC,QAAkB;QACnD,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CACrC,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,QAAQ,EACjB,QAAQ,CAAC,WAAW,EACpB,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CACtC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,QAAkB;QACjD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE3C,MAAM,kBAAkB,GAAG,GAAG,IAAA,mBAAU,GAAE,GAAG,GAAG,EAAE,CAAC;QAEnD,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CACrC,QAAQ,CAAC,UAAU,EACnB,kBAAkB,EAClB,QAAQ,CAAC,WAAW,EACpB,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CACtC,CAAC;IACJ,CAAC;CACF,CAAA;AAzDY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAEsB,UAAE;GADxB,cAAc,CAyD1B"}
+{"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../../src/services/storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,oCAAwC;AACxC,mCAAoC;AACpC,+BAA+B;AAGxB,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YAA6B,EAAM;QAAN,OAAE,GAAF,EAAE,CAAI;IAAG,CAAC;IAEvC,KAAK,CAAC,MAAM,CACV,IAAyB,EACzB,UAAkB;QAElB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEvC,MAAM,kBAAkB,GAAG,GAAG,IAAA,mBAAU,GAAE,GAAG,GAAG,EAAE,CAAC;QAEnD,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAErE,OAAO;YACL,QAAQ,EAAE,kBAAkB;YAC5B,UAAU;YACV,WAAW,EAAE,IAAI,CAAC,QAAQ;YAC1B,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,QAAkB,EAAE,QAAkB;;QACnD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CACpC,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,QAAQ,CAClB,CAAC;QAEF,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;QACzD,QAAQ,CAAC,SAAS,CAChB,qBAAqB,EACrB,wBAAwB,MAAA,QAAQ,CAAC,YAAY,mCAAI,QAAQ,CAAC,QAAQ,EAAE,CACrE,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,4BAA4B,CAAC,QAAkB;QACnD,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CACrC,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,QAAQ,EACjB,QAAQ,CAAC,WAAW,EACpB,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CACtC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,QAAkB;QACjD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE3C,MAAM,kBAAkB,GAAG,GAAG,IAAA,mBAAU,GAAE,GAAG,GAAG,EAAE,CAAC;QAEnD,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CACrC,QAAQ,CAAC,UAAU,EACnB,kBAAkB,EAClB,QAAQ,CAAC,WAAW,EACpB,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CACtC,CAAC;IACJ,CAAC;IAKD,KAAK,CAAC,iCAAiC,CACrC,QAAkB;QAElB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,kBAAkB,GAAG,GAAG,IAAA,mBAAU,GAAE,GAAG,GAAG,EAAE,CAAC;QACnD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CACnD,QAAQ,CAAC,UAAU,EACnB,kBAAkB,EAClB,QAAQ,CAAC,WAAW,EACpB,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CACtC,CAAC;QACF,OAAO;YACL,YAAY;YACZ,IAAI,kCACC,QAAQ,KACX,QAAQ,EAAE,kBAAkB,GAC7B;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,MAAc,EACd,YAAoB,EACpB,QAAgB,EAChB,UAAkB;QAElB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,YAAY,CAAC,CAAC;QAClC,MAAM,kBAAkB,GAAG,GAAG,IAAA,mBAAU,GAAE,GAAG,GAAG,EAAE,CAAC;QACnD,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;QAChE,OAAO;YACL,QAAQ,EAAE,kBAAkB;YAC5B,UAAU;YACV,WAAW,EAAE,QAAQ;YACrB,YAAY;SACb,CAAC;IACJ,CAAC;CACF,CAAA;AAjGY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAEsB,UAAE;GADxB,cAAc,CAiG1B"}

package/dist/storage.module.js

@@ -12,6 +12,7 @@ const client_s3_1 = require("@aws-sdk/client-s3");
 const storage_service_1 = require("./services/storage.service");
 const aws_s3_service_1 = require("./services/aws-s3.service");
 const types_1 = require("./types");
+const seaweed_zola_object_storage_1 = require("./services/seaweed.zola-object-storage");
 let StorageModule = class StorageModule {
 };
 exports.StorageModule = StorageModule;
@@ -36,9 +37,10 @@ exports.StorageModule = StorageModule = __decorate([
                 useClass: aws_s3_service_1.AwsS3,
             },
             storage_service_1.StorageService,
+            seaweed_zola_object_storage_1.SeaweedZolaObjectStorage,
         ],
         controllers: [],
-        exports: [storage_service_1.StorageService],
+        exports: [storage_service_1.StorageService, seaweed_zola_object_storage_1.SeaweedZolaObjectStorage],
     })
 ], StorageModule);
 //# sourceMappingURL=storage.module.js.map

package/dist/storage.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.module.js","sourceRoot":"","sources":["../src/storage.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,kDAA8C;AAC9C,gEAA4D;AAC5D,8DAAkD;AAClD,mCAA6B;AA2BtB,IAAM,aAAa,GAAnB,MAAM,aAAa;CAAG,CAAA;AAAhB,sCAAa;wBAAb,aAAa;IAzBzB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,oBAAQ;gBACjB,UAAU,EAAE,GAAG,EAAE;oBACf,OAAO,IAAI,oBAAQ,CAAC;wBAClB,WAAW,EAAE;4BACX,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;4BAC1C,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB;yBACnD;wBACD,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;wBAClC,cAAc,EAAE,IAAI;qBACrB,CAAC,CAAC;gBACL,CAAC;aACF;YACD;gBACE,OAAO,EAAE,UAAE;gBACX,QAAQ,EAAE,sBAAK;aAChB;YAED,gCAAc;SACf;QACD,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAAG"}
+{"version":3,"file":"storage.module.js","sourceRoot":"","sources":["../src/storage.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,kDAA8C;AAC9C,gEAA4D;AAC5D,8DAAkD;AAClD,mCAA6B;AAC7B,wFAAkF;AA4B3E,IAAM,aAAa,GAAnB,MAAM,aAAa;CAAG,CAAA;AAAhB,sCAAa;wBAAb,aAAa;IA1BzB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,oBAAQ;gBACjB,UAAU,EAAE,GAAG,EAAE;oBACf,OAAO,IAAI,oBAAQ,CAAC;wBAClB,WAAW,EAAE;4BACX,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;4BAC1C,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB;yBACnD;wBACD,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;wBAClC,cAAc,EAAE,IAAI;qBACrB,CAAC,CAAC;gBACL,CAAC;aACF;YACD;gBACE,OAAO,EAAE,UAAE;gBACX,QAAQ,EAAE,sBAAK;aAChB;YAED,gCAAc;YACd,sDAAwB;SACzB;QACD,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,gCAAc,EAAE,sDAAwB,CAAC;KACpD,CAAC;GACW,aAAa,CAAG"}

package/dist/zola-object-storage.d.ts

@@ -0,0 +1,19 @@
+export type ZolaStoredFileRef = {
+    filepath: string;
+    bucketName: string;
+    contentType: string;
+    originalname: string;
+};
+export interface ZolaObjectStorage {
+    uploadFile(file: Express.Multer.File, bucketName: string, metaData?: Record<string, string>): Promise<ZolaStoredFileRef>;
+    uploadBuffer(buffer: Buffer, originalname: string, mimetype: string, bucketName: string, metaData?: Record<string, string>): Promise<ZolaStoredFileRef>;
+    generatePresignedUploadUrl(fileInfo: {
+        originalname: string;
+        contentType?: string;
+    }, bucketName: string): Promise<{
+        presignedUrl: string;
+        file: ZolaStoredFileRef;
+    }>;
+    generatePresignedDownloadUrl(fileInfo: Pick<ZolaStoredFileRef, 'bucketName' | 'filepath' | 'contentType' | 'originalname'>): Promise<string>;
+}
+export declare const ZOLA_STORAGE_CONTRACT_VERSION: 1;

package/dist/zola-object-storage.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZOLA_STORAGE_CONTRACT_VERSION = void 0;
+exports.ZOLA_STORAGE_CONTRACT_VERSION = 1;
+//# sourceMappingURL=zola-object-storage.js.map

package/dist/zola-object-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zola-object-storage.js","sourceRoot":"","sources":["../src/zola-object-storage.ts"],"names":[],"mappings":";;;AA4Ca,QAAA,6BAA6B,GAAG,CAAU,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/seaweed",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "AWS S3-compatible storage for NestJS",
   "author": "zolaDO",
   "license": "ISC",