@suds-cli/tea 0.0.0 → 0.1.0-alpha.0

package/dist/index.d.ts

@@ -1,12 +1,337 @@
-export { Program, type ProgramOptions } from "./program.js";
-export type { Msg, Cmd, Model, ProgramResult } from "./types.js";
-export { QuitMsg, InterruptMsg, SuspendMsg, ResumeMsg, WindowSizeMsg, FocusMsg, BlurMsg, ClearScreenMsg, EnterAltScreenMsg, ExitAltScreenMsg, EnableMouseCellMotionMsg, EnableMouseAllMotionMsg, DisableMouseMsg, ShowCursorMsg, HideCursorMsg, EnableReportFocusMsg, DisableReportFocusMsg, SetWindowTitleMsg, } from "./messages.js";
-export { KeyMsg, KeyType, type Key, keyToString } from "./keys.js";
-export { MouseMsg, MouseAction, MouseButton, type MouseEvent, } from "./mouse.js";
-export { type InputOptions } from "./input.js";
-export { type TerminalOptions } from "./terminal.js";
-export { type RendererOptions } from "./renderer.js";
-export { type EffectFn } from "./types.js";
-export { batch, sequence, tick, every, quit, msg } from "./commands.js";
-export { clearScreen, enableMouseCellMotion, enableMouseAllMotion, disableMouse, showCursor, hideCursor, setWindowTitle, windowSize, } from "./screen.js";
-//# sourceMappingURL=index.d.ts.map
+import { PlatformAdapter } from '@suds-cli/machine';
+
+/**
+ * Message - any value that triggers an update.
+ */
+/**
+ * @public
+ * Message - must be discriminated for safe matching.
+ */
+type Msg = {
+    readonly _tag: string;
+};
+type Effect<M extends Msg = Msg> = M | M[] | null | undefined;
+/** @public Function producing an effectful message or messages. */
+type EffectFn<M extends Msg = Msg> = () => Effect<M> | Promise<Effect<M>>;
+/**
+ * @public
+ * Command - an async side effect that eventually yields a message.
+ * Use `null` to indicate no-op.
+ */
+type Cmd<M extends Msg = Msg> = EffectFn<M> | null;
+/**
+ * @public
+ * Elm-like model contract.
+ */
+interface Model<M extends Msg = Msg, Self extends Model<M, Self> = any> {
+    init(): Cmd<M>;
+    update(msg: M): [Self, Cmd<M>];
+    view(): string;
+}
+/** @public Outcome of running a program. */
+type ProgramResult<M extends Model> = {
+    model: M;
+    error?: unknown;
+};
+
+/** @public Configure program runtime options. */
+interface ProgramOptions {
+    altScreen?: boolean;
+    mouseMode?: 'cell' | 'all' | false;
+    platform?: PlatformAdapter;
+    fps?: number;
+    reportFocus?: boolean;
+    bracketedPaste?: boolean;
+}
+/** @public Bubble Tea-style program runner. */
+declare class Program<M extends Model<Msg, M>> {
+    private model;
+    private readonly terminal;
+    private readonly renderer;
+    private readonly opts;
+    private readonly platform;
+    private stopInput?;
+    private running;
+    private queue;
+    private draining;
+    private result;
+    private resolveWait?;
+    constructor(model: M, options?: ProgramOptions);
+    run(): Promise<ProgramResult<M>>;
+    private waitUntilDone;
+    send(msg: Msg): void;
+    quit(): void;
+    kill(): void;
+    private drainQueue;
+    private handleInternal;
+    private runCmd;
+    private setupTerminal;
+    private startInputLoop;
+    private setupSignals;
+    private disposeSignals;
+    private onSigInt;
+    private onSigTerm;
+    private shutdown;
+}
+
+/** @public Request graceful program termination. */
+declare class QuitMsg {
+    readonly _tag = "quit";
+}
+/** @public Interrupt the program (SIGINT). */
+declare class InterruptMsg {
+    readonly _tag = "interrupt";
+}
+/** @public Suspend the program (Ctrl+Z). */
+declare class SuspendMsg {
+    readonly _tag = "suspend";
+}
+/** @public Resume the program after suspension. */
+declare class ResumeMsg {
+    readonly _tag = "resume";
+}
+/** @public Report the current terminal width and height. */
+declare class WindowSizeMsg {
+    readonly width: number;
+    readonly height: number;
+    readonly _tag = "window-size";
+    constructor(width: number, height: number);
+}
+/** @public Terminal focus gained. */
+declare class FocusMsg {
+    readonly _tag = "focus";
+}
+/** @public Terminal focus lost. */
+declare class BlurMsg {
+    readonly _tag = "blur";
+}
+/** @public Clear the terminal screen. */
+declare class ClearScreenMsg {
+    readonly _tag = "clear-screen";
+}
+/** @public Enter the alternate screen buffer. */
+declare class EnterAltScreenMsg {
+    readonly _tag = "enter-alt-screen";
+}
+/** @public Exit the alternate screen buffer. */
+declare class ExitAltScreenMsg {
+    readonly _tag = "exit-alt-screen";
+}
+/** @public Enable cell-based mouse reporting. */
+declare class EnableMouseCellMotionMsg {
+    readonly _tag = "enable-mouse-cell-motion";
+}
+/** @public Enable all-motion mouse reporting. */
+declare class EnableMouseAllMotionMsg {
+    readonly _tag = "enable-mouse-all-motion";
+}
+/** @public Disable mouse reporting. */
+declare class DisableMouseMsg {
+    readonly _tag = "disable-mouse";
+}
+/** @public Show the cursor. */
+declare class ShowCursorMsg {
+    readonly _tag = "show-cursor";
+}
+/** @public Hide the cursor. */
+declare class HideCursorMsg {
+    readonly _tag = "hide-cursor";
+}
+/** @public Enable focus in/out reporting. */
+declare class EnableReportFocusMsg {
+    readonly _tag = "enable-report-focus";
+}
+/** @public Disable focus in/out reporting. */
+declare class DisableReportFocusMsg {
+    readonly _tag = "disable-report-focus";
+}
+/** @public Set the terminal window title. */
+declare class SetWindowTitleMsg {
+    readonly title: string;
+    readonly _tag = "set-window-title";
+    constructor(title: string);
+}
+
+/** @public Known key types parsed from terminal input. */
+declare enum KeyType {
+    Null = "null",
+    Break = "break",
+    Enter = "enter",
+    Backspace = "backspace",
+    Tab = "tab",
+    Esc = "esc",
+    Space = "space",
+    Runes = "runes",
+    Up = "up",
+    Down = "down",
+    Right = "right",
+    Left = "left",
+    ShiftTab = "shift+tab",
+    Home = "home",
+    End = "end",
+    PgUp = "pgup",
+    PgDown = "pgdown",
+    CtrlPgUp = "ctrl+pgup",
+    CtrlPgDown = "ctrl+pgdown",
+    Delete = "delete",
+    Insert = "insert",
+    CtrlUp = "ctrl+up",
+    CtrlDown = "ctrl+down",
+    CtrlRight = "ctrl+right",
+    CtrlLeft = "ctrl+left",
+    CtrlHome = "ctrl+home",
+    CtrlEnd = "ctrl+end",
+    ShiftUp = "shift+up",
+    ShiftDown = "shift+down",
+    ShiftRight = "shift+right",
+    ShiftLeft = "shift+left",
+    ShiftHome = "shift+home",
+    ShiftEnd = "shift+end",
+    CtrlShiftUp = "ctrl+shift+up",
+    CtrlShiftDown = "ctrl+shift+down",
+    CtrlShiftLeft = "ctrl+shift+left",
+    CtrlShiftRight = "ctrl+shift+right",
+    CtrlShiftHome = "ctrl+shift+home",
+    CtrlShiftEnd = "ctrl+shift+end",
+    F1 = "f1",
+    F2 = "f2",
+    F3 = "f3",
+    F4 = "f4",
+    F5 = "f5",
+    F6 = "f6",
+    F7 = "f7",
+    F8 = "f8",
+    F9 = "f9",
+    F10 = "f10",
+    F11 = "f11",
+    F12 = "f12",
+    F13 = "f13",
+    F14 = "f14",
+    F15 = "f15",
+    F16 = "f16",
+    F17 = "f17",
+    F18 = "f18",
+    F19 = "f19",
+    F20 = "f20"
+}
+/** @public Parsed key metadata. */
+interface Key {
+    type: KeyType;
+    runes: string;
+    alt: boolean;
+    paste: boolean;
+}
+/** @public Message representing a parsed key event. */
+declare class KeyMsg {
+    readonly key: Key;
+    readonly _tag = "key";
+    constructor(key: Key);
+    toString(): string;
+}
+/** @public Convert a parsed key to a human-readable string. */
+declare function keyToString(key: Key): string;
+
+/** @public Mouse action type. */
+declare enum MouseAction {
+    Press = "press",
+    Release = "release",
+    Motion = "motion"
+}
+/** @public Mouse button identifiers, including wheels. */
+declare enum MouseButton {
+    None = "none",
+    Left = "left",
+    Middle = "middle",
+    Right = "right",
+    WheelUp = "wheel-up",
+    WheelDown = "wheel-down",
+    WheelLeft = "wheel-left",
+    WheelRight = "wheel-right",
+    Backward = "backward",
+    Forward = "forward",
+    Button10 = "button-10",
+    Button11 = "button-11"
+}
+/** @public Parsed mouse event payload. */
+interface MouseEvent {
+    x: number;
+    y: number;
+    shift: boolean;
+    alt: boolean;
+    ctrl: boolean;
+    action: MouseAction;
+    button: MouseButton;
+}
+/** @public Message representing a parsed mouse event. */
+declare class MouseMsg {
+    readonly event: MouseEvent;
+    readonly _tag = "mouse";
+    constructor(event: MouseEvent);
+    toString(): string;
+}
+
+/** @public Options for the input reader. */
+interface InputOptions {
+    platform?: PlatformAdapter;
+    onMessage: (msg: Msg) => void;
+}
+
+/** @public Options for the terminal controller. */
+interface TerminalOptions {
+    platform?: PlatformAdapter;
+}
+
+/** @public Options for the standard renderer. */
+interface RendererOptions {
+    platform?: PlatformAdapter;
+    fps?: number;
+}
+
+/**
+ * @public
+ * Run multiple commands concurrently and flatten their results.
+ */
+declare function batch<M extends Msg>(...cmds: Array<Cmd<M>>): Cmd<M>;
+/**
+ * @public
+ * Run commands sequentially, preserving order and skipping nulls.
+ */
+declare function sequence<M extends Msg>(...cmds: Array<Cmd<M>>): Cmd<M>;
+/**
+ * @public
+ * Emit a message after a delay.
+ */
+declare function tick<M extends Msg>(ms: number, fn: (t: Date) => M): Cmd<M>;
+/**
+ * @public
+ * Schedule a single message aligned to the next interval boundary.
+ * Call again from your update loop to continue a repeating cadence.
+ */
+declare function every<M extends Msg>(ms: number, fn: (t: Date) => M): Cmd<M>;
+/** @public Lift a message into a command. */
+declare const msg: <M extends Msg>(value: M) => Cmd<M>;
+/** @public Command that emits a QuitMsg. */
+declare const quit: () => Cmd<Msg>;
+
+/** @public Clear the terminal screen. */
+declare const clearScreen: () => Cmd<Msg>;
+/** @public Enable cell-motion mouse reporting. */
+declare const enableMouseCellMotion: () => Cmd<Msg>;
+/** @public Enable all-motion mouse reporting. */
+declare const enableMouseAllMotion: () => Cmd<Msg>;
+/** @public Disable mouse reporting. */
+declare const disableMouse: () => Cmd<Msg>;
+/** @public Show the cursor. */
+declare const showCursor: () => Cmd<Msg>;
+/** @public Hide the cursor. */
+declare const hideCursor: () => Cmd<Msg>;
+/** @public Set the terminal window title. */
+declare const setWindowTitle: (title: string) => Cmd<Msg>;
+/**
+ * @public
+ * Emit the current window size.
+ * @param platform - Optional platform adapter to get terminal size from
+ */
+declare const windowSize: (platform?: PlatformAdapter) => Cmd<Msg>;
+
+export { BlurMsg, ClearScreenMsg, type Cmd, DisableMouseMsg, DisableReportFocusMsg, type EffectFn, EnableMouseAllMotionMsg, EnableMouseCellMotionMsg, EnableReportFocusMsg, EnterAltScreenMsg, ExitAltScreenMsg, FocusMsg, HideCursorMsg, type InputOptions, InterruptMsg, type Key, KeyMsg, KeyType, type Model, MouseAction, MouseButton, type MouseEvent, MouseMsg, type Msg, Program, type ProgramOptions, type ProgramResult, QuitMsg, type RendererOptions, ResumeMsg, SetWindowTitleMsg, ShowCursorMsg, SuspendMsg, type TerminalOptions, WindowSizeMsg, batch, clearScreen, disableMouse, enableMouseAllMotion, enableMouseCellMotion, every, hideCursor, keyToString, msg, quit, sequence, setWindowTitle, showCursor, tick, windowSize };