@cyclonedx/cyclonedx-library/src/models/bom.ts

Core functionality of CycloneDX for JavaScript (Node.js or WebBrowser).

/*!
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 { PositiveInteger } from '../types/integer'
import { isPositiveInteger } from '../types/integer'
import { ComponentRepository } from './component'
import { Metadata } from './metadata'
import { ServiceRepository } from './service'
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']
}

export class Bom {
  metadata: Metadata
  components: ComponentRepository
  services: ServiceRepository
  vulnerabilities: VulnerabilityRepository

  /** @see {@link version} */
  #version: PositiveInteger = 1

  /** @see {@link serialNumber} */
  #serialNumber?: string

  // Property `bomFormat` is not part of model, it is runtime information.
  // Property `specVersion` is not part of model, it is runtime information.

  // Property `dependencies` is not part of this model, but part of `Component` and other models.
  // The dependency graph can be normalized on render-time, no need to store it in the bom model.

  /**
   * @throws {@link TypeError} if `op.version` is neither {@link PositiveInteger} nor `undefined`
   */
  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
  }

  get version (): PositiveInteger {
    return this.#version
  }

  /**
   * @throws {@link TypeError} if value is not {@link PositiveInteger}
   */
  set version (value: PositiveInteger) {
    if (!isPositiveInteger(value)) {
      throw new TypeError('Not PositiveInteger')
    }
    this.#version = value
  }

  get serialNumber (): string | undefined {
    return this.#serialNumber
  }

  set serialNumber (value: string | undefined) {
    this.#serialNumber = value === ''
      ? undefined
      : value
  }
}