@cli-use/tui 0.1.0

package/dist/index-DAO84gkm.d.ts

@@ -0,0 +1,272 @@
+import { ReadStream, WriteStream } from 'node:tty';
+import * as readline from 'node:readline';
+import * as React from 'react';
+
+/**
+ * Terminal cell representation
+ */
+interface Cell {
+    char: string;
+    fg?: number;
+    bg?: number;
+    bold?: boolean;
+    dim?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+}
+/**
+ * Terminal buffer - a 2D grid of cells
+ */
+declare class Buffer {
+    width: number;
+    height: number;
+    cells: Cell[][];
+    constructor(width: number, height: number, cells?: Cell[][]);
+    setCell(x: number, y: number, cell: Cell): void;
+    getCell(x: number, y: number): Cell | undefined;
+    clear(): void;
+    resize(width: number, height: number): void;
+    clone(): Buffer;
+}
+/**
+ * Terminal size
+ */
+interface Size {
+    cols: number;
+    rows: number;
+}
+
+type ProcessStdin = ReadStream & NodeJS.ReadStream;
+type ProcessStdout = WriteStream & NodeJS.WriteStream;
+/**
+ * ANSI escape codes for terminal control
+ */
+declare const ANSI: {
+    readonly CLEAR_SCREEN: "\u001B[2J";
+    readonly RESET_CURSOR: "\u001B[H";
+    readonly ALTERNATE_SCREEN_ENABLE: "\u001B[?1049h";
+    readonly ALTERNATE_SCREEN_DISABLE: "\u001B[?1049l";
+    readonly HIDE_CURSOR: "\u001B[?25l";
+    readonly SHOW_CURSOR: "\u001B[?25h";
+    readonly MOVE_CURSOR: (x: number, y: number) => string;
+    readonly RESET_STYLE: "\u001B[0m";
+    readonly FG_COLOR_256: (color: number) => string;
+    readonly BG_COLOR_256: (color: number) => string;
+    readonly FG_COLOR_RGB: (r: number, g: number, b: number) => string;
+    readonly BG_COLOR_RGB: (r: number, g: number, b: number) => string;
+    readonly BOLD: "\u001B[1m";
+    readonly DIM: "\u001B[2m";
+    readonly ITALIC: "\u001B[3m";
+    readonly UNDERLINE: "\u001B[4m";
+    readonly STRIKETHROUGH: "\u001B[9m";
+    readonly BOLD_OFF: "\u001B[22m";
+    readonly DIM_OFF: "\u001B[22m";
+    readonly ITALIC_OFF: "\u001B[23m";
+    readonly UNDERLINE_OFF: "\u001B[24m";
+    readonly STRIKETHROUGH_OFF: "\u001B[29m";
+};
+/**
+ * Terminal interface - handles low-level terminal I/O
+ */
+declare class Terminal {
+    private stdin;
+    private stdout;
+    private _size;
+    private rawMode;
+    private alternateScreen;
+    constructor(stdin?: ProcessStdin, stdout?: ProcessStdout);
+    get size(): Size;
+    /**
+     * Enable raw mode for character-by-character input
+     */
+    enableRawMode(): void;
+    /**
+     * Disable raw mode
+     */
+    disableRawMode(): void;
+    /**
+     * Enable alternate screen buffer
+     */
+    enableAlternateScreen(): void;
+    /**
+     * Disable alternate screen buffer
+     */
+    disableAlternateScreen(): void;
+    /**
+     * Hide cursor
+     */
+    hideCursor(): void;
+    /**
+     * Show cursor
+     */
+    showCursor(): void;
+    /**
+     * Clear the entire screen
+     */
+    clear(): void;
+    /**
+     * Write buffer to terminal
+     */
+    write(buffer: Buffer): void;
+    /**
+     * Build ANSI style string from cell
+     */
+    private buildStyleString;
+    /**
+     * Set up SIGWINCH handler for terminal resize
+     */
+    onResize(callback: (size: Size) => void): () => void;
+    /**
+     * Set up input handler
+     */
+    onInput(callback: (chunk: Buffer, key: readline.Key) => void): () => void;
+    /**
+     * Clean up terminal state
+     */
+    restore(): void;
+}
+
+/**
+ * Renderer - manages the rendering lifecycle
+ */
+declare class Renderer {
+    private terminal;
+    private buffer?;
+    private previousBuffer?;
+    private currentSize;
+    private running;
+    constructor(terminal?: Terminal);
+    /**
+     * Start the renderer
+     */
+    start(): void;
+    /**
+     * Stop the renderer
+     */
+    stop(): void;
+    /**
+     * Get a writable buffer for the current frame
+     */
+    getBuffer(): Buffer;
+    /**
+     * Present the current buffer to the terminal
+     */
+    present(): void;
+    /**
+     * Get the current terminal size
+     */
+    getSize(): Size;
+    /**
+     * Get the terminal instance for direct access
+     */
+    getTerminal(): Terminal;
+}
+
+interface AppOptions {
+    fullscreen?: boolean;
+    alternateScreen?: boolean;
+    mouseCapture?: boolean;
+}
+/**
+ * useApp - Hook for managing the application lifecycle
+ */
+declare const useApp: (options?: AppOptions) => {
+    renderer: Renderer | null;
+    size: {
+        cols: number;
+        rows: number;
+    };
+    running: boolean;
+    exit: () => void;
+};
+
+interface InputEvent {
+    key: string;
+    name: string;
+    ctrl: boolean;
+    meta: boolean;
+    shift: boolean;
+    sequence: string;
+}
+type InputCallback = (input: InputEvent) => void;
+/**
+ * useInput - Hook for capturing keyboard input
+ */
+declare const useInput: (callback: InputCallback, deps?: any[]) => void;
+/**
+ * useKey - Hook for capturing specific key presses
+ */
+declare const useKey: (keyName: string | string[], callback: () => void, deps?: any[]) => void;
+
+/**
+ * useFocus - Hook for managing focus state in forms and lists
+ */
+declare const useFocus: (initialFocus: number | undefined, itemCount: number) => {
+    focusedIndex: number;
+    focusNext: () => void;
+    focusPrevious: () => void;
+    setFocus: (index: number) => void;
+    isFocused: (index: number) => boolean;
+};
+
+/**
+ * useStdoutDimensions - Hook for getting terminal dimensions
+ */
+declare const useStdoutDimensions: () => {
+    columns: number;
+    rows: number;
+};
+/**
+ * useStdout - Hook for stdout operations
+ */
+declare const useStdout: () => {
+    write: (data: string) => void;
+};
+
+/**
+ * useInterval - Hook for setting up intervals
+ */
+declare const useInterval: (callback: () => void, delay: number | null) => void;
+/**
+ * useTimeout - Hook for setting up timeouts
+ */
+declare const useTimeout: (callback: () => void, delay: number | null) => void;
+
+type AppState = 'idle' | 'loading' | 'success' | 'error';
+/**
+ * useAppState - Hook for managing application state
+ */
+declare const useAppState: (initialState?: AppState) => {
+    state: AppState;
+    error: Error | null;
+    isLoading: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    isIdle: boolean;
+    setLoading: () => void;
+    setSuccess: () => void;
+    setError: (err: Error) => void;
+    setIdle: () => void;
+};
+
+interface ListOptions<T> {
+    initialItems?: T[];
+    initialIndex?: number;
+    loop?: boolean;
+}
+/**
+ * useList - Hook for managing list navigation
+ */
+declare const useList: <T>({ initialItems, initialIndex, loop, }?: ListOptions<T>) => {
+    items: T[];
+    setItems: React.Dispatch<React.SetStateAction<T[]>>;
+    index: number;
+    setIndex: React.Dispatch<React.SetStateAction<number>>;
+    selectedItem: NonNullable<T> | null;
+    next: () => void;
+    previous: () => void;
+    select: (item: T) => void;
+};
+
+export { ANSI as A, Buffer as B, Renderer as R, Terminal as T, useAppState as a, useFocus as b, useInput as c, useInterval as d, useKey as e, useList as f, useStdout as g, useStdoutDimensions as h, useTimeout as i, useApp as u };