herdr-remote-relay 0.3.25 → 0.3.27

package/README.md

@@ -11,10 +11,12 @@ Brokers WebSocket connections between browsers and workstation host connectors.
 ## Installation
 
 ```bash
-npm install -g herdr-remote-relay
+npm install -g https://github.com/dibin666/herdr-remote/releases/latest/download/herdr-remote-relay.tgz
 herdr-remote-relay --public-url https://herdr.example.com --password <password>
 ```
 
+From npm instead: `npm install -g herdr-remote-relay` (it can lag a new release by a while).
+
 Requirements: Node.js 22+, TLS reverse proxy (nginx, Caddy, Cloudflare Tunnel).
 
 ## Docker

package/README.zh-CN.md

@@ -11,10 +11,12 @@
 ## 安装
 
 ```bash
-npm install -g herdr-remote-relay
+npm install -g https://github.com/dibin666/herdr-remote/releases/latest/download/herdr-remote-relay.tgz
 herdr-remote-relay --public-url https://herdr.example.com --password <密码>
 ```
 
+也可从 npm 安装：`npm install -g herdr-remote-relay`（新版本上线后 npm 可能要过一段时间才同步）。
+
 前置要求：Node.js 22+、TLS 反向代理（nginx、Caddy、Cloudflare Tunnel 等）。
 
 ## Docker 运行

package/dist/protocol/index.d.ts

@@ -3,4 +3,5 @@ export * from './terminal.js';
 export * from './herdr-keys.js';
 export * from './messages.js';
 export * from './paste.js';
+export * from './release.js';
 export type * from './http.js';

package/dist/protocol/index.js

@@ -6,3 +6,4 @@ export * from './terminal.js';
 export * from './herdr-keys.js';
 export * from './messages.js';
 export * from './paste.js';
+export * from './release.js';

package/dist/protocol/release.d.ts

@@ -0,0 +1,8 @@
+/** Also the name an update check reports as its source. */
+export declare const GITHUB_RELEASES_URL = "https://github.com/dibin666/herdr-remote/releases";
+/** `{ schema, version, tag, relayVersion, tarball }`, attached to every release. */
+export declare const LATEST_RELEASE_MANIFEST_URL = "https://github.com/dibin666/herdr-remote/releases/latest/download/latest.json";
+/** The newest self-contained CLI tarball, for a workstation that cannot say which it needs. */
+export declare const LATEST_CLI_TARBALL_URL = "https://github.com/dibin666/herdr-remote/releases/latest/download/herdr-remote.tgz";
+/** One CLI release's self-contained tarball; it bundles the relay it was released with. */
+export declare function cliTarballUrl(version: string): string;

package/dist/protocol/release.js

@@ -0,0 +1,17 @@
+// Where herdr-remote is released. The CLI updates from here and the browser
+// shows the same addresses in its manual steps, so there is one definition.
+//
+// GitHub Releases is the primary channel: a release is downloadable the moment
+// it is created, whereas npm can take many minutes after `npm publish` before
+// a new version installs. npm carries the same tarballs as a fallback.
+const RELEASE_REPOSITORY = 'dibin666/herdr-remote';
+/** Also the name an update check reports as its source. */
+export const GITHUB_RELEASES_URL = `https://github.com/${RELEASE_REPOSITORY}/releases`;
+/** `{ schema, version, tag, relayVersion, tarball }`, attached to every release. */
+export const LATEST_RELEASE_MANIFEST_URL = `${GITHUB_RELEASES_URL}/latest/download/latest.json`;
+/** The newest self-contained CLI tarball, for a workstation that cannot say which it needs. */
+export const LATEST_CLI_TARBALL_URL = `${GITHUB_RELEASES_URL}/latest/download/herdr-remote.tgz`;
+/** One CLI release's self-contained tarball; it bundles the relay it was released with. */
+export function cliTarballUrl(version) {
+    return `${GITHUB_RELEASES_URL}/download/herdr-remote-v${version}/herdr-remote-${version}.tgz`;
+}

package/dist/relay-server.d.ts

@@ -21,6 +21,8 @@ export interface RelayServerOptions {
     devLatencyMs?: number | string;
     metrics?: RelayMetrics;
     auth?: AuthStore;
+    /** The built web client to serve; defaults to the package's `web/dist`. */
+    publicDir?: string;
 }
 export type RelayAddress = {
     host: string;
@@ -47,6 +49,7 @@ declare class RelayServer implements RelayContext {
     trustProxy: boolean;
     devLatencyMs: number;
     devDelayMs: number;
+    publicDir: string;
     sendQueues: WeakMap<RelaySocket, SendQueue>;
     activeDelayTimers: Set<NodeJS.Timeout>;
     auth: AuthStore;

package/dist/relay-server.js

@@ -10,7 +10,7 @@ import { PROTOCOL_VERSION, WS_CLIENT_PATH, WS_HOST_PATH } from './protocol/index
 import { DEFAULTS, defaultStateDir, loadRelayConfig } from './relay-config.js';
 import { handleClientConnection } from './server/client-channel.js';
 import { handleHostConnection } from './server/host-channel.js';
-import { handleHttp } from './server/http-api.js';
+import { handleHttp, PUBLIC_DIR } from './server/http-api.js';
 import { heartbeat, sweep } from './server/maintenance.js';
 import { isAllowedOrigin } from './server/requests.js';
 import { detachClient, detachHost } from './server/sessions.js';
@@ -35,6 +35,7 @@ class RelayServer {
     trustProxy;
     devLatencyMs;
     devDelayMs;
+    publicDir;
     sendQueues = new WeakMap();
     activeDelayTimers = new Set();
     auth;
@@ -57,6 +58,7 @@ class RelayServer {
         this.password = options.password ?? auth.password ?? null;
         this.adminToken = options.adminToken ?? auth.adminToken ?? null;
         this.trustProxy = Boolean(options.trustProxy ?? relay.trustProxy);
+        this.publicDir = path.resolve(options.publicDir ?? PUBLIC_DIR);
         // Development-only artificial latency switch for local responsiveness profiling.
         // When unset or 0, this incurs zero overhead and avoids entering the delayed path.
         // RELAY_DEV_LATENCY_MS specifies round-trip delay, so each one-way leg

package/dist/server/http-api.d.ts

@@ -1,3 +1,4 @@
 import type { IncomingMessage, ServerResponse } from 'node:http';
 import type { RelayContext } from './types.js';
+export declare const PUBLIC_DIR: string;
 export declare function handleHttp(relay: RelayContext, req: IncomingMessage, res: ServerResponse): void;

package/dist/server/http-api.js

@@ -10,7 +10,8 @@ import { detachDeviceSessions } from './sessions.js';
 import { isOpen } from './sockets.js';
 import { statusSnapshot } from './status.js';
 import { VERSION } from './version.js';
-const PUBLIC_DIR = path.join(PACKAGE_ROOT, 'web', 'dist');
+export const PUBLIC_DIR = path.join(PACKAGE_ROOT, 'web', 'dist');
+const FONT_CACHE_SECONDS = 7 * 24 * 60 * 60;
 const MIME_TYPES = {
     '.html': 'text/html; charset=utf-8',
     '.js': 'text/javascript; charset=utf-8',
@@ -179,21 +180,21 @@ export function handleHttp(relay, req, res) {
         sendError(res, 404, 'not_found', 'API route not found');
         return;
     }
-    serveStatic(pathname, res);
+    serveStatic(relay.publicDir, pathname, res);
 }
-function serveStatic(requestPath, res) {
+function serveStatic(publicDir, requestPath, res) {
     const relative = requestPath === '/' || requestPath === '/admin'
         ? 'index.html'
         : requestPath.replace(/^\/+/, '');
-    const candidate = path.resolve(PUBLIC_DIR, relative);
-    if (!candidate.startsWith(`${PUBLIC_DIR}${path.sep}`) &&
-        candidate !== path.join(PUBLIC_DIR, 'index.html')) {
+    const candidate = path.resolve(publicDir, relative);
+    if (!candidate.startsWith(`${publicDir}${path.sep}`) &&
+        candidate !== path.join(publicDir, 'index.html')) {
         sendError(res, 403, 'forbidden', 'path is not allowed');
         return;
     }
     fs.readFile(candidate, (error, data) => {
         if (error && !path.extname(relative)) {
-            fs.readFile(path.join(PUBLIC_DIR, 'index.html'), (fallbackError, fallbackData) => {
+            fs.readFile(path.join(publicDir, 'index.html'), (fallbackError, fallbackData) => {
                 if (fallbackError) {
                     sendError(res, 503, 'web_not_built', 'frontend has not been built');
                     return;
@@ -209,6 +210,10 @@ function serveStatic(requestPath, res) {
         }
         const extension = path.extname(candidate).toLowerCase();
         setResponseHeaders(res, MIME_TYPES[extension] || 'application/octet-stream');
+        // The bundled fonts run to megabytes and only change with a release; a
+        // week is short enough that a font upgrade still arrives.
+        if (relative.startsWith('fonts/'))
+            res.setHeader('Cache-Control', `public, max-age=${FONT_CACHE_SECONDS}`);
         res.end(data);
     });
 }

package/dist/server/types.d.ts

@@ -118,6 +118,8 @@ export interface RelayContext {
     trustProxy: boolean;
     devLatencyMs: number;
     devDelayMs: number;
+    /** Where the built web client is served from. */
+    publicDir: string;
     sendQueues: WeakMap<RelaySocket, SendQueue>;
     activeDelayTimers: Set<NodeJS.Timeout>;
     finishHandshake(ws: RelaySocket): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "herdr-remote-relay",
-  "version": "0.3.25",
+  "version": "0.3.27",
   "description": "Standalone relay server and web terminal for Herdr Remote",
   "license": "MIT",
   "type": "module",