@gtkx/testing 1.0.0-rc.2 → 1.0.0-rc.4

package/dist/matchers.d.ts

@@ -1,59 +1,163 @@
+import * as Gtk from "@gtkx/gi/gtk";
 /** The expected value for a text matcher: an exact string or a regular expression. */
 type TextExpectation = string | RegExp;
+/** Options controlling how `toHaveTextContent` normalizes the text it reads. */
+type TextContentOptions = {
+    /**
+     * When true (the default), trim the text and collapse runs of whitespace into single spaces
+     * before comparing. When false, only replace non-breaking spaces with regular ones.
+     */
+    normalizeWhitespace?: boolean | undefined;
+};
+/** The expected value for a style class: an exact class name or a regular expression. */
+type ClassExpectation = string | RegExp;
+/** The outcome of a matcher: whether it passed, and the failure text built on demand. */
 type MatcherResult = {
     pass: boolean;
     message: () => string;
 };
+/** The matcher state bound as `this`, supplying the test runner's deep equality check. */
+type MatcherContext = {
+    equals: (actual: unknown, expected: unknown) => boolean;
+};
+/** Compares text read from the received widget; with no expected value, asserts the text is non-empty. */
 type TextMatcher = (received: unknown, expected?: TextExpectation) => MatcherResult;
+/** Asserts a single state of the received widget, taking no expected value. */
 type StateMatcher = (received: unknown) => MatcherResult;
-type ValueMatcher = (received: unknown, expected: number) => MatcherResult;
+/** A text matcher that also takes normalization options for the text it reads. */
+type TextContentMatcher = (received: unknown, expected?: TextExpectation, options?: TextContentOptions) => MatcherResult;
+/** Signatures of the widget assertion matchers, keyed by the name each is registered under. */
 type MatcherImplementations = {
+    /** Asserts the text an editable widget or combo box shows; with no argument, that it is not empty. */
     toHaveDisplayValue: TextMatcher;
-    toHaveTextContent: TextMatcher;
+    /** Asserts the widget's own text, or its descendants' when it has none, contains or matches the expectation. */
+    toHaveTextContent: TextContentMatcher;
+    /** Asserts the widget's accessible name; with no argument, that it has one. */
     toHaveAccessibleName: TextMatcher;
+    /**
+     * Asserts the joined accessible names of the widget's `described-by` targets, falling back to its
+     * `description` and then to its tooltip.
+     */
+    toHaveAccessibleDescription: TextMatcher;
+    /** Asserts the joined accessible names of the widget's `error-message` targets, read only while it is invalid. */
+    toHaveAccessibleErrorMessage: TextMatcher;
+    /** Asserts the widget's placeholder text; with no argument, that it has some. */
     toHavePlaceholderText: TextMatcher;
+    /** Asserts the text currently selected in an editable widget. */
+    toHaveSelection: TextMatcher;
+    /** Asserts the widget's checked state is checked rather than unchecked or mixed. */
     toBeChecked: StateMatcher;
+    /** Asserts the widget's checked state is mixed. */
+    toBePartiallyChecked: StateMatcher;
+    /** Asserts a `Gtk.ToggleButton` is active, and throws for any other widget. */
     toBePressed: StateMatcher;
+    /** Asserts a `Gtk.Expander` or the row behind a `Gtk.TreeExpander` is expanded, and throws for anything else. */
     toBeExpanded: StateMatcher;
+    /**
+     * Asserts a `Gtk.ListBoxRow` or `Gtk.FlowBoxChild` is selected, or that a widget in a selectable role
+     * carries the selected state flag, and throws for anything else.
+     */
     toBeSelected: StateMatcher;
-    toHaveValue: ValueMatcher;
+    /** Asserts the widget is insensitive, or sits inside an insensitive ancestor. */
+    toBeDisabled: StateMatcher;
+    /** Asserts the widget and all of its ancestors are sensitive. */
+    toBeEnabled: StateMatcher;
+    /** Asserts the widget and its ancestors are all visible, and that none of them is fully transparent. */
+    toBeVisible: StateMatcher;
+    /** Asserts the widget's root is a window that is still in the toplevel list. */
+    toBeRooted: StateMatcher;
+    /** Asserts the widget has neither a child nor label text. */
+    toBeEmpty: StateMatcher;
+    /** Asserts the widget's accessible invalid state is set to anything other than false. */
+    toBeInvalid: StateMatcher;
+    /** Asserts the widget's accessible invalid state is unset or false. */
+    toBeValid: StateMatcher;
+    /** Asserts the widget's accessible required state. */
+    toBeRequired: StateMatcher;
+    /** Asserts the widget holds the platform focus state. */
+    toHaveFocus: StateMatcher;
+    /** Asserts a widget's numeric value, or its display value when a string is given. */
+    toHaveValue: (received: unknown, expected?: number | string) => MatcherResult;
+    /** Asserts the widget's accessible role. */
+    toHaveRole: (received: unknown, expected: Gtk.AccessibleRole) => MatcherResult;
+    /** Asserts the widget is, or is an ancestor of, the given widget. */
+    toContainElement: (received: unknown, descendant: Gtk.Widget | null) => MatcherResult;
+    /**
+     * Asserts the widget carries every given style class, each a name, a space-separated list, or a pattern.
+     * Pass `{ exact: true }` last to require exactly that set, which rules out patterns.
+     */
+    toHaveClass: (received: unknown, ...args: unknown[]) => MatcherResult;
+    /**
+     * Asserts a GObject property, named as in GObject and looked up by its camel-cased accessor, equals the
+     * expected value. With no expected value, asserts the property is set. GObject values compare by identity.
+     */
+    toHaveObjectProperty: (this: MatcherContext, received: unknown, ...args: unknown[]) => MatcherResult;
 };
-declare const toHaveDisplayValue: TextMatcher;
-declare const toHaveTextContent: TextMatcher;
 declare const toHaveAccessibleName: TextMatcher;
+declare const toHaveAccessibleDescription: TextMatcher;
+declare const toHaveAccessibleErrorMessage: TextMatcher;
 declare const toHavePlaceholderText: TextMatcher;
-declare const toBeChecked: StateMatcher;
+declare const toHaveSelection: TextMatcher;
 declare const toBePressed: StateMatcher;
 declare const toBeExpanded: StateMatcher;
 declare const toBeSelected: StateMatcher;
+declare const toBeRequired: 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;
+declare function toHaveTextContent(received: unknown, expected?: TextExpectation, options?: TextContentOptions): MatcherResult;
+declare function toBeChecked(received: unknown): MatcherResult;
+declare function toBePartiallyChecked(received: unknown): MatcherResult;
+declare function toHaveDisplayValue(received: unknown, expected?: TextExpectation): MatcherResult;
+declare function toHaveValue(received: unknown, expected?: number | string): MatcherResult;
+declare function toBeDisabled(received: unknown): MatcherResult;
+declare function toBeEnabled(received: unknown): MatcherResult;
+declare function toBeVisible(received: unknown): MatcherResult;
+declare function toBeRooted(received: unknown): MatcherResult;
+declare function toBeEmpty(received: unknown): MatcherResult;
+declare function toBeInvalid(received: unknown): MatcherResult;
+declare function toBeValid(received: unknown): MatcherResult;
+declare function toHaveFocus(received: unknown): MatcherResult;
+declare function toHaveRole(received: unknown, expected: Gtk.AccessibleRole): MatcherResult;
+declare function toContainElement(received: unknown, descendant: Gtk.Widget | null): MatcherResult;
+declare function toHaveClass(received: unknown, ...args: unknown[]): MatcherResult;
+declare function toHaveObjectProperty(this: MatcherContext, received: unknown, ...args: unknown[]): 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 {
+    interface WidgetMatchers {
         toHaveDisplayValue(expected?: TextExpectation): void;
-        toHaveTextContent(expected?: TextExpectation): void;
+        toHaveTextContent(expected?: TextExpectation, options?: TextContentOptions): void;
         toHaveAccessibleName(expected?: TextExpectation): void;
+        toHaveAccessibleDescription(expected?: TextExpectation): void;
+        toHaveAccessibleErrorMessage(expected?: TextExpectation): void;
         toHavePlaceholderText(expected?: TextExpectation): void;
+        toHaveSelection(expected?: TextExpectation): void;
         toBeChecked(): void;
+        toBePartiallyChecked(): void;
         toBePressed(): void;
         toBeExpanded(): void;
         toBeSelected(): void;
-        toHaveValue(expected: number): void;
+        toBeDisabled(): void;
+        toBeEnabled(): void;
+        toBeVisible(): void;
+        toBeRooted(): void;
+        toBeEmpty(): void;
+        toBeInvalid(): void;
+        toBeValid(): void;
+        toBeRequired(): void;
+        toHaveFocus(): void;
+        toHaveValue(expected?: number | string): void;
+        toHaveRole(expected: Gtk.AccessibleRole): void;
+        toContainElement(descendant: Gtk.Widget | null): void;
+        toHaveClass(...args: (ClassExpectation | {
+            exact: boolean;
+        })[]): void;
+        toHaveObjectProperty(name: string, expected?: unknown): 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;
+    interface Assertion extends WidgetMatchers {
+    }
+    interface AsymmetricMatchersContaining extends WidgetMatchers {
     }
 }
-export { toHaveDisplayValue, toHaveTextContent, toHaveAccessibleName, toHavePlaceholderText, toBeChecked, toBePressed, toBeExpanded, toBeSelected, matchers, toHaveValue, registerMatchers, type TextExpectation, };
+export { toHaveDisplayValue, toHaveTextContent, toHaveAccessibleName, toHaveAccessibleDescription, toHaveAccessibleErrorMessage, toHavePlaceholderText, toHaveSelection, toBeChecked, toBePartiallyChecked, toBePressed, toBeExpanded, toBeSelected, toBeDisabled, toBeEnabled, toBeVisible, toBeRooted, toBeEmpty, toBeInvalid, toBeValid, toBeRequired, toHaveFocus, toHaveValue, toHaveRole, toContainElement, toHaveClass, toHaveObjectProperty, matchers, registerMatchers, type ClassExpectation, type TextContentOptions, type TextExpectation, };
 //# sourceMappingURL=matchers.d.ts.map

package/dist/matchers.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"matchers.d.ts","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAyBpC,sFAAsF;AACtF,KAAK,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvC,gFAAgF;AAChF,KAAK,kBAAkB,GAAG;IACtB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7C,CAAC;AAEF,yFAAyF;AACzF,KAAK,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AACxC,yFAAyF;AACzF,KAAK,aAAa,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,MAAM,CAAA;CAAE,CAAC;AAC9D,0FAA0F;AAC1F,KAAK,cAAc,GAAG;IAAE,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;CAAE,CAAC;AAClF,0GAA0G;AAC1G,KAAK,WAAW,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,eAAe,KAAK,aAAa,CAAC;AACpF,+EAA+E;AAC/E,KAAK,YAAY,GAAG,CAAC,QAAQ,EAAE,OAAO,KAAK,aAAa,CAAC;AAIzD,kFAAkF;AAClF,KAAK,kBAAkB,GAAG,CACtB,QAAQ,EAAE,OAAO,EACjB,QAAQ,CAAC,EAAE,eAAe,EAC1B,OAAO,CAAC,EAAE,kBAAkB,KAC3B,aAAa,CAAC;AAEnB,+FAA+F;AAC/F,KAAK,sBAAsB,GAAG;IAC1B,sGAAsG;IACtG,kBAAkB,EAAE,WAAW,CAAC;IAChC,gHAAgH;IAChH,iBAAiB,EAAE,kBAAkB,CAAC;IACtC,+EAA+E;IAC/E,oBAAoB,EAAE,WAAW,CAAC;IAClC;;;OAGG;IACH,2BAA2B,EAAE,WAAW,CAAC;IACzC,kHAAkH;IAClH,4BAA4B,EAAE,WAAW,CAAC;IAC1C,iFAAiF;IACjF,qBAAqB,EAAE,WAAW,CAAC;IACnC,iEAAiE;IACjE,eAAe,EAAE,WAAW,CAAC;IAC7B,oFAAoF;IACpF,WAAW,EAAE,YAAY,CAAC;IAC1B,mDAAmD;IACnD,oBAAoB,EAAE,YAAY,CAAC;IACnC,+EAA+E;IAC/E,WAAW,EAAE,YAAY,CAAC;IAC1B,iHAAiH;IACjH,YAAY,EAAE,YAAY,CAAC;IAC3B;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B,iFAAiF;IACjF,YAAY,EAAE,YAAY,CAAC;IAC3B,iEAAiE;IACjE,WAAW,EAAE,YAAY,CAAC;IAC1B,wGAAwG;IACxG,WAAW,EAAE,YAAY,CAAC;IAC1B,gFAAgF;IAChF,UAAU,EAAE,YAAY,CAAC;IACzB,6DAA6D;IAC7D,SAAS,EAAE,YAAY,CAAC;IACxB,yFAAyF;IACzF,WAAW,EAAE,YAAY,CAAC;IAC1B,uEAAuE;IACvE,SAAS,EAAE,YAAY,CAAC;IACxB,sDAAsD;IACtD,YAAY,EAAE,YAAY,CAAC;IAC3B,yDAAyD;IACzD,WAAW,EAAE,YAAY,CAAC;IAC1B,qFAAqF;IACrF,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,KAAK,aAAa,CAAC;IAC9E,4CAA4C;IAC5C,UAAU,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,cAAc,KAAK,aAAa,CAAC;IAC/E,qEAAqE;IACrE,gBAAgB,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,CAAC,MAAM,GAAG,IAAI,KAAK,aAAa,CAAC;IACtF;;;OAGG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,aAAa,CAAC;IACtE;;;OAGG;IACH,oBAAoB,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,aAAa,CAAC;CACxG,CAAC;AAMF,QAAA,MAAM,oBAAoB,EAAE,WAAmF,CAAC;AAEhH,QAAA,MAAM,2BAA2B,EAAE,WAIlC,CAAC;AAEF,QAAA,MAAM,4BAA4B,EAAE,WAInC,CAAC;AAEF,QAAA,MAAM,qBAAqB,EAAE,WAAqF,CAAC;AACnH,QAAA,MAAM,eAAe,EAAE,WAAyE,CAAC;AACjG,QAAA,MAAM,WAAW,EAAE,YAAmF,CAAC;AACvG,QAAA,MAAM,YAAY,EAAE,YAAsF,CAAC;AAC3G,QAAA,MAAM,YAAY,EAAE,YAAsF,CAAC;AAC3G,QAAA,MAAM,YAAY,EAAE,YAAsF,CAAC;AAE3G,4FAA4F;AAC5F,QAAA,MAAM,QAAQ,EAAE,sBA2Bf,CAAC;AAsNF,iBAAS,iBAAiB,CACtB,QAAQ,EAAE,OAAO,EACjB,QAAQ,CAAC,EAAE,eAAe,EAC1B,OAAO,CAAC,EAAE,kBAAkB,GAC7B,aAAa,CAIf;AAoCD,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAIrD;AAED,iBAAS,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAI9D;AAED,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,aAAa,CAQxF;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,CAqBjF;AAED,iBAAS,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAItD;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAIrD;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAIrD;AAED,iBAAS,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAQpD;AAED,iBAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAInD;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAKrD;AAED,iBAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAKnD;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,aAAa,CAIrD;AAED,iBAAS,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,cAAc,GAAG,aAAa,CAWlF;AAED,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,CAAC,MAAM,GAAG,IAAI,GAAG,aAAa,CAUzF;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,aAAa,CAqBzE;AAED,iBAAS,oBAAoB,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,aAAa,CA0BxG;AAED,gHAAgH;AAChH,QAAA,MAAM,gBAAgB,QAAO,IAa5B,CAAC;AAEF,OAAO,QAAQ,gBAAgB,CAAC;IAE5B,UAAU,cAAc;QACpB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACrD,iBAAiB,CAAC,QAAQ,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;QAClF,oBAAoB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACvD,2BAA2B,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QAC9D,4BAA4B,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QAC/D,qBAAqB,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QACxD,eAAe,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;QAClD,WAAW,IAAI,IAAI,CAAC;QACpB,oBAAoB,IAAI,IAAI,CAAC;QAC7B,WAAW,IAAI,IAAI,CAAC;QACpB,YAAY,IAAI,IAAI,CAAC;QACrB,YAAY,IAAI,IAAI,CAAC;QACrB,YAAY,IAAI,IAAI,CAAC;QACrB,WAAW,IAAI,IAAI,CAAC;QACpB,WAAW,IAAI,IAAI,CAAC;QACpB,UAAU,IAAI,IAAI,CAAC;QACnB,SAAS,IAAI,IAAI,CAAC;QAClB,WAAW,IAAI,IAAI,CAAC;QACpB,SAAS,IAAI,IAAI,CAAC;QAClB,YAAY,IAAI,IAAI,CAAC;QACrB,WAAW,IAAI,IAAI,CAAC;QACpB,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;QAC9C,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC;QAC/C,gBAAgB,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;QACtD,WAAW,CAAC,GAAG,IAAI,EAAE,CAAC,gBAAgB,GAAG;YAAE,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC,EAAE,GAAG,IAAI,CAAC;QACtE,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAChE;IAED,UAAU,SAAU,SAAQ,cAAc;KAAG;IAC7C,UAAU,4BAA6B,SAAQ,cAAc;KAAG;CAEnE;AAED,OAAO,EACH,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,WAAW,EACX,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,oBAAoB,EACpB,QAAQ,EACR,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,eAAe,GACvB,CAAC"}

package/dist/matchers.js

@@ -1,38 +1,67 @@
 /// <reference types="@vitest/expect" />
+import * as GObject from "@gtkx/gi/gobject";
 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");
+import { getDefaultNormalizer } from "./normalize.js";
+import { formatRole } from "./role-helpers.js";
+import { getWidgetAccessibleName, getWidgetCheckedState, getWidgetDescribedByText, getWidgetDisplayValue, getWidgetErrorMessage, getWidgetExpandedState, getWidgetInvalidState, getWidgetLabelText, getWidgetPlaceholderText, getWidgetPressedState, getWidgetRequiredState, getWidgetSelectedState, getWidgetSelection, getWidgetTextContent, getWidgetValue, hasDisplayValue, isWidgetDisabled, isWidgetVisible, } from "./widget-accessible-properties.js";
+const registration = { isRegistered: false };
+const displayValueMatcher = textMatcher("toHaveDisplayValue", getWidgetDisplayValue, "exact");
 const toHaveAccessibleName = textMatcher("toHaveAccessibleName", getWidgetAccessibleName, "exact");
+const toHaveAccessibleDescription = textMatcher("toHaveAccessibleDescription", getWidgetDescribedByText, "exact");
+const toHaveAccessibleErrorMessage = textMatcher("toHaveAccessibleErrorMessage", readErrorMessageText, "exact");
 const toHavePlaceholderText = textMatcher("toHavePlaceholderText", getWidgetPlaceholderText, "exact");
-const toBeChecked = booleanStateMatcher("toBeChecked", "checked", getWidgetCheckedState);
+const toHaveSelection = textMatcher("toHaveSelection", getWidgetSelection, "exact");
 const toBePressed = booleanStateMatcher("toBePressed", "pressed", getWidgetPressedState);
 const toBeExpanded = booleanStateMatcher("toBeExpanded", "expanded", getWidgetExpandedState);
 const toBeSelected = booleanStateMatcher("toBeSelected", "selected", getWidgetSelectedState);
+const toBeRequired = booleanStateMatcher("toBeRequired", "required", getWidgetRequiredState);
 /** The widget assertion matchers keyed by name, suitable for passing to `expect.extend`. */
 const matchers = {
     toHaveDisplayValue,
     toHaveTextContent,
     toHaveAccessibleName,
+    toHaveAccessibleDescription,
+    toHaveAccessibleErrorMessage,
     toHavePlaceholderText,
+    toHaveSelection,
     toBeChecked,
+    toBePartiallyChecked,
     toBePressed,
     toBeExpanded,
     toBeSelected,
+    toBeDisabled,
+    toBeEnabled,
+    toBeVisible,
+    toBeRooted,
+    toBeEmpty,
+    toBeInvalid,
+    toBeValid,
+    toBeRequired,
+    toHaveFocus,
     toHaveValue,
+    toHaveRole,
+    toContainElement,
+    toHaveClass,
+    toHaveObjectProperty,
 };
-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 asObject = (received, matcherName) => {
+    if (!(received instanceof GObject.Object)) {
+        throw new TypeError(`${matcherName}: received value must be a GObject, 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 describeObject = (object) => object instanceof Gtk.Widget ? describeWidget(object) : `<${object.constructor.name}>`;
 const isTextMatch = (actual, expected, mode) => {
     if (expected instanceof RegExp) {
         expected.lastIndex = 0;
@@ -55,6 +84,89 @@ const matchedResult = (context, expected, isPass) => ({
     message: () => `expected widget ${negationPrefix(isPass)}${context.matcherName} ${describeExpected(expected)}, ` +
         `but received ${JSON.stringify(context.actual)}\n${describeWidget(context.widget)}`,
 });
+const stateResult = (widget, stateName, isPass) => ({
+    pass: isPass,
+    message: () => `expected widget ${negationPrefix(isPass)}to be ${stateName}\n${describeWidget(widget)}`,
+});
+const camelCase = (name) => name.replaceAll(/-([a-z])/g, (_match, letter) => letter.toUpperCase());
+const isAsymmetricMatcher = (value) => typeof value === "object" && value !== null && typeof Reflect.get(value, "asymmetricMatch") === "function";
+const isEqualValue = (context, actual, expected) => {
+    if (isAsymmetricMatcher(expected)) {
+        return context.equals(actual, expected);
+    }
+    if (actual instanceof GObject.Object || expected instanceof GObject.Object) {
+        return Object.is(actual, expected);
+    }
+    return context.equals(actual, expected);
+};
+const isClassMatch = (actual, expected) => expected instanceof RegExp ? actual.some((name) => expected.test(name)) : actual.includes(expected);
+const isWidgetRooted = (widget) => {
+    const root = widget.getRoot();
+    if (root === null) {
+        return false;
+    }
+    if (root instanceof Gtk.Window) {
+        return Gtk.Window.listToplevels().includes(root);
+    }
+    return true;
+};
+const globalExpect = () => {
+    const candidate = Reflect.get(globalThis, "expect");
+    if (candidate && typeof candidate.extend === "function") {
+        return candidate;
+    }
+    return null;
+};
+function readErrorMessageText(widget) {
+    const state = getWidgetInvalidState(widget);
+    if (state === null || state === Gtk.AccessibleInvalidState.FALSE) {
+        return null;
+    }
+    const targets = getWidgetErrorMessage(widget);
+    if (targets === null) {
+        return null;
+    }
+    const texts = targets.map((target) => getWidgetAccessibleName(target)).filter((text) => text !== null);
+    return texts.length > 0 ? texts.join(" ") : null;
+}
+function assertReadableProperty(object, name, property, value) {
+    if (typeof value === "function") {
+        throw new TypeError(`toHaveObjectProperty: "${name}" is shadowed by a method of the same name; ` +
+            `call ${property}() and assert on its result instead`);
+    }
+    if (value === undefined && !Reflect.has(object, property)) {
+        throw new TypeError(`toHaveObjectProperty: no readable property "${name}" on ${describeObject(object)}; ` +
+            "construct-only and write-only properties cannot be read back");
+    }
+}
+function readObjectProperty(object, name) {
+    const property = camelCase(name);
+    const value = Reflect.get(object, property);
+    assertReadableProperty(object, name, property, value);
+    return value;
+}
+function classEntries(entry) {
+    return entry instanceof RegExp ? [entry] : String(entry).split(/\s+/).filter(Boolean);
+}
+function parseClassArguments(args) {
+    const last = args.at(-1);
+    const isOptions = typeof last === "object" && last !== null && !(last instanceof RegExp);
+    const isExact = isOptions && Reflect.get(last, "exact") === true;
+    const entries = isOptions ? args.slice(0, -1) : args;
+    return { expected: entries.flatMap((entry) => classEntries(entry)), isExact };
+}
+function exactClassResult(widget, actual, expected) {
+    if (expected.some((entry) => entry instanceof RegExp)) {
+        throw new TypeError("toHaveClass: the exact option cannot be combined with a regular expression");
+    }
+    const names = expected.map(String);
+    const isPass = names.length === actual.length && names.every((name) => actual.includes(name));
+    return {
+        pass: isPass,
+        message: () => `expected widget ${negationPrefix(isPass)}to have exactly the classes ${JSON.stringify(names)}, ` +
+            `but received ${JSON.stringify(actual)}\n${describeWidget(widget)}`,
+    };
+}
 function textMatcher(matcherName, read, mode) {
     return (received, expected) => {
         const widget = asWidget(received, matcherName);
@@ -66,41 +178,166 @@ function textMatcher(matcherName, read, mode) {
         return matchedResult(context, expected, actual !== null && isTextMatch(actual, expected, mode));
     };
 }
+function normalizeTextContent(text, options) {
+    if (options?.normalizeWhitespace === false) {
+        return text.replaceAll("\u{A0}", " ");
+    }
+    return getDefaultNormalizer()(text);
+}
+function readTextContent(widget, options) {
+    const text = getWidgetTextContent(widget);
+    return text === null ? null : normalizeTextContent(text, options);
+}
+function toHaveTextContent(received, expected, options) {
+    const read = (widget) => readTextContent(widget, options);
+    return textMatcher("toHaveTextContent", read, "substring")(received, expected);
+}
+function notApplicable(matcherName, stateName, widget) {
+    return new Error(`${matcherName}: widget does not expose a ${stateName} ` +
+        `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\n${describeWidget(widget)}`);
+}
 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)}`);
+            throw notApplicable(matcherName, `${stateName} state`, widget);
         }
-        return {
-            pass: state,
-            message: () => `expected widget ${negationPrefix(state)}to be ${stateName}\n${describeWidget(widget)}`,
-        };
+        return stateResult(widget, stateName, state);
     };
 }
+function readCheckedState(widget, matcherName) {
+    const state = getWidgetCheckedState(widget);
+    if (state === null) {
+        throw notApplicable(matcherName, "checked state", widget);
+    }
+    return state;
+}
+function toBeChecked(received) {
+    const widget = asWidget(received, "toBeChecked");
+    return stateResult(widget, "checked", readCheckedState(widget, "toBeChecked") === "checked");
+}
+function toBePartiallyChecked(received) {
+    const widget = asWidget(received, "toBePartiallyChecked");
+    return stateResult(widget, "partially checked", readCheckedState(widget, "toBePartiallyChecked") === "mixed");
+}
+function toHaveDisplayValue(received, expected) {
+    const widget = asWidget(received, "toHaveDisplayValue");
+    if (!hasDisplayValue(widget)) {
+        throw notApplicable("toHaveDisplayValue", "display value", widget);
+    }
+    return displayValueMatcher(received, expected);
+}
 function toHaveValue(received, expected) {
     const widget = asWidget(received, "toHaveValue");
+    if (typeof expected === "string") {
+        return displayValueMatcher(received, expected);
+    }
     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)}`);
+        throw notApplicable("toHaveValue", "numeric value", widget);
     }
-    const isPass = actual === expected;
+    const isPass = expected === undefined || 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;
+function toBeDisabled(received) {
+    const widget = asWidget(received, "toBeDisabled");
+    return stateResult(widget, "disabled", isWidgetDisabled(widget));
+}
+function toBeEnabled(received) {
+    const widget = asWidget(received, "toBeEnabled");
+    return stateResult(widget, "enabled", !isWidgetDisabled(widget));
+}
+function toBeVisible(received) {
+    const widget = asWidget(received, "toBeVisible");
+    return stateResult(widget, "visible", isWidgetVisible(widget));
+}
+function toBeRooted(received) {
+    if (received === null) {
+        return { pass: false, message: () => "expected a widget to be rooted in a window, but received null" };
     }
-    return null;
-};
+    const widget = asWidget(received, "toBeRooted");
+    return stateResult(widget, "rooted in a window", isWidgetRooted(widget));
+}
+function toBeEmpty(received) {
+    const widget = asWidget(received, "toBeEmpty");
+    return stateResult(widget, "empty", widget.getFirstChild() === null && getWidgetLabelText(widget) === null);
+}
+function toBeInvalid(received) {
+    const widget = asWidget(received, "toBeInvalid");
+    const state = getWidgetInvalidState(widget);
+    return stateResult(widget, "invalid", state !== null && state !== Gtk.AccessibleInvalidState.FALSE);
+}
+function toBeValid(received) {
+    const widget = asWidget(received, "toBeValid");
+    const state = getWidgetInvalidState(widget);
+    return stateResult(widget, "valid", state === null || state === Gtk.AccessibleInvalidState.FALSE);
+}
+function toHaveFocus(received) {
+    const widget = asWidget(received, "toHaveFocus");
+    return stateResult(widget, "focused", widget.getPlatformState(Gtk.AccessiblePlatformState.FOCUSED));
+}
+function toHaveRole(received, expected) {
+    const widget = asWidget(received, "toHaveRole");
+    const actual = widget.getAccessibleRole();
+    const isPass = actual === expected;
+    return {
+        pass: isPass,
+        message: () => `expected widget ${negationPrefix(isPass)}to have role '${formatRole(expected)}', ` +
+            `but received '${formatRole(actual)}'\n${describeWidget(widget)}`,
+    };
+}
+function toContainElement(received, descendant) {
+    const widget = asWidget(received, "toContainElement");
+    const isPass = descendant !== null && (descendant === widget || descendant.isAncestor(widget));
+    return {
+        pass: isPass,
+        message: () => `expected widget ${negationPrefix(isPass)}to contain ` +
+            `${descendant === null ? "null" : describeWidget(descendant)}\n${describeWidget(widget)}`,
+    };
+}
+function toHaveClass(received, ...args) {
+    const widget = asWidget(received, "toHaveClass");
+    const actual = widget.getCssClasses();
+    const { expected, isExact } = parseClassArguments(args);
+    if (isExact) {
+        return exactClassResult(widget, actual, expected);
+    }
+    if (expected.length === 0) {
+        return stateResult(widget, "given any style class", actual.length > 0);
+    }
+    const isPass = expected.every((entry) => isClassMatch(actual, entry));
+    return {
+        pass: isPass,
+        message: () => `expected widget ${negationPrefix(isPass)}to have class ${expected.map(String).join(", ")}, ` +
+            `but received ${JSON.stringify(actual)}\n${describeWidget(widget)}`,
+    };
+}
+function toHaveObjectProperty(received, ...args) {
+    const object = asObject(received, "toHaveObjectProperty");
+    const [name, expected] = args;
+    const actual = readObjectProperty(object, String(name));
+    if (args.length < 2) {
+        const isSet = actual !== null && actual !== undefined;
+        return {
+            pass: isSet,
+            message: () => `expected ${describeObject(object)} ${negationPrefix(isSet)}to have a value for property ` +
+                `"${String(name)}", but received ${JSON.stringify(actual)}`,
+        };
+    }
+    /* eslint-disable-next-line unicorn/no-this-outside-of-class --
+       expect.extend invokes matchers with the matcher state as `this` */
+    const isPass = isEqualValue(this, actual, expected);
+    return {
+        pass: isPass,
+        message: () => `expected ${describeObject(object)} ${negationPrefix(isPass)}to have property "${String(name)}" ` +
+            `equal to ${JSON.stringify(expected)}, but received ${JSON.stringify(actual)}`,
+    };
+}
 /** Registers the widget matchers on the global `expect`, when one is available. Safe to call more than once. */
 const registerMatchers = () => {
     if (registration.isRegistered) {
@@ -113,5 +350,5 @@ const registerMatchers = () => {
     expect.extend(matchers);
     registration.isRegistered = true;
 };
-export { toHaveDisplayValue, toHaveTextContent, toHaveAccessibleName, toHavePlaceholderText, toBeChecked, toBePressed, toBeExpanded, toBeSelected, matchers, toHaveValue, registerMatchers, };
+export { toHaveDisplayValue, toHaveTextContent, toHaveAccessibleName, toHaveAccessibleDescription, toHaveAccessibleErrorMessage, toHavePlaceholderText, toHaveSelection, toBeChecked, toBePartiallyChecked, toBePressed, toBeExpanded, toBeSelected, toBeDisabled, toBeEnabled, toBeVisible, toBeRooted, toBeEmpty, toBeInvalid, toBeValid, toBeRequired, toHaveFocus, toHaveValue, toHaveRole, toContainElement, toHaveClass, toHaveObjectProperty, matchers, registerMatchers, };
 //# sourceMappingURL=matchers.js.map