@lark-apaas/coding-steering 0.1.42 → 0.1.43-alpha.20260831015213
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 +6 -6
- package/steering/nestjs-react-fullstack/skills/coding-guide/SKILL.md +10 -9
- package/steering/nestjs-react-fullstack/skills/plugin-guide/SKILL.md +4 -9
- package/steering/nestjs-react-fullstack/skills/plugin-guide/references/plugin-coding-guide.md +9 -20
- package/steering/nestjs-react-fullstack/skills_local/coding-guide/SKILL.md +15 -18
- package/steering/nestjs-react-fullstack/skills_local/plugin-guide/SKILL.md +2 -6
- package/steering/nestjs-react-fullstack/skills_local/plugin-guide/references/plugin-coding-guide.md +9 -20
package/package.json
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lark-apaas/coding-steering",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.43-alpha.20260831015213",
|
|
4
4
|
"description": "Stack-specific steering content for miaoda-coding templates",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
7
7
|
"steering"
|
|
8
8
|
],
|
|
9
|
+
"scripts": {
|
|
10
|
+
"lint:md": "markdownlint 'steering/**/*.md' --ignore 'steering/**/skills/**' --ignore 'steering/**/skills_common/**' --ignore 'steering/**/skills_local/**'"
|
|
11
|
+
},
|
|
9
12
|
"devDependencies": {
|
|
10
13
|
"markdownlint-cli": "^0.47.0"
|
|
11
14
|
},
|
|
@@ -17,8 +20,5 @@
|
|
|
17
20
|
"miaoda",
|
|
18
21
|
"coding-steering"
|
|
19
22
|
],
|
|
20
|
-
"license": "MIT"
|
|
21
|
-
|
|
22
|
-
"lint:md": "markdownlint 'steering/**/*.md' --ignore 'steering/**/skills/**' --ignore 'steering/**/skills_common/**' --ignore 'steering/**/skills_local/**'"
|
|
23
|
-
}
|
|
24
|
-
}
|
|
23
|
+
"license": "MIT"
|
|
24
|
+
}
|
|
@@ -155,7 +155,7 @@ shared/ # 前后端共享的目录
|
|
|
155
155
|
|
|
156
156
|
## 依赖使用规范
|
|
157
157
|
|
|
158
|
-
1. **子包完整性检查**:部分库有多个子包(如 `@
|
|
158
|
+
1. **子包完整性检查**:部分库有多个子包(如 `@radix-ui/react-*` 系列每个组件都是独立子包),添加 import 后必须确认 package.json 中包含所有需要的子包
|
|
159
159
|
2. 用法不清时查看 readme,可进一步搜索或网页访问获取信息
|
|
160
160
|
|
|
161
161
|
## 文件命名约定
|
|
@@ -569,6 +569,8 @@ async createArticle(@Req() req: Request, @Body() dto: CreateArticleDto) {
|
|
|
569
569
|
{% if projectMeta['flags']['supportTiptapAndStreamdown'] %}
|
|
570
570
|
- **富文本**: `business-ui/tiptap-editor`(阅读 README.md)
|
|
571
571
|
- **Markdown 渲染**: `components/ui/streamdown`(内置 prose 排版)
|
|
572
|
+
{% else %}
|
|
573
|
+
- **Markdown 渲染**: `components/ui/markdown`(react-markdown + remark-gfm,内置 prose 排版)
|
|
572
574
|
{% endif %}
|
|
573
575
|
|
|
574
576
|
## API 请求
|
|
@@ -606,6 +608,8 @@ import { axiosForBackend } from '@lark-apaas/client-toolkit/utils/getAxiosForBac
|
|
|
606
608
|
{% if projectMeta['flags']['supportTiptapAndStreamdown'] %}
|
|
607
609
|
| TiptapEditorComplete | `business-ui/tiptap-editor` | 富文本编辑器 |
|
|
608
610
|
| Streamdown | `components/ui/streamdown` | Markdown/流式渲染 |
|
|
611
|
+
{% else %}
|
|
612
|
+
| Markdown | `components/ui/markdown` | Markdown 渲染(react-markdown + remark-gfm) |
|
|
609
613
|
{% endif %}
|
|
610
614
|
|
|
611
615
|
### 组件 Skill 召回规则(强制执行)
|
|
@@ -769,15 +773,12 @@ return <h1>{data?.title || '未知标题'}</h1>;
|
|
|
769
773
|
| 验证 | zod |
|
|
770
774
|
| 工具函数 | lodash |
|
|
771
775
|
| 样式 | clsx |
|
|
772
|
-
|
|
|
773
|
-
| PDF 导出 | jspdf + html2canvas(**仅前端实现,禁止服务端实现**) |
|
|
774
|
-
| 文件上传 | react-dropzone |
|
|
775
|
-
| 二维码 | qrcode.react |
|
|
776
|
+
| 文件上传 | 原生 `<input type="file">`,用 shadcn 组件封装样式 |
|
|
776
777
|
| 用户反馈 | sonner |
|
|
777
|
-
|
|
|
778
|
-
|
|
|
779
|
-
|
|
780
|
-
|
|
778
|
+
| 数字动画 | `requestAnimationFrame` 手写,或 framer-motion 的 `animate` |
|
|
779
|
+
| Base64 | 原生 `atob`/`btoa`(Unicode 内容先经 `TextEncoder`/`TextDecoder`);服务端用 `Buffer` |
|
|
780
|
+
|
|
781
|
+
> Excel 解析、PDF 导出、二维码、拖拽、3D 场景等能力已随依赖瘦身不再预装(xlsx、jspdf、html2canvas、qrcode.react、@dnd-kit、react-dropzone、react-countup、js-base64、cobe 已从模板移除)。确有此类需求时,先在 package.json 显式添加所需依赖并安装,再编写代码。
|
|
781
782
|
|
|
782
783
|
## 滚动分页最佳实践
|
|
783
784
|
|
|
@@ -20,7 +20,6 @@ gate-tools:
|
|
|
20
20
|
| 获取运行时投影 | 调用 `get_plugin_ai_json(pluginInstanceId)` |
|
|
21
21
|
| Client 侧调用 | `capabilityClient.load(id).call(actionKey, input)`(流式用 `callStream`) |
|
|
22
22
|
| Server 侧调用(仅兜底) | `capabilityService.load(id).call(actionKey, input)` |
|
|
23
|
-
| 长耗时 AI 结果 | 大体量/多字段/多份/多语言/文件或多模态串联等结构信号命中时,优先前端 `callStream` 渐进展示;需保存则流式结束后复用 CRUD 落库;仅在 Client 侧无法满足时使用后端任务记录 + 状态查询 + 结果读取;禁止单个 HTTP 请求等待完整结果后才返回 |
|
|
24
23
|
| capabilityClient 导入 | `import { capabilityClient } from '@lark-apaas/client-toolkit'` |
|
|
25
24
|
| CapabilityService 导入 | `import { CapabilityService } from '@lark-apaas/fullstack-nestjs-core';` |
|
|
26
25
|
|
|
@@ -71,7 +70,6 @@ gate-tools:
|
|
|
71
70
|
- 必须先调 `get_plugin_ai_json(pluginInstanceId)`,再产出 **Schema 摘录卡**(格式见 `references/plugin-coding-guide.md`);摘录卡字段缺失禁止编码,`output.fields` 必须完整列出且每个输出字段在代码中被消费(持久化或展示)
|
|
72
71
|
- 按 `actions[].key` 选 actionKey;严格按 `inputSchema` 构造入参(`type: array` 字段必须传数组)、按 `outputSchema` 解析出参——流式 chunk 是**对象**(按字段解构如 `chunk.content`,禁止当字符串拼接),非流式同理按字段名读取;**务必阅读并遵循 `readme`**
|
|
73
72
|
- 调用侧:优先 Client(`unary` → `call()`,`stream` → `callStream()`);触发器/定时任务、敏感凭证、强事务、结果需落库 → Server 侧
|
|
74
|
-
- 高耗时 AI capability 闸门:若运行时投影或功能设计显示输出规模大、输出字段多、需要多份结果、多语言/长文本、文件或多模态输入后继续生成、多个 capability 串联、或结果需后续查看/落库,禁止把完整生成放进一个同步 HTTP 请求等待;能由前端承接时优先 `callStream` 渐进展示,需保存则流式结束后复用 CRUD 落库;仅在 Client 侧无法满足时后端创建任务记录后快速返回、由前端短轮询状态/结果,或拆成多个独立小调用
|
|
75
73
|
4. **代码放置**:Client(默认,用户交互触发)→ `client/` 组件/hooks;Server(兜底)→ `server/` Service。
|
|
76
74
|
5. **真实调用冒烟(完成前必须)**:至少成功调用一次 `call()` 或 `callStream()`(按 outputSchema 读 chunk);失败日志含最小字段(字段清单见 `references/plugin-coding-guide.md`)。无冒烟结果不得宣告完成。
|
|
77
75
|
|
|
@@ -138,9 +136,6 @@ const structured = await capabilityClient
|
|
|
138
136
|
├── 输出包含多个独立字段(标题+正文+评分等)
|
|
139
137
|
│ → 拆成多个独立插件并行调用(⭐ 优先)或用 ai-text-to-json
|
|
140
138
|
│ → ⛔ 禁止用 ai-text-generate + 正则/split 解析多字段
|
|
141
|
-
├── 输出规模大(多份结果、多语言、长正文、多章节或批量对象)
|
|
142
|
-
│ → 优先拆分为多个独立生成单元;需要汇总持久化时使用任务状态模型承接
|
|
143
|
-
│ → ⛔ 禁止一个后端 HTTP 请求同步等待所有生成结果后才响应
|
|
144
139
|
└── 输出为单一文本(仅展示,不需解析)→ ai-text-generate
|
|
145
140
|
```
|
|
146
141
|
|
|
@@ -208,9 +203,9 @@ const structured = await capabilityClient
|
|
|
208
203
|
|
|
209
204
|
1. **禁止静默吞异常**:每个 `catch` 至少满足其一——向用户展示错误(toast/页面状态),或触发补偿机制(重试/降级/记录待处理列表)
|
|
210
205
|
2. **异步操作必须有终态**:不阻塞主流程的插件调用须在 DB 维护状态(pending → success/failed),前端必须展示 failed,不能永远 loading
|
|
211
|
-
3.
|
|
212
|
-
4.
|
|
213
|
-
5.
|
|
206
|
+
3. **通知类插件失败必须有补偿**:如 `send-feishu-message` 失败,至少记录"待发送"列表或 UI 提示"通知发送失败,请手动联系"
|
|
207
|
+
4. **配置完整性(load 前必查)**:`load(id)` 前确认实例已创建且 id 与代码完全匹配,否则抛 `CapabilityNotFoundError`(开发态 Top 错误);load/call 失败时停止后续请求避免放大错误;**缓存 load 结果**,同一 id 不重复 load
|
|
208
|
+
5. **线上/客户反馈的插件问题先查 runtime log 取证**:用户反馈「线上 / 已发布」的插件问题(飞书消息发不出 / 插件不生效 / capability 调用「用户收不到」)时,**先查线上 runtime log 再定位代码**——用 `miaoda observability log`(必要时 `trace`)看 CapabilityService 真实错误、plugin_key、action、必填参数/输入校验错误,拿到线上 ERROR/WARN 再读代码修复。**即使你已在代码里读到一个疑似原因,也不得据此直接下根因、跳过取证**——静态代码里的可疑点常不是运行时真正的失败点(线上真错误多为运行时入参为空 / 校验失败 / 授权态问题,代码静态看不出),runtime log 是这类问题下结论前的必经步。沙箱 `read_logs` 只覆盖 dev 态,**不能**作为「线上插件无错误」的证据;纯本地 dev 态插件报错仍用 `read_logs`
|
|
214
209
|
|
|
215
210
|
## 缓存与幂等性
|
|
216
211
|
|
|
@@ -245,7 +240,7 @@ const structured = await capabilityClient
|
|
|
245
240
|
|
|
246
241
|
### 通知接收人动态解析
|
|
247
242
|
|
|
248
|
-
接收人(`receiverUserList`/`receiverGroupList` 等)按角色/条件变化时,必须实时查询角色成员经 `input` 传入(角色/成员的运行时查询写法见 `authz-guide` 技能),禁止硬编码或凭经验拼装 ID。如引入缓存,必须提供显式失效手段(如角色变更时清缓存)并明示 TTL,禁止无失效手段的常驻缓存导致接收人信息过期。通知发送失败的补偿要求见上文「插件调用错误处理」第
|
|
243
|
+
接收人(`receiverUserList`/`receiverGroupList` 等)按角色/条件变化时,必须实时查询角色成员经 `input` 传入(角色/成员的运行时查询写法见 `authz-guide` 技能),禁止硬编码或凭经验拼装 ID。如引入缓存,必须提供显式失效手段(如角色变更时清缓存)并明示 TTL,禁止无失效手段的常驻缓存导致接收人信息过期。通知发送失败的补偿要求见上文「插件调用错误处理」第 3 条铁律,不重复展开。
|
|
249
244
|
|
|
250
245
|
## 飞书深链 URL 规范
|
|
251
246
|
|
package/steering/nestjs-react-fullstack/skills/plugin-guide/references/plugin-coding-guide.md
CHANGED
|
@@ -2,19 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
### 核心原则:根据场景选择调用侧
|
|
4
4
|
|
|
5
|
-
**默认优先在 Client 侧调用 capabilityClient
|
|
6
|
-
|
|
7
|
-
**高耗时 AI capability 先判调用形态**:只要输出规模大、输出字段多、需要多份结果、多语言/长文本、文件或多模态输入后继续生成、多个 capability 串联、或结果需后续查看/落库,就不得把完整 AI 结果塞进一个同步 HTTP 请求等待。能由前端承接时,优先用前端 `callStream` 渐进展示,并在流式结束后按需复用已有 CRUD 接口保存结果;只有 Client 侧无法满足(触发器/敏感凭证/强事务/必须由后端保证落库一致性等)时,才采用后端任务记录 + 状态/结果查询,避免把后台任务作为默认方案。
|
|
8
|
-
|
|
5
|
+
**默认优先在 Client 侧调用 capabilityClient;但当插件结果需要持久化到数据库时,应考虑在 Server 侧调用或确保前端调用后及时通过后端接口保存。**
|
|
9
6
|
**严禁** import { capabilityClient } from '@lark-apaas/client-capability'。
|
|
10
7
|
**唯一指定**的导入方式是 import { capabilityClient } from '@lark-apaas/client-toolkit';
|
|
11
8
|
|
|
12
9
|
| 优先级 | 场景 | 调用方式 |
|
|
13
10
|
|-------|------|---------|
|
|
14
|
-
| **首选** |
|
|
15
|
-
| **首选** |
|
|
16
|
-
|
|
|
17
|
-
| **兜底** | Client 侧无法满足且单次调用可在交互边界内完成 | `CapabilityService.load(id).call()` |
|
|
11
|
+
| **首选** | 绝大多数场景 | `capabilityClient.load(id).call()` |
|
|
12
|
+
| **首选** | 流式输出场景 | `capabilityClient.load(id).callStream()` |
|
|
13
|
+
| **兜底** | Client 侧无法满足时 | `CapabilityService.load(id).call()` |
|
|
18
14
|
|
|
19
15
|
#### 什么情况下应使用 Server 侧?
|
|
20
16
|
|
|
@@ -23,7 +19,7 @@
|
|
|
23
19
|
1. **涉及敏感凭证**:调用需要服务端私密 token/secret,不适合暴露给前端
|
|
24
20
|
2. **必须后端编排**:多个插件调用之间有强事务依赖,需要后端统一编排
|
|
25
21
|
3. **触发器/定时任务场景**:没有前端上下文,只能由后端发起
|
|
26
|
-
4.
|
|
22
|
+
4. **插件结果需要持久化**:调用结果需要保存到数据库,在 Server 侧可以在同一方法中完成调用+落库,保证数据一致性
|
|
27
23
|
|
|
28
24
|
> **提示**:如果插件结果不需要存储、仅用于即时展示(如流式生成文本、发送消息),优先在前端调用。但当结果需要保存到数据库时,不要回避使用 Server 侧。
|
|
29
25
|
|
|
@@ -46,13 +42,9 @@
|
|
|
46
42
|
|
|
47
43
|
```
|
|
48
44
|
插件结果是否需要持久化到数据库?
|
|
49
|
-
├──
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
└── 是
|
|
53
|
-
├── `outputMode=stream` 且前端可承接 → 推荐方案 A:Client 侧 `callStream()` 渐进展示,成功后通过已有 CRUD 接口保存结果
|
|
54
|
-
├── 输出较小且可在交互边界内完成、且必须由后端保证一致性 → Server 侧调用并在同一方法中落库
|
|
55
|
-
└── Client 侧无法满足且输出规模大/多字段/多份/多语言/多步骤 → 方案 B:Server 侧创建任务记录,快速返回任务状态;后台调用插件并落库;前端短轮询状态/结果
|
|
45
|
+
├── 否(一次性即时展示)→ Client 侧调用(默认)
|
|
46
|
+
└── 是 → 推荐方案 A:Server 侧调用,在 Service 中调用插件并在同一方法中落库
|
|
47
|
+
备选方案 B:Client 侧调用插件 → 成功后通过已有 CRUD 接口保存结果
|
|
56
48
|
```
|
|
57
49
|
|
|
58
50
|
| 应避免的做法 | 推荐做法 |
|
|
@@ -279,11 +271,10 @@ function MultiPluginStreamExample({ recordId }: { recordId: string }) {
|
|
|
279
271
|
2. 一个 `stream` action 的真实调用结果(chunk 按 `outputSchema` 字段读取)
|
|
280
272
|
3. 调用失败时的最小日志字段齐全
|
|
281
273
|
4. 若无法执行真实调用,必须明确写明阻塞原因,禁止直接标记“开发完成”
|
|
282
|
-
5. 若用户触发 AI 生成的请求超时、连接断开或工具返回超时,必须判定为验收失败;只有触发请求快速返回、随后能通过页面或接口读到明确完成或失败终态和结果,才允许标记通过
|
|
283
274
|
|
|
284
275
|
### Server 侧调用方式(仅兜底场景)
|
|
285
276
|
|
|
286
|
-
> 以下场景适合使用 Server
|
|
277
|
+
> 以下场景适合使用 Server 侧调用,特别是涉及数据持久化时不要回避后端。
|
|
287
278
|
|
|
288
279
|
#### 1. 何时适合用 Server 侧?
|
|
289
280
|
|
|
@@ -294,7 +285,6 @@ function MultiPluginStreamExample({ recordId }: { recordId: string }) {
|
|
|
294
285
|
| 敏感凭证调用 | 凭证不能暴露给前端 | 调用需要 admin token 的 API |
|
|
295
286
|
| 强事务编排 | 多步骤需要原子性 | 创建记录 → 发通知 → 更新状态必须全成功或全回滚 |
|
|
296
287
|
| 插件结果需持久化 | 调用结果需保存到数据库 | AI 分类/摘要结果需落库、文档解析的结构化数据需入库、图片识别结果需关联业务记录、语音转文字结果需存档等 |
|
|
297
|
-
| 高耗时 AI 生成需后续查看 | 请求不能长期占用用户交互链路 | 批量、多版本、多语言、长文本、多字段结构化生成,或文件/多模态分析后再生成内容 |
|
|
298
288
|
|
|
299
289
|
#### 2. NestJS 注入方式
|
|
300
290
|
|
|
@@ -338,7 +328,6 @@ try {
|
|
|
338
328
|
|
|
339
329
|
- PluginInstance 调用在 Server 侧通常属于 **外部依赖 / side-effect**
|
|
340
330
|
- 除非业务明确要求强一致性,**默认不应阻塞主业务流程**
|
|
341
|
-
- 已选择 Server 侧承接的高耗时 AI capability 必须有可观测状态:创建任务时记录处理进度、完成终态、失败终态、输入摘要、错误信息和结果引用;触发接口只返回任务标识与当前状态,前端通过短轮询读取进度和最终结果
|
|
342
331
|
|
|
343
332
|
推荐写法:异步触发 + catch 兜底:
|
|
344
333
|
|
|
@@ -129,7 +129,7 @@ shared/ # 前后端共享的目录
|
|
|
129
129
|
|
|
130
130
|
1. 优先使用项目已有依赖,仅在无法实现时安装新依赖
|
|
131
131
|
2. 使用前先查看 `package.json` 确保依赖已存在
|
|
132
|
-
3. **子包完整性检查**:部分库有多个子包(如 `@
|
|
132
|
+
3. **子包完整性检查**:部分库有多个子包(如 `@radix-ui/react-*` 系列每个组件都是独立子包),添加 import 后必须确认 package.json 中包含所有需要的子包
|
|
133
133
|
4. 用法不清时查看 readme,可进一步搜索或网页访问获取信息
|
|
134
134
|
|
|
135
135
|
## 文件命名约定
|
|
@@ -443,14 +443,13 @@ NestJS 自己不读 env。直连 NestJS 端口 → header 缺失 → `req.userCo
|
|
|
443
443
|
|
|
444
444
|
- **框架**: React 19 + TypeScript
|
|
445
445
|
- **路由**: React Router DOM v6
|
|
446
|
-
- **样式**:
|
|
446
|
+
- **样式**: tailwindcss(语义化 token)为主,复杂 CSS 用 CSS Modules(`*.module.css`),动态计算值用行内 `style`
|
|
447
447
|
- **UI 组件库**: shadcn/ui — Use components for functionality, heavily style them
|
|
448
448
|
- **图表**: ReactECharts,**开发前必须调用 `/charts-skill`**
|
|
449
449
|
- **图标**: Lucide React(唯一图标库,禁止 Emoji 和其他图标库)
|
|
450
450
|
- **表格/表单/图表**: 见下方"组件 Skill 召回规则",开发前必须先调用对应 Skill
|
|
451
451
|
- **用户**: 用户信息展示/选择必须用 `business-ui` 组件(阅读 README.md),禁止直接展示 userId
|
|
452
|
-
-
|
|
453
|
-
- **Markdown 渲染**: `components/ui/streamdown`(内置 prose 排版)
|
|
452
|
+
- **Markdown 渲染**: `components/ui/markdown`(react-markdown + remark-gfm,内置 prose 排版)
|
|
454
453
|
|
|
455
454
|
## API 请求
|
|
456
455
|
|
|
@@ -483,8 +482,7 @@ import { axiosForBackend } from '@lark-apaas/client-toolkit/utils/getAxiosForBac
|
|
|
483
482
|
| --------------------------------------------------- | --------------------------------------- | --------------------------------- |
|
|
484
483
|
| Table | `@lark-apaas/client-toolkit/antd-table` | 数据表格,**先调 `/table-skill`** |
|
|
485
484
|
| UserSelect/UserDisplay/UserProfile/DepartmentSelect | `business-ui/*` | 用户/部门选择展示 |
|
|
486
|
-
|
|
|
487
|
-
| Streamdown | `components/ui/streamdown` | Markdown/流式渲染 |
|
|
485
|
+
| Markdown | `components/ui/markdown` | Markdown 渲染(react-markdown + remark-gfm) |
|
|
488
486
|
|
|
489
487
|
### 组件 Skill 召回规则(强制执行)
|
|
490
488
|
|
|
@@ -535,7 +533,7 @@ import { axiosForBackend } from '@lark-apaas/client-toolkit/utils/getAxiosForBac
|
|
|
535
533
|
```
|
|
536
534
|
需要写样式?
|
|
537
535
|
├─ 基础布局/间距/颜色 → Tailwind ✅
|
|
538
|
-
├─ 复杂动画/伪元素/高级CSS →
|
|
536
|
+
├─ 复杂动画/伪元素/高级CSS → CSS Modules(`*.module.css`)✅
|
|
539
537
|
└─ JS动态计算值 → 行内 style ✅
|
|
540
538
|
```
|
|
541
539
|
|
|
@@ -548,10 +546,12 @@ import { axiosForBackend } from '@lark-apaas/client-toolkit/utils/getAxiosForBac
|
|
|
548
546
|
- **arbitrary values 中空格用下划线**:`from-[hsl(215_60%_18%)]` 非 `from-[hsl(215 60% 18%)]`
|
|
549
547
|
- `tailwind-theme.css` 自定义属性用 `hsl(H, S%, L%)` 格式(非 `23 10% 23%`)
|
|
550
548
|
|
|
551
|
-
###
|
|
549
|
+
### CSS Modules 规范
|
|
552
550
|
|
|
553
|
-
-
|
|
554
|
-
-
|
|
551
|
+
- 文件名:`ComponentName.module.css`,与组件同目录
|
|
552
|
+
- 导入用 `import styles from './ComponentName.module.css'`,通过 `className={styles.foo}` 引用
|
|
553
|
+
- 类名用 camelCase,避免使用连字符(`styles.myClass` 而非 `styles['my-class']`)
|
|
554
|
+
- 全局样式(如动画 keyframes、CSS 变量)放在 `client/src/index.css` 或 `tailwind-theme.css`
|
|
555
555
|
|
|
556
556
|
### 布局/排版
|
|
557
557
|
|
|
@@ -635,15 +635,12 @@ return <h1>{data?.title || '未知标题'}</h1>;
|
|
|
635
635
|
| 验证 | zod |
|
|
636
636
|
| 工具函数 | lodash |
|
|
637
637
|
| 样式 | clsx |
|
|
638
|
-
|
|
|
639
|
-
| PDF 导出 | jspdf + html2canvas(**仅前端实现,禁止服务端实现**) |
|
|
640
|
-
| 文件上传 | react-dropzone |
|
|
641
|
-
| 二维码 | qrcode.react |
|
|
638
|
+
| 文件上传 | 原生 `<input type="file">`,用 shadcn 组件封装样式 |
|
|
642
639
|
| 用户反馈 | sonner |
|
|
643
|
-
|
|
|
644
|
-
|
|
|
645
|
-
|
|
646
|
-
|
|
640
|
+
| 数字动画 | `requestAnimationFrame` 手写,或 framer-motion 的 `animate` |
|
|
641
|
+
| Base64 | 原生 `atob`/`btoa`(Unicode 内容先经 `TextEncoder`/`TextDecoder`);服务端用 `Buffer` |
|
|
642
|
+
|
|
643
|
+
> Excel 解析、PDF 导出、二维码、拖拽、3D 场景等能力已随依赖瘦身不再预装(xlsx、jspdf、html2canvas、qrcode.react、@dnd-kit、react-dropzone、react-countup、js-base64、cobe 已从模板移除)。确有此类需求时,先在 package.json 显式添加所需依赖并安装,再编写代码。
|
|
647
644
|
|
|
648
645
|
## 滚动分页最佳实践
|
|
649
646
|
|
|
@@ -35,7 +35,6 @@ lark-cli apps --help 2>&1 | grep -q '+plugin-install' && echo "READY" || echo "M
|
|
|
35
35
|
| Client 侧非流式调用 | `capabilityClient.load(id).call(actionKey, input)` |
|
|
36
36
|
| Client 侧流式调用 | `capabilityClient.load(id).callStream(actionKey, input)` |
|
|
37
37
|
| Server 侧调用(仅兜底) | `capabilityService.load(id).call(actionKey, input)` |
|
|
38
|
-
| 长耗时 AI 结果 | 大体量/多字段/多份/多语言/文件或多模态串联等结构信号命中时,优先前端 `callStream` 渐进展示;需保存则流式结束后复用 CRUD 落库;仅在 Client 侧无法满足时使用后端任务记录 + 状态查询 + 结果读取;禁止单个 HTTP 请求等待完整结果后才返回 |
|
|
39
38
|
| capabilityClient 导入 | `import { capabilityClient } from '@lark-apaas/client-toolkit'` |
|
|
40
39
|
| CapabilityService 导入 | `import { CapabilityService } from '@lark-apaas/fullstack-nestjs-core';` |
|
|
41
40
|
| CapabilityService 注入 | `@Inject() private readonly capabilityService: CapabilityService` |
|
|
@@ -517,9 +516,7 @@ npx @lark-apaas/miaoda-cli plugin list --id <instance_id>
|
|
|
517
516
|
2. 结果供后续功能消费
|
|
518
517
|
3. 用户再次访问时需要看到结果
|
|
519
518
|
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
**高耗时 AI capability 闸门**:若插件输出定义或功能设计显示输出规模大、输出字段多、需要多份结果、多语言/长文本、文件或多模态输入后继续生成、多个 capability 串联、或结果需后续查看/落库,禁止把完整生成放进一个同步 HTTP 请求等待;能由前端承接时优先 `callStream` 渐进展示,需保存则流式结束后复用 CRUD 落库;仅在 Client 侧无法满足时后端创建任务记录后快速返回、由前端短轮询状态/结果,或拆成多个独立小调用。
|
|
519
|
+
**推荐**:Server 侧 Service 调用插件 + 同一方法落库。**备选**:Client 侧调用 → 流式结束后调已有 CRUD 接口保存。
|
|
523
520
|
|
|
524
521
|
### 生成代码
|
|
525
522
|
|
|
@@ -538,8 +535,7 @@ npx @lark-apaas/miaoda-cli plugin list --id <instance_id>
|
|
|
538
535
|
|
|
539
536
|
1. **禁止静默吞异常**:每个 `catch` 块必须向用户展示错误或触发补偿
|
|
540
537
|
2. **异步操作必须有终态**:DB 中维护状态(pending → success / failed)
|
|
541
|
-
3.
|
|
542
|
-
4. **插件失败必须有补偿**:至少记录到待处理列表或提示用户重试
|
|
538
|
+
3. **插件失败必须有补偿**:至少记录到待处理列表或提示用户重试
|
|
543
539
|
|
|
544
540
|
## 缓存与幂等性
|
|
545
541
|
|
package/steering/nestjs-react-fullstack/skills_local/plugin-guide/references/plugin-coding-guide.md
CHANGED
|
@@ -2,19 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
### 核心原则:根据场景选择调用侧
|
|
4
4
|
|
|
5
|
-
**默认优先在 Client 侧调用 capabilityClient
|
|
6
|
-
|
|
7
|
-
**高耗时 AI capability 先判调用形态**:只要输出规模大、输出字段多、需要多份结果、多语言/长文本、文件或多模态输入后继续生成、多个 capability 串联、或结果需后续查看/落库,就不得把完整 AI 结果塞进一个同步 HTTP 请求等待。能由前端承接时,优先用前端 `callStream` 渐进展示,并在流式结束后按需复用已有 CRUD 接口保存结果;只有 Client 侧无法满足(触发器/敏感凭证/强事务/必须由后端保证落库一致性等)时,才采用后端任务记录 + 状态/结果查询,避免把后台任务作为默认方案。
|
|
8
|
-
|
|
5
|
+
**默认优先在 Client 侧调用 capabilityClient;但当插件结果需要持久化到数据库时,应考虑在 Server 侧调用或确保前端调用后及时通过后端接口保存。**
|
|
9
6
|
**严禁** import { capabilityClient } from '@lark-apaas/client-capability'。
|
|
10
7
|
**唯一指定**的导入方式是 import { capabilityClient } from '@lark-apaas/client-toolkit';
|
|
11
8
|
|
|
12
9
|
| 优先级 | 场景 | 调用方式 |
|
|
13
10
|
|-------|------|---------|
|
|
14
|
-
| **首选** |
|
|
15
|
-
| **首选** |
|
|
16
|
-
|
|
|
17
|
-
| **兜底** | Client 侧无法满足且单次调用可在交互边界内完成 | `CapabilityService.load(id).call()` |
|
|
11
|
+
| **首选** | 绝大多数场景 | `capabilityClient.load(id).call()` |
|
|
12
|
+
| **首选** | 流式输出场景 | `capabilityClient.load(id).callStream()` |
|
|
13
|
+
| **兜底** | Client 侧无法满足时 | `CapabilityService.load(id).call()` |
|
|
18
14
|
|
|
19
15
|
#### 什么情况下应使用 Server 侧?
|
|
20
16
|
|
|
@@ -23,7 +19,7 @@
|
|
|
23
19
|
1. **涉及敏感凭证**:调用需要服务端私密 token/secret,不适合暴露给前端
|
|
24
20
|
2. **必须后端编排**:多个插件调用之间有强事务依赖,需要后端统一编排
|
|
25
21
|
3. **触发器/定时任务场景**:没有前端上下文,只能由后端发起
|
|
26
|
-
4.
|
|
22
|
+
4. **插件结果需要持久化**:调用结果需要保存到数据库,在 Server 侧可以在同一方法中完成调用+落库,保证数据一致性
|
|
27
23
|
|
|
28
24
|
> **提示**:如果插件结果不需要存储、仅用于即时展示(如流式生成文本、发送消息),优先在前端调用。但当结果需要保存到数据库时,不要回避使用 Server 侧。
|
|
29
25
|
|
|
@@ -35,13 +31,9 @@
|
|
|
35
31
|
|
|
36
32
|
```
|
|
37
33
|
插件结果是否需要持久化到数据库?
|
|
38
|
-
├── 否
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
└── 是
|
|
42
|
-
├── `outputMode=stream` 且前端可承接 → 推荐方案 A:Client 侧 `callStream()` 渐进展示,成功后通过已有 CRUD 接口保存结果
|
|
43
|
-
├── 输出较小且可在交互边界内完成、且必须由后端保证一致性 → Server 侧调用并在同一方法中落库
|
|
44
|
-
└── Client 侧无法满足且输出规模大/多字段/多份/多语言/多步骤 → 方案 B:Server 侧创建任务记录,快速返回任务状态;后台调用插件并落库;前端短轮询状态/结果
|
|
34
|
+
├── 否 → Client 侧调用(默认)
|
|
35
|
+
└── 是 → 推荐方案 A:Server 侧调用,在 Service 中调用插件并在同一方法中落库
|
|
36
|
+
备选方案 B:Client 侧调用插件 → 成功后通过已有 CRUD 接口保存结果
|
|
45
37
|
```
|
|
46
38
|
|
|
47
39
|
| 应避免的做法 | 推荐做法 |
|
|
@@ -241,11 +233,10 @@ function MultiPluginStreamExample() {
|
|
|
241
233
|
2. 一个 `stream` action 的真实调用结果(chunk 按 `outputSchema` 字段读取)
|
|
242
234
|
3. 调用失败时的最小日志字段齐全
|
|
243
235
|
4. 若无法执行真实调用,必须明确写明阻塞原因,禁止直接标记"开发完成"
|
|
244
|
-
5. 若用户触发 AI 生成的请求超时、连接断开或工具返回超时,必须判定为验收失败;只有触发请求快速返回、随后能通过页面或接口读到明确完成或失败终态和结果,才允许标记通过
|
|
245
236
|
|
|
246
237
|
### Server 侧调用方式(仅兜底场景)
|
|
247
238
|
|
|
248
|
-
> 以下场景适合使用 Server
|
|
239
|
+
> 以下场景适合使用 Server 侧调用,特别是涉及数据持久化时不要回避后端。
|
|
249
240
|
|
|
250
241
|
#### 1. 何时适合用 Server 侧?
|
|
251
242
|
|
|
@@ -256,7 +247,6 @@ function MultiPluginStreamExample() {
|
|
|
256
247
|
| 敏感凭证调用 | 凭证不能暴露给前端 | 调用需要 admin token 的 API |
|
|
257
248
|
| 强事务编排 | 多步骤需要原子性 | 创建记录 → 发通知 → 更新状态必须全成功或全回滚 |
|
|
258
249
|
| 插件结果需持久化 | 调用结果需保存到数据库 | AI 分类/摘要结果需落库、文档解析的结构化数据需入库、图片识别结果需关联业务记录、语音转文字结果需存档等 |
|
|
259
|
-
| 高耗时 AI 生成需后续查看 | 请求不能长期占用用户交互链路 | 批量、多版本、多语言、长文本、多字段结构化生成,或文件/多模态分析后再生成内容 |
|
|
260
250
|
|
|
261
251
|
#### 2. NestJS 注入方式
|
|
262
252
|
|
|
@@ -300,7 +290,6 @@ try {
|
|
|
300
290
|
|
|
301
291
|
- PluginInstance 调用在 Server 侧通常属于 **外部依赖 / side-effect**
|
|
302
292
|
- 除非业务明确要求强一致性,**默认不应阻塞主业务流程**
|
|
303
|
-
- 已选择 Server 侧承接的高耗时 AI capability 必须有可观测状态:创建任务时记录处理进度、完成终态、失败终态、输入摘要、错误信息和结果引用;触发接口只返回任务标识与当前状态,前端通过短轮询读取进度和最终结果
|
|
304
293
|
|
|
305
294
|
推荐写法:异步触发 + catch 兜底:
|
|
306
295
|
|