@leeoohoo/ui-apps-devkit 0.1.0

package/templates/notepad/docs/CHATOS_UI_APPS_HOST_API.md

@@ -0,0 +1,123 @@
+# ChatOS UI Apps：`module` 入口与 Host API（协议）
+
+本文件定义 UI Apps 的 `module` 入口规范，以及宿主注入的 `host` 对象（应用与 ChatOS 交互的稳定契约）。
+
+实现对照（以代码为准）：
+
+- `deepseek_cli/apps/ui/src/features/apps/AppsPluginView.jsx`
+
+## 1. module 入口规范
+
+`plugin.json` 中的入口示例：
+
+```json
+{ "type": "module", "path": "my-app/index.mjs" }
+```
+
+入口模块需导出 `mount`（以下三种写法宿主都接受）：
+
+- `export function mount(...) { ... }`
+- `export default { mount(...) { ... } }`
+- `export default function mount(...) { ... }`
+
+`mount` 签名：
+
+```js
+export function mount({ container, host, slots }) {
+  return () => {}; // or return { dispose() {} }
+}
+```
+
+- `container`：应用正文容器（body）
+- `slots.header`：可选固定 Header 容器（不随 body 滚动）
+- 返回值：
+  - `() => void|Promise<void>`：卸载回调；或
+  - `{ dispose(): void|Promise<void> }`
+
+布局规范：
+
+- 不要使用 `window/body` 作为滚动容器；把滚动放到应用内部。
+- 将 Tabs/二级导航/操作按钮等放到 `slots.header`，可滚动内容放到 `container`。
+
+## 2. Host Bridge 可用性
+
+宿主仅在“file-based entry + preload bridge 可用”的情况下提供 `host` 能力；否则会抛错：
+
+- 若你在非 ChatOS 宿主环境下单独打开页面（或 preload 未加载），`host.bridge.enabled` 可能为 `false`。
+- 生产场景（桌面端应用内）一般为 `true`。
+
+## 3. `host` API 约定
+
+### 3.1 上下文与主题
+
+- `host.bridge.enabled: boolean`
+- `host.context.get(): { pluginId, appId, theme, bridge: { enabled } }`
+- `host.theme.get(): string`（当前实现读取 `document.documentElement.dataset.theme`）
+- `host.theme.onChange(listener): () => void`
+
+### 3.2 Admin（全局配置读取）
+
+- `host.admin.state(): Promise<any>`：读取全局 Admin 状态快照
+- `host.admin.onUpdate(listener): () => void`：订阅 Admin 更新事件
+- `host.admin.models.list(): Promise<any>`：列出 Models
+- `host.admin.secrets.list(): Promise<any>`：列出 Secrets（脱敏；不会返回明文 key）
+
+说明：
+
+- UI Apps **不得**在自己的配置里保存/管理 API Keys；应完全复用宿主全局配置。
+
+### 3.3 Registry（插件注册表）
+
+- `host.registry.list(): Promise<any>`：等价于 `uiApps:list`（包含 apps 列表、插件目录、加载错误等）
+
+### 3.4 Backend（插件后端调用）
+
+- `host.backend.invoke(method: string, params?: any): Promise<any>`
+  - `method`：后端 `methods` 的 key
+  - 返回值：后端方法返回的 `result`（宿主会把 `{ ok, result }` 解包）
+
+后端协议详见：[CHATOS_UI_APPS_BACKEND_PROTOCOL.md](./CHATOS_UI_APPS_BACKEND_PROTOCOL.md)。
+
+### 3.5 UI Prompts（右下角笑脸：交互待办）
+
+用于把“需要用户确认/输入”的交互投递到全局队列，用户无需进入对应应用即可处理。
+
+- `host.uiPrompts.read(): Promise<any>`：读取当前队列/最新状态
+- `host.uiPrompts.onUpdate(listener): () => void`：订阅队列变化
+- `host.uiPrompts.request({ prompt, runId?, requestId?, ... }): Promise<any>`：投递待办（`prompt.source` 为空时宿主写入 `${pluginId}:${appId}`）
+- `host.uiPrompts.respond({ requestId, runId?, response }): Promise<any>`：写入用户响应
+- `host.uiPrompts.open(): { ok: true }`：打开笑脸面板
+- `host.uiPrompts.close(): { ok: true }`
+- `host.uiPrompts.toggle(): { ok: true }`
+
+`prompt` / `response` 的字段协议见：[CHATOS_UI_PROMPTS_PROTOCOL.md](./CHATOS_UI_PROMPTS_PROTOCOL.md)。
+
+### 3.6 导航
+
+- `host.ui.navigate(menu: string): { ok: true }`
+  - 用于跨应用/跨页面跳转（由宿主统一处理路由）
+
+### 3.7 Chat（Agents / Sessions / Messages / Send / Events）
+
+`host.chat` 提供对聊天域的直接操作能力（节选）：
+
+- `host.chat.agents.list()`
+- `host.chat.agents.ensureDefault()`
+- `host.chat.agents.create(payload)`
+- `host.chat.agents.update(id, patch)`
+- `host.chat.agents.delete(id)`
+- `host.chat.agents.createForApp({ name?, description?, modelId?, promptIds?, subagentIds?, skills?, mcpServerIds? })`
+  - 创建一个“绑定当前应用”的 Agent，并自动写入 `uiApps: [{ pluginId, appId, mcp:true, prompt:true }]`
+- `host.chat.sessions.list()`
+- `host.chat.sessions.ensureDefault(payload?)`
+- `host.chat.sessions.create(payload)`
+- `host.chat.messages.list(payload)`
+- `host.chat.send(payload)`
+- `host.chat.abort(payload)`
+- `host.chat.events.subscribe({ sessionId?, types? }, listener): () => void`
+- `host.chat.events.unsubscribe(): { ok: true }`
+
+事件订阅说明：
+
+- `subscribe` 支持用 `sessionId` 与 `types` 做过滤；
+- 当最后一个 listener 解绑后，宿主会自动取消底层订阅。

package/templates/notepad/docs/CHATOS_UI_APPS_OVERVIEW.md

@@ -0,0 +1,110 @@
+# ChatOS UI Apps（嵌入应用）概览
+
+本文把散落在仓库各处的“ChatOS 嵌入应用（UI Apps 插件）框架/协议”说明提取到仓库根目录，并补齐了若干关键约束（路径边界、打包导入、schema 字段等）。
+
+配套文档（按从概览 → 细节的阅读顺序）：
+
+- [`CHATOS_UI_APPS_PLUGIN_MANIFEST.md`](./CHATOS_UI_APPS_PLUGIN_MANIFEST.md)：`plugin.json` / `apps[i].ai` 的清单与字段规范（含完整字段、示例与约束）。
+- [`CHATOS_UI_APPS_HOST_API.md`](./CHATOS_UI_APPS_HOST_API.md)：`module` 应用入口与 `host.*` 交互协议（前端侧）。
+- [`CHATOS_UI_PROMPTS_PROTOCOL.md`](./CHATOS_UI_PROMPTS_PROTOCOL.md)：右下角笑脸「交互待办（UI Prompts）」协议（表单/单选/多选/复杂确认）。
+- [`CHATOS_UI_APPS_BACKEND_PROTOCOL.md`](./CHATOS_UI_APPS_BACKEND_PROTOCOL.md)：插件后端（Electron main 进程）协议与 `ctx` 运行时上下文。
+- [`CHATOS_UI_APPS_AI_CONTRIBUTIONS.md`](./CHATOS_UI_APPS_AI_CONTRIBUTIONS.md)：应用如何对 Chat Agent 暴露 MCP/Prompt（含命名规则、合并规则、内置清单机制）。
+
+## 术语与角色
+
+- **ChatOS（宿主）**：桌面端 Electron 应用（本仓库的 `deepseek_cli`）。
+- **AIDE（引擎）**：模型调用/工具/MCP/子代理等核心能力（本仓库的 `aide`）。
+- **UI Apps（嵌入应用/小应用）**：以插件形式注入到桌面端「应用」中心的应用。
+- **MCP**：Model Context Protocol；通过 MCP Server 暴露 tools，最终工具名通常为 `mcp_<serverName>_<toolName>`。
+- **Prompt**：system prompt 模板；可被 Agent 勾选并注入运行时 system prompt。
+
+## 目录与状态（sessionRoot / stateDir）
+
+- `sessionRoot`：会话根目录
+  - 默认：用户主目录（Home）
+  - 可通过环境变量覆盖：`MODEL_CLI_SESSION_ROOT=/path/to/root`
+  - 桌面端/CLI 会把“上次使用的 sessionRoot”记录到 `<home>/.deepseek_cli/last-session-root.txt`（未设置 env 时会优先读取）
+- `stateDir`：`<home>/.deepseek_cli/<hostApp>`（ChatOS 的 `hostApp=chatos`）
+
+全局配置（由宿主维护；应用侧只读/复用）：
+
+- `stateDir/chatos.db.sqlite`：Admin DB（Models / Secrets / MCP Servers / Prompts / Settings…）
+- 文件镜像（从 Admin DB 同步出来，便于运行时读取）：
+  - `stateDir/auth/models.yaml`
+  - `stateDir/auth/mcp.config.json`
+  - `stateDir/auth/system-prompt.yaml`
+  - `stateDir/auth/*prompt*.yaml`
+
+原则：
+
+- **Secrets（API Keys）只存 DB**，不会明文同步到 yaml。
+- 运行前宿主会把 Secrets 写入 `process.env`（受 `override` 控制），Provider 通过 `apiKeyEnv` 取值。
+
+## UI Apps 插件目录（宿主扫描）
+
+宿主会扫描两个目录（并在 UI「应用」页展示实际路径）：
+
+- **内置/开发目录**：`deepseek_cli/ui_apps/plugins`
+- **用户插件目录**：`<stateDir>/ui_apps/plugins`（即 `~/.deepseek_cli/chatos/ui_apps/plugins`）
+
+同名 `plugin.id` 的覆盖规则：
+
+- 用户目录的插件会覆盖内置目录的同 `plugin.id` 插件（便于开发调试/热替换）。
+
+插件数据目录（供插件后端存放自己的持久化数据）：
+
+- `dataDir`：`<stateDir>/ui_apps/data/<pluginId>`
+- 插件后端的持久化数据写入目录为 `dataDir`；插件安装目录用于读取插件资源。
+
+## 插件包导入（目录或 .zip）
+
+桌面端 UI 支持：`应用` → `导入应用包` → 选择插件目录或 `.zip`。
+
+包结构要求：
+
+- `plugin.json` 在包根目录；或
+- 包根目录下一层目录中包含一个或多个插件目录（每个目录内有 `plugin.json`）。
+
+导入时的复制规则（重要）：
+
+- 会拷贝到用户插件目录 `~/.deepseek_cli/chatos/ui_apps/plugins/<sanitized(plugin.id)>/`；
+- 默认会排除：`node_modules/`、`.git/`、`.DS_Store`、`*.map`；
+- 因此若插件需要依赖，请在构建时做 bundle（不要指望随包携带 `node_modules` 生效）。
+
+## 安全边界与硬约束（协议的一部分）
+
+为避免插件越权读取宿主文件系统，宿主对“路径型字段”做了强约束：
+
+- `apps[i].entry.path` 必须位于插件目录内，且必须是文件（`module` 入口）。
+- `backend.entry` 必须位于插件目录内，且必须是文件。
+- `apps[i].ai.config`、`ai.mcp.entry`、`ai.mcpPrompt.*.path` 等所有 path 都必须位于插件目录内。
+
+尺寸限制（默认值，防止误导入超大文件）：
+
+- `plugin.json` 最大 `256 KiB`
+- `mcpPrompt` 内容最大 `128 KiB`（读取 path 或 inline content 都受限）
+
+## 最短接入路径（TL;DR）
+
+1) 从模板复制：`deepseek_cli/ui_apps/template/basic-plugin` → 放进任一插件目录  
+2) 修改 `plugin.json`：只支持 `apps[i].entry.type="module"`  
+3) 桌面端打开「应用」页 → 点“刷新” → 进入你的应用  
+4) （可选）需要 Node 能力：加 `backend.entry`，前端用 `host.backend.invoke()`  
+5) （可选）需要给 Agent 暴露工具/说明：配置 `apps[i].ai`（见 [`CHATOS_UI_APPS_AI_CONTRIBUTIONS.md`](./CHATOS_UI_APPS_AI_CONTRIBUTIONS.md)）
+
+提示：`ai.mcp` / `ai.mcpPrompt` 是否持久化写入 Admin DB，取决于宿主是否启用 `syncAiContributes`；即使不持久化，Agent 运行时也可以按 `apps[i].ai` 声明进行“临时注入”。
+
+## 实现位置（便于对照代码）
+
+- schema（`plugin.json` / `apps[i].ai`）：`deepseek_cli/electron/ui-apps/schemas.js`
+- 插件扫描/入口校验/AI 同步：`deepseek_cli/electron/ui-apps/index.js`
+- 应用包导入（目录/zip）：`deepseek_cli/electron/ui-apps/plugin-installer.js`
+- module 运行时 Host API 注入：`deepseek_cli/apps/ui/src/features/apps/AppsPluginView.jsx`
+
+## 原始文档来源（本次提取/整合）
+
+- `deepseek_cli/doc/app-dev-handbook.md`
+- `deepseek_cli/doc/app-integration.md`
+- `deepseek_cli/doc/ui-apps-plugins.md`
+- `deepseek_cli/doc/ui-apps-dev-guide.md`
+- `aide/shared/defaults/ui-apps-expose/README.md`

package/templates/notepad/docs/CHATOS_UI_APPS_PLUGIN_MANIFEST.md

@@ -0,0 +1,227 @@
+# ChatOS UI Apps：`plugin.json` 清单规范（协议）
+
+本文件定义 UI Apps 插件清单 `plugin.json` 的字段与约束，目标是让第三方/内置应用都能按统一契约被 ChatOS 扫描、加载与运行。
+
+实现对照（以代码为准）：
+
+- schema：`deepseek_cli/electron/ui-apps/schemas.js`
+- 扫描/校验：`deepseek_cli/electron/ui-apps/index.js`
+- 导入/安装：`deepseek_cli/electron/ui-apps/plugin-installer.js`
+
+另见：
+
+- [`CHATOS_UI_APPS_HOST_API.md`](./CHATOS_UI_APPS_HOST_API.md)（`module` 应用与宿主交互）
+- [`CHATOS_UI_APPS_BACKEND_PROTOCOL.md`](./CHATOS_UI_APPS_BACKEND_PROTOCOL.md)（插件后端）
+- [`CHATOS_UI_APPS_AI_CONTRIBUTIONS.md`](./CHATOS_UI_APPS_AI_CONTRIBUTIONS.md)（MCP/Prompt 暴露）
+
+## 1. 文件与安装位置
+
+- 每个插件一个目录，目录根部必须包含 `plugin.json`。
+- 插件目录可放在：
+  - `deepseek_cli/ui_apps/plugins`（内置/开发）
+  - `~/.deepseek_cli/chatos/ui_apps/plugins`（用户插件目录）
+- 也可通过桌面端 UI：`应用` → `导入应用包`（目录或 `.zip`）安装到用户插件目录。
+
+## 2. 顶层 schema（`uiAppsPluginSchema`）
+
+`plugin.json`（Top-level）字段：
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---:|---:|---|---|
+| `manifestVersion` | `number` | 否 | `1` | 目前仅支持 `1` |
+| `id` | `string` | 是 | - | 插件 ID（使用反向域名；稳定且全局唯一） |
+| `name` | `string` | 是 | - | 插件显示名称 |
+| `version` | `string` | 否 | `"0.0.0"` | 版本号（展示用途） |
+| `description` | `string` | 否 | `""` | 插件描述 |
+| `backend` | `object` | 否 | - | 插件后端（Electron main 进程） |
+| `apps` | `array` | 否 | `[]` | 插件内的应用列表 |
+
+`backend`：
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---:|---:|---|
+| `backend.entry` | `string` | 是 | 后端入口模块路径（相对插件目录；必须在插件目录内且是文件） |
+
+## 3. apps schema（`uiAppSchema`）
+
+`apps[i]` 字段：
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---:|---:|---|---|
+| `id` | `string` | 是 | - | 应用 ID（同一插件内唯一） |
+| `name` | `string` | 是 | - | 应用显示名称 |
+| `description` | `string` | 否 | `""` | 描述 |
+| `icon` | `string` | 否 | `""` | 图标（当前实现以字符串透传为主） |
+| `entry` | `object` | 是 | - | 入口（仅支持 `module`） |
+| `ai` | `object|string` | 否 | - | AI 声明（MCP/Prompt/暴露列表等；详见下文） |
+
+### 3.1 `apps[i].entry`（仅支持 `module`）
+
+```json
+{ "type": "module", "path": "my-app/index.mjs" }
+```
+
+硬约束：
+
+- `entry.type` 必须为 `"module"`（ChatOS 不支持 `iframe/url`）。
+- `entry.path` 必须在插件目录内（宿主做路径边界校验），且必须是文件。
+
+## 4. `apps[i].ai` schema（`uiAppAiSchema`）
+
+`ai` 可以写成两种形式：
+
+1) **对象**（inline）：
+
+```json
+{
+  "ai": {
+    "mcpServers": true,
+    "prompts": true
+  }
+}
+```
+
+2) **字符串路径**（等价于 `{ "config": "<path>" }`）：
+
+```json
+{ "ai": "my-app/ai.yaml" }
+```
+
+对象形式还支持额外带一个 `config` 字段，用于从文件读取并与 inline 合并：
+
+```json
+{
+  "ai": {
+    "config": "my-app/ai.yaml",
+    "mcpServers": true,
+    "prompts": true
+  }
+}
+```
+
+所有 `ai` 的 path（`ai.config`、`ai.mcp.entry`、`ai.mcpPrompt.*.path`）都必须在插件目录内，且文件大小受限（默认最大 `128 KiB`）。
+
+### 4.1 `ai` 字段一览（`uiAppAiConfigSchema`）
+
+| 字段 | 类型 | 说明 |
+|---|---:|---|
+| `ai.mcp` | `object` | 声明并同步一个 MCP Server（`serverName` 固定派生为 `${pluginId}.${appId}`） |
+| `ai.mcpPrompt` | `string|object` | 声明并同步一个 system prompt（名称固定派生） |
+| `ai.mcpServers` | `true|false|string[]` | 暴露给 Agent 的 MCP servers 范围（聚合“已有的”资源） |
+| `ai.prompts` | `true|false|string[]` | 暴露给 Agent 的 prompts 范围（聚合“已有的”资源） |
+| `ai.agent` | `object` | 可选：应用提供的 Agent 模板（当前实现主要做透传/保留字段） |
+
+## 5. `ai.mcp`：MCP Server 声明
+
+`ai.mcp` 字段（当前 schema）：
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---:|---:|---|---|
+| `url` | `string` | 二选一 | - | 远程 MCP Server 地址（`http(s)://` / `ws(s)://` 等） |
+| `entry` | `string` | 二选一 | - | 本地脚本入口（相对插件目录）；宿主会转换为 `cmd://...` |
+| `command` | `string` | 否 | `"node"` | 拉起本地 `entry` 时使用的命令 |
+| `args` | `string[]` | 否 | `[]` | 拉起时追加参数 |
+| `description` | `string` | 否 | `""` | 描述 |
+| `tags` | `string[]` | 否 | `[]` | 标签（宿主还会自动附加 `uiapp*` 标签） |
+| `enabled` | `boolean` | 否 | - | 是否启用（未填则宿主同步时默认 `true`） |
+| `allowMain` | `boolean` | 否 | - | 是否允许主流程使用（未填则宿主同步时默认 `true`） |
+| `allowSub` | `boolean` | 否 | - | 是否允许子代理使用（未填则宿主同步时默认 `true`） |
+| `auth` | `object` | 否 | - | 认证信息（token/basic/headers） |
+
+强约束：
+
+- 必须提供 `url` 或 `entry` 其中之一（只写 `command` 不算有效配置）。
+
+`auth` 结构（均为可选，且支持 partial）：
+
+```json
+{
+  "auth": {
+    "token": "…",
+    "basic": { "username": "u", "password": "p" },
+    "headers": { "X-Foo": "bar" }
+  }
+}
+```
+
+当使用 `entry` 时，宿主会把它转换为可运行的 `cmd://`：
+
+- `command` 默认为 `node`
+- `args` 会追加到命令行末尾
+- 宿主会把空格/引号等做安全引用，以避免路径包含空格时解析失败
+
+## 6. `ai.mcpPrompt`：应用默认 Prompt 声明
+
+`ai.mcpPrompt` 支持两种写法：
+
+1) **字符串**：等价于中文 prompt 从该路径读取：
+
+```json
+{ "mcpPrompt": "my-app/mcp-prompt.zh.md" }
+```
+
+2) **对象**：可分别提供 `zh`/`en`，并支持 path 或 inline content：
+
+```json
+{
+  "mcpPrompt": {
+    "title": "My App · MCP Prompt",
+    "zh": "my-app/mcp-prompt.zh.md",
+    "en": { "path": "my-app/mcp-prompt.en.md" }
+  }
+}
+```
+
+`zh/en` 的“source”结构为：
+
+```json
+{ "path": "relative.md", "content": "inline markdown…" }
+```
+
+约束：
+
+- `mcpPrompt` 必须至少提供 `zh` 或 `en` 其一；
+- 若提供 `path`，必须在插件目录内且是文件；
+- 内容大小受限（默认最大 `128 KiB`）。
+
+## 7. `ai.mcpServers` / `ai.prompts`：聚合暴露范围
+
+- `true`：开启暴露（“具体暴露哪些”由 `ai.config` / 内置默认清单决定；否则表示全部）
+- `false`：禁用暴露
+- `string[]`：精确列出允许暴露的 `serverName` / `prompt name`
+
+注意：这里定义的是“在 Agent UI 中可选/可见的范围”，最终是否启用、启用哪些仍由 Agent 编辑页勾选决定。
+
+## 8. 最小示例
+
+### 8.1 最小可运行插件（仅 module）
+
+```json
+{
+  "manifestVersion": 1,
+  "id": "com.example.tools",
+  "name": "Example Tools",
+  "version": "0.1.0",
+  "apps": [
+    {
+      "id": "hello",
+      "name": "Hello App（Module）",
+      "entry": { "type": "module", "path": "hello/index.mjs" }
+    }
+  ]
+}
+```
+
+### 8.2 带后端 + MCP/Prompt 的应用（节选）
+
+```json
+{
+  "id": "db-client",
+  "name": "数据库客户端",
+  "entry": { "type": "module", "path": "db-client/index.mjs" },
+  "ai": {
+    "mcp": { "entry": "db-client/mcp-server.mjs", "command": "node", "allowMain": true, "allowSub": true },
+    "mcpPrompt": { "zh": "db-client/mcp-prompt.zh.md", "en": "db-client/mcp-prompt.en.md" }
+  }
+}
+```