pe-library 0.4.1

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 pkg:npm/pe-library@0.4.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/pe-library@0.4.1

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:ac18486f81e0cc9485923049de3c43ec83d3730b6fa4a814b307b73bd24bc2e4","contract":["NtExecutable.createEmpty creates 64-bit or 32-bit PE executables with DOS and NT headers","NtExecutable.generate serializes executable image into binary ArrayBuffer","NtExecutable.from parses PE binary data into NtExecutable preserving architecture and alignment","NtExecutableResource adds and retrieves UTF-8 resource entries across serialization roundtrip"],"goal":"verify pkg:npm/pe-library@0.4.1","kind":"HOW","packages":["pkg:npm/pe-library@0.4.1"],"schemaVersion":1},"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/pe-library@0.4.1"],"schemaVersion":1,"subject":"pkg:npm/pe-library@0.4.1","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-pe-library",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-pe-library",
      "version": "1.0.0",
      "dependencies": {
        "pe-library": "0.4.1"
      }
    },
    "node_modules/pe-library": {
      "version": "0.4.1",
      "resolved": "https://registry.npmjs.org/pe-library/-/pe-library-0.4.1.tgz",
      "integrity": "sha512-eRWB5LBz7PpDu4PUlwT0PhnQfTQJlDDdPa35urV4Osrm0t0AqQFGn+UIkU3klZvwJ8KPO3VbBFsXquA6p6kqZw==",
      "license": "MIT",
      "engines": {
        "node": ">=12",
        "npm": ">=6"
      },
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/jet2jet"
      }
    }
  }
}

{
  "name": "sample-pe-library",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "dependencies": {
    "pe-library": "0.4.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/pe-library@0.4.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/pe-library@0.4.1"
  ]
}

import assert from 'node:assert/strict';
import { NtExecutable, NtExecutableResource } from 'pe-library';

// 1. NtExecutable.createEmpty creates 64-bit and 32-bit executable instances with headers
const exe64 = NtExecutable.createEmpty(false, true);
assert.equal(exe64.is32bit(), false, 'createEmpty(false, true) should create a 64-bit binary');
assert.ok(exe64.dosHeader, 'dosHeader should be present');
assert.ok(exe64.newHeader, 'newHeader should be present');
assert.equal(typeof exe64.getImageBase(), 'number', 'getImageBase should return number');
assert.equal(typeof exe64.getFileAlignment(), 'number', 'getFileAlignment should return number');
assert.equal(typeof exe64.getSectionAlignment(), 'number', 'getSectionAlignment should return number');
assert.ok(Array.isArray(exe64.getAllSections()), 'getAllSections should return an array');

const exe32 = NtExecutable.createEmpty(true, false);
assert.equal(exe32.is32bit(), true, 'createEmpty(true, false) should create a 32-bit binary');

// 2. NtExecutableResource manages resource entries and updates executable structure
const res = NtExecutableResource.from(exe64);
assert.ok(res, 'NtExecutableResource.from should return resource manager');
assert.ok(Array.isArray(res.entries), 'entries should be an array');

// Add string resource
res.replaceResourceEntryFromString('CUSTOM_DATA', 101, 1033, 'CodeSampleX PE Verification');
const entries = res.getResourceEntriesAsString('CUSTOM_DATA', 101);
assert.equal(entries.length, 1, 'Should have 1 resource entry');
assert.equal(entries[0][0], 1033, 'Language ID should match 1033');
assert.equal(entries[0][1], 'CodeSampleX PE Verification', 'Resource content should match');

// Output resources to executable
res.outputResource(exe64);

// 3. exe.generate produces valid binary that NtExecutable.from can parse back
const bin = exe64.generate();
assert.ok(bin instanceof ArrayBuffer, 'generate should return an ArrayBuffer');
assert.ok(bin.byteLength > 0, 'binary length should be non-zero');

const parsedExe = NtExecutable.from(bin);
assert.equal(parsedExe.is32bit(), false, 'parsed executable should match 64-bit architecture');
assert.equal(parsedExe.getFileAlignment(), exe64.getFileAlignment(), 'file alignment should be preserved');
assert.equal(parsedExe.getSectionAlignment(), exe64.getSectionAlignment(), 'section alignment should be preserved');

// Verify resource roundtrip
const parsedRes = NtExecutableResource.from(parsedExe);
const parsedEntries = parsedRes.getResourceEntriesAsString('CUSTOM_DATA', 101);
assert.equal(parsedEntries.length, 1, 'Roundtripped resource count should match');
assert.equal(parsedEntries[0][0], 1033, 'Roundtripped language ID should match');
assert.equal(parsedEntries[0][1], 'CodeSampleX PE Verification', 'Roundtripped resource content should match');

console.log('pe-library contract test passed.');