@flowgram.ai/runtime-interface 0.2.22 → 0.2.24

package/dist/index.d.mts

@@ -17,12 +17,11 @@ declare enum FlowGramAPIName {
     TaskReport = "TaskReport",
     TaskResult = "TaskResult",
     TaskCancel = "TaskCancel",
-    Validation = "Validation"
+    TaskValidate = "TaskValidate"
 }
 declare enum FlowGramAPIModule {
     Info = "Info",
-    Task = "Task",
-    Validation = "Validation"
+    Task = "Task"
 }
 
 /**
@@ -94,6 +93,9 @@ interface IJsonSchema<T = string> {
     items?: IJsonSchema<T>;
     required?: string[];
     $ref?: string;
+    key?: number;
+    name?: string;
+    isPropertyRequired?: boolean;
     extra?: {
         index?: number;
         weak?: boolean;
@@ -212,6 +214,20 @@ interface InvokeParams {
 }
 type WorkflowRuntimeInvoke = (params: InvokeParams) => Promise<WorkflowInputs>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface ValidationResult {
+    valid: boolean;
+    errors?: string[];
+}
+interface IValidation {
+    invoke(params: InvokeParams): ValidationResult;
+}
+declare const IValidation: unique symbol;
+
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -290,63 +306,6 @@ interface IStatusCenter {
     exportNodeStatus(): Record<string, StatusData>;
 }
 
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-
-interface SnapshotData {
-    nodeID: string;
-    inputs: WorkflowInputs;
-    outputs: WorkflowOutputs;
-    data: any;
-    branch?: string;
-}
-interface Snapshot extends SnapshotData {
-    id: string;
-}
-interface ISnapshot {
-    id: string;
-    data: Partial<SnapshotData>;
-    addData(data: Partial<SnapshotData>): void;
-    validate(): boolean;
-    export(): Snapshot;
-}
-
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-
-interface ISnapshotCenter {
-    id: string;
-    create(snapshot: Partial<SnapshotData>): ISnapshot;
-    exportAll(): Snapshot[];
-    export(): Record<string, Snapshot[]>;
-    init(): void;
-    dispose(): void;
-}
-
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-
-interface IOData {
-    inputs: WorkflowInputs;
-    outputs: WorkflowOutputs;
-}
-/** Input & Output */
-interface IIOCenter {
-    inputs: WorkflowInputs;
-    outputs: WorkflowOutputs;
-    setInputs(inputs: WorkflowInputs): void;
-    setOutputs(outputs: WorkflowOutputs): void;
-    init(inputs: WorkflowInputs): void;
-    dispose(): void;
-    export(): IOData;
-}
-
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -360,7 +319,9 @@ declare enum FlowGramNode {
     Condition = "condition",
     Loop = "loop",
     Comment = "comment",
-    Group = "group"
+    Group = "group",
+    BlockStart = "block-start",
+    BlockEnd = "block-end"
 }
 
 /**
@@ -427,6 +388,8 @@ interface INode<T = any> {
     children: INode[];
     prev: INode[];
     next: INode[];
+    successors: INode[];
+    predecessors: INode[];
     isBranch: boolean;
 }
 interface CreateNodeParams {
@@ -476,6 +439,77 @@ interface IState {
     addExecutedNode(node: INode): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface SnapshotData {
+    nodeID: string;
+    inputs: WorkflowInputs;
+    outputs: WorkflowOutputs;
+    data: any;
+    branch?: string;
+    error?: string;
+}
+interface Snapshot extends SnapshotData {
+    id: string;
+}
+interface ISnapshot {
+    id: string;
+    data: Partial<SnapshotData>;
+    update(data: Partial<SnapshotData>): void;
+    validate(): boolean;
+    export(): Snapshot;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface ISnapshotCenter {
+    id: string;
+    create(snapshot: Partial<SnapshotData>): ISnapshot;
+    exportAll(): Snapshot[];
+    export(): Record<string, Snapshot[]>;
+    init(): void;
+    dispose(): void;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+declare enum WorkflowMessageType {
+    Log = "log",
+    Info = "info",
+    Debug = "debug",
+    Error = "error",
+    Warn = "warning"
+}
+interface MessageData {
+    message: string;
+    nodeID?: string;
+    timestamp?: number;
+}
+interface IMessage extends MessageData {
+    id: string;
+    type: WorkflowMessageType;
+    timestamp: number;
+}
+type WorkflowMessages = Record<WorkflowMessageType, IMessage[]>;
+interface IMessageCenter {
+    init(): void;
+    dispose(): void;
+    log(data: MessageData): IMessage;
+    info(data: MessageData): IMessage;
+    debug(data: MessageData): IMessage;
+    error(data: MessageData): IMessage;
+    warn(data: MessageData): IMessage;
+    export(): WorkflowMessages;
+}
+
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -485,21 +519,44 @@ interface NodeReport extends StatusData {
     id: string;
     snapshots: Snapshot[];
 }
+type WorkflowReports = Record<string, NodeReport>;
 interface IReport {
     id: string;
     inputs: WorkflowInputs;
     outputs: WorkflowOutputs;
     workflowStatus: StatusData;
-    reports: Record<string, NodeReport>;
+    reports: WorkflowReports;
+    messages: WorkflowMessages;
 }
 interface IReporter {
     snapshotCenter: ISnapshotCenter;
     statusCenter: IStatusCenter;
+    messageCenter: IMessageCenter;
     init(): void;
     dispose(): void;
     export(): IReport;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface IOData {
+    inputs: WorkflowInputs;
+    outputs: WorkflowOutputs;
+}
+/** Input & Output */
+interface IIOCenter {
+    inputs: WorkflowInputs;
+    outputs: WorkflowOutputs;
+    setInputs(inputs: WorkflowInputs): void;
+    setOutputs(outputs: WorkflowOutputs): void;
+    init(inputs: WorkflowInputs): void;
+    dispose(): void;
+    export(): IOData;
+}
+
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -512,6 +569,7 @@ interface ContextData {
     ioCenter: IIOCenter;
     snapshotCenter: ISnapshotCenter;
     statusCenter: IStatusCenter;
+    messageCenter: IMessageCenter;
     reporter: IReporter;
 }
 interface IContext extends ContextData {
@@ -545,8 +603,7 @@ interface TaskParams {
 interface EndNodeData {
     title: string;
     inputs: IJsonSchema<'object'>;
-    outputs: IJsonSchema<'object'>;
-    outputValues: Record<string, IFlowConstantRefValue>;
+    inputsValues: Record<string, IFlowConstantRefValue>;
 }
 type EndNodeSchema = WorkflowNodeSchema<FlowGramNode.End, EndNodeData>;
 
@@ -581,6 +638,58 @@ interface StartNodeData {
 }
 type StartNodeSchema = WorkflowNodeSchema<FlowGramNode.Start, StartNodeData>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface LoopNodeData {
+    title: string;
+    loopFor: IFlowRefValue;
+    loopOutputs: Record<string, IFlowRefValue>;
+}
+type LoopNodeSchema = WorkflowNodeSchema<FlowGramNode.Loop, LoopNodeData>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+declare enum ConditionOperation {
+    EQ = "eq",
+    NEQ = "neq",
+    GT = "gt",
+    GTE = "gte",
+    LT = "lt",
+    LTE = "lte",
+    IN = "in",
+    NIN = "nin",
+    CONTAINS = "contains",
+    NOT_CONTAINS = "not_contains",
+    IS_EMPTY = "is_empty",
+    IS_NOT_EMPTY = "is_not_empty",
+    IS_TRUE = "is_true",
+    IS_FALSE = "is_false"
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface ConditionItem {
+    key: string;
+    value: {
+        left: IFlowRefValue;
+        operator: ConditionOperation;
+        right: IFlowConstantRefValue;
+    };
+}
+interface ConditionNodeData {
+    title: string;
+    conditions: ConditionItem[];
+}
+type ConditionNodeSchema = WorkflowNodeSchema<FlowGramNode.Condition, ConditionNodeData>;
+
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -621,6 +730,7 @@ declare const IExecutor: unique symbol;
  */
 
 interface EngineServices {
+    Validation: IValidation;
     Executor: IExecutor;
 }
 interface IEngine {
@@ -632,20 +742,6 @@ interface IEngine {
 }
 declare const IEngine: unique symbol;
 
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-
-interface ValidationResult {
-    valid: boolean;
-    errors?: string[];
-}
-interface IValidation {
-    validate(schema: WorkflowSchema): ValidationResult;
-}
-declare const IValidation: unique symbol;
-
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -693,12 +789,13 @@ declare const TaskReportDefine: FlowGramAPIDefine;
  * SPDX-License-Identifier: MIT
  */
 
-interface ValidationReq {
+interface TaskValidateInput {
+    inputs: WorkflowInputs;
     schema: string;
 }
-interface ValidationRes extends ValidationResult {
+interface TaskValidateOutput extends ValidationResult {
 }
-declare const ValidationDefine: FlowGramAPIDefine;
+declare const TaskValidateDefine: FlowGramAPIDefine;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
@@ -734,6 +831,7 @@ interface IRuntimeClient {
     [FlowGramAPIName.TaskReport]: (input: TaskReportInput) => Promise<TaskReportOutput | undefined>;
     [FlowGramAPIName.TaskResult]: (input: TaskResultInput) => Promise<TaskResultOutput | undefined>;
     [FlowGramAPIName.TaskCancel]: (input: TaskCancelInput) => Promise<TaskCancelOutput | undefined>;
+    [FlowGramAPIName.TaskValidate]: (input: TaskValidateInput) => Promise<TaskValidateOutput | undefined>;
 }
 
-export { type ContainerService, type ContextData, type CreateEdgeParams, type CreateNodeParams, type CreatePortParams, type EndNodeSchema, type EngineServices, type ExecutionContext, type ExecutionResult, type FlowGramAPIDefine, type FlowGramAPIDefines, FlowGramAPIMethod, FlowGramAPIModule, FlowGramAPIName, FlowGramAPINames, FlowGramAPIs, FlowGramNode, type IBasicJsonSchema, type IContainer, type IContext, type IDocument, type IEdge, IEngine, IExecutor, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IIOCenter, type IJsonSchema, type INode, type INodeExecutor, type INodeExecutorFactory, type IOData, type IPort, type IReport, type IReporter, type IRuntimeClient, type ISnapshot, type ISnapshotCenter, type IState, type IStatus, type IStatusCenter, type ITask, IValidation, type IVariable, type IVariableParseResult, type IVariableStore, type InvokeParams, type JsonSchemaBasicType, type LLMNodeSchema, type NodeReport, type NodeDeclare as NodeVariable, type PositionSchema, ServerInfoDefine, type ServerInfoInput, type ServerInfoOutput, type Snapshot, type SnapshotData, type StartNodeSchema, type StatusData, TaskCancelDefine, type TaskCancelInput, type TaskCancelOutput, type TaskParams, TaskReportDefine, type TaskReportInput, type TaskReportOutput, TaskResultDefine, type TaskResultInput, type TaskResultOutput, TaskRunDefine, type TaskRunInput, type TaskRunOutput, type VOData, ValidationDefine, type ValidationReq, type ValidationRes, type ValidationResult, type WorkflowEdgeSchema, type WorkflowInputs, type WorkflowNodeMetaSchema, type WorkflowNodeSchema, type WorkflowOutputs, WorkflowPortType, type WorkflowRuntimeInvoke, type WorkflowSchema, WorkflowStatus, WorkflowVariableType, type XYSchema };
+export { type ConditionItem, type ConditionNodeSchema, ConditionOperation, type ContainerService, type ContextData, type CreateEdgeParams, type CreateNodeParams, type CreatePortParams, type EndNodeSchema, type EngineServices, type ExecutionContext, type ExecutionResult, type FlowGramAPIDefine, type FlowGramAPIDefines, FlowGramAPIMethod, FlowGramAPIModule, FlowGramAPIName, FlowGramAPINames, FlowGramAPIs, FlowGramNode, type IBasicJsonSchema, type IContainer, type IContext, type IDocument, type IEdge, IEngine, IExecutor, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IIOCenter, type IJsonSchema, type IMessage, type IMessageCenter, type INode, type INodeExecutor, type INodeExecutorFactory, type IOData, type IPort, type IReport, type IReporter, type IRuntimeClient, type ISnapshot, type ISnapshotCenter, type IState, type IStatus, type IStatusCenter, type ITask, IValidation, type IVariable, type IVariableParseResult, type IVariableStore, type InvokeParams, type JsonSchemaBasicType, type LLMNodeSchema, type LoopNodeSchema, type MessageData, type NodeReport, type NodeDeclare as NodeVariable, type PositionSchema, ServerInfoDefine, type ServerInfoInput, type ServerInfoOutput, type Snapshot, type SnapshotData, type StartNodeSchema, type StatusData, TaskCancelDefine, type TaskCancelInput, type TaskCancelOutput, type TaskParams, TaskReportDefine, type TaskReportInput, type TaskReportOutput, TaskResultDefine, type TaskResultInput, type TaskResultOutput, TaskRunDefine, type TaskRunInput, type TaskRunOutput, TaskValidateDefine, type TaskValidateInput, type TaskValidateOutput, type VOData, type ValidationResult, type WorkflowEdgeSchema, type WorkflowInputs, WorkflowMessageType, type WorkflowMessages, type WorkflowNodeMetaSchema, type WorkflowNodeSchema, type WorkflowOutputs, WorkflowPortType, type WorkflowReports, type WorkflowRuntimeInvoke, type WorkflowSchema, WorkflowStatus, WorkflowVariableType, type XYSchema };