@leeoohoo/ui-apps-devkit 0.1.0 → 0.1.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/README.md +75 -60
- package/bin/chatos-uiapp.js +4 -4
- package/package.json +26 -20
- package/src/cli.js +53 -53
- package/src/commands/dev.js +14 -14
- package/src/commands/init.js +131 -129
- package/src/commands/install.js +47 -46
- package/src/commands/pack.js +72 -72
- package/src/commands/validate.js +138 -80
- package/src/lib/args.js +49 -49
- package/src/lib/config.js +29 -29
- package/src/lib/fs.js +78 -78
- package/src/lib/path-boundary.js +16 -16
- package/src/lib/plugin.js +45 -45
- package/src/lib/state-constants.js +2 -0
- package/src/lib/template.js +172 -168
- package/src/sandbox/server.js +1957 -692
- package/templates/basic/README.md +78 -54
- package/templates/basic/chatos.config.json +5 -5
- package/templates/basic/docs/CHATOS_UI_APPS_AI_CONTRIBUTIONS.md +214 -181
- package/templates/basic/docs/CHATOS_UI_APPS_BACKEND_PROTOCOL.md +75 -74
- package/templates/basic/docs/CHATOS_UI_APPS_HOST_API.md +136 -123
- package/templates/basic/docs/CHATOS_UI_APPS_OVERVIEW.md +112 -107
- package/templates/basic/docs/CHATOS_UI_APPS_PLUGIN_MANIFEST.md +242 -227
- package/templates/basic/docs/CHATOS_UI_APPS_STYLE_GUIDE.md +95 -0
- package/templates/basic/docs/CHATOS_UI_APPS_TROUBLESHOOTING.md +45 -0
- package/templates/basic/docs/CHATOS_UI_PROMPTS_PROTOCOL.md +392 -392
- package/templates/basic/plugin/apps/app/compact.mjs +41 -0
- package/templates/basic/plugin/apps/app/index.mjs +287 -263
- package/templates/basic/plugin/apps/app/mcp-prompt.en.md +7 -7
- package/templates/basic/plugin/apps/app/mcp-prompt.zh.md +7 -7
- package/templates/basic/plugin/apps/app/mcp-server.mjs +15 -15
- package/templates/basic/plugin/backend/index.mjs +37 -37
- package/templates/basic/template.json +7 -7
- package/templates/notepad/README.md +55 -24
- package/templates/notepad/chatos.config.json +4 -4
- package/templates/notepad/docs/CHATOS_UI_APPS_AI_CONTRIBUTIONS.md +214 -181
- package/templates/notepad/docs/CHATOS_UI_APPS_BACKEND_PROTOCOL.md +75 -74
- package/templates/notepad/docs/CHATOS_UI_APPS_HOST_API.md +136 -123
- package/templates/notepad/docs/CHATOS_UI_APPS_OVERVIEW.md +112 -107
- package/templates/notepad/docs/CHATOS_UI_APPS_PLUGIN_MANIFEST.md +242 -227
- package/templates/notepad/docs/CHATOS_UI_APPS_STYLE_GUIDE.md +95 -0
- package/templates/notepad/docs/CHATOS_UI_APPS_TROUBLESHOOTING.md +45 -0
- package/templates/notepad/docs/CHATOS_UI_PROMPTS_PROTOCOL.md +392 -392
- package/templates/notepad/plugin/apps/app/api.mjs +30 -30
- package/templates/notepad/plugin/apps/app/compact.mjs +41 -0
- package/templates/notepad/plugin/apps/app/dom.mjs +14 -14
- package/templates/notepad/plugin/apps/app/ds-tree.mjs +35 -35
- package/templates/notepad/plugin/apps/app/index.mjs +1056 -1056
- package/templates/notepad/plugin/apps/app/layers.mjs +338 -338
- package/templates/notepad/plugin/apps/app/markdown.mjs +120 -120
- package/templates/notepad/plugin/apps/app/mcp-prompt.en.md +22 -22
- package/templates/notepad/plugin/apps/app/mcp-prompt.zh.md +22 -22
- package/templates/notepad/plugin/apps/app/mcp-server.mjs +206 -199
- package/templates/notepad/plugin/apps/app/styles.mjs +355 -355
- package/templates/notepad/plugin/apps/app/tags.mjs +21 -21
- package/templates/notepad/plugin/apps/app/ui.mjs +280 -280
- package/templates/notepad/plugin/backend/index.mjs +99 -99
- package/templates/notepad/plugin/plugin.json +23 -23
- package/templates/notepad/plugin/shared/notepad-paths.mjs +59 -41
- package/templates/notepad/plugin/shared/notepad-store.mjs +765 -765
- package/templates/notepad/template.json +8 -8
|
@@ -1,74 +1,75 @@
|
|
|
1
|
-
# ChatOS UI Apps:插件后端协议(Electron main 进程)
|
|
2
|
-
|
|
3
|
-
插件后端用于承载需要 Node 能力的逻辑(数据库/SSH/I/O/调用本地二进制等)。后端运行在 Electron main 进程,通过 IPC 由 `module` 前端调用。
|
|
4
|
-
|
|
5
|
-
实现对照(以代码为准):
|
|
6
|
-
|
|
7
|
-
- `
|
|
8
|
-
|
|
9
|
-
## 1. 开启后端:`plugin.json`
|
|
10
|
-
|
|
11
|
-
```json
|
|
12
|
-
{
|
|
13
|
-
"backend": { "entry": "backend/index.mjs" }
|
|
14
|
-
}
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
约束:
|
|
18
|
-
|
|
19
|
-
- `backend.entry` 必须位于插件目录内;
|
|
20
|
-
- 必须是文件;
|
|
21
|
-
- 文件变更后会按 `mtime` 自动 reload(旧实例会尝试调用 `dispose()`)。
|
|
22
|
-
|
|
23
|
-
## 2. 后端入口:`createUiAppsBackend(ctx)`
|
|
24
|
-
|
|
25
|
-
后端入口模块必须导出:
|
|
26
|
-
|
|
27
|
-
```js
|
|
28
|
-
export async function createUiAppsBackend(ctx) {
|
|
29
|
-
return {
|
|
30
|
-
methods: {
|
|
31
|
-
async ping(params, ctx2) {
|
|
32
|
-
return { ok: true, echo: params, pluginId: ctx2.pluginId };
|
|
33
|
-
},
|
|
34
|
-
},
|
|
35
|
-
async dispose() {},
|
|
36
|
-
};
|
|
37
|
-
}
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
硬约束:
|
|
41
|
-
|
|
42
|
-
- 必须导出函数 `createUiAppsBackend`
|
|
43
|
-
- `createUiAppsBackend()` 返回值必须包含 `{ methods }`
|
|
44
|
-
|
|
45
|
-
方法调用约定:
|
|
46
|
-
|
|
47
|
-
- 前端调用:`await host.backend.invoke('ping', params)`
|
|
48
|
-
- 实际执行:`methods[method](params, ctx)`
|
|
49
|
-
- 第二个参数 `ctx` 会再次传入(即使你在 `createUiAppsBackend(ctx)` 的闭包里也已拿到一份)
|
|
50
|
-
|
|
51
|
-
## 3. `ctx`(宿主注入的运行时上下文)
|
|
52
|
-
|
|
53
|
-
`ctx` 字段(当前实现):
|
|
54
|
-
|
|
55
|
-
- `pluginId`:插件 ID
|
|
56
|
-
- `pluginDir`:插件安装目录(只读引用;用于读取插件资源)
|
|
57
|
-
- `dataDir`:`<stateDir>/ui_apps/data/<pluginId>`(插件可写数据目录;宿主会确保存在)
|
|
58
|
-
- `stateDir
|
|
59
|
-
- `
|
|
60
|
-
- `
|
|
61
|
-
- `
|
|
62
|
-
|
|
63
|
-
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
-
|
|
69
|
-
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
-
|
|
1
|
+
# ChatOS UI Apps:插件后端协议(Electron main 进程)
|
|
2
|
+
|
|
3
|
+
插件后端用于承载需要 Node 能力的逻辑(数据库/SSH/I/O/调用本地二进制等)。后端运行在 Electron main 进程,通过 IPC 由 `module` 前端调用。
|
|
4
|
+
|
|
5
|
+
实现对照(以代码为准):
|
|
6
|
+
|
|
7
|
+
- `chatos/electron/ui-apps/index.js`(`uiApps:invoke` 与后端加载/缓存)
|
|
8
|
+
|
|
9
|
+
## 1. 开启后端:`plugin.json`
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{
|
|
13
|
+
"backend": { "entry": "backend/index.mjs" }
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
约束:
|
|
18
|
+
|
|
19
|
+
- `backend.entry` 必须位于插件目录内;
|
|
20
|
+
- 必须是文件;
|
|
21
|
+
- 文件变更后会按 `mtime` 自动 reload(旧实例会尝试调用 `dispose()`)。
|
|
22
|
+
|
|
23
|
+
## 2. 后端入口:`createUiAppsBackend(ctx)`
|
|
24
|
+
|
|
25
|
+
后端入口模块必须导出:
|
|
26
|
+
|
|
27
|
+
```js
|
|
28
|
+
export async function createUiAppsBackend(ctx) {
|
|
29
|
+
return {
|
|
30
|
+
methods: {
|
|
31
|
+
async ping(params, ctx2) {
|
|
32
|
+
return { ok: true, echo: params, pluginId: ctx2.pluginId };
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
async dispose() {},
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
硬约束:
|
|
41
|
+
|
|
42
|
+
- 必须导出函数 `createUiAppsBackend`
|
|
43
|
+
- `createUiAppsBackend()` 返回值必须包含 `{ methods }`
|
|
44
|
+
|
|
45
|
+
方法调用约定:
|
|
46
|
+
|
|
47
|
+
- 前端调用:`await host.backend.invoke('ping', params)`
|
|
48
|
+
- 实际执行:`methods[method](params, ctx)`
|
|
49
|
+
- 第二个参数 `ctx` 会再次传入(即使你在 `createUiAppsBackend(ctx)` 的闭包里也已拿到一份)
|
|
50
|
+
|
|
51
|
+
## 3. `ctx`(宿主注入的运行时上下文)
|
|
52
|
+
|
|
53
|
+
`ctx` 字段(当前实现):
|
|
54
|
+
|
|
55
|
+
- `pluginId`:插件 ID
|
|
56
|
+
- `pluginDir`:插件安装目录(只读引用;用于读取插件资源)
|
|
57
|
+
- `dataDir`:`<stateDir>/ui_apps/data/<pluginId>`(插件可写数据目录;宿主会确保存在)
|
|
58
|
+
- `stateDir`:每个应用的状态根目录(`<stateRoot>/<hostApp>`;ChatOS 的 `hostApp=chatos`)
|
|
59
|
+
- 兼容旧路径:若存在 `legacyStateRoot/<hostApp>`,启动时会自动迁移到 `stateDir`
|
|
60
|
+
- `sessionRoot`:会话根
|
|
61
|
+
- `projectRoot`:宿主工程根(开发态下有用)
|
|
62
|
+
- `llm`:可选(共享模型调用接口)
|
|
63
|
+
- `ctx.llm.complete({ input, modelId?, modelName?, systemPrompt?, disableTools? })`
|
|
64
|
+
- 在 ChatOS 宿主实现中,`disableTools` 默认启用(除非显式传 `disableTools:false`);返回形如 `{ ok:true, model, content }`
|
|
65
|
+
|
|
66
|
+
规则:
|
|
67
|
+
|
|
68
|
+
- 持久化只写 `dataDir`,并自行做版本化与迁移。
|
|
69
|
+
- 返回值请保持可 JSON 序列化(避免传递函数/循环引用)。
|
|
70
|
+
- 插件后端不保存或读取 API Keys;密钥由宿主注入到环境变量;模型调用通过 `ctx.llm.complete()`。
|
|
71
|
+
|
|
72
|
+
## 4. 错误处理与返回结构
|
|
73
|
+
|
|
74
|
+
- 后端方法抛错会被宿主捕获并返回 `{ ok:false, message }`;
|
|
75
|
+
- 前端侧 `host.backend.invoke()` 会把 `ok:false` 转成异常抛出(便于应用用 `try/catch` 处理)。
|
|
@@ -1,123 +1,136 @@
|
|
|
1
|
-
# ChatOS UI Apps:`module` 入口与 Host API(协议)
|
|
2
|
-
|
|
3
|
-
本文件定义 UI Apps 的 `module` 入口规范,以及宿主注入的 `host` 对象(应用与 ChatOS 交互的稳定契约)。
|
|
4
|
-
|
|
5
|
-
实现对照(以代码为准):
|
|
6
|
-
|
|
7
|
-
- `
|
|
8
|
-
|
|
9
|
-
## 1. module 入口规范
|
|
10
|
-
|
|
11
|
-
`plugin.json` 中的入口示例:
|
|
12
|
-
|
|
13
|
-
```json
|
|
14
|
-
{ "type": "module", "path": "my-app/index.mjs" }
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
入口模块需导出 `mount`(以下三种写法宿主都接受):
|
|
18
|
-
|
|
19
|
-
- `export function mount(...) { ... }`
|
|
20
|
-
- `export default { mount(...) { ... } }`
|
|
21
|
-
- `export default function mount(...) { ... }`
|
|
22
|
-
|
|
23
|
-
`mount` 签名:
|
|
24
|
-
|
|
25
|
-
```js
|
|
26
|
-
export function mount({ container, host, slots }) {
|
|
27
|
-
return () => {}; // or return { dispose() {} }
|
|
28
|
-
}
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
- `container`:应用正文容器(body)
|
|
32
|
-
- `slots.header`:可选固定 Header 容器(不随 body 滚动)
|
|
33
|
-
- 返回值:
|
|
34
|
-
- `() => void|Promise<void>`:卸载回调;或
|
|
35
|
-
- `{ dispose(): void|Promise<void> }`
|
|
36
|
-
|
|
37
|
-
布局规范:
|
|
38
|
-
|
|
39
|
-
- 不要使用 `window/body` 作为滚动容器;把滚动放到应用内部。
|
|
40
|
-
- 将 Tabs/二级导航/操作按钮等放到 `slots.header`,可滚动内容放到 `container`。
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
- `host.
|
|
61
|
-
- `host.
|
|
62
|
-
- `host.
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
- `host.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
### 3.
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
- `host.
|
|
88
|
-
- `
|
|
89
|
-
- `
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
- `host.
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
`host.
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
- `host.
|
|
110
|
-
-
|
|
111
|
-
- `host.
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
- `host.chat.
|
|
118
|
-
- `host.chat.
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
- `
|
|
123
|
-
-
|
|
1
|
+
# ChatOS UI Apps:`module` 入口与 Host API(协议)
|
|
2
|
+
|
|
3
|
+
本文件定义 UI Apps 的 `module` 入口规范,以及宿主注入的 `host` 对象(应用与 ChatOS 交互的稳定契约)。
|
|
4
|
+
|
|
5
|
+
实现对照(以代码为准):
|
|
6
|
+
|
|
7
|
+
- `chatos/apps/ui/src/features/apps/AppsPluginView.jsx`
|
|
8
|
+
|
|
9
|
+
## 1. module 入口规范
|
|
10
|
+
|
|
11
|
+
`plugin.json` 中的入口示例:
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{ "type": "module", "path": "my-app/index.mjs" }
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
入口模块需导出 `mount`(以下三种写法宿主都接受):
|
|
18
|
+
|
|
19
|
+
- `export function mount(...) { ... }`
|
|
20
|
+
- `export default { mount(...) { ... } }`
|
|
21
|
+
- `export default function mount(...) { ... }`
|
|
22
|
+
|
|
23
|
+
`mount` 签名:
|
|
24
|
+
|
|
25
|
+
```js
|
|
26
|
+
export function mount({ container, host, slots }) {
|
|
27
|
+
return () => {}; // or return { dispose() {} }
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
- `container`:应用正文容器(body)
|
|
32
|
+
- `slots.header`:可选固定 Header 容器(不随 body 滚动)
|
|
33
|
+
- 返回值:
|
|
34
|
+
- `() => void|Promise<void>`:卸载回调;或
|
|
35
|
+
- `{ dispose(): void|Promise<void> }`
|
|
36
|
+
|
|
37
|
+
布局规范:
|
|
38
|
+
|
|
39
|
+
- 不要使用 `window/body` 作为滚动容器;把滚动放到应用内部。
|
|
40
|
+
- 将 Tabs/二级导航/操作按钮等放到 `slots.header`,可滚动内容放到 `container`。
|
|
41
|
+
|
|
42
|
+
Surface 说明:
|
|
43
|
+
|
|
44
|
+
- 宿主可能在不同 **surface** 下挂载应用(如 `full` 全屏、`compact` 侧边抽屉/分栏)。
|
|
45
|
+
- 若 `plugin.json` 提供 `entry.compact`,宿主在 compact surface 会优先加载该入口。
|
|
46
|
+
- 当前 surface 通过 `host.context.get().surface` 暴露(`"full"` / `"compact"`)。
|
|
47
|
+
|
|
48
|
+
## 2. Host Bridge 可用性
|
|
49
|
+
|
|
50
|
+
宿主仅在“file-based entry + preload bridge 可用”的情况下提供 `host` 能力;否则会抛错:
|
|
51
|
+
|
|
52
|
+
- 若你在非 ChatOS 宿主环境下单独打开页面(或 preload 未加载),`host.bridge.enabled` 可能为 `false`。
|
|
53
|
+
- 生产场景(桌面端应用内)一般为 `true`。
|
|
54
|
+
|
|
55
|
+
## 3. `host` API 约定
|
|
56
|
+
|
|
57
|
+
### 3.1 上下文与主题
|
|
58
|
+
|
|
59
|
+
- `host.bridge.enabled: boolean`
|
|
60
|
+
- `host.context.get(): { pluginId, appId, theme, surface, bridge: { enabled } }`
|
|
61
|
+
- `host.theme.get(): string`(当前实现读取 `document.documentElement.dataset.theme`)
|
|
62
|
+
- `host.theme.onChange(listener): () => void`
|
|
63
|
+
|
|
64
|
+
补充说明:
|
|
65
|
+
|
|
66
|
+
- `theme` 取值通常为 `light` / `dark`,宿主会通过 `document.documentElement.dataset.theme` 下发。
|
|
67
|
+
- 本地沙箱右上角提供 Theme 切换(light/dark/system),用于测试 `host.theme.onChange` 与样式响应。
|
|
68
|
+
- 建议使用宿主的 CSS Tokens(`--ds-*`)对齐主题与视觉,例如 `--ds-panel-bg` / `--ds-panel-border` / `--ds-subtle-bg` / `--ds-focus-ring` / `--ds-code-bg` / `--ds-code-border`。
|
|
69
|
+
|
|
70
|
+
### 3.2 Admin(全局配置读取)
|
|
71
|
+
|
|
72
|
+
- `host.admin.state(): Promise<any>`:读取全局 Admin 状态快照
|
|
73
|
+
- `host.admin.onUpdate(listener): () => void`:订阅 Admin 更新事件
|
|
74
|
+
- `host.admin.models.list(): Promise<any>`:列出 Models
|
|
75
|
+
- `host.admin.secrets.list(): Promise<any>`:列出 Secrets(脱敏;不会返回明文 key)
|
|
76
|
+
|
|
77
|
+
说明:
|
|
78
|
+
|
|
79
|
+
- UI Apps **不得**在自己的配置里保存/管理 API Keys;应完全复用宿主全局配置。
|
|
80
|
+
|
|
81
|
+
### 3.3 Registry(插件注册表)
|
|
82
|
+
|
|
83
|
+
- `host.registry.list(): Promise<any>`:等价于 `uiApps:list`(包含 apps 列表、插件目录、加载错误等)
|
|
84
|
+
|
|
85
|
+
### 3.4 Backend(插件后端调用)
|
|
86
|
+
|
|
87
|
+
- `host.backend.invoke(method: string, params?: any): Promise<any>`
|
|
88
|
+
- `method`:后端 `methods` 的 key
|
|
89
|
+
- 返回值:后端方法返回的 `result`(宿主会把 `{ ok, result }` 解包)
|
|
90
|
+
|
|
91
|
+
后端协议详见:[CHATOS_UI_APPS_BACKEND_PROTOCOL.md](./CHATOS_UI_APPS_BACKEND_PROTOCOL.md)。
|
|
92
|
+
|
|
93
|
+
### 3.5 UI Prompts(右下角笑脸:交互待办)
|
|
94
|
+
|
|
95
|
+
用于把“需要用户确认/输入”的交互投递到全局队列,用户无需进入对应应用即可处理。
|
|
96
|
+
|
|
97
|
+
- `host.uiPrompts.read(): Promise<any>`:读取当前队列/最新状态
|
|
98
|
+
- `host.uiPrompts.onUpdate(listener): () => void`:订阅队列变化
|
|
99
|
+
- `host.uiPrompts.request({ prompt, runId?, requestId?, ... }): Promise<any>`:投递待办(`prompt.source` 为空时宿主写入 `${pluginId}:${appId}`)
|
|
100
|
+
- `host.uiPrompts.respond({ requestId, runId?, response }): Promise<any>`:写入用户响应
|
|
101
|
+
- `host.uiPrompts.open(): { ok: true }`:打开笑脸面板
|
|
102
|
+
- `host.uiPrompts.close(): { ok: true }`
|
|
103
|
+
- `host.uiPrompts.toggle(): { ok: true }`
|
|
104
|
+
|
|
105
|
+
`prompt` / `response` 的字段协议见:[CHATOS_UI_PROMPTS_PROTOCOL.md](./CHATOS_UI_PROMPTS_PROTOCOL.md)。
|
|
106
|
+
|
|
107
|
+
### 3.6 导航
|
|
108
|
+
|
|
109
|
+
- `host.ui.navigate(menu: string): { ok: true }`
|
|
110
|
+
- 用于跨应用/跨页面跳转(由宿主统一处理路由)
|
|
111
|
+
- `host.ui.surface: "full" | "compact"`(当前 surface,等价于 `host.context.get().surface`)
|
|
112
|
+
|
|
113
|
+
### 3.7 Chat(Agents / Sessions / Messages / Send / Events)
|
|
114
|
+
|
|
115
|
+
`host.chat` 提供对聊天域的直接操作能力(节选):
|
|
116
|
+
|
|
117
|
+
- `host.chat.agents.list()`
|
|
118
|
+
- `host.chat.agents.ensureDefault()`
|
|
119
|
+
- `host.chat.agents.create(payload)`
|
|
120
|
+
- `host.chat.agents.update(id, patch)`
|
|
121
|
+
- `host.chat.agents.delete(id)`
|
|
122
|
+
- `host.chat.agents.createForApp({ name?, description?, modelId?, promptIds?, subagentIds?, skills?, mcpServerIds? })`
|
|
123
|
+
- 创建一个“绑定当前应用”的 Agent,并自动写入 `uiApps: [{ pluginId, appId, mcp:true, prompt:true }]`
|
|
124
|
+
- `host.chat.sessions.list()`
|
|
125
|
+
- `host.chat.sessions.ensureDefault(payload?)`
|
|
126
|
+
- `host.chat.sessions.create(payload)`
|
|
127
|
+
- `host.chat.messages.list(payload)`
|
|
128
|
+
- `host.chat.send(payload)`
|
|
129
|
+
- `host.chat.abort(payload)`
|
|
130
|
+
- `host.chat.events.subscribe({ sessionId?, types? }, listener): () => void`
|
|
131
|
+
- `host.chat.events.unsubscribe(): { ok: true }`
|
|
132
|
+
|
|
133
|
+
事件订阅说明:
|
|
134
|
+
|
|
135
|
+
- `subscribe` 支持用 `sessionId` 与 `types` 做过滤;
|
|
136
|
+
- 当最后一个 listener 解绑后,宿主会自动取消底层订阅。
|
|
@@ -1,110 +1,115 @@
|
|
|
1
|
-
# ChatOS UI Apps(嵌入应用)概览
|
|
2
|
-
|
|
3
|
-
本文把散落在仓库各处的“ChatOS 嵌入应用(UI Apps 插件)框架/协议”说明提取到仓库根目录,并补齐了若干关键约束(路径边界、打包导入、schema 字段等)。
|
|
4
|
-
|
|
5
|
-
配套文档(按从概览 → 细节的阅读顺序):
|
|
6
|
-
|
|
7
|
-
- [`CHATOS_UI_APPS_PLUGIN_MANIFEST.md`](./CHATOS_UI_APPS_PLUGIN_MANIFEST.md):`plugin.json` / `apps[i].ai` 的清单与字段规范(含完整字段、示例与约束)。
|
|
8
|
-
- [`CHATOS_UI_APPS_HOST_API.md`](./CHATOS_UI_APPS_HOST_API.md):`module` 应用入口与 `host.*` 交互协议(前端侧)。
|
|
9
|
-
- [`
|
|
10
|
-
- [`
|
|
11
|
-
- [`
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
- **
|
|
18
|
-
- **MCP
|
|
19
|
-
- **
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
1
|
+
# ChatOS UI Apps(嵌入应用)概览
|
|
2
|
+
|
|
3
|
+
本文把散落在仓库各处的“ChatOS 嵌入应用(UI Apps 插件)框架/协议”说明提取到仓库根目录,并补齐了若干关键约束(路径边界、打包导入、schema 字段等)。
|
|
4
|
+
|
|
5
|
+
配套文档(按从概览 → 细节的阅读顺序):
|
|
6
|
+
|
|
7
|
+
- [`CHATOS_UI_APPS_PLUGIN_MANIFEST.md`](./CHATOS_UI_APPS_PLUGIN_MANIFEST.md):`plugin.json` / `apps[i].ai` 的清单与字段规范(含完整字段、示例与约束)。
|
|
8
|
+
- [`CHATOS_UI_APPS_HOST_API.md`](./CHATOS_UI_APPS_HOST_API.md):`module` 应用入口与 `host.*` 交互协议(前端侧)。
|
|
9
|
+
- [`CHATOS_UI_APPS_STYLE_GUIDE.md`](./CHATOS_UI_APPS_STYLE_GUIDE.md):主题与样式约定(CSS Tokens / 主题切换)。
|
|
10
|
+
- [`CHATOS_UI_APPS_TROUBLESHOOTING.md`](./CHATOS_UI_APPS_TROUBLESHOOTING.md):常见问题与排查清单。
|
|
11
|
+
- [`CHATOS_UI_PROMPTS_PROTOCOL.md`](./CHATOS_UI_PROMPTS_PROTOCOL.md):右下角笑脸「交互待办(UI Prompts)」协议(表单/单选/多选/复杂确认)。
|
|
12
|
+
- [`CHATOS_UI_APPS_BACKEND_PROTOCOL.md`](./CHATOS_UI_APPS_BACKEND_PROTOCOL.md):插件后端(Electron main 进程)协议与 `ctx` 运行时上下文。
|
|
13
|
+
- [`CHATOS_UI_APPS_AI_CONTRIBUTIONS.md`](./CHATOS_UI_APPS_AI_CONTRIBUTIONS.md):应用如何对 Chat Agent 暴露 MCP/Prompt(含命名规则、合并规则、内置清单机制)。
|
|
14
|
+
|
|
15
|
+
## 术语与角色
|
|
16
|
+
|
|
17
|
+
- **ChatOS(宿主)**:桌面端 Electron 应用(本仓库的 `chatos`)。
|
|
18
|
+
- **AIDE(引擎)**:模型调用/工具/MCP/子代理等核心能力(本仓库的 `aide`)。
|
|
19
|
+
- **UI Apps(嵌入应用/小应用)**:以插件形式注入到桌面端「应用」中心的应用。
|
|
20
|
+
- **MCP**:Model Context Protocol;通过 MCP Server 暴露 tools,最终工具名通常为 `mcp_<serverName>_<toolName>`。
|
|
21
|
+
- **Prompt**:system prompt 模板;可被 Agent 勾选并注入运行时 system prompt。
|
|
22
|
+
|
|
23
|
+
## 目录与状态(sessionRoot / stateDir)
|
|
24
|
+
|
|
23
25
|
- `sessionRoot`:会话根目录
|
|
24
26
|
- 默认:用户主目录(Home)
|
|
25
27
|
- 可通过环境变量覆盖:`MODEL_CLI_SESSION_ROOT=/path/to/root`
|
|
26
|
-
|
|
27
|
-
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
- `stateDir/auth/
|
|
36
|
-
- `stateDir/auth
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
- `apps[i].
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
- `
|
|
110
|
-
- `
|
|
28
|
+
- `stateRoot`:用户状态根目录
|
|
29
|
+
- 桌面端/CLI 会把“上次使用的 sessionRoot”记录到 `<stateRoot>/last-session-root.txt`(未设置 env 时会优先读取)
|
|
30
|
+
- `stateDir`:`<stateRoot>/<hostApp>`(ChatOS 的 `hostApp=chatos`)
|
|
31
|
+
- 兼容旧路径:若存在 `legacyStateRoot/<hostApp>`,启动时会自动迁移到 `stateDir`
|
|
32
|
+
|
|
33
|
+
全局配置(由宿主维护;应用侧只读/复用):
|
|
34
|
+
|
|
35
|
+
- `stateDir/chatos.db.sqlite`:Admin DB(Models / Secrets / MCP Servers / Prompts / Settings…)
|
|
36
|
+
- 文件镜像(从 Admin DB 同步出来,便于运行时读取):
|
|
37
|
+
- `stateDir/auth/models.yaml`
|
|
38
|
+
- `stateDir/auth/mcp.config.json`
|
|
39
|
+
- `stateDir/auth/system-prompt.yaml`
|
|
40
|
+
- `stateDir/auth/*prompt*.yaml`
|
|
41
|
+
|
|
42
|
+
原则:
|
|
43
|
+
|
|
44
|
+
- **Secrets(API Keys)只存 DB**,不会明文同步到 yaml。
|
|
45
|
+
- 运行前宿主会把 Secrets 写入 `process.env`(受 `override` 控制),Provider 通过 `apiKeyEnv` 取值。
|
|
46
|
+
|
|
47
|
+
## UI Apps 插件目录(宿主扫描)
|
|
48
|
+
|
|
49
|
+
宿主会扫描两个目录(并在 UI「应用」页展示实际路径):
|
|
50
|
+
|
|
51
|
+
- **内置/开发目录**:`chatos/ui_apps/plugins`
|
|
52
|
+
- **用户插件目录**:`<stateDir>/ui_apps/plugins`(`stateDir = <stateRoot>/<hostApp>`)
|
|
53
|
+
|
|
54
|
+
同名 `plugin.id` 的覆盖规则:
|
|
55
|
+
|
|
56
|
+
- 用户目录的插件会覆盖内置目录的同 `plugin.id` 插件(便于开发调试/热替换)。
|
|
57
|
+
|
|
58
|
+
插件数据目录(供插件后端存放自己的持久化数据):
|
|
59
|
+
|
|
60
|
+
- `dataDir`:`<stateDir>/ui_apps/data/<pluginId>`
|
|
61
|
+
- 插件后端的持久化数据写入目录为 `dataDir`;插件安装目录用于读取插件资源。
|
|
62
|
+
|
|
63
|
+
## 插件包导入(目录或 .zip)
|
|
64
|
+
|
|
65
|
+
桌面端 UI 支持:`应用` → `导入应用包` → 选择插件目录或 `.zip`。
|
|
66
|
+
|
|
67
|
+
包结构要求:
|
|
68
|
+
|
|
69
|
+
- `plugin.json` 在包根目录;或
|
|
70
|
+
- 包根目录下一层目录中包含一个或多个插件目录(每个目录内有 `plugin.json`)。
|
|
71
|
+
|
|
72
|
+
导入时的复制规则(重要):
|
|
73
|
+
|
|
74
|
+
- 会拷贝到用户插件目录 `<stateDir>/ui_apps/plugins/<sanitized(plugin.id)>/`;
|
|
75
|
+
- 默认会排除:`node_modules/`、`.git/`、`.DS_Store`、`*.map`;
|
|
76
|
+
- 因此若插件需要依赖,请在构建时做 bundle(不要指望随包携带 `node_modules` 生效)。
|
|
77
|
+
|
|
78
|
+
## 安全边界与硬约束(协议的一部分)
|
|
79
|
+
|
|
80
|
+
为避免插件越权读取宿主文件系统,宿主对“路径型字段”做了强约束:
|
|
81
|
+
|
|
82
|
+
- `apps[i].entry.path` 必须位于插件目录内,且必须是文件(`module` 入口)。
|
|
83
|
+
- `apps[i].entry.compact.path`(可选)同样必须位于插件目录内,且必须是文件。
|
|
84
|
+
- `backend.entry` 必须位于插件目录内,且必须是文件。
|
|
85
|
+
- `apps[i].ai.config`、`ai.mcp.entry`、`ai.mcpPrompt.*.path` 等所有 path 都必须位于插件目录内。
|
|
86
|
+
|
|
87
|
+
尺寸限制(默认值,防止误导入超大文件):
|
|
88
|
+
|
|
89
|
+
- `plugin.json` 最大 `256 KiB`
|
|
90
|
+
- `mcpPrompt` 内容最大 `128 KiB`(读取 path 或 inline content 都受限)
|
|
91
|
+
|
|
92
|
+
## 最短接入路径(TL;DR)
|
|
93
|
+
|
|
94
|
+
1) 从模板复制:`chatos/ui_apps/template/basic-plugin` → 放进任一插件目录
|
|
95
|
+
2) 修改 `plugin.json`:只支持 `apps[i].entry.type="module"`(可选增加 `entry.compact` 作为紧凑 UI 入口)
|
|
96
|
+
3) 桌面端打开「应用」页 → 点“刷新” → 进入你的应用
|
|
97
|
+
4) (可选)需要 Node 能力:加 `backend.entry`,前端用 `host.backend.invoke()`
|
|
98
|
+
5) (可选)需要给 Agent 暴露工具/说明:配置 `apps[i].ai`(见 [`CHATOS_UI_APPS_AI_CONTRIBUTIONS.md`](./CHATOS_UI_APPS_AI_CONTRIBUTIONS.md))
|
|
99
|
+
|
|
100
|
+
提示:`ai.mcp` / `ai.mcpPrompt` 是否持久化写入 Admin DB,取决于宿主是否启用 `syncAiContributes`;即使不持久化,Agent 运行时也可以按 `apps[i].ai` 声明进行“临时注入”。
|
|
101
|
+
|
|
102
|
+
## 实现位置(便于对照代码)
|
|
103
|
+
|
|
104
|
+
- schema(`plugin.json` / `apps[i].ai`):`chatos/electron/ui-apps/schemas.js`
|
|
105
|
+
- 插件扫描/入口校验/AI 同步:`chatos/electron/ui-apps/index.js`
|
|
106
|
+
- 应用包导入(目录/zip):`chatos/electron/ui-apps/plugin-installer.js`
|
|
107
|
+
- module 运行时 Host API 注入:`chatos/apps/ui/src/features/apps/AppsPluginView.jsx`
|
|
108
|
+
|
|
109
|
+
## 原始文档来源(本次提取/整合)
|
|
110
|
+
|
|
111
|
+
- `chatos/doc/app-dev-handbook.md`
|
|
112
|
+
- `chatos/doc/app-integration.md`
|
|
113
|
+
- `chatos/doc/ui-apps-plugins.md`
|
|
114
|
+
- `chatos/doc/ui-apps-dev-guide.md`
|
|
115
|
+
- `aide/shared/defaults/ui-apps-expose/README.md`
|