@blueking/bkflow-canvas-editor 1.0.9 → 1.0.11

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.
Files changed (7) hide show
  1. package/README.md +36 -30
  2. package/dist/advanced.d.ts +33 -25
  3. package/dist/index.cjs.js +37 -37
  4. package/dist/index.d.ts +72 -36
  5. package/dist/index.esm.js +15885 -15301
  6. package/dist/style.css +1 -1
  7. package/package.json +1 -1
package/README.md CHANGED
@@ -64,20 +64,20 @@ npm install @blueking/bkflow-canvas-editor
64
64
 
65
65
  #### Props
66
66
 
67
- | 参数 | 类型 | 默认值 | 说明 |
68
- | ------------------- | ---------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------- |
69
- | `flowId` | `string` | - | **必需**，流程 ID |
70
- | `apiConfig` | `FlowApiConfig` | - | **必需**，API 配置对象，详见 [API 配置](#api-配置) |
71
- | `permissions` | `{ canEdit?: boolean }` | `{ canEdit: true }` | 权限配置对象，`canEdit` 控制头部编辑按钮是否使用禁用样式 |
72
- | `thumbnail` | `boolean` | `false` | 小地图模式，启用后只显示画布内容，不显示顶部 header 和操作按钮，禁用节点点击事件 |
73
- | `enableVersion` | `boolean` | `false` | 是否开启流程版本功能，开启后会根据 `flowVersion` 的值获取对应版本的流程数据 |
74
- | `flowVersion` | `string` | - | 流程版本号，仅在 `enableVersion` 为 `true` 时生效。为空时表示草稿版本，不为空时表示指定版本 |
75
- | `showHeaderActions` | `boolean` | `true` | 是否显示头部操作按钮（编辑、执行流程、调试），仅在非小地图模式下生效 |
76
- | `defaultZoom` | `number` | `1` | x6 画布的默认缩放比例，用于控制画布的初始显示效果。取值范围建议在 0.25 到 1.5 之间 |
77
- | `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
78
- | `onEdit` | `() => void` | - | 编辑按钮点击回调（可选，也可以通过 `@edit` 事件监听） |
79
- | `onBack` | `() => void` | - | 返回按钮点击回调（可选，也可以通过 `@back` 事件监听） |
80
- | `onExecuteSuccess` | `(taskId: number, templateId: number) => void` | - | 执行成功回调（可选） |
67
+ | 参数 | 类型 | 默认值 | 说明 |
68
+ | ------------------- | ------------------------------------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
69
+ | `flowId` | `string` | - | **必需**，流程 ID |
70
+ | `apiConfig` | `FlowApiConfig` | - | **必需**，API 配置对象，详见 [API 配置](#api-配置) |
71
+ | `permissions` | `{ canEdit?: boolean }` | `{ canEdit: true }` | 权限配置对象，`canEdit` 控制头部编辑按钮是否使用禁用样式 |
72
+ | `thumbnail` | `boolean` | `false` | 小地图模式，启用后只显示画布内容，不显示顶部 header 和操作按钮，禁用节点点击事件 |
73
+ | `enableVersion` | `boolean` | `false` | 是否开启流程版本功能，开启后会根据 `flowVersion` 的值获取对应版本的流程数据 |
74
+ | `flowVersion` | `string` | - | 流程版本号，仅在 `enableVersion` 为 `true` 时生效。为空时表示草稿版本，不为空时表示指定版本 |
75
+ | `showHeaderActions` | `boolean` | `true` | 是否显示头部操作按钮（编辑、执行流程、调试），仅在非小地图模式下生效 |
76
+ | `defaultZoom` | `number` | `1` | x6 画布的默认缩放比例，用于控制画布的初始显示效果。取值范围建议在 0.25 到 1.5 之间 |
77
+ | `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
78
+ | `onEdit` | `() => void` | - | 编辑按钮点击回调（可选，也可以通过 `@edit` 事件监听） |
79
+ | `onBack` | `() => void` | - | 返回按钮点击回调（可选，也可以通过 `@back` 事件监听） |
80
+ | `onExecuteSuccess` | `(result: FlowTaskExecuteSuccessResult) => void` | - | 执行成功回调（可选），参数含 `createResult`(create_task) 与 `executeResult`(operate_task)，用 `executeResult.data.url` 跳转 |
81
81
 
82
82
  #### Slots
83
83
 
@@ -224,25 +224,31 @@ interface SelectPanelConfig {
224
224
 
225
225
  #### Props
226
226
 
227
- | 参数 | 类型 | 默认值 | 说明 |
228
- | ------------------ | ---------------------------------------------- | ------- | ------------------------------------------------------------------- |
229
- | `flowId` | `string` | - | **必需**，流程 ID |
230
- | `show` | `boolean` | - | **必需**，是否显示执行面板 |
231
- | `apiConfig` | `FlowApiConfig` | - | **必需**，API 配置对象，详见 [API 配置](#api-配置) |
232
- | `editable` | `boolean` | `true` | 是否可编辑 |
233
- | `showFlowEntry` | `boolean` | `false` | 是否显示流程入口 |
234
- | `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
235
- | `onExecuteSuccess` | `(taskId: number, templateId: number) => void` | - | 执行成功回调 |
227
+ | 参数 | 类型 | 默认值 | 说明 |
228
+ | ------------------ | ------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------- |
229
+ | `flowId` | `string` | - | **必需**，流程 ID |
230
+ | `show` | `boolean` | - | **必需**，是否显示执行面板 |
231
+ | `apiConfig` | `FlowApiConfig` | - | **必需**，API 配置对象，详见 [API 配置](#api-配置) |
232
+ | `editable` | `boolean` | `true` | 是否可编辑 |
233
+ | `showFlowEntry` | `boolean` | `false` | 是否显示流程入口 |
234
+ | `bkflowSaasUrl` | `string` | - | bkflow-saas-url，用于设置 `$.context.site_url` 的值，供插件内部使用 |
235
+ | `onExecuteSuccess` | `(result: FlowTaskExecuteSuccessResult) => void` | - | 执行成功回调，参数含 `createResult`(create_task) 与 `executeResult`(operate_task)，用 `executeResult.data.url` 跳转 |
236
236
 
237
237
  #### Events
238
238
 
239
- | 事件名 | 参数 | 说明 |
240
- | -------------- | ------------------------------------ | ------------------------ |
241
- | `confirm` | `taskId: number, templateId: number` | 执行确认时触发 |
242
- | `close` | - | 关闭面板时触发 |
243
- | `update:show` | `show: boolean` | 显示状态更新时触发 |
244
- | `before-close` | - | 面板关闭前触发 |
245
- | `view-flow` | - | 点击查看排障流程按钮触发 |
239
+ | 事件名 | 参数 | 说明 |
240
+ | -------------- | -------------------------------------- | ------------------------ |
241
+ | `confirm` | `result: FlowTaskExecuteSuccessResult` | 执行确认时触发 |
242
+ | `close` | - | 关闭面板时触发 |
243
+ | `update:show` | `show: boolean` | 显示状态更新时触发 |
244
+ | `before-close` | - | 面板关闭前触发 |
245
+ | `view-flow` | - | 点击查看排障流程按钮触发 |
246
+
247
+ #### Slots
248
+
249
+ | 插槽名 | Slot Props | 说明 |
250
+ | ------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
251
+ | `customFormContent` | `customFormData`、`additionalTaskParams`、`updateCustomFormData`、`updateAdditionalTaskParams` | 自定义额外表单项；`additionalTaskParams` 会合并进 `createFlowTask` |
246
252
 
247
253
  ---
248
254
 
package/dist/advanced.d.ts CHANGED
@@ -561,7 +561,35 @@ interface DrawPipelineParams {
561
561
  gateway_size?: [number, number];
562
562
  start?: [number, number];
563
563
  }
564
-
564
+ interface CreateFlowTaskParams {
565
+ template_id: number;
566
+ name: string;
567
+ creator: string;
568
+ constants: Record<string, any>;
569
+ label_ids?: number[];
570
+ [key: string]: unknown;
571
+ }
572
+ interface CreateFlowTaskResult {
573
+ data: {
574
+ id: number;
575
+ template_id: number;
576
+ [key: string]: unknown;
577
+ };
578
+ [key: string]: unknown;
579
+ }
580
+ interface ExecuteFlowTaskResult {
581
+ result?: boolean;
582
+ code?: number;
583
+ data?: {
584
+ /** 任务详情页跳转地址（含正确的 bkflow task id 与 templateId） */
585
+ url?: string;
586
+ [key: string]: unknown;
587
+ };
588
+ message?: string | null;
589
+ request_id?: string;
590
+ trace_id?: string | null;
591
+ [key: string]: unknown;
592
+ }
565
593
  interface FlowViewApiConfig {
566
594
  fetchFlowDetail: (id: string) => Promise<FlowTemplate>;
567
595
  fetchSpaceFlowConfig: (id: string) => Promise<SpaceFlowConfig>;
@@ -590,24 +618,14 @@ interface FlowViewApiConfig {
590
618
  data: any[];
591
619
  };
592
620
  }>;
593
- createFlowTask?: (params: {
594
- template_id: number;
595
- name: string;
596
- creator: string;
597
- constants: Record<string, any>;
598
- }) => Promise<{
599
- data: {
600
- id: number;
601
- template_id: number;
602
- };
603
- }>;
621
+ createFlowTask?: (params: CreateFlowTaskParams) => Promise<CreateFlowTaskResult>;
604
622
  executeFlowTask?: (params: {
605
623
  task_id: number;
606
624
  action: string;
607
625
  resource_type: string;
608
626
  resource_id: number;
609
627
  permission_type: string;
610
- }) => Promise<any>;
628
+ }) => Promise<ExecuteFlowTaskResult>;
611
629
  fetchControlConfig?: () => Promise<Record<string, any>>;
612
630
  checkSpaceConfig?: (scopeValue: number, params: {
613
631
  name: string;
@@ -645,24 +663,14 @@ interface FlowEditApiConfig extends FlowViewApiConfig {
645
663
  drawPipeline?: (params: DrawPipelineParams) => Promise<{
646
664
  pipeline_tree: PipelineTree;
647
665
  }>;
648
- createFlowTask?: (params: {
649
- template_id: number;
650
- name: string;
651
- creator: string;
652
- constants: Record<string, any>;
653
- }) => Promise<{
654
- data: {
655
- id: number;
656
- template_id: number;
657
- };
658
- }>;
666
+ createFlowTask?: (params: CreateFlowTaskParams) => Promise<CreateFlowTaskResult>;
659
667
  executeFlowTask?: (params: {
660
668
  task_id: number;
661
669
  action: string;
662
670
  resource_type: string;
663
671
  resource_id: number;
664
672
  permission_type: string;
665
- }) => Promise<any>;
673
+ }) => Promise<ExecuteFlowTaskResult>;
666
674
  }
667
675
 
668
676
  declare const PLUGIN_GROUP_ICON_MAP: Record<string, string>;