@argos-ci/util 2.3.2 → 2.3.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 (2) hide show
  1. package/dist/browser.d.ts +36 -12
  2. package/package.json +4 -3
package/dist/browser.d.ts CHANGED
@@ -1,35 +1,59 @@
1
1
  type ScreenshotMetadata = {
2
- url?: string;
3
- previewUrl?: string;
2
+ /** @description The URL of the page that was screenshotted */
3
+ url?: string | null;
4
+ /** @description An URL to an accessible preview of the screenshot */
5
+ previewUrl?: string | null;
4
6
  viewport?: {
7
+ /** @description The width of the viewport */
5
8
  width: number;
9
+ /** @description The height of the viewport */
6
10
  height: number;
7
- };
8
- colorScheme?: "light" | "dark";
9
- mediaType?: "screen" | "print";
10
- test: {
11
- id?: string;
11
+ } | null;
12
+ /** @description The color scheme when the screenshot was taken */
13
+ colorScheme?: ("light" | "dark") | null;
14
+ /** @description The media type when the screenshot was taken */
15
+ mediaType?: ("screen" | "print") | null;
16
+ test?: ({
17
+ /** @description The unique identifier of the test */
18
+ id?: string | null;
19
+ /** @description The title of the test */
12
20
  title: string;
21
+ /** @description The path of titles leading to the test */
13
22
  titlePath: string[];
14
- retries?: number;
15
- retry?: number;
16
- repeat?: number;
23
+ /** @description The number of retries for the test */
24
+ retries?: number | null;
25
+ /** @description The current retry count */
26
+ retry?: number | null;
27
+ /** @description The repeat count for the test */
28
+ repeat?: number | null;
29
+ /** @description The location of the test in the source code */
17
30
  location?: {
31
+ /** @description The file where the test is located */
18
32
  file: string;
33
+ /** @description The line number in the file */
19
34
  line: number;
35
+ /** @description The column number in the file */
20
36
  column: number;
21
37
  };
22
- } | null;
38
+ } | null) | null;
23
39
  browser?: {
40
+ /** @description The name of the browser */
24
41
  name: string;
42
+ /** @description The version of the browser */
25
43
  version: string;
26
- };
44
+ } | null;
45
+ /** @description The automation library that generated the screenshot */
27
46
  automationLibrary: {
47
+ /** @description The name of the automation library */
28
48
  name: string;
49
+ /** @description The version of the automation library */
29
50
  version: string;
30
51
  };
52
+ /** @description The Argos SDK that generated the screenshot */
31
53
  sdk: {
54
+ /** @description The name of the Argos SDK */
32
55
  name: string;
56
+ /** @description The version of the Argos SDK */
33
57
  version: string;
34
58
  };
35
59
  transient?: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/util",
3
3
  "description": "Set of utilities used across all Argos SDKs.",
4
- "version": "2.3.2",
4
+ "version": "2.3.3",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -44,7 +44,8 @@
44
44
  "lint": "eslint ."
45
45
  },
46
46
  "devDependencies": {
47
- "@types/node": "^18.19.44"
47
+ "@types/node": "^18.19.44",
48
+ "vitest": "catalog:"
48
49
  },
49
- "gitHead": "e1fae6c3e23967e703e761afce0ec037e07245b6"
50
+ "gitHead": "ecab2281c36828d0c43728e3ed98e1eefe227c99"
50
51
  }