@vestra-player/sdk 1.5.48 → 1.5.50

package/dist/plugin/runtime.d.ts

@@ -37,6 +37,15 @@ export type Change = ReadonlyMap<string, ReadonlySet<string>>;
  * without `update()`) still shows within about this long.
  */
 export declare const SAFETY_PASS_MS = 1000;
+/** How the plugin is run: the player's runner, or `TestHost`. */
+export interface RuntimeOptions {
+    /**
+     * A declaration the player refuses during activation fails activation
+     * (`startPlugin`, so a plugin's tests show it) instead of being logged,
+     * reported to `onError` and skipped (the player's runner).
+     */
+    strictDeclarations?: boolean;
+}
 export declare const same: (a: Json | undefined, b: Json | undefined) => boolean;
 /** One value in flight, only the newest waiting. Each push learns its fate. */
 export declare class Latest<T> {
@@ -74,7 +83,7 @@ export declare class Runtime {
      * property writes). Not part of the plugin API; empty for older players.
      */
     readonly features: ReadonlySet<string>;
-    constructor(transport: Transport, manifest: PluginManifest, directory: string, dataDirectory?: string, app?: unknown);
+    constructor(transport: Transport, manifest: PluginManifest, directory: string, dataDirectory?: string, app?: unknown, options?: RuntimeOptions);
     can(capability: string): boolean;
     /** Lazily created singletons shared by every scope of this plugin. */
     service<T>(name: string, create: () => T): T;
@@ -83,6 +92,16 @@ export declare class Runtime {
      * plugin reports ready; later ones report failures to their scope.
      */
     starting<T>(work: Promise<T>, report: (error: unknown) => void): Promise<T>;
+    /**
+     * A declaration the player checks on its own (`what`: "command x"),
+     * started like `starting`. In the player's runner a refusal of it during
+     * activation (`invalid`, `conflict`, `limit`) does not fail the plugin:
+     * it is logged, skipped and reported to the scope once activation
+     * completes, so an `onError` added anywhere in `activate` hears it (SDK
+     * 1.5.49; VS Code logs a bad contribution and activates the extension).
+     * Under `strictDeclarations` (TestHost) it fails activation as before.
+     */
+    declaring<T>(work: Promise<T>, what: string, report: (error: unknown) => void): Promise<T>;
     activated(): Promise<void>;
     bind(evaluate: () => void): Disposable;
     /**

package/dist/plugin/runtime.js

@@ -86,6 +86,16 @@ function merge(into, from) {
  * without `update()`) still shows within about this long.
  */
 export const SAFETY_PASS_MS = 1000;
+/**
+ * The player's answers to a declaration that refuse that one declaration
+ * (a command's path, texts or count): during activation they skip it
+ * instead of failing the plugin (`Runtime.declaring`, SDK 1.5.49).
+ */
+const DECLARATION_REFUSALS = new Set([
+    "invalid",
+    "conflict",
+    "limit",
+]);
 export const same = (a, b) => JSON.stringify(a) === JSON.stringify(b);
 /** One value in flight, only the newest waiting. Each push learns its fate. */
 export class Latest {
@@ -149,6 +159,10 @@ export class Runtime {
     /** Registrations that activation must wait for before reporting ready. */
     startup = new Set();
     #activating = true;
+    /** `RuntimeOptions.strictDeclarations`. */
+    #strict;
+    /** Declarations skipped during activation: reported once it completes. */
+    #refusals = [];
     #transport;
     /** Each binding with the events whose state it read last time (held). */
     #bindings = new Map();
@@ -187,8 +201,9 @@ export class Runtime {
      * property writes). Not part of the plugin API; empty for older players.
      */
     features;
-    constructor(transport, manifest, directory, dataDirectory, app) {
+    constructor(transport, manifest, directory, dataDirectory, app, options = {}) {
         this.#transport = transport;
+        this.#strict = options.strictDeclarations ?? false;
         this.dataDirectory = dataDirectory;
         this.local = transport.local;
         this.host = createWire(transport);
@@ -233,6 +248,32 @@ export class Runtime {
         work.catch(() => { });
         return work;
     }
+    /**
+     * A declaration the player checks on its own (`what`: "command x"),
+     * started like `starting`. In the player's runner a refusal of it during
+     * activation (`invalid`, `conflict`, `limit`) does not fail the plugin:
+     * it is logged, skipped and reported to the scope once activation
+     * completes, so an `onError` added anywhere in `activate` hears it (SDK
+     * 1.5.49; VS Code logs a bad contribution and activates the extension).
+     * Under `strictDeclarations` (TestHost) it fails activation as before.
+     */
+    declaring(work, what, report) {
+        if (!this.#activating || this.#strict)
+            return this.starting(work, report);
+        const settled = work.then(() => { }, (error) => {
+            if (!(error instanceof HostError) ||
+                !DECLARATION_REFUSALS.has(error.code))
+                throw error;
+            console.error(`[${this.manifest.id}] ${what} skipped, the player refused it (${error.code}): ${error.message}`);
+            this.#refusals.push(() => report(error));
+        });
+        // Observed now: `activated()` may come after `activate` awaits, and
+        // its `allSettled` still sees the rejection.
+        settled.catch(() => { });
+        this.startup.add(settled);
+        work.catch(() => { });
+        return work;
+    }
     async activated() {
         while (this.startup.size) {
             const pending = [...this.startup];
@@ -242,6 +283,8 @@ export class Runtime {
                     throw result.reason;
         }
         this.#activating = false;
+        for (const report of this.#refusals.splice(0))
+            report();
     }
     bind(evaluate) {
         const held = new Map();

package/dist/plugin/testing.d.ts

@@ -2728,8 +2728,11 @@ export declare class TestHost implements Transport {
  *
  * Rejects when `manifest.json` cannot be read or parsed, when `activate`
  * throws, or when a registration made during activation fails (for example
- * `limit`, `conflict`, `invalid`), which is when the player would fail the
- * activation.
+ * `limit`, `conflict`, `invalid`). Stricter than the player's runner for
+ * commands (SDK 1.5.49): there the SDK logs a command declaration the
+ * player refuses during activation, skips it and activates the rest of the
+ * plugin (`onError` hears it); `startPlugin` fails, so a test shows the
+ * bad declaration.
  *
  * @param activate - The plugin's default-exported `activate` function.
  * @param options - Where the plugin lives and how to start it.

package/dist/plugin/testing.js

@@ -3956,14 +3956,23 @@ export class TestHost {
                     !BAR_BUTTON_ICONS.includes(icon))
                     throw commandInvalid(`unknown button icon ${JSON.stringify(icon)}: a name of @vestra/icons.slint (${BAR_BUTTON_ICONS.join(", ")}) or an image from plugin.ui.image`);
             }
+            // The binding table's `Table::canonical` (player 0.6.1): each binding
+            // parsed, and each input once, compared parsed, before the reason,
+            // conflicts and limits.
             const bindings = (declaration.bindings ?? []);
-            for (const binding of bindings)
+            const seen = new Set();
+            for (const binding of bindings.map(String)) {
+                let input;
                 try {
-                    canonical(String(binding));
+                    input = canonical(binding);
                 }
                 catch (error) {
                     throw commandInvalid(error.message);
                 }
+                if (seen.has(input))
+                    throw commandInvalid(`binding ${binding} is listed twice`);
+                seen.add(input);
+            }
             if (reason !== null)
                 commandText(reason, "reason", COMMAND_LIMITS.reasonBytes);
             if (this.commands.has(id))
@@ -3991,13 +4000,6 @@ export class TestHost {
                 this.commands.size + this.coreCommands.size + hostOnly.length >=
                     COMMAND_LIMITS.total)
                 throw new HostError("limit", "command registry limit reached");
-            // The binding table: each input once per command.
-            const seen = new Set();
-            for (const binding of bindings.map(String)) {
-                if (seen.has(binding))
-                    throw new HostError("invalid", `binding ${binding} is listed twice`);
-                seen.add(binding);
-            }
             const host = this;
             let sent = p.state;
             this.commands.set(id, {
@@ -5426,8 +5428,11 @@ function tellResidency(host) {
  *
  * Rejects when `manifest.json` cannot be read or parsed, when `activate`
  * throws, or when a registration made during activation fails (for example
- * `limit`, `conflict`, `invalid`), which is when the player would fail the
- * activation.
+ * `limit`, `conflict`, `invalid`). Stricter than the player's runner for
+ * commands (SDK 1.5.49): there the SDK logs a command declaration the
+ * player refuses during activation, skips it and activates the rest of the
+ * plugin (`onError` hears it); `startPlugin` fails, so a test shows the
+ * bad declaration.
  *
  * @param activate - The plugin's default-exported `activate` function.
  * @param options - Where the plugin lives and how to start it.
@@ -5512,7 +5517,10 @@ export async function startPlugin(activate, options = {}) {
     const instance = await createPlugin(host, manifest, directory, data, 
     // Like the player: protocol additions it takes (`app.features` set on
     // the host replaces them, e.g. `[]` for an older player's behaviour).
-    { features: [PATCH_FEATURE], ...host.app });
+    { features: [PATCH_FEATURE], ...host.app }, 
+    // Unlike the player's runner, which logs a refused command declaration
+    // and activates the rest: a plugin's tests show the refusal.
+    { strictDeclarations: true });
     await activate(instance.plugin);
     // Like the player: a position or resolver another plugin holds is not an
     // activation failure.

package/dist/plugin/types.d.ts

@@ -487,7 +487,11 @@ export interface Scope extends Disposable {
  * Registrations started during activation (commands, panels, resolvers,
  * subscriptions) do not need to be awaited: the plugin is reported ready
  * once they all succeed, and activation fails if `activate` throws or any
- * of them fails. The entry module must **default-export** `activate`.
+ * of them fails. A command declaration the player refuses is the exception
+ * (SDK 1.5.49): the SDK logs and skips it, its `ready` rejects and
+ * {@link Scope.onError} hears it, the rest of the plugin activates
+ * (`startPlugin` still fails on it). The entry module must
+ * **default-export** `activate`.
  *
  * Stopping: the player first revokes everything the plugin owns on its side
  * (menus, windows, panels, filters, subtitle layers, snapshots, jobs,
@@ -1138,8 +1142,21 @@ export interface Command extends Disposable {
      * Resolves when the host has registered the command. Rejects with
      * `conflict` (path already taken), `invalid` or `limit` (more than 160
      * commands in this plugin, or 1024 in the whole player). You rarely need
-     * to await it: during activation a failure fails activation, later it
-     * goes to {@link Scope.onError}.
+     * to await it: the refusal goes to {@link Scope.onError}. During
+     * activation the SDK, in the plugin's process, logs the refusal with the
+     * command id and the player's message, skips the command and lets the
+     * rest of the plugin activate (SDK 1.5.49; before, the refusal failed
+     * activation); the error reaches `onError` once activation completes,
+     * so a listener added anywhere in `activate` hears it. `startPlugin`
+     * stays strict: there a refusal during activation fails it, so tests
+     * show the bad declaration. Any other failure during activation
+     * (`capability`, no answer) fails activation.
+     *
+     * Only the player's answer is skipped. What {@link Commands.add} checks
+     * itself still throws from `add` (an unknown `@` menu id, more than 8
+     * path segments, an `order` out of range, a malformed binding or one
+     * listed twice, a bad `button`, a reason text of the wrong shape, an id
+     * already declared), and fails activation unless the plugin catches it.
      *
      * @throws `conflict` (rejects) Another command already has this menu path,
      *   or the path would be both a menu item and a submenu.
@@ -1161,8 +1178,9 @@ export interface Command extends Disposable {
  * when the user picks the item, presses a key or clicks the button.
  * Commands of all plugins merge into the player's menus by their English
  * path keys. Registration is asynchronous: `add` returns at once, and
- * {@link Command.ready} reports the player's answer (during activation a
- * refusal fails activation).
+ * {@link Command.ready} reports the player's answer (during activation
+ * the SDK logs a refusal and skips that command, SDK 1.5.49;
+ * `startPlugin` fails on it). What `add` checks itself throws from `add`.
  *
  * @capability commands
  *

package/llms.txt

@@ -1,148 +1,42 @@
 # Vestra Player SDK
 
-> @vestra-player/sdk 1.5.48: 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 (the player's built-in plugins share one). 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.50: 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. The documentation is a tree of short pages read by path, like `go doc`: the same pages and API as https://vestrasys.github.io/vestra-player-sdk/.
 
-**Rules**
+## Read the documentation
 
-- **Only the public SDK.** Import `@vestra-player/sdk` with `import type` only (a runtime import fails `vestra-plugin build`) and `@vestra-player/sdk/testing` only in tests.
-- **No other plugins.** Do not import another plugin's code, read its directory or data directory, or talk to it privately (shared files, sockets, messages).
-- **No system commands.** Do not run `open`, `sips`, `plutil`, `security`, `cmd`, `powershell` or similar.
-- **macOS and Windows.** The same code runs on both: build paths with `node:path`, write package paths with `/`, and handle `unsupported` where a method documents a platform difference.
-- **Your own id.** `<owner>.<name>`, where the owner is your GitHub user or organization.
+- **Command line** (any coding agent): `npx -p @vestra-player/sdk vestra-plugin docs [path] [--page N]` prints one node of the tree; `npx -p @vestra-player/sdk vestra-plugin docs --search <words>` lists the matching paths. In a project that depends on the SDK, `npx vestra-plugin docs` is enough.
+- **In a Node.js program**: `import { docs, searchDocs } from "@vestra-player/sdk/docs"`; `docs(path, { page })` and `searchDocs(query, { page })` return the same text.
+- **Paths**: `/` lists the top level; every answer lists the paths one level down with a one-line summary. `/API/<category>/<symbol>/<member>` is one declaration with its signature, parameters, return value, errors, capability, player version and examples, for example `/API/Media/Snapshot/dispose`. `/Guides/<group>/<page>` is a page of the site, for example `/Guides/How-to/Test a plugin` (the file name works too: `/Guides/How-to/testing`). Case, spaces and punctuation do not matter, the leading `/` is optional, `.` works like `/`, a name alone finds its declaration (`TestHost`, `Snapshot.export`, `plugin.player`), and `#heading` opens the page of a long answer that has that section.
+- **Size**: every answer is at most 8 KB; a longer one ends with the number of its next page (`--page 2`).
+- **Before writing code**, read `/Guides/Tutorials/Getting started` and `/Guides/Guidelines`, then the API of what you use. Test with `/Guides/How-to/Test a plugin`.
 
-**Files**
+## Top level
 
-```text
-my-plugin/
-  manifest.json        identity and capabilities
-  main.ts              the entry module
-  ui/hello.slint       optional: user interface
-  tests/main.test.ts   tests (node:test)
-  package.json         dev dependency and scripts
-```
+- `/Overview`: The package's README: what the SDK is, installing it and where to start.
+- `/Guides`: The documentation pages, by group: tutorials, how-to guides, reference, explanation, guidelines, examples, upgrading.
+- `/API`: Every type and value of @vestra-player/sdk (the plugin API), @vestra-player/sdk/testing (the test host) and @vestra-player/sdk/docs (this tree), by category.
 
-**manifest.json**
+## Guides
 
-```json
-{
-  "id": "me.hello",
-  "version": "0.1.0",
-  "apiVersion": "vestra/1",
-  "entry": "main.ts",
-  "capabilities": ["commands", "ui.osd", "playback.read", "events"]
-}
-```
-
-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: L2218–2292.
-
-**main.ts**
-
-```ts
-import type { Plugin } from "@vestra-player/sdk";
-
-export default async function activate(plugin: Plugin) {
-  plugin.commands.add({
-    id: "hello",
-    path: ["Tools", "Hello"],
-    run: () => plugin.osd.show("Hello"),
-  });
-}
-```
-
-**Capabilities** (without one a call fails: `capability`)
-
-- `producer.av`: Player.openStream (also `playback.control`)
-- `playback.read`: Player.state/refresh/stats/chapters/audioDevices, Timeline.marks
-- `playback.control`: Player.open/setPaused/seek/setRate/restart/close/scrub/setOutput/provideSequence/next/previous/addAudioTrack/selectAudioTrack/step/setStepSeek/setLoop/setAudioDevice, Power.preventSleep
-- `source.resolve`: Resolvers.add
-- `events`: Player/Subtitles/Timeline/MainWindow/Appearance/PanelSlot/Panel/BackdropSlot.onChange, Resolvers.onFileTypesChange
-- `commands`: Commands.add, Host.run
-- `ui.window`: Windows.create
-- `ui.mount`: Panels.mount/bottom/sidebar/backdrop, PanelSlot/Panel/BackdropSlot.onChange
-- `ui.dialog`: Dialogs.confirm/openFile/openFiles/openDirectory/saveFile
-- `plugins.manage`: Packages.validate/validateArchive/setEnabled/reload/uninstall
-- `processing.video`: Plugin.video.filter/video.view/video.render/video.shaders (also `playback.read`)
-- `processing.audio`: Plugin.audio.filter (also `playback.read`, `events`)
-- `subtitles.read`: Subtitles.state/onChange/refresh
-- `subtitles.control`: Subtitles.select/load/remove/setStyle
-- `media.read`: MediaCapture.capture, Snapshot.export (also `media.control`)
-- `media.control`: MediaCapture.capture, Snapshot.export (also `media.read`)
-- `ui.osd`: Osd.show/panel
-- `clipboard`: Clipboard.readText/writeText/writeImage
-- `window.control`: MainWindow.setVideoArea/setAlwaysOnTop/setCursorAutoHide/setPictureInPicture
-- `bindings.manage`: Bindings.list/set/reset/onChange
-- `timeline.marks`: Timeline.layer
-- `ui.drop`: Drops.provide, Panel.onDrop
-- `ui.settings`: Settings.page/show
-- `ui.theme`: Appearance.set/setLanguage
-- `secrets`: Secrets.get/set/delete
-- `rendering.manage`: Rendering.setPreference/restartPlayer
-- `video.upscaling`: VideoUpscaling.state/set/onChange
-- No capability: `tools`, `storage`, `system`, `app`, `ui` (images and Markdown), `i18n`, reading window.state, appearance.theme, packages.list and rendering.state. Details: L2293–2353.
-
-**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: L1861–2021; TestHost: L15502.
-
-**Command line**
-
-- `vestra-plugin check`: strict type check of the plugin's .ts files and tests/*.ts
-- `vestra-plugin build`: check, then write dist/
-- `vestra-plugin test`: node --test on tests/*.test.{ts,mjs}
-- `vestra-plugin pack`: build, then dist/ → <out>/<id>-<version>.vxp
-- `vestra-plugin i18n extract`: find the texts to translate, write locales/messages.pot and merge it into every locales/<lang>.po
-- `vestra-plugin i18n check`: coverage per language, placeholder and plural problems, a stale messages.pot
-- `vestra-player --plugin <dir>` runs a plugin from source, no build needed.
-
-**Error codes** (`error.code`; branch on it, never on `message`)
-
-- `stale`: A condition no longer held
-- `capability`: The manifest does not declare the capability the call needs
-- `invalid`: A bad argument
-- `missing`: The target does not exist
-- `busy`: The player is still doing a previous call of the same kind
-- `conflict`: Another plugin owns the resource
-- `unavailable`: Not possible right now
-- `unsupported`: Not possible on this system, build or source
-- `failed`: The operation ran and failed
-- `aborted`: An `AbortSignal` fired
-- `timeout`: A time limit ran out
-- `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
-- Others: PluginError, llms-full.txt L5966.
-
-## 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–134; Add a window L135–213; Add settings and translations L214–367; Test, check, pack and publish L368–424; Write your own blur kernel L425–685
-- How-to: Control playback L686–854; Store a plugin's data L855–961; Load subtitles from a plugin L962–1074; Keep a slider responsive while dragging L1075–1262; Remember a window's state between runs L1263–1414; Offer a GPU rendering switch L1415–1540; Keep a command's state without keeping the plugin running L1541–1697; Translate a plugin L1698–1860; Test a plugin L1861–2021; Publish a plugin L2022–2123; Troubleshooting L2124–2217
-- Reference: Manifest L2218–2292; Capabilities L2293–2353; Limits L2354–2506; Commands, menus and bindings L2507–3033; Platforms L3034–3064; Theme L3065–3414; Command line L3415–3472; Error codes L3473–3520; Translations L3521–3613; Test host L3614–3800
-- Explanation: How a plugin runs L3801–4003; Commands, menus and key bindings L4004–4158; Playback state, controls and sources L4159–4318; Video and audio processing L4319–4439; Windows, panels, settings pages, dialogs and the OSD L4440–4704; GPU and software rendering L4705–4721; The player's Rust core L4722–5063; How the player runs and talks to plugins L5064–5403
-- Guidelines: Plugin rules L5404–5415; Interface guidelines L5416–5532; Menu guidelines L5533–5591
-- Upgrading: Migrate a plugin to English source text L5592–5741; Migrating off package rollback (1.5.16, removed in 1.5.17) L5742–5819; Who must change, release by release L5820–5888
-- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L5889–15175
-- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html): L15176–18059
+- `/Guides/Tutorials`: Step-by-step lessons; the first four build one plugin, from an empty folder to a tested package in the plugin store.
+- `/Guides/How-to`: Short guides that each answer one practical question about writing, translating, testing or publishing a plugin.
+- `/Guides/Reference`: Lookup tables that span many symbols (capabilities, manifest fields and player versions, limits, menu and binding names, platform differences, theme, command line), generated from the SDK's code.
+- `/Guides/Explanation`: What each part of the player and its plugins is, why it works the way it does and how the parts fit together.
+- `/Guides/Guidelines`: The rules a plugin follows so that its windows, panels, messages and menu items look and behave like the rest of Vestra Player.
+- `/Guides/Examples`: Complete, tested example plugins with a screenshot each and a step-by-step walkthrough of their code.
+- `/Guides/Upgrading`: What to change in a plugin when an SDK or player release deprecates, removes or changes something it uses.
 
 ## API
 
-Where each `plugin.<module>` is declared:
-
-- Plugin L6305, Scope L6041, PluginError L5966, Disposable L5904
-- Commands L6900; When L6492; Windows L7847; Panels L9293; Dialogs L9963; Player L10704; video: VideoFilter L11584, VideoView L11684, RenderOptions L11771, VideoShaders L11849, VideoUpscaling L12207; audio: AudioFilter L11629; Subtitles L12443; media: MediaCapture L12847; Resolvers L13077; Packages L13479; Osd L11449; Host L11291; Clipboard L13808; Power L13895; Tools L13954; Storage L14106; System L14305; Secrets L14385; window: MainWindow L9610; App L9790; Rendering L14648; Bindings L13707; Ui L7193; Timeline L9522; Drops L8540; Appearance L8621; I18n L8854; Settings L9137.
-
-## 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. L18494–18589
-- blur: A tool window with one slider that blurs the playing video. L18590–18857
-- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L18858–19196
-- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L19197–19389
-- panel-menu: A sidebar panel with its own right-click menu. L19390–19604
-- menus: Radio menu items, separator groups and a menu item whose title changes. L19605–19770
-- theme-widgets: A tool window drawn with the player's theme and widgets. L19771–19940
-- markdown: A window that shows a Markdown document. L19941–20143
-- i18n: A plugin in the player's language: English source text, a Chinese translation. L20144–20317
-
-## Optional
-
-- [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/.
+- `/API/Commands`: 15 entries: CommandState, Bindable, Condition, When, MenuId, BarButtonIcon, CommandButton, CommandOptions, Command, Commands, HostAction, Host, BindingRef, BindingInfo, Bindings
+- `/API/Media`: 6 entries: CaptureOptions, Snapshot, ExportOptions, JobState, ExportJob, MediaCapture
+- `/API/Packages`: 10 entries: PackageManifest, PackageSource, InstallOptions, PackageCandidate, PackageChangeStatus, PackageChange, PluginInfo, PluginDisplay, PluginWarning, Packages
+- `/API/Playback`: 18 entries: MarkKind, TimelineMark, TimelineLayer, Timeline, AudioTrack, PlayerState, AudioDevice, Chapter, Conditional, Media, Scrub, StreamFrame, StreamOptions, StreamStartError, Stream,…
+- `/API/Plugin`: 11 entries: Disposable, PluginError, Scope, Plugin, WindowState, MainWindow, AppInfo, App, SystemInfo, DisplayInfo, Json
+- `/API/Processing`: 18 entries: FilterStatus, VideoFilter, AudioFilter, ViewSettings, VideoView, RenderSettings, RenderOptions, VideoShaders, UpscalingReasonCode, UpscalingReason, UpscalingDecodingCause,…
+- `/API/Services`: 15 entries: Clipboard, Power, ToolResult, Tools, JsonStore, Storage, SessionStorage, System, Secrets, RenderingMode, RenderingPreference, RenderingReasonCode, RenderingReason, RenderingState,…
+- `/API/Sources`: 7 entries: ResolverOptions, WebResolverOptions, FileResolverOptions, ResolvedStream, Resolver, Resolvers, ResolvedMedia
+- `/API/Subtitles`: 5 entries: SubtitleTrack, SubtitlesState, SubtitleConditional, Subtitles, SubtitleStyle
+- `/API/UI`: 42 entries: ImageRef, ImageOptions, MarkdownRef, MarkdownOptions, PropValue, PropData, Props, Ui, View, Window, Windows, SlotState, SlotPanel, PanelState, PanelSlot, SidebarSlot, Panel,…
+- `/API/Testing`: 32 entries: CapabilityInfo, CAPABILITY_INFO, MESSAGE_LIMIT, COMMAND_LIMITS, MENU_IDS, BAR_BUTTON_ICONS, BAR_BUTTON_LIMITS, BuiltinSubmenu, BUILTIN_SUBMENUS, BuiltinCommand, BUILTIN_COMMANDS, LOCALES,…
+- `/API/Docs`: 4 entries: DOCS_PAGE_BYTES, DocsOptions, docs, searchDocs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vestra-player/sdk",
-  "version": "1.5.48",
+  "version": "1.5.50",
   "description": "Plugin API types, test host and plugin CLI for Vestra Player (apiVersion vestra/1)",
   "license": "Apache-2.0",
   "repository": {
@@ -24,12 +24,15 @@
       "types": "./dist/player-runtime.d.ts",
       "default": "./dist/player-runtime.js"
     },
+    "./docs": {
+      "types": "./dist/docs.d.ts",
+      "default": "./dist/docs.js"
+    },
     "./ts-plugin": {
       "types": "./ts-plugin/index.d.ts",
       "default": "./ts-plugin/index.js"
     },
     "./llms.txt": "./llms.txt",
-    "./llms-full.txt": "./llms-full.txt",
     "./package.json": "./package.json"
   },
   "bin": {
@@ -43,8 +46,7 @@
     "README.md",
     "CHANGELOG.md",
     "LICENSE",
-    "llms.txt",
-    "llms-full.txt"
+    "llms.txt"
   ],
   "scripts": {
     "build": "node scripts/build.mjs",