@argos-ci/api-client 0.16.1 → 0.17.0

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.mts +47 -15
  2. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -135,7 +135,7 @@ interface components {
135
135
  } | null; /** @description The color scheme when the screenshot was taken */
136
136
  colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
137
137
  mediaType?: ("screen" | "print") | null;
138
- test?: ({
138
+ test?: {
139
139
  /** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
140
140
  title: string; /** @description The path of titles leading to the test */
141
141
  titlePath: string[]; /** @description The number of retries for the test */
@@ -155,8 +155,9 @@ interface components {
155
155
  line: number; /** @description The column number in the file */
156
156
  column: number;
157
157
  };
158
- }[];
159
- } | null) | null;
158
+ }[]; /** @description Tags associated to the test */
159
+ tags?: string[];
160
+ } | null;
160
161
  browser?: {
161
162
  /** @description The name of the browser */name: string; /** @description The version of the browser */
162
163
  version: string;
@@ -168,7 +169,14 @@ interface components {
168
169
  sdk: {
169
170
  /** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
170
171
  version: string;
171
- };
172
+ }; /** @description Storybook story metadata */
173
+ story?: {
174
+ /** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
175
+ tags?: string[]; /** @description Story mode */
176
+ mode?: string; /** @description True if the story has a play function */
177
+ play?: boolean;
178
+ } | null; /** @description Tags associated to the screenshot */
179
+ tags?: string[];
172
180
  } | null;
173
181
  pwTraceKey?: string | null;
174
182
  threshold?: number | null; /** @default image/png */
@@ -189,7 +197,9 @@ interface components {
189
197
  }; /** @description Build */
190
198
  Build: {
191
199
  id: components["schemas"]["BuildId"]; /** @description The build number */
192
- number: number; /** @description The status of the build */
200
+ number: number; /** @description The head reference of the build */
201
+ head: components["schemas"]["BuildGitReference"]; /** @description The base reference of the build */
202
+ base: components["schemas"]["BuildGitReference"] | null; /** @description The status of the build */
193
203
  status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted"); /** @description The conclusion of the build */
194
204
  conclusion: ("no-changes" | "changes-detected") | null; /** @description Stats of the diffs present in the build */
195
205
  stats: {
@@ -230,6 +240,10 @@ interface components {
230
240
  /** @enum {string} */state: "pending" | "running" | "success" | "failed" | "canceled";
231
241
  };
232
242
  } | null;
243
+ }; /** @description Git reference */
244
+ BuildGitReference: {
245
+ /** @description The commit SHA */sha: components["schemas"]["Sha1Hash"]; /** @description The branch name */
246
+ branch: string;
233
247
  }; /** @description Error response */
234
248
  Error: {
235
249
  error: string;
@@ -271,7 +285,7 @@ interface components {
271
285
  } | null; /** @description The color scheme when the screenshot was taken */
272
286
  colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
273
287
  mediaType?: ("screen" | "print") | null;
274
- test?: ({
288
+ test?: {
275
289
  /** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
276
290
  title: string; /** @description The path of titles leading to the test */
277
291
  titlePath: string[]; /** @description The number of retries for the test */
@@ -291,8 +305,9 @@ interface components {
291
305
  line: number; /** @description The column number in the file */
292
306
  column: number;
293
307
  };
294
- }[];
295
- } | null) | null;
308
+ }[]; /** @description Tags associated to the test */
309
+ tags?: string[];
310
+ } | null;
296
311
  browser?: {
297
312
  /** @description The name of the browser */name: string; /** @description The version of the browser */
298
313
  version: string;
@@ -304,7 +319,14 @@ interface components {
304
319
  sdk: {
305
320
  /** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
306
321
  version: string;
307
- };
322
+ }; /** @description Storybook story metadata */
323
+ story?: {
324
+ /** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
325
+ tags?: string[]; /** @description Story mode */
326
+ mode?: string; /** @description True if the story has a play function */
327
+ play?: boolean;
328
+ } | null; /** @description Tags associated to the screenshot */
329
+ tags?: string[];
308
330
  } | null; /** @description Width of the screenshot in pixels */
309
331
  width: number | null; /** @description Height of the screenshot in pixels */
310
332
  height: number | null;
@@ -332,7 +354,7 @@ interface components {
332
354
  } | null; /** @description The color scheme when the screenshot was taken */
333
355
  colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
334
356
  mediaType?: ("screen" | "print") | null;
335
- test?: ({
357
+ test?: {
336
358
  /** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
337
359
  title: string; /** @description The path of titles leading to the test */
338
360
  titlePath: string[]; /** @description The number of retries for the test */
@@ -352,8 +374,9 @@ interface components {
352
374
  line: number; /** @description The column number in the file */
353
375
  column: number;
354
376
  };
355
- }[];
356
- } | null) | null;
377
+ }[]; /** @description Tags associated to the test */
378
+ tags?: string[];
379
+ } | null;
357
380
  browser?: {
358
381
  /** @description The name of the browser */name: string; /** @description The version of the browser */
359
382
  version: string;
@@ -365,7 +388,14 @@ interface components {
365
388
  sdk: {
366
389
  /** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
367
390
  version: string;
368
- };
391
+ }; /** @description Storybook story metadata */
392
+ story?: {
393
+ /** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
394
+ tags?: string[]; /** @description Story mode */
395
+ mode?: string; /** @description True if the story has a play function */
396
+ play?: boolean;
397
+ } | null; /** @description Tags associated to the screenshot */
398
+ tags?: string[];
369
399
  } | null; /** @description Width of the screenshot in pixels */
370
400
  width: number | null; /** @description Height of the screenshot in pixels */
371
401
  height: number | null;
@@ -419,7 +449,8 @@ interface operations {
419
449
  runId?: string | null; /** @description The attempt number of the current run */
420
450
  runAttempt?: number | null; /** @description Whether the build was skipped, not comparing anything and always succeeding */
421
451
  skipped?: boolean | null; /** @description Whether the build has been created in a merge queue */
422
- mergeQueue?: boolean | null;
452
+ mergeQueue?: boolean | null; /** @description Pull request numbers aggregated by the merge queue build. Requires `mergeQueue` to be `true`. */
453
+ mergeQueuePrNumbers?: number[] | null;
423
454
  /**
424
455
  * @description Indicates whether this build contains only a subset of screenshots.
425
456
  * This is useful when a build is created from an incomplete test suite where some tests are skipped.
@@ -789,7 +820,8 @@ interface operations {
789
820
  query?: {
790
821
  /** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
791
822
  page?: string;
792
- commit?: components["schemas"]["Sha1Hash"]; /** @description Only return the latest builds created, unique by name and commit. */
823
+ head?: string;
824
+ headSha?: components["schemas"]["Sha1Hash"]; /** @description Only return the latest builds created, unique by name and commit. */
793
825
  distinctName?: string;
794
826
  };
795
827
  header?: never;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/api-client",
3
3
  "description": "Argos API Client library.",
4
- "version": "0.16.1",
4
+ "version": "0.17.0",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -52,5 +52,5 @@
52
52
  "debug": "^4.4.3",
53
53
  "openapi-fetch": "^0.17.0"
54
54
  },
55
- "gitHead": "b49d186d5eb6e1338982a4cd5c3cb29e6cb0b7af"
55
+ "gitHead": "82add1422f689642095d43a9e3bb0d2a008728af"
56
56
  }