@opentui/core 0.1.24 → 0.1.26

package/3d.js

@@ -5,7 +5,7 @@ import {
   __export,
   __require,
   __toESM
-} from "./index-0yx9rnxg.js";
+} from "./index-pxa2sv92.js";
 
 // ../../node_modules/omggif/omggif.js
 var require_omggif = __commonJS((exports) => {

package/README.md

@@ -3,7 +3,11 @@
 OpenTUI Core is a TypeScript library for building terminal user interfaces (TUIs). It is currently in
 development and is not ready for production use.
 
-[Getting Started](docs/getting-started.md)
+## Documentation
+
+- [Getting Started](docs/getting-started.md)
+- [Tree-Sitter](docs/tree-sitter.md)
+- [Environment Variables](docs/env-vars.md)
 
 ## Install
 

package/Renderable.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from "events";
 import { type Node as YogaNode } from "yoga-layout";
 import { OptimizedBuffer } from "./buffer";
-import type { ParsedKey } from "./lib/parse.keypress";
+import type { KeyEvent, PasteEvent } from "./lib/KeyHandler";
 import type { Selection } from "./lib/selection";
 import { type AlignString, type FlexDirectionString, type JustifyString, type OverflowString, type PositionTypeString, type WrapString } from "./lib/yoga.options";
 import { type VNode } from "./renderables/composition/vnode";
@@ -77,7 +77,8 @@ export interface RenderableOptions<T extends BaseRenderable = BaseRenderable> ex
     onMouseOver?: (this: T, event: MouseEvent) => void;
     onMouseOut?: (this: T, event: MouseEvent) => void;
     onMouseScroll?: (this: T, event: MouseEvent) => void;
-    onKeyDown?: (key: ParsedKey) => void;
+    onPaste?: (this: T, text: string) => void;
+    onKeyDown?: (key: KeyEvent) => void;
     onSizeChange?: (this: T) => void;
 }
 export declare function isRenderable(obj: any): obj is Renderable;
@@ -97,6 +98,7 @@ export declare abstract class BaseRenderable extends EventEmitter {
     abstract getChildrenCount(): number;
     abstract getRenderable(id: string): BaseRenderable | undefined;
     abstract requestRender(): void;
+    abstract findDescendantById(id: string): BaseRenderable | undefined;
     get id(): string;
     set id(value: string);
     get isDirty(): boolean;
@@ -125,12 +127,14 @@ export declare abstract class Renderable extends BaseRenderable {
     protected frameBuffer: OptimizedBuffer | null;
     protected _focusable: boolean;
     protected _focused: boolean;
-    protected keypressHandler: ((key: ParsedKey) => void) | null;
+    protected keypressHandler: ((key: KeyEvent) => void) | null;
+    protected pasteHandler: ((event: PasteEvent) => void) | null;
     private _live;
     protected _liveCount: number;
     private _sizeChangeListener;
     private _mouseListener;
     private _mouseListeners;
+    private _pasteListener;
     private _keyListeners;
     protected yogaNode: YogaNode;
     protected _positionType: PositionTypeString;
@@ -166,7 +170,8 @@ export declare abstract class Renderable extends BaseRenderable {
     get liveCount(): number;
     set live(value: boolean);
     protected propagateLiveCount(delta: number): void;
-    handleKeyPress?(key: ParsedKey | string): boolean;
+    handleKeyPress?(key: KeyEvent | string): boolean;
+    handlePaste?(text: string): void;
     findDescendantById(id: string): Renderable | undefined;
     requestRender(): void;
     get translateX(): number;
@@ -228,6 +233,11 @@ export declare abstract class Renderable extends BaseRenderable {
     protected onLayoutResize(width: number, height: number): void;
     protected handleFrameBufferResize(width: number, height: number): void;
     protected createFrameBuffer(): void;
+    /**
+     * This will be called during a render pass.
+     * Requesting a render during a render pass will drop the requested render.
+     * If you need to request a render during a render pass, use process.nextTick.
+     */
     protected onResize(width: number, height: number): void;
     private replaceParent;
     private _forceLayoutUpdateFor;
@@ -265,8 +275,10 @@ export declare abstract class Renderable extends BaseRenderable {
     set onMouseOver(handler: ((event: MouseEvent) => void) | undefined);
     set onMouseOut(handler: ((event: MouseEvent) => void) | undefined);
     set onMouseScroll(handler: ((event: MouseEvent) => void) | undefined);
-    set onKeyDown(handler: ((key: ParsedKey) => void) | undefined);
-    get onKeyDown(): ((key: ParsedKey) => void) | undefined;
+    set onPaste(handler: ((text: string) => void) | undefined);
+    get onPaste(): ((text: string) => void) | undefined;
+    set onKeyDown(handler: ((key: KeyEvent) => void) | undefined);
+    get onKeyDown(): ((key: KeyEvent) => void) | undefined;
     set onSizeChange(handler: (() => void) | undefined);
     get onSizeChange(): (() => void) | undefined;
     private applyEventOptions;
@@ -290,13 +302,11 @@ interface RenderCommandRender extends RenderCommandBase {
 }
 export type RenderCommand = RenderCommandPushScissorRect | RenderCommandPopScissorRect | RenderCommandRender;
 export declare class RootRenderable extends Renderable {
-    private yogaConfig;
     private renderList;
     constructor(ctx: RenderContext);
     render(buffer: OptimizedBuffer, deltaTime: number): void;
     protected propagateLiveCount(delta: number): void;
     calculateLayout(): void;
     resize(width: number, height: number): void;
-    protected destroySelf(): void;
 }
 export {};

package/animation/Timeline.d.ts

@@ -1,3 +1,4 @@
+import type { CliRenderer } from "../renderer";
 export interface TimelineOptions {
     duration?: number;
     loop?: boolean;
@@ -111,7 +112,7 @@ declare class TimelineEngine {
     defaults: {
         frameRate: number;
     };
-    attach(renderer: any): void;
+    attach(renderer: CliRenderer): void;
     detach(): void;
     private updateLiveState;
     private onTimelineStateChange;

package/ansi.d.ts

@@ -2,27 +2,12 @@ export declare const ANSI: {
     switchToAlternateScreen: string;
     switchToMainScreen: string;
     reset: string;
-    hideCursor: string;
-    showCursor: string;
-    resetCursorColor: string;
-    saveCursorState: string;
-    restoreCursorState: string;
-    queryPixelSize: string;
     scrollDown: (lines: number) => string;
     scrollUp: (lines: number) => string;
     moveCursor: (row: number, col: number) => string;
     moveCursorAndClear: (row: number, col: number) => string;
-    clearFromCursor: string;
     setRgbBackground: (r: number, g: number, b: number) => string;
     resetBackground: string;
-    enableMouseTracking: string;
-    disableMouseTracking: string;
-    enableButtonEventTracking: string;
-    disableButtonEventTracking: string;
-    enableAnyEventTracking: string;
-    disableAnyEventTracking: string;
-    enableSGRMouseMode: string;
-    disableSGRMouseMode: string;
-    makeRoomForRenderer: (height: number) => string;
-    clearRendererSpace: (height: number) => string;
+    bracketedPasteStart: string;
+    bracketedPasteEnd: string;
 };

package/assets/javascript/highlights.scm

@@ -0,0 +1,205 @@
+; Query from: https://raw.githubusercontent.com/tree-sitter/tree-sitter-javascript/refs/heads/master/queries/highlights.scm
+; Variables
+;----------
+
+(identifier) @variable
+
+; Properties
+;-----------
+
+(property_identifier) @property
+
+; Function and method definitions
+;--------------------------------
+
+(function_expression
+  name: (identifier) @function)
+(function_declaration
+  name: (identifier) @function)
+(method_definition
+  name: (property_identifier) @function.method)
+
+(pair
+  key: (property_identifier) @function.method
+  value: [(function_expression) (arrow_function)])
+
+(assignment_expression
+  left: (member_expression
+    property: (property_identifier) @function.method)
+  right: [(function_expression) (arrow_function)])
+
+(variable_declarator
+  name: (identifier) @function
+  value: [(function_expression) (arrow_function)])
+
+(assignment_expression
+  left: (identifier) @function
+  right: [(function_expression) (arrow_function)])
+
+; Function and method calls
+;--------------------------
+
+(call_expression
+  function: (identifier) @function)
+
+(call_expression
+  function: (member_expression
+    property: (property_identifier) @function.method))
+
+; Special identifiers
+;--------------------
+
+((identifier) @constructor
+ (#match? @constructor "^[A-Z]"))
+
+([
+    (identifier)
+    (shorthand_property_identifier)
+    (shorthand_property_identifier_pattern)
+ ] @constant
+ (#match? @constant "^[A-Z_][A-Z\\d_]+$"))
+
+((identifier) @variable.builtin
+ (#match? @variable.builtin "^(arguments|module|console|window|document)$")
+ (#is-not? local))
+
+((identifier) @function.builtin
+ (#eq? @function.builtin "require")
+ (#is-not? local))
+
+; Literals
+;---------
+
+(this) @variable.builtin
+(super) @variable.builtin
+
+[
+  (true)
+  (false)
+  (null)
+  (undefined)
+] @constant.builtin
+
+(comment) @comment
+
+[
+  (string)
+  (template_string)
+] @string
+
+(regex) @string.special
+(number) @number
+
+; Tokens
+;-------
+
+[
+  ";"
+  (optional_chain)
+  "."
+  ","
+] @punctuation.delimiter
+
+[
+  "-"
+  "--"
+  "-="
+  "+"
+  "++"
+  "+="
+  "*"
+  "*="
+  "**"
+  "**="
+  "/"
+  "/="
+  "%"
+  "%="
+  "<"
+  "<="
+  "<<"
+  "<<="
+  "="
+  "=="
+  "==="
+  "!"
+  "!="
+  "!=="
+  "=>"
+  ">"
+  ">="
+  ">>"
+  ">>="
+  ">>>"
+  ">>>="
+  "~"
+  "^"
+  "&"
+  "|"
+  "^="
+  "&="
+  "|="
+  "&&"
+  "||"
+  "??"
+  "&&="
+  "||="
+  "??="
+] @operator
+
+[
+  "("
+  ")"
+  "["
+  "]"
+  "{"
+  "}"
+]  @punctuation.bracket
+
+(template_substitution
+  "${" @punctuation.special
+  "}" @punctuation.special) @embedded
+
+[
+  "as"
+  "async"
+  "await"
+  "break"
+  "case"
+  "catch"
+  "class"
+  "const"
+  "continue"
+  "debugger"
+  "default"
+  "delete"
+  "do"
+  "else"
+  "export"
+  "extends"
+  "finally"
+  "for"
+  "from"
+  "function"
+  "get"
+  "if"
+  "import"
+  "in"
+  "instanceof"
+  "let"
+  "new"
+  "of"
+  "return"
+  "set"
+  "static"
+  "switch"
+  "target"
+  "throw"
+  "try"
+  "typeof"
+  "var"
+  "void"
+  "while"
+  "with"
+  "yield"
+] @keyword