@blueking/bkflow-canvas-editor 1.1.0-beta.2 → 1.1.0-beta.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +171 -41
- package/dist/advanced.cjs.js +1 -1
- package/dist/advanced.d.ts +232 -34
- package/dist/advanced.esm.js +5 -3
- package/dist/bkflow-canvas-editor_false-B70uLuHL.cjs +1 -0
- package/dist/bkflow-canvas-editor_false-BlC281Zg.cjs +1 -0
- package/dist/bkflow-canvas-editor_false-Casww7p4.js +5 -0
- package/dist/bkflow-canvas-editor_false-i9G8sqQi.js +5 -0
- package/dist/{composable-gqC5C2k8.js → context-DFzO6khC.js} +409 -245
- package/dist/context-NG3ocAZ9.cjs +1 -0
- package/dist/index-02hL8tEC.cjs +1 -0
- package/dist/index-B8efFF5D.cjs +1 -0
- package/dist/index-BWndXizJ.js +512 -0
- package/dist/index-BhHHxbEL.js +235 -0
- package/dist/index-Bs2CwzmL.cjs +1 -0
- package/dist/index-DUOfuLCl.js +50713 -0
- package/dist/index-GYfLO_6L.js +163 -0
- package/dist/index-j9vPPW5D.cjs +70 -0
- package/dist/index.cjs.js +1 -70
- package/dist/index.d.ts +631 -91
- package/dist/index.esm.js +39 -46100
- package/dist/style.css +1 -1
- package/dist/style.d.ts +2 -0
- package/package.json +12 -7
- package/dist/composable-B_bR5Gic.cjs +0 -1
- package/dist/index.es.min-BBOgAuB2.js +0 -3214
- package/dist/index.es.min-DQIH7mAl.cjs +0 -2
package/README.md
CHANGED
|
@@ -5,9 +5,11 @@ bkflow流程编辑组件，支持流程的编辑、查看、调试以及创建
|
|
|
5
5
|
## 安装
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @blueking/bkflow-canvas-editor
|
|
8
|
+
npm install @blueking/bkflow-canvas-editor @blueking/flow-canvas
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
`@blueking/flow-canvas` 是精确版本的 peerDependency，须与 editor 声明的版本一致；JS/CSS 均不打进 editor 产物。
|
|
12
|
+
|
|
11
13
|
## 使用
|
|
12
14
|
|
|
13
15
|
### 基础使用
|
|
@@ -24,6 +26,7 @@ npm install @blueking/bkflow-canvas-editor
|
|
|
24
26
|
|
|
25
27
|
<script setup>
|
|
26
28
|
import { FlowView } from 'bkflow-canvas-editor';
|
|
29
|
+
import '@blueking/flow-canvas/style';
|
|
27
30
|
import 'bkflow-canvas-editor/style';
|
|
28
31
|
import axios from 'axios';
|
|
29
32
|
|
|
@@ -35,6 +38,7 @@ npm install @blueking/bkflow-canvas-editor
|
|
|
35
38
|
scopeData: {
|
|
36
39
|
scope_type: 'space',
|
|
37
40
|
scope_value: 123,
|
|
41
|
+
space_id: 123,
|
|
38
42
|
}, // 作用域数据（必需）
|
|
39
43
|
fetchUserApi: `${window.BK_COMPONENT_API_URL}/api/c/compapi/v2/usermanage/fs_list_users/`, // @deprecated 仅保留向后兼容，推荐使用 memberSelectorConfig
|
|
40
44
|
// 可选：使用自定义 axios 实例
|
|
@@ -80,27 +84,29 @@ npm install @blueking/bkflow-canvas-editor
|
|
|
80
84
|
|
|
81
85
|
#### Props
|
|
82
86
|
|
|
83
|
-
| 参数 | 类型
|
|
84
|
-
| ------------------- |
|
|
85
|
-
| `flowId` | `string`
|
|
86
|
-
| `apiConfig` | `FlowApiConfig`
|
|
87
|
-
| `permissions` | `{ canEdit?: boolean }`
|
|
88
|
-
| `thumbnail` | `boolean`
|
|
89
|
-
| `enableVersion` | `boolean`
|
|
90
|
-
| `flowVersion` | `string`
|
|
91
|
-
| `showHeaderActions` | `boolean`
|
|
92
|
-
| `defaultZoom` | `number`
|
|
93
|
-
| `bkflowSaasUrl` | `string`
|
|
94
|
-
| `
|
|
95
|
-
| `
|
|
96
|
-
| `
|
|
87
|
+
| 参数 | 类型 | 默认值 | 说明 |
|
|
88
|
+
| ------------------- | ------------------------------------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
89
|
+
| `flowId` | `string` | - | **必需**，流程 ID |
|
|
90
|
+
| `apiConfig` | `FlowApiConfig` | - | **必需**，API 配置对象，详见 [API 配置](#api-配置) |
|
|
91
|
+
| `permissions` | `{ canEdit?: boolean }` | `{ canEdit: true }` | 权限配置对象，`canEdit` 控制头部编辑按钮是否使用禁用样式 |
|
|
92
|
+
| `thumbnail` | `boolean` | `false` | 小地图模式，启用后只显示画布内容，不显示顶部 header 和操作按钮，禁用节点点击事件 |
|
|
93
|
+
| `enableVersion` | `boolean` | `false` | 是否开启流程版本功能，开启后会根据 `flowVersion` 的值获取对应版本的流程数据 |
|
|
94
|
+
| `flowVersion` | `string` | - | 流程版本号，仅在 `enableVersion` 为 `true` 时生效。为空时表示草稿版本，不为空时表示指定版本 |
|
|
95
|
+
| `showHeaderActions` | `boolean` | `true` | 是否显示头部操作按钮（编辑、执行流程、调试），仅在非小地图模式下生效 |
|
|
96
|
+
| `defaultZoom` | `number` | `1` | x6 画布的默认缩放比例，用于控制画布的初始显示效果。取值范围建议在 0.25 到 1.5 之间 |
|
|
97
|
+
| `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
|
|
98
|
+
| `hideTrigger` | `boolean` | `false` | 是否隐藏基础信息中的触发器配置表单 |
|
|
99
|
+
| `onEdit` | `() => void` | - | 编辑按钮点击回调（可选，也可以通过 `@edit` 事件监听） |
|
|
100
|
+
| `onBack` | `() => void` | - | 返回按钮点击回调（可选，也可以通过 `@back` 事件监听） |
|
|
101
|
+
| `onExecuteSuccess` | `(result: FlowTaskExecuteSuccessResult) => void` | - | 执行成功回调（可选），参数含 `createResult`(create_task) 与 `executeResult`(operate_task)，用 `executeResult.data.url` 跳转 |
|
|
97
102
|
|
|
98
103
|
#### Slots
|
|
99
104
|
|
|
100
|
-
| 插槽名
|
|
101
|
-
|
|
|
102
|
-
| `header`
|
|
103
|
-
| `inputParams`
|
|
105
|
+
| 插槽名 | 作用域参数 | 说明 |
|
|
106
|
+
| ------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
107
|
+
| `header` | - | 自定义头部内容 |
|
|
108
|
+
| `inputParams` | 见下方说明 | 自定义节点输入参数组件 |
|
|
109
|
+
| `customFormContent` | `customFormData`、`additionalTaskParams`、`updateCustomFormData`、`updateAdditionalTaskParams` | 创建任务侧滑自定义额外表单项；`additionalTaskParams` 会合并进创建请求 |
|
|
104
110
|
|
|
105
111
|
##### inputParams 插槽作用域参数
|
|
106
112
|
|
|
@@ -146,7 +152,8 @@ npm install @blueking/bkflow-canvas-editor
|
|
|
146
152
|
| `defaultZoom` | `number` | `1` | x6 画布的默认缩放比例，用于控制画布的初始显示效果。取值范围建议在 0.25 到 1.5 之间 |
|
|
147
153
|
| `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
|
|
148
154
|
| `enableThirdPlugin` | `boolean` | `true` | 是否启用第三方插件。设置为 `false` 时，将不加载第三方插件列表和详情，只显示内置插件 |
|
|
149
|
-
| `quickAdd` | `QuickAddConfig
|
|
155
|
+
| `quickAdd` | `QuickAddConfig`（来自 `@blueking/flow-canvas`） | - | 透传给底层画布的 quick-add 配置；默认启用，可自定义绑定端口、插入方向或显式关闭 |
|
|
156
|
+
| `hideTrigger` | `boolean` | `false` | 是否隐藏基础信息中的触发器配置表单 |
|
|
150
157
|
|
|
151
158
|
#### Slots
|
|
152
159
|
|
|
@@ -192,6 +199,10 @@ npm install @blueking/bkflow-canvas-editor
|
|
|
192
199
|
| ----------------------- | -------------------------------------------------- | ---------------------- | ---------------------------------------------------------- |
|
|
193
200
|
| `updateNodeInputParams` | `inputParams: Record<string, PluginInputDataItem>` | `void` | 更新当前打开节点的输入参数（暂存，需点击确定按钮才会保存） |
|
|
194
201
|
| `isFlowEdited` | - | `ComputedRef<boolean>` | 流程是否已编辑（只读） |
|
|
202
|
+
| `openGlobalVariables` | - | `void` | 打开全局变量面板 |
|
|
203
|
+
| `zoomToFit` | `options?: ZoomToFitOptions` | `void` | 自适应画布视口 |
|
|
204
|
+
| `centerContent` | - | `void` | 居中画布内容 |
|
|
205
|
+
| `getZoom` | - | `number` | 获取当前缩放比例 |
|
|
195
206
|
|
|
196
207
|
---
|
|
197
208
|
|
|
@@ -240,25 +251,31 @@ interface SelectPanelConfig {
|
|
|
240
251
|
|
|
241
252
|
#### Props
|
|
242
253
|
|
|
243
|
-
| 参数 | 类型
|
|
244
|
-
| ------------------ |
|
|
245
|
-
| `flowId` | `string`
|
|
246
|
-
| `show` | `boolean`
|
|
247
|
-
| `apiConfig` | `FlowApiConfig`
|
|
248
|
-
| `editable` | `boolean`
|
|
249
|
-
| `showFlowEntry` | `boolean`
|
|
250
|
-
| `bkflowSaasUrl` | `string`
|
|
251
|
-
| `onExecuteSuccess` | `(
|
|
254
|
+
| 参数 | 类型 | 默认值 | 说明 |
|
|
255
|
+
| ------------------ | ------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
256
|
+
| `flowId` | `string` | - | **必需**，流程 ID |
|
|
257
|
+
| `show` | `boolean` | - | **必需**，是否显示执行面板 |
|
|
258
|
+
| `apiConfig` | `FlowApiConfig` | - | **必需**，API 配置对象，详见 [API 配置](#api-配置) |
|
|
259
|
+
| `editable` | `boolean` | `true` | 是否可编辑 |
|
|
260
|
+
| `showFlowEntry` | `boolean` | `false` | 是否显示流程入口 |
|
|
261
|
+
| `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
|
|
262
|
+
| `onExecuteSuccess` | `(result: FlowTaskExecuteSuccessResult) => void` | - | 执行成功回调，参数含 `createResult`(create_task) 与 `executeResult`(operate_task)，用 `executeResult.data.url` 跳转 |
|
|
263
|
+
|
|
264
|
+
#### Slots
|
|
265
|
+
|
|
266
|
+
| 插槽名 | Slot Props | 说明 |
|
|
267
|
+
| ------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
268
|
+
| `customFormContent` | `customFormData`、`additionalTaskParams`、`updateCustomFormData`、`updateAdditionalTaskParams` | 自定义额外表单项；`additionalTaskParams` 会合并进 `createFlowTask` |
|
|
252
269
|
|
|
253
270
|
#### Events
|
|
254
271
|
|
|
255
|
-
| 事件名 | 参数
|
|
256
|
-
| -------------- |
|
|
257
|
-
| `confirm` | `
|
|
258
|
-
| `close` | -
|
|
259
|
-
| `update:show` | `show: boolean`
|
|
260
|
-
| `before-close` | -
|
|
261
|
-
| `view-flow` | -
|
|
272
|
+
| 事件名 | 参数 | 说明 |
|
|
273
|
+
| -------------- | -------------------------------------- | ------------------------ |
|
|
274
|
+
| `confirm` | `result: FlowTaskExecuteSuccessResult` | 执行确认时触发 |
|
|
275
|
+
| `close` | - | 关闭面板时触发 |
|
|
276
|
+
| `update:show` | `show: boolean` | 显示状态更新时触发 |
|
|
277
|
+
| `before-close` | - | 面板关闭前触发 |
|
|
278
|
+
| `view-flow` | - | 点击查看排障流程按钮触发 |
|
|
262
279
|
|
|
263
280
|
---
|
|
264
281
|
|
|
@@ -340,6 +357,95 @@ interface SelectPanelConfig {
|
|
|
340
357
|
|
|
341
358
|
---
|
|
342
359
|
|
|
360
|
+
### FlowDetail 组件
|
|
361
|
+
|
|
362
|
+
统一的流程详情组件，将「查看 / 编辑 / 调试」收敛到一个入口，通过 `permissions` 精确控制能力。推荐新接入方使用 `FlowDetail` 替代 `FlowMockDebug`。
|
|
363
|
+
|
|
364
|
+
> `FlowDetail` 仅支持 Vue 3。`FlowEdit` / `FlowView` 的既有行为、Props/Emits 不受影响，可继续使用。
|
|
365
|
+
|
|
366
|
+
#### 安装与基础示例
|
|
367
|
+
|
|
368
|
+
```vue
|
|
369
|
+
<template>
|
|
370
|
+
<FlowDetail
|
|
371
|
+
:flow-id="flowId"
|
|
372
|
+
:api-config="apiConfig"
|
|
373
|
+
:permissions="{ canEdit: true, canDebug: true, canExecute: true }"
|
|
374
|
+
@save="handleSave"
|
|
375
|
+
@back="handleBack" />
|
|
376
|
+
</template>
|
|
377
|
+
|
|
378
|
+
<script setup>
|
|
379
|
+
import { FlowDetail } from '@blueking/bkflow-canvas-editor';
|
|
380
|
+
import '@blueking/flow-canvas/style';
|
|
381
|
+
import '@blueking/bkflow-canvas-editor/style';
|
|
382
|
+
|
|
383
|
+
const flowId = '2085';
|
|
384
|
+
const apiConfig = {
|
|
385
|
+
scopeData: { scope_type: 'space', scope_value: 171, space_id: 171 },
|
|
386
|
+
};
|
|
387
|
+
</script>
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
#### Props
|
|
391
|
+
|
|
392
|
+
| 参数 | 类型 | 默认值 | 说明 |
|
|
393
|
+
| ------------- | --------------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------- |
|
|
394
|
+
| `flowId` | `string` | - | **必需**，流程 ID |
|
|
395
|
+
| `apiConfig` | `FlowApiConfig \| FlowDetailApiConfig` | - | **必需**，API 配置对象；`canDebug=true` 时需一并提供调试方法（见下） |
|
|
396
|
+
| `permissions` | `Partial<FlowDetailPermissions>` | `{ canEdit: false, canDebug: false, canExecute: false }` | 权限配置，**默认全部拒绝**，需显式开启 |
|
|
397
|
+
| `onExecuteSuccess` | `(result: FlowTaskExecuteSuccessResult) => void` | - | 执行成功回调，参数与 `FlowView` 一致 |
|
|
398
|
+
| `enableVersion` / `flowVersion` | `boolean` / `string` | `false` / - | 流程版本功能，语义与 FlowView/FlowEdit 一致 |
|
|
399
|
+
| `defaultZoom` / `quickAdd` / `hideTrigger` / `bkflowSaasUrl` | 同 FlowEdit | - | 透传给内部画布与信息侧滑 |
|
|
400
|
+
|
|
401
|
+
#### Events
|
|
402
|
+
|
|
403
|
+
| 事件名 | 参数 | 说明 |
|
|
404
|
+
| ------------- | ------------------------ | -------------------------- |
|
|
405
|
+
| `save` | `flowData: FlowTemplate` | 显式保存成功后触发 |
|
|
406
|
+
| `saveSuccess` | - | 显式保存成功后触发 |
|
|
407
|
+
| `back` | - | 返回按钮点击时触发 |
|
|
408
|
+
| `createVariable` | `{ keyword, cursorIndex }` | 请求新建全局变量时触发 |
|
|
409
|
+
|
|
410
|
+
#### 权限矩阵
|
|
411
|
+
|
|
412
|
+
`permissions` 默认拒绝，四种组合如下：
|
|
413
|
+
|
|
414
|
+
| `canEdit` | `canDebug` | 效果 |
|
|
415
|
+
| --------- | ---------- | ---------------------------------------------------------- |
|
|
416
|
+
| `false` | `false` | 纯只读查看，无保存、无调试入口，且**不请求任何调试接口** |
|
|
417
|
+
| `true` | `false` | 可编辑与保存，无调试入口 |
|
|
418
|
+
| `false` | `true` | 只读画布 + 全流程/单节点调试（调试期间流程本就不可编辑） |
|
|
419
|
+
| `true` | `true` | 可编辑、保存与完整调试；调试运行中锁定编辑（画布转 `view`）|
|
|
420
|
+
|
|
421
|
+
`permissions.canExecute` 独立控制头部“执行流程”按钮。流程存在未保存修改时，确认保存成功后才会打开创建任务侧滑；`customFormContent` 插槽与 `FlowView` 一致。
|
|
422
|
+
|
|
423
|
+
#### 调试能力
|
|
424
|
+
|
|
425
|
+
- **全流程调试**：头部调试入口填写全局输入后启动，前端按 2500ms（失败退避 5000ms）轮询 `/context/`，可随时终止。
|
|
426
|
+
- **单节点 real**：节点详情「调试配置」Tab 内直接以真实逻辑同步执行单步，完成后刷新 `context`。
|
|
427
|
+
- **单节点 Mock**：配置 Mock 输出结果后执行（内部顺序：保存 Mock → 单步执行 mock）；执行时跳过该节点并以 Mock 输出替代实际输出，Mock 节点在后续全流程中保留 `MOCK` 标签。
|
|
428
|
+
- **取消 Mock**：清除节点的持久 Mock 配置。
|
|
429
|
+
- **终止**：全流程终止不传 `node_id`；单步调试进入运行/等待态时，传当前 `active_node_id` 终止该节点。
|
|
430
|
+
- **保存联动**：`canDebug` 且 `context` 空闲时，保存成功后会查询 `reset_impact` 并自动清理失效节点的调试结果。
|
|
431
|
+
|
|
432
|
+
#### 调试 API 契约（`canDebug=true` 必需）
|
|
433
|
+
|
|
434
|
+
消费方若传入完整的 api 配置对象（而非仅 `scopeData`），当 `canDebug=true` 时**必须**一并提供以下调试方法，组件初始化时会统一校验：
|
|
435
|
+
|
|
436
|
+
`fetchDebugContext`、`fetchDebugInputSchema`、`fetchDebugResetImpact`、`updateNodeDebugMock`、`runNodeDebugStep`、`runGlobalDebug`、`terminateDebug`、`resetDebugResult`（签名见 `DebugApiServices`）。
|
|
437
|
+
|
|
438
|
+
约定：
|
|
439
|
+
|
|
440
|
+
- 前端以 `debug_context`（后端 `build_context_view`）为**唯一事实源**，不新增 `node_input_values` 接口。`active_*`（当前持锁任务）与 `last_*`（最近一次运行）按顶层 `status` 分支选用。
|
|
441
|
+
- 建议后端在 `debug_context` 透出 `mock_outputs` / `mock_error` / `outputs`，否则刷新后 Mock 输出与「输出结果/重新编辑」回填会缺数据。
|
|
442
|
+
- 调试接口与普通接口同源：走后端 python 包 bkflow_sdk `TemplateViewSet` 的 `/bkflow/template/debug_*`，全站信封 `{result, data, message}`。走内置 `useFlowApi()` 时自动获得全部调试方法。
|
|
443
|
+
- 调试与普通接口共用同一 ApiClient：只在客户端边界解信封，并统一抛出 `ApiError`。调试请求的 `delegate` 仅转交 Message 呈现权，service/controller/page 不再重复解包或改造错误。
|
|
444
|
+
|
|
445
|
+
> **Deprecated**：`FlowMockDebug` 已废弃，请改用 `FlowDetail` 并开启 `permissions.canDebug`。`FlowMockDebug` 将在下个大版本移除。
|
|
446
|
+
|
|
447
|
+
---
|
|
448
|
+
|
|
343
449
|
## 使用示例
|
|
344
450
|
|
|
345
451
|
### 基础使用
|
|
@@ -364,6 +470,7 @@ interface SelectPanelConfig {
|
|
|
364
470
|
scopeData: {
|
|
365
471
|
scope_type: 'space',
|
|
366
472
|
scope_value: 123,
|
|
473
|
+
space_id: 123,
|
|
367
474
|
},
|
|
368
475
|
};
|
|
369
476
|
|
|
@@ -427,6 +534,7 @@ interface SelectPanelConfig {
|
|
|
427
534
|
scopeData: {
|
|
428
535
|
scope_type: "space",
|
|
429
536
|
scope_value: 123,
|
|
537
|
+
space_id: 123,
|
|
430
538
|
},
|
|
431
539
|
};
|
|
432
540
|
|
|
@@ -459,11 +567,14 @@ interface SelectPanelConfig {
|
|
|
459
567
|
scopeData: {
|
|
460
568
|
scope_type: 'space',
|
|
461
569
|
scope_value: 123,
|
|
570
|
+
space_id: 123,
|
|
462
571
|
},
|
|
463
572
|
};
|
|
464
573
|
</script>
|
|
465
574
|
```
|
|
466
575
|
|
|
576
|
+
外部 Axios 实例仍会通过组件的统一 ApiClient 边界，因此无论宿主拦截器返回 `AxiosResponse`、信封 body 或已解包 DTO，组件内部都获得业务 DTO。建议宿主拦截器不要再对 `{ result: false }` 弹业务 Message，否则无法保证跨边界的单次呈现。
|
|
577
|
+
|
|
467
578
|
### 监听流程编辑状态
|
|
468
579
|
|
|
469
580
|
```vue
|
|
@@ -514,6 +625,7 @@ interface SelectPanelConfig {
|
|
|
514
625
|
|
|
515
626
|
<script setup>
|
|
516
627
|
import { FlowView } from 'bkflow-canvas-editor';
|
|
628
|
+
import '@blueking/flow-canvas/style';
|
|
517
629
|
import 'bkflow-canvas-editor/style';
|
|
518
630
|
|
|
519
631
|
const flowId = '123';
|
|
@@ -521,6 +633,7 @@ interface SelectPanelConfig {
|
|
|
521
633
|
scopeData: {
|
|
522
634
|
scope_type: 'space',
|
|
523
635
|
scope_value: 123,
|
|
636
|
+
space_id: 123,
|
|
524
637
|
},
|
|
525
638
|
};
|
|
526
639
|
</script>
|
|
@@ -563,6 +676,7 @@ interface SelectPanelConfig {
|
|
|
563
676
|
scopeData: {
|
|
564
677
|
scope_type: 'space',
|
|
565
678
|
scope_value: 123,
|
|
679
|
+
space_id: 123,
|
|
566
680
|
},
|
|
567
681
|
};
|
|
568
682
|
</script>
|
|
@@ -586,6 +700,7 @@ interface SelectPanelConfig {
|
|
|
586
700
|
scopeData: {
|
|
587
701
|
scope_type: 'space',
|
|
588
702
|
scope_value: 123,
|
|
703
|
+
space_id: 123,
|
|
589
704
|
},
|
|
590
705
|
};
|
|
591
706
|
</script>
|
|
@@ -612,6 +727,7 @@ interface SelectPanelConfig {
|
|
|
612
727
|
scopeData: {
|
|
613
728
|
scope_type: 'space',
|
|
614
729
|
scope_value: 123,
|
|
730
|
+
space_id: 123,
|
|
615
731
|
},
|
|
616
732
|
};
|
|
617
733
|
</script>
|
|
@@ -682,6 +798,7 @@ interface SelectPanelConfig {
|
|
|
682
798
|
scopeData: {
|
|
683
799
|
scope_type: 'space',
|
|
684
800
|
scope_value: 123,
|
|
801
|
+
space_id: 123,
|
|
685
802
|
},
|
|
686
803
|
};
|
|
687
804
|
</script>
|
|
@@ -706,6 +823,7 @@ interface SelectPanelConfig {
|
|
|
706
823
|
scopeData: {
|
|
707
824
|
scope_type: 'space',
|
|
708
825
|
scope_value: 123,
|
|
826
|
+
space_id: 123,
|
|
709
827
|
},
|
|
710
828
|
};
|
|
711
829
|
</script>
|
|
@@ -758,6 +876,7 @@ interface SelectPanelConfig {
|
|
|
758
876
|
scopeData: {
|
|
759
877
|
scope_type: 'space',
|
|
760
878
|
scope_value: 123,
|
|
879
|
+
space_id: 123,
|
|
761
880
|
},
|
|
762
881
|
};
|
|
763
882
|
|
|
@@ -797,6 +916,7 @@ interface SelectPanelConfig {
|
|
|
797
916
|
scopeData: {
|
|
798
917
|
scope_type: 'space',
|
|
799
918
|
scope_value: 123,
|
|
919
|
+
space_id: 123,
|
|
800
920
|
},
|
|
801
921
|
};
|
|
802
922
|
|
|
@@ -840,6 +960,7 @@ interface SelectPanelConfig {
|
|
|
840
960
|
scopeData: {
|
|
841
961
|
scope_type: 'space',
|
|
842
962
|
scope_value: 123,
|
|
963
|
+
space_id: 123,
|
|
843
964
|
},
|
|
844
965
|
};
|
|
845
966
|
</script>
|
|
@@ -879,6 +1000,7 @@ interface SelectPanelConfig {
|
|
|
879
1000
|
scopeData: {
|
|
880
1001
|
scope_type: 'space',
|
|
881
1002
|
scope_value: 123,
|
|
1003
|
+
space_id: 123,
|
|
882
1004
|
},
|
|
883
1005
|
};
|
|
884
1006
|
</script>
|
|
@@ -907,6 +1029,7 @@ interface SelectPanelConfig {
|
|
|
907
1029
|
scopeData: {
|
|
908
1030
|
scope_type: 'space',
|
|
909
1031
|
scope_value: 123,
|
|
1032
|
+
space_id: 123,
|
|
910
1033
|
},
|
|
911
1034
|
};
|
|
912
1035
|
|
|
@@ -947,6 +1070,7 @@ interface SelectPanelConfig {
|
|
|
947
1070
|
scopeData: {
|
|
948
1071
|
scope_type: 'space',
|
|
949
1072
|
scope_value: 123,
|
|
1073
|
+
space_id: 123,
|
|
950
1074
|
},
|
|
951
1075
|
};
|
|
952
1076
|
|
|
@@ -993,6 +1117,7 @@ interface SelectPanelConfig {
|
|
|
993
1117
|
scopeData: {
|
|
994
1118
|
scope_type: 'space',
|
|
995
1119
|
scope_value: 123,
|
|
1120
|
+
space_id: 123,
|
|
996
1121
|
},
|
|
997
1122
|
};
|
|
998
1123
|
</script>
|
|
@@ -1018,6 +1143,8 @@ interface FlowApiConfig {
|
|
|
1018
1143
|
scopeData: {
|
|
1019
1144
|
scope_type: string;
|
|
1020
1145
|
scope_value: number;
|
|
1146
|
+
/** 业务方传入的空间 ID，调试接口专用，语义独立于 scope_value */
|
|
1147
|
+
space_id: number;
|
|
1021
1148
|
};
|
|
1022
1149
|
/**
|
|
1023
1150
|
* 用户查询 API 地址
|
|
@@ -1100,7 +1227,7 @@ type MemberSelectorConfig =
|
|
|
1100
1227
|
|
|
1101
1228
|
### 高级用法：传入完整 API 方法对象
|
|
1102
1229
|
|
|
1103
|
-
深度集成场景下，组件也支持直接传入“已处理好的 API 方法对象”。这类对象通常通过 `useFlowApi`
|
|
1230
|
+
深度集成场景下，组件也支持直接传入“已处理好的 API 方法对象”。这类对象通常通过 `useFlowApi` 生成，或在其基础上覆写单个方法。“已处理”的契约是：方法直接 resolve 类型声明中的业务 DTO，失败时 reject `Error`/`ApiError`，不要再返回 `AxiosResponse` 或 `{ result, data, message }` 信封。
|
|
1104
1231
|
|
|
1105
1232
|
- 常规场景：直接传 `FlowApiConfig`
|
|
1106
1233
|
- 高级场景：传 `useFlowApi(config)` 的返回值
|
|
@@ -1117,6 +1244,7 @@ const baseConfig: FlowApiConfig = {
|
|
|
1117
1244
|
scopeData: {
|
|
1118
1245
|
scope_type: 'space',
|
|
1119
1246
|
scope_value: 123,
|
|
1247
|
+
space_id: 123,
|
|
1120
1248
|
},
|
|
1121
1249
|
fetchUserApi: `${window.BK_COMPONENT_API_URL}/api/c/compapi/v2/usermanage/fs_list_users/`,
|
|
1122
1250
|
};
|
|
@@ -1127,7 +1255,8 @@ const apiConfig: FlowViewApiConfig = {
|
|
|
1127
1255
|
const res = await http.get(`/custom/template/${id}/detail/`, {
|
|
1128
1256
|
params: baseConfig.scopeData,
|
|
1129
1257
|
});
|
|
1130
|
-
|
|
1258
|
+
// 此处是宿主适配边界：返回 FlowTemplate，不返回 AxiosResponse/信封。
|
|
1259
|
+
return res.data.data;
|
|
1131
1260
|
},
|
|
1132
1261
|
};
|
|
1133
1262
|
```
|
|
@@ -1174,10 +1303,11 @@ import type {
|
|
|
1174
1303
|
UniformApiPluginInputsItem,
|
|
1175
1304
|
PluginDetailCommon,
|
|
1176
1305
|
SelectPanelConfig,
|
|
1177
|
-
QuickAddConfig,
|
|
1178
|
-
InsertDirection,
|
|
1179
1306
|
// ... 更多类型
|
|
1180
1307
|
} from 'bkflow-canvas-editor';
|
|
1308
|
+
|
|
1309
|
+
// 引擎类型从 @blueking/flow-canvas 导入，本包不再再导出
|
|
1310
|
+
import type { QuickAddConfig, InsertDirection } from '@blueking/flow-canvas';
|
|
1181
1311
|
```
|
|
1182
1312
|
|
|
1183
1313
|
高级集成场景下，还可以从 `@blueking/bkflow-canvas-editor/advanced` 导入完整 API 类型和 `useFlowApi`：
|
|
@@ -1218,7 +1348,7 @@ resolve: {
|
|
|
1218
1348
|
4. **自动合并 scopeData**：所有 API 请求会自动合并 `scopeData` 到请求参数中（GET 请求合并到 params，POST/PUT 请求合并到请求体）
|
|
1219
1349
|
5. **权限检查**：权限检查通过 `permissions` props 传入布尔值
|
|
1220
1350
|
6. **路由跳转**：路由跳转需要通过事件回调处理，组件内部不直接使用 vue-router
|
|
1221
|
-
7.
|
|
1351
|
+
7. **样式引入**：需分别引入引擎与业务样式：`import '@blueking/flow-canvas/style'` 与 `import 'bkflow-canvas-editor/style'`
|
|
1222
1352
|
8. **输入参数更新机制**：
|
|
1223
1353
|
- 使用 `inputParams` 插槽时，通过 `updateInputParams` 或 `updateNodeInputParams` 方法更新的数据会暂存到节点配置面板
|
|
1224
1354
|
- 用户需要点击节点配置面板的"确定"按钮，数据才会真正保存到流程中
|
package/dist/advanced.cjs.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./context-NG3ocAZ9.cjs");exports.PLUGIN_GROUP_ICON_MAP=e.PLUGIN_GROUP_ICON_MAP;exports.provideVariableInputCreateVariable=e.provideVariableInputCreateVariable;exports.useFlowApi=e.useFlowApi;exports.useVariableInputCreateVariable=e.useVariableInputCreateVariable;
|