@vestra-player/sdk 1.6.2 → 1.6.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.6.3
+
+**Who must change: nobody.** Documentation only: no change to the TypeScript API, the wire or `TestHost`, `apiVersion` stays `vestra/1`, no new capability, no player version needed.
+
+- **Examples name window handles after the window they name (its Slint file where there is one).** The API examples, guides, tutorials and example plugins no longer call a window handle `window`: `readmeWindow` for `ui/readme.slint`, `presetsWindow`, `thumbnailWindow`, `bookmarkWindow`, `blurWindow` and so on, in `plugin.windows.create(…)` and `host.window(…)` alike.
+
 ## 1.6.2
 
 **Who must change: nobody, but check `TestHost` tests of a full sidebar or of `keepsRunning` with a background tab.** No change to the TypeScript API or the wire, `apiVersion` stays `vestra/1`, no new capability, no player version needed. `TestHost` follows player 0.7.3: it no longer refuses a ninth sidebar tab, and `keepsRunning` lists a sidebar panel only while its tab is the current tab, as `"its sidebar tab is the current tab"`. A test that expected `conflict` for a ninth tab, or `"a mounted panel"` for a sidebar panel, now fails.

package/dist/plugin/testing.d.ts

@@ -115,7 +115,7 @@ type Call = {
  * import assert from "node:assert/strict";
  * declare const host: TestHost;
  * // ---cut---
- * await host.command("open-picture").run(); // the plugin calls window.show()
+ * await host.command("open-picture").run(); // the plugin calls pictureWindow.show()
  * const picture = host.window("picture");
  * assert.equal(picture.visible, true);
  * picture.emit("adjust", "brightness", 40); // fire a Slint callback
@@ -2746,11 +2746,11 @@ export declare class TestHost implements Transport {
      * declare const host: TestHost;
      * declare const expected: string;
      * // ---cut---
-     * const window = host.window("import");
-     * window.emit("load-file"); // the plugin reads and parses the file itself
-     * for (let i = 0; i < 100 && window.props["status-text"] !== expected; i++)
+     * const importWindow = host.window("import");
+     * importWindow.emit("load-file"); // the plugin reads and parses the file itself
+     * for (let i = 0; i < 100 && importWindow.props["status-text"] !== expected; i++)
      *   await host.settle(20);
-     * assert.equal(window.props["status-text"], expected);
+     * assert.equal(importWindow.props["status-text"], expected);
      * ```
      *
      * @capability None.

package/dist/plugin/testing.js

@@ -3479,11 +3479,11 @@ export class TestHost {
      * declare const host: TestHost;
      * declare const expected: string;
      * // ---cut---
-     * const window = host.window("import");
-     * window.emit("load-file"); // the plugin reads and parses the file itself
-     * for (let i = 0; i < 100 && window.props["status-text"] !== expected; i++)
+     * const importWindow = host.window("import");
+     * importWindow.emit("load-file"); // the plugin reads and parses the file itself
+     * for (let i = 0; i < 100 && importWindow.props["status-text"] !== expected; i++)
      *   await host.settle(20);
-     * assert.equal(window.props["status-text"], expected);
+     * assert.equal(importWindow.props["status-text"], expected);
      * ```
      *
      * @capability None.

package/dist/plugin/types.d.ts

@@ -367,10 +367,10 @@ export interface Scope extends Disposable {
      *       return;
      *     }
      *     live = plugin.scope();
-     *     const window = live.windows.create("ui/stats.slint");
+     *     const statsWindow = live.windows.create("ui/stats.slint");
      *     const timer = setInterval(() => live?.update(), 1000);
      *     live.onDispose(() => clearInterval(timer));
-     *     await window.show();
+     *     await statsWindow.show();
      *   },
      * });
      * ```
@@ -487,12 +487,12 @@ export interface Scope extends Disposable {
      * promise settles; state changed between the awaits of a long handler
      * shows only after an explicit `update()`.
      * ```ts
-     * declare const window: Window;
+     * declare const downloadWindow: Window;
      * declare function downloadPart(part: number): Promise<void>;
      * // ---cut---
      * let done = 0;
-     * window.bind(() => ({ progress: done }));
-     * window.on("start", async () => {
+     * downloadWindow.bind(() => ({ progress: done }));
+     * downloadWindow.on("start", async () => {
      *   for (let part = 0; part < 10; part++) {
      *     await downloadPart(part);
      *     done = part + 1;
@@ -1682,11 +1682,11 @@ export interface Ui {
      * calls `image()` again after rewriting it, because the SDK does not send
      * a value that did not change.
      * ```ts
-     * const window = plugin.windows.create("ui/thumbnail.slint");
+     * const thumbnailWindow = plugin.windows.create("ui/thumbnail.slint");
      * const file = `${plugin.dataDirectory}/thumbnail.png`;
      * // … write the PNG to `file` (for example with plugin.tools.run("ffmpeg", …)) …
-     * window.set({ thumbnail: plugin.ui.image(file) });
-     * await window.show();
+     * thumbnailWindow.set({ thumbnail: plugin.ui.image(file) });
+     * await thumbnailWindow.show();
      * ```
      *
      * @since 1.0.0
@@ -1850,11 +1850,11 @@ export interface Ui {
      * const response = await fetch(readmeUrl);
      * if (!response.ok) throw new Error(`README: HTTP ${response.status}`);
      * const text = await response.text();
-     * const window = plugin.windows.create("ui/readme.slint");
+     * const readmeWindow = plugin.windows.create("ui/readme.slint");
      * // Bound before the first `show`, as a tool window requires.
-     * window.on("openLink", (url: string) => plugin.system.openUrl(url));
-     * window.set({ doc: await plugin.ui.markdown(text, { base: readmeUrl }) });
-     * await window.show();
+     * readmeWindow.on("openLink", (url: string) => plugin.system.openUrl(url));
+     * readmeWindow.set({ doc: await plugin.ui.markdown(text, { base: readmeUrl }) });
+     * await readmeWindow.show();
      * ```
      *
      * @since 1.1.0
@@ -1999,10 +1999,10 @@ export interface View {
      * sends the value even though it equals the one sent before, which is
      * what pulls a control the user moved back to the plugin's value.
      * ```ts
-     * const window = plugin.windows.create("ui/presets.slint");
+     * const presetsWindow = plugin.windows.create("ui/presets.slint");
      * let presetIndex = 0;
-     * window.on("presetChosen", (index: number) => {
-     *   if (index > 2) window.set({ presetIndex }); // "Custom" is not a preset
+     * presetsWindow.on("presetChosen", (index: number) => {
+     *   if (index > 2) presetsWindow.set({ presetIndex }); // "Custom" is not a preset
      *   else presetIndex = index;
      * });
      * ```
@@ -2165,9 +2165,9 @@ export interface Window extends View, Disposable {
      * window; it rejects with a code, such as `host` for a Slint file that
      * does not compile or `unavailable` without a user interface.
      * ```ts
-     * const window = plugin.windows.create("ui/inspector.slint");
+     * const inspectorWindow = plugin.windows.create("ui/inspector.slint");
      * try {
-     *   await window.show();
+     *   await inspectorWindow.show();
      * } catch (error) {
      *   // The code is data; `message` has the details for the log.
      *   await plugin.osd.show("Cannot open the inspector ({})", [(error as PluginError).code]);
@@ -2276,8 +2276,8 @@ export interface Window extends View, Disposable {
      * store writes the change to `window.json` shortly after.
      * ```ts
      * const store = plugin.storage.json("window", { defaults: { open: false } });
-     * const window = plugin.windows.create("ui/notes.slint");
-     * window.onClose(() => store.save({ open: false }));
+     * const notesWindow = plugin.windows.create("ui/notes.slint");
+     * notesWindow.onClose(() => store.save({ open: false }));
      * ```
      *
      * @see [Remember a window's state between runs](../../docs/how-to/window-state.md)
@@ -5390,9 +5390,9 @@ export interface Stream extends Disposable {
      * connection; it resolves once both are closed.
      * ```ts
      * declare const stream: Stream;
-     * declare const window: Window;
+     * declare const generatorWindow: Window;
      * // ---cut---
-     * window.onClose(() => stream.stop());
+     * generatorWindow.onClose(() => stream.stop());
      * ```
      *
      * @since 1.0.0
@@ -9660,10 +9660,10 @@ export interface JsonStore<T> extends Disposable {
      * writes the file only once the user stops for 300 ms. Each `save`
      * replaces the value and restarts the debounce timer.
      * ```ts
-     * declare const window: Window;
+     * declare const volumeWindow: Window;
      * // ---cut---
      * const store = plugin.storage.json("prefs", { defaults: { volume: 100 } });
-     * window.on("volumeChanged", (volume: number) => store.save({ ...store.value, volume }));
+     * volumeWindow.on("volumeChanged", (volume: number) => store.save({ ...store.value, volume }));
      * ```
      *
      * @since 1.0.0

package/llms.txt

@@ -1,6 +1,6 @@
 # Vestra Player SDK
 
-> @vestra-player/sdk 1.6.2: 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/.
+> @vestra-player/sdk 1.6.3: 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/.
 
 ## Read the documentation
 

package/package.json

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