myshell-tools 2.8.0 → 2.13.0

package/dist/infra/update-check.js

@@ -0,0 +1,181 @@
+/**
+ * src/infra/update-check.ts — Self-update detection for myshell-tools.
+ *
+ * Checks the npm registry for the latest published version, caches the result
+ * so the check costs nothing on subsequent runs within the TTL, and reports
+ * whether an update is available.
+ *
+ * Architecture rules:
+ *   - NEVER throws — all errors are caught and return a safe default.
+ *   - NEVER hits the network in tests — `fetchLatest` is injected so tests stay hermetic.
+ *   - Cache is stored atomically at ~/.myshell-tools/update-check.json.
+ *   - Date.now() is allowed here (infra layer, same as config.ts / atomic.ts).
+ */
+import { mkdir, readFile } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import { atomicWrite } from './atomic.js';
+// ---------------------------------------------------------------------------
+// Constants
+// ---------------------------------------------------------------------------
+const TTL_MS_DEFAULT = 24 * 60 * 60 * 1000; // 24 hours
+const FETCH_TIMEOUT_MS = 1_500;
+// ---------------------------------------------------------------------------
+// Path helpers
+// ---------------------------------------------------------------------------
+function getCacheDir(homeDir) {
+    return join(homeDir, '.myshell-tools');
+}
+function getCachePath(homeDir) {
+    return join(getCacheDir(homeDir), 'update-check.json');
+}
+// ---------------------------------------------------------------------------
+// Cache helpers
+// ---------------------------------------------------------------------------
+/**
+ * Load the update cache from disk.  Returns null on missing/corrupt file.
+ * Never throws.
+ */
+export async function loadUpdateCache(homeDir) {
+    const home = homeDir ?? homedir();
+    try {
+        const raw = await readFile(getCachePath(home), 'utf8');
+        const parsed = JSON.parse(raw);
+        if (parsed !== null &&
+            typeof parsed === 'object' &&
+            'checkedAt' in parsed &&
+            'latest' in parsed &&
+            typeof parsed['checkedAt'] === 'number' &&
+            typeof parsed['latest'] === 'string') {
+            return parsed;
+        }
+        return null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Persist the update cache atomically.  Creates the .myshell-tools directory
+ * if it does not exist.  Never throws.
+ */
+export async function saveUpdateCache(latest, now, homeDir) {
+    const home = homeDir ?? homedir();
+    try {
+        await mkdir(getCacheDir(home), { recursive: true });
+        const cache = { checkedAt: now, latest };
+        await atomicWrite(getCachePath(home), JSON.stringify(cache, null, 2));
+    }
+    catch {
+        // Silently ignore — failing to cache is not a fatal error.
+    }
+}
+// ---------------------------------------------------------------------------
+// Version comparison
+// ---------------------------------------------------------------------------
+/**
+ * Compare two semver-ish version strings.
+ *
+ * Splits on `.`, compares numeric major/minor/patch segments in order.
+ * Any `-prerelease` suffix is stripped before comparison.
+ * Non-numeric segments are treated as 0.
+ * Returns true iff latest > current.
+ * Never throws.
+ */
+export function isNewerVersion(latest, current) {
+    try {
+        const parse = (v) => {
+            // Strip any prerelease suffix (e.g. "1.2.3-beta.1" → "1.2.3")
+            const base = v.split('-')[0] ?? '';
+            return base.split('.').map((part) => {
+                const n = parseInt(part, 10);
+                return Number.isFinite(n) ? n : 0;
+            });
+        };
+        const lParts = parse(latest);
+        const cParts = parse(current);
+        const len = Math.max(lParts.length, cParts.length);
+        for (let i = 0; i < len; i++) {
+            const l = lParts[i] ?? 0;
+            const c = cParts[i] ?? 0;
+            if (l > c)
+                return true;
+            if (l < c)
+                return false;
+        }
+        return false; // equal
+    }
+    catch {
+        return false;
+    }
+}
+// ---------------------------------------------------------------------------
+// npm registry fetch (real network — injected in tests)
+// ---------------------------------------------------------------------------
+/**
+ * Fetch the latest published version of myshell-tools from the npm registry.
+ *
+ * Uses global fetch with a 1500ms AbortSignal timeout.
+ * Returns the version string, or null on any error/timeout.
+ * Never throws.
+ */
+export async function fetchLatestFromNpm() {
+    const ac = new AbortController();
+    const timer = setTimeout(() => { ac.abort(); }, FETCH_TIMEOUT_MS);
+    try {
+        const res = await fetch('https://registry.npmjs.org/myshell-tools/latest', {
+            signal: ac.signal,
+        });
+        if (!res.ok)
+            return null;
+        const data = await res.json();
+        if (data !== null &&
+            typeof data === 'object' &&
+            'version' in data &&
+            typeof data['version'] === 'string') {
+            return data['version'] ?? null;
+        }
+        return null;
+    }
+    catch {
+        return null;
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+/**
+ * Check whether a newer version of myshell-tools is available.
+ *
+ * Uses a cache file so the npm registry is only contacted once per TTL (default 24h).
+ * If the cache is fresh, the registry is NOT contacted at all.
+ * On any error returns { current, latest: null, updateAvailable: false }.
+ * Never throws.
+ */
+export async function checkForUpdate(opts) {
+    const { currentVersion, now, homeDir, ttlMs = TTL_MS_DEFAULT } = opts;
+    const fetchFn = opts.fetchLatest ?? fetchLatestFromNpm;
+    try {
+        // Check if we have a fresh cache
+        const cache = await loadUpdateCache(homeDir);
+        if (cache !== null && now - cache.checkedAt < ttlMs) {
+            // Cache is fresh — use it without hitting the network
+            const updateAvailable = isNewerVersion(cache.latest, currentVersion);
+            return { current: currentVersion, latest: cache.latest, updateAvailable };
+        }
+        // Cache is stale or missing — fetch from the registry
+        const latest = await fetchFn();
+        if (latest !== null) {
+            await saveUpdateCache(latest, now, homeDir);
+        }
+        if (latest === null) {
+            return { current: currentVersion, latest: null, updateAvailable: false };
+        }
+        const updateAvailable = isNewerVersion(latest, currentVersion);
+        return { current: currentVersion, latest, updateAvailable };
+    }
+    catch {
+        return { current: currentVersion, latest: null, updateAvailable: false };
+    }
+}
+//# sourceMappingURL=update-check.js.map

package/dist/infra/update-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-check.js","sourceRoot":"","sources":["../../src/infra/update-check.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAiB1C,8EAA8E;AAC9E,YAAY;AACZ,8EAA8E;AAE9E,MAAM,cAAc,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,WAAW;AACvD,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAE/B,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,SAAS,WAAW,CAAC,OAAe;IAClC,OAAO,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,YAAY,CAAC,OAAe;IACnC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC,CAAC;AACzD,CAAC;AAED,8EAA8E;AAC9E,gBAAgB;AAChB,8EAA8E;AAE9E;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgB;IACpD,MAAM,IAAI,GAAG,OAAO,IAAI,OAAO,EAAE,CAAC;IAClC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAY,CAAC;QAC1C,IACE,MAAM,KAAK,IAAI;YACf,OAAO,MAAM,KAAK,QAAQ;YAC1B,WAAW,IAAI,MAAM;YACrB,QAAQ,IAAI,MAAM;YAClB,OAAQ,MAAkC,CAAC,WAAW,CAAC,KAAK,QAAQ;YACpE,OAAQ,MAAkC,CAAC,QAAQ,CAAC,KAAK,QAAQ,EACjE,CAAC;YACD,OAAO,MAAqB,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,GAAW,EACX,OAAgB;IAEhB,MAAM,IAAI,GAAG,OAAO,IAAI,OAAO,EAAE,CAAC;IAClC,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,KAAK,GAAgB,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QACtD,MAAM,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;IAAC,MAAM,CAAC;QACP,2DAA2D;IAC7D,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,qBAAqB;AACrB,8EAA8E;AAE9E;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,OAAe;IAC5D,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,CAAC,CAAS,EAAY,EAAE;YACpC,8DAA8D;YAC9D,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBAClC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC7B,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAE9B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;QAC1B,CAAC;QACD,OAAO,KAAK,CAAC,CAAC,QAAQ;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,wDAAwD;AACxD,8EAA8E;AAE9E;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACtC,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;IAClE,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,iDAAiD,EAAE;YACzE,MAAM,EAAE,EAAE,CAAC,MAAM;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAa,CAAC;QACzC,IACE,IAAI,KAAK,IAAI;YACb,OAAO,IAAI,KAAK,QAAQ;YACxB,SAAS,IAAI,IAAI;YACjB,OAAQ,IAAgC,CAAC,SAAS,CAAC,KAAK,QAAQ,EAChE,CAAC;YACD,OAAQ,IAA+B,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QAC7D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;AACH,CAAC;AAcD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAwB;IAC3D,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,GAAG,cAAc,EAAE,GAAG,IAAI,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;IAEvD,IAAI,CAAC;QACH,iCAAiC;QACjC,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,IAAI,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,GAAG,KAAK,EAAE,CAAC;YACpD,sDAAsD;YACtD,MAAM,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YACrE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC;QAC5E,CAAC;QAED,sDAAsD;QACtD,MAAM,MAAM,GAAG,MAAM,OAAO,EAAE,CAAC;QAC/B,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,MAAM,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;QAC3E,CAAC;QAED,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;IAC9D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;IAC3E,CAAC;AACH,CAAC"}

package/dist/interface/menu.d.ts

@@ -23,6 +23,7 @@ import type { EnvironmentStatus } from '../providers/detect.js';
 import type { Provider, ProviderId, SandboxLevel } from '../providers/port.js';
 import type { OutputSink } from './render.js';
 import type { LoginMethod } from '../commands/login.js';
+import type { UpdateCheckResult } from '../infra/update-check.js';
 export interface MenuContext {
     readonly version: string;
     readonly clock: Clock;
@@ -67,6 +68,30 @@ export interface MenuContext {
      * spawning during tests (e.g. after first-run onboarding or [j]/[k]/[o] login).
      */
     readonly detectEnvironment?: () => Promise<EnvironmentStatus>;
+    /**
+     * Optional injected update-check for testing. When provided, `startMenu` uses
+     * this instead of the real `checkForUpdate` from infra/update-check.ts,
+     * preventing real npm registry requests from being made during tests.
+     *
+     * Returns the update check result (current, latest, updateAvailable).
+     */
+    readonly checkForUpdate?: () => Promise<UpdateCheckResult>;
+    /**
+     * Optional injected self-update function for testing. When provided, `startMenu`
+     * uses this instead of the real `npm install -g myshell-tools@latest` subprocess.
+     *
+     * Returns true when the update succeeded (exit code 0), false otherwise.
+     * Never throws.
+     */
+    readonly updateSelf?: (out: OutputSink) => Promise<boolean>;
+    /**
+     * Optional injected relaunch function for testing. When provided, `startMenu`
+     * uses this instead of the real `execa('myshell-tools', …)` re-exec.
+     *
+     * Returns the exit code of the relaunched process (or 1 on spawn failure).
+     * Used only for the opt-in auto-update path.
+     */
+    readonly relaunch?: () => Promise<number>;
 }
 /**
  * Parse a yes/no answer from a raw input line, with a configurable default.
@@ -136,6 +161,50 @@ export declare function renderBudgetLine(spend: SpendSummary, _color: boolean):
  * Returns string[] (no ANSI — pure string building, safe for tests).
  */
 export declare function renderConversationList(metas: ConversationMeta[], nowMs: number): string[];
+/**
+ * Count how many timestamps in `times` fall within the half-open window
+ * `[now - windowMs, now]` (both endpoints inclusive).
+ *
+ * Pure — no I/O, no side effects, never throws.
+ *
+ * @param times    - Immutable array of epoch-ms timestamps (e.g. from ctx.clock.now()).
+ * @param now      - The current epoch-ms (e.g. from ctx.clock.now()).
+ * @param windowMs - Width of the sliding window in milliseconds (e.g. 1500).
+ * @returns Number of entries within the window.
+ */
+export declare function countRecentInterrupts(times: readonly number[], now: number, windowMs: number): number;
+/**
+ * Decide what action to take based on the number of recent Ctrl+C presses and
+ * whether a task is currently running.
+ *
+ * Rules:
+ *   count >= 3 → `'exit-app'`
+ *   count === 2 → `'to-menu'`
+ *   count === 1 && taskRunning → `'cancel-task'`
+ *   count === 1 && !taskRunning → `'hint'`
+ *   count <= 0  → `'hint'` (defensive)
+ *
+ * Pure — never throws, no I/O, no side effects.
+ *
+ * @param count       - Number of recent interrupt presses (from countRecentInterrupts).
+ * @param taskRunning - Whether a task is currently in-flight.
+ * @returns The action to take.
+ */
+export declare function interpretInterrupt(count: number, taskRunning: boolean): 'cancel-task' | 'to-menu' | 'exit-app' | 'hint';
+/**
+ * Decide whether a raw-session SIGINT count warrants escaping back to the menu.
+ *
+ * Returns true when count >= 2 (rapid double Ctrl+C), false otherwise.
+ * A single press (count === 1) is left entirely to the child process — the
+ * terminal already delivers SIGINT to the whole foreground process group, so
+ * claude/codex/opencode handles its own cancel without interference from us.
+ *
+ * Pure — no I/O, no side effects, never throws.
+ *
+ * @param count - Number of recent Ctrl+C presses (from countRecentInterrupts).
+ * @returns True when the user should be returned to the myshell-tools menu.
+ */
+export declare function shouldEscapeRawSession(count: number): boolean;
 /**
  * Start the sessions-first interactive menu.
  *