error-message-utils 1.2.8 → 1.2.9

package/README.md

@@ -96,7 +96,7 @@ z.object({
 Identify encoded errors:
 
 ```typescript
-import { isEncodedError, encodeError, hasErrorCode } from 'error-message-utils';
+import { isEncodedError, encodeError, isErrorCodeCarrier, hasErrorCode } from 'error-message-utils';
 
 isEncodedError('Some random unencoded error');
 // false
@@ -110,12 +110,14 @@ isEncodedError(encodeError('Some unknown error.', 'NASTY_ERROR'));
 isEncodedError(encodeError(new Error('Some unknown error.'), 'NASTY_ERROR'));
 // true
 
-hasErrorCode(new Error('Oops, something went wrong.'), 'MY_ERROR_CODE'); // false
-hasErrorCode(
-  new Exception('Oops, something went wrong.', 'MY_ERROR_CODE'), 
-  'MY_ERROR_CODE'
-); 
-// true
+const error = new Error('Oops, something went wrong.');
+const exception = new Exception('Oops, something went wrong.', 'MY_ERROR_CODE');
+
+isErrorCodeCarrier(error); // false
+hasErrorCode(error, 'MY_ERROR_CODE'); // false
+
+isErrorCodeCarrier(exception); // true
+hasErrorCode(exception, 'MY_ERROR_CODE'); // true
 ```
 
 
@@ -192,6 +194,15 @@ type IExceptionRecord = {
   code: IErrorCode;
   data: unknown | null;
 };
+
+/**
+ * Error Code Carrier
+ * An object that carries an error code, typically used to identify errors programmatically.
+ */
+type IErrorCodeCarrier = {
+  code: IErrorCode;
+  message: string;
+} & Record<string, unknown>;
 ```
 
 

package/dist/error-handler/index.d.ts

@@ -1,4 +1,4 @@
-import { IErrorCode, IDecodedError } from '../shared/types.js';
+import type { IErrorCode, IDecodedError, IErrorCodeCarrier } from '../shared/types.js';
 /**
  * General errors
  */
@@ -35,6 +35,12 @@ export declare const isEncodedError: (error: any) => boolean;
 /**
  * Misc helpers
  */
+/**
+ * Determines whether an unknown value has an inspectable error code property.
+ * @param error The unknown value to inspect.
+ * @returns True when the value can carry an Exception-style code.
+ */
+export declare const isErrorCodeCarrier: (error: unknown) => error is IErrorCodeCarrier;
 /**
  * Checks if the given error matches the specified error code.
  * @param error The error to be checked, can be of any type.

package/dist/error-handler/index.js

@@ -1 +1 @@
-import{ZodError}from"zod";import{DEFAULT_CODE,DEFAULT_MESSAGE}from"../shared/constants.js";import{wrapCode,unwrapCode}from"../utils/index.js";import{extractZodErrorMessage}from"./utilities.js";export const extractMessage=r=>{if("string"==typeof r&&r.length)return r;if(r instanceof ZodError)return extractZodErrorMessage(r);if(r instanceof Error&&r.message)return r.cause?`${r.message}; [CAUSE]: ${extractMessage(r.cause)}`:r.message;if(r&&"object"==typeof r){if(r.message)return extractMessage(r.message);if(r.msg)return extractMessage(r.msg);if(r.error)return extractMessage(r.error);if(r.err)return extractMessage(r.err);if(r.errors)return extractMessage(r.errors);if(r.errs)return extractMessage(r.errs);if(r.reason)return extractMessage(r.reason);if(r.reasons)return extractMessage(r.reasons);if(r.issue)return extractMessage(r.issue);if(r.issues)return extractMessage(r.issues);if(r.data)return extractMessage(r.data);try{return JSON.stringify(r)}catch(e){console.error("Error during extractMessage:"),console.error("Original Error: ",r),console.error("JSON.stringify Error:",e)}}return DEFAULT_MESSAGE};export const encodeError=(r,e)=>`${extractMessage(r)}${wrapCode(e)}`;export const decodeError=r=>{const e=extractMessage(r),{code:s,startsAt:t}=unwrapCode(e);return{message:t>0?e.slice(0,t):e,code:s}};export const isEncodedError=r=>decodeError(r).code!==DEFAULT_CODE;export const hasErrorCode=(r,e)=>null!==r&&(r===e||"object"==typeof r&&"code"in r&&r.code===e||decodeError(r).code===e);export const isDefaultErrorMessage=(r,e=!1)=>e?r===DEFAULT_MESSAGE:"string"==typeof r&&r.includes(DEFAULT_MESSAGE);
+import{ZodError}from"zod";import{DEFAULT_CODE,DEFAULT_MESSAGE}from"../shared/constants.js";import{wrapCode,unwrapCode}from"../utils/index.js";import{extractZodErrorMessage}from"./utilities.js";export const extractMessage=r=>{if("string"==typeof r&&r.length)return r;if(r instanceof ZodError)return extractZodErrorMessage(r);if(r instanceof Error&&r.message)return r.cause?`${r.message}; [CAUSE]: ${extractMessage(r.cause)}`:r.message;if(r&&"object"==typeof r){if(r.message)return extractMessage(r.message);if(r.msg)return extractMessage(r.msg);if(r.error)return extractMessage(r.error);if(r.err)return extractMessage(r.err);if(r.errors)return extractMessage(r.errors);if(r.errs)return extractMessage(r.errs);if(r.reason)return extractMessage(r.reason);if(r.reasons)return extractMessage(r.reasons);if(r.issue)return extractMessage(r.issue);if(r.issues)return extractMessage(r.issues);if(r.data)return extractMessage(r.data);try{return JSON.stringify(r)}catch(e){console.error("Error during extractMessage:"),console.error("Original Error: ",r),console.error("JSON.stringify Error:",e)}}return DEFAULT_MESSAGE};export const encodeError=(r,e)=>`${extractMessage(r)}${wrapCode(e)}`;export const decodeError=r=>{const e=extractMessage(r),{code:s,startsAt:t}=unwrapCode(e);return{message:t>0?e.slice(0,t):e,code:s}};export const isEncodedError=r=>decodeError(r).code!==DEFAULT_CODE;export const isErrorCodeCarrier=r=>"object"==typeof r&&null!==r&&"code"in r&&("string"==typeof r.code||"number"==typeof r.code);export const hasErrorCode=(r,e)=>null!==r&&(r===e||isErrorCodeCarrier(r)&&r.code===e||decodeError(r).code===e);export const isDefaultErrorMessage=(r,e=!1)=>e?r===DEFAULT_MESSAGE:"string"==typeof r&&r.includes(DEFAULT_MESSAGE);

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { IErrorCode, IDecodedError } from './shared/types.js';
+export { IErrorCode, IDecodedError, IErrorCodeCarrier } from './shared/types.js';
 export { DEFAULT_CODE, DEFAULT_MESSAGE } from './shared/constants.js';
-export { extractMessage, encodeError, decodeError, isEncodedError, hasErrorCode, isDefaultErrorMessage, } from './error-handler/index.js';
+export { extractMessage, encodeError, decodeError, isEncodedError, isErrorCodeCarrier, hasErrorCode, isDefaultErrorMessage, } from './error-handler/index.js';
 export { type IExceptionRecord, Exception } from './exception/index.js';

package/dist/index.js

@@ -1 +1 @@
-export{DEFAULT_CODE,DEFAULT_MESSAGE}from"./shared/constants.js";export{extractMessage,encodeError,decodeError,isEncodedError,hasErrorCode,isDefaultErrorMessage}from"./error-handler/index.js";export{Exception}from"./exception/index.js";
+export{DEFAULT_CODE,DEFAULT_MESSAGE}from"./shared/constants.js";export{extractMessage,encodeError,decodeError,isEncodedError,isErrorCodeCarrier,hasErrorCode,isDefaultErrorMessage}from"./error-handler/index.js";export{Exception}from"./exception/index.js";

package/dist/shared/types.d.ts

@@ -30,3 +30,12 @@ export type IDecodedError = {
     message: string;
     code: IErrorCode;
 };
+/**
+ * Error Code Carrier
+ * An object that carries an error code, typically used to identify errors programmatically. Extra
+ * fields are allowed because provider and application errors often carry metadata.
+ */
+export type IErrorCodeCarrier = {
+    code: IErrorCode;
+    message: string;
+} & Record<string, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-message-utils",
-  "version": "1.2.8",
+  "version": "1.2.9",
   "description": "The error-message-utils package simplifies error management in your web applications and RESTful APIs. It ensures consistent and scalable handling of error messages, saving you time and effort. Moreover, it gives you the ability to assign custom error codes so all possible cases can be handled accordingly.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",