@blueking/bkflow-canvas-editor 1.0.9 → 1.0.11

package/dist/index.d.ts

@@ -641,6 +641,41 @@ interface DrawPipelineParams {
     gateway_size?: [number, number];
     start?: [number, number];
 }
+interface CreateFlowTaskParams {
+    template_id: number;
+    name: string;
+    creator: string;
+    constants: Record<string, any>;
+    label_ids?: number[];
+    [key: string]: unknown;
+}
+interface CreateFlowTaskResult {
+    data: {
+        id: number;
+        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 FlowTaskExecuteSuccessResult {
+    /** createFlowTask（create_task）接口响应 */
+    createResult: CreateFlowTaskResult;
+    /** executeFlowTask（operate_task）接口响应，data.url 用于任务详情跳转 */
+    executeResult: ExecuteFlowTaskResult;
+}
 
 interface FlowViewApiConfig {
     fetchFlowDetail: (id: string) => Promise<FlowTemplate>;
@@ -670,24 +705,14 @@ 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;
         action: string;
         resource_type: string;
         resource_id: number;
         permission_type: string;
-    }) => Promise<any>;
+    }) => Promise<ExecuteFlowTaskResult>;
     fetchControlConfig?: () => Promise<Record<string, any>>;
     checkSpaceConfig?: (scopeValue: number, params: {
         name: string;
@@ -725,24 +750,14 @@ 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;
         action: string;
         resource_type: string;
         resource_id: number;
         permission_type: string;
-    }) => Promise<any>;
+    }) => Promise<ExecuteFlowTaskResult>;
 }
 
 type __VLS_Props$5 = {
@@ -767,10 +782,10 @@ declare var __VLS_65: {
     };
     variablesValue: Record<string, any>;
 };
-type __VLS_Slots$4 = {} & {
+type __VLS_Slots$5 = {} & {
     'custom-form-content'?: (props: typeof __VLS_65) => any;
 };
-declare const __VLS_base$4: vue.DefineComponent<__VLS_Props$5, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+declare const __VLS_base$5: vue.DefineComponent<__VLS_Props$5, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
     close: (...args: any[]) => void;
     "update:show": (...args: any[]) => void;
     confirm: (...args: any[]) => void;
@@ -786,10 +801,10 @@ declare const __VLS_base$4: vue.DefineComponent<__VLS_Props$5, {}, {}, {}, {}, v
     enableVersion: boolean;
     useCustomConfirm: boolean;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$5: __VLS_WithSlots$4<typeof __VLS_base$4, __VLS_Slots$4>;
+declare const __VLS_export$5: __VLS_WithSlots$5<typeof __VLS_base$5, __VLS_Slots$5>;
 declare const _default$6: typeof __VLS_export$5;
 
-type __VLS_WithSlots$4<T, S> = T & {
+type __VLS_WithSlots$5<T, S> = T & {
     new (): {
         $slots: S;
     };
@@ -801,7 +816,7 @@ declare namespace __debug_vue {
   };
 }
 
-type __VLS_Slots$3 = {
+type __VLS_Slots$4 = {
     header?: () => any;
     extend?: () => any;
 };
@@ -814,7 +829,7 @@ type __VLS_Props$4 = {
     showHeader?: boolean;
     onBack?: () => void;
 };
-declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$4, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+declare const __VLS_base$4: vue.DefineComponent<__VLS_Props$4, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
     retry: (nodeId: string) => any;
     skip: (nodeId: string) => any;
     resume: (nodeId: string) => any;
@@ -857,10 +872,10 @@ declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$4, {}, {}, {}, {}, v
     defaultZoom: number;
     nodeStates: TaskExecutionStates;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$4: __VLS_WithSlots$3<typeof __VLS_base$3, __VLS_Slots$3>;
+declare const __VLS_export$4: __VLS_WithSlots$4<typeof __VLS_base$4, __VLS_Slots$4>;
 declare const _default$5: typeof __VLS_export$4;
 
-type __VLS_WithSlots$3<T, S> = T & {
+type __VLS_WithSlots$4<T, S> = T & {
     new (): {
         $slots: S;
     };
@@ -872,16 +887,24 @@ declare namespace __execute_vue {
   };
 }
 
+type __VLS_Slots$3 = {
+    customFormContent?: (props: {
+        customFormData: Record<string, any>;
+        additionalTaskParams: Record<string, any>;
+        updateCustomFormData: (data: Record<string, any>) => void;
+        updateAdditionalTaskParams: (params: Record<string, any>) => void;
+    }) => any;
+};
 type __VLS_Props$3 = {
     flowId: string;
     show: boolean;
     editable?: boolean;
     showFlowEntry?: boolean;
     apiConfig: FlowApiConfig;
-    onExecuteSuccess?: (taskId: number, templateId: number) => void;
+    onExecuteSuccess?: (result: FlowTaskExecuteSuccessResult) => void;
     bkflowSaasUrl?: string;
 };
-declare const __VLS_export$3: vue.DefineComponent<__VLS_Props$3, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+declare const __VLS_base$3: vue.DefineComponent<__VLS_Props$3, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
     close: (...args: any[]) => void;
     "update:show": (...args: any[]) => void;
     confirm: (...args: any[]) => void;
@@ -897,8 +920,15 @@ declare const __VLS_export$3: vue.DefineComponent<__VLS_Props$3, {}, {}, {}, {},
     editable: boolean;
     showFlowEntry: boolean;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export$3: __VLS_WithSlots$3<typeof __VLS_base$3, __VLS_Slots$3>;
 declare const _default$4: typeof __VLS_export$3;
 
+type __VLS_WithSlots$3<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 declare namespace __create_task_vue {
   export {
     _default$4 as default,
@@ -1052,6 +1082,12 @@ type __VLS_Slots$1 = {
         }[];
         updateInputParams: (data: Record<string, any>) => void;
     }) => any;
+    customFormContent?: (props: {
+        customFormData: Record<string, any>;
+        additionalTaskParams: Record<string, any>;
+        updateCustomFormData: (data: Record<string, any>) => void;
+        updateAdditionalTaskParams: (params: Record<string, any>) => void;
+    }) => any;
 };
 type __VLS_Props$1 = {
     flowId: string;
@@ -1068,7 +1104,7 @@ type __VLS_Props$1 = {
     showHeaderActions?: boolean;
     defaultZoom?: number;
     bkflowSaasUrl?: string;
-    onExecuteSuccess?: (taskId: number, templateId: number) => void;
+    onExecuteSuccess?: (result: FlowTaskExecuteSuccessResult) => void;
 };
 declare const __VLS_base$1: vue.DefineComponent<__VLS_Props$1, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
     back: () => any;
@@ -1340,4 +1376,4 @@ declare const _default: {
 };
 
 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, DndNodeItem, ExecutionNodeAction, FlowApiConfig, FlowEditExpose, FlowTemplate, Gateway, GatewayCondition, NodeExecutionState, NodeExecutionStatus, NotifyConfig, PipelineTree, PluginDetailCommon, PluginInputDataItem, SelectPanelConfig, SpaceFlowConfig, TaskExecutionStates, TemplateConfigs, TriggerCron, TriggerItem, UniformApiPluginInputsItem, UpdateFlowParams, Variable, VariableReference };
+export type { Activity, CreateFlowTaskResult, DndNodeItem, ExecuteFlowTaskResult, ExecutionNodeAction, FlowApiConfig, FlowEditExpose, FlowTaskExecuteSuccessResult, FlowTemplate, Gateway, GatewayCondition, NodeExecutionState, NodeExecutionStatus, NotifyConfig, PipelineTree, PluginDetailCommon, PluginInputDataItem, SelectPanelConfig, SpaceFlowConfig, TaskExecutionStates, TemplateConfigs, TriggerCron, TriggerItem, UniformApiPluginInputsItem, UpdateFlowParams, Variable, VariableReference };