@exodus/errors 1.3.0 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/errors@1.3.0...@exodus/errors@2.0.0) (2025-02-26)
+
+### ⚠ BREAKING CHANGES
+
+- **errors:** SafeError returns stack trace in the text format (#11581)
+
+### Features
+
+- feat(errors)!: SafeError returns stack trace in the text format (#11581)
+
 ## [1.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/errors@1.2.0...@exodus/errors@1.3.0) (2025-02-17)
 
 ### Features

package/lib/safe-error.d.ts

@@ -2,16 +2,16 @@ import type { Frame } from './types.js';
 type ReadonlySetValues<S> = S extends ReadonlySet<infer T> ? T : never;
 declare const SAFE_NAMES_SET: ReadonlySet<"Error" | "AssertionError" | "TypeError" | "RangeError" | "UnknownError" | "SafeErrorFailedToParse" | "TimeoutError">;
 declare const SAFE_HINTS_SET: ReadonlySet<"broadcastTx" | "otherErr:broadcastTx" | "retry:broadcastTx" | "getNftArguments" | "ethCall" | "ethCall:executionReverted" | "failed to parse error">;
-type SafeName = ReadonlySetValues<typeof SAFE_NAMES_SET>;
-type SafeHint = ReadonlySetValues<typeof SAFE_HINTS_SET>;
-type SafeCode = string & {
+export type SafeName = ReadonlySetValues<typeof SAFE_NAMES_SET>;
+export type SafeHint = ReadonlySetValues<typeof SAFE_HINTS_SET>;
+export type SafeCode = string & {
     __branded_type: 'SafeCodeOutcome';
 };
 type UnknownError = Error & {
     hint?: unknown;
     code?: unknown;
 };
-declare const FACTORY_SYMBOL: unique symbol;
+export declare const FACTORY_SYMBOL: unique symbol;
 export declare class SafeError {
     #private;
     static readonly hints: {
@@ -47,24 +47,10 @@ export declare class SafeError {
         in_app?: boolean | null;
         __proto__: null;
     }[] | undefined;
+    get stack(): string | undefined;
     get timestamp(): number;
     toJSON(): {
-        __proto__: null;
-        name: "Error" | "AssertionError" | "TypeError" | "RangeError" | "UnknownError" | "SafeErrorFailedToParse" | "TimeoutError";
-        code: SafeCode | undefined;
-        hint: "broadcastTx" | "otherErr:broadcastTx" | "retry:broadcastTx" | "getNftArguments" | "ethCall" | "ethCall:executionReverted" | "failed to parse error" | undefined;
-        stackFrames: {
-            function?: string | null;
-            method?: string | null;
-            file?: string | null;
-            line?: number | null;
-            column?: number | null;
-            async?: boolean | null;
-            toplevel?: boolean | null;
-            in_app?: boolean | null;
-            __proto__: null;
-        }[] | undefined;
-        timestamp: number;
+        [k: string]: any;
     };
     constructor({ name, code, hint, stack, initSymbol, }: {
         name: SafeName;

package/lib/safe-error.js

@@ -1,5 +1,6 @@
 import assert from 'minimalistic-assert';
-import parseStackTraceNatively from './stack.js';
+import parseStackTraceNatively, { stackFramesToString } from './stack.js';
+import { omitUndefined } from './utils.js';
 function makeReadonlySet(values) {
     return new Set(values);
 }
@@ -58,7 +59,7 @@ function isExodusErrorCode(code) {
 function isSafeCode(value) {
     return SAFE_CODES_SET.has(value) || isExodusErrorCode(value);
 }
-const FACTORY_SYMBOL = Symbol('SafeError');
+export const FACTORY_SYMBOL = Symbol('SafeError');
 export class SafeError {
     static hints = safeHints;
     static from(err) {
@@ -113,18 +114,24 @@ export class SafeError {
     get stackFrames() {
         return this.#stackFrames?.map((frame) => ({ __proto__: null, ...frame }));
     }
+    get stack() {
+        const stackTrace = stackFramesToString(this.stackFrames);
+        return stackTrace
+            ? `${this.name}: ${this.code || this.hint || 'unknownHint'}\n${stackTrace}`
+            : undefined;
+    }
     get timestamp() {
         return this.#timestamp;
     }
     toJSON() {
-        return {
+        return omitUndefined({
             __proto__: null,
             name: this.name,
             code: this.code,
             hint: this.hint,
-            stackFrames: this.stackFrames,
+            stack: this.stack,
             timestamp: this.timestamp,
-        };
+        });
     }
     constructor({ name, code, hint, stack, initSymbol, }) {
         assert(initSymbol === FACTORY_SYMBOL, 'SafeError: use SafeError.from()');

package/lib/stack.d.ts

@@ -1,2 +1,3 @@
 import type { Frame } from './types.js';
+export declare function stackFramesToString(frames?: Frame[]): string | undefined;
 export default function parseStackTraceNatively(err: Error): Frame[] | undefined;

package/lib/stack.js

@@ -1,3 +1,14 @@
+export function stackFramesToString(frames) {
+    if (frames === undefined) {
+        return;
+    }
+    return frames
+        .map((frame) => {
+        const { function: fn, method, file, line, column } = frame;
+        return `    at ${fn || 'unknownFn'}${method ? `.${method}` : ''}${file ? `(${file}${line === null ? '' : `:${line}:${column}`})` : ''}`;
+    })
+        .join('\n');
+}
 export default function parseStackTraceNatively(err) {
     const { prepareStackTrace } = Error;
     let stack;

package/lib/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const omitUndefined: (object: Record<string, any>) => {
+    [k: string]: any;
+};

package/lib/utils.js

@@ -0,0 +1 @@
+export const omitUndefined = (object) => Object.fromEntries(Object.entries(object).filter(([, value]) => value !== undefined));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/errors",
   "type": "module",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Utilities for error handling in client code, such as sanitization",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -44,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "114da97a6c05a44949b90563201467852e48f069"
+  "gitHead": "b5f5320ef9490bae4794356a815b2f8a376bbf03"
 }