style: streamline readability of constructor param types

HISTORY.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Misc
+  * Improved readability of constructor parameter types. (via [#166]) 
+
+[#166]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/166
+
 ## 1.3.1 - 2022-08-04
 
 * Fixed

src/builders/fromNodePackageJson.node.ts

@@ -29,7 +29,7 @@ import { PackageJson, splitNameGroup } from '../helpers/packageJson'
 export class ToolBuilder {
   readonly #extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory
 
-  constructor (extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory) {
+  constructor (extRefFactory: ToolBuilder['extRefFactory']) {
     this.#extRefFactory = extRefFactory
   }
 
@@ -58,8 +58,8 @@ export class ComponentBuilder {
   readonly #licenseFactory: Factories.LicenseFactory
 
   constructor (
-    extRefFactory: Factories.FromNodePackageJson.ExternalReferenceFactory,
-    licenseFactory: Factories.LicenseFactory
+    extRefFactory: ComponentBuilder['extRefFactory'],
+    licenseFactory: ComponentBuilder['licenseFactory']
   ) {
     this.#extRefFactory = extRefFactory
     this.#licenseFactory = licenseFactory

src/factories/license.ts

@@ -24,7 +24,7 @@ export class LicenseFactory {
   makeFromString (value: string): License {
     try {
       return this.makeExpression(value)
-    } catch (Error) {
+    } catch {
       return this.makeDisjunctive(value)
     }
   }
@@ -39,7 +39,7 @@ export class LicenseFactory {
   makeDisjunctive (value: string): DisjunctiveLicense {
     try {
       return this.makeDisjunctiveWithId(value)
-    } catch (error) {
+    } catch {
       return this.makeDisjunctiveWithName(value)
     }
   }

src/factories/packageUrl.ts

@@ -24,7 +24,7 @@ import { ExternalReferenceType } from '../enums'
 export class PackageUrlFactory {
   readonly #type: PackageURL['type']
 
-  constructor (type: PackageURL['type']) {
+  constructor (type: PackageUrlFactory['type']) {
     this.#type = type
   }
 

src/models/attachment.ts

@@ -29,7 +29,7 @@ export class Attachment {
   content: string
   encoding?: AttachmentEncoding
 
-  constructor (content: string, op: OptionalProperties = {}) {
+  constructor (content: Attachment['content'], op: OptionalProperties = {}) {
     this.contentType = op.contentType
     this.content = content
     this.encoding = op.encoding

src/models/bom.ts

@@ -45,7 +45,7 @@ export class Bom {
   // The dependency graph can be normalized on render-time, no need to store it in the bom model.
 
   /**
-   * @throws {TypeError} if {@see op.version} is not {@see PositiveInteger} nor {@see undefined}
+   * @throws {TypeError} if {@see op.version} is neither {@see PositiveInteger} nor {@see undefined}
    * @throws {TypeError} if {@see op.serialNumber} is neither {@see UrnUuid} nor {@see undefined}
    */
   constructor (op: OptionalProperties = {}) {

src/models/bomRef.ts

@@ -24,12 +24,12 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 export class BomRef {
   value?: string
 
-  constructor (value?: string) {
+  constructor (value?: BomRef['value']) {
     this.value = value
   }
 
   compare (other: BomRef): number {
-    return (this.toString()).localeCompare(other.toString())
+    return this.toString().localeCompare(other.toString())
   }
 
   toString (): string {

src/models/externalReference.ts

@@ -29,7 +29,7 @@ export class ExternalReference implements Comparable {
   type: ExternalReferenceType
   comment?: string
 
-  constructor (url: URL | string, type: ExternalReferenceType, op: OptionalProperties = {}) {
+  constructor (url: ExternalReference['url'], type: ExternalReference['type'], op: OptionalProperties = {}) {
     this.url = url
     this.type = type
     this.comment = op.comment

src/models/license.ts

@@ -35,7 +35,7 @@ export class LicenseExpression {
   /**
    * @throws {RangeError} if {@see expression} is not eligible({@see LicenseExpression.isEligibleExpression})
    */
-  constructor (expression: string) {
+  constructor (expression: LicenseExpression['expression']) {
     this.expression = expression
   }
 
@@ -68,7 +68,7 @@ export class NamedLicense {
   text?: Attachment
   url?: URL | string
 
-  constructor (name: string, op: NamedLicenseOptionalProperties = {}) {
+  constructor (name: NamedLicense['name'], op: NamedLicenseOptionalProperties = {}) {
     this.name = name
     this.text = op.text
     this.url = op.url
@@ -94,7 +94,7 @@ export class SpdxLicense {
   /**
    * @throws {RangeError} if {@see id} is not supported SPDX id({@see isSupportedSpdxId})
    */
-  constructor (id: SpdxId, op: SpdxLicenseOptionalProperties = {}) {
+  constructor (id: SpdxLicense['id'], op: SpdxLicenseOptionalProperties = {}) {
     this.id = id
     this.text = op.text
     this.url = op.url

src/models/swid.ts

@@ -45,7 +45,7 @@ export class SWID {
   /**
    * @throws {TypeError} if {@see op.tagVersion} is neither {@see NonNegativeInteger} nor {@see undefined}
    */
-  constructor (tagId: string, name: string, op: OptionalProperties = {}) {
+  constructor (tagId: SWID['tagId'], name: SWID['name'], op: OptionalProperties = {}) {
     this.tagId = tagId
     this.name = name
     this.version = op.version

src/serialize/json/normalize.ts

@@ -28,7 +28,7 @@ import { treeIterator } from '../../helpers/tree'
 export class Factory {
   readonly #spec: Spec
 
-  constructor (spec: Spec) {
+  constructor (spec: Factory['spec']) {
     this.#spec = spec
   }
 
@@ -104,7 +104,7 @@ interface Normalizer {
 abstract class Base implements Normalizer {
   protected readonly _factory: Factory
 
-  constructor (factory: Factory) {
+  constructor (factory: Base['factory']) {
     this._factory = factory
   }
 
@@ -203,7 +203,8 @@ export class HashNormalizer extends Base {
       options.sortLists ?? false
         ? data.sorted()
         : Array.from(data)
-    ).map(h => this.normalize(h, options)
+    ).map(
+      h => this.normalize(h, options)
     ).filter(isNotUndefined)
   }
 }
@@ -295,7 +296,8 @@ export class ComponentNormalizer extends Base {
       options.sortLists ?? false
         ? data.sorted()
         : Array.from(data)
-    ).map(c => this.normalize(c, options)
+    ).map(
+      c => this.normalize(c, options)
     ).filter(isNotUndefined)
   }
 }
@@ -389,7 +391,8 @@ export class ExternalReferenceNormalizer extends Base {
       options.sortLists ?? false
         ? data.sorted()
         : Array.from(data)
-    ).map(r => this.normalize(r, options)
+    ).map(
+      r => this.normalize(r, options)
     ).filter(isNotUndefined)
   }
 }

src/serialize/jsonSerializer.ts

@@ -33,7 +33,7 @@ export class JsonSerializer extends BaseSerializer<Normalized.Bom> {
   /**
    * @throws {UnsupportedFormatError} if {@see normalizerFactory.spec} does not support {@see Format.JSON}.
    */
-  constructor (normalizerFactory: NormalizerFactory) {
+  constructor (normalizerFactory: JsonSerializer['normalizerFactory']) {
     if (!normalizerFactory.spec.supportsFormat(Format.JSON)) {
       throw new UnsupportedFormatError('Spec does not support JSON format.')
     }

src/serialize/xml/normalize.ts

@@ -28,7 +28,7 @@ import { treeIterator } from '../../helpers/tree'
 export class Factory {
   readonly #spec: Spec
 
-  constructor (spec: Spec) {
+  constructor (spec: Factory['spec']) {
     this.#spec = spec
   }
 
@@ -104,7 +104,7 @@ interface Normalizer {
 abstract class Base implements Normalizer {
   protected readonly _factory: Factory
 
-  constructor (factory: Factory) {
+  constructor (factory: Base['factory']) {
     this._factory = factory
   }
 
@@ -260,7 +260,8 @@ export class HashNormalizer extends Base {
       options.sortLists ?? false
         ? data.sorted()
         : Array.from(data)
-    ).map(h => this.normalize(h, options, elementName)
+    ).map(
+      h => this.normalize(h, options, elementName)
     ).filter(isNotUndefined)
   }
 }
@@ -392,7 +393,8 @@ export class ComponentNormalizer extends Base {
       options.sortLists ?? false
         ? data.sorted()
         : Array.from(data)
-    ).map(c => this.normalize(c, options, elementName)
+    ).map(
+      c => this.normalize(c, options, elementName)
     ).filter(isNotUndefined)
   }
 }
@@ -510,7 +512,8 @@ export class ExternalReferenceNormalizer extends Base {
       options.sortLists ?? false
         ? data.sorted()
         : Array.from(data)
-    ).map(r => this.normalize(r, options, elementName)
+    ).map(
+      r => this.normalize(r, options, elementName)
     ).filter(isNotUndefined)
   }
 }

src/serialize/xmlBaseSerializer.ts

@@ -33,7 +33,7 @@ export abstract class XmlBaseSerializer extends BaseSerializer<SimpleXml.Element
   /**
    * @throws {UnsupportedFormatError} if {@see normalizerFactory.spec} does not support {@see Format.XML}.
    */
-  constructor (normalizerFactory: NormalizerFactory) {
+  constructor (normalizerFactory: XmlBaseSerializer['normalizerFactory']) {
     if (!normalizerFactory.spec.supportsFormat(Format.JSON)) {
       throw new UnsupportedFormatError('Spec does not support JSON format.')
     }