@c9up/ream 0.2.25 → 0.2.27

package/dist/console/cliui.d.ts

@@ -1,250 +1,14 @@
 /**
- * Terminal UI (Console / `@poppinss/cliui` surface).
+ * Terminal UI — a thin re-export of `@c9up/lumen`.
  *
- * Everything renders through {@link Ui.write}, which is what makes the layer
- * testable: in `raw` mode nothing reaches the terminal and every line is kept
- * in memory for assertions. Colours become `name(text)` there — the same trick
- * Console uses, so an expected log stays a readable string instead of a soup of
- * escape codes.
- */
-/** Style names, in kleur's spelling. */
-declare const STYLES: {
-    readonly reset: 0;
-    readonly bold: 1;
-    readonly dim: 2;
-    readonly italic: 3;
-    readonly underline: 4;
-    readonly red: 31;
-    readonly green: 32;
-    readonly yellow: 33;
-    readonly blue: 34;
-    readonly magenta: 35;
-    readonly cyan: 36;
-    readonly white: 37;
-    readonly grey: 90;
-    readonly bgRed: 41;
-    readonly bgGreen: 42;
-    readonly bgYellow: 43;
-    readonly bgBlue: 44;
-};
-export type StyleName = keyof typeof STYLES;
-/**
- * A chainable colour function.
- *
- * Called with text it renders; called with nothing it returns itself, which is
- * what allows Console's `colors.bgGreen().white(' CREATED ')`.
- */
-export type Colors = ((text?: string) => string & Colors) & {
-    [K in StyleName]: Colors;
-};
-/** Where a line goes when the UI is not in raw mode. */
-type Stream = 'stdout' | 'stderr';
-/**
- * The console UI: colours, logger and widgets, plus the mode switch that makes
- * all of it assertable.
- */
-/** One captured line, with the stream it would have gone to. */
-export interface CapturedLog {
-    message: string;
-    stream: Stream;
-}
-export declare class Ui {
-    #private;
-    readonly colors: Colors;
-    readonly logger: Logger;
-    constructor();
-    /** `raw` keeps every line in memory instead of printing it. */
-    switchMode(mode: 'normal' | 'raw'): void;
-    get mode(): 'normal' | 'raw';
-    /** Everything written since raw mode was switched on. */
-    getLogs(): string[];
-    /** The same lines with the stream each one targeted. */
-    getCapturedLogs(): CapturedLog[];
-    /**
-     * Table rows as they were given, before padding.
-     *
-     * Assertions compare data, not layout: `assertTableRows` should not break
-     * because a column grew wider.
-     */
-    getTableRows(): string[][];
-    /** @internal Recorded by {@link Table.render}. */
-    captureTableRow(cells: readonly string[]): void;
-    /** @internal The head row, kept apart from the data rows. */
-    captureTableHead(cells: readonly string[]): void;
-    /**
-     * The header cells of the last rendered table.
-     *
-     * Kept apart from {@link getTableRows} so a caller can assert the data alone.
-     * `assertTableRows` looks at both: Console treats the head as one more row, and a
-     * test may or may not restate it.
-     */
-    getTableHead(): string[];
-    /** The single sink every widget writes through. */
-    write(line: string, stream?: Stream): void;
-    table(): Table;
-    sticker(): Box;
-    instructions(): Box;
-    tasks(options?: TasksOptions): Tasks;
-}
-/**
- * Command logger.
- *
- * Alert levels go to stderr so a command's data output stays pipeable — a
- * warning must not end up inside `ream list --json | jq`.
- */
-export declare class Logger {
-    #private;
-    constructor(ui: Ui);
-    /**
-     * Prepend a fixed marker to EVERY message from now on.
-     *
-     * Console's own `prefix` is per-message (`info(msg, { prefix })`, supported
-     * below); this sticky form is kept because a command tagging all its output
-     * should not repeat itself on every call.
-     */
-    prefix(value: string): this;
-    suffix(value: string): this;
-    info(message: string, options?: MessageOptions): void;
-    success(message: string, options?: MessageOptions): void;
-    warning(message: string, options?: MessageOptions): void;
-    error(message: string | Error, options?: MessageOptions): void;
-    /**
-     * A message with animated trailing dots (Console `logger.await`).
-     *
-     * The animation only ticks on a TTY: on a pipe, or in raw mode, one line per
-     * frame would be noise in a log and unassertable in a test.
-     */
-    await(message: string, options?: MessageOptions): Animation;
-    fatal(message: string | Error): void;
-    /** Only prints when DEBUG is set — the usual escape hatch for noisy detail. */
-    debug(message: string): void;
-    /** A line with no decoration. Use it for the command's own output. */
-    log(message: string): void;
-    /**
-     * A step whose outcome is reported later (Console `logger.action`).
-     *
-     *   const create = this.logger.action('creating config/auth.ts')
-     *   try { … ; create.displayDuration().succeeded() }
-     *   catch (error) { create.failed(error) }
-     */
-    action(title: string): Action;
-}
-/** Per-message decoration (Console `logger.info(msg, { prefix, suffix })`). */
-export interface MessageOptions {
-    prefix?: string | number;
-    suffix?: string | number;
-}
-/**
- * An "in progress" message with animated dots (Console `logger.await`).
- *
- * Only animates on a TTY. Elsewhere it prints the message once and each
- * `update` once more, which keeps logs and test assertions readable.
- */
-export declare class Animation {
-    #private;
-    constructor(ui: Ui, message: string, options: MessageOptions);
-    start(): this;
-    update(message: string, options?: MessageOptions): this;
-    stop(): void;
-}
-/** A pending action, reported through one of its terminal methods. */
-export declare class Action {
-    #private;
-    constructor(ui: Ui, title: string, startedAt?: number);
-    /** Append how long the action took. */
-    displayDuration(): this;
-    succeeded(): void;
-    skipped(reason?: string): void;
-    failed(error: unknown): void;
-}
-/** A cell with its alignment (Console `{ content, hAlign }`). */
-export interface TableCell {
-    content: string;
-    hAlign?: 'left' | 'right' | 'center';
-}
-export type TableInput = string | TableCell;
-/** A column-aligned table (Console `ui.table()`). */
-export declare class Table {
-    #private;
-    constructor(ui: Ui);
-    head(columns: readonly TableInput[]): this;
-    row(cells: readonly TableInput[]): this;
-    /**
-     * Stretch the table to the terminal width, the first column absorbing the
-     * slack (Console `fullWidth`). Falls back to content width when the width is
-     * unknown — a pipe has no columns.
-     */
-    fullWidth(): this;
-    /**
-     * Which column absorbs the slack in full-width mode (Console
-     * `fluidColumnIndex`). Defaults to the first.
-     */
-    fluidColumnIndex(index: number): this;
-    render(): void;
-}
-/**
- * A bordered box — `sticker()` for a highlighted block, `instructions()` for a
- * decorated list of steps.
- */
-export declare class Box {
-    #private;
-    constructor(ui: Ui, kind: 'sticker' | 'instructions');
-    add(line: string): this;
-    render(): void;
-}
-/** Handed to a task callback so it can report progress and failure. */
-export declare class TaskContext {
-    #private;
-    constructor(ui: Ui, title: string, verbose?: boolean);
-    /**
-     * Report progress.
-     *
-     * Verbose prints every message; minimal keeps only the last one, surfaced on
-     * the task's final line. A progress loop otherwise floods the output with a
-     * line per percent.
-     */
-    update(message: string): void;
-    /** @internal The last progress message, shown when the task ends. */
-    get lastMessage(): string;
-    /**
-     * Mark the task as failed. Returned from the callback rather than thrown, so
-     * an expected failure reads like a value — Console's `return task.error(…)`.
-     */
-    error(reason: string | Error): Error;
-    /** @internal */
-    get failure(): Error | undefined;
-}
-export interface TaskOutcome {
-    title: string;
-    state: 'succeeded' | 'failed';
-    message: string;
-    error?: Error;
-}
-/**
- * A sequence of steps with their outcome (Console `ui.tasks()`).
+ * This file used to BE the implementation. It moved out because the framework
+ * was not its only consumer: the Rust CLI, helix's reporter and every package
+ * that prints a line all wanted the same `[ warn ]`, in the same yellow, and
+ * none of them can depend on ream.
  *
- * Sequential on purpose: the point is a readable progress report, and running
- * them concurrently would interleave the lines into noise. A failing task stops
- * the run — the ones after it usually depend on it.
+ * Kept as a module rather than deleted so existing imports — `from
+ * '../console/cliui.js'`, and `Logger`/`Ui` off the package barrel — keep
+ * resolving.
  */
-export interface TasksOptions {
-    /**
-     * Print every progress message instead of only the last one.
-     *
-     * Minimal is the default, as in Console: a hundred `Downloaded 42%` lines make a
-     * transcript unreadable. Verbose is what a `--verbose` flag turns on.
-     */
-    verbose?: boolean;
-}
-export declare class Tasks {
-    #private;
-    constructor(ui: Ui, options?: TasksOptions);
-    add(title: string, work: (task: TaskContext) => Promise<unknown>): this;
-    /** Results in declaration order, including the task that failed. */
-    get outcomes(): TaskOutcome[];
-    run(): Promise<TaskOutcome[]>;
-}
-/** Removes the SGR escape sequences `colors` writes, leaving the visible text. */
-export declare function stripAnsi(text: string): string;
-export {};
+export { Action, Box, type CapturedLog, type Colors, ConsoleRenderer, Logger, type LoggerOptions, MemoryRenderer, type MessageOptions, type Renderer, Spinner, Steps, type StyleName, stripAnsi, Table, type TableCell, type TableChars, type TableInput, type TableOptions, type TableRow, Task, type TaskCallback, TaskContext, type TaskError, type TaskFailure, type TaskOutcome, type TaskResult, type TaskState, Tasks, type TasksOptions, Ui, type UiMode, } from '@c9up/lumen';
 //# sourceMappingURL=cliui.d.ts.map

package/dist/console/cliui.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cliui.d.ts","sourceRoot":"","sources":["../../src/console/cliui.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,wCAAwC;AACxC,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;CAkBF,CAAA;AAEV,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,MAAM,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,SAAS,GAAG,MAAM;CAAE,CAAA;AAsDxF,wDAAwD;AACxD,KAAK,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAEjC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,EAAE;;IAMb,QAAQ,CAAC,MAAM,EAAE,MAAM,CAA8C;IACrE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;;IAMvB,+DAA+D;IAC/D,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,KAAK,GAAG,IAAI;IASxC,IAAI,IAAI,IAAI,QAAQ,GAAG,KAAK,CAE3B;IAED,yDAAyD;IACzD,OAAO,IAAI,MAAM,EAAE;IAInB,wDAAwD;IACxD,eAAe,IAAI,WAAW,EAAE;IAIhC;;;;;OAKG;IACH,YAAY,IAAI,MAAM,EAAE,EAAE;IAI1B,kDAAkD;IAClD,eAAe,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAI/C,6DAA6D;IAC7D,gBAAgB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAIhD;;;;;;OAMG;IACH,YAAY,IAAI,MAAM,EAAE;IAIxB,mDAAmD;IACnD,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAiB,GAAG,IAAI;IASpD,KAAK,IAAI,KAAK;IAId,OAAO,IAAI,GAAG;IAId,YAAY,IAAI,GAAG;IAInB,KAAK,CAAC,OAAO,GAAE,YAAiB,GAAG,KAAK;CAGzC;AAED;;;;;GAKG;AACH,qBAAa,MAAM;;gBAKL,EAAE,EAAE,EAAE;IAIlB;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK3B,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK3B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,IAAI;IAIzD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,IAAI;IAI5D,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,IAAI;IAI5D,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,GAAE,cAAmB,GAAG,IAAI;IAIlE;;;;;OAKG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,SAAS;IAI/D,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAOpC,+EAA+E;IAC/E,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK5B,sEAAsE;IACtE,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI1B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAuB9B;AAED,+EAA+E;AAC/E,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACzB;AAED;;;;;GAKG;AACH,qBAAa,SAAS;;gBAOR,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IAM5D,KAAK,IAAI,IAAI;IAab,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,IAAI;IAS3D,IAAI,IAAI,IAAI;CAiCb;AAED,sEAAsE;AACtE,qBAAa,MAAM;;gBAML,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,SAAa;IAMzD,uCAAuC;IACvC,eAAe,IAAI,IAAI;IAKvB,SAAS,IAAI,IAAI;IAIjB,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAK9B,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAa7B;AAED,iEAAiE;AACjE,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;CACrC;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,CAAA;AAE3C,qDAAqD;AACrD,qBAAa,KAAK;;gBAOJ,EAAE,EAAE,EAAE;IAIlB,IAAI,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG,IAAI;IAK1C,GAAG,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,IAAI;IAKvC;;;;OAIG;IACH,SAAS,IAAI,IAAI;IAKjB;;;OAGG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAcrC,MAAM,IAAI,IAAI;CAkDf;AAiBD;;;GAGG;AACH,qBAAa,GAAG;;gBAKF,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,GAAG,cAAc;IAKpD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKvB,MAAM,IAAI,IAAI;CAmBf;AAED,uEAAuE;AACvE,qBAAa,WAAW;;gBAOV,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,UAAQ;IAMlD;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAO7B,qEAAqE;IACrE,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK;IAKpC,gBAAgB;IAChB,IAAI,OAAO,IAAI,KAAK,GAAG,SAAS,CAE/B;CACF;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,WAAW,GAAG,QAAQ,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,qBAAa,KAAK;;gBAMJ,EAAE,EAAE,EAAE,EAAE,OAAO,GAAE,YAAiB;IAK9C,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI;IAKvE,oEAAoE;IACpE,IAAI,QAAQ,IAAI,WAAW,EAAE,CAE5B;IAEK,GAAG,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;CAyCpC;AAgBD,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG9C"}
+{"version":3,"file":"cliui.d.ts","sourceRoot":"","sources":["../../src/console/cliui.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EACL,MAAM,EACN,GAAG,EACH,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,eAAe,EACf,MAAM,EACN,KAAK,aAAa,EAClB,cAAc,EACd,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,OAAO,EACP,KAAK,EACL,KAAK,SAAS,EACd,SAAS,EACT,KAAK,EACL,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,IAAI,EACJ,KAAK,YAAY,EACjB,WAAW,EACX,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,EACL,KAAK,YAAY,EACjB,EAAE,EACF,KAAK,MAAM,GACZ,MAAM,aAAa,CAAA"}