@alchemy.run/sigil 0.0.0-alpha.1 → 0.0.0-alpha.11

package/dist/index.d.ts

@@ -0,0 +1,1310 @@
+import { a as Multiplexer, c as TerminalAppearance, d as detectCapabilities, f as detectColorLevel, h as detectUnicodeSupport, i as ColorSupportLevel, l as TerminalIdentity, m as detectTerminal, n as ColorInfo, o as PixelGeometry, p as detectHyperlinkSupport, r as ColorSupport, s as RgbColor, t as Capabilities, u as createSupportsColor } from "./detect-Db6GbKOm.js";
+import { n as TerminalProgressState, t as ClipboardSelection } from "./osc-Cn0fw77g.js";
+import { a as getTerminalQuery, i as applyTerminalQuery, n as TerminalQueryOptions, o as queryTerminal, r as TerminalQueryResult, s as refreshTerminalQuery, t as PixelSize } from "./query-BNc2B8GD.js";
+import { i as OutputStream, n as capabilities, r as getCapabilities, t as CapabilitiesStore } from "./store-C1P5fOUi.js";
+import { s as CellStyle, t as ColorProfile } from "./color-profile-CyeHnG1T.js";
+import { s as Paint } from "./paint-Cx-zC_sX.js";
+import { n as Text, r as Styles, t as Props$8 } from "./Text-DV9CuzAT.js";
+import { i as Node } from "./index-DDVME65c.js";
+import { t as CursorPosition } from "./cursor-position-D2LAkRG0.js";
+import { Writable } from "node:stream";
+import { EventEmitter } from "node:events";
+import { Key as Key$1, PropsWithChildren, ReactNode, Ref, RefObject } from "react";
+//#region src/kitty-keyboard.d.ts
+declare const kittyFlags: {
+  readonly disambiguateEscapeCodes: 1;
+  readonly reportEventTypes: 2;
+  readonly reportAlternateKeys: 4;
+  readonly reportAllKeysAsEscapeCodes: 8;
+  readonly reportAssociatedText: 16;
+};
+type KittyFlagName = keyof typeof kittyFlags;
+declare const kittyModifiers: {
+  readonly shift: 1;
+  readonly alt: 2;
+  readonly ctrl: 4;
+  readonly super: 8;
+  readonly hyper: 16;
+  readonly meta: 32;
+  readonly capsLock: 64;
+  readonly numLock: 128;
+};
+type KittyKeyboardOptions = {
+  mode?: "auto" | "enabled" | "disabled";
+  flags?: KittyFlagName[];
+};
+//#endregion
+//#region src/ink.d.ts
+/**
+The origin of a chunk captured by `patchConsole`: a patched `console.*`
+method, or a direct `stdout.write` / `stderr.write` call.
+*/
+type CapturedOutputSource = "console" | "stdio";
+/**
+Performance metrics for a render operation.
+*/
+type RenderMetrics = {
+  /**
+      Time spent rendering in milliseconds.
+      */
+  renderTime: number;
+};
+/**
+A live React terminal runtime for one stdout stream, created by `createInk`.
+*/
+type Ink = {
+  /**
+      Replace the previous root node with a new one or update props of the current root node.
+      */
+  render: (node: ReactNode) => void;
+  /**
+      Unmount the app and release the terminal.
+      */
+  unmount: (error?: Error | number | null) => void;
+  /**
+      Returns a promise that settles when the app is unmounted.
+      */
+  waitUntilExit: () => Promise<unknown>;
+  /**
+      Returns a promise that settles after pending render output is flushed to stdout.
+      */
+  waitUntilRenderFlush: () => Promise<void>;
+  /**
+      Clear output.
+      */
+  clear: () => void;
+  /** Copy text through the renderer-owned terminal session. */
+  copyToClipboard: (text: string, selection?: ClipboardSelection) => boolean;
+  /** Update terminal-native progress through the renderer-owned session. */
+  setProgress: (state: TerminalProgressState, value?: number) => boolean;
+};
+//#endregion
+//#region src/render.d.ts
+type RenderOptions = {
+  /**
+      Output stream where the app will be rendered.
+  
+      @default process.stdout
+      */
+  stdout?: NodeJS.WritableStream;
+  /**
+      Input stream where app will listen for input.
+  
+      @default process.stdin
+      */
+  stdin?: NodeJS.ReadableStream;
+  /**
+      Error stream.
+      @default process.stderr
+      */
+  stderr?: NodeJS.WritableStream;
+  /**
+      If true, each update will be rendered as separate output, without replacing the previous one.
+  
+      @default false
+      */
+  debug?: boolean;
+  /**
+      Configure whether Ink should listen for Ctrl+C keyboard input and exit the app. This is needed in case `process.stdin` is in raw mode, because then Ctrl+C is ignored by default and the process is expected to handle it manually.
+  
+      @default true
+      */
+  exitOnCtrlC?: boolean;
+  /**
+      Patch console methods to ensure console output doesn't mix with Ink's output.
+  
+      Pass `"stdio"` to additionally intercept direct `stdout.write` / `stderr.write` calls on the streams Ink renders to (output from dependencies, native warnings, child tooling). Captured chunks are line-buffered and spliced above the live frame like console output; partial lines are flushed at unmount. Use `onCapturedOutput` to observe captured chunks or take over their display.
+  
+      Note: Once unmount starts, Ink restores the native console (and stream writes) before React cleanup runs. Teardown-time output then follows the normal behavior instead of being rerouted through Ink.
+  
+      @default true
+      */
+  patchConsole?: boolean | "stdio";
+  /**
+      Observe output captured by `patchConsole` before Ink displays it.
+  
+      Receives each captured chunk with its origin (`"console"` or `"stdio"`). Return `true` to take ownership of the chunk: Ink will not display it, so the app can render it itself — for example inside a `<Static>` transcript.
+      */
+  onCapturedOutput?: (stream: "stdout" | "stderr", data: string, source: "console" | "stdio") => boolean | undefined | void;
+  /**
+      Runs the given callback after each render and re-render with render metrics.
+  
+      Note: this callback runs after Ink commits a frame, but it does not wait for `stdout`/`stderr` stream callbacks.
+      To run code after output is flushed, use `waitUntilRenderFlush()`.
+      */
+  onRender?: (metrics: RenderMetrics) => void;
+  /**
+      Enable screen reader support. See https://github.com/vadimdemedes/ink/blob/master/readme.md#screen-reader-support
+  
+      @default process.env['SIGIL_SCREEN_READER'] === 'true'
+      */
+  isScreenReaderEnabled?: boolean;
+  /**
+      Maximum frames per second for render updates.
+      This controls how frequently the UI can update to prevent excessive re-rendering.
+      Higher values allow more frequent updates but may impact performance.
+  
+      @default 30
+      */
+  maxFps?: number;
+  /**
+      Override the output color profile for this render instance. When omitted,
+      the profile follows the capabilities of `stdout` and capability upgrades
+      redraw the live frame. Static content already written to scrollback is not
+      replayed or recolored.
+      */
+  colorProfile?: ColorProfile;
+  /**
+      Enable React Concurrent Rendering mode.
+  
+      When enabled:
+      - Suspense boundaries work correctly with async data
+      - `useTransition` and `useDeferredValue` are fully functional
+      - Updates can be interrupted for higher priority work
+  
+      Note: Concurrent mode changes the timing of renders. Some tests may need to use `act()` to properly await updates. Reusing the same stdout across multiple `render()` calls without unmounting is unsupported. Call `unmount()` first if you need to change the rendering mode or create a fresh instance.
+  
+      @default false
+      */
+  concurrent?: boolean;
+  /**
+      Configure kitty keyboard protocol support for enhanced keyboard input.
+      Enables additional modifiers (super, hyper, capsLock, numLock) and
+      disambiguated key events in terminals that support the protocol.
+  
+      @see https://sw.kovidgoyal.net/kitty/keyboard-protocol/
+      */
+  kittyKeyboard?: KittyKeyboardOptions;
+  /**
+      Override automatic interactive mode detection.
+  
+      By default, Ink detects whether the environment is interactive based on CI detection (the `CI` environment variable) and `stdout.isTTY`. Most users should not need to set this.
+  
+      When non-interactive, Ink disables ANSI erase sequences, cursor manipulation, synchronized output, resize handling, and kitty keyboard auto-detection, writing only the final frame at unmount.
+  
+      Set to `false` to force non-interactive mode or `true` to force interactive mode when the automatic detection doesn't suit your use case.
+  
+      Note: Reusing the same stdout across multiple `render()` calls without unmounting is unsupported. Call `unmount()` first if you need to change this option or create a fresh instance.
+  
+      @default true (false if in CI or `stdout.isTTY` is falsy)
+      */
+  interactive?: boolean;
+  /**
+      Render the app in the terminal's alternate screen buffer. When enabled, the app renders on a separate screen, and the original terminal content is restored when the app exits. This is the same mechanism used by programs like vim, htop, and less.
+  
+      Note: The terminal's scrollback buffer is not available while in the alternate screen. This is standard terminal behavior; programs like vim use the alternate screen specifically to avoid polluting the user's scrollback history.
+  
+      Note: Ink intentionally treats alternate-screen teardown output as disposable. It does not preserve or replay teardown-time frames, hook writes, or `console.*` output after restoring the primary screen.
+  
+      Only works in interactive mode. Ignored when `interactive` is `false` or in a non-interactive environment (CI, piped stdout).
+  
+      Note: Reusing the same stdout across multiple `render()` calls without unmounting is unsupported. Call `unmount()` first if you need to change this option or create a fresh instance.
+  
+      @default false
+      */
+  alternateScreen?: boolean;
+};
+type Instance = {
+  /**
+      Replace the previous root node with a new one or update props of the current root node.
+      */
+  rerender: Ink["render"];
+  /**
+      Manually unmount the whole Ink app.
+      */
+  unmount: Ink["unmount"];
+  /**
+      Returns a promise that settles when the app is unmounted.
+  
+      It resolves with the value passed to `exit(value)` and rejects with the error passed to `exit(error)`.
+      When `unmount()` is called manually, it settles after unmount-related stdout writes complete.
+  
+      @example
+      ```jsx
+      const {unmount, waitUntilExit} = render(<MyApp />);
+  
+      setTimeout(unmount, 1000);
+  
+      await waitUntilExit(); // resolves after `unmount()` is called
+      ```
+      */
+  waitUntilExit: Ink["waitUntilExit"];
+  /**
+      Returns a promise that settles after pending render output is flushed to stdout.
+  
+      This can be used after `rerender()` when you need to run code only after the frame is written.
+  
+      @example
+      ```jsx
+      const {rerender, waitUntilRenderFlush} = render(<MyApp step="loading" />);
+  
+      rerender(<MyApp step="ready" />);
+      await waitUntilRenderFlush(); // output for "ready" is flushed
+  
+      runNextCommand();
+      ```
+      */
+  waitUntilRenderFlush: Ink["waitUntilRenderFlush"];
+  /**
+      Unmount the current app and remove the internal Ink instance for this stdout.
+  
+      This is mostly useful for advanced cases where you need `render()` to create a fresh instance for the same stream without leaving terminal state such as the alternate screen behind.
+      */
+  cleanup: () => void;
+  /**
+      Clear output.
+      */
+  clear: () => void;
+  /** Copy text through the renderer-owned terminal session. */
+  copyToClipboard: (text: string, selection?: ClipboardSelection) => boolean;
+  /** Update terminal-native progress through the renderer-owned session. */
+  setProgress: (state: TerminalProgressState, value?: number) => boolean;
+};
+/**
+Mount a component and render the output.
+*/
+declare const render: (node: ReactNode, options?: Writable | RenderOptions) => Instance;
+//#endregion
+//#region src/render-to-string.d.ts
+type RenderToStringOptions = {
+  /**
+      Width of the virtual terminal in columns.
+  
+      @default 80
+      */
+  columns?: number;
+  /**
+      Color profile used for deterministic serialization. By default this retains
+      the process color level for Ink compatibility.
+      */
+  colorProfile?: ColorProfile;
+};
+/**
+Render a React element to a string synchronously. Unlike `render()`, this function does not write to stdout, does not set up any terminal event listeners, and returns the rendered output as a string.
+
+Useful for generating documentation, writing output to files, testing, or any scenario where you need the rendered output as a string without starting a persistent terminal application.
+
+**Notes:**
+
+- Terminal-specific hooks (`useInput`, `useStdin`, `useStdout`, `useStderr`, `useApp`, `useFocus`, `useFocusManager`) return default no-op values since there is no terminal session. They will not throw, but they will not function as in a live terminal.
+- `useEffect` callbacks will execute during rendering (due to synchronous rendering mode), but state updates they trigger will not affect the returned output, which reflects the initial render.
+- `useLayoutEffect` callbacks fire synchronously during commit, so state updates they trigger **will** be reflected in the output.
+- The `<Static>` component is supported — its output is prepended to the dynamic output.
+- If a component throws during rendering, the error is propagated to the caller after cleanup.
+
+@example
+```
+import {renderToString, Text, Box} from 'ink';
+
+const output = renderToString(
+    <Box padding={1}>
+        <Text color="green">Hello World</Text>
+    </Box>,
+    {columns: 40}
+);
+
+console.log(output);
+```
+*/
+declare const renderToString: (node: ReactNode, options?: RenderToStringOptions) => string;
+//#endregion
+//#region src/semantic-text-style.d.ts
+type SemanticTextStyle = {
+  readonly foreground?: Paint;
+  readonly background?: Paint;
+  readonly resetForeground?: boolean;
+  readonly resetBackground?: boolean;
+  readonly underline?: CellStyle["underline"];
+  readonly attributes: number;
+};
+//#endregion
+//#region src/transform-adapter.d.ts
+type AnsiTransformer = (text: string, line: number) => string;
+//#endregion
+//#region src/dom.d.ts
+type InkNode = {
+  parentNode: DOMElement | undefined;
+  yogaNode?: Node;
+  internal_static?: boolean;
+  style: Styles;
+};
+type LayoutListener = () => void;
+type TextName = "#text";
+type ElementNames = "ink-root" | "ink-box" | "ink-text" | "ink-virtual-text";
+type NodeNames = ElementNames | TextName;
+type DOMElement = {
+  nodeName: ElementNames;
+  attributes: Record<string, DOMNodeAttribute>;
+  childNodes: DOMNode[];
+  internal_ansi?: boolean;
+  internal_transform?: AnsiTransformer;
+  internal_textStyle?: SemanticTextStyle;
+  internal_accessibility?: {
+    role?: "button" | "checkbox" | "combobox" | "list" | "listbox" | "listitem" | "menu" | "menuitem" | "option" | "progressbar" | "radio" | "radiogroup" | "tab" | "tablist" | "table" | "textbox" | "timer" | "toolbar";
+    state?: {
+      busy?: boolean;
+      checked?: boolean;
+      disabled?: boolean;
+      expanded?: boolean;
+      multiline?: boolean;
+      multiselectable?: boolean;
+      readonly?: boolean;
+      required?: boolean;
+      selected?: boolean;
+    };
+  };
+  isStaticDirty?: boolean;
+  staticNode?: DOMElement;
+  previousStaticNode?: DOMElement;
+  onComputeLayout?: () => void;
+  onRender?: () => void;
+  onImmediateRender?: () => void;
+  onStaticChange?: () => void;
+  internal_layoutListeners?: Set<LayoutListener>;
+} & InkNode;
+type TextNode = {
+  nodeName: TextName;
+  nodeValue: string;
+} & InkNode;
+type DOMNode<T = {
+  nodeName: NodeNames;
+}> = T extends {
+  nodeName: infer U;
+} ? U extends "#text" ? TextNode : DOMElement : never;
+type DOMNodeAttribute = boolean | string | number;
+//#endregion
+//#region src/components/Box.d.ts
+type Props$2 = Omit<Styles, "textWrap"> & {
+  /**
+      A label for the element for screen readers.
+      */
+  readonly "aria-label"?: string;
+  /**
+      Hide the element from screen readers.
+      */
+  readonly "aria-hidden"?: boolean;
+  /**
+      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;
+  };
+};
+/**
+`<Box>` is an essential Ink component to build your layout. It's like `<div style="display: flex">` in the browser.
+*/
+declare function Box({ children, ref, backgroundColor, "aria-label": ariaLabel, "aria-hidden": ariaHidden, "aria-role": role, "aria-state": ariaState, ...style }: PropsWithChildren<Props$2> & {
+  readonly ref?: Ref<DOMElement>;
+}): import("react").JSX.Element | null;
+//#endregion
+//#region src/components/AnsiText.d.ts
+type Props = {
+  /** External text containing ANSI SGR styling or OSC 8 hyperlinks. */
+  readonly children: string;
+  readonly wrap?: Styles["textWrap"];
+  readonly "aria-label"?: string;
+  readonly "aria-hidden"?: boolean;
+};
+/**
+ * Renders explicitly trusted ANSI-styled output as structured terminal cells.
+ * Ordinary `Text` continues to strip terminal control sequences.
+ */
+declare function AnsiText({ children, wrap, "aria-label": ariaLabel, "aria-hidden": ariaHidden }: Props): import("react").JSX.Element | null;
+//#endregion
+//#region src/components/AppContext.d.ts
+/**
+A handle returned by `suspendTerminal()` when called without a callback.
+
+Call `resume()` to give terminal ownership back to Ink, or use `await using`
+so the suspension is resumed automatically when it leaves scope.
+*/
+type TerminalSuspension = {
+  readonly resume: () => Promise<void>;
+  readonly [Symbol.asyncDispose]: () => Promise<void>;
+};
+/**
+Temporarily hand the terminal over to a child process (e.g. `$EDITOR`, `less`,
+`fzf`), then restore Ink's terminal state and force a full redraw.
+*/
+type SuspendTerminal = {
+  (callback: () => void | Promise<void>): Promise<void>;
+  (): Promise<TerminalSuspension>;
+};
+type Props$1 = {
+  /**
+      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?: 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>;
+  /**
+      Temporarily release the terminal so a child process can take it over, then
+      restore Ink's terminal state and force a full redraw.
+  
+      Use the callback form for the common case — Ink restores the terminal even
+      if the callback throws:
+  
+      @example
+      ```jsx
+      import {useApp} from 'ink';
+  
+      const {suspendTerminal} = useApp();
+  
+      await suspendTerminal(async () => {
+          await runEditor();
+      });
+      ```
+  
+      Or hold a suspension and resume it yourself:
+  
+      @example
+      ```jsx
+      await using suspension = await suspendTerminal();
+      await runEditor();
+      ```
+      */
+  readonly suspendTerminal: SuspendTerminal;
+};
+//#endregion
+//#region src/components/StdinContext.d.ts
+type PublicProps = {
+  /**
+      The stdin stream passed to `render()` in `options.stdin`, or `process.stdin` by default. Useful if your app needs to handle user input.
+      */
+  readonly stdin: NodeJS.ReadableStream;
+  /**
+      Ink exposes this function via own `<StdinContext>` to be able to handle Ctrl+C, that's why you should use Ink's `setRawMode` instead of `process.stdin.setRawMode`. If the `stdin` stream passed to Ink does not support setRawMode, this function does nothing.
+      */
+  readonly setRawMode: (value: boolean) => void;
+  /**
+      A boolean flag determining if the current `stdin` supports `setRawMode`. A component using `setRawMode` might want to use `isRawModeSupported` to nicely fall back in environments where raw mode is not supported.
+      */
+  readonly isRawModeSupported: boolean;
+};
+//#endregion
+//#region src/components/StdoutContext.d.ts
+type Props$7 = {
+  /**
+      Stdout stream passed to `render()` in `options.stdout` or `process.stdout` by default.
+      */
+  readonly stdout: OutputStream;
+  /**
+      Write any string to stdout while preserving Ink's output. It's useful when you want to display external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to `<Static>`, except it can't accept components; it only works with strings.
+      */
+  readonly write: (data: string) => void;
+};
+//#endregion
+//#region src/components/StderrContext.d.ts
+type Props$6 = {
+  /**
+      Stderr stream passed to `render()` in `options.stderr` or `process.stderr` by default.
+      */
+  readonly stderr: NodeJS.WritableStream;
+  /**
+      Write any string to stderr while preserving Ink's output. It's useful when you want to display external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to `<Static>`, except it can't accept components; it only works with strings.
+      */
+  readonly write: (data: string) => void;
+};
+//#endregion
+//#region src/components/Static.d.ts
+type Props$5<T> = {
+  /**
+      Array of items of any type to render using the function you pass as a component child.
+      */
+  readonly items: T[];
+  /**
+      Styles to apply to a container of child elements. See <Box> for supported properties.
+      */
+  readonly style?: Styles;
+  /**
+      Function that is called to render every item in the `items` array. The first argument is the item itself, and the second argument is the index of that item in the `items` array. Note that a `key` must be assigned to the root component.
+      */
+  readonly children: (item: T, index: number) => ReactNode;
+};
+/**
+`<Static>` component permanently renders its output above everything else. It's useful for displaying activity like completed tasks or logs—things that don't change after they're rendered (hence the name "Static").
+
+It's preferred to use `<Static>` for use cases like these when you can't know or control the number of items that need to be rendered.
+
+For example, [Tap](https://github.com/tapjs/node-tap) uses `<Static>` to display a list of completed tests. [Gatsby](https://github.com/gatsbyjs/gatsby) uses it to display a list of generated pages while still displaying a live progress bar.
+*/
+declare function Static<T>(props: Props$5<T>): import("react").JSX.Element;
+//#endregion
+//#region src/components/Transform.d.ts
+type Props$9 = {
+  /**
+      Screen-reader-specific text to output. If this is set, all children will be ignored.
+      */
+  readonly accessibilityLabel?: string;
+  /**
+      Compatibility function that transforms the ANSI serialization of this subtree.
+      */
+  readonly transform: (children: string, index: number) => string;
+  readonly children?: ReactNode;
+};
+/**
+Transform a string representation of React components before they're written to output. For example, you might want to apply a gradient to text, add a clickable link, or create some text effects. These use cases can't accept React nodes as input; they expect a string. That's what the <Transform> component does: it gives you an output string of its child components and lets you transform it in any way.
+*/
+declare function Transform({ children, transform, accessibilityLabel }: Props$9): import("react").JSX.Element | null;
+//#endregion
+//#region src/components/Hyperlink.d.ts
+type Props$3 = Omit<Props$8, "children"> & {
+  /**
+      The URL the hyperlink points to.
+      */
+  readonly url: string;
+  /**
+      When the terminal does not support OSC 8 hyperlinks, append the URL in
+      parentheses after the text so it stays reachable. Set to `false` to render
+      the text alone.
+  
+      @default true
+      */
+  readonly fallback?: boolean;
+  readonly children?: ReactNode;
+};
+/**
+A clickable OSC 8 hyperlink — the counterpart to the router's `<Link>`, which
+navigates between screens. On terminals without hyperlink support it falls
+back to `text (url)`.
+
+```tsx
+<Hyperlink url="https://example.com">Documentation</Hyperlink>
+```
+*/
+declare function Hyperlink({ url, fallback, children, ...textProps }: Props$3): import("react").JSX.Element;
+//#endregion
+//#region src/components/Newline.d.ts
+/** @jsxImportSource react */
+type Props$4 = {
+  /**
+      Number of newlines to insert.
+  
+      @default 1
+      */
+  readonly count?: number;
+};
+/**
+Adds one or more newline (`\n`) characters. Must be used within `<Text>` components.
+*/
+declare function Newline({ count }: Props$4): import("react").JSX.Element;
+//#endregion
+//#region src/components/Spacer.d.ts
+/**
+A flexible space that expands along the major axis of its containing layout.
+
+It's useful as a shortcut for filling all the available space between elements.
+*/
+declare function Spacer(): import("react").JSX.Element;
+//#endregion
+//#region src/components/VirtualList.d.ts
+type Props$10<Item> = {
+  /**
+      Items to window over.
+      */
+  readonly items: ReadonlyArray<Item>;
+  /**
+      Height of an item in rows. It must match what `renderItem` produces for it:
+      the window is computed from these numbers, never from the rendered output.
+      */
+  readonly itemHeight: (item: Item, index: number) => number;
+  /**
+      Render one item. Only items intersecting the viewport are rendered.
+      */
+  readonly renderItem: (item: Item, index: number) => ReactNode;
+  /**
+      React key for an item. Defaults to its index.
+      */
+  readonly getKey?: (item: Item, index: number) => Key$1;
+  /**
+      Item to keep fully visible. When it changes, the list scrolls as little as
+      necessary to show it.
+      */
+  readonly focusedIndex?: number;
+  /**
+      Viewport height in rows. When omitted the list takes the height of its
+      content and shrinks to whatever space its container leaves: bound an
+      ancestor (`height` or `maxHeight`) and give the siblings that must keep
+      their size `flexShrink={0}`.
+      */
+  readonly height?: number;
+};
+/**
+A vertically windowed list: only the items intersecting the viewport are
+rendered, inside a clipped box that scrolls by whole rows. Items may have
+different heights, and the item at the top edge may be partially visible.
+
+Until the first layout pass has measured the viewport, every item is rendered
+inside the clipped box so the first frame already looks right.
+*/
+declare function VirtualList<Item>({ items, itemHeight, renderItem, getKey, focusedIndex, height }: Props$10<Item>): import("react").JSX.Element;
+//#endregion
+//#region src/hooks/use-capabilities.d.ts
+/**
+Returns everything knowable about the terminal: size, identity, platform,
+color depth, theme, and feature support.
+
+A thin wrapper over the framework-free capabilities store (`getCapabilities`):
+environment-derived facts are available immediately; facts only the terminal
+itself can answer fill in after a lazy one-time query, and re-mounting
+consumers refreshes the dynamic facts (theme colors, pixel geometry).
+Re-renders on terminal resize and whenever query answers arrive.
+*/
+declare const useCapabilities: () => Capabilities;
+/**
+Calls `onChange` whenever the terminal changes: resizes (including in-band
+pixel geometry), color scheme switches, window focus, and query answers
+arriving. The React wrapper over `capabilities.subscribe()` for side effects —
+for rendering, use `useCapabilities` instead.
+
+The callback always sees the latest render's closure and changing it does not
+resubscribe. Both the new and previous snapshot are passed, so handlers can
+react to the specific change:
+
+```tsx
+useCapabilitiesChange((next, previous) => {
+  if (next.theme.appearance !== previous.theme.appearance) {
+    // re-theme
+  }
+});
+```
+*/
+declare const useCapabilitiesChange: (onChange: (capabilities: Capabilities, previous: Capabilities) => void) => void;
+//#endregion
+//#region src/hooks/use-input.d.ts
+/**
+Handy information about a key that was pressed.
+*/
+type Key = {
+  /**
+      Up arrow key was pressed.
+      */
+  upArrow: boolean;
+  /**
+      Down arrow key was pressed.
+      */
+  downArrow: boolean;
+  /**
+      Left arrow key was pressed.
+      */
+  leftArrow: boolean;
+  /**
+      Right arrow key was pressed.
+      */
+  rightArrow: boolean;
+  /**
+      Page Down key was pressed.
+      */
+  pageDown: boolean;
+  /**
+      Page Up key was pressed.
+      */
+  pageUp: boolean;
+  /**
+      Home key was pressed.
+      */
+  home: boolean;
+  /**
+      End key was pressed.
+      */
+  end: boolean;
+  /**
+      Return (Enter) key was pressed.
+      */
+  return: boolean;
+  /**
+      Escape key was pressed.
+      */
+  escape: boolean;
+  /**
+      Ctrl key was pressed.
+      */
+  ctrl: boolean;
+  /**
+      Shift key was pressed.
+      */
+  shift: boolean;
+  /**
+      Tab key was pressed.
+      */
+  tab: boolean;
+  /**
+      Backspace key was pressed.
+      */
+  backspace: boolean;
+  /**
+      Delete key was pressed.
+      */
+  delete: boolean;
+  /**
+      [Meta key](https://en.wikipedia.org/wiki/Meta_key) was pressed.
+      */
+  meta: boolean;
+  /**
+      Super key (Cmd on Mac, Win on Windows) was pressed.
+  
+      Only available with kitty keyboard protocol.
+      */
+  super: boolean;
+  /**
+      Hyper key was pressed.
+  
+      Only available with kitty keyboard protocol.
+      */
+  hyper: boolean;
+  /**
+      Caps Lock is active.
+  
+      Only available with kitty keyboard protocol.
+      */
+  capsLock: boolean;
+  /**
+      Num Lock is active.
+  
+      Only available with kitty keyboard protocol.
+      */
+  numLock: boolean;
+  /**
+      Event type for key events.
+  
+      Only available with kitty keyboard protocol.
+      */
+  eventType?: "press" | "repeat" | "release";
+};
+type Handler = (input: string, key: Key) => void;
+type Options$2 = {
+  /**
+      Enable or disable capturing of user input. Useful when there are multiple `useInput` hooks used at once to avoid handling the same input several times.
+  
+      @default true
+      */
+  isActive?: boolean;
+};
+/**
+A React hook that returns `void` and handles user input.
+It's a more convenient alternative to using `StdinContext` and listening for `data` events. The callback you pass to `useInput` is called for each character when the user enters any input. However, if the user pastes text and it's more than one character, the callback will be called only once, and the whole string will be passed as `input`.
+
+```
+import {useInput} from 'ink';
+
+const UserInput = () => {
+  useInput((input, key) => {
+    if (input === 'q') {
+      // Exit program
+    }
+
+    if (key.leftArrow) {
+      // Left arrow key pressed
+    }
+  });
+
+  return …
+};
+```
+*/
+declare const useInput: (inputHandler: Handler, options?: Options$2) => void;
+//#endregion
+//#region src/hooks/use-paste.d.ts
+type Options$1 = {
+  /**
+      Enable or disable the paste handler. Useful when multiple components use `usePaste` and only one should be active at a time.
+  
+      @default true
+      */
+  isActive?: boolean;
+};
+/**
+A React hook that calls `handler` whenever the user pastes text in the terminal. Bracketed paste mode (`\x1b[?2004h`) is automatically enabled while the hook is active, so pasted text arrives as a single string rather than being misinterpreted as individual key presses.
+
+`usePaste` and `useInput` can be used together in the same component. They operate on separate event channels, so paste content is never forwarded to `useInput` handlers when `usePaste` is active.
+
+```
+import {useInput, usePaste} from 'ink';
+
+const MyInput = () => {
+    useInput((input, key) => {
+        // Only receives typed characters and key events, not pasted text.
+        if (key.return) {
+            // Submit
+        }
+    });
+
+    usePaste((text) => {
+        // Receives the full pasted string, including newlines.
+        console.log('Pasted:', text);
+    });
+
+    return …
+};
+```
+*/
+declare const usePaste: (handler: (text: string) => void, options?: Options$1) => void;
+//#endregion
+//#region src/hooks/use-app.d.ts
+/**
+A React hook that returns app lifecycle methods like `exit()` and `waitUntilRenderFlush()`.
+*/
+declare const useApp: () => Props$1;
+//#endregion
+//#region src/hooks/use-stdin.d.ts
+/**
+A React hook that returns the stdin stream and stdin-related utilities.
+*/
+declare const useStdin: () => PublicProps;
+//#endregion
+//#region src/hooks/use-stdout.d.ts
+/**
+A React hook that returns the stdout stream where Ink renders your app.
+*/
+declare const useStdout: () => Props$7;
+//#endregion
+//#region src/hooks/use-stderr.d.ts
+/**
+A React hook that returns the stderr stream.
+*/
+declare const useStderr: () => Props$6;
+//#endregion
+//#region src/hooks/use-focus.d.ts
+type Input = {
+  /**
+      Enable or disable this component's focus, while still maintaining its position in the list of focusable components.
+      */
+  isActive?: boolean;
+  /**
+      Auto-focus this component if there's no active (focused) component right now.
+      */
+  autoFocus?: boolean;
+  /**
+      Assign an ID to this component, so it can be programmatically focused with `focus(id)`.
+      */
+  id?: string;
+};
+type Output$2 = {
+  /**
+      Determines whether this component is focused.
+      */
+  isFocused: boolean;
+  /**
+      Allows focusing a specific element with the provided `id`.
+      */
+  focus: (id: string) => void;
+};
+/**
+A React hook that returns focus state and focus controls for the current component.
+A component that uses the `useFocus` hook becomes "focusable" to Ink, so when the user presses <kbd>Tab</kbd>, Ink will switch focus to this component. If there are multiple components that execute the `useFocus` hook, focus will be given to them in the order in which these components are rendered.
+*/
+declare const useFocus: ({ isActive, autoFocus, id: customId }?: Input) => Output$2;
+//#endregion
+//#region src/components/FocusContext.d.ts
+type Props$11 = {
+  readonly activeId?: string;
+  readonly add: (id: string, options: {
+    autoFocus: boolean;
+  }) => void;
+  readonly remove: (id: string) => void;
+  readonly activate: (id: string) => void;
+  readonly deactivate: (id: string) => void;
+  readonly enableFocus: () => void;
+  readonly disableFocus: () => void;
+  readonly focusNext: () => void;
+  readonly focusPrevious: () => void;
+  readonly focus: (id: string) => void;
+};
+//#endregion
+//#region src/hooks/use-focus-manager.d.ts
+type Output$1 = {
+  /**
+      Enable focus management for all components.
+      */
+  enableFocus: Props$11["enableFocus"];
+  /**
+      Disable focus management for all components. The currently active component (if there's one) will lose its focus.
+      */
+  disableFocus: Props$11["disableFocus"];
+  /**
+      Switch focus to the next focusable component. If there's no active component right now, focus will be given to the first focusable component. If the active component is the last in the list of focusable components, focus will be switched to the first focusable component.
+      */
+  focusNext: Props$11["focusNext"];
+  /**
+      Switch focus to the previous focusable component. If there's no active component right now, focus will be given to the first focusable component. If the active component is the first in the list of focusable components, focus will be switched to the last focusable component.
+      */
+  focusPrevious: Props$11["focusPrevious"];
+  /**
+      Switch focus to the element with provided `id`. If there's no element with that `id`, focus is not changed.
+      */
+  focus: Props$11["focus"];
+  /**
+      The ID of the currently focused component, or `undefined` if no component is focused.
+  
+      @example
+      ```tsx
+      import {Text, useFocusManager} from 'ink';
+  
+      const Example = () => {
+          const {activeId} = useFocusManager();
+  
+          return <Text>Focused: {activeId ?? 'none'}</Text>;
+      };
+      ```
+      */
+  activeId: Props$11["activeId"];
+};
+/**
+A React hook that returns methods to enable or disable focus management for all components or manually switch focus to the next or previous components.
+*/
+declare const useFocusManager: () => Output$1;
+//#endregion
+//#region src/hooks/use-is-screen-reader-enabled.d.ts
+/**
+A React hook that returns whether a screen reader is enabled.
+This is useful when you want to render different output for screen readers.
+*/
+declare const useIsScreenReaderEnabled: () => boolean;
+//#endregion
+//#region src/hooks/use-cursor.d.ts
+/**
+A React hook that returns methods to control the terminal cursor position.
+
+Setting a cursor position makes the cursor visible at the specified coordinates (relative to the Ink output origin). This is useful for IME (Input Method Editor) support, where the composing character is displayed at the cursor location.
+
+Pass `undefined` to hide the cursor.
+*/
+declare const useCursor: () => {
+  setCursorPosition: (position: CursorPosition | undefined) => void;
+};
+//#endregion
+//#region src/hooks/use-animation.d.ts
+type Options = {
+  /**
+      Time between ticks in milliseconds.
+  
+      @default 100
+      */
+  readonly interval?: number;
+  /**
+      Whether the animation is running. When set to `false`, the animation stops. When toggled back to `true`, all values reset to `0`.
+  
+      @default true
+      */
+  readonly isActive?: boolean;
+};
+type AnimationResult = {
+  /**
+      Discrete counter that increments by 1 each interval. Useful for indexed sequences like spinner frames.
+      */
+  readonly frame: number;
+  /**
+      Total elapsed time in milliseconds since the animation started or was last reset. Useful for continuous math-based animations like sine waves: `Math.sin(time / 1000 * Math.PI * 2)`.
+      */
+  readonly time: number;
+  /**
+      Time in milliseconds since the previous rendered tick. Accounts for throttled renders. Useful for physics-based or velocity-driven motion: `position += speed * delta`.
+      */
+  readonly delta: number;
+  /**
+      Resets `frame`, `time`, and `delta` to `0` and restarts timing from the current moment. Useful for one-shot animations triggered by events.
+      */
+  readonly reset: () => void;
+};
+/**
+A React hook that drives animations. Returns a frame counter, elapsed time, frame delta, and a reset function. All animations share a single timer internally, so multiple animated components consolidate into one render cycle.
+
+@example
+```
+import {Text, useAnimation} from 'ink';
+
+const Spinner = () => {
+    const {frame} = useAnimation({interval: 80});
+    const characters = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+
+    return <Text>{characters[frame % characters.length]}</Text>;
+};
+```
+*/
+declare function useAnimation(options?: Options): AnimationResult;
+//#endregion
+//#region src/hooks/use-terminal-osc.d.ts
+type ProgressOptions = {
+  readonly state: TerminalProgressState;
+  readonly value?: number;
+};
+declare const useProgress: ({ state, value }: ProgressOptions) => void;
+declare const useClipboard: () => ((text: string, selection?: ClipboardSelection) => void);
+declare const useTitle: (title?: string) => void;
+declare const useWorkingDirectory: (directory: URL | string) => void;
+declare const useNotification: () => ((title: string) => void);
+declare const usePointerShape: (shape: string) => void;
+//#endregion
+//#region src/hooks/use-window-size.d.ts
+/**
+Dimensions of the terminal window.
+*/
+type WindowSize = {
+  /**
+      Number of columns (horizontal character cells).
+      */
+  readonly columns: number;
+  /**
+      Number of rows (vertical character cells).
+      */
+  readonly rows: number;
+};
+/**
+A React hook that returns the current terminal window dimensions and re-renders the component whenever the terminal is resized.
+
+Reads the capabilities store, so on terminals that send in-band size reports
+(mode 2048) the dimensions are the emulator's own, arriving after it has
+rewrapped its screen; elsewhere they are the stream's `columns`/`rows`.
+Subscribing to dimensions does not initiate capability queries. In-band reports
+are used when another consumer has explicitly enabled capability discovery.
+*/
+declare const useWindowSize: () => WindowSize;
+//#endregion
+//#region src/hooks/use-box-metrics.d.ts
+/**
+Metrics of a box element.
+
+All positions are relative to the element's parent.
+*/
+type BoxMetrics = {
+  /**
+      Element width.
+      */
+  readonly width: number;
+  /**
+      Element height.
+      */
+  readonly height: number;
+  /**
+      Distance from the left edge of the parent.
+      */
+  readonly left: number;
+  /**
+      Distance from the top edge of the parent.
+      */
+  readonly top: number;
+};
+type UseBoxMetricsResult = BoxMetrics & {
+  /**
+      Whether the currently tracked element has been measured in the latest layout pass.
+      */
+  readonly hasMeasured: boolean;
+};
+/**
+A React hook that returns the current layout metrics for a tracked box element.
+It updates when layout changes (for example terminal resize, sibling/content changes, or position changes).
+
+The hook returns `{width: 0, height: 0, left: 0, top: 0}` until the first layout pass completes. It also returns zeros when the tracked ref is detached.
+
+Use `hasMeasured` to detect when the currently tracked element has been measured.
+
+@example
+```tsx
+import {useRef} from 'react';
+import {Box, Text, useBoxMetrics} from 'ink';
+
+const Example = () => {
+    const ref = useRef(null);
+    const {width, height, left, top, hasMeasured} = useBoxMetrics(ref);
+    return (
+        <Box ref={ref}>
+            <Text>
+                {hasMeasured ? `${width}x${height} at ${left},${top}` : 'Measuring...'}
+            </Text>
+        </Box>
+    );
+};
+```
+*/
+declare const useBoxMetrics: (ref: RefObject<DOMElement | null>) => UseBoxMetricsResult;
+//#endregion
+//#region src/virtual-scroll.d.ts
+/**
+Windowing math shared by `useVirtualScroll` and `<VirtualList>`.
+
+Items are stacked vertically and measured in terminal rows. The viewport shows
+`viewportHeight` rows of that stack starting `scrollTop` rows from the top.
+*/
+type VirtualScrollOptions = {
+  /**
+      Number of items in the list.
+      */
+  readonly count: number;
+  /**
+      Height of the item at `index` in rows. It must match what the item renders:
+      the window is computed from these numbers, never from the rendered output.
+      */
+  readonly itemHeight: (index: number) => number;
+  /**
+      Rows available to show items.
+      */
+  readonly viewportHeight: number;
+  /**
+      Requested distance of the viewport from the top of the list in rows. It is
+      clamped to the scrollable range and then moved as little as necessary to keep
+      `focusedIndex` fully visible.
+      */
+  readonly scrollTop: number;
+  /**
+      Item that must stay fully visible. An item taller than the viewport is aligned
+      to the top. Out-of-range values are ignored.
+      */
+  readonly focusedIndex?: number;
+};
+type VirtualScrollWindow = {
+  /**
+      Index of the first item that intersects the viewport.
+      */
+  readonly start: number;
+  /**
+      Index after the last item that intersects the viewport.
+      */
+  readonly end: number;
+  /**
+      Effective distance of the viewport from the top of the list in rows.
+      */
+  readonly scrollTop: number;
+  /**
+      Largest `scrollTop` that still fills the viewport.
+      */
+  readonly maxScrollTop: number;
+  /**
+      Height of every item combined in rows.
+      */
+  readonly totalHeight: number;
+  /**
+      Position of the `start` item relative to the top of the viewport. Zero or
+      negative: a negative value means the item is partially scrolled out above.
+      */
+  readonly offset: number;
+  /**
+      Rows scrolled out above the viewport.
+      */
+  readonly hiddenAbove: number;
+  /**
+      Rows left below the viewport.
+      */
+  readonly hiddenBelow: number;
+};
+//#endregion
+//#region src/hooks/use-virtual-scroll.d.ts
+type UseVirtualScrollOptions = Omit<VirtualScrollOptions, "scrollTop">;
+type UseVirtualScrollResult = VirtualScrollWindow & {
+  /**
+      Scroll so the viewport starts `top` rows from the top of the list.
+      */
+  readonly scrollTo: (top: number) => void;
+  /**
+      Scroll by `delta` rows; negative values scroll up.
+      */
+  readonly scrollBy: (delta: number) => void;
+};
+/**
+A React hook that owns the scroll position of a windowed list and returns which
+items to render for it. The position is clamped to the scrollable range and,
+while `focusedIndex` is set, moved as little as necessary to keep that item
+fully visible. Render the items in `[start, end)` inside an `overflowY="hidden"`
+box of `viewportHeight` rows, shifted up by `offset` rows.
+
+`<VirtualList>` wraps this hook; use it directly to draw your own chrome such
+as overflow markers or a scrollbar around the window.
+
+@example
+```tsx
+import { Box, Text, useVirtualScroll } from "@alchemy.run/sigil";
+
+const Example = ({ lines, cursor }: { lines: string[]; cursor: number }) => {
+    const { start, end, offset, hiddenAbove, hiddenBelow } = useVirtualScroll({
+        count: lines.length,
+        itemHeight: () => 1,
+        viewportHeight: 10,
+        focusedIndex: cursor,
+    });
+
+    return (
+        <Box flexDirection="column">
+            <Text dimColor>{hiddenAbove > 0 ? `↑ ${hiddenAbove} more` : ""}</Text>
+            <Box flexDirection="column" height={10} overflowY="hidden">
+                <Box flexDirection="column" flexShrink={0} marginTop={offset}>
+                    {lines.slice(start, end).map((line, index) => (
+                        <Text key={start + index} inverse={start + index === cursor}>
+                            {line}
+                        </Text>
+                    ))}
+                </Box>
+            </Box>
+            <Text dimColor>{hiddenBelow > 0 ? `↓ ${hiddenBelow} more` : ""}</Text>
+        </Box>
+    );
+};
+```
+*/
+declare const useVirtualScroll: (options: UseVirtualScrollOptions) => UseVirtualScrollResult;
+//#endregion
+//#region src/measure-element.d.ts
+type Output = {
+  /**
+      Horizontal position (0-based column) within the live layout region.
+      */
+  x: number;
+  /**
+      Vertical position (0-based row) within the live layout region.
+      */
+  y: number;
+  /**
+      Element width.
+      */
+  width: number;
+  /**
+      Element height.
+      */
+  height: number;
+};
+/**
+Measure the layout metrics of a particular `<Box>` element.
+Returns an object with `x`, `y`, `width`, and `height` properties.
+
+`x` and `y` are the element's position within the live layout region, computed by walking up the layout tree and accumulating each ancestor's offset. These are layout-tree coordinates, not terminal viewport coordinates. To compare them with mouse events, convert the event coordinates using the live region's viewport position. This is necessary even in alternate-screen mode when output, such as `<Static>` content, appears above the live region.
+
+Note: `measureElement()` returns `{x: 0, y: 0, width: 0, height: 0}` when called during render (before layout is calculated). Call it from post-render code, such as `useEffect`, `useLayoutEffect`, input handlers, or timer callbacks. When content changes, pass the relevant dependency to your effect so it re-measures after each update.
+*/
+declare const measureElement: (node: DOMElement) => Output;
+//#endregion
+export { type AnimationResult, AnsiText, type Props as AnsiTextProps, type Props$1 as AppProps, Box, type BoxMetrics, type Props$2 as BoxProps, type Capabilities, type CapabilitiesStore, type CapturedOutputSource, type ColorInfo, type ColorSupport, type ColorSupportLevel, type CursorPosition, type DOMElement, type Output as ElementMetrics, Hyperlink, type Props$3 as HyperlinkProps, type Instance, type Key, type KittyFlagName, type KittyKeyboardOptions, type Multiplexer, Newline, type Props$4 as NewlineProps, type PixelGeometry, type PixelSize, type ProgressOptions, type RenderOptions, type RenderToStringOptions, type RgbColor, Spacer, Static, type Props$5 as StaticProps, type Props$6 as StderrProps, type PublicProps as StdinProps, type Props$7 as StdoutProps, type SuspendTerminal, type TerminalAppearance, type TerminalIdentity, type TerminalQueryOptions, type TerminalQueryResult, type TerminalSuspension, Text, type Props$8 as TextProps, Transform, type Props$9 as TransformProps, type UseBoxMetricsResult, type UseVirtualScrollOptions, type UseVirtualScrollResult, VirtualList, type Props$10 as VirtualListProps, type VirtualScrollWindow, type WindowSize, applyTerminalQuery, capabilities, createSupportsColor, detectCapabilities, detectColorLevel, detectHyperlinkSupport, detectTerminal, detectUnicodeSupport, getCapabilities, getTerminalQuery, kittyFlags, kittyModifiers, measureElement, queryTerminal, refreshTerminalQuery, render, renderToString, useAnimation, useApp, useBoxMetrics, useCapabilities, useCapabilitiesChange, useClipboard, useCursor, useFocus, useFocusManager, useInput, useIsScreenReaderEnabled, useNotification, usePaste, usePointerShape, useProgress, useStderr, useStdin, useStdout, useTitle, useVirtualScroll, useWindowSize, useWorkingDirectory };