sbom.js

import CycloneDxSbom from "./cyclone_dx_sbom.js";

export default class Sbom {
	sbomModel
	#startTime
	#endTime
	constructor() {
		if (process.env["EXHORT_DEBUG"] === "true") {
			this.#startTime = new Date()
			console.log("Starting time to create sbom = " + this.#startTime)
		}
		this.sbomModel = new CycloneDxSbom()
	}

	/**
	 * @param {PackageURL} root - add main/root component for sbom
	 * @return Sbom
	 */
	addRoot (root) {
		return this.sbomModel.addRoot(root)
	}

	/**
	 * @return {{{"bom-ref": string, name, purl: string, type, version}}} root component of sbom.
	 */
	getRoot (){
		return this.sbomModel.getRoot()
	}

	/**
	 * This method gets an array of dependencies to be ignored, and remove all of them from sbom
	 * @param {Array} dependencies to be removed from sbom
	 * @return {Sbom} without ignored dependencies
	 */
	filterIgnoredDeps(deps){
		return this.sbomModel.filterIgnoredDeps(deps)
	}

	/**
	 * This method gets an array of dependencies with versions( purl string format) to be ignored, and remove all of them from CycloneDx Sbom
	 * @param {Array} dependencies to be removed from sbom
	 * @return {CycloneDxSbom} without ignored dependencies
	 */
	filterIgnoredDepsIncludingVersion(deps) {
		return this.sbomModel.filterIgnoredDepsIncludingVersion(deps)
	}
	/**
	 * @param {component} sourceRef current source Component ( Starting from root component by clients)
	 * @param {PackageURL} targetRef current dependency to add to Dependencies list of component sourceRef
	 * @return Sbom
	 */
	addDependency(sourceRef, targetRef){
		return this.sbomModel.addDependency(sourceRef,targetRef)
	}

	/**
	 * @return String sbom json in a string format
	 */
	getAsJsonString(opts = {}){
		if (process.env["EXHORT_DEBUG"] === "true") {
			this.#endTime = new Date()
			console.log("Ending time to create sbom = " + this.#endTime)
			let time = (this.#endTime - this.#startTime) / 1000
			console.log("Total time in seconds to create sbom = " + time)
		}
		return this.sbomModel.getAsJsonString(opts)
	}

	/**
	 * This method gets a PackageUrl, and returns a Component of Sbom
	 * @param purl {PackageURL}
	 * @return component
	 */
	purlToComponent(purl){
		return this.sbomModel.purlToComponent(purl)
	}

	/** This method gets a component object, and a string name, and checks if the name is a substring of the component' purl.
	 * @param {} component to search in its dependencies
	 * @param {String} name to be checked.
	 *
	 * @return {boolean}
	 */
	checkIfPackageInsideDependsOnList(component, name)
	{
		return this.sbomModel.checkIfPackageInsideDependsOnList(component,name)
	}

	/** Removes the root component from the sbom
	 */
	removeRootComponent()
	{
		return this.sbomModel.removeRootComponent()
	}

}