@opentui/core 0.2.15 → 0.3.0

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-yyyfmp8n.js";
+} from "./index-sq86yyfz.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-3fq5hq97.js";
+} from "./index-081xws23.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/lib/extmarks.d.ts

@@ -67,6 +67,7 @@ export declare class ExtmarksController {
     adjustExtmarksAfterDeletion(deleteOffset: number, length: number): void;
     private offsetToPosition;
     private positionToOffset;
+    private getNextCursorOffset;
     private updateHighlights;
     private offsetExcludingNewlines;
     create(options: ExtmarkOptions): number;

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.2.15",
+  "version": "0.3.0",
   "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.15",
-    "@opentui/core-darwin-arm64": "0.2.15",
-    "@opentui/core-linux-x64": "0.2.15",
-    "@opentui/core-linux-arm64": "0.2.15",
-    "@opentui/core-win32-x64": "0.2.15",
-    "@opentui/core-win32-arm64": "0.2.15"
+    "@opentui/core-darwin-x64": "0.3.0",
+    "@opentui/core-darwin-arm64": "0.3.0",
+    "@opentui/core-linux-x64": "0.3.0",
+    "@opentui/core-linux-arm64": "0.3.0",
+    "@opentui/core-win32-x64": "0.3.0",
+    "@opentui/core-win32-arm64": "0.3.0"
   }
 }

package/renderables/Input.d.ts

@@ -6,6 +6,8 @@ export type InputKeyBinding = TextareaKeyBinding;
 export interface InputRenderableOptions extends Omit<TextareaOptions, "height" | "minHeight" | "maxHeight" | "initialValue"> {
     /** Initial text value (newlines are stripped) */
     value?: string;
+    /** Minimum number of characters allowed */
+    minLength?: number;
     /** Maximum number of characters allowed */
     maxLength?: number;
     /** Placeholder text (Input only supports string, not StyledText) */
@@ -29,6 +31,7 @@ export declare enum InputRenderableEvents {
  */
 export declare class InputRenderable extends TextareaRenderable {
     private _maxLength;
+    private _minLength;
     private _lastCommittedValue;
     private static readonly defaultOptions;
     constructor(ctx: RenderContext, options: InputRenderableOptions);
@@ -61,6 +64,8 @@ export declare class InputRenderable extends TextareaRenderable {
     deleteCharacter(direction: "backward" | "forward"): void;
     set maxLength(maxLength: number);
     get maxLength(): number;
+    set minLength(minLength: number);
+    get minLength(): number;
     set placeholder(placeholder: string);
     get placeholder(): string;
     set initialValue(value: string);

package/renderables/Markdown.d.ts

@@ -123,6 +123,7 @@ export interface BlockState {
     marginTop?: number;
     renderable: Renderable;
     tableContentCache?: TableContentCache;
+    tracksInterBlockMargin?: boolean;
 }
 export type { ParseState };
 export declare class MarkdownRenderable extends Renderable {
@@ -190,7 +191,6 @@ export declare class MarkdownRenderable extends Renderable {
     private getRenderableListItemTokens;
     private applyListChildRenderable;
     private destroyListItemChildrenAfter;
-    private getListChildMarkdownRaw;
     private applyListItemMarker;
     private createListChildRenderable;
     private createHorizontalRuleRenderable;
@@ -200,6 +200,7 @@ export declare class MarkdownRenderable extends Renderable {
     private applyCodeBlockRenderable;
     private shouldRenderSeparately;
     private getInterBlockMargin;
+    private applyInterBlockMargin;
     private createMarkdownBlockToken;
     private normalizeMarkdownBlockRaw;
     private normalizeScrollbackMarkdownBlockRaw;

package/renderables/ScrollBox.d.ts

@@ -86,6 +86,7 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
         y: number;
     }): void;
     private isAtStickyPosition;
+    private isAtStickyReengagePoint;
     add(obj: Renderable | VNode<any, any[]>, index?: number): number;
     insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number;
     remove(id: string): void;

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 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;
@@ -48,11 +50,34 @@ export interface CliRendererConfig {
 }
 export type ScreenMode = "alternate-screen" | "main-screen" | "split-footer";
 export type ExternalOutputMode = "capture-stdout" | "passthrough";
+export interface CliRendererExternalOutputEvent {
+    snapshot: OptimizedBuffer;
+    rowColumns: number;
+    startOnNewLine: boolean;
+    trailingNewline: boolean;
+}
 export type ConsoleMode = "console-overlay" | "disabled";
 export type PixelResolution = {
     width: number;
     height: number;
 };
+export interface CliRendererStats extends NativeRenderStats {
+    fps: number;
+    frameCount: number;
+    frameTimes: number[];
+    averageFrameTime: number;
+    minFrameTime: number;
+    maxFrameTime: number;
+    frameCallbackTime: number;
+}
+export interface CliRendererFrameEvent {
+    frameId: number;
+}
+export interface RendererSchedulerState {
+    isRunning: boolean;
+    isRendering: boolean;
+    hasScheduledRender: boolean;
+}
 export interface ScrollbackRenderContext {
     width: number;
     widthMethod: WidthMethod;
@@ -142,9 +167,16 @@ 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",
+    FRAME = "frame",
+    EXTERNAL_OUTPUT = "external_output",
     FOCUS = "focus",
     BLUR = "blur",
     FOCUSED_RENDERABLE = "focused_renderable",
@@ -178,6 +210,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private _destroyPending;
     private _destroyFinalized;
     private _destroyCleanupPrepared;
+    private _streamLeaseAcquired;
     nextRenderBuffer: OptimizedBuffer;
     currentRenderBuffer: OptimizedBuffer;
     private _isRunning;
@@ -292,8 +325,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;
@@ -314,6 +376,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;
@@ -322,6 +385,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private isIdleNow;
     private resolveIdleIfNeeded;
     idle(): Promise<void>;
+    getSchedulerState(): RendererSchedulerState;
     get resolution(): PixelResolution | null;
     get console(): TerminalConsole;
     get keyInput(): KeyHandler;
@@ -426,6 +490,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: {
@@ -444,7 +517,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;
@@ -478,14 +551,8 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     intermediateRender(): void;
     private renderNative;
     private collectStatSample;
-    getStats(): {
-        fps: number;
-        frameCount: number;
-        frameTimes: number[];
-        averageFrameTime: number;
-        minFrameTime: number;
-        maxFrameTime: number;
-    };
+    getNativeStats(): NativeRenderStats;
+    getStats(): CliRendererStats;
     resetStats(): void;
     setGatherStats(enabled: boolean): void;
     getSelection(): Selection | null;

package/runtime-plugin-support-configure.js

@@ -1,13 +1,13 @@
 // @bun
 import {
   ensureRuntimePluginSupport
-} from "./index-bdfngvbe.js";
+} from "./index-dhbwkghw.js";
 import {
   createRuntimePlugin,
   runtimeModuleIdForSpecifier
-} from "./index-pzzbb0f6.js";
-import"./index-yyyfmp8n.js";
-import"./index-3fq5hq97.js";
+} from "./index-qwem5zxy.js";
+import"./index-sq86yyfz.js";
+import"./index-081xws23.js";
 export {
   runtimeModuleIdForSpecifier,
   ensureRuntimePluginSupport,

package/runtime-plugin-support.js

@@ -1,13 +1,13 @@
 // @bun
 import {
   ensureRuntimePluginSupport
-} from "./index-bdfngvbe.js";
+} from "./index-dhbwkghw.js";
 import {
   createRuntimePlugin,
   runtimeModuleIdForSpecifier
-} from "./index-pzzbb0f6.js";
-import"./index-yyyfmp8n.js";
-import"./index-3fq5hq97.js";
+} from "./index-qwem5zxy.js";
+import"./index-sq86yyfz.js";
+import"./index-081xws23.js";
 // src/runtime-plugin-support.ts
 ensureRuntimePluginSupport();
 export {

package/runtime-plugin.js

@@ -3,9 +3,9 @@ import {
   createRuntimePlugin,
   isCoreRuntimeModuleSpecifier,
   runtimeModuleIdForSpecifier
-} from "./index-pzzbb0f6.js";
-import"./index-yyyfmp8n.js";
-import"./index-3fq5hq97.js";
+} from "./index-qwem5zxy.js";
+import"./index-sq86yyfz.js";
+import"./index-081xws23.js";
 export {
   runtimeModuleIdForSpecifier,
   isCoreRuntimeModuleSpecifier,

package/testing/test-recorder.d.ts

@@ -20,7 +20,7 @@ export interface TestRecorderOptions {
     now?: () => number;
 }
 /**
- * TestRecorder records frames from a TestRenderer by hooking into the render pipeline.
+ * TestRecorder records frames from a TestRenderer by listening to rendered frame events.
  * It captures the character frame after each native render pass.
  */
 export declare class TestRecorder {
@@ -29,17 +29,17 @@ export declare class TestRecorder {
     private recording;
     private frameNumber;
     private startTime;
-    private originalRenderNative?;
     private decoder;
     private recordBuffers;
     private now;
+    private readonly onFrame;
     constructor(renderer: TestRenderer, options?: TestRecorderOptions);
     /**
-     * Start recording frames. This hooks into the renderer's renderNative method.
+     * Start recording frames.
      */
     rec(): void;
     /**
-     * Stop recording frames and restore the original renderNative method.
+     * Stop recording frames.
      */
     stop(): void;
     /**

package/testing/test-renderer.d.ts

@@ -1,4 +1,5 @@
 import { CliRenderer, type CliRendererConfig } from "../renderer.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";
@@ -8,16 +9,46 @@ 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 declare function createTestRenderer(options: TestRendererOptions): Promise<{
+export interface TestFlushOptions {
+    maxPasses?: number;
+}
+export interface TestVisualIdleOptions {
+    quietFrames?: number;
+    maxFrames?: number;
+}
+export interface TestWaitForOptions {
+    maxPasses?: number;
+}
+export interface TestExternalOutputCommit {
+    text: string;
+    rows: string[];
+    width: number;
+    height: number;
+    rowColumns: number;
+    startOnNewLine: boolean;
+    trailingNewline: boolean;
+}
+export interface TestExternalOutput {
+    take(): TestExternalOutputCommit[];
+    takeText(): string;
+    clear(): void;
+}
+export interface TestRendererSetup {
     renderer: TestRenderer;
     mockInput: MockInput;
     mockMouse: MockMouse;
     renderOnce: () => Promise<void>;
+    flush: (options?: TestFlushOptions) => Promise<void>;
+    waitFor: (predicate: () => boolean | Promise<boolean>, options?: TestWaitForOptions) => Promise<void>;
+    waitForFrame: (predicate: (frame: string) => boolean | Promise<boolean>, options?: TestWaitForOptions) => Promise<string>;
+    waitForVisualIdle: (options?: TestVisualIdleOptions) => Promise<void>;
+    externalOutput: TestExternalOutput;
+    getNativeStats: () => NativeRenderStats;
     captureCharFrame: () => string;
     captureSpans: () => CapturedFrame;
     resize: (width: number, height: number) => void;
-}>;
+}
+export declare function createTestRenderer(options: TestRendererOptions): Promise<TestRendererSetup>;

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.d.ts

@@ -4,4 +4,5 @@ export * from "./testing/mock-mouse.js";
 export * from "./testing/mock-tree-sitter-client.js";
 export * from "./testing/terminal-capabilities.js";
 export * from "./testing/spy.js";
+export { ManualClock } from "./testing/manual-clock.js";
 export { TestRecorder, type RecordedFrame } from "./testing/test-recorder.js";