@gtkx/testing 0.11.0 → 0.12.0

package/dist/widget-text.d.ts

@@ -0,0 +1,29 @@
+import * as Gtk from "@gtkx/ffi/gtk";
+/**
+ * Extracts the accessible text content from a widget based on its role.
+ *
+ * @param widget - The widget to extract text from
+ * @returns The accessible text or null if none found
+ */
+export declare const getWidgetText: (widget: Gtk.Widget) => string | null;
+/**
+ * Gets the test ID from a widget (uses the widget's name property).
+ *
+ * @param widget - The widget to get the test ID from
+ * @returns The test ID or null if not set
+ */
+export declare const getWidgetTestId: (widget: Gtk.Widget) => string | null;
+/**
+ * Gets the checked state from toggle-like widgets.
+ *
+ * @param widget - The widget to get the checked state from
+ * @returns The checked state or null if not applicable
+ */
+export declare const getWidgetCheckedState: (widget: Gtk.Widget) => boolean | null;
+/**
+ * Gets the expanded state from expander widgets.
+ *
+ * @param widget - The widget to get the expanded state from
+ * @returns The expanded state or null if not applicable
+ */
+export declare const getWidgetExpandedState: (widget: Gtk.Widget) => boolean | null;

package/dist/widget-text.js

@@ -0,0 +1,146 @@
+import { getNativeObject } from "@gtkx/ffi";
+import * as Gtk from "@gtkx/ffi/gtk";
+const ROLES_WITH_INTERNAL_LABELS = new Set([
+    Gtk.AccessibleRole.BUTTON,
+    Gtk.AccessibleRole.TOGGLE_BUTTON,
+    Gtk.AccessibleRole.CHECKBOX,
+    Gtk.AccessibleRole.RADIO,
+    Gtk.AccessibleRole.MENU_ITEM,
+    Gtk.AccessibleRole.MENU_ITEM_CHECKBOX,
+    Gtk.AccessibleRole.MENU_ITEM_RADIO,
+    Gtk.AccessibleRole.TAB,
+    Gtk.AccessibleRole.LINK,
+]);
+const isInternalLabel = (widget) => {
+    if (widget.getAccessibleRole() !== Gtk.AccessibleRole.LABEL)
+        return false;
+    const parent = widget.getParent();
+    if (!parent)
+        return false;
+    if (parent.getAccessibleRole === undefined)
+        return false;
+    const parentRole = parent.getAccessibleRole();
+    if (!parentRole)
+        return false;
+    return ROLES_WITH_INTERNAL_LABELS.has(parentRole);
+};
+const getLabelText = (widget) => {
+    const asLabel = widget;
+    const asInscription = widget;
+    return asLabel.getLabel?.() ?? asInscription.getText?.() ?? null;
+};
+const collectChildLabels = (widget) => {
+    const labels = [];
+    let child = widget.getFirstChild();
+    while (child) {
+        if (child.getAccessibleRole() === Gtk.AccessibleRole.LABEL) {
+            const labelText = getLabelText(child);
+            if (labelText)
+                labels.push(labelText);
+        }
+        labels.push(...collectChildLabels(child));
+        child = child.getNextSibling();
+    }
+    return labels;
+};
+/**
+ * Extracts the accessible text content from a widget based on its role.
+ *
+ * @param widget - The widget to extract text from
+ * @returns The accessible text or null if none found
+ */
+export const getWidgetText = (widget) => {
+    if (isInternalLabel(widget))
+        return null;
+    const role = widget.getAccessibleRole();
+    if (role === undefined)
+        return null;
+    switch (role) {
+        case Gtk.AccessibleRole.BUTTON:
+        case Gtk.AccessibleRole.LINK:
+        case Gtk.AccessibleRole.TAB: {
+            const directLabel = widget.getLabel?.() ??
+                widget.getLabel?.() ??
+                widget.getLabel?.();
+            if (directLabel)
+                return directLabel;
+            const childLabels = collectChildLabels(widget);
+            return childLabels.length > 0 ? childLabels.join(" ") : null;
+        }
+        case Gtk.AccessibleRole.TOGGLE_BUTTON:
+            return widget.getLabel?.() ?? null;
+        case Gtk.AccessibleRole.CHECKBOX:
+        case Gtk.AccessibleRole.RADIO:
+            return widget.getLabel?.() ?? null;
+        case Gtk.AccessibleRole.LABEL:
+            return getLabelText(widget);
+        case Gtk.AccessibleRole.TEXT_BOX:
+        case Gtk.AccessibleRole.SEARCH_BOX:
+        case Gtk.AccessibleRole.SPIN_BUTTON:
+            return getNativeObject(widget.handle, Gtk.Editable).getText() ?? null;
+        case Gtk.AccessibleRole.GROUP:
+            return widget.getLabel?.() ?? null;
+        case Gtk.AccessibleRole.WINDOW:
+        case Gtk.AccessibleRole.DIALOG:
+        case Gtk.AccessibleRole.ALERT_DIALOG:
+            return widget.getTitle() ?? null;
+        case Gtk.AccessibleRole.TAB_PANEL: {
+            const parent = widget.getParent();
+            if (parent) {
+                const stack = parent;
+                const page = stack.getPage?.(widget);
+                if (page) {
+                    return page.getTitle() ?? null;
+                }
+            }
+            return null;
+        }
+        default:
+            return null;
+    }
+};
+/**
+ * Gets the test ID from a widget (uses the widget's name property).
+ *
+ * @param widget - The widget to get the test ID from
+ * @returns The test ID or null if not set
+ */
+export const getWidgetTestId = (widget) => {
+    return widget.getName();
+};
+/**
+ * Gets the checked state from toggle-like widgets.
+ *
+ * @param widget - The widget to get the checked state from
+ * @returns The checked state or null if not applicable
+ */
+export const getWidgetCheckedState = (widget) => {
+    const role = widget.getAccessibleRole();
+    switch (role) {
+        case Gtk.AccessibleRole.CHECKBOX:
+        case Gtk.AccessibleRole.RADIO:
+            return widget.getActive();
+        case Gtk.AccessibleRole.TOGGLE_BUTTON:
+            return widget.getActive();
+        case Gtk.AccessibleRole.SWITCH:
+            return widget.getActive();
+        default:
+            return null;
+    }
+};
+/**
+ * Gets the expanded state from expander widgets.
+ *
+ * @param widget - The widget to get the expanded state from
+ * @returns The expanded state or null if not applicable
+ */
+export const getWidgetExpandedState = (widget) => {
+    const role = widget.getAccessibleRole();
+    if (role === Gtk.AccessibleRole.BUTTON) {
+        const parent = widget.getParent();
+        if (!parent)
+            return null;
+        return parent.getExpanded?.() ?? null;
+    }
+    return null;
+};

package/dist/widget.d.ts

@@ -1,3 +1,2 @@
 import * as Gtk from "@gtkx/ffi/gtk";
 export declare const isEditable: (widget: Gtk.Widget) => boolean;
-export declare const hasLabel: (widget: Gtk.Widget) => boolean;

package/dist/widget.js

@@ -7,16 +7,3 @@ const EDITABLE_ROLES = new Set([
 export const isEditable = (widget) => {
     return EDITABLE_ROLES.has(widget.getAccessibleRole());
 };
-const LABEL_ROLES = new Set([
-    Gtk.AccessibleRole.BUTTON,
-    Gtk.AccessibleRole.TOGGLE_BUTTON,
-    Gtk.AccessibleRole.CHECKBOX,
-    Gtk.AccessibleRole.RADIO,
-    Gtk.AccessibleRole.LABEL,
-    Gtk.AccessibleRole.MENU_ITEM,
-    Gtk.AccessibleRole.MENU_ITEM_CHECKBOX,
-    Gtk.AccessibleRole.MENU_ITEM_RADIO,
-]);
-export const hasLabel = (widget) => {
-    return LABEL_ROLES.has(widget.getAccessibleRole());
-};

package/dist/within.js

@@ -1,4 +1,4 @@
-import * as queries from "./queries.js";
+import { bindQueries } from "./bind-queries.js";
 /**
  * Creates scoped query methods for a container widget.
  *
@@ -25,13 +25,4 @@ import * as queries from "./queries.js";
  *
  * @see {@link screen} for global queries
  */
-export const within = (container) => ({
-    findByRole: (role, options) => queries.findByRole(container, role, options),
-    findByLabelText: (text, options) => queries.findByLabelText(container, text, options),
-    findByText: (text, options) => queries.findByText(container, text, options),
-    findByTestId: (testId, options) => queries.findByTestId(container, testId, options),
-    findAllByRole: (role, options) => queries.findAllByRole(container, role, options),
-    findAllByLabelText: (text, options) => queries.findAllByLabelText(container, text, options),
-    findAllByText: (text, options) => queries.findAllByText(container, text, options),
-    findAllByTestId: (testId, options) => queries.findAllByTestId(container, testId, options),
-});
+export const within = (container) => bindQueries(container);

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@gtkx/testing",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Testing utilities for GTKX applications",
   "keywords": [
+    "gtkx",
     "gtk",
     "gtk4",
     "react",
+    "typescript",
     "testing",
-    "testing-library"
+    "testing-library",
+    "linux",
+    "desktop"
   ],
   "homepage": "https://eugeniodepalo.github.io/gtkx",
   "bugs": {
@@ -32,14 +36,14 @@
     "dist"
   ],
   "dependencies": {
-    "@gtkx/ffi": "0.11.0",
-    "@gtkx/native": "0.11.0",
-    "@gtkx/react": "0.11.0"
+    "@gtkx/ffi": "0.12.0",
+    "@gtkx/native": "0.12.0",
+    "@gtkx/react": "0.12.0"
   },
   "devDependencies": {
     "@types/react-reconciler": "^0.32.3",
     "react-reconciler": "^0.33.0",
-    "@gtkx/vitest": "0.11.0"
+    "@gtkx/vitest": "0.12.0"
   },
   "scripts": {
     "build": "tsc -b && cp ../../README.md .",