@opentui/core 0.2.16 → 0.3.1

package/index.js

@@ -26,7 +26,6 @@ import {
   InputRenderableEvents,
   LineNumberRenderable,
   MarkdownRenderable,
-  NativeSpanFeed,
   PROTANOPIA_COMP_MATRIX,
   PROTANOPIA_SIM_MATRIX,
   RainbowTextEffect,
@@ -72,7 +71,7 @@ import {
   resolveCoreSlot,
   setupAudio,
   vstyles
-} from "./index-hzcw4q21.js";
+} from "./index-zv319bjp.js";
 import {
   ASCIIFontSelectionHelper,
   ATTRIBUTE_BASE_BITS,
@@ -104,6 +103,7 @@ import {
   MouseButton,
   MouseEvent,
   MouseParser,
+  NativeSpanFeed,
   OptimizedBuffer,
   PasteEvent,
   RGBA,
@@ -246,7 +246,7 @@ import {
   white,
   wrapWithDelegates,
   yellow
-} from "./index-qfwqv8y3.js";
+} from "./index-jx0p1c2f.js";
 export {
   yellow,
   wrapWithDelegates,
@@ -494,5 +494,5 @@ export {
   ACHROMATOPSIA_MATRIX
 };
 
-//# debugId=3B163E1BF0509BD764756E2164756E21
+//# debugId=893EFD9F8A7D3C4264756E2164756E21
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -4,6 +4,6 @@
   "sourcesContent": [
   ],
   "mappings": "",
-  "debugId": "3B163E1BF0509BD764756E2164756E21",
+  "debugId": "893EFD9F8A7D3C4264756E2164756E21",
   "names": []
 }

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.2.16",
+  "version": "0.3.1",
   "description": "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)",
   "license": "MIT",
   "repository": {
@@ -69,11 +69,11 @@
     "web-tree-sitter": "0.25.10"
   },
   "optionalDependencies": {
-    "@opentui/core-darwin-x64": "0.2.16",
-    "@opentui/core-darwin-arm64": "0.2.16",
-    "@opentui/core-linux-x64": "0.2.16",
-    "@opentui/core-linux-arm64": "0.2.16",
-    "@opentui/core-win32-x64": "0.2.16",
-    "@opentui/core-win32-arm64": "0.2.16"
+    "@opentui/core-darwin-x64": "0.3.1",
+    "@opentui/core-darwin-arm64": "0.3.1",
+    "@opentui/core-linux-x64": "0.3.1",
+    "@opentui/core-linux-arm64": "0.3.1",
+    "@opentui/core-win32-x64": "0.3.1",
+    "@opentui/core-win32-arm64": "0.3.1"
   }
 }

package/renderer.d.ts

@@ -3,7 +3,7 @@ import { DebugOverlayCorner, type CursorStyleOptions, type MousePointerStyle, ty
 import { RGBA, type ColorInput } from "./lib/RGBA.js";
 import type { Pointer } from "./platform/ffi.js";
 import { OptimizedBuffer } from "./buffer.js";
-import { type NativeRenderStats, type RenderLib } from "./zig.js";
+import { type NativeBufferedOutput, type NativeRenderStats } from "./zig.js";
 import { TerminalConsole, type ConsoleOptions } from "./console.js";
 import { type MouseEventType, type RawMouseEvent, type ScrollInfo } from "./lib/parse.mouse.js";
 import { Selection } from "./lib/selection.js";
@@ -16,8 +16,10 @@ import { type Clock } from "./lib/clock.js";
 export interface CliRendererConfig {
     stdin?: NodeJS.ReadStream;
     stdout?: NodeJS.WriteStream;
+    width?: number;
+    height?: number;
     remote?: boolean;
-    testing?: boolean;
+    bufferedOutput?: NativeBufferedOutput;
     exitOnCtrlC?: boolean;
     exitSignals?: NodeJS.Signals[];
     clearOnShutdown?: boolean;
@@ -110,6 +112,9 @@ export interface ScrollbackSurface {
     commitRows(startRow: number, endRowExclusive: number, options?: ScrollbackSurfaceCommitOptions): void;
     destroy(): void;
 }
+export interface SplitFooterReplayResetOptions {
+    clearSavedLines?: boolean;
+}
 /**
  * Kitty Keyboard Protocol configuration options
  * See: https://sw.kovidgoyal.net/kitty/keyboard-protocol/#progressive-enhancement
@@ -165,6 +170,11 @@ export declare enum MouseButton {
     WHEEL_UP = 4,
     WHEEL_DOWN = 5
 }
+/**
+ * Create a CLI renderer and run its async terminal setup. The constructor
+ * owns all stream and backend decisions; this factory only layers on the
+ * `--delay-start` flag and the `await setupTerminal()` convenience.
+ */
 export declare function createCliRenderer(config?: CliRendererConfig): Promise<CliRenderer>;
 export declare enum CliRenderEvents {
     RESIZE = "resize",
@@ -203,6 +213,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private _destroyPending;
     private _destroyFinalized;
     private _destroyCleanupPrepared;
+    private _streamLeaseAcquired;
     nextRenderBuffer: OptimizedBuffer;
     currentRenderBuffer: OptimizedBuffer;
     private _isRunning;
@@ -317,8 +328,37 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private dumpOutputCache;
     private exitHandler;
     private warningHandler;
+    private readonly _usesProcessStdout;
+    private _feed;
+    private _detachFeed;
+    private _detachFeedError;
+    private feedIdleRenderScheduled;
     get controlState(): RendererControlState;
-    constructor(lib: RenderLib, rendererPtr: Pointer, stdin: NodeJS.ReadStream, stdout: NodeJS.WriteStream, width: number, height: number, config?: CliRendererConfig);
+    /**
+     * Construct a renderer over the given streams.
+     *
+     * If `stdout` is not `process.stdout`, a `NativeSpanFeed` is allocated
+     * internally and rendered bytes are piped through it to `stdout` unless
+     * `bufferedOutput: "memory"` is set. Prefer `createCliRenderer` for the async
+     * `setupTerminal` convenience.
+     *
+     * Construction side effects (observable before the constructor returns):
+     *   - Acquires exclusive ownership of the given stdin/stdout streams
+     *   - Allocates a `NativeSpanFeed` (for non-process stdout unless bufferedOutput is "memory")
+     *   - Calls `lib.createRenderer` → native Zig allocation
+     *   - Registers in the process-wide `rendererTracker`
+     *   - Adds `process.on(...)` listeners for SIGWINCH (process.stdout only),
+     *     "warning", "uncaughtException", "unhandledRejection", "beforeExit",
+     *     plus the configured `exitSignals`
+     *   - Replaces `global.requestAnimationFrame` with the renderer's impl
+     *   - When `setupTerminal()` is called, it will put `stdin` in raw mode and
+     *     call `stdin.resume()`
+     *
+     * Some late constructor side effects are not rolled back if construction
+     * throws partway; production callers should use `createCliRenderer`, which
+     * wraps `setupTerminal()` in a try/catch that calls `destroy()` on failure.
+     */
+    constructor(stdin: NodeJS.ReadStream, stdout: NodeJS.WriteStream, width: number, height: number, config?: CliRendererConfig);
     private addExitListeners;
     private removeExitListeners;
     get isDestroyed(): boolean;
@@ -339,6 +379,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     get widthMethod(): WidthMethod;
     get frameId(): number;
     private writeOut;
+    private scheduleRenderAfterFeedIdle;
     requestRender(): void;
     private activateFrame;
     get consoleMode(): ConsoleMode;
@@ -385,6 +426,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     set useKittyKeyboard(use: boolean);
     createScrollbackSurface(options?: ScrollbackSurfaceOptions): ScrollbackSurface;
     writeToScrollback(write: ScrollbackWriter): void;
+    resetSplitFooterForReplay(options?: SplitFooterReplayResetOptions): void;
     private getSnapshotWidth;
     private getSnapshotHeight;
     private getSnapshotRowWidths;
@@ -452,6 +494,15 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private handleResize;
     private queryPixelResolution;
     private processResize;
+    /**
+     * Programmatically resize the renderer to new dimensions.
+     *
+     * Use this for externally-driven resize events — for example, an SSH
+     * `window-change` signal or a test harness simulating a terminal resize.
+     * When the renderer is attached to `process.stdout`, `SIGWINCH` is handled
+     * automatically and callers do not need this method.
+     */
+    resize(width: number, height: number): void;
     setBackgroundColor(color: ColorInput): void;
     toggleDebugOverlay(): void;
     configureDebugOverlay(options: {
@@ -470,7 +521,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     isOsc52Supported(): boolean;
     dumpHitGrid(): void;
     dumpBuffers(timestamp?: number): void;
-    dumpStdoutBuffer(timestamp?: number): void;
+    dumpOutputBuffer(timestamp?: number): void;
     static setCursorPosition(renderer: CliRenderer, x: number, y: number, visible?: boolean): void;
     static setCursorStyle(renderer: CliRenderer, options: CursorStyleOptions): void;
     static setCursorColor(renderer: CliRenderer, color: RGBA): void;

package/runtime-plugin-support-configure.js

@@ -1,13 +1,13 @@
 // @bun
 import {
   ensureRuntimePluginSupport
-} from "./index-t1vzaxv4.js";
+} from "./index-gnh42qx3.js";
 import {
   createRuntimePlugin,
   runtimeModuleIdForSpecifier
-} from "./index-qe67qr6s.js";
-import"./index-hzcw4q21.js";
-import"./index-qfwqv8y3.js";
+} from "./index-2wycxnwx.js";
+import"./index-zv319bjp.js";
+import"./index-jx0p1c2f.js";
 export {
   runtimeModuleIdForSpecifier,
   ensureRuntimePluginSupport,

package/runtime-plugin-support.js

@@ -1,13 +1,13 @@
 // @bun
 import {
   ensureRuntimePluginSupport
-} from "./index-t1vzaxv4.js";
+} from "./index-gnh42qx3.js";
 import {
   createRuntimePlugin,
   runtimeModuleIdForSpecifier
-} from "./index-qe67qr6s.js";
-import"./index-hzcw4q21.js";
-import"./index-qfwqv8y3.js";
+} from "./index-2wycxnwx.js";
+import"./index-zv319bjp.js";
+import"./index-jx0p1c2f.js";
 // src/runtime-plugin-support.ts
 ensureRuntimePluginSupport();
 export {

package/runtime-plugin.js

@@ -3,9 +3,9 @@ import {
   createRuntimePlugin,
   isCoreRuntimeModuleSpecifier,
   runtimeModuleIdForSpecifier
-} from "./index-qe67qr6s.js";
-import"./index-hzcw4q21.js";
-import"./index-qfwqv8y3.js";
+} from "./index-2wycxnwx.js";
+import"./index-zv319bjp.js";
+import"./index-jx0p1c2f.js";
 export {
   runtimeModuleIdForSpecifier,
   isCoreRuntimeModuleSpecifier,

package/testing/test-renderer.d.ts

@@ -1,5 +1,5 @@
 import { CliRenderer, type CliRendererConfig } from "../renderer.js";
-import { type NativeRenderStats } from "../zig.js";
+import type { NativeRenderStats } from "../zig.js";
 import { createMockKeys } from "./mock-keys.js";
 import { createMockMouse } from "./mock-mouse.js";
 import type { CapturedFrame } from "../types.js";
@@ -9,8 +9,7 @@ export interface TestRendererOptions extends CliRendererConfig {
     kittyKeyboard?: boolean;
     otherModifiersMode?: boolean;
 }
-export interface TestRenderer extends CliRenderer {
-}
+export type TestRenderer = CliRenderer;
 export type MockInput = ReturnType<typeof createMockKeys>;
 export type MockMouse = ReturnType<typeof createMockMouse>;
 export interface TestFlushOptions {

package/testing/test-streams.d.ts

@@ -0,0 +1,12 @@
+import { Writable } from "stream";
+export declare class TestWriteStream extends Writable {
+    readonly isTTY = true;
+    readonly columns: number;
+    readonly rows: number;
+    constructor(columns?: number, rows?: number);
+    _write(_chunk: any, _encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
+    getColorDepth(): number;
+}
+export type TestStdout = TestWriteStream & NodeJS.WriteStream;
+export declare function createTestStdin(): NodeJS.ReadStream;
+export declare function createTestStdout(columns?: number, rows?: number): NodeJS.WriteStream;

package/testing.js

@@ -2,13 +2,8 @@
 import {
   ANSI,
   CliRenderer,
-  TreeSitterClient,
-  calculateRenderGeometry,
-  resolveRenderLib
-} from "./index-qfwqv8y3.js";
-
-// src/testing/test-renderer.ts
-import { Readable, Writable } from "stream";
+  TreeSitterClient
+} from "./index-jx0p1c2f.js";
 
 // src/testing/mock-keys.ts
 import { Buffer as Buffer2 } from "buffer";
@@ -455,6 +450,32 @@ function createMockMouse(renderer) {
   };
 }
 
+// src/testing/test-streams.ts
+import { Readable, Writable } from "stream";
+
+class TestWriteStream extends Writable {
+  isTTY = true;
+  columns;
+  rows;
+  constructor(columns = 80, rows = 24) {
+    super();
+    this.columns = columns;
+    this.rows = rows;
+  }
+  _write(_chunk, _encoding, callback) {
+    callback();
+  }
+  getColorDepth() {
+    return 24;
+  }
+}
+function createTestStdin() {
+  return new Readable({ read() {} });
+}
+function createTestStdout(columns = 80, rows = 24) {
+  return new TestWriteStream(columns, rows);
+}
+
 // src/testing/test-renderer.ts
 var decoder = new TextDecoder;
 var DEFAULT_MAX_PASSES = 20;
@@ -557,23 +578,6 @@ function waitForNextFrameOrIdle(renderer) {
     }
   });
 }
-
-class TestWriteStream extends Writable {
-  isTTY = true;
-  columns;
-  rows;
-  constructor(columns, rows) {
-    super();
-    this.columns = columns;
-    this.rows = rows;
-  }
-  _write(_chunk, _encoding, callback) {
-    callback();
-  }
-  getColorDepth() {
-    return 24;
-  }
-}
 async function createTestRenderer(options) {
   const useKittyKeyboard = options.kittyKeyboard ? { events: true } : options.useKittyKeyboard;
   const renderer = await setupTestRenderer({
@@ -591,6 +595,10 @@ async function createTestRenderer(options) {
   });
   const mockMouse = createMockMouse(renderer);
   const renderOnce = async () => {
+    const feed = renderer._feed;
+    if (feed?.isBackpressured()) {
+      await feed.idle();
+    }
     await renderer.loop();
   };
   const captureCharFrame = () => {
@@ -699,31 +707,14 @@ async function createTestRenderer(options) {
   };
 }
 async function setupTestRenderer(config) {
-  const stdin = config.stdin || new Readable({ read() {} });
+  const stdin = config.stdin || createTestStdin();
   const width = config.width || config.stdout?.columns || process.stdout.columns || 80;
   const height = config.height || config.stdout?.rows || process.stdout.rows || 24;
-  const stdout = config.stdout || new TestWriteStream(width, height);
-  const screenMode = config.screenMode ?? "alternate-screen";
-  const footerHeight = config.footerHeight ?? 12;
-  const geometry = calculateRenderGeometry(screenMode, width, height, footerHeight);
-  const ziglib = resolveRenderLib();
-  const rendererPtr = ziglib.createRenderer(geometry.renderWidth, geometry.renderHeight, {
-    testing: true,
-    remote: config.remote ?? false
+  const stdout = config.stdout || createTestStdout(width, height);
+  return new CliRenderer(stdin, stdout, width, height, {
+    ...config,
+    bufferedOutput: config.bufferedOutput ?? "memory"
   });
-  if (!rendererPtr) {
-    throw new Error("Failed to create test renderer");
-  }
-  if (config.useThread === undefined) {
-    config.useThread = true;
-  }
-  if (process.platform === "linux") {
-    config.useThread = false;
-  }
-  ziglib.setUseThread(rendererPtr, config.useThread);
-  const renderer = new CliRenderer(ziglib, rendererPtr, stdin, stdout, width, height, config);
-  process.off("SIGWINCH", renderer["sigwinchHandler"]);
-  return renderer;
 }
 // src/testing/mock-tree-sitter-client.ts
 class MockTreeSitterClient extends TreeSitterClient {
@@ -795,7 +786,8 @@ function createTerminalCapabilities(overrides = {}) {
     osc52: false,
     notifications: false,
     explicit_cursor_positioning: false,
-    in_tmux: false,
+    remote: false,
+    multiplexer: "none",
     ...overrides,
     terminal: {
       name: "",
@@ -999,5 +991,5 @@ export {
   KeyCodes
 };
 
-//# debugId=40EAAC392783D1D064756E2164756E21
+//# debugId=0BAC903EE185632E64756E2164756E21
 //# sourceMappingURL=testing.js.map