@opentui/core 0.1.12 → 0.1.14

package/lib/KeyHandler.d.ts

@@ -1,6 +1,11 @@
 import { EventEmitter } from "events";
-export declare class KeyHandler extends EventEmitter {
+import { type ParsedKey } from "./parse.keypress";
+type KeyHandlerEventMap = {
+    keypress: [ParsedKey];
+};
+export declare class KeyHandler extends EventEmitter<KeyHandlerEventMap> {
     constructor();
     destroy(): void;
 }
 export declare function getKeyHandler(): KeyHandler;
+export {};

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "OpenTUI is a TypeScript library for building terminal user interfaces (TUIs)",
   "license": "MIT",
   "repository": {
@@ -38,11 +38,11 @@
     "bun-webgpu": "0.1.3",
     "planck": "^1.4.2",
     "three": "0.177.0",
-    "@opentui/core-darwin-x64": "0.1.12",
-    "@opentui/core-darwin-arm64": "0.1.12",
-    "@opentui/core-linux-x64": "0.1.12",
-    "@opentui/core-linux-arm64": "0.1.12",
-    "@opentui/core-win32-x64": "0.1.12",
-    "@opentui/core-win32-arm64": "0.1.12"
+    "@opentui/core-darwin-x64": "0.1.14",
+    "@opentui/core-darwin-arm64": "0.1.14",
+    "@opentui/core-linux-x64": "0.1.14",
+    "@opentui/core-linux-arm64": "0.1.14",
+    "@opentui/core-win32-x64": "0.1.14",
+    "@opentui/core-win32-arm64": "0.1.14"
   }
 }

package/renderables/Box.d.ts

@@ -3,7 +3,7 @@ import type { OptimizedBuffer } from "../buffer";
 import { type BorderCharacters, type BorderSides, type BorderSidesConfig, type BorderStyle } from "../lib";
 import { type ColorInput, RGBA } from "../lib/RGBA";
 import type { RenderContext } from "../types";
-export interface BoxOptions extends RenderableOptions<BoxRenderable> {
+export interface BoxOptions<TRenderable extends Renderable = BoxRenderable> extends RenderableOptions<TRenderable> {
     backgroundColor?: string | RGBA;
     borderStyle?: BorderStyle;
     border?: boolean | BorderSides[];
@@ -56,6 +56,12 @@ export declare class BoxRenderable extends Renderable {
     get titleAlignment(): "left" | "center" | "right";
     set titleAlignment(value: "left" | "center" | "right");
     protected renderSelf(buffer: OptimizedBuffer): void;
+    protected getScissorRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
     private applyYogaBorders;
     private applyYogaGap;
     set gap(gap: number | `${number}%` | undefined);

package/renderables/Text.d.ts

@@ -24,11 +24,24 @@ export declare class TextRenderable extends Renderable {
     private textBuffer;
     private _plainText;
     private _lineInfo;
+    protected _defaultOptions: {
+        content: string;
+        fg: RGBA;
+        bg: RGBA;
+        selectionBg: undefined;
+        selectionFg: undefined;
+        selectable: true;
+        attributes: number;
+    };
     constructor(ctx: RenderContext, options: TextOptions);
     get content(): StyledText;
     set content(value: StyledText | string);
     get fg(): RGBA;
     set fg(value: RGBA | string | undefined);
+    get selectionBg(): RGBA | undefined;
+    set selectionBg(value: RGBA | string | undefined);
+    get selectionFg(): RGBA | undefined;
+    set selectionFg(value: RGBA | string | undefined);
     get bg(): RGBA;
     set bg(value: RGBA | string | undefined);
     get attributes(): number;

package/renderables/composition/constructs.d.ts

@@ -1,8 +1,6 @@
-import { ASCIIFontRenderable, BoxRenderable, GroupRenderable, InputRenderable, SelectRenderable, TabSelectRenderable, TextRenderable, VRenderable, type ASCIIFontOptions, type BoxOptions, type TextOptions, type VRenderableOptions, type InputRenderableOptions, type SelectRenderableOptions, type TabSelectRenderableOptions, FrameBufferRenderable, type FrameBufferOptions } from "../";
-import type { RenderableOptions } from "../../Renderable";
+import { ASCIIFontRenderable, BoxRenderable, InputRenderable, SelectRenderable, TabSelectRenderable, TextRenderable, VRenderable, type ASCIIFontOptions, type BoxOptions, type TextOptions, type VRenderableOptions, type InputRenderableOptions, type SelectRenderableOptions, type TabSelectRenderableOptions, FrameBufferRenderable, type FrameBufferOptions } from "../";
 import { type VChild, type ProxiedVNode } from "./vnode";
 export declare function Generic(props?: VRenderableOptions, ...children: VChild[]): ProxiedVNode<typeof VRenderable>;
-export declare function Group(props?: RenderableOptions<any>, ...children: VChild[]): ProxiedVNode<typeof GroupRenderable>;
 export declare function Box(props?: BoxOptions, ...children: VChild[]): ProxiedVNode<typeof BoxRenderable>;
 export declare function Text(props?: TextOptions & {
     content?: any;

package/renderables/composition/vnode.d.ts

@@ -28,11 +28,18 @@ export declare function h<P>(type: Construct<P>, props?: P, ...children: VChild[
 export declare function isVNode(node: any): node is VNode;
 export declare function ensureRenderable(ctx: RenderContext, node: Renderable | VNode<any, any[]>): Renderable;
 export declare function wrapWithDelegates<T extends InstanceType<RenderableConstructor>>(instance: T, delegateMap: Record<string, string> | undefined): T;
-export declare function instantiate(ctx: RenderContext, node: VChild): Renderable;
+export type InstantiateFn<NodeType extends VNode | Renderable> = Renderable & {
+    __node?: NodeType;
+};
+export declare function instantiate<NodeType extends VNode | Renderable>(ctx: RenderContext, node: NodeType): InstantiateFn<NodeType>;
 export type DelegateMap<T> = Partial<Record<keyof T, string>>;
-export declare function delegate<TCtor extends RenderableConstructor<any>, K extends keyof InstanceType<TCtor>>(mapping: Partial<Record<K, string>>, vnode: ProxiedVNode<TCtor>): ProxiedVNode<TCtor>;
-export declare function delegate<TCtor extends RenderableConstructor<any>, K extends keyof InstanceType<TCtor>>(mapping: Partial<Record<K, string>>, vnode: VNode<any> & {
-    type: TCtor;
+export type ValidateShape<Given, AllowedKeys> = {
+    [K in keyof Given]: K extends keyof AllowedKeys ? NonNullable<Given[K]> : never;
+};
+type InferNode<T> = T extends InstantiateFn<infer U> ? U : never;
+export declare function delegate<Factory extends InstantiateFn<any>, InnerNode extends InferNode<Factory>, TargetMap extends Record<keyof InnerNode, string>, const Mapping extends Partial<TargetMap>>(mapping: ValidateShape<Mapping, TargetMap>, vnode: Factory): Renderable;
+export declare function delegate<ConstructorType extends RenderableConstructor<any>, TargetMap extends Record<keyof InstanceType<ConstructorType>, string>, const Mapping extends Partial<TargetMap>>(mapping: ValidateShape<Mapping, TargetMap>, vnode: ProxiedVNode<ConstructorType>): ProxiedVNode<ConstructorType>;
+export declare function delegate<ConstructorType extends RenderableConstructor<any>, const Mapping extends DelegateMap<InstanceType<ConstructorType>>>(mapping: ValidateShape<Mapping, string>, vnode: VNode & {
+    type: ConstructorType;
 }): VNode;
-export declare function delegate(mapping: Record<string, string>, vnode: VNode<any>): VNode;
-export declare function delegate(mapping: Record<string, string>, renderable: Renderable): Renderable;
+export {};

package/renderables/index.d.ts

@@ -1,6 +1,5 @@
 export * from "./Box";
 export * from "./FrameBuffer";
-export * from "./Group";
 export * from "./Text";
 export * from "./ASCIIFont";
 export * from "./Input";

package/renderer.d.ts

@@ -133,7 +133,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     addToHitGrid(x: number, y: number, width: number, height: number, id: number): void;
     get widthMethod(): WidthMethod;
     private writeOut;
-    needsUpdate(): void;
+    requestRender(): void;
     get useConsole(): boolean;
     set useConsole(value: boolean);
     get isRunning(): boolean;
@@ -172,6 +172,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
         corner?: DebugOverlayCorner;
     }): void;
     clearTerminal(): void;
+    setTerminalTitle(title: string): void;
     dumpHitGrid(): void;
     dumpBuffers(timestamp?: number): void;
     dumpStdoutBuffer(timestamp?: number): void;
@@ -190,6 +191,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     requestLive(): void;
     dropLive(): void;
     start(): void;
+    auto(): void;
     private internalStart;
     pause(): void;
     private internalPause;

package/types.d.ts

@@ -22,7 +22,7 @@ export interface RenderContext {
     addToHitGrid: (x: number, y: number, width: number, height: number, id: number) => void;
     width: number;
     height: number;
-    needsUpdate: () => void;
+    requestRender: () => void;
     setCursorPosition: (x: number, y: number, visible: boolean) => void;
     setCursorStyle: (style: CursorStyle, blinking: boolean) => void;
     setCursorColor: (color: RGBA) => void;

package/zig.d.ts

@@ -3,6 +3,12 @@ import { type CursorStyle, type DebugOverlayCorner, type WidthMethod } from "./t
 import { RGBA } from "./lib/RGBA";
 import { OptimizedBuffer } from "./buffer";
 import { TextBuffer } from "./text-buffer";
+export declare enum LogLevel {
+    Error = 0,
+    Warn = 1,
+    Info = 2,
+    Debug = 3
+}
 export interface RenderLib {
     createRenderer: (width: number, height: number) => Pointer | null;
     destroyRenderer: (renderer: Pointer, useAlternateScreen: boolean, splitHeight: number) => void;
@@ -14,7 +20,7 @@ export interface RenderLib {
     render: (renderer: Pointer, force: boolean) => void;
     getNextBuffer: (renderer: Pointer) => OptimizedBuffer;
     getCurrentBuffer: (renderer: Pointer) => OptimizedBuffer;
-    createOptimizedBuffer: (width: number, height: number, widthMethod: WidthMethod, respectAlpha?: boolean) => OptimizedBuffer;
+    createOptimizedBuffer: (width: number, height: number, widthMethod: WidthMethod, respectAlpha?: boolean, id?: string) => OptimizedBuffer;
     destroyOptimizedBuffer: (bufferPtr: Pointer) => void;
     drawFrameBuffer: (targetBufferPtr: Pointer, destX: number, destY: number, bufferPtr: Pointer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number) => void;
     getBufferWidth: (buffer: Pointer) => number;
@@ -26,6 +32,7 @@ export interface RenderLib {
     bufferGetAttributesPtr: (buffer: Pointer) => Pointer;
     bufferGetRespectAlpha: (buffer: Pointer) => boolean;
     bufferSetRespectAlpha: (buffer: Pointer, respectAlpha: boolean) => void;
+    bufferGetId: (buffer: Pointer) => string;
     bufferDrawText: (buffer: Pointer, text: string, x: number, y: number, color: RGBA, bgColor?: RGBA, attributes?: number) => void;
     bufferSetCellWithAlphaBlending: (buffer: Pointer, x: number, y: number, char: string, color: RGBA, bgColor: RGBA, attributes?: number) => void;
     bufferFillRect: (buffer: Pointer, x: number, y: number, width: number, height: number, color: RGBA) => void;
@@ -44,6 +51,7 @@ export interface RenderLib {
     setCursorColor: (renderer: Pointer, color: RGBA) => void;
     setDebugOverlay: (renderer: Pointer, enabled: boolean, corner: DebugOverlayCorner) => void;
     clearTerminal: (renderer: Pointer) => void;
+    setTerminalTitle: (renderer: Pointer, title: string) => void;
     addToHitGrid: (renderer: Pointer, x: number, y: number, width: number, height: number, id: number) => void;
     checkHit: (renderer: Pointer, x: number, y: number) => number;
     dumpHitGrid: (renderer: Pointer) => void;
@@ -95,6 +103,9 @@ export interface RenderLib {
         width: number;
         height: number;
     }) => void;
+    bufferPushScissorRect: (buffer: Pointer, x: number, y: number, width: number, height: number) => void;
+    bufferPopScissorRect: (buffer: Pointer) => void;
+    bufferClearScissorRects: (buffer: Pointer) => void;
     getTerminalCapabilities: (renderer: Pointer) => any;
     processCapabilityResponse: (renderer: Pointer, response: string) => void;
 }

package/renderables/Group.d.ts

@@ -1,5 +0,0 @@
-import { Renderable, type RenderableOptions } from "../Renderable";
-import type { RenderContext } from "../types";
-export declare class GroupRenderable extends Renderable {
-    constructor(ctx: RenderContext, options: RenderableOptions);
-}