@types/node-forge 1.3.14: name

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 @types/node-forge.name in pkg:npm/%40types/node-forge@1.3.14
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40types/node-forge@1.3.14
Demonstrate these symbols/APIs:
  - @types/node-forge.name
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:5d197ca55cc7149f9eb571cada59b32632a1f9b22fa44edad5c3bd42257566a9","constraints":{"executionContext":"node"},"contract":["@types/node-forge package.json specifies package name as @types/node-forge","@types/node-forge package.json specifies version 1.3.14 and types entrypoint index.d.ts","@types/node-forge declaration file index.d.ts exists and declares node-forge module namespace","@types/node-forge helper inspectPackageMetadata returns package name, version, and type definitions information"],"goal":"verify @types/node-forge.name in pkg:npm/%40types/node-forge@1.3.14","kind":"HOW","packages":["pkg:npm/%40types/node-forge@1.3.14"],"schemaVersion":1,"symbols":["@types/node-forge.name"]},"contractCommand":["node","test/contract.js"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40types/node-forge@1.3.14"],"schemaVersion":1,"subject":"pkg:npm/%40types/node-forge@1.3.14","symbols":["@types/node-forge.name"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-node-forge-types-name",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-node-forge-types-name",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@types/node-forge": "1.3.14"
      }
    },
    "node_modules/@types/node": {
      "version": "26.3.0",
      "resolved": "https://registry.npmjs.org/@types/node/-/node-26.3.0.tgz",
      "integrity": "sha512-L3fgrnchriRC2ExBflb8j4uZZURHZfQsmQeyVzhjcHW4kkwVyo8/0h1B2MVzMTrYUJYu6G7EWs14hW/L9putqw==",
      "license": "MIT",
      "dependencies": {
        "undici-types": "~8.3.0"
      }
    },
    "node_modules/@types/node-forge": {
      "version": "1.3.14",
      "resolved": "https://registry.npmjs.org/@types/node-forge/-/node-forge-1.3.14.tgz",
      "integrity": "sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw==",
      "license": "MIT",
      "dependencies": {
        "@types/node": "*"
      }
    },
    "node_modules/undici-types": {
      "version": "8.3.0",
      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-8.3.0.tgz",
      "integrity": "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-node-forge-types-name",
  "version": "1.0.0",
  "private": true,
  "license": "MIT-0",
  "dependencies": {
    "@types/node-forge": "1.3.14"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @types/node-forge.name in pkg:npm/%40types/node-forge@1.3.14",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40types/node-forge@1.3.14"
  ],
  "symbols": [
    "@types/node-forge.name"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const fs = require('node:fs');
const path = require('node:path');

/**
 * Resolves the path to the package.json file of @types/node-forge.
 * @returns {string} Absolute path to package.json
 */
function getPackageJsonPath() {
  return require.resolve('@types/node-forge/package.json');
}

/**
 * Loads and parses the package.json of @types/node-forge.
 * @returns {object} Parsed package.json object
 */
function loadPackageJson() {
  const pkgPath = getPackageJsonPath();
  const raw = fs.readFileSync(pkgPath, 'utf8');
  return JSON.parse(raw);
}

/**
 * Resolves the path to the entry declaration file defined by @types/node-forge.
 * @returns {string} Absolute path to the declaration file
 */
function getDeclarationFilePath() {
  const pkgDir = path.dirname(getPackageJsonPath());
  const pkg = loadPackageJson();
  const typesEntry = pkg.types || 'index.d.ts';
  return path.join(pkgDir, typesEntry);
}

/**
 * Inspects the metadata of @types/node-forge including package name, version, and type entry.
 * @returns {object} Package metadata summary
 */
function inspectPackageMetadata() {
  const pkg = loadPackageJson();
  const declPath = getDeclarationFilePath();
  const exists = fs.existsSync(declPath);
  const content = exists ? fs.readFileSync(declPath, 'utf8') : '';

  return {
    name: pkg.name,
    version: pkg.version,
    types: pkg.types,
    declarationFileExists: exists,
    declaresNodeForgeModule: content.includes('declare module "node-forge"')
  };
}

module.exports = {
  getPackageJsonPath,
  loadPackageJson,
  getDeclarationFilePath,
  inspectPackageMetadata
};

const assert = require('node:assert');
const fs = require('node:fs');
const {
  getPackageJsonPath,
  loadPackageJson,
  getDeclarationFilePath,
  inspectPackageMetadata
} = require('../src/index.js');

// 1. @types/node-forge package.json specifies package name as @types/node-forge
const pkg = loadPackageJson();
assert.strictEqual(pkg.name, '@types/node-forge', 'package name must be @types/node-forge');

// 2. @types/node-forge package.json specifies version 1.3.14 and types entrypoint index.d.ts
assert.strictEqual(pkg.version, '1.3.14', 'package version must be 1.3.14');
assert.strictEqual(pkg.types, 'index.d.ts', 'package types entrypoint must be index.d.ts');

// 3. @types/node-forge declaration file index.d.ts exists and declares node-forge module namespace
const declPath = getDeclarationFilePath();
assert.strictEqual(fs.existsSync(declPath), true, 'declaration file must exist on disk');
const content = fs.readFileSync(declPath, 'utf8');
assert.strictEqual(content.includes('declare module "node-forge"'), true, 'index.d.ts must declare module node-forge');

// 4. @types/node-forge helper inspectPackageMetadata returns package name, version, and type definitions information
const metadata = inspectPackageMetadata();
assert.strictEqual(metadata.name, '@types/node-forge');
assert.strictEqual(metadata.version, '1.3.14');
assert.strictEqual(metadata.types, 'index.d.ts');
assert.strictEqual(metadata.declarationFileExists, true);
assert.strictEqual(metadata.declaresNodeForgeModule, true);

console.log('Contract assertions passed successfully.');