@leeoohoo/ui-apps-devkit 0.1.1 → 0.1.3

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.
Files changed (62) hide show
  1. package/README.md +84 -76
  2. package/bin/chatos-uiapp.js +3 -4
  3. package/package.json +28 -25
  4. package/src/cli.js +53 -53
  5. package/src/commands/dev.js +14 -14
  6. package/src/commands/init.js +143 -142
  7. package/src/commands/install.js +56 -55
  8. package/src/commands/pack.js +72 -72
  9. package/src/commands/validate.js +113 -113
  10. package/src/lib/args.js +49 -49
  11. package/src/lib/config.js +29 -29
  12. package/src/lib/fs.js +78 -78
  13. package/src/lib/path-boundary.js +16 -16
  14. package/src/lib/plugin.js +45 -45
  15. package/src/lib/state-constants.js +2 -0
  16. package/src/lib/template.js +172 -172
  17. package/src/sandbox/server.js +2302 -1200
  18. package/templates/basic/README.md +80 -77
  19. package/templates/basic/chatos.config.json +5 -5
  20. package/templates/basic/docs/CHATOS_UI_APPS_AI_CONTRIBUTIONS.md +178 -178
  21. package/templates/basic/docs/CHATOS_UI_APPS_BACKEND_PROTOCOL.md +75 -74
  22. package/templates/basic/docs/CHATOS_UI_APPS_HOST_API.md +136 -136
  23. package/templates/basic/docs/CHATOS_UI_APPS_OVERVIEW.md +115 -113
  24. package/templates/basic/docs/CHATOS_UI_APPS_PLUGIN_MANIFEST.md +225 -224
  25. package/templates/basic/docs/CHATOS_UI_APPS_STYLE_GUIDE.md +95 -95
  26. package/templates/basic/docs/CHATOS_UI_APPS_TROUBLESHOOTING.md +45 -45
  27. package/templates/basic/docs/CHATOS_UI_PROMPTS_PROTOCOL.md +392 -392
  28. package/templates/basic/plugin/apps/app/compact.mjs +41 -41
  29. package/templates/basic/plugin/apps/app/index.mjs +287 -287
  30. package/templates/basic/plugin/apps/app/mcp-prompt.en.md +7 -7
  31. package/templates/basic/plugin/apps/app/mcp-prompt.zh.md +7 -7
  32. package/templates/basic/plugin/apps/app/mcp-server.mjs +15 -15
  33. package/templates/basic/plugin/backend/index.mjs +37 -37
  34. package/templates/basic/template.json +7 -7
  35. package/templates/notepad/README.md +61 -58
  36. package/templates/notepad/chatos.config.json +4 -4
  37. package/templates/notepad/docs/CHATOS_UI_APPS_AI_CONTRIBUTIONS.md +178 -178
  38. package/templates/notepad/docs/CHATOS_UI_APPS_BACKEND_PROTOCOL.md +75 -74
  39. package/templates/notepad/docs/CHATOS_UI_APPS_HOST_API.md +136 -136
  40. package/templates/notepad/docs/CHATOS_UI_APPS_OVERVIEW.md +115 -113
  41. package/templates/notepad/docs/CHATOS_UI_APPS_PLUGIN_MANIFEST.md +225 -224
  42. package/templates/notepad/docs/CHATOS_UI_APPS_STYLE_GUIDE.md +95 -95
  43. package/templates/notepad/docs/CHATOS_UI_APPS_TROUBLESHOOTING.md +45 -45
  44. package/templates/notepad/docs/CHATOS_UI_PROMPTS_PROTOCOL.md +392 -392
  45. package/templates/notepad/plugin/apps/app/api.mjs +30 -30
  46. package/templates/notepad/plugin/apps/app/compact.mjs +41 -41
  47. package/templates/notepad/plugin/apps/app/dom.mjs +14 -14
  48. package/templates/notepad/plugin/apps/app/ds-tree.mjs +35 -35
  49. package/templates/notepad/plugin/apps/app/index.mjs +1056 -1056
  50. package/templates/notepad/plugin/apps/app/layers.mjs +338 -338
  51. package/templates/notepad/plugin/apps/app/markdown.mjs +120 -120
  52. package/templates/notepad/plugin/apps/app/mcp-prompt.en.md +22 -22
  53. package/templates/notepad/plugin/apps/app/mcp-prompt.zh.md +22 -22
  54. package/templates/notepad/plugin/apps/app/mcp-server.mjs +207 -200
  55. package/templates/notepad/plugin/apps/app/styles.mjs +355 -355
  56. package/templates/notepad/plugin/apps/app/tags.mjs +21 -21
  57. package/templates/notepad/plugin/apps/app/ui.mjs +280 -280
  58. package/templates/notepad/plugin/backend/index.mjs +99 -99
  59. package/templates/notepad/plugin/plugin.json +23 -23
  60. package/templates/notepad/plugin/shared/notepad-paths.mjs +80 -62
  61. package/templates/notepad/plugin/shared/notepad-store.mjs +765 -765
  62. package/templates/notepad/template.json +8 -8
package/templates/notepad/docs/CHATOS_UI_APPS_TROUBLESHOOTING.md CHANGED
@@ -1,45 +1,45 @@
1
- # ChatOS UI Apps: Troubleshooting
2
-
3
- 本文件汇总常见问题与排查思路, 以宿主实现为准.
4
-
5
- ## 1. host 不可用或 bridge disabled
6
-
7
- - 现象: `host` 为空, 或 `host.bridge.enabled === false`.
8
- - 原因: 未在 ChatOS 宿主环境运行, 或 preload bridge 未加载.
9
- - 处理: 在沙箱中调试, 生产环境用 `host.bridge.enabled` 做降级判断.
10
-
11
- ## 2. module entry 报错或 mount 缺失
12
-
13
- - 现象: sandbox 报 "module entry must export mount()".
14
- - 原因: 入口没有导出 `mount`, 或 `plugin.json` 的 `apps[i].entry.path` 指向错误.
15
- - 处理: 确认 `apps[i].entry.type === "module"` 且路径在插件目录内.
16
-
17
- ## 3. backend.invoke 失败
18
-
19
- - 现象: `host.backend.invoke()` 抛错或返回失败.
20
- - 原因: `plugin/backend/index.mjs` 缺失或未导出 `createUiAppsBackend(ctx)`.
21
- - 处理: 补齐后端入口, 在沙箱里重新加载, 并检查路径边界.
22
-
23
- ## 4. 主题不更新
24
-
25
- - 现象: 切换主题后样式不变.
26
- - 原因: 未监听 `host.theme.onChange`, 或样式硬编码颜色.
27
- - 处理: 使用 `host.theme.*` 监听, 样式用 `--ds-*` tokens.
28
-
29
- ## 5. 资源加载 404
30
-
31
- - 现象: 图片/资源在沙箱中 404.
32
- - 原因: 路径不在插件目录内, 或未通过相对路径引用.
33
- - 处理: 用 `new URL('./asset.png', import.meta.url)` 或打包生成产物.
34
-
35
- ## 6. UI Prompts 不显示
36
-
37
- - 现象: `host.uiPrompts.request()` 后无面板.
38
- - 原因: 未调用 `host.uiPrompts.open()`, 或 `prompt.kind` 填写错误.
39
- - 处理: 先调用 `open()` 打开面板, 并按协议填写 `prompt`.
40
-
41
- ## 7. MCP 不生效
42
-
43
- - 现象: MCP tools / prompts 未出现.
44
- - 原因: 未在 `plugin.json` 启用 `ai.mcp` 或未 bundle 依赖.
45
- - 处理: bundle 成单文件, 并检查 `ai.mcp.entry` / `ai.mcpPrompt` 配置.
1
+ # ChatOS UI Apps: Troubleshooting
2
+
3
+ 本文件汇总常见问题与排查思路, 以宿主实现为准.
4
+
5
+ ## 1. host 不可用或 bridge disabled
6
+
7
+ - 现象: `host` 为空, 或 `host.bridge.enabled === false`.
8
+ - 原因: 未在 ChatOS 宿主环境运行, 或 preload bridge 未加载.
9
+ - 处理: 在沙箱中调试, 生产环境用 `host.bridge.enabled` 做降级判断.
10
+
11
+ ## 2. module entry 报错或 mount 缺失
12
+
13
+ - 现象: sandbox 报 "module entry must export mount()".
14
+ - 原因: 入口没有导出 `mount`, 或 `plugin.json` 的 `apps[i].entry.path` 指向错误.
15
+ - 处理: 确认 `apps[i].entry.type === "module"` 且路径在插件目录内.
16
+
17
+ ## 3. backend.invoke 失败
18
+
19
+ - 现象: `host.backend.invoke()` 抛错或返回失败.
20
+ - 原因: `plugin/backend/index.mjs` 缺失或未导出 `createUiAppsBackend(ctx)`.
21
+ - 处理: 补齐后端入口, 在沙箱里重新加载, 并检查路径边界.
22
+
23
+ ## 4. 主题不更新
24
+
25
+ - 现象: 切换主题后样式不变.
26
+ - 原因: 未监听 `host.theme.onChange`, 或样式硬编码颜色.
27
+ - 处理: 使用 `host.theme.*` 监听, 样式用 `--ds-*` tokens.
28
+
29
+ ## 5. 资源加载 404
30
+
31
+ - 现象: 图片/资源在沙箱中 404.
32
+ - 原因: 路径不在插件目录内, 或未通过相对路径引用.
33
+ - 处理: 用 `new URL('./asset.png', import.meta.url)` 或打包生成产物.
34
+
35
+ ## 6. UI Prompts 不显示
36
+
37
+ - 现象: `host.uiPrompts.request()` 后无面板.
38
+ - 原因: 未调用 `host.uiPrompts.open()`, 或 `prompt.kind` 填写错误.
39
+ - 处理: 先调用 `open()` 打开面板, 并按协议填写 `prompt`.
40
+
41
+ ## 7. MCP 不生效
42
+
43
+ - 现象: MCP tools / prompts 未出现.
44
+ - 原因: 未在 `plugin.json` 启用 `ai.mcp`, 或 MCP 依赖未 bundle（ChatOS 导入会剔除 `node_modules`）.
45
+ - 处理: 将 MCP server bundle 成单文件（或 vendor 依赖）, 并检查 `ai.mcp.entry` / `ai.mcpPrompt` 配置.