197 lines
14 KiB
TypeScript
197 lines
14 KiB
TypeScript
// @generated by `cargo run -p protocol --example generate_typescript --features typescript`
|
|
// Do not edit by hand. Rust DTO authority lives in `crates/protocol`.
|
|
// Large integer fields are JSON numbers on the wire and are emitted as TypeScript `number`.
|
|
|
|
export type AlertLevel = "warn" | "error";
|
|
|
|
export type AlertSource = "worker" | "engine" | "compactor" | "agents_md";
|
|
|
|
export type CompletionKind = "file";
|
|
|
|
export type WorkerStatus = "idle" | "running" | "paused";
|
|
|
|
export type TurnResult = "finished" | "paused";
|
|
|
|
export type InvokeKind = "user_send" | "notify" | "worker_event" | "system_reminder" | "wakeup";
|
|
|
|
export type RunResult = "finished" | "paused" | "limit_reached" | "rolled_back";
|
|
|
|
export type ErrorCode = "already_running" | "not_running" | "not_paused" | "provider_error" | "tool_error" | "invalid_request" | "internal";
|
|
|
|
export type Permission = "read" | "write";
|
|
|
|
export type InFlightToolCallState = "pending" | "streaming_args" | "done";
|
|
|
|
export type CommandStatus = "running" | "completed" | "failed" | "timed_out" | "cancelled";
|
|
|
|
export type CommandStream = "stdout" | "stderr";
|
|
|
|
export type CommandStreamSlice = { start_offset: number, end_offset: number, content: string, truncated: boolean, };
|
|
|
|
export type CommandSnapshot = { command_id: string, tool_call_id: string | null, status: CommandStatus, started_at_ms: number, observed_at_ms: number, last_output_at_ms: number | null, stdout: CommandStreamSlice, stderr: CommandStreamSlice, exit_code: number | null, };
|
|
|
|
export type CommandEvent = { "kind": "started", command_id: string, tool_call_id: string | null, observed_at_ms: number, } | { "kind": "output", command_id: string, stream: CommandStream, start_offset: number, end_offset: number, content: string, observed_at_ms: number, } | { "kind": "terminal", command_id: string, status: CommandStatus, exit_code: number | null, stdout_end_offset: number, stderr_end_offset: number, observed_at_ms: number, };
|
|
|
|
export type ScopeRule = {
|
|
/**
|
|
* Target path. Must be absolute by the time a `Scope` is built from
|
|
* this rule — relative paths are resolved per-layer against the
|
|
* manifest file's directory (cwd for overlay layers) before cascade
|
|
* merge.
|
|
*/
|
|
target: string,
|
|
/**
|
|
* Permission level this rule grants (allow) or caps strictly below
|
|
* (deny).
|
|
*/
|
|
permission: Permission,
|
|
/**
|
|
* When `false`, the rule only matches the target itself and its
|
|
* direct children. Defaults to `true`.
|
|
*/
|
|
recursive: boolean, };
|
|
|
|
export type CompletionEntry = { value: string, is_dir: boolean, };
|
|
|
|
export type RewindTargetId = { segment_id: string, user_input_entry_index: number, };
|
|
|
|
export type RewindTarget = { id: RewindTargetId, expected_head_entries: number, truncate_entries: number, turn_index: number, timestamp_ms: number | null, preview: string, eligible: boolean, disabled_reason: string | null, warning: string | null, };
|
|
|
|
export type RewindSummary = { truncated_to_entries: number, discarded_entries: number, tool_side_effect_warning: boolean, };
|
|
|
|
export type InFlightBlock = { "kind": "text", text: string, finished?: boolean, } | { "kind": "thinking", text: string, finished?: boolean, } | { "kind": "tool_call", id: string, name: string, args: string, state?: InFlightToolCallState, };
|
|
|
|
export type InFlightSnapshot = { blocks?: Array<InFlightBlock>, commands?: Array<CommandSnapshot>, };
|
|
|
|
export type InternalWorkerKind = "sub_worker";
|
|
|
|
export type InternalWorkerRef = { session_id: string, name: string, parent_session_id?: string | null, kind: InternalWorkerKind, };
|
|
|
|
export type InternalWorkerSnapshot = { worker: InternalWorkerRef, revision: number, entries: Array<unknown>, status: WorkerStatus, error?: string | null, in_flight?: InFlightSnapshot, internal_workers?: Array<InternalWorkerSnapshot>, };
|
|
|
|
export type Greeting = { worker_name: string, cwd: string, provider: string, model: string, scope_summary: string, tools: Array<string>,
|
|
/**
|
|
* Model context window in tokens. Always filled by the Worker greeting.
|
|
*/
|
|
context_window: number,
|
|
/**
|
|
* Estimated current session context tokens at connect time.
|
|
*/
|
|
context_tokens: number, };
|
|
|
|
export type Alert = { level: AlertLevel, source: AlertSource, message: string,
|
|
/**
|
|
* Milliseconds since the Unix epoch.
|
|
*/
|
|
timestamp_ms: number, };
|
|
|
|
export type MemoryWorkerEvent = { worker: string, status: string, run_id: string, trigger: string, reason: string,
|
|
/**
|
|
* Human-readable compact form for actionbar rendering.
|
|
*/
|
|
message: string,
|
|
/**
|
|
* Milliseconds since the Unix epoch.
|
|
*/
|
|
timestamp_ms: number, };
|
|
|
|
export type Segment = { "kind": "text", content: string, } | { "kind": "paste", id: number, chars: number, lines: number, content: string, } | { "kind": "file_ref", path: string, } | { "kind": "flow", selector: string, } | { "kind": "unknown" };
|
|
|
|
export type WorkerEvent = { "kind": "turn_ended", worker_name: string, } | { "kind": "errored", worker_name: string, message: string, } | { "kind": "shut_down", worker_name: string, } | { "kind": "scope_sub_delegated",
|
|
/**
|
|
* Sub-delegating Worker (= the sender itself).
|
|
*/
|
|
parent_worker: string,
|
|
/**
|
|
* Name of the grandchild Worker.
|
|
*/
|
|
sub_worker: string,
|
|
/**
|
|
* Unix-socket path where the grandchild is reachable.
|
|
*/
|
|
sub_socket: string,
|
|
/**
|
|
* Scope delegated to the grandchild.
|
|
*/
|
|
scope: Array<ScopeRule>, };
|
|
|
|
export type SubscriptionRequestId = string;
|
|
|
|
export type SubscriptionId = string;
|
|
|
|
export type SubscriptionWorkerId = string;
|
|
|
|
export type SubscriptionWorkdirId = string;
|
|
|
|
export type SubscriptionWorkerIds = Array<SubscriptionWorkerId>;
|
|
|
|
export type SubscriptionWorkerState = "idle" | "running" | "paused" | "stopped" | "cancelled";
|
|
|
|
export type EventSubscriptionSelector = { "topic": "runtime_workers" } | { "topic": "worker_lifecycle", worker_ids: SubscriptionWorkerIds, } | { "topic": "worker_protocol", worker_id: SubscriptionWorkerId, runtime_id?: string | null, } | { "topic": "workspace_workers" } | { "topic": "workspace_workdirs" };
|
|
|
|
export type SubscriptionWorker = { worker_id: SubscriptionWorkerId,
|
|
/**
|
|
* Set by the Workspace Server when projecting a Runtime-owned Worker to clients.
|
|
* Runtime producers leave this unset because the connection identifies the Runtime.
|
|
*/
|
|
runtime_id?: string | null,
|
|
/**
|
|
* Workspace-scoped canonical resource key. Runtime producers leave this unset;
|
|
* Workspace-facing projections must populate it before publishing the Worker.
|
|
*/
|
|
resource_key?: string | null,
|
|
/**
|
|
* Producer-owned monotonic revision for this Worker subject.
|
|
*/
|
|
subject_revision: number, state: SubscriptionWorkerState, has_running_internal_workers: boolean, workspace_id?: string | null, display_name?: string | null, profile?: string | null, repository_id?: string | null, working_directory_id?: SubscriptionWorkdirId | null, };
|
|
|
|
export type SubscriptionWorkdir = { working_directory_id: SubscriptionWorkdirId, repository_id: string, state: string, primary_worker_id?: SubscriptionWorkerId | null, };
|
|
|
|
export type SubscriptionSnapshot = { "topic": "workers", "data": { workers: Array<SubscriptionWorker>, } } | { "topic": "worker_protocol", "data": { worker_id: SubscriptionWorkerId, events: Array<Event>, } } | { "topic": "workspace_workdirs", "data": { workdirs: Array<SubscriptionWorkdir>, } };
|
|
|
|
export type SubscriptionEventPayload = { "event": "worker_upserted", "data": { worker: SubscriptionWorker, } } | { "event": "worker_removed", "data": { worker_id: SubscriptionWorkerId, runtime_id?: string | null, } } | { "event": "worker_protocol", "data": { worker_id: SubscriptionWorkerId, event: Event, } } | { "event": "workdir_upserted", "data": { workdir: SubscriptionWorkdir, } } | { "event": "workdir_removed", "data": { working_directory_id: SubscriptionWorkdirId, } };
|
|
|
|
export type SubscriptionRejectionCode = "invalid_request" | "unsupported_protocol_version" | "unsupported_selector" | "unauthorized" | "resource_not_found" | "capacity_exceeded" | "internal";
|
|
|
|
export type SubscriptionTerminationCode = "lagged" | "resource_gone" | "unauthorized" | "server_shutdown";
|
|
|
|
export type SubscriptionRequest = { "method": "subscribe_events", "params": { request_id: SubscriptionRequestId, selector: EventSubscriptionSelector, } } | { "method": "unsubscribe_events", "params": { request_id: SubscriptionRequestId, subscription_id: SubscriptionId, } };
|
|
|
|
export type SubscriptionWorkerProtocolMethod = { subscription_id: SubscriptionId, method: Method, };
|
|
|
|
export type SubscriptionResponse = { "result": "subscribed", "payload": { request_id: SubscriptionRequestId, subscription_id: SubscriptionId, selector: EventSubscriptionSelector, snapshot_revision: number, snapshot: SubscriptionSnapshot, } } | { "result": "unsubscribed", "payload": { request_id: SubscriptionRequestId, subscription_id: SubscriptionId, } } | { "result": "subscription_rejected", "payload": { request_id: SubscriptionRequestId, subscription_id?: SubscriptionId | null, code: SubscriptionRejectionCode, message: string, } };
|
|
|
|
export type SubscriptionEvent = { "event": "event", "data": { subscription_id: SubscriptionId, subject_revision: number, payload: SubscriptionEventPayload, } } | { "event": "subscription_closed", "data": { subscription_id: SubscriptionId, code: SubscriptionTerminationCode, message: string, } };
|
|
|
|
export type SubscriptionFramePayload = { "frame": "request", "message": SubscriptionRequest } | { "frame": "response", "message": SubscriptionResponse } | { "frame": "event", "message": SubscriptionEvent } | { "frame": "worker_protocol", "message": SubscriptionWorkerProtocolMethod };
|
|
|
|
export type SubscriptionFrame = { protocol_version: number, } & ({ "frame": "request", "message": SubscriptionRequest } | { "frame": "response", "message": SubscriptionResponse } | { "frame": "event", "message": SubscriptionEvent } | { "frame": "worker_protocol", "message": SubscriptionWorkerProtocolMethod });
|
|
|
|
export type Method = { "method": "run", "params": { input: Array<Segment>, } } | { "method": "notify", "params": { message: string, auto_run?: boolean, } } | { "method": "worker_event", "params": WorkerEvent } | { "method": "resume" } | { "method": "cancel" } | { "method": "pause" } | { "method": "compact" } | { "method": "list_rewind_targets" } | { "method": "rewind_to", "params": { target: RewindTargetId, expected_head_entries: number, } } | { "method": "shutdown" } | { "method": "list_completions", "params": { kind: CompletionKind, prefix: string, } } | { "method": "list_workers" } | { "method": "restore_worker", "params": { name: string, } } | { "method": "register_peer", "params": { name: string, } };
|
|
|
|
export type Event = { "event": "user_message", "data": { segments: Array<Segment>, } } | { "event": "system_item", "data": { item: unknown, } } | { "event": "invoke_start", "data": { kind: InvokeKind, } } | { "event": "turn_start", "data": { turn: number, } } | { "event": "turn_end", "data": { turn: number, result: TurnResult, } } | { "event": "llm_call_start", "data": { llm_call: number, } } | { "event": "llm_call_end", "data": { llm_call: number, } } | { "event": "llm_retry", "data": { llm_call: number,
|
|
/**
|
|
* The attempt that just failed. 1 origin.
|
|
*/
|
|
failed_attempt: number, max_attempts: number, wait_ms: number, elapsed_ms: number, status?: number | null, error: string, } } | { "event": "llm_continuation", "data": { llm_call: number, attempt: number, max_attempts: number, reason: string, } } | { "event": "text_delta", "data": { text: string, } } | { "event": "text_done", "data": { text: string, } } | { "event": "thinking_start" } | { "event": "thinking_delta", "data": { text: string, } } | { "event": "thinking_done", "data": { text: string, } } | { "event": "tool_call_start", "data": { id: string, name: string, } } | { "event": "tool_call_args_delta", "data": { id: string, json: string, } } | { "event": "tool_call_done", "data": { id: string, name: string, arguments: string, } } | { "event": "tool_result", "data": { id: string,
|
|
/**
|
|
* Short human-readable summary. Always present; used by clients
|
|
* that only want a 1-line rendering (e.g. collapsed views).
|
|
*/
|
|
summary: string,
|
|
/**
|
|
* Full tool output. Absent when the tool chose to return
|
|
* summary-only, or when the result was pruned.
|
|
*/
|
|
output?: string | null, is_error: boolean, } } | { "event": "usage", "data": { input_tokens: number | null, output_tokens: number | null, cache_read_input_tokens?: number | null, } } | { "event": "run_end", "data": { result: RunResult, } } | { "event": "error", "data": { code: ErrorCode, message: string, } } | { "event": "snapshot", "data": { entries: Array<unknown>, greeting: Greeting, status: WorkerStatus,
|
|
/**
|
|
* Unfinished model output that has already streamed in the current
|
|
* run but is not yet represented by committed snapshot entries.
|
|
*/
|
|
in_flight?: InFlightSnapshot,
|
|
/**
|
|
* Parent-owned Internal Worker sessions visible to this client.
|
|
* Service-private Internal Workers are deliberately excluded.
|
|
*/
|
|
internal_workers?: Array<InternalWorkerSnapshot>, } } | { "event": "internal_worker", "data": { worker: InternalWorkerRef, revision: number, event: Event, } } | { "event": "internal_worker_removed", "data": { worker: InternalWorkerRef, revision: number, } } | { "event": "segment_rotated", "data": { entry: unknown, } } | { "event": "status", "data": { status: WorkerStatus, } } | { "event": "command", "data": { event: CommandEvent, } } | { "event": "completions", "data": { kind: CompletionKind, entries: Array<CompletionEntry>, } } | { "event": "rewind_targets", "data": { head_entries: number, targets: Array<RewindTarget>, } } | { "event": "rewind_applied", "data": { entries: Array<unknown>, input: Array<Segment>, summary: RewindSummary, } } | { "event": "workers_listed", "data": { workers: unknown, } } | { "event": "worker_restored", "data": { result: unknown, } } | { "event": "peer_registered", "data": { result: unknown, } } | { "event": "alert", "data": Alert } | { "event": "memory_worker", "data": MemoryWorkerEvent } | { "event": "compact_start" } | { "event": "compact_done", "data": { new_segment_id: string, } } | { "event": "compact_failed", "data": { error: string, } } | { "event": "shutdown" };
|