deck-plugin-sdk 1.15.2 → 1.16.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deck-plugin-sdk",
-  "version": "1.15.2",
+  "version": "1.16.1",
   "description": "Build a plugin for Deck, outside the Deck repository.",
   "type": "module",
   "license": "MIT",

package/shim/terminals.js

@@ -33,7 +33,6 @@ export const getInstance = (...a) => t().getInstance(...a);
 export const getLayout = (...a) => t().getLayout(...a);
 export const hasSelection = (...a) => t().hasSelection(...a);
 export const insertBeside = (...a) => t().insertBeside(...a);
-export const isPinned = (...a) => t().isPinned(...a);
 export const isWorkspaceActive = (...a) => t().isWorkspaceActive(...a);
 export const leafIds = (...a) => t().leafIds(...a);
 export const leaveGroup = (...a) => t().leaveGroup(...a);
@@ -91,11 +90,9 @@ export const termSpawn = (...a) => t().termSpawn(...a);
 export const termSweepScrollback = (...a) => t().termSweepScrollback(...a);
 export const termWrite = (...a) => t().termWrite(...a);
 export const toggleGroupFold = (...a) => t().toggleGroupFold(...a);
-export const togglePin = (...a) => t().togglePin(...a);
 export const ungroup = (...a) => t().ungroup(...a);
 export const useAgentPanesVersion = (...a) => t().useAgentPanesVersion(...a);
 export const useLayout = (...a) => t().useLayout(...a);
-export const usePinnedPanes = (...a) => t().usePinnedPanes(...a);
 export const webglLimit = (...a) => t().webglLimit(...a);
 export const workspaceByCwd = (...a) => t().workspaceByCwd(...a);
 export const workspaceShellCount = (...a) => t().workspaceShellCount(...a);

package/template/plugin.json

@@ -5,6 +5,6 @@
   "icon": "Sparkles",
   "color": "#a78bfa",
   "version": "0.1.0",
-  "minDeck": "1.15.2",
+  "minDeck": "1.16.1",
   "permissions": []
 }

package/types/core/bridge.d.ts

@@ -12,8 +12,9 @@ export interface PhysRect {
     h: number;
 }
 /** Open `url` in the browser pane's own webview (created the first time) at `r`. A private one
- *  keeps no cookies, history or cache. */
-export declare const browserOpen: (pane: string, url: string, isPrivate: boolean, r: PhysRect, window?: string) => Promise<void>;
+ *  keeps no cookies, history or cache. A webview it already has goes to `url` only with `go` (sent
+ *  there); shown again, a page keeps what it is doing. */
+export declare const browserOpen: (pane: string, url: string, isPrivate: boolean, r: PhysRect, window?: string, go?: boolean) => Promise<void>;
 /** Move the pane's webview, or hide it. */
 export declare const browserBounds: (pane: string, r: PhysRect, visible: boolean, window?: string) => Promise<void>;
 export declare const browserNav: (pane: string, action: "back" | "forward" | "reload" | "go" | "focus", url?: string) => Promise<void>;
@@ -316,6 +317,11 @@ export interface Settings {
     askBeforeClose?: "running" | "always" | "never";
     /** The workspace sidebar is a button in the title bar that opens it over the panes, rather than a column. */
     sidebarMenu?: boolean;
+    /** Which dock of pinned panes takes the corner between them: the right one full height (unset),
+     *  or the bottom one full width (modules/terminals/Dock.tsx). */
+    dockCorner?: "right" | "bottom";
+    /** The docks show every project's pinned panes (unset), or only the active project's. */
+    dockScope?: "all" | "project";
     /** Pane controls float over the pane's top-right corner on hover, instead of a header row. */
     floatingPaneControls: boolean;
     /** Per notification kind, whether it shows as a card, in the bell, with a sound, and as a Windows

package/types/core/browser/browser.d.ts

@@ -148,12 +148,7 @@ export declare function browserInFloat(url: string, where: {
     beside?: string;
     focus?: boolean;
 }, isPrivate?: boolean): void;
-/** Read once, before the first browser pane asks. */
-export declare const loadPanes: () => Promise<void>;
-/** The page a pane was on when Deck last closed. */
-export declare const savedPage: (pane: string) => string | undefined;
-/** The page a pane should open on, as a restarted Deck reopens one: a closed tab reopened. */
-export declare function seedPage(pane: string, url: string): void;
+export { loadPanes, savedPage, savedLook, seedPage, subscribePanes } from "./browserpanes";
 /** How Ctrl+Shift+B shows or hides the bookmarks bar: set by the browser pane, which holds the settings. */
 export declare const setBarToggle: (f: () => void) => void;
 /** Bookmark the pane's page, as its star does: Ctrl+D, and the browser menu. */

package/types/core/browser/browserpanes.d.ts

@@ -0,0 +1,24 @@
+// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
+/** The title and icon a pane's page had. An icon past this length (a big data: address) is not kept. */
+export interface PageLook {
+    title?: string;
+    icon?: string;
+}
+/** Read once, before the first browser pane asks. */
+export declare const loadPanes: () => Promise<void>;
+/** Told once the kept pages have been read: a tab waiting on its page's title. */
+export declare const subscribePanes: (f: () => void) => () => void;
+/** The page a pane was on when Deck last closed. */
+export declare const savedPage: (pane: string) => string | undefined;
+/** The title and icon that page had, for its tab until it loads. The same object until it changes. */
+export declare const savedLook: (pane: string) => PageLook | undefined;
+export declare function rememberPane(pane: string, s: {
+    url: string;
+    home: boolean;
+    private: boolean;
+    title: string;
+    favicon: string;
+} | undefined): void;
+/** The page a pane should open on, as a restarted Deck reopens one: a closed tab reopened. */
+export declare function seedPage(pane: string, url: string): void;
+export declare function forgetPane(pane: string): void;

package/types/core/workspaces/dock.d.ts

@@ -0,0 +1,55 @@
+// GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
+import { type Layout, type LayoutTab, type LayoutWorkspace } from "./layout";
+export type DockSide = "right" | "bottom";
+export declare const DOCK_SIDES: readonly DockSide[];
+/** The `window` of a tab in each dock. */
+export declare const DOCK_WINDOW: Record<DockSide, string>;
+export declare const isDock: (win?: string) => boolean;
+export declare const sideOf: (win: string) => DockSide;
+export interface DockState {
+    /** Shown rather than folded to its strip of buttons. Absent means open. */
+    open?: boolean;
+    /** The right dock's width, the bottom one's height, in px. */
+    size?: number;
+    /** The docked tab it shows; absent or gone, the first one. */
+    shown?: string;
+}
+export type Docks = Partial<Record<DockSide, DockState>>;
+export declare const setDockScope: (onlyActive: boolean) => void;
+/** The tabs in one dock, or in either, with the workspace each belongs to, in workspace order. */
+export declare function dockTabs(l: Layout | null, side?: DockSide): {
+    ws: LayoutWorkspace;
+    tab: LayoutTab;
+}[];
+/** The tabs a dock shows: `dockTabs`, only the active project's while the docks are per project. */
+export declare function shownDockTabs(l: Layout | null, side: DockSide): {
+    ws: LayoutWorkspace;
+    tab: LayoutTab;
+}[];
+/** The docks show tab `tabId`'s project: per project, that one comes to the front. */
+export declare const withProjectOf: (l: Layout, tabId: string) => Layout;
+/** The dock pane `paneId` is in, if it is in one. */
+export declare function dockOf(paneId: string): DockSide | undefined;
+export declare function setDock(side: DockSide, patch: DockState): void;
+/**
+ * Pin a pane to a dock. The only pane of its tab takes the tab with it; one pane of a split leaves
+ * the split and gets a docked tab of its own, which remembers the tab it came from (`from`) to go
+ * back to. The pane keeps its id, so a terminal keeps its shell and a tool its state. A pane in the
+ * other dock moves across.
+ */
+export declare function pinPane(paneId: string, side?: DockSide): void;
+/** Tab `tabId`, all its panes, into a dock: from a zone, a floating window or the other dock. */
+export declare function pinTab(tabId: string, side: DockSide): void;
+/** Docked tab `tabId`, all its panes, into the other dock. */
+export declare function moveDocked(tabId: string, side: DockSide): void;
+/**
+ * Take docked tab `tabId` out of its dock: beside the panes of the tab it came from when that tab
+ * is still there, else as a tab in the zone in front, never a zone of its own (the zone it left may
+ * be gone, or its cell taken). Either way its workspace comes to the front showing it, so you see
+ * where it went.
+ */
+export declare function unpinTab(tabId: string): void;
+/** Unpin whichever docked tab holds pane `paneId`. */
+export declare function unpinPane(paneId: string): void;
+/** Both docks folded when either is open, else both open. */
+export declare function toggleDocks(): void;

package/types/core/workspaces/layout.d.ts

@@ -1,5 +1,6 @@
 // GENERATED by sdk/gen-types.mjs from Deck's source — do not edit.
 import { TabGroup } from "./zones";
+import type { Docks } from "./dock";
 export type SplitDir = "h" | "v";
 export type LayoutNode = {
     kind: "leaf";
@@ -52,6 +53,9 @@ export interface LayoutTab {
     /** Pinned from its menu (tabops.ts): only its icon, before the unpinned tabs beside it, and left
      *  open by Close others, Close to the right and Close all. */
     pinned?: true;
+    /** In a dock (`window` "dock" or "dock-bottom", core/workspaces/dock.ts) as one pane taken out of a split: the
+     *  tab it came from, which unpinning puts it back beside. */
+    from?: string;
 }
 export interface LayoutWorkspace {
     id: string;
@@ -79,6 +83,8 @@ export interface Layout {
     workspaces: LayoutWorkspace[];
     activeWs: string;
     floats?: FloatBounds[];
+    /** The two docks of panes kept in view across workspaces (core/workspaces/dock.ts). */
+    dock?: Docks;
 }
 export declare let currentLayout: Layout | null;
 export declare const layoutSubs: Set<() => void>;
@@ -94,8 +100,10 @@ export declare let loadPromise: Promise<void> | null;
 export declare let liveAtLoad: Set<string> | null;
 export declare function loadLayoutOnce(): Promise<void>;
 /**
- * What every layout write leaves true of a workspace: its active tab is one the main window draws
- * (a tab in a floating window is not; going to one leaves the main window on a neighbour), its zone
+ * What every layout write leaves true of a workspace: the main window has a tab of it to draw (its
+ * last one closed with the rest in floating windows or docks, a fresh terminal), its active tab is
+ * one the main window draws (a tab in a floating window or a dock is not; going to one leaves the
+ * main window on a neighbour), its zone
  * shows it (showActiveTab), a folded group holding it opens (openActiveGroup), and a tab group
  * whose last tab went goes with it (pruneGroups).
  */

package/types/core/workspaces/terminals.d.ts

@@ -247,6 +247,3 @@ export declare function restartPane(id: string, cwd: string): Promise<void>;
  */
 export declare function suspendWorkspace(wsId: string): Promise<number>;
 export declare function destroy(id: string): void;
-export declare function usePinnedPanes(): string[];
-export declare const isPinned: (id: string) => boolean;
-export declare function togglePin(id: string): void;