@jitl/opentui-core 0.1.97 → 0.2.15

package/renderer.d.ts

@@ -1,9 +1,9 @@
 import { Renderable, RootRenderable } from "./Renderable.js";
-import { DebugOverlayCorner, type CursorStyleOptions, type MousePointerStyle, type RenderContext, type ThemeMode, type WidthMethod } from "./types.js";
+import { DebugOverlayCorner, type CursorStyleOptions, type MousePointerStyle, type RenderContext, type TerminalCapabilities, type ThemeMode, type WidthMethod } from "./types.js";
 import { RGBA, type ColorInput } from "./lib/RGBA.js";
-import type { Pointer } from "./compat/ffi.js";
+import type { Pointer } from "./platform/ffi.js";
 import { OptimizedBuffer } from "./buffer.js";
-import { type RenderLib } from "./zig.js";
+import { type NativeRenderStats, type RenderLib } 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";
@@ -20,6 +20,7 @@ export interface CliRendererConfig {
     testing?: boolean;
     exitOnCtrlC?: boolean;
     exitSignals?: NodeJS.Signals[];
+    clearOnShutdown?: boolean;
     forwardEnvKeys?: string[];
     debounceDelay?: number;
     targetFps?: number;
@@ -47,11 +48,68 @@ 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;
+    tailColumn: number;
+    renderContext: RenderContext;
+}
+export interface ScrollbackSnapshot {
+    root: Renderable;
+    width?: number;
+    height?: number;
+    rowColumns?: number;
+    startOnNewLine?: boolean;
+    trailingNewline?: boolean;
+    teardown?: () => void;
+}
+export type ScrollbackWriter = (ctx: ScrollbackRenderContext) => ScrollbackSnapshot;
+export interface ScrollbackSurfaceOptions {
+    startOnNewLine?: boolean;
+}
+export interface ScrollbackSurfaceCommitOptions {
+    rowColumns?: number;
+    trailingNewline?: boolean;
+}
+export interface ScrollbackSurface {
+    readonly renderContext: RenderContext;
+    readonly root: Renderable;
+    readonly width: number;
+    readonly height: number;
+    readonly isDestroyed: boolean;
+    render(): void;
+    settle(timeoutMs?: number): Promise<void>;
+    commitRows(startRow: number, endRowExclusive: number, options?: ScrollbackSurfaceCommitOptions): void;
+    destroy(): void;
+}
 /**
  * Kitty Keyboard Protocol configuration options
  * See: https://sw.kovidgoyal.net/kitty/keyboard-protocol/#progressive-enhancement
@@ -110,10 +168,14 @@ export declare enum MouseButton {
 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",
     FOCUSED_EDITOR = "focused_editor",
     THEME_MODE = "theme_mode",
+    PALETTE = "palette",
     CAPABILITIES = "capabilities",
     SELECTION = "selection",
     DEBUG_OVERLAY_TOGGLE = "debugOverlay:toggle",
@@ -166,6 +228,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private renderTimeout;
     private lastTime;
     private frameCount;
+    private _frameId;
     private lastFpsTime;
     private currentFps;
     private targetFrameTime;
@@ -189,6 +252,9 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private animationRequest;
     private resizeTimeoutId;
     private capabilityTimeoutId;
+    private xtVersionWaiters;
+    private splitStartupSeedTimeoutId;
+    private pendingSplitStartupCursorSeed;
     private resizeDebounceDelay;
     private enableMouseMovement;
     private _useMouse;
@@ -196,8 +262,11 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private _screenMode;
     private _footerHeight;
     private _externalOutputMode;
+    private clearOnShutdown;
     private _suspendedMouseEnabled;
     private _previousControlState;
+    private pendingSuspendedTerminalSetup;
+    private suspendedNonAltSurfacePreserved;
     private capturedRenderable?;
     private lastOverRenderableNum;
     private lastOverRenderable?;
@@ -206,11 +275,16 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private clipboard;
     private _splitHeight;
     private renderOffset;
+    private splitTailColumn;
+    private pendingSplitFooterTransition;
+    private forceFullRepaintRequested;
+    private readonly maxSplitCommitsPerFrame;
     private _terminalWidth;
     private _terminalHeight;
     private _terminalIsSetup;
+    private externalOutputQueue;
+    private pendingExternalOutputMode;
     private realStdoutWrite;
-    private captureCallback;
     private _useConsole;
     private sigwinchHandler;
     private _capabilities;
@@ -222,14 +296,20 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private lifecyclePasses;
     private _openConsoleOnError;
     private _paletteDetector;
-    private _cachedPalette;
+    private _paletteCache;
     private _paletteDetectionPromise;
+    private _paletteDetectionSize;
+    private _paletteEpoch;
+    private _nativePaletteSignature;
+    private _emittedPaletteSignature;
+    private _palettePublishGeneration;
     private _onDestroy?;
-    private _themeMode;
+    private themeModeState;
     private _terminalFocusState;
     private sequenceHandlers;
     private prependedInputHandlers;
     private shouldRestoreModesOnNextFocus;
+    private themeModeHandler;
     private idleResolvers;
     private _debugInputs;
     private _debugModeEnabled;
@@ -250,12 +330,14 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private normalizeClockTime;
     private getElapsedMs;
     focusRenderable(renderable: Renderable): void;
+    blurRenderable(renderable: Renderable): void;
     private setCapturedRenderable;
     addToHitGrid(x: number, y: number, width: number, height: number, id: number): void;
     pushHitGridScissorRect(x: number, y: number, width: number, height: number): void;
     popHitGridScissorRect(): void;
     clearHitGridScissorRects(): void;
     get widthMethod(): WidthMethod;
+    get frameId(): number;
     private writeOut;
     requestRender(): void;
     private activateFrame;
@@ -265,6 +347,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;
@@ -284,17 +367,52 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     set footerHeight(footerHeight: number);
     get externalOutputMode(): ExternalOutputMode;
     set externalOutputMode(mode: ExternalOutputMode);
+    private applyExternalOutputMode;
+    private afterExternalOutputModeChanged;
+    private applyPendingExternalOutputModeIfReady;
+    private flushPendingSplitOutputBeforeLeavingSplitFooter;
     get liveRequestCount(): number;
     get currentControlState(): string;
-    get capabilities(): any | null;
+    get capabilities(): TerminalCapabilities | null;
+    triggerNotification(message: string, title?: string): boolean;
     get themeMode(): ThemeMode | null;
+    waitForThemeMode(timeoutMs?: number): Promise<ThemeMode | null>;
     getDebugInputs(): Array<{
         timestamp: string;
         sequence: string;
     }>;
     get useKittyKeyboard(): boolean;
     set useKittyKeyboard(use: boolean);
+    createScrollbackSurface(options?: ScrollbackSurfaceOptions): ScrollbackSurface;
+    writeToScrollback(write: ScrollbackWriter): void;
+    private getSnapshotWidth;
+    private getSnapshotHeight;
+    private getSnapshotRowWidths;
+    private advanceSplitTailColumn;
+    private getSplitTailColumnAfterCommit;
+    private recordSplitCommit;
+    private getPendingSplitTailColumn;
+    private enqueueRenderedScrollbackCommit;
+    private enqueueSplitCommit;
+    private createStdoutSnapshotCommit;
+    private splitStdoutRows;
+    private createStdoutSnapshotCommits;
+    private flushPendingSplitCommits;
     private interceptStdoutWrite;
+    private getSplitPinnedRenderOffset;
+    private getSplitCursorSeedRows;
+    private isSplitCursorSeedFrameBlocked;
+    private canFlushSplitOutputBeforeTransition;
+    private clearSplitStartupCursorSeed;
+    private abortSplitStartupCursorSeed;
+    private flushPendingSplitOutputBeforeTransition;
+    private resetSplitScrollback;
+    private syncSplitScrollback;
+    private getSplitOutputOffset;
+    private clearPendingSplitFooterTransition;
+    private setPendingSplitFooterTransition;
+    private syncSplitFooterState;
+    private clearStaleSplitSurfaceRows;
     private applyScreenMode;
     private flushStdoutCache;
     private enableMouse;
@@ -309,9 +427,9 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     removeInputHandler(handler: (sequence: string) => boolean): void;
     private updateStdinParserProtocolContext;
     subscribeOsc(handler: (sequence: string) => void): () => void;
+    private processCapabilitySequence;
     private capabilityHandler;
     private focusHandler;
-    private themeModeHandler;
     private dispatchSequenceHandlers;
     private drainStdinParser;
     private handleStdinEvent;
@@ -341,6 +459,12 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
         corner?: DebugOverlayCorner;
     }): void;
     setTerminalTitle(title: string): void;
+    /**
+     * Reset the terminal background color to its default via OSC 111.
+     * Called automatically by destroy() and suspend(), but exposed for
+     * consumers that need explicit control (e.g. before SIGTSTP).
+     */
+    resetTerminalBgColor(): void;
     copyToClipboardOSC52(text: string, target?: ClipboardTarget): boolean;
     clearClipboardOSC52(target?: ClipboardTarget): boolean;
     isOsc52Supported(): boolean;
@@ -380,14 +504,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;
@@ -408,6 +526,14 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     private notifySelectablesOfSelectionChange;
     private walkSelectableRenderables;
     get paletteDetectionStatus(): "idle" | "detecting" | "cached";
+    private getCachedPaletteBySize;
+    private ensurePaletteDetector;
+    private syncNativePaletteState;
+    private emitPaletteChange;
+    private resolveXtVersionWaiters;
+    private waitForXtVersion;
+    private shouldSyncNativePaletteState;
+    private refreshPalette;
     clearPaletteCache(): void;
     /**
      * Detects the terminal's color palette

package/runtime-plugin-support-configure.d.ts

@@ -0,0 +1,4 @@
+import { type CreateRuntimePluginOptions } from "./runtime-plugin.js";
+export declare function ensureRuntimePluginSupport(options?: CreateRuntimePluginOptions): boolean;
+export { createRuntimePlugin, runtimeModuleIdForSpecifier } from "./runtime-plugin.js";
+export type { CreateRuntimePluginOptions, RuntimeModuleEntry, RuntimeModuleExports, RuntimeModuleLoader, } from "./runtime-plugin.js";

package/runtime-plugin-support-configure.js

@@ -0,0 +1,20 @@
+// @bun
+import {
+  ensureRuntimePluginSupport
+} from "./index-axv7cw60.js";
+import {
+  createRuntimePlugin,
+  runtimeModuleIdForSpecifier
+} from "./index-xwsdfq5x.js";
+import"./index-46f5e8m6.js";
+import"./index-g9agybj3.js";
+import"./index-5zwezmgj.js";
+import"./index-k18nf2r7.js";
+export {
+  runtimeModuleIdForSpecifier,
+  ensureRuntimePluginSupport,
+  createRuntimePlugin
+};
+
+//# debugId=E348EA16E39652E864756E2164756E21
+//# sourceMappingURL=runtime-plugin-support-configure.js.map

package/{index-re3ntm60.js.map → runtime-plugin-support-configure.js.map}

@@ -4,6 +4,6 @@
   "sourcesContent": [
   ],
   "mappings": "",
-  "debugId": "C109D81D6D8E609F64756E2164756E21",
+  "debugId": "E348EA16E39652E864756E2164756E21",
   "names": []
 }

package/runtime-plugin-support.d.ts

@@ -1,3 +1,3 @@
-import { createRuntimePlugin, runtimeModuleIdForSpecifier, type CreateRuntimePluginOptions, type RuntimeModuleEntry, type RuntimeModuleExports, type RuntimeModuleLoader } from "./runtime-plugin.js";
-export declare function ensureRuntimePluginSupport(options?: CreateRuntimePluginOptions): boolean;
-export { createRuntimePlugin, runtimeModuleIdForSpecifier, type CreateRuntimePluginOptions, type RuntimeModuleEntry, type RuntimeModuleExports, type RuntimeModuleLoader, };
+import { ensureRuntimePluginSupport } from "./runtime-plugin-support-configure.js";
+export { ensureRuntimePluginSupport };
+export { createRuntimePlugin, runtimeModuleIdForSpecifier, type CreateRuntimePluginOptions, type RuntimeModuleEntry, type RuntimeModuleExports, type RuntimeModuleLoader, } from "./runtime-plugin-support-configure.js";

package/runtime-plugin-support.js

@@ -1,25 +1,16 @@
 // @bun
+import {
+  ensureRuntimePluginSupport
+} from "./index-axv7cw60.js";
 import {
   createRuntimePlugin,
   runtimeModuleIdForSpecifier
-} from "./index-kcpn1hka.js";
-import"./index-yxe6e14n.js";
-import"./index-rhfjv9c1.js";
-import"./index-cbvybypy.js";
-import"./index-re3ntm60.js";
-
+} from "./index-xwsdfq5x.js";
+import"./index-46f5e8m6.js";
+import"./index-g9agybj3.js";
+import"./index-5zwezmgj.js";
+import"./index-k18nf2r7.js";
 // src/runtime-plugin-support.ts
-var {plugin: registerBunPlugin } = globalThis.Bun;
-var runtimePluginSupportInstalledKey = "__opentuiCoreRuntimePluginSupportInstalled__";
-function ensureRuntimePluginSupport(options = {}) {
-  const state = globalThis;
-  if (state[runtimePluginSupportInstalledKey]) {
-    return false;
-  }
-  registerBunPlugin(createRuntimePlugin(options));
-  state[runtimePluginSupportInstalledKey] = true;
-  return true;
-}
 ensureRuntimePluginSupport();
 export {
   runtimeModuleIdForSpecifier,
@@ -27,5 +18,5 @@ export {
   createRuntimePlugin
 };
 
-//# debugId=4FFB83ECD35A04F464756E2164756E21
+//# debugId=6357946CF311E08864756E2164756E21
 //# sourceMappingURL=runtime-plugin-support.js.map

package/runtime-plugin-support.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["../src/runtime-plugin-support.ts"],
   "sourcesContent": [
-    "import { plugin as registerBunPlugin } from \"bun\"\nimport {\n  createRuntimePlugin,\n  runtimeModuleIdForSpecifier,\n  type CreateRuntimePluginOptions,\n  type RuntimeModuleEntry,\n  type RuntimeModuleExports,\n  type RuntimeModuleLoader,\n} from \"./runtime-plugin.js\"\n\nconst runtimePluginSupportInstalledKey = \"__opentuiCoreRuntimePluginSupportInstalled__\"\n\ntype RuntimePluginSupportState = typeof globalThis & {\n  [runtimePluginSupportInstalledKey]?: boolean\n}\n\nexport function ensureRuntimePluginSupport(options: CreateRuntimePluginOptions = {}): boolean {\n  const state = globalThis as RuntimePluginSupportState\n\n  if (state[runtimePluginSupportInstalledKey]) {\n    return false\n  }\n\n  registerBunPlugin(createRuntimePlugin(options))\n\n  state[runtimePluginSupportInstalledKey] = true\n  return true\n}\n\nensureRuntimePluginSupport()\n\nexport {\n  createRuntimePlugin,\n  runtimeModuleIdForSpecifier,\n  type CreateRuntimePluginOptions,\n  type RuntimeModuleEntry,\n  type RuntimeModuleExports,\n  type RuntimeModuleLoader,\n}\n"
+    "import { ensureRuntimePluginSupport } from \"./runtime-plugin-support-configure.js\"\n\nexport { ensureRuntimePluginSupport }\nexport {\n  createRuntimePlugin,\n  runtimeModuleIdForSpecifier,\n  type CreateRuntimePluginOptions,\n  type RuntimeModuleEntry,\n  type RuntimeModuleExports,\n  type RuntimeModuleLoader,\n} from \"./runtime-plugin-support-configure.js\"\n\nensureRuntimePluginSupport()\n"
   ],
-  "mappings": ";;;;;;;;;;;AAAA;AAUA,IAAM,mCAAmC;AAMlC,SAAS,0BAA0B,CAAC,UAAsC,CAAC,GAAY;AAAA,EAC5F,MAAM,QAAQ;AAAA,EAEd,IAAI,MAAM,mCAAmC;AAAA,IAC3C,OAAO;AAAA,EACT;AAAA,EAEA,kBAAkB,oBAAoB,OAAO,CAAC;AAAA,EAE9C,MAAM,oCAAoC;AAAA,EAC1C,OAAO;AAAA;AAGT,2BAA2B;",
-  "debugId": "4FFB83ECD35A04F464756E2164756E21",
+  "mappings": ";;;;;;;;;;;;;AAYA,2BAA2B;",
+  "debugId": "6357946CF311E08864756E2164756E21",
   "names": []
 }

package/runtime-plugin.d.ts

@@ -1,3 +1,4 @@
+import { type BunPlugin } from "bun";
 export type RuntimeModuleExports = Record<string, unknown>;
 export type RuntimeModuleLoader = () => RuntimeModuleExports | Promise<RuntimeModuleExports>;
 export type RuntimeModuleEntry = RuntimeModuleExports | RuntimeModuleLoader;
@@ -10,10 +11,6 @@ export interface CreateRuntimePluginOptions {
     additional?: Record<string, RuntimeModuleEntry>;
     rewrite?: RuntimePluginRewriteOptions;
 }
-export interface BunPlugin {
-    name: string;
-    setup(build: any): void | Promise<void>;
-}
 export declare const isCoreRuntimeModuleSpecifier: (specifier: string) => boolean;
 export declare const runtimeModuleIdForSpecifier: (specifier: string) => string;
 export declare function createRuntimePlugin(input?: CreateRuntimePluginOptions): BunPlugin;

package/runtime-plugin.js

@@ -3,11 +3,11 @@ import {
   createRuntimePlugin,
   isCoreRuntimeModuleSpecifier,
   runtimeModuleIdForSpecifier
-} from "./index-kcpn1hka.js";
-import"./index-yxe6e14n.js";
-import"./index-rhfjv9c1.js";
-import"./index-cbvybypy.js";
-import"./index-re3ntm60.js";
+} from "./index-xwsdfq5x.js";
+import"./index-46f5e8m6.js";
+import"./index-g9agybj3.js";
+import"./index-5zwezmgj.js";
+import"./index-k18nf2r7.js";
 export {
   runtimeModuleIdForSpecifier,
   isCoreRuntimeModuleSpecifier,

package/syntax-style.d.ts

@@ -1,6 +1,6 @@
 import { RGBA, type ColorInput } from "./lib/RGBA.js";
 import { type RenderLib } from "./zig.js";
-import { type Pointer } from "./compat/ffi.js";
+import { type Pointer } from "./platform/ffi.js";
 export interface StyleDefinition {
     fg?: RGBA;
     bg?: RGBA;
@@ -9,6 +9,14 @@ export interface StyleDefinition {
     underline?: boolean;
     dim?: boolean;
 }
+export interface StyleDefinitionInput {
+    fg?: ColorInput;
+    bg?: ColorInput;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    dim?: boolean;
+}
 export interface MergedStyle {
     fg?: RGBA;
     bg?: RGBA;
@@ -36,9 +44,9 @@ export declare class SyntaxStyle {
     constructor(lib: RenderLib, ptr: Pointer);
     static create(): SyntaxStyle;
     static fromTheme(theme: ThemeTokenStyle[]): SyntaxStyle;
-    static fromStyles(styles: Record<string, StyleDefinition>): SyntaxStyle;
+    static fromStyles(styles: Record<string, StyleDefinitionInput>): SyntaxStyle;
     private guard;
-    registerStyle(name: string, style: StyleDefinition): number;
+    registerStyle(name: string, style: StyleDefinitionInput): number;
     resolveStyleId(name: string): number | null;
     getStyleId(name: string): number | null;
     get ptr(): Pointer;

package/testing/terminal-capabilities.d.ts

@@ -0,0 +1,7 @@
+import type { CliRenderer } from "../renderer.js";
+import type { TerminalCapabilities, TerminalInfo } from "../types.js";
+export interface TerminalCapabilitiesOverrides extends Partial<Omit<TerminalCapabilities, "terminal">> {
+    terminal?: Partial<TerminalInfo>;
+}
+export declare function createTerminalCapabilities(overrides?: TerminalCapabilitiesOverrides): TerminalCapabilities;
+export declare function setRendererCapabilities(renderer: CliRenderer, overrides?: TerminalCapabilitiesOverrides): TerminalCapabilities;

package/testing/test-recorder.d.ts

@@ -5,8 +5,8 @@ export interface RecordBuffersOptions {
     attributes?: boolean;
 }
 export interface RecordedBuffers {
-    fg?: Float32Array;
-    bg?: Float32Array;
+    fg?: Uint16Array;
+    bg?: Uint16Array;
     attributes?: Uint8Array;
 }
 export interface RecordedFrame {
@@ -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";
@@ -12,12 +13,43 @@ export interface TestRenderer extends 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.d.ts

@@ -2,5 +2,7 @@ export * from "./testing/test-renderer.js";
 export * from "./testing/mock-keys.js";
 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";