@opentf/web-compiler 0.17.0 → 0.18.0

package/README.md

@@ -12,10 +12,9 @@ const bin = otfwcPath(); // absolute path to the otfwc executable for this platf
 
 This single package ships the `otfwc` binary for every supported platform,
 **brotli-compressed**, under `bin/<platform>-<arch>/otfwc[.exe].br` (~0.65 MB each
-vs ~2.3 MB raw). On install a `postinstall` script decompresses **only the host's**
-binary; `otfwcPath()` also decompresses lazily as a fallback (e.g. under
-`--ignore-scripts`) and returns the path matching the host
-(`process.platform-process.arch`).
+vs ~2.3 MB raw). `otfwcPath()` decompresses **only the host's** binary lazily on
+first use, so installation has no Node lifecycle hook, and returns the path
+matching the host.
 
 Shipping all platforms in one package is cheaper to maintain than the per-platform
 optionalDependencies fan-out that rolldown/swc/esbuild use (their binaries are far

package/extract.js

@@ -1,70 +1,77 @@
 //! Decompress the host's otfwc binary from its shipped brotli archive.
 //
 // The package ships one brotli-compressed binary per platform under
-// `bin/<platform>-<arch>/otfwc[.exe].br` (~0.65MB each vs ~2.3MB raw). On install
-// the postinstall script decompresses only the host's; `otfwcPath()` also does it
-// lazily as a fallback (e.g. when scripts are skipped with --ignore-scripts).
+// `bin/<platform>-<arch>/otfwc[.exe].br` (~0.65MB each vs ~2.3MB raw).
+// `otfwcPath()` decompresses the host's archive lazily on first use.
+//
+// It runs under the ES-Runtime alongside the rest of the toolchain, so package
+// installation needs no Node lifecycle hook.
+
+import { chmod, exists, file, write } from "runtime:fs";
+import { dirname, fromFileURL, join } from "runtime:path";
+import { arch, env, platform } from "runtime:process";
 
-import { existsSync, readFileSync, writeFileSync, chmodSync } from "node:fs";
-import { brotliDecompressSync } from "node:zlib";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
+const here = dirname(fromFileURL(import.meta.url));
 
-const here = dirname(fileURLToPath(import.meta.url));
+// The shipped `bin/` subdirectories are named the way node reports a host, which is
+// not how the runtime does; map onto them rather than renaming what we publish.
+const OS_NAMES = { linux: "linux", macos: "darwin", windows: "win32" };
+const ARCH_NAMES = { x86_64: "x64", aarch64: "arm64" };
 
-// `process.platform-process.arch` maps directly onto our bin/ subdirectory names.
-const SUPPORTED = new Set([
-  "linux-x64",
-  "darwin-x64",
-  "darwin-arm64",
-  "win32-x64",
-]);
+const SUPPORTED = new Set(["linux-x64", "darwin-x64", "darwin-arm64", "win32-x64"]);
 
-function hostBinPath() {
-  const key = `${process.platform}-${process.arch}`;
+function hostKey(platformName = platform, architecture = arch) {
+  const os = OS_NAMES[platformName];
+  const cpu = ARCH_NAMES[architecture];
+  return os && cpu ? `${os}-${cpu}` : `${platformName}-${architecture}`;
+}
+
+function hostBinPath({ binaryDir = here, os = platform, cpuArch = arch } = {}) {
+  const key = hostKey(os, cpuArch);
   if (!SUPPORTED.has(key)) return null;
-  const bin = process.platform === "win32" ? "otfwc.exe" : "otfwc";
-  return join(here, "bin", key, bin);
+  return join(binaryDir, "bin", key, os === "windows" ? "otfwc.exe" : "otfwc");
 }
 
 /** Decompress the host's `.br` archive to a runnable binary; returns its path. */
-function decompress(out) {
-  const archive = `${out}.br`;
-  writeFileSync(out, brotliDecompressSync(readFileSync(archive)));
-  if (process.platform !== "win32") chmodSync(out, 0o755);
+async function decompress(out, os = platform) {
+  const compressed = await file(`${out}.br`).stream();
+  const plain = compressed.pipeThrough(new DecompressionStream("brotli"));
+  await write(out, new Uint8Array(await new Response(plain).arrayBuffer()));
+  if (os !== "windows") await chmod(out, 0o755);
   return out;
 }
 
 /**
  * Best-effort: decompress the host binary if the archive is present. No-op (returns
- * null) on an unsupported platform or a source checkout without the `.br`. Used by
- * the postinstall script — never throws, so it can't break `npm install`.
+ * null) on an unsupported platform or a source checkout without the `.br`. Never
+ * throws — the caller falls back to reporting the missing binary itself.
  */
-export function extractIfPackaged() {
+export async function extractIfPackaged() {
   const out = hostBinPath();
-  if (!out || existsSync(out) || !existsSync(`${out}.br`)) return null;
+  if (!out) return null;
   try {
-    return decompress(out);
+    if ((await exists(out)) || !(await exists(`${out}.br`))) return null;
+    return await decompress(out);
   } catch {
-    return null; // lazy fallback in otfwcPath() will retry / surface the error
+    return null;
   }
 }
 
 /** Absolute path to the otfwc executable, or throw with a clear message. */
-export function otfwcPath() {
-  if (process.env.OTFWC_BIN) {
-    if (existsSync(process.env.OTFWC_BIN)) return process.env.OTFWC_BIN;
-    throw new Error(`otfwc: OTFWC_BIN is set but ${process.env.OTFWC_BIN} does not exist`);
+export async function otfwcPath({ binaryDir = here, environment = env, os = platform, cpuArch = arch } = {}) {
+  if (environment.OTFWC_BIN) {
+    if (await exists(environment.OTFWC_BIN)) return environment.OTFWC_BIN;
+    throw new Error(`otfwc: OTFWC_BIN is set but ${environment.OTFWC_BIN} does not exist`);
   }
-  const out = hostBinPath();
+  const out = hostBinPath({ binaryDir, os, cpuArch });
   if (!out) {
     throw new Error(
-      `otfwc: no prebuilt binary for ${process.platform}-${process.arch}. ` +
+      `otfwc: no prebuilt binary for ${hostKey(os, cpuArch)}. ` +
         `Supported: ${[...SUPPORTED].join(", ")}. Build from source and set OTFWC_BIN.`,
     );
   }
-  if (existsSync(out)) return out;
-  if (existsSync(`${out}.br`)) return decompress(out);
+  if (await exists(out)) return out;
+  if (await exists(`${out}.br`)) return decompress(out, os);
   throw new Error(
     `otfwc: prebuilt binary missing at ${out}. ` +
       `Reinstall @opentf/web-compiler, or set OTFWC_BIN.`,

package/package.json

@@ -1,19 +1,15 @@
 {
   "name": "@opentf/web-compiler",
-  "version": "0.17.0",
-  "description": "OTF Web IR compiler (otfwc) — prebuilt platform binaries + host resolver (ARCHITECTURE.md §8).",
+  "version": "0.18.0",
+  "description": "OTF Web native toolchain (otfwc) — component compilation and documentation indexing in one platform binary.",
   "type": "module",
   "main": "index.js",
   "exports": {
     ".": "./index.js"
   },
-  "scripts": {
-    "postinstall": "node scripts/postinstall.js"
-  },
   "files": [
     "index.js",
     "extract.js",
-    "scripts",
     "bin"
   ],
   "keywords": [

package/scripts/postinstall.js

@@ -1,7 +0,0 @@
-//! Decompress the host's otfwc binary after install. Best-effort: a no-op on a
-//! source checkout (no `.br` present) and never throws, so it can't break install.
-//! `otfwcPath()` decompresses lazily anyway if this is skipped (--ignore-scripts).
-
-import { extractIfPackaged } from "../extract.js";
-
-extractIfPackaged();