error-message-utils 1.2.6 → 1.2.8

package/README.md

@@ -96,7 +96,7 @@ z.object({
 Identify encoded errors:
 
 ```typescript
-import { isEncodedError, encodeError } from 'error-message-utils';
+import { isEncodedError, encodeError, hasErrorCode } from 'error-message-utils';
 
 isEncodedError('Some random unencoded error');
 // false
@@ -109,6 +109,13 @@ 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
 ```
 
 

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

@@ -1,45 +1,51 @@
 import { IErrorCode, IDecodedError } from '../shared/types.js';
-/**------------------------------------------------------------------------------------------------
+/**
  * General errors
- -------------------------------------------------------------------------------------------------*/
+ */
 /**
  * Attempts to extract an error message from an error that could be anything. If it fails to do so,
  * it returns the default message.
  * @param error The error to extract the message from.
  * @returns A string containing the extracted message or the default message if extraction fails.
  */
-declare const extractMessage: (error: any) => string;
-/**------------------------------------------------------------------------------------------------
- * Encoding
- -------------------------------------------------------------------------------------------------*/
+export declare const extractMessage: (error: any) => string;
+/**
+ * Encoding / Decoding
+ */
 /**
  * Given an error in any format, it extracts the message and inserts the code at the end.
  * @param error The error to be encoded, can be of any type.
  * @param code The error code to be wrapped and appended to the message.
  * @returns A string containing the encoded error message.
  */
-declare const encodeError: (error: any, code: IErrorCode) => string;
+export declare const encodeError: (error: any, code: IErrorCode) => string;
 /**
  * Given an error, it will extract the encoded message and attempt to decode it. If successful,
  * it separates the error message from the code so it can be shown directly to the user.
  * @param error The error to be decoded, can be of any type.
  * @returns The decoded error, containing the message and the code.
  */
-declare const decodeError: (error: any) => IDecodedError;
+export declare const decodeError: (error: any) => IDecodedError;
 /**
  * Determines if a given error (in any format) is an error encoded by this package.
  * @param error The error to be checked, can be of any type.
  * @returns A boolean indicating whether the error is an encoded error or not.
  */
-declare const isEncodedError: (error: any) => boolean;
-/**------------------------------------------------------------------------------------------------
+export declare const isEncodedError: (error: any) => boolean;
+/**
  * Misc helpers
- -------------------------------------------------------------------------------------------------*/
+ */
+/**
+ * Checks if the given error matches the specified error code.
+ * @param error The error to be checked, can be of any type.
+ * @param code The error code to check against.
+ * @returns A boolean indicating whether the error matches the specified code.
+ */
+export declare const hasErrorCode: (error: unknown, code: IErrorCode) => boolean;
 /**
  * Verifies if a value matches the default error message used by this package.
  * @param value The value to be checked.
  * @param fullMatch Whether to check for an exact match or a partial match.
  * @returns A boolean indicating whether the value matches the default error message.
  */
-declare const isDefaultErrorMessage: (value: string, fullMatch?: boolean) => value is string;
-export { type IErrorCode, type IDecodedError, extractMessage, encodeError, decodeError, isEncodedError, isDefaultErrorMessage, };
+export declare const isDefaultErrorMessage: (value: string, fullMatch?: boolean) => value is string;

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";const __extractPathFromZodError=r=>r&&Array.isArray(r.issues)&&r.issues.length&&Array.isArray(r.issues[0].path)&&r.issues[0].path.length?r.issues[0].path.join("."):"Unknown path",__extractZodErrorMessage=r=>r&&Array.isArray(r.issues)&&r.issues.length&&Array.isArray(r.issues[0].path)&&r.issues[0].message?`${r.issues[0].message} (${__extractPathFromZodError(r)})`:DEFAULT_MESSAGE,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},encodeError=(r,e)=>`${extractMessage(r)}${wrapCode(e)}`,decodeError=r=>{const e=extractMessage(r),{code:s,startsAt:t}=unwrapCode(e);return{message:t>0?e.slice(0,t):e,code:s}},isEncodedError=r=>decodeError(r).code!==DEFAULT_CODE,isDefaultErrorMessage=(r,e=!1)=>e?r===DEFAULT_MESSAGE:"string"==typeof r&&r.includes(DEFAULT_MESSAGE);export{extractMessage,encodeError,decodeError,isEncodedError,isDefaultErrorMessage};
+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);

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

@@ -0,0 +1,8 @@
+import { ZodError } from 'zod';
+/**
+ * Attempts to extract a Zod error message from a ZodError instance. If unable to do so, it returns
+ * the default error message.
+ * @param error The ZodError instance to extract the message from.
+ * @returns The extracted error message or the default message.
+ */
+export declare const extractZodErrorMessage: (error: ZodError) => string;

package/dist/error-handler/utilities.js

@@ -0,0 +1 @@
+import{DEFAULT_MESSAGE}from"../shared/constants.js";const __extractPathFromZodError=s=>s&&Array.isArray(s.issues)&&s.issues.length&&Array.isArray(s.issues[0].path)&&s.issues[0].path.length?s.issues[0].path.join("."):"Unknown path";export const extractZodErrorMessage=s=>s&&Array.isArray(s.issues)&&s.issues.length&&Array.isArray(s.issues[0].path)&&s.issues[0].message?`${s.issues[0].message} (${__extractPathFromZodError(s)})`:DEFAULT_MESSAGE;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { IErrorCode, IDecodedError } from './shared/types.js';
 export { DEFAULT_CODE, DEFAULT_MESSAGE } from './shared/constants.js';
-export { decodeError, encodeError, extractMessage, isDefaultErrorMessage, isEncodedError, } from './error-handler/index.js';
+export { extractMessage, encodeError, decodeError, isEncodedError, 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{decodeError,encodeError,extractMessage,isDefaultErrorMessage,isEncodedError}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,hasErrorCode,isDefaultErrorMessage}from"./error-handler/index.js";export{Exception}from"./exception/index.js";

package/dist/utils/index.js

@@ -1 +1 @@
-import{CODE_WRAPPER,DEFAULT_CODE}from"../shared/constants.js";export const wrapCode=r=>`${CODE_WRAPPER.prefix}${r??DEFAULT_CODE}${CODE_WRAPPER.suffix}`;const __isEncodedError=r=>new RegExp(`${CODE_WRAPPER.prefix}.+${CODE_WRAPPER.suffix}$`).test(r),__isNumeric=r=>!Number.isNaN(Number.parseFloat(r));export const unwrapCode=r=>{if(__isEncodedError(r)){const s=r.lastIndexOf(CODE_WRAPPER.prefix),e=r.substring(s+2,r.lastIndexOf(CODE_WRAPPER.suffix));return{code:__isNumeric(e)?Number(e):e,startsAt:s}}return{code:DEFAULT_CODE,startsAt:-1}};
+import{CODE_WRAPPER,DEFAULT_CODE}from"../shared/constants.js";export const wrapCode=r=>`${CODE_WRAPPER.prefix}${r??DEFAULT_CODE}${CODE_WRAPPER.suffix}`;const __isEncodedError=r=>new RegExp(`${CODE_WRAPPER.prefix}.+${CODE_WRAPPER.suffix}$`).test(r),__isNumeric=r=>"string"==typeof r&&/^[-]?(\d+(\.\d*)?|\.\d+)([eE][+-]?\d+)?$/.test(r);export const unwrapCode=r=>{if(__isEncodedError(r)){const E=r.lastIndexOf(CODE_WRAPPER.prefix),e=r.substring(E+CODE_WRAPPER.prefix.length,r.lastIndexOf(CODE_WRAPPER.suffix));return{code:__isNumeric(e)?Number(e):e,startsAt:E}}return{code:DEFAULT_CODE,startsAt:-1}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-message-utils",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "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",
@@ -37,6 +37,7 @@
   },
   "homepage": "https://github.com/jesusgraterol/error-message-utils#readme",
   "devDependencies": {
+    "@jest/globals": "30.3.0",
     "@types/jest": "29.5.14",
     "@types/node": "20.17.9",
     "@typescript-eslint/eslint-plugin": "7.18.0",
@@ -50,7 +51,6 @@
     "typescript": "5.7.2"
   },
   "dependencies": {
-    "@jest/globals": "30.3.0",
     "zod": "4.3.6"
   }
 }