@aws-sdk/signature-v4-multi-region 3.775.0 → 3.798.0

package/README.md

@@ -4,6 +4,7 @@
 [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/signature-v4-multi-region.svg)](https://www.npmjs.com/package/@aws-sdk/signature-v4-multi-region)
 
 See also https://github.com/aws/aws-sdk-js-v3/tree/main#functionality-requiring-aws-common-runtime-crt.
+
 ## Usage
 
 This package contains optional dependency [`@aws-sdk/signature-v4-crt`](https://www.npmjs.com/package/@aws-sdk/signature-v4).
@@ -15,12 +16,17 @@ The `@aws-sdk/signature-v4-crt` is only supported in Node.js currently because i
 
 Please refer to [this issue](https://github.com/aws/aws-sdk-js-v3/issues/2822) for more information.
 
+Note: You can also use a native JS (non-CRT) implementation of the SigV4A signer, instructions for which are here:
+https://github.com/aws/aws-sdk-js-v3/tree/main#functionality-requiring-aws-common-runtime-crt
+
+Please refer to the note regarding bundle size in the link above, before deciding to use the JS SigV4A signer (including in browsers).
+
 ## Description
 
 This package provides a SigV4-compatible request signer that wraps a pure-JS SigV4 signer
 ([`@aws-sdk/signature-v4`](https://www.npmjs.com/package/@aws-sdk/signature-v4)) for regional requests, and attempts to
 call a native implementation of SigV4a signer([`@aws-sdk/signature-v4-crt`](https://www.npmjs.com/package/@aws-sdk/signature-v4))
-it the request is not regional.
+it the request is multi-region.
 
-An un-regional request is identified by the `signingRegion` parameter. A region is un-regional if the `signingRegion`
+A multi-region request is identified by the `signingRegion` parameter. A request is multi-region if the `signingRegion`
 parameter is set to `*`.

package/dist-cjs/index.js

@@ -28,6 +28,7 @@ module.exports = __toCommonJS(index_exports);
 
 // src/SignatureV4MultiRegion.ts
 var import_middleware_sdk_s3 = require("@aws-sdk/middleware-sdk-s3");
+var import_signature_v4 = require("@smithy/signature-v4");
 
 // src/signature-v4-crt-container.ts
 var signatureV4CrtContainer = {
@@ -48,28 +49,43 @@ var SignatureV4MultiRegion = class {
   }
   async sign(requestToSign, options = {}) {
     if (options.signingRegion === "*") {
-      if (this.signerOptions.runtime !== "node")
-        throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
       return this.getSigv4aSigner().sign(requestToSign, options);
     }
     return this.sigv4Signer.sign(requestToSign, options);
   }
   /**
    * Sign with alternate credentials to the ones provided in the constructor.
+   * Note: This is only supported for SigV4a when using the CRT implementation.
    */
   async signWithCredentials(requestToSign, credentials, options = {}) {
     if (options.signingRegion === "*") {
-      if (this.signerOptions.runtime !== "node")
-        throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
-      return this.getSigv4aSigner().signWithCredentials(requestToSign, credentials, options);
+      const signer = this.getSigv4aSigner();
+      const CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
+      if (CrtSignerV4 && signer instanceof CrtSignerV4) {
+        return signer.signWithCredentials(requestToSign, credentials, options);
+      } else {
+        throw new Error(
+          `signWithCredentials with signingRegion '*' is only supported when using the CRT dependency @aws-sdk/signature-v4-crt. Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt`
+        );
+      }
     }
     return this.sigv4Signer.signWithCredentials(requestToSign, credentials, options);
   }
+  /**
+   * Presign a request.
+   * Note: This is only supported for SigV4a when using the CRT implementation.
+   */
   async presign(originalRequest, options = {}) {
     if (options.signingRegion === "*") {
-      if (this.signerOptions.runtime !== "node")
-        throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
-      return this.getSigv4aSigner().presign(originalRequest, options);
+      const signer = this.getSigv4aSigner();
+      const CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
+      if (CrtSignerV4 && signer instanceof CrtSignerV4) {
+        return signer.presign(originalRequest, options);
+      } else {
+        throw new Error(
+          `presign with signingRegion '*' is only supported when using the CRT dependency @aws-sdk/signature-v4-crt. Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt`
+        );
+      }
     }
     return this.sigv4Signer.presign(originalRequest, options);
   }
@@ -81,21 +97,38 @@ var SignatureV4MultiRegion = class {
   }
   getSigv4aSigner() {
     if (!this.sigv4aSigner) {
-      let CrtSignerV4 = null;
-      try {
-        CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
-        if (typeof CrtSignerV4 !== "function") throw new Error();
-      } catch (e) {
-        e.message = `${e.message}
-Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. 
-You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. 
-For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt`;
-        throw e;
+      const CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
+      const JsSigV4aSigner = import_signature_v4.signatureV4aContainer.SignatureV4a;
+      if (this.signerOptions.runtime === "node") {
+        if (!CrtSignerV4 && !JsSigV4aSigner) {
+          throw new Error(
+            "Neither CRT nor JS SigV4a implementation is available. Please load either @aws-sdk/signature-v4-crt or @aws-sdk/signature-v4a. For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt"
+          );
+        }
+        if (CrtSignerV4 && typeof CrtSignerV4 === "function") {
+          this.sigv4aSigner = new CrtSignerV4({
+            ...this.signerOptions,
+            signingAlgorithm: 1
+          });
+        } else if (JsSigV4aSigner && typeof JsSigV4aSigner === "function") {
+          this.sigv4aSigner = new JsSigV4aSigner({
+            ...this.signerOptions
+          });
+        } else {
+          throw new Error(
+            "Available SigV4a implementation is not a valid constructor. Please ensure you've properly imported @aws-sdk/signature-v4-crt or @aws-sdk/signature-v4a.For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt"
+          );
+        }
+      } else {
+        if (!JsSigV4aSigner || typeof JsSigV4aSigner !== "function") {
+          throw new Error(
+            "JS SigV4a implementation is not available or not a valid constructor. Please check whether you have installed the @aws-sdk/signature-v4a package explicitly. The CRT implementation is not available for browsers. You must also register the package by calling [require('@aws-sdk/signature-v4a');] or an ESM equivalent such as [import '@aws-sdk/signature-v4a';]. For more information please go to https://github.com/aws/aws-sdk-js-v3#using-javascript-non-crt-implementation-of-sigv4a"
+          );
+        }
+        this.sigv4aSigner = new JsSigV4aSigner({
+          ...this.signerOptions
+        });
       }
-      this.sigv4aSigner = new CrtSignerV4({
-        ...this.signerOptions,
-        signingAlgorithm: 1
-      });
     }
     return this.sigv4aSigner;
   }

package/dist-es/SignatureV4MultiRegion.js

@@ -1,4 +1,5 @@
 import { SignatureV4S3Express } from "@aws-sdk/middleware-sdk-s3";
+import { signatureV4aContainer, } from "@smithy/signature-v4";
 import { signatureV4CrtContainer } from "./signature-v4-crt-container";
 export class SignatureV4MultiRegion {
     sigv4aSigner;
@@ -10,25 +11,41 @@ export class SignatureV4MultiRegion {
     }
     async sign(requestToSign, options = {}) {
         if (options.signingRegion === "*") {
-            if (this.signerOptions.runtime !== "node")
-                throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
             return this.getSigv4aSigner().sign(requestToSign, options);
         }
         return this.sigv4Signer.sign(requestToSign, options);
     }
     async signWithCredentials(requestToSign, credentials, options = {}) {
         if (options.signingRegion === "*") {
-            if (this.signerOptions.runtime !== "node")
-                throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
-            return this.getSigv4aSigner().signWithCredentials(requestToSign, credentials, options);
+            const signer = this.getSigv4aSigner();
+            const CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
+            if (CrtSignerV4 && signer instanceof CrtSignerV4) {
+                return signer.signWithCredentials(requestToSign, credentials, options);
+            }
+            else {
+                throw new Error(`signWithCredentials with signingRegion '*' is only supported when using the CRT dependency @aws-sdk/signature-v4-crt. ` +
+                    `Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. ` +
+                    `You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] ` +
+                    `or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. ` +
+                    `For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt`);
+            }
         }
         return this.sigv4Signer.signWithCredentials(requestToSign, credentials, options);
     }
     async presign(originalRequest, options = {}) {
         if (options.signingRegion === "*") {
-            if (this.signerOptions.runtime !== "node")
-                throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
-            return this.getSigv4aSigner().presign(originalRequest, options);
+            const signer = this.getSigv4aSigner();
+            const CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
+            if (CrtSignerV4 && signer instanceof CrtSignerV4) {
+                return signer.presign(originalRequest, options);
+            }
+            else {
+                throw new Error(`presign with signingRegion '*' is only supported when using the CRT dependency @aws-sdk/signature-v4-crt. ` +
+                    `Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. ` +
+                    `You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] ` +
+                    `or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. ` +
+                    `For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt`);
+            }
         }
         return this.sigv4Signer.presign(originalRequest, options);
     }
@@ -40,26 +57,46 @@ export class SignatureV4MultiRegion {
     }
     getSigv4aSigner() {
         if (!this.sigv4aSigner) {
-            let CrtSignerV4 = null;
-            try {
-                CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
-                if (typeof CrtSignerV4 !== "function")
-                    throw new Error();
+            const CrtSignerV4 = signatureV4CrtContainer.CrtSignerV4;
+            const JsSigV4aSigner = signatureV4aContainer.SignatureV4a;
+            if (this.signerOptions.runtime === "node") {
+                if (!CrtSignerV4 && !JsSigV4aSigner) {
+                    throw new Error("Neither CRT nor JS SigV4a implementation is available. " +
+                        "Please load either @aws-sdk/signature-v4-crt or @aws-sdk/signature-v4a. " +
+                        "For more information please go to " +
+                        "https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt");
+                }
+                if (CrtSignerV4 && typeof CrtSignerV4 === "function") {
+                    this.sigv4aSigner = new CrtSignerV4({
+                        ...this.signerOptions,
+                        signingAlgorithm: 1,
+                    });
+                }
+                else if (JsSigV4aSigner && typeof JsSigV4aSigner === "function") {
+                    this.sigv4aSigner = new JsSigV4aSigner({
+                        ...this.signerOptions,
+                    });
+                }
+                else {
+                    throw new Error("Available SigV4a implementation is not a valid constructor. " +
+                        "Please ensure you've properly imported @aws-sdk/signature-v4-crt or @aws-sdk/signature-v4a." +
+                        "For more information please go to " +
+                        "https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt");
+                }
             }
-            catch (e) {
-                e.message =
-                    `${e.message}\n` +
-                        `Please check whether you have installed the "@aws-sdk/signature-v4-crt" package explicitly. \n` +
-                        `You must also register the package by calling [require("@aws-sdk/signature-v4-crt");] ` +
-                        `or an ESM equivalent such as [import "@aws-sdk/signature-v4-crt";]. \n` +
+            else {
+                if (!JsSigV4aSigner || typeof JsSigV4aSigner !== "function") {
+                    throw new Error("JS SigV4a implementation is not available or not a valid constructor. " +
+                        "Please check whether you have installed the @aws-sdk/signature-v4a package explicitly. The CRT implementation is not available for browsers. " +
+                        "You must also register the package by calling [require('@aws-sdk/signature-v4a');] " +
+                        "or an ESM equivalent such as [import '@aws-sdk/signature-v4a';]. " +
                         "For more information please go to " +
-                        "https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt";
-                throw e;
+                        "https://github.com/aws/aws-sdk-js-v3#using-javascript-non-crt-implementation-of-sigv4a");
+                }
+                this.sigv4aSigner = new JsSigV4aSigner({
+                    ...this.signerOptions,
+                });
             }
-            this.sigv4aSigner = new CrtSignerV4({
-                ...this.signerOptions,
-                signingAlgorithm: 1,
-            });
         }
         return this.sigv4aSigner;
     }

package/dist-types/SignatureV4MultiRegion.d.ts

@@ -11,7 +11,6 @@ export type SignatureV4MultiRegionInit = SignatureV4Init & SignatureV4CryptoInit
  * dynamically, the signer wraps native module SigV4a signer and JS SigV4 signer. It signs the request with SigV4a
  * algorithm if the request needs to be signed with `*` region. Otherwise, it signs the request with normal SigV4
  * signer.
- * Note that SigV4a signer is only supported in Node.js now because it depends on a native dependency.
  * @internal
  */
 export declare class SignatureV4MultiRegion implements RequestPresigner, RequestSigner {
@@ -22,8 +21,13 @@ export declare class SignatureV4MultiRegion implements RequestPresigner, Request
     sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
     /**
      * Sign with alternate credentials to the ones provided in the constructor.
+     * Note: This is only supported for SigV4a when using the CRT implementation.
      */
     signWithCredentials(requestToSign: HttpRequest, credentials: AwsCredentialIdentity, options?: RequestSigningArguments): Promise<HttpRequest>;
+    /**
+     * Presign a request.
+     * Note: This is only supported for SigV4a when using the CRT implementation.
+     */
     presign(originalRequest: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;
     presignWithCredentials(originalRequest: HttpRequest, credentials: AwsCredentialIdentity, options?: RequestPresigningArguments): Promise<HttpRequest>;
     private getSigv4aSigner;

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@aws-sdk/signature-v4-multi-region",
-  "version": "3.775.0",
+  "version": "3.798.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline signature-v4-multi-region",
     "build:es": "tsc -p tsconfig.es.json",
+    "build:browser": "node ./test-browser/browser-build/esbuild",
     "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "test": "yarn g:vitest run",
+    "test:e2e": "yarn g:vitest run -c vitest.config.e2e.ts",
+    "test:browser": "yarn build:browser && yarn g:vitest run -c vitest.config.browser.ts",
     "test:watch": "yarn g:vitest watch"
   },
   "main": "./dist-cjs/index.js",
@@ -21,10 +24,10 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/middleware-sdk-s3": "3.775.0",
+    "@aws-sdk/middleware-sdk-s3": "3.798.0",
     "@aws-sdk/types": "3.775.0",
     "@smithy/protocol-http": "^5.1.0",
-    "@smithy/signature-v4": "^5.0.2",
+    "@smithy/signature-v4": "^5.1.0",
     "@smithy/types": "^4.2.0",
     "tslib": "^2.6.2"
   },