@oomol-lab/open-flow 0.1.0-beta.65 → 0.1.0-beta.66

package/dist/common/workflow.d.ts

@@ -0,0 +1,93 @@
+import type { TaskNode, ManagedTaskDefinition, Port, JsonValue, RevisionContent } from '../browser/flow-change.js';
+import { z } from 'zod';
+export interface WorkflowExecutor {
+    readonly kind: 'workflow';
+    readonly flowId: string;
+    readonly revisionId: string;
+}
+export declare const publishedWorkflowInterfaceSchema: z.ZodObject<{
+    inputs: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        jsonSchema: z.ZodType<JsonValue>;
+        nullable: z.ZodBoolean;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    outputs: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        jsonSchema: z.ZodType<JsonValue>;
+        nullable: z.ZodBoolean;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strict>;
+export type PublishedWorkflowInterface = z.infer<typeof publishedWorkflowInterfaceSchema>;
+/** The callable interface of one fixed definition; absence differs from empty ports. */
+export declare function publishedWorkflowInterface(content: Pick<RevisionContent, 'document'>): PublishedWorkflowInterface;
+export declare function sameWorkflowInterface(left: PublishedWorkflowInterface, right: PublishedWorkflowInterface): boolean;
+export declare const workflowContractSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    flowId: z.ZodString;
+    name: z.ZodString;
+    revisionId: z.ZodString;
+    publicationId: z.ZodString;
+    inputs: z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        jsonSchema: z.ZodType<JsonValue>;
+        nullable: z.ZodBoolean;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    outputs: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        jsonSchema: z.ZodType<JsonValue>;
+        nullable: z.ZodBoolean;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type WorkflowContract = z.infer<typeof workflowContractSchema>;
+export interface WorkflowCandidate {
+    readonly flowId: string;
+    readonly name: string;
+    readonly problem: 'unpublished' | 'disabled' | 'retiring' | 'recursive' | 'missing-start' | null;
+}
+/** Classify only list metadata; opening the selector does not inspect a Revision. */
+export declare function workflowCandidate(flow: {
+    flowId: string;
+    name: string;
+    status: string;
+    live?: {
+        enabled: boolean;
+        hasStart: boolean;
+    } | null;
+}, sourceFlowId?: string): WorkflowCandidate;
+export declare function workflowCandidateGroup(candidate: WorkflowCandidate): 'published' | 'missingStart' | 'other';
+/** A selected target is durable even before its callable interface is available. */
+export declare function workflowSelectionTask(candidate: Pick<WorkflowCandidate, 'flowId' | 'name'>, contract?: WorkflowContract, previous?: ManagedTaskDefinition): ManagedTaskDefinition;
+export declare function workflowTask(contract: WorkflowContract, name?: string): ManagedTaskDefinition;
+export declare function workflowPorts(ports: readonly Port[]): WorkflowContract['inputs'];
+export declare function workflowCompatibility(node: TaskNode, contract: WorkflowContract, previous?: PublishedWorkflowInterface): readonly {
+    side: 'revision' | 'input' | 'output';
+    field: string;
+    message: string;
+    reason?: 'snapshot-missing' | 'interface-required' | 'revision-stale';
+}[];
+/** Refresh capability ports by exact name; removed outputs remain unresolved at consumers. */
+export declare function withWorkflowTask(node: TaskNode, task: ManagedTaskDefinition): TaskNode;
+export declare const workflowReferencesSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    direction: z.ZodEnum<{
+        incoming: "incoming";
+        outgoing: "outgoing";
+    }>;
+    total: z.ZodInt;
+    nextOffset: z.ZodOptional<z.ZodInt>;
+    references: z.ZodArray<z.ZodObject<{
+        flowId: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        available: z.ZodBoolean;
+        draft: z.ZodBoolean;
+        live: z.ZodNullable<z.ZodObject<{
+            publicationId: z.ZodString;
+            enabled: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type WorkflowReferences = z.infer<typeof workflowReferencesSchema>;