@aws-sdk/types 3.226.0 → 3.257.0

package/dist-cjs/auth.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpAuthLocation = void 0;
+var HttpAuthLocation;
+(function (HttpAuthLocation) {
+    HttpAuthLocation["HEADER"] = "header";
+    HttpAuthLocation["QUERY"] = "query";
+})(HttpAuthLocation = exports.HttpAuthLocation || (exports.HttpAuthLocation = {}));

package/dist-es/auth.js

@@ -1 +1,5 @@
-export {};
+export var HttpAuthLocation;
+(function (HttpAuthLocation) {
+    HttpAuthLocation["HEADER"] = "header";
+    HttpAuthLocation["QUERY"] = "query";
+})(HttpAuthLocation || (HttpAuthLocation = {}));

package/dist-types/auth.d.ts

@@ -25,3 +25,23 @@ export interface AuthScheme {
     signingScope?: never;
     properties: Record<string, unknown>;
 }
+export interface HttpAuthDefinition {
+    /**
+     * Defines the location of where the Auth is serialized.
+     */
+    in: HttpAuthLocation;
+    /**
+     * Defines the name of the HTTP header or query string parameter
+     * that contains the Auth.
+     */
+    name: string;
+    /**
+     * Defines the security scheme to use on the `Authorization` header value.
+     * This can only be set if the "in" property is set to {@link HttpAuthLocation.HEADER}.
+     */
+    scheme?: string;
+}
+export declare enum HttpAuthLocation {
+    HEADER = "header",
+    QUERY = "query"
+}

package/dist-types/checksum.d.ts

@@ -1,3 +1,4 @@
+import { SourceData } from "./crypto";
 /**
  * An object that provides a checksum of data provided in chunks to `update`.
  * The checksum may be performed incrementally as chunks are received or all
@@ -48,3 +49,11 @@ export interface Checksum {
      */
     update(chunk: Uint8Array): void;
 }
+/**
+ * A constructor for a Checksum that may be used to calculate an HMAC. Implementing
+ * classes should not directly hold the provided key in memory beyond the
+ * lexical scope of the constructor.
+ */
+export interface ChecksumConstructor {
+    new (secret?: SourceData): Checksum;
+}

package/dist-types/crypto.d.ts

@@ -26,6 +26,8 @@ export interface Hash {
  * A constructor for a hash that may be used to calculate an HMAC. Implementing
  * classes should not directly hold the provided key in memory beyond the
  * lexical scope of the constructor.
+ *
+ * @deprecated use {@link ChecksumConstructor}
  */
 export interface HashConstructor {
     new (secret?: SourceData): Hash;

package/dist-types/middleware.d.ts

@@ -1,4 +1,4 @@
-import { AuthScheme } from "./auth";
+import { AuthScheme, HttpAuthDefinition } from "./auth";
 import { EndpointV2 } from "./endpoint";
 import { Logger } from "./logger";
 import { UserAgent } from "./util";
@@ -343,6 +343,11 @@ export interface HandlerExecutionContext {
      * Set at the same time as endpointV2.
      */
     authSchemes?: AuthScheme[];
+    /**
+     * The current auth configuration that has been set by any auth middleware and
+     * that will prevent from being set more than once.
+     */
+    currentAuthConfig?: HttpAuthDefinition;
     /**
      * Used by DynamoDbDocumentClient.
      */

package/dist-types/stream.d.ts

@@ -1,9 +1,10 @@
+import { ChecksumConstructor } from "./checksum";
 import { HashConstructor, StreamHasher } from "./crypto";
 import { BodyLengthCalculator, Encoder } from "./util";
 export interface GetAwsChunkedEncodingStreamOptions {
     base64Encoder?: Encoder;
     bodyLengthChecker: BodyLengthCalculator;
-    checksumAlgorithmFn?: HashConstructor;
+    checksumAlgorithmFn?: ChecksumConstructor | HashConstructor;
     checksumLocationName?: string;
     streamHasher?: StreamHasher;
 }

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

@@ -6,3 +6,12 @@ export interface AuthScheme {
   signingScope?: never;
   properties: Record<string, unknown>;
 }
+export interface HttpAuthDefinition {
+  in: HttpAuthLocation;
+  name: string;
+  scheme?: string;
+}
+export declare enum HttpAuthLocation {
+  HEADER = "header",
+  QUERY = "query",
+}

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

@@ -1,3 +1,4 @@
+import { SourceData } from "./crypto";
 export interface Checksum {
   digestLength?: number;
   copy?(): Checksum;
@@ -6,3 +7,6 @@ export interface Checksum {
   reset(): void;
   update(chunk: Uint8Array): void;
 }
+export interface ChecksumConstructor {
+  new (secret?: SourceData): Checksum;
+}

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

@@ -1,4 +1,4 @@
-import { AuthScheme } from "./auth";
+import { AuthScheme, HttpAuthDefinition } from "./auth";
 import { EndpointV2 } from "./endpoint";
 import { Logger } from "./logger";
 import { UserAgent } from "./util";
@@ -202,6 +202,7 @@ export interface HandlerExecutionContext {
   userAgent?: UserAgent;
   endpointV2?: EndpointV2;
   authSchemes?: AuthScheme[];
+  currentAuthConfig?: HttpAuthDefinition;
   dynamoDbDocumentClientOptions?: Partial<{
     overrideInputFilterSensitiveLog(...args: any[]): string | void;
     overrideOutputFilterSensitiveLog(...args: any[]): string | void;

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

@@ -1,9 +1,10 @@
+import { ChecksumConstructor } from "./checksum";
 import { HashConstructor, StreamHasher } from "./crypto";
 import { BodyLengthCalculator, Encoder } from "./util";
 export interface GetAwsChunkedEncodingStreamOptions {
   base64Encoder?: Encoder;
   bodyLengthChecker: BodyLengthCalculator;
-  checksumAlgorithmFn?: HashConstructor;
+  checksumAlgorithmFn?: ChecksumConstructor | HashConstructor;
   checksumLocationName?: string;
   streamHasher?: StreamHasher;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/types",
-  "version": "3.226.0",
+  "version": "3.257.0",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",