@argos-ci/core 3.2.1 → 3.2.2

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/index.d.ts +69 -52
  2. package/package.json +6 -5
package/dist/index.d.ts CHANGED
@@ -125,88 +125,72 @@ interface components {
125
125
  Sha1Hash: string;
126
126
  /** @description SHA256 hash */
127
127
  Sha256Hash: string;
128
- /** @description Build */
129
- Build: {
130
- id: components["schemas"]["BuildId"];
131
- /** @description The build number */
132
- number: number;
133
- /** @description The status of the build */
134
- status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
135
- /**
136
- * Format: uri
137
- * @description The URL of the build
138
- */
139
- url: string;
140
- /** @description The notification payload for the build */
141
- notification: {
142
- description: string;
143
- context: string;
144
- github: {
145
- /** @enum {string} */
146
- state: "pending" | "success" | "error" | "failure";
147
- };
148
- gitlab: {
149
- /** @enum {string} */
150
- state: "pending" | "running" | "success" | "failed" | "canceled";
151
- };
152
- } | null;
153
- };
154
128
  /**
155
129
  * @description A unique identifier for the build
156
130
  * @example 12345
157
131
  */
158
132
  BuildId: string;
159
- /** @description Error response */
160
- Error: {
161
- error: string;
162
- details?: {
163
- message: string;
164
- }[];
165
- };
166
- /**
167
- * @description A unique identifier for the build
168
- * @example 12345
169
- */
170
- buildId: string;
171
133
  /** @description Screenshot input */
172
134
  ScreenshotInput: {
173
135
  key: string;
174
136
  name: string;
175
137
  baseName?: string | null;
176
138
  metadata?: {
177
- url?: string;
178
- previewUrl?: string;
139
+ /** @description The URL of the page that was screenshotted */
140
+ url?: string | null;
141
+ /** @description An URL to an accessible preview of the screenshot */
142
+ previewUrl?: string | null;
179
143
  viewport?: {
144
+ /** @description The width of the viewport */
180
145
  width: number;
146
+ /** @description The height of the viewport */
181
147
  height: number;
182
- };
183
- /** @enum {string} */
184
- colorScheme?: "light" | "dark";
185
- /** @enum {string} */
186
- mediaType?: "screen" | "print";
187
- test?: {
188
- id?: string;
148
+ } | null;
149
+ /** @description The color scheme when the screenshot was taken */
150
+ colorScheme?: ("light" | "dark") | null;
151
+ /** @description The media type when the screenshot was taken */
152
+ mediaType?: ("screen" | "print") | null;
153
+ test?: ({
154
+ /** @description The unique identifier of the test */
155
+ id?: string | null;
156
+ /** @description The title of the test */
189
157
  title: string;
158
+ /** @description The path of titles leading to the test */
190
159
  titlePath: string[];
191
- retries?: number;
192
- retry?: number;
193
- repeat?: number;
160
+ /** @description The number of retries for the test */
161
+ retries?: number | null;
162
+ /** @description The current retry count */
163
+ retry?: number | null;
164
+ /** @description The repeat count for the test */
165
+ repeat?: number | null;
166
+ /** @description The location of the test in the source code */
194
167
  location?: {
168
+ /** @description The file where the test is located */
195
169
  file: string;
170
+ /** @description The line number in the file */
196
171
  line: number;
172
+ /** @description The column number in the file */
197
173
  column: number;
198
174
  };
199
- } | null;
175
+ } | null) | null;
200
176
  browser?: {
177
+ /** @description The name of the browser */
201
178
  name: string;
179
+ /** @description The version of the browser */
202
180
  version: string;
203
- };
181
+ } | null;
182
+ /** @description The automation library that generated the screenshot */
204
183
  automationLibrary: {
184
+ /** @description The name of the automation library */
205
185
  name: string;
186
+ /** @description The version of the automation library */
206
187
  version: string;
207
188
  };
189
+ /** @description The Argos SDK that generated the screenshot */
208
190
  sdk: {
191
+ /** @description The name of the Argos SDK */
209
192
  name: string;
193
+ /** @description The version of the Argos SDK */
210
194
  version: string;
211
195
  };
212
196
  } | null;
@@ -224,6 +208,39 @@ interface components {
224
208
  };
225
209
  };
226
210
  };
211
+ /** @description Build */
212
+ Build: {
213
+ id: components["schemas"]["BuildId"];
214
+ /** @description The build number */
215
+ number: number;
216
+ /** @description The status of the build */
217
+ status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
218
+ /**
219
+ * Format: uri
220
+ * @description The URL of the build
221
+ */
222
+ url: string;
223
+ /** @description The notification payload for the build */
224
+ notification: {
225
+ description: string;
226
+ context: string;
227
+ github: {
228
+ /** @enum {string} */
229
+ state: "pending" | "success" | "error" | "failure";
230
+ };
231
+ gitlab: {
232
+ /** @enum {string} */
233
+ state: "pending" | "running" | "success" | "failed" | "canceled";
234
+ };
235
+ } | null;
236
+ };
237
+ /** @description Error response */
238
+ Error: {
239
+ error: string;
240
+ details?: {
241
+ message: string;
242
+ }[];
243
+ };
227
244
  /** @description Project */
228
245
  Project: {
229
246
  id: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/core",
3
3
  "description": "Node.js SDK for visual testing with Argos.",
4
- "version": "3.2.1",
4
+ "version": "3.2.2",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
7
7
  "exports": {
@@ -40,8 +40,8 @@
40
40
  "access": "public"
41
41
  },
42
42
  "dependencies": {
43
- "@argos-ci/api-client": "0.8.1",
44
- "@argos-ci/util": "2.3.2",
43
+ "@argos-ci/api-client": "0.8.2",
44
+ "@argos-ci/util": "2.3.3",
45
45
  "axios": "^1.8.4",
46
46
  "convict": "^6.2.4",
47
47
  "debug": "^4.4.0",
@@ -54,7 +54,8 @@
54
54
  "@types/convict": "^6.1.6",
55
55
  "@types/debug": "^4.1.12",
56
56
  "@types/tmp": "^0.2.6",
57
- "msw": "^2.7.3"
57
+ "msw": "^2.7.3",
58
+ "vitest": "catalog:"
58
59
  },
59
60
  "scripts": {
60
61
  "build": "tsup && cp ./src/index.cjs ./dist",
@@ -64,5 +65,5 @@
64
65
  "lint": "eslint .",
65
66
  "test": "vitest"
66
67
  },
67
- "gitHead": "e1fae6c3e23967e703e761afce0ec037e07245b6"
68
+ "gitHead": "ecab2281c36828d0c43728e3ed98e1eefe227c99"
68
69
  }