@visulima/tui 1.0.0-alpha.3 → 1.0.0-alpha.5

package/dist/ink/canvas/braille.d.ts

@@ -1,22 +0,0 @@
-import type { CanvasContext, CellStyle } from "./buffer.d.ts";
-export type BrailleGrid = {
-    readonly cellHeight: number;
-    readonly cellWidth: number;
-    readonly clear: () => void;
-    /**
-     * Flush the accumulated pixels into the canvas, one braille character per
-     * dirtied cell. Pass a color via `style` to apply it uniformly (mixing
-     * colors across overlapping series requires a separate grid per series).
-     */
-    readonly flush: (context: CanvasContext, style?: CellStyle) => void;
-    readonly pixelHeight: number;
-    readonly pixelWidth: number;
-    readonly plotLine: (x0: number, y0: number, x1: number, y1: number) => void;
-    readonly plotPoint: (x: number, y: number) => void;
-};
-/**
- * Accumulator for braille-rendered charts. Tracks which sub-pixels are lit
- * and emits a braille character per dirtied cell on `flush`. Designed to be
- * allocated per chart render and thrown away.
- */
-export declare const createBrailleGrid: (cellWidth: number, cellHeight: number) => BrailleGrid;

package/dist/ink/canvas/buffer.d.ts

@@ -1,67 +0,0 @@
-export type CanvasColor = number | string | undefined;
-export type CellStyle = {
-    readonly background?: CanvasColor;
-    readonly bold?: boolean;
-    readonly color?: CanvasColor;
-    readonly dim?: boolean;
-};
-/**
- * Reverse of the encoder. 0 → undefined; any other id returns the original
- * CanvasColor (preserving number vs string distinction).
- */
-type ColorDecoder = (id: number) => CanvasColor;
-export type CanvasContext = {
-    /**
-     * Clear every cell back to space + default style.
-     */
-    readonly clear: () => void;
-    /**
-     * Draw a horizontal bar using fractional block glyphs (▏▎▍▌▋▊▉█).
-     * `fillRatio` in [0, 1] determines the filled portion.
-     */
-    readonly drawHBar: (x: number, y: number, w: number, fillRatio: number, style?: CellStyle) => void;
-    /**
-     * Draw a filled rectangle using a single character.
-     */
-    readonly drawRect: (x: number, y: number, w: number, h: number, char: number | string, style?: CellStyle) => void;
-    /**
-     * Render a string left-to-right starting at (x, y). Non-printable or
-     * multi-byte codepoints are preserved but advance the cursor by 1 cell.
-     */
-    readonly drawText: (x: number, y: number, text: string, style?: CellStyle) => void;
-    /**
-     * Draw a vertical bar using fractional block glyphs (▁▂▃▄▅▆▇█).
-     * `fillRatio` in [0, 1] determines the filled portion.
-     */
-    readonly drawVBar: (x: number, y: number, h: number, fillRatio: number, style?: CellStyle) => void;
-    readonly height: number;
-    /**
-     * Set a single cell at (x, y). Out-of-bounds writes are silently ignored.
-     */
-    readonly setCell: (x: number, y: number, char: number | string, style?: CellStyle) => void;
-    readonly width: number;
-};
-export type CanvasBuffer = {
-    readonly bg: Int32Array;
-    readonly chars: Uint32Array;
-    readonly colorDecoder: ColorDecoder;
-    readonly context: CanvasContext;
-    readonly dirty: Uint8Array;
-    readonly fg: Int32Array;
-    readonly height: number;
-    readonly styles: Uint32Array;
-    readonly width: number;
-};
-/**
- * Allocate a canvas buffer and return a context that mutates it in place.
- * The buffer is typed-array backed; all mutations O(1) per cell with no
- * object allocation.
- */
-export declare const createCanvasBuffer: (width: number, height: number) => CanvasBuffer;
-/**
- * Serialize a buffer row into an ANSI string, coalescing adjacent cells that
- * share the same style. Call directly when you need to re-emit rows; row
- * caching lives one level up in Canvas.tsx.
- */
-export declare const serializeRow: (buffer: CanvasBuffer, row: number) => string;
-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/accessibility-context.d.ts

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

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

@@ -1,52 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-export type AccordionItem = {
-    /**
-     * Content rendered when the item is expanded.
-     */
-    readonly content: ReactNode;
-    /**
-     * Unique identifier.
-     */
-    readonly id: string;
-    /**
-     * Header label.
-     */
-    readonly title: ReactNode;
-};
-export type Props = {
-    /**
-     * Accent color for the focused header.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * When true, multiple panels can be open at once.
-     * @default false
-     */
-    readonly allowMultiple?: boolean;
-    /**
-     * Auto-focus the first item on mount.
-     */
-    readonly autoFocus?: boolean;
-    /**
-     * Initially open item ids.
-     */
-    readonly defaultExpanded?: ReadonlyArray<string>;
-    /**
-     * Disable interaction.
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * List of panels.
-     */
-    readonly items: ReadonlyArray<AccordionItem>;
-};
-/**
- * Keyboard-navigable accordion. Use arrow keys to move between panels and
- * Enter / Space to toggle.
- * @param props See {@link Props}.
- * @returns A `ReactElement` rendering the accordion column.
- */
-export default function Accordion({ accentColor, allowMultiple, autoFocus, defaultExpanded, isDisabled, items, }: Props): ReactElement;

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/animate-presence.d.ts

@@ -1,15 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-export type Props = {
-    /**
-     * Keyed children. Any child that accepts a `show: boolean` prop and calls
-     * `onExit` when its exit transition finishes (such as `<Transition />`) is
-     * orchestrated automatically. Other children render as-is.
-     */
-    readonly children: ReactNode;
-};
-/**
- * Orchestrates enter / exit animations for keyed children. Wrap a dynamic
- * list of `<Transition />` (or any component accepting `show` + `onExit`) to
- * keep outgoing children mounted until their exit animation finishes.
- */
-export default function AnimatePresence({ children }: Props): ReactElement;

package/dist/ink/components/animation-context.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-context.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/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/approval-prompt.d.ts

@@ -1,55 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-export type ApprovalRisk = "high" | "low" | "medium";
-export type ApprovalDecision = "allow-always" | "allow-once" | "deny";
-export type Props = {
-    /**
-     * Accent color for the highlighted option letters. Overrides the risk color.
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Auto-focus the prompt on mount. Set to `false` if a parent already
-     * owns focus and routes input to this component.
-     * @default true
-     */
-    readonly autoFocus?: boolean;
-    /**
-     * Optional body rendered between the header and the prompt line (e.g. a
-     * rendered diff or command preview).
-     */
-    readonly children?: ReactNode;
-    /**
-     * Accessible description of what approving will do.
-     */
-    readonly description?: string;
-    /**
-     * Disable input; use when a parent manages focus and input routing.
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * Resolution callback. Called once the user answers.
-     */
-    readonly onDecision: (decision: ApprovalDecision) => void;
-    /**
-     * Params shown as a compact key=value preview.
-     */
-    readonly params?: Readonly<Record<string, unknown>>;
-    /**
-     * Severity badge; controls the border color.
-     * @default "medium"
-     */
-    readonly risk?: ApprovalRisk;
-    /**
-     * Name of the tool / action under review.
-     */
-    readonly tool: string;
-};
-/**
- * Three-way approval prompt for tool calls. Resolves via `onDecision`:
- * `y` / Enter → allow-once, `a` → allow-always, `n` / Esc → deny.
- * @param props See {@link Props}.
- * @returns A bordered `ReactElement` containing the risk banner, params
- * preview, optional body, and the prompt line.
- */
-export default function ApprovalPrompt({ accentColor, autoFocus, children, description, isDisabled, onDecision, params, risk, tool, }: Props): ReactElement;

package/dist/ink/components/area-chart.d.ts

@@ -1,54 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-import type { LineSeries } from "./line-chart.d.ts";
-export type Props = {
-    /**
-     * Axis label color.
-     * @default "gray"
-     */
-    readonly axisColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Density of the shaded fill below each line.
-     * - `light` → `░`
-     * - `medium` → `▒` (default)
-     * - `heavy` → `▓`
-     */
-    readonly fillDensity?: "heavy" | "light" | "medium";
-    /**
-     * Chart body height in character rows.
-     * @default 10
-     */
-    readonly height?: number;
-    /**
-     * Upper bound for the y-axis.
-     */
-    readonly maxY?: number;
-    /**
-     * Lower bound for the y-axis.
-     */
-    readonly minY?: number;
-    /**
-     * Fallback palette.
-     */
-    readonly palette?: ReadonlyArray<LiteralUnion<AnsiColors, string>>;
-    /**
-     * Series to plot.
-     */
-    readonly series: ReadonlyArray<LineSeries>;
-    /**
-     * Render the legend below the plot.
-     * @default true
-     */
-    readonly showLegend?: boolean;
-    /**
-     * Chart body width in character columns.
-     * @default 40
-     */
-    readonly width?: number;
-};
-/**
- * Area chart: line chart with the area between the line and the baseline
- * filled with shaded blocks.
- */
-export default function AreaChart({ axisColor, fillDensity, height, maxY, minY, palette, series, showLegend, width, }: Props): ReactElement;

package/dist/ink/components/background-context.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/bar-chart.d.ts

@@ -1,57 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-export type BarDatum = {
-    /**
-     * Per-bar color override. Falls back to the chart-level palette.
-     */
-    readonly color?: LiteralUnion<AnsiColors, string>;
-    readonly label?: string;
-    readonly value: number;
-};
-export type Props = {
-    /**
-     * Bars to render.
-     */
-    readonly data: ReadonlyArray<BarDatum>;
-    /**
-     * Total height of the plot area in character rows.
-     * @default 10
-     */
-    readonly height?: number;
-    /**
-     * Optional upper bound for the axis. When omitted the chart uses the
-     * largest value in `data`.
-     */
-    readonly max?: number;
-    /**
-     * Orientation of the bars.
-     * @default "vertical"
-     */
-    readonly orientation?: "horizontal" | "vertical";
-    /**
-     * Fallback palette cycled through when a bar does not provide its own color.
-     * @default ["cyan", "magenta", "yellow", "green", "blue", "red"]
-     */
-    readonly palette?: ReadonlyArray<LiteralUnion<AnsiColors, string>>;
-    /**
-     * Render labels underneath vertical bars (or to the left of horizontal bars).
-     * @default true
-     */
-    readonly showLabels?: boolean;
-    /**
-     * Render numeric values next to each bar.
-     * @default false
-     */
-    readonly showValues?: boolean;
-    /**
-     * Total width of the plot area in character columns. Defaults to
-     * `data.length * 3` for vertical charts, or `24` for horizontal.
-     */
-    readonly width?: number;
-};
-/**
- * Bar chart rendered on top of `Canvas`. Uses fractional block glyphs for
- * sub-cell precision (▁▂▃▄▅▆▇█ vertical, ▏▎▍▌▋▊▉█ horizontal).
- */
-export default function BarChart({ data, height, max: maxOverride, orientation, palette, showLabels, showValues, width: widthOverride, }: Props): ReactElement;

package/dist/ink/components/big-text.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 };