cdx1.5 dev update existing simple models (#835)

* cdx1.5 simple model updates

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

* cs-fix

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

---------

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

Author: jkowalleck

src/models/license.ts

@@ -20,6 +20,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 import type { Sortable } from '../_helpers/sortable'
 import type { SpdxId } from '../spdx'
 import type { Attachment } from './attachment'
+import { BomRef } from './bomRef'
 
 /**
  * (SPDX) License Expression.
@@ -59,10 +60,12 @@ export class LicenseExpression {
 }
 
 class DisjunctiveLicenseBase {
+  bomRef: BomRef
   text?: Attachment
   #url?: URL | string
 
   constructor (op: OptionalDisjunctiveLicenseProperties = {}) {
+    this.bomRef = new BomRef(op.bomRef)
     this.text = op.text
     this.url = op.url
   }
@@ -79,6 +82,7 @@ class DisjunctiveLicenseBase {
 }
 
 interface OptionalDisjunctiveLicenseProperties {
+  bomRef?: BomRef['value']
   text?: DisjunctiveLicenseBase['text']
   url?: DisjunctiveLicenseBase['url']
 }
@@ -94,7 +98,10 @@ export class NamedLicense extends DisjunctiveLicenseBase {
   }
 
   compare (other: NamedLicense): number {
-    return this.name.localeCompare(other.name)
+    /* eslint-disable @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
+    return this.name.localeCompare(other.name) ||
+      this.bomRef.compare(other.bomRef)
+    /* eslint-enable @typescript-eslint/strict-boolean-expressions */
   }
 }
 
@@ -134,7 +141,10 @@ export class SpdxLicense extends DisjunctiveLicenseBase {
   }
 
   compare (other: SpdxLicense): number {
-    return this.#id.localeCompare(other.#id)
+    /* eslint-disable @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
+    return this.#id.localeCompare(other.#id) ||
+      this.bomRef.compare(other.bomRef)
+    /* eslint-enable @typescript-eslint/strict-boolean-expressions */
   }
 }
 

src/models/organizationalContact.ts

@@ -19,19 +19,23 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 import type { Comparable } from '../_helpers/sortable'
 import { SortableComparables } from '../_helpers/sortable'
+import { BomRef } from './bomRef'
 
 export interface OptionalOrganizationalContactProperties {
+  bomRef?: BomRef['value']
   name?: OrganizationalContact['name']
   email?: OrganizationalContact['email']
   phone?: OrganizationalContact['phone']
 }
 
 export class OrganizationalContact implements Comparable<OrganizationalContact> {
+  bomRef: BomRef
   name?: string
   email?: string
   phone?: string
 
   constructor (op: OptionalOrganizationalContactProperties = {}) {
+    this.bomRef = new BomRef(op.bomRef)
     this.name = op.name
     this.email = op.email
     this.phone = op.phone
@@ -41,7 +45,8 @@ export class OrganizationalContact implements Comparable<OrganizationalContact>
     /* eslint-disable @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
     return (this.name ?? '').localeCompare(other.name ?? '') ||
       (this.email ?? '').localeCompare(other.email ?? '') ||
-      (this.phone ?? '').localeCompare(other.phone ?? '')
+      (this.phone ?? '').localeCompare(other.phone ?? '') ||
+      this.bomRef.compare(other.bomRef)
     /* eslint-enable @typescript-eslint/strict-boolean-expressions */
   }
 }

src/models/organizationalEntity.ts

@@ -19,20 +19,24 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 import type { Comparable } from '../_helpers/sortable'
 import { SortableComparables, SortableStringables } from '../_helpers/sortable'
+import { BomRef } from './bomRef'
 import { OrganizationalContactRepository } from './organizationalContact'
 
 export interface OptionalOrganizationalEntityProperties {
+  bomRef?: BomRef['value']
   name?: OrganizationalEntity['name']
   url?: OrganizationalEntity['url']
   contact?: OrganizationalEntity['contact']
 }
 
 export class OrganizationalEntity implements Comparable<OrganizationalEntity> {
+  bomRef: BomRef
   name?: string
   url: Set<URL | string>
   contact: OrganizationalContactRepository
 
   constructor (op: OptionalOrganizationalEntityProperties = {}) {
+    this.bomRef = new BomRef(op.bomRef)
     this.name = op.name
     this.url = op.url ?? new Set()
     this.contact = op.contact ?? new OrganizationalContactRepository()
@@ -42,7 +46,8 @@ export class OrganizationalEntity implements Comparable<OrganizationalEntity> {
     /* eslint-disable @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
     return (this.name ?? '').localeCompare(other.name ?? '') ||
       this.contact.compare(other.contact) ||
-      (new SortableStringables(this.url)).compare(new SortableStringables(other.url))
+      (new SortableStringables(this.url)).compare(new SortableStringables(other.url)) ||
+      this.bomRef.compare(other.bomRef)
     /* eslint-enable @typescript-eslint/strict-boolean-expressions */
   }
 }

src/types/bomLink.ts

@@ -0,0 +1,39 @@
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+/** @see {@link isBomLinkDocument} */
+export type BomLinkDocument = string
+/** @see {@link isBomLinkElement} */
+export type BomLinkElement = string
+/** @see {@link https://cyclonedx.org/capabilities/bomlink/} */
+export type BomLink = BomLinkDocument | BomLinkElement
+
+/* regular expressions were taken from the CycloneDX schema definitions. */
+const bomLinkDocumentPattern = /urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/[1-9][0-9]*/
+const bomLinkElementPattern = /urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/[1-9][0-9]*#.+/
+
+export function isBomLinkDocument (value: any): value is BomLinkDocument {
+  return typeof value === 'string' &&
+    bomLinkDocumentPattern.test(value)
+}
+
+export function isBomLinkElement (value: any): value is BomLinkElement {
+  return typeof value === 'string' &&
+    bomLinkElementPattern.test(value)
+}

src/types/index.ts

@@ -17,6 +17,7 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
+export * from './bomLink'
 export * from './cpe'
 export * from './cwe'
 export * from './integer'