@vestra-player/sdk 1.5.8 → 1.5.11

package/llms.txt

@@ -1,6 +1,6 @@
 # Vestra Player SDK
 
-> @vestra-player/sdk 1.5.8: 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. llms-full.txt, next to this file, has every declaration, the guides and the examples; L<n> below are its line numbers.
+> @vestra-player/sdk 1.5.11: 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. llms-full.txt, next to this file, has every declaration, the guides and the examples; L<n> below are its line numbers.
 
 **How plugins run**
 
@@ -120,6 +120,8 @@ test("shows the position", async () => {
 - `vestra-plugin test [dir...]`: Runs `node --test` on `tests/*.test.{ts,mjs}`.
 - `vestra-plugin build [dir...] [--version x.y.z]`: Writes `dist/`: types stripped, files copied, manifest versioned.
 - `vestra-plugin pack [dir...] [--version x.y.z] [--out dir]`: Builds, then packs `dist/` as `<id>-<version>.vxp`.
+- `vestra-plugin i18n extract [dir...] [--locale lang]`: Collects the texts to translate into `locales/`, keeping translations.
+- `vestra-plugin i18n check [dir...]`: Translation coverage and untranslatable text (warnings only).
 - `vestra-player --plugin <dir>` runs a plugin from source, no build needed.
 
 **Error codes** (`error.code`; branch on it, never on `message`)
@@ -135,7 +137,7 @@ test("shows the position", async () => {
 - `failed`: The operation ran and failed
 - `aborted`: An `AbortSignal` fired
 - `timeout`: A time limit ran out
-- `limit`: A player-wide limit was reached
+- `limit`: A player-wide limit was reached, a property value is over the limits of PropValue, or a request is longer than the player's 1 MiB message
 - `reserved`: Packages.validate, PackageCandidate.install: the id is `vestra` or starts with `vestra.`, which only the player's built-in plugins use
 - `versionMismatch`: The package needs a newer player or another `apiVersion`
 - `ui-prepare`: The player could not prepare a mounted panel or a settings page
@@ -150,54 +152,56 @@ test("shows the position", async () => {
 - [Concept: Windows, panels, settings pages, dialogs and the OSD](https://vestrasys.github.io/vestra-player-sdk/documents/Windows__panels__settings_pages__dialogs_and_the_OSD.html): L281–626
 - [How-to: Keep a slider responsive while dragging](https://vestrasys.github.io/vestra-player-sdk/documents/Keep_a_slider_responsive_while_dragging.html): L627–801
 - [How-to: Remember a window's state between runs](https://vestrasys.github.io/vestra-player-sdk/documents/Remember_a_window_s_state_between_runs.html): L802–931
-- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L932–4173
-- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html) (TestHost, startPlugin): L4174–5120
+- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L932–4427
+- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html) (TestHost, startPlugin): L4428–5537
 
 ## API
 
 Where each module of `plugin` is declared:
 
-- Plugin L1151, Scope L1022, PluginError L974, Disposable L947
-- plugin.commands: Commands L1347
-- plugin.windows: Windows L1552
-- plugin.panels: Panels L2003
-- plugin.dialogs: Dialogs L2285
-- plugin.player: Player L2724
-- plugin.video: VideoFilter L2973, VideoView L3036, RenderOptions L3078
-- plugin.audio: AudioFilter L2997
-- plugin.subtitles: Subtitles L3176
-- plugin.media: MediaCapture L3334
-- plugin.resolvers: Resolvers L3439
-- plugin.packages: Packages L3657
-- plugin.osd: Osd L2910
-- plugin.host: Host L2873
-- plugin.clipboard: Clipboard L3770
-- plugin.power: Power L3790
-- plugin.tools: Tools L3823
-- plugin.storage: Storage L3866
-- plugin.system: System L3889
-- plugin.secrets: Secrets L3907
-- plugin.window: MainWindow L2126
-- plugin.app: App L2207
-- plugin.bindings: Bindings L3740
-- plugin.ui: Ui L1439
-- plugin.timeline: Timeline L2083
-- plugin.drops: Drops L1849
-- plugin.appearance: Appearance L1878
-- plugin.settings: Settings L1936
+- Plugin L1153, Scope L1022, PluginError L974, Disposable L947
+- plugin.commands: Commands L1361
+- plugin.windows: Windows L1566
+- plugin.panels: Panels L2207
+- plugin.dialogs: Dialogs L2493
+- plugin.player: Player L2934
+- plugin.video: VideoFilter L3199, VideoView L3262, RenderOptions L3304
+- plugin.audio: AudioFilter L3223
+- plugin.subtitles: Subtitles L3402
+- plugin.media: MediaCapture L3562
+- plugin.resolvers: Resolvers L3667
+- plugin.packages: Packages L3907
+- plugin.osd: Osd L3135
+- plugin.host: Host L3083
+- plugin.clipboard: Clipboard L4024
+- plugin.power: Power L4044
+- plugin.tools: Tools L4077
+- plugin.storage: Storage L4120
+- plugin.system: System L4143
+- plugin.secrets: Secrets L4161
+- plugin.window: MainWindow L2330
+- plugin.app: App L2411
+- plugin.bindings: Bindings L3994
+- plugin.ui: Ui L1453
+- plugin.timeline: Timeline L2287
+- plugin.drops: Drops L1863
+- plugin.appearance: Appearance L1892
+- plugin.i18n: I18n L2034
+- plugin.settings: Settings L2140
 
 ## Examples
 
 Complete plugins with tests, in [examples/](https://github.com/vestrasys/vestra-player-sdk/tree/main/examples) and in llms-full.txt:
 
-- hello: The README Quick start: one menu command and an on-screen message. L5534–5623
-- blur: A tool window with one slider that blurs the playing video. L5624–5885
-- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L5886–6218
-- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L6219–6403
-- panel-menu: A sidebar panel with its own right-click menu. L6404–6609
-- menus: Radio menu items, separator groups and a menu item whose title changes. L6610–6769
-- theme-widgets: A tool window drawn with the player's theme and widgets. L6770–6933
-- markdown: A window that shows a Markdown document. L6934–7127
+- hello: The README Quick start: one menu command and an on-screen message. L5954–6043
+- blur: A tool window with one slider that blurs the playing video. L6044–6305
+- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L6306–6638
+- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L6639–6823
+- panel-menu: A sidebar panel with its own right-click menu. L6824–7029
+- menus: Radio menu items, separator groups and a menu item whose title changes. L7030–7189
+- theme-widgets: A tool window drawn with the player's theme and widgets. L7190–7353
+- markdown: A window that shows a Markdown document. L7354–7547
+- i18n: A plugin in the player's language: English source text, a Chinese translation. L7548–7715
 
 ## Optional
 

package/package.json

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

package/slint/vestra/markdown.slint

@@ -7,7 +7,7 @@
 // `MarkdownView` scrolls one document. `MarkdownBlocks` does not scroll and
 // is as tall as its content: put it in your own layout or in a `ListView`
 // row (a chat message: a `[MarkdownBlock]` field of the row's struct).
-// `code-copy: true` adds a 复制 button to code blocks that reports
+// `code-copy: true` adds a Copy button to code blocks that reports
 // `copy-code(code)`; the plugin copies it (`plugin.clipboard`).
 import { ScrollView } from "std-widgets.slint";
 import { Theme } from "theme.slint";
@@ -139,7 +139,7 @@ component MarkdownBlockView {
                     border-radius: Theme.radius-control;
                     background: copy-touch.pressed ? Theme.button-press : copy-touch.has-hover ? Theme.button-hover : Theme.button-bg;
                     copy-label := Text {
-                        text: "复制";
+                        text: @tr("Copy");
                         color: copy-touch.has-hover ? Theme.text : Theme.text-dim;
                         font-size: Theme.font-body;
                         vertical-alignment: center;
@@ -160,7 +160,7 @@ component MarkdownBlockView {
                 }
             }
             if block.kind == "image" && !block.has-image: Text {
-                text: block.alt == "" ? "[图片]" : "[图片] " + block.alt;
+                text: block.alt == "" ? @tr("[Image]") : @tr("[Image] {}", block.alt);
                 color: Theme.text-dim;
                 font-size: Theme.font-body;
                 wrap: word-wrap;
@@ -214,7 +214,7 @@ component MarkdownBlockView {
 // Markdown blocks without scrolling, as tall as their content.
 export component MarkdownBlocks inherits Rectangle {
     in property <[MarkdownBlock]> blocks;
-    // A 复制 button on code blocks, reporting `copy-code(code)`.
+    // A Copy button on code blocks, reporting `copy-code(code)`.
     in property <bool> code-copy: false;
     callback link-clicked(string);
     callback copy-code(string);
@@ -239,7 +239,7 @@ export component MarkdownView inherits Rectangle {
     in property <[MarkdownBlock]> blocks;
     // Space around the document.
     in property <length> inset: 10px;
-    // A 复制 button on code blocks, reporting `copy-code(code)`.
+    // A Copy button on code blocks, reporting `copy-code(code)`.
     in property <bool> code-copy: false;
     callback link-clicked(string);
     callback copy-code(string);

package/slint/vestra/widgets.slint

@@ -183,14 +183,14 @@ export component Slider {
     }
 }
 
-// Link input (UI-DLG-02): a multi-line input and [打开] [取消]. Enter or the
-// confirm button accepts (Shift+Enter starts a new line), Esc or 取消 cancels.
+// Link input (UI-DLG-02): a multi-line input and [Open] [Cancel]. Enter or the
+// confirm button accepts (Shift+Enter starts a new line), Esc or Cancel cancels.
 // No validation here: the plugin checks the address.
 export component UrlInputRow {
     in-out property <string> text;
     in property <string> placeholder;
-    in property <string> confirm-text: "打开";
-    in property <string> cancel-text: "取消";
+    in property <string> confirm-text: @tr("Open");
+    in property <string> cancel-text: @tr("Cancel");
     in property <bool> enabled: true;
     callback accepted(string);
     callback cancelled();