@shiqianjiang/ceru-plugin-cli 0.3.16 → 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
@@ -2,35 +2,18 @@
2
2
  "version": "0.2.0",
3
3
  "configurations": [
4
4
  {
5
- "name": "Launch Ceru plugin",
6
- "type": "pwa-chrome",
7
- "request": "attach",
8
- "port": 9223,
9
- "preLaunchTask": "Ceru: dev",
10
- "webRoot": "${workspaceFolder}",
11
- "sourceMaps": true,
12
- "sourceMapPathOverrides": {
13
- "ceru:///*": "${workspaceFolder}/*"
14
- },
15
- "skipFiles": ["**/node_modules/**"],
16
- "address": "127.0.0.1",
17
- "urlFilter": "http://127.0.0.1:4179/",
18
- "timeout": 30000
19
- },
20
- {
21
- "name": "Attach to Ceru plugin",
22
- "type": "pwa-chrome",
23
- "request": "attach",
24
- "port": 9223,
25
- "webRoot": "${workspaceFolder}",
26
- "sourceMaps": true,
27
- "sourceMapPathOverrides": {
28
- "ceru:///*": "${workspaceFolder}/*"
29
- },
30
- "skipFiles": ["**/node_modules/**"],
31
- "address": "127.0.0.1",
32
- "urlFilter": "http://127.0.0.1:4179/",
33
- "timeout": 30000
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
+ ]
34
17
  }
35
18
  ]
36
19
  }
@@ -14,14 +14,13 @@
14
14
  "background": {
15
15
  "activeOnStart": true,
16
16
  "beginsPattern": "^.*$",
17
- "endsPattern": "^CERU_DEBUG_READY "
17
+ "endsPattern": "^CERU_BUILD_READY "
18
18
  }
19
19
  },
20
20
  "command": "node",
21
21
  "args": [
22
22
  "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
- "dev",
24
- "--ensure-running"
23
+ "dev"
25
24
  ],
26
25
  "options": {
27
26
  "cwd": "${workspaceFolder}"
@@ -1,22 +1,28 @@
1
1
  # connected-library / js
2
2
 
3
- Ceru Music v2 插件开发模板。此目录是源码,不是安装包。
3
+ 桌面账号菜单中的「音乐库账号」支持添加多个演示昵称、切换和退出。该示例不联网,请勿填写真实密码。接入实际平台时,在 `ctx.accounts.register` 的 `login` 中使用平台接口换取会话,在 `profile` 中返回公开资料;不要把凭据写进插件存储。
4
+
5
+ Ceru Music v3 插件开发模板。此目录是源码,不是安装包。
4
6
 
5
7
  ## 运行 demo
6
8
 
7
- 1. 使用脚手架创建工程:
9
+ 1. 使用匹配的 v3 脚手架创建工程(本地开发套件可使用其 `npm run create` 命令):
8
10
 
9
- npm create ceru-plugin@latest my-plugin -- --template connected-library --lang js
11
+ ceru-plugin init my-plugin --template connected-library --lang js
10
12
 
11
13
  2. 进入目录,运行 npm install。
12
- 3. 运行 npm run dev,打开独立 Electron 调试工作台。
14
+ 3. 运行 npm run dev,在澜音「设置 → 插件管理 → 管理设置 → 插件开发者模式」添加终端打印的 JS 文件。
13
15
  4. 修改 src 中的代码;保存后自动类型检查并重载。
14
16
  5. 运行 npm run build,只分发 dist/plugin.js。
15
17
 
16
18
  ## 编辑器
17
19
 
18
- VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to Ceru plugin。
19
- 激活代码已经执行时,可点击“重新运行”再次命中断点。
20
+ 发现页的「已连接的音乐库」仅在选中 `catalog` 且当前子账号未过期时出现。`connection.visible` 每次读取宿主保存的账号状态,重启后无需播放或再次填写表单;退出最后一个账号或凭据过期后入口隐藏。插件设置始终可打开,其中的“演示连接”只验证服务器地址,不是账号登录。
21
+
22
+ 在 `ceru.plugin.json` 中,若只需判断平台,可将 `when` 改为 `{ "selectedSource": "catalog" }`;只看连接则改为 `{ "predicate": "connection.visible" }`。两者并用时默认都须满足,可指定 `"combine": "any"`。
23
+
24
+ VS Code 按 F5 选择 Watch Ceru plugin,会启动本地构建监听,不会另开 Electron。
25
+ 已在终端运行 npm run dev 时不必再按 F5。
20
26
  配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
21
27
 
22
28
  ## 宿主资源
@@ -26,22 +32,30 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
26
32
  - 默认封面:await ctx.assets.url('placeholder.cover')。
27
33
  - 共享工具:ctx.utils.lodash。
28
34
 
29
- Vue/React 的生产运行代码、页面和样式直接编入发行 JS,宿主不提供框架。
35
+ 此模板的 `library` 是宿主渲染的 `native` 视图,`settings` 是自带页面代码的 `web` 视图。若需要复用宿主 Vue、TDesign 或播放器组件,选择 `component` 视图,不要将桌面组件复制进插件。
30
36
  TypeScript、Vue 编译器、构建工具与开发服务器不会进入产物。
31
- 运行 npm run preview 可只加载 dist/plugin.js 检查发布后的行为。
37
+ 运行 `npm run typecheck` 只检查工程,不生成发行文件。可选 `npm run preview` 验证构建产物并打印路径;将该文件加入桌面的插件开发者模式即可预览,不会启动服务器。
32
38
 
33
39
  若 VS Code 打开的是父目录,请打开本工程的 ceru-plugin.code-workspace,
34
- 再在“运行和调试”中选择 Launch Ceru plugin;已经运行 npm/pnpm dev 时选择 Attach to Ceru plugin。
40
+ 再在“运行和调试”中选择 Watch Ceru plugin。
35
41
  F5 执行当前下拉框中的配置,不会自动选择终端所在的子工程。
36
42
 
37
43
  ## 边界
38
44
 
39
- 本模板面向 v2 协议,需要支持 native Surface 的 Host。
45
+ ### 音源选择与入口条件
46
+
47
+ `catalog` 可在未登录时注册、显示和点选。`beforeSelect: "catalog.enter"` 只拦截切入本实现,不拦截切走。动作返回 `true` 放行、`false` 保留原选择,或返回 `{ login: { accountId: 'catalog' } }` 让宿主发起该账号的登录。续登可带原 `connectionId`。登录成功后宿主再调用一次判断,只有返回 `true` 才提交;取消、改选、插件停用或撤权均不能提交旧选择。不要让普通判断动作自行等待用户输入。
48
+
49
+ 发现页的 `when` 同时要求选中 `catalog` 且 `connection.visible` 返回真。只写 `{ "selectedSource": "catalog" }` 就是纯声明;只写 `{ "predicate": "connection.visible" }` 就是纯函数。二者同时声明时默认 `all`;要满足任意一项,写 `"combine": "any"`。判断动作可返回 `force-show` 或 `force-hide` 覆盖显隐。设置登录入口不要声明 `when`。
50
+
51
+ 音源的 `when.predicate` 也可返回 `{ state: 'disabled', reason: '服务正在维护' }`。宿主在悬停或键盘聚焦时展示原因;不传 `reason` 就只置灰。需要点选登录时不要返回 `disabled`。入口隐藏或禁用不能代替受保护数据操作中的账号校验。
52
+
53
+ 本模板面向 v3 协议,需要支持 native Surface 的 Host。
40
54
  凭据保险箱、完整音乐业务和 Guest 安装需要正式 Host;不支持的调试调用会明确报错。
41
55
  不要把私人 API Key、卡密或发行私钥提交到仓库。
42
56
 
43
57
  此 demo 展示原生歌单网格、歌曲列表、账号菜单贡献、导入及播放动作,还有连接表单和状态更新;点击“演示连接”不会联网或保存密码。元数据来自本地常量,播放前需实现自己的 tracks.resolve。
44
58
 
45
- 原生页面由 src/index.js 中的 defineNativeView 返回标准 JSON 内容,playlistSections 把它放入 Host 现有本地/云歌单页;library.open 使用 navigation.open({ page: 'playlist', sectionId: 'library' }) 跳转定位,不打开抽屉。点击具体歌单传递完整 ResourceRef,进入 Host 歌单详情;播放调用 Host 队列和播放器;导入调用 Host 现有导入窗口。独立工作台保留本地/云歌单示意区域并渲染插件区块,完整音乐业务由正式 Host 实现。
59
+ 在支持 v3 的澜音里启用插件后,打开歌单页的「我的音乐库」。清单里的 `ui.pages` 用 `mount: "playlist-section"` 声明入口;`src/index.js` 的 `render.library` 返回列表数据,卡片和按钮由澜音绘制。点击「演示歌单」会进入宿主歌单详情。要验证登录条件,在搜索栏选中该音源,填写演示昵称,然后到发现页查看「已连接的音乐库」;取消登录时不会切换音源。
46
60
 
47
- 账号摘要返回 signedIn、displayName、可选 avatarUrl/badge;账号变化通过 ctx.ui.setState 通知 Host。自定义账号登录页面也可使用 Vue 或 React 打包为 Web Surface,与原生音乐库页面同时存在。
61
+ `account.summary` 从 `ctx.accounts.current('catalog')` 读取当前账号并返回公开摘要。`ctx.ui.setState` 只更新视图状态,不会登录或切换账号;表单登录、切换和退出由桌面账号菜单处理。
@@ -1,86 +1,158 @@
1
1
  {
2
2
  "manifest": {
3
- "manifestVersion": 2,
3
+ "manifestVersion": 3,
4
4
  "id": "local.js",
5
5
  "name": "js",
6
6
  "version": "0.1.0",
7
- "description": "A Ceru Music v2 connected-library plugin",
7
+ "description": "A Ceru Music v3 connected-library 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", "onProvider:catalog"]
18
+ "activation": [
19
+ "onCommand:hello",
20
+ "onProvider:catalog"
21
+ ],
22
+ "module": "logic.main"
17
23
  },
18
- "surfaces": [
19
- { "id": "library", "kind": "native", "entry": "render.library" },
24
+ "views": [
25
+ {
26
+ "id": "library",
27
+ "kind": "native",
28
+ "module": "render.library"
29
+ },
20
30
  {
21
31
  "id": "settings",
22
- "kind": "schema",
23
- "entry": "schema.settings"
32
+ "kind": "web",
33
+ "module": "view.settings"
24
34
  }
25
35
  ]
26
36
  },
27
- "contributes": {
28
- "commands": [
29
- { "id": "account.summary", "title": "账号状态", "action": "account.summary" },
30
- { "id": "render.library", "title": "渲染音乐库", "action": "render.library" },
31
- { "id": "library.open", "title": "打开原生歌单页", "action": "library.open" },
32
- { "id": "playlist.open", "title": "打开歌单", "action": "playlist.open" },
33
- { "id": "playlist.import", "title": "导入歌单", "action": "playlist.import" },
34
- { "id": "track.play", "title": "播放", "action": "track.play" },
37
+ "provides": {
38
+ "providers": [
39
+ {
40
+ "id": "catalog",
41
+ "name": "js",
42
+ "protocols": [
43
+ "music.search@1",
44
+ "music.resolve@1",
45
+ "music.playlists@1"
46
+ ],
47
+ "icon": {
48
+ "kind": "host",
49
+ "name": "music-note"
50
+ },
51
+ "connectionMode": "multiple",
52
+ "beforeSelect": "catalog.enter"
53
+ }
54
+ ],
55
+ "importers": [
56
+ {
57
+ "id": "catalog",
58
+ "title": "演示歌单",
59
+ "providerId": "catalog"
60
+ }
61
+ ],
62
+ "actions": [
63
+ { "id": "catalog.enter", "title": "切入音乐库" },
64
+ {
65
+ "id": "account.summary",
66
+ "title": "账号状态"
67
+ },
68
+ {
69
+ "id": "render.library",
70
+ "title": "渲染音乐库"
71
+ },
72
+ {
73
+ "id": "library.open",
74
+ "title": "打开原生歌单页"
75
+ },
76
+ {
77
+ "id": "playlist.open",
78
+ "title": "打开歌单"
79
+ },
80
+ {
81
+ "id": "playlist.import",
82
+ "title": "导入歌单"
83
+ },
84
+ {
85
+ "id": "track.play",
86
+ "title": "播放"
87
+ },
35
88
  {
36
89
  "id": "hello",
37
- "title": "Hello",
38
- "action": "hello"
90
+ "title": "Hello"
91
+ },
92
+ {
93
+ "id": "connection.visible",
94
+ "title": "判断演示连接状态"
39
95
  },
40
96
  {
41
- "id": "connect",
97
+ "id": "connection.connect",
42
98
  "title": "演示连接",
43
- "action": "connection.connect",
44
99
  "view": "settings"
45
100
  }
46
101
  ],
47
- "providers": [
102
+ "accounts": [
48
103
  {
49
104
  "id": "catalog",
50
- "name": "js",
51
- "protocols": ["music.search@1", "music.resolve@1", "music.playlists@1"],
52
- "icon": {
53
- "kind": "host",
54
- "name": "music-note"
55
- },
56
- "connectionMode": "multiple"
105
+ "title": "音乐库账号",
106
+ "multiple": true,
107
+ "capabilities": ["profile", "likes", "playlists", "history", "recommend"],
108
+ "loginMethods": [
109
+ "form"
110
+ ],
111
+ "providers": [
112
+ "catalog"
113
+ ],
114
+ "view": "settings"
57
115
  }
58
- ],
59
- "playlistSections": [{ "id": "library", "title": "我的音乐库", "view": "library", "order": 0 }],
60
- "accountItems": [{ "id": "catalog", "title": "音乐库账号", "view": "settings", "action": "account.summary" }],
61
- "playlistImporters": [{ "id": "catalog", "title": "演示歌单", "providerId": "catalog" }],
62
- "settingsPages": [
116
+ ]
117
+ },
118
+ "uses": {
119
+ "permissions": [
120
+ {
121
+ "key": "playback",
122
+ "name": "player.control",
123
+ "reason": "使用 Host 的播放器和队列播放音乐库歌曲"
124
+ }
125
+ ]
126
+ },
127
+ "ui": {
128
+ "pages": [
129
+ {
130
+ "id": "connected",
131
+ "title": "已连接的音乐库",
132
+ "view": "library",
133
+ "mount": "home-tab",
134
+ "when": { "selectedSource": "catalog", "predicate": "connection.visible" }
135
+ },
63
136
  {
64
137
  "id": "settings",
65
138
  "title": "插件设置",
66
- "view": "settings"
139
+ "view": "settings",
140
+ "mount": "settings"
141
+ },
142
+ {
143
+ "id": "library",
144
+ "title": "我的音乐库",
145
+ "view": "library",
146
+ "order": 0,
147
+ "mount": "playlist-section"
67
148
  }
68
149
  ]
69
- },
70
- "permissions": [{ "key": "playback", "name": "player.control", "reason": "使用 Host 的播放器和队列播放音乐库歌曲" }],
71
- "dataSchemas": {
72
- "config": 1,
73
- "state": 1
74
150
  }
75
151
  },
76
152
  "entries": {
77
- "logic.main": "src/index.js"
78
- },
79
- "resources": {
80
- "schema.settings": {
81
- "path": "ui/settings.json",
82
- "type": "json"
83
- }
153
+ "logic.main": "src/index.js",
154
+ "view.settings": "src/settings.js"
84
155
  },
156
+ "resources": {},
85
157
  "output": "dist/plugin.js"
86
158
  }
@@ -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.16"
15
+ "@shiqianjiang/ceru-plugin-sdk": "^3.0.0"
15
16
  },
16
17
  "devDependencies": {
17
- "@shiqianjiang/ceru-plugin-cli": "^0.3.16",
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
  }
@@ -2,6 +2,46 @@ import { assertResourceRef, defineNativeView, definePlugin } from '@shiqianjiang
2
2
 
3
3
  export default definePlugin(async (ctx) => {
4
4
  let connected = false
5
+ ctx.actions.register('catalog.enter', async () => {
6
+ const current = await ctx.accounts.current('catalog')
7
+ if (current && !current.expired) return true
8
+ const login = { accountId: 'catalog' }
9
+ if (current?.expired) Object.assign(login, { connectionId: current.connectionId })
10
+ return { login }
11
+ })
12
+ const accountVisible = async () => {
13
+ const current = await ctx.accounts.current('catalog')
14
+ return current !== null && !current.expired
15
+ }
16
+ ctx.actions.register('connection.visible', accountVisible)
17
+ let pendingName = ''
18
+ const accountTrack=async (connection,label)=>({
19
+ ref:{pluginId:ctx.plugin.id,providerId:'catalog',kind:'track',id:'demo-track',connectionId:connection},
20
+ title:String(await ctx.storage.get('demo.account.'+connection))+' · '+label,
21
+ metadata:{artists:['演示歌手']},capabilities:['play'],
22
+ })
23
+ ctx.accounts.register('catalog', {
24
+ likes:{
25
+ async list(account){const hidden=await ctx.storage.get('demo.unliked.'+account.id);return {items:hidden?[]:[await accountTrack(account.id,'喜欢的歌曲')]}},
26
+ async set(account,{ref,liked}){if(ref.id!=='demo-track')throw Error('未知演示歌曲');await ctx.storage.set('demo.unliked.'+account.id,!liked)},
27
+ },
28
+ history:{async list(account){return {items:[await accountTrack(account.id,'最近播放')]}}},
29
+ recommend:{async list(account){return {items:[await accountTrack(account.id,'今日推荐')]}}},
30
+ playlists:{async list(account){return {items:[{ref:{pluginId:ctx.plugin.id,providerId:'catalog',connectionId:account.id,kind:'playlist',id:'demo'},title:String(await ctx.storage.get('demo.account.'+account.id))+' · 我的歌单',playlist:{trackCount:1},capabilities:['open']}]}}},
31
+ async login({ auth }) {
32
+ const values = await auth.form({ fields: [{ key: 'name', label: '演示昵称', type: 'text' }] })
33
+ pendingName = values?.name.trim().slice(0, 80) || ''
34
+ if (!pendingName) return null
35
+ return { credential: 'local-demo:' + pendingName }
36
+ },
37
+ async profile(account) {
38
+ const key = 'demo.account.' + account.id
39
+ if (pendingName) { await ctx.storage.set(key, pendingName); pendingName = '' }
40
+ const name = String(await ctx.storage.get(key) || '演示用户')
41
+ return { id: name, displayName: name }
42
+ },
43
+ async logout(account) { await ctx.storage.delete('demo.account.' + account.id);await ctx.storage.delete('demo.unliked.'+account.id) }
44
+ })
5
45
  const playlist = {
6
46
  ref: { pluginId: ctx.plugin.id, providerId: 'catalog', connectionId: 'demo', kind: 'playlist', id: 'demo' },
7
47
  title: '演示歌单',
@@ -20,10 +60,10 @@ export default definePlugin(async (ctx) => {
20
60
  })
21
61
  ctx.actions.register('hello', () => ctx.ui.openView('settings'))
22
62
  ctx.actions.register('library.open', () => ctx.ui.navigation.open({ page: 'playlist', sectionId: 'library' }))
23
- ctx.actions.register('account.summary', () => ({
24
- signedIn: connected,
25
- displayName: connected ? '演示音乐库' : '连接你的音乐库',
26
- }))
63
+ ctx.actions.register('account.summary', async () => {
64
+ const signedIn = await accountVisible()
65
+ return { signedIn, displayName: signedIn ? '演示音乐库' : '连接你的音乐库' }
66
+ })
27
67
  ctx.actions.register('render.library', defineNativeView(() => ({
28
68
  type: 'page',
29
69
  description: connected ? '演示连接已建立' : '可先浏览演示内容,再接入自己的音乐库 API。',
@@ -67,6 +107,7 @@ export default definePlugin(async (ctx) => {
67
107
  if (!['http:', 'https:'].includes(server.protocol)) throw new Error('只支持 HTTP(S) 地址')
68
108
 
69
109
  connected = true
110
+ await ctx.entries.invalidate()
70
111
  await ctx.ui.setState('library', { connected })
71
112
  // 本地 demo 不联网,也不收集密码。真实连接应使用 Host 的凭据与网络 API。
72
113
  await ctx.ui.setState('settings', {
@@ -79,7 +120,7 @@ export default definePlugin(async (ctx) => {
79
120
 
80
121
  ctx.providers.register('catalog', {
81
122
  playlists: {
82
- async get() { return { name: playlist.title, playlist: playlist.playlist, items: tracks } },
123
+ async get(_resource,_cursor,operation) { return { name: playlist.title, playlist: playlist.playlist, items: operation.connectionId ? [await accountTrack(operation.connectionId,'歌单歌曲')] : tracks } },
83
124
  },
84
125
  tracks: {
85
126
  async search() {
@@ -0,0 +1,28 @@
1
+ import { defineSurface } from '@shiqianjiang/ceru-plugin-sdk'
2
+
3
+ export default defineSurface(ctx => {
4
+ const form = document.createElement('form')
5
+ const label = document.createElement('label')
6
+ const address = document.createElement('input')
7
+ const connect = document.createElement('button')
8
+ const status = document.createElement('p')
9
+ label.textContent = '服务器地址'
10
+ address.type = 'url'
11
+ address.required = true
12
+ label.append(address)
13
+ connect.textContent = '演示连接'
14
+ form.append(label, connect, status)
15
+ form.onsubmit = async event => {
16
+ event.preventDefault()
17
+ connect.disabled = true
18
+ try { await ctx.invoke('connection.connect', {serverUrl:address.value}) }
19
+ catch (error) { status.textContent = String(error) }
20
+ finally { connect.disabled = false }
21
+ }
22
+ ctx.root.replaceChildren(form)
23
+ const off = ctx.subscribe(state => {
24
+ if (typeof state.serverUrl === 'string') address.value = state.serverUrl
25
+ if (typeof state.status === 'string') status.textContent = state.status
26
+ })
27
+ return () => { off(); ctx.root.replaceChildren() }
28
+ })
@@ -2,35 +2,18 @@
2
2
  "version": "0.2.0",
3
3
  "configurations": [
4
4
  {
5
- "name": "Launch Ceru plugin",
6
- "type": "pwa-chrome",
7
- "request": "attach",
8
- "port": 9223,
9
- "preLaunchTask": "Ceru: dev",
10
- "webRoot": "${workspaceFolder}",
11
- "sourceMaps": true,
12
- "sourceMapPathOverrides": {
13
- "ceru:///*": "${workspaceFolder}/*"
14
- },
15
- "skipFiles": ["**/node_modules/**"],
16
- "address": "127.0.0.1",
17
- "urlFilter": "http://127.0.0.1:4179/",
18
- "timeout": 30000
19
- },
20
- {
21
- "name": "Attach to Ceru plugin",
22
- "type": "pwa-chrome",
23
- "request": "attach",
24
- "port": 9223,
25
- "webRoot": "${workspaceFolder}",
26
- "sourceMaps": true,
27
- "sourceMapPathOverrides": {
28
- "ceru:///*": "${workspaceFolder}/*"
29
- },
30
- "skipFiles": ["**/node_modules/**"],
31
- "address": "127.0.0.1",
32
- "urlFilter": "http://127.0.0.1:4179/",
33
- "timeout": 30000
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
+ ]
34
17
  }
35
18
  ]
36
19
  }
@@ -14,14 +14,13 @@
14
14
  "background": {
15
15
  "activeOnStart": true,
16
16
  "beginsPattern": "^.*$",
17
- "endsPattern": "^CERU_DEBUG_READY "
17
+ "endsPattern": "^CERU_BUILD_READY "
18
18
  }
19
19
  },
20
20
  "command": "node",
21
21
  "args": [
22
22
  "${workspaceFolder}/node_modules/@shiqianjiang/ceru-plugin-cli/dist/bin.js",
23
- "dev",
24
- "--ensure-running"
23
+ "dev"
25
24
  ],
26
25
  "options": {
27
26
  "cwd": "${workspaceFolder}"
@@ -1,22 +1,28 @@
1
1
  # connected-library / ts
2
2
 
3
- Ceru Music v2 插件开发模板。此目录是源码,不是安装包。
3
+ 桌面账号菜单中的「音乐库账号」支持添加多个演示昵称、切换和退出。该示例不联网,请勿填写真实密码。接入实际平台时,在 `ctx.accounts.register` 的 `login` 中使用平台接口换取会话,在 `profile` 中返回公开资料;不要把凭据写进插件存储。
4
+
5
+ Ceru Music v3 插件开发模板。此目录是源码,不是安装包。
4
6
 
5
7
  ## 运行 demo
6
8
 
7
- 1. 使用脚手架创建工程:
9
+ 1. 使用匹配的 v3 脚手架创建工程(本地开发套件可使用其 `npm run create` 命令):
8
10
 
9
- npm create ceru-plugin@latest my-plugin -- --template connected-library --lang ts
11
+ ceru-plugin init my-plugin --template connected-library --lang ts
10
12
 
11
13
  2. 进入目录,运行 npm install。
12
- 3. 运行 npm run dev,打开独立 Electron 调试工作台。
14
+ 3. 运行 npm run dev,在澜音「设置 → 插件管理 → 管理设置 → 插件开发者模式」添加终端打印的 JS 文件。
13
15
  4. 修改 src 中的代码;保存后自动类型检查并重载。
14
16
  5. 运行 npm run build,只分发 dist/plugin.js。
15
17
 
16
18
  ## 编辑器
17
19
 
18
- VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to Ceru plugin。
19
- 激活代码已经执行时,可点击“重新运行”再次命中断点。
20
+ 发现页的「已连接的音乐库」仅在选中 `catalog` 且当前子账号未过期时出现。`connection.visible` 每次读取宿主保存的账号状态,重启后无需播放或再次填写表单;退出最后一个账号或凭据过期后入口隐藏。插件设置始终可打开,其中的“演示连接”只验证服务器地址,不是账号登录。
21
+
22
+ 在 `ceru.plugin.json` 中,若只需判断平台,可将 `when` 改为 `{ "selectedSource": "catalog" }`;只看连接则改为 `{ "predicate": "connection.visible" }`。两者并用时默认都须满足,可指定 `"combine": "any"`。
23
+
24
+ VS Code 按 F5 选择 Watch Ceru plugin,会启动本地构建监听,不会另开 Electron。
25
+ 已在终端运行 npm run dev 时不必再按 F5。
20
26
  配置文件有 JSON Schema 提示,SDK 提供参数类型、图标名称与 Lodash 方法补全。
21
27
 
22
28
  ## 宿主资源
@@ -26,22 +32,30 @@ VS Code 按 F5 选择 Launch Ceru plugin;已有调试窗口时选择 Attach to
26
32
  - 默认封面:await ctx.assets.url('placeholder.cover')。
27
33
  - 共享工具:ctx.utils.lodash。
28
34
 
29
- Vue/React 的生产运行代码、页面和样式直接编入发行 JS,宿主不提供框架。
35
+ 此模板的 `library` 是宿主渲染的 `native` 视图,`settings` 是自带页面代码的 `web` 视图。若需要复用宿主 Vue、TDesign 或播放器组件,选择 `component` 视图,不要将桌面组件复制进插件。
30
36
  TypeScript、Vue 编译器、构建工具与开发服务器不会进入产物。
31
- 运行 npm run preview 可只加载 dist/plugin.js 检查发布后的行为。
37
+ 运行 `npm run typecheck` 只检查工程,不生成发行文件。可选 `npm run preview` 验证构建产物并打印路径;将该文件加入桌面的插件开发者模式即可预览,不会启动服务器。
32
38
 
33
39
  若 VS Code 打开的是父目录,请打开本工程的 ceru-plugin.code-workspace,
34
- 再在“运行和调试”中选择 Launch Ceru plugin;已经运行 npm/pnpm dev 时选择 Attach to Ceru plugin。
40
+ 再在“运行和调试”中选择 Watch Ceru plugin。
35
41
  F5 执行当前下拉框中的配置,不会自动选择终端所在的子工程。
36
42
 
37
43
  ## 边界
38
44
 
39
- 本模板面向 v2 协议,需要支持 native Surface 的 Host。
45
+ ### 音源选择与入口条件
46
+
47
+ `catalog` 可在未登录时注册、显示和点选。`beforeSelect: "catalog.enter"` 只拦截切入本实现,不拦截切走。动作返回 `true` 放行、`false` 保留原选择,或返回 `{ login: { accountId: 'catalog' } }` 让宿主发起该账号的登录。续登可带原 `connectionId`。登录成功后宿主再调用一次判断,只有返回 `true` 才提交;取消、改选、插件停用或撤权均不能提交旧选择。不要让普通判断动作自行等待用户输入。
48
+
49
+ 发现页的 `when` 同时要求选中 `catalog` 且 `connection.visible` 返回真。只写 `{ "selectedSource": "catalog" }` 就是纯声明;只写 `{ "predicate": "connection.visible" }` 就是纯函数。二者同时声明时默认 `all`;要满足任意一项,写 `"combine": "any"`。判断动作可返回 `force-show` 或 `force-hide` 覆盖显隐。设置登录入口不要声明 `when`。
50
+
51
+ 音源的 `when.predicate` 也可返回 `{ state: 'disabled', reason: '服务正在维护' }`。宿主在悬停或键盘聚焦时展示原因;不传 `reason` 就只置灰。需要点选登录时不要返回 `disabled`。入口隐藏或禁用不能代替受保护数据操作中的账号校验。
52
+
53
+ 本模板面向 v3 协议,需要支持 native Surface 的 Host。
40
54
  凭据保险箱、完整音乐业务和 Guest 安装需要正式 Host;不支持的调试调用会明确报错。
41
55
  不要把私人 API Key、卡密或发行私钥提交到仓库。
42
56
 
43
57
  此 demo 展示原生歌单网格、歌曲列表、账号菜单贡献、导入及播放动作,还有连接表单和状态更新;点击“演示连接”不会联网或保存密码。元数据来自本地常量,播放前需实现自己的 tracks.resolve。
44
58
 
45
- 原生页面由 src/index.ts 中的 defineNativeView 返回标准 JSON 内容,playlistSections 把它放入 Host 现有本地/云歌单页;library.open 使用 navigation.open({ page: 'playlist', sectionId: 'library' }) 跳转定位,不打开抽屉。点击具体歌单传递完整 ResourceRef,进入 Host 歌单详情;播放调用 Host 队列和播放器;导入调用 Host 现有导入窗口。独立工作台保留本地/云歌单示意区域并渲染插件区块,完整音乐业务由正式 Host 实现。
59
+ 在支持 v3 的澜音里启用插件后,打开歌单页的「我的音乐库」。清单里的 `ui.pages` 用 `mount: "playlist-section"` 声明入口;`src/index.ts` 的 `render.library` 返回列表数据,卡片和按钮由澜音绘制。点击「演示歌单」会进入宿主歌单详情。要验证登录条件,在搜索栏选中该音源,填写演示昵称,然后到发现页查看「已连接的音乐库」;取消登录时不会切换音源。
46
60
 
47
- 账号摘要返回 signedIn、displayName、可选 avatarUrl/badge;账号变化通过 ctx.ui.setState 通知 Host。自定义账号登录页面也可使用 Vue 或 React 打包为 Web Surface,与原生音乐库页面同时存在。
61
+ `account.summary` 从 `ctx.accounts.current('catalog')` 读取当前账号并返回公开摘要。`ctx.ui.setState` 只更新视图状态,不会登录或切换账号;表单登录、切换和退出由桌面账号菜单处理。