@argos-ci/api-client 0.16.1 → 0.17.1-alpha.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.
- package/dist/index.d.mts +141 -80
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -48,7 +48,7 @@ interface paths {
|
|
|
48
48
|
path?: never;
|
|
49
49
|
cookie?: never;
|
|
50
50
|
};
|
|
51
|
-
get
|
|
51
|
+
get?: never;
|
|
52
52
|
put: operations["updateBuild"];
|
|
53
53
|
post?: never;
|
|
54
54
|
delete?: never;
|
|
@@ -57,14 +57,14 @@ interface paths {
|
|
|
57
57
|
patch?: never;
|
|
58
58
|
trace?: never;
|
|
59
59
|
};
|
|
60
|
-
"/
|
|
60
|
+
"/project": {
|
|
61
61
|
parameters: {
|
|
62
62
|
query?: never;
|
|
63
63
|
header?: never;
|
|
64
64
|
path?: never;
|
|
65
65
|
cookie?: never;
|
|
66
66
|
};
|
|
67
|
-
get: operations["
|
|
67
|
+
get: operations["getAuthProject"];
|
|
68
68
|
put?: never;
|
|
69
69
|
post?: never;
|
|
70
70
|
delete?: never;
|
|
@@ -73,14 +73,30 @@ interface paths {
|
|
|
73
73
|
patch?: never;
|
|
74
74
|
trace?: never;
|
|
75
75
|
};
|
|
76
|
-
"/project": {
|
|
76
|
+
"/projects/{owner}/{project}/builds": {
|
|
77
77
|
parameters: {
|
|
78
78
|
query?: never;
|
|
79
79
|
header?: never;
|
|
80
80
|
path?: never;
|
|
81
81
|
cookie?: never;
|
|
82
82
|
};
|
|
83
|
-
get: operations["
|
|
83
|
+
get: operations["getProjectBuilds"];
|
|
84
|
+
put?: never;
|
|
85
|
+
post?: never;
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
"/projects/{owner}/{project}/builds/{buildNumber}": {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
get: operations["getBuildByNumber"];
|
|
84
100
|
put?: never;
|
|
85
101
|
post?: never;
|
|
86
102
|
delete?: never;
|
|
@@ -89,14 +105,14 @@ interface paths {
|
|
|
89
105
|
patch?: never;
|
|
90
106
|
trace?: never;
|
|
91
107
|
};
|
|
92
|
-
"/project/builds": {
|
|
108
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/diffs": {
|
|
93
109
|
parameters: {
|
|
94
110
|
query?: never;
|
|
95
111
|
header?: never;
|
|
96
112
|
path?: never;
|
|
97
113
|
cookie?: never;
|
|
98
114
|
};
|
|
99
|
-
get: operations["
|
|
115
|
+
get: operations["getBuildDiffs"];
|
|
100
116
|
put?: never;
|
|
101
117
|
post?: never;
|
|
102
118
|
delete?: never;
|
|
@@ -135,7 +151,7 @@ interface components {
|
|
|
135
151
|
} | null; /** @description The color scheme when the screenshot was taken */
|
|
136
152
|
colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
|
|
137
153
|
mediaType?: ("screen" | "print") | null;
|
|
138
|
-
test?:
|
|
154
|
+
test?: {
|
|
139
155
|
/** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
|
|
140
156
|
title: string; /** @description The path of titles leading to the test */
|
|
141
157
|
titlePath: string[]; /** @description The number of retries for the test */
|
|
@@ -155,8 +171,9 @@ interface components {
|
|
|
155
171
|
line: number; /** @description The column number in the file */
|
|
156
172
|
column: number;
|
|
157
173
|
};
|
|
158
|
-
}[];
|
|
159
|
-
|
|
174
|
+
}[]; /** @description Tags associated to the test */
|
|
175
|
+
tags?: string[];
|
|
176
|
+
} | null;
|
|
160
177
|
browser?: {
|
|
161
178
|
/** @description The name of the browser */name: string; /** @description The version of the browser */
|
|
162
179
|
version: string;
|
|
@@ -168,7 +185,14 @@ interface components {
|
|
|
168
185
|
sdk: {
|
|
169
186
|
/** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
|
|
170
187
|
version: string;
|
|
171
|
-
};
|
|
188
|
+
}; /** @description Storybook story metadata */
|
|
189
|
+
story?: {
|
|
190
|
+
/** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
|
|
191
|
+
tags?: string[]; /** @description Story mode */
|
|
192
|
+
mode?: string; /** @description True if the story has a play function */
|
|
193
|
+
play?: boolean;
|
|
194
|
+
} | null; /** @description Tags associated to the screenshot */
|
|
195
|
+
tags?: string[];
|
|
172
196
|
} | null;
|
|
173
197
|
pwTraceKey?: string | null;
|
|
174
198
|
threshold?: number | null; /** @default image/png */
|
|
@@ -189,7 +213,9 @@ interface components {
|
|
|
189
213
|
}; /** @description Build */
|
|
190
214
|
Build: {
|
|
191
215
|
id: components["schemas"]["BuildId"]; /** @description The build number */
|
|
192
|
-
number: number; /** @description The
|
|
216
|
+
number: number; /** @description The head reference of the build */
|
|
217
|
+
head: components["schemas"]["BuildGitReference"]; /** @description The base reference of the build */
|
|
218
|
+
base: components["schemas"]["BuildGitReference"] | null; /** @description The status of the build */
|
|
193
219
|
status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted"); /** @description The conclusion of the build */
|
|
194
220
|
conclusion: ("no-changes" | "changes-detected") | null; /** @description Stats of the diffs present in the build */
|
|
195
221
|
stats: {
|
|
@@ -230,6 +256,10 @@ interface components {
|
|
|
230
256
|
/** @enum {string} */state: "pending" | "running" | "success" | "failed" | "canceled";
|
|
231
257
|
};
|
|
232
258
|
} | null;
|
|
259
|
+
}; /** @description Git reference */
|
|
260
|
+
BuildGitReference: {
|
|
261
|
+
/** @description The commit SHA */sha: components["schemas"]["Sha1Hash"]; /** @description The branch name */
|
|
262
|
+
branch: string;
|
|
233
263
|
}; /** @description Error response */
|
|
234
264
|
Error: {
|
|
235
265
|
error: string;
|
|
@@ -271,7 +301,7 @@ interface components {
|
|
|
271
301
|
} | null; /** @description The color scheme when the screenshot was taken */
|
|
272
302
|
colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
|
|
273
303
|
mediaType?: ("screen" | "print") | null;
|
|
274
|
-
test?:
|
|
304
|
+
test?: {
|
|
275
305
|
/** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
|
|
276
306
|
title: string; /** @description The path of titles leading to the test */
|
|
277
307
|
titlePath: string[]; /** @description The number of retries for the test */
|
|
@@ -291,8 +321,9 @@ interface components {
|
|
|
291
321
|
line: number; /** @description The column number in the file */
|
|
292
322
|
column: number;
|
|
293
323
|
};
|
|
294
|
-
}[];
|
|
295
|
-
|
|
324
|
+
}[]; /** @description Tags associated to the test */
|
|
325
|
+
tags?: string[];
|
|
326
|
+
} | null;
|
|
296
327
|
browser?: {
|
|
297
328
|
/** @description The name of the browser */name: string; /** @description The version of the browser */
|
|
298
329
|
version: string;
|
|
@@ -304,7 +335,14 @@ interface components {
|
|
|
304
335
|
sdk: {
|
|
305
336
|
/** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
|
|
306
337
|
version: string;
|
|
307
|
-
};
|
|
338
|
+
}; /** @description Storybook story metadata */
|
|
339
|
+
story?: {
|
|
340
|
+
/** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
|
|
341
|
+
tags?: string[]; /** @description Story mode */
|
|
342
|
+
mode?: string; /** @description True if the story has a play function */
|
|
343
|
+
play?: boolean;
|
|
344
|
+
} | null; /** @description Tags associated to the screenshot */
|
|
345
|
+
tags?: string[];
|
|
308
346
|
} | null; /** @description Width of the screenshot in pixels */
|
|
309
347
|
width: number | null; /** @description Height of the screenshot in pixels */
|
|
310
348
|
height: number | null;
|
|
@@ -332,7 +370,7 @@ interface components {
|
|
|
332
370
|
} | null; /** @description The color scheme when the screenshot was taken */
|
|
333
371
|
colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
|
|
334
372
|
mediaType?: ("screen" | "print") | null;
|
|
335
|
-
test?:
|
|
373
|
+
test?: {
|
|
336
374
|
/** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
|
|
337
375
|
title: string; /** @description The path of titles leading to the test */
|
|
338
376
|
titlePath: string[]; /** @description The number of retries for the test */
|
|
@@ -352,8 +390,9 @@ interface components {
|
|
|
352
390
|
line: number; /** @description The column number in the file */
|
|
353
391
|
column: number;
|
|
354
392
|
};
|
|
355
|
-
}[];
|
|
356
|
-
|
|
393
|
+
}[]; /** @description Tags associated to the test */
|
|
394
|
+
tags?: string[];
|
|
395
|
+
} | null;
|
|
357
396
|
browser?: {
|
|
358
397
|
/** @description The name of the browser */name: string; /** @description The version of the browser */
|
|
359
398
|
version: string;
|
|
@@ -365,7 +404,14 @@ interface components {
|
|
|
365
404
|
sdk: {
|
|
366
405
|
/** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
|
|
367
406
|
version: string;
|
|
368
|
-
};
|
|
407
|
+
}; /** @description Storybook story metadata */
|
|
408
|
+
story?: {
|
|
409
|
+
/** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
|
|
410
|
+
tags?: string[]; /** @description Story mode */
|
|
411
|
+
mode?: string; /** @description True if the story has a play function */
|
|
412
|
+
play?: boolean;
|
|
413
|
+
} | null; /** @description Tags associated to the screenshot */
|
|
414
|
+
tags?: string[];
|
|
369
415
|
} | null; /** @description Width of the screenshot in pixels */
|
|
370
416
|
width: number | null; /** @description Height of the screenshot in pixels */
|
|
371
417
|
height: number | null;
|
|
@@ -378,7 +424,12 @@ interface components {
|
|
|
378
424
|
} | null;
|
|
379
425
|
}; /** @description Project */
|
|
380
426
|
Project: {
|
|
381
|
-
id: string;
|
|
427
|
+
id: string; /** @description Account that owns the project */
|
|
428
|
+
account: {
|
|
429
|
+
id: string;
|
|
430
|
+
slug: string;
|
|
431
|
+
};
|
|
432
|
+
name: string;
|
|
382
433
|
defaultBaseBranch: string;
|
|
383
434
|
hasRemoteContentAccess: boolean;
|
|
384
435
|
};
|
|
@@ -419,7 +470,8 @@ interface operations {
|
|
|
419
470
|
runId?: string | null; /** @description The attempt number of the current run */
|
|
420
471
|
runAttempt?: number | null; /** @description Whether the build was skipped, not comparing anything and always succeeding */
|
|
421
472
|
skipped?: boolean | null; /** @description Whether the build has been created in a merge queue */
|
|
422
|
-
mergeQueue?: boolean | null;
|
|
473
|
+
mergeQueue?: boolean | null; /** @description Pull request numbers aggregated by the merge queue build. Requires `mergeQueue` to be `true`. */
|
|
474
|
+
mergeQueuePrNumbers?: number[] | null;
|
|
423
475
|
/**
|
|
424
476
|
* @description Indicates whether this build contains only a subset of screenshots.
|
|
425
477
|
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
@@ -556,59 +608,6 @@ interface operations {
|
|
|
556
608
|
};
|
|
557
609
|
};
|
|
558
610
|
};
|
|
559
|
-
getBuild: {
|
|
560
|
-
parameters: {
|
|
561
|
-
query?: never;
|
|
562
|
-
header?: never;
|
|
563
|
-
path: {
|
|
564
|
-
/** @description A unique identifier for the build */buildId: components["schemas"]["BuildId"];
|
|
565
|
-
};
|
|
566
|
-
cookie?: never;
|
|
567
|
-
};
|
|
568
|
-
requestBody?: never;
|
|
569
|
-
responses: {
|
|
570
|
-
/** @description Build */200: {
|
|
571
|
-
headers: {
|
|
572
|
-
[name: string]: unknown;
|
|
573
|
-
};
|
|
574
|
-
content: {
|
|
575
|
-
"application/json": components["schemas"]["Build"];
|
|
576
|
-
};
|
|
577
|
-
}; /** @description Invalid parameters */
|
|
578
|
-
400: {
|
|
579
|
-
headers: {
|
|
580
|
-
[name: string]: unknown;
|
|
581
|
-
};
|
|
582
|
-
content: {
|
|
583
|
-
"application/json": components["schemas"]["Error"];
|
|
584
|
-
};
|
|
585
|
-
}; /** @description Unauthorized */
|
|
586
|
-
401: {
|
|
587
|
-
headers: {
|
|
588
|
-
[name: string]: unknown;
|
|
589
|
-
};
|
|
590
|
-
content: {
|
|
591
|
-
"application/json": components["schemas"]["Error"];
|
|
592
|
-
};
|
|
593
|
-
}; /** @description Not found */
|
|
594
|
-
404: {
|
|
595
|
-
headers: {
|
|
596
|
-
[name: string]: unknown;
|
|
597
|
-
};
|
|
598
|
-
content: {
|
|
599
|
-
"application/json": components["schemas"]["Error"];
|
|
600
|
-
};
|
|
601
|
-
}; /** @description Server error */
|
|
602
|
-
500: {
|
|
603
|
-
headers: {
|
|
604
|
-
[name: string]: unknown;
|
|
605
|
-
};
|
|
606
|
-
content: {
|
|
607
|
-
"application/json": components["schemas"]["Error"];
|
|
608
|
-
};
|
|
609
|
-
};
|
|
610
|
-
};
|
|
611
|
-
};
|
|
612
611
|
updateBuild: {
|
|
613
612
|
parameters: {
|
|
614
613
|
query?: never;
|
|
@@ -694,11 +693,14 @@ interface operations {
|
|
|
694
693
|
parameters: {
|
|
695
694
|
query?: {
|
|
696
695
|
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
697
|
-
page?: string;
|
|
696
|
+
page?: string; /** @description Only include diffs that need review */
|
|
697
|
+
needsReview?: boolean;
|
|
698
698
|
};
|
|
699
699
|
header?: never;
|
|
700
700
|
path: {
|
|
701
|
-
/** @description
|
|
701
|
+
/** @description The account slug (owner) */owner: string; /** @description The project name */
|
|
702
|
+
project: string; /** @description The build number */
|
|
703
|
+
buildNumber: number;
|
|
702
704
|
};
|
|
703
705
|
cookie?: never;
|
|
704
706
|
};
|
|
@@ -784,16 +786,20 @@ interface operations {
|
|
|
784
786
|
};
|
|
785
787
|
};
|
|
786
788
|
};
|
|
787
|
-
|
|
789
|
+
getProjectBuilds: {
|
|
788
790
|
parameters: {
|
|
789
791
|
query?: {
|
|
790
792
|
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
791
793
|
page?: string;
|
|
792
|
-
|
|
794
|
+
head?: string;
|
|
795
|
+
headSha?: components["schemas"]["Sha1Hash"]; /** @description Only return the latest builds created, unique by name and commit. */
|
|
793
796
|
distinctName?: string;
|
|
794
797
|
};
|
|
795
798
|
header?: never;
|
|
796
|
-
path
|
|
799
|
+
path: {
|
|
800
|
+
/** @description The account slug (owner) */owner: string; /** @description The project name */
|
|
801
|
+
project: string;
|
|
802
|
+
};
|
|
797
803
|
cookie?: never;
|
|
798
804
|
};
|
|
799
805
|
requestBody?: never;
|
|
@@ -835,6 +841,61 @@ interface operations {
|
|
|
835
841
|
};
|
|
836
842
|
};
|
|
837
843
|
};
|
|
844
|
+
getBuildByNumber: {
|
|
845
|
+
parameters: {
|
|
846
|
+
query?: never;
|
|
847
|
+
header?: never;
|
|
848
|
+
path: {
|
|
849
|
+
/** @description The account slug (owner) */owner: string; /** @description The project name */
|
|
850
|
+
project: string; /** @description The build number */
|
|
851
|
+
buildNumber: number;
|
|
852
|
+
};
|
|
853
|
+
cookie?: never;
|
|
854
|
+
};
|
|
855
|
+
requestBody?: never;
|
|
856
|
+
responses: {
|
|
857
|
+
/** @description Build */200: {
|
|
858
|
+
headers: {
|
|
859
|
+
[name: string]: unknown;
|
|
860
|
+
};
|
|
861
|
+
content: {
|
|
862
|
+
"application/json": components["schemas"]["Build"];
|
|
863
|
+
};
|
|
864
|
+
}; /** @description Invalid parameters */
|
|
865
|
+
400: {
|
|
866
|
+
headers: {
|
|
867
|
+
[name: string]: unknown;
|
|
868
|
+
};
|
|
869
|
+
content: {
|
|
870
|
+
"application/json": components["schemas"]["Error"];
|
|
871
|
+
};
|
|
872
|
+
}; /** @description Unauthorized */
|
|
873
|
+
401: {
|
|
874
|
+
headers: {
|
|
875
|
+
[name: string]: unknown;
|
|
876
|
+
};
|
|
877
|
+
content: {
|
|
878
|
+
"application/json": components["schemas"]["Error"];
|
|
879
|
+
};
|
|
880
|
+
}; /** @description Not found */
|
|
881
|
+
404: {
|
|
882
|
+
headers: {
|
|
883
|
+
[name: string]: unknown;
|
|
884
|
+
};
|
|
885
|
+
content: {
|
|
886
|
+
"application/json": components["schemas"]["Error"];
|
|
887
|
+
};
|
|
888
|
+
}; /** @description Server error */
|
|
889
|
+
500: {
|
|
890
|
+
headers: {
|
|
891
|
+
[name: string]: unknown;
|
|
892
|
+
};
|
|
893
|
+
content: {
|
|
894
|
+
"application/json": components["schemas"]["Error"];
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
};
|
|
838
899
|
}
|
|
839
900
|
//#endregion
|
|
840
901
|
//#region src/index.d.ts
|
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.
|
|
4
|
+
"version": "0.17.1-alpha.2+3431e7d",
|
|
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": "
|
|
55
|
+
"gitHead": "3431e7d43acf6b1f043b55e53dec32318cabcd4c"
|
|
56
56
|
}
|