wings-plugin-sdk 0.7.0 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wings-plugin-sdk",
-  "version": "0.7.0",
+  "version": "0.9.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

@@ -11,6 +11,8 @@ interface WingsPane {
   /** What runs in the pane right now, like `zsh` or `claude`. */
   command: string;
   project: string;
+  /** The id of that project, the same as `project().id`. Needs Wings 0.1.22. */
+  projectId: string;
   /** Set while Claude Code runs in the pane. `startedAt` is when that `claude` started, in ms; a resumed session's transcript also has what came before. */
   session: { sessionId: string; name: string | null; state: string; startedAt: number } | null;
   /** The focused pane of the tab on screen. At most one pane has it, and none while no tab is open. */
@@ -98,6 +100,28 @@ interface WingsExecOptions {
   onOutput?: (line: string) => void;
 }
 
+/** A project (space) as pages see it. */
+interface WingsProject {
+  id: string;
+  name: string;
+  path: string;
+  branch: string | null;
+}
+
+/** A line in a plugin's section under a project in the sidebar. Needs Wings 0.1.23. */
+interface WingsProjectSectionRow {
+  /** Up to 64 characters, unique in the section. */
+  id: string;
+  /** Up to 120 characters. */
+  label: string;
+  /** Muted text under the label, up to 120 characters. */
+  detail?: string;
+  /** A small pill after the label. `text` is up to 24 characters. */
+  badge?: { text: string; tone?: Tone };
+  /** Clicking the row opens `view`, one of the plugin's `contributes.views` that lists `tab` in `opens`, as a tab in the row's project, with `args` (JSON, up to 16 KB) as `viewArgs()`. */
+  open: { view: string; args?: unknown };
+}
+
 interface Wings {
   // Every `on*` call returns a function that removes the listener, for cleaning up in a React effect.
   /** Every terminal pane, on every change. */
@@ -215,8 +239,47 @@ interface Wings {
    * in a window of its own or as a tab in the project on screen (`tab` needs Wings 0.1.15). `as` must be in the
    * view's `opens`, and defaults to the first. A window or tab that's already open comes to the front. The page
    * gets the same `wings` object wherever it opens.
+   *
+   * `args` (JSON, up to 16 KB, only with `as: "tab"`) is what the tab's page reads with `viewArgs`. A tab that's
+   * already open with other args takes the new ones, drops its saved tab state and reloads; a view with `"multiple": true` opens a new tab,
+   * unless a tab of it in that project already has the same `args`: that one is shown. Needs Wings 0.1.22.
+   */
+  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;
+  /** 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
+   * and never changes; any other page gets the project on screen. Needs Wings 0.1.22.
+   */
+  project(): Promise<WingsProject | null>;
+  /**
+   * Calls the listener with the current project, then each time it changes: the project on screen switched (not for a
+   * tab page), or its branch or name changed. Needs Wings 0.1.22.
+   */
+  onProject(listener: (project: WingsProject | null) => void): () => void;
+  /** Every project in Wings, in sidebar order. Worktrees are projects too. Needs Wings 0.1.23. */
+  projects(): Promise<WingsProject[]>;
+  /**
+   * Calls the listener with every project, then each time one is added, removed or renamed, or a branch changes.
+   * Works in the main script and in pages. Needs Wings 0.1.23.
+   */
+  onProjects(listener: (projects: WingsProject[]) => void): () => void;
+  /**
+   * Shows `rows` under a project in the sidebar, in the section `sectionId` that the manifest declares in
+   * `contributes.projectSections`, or removes the section with `null`. Up to 50 rows. Rejects for a project that isn't
+   * there, a section the plugin didn't declare, or a row whose `open.view` isn't one of its views that opens as a tab.
+   * Sections are kept in memory and go when the plugin is turned off, so fill them again on start. Needs Wings 0.1.23.
+   */
+  setProjectSection(projectId: string, sectionId: string, rows: WingsProjectSectionRow[] | null): Promise<void>;
+  /** In a tab page: the state it last saved with `setTabState`, or `null`. Outside a tab it is `null`. Opening the tab with new `args` clears it. Needs Wings 0.1.22. */
+  tabState<T = unknown>(): Promise<T | null>;
+  /**
+   * In a tab page: saves JSON state, up to 64 KB, on the tab. Wings keeps it across restarts and while the page is
+   * unloaded. Rejects outside a tab or when the state is too big. Needs Wings 0.1.22.
    */
-  openView(id: string, options?: { as?: "sidebar" | "modal" | "window" | "tab" }): Promise<void>;
+  setTabState(state: unknown): Promise<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. */