npm-audit-report 6.0.0

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 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

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:8c17df5a5f1fd6fe94651e0db969c386a7c5fbc48a3d1388213045b33d2e40a0","contract":["auditReport(null) throws TypeError with code 'ENOAUDITDATA' and message 'missing audit data'","auditReport(data, { reporter: 'install', chalk }) renders vulnerability summary and returns exitCode 0 when metadata.vulnerabilities.total is 0","auditReport(data, { reporter: 'detail', chalk }) unwraps data.toJSON(), formats advisory details and fix guidance, and returns exitCode 1 when severity meets auditLevel","auditReport(data, { reporter: 'quiet', auditLevel: 'critical' }) returns empty report string and exitCode 0 when highest vulnerability is below auditLevel","auditReport(data, { reporter: 'json', indent: 0 }) serializes the audit payload as JSON and auditReport.reporters exposes install, detail, json, and quiet functions"],"goal":"verify pkg:npm/npm-audit-report@6.0.0","kind":"HOW","packages":["pkg:npm/npm-audit-report@6.0.0"],"schemaVersion":1},"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","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-npm-audit-report",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-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": "sample-npm-audit-report",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "npm-audit-report": "6.0.0"
  }
}

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

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

// Minimal chalk-compatible formatter required by install/detail reporters in v6
const plainChalk = {
  bold: (s) => String(s),
  dim: (s) => String(s),
  green: { bold: (s) => String(s) },
  red: { bold: (s) => String(s) },
  magenta: { bold: (s) => String(s) },
  yellow: { bold: (s) => String(s) },
}

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

// 2. Zero vulnerabilities report and exitCode 0
const cleanData = {
  vulnerabilities: {},
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 0,
      critical: 0,
      total: 0,
    },
  },
}

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

// 3. Vulnerability data with toJSON() unwrap, install/detail/json/quiet reporters, and auditLevel exitCode
const vulnPayload = {
  vulnerabilities: {
    'pkg-a': {
      name: 'pkg-a',
      severity: 'high',
      range: '<1.2.0',
      nodes: ['node_modules/pkg-a'],
      effects: [],
      via: [
        {
          title: 'Prototype Pollution in pkg-a',
          url: 'https://example.com/advisories/1001',
        },
      ],
      fixAvailable: true,
    },
  },
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 1,
      critical: 0,
      total: 1,
    },
  },
}

const wrappedData = {
  toJSON() {
    return vulnPayload
  },
}

const installRes = auditReport(wrappedData, { reporter: 'install', chalk: plainChalk })
assert.equal(installRes.exitCode, 1)
assert.match(installRes.report, /1 high severity vulnerability/)
assert.match(installRes.report, /npm audit fix/)
assert.match(installRes.report, /Run `npm audit` for details\./)

const detailRes = auditReport(vulnPayload, { reporter: 'detail', chalk: plainChalk })
assert.equal(detailRes.exitCode, 1)
assert.match(detailRes.report, /# npm audit report/)
assert.match(detailRes.report, /Prototype Pollution in pkg-a - https:\/\/example\.com\/advisories\/1001/)
assert.match(detailRes.report, /fix available via `npm audit fix`/)

// auditLevel threshold above 'high' yields exitCode 0
const highThresholdRes = auditReport(vulnPayload, {
  reporter: 'quiet',
  auditLevel: 'critical',
})
assert.equal(highThresholdRes.exitCode, 0)
assert.equal(highThresholdRes.report, '')

// json reporter respects indent option
const jsonRes = auditReport(vulnPayload, { reporter: 'json', indent: 0 })
assert.equal(jsonRes.exitCode, 1)
assert.deepEqual(JSON.parse(jsonRes.report), vulnPayload)

// Exposed 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')