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

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

@@ -6,6 +6,11 @@ export { controlErrorCode, controlErrorMetadata, type ControlErrorCode } from '.
 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,6 +91,8 @@ 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;
@@ -244,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.resolved' | 'run.started' | 'run.waiting';
+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;
@@ -289,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>>>>;
 }
@@ -322,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;
@@ -331,6 +349,14 @@ 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): Promise<DraftSync>;
     getRevision(flowId: string, revisionId: string): Promise<Draft>;
@@ -342,18 +368,19 @@ export declare class ControlClient {
     createConnectorConnectionPage(serviceId: string, flowId?: string): Promise<string>;
     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>;
+    }, 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): 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;
@@ -362,8 +389,8 @@ 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;