@smithy/util-waiter 1.0.1 → 1.0.3

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

@@ -0,0 +1,11 @@
+import { WaiterOptions, WaiterResult } from "./waiter";
+/**
+ * Create a waiter promise that only resolves when:
+ * 1. Abort controller is signaled
+ * 2. Max wait time is reached
+ * 3. `acceptorChecks` succeeds, or fails
+ * Otherwise, it invokes `acceptorChecks` with exponential-backoff delay.
+ *
+ * @internal
+ */
+export declare const createWaiter: <Client, Input>(options: WaiterOptions<Client>, input: Input, acceptorChecks: (client: Client, input: Input) => Promise<WaiterResult>) => Promise<WaiterResult>;

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

@@ -0,0 +1,2 @@
+export * from "./createWaiter";
+export * from "./waiter";

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

@@ -0,0 +1,10 @@
+import { WaiterOptions, WaiterResult } from "./waiter";
+/**
+ * Function that runs polling as part of waiters. This will make one inital attempt and then
+ * subsequent attempts with an increasing delay.
+ * @param params - options passed to the waiter.
+ * @param client - AWS SDK Client
+ * @param input - client input
+ * @param stateChecker - function that checks the acceptor states on each poll.
+ */
+export declare const runPolling: <Client, Input>({ minDelay, maxDelay, maxWaitTime, abortController, client, abortSignal }: WaiterOptions<Client>, input: Input, acceptorChecks: (client: Client, input: Input) => Promise<WaiterResult>) => Promise<WaiterResult>;

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

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export * from "./sleep";
+/**
+ * @internal
+ */
+export * from "./validate";

package/dist-types/ts3.4/utils/sleep.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export declare const sleep: (seconds: number) => Promise<unknown>;

package/dist-types/ts3.4/utils/validate.d.ts

@@ -0,0 +1,8 @@
+import { WaiterOptions } from "../waiter";
+/**
+ * @internal
+ *
+ * Validates that waiter options are passed correctly
+ * @param options - a waiter configuration object
+ */
+export declare const validateWaiterOptions: <Client>(options: WaiterOptions<Client>) => void;

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

@@ -0,0 +1,44 @@
+import { WaiterConfiguration as WaiterConfiguration__ } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface WaiterConfiguration<T> extends WaiterConfiguration__<T> {
+}
+/**
+ * @internal
+ */
+export declare const waiterServiceDefaults: {
+    minDelay: number;
+    maxDelay: number;
+};
+/**
+ * @internal
+ */
+export type WaiterOptions<Client> = WaiterConfiguration<Client> & Required<Pick<WaiterConfiguration<Client>, "minDelay" | "maxDelay">>;
+/**
+ * @internal
+ */
+export declare enum WaiterState {
+    ABORTED = "ABORTED",
+    FAILURE = "FAILURE",
+    SUCCESS = "SUCCESS",
+    RETRY = "RETRY",
+    TIMEOUT = "TIMEOUT"
+}
+/**
+ * @internal
+ */
+export type WaiterResult = {
+    state: WaiterState;
+    /**
+     * (optional) Indicates a reason for why a waiter has reached its state.
+     */
+    reason?: any;
+};
+/**
+ * @internal
+ *
+ * Handles and throws exceptions resulting from the waiterResult
+ * @param result - WaiterResult
+ */
+export declare const checkExceptions: (result: WaiterResult) => WaiterResult;

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@smithy/util-waiter",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Shared utilities for client waiters for the AWS SDK",
   "dependencies": {
-    "@smithy/abort-controller": "^1.0.1",
-    "@smithy/types": "^1.1.0",
+    "@smithy/abort-controller": "^1.0.3",
+    "@smithy/types": "^2.0.0",
     "tslib": "^2.5.0"
   },
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",