refactor: pluggable optional deps funcs centralized

.c8rc.json

@@ -1,8 +1,7 @@
 {
   "all": true,
   "src": [
-    "src",
-    "libs/universal-node-xml"
+    "src"
   ],
   "exclude": [
     "**/*.web.ts",

.eslintignore

@@ -12,7 +12,6 @@
 /res/schema/
 
 !/src/**
-!/libs/**
 
 !/tools/schema-downloader/**
 

.github/workflows/nodejs.yml

@@ -152,12 +152,14 @@ jobs:
           # do not use caching, use fresh version always, since some deps are not pinned -- since this is a library.
       - name: setup project
         shell: bash
+        env:
+          NODE_VERSION: '${{ matrix.node-version }}'
         run: |
           set -ex
           dep_constraints=''
           dev_requirements='c8 mocha npm-run-all fast-glob'
           # as long as npm cannot auto-resolve engine-constraints, we need to help here
-          case '${{ matrix.node-version }}' in
+          case "$NODE_VERSION" in
             '16')
               # for some stupid reason, NPM tries to resolve dev-packages, event hey are to be omitted.
               # this is frustrating when NPM is not resolving to compatible versions ...so drop them here
@@ -184,7 +186,9 @@ jobs:
           name: dist.node
           path: dist.node
       - name: test
-        run: npm run test:node
+        run: >
+          npm run -- test:node
+          ${{ startsWith(matrix.node-version, env.NODE_ACTIVE_LTS) && ' --forbid-pending' || '' }}
       - name: collect coverage
         if: ${{ failure() || success() }}
         run: >

.mocharc.js

@@ -26,8 +26,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 module.exports = {
   timeout: 10000,
   spec: [
-    'tests',
-    'libs'
+    'tests'
   ],
   recursive: true,
   parallel: false, // if true, then some IDEs cannot run it

HISTORY.md

@@ -6,6 +6,19 @@ All notable changes to this project will be documented in this file.
 
 <!-- add unreleased items here -->
 
+* Changed
+  * Exising `Serialize.XmlSerializer.serialize()` for _Node.js_ may throw `Serialize.MissingOptionalDependencyError` (via [#1084])  
+    This is considered a non-breaking change, as the docs always told that any `Error` may be thrown.
+* Added
+  * New class `Serialize.MissingOptionalDependencyError` (via [#1084])
+* Misc
+  * Refactored functionality around optional/pluggable dependencies (via [#1083], [#1084])  
+    This was done in preparation for [#1079]
+
+[#1079]: https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1079
+[#1083]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/1083
+[#1084]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/1084
+
 ## 6.9.5 -- 2024-05-23
 
 Maintenance release.

res/schema/README.md

@@ -15,13 +15,13 @@ Currently using version
 | [`bom-1.4.SNAPSHOT.xsd`](bom-1.4.SNAPSHOT.xsd) | applied changes: 1 |
 | [`bom-1.5.SNAPSHOT.xsd`](bom-1.5.SNAPSHOT.xsd) | applied changes: 1 |
 | [`bom-1.6.SNAPSHOT.xsd`](bom-1.6.SNAPSHOT.xsd) | applied changes: 1 |
-| [`bom-1.2.SNAPSHOT.schema.json`](bom-1.2.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
-| [`bom-1.3.SNAPSHOT.schema.json`](bom-1.3.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
-| [`bom-1.4.SNAPSHOT.schema.json`](bom-1.4.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
-| [`bom-1.5.SNAPSHOT.schema.json`](bom-1.5.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
-| [`bom-1.6.SNAPSHOT.schema.json`](bom-1.6.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
-| [`bom-1.2-strict.SNAPSHOT.schema.json`](bom-1.2-strict.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
-| [`bom-1.3-strict.SNAPSHOT.schema.json`](bom-1.3-strict.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.2.SNAPSHOT.schema.json`](bom-1.2.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
+| [`bom-1.3.SNAPSHOT.schema.json`](bom-1.3.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
+| [`bom-1.4.SNAPSHOT.schema.json`](bom-1.4.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
+| [`bom-1.5.SNAPSHOT.schema.json`](bom-1.5.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
+| [`bom-1.6.SNAPSHOT.schema.json`](bom-1.6.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
+| [`bom-1.2-strict.SNAPSHOT.schema.json`](bom-1.2-strict.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
+| [`bom-1.3-strict.SNAPSHOT.schema.json`](bom-1.3-strict.SNAPSHOT.schema.json) | applied changes: 2,3,4,5,6 |
 | [`spdx.SNAPSHOT.xsd`](spdx.SNAPSHOT.xsd) | |
 | [`spdx.SNAPSHOT.schema.json`](spdx.SNAPSHOT.schema.json) | |
 | [`jsf-0.82.SNAPSHOT.schema.json`](jsf-0.82.SNAPSHOT.schema.json) | |
@@ -32,3 +32,4 @@ changes:
 3. `jsf-0.82.schema.json` was replaced with `jsf-0.82.SNAPSHOT.schema.json`
 4. `properties.$schema.enum` was fixed to match `$id`
 5. `required.version` removed, as it is actually optional with default value
+6. `"format": "string"` removed, as it is unknown to JSON spec

res/schema/bom-1.2-strict.SNAPSHOT.schema.json

@@ -135,19 +135,16 @@
       "properties": {
         "vendor": {
           "type": "string",
-          "format": "string",
           "title": "Tool Vendor",
           "description": "The date and time (timestamp) when the document was created."
         },
         "name": {
           "type": "string",
-          "format": "string",
           "title": "Tool Name",
           "description": "The date and time (timestamp) when the document was created."
         },
         "version": {
           "type": "string",
-          "format": "string",
           "title": "Tool Version",
           "description": "The date and time (timestamp) when the document was created."
         },

res/schema/bom-1.2.SNAPSHOT.schema.json

@@ -129,19 +129,16 @@
       "properties": {
         "vendor": {
           "type": "string",
-          "format": "string",
           "title": "Tool Vendor",
           "description": "The date and time (timestamp) when the document was created."
         },
         "name": {
           "type": "string",
-          "format": "string",
           "title": "Tool Name",
           "description": "The date and time (timestamp) when the document was created."
         },
         "version": {
           "type": "string",
-          "format": "string",
           "title": "Tool Version",
           "description": "The date and time (timestamp) when the document was created."
         },
@@ -837,7 +834,6 @@
       "properties": {
         "ref": {
           "$ref": "#/definitions/refType",
-          "format": "string",
           "title": "Reference",
           "description": "References a component by the components bom-ref attribute"
         },

src/_helpers/README.md

@@ -2,5 +2,5 @@
 
 These are _internal_ helpers, that are not intended to be exported/published.
 
-The helpers shall **not** be marked as `@internal`, so that TypeScript might pick up on them and still render definitions for them.  
-The internal defined interfaces, classes, functions are required for proper type checking downstream, but should not be utilized/called downstream.
+The helpers SHALL **NOT** be marked as `@internal`, so that TypeScript might pick up on them and still render definitions for them.  
+The internal defined interfaces, classes, functions are required for proper type checking downstream, but SHOULD NOT be utilized/called downstream.

src/_optPlug.node/README.md

@@ -0,0 +1,11 @@
+# Optional Pluggable for node
+
+These are _internal_ helpers, that are not intended to be exported/published.
+
+The helpers SHALL **NOT** be marked as `@internal`, so that TypeScript might pick up on them and still render definitions for them.  
+The internal defined interfaces, classes, functions are required for proper type checking downstream, but SHOULD NOT be utilized/called downstream.
+
+Some functionality is private.  
+These exports **MUST** be marked as `@internal`.
+Respective files **MUST NOT** export or declare any relevant types or symbols.
+Respective files **MUST** be prefixed with double-underscore ("dunder" - `__`).