@serfab/cadre-host 0.9.0 → 0.11.0

package/src/installer/paths.ts

@@ -1,109 +1,109 @@
-/**
- * Per-platform default paths for the installer.
- *
- * Linux:   XDG_DATA_HOME / ~/.local/share/cadre-host
- * macOS:   ~/Library/Application Support/CadreHost
- * Windows: %LocalAppData%\CadreHost
- *
- * The package root (where the installed `dist/bin/host.js` and `service/`
- * directory live) is resolved at runtime relative to this module. The
- * installer needs both: the data dir is per-user state, while the package
- * root is what the service-host unit's `ExecStart` line points at.
- */
-
-import { homedir } from 'node:os';
-import { posix, win32, join, resolve, dirname } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import type { SupportedPlatform } from './platform.js';
-
-/** Use the path joiner the *target* platform would use, not the runtime's. */
-function joinFor(platform: SupportedPlatform, ...parts: string[]): string {
-  return platform === 'win32' ? win32.join(...parts) : posix.join(...parts);
-}
-
-export interface InstallerEnv {
-  HOME?: string;
-  XDG_DATA_HOME?: string;
-  XDG_CONFIG_HOME?: string;
-  LocalAppData?: string;
-}
-
-/** Default data dir for the given platform. Honors XDG_DATA_HOME / LocalAppData. */
-export function defaultDataDir(
-  platform: SupportedPlatform,
-  env: InstallerEnv = process.env as InstallerEnv,
-  home: string = homedir(),
-): string {
-  switch (platform) {
-    case 'linux': {
-      const base = env.XDG_DATA_HOME?.trim() || joinFor(platform, env.HOME?.trim() || home, '.local', 'share');
-      return joinFor(platform, base, 'cadre-host');
-    }
-    case 'darwin': {
-      return joinFor(platform, env.HOME?.trim() || home, 'Library', 'Application Support', 'CadreHost');
-    }
-    case 'win32': {
-      // %LocalAppData% is the canonical per-user, non-roaming app data dir.
-      const base = env.LocalAppData?.trim();
-      if (!base) {
-        // Fallback: derive from HOME (works under cygwin/MSYS test envs too).
-        return joinFor(platform, home, 'AppData', 'Local', 'CadreHost');
-      }
-      return joinFor(platform, base, 'CadreHost');
-    }
-  }
-}
-
-/** Path on disk for the installed cadre-host CLI entrypoint. */
-export function defaultHostJs(): string {
-  // dist/installer/paths.js -> ../../dist/bin/host.js
-  // src/installer/paths.ts  -> ../bin/host.ts (only used by tests; build emits dist)
-  const here = dirname(fileURLToPath(import.meta.url));
-  return resolve(here, '..', 'bin', 'host.js');
-}
-
-/** Directory containing service templates (cadre-host.service.tmpl etc.). */
-export function defaultServiceDir(): string {
-  // dist/installer/paths.js -> ../../service/
-  const here = dirname(fileURLToPath(import.meta.url));
-  return resolve(here, '..', '..', 'service');
-}
-
-/** Where the wizard writes the JSON config. */
-export function configPath(dataDir: string): string {
-  return join(dataDir, 'host.config.json');
-}
-
-/** Where the wizard writes the Ed25519 identity. */
-export function identityPath(dataDir: string): string {
-  return join(dataDir, 'identity.key');
-}
-
-/** Logs directory (used by launchd / NSSM unit templates). */
-export function logsDir(dataDir: string): string {
-  return join(dataDir, 'logs');
-}
-
-/** Per-platform install dir for the rendered service unit file. */
-export function serviceInstallPath(
-  platform: SupportedPlatform,
-  env: InstallerEnv = process.env as InstallerEnv,
-  home: string = homedir(),
-): string {
-  const hd = env.HOME?.trim() || home;
-  switch (platform) {
-    case 'linux': {
-      const base = env.XDG_CONFIG_HOME?.trim() || joinFor(platform, hd, '.config');
-      return joinFor(platform, base, 'systemd', 'user', 'cadre-host.service');
-    }
-    case 'darwin': {
-      return joinFor(platform, hd, 'Library', 'LaunchAgents', 'com.serfab.cadre-host.plist');
-    }
-    case 'win32': {
-      // NSSM stores service config in the registry; this path is unused
-      // on Windows but returned for symmetry / logging.
-      return 'HKLM\\SYSTEM\\CurrentControlSet\\Services\\CadreHost';
-    }
-  }
-}
+/**
+ * Per-platform default paths for the installer.
+ *
+ * Linux:   XDG_DATA_HOME / ~/.local/share/cadre-host
+ * macOS:   ~/Library/Application Support/CadreHost
+ * Windows: %LocalAppData%\CadreHost
+ *
+ * The package root (where the installed `dist/bin/host.js` and `service/`
+ * directory live) is resolved at runtime relative to this module. The
+ * installer needs both: the data dir is per-user state, while the package
+ * root is what the service-host unit's `ExecStart` line points at.
+ */
+
+import { homedir } from 'node:os';
+import { posix, win32, join, resolve, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import type { SupportedPlatform } from './platform.js';
+
+/** Use the path joiner the *target* platform would use, not the runtime's. */
+function joinFor(platform: SupportedPlatform, ...parts: string[]): string {
+  return platform === 'win32' ? win32.join(...parts) : posix.join(...parts);
+}
+
+export interface InstallerEnv {
+  HOME?: string;
+  XDG_DATA_HOME?: string;
+  XDG_CONFIG_HOME?: string;
+  LocalAppData?: string;
+}
+
+/** Default data dir for the given platform. Honors XDG_DATA_HOME / LocalAppData. */
+export function defaultDataDir(
+  platform: SupportedPlatform,
+  env: InstallerEnv = process.env as InstallerEnv,
+  home: string = homedir(),
+): string {
+  switch (platform) {
+    case 'linux': {
+      const base = env.XDG_DATA_HOME?.trim() || joinFor(platform, env.HOME?.trim() || home, '.local', 'share');
+      return joinFor(platform, base, 'cadre-host');
+    }
+    case 'darwin': {
+      return joinFor(platform, env.HOME?.trim() || home, 'Library', 'Application Support', 'CadreHost');
+    }
+    case 'win32': {
+      // %LocalAppData% is the canonical per-user, non-roaming app data dir.
+      const base = env.LocalAppData?.trim();
+      if (!base) {
+        // Fallback: derive from HOME (works under cygwin/MSYS test envs too).
+        return joinFor(platform, home, 'AppData', 'Local', 'CadreHost');
+      }
+      return joinFor(platform, base, 'CadreHost');
+    }
+  }
+}
+
+/** Path on disk for the installed cadre-host CLI entrypoint. */
+export function defaultHostJs(): string {
+  // dist/installer/paths.js -> ../../dist/bin/host.js
+  // src/installer/paths.ts  -> ../bin/host.ts (only used by tests; build emits dist)
+  const here = dirname(fileURLToPath(import.meta.url));
+  return resolve(here, '..', 'bin', 'host.js');
+}
+
+/** Directory containing service templates (cadre-host.service.tmpl etc.). */
+export function defaultServiceDir(): string {
+  // dist/installer/paths.js -> ../../service/
+  const here = dirname(fileURLToPath(import.meta.url));
+  return resolve(here, '..', '..', 'service');
+}
+
+/** Where the wizard writes the JSON config. */
+export function configPath(dataDir: string): string {
+  return join(dataDir, 'host.config.json');
+}
+
+/** Where the wizard writes the Ed25519 identity. */
+export function identityPath(dataDir: string): string {
+  return join(dataDir, 'identity.key');
+}
+
+/** Logs directory (used by launchd / NSSM unit templates). */
+export function logsDir(dataDir: string): string {
+  return join(dataDir, 'logs');
+}
+
+/** Per-platform install dir for the rendered service unit file. */
+export function serviceInstallPath(
+  platform: SupportedPlatform,
+  env: InstallerEnv = process.env as InstallerEnv,
+  home: string = homedir(),
+): string {
+  const hd = env.HOME?.trim() || home;
+  switch (platform) {
+    case 'linux': {
+      const base = env.XDG_CONFIG_HOME?.trim() || joinFor(platform, hd, '.config');
+      return joinFor(platform, base, 'systemd', 'user', 'cadre-host.service');
+    }
+    case 'darwin': {
+      return joinFor(platform, hd, 'Library', 'LaunchAgents', 'com.serfab.cadre-host.plist');
+    }
+    case 'win32': {
+      // NSSM stores service config in the registry; this path is unused
+      // on Windows but returned for symmetry / logging.
+      return 'HKLM\\SYSTEM\\CurrentControlSet\\Services\\CadreHost';
+    }
+  }
+}

package/src/installer/platform.ts

@@ -1,27 +1,27 @@
-/**
- * Platform detection helpers for the installer.
- *
- * Kept narrow on purpose — `process.platform` everywhere else in the
- * installer is funneled through here so tests can stub a single point.
- */
-
-export type SupportedPlatform = 'linux' | 'darwin' | 'win32';
-
-const SUPPORTED: ReadonlySet<NodeJS.Platform> = new Set<NodeJS.Platform>([
-  'linux',
-  'darwin',
-  'win32',
-]);
-
-export function detectPlatform(p: NodeJS.Platform = process.platform): SupportedPlatform {
-  if (!SUPPORTED.has(p)) {
-    throw new Error(
-      `Unsupported platform: ${p}. cadre-host install supports linux, darwin, win32.`,
-    );
-  }
-  return p as SupportedPlatform;
-}
-
-export function isPosix(p: SupportedPlatform): boolean {
-  return p === 'linux' || p === 'darwin';
-}
+/**
+ * Platform detection helpers for the installer.
+ *
+ * Kept narrow on purpose — `process.platform` everywhere else in the
+ * installer is funneled through here so tests can stub a single point.
+ */
+
+export type SupportedPlatform = 'linux' | 'darwin' | 'win32';
+
+const SUPPORTED: ReadonlySet<NodeJS.Platform> = new Set<NodeJS.Platform>([
+  'linux',
+  'darwin',
+  'win32',
+]);
+
+export function detectPlatform(p: NodeJS.Platform = process.platform): SupportedPlatform {
+  if (!SUPPORTED.has(p)) {
+    throw new Error(
+      `Unsupported platform: ${p}. cadre-host install supports linux, darwin, win32.`,
+    );
+  }
+  return p as SupportedPlatform;
+}
+
+export function isPosix(p: SupportedPlatform): boolean {
+  return p === 'linux' || p === 'darwin';
+}

package/src/installer/service-host/index.ts

@@ -1,21 +1,21 @@
-/**
- * Pick the right service-host impl for the current platform.
- */
-
-import { detectPlatform, type SupportedPlatform } from '../platform.js';
-import { SystemdServiceHost } from './systemd.js';
-import { LaunchdServiceHost } from './launchd.js';
-import { NssmServiceHost } from './nssm.js';
-import type { ServiceHost } from './types.js';
-
-export type { ServiceHost, ServiceHostContext, ServiceHostStatus } from './types.js';
-
-export function createServiceHost(platform: SupportedPlatform = detectPlatform()): ServiceHost {
-  switch (platform) {
-    case 'linux':  return new SystemdServiceHost();
-    case 'darwin': return new LaunchdServiceHost();
-    case 'win32':  return new NssmServiceHost();
-  }
-}
-
-export { SystemdServiceHost, LaunchdServiceHost, NssmServiceHost };
+/**
+ * Pick the right service-host impl for the current platform.
+ */
+
+import { detectPlatform, type SupportedPlatform } from '../platform.js';
+import { SystemdServiceHost } from './systemd.js';
+import { LaunchdServiceHost } from './launchd.js';
+import { NssmServiceHost } from './nssm.js';
+import type { ServiceHost } from './types.js';
+
+export type { ServiceHost, ServiceHostContext, ServiceHostStatus } from './types.js';
+
+export function createServiceHost(platform: SupportedPlatform = detectPlatform()): ServiceHost {
+  switch (platform) {
+    case 'linux':  return new SystemdServiceHost();
+    case 'darwin': return new LaunchdServiceHost();
+    case 'win32':  return new NssmServiceHost();
+  }
+}
+
+export { SystemdServiceHost, LaunchdServiceHost, NssmServiceHost };

package/src/installer/service-host/template.ts

@@ -1,21 +1,21 @@
-/**
- * Tiny `@TOKEN@` substitution. Used to render systemd / launchd unit
- * files. Throws if any tokens are left after substitution to catch
- * typos at install time rather than at service-startup time.
- */
-
-const TOKEN_RE = /@([A-Z][A-Z0-9_]*)@/g;
-
-export function renderTemplate(template: string, tokens: Readonly<Record<string, string>>): string {
-  const rendered = template.replace(TOKEN_RE, (full, key: string) => {
-    if (!Object.prototype.hasOwnProperty.call(tokens, key)) {
-      throw new Error(`renderTemplate: missing value for token ${full}`);
-    }
-    return tokens[key];
-  });
-  const leftover = rendered.match(TOKEN_RE);
-  if (leftover) {
-    throw new Error(`renderTemplate: unresolved tokens: ${leftover.join(', ')}`);
-  }
-  return rendered;
-}
+/**
+ * Tiny `@TOKEN@` substitution. Used to render systemd / launchd unit
+ * files. Throws if any tokens are left after substitution to catch
+ * typos at install time rather than at service-startup time.
+ */
+
+const TOKEN_RE = /@([A-Z][A-Z0-9_]*)@/g;
+
+export function renderTemplate(template: string, tokens: Readonly<Record<string, string>>): string {
+  const rendered = template.replace(TOKEN_RE, (full, key: string) => {
+    if (!Object.prototype.hasOwnProperty.call(tokens, key)) {
+      throw new Error(`renderTemplate: missing value for token ${full}`);
+    }
+    return tokens[key];
+  });
+  const leftover = rendered.match(TOKEN_RE);
+  if (leftover) {
+    throw new Error(`renderTemplate: unresolved tokens: ${leftover.join(', ')}`);
+  }
+  return rendered;
+}

package/src/installer/wizard.ts

@@ -1,103 +1,103 @@
-/**
- * Interactive install wizard.
- *
- * Pure readline — no extra deps. Each prompt is decomposed into a small
- * `Prompt` so the test can drive the wizard with a scripted Iterable of
- * answers. Production code wires the prompts to stdin.
- */
-
-import { createInterface, type Interface as ReadlineInterface } from 'node:readline';
-
-import { defaultDataDir } from './paths.js';
-import type { SupportedPlatform } from './platform.js';
-
-export interface WizardDefaults {
-  dataDir: string;
-  uiPort: number;
-  libp2pPort: number;
-  upnpEnabled: boolean;
-  /** Also run the host's own personal cadre here (founder persona). Default false. */
-  ownCadre: boolean;
-}
-
-export interface WizardAnswers {
-  dataDir: string;
-  uiPort: number;
-  libp2pPort: number;
-  upnpEnabled: boolean;
-  configureDdns: boolean;
-  /** Also run the host's own personal cadre here (founder persona). */
-  ownCadre: boolean;
-}
-
-export const DEFAULT_UI_PORT = 8765;
-export const DEFAULT_LIBP2P_PORT = 4001;
-
-export function defaultsForPlatform(platform: SupportedPlatform): WizardDefaults {
-  return {
-    dataDir: defaultDataDir(platform),
-    uiPort: DEFAULT_UI_PORT,
-    libp2pPort: DEFAULT_LIBP2P_PORT,
-    upnpEnabled: true,
-    ownCadre: false,
-  };
-}
-
-/**
- * Drive the wizard with a function that returns the next user answer for
- * a prompt. Used both by the readline-backed `runWizard` and by tests.
- */
-export async function runWizardWith(
-  defaults: WizardDefaults,
-  ask: (label: string, fallback: string) => Promise<string>,
-): Promise<WizardAnswers> {
-  const dataDir = (await ask('Data directory', defaults.dataDir)).trim() || defaults.dataDir;
-  const uiPort = parsePort(await ask('UI port (localhost only)', String(defaults.uiPort)), defaults.uiPort);
-  const libp2pPort = parsePort(await ask('Cadre libp2p port', String(defaults.libp2pPort)), defaults.libp2pPort);
-  const upnpEnabled = parseBool(
-    await ask('Attempt UPnP port mapping on this network? [Y/n]', defaults.upnpEnabled ? 'Y' : 'n'),
-    defaults.upnpEnabled,
-  );
-  const configureDdns = parseBool(await ask('Configure DDNS now? [y/N]', 'N'), false);
-  // Founder persona (opt-in). Most installs just donate nodes to friends and
-  // answer no — a no leaves cadre-host donor-only (no owner node, no /auth+/nat).
-  const ownCadre = parseBool(
-    await ask('Also run your own personal cadre on this machine? (most people just donating nodes to friends say no) [y/N]', defaults.ownCadre ? 'Y' : 'N'),
-    defaults.ownCadre,
-  );
-  return { dataDir, uiPort, libp2pPort, upnpEnabled, configureDdns, ownCadre };
-}
-
-/** Production entrypoint — drives the wizard over stdin/stdout. */
-export async function runWizard(defaults: WizardDefaults): Promise<WizardAnswers> {
-  const rl = createInterface({ input: process.stdin, output: process.stdout });
-  try {
-    return await runWizardWith(defaults, async (label, fallback) => prompt(rl, label, fallback));
-  } finally {
-    rl.close();
-  }
-}
-
-function prompt(rl: ReadlineInterface, label: string, fallback: string): Promise<string> {
-  return new Promise<string>((resolve) => {
-    rl.question(`${label} [${fallback}]: `, (answer) => resolve(answer));
-  });
-}
-
-function parsePort(input: string, fallback: number): number {
-  const trimmed = input.trim();
-  if (!trimmed) return fallback;
-  const n = Number(trimmed);
-  if (!Number.isInteger(n) || n <= 0 || n > 65535) {
-    throw new Error(`Invalid port: ${input}`);
-  }
-  return n;
-}
-
-function parseBool(input: string, fallback: boolean): boolean {
-  const trimmed = input.trim().toLowerCase();
-  if (!trimmed) return fallback;
-  if (['y', 'yes', 'true', '1'].includes(trimmed)) return true;
-  if (['n', 'no', 'false', '0'].includes(trimmed)) return false;
-  throw new Error(`Invalid yes/no answer: ${input}`);
-}
+/**
+ * Interactive install wizard.
+ *
+ * Pure readline — no extra deps. Each prompt is decomposed into a small
+ * `Prompt` so the test can drive the wizard with a scripted Iterable of
+ * answers. Production code wires the prompts to stdin.
+ */
+
+import { createInterface, type Interface as ReadlineInterface } from 'node:readline';
+
+import { defaultDataDir } from './paths.js';
+import type { SupportedPlatform } from './platform.js';
+
+export interface WizardDefaults {
+  dataDir: string;
+  uiPort: number;
+  libp2pPort: number;
+  upnpEnabled: boolean;
+  /** Also run the host's own personal cadre here (founder persona). Default false. */
+  ownCadre: boolean;
+}
+
+export interface WizardAnswers {
+  dataDir: string;
+  uiPort: number;
+  libp2pPort: number;
+  upnpEnabled: boolean;
+  configureDdns: boolean;
+  /** Also run the host's own personal cadre here (founder persona). */
+  ownCadre: boolean;
+}
+
+export const DEFAULT_UI_PORT = 8765;
+export const DEFAULT_LIBP2P_PORT = 4001;
+
+export function defaultsForPlatform(platform: SupportedPlatform): WizardDefaults {
+  return {
+    dataDir: defaultDataDir(platform),
+    uiPort: DEFAULT_UI_PORT,
+    libp2pPort: DEFAULT_LIBP2P_PORT,
+    upnpEnabled: true,
+    ownCadre: false,
+  };
+}
+
+/**
+ * Drive the wizard with a function that returns the next user answer for
+ * a prompt. Used both by the readline-backed `runWizard` and by tests.
+ */
+export async function runWizardWith(
+  defaults: WizardDefaults,
+  ask: (label: string, fallback: string) => Promise<string>,
+): Promise<WizardAnswers> {
+  const dataDir = (await ask('Data directory', defaults.dataDir)).trim() || defaults.dataDir;
+  const uiPort = parsePort(await ask('UI port (localhost only)', String(defaults.uiPort)), defaults.uiPort);
+  const libp2pPort = parsePort(await ask('Cadre libp2p port', String(defaults.libp2pPort)), defaults.libp2pPort);
+  const upnpEnabled = parseBool(
+    await ask('Attempt UPnP port mapping on this network? [Y/n]', defaults.upnpEnabled ? 'Y' : 'n'),
+    defaults.upnpEnabled,
+  );
+  const configureDdns = parseBool(await ask('Configure DDNS now? [y/N]', 'N'), false);
+  // Founder persona (opt-in). Most installs just donate nodes to friends and
+  // answer no — a no leaves cadre-host donor-only (no owner node, no /auth+/nat).
+  const ownCadre = parseBool(
+    await ask('Also run your own personal cadre on this machine? (most people just donating nodes to friends say no) [y/N]', defaults.ownCadre ? 'Y' : 'N'),
+    defaults.ownCadre,
+  );
+  return { dataDir, uiPort, libp2pPort, upnpEnabled, configureDdns, ownCadre };
+}
+
+/** Production entrypoint — drives the wizard over stdin/stdout. */
+export async function runWizard(defaults: WizardDefaults): Promise<WizardAnswers> {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  try {
+    return await runWizardWith(defaults, async (label, fallback) => prompt(rl, label, fallback));
+  } finally {
+    rl.close();
+  }
+}
+
+function prompt(rl: ReadlineInterface, label: string, fallback: string): Promise<string> {
+  return new Promise<string>((resolve) => {
+    rl.question(`${label} [${fallback}]: `, (answer) => resolve(answer));
+  });
+}
+
+function parsePort(input: string, fallback: number): number {
+  const trimmed = input.trim();
+  if (!trimmed) return fallback;
+  const n = Number(trimmed);
+  if (!Number.isInteger(n) || n <= 0 || n > 65535) {
+    throw new Error(`Invalid port: ${input}`);
+  }
+  return n;
+}
+
+function parseBool(input: string, fallback: boolean): boolean {
+  const trimmed = input.trim().toLowerCase();
+  if (!trimmed) return fallback;
+  if (['y', 'yes', 'true', '1'].includes(trimmed)) return true;
+  if (['n', 'no', 'false', '0'].includes(trimmed)) return false;
+  throw new Error(`Invalid yes/no answer: ${input}`);
+}