doc-detective-common 4.18.0 → 4.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +87752 -6953
- package/dist/schemas/schemas.json +87752 -6953
- package/dist/types/generated/closeSurface_v3.d.ts +83 -17
- package/dist/types/generated/closeSurface_v3.d.ts.map +1 -1
- package/dist/types/generated/config_v3.d.ts +24 -0
- package/dist/types/generated/config_v3.d.ts.map +1 -1
- package/dist/types/generated/context_v3.d.ts +24 -0
- package/dist/types/generated/context_v3.d.ts.map +1 -1
- package/dist/types/generated/dragAndDrop_v3.d.ts +2 -2
- package/dist/types/generated/goTo_v3.d.ts +2 -2
- package/dist/types/generated/record_v3.d.ts +2 -2
- package/dist/types/generated/report_v3.d.ts +24 -0
- package/dist/types/generated/report_v3.d.ts.map +1 -1
- package/dist/types/generated/resolvedTests_v3.d.ts +48 -0
- package/dist/types/generated/resolvedTests_v3.d.ts.map +1 -1
- package/dist/types/generated/runBrowserScript_v3.d.ts +2 -2
- package/dist/types/generated/screenshot_v3.d.ts +42 -5
- package/dist/types/generated/screenshot_v3.d.ts.map +1 -1
- package/dist/types/generated/spec_v3.d.ts +24 -0
- package/dist/types/generated/spec_v3.d.ts.map +1 -1
- package/dist/types/generated/startSurface_v3.d.ts +108 -0
- package/dist/types/generated/startSurface_v3.d.ts.map +1 -0
- package/dist/types/generated/startSurface_v3.js +7 -0
- package/dist/types/generated/startSurface_v3.js.map +1 -0
- package/dist/types/generated/step_v3.d.ts +548 -123
- package/dist/types/generated/step_v3.d.ts.map +1 -1
- package/dist/types/generated/surface_v3.d.ts +37 -4
- package/dist/types/generated/surface_v3.d.ts.map +1 -1
- package/dist/types/generated/test_v3.d.ts +2023 -1037
- package/dist/types/generated/test_v3.d.ts.map +1 -1
- package/dist/types/generated/type_v3.d.ts +62 -12
- package/dist/types/generated/type_v3.d.ts.map +1 -1
- package/dist/types/generated/waitUntil_v3.d.ts +22 -8
- package/dist/types/generated/waitUntil_v3.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -10,6 +10,7 @@ export type Screenshot = ScreenshotSimple | CaptureScreenshotDetailed | CaptureS
|
|
|
10
10
|
* File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
|
|
11
11
|
*/
|
|
12
12
|
export type ScreenshotSimple = string;
|
|
13
|
+
export type CaptureScreenshotDetailed = CaptureScreenshotFields & AppCapturesDonTSupportCropYet;
|
|
13
14
|
/**
|
|
14
15
|
* Browser engine keyword. Targets that browser. Steps that can only ever act on a browser (not a background process) restrict the bare-string form to this enum, so a process name here is rejected at validation time instead of failing at runtime.
|
|
15
16
|
*/
|
|
@@ -38,6 +39,18 @@ export type ByIndex1 = number;
|
|
|
38
39
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
39
40
|
*/
|
|
40
41
|
export type ByName1 = string;
|
|
42
|
+
/**
|
|
43
|
+
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
44
|
+
*/
|
|
45
|
+
export type AppWindowSelector = ByIndex2 | ByName2 | ByCriteria2;
|
|
46
|
+
/**
|
|
47
|
+
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
48
|
+
*/
|
|
49
|
+
export type ByIndex2 = number;
|
|
50
|
+
/**
|
|
51
|
+
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
52
|
+
*/
|
|
53
|
+
export type ByName2 = string;
|
|
41
54
|
/**
|
|
42
55
|
* File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
|
|
43
56
|
*/
|
|
@@ -56,11 +69,11 @@ export type CropByElementDetailed = {
|
|
|
56
69
|
* If `true`, captures a screenshot. If `false`, doesn't capture a screenshot.
|
|
57
70
|
*/
|
|
58
71
|
export type CaptureScreenshot = boolean;
|
|
59
|
-
export interface
|
|
72
|
+
export interface CaptureScreenshotFields {
|
|
60
73
|
/**
|
|
61
|
-
* The browser window/tab to capture. Omit to capture the active tab. The targeted
|
|
74
|
+
* 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.
|
|
62
75
|
*/
|
|
63
|
-
surface?: SurfaceByBrowserEngine | BrowserSurface;
|
|
76
|
+
surface?: SurfaceByBrowserEngine | BrowserSurface | AppSurface;
|
|
64
77
|
path?: ScreenshotSimple1;
|
|
65
78
|
/**
|
|
66
79
|
* Directory of the PNG file. If the directory doesn't exist, creates the directory.
|
|
@@ -80,11 +93,11 @@ export interface CaptureScreenshotDetailed {
|
|
|
80
93
|
}
|
|
81
94
|
export interface BrowserSurface {
|
|
82
95
|
/**
|
|
83
|
-
* Browser engine.
|
|
96
|
+
* Browser engine. Selects the browser surface with that engine (or the one named by `name`). A goTo step opens the browser if it isn't open yet; other steps require it to already be open.
|
|
84
97
|
*/
|
|
85
98
|
browser: "chrome" | "firefox" | "safari" | "webkit" | "edge";
|
|
86
99
|
/**
|
|
87
|
-
* Name of the browser surface.
|
|
100
|
+
* Name of the browser surface. Defaults to the engine name (the context's default browser registers under its engine). Assign distinct names to drive multiple browsers at once, including several of the same engine.
|
|
88
101
|
*/
|
|
89
102
|
name?: string;
|
|
90
103
|
window?: WindowTabSelector;
|
|
@@ -126,6 +139,27 @@ export interface ByCriteria1 {
|
|
|
126
139
|
*/
|
|
127
140
|
url?: string;
|
|
128
141
|
}
|
|
142
|
+
export interface AppSurface {
|
|
143
|
+
/**
|
|
144
|
+
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
145
|
+
*/
|
|
146
|
+
app: string;
|
|
147
|
+
window?: AppWindowSelector;
|
|
148
|
+
}
|
|
149
|
+
export interface ByCriteria2 {
|
|
150
|
+
/**
|
|
151
|
+
* Assigned window name.
|
|
152
|
+
*/
|
|
153
|
+
name?: string;
|
|
154
|
+
/**
|
|
155
|
+
* Index in creation order. Negative counts from the end.
|
|
156
|
+
*/
|
|
157
|
+
index?: number;
|
|
158
|
+
/**
|
|
159
|
+
* Window title to match. Substring, or /regex/.
|
|
160
|
+
*/
|
|
161
|
+
title?: string;
|
|
162
|
+
}
|
|
129
163
|
/**
|
|
130
164
|
* Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.
|
|
131
165
|
*/
|
|
@@ -151,4 +185,7 @@ export interface SourceIntegration {
|
|
|
151
185
|
*/
|
|
152
186
|
contentPath?: string;
|
|
153
187
|
}
|
|
188
|
+
export interface AppCapturesDonTSupportCropYet {
|
|
189
|
+
[k: string]: unknown;
|
|
190
|
+
}
|
|
154
191
|
//# sourceMappingURL=screenshot_v3.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screenshot_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/screenshot_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,yBAAyB,GAAG,iBAAiB,CAAC;AAC1F;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;AACzF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAC5B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAExC,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"screenshot_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/screenshot_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,yBAAyB,GAAG,iBAAiB,CAAC;AAC1F;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG,6BAA6B,CAAC;AAChG;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;AACzF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAC5B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AACjE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAExC,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,GAAG,cAAc,GAAG,UAAU,CAAC;IAC/D,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,gBAAgB,CAAC;IAChD,IAAI,CAAC,EAAE,mBAAmB,GAAG,qBAAqB,CAAC;IACnD,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CACvC;AACD,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC7D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,GAAG,CAAC,EAAE,kBAAkB,CAAC;CAC1B;AACD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AACD,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AACD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AACD,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AACD,MAAM,WAAW,6BAA6B;IAC5C,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
|
|
@@ -87,6 +87,10 @@ export interface Context {
|
|
|
87
87
|
* Per-context override for the config-level [`browserFallback`](config) policy that governs whether a context whose browser can't start a driver session falls back to another available browser. Accepts the same values — `auto`, `explicit`, `off` — and, when set, takes precedence over the config-level value for the contexts this entry expands into. Omit it to inherit the config-level policy (which itself defaults to `auto`).
|
|
88
88
|
*/
|
|
89
89
|
browserFallback?: "auto" | "explicit" | "off";
|
|
90
|
+
/**
|
|
91
|
+
* Capabilities the environment must provide for this context to run. A string names a required command; an array names several; the object form checks commands (on PATH), files (paths, with `$VAR`/`$HOME` expansion), and environment variables. All entries are AND-ed. Any unmet requirement marks the context as SKIPPED — the same non-failing outcome as a `platforms` mismatch.
|
|
92
|
+
*/
|
|
93
|
+
requires?: string | [string, ...string[]] | Requirements;
|
|
90
94
|
}
|
|
91
95
|
/**
|
|
92
96
|
* Browser configuration.
|
|
@@ -178,6 +182,26 @@ export interface BrowserViewport1 {
|
|
|
178
182
|
*/
|
|
179
183
|
height?: number;
|
|
180
184
|
}
|
|
185
|
+
export interface Requirements {
|
|
186
|
+
/**
|
|
187
|
+
* Commands that must be resolvable on the PATH.
|
|
188
|
+
*
|
|
189
|
+
* @minItems 1
|
|
190
|
+
*/
|
|
191
|
+
commands?: [string, ...string[]];
|
|
192
|
+
/**
|
|
193
|
+
* Files that must exist. Entries support `$VAR` and `$HOME` expansion.
|
|
194
|
+
*
|
|
195
|
+
* @minItems 1
|
|
196
|
+
*/
|
|
197
|
+
files?: [string, ...string[]];
|
|
198
|
+
/**
|
|
199
|
+
* Environment variables that must be set to a non-empty value.
|
|
200
|
+
*
|
|
201
|
+
* @minItems 1
|
|
202
|
+
*/
|
|
203
|
+
env?: [string, ...string[]];
|
|
204
|
+
}
|
|
181
205
|
export interface OpenAPIDescriptionTest {
|
|
182
206
|
[k: string]: unknown;
|
|
183
207
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spec_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/spec_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;AACvD;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,IAAI,GACZ;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GACD;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AAEN,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,yGAAyG,CAAC;IACpH;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,SAAS,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,EAAE,CAAC;IAC/C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,4GAA4G,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,EACL,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAC5C,OAAO,GACP,CAAC,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;IAChE;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"spec_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/spec_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;AACvD;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,IAAI,GACZ;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GACD;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AAEN,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,yGAAyG,CAAC;IACpH;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,SAAS,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,EAAE,CAAC;IAC/C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,4GAA4G,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,EACL,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAC5C,OAAO,GACP,CAAC,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;IAChE;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC;CAC1D;AACD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACjC;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC9B;;;;OAIG;IACH,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;CAC7B;AACD,MAAM,WAAW,sBAAsB;IACrC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auto-generated from startSurface_v3.schema.json
|
|
3
|
+
* Do not edit manually
|
|
4
|
+
*/
|
|
5
|
+
export type DeviceByName = string;
|
|
6
|
+
/**
|
|
7
|
+
* Wait for a specific element to exist on the app surface. Fields with no accessibility mapping on the target platform fail at runtime with the supported alternative named.
|
|
8
|
+
*/
|
|
9
|
+
export type ElementCriteria = {
|
|
10
|
+
[k: string]: unknown;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Open (provision) a surface and register it by name so later steps can target it with `surface`. Phase A1 ships the native app branch: launch a desktop application by executable path, bundle ID, or UWP AppUserModelID. The mobile fields (`install`, `activity`, `device`) are validated now and land in later phases; browser/process branches and the parallel array form arrive with multi-surface Phase 6. See docs/design/native-app-surfaces.md.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartSurface {
|
|
16
|
+
/**
|
|
17
|
+
* The app identifier: an executable path (`C:\\Windows\\System32\\notepad.exe`), a `.app` path, a bundle ID (`com.apple.TextEdit`), a package name (`com.example.myapp`), or a UWP AppUserModelID (`Microsoft.WindowsCalculator_8wekyb3d8bbwe!App`). Disambiguated by syntax — never by a type field.
|
|
18
|
+
*/
|
|
19
|
+
app: string;
|
|
20
|
+
/**
|
|
21
|
+
* Surface-registry name later steps use in `surface`. Default: the executable basename without extension, or the final dot-segment of an ID.
|
|
22
|
+
*/
|
|
23
|
+
name?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Launch arguments (desktop apps). Entries join into a single shell-style argument string for the driver, so an argument with embedded spaces must carry its own quotes (e.g. "\"My File.txt\"").
|
|
26
|
+
*/
|
|
27
|
+
args?: string[];
|
|
28
|
+
/**
|
|
29
|
+
* Working directory for the launched app (desktop apps). Default: the run's working directory.
|
|
30
|
+
*/
|
|
31
|
+
workingDirectory?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Extra environment variables for the launched app (desktop apps). Driver support varies; unmapped variables fail with a clear runtime error.
|
|
34
|
+
*/
|
|
35
|
+
env?: {
|
|
36
|
+
[k: string]: string;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Path to an installable artifact (`.apk`/`.app`/`.ipa`) to install on the device before launch. Reserved for the mobile phases; validated now, not yet implemented.
|
|
40
|
+
*/
|
|
41
|
+
install?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Android main activity override (defaults to the package's launcher activity). Reserved for the Android phase; validated now, not yet implemented.
|
|
44
|
+
*/
|
|
45
|
+
activity?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Device the app runs on. Omit for a host desktop app. A string references an already-provisioned device by name; an object provisions one. Reserved for the mobile phases; validated now, not yet implemented.
|
|
48
|
+
*/
|
|
49
|
+
device?: DeviceByName | DeviceDescriptor;
|
|
50
|
+
/**
|
|
51
|
+
* Escape-hatch passthrough: merged into the automation session's capabilities after the ones Doc Detective computes (namespaced per driver, e.g. `appium:noReset`). Driver- and version-specific; use sparingly.
|
|
52
|
+
*/
|
|
53
|
+
driverOptions?: {
|
|
54
|
+
[k: string]: unknown;
|
|
55
|
+
};
|
|
56
|
+
waitUntil?: AppReadiness;
|
|
57
|
+
/**
|
|
58
|
+
* Startup ceiling in milliseconds (launch + install + readiness).
|
|
59
|
+
*/
|
|
60
|
+
timeout?: number;
|
|
61
|
+
}
|
|
62
|
+
export interface DeviceDescriptor {
|
|
63
|
+
/**
|
|
64
|
+
* Target platform. Selects the mobile driver.
|
|
65
|
+
*/
|
|
66
|
+
platform: "android" | "ios";
|
|
67
|
+
/**
|
|
68
|
+
* AVD name (Android) or simulator device name (iOS). Also the device's registry identity: the same name resolves to the same device.
|
|
69
|
+
*/
|
|
70
|
+
name?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Platform version. Default: the newest available.
|
|
73
|
+
*/
|
|
74
|
+
osVersion?: string;
|
|
75
|
+
/**
|
|
76
|
+
* Run the Android emulator without a window. Ignored where not applicable.
|
|
77
|
+
*/
|
|
78
|
+
headless?: boolean;
|
|
79
|
+
/**
|
|
80
|
+
* Initial orientation. Reserved; validated now, not yet implemented.
|
|
81
|
+
*/
|
|
82
|
+
orientation?: "portrait" | "landscape";
|
|
83
|
+
/**
|
|
84
|
+
* Device kind. `emulator`/`simulator` (the default, inferred from `platform`) or `device` for real hardware. Reserved; validated now, not yet implemented.
|
|
85
|
+
*/
|
|
86
|
+
type?: "emulator" | "simulator" | "device";
|
|
87
|
+
/**
|
|
88
|
+
* Pin a specific device/emulator instance by UDID. Reserved; validated now, not yet implemented.
|
|
89
|
+
*/
|
|
90
|
+
udid?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Cloud device farm configuration, keyed by provider. Reserved; validated now, not yet implemented.
|
|
93
|
+
*/
|
|
94
|
+
provider?: {
|
|
95
|
+
[k: string]: unknown;
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Startup readiness: a fixed delay and/or an element that must exist before the surface is considered open. No condition applies by default.
|
|
100
|
+
*/
|
|
101
|
+
export interface AppReadiness {
|
|
102
|
+
/**
|
|
103
|
+
* Fixed delay (ms).
|
|
104
|
+
*/
|
|
105
|
+
delayMs?: number;
|
|
106
|
+
find?: ElementCriteria;
|
|
107
|
+
}
|
|
108
|
+
//# sourceMappingURL=startSurface_v3.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"startSurface_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/startSurface_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,GAAG,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACrB,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,gBAAgB,CAAC;IACzC;;OAEG;IACH,aAAa,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB,CAAC;IACF,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,SAAS,GAAG,KAAK,CAAC;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB,CAAC;CACH;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"startSurface_v3.js","sourceRoot":"","sources":["../../../src/types/generated/startSurface_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
|