@cyclonedx/cyclonedx-library/src/types/nodePackageJson.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.
*/

/**
 * Intended to represent normalized data structures
 * based on [PackageJson spec](https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/package.json)
 * and explained by [PackageJson description](https://docs.npmjs.com/cli/v9/configuring-npm/package-json).
 *
 * Normalization should be done downstream, for example
 * via [`normalize-package-data`](https://www.npmjs.com/package/normalize-package-data).
 */
export interface NodePackageJson {
  name?: string
  version?: string
  description?: string
  license?: string
  licenses?: Array<{
    type?: string
    url?: string
  }>
  author?: string | {
    name?: string
    email?: string
  }
  bugs?: string | {
    url?: string
  }
  homepage?: string
  repository?: string | {
    type?: string
    url?: string
    directory?: string
  }
  // ... to be continued
  dist?: any // see https://github.com/CycloneDX/cyclonedx-node-npm/issues/1300
}

/**
 *
 * Not implemented, yet.
 * TODO: write type guard -- pull-requests welcome
 *
 * @alpha
 */
export function isNodePackageJson (value: any): value is NodePackageJson {
  throw new Error('Not implemented')
  /* possible implementation:
  try { assertNodePackageJson(value) }
  catch { return false }
  return true
  */
}

/**
 *
 * Not implemented, yet.
 * TODO: write type assertion -- pull-requests welcome
 *
 * @throws {@link Error} on error; includes qualitative message
 *
 * @alpha
 */
export function assertNodePackageJson (value: any): asserts value is NodePackageJson {
  throw new Error('Not implemented')
  /* possible implementation:
  if ( value === null || value === undefined ) { throw new Error('value not an object') }
  if ( !(typeof value.name in ['undefined', 'string']) ) { throw new Error('unexpected name') }
  etc...
  */
}