@shiqianjiang/ceru-plugin-cli 0.3.15 → 3.0.0

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 (302) hide show
  1. package/README.md +26 -7
  2. package/assets/compatibility.json +18 -0
  3. package/dist/compatibility.d.ts +24 -0
  4. package/dist/compatibility.js +119 -0
  5. package/dist/component.d.ts +6 -0
  6. package/dist/component.js +60 -0
  7. package/dist/dev-music.d.ts +19 -0
  8. package/dist/dev-music.js +81 -0
  9. package/dist/dev-plugin-services.d.ts +10 -0
  10. package/dist/dev-plugin-services.js +67 -0
  11. package/dist/dev.d.ts +1 -9
  12. package/dist/dev.js +53 -713
  13. package/dist/frameworks.d.ts +5 -2
  14. package/dist/frameworks.js +43 -6
  15. package/dist/index.d.ts +1 -1
  16. package/dist/index.js +54 -23
  17. package/dist/init.js +3 -3
  18. package/dist/migrate.d.ts +3 -0
  19. package/dist/migrate.js +109 -0
  20. package/dist/project.d.ts +5 -2
  21. package/dist/project.js +131 -43
  22. package/dist/test-hooks.d.ts +1 -0
  23. package/dist/test-hooks.js +209 -0
  24. package/dist/test-services.d.ts +4 -0
  25. package/dist/test-services.js +54 -0
  26. package/dist/watch-vue-types.d.ts +17 -0
  27. package/dist/watch-vue-types.js +145 -0
  28. package/package.json +10 -6
  29. package/schemas/config.schema.json +954 -452
  30. package/templates/account-qrcode/js/.vscode/extensions.json +3 -0
  31. package/templates/account-qrcode/js/.vscode/launch.json +19 -0
  32. package/templates/account-qrcode/js/.vscode/settings.json +20 -0
  33. package/templates/account-qrcode/js/.vscode/tasks.json +43 -0
  34. package/templates/account-qrcode/js/README.md +15 -0
  35. package/templates/account-qrcode/js/_gitignore +6 -0
  36. package/templates/account-qrcode/js/ceru-plugin.code-workspace +8 -0
  37. package/templates/account-qrcode/js/ceru.plugin.json +62 -0
  38. package/templates/account-qrcode/js/package.json +24 -0
  39. package/templates/account-qrcode/js/src/Login.vue +25 -0
  40. package/templates/account-qrcode/js/src/index.js +25 -0
  41. package/templates/account-qrcode/js/src/login-html.js +23 -0
  42. package/templates/account-qrcode/js/tsconfig.json +17 -0
  43. package/templates/account-qrcode/ts/.vscode/extensions.json +3 -0
  44. package/templates/account-qrcode/ts/.vscode/launch.json +19 -0
  45. package/templates/account-qrcode/ts/.vscode/settings.json +20 -0
  46. package/templates/account-qrcode/ts/.vscode/tasks.json +43 -0
  47. package/templates/account-qrcode/ts/README.md +15 -0
  48. package/templates/account-qrcode/ts/_gitignore +6 -0
  49. package/templates/account-qrcode/ts/ceru-plugin.code-workspace +8 -0
  50. package/templates/account-qrcode/ts/ceru.plugin.json +62 -0
  51. package/templates/account-qrcode/ts/package.json +24 -0
  52. package/templates/account-qrcode/ts/src/Login.vue +25 -0
  53. package/templates/account-qrcode/ts/src/index.ts +25 -0
  54. package/templates/account-qrcode/ts/src/login-html.ts +23 -0
  55. package/templates/account-qrcode/ts/tsconfig.json +17 -0
  56. package/templates/connected-library/js/.vscode/launch.json +12 -29
  57. package/templates/connected-library/js/.vscode/tasks.json +2 -3
  58. package/templates/connected-library/js/README.md +26 -12
  59. package/templates/connected-library/js/ceru.plugin.json +122 -50
  60. package/templates/connected-library/js/package.json +5 -5
  61. package/templates/connected-library/js/src/index.js +46 -5
  62. package/templates/connected-library/js/src/settings.js +28 -0
  63. package/templates/connected-library/ts/.vscode/launch.json +12 -29
  64. package/templates/connected-library/ts/.vscode/tasks.json +2 -3
  65. package/templates/connected-library/ts/README.md +26 -12
  66. package/templates/connected-library/ts/ceru.plugin.json +122 -50
  67. package/templates/connected-library/ts/package.json +5 -5
  68. package/templates/connected-library/ts/src/index.ts +46 -5
  69. package/templates/connected-library/ts/src/settings.ts +28 -0
  70. package/templates/encrypted-source/README.md +86 -0
  71. package/templates/encrypted-source/js/.prettierrc.json +5 -0
  72. package/templates/encrypted-source/js/.vscode/ceru.code-snippets +55 -0
  73. package/templates/encrypted-source/js/.vscode/extensions.json +3 -0
  74. package/templates/encrypted-source/js/.vscode/launch.json +15 -0
  75. package/templates/encrypted-source/js/.vscode/settings.json +20 -0
  76. package/templates/encrypted-source/js/.vscode/tasks.json +40 -0
  77. package/templates/encrypted-source/js/DEMO.md +77 -0
  78. package/templates/encrypted-source/js/README.md +13 -0
  79. package/templates/encrypted-source/js/_gitignore +6 -0
  80. package/templates/encrypted-source/js/ceru-plugin.code-workspace +8 -0
  81. package/templates/encrypted-source/js/ceru.plugin.json +95 -0
  82. package/templates/encrypted-source/js/package.json +26 -0
  83. package/templates/encrypted-source/js/resources/xor-byte.wasm +0 -0
  84. package/templates/encrypted-source/js/resources/xor-byte.wat +5 -0
  85. package/templates/encrypted-source/js/src/demo.js +200 -0
  86. package/templates/encrypted-source/js/src/fixtures.js +118 -0
  87. package/templates/encrypted-source/js/src/index.js +4 -0
  88. package/templates/encrypted-source/js/tests/demo.test.mjs +357 -0
  89. package/templates/encrypted-source/js/tsconfig.json +16 -0
  90. package/templates/encrypted-source/ts/.prettierrc.json +5 -0
  91. package/templates/encrypted-source/ts/.vscode/ceru.code-snippets +55 -0
  92. package/templates/encrypted-source/ts/.vscode/extensions.json +3 -0
  93. package/templates/encrypted-source/ts/.vscode/launch.json +15 -0
  94. package/templates/encrypted-source/ts/.vscode/settings.json +20 -0
  95. package/templates/encrypted-source/ts/.vscode/tasks.json +40 -0
  96. package/templates/encrypted-source/ts/DEMO.md +77 -0
  97. package/templates/encrypted-source/ts/README.md +13 -0
  98. package/templates/encrypted-source/ts/_gitignore +6 -0
  99. package/templates/encrypted-source/ts/ceru-plugin.code-workspace +8 -0
  100. package/templates/encrypted-source/ts/ceru.plugin.json +95 -0
  101. package/templates/encrypted-source/ts/package.json +26 -0
  102. package/templates/encrypted-source/ts/resources/xor-byte.wasm +0 -0
  103. package/templates/encrypted-source/ts/resources/xor-byte.wat +5 -0
  104. package/templates/encrypted-source/ts/src/demo.ts +212 -0
  105. package/templates/encrypted-source/ts/src/fixtures.ts +125 -0
  106. package/templates/encrypted-source/ts/src/index.ts +4 -0
  107. package/templates/encrypted-source/ts/tests/demo.test.mjs +357 -0
  108. package/templates/encrypted-source/ts/tsconfig.json +17 -0
  109. package/templates/guest-adapter/js/.vscode/launch.json +12 -29
  110. package/templates/guest-adapter/js/.vscode/tasks.json +2 -3
  111. package/templates/guest-adapter/js/README.md +10 -10
  112. package/templates/guest-adapter/js/ceru.plugin.json +67 -62
  113. package/templates/guest-adapter/js/package.json +5 -5
  114. package/templates/guest-adapter/js/src/index.js +1 -1
  115. package/templates/guest-adapter/js/src/settings.js +8 -0
  116. package/templates/guest-adapter/ts/.vscode/launch.json +12 -29
  117. package/templates/guest-adapter/ts/.vscode/tasks.json +2 -3
  118. package/templates/guest-adapter/ts/README.md +10 -10
  119. package/templates/guest-adapter/ts/ceru.plugin.json +67 -62
  120. package/templates/guest-adapter/ts/package.json +5 -5
  121. package/templates/guest-adapter/ts/src/index.ts +1 -1
  122. package/templates/guest-adapter/ts/src/settings.ts +8 -0
  123. package/templates/importer/js/.vscode/launch.json +12 -29
  124. package/templates/importer/js/.vscode/tasks.json +2 -3
  125. package/templates/importer/js/README.md +10 -10
  126. package/templates/importer/js/ceru.plugin.json +23 -21
  127. package/templates/importer/js/package.json +5 -5
  128. package/templates/importer/ts/.vscode/launch.json +12 -29
  129. package/templates/importer/ts/.vscode/tasks.json +2 -3
  130. package/templates/importer/ts/README.md +10 -10
  131. package/templates/importer/ts/ceru.plugin.json +23 -21
  132. package/templates/importer/ts/package.json +5 -5
  133. package/templates/page-extension/js/.vscode/extensions.json +3 -0
  134. package/templates/page-extension/js/.vscode/launch.json +19 -0
  135. package/templates/page-extension/js/.vscode/settings.json +20 -0
  136. package/templates/page-extension/js/.vscode/tasks.json +43 -0
  137. package/templates/page-extension/js/README.md +9 -0
  138. package/templates/page-extension/js/_gitignore +6 -0
  139. package/templates/page-extension/js/ceru-plugin.code-workspace +8 -0
  140. package/templates/page-extension/js/ceru.plugin.json +94 -0
  141. package/templates/page-extension/js/package.json +24 -0
  142. package/templates/page-extension/js/src/Open.vue +6 -0
  143. package/templates/page-extension/js/src/Search.vue +62 -0
  144. package/templates/page-extension/js/src/index.js +54 -0
  145. package/templates/page-extension/js/tsconfig.json +17 -0
  146. package/templates/page-extension/ts/.vscode/extensions.json +3 -0
  147. package/templates/page-extension/ts/.vscode/launch.json +19 -0
  148. package/templates/page-extension/ts/.vscode/settings.json +20 -0
  149. package/templates/page-extension/ts/.vscode/tasks.json +43 -0
  150. package/templates/page-extension/ts/README.md +9 -0
  151. package/templates/page-extension/ts/_gitignore +6 -0
  152. package/templates/page-extension/ts/ceru-plugin.code-workspace +8 -0
  153. package/templates/page-extension/ts/ceru.plugin.json +94 -0
  154. package/templates/page-extension/ts/package.json +24 -0
  155. package/templates/page-extension/ts/src/Open.vue +6 -0
  156. package/templates/page-extension/ts/src/Search.vue +62 -0
  157. package/templates/page-extension/ts/src/index.ts +54 -0
  158. package/templates/page-extension/ts/tsconfig.json +17 -0
  159. package/templates/playback-hook/js/.prettierrc.json +5 -0
  160. package/templates/playback-hook/js/.vscode/extensions.json +3 -0
  161. package/templates/playback-hook/js/.vscode/launch.json +19 -0
  162. package/templates/playback-hook/js/.vscode/settings.json +20 -0
  163. package/templates/playback-hook/js/.vscode/tasks.json +50 -0
  164. package/templates/playback-hook/js/README.md +24 -0
  165. package/templates/playback-hook/js/_gitignore +6 -0
  166. package/templates/playback-hook/js/ceru-plugin.code-workspace +8 -0
  167. package/templates/playback-hook/js/ceru.plugin.json +36 -0
  168. package/templates/playback-hook/js/package.json +23 -0
  169. package/templates/playback-hook/js/src/index.js +25 -0
  170. package/templates/playback-hook/js/tests/hooks.json +316 -0
  171. package/templates/playback-hook/js/tsconfig.json +16 -0
  172. package/templates/playback-hook/ts/.prettierrc.json +5 -0
  173. package/templates/playback-hook/ts/.vscode/extensions.json +3 -0
  174. package/templates/playback-hook/ts/.vscode/launch.json +19 -0
  175. package/templates/playback-hook/ts/.vscode/settings.json +20 -0
  176. package/templates/playback-hook/ts/.vscode/tasks.json +50 -0
  177. package/templates/playback-hook/ts/README.md +24 -0
  178. package/templates/playback-hook/ts/_gitignore +6 -0
  179. package/templates/playback-hook/ts/ceru-plugin.code-workspace +8 -0
  180. package/templates/playback-hook/ts/ceru.plugin.json +36 -0
  181. package/templates/playback-hook/ts/package.json +23 -0
  182. package/templates/playback-hook/ts/src/index.ts +25 -0
  183. package/templates/playback-hook/ts/tests/hooks.json +316 -0
  184. package/templates/playback-hook/ts/tsconfig.json +16 -0
  185. package/templates/player-skin/js/.vscode/extensions.json +3 -0
  186. package/templates/player-skin/js/.vscode/launch.json +19 -0
  187. package/templates/player-skin/js/.vscode/settings.json +20 -0
  188. package/templates/player-skin/js/.vscode/tasks.json +43 -0
  189. package/templates/player-skin/js/README.md +11 -0
  190. package/templates/player-skin/js/_gitignore +6 -0
  191. package/templates/player-skin/js/assets/studio-preview.svg +15 -0
  192. package/templates/player-skin/js/ceru-plugin.code-workspace +8 -0
  193. package/templates/player-skin/js/ceru.plugin.json +77 -0
  194. package/templates/player-skin/js/package.json +24 -0
  195. package/templates/player-skin/js/src/Artwork.vue +9 -0
  196. package/templates/player-skin/js/src/Background.vue +15 -0
  197. package/templates/player-skin/js/src/BuiltinLyrics.vue +15 -0
  198. package/templates/player-skin/js/src/Lyrics.vue +28 -0
  199. package/templates/player-skin/js/tsconfig.json +17 -0
  200. package/templates/player-skin/ts/.vscode/extensions.json +3 -0
  201. package/templates/player-skin/ts/.vscode/launch.json +19 -0
  202. package/templates/player-skin/ts/.vscode/settings.json +20 -0
  203. package/templates/player-skin/ts/.vscode/tasks.json +43 -0
  204. package/templates/player-skin/ts/README.md +11 -0
  205. package/templates/player-skin/ts/_gitignore +6 -0
  206. package/templates/player-skin/ts/assets/studio-preview.svg +15 -0
  207. package/templates/player-skin/ts/ceru-plugin.code-workspace +8 -0
  208. package/templates/player-skin/ts/ceru.plugin.json +77 -0
  209. package/templates/player-skin/ts/package.json +24 -0
  210. package/templates/player-skin/ts/src/Artwork.vue +9 -0
  211. package/templates/player-skin/ts/src/Background.vue +15 -0
  212. package/templates/player-skin/ts/src/BuiltinLyrics.vue +15 -0
  213. package/templates/player-skin/ts/src/Lyrics.vue +28 -0
  214. package/templates/player-skin/ts/tsconfig.json +17 -0
  215. package/templates/react/js/.vscode/launch.json +12 -29
  216. package/templates/react/js/.vscode/tasks.json +2 -3
  217. package/templates/react/js/README.md +10 -10
  218. package/templates/react/js/ceru.plugin.json +27 -22
  219. package/templates/react/js/package.json +5 -5
  220. package/templates/react/js/src/index.js +1 -1
  221. package/templates/react/ts/.vscode/launch.json +12 -29
  222. package/templates/react/ts/.vscode/tasks.json +2 -3
  223. package/templates/react/ts/README.md +10 -10
  224. package/templates/react/ts/ceru.plugin.json +27 -22
  225. package/templates/react/ts/package.json +5 -5
  226. package/templates/react/ts/src/index.ts +1 -1
  227. package/templates/snapshot.json +152 -6
  228. package/templates/source/js/.vscode/launch.json +12 -29
  229. package/templates/source/js/.vscode/tasks.json +2 -3
  230. package/templates/source/js/README.md +12 -10
  231. package/templates/source/js/ceru.plugin.json +44 -26
  232. package/templates/source/js/package.json +5 -5
  233. package/templates/source/js/src/index.js +10 -8
  234. package/templates/source/ts/.vscode/launch.json +12 -29
  235. package/templates/source/ts/.vscode/tasks.json +2 -3
  236. package/templates/source/ts/README.md +12 -10
  237. package/templates/source/ts/ceru.plugin.json +44 -26
  238. package/templates/source/ts/package.json +5 -5
  239. package/templates/source/ts/src/index.ts +10 -8
  240. package/templates/vue/js/.vscode/launch.json +12 -29
  241. package/templates/vue/js/.vscode/tasks.json +2 -3
  242. package/templates/vue/js/README.md +10 -10
  243. package/templates/vue/js/ceru.plugin.json +27 -22
  244. package/templates/vue/js/package.json +5 -5
  245. package/templates/vue/js/src/index.js +1 -1
  246. package/templates/vue/ts/.vscode/launch.json +12 -29
  247. package/templates/vue/ts/.vscode/tasks.json +2 -3
  248. package/templates/vue/ts/README.md +10 -10
  249. package/templates/vue/ts/ceru.plugin.json +27 -22
  250. package/templates/vue/ts/package.json +5 -5
  251. package/templates/vue/ts/src/index.ts +1 -1
  252. package/templates/vue-tsx/js/.vscode/launch.json +12 -29
  253. package/templates/vue-tsx/js/.vscode/tasks.json +2 -3
  254. package/templates/vue-tsx/js/README.md +10 -10
  255. package/templates/vue-tsx/js/ceru.plugin.json +27 -22
  256. package/templates/vue-tsx/js/package.json +5 -5
  257. package/templates/vue-tsx/js/src/index.js +1 -1
  258. package/templates/vue-tsx/ts/.vscode/launch.json +12 -29
  259. package/templates/vue-tsx/ts/.vscode/tasks.json +2 -3
  260. package/templates/vue-tsx/ts/README.md +10 -10
  261. package/templates/vue-tsx/ts/ceru.plugin.json +27 -22
  262. package/templates/vue-tsx/ts/package.json +5 -5
  263. package/templates/vue-tsx/ts/src/index.ts +1 -1
  264. package/templates/web-dist/js/.vscode/launch.json +12 -29
  265. package/templates/web-dist/js/.vscode/tasks.json +2 -3
  266. package/templates/web-dist/js/README.md +10 -10
  267. package/templates/web-dist/js/ceru.plugin.json +27 -22
  268. package/templates/web-dist/js/package.json +5 -5
  269. package/templates/web-dist/js/src/index.js +1 -1
  270. package/templates/web-dist/ts/.vscode/launch.json +12 -29
  271. package/templates/web-dist/ts/.vscode/tasks.json +2 -3
  272. package/templates/web-dist/ts/README.md +10 -10
  273. package/templates/web-dist/ts/ceru.plugin.json +27 -22
  274. package/templates/web-dist/ts/package.json +5 -5
  275. package/templates/web-dist/ts/src/index.ts +1 -1
  276. package/templates/web-surface/js/.vscode/launch.json +12 -29
  277. package/templates/web-surface/js/.vscode/tasks.json +2 -3
  278. package/templates/web-surface/js/README.md +10 -10
  279. package/templates/web-surface/js/ceru.plugin.json +35 -35
  280. package/templates/web-surface/js/package.json +5 -5
  281. package/templates/web-surface/js/src/index.js +1 -1
  282. package/templates/web-surface/ts/.vscode/launch.json +12 -29
  283. package/templates/web-surface/ts/.vscode/tasks.json +2 -3
  284. package/templates/web-surface/ts/README.md +10 -10
  285. package/templates/web-surface/ts/ceru.plugin.json +35 -35
  286. package/templates/web-surface/ts/package.json +5 -5
  287. package/templates/web-surface/ts/src/index.ts +1 -1
  288. package/assets/core-contracts.js +0 -1
  289. package/assets/electron-app/main.cjs +0 -1
  290. package/assets/electron-app/package.json +0 -8
  291. package/assets/electron.cjs +0 -42
  292. package/assets/index.html +0 -94
  293. package/assets/native-view.js +0 -197
  294. package/assets/playground.js +0 -883
  295. package/assets/sandbox.js +0 -67
  296. package/assets/style.css +0 -337
  297. package/dist/socket-broker.d.ts +0 -23
  298. package/dist/socket-broker.js +0 -229
  299. package/templates/connected-library/js/ui/settings.json +0 -24
  300. package/templates/connected-library/ts/ui/settings.json +0 -24
  301. package/templates/guest-adapter/js/ui/settings.json +0 -14
  302. package/templates/guest-adapter/ts/ui/settings.json +0 -14
@@ -1,22 +1,22 @@
1
1
  # importer / ts
2
2
 
3
- Ceru Music v2 插件开发模板。此目录是源码,不是安装包。
3
+ Ceru Music v3 插件开发模板。此目录是源码,不是安装包。
4
4
 
5
5
  ## 运行 demo
6
6
 
7
- 1. 使用脚手架创建工程:
7
+ 1. 使用匹配的 v3 脚手架创建工程(本地开发套件可使用其 `npm run create` 命令):
8
8
 
9
- npm create ceru-plugin@latest my-plugin -- --template importer --lang ts
9
+ ceru-plugin init my-plugin --template importer --lang ts
10
10
 
11
11
  2. 进入目录,运行 npm install。
12
- 3. 运行 npm run dev,打开独立 Electron 调试工作台。
12
+ 3. 运行 npm run dev,在澜音「设置 → 插件管理 → 管理设置 → 插件开发者模式」添加终端打印的 JS 文件。
13
13
  4. 修改 src 中的代码;保存后自动类型检查并重载。
14
14
  5. 运行 npm run build,只分发 dist/plugin.js。
15
15
 
16
16
  ## 编辑器
17
17
 
18
- VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to Ceru plugin。
19
- 激活代码已经执行时,可点击“重新运行”再次命中断点。
18
+ VS Code 按 F5 选择 Watch Ceru plugin,会启动本地构建监听,不会另开 Electron。
19
+ 已在终端运行 npm run dev 时不必再按 F5。
20
20
  配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
21
21
 
22
22
  ## 宿主资源
@@ -26,17 +26,17 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
26
26
  - 默认封面:await ctx.assets.url('placeholder.cover')。
27
27
  - 共享工具:ctx.utils.lodash。
28
28
 
29
- Vue/React 的生产运行代码、页面和样式直接编入发行 JS,宿主不提供框架。
29
+ 视图是否自带框架由清单的 `entry.views[].kind` 决定:`web` 页面打包自己用到的框架;`native` 由宿主绘制;`component` 复用宿主提供的 Vue、TDesign 和音乐组件。开发宿主风格的页面可选 `page-extension` 模板,播放器区域可选 `player-skin`,不需要复制桌面组件源码。
30
30
  TypeScript、Vue 编译器、构建工具与开发服务器不会进入产物。
31
- 运行 npm run preview 可只加载 dist/plugin.js 检查发布后的行为。
31
+ 运行 `npm run typecheck` 只检查工程,不生成发行文件。可选 `npm run preview` 验证构建产物并打印路径;将该文件加入桌面的插件开发者模式即可预览,不会启动服务器。
32
32
 
33
33
  若 VS Code 打开的是父目录,请打开本工程的 ceru-plugin.code-workspace,
34
- 再在“运行和调试”中选择 Launch Ceru plugin;已经运行 npm/pnpm dev 时选择 Attach to Ceru plugin。
34
+ 再在“运行和调试”中选择 Watch Ceru plugin。
35
35
  F5 执行当前下拉框中的配置,不会自动选择终端所在的子工程。
36
36
 
37
37
  ## 边界
38
38
 
39
- 本模板面向 v2 协议。开发工作台不是当前 v1 桌面 Host 的兼容层。
39
+ 本模板面向 v3 协议。需要支持 v3 的宿主。
40
40
  凭据保险箱、完整音乐业务和 Guest 安装需要正式 Host;不支持的调试调用会明确报错。
41
41
  不要把私人 API Key、卡密或发行私钥提交到仓库。
42
42
 
@@ -1,42 +1,44 @@
1
1
  {
2
2
  "manifest": {
3
- "manifestVersion": 2,
3
+ "manifestVersion": 3,
4
4
  "id": "local.ts",
5
5
  "name": "ts",
6
6
  "version": "0.1.0",
7
- "description": "A Ceru Music v2 importer plugin",
7
+ "description": "A Ceru Music v3 importer plugin",
8
+ "dataSchemas": {
9
+ "config": 1,
10
+ "state": 1
11
+ },
8
12
  "engines": {
9
- "hostApi": "^2.0.0",
10
- "logicRuntime": "ceru-js@1",
11
- "uiSchema": "^1.0.0"
13
+ "hostApi": "^3.0.0",
14
+ "logicRuntime": "ceru-js@1"
12
15
  },
13
- "modules": {
16
+ "entry": {
14
17
  "logic": {
15
- "entry": "logic.main",
16
- "activation": ["onCommand:hello"]
18
+ "activation": [
19
+ "onCommand:hello"
20
+ ],
21
+ "module": "logic.main"
17
22
  }
18
23
  },
19
- "contributes": {
20
- "commands": [
21
- {
22
- "id": "hello",
23
- "title": "打开歌单导入",
24
- "action": "hello"
25
- }
26
- ],
27
- "playlistImporters": [
24
+ "provides": {
25
+ "importers": [
28
26
  {
29
27
  "id": "text-list",
30
28
  "title": "从文本清单导入(演示)",
31
29
  "description": "复用宿主歌单导入窗口;每行一个标题",
32
30
  "placeholder": "输入标题,以逗号分隔"
33
31
  }
32
+ ],
33
+ "actions": [
34
+ {
35
+ "id": "hello",
36
+ "title": "打开歌单导入"
37
+ }
34
38
  ]
35
39
  },
36
- "permissions": [],
37
- "dataSchemas": {
38
- "config": 1,
39
- "state": 1
40
+ "uses": {
41
+ "permissions": []
40
42
  }
41
43
  },
42
44
  "entries": {
@@ -6,17 +6,17 @@
6
6
  "scripts": {
7
7
  "dev": "ceru-plugin dev",
8
8
  "build": "ceru-plugin build",
9
- "typecheck": "tsc --noEmit",
9
+ "typecheck": "ceru-plugin typecheck",
10
10
  "validate": "ceru-plugin validate dist/plugin.js",
11
- "preview": "ceru-plugin preview dist/plugin.js"
11
+ "preview": "ceru-plugin preview dist/plugin.js",
12
+ "check:compat": "ceru-plugin check-compat"
12
13
  },
13
14
  "dependencies": {
14
- "@shiqianjiang/ceru-plugin-sdk": "^0.3.15"
15
+ "@shiqianjiang/ceru-plugin-sdk": "^3.0.0"
15
16
  },
16
17
  "devDependencies": {
17
- "@shiqianjiang/ceru-plugin-cli": "^0.3.15",
18
+ "@shiqianjiang/ceru-plugin-cli": "^3.0.0",
18
19
  "typescript": "~5.9.3",
19
- "electron": "^44.4.2",
20
20
  "prettier": "^3.6.2"
21
21
  }
22
22
  }
@@ -0,0 +1,3 @@
1
+ {
2
+ "recommendations": ["esbenp.prettier-vscode", "Vue.volar"]
3
+ }
@@ -0,0 +1,19 @@
1
+ {
2
+ "version": "0.2.0",
3
+ "configurations": [
4
+ {
5
+ "name": "Watch Ceru plugin",
6
+ "type": "node",
7
+ "request": "launch",
8
+ "program": "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
9
+ "args": [
10
+ "dev"
11
+ ],
12
+ "cwd": "${workspaceFolder}",
13
+ "console": "integratedTerminal",
14
+ "skipFiles": [
15
+ "<node_internals>/**"
16
+ ]
17
+ }
18
+ ]
19
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "typescript.tsdk": "node_modules/typescript/lib",
3
+ "typescript.enablePromptUseWorkspaceTsdk": true,
4
+ "editor.formatOnSave": true,
5
+ "[typescript]": {
6
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
7
+ },
8
+ "[javascript]": {
9
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
10
+ },
11
+ "json.schemas": [
12
+ {
13
+ "fileMatch": ["/ceru.plugin.json"],
14
+ "url": "./node_modules/@shiqianjiang/ceru-plugin-cli/schemas/config.schema.json"
15
+ }
16
+ ],
17
+ "files.exclude": {
18
+ "**/*.tsbuildinfo": true
19
+ }
20
+ }
@@ -0,0 +1,43 @@
1
+ {
2
+ "version": "2.0.0",
3
+ "tasks": [
4
+ {
5
+ "label": "Ceru: dev",
6
+ "type": "process",
7
+ "isBackground": true,
8
+ "problemMatcher": {
9
+ "owner": "ceru",
10
+ "pattern": {
11
+ "regexp": "^CERU_ERROR (.*)$",
12
+ "message": 1
13
+ },
14
+ "background": {
15
+ "activeOnStart": true,
16
+ "beginsPattern": "^.*$",
17
+ "endsPattern": "^CERU_BUILD_READY "
18
+ }
19
+ },
20
+ "command": "node",
21
+ "args": [
22
+ "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
+ "dev"
24
+ ],
25
+ "options": {
26
+ "cwd": "${workspaceFolder}"
27
+ }
28
+ },
29
+ {
30
+ "label": "Ceru: typecheck",
31
+ "type": "npm",
32
+ "script": "typecheck",
33
+ "problemMatcher": "$tsc",
34
+ "group": "build"
35
+ },
36
+ {
37
+ "label": "Ceru: build",
38
+ "type": "npm",
39
+ "script": "build",
40
+ "problemMatcher": []
41
+ }
42
+ ]
43
+ }
@@ -0,0 +1,9 @@
1
+ # 页面扩展
2
+
3
+ 侧边栏和设置页复用 Vue 搜索视图,歌单页动作槽提供入口。搜索首个可用音源(支持本地曲库),点击歌名播放,在“更多”中加入队列。
4
+
5
+ `SongList` 的 `actions` 指向清单声明的 logic 动作;`music.read` 与 `music.control` 分别授权搜索、播放及入队。视图只收到显示字段和本轮结果的临时 key,完整资源引用保留在 logic 中。未声明的收藏和下载不显示。
6
+
7
+ 运行 `npm install`、`npm run typecheck`、`npm run dev`,将打印的 `dist/plugin.js` 添加到「设置 → 插件管理 → 管理设置 → 插件开发者模式」。保存源码自动重载;分发前运行 `npm run build` 和 `npm run validate`。
8
+
9
+ 侧栏读取 `ui.pages[].icon`:示例使用 `{"kind":"host","name":"search"}`。也可以在工程的 `resources` 中声明图片,再引用 `{"kind":"asset","resource":"nav.logo"}`。没有图标或图片无法显示时回退为默认插件图标。
@@ -0,0 +1,6 @@
1
+ node_modules/
2
+ dist/
3
+ .keys/
4
+ .ceru-dev/
5
+ *.private.pem
6
+ *.tsbuildinfo
@@ -0,0 +1,8 @@
1
+ {
2
+ "folders": [
3
+ {
4
+ "path": ".",
5
+ },
6
+ ],
7
+ "settings": {},
8
+ }
@@ -0,0 +1,94 @@
1
+ {
2
+ "manifest": {
3
+ "manifestVersion": 3,
4
+ "id": "local.page-extension",
5
+ "name": "页面扩展",
6
+ "version": "0.1.0",
7
+ "engines": {
8
+ "hostApi": "^3.0.0",
9
+ "logicRuntime": "ceru-js@1"
10
+ },
11
+ "entry": {
12
+ "logic": {
13
+ "module": "logic.main"
14
+ },
15
+ "views": [
16
+ {
17
+ "id": "search",
18
+ "kind": "component",
19
+ "module": "view.search",
20
+ "presentation": { "kind": "drawer", "size": 680 }
21
+ },
22
+ {
23
+ "id": "button",
24
+ "kind": "component",
25
+ "module": "view.button"
26
+ }
27
+ ]
28
+ },
29
+ "provides": {
30
+ "actions": [
31
+ {
32
+ "id": "search",
33
+ "title": "搜索音源"
34
+ },
35
+ {
36
+ "id": "play",
37
+ "title": "播放"
38
+ },
39
+ { "id": "enqueue", "title": "加入队列" },
40
+ {
41
+ "id": "open",
42
+ "title": "打开搜索页面"
43
+ }
44
+ ]
45
+ },
46
+ "uses": {
47
+ "permissions": [
48
+ {
49
+ "key": "catalog",
50
+ "name": "music.read",
51
+ "reason": "搜索用户选择的音源"
52
+ },
53
+ {
54
+ "key": "listen",
55
+ "name": "music.control",
56
+ "reason": "播放用户选择的歌曲或加入播放队列"
57
+ }
58
+ ]
59
+ },
60
+ "ui": {
61
+ "pages": [
62
+ {
63
+ "id": "search",
64
+ "title": "音源搜索",
65
+ "mount": "sidebar",
66
+ "icon": { "kind": "host", "name": "search" },
67
+ "group": "library",
68
+ "view": "search"
69
+ },
70
+ {
71
+ "id": "settings",
72
+ "title": "音源搜索",
73
+ "mount": "settings",
74
+ "view": "search"
75
+ }
76
+ ],
77
+ "slots": [
78
+ {
79
+ "id": "search-button",
80
+ "slot": "playlist.header.actions",
81
+ "mode": "append",
82
+ "view": "button"
83
+ }
84
+ ]
85
+ }
86
+ },
87
+ "framework": "vue",
88
+ "entries": {
89
+ "logic.main": "src/index.js",
90
+ "view.search": "src/Search.vue",
91
+ "view.button": "src/Open.vue"
92
+ },
93
+ "output": "dist/plugin.js"
94
+ }
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "ceru-page-extension",
3
+ "version": "0.1.0",
4
+ "private": true,
5
+ "type": "module",
6
+ "scripts": {
7
+ "dev": "ceru-plugin dev",
8
+ "build": "ceru-plugin build",
9
+ "typecheck": "ceru-plugin typecheck",
10
+ "validate": "ceru-plugin validate dist/plugin.js",
11
+ "preview": "ceru-plugin preview dist/plugin.js",
12
+ "check:compat": "ceru-plugin check-compat"
13
+ },
14
+ "dependencies": {
15
+ "@shiqianjiang/ceru-plugin-sdk": "^3.0.0"
16
+ },
17
+ "devDependencies": {
18
+ "@shiqianjiang/ceru-plugin-cli": "^3.0.0",
19
+ "typescript": "~5.9.3",
20
+ "prettier": "^3.6.2",
21
+ "vue": "^3.5.21",
22
+ "tdesign-vue-next": "1.15.4"
23
+ }
24
+ }
@@ -0,0 +1,6 @@
1
+ <script setup>
2
+ import {Button} from 'tdesign-vue-next'
3
+ import {useAction} from '@shiqianjiang/ceru-plugin-sdk/vue'
4
+ const open=useAction('open')
5
+ </script>
6
+ <template><Button @click="open()">音源搜索</Button></template>
@@ -0,0 +1,62 @@
1
+ <script setup>
2
+ import { ref } from 'vue'
3
+ import { Button, Input } from 'tdesign-vue-next'
4
+ import { useAction, useHostComponents, useViewState } from '@shiqianjiang/ceru-plugin-sdk/vue'
5
+ const query = ref(''),
6
+ pending = ref(false),
7
+ error = ref('')
8
+ const search = useAction('search')
9
+ const state = useViewState()
10
+ const { SongList, PageHeader, EmptyState, LoadingState } = useHostComponents()
11
+ const actions = { play: 'play', enqueue: 'enqueue' }
12
+ async function submit() {
13
+ if (pending.value) return
14
+ pending.value = true
15
+ error.value = ''
16
+ try {
17
+ await search(query.value)
18
+ } catch (reason) {
19
+ error.value = String(reason)
20
+ } finally {
21
+ pending.value = false
22
+ }
23
+ }
24
+ </script>
25
+ <template>
26
+ <section>
27
+ <PageHeader title="音源搜索" description="搜索歌曲,或把结果加入播放队列。" />
28
+ <div class="search-bar" role="search">
29
+ <Input v-model="query" aria-label="歌曲名称" placeholder="输入歌曲名称" @enter="submit" />
30
+ <Button type="button" :disabled="pending" @click="submit">搜索</Button>
31
+ </div>
32
+ <p v-if="error" role="alert">{{ error }}</p>
33
+ <LoadingState v-if="pending" title="正在搜索…" />
34
+ <SongList v-else-if="state.items?.length" :items="state.items" :actions="actions" />
35
+ <EmptyState
36
+ v-else
37
+ :title="state.searched ? '没有找到歌曲' : '搜索你的第一首歌'"
38
+ :description="
39
+ state.searched ? '换个关键词,或检查音源是否已启用。' : '启用的音源和本地曲库均可用于搜索。'
40
+ "
41
+ />
42
+ </section>
43
+ </template>
44
+ <style scoped>
45
+ section {
46
+ padding: 16px;
47
+ display: grid;
48
+ gap: 12px;
49
+ }
50
+ .search-bar {
51
+ display: flex;
52
+ align-items: center;
53
+ gap: 8px;
54
+ }
55
+ .search-bar > :first-child {
56
+ flex: 1;
57
+ min-width: 0;
58
+ }
59
+ [role='alert'] {
60
+ color: var(--td-error-color);
61
+ }
62
+ </style>
@@ -0,0 +1,54 @@
1
+ import { definePlugin } from '@shiqianjiang/ceru-plugin-sdk'
2
+ export default definePlugin((ctx) => {
3
+ const refs = new Map()
4
+ let generation = 0
5
+ ctx.actions.register('search', async (input, operation) => {
6
+ const request = ++generation
7
+ const sources = await ctx.music.sources()
8
+ const source = sources.find((item) => item.available)
9
+ const result = source
10
+ ? await ctx.music.search(
11
+ source.id,
12
+ {
13
+ query: typeof input === 'string' ? input : '',
14
+ kinds: ['track'],
15
+ limit: 30,
16
+ filters: {},
17
+ },
18
+ { permissionKey: 'catalog', operation },
19
+ )
20
+ : { items: [] }
21
+ if (request !== generation) return { count: 0 }
22
+ refs.clear()
23
+ const items = result.items.map((item, index) => {
24
+ const key = request + ':' + index
25
+ const durationMs = item.durationMs ?? item.metadata?.durationMs
26
+ refs.set(key, item.ref)
27
+ return {
28
+ key,
29
+ title: item.title,
30
+ source: item.ref.providerId,
31
+ playable: item.playable !== false,
32
+ metadata: {
33
+ artists: item.metadata?.artists ?? [],
34
+ qualities: item.metadata?.qualities ?? [],
35
+ },
36
+ ...(durationMs !== undefined ? { durationMs } : {}),
37
+ }
38
+ })
39
+ await ctx.ui.views.setState('search', { items, searched: true })
40
+ return { count: items.length }
41
+ })
42
+ function resolveKey(key) {
43
+ const ref = typeof key === 'string' && refs.get(key)
44
+ if (!ref) throw Error('搜索结果已更新,请重新选择歌曲')
45
+ return ref
46
+ }
47
+ ctx.actions.register('play', async (key, operation) => {
48
+ await ctx.music.play(resolveKey(key), { permissionKey: 'listen', operation })
49
+ })
50
+ ctx.actions.register('enqueue', async (key, operation) => {
51
+ await ctx.music.enqueue([resolveKey(key)], 'end', { permissionKey: 'listen', operation })
52
+ })
53
+ ctx.actions.register('open', () => ctx.ui.pages.open('search'))
54
+ })
@@ -0,0 +1,17 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "module": "ESNext",
5
+ "moduleResolution": "Bundler",
6
+ "strict": true,
7
+ "noEmit": true,
8
+ "skipLibCheck": true,
9
+ "allowJs": true,
10
+ "checkJs": false,
11
+ "lib": ["ES2022", "DOM"],
12
+ "types": [],
13
+ "jsx": "preserve",
14
+ "jsxImportSource": "vue"
15
+ },
16
+ "include": ["src", ".ceru-dev/types/**/*.d.ts"]
17
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "recommendations": ["esbenp.prettier-vscode", "Vue.volar"]
3
+ }
@@ -0,0 +1,19 @@
1
+ {
2
+ "version": "0.2.0",
3
+ "configurations": [
4
+ {
5
+ "name": "Watch Ceru plugin",
6
+ "type": "node",
7
+ "request": "launch",
8
+ "program": "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
9
+ "args": [
10
+ "dev"
11
+ ],
12
+ "cwd": "${workspaceFolder}",
13
+ "console": "integratedTerminal",
14
+ "skipFiles": [
15
+ "<node_internals>/**"
16
+ ]
17
+ }
18
+ ]
19
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "typescript.tsdk": "node_modules/typescript/lib",
3
+ "typescript.enablePromptUseWorkspaceTsdk": true,
4
+ "editor.formatOnSave": true,
5
+ "[typescript]": {
6
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
7
+ },
8
+ "[javascript]": {
9
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
10
+ },
11
+ "json.schemas": [
12
+ {
13
+ "fileMatch": ["/ceru.plugin.json"],
14
+ "url": "./node_modules/@shiqianjiang/ceru-plugin-cli/schemas/config.schema.json"
15
+ }
16
+ ],
17
+ "files.exclude": {
18
+ "**/*.tsbuildinfo": true
19
+ }
20
+ }
@@ -0,0 +1,43 @@
1
+ {
2
+ "version": "2.0.0",
3
+ "tasks": [
4
+ {
5
+ "label": "Ceru: dev",
6
+ "type": "process",
7
+ "isBackground": true,
8
+ "problemMatcher": {
9
+ "owner": "ceru",
10
+ "pattern": {
11
+ "regexp": "^CERU_ERROR (.*)$",
12
+ "message": 1
13
+ },
14
+ "background": {
15
+ "activeOnStart": true,
16
+ "beginsPattern": "^.*$",
17
+ "endsPattern": "^CERU_BUILD_READY "
18
+ }
19
+ },
20
+ "command": "node",
21
+ "args": [
22
+ "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
+ "dev"
24
+ ],
25
+ "options": {
26
+ "cwd": "${workspaceFolder}"
27
+ }
28
+ },
29
+ {
30
+ "label": "Ceru: typecheck",
31
+ "type": "npm",
32
+ "script": "typecheck",
33
+ "problemMatcher": "$tsc",
34
+ "group": "build"
35
+ },
36
+ {
37
+ "label": "Ceru: build",
38
+ "type": "npm",
39
+ "script": "build",
40
+ "problemMatcher": []
41
+ }
42
+ ]
43
+ }
@@ -0,0 +1,9 @@
1
+ # 页面扩展
2
+
3
+ 侧边栏和设置页复用 Vue 搜索视图,歌单页动作槽提供入口。搜索首个可用音源(支持本地曲库),点击歌名播放,在“更多”中加入队列。
4
+
5
+ `SongList` 的 `actions` 指向清单声明的 logic 动作;`music.read` 与 `music.control` 分别授权搜索、播放及入队。视图只收到显示字段和本轮结果的临时 key,完整资源引用保留在 logic 中。未声明的收藏和下载不显示。
6
+
7
+ 运行 `npm install`、`npm run typecheck`、`npm run dev`,将打印的 `dist/plugin.js` 添加到「设置 → 插件管理 → 管理设置 → 插件开发者模式」。保存源码自动重载;分发前运行 `npm run build` 和 `npm run validate`。
8
+
9
+ 侧栏读取 `ui.pages[].icon`:示例使用 `{"kind":"host","name":"search"}`。也可以在工程的 `resources` 中声明图片,再引用 `{"kind":"asset","resource":"nav.logo"}`。没有图标或图片无法显示时回退为默认插件图标。
@@ -0,0 +1,6 @@
1
+ node_modules/
2
+ dist/
3
+ .keys/
4
+ .ceru-dev/
5
+ *.private.pem
6
+ *.tsbuildinfo
@@ -0,0 +1,8 @@
1
+ {
2
+ "folders": [
3
+ {
4
+ "path": ".",
5
+ },
6
+ ],
7
+ "settings": {},
8
+ }