feat: support native ES Error (#325)

* chore: updates from devScripts

* fix(deps): bump deps

* fix: fallback text for template literal

* fix: widen error type to support native Error.cause

* refactor: use native format for stack/cause recursion

* fix: use inspect

---------

Co-authored-by: mshanemc <shane.mclaughlin@salesforce.com>

Author: svc-cli-bot

package.json

@@ -29,13 +29,13 @@
     "test:only": "wireit"
   },
   "dependencies": {
-    "@salesforce/ts-types": "^2.0.10"
+    "@salesforce/ts-types": "^2.0.11"
   },
   "devDependencies": {
-    "@salesforce/dev-scripts": "^10.2.2",
+    "@salesforce/dev-scripts": "^10.2.5",
     "lodash-cli": "^4.17.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.4"
   },
   "wireit": {
     "build": {

src/errors.ts

@@ -4,15 +4,18 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-
+import { inspect } from 'node:util';
 /**
  * Any `Error` compatible with the `NamedError` type signature.
  */
-type NamedErrorLike = Error & {
-  readonly name: string;
-  readonly cause?: NamedErrorLike;
-  readonly fullStack?: string;
-};
+type NamedErrorLike =
+  | Error
+  | NamedError
+  | {
+      readonly name: string;
+      readonly cause?: NamedErrorLike;
+      readonly fullStack?: string;
+    };
 
 export class NamedError extends Error {
   public readonly name: string;
@@ -32,12 +35,7 @@ export class NamedError extends Error {
   }
 
   public get fullStack(): string | undefined {
-    let stack = this.stack;
-    const causedStack = this.cause?.fullStack ?? this.cause?.stack;
-    if (causedStack) {
-      stack = `${stack ? stack + '\n' : ''}Caused by: ${causedStack}`;
-    }
-    return stack;
+    return inspect(this);
   }
 }
 

src/throttledPromiseAll.ts

@@ -167,7 +167,7 @@ export class ThrottledPromiseAll<T, O = T> {
       const r = await Promise.race(concurrencyPool.values());
       const rIndex = r?.index ?? -1;
       if (!concurrencyPool.has(rIndex)) {
-        throw new Error(`PromiseQueue: Could not find index ${r?.index} in pool`);
+        throw new Error(`PromiseQueue: Could not find index ${r?.index ?? '<undefined>'} in pool`);
       }
       concurrencyPool.delete(rIndex);
       this.#results.push(r);

test/errors.test.ts

@@ -20,16 +20,16 @@ describe('NamedError', () => {
     const three = new NamedError('ThreeError', two);
     three.stack = `${three.name}:\n    at test:3:1`;
 
-    expect(three.fullStack).to.equal(
-      `ThreeError:
-    at test:3:1
-Caused by: TwoError: message two
-    at test:2:1
-Caused by: OneError:
-    at test:1:1
-Caused by: Error: message zero
-    at test:0:1`
-    );
+    [
+      'NamedError [ThreeError]',
+      'at test:3:1',
+      'cause: NamedError [TwoError]: message two',
+      'at test:2:1',
+      'cause: NamedError [OneError]',
+      'at test:1:1',
+      'cause: Error: message zero',
+      'at test:0:1',
+    ].map((line) => expect(three.fullStack).to.contain(line));
   });
 });