@blueking/bkflow-canvas-editor 1.0.2 → 1.1.0-beta.0

package/dist/index.d.ts

@@ -6,8 +6,45 @@ import { CanvasUiEvent, QuickAddConfig, FlowModel, FlowNodeModel, NodeActionsCon
 export { InsertDirection, QuickAddConfig, QuickAddInsertDirectionResolver, QuickAddPortResolver } from '@blueking/flow-canvas';
 
 type NodeExecutionStatus = 'CREATED' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'SUSPENDED' | 'REVOKED';
+type ExecutionNodeAction = 'retry' | 'skip' | 'resume' | 'approve' | 'forceFail' | 'gatewaySkip';
 interface NodeExecutionState {
     status: NodeExecutionStatus;
+    /** 旧版任务引擎的 task 状态，优先用于识别 REVOKED */
+    taskState?: string;
+    /** 兼容旧版 snake_case 字段 */
+    task_state?: string;
+    /** 节点组件 code，如 pause_node / bk_approve，用于动作分流 */
+    nodeCode?: string;
+    /** 兼容旧版 snake_case 字段 */
+    code?: string;
+    /** 编辑态配置：失败可重试 */
+    retryable?: boolean;
+    /** 编辑态配置：失败可跳过 */
+    skippable?: boolean;
+    /** 编辑态配置：自动忽略错误（隐含 retry/skip 权限） */
+    errorIgnorable?: boolean;
+    /** 兼容旧版 snake_case 字段 */
+    error_ignorable?: boolean;
+    /** 是否有管理员权限，影响强制终止按钮 */
+    hasAdminPerm?: boolean;
+    /** 兼容旧版 snake_case 字段 */
+    has_admin_perm?: boolean;
+    /** 运行时信息：实际重试次数 */
+    retry?: number;
+    /** 运行时信息：是否已跳过 */
+    skip?: boolean;
+    /** 运行时信息：是否自动忽略错误 */
+    errorIgnored?: boolean;
+    /** 兼容旧版 snake_case 字段 */
+    error_ignored?: boolean;
+    /** 运行时信息：循环次数 */
+    loop?: number;
+    /** 运行时信息：生命周期阶段 */
+    phase?: number;
+    /** 若由上游直接给出操作列表，则 resolver 不再推导 */
+    actions?: ExecutionNodeAction[];
+    /** 兼容旧版后端直接透出的动作数组字段 */
+    action_list?: ExecutionNodeAction[];
 }
 type TaskExecutionStates = Record<string, NodeExecutionState>;
 
@@ -70,6 +107,16 @@ interface Activity {
     action: string;
   };
   status?: NodeExecutionStatus;
+  /** 执行态：实际重试次数 */
+  retry?: number;
+  /** 执行态：是否被跳过 */
+  skip?: boolean;
+  /** 执行态：是否自动忽略错误 */
+  error_ignored?: boolean;
+  /** 执行态：循环执行次数 */
+  loop?: number;
+  /** 执行态：生命周期阶段 */
+  phase?: number;
 }
 
 interface StartEvent {
@@ -160,13 +207,25 @@ interface Variable {
   show_type: 'show' | 'hide';
   source_info: Record<string, string[]>;
   source_tag: string;
-  source_type: 'custom' | 'component_inputs' | 'component_outputs' | 'system';
+  source_type: 'custom' | 'component_inputs' | 'component_outputs' | 'system' | 'space';
   validation: string;
-  value?: string | number | boolean | Record<string, any>;
+  value?: string | number | boolean | Record<string, any> | any[];
   version?: string;
   form_schema?: Record<string, any>;
   pre_render_mako?: boolean;
   plugin_code?: string;
+  /**
+   * 全局变量改版后新增字段，前端自管。
+   * 用于存储「组件配置」区域的扩展字段（如 required、data_type、placeholder、validation_error_msg），
+   * 后端原样透传即可。
+   */
+  meta?: {
+    required?: boolean;
+    data_type?: string;
+    placeholder?: string;
+    validation_error_msg?: string;
+    [key: string]: any;
+  };
 }
 
 interface PipelineTree {
@@ -714,14 +773,14 @@ type __VLS_Props$5 = {
     enableVersion?: boolean;
     flowVersion?: string;
 };
-declare var __VLS_65: {
+declare var __VLS_72: {
     formData: {
         name: string;
     };
     variablesValue: Record<string, any>;
 };
 type __VLS_Slots$4 = {} & {
-    'custom-form-content'?: (props: typeof __VLS_65) => any;
+    'custom-form-content'?: (props: typeof __VLS_72) => any;
 };
 declare const __VLS_base$4: vue.DefineComponent<__VLS_Props$5, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
     close: (...args: any[]) => void;
@@ -768,6 +827,12 @@ type __VLS_Props$4 = {
     onBack?: () => void;
 };
 declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$4, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    retry: (nodeId: string) => any;
+    skip: (nodeId: string) => any;
+    resume: (nodeId: string) => any;
+    approve: (nodeId: string) => any;
+    forceFail: (nodeId: string) => any;
+    gatewaySkip: (nodeId: string) => any;
     back: () => any;
     "ui-event": (event: CanvasUiEvent) => any;
     "node-click": (event: {
@@ -776,7 +841,17 @@ declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$4, {}, {}, {}, {}, v
     } & {
         type: "node.click";
     }) => any;
+    "execution-action": (payload: {
+        nodeId: string;
+        action: ExecutionNodeAction;
+    }) => any;
 }, string, vue.PublicProps, Readonly<__VLS_Props$4> & Readonly<{
+    onRetry?: ((nodeId: string) => any) | undefined;
+    onSkip?: ((nodeId: string) => any) | undefined;
+    onResume?: ((nodeId: string) => any) | undefined;
+    onApprove?: ((nodeId: string) => any) | undefined;
+    onForceFail?: ((nodeId: string) => any) | undefined;
+    onGatewaySkip?: ((nodeId: string) => any) | undefined;
     onBack?: (() => any) | undefined;
     "onUi-event"?: ((event: CanvasUiEvent) => any) | undefined;
     "onNode-click"?: ((event: {
@@ -785,6 +860,10 @@ declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$4, {}, {}, {}, {}, v
     } & {
         type: "node.click";
     }) => any) | undefined;
+    "onExecution-action"?: ((payload: {
+        nodeId: string;
+        action: ExecutionNodeAction;
+    }) => any) | undefined;
 }>, {
     showHeader: boolean;
     defaultZoom: number;
@@ -1246,6 +1325,21 @@ declare const bkflowConnectionValidator: ConnectionValidator;
 
 declare function createExecutionStatusPlugin(stateRef: Ref<TaskExecutionStates>): CanvasPlugin;
 
+/**
+ * 执行态动作 resolver。
+ *
+ * 输入的 nodeType 必须是 canvas-adapter schema 层的节点类型（例如 `task` /
+ * `exclusive-gateway` / `parallel-gateway`），不要直接传 pipelineTree 的
+ * `ServiceActivity` / `ExclusiveGateway` 等原始类型。
+ *
+ * 行为：
+ *  - 如果上游显式给出 `state.actions`，优先使用；
+ *  - 否则根据 status / nodeCode / retryable / skippable / errorIgnorable 推导。
+ *
+ * 不涵盖子流程节点（当前 schema 没有独立的 subprocess 节点类型），留待后续 PR。
+ */
+declare function resolveExecutionActions(state: NodeExecutionState | undefined, nodeType: string): ExecutionNodeAction[];
+
 declare const _default: {
     FlowView: () => Promise<typeof __view_vue>;
     FlowEdit: () => Promise<typeof __edit_vue>;
@@ -1254,5 +1348,5 @@ declare const _default: {
     FlowDebug: () => Promise<typeof __debug_vue>;
 };
 
-export { _default$1 as BkFlowCanvas, BkFlowModelAccessor, BkFlowNodeAccessor, _default$4 as FlowCreateTask, _default$6 as FlowDebug, _default$3 as FlowEdit, _default$5 as FlowExecute, _default$2 as FlowView, bkflowConnectionValidator, createBkflowPlugin, createBkflowSchema, createExecutionStatusPlugin, _default as default, exportToPipelineTree, generateId, getUniformApiPluginFormValue, getVariableDefaultConfig, importFromPipelineTree, provideFlowApiConfig, provideSelectPanelConfig, random4, useFlowApiConfig, useFlowEditApiConfig, useFlowViewApiConfig, useSelectPanelConfig, validatePipelineTree };
-export type { Activity, DndNodeItem, FlowApiConfig, FlowEditExpose, FlowTemplate, Gateway, GatewayCondition, NodeExecutionState, NodeExecutionStatus, NotifyConfig, PipelineTree, PluginDetailCommon, PluginInputDataItem, SelectPanelConfig, SpaceFlowConfig, TaskExecutionStates, TemplateConfigs, TriggerCron, TriggerItem, UniformApiPluginInputsItem, UpdateFlowParams, Variable, VariableReference };
+export { _default$1 as BkFlowCanvas, BkFlowModelAccessor, BkFlowNodeAccessor, _default$4 as FlowCreateTask, _default$6 as FlowDebug, _default$3 as FlowEdit, _default$5 as FlowExecute, _default$2 as FlowView, bkflowConnectionValidator, createBkflowPlugin, createBkflowSchema, createExecutionStatusPlugin, _default as default, exportToPipelineTree, generateId, getUniformApiPluginFormValue, getVariableDefaultConfig, importFromPipelineTree, provideFlowApiConfig, provideSelectPanelConfig, random4, resolveExecutionActions, useFlowApiConfig, useFlowEditApiConfig, useFlowViewApiConfig, useSelectPanelConfig, validatePipelineTree };
+export type { Activity, DndNodeItem, ExecutionNodeAction, FlowApiConfig, FlowEditExpose, FlowTemplate, Gateway, GatewayCondition, NodeExecutionState, NodeExecutionStatus, NotifyConfig, PipelineTree, PluginDetailCommon, PluginInputDataItem, SelectPanelConfig, SpaceFlowConfig, TaskExecutionStates, TemplateConfigs, TriggerCron, TriggerItem, UniformApiPluginInputsItem, UpdateFlowParams, Variable, VariableReference };