react-native-tapline 1.3.1 → 1.5.0

package/dist/actions.d.ts

@@ -1,6 +1,7 @@
 import { type Entry, type Snapshot } from './inspect';
 import { type ElementSource } from './source';
 import { type AuditType } from './checks';
+import { type UxAction, type UxCheckName, type UxKind } from './uxcheck';
 import { type Fiber } from './fiber';
 import { type Frame, type LogEntry, type TaplineElement } from './types';
 export { tree } from './inspect';
@@ -60,7 +61,7 @@ export declare function labelOf(info: {
 /** What the caller means to do; a point target then picks only an element that does it. */
 type ActionHint = 'press' | 'longPress' | 'toggle' | 'scroll' | 'type';
 /** Resolve a protocol target to exactly one element, or throw not_found / ambiguous. */
-export declare function resolveTarget(raw: unknown, hint?: ActionHint): Promise<Resolved>;
+export declare function resolveTarget(raw: unknown, hint?: ActionHint, glassOnly?: boolean): Promise<Resolved>;
 /** The nearest listed element at or above a host fiber, for naming what covers a target. */
 export declare function describeHit(snapshot: Snapshot, hit: Fiber, actor?: Entry): string;
 /** `back`: what the back button or gesture does, on the focused screen; with a sheet open, closes the sheet. */
@@ -69,19 +70,34 @@ export declare function back(rawParams: unknown): Promise<{
     closed?: 'sheet';
     dryRun?: true;
 } & SettleOutcome>;
+/** What happened to a double tap's second tap, and how long after the first it came. */
+export type PressSecond = {
+    done: true;
+    afterMs: number;
+} | {
+    done: false;
+    reason: string;
+    afterMs: number;
+};
 /**
  * What `press` and `longPress` answer: the element, `closedKeyboard: true` when the keyboard was
  * closed first, and `forced` (the reason word) when `force` let through what the checks refuse.
+ * `scrolled` says the element was off screen and was scrolled into view first (§16.2); on a dry run,
+ * `scrolls` says it would be and `point` is where the touch is expected after the scroll.
  */
 export type PressResult = {
     element: TaplineElement;
     closedKeyboard?: true;
     forced?: string;
     dryRun?: true;
+    scrolled?: true;
+    scrolls?: true;
     point?: {
         x: number;
         y: number;
     };
+    /** With `again`: the second tap of a double tap. */
+    second?: PressSecond;
 } & SettleOutcome;
 export declare function press(params: unknown): Promise<PressResult>;
 export declare function longPress(params: unknown): Promise<PressResult>;
@@ -112,6 +128,12 @@ export declare function typeText(rawParams: unknown): Promise<{
     closedKeyboard?: true;
     forced?: string;
     dryRun?: true;
+    scrolled?: true;
+    scrolls?: true;
+    point?: {
+        x: number;
+        y: number;
+    };
 } & SettleOutcome>;
 /** What `scroll` answers; `target`, `reached` and `unchanged` only with `to: "target"`. */
 export type ScrollResult = {
@@ -132,6 +154,28 @@ export type ScrollResult = {
     dryRun?: true;
 } & SettleOutcome;
 export declare function scroll(rawParams: unknown): Promise<ScrollResult>;
+interface ScrollState {
+    /** The real content offset; negative at rest when the system adds an inset. */
+    offset: {
+        x: number;
+        y: number;
+    };
+    /** The furthest offset a scrollTo can reach. */
+    max: {
+        x: number;
+        y: number;
+    };
+    visible: {
+        x: number;
+        y: number;
+    };
+}
+/**
+ * The scroll view's real offset, from where its content container sits inside it. On the new
+ * architecture `measureInWindow` includes the content offset, so scroll frame minus content frame
+ * is the offset. Null when either can't be measured (old architecture, nothing laid out).
+ */
+export declare function measureScrollState(entry: Entry): Promise<ScrollState | null>;
 export declare function toggle(rawParams: unknown): Promise<{
     element: TaplineElement;
     value: boolean;
@@ -139,6 +183,8 @@ export declare function toggle(rawParams: unknown): Promise<{
     unchanged?: true;
     forced?: string;
     dryRun?: true;
+    scrolled?: true;
+    scrolls?: true;
     point?: {
         x: number;
         y: number;
@@ -178,6 +224,25 @@ export declare function audit(rawParams: unknown): Promise<{
     issues: AuditIssue[];
     checked: AuditType[];
 }>;
+export interface UxIssue {
+    kind: UxKind;
+    element: TaplineElement | null;
+    where?: AuditWhere;
+    problem: string;
+    basis: string;
+    at?: {
+        file: string;
+        line: number;
+        direct: boolean;
+    };
+}
+/** `ux_check {wayBack?, earlier?}` (AGENT-TOOLS 1.12 §17.3): the screen against the usability basics. */
+export declare function uxCheck(rawParams: unknown): Promise<{
+    issues: UxIssue[];
+    checked: UxCheckName[];
+    choices: number;
+    actions: UxAction[];
+}>;
 export declare function getLogs(rawParams: unknown): Promise<{
     entries: LogEntry[];
 }>;