@oomol-lab/open-flow 0.1.0-beta.12 → 0.1.0-beta.14

package/dist/common/control-api.d.ts

@@ -1,3 +1,6 @@
+import type { ResultQuery } from './run-results.js';
+import { decodeResultList, decodeResultRead } from './run-results.js';
+export { readResult, parseResultQuery, decodeResultList, decodeResultRead, type ResultCall, type ResultInfo, type ResultPage, type ResultQuery, } from './run-results.js';
 import type { RunStatus } from './run-lifecycle.js';
 import type { ChangeOperation, InputPortDefinition, JsonValue, PortDefinition, RevisionContent, TriggerKeySnapshot, WaitAction } from '../browser/flow-change.js';
 export type { JsonValue, TriggerKeySnapshot, WaitAction } from '../browser/flow-change.js';
@@ -222,14 +225,19 @@ export interface Run {
     readonly status: RunStatus;
     readonly version: 1;
 }
-interface RunDetailsBase extends Run {
+type RunDetailsBase = Omit<Run, 'status'> & {
     readonly closureDigest: string;
     readonly engineContract: string;
     readonly engineDigest: string;
     readonly eventsExpiresAt?: string;
     readonly modelVersion: number;
     readonly revisionDigest: string;
-    readonly waiting?: {
+} & ({
+    readonly status: Exclude<RunStatus, 'waiting'>;
+    readonly waiting?: never;
+} | {
+    readonly status: 'waiting';
+    readonly waiting: {
         readonly actions: readonly ['continue'] | readonly ['approve', 'reject'];
         readonly expiresAt: string;
         readonly nodeId: string;
@@ -237,7 +245,7 @@ interface RunDetailsBase extends Run {
         readonly waitId: string;
         readonly waitingSince: string;
     };
-}
+});
 export type DraftRun = RunDetailsBase & {
     readonly source: 'draft';
 };
@@ -258,14 +266,8 @@ export interface RunPage {
     readonly runs: readonly Run[];
     readonly version: 1;
 }
-export type RunEventKind = 'node.artifact' | 'node.completed' | 'node.failed' | 'node.log' | 'node.progress' | 'node.started' | 'run.canceled' | 'run.completed' | 'run.events-truncated' | 'run.failed' | 'run.indeterminate' | 'run.progress' | 'run.queued' | 'run.resolved' | 'run.started' | 'run.waiting';
-export interface RunEvent {
-    readonly createdAt: string;
-    readonly kind: RunEventKind;
-    readonly payload: Readonly<Record<string, JsonValue>>;
-    readonly sequence: number;
-    readonly sourceSequence?: number;
-}
+export type RunEvent = Readonly<ReturnType<typeof decodeRunEvent>>;
+export type RunEventKind = RunEvent['kind'];
 export interface RunEvents {
     readonly done: boolean;
     readonly events: readonly RunEvent[];
@@ -318,6 +320,233 @@ export declare class ApiError extends Error {
     readonly status: number;
     constructor(status: number, code: string, message: string);
 }
+export declare function decodeRunEvent(value: unknown): {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.queued";
+    readonly payload: {
+        readonly flowId?: undefined;
+        readonly scopeId?: undefined;
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly nodeId?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.started";
+    readonly payload: {
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly parentScopeId?: string | undefined;
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly nodeId?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.progress";
+    readonly payload: {
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly progress: number;
+        readonly expiresAt?: undefined;
+        readonly nodeId?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.waiting";
+    readonly payload: {
+        readonly flowId?: undefined;
+        readonly scopeId?: undefined;
+        readonly progress?: undefined;
+        readonly expiresAt: string;
+        readonly nodeId: string;
+        readonly waitId: string;
+        readonly waitingSince: string;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly result?: undefined;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.resolved";
+    readonly payload: {
+        readonly flowId?: undefined;
+        readonly scopeId?: undefined;
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly nodeId?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action: "approve" | "continue" | "reject";
+        readonly resolvedAt: string;
+        readonly waitId: string;
+        readonly result?: undefined;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.canceled" | "run.completed" | "run.failed" | "run.indeterminate";
+    readonly payload: {
+        readonly flowId?: undefined;
+        readonly scopeId?: undefined;
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly nodeId?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result: JsonValue;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "run.events-truncated";
+    readonly payload: {
+        [k: string]: JsonValue;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "node.started";
+    readonly payload: {
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly nodeId: string;
+        readonly executionId: string;
+        readonly nodeKind?: string | undefined;
+        readonly nodeTitle?: string | undefined;
+        readonly operation?: string | undefined;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "node.completed";
+    readonly payload: {
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly nodeId: string;
+        readonly executionId: string;
+        readonly outputs: {
+            [k: string]: JsonValue;
+        };
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "node.failed";
+    readonly payload: {
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly nodeId: string;
+        readonly executionId: string;
+        readonly error: {
+            readonly code: string;
+            readonly message: string;
+        };
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "node.log";
+    readonly payload: {
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly nodeId: string;
+        readonly executionId: string;
+        readonly level: "debug" | "error" | "info" | "warn";
+        readonly message: string;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "node.progress";
+    readonly payload: {
+        readonly expiresAt?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly nodeId: string;
+        readonly executionId: string;
+        readonly progress: number;
+    };
+} | {
+    readonly createdAt: string;
+    readonly sequence: number;
+    readonly kind: "node.artifact";
+    readonly payload: {
+        readonly progress?: undefined;
+        readonly expiresAt?: undefined;
+        readonly waitingSince?: undefined;
+        readonly action?: undefined;
+        readonly resolvedAt?: undefined;
+        readonly waitId?: undefined;
+        readonly result?: undefined;
+        readonly flowId: string;
+        readonly scopeId: string;
+        readonly nodeId: string;
+        readonly executionId: string;
+        readonly artifact: {
+            readonly kind: 'artifact';
+            readonly id: string;
+            readonly name: string;
+            readonly size: number;
+            readonly digest: string;
+            readonly mediaType?: string | undefined;
+        };
+    };
+};
 export declare class ControlClient {
     private readonly requestControl;
     constructor(requestControl: ControlRequest);
@@ -390,6 +619,9 @@ export declare class ControlClient {
         readonly after?: number;
         readonly limit?: number;
     }, signal?: AbortSignal): Promise<RunEvents>;
+    listRunResults(runId: string, after?: string, signal?: AbortSignal): Promise<ReturnType<typeof decodeResultList>>;
+    readRunResult(runId: string, resultId: string, options?: ResultQuery, signal?: AbortSignal): Promise<ReturnType<typeof decodeResultRead>>;
+    downloadRunResult(runId: string, resultId: string, signal?: AbortSignal): Promise<Blob>;
     getRunResult(runId: string, signal?: AbortSignal): Promise<RunResult>;
     cancelRun(runId: string): Promise<RunCancellation>;
     resolveRunWait(runId: string, waitId: string, action: WaitAction): Promise<{
@@ -402,5 +634,6 @@ export declare class ControlClient {
         readonly waitId: string;
     }>;
     private connectorActions;
+    private response;
     protected request<Value = unknown>(path: string, init?: RequestInit): Promise<Value>;
 }