wings-plugin-sdk 0.9.0 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wings-plugin-sdk",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "The wings API types, the page frame, React hooks and the build command for Wings plugins.",
   "license": "MIT",
   "type": "module",

package/wings.d.ts

@@ -41,6 +41,14 @@ interface WingsBadge {
   actions?: { id: string; label: string; primary?: boolean }[];
 }
 
+/** Where the diff viewer scrolls to and highlights once the patch is shown. A path or line the patch doesn't have just opens the diff. */
+interface WingsDiffFocus {
+  path: string;
+  line?: number;
+  /** `new` (the default) counts lines after the change, `old` before it. */
+  side?: "old" | "new";
+}
+
 interface WingsComment {
   id: number;
   replyTo: number | null;
@@ -128,7 +136,8 @@ interface Wings {
   onPanes(listener: (panes: WingsPane[]) => void): () => void;
   /**
    * Whether the user is in Wings: true while any Wings window (the main one or a view window) is in front, false
-   * while another app is. Called once with the current state, then on each change. Needs no permission. Pause timers
+   * while another app is. In a block on a Project page it is also false while the block is out of view or its tab is hidden.
+   * Called once with the current state, then on each change. Needs no permission. Pause timers
    * while it is false and check once when it turns true, or use `pollWhileFocused` from `wings-plugin-sdk/poll`.
    */
   onFocus(listener: (event: { focused: boolean }) => void): () => void;
@@ -144,7 +153,7 @@ interface Wings {
    * is sent back as a failed call. `paneId` is the Wings pane Claude runs in, or `null`. Register it in `main`.
    */
   onTool(name: string, handler: (input: Record<string, unknown>, context: { paneId: string | null }) => unknown): void;
-  /** Runs a command from `permissions.exec`, like `git branch --show-current`. */
+  /** Runs a command from `permissions.exec`, like `git branch --show-current`. Rejects with `Output is larger than 8 MB` (and kills the program) when stdout or stderr passes 8 MB. */
   exec(program: string, args?: string[], options?: WingsExecOptions): Promise<{ code: number | null; stdout: string; stderr: string }>;
   /**
    * Needs `permissions.statusline`. What Claude Code last told its status line, once `wings statusline` is your
@@ -186,9 +195,9 @@ interface Wings {
   /** Needs `permissions.notify`. A desktop notification, up to 3 a minute. The title is cut at 64 characters, the body at 256. */
   notify(notification: { title: string; body?: string }): Promise<void>;
   /** Needs `"diff"` in `contributes.ui`. Leave out `patch` to open it loading, then call `updateDiff`. */
-  openDiff(diff: { title: string; subtitle?: string; /** The repo or folder the diff is of, so Send to agent offers the agent working there first. */ cwd?: string; patch?: string; comments?: WingsComment[] }): Promise<{ id: string }>;
+  openDiff(diff: { title: string; subtitle?: string; /** The repo or folder the diff is of, so Send to agent offers the agent working there first. */ cwd?: string; patch?: string; comments?: WingsComment[]; focus?: WingsDiffFocus }): Promise<{ id: string }>;
   /** Updates a viewer opened with `openDiff`; ignored once it's closed. `{ comments }` alone keeps the patch, like after a reply. */
-  updateDiff(id: string, update: { patch: string; comments?: WingsComment[] } | { comments: WingsComment[] } | { error: string }): Promise<void>;
+  updateDiff(id: string, update: { patch: string; comments?: WingsComment[]; focus?: WingsDiffFocus } | { comments: WingsComment[]; focus?: WingsDiffFocus } | { error: string }): Promise<void>;
   /**
    * Needs `"diff"` in `contributes.ui`. A reply typed under a comment with `canReply` in the diff viewer. Post it,
    * then add it with `updateDiff`. The reply box waits for the returned promise, and a thrown error shows under it
@@ -197,7 +206,8 @@ interface Wings {
   onReply(handler: (reply: WingsReply) => unknown): void;
   /**
    * POSTs `fields` (string or whole-number values, up to 64 KB) as JSON to a `permissions.post` path, as you:
-   * `gh api`, `glab api` against `host`, or `az rest` for Azure DevOps. Wings builds the command itself.
+   * `gh api` (against `host` for a GitHub Enterprise Server), `glab api` against `host`, or `az rest` for Azure
+   * DevOps. Wings builds the command itself. A manifest entry may pin a field, like `{event=APPROVE}`.
    */
   post(
     program: "gh" | "glab" | "az",
@@ -206,7 +216,8 @@ interface Wings {
     options?: { host?: string },
   ): Promise<{ code: number | null; stdout: string; stderr: string }>;
   /**
-   * An HTTP request to a URL under `permissions.fetch`, made by Wings. `bearer` names a secret that Wings sends
+   * An HTTP request to a URL under `permissions.fetch`, made by Wings. An entry may be `GET <prefix>`, or
+   * `POST <url with * segments>` (optionally `{field=value}`) for one write with a JSON `body`. `bearer` names a secret that Wings sends
    * as `Authorization: Bearer <secret>`. Resolves for any status; redirects aren't followed.
    */
   fetch(
@@ -246,11 +257,11 @@ interface Wings {
    */
   openView(id: string, options?: { as?: "sidebar" | "modal" | "window" | "tab"; args?: unknown }): Promise<void>;
   /** Where this page shows. `null` in the plugin's main script. Needs Wings 0.1.22. */
-  placement(): "sidebar" | "tab" | "modal" | "window" | null;
+  placement(): "sidebar" | "tab" | "modal" | "window" | "block" | null;
   /** What `openView` passed as `args` when it opened this tab, or `null`. Available at once. Needs Wings 0.1.22. */
   viewArgs<T = unknown>(): T | null;
   /**
-   * The project this page is about, or `null` when none is open. A tab page's project is the one the tab belongs to
+   * The project this page is about, or `null` when none is open. A tab page's or block's project is the one it belongs to
    * and never changes; any other page gets the project on screen. Needs Wings 0.1.22.
    */
   project(): Promise<WingsProject | null>;
@@ -280,6 +291,23 @@ interface Wings {
    * unloaded. Rejects outside a tab or when the state is too big. Needs Wings 0.1.22.
    */
   setTabState(state: unknown): Promise<void>;
+  /**
+   * In a block on a Project page, `contributes.blocks`: the state it last saved with `setBlockState`, or `null`. Outside a
+   * block it is `null`. Needs Wings 0.1.24.
+   */
+  blockState<T = unknown>(): Promise<T | null>;
+  /**
+   * In a block: saves JSON state, up to 16 KB, on the block, like which board or filter it shows. Wings keeps it with the
+   * Project page across restarts and while the block is unloaded. Rejects outside a block or when the state is too big.
+   * Needs Wings 0.1.24.
+   */
+  setBlockState(state: unknown): Promise<void>;
+  /**
+   * In a block: asks for a height in CSS pixels. Wings rounds it and clamps it to the block's `minHeight` (default 160)
+   * up to 1200, and applies it without reloading the page. Call it when the content's height changes: asking for the
+   * height already asked for does nothing, and calls in the same tick send only the last. Throws outside a block. Needs Wings 0.1.24.
+   */
+  setHeight(px: number): void;
   /** Closes a sidebar or view wherever it's open. */
   closeView(id: string): Promise<void>;
   /** Opens Wings Settings at the plugin's settings page, `contributes.settings`. Wings 0.1.15 and newer. */