@aws-sdk/types 3.170.0 → 3.178.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.178.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.177.0...v3.178.0) (2022-09-23)
+
+
+### Features
+
+* **endpoint:** endpoints 2.0 existing package changes ([#3947](https://github.com/aws/aws-sdk-js-v3/issues/3947)) ([df99fc3](https://github.com/aws/aws-sdk-js-v3/commit/df99fc33a43982e1c59000721a535f6fe77a3c23))
+
+
+
+
+
+# [3.171.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.170.0...v3.171.0) (2022-09-14)
+
+
+### Features
+
+* **endpoint:** util-endpoints and middleware-endpoint for endpoints 2.0 ([#3932](https://github.com/aws/aws-sdk-js-v3/issues/3932)) ([e81b7d0](https://github.com/aws/aws-sdk-js-v3/commit/e81b7d0920a74843a2a34857f41b0d6d93abc465))
+
+
+
+
+
 # [3.170.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.169.0...v3.170.0) (2022-09-13)
 
 **Note:** Version bump only for package @aws-sdk/types

package/dist-cjs/auth.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./abort"), exports);
+tslib_1.__exportStar(require("./auth"), exports);
 tslib_1.__exportStar(require("./client"), exports);
 tslib_1.__exportStar(require("./command"), exports);
 tslib_1.__exportStar(require("./credentials"), exports);

package/dist-es/auth.js

@@ -0,0 +1 @@
+export {};

package/dist-es/index.js

@@ -1,4 +1,5 @@
 export * from "./abort";
+export * from "./auth";
 export * from "./client";
 export * from "./command";
 export * from "./credentials";

package/dist-types/auth.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Authentication schemes represent a way that the service will authenticate the customer’s identity.
+ */
+export interface AuthScheme {
+    /**
+     * @example "v4" for SigV4
+     */
+    name: string;
+    /**
+     * @example "s3"
+     */
+    signingName: string;
+    /**
+     * @example "us-east-1"
+     */
+    signingScope: string;
+    properties: Record<string, unknown>;
+}

package/dist-types/credentials.d.ts

@@ -1,8 +1,14 @@
 import { Provider } from "./util";
+export interface AwsCredentialIdentity {
+    /**
+     * A {Date} when the identity or credential will no longer be accepted.
+     */
+    readonly expiration?: Date;
+}
 /**
  * An object representing temporary or permanent AWS credentials.
  */
-export interface Credentials {
+export interface Credentials extends AwsCredentialIdentity {
     /**
      * AWS access key ID
      */
@@ -16,9 +22,5 @@ export interface Credentials {
      * present for temporary credentials.
      */
     readonly sessionToken?: string;
-    /**
-     * A {Date} when these credentials will no longer be accepted.
-     */
-    readonly expiration?: Date;
 }
 export declare type CredentialProvider = Provider<Credentials>;

package/dist-types/endpoint.d.ts

@@ -1,3 +1,4 @@
+import { AuthScheme } from "./auth";
 export interface EndpointPartition {
     name: string;
     dnsSuffix: string;
@@ -45,6 +46,11 @@ export declare type EndpointObjectProperty = string | boolean | {
 } | EndpointObjectProperty[];
 export interface EndpointV2 {
     url: URL;
-    properties?: Record<string, EndpointObjectProperty>;
+    properties?: {
+        authSchemes?: AuthScheme[];
+    } & Record<string, EndpointObjectProperty>;
     headers?: Record<string, string[]>;
 }
+export declare type EndpointParameters = {
+    [name: string]: undefined | string | boolean;
+};

package/dist-types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./abort";
+export * from "./auth";
 export * from "./client";
 export * from "./command";
 export * from "./credentials";

package/dist-types/middleware.d.ts

@@ -1,3 +1,4 @@
+import { EndpointV2 } from "./endpoint";
 import { Logger } from "./logger";
 import { UserAgent } from "./util";
 export interface InitializeHandlerArguments<Input extends object> {
@@ -298,6 +299,12 @@ export interface MiddlewareStack<Input extends object, Output extends object> ex
      * bindings and handler priorities and tags are preserved in the copy.
      */
     concat<InputType extends Input, OutputType extends Output>(from: MiddlewareStack<InputType, OutputType>): MiddlewareStack<InputType, OutputType>;
+    /**
+     * Returns a list of the current order of middleware in the stack.
+     * This does not execute the middleware functions, nor does it
+     * provide a reference to the stack itself.
+     */
+    identify(): string[];
     /**
      * Builds a single handler function from zero or more middleware classes and
      * a core handler. The core handler is meant to send command objects to AWS
@@ -326,6 +333,11 @@ export interface HandlerExecutionContext {
      * config in clients.
      */
     userAgent?: UserAgent;
+    /**
+     * Resolved by the endpointMiddleware function of @aws-sdk/middleware-endpoint
+     * in the serialization stage.
+     */
+    endpointV2?: EndpointV2;
     [key: string]: any;
 }
 export interface Pluggable<Input extends object, Output extends object> {

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

@@ -1,15 +1,11 @@
 export interface AbortHandler {
   (this: AbortSignal, ev: any): any;
 }
-
 export interface AbortSignal {
   readonly aborted: boolean;
-
   onabort: AbortHandler | null;
 }
-
 export interface AbortController {
   readonly signal: AbortSignal;
-
   abort(): void;
 }

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

@@ -0,0 +1,6 @@
+export interface AuthScheme {
+  name: string;
+  signingName: string;
+  signingScope: string;
+  properties: Record<string, unknown>;
+}

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

@@ -1,7 +1,6 @@
 import { Command } from "./command";
 import { MiddlewareStack } from "./middleware";
 import { MetadataBearer } from "./response";
-
 interface InvokeFunction<
   InputTypes extends object,
   OutputTypes extends MetadataBearer,
@@ -40,7 +39,6 @@ interface InvokeFunction<
     cb?: (err: any, data?: OutputType) => void
   ): Promise<OutputType> | void;
 }
-
 export interface Client<
   Input extends object,
   Output extends MetadataBearer,

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

@@ -1,12 +1,10 @@
 import { Provider } from "./util";
-
-export interface Credentials {
+export interface AwsCredentialIdentity {
+  readonly expiration?: Date;
+}
+export interface Credentials extends AwsCredentialIdentity {
   readonly accessKeyId: string;
-
   readonly secretAccessKey: string;
-
   readonly sessionToken?: string;
-
-  readonly expiration?: Date;
 }
 export declare type CredentialProvider = Provider<Credentials>;

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

@@ -1,19 +1,14 @@
 export declare type SourceData = string | ArrayBuffer | ArrayBufferView;
-
 export interface Hash {
   update(toHash: SourceData, encoding?: "utf8" | "ascii" | "latin1"): void;
-
   digest(): Promise<Uint8Array>;
 }
-
 export interface HashConstructor {
   new (secret?: SourceData): Hash;
 }
-
 export interface StreamHasher<StreamType = any> {
   (hashCtor: HashConstructor, stream: StreamType): Promise<Uint8Array>;
 }
-
 export interface randomValues {
   (byteLength: number): Promise<Uint8Array>;
 }

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

@@ -1,3 +1,4 @@
+import { AuthScheme } from "./auth";
 export interface EndpointPartition {
   name: string;
   dnsSuffix: string;
@@ -18,13 +19,9 @@ export declare enum EndpointURLScheme {
 }
 export interface EndpointURL {
   scheme: EndpointURLScheme;
-
   authority: string;
-
   path: string;
-
   normalizedPath: string;
-
   isIp: boolean;
 }
 export declare type EndpointObjectProperty =
@@ -36,6 +33,11 @@ export declare type EndpointObjectProperty =
   | EndpointObjectProperty[];
 export interface EndpointV2 {
   url: URL;
-  properties?: Record<string, EndpointObjectProperty>;
+  properties?: {
+    authSchemes?: AuthScheme[];
+  } & Record<string, EndpointObjectProperty>;
   headers?: Record<string, string[]>;
 }
+export declare type EndpointParameters = {
+  [name: string]: undefined | string | boolean;
+};

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

@@ -6,7 +6,6 @@ import {
   HandlerExecutionContext,
 } from "./middleware";
 import { MetadataBearer } from "./response";
-
 export interface Message {
   headers: MessageHeaders;
   body: Uint8Array;
@@ -63,22 +62,18 @@ export interface Int64 {
   valueOf: () => number;
   toString: () => string;
 }
-
 export interface EventStreamSerdeContext {
   eventStreamMarshaller: EventStreamMarshaller;
 }
-
 export interface EventStreamMarshallerDeserFn<StreamType> {
   <T>(
     body: StreamType,
     deserializer: (input: Record<string, Message>) => Promise<T>
   ): AsyncIterable<T>;
 }
-
 export interface EventStreamMarshallerSerFn<StreamType> {
   <T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
 }
-
 export interface EventStreamMarshaller<StreamType = any> {
   deserialize: EventStreamMarshallerDeserFn<StreamType>;
   serialize: EventStreamMarshallerSerFn<StreamType>;

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

@@ -1,18 +1,13 @@
 import { AbortSignal } from "./abort";
-
 export interface Headers extends Map<string, string> {
   withHeader(headerName: string, headerValue: string): Headers;
-
   withoutHeader(headerName: string): Headers;
 }
-
 export declare type HeaderBag = Record<string, string>;
-
 export interface HttpMessage {
   headers: HeaderBag;
   body?: any;
 }
-
 export declare type QueryParameterBag = Record<
   string,
   string | Array<string> | null
@@ -24,19 +19,15 @@ export interface Endpoint {
   path: string;
   query?: QueryParameterBag;
 }
-
 export interface HttpRequest extends HttpMessage, Endpoint {
   method: string;
 }
-
 export interface HttpResponse extends HttpMessage {
   statusCode: number;
 }
-
 export interface ResolvedHttpResponse extends HttpResponse {
   body: string;
 }
-
 export interface HttpHandlerOptions {
   abortSignal?: AbortSignal;
 }

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

@@ -1,4 +1,5 @@
 export * from "./abort";
+export * from "./auth";
 export * from "./client";
 export * from "./command";
 export * from "./credentials";

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

@@ -5,12 +5,10 @@ export declare type LogLevel =
   | "warn"
   | "error"
   | "off";
-
 export interface LoggerOptions {
   logger?: Logger;
   logLevel?: LogLevel;
 }
-
 export interface Logger {
   debug(...content: any[]): void;
   info(...content: any[]): void;

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

@@ -1,3 +1,4 @@
+import { EndpointV2 } from "./endpoint";
 import { Logger } from "./logger";
 import { UserAgent } from "./util";
 export interface InitializeHandlerArguments<Input extends object> {
@@ -62,7 +63,6 @@ export interface DeserializeHandler<
     DeserializeHandlerOutput<Output>
   >;
 }
-
 export interface InitializeMiddleware<
   Input extends object,
   Output extends object
@@ -72,7 +72,6 @@ export interface InitializeMiddleware<
     context: HandlerExecutionContext
   ): InitializeHandler<Input, Output>;
 }
-
 export interface SerializeMiddleware<
   Input extends object,
   Output extends object
@@ -82,7 +81,6 @@ export interface SerializeMiddleware<
     context: HandlerExecutionContext
   ): SerializeHandler<Input, Output>;
 }
-
 export interface FinalizeRequestMiddleware<
   Input extends object,
   Output extends object
@@ -116,7 +114,6 @@ export declare type MiddlewareType<
   | BuildMiddleware<Input, Output>
   | FinalizeRequestMiddleware<Input, Output>
   | DeserializeMiddleware<Input, Output>;
-
 export interface Terminalware {
   <Input extends object, Output extends object>(
     context: HandlerExecutionContext
@@ -131,11 +128,8 @@ export declare type Step =
 export declare type Priority = "high" | "normal" | "low";
 export interface HandlerOptions {
   step?: Step;
-
   tags?: Array<string>;
-
   name?: string;
-
   override?: boolean;
 }
 export interface AbsoluteLocation {
@@ -144,7 +138,6 @@ export interface AbsoluteLocation {
 export declare type Relation = "before" | "after";
 export interface RelativeLocation {
   relation: Relation;
-
   toMiddleware: string;
 }
 export declare type RelativeMiddlewareOptions = RelativeLocation &
@@ -164,61 +157,49 @@ export interface FinalizeRequestHandlerOptions extends HandlerOptions {
 export interface DeserializeHandlerOptions extends HandlerOptions {
   step: "deserialize";
 }
-
 export interface MiddlewareStack<Input extends object, Output extends object>
   extends Pluggable<Input, Output> {
   add(
     middleware: InitializeMiddleware<Input, Output>,
     options?: InitializeHandlerOptions & AbsoluteLocation
   ): void;
-
   add(
     middleware: SerializeMiddleware<Input, Output>,
     options: SerializeHandlerOptions & AbsoluteLocation
   ): void;
-
   add(
     middleware: BuildMiddleware<Input, Output>,
     options: BuildHandlerOptions & AbsoluteLocation
   ): void;
-
   add(
     middleware: FinalizeRequestMiddleware<Input, Output>,
     options: FinalizeRequestHandlerOptions & AbsoluteLocation
   ): void;
-
   add(
     middleware: DeserializeMiddleware<Input, Output>,
     options: DeserializeHandlerOptions & AbsoluteLocation
   ): void;
-
   addRelativeTo(
     middleware: MiddlewareType<Input, Output>,
     options: RelativeMiddlewareOptions
   ): void;
-
   use(pluggable: Pluggable<Input, Output>): void;
-
   clone(): MiddlewareStack<Input, Output>;
-
   remove(toRemove: MiddlewareType<Input, Output> | string): boolean;
-
   removeByTag(toRemove: string): boolean;
-
   concat<InputType extends Input, OutputType extends Output>(
     from: MiddlewareStack<InputType, OutputType>
   ): MiddlewareStack<InputType, OutputType>;
-
+  identify(): string[];
   resolve<InputType extends Input, OutputType extends Output>(
     handler: DeserializeHandler<InputType, OutputType>,
     context: HandlerExecutionContext
   ): InitializeHandler<InputType, OutputType>;
 }
-
 export interface HandlerExecutionContext {
   logger?: Logger;
-
   userAgent?: UserAgent;
+  endpointV2?: EndpointV2;
   [key: string]: any;
 }
 export interface Pluggable<Input extends object, Output extends object> {

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

@@ -1,11 +1,8 @@
 import { Client } from "./client";
-
 export declare type Paginator<T> = AsyncGenerator<T, T, unknown>;
-
 export interface PaginationConfiguration {
   client: Client<any, any, any>;
   pageSize?: number;
   startingToken?: any;
-
   stopOnSameToken?: boolean;
 }

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

@@ -1,5 +1,4 @@
 export declare type IniSection = Record<string, string | undefined>;
-
 export interface Profile extends IniSection {}
 export declare type ParsedIniData = Record<string, IniSection>;
 export interface SharedConfigFiles {

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

@@ -1,14 +1,9 @@
 export interface ResponseMetadata {
   httpStatusCode?: number;
-
   requestId?: string;
-
   extendedRequestId?: string;
-
   cfId?: string;
-
   attempts?: number;
-
   totalRetryDelay?: number;
 }
 export interface MetadataBearer {

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

@@ -1,14 +1,12 @@
 import { Endpoint } from "./http";
 import { RequestHandler } from "./transfer";
 import { Decoder, Encoder, Provider } from "./util";
-
 export interface EndpointBearer {
   endpoint: Provider<Endpoint>;
 }
 export interface StreamCollector {
   (stream: any): Promise<Uint8Array>;
 }
-
 export interface SerdeContext extends EndpointBearer {
   base64Encoder: Encoder;
   base64Decoder: Decoder;
@@ -31,15 +29,12 @@ export interface ResponseDeserializer<
 > {
   (output: ResponseType, context: Context): Promise<OutputType>;
 }
-
 declare global {
   export interface ReadableStream {}
 }
-
 export interface SdkStreamMixin {
   transformToByteArray: () => Promise<Uint8Array>;
   transformToString: (encoding?: string) => Promise<string>;
   transformToWebStream: () => ReadableStream;
 }
-
 export declare type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;

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

@@ -1,6 +1,5 @@
 import { HttpResponse } from "./http";
 import { MetadataBearer } from "./response";
-
 export declare type DocumentType =
   | null
   | boolean
@@ -10,23 +9,16 @@ export declare type DocumentType =
   | {
       [prop: string]: DocumentType;
     };
-
 export interface RetryableTrait {
   readonly throttling?: boolean;
 }
-
 export interface SmithyException {
   readonly name: string;
-
   readonly $fault: "client" | "server";
-
   readonly $service?: string;
-
   readonly $retryable?: RetryableTrait;
-
   readonly $response?: HttpResponse;
 }
-
 export declare type SdkError = Error &
   Partial<SmithyException> &
   Partial<MetadataBearer>;

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

@@ -1,21 +1,16 @@
 import { HttpRequest } from "./http";
-
 export declare type DateInput = number | string | Date;
 export interface SigningArguments {
   signingDate?: DateInput;
-
   signingService?: string;
-
   signingRegion?: string;
 }
 export interface RequestSigningArguments extends SigningArguments {
   unsignableHeaders?: Set<string>;
-
   signableHeaders?: Set<string>;
 }
 export interface RequestPresigningArguments extends RequestSigningArguments {
   expiresIn?: number;
-
   unhoistableHeaders?: Set<string>;
 }
 export interface EventSigningArguments extends SigningArguments {
@@ -27,7 +22,6 @@ export interface RequestPresigner {
     options?: RequestPresigningArguments
   ): Promise<HttpRequest>;
 }
-
 export interface RequestSigner {
   sign(
     requestToSign: HttpRequest,

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

@@ -7,7 +7,6 @@ export interface GetAwsChunkedEncodingStreamOptions {
   checksumLocationName?: string;
   streamHasher?: StreamHasher;
 }
-
 export interface GetAwsChunkedEncodingStream<StreamType = any> {
   (
     readableStream: StreamType,

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

@@ -1,8 +1,6 @@
 import { Provider } from "./util";
-
 export interface Token {
   readonly token: string;
-
   readonly expiration?: Date;
 }
 export declare type TokenProvider = Provider<Token>;

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

@@ -5,40 +5,31 @@ import {
   FinalizeHandlerOutput,
 } from "./middleware";
 import { MetadataBearer } from "./response";
-
 export interface Encoder {
   (input: Uint8Array): string;
 }
-
 export interface Decoder {
   (input: string): Uint8Array;
 }
-
 export interface Provider<T> {
   (): Promise<T>;
 }
-
 export interface MemoizedProvider<T> {
   (options?: { forceRefresh?: boolean }): Promise<T>;
 }
-
 export interface BodyLengthCalculator {
   (body: any): number | undefined;
 }
-
 export interface RetryStrategy {
   mode?: string;
-
   retry: <Input extends object, Output extends MetadataBearer>(
     next: FinalizeHandler<Input, Output>,
     args: FinalizeHandlerArguments<Input>
   ) => Promise<FinalizeHandlerOutput<Output>>;
 }
-
 export interface UrlParser {
-  (url: string): Endpoint;
+  (url: string | URL): Endpoint;
 }
-
 export interface RegionInfo {
   hostname: string;
   partition: string;
@@ -46,19 +37,14 @@ export interface RegionInfo {
   signingService?: string;
   signingRegion?: string;
 }
-
 export interface RegionInfoProviderOptions {
   useDualstackEndpoint: boolean;
-
   useFipsEndpoint: boolean;
 }
-
 export interface RegionInfoProvider {
   (region: string, options?: RegionInfoProviderOptions): Promise<
     RegionInfo | undefined
   >;
 }
-
 export declare type UserAgentPair = [string, string];
-
 export declare type UserAgent = UserAgentPair[];

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

@@ -1,14 +1,9 @@
 import { AbortController } from "./abort";
 export interface WaiterConfiguration<Client> {
   client: Client;
-
   maxWaitTime: number;
-
   abortController?: AbortController;
-
   abortSignal?: AbortController["signal"];
-
   minDelay?: number;
-
   maxDelay?: number;
 }

package/dist-types/util.d.ts

@@ -82,7 +82,7 @@ export interface RetryStrategy {
  * Parses a URL in string form into an Endpoint object.
  */
 export interface UrlParser {
-    (url: string): Endpoint;
+    (url: string | URL): Endpoint;
 }
 /**
  * Object containing regionalization information of

package/package.json

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