Files
dacli/src/commands/bigscreen/construct.ts
T
ssw e091907db7 feat(dacli): bigscreen/construct.ts 完整 wrapCommand 迁移 (P6 6 exit 收口)
6 处 process.exit(1) → ctx.fail():
- main action catch (构造失败兜底)
- runConstruct --from-json 文件不存在 (改 throw DacliError → handler catch → ctx.fail)
- runConstruct --from-json JSON.parse 失败 (同上)
- runConstruct validateOnly 校验失败 (原 process.exit(1) 单一分支)
- runConstruct 校验失败 (原 else 分支)
- runConstruct addObj 后端未返 id (同上)

runConstruct 内部 5 处 process.exit(1) → throw new DacliError (P5 已就绪模式)
main action 兜底 catch → ctx.fail. wrapCommand handler 自动 catch 所有 throw.

修改方式: Write 整文件重写.

验证:
  - TS compile 0 新错误 (baseline 57 不变)
  - 73/73 单元测试 PASS
2026-07-21 20:25:04 +08:00

354 lines
17 KiB
TypeScript

/**
* commands/bigscreen/construct.ts — 大屏构造 (v0.13+ §8.2.4 阶段 5)
*
* 修改 P5 全量 (2026-07-21): throw new Error → DacliError 提升 L2 catch 分类.
* v2.2+ (2026-07-21): wrapCommand 收口 6 处 process.exit(1), 内部 process.exit 改 throw DacliError
*
* 用途: 一键创建带组件的大屏. 支持:
* - --template=base: 内置空大屏模板 (9 组件 demo)
* - --from-template=<name>: 官方模板 (Phase 5+ 扩展, 暂等同 --template=base)
* - --from-json=<file>: 用户设计 JSON (含 baseConfig + nav 两段)
* - --prop=<name>: 多次, 加单个组件 (e.g. --prop=bar --prop=text)
* - --x/--y/--w/--h: 组件位置 (默认 0/0/400/300, --prop 多次时按 i*320 纵向堆叠)
* - --dataType: 0-7 镜像 build.vue:666-689
* - --url/--sql/--value: 数据源字段 (跟 dataType 配套)
* - --validate-only: 只校验, 不创建
* - --no-release: 创建后不发布
* - --json: 原始 JSON 输出
*
* 流程:
* 1. 构造 baseConfig (--template=base 用 getBaseConfig)
* 2. 构造 nav 数组 (--prop 多次 → constructComponentJson; --from-json 直接用)
* 3. validateConstruct 校验 (dataType/prop/必填字段)
* 4. constructConfigDetail 包装 save formdata
* 5. 调 loadVisualData.addObj 拿新大屏 id (镜像 web 端 addObj)
* 6. 调 loadVisualData.updateObj save (带 detail/component 的完整大屏)
* 7. release if --release (默认 ON)
*
* 镜像源:
* - jnpf/前端/jnpf-web-datascreen-vue3/src/page/group/header.vue:200-211 (save formdata)
* - jnpf/前端/jnpf-web-datascreen-vue3/src/api/visual.js: addObj/updateObj
*/
import { Command } from 'commander'
import { readFileSync, existsSync } from 'node:fs'
import { JnpfClient } from '../../core/client.ts'
import { installHelpHook } from '../../core/help.ts'
import { log, printJson } from '../../core/log.ts'
import { initWebapi, loadVisualData } from '../../webapi/visualdata.ts'
import { setupOutputFilter, addOutputOptions, wrapCommand } from '../_output_filter.ts' // v2.1+ 输出过滤; v2.2+ wrapCommand 收口 5c
import { DacliError } from '../../core/types.ts' // P5 (2026-07-21): 提升 L2 catch 分类
import { runCommandAutoFix, fetchExistingLists } from '../_auto_fix.ts' // v2.1+ (2026-07-21): 跨命令 auto-fix pipeline
import {
getBaseConfig,
listComponentProps,
getValidProps, // v0.15+ (P1-4): 镜像 web 端 dicOption.dataList 真值源
constructConfigDetail,
constructComponentJson,
NavEntryInput,
} from '../../webapi/datascreen.ts'
import { validateConstruct } from './_validate.ts'
interface ConstructOpts {
fullName: string
enCode: string
category: string
/** 内置模板: base = 空大屏 (默认 9 组件 demo) */
template?: string
/** 官方模板名 (Phase 5+ 扩展) */
fromTemplate?: string
/** 用户设计 JSON 文件 */
fromJson?: string
/** 组件 prop 多次, e.g. --prop=bar --prop=text */
prop?: string[]
/** 位置 (单次) — 多组件时用 --x/--y/--w/--h 全局默认, 单组件时直接用 */
x?: number
y?: number
w?: number
h?: number
/** 数据源类型 0-7 镜像 build.vue:666-689 */
dataType?: number
/** URL (dataType=1/3/5/6) */
url?: string
/** SQL (dataType=2) */
sql?: string
/** value (dataType=0/4) */
value?: string
/** 宽度 (写进 baseConfig) */
width?: number
/** 高度 (写进 baseConfig) */
height?: number
/** 缩略图 URL */
backgroundUrl?: string
/** 状态 0/1 (默认 1) */
status?: number
/** 只校验, 不创建 */
validateOnly?: boolean
/** 不发布 (默认 ON, 跳过发布) */
noRelease?: boolean
/** 原始 JSON 输出 */
json?: boolean
/** v2.1+ (2026-07-21): --verbose, addOutputOptions 注入 */
verbose?: boolean
}
export function buildBigscreenConstructCommand(): Command {
const cmd = new Command('construct')
.description('构造大屏 (v0.13+ 镜像 web 端 save formdata 镜像, 一键创建带组件的大屏)')
.requiredOption('--fullName <name>', '大屏名称 (镜像 web visual.js addObj: visual.title)')
.requiredOption('--enCode <code>', '大屏编码 (镜像 web visual.js addObj, ENCODE_REGEXP 校验)')
.requiredOption('--category <cat>', '分类: 1=数据大屏 2=仪表盘')
.option('--template <t>', '内置模板: base=空大屏 (默认 9 组件 demo)', 'base')
.option('--from-template <name>', '官方模板 (Phase 5+ 扩展, 暂等同 --template=base)')
.option('--from-json <file>', '用户设计 JSON (含 baseConfig + nav 两段)')
.option('--prop <name>', '组件 prop (多次: --prop=bar --prop=text)', (v, prev: string[]) => prev.concat(v), [])
.option('--x <n>', '组件 x 坐标 (单组件默认 0)', parseFloat)
.option('--y <n>', '组件 y 坐标 (单组件默认 0)', parseFloat)
.option('--w <n>', '组件宽度 (默认 400)', parseFloat)
.option('--h <n>', '组件高度 (默认 300)', parseFloat)
.option('--dataType <n>', '数据源类型 0-7 (镜像 build.vue:666-689)', parseInt)
.option('--url <u>', '数据源 URL (dataType=1/3/5/6)')
.option('--sql <s>', '数据源 SQL (dataType=2)')
.option('--value <v>', '数据源 value (dataType=0/4)')
.option('--width <n>', '大屏宽度 (默认 1920)', parseInt)
.option('--height <n>', '大屏高度 (默认 1080)', parseInt)
.option('--backgroundUrl <u>', '缩略图 URL (web visual.js put-file/screenShot 上传后回填)')
.option('--status <s>', '状态 0/1 (默认 1=已发布, --no-release 时无效)', '1')
.option('--validate-only', '只校验, 不创建', false)
.option('--no-release', '创建后不发布 (默认 ON 发布)', false)
addOutputOptions(cmd)
.action(async (opts: ConstructOpts) => {
// 输出过滤: 默认静默 (quiet mode), --verbose 走完整日志, --json 走原始 JSON
setupOutputFilter(opts)
const c = await JnpfClient.fromToken()
// v2.1+ (2026-07-21): 命令级 auto-fix pipeline (G-X1 启用 — 含 <appCode> 前缀建议)
const fixCtx = await fetchExistingLists(c, c.appCode)
const cmdFix = runCommandAutoFix(opts as unknown as Record<string, unknown>, fixCtx)
if (cmdFix.silent.length > 0) {
Object.assign(opts, cmdFix.opts)
}
await wrapCommand({
command: 'bigscreen construct',
appCode: c.appCode,
startTime: Date.now(),
verbose: opts.verbose,
json: opts.json,
fixes: [],
}, async (ctx) => {
try {
const summary = await runConstruct(opts)
ctx.success({
id: summary?.id,
enCode: summary?.enCode || opts.enCode,
validateOnly: summary?.validateOnly || false,
})
} catch (err) {
const errMsg = `构造失败: ${(err as Error).message}`
log.error(errMsg)
if (process.env.DACLI_DEBUG === '1') log.error(err)
ctx.fail(errMsg, { enCode: opts.enCode })
}
})
})
installHelpHook(cmd, {
purpose: '构造大屏 (v0.13+ 镜像 web 端 save formdata 镜像 + 内置模板/用户 JSON/单组件添加, 端到端一气呵成)',
required: {
'--fullName | --enCode | --category': '大屏基础信息 (跟 create 命令相同)',
},
optional: {
'--template=base': '内置空大屏模板 (默认 9 组件 demo)',
'--from-template=xxx': '官方模板 (Phase 5+ 扩展)',
'--from-json=design.json': '用户设计 JSON (含 baseConfig + nav 两段)',
'--prop=bar --prop=text ...': '单组件添加 (多次, 默认按 i*320 纵向堆叠)',
'--x --y --w --h': '组件位置 (默认 0/0/400/300)',
'--dataType=0-7': '数据源类型 (0=static 1=api 2=sql 3=ws 4=record 5=public 6=mqtt 7=node)',
'--url --sql --value': '数据源字段 (跟 dataType 配套)',
'--width --height': '大屏尺寸 (默认 1920x1080)',
'--backgroundUrl': '缩略图 (web put-file/screenShot 上传后回填)',
'--validate-only': '只校验不创建',
'--no-release': '跳过发布 (默认 ON 发布)',
},
example: [
'dacli bigscreen construct --template=base --fullName=销售大屏 --enCode=salesDash --category=1',
'dacli bigscreen construct --from-json=design.json --fullName=我的大屏 --enCode=myDash --category=1',
'dacli bigscreen construct --template=base --fullName=TC大屏 --enCode=tcDash --category=1 --prop=bar --prop=text --prop=map --prop=video --prop=table --dataType=1 --value="demo"',
'dacli bigscreen construct --template=base --fullName=API大屏 --enCode=apiDash --category=1 --prop=bar --dataType=1 --url=http://example.com/api',
'dacli bigscreen construct --from-json=design.json --fullName=预览 --enCode=preview --category=1 --validate-only',
],
source: {
web: 'jnpf/前端/jnpf-web-datascreen-vue3/src/page/group/header.vue:200-211 (save formdata) + src/api/visual.js: addObj/updateObj',
api: 'POST /api/blade-visual/visual/save (addObj) + POST /api/blade-visual/visual/update (updateObj)',
ref: 'dacli/docs/cmd-review/v0.13-webapi-form-workflow-refactor.md §8.2.4 阶段 5',
},
notes: [
'v0.13+ NEW (2026-07-01): 镜像 web 端 save formdata 一键构造大屏',
'Phase 1+2: getBaseConfig + getComponentDefaults + listComponentProps 镜像 option/config.js + option/components/*.vue',
'Phase 3: constructConfigDetail + constructComponentJson 镜像 header.vue:200-211 + build.vue:705-709',
'Phase 4: validateConstruct 镜像 build.vue:666-692 + 1040-1042 validProp',
'Phase 5: construct 命令整合, 支持 --template/--from-template/--from-json/--prop 四种入口',
'算法: getBaseConfig → constructComponentJson → validateConstruct → constructConfigDetail → addObj → updateObj → release',
'vs create 命令: create 只建空大屏 (走 web 端 addObj 默认 detail=JSON.stringify(config+name/width/height), component=[]);',
' construct 支持带组件 (--prop/--from-json), 走 addObj 拿 id + updateObj save 完整 formdata',
],
})
return cmd
}
async function runConstruct(opts: ConstructOpts): Promise<{ id?: string; enCode: string; validateOnly?: boolean } | undefined> {
// === step 1: 构造 baseConfig ===
let baseConfig = getBaseConfig()
if (opts.width) baseConfig.width = opts.width
if (opts.height) baseConfig.height = opts.height
// 镜像 web 端 addObj: detail = JSON.stringify(config + name/width/height)
baseConfig.name = opts.fullName
// === step 2: 构造 nav 数组 ===
let navInput: NavEntryInput[] = []
if (opts.fromJson) {
// 2a. 从 JSON 文件读取
if (!existsSync(opts.fromJson)) {
log.error(`--from-json 文件不存在: ${opts.fromJson}`)
throw new DacliError(`--from-json 文件不存在: ${opts.fromJson}`)
}
try {
const json = JSON.parse(readFileSync(opts.fromJson, 'utf-8'))
baseConfig = json.baseConfig ? { ...baseConfig, ...json.baseConfig } : baseConfig
navInput = json.nav || []
} catch (e) {
log.error(`--from-json 解析失败: ${(e as Error).message}`)
throw new DacliError(`--from-json 解析失败: ${(e as Error).message?.slice(0, 200)}`)
}
} else if (opts.prop && opts.prop.length > 0) {
// 2b. 从 --prop 多次构造
navInput = opts.prop.map((p, i) => ({
prop: p,
x: opts.x ?? 0,
y: opts.y ?? i * 320,
w: opts.w ?? 400,
h: opts.h ?? 300,
dataType: opts.dataType,
url: opts.url,
sql: opts.sql,
value: opts.value,
}))
} else {
// 2c. 内置模板: base = 9 组件 demo (镜像 web 设计器默认)
// 选择常见 9 组件覆盖: 柱状图/折线/饼图/文本/地图/视频/表格/轮播/iframe
// 默认用 dataType=0 (static) + value 字符串, 避免 url/sql 必填校验失败
navInput = [
{ prop: 'bar', x: 0, y: 0, w: 600, h: 360, dataType: 0, value: '[]' },
{ prop: 'line', x: 620, y: 0, w: 600, h: 360, dataType: 0, value: '[]' },
{ prop: 'pie', x: 1240, y: 0, w: 400, h: 360, dataType: 0, value: '[]' },
{ prop: 'text', x: 0, y: 380, w: 400, h: 100, dataType: 0, value: '示例大屏' },
{ prop: 'map', x: 420, y: 380, w: 600, h: 360, dataType: 0, value: '[]' },
{ prop: 'video', x: 1040, y: 380, w: 400, h: 220, dataType: 0, value: '' },
{ prop: 'table', x: 0, y: 760, w: 800, h: 280, dataType: 0, value: '[]' },
{ prop: 'iframe', x: 820, y: 760, w: 600, h: 280, dataType: 0, value: 'https://example.com' },
{ prop: 'swiper', x: 1440, y: 380, w: 480, h: 360, dataType: 0, value: '' },
]
}
const nav = constructComponentJson(navInput)
// === step 3: 校验 ===
// v0.15+ (P1-4): 优先用 getValidProps() (镜像 web 端 dicOption.dataList 30 个硬编码 + 动态)
// 兜底用 listComponentProps() (option/components/*.vue 目录扫描, 36 个但漏 code/imgList/rectangle)
let validProps: string[]
try {
validProps = getValidProps()
if (validProps.length === 0) throw new DacliError('empty')
} catch {
validProps = listComponentProps()
}
const validation = validateConstruct({
baseConfig,
nav: nav as unknown as Array<Record<string, unknown>>,
validProps,
})
if (validation.warnings.length > 0) {
for (const w of validation.warnings) log.warn(`⚠ ${w}`)
}
if (!validation.valid) {
log.error(`✗ 校验失败 (${validation.errors.length} 项):`)
for (const e of validation.errors) log.error(` - ${e}`)
throw new DacliError(`构造校验失败 (${validation.errors.length} 项): ${validation.errors.slice(0, 3).join('; ').slice(0, 200)}`)
}
log.ok(`✓ 校验通过 (${validProps.length} 有效 prop, ${nav.length} 组件)`)
if (opts.validateOnly) {
if (opts.json) {
printJson({ validated: true, baseConfig, nav })
} else {
log.info(`--validate-only 跳过创建`)
}
// v2.1+ (2026-07-21): 返回 validate-only summary (供 .action 落 CommandLog)
return { enCode: opts.enCode, validateOnly: true }
}
// === step 4: 包装 save formdata (镜像 header.vue:200-211) ===
const formdata = constructConfigDetail(baseConfig, nav as unknown as Array<Record<string, unknown>>, {
backgroundUrl: opts.backgroundUrl,
})
// === step 5: 创建大屏 (走 web 端 addObj) ===
const c = await JnpfClient.fromToken()
await initWebapi(c)
// 先 addObj 拿 id (web 端 addObj 走 /visual/save, body 包含 visual basic + config detail/component)
// 这里 addObj body 用 web 端 addObj 签名 (跟 create 命令一致, 拿 id 走 update 完整 formdata)
// FINDING-B1 (2026-07-02 audit): addParams 必含 enCode, 否则后端入库 enCode=null
// → list 检索不到, menu create 报"主表不存在"
const addParams = {
title: opts.fullName,
enCode: opts.enCode, // P0-4 修复: 必传 enCode
category: opts.category,
status: 0, // 先未发布, 拿 id 后 updateObj save 完整 formdata
password: '',
width: Number(opts.width) || 1920,
height: Number(opts.height) || 1080,
}
const addResp = (await loadVisualData.addObj(addParams)) as { data?: string | { id?: string } }
const data = addResp.data
let id: string | undefined
if (typeof data === 'string' && /^\d+$/.test(data.trim())) id = data.trim()
else if (data && typeof data === 'object') id = (data as { id?: string }).id
if (!id) {
log.error(`addObj 后端未返 id. raw=${JSON.stringify(addResp).slice(0, 200)}`)
throw new DacliError(`addObj 后端未返 id`)
}
log.ok(`✓ addObj 创建空大屏成功 id=${id}`)
// === step 6: updateComponent save 完整 formdata (镜像 header.vue:200-211 updateComponent) ===
// FINDING-B2 (2026-07-02 audit): 旧版用 updateObj(formdata) 错 (updateObj 会再包一层 {visual: data})
// 正确调用 updateComponent(formdata) — web 端 header.vue:200-211 save 按钮走的就是这个
formdata.visual.id = id
;(formdata.config as Record<string, unknown>).visualId = id
if (opts.backgroundUrl) {
(formdata.visual as Record<string, unknown>).backgroundUrl = opts.backgroundUrl
}
await loadVisualData.updateComponent(formdata)
log.ok(`✓ updateComponent save 完整 formdata 成功 (${nav.length} 组件已写入)`)
// === step 7: 发布 (默认 ON, 镜像 web release 改 status=1) ===
// 注: updateObj(data) → web 包成 {visual: data}, 所以传 visual 即可, 不要再包
if (!opts.noRelease) {
const info = (await loadVisualData.getObj(id)) as { data?: Record<string, unknown> }
const visual = info.data
if (visual) {
visual.status = 1
await loadVisualData.updateObj(visual) // ✓ 正确: web 包 {visual: visual} 跟 publish 行为一致
log.ok(`✓ 大屏已发布 (status=1)`)
} else {
log.warn(`⚠ 发布跳过: getObj 后端未返 visual`)
}
}
// === step 8: 输出 ===
if (opts.json) {
printJson({ id, enCode: opts.enCode, fullName: opts.fullName, componentCount: nav.length })
} else {
log.info(`✓ 大屏构造完成 id=${id} 名称=${opts.fullName} 编码=${opts.enCode} 组件数=${nav.length}`)
}
// v2.1+ (2026-07-21): 返回成功 summary (供 .action 落 CommandLog)
return { id, enCode: opts.enCode }
}