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.
Files changed (130) hide show
  1. package/dist/common/src/detectTests.d.ts +101 -0
  2. package/dist/common/src/detectTests.d.ts.map +1 -0
  3. package/dist/common/src/detectTests.js +662 -0
  4. package/dist/common/src/detectTests.js.map +1 -0
  5. package/dist/common/src/fileTypes.d.ts +35 -0
  6. package/dist/common/src/fileTypes.d.ts.map +1 -0
  7. package/dist/common/src/fileTypes.js +293 -0
  8. package/dist/common/src/fileTypes.js.map +1 -0
  9. package/dist/common/src/index.d.ts +10 -0
  10. package/dist/common/src/index.d.ts.map +1 -0
  11. package/dist/common/src/index.js +5 -0
  12. package/dist/common/src/index.js.map +1 -0
  13. package/dist/common/src/schemas/index.d.ts +5 -0
  14. package/dist/common/src/schemas/index.d.ts.map +1 -0
  15. package/dist/common/src/schemas/index.js +3 -0
  16. package/dist/common/src/schemas/index.js.map +1 -0
  17. package/dist/common/src/schemas/schemas.json +128117 -0
  18. package/dist/common/src/types/generated/checkLink_v3.d.ts +27 -0
  19. package/dist/common/src/types/generated/checkLink_v3.d.ts.map +1 -0
  20. package/dist/common/src/types/generated/checkLink_v3.js +7 -0
  21. package/dist/common/src/types/generated/checkLink_v3.js.map +1 -0
  22. package/dist/common/src/types/generated/click_v3.d.ts +16 -0
  23. package/dist/common/src/types/generated/click_v3.d.ts.map +1 -0
  24. package/dist/common/src/types/generated/click_v3.js +7 -0
  25. package/dist/common/src/types/generated/click_v3.js.map +1 -0
  26. package/dist/common/src/types/generated/config_v3.d.ts +398 -0
  27. package/dist/common/src/types/generated/config_v3.d.ts.map +1 -0
  28. package/dist/common/src/types/generated/config_v3.js +7 -0
  29. package/dist/common/src/types/generated/config_v3.js.map +1 -0
  30. package/dist/common/src/types/generated/context_v3.d.ts +108 -0
  31. package/dist/common/src/types/generated/context_v3.d.ts.map +1 -0
  32. package/dist/common/src/types/generated/context_v3.js +7 -0
  33. package/dist/common/src/types/generated/context_v3.js.map +1 -0
  34. package/dist/common/src/types/generated/dragAndDrop_v3.d.ts +37 -0
  35. package/dist/common/src/types/generated/dragAndDrop_v3.d.ts.map +1 -0
  36. package/dist/common/src/types/generated/dragAndDrop_v3.js +7 -0
  37. package/dist/common/src/types/generated/dragAndDrop_v3.js.map +1 -0
  38. package/dist/common/src/types/generated/endRecord_v3.d.ts +9 -0
  39. package/dist/common/src/types/generated/endRecord_v3.d.ts.map +1 -0
  40. package/dist/common/src/types/generated/endRecord_v3.js +7 -0
  41. package/dist/common/src/types/generated/endRecord_v3.js.map +1 -0
  42. package/dist/common/src/types/generated/find_v3.d.ts +16 -0
  43. package/dist/common/src/types/generated/find_v3.d.ts.map +1 -0
  44. package/dist/common/src/types/generated/find_v3.js +7 -0
  45. package/dist/common/src/types/generated/find_v3.js.map +1 -0
  46. package/dist/common/src/types/generated/goTo_v3.d.ts +46 -0
  47. package/dist/common/src/types/generated/goTo_v3.d.ts.map +1 -0
  48. package/dist/common/src/types/generated/goTo_v3.js +7 -0
  49. package/dist/common/src/types/generated/goTo_v3.js.map +1 -0
  50. package/dist/common/src/types/generated/httpRequest_v3.d.ts +16 -0
  51. package/dist/common/src/types/generated/httpRequest_v3.d.ts.map +1 -0
  52. package/dist/common/src/types/generated/httpRequest_v3.js +7 -0
  53. package/dist/common/src/types/generated/httpRequest_v3.js.map +1 -0
  54. package/dist/common/src/types/generated/loadCookie_v3.d.ts +16 -0
  55. package/dist/common/src/types/generated/loadCookie_v3.d.ts.map +1 -0
  56. package/dist/common/src/types/generated/loadCookie_v3.js +7 -0
  57. package/dist/common/src/types/generated/loadCookie_v3.js.map +1 -0
  58. package/dist/common/src/types/generated/loadVariables_v3.d.ts +9 -0
  59. package/dist/common/src/types/generated/loadVariables_v3.d.ts.map +1 -0
  60. package/dist/common/src/types/generated/loadVariables_v3.js +7 -0
  61. package/dist/common/src/types/generated/loadVariables_v3.js.map +1 -0
  62. package/dist/common/src/types/generated/openApi_v3.d.ts +62 -0
  63. package/dist/common/src/types/generated/openApi_v3.d.ts.map +1 -0
  64. package/dist/common/src/types/generated/openApi_v3.js +7 -0
  65. package/dist/common/src/types/generated/openApi_v3.js.map +1 -0
  66. package/dist/common/src/types/generated/record_v3.d.ts +32 -0
  67. package/dist/common/src/types/generated/record_v3.d.ts.map +1 -0
  68. package/dist/common/src/types/generated/record_v3.js +7 -0
  69. package/dist/common/src/types/generated/record_v3.js.map +1 -0
  70. package/dist/common/src/types/generated/report_v3.d.ts +174 -0
  71. package/dist/common/src/types/generated/report_v3.d.ts.map +1 -0
  72. package/dist/common/src/types/generated/report_v3.js +7 -0
  73. package/dist/common/src/types/generated/report_v3.js.map +1 -0
  74. package/dist/common/src/types/generated/resolvedTests_v3.d.ts +571 -0
  75. package/dist/common/src/types/generated/resolvedTests_v3.d.ts.map +1 -0
  76. package/dist/common/src/types/generated/resolvedTests_v3.js +7 -0
  77. package/dist/common/src/types/generated/resolvedTests_v3.js.map +1 -0
  78. package/dist/common/src/types/generated/runCode_v3.d.ts +57 -0
  79. package/dist/common/src/types/generated/runCode_v3.d.ts.map +1 -0
  80. package/dist/common/src/types/generated/runCode_v3.js +7 -0
  81. package/dist/common/src/types/generated/runCode_v3.js.map +1 -0
  82. package/dist/common/src/types/generated/runShell_v3.d.ts +56 -0
  83. package/dist/common/src/types/generated/runShell_v3.d.ts.map +1 -0
  84. package/dist/common/src/types/generated/runShell_v3.js +7 -0
  85. package/dist/common/src/types/generated/runShell_v3.js.map +1 -0
  86. package/dist/common/src/types/generated/saveCookie_v3.d.ts +16 -0
  87. package/dist/common/src/types/generated/saveCookie_v3.d.ts.map +1 -0
  88. package/dist/common/src/types/generated/saveCookie_v3.js +7 -0
  89. package/dist/common/src/types/generated/saveCookie_v3.js.map +1 -0
  90. package/dist/common/src/types/generated/screenshot_v3.d.ts +74 -0
  91. package/dist/common/src/types/generated/screenshot_v3.d.ts.map +1 -0
  92. package/dist/common/src/types/generated/screenshot_v3.js +7 -0
  93. package/dist/common/src/types/generated/screenshot_v3.js.map +1 -0
  94. package/dist/common/src/types/generated/sourceIntegration_v3.d.ts +30 -0
  95. package/dist/common/src/types/generated/sourceIntegration_v3.d.ts.map +1 -0
  96. package/dist/common/src/types/generated/sourceIntegration_v3.js +7 -0
  97. package/dist/common/src/types/generated/sourceIntegration_v3.js.map +1 -0
  98. package/dist/common/src/types/generated/spec_v3.d.ts +159 -0
  99. package/dist/common/src/types/generated/spec_v3.d.ts.map +1 -0
  100. package/dist/common/src/types/generated/spec_v3.js +7 -0
  101. package/dist/common/src/types/generated/spec_v3.js.map +1 -0
  102. package/dist/common/src/types/generated/step_v3.d.ts +1558 -0
  103. package/dist/common/src/types/generated/step_v3.d.ts.map +1 -0
  104. package/dist/common/src/types/generated/step_v3.js +7 -0
  105. package/dist/common/src/types/generated/step_v3.js.map +1 -0
  106. package/dist/common/src/types/generated/stopRecord_v3.d.ts +9 -0
  107. package/dist/common/src/types/generated/stopRecord_v3.d.ts.map +1 -0
  108. package/dist/common/src/types/generated/stopRecord_v3.js +7 -0
  109. package/dist/common/src/types/generated/stopRecord_v3.js.map +1 -0
  110. package/dist/common/src/types/generated/test_v3.d.ts +3491 -0
  111. package/dist/common/src/types/generated/test_v3.d.ts.map +1 -0
  112. package/dist/common/src/types/generated/test_v3.js +7 -0
  113. package/dist/common/src/types/generated/test_v3.js.map +1 -0
  114. package/dist/common/src/types/generated/type_v3.d.ts +54 -0
  115. package/dist/common/src/types/generated/type_v3.d.ts.map +1 -0
  116. package/dist/common/src/types/generated/type_v3.js +7 -0
  117. package/dist/common/src/types/generated/type_v3.js.map +1 -0
  118. package/dist/common/src/types/generated/wait_v3.d.ts +12 -0
  119. package/dist/common/src/types/generated/wait_v3.d.ts.map +1 -0
  120. package/dist/common/src/types/generated/wait_v3.js +7 -0
  121. package/dist/common/src/types/generated/wait_v3.js.map +1 -0
  122. package/dist/common/src/validate.d.ts +41 -0
  123. package/dist/common/src/validate.d.ts.map +1 -0
  124. package/dist/common/src/validate.js +557 -0
  125. package/dist/common/src/validate.js.map +1 -0
  126. package/package.json +6 -1
  127. package/.doc-detective.json +0 -1
  128. package/CONTRIBUTIONS.md +0 -27
  129. package/screenshot-boolean.png +0 -0
  130. package/scripts/createCjsWrapper.js +0 -31
@@ -0,0 +1,1558 @@
1
+ /**
2
+ * Auto-generated from step_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * A step in a test.
7
+ */
8
+ 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);
9
+ export type CheckLink1 = CheckLinkDetailed | CheckLinkDetailed1;
10
+ /**
11
+ * Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
12
+ */
13
+ export type CheckLinkDetailed = string;
14
+ /**
15
+ * Click or tap an element.
16
+ */
17
+ export type Click1 = ClickElementSimple | ClickElementDetailed | boolean;
18
+ /**
19
+ * Identifier for the element to click. Can be a selector, element text, ARIA name, ID, or test ID.
20
+ */
21
+ export type ClickElementSimple = string;
22
+ export type ClickElementDetailed = {
23
+ [k: string]: unknown;
24
+ };
25
+ /**
26
+ * Find an element based on display text or a selector, then optionally interact with it.
27
+ */
28
+ export type Find1 = FindElementSimple | FindElementDetailed;
29
+ /**
30
+ * Identifier for the element to find. Can be a selector, element text, ARIA name, ID, or test ID.
31
+ */
32
+ export type FindElementSimple = string;
33
+ export type FindElementDetailed = {
34
+ [k: string]: unknown;
35
+ };
36
+ export type GoTo1 = GoToURLSimple | GoToURLDetailed;
37
+ /**
38
+ * 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.
39
+ */
40
+ export type GoToURLSimple = string;
41
+ /**
42
+ * Perform a generic HTTP request, for example to an API.
43
+ */
44
+ export type HttpRequest1 = HTTPRequestSimple | HTTPRequestDetailed;
45
+ /**
46
+ * URL for the HTTP request.
47
+ */
48
+ export type HTTPRequestSimple = string;
49
+ export type HTTPRequestDetailed = {
50
+ [k: string]: unknown;
51
+ };
52
+ /**
53
+ * Perform a native shell command.
54
+ */
55
+ export type RunShell1 = RunShellCommandSimple | RunShellCommandDetailed;
56
+ /**
57
+ * Command to perform in the machine's default shell.
58
+ */
59
+ export type RunShellCommandSimple = string;
60
+ /**
61
+ * Assemble and run code.
62
+ */
63
+ export type RunCode1 = RunCodeDetailed;
64
+ /**
65
+ * 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$`.
66
+ */
67
+ export type TypeKeys = TypeKeysSimple | TypeKeysDetailed;
68
+ /**
69
+ * Sequence of keys to enter.
70
+ */
71
+ export type TypeKeysSimple = string | string[];
72
+ /**
73
+ * Sequence of keys to enter.
74
+ */
75
+ export type TypeKeysSimple1 = string | string[];
76
+ /**
77
+ * Takes a screenshot in PNG format.
78
+ */
79
+ export type Screenshot1 = ScreenshotSimple | CaptureScreenshotDetailed | CaptureScreenshot;
80
+ /**
81
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
82
+ */
83
+ export type ScreenshotSimple = string;
84
+ /**
85
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
86
+ */
87
+ export type ScreenshotSimple1 = string;
88
+ /**
89
+ * Display text or selector of the element to screenshot.
90
+ */
91
+ export type CropByElementSimple = string;
92
+ /**
93
+ * Crop the screenshot to a specific element.
94
+ */
95
+ export type CropByElementDetailed = {
96
+ [k: string]: unknown;
97
+ };
98
+ /**
99
+ * If `true`, captures a screenshot. If `false`, doesn't capture a screenshot.
100
+ */
101
+ export type CaptureScreenshot = boolean;
102
+ /**
103
+ * Save a specific browser cookie to a file or environment variable for later reuse.
104
+ */
105
+ export type SaveCookie1 = CookieName | SaveCookieDetailed;
106
+ /**
107
+ * Name of the specific cookie to save. Will be saved to a default file path or environment variable.
108
+ */
109
+ export type CookieName = string;
110
+ export type SaveCookieDetailed = {
111
+ [k: string]: unknown;
112
+ };
113
+ /**
114
+ * 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' ]
115
+ */
116
+ export type Record1 = RecordSimple | RecordDetailed | RecordBoolean;
117
+ /**
118
+ * 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`.
119
+ */
120
+ export type RecordSimple = string;
121
+ /**
122
+ * If `true`, records the current browser viewport. If `false`, doesn't record the current browser viewport.
123
+ */
124
+ export type RecordBoolean = boolean;
125
+ /**
126
+ * Stop the current recording.
127
+ */
128
+ export type StopRecord1 = boolean | null;
129
+ /**
130
+ * Load environment variables from the specified `.env` file.
131
+ */
132
+ export type LoadVariables1 = string;
133
+ /**
134
+ * Display text, selector, or regex pattern (enclosed in forward slashes) of the element.
135
+ */
136
+ export type ElementSimple = string;
137
+ export type ElementDetailed = {
138
+ [k: string]: unknown;
139
+ };
140
+ /**
141
+ * Display text, selector, or regex pattern (enclosed in forward slashes) of the element.
142
+ */
143
+ export type ElementSimple1 = string;
144
+ export type ElementDetailed1 = {
145
+ [k: string]: unknown;
146
+ };
147
+ /**
148
+ * Load a specific cookie from a file or environment variable into the browser.
149
+ */
150
+ export type LoadCookie1 = CookieNameOrFilePath | LoadCookieDetailed;
151
+ /**
152
+ * Name of the specific cookie to load from default location, or file path to cookie file.
153
+ */
154
+ export type CookieNameOrFilePath = string;
155
+ export type LoadCookieDetailed = {
156
+ [k: string]: unknown;
157
+ };
158
+ /**
159
+ * Pause (in milliseconds) before performing the next action.
160
+ */
161
+ export type Wait1 = WaitSimple | WaitEnvironmentVariable | WaitBoolean;
162
+ export type WaitSimple = number;
163
+ export type WaitEnvironmentVariable = string;
164
+ export type WaitBoolean = boolean;
165
+ export interface Common {
166
+ /**
167
+ * JSON Schema for this object.
168
+ */
169
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
170
+ /**
171
+ * ID of the step.
172
+ */
173
+ stepId?: string;
174
+ /**
175
+ * Description of the step.
176
+ */
177
+ description?: string;
178
+ /**
179
+ * 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.
180
+ */
181
+ unsafe?: boolean;
182
+ outputs?: OutputsStep;
183
+ variables?: VariablesStep;
184
+ /**
185
+ * 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.
186
+ */
187
+ breakpoint?: boolean;
188
+ location?: SourceLocation;
189
+ [k: string]: unknown;
190
+ }
191
+ /**
192
+ * 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.
193
+ */
194
+ export interface OutputsStep {
195
+ /**
196
+ * Runtime expression for a user-defined output value.
197
+ *
198
+ * This interface was referenced by `OutputsStep`'s JSON-Schema definition
199
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
200
+ */
201
+ [k: string]: string;
202
+ }
203
+ /**
204
+ * Environment variables to set from user-defined expressions.
205
+ */
206
+ export interface VariablesStep {
207
+ /**
208
+ * Runtime expression for a user-defined output value.
209
+ *
210
+ * This interface was referenced by `VariablesStep`'s JSON-Schema definition
211
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
212
+ */
213
+ [k: string]: string;
214
+ }
215
+ /**
216
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
217
+ */
218
+ export interface SourceLocation {
219
+ /**
220
+ * 1-indexed line number in the source file where the step was detected.
221
+ */
222
+ line: number;
223
+ /**
224
+ * 0-indexed character offset from the start of the source file where the step begins.
225
+ */
226
+ startIndex: number;
227
+ /**
228
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
229
+ */
230
+ endIndex: number;
231
+ }
232
+ export interface CheckLink {
233
+ checkLink: CheckLink1;
234
+ [k: string]: unknown;
235
+ }
236
+ /**
237
+ * Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
238
+ */
239
+ export interface CheckLinkDetailed1 {
240
+ /**
241
+ * URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.
242
+ */
243
+ url: string;
244
+ /**
245
+ * Protocol and domain to navigate to. Prepended to `url`.
246
+ */
247
+ origin?: string;
248
+ /**
249
+ * Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.
250
+ */
251
+ statusCodes?: number | number[];
252
+ }
253
+ export interface Common1 {
254
+ /**
255
+ * JSON Schema for this object.
256
+ */
257
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
258
+ /**
259
+ * ID of the step.
260
+ */
261
+ stepId?: string;
262
+ /**
263
+ * Description of the step.
264
+ */
265
+ description?: string;
266
+ /**
267
+ * 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.
268
+ */
269
+ unsafe?: boolean;
270
+ outputs?: OutputsStep1;
271
+ variables?: VariablesStep1;
272
+ /**
273
+ * 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.
274
+ */
275
+ breakpoint?: boolean;
276
+ location?: SourceLocation1;
277
+ [k: string]: unknown;
278
+ }
279
+ /**
280
+ * 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.
281
+ */
282
+ export interface OutputsStep1 {
283
+ /**
284
+ * Runtime expression for a user-defined output value.
285
+ *
286
+ * This interface was referenced by `OutputsStep1`'s JSON-Schema definition
287
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
288
+ */
289
+ [k: string]: string;
290
+ }
291
+ /**
292
+ * Environment variables to set from user-defined expressions.
293
+ */
294
+ export interface VariablesStep1 {
295
+ /**
296
+ * Runtime expression for a user-defined output value.
297
+ *
298
+ * This interface was referenced by `VariablesStep1`'s JSON-Schema definition
299
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
300
+ */
301
+ [k: string]: string;
302
+ }
303
+ /**
304
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
305
+ */
306
+ export interface SourceLocation1 {
307
+ /**
308
+ * 1-indexed line number in the source file where the step was detected.
309
+ */
310
+ line: number;
311
+ /**
312
+ * 0-indexed character offset from the start of the source file where the step begins.
313
+ */
314
+ startIndex: number;
315
+ /**
316
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
317
+ */
318
+ endIndex: number;
319
+ }
320
+ export interface Click {
321
+ click: Click1;
322
+ [k: string]: unknown;
323
+ }
324
+ export interface Common2 {
325
+ /**
326
+ * JSON Schema for this object.
327
+ */
328
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
329
+ /**
330
+ * ID of the step.
331
+ */
332
+ stepId?: string;
333
+ /**
334
+ * Description of the step.
335
+ */
336
+ description?: string;
337
+ /**
338
+ * 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.
339
+ */
340
+ unsafe?: boolean;
341
+ outputs?: OutputsStep2;
342
+ variables?: VariablesStep2;
343
+ /**
344
+ * 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.
345
+ */
346
+ breakpoint?: boolean;
347
+ location?: SourceLocation2;
348
+ [k: string]: unknown;
349
+ }
350
+ /**
351
+ * 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.
352
+ */
353
+ export interface OutputsStep2 {
354
+ /**
355
+ * Runtime expression for a user-defined output value.
356
+ *
357
+ * This interface was referenced by `OutputsStep2`'s JSON-Schema definition
358
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
359
+ */
360
+ [k: string]: string;
361
+ }
362
+ /**
363
+ * Environment variables to set from user-defined expressions.
364
+ */
365
+ export interface VariablesStep2 {
366
+ /**
367
+ * Runtime expression for a user-defined output value.
368
+ *
369
+ * This interface was referenced by `VariablesStep2`'s JSON-Schema definition
370
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
371
+ */
372
+ [k: string]: string;
373
+ }
374
+ /**
375
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
376
+ */
377
+ export interface SourceLocation2 {
378
+ /**
379
+ * 1-indexed line number in the source file where the step was detected.
380
+ */
381
+ line: number;
382
+ /**
383
+ * 0-indexed character offset from the start of the source file where the step begins.
384
+ */
385
+ startIndex: number;
386
+ /**
387
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
388
+ */
389
+ endIndex: number;
390
+ }
391
+ export interface Find {
392
+ find: Find1;
393
+ [k: string]: unknown;
394
+ }
395
+ export interface Common3 {
396
+ /**
397
+ * JSON Schema for this object.
398
+ */
399
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
400
+ /**
401
+ * ID of the step.
402
+ */
403
+ stepId?: string;
404
+ /**
405
+ * Description of the step.
406
+ */
407
+ description?: string;
408
+ /**
409
+ * 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.
410
+ */
411
+ unsafe?: boolean;
412
+ outputs?: OutputsStep3;
413
+ variables?: VariablesStep3;
414
+ /**
415
+ * 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.
416
+ */
417
+ breakpoint?: boolean;
418
+ location?: SourceLocation3;
419
+ [k: string]: unknown;
420
+ }
421
+ /**
422
+ * 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.
423
+ */
424
+ export interface OutputsStep3 {
425
+ /**
426
+ * Runtime expression for a user-defined output value.
427
+ *
428
+ * This interface was referenced by `OutputsStep3`'s JSON-Schema definition
429
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
430
+ */
431
+ [k: string]: string;
432
+ }
433
+ /**
434
+ * Environment variables to set from user-defined expressions.
435
+ */
436
+ export interface VariablesStep3 {
437
+ /**
438
+ * Runtime expression for a user-defined output value.
439
+ *
440
+ * This interface was referenced by `VariablesStep3`'s JSON-Schema definition
441
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
442
+ */
443
+ [k: string]: string;
444
+ }
445
+ /**
446
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
447
+ */
448
+ export interface SourceLocation3 {
449
+ /**
450
+ * 1-indexed line number in the source file where the step was detected.
451
+ */
452
+ line: number;
453
+ /**
454
+ * 0-indexed character offset from the start of the source file where the step begins.
455
+ */
456
+ startIndex: number;
457
+ /**
458
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
459
+ */
460
+ endIndex: number;
461
+ }
462
+ export interface GoTo {
463
+ goTo: GoTo1;
464
+ [k: string]: unknown;
465
+ }
466
+ /**
467
+ * Navigate to an HTTP or HTTPS URL.
468
+ */
469
+ export interface GoToURLDetailed {
470
+ /**
471
+ * 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.
472
+ */
473
+ url: string;
474
+ /**
475
+ * Protocol and domain to navigate to. Prepended to `url`.
476
+ */
477
+ origin?: string;
478
+ /**
479
+ * Maximum time in milliseconds to wait for the page to be ready. If exceeded, the goTo action fails.
480
+ */
481
+ timeout?: number;
482
+ /**
483
+ * Configuration for waiting conditions after navigation.
484
+ */
485
+ waitUntil?: {
486
+ /**
487
+ * Wait for network activity to be idle (no new requests) for this duration in milliseconds. Set to `null` to skip this check.
488
+ */
489
+ networkIdleTime?: number | null;
490
+ /**
491
+ * Wait for DOM mutations to stop for this duration in milliseconds. Set to `null` to skip this check.
492
+ */
493
+ domIdleTime?: number | null;
494
+ /**
495
+ * Wait for a specific element to be present in the DOM. At least one of selector or elementText must be specified.
496
+ */
497
+ find?: {
498
+ [k: string]: unknown;
499
+ };
500
+ };
501
+ }
502
+ export interface Common4 {
503
+ /**
504
+ * JSON Schema for this object.
505
+ */
506
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
507
+ /**
508
+ * ID of the step.
509
+ */
510
+ stepId?: string;
511
+ /**
512
+ * Description of the step.
513
+ */
514
+ description?: string;
515
+ /**
516
+ * 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.
517
+ */
518
+ unsafe?: boolean;
519
+ outputs?: OutputsStep4;
520
+ variables?: VariablesStep4;
521
+ /**
522
+ * 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.
523
+ */
524
+ breakpoint?: boolean;
525
+ location?: SourceLocation4;
526
+ [k: string]: unknown;
527
+ }
528
+ /**
529
+ * 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.
530
+ */
531
+ export interface OutputsStep4 {
532
+ /**
533
+ * Runtime expression for a user-defined output value.
534
+ *
535
+ * This interface was referenced by `OutputsStep4`'s JSON-Schema definition
536
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
537
+ */
538
+ [k: string]: string;
539
+ }
540
+ /**
541
+ * Environment variables to set from user-defined expressions.
542
+ */
543
+ export interface VariablesStep4 {
544
+ /**
545
+ * Runtime expression for a user-defined output value.
546
+ *
547
+ * This interface was referenced by `VariablesStep4`'s JSON-Schema definition
548
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
549
+ */
550
+ [k: string]: string;
551
+ }
552
+ /**
553
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
554
+ */
555
+ export interface SourceLocation4 {
556
+ /**
557
+ * 1-indexed line number in the source file where the step was detected.
558
+ */
559
+ line: number;
560
+ /**
561
+ * 0-indexed character offset from the start of the source file where the step begins.
562
+ */
563
+ startIndex: number;
564
+ /**
565
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
566
+ */
567
+ endIndex: number;
568
+ }
569
+ export interface HttpRequest {
570
+ httpRequest: HttpRequest1;
571
+ [k: string]: unknown;
572
+ }
573
+ export interface Common5 {
574
+ /**
575
+ * JSON Schema for this object.
576
+ */
577
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
578
+ /**
579
+ * ID of the step.
580
+ */
581
+ stepId?: string;
582
+ /**
583
+ * Description of the step.
584
+ */
585
+ description?: string;
586
+ /**
587
+ * 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.
588
+ */
589
+ unsafe?: boolean;
590
+ outputs?: OutputsStep5;
591
+ variables?: VariablesStep5;
592
+ /**
593
+ * 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.
594
+ */
595
+ breakpoint?: boolean;
596
+ location?: SourceLocation5;
597
+ [k: string]: unknown;
598
+ }
599
+ /**
600
+ * 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.
601
+ */
602
+ export interface OutputsStep5 {
603
+ /**
604
+ * Runtime expression for a user-defined output value.
605
+ *
606
+ * This interface was referenced by `OutputsStep5`'s JSON-Schema definition
607
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
608
+ */
609
+ [k: string]: string;
610
+ }
611
+ /**
612
+ * Environment variables to set from user-defined expressions.
613
+ */
614
+ export interface VariablesStep5 {
615
+ /**
616
+ * Runtime expression for a user-defined output value.
617
+ *
618
+ * This interface was referenced by `VariablesStep5`'s JSON-Schema definition
619
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
620
+ */
621
+ [k: string]: string;
622
+ }
623
+ /**
624
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
625
+ */
626
+ export interface SourceLocation5 {
627
+ /**
628
+ * 1-indexed line number in the source file where the step was detected.
629
+ */
630
+ line: number;
631
+ /**
632
+ * 0-indexed character offset from the start of the source file where the step begins.
633
+ */
634
+ startIndex: number;
635
+ /**
636
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
637
+ */
638
+ endIndex: number;
639
+ }
640
+ export interface RunShell {
641
+ runShell: RunShell1;
642
+ [k: string]: unknown;
643
+ }
644
+ export interface RunShellCommandDetailed {
645
+ /**
646
+ * Command to perform in the machine's default shell.
647
+ */
648
+ command: string;
649
+ /**
650
+ * Arguments for the command.
651
+ */
652
+ args?: string[];
653
+ /**
654
+ * Working directory for the command.
655
+ */
656
+ workingDirectory?: string;
657
+ /**
658
+ * Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
659
+ */
660
+ exitCodes?: number[];
661
+ /**
662
+ * 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.* /`.
663
+ */
664
+ stdio?: string;
665
+ /**
666
+ * File path to save the command's output, relative to `directory`.
667
+ */
668
+ path?: string;
669
+ /**
670
+ * 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.
671
+ */
672
+ directory?: string;
673
+ /**
674
+ * 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.
675
+ */
676
+ maxVariation?: number;
677
+ /**
678
+ * If `true`, overwrites the existing output at `path` if it exists.
679
+ * If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
680
+ */
681
+ overwrite?: "true" | "false" | "aboveVariation";
682
+ /**
683
+ * Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
684
+ */
685
+ timeout?: number;
686
+ }
687
+ export interface Common6 {
688
+ /**
689
+ * JSON Schema for this object.
690
+ */
691
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
692
+ /**
693
+ * ID of the step.
694
+ */
695
+ stepId?: string;
696
+ /**
697
+ * Description of the step.
698
+ */
699
+ description?: string;
700
+ /**
701
+ * 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.
702
+ */
703
+ unsafe?: boolean;
704
+ outputs?: OutputsStep6;
705
+ variables?: VariablesStep6;
706
+ /**
707
+ * 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.
708
+ */
709
+ breakpoint?: boolean;
710
+ location?: SourceLocation6;
711
+ [k: string]: unknown;
712
+ }
713
+ /**
714
+ * 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.
715
+ */
716
+ export interface OutputsStep6 {
717
+ /**
718
+ * Runtime expression for a user-defined output value.
719
+ *
720
+ * This interface was referenced by `OutputsStep6`'s JSON-Schema definition
721
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
722
+ */
723
+ [k: string]: string;
724
+ }
725
+ /**
726
+ * Environment variables to set from user-defined expressions.
727
+ */
728
+ export interface VariablesStep6 {
729
+ /**
730
+ * Runtime expression for a user-defined output value.
731
+ *
732
+ * This interface was referenced by `VariablesStep6`'s JSON-Schema definition
733
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
734
+ */
735
+ [k: string]: string;
736
+ }
737
+ /**
738
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
739
+ */
740
+ export interface SourceLocation6 {
741
+ /**
742
+ * 1-indexed line number in the source file where the step was detected.
743
+ */
744
+ line: number;
745
+ /**
746
+ * 0-indexed character offset from the start of the source file where the step begins.
747
+ */
748
+ startIndex: number;
749
+ /**
750
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
751
+ */
752
+ endIndex: number;
753
+ }
754
+ export interface RunCode {
755
+ runCode: RunCode1;
756
+ [k: string]: unknown;
757
+ }
758
+ export interface RunCodeDetailed {
759
+ /**
760
+ * Language of the code to run.
761
+ */
762
+ language: "python" | "bash" | "javascript";
763
+ /**
764
+ * Code to run.
765
+ */
766
+ code: string;
767
+ /**
768
+ * Arguments for the command.
769
+ */
770
+ args?: string[];
771
+ /**
772
+ * Working directory for the command.
773
+ */
774
+ workingDirectory?: string;
775
+ /**
776
+ * Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
777
+ */
778
+ exitCodes?: number[];
779
+ /**
780
+ * 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.* /`.
781
+ */
782
+ stdio?: string;
783
+ /**
784
+ * File path to save the command's output, relative to `directory`.
785
+ */
786
+ path?: string;
787
+ /**
788
+ * 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.
789
+ */
790
+ directory?: string;
791
+ /**
792
+ * 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.
793
+ */
794
+ maxVariation?: number;
795
+ /**
796
+ * If `true`, overwrites the existing output at `path` if it exists.
797
+ * If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
798
+ */
799
+ overwrite?: "true" | "false" | "aboveVariation";
800
+ /**
801
+ * Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
802
+ */
803
+ timeout?: number;
804
+ [k: string]: unknown;
805
+ }
806
+ export interface Common7 {
807
+ /**
808
+ * JSON Schema for this object.
809
+ */
810
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
811
+ /**
812
+ * ID of the step.
813
+ */
814
+ stepId?: string;
815
+ /**
816
+ * Description of the step.
817
+ */
818
+ description?: string;
819
+ /**
820
+ * 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.
821
+ */
822
+ unsafe?: boolean;
823
+ outputs?: OutputsStep7;
824
+ variables?: VariablesStep7;
825
+ /**
826
+ * 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.
827
+ */
828
+ breakpoint?: boolean;
829
+ location?: SourceLocation7;
830
+ [k: string]: unknown;
831
+ }
832
+ /**
833
+ * 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.
834
+ */
835
+ export interface OutputsStep7 {
836
+ /**
837
+ * Runtime expression for a user-defined output value.
838
+ *
839
+ * This interface was referenced by `OutputsStep7`'s JSON-Schema definition
840
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
841
+ */
842
+ [k: string]: string;
843
+ }
844
+ /**
845
+ * Environment variables to set from user-defined expressions.
846
+ */
847
+ export interface VariablesStep7 {
848
+ /**
849
+ * Runtime expression for a user-defined output value.
850
+ *
851
+ * This interface was referenced by `VariablesStep7`'s JSON-Schema definition
852
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
853
+ */
854
+ [k: string]: string;
855
+ }
856
+ /**
857
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
858
+ */
859
+ export interface SourceLocation7 {
860
+ /**
861
+ * 1-indexed line number in the source file where the step was detected.
862
+ */
863
+ line: number;
864
+ /**
865
+ * 0-indexed character offset from the start of the source file where the step begins.
866
+ */
867
+ startIndex: number;
868
+ /**
869
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
870
+ */
871
+ endIndex: number;
872
+ }
873
+ export interface Type {
874
+ type: TypeKeys;
875
+ [k: string]: unknown;
876
+ }
877
+ export interface TypeKeysDetailed {
878
+ keys: TypeKeysSimple1;
879
+ /**
880
+ * Delay in milliseconds between each key press during a recording
881
+ */
882
+ inputDelay?: number;
883
+ /**
884
+ * Selector for the element to type into. If not specified, the typing occurs in the active element.
885
+ */
886
+ selector?: string;
887
+ /**
888
+ * Display text of the element to type into. If combined with other element finding fields, the element must match all specified criteria.
889
+ */
890
+ elementText?: string;
891
+ /**
892
+ * ID attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.
893
+ */
894
+ elementId?: string;
895
+ /**
896
+ * data-testid attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.
897
+ */
898
+ elementTestId?: string;
899
+ /**
900
+ * 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.
901
+ */
902
+ elementClass?: string | string[];
903
+ /**
904
+ * 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.
905
+ */
906
+ elementAttribute?: {
907
+ [k: string]: string | number | boolean;
908
+ };
909
+ /**
910
+ * Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.
911
+ */
912
+ elementAria?: string;
913
+ }
914
+ export interface Common8 {
915
+ /**
916
+ * JSON Schema for this object.
917
+ */
918
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
919
+ /**
920
+ * ID of the step.
921
+ */
922
+ stepId?: string;
923
+ /**
924
+ * Description of the step.
925
+ */
926
+ description?: string;
927
+ /**
928
+ * 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.
929
+ */
930
+ unsafe?: boolean;
931
+ outputs?: OutputsStep8;
932
+ variables?: VariablesStep8;
933
+ /**
934
+ * 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.
935
+ */
936
+ breakpoint?: boolean;
937
+ location?: SourceLocation8;
938
+ [k: string]: unknown;
939
+ }
940
+ /**
941
+ * 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.
942
+ */
943
+ export interface OutputsStep8 {
944
+ /**
945
+ * Runtime expression for a user-defined output value.
946
+ *
947
+ * This interface was referenced by `OutputsStep8`'s JSON-Schema definition
948
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
949
+ */
950
+ [k: string]: string;
951
+ }
952
+ /**
953
+ * Environment variables to set from user-defined expressions.
954
+ */
955
+ export interface VariablesStep8 {
956
+ /**
957
+ * Runtime expression for a user-defined output value.
958
+ *
959
+ * This interface was referenced by `VariablesStep8`'s JSON-Schema definition
960
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
961
+ */
962
+ [k: string]: string;
963
+ }
964
+ /**
965
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
966
+ */
967
+ export interface SourceLocation8 {
968
+ /**
969
+ * 1-indexed line number in the source file where the step was detected.
970
+ */
971
+ line: number;
972
+ /**
973
+ * 0-indexed character offset from the start of the source file where the step begins.
974
+ */
975
+ startIndex: number;
976
+ /**
977
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
978
+ */
979
+ endIndex: number;
980
+ }
981
+ export interface Screenshot {
982
+ screenshot: Screenshot1;
983
+ [k: string]: unknown;
984
+ }
985
+ export interface CaptureScreenshotDetailed {
986
+ path?: ScreenshotSimple1;
987
+ /**
988
+ * Directory of the PNG file. If the directory doesn't exist, creates the directory.
989
+ */
990
+ directory?: string;
991
+ /**
992
+ * 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.
993
+ */
994
+ maxVariation?: number;
995
+ /**
996
+ * If `true`, overwrites the existing screenshot at `path` if it exists.
997
+ * If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.
998
+ */
999
+ overwrite?: "true" | "false" | "aboveVariation";
1000
+ crop?: CropByElementSimple | CropByElementDetailed;
1001
+ sourceIntegration?: SourceIntegration;
1002
+ }
1003
+ /**
1004
+ * 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.
1005
+ */
1006
+ export interface SourceIntegration {
1007
+ /**
1008
+ * The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.
1009
+ */
1010
+ type: "heretto";
1011
+ /**
1012
+ * The name of the integration configuration in the config file. Used to look up authentication credentials.
1013
+ */
1014
+ integrationName: string;
1015
+ /**
1016
+ * The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path.
1017
+ */
1018
+ fileId?: string;
1019
+ /**
1020
+ * The path of the file in the source CMS. Used for lookup if fileId is not available.
1021
+ */
1022
+ filePath?: string;
1023
+ /**
1024
+ * The local path to the file that references this source. Used for resolving relative paths.
1025
+ */
1026
+ contentPath?: string;
1027
+ }
1028
+ export interface Common9 {
1029
+ /**
1030
+ * JSON Schema for this object.
1031
+ */
1032
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1033
+ /**
1034
+ * ID of the step.
1035
+ */
1036
+ stepId?: string;
1037
+ /**
1038
+ * Description of the step.
1039
+ */
1040
+ description?: string;
1041
+ /**
1042
+ * 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.
1043
+ */
1044
+ unsafe?: boolean;
1045
+ outputs?: OutputsStep9;
1046
+ variables?: VariablesStep9;
1047
+ /**
1048
+ * 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.
1049
+ */
1050
+ breakpoint?: boolean;
1051
+ location?: SourceLocation9;
1052
+ [k: string]: unknown;
1053
+ }
1054
+ /**
1055
+ * 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.
1056
+ */
1057
+ export interface OutputsStep9 {
1058
+ /**
1059
+ * Runtime expression for a user-defined output value.
1060
+ *
1061
+ * This interface was referenced by `OutputsStep9`'s JSON-Schema definition
1062
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1063
+ */
1064
+ [k: string]: string;
1065
+ }
1066
+ /**
1067
+ * Environment variables to set from user-defined expressions.
1068
+ */
1069
+ export interface VariablesStep9 {
1070
+ /**
1071
+ * Runtime expression for a user-defined output value.
1072
+ *
1073
+ * This interface was referenced by `VariablesStep9`'s JSON-Schema definition
1074
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1075
+ */
1076
+ [k: string]: string;
1077
+ }
1078
+ /**
1079
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1080
+ */
1081
+ export interface SourceLocation9 {
1082
+ /**
1083
+ * 1-indexed line number in the source file where the step was detected.
1084
+ */
1085
+ line: number;
1086
+ /**
1087
+ * 0-indexed character offset from the start of the source file where the step begins.
1088
+ */
1089
+ startIndex: number;
1090
+ /**
1091
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1092
+ */
1093
+ endIndex: number;
1094
+ }
1095
+ export interface SaveCookie {
1096
+ saveCookie: SaveCookie1;
1097
+ [k: string]: unknown;
1098
+ }
1099
+ export interface Common10 {
1100
+ /**
1101
+ * JSON Schema for this object.
1102
+ */
1103
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1104
+ /**
1105
+ * ID of the step.
1106
+ */
1107
+ stepId?: string;
1108
+ /**
1109
+ * Description of the step.
1110
+ */
1111
+ description?: string;
1112
+ /**
1113
+ * 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.
1114
+ */
1115
+ unsafe?: boolean;
1116
+ outputs?: OutputsStep10;
1117
+ variables?: VariablesStep10;
1118
+ /**
1119
+ * 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.
1120
+ */
1121
+ breakpoint?: boolean;
1122
+ location?: SourceLocation10;
1123
+ [k: string]: unknown;
1124
+ }
1125
+ /**
1126
+ * 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.
1127
+ */
1128
+ export interface OutputsStep10 {
1129
+ /**
1130
+ * Runtime expression for a user-defined output value.
1131
+ *
1132
+ * This interface was referenced by `OutputsStep10`'s JSON-Schema definition
1133
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1134
+ */
1135
+ [k: string]: string;
1136
+ }
1137
+ /**
1138
+ * Environment variables to set from user-defined expressions.
1139
+ */
1140
+ export interface VariablesStep10 {
1141
+ /**
1142
+ * Runtime expression for a user-defined output value.
1143
+ *
1144
+ * This interface was referenced by `VariablesStep10`'s JSON-Schema definition
1145
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1146
+ */
1147
+ [k: string]: string;
1148
+ }
1149
+ /**
1150
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1151
+ */
1152
+ export interface SourceLocation10 {
1153
+ /**
1154
+ * 1-indexed line number in the source file where the step was detected.
1155
+ */
1156
+ line: number;
1157
+ /**
1158
+ * 0-indexed character offset from the start of the source file where the step begins.
1159
+ */
1160
+ startIndex: number;
1161
+ /**
1162
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1163
+ */
1164
+ endIndex: number;
1165
+ }
1166
+ export interface Record {
1167
+ record: Record1;
1168
+ [k: string]: unknown;
1169
+ }
1170
+ export interface RecordDetailed {
1171
+ /**
1172
+ * 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`.
1173
+ */
1174
+ path?: string;
1175
+ /**
1176
+ * Directory of the file. If the directory doesn't exist, creates the directory.
1177
+ */
1178
+ directory?: string;
1179
+ /**
1180
+ * If `true`, overwrites the existing recording at `path` if it exists.
1181
+ */
1182
+ overwrite?: "true" | "false";
1183
+ [k: string]: unknown;
1184
+ }
1185
+ export interface Common11 {
1186
+ /**
1187
+ * JSON Schema for this object.
1188
+ */
1189
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1190
+ /**
1191
+ * ID of the step.
1192
+ */
1193
+ stepId?: string;
1194
+ /**
1195
+ * Description of the step.
1196
+ */
1197
+ description?: string;
1198
+ /**
1199
+ * 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.
1200
+ */
1201
+ unsafe?: boolean;
1202
+ outputs?: OutputsStep11;
1203
+ variables?: VariablesStep11;
1204
+ /**
1205
+ * 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.
1206
+ */
1207
+ breakpoint?: boolean;
1208
+ location?: SourceLocation11;
1209
+ [k: string]: unknown;
1210
+ }
1211
+ /**
1212
+ * 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.
1213
+ */
1214
+ export interface OutputsStep11 {
1215
+ /**
1216
+ * Runtime expression for a user-defined output value.
1217
+ *
1218
+ * This interface was referenced by `OutputsStep11`'s JSON-Schema definition
1219
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1220
+ */
1221
+ [k: string]: string;
1222
+ }
1223
+ /**
1224
+ * Environment variables to set from user-defined expressions.
1225
+ */
1226
+ export interface VariablesStep11 {
1227
+ /**
1228
+ * Runtime expression for a user-defined output value.
1229
+ *
1230
+ * This interface was referenced by `VariablesStep11`'s JSON-Schema definition
1231
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1232
+ */
1233
+ [k: string]: string;
1234
+ }
1235
+ /**
1236
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1237
+ */
1238
+ export interface SourceLocation11 {
1239
+ /**
1240
+ * 1-indexed line number in the source file where the step was detected.
1241
+ */
1242
+ line: number;
1243
+ /**
1244
+ * 0-indexed character offset from the start of the source file where the step begins.
1245
+ */
1246
+ startIndex: number;
1247
+ /**
1248
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1249
+ */
1250
+ endIndex: number;
1251
+ }
1252
+ export interface StopRecord {
1253
+ stopRecord: StopRecord1;
1254
+ [k: string]: unknown;
1255
+ }
1256
+ export interface Common12 {
1257
+ /**
1258
+ * JSON Schema for this object.
1259
+ */
1260
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1261
+ /**
1262
+ * ID of the step.
1263
+ */
1264
+ stepId?: string;
1265
+ /**
1266
+ * Description of the step.
1267
+ */
1268
+ description?: string;
1269
+ /**
1270
+ * 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.
1271
+ */
1272
+ unsafe?: boolean;
1273
+ outputs?: OutputsStep12;
1274
+ variables?: VariablesStep12;
1275
+ /**
1276
+ * 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.
1277
+ */
1278
+ breakpoint?: boolean;
1279
+ location?: SourceLocation12;
1280
+ [k: string]: unknown;
1281
+ }
1282
+ /**
1283
+ * 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.
1284
+ */
1285
+ export interface OutputsStep12 {
1286
+ /**
1287
+ * Runtime expression for a user-defined output value.
1288
+ *
1289
+ * This interface was referenced by `OutputsStep12`'s JSON-Schema definition
1290
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1291
+ */
1292
+ [k: string]: string;
1293
+ }
1294
+ /**
1295
+ * Environment variables to set from user-defined expressions.
1296
+ */
1297
+ export interface VariablesStep12 {
1298
+ /**
1299
+ * Runtime expression for a user-defined output value.
1300
+ *
1301
+ * This interface was referenced by `VariablesStep12`'s JSON-Schema definition
1302
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1303
+ */
1304
+ [k: string]: string;
1305
+ }
1306
+ /**
1307
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1308
+ */
1309
+ export interface SourceLocation12 {
1310
+ /**
1311
+ * 1-indexed line number in the source file where the step was detected.
1312
+ */
1313
+ line: number;
1314
+ /**
1315
+ * 0-indexed character offset from the start of the source file where the step begins.
1316
+ */
1317
+ startIndex: number;
1318
+ /**
1319
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1320
+ */
1321
+ endIndex: number;
1322
+ }
1323
+ export interface LoadVariables {
1324
+ loadVariables: LoadVariables1;
1325
+ [k: string]: unknown;
1326
+ }
1327
+ export interface Common13 {
1328
+ /**
1329
+ * JSON Schema for this object.
1330
+ */
1331
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1332
+ /**
1333
+ * ID of the step.
1334
+ */
1335
+ stepId?: string;
1336
+ /**
1337
+ * Description of the step.
1338
+ */
1339
+ description?: string;
1340
+ /**
1341
+ * 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.
1342
+ */
1343
+ unsafe?: boolean;
1344
+ outputs?: OutputsStep13;
1345
+ variables?: VariablesStep13;
1346
+ /**
1347
+ * 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.
1348
+ */
1349
+ breakpoint?: boolean;
1350
+ location?: SourceLocation13;
1351
+ [k: string]: unknown;
1352
+ }
1353
+ /**
1354
+ * 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.
1355
+ */
1356
+ export interface OutputsStep13 {
1357
+ /**
1358
+ * Runtime expression for a user-defined output value.
1359
+ *
1360
+ * This interface was referenced by `OutputsStep13`'s JSON-Schema definition
1361
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1362
+ */
1363
+ [k: string]: string;
1364
+ }
1365
+ /**
1366
+ * Environment variables to set from user-defined expressions.
1367
+ */
1368
+ export interface VariablesStep13 {
1369
+ /**
1370
+ * Runtime expression for a user-defined output value.
1371
+ *
1372
+ * This interface was referenced by `VariablesStep13`'s JSON-Schema definition
1373
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1374
+ */
1375
+ [k: string]: string;
1376
+ }
1377
+ /**
1378
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1379
+ */
1380
+ export interface SourceLocation13 {
1381
+ /**
1382
+ * 1-indexed line number in the source file where the step was detected.
1383
+ */
1384
+ line: number;
1385
+ /**
1386
+ * 0-indexed character offset from the start of the source file where the step begins.
1387
+ */
1388
+ startIndex: number;
1389
+ /**
1390
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1391
+ */
1392
+ endIndex: number;
1393
+ }
1394
+ export interface DragAndDrop {
1395
+ dragAndDrop: DragAndDrop1;
1396
+ [k: string]: unknown;
1397
+ }
1398
+ /**
1399
+ * Drag and drop an element from source to target.
1400
+ */
1401
+ export interface DragAndDrop1 {
1402
+ /**
1403
+ * The element to drag.
1404
+ */
1405
+ source: ElementSimple | ElementDetailed;
1406
+ /**
1407
+ * The target location to drop the element.
1408
+ */
1409
+ target: ElementSimple1 | ElementDetailed1;
1410
+ /**
1411
+ * Duration of the drag operation in milliseconds.
1412
+ */
1413
+ duration?: number;
1414
+ [k: string]: unknown;
1415
+ }
1416
+ export interface Common14 {
1417
+ /**
1418
+ * JSON Schema for this object.
1419
+ */
1420
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1421
+ /**
1422
+ * ID of the step.
1423
+ */
1424
+ stepId?: string;
1425
+ /**
1426
+ * Description of the step.
1427
+ */
1428
+ description?: string;
1429
+ /**
1430
+ * 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.
1431
+ */
1432
+ unsafe?: boolean;
1433
+ outputs?: OutputsStep14;
1434
+ variables?: VariablesStep14;
1435
+ /**
1436
+ * 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.
1437
+ */
1438
+ breakpoint?: boolean;
1439
+ location?: SourceLocation14;
1440
+ [k: string]: unknown;
1441
+ }
1442
+ /**
1443
+ * 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.
1444
+ */
1445
+ export interface OutputsStep14 {
1446
+ /**
1447
+ * Runtime expression for a user-defined output value.
1448
+ *
1449
+ * This interface was referenced by `OutputsStep14`'s JSON-Schema definition
1450
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1451
+ */
1452
+ [k: string]: string;
1453
+ }
1454
+ /**
1455
+ * Environment variables to set from user-defined expressions.
1456
+ */
1457
+ export interface VariablesStep14 {
1458
+ /**
1459
+ * Runtime expression for a user-defined output value.
1460
+ *
1461
+ * This interface was referenced by `VariablesStep14`'s JSON-Schema definition
1462
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1463
+ */
1464
+ [k: string]: string;
1465
+ }
1466
+ /**
1467
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1468
+ */
1469
+ export interface SourceLocation14 {
1470
+ /**
1471
+ * 1-indexed line number in the source file where the step was detected.
1472
+ */
1473
+ line: number;
1474
+ /**
1475
+ * 0-indexed character offset from the start of the source file where the step begins.
1476
+ */
1477
+ startIndex: number;
1478
+ /**
1479
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1480
+ */
1481
+ endIndex: number;
1482
+ }
1483
+ export interface LoadCookie {
1484
+ loadCookie: LoadCookie1;
1485
+ [k: string]: unknown;
1486
+ }
1487
+ export interface Common15 {
1488
+ /**
1489
+ * JSON Schema for this object.
1490
+ */
1491
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/step_v3.schema.json";
1492
+ /**
1493
+ * ID of the step.
1494
+ */
1495
+ stepId?: string;
1496
+ /**
1497
+ * Description of the step.
1498
+ */
1499
+ description?: string;
1500
+ /**
1501
+ * 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.
1502
+ */
1503
+ unsafe?: boolean;
1504
+ outputs?: OutputsStep15;
1505
+ variables?: VariablesStep15;
1506
+ /**
1507
+ * 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.
1508
+ */
1509
+ breakpoint?: boolean;
1510
+ location?: SourceLocation15;
1511
+ [k: string]: unknown;
1512
+ }
1513
+ /**
1514
+ * 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.
1515
+ */
1516
+ export interface OutputsStep15 {
1517
+ /**
1518
+ * Runtime expression for a user-defined output value.
1519
+ *
1520
+ * This interface was referenced by `OutputsStep15`'s JSON-Schema definition
1521
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1522
+ */
1523
+ [k: string]: string;
1524
+ }
1525
+ /**
1526
+ * Environment variables to set from user-defined expressions.
1527
+ */
1528
+ export interface VariablesStep15 {
1529
+ /**
1530
+ * Runtime expression for a user-defined output value.
1531
+ *
1532
+ * This interface was referenced by `VariablesStep15`'s JSON-Schema definition
1533
+ * via the `patternProperty` "^[A-Za-z0-9_]+$".
1534
+ */
1535
+ [k: string]: string;
1536
+ }
1537
+ /**
1538
+ * Source location where this step was detected in the original file. This is system-populated metadata and should not be set manually.
1539
+ */
1540
+ export interface SourceLocation15 {
1541
+ /**
1542
+ * 1-indexed line number in the source file where the step was detected.
1543
+ */
1544
+ line: number;
1545
+ /**
1546
+ * 0-indexed character offset from the start of the source file where the step begins.
1547
+ */
1548
+ startIndex: number;
1549
+ /**
1550
+ * 0-indexed character offset from the start of the source file where the step ends (exclusive).
1551
+ */
1552
+ endIndex: number;
1553
+ }
1554
+ export interface Wait {
1555
+ wait: Wait1;
1556
+ [k: string]: unknown;
1557
+ }
1558
+ //# sourceMappingURL=step_v3.d.ts.map