feat: basic Services

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

Author: jkowalleck

HISTORY.md

@@ -6,6 +6,8 @@ All notable changes to this project will be documented in this file.
 
 <!-- add unreleased items here -->
 
+[#1164]: https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1164
+
 ## 6.11.1 -- 2024-10-24
 
 * Fixed

src/models/bom.ts

@@ -20,12 +20,14 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 import type { PositiveInteger } from '../types/integer'
 import { isPositiveInteger } from '../types/integer'
 import { ComponentRepository } from './component'
+import { ServiceRepository } from './service'
 import { Metadata } from './metadata'
 import { VulnerabilityRepository } from './vulnerability/vulnerability'
 
 export interface OptionalBomProperties {
   metadata?: Bom['metadata']
   components?: Bom['components']
+  services?: Bom['services']
   version?: Bom['version']
   vulnerabilities?: Bom['vulnerabilities']
   serialNumber?: Bom['serialNumber']
@@ -34,6 +36,7 @@ export interface OptionalBomProperties {
 export class Bom {
   metadata: Metadata
   components: ComponentRepository
+  services: ServiceRepository
   vulnerabilities: VulnerabilityRepository
 
   /** @see {@link version} */
@@ -54,6 +57,7 @@ export class Bom {
   constructor (op: OptionalBomProperties = {}) {
     this.metadata = op.metadata ?? new Metadata()
     this.components = op.components ?? new ComponentRepository()
+    this.services= op.services?? new ServiceRepository()
     this.version = op.version ?? this.version
     this.vulnerabilities = op.vulnerabilities ?? new VulnerabilityRepository()
     this.serialNumber = op.serialNumber

src/models/index.ts

@@ -30,6 +30,7 @@ export * from './metadata'
 export * from './organizationalContact'
 export * from './organizationalEntity'
 export * from './property'
+export * from './service'
 export * from './swid'
 export * from './tool'
 export * as Vulnerability from './vulnerability'

src/models/service.ts

@@ -0,0 +1,92 @@
+/*!
+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.
+*/
+
+import {type Comparable, SortableComparables} from "../_helpers/sortable";
+import {BomRef} from "./bomRef";
+import {ExternalReferenceRepository} from "./externalReference";
+import {LicenseRepository} from "./license";
+import type {OrganizationalEntity} from "./organizationalEntity";
+import {PropertyRepository} from "./property";
+
+export interface OptionalToolProperties {
+  provider?: Service['provider']
+}
+
+
+export interface OptionalComponentProperties {
+  bomRef?: BomRef['value']
+  provider?: Service['provider']
+  group?: Service['group']
+  version?: Service['version']
+  description?: Service['description']
+  licenses?: Service['licenses']
+  externalReferences?: Service['externalReferences']
+  services?: Service['services']
+  properties?: Service['properties']
+}
+
+export class Service implements Comparable<Service> {
+  provider?: OrganizationalEntity
+  group?: string
+  name: string
+  version?: string
+  description?: string
+  licenses: LicenseRepository
+  externalReferences: ExternalReferenceRepository
+  services: ServiceRepository
+  properties: PropertyRepository
+
+
+  /** @see {@link bomRef} */
+  readonly #bomRef: BomRef
+
+  constructor(name: Service['name'], op: OptionalComponentProperties = {}) {
+    this.#bomRef = new BomRef(op.bomRef)
+    this.provider = op.provider
+    this.group = op.group
+    this.name = name
+    this.version = op.version
+    this.description = op.description
+    this.licenses = op.licenses ?? new LicenseRepository()
+    this.externalReferences = op.externalReferences ?? new ExternalReferenceRepository()
+    this.services = op.services ?? new ServiceRepository()
+    this.properties = op.properties ?? new PropertyRepository()
+  }
+
+  get bomRef(): BomRef {
+    return this.#bomRef
+  }
+
+  compare(other: Service): number {
+    // The purpose of this method is not to test for equality, but have deterministic comparability.
+    const bomRefCompare = this.bomRef.compare(other.bomRef)
+    if (bomRefCompare !== 0) {
+      return bomRefCompare
+    }
+    /* eslint-disable @typescript-eslint/strict-boolean-expressions -- run compares in weighted order */
+    return (this.group ?? '').localeCompare(other.group ?? '') ||
+      this.name.localeCompare(other.name) ||
+      (this.version ?? '').localeCompare(other.version ?? '')
+    /* eslint-enable  @typescript-eslint/strict-boolean-expressions */
+  }
+
+}
+
+export class ServiceRepository extends SortableComparables<Service> {
+}