@smithy/property-provider 3.0.0 → 3.1.0

package/dist-cjs/index.js

@@ -31,14 +31,28 @@ module.exports = __toCommonJS(src_exports);
 
 // src/ProviderError.ts
 var _ProviderError = class _ProviderError extends Error {
-  constructor(message, tryNextLink = true) {
+  constructor(message, options = true) {
+    var _a;
+    let logger;
+    let tryNextLink = true;
+    if (typeof options === "boolean") {
+      logger = void 0;
+      tryNextLink = options;
+    } else if (options != null && typeof options === "object") {
+      logger = options.logger;
+      tryNextLink = options.tryNextLink ?? true;
+    }
     super(message);
-    this.tryNextLink = tryNextLink;
     this.name = "ProviderError";
+    this.tryNextLink = tryNextLink;
     Object.setPrototypeOf(this, _ProviderError.prototype);
+    (_a = logger == null ? void 0 : logger.debug) == null ? void 0 : _a.call(logger, `@smithy/property-provider ${tryNextLink ? "->" : "(!)"} ${message}`);
   }
-  static from(error, tryNextLink = true) {
-    return Object.assign(new this(error.message, tryNextLink), error);
+  /**
+   * @deprecated use new operator.
+   */
+  static from(error, options = true) {
+    return Object.assign(new this(error.message, options), error);
   }
 };
 __name(_ProviderError, "ProviderError");
@@ -46,9 +60,11 @@ var ProviderError = _ProviderError;
 
 // src/CredentialsProviderError.ts
 var _CredentialsProviderError = class _CredentialsProviderError extends ProviderError {
-  constructor(message, tryNextLink = true) {
-    super(message, tryNextLink);
-    this.tryNextLink = tryNextLink;
+  /**
+   * @override
+   */
+  constructor(message, options = true) {
+    super(message, options);
     this.name = "CredentialsProviderError";
     Object.setPrototypeOf(this, _CredentialsProviderError.prototype);
   }
@@ -58,9 +74,11 @@ var CredentialsProviderError = _CredentialsProviderError;
 
 // src/TokenProviderError.ts
 var _TokenProviderError = class _TokenProviderError extends ProviderError {
-  constructor(message, tryNextLink = true) {
-    super(message, tryNextLink);
-    this.tryNextLink = tryNextLink;
+  /**
+   * @override
+   */
+  constructor(message, options = true) {
+    super(message, options);
     this.name = "TokenProviderError";
     Object.setPrototypeOf(this, _TokenProviderError.prototype);
   }

package/dist-es/CredentialsProviderError.js

@@ -1,8 +1,7 @@
 import { ProviderError } from "./ProviderError";
 export class CredentialsProviderError extends ProviderError {
-    constructor(message, tryNextLink = true) {
-        super(message, tryNextLink);
-        this.tryNextLink = tryNextLink;
+    constructor(message, options = true) {
+        super(message, options);
         this.name = "CredentialsProviderError";
         Object.setPrototypeOf(this, CredentialsProviderError.prototype);
     }

package/dist-es/ProviderError.js

@@ -1,11 +1,22 @@
 export class ProviderError extends Error {
-    constructor(message, tryNextLink = true) {
+    constructor(message, options = true) {
+        let logger;
+        let tryNextLink = true;
+        if (typeof options === "boolean") {
+            logger = undefined;
+            tryNextLink = options;
+        }
+        else if (options != null && typeof options === "object") {
+            logger = options.logger;
+            tryNextLink = options.tryNextLink ?? true;
+        }
         super(message);
-        this.tryNextLink = tryNextLink;
         this.name = "ProviderError";
+        this.tryNextLink = tryNextLink;
         Object.setPrototypeOf(this, ProviderError.prototype);
+        logger?.debug?.(`@smithy/property-provider ${tryNextLink ? "->" : "(!)"} ${message}`);
     }
-    static from(error, tryNextLink = true) {
-        return Object.assign(new this(error.message, tryNextLink), error);
+    static from(error, options = true) {
+        return Object.assign(new this(error.message, options), error);
     }
 }

package/dist-es/TokenProviderError.js

@@ -1,8 +1,7 @@
 import { ProviderError } from "./ProviderError";
 export class TokenProviderError extends ProviderError {
-    constructor(message, tryNextLink = true) {
-        super(message, tryNextLink);
-        this.tryNextLink = tryNextLink;
+    constructor(message, options = true) {
+        super(message, options);
         this.name = "TokenProviderError";
         Object.setPrototypeOf(this, TokenProviderError.prototype);
     }

package/dist-types/CredentialsProviderError.d.ts

@@ -1,4 +1,4 @@
-import { ProviderError } from "./ProviderError";
+import { ProviderError, ProviderErrorOptionsType } from "./ProviderError";
 /**
  * @public
  *
@@ -11,7 +11,20 @@ import { ProviderError } from "./ProviderError";
  * 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);
+    /**
+     * @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/ProviderError.d.ts

@@ -1,3 +1,11 @@
+import { Logger } from "@smithy/types";
+/**
+ * @public
+ */
+export type ProviderErrorOptionsType = {
+    tryNextLink?: boolean | undefined;
+    logger?: Logger;
+};
 /**
  * @public
  *
@@ -10,8 +18,22 @@
  * 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;
+    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/TokenProviderError.d.ts

@@ -1,4 +1,4 @@
-import { ProviderError } from "./ProviderError";
+import { ProviderError, ProviderErrorOptionsType } from "./ProviderError";
 /**
  * @public
  *
@@ -11,7 +11,20 @@ import { ProviderError } from "./ProviderError";
  * 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);
+    /**
+     * @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/CredentialsProviderError.d.ts

@@ -1,4 +1,4 @@
-import { ProviderError } from "./ProviderError";
+import { ProviderError, ProviderErrorOptionsType } from "./ProviderError";
 /**
  * @public
  *
@@ -11,7 +11,20 @@ import { ProviderError } from "./ProviderError";
  * 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);
+    /**
+     * @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,3 +1,11 @@
+import { Logger } from "@smithy/types";
+/**
+ * @public
+ */
+export type ProviderErrorOptionsType = {
+    tryNextLink?: boolean | undefined;
+    logger?: Logger;
+};
 /**
  * @public
  *
@@ -10,8 +18,22 @@
  * 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;
+    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,4 +1,4 @@
-import { ProviderError } from "./ProviderError";
+import { ProviderError, ProviderErrorOptionsType } from "./ProviderError";
 /**
  * @public
  *
@@ -11,7 +11,20 @@ import { ProviderError } from "./ProviderError";
  * 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);
+    /**
+     * @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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smithy/property-provider",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "node ../../scripts/inline property-provider",