@proofline/sdk 5.2.0 → 5.3.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.
package/dist/schema.d.ts CHANGED
@@ -1384,6 +1384,13 @@ export interface components {
1384
1384
  diff_stats?: components["schemas"]["ReviewDiffStats"] | null;
1385
1385
  /** @description Display names of this review's assessed environments, not current repository links. */
1386
1386
  environment_display_names: string[];
1387
+ /**
1388
+ * @description For a pull-request review, each environment its repository linked
1389
+ * when the review was created and each environment it assessed, with
1390
+ * whether the review checked it and why not. Absent for any other
1391
+ * review, and when the repository links no environment.
1392
+ */
1393
+ environments?: components["schemas"]["EnvironmentCheck"][];
1387
1394
  /**
1388
1395
  * Format: int64
1389
1396
  * @description How many findings this review's assessments recorded, across all of them.
@@ -1415,6 +1422,13 @@ export interface components {
1415
1422
  * @description The review's identifier.
1416
1423
  */
1417
1424
  id: string;
1425
+ /**
1426
+ * @description Why an `INCOMPLETE` review ended incomplete, as its incomplete
1427
+ * assessments recorded it, in name order. `UNKNOWN` alone when none
1428
+ * recorded a cause. Absent for every other status, and on reads other
1429
+ * than the reviews list and a single review.
1430
+ */
1431
+ incomplete_causes?: components["schemas"]["IncompleteCause"][];
1418
1432
  /** @description Present and true when this run is a Deep Review. */
1419
1433
  is_deep_review?: boolean;
1420
1434
  /**
@@ -1534,8 +1548,10 @@ export interface components {
1534
1548
  */
1535
1549
  repository_url?: string | null;
1536
1550
  /**
1537
- * @description Who asked for this review, for a review a person requested. Null on
1538
- * automatic reviews and on reviews recorded before requesters were.
1551
+ * @description Who asked for this review, for the reviews a person asked for: the
1552
+ * run-now button, a rerun, a pull request `review` command, or local
1553
+ * changes and pushed commits sent from the CLI or an editor. Absent on
1554
+ * automatic reviews, and on reviews recorded before requesters were.
1539
1555
  */
1540
1556
  requested_by?: components["schemas"]["ActorView"] | null;
1541
1557
  /**
@@ -1652,6 +1668,23 @@ export interface components {
1652
1668
  /** @description Severity used by the series count; the linked occurrence may be less severe. */
1653
1669
  severity: string;
1654
1670
  };
1671
+ /**
1672
+ * @description One environment linked to the reviewed repository, and whether this
1673
+ * review checked it.
1674
+ */
1675
+ EnvironmentCheck: {
1676
+ /** @description The environment's display name. */
1677
+ environment_display_name: string;
1678
+ /**
1679
+ * @description Why the environment was not checked or does not apply. Null when it
1680
+ * was checked or its check is still running.
1681
+ */
1682
+ reason?: components["schemas"]["EnvironmentCheckReason"] | null;
1683
+ /** @description Whether this review checked the environment. */
1684
+ state: components["schemas"]["EnvironmentCheckState"];
1685
+ };
1686
+ EnvironmentCheckReason: "NOT_COVERED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
1687
+ EnvironmentCheckState: "CHECKED" | "CHECKING" | "NOT_CHECKED" | "NOT_APPLICABLE";
1655
1688
  /** @enum {string} */
1656
1689
  ExportEvidenceKind: "repository_file" | "repository_file_at_commit" | "companion_repository_file" | "commit" | "workflow_run" | "world_entity" | "deterministic_test" | "recorded_read" | "text";
1657
1690
  ExportEvidenceRef: {
@@ -2129,6 +2162,11 @@ export interface components {
2129
2162
  };
2130
2163
  /** @enum {string} */
2131
2164
  GateStatus: "REQUESTED" | "EVALUATING" | "ALLOWED" | "BLOCKED" | "BYPASSED" | "SUPERSEDED";
2165
+ /**
2166
+ * @description Why an assessment of the review ended incomplete, as the assessment
2167
+ * recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.
2168
+ */
2169
+ IncompleteCause: ("NOT_CONFIGURED" | "POLICY_EXCLUDED" | "EVIDENCE_UNAVAILABLE" | "HYPOTHESES_UNRESOLVED" | "MODEL_BUDGET_EXHAUSTED") | "UNKNOWN";
2132
2170
  /**
2133
2171
  * @description One finding a patch review re-verified against the patch. The outcome is
2134
2172
  * local: the pull request's finding is unchanged whatever it is.
@@ -2855,6 +2893,13 @@ export interface components {
2855
2893
  * @description The review's identifier.
2856
2894
  */
2857
2895
  id: string;
2896
+ /**
2897
+ * @description Why an `INCOMPLETE` review ended incomplete, as its incomplete
2898
+ * assessments recorded it, in name order. `UNKNOWN` alone when none
2899
+ * recorded a cause. Absent for every other status, and on reads other
2900
+ * than the reviews list and a single review.
2901
+ */
2902
+ incomplete_causes?: components["schemas"]["IncompleteCause"][];
2858
2903
  /**
2859
2904
  * @description `PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes
2860
2905
  * sent as a patch, `COMMIT`, a review of pushed commits, `FILES`,
@@ -2937,6 +2982,13 @@ export interface components {
2937
2982
  * cannot be joined with the stored name.
2938
2983
  */
2939
2984
  repository_url?: string | null;
2985
+ /**
2986
+ * @description Who asked for this review, for the reviews a person asked for: the
2987
+ * run-now button, a rerun, a pull request `review` command, or local
2988
+ * changes and pushed commits sent from the CLI or an editor. Absent on
2989
+ * automatic reviews, and on reviews recorded before requesters were.
2990
+ */
2991
+ requested_by?: components["schemas"]["ActorView"] | null;
2940
2992
  /**
2941
2993
  * Format: int64
2942
2994
  * @description One-based, append-only ordinal within one repository pull request.
package/dist/transport.js CHANGED
@@ -1,4 +1,4 @@
1
- const VERSION = "5.2.0";
1
+ const VERSION = "5.3.0";
2
2
  const MAX_RESPONSE_BYTES = 8 * 1024 * 1024;
3
3
  const MAX_RETRIES = 3;
4
4
  const MAX_RETRY_SECONDS = 60;
@@ -1715,6 +1715,13 @@
1715
1715
  },
1716
1716
  "type": "array"
1717
1717
  },
1718
+ "environments": {
1719
+ "description": "For a pull-request review, each environment its repository linked\n when the review was created and each environment it assessed, with\n whether the review checked it and why not. Absent for any other\n review, and when the repository links no environment.",
1720
+ "items": {
1721
+ "$ref": "#/components/schemas/EnvironmentCheck"
1722
+ },
1723
+ "type": "array"
1724
+ },
1718
1725
  "finding_count": {
1719
1726
  "description": "How many findings this review's assessments recorded, across all of them.",
1720
1727
  "format": "int64",
@@ -1750,6 +1757,13 @@
1750
1757
  "format": "uuid",
1751
1758
  "type": "string"
1752
1759
  },
1760
+ "incomplete_causes": {
1761
+ "description": "Why an `INCOMPLETE` review ended incomplete, as its incomplete\n assessments recorded it, in name order. `UNKNOWN` alone when none\n recorded a cause. Absent for every other status, and on reads other\n than the reviews list and a single review.",
1762
+ "items": {
1763
+ "$ref": "#/components/schemas/IncompleteCause"
1764
+ },
1765
+ "type": "array"
1766
+ },
1753
1767
  "is_deep_review": {
1754
1768
  "description": "Present and true when this run is a Deep Review.",
1755
1769
  "type": "boolean"
@@ -1953,7 +1967,7 @@
1953
1967
  "type": "null"
1954
1968
  }
1955
1969
  ],
1956
- "description": "Who asked for this review, for a review a person requested. Null on\n automatic reviews and on reviews recorded before requesters were."
1970
+ "description": "Who asked for this review, for the reviews a person asked for: the\n run-now button, a rerun, a pull request `review` command, or local\n changes and pushed commits sent from the CLI or an editor. Absent on\n automatic reviews, and on reviews recorded before requesters were."
1957
1971
  },
1958
1972
  "review_comment_url": {
1959
1973
  "description": "The pull request review Proofline submitted for this review. Null when\n it submitted none.",
@@ -2172,6 +2186,92 @@
2172
2186
  ],
2173
2187
  "type": "object"
2174
2188
  },
2189
+ "EnvironmentCheck": {
2190
+ "description": "One environment linked to the reviewed repository, and whether this\n review checked it.",
2191
+ "properties": {
2192
+ "environment_display_name": {
2193
+ "description": "The environment's display name.",
2194
+ "type": "string"
2195
+ },
2196
+ "reason": {
2197
+ "anyOf": [
2198
+ {
2199
+ "$ref": "#/components/schemas/EnvironmentCheckReason"
2200
+ },
2201
+ {
2202
+ "type": "null"
2203
+ }
2204
+ ],
2205
+ "description": "Why the environment was not checked or does not apply. Null when it\n was checked or its check is still running."
2206
+ },
2207
+ "state": {
2208
+ "allOf": [
2209
+ {
2210
+ "$ref": "#/components/schemas/EnvironmentCheckState"
2211
+ }
2212
+ ],
2213
+ "description": "Whether this review checked the environment."
2214
+ }
2215
+ },
2216
+ "required": [
2217
+ "environment_display_name",
2218
+ "state"
2219
+ ],
2220
+ "type": "object"
2221
+ },
2222
+ "EnvironmentCheckReason": {
2223
+ "oneOf": [
2224
+ {
2225
+ "const": "NOT_COVERED",
2226
+ "description": "`NOT_CHECKED`: Proofline does not check this environment for pull\n requests, so the review assessed its code only.",
2227
+ "type": "string"
2228
+ },
2229
+ {
2230
+ "const": "FORK_PULL_REQUEST",
2231
+ "description": "`NOT_CHECKED`: the pull request comes from a fork, which Proofline\n does not check against an environment.",
2232
+ "type": "string"
2233
+ },
2234
+ {
2235
+ "const": "UNFINISHED",
2236
+ "description": "`NOT_CHECKED`: the environment's assessment did not finish.",
2237
+ "type": "string"
2238
+ },
2239
+ {
2240
+ "const": "ENDED",
2241
+ "description": "`NOT_CHECKED`: the review or the assessment stopped before the\n environment was checked.",
2242
+ "type": "string"
2243
+ },
2244
+ {
2245
+ "const": "PULL_REQUEST_REVIEWS_OFF",
2246
+ "description": "`NOT_APPLICABLE`: pull request reviews are off on this repository's\n link to the environment.",
2247
+ "type": "string"
2248
+ }
2249
+ ]
2250
+ },
2251
+ "EnvironmentCheckState": {
2252
+ "oneOf": [
2253
+ {
2254
+ "const": "CHECKED",
2255
+ "description": "The environment's assessment finished.",
2256
+ "type": "string"
2257
+ },
2258
+ {
2259
+ "const": "CHECKING",
2260
+ "description": "The environment's assessment is still running.",
2261
+ "type": "string"
2262
+ },
2263
+ {
2264
+ "const": "NOT_CHECKED",
2265
+ "description": "The review did not check the environment; `reason` says why.",
2266
+ "type": "string"
2267
+ },
2268
+ {
2269
+ "const": "NOT_APPLICABLE",
2270
+ "description": "The repository's link to the environment does not ask for pull\n request reviews; `reason` says so.",
2271
+ "type": "string"
2272
+ }
2273
+ ]
2274
+ },
2175
2275
  "ExportEvidenceKind": {
2176
2276
  "enum": [
2177
2277
  "repository_file",
@@ -3267,6 +3367,26 @@
3267
3367
  ],
3268
3368
  "type": "string"
3269
3369
  },
3370
+ "IncompleteCause": {
3371
+ "description": "Why an assessment of the review ended incomplete, as the assessment\n recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.",
3372
+ "oneOf": [
3373
+ {
3374
+ "enum": [
3375
+ "NOT_CONFIGURED",
3376
+ "POLICY_EXCLUDED",
3377
+ "EVIDENCE_UNAVAILABLE",
3378
+ "HYPOTHESES_UNRESOLVED",
3379
+ "MODEL_BUDGET_EXHAUSTED"
3380
+ ],
3381
+ "type": "string"
3382
+ },
3383
+ {
3384
+ "const": "UNKNOWN",
3385
+ "description": "The review ended incomplete and no assessment recorded why.",
3386
+ "type": "string"
3387
+ }
3388
+ ]
3389
+ },
3270
3390
  "LocalReverification": {
3271
3391
  "description": "One finding a patch review re-verified against the patch. The outcome is\n local: the pull request's finding is unchanged whatever it is.",
3272
3392
  "properties": {
@@ -4626,6 +4746,13 @@
4626
4746
  "format": "uuid",
4627
4747
  "type": "string"
4628
4748
  },
4749
+ "incomplete_causes": {
4750
+ "description": "Why an `INCOMPLETE` review ended incomplete, as its incomplete\n assessments recorded it, in name order. `UNKNOWN` alone when none\n recorded a cause. Absent for every other status, and on reads other\n than the reviews list and a single review.",
4751
+ "items": {
4752
+ "$ref": "#/components/schemas/IncompleteCause"
4753
+ },
4754
+ "type": "array"
4755
+ },
4629
4756
  "kind": {
4630
4757
  "description": "`PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes\n sent as a patch, `COMMIT`, a review of pushed commits, `FILES`,\n complete selected files at one pushed commit, `MERGE_GROUP`, the\n commit GitHub's merge queue built for a group of pull requests, or\n `REVISION_SCAN`, a scan of one captured commit.",
4631
4758
  "type": "string"
@@ -4758,6 +4885,17 @@
4758
4885
  "null"
4759
4886
  ]
4760
4887
  },
4888
+ "requested_by": {
4889
+ "anyOf": [
4890
+ {
4891
+ "$ref": "#/components/schemas/ActorView"
4892
+ },
4893
+ {
4894
+ "type": "null"
4895
+ }
4896
+ ],
4897
+ "description": "Who asked for this review, for the reviews a person asked for: the\n run-now button, a rerun, a pull request `review` command, or local\n changes and pushed commits sent from the CLI or an editor. Absent on\n automatic reviews, and on reviews recorded before requesters were."
4898
+ },
4761
4899
  "run_number": {
4762
4900
  "description": "One-based, append-only ordinal within one repository pull request.",
4763
4901
  "format": "int64",
@@ -5850,7 +5988,7 @@
5850
5988
  },
5851
5989
  "info": {
5852
5990
  "title": "Proofline Review API",
5853
- "version": "5.2.0"
5991
+ "version": "5.3.0"
5854
5992
  },
5855
5993
  "openapi": "3.1.0",
5856
5994
  "paths": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proofline/sdk",
3
- "version": "5.2.0",
3
+ "version": "5.3.0",
4
4
  "description": "Typed clients for the token-scoped Proofline review API",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",