@bombillazo/error-x 0.4.1 → 0.4.3

package/README.md

@@ -36,7 +36,6 @@ yarn add @bombillazo/error-x
 
 This library uses modern JavaScript features and ES2022 APIs. For browser compatibility, ensure your build tool (e.g., Vite, webpack, esbuild) is configured to target ES2022 or transpile accordingly.
 
-
 > [!WARNING]
 >
 > This library is currently in pre-v1.0 development. While we strive to minimize breaking changes, the API may evolve based on feedback and real-world usage. We recommend pinning to specific versions and reviewing release notes when updating.
@@ -64,11 +63,11 @@ throw new ErrorX({
 })
 
 // Using HTTP presets
-throw new ErrorX(http.notFound)
+throw new ErrorX(http[404])
 
 // Customizing presets
 throw new ErrorX({
-  ...http.unauthorized,
+  ...http[401],
   message: 'Session expired',
   metadata: { userId: 123 }
 })
@@ -116,12 +115,12 @@ ErrorX provides pre-configured error templates via the `http` export:
 import { ErrorX, http } from '@bombillazo/error-x'
 
 // Use preset directly
-throw new ErrorX(http.notFound)
+throw new ErrorX(http[404])
 // Result: 404 error with message "Not found.", code "NOT_FOUND", etc.
 
 // Override specific fields
 throw new ErrorX({
-  ...http.notFound,
+  ...http[404],
   message: 'User not found',
   metadata: { userId: 123 }
 })
@@ -131,7 +130,7 @@ try {
   // some operation
 } catch (originalError) {
   throw new ErrorX({
-    ...http.internalServerError,
+    ...http[500],
     cause: originalError,
     metadata: { operation: 'database-query' }
   })
@@ -140,7 +139,7 @@ try {
 
 #### Available Presets
 
-All presets use **camelCase naming** and include:
+All presets are indexed by **HTTP status code** (numeric keys) and include:
 - `httpStatus`: HTTP status code
 - `code`: Error code in UPPER_SNAKE_CASE
 - `name`: Descriptive error name
@@ -149,10 +148,11 @@ All presets use **camelCase naming** and include:
 - `type`: Set to `'http'` for all HTTP presets
 
 **4xx Client Errors:**
-`badRequest`, `unauthorized`, `paymentRequired`, `forbidden`, `notFound`, `methodNotAllowed`, `notAcceptable`, `proxyAuthenticationRequired`, `requestTimeout`, `conflict`, `gone`, `lengthRequired`, `preconditionFailed`, `payloadTooLarge`, `uriTooLong`, `unsupportedMediaType`, `rangeNotSatisfiable`, `expectationFailed`, `imATeapot`, `unprocessableEntity`, `locked`, `failedDependency`, `tooEarly`, `upgradeRequired`, `preconditionRequired`, `tooManyRequests`, `requestHeaderFieldsTooLarge`, `unavailableForLegalReasons`
+
+`400`, `401`, `402`, `403`, `404`, `405`, `406`, `407`, `408`, `409`, `410`, `411`, `412`, `413`, `414`, `415`, `416`, `417`, `418`, `422`, `423`, `424`, `425`, `426`, `428`, `429`, `431`, `451`
 
 **5xx Server Errors:**
-`internalServerError`, `notImplemented`, `badGateway`, `serviceUnavailable`, `gatewayTimeout`, `httpVersionNotSupported`, `variantAlsoNegotiates`, `insufficientStorage`, `loopDetected`, `notExtended`, `networkAuthenticationRequired`
+`500`, `501`, `502`, `503`, `504`, `505`, `506`, `507`, `508`, `510`, `511`
 
 #### Creating Your Own Presets
 
@@ -281,14 +281,19 @@ const enriched = error.withMetadata({ b: 2 })
 // enriched.metadata = { a: 1, b: 2 }
 ```
 
-#### `cleanStackTrace(delimiter?: string): ErrorX`
+#### `ErrorX.cleanStack(stack?: string, delimiter?: string): string`
 
-Removes stack trace lines before a delimiter:
+Cleans a stack trace by removing ErrorX internal calls and optionally trimming after a delimiter:
 
 ```typescript
 const error = new ErrorX('test')
-const cleaned = error.cleanStackTrace('my-app-boundary')
-// Stack trace only includes lines after 'my-app-boundary'
+
+// 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-boundary')
+// Returns stack trace starting after the line containing 'my-app-boundary'
 ```
 
 #### `toJSON(): ErrorXSerialized`
@@ -339,7 +344,7 @@ async function fetchUser(id: string) {
     const response = await fetch(`/api/users/${id}`)
     if (!response.ok) {
       throw new ErrorX({
-        ...http[response.status === 404 ? 'notFound' : 'internalServerError'],
+        ...http[response.status === 404 ? 404 : 500],
         metadata: { status: response.status, statusText: response.statusText }
       })
     }

package/dist/index.cjs

@@ -181,7 +181,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
    * })
    * ```
    */
@@ -195,6 +196,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)
    *
@@ -282,13 +296,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;
@@ -312,30 +337,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.
@@ -500,43 +510,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.
@@ -678,7 +651,7 @@ ${this.stack}`;
 // src/presets.ts
 var http = {
   // 4xx Client Errors
-  badRequest: {
+  400: {
     httpStatus: 400,
     code: "BAD_REQUEST",
     name: "Bad Request Error",
@@ -686,7 +659,7 @@ var http = {
     uiMessage: "The request could not be processed. Please check your input and try again.",
     type: "http"
   },
-  unauthorized: {
+  401: {
     httpStatus: 401,
     code: "UNAUTHORIZED",
     name: "Unauthorized Error",
@@ -694,7 +667,7 @@ var http = {
     uiMessage: "Authentication required. Please log in to continue.",
     type: "http"
   },
-  paymentRequired: {
+  402: {
     httpStatus: 402,
     code: "PAYMENT_REQUIRED",
     name: "Payment Required Error",
@@ -702,7 +675,7 @@ var http = {
     uiMessage: "Payment is required to access this resource.",
     type: "http"
   },
-  forbidden: {
+  403: {
     httpStatus: 403,
     code: "FORBIDDEN",
     name: "Forbidden Error",
@@ -710,7 +683,7 @@ var http = {
     uiMessage: "You do not have permission to access this resource.",
     type: "http"
   },
-  notFound: {
+  404: {
     httpStatus: 404,
     code: "NOT_FOUND",
     name: "Not Found Error",
@@ -718,7 +691,7 @@ var http = {
     uiMessage: "The requested resource could not be found.",
     type: "http"
   },
-  methodNotAllowed: {
+  405: {
     httpStatus: 405,
     code: "METHOD_NOT_ALLOWED",
     name: "Method Not Allowed Error",
@@ -726,7 +699,7 @@ var http = {
     uiMessage: "This action is not allowed for the requested resource.",
     type: "http"
   },
-  notAcceptable: {
+  406: {
     httpStatus: 406,
     code: "NOT_ACCEPTABLE",
     name: "Not Acceptable Error",
@@ -734,7 +707,7 @@ var http = {
     uiMessage: "The requested format is not supported.",
     type: "http"
   },
-  proxyAuthenticationRequired: {
+  407: {
     httpStatus: 407,
     code: "PROXY_AUTHENTICATION_REQUIRED",
     name: "Proxy Authentication Required Error",
@@ -742,7 +715,7 @@ var http = {
     uiMessage: "Proxy authentication is required to access this resource.",
     type: "http"
   },
-  requestTimeout: {
+  408: {
     httpStatus: 408,
     code: "REQUEST_TIMEOUT",
     name: "Request Timeout Error",
@@ -750,7 +723,7 @@ var http = {
     uiMessage: "The request took too long to complete. Please try again.",
     type: "http"
   },
-  conflict: {
+  409: {
     httpStatus: 409,
     code: "CONFLICT",
     name: "Conflict Error",
@@ -758,7 +731,7 @@ var http = {
     uiMessage: "The request conflicts with the current state. Please refresh and try again.",
     type: "http"
   },
-  gone: {
+  410: {
     httpStatus: 410,
     code: "GONE",
     name: "Gone Error",
@@ -766,7 +739,7 @@ var http = {
     uiMessage: "This resource is no longer available.",
     type: "http"
   },
-  lengthRequired: {
+  411: {
     httpStatus: 411,
     code: "LENGTH_REQUIRED",
     name: "Length Required Error",
@@ -774,7 +747,7 @@ var http = {
     uiMessage: "The request is missing required length information.",
     type: "http"
   },
-  preconditionFailed: {
+  412: {
     httpStatus: 412,
     code: "PRECONDITION_FAILED",
     name: "Precondition Failed Error",
@@ -782,7 +755,7 @@ var http = {
     uiMessage: "A required condition was not met. Please try again.",
     type: "http"
   },
-  payloadTooLarge: {
+  413: {
     httpStatus: 413,
     code: "PAYLOAD_TOO_LARGE",
     name: "Payload Too Large Error",
@@ -790,7 +763,7 @@ var http = {
     uiMessage: "The request is too large. Please reduce the size and try again.",
     type: "http"
   },
-  uriTooLong: {
+  414: {
     httpStatus: 414,
     code: "URI_TOO_LONG",
     name: "URI Too Long Error",
@@ -798,7 +771,7 @@ var http = {
     uiMessage: "The request URL is too long.",
     type: "http"
   },
-  unsupportedMediaType: {
+  415: {
     httpStatus: 415,
     code: "UNSUPPORTED_MEDIA_TYPE",
     name: "Unsupported Media Type Error",
@@ -806,7 +779,7 @@ var http = {
     uiMessage: "The file type is not supported.",
     type: "http"
   },
-  rangeNotSatisfiable: {
+  416: {
     httpStatus: 416,
     code: "RANGE_NOT_SATISFIABLE",
     name: "Range Not Satisfiable Error",
@@ -814,7 +787,7 @@ var http = {
     uiMessage: "The requested range cannot be satisfied.",
     type: "http"
   },
-  expectationFailed: {
+  417: {
     httpStatus: 417,
     code: "EXPECTATION_FAILED",
     name: "Expectation Failed Error",
@@ -822,7 +795,7 @@ var http = {
     uiMessage: "The server cannot meet the requirements of the request.",
     type: "http"
   },
-  imATeapot: {
+  418: {
     httpStatus: 418,
     code: "IM_A_TEAPOT",
     name: "Im A Teapot Error",
@@ -830,7 +803,7 @@ var http = {
     uiMessage: "I'm a teapot and cannot brew coffee.",
     type: "http"
   },
-  unprocessableEntity: {
+  422: {
     httpStatus: 422,
     code: "UNPROCESSABLE_ENTITY",
     name: "Unprocessable Entity Error",
@@ -838,7 +811,7 @@ var http = {
     uiMessage: "The request contains invalid data. Please check your input.",
     type: "http"
   },
-  locked: {
+  423: {
     httpStatus: 423,
     code: "LOCKED",
     name: "Locked Error",
@@ -846,7 +819,7 @@ var http = {
     uiMessage: "This resource is locked and cannot be modified.",
     type: "http"
   },
-  failedDependency: {
+  424: {
     httpStatus: 424,
     code: "FAILED_DEPENDENCY",
     name: "Failed Dependency Error",
@@ -854,7 +827,7 @@ var http = {
     uiMessage: "The request failed due to a dependency error.",
     type: "http"
   },
-  tooEarly: {
+  425: {
     httpStatus: 425,
     code: "TOO_EARLY",
     name: "Too Early Error",
@@ -862,7 +835,7 @@ var http = {
     uiMessage: "The request was sent too early. Please try again later.",
     type: "http"
   },
-  upgradeRequired: {
+  426: {
     httpStatus: 426,
     code: "UPGRADE_REQUIRED",
     name: "Upgrade Required Error",
@@ -870,7 +843,7 @@ var http = {
     uiMessage: "Please upgrade to continue using this service.",
     type: "http"
   },
-  preconditionRequired: {
+  428: {
     httpStatus: 428,
     code: "PRECONDITION_REQUIRED",
     name: "Precondition Required Error",
@@ -878,7 +851,7 @@ var http = {
     uiMessage: "Required conditions are missing from the request.",
     type: "http"
   },
-  tooManyRequests: {
+  429: {
     httpStatus: 429,
     code: "TOO_MANY_REQUESTS",
     name: "Too Many Requests Error",
@@ -886,7 +859,7 @@ var http = {
     uiMessage: "You have made too many requests. Please wait and try again.",
     type: "http"
   },
-  requestHeaderFieldsTooLarge: {
+  431: {
     httpStatus: 431,
     code: "REQUEST_HEADER_FIELDS_TOO_LARGE",
     name: "Request Header Fields Too Large Error",
@@ -894,7 +867,7 @@ var http = {
     uiMessage: "The request headers are too large.",
     type: "http"
   },
-  unavailableForLegalReasons: {
+  451: {
     httpStatus: 451,
     code: "UNAVAILABLE_FOR_LEGAL_REASONS",
     name: "Unavailable For Legal Reasons Error",
@@ -903,7 +876,7 @@ var http = {
     type: "http"
   },
   // 5xx Server Errors
-  internalServerError: {
+  500: {
     httpStatus: 500,
     code: "INTERNAL_SERVER_ERROR",
     name: "Internal Server Error",
@@ -911,7 +884,7 @@ var http = {
     uiMessage: "An unexpected error occurred. Please try again later.",
     type: "http"
   },
-  notImplemented: {
+  501: {
     httpStatus: 501,
     code: "NOT_IMPLEMENTED",
     name: "Not Implemented Error",
@@ -919,7 +892,7 @@ var http = {
     uiMessage: "This feature is not yet available.",
     type: "http"
   },
-  badGateway: {
+  502: {
     httpStatus: 502,
     code: "BAD_GATEWAY",
     name: "Bad Gateway Error",
@@ -927,7 +900,7 @@ var http = {
     uiMessage: "Unable to connect to the server. Please try again later.",
     type: "http"
   },
-  serviceUnavailable: {
+  503: {
     httpStatus: 503,
     code: "SERVICE_UNAVAILABLE",
     name: "Service Unavailable Error",
@@ -935,7 +908,7 @@ var http = {
     uiMessage: "The service is temporarily unavailable. Please try again later.",
     type: "http"
   },
-  gatewayTimeout: {
+  504: {
     httpStatus: 504,
     code: "GATEWAY_TIMEOUT",
     name: "Gateway Timeout Error",
@@ -943,7 +916,7 @@ var http = {
     uiMessage: "The server took too long to respond. Please try again.",
     type: "http"
   },
-  httpVersionNotSupported: {
+  505: {
     httpStatus: 505,
     code: "HTTP_VERSION_NOT_SUPPORTED",
     name: "HTTP Version Not Supported Error",
@@ -951,7 +924,7 @@ var http = {
     uiMessage: "Your browser version is not supported.",
     type: "http"
   },
-  variantAlsoNegotiates: {
+  506: {
     httpStatus: 506,
     code: "VARIANT_ALSO_NEGOTIATES",
     name: "Variant Also Negotiates Error",
@@ -959,7 +932,7 @@ var http = {
     uiMessage: "The server has an internal configuration error.",
     type: "http"
   },
-  insufficientStorage: {
+  507: {
     httpStatus: 507,
     code: "INSUFFICIENT_STORAGE",
     name: "Insufficient Storage Error",
@@ -967,7 +940,7 @@ var http = {
     uiMessage: "The server has insufficient storage to complete the request.",
     type: "http"
   },
-  loopDetected: {
+  508: {
     httpStatus: 508,
     code: "LOOP_DETECTED",
     name: "Loop Detected Error",
@@ -975,7 +948,7 @@ var http = {
     uiMessage: "The server detected an infinite loop.",
     type: "http"
   },
-  notExtended: {
+  510: {
     httpStatus: 510,
     code: "NOT_EXTENDED",
     name: "Not Extended Error",
@@ -983,7 +956,7 @@ var http = {
     uiMessage: "Additional extensions are required.",
     type: "http"
   },
-  networkAuthenticationRequired: {
+  511: {
     httpStatus: 511,
     code: "NETWORK_AUTHENTICATION_REQUIRED",
     name: "Network Authentication Required Error",