@constructive-io/s3-utils 2.32.0 → 2.33.1

package/README.md

@@ -16,7 +16,7 @@ Unified S3 utilities for the Constructive ecosystem — client factory, file ope
 
 ## Features
 
-- **Multi-provider support** — AWS S3, MinIO, Cloudflare R2, Google Cloud Storage, DigitalOcean Spaces
+- **Multi-provider support** — AWS S3, RustFS (or any S3-compatible store), MinIO, Cloudflare R2, Google Cloud Storage, DigitalOcean Spaces
 - **Presigned URLs** — generate secure PUT and GET URLs with configurable expiry
 - **File operations** — streaming upload, download, existence checks, and metadata retrieval
 - **Bucket management** — create buckets with provider-appropriate policies and CORS
@@ -43,9 +43,9 @@ import {
 const client = createS3Client({
   provider: 'minio',
   region: 'us-east-1',
-  endpoint: 'http://minio:9000',
-  accessKeyId: 'minioadmin',
-  secretAccessKey: 'minioadmin',
+  endpoint: 'http://rustfs:9000',
+  accessKeyId: 'constructive',
+  secretAccessKey: 'constructive-dev-secret',
 });
 
 // 2. Upload a file via stream
@@ -88,14 +88,14 @@ const client = createS3Client({
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `provider` | `'s3' \| 'minio' \| 'r2' \| 'gcs' \| 'spaces'` | yes | Storage provider |
+| `provider` | `'s3' \| 'minio' \| 'rustfs' \| 'r2' \| 'gcs' \| 'spaces'` | yes | Storage provider |
 | `region` | `string` | yes | S3 region (e.g. `"us-east-1"`) |
 | `endpoint` | `string` | non-AWS | Endpoint URL (required for all providers except `s3`) |
 | `accessKeyId` | `string` | yes | Access key ID |
 | `secretAccessKey` | `string` | yes | Secret access key |
 | `forcePathStyle` | `boolean` | no | Override path-style URL behavior |
 
-Path-style URLs are enabled automatically for `minio`, `r2`, and `gcs`. Virtual-hosted style is used for `s3` and `spaces`.
+Path-style URLs are enabled automatically for `minio`, `rustfs`, `r2`, and `gcs`. Virtual-hosted style is used for `s3` and `spaces`.
 
 Throws `S3ConfigError` on invalid configuration.
 
@@ -198,8 +198,8 @@ someReadable.pipe(pass);
 
 Creates a bucket with provider-appropriate policies and CORS configuration.
 
-- **MinIO**: read-only public access policy (list + get)
-- **S3/GCS**: full-access policy with CORS rules for browser uploads
+- **Path-style S3-compatible (`minio`, covering RustFS and MinIO)**: read-only public access policy (list + get)
+- **RustFS/S3/GCS**: full-access policy with CORS rules for browser uploads
 
 ```typescript
 const { success } = await createS3Bucket(client, 'my-bucket', {

package/client.d.ts

@@ -6,7 +6,8 @@
  * instead of wiring up @aws-sdk/client-s3 directly.
  *
  * Handles provider-specific defaults:
- * - minio: forces path-style URLs, requires endpoint
+ * - minio: forces path-style URLs, requires endpoint (RustFS or MinIO)
+ * - rustfs: forces path-style URLs, requires endpoint
  * - r2: forces path-style URLs, requires endpoint
  * - gcs: forces path-style URLs, requires endpoint
  * - s3: virtual-hosted style (AWS default)
@@ -19,9 +20,9 @@
  * const client = createS3Client({
  *   provider: 'minio',
  *   region: 'us-east-1',
- *   endpoint: 'http://minio:9000',
- *   accessKeyId: 'minioadmin',
- *   secretAccessKey: 'minioadmin',
+ *   endpoint: 'http://rustfs:9000',
+ *   accessKeyId: 'constructive',
+ *   secretAccessKey: 'constructive-dev-secret',
  * });
  * ```
  */
@@ -29,29 +30,29 @@ import { S3Client } from '@aws-sdk/client-s3';
 /**
  * Supported storage provider identifiers.
  *
- * Used to select provider-specific behavior (e.g., path-style URLs for MinIO,
+ * Used to select provider-specific behavior (e.g., path-style URLs for RustFS or MinIO,
  * jurisdiction headers for R2).
  */
-export type StorageProvider = 's3' | 'minio' | 'r2' | 'gcs' | 'spaces';
+export type StorageProvider = 's3' | 'minio' | 'rustfs' | 'r2' | 'gcs' | 'spaces';
 /**
  * Connection configuration for an S3-compatible storage backend.
  *
  * This is the input you provide to connect to your storage provider.
  * For AWS S3, only `region` and credentials are needed.
- * For MinIO/R2/etc., also provide `endpoint`.
+ * For RustFS/MinIO/R2/etc., also provide `endpoint`.
  */
 export interface StorageConnectionConfig {
     /** Storage provider type */
     provider: StorageProvider;
     /** S3 region (e.g., "us-east-1"). Required for AWS S3. */
     region: string;
-    /** S3-compatible endpoint URL (e.g., "http://minio:9000"). Required for non-AWS providers. */
+    /** S3-compatible endpoint URL (e.g., "http://rustfs:9000"). Required for non-AWS providers. */
     endpoint?: string;
     /** AWS access key ID */
     accessKeyId: string;
     /** AWS secret access key */
     secretAccessKey: string;
-    /** Use path-style URLs (required for MinIO, optional for others) */
+    /** Use path-style URLs (required for RustFS and MinIO, optional for others) */
     forcePathStyle?: boolean;
 }
 /**
@@ -65,7 +66,8 @@ export declare class S3ConfigError extends Error {
  * Create an S3Client from a storage connection config.
  *
  * Provider-specific defaults:
- * - `minio`: forces path-style URLs (required by MinIO)
+ * - `minio`: path-style S3-compatible storage (RustFS or MinIO)
+ * - `rustfs`: forces path-style URLs
  * - `r2`: forces path-style URLs (required by Cloudflare R2)
  * - `s3`: uses virtual-hosted style (AWS default)
  * - `gcs`: forces path-style URLs (GCS S3-compatible API)

package/client.js

@@ -7,7 +7,8 @@
  * instead of wiring up @aws-sdk/client-s3 directly.
  *
  * Handles provider-specific defaults:
- * - minio: forces path-style URLs, requires endpoint
+ * - minio: forces path-style URLs, requires endpoint (RustFS or MinIO)
+ * - rustfs: forces path-style URLs, requires endpoint
  * - r2: forces path-style URLs, requires endpoint
  * - gcs: forces path-style URLs, requires endpoint
  * - s3: virtual-hosted style (AWS default)
@@ -20,9 +21,9 @@
  * const client = createS3Client({
  *   provider: 'minio',
  *   region: 'us-east-1',
- *   endpoint: 'http://minio:9000',
- *   accessKeyId: 'minioadmin',
- *   secretAccessKey: 'minioadmin',
+ *   endpoint: 'http://rustfs:9000',
+ *   accessKeyId: 'constructive',
+ *   secretAccessKey: 'constructive-dev-secret',
  * });
  * ```
  */
@@ -48,7 +49,8 @@ exports.S3ConfigError = S3ConfigError;
  * Create an S3Client from a storage connection config.
  *
  * Provider-specific defaults:
- * - `minio`: forces path-style URLs (required by MinIO)
+ * - `minio`: path-style S3-compatible storage (RustFS or MinIO)
+ * - `rustfs`: forces path-style URLs
  * - `r2`: forces path-style URLs (required by Cloudflare R2)
  * - `s3`: uses virtual-hosted style (AWS default)
  * - `gcs`: forces path-style URLs (GCS S3-compatible API)
@@ -62,7 +64,7 @@ function createS3Client(config) {
         throw new S3ConfigError('INVALID_CONFIG', 'region is required');
     }
     // Providers that require path-style URLs
-    const pathStyleProviders = new Set(['minio', 'r2', 'gcs']);
+    const pathStyleProviders = new Set(['minio', 'rustfs', 'r2', 'gcs']);
     const forcePathStyle = config.forcePathStyle ?? pathStyleProviders.has(config.provider);
     // Non-AWS providers require an endpoint
     if (config.provider !== 's3' && !config.endpoint) {

package/esm/client.js

@@ -6,7 +6,8 @@
  * instead of wiring up @aws-sdk/client-s3 directly.
  *
  * Handles provider-specific defaults:
- * - minio: forces path-style URLs, requires endpoint
+ * - minio: forces path-style URLs, requires endpoint (RustFS or MinIO)
+ * - rustfs: forces path-style URLs, requires endpoint
  * - r2: forces path-style URLs, requires endpoint
  * - gcs: forces path-style URLs, requires endpoint
  * - s3: virtual-hosted style (AWS default)
@@ -19,9 +20,9 @@
  * const client = createS3Client({
  *   provider: 'minio',
  *   region: 'us-east-1',
- *   endpoint: 'http://minio:9000',
- *   accessKeyId: 'minioadmin',
- *   secretAccessKey: 'minioadmin',
+ *   endpoint: 'http://rustfs:9000',
+ *   accessKeyId: 'constructive',
+ *   secretAccessKey: 'constructive-dev-secret',
  * });
  * ```
  */
@@ -43,7 +44,8 @@ export class S3ConfigError extends Error {
  * Create an S3Client from a storage connection config.
  *
  * Provider-specific defaults:
- * - `minio`: forces path-style URLs (required by MinIO)
+ * - `minio`: path-style S3-compatible storage (RustFS or MinIO)
+ * - `rustfs`: forces path-style URLs
  * - `r2`: forces path-style URLs (required by Cloudflare R2)
  * - `s3`: uses virtual-hosted style (AWS default)
  * - `gcs`: forces path-style URLs (GCS S3-compatible API)
@@ -57,7 +59,7 @@ export function createS3Client(config) {
         throw new S3ConfigError('INVALID_CONFIG', 'region is required');
     }
     // Providers that require path-style URLs
-    const pathStyleProviders = new Set(['minio', 'r2', 'gcs']);
+    const pathStyleProviders = new Set(['minio', 'rustfs', 'r2', 'gcs']);
     const forcePathStyle = config.forcePathStyle ?? pathStyleProviders.has(config.provider);
     // Non-AWS providers require an endpoint
     if (config.provider !== 's3' && !config.endpoint) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/s3-utils",
-  "version": "2.32.0",
+  "version": "2.33.1",
   "author": "Constructive <developers@constructive.io>",
   "description": "Unified S3 utilities — client factory, file operations, presigned URLs",
   "main": "index.js",
@@ -36,7 +36,7 @@
   },
   "devDependencies": {
     "@types/node": "^22.19.11",
-    "makage": "^0.3.0"
+    "makage": "^0.8.0"
   },
-  "gitHead": "b5b6b9f05276b7e9cbd3d1f4acd31dd315c353ea"
+  "gitHead": "9bba983b38395277e0400294aaa380e586b049d4"
 }

package/policies.d.ts

@@ -1,6 +1,6 @@
 import { S3Client } from '@aws-sdk/client-s3';
 export interface CreateS3BucketOptions {
-    provider: 'minio' | 's3' | 'gcs';
+    provider: 'minio' | 'rustfs' | 's3' | 'gcs';
 }
 export declare function createS3Bucket(client: S3Client, Bucket: string, options: CreateS3BucketOptions): Promise<{
     success: boolean;