doc-detective-common 4.35.0 → 4.37.0

package/dist/types/generated/step_v3.d.ts

@@ -545,7 +545,7 @@ export type TypeKeysDetailed = {
  */
 export type TypeKeysSimple1 = string | string[];
 /**
- * The surface a step acts on. Omit to act on the active surface. Supports background processes, browser windows/tabs, and native app windows.
+ * The surface a step acts on. Omit to act on the active surface — the most recently opened, focused, or explicitly targeted surface, whatever its kind. Specifying a surface switches the active surface for the steps that follow. Supports background processes, browser windows/tabs, and native app windows.
  */
 export type Surface = SurfaceByName | ProcessSurface | BrowserSurface2 | AppSurface;
 /**
@@ -1029,7 +1029,7 @@ export type Routing55 = {
  */
 export type CloseSurface1 = Surface1 | [Surface2, ...Surface2[]];
 /**
- * The surface a step acts on. Omit to act on the active surface. Supports background processes, browser windows/tabs, and native app windows.
+ * The surface a step acts on. Omit to act on the active surface — the most recently opened, focused, or explicitly targeted surface, whatever its kind. Specifying a surface switches the active surface for the steps that follow. Supports background processes, browser windows/tabs, and native app windows.
  */
 export type Surface1 = SurfaceByName1 | ProcessSurface1 | BrowserSurface5 | AppSurface3;
 /**
@@ -1073,7 +1073,7 @@ export type ByIndex15 = number;
  */
 export type ByName15 = string;
 /**
- * The surface a step acts on. Omit to act on the active surface. Supports background processes, browser windows/tabs, and native app windows.
+ * The surface a step acts on. Omit to act on the active surface — the most recently opened, focused, or explicitly targeted surface, whatever its kind. Specifying a surface switches the active surface for the steps that follow. Supports background processes, browser windows/tabs, and native app windows.
  */
 export type Surface2 = SurfaceByName2 | ProcessSurface2 | BrowserSurface6 | AppSurface4;
 /**
@@ -1813,6 +1813,10 @@ export interface Common {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -1983,6 +1987,10 @@ export interface Common1 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -2120,6 +2128,10 @@ export interface Common2 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -2257,6 +2269,10 @@ export interface Common3 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -2451,6 +2467,10 @@ export interface Common4 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -2588,6 +2608,10 @@ export interface Common5 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -2806,6 +2830,10 @@ export interface Common6 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -3025,6 +3053,10 @@ export interface Common7 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -3249,6 +3281,10 @@ export interface Common8 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -3507,6 +3543,10 @@ export interface Common9 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -3589,7 +3629,7 @@ export interface Screenshot {
 }
 export interface CaptureScreenshotFields {
     /**
-     * The browser window/tab or app window to capture. Omit to capture the active tab. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }). App captures don't support `crop` yet.
+     * The browser window/tab or app window to capture. Omit to capture the active surface — the most recently opened, focused, or explicitly targeted surface, whatever its kind (a background process can't be captured). Specifying a surface switches the active surface for the steps that follow. App surfaces use the object form ({ "app": … }). App captures don't support `crop` yet.
      */
     surface?: SurfaceByBrowserEngine2 | BrowserSurface3 | AppSurface1;
     path?: ScreenshotSimple1;
@@ -3765,6 +3805,10 @@ export interface ElementFindingFields {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -3816,6 +3860,10 @@ export interface ElementFindingFields1 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -3867,6 +3915,10 @@ export interface ElementFindingFields2 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -3918,6 +3970,10 @@ export interface ElementFindingFields3 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -3969,6 +4025,10 @@ export interface ElementFindingFields4 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -4020,6 +4080,10 @@ export interface ElementFindingFields5 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -4218,6 +4282,10 @@ export interface Common10 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -4355,6 +4423,10 @@ export interface Common11 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -4636,6 +4708,10 @@ export interface Common12 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -4779,6 +4855,10 @@ export interface Common13 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -5066,6 +5146,10 @@ export interface Common14 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -5583,6 +5667,10 @@ export interface Common15 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -5720,6 +5808,10 @@ export interface Common16 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -5927,6 +6019,10 @@ export interface Common17 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -6064,6 +6160,10 @@ export interface Common18 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -6155,7 +6255,7 @@ export interface SwipeDirectional {
      */
     duration?: number;
     /**
-     * The browser window/tab or app window this step acts on. Omit to act on the active tab. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }).
+     * The browser window/tab or app window this step acts on. Omit to act on the active surface — the most recently opened, focused, or explicitly targeted surface, whatever its kind (a background process can't be swiped). Specifying a surface switches the active surface for the steps that follow. App surfaces use the object form ({ "app": … }).
      */
     surface?: SurfaceByBrowserEngine5 | BrowserSurface8 | AppSurface5;
 }
@@ -6236,7 +6336,7 @@ export interface SwipePointToPoint {
      */
     duration?: number;
     /**
-     * The browser window/tab or app window this step acts on. Omit to act on the active tab. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }).
+     * The browser window/tab or app window this step acts on. Omit to act on the active surface — the most recently opened, focused, or explicitly targeted surface, whatever its kind (a background process can't be swiped). Specifying a surface switches the active surface for the steps that follow. App surfaces use the object form ({ "app": … }).
      */
     surface?: SurfaceByBrowserEngine6 | BrowserSurface9 | AppSurface6;
 }
@@ -6392,6 +6492,10 @@ export interface Common19 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -6529,6 +6633,10 @@ export interface Common20 {
      * Which visit of this step produced this report, when a routing goToStep re-ran it (the first visit omits this field). Present only in test results; system-populated.
      */
     visit?: number;
+    /**
+     * Wall-clock duration of this step in milliseconds. When a routing `retry` action re-ran the step, this is the FINAL attempt's elapsed time — the attempt the reported `result` describes — not the sum across attempts. A step that was skipped or never executed reports `0`. Distinct from the `duration` input that some actions accept (for example a `click`'s press duration). Present only in test results; system-populated.
+     */
+    durationMs?: number;
     [k: string]: unknown;
 }
 /**
@@ -6706,6 +6814,10 @@ export interface ElementFindingFields6 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -6757,6 +6869,10 @@ export interface ElementFindingFields7 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -6808,6 +6924,10 @@ export interface ElementFindingFields8 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -6859,6 +6979,10 @@ export interface ElementFindingFields9 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -6910,6 +7034,10 @@ export interface ElementFindingFields10 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -6961,6 +7089,10 @@ export interface ElementFindingFields11 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -7157,6 +7289,10 @@ export interface ElementFindingFields12 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -7208,6 +7344,10 @@ export interface ElementFindingFields13 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -7259,6 +7399,10 @@ export interface ElementFindingFields14 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -7310,6 +7454,10 @@ export interface ElementFindingFields15 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -7361,6 +7509,10 @@ export interface ElementFindingFields16 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.
@@ -7412,6 +7564,10 @@ export interface ElementFindingFields17 {
      * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
      */
     elementAria?: string;
+    /**
+     * Max duration in milliseconds to wait for the element to exist.
+     */
+    timeout?: number;
 }
 /**
  * A fixed spot in the capture, for annotations that aren't anchored to an element.