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,571 @@
1
+ /**
2
+ * Auto-generated from resolvedTests_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * Load environment variables from the specified `.env` file.
7
+ */
8
+ export type LoadVariables = string;
9
+ export type FileTypePredefined = "markdown" | "asciidoc" | "html" | "dita";
10
+ export type FileTypeCustom = {
11
+ [k: string]: unknown;
12
+ } | {
13
+ [k: string]: unknown;
14
+ };
15
+ /**
16
+ * Perform a native shell command.
17
+ */
18
+ export type RunShell = RunShellCommandSimple | RunShellCommandDetailed;
19
+ /**
20
+ * Command to perform in the machine's default shell.
21
+ */
22
+ export type RunShellCommandSimple = string;
23
+ /**
24
+ * OpenAPI description and configuration.
25
+ */
26
+ export type OpenApi = {
27
+ [k: string]: unknown;
28
+ };
29
+ /**
30
+ * Configuration for Heretto CMS integrations. Each entry specifies a Heretto instance and a scenario to build and test.
31
+ */
32
+ export type HerettoCMSIntegrations = HerettoCMSIntegration[];
33
+ /**
34
+ * OpenAPI description and configuration.
35
+ */
36
+ export type OpenApi1 = {
37
+ [k: string]: unknown;
38
+ } | {
39
+ [k: string]: unknown;
40
+ };
41
+ /**
42
+ * A Doc Detective test.
43
+ */
44
+ export type Test = {
45
+ [k: string]: unknown;
46
+ } | {
47
+ [k: string]: unknown;
48
+ };
49
+ /**
50
+ * A collection of resolved tests ready to be performed.
51
+ */
52
+ export interface ResolvedTests {
53
+ /**
54
+ * Unique identifier for the resolved tests.
55
+ */
56
+ resolvedTestsId?: string;
57
+ config?: Config;
58
+ /**
59
+ * Test specifications that were performed.
60
+ *
61
+ * @minItems 1
62
+ */
63
+ specs: [Specification, ...Specification[]];
64
+ [k: string]: unknown;
65
+ }
66
+ /**
67
+ * Configuration options for Doc Detective operations.
68
+ */
69
+ export interface Config {
70
+ /**
71
+ * JSON Schema for this object.
72
+ */
73
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/config_v3.schema.json";
74
+ /**
75
+ * Identifier for the configuration.
76
+ */
77
+ configId?: string;
78
+ /**
79
+ * Path to the configuration file.
80
+ */
81
+ configPath?: string;
82
+ /**
83
+ * Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files.
84
+ */
85
+ input?: string | [string, ...string[]];
86
+ /**
87
+ * Path of the directory in which to store the output of Doc Detective commands. If a file path is specified, Doc Detective attempts to honor the file name specified, but file path behavior is controlled by the configured reporters.
88
+ */
89
+ output?: string;
90
+ /**
91
+ * If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files.
92
+ */
93
+ recursive?: boolean;
94
+ /**
95
+ * Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).
96
+ */
97
+ relativePathBase?: "cwd" | "file";
98
+ loadVariables?: LoadVariables;
99
+ /**
100
+ * Default protocol and domain to use for relative URLs.
101
+ */
102
+ origin?: string;
103
+ /**
104
+ * Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments.
105
+ */
106
+ beforeAny?: string | string[];
107
+ /**
108
+ * Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments.
109
+ */
110
+ afterAll?: string | string[];
111
+ /**
112
+ * Whether or not to detect steps in input files based on defined markup.
113
+ */
114
+ detectSteps?: boolean;
115
+ /**
116
+ * Whether or not to run potentially unsafe steps, such as those that might modify files or system state.
117
+ */
118
+ allowUnsafeSteps?: boolean;
119
+ /**
120
+ * If `true`, crawls sitemap.xml files specified by URL to find additional files to test.
121
+ */
122
+ crawl?: boolean;
123
+ /**
124
+ * If `true`, processes DITA maps and includes generated files as inputs.
125
+ */
126
+ processDitaMaps?: boolean;
127
+ /**
128
+ * Amount of detail to output when performing an operation.
129
+ */
130
+ logLevel?: "silent" | "error" | "warning" | "info" | "debug";
131
+ /**
132
+ * Contexts to run the test in. Overrides contexts defined at the config and spec levels.
133
+ */
134
+ runOn?: Context[];
135
+ /**
136
+ * Configuration for file types and their markup detection.
137
+ */
138
+ fileTypes?: [
139
+ FileTypePredefined | FileTypeCustom | FileTypeExecutable,
140
+ ...(FileTypePredefined | FileTypeCustom | FileTypeExecutable)[]
141
+ ];
142
+ integrations?: IntegrationsOptions;
143
+ telemetry?: TelemetryOptions;
144
+ /**
145
+ * Number of concurrent test runners. Set to true to use CPU core count (capped at 4).
146
+ */
147
+ concurrentRunners?: number | boolean;
148
+ environment?: EnvironmentDetails;
149
+ /**
150
+ * Enable debugging mode. `true` allows pausing on breakpoints, waiting for user input before continuing. `stepThrough` pauses at every step, waiting for user input before continuing. `false` disables all debugging.
151
+ */
152
+ debug?: boolean | "stepThrough";
153
+ }
154
+ /**
155
+ * 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.
156
+ */
157
+ export interface Context {
158
+ /**
159
+ * JSON Schema for this object.
160
+ */
161
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/context_v3.schema.json";
162
+ /**
163
+ * Unique identifier for the context.
164
+ */
165
+ contextId?: string;
166
+ /**
167
+ * Platforms to run tests on.
168
+ */
169
+ platforms?: ("linux" | "mac" | "windows") | ("linux" | "mac" | "windows")[];
170
+ /**
171
+ * Browsers to run tests on.
172
+ */
173
+ browsers?: ("chrome" | "firefox" | "safari" | "webkit") | Browser | (("chrome" | "firefox" | "safari" | "webkit") | Browser1)[];
174
+ }
175
+ /**
176
+ * Browser configuration.
177
+ */
178
+ export interface Browser {
179
+ /**
180
+ * Name of the browser.
181
+ */
182
+ name: "chrome" | "firefox" | "safari" | "webkit";
183
+ /**
184
+ * If `true`, runs the browser in headless mode.
185
+ */
186
+ headless?: boolean;
187
+ window?: BrowserWindow;
188
+ viewport?: BrowserViewport;
189
+ }
190
+ /**
191
+ * Browser dimensions.
192
+ */
193
+ export interface BrowserWindow {
194
+ /**
195
+ * Width of the browser window in pixels.
196
+ */
197
+ width?: number;
198
+ /**
199
+ * Height of the browser window in pixels.
200
+ */
201
+ height?: number;
202
+ }
203
+ /**
204
+ * Viewport dimensions.
205
+ */
206
+ export interface BrowserViewport {
207
+ /**
208
+ * Width of the viewport in pixels.
209
+ */
210
+ width?: number;
211
+ /**
212
+ * Height of the viewport in pixels.
213
+ */
214
+ height?: number;
215
+ }
216
+ /**
217
+ * Browser configuration.
218
+ */
219
+ export interface Browser1 {
220
+ /**
221
+ * Name of the browser.
222
+ */
223
+ name: "chrome" | "firefox" | "safari" | "webkit";
224
+ /**
225
+ * If `true`, runs the browser in headless mode.
226
+ */
227
+ headless?: boolean;
228
+ window?: BrowserWindow1;
229
+ viewport?: BrowserViewport1;
230
+ }
231
+ /**
232
+ * Browser dimensions.
233
+ */
234
+ export interface BrowserWindow1 {
235
+ /**
236
+ * Width of the browser window in pixels.
237
+ */
238
+ width?: number;
239
+ /**
240
+ * Height of the browser window in pixels.
241
+ */
242
+ height?: number;
243
+ }
244
+ /**
245
+ * Viewport dimensions.
246
+ */
247
+ export interface BrowserViewport1 {
248
+ /**
249
+ * Width of the viewport in pixels.
250
+ */
251
+ width?: number;
252
+ /**
253
+ * Height of the viewport in pixels.
254
+ */
255
+ height?: number;
256
+ }
257
+ export interface FileTypeExecutable {
258
+ /**
259
+ * File extensions to use with type.
260
+ */
261
+ extensions: string | [string, ...string[]];
262
+ /**
263
+ * `runShell` step to perform for this file type. Use $1 as a placeholder for the file path.
264
+ */
265
+ runShell?: RunShell;
266
+ [k: string]: unknown;
267
+ }
268
+ export interface RunShellCommandDetailed {
269
+ /**
270
+ * Command to perform in the machine's default shell.
271
+ */
272
+ command: string;
273
+ /**
274
+ * Arguments for the command.
275
+ */
276
+ args?: string[];
277
+ /**
278
+ * Working directory for the command.
279
+ */
280
+ workingDirectory?: string;
281
+ /**
282
+ * Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
283
+ */
284
+ exitCodes?: number[];
285
+ /**
286
+ * 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.* /`.
287
+ */
288
+ stdio?: string;
289
+ /**
290
+ * File path to save the command's output, relative to `directory`.
291
+ */
292
+ path?: string;
293
+ /**
294
+ * 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.
295
+ */
296
+ directory?: string;
297
+ /**
298
+ * 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.
299
+ */
300
+ maxVariation?: number;
301
+ /**
302
+ * If `true`, overwrites the existing output at `path` if it exists.
303
+ * If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
304
+ */
305
+ overwrite?: "true" | "false" | "aboveVariation";
306
+ /**
307
+ * Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
308
+ */
309
+ timeout?: number;
310
+ }
311
+ /**
312
+ * Options for connecting to external services.
313
+ */
314
+ export interface IntegrationsOptions {
315
+ openApi?: (OpenApi & OpenAPIDescriptionTest)[];
316
+ docDetectiveApi?: DocDetectiveOrchestrationAPI;
317
+ heretto?: HerettoCMSIntegrations;
318
+ }
319
+ export interface OpenAPIDescriptionTest {
320
+ [k: string]: unknown;
321
+ }
322
+ /**
323
+ * Configuration for Doc Detective Orchestration API integration.
324
+ */
325
+ export interface DocDetectiveOrchestrationAPI {
326
+ /**
327
+ * API key for authenticating with the Doc Detective Orchestration API.
328
+ */
329
+ apiKey?: string;
330
+ }
331
+ export interface HerettoCMSIntegration {
332
+ /**
333
+ * Unique identifier for this Heretto integration. Used in logs and results.
334
+ */
335
+ name: string;
336
+ /**
337
+ * The organization subdomain used to access Heretto CCMS (e.g., 'thunderbird' for thunderbird.heretto.com).
338
+ */
339
+ organizationId: string;
340
+ /**
341
+ * Heretto CCMS username (email address) for API authentication.
342
+ */
343
+ username: string;
344
+ /**
345
+ * API token generated in Heretto CCMS for authentication. See https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication#ariaid-title3
346
+ */
347
+ apiToken: string;
348
+ /**
349
+ * Name of the scenario to build and test.
350
+ */
351
+ scenarioName?: string;
352
+ /**
353
+ * Local path where Heretto content was downloaded. Set automatically during processing.
354
+ */
355
+ outputPath?: string;
356
+ /**
357
+ * Mapping of local file paths to Heretto file metadata. Set automatically during content loading.
358
+ */
359
+ fileMapping?: {
360
+ [k: string]: {
361
+ /**
362
+ * The UUID of the file in Heretto.
363
+ */
364
+ fileId?: string;
365
+ /**
366
+ * The path of the file in Heretto.
367
+ */
368
+ filePath?: string;
369
+ [k: string]: unknown;
370
+ };
371
+ };
372
+ /**
373
+ * If `true`, uploads changed screenshots and other media files back to Heretto CMS after test execution.
374
+ */
375
+ uploadOnChange?: boolean;
376
+ /**
377
+ * Mapping of Heretto file paths to their UUIDs and metadata. Set automatically during content loading by fetching ditamap resource dependencies.
378
+ */
379
+ resourceDependencies?: {
380
+ [k: string]: {
381
+ /**
382
+ * The UUID of the file in Heretto.
383
+ */
384
+ uuid?: string;
385
+ /**
386
+ * The full xmldb path of the file in Heretto.
387
+ */
388
+ fullPath?: string;
389
+ /**
390
+ * The file name.
391
+ */
392
+ name?: string;
393
+ /**
394
+ * The UUID of the parent folder in Heretto.
395
+ */
396
+ parentFolderId?: string;
397
+ [k: string]: unknown;
398
+ };
399
+ };
400
+ }
401
+ /**
402
+ * Options around sending telemetry for Doc Detective usage.
403
+ */
404
+ export interface TelemetryOptions {
405
+ /**
406
+ * If `true`, sends Doc Detective telemetry.
407
+ */
408
+ send: boolean;
409
+ /**
410
+ * Identifier for the organization, group, or individual running Doc Detective.
411
+ */
412
+ userId?: string;
413
+ }
414
+ /**
415
+ * Environment information for the system running Doc Detective.
416
+ */
417
+ export interface EnvironmentDetails {
418
+ /**
419
+ * The current working directory of the process running Doc Detective.
420
+ */
421
+ workingDirectory?: string;
422
+ /**
423
+ * The operating system type running Doc Detective.
424
+ */
425
+ platform: "linux" | "mac" | "windows";
426
+ /**
427
+ * The processor architecture of the system running Doc Detective.
428
+ */
429
+ arch?: "arm32" | "arm64" | "x32" | "x64";
430
+ }
431
+ export interface Specification {
432
+ /**
433
+ * JSON Schema for this object.
434
+ */
435
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/spec_v3.schema.json";
436
+ /**
437
+ * Unique identifier for the test specification.
438
+ */
439
+ specId?: string;
440
+ /**
441
+ * Description of the test specification.
442
+ */
443
+ description?: string;
444
+ /**
445
+ * Path to the test specification.
446
+ */
447
+ specPath?: string;
448
+ /**
449
+ * Path to the content that the specification is associated with.
450
+ */
451
+ contentPath?: string;
452
+ /**
453
+ * Contexts to run the test in. Overrides contexts defined at the config and spec levels.
454
+ */
455
+ runOn?: Context1[];
456
+ openApi?: (OpenApi1 & OpenAPIDescriptionTest1)[];
457
+ /**
458
+ * [Tests](test) to perform.
459
+ *
460
+ * @minItems 1
461
+ */
462
+ tests: [Test, ...Test[]];
463
+ [k: string]: unknown;
464
+ }
465
+ /**
466
+ * 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.
467
+ */
468
+ export interface Context1 {
469
+ /**
470
+ * JSON Schema for this object.
471
+ */
472
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/context_v3.schema.json";
473
+ /**
474
+ * Unique identifier for the context.
475
+ */
476
+ contextId?: string;
477
+ /**
478
+ * Platforms to run tests on.
479
+ */
480
+ platforms?: ("linux" | "mac" | "windows") | ("linux" | "mac" | "windows")[];
481
+ /**
482
+ * Browsers to run tests on.
483
+ */
484
+ browsers?: ("chrome" | "firefox" | "safari" | "webkit") | Browser2 | (("chrome" | "firefox" | "safari" | "webkit") | Browser3)[];
485
+ }
486
+ /**
487
+ * Browser configuration.
488
+ */
489
+ export interface Browser2 {
490
+ /**
491
+ * Name of the browser.
492
+ */
493
+ name: "chrome" | "firefox" | "safari" | "webkit";
494
+ /**
495
+ * If `true`, runs the browser in headless mode.
496
+ */
497
+ headless?: boolean;
498
+ window?: BrowserWindow2;
499
+ viewport?: BrowserViewport2;
500
+ }
501
+ /**
502
+ * Browser dimensions.
503
+ */
504
+ export interface BrowserWindow2 {
505
+ /**
506
+ * Width of the browser window in pixels.
507
+ */
508
+ width?: number;
509
+ /**
510
+ * Height of the browser window in pixels.
511
+ */
512
+ height?: number;
513
+ }
514
+ /**
515
+ * Viewport dimensions.
516
+ */
517
+ export interface BrowserViewport2 {
518
+ /**
519
+ * Width of the viewport in pixels.
520
+ */
521
+ width?: number;
522
+ /**
523
+ * Height of the viewport in pixels.
524
+ */
525
+ height?: number;
526
+ }
527
+ /**
528
+ * Browser configuration.
529
+ */
530
+ export interface Browser3 {
531
+ /**
532
+ * Name of the browser.
533
+ */
534
+ name: "chrome" | "firefox" | "safari" | "webkit";
535
+ /**
536
+ * If `true`, runs the browser in headless mode.
537
+ */
538
+ headless?: boolean;
539
+ window?: BrowserWindow3;
540
+ viewport?: BrowserViewport3;
541
+ }
542
+ /**
543
+ * Browser dimensions.
544
+ */
545
+ export interface BrowserWindow3 {
546
+ /**
547
+ * Width of the browser window in pixels.
548
+ */
549
+ width?: number;
550
+ /**
551
+ * Height of the browser window in pixels.
552
+ */
553
+ height?: number;
554
+ }
555
+ /**
556
+ * Viewport dimensions.
557
+ */
558
+ export interface BrowserViewport3 {
559
+ /**
560
+ * Width of the viewport in pixels.
561
+ */
562
+ width?: number;
563
+ /**
564
+ * Height of the viewport in pixels.
565
+ */
566
+ height?: number;
567
+ }
568
+ export interface OpenAPIDescriptionTest1 {
569
+ [k: string]: unknown;
570
+ }
571
+ //# sourceMappingURL=resolvedTests_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolvedTests_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/resolvedTests_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAC3E,MAAM,MAAM,cAAc,GACtB;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GACD;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACN;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AACvE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,EAAE,CAAC;AAC7D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAChB;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GACD;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AACN;;GAEG;AACH,MAAM,MAAM,IAAI,GACZ;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GACD;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,EAAE,CAAC,aAAa,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC;IAC3C,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,2GAA2G,CAAC;IACtH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAClC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,kBAAkB,GAAG,cAAc,GAAG,kBAAkB;QACxD,GAAG,CAAC,kBAAkB,GAAG,cAAc,GAAG,kBAAkB,CAAC,EAAE;KAChE,CAAC;IACF,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACrC,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;CACjC;AACD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,4GAA4G,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,EACL,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAC5C,OAAO,GACP,CAAC,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;CACjE;AACD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,gBAAgB,CAAC;IAChD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AACD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,EAAE,CAAC;IAC/C,eAAe,CAAC,EAAE,4BAA4B,CAAC;IAC/C,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC;AACD,MAAM,WAAW,sBAAsB;IACrC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,CAAC,CAAC,EAAE,MAAM,GAAG;YACX;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;IACF;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,oBAAoB,CAAC,EAAE;QACrB,CAAC,CAAC,EAAE,MAAM,GAAG;YACX;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;CACH;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,CAAC;CAC1C;AACD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,yGAAyG,CAAC;IACpH;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,CAAC,QAAQ,GAAG,uBAAuB,CAAC,EAAE,CAAC;IACjD;;;;OAIG;IACH,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,4GAA4G,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,EACL,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAC5C,QAAQ,GACR,CAAC,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;CACjE;AACD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,uBAAuB;IACtC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from resolvedTests_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=resolvedTests_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolvedTests_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/resolvedTests_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,57 @@
1
+ /**
2
+ * Auto-generated from runCode_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * Assemble and run code.
7
+ */
8
+ export type RunCode = RunCodeDetailed;
9
+ export interface RunCodeDetailed {
10
+ /**
11
+ * Language of the code to run.
12
+ */
13
+ language: "python" | "bash" | "javascript";
14
+ /**
15
+ * Code to run.
16
+ */
17
+ code: string;
18
+ /**
19
+ * Arguments for the command.
20
+ */
21
+ args?: string[];
22
+ /**
23
+ * Working directory for the command.
24
+ */
25
+ workingDirectory?: string;
26
+ /**
27
+ * Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.
28
+ */
29
+ exitCodes?: number[];
30
+ /**
31
+ * 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.* /`.
32
+ */
33
+ stdio?: string;
34
+ /**
35
+ * File path to save the command's output, relative to `directory`.
36
+ */
37
+ path?: string;
38
+ /**
39
+ * 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.
40
+ */
41
+ directory?: string;
42
+ /**
43
+ * 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.
44
+ */
45
+ maxVariation?: number;
46
+ /**
47
+ * If `true`, overwrites the existing output at `path` if it exists.
48
+ * If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.
49
+ */
50
+ overwrite?: "true" | "false" | "aboveVariation";
51
+ /**
52
+ * Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.
53
+ */
54
+ timeout?: number;
55
+ [k: string]: unknown;
56
+ }
57
+ //# sourceMappingURL=runCode_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"runCode_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/runCode_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC;AAEtC,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,YAAY,CAAC;IAC3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,gBAAgB,CAAC;IAChD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from runCode_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=runCode_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"runCode_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/runCode_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}