@gtkx/testing 1.0.0-rc.3 → 1.0.0

package/dist/types.d.ts

@@ -50,72 +50,106 @@ type MatcherOptions<T extends Gtk.Widget = Gtk.Widget> = {
     /** Restricts matches to instances of this widget class, and narrows the query's return type to it. */
     as?: WidgetType<T> | undefined;
 } & WaitForOptions;
-/** Constraints on a widget's numeric range value used by role queries. */
+/**
+ * Constraints on a widget's numeric range value used by role queries. The numbers come from the
+ * accessibility tree and match within 0.001, the resolution GTK keeps them to.
+ */
 type ByRoleValue = {
     /** The current value. */
     now?: number | undefined;
+    /** The lower bound of the value's range. */
     min?: number | undefined;
+    /**
+     * The highest value the widget can reach, which on a paged widget such as a scrollbar is its
+     * adjustment's upper bound less one page.
+     */
     max?: number | undefined;
     /** Matcher for the value's textual representation. */
     text?: Matcher | undefined;
 };
 /** Options for role queries: an accessible name matcher plus accessible state and value constraints. */
 type ByRoleOptions<T extends Gtk.Widget = Gtk.Widget> = MatcherOptions<T> & {
+    /** Matcher for the widget's accessible name. */
     name?: Matcher | undefined;
+    /** Required checked state; a mixed check button reads as neither, so it matches neither value. */
     checked?: boolean | undefined;
+    /** Required active state of a toggle button; any other widget matches neither value. */
     pressed?: boolean | undefined;
+    /** Required selected state of a row, list item, grid cell, option or tree item. */
     selected?: boolean | undefined;
+    /** Required expanded state of an expander or tree expander. */
     expanded?: boolean | undefined;
     /** Heading or hierarchy level. */
     level?: number | undefined;
+    /** Required busy state, which an unset state satisfies as false. */
     busy?: boolean | undefined;
+    /** Matcher for the widget's own accessible description, ignoring its `described-by` targets. */
     description?: Matcher | undefined;
+    /** Constraints on the widget's range value, each checked only when given. */
     value?: ByRoleValue | undefined;
-    /** When true, include widgets excluded from the accessibility tree. */
+    /** When true, include widgets excluded from the accessibility tree. Widgets that are not mapped stay excluded. */
     hidden?: boolean | undefined;
 };
 /** A React component that wraps rendered content, receiving it as its children. */
 type WrapperComponent = ComponentType<{
     children: ReactNode;
 }>;
+/** A custom query, taking the scope to search as its first argument and its matcher arguments after it. */
 type Query = (container: Container, ...args: never[]) => unknown;
+/** Custom queries keyed by the name each is bound under. */
 type QueryMap = Record<string, Query>;
+/** A query with its container argument already applied. */
 type BoundQuery<Q extends Query> = Q extends (container: Container, ...args: infer A) => infer R ? (...args: A) => R : never;
+/** Custom queries with their container argument already applied, keyed as they were passed in. */
 type BoundCustomQueries<Q extends QueryMap> = {
     [K in keyof Q]: BoundQuery<Q[K]>;
 };
+/** What each variant of a query family yields for the widget type it matched. */
 type QueryFamilyReturns<T extends Gtk.Widget> = {
+    /** The single match, or null when nothing matched; throws when more than one matched. */
     queryBy: T | null;
+    /** Every match, empty when nothing matched. */
     queryAllBy: T[];
+    /** The single match; throws when nothing or more than one matched. */
     getBy: T;
+    /** Every match; throws when nothing matched. */
     getAllBy: T[];
+    /** The single match, retried until it appears or the timeout elapses. */
     findBy: Promise<T>;
+    /** Every match, retried until at least one appears or the timeout elapses. */
     findAllBy: Promise<T[]>;
 };
+/** What a query family matches against, which fixes the arguments it takes. */
 type QueryKind = "role" | "text" | "name" | "value";
+/** The arguments a query of the given kind takes after the family's leading ones. */
 type QueryArgs<Kind extends QueryKind, T extends Gtk.Widget> = Kind extends "role" ? [role: Gtk.AccessibleRole, options?: ByRoleOptions<T>] : Kind extends "name" ? [name: Matcher, options?: MatcherOptions<T>] : Kind extends "value" ? [value: Matcher, options?: MatcherOptions<T>] : [text: Matcher, options?: MatcherOptions<T>];
 /**
- * One query family (`queryBy`, `getBy`, `findBy` and their `All` variants) for a single suffix.
- * Each member takes an explicit widget type, as Testing Library's queries do, and also infers it
- * from an `as` option.
+ * One family's query variants, each named for its variant followed by `Suffix` and taking `Head`
+ * ahead of the family's own arguments.
  */
 type QueryFamily<Suffix extends string, Kind extends QueryKind, Head extends unknown[]> = {
     [K in keyof QueryFamilyReturns<Gtk.Widget> as `${K & string}${Suffix}`]: <T extends Gtk.Widget = Gtk.Widget>(...args: [...Head, ...QueryArgs<Kind, T>]) => QueryFamilyReturns<T>[K];
 };
+/**
+ * Every built-in query, spanning the Role, LabelText, Text, Name, PlaceholderText, and DisplayValue
+ * families, with `Head` prepended to each signature.
+ */
 type QueryFamilies<Head extends unknown[]> = QueryFamily<"Role", "role", Head> & QueryFamily<"LabelText", "text", Head> & QueryFamily<"Text", "text", Head> & QueryFamily<"Name", "name", Head> & QueryFamily<"PlaceholderText", "text", Head> & QueryFamily<"DisplayValue", "value", Head>;
 /**
  * Options for {@link render}: the container and base element to mount into, an optional wrapper,
  * React behavior toggles, error callbacks, and custom queries to bind.
  */
 type RenderOptions<Q extends QueryMap = Record<never, never>> = {
+    /** Widget or root element to mount into; an undecorated harness window is created when omitted. */
     container?: Gtk.Widget | RootElement | undefined;
     /** Root of the subtree that bound queries search. */
     baseElement?: Container | undefined;
+    /** Component wrapped around the rendered element, such as a context provider. */
     wrapper?: WrapperComponent | undefined;
     /** Render inside React StrictMode. */
-    reactStrictMode?: boolean | undefined;
+    isReactStrictMode?: boolean | undefined;
     /** Enable widget animations during the test. */
-    animations?: boolean | undefined;
+    areAnimationsEnabled?: boolean | undefined;
     /** Called for errors caught by React error boundaries. */
     onCaughtError?: ((error: unknown, errorInfo: ErrorInfo) => void) | undefined;
     /** Called for errors React recovered from automatically. */
@@ -123,35 +157,48 @@ type RenderOptions<Q extends QueryMap = Record<never, never>> = {
     /** Custom queries to bind to the rendered result. */
     queries?: Q | undefined;
 };
+/** Console helpers bundled with the bound queries on {@link screen} and on a render result. */
 type DebugUtilities = {
+    /** Prints the widget tree of the given containers, or of the whole scope, to the console. */
     debug: (element?: Container | Container[], options?: PrettyWidgetOptions) => void;
+    /** Prints the accessible roles found in the scope, with the widgets carrying each one. */
     logRoles: () => void;
-    screenshot: (selector?: WindowSelector, options?: ScreenshotOptions) => Promise<ScreenshotResult>;
+    /**
+     * Captures what is on screen, which is the active toplevel window: GTK4 exposes no position for
+     * a toplevel, so windows cannot be composited into a single image.
+     */
+    screenshot: (options?: ScreenshotOptions) => Promise<ScreenshotResult>;
 };
 /** A captured screenshot: base64-encoded image data, its MIME type, and pixel dimensions. */
 type ScreenshotResult = {
+    /** Base64-encoded image bytes. */
     data: string;
+    /** MIME type of the encoded image, always `image/png`. */
     mimeType: string;
+    /** Image width in pixels, after the scale factor is applied. */
     width: number;
+    /** Image height in pixels, after the scale factor is applied. */
     height: number;
 };
-/** Options for capturing a screenshot: the poll timeout and interval, plus a rendering scale factor. */
+/**
+ * Options for capturing a screenshot: the poll timeout and interval, a rendering scale factor, and
+ * a file to write the PNG to.
+ */
 type ScreenshotOptions = Pick<WaitForOptions, "timeout" | "interval"> & {
     /** Device scale factor applied when rendering. */
-    scale?: number;
+    scale?: number | undefined;
+    /** File the PNG is written to, with its parent directories created as needed. */
+    path?: string | undefined;
 };
-/**
- * Selects the window to screenshot by index, or by title (exact string or regular expression);
- * undefined targets the default window.
- */
-type WindowSelector = number | string | RegExp | undefined;
 /**
  * Options for {@link renderHook}: an optional wrapper and the initial props (required unless the
  * props type permits undefined).
  */
 type RenderHookOptions<Props> = {
+    /** Component wrapped around the one calling the hook, such as a context provider. */
     wrapper?: WrapperComponent;
 } & (undefined extends Props ? {
+    /** Props the hook is invoked with until `rerender` is given new ones. */
     initialProps?: Props;
 } : {
     initialProps: Props;
@@ -161,12 +208,15 @@ type RenderHookOptions<Props> = {
  * props and to unmount.
  */
 type RenderHookResult<Result, Props> = {
-    /** Holds the most recent value returned by the hook under `current`. */
+    /** Stable object the hook's return value is written to on every render. */
     result: {
+        /** The hook's latest return value. */
         current: Result;
     };
+    /** Re-invokes the hook, keeping the previous props when none are given. */
     rerender: (newProps?: Props) => Promise<void>;
+    /** Unmounts the component that calls the hook. */
     unmount: () => Promise<void>;
 };
-export { type MatcherFunction, type Matcher, type NormalizerFn, type NormalizerOptions, type WaitForOptions, type MatcherOptions, type ByRoleValue, type ByRoleOptions, type WidgetType, type WrapperComponent, type QueryMap, type BoundCustomQueries, type QueryFamilies, type RenderOptions, type DebugUtilities, type ScreenshotResult, type ScreenshotOptions, type WindowSelector, type RenderHookOptions, type RenderHookResult, };
+export { type MatcherFunction, type Matcher, type NormalizerFn, type NormalizerOptions, type WaitForOptions, type MatcherOptions, type ByRoleValue, type ByRoleOptions, type WidgetType, type WrapperComponent, type QueryMap, type BoundCustomQueries, type QueryFamilies, type RenderOptions, type DebugUtilities, type ScreenshotResult, type ScreenshotOptions, type RenderHookOptions, type RenderHookResult, };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;GAGG;AACH,KAAK,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,OAAO,CAAC;AACxE,wHAAwH;AACxH,KAAK,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;AAC1D,0EAA0E;AAC1E,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAC7C;;;GAGG;AACH,KAAK,UAAU,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAE1F,uDAAuD;AACvD,KAAK,iBAAiB,GAAG;IACrB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,mFAAmF;AACnF,KAAK,cAAc,GAAG;IAClB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,GAAG,SAAS,CAAC;IAClD,kFAAkF;IAClF,eAAe,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,yFAAyF;AACzF,KAAK,cAAc,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI;IACrD,4GAA4G;IAC5G,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,uGAAuG;IACvG,UAAU,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACtC,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,gFAAgF;IAChF,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,sGAAsG;IACtG,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAClC,GAAG,cAAc,CAAC;AAEnB,0EAA0E;AAC1E,KAAK,WAAW,GAAG;IACf,yBAAyB;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,sDAAsD;IACtD,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,wGAAwG;AACxG,KAAK,aAAa,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG;IACxE,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAChC,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,mFAAmF;AACnF,KAAK,gBAAgB,GAAG,aAAa,CAAC;IAClC,QAAQ,EAAE,SAAS,CAAC;CACvB,CAAC,CAAC;AAEH,KAAK,KAAK,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC;AACjE,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEtC,KAAK,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GAC1F,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GACjB,KAAK,CAAC;AAEZ,KAAK,kBAAkB,CAAC,CAAC,SAAS,QAAQ,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnF,KAAK,kBAAkB,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,IAAI;IAC5C,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAClB,UAAU,EAAE,CAAC,EAAE,CAAC;IAChB,KAAK,EAAE,CAAC,CAAC;IACT,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;CAC3B,CAAC;AAEF,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,KAAK,SAAS,CAAC,IAAI,SAAS,SAAS,EAAE,CAAC,SAAS,GAAG,CAAC,MAAM,IAAI,IAAI,SAAS,MAAM,GAC5E,CAAC,IAAI,EAAE,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,GACtD,IAAI,SAAS,MAAM,GACf,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAC5C,IAAI,SAAS,OAAO,GAChB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAC7C,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3D;;;;GAIG;AACH,KAAK,WAAW,CAAC,MAAM,SAAS,MAAM,EAAE,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,OAAO,EAAE,IAAI;KACrF,CAAC,IAAI,MAAM,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,EACvG,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KACxC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC;AAEF,KAAK,aAAa,CAAC,IAAI,SAAS,OAAO,EAAE,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAC1E,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,GACtC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GACjC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GACjC,WAAW,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,CAAC,GAC5C,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAE/C;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI;IAC5D,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IACjD,qDAAqD;IACrD,WAAW,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IACpC,OAAO,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACvC,sCAAsC;IACtC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,gDAAgD;IAChD,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,0DAA0D;IAC1D,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7E,4DAA4D;IAC5D,kBAAkB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAClF,qDAAqD;IACrD,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,KAAK,cAAc,GAAG;IAClB,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAClF,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACrG,CAAC;AAEF,6FAA6F;AAC7F,KAAK,gBAAgB,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wGAAwG;AACxG,KAAK,iBAAiB,GAAG,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,UAAU,CAAC,GAAG;IACpE,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,KAAK,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAE3D;;;GAGG;AACH,KAAK,iBAAiB,CAAC,KAAK,IAAI;IAC5B,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC9B,GAAG,CAAC,SAAS,SAAS,KAAK,GACtB;IACM,YAAY,CAAC,EAAE,KAAK,CAAC;CACxB,GACH;IACM,YAAY,EAAE,KAAK,CAAC;CACvB,CAAC,CAAC;AAEX;;;GAGG;AACH,KAAK,gBAAgB,CAAC,MAAM,EAAE,KAAK,IAAI;IACnC,wEAAwE;IACxE,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC;AAEF,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACxB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;GAGG;AACH,KAAK,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,OAAO,CAAC;AACxE,wHAAwH;AACxH,KAAK,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;AAC1D,0EAA0E;AAC1E,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAC7C;;;GAGG;AACH,KAAK,UAAU,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAE1F,uDAAuD;AACvD,KAAK,iBAAiB,GAAG;IACrB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,mFAAmF;AACnF,KAAK,cAAc,GAAG;IAClB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,CAAC,GAAG,SAAS,CAAC;IAClD,kFAAkF;IAClF,eAAe,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,yFAAyF;AACzF,KAAK,cAAc,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI;IACrD,4GAA4G;IAC5G,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,uGAAuG;IACvG,UAAU,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACtC,gFAAgF;IAChF,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,gFAAgF;IAChF,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,sGAAsG;IACtG,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAClC,GAAG,cAAc,CAAC;AAEnB;;;GAGG;AACH,KAAK,WAAW,GAAG;IACf,yBAAyB;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,sDAAsD;IACtD,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,wGAAwG;AACxG,KAAK,aAAa,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG;IACxE,gDAAgD;IAChD,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,kGAAkG;IAClG,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,wFAAwF;IACxF,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,mFAAmF;IACnF,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,oEAAoE;IACpE,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,gGAAgG;IAChG,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,6EAA6E;IAC7E,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAChC,kHAAkH;IAClH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,mFAAmF;AACnF,KAAK,gBAAgB,GAAG,aAAa,CAAC;IAClC,QAAQ,EAAE,SAAS,CAAC;CACvB,CAAC,CAAC;AAEH,2GAA2G;AAC3G,KAAK,KAAK,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC;AACjE,4DAA4D;AAC5D,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEtC,2DAA2D;AAC3D,KAAK,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GAC1F,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GACjB,KAAK,CAAC;AAEZ,kGAAkG;AAClG,KAAK,kBAAkB,CAAC,CAAC,SAAS,QAAQ,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnF,iFAAiF;AACjF,KAAK,kBAAkB,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,IAAI;IAC5C,yFAAyF;IACzF,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAClB,+CAA+C;IAC/C,UAAU,EAAE,CAAC,EAAE,CAAC;IAChB,sEAAsE;IACtE,KAAK,EAAE,CAAC,CAAC;IACT,gDAAgD;IAChD,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,yEAAyE;IACzE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACnB,8EAA8E;IAC9E,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;CAC3B,CAAC;AAEF,+EAA+E;AAC/E,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,qFAAqF;AACrF,KAAK,SAAS,CAAC,IAAI,SAAS,SAAS,EAAE,CAAC,SAAS,GAAG,CAAC,MAAM,IAAI,IAAI,SAAS,MAAM,GAC5E,CAAC,IAAI,EAAE,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,GACtD,IAAI,SAAS,MAAM,GACf,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAC5C,IAAI,SAAS,OAAO,GAChB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAC7C,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3D;;;GAGG;AACH,KAAK,WAAW,CAAC,MAAM,SAAS,MAAM,EAAE,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,OAAO,EAAE,IAAI;KACrF,CAAC,IAAI,MAAM,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,EACvG,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KACxC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,KAAK,aAAa,CAAC,IAAI,SAAS,OAAO,EAAE,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAC1E,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,GACtC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GACjC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GACjC,WAAW,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,CAAC,GAC5C,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAE/C;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI;IAC5D,mGAAmG;IACnG,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IACjD,qDAAqD;IACrD,WAAW,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IACpC,iFAAiF;IACjF,OAAO,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACvC,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,gDAAgD;IAChD,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,0DAA0D;IAC1D,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7E,4DAA4D;IAC5D,kBAAkB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAClF,qDAAqD;IACrD,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,+FAA+F;AAC/F,KAAK,cAAc,GAAG;IAClB,6FAA6F;IAC7F,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAClF,0FAA0F;IAC1F,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC1E,CAAC;AAEF,6FAA6F;AAC7F,KAAK,gBAAgB,GAAG;IACpB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,KAAK,iBAAiB,GAAG,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,UAAU,CAAC,GAAG;IACpE,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,KAAK,iBAAiB,CAAC,KAAK,IAAI;IAC5B,qFAAqF;IACrF,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC9B,GAAG,CAAC,SAAS,SAAS,KAAK,GACtB;IACM,yEAAyE;IACzE,YAAY,CAAC,EAAE,KAAK,CAAC;CACxB,GACH;IACM,YAAY,EAAE,KAAK,CAAC;CACvB,CAAC,CAAC;AAEX;;;GAGG;AACH,KAAK,gBAAgB,CAAC,MAAM,EAAE,KAAK,IAAI;IACnC,2EAA2E;IAC3E,MAAM,EAAE;QACJ,sCAAsC;QACtC,OAAO,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,2EAA2E;IAC3E,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,kDAAkD;IAClD,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC;AAEF,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACxB,CAAC"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA8MA,OAAO,EAqBN,CAAC","sourcesContent":["import type * as Gtk from \"@gtkx/gi/gtk\";\nimport type { RootElement } from \"@gtkx/react\";\nimport type { ComponentType, ErrorInfo, ReactNode } from \"react\";\nimport type { PrettyWidgetOptions } from \"./pretty-widget.js\";\nimport type { Container } from \"./traversal.js\";\n\n/**\n * A custom matcher predicate: given a candidate widget's normalized text content and the widget\n * itself, returns whether it matches.\n */\ntype MatcherFunction = (content: string, widget: Gtk.Widget) => boolean;\n/** A value used to match widget text: a string or number, a regular expression, or a custom {@link MatcherFunction}. */\ntype Matcher = string | number | RegExp | MatcherFunction;\n/** Normalizes a widget's text before it is compared against a matcher. */\ntype NormalizerFn = (text: string) => string;\n/**\n * A widget class usable as a query's `as` constraint, such as `Gtk.Button`. Abstract classes and\n * generated GInterface pseudo-classes are accepted.\n */\ntype WidgetType<T extends Gtk.Widget = Gtk.Widget> = abstract new (...args: never[]) => T;\n\n/** Options controlling the default text normalizer. */\ntype NormalizerOptions = {\n    /** Trim leading and trailing whitespace. */\n    trim?: boolean | undefined;\n    /** Collapse runs of whitespace into a single space. */\n    collapseWhitespace?: boolean | undefined;\n};\n\n/** Options controlling how asynchronous queries and waits poll for a condition. */\ntype WaitForOptions = {\n    /** Maximum time in milliseconds to keep retrying before failing. */\n    timeout?: number | undefined;\n    /** Delay in milliseconds between retries. */\n    interval?: number | undefined;\n    /** Transforms the error thrown when the timeout elapses. */\n    onTimeout?: ((error: Error) => Error) | undefined;\n    /** Error whose stack trace attributes the timeout failure to the calling code. */\n    stackTraceError?: Error | undefined;\n};\n\n/** Options controlling text matching and, for asynchronous queries, polling behavior. */\ntype MatcherOptions<T extends Gtk.Widget = Gtk.Widget> = {\n    /** When true (the default), require an exact match; when false, match case-insensitively as a substring. */\n    exact?: boolean | undefined;\n    /** Custom normalizer replacing the default; cannot be combined with `trim` or `collapseWhitespace`. */\n    normalizer?: NormalizerFn | undefined;\n    /** Forwarded to the default normalizer when no custom `normalizer` is given. */\n    trim?: boolean | undefined;\n    /** Forwarded to the default normalizer when no custom `normalizer` is given. */\n    collapseWhitespace?: boolean | undefined;\n    /** Whether to include a suggested better query in error messages. */\n    suggest?: boolean | undefined;\n    /** Restricts matches to instances of this widget class, and narrows the query's return type to it. */\n    as?: WidgetType<T> | undefined;\n} & WaitForOptions;\n\n/** Constraints on a widget's numeric range value used by role queries. */\ntype ByRoleValue = {\n    /** The current value. */\n    now?: number | undefined;\n    min?: number | undefined;\n    max?: number | undefined;\n    /** Matcher for the value's textual representation. */\n    text?: Matcher | undefined;\n};\n\n/** Options for role queries: an accessible name matcher plus accessible state and value constraints. */\ntype ByRoleOptions<T extends Gtk.Widget = Gtk.Widget> = MatcherOptions<T> & {\n    name?: Matcher | undefined;\n    checked?: boolean | undefined;\n    pressed?: boolean | undefined;\n    selected?: boolean | undefined;\n    expanded?: boolean | undefined;\n    /** Heading or hierarchy level. */\n    level?: number | undefined;\n    busy?: boolean | undefined;\n    description?: Matcher | undefined;\n    value?: ByRoleValue | undefined;\n    /** When true, include widgets excluded from the accessibility tree. */\n    hidden?: boolean | undefined;\n};\n\n/** A React component that wraps rendered content, receiving it as its children. */\ntype WrapperComponent = ComponentType<{\n    children: ReactNode;\n}>;\n\ntype Query = (container: Container, ...args: never[]) => unknown;\ntype QueryMap = Record<string, Query>;\n\ntype BoundQuery<Q extends Query> = Q extends (container: Container, ...args: infer A) => infer R\n    ? (...args: A) => R\n    : never;\n\ntype BoundCustomQueries<Q extends QueryMap> = { [K in keyof Q]: BoundQuery<Q[K]> };\n\ntype QueryFamilyReturns<T extends Gtk.Widget> = {\n    queryBy: T | null;\n    queryAllBy: T[];\n    getBy: T;\n    getAllBy: T[];\n    findBy: Promise<T>;\n    findAllBy: Promise<T[]>;\n};\n\ntype QueryKind = \"role\" | \"text\" | \"name\" | \"value\";\n\ntype QueryArgs<Kind extends QueryKind, T extends Gtk.Widget> = Kind extends \"role\"\n    ? [role: Gtk.AccessibleRole, options?: ByRoleOptions<T>]\n    : Kind extends \"name\"\n        ? [name: Matcher, options?: MatcherOptions<T>]\n        : Kind extends \"value\"\n            ? [value: Matcher, options?: MatcherOptions<T>]\n            : [text: Matcher, options?: MatcherOptions<T>];\n\n/**\n * One query family (`queryBy`, `getBy`, `findBy` and their `All` variants) for a single suffix.\n * Each member takes an explicit widget type, as Testing Library's queries do, and also infers it\n * from an `as` option.\n */\ntype QueryFamily<Suffix extends string, Kind extends QueryKind, Head extends unknown[]> = {\n    [K in keyof QueryFamilyReturns<Gtk.Widget> as `${K & string}${Suffix}`]: <T extends Gtk.Widget = Gtk.Widget>(\n        ...args: [...Head, ...QueryArgs<Kind, T>]\n    ) => QueryFamilyReturns<T>[K];\n};\n\ntype QueryFamilies<Head extends unknown[]> = QueryFamily<\"Role\", \"role\", Head> &\n    QueryFamily<\"LabelText\", \"text\", Head> &\n    QueryFamily<\"Text\", \"text\", Head> &\n    QueryFamily<\"Name\", \"name\", Head> &\n    QueryFamily<\"PlaceholderText\", \"text\", Head> &\n    QueryFamily<\"DisplayValue\", \"value\", Head>;\n\n/**\n * Options for {@link render}: the container and base element to mount into, an optional wrapper,\n * React behavior toggles, error callbacks, and custom queries to bind.\n */\ntype RenderOptions<Q extends QueryMap = Record<never, never>> = {\n    container?: Gtk.Widget | RootElement | undefined;\n    /** Root of the subtree that bound queries search. */\n    baseElement?: Container | undefined;\n    wrapper?: WrapperComponent | undefined;\n    /** Render inside React StrictMode. */\n    reactStrictMode?: boolean | undefined;\n    /** Enable widget animations during the test. */\n    animations?: boolean | undefined;\n    /** Called for errors caught by React error boundaries. */\n    onCaughtError?: ((error: unknown, errorInfo: ErrorInfo) => void) | undefined;\n    /** Called for errors React recovered from automatically. */\n    onRecoverableError?: ((error: unknown, errorInfo: ErrorInfo) => void) | undefined;\n    /** Custom queries to bind to the rendered result. */\n    queries?: Q | undefined;\n};\n\ntype DebugUtilities = {\n    debug: (element?: Container | Container[], options?: PrettyWidgetOptions) => void;\n    logRoles: () => void;\n    screenshot: (selector?: WindowSelector, options?: ScreenshotOptions) => Promise<ScreenshotResult>;\n};\n\n/** A captured screenshot: base64-encoded image data, its MIME type, and pixel dimensions. */\ntype ScreenshotResult = {\n    data: string;\n    mimeType: string;\n    width: number;\n    height: number;\n};\n\n/** Options for capturing a screenshot: the poll timeout and interval, plus a rendering scale factor. */\ntype ScreenshotOptions = Pick<WaitForOptions, \"timeout\" | \"interval\"> & {\n    /** Device scale factor applied when rendering. */\n    scale?: number;\n};\n\n/**\n * Selects the window to screenshot by index, or by title (exact string or regular expression);\n * undefined targets the default window.\n */\ntype WindowSelector = number | string | RegExp | undefined;\n\n/**\n * Options for {@link renderHook}: an optional wrapper and the initial props (required unless the\n * props type permits undefined).\n */\ntype RenderHookOptions<Props> = {\n    wrapper?: WrapperComponent;\n} & (undefined extends Props\n    ? {\n            initialProps?: Props;\n        }\n    : {\n            initialProps: Props;\n        });\n\n/**\n * The result of {@link renderHook}: the latest hook return value plus functions to rerender with new\n * props and to unmount.\n */\ntype RenderHookResult<Result, Props> = {\n    /** Holds the most recent value returned by the hook under `current`. */\n    result: { current: Result };\n    rerender: (newProps?: Props) => Promise<void>;\n    unmount: () => Promise<void>;\n};\n\nexport {\n    type MatcherFunction,\n    type Matcher,\n    type NormalizerFn,\n    type NormalizerOptions,\n    type WaitForOptions,\n    type MatcherOptions,\n    type ByRoleValue,\n    type ByRoleOptions,\n    type WidgetType,\n    type WrapperComponent,\n    type QueryMap,\n    type BoundCustomQueries,\n    type QueryFamilies,\n    type RenderOptions,\n    type DebugUtilities,\n    type ScreenshotResult,\n    type ScreenshotOptions,\n    type WindowSelector,\n    type RenderHookOptions,\n    type RenderHookResult,\n};\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAiQA,OAAO,EAoBN,CAAC","sourcesContent":["import type * as Gtk from \"@gtkx/gi/gtk\";\nimport type { RootElement } from \"@gtkx/react\";\nimport type { ComponentType, ErrorInfo, ReactNode } from \"react\";\nimport type { PrettyWidgetOptions } from \"./pretty-widget.js\";\nimport type { Container } from \"./traversal.js\";\n\n/**\n * A custom matcher predicate: given a candidate widget's normalized text content and the widget\n * itself, returns whether it matches.\n */\ntype MatcherFunction = (content: string, widget: Gtk.Widget) => boolean;\n/** A value used to match widget text: a string or number, a regular expression, or a custom {@link MatcherFunction}. */\ntype Matcher = string | number | RegExp | MatcherFunction;\n/** Normalizes a widget's text before it is compared against a matcher. */\ntype NormalizerFn = (text: string) => string;\n/**\n * A widget class usable as a query's `as` constraint, such as `Gtk.Button`. Abstract classes and\n * generated GInterface pseudo-classes are accepted.\n */\ntype WidgetType<T extends Gtk.Widget = Gtk.Widget> = abstract new (...args: never[]) => T;\n\n/** Options controlling the default text normalizer. */\ntype NormalizerOptions = {\n    /** Trim leading and trailing whitespace. */\n    trim?: boolean | undefined;\n    /** Collapse runs of whitespace into a single space. */\n    collapseWhitespace?: boolean | undefined;\n};\n\n/** Options controlling how asynchronous queries and waits poll for a condition. */\ntype WaitForOptions = {\n    /** Maximum time in milliseconds to keep retrying before failing. */\n    timeout?: number | undefined;\n    /** Delay in milliseconds between retries. */\n    interval?: number | undefined;\n    /** Transforms the error thrown when the timeout elapses. */\n    onTimeout?: ((error: Error) => Error) | undefined;\n    /** Error whose stack trace attributes the timeout failure to the calling code. */\n    stackTraceError?: Error | undefined;\n};\n\n/** Options controlling text matching and, for asynchronous queries, polling behavior. */\ntype MatcherOptions<T extends Gtk.Widget = Gtk.Widget> = {\n    /** When true (the default), require an exact match; when false, match case-insensitively as a substring. */\n    exact?: boolean | undefined;\n    /** Custom normalizer replacing the default; cannot be combined with `trim` or `collapseWhitespace`. */\n    normalizer?: NormalizerFn | undefined;\n    /** Forwarded to the default normalizer when no custom `normalizer` is given. */\n    trim?: boolean | undefined;\n    /** Forwarded to the default normalizer when no custom `normalizer` is given. */\n    collapseWhitespace?: boolean | undefined;\n    /** Whether to include a suggested better query in error messages. */\n    suggest?: boolean | undefined;\n    /** Restricts matches to instances of this widget class, and narrows the query's return type to it. */\n    as?: WidgetType<T> | undefined;\n} & WaitForOptions;\n\n/**\n * Constraints on a widget's numeric range value used by role queries. The numbers come from the\n * accessibility tree and match within 0.001, the resolution GTK keeps them to.\n */\ntype ByRoleValue = {\n    /** The current value. */\n    now?: number | undefined;\n    /** The lower bound of the value's range. */\n    min?: number | undefined;\n    /**\n     * The highest value the widget can reach, which on a paged widget such as a scrollbar is its\n     * adjustment's upper bound less one page.\n     */\n    max?: number | undefined;\n    /** Matcher for the value's textual representation. */\n    text?: Matcher | undefined;\n};\n\n/** Options for role queries: an accessible name matcher plus accessible state and value constraints. */\ntype ByRoleOptions<T extends Gtk.Widget = Gtk.Widget> = MatcherOptions<T> & {\n    /** Matcher for the widget's accessible name. */\n    name?: Matcher | undefined;\n    /** Required checked state; a mixed check button reads as neither, so it matches neither value. */\n    checked?: boolean | undefined;\n    /** Required active state of a toggle button; any other widget matches neither value. */\n    pressed?: boolean | undefined;\n    /** Required selected state of a row, list item, grid cell, option or tree item. */\n    selected?: boolean | undefined;\n    /** Required expanded state of an expander or tree expander. */\n    expanded?: boolean | undefined;\n    /** Heading or hierarchy level. */\n    level?: number | undefined;\n    /** Required busy state, which an unset state satisfies as false. */\n    busy?: boolean | undefined;\n    /** Matcher for the widget's own accessible description, ignoring its `described-by` targets. */\n    description?: Matcher | undefined;\n    /** Constraints on the widget's range value, each checked only when given. */\n    value?: ByRoleValue | undefined;\n    /** When true, include widgets excluded from the accessibility tree. Widgets that are not mapped stay excluded. */\n    hidden?: boolean | undefined;\n};\n\n/** A React component that wraps rendered content, receiving it as its children. */\ntype WrapperComponent = ComponentType<{\n    children: ReactNode;\n}>;\n\n/** A custom query, taking the scope to search as its first argument and its matcher arguments after it. */\ntype Query = (container: Container, ...args: never[]) => unknown;\n/** Custom queries keyed by the name each is bound under. */\ntype QueryMap = Record<string, Query>;\n\n/** A query with its container argument already applied. */\ntype BoundQuery<Q extends Query> = Q extends (container: Container, ...args: infer A) => infer R\n    ? (...args: A) => R\n    : never;\n\n/** Custom queries with their container argument already applied, keyed as they were passed in. */\ntype BoundCustomQueries<Q extends QueryMap> = { [K in keyof Q]: BoundQuery<Q[K]> };\n\n/** What each variant of a query family yields for the widget type it matched. */\ntype QueryFamilyReturns<T extends Gtk.Widget> = {\n    /** The single match, or null when nothing matched; throws when more than one matched. */\n    queryBy: T | null;\n    /** Every match, empty when nothing matched. */\n    queryAllBy: T[];\n    /** The single match; throws when nothing or more than one matched. */\n    getBy: T;\n    /** Every match; throws when nothing matched. */\n    getAllBy: T[];\n    /** The single match, retried until it appears or the timeout elapses. */\n    findBy: Promise<T>;\n    /** Every match, retried until at least one appears or the timeout elapses. */\n    findAllBy: Promise<T[]>;\n};\n\n/** What a query family matches against, which fixes the arguments it takes. */\ntype QueryKind = \"role\" | \"text\" | \"name\" | \"value\";\n\n/** The arguments a query of the given kind takes after the family's leading ones. */\ntype QueryArgs<Kind extends QueryKind, T extends Gtk.Widget> = Kind extends \"role\"\n    ? [role: Gtk.AccessibleRole, options?: ByRoleOptions<T>]\n    : Kind extends \"name\"\n        ? [name: Matcher, options?: MatcherOptions<T>]\n        : Kind extends \"value\"\n            ? [value: Matcher, options?: MatcherOptions<T>]\n            : [text: Matcher, options?: MatcherOptions<T>];\n\n/**\n * One family's query variants, each named for its variant followed by `Suffix` and taking `Head`\n * ahead of the family's own arguments.\n */\ntype QueryFamily<Suffix extends string, Kind extends QueryKind, Head extends unknown[]> = {\n    [K in keyof QueryFamilyReturns<Gtk.Widget> as `${K & string}${Suffix}`]: <T extends Gtk.Widget = Gtk.Widget>(\n        ...args: [...Head, ...QueryArgs<Kind, T>]\n    ) => QueryFamilyReturns<T>[K];\n};\n\n/**\n * Every built-in query, spanning the Role, LabelText, Text, Name, PlaceholderText, and DisplayValue\n * families, with `Head` prepended to each signature.\n */\ntype QueryFamilies<Head extends unknown[]> = QueryFamily<\"Role\", \"role\", Head> &\n    QueryFamily<\"LabelText\", \"text\", Head> &\n    QueryFamily<\"Text\", \"text\", Head> &\n    QueryFamily<\"Name\", \"name\", Head> &\n    QueryFamily<\"PlaceholderText\", \"text\", Head> &\n    QueryFamily<\"DisplayValue\", \"value\", Head>;\n\n/**\n * Options for {@link render}: the container and base element to mount into, an optional wrapper,\n * React behavior toggles, error callbacks, and custom queries to bind.\n */\ntype RenderOptions<Q extends QueryMap = Record<never, never>> = {\n    /** Widget or root element to mount into; an undecorated harness window is created when omitted. */\n    container?: Gtk.Widget | RootElement | undefined;\n    /** Root of the subtree that bound queries search. */\n    baseElement?: Container | undefined;\n    /** Component wrapped around the rendered element, such as a context provider. */\n    wrapper?: WrapperComponent | undefined;\n    /** Render inside React StrictMode. */\n    isReactStrictMode?: boolean | undefined;\n    /** Enable widget animations during the test. */\n    areAnimationsEnabled?: boolean | undefined;\n    /** Called for errors caught by React error boundaries. */\n    onCaughtError?: ((error: unknown, errorInfo: ErrorInfo) => void) | undefined;\n    /** Called for errors React recovered from automatically. */\n    onRecoverableError?: ((error: unknown, errorInfo: ErrorInfo) => void) | undefined;\n    /** Custom queries to bind to the rendered result. */\n    queries?: Q | undefined;\n};\n\n/** Console helpers bundled with the bound queries on {@link screen} and on a render result. */\ntype DebugUtilities = {\n    /** Prints the widget tree of the given containers, or of the whole scope, to the console. */\n    debug: (element?: Container | Container[], options?: PrettyWidgetOptions) => void;\n    /** Prints the accessible roles found in the scope, with the widgets carrying each one. */\n    logRoles: () => void;\n    /**\n     * Captures what is on screen, which is the active toplevel window: GTK4 exposes no position for\n     * a toplevel, so windows cannot be composited into a single image.\n     */\n    screenshot: (options?: ScreenshotOptions) => Promise<ScreenshotResult>;\n};\n\n/** A captured screenshot: base64-encoded image data, its MIME type, and pixel dimensions. */\ntype ScreenshotResult = {\n    /** Base64-encoded image bytes. */\n    data: string;\n    /** MIME type of the encoded image, always `image/png`. */\n    mimeType: string;\n    /** Image width in pixels, after the scale factor is applied. */\n    width: number;\n    /** Image height in pixels, after the scale factor is applied. */\n    height: number;\n};\n\n/**\n * Options for capturing a screenshot: the poll timeout and interval, a rendering scale factor, and\n * a file to write the PNG to.\n */\ntype ScreenshotOptions = Pick<WaitForOptions, \"timeout\" | \"interval\"> & {\n    /** Device scale factor applied when rendering. */\n    scale?: number | undefined;\n    /** File the PNG is written to, with its parent directories created as needed. */\n    path?: string | undefined;\n};\n\n/**\n * Options for {@link renderHook}: an optional wrapper and the initial props (required unless the\n * props type permits undefined).\n */\ntype RenderHookOptions<Props> = {\n    /** Component wrapped around the one calling the hook, such as a context provider. */\n    wrapper?: WrapperComponent;\n} & (undefined extends Props\n    ? {\n            /** Props the hook is invoked with until `rerender` is given new ones. */\n            initialProps?: Props;\n        }\n    : {\n            initialProps: Props;\n        });\n\n/**\n * The result of {@link renderHook}: the latest hook return value plus functions to rerender with new\n * props and to unmount.\n */\ntype RenderHookResult<Result, Props> = {\n    /** Stable object the hook's return value is written to on every render. */\n    result: {\n        /** The hook's latest return value. */\n        current: Result;\n    };\n    /** Re-invokes the hook, keeping the previous props when none are given. */\n    rerender: (newProps?: Props) => Promise<void>;\n    /** Unmounts the component that calls the hook. */\n    unmount: () => Promise<void>;\n};\n\nexport {\n    type MatcherFunction,\n    type Matcher,\n    type NormalizerFn,\n    type NormalizerOptions,\n    type WaitForOptions,\n    type MatcherOptions,\n    type ByRoleValue,\n    type ByRoleOptions,\n    type WidgetType,\n    type WrapperComponent,\n    type QueryMap,\n    type BoundCustomQueries,\n    type QueryFamilies,\n    type RenderOptions,\n    type DebugUtilities,\n    type ScreenshotResult,\n    type ScreenshotOptions,\n    type RenderHookOptions,\n    type RenderHookResult,\n};\n"]}

package/dist/user-event/adjustment.d.ts

@@ -1,10 +1,26 @@
 import * as Gtk from "@gtkx/gi/gtk";
 /** A scroll distance in pixels along each axis. */
 type ScrollDelta = {
+    /** Distance added to the horizontal adjustment. */
     x?: number;
+    /** Distance added to the vertical adjustment. */
     y?: number;
 };
+/**
+ * Emits a jump `change-value` so a Gtk.Range moves to the given value.
+ *
+ * @throws When the widget is not a Gtk.Range.
+ */
 declare const slide: (widget: Gtk.Widget, value: number) => Promise<void>;
+/**
+ * Adds the delta to the adjustments of the widget itself, or of its nearest Gtk.ScrolledWindow or
+ * Gtk.Scrollable ancestor.
+ *
+ * Each adjustment advances in viewport-sized steps rather than one jump, so virtualized views such
+ * as Gtk.ListView, Gtk.GridView and Gtk.ColumnView re-anchor onto the rows the new offset shows.
+ *
+ * @throws When neither the widget nor any of its ancestors is scrollable.
+ */
 declare const scroll: (widget: Gtk.Widget, delta: ScrollDelta) => Promise<void>;
 export { slide, scroll, type ScrollDelta };
 //# sourceMappingURL=adjustment.d.ts.map

package/dist/user-event/adjustment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adjustment.d.ts","sourceRoot":"","sources":["../../src/user-event/adjustment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAGpC,mDAAmD;AACnD,KAAK,WAAW,GAAG;IACf,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAOF,QAAA,MAAM,KAAK,GAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CASzD,CAAC;AAwBP,QAAA,MAAM,MAAM,GAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,OAAO,WAAW,KAAG,OAAO,CAAC,IAAI,CAY/D,CAAC;AAEP,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,CAAC"}
+{"version":3,"file":"adjustment.d.ts","sourceRoot":"","sources":["../../src/user-event/adjustment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAIpC,mDAAmD;AACnD,KAAK,WAAW,GAAG;IACf,mDAAmD;IACnD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,iDAAiD;IACjD,CAAC,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAOF;;;;GAIG;AACH,QAAA,MAAM,KAAK,GAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CASzD,CAAC;AA8CP;;;;;;;;GAQG;AACH,QAAA,MAAM,MAAM,GAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,OAAO,WAAW,KAAG,OAAO,CAAC,IAAI,CAa/D,CAAC;AAEP,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,CAAC"}

package/dist/user-event/adjustment.js

@@ -1,5 +1,11 @@
 import * as Gtk from "@gtkx/gi/gtk";
+import { scheduleNextFrame } from "../frame-sync.js";
 import { wrapEvent } from "./event-wrapper.js";
+/**
+ * Emits a jump `change-value` so a Gtk.Range moves to the given value.
+ *
+ * @throws When the widget is not a Gtk.Range.
+ */
 const slide = (widget, value) => wrapEvent(widget, () => {
     if (!(widget instanceof Gtk.Range)) {
         throw new TypeError(`userEvent.slide requires a Gtk.Range (e.g. Gtk.Scale), got ${widget.constructor.name}`);
@@ -17,19 +23,45 @@ const resolveScrollAdjustments = (widget) => {
     }
     return null;
 };
+const stepToward = (adjustment, target, step) => {
+    const value = adjustment.getValue();
+    adjustment.setValue(value < target ? Math.min(value + step, target) : Math.max(value - step, target));
+    return adjustment.getValue();
+};
+const rampTo = (adjustment, target, step) => {
+    let value = adjustment.getValue();
+    while (value !== target) {
+        const moved = stepToward(adjustment, target, step);
+        if (moved === value) {
+            return;
+        }
+        value = moved;
+    }
+};
 const applyScrollDelta = (adjustment, delta) => {
     if (!adjustment || delta === 0) {
         return;
     }
-    adjustment.setValue(adjustment.getValue() + delta);
+    const pageSize = adjustment.getPageSize();
+    rampTo(adjustment, adjustment.getValue() + delta, pageSize > 0 ? pageSize : Math.abs(delta));
 };
-const scroll = (widget, delta) => wrapEvent(widget, () => {
+/**
+ * Adds the delta to the adjustments of the widget itself, or of its nearest Gtk.ScrolledWindow or
+ * Gtk.Scrollable ancestor.
+ *
+ * Each adjustment advances in viewport-sized steps rather than one jump, so virtualized views such
+ * as Gtk.ListView, Gtk.GridView and Gtk.ColumnView re-anchor onto the rows the new offset shows.
+ *
+ * @throws When neither the widget nor any of its ancestors is scrollable.
+ */
+const scroll = (widget, delta) => wrapEvent(widget, async () => {
     const adjustments = resolveScrollAdjustments(widget);
     if (!adjustments) {
         throw new Error("userEvent.scroll: no Gtk.ScrolledWindow or Gtk.Scrollable found on the widget or its ancestors");
     }
     applyScrollDelta(adjustments.horizontal, delta.x ?? 0);
     applyScrollDelta(adjustments.vertical, delta.y ?? 0);
+    await scheduleNextFrame(widget);
 });
 export { slide, scroll };
 //# sourceMappingURL=adjustment.js.map

package/dist/user-event/adjustment.js.map

@@ -1 +1 @@
-{"version":3,"file":"adjustment.js","sourceRoot":"","sources":["../../src/user-event/adjustment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAa/C,MAAM,KAAK,GAAG,CAAC,MAAkB,EAAE,KAAa,EAAiB,EAAE,CAC/D,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE;IACnB,IAAI,CAAC,CAAC,MAAM,YAAY,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,SAAS,CACf,8DAA8D,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAC1F,CAAC;IACN,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEP,MAAM,wBAAwB,GAAG,CAAC,MAAkB,EAA4B,EAAE;IAC9E,KAAK,IAAI,OAAO,GAAsB,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;QACnF,IAAI,OAAO,YAAY,GAAG,CAAC,cAAc,EAAE,CAAC;YACxC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;QACxF,CAAC;QAED,IAAI,OAAO,YAAY,GAAG,CAAC,UAAU,EAAE,CAAC;YACpC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;QACxF,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,UAAiC,EAAE,KAAa,EAAQ,EAAE;IAChF,IAAI,CAAC,UAAU,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO;IACX,CAAC;IAED,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,MAAkB,EAAE,KAAkB,EAAiB,EAAE,CACrE,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE;IACnB,MAAM,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAErD,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACX,gGAAgG,CACnG,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC;AAEP,OAAO,EAAE,KAAK,EAAE,MAAM,EAAoB,CAAC","sourcesContent":["import * as Gtk from \"@gtkx/gi/gtk\";\nimport { wrapEvent } from \"./event-wrapper.js\";\n\n/** A scroll distance in pixels along each axis. */\ntype ScrollDelta = {\n    x?: number;\n    y?: number;\n};\n\ntype ScrollAdjustments = {\n    horizontal: Gtk.Adjustment | null;\n    vertical: Gtk.Adjustment | null;\n};\n\nconst slide = (widget: Gtk.Widget, value: number): Promise<void> =>\n    wrapEvent(widget, () => {\n        if (!(widget instanceof Gtk.Range)) {\n            throw new TypeError(\n                `userEvent.slide requires a Gtk.Range (e.g. Gtk.Scale), got ${widget.constructor.name}`,\n            );\n        }\n\n        widget.emit(\"change-value\", Gtk.ScrollType.JUMP, value);\n    });\n\nconst resolveScrollAdjustments = (widget: Gtk.Widget): ScrollAdjustments | null => {\n    for (let current: Gtk.Widget | null = widget; current; current = current.getParent()) {\n        if (current instanceof Gtk.ScrolledWindow) {\n            return { horizontal: current.getHadjustment(), vertical: current.getVadjustment() };\n        }\n\n        if (current instanceof Gtk.Scrollable) {\n            return { horizontal: current.getHadjustment(), vertical: current.getVadjustment() };\n        }\n    }\n\n    return null;\n};\n\nconst applyScrollDelta = (adjustment: Gtk.Adjustment | null, delta: number): void => {\n    if (!adjustment || delta === 0) {\n        return;\n    }\n\n    adjustment.setValue(adjustment.getValue() + delta);\n};\n\nconst scroll = (widget: Gtk.Widget, delta: ScrollDelta): Promise<void> =>\n    wrapEvent(widget, () => {\n        const adjustments = resolveScrollAdjustments(widget);\n\n        if (!adjustments) {\n            throw new Error(\n                \"userEvent.scroll: no Gtk.ScrolledWindow or Gtk.Scrollable found on the widget or its ancestors\",\n            );\n        }\n\n        applyScrollDelta(adjustments.horizontal, delta.x ?? 0);\n        applyScrollDelta(adjustments.vertical, delta.y ?? 0);\n    });\n\nexport { slide, scroll, type ScrollDelta };\n"]}
+{"version":3,"file":"adjustment.js","sourceRoot":"","sources":["../../src/user-event/adjustment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAe/C;;;;GAIG;AACH,MAAM,KAAK,GAAG,CAAC,MAAkB,EAAE,KAAa,EAAiB,EAAE,CAC/D,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE;IACnB,IAAI,CAAC,CAAC,MAAM,YAAY,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,SAAS,CACf,8DAA8D,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAC1F,CAAC;IACN,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEP,MAAM,wBAAwB,GAAG,CAAC,MAAkB,EAA4B,EAAE;IAC9E,KAAK,IAAI,OAAO,GAAsB,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;QACnF,IAAI,OAAO,YAAY,GAAG,CAAC,cAAc,EAAE,CAAC;YACxC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;QACxF,CAAC;QAED,IAAI,OAAO,YAAY,GAAG,CAAC,UAAU,EAAE,CAAC;YACpC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;QACxF,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,UAA0B,EAAE,MAAc,EAAE,IAAY,EAAU,EAAE;IACpF,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IACpC,UAAU,CAAC,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAEtG,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,UAA0B,EAAE,MAAc,EAAE,IAAY,EAAQ,EAAE;IAC9E,IAAI,KAAK,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IAElC,OAAO,KAAK,KAAK,MAAM,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAEnD,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YAClB,OAAO;QACX,CAAC;QAED,KAAK,GAAG,KAAK,CAAC;IAClB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,UAAiC,EAAE,KAAa,EAAQ,EAAE;IAChF,IAAI,CAAC,UAAU,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO;IACX,CAAC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;IAC1C,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE,GAAG,KAAK,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AACjG,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,GAAG,CAAC,MAAkB,EAAE,KAAkB,EAAiB,EAAE,CACrE,SAAS,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;IACzB,MAAM,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAErD,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACX,gGAAgG,CACnG,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC;AAEP,OAAO,EAAE,KAAK,EAAE,MAAM,EAAoB,CAAC","sourcesContent":["import * as Gtk from \"@gtkx/gi/gtk\";\nimport { scheduleNextFrame } from \"../frame-sync.js\";\nimport { wrapEvent } from \"./event-wrapper.js\";\n\n/** A scroll distance in pixels along each axis. */\ntype ScrollDelta = {\n    /** Distance added to the horizontal adjustment. */\n    x?: number;\n    /** Distance added to the vertical adjustment. */\n    y?: number;\n};\n\ntype ScrollAdjustments = {\n    horizontal: Gtk.Adjustment | null;\n    vertical: Gtk.Adjustment | null;\n};\n\n/**\n * Emits a jump `change-value` so a Gtk.Range moves to the given value.\n *\n * @throws When the widget is not a Gtk.Range.\n */\nconst slide = (widget: Gtk.Widget, value: number): Promise<void> =>\n    wrapEvent(widget, () => {\n        if (!(widget instanceof Gtk.Range)) {\n            throw new TypeError(\n                `userEvent.slide requires a Gtk.Range (e.g. Gtk.Scale), got ${widget.constructor.name}`,\n            );\n        }\n\n        widget.emit(\"change-value\", Gtk.ScrollType.JUMP, value);\n    });\n\nconst resolveScrollAdjustments = (widget: Gtk.Widget): ScrollAdjustments | null => {\n    for (let current: Gtk.Widget | null = widget; current; current = current.getParent()) {\n        if (current instanceof Gtk.ScrolledWindow) {\n            return { horizontal: current.getHadjustment(), vertical: current.getVadjustment() };\n        }\n\n        if (current instanceof Gtk.Scrollable) {\n            return { horizontal: current.getHadjustment(), vertical: current.getVadjustment() };\n        }\n    }\n\n    return null;\n};\n\nconst stepToward = (adjustment: Gtk.Adjustment, target: number, step: number): number => {\n    const value = adjustment.getValue();\n    adjustment.setValue(value < target ? Math.min(value + step, target) : Math.max(value - step, target));\n\n    return adjustment.getValue();\n};\n\nconst rampTo = (adjustment: Gtk.Adjustment, target: number, step: number): void => {\n    let value = adjustment.getValue();\n\n    while (value !== target) {\n        const moved = stepToward(adjustment, target, step);\n\n        if (moved === value) {\n            return;\n        }\n\n        value = moved;\n    }\n};\n\nconst applyScrollDelta = (adjustment: Gtk.Adjustment | null, delta: number): void => {\n    if (!adjustment || delta === 0) {\n        return;\n    }\n\n    const pageSize = adjustment.getPageSize();\n    rampTo(adjustment, adjustment.getValue() + delta, pageSize > 0 ? pageSize : Math.abs(delta));\n};\n\n/**\n * Adds the delta to the adjustments of the widget itself, or of its nearest Gtk.ScrolledWindow or\n * Gtk.Scrollable ancestor.\n *\n * Each adjustment advances in viewport-sized steps rather than one jump, so virtualized views such\n * as Gtk.ListView, Gtk.GridView and Gtk.ColumnView re-anchor onto the rows the new offset shows.\n *\n * @throws When neither the widget nor any of its ancestors is scrollable.\n */\nconst scroll = (widget: Gtk.Widget, delta: ScrollDelta): Promise<void> =>\n    wrapEvent(widget, async () => {\n        const adjustments = resolveScrollAdjustments(widget);\n\n        if (!adjustments) {\n            throw new Error(\n                \"userEvent.scroll: no Gtk.ScrolledWindow or Gtk.Scrollable found on the widget or its ancestors\",\n            );\n        }\n\n        applyScrollDelta(adjustments.horizontal, delta.x ?? 0);\n        applyScrollDelta(adjustments.vertical, delta.y ?? 0);\n        await scheduleNextFrame(widget);\n    });\n\nexport { slide, scroll, type ScrollDelta };\n"]}

package/dist/user-event/click.d.ts

@@ -1,8 +1,50 @@
 import * as Gtk from "@gtkx/gi/gtk";
-declare const emitPress: (widget: Gtk.Widget, controllers: Gtk.GestureClick[], nPress: number) => void;
-declare const emitRelease: (widget: Gtk.Widget, controllers: Gtk.GestureClick[], nPress: number) => void;
+type ClickPhase = "pressed" | "released";
+declare const emitClickPhase: (widget: Gtk.Widget, controllers: Gtk.GestureClick[], nPress: number, phase: ClickPhase) => void;
+declare const clickGestures: (widget: Gtk.Widget) => Gtk.GestureClick[];
+declare const getAuthoredClickGestures: (widget: Gtk.Widget) => Gtk.GestureClick[];
+/**
+ * Activates a widget that neither claims the click nor carries a click gesture of its own, and
+ * otherwise delivers a press and release. The press travels outwards from the clicked widget
+ * through every widget carrying a click gesture with a pressed or released handler, the way GTK
+ * hands the same press to each of them, and stops at the first Gtk.Button or indexed child of a
+ * list box or flow box, which claims it. A gesture GTK attached itself takes the press only when no
+ * widget below it handles one, and stops it there, so an expander or a notebook tab nested in a row
+ * opens instead of activating the row. Coordinates are the clicked widget's position in each
+ * carrier, so a gesture the container of an indexed child carries reads the child's position rather
+ * than the container's center. An indexed child that the press reaches is then activated, or
+ * exclusively selected when its container does not activate on a single click. A widget with the
+ * label role is never activated, but does consume the click when it carries a gesture of its own.
+ *
+ * The press also stops at a widget whose click GTK4 implements in C on a gesture it attached
+ * itself, reading a GdkEvent that off-screen synthesis cannot produce. Gestures that widget carries
+ * of its own still take the press and release, the way GTK hands them the press before its own
+ * gesture claims it, and the same outcome is then applied through the public action GTK's own
+ * handler invokes: a list, grid, or column-view row is focused and selected, and activated as well
+ * on a second press or when its view activates on a single click; an expandable tree expander
+ * toggles its expansion, once per press, and only when it is the widget clicked, so a click on its
+ * child falls through to the enclosing row; a column header sorts by its column. Sorting goes
+ * through Gtk.ColumnView.sortByColumn, so the primary sort column and order match what a pointer
+ * produces while previously sorted columns are dropped rather than kept as secondary keys. A
+ * column-view cell and the row that carries the column headers stand in the way of the click rather
+ * than taking it, so a click on either reaches the row or the view behind it.
+ */
 declare const click: (widget: Gtk.Widget) => Promise<void>;
+/**
+ * Delivers a two-press click gesture the way {@link click} delivers a single press, without trying
+ * activation first. A list box row or flow box child the presses reach, clicked directly or through
+ * a descendant, is activated and exclusively selected, as GTK's double-click path does whether or
+ * not the container activates on a single click. A widget whose click GTK4 implements itself
+ * receives that outcome once per press, so a list, grid, or column-view row is selected and then
+ * activated by the second press, a tree expander ends back where it started, and a column header
+ * sorts and then inverts its order.
+ */
 declare const dblClick: (widget: Gtk.Widget) => Promise<void>;
+/**
+ * Delivers a three-press click gesture the same way a double click is delivered, applying the same
+ * outcome to a list box row or flow box child the presses reach, and applying the outcome GTK4
+ * implements itself once per press to a row, tree expander, or column header.
+ */
 declare const tripleClick: (widget: Gtk.Widget) => Promise<void>;
-export { emitPress, emitRelease, click, dblClick, tripleClick };
+export { clickGestures, emitClickPhase, getAuthoredClickGestures, click, dblClick, tripleClick };
 //# sourceMappingURL=click.d.ts.map

package/dist/user-event/click.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"click.d.ts","sourceRoot":"","sources":["../../src/user-event/click.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AAuBpC,QAAA,MAAM,SAAS,GAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,CAAC,YAAY,EAAE,EAAE,QAAQ,MAAM,KAAG,IAExF,CAAC;AAEF,QAAA,MAAM,WAAW,GAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,CAAC,YAAY,EAAE,EAAE,QAAQ,MAAM,KAAG,IAE1F,CAAC;AAwCF,QAAA,MAAM,KAAK,GAAU,QAAQ,GAAG,CAAC,MAAM,KAAG,OAAO,CAAC,IAAI,CAwBrD,CAAC;AAEF,QAAA,MAAM,QAAQ,GAAI,QAAQ,GAAG,CAAC,MAAM,KAAG,OAAO,CAAC,IAAI,CAAyC,CAAC;AAC7F,QAAA,MAAM,WAAW,GAAI,QAAQ,GAAG,CAAC,MAAM,KAAG,OAAO,CAAC,IAAI,CAAyC,CAAC;AAEhG,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"click.d.ts","sourceRoot":"","sources":["../../src/user-event/click.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AASpC,KAAK,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC;AA8CzC,QAAA,MAAM,cAAc,GAChB,QAAQ,GAAG,CAAC,MAAM,EAClB,aAAa,GAAG,CAAC,YAAY,EAAE,EAC/B,QAAQ,MAAM,EACd,OAAO,UAAU,KAClB,IAEF,CAAC;AAyBF,QAAA,MAAM,aAAa,GAAI,QAAQ,GAAG,CAAC,MAAM,KAAG,GAAG,CAAC,YAAY,EACoC,CAAC;AAEjG,QAAA,MAAM,wBAAwB,GAAI,QAAQ,GAAG,CAAC,MAAM,KAAG,GAAG,CAAC,YAAY,EACC,CAAC;AA6JzE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,QAAA,MAAM,KAAK,GAAU,QAAQ,GAAG,CAAC,MAAM,KAAG,OAAO,CAAC,IAAI,CAMrD,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,QAAQ,GAAI,QAAQ,GAAG,CAAC,MAAM,KAAG,OAAO,CAAC,IAAI,CAA4B,CAAC;AAChF;;;;GAIG;AACH,QAAA,MAAM,WAAW,GAAI,QAAQ,GAAG,CAAC,MAAM,KAAG,OAAO,CAAC,IAAI,CAA4B,CAAC;AAEnF,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,wBAAwB,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC"}