@aws-sdk/types 3.35.0 → 3.40.0

package/src/credentials.ts

@@ -1,29 +0,0 @@
-import { Provider } from "./util";
-
-/**
- * An object representing temporary or permanent AWS credentials.
- */
-export interface Credentials {
-  /**
-   * AWS access key ID
-   */
-  readonly accessKeyId: string;
-
-  /**
-   * AWS secret access key
-   */
-  readonly secretAccessKey: string;
-
-  /**
-   * A security or session token to use with these credentials. Usually
-   * present for temporary credentials.
-   */
-  readonly sessionToken?: string;
-
-  /**
-   * A {Date} when these credentials will no longer be accepted.
-   */
-  readonly expiration?: Date;
-}
-
-export type CredentialProvider = Provider<Credentials>;

package/src/crypto.d.ts

@@ -1,45 +0,0 @@
-export declare type SourceData = string | ArrayBuffer | ArrayBufferView;
-/**
- * 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.
- */
-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>;
-}
-/**
- * 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.
- */
-export interface HashConstructor {
-  new (secret?: SourceData): Hash;
-}
-/**
- * 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>;
-}
-/**
- * A function that returns a promise fulfilled with bytes from a
- * cryptographically secure pseudorandom number generator.
- */
-export interface randomValues {
-  (byteLength: number): Promise<Uint8Array>;
-}

package/src/crypto.ts

@@ -1,50 +0,0 @@
-export type SourceData = string | ArrayBuffer | ArrayBufferView;
-
-/**
- * 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.
- */
-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>;
-}
-
-/**
- * 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.
- */
-export interface HashConstructor {
-  new (secret?: SourceData): Hash;
-}
-
-/**
- * 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>;
-}
-
-/**
- * A function that returns a promise fulfilled with bytes from a
- * cryptographically secure pseudorandom number generator.
- */
-export interface randomValues {
-  (byteLength: number): Promise<Uint8Array>;
-}

package/src/eventStream.d.ts

@@ -1,100 +0,0 @@
-import { HttpRequest } from "./http";
-import {
-  FinalizeHandler,
-  FinalizeHandlerArguments,
-  FinalizeHandlerOutput,
-  HandlerExecutionContext,
-} from "./middleware";
-import { MetadataBearer } from "./response";
-/**
- * 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;
-}
-export interface MessageHeaders {
-  [name: string]: MessageHeaderValue;
-}
-export interface BooleanHeaderValue {
-  type: "boolean";
-  value: boolean;
-}
-export interface ByteHeaderValue {
-  type: "byte";
-  value: number;
-}
-export interface ShortHeaderValue {
-  type: "short";
-  value: number;
-}
-export interface IntegerHeaderValue {
-  type: "integer";
-  value: number;
-}
-export interface LongHeaderValue {
-  type: "long";
-  value: Int64;
-}
-export interface BinaryHeaderValue {
-  type: "binary";
-  value: Uint8Array;
-}
-export interface StringHeaderValue {
-  type: "string";
-  value: string;
-}
-export interface TimestampHeaderValue {
-  type: "timestamp";
-  value: Date;
-}
-export interface UuidHeaderValue {
-  type: "uuid";
-  value: string;
-}
-export declare type MessageHeaderValue =
-  | BooleanHeaderValue
-  | ByteHeaderValue
-  | ShortHeaderValue
-  | IntegerHeaderValue
-  | LongHeaderValue
-  | BinaryHeaderValue
-  | StringHeaderValue
-  | TimestampHeaderValue
-  | UuidHeaderValue;
-export interface Int64 {
-  readonly bytes: Uint8Array;
-  valueOf: () => number;
-  toString: () => string;
-}
-/**
- * Util functions for serializing or deserializing event stream
- */
-export interface EventStreamSerdeContext {
-  eventStreamMarshaller: EventStreamMarshaller;
-}
-export interface EventStreamMarshaller {
-  deserialize: (body: any, deserializer: (input: { [event: string]: Message }) => any) => AsyncIterable<any>;
-  serialize: (input: AsyncIterable<any>, serializer: (event: any) => Message) => any;
-}
-export interface EventStreamRequestSigner {
-  sign(request: HttpRequest): Promise<HttpRequest>;
-}
-export interface EventStreamPayloadHandler {
-  handle: <Input extends object, Output extends MetadataBearer>(
-    next: FinalizeHandler<Input, Output>,
-    args: FinalizeHandlerArguments<Input>,
-    context?: HandlerExecutionContext
-  ) => Promise<FinalizeHandlerOutput<Output>>;
-}
-export interface EventStreamPayloadHandlerProvider {
-  (options: any): EventStreamPayloadHandler;
-}
-export interface EventStreamSerdeProvider {
-  (options: any): EventStreamMarshaller;
-}
-export interface EventStreamSignerProvider {
-  (options: any): EventStreamRequestSigner;
-}

package/src/eventStream.ts

@@ -1,119 +0,0 @@
-import { HttpRequest } from "./http";
-import {
-  FinalizeHandler,
-  FinalizeHandlerArguments,
-  FinalizeHandlerOutput,
-  HandlerExecutionContext,
-} from "./middleware";
-import { MetadataBearer } from "./response";
-/**
- * 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;
-}
-
-export interface MessageHeaders {
-  [name: string]: MessageHeaderValue;
-}
-
-export interface BooleanHeaderValue {
-  type: "boolean";
-  value: boolean;
-}
-
-export interface ByteHeaderValue {
-  type: "byte";
-  value: number;
-}
-
-export interface ShortHeaderValue {
-  type: "short";
-  value: number;
-}
-
-export interface IntegerHeaderValue {
-  type: "integer";
-  value: number;
-}
-
-export interface LongHeaderValue {
-  type: "long";
-  value: Int64;
-}
-
-export interface BinaryHeaderValue {
-  type: "binary";
-  value: Uint8Array;
-}
-
-export interface StringHeaderValue {
-  type: "string";
-  value: string;
-}
-
-export interface TimestampHeaderValue {
-  type: "timestamp";
-  value: Date;
-}
-
-export interface UuidHeaderValue {
-  type: "uuid";
-  value: string;
-}
-
-export type MessageHeaderValue =
-  | BooleanHeaderValue
-  | ByteHeaderValue
-  | ShortHeaderValue
-  | IntegerHeaderValue
-  | LongHeaderValue
-  | BinaryHeaderValue
-  | StringHeaderValue
-  | TimestampHeaderValue
-  | UuidHeaderValue;
-
-export interface Int64 {
-  readonly bytes: Uint8Array;
-  valueOf: () => number;
-  toString: () => string;
-}
-
-/**
- * Util functions for serializing or deserializing event stream
- */
-export interface EventStreamSerdeContext {
-  eventStreamMarshaller: EventStreamMarshaller;
-}
-
-export interface EventStreamMarshaller {
-  deserialize: (body: any, deserializer: (input: { [event: string]: Message }) => any) => AsyncIterable<any>;
-  serialize: (input: AsyncIterable<any>, serializer: (event: any) => Message) => any;
-}
-
-export interface EventStreamRequestSigner {
-  sign(request: HttpRequest): Promise<HttpRequest>;
-}
-
-export interface EventStreamPayloadHandler {
-  handle: <Input extends object, Output extends MetadataBearer>(
-    next: FinalizeHandler<Input, Output>,
-    args: FinalizeHandlerArguments<Input>,
-    context?: HandlerExecutionContext
-  ) => Promise<FinalizeHandlerOutput<Output>>;
-}
-
-export interface EventStreamPayloadHandlerProvider {
-  (options: any): EventStreamPayloadHandler;
-}
-
-export interface EventStreamSerdeProvider {
-  (options: any): EventStreamMarshaller;
-}
-
-export interface EventStreamSignerProvider {
-  (options: any): EventStreamRequestSigner;
-}

package/src/http.d.ts

@@ -1,92 +0,0 @@
-import { AbortSignal } from "./abort";
-/**
- * A collection of key/value pairs with case-insensitive keys.
- */
-export interface Headers extends Map<string, string> {
-  /**
-   * Returns a new instance of Headers with the specified header set to the
-   * provided value. Does not modify the original Headers instance.
-   *
-   * @param headerName    The name of the header to add or overwrite
-   * @param headerValue   The value to which the header should be set
-   */
-  withHeader(headerName: string, headerValue: string): Headers;
-  /**
-   * Returns a new instance of Headers without the specified header. Does not
-   * modify the original Headers instance.
-   *
-   * @param headerName    The name of the header to remove
-   */
-  withoutHeader(headerName: string): Headers;
-}
-/**
- * A mapping of header names to string values. Multiple values for the same
- * header should be represented as a single string with values separated by
- * `, `.
- *
- * Keys should be considered case insensitive, even if this is not enforced by a
- * particular implementation. For example, given the following HeaderBag, where
- * keys differ only in case:
- *
- *    {
- *        'x-amz-date': '2000-01-01T00:00:00Z',
- *        'X-Amz-Date': '2001-01-01T00:00:00Z'
- *    }
- *
- * The SDK may at any point during processing remove one of the object
- * properties in favor of the other. The headers may or may not be combined, and
- * the SDK will not deterministically select which header candidate to use.
- */
-export interface HeaderBag {
-  [key: string]: string;
-}
-/**
- * Represents an HTTP message with headers and an optional static or streaming
- * body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
- */
-export interface HttpMessage {
-  headers: HeaderBag;
-  body?: any;
-}
-/**
- * A mapping of query parameter names to strings or arrays of strings, with the
- * second being used when a parameter contains a list of values. Value can be set
- * to null when query is not in key-value pairs shape
- */
-export interface QueryParameterBag {
-  [key: string]: string | Array<string> | null;
-}
-export interface Endpoint {
-  protocol: string;
-  hostname: string;
-  port?: number;
-  path: string;
-  query?: QueryParameterBag;
-}
-/**
- * Interface an HTTP request class. Contains
- * addressing information in addition to standard message properties.
- */
-export interface HttpRequest extends HttpMessage, Endpoint {
-  method: string;
-}
-/**
- * Represents an HTTP message as received in reply to a request. Contains a
- * numeric status code in addition to standard message properties.
- */
-export interface HttpResponse extends HttpMessage {
-  statusCode: number;
-}
-/**
- * Represents HTTP message whose body has been resolved to a string. This is
- * used in parsing http message.
- */
-export interface ResolvedHttpResponse extends HttpResponse {
-  body: string;
-}
-/**
- * Represents the options that may be passed to an Http Handler.
- */
-export interface HttpHandlerOptions {
-  abortSignal?: AbortSignal;
-}

package/src/http.ts

@@ -1,101 +0,0 @@
-import { AbortSignal } from "./abort";
-/**
- * A collection of key/value pairs with case-insensitive keys.
- */
-export interface Headers extends Map<string, string> {
-  /**
-   * Returns a new instance of Headers with the specified header set to the
-   * provided value. Does not modify the original Headers instance.
-   *
-   * @param headerName    The name of the header to add or overwrite
-   * @param headerValue   The value to which the header should be set
-   */
-  withHeader(headerName: string, headerValue: string): Headers;
-
-  /**
-   * Returns a new instance of Headers without the specified header. Does not
-   * modify the original Headers instance.
-   *
-   * @param headerName    The name of the header to remove
-   */
-  withoutHeader(headerName: string): Headers;
-}
-
-/**
- * A mapping of header names to string values. Multiple values for the same
- * header should be represented as a single string with values separated by
- * `, `.
- *
- * Keys should be considered case insensitive, even if this is not enforced by a
- * particular implementation. For example, given the following HeaderBag, where
- * keys differ only in case:
- *
- *    {
- *        'x-amz-date': '2000-01-01T00:00:00Z',
- *        'X-Amz-Date': '2001-01-01T00:00:00Z'
- *    }
- *
- * The SDK may at any point during processing remove one of the object
- * properties in favor of the other. The headers may or may not be combined, and
- * the SDK will not deterministically select which header candidate to use.
- */
-export interface HeaderBag {
-  [key: string]: string;
-}
-
-/**
- * Represents an HTTP message with headers and an optional static or streaming
- * body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
- */
-export interface HttpMessage {
-  headers: HeaderBag;
-  body?: any;
-}
-
-/**
- * A mapping of query parameter names to strings or arrays of strings, with the
- * second being used when a parameter contains a list of values. Value can be set
- * to null when query is not in key-value pairs shape
- */
-export interface QueryParameterBag {
-  [key: string]: string | Array<string> | null;
-}
-
-export interface Endpoint {
-  protocol: string;
-  hostname: string;
-  port?: number;
-  path: string;
-  query?: QueryParameterBag;
-}
-
-/**
- * Interface an HTTP request class. Contains
- * addressing information in addition to standard message properties.
- */
-export interface HttpRequest extends HttpMessage, Endpoint {
-  method: string;
-}
-
-/**
- * Represents an HTTP message as received in reply to a request. Contains a
- * numeric status code in addition to standard message properties.
- */
-export interface HttpResponse extends HttpMessage {
-  statusCode: number;
-}
-
-/**
- * Represents HTTP message whose body has been resolved to a string. This is
- * used in parsing http message.
- */
-export interface ResolvedHttpResponse extends HttpResponse {
-  body: string;
-}
-
-/**
- * Represents the options that may be passed to an Http Handler.
- */
-export interface HttpHandlerOptions {
-  abortSignal?: AbortSignal;
-}

package/src/index.d.ts

@@ -1,17 +0,0 @@
-export * from "./abort";
-export * from "./client";
-export * from "./command";
-export * from "./credentials";
-export * from "./crypto";
-export * from "./eventStream";
-export * from "./http";
-export * from "./logger";
-export * from "./pagination";
-export * from "./serde";
-export * from "./middleware";
-export * from "./response";
-export * from "./shapes";
-export * from "./signature";
-export * from "./transfer";
-export * from "./util";
-export * from "./waiter";

package/src/index.ts

@@ -1,17 +0,0 @@
-export * from "./abort";
-export * from "./client";
-export * from "./command";
-export * from "./credentials";
-export * from "./crypto";
-export * from "./eventStream";
-export * from "./http";
-export * from "./logger";
-export * from "./pagination";
-export * from "./serde";
-export * from "./middleware";
-export * from "./response";
-export * from "./shapes";
-export * from "./signature";
-export * from "./transfer";
-export * from "./util";
-export * from "./waiter";

package/src/logger.d.ts

@@ -1,26 +0,0 @@
-/**
- * A list of logger's log level. These levels are sorted in
- * order of increasing severity. Each log level includes itself and all
- * the levels behind itself.
- *
- * @example new Logger({logLevel: 'warn'}) will print all the warn and error
- * message.
- */
-export declare type LogLevel = "all" | "log" | "info" | "warn" | "error" | "off";
-/**
- * An object consumed by Logger constructor to initiate a logger object.
- */
-export interface LoggerOptions {
-  logger?: Logger;
-  logLevel?: LogLevel;
-}
-/**
- * Represents a logger object that is available in HandlerExecutionContext
- * throughout the middleware stack.
- */
-export interface Logger {
-  debug(content: object): void;
-  info(content: object): void;
-  warn(content: object): void;
-  error(content: object): void;
-}

package/src/logger.ts

@@ -1,28 +0,0 @@
-/**
- * A list of logger's log level. These levels are sorted in
- * order of increasing severity. Each log level includes itself and all
- * the levels behind itself.
- *
- * @example new Logger({logLevel: 'warn'}) will print all the warn and error
- * message.
- */
-export type LogLevel = "all" | "log" | "info" | "warn" | "error" | "off";
-
-/**
- * An object consumed by Logger constructor to initiate a logger object.
- */
-export interface LoggerOptions {
-  logger?: Logger;
-  logLevel?: LogLevel;
-}
-
-/**
- * Represents a logger object that is available in HandlerExecutionContext
- * throughout the middleware stack.
- */
-export interface Logger {
-  debug(content: object): void;
-  info(content: object): void;
-  warn(content: object): void;
-  error(content: object): void;
-}