@aws-sdk/types 3.347.0 → 3.369.0

package/dist-cjs/auth.js

@@ -1,8 +1,5 @@
 "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 = {}));
+var types_1 = require("@smithy/types");
+Object.defineProperty(exports, "HttpAuthLocation", { enumerable: true, get: function () { return types_1.HttpAuthLocation; } });

package/dist-cjs/connection.js

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

package/dist-cjs/endpoint.js

@@ -1,8 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EndpointURLScheme = void 0;
-var EndpointURLScheme;
-(function (EndpointURLScheme) {
-    EndpointURLScheme["HTTP"] = "http";
-    EndpointURLScheme["HTTPS"] = "https";
-})(EndpointURLScheme = exports.EndpointURLScheme || (exports.EndpointURLScheme = {}));
+var types_1 = require("@smithy/types");
+Object.defineProperty(exports, "EndpointURLScheme", { enumerable: true, get: function () { return types_1.EndpointURLScheme; } });

package/dist-cjs/index.js

@@ -3,6 +3,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("./blob/blob-types"), exports);
 tslib_1.__exportStar(require("./checksum"), exports);
 tslib_1.__exportStar(require("./client"), exports);
 tslib_1.__exportStar(require("./command"), exports);

package/dist-cjs/transfer.js

@@ -1,9 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestHandlerProtocol = void 0;
-var RequestHandlerProtocol;
-(function (RequestHandlerProtocol) {
-    RequestHandlerProtocol["HTTP_0_9"] = "http/0.9";
-    RequestHandlerProtocol["HTTP_1_0"] = "http/1.0";
-    RequestHandlerProtocol["TDS_8_0"] = "tds/8.0";
-})(RequestHandlerProtocol = exports.RequestHandlerProtocol || (exports.RequestHandlerProtocol = {}));
+var types_1 = require("@smithy/types");
+Object.defineProperty(exports, "RequestHandlerProtocol", { enumerable: true, get: function () { return types_1.RequestHandlerProtocol; } });

package/dist-es/auth.js

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

package/dist-es/connection.js

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

package/dist-es/endpoint.js

@@ -1,5 +1 @@
-export var EndpointURLScheme;
-(function (EndpointURLScheme) {
-    EndpointURLScheme["HTTP"] = "http";
-    EndpointURLScheme["HTTPS"] = "https";
-})(EndpointURLScheme || (EndpointURLScheme = {}));
+export { EndpointURLScheme, } from "@smithy/types";

package/dist-es/index.js

@@ -1,5 +1,6 @@
 export * from "./abort";
 export * from "./auth";
+export * from "./blob/blob-types";
 export * from "./checksum";
 export * from "./client";
 export * from "./command";

package/dist-es/transfer.js

@@ -1,6 +1 @@
-export var RequestHandlerProtocol;
-(function (RequestHandlerProtocol) {
-    RequestHandlerProtocol["HTTP_0_9"] = "http/0.9";
-    RequestHandlerProtocol["HTTP_1_0"] = "http/1.0";
-    RequestHandlerProtocol["TDS_8_0"] = "tds/8.0";
-})(RequestHandlerProtocol || (RequestHandlerProtocol = {}));
+export { RequestHandlerProtocol, } from "@smithy/types";

package/dist-types/abort.d.ts

@@ -1,49 +1 @@
-/**
- * @public
- */
-export interface AbortHandler {
-    (this: AbortSignal, ev: any): any;
-}
-/**
- * @public
- *
- * Holders of an AbortSignal object may query if the associated operation has
- * been aborted and register an onabort handler.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
- */
-export interface AbortSignal {
-    /**
-     * Whether the action represented by this signal has been cancelled.
-     */
-    readonly aborted: boolean;
-    /**
-     * A function to be invoked when the action represented by this signal has
-     * been cancelled.
-     */
-    onabort: AbortHandler | Function | null;
-}
-/**
- * @public
- *
- * The AWS SDK uses a Controller/Signal model to allow for cooperative
- * cancellation of asynchronous operations. When initiating such an operation,
- * the caller can create an AbortController and then provide linked signal to
- * subtasks. This allows a single source to communicate to multiple consumers
- * that an action has been aborted without dictating how that cancellation
- * should be handled.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortController
- */
-export interface AbortController {
-    /**
-     * An object that reports whether the action associated with this
-     * `AbortController` has been cancelled.
-     */
-    readonly signal: AbortSignal;
-    /**
-     * Declares the operation associated with this AbortController to have been
-     * cancelled.
-     */
-    abort(): void;
-}
+export { AbortController, AbortHandler, AbortSignal } from "@smithy/types";

package/dist-types/auth.d.ts

@@ -1,55 +1 @@
-/**
- * @internal
- *
- * Authentication schemes represent a way that the service will authenticate the customer’s identity.
- */
-export interface AuthScheme {
-    /**
-     * @example "sigv4a" or "sigv4"
-     */
-    name: "sigv4" | "sigv4a" | string;
-    /**
-     * @example "s3"
-     */
-    signingName: string;
-    /**
-     * @example "us-east-1"
-     */
-    signingRegion: string;
-    /**
-     * @example ["*"]
-     * @example ["us-west-2", "us-east-1"]
-     */
-    signingRegionSet?: string[];
-    /**
-     * @deprecated this field was renamed to signingRegion.
-     */
-    signingScope?: never;
-    properties: Record<string, unknown>;
-}
-/**
- * @internal
- */
-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;
-}
-/**
- * @internal
- */
-export declare enum HttpAuthLocation {
-    HEADER = "header",
-    QUERY = "query"
-}
+export { AuthScheme, HttpAuthDefinition, HttpAuthLocation } from "@smithy/types";

package/dist-types/blob/blob-types.d.ts

@@ -0,0 +1,22 @@
+import { RuntimeBlobTypes } from "./runtime-blob-types.node";
+/**
+ * @public
+ *
+ * A union of types that can be used as inputs for the service model
+ * "blob" type when it represents the request's entire payload or body.
+ *
+ * For example, in Lambda::invoke, the payload is modeled as a blob type
+ * and this union applies to it.
+ * In contrast, in Lambda::createFunction the Zip file option is a blob type,
+ * but is not the (entire) payload and this union does not apply.
+ *
+ * Note: not all types are signable by the standard SignatureV4 signer when
+ * used as the request body. For example, in Node.js a Readable stream
+ * is not signable by the default signer.
+ * They are included in the union because it may work in some cases,
+ * but the expected types are primarily string and Uint8Array.
+ *
+ * Additional details may be found in the internal
+ * function "getPayloadHash" in the SignatureV4 module.
+ */
+export type BlobTypes = string | ArrayBuffer | ArrayBufferView | Uint8Array | RuntimeBlobTypes;

package/dist-types/blob/runtime-blob-types.browser.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @public
+ *
+ * Additional blob types for the browser environment.
+ */
+export type RuntimeBlobTypes = Blob | ReadableStream;

package/dist-types/blob/runtime-blob-types.node.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from "stream";
+/**
+ * @public
+ *
+ * Additional blob types for the Node.js environment.
+ */
+export type RuntimeBlobTypes = Readable | Buffer;

package/dist-types/checksum.d.ts

@@ -1,63 +1 @@
-import { SourceData } from "./crypto";
-/**
- * @public
- *
- * 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
- * at once when the checksum is finalized, depending on the underlying
- * implementation.
- *
- * It's recommended to compute checksum incrementally to avoid reading the
- * entire payload in memory.
- *
- * A class that implements this interface may accept an optional secret key in its
- * constructor while computing checksum value, when using HMAC. If provided,
- * this secret key would be used when computing checksum.
- */
-export interface Checksum {
-    /**
-     * Constant length of the digest created by the algorithm in bytes.
-     */
-    digestLength?: number;
-    /**
-     * Creates a new checksum object that contains a deep copy of the internal
-     * state of the current `Checksum` object.
-     */
-    copy?(): Checksum;
-    /**
-     * Returns the digest of all of the data passed.
-     */
-    digest(): Promise<Uint8Array>;
-    /**
-     * Allows marking a checksum for checksums that support the ability
-     * to mark and reset.
-     *
-     * @param readLimit - The maximum limit of bytes that can be read
-     *   before the mark position becomes invalid.
-     */
-    mark?(readLimit: number): void;
-    /**
-     * Resets the checksum to its initial value.
-     */
-    reset(): void;
-    /**
-     * Adds a chunk of data for which checksum needs to be computed.
-     * This can be called many times with new data as it is streamed.
-     *
-     * Implementations may override this method which passes second param
-     * which makes Checksum object stateless.
-     *
-     * @param chunk - The buffer to update checksum with.
-     */
-    update(chunk: Uint8Array): void;
-}
-/**
- * @public
- *
- * 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;
-}
+export { Checksum, ChecksumConstructor } from "@smithy/types";

package/dist-types/client.d.ts

@@ -1,25 +1 @@
-import { Command } from "./command";
-import { MiddlewareStack } from "./middleware";
-import { MetadataBearer } from "./response";
-/**
- * @public
- *
- * function definition for different overrides of client's 'send' function.
- */
-interface InvokeFunction<InputTypes extends object, OutputTypes extends MetadataBearer, ResolvedClientConfiguration> {
-    <InputType extends InputTypes, OutputType extends OutputTypes>(command: Command<InputTypes, InputType, OutputTypes, OutputType, ResolvedClientConfiguration>, options?: any): Promise<OutputType>;
-    <InputType extends InputTypes, OutputType extends OutputTypes>(command: Command<InputTypes, InputType, OutputTypes, OutputType, ResolvedClientConfiguration>, options: any, cb: (err: any, data?: OutputType) => void): void;
-    <InputType extends InputTypes, OutputType extends OutputTypes>(command: Command<InputTypes, InputType, OutputTypes, OutputType, ResolvedClientConfiguration>, options?: any, cb?: (err: any, data?: OutputType) => void): Promise<OutputType> | void;
-}
-/**
- * A general interface for service clients, idempotent to browser or node clients
- * This type corresponds to SmithyClient(https://github.com/aws/aws-sdk-js-v3/blob/main/packages/smithy-client/src/client.ts).
- * It's provided for using without importing the SmithyClient class.
- */
-export interface Client<Input extends object, Output extends MetadataBearer, ResolvedClientConfiguration> {
-    readonly config: ResolvedClientConfiguration;
-    middlewareStack: MiddlewareStack<Input, Output>;
-    send: InvokeFunction<Input, Output, ResolvedClientConfiguration>;
-    destroy: () => void;
-}
-export {};
+export { Client } from "@smithy/types";

package/dist-types/command.d.ts

@@ -1,10 +1 @@
-import { Handler, MiddlewareStack } from "./middleware";
-import { MetadataBearer } from "./response";
-/**
- * @public
- */
-export interface Command<ClientInput extends object, InputType extends ClientInput, ClientOutput extends MetadataBearer, OutputType extends ClientOutput, ResolvedConfiguration> {
-    readonly input: InputType;
-    readonly middlewareStack: MiddlewareStack<InputType, OutputType>;
-    resolveMiddleware(stack: MiddlewareStack<ClientInput, ClientOutput>, configuration: ResolvedConfiguration, options: any): Handler<InputType, OutputType>;
-}
+export { Command } from "@smithy/types";

package/dist-types/connection.d.ts

@@ -0,0 +1 @@
+export { ConnectConfiguration, ConnectionManager, ConnectionManagerConfiguration, ConnectionPool } from "@smithy/types";

package/dist-types/crypto.d.ts

@@ -1,60 +1 @@
-/**
- * @public
- */
-export type SourceData = string | ArrayBuffer | ArrayBufferView;
-/**
- * @public
- *
- * An object that provides a hash of data provided in chunks to `update`. The
- * hash may be performed incrementally as chunks are received or all at once
- * when the hash is finalized, depending on the underlying implementation.
- *
- * @deprecated use {@link Checksum}
- */
-export interface Hash {
-    /**
-     * Adds a chunk of data to the hash. If a buffer is provided, the `encoding`
-     * argument will be ignored. If a string is provided without a specified
-     * encoding, implementations must assume UTF-8 encoding.
-     *
-     * Not all encodings are supported on all platforms, though all must support
-     * UTF-8.
-     */
-    update(toHash: SourceData, encoding?: "utf8" | "ascii" | "latin1"): void;
-    /**
-     * Finalizes the hash and provides a promise that will be fulfilled with the
-     * raw bytes of the calculated hash.
-     */
-    digest(): Promise<Uint8Array>;
-}
-/**
- * @public
- *
- * 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;
-}
-/**
- * @public
- *
- * A function that calculates the hash of a data stream. Determining the hash
- * will consume the stream, so only replayable streams should be provided to an
- * implementation of this interface.
- */
-export interface StreamHasher<StreamType = any> {
-    (hashCtor: HashConstructor, stream: StreamType): Promise<Uint8Array>;
-}
-/**
- * @public
- *
- * A function that returns a promise fulfilled with bytes from a
- * cryptographically secure pseudorandom number generator.
- */
-export interface randomValues {
-    (byteLength: number): Promise<Uint8Array>;
-}
+export { Hash, HashConstructor, StreamHasher, randomValues, SourceData } from "@smithy/types";

package/dist-types/encode.d.ts

@@ -1,19 +1 @@
-import { Message } from "./eventStream";
-export interface MessageEncoder {
-    encode(message: Message): Uint8Array;
-}
-export interface MessageDecoder {
-    decode(message: ArrayBufferView): Message;
-    feed(message: ArrayBufferView): void;
-    endOfStream(): void;
-    getMessage(): AvailableMessage;
-    getAvailableMessages(): AvailableMessages;
-}
-export interface AvailableMessage {
-    getMessage(): Message | undefined;
-    isEndOfStream(): boolean;
-}
-export interface AvailableMessages {
-    getMessages(): Message[];
-    isEndOfStream(): boolean;
-}
+export { MessageDecoder, MessageEncoder, AvailableMessage, AvailableMessages } from "@smithy/types";

package/dist-types/endpoint.d.ts

@@ -1,77 +1 @@
-import { AuthScheme } from "./auth";
-/**
- * @public
- */
-export interface EndpointPartition {
-    name: string;
-    dnsSuffix: string;
-    dualStackDnsSuffix: string;
-    supportsFIPS: boolean;
-    supportsDualStack: boolean;
-}
-/**
- * @public
- */
-export interface EndpointARN {
-    partition: string;
-    service: string;
-    region: string;
-    accountId: string;
-    resourceId: Array<string>;
-}
-/**
- * @public
- */
-export declare enum EndpointURLScheme {
-    HTTP = "http",
-    HTTPS = "https"
-}
-/**
- * @public
- */
-export interface EndpointURL {
-    /**
-     * The URL scheme such as http or https.
-     */
-    scheme: EndpointURLScheme;
-    /**
-     * The authority is the host and optional port component of the URL.
-     */
-    authority: string;
-    /**
-     * The parsed path segment of the URL.
-     * This value is as-is as provided by the user.
-     */
-    path: string;
-    /**
-     * The parsed path segment of the URL.
-     * This value is guranteed to start and end with a "/".
-     */
-    normalizedPath: string;
-    /**
-     * A boolean indicating whether the authority is an IP address.
-     */
-    isIp: boolean;
-}
-/**
- * @public
- */
-export type EndpointObjectProperty = string | boolean | {
-    [key: string]: EndpointObjectProperty;
-} | EndpointObjectProperty[];
-/**
- * @public
- */
-export interface EndpointV2 {
-    url: URL;
-    properties?: {
-        authSchemes?: AuthScheme[];
-    } & Record<string, EndpointObjectProperty>;
-    headers?: Record<string, string[]>;
-}
-/**
- * @public
- */
-export type EndpointParameters = {
-    [name: string]: undefined | string | boolean;
-};
+export { EndpointARN, EndpointPartition, EndpointURLScheme, EndpointURL, EndpointObjectProperty, EndpointV2, EndpointParameters, } from "@smithy/types";

package/dist-types/eventStream.d.ts

@@ -1,108 +1 @@
-import { HttpRequest } from "./http";
-import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput, HandlerExecutionContext } from "./middleware";
-import { MetadataBearer } from "./response";
-/**
- * @public
- *
- * An event stream message. The headers and body properties will always be
- * defined, with empty headers represented as an object with no keys and an
- * empty body represented as a zero-length Uint8Array.
- */
-export interface Message {
-    headers: MessageHeaders;
-    body: Uint8Array;
-}
-/**
- * @public
- */
-export type MessageHeaders = Record<string, MessageHeaderValue>;
-type HeaderValue<K extends string, V> = {
-    type: K;
-    value: V;
-};
-export type BooleanHeaderValue = HeaderValue<"boolean", boolean>;
-export type ByteHeaderValue = HeaderValue<"byte", number>;
-export type ShortHeaderValue = HeaderValue<"short", number>;
-export type IntegerHeaderValue = HeaderValue<"integer", number>;
-export type LongHeaderValue = HeaderValue<"long", Int64>;
-export type BinaryHeaderValue = HeaderValue<"binary", Uint8Array>;
-export type StringHeaderValue = HeaderValue<"string", string>;
-export type TimestampHeaderValue = HeaderValue<"timestamp", Date>;
-export type UuidHeaderValue = HeaderValue<"uuid", string>;
-/**
- * @public
- */
-export type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
-/**
- * @public
- */
-export interface Int64 {
-    readonly bytes: Uint8Array;
-    valueOf: () => number;
-    toString: () => string;
-}
-/**
- * @public
- *
- * Util functions for serializing or deserializing event stream
- */
-export interface EventStreamSerdeContext {
-    eventStreamMarshaller: EventStreamMarshaller;
-}
-/**
- * @public
- *
- * A function which deserializes binary event stream message into modeled shape.
- */
-export interface EventStreamMarshallerDeserFn<StreamType> {
-    <T>(body: StreamType, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
-}
-/**
- * @public
- *
- * A function that serializes modeled shape into binary stream message.
- */
-export interface EventStreamMarshallerSerFn<StreamType> {
-    <T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
-}
-/**
- * @public
- *
- * An interface which provides functions for serializing and deserializing binary event stream
- * to/from corresponsing modeled shape.
- */
-export interface EventStreamMarshaller<StreamType = any> {
-    deserialize: EventStreamMarshallerDeserFn<StreamType>;
-    serialize: EventStreamMarshallerSerFn<StreamType>;
-}
-/**
- * @public
- */
-export interface EventStreamRequestSigner {
-    sign(request: HttpRequest): Promise<HttpRequest>;
-}
-/**
- * @public
- */
-export interface EventStreamPayloadHandler {
-    handle: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>, context?: HandlerExecutionContext) => Promise<FinalizeHandlerOutput<Output>>;
-}
-/**
- * @public
- */
-export interface EventStreamPayloadHandlerProvider {
-    (options: any): EventStreamPayloadHandler;
-}
-/**
- * @public
- */
-export interface EventStreamSerdeProvider {
-    (options: any): EventStreamMarshaller;
-}
-/**
- * @public
- */
-export interface EventStreamSignerProvider {
-    (options: any): EventStreamRequestSigner;
-}
-export {};
+export { Message, MessageHeaders, BooleanHeaderValue, ByteHeaderValue, ShortHeaderValue, IntegerHeaderValue, LongHeaderValue, BinaryHeaderValue, StringHeaderValue, TimestampHeaderValue, UuidHeaderValue, MessageHeaderValue, Int64, EventStreamSerdeContext, EventStreamMarshaller, EventStreamMarshallerDeserFn, EventStreamMarshallerSerFn, EventStreamPayloadHandler, EventStreamPayloadHandlerProvider, EventStreamRequestSigner, EventStreamSerdeProvider, EventStreamSignerProvider, } from "@smithy/types";