terminal-richjs 0.1.0 → 0.2.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import cliSpinners, { SpinnerName as SpinnerName$1 } from 'cli-spinners';
+import { SpinnerName } from 'cli-spinners';
 import boxes from 'cli-boxes';
 import tinycolor from 'tinycolor2';
 
@@ -23,6 +23,10 @@ interface StyleOptions {
 }
 
 declare class Style {
+    /**
+     * Apply this style to text (alias for render).
+     */
+    apply(text: string): string;
     readonly color?: Color$1;
     readonly backgroundColor?: Color$1;
     readonly bold?: boolean;
@@ -175,22 +179,24 @@ interface Renderable {
  */
 declare function isRenderable(obj: unknown): obj is Renderable;
 
+interface StatusOptions {
+    spinnerName?: string;
+}
 declare class Status {
-    private live;
     private spinner;
     private message;
     private interval;
-    constructor(message: string, options?: {
-        console?: Console;
-        spinner?: SpinnerName$1;
-    });
+    private started;
+    private lastRenderedLines;
+    constructor(message: string, options?: StatusOptions);
     start(): void;
     stop(): void;
     update(message: string): void;
-    private render;
+    private refresh;
 }
 
 declare class Console {
+    error(message: any): void;
     private readonly terminal;
     private readonly markupParser;
     private readonly options;
@@ -210,7 +216,7 @@ declare class Console {
      * Displays a status spinner.
      */
     status(message: string, options?: {
-        spinner?: SpinnerName$1;
+        spinner?: SpinnerName;
     }): {
         start: () => void;
         stop: () => void;
@@ -220,7 +226,7 @@ declare class Console {
      * Run a task with a status spinner.
      */
     withStatus<T>(message: string, task: (status: Status) => Promise<T>, options?: {
-        spinner?: SpinnerName$1;
+        spinner?: SpinnerName;
     }): Promise<T>;
     /**
      * Renders a renderable object to a string.
@@ -484,6 +490,73 @@ declare class Align implements Renderable {
     __rich_console__(console: Console, options: ConsoleOptions): RenderResult;
 }
 
+/**
+ * Columns layout - display renderables in responsive columns
+ */
+/** biome-ignore-all lint/suspicious/noControlCharactersInRegex: false */
+/** biome-ignore-all assist/source/organizeImports: false */
+
+interface ColumnsOptions {
+    width?: number;
+    padding?: number;
+    expand?: boolean;
+    equal?: boolean;
+    columnFirst?: boolean;
+    rightToLeft?: boolean;
+    title?: string;
+}
+/**
+ * Display renderables in neat columns that adapt to terminal width.
+ */
+declare class Columns implements Renderable {
+    private renderables;
+    private options;
+    constructor(renderables?: Iterable<string | Renderable>, options?: ColumnsOptions);
+    /**
+     * Add a renderable to the columns.
+     */
+    add(renderable: string | Renderable): this;
+    __rich_console__(console: Console, consoleOptions: ConsoleOptions): RenderResult;
+    /**
+     * Get the display width of a string (accounting for ANSI codes).
+     */
+    private getDisplayWidth;
+    /**
+     * Pad an item to the specified width.
+     */
+    private padItem;
+}
+
+/**
+ * JSON renderable - pretty-printed and syntax-highlighted JSON
+ */
+/** biome-ignore-all lint/suspicious/noShadowRestrictedNames: false */
+/** biome-ignore-all assist/source/organizeImports: false */
+
+interface JSONOptions {
+    indent?: number | string;
+    highlight?: boolean;
+    sortKeys?: boolean;
+}
+/**
+ * A renderable which pretty prints JSON with syntax highlighting.
+ */
+declare class JSON implements Renderable {
+    private readonly text;
+    private readonly highlight;
+    constructor(json: string, options?: JSONOptions);
+    /**
+     * Create JSON from any data object.
+     */
+    static fromData(data: unknown, options?: JSONOptions): JSON;
+    private sortObject;
+    /**
+     * Apply JSON syntax highlighting.
+     */
+    private highlightJSON;
+    __rich_console__(_console: Console, _consoleOptions: ConsoleOptions): RenderResult;
+}
+
 interface TracebackOptions {
     showLocals?: boolean;
     extraLines?: number;
@@ -595,7 +668,7 @@ declare class Markdown implements Renderable {
     __rich_console__(_console: Console, _options: ConsoleOptions): RenderResult;
 }
 
-/** biome-ignore-all assist/source/organizeImports: falses */
+/** biome-ignore-all assist/source/organizeImports: false */
 
 interface ProgressBarOptions {
     width?: number;
@@ -615,6 +688,7 @@ declare class ProgressBar implements Renderable {
     readonly total: number;
     readonly completed: number;
     readonly options: ProgressBarOptions;
+    render(_arg0: number): void;
     private pulseOffset;
     private lastPulseTime;
     constructor(total?: number, completed?: number, options?: ProgressBarOptions);
@@ -649,16 +723,12 @@ declare class TimeRemainingColumn implements Renderable {
     __rich_console__(_console: Console, _options: ConsoleOptions): RenderResult;
 }
 
-interface ProgressOptions {
-    console?: Console;
-    autoRefresh?: boolean;
-}
 declare class Progress {
     private tasks;
-    private live;
-    private console;
     private taskIdCounter;
-    constructor(options?: ProgressOptions);
+    private started;
+    private refreshInterval;
+    private lastRenderedLines;
     addTask(description: string, options?: {
         total?: number;
         completed?: number;
@@ -670,6 +740,7 @@ declare class Progress {
     start(): void;
     stop(): void;
     private refresh;
+    private renderSimpleBar;
 }
 
 /**
@@ -677,17 +748,121 @@ declare class Progress {
  */
 declare function track<T>(sequence: Iterable<T> | T[], description?: string): Generator<T>;
 
-type SpinnerName = keyof typeof cliSpinners;
+/**
+ * Spinner renderable - animated spinners for status display
+ */
+/** biome-ignore-all assist/source/organizeImports: false */
+
+interface SpinnerOptions {
+    text?: string;
+    style?: string;
+    speed?: number;
+}
+/**
+ * A spinner animation that can be rendered with Live updates.
+ */
 declare class Spinner implements Renderable {
-    readonly name: SpinnerName;
-    readonly style: Style;
-    private frame;
-    private readonly spinner;
-    constructor(name?: SpinnerName, style?: Style);
-    get currentFrame(): string;
-    __rich_console__(_console: Console, _options: ConsoleOptions): RenderResult;
-    nextFrame(): void;
+    readonly name: string;
+    readonly frames: string[];
+    readonly interval: number;
+    text: string;
+    style: string;
+    speed: number;
+    private startTime;
+    private frameNoOffset;
+    constructor(name?: string, options?: SpinnerOptions);
+    /**
+     * Render the spinner for a given time.
+     */
+    render(time: number): string;
+    /**
+     * Get the current frame without time advancement (for static rendering).
+     */
+    getCurrentFrame(): string;
+    /**
+     * Update spinner properties.
+     */
+    update(options: Partial<SpinnerOptions>): void;
+    __rich_console__(_console: Console, _consoleOptions: ConsoleOptions): RenderResult;
 }
+/**
+ * List all available spinner names.
+ */
+declare function listSpinners$1(): string[];
+
+/**
+ * Live display - updates content in place
+ */
+interface LiveOptions {
+    refreshPerSecond?: number;
+    transient?: boolean;
+}
+/**
+ * Renders an auto-updating live display.
+ *
+ * @example
+ * ```typescript
+ * const live = new Live();
+ *
+ * await live.start(async (update) => {
+ *   for (let i = 0; i <= 100; i++) {
+ *     update(`Progress: ${i}%`);
+ *     await sleep(50);
+ *   }
+ * });
+ * ```
+ */
+declare class Live {
+    private transient;
+    private started;
+    private refreshThread;
+    private lastRenderedLines;
+    private currentContent;
+    constructor(options?: LiveOptions);
+    /**
+     * Check if live display is currently running.
+     */
+    get isStarted(): boolean;
+    /**
+     * Update the displayed content.
+     */
+    update(content: string): void;
+    /**
+     * Refresh the display with current content.
+     */
+    private refresh;
+    /**
+     * Start live display with a callback function.
+     * The callback receives an update function to change the displayed content.
+     */
+    start(callback: (update: (content: string) => void) => Promise<void> | void): Promise<void>;
+    /**
+     * Stop live display.
+     */
+    stop(): void;
+}
+/**
+ * Helper function to sleep for a given number of milliseconds.
+ */
+declare function sleep(ms: number): Promise<void>;
+
+/**
+ * Spinner animation definitions
+ * Ported from Python Rich / cli-spinners
+ */
+interface SpinnerData {
+    interval: number;
+    frames: string[] | string;
+}
+declare const SPINNERS: Record<string, SpinnerData>;
+/**
+ * Get spinner data by name
+ */
+declare function getSpinner(name: string): SpinnerData | undefined;
+/**
+ * List all available spinner names
+ */
+declare function listSpinners(): string[];
 
 declare class Color {
     private tc;
@@ -710,6 +885,25 @@ declare class Color {
     getContrastColor(): Color;
 }
 
+/**
+ * Emoji codes database - common emoji shortcodes
+ * Subset of Python Rich's emoji database for practical use
+ */
+declare const EMOJI: Record<string, string>;
+/**
+ * Replace emoji shortcodes in text with actual emoji characters.
+ * Shortcodes are in the format :emoji_name:
+ */
+declare function replaceEmoji(text: string): string;
+/**
+ * Get all available emoji names
+ */
+declare function listEmoji(): string[];
+/**
+ * Check if an emoji shortcode exists
+ */
+declare function hasEmoji(name: string): boolean;
+
 type LogLevel = 'debug' | 'info' | 'warn' | 'error';
 interface LogRecord {
     level: LogLevel;
@@ -748,4 +942,4 @@ declare function inspect(obj: any, options?: InspectOptions): void;
 
 declare const print: (...objects: any[]) => void;
 
-export { Align, type BoxData, type BoxStyle, Color, type ColorSystem, Confirm, Console, type ConsoleOptions, DEFAULT_THEME, DRACULA, GITHUB_LIGHT, Grid, Layout, Logger, MONOKAI, MONOKAI_THEME, Markdown, MarkupParser, ONE_DARK, Padding, Palette, Panel, PercentageColumn, Progress, ProgressBar, Prompt, type RGB, type RenderResult, type Renderable, RichHandler, Rule, SYNTAX_THEMES, Segment, Spinner, type StandardColor, Status, Style, type StyleOptions, Syntax, type SyntaxTheme, Table, Text, Theme, TimeElapsedColumn, TimeRemainingColumn, Traceback, Tree, getBox, getTheme, inspect, install, installTracebackHandler, isRenderable, listBoxStyles, print, track };
+export { Align, type BoxData, type BoxStyle, Color, type ColorSystem, Columns, Confirm, Console, type ConsoleOptions, DEFAULT_THEME, DRACULA, EMOJI, GITHUB_LIGHT, Grid, JSON, Layout, Live, Logger, MONOKAI, MONOKAI_THEME, Markdown, MarkupParser, ONE_DARK, Padding, Palette, Panel, PercentageColumn, Progress, ProgressBar, Prompt, type RGB, type RenderResult, type Renderable, RichHandler, Rule, SPINNERS, SYNTAX_THEMES, Segment, Spinner, type SpinnerData, type StandardColor, Status, Style, type StyleOptions, Syntax, type SyntaxTheme, Table, Text, Theme, TimeElapsedColumn, TimeRemainingColumn, Traceback, Tree, getBox, getSpinner, listSpinners as getSpinnerNames, getTheme, hasEmoji, inspect, install, installTracebackHandler, isRenderable, listBoxStyles, listEmoji, listSpinners$1 as listSpinners, print, replaceEmoji, sleep, track };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import cliSpinners, { SpinnerName as SpinnerName$1 } from 'cli-spinners';
+import { SpinnerName } from 'cli-spinners';
 import boxes from 'cli-boxes';
 import tinycolor from 'tinycolor2';
 
@@ -23,6 +23,10 @@ interface StyleOptions {
 }
 
 declare class Style {
+    /**
+     * Apply this style to text (alias for render).
+     */
+    apply(text: string): string;
     readonly color?: Color$1;
     readonly backgroundColor?: Color$1;
     readonly bold?: boolean;
@@ -175,22 +179,24 @@ interface Renderable {
  */
 declare function isRenderable(obj: unknown): obj is Renderable;
 
+interface StatusOptions {
+    spinnerName?: string;
+}
 declare class Status {
-    private live;
     private spinner;
     private message;
     private interval;
-    constructor(message: string, options?: {
-        console?: Console;
-        spinner?: SpinnerName$1;
-    });
+    private started;
+    private lastRenderedLines;
+    constructor(message: string, options?: StatusOptions);
     start(): void;
     stop(): void;
     update(message: string): void;
-    private render;
+    private refresh;
 }
 
 declare class Console {
+    error(message: any): void;
     private readonly terminal;
     private readonly markupParser;
     private readonly options;
@@ -210,7 +216,7 @@ declare class Console {
      * Displays a status spinner.
      */
     status(message: string, options?: {
-        spinner?: SpinnerName$1;
+        spinner?: SpinnerName;
     }): {
         start: () => void;
         stop: () => void;
@@ -220,7 +226,7 @@ declare class Console {
      * Run a task with a status spinner.
      */
     withStatus<T>(message: string, task: (status: Status) => Promise<T>, options?: {
-        spinner?: SpinnerName$1;
+        spinner?: SpinnerName;
     }): Promise<T>;
     /**
      * Renders a renderable object to a string.
@@ -484,6 +490,73 @@ declare class Align implements Renderable {
     __rich_console__(console: Console, options: ConsoleOptions): RenderResult;
 }
 
+/**
+ * Columns layout - display renderables in responsive columns
+ */
+/** biome-ignore-all lint/suspicious/noControlCharactersInRegex: false */
+/** biome-ignore-all assist/source/organizeImports: false */
+
+interface ColumnsOptions {
+    width?: number;
+    padding?: number;
+    expand?: boolean;
+    equal?: boolean;
+    columnFirst?: boolean;
+    rightToLeft?: boolean;
+    title?: string;
+}
+/**
+ * Display renderables in neat columns that adapt to terminal width.
+ */
+declare class Columns implements Renderable {
+    private renderables;
+    private options;
+    constructor(renderables?: Iterable<string | Renderable>, options?: ColumnsOptions);
+    /**
+     * Add a renderable to the columns.
+     */
+    add(renderable: string | Renderable): this;
+    __rich_console__(console: Console, consoleOptions: ConsoleOptions): RenderResult;
+    /**
+     * Get the display width of a string (accounting for ANSI codes).
+     */
+    private getDisplayWidth;
+    /**
+     * Pad an item to the specified width.
+     */
+    private padItem;
+}
+
+/**
+ * JSON renderable - pretty-printed and syntax-highlighted JSON
+ */
+/** biome-ignore-all lint/suspicious/noShadowRestrictedNames: false */
+/** biome-ignore-all assist/source/organizeImports: false */
+
+interface JSONOptions {
+    indent?: number | string;
+    highlight?: boolean;
+    sortKeys?: boolean;
+}
+/**
+ * A renderable which pretty prints JSON with syntax highlighting.
+ */
+declare class JSON implements Renderable {
+    private readonly text;
+    private readonly highlight;
+    constructor(json: string, options?: JSONOptions);
+    /**
+     * Create JSON from any data object.
+     */
+    static fromData(data: unknown, options?: JSONOptions): JSON;
+    private sortObject;
+    /**
+     * Apply JSON syntax highlighting.
+     */
+    private highlightJSON;
+    __rich_console__(_console: Console, _consoleOptions: ConsoleOptions): RenderResult;
+}
+
 interface TracebackOptions {
     showLocals?: boolean;
     extraLines?: number;
@@ -595,7 +668,7 @@ declare class Markdown implements Renderable {
     __rich_console__(_console: Console, _options: ConsoleOptions): RenderResult;
 }
 
-/** biome-ignore-all assist/source/organizeImports: falses */
+/** biome-ignore-all assist/source/organizeImports: false */
 
 interface ProgressBarOptions {
     width?: number;
@@ -615,6 +688,7 @@ declare class ProgressBar implements Renderable {
     readonly total: number;
     readonly completed: number;
     readonly options: ProgressBarOptions;
+    render(_arg0: number): void;
     private pulseOffset;
     private lastPulseTime;
     constructor(total?: number, completed?: number, options?: ProgressBarOptions);
@@ -649,16 +723,12 @@ declare class TimeRemainingColumn implements Renderable {
     __rich_console__(_console: Console, _options: ConsoleOptions): RenderResult;
 }
 
-interface ProgressOptions {
-    console?: Console;
-    autoRefresh?: boolean;
-}
 declare class Progress {
     private tasks;
-    private live;
-    private console;
     private taskIdCounter;
-    constructor(options?: ProgressOptions);
+    private started;
+    private refreshInterval;
+    private lastRenderedLines;
     addTask(description: string, options?: {
         total?: number;
         completed?: number;
@@ -670,6 +740,7 @@ declare class Progress {
     start(): void;
     stop(): void;
     private refresh;
+    private renderSimpleBar;
 }
 
 /**
@@ -677,17 +748,121 @@ declare class Progress {
  */
 declare function track<T>(sequence: Iterable<T> | T[], description?: string): Generator<T>;
 
-type SpinnerName = keyof typeof cliSpinners;
+/**
+ * Spinner renderable - animated spinners for status display
+ */
+/** biome-ignore-all assist/source/organizeImports: false */
+
+interface SpinnerOptions {
+    text?: string;
+    style?: string;
+    speed?: number;
+}
+/**
+ * A spinner animation that can be rendered with Live updates.
+ */
 declare class Spinner implements Renderable {
-    readonly name: SpinnerName;
-    readonly style: Style;
-    private frame;
-    private readonly spinner;
-    constructor(name?: SpinnerName, style?: Style);
-    get currentFrame(): string;
-    __rich_console__(_console: Console, _options: ConsoleOptions): RenderResult;
-    nextFrame(): void;
+    readonly name: string;
+    readonly frames: string[];
+    readonly interval: number;
+    text: string;
+    style: string;
+    speed: number;
+    private startTime;
+    private frameNoOffset;
+    constructor(name?: string, options?: SpinnerOptions);
+    /**
+     * Render the spinner for a given time.
+     */
+    render(time: number): string;
+    /**
+     * Get the current frame without time advancement (for static rendering).
+     */
+    getCurrentFrame(): string;
+    /**
+     * Update spinner properties.
+     */
+    update(options: Partial<SpinnerOptions>): void;
+    __rich_console__(_console: Console, _consoleOptions: ConsoleOptions): RenderResult;
 }
+/**
+ * List all available spinner names.
+ */
+declare function listSpinners$1(): string[];
+
+/**
+ * Live display - updates content in place
+ */
+interface LiveOptions {
+    refreshPerSecond?: number;
+    transient?: boolean;
+}
+/**
+ * Renders an auto-updating live display.
+ *
+ * @example
+ * ```typescript
+ * const live = new Live();
+ *
+ * await live.start(async (update) => {
+ *   for (let i = 0; i <= 100; i++) {
+ *     update(`Progress: ${i}%`);
+ *     await sleep(50);
+ *   }
+ * });
+ * ```
+ */
+declare class Live {
+    private transient;
+    private started;
+    private refreshThread;
+    private lastRenderedLines;
+    private currentContent;
+    constructor(options?: LiveOptions);
+    /**
+     * Check if live display is currently running.
+     */
+    get isStarted(): boolean;
+    /**
+     * Update the displayed content.
+     */
+    update(content: string): void;
+    /**
+     * Refresh the display with current content.
+     */
+    private refresh;
+    /**
+     * Start live display with a callback function.
+     * The callback receives an update function to change the displayed content.
+     */
+    start(callback: (update: (content: string) => void) => Promise<void> | void): Promise<void>;
+    /**
+     * Stop live display.
+     */
+    stop(): void;
+}
+/**
+ * Helper function to sleep for a given number of milliseconds.
+ */
+declare function sleep(ms: number): Promise<void>;
+
+/**
+ * Spinner animation definitions
+ * Ported from Python Rich / cli-spinners
+ */
+interface SpinnerData {
+    interval: number;
+    frames: string[] | string;
+}
+declare const SPINNERS: Record<string, SpinnerData>;
+/**
+ * Get spinner data by name
+ */
+declare function getSpinner(name: string): SpinnerData | undefined;
+/**
+ * List all available spinner names
+ */
+declare function listSpinners(): string[];
 
 declare class Color {
     private tc;
@@ -710,6 +885,25 @@ declare class Color {
     getContrastColor(): Color;
 }
 
+/**
+ * Emoji codes database - common emoji shortcodes
+ * Subset of Python Rich's emoji database for practical use
+ */
+declare const EMOJI: Record<string, string>;
+/**
+ * Replace emoji shortcodes in text with actual emoji characters.
+ * Shortcodes are in the format :emoji_name:
+ */
+declare function replaceEmoji(text: string): string;
+/**
+ * Get all available emoji names
+ */
+declare function listEmoji(): string[];
+/**
+ * Check if an emoji shortcode exists
+ */
+declare function hasEmoji(name: string): boolean;
+
 type LogLevel = 'debug' | 'info' | 'warn' | 'error';
 interface LogRecord {
     level: LogLevel;
@@ -748,4 +942,4 @@ declare function inspect(obj: any, options?: InspectOptions): void;
 
 declare const print: (...objects: any[]) => void;
 
-export { Align, type BoxData, type BoxStyle, Color, type ColorSystem, Confirm, Console, type ConsoleOptions, DEFAULT_THEME, DRACULA, GITHUB_LIGHT, Grid, Layout, Logger, MONOKAI, MONOKAI_THEME, Markdown, MarkupParser, ONE_DARK, Padding, Palette, Panel, PercentageColumn, Progress, ProgressBar, Prompt, type RGB, type RenderResult, type Renderable, RichHandler, Rule, SYNTAX_THEMES, Segment, Spinner, type StandardColor, Status, Style, type StyleOptions, Syntax, type SyntaxTheme, Table, Text, Theme, TimeElapsedColumn, TimeRemainingColumn, Traceback, Tree, getBox, getTheme, inspect, install, installTracebackHandler, isRenderable, listBoxStyles, print, track };
+export { Align, type BoxData, type BoxStyle, Color, type ColorSystem, Columns, Confirm, Console, type ConsoleOptions, DEFAULT_THEME, DRACULA, EMOJI, GITHUB_LIGHT, Grid, JSON, Layout, Live, Logger, MONOKAI, MONOKAI_THEME, Markdown, MarkupParser, ONE_DARK, Padding, Palette, Panel, PercentageColumn, Progress, ProgressBar, Prompt, type RGB, type RenderResult, type Renderable, RichHandler, Rule, SPINNERS, SYNTAX_THEMES, Segment, Spinner, type SpinnerData, type StandardColor, Status, Style, type StyleOptions, Syntax, type SyntaxTheme, Table, Text, Theme, TimeElapsedColumn, TimeRemainingColumn, Traceback, Tree, getBox, getSpinner, listSpinners as getSpinnerNames, getTheme, hasEmoji, inspect, install, installTracebackHandler, isRenderable, listBoxStyles, listEmoji, listSpinners$1 as listSpinners, print, replaceEmoji, sleep, track };