bare-bundle 1.10.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/bare-bundle@1.10.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/bare-bundle@1.10.0
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:9fcc97ec6392be6a937367d1a278c4abdcfeca5e71e6c4901d4d8a2f04d8df43","constraints":{"executionContext":"node"},"contract":["Bundle creates an empty bundle with default properties and version 0","Bundle.prototype.write stores files with data, permissions mode, and updates main entry point","Bundle.prototype.write registers package imports aliases, resolutions, addons, and assets","Bundle.prototype.read and exists retrieve stored file contents as Buffer and check presence","Bundle.prototype.toBuffer serializes bundle metadata and files into binary format with length-prefixed JSON header","Bundle.from deserializes serialized buffer restoring files, main entry, and metadata","Bundle.from parses bundle containing leading hashbang prefix","Bundle.from throws BundleError INVALID_BUNDLE_HEADER for malformed header data","Bundle.isBundle identifies Bundle instances and returns false for plain objects","Bundle.prototype.mount prefixes bundle file paths and specifiers under a root URL"],"goal":"verify pkg:npm/bare-bundle@1.10.0","kind":"HOW","packages":["pkg:npm/bare-bundle@1.10.0"],"schemaVersion":1},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/bare-bundle@1.10.0"],"schemaVersion":1,"subject":"pkg:npm/bare-bundle@1.10.0","verifierAdapter":"node-typescript@1"}

import Bundle from 'bare-bundle';

/**
 * Creates a new Bundle instance with initial files.
 * @param {Array<{path: string, content: string|Buffer, options?: object}>} files
 * @returns {Bundle}
 */
export function createBundle(files = []) {
  const bundle = new Bundle();
  for (const file of files) {
    bundle.write(file.path, file.content, file.options);
  }
  return bundle;
}

/**
 * Serializes a bundle into a Buffer.
 * @param {Bundle} bundle
 * @param {object} options
 * @returns {Buffer}
 */
export function serializeBundle(bundle, options) {
  return bundle.toBuffer(options);
}

/**
 * Deserializes a bundle from a Buffer or string.
 * @param {string|Buffer} buffer
 * @returns {Bundle}
 */
export function parseBundle(buffer) {
  return Bundle.from(buffer);
}

export default Bundle;
export { Bundle };

{
  "name": "sample-bare-bundle",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-bare-bundle",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "bare-bundle": "1.10.0"
      }
    },
    "node_modules/bare-bundle": {
      "version": "1.10.0",
      "resolved": "https://registry.npmjs.org/bare-bundle/-/bare-bundle-1.10.0.tgz",
      "integrity": "sha512-4LVlnJAHr00Hh6Vu6ZUJS38rcEtJT3b3vChXSsBsJ2mk1TN0lQ+gzd+Dw5L0aV7uqDZv84smuwW+O02X7PfDlw==",
      "license": "Apache-2.0",
      "peerDependencies": {
        "bare-buffer": "*",
        "bare-url": "*"
      },
      "peerDependenciesMeta": {
        "bare-buffer": {
          "optional": true
        },
        "bare-url": {
          "optional": true
        }
      }
    }
  }
}

{
  "name": "sample-bare-bundle",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "bare-bundle": "1.10.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/bare-bundle@1.10.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/bare-bundle@1.10.0"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

import assert from 'node:assert/strict';
import Bundle, { createBundle, serializeBundle, parseBundle } from '../index.js';

// 1. Bundle creates an empty bundle with default properties and version 0
{
  const bundle = new Bundle();
  assert.equal(bundle.version, 0);
  assert.equal(bundle.id, null);
  assert.equal(bundle.main, null);
  assert.deepEqual(bundle.imports, {});
  assert.deepEqual(bundle.resolutions, {});
  assert.deepEqual(bundle.addons, []);
  assert.deepEqual(bundle.assets, []);
  assert.equal(bundle.empty(), true);
  assert.deepEqual([...bundle.keys()], []);
}

// 2. Bundle.prototype.write stores files with data, permissions mode, and updates main entry point
{
  const bundle = createBundle([
    {
      path: '/index.js',
      content: 'console.log("hello world");',
      options: { main: true, mode: 0o755 }
    }
  ]);

  assert.equal(bundle.empty(), false);
  assert.equal(bundle.main, '/index.js');
  assert.equal(bundle.exists('/index.js'), true);
  assert.equal(bundle.size('/index.js'), 27);
  assert.equal(bundle.mode('/index.js'), 0o755);
  assert.deepEqual(bundle.read('/index.js'), Buffer.from('console.log("hello world");'));
}

// 3. Bundle.prototype.write registers package imports aliases, resolutions, addons, and assets
{
  const bundle = new Bundle();
  bundle.write('/addon.node', Buffer.from([0x00, 0x01]), {
    addon: true,
    alias: 'native-addon'
  });
  bundle.write('/image.png', Buffer.from([0x89, 0x50]), {
    asset: true
  });
  bundle.write('/module.js', 'export default 42;', {
    imports: { dep: '/dep.js' }
  });

  assert.deepEqual(bundle.addons, ['/addon.node']);
  assert.deepEqual(bundle.assets, ['/image.png']);
  assert.deepEqual(bundle.imports, { 'native-addon': '/addon.node' });
  assert.deepEqual(bundle.resolutions, { '/module.js': { dep: '/dep.js' } });
}

// 4. Bundle.prototype.read and exists retrieve stored file contents as Buffer and check presence
{
  const bundle = new Bundle();
  bundle.write('/data.txt', 'test content');

  assert.equal(bundle.exists('/data.txt'), true);
  assert.equal(bundle.exists('/missing.txt'), false);
  assert.equal(bundle.read('/missing.txt'), null);
  assert.equal(bundle.size('/missing.txt'), 0);
  assert.equal(bundle.mode('/missing.txt'), 0);
  assert.equal(bundle.read('/data.txt').toString('utf8'), 'test content');
}

// 5. Bundle.prototype.toBuffer serializes bundle metadata and files into binary format with length-prefixed JSON header
{
  const bundle = new Bundle();
  bundle.write('/main.js', 'console.log("ok");', { main: true });
  const raw = serializeBundle(bundle);

  assert.equal(Buffer.isBuffer(raw), true);
  assert.ok(raw.byteLength > 0);

  let end = 0;
  while (raw[end] >= 0x30 && raw[end] <= 0x39) end++;
  const jsonLen = parseInt(raw.toString('utf8', 0, end), 10);
  assert.ok(jsonLen > 0);

  const parsedHeader = JSON.parse(raw.toString('utf8', end, end + jsonLen));
  assert.equal(parsedHeader.main, '/main.js');
  assert.ok(parsedHeader.files['/main.js']);
  assert.equal(parsedHeader.files['/main.js'].length, 18);
}

// 6. Bundle.from deserializes serialized buffer restoring files, main entry, and metadata
{
  const original = new Bundle();
  original.id = 'bundle-123';
  original.write('/index.js', 'module.exports = "bundle";', {
    main: true,
    alias: 'root'
  });
  const serialized = original.toBuffer();

  const restored = parseBundle(serialized);
  assert.equal(Bundle.isBundle(restored), true);
  assert.equal(restored.id, 'bundle-123');
  assert.equal(restored.main, '/index.js');
  assert.deepEqual(restored.imports, { root: '/index.js' });
  assert.equal(restored.read('/index.js').toString('utf8'), 'module.exports = "bundle";');
}

// 7. Bundle.from parses bundle containing leading hashbang prefix
{
  const bundle = new Bundle();
  bundle.write('/script.js', 'console.log(1);', { main: true });
  const serialized = bundle.toBuffer();

  const hashbang = Buffer.from('#!/usr/bin/env bare\n');
  const withHashbang = Buffer.concat([hashbang, serialized]);

  const fromHashbang = Bundle.from(withHashbang);
  assert.equal(fromHashbang.main, '/script.js');
  assert.equal(fromHashbang.read('/script.js').toString('utf8'), 'console.log(1);');
}

// 8. Bundle.from throws BundleError INVALID_BUNDLE_HEADER for malformed header data
{
  const corrupted = Buffer.from('15\n{not-valid-json}\n');
  assert.throws(() => {
    Bundle.from(corrupted);
  }, (err) => {
    return err.name === 'BundleError' && (err.code === 'INVALID_BUNDLE_HEADER' || err.message.includes('INVALID_BUNDLE_HEADER'));
  });
}

// 9. Bundle.isBundle identifies Bundle instances and returns false for plain objects
{
  const bundle = new Bundle();
  assert.equal(Bundle.isBundle(bundle), true);
  assert.equal(Bundle.isBundle(Bundle.from(bundle.toBuffer())), true);
  assert.equal(Bundle.isBundle({}), false);
  assert.equal(Bundle.isBundle(null), false);
  assert.equal(Bundle.isBundle('bundle'), false);
  assert.equal(Bundle.isBundle(undefined), false);
}

// 10. Bundle.prototype.mount prefixes bundle file paths and specifiers under a root URL
{
  const bundle = new Bundle();
  bundle.write('/index.js', 'content', { main: true });
  const mounted = bundle.mount('https://example.com/app/');

  assert.equal(mounted.main, 'https://example.com/app/index.js');
  assert.equal(mounted.exists('https://example.com/app/index.js'), true);
  assert.equal(mounted.read('https://example.com/app/index.js').toString('utf8'), 'content');
  assert.equal(mounted.exists('/index.js'), false);

  const unmounted = mounted.unmount('https://example.com/app/');
  assert.equal(unmounted.main, '/index.js');
  assert.equal(unmounted.exists('/index.js'), true);
}

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