@gtkx/testing 0.21.0 → 1.0.0-rc.2

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,YAAY,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EACH,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,EACb,eAAe,EACf,UAAU,EACV,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,WAAW,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,YAAY,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EACR,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,GACnB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,0BAA0B,CAAC;AAElC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC7E,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EACH,qBAAqB,EACrB,kBAAkB,EAClB,aAAa,EACb,wBAAwB,EACxB,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,SAAS,EACT,oBAAoB,EACpB,SAAS,EACT,SAAS,EACT,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,cAAc,EACd,yBAAyB,EACzB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,WAAW,EACX,WAAW,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC1F,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EACR,aAAa,EACb,WAAW,EACX,OAAO,EACP,eAAe,EACf,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,gBAAgB,GACnB,MAAM,YAAY,CAAC;AACpB,YAAY,EACR,UAAU,EACV,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAY,EACZ,WAAW,EACX,UAAU,EACV,WAAW,EACX,SAAS,GACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EACH,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,GACpB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -1,14 +1,18 @@
+import "./register-test-hooks.js";
+export { act } from "./act.js";
 export { configure, getConfig } from "./config.js";
 export { fireEvent } from "./fire-event.js";
-export { prettyWidget } from "./pretty-widget.js";
-export { findAllByLabelText, findAllByName, findAllByRole, findAllByText, findByLabelText, findByName, findByRole, findByText, queryAllByLabelText, queryAllByName, queryAllByRole, queryAllByText, queryByLabelText, queryByName, queryByRole, queryByText, } from "./queries.js";
-export { cleanup, render } from "./render.js";
+export { matchers, registerMatchers } from "./matchers.js";
+export { logWidget, prettyWidget } from "./pretty-widget.js";
+export { findAllByDisplayValue, findAllByLabelText, findAllByName, findAllByPlaceholderText, findAllByRole, findAllByText, findByDisplayValue, findByLabelText, findByName, findByPlaceholderText, findByRole, findByText, getAllByDisplayValue, getAllByLabelText, getAllByName, getAllByPlaceholderText, getAllByRole, getAllByText, getByDisplayValue, getByLabelText, getByName, getByPlaceholderText, getByRole, getByText, getDefaultNormalizer, queryAllByDisplayValue, queryAllByLabelText, queryAllByName, queryAllByPlaceholderText, queryAllByRole, queryAllByText, queryByDisplayValue, queryByLabelText, queryByName, queryByPlaceholderText, queryByRole, queryByText, } from "./queries.js";
 export { renderHook } from "./render-hook.js";
-export { getRoles, logRoles, prettyRoles } from "./role-helpers.js";
+export { cleanup, render } from "./render.js";
+export { formatRole, getRoles, logRoles, prettyRoles } from "./role-helpers.js";
 export { screen } from "./screen.js";
-export { screenshot } from "./screenshot.js";
-export { tick } from "./timing.js";
-export { userEvent } from "./user-event.js";
+export { captureAndSaveScreenshot, logScreenshotPath, screenshot } from "./screenshot.js";
+export { getSuggestedQuery } from "./suggestions.js";
+export { userEvent } from "./user-event/index.js";
 export { waitFor, waitForElementToBeRemoved } from "./wait-for.js";
+export { getWidgetErrorMessage, getWidgetInvalidState, getWidgetNodeText, } from "./widget-accessible-properties.js";
 export { within } from "./within.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EACH,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,EACb,eAAe,EACf,UAAU,EACV,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,WAAW,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAkBnC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,0BAA0B,CAAC;AAElC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EACH,qBAAqB,EACrB,kBAAkB,EAClB,aAAa,EACb,wBAAwB,EACxB,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,SAAS,EACT,oBAAoB,EACpB,SAAS,EACT,SAAS,EACT,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,cAAc,EACd,yBAAyB,EACzB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,WAAW,EACX,WAAW,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE1F,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AA8BrD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EACH,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,GACpB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC","sourcesContent":["import \"./register-test-hooks.js\";\n\nexport { act } from \"./act.js\";\nexport type { BoundQueries, RenderResult, Screen } from \"./bound-queries.js\";\nexport type { Config, ConfigFn } from \"./config.js\";\nexport { configure, getConfig } from \"./config.js\";\nexport { fireEvent } from \"./fire-event.js\";\nexport type { TextExpectation } from \"./matchers.js\";\nexport { matchers, registerMatchers } from \"./matchers.js\";\nexport type { PrettyWidgetOptions } from \"./pretty-widget.js\";\nexport { logWidget, prettyWidget } from \"./pretty-widget.js\";\nexport {\n    findAllByDisplayValue,\n    findAllByLabelText,\n    findAllByName,\n    findAllByPlaceholderText,\n    findAllByRole,\n    findAllByText,\n    findByDisplayValue,\n    findByLabelText,\n    findByName,\n    findByPlaceholderText,\n    findByRole,\n    findByText,\n    getAllByDisplayValue,\n    getAllByLabelText,\n    getAllByName,\n    getAllByPlaceholderText,\n    getAllByRole,\n    getAllByText,\n    getByDisplayValue,\n    getByLabelText,\n    getByName,\n    getByPlaceholderText,\n    getByRole,\n    getByText,\n    getDefaultNormalizer,\n    queryAllByDisplayValue,\n    queryAllByLabelText,\n    queryAllByName,\n    queryAllByPlaceholderText,\n    queryAllByRole,\n    queryAllByText,\n    queryByDisplayValue,\n    queryByLabelText,\n    queryByName,\n    queryByPlaceholderText,\n    queryByRole,\n    queryByText,\n} from \"./queries.js\";\nexport { renderHook } from \"./render-hook.js\";\nexport { cleanup, render } from \"./render.js\";\nexport { formatRole, getRoles, logRoles, prettyRoles } from \"./role-helpers.js\";\nexport { screen } from \"./screen.js\";\nexport { captureAndSaveScreenshot, logScreenshotPath, screenshot } from \"./screenshot.js\";\nexport type { Method, Suggestion, Variant } from \"./suggestions.js\";\nexport { getSuggestedQuery } from \"./suggestions.js\";\nexport type { Container } from \"./traversal.js\";\nexport type {\n    ByRoleOptions,\n    ByRoleValue,\n    Matcher,\n    MatcherFunction,\n    MatcherOptions,\n    NormalizerFn,\n    NormalizerOptions,\n    RenderHookOptions,\n    RenderHookResult,\n    RenderOptions,\n    ScreenshotOptions,\n    ScreenshotResult,\n    WaitForOptions,\n    WindowSelector,\n    WrapperComponent,\n} from \"./types.js\";\nexport type {\n    DragOffset,\n    DragOptions,\n    DropContent,\n    DropOptions,\n    PointerInput,\n    ScrollDelta,\n    TabOptions,\n    TypeOptions,\n    UserEvent,\n} from \"./user-event/index.js\";\nexport { userEvent } from \"./user-event/index.js\";\nexport { waitFor, waitForElementToBeRemoved } from \"./wait-for.js\";\nexport {\n    getWidgetErrorMessage,\n    getWidgetInvalidState,\n    getWidgetNodeText,\n} from \"./widget-accessible-properties.js\";\nexport { within } from \"./within.js\";\n"]}

package/dist/matchers.d.ts

@@ -0,0 +1,59 @@
+/** The expected value for a text matcher: an exact string or a regular expression. */
+type TextExpectation = string | RegExp;
+type MatcherResult = {
+    pass: boolean;
+    message: () => string;
+};
+type TextMatcher = (received: unknown, expected?: TextExpectation) => MatcherResult;
+type StateMatcher = (received: unknown) => MatcherResult;
+type ValueMatcher = (received: unknown, expected: number) => MatcherResult;
+type MatcherImplementations = {
+    toHaveDisplayValue: TextMatcher;
+    toHaveTextContent: TextMatcher;
+    toHaveAccessibleName: TextMatcher;
+    toHavePlaceholderText: TextMatcher;
+    toBeChecked: StateMatcher;
+    toBePressed: StateMatcher;
+    toBeExpanded: StateMatcher;
+    toBeSelected: StateMatcher;
+    toHaveValue: ValueMatcher;
+};
+declare const toHaveDisplayValue: TextMatcher;
+declare const toHaveTextContent: TextMatcher;
+declare const toHaveAccessibleName: TextMatcher;
+declare const toHavePlaceholderText: TextMatcher;
+declare const toBeChecked: StateMatcher;
+declare const toBePressed: StateMatcher;
+declare const toBeExpanded: StateMatcher;
+declare const toBeSelected: StateMatcher;
+/** The widget assertion matchers keyed by name, suitable for passing to `expect.extend`. */
+declare const matchers: MatcherImplementations;
+declare function toHaveValue(received: unknown, expected: number): MatcherResult;
+/** Registers the widget matchers on the global `expect`, when one is available. Safe to call more than once. */
+declare const registerMatchers: () => void;
+declare module "@vitest/expect" {
+    interface Assertion {
+        toHaveDisplayValue(expected?: TextExpectation): void;
+        toHaveTextContent(expected?: TextExpectation): void;
+        toHaveAccessibleName(expected?: TextExpectation): void;
+        toHavePlaceholderText(expected?: TextExpectation): void;
+        toBeChecked(): void;
+        toBePressed(): void;
+        toBeExpanded(): void;
+        toBeSelected(): void;
+        toHaveValue(expected: number): void;
+    }
+    interface AsymmetricMatchersContaining {
+        toHaveDisplayValue(expected?: TextExpectation): void;
+        toHaveTextContent(expected?: TextExpectation): void;
+        toHaveAccessibleName(expected?: TextExpectation): void;
+        toHavePlaceholderText(expected?: TextExpectation): void;
+        toBeChecked(): void;
+        toBePressed(): void;
+        toBeExpanded(): void;
+        toBeSelected(): void;
+        toHaveValue(expected: number): void;
+    }
+}
+export { toHaveDisplayValue, toHaveTextContent, toHaveAccessibleName, toHavePlaceholderText, toBeChecked, toBePressed, toBeExpanded, toBeSelected, matchers, toHaveValue, registerMatchers, type TextExpectation, };
+//# sourceMappingURL=matchers.d.ts.map

package/dist/matchers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.d.ts","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAcA,sFAAsF;AACtF,KAAK,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AACvC,KAAK,aAAa,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,MAAM,CAAA;CAAE,CAAC;AAC9D,KAAK,WAAW,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,eAAe,KAAK,aAAa,CAAC;AACpF,KAAK,YAAY,GAAG,CAAC,QAAQ,EAAE,OAAO,KAAK,aAAa,CAAC;AACzD,KAAK,YAAY,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,aAAa,CAAC;AAG3E,KAAK,sBAAsB,GAAG;IAC1B,kBAAkB,EAAE,WAAW,CAAC;IAChC,iBAAiB,EAAE,WAAW,CAAC;IAC/B,oBAAoB,EAAE,WAAW,CAAC;IAClC,qBAAqB,EAAE,WAAW,CAAC;IACnC,WAAW,EAAE,YAAY,CAAC;IAC1B,WAAW,EAAE,YAAY,CAAC;IAC1B,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;IAC3B,WAAW,EAAE,YAAY,CAAC;CAC7B,CAAC;AAIF,QAAA,MAAM,kBAAkB,EAAE,WAA+E,CAAC;AAE1G,QAAA,MAAM,iBAAiB,EAAE,WAIxB,CAAC;AAEF,QAAA,MAAM,oBAAoB,EAAE,WAAmF,CAAC;AAEhH,QAAA,MAAM,qBAAqB,EAAE,WAI5B,CAAC;AAEF,QAAA,MAAM,WAAW,EAAE,YAAmF,CAAC;AACvG,QAAA,MAAM,WAAW,EAAE,YAAmF,CAAC;AACvG,QAAA,MAAM,YAAY,EAAE,YAAsF,CAAC;AAC3G,QAAA,MAAM,YAAY,EAAE,YAAsF,CAAC;AAE3G,4FAA4F;AAC5F,QAAA,MAAM,QAAQ,EAAE,sBAUf,CAAC;AA8FF,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,aAAa,CAmBvE;AAYD,gHAAgH;AAChH,QAAA,MAAM,gBAAgB,QAAO,IAa5B,CAAC;AAEF,OAAO,QAAQ,gBAAgB,CAAC;IAE5B,UAAU,SAAS;QACf,kBAAkB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACrD,iBAAiB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACpD,oBAAoB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACvD,qBAAqB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACxD,WAAW,IAAI,IAAI,CAAC;QACpB,WAAW,IAAI,IAAI,CAAC;QACpB,YAAY,IAAI,IAAI,CAAC;QACrB,YAAY,IAAI,IAAI,CAAC;QACrB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;IAED,UAAU,4BAA4B;QAClC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACrD,iBAAiB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACpD,oBAAoB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACvD,qBAAqB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACxD,WAAW,IAAI,IAAI,CAAC;QACpB,WAAW,IAAI,IAAI,CAAC;QACpB,YAAY,IAAI,IAAI,CAAC;QACrB,YAAY,IAAI,IAAI,CAAC;QACrB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CAEJ;AAED,OAAO,EACH,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,KAAK,eAAe,GACvB,CAAC"}

package/dist/matchers.js

@@ -0,0 +1,117 @@
+/// <reference types="@vitest/expect" />
+import * as Gtk from "@gtkx/gi/gtk";
+import { getWidgetAccessibleName, getWidgetCheckedState, getWidgetDisplayValue, getWidgetExpandedState, getWidgetNodeText, getWidgetPlaceholderText, getWidgetPressedState, getWidgetSelectedState, getWidgetValue, } from "./widget-accessible-properties.js";
+const toHaveDisplayValue = textMatcher("toHaveDisplayValue", getWidgetDisplayValue, "exact");
+const toHaveTextContent = textMatcher("toHaveTextContent", (widget) => getWidgetNodeText(widget) ?? getWidgetAccessibleName(widget), "substring");
+const toHaveAccessibleName = textMatcher("toHaveAccessibleName", getWidgetAccessibleName, "exact");
+const toHavePlaceholderText = textMatcher("toHavePlaceholderText", getWidgetPlaceholderText, "exact");
+const toBeChecked = booleanStateMatcher("toBeChecked", "checked", getWidgetCheckedState);
+const toBePressed = booleanStateMatcher("toBePressed", "pressed", getWidgetPressedState);
+const toBeExpanded = booleanStateMatcher("toBeExpanded", "expanded", getWidgetExpandedState);
+const toBeSelected = booleanStateMatcher("toBeSelected", "selected", getWidgetSelectedState);
+/** The widget assertion matchers keyed by name, suitable for passing to `expect.extend`. */
+const matchers = {
+    toHaveDisplayValue,
+    toHaveTextContent,
+    toHaveAccessibleName,
+    toHavePlaceholderText,
+    toBeChecked,
+    toBePressed,
+    toBeExpanded,
+    toBeSelected,
+    toHaveValue,
+};
+const registration = { isRegistered: false };
+const asWidget = (received, matcherName) => {
+    if (!(received instanceof Gtk.Widget)) {
+        throw new TypeError(`${matcherName}: received value must be a Gtk.Widget, got ${typeof received}`);
+    }
+    return received;
+};
+const describeWidget = (widget) => {
+    const role = Gtk.AccessibleRole[widget.getAccessibleRole()];
+    const name = getWidgetAccessibleName(widget);
+    return name === null ? `<${role}>` : `<${role} name=${JSON.stringify(name)}>`;
+};
+const isTextMatch = (actual, expected, mode) => {
+    if (expected instanceof RegExp) {
+        expected.lastIndex = 0;
+        return expected.test(actual);
+    }
+    return mode === "exact" ? actual === expected : actual.includes(expected);
+};
+const describeExpected = (expected) => expected instanceof RegExp ? String(expected) : JSON.stringify(expected);
+const negationPrefix = (isPass) => (isPass ? "not " : "");
+const nonEmptyResult = ({ matcherName, widget, actual }) => {
+    const isPass = actual !== null && actual !== "";
+    return {
+        pass: isPass,
+        message: () => `expected widget ${negationPrefix(isPass)}to have a non-empty value for ${matcherName}, ` +
+            `but got ${JSON.stringify(actual)}\n${describeWidget(widget)}`,
+    };
+};
+const matchedResult = (context, expected, isPass) => ({
+    pass: isPass,
+    message: () => `expected widget ${negationPrefix(isPass)}${context.matcherName} ${describeExpected(expected)}, ` +
+        `but received ${JSON.stringify(context.actual)}\n${describeWidget(context.widget)}`,
+});
+function textMatcher(matcherName, read, mode) {
+    return (received, expected) => {
+        const widget = asWidget(received, matcherName);
+        const actual = read(widget);
+        const context = { matcherName, widget, actual };
+        if (expected === undefined) {
+            return nonEmptyResult(context);
+        }
+        return matchedResult(context, expected, actual !== null && isTextMatch(actual, expected, mode));
+    };
+}
+function booleanStateMatcher(matcherName, stateName, read) {
+    return (received) => {
+        const widget = asWidget(received, matcherName);
+        const state = read(widget);
+        if (state === null) {
+            throw new Error(`${matcherName}: widget does not expose a ${stateName} state ` +
+                `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\n${describeWidget(widget)}`);
+        }
+        return {
+            pass: state,
+            message: () => `expected widget ${negationPrefix(state)}to be ${stateName}\n${describeWidget(widget)}`,
+        };
+    };
+}
+function toHaveValue(received, expected) {
+    const widget = asWidget(received, "toHaveValue");
+    const actual = getWidgetValue(widget).now;
+    if (actual === null) {
+        throw new Error("toHaveValue: widget does not expose a numeric value " +
+            `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\n${describeWidget(widget)}`);
+    }
+    const isPass = actual === expected;
+    return {
+        pass: isPass,
+        message: () => `expected widget ${negationPrefix(isPass)}to have value ${String(expected)}, ` +
+            `but received ${String(actual)}\n${describeWidget(widget)}`,
+    };
+}
+const globalExpect = () => {
+    const candidate = Reflect.get(globalThis, "expect");
+    if (candidate && typeof candidate.extend === "function") {
+        return candidate;
+    }
+    return null;
+};
+/** Registers the widget matchers on the global `expect`, when one is available. Safe to call more than once. */
+const registerMatchers = () => {
+    if (registration.isRegistered) {
+        return;
+    }
+    const expect = globalExpect();
+    if (!expect) {
+        return;
+    }
+    expect.extend(matchers);
+    registration.isRegistered = true;
+};
+export { toHaveDisplayValue, toHaveTextContent, toHaveAccessibleName, toHavePlaceholderText, toBeChecked, toBePressed, toBeExpanded, toBeSelected, matchers, toHaveValue, registerMatchers, };
+//# sourceMappingURL=matchers.js.map

package/dist/matchers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.js","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,GACjB,MAAM,mCAAmC,CAAC;AAwB3C,MAAM,kBAAkB,GAAgB,WAAW,CAAC,oBAAoB,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;AAE1G,MAAM,iBAAiB,GAAgB,WAAW,CAC9C,mBAAmB,EACnB,CAAC,MAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,EACxE,WAAW,CACd,CAAC;AAEF,MAAM,oBAAoB,GAAgB,WAAW,CAAC,sBAAsB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;AAEhH,MAAM,qBAAqB,GAAgB,WAAW,CAClD,uBAAuB,EACvB,wBAAwB,EACxB,OAAO,CACV,CAAC;AAEF,MAAM,WAAW,GAAiB,mBAAmB,CAAC,aAAa,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC;AACvG,MAAM,WAAW,GAAiB,mBAAmB,CAAC,aAAa,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC;AACvG,MAAM,YAAY,GAAiB,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC;AAC3G,MAAM,YAAY,GAAiB,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC;AAE3G,4FAA4F;AAC5F,MAAM,QAAQ,GAA2B;IACrC,kBAAkB;IAClB,iBAAiB;IACjB,oBAAoB;IACpB,qBAAqB;IACrB,WAAW;IACX,WAAW;IACX,YAAY;IACZ,YAAY;IACZ,WAAW;CACd,CAAC;AAEF,MAAM,YAAY,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;AAE7C,MAAM,QAAQ,GAAG,CAAC,QAAiB,EAAE,WAAmB,EAAc,EAAE;IACpE,IAAI,CAAC,CAAC,QAAQ,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,8CAA8C,OAAO,QAAQ,EAAE,CAAC,CAAC;IACvG,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,MAAkB,EAAU,EAAE;IAClD,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC5D,MAAM,IAAI,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE7C,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;AAClF,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,QAAyB,EAAE,IAA2B,EAAW,EAAE;IACpG,IAAI,QAAQ,YAAY,MAAM,EAAE,CAAC;QAC7B,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;QAEvB,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAyB,EAAU,EAAE,CAC3D,QAAQ,YAAY,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAE7E,MAAM,cAAc,GAAG,CAAC,MAAe,EAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAE3E,MAAM,cAAc,GAAG,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAsB,EAAiB,EAAE;IAC1F,MAAM,MAAM,GAAG,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,EAAE,CAAC;IAEhD,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,cAAc,CAAC,MAAM,CAAC,iCAAiC,WAAW,IAAI;YACzF,WAAW,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;KACrE,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAA2B,EAAE,QAAyB,EAAE,MAAe,EAAiB,EAAE,CAAC,CAAC;IAC/G,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,cAAc,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,IAAI,gBAAgB,CAAC,QAAQ,CAAC,IAAI;QACjG,gBAAgB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;CAC1F,CAAC,CAAC;AAEH,SAAS,WAAW,CAChB,WAAmB,EACnB,IAA2C,EAC3C,IAA2B;IAE3B,OAAO,CAAC,QAAiB,EAAE,QAA0B,EAAiB,EAAE;QACpE,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAuB,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAEpE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,IAAI,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;IACpG,CAAC,CAAC;AACN,CAAC;AAED,SAAS,mBAAmB,CACxB,WAAmB,EACnB,SAAiB,EACjB,IAA4C;IAE5C,OAAO,CAAC,QAAiB,EAAiB,EAAE;QACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAE3B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACX,GAAG,WAAW,8BAA8B,SAAS,SAAS;gBAC9D,SAAS,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,MAAM,cAAc,CAAC,MAAM,CAAC,EAAE,CACxF,CAAC;QACN,CAAC;QAED,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,cAAc,CAAC,KAAK,CAAC,SAAS,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;SAC9F,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AAED,SAAS,WAAW,CAAC,QAAiB,EAAE,QAAgB;IACpD,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC;IAE1C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACX,sDAAsD;YACtD,SAAS,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,MAAM,cAAc,CAAC,MAAM,CAAC,EAAE,CACxF,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,KAAK,QAAQ,CAAC;IAEnC,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,cAAc,CAAC,MAAM,CAAC,iBAAiB,MAAM,CAAC,QAAQ,CAAC,IAAI;YAC9E,gBAAgB,MAAM,CAAC,MAAM,CAAC,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;KAClE,CAAC;AACN,CAAC;AAED,MAAM,YAAY,GAAG,GAAwB,EAAE;IAC3C,MAAM,SAAS,GAAY,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE7D,IAAI,SAAS,IAAI,OAAQ,SAA0B,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACxE,OAAO,SAAyB,CAAC;IACrC,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,gHAAgH;AAChH,MAAM,gBAAgB,GAAG,GAAS,EAAE;IAChC,IAAI,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,OAAO;IACX,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAE9B,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO;IACX,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACxB,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;AACrC,CAAC,CAAC;AA8BF,OAAO,EACH,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,gBAAgB,GAEnB,CAAC","sourcesContent":["/// <reference types=\"@vitest/expect\" />\nimport * as Gtk from \"@gtkx/gi/gtk\";\nimport {\n    getWidgetAccessibleName,\n    getWidgetCheckedState,\n    getWidgetDisplayValue,\n    getWidgetExpandedState,\n    getWidgetNodeText,\n    getWidgetPlaceholderText,\n    getWidgetPressedState,\n    getWidgetSelectedState,\n    getWidgetValue,\n} from \"./widget-accessible-properties.js\";\n\n/** The expected value for a text matcher: an exact string or a regular expression. */\ntype TextExpectation = string | RegExp;\ntype MatcherResult = { pass: boolean; message: () => string };\ntype TextMatcher = (received: unknown, expected?: TextExpectation) => MatcherResult;\ntype StateMatcher = (received: unknown) => MatcherResult;\ntype ValueMatcher = (received: unknown, expected: number) => MatcherResult;\ntype TextMatcherContext = { matcherName: string; widget: Gtk.Widget; actual: string | null };\n\ntype MatcherImplementations = {\n    toHaveDisplayValue: TextMatcher;\n    toHaveTextContent: TextMatcher;\n    toHaveAccessibleName: TextMatcher;\n    toHavePlaceholderText: TextMatcher;\n    toBeChecked: StateMatcher;\n    toBePressed: StateMatcher;\n    toBeExpanded: StateMatcher;\n    toBeSelected: StateMatcher;\n    toHaveValue: ValueMatcher;\n};\n\ntype ExpectExtend = { extend: (m: MatcherImplementations) => void };\n\nconst toHaveDisplayValue: TextMatcher = textMatcher(\"toHaveDisplayValue\", getWidgetDisplayValue, \"exact\");\n\nconst toHaveTextContent: TextMatcher = textMatcher(\n    \"toHaveTextContent\",\n    (widget) => getWidgetNodeText(widget) ?? getWidgetAccessibleName(widget),\n    \"substring\",\n);\n\nconst toHaveAccessibleName: TextMatcher = textMatcher(\"toHaveAccessibleName\", getWidgetAccessibleName, \"exact\");\n\nconst toHavePlaceholderText: TextMatcher = textMatcher(\n    \"toHavePlaceholderText\",\n    getWidgetPlaceholderText,\n    \"exact\",\n);\n\nconst toBeChecked: StateMatcher = booleanStateMatcher(\"toBeChecked\", \"checked\", getWidgetCheckedState);\nconst toBePressed: StateMatcher = booleanStateMatcher(\"toBePressed\", \"pressed\", getWidgetPressedState);\nconst toBeExpanded: StateMatcher = booleanStateMatcher(\"toBeExpanded\", \"expanded\", getWidgetExpandedState);\nconst toBeSelected: StateMatcher = booleanStateMatcher(\"toBeSelected\", \"selected\", getWidgetSelectedState);\n\n/** The widget assertion matchers keyed by name, suitable for passing to `expect.extend`. */\nconst matchers: MatcherImplementations = {\n    toHaveDisplayValue,\n    toHaveTextContent,\n    toHaveAccessibleName,\n    toHavePlaceholderText,\n    toBeChecked,\n    toBePressed,\n    toBeExpanded,\n    toBeSelected,\n    toHaveValue,\n};\n\nconst registration = { isRegistered: false };\n\nconst asWidget = (received: unknown, matcherName: string): Gtk.Widget => {\n    if (!(received instanceof Gtk.Widget)) {\n        throw new TypeError(`${matcherName}: received value must be a Gtk.Widget, got ${typeof received}`);\n    }\n\n    return received;\n};\n\nconst describeWidget = (widget: Gtk.Widget): string => {\n    const role = Gtk.AccessibleRole[widget.getAccessibleRole()];\n    const name = getWidgetAccessibleName(widget);\n\n    return name === null ? `<${role}>` : `<${role} name=${JSON.stringify(name)}>`;\n};\n\nconst isTextMatch = (actual: string, expected: TextExpectation, mode: \"exact\" | \"substring\"): boolean => {\n    if (expected instanceof RegExp) {\n        expected.lastIndex = 0;\n\n        return expected.test(actual);\n    }\n\n    return mode === \"exact\" ? actual === expected : actual.includes(expected);\n};\n\nconst describeExpected = (expected: TextExpectation): string =>\n    expected instanceof RegExp ? String(expected) : JSON.stringify(expected);\n\nconst negationPrefix = (isPass: boolean): string => (isPass ? \"not \" : \"\");\n\nconst nonEmptyResult = ({ matcherName, widget, actual }: TextMatcherContext): MatcherResult => {\n    const isPass = actual !== null && actual !== \"\";\n\n    return {\n        pass: isPass,\n        message: () =>\n            `expected widget ${negationPrefix(isPass)}to have a non-empty value for ${matcherName}, ` +\n            `but got ${JSON.stringify(actual)}\\n${describeWidget(widget)}`,\n    };\n};\n\nconst matchedResult = (context: TextMatcherContext, expected: TextExpectation, isPass: boolean): MatcherResult => ({\n    pass: isPass,\n    message: () =>\n        `expected widget ${negationPrefix(isPass)}${context.matcherName} ${describeExpected(expected)}, ` +\n        `but received ${JSON.stringify(context.actual)}\\n${describeWidget(context.widget)}`,\n});\n\nfunction textMatcher(\n    matcherName: string,\n    read: (widget: Gtk.Widget) => string | null,\n    mode: \"exact\" | \"substring\",\n): TextMatcher {\n    return (received: unknown, expected?: TextExpectation): MatcherResult => {\n        const widget = asWidget(received, matcherName);\n        const actual = read(widget);\n        const context: TextMatcherContext = { matcherName, widget, actual };\n\n        if (expected === undefined) {\n            return nonEmptyResult(context);\n        }\n\n        return matchedResult(context, expected, actual !== null && isTextMatch(actual, expected, mode));\n    };\n}\n\nfunction booleanStateMatcher(\n    matcherName: string,\n    stateName: string,\n    read: (widget: Gtk.Widget) => boolean | null,\n): StateMatcher {\n    return (received: unknown): MatcherResult => {\n        const widget = asWidget(received, matcherName);\n        const state = read(widget);\n\n        if (state === null) {\n            throw new Error(\n                `${matcherName}: widget does not expose a ${stateName} state ` +\n                `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\\n${describeWidget(widget)}`,\n            );\n        }\n\n        return {\n            pass: state,\n            message: () =>\n                `expected widget ${negationPrefix(state)}to be ${stateName}\\n${describeWidget(widget)}`,\n        };\n    };\n}\n\nfunction toHaveValue(received: unknown, expected: number): MatcherResult {\n    const widget = asWidget(received, \"toHaveValue\");\n    const actual = getWidgetValue(widget).now;\n\n    if (actual === null) {\n        throw new Error(\n            \"toHaveValue: widget does not expose a numeric value \" +\n            `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\\n${describeWidget(widget)}`,\n        );\n    }\n\n    const isPass = actual === expected;\n\n    return {\n        pass: isPass,\n        message: () =>\n            `expected widget ${negationPrefix(isPass)}to have value ${String(expected)}, ` +\n            `but received ${String(actual)}\\n${describeWidget(widget)}`,\n    };\n}\n\nconst globalExpect = (): ExpectExtend | null => {\n    const candidate: unknown = Reflect.get(globalThis, \"expect\");\n\n    if (candidate && typeof (candidate as ExpectExtend).extend === \"function\") {\n        return candidate as ExpectExtend;\n    }\n\n    return null;\n};\n\n/** Registers the widget matchers on the global `expect`, when one is available. Safe to call more than once. */\nconst registerMatchers = (): void => {\n    if (registration.isRegistered) {\n        return;\n    }\n\n    const expect = globalExpect();\n\n    if (!expect) {\n        return;\n    }\n\n    expect.extend(matchers);\n    registration.isRegistered = true;\n};\n\ndeclare module \"@vitest/expect\" {\n    /* eslint-disable @typescript-eslint/consistent-type-definitions -- declaration merging requires interfaces */\n    interface Assertion {\n        toHaveDisplayValue(expected?: TextExpectation): void;\n        toHaveTextContent(expected?: TextExpectation): void;\n        toHaveAccessibleName(expected?: TextExpectation): void;\n        toHavePlaceholderText(expected?: TextExpectation): void;\n        toBeChecked(): void;\n        toBePressed(): void;\n        toBeExpanded(): void;\n        toBeSelected(): void;\n        toHaveValue(expected: number): void;\n    }\n\n    interface AsymmetricMatchersContaining {\n        toHaveDisplayValue(expected?: TextExpectation): void;\n        toHaveTextContent(expected?: TextExpectation): void;\n        toHaveAccessibleName(expected?: TextExpectation): void;\n        toHavePlaceholderText(expected?: TextExpectation): void;\n        toBeChecked(): void;\n        toBePressed(): void;\n        toBeExpanded(): void;\n        toBeSelected(): void;\n        toHaveValue(expected: number): void;\n    }\n    /* eslint-enable @typescript-eslint/consistent-type-definitions */\n}\n\nexport {\n    toHaveDisplayValue,\n    toHaveTextContent,\n    toHaveAccessibleName,\n    toHavePlaceholderText,\n    toBeChecked,\n    toBePressed,\n    toBeExpanded,\n    toBeSelected,\n    matchers,\n    toHaveValue,\n    registerMatchers,\n    type TextExpectation,\n};\n"]}

package/dist/pretty-widget.d.ts

@@ -1,37 +1,35 @@
+import type * as Gtk from "@gtkx/gi/gtk";
 import { type Container } from "./traversal.js";
+type WidgetIdResolver = (widget: Gtk.Widget) => string;
 /**
- * Options for {@link prettyWidget}.
+ * Options controlling how a widget tree is rendered to a string by
+ * {@link prettyWidget} and {@link logWidget}.
  */
-export type PrettyWidgetOptions = {
-    /** Maximum output length before truncation (default: 7000) */
+type PrettyWidgetOptions = {
+    /** Truncates the output once it exceeds this many characters. */
     maxLength?: number;
-    /** Enable ANSI color highlighting (default: auto-detect) */
+    /** Whether to apply ANSI color highlighting; defaults to the terminal capabilities. */
     highlight?: boolean;
-    /** Include widget IDs for MCP/agentic interactions (default: false) */
-    includeIds?: boolean;
+    /** Resolves an `id` attribute to show for each widget. */
+    getId?: WidgetIdResolver;
+    /** Stops descending past this depth, replacing deeper children with a summary line. */
+    maxDepth?: number;
 };
 /**
- * Formats a widget tree as a readable string for debugging.
+ * Renders a widget tree as an indented, HTML-like string showing each widget's
+ * tag, accessible attributes, and text content.
  *
- * Renders the widget hierarchy in an HTML-like format with accessibility
- * attributes like role, name, and text content.
- *
- * @param container - The container widget or application to format
- * @param options - Formatting options for length and highlighting
- * @returns Formatted string representation of the widget tree
- *
- * @example
- * ```tsx
- * import { prettyWidget } from "@gtkx/testing";
+ * @param container The scope whose widget tree is formatted.
+ * @param options Formatting options such as truncation length and highlighting.
+ * @returns The formatted representation of the tree.
+ */
+declare const prettyWidget: (container: Container, options?: PrettyWidgetOptions) => string;
+/**
+ * Prints one or more widget trees to the console using {@link prettyWidget}.
  *
- * console.log(prettyWidget(application));
- * // Output:
- * // <GtkApplicationWindow role="window">
- * //   <GtkButton role="button">
- * //     Click me
- * //   </GtkButton>
- * // </GtkApplicationWindow>
- * ```
+ * @param container A single scope or an array of scopes to format and print.
+ * @param options Formatting options passed through to {@link prettyWidget}.
  */
-export declare const prettyWidget: (container: Container, options?: PrettyWidgetOptions) => string;
+declare const logWidget: (container: Container | Container[], options?: PrettyWidgetOptions) => void;
+export { prettyWidget, logWidget, type PrettyWidgetOptions };
 //# sourceMappingURL=pretty-widget.d.ts.map

package/dist/pretty-widget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pretty-widget.d.ts","sourceRoot":"","sources":["../src/pretty-widget.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAiB,MAAM,gBAAgB,CAAC;AAkB/D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAqIF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,YAAY,GAAI,WAAW,SAAS,EAAE,UAAS,mBAAwB,KAAG,MAkBtF,CAAC"}
+{"version":3,"file":"pretty-widget.d.ts","sourceRoot":"","sources":["../src/pretty-widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AAGzC,OAAO,EAAE,KAAK,SAAS,EAAS,MAAM,gBAAgB,CAAC;AAGvD,KAAK,gBAAgB,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC;AAEvD;;;GAGG;AACH,KAAK,mBAAmB,GAAG;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,uFAAuF;IACvF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AA4KF;;;;;;;GAOG;AACH,QAAA,MAAM,YAAY,GAAI,WAAW,SAAS,EAAE,UAAS,mBAAwB,KAAG,MAoB/E,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,SAAS,GAAI,WAAW,SAAS,GAAG,SAAS,EAAE,EAAE,UAAU,mBAAmB,KAAG,IAMtF,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,mBAAmB,EAAE,CAAC"}

package/dist/pretty-widget.js

@@ -1,161 +1,155 @@
-import * as Gtk from "@gtkx/ffi/gtk";
+import { sortStringsBy } from "@gtkx/utils";
 import { formatRole } from "./role-helpers.js";
-import { isApplication } from "./traversal.js";
-import { getWidgetPropertyText } from "./widget-text.js";
+import { roots } from "./traversal.js";
+import { getWidgetNodeText } from "./widget-accessible-properties.js";
 const DEFAULT_MAX_LENGTH = 7000;
 const INDENT = "  ";
-const debugIdMap = new WeakMap();
-let nextDebugId = 0;
-const getWidgetDebugId = (widget) => {
-    let id = debugIdMap.get(widget);
-    if (!id) {
-        id = String(nextDebugId++);
-        debugIdMap.set(widget, id);
-    }
-    return id;
+const ansi = {
+    cyan: "\u{1B}[36m",
+    yellow: "\u{1B}[33m",
+    green: "\u{1B}[32m",
+    reset: "\u{1B}[0m",
+};
+const buildAttrs = (widget, getId) => {
+    const attrs = [];
+    if (getId) {
+        attrs.push(["id", getId(widget)]);
+    }
+    const name = widget.getName();
+    if (name) {
+        attrs.push(["name", name]);
+    }
+    attrs.push(["role", formatRole(widget.getAccessibleRole())]);
+    if (!widget.getSensitive()) {
+        attrs.push(["accessible-disabled", "true"]);
+    }
+    if (!widget.getVisible()) {
+        attrs.push(["accessible-hidden", "true"]);
+    }
+    const idAttrs = attrs.filter(([key]) => key === "id");
+    const otherAttrs = sortStringsBy(attrs.filter(([key]) => key !== "id"), ([key]) => key);
+    return [...idAttrs, ...otherAttrs];
 };
 const shouldHighlight = () => {
-    if (typeof process === "undefined")
+    if (typeof process === "undefined") {
         return false;
-    if (process.env.COLORS === "false" || process.env.NO_COLOR)
+    }
+    if (process.env.COLORS === "false" || process.env.NO_COLOR) {
         return false;
-    if (process.env.COLORS === "true" || process.env.FORCE_COLOR)
+    }
+    if (process.env.COLORS === "true" || process.env.FORCE_COLOR) {
         return true;
-    return process.stdout?.isTTY ?? false;
-};
-const ansi = {
-    cyan: "\x1b[36m",
-    yellow: "\x1b[33m",
-    green: "\x1b[32m",
-    reset: "\x1b[0m",
+    }
+    return process.stdout.isTTY;
 };
-const createColors = (enabled) => {
-    if (!enabled) {
+const createColors = (isEnabled) => {
+    if (!isEnabled) {
         const identity = (s) => s;
-        return { tag: identity, attr: identity, value: identity, text: identity, reset: "" };
+        return { tag: identity, attr: identity, value: identity };
     }
     return {
         tag: (s) => `${ansi.cyan}${s}${ansi.reset}`,
         attr: (s) => `${ansi.yellow}${s}${ansi.reset}`,
         value: (s) => `${ansi.green}${s}${ansi.reset}`,
-        text: (s) => s,
-        reset: ansi.reset,
     };
 };
-const formatTagName = (widget) => {
-    return widget.constructor.name;
-};
-const escapeAttrValue = (value) => {
-    return value.replace(/"/g, """);
+const escapeAttrValue = (value) => value.replaceAll('"', """);
+const formatAttr = (key, value, colors) => {
+    const quoted = `"${escapeAttrValue(value)}"`;
+    return ` ${colors.attr(key)}=${colors.value(quoted)}`;
 };
-const formatAttributes = (widget, colors, includeIds) => {
-    const attrs = [];
-    if (includeIds) {
-        attrs.push(["id", getWidgetDebugId(widget)]);
-    }
-    const name = widget.getName();
-    if (name) {
-        attrs.push(["name", name]);
-    }
-    const role = widget.getAccessibleRole();
-    if (role !== undefined) {
-        attrs.push(["role", formatRole(role)]);
-    }
-    if (!widget.getSensitive()) {
-        attrs.push(["aria-disabled", "true"]);
-    }
-    if (!widget.getVisible()) {
-        attrs.push(["aria-hidden", "true"]);
+const formatAttrs = (attrs, colors) => attrs.map(([key, value]) => formatAttr(key, value, colors)).join("");
+const countChildren = (widget) => {
+    let count = 0;
+    let child = widget.getFirstChild();
+    while (child) {
+        count += 1;
+        child = child.getNextSibling();
     }
-    if (attrs.length === 0)
-        return "";
-    return attrs
-        .sort(([a], [b]) => {
-        if (a === "id")
-            return -1;
-        if (b === "id")
-            return 1;
-        return a.localeCompare(b);
-    })
-        .map(([key, value]) => ` ${colors.attr(key)}=${colors.value(`"${escapeAttrValue(value)}"`)}`)
-        .join("");
-};
-const hasChildren = (widget) => {
-    return widget.getFirstChild() !== null;
+    return count;
 };
-const printWidget = (widget, colors, depth, includeIds) => {
+const formatHiddenChildrenLine = (widget, depth, ctx) => {
+    const { getId, colors } = ctx;
     const indent = INDENT.repeat(depth);
-    const tagName = formatTagName(widget);
-    const attributes = formatAttributes(widget, colors, includeIds);
-    const text = getWidgetPropertyText(widget);
-    const children = [];
+    const count = countChildren(widget);
+    const hint = getId ? ` (pass rootId="${getId(widget)}" or raise maxDepth to expand)` : "";
+    const plural = count === 1 ? "" : "s";
+    const summary = `… ${String(count)} child widget${plural} hidden${hint}`;
+    return `${indent}${INDENT}${colors.tag(summary)}\n`;
+};
+const formatChildren = (widget, depth, ctx) => {
+    let output = "";
     let child = widget.getFirstChild();
     while (child) {
-        children.push(printWidget(child, colors, depth + 1, includeIds));
+        output += formatWidget(child, depth + 1, ctx);
         child = child.getNextSibling();
     }
-    const openTag = `${colors.tag("<")}${colors.tag(tagName)}${attributes}${colors.tag(">")}`;
-    if (!hasChildren(widget) && !text) {
+    return output;
+};
+const formatWidget = (widget, depth, ctx) => {
+    const { getId, colors, maxDepth } = ctx;
+    const indent = INDENT.repeat(depth);
+    const tag = widget.constructor.name;
+    const attrs = formatAttrs(buildAttrs(widget, getId), colors);
+    const openTag = `${colors.tag("<")}${colors.tag(tag)}${attrs}${colors.tag(">")}`;
+    const closeTag = `${colors.tag("</")}${colors.tag(tag)}${colors.tag(">")}`;
+    const text = getWidgetNodeText(widget);
+    const firstChild = widget.getFirstChild();
+    if (!text && !firstChild) {
         return `${indent}${openTag}\n`;
     }
-    const closeTag = `${colors.tag("</")}${colors.tag(tagName)}${colors.tag(">")}`;
-    if (text && !hasChildren(widget)) {
-        const textContent = colors.text(text);
-        return `${indent}${openTag}\n${indent}${INDENT}${textContent}\n${indent}${closeTag}\n`;
-    }
-    let result = `${indent}${openTag}\n`;
+    let output = `${indent}${openTag}\n`;
     if (text) {
-        result += `${indent}${INDENT}${colors.text(text)}\n`;
+        output += `${indent}${INDENT}${text}\n`;
     }
-    for (const childOutput of children) {
-        result += childOutput;
+    if (firstChild && maxDepth !== undefined && depth >= maxDepth) {
+        output += formatHiddenChildrenLine(widget, depth, ctx);
+        output += `${indent}${closeTag}\n`;
+        return output;
     }
-    result += `${indent}${closeTag}\n`;
-    return result;
+    output += formatChildren(widget, depth, ctx);
+    output += `${indent}${closeTag}\n`;
+    return output;
 };
-const printContainer = (container, colors, includeIds) => {
-    if (isApplication(container)) {
-        const windows = Gtk.Window.listToplevels();
-        return windows.map((window) => printWidget(window, colors, 0, includeIds)).join("");
-    }
-    return printWidget(container, colors, 0, includeIds);
+const resolveMaxLength = (options) => {
+    const envLimit = process.env.DEBUG_PRINT_LIMIT ? Number(process.env.DEBUG_PRINT_LIMIT) : DEFAULT_MAX_LENGTH;
+    return options.maxLength ?? envLimit;
 };
 /**
- * Formats a widget tree as a readable string for debugging.
- *
- * Renders the widget hierarchy in an HTML-like format with accessibility
- * attributes like role, name, and text content.
+ * Renders a widget tree as an indented, HTML-like string showing each widget's
+ * tag, accessible attributes, and text content.
  *
- * @param container - The container widget or application to format
- * @param options - Formatting options for length and highlighting
- * @returns Formatted string representation of the widget tree
- *
- * @example
- * ```tsx
- * import { prettyWidget } from "@gtkx/testing";
- *
- * console.log(prettyWidget(application));
- * // Output:
- * // <GtkApplicationWindow role="window">
- * //   <GtkButton role="button">
- * //     Click me
- * //   </GtkButton>
- * // </GtkApplicationWindow>
- * ```
+ * @param container The scope whose widget tree is formatted.
+ * @param options Formatting options such as truncation length and highlighting.
+ * @returns The formatted representation of the tree.
  */
-export const prettyWidget = (container, options = {}) => {
-    const envLimit = process.env.DEBUG_PRINT_LIMIT ? Number(process.env.DEBUG_PRINT_LIMIT) : DEFAULT_MAX_LENGTH;
-    const maxLength = options.maxLength ?? envLimit;
-    const highlight = options.highlight ?? shouldHighlight();
-    const includeIds = options.includeIds ?? false;
+const prettyWidget = (container, options = {}) => {
+    const maxLength = resolveMaxLength(options);
     if (maxLength === 0) {
         return "";
     }
-    const colors = createColors(highlight);
-    const output = printContainer(container, colors, includeIds);
+    const isHighlight = options.highlight ?? shouldHighlight();
+    const colors = createColors(isHighlight);
+    let output = "";
+    for (const root of roots(container)) {
+        output += formatWidget(root, 0, { getId: options.getId, colors, maxDepth: options.maxDepth });
+    }
     if (output.length > maxLength) {
         return `${output.slice(0, maxLength)}...`;
     }
     return output.trimEnd();
 };
+/**
+ * Prints one or more widget trees to the console using {@link prettyWidget}.
+ *
+ * @param container A single scope or an array of scopes to format and print.
+ * @param options Formatting options passed through to {@link prettyWidget}.
+ */
+const logWidget = (container, options) => {
+    const containers = Array.isArray(container) ? container : [container];
+    for (const target of containers) {
+        console.log(prettyWidget(target, options));
+    }
+};
+export { prettyWidget, logWidget };
 //# sourceMappingURL=pretty-widget.js.map