@earendil-works/pi-tui 0.87.0 → 0.99.0

package/dist/tui.js

@@ -3,7 +3,7 @@
  */
 import { performance } from "node:perf_hooks";
 import { isKeyRelease, matchesKey } from "./keys.js";
-import { isOsc11BackgroundColorResponse, parseOsc11BackgroundColor, parseTerminalColorSchemeReport, } from "./terminal-colors.js";
+import { parseOscColorResponse, parseTerminalColorSchemeReport, } from "./terminal-colors.js";
 import { getCapabilities, isImageLine, setCellDimensions } from "./terminal-image.js";
 import { extractSegments, normalizeTerminalOutput, sliceByColumn, sliceWithWidth, visibleWidth } from "./utils.js";
 /**
@@ -14,8 +14,13 @@ export function dispatchMouseEvent(component, event) {
     const result = component.handleMouse?.(event);
     if (!result)
         return undefined;
-    if ("target" in result)
-        return result;
+    if ("target" in result) {
+        // The component forwarded the event to a child it hosts. Like a delegating container, it routes
+        // keys to that child itself, so it keeps keyboard focus. Focusing the child directly would leave
+        // focus on a detached component once the host removes it, e.g. a closed settings submenu.
+        const forwarded = result;
+        return forwarded.focus && component.handleInput ? { ...forwarded, focusTarget: component } : forwarded;
+    }
     if (!result.handled && !result.capture && !result.focus)
         return undefined;
     return {
@@ -41,6 +46,16 @@ export function retargetMouseEvent(event, target) {
         height: target.height,
     };
 }
+const TERMINAL_PALETTE_SIZE = 16;
+/** OSC 10 and 11 plus OSC 4 for every palette color. */
+const TERMINAL_COLOR_REPLY_COUNT = 2 + TERMINAL_PALETTE_SIZE;
+/**
+ * Default colors, palette colors 0-15, and a trailing primary device attributes (DA1) request.
+ * Every terminal answers DA1 and terminals answer in order, so the DA1 reply marks the end of
+ * the color replies, including for terminals that ignore the color queries.
+ */
+const TERMINAL_COLOR_QUERY = `\x1b]10;?\x07\x1b]11;?\x07${Array.from({ length: TERMINAL_PALETTE_SIZE }, (_, index) => `\x1b]4;${index};?\x07`).join("")}\x1b[c`;
+const DEVICE_ATTRIBUTES_RESPONSE_PATTERN = /^\x1b\[\?[\d;]*c$/;
 /** Type guard to check if a component implements Focusable */
 export function isFocusable(component) {
     return component !== null && "focused" in component;
@@ -171,8 +186,11 @@ export class TuiBase extends Container {
     clearOnShrink = false;
     fullRedrawCount = 0;
     stopped = false;
-    pendingOsc11BackgroundReplies = 0;
-    pendingOsc11BackgroundQueries = [];
+    /**
+     * Color queries waiting for their DA1 reply, oldest first. Terminals answer in order, so color
+     * replies belong to the oldest one. Queries stay here after a timeout to collect late replies.
+     */
+    pendingTerminalColorQueries = [];
     terminalColorSchemeListeners = new Set();
     terminalColorSchemeNotificationsEnabled = false;
     /** Directory for debug/crash logs. When undefined, debug logging is disabled and crash dumps fall back to the OS temp directory. */
@@ -209,7 +227,7 @@ export class TuiBase extends Container {
             return;
         this.showHardwareCursor = enabled;
         if (!enabled) {
-            this.terminal.hideCursor();
+            this.hideTerminalCursor();
         }
         this.requestRender();
     }
@@ -357,7 +375,7 @@ export class TuiBase extends Container {
         if (!options?.nonCapturing && this.isOverlayVisible(entry)) {
             this.setFocus(component);
         }
-        this.terminal.hideCursor();
+        this.hideTerminalCursor();
         this.requestRender();
         // Return handle for controlling this overlay
         return {
@@ -373,7 +391,7 @@ export class TuiBase extends Container {
                         this.setFocus(topVisible?.component ?? entry.preFocus);
                     }
                     if (this.overlayStack.length === 0)
-                        this.terminal.hideCursor();
+                        this.hideTerminalCursor();
                     this.requestRender();
                 }
             },
@@ -460,9 +478,14 @@ export class TuiBase extends Container {
             this.setFocus(topVisible?.component ?? overlay.preFocus);
         }
         if (this.overlayStack.length === 0)
-            this.terminal.hideCursor();
+            this.hideTerminalCursor();
         this.requestRender();
     }
+    /** Hide the cursor while running. After stop(), the shell owns the cursor and it must stay visible. */
+    hideTerminalCursor() {
+        if (!this.stopped)
+            this.terminal.hideCursor();
+    }
     /** Check if there are any visible overlays */
     hasOverlay() {
         return this.overlayStack.some((o) => this.isOverlayVisible(o));
@@ -653,7 +676,7 @@ export class TuiBase extends Container {
         }, delay);
     }
     handleTerminalInput(data) {
-        if (this.consumeOsc11BackgroundResponse(data)) {
+        if (this.consumeTerminalColorResponse(data)) {
             return;
         }
         if (this.consumeTerminalColorSchemeReport(data)) {
@@ -726,27 +749,50 @@ export class TuiBase extends Container {
             this.requestImmediateRender();
         }
     }
-    consumeOsc11BackgroundResponse(data) {
-        if (this.pendingOsc11BackgroundReplies <= 0) {
+    consumeTerminalColorResponse(data) {
+        const query = this.pendingTerminalColorQueries[0];
+        if (!query) {
             return false;
         }
-        if (!isOsc11BackgroundColorResponse(data)) {
+        if (DEVICE_ATTRIBUTES_RESPONSE_PATTERN.test(data)) {
+            this.pendingTerminalColorQueries.shift();
+            this.completeTerminalColorQuery(query);
+            return true;
+        }
+        const response = parseOscColorResponse(data);
+        if (!response) {
             return false;
         }
-        const rgb = parseOsc11BackgroundColor(data);
-        this.pendingOsc11BackgroundReplies -= 1;
-        const query = this.pendingOsc11BackgroundQueries.shift();
-        if (query && !query.settled) {
-            query.settled = true;
-            if (query.timer) {
-                clearTimeout(query.timer);
-                query.timer = undefined;
-            }
-            query.resolve?.(rgb);
-            query.resolve = undefined;
+        const { target, rgb } = response;
+        const key = String(target);
+        if (!query.deliver || query.replied.has(key)) {
+            return true;
+        }
+        query.replied.add(key);
+        if (target === "foreground") {
+            query.foreground = rgb;
+        }
+        else if (target === "background") {
+            query.background = rgb;
+        }
+        else if (target < TERMINAL_PALETTE_SIZE) {
+            query.palette[target] = rgb;
+        }
+        if (query.replied.size === TERMINAL_COLOR_REPLY_COUNT) {
+            this.completeTerminalColorQuery(query);
         }
         return true;
     }
+    terminalColorQueryResult(query) {
+        const palette = query.palette.every((color) => color !== undefined) ? query.palette : undefined;
+        return { foreground: query.foreground, background: query.background, palette };
+    }
+    completeTerminalColorQuery(query) {
+        const deliver = query.deliver;
+        query.deliver = undefined;
+        clearTimeout(query.timer);
+        deliver?.(this.terminalColorQueryResult(query));
+    }
     consumeTerminalColorSchemeReport(data) {
         const scheme = parseTerminalColorSchemeReport(data);
         if (!scheme) {
@@ -1000,55 +1046,28 @@ export class TuiBase extends Container {
         return null;
     }
     /**
-     * Query the terminal's default background color with OSC 11 (`ESC ] 11 ; ? BEL`).
-     * @param timeoutMs Query timeout in milliseconds.
-     * @returns Promise containing the parsed RGB color, or undefined if it times out or fails to parse.
+     * Query the terminal's theme colors: the default foreground (OSC 10), the default background
+     * (OSC 11), and ANSI colors 0-15 (OSC 4), followed by a DA1 request that marks the end of the
+     * replies. Resolves when the DA1 reply or all color replies arrive, or when the timeout expires.
+     * Colors the terminal did not report are undefined; the palette is only set when all 16 arrived.
+     * @param timeoutMs Query timeout in milliseconds, for terminals that do not answer DA1 either.
+     * @param onLateReply Receives the replies if the query completes after the timeout, e.g. over slow links.
      */
-    queryTerminalBackgroundColor({ timeoutMs }) {
+    queryTerminalColors({ timeoutMs, onLateReply, }) {
         return new Promise((resolve) => {
             const query = {
-                settled: false,
-                resolve,
+                palette: Array.from({ length: TERMINAL_PALETTE_SIZE }, () => undefined),
+                replied: new Set(),
+                deliver: resolve,
                 timer: undefined,
             };
+            // Resolve with the replies so far, and keep collecting late replies for `onLateReply`.
             query.timer = setTimeout(() => {
-                if (query.settled) {
-                    return;
-                }
-                query.settled = true;
-                query.timer = undefined;
-                query.resolve?.(undefined);
-                query.resolve = undefined;
+                query.deliver = onLateReply;
+                resolve(this.terminalColorQueryResult(query));
             }, timeoutMs);
-            this.pendingOsc11BackgroundQueries.push(query);
-            this.pendingOsc11BackgroundReplies += 1;
-            this.terminal.write("\x1b]11;?\x07");
-        });
-    }
-    /**
-     * Query the terminal's color-scheme preference with DSR (`CSI ? 996 n`).
-     * Terminals that support the color palette notification protocol reply with
-     * `CSI ? 997 ; 1 n` for dark or `CSI ? 997 ; 2 n` for light.
-     */
-    queryTerminalColorScheme({ timeoutMs }) {
-        return new Promise((resolve) => {
-            let settled = false;
-            let timer;
-            let unsubscribe = () => { };
-            const settle = (scheme) => {
-                if (settled)
-                    return;
-                settled = true;
-                if (timer) {
-                    clearTimeout(timer);
-                    timer = undefined;
-                }
-                unsubscribe();
-                resolve(scheme);
-            };
-            unsubscribe = this.onTerminalColorSchemeChange(settle);
-            timer = setTimeout(() => settle(undefined), timeoutMs);
-            this.terminal.write("\x1b[?996n");
+            this.pendingTerminalColorQueries.push(query);
+            this.terminal.write(TERMINAL_COLOR_QUERY);
         });
     }
 }