feat: Moved non‑standard implementations to Contrib area by jkowalleck · Pull Request #1343 · CycloneDX/cyclonedx-javascript-library

jkowalleck · 2025-11-26T09:46:40Z

fixes refactor: move every implementation that does not implement the standard to sub-namespace "contrib" #1344

Added

New entry point for /Contrib and known submodules
See package.json::exports for details.

Changed

Moved non‑standard implementations to Contrib area

Deprecated

Certain exports have been deprecated; downstream imports should be updated to the new locations
Note: the symbols themselves remain supported. See documentation and the "Refactored" section below for details.

Refactored

The following symbols were moved.
The symbols are still import-able through their old location.
- OLD -> NEW
- Builders.FromNodePackageJson -> Contrib.FromNodePackageJson.Builders
- Factories.FromNodePackageJson -> Contrib.FromNodePackageJson.Factories
- Factories.LicenseFactory -> Contrib.License.Factories.LicenseFactory
- Factories.PackageUrlFactory -> Contrib.PackageUrl.Factories.PackageUrlFactory
- Types.assertNodePackageJson -> Contrib.FromNodePackageJson.Types.assertNodePackageJson
- Types.isNodePackageJson -> Contrib.FromNodePackageJson.Types.isNodePackageJson
- Types.NodePackageJson -> Contrib.FromNodePackageJson.Types.NodePackageJson
- Utils.LicenseUtility -> Contrib.License.Utils
- Utils.NpmjsUtility -> Contrib.FromNodePackageJson.Utils

⚠️ tests for contribs were not moved yet, to show that all functionality still works.
the tests will be moved in a later step

wrote docs
moved functionality
mark old imports ad deprecated
write changelog

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

codacy-production · 2025-11-26T12:29:31Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.05% (target: -1.00%)	✅ 100.00% (target: 90.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`8c36d6c`)	26565	26139	98.40%
Head commit (`81bed86`)	27486 (+921)	27060 (+921)	98.45% (+0.05%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#1343)	353	353	100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Copilot

Pull request overview

This PR reorganizes non-standard implementations into a new /Contrib area to better separate community-contributed features from core CycloneDX functionality. The refactoring maintains backward compatibility by creating deprecated re-exports at the old locations while establishing new canonical import paths.

Key Changes:

Introduces a new /Contrib namespace with submodules for FromNodePackageJson, License, and PackageUrl
Moves existing implementations (factories, builders, utilities, types) from core areas to their respective contrib modules
Adds package.json exports for all new contrib entry points
Provides comprehensive deprecation notices for old import paths while keeping symbols functional

Reviewed changes

Copilot reviewed 28 out of 32 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`package.json`	Adds new export entries for `/Contrib` and its submodules (FromNodePackageJson, License, PackageUrl)
`HISTORY.md`	Documents the refactoring with detailed migration paths for affected symbols
`src/index.node.ts`, `src/index.web.ts`, `src/index.common.ts`	Exports new `Contrib` namespace at the root level
`src/contrib/index.node.ts`, `src/contrib/index.web.ts`, `src/contrib/index.common.ts`	New entry points for contrib modules with platform-specific exports
`src/contrib/README.md`	Documentation explaining the contrib area's purpose and guidelines
`src/contrib/fromNodePackageJson/*`	Relocated Node package.json utilities, builders, factories, and types from root modules
`src/contrib/license/*`	Relocated license-related factories and utilities to contrib area
`src/contrib/packageUrl/*`	Relocated PackageURL factory to contrib area
`src/types/index.ts`	Adds deprecated re-exports for NodePackageJson types with migration notices
`src/factories/index.common.ts`, `src/factories/index.node.ts`	Adds deprecated re-exports for LicenseFactory, PackageUrlFactory, and FromNodePackageJson factories
`src/builders/index.node.ts`	Adds deprecated re-export for FromNodePackageJson builders
`src/utils/index.node.ts`	Adds deprecated re-exports for LicenseUtility and NpmjsUtility
`tests/contrib/license/unit/internals/helpers.mime.node.spec.js`	Updates test import path to reflect new location of mime helper

Comments suppressed due to low confidence (2)

src/contrib/fromNodePackageJson/factories.ts:34

Inconsistent quote style in import statement. Use single quotes to match the style of other imports in this file (lines 32-33, 35-41).
src/contrib/fromNodePackageJson/factories.ts:39
Inconsistent quote style in import statement. Use single quotes to match the style of other imports in this file (lines 32-33, 35-38, 40-41).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/utils/index.node.ts

src/types/index.ts

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Copilot

Pull request overview

Copilot reviewed 36 out of 41 changed files in this pull request and generated 8 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/index.node.ts

src/index.web.ts

src/utils/index.common.ts

examples/node/javascript/package.json

src/index.node.ts

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Copilot

Pull request overview

Copilot reviewed 37 out of 42 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

HISTORY.md

package.json

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Copilot

Pull request overview

Copilot reviewed 37 out of 42 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (1)

tests/contrib/license/unit/internals/helpers.mime.node.spec.js:26

The require path is missing the .js file extension. It should be:

} = require('../../../../../dist.node/contrib/license/_helpers/mime.node.js')

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

package.json

examples/node/javascript/package.json

### Description  in #1343 some contrib implementations were moved, and the old exports were kept. they are marked deprecated -- and now the were removed * Removed * Entrypoint `Builders` (via [#1377]) * Entrypoint `Factories` (via [#1377]) * Entrypoint `Utils` (via [#1377]) * Deprecated symbol `Builders` ([#1346] via [#1377]) * Deprecated symbol `Builders.FromNodePackageJson` ([#1346] via [#1377]) * Deprecated symbol `Builders.FromNodePackageJson.ToolBuilder` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Builders.ToolBuilder` instead. * Deprecated symbol `Builders.FromNodePackageJson.ComponentBuilder` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Builders.ComponentBuilder` instead. * Deprecated symbol `Factories` ([#1346] via [#1377]) * Deprecated symbol `Factories.FromNodePackageJson` ([#1346] via [#1377]) * Deprecated symbol `Factories.FromNodePackageJson.ExternalReferenceFactory` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Factories.ExternalReferenceFactory` instead. * Deprecated symbol `Factories.FromNodePackageJson.PackageUrlFactory` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Factories.PackageUrlFactory` instead. * Deprecated symbol `Factories.LicenseFactory` ([#1346] via [#1377]) Use `Contrib.License.Factories.LicenseFactory` instead. * Deprecated symbol `Factories.PackageUrlFactory` ([#1346] via [#1377]) Use `Contrib.PackageUrl.Factories.PackageUrlFactory` instead. * Deprecated symbol `Types.NodePackageJson` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Types.NodePackageJson` instead. * Deprecated symbol `Types.assertNodePackageJson` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Types.assertNodePackageJson` instead. * Deprecated symbol `Types.isNodePackageJson` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Types.isNodePackageJson` instead. * Deprecated symbol `Utils` ([#1346] via [#1377]) * Deprecated symbol `Utils.BomUtility` ([#1346] via [#1377]) * Deprecated symbol `Utils.BomUtility.randomSerialNumber` ([#1346] via [#1377]) Use `Contrib.Bom.Utils.randomSerialNumber` instead. * Deprecated symbol `Utils.LicenseUtility` ([#1346] via [#1377]) * Deprecated symbol `Utils.LicenseUtility.FsUtils` ([#1346] via [#1377]) Use `Contrib.License.Utils.FsUtils` instead. * Deprecated symbol `Utils.LicenseUtility.PathUtils` ([#1346] via [#1377]) * Use `Contrib.License.Utils.PathUtils` instead. * Deprecated symbol `Utils.LicenseUtility.FileAttachment` ([#1346] via [#1377]) Use `Contrib.License.Utils.FileAttachment` instead. * Deprecated symbol `Utils.LicenseUtility.ErrorReporter` ([#1346] via [#1377]) Use `Contrib.License.Utils.ErrorReporter` instead. * Deprecated symbol `Utils.LicenseUtility.LicenseEvidenceGatherer` ([#1346] via [#1377]) Use `Contrib.License.Utils.LicenseEvidenceGatherer` instead. * Deprecated symbol `Utils.NpmjsUtility` ([#1346] via [#1377]) * Deprecated symbol `Utils.NpmjsUtility.parsePackageIntegrity` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Utils.parsePackageIntegrity` instead. * Deprecated symbol `Utils.NpmjsUtility.defaultRegistryMatcher` ([#1346] via [#1377]) Use `Contrib.FromNodePackageJson.Utils.defaultRegistryMatcher` instead. fixes: #1346 ### AI Tool Disclosure - [x] My contribution does not include any AI-generated content - [ ] My contribution includes AI-generated content, as disclosed below: - AI Tools: `[e.g. GitHub CoPilot, ChatGPT, JetBrains Junie etc.]` - LLMs and versions: `[e.g. GPT-4.1, Claude Haiku 4.5, Gemini 2.5 Pro etc.]` - Prompts: `[Summarize the key prompts or instructions given to the AI tools]` ### Affirmation - [x] My code follows the [CONTRIBUTING.md](https://github.com/CycloneDX/cyclonedx-javascript-library/blob/main/CONTRIBUTING.md) guidelines

feat: prepare "contrib" area

5965aa8

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck requested a review from a team as a code owner November 26, 2025 09:46

jkowalleck added the enhancement New feature or request label Nov 26, 2025

jkowalleck marked this pull request as draft November 26, 2025 10:33

jkowalleck added 3 commits November 26, 2025 12:36

refactor: moved contrib foo

b7719f6

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

refactor: moved contrib foo

12d64f8

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

refactor: moved contrib foo

9754509

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck force-pushed the feat/prep-contrib branch from 2b9e1f3 to 9754509 Compare November 26, 2025 12:18

refactor: moved contrib foo

f890b67

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck added refactor and removed enhancement New feature or request labels Nov 26, 2025

Copilot AI mentioned this pull request Nov 26, 2025

Add JSDoc @deprecated annotations for contrib re-exports #1345

Closed

jkowalleck added 2 commits November 27, 2025 11:34

refactor: moved contrib foo

17c5cf7

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

docs

5ab41cf

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck marked this pull request as ready for review November 27, 2025 11:02

jkowalleck added 2 commits November 27, 2025 12:32

docs

96a596c

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

docs

870e1c5

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck added the enhancement New feature or request label Nov 27, 2025

docs

dc9bfa0

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck mentioned this pull request Nov 27, 2025

remove deprecated re-exports #1346

Closed

feat: prepare "contrib" area

5e02470

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck requested a review from Copilot November 28, 2025 13:36

Copilot started reviewing on behalf of jkowalleck November 28, 2025 13:36 View session

Copilot finished reviewing on behalf of jkowalleck November 28, 2025 13:38

Copilot AI reviewed Nov 28, 2025

View reviewed changes

jkowalleck added 2 commits November 28, 2025 14:57

feat: prepare "contrib" area

a8dfdb2

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

feat: prepare "contrib" area

9120af8

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck changed the title ~~feat: prepare "contrib" area~~ feat: move non-standard implementations to "contrib" area Nov 28, 2025

jkowalleck changed the title ~~feat: move non-standard implementations to "contrib" area~~ feat: Moved non‑standard implementations to Contrib area Nov 28, 2025

jkowalleck mentioned this pull request Nov 30, 2025

feat!: (re)move non-standard implementations #1348

Closed

4 tasks

jkowalleck added 7 commits November 30, 2025 13:51

feat: prep contrib

0d9e9c9

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

feat: prep contrib

e8a09dd

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

feat: prep contrib

0a64b60

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

feat: prep contrib

bc4c69d

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Merge branch 'main' into feat/prep-contrib

22b8930

Merge branch 'main' into feat/prep-contrib

2e18551

Merge remote-tracking branch 'origin/main' into feat/prep-contrib

5c2366a

jkowalleck requested a review from Copilot December 2, 2025 10:14

Copilot started reviewing on behalf of jkowalleck December 2, 2025 10:15 View session

Copilot finished reviewing on behalf of jkowalleck December 2, 2025 10:20

Copilot AI reviewed Dec 2, 2025

View reviewed changes

wup

6cd736e

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck requested a review from Copilot December 2, 2025 11:32

Copilot started reviewing on behalf of jkowalleck December 2, 2025 11:32 View session

Copilot finished reviewing on behalf of jkowalleck December 2, 2025 11:37

Copilot AI reviewed Dec 2, 2025

View reviewed changes

HISTORY.md Show resolved Hide resolved

package.json Show resolved Hide resolved

jkowalleck requested a review from Copilot December 2, 2025 11:42

Copilot started reviewing on behalf of jkowalleck December 2, 2025 11:42 View session

wup

81bed86

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Copilot finished reviewing on behalf of jkowalleck December 2, 2025 11:48

Copilot AI reviewed Dec 2, 2025

View reviewed changes

package.json Show resolved Hide resolved

package.json Show resolved Hide resolved

examples/node/javascript/package.json Show resolved Hide resolved

jkowalleck merged commit ea8f1f3 into main Dec 2, 2025
40 checks passed

jkowalleck deleted the feat/prep-contrib branch December 2, 2025 12:08

jkowalleck added the contrib label Dec 2, 2025

jkowalleck mentioned this pull request Feb 18, 2026

feat!: remove deprecated reexports #1377

Merged

3 tasks

Uh oh!

Conversation

jkowalleck commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Added

Changed

Deprecated

Refactored

Uh oh!

codacy-production bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

See diff coverage on Codacy

See your quality gate settings Change summary preferences

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jkowalleck commented Nov 26, 2025 •

edited

Loading

codacy-production bot commented Nov 26, 2025 •

edited

Loading