@ledgerhq/errors 6.10.1-nightly.1 → 6.10.2-next.0

package/src/helpers.ts

@@ -13,24 +13,34 @@ export const addCustomErrorDeserializer = (
   deserializers[name] = deserializer;
 };
 
-export type CustomErrorFunc = (
-  message?: string,
-  fields?: { [key: string]: any },
-  options?: any
-) => void;
+export interface LedgerErrorConstructor<F extends { [key: string]: unknown }>
+  extends ErrorConstructor {
+  new (message?: string, fields?: F, options?: any): Error;
+  (message?: string, fields?: F, options?: any): Error;
+  readonly prototype: Error;
+}
 
-export const createCustomErrorClass = (name: string): CustomErrorFunc => {
+export const createCustomErrorClass = <
+  F extends { [key: string]: unknown },
+  T extends LedgerErrorConstructor<F>
+>(
+  name: string
+): T => {
   class CustomErrorClass extends Error {
     cause?: Error;
-    constructor(message, fields, options) {
+    constructor(message?: string, fields?: F, options?: any) {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore
       super(message || name, options);
       // Set the prototype explicitly. See https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
       Object.setPrototypeOf(this, CustomErrorClass.prototype);
       this.name = name;
-      for (const k in fields) {
-        this[k] = fields[k];
+      if (fields) {
+        for (const k in fields) {
+          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+          // @ts-ignore
+          this[k] = fields[k];
+        }
       }
       if (isObject(options) && "cause" in options && !("cause" in this)) {
         // .cause was specified but the superconstructor
@@ -46,9 +56,7 @@ export const createCustomErrorClass = (name: string): CustomErrorFunc => {
 
   errorClasses[name] = CustomErrorClass;
 
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  return CustomErrorClass;
+  return CustomErrorClass as unknown as T;
 };
 
 function isObject(value) {
@@ -106,7 +114,9 @@ export const deserializeError = (object: any): Error => {
 };
 
 // inspired from https://github.com/sindresorhus/serialize-error/blob/master/index.js
-export const serializeError = (value: any): undefined | To | string => {
+export const serializeError = (
+  value: undefined | To | string | (() => unknown)
+): undefined | To | string => {
   if (!value) return value;
   if (typeof value === "object") {
     return destroyCircular(value, []);
@@ -124,7 +134,7 @@ interface To {
 }
 
 // https://www.npmjs.com/package/destroy-circular
-function destroyCircular(from: any, seen: any[]): To {
+function destroyCircular(from: To, seen: Array<To>): To {
   const to: To = {};
   seen.push(from);
   for (const key of Object.keys(from)) {

package/src/index.test.ts

@@ -1,4 +1,4 @@
-import { AmountRequired } from "./index";
+import { AmountRequired, CurrencyNotSupported } from "./index";
 
 function functionA() {
   throw new AmountRequired();
@@ -35,9 +35,12 @@ describe("custom errors", () => {
 
   test("error with custom fields", () => {
     try {
-      throw new AmountRequired("YO", { foo: 42 });
+      throw new CurrencyNotSupported("YO", { currencyName: "foo" });
     } catch (e: any) {
-      expect(e.foo).toEqual(42);
+      expect(
+        // FIXME it's not yet the good type here
+        e instanceof CurrencyNotSupported && (e as any).currencyName
+      ).toEqual("foo");
     }
   });
 
@@ -66,4 +69,9 @@ describe("custom errors", () => {
       AmountRequired
     );
   });
+
+  test("error is instance of Error", () => {
+    const error: Error = new AmountRequired();
+    expect(error instanceof Error).toBeTruthy();
+  });
 });

package/src/index.ts

@@ -3,6 +3,7 @@ import {
   deserializeError,
   createCustomErrorClass,
   addCustomErrorDeserializer,
+  LedgerErrorConstructor,
 } from "./helpers";
 
 export {
@@ -25,9 +26,10 @@ export const CantOpenDevice = createCustomErrorClass("CantOpenDevice");
 export const CashAddrNotSupported = createCustomErrorClass(
   "CashAddrNotSupported"
 );
-export const CurrencyNotSupported = createCustomErrorClass(
-  "CurrencyNotSupported"
-);
+export const CurrencyNotSupported = createCustomErrorClass<
+  { currencyName: string },
+  LedgerErrorConstructor<{ currencyName: string }>
+>("CurrencyNotSupported");
 export const DeviceAppVerifyNotSupported = createCustomErrorClass(
   "DeviceAppVerifyNotSupported"
 );
@@ -111,6 +113,7 @@ export const ManagerUninstallBTCDep = createCustomErrorClass(
   "ManagerUninstallBTCDep"
 );
 export const NetworkDown = createCustomErrorClass("NetworkDown");
+export const NetworkError = createCustomErrorClass("NetworkError");
 export const NoAddressesFound = createCustomErrorClass("NoAddressesFound");
 export const NotEnoughBalance = createCustomErrorClass("NotEnoughBalance");
 export const NotEnoughBalanceToDelegate = createCustomErrorClass(
@@ -218,6 +221,8 @@ export const FirmwareOrAppUpdateRequired = createCustomErrorClass(
   "FirmwareOrAppUpdateRequired"
 );
 
+export const LanguageNotFound = createCustomErrorClass("LanguageNotFound");
+
 // db stuff, no need to translate
 export const NoDBPathGiven = createCustomErrorClass("NoDBPathGiven");
 export const DBWrongPassword = createCustomErrorClass("DBWrongPassword");
@@ -227,13 +232,17 @@ export const DBNotReset = createCustomErrorClass("DBNotReset");
  * TransportError is used for any generic transport errors.
  * e.g. Error thrown when data received by exchanges are incorrect or if exchanged failed to communicate with the device for various reason.
  */
-export function TransportError(message: string, id: string): void {
-  this.name = "TransportError";
-  this.message = message;
-  this.stack = new Error().stack;
-  this.id = id;
+export class TransportError extends Error {
+  id: string;
+  constructor(message: string, id: string) {
+    const name = "TransportError";
+    super(message || name);
+    this.name = name;
+    this.message = message;
+    this.stack = new Error().stack;
+    this.id = id;
+  }
 }
-TransportError.prototype = new Error();
 
 addCustomErrorDeserializer(
   "TransportError",