herdr-remote 0.2.39 → 0.3.31

package/dist/paths.js

@@ -1,74 +0,0 @@
-// Where herdr-remote keeps its files: the package itself, the configuration
-// directory and the state directory.
-import fs from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
-/**
- * Locate the package directory by walking up to our own package.json.
- *
- * This module runs from src/ under the tests and from dist/ once built.
- * Everything that matters — the plugin manifest, the host connector entry
- * point, the systemd unit's ExecStart — is resolved from this value, so it has
- * to be independent of where the code happens to be loaded from.
- */
-function findPackageRoot(start) {
-    let directory = start;
-    for (let depth = 0; depth < 8; depth += 1) {
-        const candidate = path.join(directory, 'package.json');
-        try {
-            if (JSON.parse(fs.readFileSync(candidate, 'utf8')).name === 'herdr-remote')
-                return directory;
-        }
-        catch {
-            // Keep climbing: a missing or unrelated package.json is expected.
-        }
-        const parent = path.dirname(directory);
-        if (parent === directory)
-            break;
-        directory = parent;
-    }
-    return path.resolve(start, '..');
-}
-const PACKAGE_ROOT = findPackageRoot(import.meta.dirname);
-/**
- * The canonical configuration directory.
- *
- * Deliberately NOT $HERDR_PLUGIN_CONFIG_DIR: Herdr sets that variable only when
- * it launches the plugin itself, so honouring it would give "herdr-remote" run
- * from a shell and the same tool run from a Herdr pane two different config
- * files. One path, one config; `migrateLegacyConfig()` imports the old one.
- * On Windows, configuration roams under `APPDATA` while state and logs stay
- * local under `LOCALAPPDATA`, following Windows and Herdr's directory layout.
- */
-function configDir(env = process.env, platform = process.platform) {
-    if (env.HERDR_REMOTE_CONFIG_DIR)
-        return env.HERDR_REMOTE_CONFIG_DIR;
-    if (platform === 'win32') {
-        return path.join(env.APPDATA || path.join(os.homedir(), 'AppData', 'Roaming'), 'herdr-remote');
-    }
-    return path.join(os.homedir(), '.config', 'herdr-remote');
-}
-function stateDir(env = process.env, platform = process.platform) {
-    if (env.HERDR_REMOTE_STATE_DIR)
-        return env.HERDR_REMOTE_STATE_DIR;
-    if (platform === 'win32') {
-        return path.join(env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local'), 'herdr-remote');
-    }
-    return path.join(os.homedir(), '.local', 'state', 'herdr-remote');
-}
-function configPath() {
-    return path.join(configDir(), 'config.json');
-}
-function runtimeStatePath() {
-    return path.join(stateDir(), 'runtime.json');
-}
-/** Where a service (relay, host, supervisor) writes its output. */
-function logPath(name) {
-    return path.join(stateDir(), `${name}.log`);
-}
-function legacyConfigPath() {
-    return process.env.HERDR_PLUGIN_CONFIG_DIR
-        ? path.join(process.env.HERDR_PLUGIN_CONFIG_DIR, 'config.json')
-        : null;
-}
-export { PACKAGE_ROOT, configDir, stateDir, configPath, runtimeStatePath, logPath, legacyConfigPath, };

package/dist/pty-session.js

@@ -1,133 +0,0 @@
-import os from 'node:os';
-import { nodePty } from './node-pty-loader.js';
-/**
- * Variables that name the terminal this process was started from. The Herdr
- * client's outer terminal is the browser's xterm.js, and from Herdr 0.9.2 the
- * client reads these to pick image transports: one that believes it runs in
- * Ghostty, kitty or WezTerm hands images over as local file paths no browser
- * can open. Herdr strips the same list from its own panes.
- */
-const OUTER_TERMINAL_ENV = [
-    'TERM_PROGRAM',
-    'TERM_PROGRAM_VERSION',
-    'ITERM_SESSION_ID',
-    'LC_TERMINAL',
-    'LC_TERMINAL_VERSION',
-    'WEZTERM_PANE',
-    'KITTY_WINDOW_ID',
-    'WT_SESSION',
-    'TMUX',
-    'TMUX_PANE',
-    'STY',
-    'ZELLIJ',
-    'ZELLIJ_SESSION_NAME',
-    'ZELLIJ_PANE_ID',
-];
-class PtySession {
-    static DEFAULT_COLS = 100;
-    static DEFAULT_ROWS = 30;
-    static MIN_DIMENSION = 2;
-    static MAX_DIMENSION = 500;
-    command;
-    args;
-    cwd;
-    socketPath;
-    platform;
-    fastWindowsPty;
-    spawnPty;
-    terminal;
-    startedAt;
-    constructor({ command, args = [], cwd = os.homedir(), socketPath, platform = process.platform, spawn: spawnPty = nodePty().spawn, fastWindowsPty = false, } = {}) {
-        if (typeof command !== 'string' || command.length === 0)
-            throw new TypeError('command must be a non-empty string');
-        if (!Array.isArray(args) || !args.every((arg) => typeof arg === 'string'))
-            throw new TypeError('args must be strings');
-        this.command = command;
-        this.args = args;
-        this.cwd = cwd;
-        this.socketPath = socketPath;
-        this.platform = platform;
-        this.fastWindowsPty = fastWindowsPty;
-        this.spawnPty = spawnPty;
-        this.terminal = null;
-        this.startedAt = null;
-    }
-    static childEnv(socketPath, source = process.env) {
-        const env = { ...source };
-        for (const key of Object.keys(env)) {
-            if (key.startsWith('HERDR_'))
-                delete env[key];
-        }
-        for (const key of OUTER_TERMINAL_ENV)
-            delete env[key];
-        if (socketPath)
-            env.HERDR_SOCKET_PATH = socketPath;
-        env.TERM = 'xterm-256color';
-        env.COLORTERM = 'truecolor';
-        return env;
-    }
-    static clampDimension(value, fallback) {
-        const numeric = Number(value);
-        if (!Number.isInteger(numeric))
-            return fallback;
-        return Math.min(PtySession.MAX_DIMENSION, Math.max(PtySession.MIN_DIMENSION, numeric));
-    }
-    start({ cols, rows, onData, onExit }) {
-        if (this.terminal)
-            throw new Error('PTY session already started');
-        // The Herdr UI needs the bundled ConPTY's Kitty and mouse reporting.
-        this.terminal = this.spawnPty(this.command, this.args, {
-            name: 'xterm-256color',
-            cols: PtySession.clampDimension(cols, PtySession.DEFAULT_COLS),
-            rows: PtySession.clampDimension(rows, PtySession.DEFAULT_ROWS),
-            cwd: this.cwd,
-            env: PtySession.childEnv(this.socketPath),
-            ...(this.platform === 'win32'
-                ? this.fastWindowsPty
-                    ? { useConpty: false }
-                    : { useConptyDll: true }
-                : {}),
-        });
-        this.startedAt = new Date().toISOString();
-        const terminal = this.terminal;
-        if (onData)
-            terminal.onData(onData);
-        if (onExit) {
-            terminal.onExit((event) => {
-                this.terminal = null;
-                onExit(event);
-            });
-        }
-        return this;
-    }
-    write(data) {
-        if (!this.terminal)
-            return;
-        this.terminal.write(Buffer.isBuffer(data) ? data.toString('utf8') : String(data));
-    }
-    resize(cols, rows) {
-        if (!this.terminal)
-            return;
-        this.terminal.resize(PtySession.clampDimension(cols, PtySession.DEFAULT_COLS), PtySession.clampDimension(rows, PtySession.DEFAULT_ROWS));
-    }
-    info() {
-        return {
-            pid: this.terminal?.pid || null,
-            command: this.command,
-            cols: this.terminal?.cols || null,
-            rows: this.terminal?.rows || null,
-            cwd: this.cwd,
-            createdAt: this.startedAt,
-        };
-    }
-    kill() {
-        try {
-            this.terminal?.kill();
-        }
-        catch {
-            // The process has already exited.
-        }
-        this.terminal = null;
-    }
-}
-export { PtySession };

package/dist/relay-client.js

@@ -1,106 +0,0 @@
-// Talking to a relay's HTTP API from this workstation: health, status, pairing.
-import http from 'node:http';
-import https from 'node:https';
-import { resolveAdminOrigin } from './relay-urls.js';
-import { ensureRuntime } from './runtime.js';
-/**
- * Minimal JSON client. Picks http or https from the URL: a self-hosted relay is
- * reached over https, while the local relay is plain http on loopback.
- */
-export function requestJson(urlString, options = {}) {
-    return new Promise((resolve, reject) => {
-        let url;
-        try {
-            url = new URL(urlString);
-        }
-        catch (error) {
-            reject(error);
-            return;
-        }
-        const transport = url.protocol === 'https:' ? https : http;
-        const request = transport.request(url, {
-            method: options.method || 'GET',
-            headers: options.headers || {},
-            timeout: options.timeout || 1500,
-        }, (response) => {
-            const chunks = [];
-            response.on('data', (chunk) => chunks.push(chunk));
-            response.on('end', () => {
-                const text = Buffer.concat(chunks).toString('utf8');
-                let body;
-                try {
-                    body = JSON.parse(text);
-                }
-                catch {
-                    body = { raw: text };
-                }
-                const status = response.statusCode || 0;
-                if (status >= 400) {
-                    const error = new Error(typeof body.message === 'string' ? body.message : `HTTP ${status}`);
-                    error.statusCode = status;
-                    error.body = body;
-                    reject(error);
-                }
-                else
-                    resolve(body);
-            });
-        });
-        request.on('timeout', () => request.destroy(new Error('request timed out')));
-        request.on('error', reject);
-        if (options.body)
-            request.write(options.body);
-        request.end();
-    });
-}
-export function healthUrl(config) {
-    return `${resolveAdminOrigin(config)}/healthz`;
-}
-/** This workstation's own credentials, which scope a relay's answers to it. */
-export function hostHeaders() {
-    const state = ensureRuntime();
-    return { 'X-Herdr-Host-Id': state.hostId, 'X-Herdr-Host-Token': state.hostToken };
-}
-export async function waitForRelay(config, { attempts = 20, delayMs = 100 } = {}) {
-    let lastError;
-    for (let attempt = 0; attempt < attempts; attempt += 1) {
-        try {
-            return await requestJson(healthUrl(config), { timeout: 800 });
-        }
-        catch (error) {
-            lastError = error;
-        }
-        await new Promise((resolve) => setTimeout(resolve, delayMs));
-    }
-    throw lastError || new Error('relay did not become ready');
-}
-export async function waitForHost(config, { attempts = 30, delayMs = 100 } = {}) {
-    const headers = hostHeaders();
-    const hostId = headers['X-Herdr-Host-Id'];
-    const statusEndpoint = `${resolveAdminOrigin(config)}/api/status`;
-    let lastStatus = null;
-    for (let attempt = 0; attempt < attempts; attempt += 1) {
-        try {
-            lastStatus = await requestJson(statusEndpoint, {
-                timeout: 800,
-                headers,
-            });
-            if (lastStatus.hosts?.some((host) => host.id === hostId))
-                return lastStatus;
-        }
-        catch (error) {
-            lastStatus = { ok: false, message: error.message };
-        }
-        await new Promise((resolve) => setTimeout(resolve, delayMs));
-    }
-    const error = new Error(lastStatus?.message || 'the Herdr host connector did not register with the relay');
-    error.health = lastStatus;
-    throw error;
-}
-export function extractPairingCode(response) {
-    const answer = response;
-    const code = answer?.code || answer?.pairCode;
-    if (typeof code !== 'string' || code.length === 0) {
-        throw new Error('the relay response did not contain a valid pairing code');
-    }
-    return code;
-}

package/dist/relay-urls.js

@@ -1,99 +0,0 @@
-// The addresses a configuration implies: where the local relay binds, the URL
-// a browser opens, and the relay URLs the host connector and the CLI dial.
-import { WS_HOST_PATH } from 'herdr-remote-relay/protocol';
-function isLoopbackHost(value) {
-    return value === '127.0.0.1' || value === 'localhost' || value === '::1' || value === '[::1]';
-}
-function isUnspecifiedAddress(value) {
-    const address = typeof value === 'string' ? value.trim().toLowerCase() : '';
-    return address === '0.0.0.0' || address === '::' || address === '[::]';
-}
-/** An unspecified host is valid for a server bind, but not for a browser URL. */
-function isUnspecifiedHost(value) {
-    try {
-        const hostname = new URL(value).hostname.toLowerCase();
-        return hostname === '0.0.0.0' || hostname === '::' || hostname === '[::]';
-    }
-    catch {
-        return false;
-    }
-}
-function normalizeUrl(value) {
-    return typeof value === 'string' ? value.trim().replace(/\/+$/, '') : '';
-}
-/** Whether this machine runs its own relay process. */
-function runsLocalRelay(config) {
-    return config.relay.mode !== 'remote';
-}
-/** Address the local relay binds to for the configured mode. */
-function bindAddress(config) {
-    return config.relay.mode === 'lan' ? '0.0.0.0' : '127.0.0.1';
-}
-/**
- * Host name to put into pairing URLs. For "lan" this is the interface address a
- * phone can actually reach; `lanHost` is the user's pick from the TUI, and the
- * fallback keeps things working if that interface disappeared.
- */
-function advertisedHost(config, fallbackLanHost = null) {
-    if (config.relay.mode === 'lan') {
-        const configured = config.relay.lanHost;
-        if (configured && !isLoopbackHost(configured) && !isUnspecifiedAddress(configured))
-            return configured;
-        if (fallbackLanHost &&
-            !isLoopbackHost(fallbackLanHost) &&
-            !isUnspecifiedAddress(fallbackLanHost)) {
-            return fallbackLanHost;
-        }
-        return '127.0.0.1';
-    }
-    return '127.0.0.1';
-}
-/** The URL a browser opens. */
-function resolvePublicUrl(config, fallbackLanHost = null) {
-    if (config.relay.publicUrl)
-        return config.relay.publicUrl;
-    if (config.relay.mode === 'remote')
-        return httpOrigin(config.relay.remoteUrl);
-    return `http://${advertisedHost(config, fallbackLanHost)}:${config.relay.port}`;
-}
-/** Base HTTP origin used for relay admin calls (pairing, health). */
-function resolveAdminOrigin(config) {
-    if (config.relay.mode === 'remote')
-        return httpOrigin(config.relay.remoteUrl);
-    return `http://127.0.0.1:${config.relay.port}`;
-}
-/** WebSocket URL the host connector dials. */
-function resolveHostRelayUrl(config) {
-    const base = config.relay.mode === 'remote' ? config.relay.remoteUrl : `ws://127.0.0.1:${config.relay.port}`;
-    return hostWebSocketUrl(base);
-}
-function httpOrigin(value) {
-    try {
-        const url = new URL(value);
-        if (url.protocol === 'ws:')
-            url.protocol = 'http:';
-        if (url.protocol === 'wss:')
-            url.protocol = 'https:';
-        const pathname = url.pathname.replace(/\/+$/, '');
-        return `${url.origin}${pathname}`;
-    }
-    catch {
-        return normalizeUrl(value);
-    }
-}
-function hostWebSocketUrl(base) {
-    const url = new URL(base);
-    if (url.protocol === 'http:')
-        url.protocol = 'ws:';
-    if (url.protocol === 'https:')
-        url.protocol = 'wss:';
-    const pathname = url.pathname.replace(/\/+$/, '');
-    if (!pathname || pathname === '/') {
-        url.pathname = WS_HOST_PATH;
-    }
-    else if (!pathname.endsWith(WS_HOST_PATH)) {
-        url.pathname = `${pathname}${WS_HOST_PATH}`;
-    }
-    return url.toString();
-}
-export { isLoopbackHost, isUnspecifiedAddress, isUnspecifiedHost, normalizeUrl, runsLocalRelay, bindAddress, advertisedHost, resolvePublicUrl, resolveAdminOrigin, resolveHostRelayUrl, hostWebSocketUrl, };

package/dist/runtime.js

@@ -1,107 +0,0 @@
-// runtime.json: this workstation's relay credentials, the processes started
-// for it, and facts other modules remember there (terminal palette and font).
-// Every read and write of that file goes through here.
-import { ensureDir, randomToken, readJson, writeJsonAtomic } from 'herdr-remote-relay/state';
-import { processStart, stillRunning } from './lib/process.js';
-import { configDir, runtimeStatePath, stateDir } from './paths.js';
-const RUNTIME_VERSION = 2;
-export function readRuntime() {
-    const state = readJson(runtimeStatePath(), {});
-    return state && typeof state === 'object' ? state : {};
-}
-export function writeRuntime(state) {
-    writeJsonAtomic(runtimeStatePath(), state);
-}
-/** Read, change and write back in one step, so no field another writer set is lost. */
-export function updateRuntime(change) {
-    const state = readRuntime();
-    change(state);
-    writeRuntime(state);
-    return state;
-}
-/**
- * Load (creating if needed) the long-lived identifiers and secrets this
- * workstation uses. These live in the state directory rather than config.json
- * because they are credentials: writeJsonAtomic stores them mode 0600.
- */
-export function ensureRuntime() {
-    ensureDir(configDir());
-    ensureDir(stateDir());
-    return updateRuntime((state) => {
-        if (!state.version)
-            state.version = RUNTIME_VERSION;
-        if (!state.hostId)
-            state.hostId = `host-${randomToken(9)}`;
-        if (!state.hostToken)
-            state.hostToken = randomToken(32);
-    });
-}
-/**
- * Set the password used to join a relay. An empty value means "no password",
- * which is what a public relay expects.
- *
- * It lives in the state file rather than config.json because it is a secret:
- * writeJsonAtomic stores that file mode 0600.
- */
-export function setRelayPassword(password) {
-    const state = ensureRuntime();
-    state.relayPassword = typeof password === 'string' ? password.trim() : '';
-    writeRuntime(state);
-    return state;
-}
-/**
- * Issue this workstation a new identity on the relay.
- *
- * The host token is what proves ownership of this workstation, so replacing it
- * means the relay no longer recognises the old one — useful if it leaked, but
- * it also orphans the previous record on a relay that already enrolled it.
- */
-export function regenerateHostIdentity() {
-    const state = ensureRuntime();
-    state.hostId = `host-${randomToken(9)}`;
-    state.hostToken = randomToken(32);
-    writeRuntime(state);
-    return state;
-}
-/**
- * Remember a process we started, in a list that survives being overwritten.
- *
- * `relayPid`/`hostPid` alone were not enough: the supervisor rewrote them with
- * its own children, which orphaned anything an earlier detached start had
- * spawned. Those orphans kept the port and the host session, so the relay could
- * never bind and "stop" had nothing left to kill. The ledger is append-only
- * (minus dead entries) precisely so no writer can lose another writer's pids.
- */
-export function recordManagedPid(state, name, pid) {
-    const existing = Array.isArray(state.managedPids) ? state.managedPids.filter(Boolean) : [];
-    const kept = stillRunning(existing.filter((entry) => entry.pid !== pid));
-    // Only track something that is actually running, and together with its start
-    // token: the ledger outlives a reboot, and a bare pid it kept would then name
-    // whichever unrelated process got that number next — which we would signal.
-    const start = Number.isInteger(pid) ? processStart(pid) : null;
-    if (start) {
-        kept.push({
-            name,
-            pid: pid,
-            processStart: start,
-            startedAt: new Date().toISOString(),
-        });
-    }
-    state.managedPids = kept;
-    return state;
-}
-/**
- * Every process we started that is still running, and still that process.
- *
- * Only the ledger counts. `supervisorPid`, `relayPid` and `hostPid` are bare
- * numbers that survive a reboot, and trusting them would signal whichever
- * unrelated process inherited one.
- */
-export function managedPids(state = readRuntime()) {
-    const unique = new Map();
-    for (const entry of state.managedPids || []) {
-        if (entry && !unique.has(entry.pid))
-            unique.set(entry.pid, entry);
-    }
-    return stillRunning([...unique.values()]);
-}