bare-os 3.9.3: machine

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 machine in pkg:npm/bare-os@3.9.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/bare-os@3.9.3
Demonstrate these symbols/APIs:
  - machine

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:fbe707ad3622ea8d8a1d668f8fd4ae437ca41e62f546293e286b7296f59c2c49","contract":["package manifest specifies Bare addon configuration, Bare engine requirement, and exports for root, constants, errors, and package subpaths","index.d.ts declares export function machine(): string for retrieving system hardware machine architecture","index.js exports machine function that delegates to binding.machine()","bare-os.machine returns the machine architecture string provided by the addon binding","binding.c implements bare_os_machine via uv_os_uname buffer.machine and registers the symbol in exports table","bare-os/errors exports OSError class extending Error with UNKNOWN_SIGNAL constructor"],"goal":"verify machine in pkg:npm/bare-os@3.9.3","kind":"HOW","packages":["pkg:npm/bare-os@3.9.3"],"schemaVersion":1,"symbols":["machine"]},"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/bare-os@3.9.3"],"schemaVersion":1,"subject":"pkg:npm/bare-os@3.9.3","symbols":["machine"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-bare-os-machine",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-bare-os-machine",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "bare-os": "3.9.3"
      }
    },
    "node_modules/bare-os": {
      "version": "3.9.3",
      "resolved": "https://registry.npmjs.org/bare-os/-/bare-os-3.9.3.tgz",
      "integrity": "sha512-fF4Q7QsyKVF5Rj0qvI8BgUNjqzC2JvQlpTaPLjVJVxYVUX5Zr9un+y3w1HmA4nNKdFmRBT8z/WmrjvXzXVerKQ==",
      "license": "Apache-2.0",
      "engines": {
        "bare": ">=1.14.0"
      }
    }
  }
}

{
  "name": "sample-bare-os-machine",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "bare-os": "3.9.3"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify machine in pkg:npm/bare-os@3.9.3",
  "kind": "HOW",
  "packages": [
    "pkg:npm/bare-os@3.9.3"
  ],
  "symbols": [
    "machine"
  ]
}

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';
import fs from 'node:fs';
import path from 'node:path';

const require = createRequire(import.meta.url);

// 1. Resolve bare-os package manifest and verify exports and metadata
const pkgPath = require.resolve('bare-os/package');
const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));

assert.equal(pkg.name, 'bare-os', 'Package name must be bare-os');
assert.equal(pkg.version, '3.9.3', 'Package version must be 3.9.3');
assert.equal(pkg.license, 'Apache-2.0', 'Package license must be Apache-2.0');
assert.equal(pkg.addon, true, 'Package must be marked as addon');
assert.equal(pkg.engines?.bare, '>=1.14.0', 'Package must specify Bare engine >=1.14.0');

assert.ok(pkg.exports, 'Package must define exports');
assert.equal(pkg.exports['.'].types, './index.d.ts', 'Root export must have index.d.ts types');
assert.equal(pkg.exports['.'].default, './index.js', 'Root export must have index.js default');
assert.equal(pkg.exports['./constants'].types, './lib/constants.d.ts', 'Constants export must have constants.d.ts types');
assert.equal(pkg.exports['./constants'].default, './lib/constants.js', 'Constants export must have constants.js default');
assert.equal(pkg.exports['./errors'].types, './lib/errors.d.ts', 'Errors export must have errors.d.ts types');
assert.equal(pkg.exports['./errors'].default, './lib/errors.js', 'Errors export must have errors.js default');
assert.equal(pkg.exports['./package'], './package.json', 'Package export must point to package.json');

const pkgDir = path.dirname(pkgPath);
const indexDts = fs.readFileSync(path.join(pkgDir, 'index.d.ts'), 'utf8');
const indexJs = fs.readFileSync(path.join(pkgDir, 'index.js'), 'utf8');
const bindingC = fs.readFileSync(path.join(pkgDir, 'binding.c'), 'utf8');

// 2. Verify machine symbol declarations in TypeScript definition
assert.ok(indexDts.includes('export function machine(): string'), 'index.d.ts must declare export function machine(): string');
assert.ok(indexDts.includes('export function platform()'), 'index.d.ts must declare platform');
assert.ok(indexDts.includes('export function arch()'), 'index.d.ts must declare arch');
assert.ok(indexDts.includes('export function release(): string'), 'index.d.ts must declare release');

// 3. Verify machine implementation in JavaScript module
assert.ok(indexJs.includes('exports.machine = function machine()'), 'index.js must export machine function');
assert.ok(indexJs.includes('return binding.machine()'), 'machine function must delegate to binding.machine()');

// 4. Verify machine invocation behavior with addon binding stub
const bindingFilePath = path.join(pkgDir, 'binding.js');
let bindingMachineCalls = 0;
const expectedMachine = 'x86_64';

require.cache[bindingFilePath] = {
  id: bindingFilePath,
  filename: bindingFilePath,
  loaded: true,
  exports: {
    platform: 'linux',
    arch: 'x64',
    machine: () => {
      bindingMachineCalls++;
      return expectedMachine;
    },
    isLittleEndian: true
  }
};

const bareOs = require('bare-os');
assert.equal(typeof bareOs.machine, 'function', 'bare-os must export machine function');
const machineResult = bareOs.machine();
assert.equal(machineResult, expectedMachine, 'bare-os.machine() must return value from binding.machine()');
assert.equal(bindingMachineCalls, 1, 'binding.machine() must have been called exactly once');

// Test machine returning another architecture format (e.g. aarch64)
require.cache[bindingFilePath].exports.machine = () => 'aarch64';
assert.equal(bareOs.machine(), 'aarch64', 'bare-os.machine() must return updated machine architecture');

// 5. Verify C binding implementation and symbol registration
assert.ok(bindingC.includes('bare_os_machine('), 'binding.c must implement bare_os_machine');
assert.ok(bindingC.includes('uv_os_uname(&buffer)'), 'bare_os_machine must call uv_os_uname to retrieve machine info');
assert.ok(bindingC.includes('buffer.machine'), 'bare_os_machine must read buffer.machine from uv_utsname_t');
assert.ok(bindingC.includes('V("machine", bare_os_machine)'), 'binding.c must register machine in addon exports table');

// 6. Verify errors submodule functionality
const OSError = require('bare-os/errors');
assert.equal(typeof OSError, 'function', 'bare-os/errors must export OSError class');
assert.ok(OSError.prototype instanceof Error, 'OSError must extend Error');

const unknownSignalErr = OSError.UNKNOWN_SIGNAL('Invalid signal');
assert.ok(unknownSignalErr instanceof OSError, 'UNKNOWN_SIGNAL must return OSError instance');
assert.equal(unknownSignalErr.code, 'UNKNOWN_SIGNAL', 'Error code must be UNKNOWN_SIGNAL');

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