handmux 0.14.0 → 0.16.0

package/src/cli/setupWizard.js

@@ -14,148 +14,23 @@ import { defaultGen as genToken } from './options.js';
 import { resolveCloudflared } from './cloudflared.js';
 import { resolveTunlite, checkSshAuth } from './tunlite.js';
 import { resolveNatapp, resolveCpolar } from './tunnelClients.js';
-import { t, setLocale, getLocale } from './i18n/index.js';
+import { t, setLocale } from './i18n/index.js';
 import { intro, outro, note, cancel, select, text, password, confirm, ask, CANCELLED } from './prompt.js';
 
-// ~/.cloudflared/config.yml for a named tunnel: route the hostname to the local handmux port.
-export function cfConfigYaml({ tunnelName, credentialsFile, hostname, port }) {
-  return [
-    `tunnel: ${tunnelName}`,
-    `credentials-file: ${credentialsFile}`,
-    'ingress:',
-    `  - hostname: ${hostname}`,
-    `    service: http://localhost:${port}`,
-    '  - service: http_status:404',
-    '',
-  ].join('\n');
-}
-
-// Extract the tunnel UUID + credentials path from `cloudflared tunnel create <name>` stdout.
-export function parseTunnelCreate(out) {
-  const s = String(out || '');
-  const id = (s.match(/Created tunnel \S+ with id ([0-9a-fA-F-]+)/) || [])[1] || null;
-  const credentialsFile = (s.match(/credentials written to (\S+\.json)/i) || [])[1]?.replace(/\.$/, '') || null;
-  return { id, credentialsFile };
-}
-
-// Find an existing named tunnel's UUID in `cloudflared tunnel list --output json`. A named tunnel is a
-// PERSISTENT object in the Cloudflare account, so a second `setup` would hit `cloudflared tunnel create`'s
-// "tunnel with name X already exists" error — which used to force a rename and pile up junk tunnels in the
-// account. Looking it up first lets provisioning REUSE it idempotently. Tolerates non-JSON / errors → null.
-export function findTunnelId(listJsonOut, name) {
-  let arr;
-  try { arr = JSON.parse(String(listJsonOut || '')); } catch { return null; }
-  if (!Array.isArray(arr)) return null;
-  const hit = arr.find((tn) => tn && tn.name === name);
-  return hit?.id || null;
-}
-
-// The config keys the wizard owns: everything it can set. mergeConfig wipes these from the existing config
-// before re-applying the answers, so switching a tunnel (or clearing an optional field) cleanly drops the
-// old value instead of leaving a stale field behind. Anything NOT here (staticDir, previewDomain…) is
-// preserved untouched. `token` IS owned so the Token row can pin one AND clear it back to auto — but it
-// round-trips through answersFromConfig, so a re-run that never touches the row still writes it back.
-const WIZARD_KEYS = [
-  'lang', 'name', 'port', 'tunnel', 'token',
-  'sshHost', 'remotePort', 'sshJump', 'cfHostname', 'cfTunnelName', 'publicUrl',
-  'authtoken', 'cpolarRegion',
-  'vapid', 'xfyun',
-];
-
-// The tunnel-specific keys, cleared whenever the tunnel changes so a switch never carries a stale field.
-const TUNNEL_KEYS = ['sshHost', 'remotePort', 'sshJump', 'cfHostname', 'cfTunnelName', 'publicUrl', 'authtoken', 'cpolarRegion'];
-
-// Wizard answers → the config fragment the user actually set (omit empty optional fields).
-export function configFromAnswers(a) {
-  const cfg = { tunnel: a.tunnel, port: a.port };
-  if (a.lang) cfg.lang = a.lang;
-  if (a.name) cfg.name = a.name;
-  if (a.token) cfg.token = a.token;   // blank = don't pin one → the server mints a fresh token each start
-  if (a.tunnel === 'ssh') {
-    cfg.sshHost = a.sshHost;
-    cfg.remotePort = a.remotePort;
-    if (a.publicUrl) cfg.publicUrl = a.publicUrl;
-    if (a.sshJump) cfg.sshJump = a.sshJump;
-  }
-  if (a.tunnel === 'cloudflare-named') {
-    cfg.cfHostname = a.cfHostname;
-    cfg.cfTunnelName = a.cfTunnelName;
-  }
-  if (a.tunnel === 'natapp' || a.tunnel === 'cpolar') {
-    if (a.authtoken) cfg.authtoken = a.authtoken;
-    if (a.publicUrl) cfg.publicUrl = a.publicUrl;      // fixed/reserved domain (blank = temporary random)
-    if (a.cpolarRegion) cfg.cpolarRegion = a.cpolarRegion;
-  }
-  if (a.vapid) cfg.vapid = a.vapid;
-  if (a.xfyun) cfg.xfyun = a.xfyun;
-  return cfg;
-}
-
-// Fold this run's answers into an existing config: preserve every non-wizard field, replace the wizard's
-// own fields wholesale. This is why re-running `setup` to switch tunnels (or edit the name) never drops
-// your token / push keys / static dir, yet also never leaves the previous tunnel's stale keys around.
-export function mergeConfig(existing = {}, answers) {
-  const out = { ...existing };
-  for (const k of WIZARD_KEYS) delete out[k];
-  return { ...out, ...configFromAnswers(answers) };
-}
-
-// Seed the working answers from an existing config so the hub shows current values and each edit starts
-// from what's already there. A brand-new config yields safe defaults (none/LAN, port 19999).
-export function answersFromConfig(cfg = {}) {
-  const a = {
-    lang: cfg.lang || getLocale(),
-    name: cfg.name || '',
-    token: cfg.token || '',   // '' = not pinned (auto each start); seeded so an untouched re-run rewrites it
-    tunnel: cfg.tunnel || 'none',
-    port: Number(cfg.port) || 19999,
-  };
-  for (const k of [...TUNNEL_KEYS, 'vapid', 'xfyun']) if (cfg[k] != null) a[k] = cfg[k];
-  return a;
-}
-
-// The dim one-line summary shown next to the Connection row (and reused nowhere else). Pure.
-export function summarizeConnection(a) {
-  const bare = (u) => String(u || '').replace(/^https?:\/\//, '');
-  switch (a.tunnel) {
-    case 'cloudflare': return `cloudflare · ${t('setup.sumTemp')}`;
-    case 'cloudflare-named': return `cloudflare-named · ${a.cfHostname || '?'}`;
-    case 'ssh': return `ssh · ${a.sshHost || '?'}`;
-    case 'natapp':
-    case 'cpolar': return `${a.tunnel} · ${a.publicUrl ? `${t('setup.sumFixed')} ${bare(a.publicUrl)}` : t('setup.sumTemp')}`;
-    default: return `${t('setup.tunnelNone')} · ${t('setup.sumNoRelay')}`;
-  }
-}
-
-// ---- validators (clack: return a string to reject + show inline, undefined to accept). Pure. ----
-export function validatePort(v) {
-  const n = Number(v);
-  if (!Number.isInteger(n) || n < 1 || n > 65535) return t('setup.valPort');
-  return undefined;
-}
-export const validateNonEmpty = (label) => (v) => (String(v || '').trim() ? undefined : t('setup.valRequired', { label }));
-export function validateHost(v) {
-  const s = String(v || '').trim().replace(/^https?:\/\//, '').replace(/\/.*$/, '');
-  return /^[a-z0-9-]+(\.[a-z0-9-]+)+$/i.test(s) ? undefined : t('setup.valHost');
-}
-// VAPID subject: Apple (APNs) rejects a fake/.local domain with BadJwtToken, so require a real-looking
-// mailto:you@host.tld or an https:// URL and reject the known-bad .local. Keeps push from silently
-// failing on iOS. (Can't fully validate "real" client-side — this just catches the obvious footguns.)
-export function validateContact(v) {
-  const s = String(v || '').trim();
-  const wellFormed = /^mailto:[^@\s]+@[a-z0-9-]+(\.[a-z0-9-]+)+$/i.test(s)
-    || /^https:\/\/[a-z0-9-]+(\.[a-z0-9-]+)+/i.test(s);
-  if (!wellFormed || /\.local(?:[:/]|$)/i.test(s)) return t('setup.valContact');
-  return undefined;
-}
-// Access token: it rides in the phone's URL as ?token=…, so require something and reject whitespace (a space
-// would break the link). Length/charset are otherwise up to the user — a pinned token is used verbatim.
-export function validateToken(v) {
-  const s = String(v || '').trim();
-  if (!s) return t('setup.valToken');
-  if (/\s/.test(s)) return t('setup.valTokenSpace');
-  return undefined;
-}
+// The pure answer↔config model + validators + cloudflared text helpers live in setupModel.js. Imported for
+// the interactive shell below; re-exported so their historical import path (this module) stays valid for
+// callers and tests.
+import {
+  cfConfigYaml, parseTunnelCreate, findTunnelId,
+  mergeConfig, answersFromConfig, summarizeConnection,
+  validatePort, validateHost, validateNonEmpty, validateContact, validateToken,
+  TUNNEL_KEYS,
+} from './setupModel.js';
+export {
+  cfConfigYaml, parseTunnelCreate, findTunnelId,
+  configFromAnswers, mergeConfig, answersFromConfig, summarizeConnection,
+  validatePort, validateHost, validateNonEmpty, validateContact, validateToken,
+} from './setupModel.js';
 
 function readExisting(file) {
   try { return JSON.parse(fs.readFileSync(file, 'utf8')); } catch { return {}; }

package/src/cli/state.js

@@ -25,9 +25,15 @@ export function readState(home) {
   try { return JSON.parse(fs.readFileSync(statePath(home), 'utf8')); } catch { return null; }
 }
 
+// Atomic write (tmp + rename): the supervisor persist()s frequently while the CLI concurrently readState()s
+// (waitAndPrint/status), so a plain writeFileSync could be caught mid-write and JSON.parse-fail — silently
+// degrading to "not running". rename is atomic on the same filesystem, so a reader sees old or new, never torn.
 export function writeState(state, home) {
   fs.mkdirSync(pocketHome(home), { recursive: true });
-  fs.writeFileSync(statePath(home), JSON.stringify(state, null, 2));
+  const file = statePath(home);
+  const tmp = `${file}.tmp`;
+  fs.writeFileSync(tmp, JSON.stringify(state, null, 2));
+  fs.renameSync(tmp, file);
 }
 
 export function clearState(home) {

package/src/cli/statusLine.js

@@ -9,6 +9,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { homedir } from 'node:os';
+import { writeJsonAtomic } from './hookScaffold.js';
 
 const STATUS_MARK = 'handmux-statusline.cjs'; // identifies our statusLine command among the user's own
 const SCRIPT = 'handmux-statusline.cjs';
@@ -19,11 +20,6 @@ function settingsPath(home = homedir()) { return path.join(claudeDir(home), 'set
 function readSettings(home) {
   try { return JSON.parse(fs.readFileSync(settingsPath(home), 'utf8')); } catch { return {}; }
 }
-function writeJsonAtomic(file, obj) {
-  const tmp = `${file}.tmp`;
-  fs.writeFileSync(tmp, JSON.stringify(obj, null, 2));
-  fs.renameSync(tmp, file);
-}
 
 function isOurs(sl) {
   return !!(sl && typeof sl.command === 'string' && sl.command.includes(STATUS_MARK));

package/src/cli/updateCheck.js

@@ -16,6 +16,12 @@ import { t } from './i18n/index.js';
 export const PKG_NAME = 'handmux';
 export const CHECK_INTERVAL_MS = 60 * 60 * 1000; // refresh the cached "latest" at most once an hour
 
+// A Homebrew-installed handmux lives under the Cellar (…/Cellar/handmux/<ver>/…, symlinked from the brew
+// prefix's bin), or under a linuxbrew prefix. For such installs `handmux update` must NOT `npm i -g` over
+// itself — that plants a second, conflicting copy that brew can't see or upgrade — and the "how to upgrade"
+// hint must point at `brew upgrade` instead. Detect the source from the (real, symlink-resolved) entry path.
+export function isBrewInstall(selfPath = '') { return /\/(Cellar|homebrew)\//.test(selfPath); }
+
 export function updateCachePath(home) { return path.join(pocketHome(home), 'update-check.json'); }
 
 export function readCache(home) {
@@ -114,7 +120,7 @@ export function notifyUpdate(home, { version, selfPath, now = Date.now(), log =
   if (cache && cache.latest && isNewer(cache.latest, version)) {
     log('');
     log(t('update.available', { current: version, latest: cache.latest }));
-    log(t('update.how'));
+    log(t(isBrewInstall(selfPath) ? 'update.howBrew' : 'update.how'));
     shown = true;
   }
   if (selfPath && shouldRefresh(cache, now)) {

package/src/docPath.js

@@ -1,4 +1,6 @@
-const EXT = {
+// Renderable doc types by extension. Exported so the web mirror (docPath.js DOC_LINK_EXTS) can be
+// parity-checked against it — the client's tappable-path detector must open exactly what we can render.
+export const EXT = {
   '.md': 'markdown', '.markdown': 'markdown', '.html': 'html', '.htm': 'html',
   // Plain-text files: rendered verbatim in a <pre> (no markdown parsing).
   '.txt': 'text', '.log': 'text', '.sh': 'text',
@@ -12,7 +14,7 @@ export function docTypeFor(name) {
 
 // Image extensions the in-app viewer can show inline via <img> (GIF animates natively). SVG is safe
 // here because <img>-loaded SVG never runs its scripts. Returns 'image' or null. Case-insensitive.
-const IMG_EXT = new Set(['png', 'jpg', 'jpeg', 'jfif', 'gif', 'webp', 'svg', 'bmp', 'ico', 'avif', 'apng']);
+export const IMG_EXT = new Set(['png', 'jpg', 'jpeg', 'jfif', 'gif', 'webp', 'svg', 'bmp', 'ico', 'avif', 'apng']);
 export function imageTypeFor(name) {
   const m = /\.([A-Za-z0-9]+)$/.exec(name || '');
   return m && IMG_EXT.has(m[1].toLowerCase()) ? 'image' : null;