refactor: getBucketPolicy

docs/API.md

@@ -2026,26 +2026,23 @@ listener.on('notification', function (record) {
 
 <a name="getBucketPolicy"></a>
 
-### getBucketPolicy(bucketName [, callback])
+### async getBucketPolicy(bucketName: string): Promise<string>
 
 Get the bucket policy associated with the specified bucket. If `objectPrefix`
 is not empty, the bucket policy will be filtered based on object permissions
 as well.
 
 **Parameters**
 
-| Param                   | Type       | Description                                                                                                                                                                                                                           |
-| ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `bucketName`            | _string_   | Name of the bucket                                                                                                                                                                                                                    |
-| `callback(err, policy)` | _function_ | Callback function is called with non `null` err value in case of error. `policy` is [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html). If no callback is passed, a `Promise` is returned. |
+| Param        | Type     | Description        |
+| ------------ | -------- | ------------------ |
+| `bucketName` | _string_ | Name of the bucket |
 
 ```js
 // Retrieve bucket policy of 'my-bucketname'
-minioClient.getBucketPolicy('my-bucketname', function (err, policy) {
-  if (err) throw err
+const policy = await minioClient.getBucketPolicy('my-bucketname')
 
-  console.log(`Bucket policy file: ${policy}`)
-})
+console.log(`Bucket policy file: ${policy}`)
 ```
 
 <a name="setBucketPolicy"></a>

docs/zh_CN/API.md

@@ -958,7 +958,7 @@ listener.on('notification', function(record) {
 ```
 
 <a name="getBucketPolicy"></a>
-### getBucketPolicy(bucketName, objectPrefix[, callback])
+### async getBucketPolicy(bucketName: string): Promise<string>
 
 获取指定存储桶的访问策略，如果`objectPrefix`不为空，则会取相应对象前缀上的访问策略。
 
@@ -968,18 +968,13 @@ __参数__
 | 参数  |  类型 | 描述  |
 |---|---|---|
 | `bucketName`  | _string_  | 存储桶名称。 |
-| `objectPrefix` | _string_ | 用于过滤的对象前缀，`''`代表整个存储桶。 |
-| `callback(err, policy)`  | _function_  | 如果`err`不是null则代表有错误。`policy`是存储桶策略的字符串表示(`minio.Policy.NONE`，`minio.Policy.READONLY`，`minio.Policy.WRITEONLY`，或者`minio.Policy.READWRITE`). 如果没有传callback的话，则返回一个`Promise`对象。 |
 
 
 ```js
 // Retrieve bucket policy of 'my-bucketname' that applies to all objects that
-// start with 'img-'.
-minioClient.getBucketPolicy('my-bucketname', 'img-', function(err, policy) {
-  if (err) throw err
+const policy = await minioClient.getBucketPolicy('my-bucketname')
 
-  console.log(`Bucket policy: ${policy}`)
-})
+console.log(`Bucket policy file: ${policy}`)
 ```
 
 <a name="setBucketPolicy"></a>

src/internal/client.ts

@@ -1500,7 +1500,7 @@
 
     const chunkier = new BlockStream2({ size: partSize, zeroPadding: false })
 
     const [_, o] = await Promise.all([
       new Promise((resolve, reject) => {
         body.pipe(chunkier).on('error', reject)
         chunkier.on('end', resolve).on('error', reject)
@@ -1743,6 +1743,21 @@
     return xmlParsers.parseTagging(body)
   }
 
+  /**
+   * Get the policy on a bucket or an object prefix.
+   */
+  async getBucketPolicy(bucketName: string): Promise<string> {
+    // Validate arguments.
+    if (!isValidBucketName(bucketName)) {
+      throw new errors.InvalidBucketNameError(`Invalid bucket name: ${bucketName}`)
+    }
+
+    const method = 'GET'
+    const query = 'policy'
+    const res = await this.makeRequestAsync({ method, bucketName, query })
+    return await readAsString(res)
+  }
+
   async putObjectRetention(bucketName: string, objectName: string, retentionOpts: Retention = {}): Promise<void> {
     if (!isValidBucketName(bucketName)) {
       throw new errors.InvalidBucketNameError(`Invalid bucket name: ${bucketName}`)

src/minio.d.ts

@@ -420,9 +420,6 @@ export class Client extends TypedClient {
   removeAllBucketNotification(bucketName: string, callback: NoResultCallback): void
   removeAllBucketNotification(bucketName: string): Promise<void>
 
-  getBucketPolicy(bucketName: string, callback: ResultCallback<string>): void
-  getBucketPolicy(bucketName: string): Promise<string>
-
   setBucketPolicy(bucketName: string, bucketPolicy: string, callback: NoResultCallback): void
   setBucketPolicy(bucketName: string, bucketPolicy: string): Promise<void>
 

src/minio.js

@@ -820,37 +820,6 @@ export class Client extends TypedClient {
     )
   }
 
-  // Get the policy on a bucket or an object prefix.
-  //
-  // __Arguments__
-  // * `bucketName` _string_: name of the bucket
-  // * `callback(err, policy)` _function_: callback function
-  getBucketPolicy(bucketName, cb) {
-    // Validate arguments.
-    if (!isValidBucketName(bucketName)) {
-      throw new errors.InvalidBucketNameError(`Invalid bucket name: ${bucketName}`)
-    }
-    if (!isFunction(cb)) {
-      throw new TypeError('callback should be of type "function"')
-    }
-
-    let method = 'GET'
-    let query = 'policy'
-    this.makeRequest({ method, bucketName, query }, '', [200], '', true, (e, response) => {
-      if (e) {
-        return cb(e)
-      }
-
-      let policy = Buffer.from('')
-      pipesetup(response, transformers.getConcater())
-        .on('data', (data) => (policy = data))
-        .on('error', cb)
-        .on('end', () => {
-          cb(null, policy.toString())
-        })
-    })
-  }
-
   // Set the policy on a bucket or an object prefix.
   //
   // __Arguments__
@@ -1827,7 +1796,6 @@ Client.prototype.presignedPostPolicy = promisify(Client.prototype.presignedPostP
 Client.prototype.getBucketNotification = promisify(Client.prototype.getBucketNotification)
 Client.prototype.setBucketNotification = promisify(Client.prototype.setBucketNotification)
 Client.prototype.removeAllBucketNotification = promisify(Client.prototype.removeAllBucketNotification)
-Client.prototype.getBucketPolicy = promisify(Client.prototype.getBucketPolicy)
 Client.prototype.setBucketPolicy = promisify(Client.prototype.setBucketPolicy)
 Client.prototype.removeIncompleteUpload = promisify(Client.prototype.removeIncompleteUpload)
 Client.prototype.setBucketTagging = promisify(Client.prototype.setBucketTagging)
@@ -1864,6 +1832,6 @@ Client.prototype.getObjectTagging = callbackify(Client.prototype.getObjectTaggin
 Client.prototype.putObjectRetention = callbackify(Client.prototype.putObjectRetention)
 Client.prototype.setObjectLockConfig = callbackify(Client.prototype.setObjectLockConfig)
 Client.prototype.getObjectLockConfig = callbackify(Client.prototype.getObjectLockConfig)
-
+Client.prototype.getBucketPolicy = callbackify(Client.prototype.getBucketPolicy)
 Client.prototype.getBucketVersioning = callbackify(Client.prototype.getBucketVersioning)
 Client.prototype.setBucketVersioning = callbackify(Client.prototype.setBucketVersioning)