@visulima/tui 1.0.0-alpha.2 → 1.0.0-alpha.21

package/dist/core/app.d.ts

@@ -1,50 +0,0 @@
-import EventEmitter from "eventemitter3";
-export declare class TuiApp extends EventEmitter {
-    private renderer;
-    private terminal;
-    private backBuffer;
-    private width;
-    private height;
-    private isRunning;
-    private stdoutBuffer;
-    private stderrBuffer;
-    constructor();
-    /** Enters raw mode + alternate screen. Does NOT start any render loop. */
-    start(): void;
-    /** Request a clean exit — restores terminal, stops input, exits the process. */
-    quit(): void;
-    /** Exits raw mode + alternate screen, then flushes any buffered stdout/stderr. */
-    stop(): void;
-    /**
-     * Buffer a write to stdout. While the alternate screen is active, writing
-     * directly would corrupt the TUI. Buffered output is flushed on stop().
-     */
-    writeStdout(text: string): void;
-    /**
-     * Buffer a write to stderr. While the alternate screen is active, writing
-     * directly would corrupt the TUI. Buffered output is flushed on stop().
-     */
-    writeStderr(text: string): void;
-    /** Returns the shared Uint32Array back-buffer (width * height * 2 u32 cells). */
-    getBuffer(): Uint32Array;
-    /** Returns current terminal dimensions. */
-    getSize(): {
-        height: number;
-        width: number;
-    };
-    /** Update terminal dimensions (called on SIGWINCH). */
-    resize(width: number, height: number): void;
-    /**
-     * Callbacks fired on every frame after React paints the buffer but before
-     * the Rust diff engine flushes to stdout. Use for direct buffer painting
-     * that needs to overlay React output (animated graphs, overlays, FPS counters).
-     * Multiple listeners are supported — they fire in registration order.
-     */
-    private beforeFlushListeners;
-    onBeforeFlush(function_: (buffer: Uint32Array, width: number, height: number) => void): () => void;
-    /**
-     * Layout + paint synchronously. Called from the render loop on every dirty frame,
-     * and directly on resize for immediate response.
-     */
-    paintNow(calculateLayout: (w: number, h: number) => void, renderToBuffer: (buf: Uint32Array, w: number, h: number) => void): void;
-}

package/dist/core/cell.d.ts

@@ -1,33 +0,0 @@
-/**
- * 2×u32 per-cell back-buffer layout:
- *   buffer[idx * 2]     = charCode  (Unicode codepoint, u32)
- *   buffer[idx * 2 + 1] = attrCode  = (styles &lt;< 16) | (bg &lt;< 8) | fg
- */
-export declare const Cell: {
-    /** Read bg color from an attr slot value (buffer[idx*2+1]) — bits 15:8 */
-    getBg(attributeSlot: number): number;
-    /** Read the char character from a raw char slot value (buffer[idx*2]) */
-    getChar(charSlot: number): string;
-    /** Read fg color from an attr slot value (buffer[idx*2+1]) — bits 7:0 */
-    getFg(attributeSlot: number): number;
-    /** Read styles bitmask from an attr slot value (buffer[idx*2+1]) — bits 23:16 */
-    getStyles(attributeSlot: number): number;
-    /**
-     * Pack a cell into a [charCode, attrCode] tuple.
-     * charCode = char.codePointAt(0)
-     * attrCode = (styles & 0xFF) &lt;< 16 | (bg & 0xFF) &lt;< 8 | (fg & 0xFF)
-     *
-     * Write to buffer as: buffer[idx*2] = charCode; buffer[idx*2+1] = attrCode
-     */
-    pack(char: string, fg?: number, bg?: number, styles?: number): [number, number];
-};
-export declare const StyleMasks: {
-    BLINK: number;
-    BOLD: number;
-    DIM: number;
-    HIDDEN: number;
-    INVERT: number;
-    ITALIC: number;
-    STRIKETHROUGH: number;
-    UNDERLINE: number;
-};

package/dist/core/inline.d.ts

@@ -1,22 +0,0 @@
-export interface InlineOptions {
-    /** Frames per second. Default: 60 */
-    fps?: number;
-    /**
-     * What to do with the rendered content when the loop stops.
-     * - 'preserve' (default) — content stays in terminal scrollback
-     * - 'destroy'            — content is cleared, terminal looks untouched
-     */
-    onExit?: "preserve" | "destroy";
-    /** Number of terminal rows to reserve. Default: 10 */
-    rows?: number;
-}
-export type InlinePaintFn = (buf: Uint32Array, cols: number, rows: number, frame: number) => void;
-export interface InlineLoop {
-    start: () => void;
-    stop: () => void;
-}
-/**
- * Create an inline render loop. Renders `rows` lines immediately below the
- * current cursor position (no alternate screen).
- */
-export declare function createInlineLoop(paint: InlinePaintFn, options?: InlineOptions): InlineLoop;

package/dist/core/input.d.ts

@@ -1,18 +0,0 @@
-import EventEmitter from "eventemitter3";
-export interface MouseEvent {
-    button: "left" | "right" | "middle" | "scrollUp" | "scrollDown";
-    ctrl: boolean;
-    meta: boolean;
-    shift: boolean;
-    x: number;
-    y: number;
-}
-export declare class InputParser extends EventEmitter {
-    private stdin;
-    private _boundHandleData;
-    private _pasteBuffer;
-    constructor(stdin: NodeJS.ReadStream);
-    start(): void;
-    stop(): void;
-    private handleData;
-}

package/dist/core/native-binding.d.ts

@@ -1,22 +0,0 @@
-export interface TerminalSize {
-    cols: number;
-    rows: number;
-}
-export interface RendererInstance {
-    readonly height: number;
-    render: (backBuffer: Uint32Array) => void;
-    renderDiff: (backBuffer: Uint32Array) => string;
-    resize: (width: number, height: number) => void;
-    setRowOffset: (offset: number) => void;
-    readonly width: number;
-    writeRaw: (data: string) => void;
-}
-export type RendererConstructor = new (width: number, height: number) => RendererInstance;
-export interface TerminalGuardInstance {
-    getSize: () => TerminalSize;
-    leave: () => void;
-}
-export type TerminalGuardConstructor = new (mouse?: boolean | undefined | null) => TerminalGuardInstance;
-export declare const Renderer: RendererConstructor;
-export declare const TerminalGuard: TerminalGuardConstructor;
-export declare const terminalSize: () => TerminalSize;

package/dist/ink/ansi-to-cell.d.ts

@@ -1,5 +0,0 @@
-/**
- * Sentinel value for the trailing cell of a wide (fullWidth) character.
- * Must be outside Unicode scalar range so it never collides with real text.
- */
-export declare const CONTINUATION_CELL_CODE = 1114112;

package/dist/ink/ansi-tokenizer.d.ts

@@ -1,38 +0,0 @@
-type ControlStringType = "osc" | "dcs" | "pm" | "apc" | "sos";
-type CsiToken = {
-    readonly finalCharacter: string;
-    readonly intermediateString: string;
-    readonly parameterString: string;
-    readonly type: "csi";
-    readonly value: string;
-};
-type EscToken = {
-    readonly finalCharacter: string;
-    readonly intermediateString: string;
-    readonly type: "esc";
-    readonly value: string;
-};
-type ControlStringToken = {
-    readonly type: ControlStringType;
-    readonly value: string;
-};
-type TextToken = {
-    readonly type: "text";
-    readonly value: string;
-};
-type StToken = {
-    readonly type: "st";
-    readonly value: string;
-};
-type C1Token = {
-    readonly type: "c1";
-    readonly value: string;
-};
-type InvalidToken = {
-    readonly type: "invalid";
-    readonly value: string;
-};
-export type AnsiToken = TextToken | CsiToken | EscToken | ControlStringToken | StToken | C1Token | InvalidToken;
-export declare const hasAnsiControlCharacters: (text: string) => boolean;
-export declare const tokenizeAnsi: (text: string) => AnsiToken[];
-export {};

package/dist/ink/clipboard.d.ts

@@ -1,29 +0,0 @@
-/**
- * OSC 52 clipboard protocol utilities.
- *
- * OSC 52 allows terminal applications to read/write the system clipboard
- * via escape sequences. Format: ESC ] 52 ; <target> ; <base64-data> BEL
- * @see https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Operating-System-Commands
- */
-import type { Writable } from "node:stream";
-/**
- * Clipboard targets as defined by the OSC 52 spec.
- * - `c` — system clipboard
- * - `p` — primary selection (X11 only)
- * - `s` — secondary selection (X11 only)
- */
-export type ClipboardTarget = "c" | "p" | "s";
-/**
- * Check whether the current terminal likely supports OSC 52.
- *
- * Detection is best-effort based on `TERM_PROGRAM` and other env vars.
- * Returns `true` for known-supported terminals, `false` otherwise.
- */
-export declare const isOsc52Supported: () => boolean;
-export declare const writeOsc52: (stream: Writable, text: string, target?: ClipboardTarget) => void;
-/**
- * Clear the clipboard via OSC 52.
- * @param stream The writable stream to write the escape sequence to.
- * @param target The clipboard target. Defaults to `"c"`.
- */
-export declare const clearOsc52: (stream: Writable, target?: ClipboardTarget) => void;

package/dist/ink/color-matrix.d.ts

@@ -1,49 +0,0 @@
-/**
- * Color matrix transforms for color blindness simulation and compensation.
- *
- * Matrices sourced from research by Brettel, Viénot, and Mollon (1997)
- * and Machado, Oliveira, and Fernandes (2009).
- * @see https://www.inf.ufrgs.br/~oliveira/pubs_files/CVD_Simulation/CVD_Simulation.html
- */
-/**
- * 3x3 color transformation matrix operating on linear RGB values (0-255).
- */
-export type ColorMatrix = readonly [readonly [number, number, number], readonly [number, number, number], readonly [number, number, number]];
-export type ColorBlindnessType = "achromatopsia" | "deuteranopia" | "protanopia" | "tritanopia";
-/**
- * Simulation matrices — show how colors appear to users with color vision deficiency.
- */
-export declare const COLOR_BLINDNESS_SIMULATION: Record<ColorBlindnessType, ColorMatrix>;
-/**
- * Compensation matrices — shift colors into a distinguishable range for affected users.
- * These remap problematic colors to alternatives the user can perceive.
- */
-/**
- * Compensation matrices — enhance distinguishability for affected users
- * by redistributing the lost channel's energy into perceivable channels.
- * Based on Daltonization approach (Fidaner et al., 2005).
- */
-export declare const COLOR_BLINDNESS_COMPENSATION: Record<Exclude<ColorBlindnessType, "achromatopsia">, ColorMatrix>;
-/**
- * Identity matrix (no transformation).
- */
-export declare const IDENTITY_MATRIX: ColorMatrix;
-/**
- * Apply a 3x3 color matrix to an RGB triplet.
- * @param r Red channel (0-255)
- * @param g Green channel (0-255)
- * @param b Blue channel (0-255)
- * @param matrix The 3x3 transformation matrix
- * @returns Transformed [r, g, b] triplet, clamped to 0-255
- */
-export declare const applyColorMatrix: (r: number, g: number, b: number, matrix: ColorMatrix) => [number, number, number];
-export declare const hexToRgb: (hex: string) => [number, number, number] | null;
-/**
- * Convert RGB components to a hex color string.
- */
-export declare const rgbToHex: (r: number, g: number, b: number) => string;
-/**
- * Transform a hex color through a color blindness simulation or compensation matrix.
- * Returns the original color if parsing fails.
- */
-export declare const transformHexColor: (hex: string, matrix: ColorMatrix) => string;

package/dist/ink/color-utils.d.ts

@@ -1,30 +0,0 @@
-/**
- * Shared color lookup tables and parsing utilities.
- *
- * Used by styled-line-serializer.ts, styled-line-factory.ts, and output.ts
- * to avoid triplicate color mapping code.
- */
-/** Standard ANSI color names to 0-7 index */
-export declare const NAMED_COLORS: Readonly<Record<string, number>>;
-/** Bright ANSI color names to 8-15 index */
-export declare const BRIGHT_COLORS: Readonly<Record<string, number>>;
-/**
- * Parse a color string into an ANSI 256-color index (0-255).
- * Returns 255 (default) for unrecognized colors.
- */
-export declare const colorToAnsi256: (color: string) => number;
-/**
- * Convert a color string to SGR parameter array for escape sequences.
- * @param color the color string to convert
- * @param isFg true for foreground (30-based), false for background (40-based)
- */
-export declare const colorToSgrParams: (color: string, isFg: boolean) => number[];
-/**
- * Convert a color string to a raw ANSI escape code string.
- */
-export declare const colorToAnsiCode: (color: string, isFg: boolean) => string | undefined;
-/**
- * Convert an ANSI 256-color index to a named color string.
- * Standard colors (0-7) use names; everything else uses ansi256(N).
- */
-export declare const ansi256ToColorName: (index: number) => string;

package/dist/ink/colorize.d.ts

@@ -1,4 +0,0 @@
-type ColorType = "foreground" | "background";
-declare const colorize: (string_: string, color: string | undefined, type: ColorType) => string;
-export declare const getBackgroundColorEscape: (color: string) => string | undefined;
-export default colorize;

package/dist/ink/components/AccessibilityContext.d.ts

@@ -1,4 +0,0 @@
-import type { Context } from "react";
-export declare const accessibilityContext: Context<{
-    isScreenReaderEnabled: boolean;
-}>;

package/dist/ink/components/Alert.d.ts

@@ -1,30 +0,0 @@
-/**
- * Alert component for Ink.
- *
- * Inspired by ink-ui Alert by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-ui
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- */
-import type { ReactElement, ReactNode } from "react";
-import type { Variant } from "./variant-config.d.ts";
-export type AlertVariant = Variant;
-export type Props = {
-    /**
-     * Alert message content.
-     */
-    readonly children: ReactNode;
-    /**
-     * Optional heading displayed above the message.
-     */
-    readonly title?: string;
-    /**
-     * Determines the border color and icon.
-     */
-    readonly variant: AlertVariant;
-};
-/**
- * Renders a bordered alert box with a variant-specific icon, optional title, and message.
- */
-export default function Alert({ children, title, variant }: Props): ReactElement;

package/dist/ink/components/AnimationContext.d.ts

@@ -1,10 +0,0 @@
-import type { Context } from "react";
-type AnimationContextValue = {
-    readonly renderThrottleMs: number;
-    readonly subscribe: (callback: (currentTime: number) => void, interval: number) => {
-        readonly startTime: number;
-        readonly unsubscribe: () => void;
-    };
-};
-declare const animationContext: Context<AnimationContextValue>;
-export default animationContext;

package/dist/ink/components/App.d.ts

@@ -1,19 +0,0 @@
-import type { ReactNode } from "react";
-import React from "react";
-import type { CursorPosition } from "../log-update.d.ts";
-type Props = {
-    readonly children: ReactNode;
-    readonly exitOnCtrlC: boolean;
-    readonly interactive: boolean;
-    readonly onExit: (errorOrResult?: unknown) => void;
-    readonly onWaitUntilRenderFlush: () => Promise<void>;
-    readonly renderThrottleMs: number;
-    readonly setCursorPosition: (position: CursorPosition | undefined) => void;
-    readonly stderr: NodeJS.WriteStream;
-    readonly stdin: NodeJS.ReadStream;
-    readonly stdout: NodeJS.WriteStream;
-    readonly writeToStderr: (data: string) => void;
-    readonly writeToStdout: (data: string) => void;
-};
-declare const _default: React.FC<Props>;
-export default _default;

package/dist/ink/components/AppContext.d.ts

@@ -1,38 +0,0 @@
-import type { Context } from "react";
-export type Props = {
-    /**
-     * Exit (unmount) the whole Ink app.
-     *
-     * - `exit()` — resolves `waitUntilExit()` with `undefined`.
-     * - `exit(new Error('…'))` — rejects `waitUntilExit()` with the error.
-     * - `exit(value)` — resolves `waitUntilExit()` with `value`.
-     */
-    readonly exit: (errorOrResult?: Error | unknown) => void;
-    /**
-     * Returns a promise that settles after pending render output is flushed to stdout.
-     * @example
-     * ```jsx
-     * import {useEffect} from 'react';
-    * import {useApp} from 'ink';
-     
-    const Example = () => {
-        const {waitUntilRenderFlush} = useApp();
-     
-        useEffect(() => {
-            void (async () => {
-                await waitUntilRenderFlush();
-                runNextCommand();
-            })();
-        }, [waitUntilRenderFlush]);
-     
-        return …;
-    };
-    ```
-     */
-    readonly waitUntilRenderFlush: () => Promise<void>;
-};
-/**
- * `AppContext` is a React context that exposes lifecycle methods for the app.
- */
-declare const AppContext: Context<Props>;
-export default AppContext;

package/dist/ink/components/BackgroundContext.d.ts

@@ -1,5 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { Context } from "react";
-import type { LiteralUnion } from "type-fest";
-export type BackgroundColor = LiteralUnion<AnsiColors, string>;
-export declare const backgroundContext: Context<BackgroundColor | undefined>;

package/dist/ink/components/Badge.d.ts

@@ -1,27 +0,0 @@
-/**
- * Badge component for Ink.
- *
- * Inspired by ink-ui Badge by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-ui
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- */
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-export type Props = {
-    /**
-     * Label content. Strings are automatically uppercased.
-     */
-    readonly children: ReactNode;
-    /**
-     * Background color for the badge.
-     * @default "magenta"
-     */
-    readonly color?: LiteralUnion<AnsiColors, string>;
-};
-/**
- * Renders an uppercase colored label badge, useful for status indicators.
- */
-export default function Badge({ children, color }: Props): ReactElement;

package/dist/ink/components/BigText.d.ts

@@ -1,71 +0,0 @@
-import type { ReactElement } from "react";
-/**
- * Available CFonts font faces.
- */
-type Font = "3d" | "block" | "chrome" | "grid" | "huge" | "pallet" | "shade" | "simple" | "simple3d" | "simpleBlock" | "slick" | "tiny";
-/**
- * Horizontal text alignment.
- */
-type Align = "center" | "left" | "right";
-/**
- * Terminal background color names supported by CFonts.
- */
-type BackgroundColor = "black" | "blue" | "cyan" | "green" | "magenta" | "red" | "transparent" | "white" | "yellow";
-type Props = {
-    /**
-     * Horizontal alignment of the text.
-     * @default "left"
-     */
-    readonly align?: Align;
-    /**
-     * Background color.
-     * @default "transparent"
-     */
-    readonly backgroundColor?: BackgroundColor;
-    /**
-     * Colors to use for the font. Accepts color names, hex values, or `"system"` for terminal default.
-     * @default ["system"]
-     */
-    readonly colors?: string[];
-    /**
-     * Font face to use.
-     * @default "block"
-     * @see https://github.com/dominikwilkowski/cfonts#supported-fonts
-     */
-    readonly font?: Font;
-    /**
-     * Letter spacing.
-     * @default 1
-     */
-    readonly letterSpacing?: number;
-    /**
-     * Line height.
-     * @default 1
-     */
-    readonly lineHeight?: number;
-    /**
-     * Maximum character length per line. `0` means no limit.
-     * @default 0
-     */
-    readonly maxLength?: number;
-    /**
-     * Whether to add an empty line on top and at the bottom of the output.
-     * @default true
-     */
-    readonly space?: boolean;
-    /**
-     * The text to render in a large font.
-     */
-    readonly text: string;
-};
-/**
- * Render large terminal text using CFonts.
- * @example
- * ```tsx
- * import { BigText } from "@visulima/tui/ink";
- *
- * <BigText text="Hello" font="block" />
- * ```
- */
-export default function BigText({ align, backgroundColor, colors, font, letterSpacing, lineHeight, maxLength, space, text }: Props): ReactElement;
-export type { Align, BackgroundColor, Font, Props };

package/dist/ink/components/Box.d.ts

@@ -1,58 +0,0 @@
-import type { ForwardRefExoticComponent, PropsWithChildren, ReactNode, RefAttributes } from "react";
-import type { Except } from "type-fest";
-import type { DOMElement } from "../dom.d.ts";
-import type { Styles } from "../styles.d.ts";
-export type Props = Except<Styles, "textWrap"> & {
-    /**
-     * Hide the element from screen readers.
-     */
-    readonly "aria-hidden"?: boolean;
-    /**
-     * A label for the element for screen readers.
-     */
-    readonly "aria-label"?: string;
-    /**
-     * The role of the element.
-     */
-    readonly "aria-role"?: "button" | "checkbox" | "combobox" | "list" | "listbox" | "listitem" | "menu" | "menuitem" | "option" | "progressbar" | "radio" | "radiogroup" | "tab" | "tablist" | "table" | "textbox" | "timer" | "toolbar";
-    /**
-     * The state of the element.
-     */
-    readonly "aria-state"?: {
-        readonly busy?: boolean;
-        readonly checked?: boolean;
-        readonly disabled?: boolean;
-        readonly expanded?: boolean;
-        readonly multiline?: boolean;
-        readonly multiselectable?: boolean;
-        readonly readonly?: boolean;
-        readonly required?: boolean;
-        readonly selected?: boolean;
-    };
-    /**
-     * Whether this element is opaque (prevents rendering of covered content beneath it).
-     * Useful for performance optimization with layered content.
-     */
-    readonly opaque?: boolean;
-    /**
-     * Whether to render a scrollbar for this scrollable element.
-     * Only applies when `overflow` is `'scroll'`. Defaults to `true`.
-     */
-    readonly scrollbar?: boolean;
-    /**
-     * Makes this element sticky within its scroll container.
-     * - `true` or `'top'`: pinned to the top during scroll
-     * - `'bottom'`: pinned to the bottom during scroll
-     */
-    readonly sticky?: boolean | "top" | "bottom";
-    /**
-     * Alternate content to render when this element is in its sticky (pinned) state.
-     * Only applies when `sticky` is set. When omitted, the normal children are used.
-     */
-    readonly stickyChildren?: ReactNode;
-};
-/**
- * `&lt;Box>` is an essential Ink component to build your layout. It's like `&lt;div style="display: flex">` in the browser.
- */
-declare const Box: ForwardRefExoticComponent<PropsWithChildren<Props> & RefAttributes<DOMElement>>;
-export default Box;

package/dist/ink/components/Code.d.ts

@@ -1,46 +0,0 @@
-/**
- * Syntax-highlighted code display component for Ink.
- *
- * Uses Shiki for tokenization and maps themed tokens to colored
- * Ink Text elements for terminal rendering.
- */
-import type { ReactElement } from "react";
-export type Props = {
-    /**
-     * The source code string to highlight.
-     */
-    readonly code: string;
-    /**
-     * Set of line numbers to visually emphasize.
-     */
-    readonly highlightLines?: ReadonlySet<number>;
-    /**
-     * Programming language for syntax highlighting.
-     * Falls back to plain text if the language is unknown.
-     */
-    readonly language?: string;
-    /**
-     * Whether to show line numbers in the gutter.
-     * @default false
-     */
-    readonly showLineNumbers?: boolean;
-    /**
-     * Starting line number (useful for code excerpts).
-     * @default 1
-     */
-    readonly startLine?: number;
-    /**
-     * Shiki theme name.
-     * @default "github-dark-default"
-     */
-    readonly theme?: string;
-};
-/**
- * Render source code with syntax highlighting.
- *
- * ```tsx
- * &lt;Code code="const x = 42;" language="typescript" />
- * &lt;Code code={source} language="python" showLineNumbers />
- * ```
- */
-export default function Code({ code, highlightLines, language, showLineNumbers, startLine, theme }: Props): ReactElement;