rename sub-namespace FromPackageJson -> FromNodePackageJson (#148)

* Deprecated
  * The sub-namespace `FromPackageJson` will be known as `FromNodePackageJson`.
    * `Factories.FromPackageJson` -> `Factories.FromNodePackageJson`
    * `Builders.FromPackageJson` -> `Builders.FromNodePackageJson`

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

Author: jkowalleck

HISTORY.md

@@ -20,9 +20,14 @@ All notable changes to this project will be documented in this file.
     * Method `Factories.PackageUrlFactory.makeFromComponent()` got a new optional parameter `sort`,
       to indicate whether to go the extra mile and bring hashes and qualifiers in alphabetical order.  
       This feature switch is related to reproducible builds.
+* Deprecated
+  * The sub-namespace `FromPackageJson` will be known as `FromNodePackageJson`. (via [#148])
+    * `Factories.FromPackageJson` -> `Factories.FromNodePackageJson`
+    * `Builders.FromPackageJson` -> `Builders.FromNodePackageJson`
 
 [#145]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/145
 [#146]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/146
+[#148]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/148
 
 ## 1.1.0 - 2022-07-29
 

src/builders/fromPackageJson.node.ts renamed to src/builders/fromNodePackageJson.node.ts

@@ -27,13 +27,13 @@ import { PackageJson, splitNameGroup } from '../helpers/packageJson'
  */
 
 export class ToolBuilder {
-  readonly #extRefFactory: Factories.FromPackageJson.ExternalReferenceFactory
+  readonly #extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory
 
-  constructor (extRefFactory: Factories.FromPackageJson.ExternalReferenceFactory) {
+  constructor (extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory) {
     this.#extRefFactory = extRefFactory
   }
 
-  get extRefFactory (): Factories.FromPackageJson.ExternalReferenceFactory {
+  get extRefFactory (): Factories.FromNodePackageJson.ExternalReferenceFactory {
     return this.#extRefFactory
   }
 
@@ -54,18 +54,18 @@ export class ToolBuilder {
 }
 
 export class ComponentBuilder {
-  readonly #extRefFactory: Factories.FromPackageJson.ExternalReferenceFactory
+  readonly #extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory
   readonly #licenseFactory: Factories.LicenseFactory
 
   constructor (
-    extRefFactory: Factories.FromPackageJson.ExternalReferenceFactory,
+    extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory,
     licenseFactory: Factories.LicenseFactory
   ) {
     this.#extRefFactory = extRefFactory
     this.#licenseFactory = licenseFactory
   }
 
-  get extRefFactory (): Factories.FromPackageJson.ExternalReferenceFactory {
+  get extRefFactory (): Factories.FromNodePackageJson.ExternalReferenceFactory {
     return this.#extRefFactory
   }
 

src/builders/index.node.ts

@@ -17,4 +17,6 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
-export * as FromPackageJson from './fromPackageJson.node'
+export * as FromNodePackageJson from './fromNodePackageJson.node'
+/** @deprecated use {@see FromNodePackageJson} instead of {@see FromPackageJson} */
+export * as FromPackageJson from './fromNodePackageJson.node'

src/factories/fromPackageJson.node.ts renamed to src/factories/fromNodePackageJson.node.ts

@@ -19,4 +19,6 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 export * from './index.common'
 
-export * as FromPackageJson from './fromPackageJson.node'
+export * as FromNodePackageJson from './fromNodePackageJson.node'
+/** @deprecated use {@see FromNodePackageJson} instead of {@see FromPackageJson} */
+export * as FromPackageJson from './fromNodePackageJson.node'

src/factories/index.node.ts

@@ -25,13 +25,13 @@ const {
   Enums,
   Models,
   Factories,
-  Builders: { FromPackageJson: { ComponentBuilder } }
+  Builders: { FromNodePackageJson: { ComponentBuilder } }
 } = require('../../')
 
-suite('Builders.FromPackageJson.ComponentBuilder', () => {
+suite('Builders.FromNodePackageJson.ComponentBuilder', () => {
   const salt = Math.random()
 
-  const extRefFactory = new Factories.FromPackageJson.ExternalReferenceFactory()
+  const extRefFactory = new Factories.FromNodePackageJson.ExternalReferenceFactory()
   extRefFactory.makeExternalReferences = () => [`FAKE REFERENCES ${salt}`]
   const licenseFactory = new Factories.LicenseFactory()
   licenseFactory.makeFromString = () => `FAKE LICENSE ${salt}`

tests/integration/Builders.FromPackageJson.ComponentBuilder.test.js renamed to tests/integration/Builders.FromNodePackageJson.ComponentBuilder.test.js

@@ -24,13 +24,13 @@ const { suite, test } = require('mocha')
 const {
   Models,
   Factories,
-  Builders: { FromPackageJson: { ToolBuilder } }
+  Builders: { FromNodePackageJson: { ToolBuilder } }
 } = require('../../')
 
-suite('Builders.FromPackageJson.ToolBuilder', () => {
+suite('Builders.FromNodePackageJson.ToolBuilder', () => {
   const salt = Math.random()
 
-  const extRefFactory = new Factories.FromPackageJson.ExternalReferenceFactory()
+  const extRefFactory = new Factories.FromNodePackageJson.ExternalReferenceFactory()
   extRefFactory.makeExternalReferences = () => [`FAKE REFERENCES ${salt}`]
 
   const sut = new ToolBuilder(extRefFactory)

tests/integration/Builders.FromPackageJson.ToolBuilders.test.js renamed to tests/integration/Builders.FromNodePackageJson.ToolBuilders.test.js

@@ -24,10 +24,10 @@ const { suite, test } = require('mocha')
 const {
   Enums: { ExternalReferenceType },
   Models: { ExternalReference },
-  Factories: { FromPackageJson: { ExternalReferenceFactory } }
+  Factories: { FromNodePackageJson: { ExternalReferenceFactory } }
 } = require('../../')
 
-suite('Factories.FromPackageJson.ExternalReferenceFactory', () => {
+suite('Factories.FromNodePackageJson.ExternalReferenceFactory', () => {
   const sut = new ExternalReferenceFactory()
 
   suite('from "homepage"', () => {

tests/integration/Factories.FromPackageJson.ExternalReferenceFactory.test.js renamed to tests/integration/Factories.FromNodePackageJson.ExternalReferenceFactory.test.js

@@ -22,14 +22,14 @@ const assert = require('assert')
 const { suite, test } = require('mocha')
 
 const {
-  Builders: { FromPackageJson: { ComponentBuilder } },
+  Builders: { FromNodePackageJson: { ComponentBuilder } },
   Factories: {
-    FromPackageJson: { ExternalReferenceFactory },
+    FromNodePackageJson: { ExternalReferenceFactory },
     LicenseFactory
   }
 } = require('../../')
 
-suite('Builders.FromPackageJson.ToolBuilder', () => {
+suite('Builders.FromNodePackageJson.ToolBuilder', () => {
   test('construct', () => {
     const extRefFactory = new ExternalReferenceFactory()
     const licenseFactory = new LicenseFactory()

tests/unit/Builders.FromPackageJson.ComponentBuilder.spec.js renamed to tests/unit/Builders.FromNodePackageJson.ComponentBuilder.spec.js

@@ -22,11 +22,11 @@ const assert = require('assert')
 const { suite, test } = require('mocha')
 
 const {
-  Builders: { FromPackageJson: { ToolBuilder } },
-  Factories: { FromPackageJson: { ExternalReferenceFactory } }
+  Builders: { FromNodePackageJson: { ToolBuilder } },
+  Factories: { FromNodePackageJson: { ExternalReferenceFactory } }
 } = require('../../')
 
-suite('Builders.FromPackageJson.ToolBuilder', () => {
+suite('Builders.FromNodePackageJson.ToolBuilder', () => {
   test('construct', () => {
     const extRefFactory = new ExternalReferenceFactory()