@bombillazo/error-x 0.4.1 → 0.4.3

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.
@@ -534,7 +533,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * ### 1. Use Preset Directly
  * Create an error with all preset values:
  * ```typescript
- * throw new ErrorX(http.notFound)
+ * throw new ErrorX(http[404])
  * // Result: 404 error with message "Not found.", code, name, uiMessage, and type
  * ```
  *
@@ -542,7 +541,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * Customize the error while keeping other preset values:
  * ```typescript
  * throw new ErrorX({
- *   ...http.notFound,
+ *   ...http[404],
  *   message: 'User not found',
  *   metadata: { userId: 123 }
  * })
@@ -553,7 +552,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * Enhance presets with additional context:
  * ```typescript
  * throw new ErrorX({
- *   ...http.unauthorized,
+ *   ...http[401],
  *   metadata: { attemptedAction: 'viewProfile', userId: 456 }
  * })
  * ```
@@ -565,7 +564,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  *   // some operation
  * } catch (originalError) {
  *   throw new ErrorX({
- *     ...http.internalServerError,
+ *     ...http[500],
  *     cause: originalError,
  *     metadata: { operation: 'database-query' }
  *   })
@@ -575,21 +574,21 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * ## Common HTTP Presets
  *
  * ### 4xx Client Errors
- * - `badRequest` (400) - Invalid request data
- * - `unauthorized` (401) - Authentication required
- * - `forbidden` (403) - Insufficient permissions
- * - `notFound` (404) - Resource not found
- * - `methodNotAllowed` (405) - HTTP method not allowed
- * - `conflict` (409) - Resource conflict
- * - `unprocessableEntity` (422) - Validation failed
- * - `tooManyRequests` (429) - Rate limit exceeded
+ * - `400` - Bad Request - Invalid request data
+ * - `401` - Unauthorized - Authentication required
+ * - `403` - Forbidden - Insufficient permissions
+ * - `404` - Not Found - Resource not found
+ * - `405` - Method Not Allowed - HTTP method not allowed
+ * - `409` - Conflict - Resource conflict
+ * - `422` - Unprocessable Entity - Validation failed
+ * - `429` - Too Many Requests - Rate limit exceeded
  *
  * ### 5xx Server Errors
- * - `internalServerError` (500) - Unexpected server error
- * - `notImplemented` (501) - Feature not implemented
- * - `badGateway` (502) - Upstream server error
- * - `serviceUnavailable` (503) - Service temporarily down
- * - `gatewayTimeout` (504) - Upstream timeout
+ * - `500` - Internal Server Error - Unexpected server error
+ * - `501` - Not Implemented - Feature not implemented
+ * - `502` - Bad Gateway - Upstream server error
+ * - `503` - Service Unavailable - Service temporarily down
+ * - `504` - Gateway Timeout - Upstream timeout
  *
  * @example
  * ```typescript
@@ -599,7 +598,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  *
  *   if (!user) {
  *     throw new ErrorX({
- *       ...http.notFound,
+ *       ...http[404],
  *       message: 'User not found',
  *       metadata: { userId: req.params.id }
  *     })
@@ -611,7 +610,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * // Authentication middleware example
  * const requireAuth = (req, res, next) => {
  *   if (!req.user) {
- *     throw new ErrorX(http.unauthorized)
+ *     throw new ErrorX(http[401])
  *   }
  *   next()
  * }
@@ -619,7 +618,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * // Rate limiting example
  * if (isRateLimited(req.ip)) {
  *   throw new ErrorX({
- *     ...http.tooManyRequests,
+ *     ...http[429],
  *     metadata: {
  *       ip: req.ip,
  *       retryAfter: 60
@@ -631,7 +630,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
  * @public
  */
 declare const http: {
-    readonly badRequest: {
+    readonly 400: {
         httpStatus: number;
         code: string;
         name: string;
@@ -639,7 +638,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unauthorized: {
+    readonly 401: {
         httpStatus: number;
         code: string;
         name: string;
@@ -647,7 +646,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly paymentRequired: {
+    readonly 402: {
         httpStatus: number;
         code: string;
         name: string;
@@ -655,7 +654,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly forbidden: {
+    readonly 403: {
         httpStatus: number;
         code: string;
         name: string;
@@ -663,7 +662,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notFound: {
+    readonly 404: {
         httpStatus: number;
         code: string;
         name: string;
@@ -671,7 +670,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly methodNotAllowed: {
+    readonly 405: {
         httpStatus: number;
         code: string;
         name: string;
@@ -679,7 +678,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notAcceptable: {
+    readonly 406: {
         httpStatus: number;
         code: string;
         name: string;
@@ -687,7 +686,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly proxyAuthenticationRequired: {
+    readonly 407: {
         httpStatus: number;
         code: string;
         name: string;
@@ -695,7 +694,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly requestTimeout: {
+    readonly 408: {
         httpStatus: number;
         code: string;
         name: string;
@@ -703,7 +702,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly conflict: {
+    readonly 409: {
         httpStatus: number;
         code: string;
         name: string;
@@ -711,7 +710,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly gone: {
+    readonly 410: {
         httpStatus: number;
         code: string;
         name: string;
@@ -719,7 +718,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly lengthRequired: {
+    readonly 411: {
         httpStatus: number;
         code: string;
         name: string;
@@ -727,7 +726,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly preconditionFailed: {
+    readonly 412: {
         httpStatus: number;
         code: string;
         name: string;
@@ -735,7 +734,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly payloadTooLarge: {
+    readonly 413: {
         httpStatus: number;
         code: string;
         name: string;
@@ -743,7 +742,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly uriTooLong: {
+    readonly 414: {
         httpStatus: number;
         code: string;
         name: string;
@@ -751,7 +750,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unsupportedMediaType: {
+    readonly 415: {
         httpStatus: number;
         code: string;
         name: string;
@@ -759,7 +758,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly rangeNotSatisfiable: {
+    readonly 416: {
         httpStatus: number;
         code: string;
         name: string;
@@ -767,7 +766,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly expectationFailed: {
+    readonly 417: {
         httpStatus: number;
         code: string;
         name: string;
@@ -775,7 +774,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly imATeapot: {
+    readonly 418: {
         httpStatus: number;
         code: string;
         name: string;
@@ -783,7 +782,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unprocessableEntity: {
+    readonly 422: {
         httpStatus: number;
         code: string;
         name: string;
@@ -791,7 +790,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly locked: {
+    readonly 423: {
         httpStatus: number;
         code: string;
         name: string;
@@ -799,7 +798,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly failedDependency: {
+    readonly 424: {
         httpStatus: number;
         code: string;
         name: string;
@@ -807,7 +806,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly tooEarly: {
+    readonly 425: {
         httpStatus: number;
         code: string;
         name: string;
@@ -815,7 +814,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly upgradeRequired: {
+    readonly 426: {
         httpStatus: number;
         code: string;
         name: string;
@@ -823,7 +822,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly preconditionRequired: {
+    readonly 428: {
         httpStatus: number;
         code: string;
         name: string;
@@ -831,7 +830,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly tooManyRequests: {
+    readonly 429: {
         httpStatus: number;
         code: string;
         name: string;
@@ -839,7 +838,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly requestHeaderFieldsTooLarge: {
+    readonly 431: {
         httpStatus: number;
         code: string;
         name: string;
@@ -847,7 +846,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unavailableForLegalReasons: {
+    readonly 451: {
         httpStatus: number;
         code: string;
         name: string;
@@ -855,7 +854,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly internalServerError: {
+    readonly 500: {
         httpStatus: number;
         code: string;
         name: string;
@@ -863,7 +862,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notImplemented: {
+    readonly 501: {
         httpStatus: number;
         code: string;
         name: string;
@@ -871,7 +870,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly badGateway: {
+    readonly 502: {
         httpStatus: number;
         code: string;
         name: string;
@@ -879,7 +878,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly serviceUnavailable: {
+    readonly 503: {
         httpStatus: number;
         code: string;
         name: string;
@@ -887,7 +886,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly gatewayTimeout: {
+    readonly 504: {
         httpStatus: number;
         code: string;
         name: string;
@@ -895,7 +894,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly httpVersionNotSupported: {
+    readonly 505: {
         httpStatus: number;
         code: string;
         name: string;
@@ -903,7 +902,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly variantAlsoNegotiates: {
+    readonly 506: {
         httpStatus: number;
         code: string;
         name: string;
@@ -911,7 +910,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly insufficientStorage: {
+    readonly 507: {
         httpStatus: number;
         code: string;
         name: string;
@@ -919,7 +918,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly loopDetected: {
+    readonly 508: {
         httpStatus: number;
         code: string;
         name: string;
@@ -927,7 +926,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notExtended: {
+    readonly 510: {
         httpStatus: number;
         code: string;
         name: string;
@@ -935,7 +934,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly networkAuthenticationRequired: {
+    readonly 511: {
         httpStatus: number;
         code: string;
         name: string;