npm-bundled 4.0.0: bundleWalk

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 bundleWalk in pkg:npm/npm-bundled@4.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/npm-bundled@4.0.0
Demonstrate these symbols/APIs:
  - bundleWalk

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:c643ce2a908222e32f416d547d652aa8bd5c9915033d116fdc3a311403ec729f","contract":["bundleWalk({ path, packageJsonCache }) returns a Promise resolving to direct and hoisted transitive bundled package names while populating packageJsonCache","bundleWalk.sync({ path, packageJsonCache }) synchronously walks bundledDependencies and returns the same top-level bundled package names","bundleWalk({ path }) with bundleDependencies: true includes all dependencies and optionalDependencies present in node_modules"],"goal":"verify bundleWalk in pkg:npm/npm-bundled@4.0.0","kind":"HOW","packages":["pkg:npm/npm-bundled@4.0.0"],"schemaVersion":1,"symbols":["bundleWalk"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9","runtime":"node","runtimeVersion":"22.23","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/npm-bundled@4.0.0"],"schemaVersion":1,"subject":"pkg:npm/npm-bundled@4.0.0","symbols":["bundleWalk"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-npm-bundled",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-npm-bundled",
      "version": "1.0.0",
      "dependencies": {
        "npm-bundled": "4.0.0"
      }
    },
    "node_modules/npm-bundled": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-4.0.0.tgz",
      "integrity": "sha512-IxaQZDMsqfQ2Lz37VvyyEtKLe8FsRZuysmedy/N06TU1RyVppYKXrO4xIhR0F+7ubIBox6Q7nir6fQI3ej39iA==",
      "license": "ISC",
      "dependencies": {
        "npm-normalize-package-bin": "^4.0.0"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/npm-normalize-package-bin": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-4.0.0.tgz",
      "integrity": "sha512-TZKxPvItzai9kN9H/TkmCtx/ZN/hvr3vUycjlfmH0ootY9yFBzNOpiXAdIn1Iteqsvk4lQn6B5PTrt+n6h8k/w==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    }
  }
}

{
  "name": "sample-npm-bundled",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "npm-bundled": "4.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify bundleWalk in pkg:npm/npm-bundled@4.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/npm-bundled@4.0.0"
  ],
  "symbols": [
    "bundleWalk"
  ]
}

import assert from 'node:assert/strict';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import bundleWalk from 'npm-bundled';

function writePkg(dir, pkg) {
  fs.mkdirSync(dir, { recursive: true });
  fs.writeFileSync(path.join(dir, 'package.json'), JSON.stringify(pkg, null, 2));
}

const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'npm-bundled-walk-'));

try {
  // Root package bundles 'pkg-a' and '@scope/pkg-b', leaves 'unbundled-dep' unbundled
  writePkg(tmpDir, {
    name: 'root-pkg',
    version: '1.0.0',
    dependencies: {
      'pkg-a': '1.0.0',
      '@scope/pkg-b': '1.0.0',
      'unbundled-dep': '1.0.0'
    },
    bundleDependencies: ['pkg-a', '@scope/pkg-b']
  });

  // pkg-a depends on transitive-dep (hoisted to root node_modules)
  writePkg(path.join(tmpDir, 'node_modules', 'pkg-a'), {
    name: 'pkg-a',
    version: '1.0.0',
    dependencies: {
      'transitive-dep': '1.0.0'
    }
  });

  // @scope/pkg-b has no extra deps
  writePkg(path.join(tmpDir, 'node_modules', '@scope', 'pkg-b'), {
    name: '@scope/pkg-b',
    version: '1.0.0'
  });

  // transitive-dep hoisted at root node_modules
  writePkg(path.join(tmpDir, 'node_modules', 'transitive-dep'), {
    name: 'transitive-dep',
    version: '1.0.0'
  });

  // unbundled-dep at root node_modules (should NOT be returned)
  writePkg(path.join(tmpDir, 'node_modules', 'unbundled-dep'), {
    name: 'unbundled-dep',
    version: '1.0.0'
  });

  // 1. Async Promise walk via default export bundleWalk({ path, packageJsonCache })
  const asyncCache = new Map();
  const asyncResult = await bundleWalk({ path: tmpDir, packageJsonCache: asyncCache });
  assert.deepEqual(
    [...asyncResult].sort(),
    ['@scope/pkg-b', 'pkg-a', 'transitive-dep'],
    'bundleWalk({ path, packageJsonCache }) resolves to direct and hoisted transitive bundled dependencies'
  );
  assert.ok(asyncCache.size >= 4, 'bundleWalk populates packageJsonCache during async walk');

  // 2. Synchronous walk via bundleWalk.sync({ path, packageJsonCache })
  const syncCache = new Map();
  const syncResult = bundleWalk.sync({ path: tmpDir, packageJsonCache: syncCache });
  assert.deepEqual(
    [...syncResult].sort(),
    ['@scope/pkg-b', 'pkg-a', 'transitive-dep'],
    'bundleWalk.sync({ path, packageJsonCache }) synchronously returns the same bundled dependency list'
  );
  assert.ok(syncCache.size >= 4, 'bundleWalk.sync populates packageJsonCache during sync walk');

  // 3. bundleDependencies: true bundles all dependencies and optionalDependencies present in node_modules
  const tmpAllDir = fs.mkdtempSync(path.join(os.tmpdir(), 'npm-bundled-all-'));
  try {
    writePkg(tmpAllDir, {
      name: 'all-bundled',
      version: '1.0.0',
      dependencies: { 'dep-one': '1.0.0' },
      optionalDependencies: { 'dep-opt': '1.0.0' },
      bundleDependencies: true
    });
    writePkg(path.join(tmpAllDir, 'node_modules', 'dep-one'), { name: 'dep-one', version: '1.0.0' });
    writePkg(path.join(tmpAllDir, 'node_modules', 'dep-opt'), { name: 'dep-opt', version: '1.0.0' });

    const allAsyncResult = await bundleWalk({ path: tmpAllDir });
    assert.deepEqual(
      [...allAsyncResult].sort(),
      ['dep-one', 'dep-opt'],
      'bundleWalk with bundleDependencies: true includes all dependencies and optionalDependencies'
    );
  } finally {
    fs.rmSync(tmpAllDir, { recursive: true, force: true });
  }
} finally {
  fs.rmSync(tmpDir, { recursive: true, force: true });
}