@bombillazo/error-x 0.4.1 → 0.4.2

package/dist/index.d.cts

@@ -164,6 +164,11 @@ interface ErrorXConfig {
      * - string[]: Custom patterns to match and remove from stack traces
      */
     cleanStack?: boolean | string[];
+    /**
+     * Delimiter to trim stack traces after a specified line
+     * When set, stack traces will be trimmed to start after the first line containing this string
+     */
+    cleanStackDelimiter?: string;
 }
 /**
  * Enhanced Error class with rich metadata, type-safe error handling, and intelligent error conversion.
@@ -177,7 +182,8 @@ interface ErrorXConfig {
  *   docsMap: {
  *     'AUTH_FAILED': 'errors/authentication',
  *     'DB_ERROR': 'errors/database'
- *   }
+ *   },
+ *   cleanStackDelimiter: 'my-app-entry' // Clean stack traces after this line
  * })
  *
  * // Basic usage
@@ -286,7 +292,8 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      *   docsMap: {
      *     'AUTH_FAILED': 'authentication-errors',
      *     'DB_ERROR': 'database-errors'
-     *   }
+     *   },
+     *   cleanStackDelimiter: 'app-entry-point' // Trim stack traces after this line
      * })
      * ```
      */
@@ -296,6 +303,17 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      * Returns null if no configuration has been set.
      */
     static getConfig(): ErrorXConfig | null;
+    /**
+     * Reset global configuration to null.
+     * Useful for testing or when you want to clear all configuration.
+     *
+     * @example
+     * ```typescript
+     * ErrorX.resetConfig()
+     * const config = ErrorX.getConfig() // null
+     * ```
+     */
+    static resetConfig(): void;
     /**
      * Validates HTTP status code to ensure it's within valid range (100-599)
      *
@@ -343,28 +361,24 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      */
     private static preserveOriginalStackFromCause;
     /**
-     * Cleans the stack trace by removing ErrorX internal method calls.
+     * Cleans a stack trace by removing ErrorX internal method calls and optionally trimming after a delimiter.
      * This provides cleaner stack traces that focus on user code.
      *
-     * @param stack - Raw stack trace to clean
-     * @returns Cleaned stack trace without ErrorX internal calls
-     */
-    private static cleanStack;
-    /**
-     * Processes an error's stack trace to trim it after a specified delimiter.
-     * Useful for removing irrelevant stack frames before a specific function.
-     *
-     * @param error - Error whose stack to process
-     * @param delimiter - String to search for in stack lines
-     * @returns Processed stack trace starting after the delimiter
+     * @param stack - Raw stack trace string to clean
+     * @param delimiter - Optional delimiter to trim stack trace after (overrides config delimiter)
+     * @returns Cleaned stack trace without internal calls and optionally trimmed after delimiter
      *
      * @example
      * ```typescript
-     * const processed = ErrorX.processErrorStack(error, 'my-app-entry')
+     * // Clean with pattern-based removal only
+     * const cleaned = ErrorX.cleanStack(error.stack)
+     *
+     * // Clean and trim after delimiter
+     * const trimmed = ErrorX.cleanStack(error.stack, 'my-app-entry')
      * // Returns stack trace starting after the line containing 'my-app-entry'
      * ```
      */
-    private static processErrorStack;
+    static cleanStack(stack?: string, delimiter?: string): string;
     /**
      * Creates a new ErrorX instance with additional metadata merged with existing metadata.
      * The original error properties are preserved while extending the metadata.
@@ -444,21 +458,6 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
     static from(error: Error): ErrorX;
     static from(error: string): ErrorX;
     static from(error: unknown): ErrorX;
-    /**
-     * Creates a new ErrorX instance with cleaned stack trace using the specified delimiter.
-     * Returns the same instance if no delimiter is provided or no stack is available.
-     *
-     * @param delimiter - Optional string to search for in stack lines
-     * @returns New ErrorX instance with cleaned stack trace, or the same instance if no cleaning needed
-     *
-     * @example
-     * ```typescript
-     * const error = new ErrorX({ message: 'Database error' })
-     * const cleanedError = error.cleanStackTrace('database-layer')
-     * // Returns new ErrorX with stack trace starting after 'database-layer'
-     * ```
-     */
-    cleanStackTrace(delimiter?: string): ErrorX<TMetadata>;
     /**
      * Converts the ErrorX instance to a detailed string representation.
      * Includes error name, message, code, timestamp, metadata, and stack trace.

package/dist/index.d.ts

@@ -164,6 +164,11 @@ interface ErrorXConfig {
      * - string[]: Custom patterns to match and remove from stack traces
      */
     cleanStack?: boolean | string[];
+    /**
+     * Delimiter to trim stack traces after a specified line
+     * When set, stack traces will be trimmed to start after the first line containing this string
+     */
+    cleanStackDelimiter?: string;
 }
 /**
  * Enhanced Error class with rich metadata, type-safe error handling, and intelligent error conversion.
@@ -177,7 +182,8 @@ interface ErrorXConfig {
  *   docsMap: {
  *     'AUTH_FAILED': 'errors/authentication',
  *     'DB_ERROR': 'errors/database'
- *   }
+ *   },
+ *   cleanStackDelimiter: 'my-app-entry' // Clean stack traces after this line
  * })
  *
  * // Basic usage
@@ -286,7 +292,8 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      *   docsMap: {
      *     'AUTH_FAILED': 'authentication-errors',
      *     'DB_ERROR': 'database-errors'
-     *   }
+     *   },
+     *   cleanStackDelimiter: 'app-entry-point' // Trim stack traces after this line
      * })
      * ```
      */
@@ -296,6 +303,17 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      * Returns null if no configuration has been set.
      */
     static getConfig(): ErrorXConfig | null;
+    /**
+     * Reset global configuration to null.
+     * Useful for testing or when you want to clear all configuration.
+     *
+     * @example
+     * ```typescript
+     * ErrorX.resetConfig()
+     * const config = ErrorX.getConfig() // null
+     * ```
+     */
+    static resetConfig(): void;
     /**
      * Validates HTTP status code to ensure it's within valid range (100-599)
      *
@@ -343,28 +361,24 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      */
     private static preserveOriginalStackFromCause;
     /**
-     * Cleans the stack trace by removing ErrorX internal method calls.
+     * Cleans a stack trace by removing ErrorX internal method calls and optionally trimming after a delimiter.
      * This provides cleaner stack traces that focus on user code.
      *
-     * @param stack - Raw stack trace to clean
-     * @returns Cleaned stack trace without ErrorX internal calls
-     */
-    private static cleanStack;
-    /**
-     * Processes an error's stack trace to trim it after a specified delimiter.
-     * Useful for removing irrelevant stack frames before a specific function.
-     *
-     * @param error - Error whose stack to process
-     * @param delimiter - String to search for in stack lines
-     * @returns Processed stack trace starting after the delimiter
+     * @param stack - Raw stack trace string to clean
+     * @param delimiter - Optional delimiter to trim stack trace after (overrides config delimiter)
+     * @returns Cleaned stack trace without internal calls and optionally trimmed after delimiter
      *
      * @example
      * ```typescript
-     * const processed = ErrorX.processErrorStack(error, 'my-app-entry')
+     * // Clean with pattern-based removal only
+     * const cleaned = ErrorX.cleanStack(error.stack)
+     *
+     * // Clean and trim after delimiter
+     * const trimmed = ErrorX.cleanStack(error.stack, 'my-app-entry')
      * // Returns stack trace starting after the line containing 'my-app-entry'
      * ```
      */
-    private static processErrorStack;
+    static cleanStack(stack?: string, delimiter?: string): string;
     /**
      * Creates a new ErrorX instance with additional metadata merged with existing metadata.
      * The original error properties are preserved while extending the metadata.
@@ -444,21 +458,6 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
     static from(error: Error): ErrorX;
     static from(error: string): ErrorX;
     static from(error: unknown): ErrorX;
-    /**
-     * Creates a new ErrorX instance with cleaned stack trace using the specified delimiter.
-     * Returns the same instance if no delimiter is provided or no stack is available.
-     *
-     * @param delimiter - Optional string to search for in stack lines
-     * @returns New ErrorX instance with cleaned stack trace, or the same instance if no cleaning needed
-     *
-     * @example
-     * ```typescript
-     * const error = new ErrorX({ message: 'Database error' })
-     * const cleanedError = error.cleanStackTrace('database-layer')
-     * // Returns new ErrorX with stack trace starting after 'database-layer'
-     * ```
-     */
-    cleanStackTrace(delimiter?: string): ErrorX<TMetadata>;
     /**
      * Converts the ErrorX instance to a detailed string representation.
      * Includes error name, message, code, timestamp, metadata, and stack trace.

package/dist/index.js

@@ -175,7 +175,8 @@ var ErrorX = class _ErrorX extends Error {
    *   docsMap: {
    *     'AUTH_FAILED': 'authentication-errors',
    *     'DB_ERROR': 'database-errors'
-   *   }
+   *   },
+   *   cleanStackDelimiter: 'app-entry-point' // Trim stack traces after this line
    * })
    * ```
    */
@@ -189,6 +190,19 @@ var ErrorX = class _ErrorX extends Error {
   static getConfig() {
     return _ErrorX._config;
   }
+  /**
+   * Reset global configuration to null.
+   * Useful for testing or when you want to clear all configuration.
+   *
+   * @example
+   * ```typescript
+   * ErrorX.resetConfig()
+   * const config = ErrorX.getConfig() // null
+   * ```
+   */
+  static resetConfig() {
+    _ErrorX._config = null;
+  }
   /**
    * Validates HTTP status code to ensure it's within valid range (100-599)
    *
@@ -276,13 +290,24 @@ var ErrorX = class _ErrorX extends Error {
     return [newErrorFirstLine, ...originalStackTrace].join("\n");
   }
   /**
-   * Cleans the stack trace by removing ErrorX internal method calls.
+   * Cleans a stack trace by removing ErrorX internal method calls and optionally trimming after a delimiter.
    * This provides cleaner stack traces that focus on user code.
    *
-   * @param stack - Raw stack trace to clean
-   * @returns Cleaned stack trace without ErrorX internal calls
+   * @param stack - Raw stack trace string to clean
+   * @param delimiter - Optional delimiter to trim stack trace after (overrides config delimiter)
+   * @returns Cleaned stack trace without internal calls and optionally trimmed after delimiter
+   *
+   * @example
+   * ```typescript
+   * // Clean with pattern-based removal only
+   * const cleaned = ErrorX.cleanStack(error.stack)
+   *
+   * // Clean and trim after delimiter
+   * const trimmed = ErrorX.cleanStack(error.stack, 'my-app-entry')
+   * // Returns stack trace starting after the line containing 'my-app-entry'
+   * ```
    */
-  static cleanStack(stack) {
+  static cleanStack(stack, delimiter) {
     if (!stack) return "";
     const config = _ErrorX.getConfig();
     const cleanStackConfig = config?.cleanStack ?? true;
@@ -306,30 +331,15 @@ var ErrorX = class _ErrorX extends Error {
       }
       cleanedLines.push(line);
     }
-    return cleanedLines.join("\n");
-  }
-  /**
-   * Processes an error's stack trace to trim it after a specified delimiter.
-   * Useful for removing irrelevant stack frames before a specific function.
-   *
-   * @param error - Error whose stack to process
-   * @param delimiter - String to search for in stack lines
-   * @returns Processed stack trace starting after the delimiter
-   *
-   * @example
-   * ```typescript
-   * const processed = ErrorX.processErrorStack(error, 'my-app-entry')
-   * // Returns stack trace starting after the line containing 'my-app-entry'
-   * ```
-   */
-  static processErrorStack(error, delimiter) {
-    let stack = error.stack ?? "";
-    const stackLines = stack.split("\n");
-    const delimiterIndex = stackLines.findIndex((line) => line.includes(delimiter));
-    if (delimiterIndex !== -1) {
-      stack = stackLines.slice(delimiterIndex + 1).join("\n");
+    let cleanedStack = cleanedLines.join("\n");
+    const activeDelimiter = delimiter ?? config?.cleanStackDelimiter;
+    if (activeDelimiter) {
+      const delimiterIndex = cleanedLines.findIndex((line) => line.includes(activeDelimiter));
+      if (delimiterIndex !== -1) {
+        cleanedStack = cleanedLines.slice(delimiterIndex + 1).join("\n");
+      }
     }
-    return stack;
+    return cleanedStack;
   }
   /**
    * Creates a new ErrorX instance with additional metadata merged with existing metadata.
@@ -494,43 +504,6 @@ var ErrorX = class _ErrorX extends Error {
     const options = _ErrorX.convertUnknownToOptions(error);
     return new _ErrorX(options);
   }
-  /**
-   * Creates a new ErrorX instance with cleaned stack trace using the specified delimiter.
-   * Returns the same instance if no delimiter is provided or no stack is available.
-   *
-   * @param delimiter - Optional string to search for in stack lines
-   * @returns New ErrorX instance with cleaned stack trace, or the same instance if no cleaning needed
-   *
-   * @example
-   * ```typescript
-   * const error = new ErrorX({ message: 'Database error' })
-   * const cleanedError = error.cleanStackTrace('database-layer')
-   * // Returns new ErrorX with stack trace starting after 'database-layer'
-   * ```
-   */
-  cleanStackTrace(delimiter) {
-    if (delimiter && this.stack) {
-      const options = {
-        message: this.message,
-        name: this.name,
-        code: this.code,
-        uiMessage: this.uiMessage,
-        cause: this.cause,
-        httpStatus: this.httpStatus,
-        type: this.type,
-        sourceUrl: this.sourceUrl,
-        docsUrl: this.docsUrl,
-        source: this.source
-      };
-      if (this.metadata !== void 0) {
-        options.metadata = this.metadata;
-      }
-      const newError = new _ErrorX(options);
-      newError.stack = _ErrorX.processErrorStack(this, delimiter);
-      return newError;
-    }
-    return this;
-  }
   /**
    * Converts the ErrorX instance to a detailed string representation.
    * Includes error name, message, code, timestamp, metadata, and stack trace.