@opentf/web-compiler 0.1.0

package/README.md

@@ -0,0 +1,33 @@
+# @opentf/web-compiler
+
+Prebuilt binaries for **otfwc**, the OTF Web IR compiler (a Rust binary). You
+normally don't install this directly — `@opentf/web-cli` depends on it.
+
+```js
+import { otfwcPath } from "@opentf/web-compiler";
+const bin = otfwcPath(); // absolute path to the otfwc executable for this platform
+```
+
+## How it works
+
+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`).
+
+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
+larger). `OTFWC_BIN` overrides everything (used in this repo's own dev to point at
+the cargo `target/` build).
+
+## Releasing (CI)
+
+`bin/` is empty in git, and the package is `private: true` only as a guard so the
+monorepo `changeset publish` doesn't ship it binary-less. It is published by its
+own workflow, `.github/workflows/release-compiler.yml` (run manually after a
+release): that cross-builds otfwc for each target, brotli-compresses each into
+`bin/<platform>/`, flips `private` off, and publishes — so the package on npm is
+public. Versioning is owned entirely by changesets — there is no version-sync
+script.

package/extract.js

@@ -0,0 +1,73 @@
+//! 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).
+
+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(fileURLToPath(import.meta.url));
+
+// `process.platform-process.arch` maps directly onto our bin/ subdirectory names.
+const SUPPORTED = new Set([
+  "linux-x64",
+  "linux-arm64",
+  "darwin-x64",
+  "darwin-arm64",
+  "win32-x64",
+]);
+
+function hostBinPath() {
+  const key = `${process.platform}-${process.arch}`;
+  if (!SUPPORTED.has(key)) return null;
+  const bin = process.platform === "win32" ? "otfwc.exe" : "otfwc";
+  return join(here, "bin", key, bin);
+}
+
+/** 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);
+  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`.
+ */
+export function extractIfPackaged() {
+  const out = hostBinPath();
+  if (!out || existsSync(out) || !existsSync(`${out}.br`)) return null;
+  try {
+    return decompress(out);
+  } catch {
+    return null; // lazy fallback in otfwcPath() will retry / surface the error
+  }
+}
+
+/** 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`);
+  }
+  const out = hostBinPath();
+  if (!out) {
+    throw new Error(
+      `otfwc: no prebuilt binary for ${process.platform}-${process.arch}. ` +
+        `Supported: ${[...SUPPORTED].join(", ")}. Build from source and set OTFWC_BIN.`,
+    );
+  }
+  if (existsSync(out)) return out;
+  if (existsSync(`${out}.br`)) return decompress(out);
+  throw new Error(
+    `otfwc: prebuilt binary missing at ${out}. ` +
+      `Reinstall @opentf/web-compiler, or set OTFWC_BIN.`,
+  );
+}

package/index.js

@@ -0,0 +1,10 @@
+//! Resolve the `otfwc` compiler binary for the current platform.
+//
+// otfwc is a Rust binary. It ships brotli-compressed for every supported platform
+// inside this single package under `bin/<platform>-<arch>/otfwc[.exe].br`; the
+// host's copy is decompressed on install (and lazily here as a fallback). The
+// toolchain (`@opentf/web-cli`) calls `otfwcPath()` to get the executable path.
+// `OTFWC_BIN` overrides everything (used in this repo's own dev to point at the
+// cargo build). See extract.js for the decompression logic.
+
+export { otfwcPath } from "./extract.js";

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@opentf/web-compiler",
+  "version": "0.1.0",
+  "description": "OTF Web IR compiler (otfwc) — prebuilt platform binaries + host resolver (ARCHITECTURE.md §8).",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "files": [
+    "index.js",
+    "extract.js",
+    "scripts",
+    "bin"
+  ],
+  "keywords": [
+    "opentf",
+    "compiler",
+    "jsx",
+    "web-components",
+    "ssg"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Open-Tech-Foundation/Web-App-Framework.git",
+    "directory": "packages/web-compiler"
+  },
+  "homepage": "https://github.com/Open-Tech-Foundation/Web-App-Framework#readme",
+  "bugs": "https://github.com/Open-Tech-Foundation/Web-App-Framework/issues",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,7 @@
+//! 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();