doc-detective-common 4.0.2-dev.11 → 4.0.2-dev.12

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 (6) hide show
  1. package/dist/index.cjs +196 -112
  2. package/dist/schemas/schemas.json +196 -112
  3. package/dist/types/generated/screenshot_v3.d.ts +2 -2
  4. package/dist/types/generated/step_v3.d.ts +2 -2
  5. package/dist/types/generated/test_v3.d.ts +4 -4
  6. package/package.json +1 -1
package/dist/types/generated/screenshot_v3.d.ts CHANGED
@@ -7,11 +7,11 @@
7
7
  */
8
8
  export type Screenshot = ScreenshotSimple | CaptureScreenshotDetailed | CaptureScreenshot;
9
9
  /**
10
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
10
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
11
11
  */
12
12
  export type ScreenshotSimple = string;
13
13
  /**
14
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
14
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
15
15
  */
16
16
  export type ScreenshotSimple1 = string;
17
17
  /**
package/dist/types/generated/step_v3.d.ts CHANGED
@@ -83,11 +83,11 @@ export type TypeKeysSimple1 = string | string[];
83
83
  */
84
84
  export type Screenshot1 = ScreenshotSimple | CaptureScreenshotDetailed | CaptureScreenshot;
85
85
  /**
86
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
86
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
87
87
  */
88
88
  export type ScreenshotSimple = string;
89
89
  /**
90
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
90
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
91
91
  */
92
92
  export type ScreenshotSimple1 = string;
93
93
  /**
package/dist/types/generated/test_v3.d.ts CHANGED
@@ -158,11 +158,11 @@ export type TypeKeysSimple1 = string | string[];
158
158
  */
159
159
  export type Screenshot1 = ScreenshotSimple | CaptureScreenshotDetailed | CaptureScreenshot;
160
160
  /**
161
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
161
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
162
162
  */
163
163
  export type ScreenshotSimple = string;
164
164
  /**
165
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
165
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
166
166
  */
167
167
  export type ScreenshotSimple1 = string;
168
168
  /**
@@ -395,11 +395,11 @@ export type TypeKeysSimple3 = string | string[];
395
395
  */
396
396
  export type Screenshot3 = ScreenshotSimple2 | CaptureScreenshotDetailed1 | CaptureScreenshot1;
397
397
  /**
398
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
398
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
399
399
  */
400
400
  export type ScreenshotSimple2 = string;
401
401
  /**
402
- * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.
402
+ * File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step. If an `http(s)` URL is supplied, the remote image is downloaded and used as a read-only reference for comparison; the new capture is written to a local run-specific folder instead of being uploaded back to the URL.
403
403
  */
404
404
  export type ScreenshotSimple3 = string;
405
405
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "doc-detective-common",
3
- "version": "4.0.2-dev.11",
3
+ "version": "4.0.2-dev.12",
4
4
  "description": "Shared components for Doc Detective projects.",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",