@aws-sdk/types 3.215.0 → 3.222.0

package/dist-cjs/checksum.js

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

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("./checksum"), exports);
 tslib_1.__exportStar(require("./client"), exports);
 tslib_1.__exportStar(require("./command"), exports);
 tslib_1.__exportStar(require("./credentials"), exports);
@@ -16,6 +17,7 @@ tslib_1.__exportStar(require("./middleware"), exports);
 tslib_1.__exportStar(require("./pagination"), exports);
 tslib_1.__exportStar(require("./profile"), exports);
 tslib_1.__exportStar(require("./response"), exports);
+tslib_1.__exportStar(require("./retry"), exports);
 tslib_1.__exportStar(require("./serde"), exports);
 tslib_1.__exportStar(require("./shapes"), exports);
 tslib_1.__exportStar(require("./signature"), exports);

package/dist-cjs/retry.js

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

package/dist-es/checksum.js

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

package/dist-es/index.js

@@ -1,5 +1,6 @@
 export * from "./abort";
 export * from "./auth";
+export * from "./checksum";
 export * from "./client";
 export * from "./command";
 export * from "./credentials";
@@ -13,6 +14,7 @@ export * from "./middleware";
 export * from "./pagination";
 export * from "./profile";
 export * from "./response";
+export * from "./retry";
 export * from "./serde";
 export * from "./shapes";
 export * from "./signature";

package/dist-es/retry.js

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

package/dist-types/checksum.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 {number} 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 {Uint8Array} chunk - The buffer to update checksum with.
+     */
+    update(chunk: Uint8Array): void;
+}

package/dist-types/crypto.d.ts

@@ -3,6 +3,8 @@ 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.
+ *
+ * @deprecated use {@link Checksum}
  */
 export interface Hash {
     /**

package/dist-types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./abort";
 export * from "./auth";
+export * from "./checksum";
 export * from "./client";
 export * from "./command";
 export * from "./credentials";
@@ -13,6 +14,7 @@ export * from "./middleware";
 export * from "./pagination";
 export * from "./profile";
 export * from "./response";
+export * from "./retry";
 export * from "./serde";
 export * from "./shapes";
 export * from "./signature";

package/dist-types/retry.d.ts

@@ -0,0 +1,112 @@
+export declare type RetryErrorType = 
+/**
+ * This is a connection level error such as a socket timeout, socket connect
+ * error, tls negotiation timeout etc...
+ * Typically these should never be applied for non-idempotent request types
+ * since in this scenario, it's impossible to know whether the operation had
+ * a side effect on the server.
+ */
+"TRANSIENT"
+/**
+ * This is an error where the server explicitly told the client to back off,
+ * such as a 429 or 503 Http error.
+ */
+ | "THROTTLING"
+/**
+ * This is a server error that isn't explicitly throttling but is considered
+ * by the client to be something that should be retried.
+ */
+ | "SERVER_ERROR"
+/**
+ * Doesn't count against any budgets. This could be something like a 401
+ * challenge in Http.
+ */
+ | "CLIENT_ERROR";
+export interface RetryErrorInfo {
+    errorType: RetryErrorType;
+    /**
+     * Protocol hint. This could come from Http's 'retry-after' header or
+     * something from MQTT or any other protocol that has the ability to convey
+     * retry info from a peer.
+     *
+     * @returns the Date after which a retry should be attempted.
+     */
+    retryAfterHint?: Date;
+}
+export interface RetryBackoffStrategy {
+    /**
+     * @returns the number of milliseconds to wait before retrying an action.
+     */
+    computeNextBackoffDelay(retryAttempt: number): number;
+}
+export interface StandardRetryBackoffStrategy extends RetryBackoffStrategy {
+    /**
+     * Sets the delayBase used to compute backoff delays.
+     * @param delayBase
+     */
+    setDelayBase(delayBase: number): void;
+}
+export interface RetryStrategyOptions {
+    backoffStrategy: RetryBackoffStrategy;
+    maxRetriesBase: number;
+}
+export interface RetryToken {
+    /**
+     * @returns the current count of retry.
+     */
+    getRetryCount(): number;
+    /**
+     * @returns the number of milliseconds to wait before retrying an action.
+     */
+    getRetryDelay(): number;
+}
+export interface StandardRetryToken extends RetryToken {
+    /**
+     * @returns wheather token has remaining tokens.
+     */
+    hasRetryTokens(errorType: RetryErrorType): boolean;
+    /**
+     * @returns the number of available tokens.
+     */
+    getRetryTokenCount(errorInfo: RetryErrorInfo): number;
+    /**
+     * @returns the cost of the last retry attemp.
+     */
+    getLastRetryCost(): number | undefined;
+    /**
+     * Releases a number of tokens.
+     *
+     * @param amount of tokens to release.
+     */
+    releaseRetryTokens(amount?: number): void;
+}
+export interface RetryStrategyV2 {
+    /**
+     * Called before any retries (for the first call to the operation). It either
+     * returns a retry token or an error upon the failure to acquire a token prior.
+     *
+     * tokenScope is arbitrary and out of scope for this component. However,
+     * adding it here offers us a lot of future flexibility for outage detection.
+     * For example, it could be "us-east-1" on a shared retry strategy, or
+     * "us-west-2-c:dynamodb".
+     */
+    acquireInitialRetryToken(retryTokenScope: string): Promise<RetryToken>;
+    /**
+     * After a failed operation call, this function is invoked to refresh the
+     * retryToken returned by acquireInitialRetryToken(). This function can
+     * either choose to allow another retry and send a new or updated token,
+     * or reject the retry attempt and report the error either in an exception
+     * or returning an error.
+     */
+    refreshRetryTokenForRetry(tokenToRenew: RetryToken, errorInfo: RetryErrorInfo): Promise<RetryToken>;
+    /**
+     * Upon successful completion of the operation, a user calls this function
+     * to record that the operation was successful.
+     */
+    recordSuccess(token: RetryToken): void;
+}
+export declare type ExponentialBackoffJitterType = "DEFAULT" | "NONE" | "FULL" | "DECORRELATED";
+export interface ExponentialBackoffStrategyOptions {
+    jitterType: ExponentialBackoffJitterType;
+    backoffScaleValue?: number;
+}

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

@@ -0,0 +1,8 @@
+export interface Checksum {
+  digestLength?: number;
+  copy?(): Checksum;
+  digest(): Promise<Uint8Array>;
+  mark?(readLimit: number): void;
+  reset(): void;
+  update(chunk: Uint8Array): void;
+}

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

@@ -1,5 +1,6 @@
 export * from "./abort";
 export * from "./auth";
+export * from "./checksum";
 export * from "./client";
 export * from "./command";
 export * from "./credentials";
@@ -13,6 +14,7 @@ export * from "./middleware";
 export * from "./pagination";
 export * from "./profile";
 export * from "./response";
+export * from "./retry";
 export * from "./serde";
 export * from "./shapes";
 export * from "./signature";

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

@@ -0,0 +1,46 @@
+export declare type RetryErrorType =
+  | "TRANSIENT"
+  | "THROTTLING"
+  | "SERVER_ERROR"
+  | "CLIENT_ERROR";
+export interface RetryErrorInfo {
+  errorType: RetryErrorType;
+  retryAfterHint?: Date;
+}
+export interface RetryBackoffStrategy {
+  computeNextBackoffDelay(retryAttempt: number): number;
+}
+export interface StandardRetryBackoffStrategy extends RetryBackoffStrategy {
+  setDelayBase(delayBase: number): void;
+}
+export interface RetryStrategyOptions {
+  backoffStrategy: RetryBackoffStrategy;
+  maxRetriesBase: number;
+}
+export interface RetryToken {
+  getRetryCount(): number;
+  getRetryDelay(): number;
+}
+export interface StandardRetryToken extends RetryToken {
+  hasRetryTokens(errorType: RetryErrorType): boolean;
+  getRetryTokenCount(errorInfo: RetryErrorInfo): number;
+  getLastRetryCost(): number | undefined;
+  releaseRetryTokens(amount?: number): void;
+}
+export interface RetryStrategyV2 {
+  acquireInitialRetryToken(retryTokenScope: string): Promise<RetryToken>;
+  refreshRetryTokenForRetry(
+    tokenToRenew: RetryToken,
+    errorInfo: RetryErrorInfo
+  ): Promise<RetryToken>;
+  recordSuccess(token: RetryToken): void;
+}
+export declare type ExponentialBackoffJitterType =
+  | "DEFAULT"
+  | "NONE"
+  | "FULL"
+  | "DECORRELATED";
+export interface ExponentialBackoffStrategyOptions {
+  jitterType: ExponentialBackoffJitterType;
+  backoffScaleValue?: number;
+}

package/package.json

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