error-message-utils 1.0.2 → 1.1.1

package/README.md

@@ -24,6 +24,7 @@ $ npm install -S error-message-utils
 ## Usage
 
 Encoding an error:
+
 ```typescript
 import { encodeError } from 'error-message-utils';
 
@@ -36,7 +37,11 @@ if (emailExists()) {
 }
 ```
 
+
+<br/>
+
 Decoding an error:
+
 ```typescript
 import { decodeError } from 'error-message-utils';
 
@@ -47,7 +52,11 @@ decodeError('The provided email is already in use.{(EMAIL_EXISTS)}');
 // }
 ```
 
+
+<br/>
+
 Error messages can be extracted recursively from complex structures, including nested `cause` data properties from `Error` instances:
+
 ```typescript
 import { extractMessage } from 'error-message-utils';
 
@@ -70,6 +79,26 @@ extractMessage({
 ```
 
 
+<br/>
+
+Identifying encoded errors:
+
+```typescript
+import { isEncodedError, encodeError } from 'error-message-utils';
+
+isEncodedError('Some random unencoded error');
+// false
+
+isEncodedError(new Error('Some random unencoded error'));
+// false
+
+isEncodedError(encodeError('Some unknown error.', 'NASTY_ERROR'));
+// true
+
+isEncodedError(encodeError(new Error('Some unknown error.'), 'NASTY_ERROR'));
+// true
+```
+
 
 <br/>
 

package/dist/index.d.ts

@@ -1,2 +1,29 @@
-export * from './shared/types.js';
-export * from './error/index.js';
+import { IErrorCode, IDecodedError } from './shared/types.js';
+/**
+ * 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
+ * @returns string
+ */
+declare const extractMessage: (error: any) => string;
+/**
+ * Given an error in any format, it extracts the message and inserts the code at the end.
+ * @param error
+ * @param code
+ * @returns string
+ */
+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
+ * @returns IDecodedError
+ */
+declare const decodeError: (error: any) => IDecodedError;
+/**
+ * Determines if a given error (in any format) is an error encoded by this package.
+ * @param error
+ * @returns boolean
+ */
+declare const isEncodedError: (error: any) => boolean;
+export { IErrorCode, IDecodedError, extractMessage, encodeError, decodeError, isEncodedError, };

package/dist/index.js

@@ -1 +1 @@
-export*from"./shared/types.js";export*from"./error/index.js";
+import{DEFAULT_MESSAGE,DEFAULT_CODE,wrapCode,unwrapCode}from"./utils/utils.js";const extractMessage=r=>{if("string"==typeof r&&r.length)return 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);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;export{extractMessage,encodeError,decodeError,isEncodedError};

package/dist/shared/types.d.ts

@@ -3,10 +3,10 @@
  * When an error code is inserted into a message (encoding a message), it must be wrapped first so
  * it can be decoded later.
  */
-interface IErrorCodeWrapper {
+type IErrorCodeWrapper = {
     prefix: string;
     suffix: string;
-}
+};
 /**
  * Error Code
  * The error's code that is inserted when encoding an error. If none is provided or none can be
@@ -17,17 +17,17 @@ type IErrorCode = string | number;
  * Unwrapped Error Code
  * In order to decode an error, the code must be first unwrapped.
  */
-interface IUnwrappedErrorCode {
+type IUnwrappedErrorCode = {
     code: IErrorCode;
     startsAt: number;
-}
+};
 /**
  * Decoded Error
  * The object obtained when an error is decoded. Keep in mind that if the error message or the code
  * cannot be extracted for any reason, the default values will be set instead.
  */
-interface IDecodedError {
+type IDecodedError = {
     message: string;
     code: IErrorCode;
-}
-export { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode, IDecodedError, };
+};
+export type { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode, IDecodedError, };

package/dist/utils/utils.d.ts

@@ -1,4 +1,4 @@
-import { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode } from '../shared/index.js';
+import { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode } from '../shared/types.js';
 declare const CODE_WRAPPER: IErrorCodeWrapper;
 declare const DEFAULT_MESSAGE: string;
 declare const DEFAULT_CODE: IErrorCode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-message-utils",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "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",
@@ -38,13 +38,13 @@
   "homepage": "https://github.com/jesusgraterol/error-message-utils#readme",
   "devDependencies": {
     "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.9",
-    "@typescript-eslint/eslint-plugin": "^7.8.0",
-    "@typescript-eslint/parser": "^7.8.0",
+    "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.16.0",
+    "@typescript-eslint/parser": "^7.16.0",
     "eslint-config-airbnb-typescript": "^18.0.0",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.0",
     "ts-lib-builder": "^1.0.3",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.3"
   }
 }

package/dist/error/error.d.ts

@@ -1,23 +0,0 @@
-import { IErrorCode, IDecodedError } from '../shared/index.js';
-/**
- * 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
- * @returns string
- */
-declare const extractMessage: (error: any) => string;
-/**
- * Given an error in any format, it extracts the message and inserts the code at the end.
- * @param error
- * @param code
- * @returns string
- */
-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
- * @returns IDecodedError
- */
-declare const decodeError: (error: any) => IDecodedError;
-export { extractMessage, encodeError, decodeError, };

package/dist/error/error.js

@@ -1 +0,0 @@
-import{DEFAULT_MESSAGE,wrapCode,unwrapCode}from"../utils/utils.js";const extractMessage=r=>{if("string"==typeof r&&r.length)return 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);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}};export{extractMessage,encodeError,decodeError};

package/dist/error/index.d.ts

@@ -1 +0,0 @@
-export * from './error.js';

package/dist/error/index.js

@@ -1 +0,0 @@
-export*from"./error.js";

package/dist/shared/index.d.ts

@@ -1 +0,0 @@
-export * from './types.js';

package/dist/shared/index.js

@@ -1 +0,0 @@
-export*from"./types.js";

package/dist/utils/index.d.ts

@@ -1 +0,0 @@
-export * from './utils.js';

package/dist/utils/index.js

@@ -1 +0,0 @@
-export*from"./utils.js";