ac-custom-error 0.2.1 → 1.0.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+<a name="1.0.0"></a>
+ 
+# [1.0.0](https://github.com/admiralcloud/ac-custom-error/compare/v0.2.1..v1.0.0) (2023-03-12 13:22:39)
+
+
+### Feature
+
+* **App:** Add ACErrorFromCode  | MP | [114a5fc289ac193d1374bcba9247917966b39f31](https://github.com/admiralcloud/ac-custom-error/commit/114a5fc289ac193d1374bcba9247917966b39f31)    
+You can now use a global library of error codes and throw the error based on a code.  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+## BREAKING CHANGES
+* **App:** Two classes are exported in the function: ACError and ACErrorFromCode
 <a name="0.2.1"></a>
 
 ## [0.2.1](https://github.com/admiralcloud/ac-custom-error/compare/v0.2.0..v0.2.1) (2023-03-12 11:50:21)

package/README.md

@@ -3,16 +3,50 @@ Extend the NodeJS error with an error code and additional information.
 
 [![Node.js CI](https://github.com/AdmiralCloud/ac-custom-error/actions/workflows/node.js.yml/badge.svg)](https://github.com/AdmiralCloud/ac-custom-error/actions/workflows/node.js.yml)
 
-# Usage
+# ACErrorFromCode
+This is the preferred way to use this class. You define a central library of error codes and export them to global. You can then throw the error based on that code.
+
+## Usage
+```
+const { ACErrorFromCode } = require('ac-custom-error)
+
+// define error library
+const errorCodes = {
+  12345: {
+    message: 'this is the error,
+    solution: 'Provide optional solution to solve the error',
+    stack: true // optional, if you want to log the stack
+  },
+  ...
+}
+global.errorCodes = errorCodes
+
+
+// call the error
+throw new ACErrorFromCode(12345)
+
+// result in console
+ACErrorFromCode: this is the error
+    at STACK
+  code: 12345,
+  errorMessage: 'this is the error',
+  solution: 'Provide optional solution to solve the error'
+}
+```
+
+
+# ACError
+If you do not want ot use a global library of error codes, you can use ACError to still show code and additionalInfo.
+## Usage
 Use it just like the built-in error:
 + first parameter is the actual error message as string
 + second parameter is the error code 
 + third parameter is an optional object of additional information (e.g. variables clarifying the error)
 + fouth parameter is an optional object of options that can help further processing of the error 
 
-## Example
+### Example
 ```
-const ACError = require('ac-custom-error')
+const { ACError } = require('ac-custom-error')
 
 throw new ACError('myError', 123, { id: 333 }, { stack: true })
 

package/index.js

@@ -22,5 +22,33 @@ class ACError extends Error {
   }
 }
 
+class ACErrorFromCode extends Error {
+  constructor(code, additionalInfo = {}) {
+    super(code)
 
-module.exports = ACError
+    // fetch the error message for errorCodes object (if available)
+    const error = global?.errorCodes[code]
+    
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ACErrorFromCode)
+    }
+    // info
+    this.code = code || -1
+    this.errorMessage = error?.message || 'undefinedError'
+    this.message = this.errorMessage
+
+    if (error?.solution) {
+      this.solution = error.solution
+    }
+
+    if (Object.keys(additionalInfo).length) {
+      this.additionalInfo = additionalInfo
+    }
+    if (error?.stack) {
+      console.error(this.stack)
+    }
+  }
+}
+
+
+module.exports = { ACError, ACErrorFromCode }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ac-custom-error",
-  "version": "0.2.1",
+  "version": "1.0.0",
   "description": "Custom NodeJS error with error code and additional info",
   "main": "index.js",
   "repository": "https://github.com/AdmiralCloud/ac-custom-error",

package/test.js

@@ -1,13 +1,17 @@
 const { expect } = require('chai')
 
-const ACError = require('./index')
+const { ACError, ACErrorFromCode } = require('./index')
 
 const errorFunction = ({ message, code, additionalInfo, options }) => {
   throw new ACError(message, code, additionalInfo, options )
 }
 
+const errorFunctionFromCode = ({ code, additionalInfo }) => {
+  throw new ACErrorFromCode(code, additionalInfo)
+}
+
 
-describe('Run tests', () => {
+describe('Run tests with ACError', () => {
 
   it('Check error code', () => {
     let errorParams = { message: 'myError', code: 123 }
@@ -55,3 +59,33 @@ describe('Run tests', () => {
 
 })
 
+describe('Run tests with ACError', () => {
+
+  it('Define error codes', () => {
+    global.errorCodes = {
+      123: {
+        message: 'thisIsAnError',
+        solution: 'Provide an ID to avoid this error.'
+      }
+    }
+  })
+
+
+  it('Check error', () => {
+    let error
+    try {
+      errorFunctionFromCode({ code: 123 })
+    }
+    catch (err) {
+      error = err
+    }
+    
+    expect(error).to.be.an('Error')
+    expect(error.message).to.equal(global.errorCodes[123].message)
+    expect(error.code).to.equal(123)
+    expect(error.solution).to.equal(global.errorCodes[123].solution)
+  })
+
+
+})
+