@oomol-lab/open-flow 0.1.0-beta.1 → 0.1.0-beta.11

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

@@ -1,11 +1,16 @@
 import type { RunStatus } from './run-lifecycle.js';
-import type { ChangeOperation, InputPortDefinition, JsonValue, PortDefinition, RevisionContent, TriggerKeySnapshot } from '../browser/flow-change.js';
-export type { JsonValue, TriggerKeySnapshot } from '../browser/flow-change.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';
 export type { RunStatus } from './run-lifecycle.js';
 export { controlErrorCode, controlErrorMetadata, type ControlErrorCode } from './control-api-errors.js';
 export type { FlowCatalogEvent, FlowChangeEvent } from './flow-notifications.js';
 export type ControlRequest = (path: string, init?: RequestInit) => Promise<Response>;
 export interface Flow {
+    readonly live?: {
+        readonly enabled: boolean;
+        readonly publicationId: string;
+        readonly revisionId: string;
+    };
     readonly createdAt: string;
     readonly draftRevisionId: string;
     readonly flowId: string;
@@ -14,6 +19,12 @@ export interface Flow {
     readonly updatedAt: string;
     readonly version: 1;
 }
+export interface Presentation {
+    readonly revision: number;
+    readonly updatedAt: string;
+    readonly value: Readonly<Record<string, JsonValue>>;
+    readonly version: 1;
+}
 export interface FlowPage {
     readonly flows: readonly Flow[];
     readonly nextCursor?: string;
@@ -72,6 +83,7 @@ export interface PollTriggerTestResult {
     readonly version: 1;
 }
 export interface ConnectorConnection {
+    readonly alias?: string;
     readonly connectionId: string;
     readonly displayName: string;
     readonly isDefault: boolean;
@@ -79,9 +91,13 @@ export interface ConnectorConnection {
     readonly status: 'active' | 'disconnected' | 'error' | 'reauth_required';
 }
 export interface ConnectorAction {
+    readonly inputSchema?: JsonValue;
+    readonly outputSchema?: JsonValue;
     readonly actionId: string;
+    readonly authenticated: boolean;
     readonly defaultConnection?: ConnectorConnection;
     readonly description: string;
+    readonly homepageUrl?: string;
     readonly icon?: string;
     readonly inputs: Readonly<Record<string, InputPortDefinition>>;
     readonly name: string;
@@ -90,6 +106,7 @@ export interface ConnectorAction {
     readonly serviceName: string;
 }
 export interface ConnectorProvider {
+    readonly homepageUrl?: string;
     readonly icon?: string;
     readonly serviceId: string;
     readonly serviceName: string;
@@ -111,18 +128,11 @@ export interface DraftChange {
     readonly revision: RevisionMetadata;
     readonly version: 1;
 }
-export type DraftSync = {
-    readonly kind: 'changes';
-    readonly revisions: readonly {
-        readonly operations: readonly ChangeOperation[];
-        readonly revision: RevisionMetadata;
-    }[];
-    readonly version: 1;
-} | {
+export interface DraftSync {
     readonly draft: Draft;
     readonly kind: 'snapshot';
     readonly version: 1;
-};
+}
 export interface Publication {
     readonly actorId: string;
     readonly closureDigest: string;
@@ -137,6 +147,37 @@ export interface Publication {
     readonly sourcePublicationId?: string;
     readonly version: 1;
 }
+export type PublishOperation = {
+    readonly createdAt: string;
+    readonly flowId: string;
+    readonly operationId: string;
+    readonly revisionId: string;
+    readonly status: 'pending';
+    readonly updatedAt: string;
+    readonly version: 1;
+} | {
+    readonly createdAt: string;
+    readonly flowId: string;
+    readonly operationId: string;
+    readonly publicationId: string;
+    readonly revisionId: string;
+    readonly status: 'succeeded';
+    readonly updatedAt: string;
+    readonly version: 1;
+} | {
+    readonly createdAt: string;
+    readonly flowId: string;
+    readonly issue: {
+        readonly code: string;
+        readonly message: string;
+        readonly nodeId?: string;
+    };
+    readonly operationId: string;
+    readonly revisionId: string;
+    readonly status: 'failed';
+    readonly updatedAt: string;
+    readonly version: 1;
+};
 export interface Diagnostic {
     readonly code: string;
     readonly column: number;
@@ -188,6 +229,14 @@ interface RunDetailsBase extends Run {
     readonly eventsExpiresAt?: string;
     readonly modelVersion: number;
     readonly revisionDigest: string;
+    readonly waiting?: {
+        readonly actions: readonly ['continue'] | readonly ['approve', 'reject'];
+        readonly expiresAt: string;
+        readonly nodeId: string;
+        readonly prompt: string;
+        readonly waitId: string;
+        readonly waitingSince: string;
+    };
 }
 export type DraftRun = RunDetailsBase & {
     readonly source: 'draft';
@@ -209,7 +258,7 @@ export interface RunPage {
     readonly runs: readonly Run[];
     readonly version: 1;
 }
-export type RunEventKind = 'node.artifact' | 'node.completed' | 'node.failed' | 'node.log' | 'node.output' | 'node.progress' | 'node.started' | 'run.canceled' | 'run.completed' | 'run.events-truncated' | 'run.failed' | 'run.indeterminate' | 'run.progress' | 'run.queued' | 'run.started';
+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;
@@ -254,6 +303,10 @@ export type RunResult = {
     readonly version: 1;
 };
 interface RunOptions {
+    readonly trigger: {
+        readonly nodeId: string;
+        readonly payload: JsonValue;
+    };
     readonly idempotencyKey?: string;
     readonly inputs?: Readonly<Record<string, Readonly<Record<string, JsonValue>>>>;
 }
@@ -287,7 +340,7 @@ export declare class ControlClient {
     listTriggerKeys(signal?: AbortSignal): Promise<readonly TriggerKeySummary[]>;
     listTriggerDefinitions(signal?: AbortSignal): Promise<readonly TriggerKeySnapshot[]>;
     getTriggerKey(key: string, signal?: AbortSignal): Promise<TriggerKeySnapshot>;
-    listFlowTriggerBindings(flowId: string): Promise<readonly TriggerBinding[]>;
+    listFlowTriggerBindings(flowId: string, signal?: AbortSignal): Promise<readonly TriggerBinding[]>;
     getFlowTriggerBinding(flowId: string, triggerNodeId: string): Promise<TriggerBindingDetail>;
     listFlowTriggerActivities(flowId: string, triggerNodeId: string, options?: {
         readonly cursor?: string;
@@ -296,8 +349,16 @@ export declare class ControlClient {
     pauseFlowTrigger(flowId: string, triggerNodeId: string): Promise<TriggerBinding>;
     resumeFlowTrigger(flowId: string, triggerNodeId: string): Promise<TriggerBinding>;
     testFlowPollTrigger(flowId: string, triggerNodeId: string): Promise<PollTriggerTestResult>;
+    getEditor(flowId: string): Promise<{
+        readonly flow: Flow;
+        readonly draft: Draft;
+        readonly live: Live;
+        readonly presentation: Presentation;
+        readonly version: 1;
+    }>;
+    getPresentation(flowId: string): Promise<Presentation>;
     getDraft(flowId: string): Promise<Draft>;
-    syncDraft(flowId: string, fromRevisionId?: string): Promise<DraftSync>;
+    syncDraft(flowId: string): Promise<DraftSync>;
     getRevision(flowId: string, revisionId: string): Promise<Draft>;
     listConnectorProviders(signal?: AbortSignal, flowId?: string): Promise<readonly ConnectorProvider[]>;
     listConnectorActions(serviceId?: string, signal?: AbortSignal, flowId?: string): Promise<readonly ConnectorAction[]>;
@@ -305,19 +366,21 @@ export declare class ControlClient {
     getConnectorAction(actionId: string, signal?: AbortSignal, flowId?: string): Promise<ConnectorAction>;
     listConnectorConnections(serviceId: string, signal?: AbortSignal, flowId?: string): Promise<readonly ConnectorConnection[]>;
     createConnectorConnectionPage(serviceId: string, flowId?: string): Promise<string>;
-    changeDraft(flowId: string, expectedRevisionId: string, operations: readonly ChangeOperation[]): Promise<DraftChange>;
+    changeDraft(flowId: string, expectedRevisionId: string, operations: readonly ChangeOperation[], changeId?: string): Promise<DraftChange>;
     checkFlow(flowId: string, revisionId: string): Promise<FlowCheck>;
-    getLive(flowId: string): Promise<Live>;
+    getLive(flowId: string, signal?: AbortSignal): Promise<Live>;
     listPublications(flowId: string, options?: {
         readonly cursor?: string;
         readonly includeTotal?: boolean;
         readonly limit?: number;
-    }): Promise<PublicationPage>;
-    createDraftRun(flowId: string, revisionId: string, options?: RunOptions): Promise<DraftRun>;
-    createLiveRun(publicationId: string, options?: RunOptions): Promise<LiveRun>;
-    publishFlow(flowId: string, revisionId: string, expectedLivePublicationId: string | null, options?: PublicationOptions): Promise<Publication>;
+    }, signal?: AbortSignal): Promise<PublicationPage>;
+    createDraftRun(flowId: string, revisionId: string, options: RunOptions): Promise<DraftRun>;
+    createLiveRun(publicationId: string, options: RunOptions): Promise<LiveRun>;
+    setFlowEnabled(flowId: string, publicationId: string, enabled: boolean): Promise<Flow>;
+    publishFlow(flowId: string, revisionId: string, expectedLivePublicationId: string | null, options?: PublicationOptions): Promise<PublishOperation>;
+    getPublishOperation(flowId: string, operationId: string, signal?: AbortSignal): Promise<PublishOperation>;
     rollbackFlow(flowId: string, publicationId: string, expectedLivePublicationId: string, options?: PublicationOptions): Promise<Publication>;
-    getRun(runId: string): Promise<RunDetails>;
+    getRun(runId: string, signal?: AbortSignal): Promise<RunDetails>;
     listRuns(flowId: string, options?: {
         readonly cursor?: string;
         readonly limit?: number;
@@ -326,9 +389,18 @@ export declare class ControlClient {
     getRunEvents(runId: string, options?: {
         readonly after?: number;
         readonly limit?: number;
-    }): Promise<RunEvents>;
-    getRunResult(runId: string): Promise<RunResult>;
+    }, signal?: AbortSignal): Promise<RunEvents>;
+    getRunResult(runId: string, signal?: AbortSignal): Promise<RunResult>;
     cancelRun(runId: string): Promise<RunCancellation>;
+    resolveRunWait(runId: string, waitId: string, action: WaitAction): Promise<{
+        readonly action: WaitAction | null;
+        readonly resolutionAccepted: boolean;
+        readonly resolvedAt: string | null;
+        readonly runId: string;
+        readonly status: RunStatus;
+        readonly version: 1;
+        readonly waitId: string;
+    }>;
     private connectorActions;
     protected request<Value = unknown>(path: string, init?: RequestInit): Promise<Value>;
 }