@blueking/bkflow-canvas-editor 1.0.17 → 1.0.18

package/dist/index.d.ts

@@ -635,7 +635,11 @@ interface FlowApiConfig {
         scope_type: string;
         scope_value: number;
     };
-    /** 用户查询 API 地址（可选） */
+    /**
+     * 用户查询 API 地址（可选）
+     * @deprecated 请改用 FlowEdit/FlowView 顶层组件的 `memberSelectorConfig.fetchUserApi`。
+     * 该字段仅保留向后兼容，未来版本会移除。
+     */
     fetchUserApi?: string;
     /** 是否启用第三方插件（可选，默认为 true） */
     enableThirdPlugin?: boolean;
@@ -689,6 +693,10 @@ interface FlowViewApiConfig {
     fetchFlowDetail: (id: string) => Promise<FlowTemplate>;
     fetchSpaceFlowConfig: (id: string) => Promise<SpaceFlowConfig>;
     fetchSystemVariables: (id: string) => Promise<Variable[]>;
+    /**
+     * 用户查询 API 地址
+     * @deprecated 请改用 memberSelectorConfig.fetchUserApi（顶层组件 prop）
+     */
     fetchUserApi?: string;
     /** 作用域数据（必需，由外部传入） */
     scopeData: {
@@ -768,6 +776,97 @@ interface FlowEditApiConfig extends FlowViewApiConfig {
     }) => Promise<ExecuteFlowTaskResult>;
 }
 
+/**
+ * 插件分组选择面板配置
+ */
+interface SelectPanelConfig {
+    agentApplyUrl?: string;
+    agentResourceUrl?: string;
+    agentButtonText?: string;
+    knowledgebaseResourceUrl?: string;
+}
+/**
+ * 人员选择器配置
+ * 采用判别联合（discriminated union）：
+ *  - mode 缺省或为 'legacy'：使用组件内置的 UserSelector，依赖 fetchUserApi
+ *  - mode 为 'tenant'：使用多租户人员选择器 @blueking/bk-user-selector，
+ *    tenantId 与 apiBaseUrl 在类型上即为必填
+ *    接入方需自行安装 npm 包 @blueking/bk-user-selector
+ */
+type MemberSelectorConfig = {
+    mode?: 'legacy';
+    /** 用户查询 API 地址 */
+    fetchUserApi?: string;
+} | {
+    mode: 'tenant';
+    /** 租户 ID */
+    tenantId: string;
+    /** bk-user 服务的 API 基础地址 */
+    apiBaseUrl: string;
+    /** 当前登录用户 ID，开启后可在下拉中快捷选择"我" */
+    currentUserId?: string;
+    /** 是否启用跨租户搜索，默认 false */
+    enableMultiTenantMode?: boolean;
+    /** 是否展示头像，默认 false */
+    hasAvatar?: boolean;
+    /** 头像 CDN 基础地址 */
+    avatarBaseUrl?: string;
+    /** 最近选择的用户 ID 列表 */
+    recentUserIds?: string[];
+};
+/**
+ * 在顶层组件中提供 FlowApiConfig
+ * @param config FlowApiConfig 配置对象或已处理的 API 配置对象
+ * @returns 返回处理后的 API 配置对象
+ */
+declare function provideFlowApiConfig(config: FlowApiConfig | FlowEditApiConfig | FlowViewApiConfig): FlowEditApiConfig | FlowViewApiConfig;
+/**
+ * 在子组件中注入 FlowApiConfig（通用版本）
+ * @returns FlowEditApiConfig
+ * @throws 如果 apiConfig 未提供则抛出错误
+ */
+declare function useFlowApiConfig(): FlowEditApiConfig;
+/**
+ * 在子组件中注入 FlowEditApiConfig（类型化版本）
+ * @returns FlowEditApiConfig
+ */
+declare function useFlowEditApiConfig(): FlowEditApiConfig;
+/**
+ * 在子组件中注入 FlowViewApiConfig（类型化版本）
+ * 注意：实际上返回的是 FlowEditApiConfig，但类型上兼容 FlowViewApiConfig
+ * @returns FlowViewApiConfig
+ */
+declare function useFlowViewApiConfig(): FlowViewApiConfig;
+/**
+ * 在顶层组件中提供 SelectPanelConfig
+ * @param config SelectPanelConfig 配置对象
+ */
+declare function provideSelectPanelConfig(config: SelectPanelConfig): void;
+/**
+ * 在子组件中注入 SelectPanelConfig
+ * @returns SelectPanelConfig 或 null（如果未提供配置）
+ */
+declare function useSelectPanelConfig(): SelectPanelConfig | null;
+/**
+ * 在顶层组件中提供 MemberSelectorConfig
+ *
+ * 注意：当 `config` 为 undefined 时，**不会调用 provide**，从而不会遮蔽
+ * 父级（如外层 FlowView/FlowEdit）已经 provide 的配置。
+ * 例如 `FlowView` 内部渲染 `FlowCreateTask` 时，如果调用方仅在 `FlowView`
+ * 上传入 `memberSelectorConfig`，则 `FlowCreateTask` 不会因为自己未收到 prop
+ * 而把 tenant 配置覆盖回 legacy。
+ *
+ * 若调用方主动传入 `{ mode: 'legacy' }`，则视为显式覆盖，按正常 provide。
+ *
+ * @param config MemberSelectorConfig 配置对象；为 undefined 时跳过 provide
+ */
+declare function provideMemberSelectorConfig(config?: MemberSelectorConfig): void;
+/**
+ * 在子组件中注入 MemberSelectorConfig
+ * @returns MemberSelectorConfig，未提供时返回 { mode: 'legacy' }
+ */
+declare function useMemberSelectorConfig(): MemberSelectorConfig;
+
 type __VLS_Props$5 = {
     flowId: string;
     show: boolean;
@@ -783,6 +882,7 @@ type __VLS_Props$5 = {
     bkflowSaasUrl?: string;
     enableVersion?: boolean;
     flowVersion?: string;
+    memberSelectorConfig?: MemberSelectorConfig;
 };
 declare var __VLS_65: {
     formData: {
@@ -911,6 +1011,7 @@ type __VLS_Props$3 = {
     apiConfig: FlowApiConfig;
     onExecuteSuccess?: (result: FlowTaskExecuteSuccessResult) => void;
     bkflowSaasUrl?: string;
+    memberSelectorConfig?: MemberSelectorConfig;
 };
 declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$3, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
     close: (...args: any[]) => void;
@@ -943,49 +1044,6 @@ declare namespace __create_task_vue {
   };
 }
 
-/**
- * 插件分组选择面板配置
- */
-interface SelectPanelConfig {
-    agentApplyUrl?: string;
-    agentResourceUrl?: string;
-    agentButtonText?: string;
-    knowledgebaseResourceUrl?: string;
-}
-/**
- * 在顶层组件中提供 FlowApiConfig
- * @param config FlowApiConfig 配置对象或已处理的 API 配置对象
- * @returns 返回处理后的 API 配置对象
- */
-declare function provideFlowApiConfig(config: FlowApiConfig | FlowEditApiConfig | FlowViewApiConfig): FlowEditApiConfig | FlowViewApiConfig;
-/**
- * 在子组件中注入 FlowApiConfig（通用版本）
- * @returns FlowEditApiConfig
- * @throws 如果 apiConfig 未提供则抛出错误
- */
-declare function useFlowApiConfig(): FlowEditApiConfig;
-/**
- * 在子组件中注入 FlowEditApiConfig（类型化版本）
- * @returns FlowEditApiConfig
- */
-declare function useFlowEditApiConfig(): FlowEditApiConfig;
-/**
- * 在子组件中注入 FlowViewApiConfig（类型化版本）
- * 注意：实际上返回的是 FlowEditApiConfig，但类型上兼容 FlowViewApiConfig
- * @returns FlowViewApiConfig
- */
-declare function useFlowViewApiConfig(): FlowViewApiConfig;
-/**
- * 在顶层组件中提供 SelectPanelConfig
- * @param config SelectPanelConfig 配置对象
- */
-declare function provideSelectPanelConfig(config: SelectPanelConfig): void;
-/**
- * 在子组件中注入 SelectPanelConfig
- * @returns SelectPanelConfig 或 null（如果未提供配置）
- */
-declare function useSelectPanelConfig(): SelectPanelConfig | null;
-
 type __VLS_Slots$2 = {
     header?: () => any;
     inputParams?: (props: {
@@ -1023,6 +1081,7 @@ type __VLS_Props$2 = {
     }) => Promise<void> | void;
     useCustomDebugConfirm?: boolean;
     selectPanelConfig?: SelectPanelConfig;
+    memberSelectorConfig?: MemberSelectorConfig;
     onSave?: (flowData: FlowTemplate) => void;
     onSaveSuccess?: () => void;
     onBack?: () => void;
@@ -1121,6 +1180,7 @@ type __VLS_Props$1 = {
     onExecuteSuccess?: (result: FlowTaskExecuteSuccessResult) => void;
     /** 是否隐藏基础信息中的触发器配置表单，默认 false */
     hideTrigger?: boolean;
+    memberSelectorConfig?: MemberSelectorConfig;
 };
 declare const __VLS_base$1: vue.DefineComponent<__VLS_Props$1, {
     zoomToFit: (options?: ZoomToFitOptions) => void;
@@ -1396,5 +1456,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, resolveExecutionActions, useFlowApiConfig, useFlowEditApiConfig, useFlowViewApiConfig, useSelectPanelConfig, validatePipelineTree };
-export type { Activity, CanvasViewportExpose, CreateFlowTaskResult, DndNodeItem, ExecuteFlowTaskResult, ExecutionNodeAction, FlowApiConfig, FlowEditExpose, FlowTaskExecuteSuccessResult, FlowTemplate, FlowViewExpose, 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, provideMemberSelectorConfig, provideSelectPanelConfig, random4, resolveExecutionActions, useFlowApiConfig, useFlowEditApiConfig, useFlowViewApiConfig, useMemberSelectorConfig, useSelectPanelConfig, validatePipelineTree };
+export type { Activity, CanvasViewportExpose, CreateFlowTaskResult, DndNodeItem, ExecuteFlowTaskResult, ExecutionNodeAction, FlowApiConfig, FlowEditExpose, FlowTaskExecuteSuccessResult, FlowTemplate, FlowViewExpose, Gateway, GatewayCondition, MemberSelectorConfig, NodeExecutionState, NodeExecutionStatus, NotifyConfig, PipelineTree, PluginDetailCommon, PluginInputDataItem, SelectPanelConfig, SpaceFlowConfig, TaskExecutionStates, TemplateConfigs, TriggerCron, TriggerItem, UniformApiPluginInputsItem, UpdateFlowParams, Variable, VariableReference };