🤖 Merge PR DefinitelyTyped#74303 ali-oss: add signatureUrlV4 by @cnjsstong

Co-authored-by: StarHeart <starheart233@gmail.com>

Author: cnjsstong

types/ali-oss/ali-oss-tests.ts

@@ -5,6 +5,7 @@ const ossOptions: OSS.Options = {
     accessKeySecret: "your access secret",
     bucket: "your bucket name",
     region: "oss-cn-hangzhou",
+    authorizationV4: true,
 };
 
 const client = new OSS(ossOptions);
@@ -15,6 +16,43 @@ client.copy("newfile.png", "sourcefile.png", { timeout: 1000 });
 client.copy("newfile.png", "sourcefile.png", "sourceBucket");
 client.copy("newfile.png", "sourcefile.png", "sourceBucket", { timeout: 1000 });
 
+// $ExpectType Promise<string>
+client.signatureUrlV4("GET", 60, undefined, "your object name");
+
+// $ExpectType Promise<string>
+client.signatureUrlV4(
+    "GET",
+    60,
+    {
+        headers: {
+            "Cache-Control": "no-cache",
+        },
+        queries: {
+            versionId: "version ID of your object",
+        },
+    },
+    "your object name",
+    ["Cache-Control"],
+);
+
+// $ExpectType Promise<string>
+client.signatureUrlV4("PUT", 60, undefined, "your object name");
+
+// $ExpectType Promise<string>
+client.signatureUrlV4(
+    "PUT",
+    60,
+    {
+        headers: {
+            "Content-Type": "text/plain",
+            "Content-MD5": "xxx",
+            "Content-Length": 1,
+        },
+    },
+    "your object name",
+    ["Content-Length"],
+);
+
 const clusterOptions: OSS.ClusterOptions = {
     clusters: [],
 };

types/ali-oss/index.d.ts

@@ -27,6 +27,8 @@ declare namespace OSS {
         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 }>;
+        /** Use V4 signature. Default is false. */
+        authorizationV4?: boolean | undefined;
     }
 
     /**
@@ -698,11 +700,11 @@ declare namespace OSS {
         signatureUrlV4(
             method: HTTPMethods,
             expires: number,
-            request?: {
+            request: {
                 headers?: object | undefined;
                 queries?: object | undefined;
-            },
-            objectName?: string,
+            } | undefined,
+            objectName: string,
             additionalHeaders?: string[],
         ): Promise<string>;
 
@@ -1083,6 +1085,20 @@ declare class OSS {
      */
     signatureUrl(name: string, options?: OSS.SignatureUrlOptions): string;
 
+    /**
+     * Generate a signed URL for V4 of an OSS resource and share the URL to allow authorized third-party users to access the resource.
+     */
+    signatureUrlV4(
+        method: OSS.HTTPMethods,
+        expires: number,
+        request: {
+            headers?: object | undefined;
+            queries?: object | undefined;
+        } | undefined,
+        objectName: string,
+        additionalHeaders?: string[],
+    ): Promise<string>;
+
     /**
      * Basically the same as signatureUrl, if refreshSTSToken is configured asyncSignatureUrl will refresh stsToken
      */

types/ali-oss/package.json

@@ -1,9 +1,9 @@
 {
     "private": true,
     "name": "@types/ali-oss",
-    "version": "6.16.9999",
+    "version": "6.23.9999",
     "projects": [
-        "https://github.com/aliyun/oss-nodejs-sdk"
+        "https://github.com/ali-sdk/ali-oss"
     ],
     "devDependencies": {
         "@types/ali-oss": "workspace:."
@@ -16,6 +16,10 @@
         {
             "name": "StarHeart",
             "githubUsername": "StarHeartHunt"
+        },
+        {
+            "name": "cnjsstong",
+            "githubUsername": "cnjsstong"
         }
     ]
 }