renamed HashRepository -> HashDictionary (#229)

rename HashRepository -> HashDictionary

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

Author: jkowalleck

HISTORY.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+## 1.5.0 - 2022-09-17
+
+* Deprecated
+  * The class `HashRepository` will be known as `HashDictionary`. (via [#229])
+
+[#229]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/229
+
 ## 1.4.2 - 2022-09-10
 
 Maintenance release.
@@ -196,7 +203,7 @@ Initial release.
     * `BomRef`, `BomRefRepository`
     * `Component`, `ComponentRepository`
     * `ExternalReference`, `ExternalReferenceRepository`
-    * `HashContent`, `Hash`, `HashRepository`
+    * `HashContent`, `Hash`, `HashDictionary`
     * `LicenseExpression`, `NamedLicense`, `SpdxLicense`, `LicenseRepository`
     * `Metadata`
     * `OrganizationalContact`, `OrganizationalContactRepository`

README.md

@@ -44,7 +44,7 @@ written in _TypeScript_ and compiled for the target.
   * `BomRef`, `BomRefRepository`
   * `Component`, `ComponentRepository`
   * `ExternalReference`, `ExternalReferenceRepository`
-  * `Hash`, `HashRepository`, `HashContent`
+  * `Hash`, `HashDictionary`, `HashContent`
   * `LicenseExpression`, `NamedLicense`, `SpdxLicense`, `LicenseRepository`
   * `Metadata`
   * `OrganizationalContact`, `OrganizationalContactRepository`

src/models/component.ts

@@ -25,7 +25,7 @@ import { treeIteratorSymbol } from '../helpers/tree'
 import { CPE, isCPE } from '../types'
 import { BomRef, BomRefRepository } from './bomRef'
 import { ExternalReferenceRepository } from './externalReference'
-import { HashRepository } from './hash'
+import { HashDictionary } from './hash'
 import { LicenseRepository } from './license'
 import { OrganizationalEntity } from './organizationalEntity'
 import { PropertyRepository } from './property'
@@ -60,7 +60,7 @@ export class Component implements Comparable {
   description?: string
   externalReferences: ExternalReferenceRepository
   group?: string
-  hashes: HashRepository
+  hashes: HashDictionary
   licenses: LicenseRepository
   publisher?: string
   purl?: PackageURL
@@ -90,7 +90,7 @@ export class Component implements Comparable {
     this.copyright = op.copyright
     this.externalReferences = op.externalReferences ?? new ExternalReferenceRepository()
     this.group = op.group
-    this.hashes = op.hashes ?? new HashRepository()
+    this.hashes = op.hashes ?? new HashDictionary()
     this.licenses = op.licenses ?? new LicenseRepository()
     this.publisher = op.publisher
     this.purl = op.purl

src/models/hash.ts

@@ -23,20 +23,25 @@ import { HashAlgorithm } from '../enums'
 export type HashContent = string
 
 export type Hash = readonly [
-  // order matters: it must reflect [key, value] of HashRepository -
-  // this way a HashRepository can be constructed from multiple Hash objects.
+  // order matters: it must reflect [key, value] of HashDictionary -
+  // this way a HashDictionary can be constructed from multiple Hash objects.
   algorithm: HashAlgorithm,
   content: HashContent
 ]
 
-export class HashRepository extends Map<Hash[0], Hash[1]> {
+/** @since 1.5.0 */
+export class HashDictionary extends Map<Hash[0], Hash[1]> {
   #compareItems ([a1, c1]: Hash, [a2, c2]: Hash): number {
-    /* eslint-disable-next-line @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
+    /* eslint-disable @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
     return a1.localeCompare(a2) ||
       c1.localeCompare(c2)
+    /* eslint-enable @typescript-eslint/strict-boolean-expressions */
   }
 
   sorted (): Hash[] {
     return Array.from(this.entries()).sort(this.#compareItems)
   }
 }
+
+/** @deprecated use {@see HashDictionary} instead of {@link HashRepository} */
+export class HashRepository extends HashDictionary {}

src/models/tool.ts

@@ -19,7 +19,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 import { Comparable, SortableSet } from '../helpers/sortableSet'
 import { ExternalReferenceRepository } from './externalReference'
-import { HashRepository } from './hash'
+import { HashDictionary } from './hash'
 
 interface OptionalProperties {
   vendor?: Tool['vendor']
@@ -33,14 +33,14 @@ export class Tool implements Comparable {
   vendor?: string
   name?: string
   version?: string
-  hashes: HashRepository
+  hashes: HashDictionary
   externalReferences: ExternalReferenceRepository
 
   constructor (op: OptionalProperties = {}) {
     this.vendor = op.vendor
     this.name = op.name
     this.version = op.version
-    this.hashes = op.hashes ?? new HashRepository()
+    this.hashes = op.hashes ?? new HashDictionary()
     this.externalReferences = op.externalReferences ?? new ExternalReferenceRepository()
   }
 

src/serialize/json/normalize.ts

@@ -198,7 +198,7 @@ export class HashNormalizer extends Base {
       : undefined
   }
 
-  normalizeRepository (data: Models.HashRepository, options: NormalizerOptions): Normalized.Hash[] {
+  normalizeRepository (data: Models.HashDictionary, options: NormalizerOptions): Normalized.Hash[] {
     return (
       options.sortLists ?? false
         ? data.sorted()

src/serialize/xml/normalize.ts

@@ -255,7 +255,7 @@ export class HashNormalizer extends Base {
       : undefined
   }
 
-  normalizeRepository (data: Models.HashRepository, options: NormalizerOptions, elementName: string): SimpleXml.Element[] {
+  normalizeRepository (data: Models.HashDictionary, options: NormalizerOptions, elementName: string): SimpleXml.Element[] {
     return (
       options.sortLists ?? false
         ? data.sorted()

tests/_data/models.js

@@ -38,7 +38,7 @@ module.exports.createComplexStructure = function () {
           vendor: 'tool vendor',
           name: 'tool name',
           version: '0.8.15',
-          hashes: new Models.HashRepository([
+          hashes: new Models.HashDictionary([
             [Enums.HashAlgorithm.MD5, 'f32a26e2a3a8aa338cd77b6e1263c535'],
             [Enums.HashAlgorithm['SHA-1'], '829c3804401b0727f70f73d4415e162400cbe57b']
           ])

tests/integration/Factories.FromNodePackageJson.PackageUrlFactory.test.js

@@ -199,7 +199,7 @@ suite('Factories.FromNodePackageJson.PackageUrlFactory', () => {
             new Models.ExternalReference('', Enums.ExternalReferenceType.VCS),
             new Models.ExternalReference('', Enums.ExternalReferenceType.Distribution)
           ]),
-          hashes: new Models.HashRepository([
+          hashes: new Models.HashDictionary([
             [Enums.HashAlgorithm['SHA-256'], 'C3AB8FF13720E8AD9047DD39466B3C8974E592C2FA383D4A3960714CAEF0C4F2']
           ])
         }
@@ -219,7 +219,7 @@ suite('Factories.FromNodePackageJson.PackageUrlFactory', () => {
           externalReferences: new Models.ExternalReferenceRepository([
             new Models.ExternalReference('git+https://foo.bar/repo.git', Enums.ExternalReferenceType.VCS)
           ]),
-          hashes: new Models.HashRepository([
+          hashes: new Models.HashDictionary([
             [Enums.HashAlgorithm['SHA-256'], 'C3AB8FF13720E8AD9047DD39466B3C8974E592C2FA383D4A3960714CAEF0C4F2']
           ])
         }
@@ -239,7 +239,7 @@ suite('Factories.FromNodePackageJson.PackageUrlFactory', () => {
           externalReferences: new Models.ExternalReferenceRepository([
             new Models.ExternalReference('git+https://foo.bar/repo.git', Enums.ExternalReferenceType.VCS)
           ]),
-          hashes: new Models.HashRepository([
+          hashes: new Models.HashDictionary([
             [Enums.HashAlgorithm['SHA-256'], 'C3AB8FF13720E8AD9047DD39466B3C8974E592C2FA383D4A3960714CAEF0C4F2'],
             [Enums.HashAlgorithm.BLAKE3, 'aa51dcd43d5c6c5203ee16906fd6b35db298b9b2e1de3fce81811d4806b76b7d']
           ])

tests/integration/Factories.PackageUrlFactory.test.js

@@ -140,7 +140,7 @@ suite('Factories.PackageUrlFactory', () => {
         Enums.ComponentType.Library,
         `name-${salt}`,
         {
-          hashes: new Models.HashRepository([
+          hashes: new Models.HashDictionary([
             [Enums.HashAlgorithm['SHA-256'], 'C3AB8FF13720E8AD9047DD39466B3C8974E592C2FA383D4A3960714CAEF0C4F2']
           ])
         }
@@ -161,7 +161,7 @@ suite('Factories.PackageUrlFactory', () => {
             new Models.ExternalReference('git+https://foo.bar/repo.git', Enums.ExternalReferenceType.VCS),
             new Models.ExternalReference('https://foo.bar/download', Enums.ExternalReferenceType.Distribution)
           ]),
-          hashes: new Models.HashRepository([
+          hashes: new Models.HashDictionary([
             [Enums.HashAlgorithm['SHA-256'], 'C3AB8FF13720E8AD9047DD39466B3C8974E592C2FA383D4A3960714CAEF0C4F2'],
             [Enums.HashAlgorithm.BLAKE3, 'aa51dcd43d5c6c5203ee16906fd6b35db298b9b2e1de3fce81811d4806b76b7d']
           ])