@proofline/sdk 6.4.0 → 7.0.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
@@ -1524,6 +1524,15 @@ export interface components {
1524
1524
  * `REVISION_SCAN`, a scan of one captured commit.
1525
1525
  */
1526
1526
  kind: string;
1527
+ /**
1528
+ * @description What this review's linked-issue receipt recorded, read from the
1529
+ * receipt and never from current settings, so a later allowlist change
1530
+ * does not alter it. Null when the review kept no receipt: a kind that
1531
+ * reads no linked issues, a run that has not prepared its context yet,
1532
+ * a run that predates receipts, or a receipt that does not decode. Null
1533
+ * never means that no issue was captured.
1534
+ */
1535
+ linked_issues?: components["schemas"]["LinkedIssueCapture"] | null;
1527
1536
  /**
1528
1537
  * @description For a patch review requested with `verify_finding_ids`, each finding
1529
1538
  * it re-verifies against the patch and the outcome. The outcome is
@@ -1786,6 +1795,8 @@ export interface components {
1786
1795
  EnvironmentCheck: {
1787
1796
  /** @description The environment's display name. */
1788
1797
  environment_display_name: string;
1798
+ /** @description The environment's key, which names its console pages. */
1799
+ environment_external_key: string;
1789
1800
  /**
1790
1801
  * @description Why the environment was not checked or does not apply. Null when it
1791
1802
  * was checked or its check is still running.
@@ -1794,7 +1805,7 @@ export interface components {
1794
1805
  /** @description Whether this review checked the environment. */
1795
1806
  state: components["schemas"]["EnvironmentCheckState"];
1796
1807
  };
1797
- EnvironmentCheckReason: "NOT_COVERED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
1808
+ EnvironmentCheckReason: "NOT_COVERED" | "NO_CLOUD_ACCOUNT" | "READS_REFUSED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
1798
1809
  EnvironmentCheckState: "CHECKED" | "CHECKING" | "NOT_CHECKED" | "NOT_APPLICABLE";
1799
1810
  /** @enum {string} */
1800
1811
  ExportEvidenceKind: "repository_file" | "repository_file_at_commit" | "companion_repository_file" | "commit" | "workflow_run" | "world_entity" | "deterministic_test" | "recorded_read" | "text";
@@ -2287,6 +2298,20 @@ export interface components {
2287
2298
  * recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.
2288
2299
  */
2289
2300
  IncompleteCause: ("NOT_CONFIGURED" | "POLICY_EXCLUDED" | "EVIDENCE_UNAVAILABLE" | "HYPOTHESES_UNRESOLVED" | "MODEL_BUDGET_EXHAUSTED") | "UNKNOWN";
2301
+ /**
2302
+ * @description The count and outcome of a review's linked-issue receipt. Issue numbers,
2303
+ * titles and the receipt's gaps stay in the receipt.
2304
+ */
2305
+ LinkedIssueCapture: {
2306
+ /**
2307
+ * Format: int64
2308
+ * @description How many issues the review captured as context.
2309
+ */
2310
+ captured_count: number;
2311
+ outcome: components["schemas"]["LinkedIssueOutcome"];
2312
+ };
2313
+ /** @description What the review's linked-issue preparation found. */
2314
+ LinkedIssueOutcome: "NOT_CONFIGURED" | "NO_REFERENCES" | "PREPARED" | "SOURCE_UNAVAILABLE";
2290
2315
  /**
2291
2316
  * @description One finding a patch review re-verified against the patch. The outcome is
2292
2317
  * local: the pull request's finding is unchanged whatever it is.
package/dist/transport.js CHANGED
@@ -1,4 +1,4 @@
1
- const VERSION = "6.4.0";
1
+ const VERSION = "7.0.0";
2
2
  const DEFAULT_BASE_URL = "https://proofline.sh";
3
3
  const MAX_RESPONSE_BYTES = 8 * 1024 * 1024;
4
4
  const MAX_RETRIES = 3;
@@ -1903,6 +1903,17 @@
1903
1903
  "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.",
1904
1904
  "type": "string"
1905
1905
  },
1906
+ "linked_issues": {
1907
+ "anyOf": [
1908
+ {
1909
+ "$ref": "#/components/schemas/LinkedIssueCapture"
1910
+ },
1911
+ {
1912
+ "type": "null"
1913
+ }
1914
+ ],
1915
+ "description": "What this review's linked-issue receipt recorded, read from the\n receipt and never from current settings, so a later allowlist change\n does not alter it. Null when the review kept no receipt: a kind that\n reads no linked issues, a run that has not prepared its context yet,\n a run that predates receipts, or a receipt that does not decode. Null\n never means that no issue was captured."
1916
+ },
1906
1917
  "local_reverifications": {
1907
1918
  "description": "For a patch review requested with `verify_finding_ids`, each finding\n it re-verifies against the patch and the outcome. The outcome is\n local: the pull request's finding is unchanged whatever it is. Absent\n otherwise.",
1908
1919
  "items": {
@@ -2360,6 +2371,10 @@
2360
2371
  "description": "The environment's display name.",
2361
2372
  "type": "string"
2362
2373
  },
2374
+ "environment_external_key": {
2375
+ "description": "The environment's key, which names its console pages.",
2376
+ "type": "string"
2377
+ },
2363
2378
  "reason": {
2364
2379
  "anyOf": [
2365
2380
  {
@@ -2382,6 +2397,7 @@
2382
2397
  },
2383
2398
  "required": [
2384
2399
  "environment_display_name",
2400
+ "environment_external_key",
2385
2401
  "state"
2386
2402
  ],
2387
2403
  "type": "object"
@@ -2393,6 +2409,16 @@
2393
2409
  "description": "`NOT_CHECKED`: Proofline does not check this environment for pull\n requests, so the review assessed its code only.",
2394
2410
  "type": "string"
2395
2411
  },
2412
+ {
2413
+ "const": "NO_CLOUD_ACCOUNT",
2414
+ "description": "`NOT_CHECKED`: no AWS account, Google Cloud project or Azure\n subscription is connected to the environment, so the review assessed\n its code only. The environment's Setup page connects one.",
2415
+ "type": "string"
2416
+ },
2417
+ {
2418
+ "const": "READS_REFUSED",
2419
+ "description": "`NOT_CHECKED`: the environment's assessment is incomplete because the\n inventory it pinned lacks reads a connected account's role refused.\n The environment's Setup page names them.",
2420
+ "type": "string"
2421
+ },
2396
2422
  {
2397
2423
  "const": "FORK_PULL_REQUEST",
2398
2424
  "description": "`NOT_CHECKED`: the pull request comes from a fork, which Proofline\n does not check against an environment.",
@@ -3591,6 +3617,49 @@
3591
3617
  }
3592
3618
  ]
3593
3619
  },
3620
+ "LinkedIssueCapture": {
3621
+ "description": "The count and outcome of a review's linked-issue receipt. Issue numbers,\n titles and the receipt's gaps stay in the receipt.",
3622
+ "properties": {
3623
+ "captured_count": {
3624
+ "description": "How many issues the review captured as context.",
3625
+ "format": "int64",
3626
+ "type": "integer"
3627
+ },
3628
+ "outcome": {
3629
+ "$ref": "#/components/schemas/LinkedIssueOutcome"
3630
+ }
3631
+ },
3632
+ "required": [
3633
+ "outcome",
3634
+ "captured_count"
3635
+ ],
3636
+ "type": "object"
3637
+ },
3638
+ "LinkedIssueOutcome": {
3639
+ "description": "What the review's linked-issue preparation found.",
3640
+ "oneOf": [
3641
+ {
3642
+ "const": "NOT_CONFIGURED",
3643
+ "description": "No issue source was connected for the review.",
3644
+ "type": "string"
3645
+ },
3646
+ {
3647
+ "const": "NO_REFERENCES",
3648
+ "description": "The pull request referenced no issue.",
3649
+ "type": "string"
3650
+ },
3651
+ {
3652
+ "const": "PREPARED",
3653
+ "description": "The pull request referenced issues and the source was read.",
3654
+ "type": "string"
3655
+ },
3656
+ {
3657
+ "const": "SOURCE_UNAVAILABLE",
3658
+ "description": "The source could not be read, or the review's evaluation withheld\n linked issues.",
3659
+ "type": "string"
3660
+ }
3661
+ ]
3662
+ },
3594
3663
  "LocalReverification": {
3595
3664
  "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.",
3596
3665
  "properties": {
@@ -6356,7 +6425,7 @@
6356
6425
  },
6357
6426
  "info": {
6358
6427
  "title": "Proofline Review API",
6359
- "version": "6.4.0"
6428
+ "version": "7.0.0"
6360
6429
  },
6361
6430
  "openapi": "3.1.0",
6362
6431
  "paths": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proofline/sdk",
3
- "version": "6.4.0",
3
+ "version": "7.0.0",
4
4
  "description": "Typed clients for the token-scoped Proofline review API",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",