add getBucketPolicyStatus

Author: c4spar

src/client.ts

@@ -3,8 +3,10 @@ import type {
   CreateBucketOptions,
   DeleteBucketPolicyOptions,
   GetBucketPolicyOptions,
+  GetBucketPolicyStatusOptions,
   ListBucketsResponses,
   Policy,
+  PolicyStatus,
   PutBucketPolicyOptions,
   Statement,
 } from "./types.ts";
@@ -231,8 +233,42 @@ export class S3 {
     await resp.arrayBuffer();
   }
 
-  #parseListBucketsResponseXml(x: string): ListBucketsResponses {
-    const doc: Document = parseXML(x);
+  async getBucketPolicyStatus(
+    bucket: string,
+    options?: GetBucketPolicyStatusOptions,
+  ): Promise<PolicyStatus> {
+    const headers: Params = {};
+    const params: Params = {};
+
+    if (options?.expectedBucketOwner) {
+      headers["x-amz-expected-bucket-owner"] = options.expectedBucketOwner;
+    }
+
+    params["policyStatus"] = "true";
+
+    const resp = await doRequest({
+      host: this.#host,
+      signer: this.#signer,
+      path: bucket,
+      method: "GET",
+      headers,
+      params,
+    });
+
+    if (resp.status !== 200) {
+      throw new S3Error(
+        `Failed to get policy status for bucket "${bucket}": ${resp.status} ${resp.statusText}`,
+        await resp.text(),
+      );
+    }
+
+    return this.#parseGetBucketPolicyStatusResult(
+      await resp.text(),
+    );
+  }
+
+  #parseListBucketsResponseXml(xml: string): ListBucketsResponses {
+    const doc: Document = parseXML(xml);
     const root = extractRoot(doc, "ListAllMyBucketsResult");
     const buckets = extractField(root, "Buckets")!;
     const owner = extractField(root, "Owner")!;
@@ -281,4 +317,12 @@ export class S3 {
       return mapped;
     }
   }
+
+  #parseGetBucketPolicyStatusResult(xml: string): PolicyStatus {
+    const doc: Document = parseXML(xml);
+    const root = extractRoot(doc, "PolicyStatus");
+    const isPublic =
+      extractContent(root, "IsPublic ")?.toLowerCase() === "true";
+    return { isPublic };
+  }
 }

src/client_test.ts

@@ -105,11 +105,22 @@ Deno.test({
     await s3.putBucketPolicy("test.bucket", { policy });
     const resp = await s3.getBucketPolicy("test.bucket");
     assert(resp);
+
+    // teardown
     await s3.deleteBucketPolicy("test.bucket");
+
     await assertThrowsAsync(
       () => s3.getBucketPolicy("test.bucket"),
       S3Error,
       'Failed to get policy for bucket "test.bucket": 404 Not Found',
     );
   },
 });
+
+Deno.test({
+  name: "[client] should get the bucket policy status",
+  async fn() {
+    const resp = await s3.getBucketPolicyStatus("test.bucket");
+    assertEquals(resp, { isPublic: false });
+  },
+});

src/types.ts

@@ -728,3 +728,20 @@ export interface DeleteBucketPolicyOptions {
    */
   expectedBucketOwner?: string;
 }
+
+export interface GetBucketPolicyStatusOptions {
+  /**
+   * The account ID of the expected bucket owner. If the bucket is owned by a
+   * different account, the request will fail with an HTTP 403 (Access Denied)
+   * error.
+   */
+  expectedBucketOwner?: string;
+}
+
+export interface PolicyStatus {
+  /**
+   * The policy status for this bucket. TRUE indicates that this bucket is
+   * public. FALSE indicates that the bucket is not public.
+   */
+  isPublic: boolean;
+}