@smithy/property-provider 1.0.1 → 1.0.2

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

@@ -0,0 +1,17 @@
+import { ProviderError } from "./ProviderError";
+/**
+ * @internal
+ *
+ * An error representing a failure of an individual credential provider.
+ *
+ * This error class has special meaning to the {@link chain} method. If a
+ * provider in the chain is rejected with an error, the chain will only proceed
+ * to the next provider if the value of the `tryNextLink` property on the error
+ * is truthy. This allows individual providers to halt the chain and also
+ * ensures the chain will stop if an entirely unexpected error is encountered.
+ */
+export declare class CredentialsProviderError extends ProviderError {
+    readonly tryNextLink: boolean;
+    name: string;
+    constructor(message: string, tryNextLink?: boolean);
+}

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

@@ -0,0 +1,17 @@
+/**
+ * @internal
+ *
+ * An error representing a failure of an individual provider.
+ *
+ * This error class has special meaning to the {@link chain} method. If a
+ * provider in the chain is rejected with an error, the chain will only proceed
+ * to the next provider if the value of the `tryNextLink` property on the error
+ * is truthy. This allows individual providers to halt the chain and also
+ * ensures the chain will stop if an entirely unexpected error is encountered.
+ */
+export declare class ProviderError extends Error {
+    readonly tryNextLink: boolean;
+    name: string;
+    constructor(message: string, tryNextLink?: boolean);
+    static from(error: Error, tryNextLink?: boolean): ProviderError;
+}

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

@@ -0,0 +1,17 @@
+import { ProviderError } from "./ProviderError";
+/**
+ * @internal
+ *
+ * An error representing a failure of an individual token provider.
+ *
+ * This error class has special meaning to the {@link chain} method. If a
+ * provider in the chain is rejected with an error, the chain will only proceed
+ * to the next provider if the value of the `tryNextLink` property on the error
+ * is truthy. This allows individual providers to halt the chain and also
+ * ensures the chain will stop if an entirely unexpected error is encountered.
+ */
+export declare class TokenProviderError extends ProviderError {
+    readonly tryNextLink: boolean;
+    name: string;
+    constructor(message: string, tryNextLink?: boolean);
+}

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

@@ -0,0 +1,13 @@
+import { Provider } from "@smithy/types";
+/**
+ * @internal
+ *
+ * Compose a single credential provider function from multiple credential
+ * providers. The first provider in the argument list will always be invoked;
+ * subsequent providers in the list will be invoked in the order in which the
+ * were received if the preceding provider did not successfully resolve.
+ *
+ * If no providers were received or no provider resolves successfully, the
+ * returned promise will be rejected.
+ */
+export declare function chain<T>(...providers: Array<Provider<T>>): Provider<T>;

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

@@ -0,0 +1,5 @@
+import { Provider } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const fromStatic: <T>(staticValue: T) => Provider<T>;

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

@@ -0,0 +1,24 @@
+/**
+ * @internal
+ */
+export * from "./CredentialsProviderError";
+/**
+ * @internal
+ */
+export * from "./ProviderError";
+/**
+ * @internal
+ */
+export * from "./TokenProviderError";
+/**
+ * @internal
+ */
+export * from "./chain";
+/**
+ * @internal
+ */
+export * from "./fromStatic";
+/**
+ * @internal
+ */
+export * from "./memoize";

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

@@ -0,0 +1,40 @@
+import { MemoizedProvider, Provider } from "@smithy/types";
+interface MemoizeOverload {
+    /**
+     *
+     * Decorates a provider function with either static memoization.
+     *
+     * To create a statically memoized provider, supply a provider as the only
+     * argument to this function. The provider will be invoked once, and all
+     * invocations of the provider returned by `memoize` will return the same
+     * promise object.
+     *
+     * @param provider The provider whose result should be cached indefinitely.
+     */
+    <T>(provider: Provider<T>): MemoizedProvider<T>;
+    /**
+     * Decorates a provider function with refreshing memoization.
+     *
+     * @param provider          The provider whose result should be cached.
+     * @param isExpired         A function that will evaluate the resolved value and
+     *                          determine if it is expired. For example, when
+     *                          memoizing AWS credential providers, this function
+     *                          should return `true` when the credential's
+     *                          expiration is in the past (or very near future) and
+     *                          `false` otherwise.
+     * @param requiresRefresh   A function that will evaluate the resolved value and
+     *                          determine if it represents static value or one that
+     *                          will eventually need to be refreshed. For example,
+     *                          AWS credentials that have no defined expiration will
+     *                          never need to be refreshed, so this function would
+     *                          return `true` if the credentials resolved by the
+     *                          underlying provider had an expiration and `false`
+     *                          otherwise.
+     */
+    <T>(provider: Provider<T>, isExpired: (resolved: T) => boolean, requiresRefresh?: (resolved: T) => boolean): MemoizedProvider<T>;
+}
+/**
+ * @internal
+ */
+export declare const memoize: MemoizeOverload;
+export {};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@smithy/property-provider",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "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",
@@ -22,7 +22,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@smithy/types": "^1.1.0",
+    "@smithy/types": "^1.1.1",
     "tslib": "^2.5.0"
   },
   "engines": {