@swmansion/argent 0.27.1-next.2 → 0.27.1-next.21

package/dist/client.d.ts

@@ -13,6 +13,74 @@ export interface ArgentToolResult<T = unknown> {
     /** Optional advisory note the tool attached to the result. */
     note?: string;
 }
+/**
+ * A node of the `ui-tree` result. A flag is set only when true; a field named in
+ * `UiTree.unsupportedFields` is unknown when absent.
+ */
+export interface UiTreeNode {
+    role: string;
+    label?: string;
+    value?: string;
+    identifier?: string;
+    checked?: boolean;
+    disabled?: boolean;
+    password?: boolean;
+    focused?: boolean;
+    selected?: boolean;
+    /** Normalized to `screen` like gesture-tap, but not clamped: it can fall outside 0..1. */
+    frame?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /** Android: the view class. iOS: the XCUIElementType name, e.g. `TextField`. */
+    type?: string;
+    /** iOS: the accessibility trait names. */
+    traits?: string[];
+    roleDescription?: string;
+    /** Android: the raw content-desc. */
+    contentDescription?: string;
+    /** Roots: the app's bundle id (iOS) or package (Android). */
+    bundleId?: string;
+    editable?: boolean;
+    heading?: boolean;
+    /** On screen, but behind an in-app presentation (iOS) or a system alert. */
+    covered?: boolean;
+    placeholder?: string;
+    /** The input shows its placeholder: it holds no text, and `value` is unset. */
+    hintShowing?: boolean;
+    /** No part of the frame is on screen inside its ancestors: scrolled out or clipped. */
+    hidden?: boolean;
+    children: UiTreeNode[];
+}
+export interface UiTree {
+    schemaVersion: 1;
+    source: "ax-service" | "android-devtools";
+    /** Native units: iOS points, Android pixels. */
+    screen?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * iOS: while a system alert shows, the system app first and the app it covers
+     * second. Android: one root per window, topmost first.
+     */
+    roots: UiTreeNode[];
+    truncated: boolean;
+    alertVisible?: boolean;
+    keyboardVisible?: boolean;
+    /**
+     * The bundle id or package of the app in front, under any system alert.
+     * Android: unset when the alert hides the app's window.
+     */
+    foregroundApp?: string;
+    /**
+     * Fields this source cannot report. On Android they depend on the API level:
+     * `placeholder` and `hintShowing` need 26, `heading` 28.
+     */
+    unsupportedFields: string[];
+}
 export interface CallToolOptions {
     /** Receive progress events while a long-running tool works. */
     onProgress?: (event: unknown) => void;