@cyclonedx/cyclonedx-library/src/validation/jsonValidator.node.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 { OptPlugError } from '../_optPlug.node/errors'
import makeValidator, { type Validator } from '../_optPlug.node/jsonValidator'
import { FILES } from '../resources.node'
import { BaseValidator } from './baseValidator'
import { MissingOptionalDependencyError, NotImplementedError } from './errors'
import type { ValidationError } from './types'

abstract class BaseJsonValidator extends BaseValidator {
  /** @internal */
  protected abstract _getSchemaFile (): string | undefined

  #getSchemaFilePath (): string {
    const s = this._getSchemaFile()
    if (s === undefined) {
      throw new NotImplementedError(this.version)
    }
    return s
  }

  #validatorCache?: Validator = undefined

  async #getValidator (): Promise<Validator> {
    if (this.#validatorCache === undefined) {
      try {
        this.#validatorCache = await makeValidator(this.#getSchemaFilePath(), {
          'http://cyclonedx.org/schema/spdx.SNAPSHOT.schema.json': FILES.SPDX.JSON_SCHEMA,
          'http://cyclonedx.org/schema/jsf-0.82.SNAPSHOT.schema.json': FILES.JSF.JSON_SCHEMA
        })
      } catch (err) {
        if (err instanceof OptPlugError) {
          throw new MissingOptionalDependencyError(err.message, err)
        }
        throw err
      }
    }
    return this.#validatorCache
  }

  /**
   * Validate the data against CycloneDX spec of `this.version`.
   *
   * Promise completes with one of the following:
   * - `null`, when data was valid
   * - {@link Validation.Types.ValidationError | something} representing the error details, when data was invalid representing the error details, when data was invalid
   *
   * Promise rejects with one of the following:
   * - {@link Validation.NotImplementedError | NotImplementedError}, when there is no validator available for `this.version`
   * - {@link Validation.MissingOptionalDependencyError | MissingOptionalDependencyError}, when a required dependency was not installed
   */
  async validate (data: string): Promise<null | ValidationError> {
    return (await this.#getValidator())(data)
  }
}
export class JsonValidator extends BaseJsonValidator {
  /** @internal */
  protected _getSchemaFile (): string | undefined {
    return FILES.CDX.JSON_SCHEMA[this.version]
  }
}

export class JsonStrictValidator extends BaseJsonValidator {
  /** @internal */
  protected _getSchemaFile (): string | undefined {
    return FILES.CDX.JSON_STRICT_SCHEMA[this.version]
  }
}