bare-os 3.9.3: networkInterfaces

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

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:c1952c1c381bbf521825c20904f14f5a2d392a9caf4841d4996eeaffdd9bd55e","contract":["declares networkInterfaces function returning Record\u003cstring, NetworkInterface[]\u003e in index.d.ts with interface definition","defines networkInterfaces in index.js grouping native binding entries by interface name","implements bare_os_network_interfaces in binding.c querying uv_interface_addresses and formatting IPv4/IPv6 addresses, CIDR, and MAC addresses","registers networkInterfaces symbol in addon native exports definition table","verifies bare-os package manifest exports mapping, CMake build specification, and prebuild artifacts"],"goal":"verify networkInterfaces in pkg:npm/bare-os@3.9.3","kind":"HOW","packages":["pkg:npm/bare-os@3.9.3"],"schemaVersion":1,"symbols":["networkInterfaces"]},"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":["networkInterfaces"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-bare-os-network-interfaces",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-bare-os-network-interfaces",
      "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-network-interfaces",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "bare-os": "3.9.3"
  }
}

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

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['./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 bindingJs = fs.readFileSync(path.join(pkgDir, 'binding.js'), 'utf8');
const bindingC = fs.readFileSync(path.join(pkgDir, 'binding.c'), 'utf8');

// 2. Verify TypeScript declarations (index.d.ts) for networkInterfaces
assert.ok(
  indexDts.includes('export interface NetworkInterface {'),
  'index.d.ts must declare NetworkInterface interface'
);
assert.ok(indexDts.includes('address: string'), 'NetworkInterface must include address field');
assert.ok(indexDts.includes('netmask: string'), 'NetworkInterface must include netmask field');
assert.ok(indexDts.includes("family: 'IPv4' | 'IPv6'"), 'NetworkInterface must include family field');
assert.ok(indexDts.includes('cidr: string'), 'NetworkInterface must include cidr field');
assert.ok(indexDts.includes('mac: string'), 'NetworkInterface must include mac field');
assert.ok(indexDts.includes('internal: boolean'), 'NetworkInterface must include internal field');
assert.ok(indexDts.includes('scopeid?: number'), 'NetworkInterface must include scopeid optional field');
assert.ok(
  indexDts.includes('export function networkInterfaces(): Record<string, NetworkInterface[]>'),
  'index.d.ts must declare networkInterfaces(): Record<string, NetworkInterface[]>'
);

// 3. Verify JavaScript implementation in index.js
assert.ok(
  indexJs.includes('exports.networkInterfaces = function networkInterfaces()'),
  'index.js must export networkInterfaces function'
);
assert.ok(
  indexJs.includes('for (const entry of binding.networkInterfaces())'),
  'index.js networkInterfaces must iterate through binding.networkInterfaces()'
);
assert.ok(
  indexJs.includes('const { name, ...properties } = entry'),
  'index.js networkInterfaces must extract interface name and group properties'
);

// Verify grouping behavior logic
function groupInterfaces(entries) {
  const result = {};
  for (const entry of entries) {
    const { name, ...properties } = entry;
    if (result[name]) result[name].push(properties);
    else result[name] = [properties];
  }
  return result;
}

const mockBindingEntries = [
  {
    name: 'lo',
    address: '127.0.0.1',
    netmask: '255.0.0.0',
    family: 'IPv4',
    cidr: '127.0.0.1/8',
    mac: '00:00:00:00:00:00',
    internal: true
  },
  {
    name: 'eth0',
    address: '192.168.1.50',
    netmask: '255.255.255.0',
    family: 'IPv4',
    cidr: '192.168.1.50/24',
    mac: '01:23:45:67:89:ab',
    internal: false
  },
  {
    name: 'eth0',
    address: 'fe80::1',
    netmask: 'ffff:ffff:ffff:ffff::',
    family: 'IPv6',
    cidr: 'fe80::1/64',
    mac: '01:23:45:67:89:ab',
    internal: false,
    scopeid: 2
  }
];

const grouped = groupInterfaces(mockBindingEntries);
assert.ok(Array.isArray(grouped.lo), 'grouped.lo must be an array');
assert.equal(grouped.lo.length, 1, 'grouped.lo must contain 1 entry');
assert.equal(grouped.lo[0].address, '127.0.0.1');
assert.equal(grouped.lo[0].internal, true);
assert.equal(grouped.lo[0].family, 'IPv4');
assert.equal(grouped.lo[0].cidr, '127.0.0.1/8');

assert.ok(Array.isArray(grouped.eth0), 'grouped.eth0 must be an array');
assert.equal(grouped.eth0.length, 2, 'grouped.eth0 must contain 2 entries');
assert.equal(grouped.eth0[0].family, 'IPv4');
assert.equal(grouped.eth0[1].family, 'IPv6');
assert.equal(grouped.eth0[1].scopeid, 2);

// 4. Verify C native addon binding in binding.c
assert.ok(
  bindingC.includes('bare_os_network_interfaces(js_env_t *env, js_callback_info_t *info)'),
  'binding.c must implement bare_os_network_interfaces'
);
assert.ok(
  bindingC.includes('uv_interface_addresses(&addresses, &len)'),
  'bare_os_network_interfaces must call uv_interface_addresses'
);
assert.ok(
  bindingC.includes('bare_os__population_count(address.netmask.netmask4.sin_addr.s_addr)'),
  'bare_os_network_interfaces must calculate CIDR mask for IPv4'
);
assert.ok(
  bindingC.includes('uv_free_interface_addresses(addresses, len)'),
  'bare_os_network_interfaces must free addresses via uv_free_interface_addresses'
);
assert.ok(
  bindingC.includes('V("networkInterfaces", bare_os_network_interfaces)'),
  'binding.c must register networkInterfaces in addon exports'
);

// 5. Verify prebuild artifacts and CMake build file
assert.ok(fs.existsSync(path.join(pkgDir, 'CMakeLists.txt')), 'CMakeLists.txt must exist');
const prebuildsDir = path.join(pkgDir, 'prebuilds');
const expectedTargets = [
  'linux-x64',
  'linux-arm64',
  'darwin-x64',
  'darwin-arm64',
  'win32-x64',
  'win32-arm64',
  'android-arm64',
  'ios-arm64'
];

for (const target of expectedTargets) {
  const prebuildPath = path.join(prebuildsDir, target, 'bare-os.bare');
  assert.ok(fs.existsSync(prebuildPath), `Prebuild binary for ${target} must exist at ${prebuildPath}`);
  const stats = fs.statSync(prebuildPath);
  assert.ok(stats.size > 0, `Prebuild binary for ${target} must not be empty`);
}

console.log('Contract passed: networkInterfaces in pkg:npm/bare-os@3.9.3 successfully verified');