@serfab/cadre-host 0.10.0 → 0.11.0

package/src/installer/__tests__/service-host.test.ts

@@ -1,62 +1,62 @@
-import { describe, expect, it } from 'vitest';
-import { resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { LaunchdServiceHost } from '../service-host/launchd.js';
-import { SystemdServiceHost } from '../service-host/systemd.js';
-import { NssmServiceHost } from '../service-host/nssm.js';
-import { renderTemplate } from '../service-host/template.js';
-import type { ServiceHostContext } from '../service-host/types.js';
-
-const here = fileURLToPath(new URL('.', import.meta.url));
-const serviceDir = resolve(here, '..', '..', '..', 'service');
-
-function ctx(): ServiceHostContext {
-  return {
-    nodePath: '/usr/local/bin/node',
-    hostJs: '/opt/cadre-host/dist/bin/host.js',
-    dataDir: '/var/data/cadre-host',
-    serviceDir,
-  };
-}
-
-describe('renderTemplate', () => {
-  it('substitutes @TOKEN@ values', () => {
-    expect(renderTemplate('@A@ x @B@', { A: 'foo', B: 'bar' })).toBe('foo x bar');
-  });
-
-  it('throws on unknown tokens', () => {
-    expect(() => renderTemplate('@A@ @MISSING@', { A: 'foo' })).toThrow(/missing value for token @MISSING@/);
-  });
-});
-
-describe('SystemdServiceHost.renderUnit', () => {
-  it('produces an enable-able [Install] section and substitutes ExecStart', () => {
-    const unit = new SystemdServiceHost().renderUnit(ctx());
-    expect(unit).toContain('[Install]');
-    expect(unit).toContain('WantedBy=default.target');
-    expect(unit).toContain('ExecStart=/usr/local/bin/node /opt/cadre-host/dist/bin/host.js start --no-tui --data-dir /var/data/cadre-host');
-    expect(unit).toContain('RestartPreventExitStatus=0');
-  });
-});
-
-describe('LaunchdServiceHost.renderUnit', () => {
-  it('produces a plist with the substituted ProgramArguments', () => {
-    const unit = new LaunchdServiceHost().renderUnit(ctx());
-    expect(unit).toContain('<key>Label</key>');
-    expect(unit).toContain('<string>com.serfab.cadre-host</string>');
-    expect(unit).toContain('<string>/usr/local/bin/node</string>');
-    expect(unit).toContain('<string>/opt/cadre-host/dist/bin/host.js</string>');
-    expect(unit).toContain('<string>--data-dir</string>');
-    expect(unit).toContain('<string>/var/data/cadre-host</string>');
-    expect(unit).toContain('<key>KeepAlive</key>');
-    expect(unit).toContain('<key>SuccessfulExit</key>');
-    expect(unit).toContain('<key>Crashed</key>');
-  });
-});
-
-describe('NssmServiceHost', () => {
-  it('returns null from renderUnit (NSSM stores config in the registry)', () => {
-    expect(new NssmServiceHost().renderUnit(ctx())).toBeNull();
-  });
-});
+import { describe, expect, it } from 'vitest';
+import { resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { LaunchdServiceHost } from '../service-host/launchd.js';
+import { SystemdServiceHost } from '../service-host/systemd.js';
+import { NssmServiceHost } from '../service-host/nssm.js';
+import { renderTemplate } from '../service-host/template.js';
+import type { ServiceHostContext } from '../service-host/types.js';
+
+const here = fileURLToPath(new URL('.', import.meta.url));
+const serviceDir = resolve(here, '..', '..', '..', 'service');
+
+function ctx(): ServiceHostContext {
+  return {
+    nodePath: '/usr/local/bin/node',
+    hostJs: '/opt/cadre-host/dist/bin/host.js',
+    dataDir: '/var/data/cadre-host',
+    serviceDir,
+  };
+}
+
+describe('renderTemplate', () => {
+  it('substitutes @TOKEN@ values', () => {
+    expect(renderTemplate('@A@ x @B@', { A: 'foo', B: 'bar' })).toBe('foo x bar');
+  });
+
+  it('throws on unknown tokens', () => {
+    expect(() => renderTemplate('@A@ @MISSING@', { A: 'foo' })).toThrow(/missing value for token @MISSING@/);
+  });
+});
+
+describe('SystemdServiceHost.renderUnit', () => {
+  it('produces an enable-able [Install] section and substitutes ExecStart', () => {
+    const unit = new SystemdServiceHost().renderUnit(ctx());
+    expect(unit).toContain('[Install]');
+    expect(unit).toContain('WantedBy=default.target');
+    expect(unit).toContain('ExecStart=/usr/local/bin/node /opt/cadre-host/dist/bin/host.js start --no-tui --data-dir /var/data/cadre-host');
+    expect(unit).toContain('RestartPreventExitStatus=0');
+  });
+});
+
+describe('LaunchdServiceHost.renderUnit', () => {
+  it('produces a plist with the substituted ProgramArguments', () => {
+    const unit = new LaunchdServiceHost().renderUnit(ctx());
+    expect(unit).toContain('<key>Label</key>');
+    expect(unit).toContain('<string>com.serfab.cadre-host</string>');
+    expect(unit).toContain('<string>/usr/local/bin/node</string>');
+    expect(unit).toContain('<string>/opt/cadre-host/dist/bin/host.js</string>');
+    expect(unit).toContain('<string>--data-dir</string>');
+    expect(unit).toContain('<string>/var/data/cadre-host</string>');
+    expect(unit).toContain('<key>KeepAlive</key>');
+    expect(unit).toContain('<key>SuccessfulExit</key>');
+    expect(unit).toContain('<key>Crashed</key>');
+  });
+});
+
+describe('NssmServiceHost', () => {
+  it('returns null from renderUnit (NSSM stores config in the registry)', () => {
+    expect(new NssmServiceHost().renderUnit(ctx())).toBeNull();
+  });
+});

package/src/installer/__tests__/wizard.test.ts

@@ -1,64 +1,64 @@
-import { describe, expect, it } from 'vitest';
-
-import { runWizardWith, type WizardDefaults } from '../wizard.js';
-
-const defaults: WizardDefaults = {
-  dataDir: '/data/cadre-host',
-  uiPort: 8765,
-  libp2pPort: 4001,
-  upnpEnabled: true,
-  ownCadre: false,
-};
-
-function scripted(answers: ReadonlyArray<string>): (label: string, fallback: string) => Promise<string> {
-  let i = 0;
-  return async (_label, _fallback) => {
-    if (i >= answers.length) throw new Error(`wizard asked more questions than scripted (i=${i})`);
-    return answers[i++]!;
-  };
-}
-
-describe('runWizardWith', () => {
-  it('returns the defaults when every answer is blank', async () => {
-    const out = await runWizardWith(defaults, scripted(['', '', '', '', '', '']));
-    expect(out).toEqual({
-      dataDir: '/data/cadre-host',
-      uiPort: 8765,
-      libp2pPort: 4001,
-      upnpEnabled: true,
-      configureDdns: false,
-      ownCadre: false,
-    });
-  });
-
-  it('respects overrides', async () => {
-    const out = await runWizardWith(defaults, scripted([
-      '/srv/host',
-      '9000',
-      '5000',
-      'n',
-      'y',
-      'y',
-    ]));
-    expect(out).toEqual({
-      dataDir: '/srv/host',
-      uiPort: 9000,
-      libp2pPort: 5000,
-      upnpEnabled: false,
-      configureDdns: true,
-      ownCadre: true,
-    });
-  });
-
-  it('rejects invalid port input', async () => {
-    await expect(
-      runWizardWith(defaults, scripted(['', 'banana', '', '', ''])),
-    ).rejects.toThrow(/Invalid port/);
-  });
-
-  it('rejects unrecognized yes/no answers', async () => {
-    await expect(
-      runWizardWith(defaults, scripted(['', '', '', 'maybe', ''])),
-    ).rejects.toThrow(/Invalid yes\/no/);
-  });
-});
+import { describe, expect, it } from 'vitest';
+
+import { runWizardWith, type WizardDefaults } from '../wizard.js';
+
+const defaults: WizardDefaults = {
+  dataDir: '/data/cadre-host',
+  uiPort: 8765,
+  libp2pPort: 4001,
+  upnpEnabled: true,
+  ownCadre: false,
+};
+
+function scripted(answers: ReadonlyArray<string>): (label: string, fallback: string) => Promise<string> {
+  let i = 0;
+  return async (_label, _fallback) => {
+    if (i >= answers.length) throw new Error(`wizard asked more questions than scripted (i=${i})`);
+    return answers[i++]!;
+  };
+}
+
+describe('runWizardWith', () => {
+  it('returns the defaults when every answer is blank', async () => {
+    const out = await runWizardWith(defaults, scripted(['', '', '', '', '', '']));
+    expect(out).toEqual({
+      dataDir: '/data/cadre-host',
+      uiPort: 8765,
+      libp2pPort: 4001,
+      upnpEnabled: true,
+      configureDdns: false,
+      ownCadre: false,
+    });
+  });
+
+  it('respects overrides', async () => {
+    const out = await runWizardWith(defaults, scripted([
+      '/srv/host',
+      '9000',
+      '5000',
+      'n',
+      'y',
+      'y',
+    ]));
+    expect(out).toEqual({
+      dataDir: '/srv/host',
+      uiPort: 9000,
+      libp2pPort: 5000,
+      upnpEnabled: false,
+      configureDdns: true,
+      ownCadre: true,
+    });
+  });
+
+  it('rejects invalid port input', async () => {
+    await expect(
+      runWizardWith(defaults, scripted(['', 'banana', '', '', ''])),
+    ).rejects.toThrow(/Invalid port/);
+  });
+
+  it('rejects unrecognized yes/no answers', async () => {
+    await expect(
+      runWizardWith(defaults, scripted(['', '', '', 'maybe', ''])),
+    ).rejects.toThrow(/Invalid yes\/no/);
+  });
+});

package/src/installer/identity.ts

@@ -1,49 +1,49 @@
-/**
- * Identity persistence for cadre-host.
- *
- * The host's libp2p peer identity is an Ed25519 keypair generated at
- * install time. The protobuf-encoded private key is written to
- * `<dataDir>/identity.key` with mode 0600 on POSIX. `cadre-host start`
- * later loads it with `privateKeyFromProtobuf`.
- *
- * We persist the protobuf form (not raw bytes) because that's the format
- * libp2p's `privateKeyFromProtobuf` consumes directly and it preserves the
- * key type tag — future migrations to a different key algorithm don't
- * require a schema change here.
- */
-
-import { chmodSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
-import { dirname } from 'node:path';
-import {
-  generateKeyPair,
-  privateKeyFromProtobuf,
-  privateKeyToProtobuf,
-} from '@libp2p/crypto/keys';
-import { peerIdFromPrivateKey } from '@libp2p/peer-id';
-import type { PrivateKey } from '@libp2p/interface';
-
-export interface IdentityRecord {
-  privateKey: PrivateKey;
-  /** Stringified libp2p peer ID (`12D3Koo…`). */
-  peerId: string;
-}
-
-/** Generate a fresh Ed25519 identity and persist it. Returns the in-memory record. */
-export async function generateIdentity(filePath: string): Promise<IdentityRecord> {
-  const privateKey = await generateKeyPair('Ed25519');
-  const bytes = privateKeyToProtobuf(privateKey);
-  mkdirSync(dirname(filePath), { recursive: true });
-  writeFileSync(filePath, bytes);
-  // 0600 — owner read/write only. No-op on Windows.
-  if (process.platform !== 'win32') {
-    chmodSync(filePath, 0o600);
-  }
-  return { privateKey, peerId: peerIdFromPrivateKey(privateKey).toString() };
-}
-
-/** Load an existing identity file. Throws if it doesn't decode. */
-export function loadIdentity(filePath: string): IdentityRecord {
-  const bytes = readFileSync(filePath);
-  const privateKey = privateKeyFromProtobuf(new Uint8Array(bytes));
-  return { privateKey, peerId: peerIdFromPrivateKey(privateKey).toString() };
-}
+/**
+ * Identity persistence for cadre-host.
+ *
+ * The host's libp2p peer identity is an Ed25519 keypair generated at
+ * install time. The protobuf-encoded private key is written to
+ * `<dataDir>/identity.key` with mode 0600 on POSIX. `cadre-host start`
+ * later loads it with `privateKeyFromProtobuf`.
+ *
+ * We persist the protobuf form (not raw bytes) because that's the format
+ * libp2p's `privateKeyFromProtobuf` consumes directly and it preserves the
+ * key type tag — future migrations to a different key algorithm don't
+ * require a schema change here.
+ */
+
+import { chmodSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname } from 'node:path';
+import {
+  generateKeyPair,
+  privateKeyFromProtobuf,
+  privateKeyToProtobuf,
+} from '@libp2p/crypto/keys';
+import { peerIdFromPrivateKey } from '@libp2p/peer-id';
+import type { PrivateKey } from '@libp2p/interface';
+
+export interface IdentityRecord {
+  privateKey: PrivateKey;
+  /** Stringified libp2p peer ID (`12D3Koo…`). */
+  peerId: string;
+}
+
+/** Generate a fresh Ed25519 identity and persist it. Returns the in-memory record. */
+export async function generateIdentity(filePath: string): Promise<IdentityRecord> {
+  const privateKey = await generateKeyPair('Ed25519');
+  const bytes = privateKeyToProtobuf(privateKey);
+  mkdirSync(dirname(filePath), { recursive: true });
+  writeFileSync(filePath, bytes);
+  // 0600 — owner read/write only. No-op on Windows.
+  if (process.platform !== 'win32') {
+    chmodSync(filePath, 0o600);
+  }
+  return { privateKey, peerId: peerIdFromPrivateKey(privateKey).toString() };
+}
+
+/** Load an existing identity file. Throws if it doesn't decode. */
+export function loadIdentity(filePath: string): IdentityRecord {
+  const bytes = readFileSync(filePath);
+  const privateKey = privateKeyFromProtobuf(new Uint8Array(bytes));
+  return { privateKey, peerId: peerIdFromPrivateKey(privateKey).toString() };
+}

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';
+}