lean-s3 0.2.0 → 0.2.1

package/README.md

@@ -77,7 +77,7 @@ $ du -sh node_modules
 `lean-s3` is _so_ lean that it is ~1.8MB just to do a couple of HTTP requests <img src="https://cdn.frankerfacez.com/emoticon/480839/1" width="20" height="20">
 BUT...
 
-Due to its scalability, portability and AWS integrations, pre-signing URLs is `async` and performs poorly in high-performance scenarios. By taking different trade-offs, lean-s3 can presign URLs much faster. I promise! This is the reason you cannot use lean-s3 in the browser.
+Due to the scalability, portability and AWS integrations of @aws-sdk/client-s3, pre-signing URLs is `async` and performs poorly in high-performance scenarios. By taking different trade-offs, lean-s3 can presign URLs much faster. I promise! This is the reason you cannot use lean-s3 in the browser.
 
 lean-s3 is currently about 30x faster than AWS SDK when it comes to pre-signing URLs[^1]:
 ```
@@ -121,6 +121,18 @@ We try to keep this library small. If you happen to need something that is not s
 
 See [DESIGN_DECISIONS.md](./DESIGN_DECISIONS.md) to read about why this library is the way it is.
 
+## Supported Operations
+
+### Bucket Operations
+- ✅ [`CreateBucket`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) via `.createBucket`
+
+### Object Operations
+- ✅ [`ListObjectsV2`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) via `.list`/`.listIterating`
+- ✅ [`DeleteObjects`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html) via `.deleteObjects`
+- ✅ [`DeleteObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) via `S3File.delete`
+- ✅ [`PutObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) via `S3File.write`
+- ✅ [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html) via `S3File.exists`/`S3File.stat`
+
 ## Example Configurations
 ### Hetzner Object Storage
 ```js

package/dist/S3Client.d.ts

@@ -1,7 +1,7 @@
 import S3File from "./S3File.ts";
 import S3BucketEntry from "./S3BucketEntry.ts";
 import * as amzDate from "./AmzDate.ts";
-import type { Acl, PresignableHttpMethod, StorageClass, UndiciBodyInit } from "./index.ts";
+import type { Acl, BucketInfo, BucketLocationInfo, PresignableHttpMethod, StorageClass, UndiciBodyInit } from "./index.ts";
 export declare const write: unique symbol;
 export declare const stream: unique symbol;
 export interface S3ClientOptions {
@@ -14,6 +14,9 @@ export interface S3ClientOptions {
 }
 export type OverridableS3ClientOptions = Pick<S3ClientOptions, "region" | "bucket" | "endpoint">;
 export type CreateFileInstanceOptions = {};
+export type DeleteObjectsOptions = {
+    signal?: AbortSignal;
+};
 export interface S3FilePresignOptions {
     contentHash: Buffer;
     /** Seconds. */
@@ -22,6 +25,19 @@ export interface S3FilePresignOptions {
     storageClass: StorageClass;
     acl: Acl;
 }
+export type ListObjectsOptions = {
+    prefix?: string;
+    maxKeys?: number;
+    startAfter?: string;
+    continuationToken?: string;
+    signal?: AbortSignal;
+};
+export type ListObjectsIteratingOptions = {
+    prefix?: string;
+    startAfter?: string;
+    signal?: AbortSignal;
+    internalPageSize?: number;
+};
 export type ListObjectsResponse = {
     name: string;
     prefix: string | undefined;
@@ -33,6 +49,12 @@ export type ListObjectsResponse = {
     nextContinuationToken: string | undefined;
     contents: readonly S3BucketEntry[];
 };
+export type BucketCreationOptions = {
+    locationConstraint?: string;
+    location?: BucketLocationInfo;
+    info?: BucketInfo;
+    signal?: AbortSignal;
+};
 /**
  * A configured S3 bucket instance for managing files.
  *
@@ -60,9 +82,27 @@ export default class S3Client {
     /**
      * Creates an S3File instance for the given path.
      *
-     * @param {string} path
+     * @param {string} path The path to the object in the bucket. ALso known as [object key](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).
+     * We recommend not using the following characters in a key name because of significant special character handling, which isn't consistent across all applications (see [AWS docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html)):
+     * - Backslash (`\\`)
+     * - Left brace (`{`)
+     * - Non-printable ASCII characters (128–255 decimal characters)
+     * - Caret or circumflex (`^`)
+     * - Right brace (`}`)
+     * - Percent character (`%`)
+     * - Grave accent or backtick (`\``)
+     * - Right bracket (`]`)
+     * - Quotation mark (`"`)
+     * - Greater than sign (`>`)
+     * - Left bracket (`[`)
+     * - Tilde (`~`)
+     * - Less than sign (`<`)
+     * - Pound sign (`#`)
+     * - Vertical bar or pipe (`|`)
+     *
+     * lean-s3 does not enforce these restrictions.
+     *
      * @param {Partial<CreateFileInstanceOptions>} [options] TODO
-     * @returns {S3File}
      * @example
      * ```js
      * const file = client.file("image.jpg");
@@ -89,23 +129,39 @@ export default class S3Client {
      */
     presign(path: string, { method, expiresIn, // TODO: Maybe rename this to expiresInSeconds
     storageClass, acl, region: regionOverride, bucket: bucketOverride, endpoint: endpointOverride, }?: Partial<S3FilePresignOptions & OverridableS3ClientOptions>): string;
-    deleteObjects(objects: readonly S3BucketEntry[] | readonly string[], options: unknown): Promise<void>;
     /**
-     * Uses `ListObjectsV2` to iterate over all keys. Pagination and continuation is handled internally.
+     * Uses [`DeleteObjects`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html) to delete multiple objects in a single request.
+     */
+    deleteObjects(objects: readonly S3BucketEntry[] | readonly string[], options?: DeleteObjectsOptions): Promise<{
+        errors: {
+            code: any;
+            key: any;
+            message: any;
+            versionId: any;
+        }[];
+    } | null>;
+    /**
+     * Creates a new bucket on the S3 server.
+     *
+     * @param name The name of the bucket to create. AWS the name according to [some rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The most important ones are:
+     * - Bucket names must be between `3` (min) and `63` (max) characters long.
+     * - Bucket names can consist only of lowercase letters, numbers, periods (`.`), and hyphens (`-`).
+     * - Bucket names must begin and end with a letter or number.
+     * - Bucket names must not contain two adjacent periods.
+     * - Bucket names must not be formatted as an IP address (for example, `192.168.5.4`).
+     *
+     * @throws {Error} If the bucket name is invalid.
+     * @remarks Uses [`CreateBucket`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+     */
+    createBucket(name: string, options?: BucketCreationOptions): Promise<void>;
+    /**
+     * Uses [`ListObjectsV2`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) to iterate over all keys. Pagination and continuation is handled internally.
      */
-    listIterating(options: {
-        prefix?: string;
-        startAfter?: string;
-        signal?: AbortSignal;
-        internalPageSize?: number;
-    }): AsyncGenerator<S3BucketEntry>;
-    list(options?: {
-        prefix?: string;
-        maxKeys?: number;
-        startAfter?: string;
-        continuationToken?: string;
-        signal?: AbortSignal;
-    }): Promise<ListObjectsResponse>;
+    listIterating(options: ListObjectsIteratingOptions): AsyncGenerator<S3BucketEntry>;
+    /**
+     * Implements [`ListObjectsV2`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) to iterate over all keys.
+     */
+    list(options?: ListObjectsOptions): Promise<ListObjectsResponse>;
     /**
      * @internal
      * @param {import("./index.d.ts").UndiciBodyInit} data TODO
@@ -116,15 +172,4 @@ export default class S3Client {
      */
     [stream](path: string, contentHash: Buffer | undefined, rageStart: number | undefined, rangeEndExclusive: number | undefined): import("stream/web").ReadableStream<Uint8Array<ArrayBufferLike>>;
 }
-/**
- * @param {string} amzCredential
- * @param {import("./AmzDate.ts").AmzDate} date
- * @param {number} expiresIn
- * @param {string} headerList
- * @param {StorageClass | null | undefined} storageClass
- * @param {string | null | undefined} sessionToken
- * @param {Acl | null | undefined} acl
- * @param {string | null | undefined} contentHashStr
- * @returns {string}
- */
 export declare function buildSearchParams(amzCredential: string, date: amzDate.AmzDate, expiresIn: number, headerList: string, contentHashStr: string | null | undefined, storageClass: StorageClass | null | undefined, sessionToken: string | null | undefined, acl: Acl | null | undefined): string;

package/dist/S3Client.js

@@ -10,7 +10,10 @@ import { buildRequestUrl, getRangeHeader, prepareHeadersForSigning, } from "./ur
 export const write = Symbol("write");
 export const stream = Symbol("stream");
 const xmlParser = new XMLParser();
-const xmlBuilder = new XMLBuilder();
+const xmlBuilder = new XMLBuilder({
+    attributeNamePrefix: "$",
+    ignoreAttributes: false,
+});
 /**
  * A configured S3 bucket instance for managing files.
  *
@@ -28,11 +31,9 @@ const xmlBuilder = new XMLBuilder();
  * ```
  */
 export default class S3Client {
-    /** @type {Readonly<S3ClientOptions>} */
     #options;
     #keyCache = new KeyCache();
-    // TODO: pass options to this in client
-    /** @type {Dispatcher} */
+    // TODO: pass options to this in client? Do we want to expose tjhe internal use of undici?
     #dispatcher = new Agent();
     /**
      * Create a new instance of an S3 bucket so that credentials can be managed from a single instance instead of being passed to every method.
@@ -71,9 +72,27 @@ export default class S3Client {
     /**
      * Creates an S3File instance for the given path.
      *
-     * @param {string} path
+     * @param {string} path The path to the object in the bucket. ALso known as [object key](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).
+     * We recommend not using the following characters in a key name because of significant special character handling, which isn't consistent across all applications (see [AWS docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html)):
+     * - Backslash (`\\`)
+     * - Left brace (`{`)
+     * - Non-printable ASCII characters (128–255 decimal characters)
+     * - Caret or circumflex (`^`)
+     * - Right brace (`}`)
+     * - Percent character (`%`)
+     * - Grave accent or backtick (`\``)
+     * - Right bracket (`]`)
+     * - Quotation mark (`"`)
+     * - Greater than sign (`>`)
+     * - Left bracket (`[`)
+     * - Tilde (`~`)
+     * - Less than sign (`<`)
+     * - Pound sign (`#`)
+     * - Vertical bar or pipe (`|`)
+     *
+     * lean-s3 does not enforce these restrictions.
+     *
      * @param {Partial<CreateFileInstanceOptions>} [options] TODO
-     * @returns {S3File}
      * @example
      * ```js
      * const file = client.file("image.jpg");
@@ -86,6 +105,7 @@ export default class S3Client {
      * ```
      */
     file(path, options) {
+        // TODO: Check max path length in bytes
         return new S3File(this, path, undefined, undefined, undefined);
     }
     /**
@@ -117,12 +137,115 @@ export default class S3Client {
         res.search = `${query}&X-Amz-Signature=${signature}`;
         return res.toString();
     }
-    async deleteObjects(objects, options) {
-        throw new Error("Not implemented");
+    /**
+     * Uses [`DeleteObjects`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html) to delete multiple objects in a single request.
+     */
+    async deleteObjects(objects, options = {}) {
+        const body = xmlBuilder.build({
+            Delete: {
+                Quiet: true,
+                Object: objects.map(o => ({
+                    Key: typeof o === "string" ? o : o.key,
+                })),
+            },
+        });
+        const response = await this.#signedRequest("POST", "", "delete=", // "=" is needed by minio for some reason
+        body, {
+            "content-md5": sign.md5Base64(body),
+        }, undefined, undefined, this.#options.bucket, options.signal);
+        if (response.statusCode === 200) {
+            const text = await response.body.text();
+            let res = undefined;
+            try {
+                // Quite mode omits all deleted elements, so it will be parsed as "", wich we need to coalasce to null/undefined
+                res = (xmlParser.parse(text)?.DeleteResult || undefined)?.Error ?? [];
+            }
+            catch (cause) {
+                // Possible according to AWS docs
+                throw new S3Error("Unknown", "", {
+                    message: "S3 service responded with invalid XML.",
+                    cause,
+                });
+            }
+            if (!res || !Array.isArray(res)) {
+                throw new S3Error("Unknown", "", {
+                    message: "Could not process response.",
+                });
+            }
+            const errors = res.map(e => ({
+                code: e.Code,
+                key: e.Key,
+                message: e.Message,
+                versionId: e.VersionId,
+            }));
+            return errors.length > 0 ? { errors } : null;
+        }
+        if (400 <= response.statusCode && response.statusCode < 500) {
+            throw await getResponseError(response, "");
+        }
+        response.body.dump(); // undici docs state that we should dump the body if not used
+        throw new Error(`Response code not implemented yet: ${response.statusCode}`);
+    }
+    /**
+     * Creates a new bucket on the S3 server.
+     *
+     * @param name The name of the bucket to create. AWS the name according to [some rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The most important ones are:
+     * - Bucket names must be between `3` (min) and `63` (max) characters long.
+     * - Bucket names can consist only of lowercase letters, numbers, periods (`.`), and hyphens (`-`).
+     * - Bucket names must begin and end with a letter or number.
+     * - Bucket names must not contain two adjacent periods.
+     * - Bucket names must not be formatted as an IP address (for example, `192.168.5.4`).
+     *
+     * @throws {Error} If the bucket name is invalid.
+     * @remarks Uses [`CreateBucket`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+     */
+    async createBucket(name, options) {
+        if (name.length < 3 || name.length > 63) {
+            throw new Error("`name` must be between 3 and 63 characters long.");
+        }
+        let body = undefined;
+        if (options) {
+            const location = options.location && (options.location.name || options.location.type)
+                ? {
+                    Name: options.location.name ?? undefined,
+                    Type: options.location.type ?? undefined,
+                }
+                : undefined;
+            const bucket = options.info && (options.info.dataRedundancy || options.info.type)
+                ? {
+                    DataRedundancy: options.info.dataRedundancy ?? undefined,
+                    Type: options.info.type ?? undefined,
+                }
+                : undefined;
+            body =
+                location || bucket || options.locationConstraint
+                    ? xmlBuilder.build({
+                        CreateBucketConfiguration: {
+                            $xmlns: "http://s3.amazonaws.com/doc/2006-03-01/",
+                            LocationConstraint: options.locationConstraint ?? undefined,
+                            Location: location,
+                            Bucket: bucket,
+                        },
+                    })
+                    : undefined;
+        }
+        const additionalSignedHeaders = body
+            ? { "content-md5": sign.md5Base64(body) }
+            : undefined;
+        const response = await this.#signedRequest("PUT", "", undefined, body, additionalSignedHeaders, undefined, undefined, name, options?.signal);
+        if (response.statusCode === 200) {
+            response.body.dump(); // undici docs state that we should dump the body if not used
+            return;
+        }
+        if (400 <= response.statusCode && response.statusCode < 500) {
+            throw await getResponseError(response, "");
+        }
+        response.body.dump(); // undici docs state that we should dump the body if not used
+        throw new Error(`Response code not supported: ${response.statusCode}`);
     }
     //#region list
     /**
-     * Uses `ListObjectsV2` to iterate over all keys. Pagination and continuation is handled internally.
+     * Uses [`ListObjectsV2`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) to iterate over all keys. Pagination and continuation is handled internally.
      */
     async *listIterating(options) {
         // only used to get smaller pages, so we can test this properly
@@ -142,6 +265,9 @@ export default class S3Client {
             continuationToken = res.nextContinuationToken;
         } while (continuationToken);
     }
+    /**
+     * Implements [`ListObjectsV2`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) to iterate over all keys.
+     */
     async list(options = {}) {
         // See `benchmark-operations.js` on why we don't use URLSearchParams but string concat
         // tldr: This is faster and we know the params exactly, so we can focus our encoding
@@ -174,7 +300,7 @@ export default class S3Client {
             }
             query += `&start-after=${encodeURIComponent(options.startAfter)}`;
         }
-        const response = await this.#signedRequest("GET", "", query, undefined, undefined, undefined, undefined, options.signal);
+        const response = await this.#signedRequest("GET", "", query, undefined, undefined, undefined, undefined, this.#options.bucket, options.signal);
         if (response.statusCode === 200) {
             const text = await response.body.text();
             let res = undefined;
@@ -211,13 +337,11 @@ export default class S3Client {
                 contents,
             };
         }
-        // undici docs state that we shoul dump the body if not used
-        response.body.dump();
+        response.body.dump(); // undici docs state that we should dump the body if not used
         throw new Error(`Response code not implemented yet: ${response.statusCode}`);
     }
     //#endregion
-    async #signedRequest(method, pathWithoutBucket, query, body, additionalSignedHeaders, additionalUnsignedHeaders, contentHash, signal = undefined) {
-        const bucket = this.#options.bucket;
+    async #signedRequest(method, pathWithoutBucket, query, body, additionalSignedHeaders, additionalUnsignedHeaders, contentHash, bucket, signal = undefined) {
         const endpoint = this.#options.endpoint;
         const region = this.#options.region;
         const url = buildRequestUrl(endpoint, bucket, region, pathWithoutBucket);
@@ -304,34 +428,7 @@ export default class S3Client {
             // everything seemed to work, no need to process response body
             return;
         }
-        let body = undefined;
-        try {
-            body = await response.body.text();
-        }
-        catch (cause) {
-            throw new S3Error("Unknown", path, {
-                message: "Could not read response body.",
-                cause,
-            });
-        }
-        if (response.headers["content-type"] === "application/xml") {
-            let error = undefined;
-            try {
-                error = xmlParser.parse(body);
-            }
-            catch (cause) {
-                throw new S3Error("Unknown", path, {
-                    message: "Could not parse XML error response.",
-                    cause,
-                });
-            }
-            throw new S3Error(error.Code || "Unknown", path, {
-                message: error.Message || undefined, // Message might be "",
-            });
-        }
-        throw new S3Error("Unknown", path, {
-            message: "Unknown error during S3 request.",
-        });
+        throw await getResponseError(response, path);
     }
     // TODO: Support abortSignal
     /**
@@ -445,17 +542,6 @@ export default class S3Client {
         return `AWS4-HMAC-SHA256 Credential=${credentialSpec}, SignedHeaders=${signedHeadersSpec}, Signature=${signature}`;
     }
 }
-/**
- * @param {string} amzCredential
- * @param {import("./AmzDate.ts").AmzDate} date
- * @param {number} expiresIn
- * @param {string} headerList
- * @param {StorageClass | null | undefined} storageClass
- * @param {string | null | undefined} sessionToken
- * @param {Acl | null | undefined} acl
- * @param {string | null | undefined} contentHashStr
- * @returns {string}
- */
 export function buildSearchParams(amzCredential, date, expiresIn, headerList, contentHashStr, storageClass, sessionToken, acl) {
     // We tried to make these query params entirely lower-cased, just like the headers
     // but Cloudflare R2 requires them to have this exact casing
@@ -483,3 +569,42 @@ export function buildSearchParams(amzCredential, date, expiresIn, headerList, co
     }
     return res;
 }
+async function getResponseError(response, path) {
+    let body = undefined;
+    try {
+        body = await response.body.text();
+    }
+    catch (cause) {
+        return new S3Error("Unknown", path, {
+            message: "Could not read response body.",
+            cause,
+        });
+    }
+    if (response.headers["content-type"] === "application/xml") {
+        return parseAndGetXmlError(body, path);
+    }
+    return new S3Error("Unknown", path, {
+        message: "Unknown error during S3 request.",
+    });
+}
+function parseAndGetXmlError(body, path) {
+    let error = undefined;
+    try {
+        error = xmlParser.parse(body);
+    }
+    catch (cause) {
+        return new S3Error("Unknown", path, {
+            message: "Could not parse XML error response.",
+            cause,
+        });
+    }
+    if (error.Error) {
+        const e = error.Error;
+        return new S3Error(e.Code || "Unknown", path, {
+            message: e.Message || undefined, // Message might be "",
+        });
+    }
+    return new S3Error(error.Code || "Unknown", path, {
+        message: error.Message || undefined, // Message might be "",
+    });
+}

package/dist/S3File.d.ts

@@ -12,21 +12,22 @@ export default class S3File {
     /**
      *  Get the stat of a file in the bucket. Uses `HEAD` request to check existence.
      *
+     * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
      * @throws {Error} If the file does not exist.
-     * @param {Partial<S3StatOptions>} [options]
-     * @returns {Promise<S3Stat>}
      */
     stat({ signal }?: Partial<S3StatOptions>): Promise<S3Stat>;
     /**
      * Check if a file exists in the bucket. Uses `HEAD` request to check existence.
-     * @param {Partial<S3FileExistsOptions>} [options]
-     * @returns {Promise<boolean>}
+     *
+     * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
      */
     exists({ signal, }?: Partial<S3FileExistsOptions>): Promise<boolean>;
     /**
      * Delete a file from the bucket.
+     *
+     * @remarks Uses [`DeleteObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html).
+     *
      * @param {Partial<S3FileDeleteOptions>} [options]
-     * @returns {Promise<void>}
      *
      * @example
      * ```js

package/dist/S3File.js

@@ -40,9 +40,8 @@ export default class S3File {
     /**
      *  Get the stat of a file in the bucket. Uses `HEAD` request to check existence.
      *
+     * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
      * @throws {Error} If the file does not exist.
-     * @param {Partial<S3StatOptions>} [options]
-     * @returns {Promise<S3Stat>}
      */
     async stat({ signal } = {}) {
         // TODO: Support all options
@@ -67,8 +66,8 @@ export default class S3File {
     }
     /**
      * Check if a file exists in the bucket. Uses `HEAD` request to check existence.
-     * @param {Partial<S3FileExistsOptions>} [options]
-     * @returns {Promise<boolean>}
+     *
+     * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
      */
     async exists({ signal, } = {}) {
         // TODO: Support all options
@@ -79,8 +78,10 @@ export default class S3File {
     }
     /**
      * Delete a file from the bucket.
+     *
+     * @remarks Uses [`DeleteObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html).
+     *
      * @param {Partial<S3FileDeleteOptions>} [options]
-     * @returns {Promise<void>}
      *
      * @example
      * ```js
@@ -143,14 +144,6 @@ export default class S3File {
         // This function is called for every operation on the blob
         return this.#client[stream](this.#path, undefined, this.#start, this.#end);
     }
-    /**
-     * @param {ByteSource} data
-     * @returns {Promise<[
-     *   buffer: import("./index.d.ts").UndiciBodyInit,
-     *   size: number | undefined,
-     *   hash: Buffer | undefined,
-     * ]>}
-     */
     async #transformData(data) {
         if (typeof data === "string") {
             const binary = new TextEncoder();
@@ -197,10 +190,6 @@ export default class S3File {
         return await this.#client[write](this.#path, bytes, this.#contentType, length, hash, this.#start, this.#end, signal);
     }
 }
-/**
- * @param {never} v
- * @returns {never}
- */
 function assertNever(v) {
     throw new TypeError(`Expected value not to have type ${typeof v}`);
 }

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import type { Readable } from "node:stream";
 export { default as S3File, type S3FileDeleteOptions, type S3FileExistsOptions, type S3StatOptions, } from "./S3File.ts";
-export { default as S3Client, type ListObjectsResponse, type CreateFileInstanceOptions, type OverridableS3ClientOptions, type S3ClientOptions, type S3FilePresignOptions, } from "./S3Client.ts";
+export { default as S3Client, type ListObjectsOptions, type ListObjectsIteratingOptions, type ListObjectsResponse, type CreateFileInstanceOptions, type OverridableS3ClientOptions, type S3ClientOptions, type S3FilePresignOptions, type BucketCreationOptions, type DeleteObjectsOptions, } from "./S3Client.ts";
 export { default as S3Error, type S3ErrorOptions } from "./S3Error.ts";
 export { default as S3Stat } from "./S3Stat.ts";
 export { default as S3BucketEntry } from "./S3BucketEntry.ts";
@@ -13,3 +13,17 @@ export type HttpMethod = PresignableHttpMethod | "POST";
 /** Body values supported by undici. */
 export type UndiciBodyInit = string | Buffer | Uint8Array | Readable;
 export type ByteSource = UndiciBodyInit | Blob;
+/**
+ * Implements [LocationInfo](https://docs.aws.amazon.com/AmazonS3/latest/API/API_LocationInfo.html)
+ */
+export type BucketLocationInfo = {
+    name?: string;
+    type?: string;
+};
+/**
+ * Implements [BucketInfo](https://docs.aws.amazon.com/AmazonS3/latest/API/API_BucketInfo.html)
+ */
+export type BucketInfo = {
+    dataRedundancy?: string;
+    type?: string;
+};

package/dist/index.js

@@ -3,11 +3,3 @@ export { default as S3Client, } from "./S3Client.js";
 export { default as S3Error } from "./S3Error.js";
 export { default as S3Stat } from "./S3Stat.js";
 export { default as S3BucketEntry } from "./S3BucketEntry.js";
-// TODO
-// | ArrayBufferView
-// | ArrayBuffer
-// | SharedArrayBuffer
-// | Request
-// | Response
-// | S3File
-// | ReadableStream<Uint8Array>

package/dist/sign.d.ts

@@ -13,4 +13,4 @@ export declare const unsignedPayload = "UNSIGNED-PAYLOAD";
 export declare function createCanonicalDataDigestHostOnly(method: PresignableHttpMethod, path: string, query: string, host: string): string;
 export declare function createCanonicalDataDigest(method: HttpMethod, path: string, query: string, sortedHeaders: Record<string, string>, contentHashStr: string): string;
 export declare function sha256(data: BinaryLike): Buffer;
-export declare function md5Hex(data: BinaryLike): string;
+export declare function md5Base64(data: BinaryLike): string;

package/dist/sign.js

@@ -72,6 +72,6 @@ export function createCanonicalDataDigest(method, path, query, sortedHeaders, co
 export function sha256(data) {
     return createHash("sha256").update(data).digest();
 }
-export function md5Hex(data) {
-    return createHash("md5").update(data).digest("hex");
+export function md5Base64(data) {
+    return createHash("md5").update(data).digest("base64");
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "lean-s3",
   "author": "Niklas Mollenhauer",
   "license": "MIT",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A server-side S3 API for the regular user.",
   "keywords": [
     "s3",
@@ -30,7 +30,6 @@
     "prepublishOnly": "npm run clean && npm run build"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.828.0",
     "@biomejs/biome": "^1.9.4",
     "@testcontainers/localstack": "^11.0.3",
     "@testcontainers/minio": "^11.0.3",