deck-plugin-sdk 1.10.0 → 1.10.1

package/package.json

@@ -1,60 +1,60 @@
-{
-  "name": "deck-plugin-sdk",
-  "version": "1.10.0",
-  "description": "Build a plugin for Deck, outside the Deck repository.",
-  "type": "module",
-  "license": "MIT",
-  "bin": {
-    "deck-plugin": "bin/deck-plugin.mjs"
-  },
-  "exports": {
-    "./build": "./build-plugin.mjs",
-    "./*": {
-      "types": "./shim/*.d.ts",
-      "default": "./shim/*.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "bin",
-    "shim",
-    "types",
-    "template",
-    "build-plugin.mjs",
-    "packages.mjs",
-    "README.md",
-    "permissions.json",
-    "publish.mjs",
-    "validate.mjs"
-  ],
-  "dependencies": {
-    "esbuild": "^0.28.0"
-  },
-  "peerDependencies": {
-    "@types/react": "^19.0.0",
-    "framer-motion": "^13.0.0",
-    "lucide-react": "^1.0.0",
-    "monaco-editor": "^0.56.0",
-    "react": "^19.0.0",
-    "typescript": "^5.0.0"
-  },
-  "peerDependenciesMeta": {
-    "framer-motion": {
-      "optional": true
-    },
-    "monaco-editor": {
-      "optional": true
-    },
-    "typescript": {
-      "optional": true
-    }
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "keywords": [
-    "deck",
-    "plugin",
-    "sdk"
-  ]
-}
+{
+  "name": "deck-plugin-sdk",
+  "version": "1.10.1",
+  "description": "Build a plugin for Deck, outside the Deck repository.",
+  "type": "module",
+  "license": "MIT",
+  "bin": {
+    "deck-plugin": "bin/deck-plugin.mjs"
+  },
+  "exports": {
+    "./build": "./build-plugin.mjs",
+    "./*": {
+      "types": "./shim/*.d.ts",
+      "default": "./shim/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "shim",
+    "types",
+    "template",
+    "build-plugin.mjs",
+    "packages.mjs",
+    "README.md",
+    "permissions.json",
+    "publish.mjs",
+    "validate.mjs"
+  ],
+  "dependencies": {
+    "esbuild": "^0.28.0"
+  },
+  "peerDependencies": {
+    "@types/react": "^19.0.0",
+    "framer-motion": "^13.0.0",
+    "lucide-react": "^1.0.0",
+    "monaco-editor": "^0.56.0",
+    "react": "^19.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "framer-motion": {
+      "optional": true
+    },
+    "monaco-editor": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "deck",
+    "plugin",
+    "sdk"
+  ]
+}

package/template/plugin.json

@@ -1,10 +1,10 @@
-{
-  "id": "__ID__",
-  "name": "__NAME__",
-  "description": "One line on what this is for, shown under its name in Settings.",
-  "icon": "Sparkles",
-  "color": "#a78bfa",
-  "version": "0.1.0",
-  "minDeck": "1.10.0",
-  "permissions": []
-}
+{
+  "id": "__ID__",
+  "name": "__NAME__",
+  "description": "One line on what this is for, shown under its name in Settings.",
+  "icon": "Sparkles",
+  "color": "#a78bfa",
+  "version": "0.1.0",
+  "minDeck": "1.10.1",
+  "permissions": []
+}

package/types/core/browser.d.ts

@@ -233,4 +233,5 @@ export declare const pageBox: (pane: string) => DOMRect | null;
 export declare const paneWindow: (pane: string) => Window;
 /** Close the pane's webview to give back its memory, keeping the tab and its address. */
 export declare function discardBrowserPane(pane: string): Promise<void>;
+export declare function picturePages(on: boolean): void;
 export declare function trackBrowser(pane: string, el: HTMLElement, url: string): () => void;

package/types/core/p2p.d.ts

@@ -1,117 +1,117 @@
-// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
-/** What can travel: anything JSON can carry. */
-export type Json = string | number | boolean | null | Json[] | {
-    [k: string]: Json;
-};
-/** Whether someone may change what is shared, or only watch. */
-export type Mode = "edit" | "view";
-/** Who may change things: a default for everyone, and a choice per person that wins over it. */
-export interface Roles {
-    def: Mode;
-    per: Record<string, Mode>;
-}
-/** Why a share ended for a joiner: the host stopped, vanished, removed this Deck, turned it away,
- *  or speaks another version. */
-export type Gone = "ended" | "lost" | "removed" | "denied" | "version";
-export interface Person {
-    id: string;
-    name: string; /** Round trip in ms, once measured. */
-    ms?: number;
-}
-/** What a share's bar and dialogs show. Replaced, never mutated, so React sees a change. */
-export interface ShareView {
-    /** Who is in and connected: on the host, everyone let in; on a joiner, the host and the others. */
-    peers: Person[];
-    /** On the host: who is asking to be let in. */
-    knocking: Person[];
-    /** On a joiner: the host is there but has not let this Deck in yet. */
-    waiting: boolean;
-    /** On a joiner: no host heard from for a while (wrong code, or a network that blocks it). */
-    stuck: boolean;
-    gone: Gone | null;
-    hostName: string;
-    /** A passing line: someone on another version, or whatever the plugin `say`s. */
-    note: string;
-    roles: Roles;
-    /** Whether this Deck may change things. */
-    canEdit: boolean;
-}
-export interface ShareOptions {
-    /** What the share is for, e.g. "canvas-share". Decks only meet others using the same one. */
-    app: string;
-    /** The share code, which names the room (see newCode). */
-    code: string;
-    /** Optional extra secret, needed with the code to connect at all. Sharing works without one. */
-    password?: string;
-    /** The plugin's message channel, at most 12 bytes (Trystero's cap). Defaults to "msg". */
-    channel?: string;
-    /** Whether this Deck is the one sharing. */
-    host: boolean;
-    /** Shown to the others: in the host's knock, on cursors, in the list of who is here. */
-    name: string;
-    /** The plugin's own protocol version. Decks on different versions do not share. */
-    version: number;
-    /** The host's default for who may change things. Joiners may until the host says otherwise. */
-    mode?: Mode;
-}
-export interface ShareHandlers<T> {
-    /** A plugin message, only ever from someone let in (and the host). Check `mayEdit(peer)` before
-     *  applying a change: a view-only person's edits are to be dropped by every Deck. */
-    message: (msg: T, peer: string) => void;
-    /** On the host: someone was just let in. Send them what they need to start, e.g. the board. */
-    welcome?: (peer: string) => void;
-    /** Someone left or was removed: forget what was kept for them (a cursor). */
-    left?: (peer: string) => void;
-}
-export interface P2pShare<T> {
-    readonly host: boolean;
-    /** Send a plugin message to everyone let in, or to one of them. Sends nothing before this Deck is
-     *  let in. Settles once handed to the connection, so awaiting it paces the sender. */
-    send(msg: T, to?: string): Promise<void>;
-    /** Whether a peer may change things: the host always, anyone else by the roles. */
-    mayEdit(peer: string): boolean;
-    /** The host: let someone in, or turn them away. */
-    allow(peer: string): void;
-    deny(peer: string): void;
-    /** The host: remove someone who was let in. They cannot come back with the same Deck. */
-    kick(peer: string): void;
-    /** The host: everyone's default, and one person's own choice (`null` follows the default). */
-    setDefault(mode: Mode): void;
-    setPerson(peer: string, mode: Mode | null): void;
-    /** Show a passing line in the view for a few seconds. */
-    say(note: string): void;
-    /** Leave. With `announce` (the host ending on purpose) everyone is told first, so they end at
-     *  once rather than when the connection times out. Safe to call twice. */
-    close(announce?: boolean): Promise<void>;
-    /** For useSyncExternalStore. */
-    subscribe(fn: () => void): () => void;
-    getView(): ShareView;
-}
-/** The part of a Trystero room a share uses: a seam, so the check can run a share without a network. */
-export interface RoomLike {
-    /** This Deck's id in the room; Trystero's own is `selfId()`. */
-    selfId?: string;
-    makeAction(name: string, config: {
-        onMessage: (data: any, ctx: {
-            peerId: string;
-        }) => void;
-    }): {
-        send(data: any, options?: {
-            target?: string | string[];
-        }): Promise<void>;
-    };
-    ping(peer: string): Promise<number>;
-    leave(): Promise<void>;
-    getPeers(): Record<string, unknown>;
-    onPeerJoin: ((peer: string) => void) | null;
-    onPeerLeave: ((peer: string) => void) | null;
-}
-/** This Deck's id in every share: the one the others know it by. The same for the whole session,
- *  so someone let in who rejoins after a dropped connection is let straight back in. */
-export declare function selfId(): string;
-/** Start sharing (`host`), or ask to join someone's share. */
-export declare function share<T extends Json>(opts: ShareOptions, on: ShareHandlers<T>, room?: RoomLike): P2pShare<T>;
-/** A share code: 16 random characters in four groups, easy to read out or paste. */
-export declare function newCode(random?: (n: number) => Uint8Array): string;
-/** A pasted code, tidied: spaces dropped, case folded. Empty when it is not a code. */
-export declare function cleanCode(text: string): string;
+// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
+/** What can travel: anything JSON can carry. */
+export type Json = string | number | boolean | null | Json[] | {
+    [k: string]: Json;
+};
+/** Whether someone may change what is shared, or only watch. */
+export type Mode = "edit" | "view";
+/** Who may change things: a default for everyone, and a choice per person that wins over it. */
+export interface Roles {
+    def: Mode;
+    per: Record<string, Mode>;
+}
+/** Why a share ended for a joiner: the host stopped, vanished, removed this Deck, turned it away,
+ *  or speaks another version. */
+export type Gone = "ended" | "lost" | "removed" | "denied" | "version";
+export interface Person {
+    id: string;
+    name: string; /** Round trip in ms, once measured. */
+    ms?: number;
+}
+/** What a share's bar and dialogs show. Replaced, never mutated, so React sees a change. */
+export interface ShareView {
+    /** Who is in and connected: on the host, everyone let in; on a joiner, the host and the others. */
+    peers: Person[];
+    /** On the host: who is asking to be let in. */
+    knocking: Person[];
+    /** On a joiner: the host is there but has not let this Deck in yet. */
+    waiting: boolean;
+    /** On a joiner: no host heard from for a while (wrong code, or a network that blocks it). */
+    stuck: boolean;
+    gone: Gone | null;
+    hostName: string;
+    /** A passing line: someone on another version, or whatever the plugin `say`s. */
+    note: string;
+    roles: Roles;
+    /** Whether this Deck may change things. */
+    canEdit: boolean;
+}
+export interface ShareOptions {
+    /** What the share is for, e.g. "canvas-share". Decks only meet others using the same one. */
+    app: string;
+    /** The share code, which names the room (see newCode). */
+    code: string;
+    /** Optional extra secret, needed with the code to connect at all. Sharing works without one. */
+    password?: string;
+    /** The plugin's message channel, at most 12 bytes (Trystero's cap). Defaults to "msg". */
+    channel?: string;
+    /** Whether this Deck is the one sharing. */
+    host: boolean;
+    /** Shown to the others: in the host's knock, on cursors, in the list of who is here. */
+    name: string;
+    /** The plugin's own protocol version. Decks on different versions do not share. */
+    version: number;
+    /** The host's default for who may change things. Joiners may until the host says otherwise. */
+    mode?: Mode;
+}
+export interface ShareHandlers<T> {
+    /** A plugin message, only ever from someone let in (and the host). Check `mayEdit(peer)` before
+     *  applying a change: a view-only person's edits are to be dropped by every Deck. */
+    message: (msg: T, peer: string) => void;
+    /** On the host: someone was just let in. Send them what they need to start, e.g. the board. */
+    welcome?: (peer: string) => void;
+    /** Someone left or was removed: forget what was kept for them (a cursor). */
+    left?: (peer: string) => void;
+}
+export interface P2pShare<T> {
+    readonly host: boolean;
+    /** Send a plugin message to everyone let in, or to one of them. Sends nothing before this Deck is
+     *  let in. Settles once handed to the connection, so awaiting it paces the sender. */
+    send(msg: T, to?: string): Promise<void>;
+    /** Whether a peer may change things: the host always, anyone else by the roles. */
+    mayEdit(peer: string): boolean;
+    /** The host: let someone in, or turn them away. */
+    allow(peer: string): void;
+    deny(peer: string): void;
+    /** The host: remove someone who was let in. They cannot come back with the same Deck. */
+    kick(peer: string): void;
+    /** The host: everyone's default, and one person's own choice (`null` follows the default). */
+    setDefault(mode: Mode): void;
+    setPerson(peer: string, mode: Mode | null): void;
+    /** Show a passing line in the view for a few seconds. */
+    say(note: string): void;
+    /** Leave. With `announce` (the host ending on purpose) everyone is told first, so they end at
+     *  once rather than when the connection times out. Safe to call twice. */
+    close(announce?: boolean): Promise<void>;
+    /** For useSyncExternalStore. */
+    subscribe(fn: () => void): () => void;
+    getView(): ShareView;
+}
+/** The part of a Trystero room a share uses: a seam, so the check can run a share without a network. */
+export interface RoomLike {
+    /** This Deck's id in the room; Trystero's own is `selfId()`. */
+    selfId?: string;
+    makeAction(name: string, config: {
+        onMessage: (data: any, ctx: {
+            peerId: string;
+        }) => void;
+    }): {
+        send(data: any, options?: {
+            target?: string | string[];
+        }): Promise<void>;
+    };
+    ping(peer: string): Promise<number>;
+    leave(): Promise<void>;
+    getPeers(): Record<string, unknown>;
+    onPeerJoin: ((peer: string) => void) | null;
+    onPeerLeave: ((peer: string) => void) | null;
+}
+/** This Deck's id in every share: the one the others know it by. The same for the whole session,
+ *  so someone let in who rejoins after a dropped connection is let straight back in. */
+export declare function selfId(): string;
+/** Start sharing (`host`), or ask to join someone's share. */
+export declare function share<T extends Json>(opts: ShareOptions, on: ShareHandlers<T>, room?: RoomLike): P2pShare<T>;
+/** A share code: 16 random characters in four groups, easy to read out or paste. */
+export declare function newCode(random?: (n: number) => Uint8Array): string;
+/** A pasted code, tidied: spaces dropped, case folded. Empty when it is not a code. */
+export declare function cleanCode(text: string): string;

package/types/core/settingsstore.d.ts

@@ -1,26 +1,26 @@
-// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
-import { type Settings } from "./bridge";
-/** Called by Settings after every write, so readers update without a reload. */
-export declare function publishSettings(s: Settings): void;
-/**
- * Write settings and apply everything that has to happen alongside the write.
- *
- * Settings' own persist() used to be the only path, so anything outside that module (the
- * command palette toggling relay, say) would have had to repeat five steps and would break
- * quietly when one of them changed. Settings still owns its local form state and calls this
- * for the shared half.
- */
-export declare function saveSettings(next: Settings): void;
-/** The zoom steps Ctrl+= and Ctrl+- move through, in percent, as a browser's do. */
-export declare const ZOOM_STEPS: number[];
-/**
- * Zoom the whole window: the webview's own zoom, the same as a browser's Ctrl+=, rather than CSS
- * `zoom`, which leaves xterm and Monaco measuring the mouse in unzoomed pixels.
- */
-export declare function applyZoom(pct: number | undefined): void;
-/** One step in or out from the current zoom, or back to 100% with dir 0. Saved like any setting. */
-export declare function stepZoom(dir: -1 | 0 | 1): void;
-/** Current settings for non-React callers (the palette's providers). */
-export declare const getSettings: () => Settings;
-export declare function userName(): Promise<string>;
-export declare function useSettings(): Settings;
+// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
+import { type Settings } from "./bridge";
+/** Called by Settings after every write, so readers update without a reload. */
+export declare function publishSettings(s: Settings): void;
+/**
+ * Write settings and apply everything that has to happen alongside the write.
+ *
+ * Settings' own persist() used to be the only path, so anything outside that module (the
+ * command palette toggling relay, say) would have had to repeat five steps and would break
+ * quietly when one of them changed. Settings still owns its local form state and calls this
+ * for the shared half.
+ */
+export declare function saveSettings(next: Settings): void;
+/** The zoom steps Ctrl+= and Ctrl+- move through, in percent, as a browser's do. */
+export declare const ZOOM_STEPS: number[];
+/**
+ * Zoom the whole window: the webview's own zoom, the same as a browser's Ctrl+=, rather than CSS
+ * `zoom`, which leaves xterm and Monaco measuring the mouse in unzoomed pixels.
+ */
+export declare function applyZoom(pct: number | undefined): void;
+/** One step in or out from the current zoom, or back to 100% with dir 0. Saved like any setting. */
+export declare function stepZoom(dir: -1 | 0 | 1): void;
+/** Current settings for non-React callers (the palette's providers). */
+export declare const getSettings: () => Settings;
+export declare function userName(): Promise<string>;
+export declare function useSettings(): Settings;