bare-os 3.9.3: platform

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

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:f88d58b2efbde4cfc1cc0124317a3c32aad9ae7b66c6823b4a3c2a76a17d1e68","contract":["package manifest specifies bare-os 3.9.3 with Bare addon configuration and exports for root and package subpaths","declares platform function returning platform union type ('android' | 'darwin' | 'ios' | 'linux' | 'win32') in TypeScript definitions (index.d.ts)","exports platform function in JavaScript returning native binding.platform identifier","validates platform identifier against supported operating system targets and platform-specific behaviors","ships native Bare C addon binding with BARE_PLATFORM export and multi-platform prebuild artifacts"],"goal":"verify platform in pkg:npm/bare-os@3.9.3","kind":"HOW","packages":["pkg:npm/bare-os@3.9.3"],"schemaVersion":1,"symbols":["platform"]},"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":["platform"],"verifierAdapter":"node-typescript@1"}

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

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

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 platform()
assert.ok(
  indexDts.includes("export function platform(): 'android' | 'darwin' | 'ios' | 'linux' | 'win32'"),
  'index.d.ts must declare platform function returning platform union type'
);

// 3. Verify JavaScript implementation for platform()
assert.ok(
  indexJs.includes('exports.platform = function platform() {\n  return binding.platform\n}'),
  'index.js must export platform function returning binding.platform'
);

// Verify dependent platform logic in index.js
assert.ok(
  indexJs.includes("exports.EOL = binding.platform === 'win32' ? '\\r\\n' : '\\n'"),
  'index.js must derive EOL based on binding.platform'
);
assert.ok(
  indexJs.includes("exports.devNull = binding.platform === 'win32' ? '\\\\\\\\.\\\\nul' : '/dev/null'"),
  'index.js must derive devNull based on binding.platform'
);

// 4. Validate platform identifier sets and platform mapping
const validPlatforms = new Set(['android', 'darwin', 'ios', 'linux', 'win32']);
assert.ok(validPlatforms.has('linux'), 'linux must be a valid bare-os platform');
assert.ok(validPlatforms.has('darwin'), 'darwin must be a valid bare-os platform');
assert.ok(validPlatforms.has('win32'), 'win32 must be a valid bare-os platform');
assert.ok(validPlatforms.has('android'), 'android must be a valid bare-os platform');
assert.ok(validPlatforms.has('ios'), 'ios must be a valid bare-os platform');

// Verify process.platform mapping to bare-os platform identifiers
function mapNodePlatform(nodePlatform) {
  switch (nodePlatform) {
    case 'linux': return 'linux';
    case 'darwin': return 'darwin';
    case 'win32': return 'win32';
    case 'android': return 'android';
    default: return nodePlatform;
  }
}

const currentPlatform = mapNodePlatform(process.platform);
assert.ok(
  validPlatforms.has(currentPlatform),
  `Current mapped platform ${currentPlatform} must be a known bare-os platform`
);

// 5. Verify C native addon binding and multi-platform prebuilt binaries for platform resolution
assert.ok(bindingC.includes('BARE_MODULE(bare_os, bare_os_exports)'), 'binding.c must register bare_os BARE_MODULE');
assert.ok(bindingC.includes('V("platform", BARE_PLATFORM)'), 'binding.c must export platform property from BARE_PLATFORM');
assert.ok(bindingJs.includes('module.exports = require.addon()'), 'binding.js must load native addon via require.addon()');
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 tests passed successfully.');