@opentui/core 0.5.4 → 0.5.6

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.node.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)",
   "license": "MIT",
   "repository": {
@@ -75,13 +75,13 @@
     "web-tree-sitter": "0.25.10"
   },
   "optionalDependencies": {
-    "@opentui/core-darwin-x64": "0.5.4",
-    "@opentui/core-darwin-arm64": "0.5.4",
-    "@opentui/core-linux-x64": "0.5.4",
-    "@opentui/core-linux-arm64": "0.5.4",
-    "@opentui/core-win32-x64": "0.5.4",
-    "@opentui/core-win32-arm64": "0.5.4",
-    "@opentui/core-linux-x64-musl": "0.5.4",
-    "@opentui/core-linux-arm64-musl": "0.5.4"
+    "@opentui/core-darwin-x64": "0.5.6",
+    "@opentui/core-darwin-arm64": "0.5.6",
+    "@opentui/core-linux-x64": "0.5.6",
+    "@opentui/core-linux-arm64": "0.5.6",
+    "@opentui/core-win32-x64": "0.5.6",
+    "@opentui/core-win32-arm64": "0.5.6",
+    "@opentui/core-linux-x64-musl": "0.5.6",
+    "@opentui/core-linux-arm64-musl": "0.5.6"
   }
 }

package/renderables/EmbeddedTerminal.d.ts

@@ -0,0 +1,67 @@
+import { type RenderableOptions, Renderable } from "../Renderable.js";
+import type { KeyEvent, PasteEvent } from "../lib/KeyHandler.js";
+import type { RenderContext } from "../types.js";
+import type { OptimizedBuffer } from "../buffer.js";
+import { type Selection } from "../lib/selection.js";
+export type EmbeddedTerminalDataSource = "input" | "response";
+export interface EmbeddedTerminalOptions extends RenderableOptions<EmbeddedTerminalRenderable> {
+    cols?: number;
+    rows?: number;
+    maxScrollback?: number;
+    onData?: (data: Uint8Array, source: EmbeddedTerminalDataSource) => void;
+    onTerminalResize?: (cols: number, rows: number) => void;
+    onScreenChange?: () => void;
+    selectable?: boolean;
+}
+export type EmbeddedTerminalScreen = {
+    text: string;
+    lines: string[];
+    columns: number;
+    rows: number;
+    cursor: {
+        x: number;
+        y: number;
+        visible: boolean;
+    };
+};
+export declare class EmbeddedTerminalRenderable extends Renderable {
+    selectable: boolean;
+    private readonly lib;
+    private handle;
+    private _onData?;
+    private _onTerminalResize?;
+    private _onScreenChange?;
+    private keyreleaseHandler;
+    private hadRenderHooks;
+    private selection;
+    constructor(ctx: RenderContext, options: EmbeddedTerminalOptions);
+    get onData(): ((data: Uint8Array, source: EmbeddedTerminalDataSource) => void) | undefined;
+    set onData(value: ((data: Uint8Array, source: EmbeddedTerminalDataSource) => void) | undefined);
+    get onTerminalResize(): ((cols: number, rows: number) => void) | undefined;
+    set onTerminalResize(value: ((cols: number, rows: number) => void) | undefined);
+    get onScreenChange(): (() => void) | undefined;
+    set onScreenChange(value: (() => void) | undefined);
+    screen(): EmbeddedTerminalScreen;
+    write(data: string | Uint8Array): void;
+    invalidate(): void;
+    encodeKey(key: KeyEvent): Uint8Array;
+    encodePaste(bytes: Uint8Array): Uint8Array;
+    shouldStartSelection(x: number, y: number): boolean;
+    onSelectionChanged(selection: Selection | null): boolean;
+    hasSelection(): boolean;
+    getSelectedText(): string;
+    focus(): void;
+    blur(): void;
+    handleKeyPress(key: KeyEvent): boolean;
+    handlePaste(event: PasteEvent): void;
+    render(buffer: OptimizedBuffer, deltaTime: number): void;
+    protected onResize(width: number, height: number): void;
+    protected renderSelf(buffer: OptimizedBuffer): void;
+    protected destroySelf(): void;
+    protected onRemove(): void;
+    private setupMouse;
+    private forwardMouse;
+    private flushResponses;
+    private removeKeyreleaseHandler;
+    private send;
+}

package/renderables/index.d.ts

@@ -6,6 +6,7 @@ export * from "./composition/VRenderable.js";
 export * from "./composition/vnode.js";
 export * from "./Diff.js";
 export * from "./EditBufferRenderable.js";
+export * from "./EmbeddedTerminal.js";
 export * from "./FrameBuffer.js";
 export * from "./Input.js";
 export * from "./Image.js";

package/testing.bun.js

@@ -2,11 +2,11 @@
 import {
   ANSI,
   CliRenderer
-} from "./chunk-bun-gvv8cwwz.js";
+} from "./chunk-bun-da1keqyp.js";
 import {
   SystemClock,
   TreeSitterClient
-} from "./chunk-bun-1n307cze.js";
+} from "./chunk-bun-9335djz2.js";
 
 // src/testing/mock-keys.ts
 import { Buffer as Buffer2 } from "buffer";

package/testing.js

@@ -1,11 +1,11 @@
 import {
   ANSI,
   CliRenderer
-} from "./chunk-node-tq0x9mbj.js";
+} from "./chunk-node-ks0581vk.js";
 import {
   SystemClock,
   TreeSitterClient
-} from "./chunk-node-crchpns1.js";
+} from "./chunk-node-2h23nsbj.js";
 
 // src/testing/mock-keys.ts
 import { Buffer as Buffer2 } from "node:buffer";

package/yoga.bun.js

@@ -93,7 +93,7 @@ import {
   WRAP_WRAP_REVERSE,
   Wrap,
   yoga_default
-} from "./chunk-bun-1n307cze.js";
+} from "./chunk-bun-9335djz2.js";
 export {
   yoga_default as default,
   Wrap,

package/yoga.js

@@ -92,7 +92,7 @@ import {
   WRAP_WRAP_REVERSE,
   Wrap,
   yoga_default
-} from "./chunk-node-crchpns1.js";
+} from "./chunk-node-2h23nsbj.js";
 export {
   yoga_default as default,
   Wrap,

package/zig-structs.d.ts

@@ -82,6 +82,8 @@ export declare const LineInfoStruct: import("bun-ffi-structs").DefineStructRetur
 }], readonly ["widthColsMax", "u32"]], {}>;
 export declare const MeasureResultStruct: import("bun-ffi-structs").DefineStructReturnType<[readonly ["lineCount", "u32"], readonly ["widthColsMax", "u32"]], {}>;
 export declare const CursorStateStruct: import("bun-ffi-structs").DefineStructReturnType<[readonly ["x", "u32"], readonly ["y", "u32"], readonly ["visible", "bool_u8"], readonly ["style", "u8"], readonly ["blinking", "bool_u8"], readonly ["r", "f32"], readonly ["g", "f32"], readonly ["b", "f32"], readonly ["a", "f32"]], {}>;
+export declare const EmbeddedTerminalCursorStruct: import("bun-ffi-structs").DefineStructReturnType<[readonly ["x", "u16"], readonly ["y", "u16"], readonly ["hasValue", "bool_u8"], readonly ["visible", "bool_u8"], readonly ["blinking", "bool_u8"], readonly ["wideTail", "bool_u8"], readonly ["style", "u8"], readonly ["colorHasValue", "bool_u8"], readonly ["colorR", "u8"], readonly ["colorG", "u8"], readonly ["colorB", "u8"], readonly ["padding", "u8"]], {}>;
+export declare const EmbeddedTerminalKeyOptionsStruct: import("bun-ffi-structs").DefineStructReturnType<[readonly ["action", "u8"], readonly ["composing", "u8"], readonly ["mods", "u16"], readonly ["consumedMods", "u16"], readonly ["padding", "u16"], readonly ["unshiftedCodepoint", "u32"]], {}>;
 export declare const CursorStyleOptionsStruct: import("bun-ffi-structs").DefineStructReturnType<[readonly ["style", "u8", {
     readonly default: 255;
 }], readonly ["blinking", "u8", {

package/zig.d.ts

@@ -89,6 +89,38 @@ export declare enum NativeClipboardShutdownStatus {
     Ready = 1,
     InvalidHandle = 2
 }
+export type EmbeddedTerminalHandle = NativeHandle<"embedded_terminal">;
+export type EmbeddedTerminalCursor = {
+    x: number;
+    y: number;
+    hasValue: boolean;
+    visible: boolean;
+    blinking: boolean;
+    wideTail: boolean;
+    style: "bar" | "block" | "underline" | "block-hollow";
+    color?: {
+        r: number;
+        g: number;
+        b: number;
+    };
+};
+export type EmbeddedTerminalKey = {
+    action?: "release" | "press" | "repeat";
+    key?: string;
+    mods?: number;
+    consumedMods?: number;
+    composing?: boolean;
+    text?: string;
+    unshiftedCodepoint?: number;
+};
+export type EmbeddedTerminalMouse = {
+    action: "press" | "release" | "motion";
+    button?: "unknown" | "left" | "right" | "middle" | "four" | "five" | "six" | "seven";
+    mods?: number;
+    x: number;
+    y: number;
+    anyButtonPressed?: boolean;
+};
 export declare enum LogLevel {
     Error = 0,
     Warn = 1,
@@ -263,13 +295,13 @@ export interface RenderLib extends AudioEngineLib {
     bufferSetCellWithAlphaBlending: (buffer: OptimizedBufferHandle, x: number, y: number, char: string, color: RGBA, bgColor: RGBA, attributes?: number) => void;
     bufferSetCell: (buffer: OptimizedBufferHandle, x: number, y: number, char: string, color: RGBA, bgColor: RGBA, attributes?: number) => void;
     bufferFillRect: (buffer: OptimizedBufferHandle, x: number, y: number, width: number, height: number, color: RGBA) => void;
-    bufferColorMatrix: (buffer: OptimizedBufferHandle, matrixPtr: Pointer, cellMaskPtr: Pointer, cellMaskCount: number, strength: number, target: TargetChannel) => void;
-    bufferColorMatrixUniform: (buffer: OptimizedBufferHandle, matrixPtr: Pointer, strength: number, target: TargetChannel) => void;
-    bufferDrawSuperSampleBuffer: (buffer: OptimizedBufferHandle, x: number, y: number, pixelDataPtr: Pointer, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number) => void;
+    bufferColorMatrix: (buffer: OptimizedBufferHandle, matrix: Pointer | Float32Array, cellMask: Pointer | Float32Array, cellMaskCount: number, strength: number, target: TargetChannel) => void;
+    bufferColorMatrixUniform: (buffer: OptimizedBufferHandle, matrix: Pointer | Float32Array, strength: number, target: TargetChannel) => void;
+    bufferDrawSuperSampleBuffer: (buffer: OptimizedBufferHandle, x: number, y: number, pixelData: Pointer | Uint8Array, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number) => void;
     bufferDrawImage: (buffer: OptimizedBufferHandle, image: ImageHandle, x: number, y: number, width: number, height: number, pixelWidth: number, pixelHeight: number, sourceX: number, sourceY: number, sourceWidth: number, sourceHeight: number, protocol: ImageRenderProtocol) => boolean;
-    bufferDrawPackedBuffer: (buffer: OptimizedBufferHandle, dataPtr: Pointer, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number) => void;
-    bufferDrawGrayscaleBuffer: (buffer: OptimizedBufferHandle, posX: number, posY: number, intensitiesPtr: Pointer, srcWidth: number, srcHeight: number, fg: RGBA | null, bg: RGBA | null) => void;
-    bufferDrawGrayscaleBufferSupersampled: (buffer: OptimizedBufferHandle, posX: number, posY: number, intensitiesPtr: Pointer, srcWidth: number, srcHeight: number, fg: RGBA | null, bg: RGBA | null) => void;
+    bufferDrawPackedBuffer: (buffer: OptimizedBufferHandle, data: Pointer | Uint8Array, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number) => void;
+    bufferDrawGrayscaleBuffer: (buffer: OptimizedBufferHandle, posX: number, posY: number, intensities: Pointer | Float32Array, srcWidth: number, srcHeight: number, fg: RGBA | null, bg: RGBA | null) => void;
+    bufferDrawGrayscaleBufferSupersampled: (buffer: OptimizedBufferHandle, posX: number, posY: number, intensities: Pointer | Float32Array, srcWidth: number, srcHeight: number, fg: RGBA | null, bg: RGBA | null) => void;
     bufferDrawGrid: (buffer: OptimizedBufferHandle, borderChars: Uint32Array, borderFg: RGBA, borderBg: RGBA, columnOffsets: Int32Array, columnCount: number, rowOffsets: Int32Array, rowCount: number, options: {
         drawInner: boolean;
         drawOuter: boolean;
@@ -683,6 +715,32 @@ export interface RenderLib extends AudioEngineLib {
     destroyNativeRenderable: (handle: NativeRenderableHandle) => void;
     nativeRenderableAttachYogaNode: (handle: NativeRenderableHandle, node: Pointer) => boolean;
     nativeRenderableSetMeasureTarget: (handle: NativeRenderableHandle, kind: NativeMeasureTargetKind, target: NativeMeasureTargetHandle | 0) => boolean;
+    createEmbeddedTerminal: (options: {
+        cols: number;
+        rows: number;
+        maxScrollback?: number;
+    }) => EmbeddedTerminalHandle;
+    destroyEmbeddedTerminal: (handle: EmbeddedTerminalHandle) => void;
+    embeddedTerminalWrite: (handle: EmbeddedTerminalHandle, data: string | Uint8Array) => void;
+    embeddedTerminalResize: (handle: EmbeddedTerminalHandle, cols: number, rows: number) => void;
+    embeddedTerminalInvalidate: (handle: EmbeddedTerminalHandle) => void;
+    embeddedTerminalScroll: (handle: EmbeddedTerminalHandle, delta: number) => void;
+    embeddedTerminalSetSelection: (handle: EmbeddedTerminalHandle, start: {
+        x: number;
+        y: number;
+    }, end: {
+        x: number;
+        y: number;
+    }) => void;
+    embeddedTerminalClearSelection: (handle: EmbeddedTerminalHandle) => void;
+    embeddedTerminalGetSelectedText: (handle: EmbeddedTerminalHandle) => Uint8Array;
+    embeddedTerminalCompose: (handle: EmbeddedTerminalHandle, target: OptimizedBufferHandle, x: number, y: number) => void;
+    embeddedTerminalCursor: (handle: EmbeddedTerminalHandle) => EmbeddedTerminalCursor;
+    embeddedTerminalEncodeKey: (handle: EmbeddedTerminalHandle, key: EmbeddedTerminalKey) => Uint8Array;
+    embeddedTerminalEncodeMouse: (handle: EmbeddedTerminalHandle, mouse: EmbeddedTerminalMouse) => Uint8Array;
+    embeddedTerminalEncodePaste: (handle: EmbeddedTerminalHandle, input: Uint8Array) => Uint8Array;
+    embeddedTerminalEncodeFocus: (handle: EmbeddedTerminalHandle, focused: boolean) => Uint8Array;
+    embeddedTerminalDrainResponses: (handle: EmbeddedTerminalHandle) => Uint8Array;
     onNativeEvent: (name: string, handler: (data: ArrayBuffer) => void) => void;
     onceNativeEvent: (name: string, handler: (data: ArrayBuffer) => void) => void;
     offNativeEvent: (name: string, handler: (data: ArrayBuffer) => void) => void;