@microi.net/cli 4.6.2
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.
- package/LICENSE +21 -0
- package/README.md +66 -0
- package/dist/mcp-codex-stdio-adapter.js +189 -0
- package/dist/mcp-server.js +972 -0
- package/dist/mcp-trae-windows-launcher.cmd +21 -0
- package/dist/microi-cli-mcp.js +7 -0
- package/dist/microi-cli.js +1645 -0
- package/dist/microi-skills.meta.json +335 -0
- package/dist/microi.skills/.microi-skills-version.json +6 -0
- package/dist/microi.skills/README.md +276 -0
- package/dist/microi.skills/ai-engine/SKILL.md +140 -0
- package/dist/microi.skills/ai-engine/agents/openai.yaml +4 -0
- package/dist/microi.skills/app-store/SKILL.md +105 -0
- package/dist/microi.skills/app-store/agents/openai.yaml +4 -0
- package/dist/microi.skills/business-blueprint/SKILL.md +184 -0
- package/dist/microi.skills/datasource-engine/SKILL.md +89 -0
- package/dist/microi.skills/datasource-engine/agents/openai.yaml +4 -0
- package/dist/microi.skills/dos-orm/SKILL.md +76 -0
- package/dist/microi.skills/dos-orm/references/api-reference.md +229 -0
- package/dist/microi.skills/job-engine/SKILL.md +141 -0
- package/dist/microi.skills/job-engine/agents/openai.yaml +4 -0
- package/dist/microi.skills/message-notification/SKILL.md +113 -0
- package/dist/microi.skills/message-notification/agents/openai.yaml +6 -0
- package/dist/microi.skills/message-notification/references/contracts.md +99 -0
- package/dist/microi.skills/microi-ai-app-auth.js +651 -0
- package/dist/microi.skills/microi-ai-application/SKILL.md +80 -0
- package/dist/microi.skills/microi-ai-application/agents/openai.yaml +4 -0
- package/dist/microi.skills/microi-ai-application/references/frontend-baseline.md +164 -0
- package/dist/microi.skills/microi-client-frontend/SKILL.md +562 -0
- package/dist/microi.skills/microi-datasource-mapping/SKILL.md +108 -0
- package/dist/microi.skills/microi-db-schema/SKILL.md +170 -0
- package/dist/microi.skills/microi-db-schema/agents/openai.yaml +4 -0
- package/dist/microi.skills/microi-db-schema/references/core-tables.md +695 -0
- package/dist/microi.skills/microi-db-schema/references/form-component-options.md +256 -0
- package/dist/microi.skills/microi-db-schema/references/schema-overview.md +203 -0
- package/dist/microi.skills/microi-db-schema/references/schema.md +647 -0
- package/dist/microi.skills/microi-db-schema/references/table-catalog.md +1607 -0
- package/dist/microi.skills/microi-deployment/SKILL.md +117 -0
- package/dist/microi.skills/microi-deployment/references/deployment-matrix.md +94 -0
- package/dist/microi.skills/microi-docs-coverage/SKILL.md +91 -0
- package/dist/microi.skills/microi-docs-coverage/references/capability-map.md +65 -0
- package/dist/microi.skills/microi-docs-coverage/scripts/audit-doc-skill-coverage.mjs +887 -0
- package/dist/microi.skills/microi-form-engine/SKILL.md +159 -0
- package/dist/microi.skills/microi-form-engine/references/component-catalog.md +116 -0
- package/dist/microi.skills/microi-form-engine/references/data-source-events.md +117 -0
- package/dist/microi.skills/microi-form-layout/SKILL.md +373 -0
- package/dist/microi.skills/microi-frontend-sdk/SKILL.md +304 -0
- package/dist/microi.skills/microi-left-right-layout/SKILL.md +132 -0
- package/dist/microi.skills/microi-microservice/SKILL.md +115 -0
- package/dist/microi.skills/microi-microservice/references/runtime-delivery.md +145 -0
- package/dist/microi.skills/microi-mobile-app-quality/SKILL.md +436 -0
- package/dist/microi.skills/microi-solution-quotation/SKILL.md +76 -0
- package/dist/microi.skills/microi-solution-quotation/agents/openai.yaml +4 -0
- package/dist/microi.skills/microi-solution-quotation/scripts/build_solution_quote.py +296 -0
- package/dist/microi.skills/microi-system-delivery/SKILL.md +446 -0
- package/dist/microi.skills/microi-ui/SKILL.md +321 -0
- package/dist/microi.skills/microi-uniapp-frontend/SKILL.md +483 -0
- package/dist/microi.skills/microi.v8.js +1758 -0
- package/dist/microi.skills/module-engine/SKILL.md +131 -0
- package/dist/microi.skills/module-engine/references/module-config.md +174 -0
- package/dist/microi.skills/page-engine/SKILL.md +397 -0
- package/dist/microi.skills/performance-testing/SKILL.md +207 -0
- package/dist/microi.skills/playwright-e2e/SKILL.md +769 -0
- package/dist/microi.skills/print-engine/SKILL.md +237 -0
- package/dist/microi.skills/production-readonly-audit/SKILL.md +39 -0
- package/dist/microi.skills/report-engine/SKILL.md +69 -0
- package/dist/microi.skills/report-engine/agents/openai.yaml +4 -0
- package/dist/microi.skills/search-engine/SKILL.md +73 -0
- package/dist/microi.skills/search-engine/agents/openai.yaml +4 -0
- package/dist/microi.skills/spider-engine/SKILL.md +188 -0
- package/dist/microi.skills/translate-engine/SKILL.md +91 -0
- package/dist/microi.skills/translate-engine/agents/openai.yaml +4 -0
- package/dist/microi.skills/ui-design/SKILL.md +1575 -0
- package/dist/microi.skills/ui-design/assets/pattern-showcase/app.js +54 -0
- package/dist/microi.skills/ui-design/assets/pattern-showcase/index.html +163 -0
- package/dist/microi.skills/ui-design/assets/pattern-showcase/styles.css +311 -0
- package/dist/microi.skills/ui-design/assets/templates/MCI-DESIGN.md +98 -0
- package/dist/microi.skills/ui-design/references/design-pattern-library.md +171 -0
- package/dist/microi.skills/ui-design/references/mci-design-contract.md +84 -0
- package/dist/microi.skills/ui-design/references/motion-and-media.md +71 -0
- package/dist/microi.skills/ui-design/references/product-flow-recipes.md +94 -0
- package/dist/microi.skills/uniapp-mall-assets/SKILL.md +105 -0
- package/dist/microi.skills/v8-api-config/SKILL.md +272 -0
- package/dist/microi.skills/v8-cache-pattern/SKILL.md +286 -0
- package/dist/microi.skills/v8-crud-api/SKILL.md +398 -0
- package/dist/microi.skills/v8-debugging/SKILL.md +279 -0
- package/dist/microi.skills/v8-explorer-tree/SKILL.md +224 -0
- package/dist/microi.skills/v8-export-import/SKILL.md +590 -0
- package/dist/microi.skills/v8-file-upload/SKILL.md +497 -0
- package/dist/microi.skills/v8-formengine-http/SKILL.md +218 -0
- package/dist/microi.skills/v8-frontend-events/SKILL.md +349 -0
- package/dist/microi.skills/v8-frontend-events/references/bluetooth-print-api.md +107 -0
- package/dist/microi.skills/v8-frontend-events/references/bluetooth-print.md +185 -0
- package/dist/microi.skills/v8-http-integration/SKILL.md +379 -0
- package/dist/microi.skills/v8-image-processing/SKILL.md +187 -0
- package/dist/microi.skills/v8-image-processing/agents/openai.yaml +4 -0
- package/dist/microi.skills/v8-image-processing/references/api-reference.md +620 -0
- package/dist/microi.skills/v8-menu-buttons/SKILL.md +661 -0
- package/dist/microi.skills/v8-mongodb/SKILL.md +149 -0
- package/dist/microi.skills/v8-mq-mqtt/SKILL.md +227 -0
- package/dist/microi.skills/v8-saas-multi-tenant/SKILL.md +193 -0
- package/dist/microi.skills/v8-security/SKILL.md +417 -0
- package/dist/microi.skills/v8-sql-query/SKILL.md +290 -0
- package/dist/microi.skills/v8-table-event/SKILL.md +385 -0
- package/dist/microi.skills/v8-template-engine/SKILL.md +165 -0
- package/dist/microi.skills/v8-utilities/SKILL.md +79 -0
- package/dist/microi.skills/v8-utilities/references/client-api-index.md +136 -0
- package/dist/microi.skills/v8-utilities/references/platform-http-routes.md +80 -0
- package/dist/microi.skills/v8-utilities/references/server-api-index.md +129 -0
- package/dist/microi.skills/v8-workflow/SKILL.md +322 -0
- package/dist/microi.skills/workspace-conventions/SKILL.md +479 -0
- package/package.json +40 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: microi-form-engine
|
|
3
|
+
description: Microi 表单引擎设计与控件配置指南。用于创建或修改 diy_table、diy_field、表单组件、字段属性、选项/SQL/数据源引擎数据源、子表、关联表单、定制组件、表单布局和字段事件。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Microi 表单引擎设计
|
|
7
|
+
|
|
8
|
+
表单引擎同时驱动数据模型、表单、列表、模块、接口配置和工作流配置。处理“新增字段”
|
|
9
|
+
不能只做物理 `ALTER TABLE`:必须让 `diy_table`、`diy_field`、物理列、组件
|
|
10
|
+
Config/Data、菜单查询列与缓存保持一致。
|
|
11
|
+
|
|
12
|
+
平台创建 DIY 表时会自动加入 `DiyCommon.FixedDiyField` 定义的 Id、创建/更新时间、
|
|
13
|
+
创建人、租户等固定字段。业务 Manifest 不重复声明这些字段;读取 `db.json` 时也不能
|
|
14
|
+
因为 `_Fields` 只列出可配置字段,就误判物理表缺少固定字段。
|
|
15
|
+
|
|
16
|
+
## 必读参考
|
|
17
|
+
|
|
18
|
+
- 控件完整目录、推荐物理类型和选择规则:`references/component-catalog.md`
|
|
19
|
+
- 数据源、字段属性、事件与定制组件:`references/data-source-events.md`
|
|
20
|
+
- 表单分组与宽度:`../microi-form-layout/SKILL.md`
|
|
21
|
+
- 后端表单事件:`../v8-table-event/SKILL.md`
|
|
22
|
+
- 前端字段事件:`../v8-frontend-events/SKILL.md`
|
|
23
|
+
|
|
24
|
+
## 标准工作流
|
|
25
|
+
|
|
26
|
+
1. 先通过 `microi_get_db_schema` 读取目标租户的真实表、字段和菜单。
|
|
27
|
+
2. 从当前源码
|
|
28
|
+
`Microi.Client/src/views/form-engine/diy-field-component/diy-component-list.json`
|
|
29
|
+
核对控件名;官网页面可能含历史控件。
|
|
30
|
+
3. 新表用 `microi_create_table`;字段用 `microi_add_field`,不得直接写
|
|
31
|
+
`diy_field` 或执行临时 DDL。
|
|
32
|
+
4. 选项控件同时设置 `data/config`;关联控件明确保存字段和显示字段。
|
|
33
|
+
5. 字段多时设置 `diy_table.Tabs` 与字段 `Tab`;只有整行控件设置
|
|
34
|
+
`FormWidth=24`,普通字段省略。
|
|
35
|
+
6. 绑定菜单后补齐/允许平台推断列表列、搜索列、隐藏列、排序列、移动端列和默认排序。
|
|
36
|
+
7. 回读 `diy_field`、刷新 schema 缓存,再在真实新增/编辑/查看表单中验收。
|
|
37
|
+
|
|
38
|
+
## 物理类型底线
|
|
39
|
+
|
|
40
|
+
MCP 建模只使用:
|
|
41
|
+
|
|
42
|
+
- `varchar(N)`
|
|
43
|
+
- `mediumtext` / `longtext`
|
|
44
|
+
- `int` / `bigint`
|
|
45
|
+
- `decimal(18,N)`
|
|
46
|
+
|
|
47
|
+
日期时间用 `varchar(25)` 保存 `yyyy-MM-dd HH:mm:ss`,组件用 `DateTime`;
|
|
48
|
+
开关用 `int`。不得生成 `datetime/date/timestamp/float/double/boolean/bool/string/text/nvarchar`。
|
|
49
|
+
前端设计器 JSON 中的历史默认类型不能覆盖服务器建模规则。
|
|
50
|
+
|
|
51
|
+
## 选项字段
|
|
52
|
+
|
|
53
|
+
`Select`、`MultipleSelect`、`Radio`、`Checkbox` 没有数据源时会显示空选项:
|
|
54
|
+
|
|
55
|
+
```text
|
|
56
|
+
1|启用,0|禁用
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
推荐保存稳定 Key、显示可翻译 Label。修改 `Data/Config/KeyValue` 后必须
|
|
60
|
+
`microi_get_field_list` 回读,并执行 `microi_refresh_schema_cache`。
|
|
61
|
+
|
|
62
|
+
## `JoinForm` 与 `TableChild` 硬性判定
|
|
63
|
+
|
|
64
|
+
这两个控件都能在表单内显示另一张表,但数据关系和运行组件完全不同,生成表/字段前
|
|
65
|
+
必须先确定基数,不得因为名称里出现“关联”就默认使用 `JoinForm`。
|
|
66
|
+
|
|
67
|
+
| 判断项 | `JoinForm`(关联表单) | `TableChild`(子表) |
|
|
68
|
+
|---|---|---|
|
|
69
|
+
| 关系 | 当前记录关联**一个**独立目标记录,通常为 N:1 或 1:1 | 一条主表记录拥有 0..N 条明细,标准 1:N |
|
|
70
|
+
| 关系存储 | 主表字段保存目标记录 `Id` | **子表物理外键**保存主表 `Id`/指定主键值 |
|
|
71
|
+
| 界面 | 嵌入一张 `diy-form`,只展示/编辑一条目标记录 | 嵌入一张 `diy-table`,提供明细列表、分页及行级增删改 |
|
|
72
|
+
| 核心配置 | `Config.JoinForm.{TableId,TableName,JoinFieldName,FormMode,Id,_SearchEqual}` | `Config` 根节点的子表/菜单/外键 Id,加 `Config.TableChild` 运行选项 |
|
|
73
|
+
| 目标限制 | 目标表必须与当前表不同;相同则组件拒绝渲染 | 子表应是独立明细表,并通过外键限定到当前父记录 |
|
|
74
|
+
|
|
75
|
+
### 决策规则(强制)
|
|
76
|
+
|
|
77
|
+
- 需求出现“子表、明细、清单、条目、行项目、多个、若干条、记录列表”,且没有明确说明
|
|
78
|
+
“只关联一条已有记录”时,默认建模为 `TableChild`。
|
|
79
|
+
- 只要一条父记录可能有 0..N 条目标记录,或需要在父表单内列表、分页、新增、编辑、删除
|
|
80
|
+
多行,就必须用 `TableChild`。
|
|
81
|
+
- 只有主表保存一个目标记录 Id、并需要把该独立记录的完整表单嵌入当前表单时,才用
|
|
82
|
+
`JoinForm`。选择一条记录但无需嵌入完整表单时,优先 `OpenTable`/`Select`。
|
|
83
|
+
- 语义仍不明确时必须在任何 MCP 写入前询问基数;禁止静默退化为 `JoinForm`。
|
|
84
|
+
- 禁止把“明细”设计为主表 `XxxId + JoinForm`;禁止让 `JoinForm.TableId/TableName`
|
|
85
|
+
指向当前表;禁止把 1:N 外键放在主表。
|
|
86
|
+
- MCP 的组件枚举、Manifest 结构检查或 `dryRun` 即使通过,也不代表关系基数正确;AI 必须
|
|
87
|
+
单独执行本节语义门禁。
|
|
88
|
+
|
|
89
|
+
示例:
|
|
90
|
+
|
|
91
|
+
- “订单包含多个商品明细” → `order_detail.OrderId` + `TableChild`。
|
|
92
|
+
- “访客单包含多件携带物品” → `fk_carry_item.VisitId` + `TableChild`,不能用
|
|
93
|
+
`GuestId + JoinForm`,也不能把 `JoinForm` 指回 `fk_carry_item` 自己。
|
|
94
|
+
- “工单关联一个客户,并在工单内展开客户档案” → 主表 `CustomerId` + `JoinForm`。
|
|
95
|
+
|
|
96
|
+
### MCP 创建 `TableChild` 的两阶段流程
|
|
97
|
+
|
|
98
|
+
1. 创建主表和独立子表;在子表创建真实外键(如 `VisitId varchar(50)`)。
|
|
99
|
+
2. 在子表为回查创建租户组合索引(通常 `(OsClient, VisitId)`),索引写入 Manifest
|
|
100
|
+
`tables[].indexes`,并以 `microi_get_table_indexes` 回读。
|
|
101
|
+
3. 为子表创建绑定其 `diyTableId` 的隐藏 CRUD 菜单:`Display=0`、`AppDisplay=0`、
|
|
102
|
+
`HasChild=0`。
|
|
103
|
+
4. 回读真实的子表 `diy_table.Id`、子菜单 `sys_menu.Id` 与子表外键名后,再在主表
|
|
104
|
+
新增/更新 `Component=TableChild`、`FormWidth=24` 的配置字段。工具还不能在一次
|
|
105
|
+
Manifest 中解析这些新建 Id 时,必须分两阶段执行;禁止编造 Id 或改用 `JoinForm`。
|
|
106
|
+
5. `TableChild` 控件字段通常只是表单配置位,关系事实存放在子表外键。至少保存:
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
{
|
|
110
|
+
"TableChildTableId": "<子表 diy_table.Id>",
|
|
111
|
+
"TableChildSysMenuId": "<子表 sys_menu.Id>",
|
|
112
|
+
"TableChildSysMenuName": "携带物品明细",
|
|
113
|
+
"TableChildFkFieldName": "VisitId",
|
|
114
|
+
"TableChild": {
|
|
115
|
+
"PrimaryTableFieldName": "Id",
|
|
116
|
+
"Data": [],
|
|
117
|
+
"SearchAppend": {},
|
|
118
|
+
"ImportAutoFillFk": true,
|
|
119
|
+
"FieldRelations": [],
|
|
120
|
+
"LastTableId": "",
|
|
121
|
+
"LastSysMenuId": "",
|
|
122
|
+
"LastSysMenuName": "",
|
|
123
|
+
"DisablePagination": false,
|
|
124
|
+
"NoneDefaultHeight": false
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
`FieldRelations` 使用紧凑格式 `[["父表字段","子表字段",true?], ...]`。全部关系用于新增回写和导入回填;第三位 `true` 仅标记参与导入反查父表的关系。后端兼容旧三项配置,新版前端会合并去重并在字段下次保存时清除旧键。
|
|
130
|
+
|
|
131
|
+
`OpenTable` 用于弹出列表选择数据,固定授权范围用 `V8.OpenTableSetWhere`;`JoinTable`
|
|
132
|
+
用于展示关联集合,不能用前端拼接代替数据权限。
|
|
133
|
+
|
|
134
|
+
### 子表验收与复盘
|
|
135
|
+
|
|
136
|
+
- 回读主表字段、子表字段、隐藏子菜单和索引,确认配置中的表 Id、菜单 Id、外键名均真实存在。
|
|
137
|
+
- 用父记录 A 新增/编辑/删除多条子记录;打开父记录 B,确认 A 的数据不可见且不可越权操作。
|
|
138
|
+
- 新增主表尚无真实 Id 时,不得产生孤儿子记录;保存后重新打开仍能正确回显。
|
|
139
|
+
- 若曾误选组件,复盘必须记录:触发用语、误判基数、正确关系、应增加的生成前断言;通用结论
|
|
140
|
+
回写本节,不能只修一张业务表。
|
|
141
|
+
|
|
142
|
+
## 自定义组件边界
|
|
143
|
+
|
|
144
|
+
优先使用现有 44 类标准控件。只有标准控件无法表达交互、且该交互会长期复用时,
|
|
145
|
+
才使用 `DevComponent`:
|
|
146
|
+
|
|
147
|
+
- Vue 组件路径必须稳定并纳入 `Microi.Client` 源码/构建。
|
|
148
|
+
- 支持 Add/Edit/View、只读、必填、清空、校验、移动端和暗色主题。
|
|
149
|
+
- 不在组件内绕过 FormEngine 权限直接访问任意表。
|
|
150
|
+
- 复杂但租户独有的页面优先使用 MicroService + `V8.OpenAppDialog`,避免把客户逻辑打进主前端。
|
|
151
|
+
|
|
152
|
+
## 验收
|
|
153
|
+
|
|
154
|
+
- 物理列与 `diy_field` 一致,字段缓存已刷新。
|
|
155
|
+
- 新增、编辑、查看、列表、搜索、导入/导出至少覆盖适用场景。
|
|
156
|
+
- 选项显示 Label、保存 Key,回显和筛选一致。
|
|
157
|
+
- 子表新增/编辑/删除与父表外键正确,不能跨父记录串数据。
|
|
158
|
+
- PC 与移动端字段顺序、Tabs、整行控件无截断。
|
|
159
|
+
- 前端校验只改善体验;绕过前端直接 HTTP 提交时后端事件仍能阻止非法数据。
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# 表单组件目录
|
|
2
|
+
|
|
3
|
+
控件名称以
|
|
4
|
+
`Microi.Client/src/views/form-engine/diy-field-component/diy-component-list.json`
|
|
5
|
+
为当前事实源;物理类型以服务器/MCP 允许类型为准。
|
|
6
|
+
|
|
7
|
+
## 基础输入
|
|
8
|
+
|
|
9
|
+
| Component | 用途 | 推荐物理类型 |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| `Text` | 单行文本 | `varchar(200)` |
|
|
12
|
+
| `Guid` | GUID/只读标识 | `varchar(50)` |
|
|
13
|
+
| `Textarea` | 多行文本 | `mediumtext` |
|
|
14
|
+
| `NumberText` | 整数/金额/小数 | `int` 或 `decimal(18,2)` |
|
|
15
|
+
| `DateTime` | 日期时间选择 | `varchar(25)` |
|
|
16
|
+
| `Select` | 下拉单选 | `varchar(50)` |
|
|
17
|
+
| `MultipleSelect` | 下拉多选 | `varchar(500)` 或 `mediumtext` |
|
|
18
|
+
| `Radio` | 单选 | `varchar(50)` |
|
|
19
|
+
| `Checkbox` | 多选 | `varchar(500)` 或 `mediumtext` |
|
|
20
|
+
| `Switch` | 0/1 开关 | `int` |
|
|
21
|
+
| `Rate` | 评分 | `int` |
|
|
22
|
+
| `Progress` | 进度展示/输入 | `int` |
|
|
23
|
+
| `Slider` | 滑块 | `int` 或 `decimal(18,2)` |
|
|
24
|
+
| `ColorPicker` | 颜色 | `varchar(50)` |
|
|
25
|
+
| `AutoNumber` | 自动编号 | `varchar(200)` |
|
|
26
|
+
| `Button` | 表单动作按钮 | 通常 `varchar(50)`,不承载核心业务值 |
|
|
27
|
+
|
|
28
|
+
## 布局与内容
|
|
29
|
+
|
|
30
|
+
| Component | 用途 | 规则 |
|
|
31
|
+
|---|---|---|
|
|
32
|
+
| `Divider` | 分割线 | 布局字段,不进入关键查询 |
|
|
33
|
+
| `CollapseGroup` | 局部分组折叠 | 先读 `microi-form-layout` |
|
|
34
|
+
| `Tabs` | 字段级页签布局 | 整体多分区优先 `diy_table.Tabs` |
|
|
35
|
+
| `Alert` | 提示说明 | 不承载业务状态 |
|
|
36
|
+
| `StaticText` | 静态文本 | 不承载业务状态 |
|
|
37
|
+
| `Html` | 可信 HTML 展示 | 必须净化,不拼接不可信内容 |
|
|
38
|
+
| `RichText` | 富文本 | `mediumtext`;输出需净化 |
|
|
39
|
+
| `CodeEditor` | 代码/JSON/SQL 编辑 | `mediumtext`;通常 `FormWidth=24` |
|
|
40
|
+
| `JsonTable` | JSON 表格 | `mediumtext`;定义结构与大小上限 |
|
|
41
|
+
|
|
42
|
+
## 文件与高级输入
|
|
43
|
+
|
|
44
|
+
| Component | 用途 | 推荐物理类型 |
|
|
45
|
+
|---|---|---|
|
|
46
|
+
| `ImgUpload` | 图片上传 | `mediumtext` |
|
|
47
|
+
| `FileUpload` | 文件上传 | `mediumtext` |
|
|
48
|
+
| `Autocomplete` | 自动完成 | `varchar(200)` |
|
|
49
|
+
| `TagInput` | 标签集合 | `varchar(500)` 或 `mediumtext` |
|
|
50
|
+
| `Transfer` | 穿梭框多选 | `mediumtext` |
|
|
51
|
+
| `Cascader` | 级联选择 | `varchar(500)` |
|
|
52
|
+
| `Address` | 省市区地址 | `varchar(500)` |
|
|
53
|
+
| `Department` | 部门选择 | `varchar(50)` |
|
|
54
|
+
| `SelectTree` | 树形选择 | `varchar(50)` 或 `varchar(500)` |
|
|
55
|
+
| `TreeCheckbox` | 树形权限多选 | `mediumtext` |
|
|
56
|
+
|
|
57
|
+
## 关联、地图与扩展
|
|
58
|
+
|
|
59
|
+
| Component | 用途 | 关键约束 |
|
|
60
|
+
|---|---|---|
|
|
61
|
+
| `OpenTable` | 弹出列表选择 | 配置保存字段、显示字段和固定查询范围 |
|
|
62
|
+
| `JoinTable` | 关联集合展示 | 查询与权限在服务端完成 |
|
|
63
|
+
| `JoinForm` | 嵌入一个独立记录的完整表单 | 主表字段保存一个目标 Id;目标表不能与当前表相同 |
|
|
64
|
+
| `TableChild` | 主表内嵌 0..N 条明细列表 | 独立子表、子表真实外键、隐藏子菜单、回查索引 |
|
|
65
|
+
| `Map` | 点位 | `varchar(200)`/`mediumtext`,明确坐标格式 |
|
|
66
|
+
| `MapArea` | 区域 | `mediumtext`,限制点数/体积 |
|
|
67
|
+
| `Qrcode` | 二维码展示 | `varchar(500)` |
|
|
68
|
+
| `FontAwesome` | 图标选择 | `varchar(200)` |
|
|
69
|
+
| `DevComponent` | 主前端定制 Vue 控件 | 仅用于长期复用且标准控件无法满足的场景 |
|
|
70
|
+
|
|
71
|
+
### `JoinForm` 不是子表
|
|
72
|
+
|
|
73
|
+
- `JoinForm` 渲染 `diy-form`,通过 `Config.JoinForm.JoinFieldName` 从当前表单取出一个
|
|
74
|
+
目标记录 Id(也可用固定 `Id` / `_SearchEqual`),因此表达的是“这一条记录关联哪一条
|
|
75
|
+
独立记录”。当前表和目标表相同会被组件判为无效并拒绝渲染。
|
|
76
|
+
- `TableChild` 渲染 `diy-table`,通过 `Config.TableChildFkFieldName` 把子表列表限定在
|
|
77
|
+
当前父记录,并依赖 `TableChildTableId` 与 `TableChildSysMenuId` 完成列表和行级增删改。
|
|
78
|
+
- `TableChild` 控件字段通常不承担关系存储;真正的关系列位于子表,例如
|
|
79
|
+
`order_detail.OrderId`。不得创建主表 `DetailId` 后用 `JoinForm` 冒充明细。
|
|
80
|
+
- 生成前先问“一个父记录最多有几条目标记录”:答案可能大于 1 就选 `TableChild`;只有
|
|
81
|
+
明确恰好一个目标 Id 且需要嵌入完整目标表单时才选 `JoinForm`。不确定时先询问,不写入。
|
|
82
|
+
|
|
83
|
+
## 官网历史名称
|
|
84
|
+
|
|
85
|
+
中文官网可能仍展示 `PhoneSMS`、`Timeline` 等历史/业务扩展控件。生成新字段前
|
|
86
|
+
必须在当前 `diy-component-list.json`、目标租户 `diy_field.Component` 和实际客户端
|
|
87
|
+
中核对;未出现在当前控件清单的名称不得仅凭旧文档直接生成。
|
|
88
|
+
|
|
89
|
+
## 常用配置键
|
|
90
|
+
|
|
91
|
+
这些是 `diy_field.Config` 内的配置路径,不是可调用函数;保存后必须回读
|
|
92
|
+
`Config` 并刷新 Schema 缓存:
|
|
93
|
+
|
|
94
|
+
| 组件族 | 常用配置路径 |
|
|
95
|
+
|---|---|
|
|
96
|
+
| Textarea | `Textarea.DefaultRows` |
|
|
97
|
+
| TagInput | `TagInput.Placeholder`、`TagInput.Options`、`TagInput.MaxCount` |
|
|
98
|
+
| Transfer | `Transfer.LeftTitle`、`Transfer.RightTitle`、`Transfer.Filterable`、`Transfer.Options` |
|
|
99
|
+
| AutoNumber | `AutoNumber.DataRule`、`AutoNumber.CreateRule`,以及 `AutoNumberFixed`、`AutoNumberLength`、`AutoNumberFields` |
|
|
100
|
+
| Button | `Button.Type`、`Button.Icon`、`Button.Size`、`Button.PreviewCanClick`、`Button.RefreshTableAfterClick`、`Button.Loading`(`V8.FieldSet` 时使用 `Config.Button.Loading`) |
|
|
101
|
+
| Divider / StaticText | `Divider.Icon`、`StaticText.Content` |
|
|
102
|
+
| OpenTable | `OpenTable.BtnName`、`OpenTable.MultipleSelect`、`OpenTable.BeforeOpenV8`、`OpenTable.SubmitV8` |
|
|
103
|
+
| CodeEditor / JsonTable | `CodeEditor.Height`、`JsonTable.Columns`、`JsonTable.Columns[].Config` |
|
|
104
|
+
| JoinForm | `JoinForm.TableId`、`JoinForm.TableName`、`JoinForm.JoinFieldName`、`JoinForm.FormMode`、`JoinForm.Id`、`JoinForm._SearchEqual` |
|
|
105
|
+
| TableChild | Config 根节点的 `TableChildTableId`、`TableChildSysMenuId`、`TableChildFkFieldName`;`TableChild.PrimaryTableFieldName`(默认 `Id`)及分页/导入选项 |
|
|
106
|
+
| ImgUpload | `ImgUpload.Multiple`;导出时会按最大图片数展开列 |
|
|
107
|
+
|
|
108
|
+
其余选择、树、上传、关联和布局选项以当前字段设计器和
|
|
109
|
+
`microi-db-schema/references/form-component-options.md` 为事实源;不要凭旧截图
|
|
110
|
+
发明配置键。
|
|
111
|
+
|
|
112
|
+
## 宽度与重字段
|
|
113
|
+
|
|
114
|
+
- 普通 Text、Select、NumberText、DateTime 默认不写 `FormWidth`。
|
|
115
|
+
- Textarea、RichText、CodeEditor、JsonTable、上传、子表、地图、布局和定制组件通常 `FormWidth=24`。
|
|
116
|
+
- 列表默认隐藏上传、富文本、地图、子表、布局等重字段;按需在详情中加载。
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# 字段数据源、属性与事件
|
|
2
|
+
|
|
3
|
+
## 数据源类型
|
|
4
|
+
|
|
5
|
+
| 类型 | 适用场景 | 配置要点 |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| `Data` | 显示值和保存值相同的固定数组 | 适合少量稳定枚举 |
|
|
8
|
+
| `KeyValue` | 保存 Key、显示 Label | 推荐;便于翻译和状态演进 |
|
|
9
|
+
| `Sql` | 基于当前库的受控查询 | 参数化、限制条数、选择明确字段 |
|
|
10
|
+
| `DataSource` | 复用数据源引擎 | 使用稳定 DataSourceId/Key |
|
|
11
|
+
| `ApiEngine` | 复杂权限、跨表或外部数据 | 接口返回稳定的 Label/Value 字段 |
|
|
12
|
+
|
|
13
|
+
KeyValue 示例:
|
|
14
|
+
|
|
15
|
+
```text
|
|
16
|
+
draft|草稿,enabled|启用,disabled|禁用
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
对应核心语义:
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"DataSource": "KeyValue",
|
|
24
|
+
"SelectLabel": "Value",
|
|
25
|
+
"SelectSaveField": "Key"
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
动态 SQL 示例只选择必要字段并限制返回量:
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"DataSource": "Sql",
|
|
34
|
+
"Sql": "select Id,Name from biz_customer where Name like '%$Keyword$%' limit 0,20",
|
|
35
|
+
"SelectLabel": "Name",
|
|
36
|
+
"SelectSaveField": "Id",
|
|
37
|
+
"DataSourceSqlRemote": true
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
SQL 仍必须经过平台受控数据源;不要把用户文本拼成标识符或任意 SQL。复杂权限、
|
|
42
|
+
跨库或外部服务使用数据源引擎/接口引擎。
|
|
43
|
+
|
|
44
|
+
## 动态联动
|
|
45
|
+
|
|
46
|
+
字段值变化时可用前端 V8 更新另一个字段的数据源:
|
|
47
|
+
|
|
48
|
+
```javascript
|
|
49
|
+
if (V8.LoadMode === 'Design') return;
|
|
50
|
+
|
|
51
|
+
var result = await V8.FormEngine.GetTableData('biz_contact', {
|
|
52
|
+
_SelectFields: ['Id', 'Name'],
|
|
53
|
+
_Where: [['CustomerId', '=', V8.ThisValue]],
|
|
54
|
+
_PageIndex: 1,
|
|
55
|
+
_PageSize: 100
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
V8.FieldSet('ContactId', 'Data', result.Code === 1 ? result.Data : []);
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
前端联动不能替代后端权限和提交校验。
|
|
62
|
+
|
|
63
|
+
## 表单生命周期
|
|
64
|
+
|
|
65
|
+
| 配置 | 运行端 | 用途 |
|
|
66
|
+
|---|---|---|
|
|
67
|
+
| `InFormV8` | 前端 | 默认值、字段显隐、初始化交互 |
|
|
68
|
+
| `SubmitFormV8` | 前端 | 即时校验;HTTP 直调不会触发 |
|
|
69
|
+
| `SubmitBeforeServerV8` | 后端事务内 | 最终校验、加工、阻止提交 |
|
|
70
|
+
| `SubmitAfterServerV8` | 后端事务内 | 同事务联动其它表 |
|
|
71
|
+
| `OutFormV8` | 前端 | 关闭后刷新/跳转 |
|
|
72
|
+
| `DataFilterV8` | 后端 | 每行脱敏/展示加工 |
|
|
73
|
+
|
|
74
|
+
事件代码、版本和表单属性都必须从当前 `diy_table/diy_field` 回读。后端阻止提交:
|
|
75
|
+
|
|
76
|
+
```javascript
|
|
77
|
+
if (!V8.Form.Name) return { Code: 0, Msg: '名称不能为空' };
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## 字段属性
|
|
81
|
+
|
|
82
|
+
常用属性包括 `Visible`、`AppVisible`、`Required`、`Readonly`、`Data`、
|
|
83
|
+
`Config`、`FormWidth`、`TableWidth`、`Tab`、角色绑定和前端事件代码。
|
|
84
|
+
|
|
85
|
+
- 除非明确隐藏,`Visible=1`、`AppVisible=1`。
|
|
86
|
+
- 角色绑定只缩小界面可见性,不能代替服务器数据权限。
|
|
87
|
+
- 修改防抖编辑器/代码字段前必须刷新待保存值,避免最后一次输入未入库。
|
|
88
|
+
- `Data/Config` 修改后回读并刷新 schema 缓存。
|
|
89
|
+
|
|
90
|
+
## DevComponent 定制组件
|
|
91
|
+
|
|
92
|
+
定制组件至少处理:
|
|
93
|
+
|
|
94
|
+
- `value/modelValue` 的输入与变更通知;
|
|
95
|
+
- 当前字段模型、表单模型、表单模式和只读状态;
|
|
96
|
+
- 校验错误、清空、禁用、加载与销毁;
|
|
97
|
+
- Add/Edit/View 回显;
|
|
98
|
+
- PC、移动端和暗色主题;
|
|
99
|
+
- 组件内部请求的 Token/OsClient 传递与错误态。
|
|
100
|
+
|
|
101
|
+
定制组件需要修改并发布主前端。若只服务单一租户、包含多个字段或复杂页面,
|
|
102
|
+
优先创建 MicroService 页面,通过 `V8.OpenAppDialog` 与宿主交互。
|
|
103
|
+
|
|
104
|
+
历史 Options API 定制组件可通过宿主 facade 调用数据源引擎:
|
|
105
|
+
|
|
106
|
+
```javascript
|
|
107
|
+
this.Microi.DataSourceEngine.Run('customer_summary', { Id: customerId }, (result) => {
|
|
108
|
+
if (this.Microi.CheckResult(result)) {
|
|
109
|
+
this.summary = result.Data;
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
`Microi.DataSourceEngine.Run` 是回调式宿主接口,`Microi.CheckResult` 负责按
|
|
115
|
+
DosResult 约定判断并展示错误。组件卸载后要阻止迟到回调继续写状态;新页面
|
|
116
|
+
优先使用项目现有的组合式 facade,不要假定 `this.Microi` 在任意 Vue 组件中
|
|
117
|
+
都存在。
|