improved debuggability

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

src/validation/errors.ts

@@ -17,15 +17,28 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
+import { type Version } from '../spec'
+
 export class ValidationError extends Error {
   readonly details: any | undefined
 
-  constructor (message?: string, details?: any) {
+  constructor (message: string, details?: any) {
     super(message)
     this.details = details
   }
 }
 
-export class NotImplementedError extends Error {}
+export class NotImplementedError extends Error {
+  constructor (version: Version) {
+    super(`not implemented for CycloneDX version: ${version}`)
+  }
+}
+
+export class MissingOptionalDependencyError extends Error {
+  readonly cause: any | undefined
 
-export class MissingOptionalDependencyError extends Error {}
+  constructor (message: string, cause?: any) {
+    super(message)
+    this.cause = cause
+  }
+}

src/validation/jsonValidator.ts

@@ -40,11 +40,12 @@ async function getAjv (): Promise<Ajv> {
         /* @ts-expect-error TS7016 */
         import('ajv-formats-draft2019')
       ])
-    } catch {
+    } catch (err) {
       throw new MissingOptionalDependencyError(
         'No JSON validator available.' +
         ' Please install all of the optional libraries:' +
-        ' ajv, ajv-formats, ajv-formats-draft2019'
+        ' ajv, ajv-formats, ajv-formats-draft2019',
+        err
       )
     }
 
@@ -81,7 +82,7 @@ abstract class BaseJsonValidator extends BaseValidator {
     if (this.#validator === undefined) {
       const schemaFile = this._getSchemaFile()
       if (schemaFile === undefined) {
-        throw new NotImplementedError(`not implemented for version: ${this.version}`)
+        throw new NotImplementedError(this.version)
       }
       const [ajv, schema] = await Promise.all([
         getAjv(),

src/validation/xmlValidator.node.ts

@@ -32,11 +32,12 @@ async function getParser (): Promise<typeof parseXml> {
     let libxml
     try {
       libxml = await import('libxmljs2')
-    } catch {
+    } catch (err) {
       throw new MissingOptionalDependencyError(
         'No XML validator available.' +
         ' Please install the optional libraries "libxmljs2".' +
-        ' Please make sure the system meets the requirements for node-gyp. https://github.com/TooTallNate/node-gyp#installation'
+        ' Please make sure the system meets the requirements for node-gyp. https://github.com/TooTallNate/node-gyp#installation',
+        err
       )
     }
     _parser = libxml.parseXml
@@ -60,7 +61,7 @@ export class XmlValidator extends BaseValidator {
     if (undefined === this.#schema) {
       const file = this.#getSchemaFile()
       if (file === undefined) {
-        throw new NotImplementedError(`not implemented for version: ${this.version}`)
+        throw new NotImplementedError(this.version)
       }
       const [parse, schema] = await Promise.all([
         getParser(),