Files
dacli/src/commands/workflow/create.ts
T
ssw 831a2907a6 feat(workflow): v0.11e+ Phase B2 --auto-authorize 选项
workflow/create.ts 加 --auto-authorize 选项:
- 创建 workflow 后自动调 /permission/authorize 端点授权给当前角色
- 镜像 web 流程创建后自动授权 (流程设计器建好流程后自动在权限管理里出现)
- 失败不阻断 workflow 创建, 仅 warn (workflow 已成功创建, 可手动授权)
- 后端 objectType='flow' + objectId=newId

简化版实现 (调用通用 authorize 端点, 非完美镜像 web 流程发布后自动授权的复杂逻辑)
真正的流程版本授权通过 menu type=11 (workflow) + Actions/Module 完成, 与 menu create --formId 路径协同

selfcheck workflow/create.ts: 8/8 pass (src/commands/ 0 error)
2026-06-27 03:19:08 +08:00

253 lines
12 KiB
TypeScript

/**
* commands/workflow/create.ts — 新建流程模板
*
* API: POST /api/workflow/template body=TemplateNodeCrFrom
* - {fullName, enCode, category, type, flowXml, flowNodes, flowConfig, ...}
* - v0.11: 与后端 TemplateCrForm.java 字段名 1:1 对齐 (type/iconBackground/showType)
*
* AI 集成 (白皮书 5.10.3): --ai "<描述>" 调用 POST /api/workflow/ai,
* LLM 返回 flowXml, 自动塞进 body。
*/
import { Command } from 'commander'
import { JnpfClient } from '../../core/client.ts'
import { installAiHelpHook } from '../../core/help.ts'
import { log, printJson } from '../../core/log.ts'
import { callAiWorkflow } from '../form/_ai.ts'
import { validateWorkflowCreate } from './_validate.ts'
import { enhanceFromBackend, formatErrorLine } from '../_error_codes.ts'
interface CreateOpts {
fullName?: string
enCode?: string
category?: string
/** v0.11 修复: 后端字段名是 `type` (TemplateCrForm.java:19), dacli 旧称 flowType 错配 */
type?: string
/** v0.11e+ Phase B2: auto-authorize */
autoAuthorize?: boolean
flowXml?: string
flowNodes?: string
flowConfig?: string
/** v0.11 修复: 后端字段名是 `iconBackground` (TemplateCrForm.java:28) */
iconBackground?: string
/** v0.11 修复: 后端字段名是 `showType` (TemplateCrForm.java:42), visibleType 是别名 */
showType?: string
/** v0.11d+ 镜像 web flowEngine/Form.vue:70-75 icon 必填 */
icon?: string
json?: boolean
/** 5.10.3 AI 创建流程 — 自然语言描述, 平台 LLM 生成 flowXml */
ai?: string
}
export function buildWorkflowCreateCommand(): Command {
const cmd = new Command('create')
.description('新建流程模板 (--ai "<描述>" 走平台 LLM 自动生成 BPMN xml)')
.option('--fullName <n>', '中文名 (--ai 自动填, 否则必填)')
.option('--enCode <e>', '英文编码 (--ai 自动填, 否则必填)')
.option('--category <c>', '分类 id (workflow list 看真实值)')
// v0.11 修复: 与后端 TemplateCrForm.java:type 对齐 (0=标准 1=简流)
.option('--type <t>', '流程类型 (0=标准 1=简流, 默认 0=标准)', '0')
.option('--flowXml <xml>', 'BPMN xml (--ai 自动填, 否则必填)')
.option('--flowNodes <json>', 'flowNodes JSON 字符串 (节点结构, --ai 自动填)')
.option('--flowConfig <json>', 'flowConfig JSON 字符串')
.option('--iconBackground <color>', '图标背景色 (默认 #108ee9)', '#108ee9')
// v0.11d+ 镜像 web flowEngine/Form.vue:70-75 icon 必填
.option('--icon <i>', '流程图标 (默认 icon-ym icon-ym-flow)', 'icon-ym icon-ym-flow')
// v0.11 修复: 后端 showType (TemplateCrForm.java:42)
.option('--showType <n>', '显示位置 (0=全局 1=流程 2=菜单, 默认 0)', '0')
.option('--ai <desc>', '白皮书 5.10.3 AI 创建流程 — 自然语言描述, 平台 LLM 生成 flowXml')
// v0.11e+ Phase B2: auto-authorize (镜像 web 流创建后自动授权给当前角色)
.option('--auto-authorize', 'v0.11e+ Phase B2: 创建后自动给当前角色授权 (镜像 web Actions/Module 流程版本)', false)
.option('--json', '原始 JSON 输出', false)
.action(async (opts: CreateOpts) => {
// 5.10.3 AI 创建流程
if (opts.ai) {
log.info(`--ai "${opts.ai}" — 调用平台 AI 生成流程 (白皮书 5.10.3)`)
const data = await callAiWorkflow(opts.ai)
if (!data.flowXml) {
log.error('AI 响应缺 flowXml, 无法自动建流程')
if (opts.json) printJson(data)
process.exit(2)
}
opts.flowXml = opts.flowXml || data.flowXml
if (data.flowNodes) opts.flowNodes = opts.flowNodes || JSON.stringify(data.flowNodes)
log.info(`AI 生成 flowXml 长度 ${data.flowXml.length} 字符`)
}
// v0.11d+ 移除前置 fail-fast, 改由 step machine 聚合校验 (镜像 web flowEngine/Form.vue:125-150 validate)
const c = await JnpfClient.fromToken()
// v0.11d+ step machine 校验 (镜像 web flowEngine/Form.vue + AiCreateModal.vue + 后端 TemplateController.java:268-276)
// 在发 API 前暴露问题, 聚合错误一次报
await runWorkflowStepMachine(c, {
fullName: opts.fullName,
enCode: opts.enCode,
category: opts.category,
icon: opts.icon,
showType: opts.showType,
flowXml: opts.flowXml,
flowNodes: opts.flowNodes,
})
// D-8 (BS-45 防御): flowNodes 必 Map 格式, Array 会报 "Cannot deserialize value of type Map from Array value"
let flowNodes: unknown = {}
if (opts.flowNodes) {
let parsed: unknown
try { parsed = JSON.parse(opts.flowNodes) }
catch (e) {
// v0.11d+: 让 step machine 统一报 JSON 解析错误, 不在这里 fail-fast
log.warn(`flowNodes JSON 解析警告: ${(e as Error).message}, step machine 会再次校验`)
parsed = opts.flowNodes
}
if (Array.isArray(parsed)) {
// D-8: BS-45 防御, 但改成 WARN 提示, 不阻断 (step machine 会拦)
log.warn('D-8: --flowNodes 必传 Map 格式 (key=nodeCode, value=nodeInfo), Array 会被 step machine 拦截')
}
flowNodes = parsed
}
const body: Record<string, unknown> = {
fullName: opts.fullName,
enCode: opts.enCode,
category: opts.category || null,
// v0.11 修复: 与后端 TemplateCrForm.java:type 对齐 (旧称 flowType)
type: Number(opts.type ?? '0'),
flowXml: opts.flowXml,
flowNodes,
flowConfig: opts.flowConfig || '{}',
sortCode: 0,
// v0.11 修复: 与后端 TemplateCrForm.java:showType 对齐 (旧称 visibleType, 是别名)
showType: Number(opts.showType ?? '0'),
// v0.11 修复: 与后端 TemplateCrForm.java:iconBackground 对齐 (旧称 color)
iconBackground: opts.iconBackground ?? '#108ee9',
// v0.11d+ 镜像 web flowEngine/Form.vue:70-75 (用户传或默认)
icon: opts.icon ?? 'icon-ym icon-ym-flow',
}
log.info(`POST /workflow/template ${opts.enCode} type=${body.type} showType=${body.showType}`)
const r = await c.postJson<unknown>('/workflow/template', body)
if (r.code !== 200) {
log.error(`创建流程失败 (code=${r.code}): ${r.msg}`)
// v0.11e+ Phase A1: 后端错误增强 — 自动从 msg 提取 ErrorCode
const enhanced = enhanceFromBackend(r.msg || '', 'workflow', { entity: 'workflow' })
log.error(` ${formatErrorLine(enhanced, { step: 2, stepName: '后端API' })}`)
if (opts.json) printJson(r)
process.exit(1)
}
const newId = (r.data as { id?: string })?.id || '(unknown)'
log.ok(`创建成功: id=${newId} enCode=${opts.enCode}`)
// v0.11e+ Phase B2: auto-authorize (镜像 web 流程创建后自动授权给当前角色)
if (opts.autoAuthorize) {
log.info(`--auto-authorize: 给当前角色授权 workflow (id=${newId})`)
try {
// 通用 authorize 端点 (JNPF /permission/authorize + itemType=workflow)
const ar = await c.postJson('/permission/authorize', {
objectType: 'flow',
objectId: newId,
})
if (ar.code === 200) {
log.ok(`✓ 已授权给当前角色 (workflow id=${newId})`)
} else {
log.warn(`--auto-authorize 部分失败: ${ar.msg} (workflow 已创建, 可在权限管理手动授权)`)
}
} catch (e) {
log.warn(`--auto-authorize 异常: ${(e as Error).message?.slice(0, 100)} (workflow 已创建)`)
}
}
if (opts.json) printJson({ id: newId, enCode: opts.enCode, flowXml: opts.flowXml })
})
installAiHelpHook(cmd, {
purpose: '新建流程模板. --ai "<描述>" 走平台 LLM 自动生成 BPMN xml (白皮书 5.10.3). v0.11d+ 加 step machine 校验 (3 step 镜像 web flowEngine/Form.vue + 后端 TemplateController.create, 聚合错误)',
required: { '--fullName | --ai': '中文名, 或传 --ai 由平台 AI 自动生成' },
optional: {
'--enCode': '英文编码 (--ai 自动填)',
'--category': '分类 id',
'--type': '0=标准 1=简流 (v0.11 与后端 TemplateCrForm.java:type 对齐)',
'--flowXml': 'BPMN xml (--ai 自动填)',
'--flowNodes': '节点结构 JSON',
'--flowConfig': '流程配置 JSON',
'--ai': '白皮书 5.10.3 AI 创建流程 — 自然语言描述生成 BPMN',
},
example: [
'dacli workflow create --fullName="请假流程" --enCode=leave_flow --type=0 --flowXml=\'<?xml...>\'',
'dacli workflow create --ai "员工请假, 直属领导审批, HR 备案"',
],
source: {
web: 'web/.../onlineDev/flowEngine/Form.vue (后端: jnpf/.../TemplateController.java:268-276)',
api: 'POST /api/workflow/template | POST /api/workflow/ai',
ref: '白皮书 5.6.1-5.6.5 (流程设计) + 5.10.3 (AI 创建流程) + web formValidate.ts:24-28 (enCode 正则)',
},
notes: [
'v0.11d+ step machine (镜像 web flowEngine/Form.vue:31-106 schemas + L125-150 handleSubmit):',
' step 0 基础信息: fullName 必填 + enCode 正则 + category 必填 + icon 必填 + showType ∈ {0,1,2}',
' step 1 流程图: flowXml 必填 + 合法 BPMN XML + flowNodes Map 格式 + 节点完整性 (BPMN 标准 start+end)',
' step 2 唯一性: enCode 不重复 (后端不查, 必须预校验) + category 合法',
'flowXml 是 BPMN 2.0 XML, --ai 会从平台 LLM 拿',
'AI 生成的流程需在浏览器里手动调整节点位置 + 表单绑定',
'5.10.4 (AI 咨询助手) 暂未集成 — free-form Q&A 无自然挂载点, 留 v0.10+ 评估',
'5.10.5 (AI 模型配置) 走 dacli integration model (P2 已有)',
],
})
return cmd
}
/**
* v0.11d+ step machine 校验 (3 步镜像 web flowEngine/Form.vue + 后端 TemplateController.create)
* 在发 API 前暴露问题, 聚合错误一次报
*
* 镜像原型:
* - web flowEngine/Form.vue:31-106 schemas 6 字段 (fullName/enCode/category/icon)
* - web flowEngine/Form.vue:125-150 handleSubmit (validate + create API)
* - web flowEngine/components/AiCreateModal.vue:36-41 (同 4 必填)
* - web packages/jnpf/utils/src/helpers/formValidate.ts:24-28 (enCode 正则, 同 menu 修复)
* - jnpf/.../flowable/controller/TemplateController.java:268-276 (create 端点)
*/
async function runWorkflowStepMachine(
c: JnpfClient,
opts: {
fullName?: string
enCode?: string
category?: string
icon?: string
showType?: string
flowXml?: string
flowNodes?: string
},
): Promise<void> {
// 1. 拉已存在 enCode 列表 (供 step 2 唯一性预校验, 容错: 拉失败跳过)
let existingEnCodes: string[] = []
try {
const r = await c.get<{ data?: { list?: Array<{ enCode: string }> } }>('/workflow/template', {
currentPage: 1,
pageSize: 1000,
})
const list = (r.data as { list?: Array<{ enCode: string }> })?.list || []
existingEnCodes = list.map((t) => t.enCode).filter(Boolean)
} catch {
// 拉列表失败不阻断 (step 2 跳过查重)
}
// 2. 跑 3 step 校验
const result = validateWorkflowCreate({
fullName: opts.fullName,
enCode: opts.enCode,
category: opts.category,
icon: opts.icon,
showType: opts.showType ? Number(opts.showType) : undefined,
flowXml: opts.flowXml,
flowNodes: opts.flowNodes,
existingEnCodes,
})
// 3. 输出结果 (聚合错误 / 全部通过)
if (!result.ok) {
const allErrors = result.steps.flatMap((s) =>
s.errors.map((e) => ({ step: s.step, stepName: s.stepName, ...e })),
)
log.error(`✗ step machine 校验失败 (${allErrors.length} 个错误):`)
for (const e of allErrors) {
log.error(` [step ${e.step} ${e.stepName}] ${e.field || '?'}: ${e.message}`)
}
process.exit(1)
}
log.info(`✓ step machine 校验通过 (3/3): enCode=${opts.enCode}`)
}