lean-s3 0.6.2 → 0.6.3

package/README.md

@@ -141,6 +141,9 @@ See [DESIGN_DECISIONS.md](./DESIGN_DECISIONS.md) to read about why this library
 - ✅ [`UploadPart`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) via `.uploadPart`
 - ✅ [`CompleteMultipartUpload`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) via `.completeMultipartUpload`
 - ✅ [`AbortMultipartUpload`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) via `.abortMultipartUpload`
+- ✅ [`PutBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) via `.putBucketCors`
+- ✅ [`GetBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html) via `.getBucketCors`
+- ✅ [`DeleteBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) via `.deleteBucketCors`
 
 ## Example Configurations
 ### Hetzner Object Storage

package/dist/index.d.ts

@@ -208,6 +208,35 @@ type BucketDeletionOptions = {
 type BucketExistsOptions = {
     signal?: AbortSignal;
 };
+type BucketCorsRules = readonly BucketCorsRule[];
+type BucketCorsRule = {
+    allowedMethods: readonly HttpMethod[];
+    /** One or more origins you want customers to be able to access the bucket from. */
+    allowedOrigins: readonly string[];
+    /** Headers that are specified in the `Access-Control-Request-Headers` header. These headers are allowed in a preflight `OPTIONS` request. */
+    allowedHeaders?: readonly string[];
+    /** One or more headers in the response that you want customers to be able to access from their applications. */
+    exposeHeaders?: readonly string[];
+    /** Unique identifier for the rule. The value cannot be longer than 255 characters. */
+    id?: string;
+    /** The time in seconds that your browser is to cache the preflight response for the specified resource. */
+    maxAgeSeconds?: number;
+};
+type PutBucketCorsOptions = {
+    bucket?: string;
+    signal?: AbortSignal;
+};
+type DeleteBucketCorsOptions = {
+    bucket?: string;
+    signal?: AbortSignal;
+};
+type GetBucketCorsOptions = {
+    bucket?: string;
+    signal?: AbortSignal;
+};
+type GetBucketCorsResult = {
+    rules: BucketCorsRule[];
+};
 /**
  * A configured S3 bucket instance for managing files.
  *
@@ -232,6 +261,11 @@ declare class S3Client {
      * @param  options The default options to use for the S3 client.
      */
     constructor(options: S3ClientOptions);
+    cors: {
+        get: () => void;
+        set: () => void;
+        delete: () => void;
+    };
     /**
      * Creates an S3File instance for the given path.
      *
@@ -345,6 +379,18 @@ declare class S3Client {
      * @remarks Uses [`HeadBucket`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html).
      */
     bucketExists(name: string, options?: BucketExistsOptions): Promise<boolean>;
+    /**
+     * @remarks Uses [`PutBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html).
+     */
+    putBucketCors(rules: BucketCorsRules, options?: PutBucketCorsOptions): Promise<void>;
+    /**
+     * @remarks Uses [`GetBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html).
+     */
+    getBucketCors(options?: GetBucketCorsOptions): Promise<GetBucketCorsResult>;
+    /**
+     * @remarks Uses [`DeleteBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html).
+     */
+    deleteBucketCors(options?: DeleteBucketCorsOptions): 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.
      */
@@ -490,4 +536,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 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 };
+export { type AbortMultipartUploadOptions, type Acl, type BucketCorsRule, type BucketCorsRules, 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 GetBucketCorsOptions, type GetBucketCorsResult, type HttpMethod, type ListMultipartUploadsOptions, type ListMultipartUploadsResult, type ListObjectsIteratingOptions, type ListObjectsOptions, type ListObjectsResult, type ListPartsOptions, type ListPartsResult, type MultipartUpload, type MultipartUploadPart, type OverridableS3ClientOptions, type PresignableHttpMethod, type PutBucketCorsOptions, 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

@@ -404,6 +404,14 @@ var S3Client = class {
       sessionToken
     };
   }
+  cors = {
+    get: () => {
+    },
+    set: () => {
+    },
+    delete: () => {
+    }
+  };
   /**
    * Creates an S3File instance for the given path.
    *
@@ -912,6 +920,90 @@ var S3Client = class {
     }
     throw new Error(`Response code not supported: ${response.statusCode}`);
   }
+  //#region bucket cors
+  /**
+   * @remarks Uses [`PutBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html).
+   */
+  async putBucketCors(rules, options = {}) {
+    const body = xmlBuilder.build({
+      CORSConfiguration: {
+        CORSRule: rules.map((r) => ({
+          AllowedOrigin: r.allowedOrigins,
+          AllowedMethod: r.allowedMethods,
+          ExposeHeader: r.exposeHeaders,
+          ID: r.id ?? void 0,
+          MaxAgeSeconds: r.maxAgeSeconds ?? void 0
+        }))
+      }
+    });
+    const response = await this[signedRequest](
+      "PUT",
+      "",
+      "cors=",
+      // "=" is needed by minio for some reason
+      body,
+      {
+        "content-md5": md5Base64(body)
+      },
+      void 0,
+      void 0,
+      ensureValidBucketName(options.bucket ?? this.#options.bucket),
+      options.signal
+    );
+    if (response.statusCode === 200) {
+      response.body.dump();
+      return;
+    }
+    if (400 <= response.statusCode && response.statusCode < 500) {
+      throw await getResponseError(response, "");
+    }
+    throw new Error(
+      `Response code not implemented yet: ${response.statusCode}`
+    );
+  }
+  /**
+   * @remarks Uses [`GetBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html).
+   */
+  async getBucketCors(options = {}) {
+    const response = await this[signedRequest](
+      "GET",
+      "",
+      "cors=",
+      // "=" is needed by minio for some reason
+      void 0,
+      void 0,
+      void 0,
+      void 0,
+      ensureValidBucketName(options.bucket ?? this.#options.bucket),
+      options.signal
+    );
+    if (response.statusCode !== 200) {
+      response.body.dump();
+      throw fromStatusCode(response.statusCode, "");
+    }
+    throw new Error("Not implemented");
+  }
+  /**
+   * @remarks Uses [`DeleteBucketCors`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html).
+   */
+  async deleteBucketCors(options = {}) {
+    const response = await this[signedRequest](
+      "DELETE",
+      "",
+      "cors=",
+      // "=" is needed by minio for some reason
+      void 0,
+      void 0,
+      void 0,
+      void 0,
+      ensureValidBucketName(options.bucket ?? this.#options.bucket),
+      options.signal
+    );
+    if (response.statusCode !== 204) {
+      response.body.dump();
+      throw fromStatusCode(response.statusCode, "");
+    }
+  }
   //#endregion
   //#region list objects
   /**

package/package.json

@@ -2,7 +2,7 @@
   "name": "lean-s3",
   "author": "Niklas Mollenhauer",
   "license": "MIT",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "A server-side S3 API for the regular user.",
   "keywords": [
     "s3",
@@ -44,19 +44,19 @@
   },
   "dependencies": {
     "fast-xml-parser": "^5.2.5",
-    "undici": "^7.10.0"
+    "undici": "^7.11.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.0.5",
+    "@biomejs/biome": "2.0.6",
     "@testcontainers/localstack": "^11.0.3",
     "@testcontainers/minio": "^11.0.3",
-    "@types/node": "^24.0.4",
-    "@typescript/native-preview": "^7.0.0-dev.20250626.1",
+    "@types/node": "^24.0.7",
+    "@typescript/native-preview": "^7.0.0-dev.20250629.1",
     "expect": "^30.0.3",
     "lefthook": "^1.11.14",
     "tsup": "^8.5.0",
     "tsx": "^4.20.3",
-    "typedoc": "^0.28.5"
+    "typedoc": "^0.28.6"
   },
   "engines": {
     "node": "^20.19.2 || ^22.16.0 || ^24.2.0"