@opentui/core 0.0.0-20250908-4906ddad
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.
- package/3d/SpriteResourceManager.d.ts +74 -0
- package/3d/SpriteUtils.d.ts +13 -0
- package/3d/TextureUtils.d.ts +24 -0
- package/3d/WGPURenderer.d.ts +59 -0
- package/3d/animation/ExplodingSpriteEffect.d.ts +71 -0
- package/3d/animation/PhysicsExplodingSpriteEffect.d.ts +76 -0
- package/3d/animation/SpriteAnimator.d.ts +124 -0
- package/3d/animation/SpriteParticleGenerator.d.ts +62 -0
- package/3d/canvas.d.ts +42 -0
- package/3d/index.d.ts +11 -0
- package/3d/physics/PlanckPhysicsAdapter.d.ts +19 -0
- package/3d/physics/RapierPhysicsAdapter.d.ts +19 -0
- package/3d/physics/physics-interface.d.ts +27 -0
- package/3d.d.ts +2 -0
- package/3d.js +33847 -0
- package/3d.js.map +154 -0
- package/LICENSE +21 -0
- package/README.md +43 -0
- package/Renderable.d.ts +266 -0
- package/animation/Timeline.d.ts +125 -0
- package/ansi.d.ts +28 -0
- package/buffer.d.ts +74 -0
- package/console.d.ts +86 -0
- package/index-d6kwx5pm.js +8837 -0
- package/index-d6kwx5pm.js.map +36 -0
- package/index.d.ts +12 -0
- package/index.js +3721 -0
- package/index.js.map +23 -0
- package/lib/KeyHandler.d.ts +11 -0
- package/lib/RGBA.d.ts +24 -0
- package/lib/TrackedNode.d.ts +36 -0
- package/lib/ascii.font.d.ts +301 -0
- package/lib/border.d.ts +47 -0
- package/lib/hast-styled-text.d.ts +38 -0
- package/lib/index.d.ts +11 -0
- package/lib/output.capture.d.ts +24 -0
- package/lib/parse.keypress.d.ts +14 -0
- package/lib/parse.mouse.d.ts +23 -0
- package/lib/selection.d.ts +63 -0
- package/lib/styled-text.d.ts +73 -0
- package/lib/word-jumps.d.ts +2 -0
- package/lib/yoga.options.d.ts +31 -0
- package/package.json +48 -0
- package/post/filters.d.ts +105 -0
- package/renderables/ASCIIFont.d.ts +43 -0
- package/renderables/Box.d.ts +70 -0
- package/renderables/FrameBuffer.d.ts +16 -0
- package/renderables/Input.d.ts +70 -0
- package/renderables/ScrollBar.d.ts +77 -0
- package/renderables/ScrollBox.d.ts +82 -0
- package/renderables/Select.d.ts +102 -0
- package/renderables/Slider.d.ts +31 -0
- package/renderables/TabSelect.d.ts +86 -0
- package/renderables/Text.d.ts +72 -0
- package/renderables/composition/VRenderable.d.ts +16 -0
- package/renderables/composition/constructs.d.ts +12 -0
- package/renderables/composition/vnode.d.ts +46 -0
- package/renderables/index.d.ts +12 -0
- package/renderer.d.ts +232 -0
- package/singleton.d.ts +5 -0
- package/text-buffer.d.ts +52 -0
- package/types.d.ts +56 -0
- package/utils.d.ts +10 -0
- package/zig.d.ts +110 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 opentui
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# OpenTUI Core
|
|
2
|
+
|
|
3
|
+
OpenTUI Core is a TypeScript library for building terminal user interfaces (TUIs). It is currently in
|
|
4
|
+
development and is not ready for production use.
|
|
5
|
+
|
|
6
|
+
[Getting Started](docs/getting-started.md)
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
bun install @opentui/core
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Build
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
bun run build
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
This creates platform-specific libraries that are automatically loaded by the TypeScript layer.
|
|
21
|
+
|
|
22
|
+
## Examples
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
bun install
|
|
26
|
+
bun run src/examples/index.ts
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## CLI Renderer
|
|
30
|
+
|
|
31
|
+
### Renderables
|
|
32
|
+
|
|
33
|
+
Renderables are hierarchical objects that can be positioned, nested, styled and rendered to the terminal:
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { createCliRenderer, TextRenderable } from "@opentui/core"
|
|
37
|
+
|
|
38
|
+
const renderer = await createCliRenderer()
|
|
39
|
+
|
|
40
|
+
const obj = new TextRenderable(renderer, { id: "my-obj", content: "Hello, world!" })
|
|
41
|
+
|
|
42
|
+
renderer.root.add(obj)
|
|
43
|
+
```
|
package/Renderable.d.ts
ADDED
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
import { EventEmitter } from "events";
|
|
2
|
+
import { OptimizedBuffer } from "./buffer";
|
|
3
|
+
import { type KeyHandler } from "./lib/KeyHandler";
|
|
4
|
+
import { TrackedNode } from "./lib/TrackedNode";
|
|
5
|
+
import type { ParsedKey } from "./lib/parse.keypress";
|
|
6
|
+
import { type AlignString, type FlexDirectionString, type JustifyString, type OverflowString, type PositionTypeString, type WrapString } from "./lib/yoga.options";
|
|
7
|
+
import type { MouseEvent } from "./renderer";
|
|
8
|
+
import type { RenderContext, ViewportBounds } from "./types";
|
|
9
|
+
import { type VNode } from "./renderables/composition/vnode";
|
|
10
|
+
import type { Selection } from "./lib/selection";
|
|
11
|
+
declare const BrandedRenderable: unique symbol;
|
|
12
|
+
export declare enum LayoutEvents {
|
|
13
|
+
LAYOUT_CHANGED = "layout-changed",
|
|
14
|
+
ADDED = "added",
|
|
15
|
+
REMOVED = "removed",
|
|
16
|
+
RESIZED = "resized"
|
|
17
|
+
}
|
|
18
|
+
export declare enum RenderableEvents {
|
|
19
|
+
FOCUSED = "focused",
|
|
20
|
+
BLURRED = "blurred"
|
|
21
|
+
}
|
|
22
|
+
export interface Position {
|
|
23
|
+
top?: number | "auto" | `${number}%`;
|
|
24
|
+
right?: number | "auto" | `${number}%`;
|
|
25
|
+
bottom?: number | "auto" | `${number}%`;
|
|
26
|
+
left?: number | "auto" | `${number}%`;
|
|
27
|
+
}
|
|
28
|
+
export interface LayoutOptions {
|
|
29
|
+
flexGrow?: number;
|
|
30
|
+
flexShrink?: number;
|
|
31
|
+
flexDirection?: FlexDirectionString;
|
|
32
|
+
flexWrap?: WrapString;
|
|
33
|
+
alignItems?: AlignString;
|
|
34
|
+
justifyContent?: JustifyString;
|
|
35
|
+
alignSelf?: AlignString;
|
|
36
|
+
flexBasis?: number | "auto" | undefined;
|
|
37
|
+
position?: PositionTypeString;
|
|
38
|
+
overflow?: OverflowString;
|
|
39
|
+
top?: number | "auto" | `${number}%`;
|
|
40
|
+
right?: number | "auto" | `${number}%`;
|
|
41
|
+
bottom?: number | "auto" | `${number}%`;
|
|
42
|
+
left?: number | "auto" | `${number}%`;
|
|
43
|
+
minWidth?: number | "auto" | `${number}%`;
|
|
44
|
+
minHeight?: number | "auto" | `${number}%`;
|
|
45
|
+
maxWidth?: number | "auto" | `${number}%`;
|
|
46
|
+
maxHeight?: number | "auto" | `${number}%`;
|
|
47
|
+
margin?: number | "auto" | `${number}%`;
|
|
48
|
+
marginTop?: number | "auto" | `${number}%`;
|
|
49
|
+
marginRight?: number | "auto" | `${number}%`;
|
|
50
|
+
marginBottom?: number | "auto" | `${number}%`;
|
|
51
|
+
marginLeft?: number | "auto" | `${number}%`;
|
|
52
|
+
padding?: number | `${number}%`;
|
|
53
|
+
paddingTop?: number | `${number}%`;
|
|
54
|
+
paddingRight?: number | `${number}%`;
|
|
55
|
+
paddingBottom?: number | `${number}%`;
|
|
56
|
+
paddingLeft?: number | `${number}%`;
|
|
57
|
+
enableLayout?: boolean;
|
|
58
|
+
}
|
|
59
|
+
export interface RenderableOptions<T extends Renderable = Renderable> extends Partial<LayoutOptions> {
|
|
60
|
+
id?: string;
|
|
61
|
+
width?: number | "auto" | `${number}%`;
|
|
62
|
+
height?: number | "auto" | `${number}%`;
|
|
63
|
+
zIndex?: number;
|
|
64
|
+
visible?: boolean;
|
|
65
|
+
buffered?: boolean;
|
|
66
|
+
live?: boolean;
|
|
67
|
+
renderBefore?: (this: T, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
68
|
+
renderAfter?: (this: T, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
69
|
+
onMouse?: (this: T, event: MouseEvent) => void;
|
|
70
|
+
onMouseDown?: (this: T, event: MouseEvent) => void;
|
|
71
|
+
onMouseUp?: (this: T, event: MouseEvent) => void;
|
|
72
|
+
onMouseMove?: (this: T, event: MouseEvent) => void;
|
|
73
|
+
onMouseDrag?: (this: T, event: MouseEvent) => void;
|
|
74
|
+
onMouseDragEnd?: (this: T, event: MouseEvent) => void;
|
|
75
|
+
onMouseDrop?: (this: T, event: MouseEvent) => void;
|
|
76
|
+
onMouseOver?: (this: T, event: MouseEvent) => void;
|
|
77
|
+
onMouseOut?: (this: T, event: MouseEvent) => void;
|
|
78
|
+
onMouseScroll?: (this: T, event: MouseEvent) => void;
|
|
79
|
+
onKeyDown?: (key: ParsedKey) => void;
|
|
80
|
+
onSizeChange?: (this: T) => void;
|
|
81
|
+
}
|
|
82
|
+
export declare function isValidPercentage(value: any): value is `${number}%`;
|
|
83
|
+
export declare function isMarginType(value: any): value is number | "auto" | `${number}%`;
|
|
84
|
+
export declare function isPaddingType(value: any): value is number | `${number}%`;
|
|
85
|
+
export declare function isPositionType(value: any): value is number | "auto" | `${number}%`;
|
|
86
|
+
export declare function isPositionTypeType(value: any): value is PositionTypeString;
|
|
87
|
+
export declare function isOverflowType(value: any): value is OverflowString;
|
|
88
|
+
export declare function isDimensionType(value: any): value is number | "auto" | `${number}%`;
|
|
89
|
+
export declare function isFlexBasisType(value: any): value is number | "auto" | undefined;
|
|
90
|
+
export declare function isSizeType(value: any): value is number | `${number}%` | undefined;
|
|
91
|
+
export declare function isRenderable(obj: any): obj is Renderable;
|
|
92
|
+
export declare abstract class Renderable extends EventEmitter {
|
|
93
|
+
[BrandedRenderable]: boolean;
|
|
94
|
+
private static renderableNumber;
|
|
95
|
+
static renderablesByNumber: Map<number, Renderable>;
|
|
96
|
+
readonly id: string;
|
|
97
|
+
readonly num: number;
|
|
98
|
+
private _isDestroyed;
|
|
99
|
+
protected _ctx: RenderContext;
|
|
100
|
+
protected _translateX: number;
|
|
101
|
+
protected _translateY: number;
|
|
102
|
+
protected _x: number;
|
|
103
|
+
protected _y: number;
|
|
104
|
+
protected _width: number | "auto" | `${number}%`;
|
|
105
|
+
protected _height: number | "auto" | `${number}%`;
|
|
106
|
+
protected _widthValue: number;
|
|
107
|
+
protected _heightValue: number;
|
|
108
|
+
private _zIndex;
|
|
109
|
+
protected _visible: boolean;
|
|
110
|
+
selectable: boolean;
|
|
111
|
+
protected buffered: boolean;
|
|
112
|
+
protected frameBuffer: OptimizedBuffer | null;
|
|
113
|
+
private _dirty;
|
|
114
|
+
protected focusable: boolean;
|
|
115
|
+
protected _focused: boolean;
|
|
116
|
+
protected keyHandler: KeyHandler;
|
|
117
|
+
protected keypressHandler: ((key: ParsedKey) => void) | null;
|
|
118
|
+
private _live;
|
|
119
|
+
protected _liveCount: number;
|
|
120
|
+
private _sizeChangeListener;
|
|
121
|
+
private _mouseListener;
|
|
122
|
+
private _mouseListeners;
|
|
123
|
+
private _keyListeners;
|
|
124
|
+
protected layoutNode: TrackedNode;
|
|
125
|
+
protected _positionType: PositionTypeString;
|
|
126
|
+
protected _overflow: OverflowString;
|
|
127
|
+
protected _position: Position;
|
|
128
|
+
private renderableMap;
|
|
129
|
+
protected renderableArray: Renderable[];
|
|
130
|
+
private needsZIndexSort;
|
|
131
|
+
parent: Renderable | null;
|
|
132
|
+
private childrenPrimarySortDirty;
|
|
133
|
+
private childrenSortedByPrimaryAxis;
|
|
134
|
+
renderBefore?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
135
|
+
renderAfter?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
136
|
+
constructor(ctx: RenderContext, options: RenderableOptions<any>);
|
|
137
|
+
get ctx(): RenderContext;
|
|
138
|
+
get visible(): boolean;
|
|
139
|
+
set visible(value: boolean);
|
|
140
|
+
hasSelection(): boolean;
|
|
141
|
+
onSelectionChanged(selection: Selection | null): boolean;
|
|
142
|
+
getSelectedText(): string;
|
|
143
|
+
shouldStartSelection(x: number, y: number): boolean;
|
|
144
|
+
focus(): void;
|
|
145
|
+
blur(): void;
|
|
146
|
+
get focused(): boolean;
|
|
147
|
+
get live(): boolean;
|
|
148
|
+
get liveCount(): number;
|
|
149
|
+
set live(value: boolean);
|
|
150
|
+
protected propagateLiveCount(delta: number): void;
|
|
151
|
+
handleKeyPress?(key: ParsedKey | string): boolean;
|
|
152
|
+
protected get isDirty(): boolean;
|
|
153
|
+
findDescendantById(id: string): Renderable | undefined;
|
|
154
|
+
private markClean;
|
|
155
|
+
requestRender(): void;
|
|
156
|
+
get translateX(): number;
|
|
157
|
+
set translateX(value: number);
|
|
158
|
+
get translateY(): number;
|
|
159
|
+
set translateY(value: number);
|
|
160
|
+
get x(): number;
|
|
161
|
+
set x(value: number);
|
|
162
|
+
get top(): number | "auto" | `${number}%` | undefined;
|
|
163
|
+
set top(value: number | "auto" | `${number}%` | undefined);
|
|
164
|
+
get right(): number | "auto" | `${number}%` | undefined;
|
|
165
|
+
set right(value: number | "auto" | `${number}%` | undefined);
|
|
166
|
+
get bottom(): number | "auto" | `${number}%` | undefined;
|
|
167
|
+
set bottom(value: number | "auto" | `${number}%` | undefined);
|
|
168
|
+
get left(): number | "auto" | `${number}%` | undefined;
|
|
169
|
+
set left(value: number | "auto" | `${number}%` | undefined);
|
|
170
|
+
get y(): number;
|
|
171
|
+
set y(value: number);
|
|
172
|
+
get width(): number;
|
|
173
|
+
set width(value: number | "auto" | `${number}%`);
|
|
174
|
+
get height(): number;
|
|
175
|
+
set height(value: number | "auto" | `${number}%`);
|
|
176
|
+
get zIndex(): number;
|
|
177
|
+
set zIndex(value: number);
|
|
178
|
+
private requestZIndexSort;
|
|
179
|
+
private ensureZIndexSorted;
|
|
180
|
+
getChildrenInViewport(viewport: ViewportBounds, padding?: number, minTriggerSize?: number): Renderable[];
|
|
181
|
+
protected getChildrenSortedByPrimaryAxis(): Renderable[];
|
|
182
|
+
private setupYogaProperties;
|
|
183
|
+
private setupMarginAndPadding;
|
|
184
|
+
set position(positionType: PositionTypeString);
|
|
185
|
+
get overflow(): OverflowString;
|
|
186
|
+
set overflow(overflow: OverflowString);
|
|
187
|
+
setPosition(position: Position): void;
|
|
188
|
+
private updateYogaPosition;
|
|
189
|
+
set flexGrow(grow: number);
|
|
190
|
+
set flexShrink(shrink: number);
|
|
191
|
+
set flexDirection(direction: FlexDirectionString);
|
|
192
|
+
set flexWrap(wrap: WrapString);
|
|
193
|
+
set alignItems(alignItems: AlignString);
|
|
194
|
+
set justifyContent(justifyContent: JustifyString);
|
|
195
|
+
set alignSelf(alignSelf: AlignString);
|
|
196
|
+
set flexBasis(basis: number | "auto" | undefined);
|
|
197
|
+
set minWidth(minWidth: number | `${number}%` | undefined);
|
|
198
|
+
set maxWidth(maxWidth: number | `${number}%` | undefined);
|
|
199
|
+
set minHeight(minHeight: number | `${number}%` | undefined);
|
|
200
|
+
set maxHeight(maxHeight: number | `${number}%` | undefined);
|
|
201
|
+
set margin(margin: number | "auto" | `${number}%` | undefined);
|
|
202
|
+
set marginTop(margin: number | "auto" | `${number}%` | undefined);
|
|
203
|
+
set marginRight(margin: number | "auto" | `${number}%` | undefined);
|
|
204
|
+
set marginBottom(margin: number | "auto" | `${number}%` | undefined);
|
|
205
|
+
set marginLeft(margin: number | "auto" | `${number}%` | undefined);
|
|
206
|
+
set padding(padding: number | `${number}%` | undefined);
|
|
207
|
+
set paddingTop(padding: number | `${number}%` | undefined);
|
|
208
|
+
set paddingRight(padding: number | `${number}%` | undefined);
|
|
209
|
+
set paddingBottom(padding: number | `${number}%` | undefined);
|
|
210
|
+
set paddingLeft(padding: number | `${number}%` | undefined);
|
|
211
|
+
getLayoutNode(): TrackedNode;
|
|
212
|
+
updateFromLayout(): void;
|
|
213
|
+
protected onLayoutResize(width: number, height: number): void;
|
|
214
|
+
protected handleFrameBufferResize(width: number, height: number): void;
|
|
215
|
+
protected createFrameBuffer(): void;
|
|
216
|
+
protected onResize(width: number, height: number): void;
|
|
217
|
+
private replaceParent;
|
|
218
|
+
add(obj: Renderable | VNode<any, any[]>, index?: number): number;
|
|
219
|
+
insertBefore(obj: Renderable | VNode<any, any[]>, anchor?: Renderable): number;
|
|
220
|
+
getRenderable(id: string): Renderable | undefined;
|
|
221
|
+
remove(id: string): void;
|
|
222
|
+
protected onRemove(): void;
|
|
223
|
+
getChildren(): Renderable[];
|
|
224
|
+
getChildrenCount(): number;
|
|
225
|
+
render(buffer: OptimizedBuffer, deltaTime: number): void;
|
|
226
|
+
protected _getChildren(): Renderable[];
|
|
227
|
+
protected onUpdate(deltaTime: number): void;
|
|
228
|
+
protected getScissorRect(): {
|
|
229
|
+
x: number;
|
|
230
|
+
y: number;
|
|
231
|
+
width: number;
|
|
232
|
+
height: number;
|
|
233
|
+
};
|
|
234
|
+
protected renderSelf(buffer: OptimizedBuffer, deltaTime: number): void;
|
|
235
|
+
get isDestroyed(): boolean;
|
|
236
|
+
destroy(): void;
|
|
237
|
+
destroyRecursively(): void;
|
|
238
|
+
protected destroySelf(): void;
|
|
239
|
+
processMouseEvent(event: MouseEvent): void;
|
|
240
|
+
protected onMouseEvent(event: MouseEvent): void;
|
|
241
|
+
set onMouse(handler: ((event: MouseEvent) => void) | undefined);
|
|
242
|
+
set onMouseDown(handler: ((event: MouseEvent) => void) | undefined);
|
|
243
|
+
set onMouseUp(handler: ((event: MouseEvent) => void) | undefined);
|
|
244
|
+
set onMouseMove(handler: ((event: MouseEvent) => void) | undefined);
|
|
245
|
+
set onMouseDrag(handler: ((event: MouseEvent) => void) | undefined);
|
|
246
|
+
set onMouseDragEnd(handler: ((event: MouseEvent) => void) | undefined);
|
|
247
|
+
set onMouseDrop(handler: ((event: MouseEvent) => void) | undefined);
|
|
248
|
+
set onMouseOver(handler: ((event: MouseEvent) => void) | undefined);
|
|
249
|
+
set onMouseOut(handler: ((event: MouseEvent) => void) | undefined);
|
|
250
|
+
set onMouseScroll(handler: ((event: MouseEvent) => void) | undefined);
|
|
251
|
+
set onKeyDown(handler: ((key: ParsedKey) => void) | undefined);
|
|
252
|
+
get onKeyDown(): ((key: ParsedKey) => void) | undefined;
|
|
253
|
+
set onSizeChange(handler: (() => void) | undefined);
|
|
254
|
+
get onSizeChange(): (() => void) | undefined;
|
|
255
|
+
private applyEventOptions;
|
|
256
|
+
}
|
|
257
|
+
export declare class RootRenderable extends Renderable {
|
|
258
|
+
private yogaConfig;
|
|
259
|
+
constructor(ctx: RenderContext);
|
|
260
|
+
protected propagateLiveCount(delta: number): void;
|
|
261
|
+
calculateLayout(): void;
|
|
262
|
+
resize(width: number, height: number): void;
|
|
263
|
+
protected onUpdate(): void;
|
|
264
|
+
protected destroySelf(): void;
|
|
265
|
+
}
|
|
266
|
+
export {};
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
export interface TimelineOptions {
|
|
2
|
+
duration?: number;
|
|
3
|
+
loop?: boolean;
|
|
4
|
+
autoplay?: boolean;
|
|
5
|
+
onComplete?: () => void;
|
|
6
|
+
onPause?: () => void;
|
|
7
|
+
}
|
|
8
|
+
export interface AnimationOptions {
|
|
9
|
+
duration: number;
|
|
10
|
+
ease?: EasingFunctions;
|
|
11
|
+
onUpdate?: (animation: JSAnimation) => void;
|
|
12
|
+
onComplete?: () => void;
|
|
13
|
+
onStart?: () => void;
|
|
14
|
+
onLoop?: () => void;
|
|
15
|
+
loop?: boolean | number;
|
|
16
|
+
loopDelay?: number;
|
|
17
|
+
alternate?: boolean;
|
|
18
|
+
once?: boolean;
|
|
19
|
+
[key: string]: any;
|
|
20
|
+
}
|
|
21
|
+
export interface JSAnimation {
|
|
22
|
+
targets: any[];
|
|
23
|
+
deltaTime: number;
|
|
24
|
+
progress: number;
|
|
25
|
+
currentTime: number;
|
|
26
|
+
}
|
|
27
|
+
interface TimelineItem {
|
|
28
|
+
type: "animation" | "callback" | "timeline";
|
|
29
|
+
startTime: number;
|
|
30
|
+
}
|
|
31
|
+
interface TimelineTimelineItem extends TimelineItem {
|
|
32
|
+
type: "timeline";
|
|
33
|
+
timeline: Timeline;
|
|
34
|
+
timelineStarted?: boolean;
|
|
35
|
+
}
|
|
36
|
+
interface TimelineCallbackItem extends TimelineItem {
|
|
37
|
+
type: "callback";
|
|
38
|
+
callback: () => void;
|
|
39
|
+
executed: boolean;
|
|
40
|
+
}
|
|
41
|
+
interface TimelineAnimationItem extends TimelineItem {
|
|
42
|
+
type: "animation";
|
|
43
|
+
target: any[];
|
|
44
|
+
properties?: Record<string, number>;
|
|
45
|
+
initialValues?: Record<string, number>[];
|
|
46
|
+
duration?: number;
|
|
47
|
+
ease?: keyof typeof easingFunctions;
|
|
48
|
+
loop?: boolean | number;
|
|
49
|
+
loopDelay?: number;
|
|
50
|
+
alternate?: boolean;
|
|
51
|
+
onUpdate?: (animation: JSAnimation) => void;
|
|
52
|
+
onComplete?: () => void;
|
|
53
|
+
onStart?: () => void;
|
|
54
|
+
onLoop?: () => void;
|
|
55
|
+
completed?: boolean;
|
|
56
|
+
started?: boolean;
|
|
57
|
+
currentLoop?: number;
|
|
58
|
+
once?: boolean;
|
|
59
|
+
}
|
|
60
|
+
export type EasingFunctions = keyof typeof easingFunctions;
|
|
61
|
+
declare const easingFunctions: {
|
|
62
|
+
linear: (t: number) => number;
|
|
63
|
+
inQuad: (t: number) => number;
|
|
64
|
+
outQuad: (t: number) => number;
|
|
65
|
+
inOutQuad: (t: number) => number;
|
|
66
|
+
inExpo: (t: number) => number;
|
|
67
|
+
outExpo: (t: number) => number;
|
|
68
|
+
inOutSine: (t: number) => number;
|
|
69
|
+
outBounce: (t: number) => number;
|
|
70
|
+
outElastic: (t: number) => number;
|
|
71
|
+
inBounce: (t: number) => number;
|
|
72
|
+
inCirc: (t: number) => number;
|
|
73
|
+
outCirc: (t: number) => number;
|
|
74
|
+
inOutCirc: (t: number) => number;
|
|
75
|
+
inBack: (t: number, s?: number) => number;
|
|
76
|
+
outBack: (t: number, s?: number) => number;
|
|
77
|
+
inOutBack: (t: number, s?: number) => number;
|
|
78
|
+
};
|
|
79
|
+
export declare class Timeline {
|
|
80
|
+
items: (TimelineAnimationItem | TimelineCallbackItem)[];
|
|
81
|
+
subTimelines: TimelineTimelineItem[];
|
|
82
|
+
currentTime: number;
|
|
83
|
+
isPlaying: boolean;
|
|
84
|
+
isComplete: boolean;
|
|
85
|
+
duration: number;
|
|
86
|
+
loop: boolean;
|
|
87
|
+
synced: boolean;
|
|
88
|
+
private autoplay;
|
|
89
|
+
private onComplete?;
|
|
90
|
+
private onPause?;
|
|
91
|
+
private stateChangeListeners;
|
|
92
|
+
constructor(options?: TimelineOptions);
|
|
93
|
+
addStateChangeListener(listener: (timeline: Timeline) => void): void;
|
|
94
|
+
removeStateChangeListener(listener: (timeline: Timeline) => void): void;
|
|
95
|
+
private notifyStateChange;
|
|
96
|
+
add(target: any, properties: AnimationOptions, startTime?: number | string): this;
|
|
97
|
+
once(target: any, properties: AnimationOptions): this;
|
|
98
|
+
call(callback: () => void, startTime?: number | string): this;
|
|
99
|
+
sync(timeline: Timeline, startTime?: number): this;
|
|
100
|
+
play(): this;
|
|
101
|
+
pause(): this;
|
|
102
|
+
resetItems(): void;
|
|
103
|
+
restart(): this;
|
|
104
|
+
update(deltaTime: number): void;
|
|
105
|
+
}
|
|
106
|
+
declare class TimelineEngine {
|
|
107
|
+
private timelines;
|
|
108
|
+
private renderer;
|
|
109
|
+
private frameCallback;
|
|
110
|
+
private isLive;
|
|
111
|
+
defaults: {
|
|
112
|
+
frameRate: number;
|
|
113
|
+
};
|
|
114
|
+
attach(renderer: any): void;
|
|
115
|
+
detach(): void;
|
|
116
|
+
private updateLiveState;
|
|
117
|
+
private onTimelineStateChange;
|
|
118
|
+
register(timeline: Timeline): void;
|
|
119
|
+
unregister(timeline: Timeline): void;
|
|
120
|
+
clear(): void;
|
|
121
|
+
update(deltaTime: number): void;
|
|
122
|
+
}
|
|
123
|
+
export declare const engine: TimelineEngine;
|
|
124
|
+
export declare function createTimeline(options?: TimelineOptions): Timeline;
|
|
125
|
+
export {};
|
package/ansi.d.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export declare const ANSI: {
|
|
2
|
+
switchToAlternateScreen: string;
|
|
3
|
+
switchToMainScreen: string;
|
|
4
|
+
reset: string;
|
|
5
|
+
hideCursor: string;
|
|
6
|
+
showCursor: string;
|
|
7
|
+
resetCursorColor: string;
|
|
8
|
+
saveCursorState: string;
|
|
9
|
+
restoreCursorState: string;
|
|
10
|
+
queryPixelSize: string;
|
|
11
|
+
scrollDown: (lines: number) => string;
|
|
12
|
+
scrollUp: (lines: number) => string;
|
|
13
|
+
moveCursor: (row: number, col: number) => string;
|
|
14
|
+
moveCursorAndClear: (row: number, col: number) => string;
|
|
15
|
+
clearFromCursor: string;
|
|
16
|
+
setRgbBackground: (r: number, g: number, b: number) => string;
|
|
17
|
+
resetBackground: string;
|
|
18
|
+
enableMouseTracking: string;
|
|
19
|
+
disableMouseTracking: string;
|
|
20
|
+
enableButtonEventTracking: string;
|
|
21
|
+
disableButtonEventTracking: string;
|
|
22
|
+
enableAnyEventTracking: string;
|
|
23
|
+
disableAnyEventTracking: string;
|
|
24
|
+
enableSGRMouseMode: string;
|
|
25
|
+
disableSGRMouseMode: string;
|
|
26
|
+
makeRoomForRenderer: (height: number) => string;
|
|
27
|
+
clearRendererSpace: (height: number) => string;
|
|
28
|
+
};
|
package/buffer.d.ts
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import type { TextBuffer } from "./text-buffer";
|
|
2
|
+
import { RGBA } from "./lib";
|
|
3
|
+
import { type RenderLib } from "./zig";
|
|
4
|
+
import { type Pointer } from "bun:ffi";
|
|
5
|
+
import { type BorderStyle, type BorderSides } from "./lib";
|
|
6
|
+
import { type WidthMethod } from "./types";
|
|
7
|
+
export declare class OptimizedBuffer {
|
|
8
|
+
private static fbIdCounter;
|
|
9
|
+
id: string;
|
|
10
|
+
lib: RenderLib;
|
|
11
|
+
private bufferPtr;
|
|
12
|
+
private _width;
|
|
13
|
+
private _height;
|
|
14
|
+
respectAlpha: boolean;
|
|
15
|
+
private _rawBuffers;
|
|
16
|
+
get ptr(): Pointer;
|
|
17
|
+
get buffers(): {
|
|
18
|
+
char: Uint32Array;
|
|
19
|
+
fg: Float32Array;
|
|
20
|
+
bg: Float32Array;
|
|
21
|
+
attributes: Uint8Array;
|
|
22
|
+
};
|
|
23
|
+
constructor(lib: RenderLib, ptr: Pointer, width: number, height: number, options: {
|
|
24
|
+
respectAlpha?: boolean;
|
|
25
|
+
id?: string;
|
|
26
|
+
});
|
|
27
|
+
static create(width: number, height: number, widthMethod: WidthMethod, options?: {
|
|
28
|
+
respectAlpha?: boolean;
|
|
29
|
+
id?: string;
|
|
30
|
+
}): OptimizedBuffer;
|
|
31
|
+
private coordsToIndex;
|
|
32
|
+
get width(): number;
|
|
33
|
+
get height(): number;
|
|
34
|
+
setRespectAlpha(respectAlpha: boolean): void;
|
|
35
|
+
getNativeId(): string;
|
|
36
|
+
clear(bg?: RGBA): void;
|
|
37
|
+
setCell(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
|
|
38
|
+
setCellWithAlphaBlending(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
|
|
39
|
+
drawText(text: string, x: number, y: number, fg: RGBA, bg?: RGBA, attributes?: number, selection?: {
|
|
40
|
+
start: number;
|
|
41
|
+
end: number;
|
|
42
|
+
bgColor?: RGBA;
|
|
43
|
+
fgColor?: RGBA;
|
|
44
|
+
} | null): void;
|
|
45
|
+
fillRect(x: number, y: number, width: number, height: number, bg: RGBA): void;
|
|
46
|
+
drawFrameBuffer(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
|
|
47
|
+
destroy(): void;
|
|
48
|
+
drawTextBuffer(textBuffer: TextBuffer, x: number, y: number, clipRect?: {
|
|
49
|
+
x: number;
|
|
50
|
+
y: number;
|
|
51
|
+
width: number;
|
|
52
|
+
height: number;
|
|
53
|
+
}): void;
|
|
54
|
+
drawSuperSampleBuffer(x: number, y: number, pixelDataPtr: Pointer, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number): void;
|
|
55
|
+
drawPackedBuffer(dataPtr: Pointer, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number): void;
|
|
56
|
+
resize(width: number, height: number): void;
|
|
57
|
+
drawBox(options: {
|
|
58
|
+
x: number;
|
|
59
|
+
y: number;
|
|
60
|
+
width: number;
|
|
61
|
+
height: number;
|
|
62
|
+
borderStyle?: BorderStyle;
|
|
63
|
+
customBorderChars?: Uint32Array;
|
|
64
|
+
border: boolean | BorderSides[];
|
|
65
|
+
borderColor: RGBA;
|
|
66
|
+
backgroundColor: RGBA;
|
|
67
|
+
shouldFill?: boolean;
|
|
68
|
+
title?: string;
|
|
69
|
+
titleAlignment?: "left" | "center" | "right";
|
|
70
|
+
}): void;
|
|
71
|
+
pushScissorRect(x: number, y: number, width: number, height: number): void;
|
|
72
|
+
popScissorRect(): void;
|
|
73
|
+
clearScissorRects(): void;
|
|
74
|
+
}
|
package/console.d.ts
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { EventEmitter } from "events";
|
|
2
|
+
import type { CliRenderer, ColorInput } from ".";
|
|
3
|
+
import { OptimizedBuffer } from "./buffer";
|
|
4
|
+
import { Capture } from "./lib/output.capture";
|
|
5
|
+
export declare const capture: Capture;
|
|
6
|
+
export declare enum ConsolePosition {
|
|
7
|
+
TOP = "top",
|
|
8
|
+
BOTTOM = "bottom",
|
|
9
|
+
LEFT = "left",
|
|
10
|
+
RIGHT = "right"
|
|
11
|
+
}
|
|
12
|
+
export interface ConsoleOptions {
|
|
13
|
+
position?: ConsolePosition;
|
|
14
|
+
sizePercent?: number;
|
|
15
|
+
zIndex?: number;
|
|
16
|
+
colorInfo?: ColorInput;
|
|
17
|
+
colorWarn?: ColorInput;
|
|
18
|
+
colorError?: ColorInput;
|
|
19
|
+
colorDebug?: ColorInput;
|
|
20
|
+
colorDefault?: ColorInput;
|
|
21
|
+
backgroundColor?: ColorInput;
|
|
22
|
+
startInDebugMode?: boolean;
|
|
23
|
+
title?: string;
|
|
24
|
+
titleBarColor?: ColorInput;
|
|
25
|
+
titleBarTextColor?: ColorInput;
|
|
26
|
+
cursorColor?: ColorInput;
|
|
27
|
+
maxStoredLogs?: number;
|
|
28
|
+
maxDisplayLines?: number;
|
|
29
|
+
}
|
|
30
|
+
export declare class TerminalConsole extends EventEmitter {
|
|
31
|
+
private isVisible;
|
|
32
|
+
private isFocused;
|
|
33
|
+
private renderer;
|
|
34
|
+
private stdinHandler;
|
|
35
|
+
private options;
|
|
36
|
+
private _debugModeEnabled;
|
|
37
|
+
private frameBuffer;
|
|
38
|
+
private consoleX;
|
|
39
|
+
private consoleY;
|
|
40
|
+
private consoleWidth;
|
|
41
|
+
private consoleHeight;
|
|
42
|
+
private scrollTopIndex;
|
|
43
|
+
private isScrolledToBottom;
|
|
44
|
+
private currentLineIndex;
|
|
45
|
+
private _displayLines;
|
|
46
|
+
private _allLogEntries;
|
|
47
|
+
private _needsFrameBufferUpdate;
|
|
48
|
+
private markNeedsRerender;
|
|
49
|
+
private _rgbaInfo;
|
|
50
|
+
private _rgbaWarn;
|
|
51
|
+
private _rgbaError;
|
|
52
|
+
private _rgbaDebug;
|
|
53
|
+
private _rgbaDefault;
|
|
54
|
+
private backgroundColor;
|
|
55
|
+
private _rgbaTitleBar;
|
|
56
|
+
private _rgbaTitleBarText;
|
|
57
|
+
private _title;
|
|
58
|
+
private _rgbaCursor;
|
|
59
|
+
private _positions;
|
|
60
|
+
constructor(renderer: CliRenderer, options?: ConsoleOptions);
|
|
61
|
+
activate(): void;
|
|
62
|
+
deactivate(): void;
|
|
63
|
+
private _handleNewLog;
|
|
64
|
+
private _updateConsoleDimensions;
|
|
65
|
+
private handleStdin;
|
|
66
|
+
private attachStdin;
|
|
67
|
+
private detachStdin;
|
|
68
|
+
private formatTimestamp;
|
|
69
|
+
private formatArguments;
|
|
70
|
+
resize(width: number, height: number): void;
|
|
71
|
+
clear(): void;
|
|
72
|
+
toggle(): void;
|
|
73
|
+
focus(): void;
|
|
74
|
+
blur(): void;
|
|
75
|
+
show(): void;
|
|
76
|
+
hide(): void;
|
|
77
|
+
getCachedLogs(): string;
|
|
78
|
+
private updateFrameBuffer;
|
|
79
|
+
renderToBuffer(buffer: OptimizedBuffer): void;
|
|
80
|
+
setDebugMode(enabled: boolean): void;
|
|
81
|
+
toggleDebugMode(): void;
|
|
82
|
+
private _scrollToBottom;
|
|
83
|
+
private _processLogEntry;
|
|
84
|
+
private _processCachedLogs;
|
|
85
|
+
private saveLogsToFile;
|
|
86
|
+
}
|