@opentui/core 0.5.17 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/NativeScene.d.ts +185 -0
  2. package/NativeSession.d.ts +134 -0
  3. package/NativeSpanFeed.d.ts +1 -4
  4. package/README.md +5 -3
  5. package/Renderable.d.ts +162 -67
  6. package/animation/Timeline.d.ts +11 -1
  7. package/assets/typescriptreact/highlights.scm +758 -0
  8. package/assets/typescriptreact/tree-sitter-tsx.wasm +0 -0
  9. package/buffer.d.ts +76 -36
  10. package/chunk-bun-s01c2jyn.js +24914 -0
  11. package/chunk-bun-s01c2jyn.js.map +69 -0
  12. package/chunk-bun-tsc14mt5.js +12515 -0
  13. package/chunk-bun-tsc14mt5.js.map +35 -0
  14. package/chunk-node-df90qrqc.js +12495 -0
  15. package/chunk-node-df90qrqc.js.map +34 -0
  16. package/chunk-node-hjr2tm60.js +24913 -0
  17. package/chunk-node-hjr2tm60.js.map +69 -0
  18. package/edit-buffer.d.ts +18 -20
  19. package/editor-view.d.ts +13 -5
  20. package/image.d.ts +18 -7
  21. package/index.bun.js +2387 -2899
  22. package/index.bun.js.map +20 -22
  23. package/index.d.ts +6 -2
  24. package/index.node.js +2387 -2899
  25. package/index.node.js.map +20 -24
  26. package/lib/buffer-access.d.ts +6 -0
  27. package/lib/clipboard.d.ts +0 -9
  28. package/lib/extmarks.d.ts +4 -1
  29. package/lib/tree-sitter/parsers-config.d.ts +9 -9
  30. package/native-abi.generated.d.ts +5496 -0
  31. package/node-assets.js +6 -2
  32. package/node-assets.js.map +3 -3
  33. package/package.json +10 -10
  34. package/parser.worker.js +14 -2
  35. package/parser.worker.js.map +3 -3
  36. package/renderables/ASCIIFont.d.ts +5 -5
  37. package/renderables/Box.d.ts +8 -8
  38. package/renderables/Code.d.ts +6 -2
  39. package/renderables/Diff.d.ts +4 -2
  40. package/renderables/EditBufferRenderable.d.ts +8 -10
  41. package/renderables/EmbeddedTerminal.d.ts +4 -2
  42. package/renderables/FrameBuffer.d.ts +3 -1
  43. package/renderables/Image.d.ts +3 -1
  44. package/renderables/Input.d.ts +0 -5
  45. package/renderables/LineNumberRenderable.d.ts +3 -1
  46. package/renderables/Markdown.d.ts +5 -2
  47. package/renderables/ScrollBar.d.ts +7 -1
  48. package/renderables/ScrollBox.d.ts +4 -6
  49. package/renderables/Select.d.ts +2 -1
  50. package/renderables/Slider.d.ts +7 -5
  51. package/renderables/TabSelect.d.ts +2 -1
  52. package/renderables/Text.d.ts +5 -4
  53. package/renderables/TextBufferRenderable.d.ts +10 -9
  54. package/renderables/TextNode.d.ts +8 -0
  55. package/renderables/TextTable.d.ts +1 -1
  56. package/renderables/Textarea.d.ts +1 -1
  57. package/renderables/index.d.ts +1 -1
  58. package/renderer.d.ts +90 -67
  59. package/session-buffer.d.ts +4 -0
  60. package/syntax-style.d.ts +9 -7
  61. package/testing/harness.d.ts +33 -0
  62. package/testing/manual-clock.d.ts +2 -0
  63. package/testing/test-renderer.d.ts +3 -0
  64. package/testing/test-streams.d.ts +20 -2
  65. package/testing.bun.js +60 -49
  66. package/testing.bun.js.map +6 -6
  67. package/testing.js +60 -49
  68. package/testing.js.map +6 -6
  69. package/tests/native-log-worker-child.d.ts +1 -0
  70. package/tests/native-symbol-stubs.d.ts +5 -0
  71. package/tests/yoga-callback-boundary-child.d.ts +1 -0
  72. package/tests/yoga-default-config-worker-child.d.ts +1 -0
  73. package/text-buffer-view.d.ts +11 -4
  74. package/text-buffer.d.ts +24 -9
  75. package/types.d.ts +4 -4
  76. package/yoga.bun.js +6 -2
  77. package/yoga.bun.js.map +1 -1
  78. package/yoga.d.ts +91 -56
  79. package/yoga.internal.d.ts +78 -0
  80. package/yoga.js +6 -2
  81. package/yoga.js.map +1 -1
  82. package/zig-structs.d.ts +13 -98
  83. package/zig.d.ts +1304 -583
  84. package/chunk-bun-6rvkxs1v.js +0 -18862
  85. package/chunk-bun-6rvkxs1v.js.map +0 -64
  86. package/chunk-bun-h3ggawd9.js +0 -10533
  87. package/chunk-bun-h3ggawd9.js.map +0 -32
  88. package/chunk-node-kc1sqq2a.js +0 -10532
  89. package/chunk-node-kc1sqq2a.js.map +0 -32
  90. package/chunk-node-tfvyz31s.js +0 -18844
  91. package/chunk-node-tfvyz31s.js.map +0 -63
@@ -107,9 +107,9 @@ export declare class TextTableRenderable extends Renderable {
107
107
  protected destroySelf(): void;
108
108
  private setupMeasureFunc;
109
109
  private rebuildCells;
110
- private updateCellsDiff;
111
110
  private createCell;
112
111
  private toStyledText;
112
+ private destroyCell;
113
113
  private destroyCells;
114
114
  private rebuildLayoutForCurrentWidth;
115
115
  private computeLayout;
@@ -3,7 +3,7 @@ import { RGBA, type ColorInput } from "../lib/RGBA.js";
3
3
  import { type RenderContext } from "../types.js";
4
4
  import { EditBufferRenderable, type EditBufferOptions } from "./EditBufferRenderable.js";
5
5
  import { type KeyBinding as BaseKeyBinding } from "../lib/keybinding.internal.js";
6
- import { type StyledText } from "../lib/styled-text.js";
6
+ import { StyledText } from "../lib/styled-text.js";
7
7
  import type { ExtmarksController } from "../lib/extmarks.js";
8
8
  export type TextareaAction = "move-left" | "move-right" | "move-up" | "move-down" | "select-left" | "select-right" | "select-up" | "select-down" | "line-home" | "line-end" | "select-line-home" | "select-line-end" | "visual-line-home" | "visual-line-end" | "select-visual-line-home" | "select-visual-line-end" | "buffer-home" | "buffer-end" | "select-buffer-home" | "select-buffer-end" | "delete-line" | "delete-to-line-end" | "delete-to-line-start" | "backspace" | "delete" | "newline" | "undo" | "redo" | "word-forward" | "word-backward" | "select-word-forward" | "select-word-backward" | "delete-word-forward" | "delete-word-backward" | "select-all" | "submit";
9
9
  export type KeyBinding = BaseKeyBinding<TextareaAction>;
@@ -13,7 +13,7 @@ export * from "./Image.js";
13
13
  export * from "./LineNumberRenderable.js";
14
14
  export * from "./Markdown.js";
15
15
  export * from "./ScrollBar.js";
16
- export * from "./ScrollBox.js";
16
+ export { ScrollBoxRenderable, type ScrollBoxOptions } from "./ScrollBox.js";
17
17
  export * from "./Select.js";
18
18
  export * from "./Slider.js";
19
19
  export * from "./TextTable.js";
package/renderer.d.ts CHANGED
@@ -2,11 +2,13 @@ import { Renderable, RootRenderable } from "./Renderable.js";
2
2
  import { DebugOverlayCorner, type CursorStyleOptions, type MousePointerStyle, type RenderContext, type TerminalCapabilities, type ThemeMode, type SelectionBehavior, type WidthMethod } from "./types.js";
3
3
  import { RGBA, type ColorInput } from "./lib/RGBA.js";
4
4
  import { OptimizedBuffer } from "./buffer.js";
5
- import { type NativeBufferedOutput, type NativeRenderStats, type RendererHandle } from "./zig.js";
5
+ import { type NativeBufferedOutput, type NativeRenderStats } from "./zig.js";
6
+ import { NativeSession } from "./NativeSession.js";
7
+ import { NativeScene } from "./NativeScene.js";
6
8
  import { TerminalConsole, type ConsoleOptions } from "./console.js";
7
9
  import { type MouseEventType, type RawMouseEvent, type ScrollInfo } from "./lib/parse.mouse.js";
8
10
  import { Selection } from "./lib/selection.js";
9
- import { type ClipboardTarget } from "./lib/clipboard.js";
11
+ import { ClipboardTarget } from "./lib/clipboard.js";
10
12
  import { EventEmitter } from "events";
11
13
  import { KeyHandler, InternalKeyHandler } from "./lib/KeyHandler.js";
12
14
  import { type EditBufferRenderable } from "./renderables/EditBufferRenderable.js";
@@ -22,6 +24,10 @@ export interface KittyImageTransportStatus {
22
24
  pendingBytes: number;
23
25
  }
24
26
  export interface CliRendererConfig {
27
+ /** Transfer this driver's ownership after attachment succeeds. Requires the same stdout. */
28
+ nativeSession?: NativeSession;
29
+ /** Opt-in native preparation/feedback items per turn. Yoga, painting, and encoding remain synchronous. */
30
+ nativeSceneWorkBudget?: number;
25
31
  stdin?: NodeJS.ReadStream;
26
32
  stdout?: NodeJS.WriteStream;
27
33
  width?: number;
@@ -33,11 +39,11 @@ export interface CliRendererConfig {
33
39
  exitSignals?: NodeJS.Signals[];
34
40
  clearOnShutdown?: boolean;
35
41
  forwardEnvKeys?: string[];
42
+ environment?: Readonly<Record<string, string>>;
36
43
  debounceDelay?: number;
37
44
  targetFps?: number;
38
45
  maxFps?: number;
39
46
  memorySnapshotInterval?: number;
40
- useThread?: boolean;
41
47
  gatherStats?: boolean;
42
48
  maxStatSamples?: number;
43
49
  consoleOptions?: Omit<ConsoleOptions, "clock">;
@@ -223,7 +229,25 @@ export declare enum RendererControlState {
223
229
  export declare class CliRenderer extends EventEmitter implements RenderContext {
224
230
  private static animationFrameId;
225
231
  private lib;
226
- rendererPtr: RendererHandle;
232
+ readonly nativeScene: NativeScene;
233
+ private readonly nativeSession;
234
+ private readonly nativeDestroyWait?;
235
+ private readonly nativeClosed;
236
+ private nativeTerminalTransition;
237
+ private pendingNativeResize;
238
+ private pendingNativeMode;
239
+ private nativeSplitAcceptedCount;
240
+ private nativeSplitFlush;
241
+ private pendingNativeReplay;
242
+ private readonly detachedSurfaces;
243
+ private nativeResizeWait;
244
+ private nativeKittyKeyboardFlags;
245
+ private kittyTransportMode;
246
+ private kittyTransportTimer;
247
+ private _lastSceneTimeMs;
248
+ get lastSceneTimeMs(): number;
249
+ /** Await after destroy() before closing stdout or calling process.exit(). */
250
+ get closed(): Promise<void>;
227
251
  stdin: NodeJS.ReadStream;
228
252
  private stdout;
229
253
  private exitOnCtrlC;
@@ -234,6 +258,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
234
258
  private _destroyFinalized;
235
259
  private _destroyCleanupPrepared;
236
260
  private _streamLeaseAcquired;
261
+ private flushTerminalInputOnClose;
237
262
  nextRenderBuffer: OptimizedBuffer;
238
263
  currentRenderBuffer: OptimizedBuffer;
239
264
  private _isRunning;
@@ -246,7 +271,6 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
246
271
  readonly root: RootRenderable;
247
272
  width: number;
248
273
  height: number;
249
- private _useThread;
250
274
  private gatherStats;
251
275
  private frameTimes;
252
276
  private maxStatSamples;
@@ -254,9 +278,9 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
254
278
  private backgroundColor;
255
279
  private waitingForPixelResolution;
256
280
  private pixelResolutionRequeryPending;
257
- private readonly clock;
281
+ readonly clock: Clock;
258
282
  private rendering;
259
- private renderingNative;
283
+ private renderingCompletion;
260
284
  private renderTimeout;
261
285
  private lastTime;
262
286
  private frameCount;
@@ -266,8 +290,6 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
266
290
  private targetFrameTime;
267
291
  private minTargetFrameTime;
268
292
  private immediateRerenderRequested;
269
- private updateScheduled;
270
- private updateGeneration;
271
293
  private liveRequestCounter;
272
294
  private _controlState;
273
295
  private frameCallbacks;
@@ -283,11 +305,11 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
283
305
  private readonly oscSubscribers;
284
306
  private hasLoggedStdinParserError;
285
307
  private animationRequest;
308
+ private cancelFrameContinuation;
309
+ private cancelReadyFrame;
286
310
  private resizeTimeoutId;
287
311
  private pendingResizeSawDifferentSize;
288
312
  private capabilityTimeoutId;
289
- private kittyTransportTimer;
290
- private kittyTransportMode;
291
313
  private terminalKeepAliveTimer;
292
314
  private xtVersionWaiters;
293
315
  private splitStartupSeedTimeoutId;
@@ -302,18 +324,16 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
302
324
  private clearOnShutdown;
303
325
  private _suspendedMouseEnabled;
304
326
  private _previousControlState;
305
- private pendingSuspendedTerminalSetup;
306
- private suspendedNonAltSurfacePreserved;
307
327
  private capturedRenderable?;
308
328
  private lastOverRenderableNum;
309
329
  private lastOverRenderable?;
310
330
  private currentSelection;
311
331
  private selectionContainers;
312
332
  private lastClick;
313
- private clipboard;
314
333
  private _splitHeight;
315
334
  private renderOffset;
316
335
  private splitTailColumn;
336
+ private queuedSplitTail;
317
337
  private pendingSplitFooterTransition;
318
338
  private forceFullRepaintRequested;
319
339
  private readonly maxSplitCommitsPerFrame;
@@ -331,12 +351,14 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
331
351
  private _lastPointerModifiers;
332
352
  private _currentMousePointerStyle;
333
353
  private _currentFocusedRenderable;
334
- private lifecyclePasses;
354
+ private focusChange?;
335
355
  private _openConsoleOnError;
336
356
  private _paletteDetector;
337
357
  private _paletteCache;
338
358
  private _paletteDetectionPromise;
359
+ private _cancelPaletteDetection;
339
360
  private _paletteDetectionSize;
361
+ private _paletteDetectionGeneration;
340
362
  private _paletteEpoch;
341
363
  private _nativePaletteSignature;
342
364
  private _emittedPaletteSignature;
@@ -355,43 +377,39 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
355
377
  private handleError;
356
378
  private dumpOutputCache;
357
379
  private exitHandler;
380
+ private nativeProcessExitHandler;
358
381
  private warningHandler;
359
382
  private readonly _usesProcessStdout;
360
- private _feed;
361
- private _detachFeed;
362
- private _detachFeedError;
363
- private feedIdleRenderScheduled;
364
- private feedIdleWaitPending;
383
+ private outputIdleRenderScheduled;
384
+ private ordinaryFrameWaitingForOutput;
385
+ private ordinaryFrameWaitControlState;
365
386
  get controlState(): RendererControlState;
366
387
  /**
367
388
  * Construct a renderer over the given streams.
368
389
  *
369
- * If `stdout` is not `process.stdout`, a `NativeSpanFeed` is allocated
370
- * internally and rendered bytes are piped through it to `stdout` unless
371
- * `bufferedOutput: "memory"` is set. Prefer `createCliRenderer` for the async
372
- * `setupTerminal` convenience.
390
+ * A NativeSession owns ordered output to `stdout`, or to an in-memory sink
391
+ * when `bufferedOutput: "memory"` is set. Prefer `createCliRenderer` for the
392
+ * async `setupTerminal` convenience.
373
393
  *
374
394
  * Construction side effects (observable before the constructor returns):
375
395
  * - Acquires exclusive ownership of the given stdin/stdout streams
376
- * - Allocates a `NativeSpanFeed` (for non-process stdout unless bufferedOutput is "memory")
377
- * - Calls `lib.createRenderer` → native Zig allocation
396
+ * - Attaches a NativeSession and allocates its scene
378
397
  * - Registers in the process-wide `rendererTracker`
379
398
  * - Adds `process.on(...)` listeners for SIGWINCH (process.stdout only),
380
399
  * "warning", "uncaughtException", "unhandledRejection", plus the
381
400
  * configured `exitSignals`
382
- * - Replaces `global.requestAnimationFrame` with the renderer's impl
383
401
  * - When `setupTerminal()` is called, it will put `stdin` in raw mode and
384
402
  * call `stdin.resume()`
385
403
  *
386
- * Some late constructor side effects are not rolled back if construction
387
- * throws partway; production callers should use `createCliRenderer`, which
388
- * wraps `setupTerminal()` in a try/catch that calls `destroy()` on failure.
404
+ * Construction failures release the owner. `createCliRenderer` also destroys
405
+ * the renderer if asynchronous terminal setup fails.
389
406
  */
390
407
  constructor(stdin: NodeJS.ReadStream, stdout: NodeJS.WriteStream, width: number, height: number, config?: CliRendererConfig);
391
408
  private addExitListeners;
392
409
  private startTerminalKeepAlive;
393
410
  private stopTerminalKeepAlive;
394
411
  private removeExitListeners;
412
+ private removeCleanupListener;
395
413
  get isDestroyed(): boolean;
396
414
  registerLifecyclePass(renderable: Renderable): void;
397
415
  unregisterLifecyclePass(renderable: Renderable): void;
@@ -402,25 +420,20 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
402
420
  private getElapsedMs;
403
421
  focusRenderable(renderable: Renderable): void;
404
422
  blurRenderable(renderable: Renderable): void;
423
+ private changeFocus;
405
424
  private setCapturedRenderable;
406
- addToHitGrid(x: number, y: number, width: number, height: number, id: number): void;
407
- pushHitGridScissorRect(x: number, y: number, width: number, height: number): void;
408
- popHitGridScissorRect(): void;
409
- clearHitGridScissorRects(): void;
410
425
  get widthMethod(): WidthMethod;
411
426
  get frameId(): number;
412
- private writeOut;
413
- private scheduleRenderAfterFeedIdle;
414
- private cancelRenderAfterFeedIdle;
415
- private handleNativeRenderRejection;
416
- private reportNativeRenderFailure;
427
+ private scheduleRenderAfterOutputIdle;
417
428
  private scheduleRenderTimer;
418
- private scheduleRenderAfterBackpressure;
429
+ private nextFrameDelay;
430
+ private scheduleFrame;
431
+ private clearFrameTimer;
419
432
  requestRender(): void;
420
- private activateFrame;
421
433
  get consoleMode(): ConsoleMode;
422
434
  set consoleMode(mode: ConsoleMode);
423
435
  get isRunning(): boolean;
436
+ private hasScheduledWork;
424
437
  private isIdleNow;
425
438
  private resolveIdleIfNeeded;
426
439
  idle(): Promise<void>;
@@ -431,7 +444,6 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
431
444
  get _internalKeyInput(): InternalKeyHandler;
432
445
  get terminalWidth(): number;
433
446
  get terminalHeight(): number;
434
- get useThread(): boolean;
435
447
  get targetFps(): number;
436
448
  set targetFps(targetFps: number);
437
449
  get maxFps(): number;
@@ -447,7 +459,6 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
447
459
  private applyExternalOutputMode;
448
460
  private afterExternalOutputModeChanged;
449
461
  private applyPendingExternalOutputModeIfReady;
450
- private flushPendingSplitOutputBeforeLeavingSplitFooter;
451
462
  get liveRequestCount(): number;
452
463
  get currentControlState(): string;
453
464
  get capabilities(): TerminalCapabilities | null;
@@ -456,7 +467,6 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
456
467
  private startKittyTransportPolling;
457
468
  get kittyImageTransportStatus(): KittyImageTransportStatus;
458
469
  cancelKittyImageTransport(): void;
459
- private kittyOutputErrorHandler;
460
470
  triggerNotification(message: string, title?: string): boolean;
461
471
  get themeMode(): ThemeMode | null;
462
472
  waitForThemeMode(timeoutMs?: number): Promise<ThemeMode | null>;
@@ -469,42 +479,39 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
469
479
  createScrollbackSurface(options?: ScrollbackSurfaceOptions): ScrollbackSurface;
470
480
  writeToScrollback(write: ScrollbackWriter): void;
471
481
  resetSplitFooterForReplay(options?: SplitFooterReplayResetOptions): void;
472
- private getSnapshotWidth;
473
- private getSnapshotHeight;
474
- private getSnapshotRowWidths;
482
+ private applySplitFooterReplayReset;
483
+ private getSnapshotDimension;
475
484
  private advanceSplitTailColumn;
476
485
  private getSplitTailColumnAfterCommit;
477
486
  private recordSplitCommit;
478
487
  private getPendingSplitTailColumn;
479
488
  private enqueueRenderedScrollbackCommit;
480
- private enqueueSplitCommit;
481
- private createStdoutSnapshotCommit;
489
+ private enqueueSplitCommits;
482
490
  private splitStdoutRows;
483
491
  private createStdoutSnapshotCommits;
484
- private flushPendingSplitCommits;
485
492
  private interceptStdoutWrite;
486
493
  private getSplitPinnedRenderOffset;
487
494
  private getSplitCursorSeedRows;
488
495
  private isSplitCursorSeedFrameBlocked;
489
- private canFlushSplitOutputBeforeTransition;
490
496
  private clearSplitStartupCursorSeed;
491
497
  private abortSplitStartupCursorSeed;
492
- private flushPendingSplitOutputBeforeTransition;
493
498
  private resetSplitScrollback;
494
499
  private syncSplitScrollback;
495
500
  private getSplitOutputOffset;
496
501
  private clearPendingSplitFooterTransition;
497
502
  private setPendingSplitFooterTransition;
503
+ private setRenderOffset;
498
504
  private syncSplitFooterState;
499
- private clearStaleSplitSurfaceRows;
505
+ private getStaleSplitSurfaceClear;
500
506
  private applyScreenMode;
501
- private flushStdoutCache;
507
+ private applyPendingNativeMode;
508
+ private applyPendingNativeModeReported;
502
509
  private enableMouse;
503
510
  private disableMouse;
504
511
  enableKittyKeyboard(flags?: number): void;
505
512
  disableKittyKeyboard(): void;
506
- set useThread(useThread: boolean);
507
513
  setupTerminal(): Promise<void>;
514
+ private trackNativeTerminalTransition;
508
515
  private stdinListener;
509
516
  addInputHandler(handler: (sequence: string) => boolean): void;
510
517
  prependInputHandler(handler: (sequence: string) => boolean): void;
@@ -530,14 +537,14 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
530
537
  private recheckHoverState;
531
538
  setMousePointer(style: MousePointerStyle): void;
532
539
  hitTest(x: number, y: number): number;
533
- getLinkIdAt(x: number, y: number): number;
534
- getLinkAt(x: number, y: number): string | null;
535
540
  private takeMemorySnapshot;
536
541
  private startMemorySnapshotTimer;
537
542
  private stopMemorySnapshotTimer;
538
543
  setMemorySnapshotInterval(interval: number): void;
539
- private handleResize;
540
- private applyPendingResize;
544
+ /** Queue a debounced resize intent. RESIZE is emitted only after the latest size is accepted. */
545
+ requestResize(width: number, height: number): void;
546
+ private applyPendingNativeResize;
547
+ private pixelResolutionRetry;
541
548
  private queryPixelResolution;
542
549
  private processResize;
543
550
  /**
@@ -547,8 +554,12 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
547
554
  * `window-change` signal or a test harness simulating a terminal resize.
548
555
  * When the renderer is attached to `process.stdout`, `SIGWINCH` is handled
549
556
  * automatically and callers do not need this method.
557
+ *
558
+ * While the Session presents or paints a frame, the resize waits for that frame like `requestResize`. Later calls
559
+ * join a waiting resize, so sizes apply in order and a return to the current size still repaints everything.
550
560
  */
551
561
  resize(width: number, height: number): void;
562
+ private deferResize;
552
563
  setBackgroundColor(color: ColorInput): void;
553
564
  toggleDebugOverlay(): void;
554
565
  configureDebugOverlay(options: {
@@ -566,8 +577,8 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
566
577
  clearClipboardOSC52(target?: ClipboardTarget): boolean;
567
578
  isOsc52Supported(): boolean;
568
579
  dumpHitGrid(): void;
569
- dumpBuffers(timestamp?: number): void;
570
- dumpOutputBuffer(timestamp?: number): void;
580
+ getLinkIdAt(x: number, y: number): number;
581
+ getLinkAt(x: number, y: number): string | null;
571
582
  static setCursorPosition(renderer: CliRenderer, x: number, y: number, visible?: boolean): void;
572
583
  static setCursorStyle(renderer: CliRenderer, options: CursorStyleOptions): void;
573
584
  static setCursorColor(renderer: CliRenderer, color: RGBA): void;
@@ -579,27 +590,39 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
579
590
  removePostProcessFn(processFn: (buffer: OptimizedBuffer, deltaTime: number) => void): void;
580
591
  clearPostProcessFns(): void;
581
592
  setFrameCallback(callback: (deltaTime: number) => Promise<void>): void;
593
+ hasFrameCallback(callback: (deltaTime: number) => Promise<void>): boolean;
582
594
  removeFrameCallback(callback: (deltaTime: number) => Promise<void>): void;
583
595
  clearFrameCallbacks(): void;
596
+ private get canRender();
597
+ requestAnimationFrame(callback: FrameRequestCallback): number;
598
+ cancelAnimationFrame(handle: number): void;
599
+ private yieldFrame;
600
+ private queueFrame;
584
601
  requestLive(): void;
585
602
  dropLive(): void;
586
603
  start(): void;
587
604
  auto(): void;
588
605
  private internalStart;
589
606
  pause(): void;
590
- suspend(): void;
591
- resume(): void;
592
- private internalPause;
607
+ suspend(): Promise<void>;
608
+ resume(): Promise<void>;
609
+ private finishResume;
593
610
  stop(): void;
594
- private internalStop;
611
+ private halt;
595
612
  destroy(): void;
596
613
  private cleanupBeforeDestroy;
597
- private prepareDestroyDuringRender;
598
614
  private finalizeDestroy;
615
+ private releaseStreamLease;
599
616
  private startRenderLoop;
600
617
  private loop;
618
+ private logNativeDiagnostics;
619
+ /** Waits for pending terminal transitions. False when one failed; its tracker already reported it. Callers check
620
+ * `nativeTerminalTransition` first, so a frame without a transition does not yield. */
621
+ private waitForTerminalTransition;
601
622
  intermediateRender(): void;
602
- private renderNative;
623
+ private presentNativeScene;
624
+ private completeNativeSplitCommits;
625
+ private flushNativeSplitOutput;
603
626
  private collectStatSample;
604
627
  getNativeStats(): NativeRenderStats;
605
628
  getStats(): CliRendererStats;
@@ -0,0 +1,4 @@
1
+ import type { NativeContextBufferLease, NativeContextHandle, NativeSceneFrameRequest, RenderLib, SessionBuffer, SessionHandle } from "./zig.js";
2
+ /** @internal Acquires Session storage, optionally qualified by a painted scene ticket.
3
+ * Release with contextReleaseBufferLease on every exit path, including stale validation. */
4
+ export declare function acquireSessionBufferLease(lib: RenderLib, context: NativeContextHandle, session: SessionHandle, which: SessionBuffer, frame?: NativeSceneFrameRequest | null): NativeContextBufferLease;
package/syntax-style.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { RGBA, type ColorInput } from "./lib/RGBA.js";
2
- import { type RenderLib, type SyntaxStyleHandle } from "./zig.js";
2
+ import { type RenderLib, type ContextSyntaxStyleHandle } from "./zig.js";
3
+ import type { NativeResourceOwner } from "./buffer.js";
3
4
  export interface StyleDefinition {
4
5
  fg?: RGBA;
5
6
  bg?: RGBA;
@@ -35,20 +36,21 @@ export interface ThemeTokenStyle {
35
36
  export declare function convertThemeToStyles(theme: ThemeTokenStyle[]): Record<string, StyleDefinition>;
36
37
  export declare class SyntaxStyle {
37
38
  private lib;
38
- private stylePtr;
39
+ private native;
39
40
  private _destroyed;
40
41
  private nameCache;
41
42
  private styleDefs;
42
43
  private mergedCache;
43
- constructor(lib: RenderLib, ptr: SyntaxStyleHandle);
44
- static create(): SyntaxStyle;
45
- static fromTheme(theme: ThemeTokenStyle[]): SyntaxStyle;
46
- static fromStyles(styles: Record<string, StyleDefinitionInput>): SyntaxStyle;
44
+ constructor(lib: RenderLib, handle: ContextSyntaxStyleHandle, source: NativeResourceOwner);
45
+ static create(source: NativeResourceOwner): SyntaxStyle;
46
+ static fromTheme(theme: ThemeTokenStyle[], owner: NativeResourceOwner): SyntaxStyle;
47
+ static fromStyles(styles: Record<string, StyleDefinitionInput> | Map<string, StyleDefinitionInput>, owner: NativeResourceOwner): SyntaxStyle;
47
48
  private guard;
49
+ /** @internal Attachment borrows the Context-owned style; it never allocates a copy. */
50
+ _getSceneHandle(scene: NativeResourceOwner): ContextSyntaxStyleHandle;
48
51
  registerStyle(name: string, style: StyleDefinitionInput): number;
49
52
  resolveStyleId(name: string): number | null;
50
53
  getStyleId(name: string): number | null;
51
- get ptr(): SyntaxStyleHandle;
52
54
  getStyleCount(): number;
53
55
  clearNameCache(): void;
54
56
  getStyle(name: string): StyleDefinition | undefined;
@@ -0,0 +1,33 @@
1
+ import type { CliRenderer } from "../renderer.js";
2
+ import { NativeSessionRenderStatus } from "../zig.js";
3
+ /** Runs `turns` host turns, so ready frames, Session pumps, and stream callbacks can run. */
4
+ export declare function settle(turns?: number): Promise<void>;
5
+ /** Runs host turns until `predicate` holds. Throws after `maxTurns`, so a stalled renderer fails fast. */
6
+ export declare function settleUntil(predicate: () => boolean, maxTurns?: number): Promise<void>;
7
+ /**
8
+ * Runs host turns until no frame renders, no ready frame is queued, and no output-idle retry waits. Timer-driven
9
+ * frames are not run; advance the clock first. Reads scheduler internals that `getSchedulerState()` merges.
10
+ */
11
+ export declare function serviceReadyFrames(renderer: CliRenderer, maxTurns?: number): Promise<void>;
12
+ /**
13
+ * Replaces the Session frame commit. `next()` picks the status of each commit: Presented commits normally; any other
14
+ * status consumes the frame without output, as the native Session does under pressure. Returns a restore function.
15
+ */
16
+ export declare function forceRenderStatus(renderer: CliRenderer, next: () => NativeSessionRenderStatus): () => void;
17
+ export interface HeldOutputIdle {
18
+ /** Resolves the held wait; later `idle()` calls pass through until `hold()`. */
19
+ release(): Promise<void>;
20
+ hold(): void;
21
+ /** Number of `idle()` calls since the hold started. */
22
+ calls(): number;
23
+ restore(): void;
24
+ }
25
+ /** Holds every Session `idle()` wait, so a skipped frame's output-idle retry runs only on `release()`. */
26
+ export declare function holdOutputIdle(renderer: CliRenderer): HeldOutputIdle;
27
+ /** Counts the process listeners that a renderer installs. Take it before construction. */
28
+ export declare function processListenerCounts(): Map<string, number>;
29
+ /**
30
+ * Waits for `closed` (a Session failure is allowed) and checks that the renderer released everything it acquired:
31
+ * process listeners (against `before`), its stdin listener, the stream lease, the root tree, and the Session.
32
+ */
33
+ export declare function assertRendererReleased(renderer: CliRenderer, before: Map<string, number>): Promise<void>;
@@ -5,6 +5,8 @@ export declare class ManualClock implements Clock {
5
5
  private nextOrder;
6
6
  private readonly timers;
7
7
  now(): number;
8
+ /** Scheduled timeouts and intervals that have not fired or been cleared. */
9
+ get pendingTimerCount(): number;
8
10
  setTime(time: number): void;
9
11
  setTimeout(fn: () => void, delayMs: number): TimerHandle;
10
12
  clearTimeout(handle: TimerHandle): void;
@@ -50,5 +50,8 @@ export interface TestRendererSetup {
50
50
  captureCharFrame: () => string;
51
51
  captureSpans: () => CapturedFrame;
52
52
  resize: (width: number, height: number) => void;
53
+ /** Destroys the renderer and waits for `closed`; rejects with a Session failure. */
54
+ dispose: () => Promise<void>;
55
+ [Symbol.asyncDispose]: () => Promise<void>;
53
56
  }
54
57
  export declare function createTestRenderer(options: TestRendererOptions): Promise<TestRendererSetup>;
@@ -1,12 +1,30 @@
1
- import { Writable } from "stream";
1
+ import { Writable, type WritableOptions } from "stream";
2
2
  export declare class TestWriteStream extends Writable {
3
3
  readonly isTTY = true;
4
4
  readonly columns: number;
5
5
  readonly rows: number;
6
- constructor(columns?: number, rows?: number);
6
+ constructor(columns?: number, rows?: number, options?: WritableOptions);
7
7
  _write(_chunk: any, _encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
8
8
  getColorDepth(): number;
9
9
  }
10
+ /**
11
+ * Test stdout that copies every write. `hold()` parks the next write's completion until `release()`, which models a
12
+ * slow terminal or socket: the Session keeps the frame pending and later output queued.
13
+ */
14
+ export declare class RecordingWriteStream extends TestWriteStream {
15
+ readonly writes: Buffer[];
16
+ private held;
17
+ private parked;
18
+ _write(chunk: Uint8Array, _encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
19
+ /** True while a write waits for `release()`. */
20
+ get pendingWrite(): boolean;
21
+ hold(): void;
22
+ /** Stops holding and completes the parked write, if any. */
23
+ release(): void;
24
+ bytes(): Buffer;
25
+ text(): string;
26
+ clear(): void;
27
+ }
10
28
  export type TestStdout = TestWriteStream & NodeJS.WriteStream;
11
29
  export declare function createTestStdin(): NodeJS.ReadStream;
12
30
  export declare function createTestStdout(columns?: number, rows?: number): NodeJS.WriteStream;