doc-detective 4.0.1-dev.2 → 4.0.1-dev.3
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/common/src/detectTests.d.ts +101 -0
- package/dist/common/src/detectTests.d.ts.map +1 -0
- package/dist/common/src/detectTests.js +662 -0
- package/dist/common/src/detectTests.js.map +1 -0
- package/dist/common/src/fileTypes.d.ts +35 -0
- package/dist/common/src/fileTypes.d.ts.map +1 -0
- package/dist/common/src/fileTypes.js +293 -0
- package/dist/common/src/fileTypes.js.map +1 -0
- package/dist/common/src/index.d.ts +10 -0
- package/dist/common/src/index.d.ts.map +1 -0
- package/dist/common/src/index.js +5 -0
- package/dist/common/src/index.js.map +1 -0
- package/dist/common/src/schemas/index.d.ts +5 -0
- package/dist/common/src/schemas/index.d.ts.map +1 -0
- package/dist/common/src/schemas/index.js +3 -0
- package/dist/common/src/schemas/index.js.map +1 -0
- package/dist/common/src/schemas/schemas.json +128117 -0
- package/dist/common/src/types/generated/checkLink_v3.d.ts +27 -0
- package/dist/common/src/types/generated/checkLink_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/checkLink_v3.js +7 -0
- package/dist/common/src/types/generated/checkLink_v3.js.map +1 -0
- package/dist/common/src/types/generated/click_v3.d.ts +16 -0
- package/dist/common/src/types/generated/click_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/click_v3.js +7 -0
- package/dist/common/src/types/generated/click_v3.js.map +1 -0
- package/dist/common/src/types/generated/config_v3.d.ts +398 -0
- package/dist/common/src/types/generated/config_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/config_v3.js +7 -0
- package/dist/common/src/types/generated/config_v3.js.map +1 -0
- package/dist/common/src/types/generated/context_v3.d.ts +108 -0
- package/dist/common/src/types/generated/context_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/context_v3.js +7 -0
- package/dist/common/src/types/generated/context_v3.js.map +1 -0
- package/dist/common/src/types/generated/dragAndDrop_v3.d.ts +37 -0
- package/dist/common/src/types/generated/dragAndDrop_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/dragAndDrop_v3.js +7 -0
- package/dist/common/src/types/generated/dragAndDrop_v3.js.map +1 -0
- package/dist/common/src/types/generated/endRecord_v3.d.ts +9 -0
- package/dist/common/src/types/generated/endRecord_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/endRecord_v3.js +7 -0
- package/dist/common/src/types/generated/endRecord_v3.js.map +1 -0
- package/dist/common/src/types/generated/find_v3.d.ts +16 -0
- package/dist/common/src/types/generated/find_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/find_v3.js +7 -0
- package/dist/common/src/types/generated/find_v3.js.map +1 -0
- package/dist/common/src/types/generated/goTo_v3.d.ts +46 -0
- package/dist/common/src/types/generated/goTo_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/goTo_v3.js +7 -0
- package/dist/common/src/types/generated/goTo_v3.js.map +1 -0
- package/dist/common/src/types/generated/httpRequest_v3.d.ts +16 -0
- package/dist/common/src/types/generated/httpRequest_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/httpRequest_v3.js +7 -0
- package/dist/common/src/types/generated/httpRequest_v3.js.map +1 -0
- package/dist/common/src/types/generated/loadCookie_v3.d.ts +16 -0
- package/dist/common/src/types/generated/loadCookie_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/loadCookie_v3.js +7 -0
- package/dist/common/src/types/generated/loadCookie_v3.js.map +1 -0
- package/dist/common/src/types/generated/loadVariables_v3.d.ts +9 -0
- package/dist/common/src/types/generated/loadVariables_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/loadVariables_v3.js +7 -0
- package/dist/common/src/types/generated/loadVariables_v3.js.map +1 -0
- package/dist/common/src/types/generated/openApi_v3.d.ts +62 -0
- package/dist/common/src/types/generated/openApi_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/openApi_v3.js +7 -0
- package/dist/common/src/types/generated/openApi_v3.js.map +1 -0
- package/dist/common/src/types/generated/record_v3.d.ts +32 -0
- package/dist/common/src/types/generated/record_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/record_v3.js +7 -0
- package/dist/common/src/types/generated/record_v3.js.map +1 -0
- package/dist/common/src/types/generated/report_v3.d.ts +174 -0
- package/dist/common/src/types/generated/report_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/report_v3.js +7 -0
- package/dist/common/src/types/generated/report_v3.js.map +1 -0
- package/dist/common/src/types/generated/resolvedTests_v3.d.ts +571 -0
- package/dist/common/src/types/generated/resolvedTests_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/resolvedTests_v3.js +7 -0
- package/dist/common/src/types/generated/resolvedTests_v3.js.map +1 -0
- package/dist/common/src/types/generated/runCode_v3.d.ts +57 -0
- package/dist/common/src/types/generated/runCode_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/runCode_v3.js +7 -0
- package/dist/common/src/types/generated/runCode_v3.js.map +1 -0
- package/dist/common/src/types/generated/runShell_v3.d.ts +56 -0
- package/dist/common/src/types/generated/runShell_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/runShell_v3.js +7 -0
- package/dist/common/src/types/generated/runShell_v3.js.map +1 -0
- package/dist/common/src/types/generated/saveCookie_v3.d.ts +16 -0
- package/dist/common/src/types/generated/saveCookie_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/saveCookie_v3.js +7 -0
- package/dist/common/src/types/generated/saveCookie_v3.js.map +1 -0
- package/dist/common/src/types/generated/screenshot_v3.d.ts +74 -0
- package/dist/common/src/types/generated/screenshot_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/screenshot_v3.js +7 -0
- package/dist/common/src/types/generated/screenshot_v3.js.map +1 -0
- package/dist/common/src/types/generated/sourceIntegration_v3.d.ts +30 -0
- package/dist/common/src/types/generated/sourceIntegration_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/sourceIntegration_v3.js +7 -0
- package/dist/common/src/types/generated/sourceIntegration_v3.js.map +1 -0
- package/dist/common/src/types/generated/spec_v3.d.ts +159 -0
- package/dist/common/src/types/generated/spec_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/spec_v3.js +7 -0
- package/dist/common/src/types/generated/spec_v3.js.map +1 -0
- package/dist/common/src/types/generated/step_v3.d.ts +1558 -0
- package/dist/common/src/types/generated/step_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/step_v3.js +7 -0
- package/dist/common/src/types/generated/step_v3.js.map +1 -0
- package/dist/common/src/types/generated/stopRecord_v3.d.ts +9 -0
- package/dist/common/src/types/generated/stopRecord_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/stopRecord_v3.js +7 -0
- package/dist/common/src/types/generated/stopRecord_v3.js.map +1 -0
- package/dist/common/src/types/generated/test_v3.d.ts +3491 -0
- package/dist/common/src/types/generated/test_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/test_v3.js +7 -0
- package/dist/common/src/types/generated/test_v3.js.map +1 -0
- package/dist/common/src/types/generated/type_v3.d.ts +54 -0
- package/dist/common/src/types/generated/type_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/type_v3.js +7 -0
- package/dist/common/src/types/generated/type_v3.js.map +1 -0
- package/dist/common/src/types/generated/wait_v3.d.ts +12 -0
- package/dist/common/src/types/generated/wait_v3.d.ts.map +1 -0
- package/dist/common/src/types/generated/wait_v3.js +7 -0
- package/dist/common/src/types/generated/wait_v3.js.map +1 -0
- package/dist/common/src/validate.d.ts +41 -0
- package/dist/common/src/validate.d.ts.map +1 -0
- package/dist/common/src/validate.js +557 -0
- package/dist/common/src/validate.js.map +1 -0
- package/package.json +6 -1
- package/.doc-detective.json +0 -1
- package/CONTRIBUTIONS.md +0 -27
- package/screenshot-boolean.png +0 -0
- package/scripts/createCjsWrapper.js +0 -31
|
@@ -0,0 +1,3491 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auto-generated from test_v3.schema.json
|
|
3
|
+
* Do not edit manually
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* A Doc Detective test.
|
|
7
|
+
*/
|
|
8
|
+
export type Test = {
|
|
9
|
+
[k: string]: unknown;
|
|
10
|
+
} & {
|
|
11
|
+
/**
|
|
12
|
+
* Unique identifier for the test.
|
|
13
|
+
*/
|
|
14
|
+
testId?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Description of the test.
|
|
17
|
+
*/
|
|
18
|
+
description?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Path to the content that the test is associated with.
|
|
21
|
+
*/
|
|
22
|
+
contentPath?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Whether or not to detect steps in input files based on markup regex.
|
|
25
|
+
*/
|
|
26
|
+
detectSteps?: boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Contexts to run the test in. Overrides contexts defined at the config and spec levels.
|
|
29
|
+
*/
|
|
30
|
+
runOn?: Context[];
|
|
31
|
+
openApi?: (OpenApi & OpenAPIDescriptionTest)[];
|
|
32
|
+
/**
|
|
33
|
+
* Path to a test specification to perform before this test, while maintaining this test's context. Useful for setting up testing environments. Only the `steps` property is used from the first test in the setup spec.
|
|
34
|
+
*/
|
|
35
|
+
before?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Path to a test specification to perform after this test, while maintaining this test's context. Useful for cleaning up testing environments. Only the `steps` property is used from the first test in the cleanup spec.
|
|
38
|
+
*/
|
|
39
|
+
after?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Steps to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails. By default, if a step fails, the test stops and the remaining steps are not executed.
|
|
42
|
+
*
|
|
43
|
+
* @minItems 1
|
|
44
|
+
*/
|
|
45
|
+
steps?: [Step, ...Step[]];
|
|
46
|
+
contexts?: ResolvedContexts;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* OpenAPI description and configuration.
|
|
50
|
+
*/
|
|
51
|
+
export type OpenApi = {
|
|
52
|
+
[k: string]: unknown;
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* A step in a test.
|
|
56
|
+
*/
|
|
57
|
+
export type Step = (Common & CheckLink) | (Common1 & Click) | (Common2 & Find) | (Common3 & GoTo) | (Common4 & HttpRequest) | (Common5 & RunShell) | (Common6 & RunCode) | (Common7 & Type) | (Common8 & Screenshot) | (Common9 & SaveCookie) | (Common10 & Record) | (Common11 & StopRecord) | (Common12 & LoadVariables) | (Common13 & DragAndDrop) | (Common14 & LoadCookie) | (Common15 & Wait);
|
|
58
|
+
export type CheckLink1 = CheckLinkDetailed | CheckLinkDetailed1;
|
|
59
|
+
/**
|
|
60
|
+
* Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
|
|
61
|
+
*/
|
|
62
|
+
export type CheckLinkDetailed = string;
|
|
63
|
+
/**
|
|
64
|
+
* Click or tap an element.
|
|
65
|
+
*/
|
|
66
|
+
export type Click1 = ClickElementSimple | ClickElementDetailed | boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Identifier for the element to click. Can be a selector, element text, ARIA name, ID, or test ID.
|
|
69
|
+
*/
|
|
70
|
+
export type ClickElementSimple = string;
|
|
71
|
+
export type ClickElementDetailed = {
|
|
72
|
+
[k: string]: unknown;
|
|
73
|
+
} | {
|
|
74
|
+
[k: string]: unknown;
|
|
75
|
+
} | {
|
|
76
|
+
[k: string]: unknown;
|
|
77
|
+
} | {
|
|
78
|
+
[k: string]: unknown;
|
|
79
|
+
} | {
|
|
80
|
+
[k: string]: unknown;
|
|
81
|
+
} | {
|
|
82
|
+
[k: string]: unknown;
|
|
83
|
+
} | {
|
|
84
|
+
[k: string]: unknown;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* Find an element based on display text or a selector, then optionally interact with it.
|
|
88
|
+
*/
|
|
89
|
+
export type Find1 = FindElementSimple | FindElementDetailed;
|
|
90
|
+
/**
|
|
91
|
+
* Identifier for the element to find. Can be a selector, element text, ARIA name, ID, or test ID.
|
|
92
|
+
*/
|
|
93
|
+
export type FindElementSimple = string;
|
|
94
|
+
export type FindElementDetailed = {
|
|
95
|
+
[k: string]: unknown;
|
|
96
|
+
} | {
|
|
97
|
+
[k: string]: unknown;
|
|
98
|
+
} | {
|
|
99
|
+
[k: string]: unknown;
|
|
100
|
+
} | {
|
|
101
|
+
[k: string]: unknown;
|
|
102
|
+
} | {
|
|
103
|
+
[k: string]: unknown;
|
|
104
|
+
} | {
|
|
105
|
+
[k: string]: unknown;
|
|
106
|
+
} | {
|
|
107
|
+
[k: string]: unknown;
|
|
108
|
+
};
|
|
109
|
+
export type GoTo1 = GoToURLSimple | GoToURLDetailed;
|
|
110
|
+
/**
|
|
111
|
+
* Navigate to an HTTP or HTTPS URL. Can be a full URL or a path. If a path is provided, navigates relative to the current URL, if any.
|
|
112
|
+
*/
|
|
113
|
+
export type GoToURLSimple = string;
|
|
114
|
+
/**
|
|
115
|
+
* Perform a generic HTTP request, for example to an API.
|
|
116
|
+
*/
|
|
117
|
+
export type HttpRequest1 = HTTPRequestSimple | HTTPRequestDetailed;
|
|
118
|
+
/**
|
|
119
|
+
* URL for the HTTP request.
|
|
120
|
+
*/
|
|
121
|
+
export type HTTPRequestSimple = string;
|
|
122
|
+
export type HTTPRequestDetailed = {
|
|
123
|
+
[k: string]: unknown;
|
|
124
|
+
} | {
|
|
125
|
+
[k: string]: unknown;
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* Perform a native shell command.
|
|
129
|
+
*/
|
|
130
|
+
export type RunShell1 = RunShellCommandSimple | RunShellCommandDetailed;
|
|
131
|
+
/**
|
|
132
|
+
* Command to perform in the machine's default shell.
|
|
133
|
+
*/
|
|
134
|
+
export type RunShellCommandSimple = string;
|
|
135
|
+
/**
|
|
136
|
+
* Assemble and run code.
|
|
137
|
+
*/
|
|
138
|
+
export type RunCode1 = RunCodeDetailed;
|
|
139
|
+
/**
|
|
140
|
+
* Type keys. To type special keys, begin and end the string with `$` and use the special key's keyword. For example, to type the Escape key, enter `$ESCAPE$`.
|
|
141
|
+
*/
|
|
142
|
+
export type TypeKeys = TypeKeysSimple | TypeKeysDetailed;
|
|
143
|
+
/**
|
|
144
|
+
* Sequence of keys to enter.
|
|
145
|
+
*/
|
|
146
|
+
export type TypeKeysSimple = string | string[];
|
|
147
|
+
/**
|
|
148
|
+
* Sequence of keys to enter.
|
|
149
|
+
*/
|
|
150
|
+
export type TypeKeysSimple1 = string | string[];
|
|
151
|
+
/**
|
|
152
|
+
* Takes a screenshot in PNG format.
|
|
153
|
+
*/
|
|
154
|
+
export type Screenshot1 = ScreenshotSimple | CaptureScreenshotDetailed | CaptureScreenshot;
|
|
155
|
+
/**
|
|
156
|
+
* File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
|
|
157
|
+
*/
|
|
158
|
+
export type ScreenshotSimple = string;
|
|
159
|
+
/**
|
|
160
|
+
* File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
|
|
161
|
+
*/
|
|
162
|
+
export type ScreenshotSimple1 = string;
|
|
163
|
+
/**
|
|
164
|
+
* Display text or selector of the element to screenshot.
|
|
165
|
+
*/
|
|
166
|
+
export type CropByElementSimple = string;
|
|
167
|
+
/**
|
|
168
|
+
* Crop the screenshot to a specific element.
|
|
169
|
+
*/
|
|
170
|
+
export type CropByElementDetailed = {
|
|
171
|
+
[k: string]: unknown;
|
|
172
|
+
} | {
|
|
173
|
+
[k: string]: unknown;
|
|
174
|
+
} | {
|
|
175
|
+
[k: string]: unknown;
|
|
176
|
+
} | {
|
|
177
|
+
[k: string]: unknown;
|
|
178
|
+
} | {
|
|
179
|
+
[k: string]: unknown;
|
|
180
|
+
} | {
|
|
181
|
+
[k: string]: unknown;
|
|
182
|
+
} | {
|
|
183
|
+
[k: string]: unknown;
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* If `true`, captures a screenshot. If `false`, doesn't capture a screenshot.
|
|
187
|
+
*/
|
|
188
|
+
export type CaptureScreenshot = boolean;
|
|
189
|
+
/**
|
|
190
|
+
* Save a specific browser cookie to a file or environment variable for later reuse.
|
|
191
|
+
*/
|
|
192
|
+
export type SaveCookie1 = CookieName | SaveCookieDetailed;
|
|
193
|
+
/**
|
|
194
|
+
* Name of the specific cookie to save. Will be saved to a default file path or environment variable.
|
|
195
|
+
*/
|
|
196
|
+
export type CookieName = string;
|
|
197
|
+
export type SaveCookieDetailed = {
|
|
198
|
+
[k: string]: unknown;
|
|
199
|
+
} | {
|
|
200
|
+
[k: string]: unknown;
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* Start recording the current browser viewport. Must be followed by a `stopRecord` step. Only runs in Chrome browsers when they are visible. Supported extensions: [ '.mp4', '.webm', '.gif' ]
|
|
204
|
+
*/
|
|
205
|
+
export type Record1 = RecordSimple | RecordDetailed | RecordBoolean;
|
|
206
|
+
/**
|
|
207
|
+
* File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.
|
|
208
|
+
*/
|
|
209
|
+
export type RecordSimple = string;
|
|
210
|
+
/**
|
|
211
|
+
* If `true`, records the current browser viewport. If `false`, doesn't record the current browser viewport.
|
|
212
|
+
*/
|
|
213
|
+
export type RecordBoolean = boolean;
|
|
214
|
+
/**
|
|
215
|
+
* Stop the current recording.
|
|
216
|
+
*/
|
|
217
|
+
export type StopRecord1 = boolean | null;
|
|
218
|
+
/**
|
|
219
|
+
* Load environment variables from the specified `.env` file.
|
|
220
|
+
*/
|
|
221
|
+
export type LoadVariables1 = string;
|
|
222
|
+
/**
|
|
223
|
+
* Display text, selector, or regex pattern (enclosed in forward slashes) of the element.
|
|
224
|
+
*/
|
|
225
|
+
export type ElementSimple = string;
|
|
226
|
+
export type ElementDetailed = {
|
|
227
|
+
[k: string]: unknown;
|
|
228
|
+
} | {
|
|
229
|
+
[k: string]: unknown;
|
|
230
|
+
} | {
|
|
231
|
+
[k: string]: unknown;
|
|
232
|
+
} | {
|
|
233
|
+
[k: string]: unknown;
|
|
234
|
+
} | {
|
|
235
|
+
[k: string]: unknown;
|
|
236
|
+
} | {
|
|
237
|
+
[k: string]: unknown;
|
|
238
|
+
} | {
|
|
239
|
+
[k: string]: unknown;
|
|
240
|
+
};
|
|
241
|
+
/**
|
|
242
|
+
* Display text, selector, or regex pattern (enclosed in forward slashes) of the element.
|
|
243
|
+
*/
|
|
244
|
+
export type ElementSimple1 = string;
|
|
245
|
+
export type ElementDetailed1 = {
|
|
246
|
+
[k: string]: unknown;
|
|
247
|
+
} | {
|
|
248
|
+
[k: string]: unknown;
|
|
249
|
+
} | {
|
|
250
|
+
[k: string]: unknown;
|
|
251
|
+
} | {
|
|
252
|
+
[k: string]: unknown;
|
|
253
|
+
} | {
|
|
254
|
+
[k: string]: unknown;
|
|
255
|
+
} | {
|
|
256
|
+
[k: string]: unknown;
|
|
257
|
+
} | {
|
|
258
|
+
[k: string]: unknown;
|
|
259
|
+
};
|
|
260
|
+
/**
|
|
261
|
+
* Load a specific cookie from a file or environment variable into the browser.
|
|
262
|
+
*/
|
|
263
|
+
export type LoadCookie1 = CookieNameOrFilePath | LoadCookieDetailed;
|
|
264
|
+
/**
|
|
265
|
+
* Name of the specific cookie to load from default location, or file path to cookie file.
|
|
266
|
+
*/
|
|
267
|
+
export type CookieNameOrFilePath = string;
|
|
268
|
+
export type LoadCookieDetailed = {
|
|
269
|
+
[k: string]: unknown;
|
|
270
|
+
} | {
|
|
271
|
+
[k: string]: unknown;
|
|
272
|
+
};
|
|
273
|
+
/**
|
|
274
|
+
* Pause (in milliseconds) before performing the next action.
|
|
275
|
+
*/
|
|
276
|
+
export type Wait1 = WaitSimple | WaitEnvironmentVariable | WaitBoolean;
|
|
277
|
+
export type WaitSimple = number;
|
|
278
|
+
export type WaitEnvironmentVariable = string;
|
|
279
|
+
export type WaitBoolean = boolean;
|
|
280
|
+
/**
|
|
281
|
+
* OpenAPI description and configuration.
|
|
282
|
+
*/
|
|
283
|
+
export type OpenApi1 = {
|
|
284
|
+
[k: string]: unknown;
|
|
285
|
+
};
|
|
286
|
+
/**
|
|
287
|
+
* A step in a test.
|
|
288
|
+
*/
|
|
289
|
+
export type Step1 = (Common16 & CheckLink2) | (Common17 & Click2) | (Common18 & Find2) | (Common19 & GoTo2) | (Common20 & HttpRequest2) | (Common21 & RunShell2) | (Common22 & RunCode2) | (Common23 & Type1) | (Common24 & Screenshot2) | (Common25 & SaveCookie2) | (Common26 & Record2) | (Common27 & StopRecord2) | (Common28 & LoadVariables2) | (Common29 & DragAndDrop2) | (Common30 & LoadCookie2) | (Common31 & Wait2);
|
|
290
|
+
export type CheckLink3 = CheckLinkDetailed2 | CheckLinkDetailed3;
|
|
291
|
+
/**
|
|
292
|
+
* Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
|
|
293
|
+
*/
|
|
294
|
+
export type CheckLinkDetailed2 = string;
|
|
295
|
+
/**
|
|
296
|
+
* Click or tap an element.
|
|
297
|
+
*/
|
|
298
|
+
export type Click3 = ClickElementSimple1 | ClickElementDetailed1 | boolean;
|
|
299
|
+
/**
|
|
300
|
+
* Identifier for the element to click. Can be a selector, element text, ARIA name, ID, or test ID.
|
|
301
|
+
*/
|
|
302
|
+
export type ClickElementSimple1 = string;
|
|
303
|
+
export type ClickElementDetailed1 = {
|
|
304
|
+
[k: string]: unknown;
|
|
305
|
+
} | {
|
|
306
|
+
[k: string]: unknown;
|
|
307
|
+
} | {
|
|
308
|
+
[k: string]: unknown;
|
|
309
|
+
} | {
|
|
310
|
+
[k: string]: unknown;
|
|
311
|
+
} | {
|
|
312
|
+
[k: string]: unknown;
|
|
313
|
+
} | {
|
|
314
|
+
[k: string]: unknown;
|
|
315
|
+
} | {
|
|
316
|
+
[k: string]: unknown;
|
|
317
|
+
};
|
|
318
|
+
/**
|
|
319
|
+
* Find an element based on display text or a selector, then optionally interact with it.
|
|
320
|
+
*/
|
|
321
|
+
export type Find3 = FindElementSimple1 | FindElementDetailed1;
|
|
322
|
+
/**
|
|
323
|
+
* Identifier for the element to find. Can be a selector, element text, ARIA name, ID, or test ID.
|
|
324
|
+
*/
|
|
325
|
+
export type FindElementSimple1 = string;
|
|
326
|
+
export type FindElementDetailed1 = {
|
|
327
|
+
[k: string]: unknown;
|
|
328
|
+
} | {
|
|
329
|
+
[k: string]: unknown;
|
|
330
|
+
} | {
|
|
331
|
+
[k: string]: unknown;
|
|
332
|
+
} | {
|
|
333
|
+
[k: string]: unknown;
|
|
334
|
+
} | {
|
|
335
|
+
[k: string]: unknown;
|
|
336
|
+
} | {
|
|
337
|
+
[k: string]: unknown;
|
|
338
|
+
} | {
|
|
339
|
+
[k: string]: unknown;
|
|
340
|
+
};
|
|
341
|
+
export type GoTo3 = GoToURLSimple1 | GoToURLDetailed1;
|
|
342
|
+
/**
|
|
343
|
+
* Navigate to an HTTP or HTTPS URL. Can be a full URL or a path. If a path is provided, navigates relative to the current URL, if any.
|
|
344
|
+
*/
|
|
345
|
+
export type GoToURLSimple1 = string;
|
|
346
|
+
/**
|
|
347
|
+
* Perform a generic HTTP request, for example to an API.
|
|
348
|
+
*/
|
|
349
|
+
export type HttpRequest3 = HTTPRequestSimple1 | HTTPRequestDetailed1;
|
|
350
|
+
/**
|
|
351
|
+
* URL for the HTTP request.
|
|
352
|
+
*/
|
|
353
|
+
export type HTTPRequestSimple1 = string;
|
|
354
|
+
export type HTTPRequestDetailed1 = {
|
|
355
|
+
[k: string]: unknown;
|
|
356
|
+
} | {
|
|
357
|
+
[k: string]: unknown;
|
|
358
|
+
};
|
|
359
|
+
/**
|
|
360
|
+
* Perform a native shell command.
|
|
361
|
+
*/
|
|
362
|
+
export type RunShell3 = RunShellCommandSimple1 | RunShellCommandDetailed1;
|
|
363
|
+
/**
|
|
364
|
+
* Command to perform in the machine's default shell.
|
|
365
|
+
*/
|
|
366
|
+
export type RunShellCommandSimple1 = string;
|
|
367
|
+
/**
|
|
368
|
+
* Assemble and run code.
|
|
369
|
+
*/
|
|
370
|
+
export type RunCode3 = RunCodeDetailed1;
|
|
371
|
+
/**
|
|
372
|
+
* Type keys. To type special keys, begin and end the string with `$` and use the special key's keyword. For example, to type the Escape key, enter `$ESCAPE$`.
|
|
373
|
+
*/
|
|
374
|
+
export type TypeKeys1 = TypeKeysSimple2 | TypeKeysDetailed1;
|
|
375
|
+
/**
|
|
376
|
+
* Sequence of keys to enter.
|
|
377
|
+
*/
|
|
378
|
+
export type TypeKeysSimple2 = string | string[];
|
|
379
|
+
/**
|
|
380
|
+
* Sequence of keys to enter.
|
|
381
|
+
*/
|
|
382
|
+
export type TypeKeysSimple3 = string | string[];
|
|
383
|
+
/**
|
|
384
|
+
* Takes a screenshot in PNG format.
|
|
385
|
+
*/
|
|
386
|
+
export type Screenshot3 = ScreenshotSimple2 | CaptureScreenshotDetailed1 | CaptureScreenshot1;
|
|
387
|
+
/**
|
|
388
|
+
* File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
|
|
389
|
+
*/
|
|
390
|
+
export type ScreenshotSimple2 = string;
|
|
391
|
+
/**
|
|
392
|
+
* File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
|
|
393
|
+
*/
|
|
394
|
+
export type ScreenshotSimple3 = string;
|
|
395
|
+
/**
|
|
396
|
+
* Display text or selector of the element to screenshot.
|
|
397
|
+
*/
|
|
398
|
+
export type CropByElementSimple1 = string;
|
|
399
|
+
/**
|
|
400
|
+
* Crop the screenshot to a specific element.
|
|
401
|
+
*/
|
|
402
|
+
export type CropByElementDetailed1 = {
|
|
403
|
+
[k: string]: unknown;
|
|
404
|
+
} | {
|
|
405
|
+
[k: string]: unknown;
|
|
406
|
+
} | {
|
|
407
|
+
[k: string]: unknown;
|
|
408
|
+
} | {
|
|
409
|
+
[k: string]: unknown;
|
|
410
|
+
} | {
|
|
411
|
+
[k: string]: unknown;
|
|
412
|
+
} | {
|
|
413
|
+
[k: string]: unknown;
|
|
414
|
+
} | {
|
|
415
|
+
[k: string]: unknown;
|
|
416
|
+
};
|
|
417
|
+
/**
|
|
418
|
+
* If `true`, captures a screenshot. If `false`, doesn't capture a screenshot.
|
|
419
|
+
*/
|
|
420
|
+
export type CaptureScreenshot1 = boolean;
|
|
421
|
+
/**
|
|
422
|
+
* Save a specific browser cookie to a file or environment variable for later reuse.
|
|
423
|
+
*/
|
|
424
|
+
export type SaveCookie3 = CookieName1 | SaveCookieDetailed1;
|
|
425
|
+
/**
|
|
426
|
+
* Name of the specific cookie to save. Will be saved to a default file path or environment variable.
|
|
427
|
+
*/
|
|
428
|
+
export type CookieName1 = string;
|
|
429
|
+
export type SaveCookieDetailed1 = {
|
|
430
|
+
[k: string]: unknown;
|
|
431
|
+
} | {
|
|
432
|
+
[k: string]: unknown;
|
|
433
|
+
};
|
|
434
|
+
/**
|
|
435
|
+
* Start recording the current browser viewport. Must be followed by a `stopRecord` step. Only runs in Chrome browsers when they are visible. Supported extensions: [ '.mp4', '.webm', '.gif' ]
|
|
436
|
+
*/
|
|
437
|
+
export type Record3 = RecordSimple1 | RecordDetailed1 | RecordBoolean1;
|
|
438
|
+
/**
|
|
439
|
+
* File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.
|
|
440
|
+
*/
|
|
441
|
+
export type RecordSimple1 = string;
|
|
442
|
+
/**
|
|
443
|
+
* If `true`, records the current browser viewport. If `false`, doesn't record the current browser viewport.
|
|
444
|
+
*/
|
|
445
|
+
export type RecordBoolean1 = boolean;
|
|
446
|
+
/**
|
|
447
|
+
* Stop the current recording.
|
|
448
|
+
*/
|
|
449
|
+
export type StopRecord3 = boolean | null;
|
|
450
|
+
/**
|
|
451
|
+
* Load environment variables from the specified `.env` file.
|
|
452
|
+
*/
|
|
453
|
+
export type LoadVariables3 = string;
|
|
454
|
+
/**
|
|
455
|
+
* Display text, selector, or regex pattern (enclosed in forward slashes) of the element.
|
|
456
|
+
*/
|
|
457
|
+
export type ElementSimple2 = string;
|
|
458
|
+
export type ElementDetailed2 = {
|
|
459
|
+
[k: string]: unknown;
|
|
460
|
+
} | {
|
|
461
|
+
[k: string]: unknown;
|
|
462
|
+
} | {
|
|
463
|
+
[k: string]: unknown;
|
|
464
|
+
} | {
|
|
465
|
+
[k: string]: unknown;
|
|
466
|
+
} | {
|
|
467
|
+
[k: string]: unknown;
|
|
468
|
+
} | {
|
|
469
|
+
[k: string]: unknown;
|
|
470
|
+
} | {
|
|
471
|
+
[k: string]: unknown;
|
|
472
|
+
};
|
|
473
|
+
/**
|
|
474
|
+
* Display text, selector, or regex pattern (enclosed in forward slashes) of the element.
|
|
475
|
+
*/
|
|
476
|
+
export type ElementSimple3 = string;
|
|
477
|
+
export type ElementDetailed3 = {
|
|
478
|
+
[k: string]: unknown;
|
|
479
|
+
} | {
|
|
480
|
+
[k: string]: unknown;
|
|
481
|
+
} | {
|
|
482
|
+
[k: string]: unknown;
|
|
483
|
+
} | {
|
|
484
|
+
[k: string]: unknown;
|
|
485
|
+
} | {
|
|
486
|
+
[k: string]: unknown;
|
|
487
|
+
} | {
|
|
488
|
+
[k: string]: unknown;
|
|
489
|
+
} | {
|
|
490
|
+
[k: string]: unknown;
|
|
491
|
+
};
|
|
492
|
+
/**
|
|
493
|
+
* Load a specific cookie from a file or environment variable into the browser.
|
|
494
|
+
*/
|
|
495
|
+
export type LoadCookie3 = CookieNameOrFilePath1 | LoadCookieDetailed1;
|
|
496
|
+
/**
|
|
497
|
+
* Name of the specific cookie to load from default location, or file path to cookie file.
|
|
498
|
+
*/
|
|
499
|
+
export type CookieNameOrFilePath1 = string;
|
|
500
|
+
export type LoadCookieDetailed1 = {
|
|
501
|
+
[k: string]: unknown;
|
|
502
|
+
} | {
|
|
503
|
+
[k: string]: unknown;
|
|
504
|
+
};
|
|
505
|
+
/**
|
|
506
|
+
* Pause (in milliseconds) before performing the next action.
|
|
507
|
+
*/
|
|
508
|
+
export type Wait3 = WaitSimple1 | WaitEnvironmentVariable1 | WaitBoolean1;
|
|
509
|
+
export type WaitSimple1 = number;
|
|
510
|
+
export type WaitEnvironmentVariable1 = string;
|
|
511
|
+
export type WaitBoolean1 = boolean;
|
|
512
|
+
/**
|
|
513
|
+
* Resolved contexts to run the test in. This is a resolved version of the `runOn` property. It is not user-defined and should not be used in test specifications.
|
|
514
|
+
*/
|
|
515
|
+
export type ResolvedContexts = ResolvedContext[];
|
|
516
|
+
/**
|
|
517
|
+
* A context in which to perform tests. If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For example, if a browser isn't specified but is required by steps in the test, Doc Detective will search for and use a supported browser available in the current environment.
|
|
518
|
+
*/
|
|
519
|
+
export interface Context {
|
|
520
|
+
/**
|
|
521
|
+
* JSON Schema for this object.
|
|
522
|
+
*/
|
|
523
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/context_v3.schema.json";
|
|
524
|
+
/**
|
|
525
|
+
* Unique identifier for the context.
|
|
526
|
+
*/
|
|
527
|
+
contextId?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Platforms to run tests on.
|
|
530
|
+
*/
|
|
531
|
+
platforms?: ("linux" | "mac" | "windows") | ("linux" | "mac" | "windows")[];
|
|
532
|
+
/**
|
|
533
|
+
* Browsers to run tests on.
|
|
534
|
+
*/
|
|
535
|
+
browsers?: ("chrome" | "firefox" | "safari" | "webkit") | Browser | (("chrome" | "firefox" | "safari" | "webkit") | Browser1)[];
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
* Browser configuration.
|
|
539
|
+
*/
|
|
540
|
+
export interface Browser {
|
|
541
|
+
/**
|
|
542
|
+
* Name of the browser.
|
|
543
|
+
*/
|
|
544
|
+
name: "chrome" | "firefox" | "safari" | "webkit";
|
|
545
|
+
/**
|
|
546
|
+
* If `true`, runs the browser in headless mode.
|
|
547
|
+
*/
|
|
548
|
+
headless?: boolean;
|
|
549
|
+
window?: BrowserWindow;
|
|
550
|
+
viewport?: BrowserViewport;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Browser dimensions.
|
|
554
|
+
*/
|
|
555
|
+
export interface BrowserWindow {
|
|
556
|
+
/**
|
|
557
|
+
* Width of the browser window in pixels.
|
|
558
|
+
*/
|
|
559
|
+
width?: number;
|
|
560
|
+
/**
|
|
561
|
+
* Height of the browser window in pixels.
|
|
562
|
+
*/
|
|
563
|
+
height?: number;
|
|
564
|
+
}
|
|
565
|
+
/**
|
|
566
|
+
* Viewport dimensions.
|
|
567
|
+
*/
|
|
568
|
+
export interface BrowserViewport {
|
|
569
|
+
/**
|
|
570
|
+
* Width of the viewport in pixels.
|
|
571
|
+
*/
|
|
572
|
+
width?: number;
|
|
573
|
+
/**
|
|
574
|
+
* Height of the viewport in pixels.
|
|
575
|
+
*/
|
|
576
|
+
height?: number;
|
|
577
|
+
}
|
|
578
|
+
/**
|
|
579
|
+
* Browser configuration.
|
|
580
|
+
*/
|
|
581
|
+
export interface Browser1 {
|
|
582
|
+
/**
|
|
583
|
+
* Name of the browser.
|
|
584
|
+
*/
|
|
585
|
+
name: "chrome" | "firefox" | "safari" | "webkit";
|
|
586
|
+
/**
|
|
587
|
+
* If `true`, runs the browser in headless mode.
|
|
588
|
+
*/
|
|
589
|
+
headless?: boolean;
|
|
590
|
+
window?: BrowserWindow1;
|
|
591
|
+
viewport?: BrowserViewport1;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* Browser dimensions.
|
|
595
|
+
*/
|
|
596
|
+
export interface BrowserWindow1 {
|
|
597
|
+
/**
|
|
598
|
+
* Width of the browser window in pixels.
|
|
599
|
+
*/
|
|
600
|
+
width?: number;
|
|
601
|
+
/**
|
|
602
|
+
* Height of the browser window in pixels.
|
|
603
|
+
*/
|
|
604
|
+
height?: number;
|
|
605
|
+
}
|
|
606
|
+
/**
|
|
607
|
+
* Viewport dimensions.
|
|
608
|
+
*/
|
|
609
|
+
export interface BrowserViewport1 {
|
|
610
|
+
/**
|
|
611
|
+
* Width of the viewport in pixels.
|
|
612
|
+
*/
|
|
613
|
+
width?: number;
|
|
614
|
+
/**
|
|
615
|
+
* Height of the viewport in pixels.
|
|
616
|
+
*/
|
|
617
|
+
height?: number;
|
|
618
|
+
}
|
|
619
|
+
export interface OpenAPIDescriptionTest {
|
|
620
|
+
[k: string]: unknown;
|
|
621
|
+
}
|
|
622
|
+
export interface Common {
|
|
623
|
+
/**
|
|
624
|
+
* JSON Schema for this object.
|
|
625
|
+
*/
|
|
626
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
627
|
+
/**
|
|
628
|
+
* ID of the step.
|
|
629
|
+
*/
|
|
630
|
+
stepId?: string;
|
|
631
|
+
/**
|
|
632
|
+
* Description of the step.
|
|
633
|
+
*/
|
|
634
|
+
description?: string;
|
|
635
|
+
/**
|
|
636
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
637
|
+
*/
|
|
638
|
+
unsafe?: boolean;
|
|
639
|
+
outputs?: OutputsStep;
|
|
640
|
+
variables?: VariablesStep;
|
|
641
|
+
/**
|
|
642
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
643
|
+
*/
|
|
644
|
+
breakpoint?: boolean;
|
|
645
|
+
location?: SourceLocation;
|
|
646
|
+
[k: string]: unknown;
|
|
647
|
+
}
|
|
648
|
+
/**
|
|
649
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
650
|
+
*/
|
|
651
|
+
export interface OutputsStep {
|
|
652
|
+
/**
|
|
653
|
+
* Runtime expression for a user-defined output value.
|
|
654
|
+
*
|
|
655
|
+
* This interface was referenced by `OutputsStep`'s JSON-Schema definition
|
|
656
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
657
|
+
*/
|
|
658
|
+
[k: string]: string;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* Environment variables to set from user-defined expressions.
|
|
662
|
+
*/
|
|
663
|
+
export interface VariablesStep {
|
|
664
|
+
/**
|
|
665
|
+
* Runtime expression for a user-defined output value.
|
|
666
|
+
*
|
|
667
|
+
* This interface was referenced by `VariablesStep`'s JSON-Schema definition
|
|
668
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
669
|
+
*/
|
|
670
|
+
[k: string]: string;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
674
|
+
*/
|
|
675
|
+
export interface SourceLocation {
|
|
676
|
+
/**
|
|
677
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
678
|
+
*/
|
|
679
|
+
line: number;
|
|
680
|
+
/**
|
|
681
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
682
|
+
*/
|
|
683
|
+
startIndex: number;
|
|
684
|
+
/**
|
|
685
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
686
|
+
*/
|
|
687
|
+
endIndex: number;
|
|
688
|
+
}
|
|
689
|
+
export interface CheckLink {
|
|
690
|
+
checkLink: CheckLink1;
|
|
691
|
+
[k: string]: unknown;
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
|
|
695
|
+
*/
|
|
696
|
+
export interface CheckLinkDetailed1 {
|
|
697
|
+
/**
|
|
698
|
+
* URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.
|
|
699
|
+
*/
|
|
700
|
+
url: string;
|
|
701
|
+
/**
|
|
702
|
+
* Protocol and domain to navigate to. Prepended to `url`.
|
|
703
|
+
*/
|
|
704
|
+
origin?: string;
|
|
705
|
+
/**
|
|
706
|
+
* Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.
|
|
707
|
+
*/
|
|
708
|
+
statusCodes?: number | number[];
|
|
709
|
+
}
|
|
710
|
+
export interface Common1 {
|
|
711
|
+
/**
|
|
712
|
+
* JSON Schema for this object.
|
|
713
|
+
*/
|
|
714
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
715
|
+
/**
|
|
716
|
+
* ID of the step.
|
|
717
|
+
*/
|
|
718
|
+
stepId?: string;
|
|
719
|
+
/**
|
|
720
|
+
* Description of the step.
|
|
721
|
+
*/
|
|
722
|
+
description?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
725
|
+
*/
|
|
726
|
+
unsafe?: boolean;
|
|
727
|
+
outputs?: OutputsStep1;
|
|
728
|
+
variables?: VariablesStep1;
|
|
729
|
+
/**
|
|
730
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
731
|
+
*/
|
|
732
|
+
breakpoint?: boolean;
|
|
733
|
+
location?: SourceLocation1;
|
|
734
|
+
[k: string]: unknown;
|
|
735
|
+
}
|
|
736
|
+
/**
|
|
737
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
738
|
+
*/
|
|
739
|
+
export interface OutputsStep1 {
|
|
740
|
+
/**
|
|
741
|
+
* Runtime expression for a user-defined output value.
|
|
742
|
+
*
|
|
743
|
+
* This interface was referenced by `OutputsStep1`'s JSON-Schema definition
|
|
744
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
745
|
+
*/
|
|
746
|
+
[k: string]: string;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* Environment variables to set from user-defined expressions.
|
|
750
|
+
*/
|
|
751
|
+
export interface VariablesStep1 {
|
|
752
|
+
/**
|
|
753
|
+
* Runtime expression for a user-defined output value.
|
|
754
|
+
*
|
|
755
|
+
* This interface was referenced by `VariablesStep1`'s JSON-Schema definition
|
|
756
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
757
|
+
*/
|
|
758
|
+
[k: string]: string;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
762
|
+
*/
|
|
763
|
+
export interface SourceLocation1 {
|
|
764
|
+
/**
|
|
765
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
766
|
+
*/
|
|
767
|
+
line: number;
|
|
768
|
+
/**
|
|
769
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
770
|
+
*/
|
|
771
|
+
startIndex: number;
|
|
772
|
+
/**
|
|
773
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
774
|
+
*/
|
|
775
|
+
endIndex: number;
|
|
776
|
+
}
|
|
777
|
+
export interface Click {
|
|
778
|
+
click: Click1;
|
|
779
|
+
[k: string]: unknown;
|
|
780
|
+
}
|
|
781
|
+
export interface Common2 {
|
|
782
|
+
/**
|
|
783
|
+
* JSON Schema for this object.
|
|
784
|
+
*/
|
|
785
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
786
|
+
/**
|
|
787
|
+
* ID of the step.
|
|
788
|
+
*/
|
|
789
|
+
stepId?: string;
|
|
790
|
+
/**
|
|
791
|
+
* Description of the step.
|
|
792
|
+
*/
|
|
793
|
+
description?: string;
|
|
794
|
+
/**
|
|
795
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
796
|
+
*/
|
|
797
|
+
unsafe?: boolean;
|
|
798
|
+
outputs?: OutputsStep2;
|
|
799
|
+
variables?: VariablesStep2;
|
|
800
|
+
/**
|
|
801
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
802
|
+
*/
|
|
803
|
+
breakpoint?: boolean;
|
|
804
|
+
location?: SourceLocation2;
|
|
805
|
+
[k: string]: unknown;
|
|
806
|
+
}
|
|
807
|
+
/**
|
|
808
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
809
|
+
*/
|
|
810
|
+
export interface OutputsStep2 {
|
|
811
|
+
/**
|
|
812
|
+
* Runtime expression for a user-defined output value.
|
|
813
|
+
*
|
|
814
|
+
* This interface was referenced by `OutputsStep2`'s JSON-Schema definition
|
|
815
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
816
|
+
*/
|
|
817
|
+
[k: string]: string;
|
|
818
|
+
}
|
|
819
|
+
/**
|
|
820
|
+
* Environment variables to set from user-defined expressions.
|
|
821
|
+
*/
|
|
822
|
+
export interface VariablesStep2 {
|
|
823
|
+
/**
|
|
824
|
+
* Runtime expression for a user-defined output value.
|
|
825
|
+
*
|
|
826
|
+
* This interface was referenced by `VariablesStep2`'s JSON-Schema definition
|
|
827
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
828
|
+
*/
|
|
829
|
+
[k: string]: string;
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
833
|
+
*/
|
|
834
|
+
export interface SourceLocation2 {
|
|
835
|
+
/**
|
|
836
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
837
|
+
*/
|
|
838
|
+
line: number;
|
|
839
|
+
/**
|
|
840
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
841
|
+
*/
|
|
842
|
+
startIndex: number;
|
|
843
|
+
/**
|
|
844
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
845
|
+
*/
|
|
846
|
+
endIndex: number;
|
|
847
|
+
}
|
|
848
|
+
export interface Find {
|
|
849
|
+
find: Find1;
|
|
850
|
+
[k: string]: unknown;
|
|
851
|
+
}
|
|
852
|
+
export interface Common3 {
|
|
853
|
+
/**
|
|
854
|
+
* JSON Schema for this object.
|
|
855
|
+
*/
|
|
856
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
857
|
+
/**
|
|
858
|
+
* ID of the step.
|
|
859
|
+
*/
|
|
860
|
+
stepId?: string;
|
|
861
|
+
/**
|
|
862
|
+
* Description of the step.
|
|
863
|
+
*/
|
|
864
|
+
description?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
867
|
+
*/
|
|
868
|
+
unsafe?: boolean;
|
|
869
|
+
outputs?: OutputsStep3;
|
|
870
|
+
variables?: VariablesStep3;
|
|
871
|
+
/**
|
|
872
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
873
|
+
*/
|
|
874
|
+
breakpoint?: boolean;
|
|
875
|
+
location?: SourceLocation3;
|
|
876
|
+
[k: string]: unknown;
|
|
877
|
+
}
|
|
878
|
+
/**
|
|
879
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
880
|
+
*/
|
|
881
|
+
export interface OutputsStep3 {
|
|
882
|
+
/**
|
|
883
|
+
* Runtime expression for a user-defined output value.
|
|
884
|
+
*
|
|
885
|
+
* This interface was referenced by `OutputsStep3`'s JSON-Schema definition
|
|
886
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
887
|
+
*/
|
|
888
|
+
[k: string]: string;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* Environment variables to set from user-defined expressions.
|
|
892
|
+
*/
|
|
893
|
+
export interface VariablesStep3 {
|
|
894
|
+
/**
|
|
895
|
+
* Runtime expression for a user-defined output value.
|
|
896
|
+
*
|
|
897
|
+
* This interface was referenced by `VariablesStep3`'s JSON-Schema definition
|
|
898
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
899
|
+
*/
|
|
900
|
+
[k: string]: string;
|
|
901
|
+
}
|
|
902
|
+
/**
|
|
903
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
904
|
+
*/
|
|
905
|
+
export interface SourceLocation3 {
|
|
906
|
+
/**
|
|
907
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
908
|
+
*/
|
|
909
|
+
line: number;
|
|
910
|
+
/**
|
|
911
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
912
|
+
*/
|
|
913
|
+
startIndex: number;
|
|
914
|
+
/**
|
|
915
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
916
|
+
*/
|
|
917
|
+
endIndex: number;
|
|
918
|
+
}
|
|
919
|
+
export interface GoTo {
|
|
920
|
+
goTo: GoTo1;
|
|
921
|
+
[k: string]: unknown;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* Navigate to an HTTP or HTTPS URL.
|
|
925
|
+
*/
|
|
926
|
+
export interface GoToURLDetailed {
|
|
927
|
+
/**
|
|
928
|
+
* URL to navigate to. Can be a full URL or a path. If a path is provided and `origin` is specified, prepends `origin` to `url`. If a path is provided but `origin` isn't specified, attempts to navigate relative to the current URL, if any.
|
|
929
|
+
*/
|
|
930
|
+
url: string;
|
|
931
|
+
/**
|
|
932
|
+
* Protocol and domain to navigate to. Prepended to `url`.
|
|
933
|
+
*/
|
|
934
|
+
origin?: string;
|
|
935
|
+
/**
|
|
936
|
+
* Maximum time in milliseconds to wait for the page to be ready. If exceeded, the goTo action fails.
|
|
937
|
+
*/
|
|
938
|
+
timeout?: number;
|
|
939
|
+
/**
|
|
940
|
+
* Configuration for waiting conditions after navigation.
|
|
941
|
+
*/
|
|
942
|
+
waitUntil?: {
|
|
943
|
+
/**
|
|
944
|
+
* Wait for network activity to be idle (no new requests) for this duration in milliseconds. Set to `null` to skip this check.
|
|
945
|
+
*/
|
|
946
|
+
networkIdleTime?: number | null;
|
|
947
|
+
/**
|
|
948
|
+
* Wait for DOM mutations to stop for this duration in milliseconds. Set to `null` to skip this check.
|
|
949
|
+
*/
|
|
950
|
+
domIdleTime?: number | null;
|
|
951
|
+
/**
|
|
952
|
+
* Wait for a specific element to be present in the DOM. At least one of selector or elementText must be specified.
|
|
953
|
+
*/
|
|
954
|
+
find?: {
|
|
955
|
+
[k: string]: unknown;
|
|
956
|
+
} | {
|
|
957
|
+
[k: string]: unknown;
|
|
958
|
+
} | {
|
|
959
|
+
[k: string]: unknown;
|
|
960
|
+
} | {
|
|
961
|
+
[k: string]: unknown;
|
|
962
|
+
} | {
|
|
963
|
+
[k: string]: unknown;
|
|
964
|
+
} | {
|
|
965
|
+
[k: string]: unknown;
|
|
966
|
+
} | {
|
|
967
|
+
[k: string]: unknown;
|
|
968
|
+
};
|
|
969
|
+
};
|
|
970
|
+
}
|
|
971
|
+
export interface Common4 {
|
|
972
|
+
/**
|
|
973
|
+
* JSON Schema for this object.
|
|
974
|
+
*/
|
|
975
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
976
|
+
/**
|
|
977
|
+
* ID of the step.
|
|
978
|
+
*/
|
|
979
|
+
stepId?: string;
|
|
980
|
+
/**
|
|
981
|
+
* Description of the step.
|
|
982
|
+
*/
|
|
983
|
+
description?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
986
|
+
*/
|
|
987
|
+
unsafe?: boolean;
|
|
988
|
+
outputs?: OutputsStep4;
|
|
989
|
+
variables?: VariablesStep4;
|
|
990
|
+
/**
|
|
991
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
992
|
+
*/
|
|
993
|
+
breakpoint?: boolean;
|
|
994
|
+
location?: SourceLocation4;
|
|
995
|
+
[k: string]: unknown;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
999
|
+
*/
|
|
1000
|
+
export interface OutputsStep4 {
|
|
1001
|
+
/**
|
|
1002
|
+
* Runtime expression for a user-defined output value.
|
|
1003
|
+
*
|
|
1004
|
+
* This interface was referenced by `OutputsStep4`'s JSON-Schema definition
|
|
1005
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1006
|
+
*/
|
|
1007
|
+
[k: string]: string;
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* Environment variables to set from user-defined expressions.
|
|
1011
|
+
*/
|
|
1012
|
+
export interface VariablesStep4 {
|
|
1013
|
+
/**
|
|
1014
|
+
* Runtime expression for a user-defined output value.
|
|
1015
|
+
*
|
|
1016
|
+
* This interface was referenced by `VariablesStep4`'s JSON-Schema definition
|
|
1017
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1018
|
+
*/
|
|
1019
|
+
[k: string]: string;
|
|
1020
|
+
}
|
|
1021
|
+
/**
|
|
1022
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1023
|
+
*/
|
|
1024
|
+
export interface SourceLocation4 {
|
|
1025
|
+
/**
|
|
1026
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1027
|
+
*/
|
|
1028
|
+
line: number;
|
|
1029
|
+
/**
|
|
1030
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1031
|
+
*/
|
|
1032
|
+
startIndex: number;
|
|
1033
|
+
/**
|
|
1034
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1035
|
+
*/
|
|
1036
|
+
endIndex: number;
|
|
1037
|
+
}
|
|
1038
|
+
export interface HttpRequest {
|
|
1039
|
+
httpRequest: HttpRequest1;
|
|
1040
|
+
[k: string]: unknown;
|
|
1041
|
+
}
|
|
1042
|
+
export interface Common5 {
|
|
1043
|
+
/**
|
|
1044
|
+
* JSON Schema for this object.
|
|
1045
|
+
*/
|
|
1046
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1047
|
+
/**
|
|
1048
|
+
* ID of the step.
|
|
1049
|
+
*/
|
|
1050
|
+
stepId?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* Description of the step.
|
|
1053
|
+
*/
|
|
1054
|
+
description?: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1057
|
+
*/
|
|
1058
|
+
unsafe?: boolean;
|
|
1059
|
+
outputs?: OutputsStep5;
|
|
1060
|
+
variables?: VariablesStep5;
|
|
1061
|
+
/**
|
|
1062
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1063
|
+
*/
|
|
1064
|
+
breakpoint?: boolean;
|
|
1065
|
+
location?: SourceLocation5;
|
|
1066
|
+
[k: string]: unknown;
|
|
1067
|
+
}
|
|
1068
|
+
/**
|
|
1069
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1070
|
+
*/
|
|
1071
|
+
export interface OutputsStep5 {
|
|
1072
|
+
/**
|
|
1073
|
+
* Runtime expression for a user-defined output value.
|
|
1074
|
+
*
|
|
1075
|
+
* This interface was referenced by `OutputsStep5`'s JSON-Schema definition
|
|
1076
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1077
|
+
*/
|
|
1078
|
+
[k: string]: string;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* Environment variables to set from user-defined expressions.
|
|
1082
|
+
*/
|
|
1083
|
+
export interface VariablesStep5 {
|
|
1084
|
+
/**
|
|
1085
|
+
* Runtime expression for a user-defined output value.
|
|
1086
|
+
*
|
|
1087
|
+
* This interface was referenced by `VariablesStep5`'s JSON-Schema definition
|
|
1088
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1089
|
+
*/
|
|
1090
|
+
[k: string]: string;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1094
|
+
*/
|
|
1095
|
+
export interface SourceLocation5 {
|
|
1096
|
+
/**
|
|
1097
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1098
|
+
*/
|
|
1099
|
+
line: number;
|
|
1100
|
+
/**
|
|
1101
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1102
|
+
*/
|
|
1103
|
+
startIndex: number;
|
|
1104
|
+
/**
|
|
1105
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1106
|
+
*/
|
|
1107
|
+
endIndex: number;
|
|
1108
|
+
}
|
|
1109
|
+
export interface RunShell {
|
|
1110
|
+
runShell: RunShell1;
|
|
1111
|
+
[k: string]: unknown;
|
|
1112
|
+
}
|
|
1113
|
+
export interface RunShellCommandDetailed {
|
|
1114
|
+
/**
|
|
1115
|
+
* Command to perform in the machine's default shell.
|
|
1116
|
+
*/
|
|
1117
|
+
command: string;
|
|
1118
|
+
/**
|
|
1119
|
+
* Arguments for the command.
|
|
1120
|
+
*/
|
|
1121
|
+
args?: string[];
|
|
1122
|
+
/**
|
|
1123
|
+
* Working directory for the command.
|
|
1124
|
+
*/
|
|
1125
|
+
workingDirectory?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
|
|
1128
|
+
*/
|
|
1129
|
+
exitCodes?: number[];
|
|
1130
|
+
/**
|
|
1131
|
+
* Content expected in the command's stdout or stderr. If the expected content can't be found in the command's stdout or stderr, the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.* /`.
|
|
1132
|
+
*/
|
|
1133
|
+
stdio?: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* File path to save the command's output, relative to `directory`.
|
|
1136
|
+
*/
|
|
1137
|
+
path?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory.
|
|
1140
|
+
*/
|
|
1141
|
+
directory?: string;
|
|
1142
|
+
/**
|
|
1143
|
+
* Allowed variation as a fraction (0 to 1) of text different between the current output and previously saved output. For example, 0.1 means 10%. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.
|
|
1144
|
+
*/
|
|
1145
|
+
maxVariation?: number;
|
|
1146
|
+
/**
|
|
1147
|
+
* If `true`, overwrites the existing output at `path` if it exists.
|
|
1148
|
+
* If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
|
|
1149
|
+
*/
|
|
1150
|
+
overwrite?: "true" | "false" | "aboveVariation";
|
|
1151
|
+
/**
|
|
1152
|
+
* Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
|
|
1153
|
+
*/
|
|
1154
|
+
timeout?: number;
|
|
1155
|
+
}
|
|
1156
|
+
export interface Common6 {
|
|
1157
|
+
/**
|
|
1158
|
+
* JSON Schema for this object.
|
|
1159
|
+
*/
|
|
1160
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1161
|
+
/**
|
|
1162
|
+
* ID of the step.
|
|
1163
|
+
*/
|
|
1164
|
+
stepId?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* Description of the step.
|
|
1167
|
+
*/
|
|
1168
|
+
description?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1171
|
+
*/
|
|
1172
|
+
unsafe?: boolean;
|
|
1173
|
+
outputs?: OutputsStep6;
|
|
1174
|
+
variables?: VariablesStep6;
|
|
1175
|
+
/**
|
|
1176
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1177
|
+
*/
|
|
1178
|
+
breakpoint?: boolean;
|
|
1179
|
+
location?: SourceLocation6;
|
|
1180
|
+
[k: string]: unknown;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1184
|
+
*/
|
|
1185
|
+
export interface OutputsStep6 {
|
|
1186
|
+
/**
|
|
1187
|
+
* Runtime expression for a user-defined output value.
|
|
1188
|
+
*
|
|
1189
|
+
* This interface was referenced by `OutputsStep6`'s JSON-Schema definition
|
|
1190
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1191
|
+
*/
|
|
1192
|
+
[k: string]: string;
|
|
1193
|
+
}
|
|
1194
|
+
/**
|
|
1195
|
+
* Environment variables to set from user-defined expressions.
|
|
1196
|
+
*/
|
|
1197
|
+
export interface VariablesStep6 {
|
|
1198
|
+
/**
|
|
1199
|
+
* Runtime expression for a user-defined output value.
|
|
1200
|
+
*
|
|
1201
|
+
* This interface was referenced by `VariablesStep6`'s JSON-Schema definition
|
|
1202
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1203
|
+
*/
|
|
1204
|
+
[k: string]: string;
|
|
1205
|
+
}
|
|
1206
|
+
/**
|
|
1207
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1208
|
+
*/
|
|
1209
|
+
export interface SourceLocation6 {
|
|
1210
|
+
/**
|
|
1211
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1212
|
+
*/
|
|
1213
|
+
line: number;
|
|
1214
|
+
/**
|
|
1215
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1216
|
+
*/
|
|
1217
|
+
startIndex: number;
|
|
1218
|
+
/**
|
|
1219
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1220
|
+
*/
|
|
1221
|
+
endIndex: number;
|
|
1222
|
+
}
|
|
1223
|
+
export interface RunCode {
|
|
1224
|
+
runCode: RunCode1;
|
|
1225
|
+
[k: string]: unknown;
|
|
1226
|
+
}
|
|
1227
|
+
export interface RunCodeDetailed {
|
|
1228
|
+
/**
|
|
1229
|
+
* Language of the code to run.
|
|
1230
|
+
*/
|
|
1231
|
+
language: "python" | "bash" | "javascript";
|
|
1232
|
+
/**
|
|
1233
|
+
* Code to run.
|
|
1234
|
+
*/
|
|
1235
|
+
code: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* Arguments for the command.
|
|
1238
|
+
*/
|
|
1239
|
+
args?: string[];
|
|
1240
|
+
/**
|
|
1241
|
+
* Working directory for the command.
|
|
1242
|
+
*/
|
|
1243
|
+
workingDirectory?: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
|
|
1246
|
+
*/
|
|
1247
|
+
exitCodes?: number[];
|
|
1248
|
+
/**
|
|
1249
|
+
* Content expected in the command's output. If the expected content can't be found in the command's output (either stdout or stderr), the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.* /`.
|
|
1250
|
+
*/
|
|
1251
|
+
stdio?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* File path to save the command's output, relative to `directory`.
|
|
1254
|
+
*/
|
|
1255
|
+
path?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory.
|
|
1258
|
+
*/
|
|
1259
|
+
directory?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* Allowed variation as a fraction (0 to 1) of text different between the current output and previously saved output. For example, 0.1 means 10%. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.
|
|
1262
|
+
*/
|
|
1263
|
+
maxVariation?: number;
|
|
1264
|
+
/**
|
|
1265
|
+
* If `true`, overwrites the existing output at `path` if it exists.
|
|
1266
|
+
* If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
|
|
1267
|
+
*/
|
|
1268
|
+
overwrite?: "true" | "false" | "aboveVariation";
|
|
1269
|
+
/**
|
|
1270
|
+
* Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
|
|
1271
|
+
*/
|
|
1272
|
+
timeout?: number;
|
|
1273
|
+
[k: string]: unknown;
|
|
1274
|
+
}
|
|
1275
|
+
export interface Common7 {
|
|
1276
|
+
/**
|
|
1277
|
+
* JSON Schema for this object.
|
|
1278
|
+
*/
|
|
1279
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1280
|
+
/**
|
|
1281
|
+
* ID of the step.
|
|
1282
|
+
*/
|
|
1283
|
+
stepId?: string;
|
|
1284
|
+
/**
|
|
1285
|
+
* Description of the step.
|
|
1286
|
+
*/
|
|
1287
|
+
description?: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1290
|
+
*/
|
|
1291
|
+
unsafe?: boolean;
|
|
1292
|
+
outputs?: OutputsStep7;
|
|
1293
|
+
variables?: VariablesStep7;
|
|
1294
|
+
/**
|
|
1295
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1296
|
+
*/
|
|
1297
|
+
breakpoint?: boolean;
|
|
1298
|
+
location?: SourceLocation7;
|
|
1299
|
+
[k: string]: unknown;
|
|
1300
|
+
}
|
|
1301
|
+
/**
|
|
1302
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1303
|
+
*/
|
|
1304
|
+
export interface OutputsStep7 {
|
|
1305
|
+
/**
|
|
1306
|
+
* Runtime expression for a user-defined output value.
|
|
1307
|
+
*
|
|
1308
|
+
* This interface was referenced by `OutputsStep7`'s JSON-Schema definition
|
|
1309
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1310
|
+
*/
|
|
1311
|
+
[k: string]: string;
|
|
1312
|
+
}
|
|
1313
|
+
/**
|
|
1314
|
+
* Environment variables to set from user-defined expressions.
|
|
1315
|
+
*/
|
|
1316
|
+
export interface VariablesStep7 {
|
|
1317
|
+
/**
|
|
1318
|
+
* Runtime expression for a user-defined output value.
|
|
1319
|
+
*
|
|
1320
|
+
* This interface was referenced by `VariablesStep7`'s JSON-Schema definition
|
|
1321
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1322
|
+
*/
|
|
1323
|
+
[k: string]: string;
|
|
1324
|
+
}
|
|
1325
|
+
/**
|
|
1326
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1327
|
+
*/
|
|
1328
|
+
export interface SourceLocation7 {
|
|
1329
|
+
/**
|
|
1330
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1331
|
+
*/
|
|
1332
|
+
line: number;
|
|
1333
|
+
/**
|
|
1334
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1335
|
+
*/
|
|
1336
|
+
startIndex: number;
|
|
1337
|
+
/**
|
|
1338
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1339
|
+
*/
|
|
1340
|
+
endIndex: number;
|
|
1341
|
+
}
|
|
1342
|
+
export interface Type {
|
|
1343
|
+
type: TypeKeys;
|
|
1344
|
+
[k: string]: unknown;
|
|
1345
|
+
}
|
|
1346
|
+
export interface TypeKeysDetailed {
|
|
1347
|
+
keys: TypeKeysSimple1;
|
|
1348
|
+
/**
|
|
1349
|
+
* Delay in milliseconds between each key press during a recording
|
|
1350
|
+
*/
|
|
1351
|
+
inputDelay?: number;
|
|
1352
|
+
/**
|
|
1353
|
+
* Selector for the element to type into. If not specified, the typing occurs in the active element.
|
|
1354
|
+
*/
|
|
1355
|
+
selector?: string;
|
|
1356
|
+
/**
|
|
1357
|
+
* Display text of the element to type into. If combined with other element finding fields, the element must match all specified criteria.
|
|
1358
|
+
*/
|
|
1359
|
+
elementText?: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* ID attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.
|
|
1362
|
+
*/
|
|
1363
|
+
elementId?: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* data-testid attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.
|
|
1366
|
+
*/
|
|
1367
|
+
elementTestId?: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* Class or array of classes that the element must have. Each class supports exact match or regex pattern using /pattern/ syntax. Element must have all specified classes.
|
|
1370
|
+
*/
|
|
1371
|
+
elementClass?: string | string[];
|
|
1372
|
+
/**
|
|
1373
|
+
* Object of attribute key-value pairs that the element must have. Values can be strings (supporting /pattern/ regex), numbers, or booleans. Boolean true matches attribute presence, false matches absence.
|
|
1374
|
+
*/
|
|
1375
|
+
elementAttribute?: {
|
|
1376
|
+
[k: string]: string | number | boolean;
|
|
1377
|
+
};
|
|
1378
|
+
/**
|
|
1379
|
+
* Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
|
|
1380
|
+
*/
|
|
1381
|
+
elementAria?: string;
|
|
1382
|
+
}
|
|
1383
|
+
export interface Common8 {
|
|
1384
|
+
/**
|
|
1385
|
+
* JSON Schema for this object.
|
|
1386
|
+
*/
|
|
1387
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1388
|
+
/**
|
|
1389
|
+
* ID of the step.
|
|
1390
|
+
*/
|
|
1391
|
+
stepId?: string;
|
|
1392
|
+
/**
|
|
1393
|
+
* Description of the step.
|
|
1394
|
+
*/
|
|
1395
|
+
description?: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1398
|
+
*/
|
|
1399
|
+
unsafe?: boolean;
|
|
1400
|
+
outputs?: OutputsStep8;
|
|
1401
|
+
variables?: VariablesStep8;
|
|
1402
|
+
/**
|
|
1403
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1404
|
+
*/
|
|
1405
|
+
breakpoint?: boolean;
|
|
1406
|
+
location?: SourceLocation8;
|
|
1407
|
+
[k: string]: unknown;
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1411
|
+
*/
|
|
1412
|
+
export interface OutputsStep8 {
|
|
1413
|
+
/**
|
|
1414
|
+
* Runtime expression for a user-defined output value.
|
|
1415
|
+
*
|
|
1416
|
+
* This interface was referenced by `OutputsStep8`'s JSON-Schema definition
|
|
1417
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1418
|
+
*/
|
|
1419
|
+
[k: string]: string;
|
|
1420
|
+
}
|
|
1421
|
+
/**
|
|
1422
|
+
* Environment variables to set from user-defined expressions.
|
|
1423
|
+
*/
|
|
1424
|
+
export interface VariablesStep8 {
|
|
1425
|
+
/**
|
|
1426
|
+
* Runtime expression for a user-defined output value.
|
|
1427
|
+
*
|
|
1428
|
+
* This interface was referenced by `VariablesStep8`'s JSON-Schema definition
|
|
1429
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1430
|
+
*/
|
|
1431
|
+
[k: string]: string;
|
|
1432
|
+
}
|
|
1433
|
+
/**
|
|
1434
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1435
|
+
*/
|
|
1436
|
+
export interface SourceLocation8 {
|
|
1437
|
+
/**
|
|
1438
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1439
|
+
*/
|
|
1440
|
+
line: number;
|
|
1441
|
+
/**
|
|
1442
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1443
|
+
*/
|
|
1444
|
+
startIndex: number;
|
|
1445
|
+
/**
|
|
1446
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1447
|
+
*/
|
|
1448
|
+
endIndex: number;
|
|
1449
|
+
}
|
|
1450
|
+
export interface Screenshot {
|
|
1451
|
+
screenshot: Screenshot1;
|
|
1452
|
+
[k: string]: unknown;
|
|
1453
|
+
}
|
|
1454
|
+
export interface CaptureScreenshotDetailed {
|
|
1455
|
+
path?: ScreenshotSimple1;
|
|
1456
|
+
/**
|
|
1457
|
+
* Directory of the PNG file. If the directory doesn't exist, creates the directory.
|
|
1458
|
+
*/
|
|
1459
|
+
directory?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored.
|
|
1462
|
+
*/
|
|
1463
|
+
maxVariation?: number;
|
|
1464
|
+
/**
|
|
1465
|
+
* If `true`, overwrites the existing screenshot at `path` if it exists.
|
|
1466
|
+
* If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.
|
|
1467
|
+
*/
|
|
1468
|
+
overwrite?: "true" | "false" | "aboveVariation";
|
|
1469
|
+
crop?: CropByElementSimple | CropByElementDetailed;
|
|
1470
|
+
sourceIntegration?: SourceIntegration;
|
|
1471
|
+
}
|
|
1472
|
+
/**
|
|
1473
|
+
* 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.
|
|
1474
|
+
*/
|
|
1475
|
+
export interface SourceIntegration {
|
|
1476
|
+
/**
|
|
1477
|
+
* The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.
|
|
1478
|
+
*/
|
|
1479
|
+
type: "heretto";
|
|
1480
|
+
/**
|
|
1481
|
+
* The name of the integration configuration in the config file. Used to look up authentication credentials.
|
|
1482
|
+
*/
|
|
1483
|
+
integrationName: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path.
|
|
1486
|
+
*/
|
|
1487
|
+
fileId?: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* The path of the file in the source CMS. Used for lookup if fileId is not available.
|
|
1490
|
+
*/
|
|
1491
|
+
filePath?: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* The local path to the file that references this source. Used for resolving relative paths.
|
|
1494
|
+
*/
|
|
1495
|
+
contentPath?: string;
|
|
1496
|
+
}
|
|
1497
|
+
export interface Common9 {
|
|
1498
|
+
/**
|
|
1499
|
+
* JSON Schema for this object.
|
|
1500
|
+
*/
|
|
1501
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1502
|
+
/**
|
|
1503
|
+
* ID of the step.
|
|
1504
|
+
*/
|
|
1505
|
+
stepId?: string;
|
|
1506
|
+
/**
|
|
1507
|
+
* Description of the step.
|
|
1508
|
+
*/
|
|
1509
|
+
description?: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1512
|
+
*/
|
|
1513
|
+
unsafe?: boolean;
|
|
1514
|
+
outputs?: OutputsStep9;
|
|
1515
|
+
variables?: VariablesStep9;
|
|
1516
|
+
/**
|
|
1517
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1518
|
+
*/
|
|
1519
|
+
breakpoint?: boolean;
|
|
1520
|
+
location?: SourceLocation9;
|
|
1521
|
+
[k: string]: unknown;
|
|
1522
|
+
}
|
|
1523
|
+
/**
|
|
1524
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1525
|
+
*/
|
|
1526
|
+
export interface OutputsStep9 {
|
|
1527
|
+
/**
|
|
1528
|
+
* Runtime expression for a user-defined output value.
|
|
1529
|
+
*
|
|
1530
|
+
* This interface was referenced by `OutputsStep9`'s JSON-Schema definition
|
|
1531
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1532
|
+
*/
|
|
1533
|
+
[k: string]: string;
|
|
1534
|
+
}
|
|
1535
|
+
/**
|
|
1536
|
+
* Environment variables to set from user-defined expressions.
|
|
1537
|
+
*/
|
|
1538
|
+
export interface VariablesStep9 {
|
|
1539
|
+
/**
|
|
1540
|
+
* Runtime expression for a user-defined output value.
|
|
1541
|
+
*
|
|
1542
|
+
* This interface was referenced by `VariablesStep9`'s JSON-Schema definition
|
|
1543
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1544
|
+
*/
|
|
1545
|
+
[k: string]: string;
|
|
1546
|
+
}
|
|
1547
|
+
/**
|
|
1548
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1549
|
+
*/
|
|
1550
|
+
export interface SourceLocation9 {
|
|
1551
|
+
/**
|
|
1552
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1553
|
+
*/
|
|
1554
|
+
line: number;
|
|
1555
|
+
/**
|
|
1556
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1557
|
+
*/
|
|
1558
|
+
startIndex: number;
|
|
1559
|
+
/**
|
|
1560
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1561
|
+
*/
|
|
1562
|
+
endIndex: number;
|
|
1563
|
+
}
|
|
1564
|
+
export interface SaveCookie {
|
|
1565
|
+
saveCookie: SaveCookie1;
|
|
1566
|
+
[k: string]: unknown;
|
|
1567
|
+
}
|
|
1568
|
+
export interface Common10 {
|
|
1569
|
+
/**
|
|
1570
|
+
* JSON Schema for this object.
|
|
1571
|
+
*/
|
|
1572
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1573
|
+
/**
|
|
1574
|
+
* ID of the step.
|
|
1575
|
+
*/
|
|
1576
|
+
stepId?: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* Description of the step.
|
|
1579
|
+
*/
|
|
1580
|
+
description?: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1583
|
+
*/
|
|
1584
|
+
unsafe?: boolean;
|
|
1585
|
+
outputs?: OutputsStep10;
|
|
1586
|
+
variables?: VariablesStep10;
|
|
1587
|
+
/**
|
|
1588
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1589
|
+
*/
|
|
1590
|
+
breakpoint?: boolean;
|
|
1591
|
+
location?: SourceLocation10;
|
|
1592
|
+
[k: string]: unknown;
|
|
1593
|
+
}
|
|
1594
|
+
/**
|
|
1595
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1596
|
+
*/
|
|
1597
|
+
export interface OutputsStep10 {
|
|
1598
|
+
/**
|
|
1599
|
+
* Runtime expression for a user-defined output value.
|
|
1600
|
+
*
|
|
1601
|
+
* This interface was referenced by `OutputsStep10`'s JSON-Schema definition
|
|
1602
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1603
|
+
*/
|
|
1604
|
+
[k: string]: string;
|
|
1605
|
+
}
|
|
1606
|
+
/**
|
|
1607
|
+
* Environment variables to set from user-defined expressions.
|
|
1608
|
+
*/
|
|
1609
|
+
export interface VariablesStep10 {
|
|
1610
|
+
/**
|
|
1611
|
+
* Runtime expression for a user-defined output value.
|
|
1612
|
+
*
|
|
1613
|
+
* This interface was referenced by `VariablesStep10`'s JSON-Schema definition
|
|
1614
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1615
|
+
*/
|
|
1616
|
+
[k: string]: string;
|
|
1617
|
+
}
|
|
1618
|
+
/**
|
|
1619
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1620
|
+
*/
|
|
1621
|
+
export interface SourceLocation10 {
|
|
1622
|
+
/**
|
|
1623
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1624
|
+
*/
|
|
1625
|
+
line: number;
|
|
1626
|
+
/**
|
|
1627
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1628
|
+
*/
|
|
1629
|
+
startIndex: number;
|
|
1630
|
+
/**
|
|
1631
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1632
|
+
*/
|
|
1633
|
+
endIndex: number;
|
|
1634
|
+
}
|
|
1635
|
+
export interface Record {
|
|
1636
|
+
record: Record1;
|
|
1637
|
+
[k: string]: unknown;
|
|
1638
|
+
}
|
|
1639
|
+
export interface RecordDetailed {
|
|
1640
|
+
/**
|
|
1641
|
+
* File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.
|
|
1642
|
+
*/
|
|
1643
|
+
path?: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* Directory of the file. If the directory doesn't exist, creates the directory.
|
|
1646
|
+
*/
|
|
1647
|
+
directory?: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* If `true`, overwrites the existing recording at `path` if it exists.
|
|
1650
|
+
*/
|
|
1651
|
+
overwrite?: "true" | "false";
|
|
1652
|
+
[k: string]: unknown;
|
|
1653
|
+
}
|
|
1654
|
+
export interface Common11 {
|
|
1655
|
+
/**
|
|
1656
|
+
* JSON Schema for this object.
|
|
1657
|
+
*/
|
|
1658
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1659
|
+
/**
|
|
1660
|
+
* ID of the step.
|
|
1661
|
+
*/
|
|
1662
|
+
stepId?: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* Description of the step.
|
|
1665
|
+
*/
|
|
1666
|
+
description?: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1669
|
+
*/
|
|
1670
|
+
unsafe?: boolean;
|
|
1671
|
+
outputs?: OutputsStep11;
|
|
1672
|
+
variables?: VariablesStep11;
|
|
1673
|
+
/**
|
|
1674
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1675
|
+
*/
|
|
1676
|
+
breakpoint?: boolean;
|
|
1677
|
+
location?: SourceLocation11;
|
|
1678
|
+
[k: string]: unknown;
|
|
1679
|
+
}
|
|
1680
|
+
/**
|
|
1681
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1682
|
+
*/
|
|
1683
|
+
export interface OutputsStep11 {
|
|
1684
|
+
/**
|
|
1685
|
+
* Runtime expression for a user-defined output value.
|
|
1686
|
+
*
|
|
1687
|
+
* This interface was referenced by `OutputsStep11`'s JSON-Schema definition
|
|
1688
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1689
|
+
*/
|
|
1690
|
+
[k: string]: string;
|
|
1691
|
+
}
|
|
1692
|
+
/**
|
|
1693
|
+
* Environment variables to set from user-defined expressions.
|
|
1694
|
+
*/
|
|
1695
|
+
export interface VariablesStep11 {
|
|
1696
|
+
/**
|
|
1697
|
+
* Runtime expression for a user-defined output value.
|
|
1698
|
+
*
|
|
1699
|
+
* This interface was referenced by `VariablesStep11`'s JSON-Schema definition
|
|
1700
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1701
|
+
*/
|
|
1702
|
+
[k: string]: string;
|
|
1703
|
+
}
|
|
1704
|
+
/**
|
|
1705
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1706
|
+
*/
|
|
1707
|
+
export interface SourceLocation11 {
|
|
1708
|
+
/**
|
|
1709
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1710
|
+
*/
|
|
1711
|
+
line: number;
|
|
1712
|
+
/**
|
|
1713
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1714
|
+
*/
|
|
1715
|
+
startIndex: number;
|
|
1716
|
+
/**
|
|
1717
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1718
|
+
*/
|
|
1719
|
+
endIndex: number;
|
|
1720
|
+
}
|
|
1721
|
+
export interface StopRecord {
|
|
1722
|
+
stopRecord: StopRecord1;
|
|
1723
|
+
[k: string]: unknown;
|
|
1724
|
+
}
|
|
1725
|
+
export interface Common12 {
|
|
1726
|
+
/**
|
|
1727
|
+
* JSON Schema for this object.
|
|
1728
|
+
*/
|
|
1729
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1730
|
+
/**
|
|
1731
|
+
* ID of the step.
|
|
1732
|
+
*/
|
|
1733
|
+
stepId?: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* Description of the step.
|
|
1736
|
+
*/
|
|
1737
|
+
description?: string;
|
|
1738
|
+
/**
|
|
1739
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1740
|
+
*/
|
|
1741
|
+
unsafe?: boolean;
|
|
1742
|
+
outputs?: OutputsStep12;
|
|
1743
|
+
variables?: VariablesStep12;
|
|
1744
|
+
/**
|
|
1745
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1746
|
+
*/
|
|
1747
|
+
breakpoint?: boolean;
|
|
1748
|
+
location?: SourceLocation12;
|
|
1749
|
+
[k: string]: unknown;
|
|
1750
|
+
}
|
|
1751
|
+
/**
|
|
1752
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1753
|
+
*/
|
|
1754
|
+
export interface OutputsStep12 {
|
|
1755
|
+
/**
|
|
1756
|
+
* Runtime expression for a user-defined output value.
|
|
1757
|
+
*
|
|
1758
|
+
* This interface was referenced by `OutputsStep12`'s JSON-Schema definition
|
|
1759
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1760
|
+
*/
|
|
1761
|
+
[k: string]: string;
|
|
1762
|
+
}
|
|
1763
|
+
/**
|
|
1764
|
+
* Environment variables to set from user-defined expressions.
|
|
1765
|
+
*/
|
|
1766
|
+
export interface VariablesStep12 {
|
|
1767
|
+
/**
|
|
1768
|
+
* Runtime expression for a user-defined output value.
|
|
1769
|
+
*
|
|
1770
|
+
* This interface was referenced by `VariablesStep12`'s JSON-Schema definition
|
|
1771
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1772
|
+
*/
|
|
1773
|
+
[k: string]: string;
|
|
1774
|
+
}
|
|
1775
|
+
/**
|
|
1776
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1777
|
+
*/
|
|
1778
|
+
export interface SourceLocation12 {
|
|
1779
|
+
/**
|
|
1780
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1781
|
+
*/
|
|
1782
|
+
line: number;
|
|
1783
|
+
/**
|
|
1784
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1785
|
+
*/
|
|
1786
|
+
startIndex: number;
|
|
1787
|
+
/**
|
|
1788
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1789
|
+
*/
|
|
1790
|
+
endIndex: number;
|
|
1791
|
+
}
|
|
1792
|
+
export interface LoadVariables {
|
|
1793
|
+
loadVariables: LoadVariables1;
|
|
1794
|
+
[k: string]: unknown;
|
|
1795
|
+
}
|
|
1796
|
+
export interface Common13 {
|
|
1797
|
+
/**
|
|
1798
|
+
* JSON Schema for this object.
|
|
1799
|
+
*/
|
|
1800
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1801
|
+
/**
|
|
1802
|
+
* ID of the step.
|
|
1803
|
+
*/
|
|
1804
|
+
stepId?: string;
|
|
1805
|
+
/**
|
|
1806
|
+
* Description of the step.
|
|
1807
|
+
*/
|
|
1808
|
+
description?: string;
|
|
1809
|
+
/**
|
|
1810
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1811
|
+
*/
|
|
1812
|
+
unsafe?: boolean;
|
|
1813
|
+
outputs?: OutputsStep13;
|
|
1814
|
+
variables?: VariablesStep13;
|
|
1815
|
+
/**
|
|
1816
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1817
|
+
*/
|
|
1818
|
+
breakpoint?: boolean;
|
|
1819
|
+
location?: SourceLocation13;
|
|
1820
|
+
[k: string]: unknown;
|
|
1821
|
+
}
|
|
1822
|
+
/**
|
|
1823
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1824
|
+
*/
|
|
1825
|
+
export interface OutputsStep13 {
|
|
1826
|
+
/**
|
|
1827
|
+
* Runtime expression for a user-defined output value.
|
|
1828
|
+
*
|
|
1829
|
+
* This interface was referenced by `OutputsStep13`'s JSON-Schema definition
|
|
1830
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1831
|
+
*/
|
|
1832
|
+
[k: string]: string;
|
|
1833
|
+
}
|
|
1834
|
+
/**
|
|
1835
|
+
* Environment variables to set from user-defined expressions.
|
|
1836
|
+
*/
|
|
1837
|
+
export interface VariablesStep13 {
|
|
1838
|
+
/**
|
|
1839
|
+
* Runtime expression for a user-defined output value.
|
|
1840
|
+
*
|
|
1841
|
+
* This interface was referenced by `VariablesStep13`'s JSON-Schema definition
|
|
1842
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1843
|
+
*/
|
|
1844
|
+
[k: string]: string;
|
|
1845
|
+
}
|
|
1846
|
+
/**
|
|
1847
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1848
|
+
*/
|
|
1849
|
+
export interface SourceLocation13 {
|
|
1850
|
+
/**
|
|
1851
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1852
|
+
*/
|
|
1853
|
+
line: number;
|
|
1854
|
+
/**
|
|
1855
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1856
|
+
*/
|
|
1857
|
+
startIndex: number;
|
|
1858
|
+
/**
|
|
1859
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1860
|
+
*/
|
|
1861
|
+
endIndex: number;
|
|
1862
|
+
}
|
|
1863
|
+
export interface DragAndDrop {
|
|
1864
|
+
dragAndDrop: DragAndDrop1;
|
|
1865
|
+
[k: string]: unknown;
|
|
1866
|
+
}
|
|
1867
|
+
/**
|
|
1868
|
+
* Drag and drop an element from source to target.
|
|
1869
|
+
*/
|
|
1870
|
+
export interface DragAndDrop1 {
|
|
1871
|
+
/**
|
|
1872
|
+
* The element to drag.
|
|
1873
|
+
*/
|
|
1874
|
+
source: ElementSimple | ElementDetailed;
|
|
1875
|
+
/**
|
|
1876
|
+
* The target location to drop the element.
|
|
1877
|
+
*/
|
|
1878
|
+
target: ElementSimple1 | ElementDetailed1;
|
|
1879
|
+
/**
|
|
1880
|
+
* Duration of the drag operation in milliseconds.
|
|
1881
|
+
*/
|
|
1882
|
+
duration?: number;
|
|
1883
|
+
[k: string]: unknown;
|
|
1884
|
+
}
|
|
1885
|
+
export interface Common14 {
|
|
1886
|
+
/**
|
|
1887
|
+
* JSON Schema for this object.
|
|
1888
|
+
*/
|
|
1889
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1890
|
+
/**
|
|
1891
|
+
* ID of the step.
|
|
1892
|
+
*/
|
|
1893
|
+
stepId?: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* Description of the step.
|
|
1896
|
+
*/
|
|
1897
|
+
description?: string;
|
|
1898
|
+
/**
|
|
1899
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1900
|
+
*/
|
|
1901
|
+
unsafe?: boolean;
|
|
1902
|
+
outputs?: OutputsStep14;
|
|
1903
|
+
variables?: VariablesStep14;
|
|
1904
|
+
/**
|
|
1905
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1906
|
+
*/
|
|
1907
|
+
breakpoint?: boolean;
|
|
1908
|
+
location?: SourceLocation14;
|
|
1909
|
+
[k: string]: unknown;
|
|
1910
|
+
}
|
|
1911
|
+
/**
|
|
1912
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1913
|
+
*/
|
|
1914
|
+
export interface OutputsStep14 {
|
|
1915
|
+
/**
|
|
1916
|
+
* Runtime expression for a user-defined output value.
|
|
1917
|
+
*
|
|
1918
|
+
* This interface was referenced by `OutputsStep14`'s JSON-Schema definition
|
|
1919
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1920
|
+
*/
|
|
1921
|
+
[k: string]: string;
|
|
1922
|
+
}
|
|
1923
|
+
/**
|
|
1924
|
+
* Environment variables to set from user-defined expressions.
|
|
1925
|
+
*/
|
|
1926
|
+
export interface VariablesStep14 {
|
|
1927
|
+
/**
|
|
1928
|
+
* Runtime expression for a user-defined output value.
|
|
1929
|
+
*
|
|
1930
|
+
* This interface was referenced by `VariablesStep14`'s JSON-Schema definition
|
|
1931
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1932
|
+
*/
|
|
1933
|
+
[k: string]: string;
|
|
1934
|
+
}
|
|
1935
|
+
/**
|
|
1936
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
1937
|
+
*/
|
|
1938
|
+
export interface SourceLocation14 {
|
|
1939
|
+
/**
|
|
1940
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
1941
|
+
*/
|
|
1942
|
+
line: number;
|
|
1943
|
+
/**
|
|
1944
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
1945
|
+
*/
|
|
1946
|
+
startIndex: number;
|
|
1947
|
+
/**
|
|
1948
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
1949
|
+
*/
|
|
1950
|
+
endIndex: number;
|
|
1951
|
+
}
|
|
1952
|
+
export interface LoadCookie {
|
|
1953
|
+
loadCookie: LoadCookie1;
|
|
1954
|
+
[k: string]: unknown;
|
|
1955
|
+
}
|
|
1956
|
+
export interface Common15 {
|
|
1957
|
+
/**
|
|
1958
|
+
* JSON Schema for this object.
|
|
1959
|
+
*/
|
|
1960
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
1961
|
+
/**
|
|
1962
|
+
* ID of the step.
|
|
1963
|
+
*/
|
|
1964
|
+
stepId?: string;
|
|
1965
|
+
/**
|
|
1966
|
+
* Description of the step.
|
|
1967
|
+
*/
|
|
1968
|
+
description?: string;
|
|
1969
|
+
/**
|
|
1970
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
1971
|
+
*/
|
|
1972
|
+
unsafe?: boolean;
|
|
1973
|
+
outputs?: OutputsStep15;
|
|
1974
|
+
variables?: VariablesStep15;
|
|
1975
|
+
/**
|
|
1976
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
1977
|
+
*/
|
|
1978
|
+
breakpoint?: boolean;
|
|
1979
|
+
location?: SourceLocation15;
|
|
1980
|
+
[k: string]: unknown;
|
|
1981
|
+
}
|
|
1982
|
+
/**
|
|
1983
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
1984
|
+
*/
|
|
1985
|
+
export interface OutputsStep15 {
|
|
1986
|
+
/**
|
|
1987
|
+
* Runtime expression for a user-defined output value.
|
|
1988
|
+
*
|
|
1989
|
+
* This interface was referenced by `OutputsStep15`'s JSON-Schema definition
|
|
1990
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
1991
|
+
*/
|
|
1992
|
+
[k: string]: string;
|
|
1993
|
+
}
|
|
1994
|
+
/**
|
|
1995
|
+
* Environment variables to set from user-defined expressions.
|
|
1996
|
+
*/
|
|
1997
|
+
export interface VariablesStep15 {
|
|
1998
|
+
/**
|
|
1999
|
+
* Runtime expression for a user-defined output value.
|
|
2000
|
+
*
|
|
2001
|
+
* This interface was referenced by `VariablesStep15`'s JSON-Schema definition
|
|
2002
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2003
|
+
*/
|
|
2004
|
+
[k: string]: string;
|
|
2005
|
+
}
|
|
2006
|
+
/**
|
|
2007
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2008
|
+
*/
|
|
2009
|
+
export interface SourceLocation15 {
|
|
2010
|
+
/**
|
|
2011
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2012
|
+
*/
|
|
2013
|
+
line: number;
|
|
2014
|
+
/**
|
|
2015
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2016
|
+
*/
|
|
2017
|
+
startIndex: number;
|
|
2018
|
+
/**
|
|
2019
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2020
|
+
*/
|
|
2021
|
+
endIndex: number;
|
|
2022
|
+
}
|
|
2023
|
+
export interface Wait {
|
|
2024
|
+
wait: Wait1;
|
|
2025
|
+
[k: string]: unknown;
|
|
2026
|
+
}
|
|
2027
|
+
export interface ResolvedContext {
|
|
2028
|
+
/**
|
|
2029
|
+
* Platform to run the test on. This is a resolved version of the `platforms` property.
|
|
2030
|
+
*/
|
|
2031
|
+
platform?: string;
|
|
2032
|
+
browser?: Browser2;
|
|
2033
|
+
openApi?: (OpenApi1 & OpenAPIDescriptionTest1)[];
|
|
2034
|
+
/**
|
|
2035
|
+
* Steps to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails. By default, if a step fails, the test stops and the remaining steps are not executed.
|
|
2036
|
+
*
|
|
2037
|
+
* @minItems 1
|
|
2038
|
+
*/
|
|
2039
|
+
steps?: [Step1, ...Step1[]];
|
|
2040
|
+
[k: string]: unknown;
|
|
2041
|
+
}
|
|
2042
|
+
/**
|
|
2043
|
+
* Browser configuration.
|
|
2044
|
+
*/
|
|
2045
|
+
export interface Browser2 {
|
|
2046
|
+
/**
|
|
2047
|
+
* Name of the browser.
|
|
2048
|
+
*/
|
|
2049
|
+
name: "chrome" | "firefox" | "safari" | "webkit";
|
|
2050
|
+
/**
|
|
2051
|
+
* If `true`, runs the browser in headless mode.
|
|
2052
|
+
*/
|
|
2053
|
+
headless?: boolean;
|
|
2054
|
+
window?: BrowserWindow2;
|
|
2055
|
+
viewport?: BrowserViewport2;
|
|
2056
|
+
}
|
|
2057
|
+
/**
|
|
2058
|
+
* Browser dimensions.
|
|
2059
|
+
*/
|
|
2060
|
+
export interface BrowserWindow2 {
|
|
2061
|
+
/**
|
|
2062
|
+
* Width of the browser window in pixels.
|
|
2063
|
+
*/
|
|
2064
|
+
width?: number;
|
|
2065
|
+
/**
|
|
2066
|
+
* Height of the browser window in pixels.
|
|
2067
|
+
*/
|
|
2068
|
+
height?: number;
|
|
2069
|
+
}
|
|
2070
|
+
/**
|
|
2071
|
+
* Viewport dimensions.
|
|
2072
|
+
*/
|
|
2073
|
+
export interface BrowserViewport2 {
|
|
2074
|
+
/**
|
|
2075
|
+
* Width of the viewport in pixels.
|
|
2076
|
+
*/
|
|
2077
|
+
width?: number;
|
|
2078
|
+
/**
|
|
2079
|
+
* Height of the viewport in pixels.
|
|
2080
|
+
*/
|
|
2081
|
+
height?: number;
|
|
2082
|
+
}
|
|
2083
|
+
export interface OpenAPIDescriptionTest1 {
|
|
2084
|
+
[k: string]: unknown;
|
|
2085
|
+
}
|
|
2086
|
+
export interface Common16 {
|
|
2087
|
+
/**
|
|
2088
|
+
* JSON Schema for this object.
|
|
2089
|
+
*/
|
|
2090
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2091
|
+
/**
|
|
2092
|
+
* ID of the step.
|
|
2093
|
+
*/
|
|
2094
|
+
stepId?: string;
|
|
2095
|
+
/**
|
|
2096
|
+
* Description of the step.
|
|
2097
|
+
*/
|
|
2098
|
+
description?: string;
|
|
2099
|
+
/**
|
|
2100
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2101
|
+
*/
|
|
2102
|
+
unsafe?: boolean;
|
|
2103
|
+
outputs?: OutputsStep16;
|
|
2104
|
+
variables?: VariablesStep16;
|
|
2105
|
+
/**
|
|
2106
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2107
|
+
*/
|
|
2108
|
+
breakpoint?: boolean;
|
|
2109
|
+
location?: SourceLocation16;
|
|
2110
|
+
[k: string]: unknown;
|
|
2111
|
+
}
|
|
2112
|
+
/**
|
|
2113
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2114
|
+
*/
|
|
2115
|
+
export interface OutputsStep16 {
|
|
2116
|
+
/**
|
|
2117
|
+
* Runtime expression for a user-defined output value.
|
|
2118
|
+
*
|
|
2119
|
+
* This interface was referenced by `OutputsStep16`'s JSON-Schema definition
|
|
2120
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2121
|
+
*/
|
|
2122
|
+
[k: string]: string;
|
|
2123
|
+
}
|
|
2124
|
+
/**
|
|
2125
|
+
* Environment variables to set from user-defined expressions.
|
|
2126
|
+
*/
|
|
2127
|
+
export interface VariablesStep16 {
|
|
2128
|
+
/**
|
|
2129
|
+
* Runtime expression for a user-defined output value.
|
|
2130
|
+
*
|
|
2131
|
+
* This interface was referenced by `VariablesStep16`'s JSON-Schema definition
|
|
2132
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2133
|
+
*/
|
|
2134
|
+
[k: string]: string;
|
|
2135
|
+
}
|
|
2136
|
+
/**
|
|
2137
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2138
|
+
*/
|
|
2139
|
+
export interface SourceLocation16 {
|
|
2140
|
+
/**
|
|
2141
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2142
|
+
*/
|
|
2143
|
+
line: number;
|
|
2144
|
+
/**
|
|
2145
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2146
|
+
*/
|
|
2147
|
+
startIndex: number;
|
|
2148
|
+
/**
|
|
2149
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2150
|
+
*/
|
|
2151
|
+
endIndex: number;
|
|
2152
|
+
}
|
|
2153
|
+
export interface CheckLink2 {
|
|
2154
|
+
checkLink: CheckLink3;
|
|
2155
|
+
[k: string]: unknown;
|
|
2156
|
+
}
|
|
2157
|
+
/**
|
|
2158
|
+
* Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
|
|
2159
|
+
*/
|
|
2160
|
+
export interface CheckLinkDetailed3 {
|
|
2161
|
+
/**
|
|
2162
|
+
* URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.
|
|
2163
|
+
*/
|
|
2164
|
+
url: string;
|
|
2165
|
+
/**
|
|
2166
|
+
* Protocol and domain to navigate to. Prepended to `url`.
|
|
2167
|
+
*/
|
|
2168
|
+
origin?: string;
|
|
2169
|
+
/**
|
|
2170
|
+
* Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.
|
|
2171
|
+
*/
|
|
2172
|
+
statusCodes?: number | number[];
|
|
2173
|
+
}
|
|
2174
|
+
export interface Common17 {
|
|
2175
|
+
/**
|
|
2176
|
+
* JSON Schema for this object.
|
|
2177
|
+
*/
|
|
2178
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2179
|
+
/**
|
|
2180
|
+
* ID of the step.
|
|
2181
|
+
*/
|
|
2182
|
+
stepId?: string;
|
|
2183
|
+
/**
|
|
2184
|
+
* Description of the step.
|
|
2185
|
+
*/
|
|
2186
|
+
description?: string;
|
|
2187
|
+
/**
|
|
2188
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2189
|
+
*/
|
|
2190
|
+
unsafe?: boolean;
|
|
2191
|
+
outputs?: OutputsStep17;
|
|
2192
|
+
variables?: VariablesStep17;
|
|
2193
|
+
/**
|
|
2194
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2195
|
+
*/
|
|
2196
|
+
breakpoint?: boolean;
|
|
2197
|
+
location?: SourceLocation17;
|
|
2198
|
+
[k: string]: unknown;
|
|
2199
|
+
}
|
|
2200
|
+
/**
|
|
2201
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2202
|
+
*/
|
|
2203
|
+
export interface OutputsStep17 {
|
|
2204
|
+
/**
|
|
2205
|
+
* Runtime expression for a user-defined output value.
|
|
2206
|
+
*
|
|
2207
|
+
* This interface was referenced by `OutputsStep17`'s JSON-Schema definition
|
|
2208
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2209
|
+
*/
|
|
2210
|
+
[k: string]: string;
|
|
2211
|
+
}
|
|
2212
|
+
/**
|
|
2213
|
+
* Environment variables to set from user-defined expressions.
|
|
2214
|
+
*/
|
|
2215
|
+
export interface VariablesStep17 {
|
|
2216
|
+
/**
|
|
2217
|
+
* Runtime expression for a user-defined output value.
|
|
2218
|
+
*
|
|
2219
|
+
* This interface was referenced by `VariablesStep17`'s JSON-Schema definition
|
|
2220
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2221
|
+
*/
|
|
2222
|
+
[k: string]: string;
|
|
2223
|
+
}
|
|
2224
|
+
/**
|
|
2225
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2226
|
+
*/
|
|
2227
|
+
export interface SourceLocation17 {
|
|
2228
|
+
/**
|
|
2229
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2230
|
+
*/
|
|
2231
|
+
line: number;
|
|
2232
|
+
/**
|
|
2233
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2234
|
+
*/
|
|
2235
|
+
startIndex: number;
|
|
2236
|
+
/**
|
|
2237
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2238
|
+
*/
|
|
2239
|
+
endIndex: number;
|
|
2240
|
+
}
|
|
2241
|
+
export interface Click2 {
|
|
2242
|
+
click: Click3;
|
|
2243
|
+
[k: string]: unknown;
|
|
2244
|
+
}
|
|
2245
|
+
export interface Common18 {
|
|
2246
|
+
/**
|
|
2247
|
+
* JSON Schema for this object.
|
|
2248
|
+
*/
|
|
2249
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2250
|
+
/**
|
|
2251
|
+
* ID of the step.
|
|
2252
|
+
*/
|
|
2253
|
+
stepId?: string;
|
|
2254
|
+
/**
|
|
2255
|
+
* Description of the step.
|
|
2256
|
+
*/
|
|
2257
|
+
description?: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2260
|
+
*/
|
|
2261
|
+
unsafe?: boolean;
|
|
2262
|
+
outputs?: OutputsStep18;
|
|
2263
|
+
variables?: VariablesStep18;
|
|
2264
|
+
/**
|
|
2265
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2266
|
+
*/
|
|
2267
|
+
breakpoint?: boolean;
|
|
2268
|
+
location?: SourceLocation18;
|
|
2269
|
+
[k: string]: unknown;
|
|
2270
|
+
}
|
|
2271
|
+
/**
|
|
2272
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2273
|
+
*/
|
|
2274
|
+
export interface OutputsStep18 {
|
|
2275
|
+
/**
|
|
2276
|
+
* Runtime expression for a user-defined output value.
|
|
2277
|
+
*
|
|
2278
|
+
* This interface was referenced by `OutputsStep18`'s JSON-Schema definition
|
|
2279
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2280
|
+
*/
|
|
2281
|
+
[k: string]: string;
|
|
2282
|
+
}
|
|
2283
|
+
/**
|
|
2284
|
+
* Environment variables to set from user-defined expressions.
|
|
2285
|
+
*/
|
|
2286
|
+
export interface VariablesStep18 {
|
|
2287
|
+
/**
|
|
2288
|
+
* Runtime expression for a user-defined output value.
|
|
2289
|
+
*
|
|
2290
|
+
* This interface was referenced by `VariablesStep18`'s JSON-Schema definition
|
|
2291
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2292
|
+
*/
|
|
2293
|
+
[k: string]: string;
|
|
2294
|
+
}
|
|
2295
|
+
/**
|
|
2296
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2297
|
+
*/
|
|
2298
|
+
export interface SourceLocation18 {
|
|
2299
|
+
/**
|
|
2300
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2301
|
+
*/
|
|
2302
|
+
line: number;
|
|
2303
|
+
/**
|
|
2304
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2305
|
+
*/
|
|
2306
|
+
startIndex: number;
|
|
2307
|
+
/**
|
|
2308
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2309
|
+
*/
|
|
2310
|
+
endIndex: number;
|
|
2311
|
+
}
|
|
2312
|
+
export interface Find2 {
|
|
2313
|
+
find: Find3;
|
|
2314
|
+
[k: string]: unknown;
|
|
2315
|
+
}
|
|
2316
|
+
export interface Common19 {
|
|
2317
|
+
/**
|
|
2318
|
+
* JSON Schema for this object.
|
|
2319
|
+
*/
|
|
2320
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2321
|
+
/**
|
|
2322
|
+
* ID of the step.
|
|
2323
|
+
*/
|
|
2324
|
+
stepId?: string;
|
|
2325
|
+
/**
|
|
2326
|
+
* Description of the step.
|
|
2327
|
+
*/
|
|
2328
|
+
description?: string;
|
|
2329
|
+
/**
|
|
2330
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2331
|
+
*/
|
|
2332
|
+
unsafe?: boolean;
|
|
2333
|
+
outputs?: OutputsStep19;
|
|
2334
|
+
variables?: VariablesStep19;
|
|
2335
|
+
/**
|
|
2336
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2337
|
+
*/
|
|
2338
|
+
breakpoint?: boolean;
|
|
2339
|
+
location?: SourceLocation19;
|
|
2340
|
+
[k: string]: unknown;
|
|
2341
|
+
}
|
|
2342
|
+
/**
|
|
2343
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2344
|
+
*/
|
|
2345
|
+
export interface OutputsStep19 {
|
|
2346
|
+
/**
|
|
2347
|
+
* Runtime expression for a user-defined output value.
|
|
2348
|
+
*
|
|
2349
|
+
* This interface was referenced by `OutputsStep19`'s JSON-Schema definition
|
|
2350
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2351
|
+
*/
|
|
2352
|
+
[k: string]: string;
|
|
2353
|
+
}
|
|
2354
|
+
/**
|
|
2355
|
+
* Environment variables to set from user-defined expressions.
|
|
2356
|
+
*/
|
|
2357
|
+
export interface VariablesStep19 {
|
|
2358
|
+
/**
|
|
2359
|
+
* Runtime expression for a user-defined output value.
|
|
2360
|
+
*
|
|
2361
|
+
* This interface was referenced by `VariablesStep19`'s JSON-Schema definition
|
|
2362
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2363
|
+
*/
|
|
2364
|
+
[k: string]: string;
|
|
2365
|
+
}
|
|
2366
|
+
/**
|
|
2367
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2368
|
+
*/
|
|
2369
|
+
export interface SourceLocation19 {
|
|
2370
|
+
/**
|
|
2371
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2372
|
+
*/
|
|
2373
|
+
line: number;
|
|
2374
|
+
/**
|
|
2375
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2376
|
+
*/
|
|
2377
|
+
startIndex: number;
|
|
2378
|
+
/**
|
|
2379
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2380
|
+
*/
|
|
2381
|
+
endIndex: number;
|
|
2382
|
+
}
|
|
2383
|
+
export interface GoTo2 {
|
|
2384
|
+
goTo: GoTo3;
|
|
2385
|
+
[k: string]: unknown;
|
|
2386
|
+
}
|
|
2387
|
+
/**
|
|
2388
|
+
* Navigate to an HTTP or HTTPS URL.
|
|
2389
|
+
*/
|
|
2390
|
+
export interface GoToURLDetailed1 {
|
|
2391
|
+
/**
|
|
2392
|
+
* URL to navigate to. Can be a full URL or a path. If a path is provided and `origin` is specified, prepends `origin` to `url`. If a path is provided but `origin` isn't specified, attempts to navigate relative to the current URL, if any.
|
|
2393
|
+
*/
|
|
2394
|
+
url: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* Protocol and domain to navigate to. Prepended to `url`.
|
|
2397
|
+
*/
|
|
2398
|
+
origin?: string;
|
|
2399
|
+
/**
|
|
2400
|
+
* Maximum time in milliseconds to wait for the page to be ready. If exceeded, the goTo action fails.
|
|
2401
|
+
*/
|
|
2402
|
+
timeout?: number;
|
|
2403
|
+
/**
|
|
2404
|
+
* Configuration for waiting conditions after navigation.
|
|
2405
|
+
*/
|
|
2406
|
+
waitUntil?: {
|
|
2407
|
+
/**
|
|
2408
|
+
* Wait for network activity to be idle (no new requests) for this duration in milliseconds. Set to `null` to skip this check.
|
|
2409
|
+
*/
|
|
2410
|
+
networkIdleTime?: number | null;
|
|
2411
|
+
/**
|
|
2412
|
+
* Wait for DOM mutations to stop for this duration in milliseconds. Set to `null` to skip this check.
|
|
2413
|
+
*/
|
|
2414
|
+
domIdleTime?: number | null;
|
|
2415
|
+
/**
|
|
2416
|
+
* Wait for a specific element to be present in the DOM. At least one of selector or elementText must be specified.
|
|
2417
|
+
*/
|
|
2418
|
+
find?: {
|
|
2419
|
+
[k: string]: unknown;
|
|
2420
|
+
} | {
|
|
2421
|
+
[k: string]: unknown;
|
|
2422
|
+
} | {
|
|
2423
|
+
[k: string]: unknown;
|
|
2424
|
+
} | {
|
|
2425
|
+
[k: string]: unknown;
|
|
2426
|
+
} | {
|
|
2427
|
+
[k: string]: unknown;
|
|
2428
|
+
} | {
|
|
2429
|
+
[k: string]: unknown;
|
|
2430
|
+
} | {
|
|
2431
|
+
[k: string]: unknown;
|
|
2432
|
+
};
|
|
2433
|
+
};
|
|
2434
|
+
}
|
|
2435
|
+
export interface Common20 {
|
|
2436
|
+
/**
|
|
2437
|
+
* JSON Schema for this object.
|
|
2438
|
+
*/
|
|
2439
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2440
|
+
/**
|
|
2441
|
+
* ID of the step.
|
|
2442
|
+
*/
|
|
2443
|
+
stepId?: string;
|
|
2444
|
+
/**
|
|
2445
|
+
* Description of the step.
|
|
2446
|
+
*/
|
|
2447
|
+
description?: string;
|
|
2448
|
+
/**
|
|
2449
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2450
|
+
*/
|
|
2451
|
+
unsafe?: boolean;
|
|
2452
|
+
outputs?: OutputsStep20;
|
|
2453
|
+
variables?: VariablesStep20;
|
|
2454
|
+
/**
|
|
2455
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2456
|
+
*/
|
|
2457
|
+
breakpoint?: boolean;
|
|
2458
|
+
location?: SourceLocation20;
|
|
2459
|
+
[k: string]: unknown;
|
|
2460
|
+
}
|
|
2461
|
+
/**
|
|
2462
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2463
|
+
*/
|
|
2464
|
+
export interface OutputsStep20 {
|
|
2465
|
+
/**
|
|
2466
|
+
* Runtime expression for a user-defined output value.
|
|
2467
|
+
*
|
|
2468
|
+
* This interface was referenced by `OutputsStep20`'s JSON-Schema definition
|
|
2469
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2470
|
+
*/
|
|
2471
|
+
[k: string]: string;
|
|
2472
|
+
}
|
|
2473
|
+
/**
|
|
2474
|
+
* Environment variables to set from user-defined expressions.
|
|
2475
|
+
*/
|
|
2476
|
+
export interface VariablesStep20 {
|
|
2477
|
+
/**
|
|
2478
|
+
* Runtime expression for a user-defined output value.
|
|
2479
|
+
*
|
|
2480
|
+
* This interface was referenced by `VariablesStep20`'s JSON-Schema definition
|
|
2481
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2482
|
+
*/
|
|
2483
|
+
[k: string]: string;
|
|
2484
|
+
}
|
|
2485
|
+
/**
|
|
2486
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2487
|
+
*/
|
|
2488
|
+
export interface SourceLocation20 {
|
|
2489
|
+
/**
|
|
2490
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2491
|
+
*/
|
|
2492
|
+
line: number;
|
|
2493
|
+
/**
|
|
2494
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2495
|
+
*/
|
|
2496
|
+
startIndex: number;
|
|
2497
|
+
/**
|
|
2498
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2499
|
+
*/
|
|
2500
|
+
endIndex: number;
|
|
2501
|
+
}
|
|
2502
|
+
export interface HttpRequest2 {
|
|
2503
|
+
httpRequest: HttpRequest3;
|
|
2504
|
+
[k: string]: unknown;
|
|
2505
|
+
}
|
|
2506
|
+
export interface Common21 {
|
|
2507
|
+
/**
|
|
2508
|
+
* JSON Schema for this object.
|
|
2509
|
+
*/
|
|
2510
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2511
|
+
/**
|
|
2512
|
+
* ID of the step.
|
|
2513
|
+
*/
|
|
2514
|
+
stepId?: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* Description of the step.
|
|
2517
|
+
*/
|
|
2518
|
+
description?: string;
|
|
2519
|
+
/**
|
|
2520
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2521
|
+
*/
|
|
2522
|
+
unsafe?: boolean;
|
|
2523
|
+
outputs?: OutputsStep21;
|
|
2524
|
+
variables?: VariablesStep21;
|
|
2525
|
+
/**
|
|
2526
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2527
|
+
*/
|
|
2528
|
+
breakpoint?: boolean;
|
|
2529
|
+
location?: SourceLocation21;
|
|
2530
|
+
[k: string]: unknown;
|
|
2531
|
+
}
|
|
2532
|
+
/**
|
|
2533
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2534
|
+
*/
|
|
2535
|
+
export interface OutputsStep21 {
|
|
2536
|
+
/**
|
|
2537
|
+
* Runtime expression for a user-defined output value.
|
|
2538
|
+
*
|
|
2539
|
+
* This interface was referenced by `OutputsStep21`'s JSON-Schema definition
|
|
2540
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2541
|
+
*/
|
|
2542
|
+
[k: string]: string;
|
|
2543
|
+
}
|
|
2544
|
+
/**
|
|
2545
|
+
* Environment variables to set from user-defined expressions.
|
|
2546
|
+
*/
|
|
2547
|
+
export interface VariablesStep21 {
|
|
2548
|
+
/**
|
|
2549
|
+
* Runtime expression for a user-defined output value.
|
|
2550
|
+
*
|
|
2551
|
+
* This interface was referenced by `VariablesStep21`'s JSON-Schema definition
|
|
2552
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2553
|
+
*/
|
|
2554
|
+
[k: string]: string;
|
|
2555
|
+
}
|
|
2556
|
+
/**
|
|
2557
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2558
|
+
*/
|
|
2559
|
+
export interface SourceLocation21 {
|
|
2560
|
+
/**
|
|
2561
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2562
|
+
*/
|
|
2563
|
+
line: number;
|
|
2564
|
+
/**
|
|
2565
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2566
|
+
*/
|
|
2567
|
+
startIndex: number;
|
|
2568
|
+
/**
|
|
2569
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2570
|
+
*/
|
|
2571
|
+
endIndex: number;
|
|
2572
|
+
}
|
|
2573
|
+
export interface RunShell2 {
|
|
2574
|
+
runShell: RunShell3;
|
|
2575
|
+
[k: string]: unknown;
|
|
2576
|
+
}
|
|
2577
|
+
export interface RunShellCommandDetailed1 {
|
|
2578
|
+
/**
|
|
2579
|
+
* Command to perform in the machine's default shell.
|
|
2580
|
+
*/
|
|
2581
|
+
command: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* Arguments for the command.
|
|
2584
|
+
*/
|
|
2585
|
+
args?: string[];
|
|
2586
|
+
/**
|
|
2587
|
+
* Working directory for the command.
|
|
2588
|
+
*/
|
|
2589
|
+
workingDirectory?: string;
|
|
2590
|
+
/**
|
|
2591
|
+
* Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
|
|
2592
|
+
*/
|
|
2593
|
+
exitCodes?: number[];
|
|
2594
|
+
/**
|
|
2595
|
+
* Content expected in the command's stdout or stderr. If the expected content can't be found in the command's stdout or stderr, the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.* /`.
|
|
2596
|
+
*/
|
|
2597
|
+
stdio?: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* File path to save the command's output, relative to `directory`.
|
|
2600
|
+
*/
|
|
2601
|
+
path?: string;
|
|
2602
|
+
/**
|
|
2603
|
+
* Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory.
|
|
2604
|
+
*/
|
|
2605
|
+
directory?: string;
|
|
2606
|
+
/**
|
|
2607
|
+
* Allowed variation as a fraction (0 to 1) of text different between the current output and previously saved output. For example, 0.1 means 10%. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.
|
|
2608
|
+
*/
|
|
2609
|
+
maxVariation?: number;
|
|
2610
|
+
/**
|
|
2611
|
+
* If `true`, overwrites the existing output at `path` if it exists.
|
|
2612
|
+
* If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
|
|
2613
|
+
*/
|
|
2614
|
+
overwrite?: "true" | "false" | "aboveVariation";
|
|
2615
|
+
/**
|
|
2616
|
+
* Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
|
|
2617
|
+
*/
|
|
2618
|
+
timeout?: number;
|
|
2619
|
+
}
|
|
2620
|
+
export interface Common22 {
|
|
2621
|
+
/**
|
|
2622
|
+
* JSON Schema for this object.
|
|
2623
|
+
*/
|
|
2624
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2625
|
+
/**
|
|
2626
|
+
* ID of the step.
|
|
2627
|
+
*/
|
|
2628
|
+
stepId?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Description of the step.
|
|
2631
|
+
*/
|
|
2632
|
+
description?: string;
|
|
2633
|
+
/**
|
|
2634
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2635
|
+
*/
|
|
2636
|
+
unsafe?: boolean;
|
|
2637
|
+
outputs?: OutputsStep22;
|
|
2638
|
+
variables?: VariablesStep22;
|
|
2639
|
+
/**
|
|
2640
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2641
|
+
*/
|
|
2642
|
+
breakpoint?: boolean;
|
|
2643
|
+
location?: SourceLocation22;
|
|
2644
|
+
[k: string]: unknown;
|
|
2645
|
+
}
|
|
2646
|
+
/**
|
|
2647
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2648
|
+
*/
|
|
2649
|
+
export interface OutputsStep22 {
|
|
2650
|
+
/**
|
|
2651
|
+
* Runtime expression for a user-defined output value.
|
|
2652
|
+
*
|
|
2653
|
+
* This interface was referenced by `OutputsStep22`'s JSON-Schema definition
|
|
2654
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2655
|
+
*/
|
|
2656
|
+
[k: string]: string;
|
|
2657
|
+
}
|
|
2658
|
+
/**
|
|
2659
|
+
* Environment variables to set from user-defined expressions.
|
|
2660
|
+
*/
|
|
2661
|
+
export interface VariablesStep22 {
|
|
2662
|
+
/**
|
|
2663
|
+
* Runtime expression for a user-defined output value.
|
|
2664
|
+
*
|
|
2665
|
+
* This interface was referenced by `VariablesStep22`'s JSON-Schema definition
|
|
2666
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2667
|
+
*/
|
|
2668
|
+
[k: string]: string;
|
|
2669
|
+
}
|
|
2670
|
+
/**
|
|
2671
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2672
|
+
*/
|
|
2673
|
+
export interface SourceLocation22 {
|
|
2674
|
+
/**
|
|
2675
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2676
|
+
*/
|
|
2677
|
+
line: number;
|
|
2678
|
+
/**
|
|
2679
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2680
|
+
*/
|
|
2681
|
+
startIndex: number;
|
|
2682
|
+
/**
|
|
2683
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2684
|
+
*/
|
|
2685
|
+
endIndex: number;
|
|
2686
|
+
}
|
|
2687
|
+
export interface RunCode2 {
|
|
2688
|
+
runCode: RunCode3;
|
|
2689
|
+
[k: string]: unknown;
|
|
2690
|
+
}
|
|
2691
|
+
export interface RunCodeDetailed1 {
|
|
2692
|
+
/**
|
|
2693
|
+
* Language of the code to run.
|
|
2694
|
+
*/
|
|
2695
|
+
language: "python" | "bash" | "javascript";
|
|
2696
|
+
/**
|
|
2697
|
+
* Code to run.
|
|
2698
|
+
*/
|
|
2699
|
+
code: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* Arguments for the command.
|
|
2702
|
+
*/
|
|
2703
|
+
args?: string[];
|
|
2704
|
+
/**
|
|
2705
|
+
* Working directory for the command.
|
|
2706
|
+
*/
|
|
2707
|
+
workingDirectory?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
|
|
2710
|
+
*/
|
|
2711
|
+
exitCodes?: number[];
|
|
2712
|
+
/**
|
|
2713
|
+
* Content expected in the command's output. If the expected content can't be found in the command's output (either stdout or stderr), the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.* /`.
|
|
2714
|
+
*/
|
|
2715
|
+
stdio?: string;
|
|
2716
|
+
/**
|
|
2717
|
+
* File path to save the command's output, relative to `directory`.
|
|
2718
|
+
*/
|
|
2719
|
+
path?: string;
|
|
2720
|
+
/**
|
|
2721
|
+
* Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory.
|
|
2722
|
+
*/
|
|
2723
|
+
directory?: string;
|
|
2724
|
+
/**
|
|
2725
|
+
* Allowed variation as a fraction (0 to 1) of text different between the current output and previously saved output. For example, 0.1 means 10%. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.
|
|
2726
|
+
*/
|
|
2727
|
+
maxVariation?: number;
|
|
2728
|
+
/**
|
|
2729
|
+
* If `true`, overwrites the existing output at `path` if it exists.
|
|
2730
|
+
* If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
|
|
2731
|
+
*/
|
|
2732
|
+
overwrite?: "true" | "false" | "aboveVariation";
|
|
2733
|
+
/**
|
|
2734
|
+
* Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
|
|
2735
|
+
*/
|
|
2736
|
+
timeout?: number;
|
|
2737
|
+
[k: string]: unknown;
|
|
2738
|
+
}
|
|
2739
|
+
export interface Common23 {
|
|
2740
|
+
/**
|
|
2741
|
+
* JSON Schema for this object.
|
|
2742
|
+
*/
|
|
2743
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2744
|
+
/**
|
|
2745
|
+
* ID of the step.
|
|
2746
|
+
*/
|
|
2747
|
+
stepId?: string;
|
|
2748
|
+
/**
|
|
2749
|
+
* Description of the step.
|
|
2750
|
+
*/
|
|
2751
|
+
description?: string;
|
|
2752
|
+
/**
|
|
2753
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2754
|
+
*/
|
|
2755
|
+
unsafe?: boolean;
|
|
2756
|
+
outputs?: OutputsStep23;
|
|
2757
|
+
variables?: VariablesStep23;
|
|
2758
|
+
/**
|
|
2759
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2760
|
+
*/
|
|
2761
|
+
breakpoint?: boolean;
|
|
2762
|
+
location?: SourceLocation23;
|
|
2763
|
+
[k: string]: unknown;
|
|
2764
|
+
}
|
|
2765
|
+
/**
|
|
2766
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2767
|
+
*/
|
|
2768
|
+
export interface OutputsStep23 {
|
|
2769
|
+
/**
|
|
2770
|
+
* Runtime expression for a user-defined output value.
|
|
2771
|
+
*
|
|
2772
|
+
* This interface was referenced by `OutputsStep23`'s JSON-Schema definition
|
|
2773
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2774
|
+
*/
|
|
2775
|
+
[k: string]: string;
|
|
2776
|
+
}
|
|
2777
|
+
/**
|
|
2778
|
+
* Environment variables to set from user-defined expressions.
|
|
2779
|
+
*/
|
|
2780
|
+
export interface VariablesStep23 {
|
|
2781
|
+
/**
|
|
2782
|
+
* Runtime expression for a user-defined output value.
|
|
2783
|
+
*
|
|
2784
|
+
* This interface was referenced by `VariablesStep23`'s JSON-Schema definition
|
|
2785
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2786
|
+
*/
|
|
2787
|
+
[k: string]: string;
|
|
2788
|
+
}
|
|
2789
|
+
/**
|
|
2790
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2791
|
+
*/
|
|
2792
|
+
export interface SourceLocation23 {
|
|
2793
|
+
/**
|
|
2794
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2795
|
+
*/
|
|
2796
|
+
line: number;
|
|
2797
|
+
/**
|
|
2798
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2799
|
+
*/
|
|
2800
|
+
startIndex: number;
|
|
2801
|
+
/**
|
|
2802
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2803
|
+
*/
|
|
2804
|
+
endIndex: number;
|
|
2805
|
+
}
|
|
2806
|
+
export interface Type1 {
|
|
2807
|
+
type: TypeKeys1;
|
|
2808
|
+
[k: string]: unknown;
|
|
2809
|
+
}
|
|
2810
|
+
export interface TypeKeysDetailed1 {
|
|
2811
|
+
keys: TypeKeysSimple3;
|
|
2812
|
+
/**
|
|
2813
|
+
* Delay in milliseconds between each key press during a recording
|
|
2814
|
+
*/
|
|
2815
|
+
inputDelay?: number;
|
|
2816
|
+
/**
|
|
2817
|
+
* Selector for the element to type into. If not specified, the typing occurs in the active element.
|
|
2818
|
+
*/
|
|
2819
|
+
selector?: string;
|
|
2820
|
+
/**
|
|
2821
|
+
* Display text of the element to type into. If combined with other element finding fields, the element must match all specified criteria.
|
|
2822
|
+
*/
|
|
2823
|
+
elementText?: string;
|
|
2824
|
+
/**
|
|
2825
|
+
* ID attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.
|
|
2826
|
+
*/
|
|
2827
|
+
elementId?: string;
|
|
2828
|
+
/**
|
|
2829
|
+
* data-testid attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.
|
|
2830
|
+
*/
|
|
2831
|
+
elementTestId?: string;
|
|
2832
|
+
/**
|
|
2833
|
+
* Class or array of classes that the element must have. Each class supports exact match or regex pattern using /pattern/ syntax. Element must have all specified classes.
|
|
2834
|
+
*/
|
|
2835
|
+
elementClass?: string | string[];
|
|
2836
|
+
/**
|
|
2837
|
+
* Object of attribute key-value pairs that the element must have. Values can be strings (supporting /pattern/ regex), numbers, or booleans. Boolean true matches attribute presence, false matches absence.
|
|
2838
|
+
*/
|
|
2839
|
+
elementAttribute?: {
|
|
2840
|
+
[k: string]: string | number | boolean;
|
|
2841
|
+
};
|
|
2842
|
+
/**
|
|
2843
|
+
* Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
|
|
2844
|
+
*/
|
|
2845
|
+
elementAria?: string;
|
|
2846
|
+
}
|
|
2847
|
+
export interface Common24 {
|
|
2848
|
+
/**
|
|
2849
|
+
* JSON Schema for this object.
|
|
2850
|
+
*/
|
|
2851
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2852
|
+
/**
|
|
2853
|
+
* ID of the step.
|
|
2854
|
+
*/
|
|
2855
|
+
stepId?: string;
|
|
2856
|
+
/**
|
|
2857
|
+
* Description of the step.
|
|
2858
|
+
*/
|
|
2859
|
+
description?: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2862
|
+
*/
|
|
2863
|
+
unsafe?: boolean;
|
|
2864
|
+
outputs?: OutputsStep24;
|
|
2865
|
+
variables?: VariablesStep24;
|
|
2866
|
+
/**
|
|
2867
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2868
|
+
*/
|
|
2869
|
+
breakpoint?: boolean;
|
|
2870
|
+
location?: SourceLocation24;
|
|
2871
|
+
[k: string]: unknown;
|
|
2872
|
+
}
|
|
2873
|
+
/**
|
|
2874
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2875
|
+
*/
|
|
2876
|
+
export interface OutputsStep24 {
|
|
2877
|
+
/**
|
|
2878
|
+
* Runtime expression for a user-defined output value.
|
|
2879
|
+
*
|
|
2880
|
+
* This interface was referenced by `OutputsStep24`'s JSON-Schema definition
|
|
2881
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2882
|
+
*/
|
|
2883
|
+
[k: string]: string;
|
|
2884
|
+
}
|
|
2885
|
+
/**
|
|
2886
|
+
* Environment variables to set from user-defined expressions.
|
|
2887
|
+
*/
|
|
2888
|
+
export interface VariablesStep24 {
|
|
2889
|
+
/**
|
|
2890
|
+
* Runtime expression for a user-defined output value.
|
|
2891
|
+
*
|
|
2892
|
+
* This interface was referenced by `VariablesStep24`'s JSON-Schema definition
|
|
2893
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2894
|
+
*/
|
|
2895
|
+
[k: string]: string;
|
|
2896
|
+
}
|
|
2897
|
+
/**
|
|
2898
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
2899
|
+
*/
|
|
2900
|
+
export interface SourceLocation24 {
|
|
2901
|
+
/**
|
|
2902
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
2903
|
+
*/
|
|
2904
|
+
line: number;
|
|
2905
|
+
/**
|
|
2906
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
2907
|
+
*/
|
|
2908
|
+
startIndex: number;
|
|
2909
|
+
/**
|
|
2910
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
2911
|
+
*/
|
|
2912
|
+
endIndex: number;
|
|
2913
|
+
}
|
|
2914
|
+
export interface Screenshot2 {
|
|
2915
|
+
screenshot: Screenshot3;
|
|
2916
|
+
[k: string]: unknown;
|
|
2917
|
+
}
|
|
2918
|
+
export interface CaptureScreenshotDetailed1 {
|
|
2919
|
+
path?: ScreenshotSimple3;
|
|
2920
|
+
/**
|
|
2921
|
+
* Directory of the PNG file. If the directory doesn't exist, creates the directory.
|
|
2922
|
+
*/
|
|
2923
|
+
directory?: string;
|
|
2924
|
+
/**
|
|
2925
|
+
* Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored.
|
|
2926
|
+
*/
|
|
2927
|
+
maxVariation?: number;
|
|
2928
|
+
/**
|
|
2929
|
+
* If `true`, overwrites the existing screenshot at `path` if it exists.
|
|
2930
|
+
* If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.
|
|
2931
|
+
*/
|
|
2932
|
+
overwrite?: "true" | "false" | "aboveVariation";
|
|
2933
|
+
crop?: CropByElementSimple1 | CropByElementDetailed1;
|
|
2934
|
+
sourceIntegration?: SourceIntegration1;
|
|
2935
|
+
}
|
|
2936
|
+
/**
|
|
2937
|
+
* 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.
|
|
2938
|
+
*/
|
|
2939
|
+
export interface SourceIntegration1 {
|
|
2940
|
+
/**
|
|
2941
|
+
* The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.
|
|
2942
|
+
*/
|
|
2943
|
+
type: "heretto";
|
|
2944
|
+
/**
|
|
2945
|
+
* The name of the integration configuration in the config file. Used to look up authentication credentials.
|
|
2946
|
+
*/
|
|
2947
|
+
integrationName: string;
|
|
2948
|
+
/**
|
|
2949
|
+
* The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path.
|
|
2950
|
+
*/
|
|
2951
|
+
fileId?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
* The path of the file in the source CMS. Used for lookup if fileId is not available.
|
|
2954
|
+
*/
|
|
2955
|
+
filePath?: string;
|
|
2956
|
+
/**
|
|
2957
|
+
* The local path to the file that references this source. Used for resolving relative paths.
|
|
2958
|
+
*/
|
|
2959
|
+
contentPath?: string;
|
|
2960
|
+
}
|
|
2961
|
+
export interface Common25 {
|
|
2962
|
+
/**
|
|
2963
|
+
* JSON Schema for this object.
|
|
2964
|
+
*/
|
|
2965
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
2966
|
+
/**
|
|
2967
|
+
* ID of the step.
|
|
2968
|
+
*/
|
|
2969
|
+
stepId?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
* Description of the step.
|
|
2972
|
+
*/
|
|
2973
|
+
description?: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
2976
|
+
*/
|
|
2977
|
+
unsafe?: boolean;
|
|
2978
|
+
outputs?: OutputsStep25;
|
|
2979
|
+
variables?: VariablesStep25;
|
|
2980
|
+
/**
|
|
2981
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
2982
|
+
*/
|
|
2983
|
+
breakpoint?: boolean;
|
|
2984
|
+
location?: SourceLocation25;
|
|
2985
|
+
[k: string]: unknown;
|
|
2986
|
+
}
|
|
2987
|
+
/**
|
|
2988
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
2989
|
+
*/
|
|
2990
|
+
export interface OutputsStep25 {
|
|
2991
|
+
/**
|
|
2992
|
+
* Runtime expression for a user-defined output value.
|
|
2993
|
+
*
|
|
2994
|
+
* This interface was referenced by `OutputsStep25`'s JSON-Schema definition
|
|
2995
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
2996
|
+
*/
|
|
2997
|
+
[k: string]: string;
|
|
2998
|
+
}
|
|
2999
|
+
/**
|
|
3000
|
+
* Environment variables to set from user-defined expressions.
|
|
3001
|
+
*/
|
|
3002
|
+
export interface VariablesStep25 {
|
|
3003
|
+
/**
|
|
3004
|
+
* Runtime expression for a user-defined output value.
|
|
3005
|
+
*
|
|
3006
|
+
* This interface was referenced by `VariablesStep25`'s JSON-Schema definition
|
|
3007
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3008
|
+
*/
|
|
3009
|
+
[k: string]: string;
|
|
3010
|
+
}
|
|
3011
|
+
/**
|
|
3012
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3013
|
+
*/
|
|
3014
|
+
export interface SourceLocation25 {
|
|
3015
|
+
/**
|
|
3016
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3017
|
+
*/
|
|
3018
|
+
line: number;
|
|
3019
|
+
/**
|
|
3020
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3021
|
+
*/
|
|
3022
|
+
startIndex: number;
|
|
3023
|
+
/**
|
|
3024
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3025
|
+
*/
|
|
3026
|
+
endIndex: number;
|
|
3027
|
+
}
|
|
3028
|
+
export interface SaveCookie2 {
|
|
3029
|
+
saveCookie: SaveCookie3;
|
|
3030
|
+
[k: string]: unknown;
|
|
3031
|
+
}
|
|
3032
|
+
export interface Common26 {
|
|
3033
|
+
/**
|
|
3034
|
+
* JSON Schema for this object.
|
|
3035
|
+
*/
|
|
3036
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
3037
|
+
/**
|
|
3038
|
+
* ID of the step.
|
|
3039
|
+
*/
|
|
3040
|
+
stepId?: string;
|
|
3041
|
+
/**
|
|
3042
|
+
* Description of the step.
|
|
3043
|
+
*/
|
|
3044
|
+
description?: string;
|
|
3045
|
+
/**
|
|
3046
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
3047
|
+
*/
|
|
3048
|
+
unsafe?: boolean;
|
|
3049
|
+
outputs?: OutputsStep26;
|
|
3050
|
+
variables?: VariablesStep26;
|
|
3051
|
+
/**
|
|
3052
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
3053
|
+
*/
|
|
3054
|
+
breakpoint?: boolean;
|
|
3055
|
+
location?: SourceLocation26;
|
|
3056
|
+
[k: string]: unknown;
|
|
3057
|
+
}
|
|
3058
|
+
/**
|
|
3059
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
3060
|
+
*/
|
|
3061
|
+
export interface OutputsStep26 {
|
|
3062
|
+
/**
|
|
3063
|
+
* Runtime expression for a user-defined output value.
|
|
3064
|
+
*
|
|
3065
|
+
* This interface was referenced by `OutputsStep26`'s JSON-Schema definition
|
|
3066
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3067
|
+
*/
|
|
3068
|
+
[k: string]: string;
|
|
3069
|
+
}
|
|
3070
|
+
/**
|
|
3071
|
+
* Environment variables to set from user-defined expressions.
|
|
3072
|
+
*/
|
|
3073
|
+
export interface VariablesStep26 {
|
|
3074
|
+
/**
|
|
3075
|
+
* Runtime expression for a user-defined output value.
|
|
3076
|
+
*
|
|
3077
|
+
* This interface was referenced by `VariablesStep26`'s JSON-Schema definition
|
|
3078
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3079
|
+
*/
|
|
3080
|
+
[k: string]: string;
|
|
3081
|
+
}
|
|
3082
|
+
/**
|
|
3083
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3084
|
+
*/
|
|
3085
|
+
export interface SourceLocation26 {
|
|
3086
|
+
/**
|
|
3087
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3088
|
+
*/
|
|
3089
|
+
line: number;
|
|
3090
|
+
/**
|
|
3091
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3092
|
+
*/
|
|
3093
|
+
startIndex: number;
|
|
3094
|
+
/**
|
|
3095
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3096
|
+
*/
|
|
3097
|
+
endIndex: number;
|
|
3098
|
+
}
|
|
3099
|
+
export interface Record2 {
|
|
3100
|
+
record: Record3;
|
|
3101
|
+
[k: string]: unknown;
|
|
3102
|
+
}
|
|
3103
|
+
export interface RecordDetailed1 {
|
|
3104
|
+
/**
|
|
3105
|
+
* File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.
|
|
3106
|
+
*/
|
|
3107
|
+
path?: string;
|
|
3108
|
+
/**
|
|
3109
|
+
* Directory of the file. If the directory doesn't exist, creates the directory.
|
|
3110
|
+
*/
|
|
3111
|
+
directory?: string;
|
|
3112
|
+
/**
|
|
3113
|
+
* If `true`, overwrites the existing recording at `path` if it exists.
|
|
3114
|
+
*/
|
|
3115
|
+
overwrite?: "true" | "false";
|
|
3116
|
+
[k: string]: unknown;
|
|
3117
|
+
}
|
|
3118
|
+
export interface Common27 {
|
|
3119
|
+
/**
|
|
3120
|
+
* JSON Schema for this object.
|
|
3121
|
+
*/
|
|
3122
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
3123
|
+
/**
|
|
3124
|
+
* ID of the step.
|
|
3125
|
+
*/
|
|
3126
|
+
stepId?: string;
|
|
3127
|
+
/**
|
|
3128
|
+
* Description of the step.
|
|
3129
|
+
*/
|
|
3130
|
+
description?: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
3133
|
+
*/
|
|
3134
|
+
unsafe?: boolean;
|
|
3135
|
+
outputs?: OutputsStep27;
|
|
3136
|
+
variables?: VariablesStep27;
|
|
3137
|
+
/**
|
|
3138
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
3139
|
+
*/
|
|
3140
|
+
breakpoint?: boolean;
|
|
3141
|
+
location?: SourceLocation27;
|
|
3142
|
+
[k: string]: unknown;
|
|
3143
|
+
}
|
|
3144
|
+
/**
|
|
3145
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
3146
|
+
*/
|
|
3147
|
+
export interface OutputsStep27 {
|
|
3148
|
+
/**
|
|
3149
|
+
* Runtime expression for a user-defined output value.
|
|
3150
|
+
*
|
|
3151
|
+
* This interface was referenced by `OutputsStep27`'s JSON-Schema definition
|
|
3152
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3153
|
+
*/
|
|
3154
|
+
[k: string]: string;
|
|
3155
|
+
}
|
|
3156
|
+
/**
|
|
3157
|
+
* Environment variables to set from user-defined expressions.
|
|
3158
|
+
*/
|
|
3159
|
+
export interface VariablesStep27 {
|
|
3160
|
+
/**
|
|
3161
|
+
* Runtime expression for a user-defined output value.
|
|
3162
|
+
*
|
|
3163
|
+
* This interface was referenced by `VariablesStep27`'s JSON-Schema definition
|
|
3164
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3165
|
+
*/
|
|
3166
|
+
[k: string]: string;
|
|
3167
|
+
}
|
|
3168
|
+
/**
|
|
3169
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3170
|
+
*/
|
|
3171
|
+
export interface SourceLocation27 {
|
|
3172
|
+
/**
|
|
3173
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3174
|
+
*/
|
|
3175
|
+
line: number;
|
|
3176
|
+
/**
|
|
3177
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3178
|
+
*/
|
|
3179
|
+
startIndex: number;
|
|
3180
|
+
/**
|
|
3181
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3182
|
+
*/
|
|
3183
|
+
endIndex: number;
|
|
3184
|
+
}
|
|
3185
|
+
export interface StopRecord2 {
|
|
3186
|
+
stopRecord: StopRecord3;
|
|
3187
|
+
[k: string]: unknown;
|
|
3188
|
+
}
|
|
3189
|
+
export interface Common28 {
|
|
3190
|
+
/**
|
|
3191
|
+
* JSON Schema for this object.
|
|
3192
|
+
*/
|
|
3193
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
3194
|
+
/**
|
|
3195
|
+
* ID of the step.
|
|
3196
|
+
*/
|
|
3197
|
+
stepId?: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* Description of the step.
|
|
3200
|
+
*/
|
|
3201
|
+
description?: string;
|
|
3202
|
+
/**
|
|
3203
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
3204
|
+
*/
|
|
3205
|
+
unsafe?: boolean;
|
|
3206
|
+
outputs?: OutputsStep28;
|
|
3207
|
+
variables?: VariablesStep28;
|
|
3208
|
+
/**
|
|
3209
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
3210
|
+
*/
|
|
3211
|
+
breakpoint?: boolean;
|
|
3212
|
+
location?: SourceLocation28;
|
|
3213
|
+
[k: string]: unknown;
|
|
3214
|
+
}
|
|
3215
|
+
/**
|
|
3216
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
3217
|
+
*/
|
|
3218
|
+
export interface OutputsStep28 {
|
|
3219
|
+
/**
|
|
3220
|
+
* Runtime expression for a user-defined output value.
|
|
3221
|
+
*
|
|
3222
|
+
* This interface was referenced by `OutputsStep28`'s JSON-Schema definition
|
|
3223
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3224
|
+
*/
|
|
3225
|
+
[k: string]: string;
|
|
3226
|
+
}
|
|
3227
|
+
/**
|
|
3228
|
+
* Environment variables to set from user-defined expressions.
|
|
3229
|
+
*/
|
|
3230
|
+
export interface VariablesStep28 {
|
|
3231
|
+
/**
|
|
3232
|
+
* Runtime expression for a user-defined output value.
|
|
3233
|
+
*
|
|
3234
|
+
* This interface was referenced by `VariablesStep28`'s JSON-Schema definition
|
|
3235
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3236
|
+
*/
|
|
3237
|
+
[k: string]: string;
|
|
3238
|
+
}
|
|
3239
|
+
/**
|
|
3240
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3241
|
+
*/
|
|
3242
|
+
export interface SourceLocation28 {
|
|
3243
|
+
/**
|
|
3244
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3245
|
+
*/
|
|
3246
|
+
line: number;
|
|
3247
|
+
/**
|
|
3248
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3249
|
+
*/
|
|
3250
|
+
startIndex: number;
|
|
3251
|
+
/**
|
|
3252
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3253
|
+
*/
|
|
3254
|
+
endIndex: number;
|
|
3255
|
+
}
|
|
3256
|
+
export interface LoadVariables2 {
|
|
3257
|
+
loadVariables: LoadVariables3;
|
|
3258
|
+
[k: string]: unknown;
|
|
3259
|
+
}
|
|
3260
|
+
export interface Common29 {
|
|
3261
|
+
/**
|
|
3262
|
+
* JSON Schema for this object.
|
|
3263
|
+
*/
|
|
3264
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
3265
|
+
/**
|
|
3266
|
+
* ID of the step.
|
|
3267
|
+
*/
|
|
3268
|
+
stepId?: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* Description of the step.
|
|
3271
|
+
*/
|
|
3272
|
+
description?: string;
|
|
3273
|
+
/**
|
|
3274
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
3275
|
+
*/
|
|
3276
|
+
unsafe?: boolean;
|
|
3277
|
+
outputs?: OutputsStep29;
|
|
3278
|
+
variables?: VariablesStep29;
|
|
3279
|
+
/**
|
|
3280
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
3281
|
+
*/
|
|
3282
|
+
breakpoint?: boolean;
|
|
3283
|
+
location?: SourceLocation29;
|
|
3284
|
+
[k: string]: unknown;
|
|
3285
|
+
}
|
|
3286
|
+
/**
|
|
3287
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
3288
|
+
*/
|
|
3289
|
+
export interface OutputsStep29 {
|
|
3290
|
+
/**
|
|
3291
|
+
* Runtime expression for a user-defined output value.
|
|
3292
|
+
*
|
|
3293
|
+
* This interface was referenced by `OutputsStep29`'s JSON-Schema definition
|
|
3294
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3295
|
+
*/
|
|
3296
|
+
[k: string]: string;
|
|
3297
|
+
}
|
|
3298
|
+
/**
|
|
3299
|
+
* Environment variables to set from user-defined expressions.
|
|
3300
|
+
*/
|
|
3301
|
+
export interface VariablesStep29 {
|
|
3302
|
+
/**
|
|
3303
|
+
* Runtime expression for a user-defined output value.
|
|
3304
|
+
*
|
|
3305
|
+
* This interface was referenced by `VariablesStep29`'s JSON-Schema definition
|
|
3306
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3307
|
+
*/
|
|
3308
|
+
[k: string]: string;
|
|
3309
|
+
}
|
|
3310
|
+
/**
|
|
3311
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3312
|
+
*/
|
|
3313
|
+
export interface SourceLocation29 {
|
|
3314
|
+
/**
|
|
3315
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3316
|
+
*/
|
|
3317
|
+
line: number;
|
|
3318
|
+
/**
|
|
3319
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3320
|
+
*/
|
|
3321
|
+
startIndex: number;
|
|
3322
|
+
/**
|
|
3323
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3324
|
+
*/
|
|
3325
|
+
endIndex: number;
|
|
3326
|
+
}
|
|
3327
|
+
export interface DragAndDrop2 {
|
|
3328
|
+
dragAndDrop: DragAndDrop3;
|
|
3329
|
+
[k: string]: unknown;
|
|
3330
|
+
}
|
|
3331
|
+
/**
|
|
3332
|
+
* Drag and drop an element from source to target.
|
|
3333
|
+
*/
|
|
3334
|
+
export interface DragAndDrop3 {
|
|
3335
|
+
/**
|
|
3336
|
+
* The element to drag.
|
|
3337
|
+
*/
|
|
3338
|
+
source: ElementSimple2 | ElementDetailed2;
|
|
3339
|
+
/**
|
|
3340
|
+
* The target location to drop the element.
|
|
3341
|
+
*/
|
|
3342
|
+
target: ElementSimple3 | ElementDetailed3;
|
|
3343
|
+
/**
|
|
3344
|
+
* Duration of the drag operation in milliseconds.
|
|
3345
|
+
*/
|
|
3346
|
+
duration?: number;
|
|
3347
|
+
[k: string]: unknown;
|
|
3348
|
+
}
|
|
3349
|
+
export interface Common30 {
|
|
3350
|
+
/**
|
|
3351
|
+
* JSON Schema for this object.
|
|
3352
|
+
*/
|
|
3353
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
3354
|
+
/**
|
|
3355
|
+
* ID of the step.
|
|
3356
|
+
*/
|
|
3357
|
+
stepId?: string;
|
|
3358
|
+
/**
|
|
3359
|
+
* Description of the step.
|
|
3360
|
+
*/
|
|
3361
|
+
description?: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
3364
|
+
*/
|
|
3365
|
+
unsafe?: boolean;
|
|
3366
|
+
outputs?: OutputsStep30;
|
|
3367
|
+
variables?: VariablesStep30;
|
|
3368
|
+
/**
|
|
3369
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
3370
|
+
*/
|
|
3371
|
+
breakpoint?: boolean;
|
|
3372
|
+
location?: SourceLocation30;
|
|
3373
|
+
[k: string]: unknown;
|
|
3374
|
+
}
|
|
3375
|
+
/**
|
|
3376
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
3377
|
+
*/
|
|
3378
|
+
export interface OutputsStep30 {
|
|
3379
|
+
/**
|
|
3380
|
+
* Runtime expression for a user-defined output value.
|
|
3381
|
+
*
|
|
3382
|
+
* This interface was referenced by `OutputsStep30`'s JSON-Schema definition
|
|
3383
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3384
|
+
*/
|
|
3385
|
+
[k: string]: string;
|
|
3386
|
+
}
|
|
3387
|
+
/**
|
|
3388
|
+
* Environment variables to set from user-defined expressions.
|
|
3389
|
+
*/
|
|
3390
|
+
export interface VariablesStep30 {
|
|
3391
|
+
/**
|
|
3392
|
+
* Runtime expression for a user-defined output value.
|
|
3393
|
+
*
|
|
3394
|
+
* This interface was referenced by `VariablesStep30`'s JSON-Schema definition
|
|
3395
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3396
|
+
*/
|
|
3397
|
+
[k: string]: string;
|
|
3398
|
+
}
|
|
3399
|
+
/**
|
|
3400
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3401
|
+
*/
|
|
3402
|
+
export interface SourceLocation30 {
|
|
3403
|
+
/**
|
|
3404
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3405
|
+
*/
|
|
3406
|
+
line: number;
|
|
3407
|
+
/**
|
|
3408
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3409
|
+
*/
|
|
3410
|
+
startIndex: number;
|
|
3411
|
+
/**
|
|
3412
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3413
|
+
*/
|
|
3414
|
+
endIndex: number;
|
|
3415
|
+
}
|
|
3416
|
+
export interface LoadCookie2 {
|
|
3417
|
+
loadCookie: LoadCookie3;
|
|
3418
|
+
[k: string]: unknown;
|
|
3419
|
+
}
|
|
3420
|
+
export interface Common31 {
|
|
3421
|
+
/**
|
|
3422
|
+
* JSON Schema for this object.
|
|
3423
|
+
*/
|
|
3424
|
+
$schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
|
|
3425
|
+
/**
|
|
3426
|
+
* ID of the step.
|
|
3427
|
+
*/
|
|
3428
|
+
stepId?: string;
|
|
3429
|
+
/**
|
|
3430
|
+
* Description of the step.
|
|
3431
|
+
*/
|
|
3432
|
+
description?: string;
|
|
3433
|
+
/**
|
|
3434
|
+
* Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.
|
|
3435
|
+
*/
|
|
3436
|
+
unsafe?: boolean;
|
|
3437
|
+
outputs?: OutputsStep31;
|
|
3438
|
+
variables?: VariablesStep31;
|
|
3439
|
+
/**
|
|
3440
|
+
* Whether or not this step should act as a breakpoint when debugging is enabled. When `true`, execution will pause at this step when debug mode is enabled.
|
|
3441
|
+
*/
|
|
3442
|
+
breakpoint?: boolean;
|
|
3443
|
+
location?: SourceLocation31;
|
|
3444
|
+
[k: string]: unknown;
|
|
3445
|
+
}
|
|
3446
|
+
/**
|
|
3447
|
+
* Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.
|
|
3448
|
+
*/
|
|
3449
|
+
export interface OutputsStep31 {
|
|
3450
|
+
/**
|
|
3451
|
+
* Runtime expression for a user-defined output value.
|
|
3452
|
+
*
|
|
3453
|
+
* This interface was referenced by `OutputsStep31`'s JSON-Schema definition
|
|
3454
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3455
|
+
*/
|
|
3456
|
+
[k: string]: string;
|
|
3457
|
+
}
|
|
3458
|
+
/**
|
|
3459
|
+
* Environment variables to set from user-defined expressions.
|
|
3460
|
+
*/
|
|
3461
|
+
export interface VariablesStep31 {
|
|
3462
|
+
/**
|
|
3463
|
+
* Runtime expression for a user-defined output value.
|
|
3464
|
+
*
|
|
3465
|
+
* This interface was referenced by `VariablesStep31`'s JSON-Schema definition
|
|
3466
|
+
* via the `patternProperty` "^[A-Za-z0-9_]+$".
|
|
3467
|
+
*/
|
|
3468
|
+
[k: string]: string;
|
|
3469
|
+
}
|
|
3470
|
+
/**
|
|
3471
|
+
* Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
|
|
3472
|
+
*/
|
|
3473
|
+
export interface SourceLocation31 {
|
|
3474
|
+
/**
|
|
3475
|
+
* 1-indexed line number in the source file where the step was detected.
|
|
3476
|
+
*/
|
|
3477
|
+
line: number;
|
|
3478
|
+
/**
|
|
3479
|
+
* 0-indexed character offset from the start of the source file where the step begins.
|
|
3480
|
+
*/
|
|
3481
|
+
startIndex: number;
|
|
3482
|
+
/**
|
|
3483
|
+
* 0-indexed character offset from the start of the source file where the step ends (exclusive).
|
|
3484
|
+
*/
|
|
3485
|
+
endIndex: number;
|
|
3486
|
+
}
|
|
3487
|
+
export interface Wait2 {
|
|
3488
|
+
wait: Wait3;
|
|
3489
|
+
[k: string]: unknown;
|
|
3490
|
+
}
|
|
3491
|
+
//# sourceMappingURL=test_v3.d.ts.map
|