@flowtty/core 1.0.0-alpha.1 → 1.0.0-alpha.11

package/dist/backend-CT8SGLO5.d.ts

@@ -0,0 +1,103 @@
+import { t as Buffer } from "./cells-C-GthybI.js";
+//#region src/keys.d.ts
+/**
+ * Every multi-character key name a backend produces. A printable key's name is
+ * the character itself (`' '`, `':'`, `'a'`) — there is no `'space'`, `'enter'`
+ * or `'colon'`. Sequences the key parser does not recognize surface under a
+ * `csi-…` name, which is deliberately not listed here.
+ */
+declare const NAMED_KEYS: readonly ["return", "escape", "tab", "backspace", "delete", "insert", "up", "down", "left", "right", "home", "end", "pageup", "pagedown", "f1", "f2", "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", "f11", "f12", "paste", "wheelup", "wheeldown"];
+type NamedKey = typeof NAMED_KEYS[number];
+/** A key name: a named key, or the character itself for a printable key. The
+ *  `string & {}` arm keeps any character valid while editors still complete the
+ *  named ones — it cannot reject a typo like `'space'`; `TestBackend.press` does. */
+type KeyName = NamedKey | (string & {});
+interface Key {
+  /**
+   * Canonical name of the key. For printable ASCII characters this is the
+   * character itself ('a', '!', ' '). For named keys: 'return', 'escape',
+   * 'tab', 'backspace', 'delete', 'up', 'down', 'left', 'right', 'home',
+   * 'end', 'pageup', 'pagedown'. A bracketed paste is one key named 'paste'
+   * whose content is in `text`. Mouse wheel steps are 'wheelup' / 'wheeldown',
+   * positioned by `x` / `y`.
+   */
+  name: KeyName;
+  /**
+   * Payload of a 'paste' key: the pasted text, line endings normalized to `\n`.
+   * A paste is delivered whole — its newlines and letters are text, never
+   * 'return' or single-letter keys — so an app inserts it instead of acting on it.
+   * Undefined for every other key.
+   */
+  text?: string;
+  /**
+   * Cell under the pointer for a mouse key ('wheelup' / 'wheeldown'): 0-based
+   * column and row, the same coordinates `onLayout` rects use. Undefined for
+   * every other key.
+   */
+  x?: number;
+  y?: number;
+  /** Raw byte sequence as received from the source (empty for synthetic keys). */
+  sequence: string;
+  ctrl: boolean;
+  meta: boolean;
+  shift: boolean;
+}
+//#endregion
+//#region src/backend.d.ts
+interface Backend {
+  size(): {
+    width: number;
+    height: number;
+  };
+  draw(buffer: Buffer): void;
+  /**
+   * Subscribe to raw key events. Returns an unsubscribe function.
+   * Backends without an input source omit this method.
+   */
+  onKey?(handler: (key: Key) => void): () => void;
+  /**
+   * Subscribe to terminal-resize events. Returns an unsubscribe function.
+   * Handlers are called AFTER `size()` reflects the new dimensions.
+   * Backends with fixed dimensions (e.g. the test backend) omit this method.
+   */
+  onResize?(handler: () => void): () => void;
+  dispose?(): void;
+  /**
+   * Append plain (already-styled, ANSI-ready) lines ABOVE the live region.
+   * The lines scroll naturally into the terminal's scrollback. Backends
+   * that own the whole screen (alt-screen TTY) or are headless (TestBackend)
+   * may omit this; components like <Static> check for presence at runtime
+   * and degrade gracefully when absent.
+   */
+  printStatic?(lines: string[]): void;
+  /**
+   * Whether this backend owns the entire render area — i.e. components can
+   * use the full `size()` for layout and overlay larger panels (Menu cascade,
+   * full-screen DialogHost) on top.
+   *
+   *   true  — TtyBackend (alt-screen), TestBackend (full buffer)
+   *   false — @flowtty/inline-tty-backend (only the live region is yours;
+   *           scrollback above is append-only and out of layout control)
+   *
+   * Defaults to `true` when omitted — preserves the behavior of existing
+   * backends that don't declare the flag. Inline-style backends MUST set
+   * it to `false` so capability-sensitive components (e.g. <Menu>) can
+   * refuse to render rather than produce broken overflow UI.
+   */
+  fullScreen?: boolean;
+  /**
+   * Whether this backend can emit OSC 8 terminal hyperlinks (clickable links).
+   *
+   *   true      — TTY backends (alt-screen + inline) wrap linked cells in the
+   *               OSC 8 escape, so a `<Link>` is clickable in supporting terminals.
+   *   omitted   — treated as false. The headless TestBackend and any output that
+   *     /false    can't render clickable links leave them out, so `<Link>` should
+   *               degrade to styled text plus a visible URL.
+   *
+   * Feature-detected like `fullScreen`: components read it (via useBackend())
+   * rather than assuming a capability.
+   */
+  hyperlinks?: boolean;
+}
+//#endregion
+export { NamedKey as a, NAMED_KEYS as i, Key as n, KeyName as r, Backend as t };

package/dist/cells-C-GthybI.d.ts

@@ -0,0 +1,43 @@
+//#region src/colors.d.ts
+declare const NAMED_COLORS: readonly ["black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "gray", "grey", "blackBright", "redBright", "greenBright", "yellowBright", "blueBright", "magentaBright", "cyanBright", "whiteBright"];
+type NamedColor = typeof NAMED_COLORS[number];
+/**
+ * A color value: a named color, or any string for the other accepted forms —
+ * `#rgb`, `#rrggbb`, `rgb(r, g, b)`. The `string & {}` arm keeps those valid
+ * while editors still complete the names. It cannot reject a misspelled name;
+ * the TTY backends report unknown names when they exit.
+ */
+type Color = NamedColor | (string & {});
+//#endregion
+//#region src/cells.d.ts
+interface Style {
+  fg?: Color;
+  bg?: Color;
+  bold?: boolean;
+  dim?: boolean;
+  underline?: boolean;
+  inverse?: boolean;
+  strikethrough?: boolean;
+  /**
+   * Target URL for an OSC 8 terminal hyperlink. Backends that can emit
+   * clickable links (TTY / inline TTY) wrap this cell's char in the hyperlink
+   * escape; backends that can't (headless test surface) ignore it. Carried in
+   * Style so it threads through the same paint + diff path as visual attrs.
+   */
+  link?: string;
+}
+interface Cell {
+  char: string;
+  style: Style;
+}
+declare class Buffer {
+  readonly width: number;
+  readonly height: number;
+  private readonly cells;
+  constructor(width: number, height: number);
+  set(x: number, y: number, char: string, style?: Style): void;
+  get(x: number, y: number): Cell;
+  toString(): string;
+}
+//#endregion
+export { NAMED_COLORS as a, Color as i, Cell as n, NamedColor as o, Style as r, Buffer as t };

package/dist/host/index.d.ts

@@ -1,8 +1,6 @@
-import { C as Container } from '../host-DttBG-OZ.js';
-export { B as BORDER_CHARS, H as HostType, I as Instance, R as Rect, T as TextInstance, Y as Yoga, e as YogaNode, f as appendChild, g as applyProps, h as computeLayout, i as createInstance, j as createTextInstance, k as getYoga, l as insertBefore, m as layoutOf, n as measureText, o as ownText, r as refreshMeasure, p as removeChild } from '../host-DttBG-OZ.js';
-import { B as Buffer } from '../cells-CaXEx4lH.js';
-import 'yoga-layout/load';
-
-declare function paint(container: Container, width: number, height: number): Buffer;
-
-export { Container, paint };
+import { D as getYoga, E as YogaNode, T as Yoga, _ as computeLayout, c as applyProps, d as insertBefore, f as measureText, g as Rect, h as removeChild, i as Instance, l as createInstance, m as refreshMeasure, n as Container, o as TextInstance, p as ownText, r as HostType, s as appendChild, u as createTextInstance, v as layoutOf, y as BORDER_CHARS } from "../host-C98WW3Ai.js";
+import { t as Buffer } from "../cells-C-GthybI.js";
+//#region src/host/paint.d.ts
+export declare function paint(container: Container, width: number, height: number): Buffer;
+//#endregion
+export { BORDER_CHARS, type Container, type HostType, type Instance, type Rect, type TextInstance, type Yoga, type YogaNode, appendChild, applyProps, computeLayout, createInstance, createTextInstance, getYoga, insertBefore, layoutOf, measureText, ownText, refreshMeasure, removeChild };