@bombillazo/error-x 0.4.2 → 0.4.4

package/dist/index.d.ts

@@ -102,7 +102,7 @@ type ErrorXCause = {
  *   uiMessage: 'Please check your credentials',
  *   stack: 'Error: Authentication failed.\n    at login (auth.ts:42:15)',
  *   metadata: { userId: 123, loginAttempt: 3 },
- *   timestamp: '2024-01-15T10:30:45.123Z',
+ *   timestamp: 1705315845123,
  *   cause: {
  *     name: 'NetworkError',
  *     message: 'Request timeout.',
@@ -129,8 +129,8 @@ type ErrorXSerialized = {
     stack?: string;
     /** Additional context and debugging information */
     metadata: ErrorXMetadata | undefined;
-    /** ISO timestamp when error was created */
-    timestamp: string;
+    /** Unix epoch timestamp (milliseconds) when error was created */
+    timestamp: number;
     /** Simplified cause error (for error chaining) */
     cause?: ErrorXCause;
     /** HTTP status code for HTTP-related errors */
@@ -218,8 +218,8 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
     uiMessage: string | undefined;
     /** Additional context and metadata associated with the error */
     metadata: TMetadata | undefined;
-    /** Timestamp when the error was created */
-    timestamp: Date;
+    /** Unix epoch timestamp (milliseconds) when the error was created */
+    timestamp: number;
     /** HTTP status code (100-599) for HTTP-related errors */
     httpStatus: number | undefined;
     /** Error type for categorization */
@@ -400,7 +400,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      * // Result: metadata = { endpoint: '/users', retryCount: 3, userId: 123 }
      * ```
      */
-    withMetadata(additionalMetadata: Partial<TMetadata>): ErrorX<TMetadata>;
+    withMetadata<TAdditionalMetadata extends Record<string, unknown> = ErrorXMetadata>(additionalMetadata: TAdditionalMetadata): ErrorX<TMetadata & TAdditionalMetadata>;
     /**
      * Type guard that checks if a value is an ErrorX instance.
      *
@@ -474,7 +474,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      * })
      *
      * console.log(error.toString())
-     * // Output: "DatabaseError: Database connection failed. [DB_CONN_FAILED] (2024-01-15T10:30:45.123Z) metadata: {...}"
+     * // Output: "DatabaseError: Database connection failed. [DB_CONN_FAILED] 2025-01-15T10:30:45.123Z (1736937045123) metadata: {...}"
      * ```
      */
     toString(): string;
@@ -512,7 +512,7 @@ declare class ErrorX<TMetadata extends ErrorXMetadata = ErrorXMetadata> extends
      *   code: 'DB_CONN_FAILED',
      *   uiMessage: 'Database is temporarily unavailable',
      *   metadata: { host: 'localhost' },
-     *   timestamp: '2024-01-15T10:30:45.123Z'
+     *   timestamp: 1705315845123
      * }
      *
      * const error = ErrorX.fromJSON(serializedError)
@@ -533,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
  * ```
  *
@@ -541,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 }
  * })
@@ -552,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 }
  * })
  * ```
@@ -564,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' }
  *   })
@@ -574,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
@@ -598,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 }
  *     })
@@ -610,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()
  * }
@@ -618,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
@@ -630,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;
@@ -638,7 +638,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unauthorized: {
+    readonly 401: {
         httpStatus: number;
         code: string;
         name: string;
@@ -646,7 +646,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly paymentRequired: {
+    readonly 402: {
         httpStatus: number;
         code: string;
         name: string;
@@ -654,7 +654,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly forbidden: {
+    readonly 403: {
         httpStatus: number;
         code: string;
         name: string;
@@ -662,7 +662,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notFound: {
+    readonly 404: {
         httpStatus: number;
         code: string;
         name: string;
@@ -670,7 +670,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly methodNotAllowed: {
+    readonly 405: {
         httpStatus: number;
         code: string;
         name: string;
@@ -678,7 +678,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notAcceptable: {
+    readonly 406: {
         httpStatus: number;
         code: string;
         name: string;
@@ -686,7 +686,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly proxyAuthenticationRequired: {
+    readonly 407: {
         httpStatus: number;
         code: string;
         name: string;
@@ -694,7 +694,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly requestTimeout: {
+    readonly 408: {
         httpStatus: number;
         code: string;
         name: string;
@@ -702,7 +702,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly conflict: {
+    readonly 409: {
         httpStatus: number;
         code: string;
         name: string;
@@ -710,7 +710,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly gone: {
+    readonly 410: {
         httpStatus: number;
         code: string;
         name: string;
@@ -718,7 +718,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly lengthRequired: {
+    readonly 411: {
         httpStatus: number;
         code: string;
         name: string;
@@ -726,7 +726,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly preconditionFailed: {
+    readonly 412: {
         httpStatus: number;
         code: string;
         name: string;
@@ -734,7 +734,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly payloadTooLarge: {
+    readonly 413: {
         httpStatus: number;
         code: string;
         name: string;
@@ -742,7 +742,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly uriTooLong: {
+    readonly 414: {
         httpStatus: number;
         code: string;
         name: string;
@@ -750,7 +750,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unsupportedMediaType: {
+    readonly 415: {
         httpStatus: number;
         code: string;
         name: string;
@@ -758,7 +758,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly rangeNotSatisfiable: {
+    readonly 416: {
         httpStatus: number;
         code: string;
         name: string;
@@ -766,7 +766,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly expectationFailed: {
+    readonly 417: {
         httpStatus: number;
         code: string;
         name: string;
@@ -774,7 +774,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly imATeapot: {
+    readonly 418: {
         httpStatus: number;
         code: string;
         name: string;
@@ -782,7 +782,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unprocessableEntity: {
+    readonly 422: {
         httpStatus: number;
         code: string;
         name: string;
@@ -790,7 +790,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly locked: {
+    readonly 423: {
         httpStatus: number;
         code: string;
         name: string;
@@ -798,7 +798,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly failedDependency: {
+    readonly 424: {
         httpStatus: number;
         code: string;
         name: string;
@@ -806,7 +806,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly tooEarly: {
+    readonly 425: {
         httpStatus: number;
         code: string;
         name: string;
@@ -814,7 +814,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly upgradeRequired: {
+    readonly 426: {
         httpStatus: number;
         code: string;
         name: string;
@@ -822,7 +822,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly preconditionRequired: {
+    readonly 428: {
         httpStatus: number;
         code: string;
         name: string;
@@ -830,7 +830,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly tooManyRequests: {
+    readonly 429: {
         httpStatus: number;
         code: string;
         name: string;
@@ -838,7 +838,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly requestHeaderFieldsTooLarge: {
+    readonly 431: {
         httpStatus: number;
         code: string;
         name: string;
@@ -846,7 +846,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly unavailableForLegalReasons: {
+    readonly 451: {
         httpStatus: number;
         code: string;
         name: string;
@@ -854,7 +854,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly internalServerError: {
+    readonly 500: {
         httpStatus: number;
         code: string;
         name: string;
@@ -862,7 +862,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notImplemented: {
+    readonly 501: {
         httpStatus: number;
         code: string;
         name: string;
@@ -870,7 +870,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly badGateway: {
+    readonly 502: {
         httpStatus: number;
         code: string;
         name: string;
@@ -878,7 +878,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly serviceUnavailable: {
+    readonly 503: {
         httpStatus: number;
         code: string;
         name: string;
@@ -886,7 +886,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly gatewayTimeout: {
+    readonly 504: {
         httpStatus: number;
         code: string;
         name: string;
@@ -894,7 +894,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly httpVersionNotSupported: {
+    readonly 505: {
         httpStatus: number;
         code: string;
         name: string;
@@ -902,7 +902,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly variantAlsoNegotiates: {
+    readonly 506: {
         httpStatus: number;
         code: string;
         name: string;
@@ -910,7 +910,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly insufficientStorage: {
+    readonly 507: {
         httpStatus: number;
         code: string;
         name: string;
@@ -918,7 +918,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly loopDetected: {
+    readonly 508: {
         httpStatus: number;
         code: string;
         name: string;
@@ -926,7 +926,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly notExtended: {
+    readonly 510: {
         httpStatus: number;
         code: string;
         name: string;
@@ -934,7 +934,7 @@ declare const http: {
         uiMessage: string;
         type: string;
     };
-    readonly networkAuthenticationRequired: {
+    readonly 511: {
         httpStatus: number;
         code: string;
         name: string;