feat: add argument to handle custom description errors on errorCodeToString (#61)

* fix: add missing dev dep

* feat: add argument to handle custom description errors

* feat: add tests

Author: emmanuelm41

bun.lockb

@@ -53,6 +53,7 @@
     "eslint-plugin-tsdoc": "^0.3.0",
     "eslint-plugin-unused-imports": "^4.0.0",
     "prettier": "^3.3.2",
+    "sort-package-json": "^2.10.1",
     "ts-jest": "^29.1.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"

package.json

@@ -14,7 +14,7 @@
  *  limitations under the License.
  *****************************************************************************/
 import { processErrorResponse } from './common'
-import { LedgerError } from './consts'
+import { LedgerCustomError, LedgerError } from './consts'
 import { errorCodeToString } from './errors'
 import { ResponseError } from './responseError'
 
@@ -25,6 +25,18 @@ describe('errorCodeToString', () => {
     expect(errorCodeToString(knownErrorCode)).toEqual(expectedMessage)
   })
 
+  it('should return the correct error message for a custom error code', () => {
+    const knownErrorCode: LedgerCustomError = 0xabcd
+    const expectedMessage = 'test custom error'
+    expect(errorCodeToString(knownErrorCode, { 0xabcd: expectedMessage })).toEqual(expectedMessage)
+  })
+
+  it('should return the correct error message for a known error code, when a custom error list is passed', () => {
+    const knownErrorCode: LedgerError = 0x9000
+    const expectedMessage = 'No errors'
+    expect(errorCodeToString(knownErrorCode, { [knownErrorCode]: 'Custom no errors' })).toEqual(expectedMessage)
+  })
+
   it('should return "Unknown Return Code" for an unknown error code', () => {
     const unknownErrorCode: LedgerError = 0x9999 as LedgerError
     const expectedMessage = 'Unknown Return Code: 0x9999'

src/common.test.ts

@@ -25,6 +25,8 @@ export const PAYLOAD_TYPE: Readonly<Record<string, number>> = {
   LAST: 0x02,
 }
 
+export type LedgerCustomError = number
+
 // Ledger error codes and descriptions sorted by value
 export enum LedgerError {
   U2FUnknown = 1,

src/consts.ts

@@ -13,20 +13,25 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  *****************************************************************************/
-import { ERROR_DESCRIPTION_OVERRIDE, LedgerError } from './consts'
+import { ERROR_DESCRIPTION_OVERRIDE, LedgerCustomError, LedgerError } from './consts'
 
 /**
  * Converts a Ledger error code to a human-readable string.
  *
  * @param returnCode - The Ledger error code to convert.
+ * @param customErrorList - Custom error description list to convert error code with.
  * @returns A string describing the error code.
  */
-export function errorCodeToString(returnCode: LedgerError): string {
+export function errorCodeToString(returnCode: LedgerError, customErrorList?: Record<LedgerCustomError, string>): string {
   const returnCodeStr = returnCode.toString(16).toUpperCase()
   let errDescription = `Unknown Return Code: 0x${returnCodeStr}`
 
   if (returnCode in ERROR_DESCRIPTION_OVERRIDE) {
-    errDescription = ERROR_DESCRIPTION_OVERRIDE[returnCode]
+    return ERROR_DESCRIPTION_OVERRIDE[returnCode]
+  }
+
+  if (customErrorList && returnCode in customErrorList) {
+    return customErrorList[returnCode]
   }
 
   return errDescription