@ordewell/core 0.5.5 → 0.5.6

package/dist/ITerminalRunner-BV9Rd2o9.d.ts

@@ -1,563 +0,0 @@
-import { I as IApproval, a as ApprovalMode } from './ApprovalPolicy-BVhGdECT.js';
-import { H as RunnerId } from './Task-Vl5Zq_D-.js';
-
-interface ToolOutcome {
-    success: boolean;
-    output: string;
-    truncated: boolean;
-}
-interface ReadFileOpts {
-    maxBytes?: number;
-    offset?: number;
-    limit?: number;
-}
-/**
- * `content` returns matching lines, `files` only the paths that matched, and
- * `count` a per-file tally. Cheap models otherwise grep and then read whole
- * files to answer "which files touch this", burning rounds against the budget.
- */
-type GrepOutputMode = 'content' | 'files' | 'count';
-interface GrepOptions {
-    /** File glob filter, e.g. `*.ts`. */
-    include?: string;
-    /** Search root. Relative to the workspace unless approved as external. */
-    path?: string;
-    outputMode?: GrepOutputMode;
-    /** Lines of context around each match (`content` mode only). */
-    contextBefore?: number;
-    contextAfter?: number;
-    /** Treat the pattern as a literal string rather than a regex. */
-    literal?: boolean;
-    caseInsensitive?: boolean;
-    /** Global cap on returned rows. Defaults to {@link GREP_DEFAULT_HEAD_LIMIT}. */
-    headLimit?: number;
-}
-interface GlobOptions {
-    /** Search root. Relative to the workspace unless approved as external. */
-    path?: string;
-    headLimit?: number;
-}
-interface FindSymbolOptions {
-    /** Language id or file extension, e.g. `typescript` or `.go`. Narrows the keyword set. */
-    language?: string;
-    /** Search root. Relative to the workspace unless approved as external. */
-    path?: string;
-}
-/** Global row cap for grep. A per-file cap is not a budget — see PoolFileSystem. */
-declare const GREP_DEFAULT_HEAD_LIMIT = 100;
-/**
- * Directories that are never interesting to a planner and would otherwise eat
- * the result budget. Applied by every search entry point, not just `glob` —
- * `dist/` and `.ordewell/` are frequently not gitignored.
- */
-declare const SEARCH_EXCLUSIONS: string[];
-interface IFileSystem {
-    readFile(path: string, opts?: ReadFileOpts): Promise<ToolOutcome>;
-    readFiles(paths: string[]): Promise<ToolOutcome>;
-    glob(pattern: string, opts?: GlobOptions): Promise<ToolOutcome>;
-    grep(pattern: string, opts?: GrepOptions): Promise<ToolOutcome>;
-    listDir(path: string, depth?: number): Promise<ToolOutcome>;
-    /**
-     * `signal` stops the planning turn this command belongs to: adapters kill
-     * the spawned child rather than let it run out its own timeout. The other
-     * tools here are short enough that the loop's between-call abort check is
-     * indistinguishable from cancelling them mid-flight; a `bash` call is not.
-     */
-    bash(command: string, signal?: AbortSignal): Promise<ToolOutcome>;
-    /** Definition-first lookup for one symbol. See `symbolPatterns.ts`. */
-    findSymbol(symbol: string, opts?: FindSymbolOptions): Promise<ToolOutcome>;
-    getWorkspaceRoot(): string;
-    /**
-     * Inject the human-approval channel for out-of-envelope access. Optional so
-     * test doubles stay small; every adapter extending `BaseFileSystem` has it.
-     */
-    setApproval?(approval: IApproval): void;
-}
-
-interface CatalogModel {
-    id: string;
-    name: string;
-    description: string;
-    pricing: {
-        prompt: string;
-        completion: string;
-    };
-    contextLength: number;
-}
-declare class ModelCatalog {
-    static fetchModels(apiKey: string, baseUrl?: string, fetchImpl?: typeof fetch): Promise<CatalogModel[]>;
-    /**
-     * Delete the on-disk catalog cache for a base URL so the next fetch re-runs.
-     * Used by the resolver's `invalidate()` in production (no injected fetch);
-     * best-effort — a missing file or unreadable dir is a no-op.
-     */
-    static clearCache(baseUrl?: string): void;
-    private static readCache;
-    private static writeCache;
-}
-
-interface ModelShortcut {
-    label: string;
-    id: string;
-    provider: string;
-    description: string;
-    pricing?: string;
-}
-declare const ORCHESTRATOR_SHORTCUTS: ModelShortcut[];
-declare function resolveModelShortcut(input: string, shortcuts: ModelShortcut[]): string | null;
-/**
- * Resolves a value to a model id ONLY when it is in the supplied catalog
- * option list — either directly or via a shortcut label. Free-typed, unknown,
- * or not-currently-available values return null, so callers never store an id
- * the user couldn't have selected from the list. Keeps model-setting list-only.
- */
-declare function knownModelId(value: string, optionIds: string[], shortcuts: ModelShortcut[]): string | null;
-
-type ProviderModelLists = Record<string, string[]>;
-interface OrchestratorOption {
-    id: string;
-    label: string;
-    provider: string;
-    apiProvider: AiProvider;
-    description?: string;
-    pricing?: string;
-    /** The model's context window when the catalog reports one (#49). */
-    contextWindow?: number;
-}
-
-interface FetchAllProviderModelsOptions {
-    apiKeys: Record<string, string>;
-    baseUrls: Record<string, string>;
-    fetchImpl?: typeof fetch;
-}
-type AllProviderModels = Record<string, CatalogModel[]>;
-/**
- * Result of a picker-catalog fetch fan-out: the per-provider model lists plus
- * the per-provider failures. `errors` is keyed by provider id and holds the
- * failure message for any provider whose catalog fetch rejected — the seam the
- * surfaces (CLI, VS Code) use to flag "this configured provider didn't work"
- * rather than silently showing a short list.
- */
-interface ProviderModelsResult {
-    models: AllProviderModels;
-    errors: Record<string, string>;
-}
-/** The provider config fields the discovery fan-out needs. */
-interface ProviderCredentialSource {
-    getProviderApiKey(provider: AiProvider): string;
-    getProviderBaseUrl(provider: AiProvider): string;
-    openaiCompatibleBaseUrl: string;
-}
-/**
- * Collect the API keys and base URLs the picker fan-out should probe, applying
- * the single "configured" policy shared by every surface (CLI + VS Code):
- *  - a preset is discovered only when it has an API key (OpenRouter included —
- *    its public catalog is not probed keyless, matching the product rule that
- *    only key-configured providers appear);
- *  - `openai_compatible` is discovered only when an explicit endpoint is set
- *    (keyless local servers like ollama / LM Studio).
- * Base URLs are handed through only for providers that pass the gate, so the
- * fan-out never touches an unconfigured third-party endpoint.
- */
-declare function collectProviderCredentials(config: ProviderCredentialSource): {
-    apiKeys: Record<string, string>;
-    baseUrls: Record<string, string>;
-};
-declare function fetchAllProviderModels(opts: FetchAllProviderModelsOptions): Promise<ProviderModelsResult>;
-declare function resolveProvider(modelId: string, providerModelLists: Record<string, string[]>): AiProvider | null;
-declare function toOrchestratorOptions(providerModels: AllProviderModels, shortcuts: ModelShortcut[]): OrchestratorOption[];
-
-/**
- * Who plans. Mostly LLM vendors reached over HTTP; the last three are *harness
- * planners* (ADR-0009) — a coding agent CLI already installed on the machine,
- * driven as the planner over its own programmatic transport and authenticated
- * by the subscription the user already holds. They are runners in the provider
- * axis, deliberately: "what plans for me?" is one question, and it belongs in
- * one setting. `isCliProvider` is the single guard that tells the two kinds
- * apart.
- */
-type AiProvider = 'google' | 'openrouter' | 'openai_compatible' | 'openai' | 'xai' | 'groq' | 'deepseek' | 'together' | 'mistral' | 'anthropic' | 'fireworks' | 'perplexity' | 'zhipu' | 'kimi' | 'cerebras' | 'deepinfra' | 'doubao' | 'qwen' | 'hunyuan' | 'baichuan' | 'minimax' | 'yi' | 'stepfun' | 'siliconflow' | 'cohere' | 'novita' | 'claude-code' | 'codex' | 'opencode';
-interface IConfig {
-    aiProvider: AiProvider;
-    apiKey: string;
-    planningModel: string;
-    enabledRunners: string[];
-    maxParallelSessions: number;
-    researchEnabled: boolean;
-    researchMaxSteps: number;
-    researchMaxFileSize: number;
-    openAiBaseUrl: string;
-    openAiApiKey: string;
-    /** Provider keys + base URL the ModelResolver uses to fetch the picker catalogs. */
-    openrouterKey: string;
-    geminiKey: string;
-    geminiBaseUrl?: string;
-    /** Base URL + API key for a user-provided OpenAI-compatible endpoint (ollama, vLLM, LM Studio, etc.). */
-    openaiCompatibleBaseUrl: string;
-    openaiCompatibleApiKey: string;
-    orchestratorModel: string;
-    geminiModel: string;
-    /** Model for research subagents (issue #34); defaults to the (cheap) planner model. */
-    researchSubagentModel: string;
-    /**
-     * Thinking effort / model variant for a harness planner (ADR-0009), chosen
-     * from the agent's own discovered variants. Separate from the per-task
-     * efforts the plan carries — this one is the planner's own dial.
-     */
-    plannerThinkingEffort?: string;
-    planMapEnabled: boolean;
-    autonomousMode: boolean;
-    /**
-     * Run each AI task in its own git worktree and integrate the results on a
-     * per-run branch (ADR-0013). Non-git workspaces fall back to the shared
-     * workspace root regardless of this flag.
-     */
-    worktreeIsolation: boolean;
-    /**
-     * Shell command run in a fresh task worktree instead of symlinking ignored
-     * artifacts from the main worktree — for repos where sharing `node_modules`
-     * or a virtualenv is wrong.
-     */
-    worktreeSetupCommand?: string;
-    /**
-     * Repositories of the repo group listed by hand, relative to the workspace
-     * (ADR-0014). When non-empty the group is exactly these, replacing the
-     * repositories auto-detected directly inside the folder; needed for ones
-     * deeper than that, which are never auto-detected.
-     */
-    workspaceRepos: string[];
-    /**
-     * Extra paths or globs, relative to each repo root, linked from the real repo
-     * into its task worktree where they exist — gitignored local state such as
-     * `*.tfstate` that a task must use, not a copy of.
-     */
-    worktreeLinks: string[];
-    /**
-     * How many conflict repairs one task may go through before its conflict is
-     * left for a person (ADR-0015); 0 turns repair off.
-     */
-    conflictRepairAttempts: number;
-    /**
-     * What to do when planner research reaches outside its default envelope — an
-     * out-of-workspace path, or a shell command beyond the auto-allowed read-only
-     * set. `ask` prompts the user (and denies where no surface can prompt, such as
-     * headless runs); `allow` and `deny` skip the prompt entirely.
-     */
-    approvalMode: ApprovalMode;
-    /** Scopes granted up front, so CI and power users never see a prompt. Trailing `*` matches by prefix. */
-    approvalPreApproved: string[];
-    /** Get the base URL for an OpenAI-compatible provider. */
-    getProviderBaseUrl(provider: AiProvider): string;
-    /** Get the API key for a provider. */
-    getProviderApiKey(provider: AiProvider): string;
-    /**
-     * Push the canonical provider routing lists in (sole producer: ModelResolver).
-     * Config consumes them when resolving a chosen model id to its serving API.
-     */
-    setProviderModelLists(lists: ProviderModelLists): void;
-}
-declare function enabledRunners(cfg: IConfig): RunnerId[];
-
-interface RunnerPluginManifest {
-    name: string;
-    displayName: string;
-    description: string;
-    version: string;
-    author?: string;
-    homepage?: string;
-    runner: PluginRunnerDef;
-    features: PluginFeatures;
-    modelDiscovery: PluginModelDiscovery;
-    contextFile?: string;
-    contextFileAltPath?: string;
-    modes?: PluginMode[];
-}
-interface PluginRunnerDef {
-    command: string;
-    argsTemplate: string[];
-    promptInArgs: boolean;
-    env?: Record<string, string>;
-    /** When true, the runner requires a PTY. HeadlessRunner wraps with `script` to allocate one. */
-    requiresTty?: boolean;
-    /**
-     * True when this runner's interactive prompt flag (e.g. opencode's
-     * `--prompt`) only pre-fills its TUI's composer instead of running it, so a
-     * surface driving that TUI unattended must send an explicit Enter after
-     * launch. Only takes effect while the resolved invocation is interactive —
-     * see `RunnerInvocation.submitPromptKey`.
-     */
-    submitPromptKey?: boolean;
-    /**
-     * Screens the agent can stop on before starting the task, waiting for a
-     * human — a folder-trust or permission-mode confirmation. Ordewell never
-     * answers one; seeing it, the task's user is told where to.
-     */
-    blockingPrompts?: BlockingPrompt[];
-}
-interface BlockingPrompt {
-    /** Text the prompt shows; matched ignoring case and whitespace. */
-    phrase: string;
-    /** Completes "<runner> is asking …", e.g. "whether to trust this folder". */
-    asks: string;
-}
-interface PluginFeatures {
-    modelSelection: boolean;
-    thinkingEffort: boolean;
-    planMode: boolean;
-    planModeFlag: string;
-    buildModeFlag?: string;
-    /** Flag appended when headless mode is on, so the agent never prompts for permission (e.g. Claude's --dangerously-skip-permissions). */
-    headlessFlag?: string;
-    thinkingFlag?: string;
-    thinkingValueEnabled?: string;
-    thinkingValueDisabled?: string;
-    thinkingValueAdaptive?: string;
-    /** Maps mode IDs to the CLI --permission-mode value. Used by {{feature:permissionModeVal}}. */
-    permissionModeValues?: Record<string, string>;
-}
-type PluginParser = 'claude-help' | 'opencode-models' | 'opencode-models-verbose' | 'anthropic-models' | 'line-by-line' | 'json' | 'json-table';
-interface DiscoveryCommand {
-    command: string;
-    args: string[];
-    parser?: PluginParser;
-}
-type ApiAuthMethod = {
-    type: 'env';
-    varName: string;
-    header: string;
-    prefix?: string;
-} | {
-    type: 'file';
-    path: string;
-    jsonPath: string;
-    header: string;
-    prefix?: string;
-};
-interface ApiDiscoveryConfig {
-    url: string;
-    headers?: Record<string, string>;
-    auth: ApiAuthMethod[];
-    parser: PluginParser;
-}
-interface PluginModelDiscovery {
-    method: 'command' | 'hardcoded';
-    command?: string;
-    args?: string[];
-    parser?: PluginParser;
-    jsonPath?: string;
-    /**
-     * Stdio JSON-RPC discovery (Codex `app-server`): spawn the command, send
-     * `initialize` then `model/list`, and read the catalog from the response.
-     * Tried BEFORE apiDiscovery and command discovery. When the call fails,
-     * `cacheFile` (the runner's own on-disk catalog cache, `~` expanded) is
-     * read before falling through to the remaining discovery methods.
-     */
-    appServer?: {
-        command: string;
-        args: string[];
-        cacheFile?: string;
-    };
-    /**
-     * Optional last-resort list for user plugins whose CLI cannot enumerate
-     * models. Used only when command discovery fails entirely or the CLI is
-     * unavailable. Built-in manifests must NOT use this: anything listed here is
-     * shown to the user as available even when it isn't.
-     */
-    fallbackModels?: {
-        modelId: string;
-        modelLabel: string;
-    }[];
-    /**
-     * Stable `--model` aliases that the runner's CLI always accepts but its help
-     * text may omit (e.g. Claude's 'haiku'). Merged into successful discovery
-     * results to fill gaps — discovered models take precedence, missing aliases
-     * are appended — and used as the last resort when discovery fails entirely.
-     * Unlike `fallbackModels`, entries must be stable CLI-accepted aliases
-     * (contracts that always resolve), not arbitrary model IDs.
-     */
-    canonicalAliases?: {
-        modelId: string;
-        modelLabel: string;
-    }[];
-    /**
-     * HTTP API discovery — tried BEFORE command discovery. When the runner's CLI
-     * has no model-listing subcommand (Claude Code), an API endpoint can serve as
-     * the authoritative source. Auth methods are tried in order; the first that
-     * yields a token is used. If no auth method yields a token or the request
-     * fails, discovery falls through to `discoveryCommands` + `canonicalAliases`.
-     */
-    apiDiscovery?: ApiDiscoveryConfig;
-    preferredPatterns?: {
-        id: string;
-        label: string;
-    }[];
-    variants?: {
-        id: string;
-        label: string;
-    }[];
-    discoveryCommands?: DiscoveryCommand[];
-}
-interface PluginMode {
-    id: string;
-    label: string;
-    description: string;
-    /** CLI value passed to the runner's permission/mode flag. Defaults to id if omitted. */
-    cliValue?: string;
-    /** Marks this mode as the runner's most permissive mode — the resolved default when autonomous mode is ON. */
-    autonomous?: boolean;
-    /** Marks this mode as the runner's conservative build mode — the resolved default when autonomous mode is OFF. */
-    safe?: boolean;
-}
-interface PluginEntry {
-    manifest: RunnerPluginManifest;
-    source: 'builtin' | 'user';
-    installPath?: string;
-}
-interface ResolveContext {
-    prompt: string;
-    model?: string;
-    thinkingEffort?: string;
-    /** All variant ids the assigned model offers — lets {{opencodeVariantConfig}} disable the non-chosen ones. */
-    modelVariants?: string[];
-    mode: string;
-    /**
-     * Autonomy axis: when true, resolve {{if headless}} blocks and the
-     * {{feature:headless}} token so the agent never stops to ask for permission.
-     * True for every orchestrated task run — nobody is watching the terminal on
-     * Ordewell's behalf — independently of the session *shape* below.
-     */
-    headless?: boolean;
-    /**
-     * Session-shape axis: true when the runner is launched onto a real TTY the
-     * user can attach to (a tmux window, a VS Code pseudoterminal), so the
-     * runner's own TUI should come up rather than its non-interactive
-     * subcommand. Defaults to `!headless` for callers that predate the split.
-     */
-    interactive?: boolean;
-    /** The task's working directory — needed by runners whose autonomy flags name a path. */
-    cwd?: string;
-}
-interface RunnerInvocation {
-    command: string;
-    args: string[];
-    env: Record<string, string>;
-    promptInArgs: boolean;
-    /** True when a surface running this invocation on a real TTY must send an explicit Enter once the process starts. */
-    submitPromptKey: boolean;
-}
-/**
- * Persistent storage seam for plugin manifests. The RunnerRegistry delegates
- * all filesystem operations to this interface so the plugin lifecycle is
- * testable without real I/O.
- */
-interface IPluginStore {
-    /** Path to the user plugins directory (~/.ordewell/plugins/). */
-    getUserPluginsDir(): string;
-    /** List subdirectory names inside the user plugins directory. */
-    listUserPluginDirs(): string[];
-    /** List entry names directly inside a directory. Returns [] when unreadable. */
-    listDir(dir: string): string[];
-    /** Read and parse a manifest.json from pluginDir. Returns null on failure. */
-    loadManifest(pluginDir: string): RunnerPluginManifest | null;
-    /** Recursively copy sourceDir to destDir. */
-    copyDir(sourceDir: string, destDir: string): void;
-    /** Recursively remove a directory. */
-    removeDir(dir: string): void;
-    /** Ensure a directory exists (mkdir -p). */
-    ensureDir(dir: string): void;
-    /** Write a text file. */
-    writeFile(filePath: string, content: string): void;
-    /** Read a UTF-8 text file. Returns null on ENOENT or read error. */
-    readFile(filePath: string): string | null;
-    /** True if path exists and is a directory. */
-    dirExists(path: string): boolean;
-    /** True if path exists. */
-    exists(path: string): boolean;
-}
-
-/** True when a name belongs to a built-in runner and is therefore not installable. */
-declare function isReservedRunnerName(name: string): boolean;
-/** Clone seam: takes a validated URL and a destination, or throws. */
-type PluginCloneFn = (url: string, destDir: string) => void;
-declare class RunnerRegistry {
-    private plugins;
-    private store;
-    private clone;
-    constructor(store?: IPluginStore, clone?: PluginCloneFn);
-    private loadBuiltins;
-    loadUserPlugins(): void;
-    get(id: string): PluginEntry | undefined;
-    getManifest(id: string): RunnerPluginManifest | undefined;
-    list(): PluginEntry[];
-    listEnabled(config: IConfig): PluginEntry[];
-    listEnabledIds(config: IConfig): string[];
-    isBuiltIn(id: string): boolean;
-    installFromPath(sourcePath: string): RunnerPluginManifest;
-    installFromGit(url: string): RunnerPluginManifest;
-    /**
-     * The single destination-building step both install routes share: the name is
-     * constrained to a plain segment and the resolved destination is asserted to
-     * be inside the plugins directory before anything is copied.
-     */
-    private registerInstalled;
-    remove(name: string): void;
-    createSkeleton(name: string, outputDir: string): string;
-}
-
-interface ITerminalSession {
-    id: string;
-    taskId: string;
-    onOutput(callback: (text: string) => void): void;
-    onExit(callback: (code: number) => void): void;
-    kill(): void;
-    getOutput(): string;
-    write(text: string): void;
-    /**
-     * True when the session runs the agent as a raw-mode TUI (a real PTY for the
-     * VS Code terminal, a tmux window). Such a surface submits an input line on
-     * the Enter keystroke (`\r`), so a synchronized resume token terminated with
-     * `\n` only types the line and never sends it. A line-oriented piped session
-     * (`defaultInteractive = false`) leaves this false and accepts `\n`.
-     */
-    readonly interactive?: boolean;
-    /**
-     * Optional transport-level control channel: PTY resize requests for a session
-     * whose runner renders a TUI. Absent on transports without a resizable PTY
-     * (a plain piped subprocess); surfaces must feature-detect before calling.
-     */
-    writeControl?(text: string): void;
-}
-
-interface ITerminalRunner {
-    spawn(opts: {
-        taskId: string;
-        runner: string;
-        prompt: string;
-        modelId?: string;
-        thinkingEffort?: string;
-        modelVariants?: string[];
-        mode?: string;
-        headless?: boolean;
-        cwd: string;
-        registry?: RunnerRegistry;
-        /** Task order and title — surfaces use these to label task_started/output events. */
-        order?: number;
-        title?: string;
-        /**
-         * The owning plan session. Task ids are only unique within one plan, so
-         * transports that key OS resources by task (tmux windows, log files) need
-         * this to keep two plans' identically named tasks apart.
-         */
-        planSessionId?: string;
-        /**
-         * The workspace's own variables (ADR-0016), under the runner's: a
-         * manifest's env still wins over them.
-         */
-        env?: Record<string, string>;
-    }): Promise<ITerminalSession>;
-    stop(sessionId: string): void;
-    stopAll(): void;
-    activeCount: number;
-}
-
-export { type AiProvider as A, type BlockingPrompt as B, type CatalogModel as C, type DiscoveryCommand as D, isReservedRunnerName as E, type FetchAllProviderModelsOptions as F, GREP_DEFAULT_HEAD_LIMIT as G, knownModelId as H, type IConfig as I, resolveModelShortcut as J, resolveProvider as K, toOrchestratorOptions as L, ModelCatalog as M, ORCHESTRATOR_SHORTCUTS as O, type PluginCloneFn as P, type ReadFileOpts as R, SEARCH_EXCLUSIONS as S, type ToolOutcome as T, type AllProviderModels as a, type FindSymbolOptions as b, type GlobOptions as c, type GrepOptions as d, type GrepOutputMode as e, type IFileSystem as f, type IPluginStore as g, type ITerminalRunner as h, type ITerminalSession as i, type ModelShortcut as j, type OrchestratorOption as k, type PluginEntry as l, type PluginFeatures as m, type PluginMode as n, type PluginModelDiscovery as o, type PluginRunnerDef as p, type ProviderCredentialSource as q, type ProviderModelLists as r, type ProviderModelsResult as s, type ResolveContext as t, type RunnerInvocation as u, type RunnerPluginManifest as v, RunnerRegistry as w, collectProviderCredentials as x, enabledRunners as y, fetchAllProviderModels as z };