@opentui/core 0.0.0-20250923-da12fb15 → 0.0.0-20250924-9d06e8e4

package/lib/KeyHandler.d.ts

@@ -1,18 +1,57 @@
 import { EventEmitter } from "events";
-import { type ParsedKey } from "./parse.keypress";
-export type { ParsedKey };
-type KeyHandlerEventMap = {
-    keypress: [ParsedKey];
-    keyrepeat: [ParsedKey];
-    keyrelease: [ParsedKey];
-    paste: [string];
+import { type KeyEventType, type ParsedKey } from "./parse.keypress";
+export declare class KeyEvent implements ParsedKey {
+    name: string;
+    ctrl: boolean;
+    meta: boolean;
+    shift: boolean;
+    option: boolean;
+    sequence: string;
+    number: boolean;
+    raw: string;
+    eventType: KeyEventType;
+    code?: string;
+    super?: boolean;
+    hyper?: boolean;
+    capsLock?: boolean;
+    numLock?: boolean;
+    baseCode?: number;
+    private _defaultPrevented;
+    constructor(key: ParsedKey);
+    get defaultPrevented(): boolean;
+    preventDefault(): void;
+}
+export declare class PasteEvent {
+    text: string;
+    private _defaultPrevented;
+    constructor(text: string);
+    get defaultPrevented(): boolean;
+    preventDefault(): void;
+}
+export type KeyHandlerEventMap = {
+    keypress: [KeyEvent];
+    keyrepeat: [KeyEvent];
+    keyrelease: [KeyEvent];
+    paste: [PasteEvent];
 };
 export declare class KeyHandler extends EventEmitter<KeyHandlerEventMap> {
-    private stdin;
-    private useKittyKeyboard;
-    private listener;
-    private pasteMode;
-    private pasteBuffer;
+    protected stdin: NodeJS.ReadStream;
+    protected useKittyKeyboard: boolean;
+    protected listener: (key: Buffer) => void;
+    protected pasteMode: boolean;
+    protected pasteBuffer: string[];
     constructor(stdin?: NodeJS.ReadStream, useKittyKeyboard?: boolean);
     destroy(): void;
 }
+/**
+ * This class is used internally by the renderer to ensure global handlers
+ * can preventDefault before renderable handlers process events.
+ */
+export declare class InternalKeyHandler extends KeyHandler {
+    private renderableHandlers;
+    constructor(stdin?: NodeJS.ReadStream, useKittyKeyboard?: boolean);
+    emit<K extends keyof KeyHandlerEventMap>(event: K, ...args: KeyHandlerEventMap[K]): boolean;
+    private emitWithPriority;
+    onInternal<K extends keyof KeyHandlerEventMap>(event: K, handler: (...args: KeyHandlerEventMap[K]) => void): void;
+    offInternal<K extends keyof KeyHandlerEventMap>(event: K, handler: (...args: KeyHandlerEventMap[K]) => void): void;
+}

package/lib/env.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Environment variable registry
+ *
+ * Usage:
+ * ```ts
+ * import { registerEnvVar, env } from "./lib/env.ts";
+ *
+ * // Register environment variables
+ * registerEnvVar({
+ *   name: "DEBUG",
+ *   description: "Enable debug logging",
+ *   type: "boolean",
+ *   default: false
+ * });
+ *
+ * registerEnvVar({
+ *   name: "PORT",
+ *   description: "Server port number",
+ *   type: "number",
+ *   default: 3000
+ * });
+ *
+ * // Access environment variables
+ * if (env.DEBUG) {
+ *   console.log("Debug mode enabled");
+ * }
+ *
+ * const port = env.PORT; // number
+ * ```
+ */
+export interface EnvVarConfig {
+    name: string;
+    description: string;
+    default?: string | boolean | number;
+    type?: "string" | "boolean" | "number";
+}
+export declare const envRegistry: Record<string, EnvVarConfig>;
+export declare function registerEnvVar(config: EnvVarConfig): void;
+export declare function generateEnvMarkdown(): string;
+export declare function generateEnvColored(): string;
+export declare const env: Record<string, string | number | boolean>;

package/lib/index.d.ts

@@ -8,3 +8,4 @@ export * from "./styled-text";
 export * from "./yoga.options";
 export * from "./parse.mouse";
 export * from "./selection";
+export * from "./env";

package/lib/parse.keypress.d.ts

@@ -1,7 +1,7 @@
 import { Buffer } from "node:buffer";
 export declare const nonAlphanumericKeys: string[];
 export type KeyEventType = "press" | "repeat" | "release";
-export type ParsedKey = {
+export interface ParsedKey {
     name: string;
     ctrl: boolean;
     meta: boolean;
@@ -17,7 +17,7 @@ export type ParsedKey = {
     capsLock?: boolean;
     numLock?: boolean;
     baseCode?: number;
-};
+}
 export type ParseKeypressOptions = {
     useKittyKeyboard?: boolean;
 };

package/package.json

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

package/renderables/Input.d.ts

@@ -1,5 +1,5 @@
 import { OptimizedBuffer } from "../buffer";
-import type { ParsedKey } from "../lib/parse.keypress";
+import type { KeyEvent } from "../lib/KeyHandler";
 import { type ColorInput } from "../lib/RGBA";
 import { Renderable, type RenderableOptions } from "../Renderable";
 import type { RenderContext } from "../types";
@@ -56,7 +56,7 @@ export declare class InputRenderable extends Renderable {
     set cursorPosition(position: number);
     insertText(text: string): void;
     deleteCharacter(direction: "backward" | "forward"): void;
-    handleKeyPress(key: ParsedKey | string): boolean;
+    handleKeyPress(key: KeyEvent | string): boolean;
     set maxLength(maxLength: number);
     set backgroundColor(value: ColorInput);
     set textColor(value: ColorInput);

package/renderables/ScrollBar.d.ts

@@ -1,6 +1,6 @@
 import type { OptimizedBuffer } from "../buffer";
 import { RGBA, type ColorInput } from "../lib";
-import type { ParsedKey } from "../lib/parse.keypress";
+import type { KeyEvent } from "../lib/KeyHandler";
 import { Renderable, type RenderableOptions } from "../Renderable";
 import type { RenderContext } from "../types";
 import { SliderRenderable, type SliderOptions } from "./Slider";
@@ -42,7 +42,7 @@ export declare class ScrollBarRenderable extends Renderable {
     private updateSliderFromScrollState;
     scrollBy(delta: number, unit?: ScrollUnit): void;
     private recalculateVisibility;
-    handleKeyPress(key: ParsedKey | string): boolean;
+    handleKeyPress(key: KeyEvent | string): boolean;
 }
 export interface ArrowOptions extends RenderableOptions<ArrowRenderable> {
     direction: "up" | "down" | "left" | "right";

package/renderables/ScrollBox.d.ts

@@ -1,4 +1,4 @@
-import { type ParsedKey } from "../lib";
+import { type KeyEvent } from "../lib";
 import type { Renderable, RenderableOptions } from "../Renderable";
 import type { MouseEvent } from "../renderer";
 import type { RenderContext } from "../types";
@@ -77,7 +77,7 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
     remove(id: string): void;
     getChildren(): Renderable[];
     protected onMouseEvent(event: MouseEvent): void;
-    handleKeyPress(key: ParsedKey | string): boolean;
+    handleKeyPress(key: KeyEvent | string): boolean;
     startAutoScroll(mouseX: number, mouseY: number): void;
     updateAutoScroll(mouseX: number, mouseY: number): void;
     stopAutoScroll(): void;

package/renderables/Select.d.ts

@@ -1,6 +1,6 @@
 import { OptimizedBuffer } from "../buffer";
 import { fonts } from "../lib/ascii.font";
-import type { ParsedKey } from "../lib/parse.keypress";
+import type { KeyEvent } from "../lib/KeyHandler";
 import { type ColorInput } from "../lib/RGBA";
 import { Renderable, type RenderableOptions } from "../Renderable";
 import type { RenderContext } from "../types";
@@ -81,7 +81,7 @@ export declare class SelectRenderable extends Renderable {
     setSelectedIndex(index: number): void;
     private updateScrollOffset;
     protected onResize(width: number, height: number): void;
-    handleKeyPress(key: ParsedKey | string): boolean;
+    handleKeyPress(key: KeyEvent | string): boolean;
     get showScrollIndicator(): boolean;
     set showScrollIndicator(show: boolean);
     get showDescription(): boolean;

package/renderables/TabSelect.d.ts

@@ -1,7 +1,7 @@
 import { Renderable, type RenderableOptions } from "../Renderable";
 import { OptimizedBuffer } from "../buffer";
 import { type ColorInput } from "../lib/RGBA";
-import type { ParsedKey } from "../lib/parse.keypress";
+import type { KeyEvent } from "../lib/KeyHandler";
 import type { RenderContext } from "../types";
 export interface TabSelectOption {
     name: string;
@@ -63,7 +63,7 @@ export declare class TabSelectRenderable extends Renderable {
     protected onResize(width: number, height: number): void;
     setTabWidth(tabWidth: number): void;
     getTabWidth(): number;
-    handleKeyPress(key: ParsedKey | string): boolean;
+    handleKeyPress(key: KeyEvent | string): boolean;
     get options(): TabSelectOption[];
     set options(options: TabSelectOption[]);
     set backgroundColor(color: ColorInput);

package/renderer.d.ts

@@ -8,7 +8,7 @@ import { TerminalConsole, type ConsoleOptions } from "./console";
 import { type MouseEventType, type RawMouseEvent, type ScrollInfo } from "./lib/parse.mouse";
 import { Selection } from "./lib/selection";
 import { EventEmitter } from "events";
-import { KeyHandler } from "./lib/KeyHandler";
+import { KeyHandler, InternalKeyHandler } from "./lib/KeyHandler";
 export interface CliRendererConfig {
     stdin?: NodeJS.ReadStream;
     stdout?: NodeJS.WriteStream;
@@ -160,6 +160,7 @@ export declare class CliRenderer extends EventEmitter implements RenderContext {
     get resolution(): PixelResolution | null;
     get console(): TerminalConsole;
     get keyInput(): KeyHandler;
+    get _internalKeyInput(): InternalKeyHandler;
     get terminalWidth(): number;
     get terminalHeight(): number;
     get useThread(): boolean;

package/testing.js

@@ -3,7 +3,7 @@ import {
   ANSI,
   CliRenderer,
   resolveRenderLib
-} from "./index-ce0mn4wa.js";
+} from "./index-bq6h36ne.js";
 
 // src/testing/mock-keys.ts
 var KeyCodes = {

package/types.d.ts

@@ -2,7 +2,7 @@ import type { RGBA } from "./lib/RGBA";
 import type { EventEmitter } from "events";
 import type { Selection } from "./lib/selection";
 import type { Renderable } from "./Renderable";
-import type { KeyHandler } from "./lib";
+import type { InternalKeyHandler, KeyHandler } from "./lib/KeyHandler";
 export declare const TextAttributes: {
     NONE: number;
     BOLD: number;
@@ -54,6 +54,7 @@ export interface RenderContext extends EventEmitter {
     unregisterLifecyclePass: (renderable: Renderable) => void;
     getLifecyclePasses: () => Set<Renderable>;
     keyInput: KeyHandler;
+    _internalKeyInput: InternalKeyHandler;
 }
 export type Timeout = ReturnType<typeof setTimeout> | undefined;
 export interface ViewportBounds {