@aws-sdk/signature-v4-multi-region 3.460.0 → 3.465.0

package/dist-cjs/SignatureV4MultiRegion.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignatureV4MultiRegion = void 0;
-const signature_v4_1 = require("@smithy/signature-v4");
+const middleware_sdk_s3_1 = require("@aws-sdk/middleware-sdk-s3");
 const signature_v4_crt_container_1 = require("./signature-v4-crt-container");
 class SignatureV4MultiRegion {
     constructor(options) {
-        this.sigv4Signer = new signature_v4_1.SignatureV4(options);
+        this.sigv4Signer = new middleware_sdk_s3_1.SignatureV4S3Express(options);
         this.signerOptions = options;
     }
     async sign(requestToSign, options = {}) {
@@ -16,6 +16,14 @@ class SignatureV4MultiRegion {
         }
         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);
+        }
+        return this.sigv4Signer.signWithCredentials(requestToSign, credentials, options);
+    }
     async presign(originalRequest, options = {}) {
         if (options.signingRegion === "*") {
             if (this.signerOptions.runtime !== "node")
@@ -24,6 +32,12 @@ class SignatureV4MultiRegion {
         }
         return this.sigv4Signer.presign(originalRequest, options);
     }
+    async presignWithCredentials(originalRequest, credentials, options = {}) {
+        if (options.signingRegion === "*") {
+            throw new Error("Method presignWithCredentials is not supported for [signingRegion=*].");
+        }
+        return this.sigv4Signer.presignWithCredentials(originalRequest, credentials, options);
+    }
     getSigv4aSigner() {
         if (!this.sigv4aSigner) {
             let CrtSignerV4 = null;

package/dist-es/SignatureV4MultiRegion.js

@@ -1,8 +1,8 @@
-import { SignatureV4 } from "@smithy/signature-v4";
+import { SignatureV4S3Express } from "@aws-sdk/middleware-sdk-s3";
 import { signatureV4CrtContainer } from "./signature-v4-crt-container";
 export class SignatureV4MultiRegion {
     constructor(options) {
-        this.sigv4Signer = new SignatureV4(options);
+        this.sigv4Signer = new SignatureV4S3Express(options);
         this.signerOptions = options;
     }
     async sign(requestToSign, options = {}) {
@@ -13,6 +13,14 @@ export class SignatureV4MultiRegion {
         }
         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);
+        }
+        return this.sigv4Signer.signWithCredentials(requestToSign, credentials, options);
+    }
     async presign(originalRequest, options = {}) {
         if (options.signingRegion === "*") {
             if (this.signerOptions.runtime !== "node")
@@ -21,6 +29,12 @@ export class SignatureV4MultiRegion {
         }
         return this.sigv4Signer.presign(originalRequest, options);
     }
+    async presignWithCredentials(originalRequest, credentials, options = {}) {
+        if (options.signingRegion === "*") {
+            throw new Error("Method presignWithCredentials is not supported for [signingRegion=*].");
+        }
+        return this.sigv4Signer.presignWithCredentials(originalRequest, credentials, options);
+    }
     getSigv4aSigner() {
         if (!this.sigv4aSigner) {
             let CrtSignerV4 = null;

package/dist-types/SignatureV4MultiRegion.d.ts

@@ -1,5 +1,5 @@
 import { SignatureV4CryptoInit, SignatureV4Init } from "@smithy/signature-v4";
-import { HttpRequest, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments } from "@smithy/types";
+import { AwsCredentialIdentity, HttpRequest, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments } from "@smithy/types";
 /**
  * @internal
  */
@@ -15,11 +15,16 @@ export type SignatureV4MultiRegionInit = SignatureV4Init & SignatureV4CryptoInit
  * @internal
  */
 export declare class SignatureV4MultiRegion implements RequestPresigner, RequestSigner {
-    private readonly sigv4Signer;
     private sigv4aSigner?;
+    private readonly sigv4Signer;
     private readonly signerOptions;
     constructor(options: SignatureV4MultiRegionInit);
     sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
+    /**
+     * Sign with alternate credentials to the ones provided in the constructor.
+     */
+    signWithCredentials(requestToSign: HttpRequest, credentials: AwsCredentialIdentity, options?: RequestSigningArguments): Promise<HttpRequest>;
     presign(originalRequest: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;
+    presignWithCredentials(originalRequest: HttpRequest, credentials: AwsCredentialIdentity, options?: RequestPresigningArguments): Promise<HttpRequest>;
     private getSigv4aSigner;
 }

package/dist-types/signature-v4-crt-container.d.ts

@@ -1,4 +1,5 @@
-import type { RequestPresigner, RequestSigner } from "@smithy/types";
+import type { AwsCredentialIdentity } from "@aws-sdk/types";
+import type { HttpRequest, RequestPresigner, RequestSigner, RequestSigningArguments } from "@smithy/types";
 /**
  * @public
  */
@@ -9,7 +10,9 @@ export type OptionalCrtSignerV4 = {
      *
      * The true type is CrtSignerV4 from \@aws-sdk/signature-v4-crt.
      */
-    new (options: any): RequestPresigner & RequestSigner;
+    new (options: any): RequestPresigner & RequestSigner & {
+        signWithCredentials(requestToSign: HttpRequest, credentials: AwsCredentialIdentity, options: RequestSigningArguments): Promise<HttpRequest>;
+    };
 };
 /**
  * @public

package/dist-types/ts3.4/SignatureV4MultiRegion.d.ts

@@ -1,5 +1,6 @@
 import { SignatureV4CryptoInit, SignatureV4Init } from "@smithy/signature-v4";
 import {
+  AwsCredentialIdentity,
   HttpRequest,
   RequestPresigner,
   RequestPresigningArguments,
@@ -13,17 +14,27 @@ export type SignatureV4MultiRegionInit = SignatureV4Init &
 export declare class SignatureV4MultiRegion
   implements RequestPresigner, RequestSigner
 {
-  private readonly sigv4Signer;
   private sigv4aSigner?;
+  private readonly sigv4Signer;
   private readonly signerOptions;
   constructor(options: SignatureV4MultiRegionInit);
   sign(
     requestToSign: HttpRequest,
     options?: RequestSigningArguments
   ): Promise<HttpRequest>;
+  signWithCredentials(
+    requestToSign: HttpRequest,
+    credentials: AwsCredentialIdentity,
+    options?: RequestSigningArguments
+  ): Promise<HttpRequest>;
   presign(
     originalRequest: HttpRequest,
     options?: RequestPresigningArguments
   ): Promise<HttpRequest>;
+  presignWithCredentials(
+    originalRequest: HttpRequest,
+    credentials: AwsCredentialIdentity,
+    options?: RequestPresigningArguments
+  ): Promise<HttpRequest>;
   private getSigv4aSigner;
 }

package/dist-types/ts3.4/signature-v4-crt-container.d.ts

@@ -1,6 +1,19 @@
-import { RequestPresigner, RequestSigner } from "@smithy/types";
+import { AwsCredentialIdentity } from "@aws-sdk/types";
+import {
+  HttpRequest,
+  RequestPresigner,
+  RequestSigner,
+  RequestSigningArguments,
+} from "@smithy/types";
 export type OptionalCrtSignerV4 = {
-  new (options: any): RequestPresigner & RequestSigner;
+  new (options: any): RequestPresigner &
+    RequestSigner & {
+      signWithCredentials(
+        requestToSign: HttpRequest,
+        credentials: AwsCredentialIdentity,
+        options: RequestSigningArguments
+      ): Promise<HttpRequest>;
+    };
 };
 export declare const signatureV4CrtContainer: {
   CrtSignerV4: null | OptionalCrtSignerV4;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/signature-v4-multi-region",
-  "version": "3.460.0",
+  "version": "3.465.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,7 +20,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/types": "3.460.0",
+    "@aws-sdk/middleware-sdk-s3": "3.465.0",
+    "@aws-sdk/types": "3.465.0",
     "@smithy/protocol-http": "^3.0.9",
     "@smithy/signature-v4": "^2.0.0",
     "@smithy/types": "^2.5.0",
@@ -31,7 +32,6 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.23.23",
     "typescript": "~4.9.5"
   },
   "engines": {
@@ -52,8 +52,5 @@
     "type": "git",
     "url": "https://github.com/aws/aws-sdk-js-v3.git",
     "directory": "packages/signature-v4-multi-region"
-  },
-  "typedoc": {
-    "entryPoint": "src/index.ts"
   }
 }