bare-os 3.9.3: memoryUsage

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

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:dffae83cee09eed627969c91982c071e99e38e454944349caeb6c5ec3888f141","contract":["package manifest specifies bare-os name, version 3.9.3, addon configuration, and Bare engine requirement","declares memoryUsage function in index.d.ts returning rss, heapTotal, heapUsed, and external metrics","exports memoryUsage in index.js delegating execution to native binding","native binding implements bare_os_memory_usage querying heap statistics and resident set memory","memoryUsage() returns current process memory metrics matching the declared schema"],"goal":"verify memoryUsage in pkg:npm/bare-os@3.9.3","kind":"HOW","packages":["pkg:npm/bare-os@3.9.3"],"schemaVersion":1,"symbols":["memoryUsage"]},"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":["memoryUsage"],"verifierAdapter":"node-typescript@1"}

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

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

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 package manifest and verify package structure
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.addon, true, 'Package must be marked as addon');
assert.equal(pkg.engines?.bare, '>=1.14.0', 'Package must specify Bare engine requirement >=1.14.0');
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');

const pkgDir = path.dirname(pkgPath);
const indexDtsPath = path.join(pkgDir, 'index.d.ts');
const indexJsPath = path.join(pkgDir, 'index.js');
const bindingCPath = path.join(pkgDir, 'binding.c');

// 2. Verify memoryUsage type declaration in index.d.ts
assert.ok(fs.existsSync(indexDtsPath), 'index.d.ts must exist');
const indexDts = fs.readFileSync(indexDtsPath, 'utf8');

assert.ok(
  indexDts.includes('export function memoryUsage(): {'),
  'index.d.ts must declare memoryUsage return object'
);
assert.ok(indexDts.includes('rss: number'), 'index.d.ts must declare rss: number');
assert.ok(indexDts.includes('heapTotal: number'), 'index.d.ts must declare heapTotal: number');
assert.ok(indexDts.includes('heapUsed: number'), 'index.d.ts must declare heapUsed: number');
assert.ok(indexDts.includes('external: number'), 'index.d.ts must declare external: number');

// 3. Verify memoryUsage export in index.js
assert.ok(fs.existsSync(indexJsPath), 'index.js must exist');
const indexJs = fs.readFileSync(indexJsPath, 'utf8');

assert.match(
  indexJs,
  /exports\.memoryUsage\s*=\s*function\s+memoryUsage\s*\(\)\s*\{\s*return\s+binding\.memoryUsage\(\)\s*\}/,
  'index.js must export memoryUsage delegating to binding.memoryUsage()'
);

// 4. Verify native C binding implementation in binding.c
assert.ok(fs.existsSync(bindingCPath), 'binding.c must exist');
const bindingC = fs.readFileSync(bindingCPath, 'utf8');

assert.ok(
  bindingC.includes('bare_os_memory_usage(js_env_t *env, js_callback_info_t *info)'),
  'binding.c must implement bare_os_memory_usage callback'
);
assert.ok(
  bindingC.includes('js_get_heap_statistics(env, &stats)'),
  'bare_os_memory_usage must query heap statistics via js_get_heap_statistics'
);
assert.ok(
  bindingC.includes('uv_resident_set_memory(&rss)'),
  'bare_os_memory_usage must query resident set memory via uv_resident_set_memory'
);
assert.ok(
  bindingC.includes('err = js_set_named_property(env, result, "rss", value);'),
  'bare_os_memory_usage must set rss property'
);
assert.ok(
  bindingC.includes('V("heapTotal", total_heap_size)'),
  'bare_os_memory_usage must map heapTotal'
);
assert.ok(
  bindingC.includes('V("heapUsed", used_heap_size)'),
  'bare_os_memory_usage must map heapUsed'
);
assert.ok(
  bindingC.includes('V("external", external_memory)'),
  'bare_os_memory_usage must map external'
);
assert.ok(
  bindingC.includes('V("memoryUsage", bare_os_memory_usage)'),
  'binding.c must register memoryUsage in addon export table'
);

// 5. Verify runtime invocation with mock binding
const bindingPath = path.join(pkgDir, 'binding.js');
const mockMemoryStats = {
  rss: 34500000,
  heapTotal: 12500000,
  heapUsed: 8300000,
  external: 1200000,
};

let memoryUsageCalled = false;
require.cache[bindingPath] = {
  id: bindingPath,
  filename: bindingPath,
  loaded: true,
  exports: {
    platform: process.platform,
    arch: process.arch,
    memoryUsage: () => {
      memoryUsageCalled = true;
      return mockMemoryStats;
    },
  },
};

const bareOs = require('bare-os');
assert.equal(typeof bareOs.memoryUsage, 'function', 'bareOs.memoryUsage must be a function');

const usage = bareOs.memoryUsage();
assert.equal(memoryUsageCalled, true, 'bareOs.memoryUsage() must invoke binding.memoryUsage()');
assert.equal(usage.rss, 34500000, 'usage.rss must match');
assert.equal(usage.heapTotal, 12500000, 'usage.heapTotal must match');
assert.equal(usage.heapUsed, 8300000, 'usage.heapUsed must match');
assert.equal(usage.external, 1200000, 'usage.external must match');

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