@aragon-agent/cli 0.6.2 → 0.6.4

package/dist/input/stdin-mouse-filter.js

@@ -1,153 +0,0 @@
-/**
- * Stdin mouse filter (mouse-wheel-region-routing §4.2 / §5.2).
- *
- * WHY A WRAPPER AND NOT A SECOND LISTENER. Ink 5.2.1 owns stdin in a way that
- * forbids a second reader: `components/App.js` calls `setEncoding('utf8')`,
- * `ref()`, `setRawMode(true)`, subscribes to `'readable'` and drains with
- * `read()`. Attaching our own `'data'` listener to the same `process.stdin`
- * would switch the stream into flowing mode and RACE Ink's `read()` for chunks
- * — some keystrokes would reach Ink, some would not, non-deterministically
- * (D-3). So the filter REPLACES the stream Ink is given: it reads the real
- * stdin, strips every mouse report, and writes the remainder into a
- * `PassThrough` that carries the surface Ink requires.
- *
- * ORDERING IS AN INVARIANT, NOT A CONVENTION (I-8). The caller must build this
- * filter BEFORE anything writes `\x1b[?1000h`. Reporting enabled while Ink
- * still holds the raw stream does not degrade the feature — it types
- * `[<0;12;5M` into the user's message on every click, which is strictly worse
- * than the bug this feature fixes. `cli.tsx::runInteractive` is the only caller
- * and passes `filter !== null` to `enterAltScreen`.
- */
-import { PassThrough } from 'node:stream';
-import { splitMouseEvents } from './mouse-events.js';
-/**
- * How long a possible-prefix tail is held before being flushed as text.
- *
- * This is what stops a lone `\x1b` — the Esc key, which aborts a run — from
- * being held hostage waiting for a `[` that will never arrive. Worst-case Esc
- * latency becomes 12 ms, and only for the keystroke that is literally a bare
- * ESC; every other key resolves `isMousePrefix` to false immediately.
- */
-const PENDING_FLUSH_MS = 12;
-/** Assign a method onto the PassThrough without widening its public type. */
-function define(target, name, value) {
-    Object.defineProperty(target, name, { value, writable: true, configurable: true });
-}
-export function createMouseFilter(real) {
-    const wrapper = new PassThrough();
-    const listeners = new Set();
-    let pending = '';
-    let flushTimer = null;
-    let disposed = false;
-    // --- The surface Ink reads off the stream it is handed. ------------------
-    // `isRawModeSupported()` reads `props.stdin.isTTY` (App.js:34), so this has
-    // to be a DELEGATING GETTER rather than a snapshot: a stdin that is not a TTY
-    // must still report so through the wrapper, or Ink throws instead of falling
-    // back.
-    Object.defineProperty(wrapper, 'isTTY', {
-        get: () => real.isTTY,
-        configurable: true,
-    });
-    define(wrapper, 'setRawMode', (mode) => {
-        real.setRawMode?.(mode);
-        return wrapper;
-    });
-    define(wrapper, 'ref', () => {
-        real.ref?.();
-        return wrapper;
-    });
-    define(wrapper, 'unref', () => {
-        real.unref?.();
-        return wrapper;
-    });
-    const emit = (event) => {
-        for (const listener of [...listeners])
-            listener(event);
-    };
-    const clearFlushTimer = () => {
-        if (!flushTimer)
-            return;
-        clearTimeout(flushTimer);
-        flushTimer = null;
-    };
-    const flushPending = () => {
-        clearFlushTimer();
-        if (pending.length === 0 || disposed)
-            return;
-        const text = pending;
-        pending = '';
-        wrapper.write(text);
-    };
-    const onData = (chunk) => {
-        if (disposed)
-            return;
-        clearFlushTimer();
-        const decoded = typeof chunk === 'string' ? chunk : chunk.toString('utf8');
-        const split = splitMouseEvents(pending + decoded);
-        pending = split.pending;
-        if (split.text.length > 0)
-            wrapper.write(split.text);
-        for (const event of split.events)
-            emit(event);
-        if (pending.length > 0) {
-            // `.unref()` so a held tail can never keep the process alive on its own.
-            flushTimer = setTimeout(flushPending, PENDING_FLUSH_MS);
-            flushTimer.unref?.();
-        }
-    };
-    // P2-7: a closed stdin must still terminate Ink's reader, or it waits forever
-    // on a stream that will never produce another byte.
-    const onEnd = () => {
-        flushPending();
-        if (!wrapper.writableEnded)
-            wrapper.end();
-    };
-    // `setEncoding('utf8')` on the REAL stream so Node's StringDecoder handles
-    // multi-byte boundaries for us — the parser works on characters, and a UTF-8
-    // sequence split across two chunks would otherwise become two mojibake
-    // characters before it ever reached `splitMouseEvents`.
-    real.setEncoding?.('utf8');
-    real.on('data', onData);
-    real.once('end', onEnd);
-    real.once('close', onEnd);
-    return {
-        stdin: wrapper,
-        source: {
-            subscribe(listener) {
-                listeners.add(listener);
-                return () => listeners.delete(listener);
-            },
-        },
-        dispose() {
-            if (disposed)
-                return;
-            disposed = true;
-            clearFlushTimer();
-            real.removeListener('data', onData);
-            real.removeListener('end', onEnd);
-            real.removeListener('close', onEnd);
-            listeners.clear();
-            // I-7: a live `'data'` listener on stdin keeps the event loop alive, and
-            // `aragon` would hang on exit instead of returning to the shell.
-            real.pause?.();
-            real.unref?.();
-        },
-    };
-}
-/**
- * Build a filter, or `null` if construction throws.
- *
- * The `null` return is the whole point (P0-1): `enterAltScreen` derives whether
- * to enable mouse reporting from `filter !== null`, so a construction failure
- * degrades to "the wheel is inert" — a supported, tested rung of the fail-safe
- * ladder — rather than leaving reporting on with no filter in front of Ink.
- */
-export function tryCreateMouseFilter(real, onError) {
-    try {
-        return createMouseFilter(real);
-    }
-    catch (err) {
-        onError?.(err instanceof Error ? err.message : String(err));
-        return null;
-    }
-}