@promptctl/rich-js 0.17.0 → 0.18.0

package/dist/renderables/progressBar.js

@@ -1,52 +0,0 @@
-/**
- * ProgressBar — a visual progress bar rendered with block characters.
- */
-import { Segment } from "../core/segment.js";
-import { NULL_STYLE } from "../core/style.js";
-import { getStyle } from "../core/protocol.js";
-const FULL_BLOCK = "━";
-const EMPTY_BLOCK = "━";
-export class ProgressBar {
-    total;
-    completed;
-    width;
-    pulse;
-    style;
-    completeStyle;
-    finishedStyle;
-    constructor(options) {
-        this.total = options?.total ?? 100;
-        this.completed = options?.completed ?? 0;
-        this.width = options?.width;
-        this.pulse = options?.pulse ?? false;
-        this.style = options?.style ?? NULL_STYLE;
-        this.completeStyle = options?.completeStyle ?? "bar.complete";
-        this.finishedStyle = options?.finishedStyle ?? "bar.finished";
-    }
-    get percentComplete() {
-        if (this.total <= 0)
-            return 0;
-        return Math.min(1, Math.max(0, this.completed / this.total));
-    }
-    *render(options) {
-        const barWidth = this.width ?? Math.min(40, options.maxWidth);
-        const percent = this.percentComplete;
-        const isFinished = percent >= 1;
-        const filledWidth = Math.round(barWidth * percent);
-        const emptyWidth = barWidth - filledWidth;
-        const fill = getStyle(options, isFinished ? this.finishedStyle : this.completeStyle);
-        const back = getStyle(options, this.style);
-        const fillStyle = fill.isNull ? undefined : fill;
-        const bgStyle = back.isNull ? undefined : back;
-        if (filledWidth > 0) {
-            yield new Segment(FULL_BLOCK.repeat(filledWidth), fillStyle);
-        }
-        if (emptyWidth > 0) {
-            yield new Segment(EMPTY_BLOCK.repeat(emptyWidth), bgStyle);
-        }
-    }
-    measure(_options) {
-        const w = this.width ?? 40;
-        return { minimum: 4, maximum: w };
-    }
-}

package/dist/renderables/prompt.d.ts

@@ -1,49 +0,0 @@
-/**
- * Prompt — interactive prompts for user input.
- *
- * [LAW:locality-or-seam] The renderable owns prompt logic (display, choice
- * validation, default fallback, retry loop) — but not where the answer comes
- * from. The input source is a required `PromptInput` capability passed at the
- * call site. Node consumers pass `nodeAsk` from
- * `@promptctl/rich-js/node/prompt`; tests pass a fake; the browser bundle
- * gets the classes without dragging `node:readline` into the main barrel.
- *
- * [LAW:types-are-the-program] The `input: PromptInput` parameter is
- * positional and required on every `*.ask()` static — not an optional in
- * `PromptOptions`. The previous shape allowed `Prompt.ask("name?")` at the
- * type level and threw at runtime; the new shape makes the missing-capability
- * state unrepresentable to TS callers.
- *
- * A trust-boundary `typeof === "function"` check remains because the public
- * API surface is reachable from JS (no compile-time types) and from
- * `any`-typed TS callers. The check makes the failure *diagnostic* (points
- * the caller at the node helper), not gatekeep-against-bugs — TS users
- * never see it because the type already forbids the bad state.
- */
-/**
- * Input capability: receives the rendered prompt string (always with a
- * trailing space appended by the renderable, so implementations should not
- * add their own), resolves with the raw user response. Implementations
- * decide where the input comes from (stdin readline, network, in-memory
- * queue, etc.).
- */
-export type PromptInput = (prompt: string) => Promise<string>;
-export interface PromptOptions<T> {
-    default?: T;
-    choices?: string[];
-    caseSensitive?: boolean;
-    showChoices?: boolean;
-    showDefault?: boolean;
-}
-export declare class Prompt {
-    static ask(promptText: string, input: PromptInput, options?: PromptOptions<string>): Promise<string>;
-}
-export declare class IntPrompt {
-    static ask(promptText: string, input: PromptInput, options?: PromptOptions<number>): Promise<number>;
-}
-export declare class FloatPrompt {
-    static ask(promptText: string, input: PromptInput, options?: PromptOptions<number>): Promise<number>;
-}
-export declare class Confirm {
-    static ask(promptText: string, input: PromptInput, options?: PromptOptions<boolean>): Promise<boolean>;
-}

package/dist/renderables/prompt.js

@@ -1,125 +0,0 @@
-/**
- * Prompt — interactive prompts for user input.
- *
- * [LAW:locality-or-seam] The renderable owns prompt logic (display, choice
- * validation, default fallback, retry loop) — but not where the answer comes
- * from. The input source is a required `PromptInput` capability passed at the
- * call site. Node consumers pass `nodeAsk` from
- * `@promptctl/rich-js/node/prompt`; tests pass a fake; the browser bundle
- * gets the classes without dragging `node:readline` into the main barrel.
- *
- * [LAW:types-are-the-program] The `input: PromptInput` parameter is
- * positional and required on every `*.ask()` static — not an optional in
- * `PromptOptions`. The previous shape allowed `Prompt.ask("name?")` at the
- * type level and threw at runtime; the new shape makes the missing-capability
- * state unrepresentable to TS callers.
- *
- * A trust-boundary `typeof === "function"` check remains because the public
- * API surface is reachable from JS (no compile-time types) and from
- * `any`-typed TS callers. The check makes the failure *diagnostic* (points
- * the caller at the node helper), not gatekeep-against-bugs — TS users
- * never see it because the type already forbids the bad state.
- */
-import { renderMarkup } from "../core/markup.js";
-// --- Base ---
-function ask(promptText, input) {
-    // [LAW:single-enforcer] Trust-boundary validation for non-TS callers
-    // (JS, or TS with `any` laundering). TS callers can't reach this branch
-    // because `PromptInput` is required at every static `.ask`. The message
-    // points at the node helper rather than letting the call site die with
-    // a generic `TypeError: input is not a function`.
-    if (typeof input !== "function") {
-        throw new TypeError("Prompt: `input` must be a `PromptInput` function. Pass `nodeAsk` from " +
-            "`@promptctl/rich-js/node/prompt` for Node, or supply a custom " +
-            "`PromptInput` for tests/browsers.");
-    }
-    const rendered = renderMarkup(promptText);
-    return input(rendered.plain + " ");
-}
-// --- Prompt ---
-export class Prompt {
-    static async ask(promptText, input, options) {
-        const showDefault = options?.showDefault !== false;
-        const showChoices = options?.showChoices !== false;
-        let display = promptText;
-        if (showChoices && options?.choices) {
-            display += ` [${options.choices.join("/")}]`;
-        }
-        if (showDefault && options?.default !== undefined) {
-            display += ` (${options.default})`;
-        }
-        display += ":";
-        while (true) {
-            const answer = await ask(display, input);
-            const value = answer.trim();
-            if (value === "" && options?.default !== undefined) {
-                return options.default;
-            }
-            if (options?.choices) {
-                const caseSensitive = options.caseSensitive !== false;
-                const match = options.choices.find((c) => caseSensitive ? c === value : c.toLowerCase() === value.toLowerCase());
-                if (match)
-                    return match;
-                continue;
-            }
-            return value;
-        }
-    }
-}
-export class IntPrompt {
-    static async ask(promptText, input, options) {
-        const showDefault = options?.showDefault !== false;
-        let display = promptText;
-        if (showDefault && options?.default !== undefined) {
-            display += ` (${options.default})`;
-        }
-        display += ":";
-        while (true) {
-            const answer = await ask(display, input);
-            const value = answer.trim();
-            if (value === "" && options?.default !== undefined) {
-                return options.default;
-            }
-            const num = parseInt(value, 10);
-            if (!isNaN(num) && String(num) === value)
-                return num;
-        }
-    }
-}
-export class FloatPrompt {
-    static async ask(promptText, input, options) {
-        const showDefault = options?.showDefault !== false;
-        let display = promptText;
-        if (showDefault && options?.default !== undefined) {
-            display += ` (${options.default})`;
-        }
-        display += ":";
-        while (true) {
-            const answer = await ask(display, input);
-            const value = answer.trim();
-            if (value === "" && options?.default !== undefined) {
-                return options.default;
-            }
-            const num = parseFloat(value);
-            if (!isNaN(num))
-                return num;
-        }
-    }
-}
-export class Confirm {
-    static async ask(promptText, input, options) {
-        const defaultVal = options?.default;
-        const yesNo = defaultVal === true ? "Y/n" : defaultVal === false ? "y/N" : "y/n";
-        const display = `${promptText} [${yesNo}]:`;
-        while (true) {
-            const answer = await ask(display, input);
-            const value = answer.trim().toLowerCase();
-            if (value === "" && defaultVal !== undefined)
-                return defaultVal;
-            if (value === "y" || value === "yes")
-                return true;
-            if (value === "n" || value === "no")
-                return false;
-        }
-    }
-}

package/dist/renderables/rule.d.ts

@@ -1,24 +0,0 @@
-/**
- * Rule — a horizontal divider line, optionally with a centered title.
- */
-import { Segment } from "../core/segment.js";
-import { Style } from "../core/style.js";
-import type { Renderable, Measurable, RenderOptions } from "../core/protocol.js";
-export type RuleAlign = "left" | "center" | "right";
-export interface RuleOptions {
-    characters?: string;
-    align?: RuleAlign;
-    style?: string | Style;
-}
-export declare class Rule implements Renderable, Measurable {
-    readonly title: string | undefined;
-    readonly characters: string;
-    readonly align: RuleAlign;
-    readonly style: string | Style;
-    constructor(title?: string, options?: RuleOptions);
-    render(options: RenderOptions): Iterable<Segment>;
-    measure(_options: RenderOptions): {
-        minimum: number;
-        maximum: number;
-    };
-}

package/dist/renderables/rule.js

@@ -1,90 +0,0 @@
-/**
- * Rule — a horizontal divider line, optionally with a centered title.
- */
-import { cellLen } from "../core/cells.js";
-import { Segment } from "../core/segment.js";
-import { NULL_STYLE } from "../core/style.js";
-import { getStyle } from "../core/protocol.js";
-const ASCII_RULE_CHAR = "-";
-const DEFAULT_RULE_CHAR = "\u2500"; // ─
-export class Rule {
-    title;
-    characters;
-    align;
-    style;
-    constructor(title, options) {
-        const chars = options?.characters ?? DEFAULT_RULE_CHAR;
-        if (chars.length === 0) {
-            throw new Error("Rule characters must not be empty");
-        }
-        const align = options?.align;
-        if (align !== undefined && align !== "left" && align !== "center" && align !== "right") {
-            throw new Error(`Invalid align value: "${align}"`);
-        }
-        this.title = title;
-        this.characters = chars;
-        this.align = align ?? "center";
-        this.style = options?.style ?? NULL_STYLE;
-    }
-    *render(options) {
-        const maxWidth = options.maxWidth;
-        const ruleChar = options.asciiOnly ? ASCII_RULE_CHAR : this.characters;
-        const style = getStyle(options, this.style);
-        const ruleStyle = style.isNull ? undefined : style;
-        if (!this.title) {
-            // No title — just a line of repeated characters
-            yield new Segment(repeatToWidth(ruleChar, maxWidth), ruleStyle);
-            yield Segment.line();
-            return;
-        }
-        // With title
-        const titleText = ` ${this.title} `;
-        const titleWidth = cellLen(titleText);
-        if (titleWidth >= maxWidth) {
-            // Title fills the whole width
-            yield new Segment(titleText.slice(0, maxWidth), ruleStyle);
-            yield Segment.line();
-            return;
-        }
-        const remaining = maxWidth - titleWidth;
-        // [LAW:dataflow-not-control-flow] Always compute both sides; alignment determines distribution
-        const leftWidth = this.align === "right"
-            ? remaining
-            : this.align === "center"
-                ? Math.floor(remaining / 2)
-                : 0;
-        const rightWidth = remaining - leftWidth;
-        if (leftWidth > 0) {
-            yield new Segment(repeatToWidth(ruleChar, leftWidth), ruleStyle);
-        }
-        yield new Segment(titleText, ruleStyle);
-        if (rightWidth > 0) {
-            yield new Segment(repeatToWidth(ruleChar, rightWidth), ruleStyle);
-        }
-        yield Segment.line();
-    }
-    measure(_options) {
-        return { minimum: 1, maximum: _options.maxWidth };
-    }
-}
-function repeatToWidth(char, width) {
-    const charWidth = cellLen(char);
-    if (charWidth === 0)
-        return " ".repeat(width);
-    const repeats = Math.ceil(width / charWidth);
-    const full = char.repeat(repeats);
-    // Trim to exact width
-    let w = 0;
-    let i = 0;
-    for (const c of full) {
-        const cw = cellLen(c);
-        if (w + cw > width)
-            break;
-        w += cw;
-        i += c.length;
-    }
-    const result = full.slice(0, i);
-    // Pad if needed (wide char couldn't fill exact width)
-    const gap = width - w;
-    return gap > 0 ? result + " ".repeat(gap) : result;
-}

package/dist/renderables/spinner.d.ts

@@ -1,29 +0,0 @@
-/**
- * Spinner — animated terminal spinner with optional text label.
- */
-import { Segment } from "../core/segment.js";
-import { Style } from "../core/style.js";
-import type { Renderable, Measurable, RenderOptions } from "../core/protocol.js";
-export interface SpinnerOptions {
-    speed?: number;
-    style?: string | Style;
-}
-export declare class Spinner implements Renderable, Measurable {
-    readonly name: string;
-    readonly text: string | undefined;
-    readonly speed: number;
-    readonly style: string | Style;
-    private readonly _data;
-    private _frameIndex;
-    private _lastUpdate;
-    constructor(name?: string, text?: string, options?: SpinnerOptions);
-    get frames(): readonly string[];
-    get interval(): number;
-    /** Advance frame based on elapsed time and return current frame. */
-    private _currentFrame;
-    render(options: RenderOptions): Iterable<Segment>;
-    measure(_options: RenderOptions): {
-        minimum: number;
-        maximum: number;
-    };
-}

package/dist/renderables/spinner.js

@@ -1,64 +0,0 @@
-/**
- * Spinner — animated terminal spinner with optional text label.
- */
-import { cellLen } from "../core/cells.js";
-import { Segment } from "../core/segment.js";
-import { NULL_STYLE } from "../core/style.js";
-import { SPINNERS, DEFAULT_SPINNER } from "../core/spinnerData.js";
-import { getStyle } from "../core/protocol.js";
-export class Spinner {
-    name;
-    text;
-    speed;
-    style;
-    _data;
-    _frameIndex;
-    _lastUpdate;
-    constructor(name, text, options) {
-        const spinnerName = name ?? DEFAULT_SPINNER;
-        const data = SPINNERS[spinnerName];
-        if (!data) {
-            throw new Error(`Unknown spinner: "${spinnerName}"`);
-        }
-        this.name = spinnerName;
-        this.text = text;
-        this.speed = options?.speed ?? 1;
-        this.style = options?.style ?? NULL_STYLE;
-        this._data = data;
-        this._frameIndex = 0;
-        this._lastUpdate = Date.now();
-    }
-    get frames() {
-        return this._data.frames;
-    }
-    get interval() {
-        return this._data.interval;
-    }
-    /** Advance frame based on elapsed time and return current frame. */
-    _currentFrame() {
-        const now = Date.now();
-        const elapsed = now - this._lastUpdate;
-        const effectiveInterval = this.interval / this.speed;
-        if (elapsed >= effectiveInterval) {
-            const steps = Math.floor(elapsed / effectiveInterval);
-            this._frameIndex = (this._frameIndex + steps) % this._data.frames.length;
-            this._lastUpdate = now;
-        }
-        return this._data.frames[this._frameIndex];
-    }
-    *render(options) {
-        const frame = this._currentFrame();
-        const style = getStyle(options, this.style);
-        const spinStyle = style.isNull ? undefined : style;
-        yield new Segment(frame, spinStyle);
-        if (this.text) {
-            yield new Segment(` ${this.text}`);
-        }
-    }
-    measure(_options) {
-        const frameWidth = Math.max(...this._data.frames.map((f) => cellLen(f)));
-        const textWidth = this.text ? cellLen(this.text) + 1 : 0;
-        const total = frameWidth + textWidth;
-        return { minimum: frameWidth, maximum: total };
-    }
-}

package/dist/renderables/status.d.ts

@@ -1,23 +0,0 @@
-/**
- * Status — displays a spinner animation with a status message.
- */
-import { Style } from "../core/style.js";
-import { Console } from "../core/console.js";
-export interface StatusOptions {
-    spinner?: string;
-    speed?: number;
-    style?: string | Style;
-    console?: Console;
-}
-export declare class Status {
-    private _live;
-    private _renderable;
-    private _console;
-    constructor(message: string, options?: StatusOptions);
-    get console(): Console;
-    get message(): string;
-    set message(value: string);
-    start(): void;
-    stop(): void;
-    update(message: string): void;
-}

package/dist/renderables/status.js

@@ -1,60 +0,0 @@
-/**
- * Status — displays a spinner animation with a status message.
- */
-import { Segment } from "../core/segment.js";
-import { NULL_STYLE } from "../core/style.js";
-import { Console } from "../core/console.js";
-import { Spinner } from "./spinner.js";
-import { Live } from "./live.js";
-import { getStyle } from "../core/protocol.js";
-/** A renderable that shows spinner + message */
-class StatusRenderable {
-    message;
-    _spinner;
-    _style;
-    constructor(message, spinner, style) {
-        this.message = message;
-        this._spinner = spinner;
-        this._style = style;
-    }
-    *render(options) {
-        yield* this._spinner.render(options);
-        const style = getStyle(options, this._style);
-        const msgStyle = style.isNull ? undefined : style;
-        yield new Segment(` ${this.message}`, msgStyle);
-    }
-}
-export class Status {
-    _live;
-    _renderable;
-    _console;
-    constructor(message, options) {
-        this._console = options?.console ?? new Console({ forceTerminal: true });
-        const spinner = new Spinner(options?.spinner ?? "dots", undefined, { speed: options?.speed });
-        this._renderable = new StatusRenderable(message, spinner, options?.style ?? NULL_STYLE);
-        this._live = new Live(this._renderable, {
-            console: this._console,
-            transient: true,
-            refreshPerSecond: 12.5,
-        });
-    }
-    get console() {
-        return this._console;
-    }
-    get message() {
-        return this._renderable.message;
-    }
-    set message(value) {
-        this._renderable.message = value;
-    }
-    start() {
-        this._live.start();
-    }
-    stop() {
-        this._live.stop();
-    }
-    update(message) {
-        this._renderable.message = message;
-        this._live.update(this._renderable, { refresh: true });
-    }
-}

package/dist/renderables/syntax.d.ts

@@ -1,35 +0,0 @@
-/**
- * Syntax — renders source code with basic syntax highlighting.
- * Uses built-in tokenization (no external dependency).
- */
-import { Segment } from "../core/segment.js";
-import type { PaddingDimensions } from "./padding.js";
-import type { Renderable, Measurable, RenderOptions } from "../core/protocol.js";
-export interface SyntaxOptions {
-    lineNumbers?: boolean;
-    theme?: string;
-    startLine?: number;
-    lineRange?: [number, number];
-    highlightLines?: Set<number>;
-    wordWrap?: boolean;
-    tabSize?: number;
-    padding?: PaddingDimensions;
-}
-export declare class Syntax implements Renderable, Measurable {
-    readonly code: string;
-    readonly language: string;
-    readonly lineNumbers: boolean;
-    readonly startLine: number;
-    readonly lineRange: [number, number] | undefined;
-    readonly highlightLines: Set<number>;
-    readonly wordWrap: boolean;
-    readonly tabSize: number;
-    constructor(code: string, language?: string, options?: SyntaxOptions);
-    render(options: RenderOptions): Iterable<Segment>;
-    measure(options: RenderOptions): {
-        minimum: number;
-        maximum: number;
-    };
-    private _highlight;
-    static fromPath(_filePath: string, _options?: SyntaxOptions): Syntax;
-}

package/dist/renderables/syntax.js

@@ -1,114 +0,0 @@
-/**
- * Syntax — renders source code with basic syntax highlighting.
- * Uses built-in tokenization (no external dependency).
- */
-import { cellLen } from "../core/cells.js";
-import { Segment } from "../core/segment.js";
-import { Style } from "../core/style.js";
-import { RichText } from "../core/text.js";
-// Built-in token patterns for common languages
-const TOKEN_PATTERNS = {
-    _default: [
-        [/\/\/.*$/gm, "comment"],
-        [/\/\*[\s\S]*?\*\//g, "comment"],
-        [/#.*$/gm, "comment"],
-        [/"(?:[^"\\]|\\.)*"/g, "string"],
-        [/'(?:[^'\\]|\\.)*'/g, "string"],
-        [/`(?:[^`\\]|\\.)*`/g, "string"],
-        [/\b(?:true|false|null|undefined|NaN|Infinity)\b/g, "keyword.constant"],
-        [/\b(?:function|class|const|let|var|return|if|else|for|while|do|switch|case|break|continue|new|throw|try|catch|finally|import|export|from|default|async|await|yield|of|in|typeof|instanceof|void|delete)\b/g, "keyword"],
-        [/\b(?:def|lambda|with|as|pass|raise|elif|except|print|self|cls|None|True|False)\b/g, "keyword"],
-        [/\b\d+(?:\.\d+)?(?:[eE][+-]?\d+)?\b/g, "number"],
-        [/\b0x[0-9a-fA-F]+\b/g, "number"],
-    ],
-};
-const TOKEN_STYLES = {
-    "keyword": Style.parse("bold magenta"),
-    "keyword.constant": Style.parse("italic bright_magenta"),
-    "string": Style.parse("green"),
-    "number": Style.parse("cyan"),
-    "comment": Style.parse("dim italic"),
-};
-export class Syntax {
-    code;
-    language;
-    lineNumbers;
-    startLine;
-    lineRange;
-    highlightLines;
-    wordWrap;
-    tabSize;
-    constructor(code, language, options) {
-        this.code = code;
-        this.language = language ?? "text";
-        this.lineNumbers = options?.lineNumbers ?? false;
-        this.startLine = options?.startLine ?? 1;
-        this.lineRange = options?.lineRange;
-        this.highlightLines = options?.highlightLines ?? new Set();
-        this.wordWrap = options?.wordWrap ?? false;
-        this.tabSize = options?.tabSize ?? 4;
-    }
-    *render(options) {
-        const expandedCode = this.code.replace(/\t/g, " ".repeat(this.tabSize));
-        let lines = expandedCode.split("\n");
-        // Apply line range
-        if (this.lineRange) {
-            const [start, end] = this.lineRange;
-            lines = lines.slice(start - 1, end);
-        }
-        const lineNumWidth = this.lineNumbers
-            ? String(this.startLine + lines.length - 1).length + 1
-            : 0;
-        // Tokenize the full text for highlighting
-        const text = new RichText(lines.join("\n"), { end: "" });
-        this._highlight(text);
-        const textLines = text.split("\n");
-        for (let i = 0; i < textLines.length; i++) {
-            const lineNo = this.startLine + i;
-            const isHighlighted = this.highlightLines.has(lineNo);
-            if (this.lineNumbers) {
-                const numStr = String(lineNo).padStart(lineNumWidth - 1) + " ";
-                const numStyle = isHighlighted
-                    ? Style.parse("bold on grey27")
-                    : Style.parse("dim");
-                yield new Segment(numStr, numStyle);
-                yield new Segment("│ ", Style.parse("dim"));
-            }
-            const line = textLines[i];
-            const segs = [...line.render({ ...options, maxWidth: options.maxWidth - lineNumWidth - 2 })];
-            // Filter out trailing newline from render
-            for (const seg of segs) {
-                if (seg.text !== "\n")
-                    yield seg;
-            }
-            yield Segment.line();
-        }
-    }
-    measure(options) {
-        const lines = this.code.split("\n");
-        let maxLine = 0;
-        for (const line of lines) {
-            maxLine = Math.max(maxLine, cellLen(line));
-        }
-        const lineNumWidth = this.lineNumbers
-            ? String(this.startLine + lines.length - 1).length + 3
-            : 0;
-        return {
-            minimum: 10,
-            maximum: Math.min(maxLine + lineNumWidth, options.maxWidth),
-        };
-    }
-    _highlight(text) {
-        const patterns = TOKEN_PATTERNS["_default"] ?? [];
-        for (const [pattern, tokenType] of patterns) {
-            const style = TOKEN_STYLES[tokenType];
-            if (style) {
-                text.highlightRegex(pattern, style);
-            }
-        }
-    }
-    static fromPath(_filePath, _options) {
-        // In a real implementation, this would read the file and detect language
-        throw new Error("Syntax.fromPath requires file system access — use the constructor with code string instead");
-    }
-}