@scp-dev/relay-server 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# SCP relay server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run `npx @scp-dev/relay-server serve` or install with `npm install -g @scp-dev/relay-server`.
+The wrapper selects a native binary through optional dependencies. Node 18 or later is required.
+Set `SCP_RELAY_BINARY` to use a binary at a custom path.
+
+See the [self-host guide](https://scp.dev/docs/self-host) for storage, dashboard and administration.

package/bin/scp-relay.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const { spawn } = require("node:child_process");
+
+let binary = process.env.SCP_RELAY_BINARY;
+if (!binary) {
+  let key = `${process.platform}-${process.arch}`;
+  if (process.platform === "linux") {
+    key += process.report.getReport().header.glibcVersionRuntime ? "-gnu" : "-musl";
+  }
+  const name = `@scp-dev/relay-server-${key}`;
+  try {
+    binary = require.resolve(`${name}/bin/scp-relay${process.platform === "win32" ? ".exe" : ""}`);
+  } catch {
+    console.error(`Missing relay binary package ${name}. Install with optional dependencies enabled on a supported platform, or set SCP_RELAY_BINARY.`);
+    process.exit(1);
+  }
+}
+const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
+for (const signal of ["SIGINT", "SIGTERM"]) process.on(signal, () => child.kill(signal));
+child.on("error", (error) => {
+  console.error(`Cannot start SCP relay: ${error.message}`);
+  process.exitCode = 1;
+});
+child.on("exit", (code, signal) => {
+  if (signal) {
+    process.removeAllListeners(signal);
+    process.kill(process.pid, signal);
+  } else process.exitCode = code ?? 1;
+});

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@scp-dev/relay-server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Self-hosted SCP relay server",
+  "bin": {
+    "scp-relay": "bin/scp-relay.js"
+  },
+  "optionalDependencies": {
+    "@scp-dev/relay-server-darwin-arm64": "0.1.0",
+    "@scp-dev/relay-server-darwin-x64": "0.1.0",
+    "@scp-dev/relay-server-linux-x64-gnu": "0.1.0",
+    "@scp-dev/relay-server-linux-arm64-gnu": "0.1.0",
+    "@scp-dev/relay-server-linux-x64-musl": "0.1.0",
+    "@scp-dev/relay-server-win32-x64": "0.1.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "bin",
+    "README.md"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scphq/scp.git",
+    "directory": "crates/npm/relay-server"
+  },
+  "homepage": "https://scp.dev",
+  "publishConfig": {
+    "access": "public"
+  }
+}