wings-plugin-sdk 0.6.0 → 0.7.0

package/README.md

@@ -55,6 +55,12 @@ to fill. Every `wings.on*` call returns a function that removes the listener, so
 `wings-plugin-sdk/react`, or your own `useEffect`, cleans up when a component goes. The API reference is
 [plugins/README.md](https://github.com/josippapez/Wings/blob/main/plugins/README.md) in the Wings repo.
 
+## Polling
+
+Wings is often in the background, and a timer that runs `git` or a network call then costs battery for nothing.
+`pollWhileFocused(tick, ms)` from `wings-plugin-sdk/poll` runs `tick` every `ms` only while a Wings window is in
+front, and once at once when you come back. It uses `wings.onFocus`.
+
 ## Pack
 
 A plugin in its own repo doesn't need to commit what it builds. `wings-plugin pack` builds it into a temporary

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wings-plugin-sdk",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "The wings API types, the page frame, React hooks and the build command for Wings plugins.",
   "license": "MIT",
   "type": "module",
@@ -17,6 +17,10 @@
       "types": "./shell.d.ts",
       "default": "./shell.js"
     },
+    "./poll": {
+      "types": "./poll.d.ts",
+      "default": "./poll.js"
+    },
     "./build": {
       "types": "./build.d.ts",
       "default": "./build.mjs"
@@ -34,6 +38,8 @@
     "react.d.ts",
     "shell.js",
     "shell.d.ts",
+    "poll.js",
+    "poll.d.ts",
     "build.mjs",
     "build.d.ts",
     "bin.mjs",

package/poll.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="./wings.d.ts" />
+/**
+ * Calls `tick` every `ms` while Wings is focused. When Wings loses focus the timer stops; when it regains focus,
+ * `tick` runs once at once and the timer starts again. `tick` is not called for the state Wings starts in, so
+ * a plugin keeps doing its own first check. Returns a function that stops everything.
+ */
+export function pollWhileFocused(tick: () => void, ms: number, w?: Pick<Wings, "focused" | "onFocus">): () => void;

package/poll.js

@@ -0,0 +1,28 @@
+// A timer that runs only while the user is in Wings.
+
+/**
+ * Calls `tick` every `ms` while Wings is focused. When Wings loses focus the timer stops; when it regains focus,
+ * `tick` runs once at once and the timer starts again. `tick` is not called for the state Wings starts in, so
+ * a plugin keeps doing its own first check. Returns a function that stops everything.
+ */
+export function pollWhileFocused(tick, ms, w = globalThis.wings) {
+  let timer;
+  let wasFocused = w.focused;
+  const start = () => (timer ??= setInterval(tick, ms));
+  const stop = () => {
+    clearInterval(timer);
+    timer = undefined;
+  };
+  if (wasFocused) start();
+  const off = w.onFocus(({ focused }) => {
+    if (focused === wasFocused) return;
+    wasFocused = focused;
+    if (!focused) return stop();
+    tick();
+    start();
+  });
+  return () => {
+    off();
+    stop();
+  };
+}

package/wings.d.ts

@@ -102,6 +102,14 @@ 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. */
   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 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;
+  /** The state `onFocus` last reported. True until Wings says otherwise, which it does as soon as the frame is ready. */
+  readonly focused: boolean;
   /**
    * A badge action was clicked. Return a promise: the button spins until it settles (up to 5 min), and a thrown
    * error shows in the card. What it resolves to is ignored.
@@ -154,7 +162,7 @@ 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; 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[] }): 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>;
   /**