@leeoohoo/ui-apps-devkit 0.1.2 → 0.1.3

package/templates/basic/plugin/apps/app/mcp-prompt.zh.md

@@ -1,7 +1,7 @@
-# __PLUGIN_NAME__ · MCP Prompt（中文）
-
-你是一个 ChatOS 应用的工具助手。
-
-- 对应 MCP Server：`__PLUGIN_ID__.__APP_ID__`
-- 当用户需要使用该应用能力时，优先调用该 MCP tools。
-
+# __PLUGIN_NAME__ · MCP Prompt（中文）
+
+你是一个 ChatOS 应用的工具助手。
+
+- 对应 MCP Server：`__PLUGIN_ID__.__APP_ID__`
+- 当用户需要使用该应用能力时，优先调用该 MCP tools。
+

package/templates/basic/plugin/apps/app/mcp-server.mjs

@@ -1,15 +1,15 @@
-/**
- * MCP Server 入口（可选）
- *
- * 注意：
- * - ChatOS 导入插件包时会默认排除 `node_modules/`，因此这里不要依赖“随包携带的依赖”。
- * - 若你需要使用 `@modelcontextprotocol/sdk`，请在 build 阶段做 bundle（把依赖打进单文件）。
- *
- * 你可以：
- * 1) 用 bundler（esbuild/rollup）把 MCP Server 打包成单文件，并在 plugin.json 里把 `ai.mcp.entry` 指向打包产物；
- * 2) 或者把依赖源码 vendoring 到插件目录内，使用相对路径 import。
- */
-
-// TODO: 实现你自己的 MCP Server（stdio）。建议把日志写到 stderr，不要污染 stdout。
-console.error('[mcp] placeholder: implement your MCP server here');
-process.exit(1);
+/**
+ * MCP Server 入口（可选）
+ *
+ * 注意：
+ * - ChatOS 导入插件包时会默认排除 `node_modules/`，因此这里不要依赖“随包携带的依赖”。
+ * - 若你需要使用 `@modelcontextprotocol/sdk`，请在 build 阶段做 bundle（把依赖打进单文件）。
+ *
+ * 你可以：
+ * 1) 用 bundler（esbuild/rollup）把 MCP Server 打包成单文件，并在 plugin.json 里把 `ai.mcp.entry` 指向打包产物；
+ * 2) 或者把依赖源码 vendoring 到插件目录内，使用相对路径 import。
+ */
+
+// TODO: 实现你自己的 MCP Server（stdio）。建议把日志写到 stderr，不要污染 stdout。
+console.error('[mcp] placeholder: implement your MCP server here');
+process.exit(1);

package/templates/basic/plugin/backend/index.mjs

@@ -1,37 +1,37 @@
-export async function createUiAppsBackend(ctx) {
-  const llmComplete = async (params, runtimeCtx) => {
-    const api = runtimeCtx?.llm || ctx?.llm || null;
-    if (!api || typeof api.complete !== 'function') {
-      throw new Error('Host LLM bridge is not available (ctx.llm.complete)');
-    }
-    const input = typeof params?.input === 'string' ? params.input : typeof params?.prompt === 'string' ? params.prompt : '';
-    const normalized = String(input || '').trim();
-    if (!normalized) {
-      throw new Error('input is required');
-    }
-    return await api.complete({
-      input: normalized,
-      modelId: typeof params?.modelId === 'string' ? params.modelId : undefined,
-      modelName: typeof params?.modelName === 'string' ? params.modelName : undefined,
-      systemPrompt: typeof params?.systemPrompt === 'string' ? params.systemPrompt : undefined,
-      disableTools: params?.disableTools,
-    });
-  };
-
-  return {
-    methods: {
-      async ping(params, runtimeCtx) {
-        return {
-          ok: true,
-          now: new Date().toISOString(),
-          pluginId: runtimeCtx?.pluginId || ctx?.pluginId || '',
-          params: params ?? null,
-        };
-      },
-
-      async llmComplete(params, runtimeCtx) {
-        return await llmComplete(params, runtimeCtx);
-      },
-    },
-  };
-}
+export async function createUiAppsBackend(ctx) {
+  const llmComplete = async (params, runtimeCtx) => {
+    const api = runtimeCtx?.llm || ctx?.llm || null;
+    if (!api || typeof api.complete !== 'function') {
+      throw new Error('Host LLM bridge is not available (ctx.llm.complete)');
+    }
+    const input = typeof params?.input === 'string' ? params.input : typeof params?.prompt === 'string' ? params.prompt : '';
+    const normalized = String(input || '').trim();
+    if (!normalized) {
+      throw new Error('input is required');
+    }
+    return await api.complete({
+      input: normalized,
+      modelId: typeof params?.modelId === 'string' ? params.modelId : undefined,
+      modelName: typeof params?.modelName === 'string' ? params.modelName : undefined,
+      systemPrompt: typeof params?.systemPrompt === 'string' ? params.systemPrompt : undefined,
+      disableTools: params?.disableTools,
+    });
+  };
+
+  return {
+    methods: {
+      async ping(params, runtimeCtx) {
+        return {
+          ok: true,
+          now: new Date().toISOString(),
+          pluginId: runtimeCtx?.pluginId || ctx?.pluginId || '',
+          params: params ?? null,
+        };
+      },
+
+      async llmComplete(params, runtimeCtx) {
+        return await llmComplete(params, runtimeCtx);
+      },
+    },
+  };
+}

package/templates/basic/template.json

@@ -1,7 +1,7 @@
-{
-  "description": "基础模板：无依赖 module + backend.invoke 示例 + uiPrompts 示例",
-  "defaults": {
-    "appId": "app",
-    "withBackend": true
-  }
-}
+{
+  "description": "基础模板：无依赖 module + backend.invoke 示例 + uiPrompts 示例",
+  "defaults": {
+    "appId": "app",
+    "withBackend": true
+  }
+}

package/templates/notepad/README.md

@@ -1,61 +1,55 @@
-# __PLUGIN_NAME__（Notepad 示例模板）
-
-这是一个更接近“真实应用”的 **ChatOS UI Apps** 示例模板：Markdown 记事本（文件夹分类 + 标签检索 + 编辑/预览）。
-
-## 快速开始
-
+# __PLUGIN_NAME__（Notepad 示例模板）
+
+这是一个更接近“真实应用”的 **ChatOS UI Apps** 示例模板：Markdown 记事本（文件夹分类 + 标签检索 + 编辑/预览）。
+
+## 快速开始
+
 ```bash
 npm install
 npm run dev
 ```
 
-## 本地沙箱 AI Config（可选）
+## 目录说明
+
+- `plugin/plugin.json`：插件清单（应用列表、入口、后端、AI 贡献）
+- `plugin/apps/__APP_ID__/`：前端 module（浏览器环境，导出 `mount({ container, host, slots })`）
+- `plugin/apps/__APP_ID__/compact.mjs`：compact 入口（可选；用于侧边抽屉/分栏场景）
+- `plugin/backend/`：插件后端（Node/Electron main，导出 `createUiAppsBackend(ctx)`）
+- `plugin/shared/`：共享存储实现（后端持久化所需）
+- `docs/`：协议文档快照（随工程分发）
 
-- 右上角 `AI Config` 可配置 `API Key / Base URL / Model ID`，用于测试真实模型调用（以及 MCP 调用）。
-- 沙箱默认把 `_meta.workdir` 设为 `dataDir`；如需模拟其它工作目录，可在 `AI Config` 里设置 `Workdir` 覆盖（支持 `$dataDir/$pluginDir/$projectRoot`）。
+## 主题与样式（重要）
+
+- 宿主通过 `document.documentElement.dataset.theme` 下发 `light` / `dark`，用 `host.theme.get()` / `host.theme.onChange()` 读取与监听。
+- 推荐使用 CSS Tokens（`--ds-*`）做主题适配，避免硬编码颜色。
+- 本地沙箱右上角提供 Theme 切换（light/dark/system）用于测试样式响应。
+- 本地沙箱 Inspect 面板可查看 `host.context` 与 `--ds-*` tokens。
+
+## 开发清单（建议）
 
-## 目录说明
-
-- `plugin/plugin.json`：插件清单（应用列表、入口、后端、AI 贡献）
-- `plugin/apps/__APP_ID__/`：前端 module（浏览器环境，导出 `mount({ container, host, slots })`）
-- `plugin/apps/__APP_ID__/compact.mjs`：compact 入口（可选；用于侧边抽屉/分栏场景）
-- `plugin/backend/`：插件后端（Node/Electron main，导出 `createUiAppsBackend(ctx)`）
-- `plugin/shared/`：共享存储实现（后端持久化所需）
-- `docs/`：协议文档快照（随工程分发）
-
-## 主题与样式（重要）
-
-- 宿主通过 `document.documentElement.dataset.theme` 下发 `light` / `dark`，用 `host.theme.get()` / `host.theme.onChange()` 读取与监听。
-- 推荐使用 CSS Tokens（`--ds-*`）做主题适配，避免硬编码颜色。
-- 本地沙箱右上角提供 Theme 切换（light/dark/system）用于测试样式响应。
-- 本地沙箱 Inspect 面板可查看 `host.context` 与 `--ds-*` tokens。
-
-## 开发清单（建议）
-
 - `plugin/plugin.json`：`apps[i].entry.type` 必须是 `module`，且 `path` 在插件目录内。
 - `plugin/plugin.json`：可选 `apps[i].entry.compact.path`，用于 compact UI。
-- 安全：插件目录内尽量避免 symlink（`npm run validate` 会提示），以免路径边界与打包行为不一致。
-- `mount()`：返回卸载函数并清理事件/订阅；滚动放在应用内部，固定内容用 `slots.header`。
+- `mount()`：返回卸载函数并清理事件/订阅；滚动放在应用内部，固定内容用 `slots.header`。
 - 主题：用 `host.theme.*` 与 `--ds-*` tokens；避免硬编码颜色。
 - 宿主能力：先判断 `host.bridge.enabled`，非宿主环境要可降级运行。
 - Node 能力：前端不直接用 Node API，需要时走 `host.backend.invoke()`。
 - 打包：依赖需 bundle 成单文件；ChatOS 导入会排除 `node_modules`，MCP server 不能直接 import 第三方依赖。
 - 提交前：`npm run validate`，必要时再 `pack/install`。
-
-## 协议文档
-
-`docs/` 目录包含当前版本的协议快照（建议团队内统一对齐），并包含主题样式指南与排错清单。
-
-## 后端 API（示例）
-
-前端通过 `host.backend.invoke(method, params)` 调用后端方法，本模板提供 `notes.*` 一组方法用于管理笔记：
-
-- `notes.listFolders / notes.createFolder / notes.renameFolder / notes.deleteFolder`
-- `notes.listNotes / notes.createNote / notes.getNote / notes.updateNote / notes.deleteNote`
-- `notes.listTags / notes.searchNotes`
-
-## MCP（可选）
-
+
+## 协议文档
+
+`docs/` 目录包含当前版本的协议快照（建议团队内统一对齐），并包含主题样式指南与排错清单。
+
+## 后端 API（示例）
+
+前端通过 `host.backend.invoke(method, params)` 调用后端方法，本模板提供 `notes.*` 一组方法用于管理笔记：
+
+- `notes.listFolders / notes.createFolder / notes.renameFolder / notes.deleteFolder`
+- `notes.listNotes / notes.createNote / notes.getNote / notes.updateNote / notes.deleteNote`
+- `notes.listTags / notes.searchNotes`
+
+## MCP（可选）
+
 模板内包含 `plugin/apps/__APP_ID__/mcp-server.mjs` 与 `mcp-prompt.*.md`，但默认 **未在** `plugin/plugin.json` 启用 `ai.mcp`（避免打包时遗漏依赖导致运行失败）。
 
 ⚠️ ChatOS 导入插件时会排除 `node_modules/`。因此 MCP server 只要用了第三方依赖（如 `@modelcontextprotocol/sdk`、`zod`），就必须先 bundle 成单文件，或把依赖源码放进插件目录。

package/templates/notepad/chatos.config.json

@@ -1,4 +1,4 @@
-{
-  "pluginDir": "plugin",
-  "appId": "__APP_ID__"
-}
+{
+  "pluginDir": "plugin",
+  "appId": "__APP_ID__"
+}