@blueking/bkflow-canvas-editor 1.1.0-beta.5 → 1.1.0-beta.7

package/dist/advanced.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
 
-type NodeExecutionStatus = 'CREATED' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'SUSPENDED' | 'REVOKED';
+type NodeExecutionStatus = 'CREATED' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'SUSPENDED' | 'REVOKED' | 'SKIP';
 type ExecutionNodeAction = 'retry' | 'skip' | 'resume' | 'approve' | 'forceFail' | 'gatewaySkip';
 interface NodeExecutionState {
     status: NodeExecutionStatus;
@@ -600,6 +600,184 @@ interface CustomVariableType {
     code: string;
 }
 
+type DebugContextStatus = 'idle' | 'running' | 'terminating';
+type DebugNodeStatus = 'not_run' | 'running' | 'waiting' | 'paused' | 'finished' | 'failed' | 'suspended' | 'skipped';
+type DebugExecutionMode = 'real' | 'mock';
+interface DebugMissingVar {
+    key: string;
+    source_node_id: string | null;
+}
+type DebugRunMode = DebugExecutionMode | 'mixed';
+type DebugRunType = 'global' | 'step';
+type DebugRunStatus = 'not_run' | 'running' | 'waiting' | 'paused' | 'terminating' | 'finished' | 'failed' | 'revoked';
+/** 运行级 / 节点级错误详情（last_error_detail、nodes[].error_detail）。 */
+interface DebugErrorFailure {
+    message: string;
+    node_id?: string;
+    template_node_id?: string;
+    [key: string]: unknown;
+}
+interface DebugErrorDetail {
+    type?: string;
+    message?: string;
+    task_id?: number | string;
+    failures?: DebugErrorFailure[];
+    [key: string]: unknown;
+}
+interface DebugContextNode {
+    node_id: string;
+    node_type: string;
+    execution_mode: DebugExecutionMode;
+    status: DebugNodeStatus;
+    can_step: boolean;
+    missing_vars: DebugMissingVar[];
+    waiting_reason?: string | null;
+    mock_result?: 'success' | 'fail' | null;
+    error_detail?: DebugErrorDetail | string | null;
+    duration_ms?: number | null;
+    log_ref?: {
+        instance_id: number | string;
+        node_id: string;
+        version: string;
+    } | null;
+    mock_outputs?: Record<string, unknown> | null;
+    mock_error?: string | null;
+    outputs?: Record<string, unknown> | null;
+}
+/**
+ * /debug_context/ 顶层结构。
+ *
+ * 前端按 status 分支：
+ * - running：任务定位用 active_*，进度用 last_run_status
+ * - terminating：继续用 active_*，UI 展示「终止中」并轮询
+ * - idle：active_* 为空，结果摘要用 last_*；last_task_id=null 表示尚无调试记录
+ */
+interface DebugContext {
+    template_id: number;
+    status: DebugContextStatus;
+    locked_by: string;
+    active_task_id: number | string | null;
+    active_run_type: DebugRunType | null;
+    active_node_id: string | null;
+    last_task_id: number | string | null;
+    last_run_type: DebugRunType | null;
+    last_run_status: DebugRunStatus | null;
+    last_error_detail?: DebugErrorDetail | null;
+    last_inputs?: Record<string, unknown>;
+    global_vars: Record<string, unknown>;
+    missing_vars?: DebugMissingVar[];
+    nodes: DebugContextNode[];
+}
+interface DebugInputSchemaField {
+    key: string;
+    name: string;
+    type: string;
+    default?: unknown;
+    required?: boolean;
+    [key: string]: unknown;
+}
+interface DebugInputSchema {
+    fields?: DebugInputSchemaField[];
+    constants?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface DebugHistoryRun {
+    task_id?: number | string | null;
+    operator?: string;
+    started_at?: string;
+    finished_at?: string;
+    status?: DebugRunStatus | string;
+    run_type?: DebugRunType;
+    run_mode?: DebugRunMode;
+    [key: string]: unknown;
+}
+interface DebugHistory {
+    runs?: DebugHistoryRun[];
+    [key: string]: unknown;
+}
+interface DebugResetImpact {
+    reset_node_ids: string[];
+    reasons?: Record<string, string>;
+}
+interface DebugGlobalVarsResult {
+    global_vars: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface UpdateNodeDebugMockResult {
+    node_id: string;
+    execution_mode: DebugExecutionMode;
+    updated_global_vars?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface RunNodeDebugStepResult {
+    node_id: string;
+    status: DebugNodeStatus;
+    outputs?: Record<string, unknown> | null;
+    error_detail?: unknown;
+    updated_global_vars?: Record<string, unknown>;
+    log_ref?: DebugContextNode['log_ref'];
+    [key: string]: unknown;
+}
+interface RunGlobalDebugResult {
+    task_id: number | string;
+    status: DebugContextStatus;
+    [key: string]: unknown;
+}
+interface TerminateDebugResult {
+    status?: DebugContextStatus;
+    [key: string]: unknown;
+}
+interface DebugResetResult {
+    reset_node_ids?: string[];
+    [key: string]: unknown;
+}
+interface UpdateDebugContextVariableParams {
+    templateId: string | number;
+    key: string;
+    value: unknown;
+}
+interface UpdateNodeDebugMockParams {
+    templateId: string | number;
+    nodeId: string;
+    enable: boolean;
+    mockResult?: 'success' | 'fail';
+    mockOutputs?: Record<string, unknown>;
+    mockError?: string;
+}
+interface RunNodeDebugStepParams {
+    templateId: string | number;
+    nodeId: string;
+    mode: 'real' | 'mock';
+    inputOverrides?: Record<string, unknown>;
+    mockResult?: 'success' | 'fail';
+    mockOutputs?: Record<string, unknown>;
+    mockError?: string;
+}
+interface RunGlobalDebugParams {
+    templateId: string | number;
+    inputs: Record<string, unknown>;
+}
+interface TerminateDebugParams {
+    templateId: string | number;
+    nodeId?: string;
+}
+interface ResetDebugResultParams {
+    templateId: string | number;
+    nodeIds?: string[];
+}
+interface DebugApiServices {
+    fetchDebugContext(templateId: string | number): Promise<DebugContext>;
+    fetchDebugInputSchema(templateId: string | number): Promise<DebugInputSchema>;
+    fetchDebugHistory(templateId: string | number): Promise<DebugHistory>;
+    fetchDebugResetImpact(templateId: string | number): Promise<DebugResetImpact>;
+    updateDebugContextVariable(params: UpdateDebugContextVariableParams): Promise<DebugGlobalVarsResult>;
+    updateNodeDebugMock(params: UpdateNodeDebugMockParams): Promise<UpdateNodeDebugMockResult>;
+    runNodeDebugStep(params: RunNodeDebugStepParams): Promise<RunNodeDebugStepResult>;
+    runGlobalDebug(params: RunGlobalDebugParams): Promise<RunGlobalDebugResult>;
+    terminateDebug(params: TerminateDebugParams): Promise<TerminateDebugResult>;
+    resetDebugResult(params: ResetDebugResultParams): Promise<DebugResetResult>;
+}
+
 /**
  * Flow API 配置接口
  */
@@ -616,6 +794,8 @@ interface FlowApiConfig {
     scopeData: {
         scope_type: string;
         scope_value: number;
+        /** 业务方传入的空间 ID，调试接口专用，语义独立于 scope_value */
+        space_id: number;
     };
     /**
      * 用户查询 API 地址（可选）
@@ -682,6 +862,35 @@ interface FlowTaskDetail {
     pipeline_tree: PipelineTree;
     [key: string]: unknown;
 }
+interface CreateFlowTaskParams {
+    template_id: number;
+    name: string;
+    creator: string;
+    constants: Record<string, any>;
+    label_ids?: number[];
+    [key: string]: unknown;
+}
+interface CreateFlowTaskResult {
+    data: {
+        id: number | string;
+        template_id?: number;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+interface ExecuteFlowTaskResult {
+    result?: boolean;
+    code?: number;
+    data?: {
+        /** 任务详情页跳转地址（含正确的 bkflow task id 与 templateId） */
+        url?: string;
+        [key: string]: unknown;
+    };
+    message?: string | null;
+    request_id?: string;
+    trace_id?: string | null;
+    [key: string]: unknown;
+}
 interface TaskStateResult {
     state?: string;
     status?: string;
@@ -707,6 +916,8 @@ interface FlowViewApiConfig {
     scopeData: {
         scope_type: string;
         scope_value: number;
+        /** 业务方传入的空间 ID，调试接口专用，语义独立于 scope_value */
+        space_id: number;
     };
     fetchFlowDraftDetail?: (id: string) => Promise<FlowDraftDetail>;
     fetchFlowDetailByVersion?: (id: string, version: string) => Promise<FlowDetailByVersion>;
@@ -726,23 +937,13 @@ interface FlowViewApiConfig {
             data: any[];
         };
     }>;
-    createFlowTask?: (params: {
-        template_id: number;
-        name: string;
-        creator: string;
-        constants: Record<string, any>;
-    }) => Promise<{
-        data: {
-            id: number;
-            template_id: number;
-        };
-    }>;
+    createFlowTask?: (params: CreateFlowTaskParams) => Promise<CreateFlowTaskResult>;
     executeFlowTask?: (params: {
         task_id: number | string;
         resource_type: string;
         resource_id: number | string;
         permission_type: string;
-    }) => Promise<any>;
+    }) => Promise<ExecuteFlowTaskResult>;
     revokeFlowTask?: (params: {
         task_id: number | string;
         resource_type: string;
@@ -799,23 +1000,13 @@ interface FlowEditApiConfig extends FlowViewApiConfig {
     drawPipeline?: (params: DrawPipelineParams) => Promise<{
         pipeline_tree: PipelineTree;
     }>;
-    createFlowTask?: (params: {
-        template_id: number;
-        name: string;
-        creator: string;
-        constants: Record<string, any>;
-    }) => Promise<{
-        data: {
-            id: number;
-            template_id: number;
-        };
-    }>;
+    createFlowTask?: (params: CreateFlowTaskParams) => Promise<CreateFlowTaskResult>;
     executeFlowTask?: (params: {
         task_id: number | string;
         resource_type: string;
         resource_id: number | string;
         permission_type: string;
-    }) => Promise<any>;
+    }) => Promise<ExecuteFlowTaskResult>;
     revokeFlowTask?: (params: {
         task_id: number | string;
         resource_type: string;
@@ -835,14 +1026,16 @@ interface FlowEditApiConfig extends FlowViewApiConfig {
     fetchTaskNodeLog?: (params: FetchTaskNodeLogParams) => Promise<unknown>;
     getFlowTaskDetail?: (params: GetFlowTaskDetailParams) => Promise<FlowTaskDetail>;
 }
+interface FlowDetailApiConfig extends FlowEditApiConfig, Partial<DebugApiServices> {
+}
 
 declare const PLUGIN_GROUP_ICON_MAP: Record<string, string>;
 
 /**
  * 使用 Flow API 的 composable
- * 返回所有 API 方法，兼容 FlowEditApiConfig 接口
+ * 返回所有 API 方法，兼容 FlowDetailApiConfig 接口（含调试 API）
  */
-declare function useFlowApi(config: FlowApiConfig): FlowEditApiConfig;
+declare function useFlowApi(config: FlowApiConfig): FlowDetailApiConfig;
 
 export { PLUGIN_GROUP_ICON_MAP, useFlowApi };
-export type { CustomVariableType, EndEvent, Flow, FlowEditApiConfig, FlowListItem, FlowViewApiConfig, GatewayType, Line, Location, NodeConfigData, NodeType, NotifyConfig, PluginGroupConfig, PluginOutputItem, PortOrientation, StartEvent, TemplateConfigs, UniformApiPluginConfig, UniformApiPluginInputsItem, VariableRefRequestParams };
+export type { CustomVariableType, DebugApiServices, DebugContext, DebugContextNode, DebugContextStatus, DebugErrorDetail, DebugExecutionMode, DebugInputSchema, DebugMissingVar, DebugNodeStatus, DebugRunStatus, DebugRunType, EndEvent, Flow, FlowDetailApiConfig, FlowEditApiConfig, FlowListItem, FlowViewApiConfig, GatewayType, Line, Location, NodeConfigData, NodeType, NotifyConfig, PluginGroupConfig, PluginOutputItem, PortOrientation, StartEvent, TemplateConfigs, UniformApiPluginConfig, UniformApiPluginInputsItem, VariableRefRequestParams };

package/dist/advanced.esm.js

@@ -1,4 +1,4 @@
-import { P as s, u as _ } from "./composable-CmXOtkXh.js";
+import { P as s, u as _ } from "./composable-Cf47ka9M.js";
 export {
   s as PLUGIN_GROUP_ICON_MAP,
   _ as useFlowApi