@blueking/bkflow-canvas-editor 1.1.0-beta.43 → 1.1.0-beta.45

package/README.md

@@ -411,7 +411,8 @@ interface SelectPanelConfig {
 | `apiConfig`   | `FlowApiConfig \| FlowDetailApiConfig`        | -                                  | **必需**，API 配置对象；`canDebug=true` 时需一并提供调试方法（见下）       |
 | `permissions` | `Partial<FlowDetailPermissions>`              | `{ canEdit: false, canDebug: false, canExecute: false }` | 权限配置，**默认全部拒绝**，需显式开启                                     |
 | `onExecuteSuccess` | `(result: FlowTaskExecuteSuccessResult) => void` | - | 执行成功回调，参数与 `FlowView` 一致 |
-| `enableVersion` / `flowVersion` | `boolean` / `string`        | `false` / -                        | 流程版本功能，语义与 FlowView/FlowEdit 一致                                |
+| `enableVersion` / `flowVersion` | `boolean` / `string`        | `false` / -                        | 流程版本功能，语义与 FlowView/FlowEdit 一致；`flowVersion` 支持 `v-model`  |
+| `enableVersionManagement` | `boolean`                           | `false`                            | 是否启用版本管理 UI（版本选择器 + 版本历史 + 发布 + 回滚），见下           |
 | `defaultZoom` / `quickAdd` / `hideTrigger` / `bkflowSaasUrl` | 同 FlowEdit | -                       | 透传给内部画布与信息侧滑                                                   |
 
 #### Events
@@ -422,6 +423,7 @@ interface SelectPanelConfig {
 | `saveSuccess` | -                        | 显式保存成功后触发         |
 | `back`        | -                        | 返回按钮点击时触发         |
 | `createVariable` | `{ keyword, cursorIndex }` | 请求新建全局变量时触发 |
+| `update:flowVersion` | `version: string \| undefined` | 内部切换查看版本时触发；`undefined` 表示回到草稿。宿主可用 `v-model:flowVersion` 同步 URL，也可以不接 |
 
 #### Slots
 
@@ -462,7 +464,22 @@ interface SelectPanelConfig {
 - **单节点 Mock**：配置 Mock 输出结果后执行（内部顺序：保存 Mock → 单步执行 mock）；执行时跳过该节点并以 Mock 输出替代实际输出，Mock 节点在后续全流程中保留 `MOCK` 标签。
 - **取消 Mock**：清除节点的持久 Mock 配置。
 - **终止**：全流程终止不传 `node_id`；单步调试进入运行/等待态时，传当前 `active_node_id` 终止该节点。
-- **保存联动**：`canDebug` 且 `context` 空闲时，保存成功后会查询 `reset_impact` 并自动清理失效节点的调试结果。
+- **保存联动**：`canDebug` 时保存成功后刷新 `debug_context`；最后一次 `debug_snapshot` 会保留，直接修改或删除的节点分别由 `config_changed` / `node_deleted` 标记为已失效。
+
+#### 版本管理（`enableVersionManagement=true`）
+
+开启后头部流程名右侧出现版本选择器，头部图标区新增「版本历史」入口。草稿态右侧操作区依次展示主按钮「发布」和浅蓝次按钮「暂存草稿」，不展示「执行流程」；历史版本只读态只展示「执行流程」。
+
+- **数据加载**：`enableVersionManagement=true` 隐含 `enableVersion` 的语义，消费方只需传这一个。查看的版本由组件内部持有，初值取 `flowVersion`。
+- **草稿切换**：版本下拉首项固定为「草稿」；`flowVersion` 为空时默认选中草稿，选中该项可从历史版本预览切回当前草稿。
+- **查看历史版本**：选中历史版本后画布转为只读预览（走 `preview_task_tree`），不展示保存与发布，**调试域整体不挂载** —— 后端调试端点只读 DB 里的草稿，在历史版本视图下调试会跑在草稿上，结果与画面不符。
+- **草稿自动保存**：完整版本管理开启后，画布结构/配置、节点配置、全局变量和基础信息的编辑结果会按顺序自动保存全量流程；保存草稿不做完整性校验，允许暂存未完成流程。
+- **发布上线**：发布前会全量校验并确保草稿已落库（后端 `release_template` 转正的是 DB 里的 draft 行，不接受请求体里的 pipeline）。发布成功后刷新版本列表，并从新发布版本初始化草稿。版本号默认取 `calculate_version` 的建议值，失败原因内联展示在版本号字段上并保留输入。
+- **加载至草稿**：入口仅在版本历史条目 hover 中展示，二次确认后用所选历史版本覆盖当前草稿，随后回到草稿态重载。
+- **权限**：发布与回滚都收敛到 `permissions.canEdit`，不引入额外权限位；调试运行中（`debugLocked`）全部禁用。
+- **空间开关**：组件无法自检空间的 `flow_versioning` 配置（后端 `get_space_related_configs` 不返回该字段），由消费方保证只在已开启版本管理的空间传 `true`。
+
+`enableVersionManagement=true` 且消费方传入完整 api 配置对象时，需一并提供 `fetchFlowVersionList`、`calculateNextFlowVersion`、`releaseFlowVersion`、`rollbackFlowVersion`（签名见 `FlowVersionApiServices`）。走内置 `useFlowApi()` 时自动获得。
 
 #### 调试 API 契约（`canDebug=true` 必需）
 
@@ -1402,6 +1419,46 @@ resolve: {
     - FlowEdit 会自动将版本相关 props 透传给内嵌的 FlowDebug 组件
     - 版本功能依赖 `fetchFlowDraftDetail` 和 `fetchFlowDetailByVersion` 两个 API 方法
 
+## 国际化
+
+包内自带 `zh-cn` 与 `en` 词条，默认 `zh-cn`。宿主在挂载前调用一次 `setLocale` 即可：
+
+```typescript
+import { setLocale } from '@blueking/bkflow-canvas-editor';
+
+setLocale('en');
+```
+
+语言是进程级全局状态，切换后需由宿主刷新页面；不支持同一页面内两个画布实例使用不同语言。
+
+组件库（bkui-vue / element-plus）的文案由包内自动联动，宿主无需在 `app.use(bkui)` 时额外配置。
+
+`setLocale` 只管前端文案。**后端下发的内容（插件名称、插件表单 schema 标签、接口报错）
+不受它影响**——bkflow 后端按 `blueking_language` Cookie（`zh-cn` / `en`）判定语言，
+不读 `Accept-Language` 请求头，宿主需自行设置该 Cookie。
+
+locale 非 `zh-cn` 时本包会改写 bkui-vue 的 `defaultRootConfig.locale` 以覆盖命令式
+`Message` / `InfoBox`，**影响范围是整个宿主应用**。详见
+[docs/usage.md 的国际化章节](./docs/usage.md#国际化)。
+
+进阶用法：
+
+| API | 用途 |
+| --- | --- |
+| `registerMessages(locale, messages, options?)` | 深合并覆盖个别词条，或注册包内没有的新语言 |
+| `setTranslator(fn)` | 完全接管翻译，桥接宿主已有的 i18n；返回 `undefined` 时回落包内词条 |
+| `getLocale()` | 读取当前语言 |
+
+注册新语言时可一并提供 bkui-vue 语言包：
+
+```typescript
+import { registerMessages } from '@blueking/bkflow-canvas-editor';
+import jaMessages from './ja';
+import { jp } from 'bkui-vue/lib/locale';
+
+registerMessages('ja', jaMessages, { bkuiLocale: jp });
+```
+
 ## License
 
 MIT

package/dist/advanced.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./context-iqnF_HqS.cjs");exports.PLUGIN_GROUP_ICON_MAP=e.PLUGIN_GROUP_ICON_MAP;exports.SOPS_PLUGIN_GROUP_NAME=e.SOPS_PLUGIN_GROUP_NAME;exports.provideVariableInputCreateVariable=e.provideVariableInputCreateVariable;exports.resolveSopsPluginSources=e.resolveSopsPluginSources;exports.useFlowApi=e.useFlowApi;exports.useVariableInputCreateVariable=e.useVariableInputCreateVariable;exports.withSopsPluginGroup=e.withSopsPluginGroup;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./context-bUpcrt8M.cjs");exports.PLUGIN_GROUP_ICON_MAP=e.PLUGIN_GROUP_ICON_MAP;exports.SOPS_PLUGIN_GROUP_NAME=e.SOPS_PLUGIN_GROUP_NAME;exports.provideVariableInputCreateVariable=e.provideVariableInputCreateVariable;exports.resolveSopsPluginSources=e.resolveSopsPluginSources;exports.useFlowApi=e.useFlowApi;exports.useVariableInputCreateVariable=e.useVariableInputCreateVariable;exports.withSopsPluginGroup=e.withSopsPluginGroup;

package/dist/advanced.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
 
-type NodeExecutionStatus = 'CREATED' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'SUSPENDED' | 'REVOKED' | 'SKIP';
+type NodeExecutionStatus = 'CREATED' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'SUSPENDED' | 'REVOKED' | 'INVALID' | 'SKIP';
 type ExecutionNodeAction = 'retry' | 'skip' | 'resume' | 'approve' | 'forceFail' | 'gatewaySkip';
 interface NodeExecutionState {
     status: NodeExecutionStatus;
@@ -816,9 +816,13 @@ interface DebugConditionResult {
 }
 interface DebugContextNode {
     node_id: string;
+    /** 节点显示名称；后端逐步补齐，旧版本可能缺失。 */
+    node_name?: string;
     node_type: string;
     execution_mode: DebugExecutionMode;
     status: DebugNodeStatus;
+    /** 节点配置变更后，已有调试结果是否失效。 */
+    config_changed?: boolean;
     can_step: boolean;
     missing_vars: DebugMissingVar[];
     waiting_reason?: string | null;
@@ -842,6 +846,26 @@ interface DebugContextNode {
     /** 条件网关每个分支的表达式与命中结果。 */
     condition_results?: DebugConditionResult[];
 }
+interface DebugSnapshotNode {
+    node_id: string;
+    node_name: string;
+    node_type: string;
+    execution_mode: DebugExecutionMode;
+    status: DebugNodeStatus;
+    waiting_reason?: string | null;
+    inputs: Record<string, unknown>;
+    outputs: Record<string, unknown>;
+    duration_ms?: number | null;
+    error_detail?: DebugErrorDetail | string | null;
+    log_ref?: DebugContextNode['log_ref'];
+    operator: string;
+    last_run_at?: string | null;
+    config_changed: boolean;
+    node_deleted: boolean;
+}
+interface DebugSnapshot {
+    nodes: DebugSnapshotNode[];
+}
 /**
  * /debug_context/ 顶层结构。
  *
@@ -865,6 +889,7 @@ interface DebugContext {
     global_vars: Record<string, unknown>;
     missing_vars?: DebugMissingVar[];
     nodes: DebugContextNode[];
+    debug_snapshot: DebugSnapshot | null;
 }
 interface DebugInputSchemaField {
     key: string;
@@ -961,6 +986,45 @@ interface DebugApiServices {
     resetDebugResult(params: ResetDebugResultParams): Promise<DebugResetResult>;
 }
 
+/** 版本列表条目。列表接口不返回 pipeline_tree，取流程内容要走 preview_task_tree。 */
+interface FlowVersionSnapshot {
+    id: number;
+    template_id: number;
+    /** 草稿行为 null；已发布行为 semver 字符串 */
+    version: string | null;
+    desc: string | null;
+    draft: boolean;
+    creator: string;
+    operator: string;
+    /** pipeline 内容指纹 */
+    md5sum: string;
+    create_time: string;
+    update_time: string;
+}
+interface FlowVersionListResult {
+    count: number;
+    results: FlowVersionSnapshot[];
+}
+interface ReleaseFlowVersionParams {
+    version: string;
+    desc?: string;
+}
+interface RollbackFlowVersionParams {
+    version: string;
+}
+interface FlowVersionApiServices {
+    /** 版本列表。固定以 limit=-1 请求全量，不做分页 UI */
+    fetchFlowVersionList: (templateId: string) => Promise<FlowVersionListResult>;
+    /** 计算下一个建议版本号。基于当前线上版本 bump，无历史版本时返回 1.0.0 */
+    calculateNextFlowVersion: (templateId: string) => Promise<{
+        version: string;
+    }>;
+    /** 发布上线。作用于 DB 里的草稿行，调用前必须确保草稿已落库 */
+    releaseFlowVersion: (templateId: string, params: ReleaseFlowVersionParams) => Promise<FlowTemplate>;
+    /** 把历史版本加载至草稿，会覆盖当前草稿内容 */
+    rollbackFlowVersion: (templateId: string, params: RollbackFlowVersionParams) => Promise<unknown>;
+}
+
 /**
  * Flow API 配置接口
  */
@@ -1071,6 +1135,8 @@ interface FlowTaskDetail {
     id: number | string;
     template_id: number;
     pipeline_tree: PipelineTree;
+    /** 调试任务执行人。 */
+    executor?: string;
     /** 任务已耗时（秒），调试摘要弹层刷新恢复用。 */
     elapsed_time?: number;
     [key: string]: unknown;
@@ -1242,7 +1308,7 @@ interface FlowEditApiConfig extends FlowViewApiConfig {
     fetchTaskNodeLog?: (params: FetchTaskNodeLogParams) => Promise<unknown>;
     getFlowTaskDetail?: (params: GetFlowTaskDetailParams) => Promise<FlowTaskDetail>;
 }
-interface FlowDetailApiConfig extends FlowEditApiConfig, Partial<DebugApiServices> {
+interface FlowDetailApiConfig extends FlowEditApiConfig, Partial<DebugApiServices>, Partial<FlowVersionApiServices> {
 }
 
 declare const SOPS_PLUGIN_GROUP_NAME = "sops";
@@ -1276,4 +1342,4 @@ declare const provideVariableInputCreateVariable: (handler: VariableInputCreateV
 declare const useVariableInputCreateVariable: () => VariableInputCreateVariableHandler | null;
 
 export { PLUGIN_GROUP_ICON_MAP, SOPS_PLUGIN_GROUP_NAME, provideVariableInputCreateVariable, resolveSopsPluginSources, useFlowApi, useVariableInputCreateVariable, withSopsPluginGroup };
-export type { CreateVariablePayload, CreateVariableRequest, CustomVariableType, DebugApiServices, DebugConditionResult, 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, SelectRelatedSourceContext, SopsPluginCategory, SopsPluginCategoryParams, SopsPluginDetail, SopsPluginDetailParams, SopsPluginFormDescriptor, SopsPluginItem, SopsPluginListParams, SopsPluginListResult, SopsPluginSourceItem, SpaceUniformApiEntry, StartEvent, TemplateConfigs, UniformApiPluginConfig, UniformApiPluginInputsItem, VariableInputCreateVariableHandler, VariableOption, VariableRefRequestParams };
+export type { CreateVariablePayload, CreateVariableRequest, CustomVariableType, DebugApiServices, DebugConditionResult, DebugContext, DebugContextNode, DebugContextStatus, DebugErrorDetail, DebugExecutionMode, DebugInputSchema, DebugMissingVar, DebugNodeStatus, DebugRunStatus, DebugRunType, DebugSnapshot, DebugSnapshotNode, EndEvent, Flow, FlowDetailApiConfig, FlowEditApiConfig, FlowListItem, FlowVersionApiServices, FlowVersionListResult, FlowVersionSnapshot, FlowViewApiConfig, GatewayType, Line, Location, NodeConfigData, NodeType, NotifyConfig, PluginGroupConfig, PluginOutputItem, PortOrientation, ReleaseFlowVersionParams, RollbackFlowVersionParams, SelectRelatedSourceContext, SopsPluginCategory, SopsPluginCategoryParams, SopsPluginDetail, SopsPluginDetailParams, SopsPluginFormDescriptor, SopsPluginItem, SopsPluginListParams, SopsPluginListResult, SopsPluginSourceItem, SpaceUniformApiEntry, StartEvent, TemplateConfigs, UniformApiPluginConfig, UniformApiPluginInputsItem, VariableInputCreateVariableHandler, VariableOption, VariableRefRequestParams };

package/dist/advanced.esm.js

@@ -1,4 +1,4 @@
-import { P as r, S as s, p as i, r as o, u as p, a as u, w as P } from "./context-Bg6nsbrK.js";
+import { P as r, S as s, p as i, r as o, u as p, a as u, w as P } from "./context-Bu4mmo1Q.js";
 export {
   r as PLUGIN_GROUP_ICON_MAP,
   s as SOPS_PLUGIN_GROUP_NAME,

package/dist/bkflow-canvas-editor_false-B70uLuHL.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={};throw new Error('Could not resolve "@blueking/bk-user-selector/vue3/vue3.css" imported by "@blueking/bkflow-canvas-editor".');exports.default=e;

package/dist/bkflow-canvas-editor_false-BlC281Zg.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={};throw new Error('Could not resolve "@blueking/bk-user-selector" imported by "@blueking/bkflow-canvas-editor".');exports.default=e;

package/dist/bkflow-canvas-editor_false-Casww7p4.js

@@ -0,0 +1,5 @@
+const e = {};
+throw new Error('Could not resolve "@blueking/bk-user-selector/vue3/vue3.css" imported by "@blueking/bkflow-canvas-editor".');
+export {
+  e as default
+};

package/dist/bkflow-canvas-editor_false-i9G8sqQi.js

@@ -0,0 +1,5 @@
+const e = {};
+throw new Error('Could not resolve "@blueking/bk-user-selector" imported by "@blueking/bkflow-canvas-editor".');
+export {
+  e as default
+};