@types/ali-oss 6.0.11 → 6.16.3

ali-oss/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for ali-oss (https://github.com/aliyun/os
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ali-oss.
 
 ### Additional Details
- * Last updated: Sat, 18 Sep 2021 08:01:23 GMT
+ * Last updated: Fri, 18 Feb 2022 14:31:33 GMT
  * Dependencies: none
  * Global values: none
 

ali-oss/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for ali-oss 6.0
+// Type definitions for ali-oss 6.16
 // Project: https://github.com/aliyun/oss-nodejs-sdk
 // Definitions by: Ptrdu <https://github.com/ptrdu>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -32,7 +32,7 @@ declare namespace OSS {
         /** use time (ms) of refresh STSToken interval it should be less than sts info expire interval, default is 300000ms(5min) when sts info expires. */
         refreshSTSTokenInterval?: number;
         /** used by auto set stsToken、accessKeyId、accessKeySecret when sts info expires. return value must be object contains stsToken、accessKeyId、accessKeySecret */
-        refreshSTSToken?: () => Promise<{accessKeyId: string, accessKeySecret: string, stsToken: string}>;
+        refreshSTSToken?: () => Promise<{ accessKeyId: string, accessKeySecret: string, stsToken: string }>;
     }
 
     /**
@@ -149,6 +149,8 @@ declare namespace OSS {
     interface ObjectMeta {
         /** object name on oss */
         name: string;
+        /** object url */
+        url: string;
         /** object last modified GMT date, e.g.: 2015-02-19T08:39:44.000Z */
         lastModified: string;
         /** object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" */
@@ -158,7 +160,17 @@ declare namespace OSS {
         /** object size, e.g.: 344606 */
         size: number;
         storageClass: StorageType;
-        owner: OwnerType;
+        owner?: OwnerType;
+    }
+
+    interface BucketPolicy {
+        Version: string;
+        Statement: Array<{
+            Action: string[];
+            Effect: 'Allow' | 'Deny';
+            Principal: string[];
+            Resource: string[];
+        }>;
     }
 
     interface NormalSuccessResponse {
@@ -173,7 +185,11 @@ declare namespace OSS {
         rt: number;
     }
 
-    interface UserMeta {
+    /**
+     * @see x-oss-meta-* in https://help.aliyun.com/document_detail/31978.html for Aliyun user
+     * @see x-oss-meta-* in https://www.alibabacloud.com/help/en/doc-detail/31978.html for AlibabaCloud user
+     */
+    interface UserMeta extends Record<string, string | number> {
         uid: number;
         pid: number;
     }
@@ -239,6 +255,7 @@ declare namespace OSS {
         /** the remote addr */
         RemoteAddr: string;
     }
+
     // parameters type
     interface ListBucketsQueryType {
         /** search buckets using prefix key */
@@ -272,6 +289,28 @@ declare namespace OSS {
         delimiter?: string | undefined; // delimiter search scope e.g.
         /** max objects, default is 100, limit to 1000 */
         'max-keys': string | number;
+        /** Specifies that the object names in the response are URL-encoded. */
+        'encoding-type'?: 'url' | '';
+    }
+
+    interface ListV2ObjectsQuery {
+        /** search object using prefix key */
+        prefix?: string;
+        /** search start from token, including token key */
+        'continuation-token'?: string;
+        /** only search current dir, not including subdir */
+        delimiter?: string | number;
+        /** max objects, default is 100, limit to 1000  */
+        'max-keys'?: string;
+        /**
+         * The name of the object from which the list operation begins.
+         * If this parameter is specified, objects whose names are alphabetically greater than the start-after parameter value are returned.
+         */
+        'start-after'?: string;
+        /** Specifies whether to include the information about object owners in the response. */
+        'fetch-owner'?: boolean;
+        /** Specifies that the object names in the response are URL-encoded. */
+        'encoding-type'?: 'url' | '';
     }
 
     interface ListObjectResult {
@@ -591,6 +630,18 @@ declare namespace OSS {
         /** the operation timeout */
         timeout?: number | undefined;
     }
+
+    interface GetBucketPolicyResult {
+        policy: BucketPolicy | null;
+        status: number;
+        res: NormalSuccessResponse;
+    }
+
+    interface PostObjectParams {
+        policy: string;
+        OSSAccessKeyId: string;
+        Signature: string;
+    }
 }
 
 // cluster
@@ -606,11 +657,16 @@ declare namespace OSS {
         schedule?: string | undefined;
     }
 
-    class Cluster {
+    class ClusterClient {
         constructor(options: ClusterOptions);
 
         list(query: ListObjectsQuery | null, options: RequestOptions): Promise<ListObjectResult>;
 
+        /**
+         * @since 6.12.0
+         */
+        listV2(query: ListV2ObjectsQuery | null, options: RequestOptions): Promise<ListObjectResult>;
+
         put(name: string, file: any, options?: PutObjectOptions): Promise<PutObjectResult>;
 
         putStream(
@@ -886,6 +942,35 @@ declare class OSS {
      */
     deleteBucketCORS(name: string): Promise<OSS.NormalSuccessResponse>;
 
+    // policy operations
+    /**
+     * Adds or modify policy for a bucket.
+     */
+    putBucketPolicy(
+        name: string,
+        policy: OSS.BucketPolicy,
+        options?: OSS.RequestOptions
+    ): Promise<{
+        status: number,
+        res: OSS.NormalSuccessResponse,
+    }>;
+
+    /**
+     * Obtains the policy for a bucket.
+     */
+    getBucketPolicy(name: string, options?: OSS.RequestOptions): Promise<OSS.GetBucketPolicyResult>;
+
+    /**
+     * Deletes the policy added for a bucket.
+     */
+    deleteBucketPolicy(
+        name: string,
+        options?: OSS.RequestOptions
+    ): Promise<{
+        status: number,
+        res: OSS.NormalSuccessResponse,
+    }>;
+
     /********************************************************** Object operations ********************************************/
     /**
      * List objects in the bucket.
@@ -1057,6 +1142,16 @@ declare class OSS {
         options?: OSS.RequestOptions,
     ): Promise<OSS.NormalSuccessResponse>;
 
+    /**
+     * get postObject params.
+     */
+    calculatePostSignature(
+        /**
+         * policy config object or JSON string
+         */
+        policy: object | string
+    ): OSS.PostObjectParams;
+
     /************************************************ RTMP Operations *************************************************************/
     /**
      * Create a live channel.

ali-oss/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/ali-oss",
-    "version": "6.0.11",
+    "version": "6.16.3",
     "description": "TypeScript definitions for ali-oss",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ali-oss",
     "license": "MIT",
@@ -20,6 +20,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "bd38560fcac2b30b10f7d686a37a7d677519fb8f3d36e1c4899de9df5ff73a3a",
-    "typeScriptVersion": "3.7"
+    "typesPublisherContentHash": "4433b0f3e5b2ce255a06937c0fb9e830d816e3a808d9f053a3521cfb9718e790",
+    "typeScriptVersion": "3.8"
 }