@chengchenccc/tui 0.1.1-rc.1

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 (226) hide show
  1. package/dist/autocomplete.d.ts +56 -0
  2. package/dist/autocomplete.d.ts.map +1 -0
  3. package/dist/autocomplete.js +647 -0
  4. package/dist/components/box.d.ts +22 -0
  5. package/dist/components/box.d.ts.map +1 -0
  6. package/dist/components/box.js +103 -0
  7. package/dist/components/card.d.ts +33 -0
  8. package/dist/components/card.d.ts.map +1 -0
  9. package/dist/components/card.js +49 -0
  10. package/dist/components/editor.d.ts +257 -0
  11. package/dist/components/editor.d.ts.map +1 -0
  12. package/dist/components/editor.js +1980 -0
  13. package/dist/components/input.d.ts +37 -0
  14. package/dist/components/input.d.ts.map +1 -0
  15. package/dist/components/input.js +389 -0
  16. package/dist/components/loader.d.ts +33 -0
  17. package/dist/components/loader.d.ts.map +1 -0
  18. package/dist/components/loader.js +100 -0
  19. package/dist/components/markdown.d.ts +108 -0
  20. package/dist/components/markdown.d.ts.map +1 -0
  21. package/dist/components/markdown.js +847 -0
  22. package/dist/components/markdown.test.d.ts +2 -0
  23. package/dist/components/markdown.test.d.ts.map +1 -0
  24. package/dist/components/markdown.test.js +81 -0
  25. package/dist/components/output-block.d.ts +44 -0
  26. package/dist/components/output-block.d.ts.map +1 -0
  27. package/dist/components/output-block.js +131 -0
  28. package/dist/components/select-list.d.ts +50 -0
  29. package/dist/components/select-list.d.ts.map +1 -0
  30. package/dist/components/select-list.js +166 -0
  31. package/dist/components/spacer.d.ts +12 -0
  32. package/dist/components/spacer.d.ts.map +1 -0
  33. package/dist/components/spacer.js +22 -0
  34. package/dist/components/statusline.d.ts +30 -0
  35. package/dist/components/statusline.d.ts.map +1 -0
  36. package/dist/components/statusline.js +46 -0
  37. package/dist/components/text.d.ts +19 -0
  38. package/dist/components/text.d.ts.map +1 -0
  39. package/dist/components/text.js +90 -0
  40. package/dist/components/truncated-text.d.ts +13 -0
  41. package/dist/components/truncated-text.d.ts.map +1 -0
  42. package/dist/components/truncated-text.js +50 -0
  43. package/dist/editor-component.d.ts +39 -0
  44. package/dist/editor-component.d.ts.map +1 -0
  45. package/dist/editor-component.js +1 -0
  46. package/dist/fuzzy.d.ts +16 -0
  47. package/dist/fuzzy.d.ts.map +1 -0
  48. package/dist/fuzzy.js +109 -0
  49. package/dist/index.d.ts +25 -0
  50. package/dist/index.d.ts.map +1 -0
  51. package/dist/index.js +36 -0
  52. package/dist/keybindings.d.ts +193 -0
  53. package/dist/keybindings.d.ts.map +1 -0
  54. package/dist/keybindings.js +191 -0
  55. package/dist/keys.d.ts +184 -0
  56. package/dist/keys.d.ts.map +1 -0
  57. package/dist/keys.js +1191 -0
  58. package/dist/kill-ring.d.ts +28 -0
  59. package/dist/kill-ring.d.ts.map +1 -0
  60. package/dist/kill-ring.js +43 -0
  61. package/dist/mermaid.d.ts +23 -0
  62. package/dist/mermaid.d.ts.map +1 -0
  63. package/dist/mermaid.js +77 -0
  64. package/dist/mouse.d.ts +40 -0
  65. package/dist/mouse.d.ts.map +1 -0
  66. package/dist/mouse.js +39 -0
  67. package/dist/mouse.test.d.ts +2 -0
  68. package/dist/mouse.test.d.ts.map +1 -0
  69. package/dist/mouse.test.js +36 -0
  70. package/dist/native-modifiers.d.ts +3 -0
  71. package/dist/native-modifiers.d.ts.map +1 -0
  72. package/dist/native-modifiers.js +52 -0
  73. package/dist/stdin-buffer.d.ts +50 -0
  74. package/dist/stdin-buffer.d.ts.map +1 -0
  75. package/dist/stdin-buffer.js +360 -0
  76. package/dist/terminal-colors.d.ts +10 -0
  77. package/dist/terminal-colors.d.ts.map +1 -0
  78. package/dist/terminal-colors.js +58 -0
  79. package/dist/terminal-image.d.ts +90 -0
  80. package/dist/terminal-image.d.ts.map +1 -0
  81. package/dist/terminal-image.js +375 -0
  82. package/dist/terminal.d.ts +110 -0
  83. package/dist/terminal.d.ts.map +1 -0
  84. package/dist/terminal.js +432 -0
  85. package/dist/tui-scrollback.test.d.ts +2 -0
  86. package/dist/tui-scrollback.test.d.ts.map +1 -0
  87. package/dist/tui-scrollback.test.js +51 -0
  88. package/dist/tui.d.ts +330 -0
  89. package/dist/tui.d.ts.map +1 -0
  90. package/dist/tui.js +1568 -0
  91. package/dist/undo-stack.d.ts +17 -0
  92. package/dist/undo-stack.d.ts.map +1 -0
  93. package/dist/undo-stack.js +24 -0
  94. package/dist/utils.d.ts +85 -0
  95. package/dist/utils.d.ts.map +1 -0
  96. package/dist/utils.js +1066 -0
  97. package/dist/vendor/mermaid-ascii/ascii/ansi.d.ts +42 -0
  98. package/dist/vendor/mermaid-ascii/ascii/ansi.d.ts.map +1 -0
  99. package/dist/vendor/mermaid-ascii/ascii/ansi.js +361 -0
  100. package/dist/vendor/mermaid-ascii/ascii/canvas.d.ts +90 -0
  101. package/dist/vendor/mermaid-ascii/ascii/canvas.d.ts.map +1 -0
  102. package/dist/vendor/mermaid-ascii/ascii/canvas.js +414 -0
  103. package/dist/vendor/mermaid-ascii/ascii/class-diagram.d.ts +8 -0
  104. package/dist/vendor/mermaid-ascii/ascii/class-diagram.d.ts.map +1 -0
  105. package/dist/vendor/mermaid-ascii/ascii/class-diagram.js +623 -0
  106. package/dist/vendor/mermaid-ascii/ascii/converter.d.ts +13 -0
  107. package/dist/vendor/mermaid-ascii/ascii/converter.d.ts.map +1 -0
  108. package/dist/vendor/mermaid-ascii/ascii/converter.js +233 -0
  109. package/dist/vendor/mermaid-ascii/ascii/draw.d.ts +67 -0
  110. package/dist/vendor/mermaid-ascii/ascii/draw.d.ts.map +1 -0
  111. package/dist/vendor/mermaid-ascii/ascii/draw.js +1313 -0
  112. package/dist/vendor/mermaid-ascii/ascii/edge-bundling.d.ts +49 -0
  113. package/dist/vendor/mermaid-ascii/ascii/edge-bundling.d.ts.map +1 -0
  114. package/dist/vendor/mermaid-ascii/ascii/edge-bundling.js +289 -0
  115. package/dist/vendor/mermaid-ascii/ascii/edge-routing.d.ts +44 -0
  116. package/dist/vendor/mermaid-ascii/ascii/edge-routing.d.ts.map +1 -0
  117. package/dist/vendor/mermaid-ascii/ascii/edge-routing.js +302 -0
  118. package/dist/vendor/mermaid-ascii/ascii/er-diagram.d.ts +8 -0
  119. package/dist/vendor/mermaid-ascii/ascii/er-diagram.d.ts.map +1 -0
  120. package/dist/vendor/mermaid-ascii/ascii/er-diagram.js +380 -0
  121. package/dist/vendor/mermaid-ascii/ascii/grid.d.ts +57 -0
  122. package/dist/vendor/mermaid-ascii/ascii/grid.d.ts.map +1 -0
  123. package/dist/vendor/mermaid-ascii/ascii/grid.js +516 -0
  124. package/dist/vendor/mermaid-ascii/ascii/index.d.ts +66 -0
  125. package/dist/vendor/mermaid-ascii/ascii/index.d.ts.map +1 -0
  126. package/dist/vendor/mermaid-ascii/ascii/index.js +133 -0
  127. package/dist/vendor/mermaid-ascii/ascii/multiline-utils.d.ts +28 -0
  128. package/dist/vendor/mermaid-ascii/ascii/multiline-utils.d.ts.map +1 -0
  129. package/dist/vendor/mermaid-ascii/ascii/multiline-utils.js +60 -0
  130. package/dist/vendor/mermaid-ascii/ascii/pathfinder.d.ts +18 -0
  131. package/dist/vendor/mermaid-ascii/ascii/pathfinder.d.ts.map +1 -0
  132. package/dist/vendor/mermaid-ascii/ascii/pathfinder.js +224 -0
  133. package/dist/vendor/mermaid-ascii/ascii/sequence.d.ts +8 -0
  134. package/dist/vendor/mermaid-ascii/ascii/sequence.d.ts.map +1 -0
  135. package/dist/vendor/mermaid-ascii/ascii/sequence.js +416 -0
  136. package/dist/vendor/mermaid-ascii/ascii/shapes/circle.d.ts +12 -0
  137. package/dist/vendor/mermaid-ascii/ascii/shapes/circle.d.ts.map +1 -0
  138. package/dist/vendor/mermaid-ascii/ascii/shapes/circle.js +22 -0
  139. package/dist/vendor/mermaid-ascii/ascii/shapes/corners.d.ts +35 -0
  140. package/dist/vendor/mermaid-ascii/ascii/shapes/corners.d.ts.map +1 -0
  141. package/dist/vendor/mermaid-ascii/ascii/shapes/corners.js +91 -0
  142. package/dist/vendor/mermaid-ascii/ascii/shapes/diamond.d.ts +12 -0
  143. package/dist/vendor/mermaid-ascii/ascii/shapes/diamond.d.ts.map +1 -0
  144. package/dist/vendor/mermaid-ascii/ascii/shapes/diamond.js +22 -0
  145. package/dist/vendor/mermaid-ascii/ascii/shapes/hexagon.d.ts +12 -0
  146. package/dist/vendor/mermaid-ascii/ascii/shapes/hexagon.d.ts.map +1 -0
  147. package/dist/vendor/mermaid-ascii/ascii/shapes/hexagon.js +22 -0
  148. package/dist/vendor/mermaid-ascii/ascii/shapes/index.d.ts +27 -0
  149. package/dist/vendor/mermaid-ascii/ascii/shapes/index.d.ts.map +1 -0
  150. package/dist/vendor/mermaid-ascii/ascii/shapes/index.js +66 -0
  151. package/dist/vendor/mermaid-ascii/ascii/shapes/rectangle.d.ts +32 -0
  152. package/dist/vendor/mermaid-ascii/ascii/shapes/rectangle.d.ts.map +1 -0
  153. package/dist/vendor/mermaid-ascii/ascii/shapes/rectangle.js +149 -0
  154. package/dist/vendor/mermaid-ascii/ascii/shapes/rounded.d.ts +12 -0
  155. package/dist/vendor/mermaid-ascii/ascii/shapes/rounded.d.ts.map +1 -0
  156. package/dist/vendor/mermaid-ascii/ascii/shapes/rounded.js +22 -0
  157. package/dist/vendor/mermaid-ascii/ascii/shapes/special.d.ts +60 -0
  158. package/dist/vendor/mermaid-ascii/ascii/shapes/special.d.ts.map +1 -0
  159. package/dist/vendor/mermaid-ascii/ascii/shapes/special.js +253 -0
  160. package/dist/vendor/mermaid-ascii/ascii/shapes/stadium.d.ts +18 -0
  161. package/dist/vendor/mermaid-ascii/ascii/shapes/stadium.d.ts.map +1 -0
  162. package/dist/vendor/mermaid-ascii/ascii/shapes/stadium.js +103 -0
  163. package/dist/vendor/mermaid-ascii/ascii/shapes/state.d.ts +31 -0
  164. package/dist/vendor/mermaid-ascii/ascii/shapes/state.d.ts.map +1 -0
  165. package/dist/vendor/mermaid-ascii/ascii/shapes/state.js +167 -0
  166. package/dist/vendor/mermaid-ascii/ascii/shapes/types.d.ts +56 -0
  167. package/dist/vendor/mermaid-ascii/ascii/shapes/types.d.ts.map +1 -0
  168. package/dist/vendor/mermaid-ascii/ascii/shapes/types.js +4 -0
  169. package/dist/vendor/mermaid-ascii/ascii/types.d.ts +207 -0
  170. package/dist/vendor/mermaid-ascii/ascii/types.d.ts.map +1 -0
  171. package/dist/vendor/mermaid-ascii/ascii/types.js +39 -0
  172. package/dist/vendor/mermaid-ascii/ascii/validate.d.ts +52 -0
  173. package/dist/vendor/mermaid-ascii/ascii/validate.d.ts.map +1 -0
  174. package/dist/vendor/mermaid-ascii/ascii/validate.js +97 -0
  175. package/dist/vendor/mermaid-ascii/ascii/xychart.d.ts +3 -0
  176. package/dist/vendor/mermaid-ascii/ascii/xychart.d.ts.map +1 -0
  177. package/dist/vendor/mermaid-ascii/ascii/xychart.js +719 -0
  178. package/dist/vendor/mermaid-ascii/class/parser.d.ts +7 -0
  179. package/dist/vendor/mermaid-ascii/class/parser.d.ts.map +1 -0
  180. package/dist/vendor/mermaid-ascii/class/parser.js +265 -0
  181. package/dist/vendor/mermaid-ascii/class/types.d.ts +103 -0
  182. package/dist/vendor/mermaid-ascii/class/types.d.ts.map +1 -0
  183. package/dist/vendor/mermaid-ascii/class/types.js +7 -0
  184. package/dist/vendor/mermaid-ascii/er/parser.d.ts +7 -0
  185. package/dist/vendor/mermaid-ascii/er/parser.d.ts.map +1 -0
  186. package/dist/vendor/mermaid-ascii/er/parser.js +162 -0
  187. package/dist/vendor/mermaid-ascii/er/types.d.ts +77 -0
  188. package/dist/vendor/mermaid-ascii/er/types.d.ts.map +1 -0
  189. package/dist/vendor/mermaid-ascii/er/types.js +7 -0
  190. package/dist/vendor/mermaid-ascii/index.d.ts +2 -0
  191. package/dist/vendor/mermaid-ascii/index.d.ts.map +1 -0
  192. package/dist/vendor/mermaid-ascii/index.js +13 -0
  193. package/dist/vendor/mermaid-ascii/multiline-utils.d.ts +10 -0
  194. package/dist/vendor/mermaid-ascii/multiline-utils.d.ts.map +1 -0
  195. package/dist/vendor/mermaid-ascii/multiline-utils.js +29 -0
  196. package/dist/vendor/mermaid-ascii/parser.d.ts +8 -0
  197. package/dist/vendor/mermaid-ascii/parser.d.ts.map +1 -0
  198. package/dist/vendor/mermaid-ascii/parser.js +558 -0
  199. package/dist/vendor/mermaid-ascii/sequence/parser.d.ts +7 -0
  200. package/dist/vendor/mermaid-ascii/sequence/parser.d.ts.map +1 -0
  201. package/dist/vendor/mermaid-ascii/sequence/parser.js +182 -0
  202. package/dist/vendor/mermaid-ascii/sequence/types.d.ts +131 -0
  203. package/dist/vendor/mermaid-ascii/sequence/types.d.ts.map +1 -0
  204. package/dist/vendor/mermaid-ascii/sequence/types.js +7 -0
  205. package/dist/vendor/mermaid-ascii/text-metrics.d.ts +24 -0
  206. package/dist/vendor/mermaid-ascii/text-metrics.d.ts.map +1 -0
  207. package/dist/vendor/mermaid-ascii/text-metrics.js +69 -0
  208. package/dist/vendor/mermaid-ascii/types.d.ts +115 -0
  209. package/dist/vendor/mermaid-ascii/types.d.ts.map +1 -0
  210. package/dist/vendor/mermaid-ascii/types.js +4 -0
  211. package/dist/vendor/mermaid-ascii/xychart/colors.d.ts +26 -0
  212. package/dist/vendor/mermaid-ascii/xychart/colors.d.ts.map +1 -0
  213. package/dist/vendor/mermaid-ascii/xychart/colors.js +145 -0
  214. package/dist/vendor/mermaid-ascii/xychart/parser.d.ts +7 -0
  215. package/dist/vendor/mermaid-ascii/xychart/parser.d.ts.map +1 -0
  216. package/dist/vendor/mermaid-ascii/xychart/parser.js +105 -0
  217. package/dist/vendor/mermaid-ascii/xychart/types.d.ts +146 -0
  218. package/dist/vendor/mermaid-ascii/xychart/types.d.ts.map +1 -0
  219. package/dist/vendor/mermaid-ascii/xychart/types.js +8 -0
  220. package/dist/virtual-terminal.d.ts +80 -0
  221. package/dist/virtual-terminal.d.ts.map +1 -0
  222. package/dist/virtual-terminal.js +284 -0
  223. package/dist/word-navigation.d.ts +25 -0
  224. package/dist/word-navigation.d.ts.map +1 -0
  225. package/dist/word-navigation.js +97 -0
  226. package/package.json +38 -0
package/dist/tui.d.ts ADDED
@@ -0,0 +1,330 @@
1
+ /**
2
+ * Minimal TUI implementation with differential rendering
3
+ */
4
+ import type { Terminal } from "./terminal.ts";
5
+ import { type RgbColor, type TerminalColorScheme } from "./terminal-colors.ts";
6
+ import { visibleWidth } from "./utils.ts";
7
+ /**
8
+ * Component interface - all components must implement this
9
+ */
10
+ export interface Component {
11
+ /**
12
+ * Render the component to lines for the given viewport width
13
+ * @param width - Current viewport width
14
+ * @returns Array of strings, each representing a line
15
+ */
16
+ render(width: number): string[];
17
+ /**
18
+ * Optional handler for keyboard input when component has focus
19
+ */
20
+ handleInput?(data: string): void;
21
+ /**
22
+ * If true, component receives key release events (Kitty protocol).
23
+ * Default is false - release events are filtered out.
24
+ */
25
+ wantsKeyRelease?: boolean;
26
+ /**
27
+ * Invalidate any cached rendering state.
28
+ * Called when theme changes or when component needs to re-render from scratch.
29
+ */
30
+ invalidate(): void;
31
+ }
32
+ type InputListenerResult = {
33
+ consume?: boolean;
34
+ data?: string;
35
+ } | undefined;
36
+ type InputListener = (data: string) => InputListenerResult;
37
+ /**
38
+ * Interface for components that can receive focus and display a hardware cursor.
39
+ * When focused, the component should emit CURSOR_MARKER at the cursor position
40
+ * in its render output. TUI will find this marker and position the hardware
41
+ * cursor there for proper IME candidate window positioning.
42
+ */
43
+ export interface Focusable {
44
+ /** Set by TUI when focus changes. Component should emit CURSOR_MARKER when true. */
45
+ focused: boolean;
46
+ }
47
+ /** Type guard to check if a component implements Focusable */
48
+ export declare function isFocusable(component: Component | null): component is Component & Focusable;
49
+ /**
50
+ * Cursor position marker - APC (Application Program Command) sequence.
51
+ * This is a zero-width escape sequence that terminals ignore.
52
+ * Components emit this at the cursor position when focused.
53
+ * TUI finds and strips this marker, then positions the hardware cursor there.
54
+ */
55
+ export declare const CURSOR_MARKER = "\u001B_pi:c\u0007";
56
+ export { visibleWidth };
57
+ /**
58
+ * Anchor position for overlays
59
+ */
60
+ export type OverlayAnchor = "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | "left-center" | "right-center";
61
+ /**
62
+ * Margin configuration for overlays
63
+ */
64
+ export interface OverlayMargin {
65
+ top?: number;
66
+ right?: number;
67
+ bottom?: number;
68
+ left?: number;
69
+ }
70
+ /** Value that can be absolute (number) or percentage (string like "50%") */
71
+ export type SizeValue = number | `${number}%`;
72
+ /**
73
+ * Options for overlay positioning and sizing.
74
+ * Values can be absolute numbers or percentage strings (e.g., "50%").
75
+ */
76
+ export interface OverlayOptions {
77
+ /** Width in columns, or percentage of terminal width (e.g., "50%") */
78
+ width?: SizeValue;
79
+ /** Minimum width in columns */
80
+ minWidth?: number;
81
+ /** Maximum height in rows, or percentage of terminal height (e.g., "50%") */
82
+ maxHeight?: SizeValue;
83
+ /** Anchor point for positioning (default: 'center') */
84
+ anchor?: OverlayAnchor;
85
+ /** Horizontal offset from anchor position (positive = right) */
86
+ offsetX?: number;
87
+ /** Vertical offset from anchor position (positive = down) */
88
+ offsetY?: number;
89
+ /** Row position: absolute number, or percentage (e.g., "25%" = 25% from top) */
90
+ row?: SizeValue;
91
+ /** Column position: absolute number, or percentage (e.g., "50%" = centered horizontally) */
92
+ col?: SizeValue;
93
+ /** Margin from terminal edges. Number applies to all sides. */
94
+ margin?: OverlayMargin | number;
95
+ /**
96
+ * Control overlay visibility based on terminal dimensions.
97
+ * If provided, overlay is only rendered when this returns true.
98
+ * Called each render cycle with current terminal dimensions.
99
+ */
100
+ visible?: (termWidth: number, termHeight: number) => boolean;
101
+ /** If true, don't capture keyboard focus when shown */
102
+ nonCapturing?: boolean;
103
+ }
104
+ /** Options for {@link OverlayHandle.unfocus}. */
105
+ export interface OverlayUnfocusOptions {
106
+ /** Explicit target to focus after releasing this overlay. */
107
+ target: Component | null;
108
+ }
109
+ /**
110
+ * Handle returned by showOverlay for controlling the overlay
111
+ */
112
+ export interface OverlayHandle {
113
+ /** Permanently remove the overlay (cannot be shown again) */
114
+ hide(): void;
115
+ /** Temporarily hide or show the overlay */
116
+ setHidden(hidden: boolean): void;
117
+ /** Check if overlay is temporarily hidden */
118
+ isHidden(): boolean;
119
+ /** Focus this overlay and bring it to the visual front */
120
+ focus(): void;
121
+ /** Release focus to the next visible capturing overlay or previous target, or to an explicit target when provided */
122
+ unfocus(options?: OverlayUnfocusOptions): void;
123
+ /** Check if this overlay currently has focus */
124
+ isFocused(): boolean;
125
+ }
126
+ /**
127
+ * Container - a component that contains other components
128
+ */
129
+ export declare class Container implements Component {
130
+ children: Component[];
131
+ addChild(component: Component): void;
132
+ removeChild(component: Component): void;
133
+ clear(): void;
134
+ invalidate(): void;
135
+ render(width: number): string[];
136
+ }
137
+ /** Engine tells a component how many of its rows have entered native scrollback. */
138
+ export interface NativeScrollbackCommittedRows {
139
+ setNativeScrollbackCommittedRows(rows: number): void;
140
+ }
141
+ /** One offered history batch (finalized rows for terminal scrollback). */
142
+ export interface HistoryBatch {
143
+ id: number;
144
+ rows: readonly string[];
145
+ }
146
+ /** A frame plan returned by a terminal frame provider. */
147
+ export interface FramePlan {
148
+ viewport: readonly string[];
149
+ history?: HistoryBatch;
150
+ }
151
+ /** A provider that composes the terminal frame + offers history batches.
152
+ * oma currently uses a simplified renderer; this contract is the target for
153
+ * the full omp-compatible pipeline. */
154
+ export interface TerminalFrameProvider {
155
+ renderFrame(opts: {
156
+ columns: number;
157
+ rows: number;
158
+ }): FramePlan;
159
+ acknowledgeHistory?(id: number): void;
160
+ beginHistoryFlush?(): void;
161
+ beginHistoryReplay?(): void;
162
+ }
163
+ /** A component reports the local row index below which rows are mutable. */
164
+ export interface NativeScrollbackLiveRegion {
165
+ getNativeScrollbackLiveRegionStart(): number | undefined;
166
+ isNativeScrollbackLiveRegionPinned?(): boolean;
167
+ }
168
+ /** A component reports leading rows byte-identical to the previous render. */
169
+ export interface RenderStablePrefix {
170
+ getRenderStablePrefixRows(): number;
171
+ }
172
+ /** Fast path for composing only the visible tail during a resize burst. */
173
+ export interface ViewportTailProvider {
174
+ renderViewportTail(width: number, maxRows: number): readonly string[];
175
+ }
176
+ /** Hook to rehydrate a component's full frame after a destructive replay. */
177
+ export interface NativeScrollbackReplay {
178
+ prepareNativeScrollbackReplay(): void;
179
+ }
180
+ export declare function setNativeScrollbackCommittedRows(component: Component, rows: number): void;
181
+ export declare function getNativeScrollbackLiveRegionStart(component: Component): number | undefined;
182
+ export declare function getRenderStablePrefixRows(component: Component): number | undefined;
183
+ export declare function prepareNativeScrollbackReplay(component: Component): void;
184
+ /**
185
+ * TUI - Main class for managing terminal UI with differential rendering
186
+ */
187
+ export declare class TUI extends Container {
188
+ terminal: Terminal;
189
+ private previousLines;
190
+ private previousKittyImageIds;
191
+ private previousWidth;
192
+ private previousHeight;
193
+ private focusedComponent;
194
+ private inputListeners;
195
+ /** Global callback for debug key (Shift+Ctrl+D). Called before input is forwarded to focused component. */
196
+ onDebug?: () => void;
197
+ private renderRequested;
198
+ private renderTimer;
199
+ private lastRenderAt;
200
+ private static readonly MIN_RENDER_INTERVAL_MS;
201
+ private cursorRow;
202
+ private hardwareCursorRow;
203
+ private showHardwareCursor;
204
+ private clearOnShrink;
205
+ private maxLinesRendered;
206
+ private previousViewportTop;
207
+ private committedRows;
208
+ private frameProvider?;
209
+ private providerViewportTop;
210
+ private providerWindow;
211
+ private acceptedHistoryBatchId;
212
+ private providerForceRepaint;
213
+ private fullRedrawCount;
214
+ private stopped;
215
+ private pendingOsc11BackgroundReplies;
216
+ private pendingOsc11BackgroundQueries;
217
+ private terminalColorSchemeListeners;
218
+ private terminalColorSchemeNotificationsEnabled;
219
+ private focusOrderCounter;
220
+ private overlayStack;
221
+ private overlayFocusRestore;
222
+ constructor(terminal: Terminal, showHardwareCursor?: boolean);
223
+ get fullRedraws(): number;
224
+ getShowHardwareCursor(): boolean;
225
+ setShowHardwareCursor(enabled: boolean): void;
226
+ getClearOnShrink(): boolean;
227
+ /**
228
+ * Set whether to trigger full re-render when content shrinks.
229
+ * When true (default), empty rows are cleared when content shrinks.
230
+ * When false, empty rows remain (reduces redraws on slower terminals).
231
+ */
232
+ setClearOnShrink(enabled: boolean): void;
233
+ /** Provide a frame provider (omp TerminalFrameProvider pipeline). */
234
+ setFrameProvider(provider?: TerminalFrameProvider): void;
235
+ setFocus(component: Component | null): void;
236
+ private setFocusInternal;
237
+ private clearOverlayFocusRestore;
238
+ private clearOverlayFocusRestoreFor;
239
+ private resolveBlockedOverlayFocusResume;
240
+ private getVisibleOverlayFocusRestore;
241
+ private isOverlayFocusAncestor;
242
+ private retargetOverlayPreFocus;
243
+ private isComponentMounted;
244
+ private containsComponent;
245
+ /**
246
+ * Show an overlay component with configurable positioning and sizing.
247
+ * Returns a handle to control the overlay's visibility.
248
+ */
249
+ showOverlay(component: Component, options?: OverlayOptions): OverlayHandle;
250
+ /** Hide the topmost overlay and restore previous focus. */
251
+ hideOverlay(): void;
252
+ /** Check if there are any visible overlays */
253
+ hasOverlay(): boolean;
254
+ /** Check if an overlay entry is currently visible */
255
+ private isOverlayVisible;
256
+ /** Find the visual-frontmost visible capturing overlay, if any */
257
+ private getTopmostVisibleOverlay;
258
+ invalidate(): void;
259
+ start(): void;
260
+ addInputListener(listener: InputListener): () => void;
261
+ removeInputListener(listener: InputListener): void;
262
+ onTerminalColorSchemeChange(listener: (scheme: TerminalColorScheme) => void): () => void;
263
+ setTerminalColorSchemeNotifications(enabled: boolean): void;
264
+ private queryCellSize;
265
+ stop(): void;
266
+ requestRender(force?: boolean): void;
267
+ private scheduleRender;
268
+ private handleInput;
269
+ private consumeOsc11BackgroundResponse;
270
+ private consumeTerminalColorSchemeReport;
271
+ private consumeCellSizeResponse;
272
+ /**
273
+ * Resolve overlay layout from options.
274
+ * Returns { width, row, col, maxHeight } for rendering.
275
+ */
276
+ private resolveOverlayLayout;
277
+ private resolveAnchorRow;
278
+ private resolveAnchorCol;
279
+ /** Composite all overlays into content lines (sorted by focusOrder, higher = on top). */
280
+ private compositeOverlays;
281
+ private static readonly SEGMENT_RESET;
282
+ private applyLineResets;
283
+ private collectKittyImageIds;
284
+ private deleteKittyImages;
285
+ private getKittyImageReservedRows;
286
+ private expandChangedRangeForKittyImages;
287
+ private deleteChangedKittyImages;
288
+ /** Splice overlay content into a base line at a specific column. Single-pass optimized. */
289
+ private compositeLineAt;
290
+ /**
291
+ * Find and extract cursor position from rendered lines.
292
+ * Searches for CURSOR_MARKER, calculates its position, and strips it from the output.
293
+ * Only scans the bottom terminal height lines (visible viewport).
294
+ * @param lines - Rendered lines to search
295
+ * @param height - Terminal height (visible viewport size)
296
+ * @returns Cursor position { row, col } or null if no marker found
297
+ */
298
+ private extractCursorPosition;
299
+ /** Advance the committed boundary and notify root children. */
300
+ private syncCommittedRows;
301
+ /** Provider frame path: append committed history to native scrollback and
302
+ * repaint the bounded mutable viewport. When a terminal frame provider is
303
+ * installed this replaces the full-frame differential renderer so old rows
304
+ * scroll into the terminal's own scrollback instead of being covered. */
305
+ private renderProviderFrame;
306
+ private doRender;
307
+ /**
308
+ * Position the hardware cursor for IME candidate window.
309
+ * @param cursorPos The cursor position extracted from rendered output, or null
310
+ * @param totalLines Total number of rendered lines
311
+ */
312
+ private positionHardwareCursor;
313
+ /**
314
+ * Query the terminal's default background color with OSC 11 (`ESC ] 11 ; ? BEL`).
315
+ * @param timeoutMs Query timeout in milliseconds.
316
+ * @returns Promise containing the parsed RGB color, or undefined if it times out or fails to parse.
317
+ */
318
+ queryTerminalBackgroundColor({ timeoutMs, }: {
319
+ timeoutMs: number;
320
+ }): Promise<RgbColor | undefined>;
321
+ /**
322
+ * Query the terminal's color-scheme preference with DSR (`CSI ? 996 n`).
323
+ * Terminals that support the color palette notification protocol reply with
324
+ * `CSI ? 997 ; 1 n` for dark or `CSI ? 997 ; 2 n` for light.
325
+ */
326
+ queryTerminalColorScheme({ timeoutMs, }: {
327
+ timeoutMs: number;
328
+ }): Promise<TerminalColorScheme | undefined>;
329
+ }
330
+ //# sourceMappingURL=tui.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tui.d.ts","sourceRoot":"","sources":["../src/tui.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAIL,KAAK,QAAQ,EACb,KAAK,mBAAmB,EACzB,MAAM,sBAAsB,CAAC;AAO9B,OAAO,EAKL,YAAY,EACb,MAAM,YAAY,CAAC;AA0CpB;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,UAAU,IAAI,IAAI,CAAC;CACpB;AAED,KAAK,mBAAmB,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAC5E,KAAK,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,mBAAmB,CAAC;AAO3D;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,oFAAoF;IACpF,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,8DAA8D;AAC9D,wBAAgB,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,GAAG,SAAS,IAAI,SAAS,GAAG,SAAS,CAE3F;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sBAAkB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,UAAU,GACV,WAAW,GACX,aAAa,GACb,cAAc,GACd,YAAY,GACZ,eAAe,GACf,aAAa,GACb,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,4EAA4E;AAC5E,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC;AAkB9C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAE7B,sEAAsE;IACtE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,SAAS,CAAC;IAGtB,uDAAuD;IACvD,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,gFAAgF;IAChF,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,4FAA4F;IAC5F,GAAG,CAAC,EAAE,SAAS,CAAC;IAGhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAGhC;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7D,uDAAuD;IACvD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,iDAAiD;AACjD,MAAM,WAAW,qBAAqB;IACpC,6DAA6D;IAC7D,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,6DAA6D;IAC7D,IAAI,IAAI,IAAI,CAAC;IACb,2CAA2C;IAC3C,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,6CAA6C;IAC7C,QAAQ,IAAI,OAAO,CAAC;IACpB,0DAA0D;IAC1D,KAAK,IAAI,IAAI,CAAC;IACd,qHAAqH;IACrH,OAAO,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,gDAAgD;IAChD,SAAS,IAAI,OAAO,CAAC;CACtB;AA6BD;;GAEG;AACH,qBAAa,SAAU,YAAW,SAAS;IACzC,QAAQ,EAAE,SAAS,EAAE,CAAM;IAE3B,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAIpC,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAOvC,KAAK,IAAI,IAAI;IAIb,UAAU,IAAI,IAAI;IAMlB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;CAUhC;AAED,oFAAoF;AACpF,MAAM,WAAW,6BAA6B;IAC5C,gCAAgC,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACtD;AAED,0EAA0E;AAC1E,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB;AAED,0DAA0D;AAC1D,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB;AAED;;wCAEwC;AACxC,MAAM,WAAW,qBAAqB;IACpC,WAAW,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IAChE,kBAAkB,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,iBAAiB,CAAC,IAAI,IAAI,CAAC;IAC3B,kBAAkB,CAAC,IAAI,IAAI,CAAC;CAC7B;AAED,4EAA4E;AAC5E,MAAM,WAAW,0BAA0B;IACzC,kCAAkC,IAAI,MAAM,GAAG,SAAS,CAAC;IACzD,kCAAkC,CAAC,IAAI,OAAO,CAAC;CAChD;AAED,8EAA8E;AAC9E,MAAM,WAAW,kBAAkB;IACjC,yBAAyB,IAAI,MAAM,CAAC;CACrC;AAED,2EAA2E;AAC3E,MAAM,WAAW,oBAAoB;IACnC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;CACvE;AAED,6EAA6E;AAC7E,MAAM,WAAW,sBAAsB;IACrC,6BAA6B,IAAI,IAAI,CAAC;CACvC;AAED,wBAAgB,gCAAgC,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAIzF;AAED,wBAAgB,kCAAkC,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAI3F;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAElF;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAExE;AAED;;GAEG;AACH,qBAAa,GAAI,SAAQ,SAAS;IACzB,QAAQ,EAAE,QAAQ,CAAC;IAC1B,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,qBAAqB,CAAqB;IAClD,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,gBAAgB,CAA0B;IAClD,OAAO,CAAC,cAAc,CAA4B;IAElD,2GAA2G;IACpG,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAM;IACpD,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,kBAAkB,CAA0C;IACpE,OAAO,CAAC,aAAa,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,aAAa,CAAC,CAAwB;IAC9C,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,sBAAsB,CAAK;IACnC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,6BAA6B,CAAK;IAC1C,OAAO,CAAC,6BAA6B,CAAqC;IAC1E,OAAO,CAAC,4BAA4B,CAAoD;IACxF,OAAO,CAAC,uCAAuC,CAAS;IAGxD,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,mBAAmB,CAEzB;gBAEU,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,EAAE,OAAO;IAQ5D,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,qBAAqB,IAAI,OAAO;IAIhC,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAS7C,gBAAgB,IAAI,OAAO;IAI3B;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAIxC,qEAAqE;IACrE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAIxD,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI;IAI3C,OAAO,CAAC,gBAAgB;IA6ExB,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,2BAA2B;IASnC,OAAO,CAAC,gCAAgC;IAQxC,OAAO,CAAC,6BAA6B;IAYrC,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,uBAAuB;IAQ/B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IAMzB;;;OAGG;IACH,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa;IAiG1E,2DAA2D;IAC3D,WAAW,IAAI,IAAI;IAenB,8CAA8C;IAC9C,UAAU,IAAI,OAAO;IAIrB,qDAAqD;IACrD,OAAO,CAAC,gBAAgB;IAQxB,kEAAkE;IAClE,OAAO,CAAC,wBAAwB;IAWvB,UAAU,IAAI,IAAI;IAK3B,KAAK,IAAI,IAAI;IAcb,gBAAgB,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,IAAI;IAOrD,mBAAmB,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAIlD,2BAA2B,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,GAAG,MAAM,IAAI;IAOxF,mCAAmC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAU3D,OAAO,CAAC,aAAa;IAUrB,IAAI,IAAI,IAAI;IA6BZ,aAAa,CAAC,KAAK,UAAQ,GAAG,IAAI;IA6BlC,OAAO,CAAC,cAAc;IAoBtB,OAAO,CAAC,WAAW;IAkFnB,OAAO,CAAC,8BAA8B;IAwBtC,OAAO,CAAC,gCAAgC;IAYxC,OAAO,CAAC,uBAAuB;IAoB/B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IA+G5B,OAAO,CAAC,gBAAgB;IAsBxB,OAAO,CAAC,gBAAgB;IAsBxB,yFAAyF;IACzF,OAAO,CAAC,iBAAiB;IAyEzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAyB;IAE9D,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,yBAAyB;IAkBjC,OAAO,CAAC,gCAAgC;IA0BxC,OAAO,CAAC,wBAAwB;IAchC,2FAA2F;IAC3F,OAAO,CAAC,eAAe;IAkDvB;;;;;;;OAOG;IACH,OAAO,CAAC,qBAAqB;IAuB7B,+DAA+D;IAC/D,OAAO,CAAC,iBAAiB;IAOzB;;;8EAG0E;IAC1E,OAAO,CAAC,mBAAmB;IAsE3B,OAAO,CAAC,QAAQ;IAoZhB;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAoC9B;;;;OAIG;IACH,4BAA4B,CAAC,EAC3B,SAAS,GACV,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAuBjC;;;;OAIG;IACH,wBAAwB,CAAC,EACvB,SAAS,GACV,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;CAqB7C"}