onepipeline-api-cli 0.3.1

package/bin/onepipeline-api.js

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+// Launcher for the `onepipeline-api` command installed from the
+// `onepipeline-api-cli` npm package.
+//
+// Like the PyPI wheels (maturin `bindings = "bin"`, see pyproject.toml), the npm
+// distribution carries the *prebuilt* Rust binary — no Rust toolchain, no
+// compile, no download at install time. The platform-specific binary ships
+// inside a per-platform package (`onepipeline-api-cli-<platform>-<arch>`)
+// declared in this package's `optionalDependencies`; npm installs only the one
+// whose `os`/`cpu` match the host, and this shim resolves it and execs it with
+// the caller's argv.
+//
+// This file is committed source; the version and the optionalDependency
+// versions are stamped from Cargo.toml at publish time by scripts/npm-build.mjs,
+// which also generates the per-platform packages from the release binaries.
+
+"use strict";
+
+const { spawnSync } = require("node:child_process");
+
+// process.platform-process.arch -> the platform package that carries the binary.
+// The keys mirror the Rust target matrix in .github/workflows/release.yml and
+// the optionalDependencies in package.json; keep the three in lockstep.
+const PACKAGES = {
+  "linux-x64": "onepipeline-api-cli-linux-x64",
+  "linux-arm64": "onepipeline-api-cli-linux-arm64",
+  "darwin-x64": "onepipeline-api-cli-darwin-x64",
+  "darwin-arm64": "onepipeline-api-cli-darwin-arm64",
+  "win32-x64": "onepipeline-api-cli-win32-x64",
+};
+
+// Every failure here is a failed install, so say what to do about it rather than
+// only what went wrong.
+const OTHER_INSTALLS =
+  "Install another way instead: 'pip install onepipeline-api-cli', or " +
+  "'cargo install onepipeline-ui --locked'.";
+
+function fail(message) {
+  process.stderr.write(`onepipeline-api: ${message}\n`);
+  process.exit(1);
+}
+
+function binaryPath() {
+  const key = `${process.platform}-${process.arch}`;
+  const pkg = PACKAGES[key];
+  // llmlint: ignore-block[changed_behavior_has_e2e] reaching this branch means running
+  // where no prebuilt package exists, and a test can only get there by lying to node
+  // about process.platform — which would prove the lie. The sibling branches are driven
+  // for real by tests/e2e/packaging.rs (npm omits the optional dependency; the binary
+  // resolves and execs), and npm's own os/cpu fields keep a user from installing a
+  // platform package this map does not name.
+  if (!pkg) {
+    fail(
+      `unsupported platform ${key}. Prebuilt binaries exist for: ` +
+        `${Object.keys(PACKAGES).join(", ")}. ${OTHER_INSTALLS}`
+    );
+  }
+  // llmlint: ignore-end[changed_behavior_has_e2e]
+
+  const binName =
+    process.platform === "win32" ? "onepipeline-api.exe" : "onepipeline-api";
+  try {
+    // Resolve the platform package's manifest, then locate the binary beside it.
+    // Resolving package.json (rather than the binary file directly) is portable
+    // across Node resolution modes and does not require an `exports` entry for a
+    // non-JS asset.
+    const path = require("node:path");
+    const manifest = require.resolve(`${pkg}/package.json`);
+    return path.join(path.dirname(manifest), "bin", binName);
+  } catch (_err) {
+    fail(
+      `the platform package ${pkg} is not installed. This usually means npm ` +
+        "skipped optional dependencies (e.g. --no-optional / --omit=optional) " +
+        "or the install was for a different platform. Reinstall with optional " +
+        `dependencies enabled. ${OTHER_INSTALLS}`
+    );
+  }
+}
+
+const result = spawnSync(binaryPath(), process.argv.slice(2), {
+  stdio: "inherit",
+});
+
+if (result.error) {
+  fail(`failed to launch the onepipeline-api binary: ${result.error.message}`);
+}
+
+// Re-raise a terminating signal so callers observe the true cause; otherwise
+// propagate the child's exit code verbatim — a caller scripting against the
+// documented exit codes depends on seeing them.
+if (result.signal) {
+  process.kill(process.pid, result.signal);
+}
+process.exit(result.status === null ? 1 : result.status);

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "onepipeline-api-cli",
+  "version": "0.3.1",
+  "description": "Read API and browser view for onepipeline runs.",
+  "keywords": [
+    "cli",
+    "api",
+    "telemetry",
+    "observability",
+    "onepipeline"
+  ],
+  "homepage": "https://github.com/nickderobertis/onepipeline-ui",
+  "bugs": "https://github.com/nickderobertis/onepipeline-ui/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nickderobertis/onepipeline-ui.git"
+  },
+  "license": "MIT",
+  "author": "Nick DeRobertis",
+  "bin": {
+    "onepipeline-api": "bin/onepipeline-api.js"
+  },
+  "files": [
+    "bin/onepipeline-api.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "onepipeline-api-cli-linux-x64": "0.3.1",
+    "onepipeline-api-cli-linux-arm64": "0.3.1",
+    "onepipeline-api-cli-darwin-x64": "0.3.1",
+    "onepipeline-api-cli-darwin-arm64": "0.3.1",
+    "onepipeline-api-cli-win32-x64": "0.3.1"
+  }
+}