lean-s3 0.6.1 → 0.6.2

package/dist/index.d.ts

@@ -45,6 +45,15 @@ type DeleteObjectsOptions = {
     bucket?: string;
     signal?: AbortSignal;
 };
+type DeleteObjectsResult = {
+    errors: DeleteObjectsError[];
+};
+type DeleteObjectsError = {
+    code: string;
+    key: string;
+    message: string;
+    versionId: string;
+};
 interface S3FilePresignOptions {
     contentHash: Buffer;
     /** Seconds. */
@@ -58,6 +67,7 @@ type ListObjectsOptions = {
     bucket?: string;
     prefix?: string;
     maxKeys?: number;
+    delimiter?: string;
     startAfter?: string;
     continuationToken?: string;
     signal?: AbortSignal;
@@ -348,9 +358,7 @@ declare class S3Client {
     /**
      * 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: any;
-    } | null>;
+    deleteObjects(objects: readonly S3BucketEntry[] | readonly string[], options?: DeleteObjectsOptions): Promise<DeleteObjectsResult>;
     /**
      * Do not use this. This is an internal method.
      * TODO: Maybe move this into a separate free function?
@@ -379,9 +387,7 @@ declare class S3Stat {
 
 declare class S3File {
     #private;
-    /**
-     * @internal
-     */
+    /** @internal */
     constructor(client: S3Client, path: ObjectKey, start: number | undefined, end: number | undefined, contentType: string | undefined);
     slice(start?: number | undefined, end?: number | undefined, contentType?: string | undefined): S3File;
     /**
@@ -391,13 +397,13 @@ declare class S3File {
      * @throws {S3Error} If the file does not exist or the server has some other issues.
      * @throws {Error} If the server returns an invalid response.
      */
-    stat({ signal }?: Partial<S3StatOptions>): Promise<S3Stat>;
+    stat(options?: Partial<S3StatOptions>): Promise<S3Stat>;
     /**
      * Check if a file exists in the bucket. Uses `HEAD` request to check existence.
      *
      * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
      */
-    exists({ signal, }?: Partial<S3FileExistsOptions>): Promise<boolean>;
+    exists(options?: Partial<S3FileExistsOptions>): Promise<boolean>;
     /**
      * Delete a file from the bucket.
      *
@@ -409,18 +415,18 @@ declare class S3File {
      * @example
      * ```js
      * // Simple delete
-     * await client.unlink("old-file.txt");
+     * await client.delete("old-file.txt");
      *
      * // With error handling
      * try {
-     *   await client.unlink("file.dat");
+     *   await client.delete("file.dat");
      *   console.log("File deleted");
      * } catch (err) {
      *   console.error("Delete failed:", err);
      * }
      * ```
      */
-    delete({ signal }?: Partial<S3FileDeleteOptions>): Promise<void>;
+    delete(options?: Partial<S3FileDeleteOptions>): Promise<void>;
     toString(): string;
     json(): Promise<unknown>;
     bytes(): Promise<Uint8Array>;
@@ -484,4 +490,4 @@ type BucketInfo = {
     type?: string;
 };
 
-export { type AbortMultipartUploadOptions, type Acl, type BucketCreationOptions, type BucketDeletionOptions, type BucketExistsOptions, type BucketInfo, type BucketLocationInfo, type ByteSource, type ChecksumAlgorithm, type ChecksumType, type CompleteMultipartUploadOptions, type CompleteMultipartUploadResult, type CreateFileInstanceOptions, type CreateMultipartUploadOptions, type CreateMultipartUploadResult, type DeleteObjectsOptions, type HttpMethod, type ListMultipartUploadsOptions, type ListMultipartUploadsResult, type ListObjectsIteratingOptions, type ListObjectsOptions, type ListObjectsResult, type ListPartsOptions, type ListPartsResult, type MultipartUpload, type MultipartUploadPart, type OverridableS3ClientOptions, type PresignableHttpMethod, S3BucketEntry, S3Client, type S3ClientOptions, S3Error, type S3ErrorOptions, S3File, type S3FileDeleteOptions, type S3FileExistsOptions, type S3FilePresignOptions, S3Stat, type S3StatOptions, type StorageClass, type UndiciBodyInit, type UploadPartOptions, type UploadPartResult };
+export { type AbortMultipartUploadOptions, type Acl, type BucketCreationOptions, type BucketDeletionOptions, type BucketExistsOptions, type BucketInfo, type BucketLocationInfo, type ByteSource, type ChecksumAlgorithm, type ChecksumType, type CompleteMultipartUploadOptions, type CompleteMultipartUploadResult, type CreateFileInstanceOptions, type CreateMultipartUploadOptions, type CreateMultipartUploadResult, type DeleteObjectsError, type DeleteObjectsOptions, type DeleteObjectsResult, type HttpMethod, type ListMultipartUploadsOptions, type ListMultipartUploadsResult, type ListObjectsIteratingOptions, type ListObjectsOptions, type ListObjectsResult, type ListPartsOptions, type ListPartsResult, type MultipartUpload, type MultipartUploadPart, type OverridableS3ClientOptions, type PresignableHttpMethod, S3BucketEntry, S3Client, type S3ClientOptions, S3Error, type S3ErrorOptions, S3File, type S3FileDeleteOptions, type S3FileExistsOptions, type S3FilePresignOptions, S3Stat, type S3StatOptions, type StorageClass, type UndiciBodyInit, type UploadPartOptions, type UploadPartResult };

package/dist/index.js

@@ -202,7 +202,7 @@ function buildRequestUrl(endpoint, bucket, region, path) {
   const result = new URL(endpointWithBucketAndRegion);
   const pathPrefix = result.pathname.endsWith("/") ? result.pathname : `${result.pathname}/`;
   const pathSuffix = replacedBucket ? normalizePath(path) : `${normalizedBucket}/${normalizePath(path)}`;
-  result.pathname = pathPrefix + pathSuffix.replaceAll(":", "%3A").replaceAll("+", "%2B").replaceAll("(", "%28").replaceAll(")", "%29");
+  result.pathname = pathPrefix + pathSuffix.replaceAll(":", "%3A").replaceAll("+", "%2B").replaceAll("(", "%28").replaceAll(")", "%29").replaceAll(",", "%2C");
   return result;
 }
 function replaceDomainPlaceholders(endpoint, bucket, region) {
@@ -721,7 +721,7 @@ var S3Client = class {
       options.signal
     );
     if (response.statusCode === 200) {
-      await response.body.dump();
+      response.body.dump();
       const etag = response.headers.etag;
       if (typeof etag !== "string" || etag.length === 0) {
         throw new S3Error("Unknown", "", {
@@ -848,7 +848,7 @@ var S3Client = class {
     if (400 <= response.statusCode && response.statusCode < 500) {
       throw await getResponseError(response, "");
     }
-    await response.body.dump();
+    response.body.dump();
     if (response.statusCode === 200) {
       return;
     }
@@ -876,7 +876,7 @@ var S3Client = class {
     if (400 <= response.statusCode && response.statusCode < 500) {
       throw await getResponseError(response, "");
     }
-    await response.body.dump();
+    response.body.dump();
     if (response.statusCode === 204) {
       return;
     }
@@ -903,7 +903,7 @@ var S3Client = class {
     if (response.statusCode !== 404 && 400 <= response.statusCode && response.statusCode < 500) {
       throw await getResponseError(response, "");
     }
-    await response.body.dump();
+    response.body.dump();
     if (response.statusCode === 200) {
       return true;
     }
@@ -956,6 +956,12 @@ var S3Client = class {
       }
       query += `&max-keys=${options.maxKeys}`;
     }
+    if (typeof options.delimiter !== "undefined") {
+      if (typeof options.delimiter !== "string") {
+        throw new TypeError("`delimiter` must be a `string`.");
+      }
+      query += `&delimiter=${options.delimiter === "/" ? "/" : encodeURIComponent(options.delimiter)}`;
+    }
     if (options.prefix) {
       if (typeof options.prefix !== "string") {
         throw new TypeError("`prefix` must be a `string`.");
@@ -1051,7 +1057,7 @@ var S3Client = class {
           versionId: e.VersionId
         })) ?? []
       );
-      return errors.length > 0 ? { errors } : null;
+      return { errors };
     }
     if (400 <= response.statusCode && response.statusCode < 500) {
       throw await getResponseError(response, "");
@@ -1352,9 +1358,7 @@ var S3File = class _S3File {
   #start;
   #end;
   #contentType;
-  /**
-   * @internal
-   */
+  /** @internal */
   constructor(client, path, start, end, contentType) {
     if (typeof start === "number" && start < 0) {
       throw new Error("Invalid slice `start`.");
@@ -1385,7 +1389,7 @@ var S3File = class _S3File {
    * @throws {S3Error} If the file does not exist or the server has some other issues.
    * @throws {Error} If the server returns an invalid response.
    */
-  async stat({ signal } = {}) {
+  async stat(options = {}) {
     const response = await this.#client[signedRequest](
       "HEAD",
       this.#path,
@@ -1395,9 +1399,9 @@ var S3File = class _S3File {
       void 0,
       void 0,
       void 0,
-      signal
+      options.signal
     );
-    await response.body.dump();
+    response.body.dump();
     if (200 <= response.statusCode && response.statusCode < 300) {
       const result = S3Stat.tryParseFromHeaders(response.headers);
       if (!result) {
@@ -1416,9 +1420,7 @@ var S3File = class _S3File {
    *
    * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
    */
-  async exists({
-    signal
-  } = {}) {
+  async exists(options = {}) {
     const response = await this.#client[signedRequest](
       "HEAD",
       this.#path,
@@ -1428,9 +1430,9 @@ var S3File = class _S3File {
       void 0,
       void 0,
       void 0,
-      signal
+      options.signal
     );
-    await response.body.dump();
+    response.body.dump();
     if (200 <= response.statusCode && response.statusCode < 300) {
       return true;
     }
@@ -1452,18 +1454,18 @@ var S3File = class _S3File {
    * @example
    * ```js
    * // Simple delete
-   * await client.unlink("old-file.txt");
+   * await client.delete("old-file.txt");
    *
    * // With error handling
    * try {
-   *   await client.unlink("file.dat");
+   *   await client.delete("file.dat");
    *   console.log("File deleted");
    * } catch (err) {
    *   console.error("Delete failed:", err);
    * }
    * ```
    */
-  async delete({ signal } = {}) {
+  async delete(options = {}) {
     const response = await this.#client[signedRequest](
       "DELETE",
       this.#path,
@@ -1473,10 +1475,10 @@ var S3File = class _S3File {
       void 0,
       void 0,
       void 0,
-      signal
+      options.signal
     );
     if (response.statusCode === 204) {
-      await response.body.dump();
+      response.body.dump();
       return;
     }
     throw await getResponseError(response, this.#path);
@@ -1556,10 +1558,6 @@ var S3File = class _S3File {
   }
   /*
   // Future API?
-  writer(): WritableStream<ArrayBufferLike | ArrayBufferView> {
-  	throw new Error("Not implemented");
-  }
-  // Future API?
   setTags(): Promise<void> {
   	throw new Error("Not implemented");
   }

package/package.json

@@ -2,7 +2,7 @@
   "name": "lean-s3",
   "author": "Niklas Mollenhauer",
   "license": "MIT",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "A server-side S3 API for the regular user.",
   "keywords": [
     "s3",
@@ -44,16 +44,15 @@
   },
   "dependencies": {
     "fast-xml-parser": "^5.2.5",
-    "i": "^0.3.7",
     "undici": "^7.10.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.0.0",
+    "@biomejs/biome": "2.0.5",
     "@testcontainers/localstack": "^11.0.3",
     "@testcontainers/minio": "^11.0.3",
-    "@types/node": "^24.0.3",
-    "@typescript/native-preview": "^7.0.0-dev.20250620.1",
-    "expect": "^30.0.2",
+    "@types/node": "^24.0.4",
+    "@typescript/native-preview": "^7.0.0-dev.20250626.1",
+    "expect": "^30.0.3",
     "lefthook": "^1.11.14",
     "tsup": "^8.5.0",
     "tsx": "^4.20.3",