@cyclonedx/cyclonedx-library/src/factories/packageUrl.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 { PackageURL, PurlQualifierNames } from 'packageurl-js'

import { ExternalReferenceType } from '../enums/externalReferenceType'
import type { Component } from '../models/component'

export class PackageUrlFactory<PurlType extends PackageURL['type'] = PackageURL['type']> {
  readonly #type: PurlType

  constructor (type: PurlType) {
    this.#type = type
  }

  get type (): PurlType {
    return this.#type
  }

  /* eslint-disable-next-line @typescript-eslint/no-inferrable-types -- docs */
  makeFromComponent (component: Component, sort: boolean = false): PackageURL | undefined {
    const qualifiers: PackageURL['qualifiers'] = {}
    /* @ts-expect-error TS2322 */
    qualifiers.__proto__ = null /* eslint-disable-line no-proto -- intended */
    let subpath: PackageURL['subpath'] = undefined

    // sorting to allow reproducibility: use the last instance for a `extRef.type`, if multiples exist
    const extRefs = sort
      ? component.externalReferences.sorted()
      : component.externalReferences
    for (const extRef of extRefs) {
      const url = extRef.url.toString()
      if (url.length <= 0) {
        continue
      }
      // No further need for validation.
      // According to https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst
      // there is no formal requirement to a `..._url`.
      // Everything is possible: URL-encoded, not encoded, with schema, without schema
      /* eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check -- intended */
      switch (extRef.type) {
        case ExternalReferenceType.VCS:
          [qualifiers[PurlQualifierNames.VcsUrl], subpath] = url.split('#', 2)
          break
        case ExternalReferenceType.Distribution:
          qualifiers[PurlQualifierNames.DownloadUrl] = url
          break
      }
    }

    const hashes = component.hashes
    if (hashes.size > 0) {
      qualifiers[PurlQualifierNames.Checksum] = Array.from(
        sort
          ? hashes.sorted()
          : hashes,
        ([hashAlgo, hashCont]) => `${hashAlgo.toLowerCase()}:${hashCont.toLowerCase()}`
      ).join(',')
    }

    try {
      // Do not beautify the parameters here, because that is in the domain of PackageURL and its representation.
      // No need to convert an empty "subpath" string to `undefined` and such.
      return new PackageURL(
        this.#type,
        component.group,
        component.name,
        component.version,
        qualifiers,
        subpath
      )
    } catch {
      return undefined
    }
  }
}