ultracode-for-codex 0.2.0

package/dist/runtime/workflow-runtime.d.ts

@@ -0,0 +1,266 @@
+import type { SubagentBackend } from './types.js';
+import type { WorkflowJournalDurability } from './workflow-journal.js';
+export type WorkflowTaskStatus = 'running' | 'completed' | 'failed';
+export type WorkflowTaskType = 'local_workflow';
+export type WorkflowSource = 'inline' | 'script_path' | 'project' | 'user' | 'plugin' | 'built_in';
+export type WorkflowPermissionDecision = 'allow' | 'deny';
+export type WorkflowEvent = {
+    readonly type: 'workflow.started';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly workflowName: string;
+    readonly scriptPath: string;
+    readonly workflowSource: WorkflowSource;
+    readonly workflowSourcePath?: string;
+    readonly scriptHash: string;
+} | {
+    readonly type: 'workflow.phase.started';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly phaseIndex: number;
+    readonly title: string;
+    readonly detail?: string;
+} | {
+    readonly type: 'workflow.log';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly message: string;
+} | {
+    readonly type: 'workflow.agent.started';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly agentIndex: number;
+    readonly agentId: string;
+    readonly label: string;
+    readonly phase?: string;
+    readonly promptPreview: string;
+} | {
+    readonly type: 'workflow.agent.completed';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly agentIndex: number;
+    readonly agentId: string;
+    readonly label: string;
+    readonly phase?: string;
+    readonly tokens: number;
+    readonly toolCalls: number;
+    readonly resultPreview?: string;
+    readonly cached?: boolean;
+    readonly worktreePath?: string;
+    readonly worktreePreserved?: boolean;
+    readonly preservedWorktrees?: readonly WorkflowAgentPreservedWorktree[];
+} | {
+    readonly type: 'workflow.agent.failed';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly agentIndex: number;
+    readonly agentId: string;
+    readonly label: string;
+    readonly phase?: string;
+    readonly error: string;
+    readonly skipped?: boolean;
+    readonly worktreePath?: string;
+    readonly worktreePreserved?: boolean;
+    readonly preservedWorktrees?: readonly WorkflowAgentPreservedWorktree[];
+} | {
+    readonly type: 'workflow.completed';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly resultPath: string;
+    readonly agentCount: number;
+    readonly tokens: number;
+    readonly toolCalls: number;
+    readonly durationMs: number;
+} | {
+    readonly type: 'workflow.failed';
+    readonly taskId: string;
+    readonly runId: string;
+    readonly error: string;
+    readonly recovery?: {
+        readonly retryable: boolean;
+        readonly reason: string;
+    };
+};
+export interface WorkflowLaunchInput {
+    readonly script?: string;
+    readonly name?: string;
+    readonly scriptPath?: string;
+    readonly args?: unknown;
+    readonly resumeFromRunId?: string;
+    readonly toolName?: string;
+}
+export type WorkflowLaunchResult = WorkflowAsyncLaunchResult | WorkflowPermissionRequiredResult;
+export interface WorkflowAsyncLaunchResult {
+    readonly status: 'async_launched';
+    readonly taskId: string;
+    readonly taskType: 'local_workflow';
+    readonly workflowName: string;
+    readonly runId: string;
+    readonly summary?: string;
+    readonly transcriptDir: string;
+    readonly scriptPath: string;
+    readonly workflowSource: WorkflowSource;
+    readonly workflowSourcePath?: string;
+    readonly scriptHash: string;
+}
+export interface WorkflowPermissionRequiredResult {
+    readonly status: 'permission_required';
+    readonly taskType: WorkflowTaskType;
+    readonly workflowName: string;
+    readonly summary?: string;
+    readonly workflowSource: WorkflowSource;
+    readonly workflowSourcePath?: string;
+    readonly scriptHash: string;
+    readonly permissionRequestId: string;
+    readonly review: WorkflowPermissionReview;
+}
+export interface WorkflowPermissionDeniedResult {
+    readonly status: 'permission_denied';
+    readonly taskType: WorkflowTaskType;
+    readonly workflowName: string;
+    readonly workflowSource: WorkflowSource;
+    readonly workflowSourcePath?: string;
+    readonly scriptHash: string;
+    readonly permissionRequestId: string;
+    readonly reason: 'workflow_permission_denied';
+}
+export interface WorkflowPermissionReview {
+    readonly permissionRequestId: string;
+    readonly reviewVersion: number;
+    readonly workflowName: string;
+    readonly summary?: string;
+    readonly workflowSource: WorkflowSource;
+    readonly workflowSourcePath?: string;
+    readonly scriptHash: string;
+    readonly phases: readonly string[];
+    readonly requestedIsolationModes: readonly string[];
+    readonly dynamicIsolation: boolean;
+    readonly riskSummary: string;
+    readonly scriptPreview: string;
+}
+export interface WorkflowTaskSnapshot {
+    readonly taskId: string;
+    readonly runId: string;
+    readonly workflowName: string;
+    readonly status: WorkflowTaskStatus;
+    readonly taskType: WorkflowTaskType;
+    readonly transcriptDir: string;
+    readonly scriptPath: string;
+    readonly workflowSource: WorkflowSource;
+    readonly workflowSourcePath?: string;
+    readonly scriptHash: string;
+    readonly resultPath?: string;
+    readonly result?: unknown;
+    readonly error?: string;
+    readonly failureReason?: string;
+    readonly events: readonly WorkflowEvent[];
+}
+export interface WorkflowRuntime {
+    launch(input: WorkflowLaunchInput): Promise<WorkflowLaunchResult>;
+    get(taskId: string): WorkflowTaskSnapshot | null;
+    cancel(taskId: string): Promise<WorkflowTaskSnapshot>;
+    retry(taskId: string): Promise<WorkflowLaunchResult>;
+    getPermissionRequest(permissionRequestId: string): WorkflowPermissionReview | null;
+    approvePermissionRequest(permissionRequestId: string): Promise<WorkflowLaunchResult>;
+    denyPermissionRequest(permissionRequestId: string): Promise<WorkflowPermissionDeniedResult>;
+    streamEvents(taskId: string, signal?: AbortSignal): AsyncIterable<WorkflowEvent>;
+    close?(): Promise<void>;
+}
+interface WorkflowTaskRegistryOptions {
+    readonly backend: SubagentBackend;
+    readonly cwd?: string;
+    readonly stateDir?: string;
+    readonly requestTimeoutMs: number;
+    readonly agentStallTimeoutMs?: number;
+    readonly agentStallRetryLimit?: number;
+    readonly userWorkflowDirs?: readonly string[];
+    readonly pluginWorkflows?: readonly WorkflowPluginRegistry[];
+    readonly builtinWorkflows?: readonly BuiltinWorkflow[];
+    readonly journalDurability?: WorkflowJournalDurability;
+}
+interface WorkflowPluginRegistry {
+    readonly pluginName: string;
+    readonly workflowsDir?: string;
+    readonly workflowsDirs?: readonly string[];
+    readonly workflowsPath?: string;
+    readonly workflowsPaths?: readonly string[];
+}
+interface BuiltinWorkflow {
+    readonly name: string;
+    readonly script: string;
+}
+export interface WorkflowAgentPreservedWorktree {
+    readonly path: string;
+    readonly attemptIndex: number;
+    readonly reason: 'changed' | 'stalled' | 'aborted' | 'status_unavailable' | 'cleanup_failed';
+}
+export declare class WorkflowTaskRegistry implements WorkflowRuntime {
+    private readonly options;
+    private readonly tasks;
+    private readonly permissionRequests;
+    private permissionRecords?;
+    private closed;
+    private readonly stateDir;
+    private readonly agentStallTimeoutMs;
+    private readonly agentStallRetryLimit;
+    constructor(options: WorkflowTaskRegistryOptions);
+    launch(input: WorkflowLaunchInput): Promise<WorkflowLaunchResult>;
+    private prepareResumePlan;
+    private workflowTaskByRunId;
+    private createResumeCache;
+    private resolveLaunchInput;
+    private workflowPermissionRequired;
+    private resolveTrustedScriptPathMetadata;
+    getPermissionRequest(permissionRequestId: string): WorkflowPermissionReview | null;
+    approvePermissionRequest(permissionRequestId: string): Promise<WorkflowLaunchResult>;
+    denyPermissionRequest(permissionRequestId: string): Promise<WorkflowPermissionDeniedResult>;
+    private consumePendingWorkflowPermission;
+    private deletePendingWorkflowPermissions;
+    private workflowPermissionRecord;
+    private recordWorkflowPermission;
+    private recordWorkflowSourceAllow;
+    private recordWorkflowPermissionRecord;
+    private workflowPermissionRecords;
+    private writeWorkflowPermissionRecords;
+    private workflowPermissionStorePath;
+    private resolveNamedWorkflow;
+    private userWorkflowDirs;
+    private findNamedWorkflowInDirs;
+    private findBuiltinWorkflow;
+    private workflowScriptsDir;
+    private workflowScriptPath;
+    private persistInlineWorkflowScript;
+    private writeWorkflowScriptMetadata;
+    private readRuntimeWorkflowScript;
+    private readWorkflowScriptMetadata;
+    get(taskId: string): WorkflowTaskSnapshot | null;
+    cancel(taskId: string): Promise<WorkflowTaskSnapshot>;
+    retry(taskId: string): Promise<WorkflowLaunchResult>;
+    streamEvents(taskId: string, signal?: AbortSignal): AsyncIterable<WorkflowEvent>;
+    close(): Promise<void>;
+    private runTask;
+    private createVmGlobals;
+    private runAgent;
+    private runAgentInner;
+    private createAgentWorktree;
+    private finalizeAgentWorktree;
+    private runAgentWithStallRetries;
+    private gitStatusArgsExcludingRuntimeState;
+    private runAgentAttempt;
+    private parallel;
+    private pipeline;
+    private phase;
+    private completeTask;
+    private failTask;
+    private finalizeTask;
+    private failTaskFromCallback;
+    private drainWorkflowFinalizers;
+    private trackWorkflowPromise;
+    private emit;
+    private notifyTaskWaiters;
+}
+export declare function workflowResultUsage(events: readonly WorkflowEvent[]): {
+    readonly inputTokens: number;
+    readonly outputTokens: number;
+};
+export {};