@argos-ci/api-client 0.21.0 → 0.22.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 +82 -15
  2. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -280,7 +280,11 @@ interface components {
280
280
  schemas: {
281
281
  /** @description SHA1 hash */Sha1Hash: string;
282
282
  GitBranch: string; /** @description SHA256 hash */
283
- Sha256Hash: string;
283
+ Sha256Hash: string; /** @description Screenshot file to upload */
284
+ ScreenshotUploadRequest: {
285
+ key: components["schemas"]["Sha256Hash"]; /** @description Content type of the snapshot file */
286
+ contentType: string;
287
+ };
284
288
  /**
285
289
  * @description A unique identifier for the build
286
290
  * @example 12345
@@ -349,8 +353,8 @@ interface components {
349
353
  tags?: string[];
350
354
  } | null;
351
355
  pwTraceKey?: string | null;
352
- threshold?: number | null; /** @default image/png */
353
- contentType: string;
356
+ threshold?: number | null; /** @description Content type of the snapshot file */
357
+ contentType?: string;
354
358
  }; /** @description Build metadata */
355
359
  BuildMetadata: {
356
360
  /** @description Test suite report */testReport?: {
@@ -413,7 +417,8 @@ interface components {
413
417
  };
414
418
  gitlab: {
415
419
  /** @enum {string} */state: "pending" | "running" | "success" | "failed" | "canceled";
416
- };
420
+ }; /** Format: uri */
421
+ url: string;
417
422
  } | null;
418
423
  }; /** @description Git reference */
419
424
  BuildGitReference: {
@@ -618,8 +623,7 @@ interface operations {
618
623
  content: {
619
624
  "application/json": {
620
625
  /** @description The commit the build is running on */commit: components["schemas"]["Sha1Hash"]; /** @description The branch the build is running on */
621
- branch: components["schemas"]["GitBranch"]; /** @description Keys of screenshot files */
622
- screenshotKeys: components["schemas"]["Sha256Hash"][]; /** @description Keys of Playwright trace files */
626
+ branch: components["schemas"]["GitBranch"]; /** @description Keys of Playwright trace files */
623
627
  pwTraceKeys?: components["schemas"]["Sha256Hash"][]; /** @description The name of the build (for multi-build setups) */
624
628
  name?: string | null; /** @description Whether to run the build in parallel */
625
629
  parallel?: boolean | null; /** @description A unique nonce for the parallel build */
@@ -642,7 +646,17 @@ interface operations {
642
646
  * This is useful when a build is created from an incomplete test suite where some tests are skipped.
643
647
  */
644
648
  subset?: boolean | null;
645
- };
649
+ } & ({
650
+ /**
651
+ * @deprecated
652
+ * @description Keys of screenshot files
653
+ */
654
+ screenshotKeys: components["schemas"]["Sha256Hash"][];
655
+ screenshots?: unknown;
656
+ } | {
657
+ /** @description Screenshot files to upload */screenshots: components["schemas"]["ScreenshotUploadRequest"][];
658
+ screenshotKeys?: unknown;
659
+ });
646
660
  };
647
661
  };
648
662
  responses: {
@@ -653,14 +667,36 @@ interface operations {
653
667
  content: {
654
668
  "application/json": {
655
669
  build: components["schemas"]["Build"];
656
- screenshots: {
657
- key: string; /** Format: uri */
670
+ screenshots: ({
671
+ key: string;
672
+ /**
673
+ * Format: uri
674
+ * @deprecated
675
+ * @description Deprecated. Use postUrl and fields instead.
676
+ */
658
677
  putUrl: string;
659
- }[];
660
- pwTraces: {
678
+ } | {
661
679
  key: string; /** Format: uri */
680
+ postUrl: string;
681
+ fields: {
682
+ [key: string]: string;
683
+ };
684
+ })[];
685
+ pwTraces: ({
686
+ key: string;
687
+ /**
688
+ * Format: uri
689
+ * @deprecated
690
+ * @description Deprecated. Use postUrl and fields instead.
691
+ */
662
692
  putUrl: string;
663
- }[];
693
+ } | {
694
+ key: string; /** Format: uri */
695
+ postUrl: string;
696
+ fields: {
697
+ [key: string]: string;
698
+ };
699
+ })[];
664
700
  };
665
701
  };
666
702
  }; /** @description Invalid parameters */
@@ -1181,6 +1217,14 @@ interface operations {
1181
1217
  content: {
1182
1218
  "application/json": components["schemas"]["Error"];
1183
1219
  };
1220
+ }; /** @description Not found */
1221
+ 404: {
1222
+ headers: {
1223
+ [name: string]: unknown;
1224
+ };
1225
+ content: {
1226
+ "application/json": components["schemas"]["Error"];
1227
+ };
1184
1228
  }; /** @description Server error */
1185
1229
  500: {
1186
1230
  headers: {
@@ -1189,6 +1233,14 @@ interface operations {
1189
1233
  content: {
1190
1234
  "application/json": components["schemas"]["Error"];
1191
1235
  };
1236
+ }; /** @description Service unavailable */
1237
+ 503: {
1238
+ headers: {
1239
+ [name: string]: unknown;
1240
+ };
1241
+ content: {
1242
+ "application/json": components["schemas"]["Error"];
1243
+ };
1192
1244
  };
1193
1245
  };
1194
1246
  };
@@ -1573,10 +1625,17 @@ interface operations {
1573
1625
  content: {
1574
1626
  "application/json": {
1575
1627
  /**
1576
- * @description Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES"
1628
+ * @description Review event to apply to the build: "APPROVE", "REJECT" or "COMMENT". Required when `conclusion` is not provided.
1577
1629
  * @enum {string}
1578
1630
  */
1579
- conclusion: "APPROVE" | "REQUEST_CHANGES";
1631
+ event?: "APPROVE" | "REJECT" | "COMMENT";
1632
+ /**
1633
+ * @deprecated
1634
+ * @description Deprecated: use `event` instead. Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES".
1635
+ * @enum {string}
1636
+ */
1637
+ conclusion?: "APPROVE" | "REQUEST_CHANGES"; /** @description Optional comment to attach to the review. Expected as the JSON representation of a rich-text document. */
1638
+ body?: unknown;
1580
1639
  /**
1581
1640
  * @description Optional per-snapshot review decisions. When omitted, only the build-level review is recorded.
1582
1641
  * @default []
@@ -1600,9 +1659,17 @@ interface operations {
1600
1659
  content: {
1601
1660
  "application/json": {
1602
1661
  id: string; /** @enum {string} */
1603
- state: "approved" | "rejected";
1662
+ state: "approved" | "rejected" | "commented" | "pending";
1604
1663
  };
1605
1664
  };
1665
+ }; /** @description Invalid parameters */
1666
+ 400: {
1667
+ headers: {
1668
+ [name: string]: unknown;
1669
+ };
1670
+ content: {
1671
+ "application/json": components["schemas"]["Error"];
1672
+ };
1606
1673
  }; /** @description Unauthorized */
1607
1674
  401: {
1608
1675
  headers: {
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.21.0",
4
+ "version": "0.22.0",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -54,5 +54,5 @@
54
54
  "openapi-fetch": "^0.17.0",
55
55
  "p-retry": "^8.0.0"
56
56
  },
57
- "gitHead": "fa5a1d192b0782602f9a415ddfc82c0f696eec7b"
57
+ "gitHead": "4d890d5091bd313c327eb4e8c17dc1bee9d48578"
58
58
  }