npm-audit-report 6.0.0: auditReport

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify auditReport in pkg:npm/npm-audit-report@6.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/npm-audit-report@6.0.0
Demonstrate these symbols/APIs:
  - auditReport

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:af69826c4a7689df564bdbffb900ca796180d4aeafbb28b052cecce1bcea0302","contract":["auditReport(data, options) returns { report, exitCode } using the selected reporter ('install', 'detail', 'json', 'quiet') and computes exitCode (1 when vulnerabilities meet or exceed auditLevel, 0 otherwise)","auditReport throws TypeError with code 'ENOAUDITDATA' when data is falsy, unwraps data.toJSON() when present, and requires options.chalk for 'install' and 'detail' reporters"],"goal":"verify auditReport in pkg:npm/npm-audit-report@6.0.0","kind":"HOW","packages":["pkg:npm/npm-audit-report@6.0.0"],"schemaVersion":1,"symbols":["auditReport"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/npm-audit-report@6.0.0"],"schemaVersion":1,"subject":"pkg:npm/npm-audit-report@6.0.0","symbols":["auditReport"],"verifierAdapter":"node-typescript@1"}

{
  "name": "verify-npm-audit-report",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "verify-npm-audit-report",
      "version": "1.0.0",
      "dependencies": {
        "npm-audit-report": "6.0.0"
      }
    },
    "node_modules/npm-audit-report": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/npm-audit-report/-/npm-audit-report-6.0.0.tgz",
      "integrity": "sha512-Ag6Y1irw/+CdSLqEEAn69T8JBgBThj5mw0vuFIKeP7hATYuQuS5jkMjK6xmVB8pr7U4g5Audbun0lHhBDMIBRA==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    }
  }
}

{
  "name": "verify-npm-audit-report",
  "version": "1.0.0",
  "private": true,
  "dependencies": {
    "npm-audit-report": "6.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify auditReport in pkg:npm/npm-audit-report@6.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/npm-audit-report@6.0.0"
  ],
  "symbols": [
    "auditReport"
  ]
}

import assert from 'node:assert/strict'
import auditReport from 'npm-audit-report'

const identity = (s) => String(s)
const bold = Object.assign((s) => String(s), {
  green: identity,
  red: identity,
  magenta: identity,
  yellow: identity,
})
const mockChalk = {
  green: { bold: identity },
  red: { bold: identity },
  magenta: { bold: identity },
  yellow: { bold: identity },
  bold: identity,
  dim: identity,
}

// 1. Missing data throws ENOAUDITDATA
assert.throws(
  () => auditReport(null),
  (err) => err instanceof TypeError && err.code === 'ENOAUDITDATA' && err.message === 'missing audit data'
)

// 2. Clean audit data (0 vulnerabilities) with default 'install' reporter
const cleanData = {
  vulnerabilities: {},
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 0,
      critical: 0,
      total: 0,
    },
  },
}

const cleanRes = auditReport(cleanData, { chalk: mockChalk })
assert.equal(cleanRes.exitCode, 0)
assert.equal(cleanRes.report, 'found 0 vulnerabilities')

// 3. Vulnerable data with 'install', 'detail', 'json', 'quiet' reporters and auditLevel threshold
const vulnData = {
  vulnerabilities: {
    'pkg-a': {
      name: 'pkg-a',
      severity: 'high',
      via: [
        {
          title: 'Prototype Pollution',
          url: 'https://example.com/advisory/1',
        },
      ],
      effects: [],
      range: '<1.2.0',
      nodes: ['node_modules/pkg-a'],
      fixAvailable: true,
    },
  },
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 1,
      critical: 0,
      total: 1,
    },
  },
}

const installRes = auditReport(vulnData, { reporter: 'install', chalk: mockChalk })
assert.equal(installRes.exitCode, 1)
assert.ok(installRes.report.includes('1 high severity vulnerability'))
assert.ok(installRes.report.includes('npm audit fix'))

// Higher auditLevel ('critical') causes exitCode 0 when only 'high' vulnerabilities exist
const criticalLevelRes = auditReport(vulnData, { reporter: 'install', auditLevel: 'critical', chalk: mockChalk })
assert.equal(criticalLevelRes.exitCode, 0)

// 'detail' reporter
const detailRes = auditReport(vulnData, { reporter: 'detail', chalk: mockChalk })
assert.equal(detailRes.exitCode, 1)
assert.ok(detailRes.report.includes('# npm audit report'))
assert.ok(detailRes.report.includes('Prototype Pollution - https://example.com/advisory/1'))

// 'json' reporter and toJSON() unwrapping
const wrappedData = {
  toJSON() {
    return cleanData
  },
}
const jsonRes = auditReport(wrappedData, { reporter: 'json', indent: 2 })
assert.equal(jsonRes.exitCode, 0)
assert.deepEqual(JSON.parse(jsonRes.report), cleanData)

// 'quiet' reporter
const quietRes = auditReport(vulnData, { reporter: 'quiet', chalk: mockChalk })
assert.equal(quietRes.exitCode, 1)
assert.equal(quietRes.report, '')

// Attached reporters map
assert.equal(typeof auditReport.reporters.install, 'function')
assert.equal(typeof auditReport.reporters.detail, 'function')
assert.equal(typeof auditReport.reporters.json, 'function')
assert.equal(typeof auditReport.reporters.quiet, 'function')