can't use internals for public API

[jkowalleck]

some properties and constructor parameters use internal types, like SortableStringables.

this is an issue, as these internals are not exported. they can not be used downstream.
It prevents usage like follows:

component.evidence = new CDX.Models.ComponentEvidence({
        licenses: new CDX.Models.LicenseRepository(this.getLicenseEvidence(dirname(pkg.path), logger)),
        copyright: new SortableStringables(copyrights)
      })

context

some symbols are mark as internals, they are not exported, and they are not public API.
see https://cyclonedx-javascript-library.readthedocs.io/en/latest/typedoc/node/modules/_internal_.html

but yet, some internals are used in public API, as properties or parameters.

requirements / goals

• no internals are used in public API, as properties or parameters.
  They miught be used for inheritance, still.

solution

have dedicated classes, that are properly exported and public API.
for example

// pseudo-code 
export CDX.Models.CopyrightRepository extends SortableStringables{}

just like we did before:

cyclonedx-javascript-library/src/enums/vulnerability/analysisResponse.ts

Line 30 in fca1db5

export class AnalysisResponseRepository extends SortableStringables<AnalysisResponse> {}

considerations

since this would change types of public API, we would introduce it in a two-staged manner:

1. non-breaking:
   • allo the new class -- since the new classes inherit from the old one, all is good
     ComponentEvidence(..., copyright: CopyrightRepository|SortableStringables)
   • dont change the typeof the property -- since the new classes inherit from the old one, all is good
     copyright: SortableStringables
2. breaking: remove any usage of non-public classes in public API.
   prepare a breaking change, but dont mere it yet; have it added to the next major milestone.
   see must not use internals for public API #1193

[jkowalleck]

@Frozen-byte this issue is caused by https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1338/files#r1867685873

If you like, you can work on a non-breaking solution
taken. see #1192 (comment)

[jkowalleck]

i will be working on a non-breaking solution.

[jkowalleck]

as the previous API was non-public, a change to use some public API is considered non-breaking.