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,9 @@
1
+ /**
2
+ * Auto-generated from endRecord_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * Stop the current recording.
7
+ */
8
+ export type EndRecord = boolean | null;
9
+ //# sourceMappingURL=endRecord_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"endRecord_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/endRecord_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from endRecord_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=endRecord_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"endRecord_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/endRecord_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Auto-generated from find_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * Find an element based on display text or a selector, then optionally interact with it.
7
+ */
8
+ export type Find = FindElementSimple | FindElementDetailed;
9
+ /**
10
+ * Identifier for the element to find. Can be a selector, element text, ARIA name, ID, or test ID.
11
+ */
12
+ export type FindElementSimple = string;
13
+ export type FindElementDetailed = {
14
+ [k: string]: unknown;
15
+ };
16
+ //# sourceMappingURL=find_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"find_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/find_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAC3D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from find_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=find_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"find_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/find_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Auto-generated from goTo_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ export type GoTo = GoToURLSimple | GoToURLDetailed;
6
+ /**
7
+ * 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.
8
+ */
9
+ export type GoToURLSimple = string;
10
+ /**
11
+ * Navigate to an HTTP or HTTPS URL.
12
+ */
13
+ export interface GoToURLDetailed {
14
+ /**
15
+ * 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.
16
+ */
17
+ url: string;
18
+ /**
19
+ * Protocol and domain to navigate to. Prepended to `url`.
20
+ */
21
+ origin?: string;
22
+ /**
23
+ * Maximum time in milliseconds to wait for the page to be ready. If exceeded, the goTo action fails.
24
+ */
25
+ timeout?: number;
26
+ /**
27
+ * Configuration for waiting conditions after navigation.
28
+ */
29
+ waitUntil?: {
30
+ /**
31
+ * Wait for network activity to be idle (no new requests) for this duration in milliseconds. Set to `null` to skip this check.
32
+ */
33
+ networkIdleTime?: number | null;
34
+ /**
35
+ * Wait for DOM mutations to stop for this duration in milliseconds. Set to `null` to skip this check.
36
+ */
37
+ domIdleTime?: number | null;
38
+ /**
39
+ * Wait for a specific element to be present in the DOM. At least one of selector or elementText must be specified.
40
+ */
41
+ find?: {
42
+ [k: string]: unknown;
43
+ };
44
+ };
45
+ }
46
+ //# sourceMappingURL=goTo_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"goTo_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/goTo_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH,MAAM,MAAM,IAAI,GAAG,aAAa,GAAG,eAAe,CAAC;AACnD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B;;WAEG;QACH,IAAI,CAAC,EAAE;YACL,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;CACH"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from goTo_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=goTo_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"goTo_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/goTo_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Auto-generated from httpRequest_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * Perform a generic HTTP request, for example to an API.
7
+ */
8
+ export type HttpRequest = HTTPRequestSimple | HTTPRequestDetailed;
9
+ /**
10
+ * URL for the HTTP request.
11
+ */
12
+ export type HTTPRequestSimple = string;
13
+ export type HTTPRequestDetailed = {
14
+ [k: string]: unknown;
15
+ };
16
+ //# sourceMappingURL=httpRequest_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"httpRequest_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/httpRequest_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from httpRequest_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=httpRequest_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"httpRequest_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/httpRequest_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Auto-generated from loadCookie_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * Load a specific cookie from a file or environment variable into the browser.
7
+ */
8
+ export type LoadCookie = CookieNameOrFilePath | LoadCookieDetailed;
9
+ /**
10
+ * Name of the specific cookie to load from default location, or file path to cookie file.
11
+ */
12
+ export type CookieNameOrFilePath = string;
13
+ export type LoadCookieDetailed = {
14
+ [k: string]: unknown;
15
+ };
16
+ //# sourceMappingURL=loadCookie_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"loadCookie_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/loadCookie_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AACnE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from loadCookie_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=loadCookie_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"loadCookie_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/loadCookie_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Auto-generated from loadVariables_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
+ //# sourceMappingURL=loadVariables_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"loadVariables_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/loadVariables_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from loadVariables_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=loadVariables_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"loadVariables_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/loadVariables_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Auto-generated from openApi_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * OpenAPI description and configuration.
7
+ */
8
+ export type OpenApi = {
9
+ [k: string]: unknown;
10
+ } & {
11
+ /**
12
+ * Name of the OpenAPI description, as defined in your configuration.
13
+ */
14
+ name?: string;
15
+ /**
16
+ * URL or local path to the OpenAPI description.
17
+ */
18
+ descriptionPath?: string;
19
+ definition?: OpenAPIDefinition;
20
+ /**
21
+ * ID of the operation to use for the request.
22
+ */
23
+ operationId?: string;
24
+ /**
25
+ * Server to use for example requests. Only valid if `useExample` is `request` or `both`. If not specified but an example is used for the request, uses the first server defined in the OpenAPI description.
26
+ */
27
+ server?: string;
28
+ /**
29
+ * Validates the request and/or response against the schema in the OpenAPI description. If the request or response doesn't match the schema, the step fails.
30
+ */
31
+ validateAgainstSchema?: "request" | "response" | "both" | "none";
32
+ /**
33
+ * If `true`, doesn't make the HTTP request, but instead uses the response example or schema from the OpenAPI description as the response data. Useful for creating tests when an API isn't fully implemented yet. If `statusCode` isn't specified, uses the first defined response code.
34
+ */
35
+ mockResponse?: boolean;
36
+ /**
37
+ * Response code to use for validation, examples, and status code checking. If the response code doesn't match, the step fails. `statusCodes` overrides this value when specified.
38
+ */
39
+ statusCode?: number;
40
+ /**
41
+ * Uses the example from the OpenAPI description as the request and response data. If the request or response has multiple examples, specify `exampleKey`. If `statusCode` isn't specified, uses the first defined response code. `requestData`, `requestParams`, and `requestHeaders` override portions of request examples when specified. `responseData` overrides portions of response examples when specified.
42
+ */
43
+ useExample?: "request" | "response" | "both" | "none";
44
+ /**
45
+ * Key of the example to use from the `examples` property in the OpenAPI description. If an `examples` key isn't specified or isn't available for a given parameter or object, the `example` property value is used.
46
+ */
47
+ exampleKey?: string;
48
+ headers?: OpenAPIRequestHeaders;
49
+ };
50
+ /**
51
+ * OpenAPI definition object loaded from the `descriptionPath`. This is a resolved version of the OpenAPI description and should not be user-defined.
52
+ */
53
+ export interface OpenAPIDefinition {
54
+ [k: string]: unknown;
55
+ }
56
+ /**
57
+ * Request headers to add to requests. For example, to set `Authorization` headers for all requests from the specified OpenAPI document. If specified in both a config and a step, the step value overrides the config value.
58
+ */
59
+ export interface OpenAPIRequestHeaders {
60
+ [k: string]: string;
61
+ }
62
+ //# sourceMappingURL=openApi_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"openApi_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/openApi_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GAAG;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,qBAAqB,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IACjE;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IACtD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from openApi_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=openApi_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"openApi_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/openApi_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Auto-generated from record_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * 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' ]
7
+ */
8
+ export type Record = RecordSimple | RecordDetailed | RecordBoolean;
9
+ /**
10
+ * 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`.
11
+ */
12
+ export type RecordSimple = string;
13
+ /**
14
+ * If `true`, records the current browser viewport. If `false`, doesn't record the current browser viewport.
15
+ */
16
+ export type RecordBoolean = boolean;
17
+ export interface RecordDetailed {
18
+ /**
19
+ * 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`.
20
+ */
21
+ path?: string;
22
+ /**
23
+ * Directory of the file. If the directory doesn't exist, creates the directory.
24
+ */
25
+ directory?: string;
26
+ /**
27
+ * If `true`, overwrites the existing recording at `path` if it exists.
28
+ */
29
+ overwrite?: "true" | "false";
30
+ [k: string]: unknown;
31
+ }
32
+ //# sourceMappingURL=record_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"record_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/record_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,aAAa,CAAC;AACnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC;AAEpC,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from record_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=record_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"record_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/record_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}
@@ -0,0 +1,174 @@
1
+ /**
2
+ * Auto-generated from report_v3.schema.json
3
+ * Do not edit manually
4
+ */
5
+ /**
6
+ * OpenAPI description and configuration.
7
+ */
8
+ export type OpenApi = {
9
+ [k: string]: unknown;
10
+ } | {
11
+ [k: string]: unknown;
12
+ };
13
+ /**
14
+ * A Doc Detective test.
15
+ */
16
+ export type Test = {
17
+ [k: string]: unknown;
18
+ } | {
19
+ [k: string]: unknown;
20
+ };
21
+ export interface Report {
22
+ /**
23
+ * Unique identifier for the test specification.
24
+ */
25
+ reportId?: string;
26
+ /**
27
+ * Test specifications that were performed.
28
+ *
29
+ * @minItems 1
30
+ */
31
+ specs: [Specification, ...Specification[]];
32
+ [k: string]: unknown;
33
+ }
34
+ export interface Specification {
35
+ /**
36
+ * JSON Schema for this object.
37
+ */
38
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/spec_v3.schema.json";
39
+ /**
40
+ * Unique identifier for the test specification.
41
+ */
42
+ specId?: string;
43
+ /**
44
+ * Description of the test specification.
45
+ */
46
+ description?: string;
47
+ /**
48
+ * Path to the test specification.
49
+ */
50
+ specPath?: string;
51
+ /**
52
+ * Path to the content that the specification is associated with.
53
+ */
54
+ contentPath?: string;
55
+ /**
56
+ * Contexts to run the test in. Overrides contexts defined at the config and spec levels.
57
+ */
58
+ runOn?: Context[];
59
+ openApi?: (OpenApi & OpenAPIDescriptionTest)[];
60
+ /**
61
+ * [Tests](test) to perform.
62
+ *
63
+ * @minItems 1
64
+ */
65
+ tests: [Test, ...Test[]];
66
+ [k: string]: unknown;
67
+ }
68
+ /**
69
+ * 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.
70
+ */
71
+ export interface Context {
72
+ /**
73
+ * JSON Schema for this object.
74
+ */
75
+ $schema?: "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/context_v3.schema.json";
76
+ /**
77
+ * Unique identifier for the context.
78
+ */
79
+ contextId?: string;
80
+ /**
81
+ * Platforms to run tests on.
82
+ */
83
+ platforms?: ("linux" | "mac" | "windows") | ("linux" | "mac" | "windows")[];
84
+ /**
85
+ * Browsers to run tests on.
86
+ */
87
+ browsers?: ("chrome" | "firefox" | "safari" | "webkit") | Browser | (("chrome" | "firefox" | "safari" | "webkit") | Browser1)[];
88
+ }
89
+ /**
90
+ * Browser configuration.
91
+ */
92
+ export interface Browser {
93
+ /**
94
+ * Name of the browser.
95
+ */
96
+ name: "chrome" | "firefox" | "safari" | "webkit";
97
+ /**
98
+ * If `true`, runs the browser in headless mode.
99
+ */
100
+ headless?: boolean;
101
+ window?: BrowserWindow;
102
+ viewport?: BrowserViewport;
103
+ }
104
+ /**
105
+ * Browser dimensions.
106
+ */
107
+ export interface BrowserWindow {
108
+ /**
109
+ * Width of the browser window in pixels.
110
+ */
111
+ width?: number;
112
+ /**
113
+ * Height of the browser window in pixels.
114
+ */
115
+ height?: number;
116
+ }
117
+ /**
118
+ * Viewport dimensions.
119
+ */
120
+ export interface BrowserViewport {
121
+ /**
122
+ * Width of the viewport in pixels.
123
+ */
124
+ width?: number;
125
+ /**
126
+ * Height of the viewport in pixels.
127
+ */
128
+ height?: number;
129
+ }
130
+ /**
131
+ * Browser configuration.
132
+ */
133
+ export interface Browser1 {
134
+ /**
135
+ * Name of the browser.
136
+ */
137
+ name: "chrome" | "firefox" | "safari" | "webkit";
138
+ /**
139
+ * If `true`, runs the browser in headless mode.
140
+ */
141
+ headless?: boolean;
142
+ window?: BrowserWindow1;
143
+ viewport?: BrowserViewport1;
144
+ }
145
+ /**
146
+ * Browser dimensions.
147
+ */
148
+ export interface BrowserWindow1 {
149
+ /**
150
+ * Width of the browser window in pixels.
151
+ */
152
+ width?: number;
153
+ /**
154
+ * Height of the browser window in pixels.
155
+ */
156
+ height?: number;
157
+ }
158
+ /**
159
+ * Viewport dimensions.
160
+ */
161
+ export interface BrowserViewport1 {
162
+ /**
163
+ * Width of the viewport in pixels.
164
+ */
165
+ width?: number;
166
+ /**
167
+ * Height of the viewport in pixels.
168
+ */
169
+ height?: number;
170
+ }
171
+ export interface OpenAPIDescriptionTest {
172
+ [k: string]: unknown;
173
+ }
174
+ //# sourceMappingURL=report_v3.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report_v3.d.ts","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/report_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,OAAO,GACf;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,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,KAAK,EAAE,CAAC,aAAa,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC;IAC3C,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;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,OAAO,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,OAAO,GAAG,sBAAsB,CAAC,EAAE,CAAC;IAC/C;;;;OAIG;IACH,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,4GAA4G,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IAC5E;;OAEG;IACH,QAAQ,CAAC,EACL,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAC5C,OAAO,GACP,CAAC,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;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,sBAAsB;IACrC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * Auto-generated from report_v3.schema.json
4
+ * Do not edit manually
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=report_v3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report_v3.js","sourceRoot":"","sources":["../../../../../src/common/src/types/generated/report_v3.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;GAGG"}