1ch 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,639 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, CSSProperties, RefObject } from 'react';
+
+type Style = {
+    text: string;
+    color?: string;
+    bg?: string;
+    bold?: boolean;
+    dim?: boolean;
+    inverted?: boolean;
+    blink?: boolean;
+    onClick?: () => void;
+    noSelect?: boolean;
+    cell?: number;
+};
+type Segment = string | Style;
+type Line = Segment[];
+type Block = Line[];
+type LayoutFn = (width: number) => Block;
+type ThemeMode = "light" | "dark";
+type ThemePreference = ThemeMode | "system";
+type ThemePalette = {
+    black: string;
+    red: string;
+    green: string;
+    yellow: string;
+    blue: string;
+    magenta: string;
+    cyan: string;
+    white: string;
+    brightBlack: string;
+    brightWhite: string;
+};
+type ThemeSemantic = {
+    frameBg: string;
+    frameFg: string;
+    frameMuted: string;
+    border: string;
+    borderStrong: string;
+    inverseFg: string;
+    inverseBg: string;
+    info: string;
+    success: string;
+    warn: string;
+    danger: string;
+};
+type ThemeSyntax = {
+    default: string;
+    keyword: string;
+    string: string;
+    number: string;
+    comment: string;
+    punctuation: string;
+    function: string;
+    type: string;
+};
+type ThemeMarkdown = {
+    headingMarker: string;
+    headingBoldMaxLevel: number;
+    headings: {
+        h1: string;
+        h2: string;
+        h3: string;
+        h4: string;
+        h5: string;
+        h6: string;
+    };
+    paragraph: string;
+    unorderedBullet: string;
+    orderedMarker: string;
+    tableHeader: string;
+    tableBorder: string;
+    quoteMarker: string;
+    quoteText: string;
+    separator: string;
+    codeText: string;
+    codeEmpty: string;
+    codeBorder: string;
+};
+type ThemeComponents = {
+    tabs: {
+        activeFg: string;
+        activeBg: string;
+        inactiveFg: string;
+        separator: string;
+    };
+    statusbar: {
+        fg: string;
+        bg: string;
+    };
+    badge: {
+        fg: string;
+        bg: string;
+    };
+    button: {
+        fg: string;
+        bg: string;
+    };
+};
+type Theme = {
+    id: string;
+    label: string;
+    version: number;
+    mode: ThemeMode;
+    palette: ThemePalette;
+    semantic: ThemeSemantic;
+    syntax: ThemeSyntax;
+    markdown: ThemeMarkdown;
+    components: ThemeComponents;
+    black: string;
+    red: string;
+    green: string;
+    yellow: string;
+    blue: string;
+    magenta: string;
+    cyan: string;
+    white: string;
+    brightBlack: string;
+    brightWhite: string;
+    border: string;
+    bg: string;
+};
+
+declare function isTableLine(line: Line): boolean;
+declare function preserveTableTag(source: Line, target: Line): void;
+
+declare function pad(s: string, w: number, right?: boolean): string;
+declare function hl(n: number): string;
+declare function bar(val: number, max: number, w: number): string;
+declare function spark(data: number[], w: number): string;
+declare function padLine(line: Line, w: number): Line;
+
+declare function lines(content: Line[] | ((w: number) => Line[])): LayoutFn;
+declare function box(content: LayoutFn, opts?: {
+    title?: string;
+    borderColor?: string;
+}): LayoutFn;
+declare function hstack(children: LayoutFn[], opts?: {
+    gap?: number;
+    widths?: number[];
+}): LayoutFn;
+declare function vstack(...children: LayoutFn[]): LayoutFn;
+declare function separator(color?: string): LayoutFn;
+declare function blank(): LayoutFn;
+
+type Column<T extends Record<string, unknown> = Record<string, unknown>> = {
+    key: keyof T & string;
+    title?: string;
+    width?: number;
+    align?: "left" | "right";
+    headerColor?: string;
+    headerBold?: boolean;
+    color?: string | ((value: unknown, row: T) => string | undefined);
+    dim?: boolean | ((value: unknown, row: T) => boolean);
+};
+declare function table<T extends Record<string, unknown>>(columns: Column<T>[], data: T[], opts?: {
+    borderColor?: string;
+    fillWidth?: boolean;
+    headerColor?: string;
+    cellPadding?: number;
+}): LayoutFn;
+
+declare function statusbar(left: Segment[], right: Segment[], opts?: {
+    bg?: string;
+    color?: string;
+    theme?: Theme;
+}): LayoutFn;
+declare function tabs(names: string[], active: number, opts?: {
+    activeColor?: string;
+    activeBg?: string;
+    inactiveColor?: string;
+    separatorColor?: string;
+    onSelect?: (index: number) => void;
+    onClicks?: ((() => void) | undefined)[];
+    theme?: Theme;
+}): LayoutFn;
+declare function badge(label: string, opts?: {
+    color?: string;
+    bg?: string;
+    onClick?: () => void;
+    theme?: Theme;
+}): Segment;
+
+type JsonNode = {
+    type: "vstack";
+    children: JsonNode[];
+} | {
+    type: "hstack";
+    gap?: number;
+    widths?: number[];
+    children: JsonNode[];
+} | {
+    type: "box";
+    title?: string;
+    borderColor?: string;
+    children: JsonNode[];
+} | {
+    type: "lines";
+    content: Line[];
+} | {
+    type: "separator";
+    color?: string;
+} | {
+    type: "blank";
+} | {
+    type: "table";
+    columns: Column[];
+    data: Record<string, unknown>[];
+    borderColor?: string;
+    fillWidth?: boolean;
+} | {
+    type: "statusbar";
+    left: Segment[];
+    right: Segment[];
+    bg?: string;
+    color?: string;
+} | {
+    type: "tabs";
+    names: string[];
+    active: number;
+    activeColor?: string;
+    activeBg?: string;
+    inactiveColor?: string;
+    separatorColor?: string;
+} | {
+    type: "bar";
+    value: number;
+    max: number;
+    color?: string;
+    label?: string;
+} | {
+    type: "text";
+    segments: Segment[];
+};
+declare function fromJsonNode(node: JsonNode): LayoutFn;
+
+type TreeNode = {
+    label: string;
+    children?: TreeNode[];
+};
+declare function tree(data: TreeNode[], opts?: {
+    color?: string;
+    branchColor?: string;
+    leafColor?: string;
+}): LayoutFn;
+declare function list(items: string[], opts?: {
+    ordered?: boolean;
+    bulletColor?: string;
+    color?: string;
+}): LayoutFn;
+
+type TokenType = "keyword" | "string" | "number" | "comment" | "punctuation" | "function" | "type" | "default";
+type Token = {
+    text: string;
+    type: TokenType;
+};
+declare function tokenize(source: string, language?: string): Token[][];
+
+declare function tokenColor(type: TokenType, theme: Theme): string;
+declare function code(source: string, opts?: {
+    language?: string;
+    title?: string;
+    borderColor?: string;
+    theme?: Theme;
+}): LayoutFn;
+declare function diff(value: string, opts?: {
+    addColor?: string;
+    removeColor?: string;
+    metaColor?: string;
+    theme?: Theme;
+}): LayoutFn;
+
+type DocumentSource = {
+    format: "markdown";
+    value: string;
+} | {
+    format: "json";
+    value: unknown;
+} | {
+    format: "html";
+    value: string;
+};
+type MarkdownThemeOverrides = Partial<ThemeMarkdown>;
+
+declare function fromMarkdown(markdown: string, opts?: {
+    theme?: Theme;
+    overrides?: MarkdownThemeOverrides;
+}): LayoutFn;
+
+declare function fromHtml(html: string, opts?: {
+    theme?: Theme;
+    overrides?: MarkdownThemeOverrides;
+}): LayoutFn;
+
+declare function fromJson(value: unknown, opts?: {
+    theme?: Theme;
+    title?: string;
+}): LayoutFn;
+
+declare function fromDocument(source: DocumentSource, opts?: {
+    theme?: Theme;
+    jsonTitle?: string;
+    markdownOverrides?: MarkdownThemeOverrides;
+}): LayoutFn;
+
+type ThemeModeTokens = {
+    palette: ThemePalette;
+    semantic: ThemeSemantic;
+    syntax: ThemeSyntax;
+    markdown: ThemeMarkdown;
+    components: ThemeComponents;
+};
+type ThemeSpec = {
+    id: string;
+    label: string;
+    version: number;
+    modes: Record<ThemeMode, ThemeModeTokens>;
+};
+type ThemeValidationIssue = {
+    path: string;
+    message: string;
+};
+type ThemeValidationResult = {
+    ok: boolean;
+    issues: ThemeValidationIssue[];
+    theme?: ThemeSpec;
+};
+declare const defaultThemeSpec: ThemeSpec;
+declare const builtinThemes: {
+    readonly default: ThemeSpec;
+};
+declare function resolveThemeMode(preference: ThemePreference, systemMode?: ThemeMode): ThemeMode;
+declare function resolveTheme(spec: ThemeSpec, preference?: ThemePreference, opts?: {
+    systemMode?: ThemeMode;
+}): Theme;
+declare const dark: Theme;
+declare const light: Theme;
+declare function themeToCssVars(theme: Theme): Record<string, string>;
+declare function parseThemeSpec(json: string): ThemeValidationResult;
+declare function validateThemeSpec(value: unknown): ThemeValidationResult;
+
+type TermThemeContextValue = {
+    themeSpec: ThemeSpec;
+    modePreference: ThemePreference;
+    systemMode: ThemeMode;
+    theme: Theme;
+    setThemeSpec: (next: ThemeSpec) => void;
+    setModePreference: (next: ThemePreference) => void;
+};
+type TermThemeProviderProps = {
+    children: ReactNode;
+    initialTheme?: ThemeSpec;
+    initialMode?: ThemePreference;
+};
+declare function TermThemeProvider({ children, initialTheme, initialMode, }: TermThemeProviderProps): react_jsx_runtime.JSX.Element;
+declare function useTermTheme(): TermThemeContextValue;
+
+type TermUIProps = {
+    block?: Block;
+    children?: ReactNode;
+    width?: number;
+    theme?: Theme;
+    themeSpec?: ThemeSpec;
+    mode?: ThemePreference;
+    markdownOverrides?: MarkdownThemeOverrides;
+    className?: string;
+    style?: CSSProperties;
+};
+type TermDocumentProps = {
+    source: DocumentSource;
+    width?: number;
+    theme?: Theme;
+    themeSpec?: ThemeSpec;
+    mode?: ThemePreference;
+    jsonTitle?: string;
+    markdownOverrides?: MarkdownThemeOverrides;
+    className?: string;
+    style?: CSSProperties;
+};
+declare function TermUIBase({ block, children, width, theme, themeSpec, mode, markdownOverrides, className, style, }: TermUIProps): react_jsx_runtime.JSX.Element;
+declare const TermUI: react.MemoExoticComponent<typeof TermUIBase>;
+
+declare function TermDocument({ source, width, theme, themeSpec, mode, jsonTitle, markdownOverrides, className, style, }: TermDocumentProps): react_jsx_runtime.JSX.Element;
+
+type BaseProps = {
+    children?: ReactNode;
+};
+type TVStackProps = BaseProps & {
+    gap?: number;
+};
+type THStackProps = BaseProps & {
+    gap?: number;
+    widths?: number[];
+};
+type TBoxProps = BaseProps & {
+    title?: string;
+    borderColor?: string;
+    gap?: number;
+};
+type TSeparatorProps = {
+    color?: string;
+};
+type TRawProps = {
+    text?: string;
+    color?: string;
+    bg?: string;
+    bold?: boolean;
+    dim?: boolean;
+    blink?: boolean;
+    inverted?: boolean;
+    onClick?: () => void;
+    children?: ReactNode;
+};
+type TTableProps<T extends Record<string, unknown> = Record<string, unknown>> = {
+    columns: Column<T>[];
+    data: T[];
+    borderColor?: string;
+    fillWidth?: boolean;
+    headerColor?: string;
+    cellPadding?: number;
+};
+type TTabProps = {
+    name: string;
+    children?: ReactNode;
+};
+type TTabsProps = {
+    active: number;
+    activeColor?: string;
+    activeBg?: string;
+    inactiveColor?: string;
+    separatorColor?: string;
+    onSelect?: (index: number) => void;
+    children?: ReactNode;
+};
+type TStatusbarProps = {
+    left: string | Segment[];
+    right: string | Segment[];
+    bg?: string;
+    color?: string;
+};
+type TMarkdownProps = {
+    value: string;
+    themeOverrides?: MarkdownThemeOverrides;
+};
+type TJsonProps = {
+    value: unknown;
+    title?: string;
+};
+type THtmlProps = {
+    value: string;
+    themeOverrides?: MarkdownThemeOverrides;
+};
+type TLineProps = {
+    children?: ReactNode;
+};
+type TSpanProps = {
+    text?: string;
+    children?: ReactNode;
+    color?: string;
+    bg?: string;
+    bold?: boolean;
+    dim?: boolean;
+    inverted?: boolean;
+    blink?: boolean;
+};
+type TLayoutProps = {
+    layout: LayoutFn;
+};
+type TTreeProps = {
+    data: TreeNode[];
+    color?: string;
+    branchColor?: string;
+    leafColor?: string;
+};
+type TCodeProps = {
+    code: string;
+    language?: string;
+    title?: string;
+    borderColor?: string;
+};
+type TDiffProps = {
+    value: string;
+    addColor?: string;
+    removeColor?: string;
+    metaColor?: string;
+};
+type TBarProps = {
+    label: string;
+    value: number;
+    max?: number;
+    color?: string;
+};
+type TSparkProps = {
+    data: number[];
+    color?: string;
+};
+type TListProps = {
+    items: string[];
+    ordered?: boolean;
+    bulletColor?: string;
+    color?: string;
+};
+type TButtonProps = {
+    label: string;
+    onClick?: () => void;
+    color?: string;
+    bg?: string;
+};
+type RenderTermOptions = {
+    theme?: Theme;
+    themeSpec?: ThemeSpec;
+    mode?: ThemePreference;
+    markdownOverrides?: MarkdownThemeOverrides;
+};
+declare function TVStack({ children, gap }: TVStackProps): react.ReactElement<{
+    gap: number | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function THStack({ children, gap, widths }: THStackProps): react.ReactElement<{
+    gap: number | undefined;
+    widths: number[] | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TBox({ children, title, borderColor, gap }: TBoxProps): react.ReactElement<{
+    title: string | undefined;
+    borderColor: string | undefined;
+    gap: number | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TSeparator({ color }: TSeparatorProps): react.ReactElement<{
+    color: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TBlank(): react.DOMElement<{}, Element>;
+declare function TRaw({ children, text, color, bg, bold, dim, blink, inverted, onClick }: TRawProps): react.DOMElement<{
+    text: string | undefined;
+    color: string | undefined;
+    bg: string | undefined;
+    bold: boolean | undefined;
+    dim: boolean | undefined;
+    blink: boolean | undefined;
+    inverted: boolean | undefined;
+    onClick: (() => void) | undefined;
+}, Element>;
+declare function TTable<T extends Record<string, unknown>>({ columns, data, borderColor, fillWidth, headerColor, cellPadding, }: TTableProps<T>): react.ReactElement<{
+    columns: Column<T>[];
+    data: T[];
+    borderColor: string | undefined;
+    fillWidth: boolean | undefined;
+    headerColor: string | undefined;
+    cellPadding: number | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TTab({ name, children }: TTabProps): react.ReactElement<{
+    name: string;
+}, string | react.JSXElementConstructor<any>>;
+declare function TTabs({ children, active, activeColor, activeBg, inactiveColor, separatorColor, onSelect, }: TTabsProps): react.ReactElement<{
+    active: number;
+    activeColor: string | undefined;
+    activeBg: string | undefined;
+    inactiveColor: string | undefined;
+    separatorColor: string | undefined;
+    onSelect: ((index: number) => void) | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TStatusbar({ left, right, bg, color }: TStatusbarProps): react.ReactElement<{
+    left: string | Segment[];
+    right: string | Segment[];
+    bg: string | undefined;
+    color: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TMarkdown({ value, themeOverrides }: TMarkdownProps): react.ReactElement<{
+    value: string;
+    themeOverrides: Partial<ThemeMarkdown> | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TJson({ value, title }: TJsonProps): react.ReactElement<{
+    value: unknown;
+    title: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function THtml({ value, themeOverrides }: THtmlProps): react.ReactElement<{
+    value: string;
+    themeOverrides: Partial<ThemeMarkdown> | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TLine({ children }: TLineProps): react.DOMElement<{}, Element>;
+declare function TSpan({ children, text, color, bg, bold, dim, inverted, blink }: TSpanProps): react.ReactElement<{
+    text: string | undefined;
+    color: string | undefined;
+    bg: string | undefined;
+    bold: boolean | undefined;
+    dim: boolean | undefined;
+    inverted: boolean | undefined;
+    blink: boolean | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TLayout({ layout }: TLayoutProps): react.ReactElement<{
+    layout: LayoutFn;
+}, string | react.JSXElementConstructor<any>>;
+declare function TTree({ data, color, branchColor, leafColor }: TTreeProps): react.ReactElement<{
+    data: TreeNode[];
+    color: string | undefined;
+    branchColor: string | undefined;
+    leafColor: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TCode({ code, language, title, borderColor }: TCodeProps): react.ReactElement<{
+    code: string;
+    language: string | undefined;
+    title: string | undefined;
+    borderColor: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TDiff({ value, addColor, removeColor, metaColor }: TDiffProps): react.ReactElement<{
+    value: string;
+    addColor: string | undefined;
+    removeColor: string | undefined;
+    metaColor: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TBar({ label, value, max, color }: TBarProps): react.ReactElement<{
+    label: string;
+    value: number;
+    max: number | undefined;
+    color: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TSpark({ data, color }: TSparkProps): react.ReactElement<{
+    data: number[];
+    color: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TList({ items, ordered, bulletColor, color }: TListProps): react.ReactElement<{
+    items: string[];
+    ordered: boolean | undefined;
+    bulletColor: string | undefined;
+    color: string | undefined;
+}, string | react.JSXElementConstructor<any>>;
+declare function TButton({ label, onClick, color, bg }: TButtonProps): react.DOMElement<{
+    label: string;
+    onClick: (() => void) | undefined;
+    color: string | undefined;
+    bg: string | undefined;
+}, Element>;
+declare function renderTermReact(tree: ReactNode, opts?: RenderTermOptions): LayoutFn;
+
+declare function useSpinner(ms?: number): string;
+declare function useTick(ms?: number): number;
+declare function useTermWidth(ref: RefObject<HTMLElement | null>, fallback?: number): number;
+declare function useStreamingText(text: string, lerp?: number): string;
+
+export { type Block, type Column, type DocumentSource, type JsonNode, type LayoutFn, type Line, type MarkdownThemeOverrides, type RenderTermOptions, type Segment, type Style, TBar, type TBarProps, TBlank, TBox, type TBoxProps, TButton, type TButtonProps, TCode, type TCodeProps, TDiff, type TDiffProps, THStack, type THStackProps, THtml, type THtmlProps, TJson, type TJsonProps, TLayout, type TLayoutProps, TLine, type TLineProps, TList, type TListProps, TMarkdown, type TMarkdownProps, TRaw, type TRawProps, TSeparator, type TSeparatorProps, TSpan, type TSpanProps, TSpark, type TSparkProps, TStatusbar, type TStatusbarProps, TTab, type TTabProps, TTable, type TTableProps, TTabs, type TTabsProps, TTree, type TTreeProps, TVStack, type TVStackProps, TermDocument, type TermDocumentProps, type TermThemeContextValue, TermThemeProvider, type TermThemeProviderProps, TermUI, type TermUIProps, type Theme, type ThemeComponents, type ThemeMarkdown, type ThemeMode, type ThemeModeTokens, type ThemePalette, type ThemePreference, type ThemeSemantic, type ThemeSpec, type ThemeSyntax, type ThemeValidationIssue, type ThemeValidationResult, type Token, type TokenType, type TreeNode, badge, bar, blank, box, builtinThemes, code, dark, defaultThemeSpec, diff, fromDocument, fromHtml, fromJson, fromJsonNode, fromMarkdown, hl, hstack, isTableLine, light, lines, list, pad, padLine, parseThemeSpec, preserveTableTag, renderTermReact, resolveTheme, resolveThemeMode, separator, spark, statusbar, table, tabs, themeToCssVars, tokenColor, tokenize, tree, useSpinner, useStreamingText, useTermTheme, useTermWidth, useTick, validateThemeSpec, vstack };