@vestra-player/sdk 1.5.30 → 1.5.31

package/llms.txt

@@ -1,6 +1,6 @@
 # Vestra Player SDK
 
-> @vestra-player/sdk 1.5.30: write plugins for Vestra Player in TypeScript (plugin API `vestra/1`). A plugin is a folder with `manifest.json` and an entry module whose default export `activate(plugin)` the player calls; it runs in its own Node.js process. Everything a plugin creates (commands, windows, panels, filters, listeners…) is a handle that is released automatically when the plugin stops. L<n>: a line of llms-full.txt (next to this file), which has every page, declaration and example.
+> @vestra-player/sdk 1.5.31: write plugins for Vestra Player in TypeScript (plugin API `vestra/1`). A plugin is a folder with `manifest.json` and an entry module whose default export `activate(plugin)` the player calls; it runs in its own Node.js process. Everything a plugin creates (commands, windows, panels, filters, listeners…) is a handle that is released automatically when the plugin stops. L<n>: a line of llms-full.txt (next to this file), which has every page, declaration and example.
 
 **Rules**
 
@@ -33,7 +33,7 @@ my-plugin/
 }
 ```
 
-Fields: `id`, `version`, `apiVersion`, `entry`, `capabilities`, `name`, `author`, `punchline`, `description`, `tags`, `icon`, `readme`, `changelog`, `sourceUrl`, `license`, `minPlayerVersion`; unknown fields and capabilities are rejected. Rules and limits: L2231–2298.
+Fields: `id`, `version`, `apiVersion`, `entry`, `capabilities`, `name`, `author`, `punchline`, `description`, `tags`, `icon`, `readme`, `changelog`, `sourceUrl`, `license`, `minPlayerVersion`; unknown fields and capabilities are rejected. Rules and limits: L2428–2495.
 
 **main.ts**
 
@@ -76,9 +76,9 @@ export default async function activate(plugin: Plugin) {
 - `ui.settings`: Settings.page/show
 - `ui.theme`: Appearance.set/setLanguage
 - `secrets`: Secrets.get/set/delete
-- No capability: `tools`, `storage`, `system`, `app`, `ui` (images and Markdown), `i18n`, reading window.state, appearance.theme and packages.list. Details: L2299–2357.
+- No capability: `tools`, `storage`, `system`, `app`, `ui` (images and Markdown), `i18n`, reading window.state, appearance.theme and packages.list. Details: L2496–2554.
 
-**Test**: `tests/*.test.ts` with `node:test`, run by `vestra-plugin test`. `startPlugin(activate, { directory: new URL("..", import.meta.url) })` from `@vestra-player/sdk/testing` returns `{ host, stop }`; `host` is a TestHost (an in-memory player): `host.setSource(…)`, `host.command(id).run()`, `host.press(key)`, `await host.settle()`, then assert on `host.osd`, `host.window(id).props`… Guide: L1672–1860; TestHost: L9776.
+**Test**: `tests/*.test.ts` with `node:test`, run by `vestra-plugin test`. `startPlugin(activate, { directory: new URL("..", import.meta.url) })` from `@vestra-player/sdk/testing` returns `{ host, stop }`, `host` an in-memory player (TestHost): act (`host.command(id).run()`, `host.press(key)`), `await host.settle()`, assert on `host.osd`, `host.window(id).props`… Guide: L1869–2057; TestHost: L10902.
 
 **Command line**
 
@@ -106,40 +106,40 @@ export default async function activate(plugin: Plugin) {
 - `limit`: A player-wide limit was reached, a property value is over the limits of PropValue
 - `reserved`: The id is `vestra` or starts with `vestra.`
 - `versionMismatch`: The package needs a newer player or another `apiVersion`
-- Others: PluginError, llms-full.txt L3319.
+- Others: PluginError, llms-full.txt L3516.
 
 ## Reference
 
 - [llms-full.txt](https://vestrasys.github.io/vestra-player-sdk/llms-full.txt), also node_modules/@vestra-player/sdk/llms-full.txt; pages: [site](https://vestrasys.github.io/vestra-player-sdk/).
 - Tutorials: Getting started L9–237
 - Concepts: How a plugin runs L238–408; Commands, menus and key bindings L409–520; Playback state, controls and sources L521–666; Video and audio processing L667–745; Windows, panels, settings pages, dialogs and the OSD L746–1034
-- How-to: Keep a slider responsive while dragging L1035–1209; Remember a window's state between runs L1210–1339; Translate a plugin L1340–1523; Migrate a plugin to English source text L1524–1671; Test a plugin L1672–1860; Publish a plugin L1861–1949; Migrating off package rollback (1.5.16, removed in 1.5.17) L1950–2025
-- Guidelines: Interface guidelines L2026–2133; Menu guidelines L2134–2230
-- Reference: Manifest L2231–2298; Capabilities L2299–2357; Limits L2358–2472; Commands, menus and bindings L2473–2955; Platforms L2956–2984; Theme L2985–3206; Command line L3207–3264
-- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L3265–9552
-- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html): L9553–11761
+- How-to: Control playback L1035–1163; Store a plugin's data L1164–1231; Keep a slider responsive while dragging L1232–1406; Remember a window's state between runs L1407–1536; Translate a plugin L1537–1720; Migrate a plugin to English source text L1721–1868; Test a plugin L1869–2057; Publish a plugin L2058–2146; Migrating off package rollback (1.5.16, removed in 1.5.17) L2147–2222
+- Guidelines: Interface guidelines L2223–2330; Menu guidelines L2331–2427
+- Reference: Manifest L2428–2495; Capabilities L2496–2554; Limits L2555–2669; Commands, menus and bindings L2670–3152; Platforms L3153–3181; Theme L3182–3403; Command line L3404–3461
+- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L3462–10678
+- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html): L10679–12888
 
 ## API
 
 Where each `plugin.<module>` is declared:
 
-- Plugin L3568, Scope L3395, PluginError L3319, Disposable L3280
-- Commands L3928; Windows L4838; Panels L6257; Dialogs L6718; Player L7328; video: VideoFilter L7818, VideoView L7904, RenderOptions L7958; audio: AudioFilter L7855; Subtitles L8071; media: MediaCapture L8257; Resolvers L8428; Packages L8711; Osd L7683; Host L7557; Clipboard L8870; Power L8905; Tools L8938; Storage L9000; System L9117; Secrets L9151; window: MainWindow L6512; App L6624; Bindings L8828; Ui L4190; Timeline L6469; Drops L5531; Appearance L5585; I18n L5818; Settings L6101.
+- Plugin L3765, Scope L3592, PluginError L3516, Disposable L3477
+- Commands L4156; Windows L5093; Panels L6512; Dialogs L6973; Player L7714; video: VideoFilter L8594, VideoView L8680, RenderOptions L8734; audio: AudioFilter L8631; Subtitles L8847; media: MediaCapture L9033; Resolvers L9204; Packages L9487; Osd L8459; Host L8301; Clipboard L9646; Power L9733; Tools L9792; Storage L9944; System L10143; Secrets L10223; window: MainWindow L6767; App L6879; Bindings L9604; Ui L4445; Timeline L6724; Drops L5786; Appearance L5840; I18n L6073; Settings L6356.
 
 ## Examples
 
 Tested plugins in [examples/](https://github.com/vestrasys/vestra-player-sdk/tree/main/examples):
 
-- hello: The README Quick start: one menu command and an on-screen message. L12192–12281
-- blur: A tool window with one slider that blurs the playing video. L12282–12543
-- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L12544–12876
-- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L12877–13063
-- panel-menu: A sidebar panel with its own right-click menu. L13064–13272
-- menus: Radio menu items, separator groups and a menu item whose title changes. L13273–13432
-- theme-widgets: A tool window drawn with the player's theme and widgets. L13433–13596
-- markdown: A window that shows a Markdown document. L13597–13793
-- i18n: A plugin in the player's language: English source text, a Chinese translation. L13794–13961
+- hello: The README Quick start: one menu command and an on-screen message. L13319–13408
+- blur: A tool window with one slider that blurs the playing video. L13409–13670
+- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L13671–14003
+- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L14004–14190
+- panel-menu: A sidebar panel with its own right-click menu. L14191–14399
+- menus: Radio menu items, separator groups and a menu item whose title changes. L14400–14559
+- theme-widgets: A tool window drawn with the player's theme and widgets. L14560–14723
+- markdown: A window that shows a Markdown document. L14724–14920
+- i18n: A plugin in the player's language: English source text, a Chinese translation. L14921–15088
 
 ## Optional
 
-- [Changelog](https://github.com/vestrasys/vestra-player-sdk/blob/main/CHANGELOG.md); full doc comments: node_modules/@vestra-player/sdk/dist/plugin/{types,testing}.d.ts; Slint library: slint/vestra/.
+- [Changelog](https://github.com/vestrasys/vestra-player-sdk/blob/main/CHANGELOG.md); full doc comments in the package's dist/plugin/*.d.ts; Slint library in slint/vestra/.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vestra-player/sdk",
-  "version": "1.5.30",
+  "version": "1.5.31",
   "description": "Plugin API types, test host and plugin CLI for Vestra Player (apiVersion vestra/1)",
   "license": "Apache-2.0",
   "repository": {