openxiangda-skill-kit 2.0.19 → 2.0.20
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/package.json +2 -2
- package/skills/openxiangda-v2/SKILL.md +2 -0
- package/skills/openxiangda-v2/references/development.md +3 -1
- package/skills/openxiangda-v2/references/frontend.md +27 -0
- package/skills/openxiangda-v2/references/interaction-patterns.md +2 -0
- package/skills/openxiangda-v2/references/product-design.md +2 -0
- package/skills/openxiangda-v2/references/testing.md +3 -1
- package/skills/openxiangda-v2/references/workflow-events.md +40 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "openxiangda-skill-kit",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.20",
|
|
4
4
|
"description": "OpenXiangda 2.0 中文 AI 技能的校验、分发与安装。",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"README.md"
|
|
18
18
|
],
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"openxiangda-devkit-core": "2.
|
|
20
|
+
"openxiangda-devkit-core": "2.8.0"
|
|
21
21
|
},
|
|
22
22
|
"devDependencies": {
|
|
23
23
|
"tsx": "4.23.12",
|
|
@@ -56,6 +56,8 @@ pnpm dlx openxiangda@__OPENXIANGDA_VERSION__ skill install --force
|
|
|
56
56
|
|
|
57
57
|
## 引导开发并持续记录
|
|
58
58
|
|
|
59
|
+
先选择页面归属:管理后台默认只面向 PC,普通管理/录入复用标准 CRUD 与 Shell,自定义报表和工具使用 admin React 页面及显式菜单;不因“自定义”就复制导航或改成 user 页面,也不为后台自动补移动适配。独立用户页与手机用户任务按实际需求设计,模板 `/home` 仅是占位。报表等专业交互主动检查已有依赖、评估成熟组件和开源库,图表优先评估 ECharts,记录选型理由及加载/销毁边界;细节见[前端](references/frontend.md)。交付需验证平台实际点击入口、根路径、后台菜单和登录返回,不能只验收直达业务链接。
|
|
60
|
+
|
|
59
61
|
每轮先读取当前 AppSpec 总纲、设计索引、相关能力、活动变更与契约,按稳定 ID 恢复已知事实、候选建议和未决项。设计文件相互引用而不重复定义规则;角色、权限、页面或入口范围改变时,同步受影响 PRD、旅程、交互、架构和 AC。具体工作法按需读取[产品设计](references/product-design.md)。
|
|
60
62
|
|
|
61
63
|
总纲维护领域与模型关系、PC/移动任务页面、页面/操作/行/字段权限、多角色组合和容量预算。新增功能先评估影响,普通 CRUD、流程、消息等复用平台能力。明确数据量、分页/索引、请求次数、并发/批量和延迟目标,避免无界全量读取、逐行请求与无限重试。
|
|
@@ -20,7 +20,9 @@
|
|
|
20
20
|
## 选择平台能力 {#capabilities}
|
|
21
21
|
|
|
22
22
|
- 普通数据管理:通过 `defineDataModel`、`defineApplicationModule` 和显式 CRUD 视图声明;模型不自动生成菜单或写权限。
|
|
23
|
-
- PC
|
|
23
|
+
- 管理后台默认仅 PC:先复用平台 Shell、标准 CRUD 和字段;自定义报表/工具使用 admin 页面与显式导航,不为后台自动创建移动副本。详见[页面归属](frontend.md#surface-selection)。
|
|
24
|
+
- 用户页面按实际旅程选择独立 PC/移动布局,手机端只覆盖已确认的用户任务。
|
|
25
|
+
- 图表等专业交互先检查已有依赖,再评估成熟组件或开源库;报表优先评估 ECharts,记录选型理由和加载/销毁边界。详见[组件选型](frontend.md#component-selection)。
|
|
24
26
|
- 无平台账号的外部表单:使用[匿名公开访问](public-access.md),不用普通 RBAC 角色冒充匿名主体。
|
|
25
27
|
- 标准审批、待办与通知:按需声明平台能力,见[工作流](workflow-events.md)。
|
|
26
28
|
- 真实事务或外部集成:使用[按需后端](backend.md),不为每张表重写 CRUD 控制器。
|
|
@@ -12,6 +12,33 @@
|
|
|
12
12
|
|
|
13
13
|
不维护 Umi/Pro 双栈,也不在新模板中依赖已退休的前端框架包或旧身份 Provider。
|
|
14
14
|
|
|
15
|
+
## 先选页面归属,再写布局 {#surface-selection}
|
|
16
|
+
|
|
17
|
+
管理后台默认只面向 **PC 操作**。数据管理、后台录入和管理报表优先使用平台标准 Shell;无需为后台创建移动页面、响应式手机布局或移动验收任务。
|
|
18
|
+
|
|
19
|
+
| 任务 | 页面与组件起点 |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| 简单管理列表、表单、详情 | 显式标准 CRUD,使用平台字段与默认外观 |
|
|
22
|
+
| 后台自定义报表、批量工具、跨模型操作 | `surface: 'admin'` 的 React 页面,路径 `/admin/operations/...`,通过 `adminOperationPage` 加入菜单 |
|
|
23
|
+
| 独立门户、申请或用户任务 | 按实际旅程选择 `surface: 'user'`,拥有独立布局 |
|
|
24
|
+
| 确有手机使用需求的用户任务 | 独立移动 user 页面,使用 `openxiangda/mobile` 和 Field Kit |
|
|
25
|
+
|
|
26
|
+
“自定义页面”可以直接放在标准后台内。应用只编写内容,runtime 自动套用唯一 Shell;不要因为要画图表就复制顶栏、侧栏、Router 或改成 user 页面。模板 `/home` 是独立用户页占位,不能不经页面选型就当作业务默认入口。
|
|
27
|
+
|
|
28
|
+
后台菜单的分组、名称、顺序、图标由 `frontend.admin.navigation` 配置;标准视图控制字段与操作,工具栏/行/详情有动作插槽,自定义 React 内容通过 contributions 接入。当前没有整套后台 Shell 的替换接口。用户需要独立产品布局时选择 user surface,普通后台报表无需更换外壳。
|
|
29
|
+
|
|
30
|
+
应用根路径由生成的 `routeManifest.rootEntry` 分流;`/admin` 根据当前用户可访问的显式菜单选择后台首页。交付时分别核验平台应用列表入口、根路径、后台入口和业务深链接。无后台菜单不能解释为缺少模型;没有管理后台的用户应用也不需要为了消除空状态伪造 CRUD 页面。
|
|
31
|
+
|
|
32
|
+
## 按场景选择成熟组件与开源库 {#component-selection}
|
|
33
|
+
|
|
34
|
+
实现专业交互前先检查项目已有依赖,再选择合适的成熟组件或开源库,不默认手写替代品,也不把所有推荐库预装进模板。
|
|
35
|
+
|
|
36
|
+
- 普通业务字段优先 Field Kit,后台通用控件使用 Ant Design;记录数等单值指标可使用标准统计组件。
|
|
37
|
+
- 分类、趋势、分布等报表图表优先评估 **ECharts**。按需要引入图表、组件和渲染器,图表页面按需加载,容器变化时 resize,卸载时 dispose;用同一筛选条件的服务端聚合结果绘图,不以当前分页数据冒充总体。
|
|
38
|
+
- 编辑器、日历、复杂拖拽等专业功能先评估现有组件和成熟库,平台能力仍唯一拥有数据与权限。选型考虑当前 React/构建兼容性、维护情况、许可证、所需交互、包体积与可访问性。
|
|
39
|
+
|
|
40
|
+
在页面设计或实现说明中写清选用组件、理由与必要边界。已有需求内的技术选型由开发者完成,无需让用户逐个指定依赖。ECharts 的按需导入方式见[官方说明](https://echarts.apache.org/handbook/en/basics/import/);后台无需为图表增加手机适配,用户移动图表只按已确认需求处理。
|
|
41
|
+
|
|
15
42
|
## 数据和权限
|
|
16
43
|
|
|
17
44
|
`modules/` 中的业务模型由编译器派生 DataResource 契约,`openxiangda.config.ts` 声明页面
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
## 标准管理页面 {#admin}
|
|
6
6
|
|
|
7
|
+
管理后台默认仅 PC,不要求手机适配或移动验收。自定义报表和工具也优先放进同一后台 Shell,通过声明增加菜单;图表选型见[成熟组件与开源库](frontend.md#component-selection)。只有实际用户端需求才采用下文的独立 PC 或移动模式。
|
|
8
|
+
|
|
7
9
|
适用于管理员维护独立业务对象。显式选择 CRUD 视图,沿用 Field Kit、Ant Design 与组件默认外观。页面优先呈现标题、主要新建入口、常用筛选、列表与行操作;复杂筛选按需展开。列按办理任务选择,记录默认排序、分页上限、空值/长文显示与操作条件。辅助模型无需独立导航。
|
|
8
10
|
|
|
9
11
|
列表进入详情再返回时明确关键词、筛选、页码、选择范围与位置是否保留;批量操作说明当前页/已选记录范围,确认内容包含实际对象及影响。新建和编辑复用字段规则,失败定位到字段并保留其他输入。删除只在业务明确需要时提供,由服务端权限和业务约束最终裁定。
|
|
@@ -64,6 +64,8 @@ AppSpec 是唯一设计记录位置。`app.md` 是总纲与目录,详细规则
|
|
|
64
64
|
|
|
65
65
|
页面必须记录初始加载、刷新、首次空数据、筛选无结果、错误、无权限、提交中、成功、明确失败、结果未知及并发冲突的适用性。公共状态可引用共用设计,逐页写差异;不适用时写具体理由。详细逐页检查与标准方案见[交互模式](interaction-patterns.md)。
|
|
66
66
|
|
|
67
|
+
管理后台默认只在 PC 操作,页面规格写明“后台仅 PC,移动不适用”即可,不为材料完整度扩出手机后台。只有用户端有明确手机任务时才设计对应移动页面。页面设计同时选择标准 CRUD、后台自定义页或独立 user 页;报表等专业交互应主动评估成熟组件与开源库,按[前端选型](frontend.md#component-selection)记录选择与理由。
|
|
68
|
+
|
|
67
69
|
## AppSpec 材料模板 {#templates}
|
|
68
70
|
|
|
69
71
|
应用资料放在 `product/`(来源与 PRD)、`experience/`(旅程和逐页规格)、`design/`(视觉、权限和架构)、`reviews/`(评审)下。它们都是 `appspec/` 内单层 Markdown;不要使用嵌套页面目录。只为实际需要的材料建文件,不复制一批“已确认”示例。
|
|
@@ -28,7 +28,9 @@ CI、离线开发或尚未发布的候选包使用 `pnpm openxiangda check --loc
|
|
|
28
28
|
|
|
29
29
|
Web 默认保留开发服务回环访问检查。按需 Nest 使用 `tsx --test` 发现项目中的业务测试;没有用例时只有零项测试,不能当成业务已验收。浏览器目录 `apps/web/e2e/` 起初只有编写说明,添加本应用的 `*.spec.ts` 后运行 `pnpm test:e2e`;真实角色验收绑定 AppSpec 和指定测试版本。
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
修改资源时验证声明、实际交付端的字段语义及受影响的新增、详情、修改、删除、筛选、导出和版本冲突。管理后台默认仅 PC,不要求移动后台验收;只有已确认的用户移动页面需要验证移动交互。用允许角色验证成功,用禁止角色验证页面、操作、行和字段边界;存储值及审计应符合声明。平台内部的数据库和性能回归由平台维护者负责,应用不重复搭建平台数据库测试。
|
|
32
|
+
|
|
33
|
+
应用入口或导航变更必须从平台应用列表实际点击进入,再验证应用根路径、登录返回和刷新后的深链接。使用后台的应用检查 `/admin` 进入首个有权菜单、自定义页只出现一个 Shell、菜单切换与未保存保护、无权限拒绝;纯用户应用验证其声明首页,不强制增加后台。直达开发者给出的 `/home` 或报表链接通过,不能替代平台实际入口验收。
|
|
32
34
|
|
|
33
35
|
只改文案时验证受影响页面。复杂事务、并发和值转换使用聚焦测试。浏览器验收实际操作并检查错误,不能用模拟响应或空页面加载代替真实角色验收。
|
|
34
36
|
|
|
@@ -18,6 +18,46 @@
|
|
|
18
18
|
权限、记录修订约束、文件引用、日期触发和流程命令继续生效,自定义 `emitEvent`
|
|
19
19
|
也不受该策略影响。策略通过正常应用版本发布、测试和生产晋级生效。
|
|
20
20
|
|
|
21
|
+
## 平台原生数据自动化
|
|
22
|
+
|
|
23
|
+
只涉及平台表单数据增删改的自动化,可以直接声明 `execution`,无需应用 Nest
|
|
24
|
+
服务和事件 HTTP 接收器。需要平台 `events.native-data-actions` 1.0.0 能力。
|
|
25
|
+
例如已声明 `items`、`copies` 模型及相应字段后:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
events: {
|
|
29
|
+
capturePolicies: [
|
|
30
|
+
{ resourceCode: 'items', mode: 'subscribed' },
|
|
31
|
+
{ resourceCode: 'copies', mode: 'subscribed' },
|
|
32
|
+
],
|
|
33
|
+
subscriptions: [{
|
|
34
|
+
code: 'copy-item',
|
|
35
|
+
eventTypes: ['openxiangda.data.record.created.v2'],
|
|
36
|
+
filter: { resourceCodes: ['items'] },
|
|
37
|
+
execution: {
|
|
38
|
+
kind: 'native-data', version: 1,
|
|
39
|
+
operations: [{
|
|
40
|
+
operation: 'create', resourceCode: 'copies',
|
|
41
|
+
data: {
|
|
42
|
+
name: { source: 'event', path: 'data.projection.name' },
|
|
43
|
+
sourceId: { source: 'event', path: 'data.recordId' },
|
|
44
|
+
},
|
|
45
|
+
}],
|
|
46
|
+
},
|
|
47
|
+
}],
|
|
48
|
+
},
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
编译器自动收集必需的事件字段并固定目标资源摘要。动作效果与执行结果同事务
|
|
52
|
+
提交,重复消息和人工重放使用同一个效果标记。更新、删除还必须映射 `id` 和
|
|
53
|
+
`expectedRevision`,冲突不会覆盖新数据。常量使用 `{ source: 'literal', value }`。
|
|
54
|
+
首版支持数据事件、明确的源资源、最多 16 个操作、每次最多 32 个映射字段和
|
|
55
|
+
64 KiB 输入,不执行脚本、SQL、HTTP 或应用代码。目标模型发生不兼容变化时停止
|
|
56
|
+
旧动作并报告错误;关闭并排空此类动作后才能回退到不支持该能力的平台镜像。
|
|
57
|
+
|
|
58
|
+
外部 Webhook 和自定义代码仍使用已有签名、回执、重试及接收端幂等协议,按至少
|
|
59
|
+
一次投递处理。轻量操作历史仍通过已有审计 API 查询,不依赖是否订阅了事件。
|
|
60
|
+
|
|
21
61
|
## 标准详情与当前用户入口
|
|
22
62
|
|
|
23
63
|
普通记录、流程记录、任务和实例复用同一详情框架。流程详情提供申请内容、审批历史和变更记录三个标签页;管理员在当前抽屉或页面中切换到普通表单编辑,直接保存并自动留下变更记录,审批结果保持不变。PC 子表在表格内编辑,父表提交时统一校验。
|