@oh-my-pi/pi-tui 18.2.11 → 18.3.0

package/dist/types/tools/hub.d.ts

@@ -1,342 +0,0 @@
-import type { Component } from "../tui.js";
-import type { Theme } from "../theme/theme.js";
-import { type OutputMeta } from "./output-meta.js";
-import { type ConfiguredThinkingLevel } from "../render/render-utils.js";
-import type { StructuredSubagentOutput } from "./task.js";
-import type { RenderResultOptions, ToolActivitySummary } from "./renderer.js";
-/** Whether a wait snapshot contains only running jobs and no cancellations. */
-export declare function isWaitingPollDetails(details: unknown): boolean;
-/**
- * Hub operations: messaging (`send`/`wait`/`inbox`/`list`), jobs
- * (`wait`/`cancel`/`jobs`), and process supervision (`start`/`ps`/`logs`/
- * `stop`/`restart`/`describe`, plus `send`/`wait` when they carry `name`).
- */
-export type HubOp = "send" | "wait" | "inbox" | "list" | "jobs" | "cancel" | "start" | "ps" | "logs" | "stop" | "restart" | "describe";
-/** Peer row surfaced by `op:"list"`. */
-export interface HubPeerInfo {
-    id: string;
-    displayName: string;
-    kind: string;
-    status: string;
-    parentId?: string;
-    unread: number;
-    lastActivity: number;
-    activity?: string;
-}
-/** Status values `op:"list"` can filter on. Advisor is a kind, not a status. */
-export type HubListStatus = "running" | "idle" | "parked";
-/** Model-facing roster bounds shared by the hub schema and executor. */
-export declare const DEFAULT_HUB_LIST_LIMIT = 32;
-/** Maximum number of peers in a hub roster page. */
-export declare const MAX_HUB_LIST_LIMIT = 100;
-/** Addressable roster tallies always returned by `op:"list"`. */
-export interface HubRosterCounts {
-    running: number;
-    idle: number;
-    parked: number;
-    shown: number;
-    truncated: number;
-}
-/** Background-job row surfaced by `wait`/`cancel`/`jobs` results. */
-export interface JobSnapshot {
-    id: string;
-    type: "bash" | "task" | "eval";
-    status: "running" | "completed" | "failed" | "cancelled";
-    label: string;
-    durationMs: number;
-    /** Process exit status when the job reports one. */
-    exitCode?: number;
-    /** Effective task model selector, including an explicit reasoning suffix when configured. */
-    resolvedModel?: string;
-    /** Provider/id including routing, with no added thinking suffix. */
-    resolvedModelIdentity?: string;
-    /** Explicit thinking metadata, independent of the model identity. */
-    resolvedThinkingLevel?: ConfiguredThinkingLevel;
-    /** True when the task progress reports an attached live advisor. */
-    advisor?: boolean;
-    resultText?: string;
-    errorText?: string;
-    /** Source-output metadata retained for per-job warnings and persisted row rendering. */
-    meta?: OutputMeta;
-    /** Capture error in historical snapshots; new snapshots store source metadata in `meta`. */
-    artifactError?: OutputMeta["artifactError"];
-    structured?: StructuredSubagentOutput;
-    /**
-     * `agent://<id>` handle backing this job's artifacts — the job-row's
-     * registry `agentId` when the manager disambiguated a requested job id
-     * on collision, else the job id itself. See {@link AsyncJob.agentId}.
-     */
-    agentUrlId?: string;
-}
-/** Outcome of cancelling one background job. */
-export type CancelStatus = "cancelled" | "not_found" | "already_completed";
-/** Cancellation outcome and its model-facing explanation. */
-export interface CancelOutcome {
-    id: string;
-    status: CancelStatus;
-    message: string;
-}
-/**
- * A live subagent from the AgentRegistry that has no backing job in the
- * AsyncJobManager — e.g. an idle agent woken (or a parked agent revived) via
- * a hub message, or a spawn owned by another agent. Surfaced by `jobs` and
- * empty-wait snapshots so the hub's picture matches the UI's running-agent
- * count.
- */
-export interface AgentActivitySnapshot {
-    id: string;
-    parentId?: string;
-    /** Latest activity gist recorded by the registry (display-only). */
-    activity?: string;
-    /** Time since the agent was registered. */
-    ageMs: number;
-    /**
-     * Whether an attached session corroborates the `running` claim. False marks
-     * a ref that says `running` with no turn in flight — either a spawn still
-     * wiring up or a stale registration that `hub cancel <id>` clears (#8634).
-     */
-    live: boolean;
-    /**
-     * Acceptance time of the agent's final result, when the registry recorded
-     * one. With `live: false` this is an accepted run the parent may cancel
-     * instead of waiting on (#11079).
-     */
-    acceptedAt?: number;
-}
-/** Result details for messaging and job ops; fields are disjoint per op. */
-export interface CoordinationDetails {
-    meta?: OutputMeta;
-    op: HubOp;
-    from?: string;
-    to?: string;
-    receipts?: IrcDeliveryReceipt[];
-    /** Message consumed by `wait` / `send await:true`; null when the wait timed out. */
-    waited?: IrcMessage | null;
-    inbox?: IrcMessage[];
-    peers?: HubPeerInfo[];
-    /** Present on `op:"list"`: addressable running/idle/parked plus page size. */
-    counts?: HubRosterCounts;
-    jobs?: JobSnapshot[];
-    cancelled?: {
-        id: string;
-        status: CancelStatus;
-    }[];
-    /** Running subagents not represented by a job row in this result. */
-    agents?: AgentActivitySnapshot[];
-}
-/** Hub result details: coordination snapshots or launch (process) state. */
-export type HubDetails = CoordinationDetails | LaunchToolDetails;
-/** Partially-streamed hub call arguments, as seen by the renderers. */
-export type HubRenderArgs = {
-    op?: string;
-    to?: string;
-    message?: string;
-    replyTo?: string;
-    await?: boolean;
-    from?: string;
-    peek?: boolean;
-    ids?: string[];
-} & Partial<Omit<LaunchParams, "op">>;
-/** Stable lifecycle states exposed by the launch tool. */
-export type DaemonState = "starting" | "running" | "ready" | "restarting" | "stopping" | "exited" | "failed";
-/** Restart behavior applied after an unexpected daemon exit. */
-export type DaemonRestartPolicy = "no" | "on-failure" | "always";
-/** Readiness conditions; every configured condition must pass. */
-export interface DaemonReadySpec {
-    log?: string;
-    port?: number;
-    host?: string;
-    timeoutMs: number;
-}
-/** Immutable launch specification retained for restart and inspection. */
-export interface DaemonSpec {
-    name: string;
-    application: string;
-    args: string[];
-    env: Record<string, string>;
-    cwd: string;
-    pty: boolean;
-    ready?: DaemonReadySpec;
-    restart: DaemonRestartPolicy;
-    persist: boolean;
-    detached: boolean;
-}
-/** Serializable daemon state visible to every client in one broker scope. */
-export interface DaemonSnapshot {
-    name: string;
-    id: string;
-    state: DaemonState;
-    pid?: number;
-    createdAt: number;
-    startedAt: number;
-    readyAt?: number;
-    exitedAt?: number;
-    exitCode?: number;
-    exitReason?: string;
-    restartCount: number;
-    outputBytes: number;
-    owner?: string;
-    readyMatch?: string;
-    /** Readiness conditions still unmet while `state` is `starting`; absent once ready or without a ready spec. */
-    readyPending?: ("log" | "port")[];
-    persist: boolean;
-    detached: boolean;
-}
-/** Serializable peer message retained in hub result snapshots. */
-export interface IrcMessage {
-    id: string;
-    /** Sender agent id. */
-    from: string;
-    /** Recipient agent id (resolved; "all" is expanded by the tool, not stored). */
-    to: string;
-    body: string;
-    ts: number;
-    /** Message id being answered. */
-    replyTo?: string;
-    /**
-     * Automated wake-turn relay of a woken subagent's stop output (task executor
-     * `relayWakeTurnOutput`). Relays are answers, never wake sources: the
-     * recipient's own wake-turn relay must skip them or two idle peers
-     * ping-pong forever.
-     */
-    wakeRelay?: boolean;
-}
-/** Delivery outcome for one peer recipient. */
-export interface IrcDeliveryReceipt {
-    to: string;
-    outcome: "injected" | "woken" | "revived" | "failed";
-    error?: string;
-}
-/** Broker-facing launch parameters; the hub adapts its `ps` op to `list` before calling in. */
-export interface LaunchParams {
-    op: "start" | "list" | "logs" | "wait" | "send" | "stop" | "restart" | "describe";
-    name?: string;
-    application?: string;
-    args?: string[];
-    env?: Record<string, string>;
-    cwd?: string;
-    pty?: boolean;
-    ready?: {
-        log?: string;
-        port?: number;
-        host?: string;
-        timeout?: number;
-    };
-    restart?: "no" | "on-failure" | "always";
-    persist?: boolean;
-    detached?: boolean;
-    lines?: number;
-    head?: boolean;
-    grep?: string;
-    follow?: boolean;
-    cursor?: number;
-    for?: "ready" | "exit";
-    pattern?: string;
-    text?: string;
-    enter?: boolean;
-    keys?: string[];
-    signal?: "SIGINT" | "SIGTERM" | "SIGHUP" | "SIGQUIT" | "SIGKILL";
-    timeout?: number;
-}
-/** Structured launch state retained for compact TUI rendering. */
-export interface LaunchToolDetails {
-    op: LaunchParams["op"];
-    daemon?: DaemonSnapshot;
-    daemons?: DaemonSnapshot[];
-    cursor?: number;
-    timedOut?: boolean;
-    /** logs: daemon lifecycle state at read time. */
-    state?: DaemonState;
-    /** logs: virtual terminal rows for display; model-facing content remains sanitized text. */
-    terminalRows?: string[];
-    /** wait: output line that satisfied the pattern. */
-    matched?: string;
-    /** describe: immutable launch spec backing the command/cwd detail lines. */
-    spec?: DaemonSpec;
-}
-/**
- * Human sentences for the readiness conditions still unmet, e.g.
- * `port 5173 on 127.0.0.1 never accepted connections`. `ready` (from the start
- * params) adds the concrete pattern/port; absent it falls back to generic labels.
- */
-export declare function readyPendingSummary(daemon: DaemonSnapshot, ready?: LaunchParams["ready"]): string[];
-/**
- * What a timed-out `wait` was actually blocked on: the output `pattern`, the
- * process exiting (`for: "exit"`, the default), or the unmet readiness
- * conditions (`for: "ready"`). Never reports readiness for an exit/pattern
- * wait — the process may well be ready and simply still running.
- */
-export declare function waitPendingSummary(daemon: DaemonSnapshot, params: Pick<LaunchParams, "for" | "pattern">): string[];
-/** Hub roster ordering (running before idle before parked) shared with the child prompt's live-row cap. */
-export declare const LIST_STATUS_ORDER: Record<string, number>;
-/** Pending-call frame for job ops (wait/cancel/jobs). */
-export declare function jobsRenderCall(args: HubRenderArgs, _options: RenderResultOptions, uiTheme: Theme): Component;
-/** Result frame for job snapshots (wait/cancel/jobs and the agents roster). */
-export declare function jobsRenderResult(result: {
-    content: Array<{
-        type: string;
-        text?: string;
-    }>;
-    details?: CoordinationDetails;
-    isError?: boolean;
-}, options: RenderResultOptions, uiTheme: Theme, hubArgs?: HubRenderArgs): Component;
-/** Args shape visible to the renderer, possibly mid-stream (every field optional). */
-export type LaunchRenderArgs = Partial<Omit<LaunchParams, "op">> & {
-    op?: string;
-};
-/** Pending-call frame for launch ops; consumes the spinner while the broker call is live. */
-export declare function launchRenderCall(args: LaunchRenderArgs, options: RenderResultOptions, theme: Theme): Component;
-/** Result frame: one status header per op, meta from structured details, capped body lines. */
-export declare function launchRenderResult(result: {
-    content: Array<{
-        type: string;
-        text?: string;
-    }>;
-    details?: LaunchToolDetails;
-    isError?: boolean;
-}, options: RenderResultOptions, theme: Theme, args?: LaunchRenderArgs): Component;
-/**
- * Display-only transcript card for live IRC traffic: `irc:incoming` DMs
- * delivered to this session, `irc:autoreply` side-channel replies sent on
- * this session's behalf, and `irc:relay` observations of agent↔agent
- * traffic. Shares the tool renderer's glyph + quote-border conventions so
- * cards and hub messaging output look identical in the transcript.
- */
-export declare function createIrcMessageCard(card: {
-    kind: "incoming" | "autoreply" | "relay" | "workpool";
-    from?: string;
-    to?: string;
-    body?: string;
-    replyTo?: string;
-    timestamp?: number;
-    pool?: string;
-    mode?: string;
-}, getExpanded: () => boolean, uiTheme: Theme): Component;
-/** Pending-call frame for messaging ops (send/wait-from/inbox/list). */
-export declare function messagingRenderCall(args: HubRenderArgs, _options: RenderResultOptions, uiTheme: Theme): Component;
-/** Result frame for messaging ops and message-carrying `wait` results. */
-export declare function messagingRenderResult(result: {
-    content: Array<{
-        type: string;
-        text?: string;
-    }>;
-    details?: CoordinationDetails;
-    isError?: boolean;
-}, options: RenderResultOptions, uiTheme: Theme, args?: HubRenderArgs): Component;
-/** Renders hub messaging, jobs, and supervised processes. */
-export declare const hubToolRenderer: {
-    inline: true;
-    mergeCallAndResult: true;
-    /** Compact one-line activity: op plus its peer, process, or job target. */
-    activitySummary(args: unknown): ToolActivitySummary;
-    animatedPendingPreview: (args: unknown) => boolean;
-    renderCall(args: HubRenderArgs, options: RenderResultOptions, uiTheme: Theme): Component;
-    renderResult(result: {
-        content: Array<{
-            type: string;
-            text?: string;
-        }>;
-        details?: HubDetails;
-        isError?: boolean;
-    }, options: RenderResultOptions, uiTheme: Theme, args?: HubRenderArgs): Component;
-};