error-message-utils 1.1.2 → 1.1.4

package/.prettierignore

@@ -0,0 +1,35 @@
+# defaults
+**/.git
+**/.svn
+**/.hg
+**/node_modules
+
+# build and dist Output
+dist
+build
+.out
+.next
+
+# logs
+npm-debug.log
+yarn-debug.log
+yarn-error.log
+pnpm-debug.log
+
+# environment files
+.env
+.env.local
+.env.*.local
+
+# lockfiles (if using a monorepo or specific package manager setup)
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# miscellaneous
+coverage/
+.DS_Store
+*.min.js
+public/
+tmp/
+*.md

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "singleAttributePerLine": true
+}

package/README.md

@@ -12,7 +12,7 @@ The `error-message-utils` package simplifies error management in your web applic
 
 Install the package:
 ```bash
-npm install -S error-message-utils
+npm i -S error-message-utils
 ```
 
 ### Examples
@@ -94,6 +94,26 @@ isEncodedError(encodeError(new Error('Some unknown error.'), 'NASTY_ERROR'));
 ```
 
 
+<br/>
+
+In some cases, you may want to check whether the extracted error matches the default message provided by this package:
+
+```typescript
+import { isDefaultErrorMessage} from 'error-message-utils';
+
+const DEFAULT_MESSAGE: string = 'The error message could not be extracted, check the logs for more information.';
+
+isDefaultErrorMessage(DEFAULT_MESSAGE);
+// true
+
+isDefaultErrorMessage(`${DEFAULT_MESSAGE} and something else...`);
+// false
+
+isDefaultErrorMessage(`${DEFAULT_MESSAGE} and something else...`, true);
+// true
+```
+
+
 
 
 <br/>
@@ -145,28 +165,3 @@ npm run test:unit
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)
-
-
-
-
-
-<br/>
-
-## Deployment
-
-Install dependencies:
-```bash
-npm install
-```
-
-
-Build the library:
-```bash
-npm start
-```
-
-
-Publish to `npm`:
-```bash
-npm publish
-```

package/dist/index.d.ts

@@ -6,6 +6,13 @@ import { IErrorCode, IDecodedError } from './shared/types.js';
  * @returns string
  */
 declare const extractMessage: (error: any) => string;
+/**
+ * Verifies if a value matches the default error message used by this package.
+ * @param value
+ * @param fullMatch?
+ * @returns boolean
+ */
+declare const isDefaultErrorMessage: (value: string, fullMatch?: boolean) => value is string;
 /**
  * Given an error in any format, it extracts the message and inserts the code at the end.
  * @param error
@@ -26,4 +33,4 @@ declare const decodeError: (error: any) => IDecodedError;
  * @returns boolean
  */
 declare const isEncodedError: (error: any) => boolean;
-export { type IErrorCode, type IDecodedError, extractMessage, encodeError, decodeError, isEncodedError, };
+export { type IErrorCode, type IDecodedError, extractMessage, isDefaultErrorMessage, encodeError, decodeError, isEncodedError, };

package/dist/index.js

@@ -1 +1 @@
-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};
+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},isDefaultErrorMessage=(r,e=!1)=>e?r===DEFAULT_MESSAGE:"string"==typeof r&&r.includes(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,isDefaultErrorMessage,encodeError,decodeError,isEncodedError};

package/dist/shared/types.d.ts

@@ -30,4 +30,4 @@ type IDecodedError = {
     message: string;
     code: IErrorCode;
 };
-export type { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode, IDecodedError, };
+export type { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode, IDecodedError };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "error-message-utils",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "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",
   "type": "module",
   "scripts": {
-    "start": "ts-lib-builder --tsconfig=tsconfig.build.json",
+    "build": "ts-lib-builder --tsconfig=tsconfig.build.json",
     "test": "echo \"Error: tests are executed with  npm run test:(integration|unit)\" && exit 1",
     "test:integration": "jest --config=jest.test-integration.config.json --no-cache",
     "test:unit": "jest --config=jest.test-unit.config.json --no-cache"
@@ -37,14 +37,16 @@
   },
   "homepage": "https://github.com/jesusgraterol/error-message-utils#readme",
   "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.9",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.5",
-    "ts-lib-builder": "^1.0.5",
-    "typescript": "^5.7.2"
+    "@types/jest": "29.5.14",
+    "@types/node": "20.17.9",
+    "@typescript-eslint/eslint-plugin": "7.18.0",
+    "@typescript-eslint/parser": "7.18.0",
+    "eslint-config-airbnb-typescript": "18.0.0",
+    "eslint-config-prettier": "10.1.5",
+    "jest": "29.7.0",
+    "prettier": "3.6.2",
+    "ts-jest": "29.2.5",
+    "ts-lib-builder": "1.0.7",
+    "typescript": "5.7.2"
   }
 }