@gtkx/testing 0.20.0 → 1.0.0-rc.1

package/dist/screenshot.js

@@ -1,45 +1,43 @@
-import { createRef } from "@gtkx/ffi";
-import * as Gsk from "@gtkx/ffi/gsk";
-import * as Gtk from "@gtkx/ffi/gtk";
-import { tick } from "./timing.js";
+import { existsSync, mkdirSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import * as Gsk from "@gtkx/gi/gsk";
+import * as Gtk from "@gtkx/gi/gtk";
 import { waitFor } from "./wait-for.js";
 const bytesToBase64 = (bytes) => {
     return Buffer.from(bytes).toString("base64");
 };
-const DEFAULT_SCREENSHOT_TIMEOUT = 100;
 const DEFAULT_SCREENSHOT_INTERVAL = 10;
-const captureSnapshot = (widget) => {
-    const paintable = new Gtk.WidgetPaintable(widget);
+const describeWidgetState = (widget) => `realized=${widget.getRealized()} mapped=${widget.getMapped()} visible=${widget.getVisible()}`;
+const captureSnapshot = (widget, scale) => {
+    const paintable = new Gtk.WidgetPaintable({ widget });
     const width = paintable.getIntrinsicWidth();
     const height = paintable.getIntrinsicHeight();
     if (width <= 0 || height <= 0) {
-        throw new Error("Widget has no size - ensure it is realized and visible");
+        throw new Error(`Widget has no size: ensure it is realized and visible (${describeWidgetState(widget)})`);
     }
     const snapshot = new Gtk.Snapshot();
+    snapshot.scale(scale, scale);
     paintable.snapshot(snapshot, width, height);
     const renderNode = snapshot.toNode();
     if (!renderNode) {
-        throw new Error("Widget produced no render content");
+        throw new Error(`Widget produced no render content (${describeWidgetState(widget)})`);
     }
     const display = widget.getDisplay();
-    if (!display) {
-        throw new Error("Widget has no display - ensure it is realized");
-    }
     const renderer = new Gsk.CairoRenderer();
     renderer.realizeForDisplay(display);
     try {
-        const texture = renderer.renderTexture(renderNode);
+        const texture = renderer.renderTexture(renderNode, null);
         const pngBytes = texture.saveToPngBytes();
-        const sizeRef = createRef(0);
-        const data = pngBytes.getData(sizeRef);
+        const data = pngBytes.getData();
         if (!data) {
             throw new Error("Failed to serialize screenshot to PNG");
         }
         return {
             data: bytesToBase64(data),
             mimeType: "image/png",
-            width,
-            height,
+            width: Math.round(width * scale),
+            height: Math.round(height * scale),
         };
     }
     finally {
@@ -47,41 +45,84 @@ const captureSnapshot = (widget) => {
     }
 };
 /**
- * Captures a screenshot of a GTK widget as a PNG image.
- *
- * This function will retry multiple times if the widget hasn't finished
- * rendering, waiting for GTK to complete its paint cycle.
- *
- * @param widget - The widget to capture (typically a Window)
- * @param options - Optional timeout and interval configuration
- * @returns Screenshot result containing base64-encoded PNG data and dimensions
- * @throws Error if widget has no size, is not realized, or rendering fails after timeout
+ * Captures a PNG snapshot of a widget, retrying until it has a paintable size.
  *
- * @example
- * ```tsx
- * import { render, screenshot } from "@gtkx/testing";
- * import * as Gtk from "@gtkx/ffi/gtk";
- *
- * const { container } = await render(<MyApp />);
- * const window = container.getWindows()[0];
- * const result = await screenshot(window);
- * console.log(result.mimeType); // "image/png"
- * ```
+ * @param widget The widget to render to an image.
+ * @param options Optional scale, timeout, and retry interval.
+ * @returns The base64-encoded PNG data along with its mime type and dimensions.
  */
 export const screenshot = async (widget, options) => {
-    await tick();
-    return waitFor(() => captureSnapshot(widget), {
-        timeout: options?.timeout ?? DEFAULT_SCREENSHOT_TIMEOUT,
+    const scale = options?.scale ?? 1;
+    if (!Number.isFinite(scale) || scale <= 0) {
+        throw new Error(`Screenshot scale must be a positive number, got ${scale}`);
+    }
+    return waitFor(() => captureSnapshot(widget, scale), {
+        timeout: options?.timeout,
         interval: options?.interval ?? DEFAULT_SCREENSHOT_INTERVAL,
-        onTimeout: (error) => {
-            const paintable = new Gtk.WidgetPaintable(widget);
-            const width = paintable.getIntrinsicWidth();
-            const height = paintable.getIntrinsicHeight();
-            if (width <= 0 || height <= 0) {
-                return new Error("Widget has no size - ensure it is realized and visible");
-            }
-            return new Error(`Widget produced no render content after waiting for paint cycle. ${error.message}`);
-        },
     });
 };
+const resolveWindow = (selector) => {
+    const windows = Gtk.Window.listToplevels();
+    if (windows.length === 0) {
+        throw new Error("No windows available for screenshot");
+    }
+    if (selector === undefined) {
+        const [first] = windows;
+        if (!(first instanceof Gtk.Window)) {
+            throw new TypeError("First toplevel is not a Window");
+        }
+        return first;
+    }
+    if (typeof selector === "number") {
+        const indexed = windows[selector];
+        if (!(indexed instanceof Gtk.Window)) {
+            throw new TypeError(`Window at index ${selector} not found`);
+        }
+        return indexed;
+    }
+    const isRegex = selector instanceof RegExp;
+    const found = windows.find((w) => {
+        if (!(w instanceof Gtk.Window))
+            return false;
+        const title = w.getTitle() ?? "";
+        return isRegex ? selector.test(title) : title.includes(selector);
+    });
+    if (!found) {
+        const pattern = isRegex ? selector.toString() : `"${selector}"`;
+        throw new Error(`No window found with title matching ${pattern}`);
+    }
+    return found;
+};
+const saveScreenshotToTempFile = (result) => {
+    const dir = join(tmpdir(), "gtkx-screenshots");
+    if (!existsSync(dir)) {
+        mkdirSync(dir, { recursive: true });
+    }
+    const filepath = join(dir, `${Date.now()}-screenshot.png`);
+    writeFileSync(filepath, Buffer.from(result.data, "base64"));
+    return filepath;
+};
+/**
+ * Prints a clickable file URL for a saved screenshot to the console.
+ *
+ * @param filepath Absolute path of the saved screenshot file.
+ */
+export const logScreenshotPath = (filepath) => {
+    console.log(`Screenshot saved: file://${filepath}`);
+};
+/**
+ * Captures a screenshot of a toplevel window, writes it to a temporary file,
+ * logs its path, and returns the image data.
+ *
+ * @param selector Chooses the window by index, title substring, or regular
+ * expression; defaults to the first toplevel.
+ * @param options Optional scale, timeout, and retry interval.
+ * @returns The base64-encoded PNG data along with its mime type and dimensions.
+ */
+export const captureAndSaveScreenshot = async (selector, options) => {
+    const target = resolveWindow(selector);
+    const result = await screenshot(target, options);
+    logScreenshotPath(saveScreenshotToTempFile(result));
+    return result;
+};
 //# sourceMappingURL=screenshot.js.map

package/dist/screenshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../src/screenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,aAAa,GAAG,CAAC,KAAe,EAAU,EAAE;IAC9C,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,GAAG,CAAC;AACvC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAEvC,MAAM,eAAe,GAAG,CAAC,MAAkB,EAAoB,EAAE;IAC7D,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAC5C,MAAM,MAAM,GAAG,SAAS,CAAC,kBAAkB,EAAE,CAAC;IAE9C,IAAI,KAAK,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;IACpC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;IAErC,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IACpC,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;IACzC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpC,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO;YACH,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC;YACzB,QAAQ,EAAE,WAAW;YACrB,KAAK;YACL,MAAM;SACT,CAAC;IACN,CAAC;YAAS,CAAC;QACP,QAAQ,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,MAAkB,EAAE,OAA2B,EAA6B,EAAE;IAC3G,MAAM,IAAI,EAAE,CAAC;IAEb,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE;QAC1C,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,0BAA0B;QACvD,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,2BAA2B;QAC1D,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YACjB,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;YAC5C,MAAM,MAAM,GAAG,SAAS,CAAC,kBAAkB,EAAE,CAAC;YAE9C,IAAI,KAAK,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;gBAC5B,OAAO,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;YAC/E,CAAC;YACD,OAAO,IAAI,KAAK,CAAC,oEAAoE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1G,CAAC;KACJ,CAAC,CAAC;AACP,CAAC,CAAC"}
+{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../src/screenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,aAAa,GAAG,CAAC,KAAe,EAAU,EAAE;IAC9C,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAEvC,MAAM,mBAAmB,GAAG,CAAC,MAAkB,EAAU,EAAE,CACvD,YAAY,MAAM,CAAC,WAAW,EAAE,WAAW,MAAM,CAAC,SAAS,EAAE,YAAY,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;AAEnG,MAAM,eAAe,GAAG,CAAC,MAAkB,EAAE,KAAa,EAAoB,EAAE;IAC5E,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACtD,MAAM,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAC5C,MAAM,MAAM,GAAG,SAAS,CAAC,kBAAkB,EAAE,CAAC;IAE9C,IAAI,KAAK,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,0DAA0D,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9G,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;IACpC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC7B,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;IAErC,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sCAAsC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAEpC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;IACzC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEpC,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEhC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO;YACH,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC;YACzB,QAAQ,EAAE,WAAW;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YAChC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;SACrC,CAAC;IACN,CAAC;YAAS,CAAC;QACP,QAAQ,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,MAAkB,EAAE,OAA2B,EAA6B,EAAE;IAC3G,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC;IAElC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,mDAAmD,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;QACjD,OAAO,EAAE,OAAO,EAAE,OAAO;QACzB,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,2BAA2B;KAC7D,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,QAAyB,EAAc,EAAE;IAC5D,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;IAE3C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,CAAC,KAAK,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,CAAC,OAAO,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,SAAS,CAAC,mBAAmB,QAAQ,YAAY,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,QAAQ,YAAY,MAAM,CAAC;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAmB,EAAE;QAC9C,IAAI,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,MAAM,CAAC;YAAE,OAAO,KAAK,CAAC;QAC7C,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,GAAG,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,MAAwB,EAAU,EAAE;IAClE,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC;IAC/C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IAC3D,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5D,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAQ,EAAE;IACxD,OAAO,CAAC,GAAG,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EACzC,QAAyB,EACzB,OAA2B,EACF,EAAE;IAC3B,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,iBAAiB,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC","sourcesContent":["import { existsSync, mkdirSync, writeFileSync } from \"node:fs\";\nimport { tmpdir } from \"node:os\";\nimport { join } from \"node:path\";\nimport * as Gsk from \"@gtkx/gi/gsk\";\nimport * as Gtk from \"@gtkx/gi/gtk\";\nimport type { ScreenshotOptions, ScreenshotResult, WindowSelector } from \"./types.js\";\nimport { waitFor } from \"./wait-for.js\";\n\nconst bytesToBase64 = (bytes: number[]): string => {\n    return Buffer.from(bytes).toString(\"base64\");\n};\n\nconst DEFAULT_SCREENSHOT_INTERVAL = 10;\n\nconst describeWidgetState = (widget: Gtk.Widget): string =>\n    `realized=${widget.getRealized()} mapped=${widget.getMapped()} visible=${widget.getVisible()}`;\n\nconst captureSnapshot = (widget: Gtk.Widget, scale: number): ScreenshotResult => {\n    const paintable = new Gtk.WidgetPaintable({ widget });\n    const width = paintable.getIntrinsicWidth();\n    const height = paintable.getIntrinsicHeight();\n\n    if (width <= 0 || height <= 0) {\n        throw new Error(`Widget has no size: ensure it is realized and visible (${describeWidgetState(widget)})`);\n    }\n\n    const snapshot = new Gtk.Snapshot();\n    snapshot.scale(scale, scale);\n    paintable.snapshot(snapshot, width, height);\n    const renderNode = snapshot.toNode();\n\n    if (!renderNode) {\n        throw new Error(`Widget produced no render content (${describeWidgetState(widget)})`);\n    }\n\n    const display = widget.getDisplay();\n\n    const renderer = new Gsk.CairoRenderer();\n    renderer.realizeForDisplay(display);\n\n    try {\n        const texture = renderer.renderTexture(renderNode, null);\n        const pngBytes = texture.saveToPngBytes();\n        const data = pngBytes.getData();\n\n        if (!data) {\n            throw new Error(\"Failed to serialize screenshot to PNG\");\n        }\n\n        return {\n            data: bytesToBase64(data),\n            mimeType: \"image/png\",\n            width: Math.round(width * scale),\n            height: Math.round(height * scale),\n        };\n    } finally {\n        renderer.unrealize();\n    }\n};\n\n/**\n * Captures a PNG snapshot of a widget, retrying until it has a paintable size.\n *\n * @param widget The widget to render to an image.\n * @param options Optional scale, timeout, and retry interval.\n * @returns The base64-encoded PNG data along with its mime type and dimensions.\n */\nexport const screenshot = async (widget: Gtk.Widget, options?: ScreenshotOptions): Promise<ScreenshotResult> => {\n    const scale = options?.scale ?? 1;\n\n    if (!Number.isFinite(scale) || scale <= 0) {\n        throw new Error(`Screenshot scale must be a positive number, got ${scale}`);\n    }\n\n    return waitFor(() => captureSnapshot(widget, scale), {\n        timeout: options?.timeout,\n        interval: options?.interval ?? DEFAULT_SCREENSHOT_INTERVAL,\n    });\n};\n\nconst resolveWindow = (selector?: WindowSelector): Gtk.Window => {\n    const windows = Gtk.Window.listToplevels();\n\n    if (windows.length === 0) {\n        throw new Error(\"No windows available for screenshot\");\n    }\n\n    if (selector === undefined) {\n        const [first] = windows;\n        if (!(first instanceof Gtk.Window)) {\n            throw new TypeError(\"First toplevel is not a Window\");\n        }\n        return first;\n    }\n\n    if (typeof selector === \"number\") {\n        const indexed = windows[selector];\n        if (!(indexed instanceof Gtk.Window)) {\n            throw new TypeError(`Window at index ${selector} not found`);\n        }\n        return indexed;\n    }\n\n    const isRegex = selector instanceof RegExp;\n    const found = windows.find((w): w is Gtk.Window => {\n        if (!(w instanceof Gtk.Window)) return false;\n        const title = w.getTitle() ?? \"\";\n        return isRegex ? selector.test(title) : title.includes(selector);\n    });\n\n    if (!found) {\n        const pattern = isRegex ? selector.toString() : `\"${selector}\"`;\n        throw new Error(`No window found with title matching ${pattern}`);\n    }\n    return found;\n};\n\nconst saveScreenshotToTempFile = (result: ScreenshotResult): string => {\n    const dir = join(tmpdir(), \"gtkx-screenshots\");\n    if (!existsSync(dir)) {\n        mkdirSync(dir, { recursive: true });\n    }\n    const filepath = join(dir, `${Date.now()}-screenshot.png`);\n    writeFileSync(filepath, Buffer.from(result.data, \"base64\"));\n    return filepath;\n};\n\n/**\n * Prints a clickable file URL for a saved screenshot to the console.\n *\n * @param filepath Absolute path of the saved screenshot file.\n */\nexport const logScreenshotPath = (filepath: string): void => {\n    console.log(`Screenshot saved: file://${filepath}`);\n};\n\n/**\n * Captures a screenshot of a toplevel window, writes it to a temporary file,\n * logs its path, and returns the image data.\n *\n * @param selector Chooses the window by index, title substring, or regular\n * expression; defaults to the first toplevel.\n * @param options Optional scale, timeout, and retry interval.\n * @returns The base64-encoded PNG data along with its mime type and dimensions.\n */\nexport const captureAndSaveScreenshot = async (\n    selector?: WindowSelector,\n    options?: ScreenshotOptions,\n): Promise<ScreenshotResult> => {\n    const target = resolveWindow(selector);\n    const result = await screenshot(target, options);\n    logScreenshotPath(saveScreenshotToTempFile(result));\n    return result;\n};\n"]}

package/dist/suggestions.d.ts

@@ -0,0 +1,22 @@
+import * as Gtk from "@gtkx/gi/gtk";
+/** The query variant a suggestion targets. */
+export type Variant = "get" | "getAll" | "query" | "queryAll" | "find" | "findAll";
+/** The query family a suggestion targets. */
+export type Method = "Role" | "LabelText" | "PlaceholderText" | "Text" | "DisplayValue" | "Name";
+/** A suggested query for reaching a widget, including its family, variant, method name, and a `toString` that renders the full call. */
+export type Suggestion = {
+    queryName: Method;
+    /** The full query function name, such as `getByRole`. */
+    queryMethod: string;
+    variant: Variant;
+    toString: () => string;
+};
+/**
+ * Computes the recommended query for reaching the given widget, preferring role, then label text, placeholder text, text, display value, and name.
+ * @param widget Widget to build a suggestion for.
+ * @param variant Query variant the suggestion should use.
+ * @param method Restrict the suggestion to a specific query family instead of choosing by priority.
+ * @returns The best available suggestion, or undefined when no query applies.
+ */
+export declare const getSuggestedQuery: (widget: Gtk.Widget, variant?: Variant, method?: Method) => Suggestion | undefined;
+//# sourceMappingURL=suggestions.d.ts.map

package/dist/suggestions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestions.d.ts","sourceRoot":"","sources":["../src/suggestions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAYpC,8CAA8C;AAC9C,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAEnF,6CAA6C;AAC7C,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,iBAAiB,GAAG,MAAM,GAAG,cAAc,GAAG,MAAM,CAAC;AAEjG,wIAAwI;AACxI,MAAM,MAAM,UAAU,GAAG;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,MAAM,CAAC;CAC1B,CAAC;AA6BF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,WAClB,GAAG,CAAC,MAAM,YACT,OAAO,WACP,MAAM,KAChB,UAAU,GAAG,SAqBf,CAAC"}

package/dist/suggestions.js

@@ -0,0 +1,56 @@
+import * as Gtk from "@gtkx/gi/gtk";
+import { formatRole } from "./role-helpers.js";
+import { getWidgetAccessibleName, getWidgetDisplayValue, getWidgetLabelledByText, getWidgetLabelText, getWidgetName, getWidgetOwnLabel, getWidgetPlaceholderText, } from "./widget-accessible-properties.js";
+const makeSuggestion = (queryName, variant, argsText) => {
+    const queryMethod = `${variant}By${queryName}`;
+    return {
+        queryName,
+        queryMethod,
+        variant,
+        toString: () => `${queryMethod}(${argsText})`,
+    };
+};
+const roleSuggestion = (widget, variant) => {
+    const role = widget.getAccessibleRole();
+    if (role === Gtk.AccessibleRole.NONE || role === Gtk.AccessibleRole.GENERIC)
+        return undefined;
+    const roleText = `Gtk.AccessibleRole.${formatRole(role).toUpperCase()}`;
+    const name = getWidgetAccessibleName(widget);
+    if (name === null) {
+        return makeSuggestion("Role", variant, roleText);
+    }
+    return makeSuggestion("Role", variant, `${roleText}, { name: '${name}' }`);
+};
+const textSuggestion = (queryName, variant, value) => {
+    if (value === null)
+        return undefined;
+    return makeSuggestion(queryName, variant, `'${value}'`);
+};
+/**
+ * Computes the recommended query for reaching the given widget, preferring role, then label text, placeholder text, text, display value, and name.
+ * @param widget Widget to build a suggestion for.
+ * @param variant Query variant the suggestion should use.
+ * @param method Restrict the suggestion to a specific query family instead of choosing by priority.
+ * @returns The best available suggestion, or undefined when no query applies.
+ */
+export const getSuggestedQuery = (widget, variant = "get", method) => {
+    const builders = {
+        Role: () => roleSuggestion(widget, variant),
+        LabelText: () => textSuggestion("LabelText", variant, getWidgetOwnLabel(widget) ?? getWidgetLabelledByText(widget)),
+        PlaceholderText: () => textSuggestion("PlaceholderText", variant, getWidgetPlaceholderText(widget)),
+        Text: () => textSuggestion("Text", variant, getWidgetLabelText(widget)),
+        DisplayValue: () => textSuggestion("DisplayValue", variant, getWidgetDisplayValue(widget)),
+        Name: () => textSuggestion("Name", variant, getWidgetName(widget)),
+    };
+    if (method) {
+        return builders[method]();
+    }
+    const priority = ["Role", "LabelText", "PlaceholderText", "Text", "DisplayValue", "Name"];
+    for (const candidate of priority) {
+        const suggestion = builders[candidate]();
+        if (suggestion)
+            return suggestion;
+    }
+    return undefined;
+};
+//# sourceMappingURL=suggestions.js.map

package/dist/suggestions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestions.js","sourceRoot":"","sources":["../src/suggestions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EACH,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,wBAAwB,GAC3B,MAAM,mCAAmC,CAAC;AAiB3C,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,OAAgB,EAAE,QAAgB,EAAc,EAAE;IACzF,MAAM,WAAW,GAAG,GAAG,OAAO,KAAK,SAAS,EAAE,CAAC;IAC/C,OAAO;QACH,SAAS;QACT,WAAW;QACX,OAAO;QACP,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,WAAW,IAAI,QAAQ,GAAG;KAChD,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,MAAkB,EAAE,OAAgB,EAA0B,EAAE;IACpF,MAAM,IAAI,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;IACxC,IAAI,IAAI,KAAK,GAAG,CAAC,cAAc,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAE9F,MAAM,QAAQ,GAAG,sBAAsB,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;IACxE,MAAM,IAAI,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAChB,OAAO,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,cAAc,IAAI,KAAK,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,OAAgB,EAAE,KAAoB,EAA0B,EAAE;IACzG,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,OAAO,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC7B,MAAkB,EAClB,OAAO,GAAY,KAAK,EACxB,MAAe,EACO,EAAE;IACxB,MAAM,QAAQ,GAAiD;QAC3D,IAAI,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC;QAC3C,SAAS,EAAE,GAAG,EAAE,CACZ,cAAc,CAAC,WAAW,EAAE,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACtG,eAAe,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,iBAAiB,EAAE,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACnG,IAAI,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACvE,YAAY,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,EAAE,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC1F,IAAI,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;KACrE,CAAC;IAEF,IAAI,MAAM,EAAE,CAAC;QACT,OAAO,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9B,CAAC;IAED,MAAM,QAAQ,GAAa,CAAC,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IACpG,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzC,IAAI,UAAU;YAAE,OAAO,UAAU,CAAC;IACtC,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC","sourcesContent":["import * as Gtk from \"@gtkx/gi/gtk\";\nimport { formatRole } from \"./role-helpers.js\";\nimport {\n    getWidgetAccessibleName,\n    getWidgetDisplayValue,\n    getWidgetLabelledByText,\n    getWidgetLabelText,\n    getWidgetName,\n    getWidgetOwnLabel,\n    getWidgetPlaceholderText,\n} from \"./widget-accessible-properties.js\";\n\n/** The query variant a suggestion targets. */\nexport type Variant = \"get\" | \"getAll\" | \"query\" | \"queryAll\" | \"find\" | \"findAll\";\n\n/** The query family a suggestion targets. */\nexport type Method = \"Role\" | \"LabelText\" | \"PlaceholderText\" | \"Text\" | \"DisplayValue\" | \"Name\";\n\n/** A suggested query for reaching a widget, including its family, variant, method name, and a `toString` that renders the full call. */\nexport type Suggestion = {\n    queryName: Method;\n    /** The full query function name, such as `getByRole`. */\n    queryMethod: string;\n    variant: Variant;\n    toString: () => string;\n};\n\nconst makeSuggestion = (queryName: Method, variant: Variant, argsText: string): Suggestion => {\n    const queryMethod = `${variant}By${queryName}`;\n    return {\n        queryName,\n        queryMethod,\n        variant,\n        toString: () => `${queryMethod}(${argsText})`,\n    };\n};\n\nconst roleSuggestion = (widget: Gtk.Widget, variant: Variant): Suggestion | undefined => {\n    const role = widget.getAccessibleRole();\n    if (role === Gtk.AccessibleRole.NONE || role === Gtk.AccessibleRole.GENERIC) return undefined;\n\n    const roleText = `Gtk.AccessibleRole.${formatRole(role).toUpperCase()}`;\n    const name = getWidgetAccessibleName(widget);\n    if (name === null) {\n        return makeSuggestion(\"Role\", variant, roleText);\n    }\n    return makeSuggestion(\"Role\", variant, `${roleText}, { name: '${name}' }`);\n};\n\nconst textSuggestion = (queryName: Method, variant: Variant, value: string | null): Suggestion | undefined => {\n    if (value === null) return undefined;\n    return makeSuggestion(queryName, variant, `'${value}'`);\n};\n\n/**\n * Computes the recommended query for reaching the given widget, preferring role, then label text, placeholder text, text, display value, and name.\n * @param widget Widget to build a suggestion for.\n * @param variant Query variant the suggestion should use.\n * @param method Restrict the suggestion to a specific query family instead of choosing by priority.\n * @returns The best available suggestion, or undefined when no query applies.\n */\nexport const getSuggestedQuery = (\n    widget: Gtk.Widget,\n    variant: Variant = \"get\",\n    method?: Method,\n): Suggestion | undefined => {\n    const builders: Record<Method, () => Suggestion | undefined> = {\n        Role: () => roleSuggestion(widget, variant),\n        LabelText: () =>\n            textSuggestion(\"LabelText\", variant, getWidgetOwnLabel(widget) ?? getWidgetLabelledByText(widget)),\n        PlaceholderText: () => textSuggestion(\"PlaceholderText\", variant, getWidgetPlaceholderText(widget)),\n        Text: () => textSuggestion(\"Text\", variant, getWidgetLabelText(widget)),\n        DisplayValue: () => textSuggestion(\"DisplayValue\", variant, getWidgetDisplayValue(widget)),\n        Name: () => textSuggestion(\"Name\", variant, getWidgetName(widget)),\n    };\n\n    if (method) {\n        return builders[method]();\n    }\n\n    const priority: Method[] = [\"Role\", \"LabelText\", \"PlaceholderText\", \"Text\", \"DisplayValue\", \"Name\"];\n    for (const candidate of priority) {\n        const suggestion = builders[candidate]();\n        if (suggestion) return suggestion;\n    }\n    return undefined;\n};\n"]}

package/dist/traversal.d.ts

@@ -1,13 +1,15 @@
-import * as Gtk from "@gtkx/ffi/gtk";
+import * as Gtk from "@gtkx/gi/gtk";
+export declare const TOPLEVELS: unique symbol;
+type QueryContainer = Gtk.Widget | Gtk.EventController | Gtk.LayoutManager | Gtk.ListItem | Gtk.ListHeader;
 /**
- * Root element for scoping queries.
- *
- * When a `Gtk.Application` is provided, queries search across all toplevel
- * windows. When a `Gtk.Widget` is provided, queries are scoped to that
- * widget's subtree.
+ * A scope that queries and traversal can run against: a widget, an event
+ * controller, a layout manager, a list item or header, an application, or the
+ * sentinel representing all current toplevel windows.
  */
-export type Container = Gtk.Application | Gtk.Widget;
-export declare const isApplication: (container: Container) => container is Gtk.Application;
+export type Container = QueryContainer | Gtk.Application | typeof TOPLEVELS;
+export declare const descendants: (widget: Gtk.Widget) => Generator<Gtk.Widget>;
+export declare const roots: (container: Container) => Generator<Gtk.Widget>;
 export declare const traverse: (container: Container) => Generator<Gtk.Widget>;
 export declare const findAll: (container: Container, predicate: (node: Gtk.Widget) => boolean) => Gtk.Widget[];
+export {};
 //# sourceMappingURL=traversal.d.ts.map

package/dist/traversal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traversal.d.ts","sourceRoot":"","sources":["../src/traversal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC;AAErD,eAAO,MAAM,aAAa,GAAI,WAAW,SAAS,KAAG,SAAS,IAAI,GAAG,CAAC,WACK,CAAC;AAmB5E,eAAO,MAAM,QAAQ,GAAc,WAAW,SAAS,KAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAM7E,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,WAAW,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,KAAK,OAAO,KAAG,GAAG,CAAC,MAAM,EASlG,CAAC"}
+{"version":3,"file":"traversal.d.ts","sourceRoot":"","sources":["../src/traversal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAEpC,eAAO,MAAM,SAAS,EAAE,OAAO,MAAiC,CAAC;AAEjE,KAAK,cAAc,GAAG,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,eAAe,GAAG,GAAG,CAAC,aAAa,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC;AAE3G;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,GAAG,CAAC,WAAW,GAAG,OAAO,SAAS,CAAC;AAc5E,eAAO,MAAM,WAAW,WAAsB,GAAG,CAAC,MAAM,KAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAI9E,CAAC;AAUF,eAAO,MAAM,KAAK,cAAyB,SAAS,KAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAO1E,CAAC;AAEF,eAAO,MAAM,QAAQ,cAAyB,SAAS,KAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAI7E,CAAC;AAEF,eAAO,MAAM,OAAO,cAAe,SAAS,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,KAAK,OAAO,KAAG,GAAG,CAAC,MAAM,EAQlG,CAAC"}

package/dist/traversal.js

@@ -1,5 +1,6 @@
-import * as Gtk from "@gtkx/ffi/gtk";
-export const isApplication = (container) => "getWindows" in container && typeof container.getWindows === "function";
+import * as Gtk from "@gtkx/gi/gtk";
+export const TOPLEVELS = Symbol("gtkx.toplevels");
+const isApplication = (container) => container instanceof Gtk.Application;
 const traverseWidgetTree = function* (root) {
     yield root;
     let child = root.getFirstChild();
@@ -8,25 +9,39 @@ const traverseWidgetTree = function* (root) {
         child = child.getNextSibling();
     }
 };
-const traverseWindows = function* () {
-    const windows = Gtk.Window.listToplevels();
-    for (const window of windows) {
-        yield* traverseWidgetTree(window);
+export const descendants = function* (widget) {
+    const tree = traverseWidgetTree(widget);
+    tree.next();
+    yield* tree;
+};
+const resolveRoot = (container) => {
+    if (container instanceof Gtk.Widget)
+        return container;
+    if (container instanceof Gtk.EventController)
+        return container.getWidget();
+    if (container instanceof Gtk.LayoutManager)
+        return container.getWidget();
+    if (container instanceof Gtk.ListItem || container instanceof Gtk.ListHeader)
+        return container.getChild();
+    return null;
+};
+export const roots = function* (container) {
+    if (container === TOPLEVELS || isApplication(container)) {
+        yield* Gtk.Window.listToplevels();
+        return;
     }
+    const root = resolveRoot(container);
+    if (root)
+        yield root;
 };
 export const traverse = function* (container) {
-    if (isApplication(container)) {
-        yield* traverseWindows();
-    }
-    else {
-        yield* traverseWidgetTree(container);
+    for (const root of roots(container)) {
+        yield* traverseWidgetTree(root);
     }
 };
 export const findAll = (container, predicate) => {
     const results = [];
     for (const node of traverse(container)) {
-        if (node.getAccessibleRole?.() === Gtk.AccessibleRole.LABEL)
-            continue;
         if (predicate(node)) {
             results.push(node);
         }

package/dist/traversal.js.map

@@ -1 +1 @@
-{"version":3,"file":"traversal.js","sourceRoot":"","sources":["../src/traversal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AAWrC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAoB,EAAgC,EAAE,CAChF,YAAY,IAAI,SAAS,IAAI,OAAO,SAAS,CAAC,UAAU,KAAK,UAAU,CAAC;AAE5E,MAAM,kBAAkB,GAAG,QAAQ,CAAC,EAAE,IAAgB;IAClD,MAAM,IAAI,CAAC;IAEX,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACjC,OAAO,KAAK,EAAE,CAAC;QACX,KAAK,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACjC,KAAK,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,QAAQ,CAAC;IAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;IAC3C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,KAAK,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,SAAoB;IACnD,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACJ,KAAK,CAAC,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,SAAoB,EAAE,SAAwC,EAAgB,EAAE;IACpG,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,KAAK,GAAG,CAAC,cAAc,CAAC,KAAK;YAAE,SAAS;QACtE,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC"}
+{"version":3,"file":"traversal.js","sourceRoot":"","sources":["../src/traversal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAEpC,MAAM,CAAC,MAAM,SAAS,GAAkB,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAWjE,MAAM,aAAa,GAAG,CAAC,SAAoB,EAAgC,EAAE,CAAC,SAAS,YAAY,GAAG,CAAC,WAAW,CAAC;AAEnH,MAAM,kBAAkB,GAAG,QAAQ,CAAC,EAAE,IAAgB;IAClD,MAAM,IAAI,CAAC;IAEX,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACjC,OAAO,KAAK,EAAE,CAAC;QACX,KAAK,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACjC,KAAK,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC,EAAE,MAAkB;IACpD,MAAM,IAAI,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,IAAI,EAAE,CAAC;IACZ,KAAK,CAAC,CAAC,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAyB,EAAqB,EAAE;IACjE,IAAI,SAAS,YAAY,GAAG,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IACtD,IAAI,SAAS,YAAY,GAAG,CAAC,eAAe;QAAE,OAAO,SAAS,CAAC,SAAS,EAAE,CAAC;IAC3E,IAAI,SAAS,YAAY,GAAG,CAAC,aAAa;QAAE,OAAO,SAAS,CAAC,SAAS,EAAE,CAAC;IACzE,IAAI,SAAS,YAAY,GAAG,CAAC,QAAQ,IAAI,SAAS,YAAY,GAAG,CAAC,UAAU;QAAE,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC1G,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,SAAoB;IAChD,IAAI,SAAS,KAAK,SAAS,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QACtD,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAClC,OAAO;IACX,CAAC;IACD,MAAM,IAAI,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,IAAI;QAAE,MAAM,IAAI,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,SAAoB;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,SAAoB,EAAE,SAAwC,EAAgB,EAAE;IACpG,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC","sourcesContent":["import * as Gtk from \"@gtkx/gi/gtk\";\n\nexport const TOPLEVELS: unique symbol = Symbol(\"gtkx.toplevels\");\n\ntype QueryContainer = Gtk.Widget | Gtk.EventController | Gtk.LayoutManager | Gtk.ListItem | Gtk.ListHeader;\n\n/**\n * A scope that queries and traversal can run against: a widget, an event\n * controller, a layout manager, a list item or header, an application, or the\n * sentinel representing all current toplevel windows.\n */\nexport type Container = QueryContainer | Gtk.Application | typeof TOPLEVELS;\n\nconst isApplication = (container: Container): container is Gtk.Application => container instanceof Gtk.Application;\n\nconst traverseWidgetTree = function* (root: Gtk.Widget): Generator<Gtk.Widget> {\n    yield root;\n\n    let child = root.getFirstChild();\n    while (child) {\n        yield* traverseWidgetTree(child);\n        child = child.getNextSibling();\n    }\n};\n\nexport const descendants = function* (widget: Gtk.Widget): Generator<Gtk.Widget> {\n    const tree = traverseWidgetTree(widget);\n    tree.next();\n    yield* tree;\n};\n\nconst resolveRoot = (container: QueryContainer): Gtk.Widget | null => {\n    if (container instanceof Gtk.Widget) return container;\n    if (container instanceof Gtk.EventController) return container.getWidget();\n    if (container instanceof Gtk.LayoutManager) return container.getWidget();\n    if (container instanceof Gtk.ListItem || container instanceof Gtk.ListHeader) return container.getChild();\n    return null;\n};\n\nexport const roots = function* (container: Container): Generator<Gtk.Widget> {\n    if (container === TOPLEVELS || isApplication(container)) {\n        yield* Gtk.Window.listToplevels();\n        return;\n    }\n    const root = resolveRoot(container);\n    if (root) yield root;\n};\n\nexport const traverse = function* (container: Container): Generator<Gtk.Widget> {\n    for (const root of roots(container)) {\n        yield* traverseWidgetTree(root);\n    }\n};\n\nexport const findAll = (container: Container, predicate: (node: Gtk.Widget) => boolean): Gtk.Widget[] => {\n    const results: Gtk.Widget[] = [];\n    for (const node of traverse(container)) {\n        if (predicate(node)) {\n            results.push(node);\n        }\n    }\n    return results;\n};\n"]}