@msn-control/liftoff 0.3.4 → 0.4.1

package/dist/terminal.d.ts

@@ -0,0 +1,128 @@
+export type TerminalLayout = 'full' | 'compact' | 'plain';
+export type StatusKind = 'success' | 'info' | 'warning' | 'error' | 'pending';
+export type SemanticColor = 'brand' | 'info' | 'success' | 'warning' | 'error' | 'pending' | 'command' | 'metadata';
+export interface TerminalRendererOptions {
+    stream: NodeJS.WritableStream;
+    columns?: number;
+    color?: boolean;
+    snapshot?: boolean;
+    json?: boolean;
+    env?: NodeJS.ProcessEnv;
+    layout?: TerminalLayout;
+    normalize?: (value: string) => string;
+}
+export interface PresentationSessionOptions {
+    stdout: NodeJS.WritableStream;
+    stderr: NodeJS.WritableStream;
+    columns?: number;
+    color?: boolean;
+    snapshot?: boolean;
+    json?: boolean;
+    env?: NodeJS.ProcessEnv;
+    layout?: TerminalLayout;
+    normalize?: (value: string) => string;
+}
+export interface DefinitionItem {
+    label: string;
+    value: string;
+}
+export interface ChoiceItem {
+    label: string;
+    value?: string;
+    disabled?: boolean;
+    default?: boolean;
+    selected?: boolean;
+}
+export declare const TERMINAL_LAYOUT: {
+    readonly compactColumns: 64;
+    readonly fullColumns: 96;
+    readonly maximumContentColumns: 92;
+    readonly minimumColumns: 20;
+    readonly indent: 2;
+    readonly sectionSpacing: 1;
+};
+export declare const TERMINAL_GLYPHS: {
+    readonly topLeft: '┌';
+    readonly topRight: '┐';
+    readonly bottomLeft: '└';
+    readonly bottomRight: '┘';
+    readonly horizontal: '─';
+    readonly vertical: '│';
+    readonly leftJunction: '├';
+    readonly rightJunction: '┤';
+    readonly bullet: '•';
+    readonly choice: '›';
+    readonly selected: '●';
+    readonly unselected: '○';
+};
+export declare const LIFTOFF_WORDMARK: readonly ['██╗     ██╗███████╗████████╗ ██████╗ ███████╗███████╗', '██║     ██║██╔════╝╚══██╔══╝██╔═══██╗██╔════╝██╔════╝', '██║     ██║█████╗     ██║   ██║   ██║█████╗  █████╗', '██║     ██║██╔══╝     ██║   ██║   ██║██╔══╝  ██╔══╝', '███████╗██║██║        ██║   ╚██████╔╝██║     ██║', '╚══════╝╚═╝╚═╝        ╚═╝    ╚═════╝ ╚═╝     ╚═╝'];
+export declare const LIFTOFF_COMPACT_WORDMARK: readonly ['╻  ╻┏━╸╺┳╸┏━┓┏━╸┏━╸', '┃  ┃┣╸  ┃ ┃ ┃┣╸ ┣╸', '┗━╸╹╹   ╹ ┗━┛╹  ╹'];
+export declare function stripAnsi(value: string): string;
+export declare function visibleLength(value: string): number;
+export declare function padVisible(value: string, width: number): string;
+export declare function wrapVisible(value: string, width: number, breakLongWords?: boolean): string[];
+export declare class TerminalRenderer {
+    private readonly options;
+    readonly columns: number;
+    readonly layout: TerminalLayout;
+    readonly colorEnabled: boolean;
+    readonly jsonMode: boolean;
+    private readonly colors;
+    constructor(options: TerminalRendererOptions);
+    write(value: string): void;
+    json(value: unknown): string;
+    style(kind: SemanticColor, value: string): string;
+    private contentWidth;
+    private normalize;
+    banner(subtitle?: string): string;
+    commandIdentity(command: string, description: string): string;
+    heading(value: string): string;
+    stage(value: string, detail?: string): string;
+    panel(title: string, lines: string[]): string;
+    section(title: string, lines: string[]): string;
+    definitionList(title: string, items: readonly DefinitionItem[]): string;
+    bulletList(title: string, items: readonly string[]): string;
+    choiceList(title: string, choices: readonly ChoiceItem[]): string;
+    table(headers: readonly string[], rows: readonly (readonly string[])[]): string;
+    tableSection(title: string, headers: readonly string[], rows: readonly (readonly string[])[]): string;
+    status(kind: StatusKind, label: string, detail?: string): string;
+    command(value: string): string;
+    prompt(label: string, defaultValue?: string): string;
+    promptContext(label: string, detail?: string): string;
+    remedy(value: string): string;
+    compactError(message: string, remedy?: string): string;
+    warning(value: string): string;
+    error(value: string, remedy?: string): string;
+    cancellation(value: string): string;
+    completion(label: string, detail?: string, items?: readonly DefinitionItem[], nextCommand?: string): string;
+    confirmation(value: string): string;
+}
+export declare class PresentationSession {
+    readonly stdout: TerminalRenderer;
+    readonly stderr: TerminalRenderer;
+    private readonly stdoutStream;
+    private readonly stderrStream;
+    constructor(options: PresentationSessionOptions);
+    identity(subtitle: string): void;
+    commandIdentity(command: string, description: string): void;
+    stage(title: string, detail?: string): void;
+    section(title: string, lines: string[]): void;
+    definitions(title: string, items: readonly DefinitionItem[]): void;
+    bullets(title: string, items: readonly string[]): void;
+    choices(title: string, choices: readonly ChoiceItem[]): void;
+    prompt(label: string, defaultValue?: string): void;
+    table(title: string, headers: readonly string[], rows: readonly (readonly string[])[]): void;
+    status(kind: StatusKind, label: string, detail?: string): void;
+    warning(value: string): void;
+    command(value: string): void;
+    remedy(value: string): void;
+    cancellation(value: string): void;
+    completion(label: string, detail?: string, items?: readonly DefinitionItem[], nextCommand?: string): void;
+    error(message: string, remedy?: string): void;
+    rawStdout(value: string): void;
+    rawStderr(value: string): void;
+    childStreams(): {
+        stdout: NodeJS.WritableStream;
+        stderr: NodeJS.WritableStream;
+    };
+}