@smithy/property-provider 4.2.12 → 4.2.14

package/README.md

@@ -3,8 +3,15 @@
 [![NPM version](https://img.shields.io/npm/v/@smithy/property-provider/latest.svg)](https://www.npmjs.com/package/@smithy/property-provider)
 [![NPM downloads](https://img.shields.io/npm/dm/@smithy/property-provider.svg)](https://www.npmjs.com/package/@smithy/property-provider)
 
-> An internal package
+### :warning: Internal API :warning:
 
-## Usage
+> This is an internal package.
+> That means this is used as a dependency for other, public packages, but
+> should not be taken directly as a dependency in your application's `package.json`.
 
-You probably shouldn't, at least directly.
+> If you are updating the version of this package, for example to bring in a
+> bug-fix, you should do so by updating your application lockfile with
+> e.g. `npm up @scope/package` or equivalent command in another
+> package manager, rather than taking a direct dependency.
+
+---

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@smithy/property-provider",
-  "version": "4.2.12",
+  "version": "4.2.14",
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
-    "build:cjs": "node ../../scripts/inline property-provider",
-    "build:es": "yarn g:tsc -p tsconfig.es.json",
+    "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'",
+    "build:es:cjs": "yarn g:tsc -p tsconfig.es.json && node ../../scripts/inline property-provider",
     "build:types": "yarn g:tsc -p tsconfig.types.json",
     "build:types:downlevel": "premove dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
-    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
-    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
     "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"",
+    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
+    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "test": "yarn g:vitest run",
     "test:watch": "yarn g:vitest watch"
   },
@@ -24,7 +23,7 @@
   "license": "Apache-2.0",
   "sideEffects": false,
   "dependencies": {
-    "@smithy/types": "^4.13.1",
+    "@smithy/types": "^4.14.1",
     "tslib": "^2.6.2"
   },
   "engines": {

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

@@ -1,31 +0,0 @@
-import { ProviderErrorOptionsType } from "./ProviderError";
-import { ProviderError } from "./ProviderError";
-/**
- * @public
- *
- * 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 {
-    name: string;
-    /**
-     * @override
-     * @deprecated constructor should be given a logger.
-     */
-    constructor(message: string);
-    /**
-     * @override
-     * @deprecated constructor should be given a logger.
-     */
-    constructor(message: string, tryNextLink: boolean | undefined);
-    /**
-     * @override
-     * This signature is preferred for logging capability.
-     */
-    constructor(message: string, options: ProviderErrorOptionsType);
-}

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

@@ -1,39 +0,0 @@
-import { Logger } from "@smithy/types";
-/**
- * @public
- */
-export type ProviderErrorOptionsType = {
-    tryNextLink?: boolean | undefined;
-    logger?: Logger;
-};
-/**
- * @public
- *
- * 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 {
-    name: string;
-    readonly tryNextLink: boolean;
-    /**
-     * @deprecated constructor should be given a logger.
-     */
-    constructor(message: string);
-    /**
-     * @deprecated constructor should be given a logger.
-     */
-    constructor(message: string, tryNextLink: boolean | undefined);
-    /**
-     * This signature is preferred for logging capability.
-     */
-    constructor(message: string, options: ProviderErrorOptionsType);
-    /**
-     * @deprecated use new operator.
-     */
-    static from(error: Error, options?: boolean | ProviderErrorOptionsType): ProviderError;
-}

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

@@ -1,31 +0,0 @@
-import { ProviderErrorOptionsType } from "./ProviderError";
-import { ProviderError } from "./ProviderError";
-/**
- * @public
- *
- * 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 {
-    name: string;
-    /**
-     * @override
-     * @deprecated constructor should be given a logger.
-     */
-    constructor(message: string);
-    /**
-     * @override
-     * @deprecated constructor should be given a logger.
-     */
-    constructor(message: string, tryNextLink: boolean | undefined);
-    /**
-     * @override
-     * This signature is preferred for logging capability.
-     */
-    constructor(message: string, options: ProviderErrorOptionsType);
-}

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

@@ -1,13 +0,0 @@
-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 const chain: <T>(...providers: Array<Provider<T>>) => Provider<T>;

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

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

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

@@ -1,24 +0,0 @@
-/**
- * @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

@@ -1,40 +0,0 @@
-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 {};