@gtkx/testing 0.21.0 → 1.0.0-rc.2

package/dist/screen.d.ts

@@ -1,66 +1,10 @@
-import * as Gtk from "@gtkx/ffi/gtk";
-import { type ScreenshotOptions } from "./screenshot.js";
-import type { ScreenshotResult } from "./types.js";
-/** @internal */
-export declare const setScreenRoot: (root: Gtk.Application | null) => void;
+import type { RenderResult, Screen } from "./bound-queries.js";
 /**
- * Global query object for accessing rendered components.
- *
- * Provides the same query methods as render result, but automatically
- * uses the most recently rendered application as the container.
- *
- * @example
- * ```tsx
- * import { render, screen } from "@gtkx/testing";
- *
- * test("finds button", async () => {
- *   await render(<MyComponent />);
- *   const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
- *   expect(button).toBeDefined();
- * });
- * ```
- *
- * @see {@link render} for rendering components
- * @see {@link within} for scoped queries
+ * Queries and debug utilities bound to the most recent render, scoped to the
+ * current toplevel windows. Accessing it before any render throws.
  */
-export declare const screen: {
-    /** Print the widget tree to console for debugging */
-    debug: () => void;
-    /** Log all accessible roles to console for debugging */
-    logRoles: () => void;
-    /**
-     * Capture a screenshot of the application window, saving it to a temporary file and logging the file path.
-     *
-     * @param selector - Window selector: index (number), title substring (string), or title pattern (RegExp).
-     *                   If omitted, captures the first window.
-     * @param options - Optional timeout and interval configuration for waiting on widget rendering.
-     * @returns Screenshot result containing base64-encoded PNG data
-     * @throws Error if no windows are available or no matching window is found
-     *
-     * @example
-     * ```tsx
-     * await screen.screenshot();              // First window
-     * await screen.screenshot(0);             // Window at index 0
-     * await screen.screenshot("Settings");    // Window with title containing "Settings"
-     * await screen.screenshot(/^My App/);     // Window with title matching regex
-     * ```
-     */
-    screenshot: (selector?: number | string | RegExp, options?: ScreenshotOptions) => Promise<ScreenshotResult>;
-    queryByRole: (role: Gtk.AccessibleRole, options?: import("./types.js").ByRoleOptions) => Gtk.Widget | null;
-    queryByLabelText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Gtk.Widget | null;
-    queryByText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Gtk.Widget | null;
-    queryByName: (name: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Gtk.Widget | null;
-    queryAllByRole: (role: Gtk.AccessibleRole, options?: import("./types.js").ByRoleOptions) => Gtk.Widget[];
-    queryAllByLabelText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Gtk.Widget[];
-    queryAllByText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Gtk.Widget[];
-    queryAllByName: (name: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Gtk.Widget[];
-    findByRole: (role: Gtk.AccessibleRole, options?: import("./types.js").ByRoleOptions) => Promise<Gtk.Widget>;
-    findByLabelText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Promise<Gtk.Widget>;
-    findByText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Promise<Gtk.Widget>;
-    findByName: (name: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Promise<Gtk.Widget>;
-    findAllByRole: (role: Gtk.AccessibleRole, options?: import("./types.js").ByRoleOptions) => Promise<Gtk.Widget[]>;
-    findAllByLabelText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Promise<Gtk.Widget[]>;
-    findAllByText: (text: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Promise<Gtk.Widget[]>;
-    findAllByName: (name: import("./types.js").TextMatch, options?: import("./types.js").TextMatchOptions) => Promise<Gtk.Widget[]>;
-};
+declare const screen: Screen;
+declare const setScreen: (result: RenderResult) => void;
+declare const clearScreen: () => void;
+export { screen, setScreen, clearScreen };
 //# sourceMappingURL=screen.d.ts.map

package/dist/screen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../src/screen.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AAIrC,OAAO,EAAE,KAAK,iBAAiB,EAAkC,MAAM,iBAAiB,CAAC;AACzF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAqBnD,gBAAgB;AAChB,eAAO,MAAM,aAAa,GAAI,MAAM,GAAG,CAAC,WAAW,GAAG,IAAI,KAAG,IAE5D,CAAC;AAYF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM;IAEf,qDAAqD;;IAIrD,wDAAwD;;IAIxD;;;;;;;;;;;;;;;;OAgBG;4BAC2B,MAAM,GAAG,MAAM,GAAG,MAAM,YAAY,iBAAiB,KAAG,OAAO,CAAC,gBAAgB,CAAC;mDAS3G,CAAA;oEAG0B,CAAC;+DAI3B,CAAL;+DAGqC,CAAC;sDAIV,CAAC;uEAGpB,CAAJ;kEAQF,CAAC;kEAAmK,CAAC;kDAAyK,CAAC;mEAA4K,CAAC;8DAAoK,CAAC;8DAAmK,CAAC;qDAAkL,CAAC;sEAAgL,CAAC;iEAAwK,CAAC;iEAAuK,CAAC;CAD//C,CAAC"}
+{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../src/screen.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAgB/D;;;GAGG;AACH,QAAA,MAAM,MAAM,EAAE,MAEZ,CAAC;AAMH,QAAA,MAAM,SAAS,GAAI,QAAQ,YAAY,KAAG,IAEzC,CAAC;AAEF,QAAA,MAAM,WAAW,QAAO,IAEvB,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC"}

package/dist/screen.js

@@ -1,114 +1,28 @@
-import { existsSync, mkdirSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import * as Gtk from "@gtkx/ffi/gtk";
-import { bindQueries } from "./bind-queries.js";
-import { prettyWidget } from "./pretty-widget.js";
-import { logRoles } from "./role-helpers.js";
-import { screenshot as screenshotWidget } from "./screenshot.js";
-const getScreenshotDir = () => {
-    const dir = join(tmpdir(), "gtkx-screenshots");
-    if (!existsSync(dir)) {
-        mkdirSync(dir, { recursive: true });
-    }
-    return dir;
-};
-const saveAndLogScreenshot = (result) => {
-    const dir = getScreenshotDir();
-    const filename = `${Date.now()}-screenshot.png`;
-    const filepath = join(dir, filename);
-    const buffer = Buffer.from(result.data, "base64");
-    writeFileSync(filepath, buffer);
-    console.log(`Screenshot saved: file://${filepath}`);
-};
-let currentRoot = null;
-/** @internal */
-export const setScreenRoot = (root) => {
-    currentRoot = root;
-};
-const getRoot = () => {
-    if (!currentRoot) {
-        throw new Error("No render has been performed: call render() before using screen queries");
-    }
-    return currentRoot;
-};
-const boundQueries = bindQueries(getRoot);
-/**
- * Global query object for accessing rendered components.
- *
- * Provides the same query methods as render result, but automatically
- * uses the most recently rendered application as the container.
- *
- * @example
- * ```tsx
- * import { render, screen } from "@gtkx/testing";
- *
- * test("finds button", async () => {
- *   await render(<MyComponent />);
- *   const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
- *   expect(button).toBeDefined();
- * });
- * ```
- *
- * @see {@link render} for rendering components
- * @see {@link within} for scoped queries
- */
-export const screen = {
-    ...boundQueries,
-    /** Print the widget tree to console for debugging */
-    debug: () => {
-        console.log(prettyWidget(getRoot()));
-    },
-    /** Log all accessible roles to console for debugging */
-    logRoles: () => {
-        logRoles(getRoot());
-    },
-    /**
-     * Capture a screenshot of the application window, saving it to a temporary file and logging the file path.
-     *
-     * @param selector - Window selector: index (number), title substring (string), or title pattern (RegExp).
-     *                   If omitted, captures the first window.
-     * @param options - Optional timeout and interval configuration for waiting on widget rendering.
-     * @returns Screenshot result containing base64-encoded PNG data
-     * @throws Error if no windows are available or no matching window is found
-     *
-     * @example
-     * ```tsx
-     * await screen.screenshot();              // First window
-     * await screen.screenshot(0);             // Window at index 0
-     * await screen.screenshot("Settings");    // Window with title containing "Settings"
-     * await screen.screenshot(/^My App/);     // Window with title matching regex
-     * ```
-     */
-    screenshot: async (selector, options) => {
-        const windows = Gtk.Window.listToplevels();
-        if (windows.length === 0) {
-            throw new Error("No windows available for screenshot");
+const NO_RENDER_MESSAGE = "No render has been performed: call render() before using screen queries";
+const defaultScreen = new Proxy({}, {
+    get: (_target, property) => {
+        if (property === "baseElement" || property === "container") {
+            return throwNoRender();
         }
-        let targetWindow;
-        if (selector === undefined) {
-            targetWindow = windows[0];
-        }
-        else if (typeof selector === "number") {
-            targetWindow = windows[selector];
-            if (!targetWindow) {
-                throw new Error(`Window at index ${selector} not found`);
-            }
-        }
-        else {
-            const isRegex = selector instanceof RegExp;
-            targetWindow = windows.find((w) => {
-                const title = w.getTitle() ?? "";
-                return isRegex ? selector.test(title) : title.includes(selector);
-            });
-            if (!targetWindow) {
-                const pattern = isRegex ? selector.toString() : `"${selector}"`;
-                throw new Error(`No window found with title matching ${pattern}`);
-            }
-        }
-        const result = await screenshotWidget(targetWindow, options);
-        saveAndLogScreenshot(result);
-        return result;
+        return throwNoRender;
     },
+});
+const activeScreen = { current: defaultScreen };
+/**
+ * Queries and debug utilities bound to the most recent render, scoped to the
+ * current toplevel windows. Accessing it before any render throws.
+ */
+const screen = new Proxy({}, {
+    get: (_target, property) => Reflect.get(activeScreen.current, property),
+});
+const throwNoRender = () => {
+    throw new Error(NO_RENDER_MESSAGE);
+};
+const setScreen = (result) => {
+    activeScreen.current = result;
+};
+const clearScreen = () => {
+    activeScreen.current = defaultScreen;
 };
+export { screen, setScreen, clearScreen };
 //# sourceMappingURL=screen.js.map

package/dist/screen.js.map

@@ -1 +1 @@
-{"version":3,"file":"screen.js","sourceRoot":"","sources":["../src/screen.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,eAAe,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAA0B,UAAU,IAAI,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGzF,MAAM,gBAAgB,GAAG,GAAW,EAAE;IAClC,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,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAwB,EAAQ,EAAE;IAC5D,MAAM,GAAG,GAAG,gBAAgB,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC;IAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,IAAI,WAAW,GAA2B,IAAI,CAAC;AAE/C,gBAAgB;AAChB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAA4B,EAAQ,EAAE;IAChE,WAAW,GAAG,IAAI,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,GAAoB,EAAE;IAClC,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC/F,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IAClB,GAAG,YAAY;IACf,qDAAqD;IACrD,KAAK,EAAE,GAAG,EAAE;QACR,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,wDAAwD;IACxD,QAAQ,EAAE,GAAG,EAAE;QACX,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACxB,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,EAAE,KAAK,EAAE,QAAmC,EAAE,OAA2B,EAA6B,EAAE;QAC9G,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAE3C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,YAAoC,CAAC;QAEzC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,YAAY,GAAG,OAAO,CAAC,CAAC,CAAe,CAAC;QAC5C,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACtC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAA2B,CAAC;YAC3D,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,YAAY,CAAC,CAAC;YAC7D,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,YAAY,MAAM,CAAC;YAC3C,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC9B,MAAM,KAAK,GAAI,CAAgB,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;gBACjD,OAAO,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACrE,CAAC,CAA2B,CAAC;YAE7B,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,GAAG,CAAC;gBAChE,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;YACtE,CAAC;QACL,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC7D,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ,CAAC"}
+{"version":3,"file":"screen.js","sourceRoot":"","sources":["../src/screen.ts"],"names":[],"mappings":"AAEA,MAAM,iBAAiB,GAAG,yEAAyE,CAAC;AAEpG,MAAM,aAAa,GAAiB,IAAI,KAAK,CAAC,EAAkB,EAAE;IAC9D,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QACvB,IAAI,QAAQ,KAAK,aAAa,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;YACzD,OAAO,aAAa,EAAE,CAAC;QAC3B,CAAC;QAED,OAAO,aAAa,CAAC;IACzB,CAAC;CACJ,CAAC,CAAC;AAEH,MAAM,YAAY,GAA8B,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,GAAW,IAAI,KAAK,CAAC,EAAY,EAAE;IAC3C,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAW,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;CACnF,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,GAAU,EAAE;IAC9B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,MAAoB,EAAQ,EAAE;IAC7C,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,GAAS,EAAE;IAC3B,YAAY,CAAC,OAAO,GAAG,aAAa,CAAC;AACzC,CAAC,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC","sourcesContent":["import type { RenderResult, Screen } from \"./bound-queries.js\";\n\nconst NO_RENDER_MESSAGE = \"No render has been performed: call render() before using screen queries\";\n\nconst defaultScreen: RenderResult = new Proxy({} as RenderResult, {\n    get: (_target, property) => {\n        if (property === \"baseElement\" || property === \"container\") {\n            return throwNoRender();\n        }\n\n        return throwNoRender;\n    },\n});\n\nconst activeScreen: { current: RenderResult } = { current: defaultScreen };\n\n/**\n * Queries and debug utilities bound to the most recent render, scoped to the\n * current toplevel windows. Accessing it before any render throws.\n */\nconst screen: Screen = new Proxy({} as Screen, {\n    get: (_target, property): unknown => Reflect.get(activeScreen.current, property),\n});\n\nconst throwNoRender = (): never => {\n    throw new Error(NO_RENDER_MESSAGE);\n};\n\nconst setScreen = (result: RenderResult): void => {\n    activeScreen.current = result;\n};\n\nconst clearScreen = (): void => {\n    activeScreen.current = defaultScreen;\n};\n\nexport { screen, setScreen, clearScreen };\n"]}

package/dist/screenshot.d.ts

@@ -1,30 +1,28 @@
-import * as Gtk from "@gtkx/ffi/gtk";
-import type { ScreenshotResult, WaitForOptions } from "./types.js";
+import * as Gtk from "@gtkx/gi/gtk";
+import type { ScreenshotOptions, ScreenshotResult, WindowSelector } from "./types.js";
 /**
- * Options for capturing widget screenshots.
+ * Captures a PNG snapshot of a widget, retrying until it has a paintable size.
+ *
+ * @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 type ScreenshotOptions = Pick<WaitForOptions, "timeout" | "interval">;
+declare const screenshot: (widget: Gtk.Widget, options?: ScreenshotOptions) => Promise<ScreenshotResult>;
 /**
- * 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
+ * Prints a clickable file URL for a saved screenshot to the console.
  *
- * @example
- * ```tsx
- * import { render, screenshot } from "@gtkx/testing";
- * import * as Gtk from "@gtkx/ffi/gtk";
+ * @param filepath Absolute path of the saved screenshot file.
+ */
+declare const logScreenshotPath: (filepath: string) => void;
+/**
+ * Captures a screenshot of a toplevel window, writes it to a temporary file,
+ * logs its path, and returns the image data.
  *
- * const { container } = await render(<MyApp />);
- * const window = container.getWindows()[0];
- * const result = await screenshot(window);
- * console.log(result.mimeType); // "image/png"
- * ```
+ * @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 declare const screenshot: (widget: Gtk.Widget, options?: ScreenshotOptions) => Promise<ScreenshotResult>;
+declare const captureAndSaveScreenshot: (selector?: WindowSelector, options?: ScreenshotOptions) => Promise<ScreenshotResult>;
+export { screenshot, logScreenshotPath, captureAndSaveScreenshot };
 //# sourceMappingURL=screenshot.d.ts.map

package/dist/screenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../src/screenshot.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AAErC,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAwDnE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,UAAU,GAAU,QAAQ,GAAG,CAAC,MAAM,EAAE,UAAU,iBAAiB,KAAG,OAAO,CAAC,gBAAgB,CAiB1G,CAAC"}
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../src/screenshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAIpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAuDtF;;;;;;GAMG;AACH,QAAA,MAAM,UAAU,GAAU,QAAQ,GAAG,CAAC,MAAM,EAAE,UAAU,iBAAiB,KAAG,OAAO,CAAC,gBAAgB,CAWnG,CAAC;AAqEF;;;;GAIG;AACH,QAAA,MAAM,iBAAiB,GAAI,UAAU,MAAM,KAAG,IAE7C,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,wBAAwB,GAC1B,WAAW,cAAc,EACzB,UAAU,iBAAiB,KAC5B,OAAO,CAAC,gBAAgB,CAM1B,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,CAAC"}

package/dist/screenshot.js

@@ -1,45 +1,44 @@
-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 * as Gsk from "@gtkx/gi/gsk";
+import * as Gtk from "@gtkx/gi/gtk";
+import { mkdtempSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
 import { waitFor } from "./wait-for.js";
+const DEFAULT_SCREENSHOT_INTERVAL = 10;
 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=${String(widget.getRealized())} mapped=${String(widget.getMapped())} ` +
+    `visible=${String(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 +46,90 @@ 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.
+ * Captures a PNG snapshot of a widget, retrying until it has a paintable size.
  *
- * @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
- *
- * @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 screenshot = async (widget, options) => {
+    const scale = options?.scale ?? 1;
+    if (!Number.isFinite(scale) || scale <= 0) {
+        throw new Error(`Screenshot scale must be a positive number, got ${String(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 firstToplevelWindow = (windows) => {
+    const [first] = windows;
+    if (!(first instanceof Gtk.Window)) {
+        throw new TypeError("First toplevel is not a Window");
+    }
+    return first;
+};
+const windowAtIndex = (windows, index) => {
+    const indexed = windows[index];
+    if (!(indexed instanceof Gtk.Window)) {
+        throw new TypeError(`Window at index ${String(index)} not found`);
+    }
+    return indexed;
+};
+const isWindow = (widget) => widget instanceof Gtk.Window;
+const hasMatchingTitle = (window, selector) => {
+    const title = window.getTitle() ?? "";
+    return selector instanceof RegExp ? selector.test(title) : title.includes(selector);
+};
+const describeTitleSelector = (selector) => selector instanceof RegExp ? selector.toString() : `"${selector}"`;
+const windowByTitle = (windows, selector) => {
+    const found = windows.filter(isWindow).find((window) => hasMatchingTitle(window, selector));
+    if (!found) {
+        throw new Error(`No window found with title matching ${describeTitleSelector(selector)}`);
+    }
+    return found;
+};
+const resolveWindow = (selector) => {
+    const windows = Gtk.Window.listToplevels();
+    if (windows.length === 0) {
+        throw new Error("No windows available for screenshot");
+    }
+    if (selector === undefined) {
+        return firstToplevelWindow(windows);
+    }
+    if (typeof selector === "number") {
+        return windowAtIndex(windows, selector);
+    }
+    return windowByTitle(windows, selector);
+};
+const saveScreenshotToTempFile = (result) => {
+    const dir = mkdtempSync(join(tmpdir(), "gtkx-screenshots-"));
+    const filepath = join(dir, "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.
+ */
+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.
+ */
+const captureAndSaveScreenshot = async (selector, options) => {
+    const target = resolveWindow(selector);
+    const result = await screenshot(target, options);
+    logScreenshotPath(saveScreenshotToTempFile(result));
+    return result;
+};
+export { screenshot, logScreenshotPath, captureAndSaveScreenshot };
 //# 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,uDAAuD,CAAC,CAAC;IAC7E,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,8CAA8C,CAAC,CAAC;IACpE,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,uDAAuD,CAAC,CAAC;YAC9E,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,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAEvC,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,mBAAmB,GAAG,CAAC,MAAkB,EAAU,EAAE,CACvD,YAAY,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,WAAW,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG;IAChF,WAAW,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;AAE7C,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;IACpC,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,UAAU,GAAG,KAAK,EAAE,MAAkB,EAAE,OAA2B,EAA6B,EAAE;IACpG,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,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxF,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,mBAAmB,GAAG,CAAC,OAAqB,EAAc,EAAE;IAC9D,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;IAExB,IAAI,CAAC,CAAC,KAAK,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAAqB,EAAE,KAAa,EAAc,EAAE;IACvE,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAE/B,IAAI,CAAC,CAAC,OAAO,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CAAC,mBAAmB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,MAAkB,EAAwB,EAAE,CAAC,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC;AAE5F,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAAE,QAAyB,EAAW,EAAE;IAChF,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;IAEtC,OAAO,QAAQ,YAAY,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,QAAyB,EAAU,EAAE,CAChE,QAAQ,YAAY,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,GAAG,CAAC;AAEvE,MAAM,aAAa,GAAG,CAAC,OAAqB,EAAE,QAAyB,EAAc,EAAE;IACnF,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE5F,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,uCAAuC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,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,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,MAAwB,EAAU,EAAE;IAClE,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;IAC7C,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE5D,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAQ,EAAE;IACjD,OAAO,CAAC,GAAG,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,wBAAwB,GAAG,KAAK,EAClC,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;IAEpD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,CAAC","sourcesContent":["import * as Gsk from \"@gtkx/gi/gsk\";\nimport * as Gtk from \"@gtkx/gi/gtk\";\nimport { mkdtempSync, writeFileSync } from \"node:fs\";\nimport { tmpdir } from \"node:os\";\nimport { join } from \"node:path\";\nimport type { ScreenshotOptions, ScreenshotResult, WindowSelector } from \"./types.js\";\nimport { waitFor } from \"./wait-for.js\";\n\nconst DEFAULT_SCREENSHOT_INTERVAL = 10;\n\nconst bytesToBase64 = (bytes: number[]): string => {\n    return Buffer.from(bytes).toString(\"base64\");\n};\n\nconst describeWidgetState = (widget: Gtk.Widget): string =>\n    `realized=${String(widget.getRealized())} mapped=${String(widget.getMapped())} ` +\n    `visible=${String(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    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 */\nconst 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 ${String(scale)}`);\n    }\n\n    return waitFor(() => captureSnapshot(widget, scale), {\n        timeout: options?.timeout,\n        interval: options?.interval ?? DEFAULT_SCREENSHOT_INTERVAL,\n    });\n};\n\nconst firstToplevelWindow = (windows: Gtk.Widget[]): Gtk.Window => {\n    const [first] = windows;\n\n    if (!(first instanceof Gtk.Window)) {\n        throw new TypeError(\"First toplevel is not a Window\");\n    }\n\n    return first;\n};\n\nconst windowAtIndex = (windows: Gtk.Widget[], index: number): Gtk.Window => {\n    const indexed = windows[index];\n\n    if (!(indexed instanceof Gtk.Window)) {\n        throw new TypeError(`Window at index ${String(index)} not found`);\n    }\n\n    return indexed;\n};\n\nconst isWindow = (widget: Gtk.Widget): widget is Gtk.Window => widget instanceof Gtk.Window;\n\nconst hasMatchingTitle = (window: Gtk.Window, selector: string | RegExp): boolean => {\n    const title = window.getTitle() ?? \"\";\n\n    return selector instanceof RegExp ? selector.test(title) : title.includes(selector);\n};\n\nconst describeTitleSelector = (selector: string | RegExp): string =>\n    selector instanceof RegExp ? selector.toString() : `\"${selector}\"`;\n\nconst windowByTitle = (windows: Gtk.Widget[], selector: string | RegExp): Gtk.Window => {\n    const found = windows.filter(isWindow).find((window) => hasMatchingTitle(window, selector));\n\n    if (!found) {\n        throw new Error(`No window found with title matching ${describeTitleSelector(selector)}`);\n    }\n\n    return found;\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        return firstToplevelWindow(windows);\n    }\n\n    if (typeof selector === \"number\") {\n        return windowAtIndex(windows, selector);\n    }\n\n    return windowByTitle(windows, selector);\n};\n\nconst saveScreenshotToTempFile = (result: ScreenshotResult): string => {\n    const dir = mkdtempSync(join(tmpdir(), \"gtkx-screenshots-\"));\n    const filepath = join(dir, \"screenshot.png\");\n    writeFileSync(filepath, Buffer.from(result.data, \"base64\"));\n\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 */\nconst 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 */\nconst 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\n    return result;\n};\n\nexport { screenshot, logScreenshotPath, captureAndSaveScreenshot };\n"]}

package/dist/suggestions.d.ts

@@ -0,0 +1,27 @@
+import * as Gtk from "@gtkx/gi/gtk";
+/** The query variant a suggestion targets. */
+type Variant = "get" | "getAll" | "query" | "queryAll" | "find" | "findAll";
+/** The query family a suggestion targets. */
+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.
+ */
+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.
+ */
+declare const getSuggestedQuery: (widget: Gtk.Widget, variant?: Variant, method?: Method) => Suggestion | undefined;
+export { getSuggestedQuery, type Variant, type Method, type Suggestion };
+//# 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,KAAK,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAC5E,6CAA6C;AAC7C,KAAK,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,iBAAiB,GAAG,MAAM,GAAG,cAAc,GAAG,MAAM,CAAC;AAE1F;;;GAGG;AACH,KAAK,UAAU,GAAG;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,MAAM,CAAC;CAC1B,CAAC;AAsCF;;;;;;;GAOG;AACH,QAAA,MAAM,iBAAiB,GACnB,QAAQ,GAAG,CAAC,MAAM,EAClB,UAAS,OAAe,EACxB,SAAS,MAAM,KAChB,UAAU,GAAG,SA0Bf,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,CAAC"}

package/dist/suggestions.js

@@ -0,0 +1,61 @@
+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.
+ */
+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;
+};
+export { getSuggestedQuery };
+//# 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;AAmB3C,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,OAAgB,EAAE,QAAgB,EAAc,EAAE;IACzF,MAAM,WAAW,GAAG,GAAG,OAAO,KAAK,SAAS,EAAE,CAAC;IAE/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;IAExC,IAAI,IAAI,KAAK,GAAG,CAAC,cAAc,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC1E,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,sBAAsB,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;IACxE,MAAM,IAAI,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE7C,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAChB,OAAO,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,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,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,iBAAiB,GAAG,CACtB,MAAkB,EAClB,UAAmB,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;IAEpG,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAEzC,IAAI,UAAU,EAAE,CAAC;YACb,OAAO,UAAU,CAAC;QACtB,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAA8C,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. */\ntype Variant = \"get\" | \"getAll\" | \"query\" | \"queryAll\" | \"find\" | \"findAll\";\n/** The query family a suggestion targets. */\ntype Method = \"Role\" | \"LabelText\" | \"PlaceholderText\" | \"Text\" | \"DisplayValue\" | \"Name\";\n\n/**\n * A suggested query for reaching a widget, including its family, variant, method name, and a\n * `toString` that renders the full call.\n */\ntype 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\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\n    if (role === Gtk.AccessibleRole.NONE || role === Gtk.AccessibleRole.GENERIC) {\n        return undefined;\n    }\n\n    const roleText = `Gtk.AccessibleRole.${formatRole(role).toUpperCase()}`;\n    const name = getWidgetAccessibleName(widget);\n\n    if (name === null) {\n        return makeSuggestion(\"Role\", variant, roleText);\n    }\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) {\n        return undefined;\n    }\n\n    return makeSuggestion(queryName, variant, `'${value}'`);\n};\n\n/**\n * Computes the recommended query for reaching the given widget, preferring role, then label text,\n * 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 */\nconst 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\n    for (const candidate of priority) {\n        const suggestion = builders[candidate]();\n\n        if (suggestion) {\n            return suggestion;\n        }\n    }\n\n    return undefined;\n};\n\nexport { getSuggestedQuery, type Variant, type Method, type Suggestion };\n"]}