s3mini 0.9.2 → 0.9.4

package/README.md

@@ -2,13 +2,17 @@
 
 `s3mini` is an ultra-lightweight Typescript client (~20 KB minified, ≈15 % more ops/s) for S3-compatible object storage. It runs on Node, Bun, Cloudflare Workers, and other edge platforms. It has been tested on Cloudflare R2, Backblaze B2, DigitalOcean Spaces, Ceph, Oracle, Garage and MinIO. (No Browser support!)
 
+![Node.js](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
+![Bun](https://img.shields.io/badge/Bun-%23000000.svg?style=for-the-badge&logo=bun&logoColor=white)
+![Cloudflare](https://img.shields.io/badge/Cloudflare-F38020?style=for-the-badge&logo=Cloudflare&logoColor=white)
+
 [[github](https://github.com/good-lly/s3mini)]
 [[issues](https://github.com/good-lly/s3mini/issues)]
 [[npm](https://www.npmjs.com/package/s3mini)]
 
 ## Features
 
-- 🚀 Light and fast: averages ≈15 % more ops/s and only ~20 KB (minified, not gzipped).
+- 🚀 Light and fast: ~20 KB (minified, not gzipped), up to 1.37x faster on Bun vs Node.
 - 🔧 Zero dependencies; supports AWS SigV4, pre-signed URLs, and SSE-C headers (tested on Cloudflare)
 - 🟠 Works on Cloudflare Workers; ideal for edge computing, Node, and Bun (no browser support).
 - 🔑 Only the essential S3 APIs—improved list, put, get, delete, and a few more.
@@ -44,6 +48,10 @@ Dev:
 
 <a href="https://github.com/good-lly/s3mini/issues/"> <img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg" alt="Contributions welcome" /></a>
 
+### Bun vs Node
+
+s3mini is tested on both Node and Bun. In our benchmarks against MinIO, Bun is roughly **~1.4x faster** on most operations (median across ~40 tests). Blob multipart uploads see the largest gain (~20x) thanks to Bun's native `Blob.slice()`. Results are approximate and will vary by environment.
+
 ## Table of Contents
 
 - [Installation](#installation)
@@ -515,6 +523,21 @@ const url = await s3.getPresignedUrl('GET', 'report.pdf', 3600, {
 });
 ```
 
+**Signed headers (enforce headers on the client request):**
+
+```typescript
+// Upload URL that requires Content-Type — client MUST send this exact header
+const url = await s3.getPresignedUrl('PUT', 'uploads/data.json', 300, {}, {
+  'Content-Type': 'application/json',
+});
+
+await fetch(url, {
+  method: 'PUT',
+  body: JSON.stringify({ ok: true }),
+  headers: { 'Content-Type': 'application/json' },
+});
+```
+
 **Method signature:**
 
 ```typescript
@@ -523,6 +546,7 @@ getPresignedUrl(
   key: string,
   expiresIn?: number,           // Default: 3600 (1 hour), max: 604800 (7 days)
   queryParams?: Record<string, string>,
+  headers?: Record<string, string>,  // HTTP headers to sign (e.g. Content-Type)
 ): Promise<string>
 ```
 
@@ -532,6 +556,7 @@ getPresignedUrl(
 - Works with both virtual-hosted-style and path-style endpoints.
 - Special characters and unicode in keys are handled automatically.
 - Throws `TypeError` for empty keys or out-of-range `expiresIn`.
+- When `headers` are provided, they are included in `X-Amz-SignedHeaders` and the signature. The client consuming the URL must send those exact headers with matching values. The `host` header is always signed automatically.
 
 ---
 
@@ -603,7 +628,7 @@ await s3.copyObject('secret.dat', 'backup/secret.dat', {
 | `getContentLength(key, ssec?)`                                     | `Promise<number>`                           | Get size in bytes       |
 | `copyObject(source, dest, opts?)`                                  | `Promise<CopyObjectResult>`                 | Server-side copy        |
 | `moveObject(source, dest, opts?)`                                  | `Promise<CopyObjectResult>`                 | Copy + delete           |
-| `getPresignedUrl(method, key, expiresIn?, queryParams?)`           | `Promise<string>`                           | Generate pre-signed URL |
+| `getPresignedUrl(method, key, expiresIn?, queryParams?, headers?)` | `Promise<string>`                           | Generate pre-signed URL |
 | `getMultipartUploadId(key, type?, ssec?, headers?)`                | `Promise<string>`                           | Init multipart          |
 | `uploadPart(key, uploadId, data, partNum, opts?, ssec?, headers?)` | `Promise<UploadPart>`                       | Upload part             |
 | `completeMultipartUpload(key, uploadId, parts)`                    | `Promise<CompleteResult>`                   | Complete multipart      |

package/dist/s3mini.d.ts

@@ -164,6 +164,7 @@ declare class S3mini {
     readonly logger?: Logger;
     readonly _fetch: typeof fetch;
     readonly minPartSize: number;
+    private readonly _bun?;
     private signingKeyDate?;
     private signingKey?;
     constructor({ accessKeyId, secretAccessKey, endpoint, region, requestSizeInBytes, requestAbortTimeout, logger, fetch, minPartSize, }: S3Config);
@@ -175,6 +176,8 @@ declare class S3mini {
      * @returns true if both accessKeyId and secretAccessKey are non-empty.
      */
     private _hasCredentials;
+    /** Run a read op via Bun-native S3, returning null on NoSuchKey. */
+    private _bunRead;
     private _ensureValidUrl;
     private _validateMethodIsGetOrHead;
     private _checkKey;
@@ -249,6 +252,10 @@ declare class S3mini {
     private _parseListObjectsResponse;
     private _extractObjectsFromResponse;
     private _extractContinuationToken;
+    private _bunListAll;
+    private _bunFetchPage;
+    private _bunNextCursor;
+    private _bunMapListResult;
     /**
      * Lists multipart uploads in the bucket.
      * This method sends a request to list multipart uploads in the specified bucket.
@@ -579,6 +586,9 @@ declare class S3mini {
      */
     deleteObject(key: string): Promise<boolean>;
     private _deleteObjectsProcess;
+    private _sendDeleteRequest;
+    private _markDeletedKeys;
+    private _logDeleteErrors;
     /**
      * Deletes multiple objects from the bucket.
      * @param {string[]} keys - An array of object keys to delete.
@@ -597,20 +607,24 @@ declare class S3mini {
      * @param {'GET' | 'PUT'} method - HTTP method ('GET' for download, 'PUT' for upload)
      * @param {string} key - The object key/path
      * @param {number} [expiresIn=3600] - URL expiration time in seconds (1–604800)
-     * @param {Record<string, string>} [queryParams={}] - Additional query parameters to sign
+     * @param {Record<string, string>} [queryParams={}] - Additional query parameters to include in the URL
+     * @param {Record<string, string>} [headers={}] - HTTP headers to sign. The consumer of the URL
+     *   MUST send these exact headers with matching values. The `host` header is always signed automatically.
      * @returns {Promise<string>} Pre-signed URL string
      * @throws {TypeError} If key is empty or expiresIn is out of range
      * @example
      * // Download URL valid for 1 hour
      * const url = await s3.getPresignedUrl('GET', 'photos/vacation.jpg');
      *
-     * // Upload URL valid for 5 minutes
-     * const url = await s3.getPresignedUrl('PUT', 'uploads/file.bin', 300);
+     * // Upload URL valid for 5 minutes with signed Content-Type
+     * const url = await s3.getPresignedUrl('PUT', 'uploads/file.bin', 300, {}, {
+     *   'Content-Type': 'application/octet-stream',
+     * });
      *
-     * // Client-side usage (no credentials needed)
-     * await fetch(url, { method: 'PUT', body: data });
+     * // Client-side usage (must include signed headers)
+     * await fetch(url, { method: 'PUT', body: data, headers: { 'Content-Type': 'application/octet-stream' } });
      */
-    getPresignedUrl(method: 'GET' | 'PUT', key: string, expiresIn?: number, queryParams?: Record<string, string>): Promise<string>;
+    getPresignedUrl(method: 'GET' | 'PUT', key: string, expiresIn?: number, queryParams?: Record<string, string>, headers?: Record<string, string>): Promise<string>;
     private _presign;
     private _getSignatureKey;
 }