eve/dist/src/setup/cli/channel-setup-prompter.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

import type { ChannelKind } from "../scaffold/update/channels.js";
/** Reasons that make scaffoldable channel kinds unavailable in a picker. */
export type DisabledChannelReasons = Readonly<Partial<Record<ChannelKind, string>>>;
/** One selectable action shown while a setup operation continues in the background. */
export interface ChannelSetupAction {
    value: string;
    label: string;
}
/** Context plus actions shown while a setup operation continues in the background. */
export interface ChannelSetupChoiceOptions {
    /** The animated spinner line shown above the actions. */
    status: string;
    /** Inert row explaining what the background operation is waiting for. */
    context: string;
    /** Selectable actions, visually separated from the context row. */
    actions: readonly ChannelSetupAction[];
}
/** Concurrent setup choice plus an idempotent prompt dismissal handle. */
export interface ChannelSetupChoice {
    choice: Promise<string | undefined>;
    close(): void;
}
/** Optional interaction capability for a long-running setup operation. */
export type ChannelSetupAwaitChoice = (options: ChannelSetupChoiceOptions) => ChannelSetupChoice;
/** Status and subprocess output operations used by shared setup flows. */
export interface ChannelSetupLog {
    message(text: string): void;
    info(text: string): void;
    success(text: string): void;
    warning(text: string): void;
    error(text: string): void;
    /** Updates the transient detail beneath the current status while a child command runs. */
    commandOutput(text: string): void;
    /**
     * Starts an ephemeral progress indicator for an async wait, returning a
     * handle whose `stop()` clears it without leaving a transcript line.
     * Mirrors `Prompter["log"]["spinner"]`; optional so plain and headless logs
     * (which have no live status surface) can omit it and callers fall back to
     * a persisted message.
     */
    spinner?(message: string): {
        stop(): void;
    };
}
/**
 * Runs one setup phase behind an ephemeral spinner so only outcomes persist in
 * the transcript. Logs without a spinner (plain or headless output) persist the
 * phase message instead, keeping their progress trail; the spinner stops
 * whether the work resolves or throws.
 */
export declare function withPhase<T>(log: ChannelSetupLog, message: string, task: () => Promise<T>): Promise<T>;