node-api-version 0.2.1: fromElectronVersion

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 node-api-version.fromElectronVersion in pkg:npm/node-api-version@0.2.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/node-api-version@0.2.1
Demonstrate these symbols/APIs:
  - node-api-version.fromElectronVersion

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:aa16dd2e1b402dbbdb1d8edf9018ce4e677638ea9bc39215a501efa2224c2c12","contract":["fromElectronVersion returns highest supported Node-API version number for valid Electron version strings","fromElectronVersion returns undefined for Electron versions prior to Node-API support"],"goal":"verify node-api-version.fromElectronVersion in pkg:npm/node-api-version@0.2.1","kind":"HOW","packages":["pkg:npm/node-api-version@0.2.1"],"schemaVersion":1,"symbols":["node-api-version.fromElectronVersion"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","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/node-api-version@0.2.1"],"schemaVersion":1,"subject":"pkg:npm/node-api-version@0.2.1","symbols":["node-api-version.fromElectronVersion"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-node-api-version-from-electron",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-node-api-version-from-electron",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "node-api-version": "0.2.1"
      }
    },
    "node_modules/node-api-version": {
      "version": "0.2.1",
      "resolved": "https://registry.npmjs.org/node-api-version/-/node-api-version-0.2.1.tgz",
      "integrity": "sha512-2xP/IGGMmmSQpI1+O/k72jF/ykvZ89JeuKX3TLJAYPDVLUalrshrLHkeVcCCZqG/eEa635cr8IBYzgnDvM2O8Q==",
      "license": "MIT",
      "dependencies": {
        "semver": "^7.3.5"
      }
    },
    "node_modules/semver": {
      "version": "7.8.5",
      "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz",
      "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==",
      "license": "ISC",
      "bin": {
        "semver": "bin/semver.js"
      },
      "engines": {
        "node": ">=10"
      }
    }
  }
}

{
  "name": "sample-node-api-version-from-electron",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification sample for node-api-version fromElectronVersion",
  "type": "module",
  "main": "src/index.mjs",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "node-api-version": "0.2.1"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify node-api-version.fromElectronVersion in pkg:npm/node-api-version@0.2.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/node-api-version@0.2.1"
  ],
  "symbols": [
    "node-api-version.fromElectronVersion"
  ]
}

import { fromElectronVersion } from 'node-api-version';

/**
 * Gets the supported Node-API version for an Electron version string.
 * @param {string} electronVersion
 * @returns {number | undefined}
 */
export function getElectronNodeApiVersion(electronVersion) {
  return fromElectronVersion(electronVersion);
}

/**
 * Checks if Node-API is supported in the given Electron version.
 * @param {string} electronVersion
 * @returns {boolean}
 */
export function isElectronNodeApiSupported(electronVersion) {
  return fromElectronVersion(electronVersion) !== undefined;
}

export { fromElectronVersion };

import assert from 'node:assert';
import {
  fromElectronVersion,
  getElectronNodeApiVersion,
  isElectronNodeApiSupported
} from '../src/index.mjs';

// 1. fromElectronVersion returns highest supported Node-API version number for valid Electron version strings
{
  assert.strictEqual(fromElectronVersion('3.0.0'), 3);
  assert.strictEqual(fromElectronVersion('4.0.0'), 3);
  assert.strictEqual(fromElectronVersion('5.0.0'), 4);
  assert.strictEqual(fromElectronVersion('6.0.0'), 4);
  assert.strictEqual(fromElectronVersion('7.0.0'), 4);
  assert.strictEqual(fromElectronVersion('8.0.0'), 5);
  assert.strictEqual(fromElectronVersion('9.0.0'), 5);
  assert.strictEqual(fromElectronVersion('10.0.0'), 5);
  assert.strictEqual(fromElectronVersion('11.0.0'), 6);
  assert.strictEqual(fromElectronVersion('12.0.0'), 7);
  assert.strictEqual(fromElectronVersion('13.0.0'), 7);
  assert.strictEqual(fromElectronVersion('14.0.0'), 7);
  assert.strictEqual(fromElectronVersion('15.0.0'), 8);
  assert.strictEqual(fromElectronVersion('16.0.0'), 8);
  assert.strictEqual(fromElectronVersion('28.0.0'), 9);
  assert.strictEqual(fromElectronVersion('35.0.0'), 10);

  // Wrapper helpers
  assert.strictEqual(getElectronNodeApiVersion('35.0.0'), 10);
  assert.strictEqual(getElectronNodeApiVersion('15.0.0'), 8);
  assert.strictEqual(isElectronNodeApiSupported('35.0.0'), true);
  assert.strictEqual(isElectronNodeApiSupported('3.0.0'), true);
}

// 2. fromElectronVersion returns undefined for Electron versions prior to Node-API support
{
  assert.strictEqual(fromElectronVersion('0.25.0'), undefined);
  assert.strictEqual(fromElectronVersion('1.0.0'), undefined);
  assert.strictEqual(fromElectronVersion('2.0.0'), undefined);

  // Wrapper helpers
  assert.strictEqual(getElectronNodeApiVersion('2.0.0'), undefined);
  assert.strictEqual(isElectronNodeApiSupported('2.0.0'), false);
}

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