@proofline/sdk 5.0.1 → 5.2.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
@@ -1454,6 +1454,12 @@ export interface components {
1454
1454
  * Absent when that observation is unavailable; scalar counts remain separate.
1455
1455
  */
1456
1456
  open_items_observation?: components["schemas"]["ReviewOpenItems"] | null;
1457
+ /**
1458
+ * @description What holds the review now: GitHub's rate limit, and when it resets.
1459
+ * Null unless one of the review's runs waits for it, and once the run
1460
+ * continues.
1461
+ */
1462
+ provider_wait?: components["schemas"]["ProviderWait"] | null;
1457
1463
  /** @description The review's stable public address: `rev_` followed by its identifier without hyphens. */
1458
1464
  public_key: string;
1459
1465
  /**
@@ -1659,7 +1665,7 @@ export interface components {
1659
1665
  /** @enum {string} */
1660
1666
  ExportFindingSeverity: "WARNING" | "SERIOUS";
1661
1667
  /** @enum {string} */
1662
- ExportReviewKind: "PULL_REQUEST" | "DEPLOYMENT" | "PATCH" | "COMMIT" | "FILES";
1668
+ ExportReviewKind: "PULL_REQUEST" | "DEPLOYMENT" | "PATCH" | "COMMIT" | "FILES" | "MERGE_GROUP" | "REVISION_SCAN";
1663
1669
  /** @enum {string} */
1664
1670
  ExportReviewStatus: "PENDING" | "RUNNING" | "COMPLETED" | "INCOMPLETE" | "FAILED" | "SUPERSEDED" | "STOPPED" | "EXCLUDED";
1665
1671
  /** @description The closed row vocabulary of the existing raw-stream export operation. */
@@ -2398,6 +2404,25 @@ export interface components {
2398
2404
  };
2399
2405
  /** @description Why the summary carries prose or does not. */
2400
2406
  ProseOutcome: "PUBLISHED" | "NO_CHANGE_DIGEST" | "NOT_REQUESTED" | "MODEL_UNAVAILABLE" | "MALFORMED" | "REJECTED" | "UNGROUNDED";
2407
+ /** @description A provider wait that holds the review now. */
2408
+ ProviderWait: {
2409
+ /**
2410
+ * @description `GITHUB_RATE_LIMIT`: GitHub's rate limit for the organization's App
2411
+ * installation is reached, and the review continues after it resets.
2412
+ */
2413
+ reason: components["schemas"]["ProviderWaitReason"];
2414
+ /**
2415
+ * Format: date-time
2416
+ * @description When the wait ends: the reset GitHub named, or, when it named none,
2417
+ * when the run is due again.
2418
+ */
2419
+ until: string;
2420
+ };
2421
+ /**
2422
+ * @description Why a review's run waits on a provider.
2423
+ * @enum {string}
2424
+ */
2425
+ ProviderWaitReason: "GITHUB_RATE_LIMIT";
2401
2426
  PullRequestMergeGate: {
2402
2427
  /**
2403
2428
  * Format: int32
@@ -2442,6 +2467,16 @@ export interface components {
2442
2467
  * @description The stable GitHub user ID reported by a merged-close bypass, or null when none was reported.
2443
2468
  */
2444
2469
  merged_by_github_user_id?: number | null;
2470
+ /**
2471
+ * @description The merger's GitHub login as this organization's developer record last saw it. Display
2472
+ * metadata only. Null when the organization has no record of that user.
2473
+ */
2474
+ merged_by_login?: string | null;
2475
+ /**
2476
+ * @description The merger's name, from the organization's developer record or their Proofline account.
2477
+ * Display metadata only: `merged_by_github_user_id` stays the identity. Null when unknown.
2478
+ */
2479
+ merged_by_name?: string | null;
2445
2480
  /**
2446
2481
  * Format: int64
2447
2482
  * @description The actual pull request merged in the recorded bypass, which may differ from the captured PR.
@@ -2947,7 +2982,7 @@ export interface components {
2947
2982
  head_commit_sha?: string | null;
2948
2983
  /**
2949
2984
  * @description Whether the review analyzes a pull request, a deployment, a local patch, pushed
2950
- * commits or selected whole files.
2985
+ * commits, selected whole files, a merge group or a revision scan.
2951
2986
  */
2952
2987
  kind: components["schemas"]["ExportReviewKind"];
2953
2988
  /**
@@ -4169,6 +4204,7 @@ export interface operations {
4169
4204
  path: {
4170
4205
  org_id: string;
4171
4206
  pull_request_number: number;
4207
+ /** @description The repository's name without its owner, or a name it had before a rename. */
4172
4208
  repository: string;
4173
4209
  };
4174
4210
  cookie?: never;
@@ -4201,6 +4237,7 @@ export interface operations {
4201
4237
  path: {
4202
4238
  org_id: string;
4203
4239
  pull_request_number: number;
4240
+ /** @description The repository's name without its owner, or a name it had before a rename. */
4204
4241
  repository: string;
4205
4242
  run_number: number;
4206
4243
  };
package/dist/transport.js CHANGED
@@ -1,4 +1,4 @@
1
- const VERSION = "5.0.1";
1
+ const VERSION = "5.2.0";
2
2
  const MAX_RESPONSE_BYTES = 8 * 1024 * 1024;
3
3
  const MAX_RETRIES = 3;
4
4
  const MAX_RETRY_SECONDS = 60;
@@ -1806,6 +1806,17 @@
1806
1806
  ],
1807
1807
  "description": "Dated PR counts with head, evaluated-scope and bounded thread proof.\n Absent when that observation is unavailable; scalar counts remain separate."
1808
1808
  },
1809
+ "provider_wait": {
1810
+ "anyOf": [
1811
+ {
1812
+ "$ref": "#/components/schemas/ProviderWait"
1813
+ },
1814
+ {
1815
+ "type": "null"
1816
+ }
1817
+ ],
1818
+ "description": "What holds the review now: GitHub's rate limit, and when it resets.\n Null unless one of the review's runs waits for it, and once the run\n continues."
1819
+ },
1809
1820
  "public_key": {
1810
1821
  "description": "The review's stable public address: `rev_` followed by its identifier without hyphens.",
1811
1822
  "type": "string"
@@ -2218,7 +2229,9 @@
2218
2229
  "DEPLOYMENT",
2219
2230
  "PATCH",
2220
2231
  "COMMIT",
2221
- "FILES"
2232
+ "FILES",
2233
+ "MERGE_GROUP",
2234
+ "REVISION_SCAN"
2222
2235
  ],
2223
2236
  "type": "string"
2224
2237
  },
@@ -3815,6 +3828,36 @@
3815
3828
  }
3816
3829
  ]
3817
3830
  },
3831
+ "ProviderWait": {
3832
+ "description": "A provider wait that holds the review now.",
3833
+ "properties": {
3834
+ "reason": {
3835
+ "allOf": [
3836
+ {
3837
+ "$ref": "#/components/schemas/ProviderWaitReason"
3838
+ }
3839
+ ],
3840
+ "description": "`GITHUB_RATE_LIMIT`: GitHub's rate limit for the organization's App\n installation is reached, and the review continues after it resets."
3841
+ },
3842
+ "until": {
3843
+ "description": "When the wait ends: the reset GitHub named, or, when it named none,\n when the run is due again.",
3844
+ "format": "date-time",
3845
+ "type": "string"
3846
+ }
3847
+ },
3848
+ "required": [
3849
+ "reason",
3850
+ "until"
3851
+ ],
3852
+ "type": "object"
3853
+ },
3854
+ "ProviderWaitReason": {
3855
+ "description": "Why a review's run waits on a provider.",
3856
+ "enum": [
3857
+ "GITHUB_RATE_LIMIT"
3858
+ ],
3859
+ "type": "string"
3860
+ },
3818
3861
  "PullRequestMergeGate": {
3819
3862
  "properties": {
3820
3863
  "assessment_count": {
@@ -3895,6 +3938,20 @@
3895
3938
  "null"
3896
3939
  ]
3897
3940
  },
3941
+ "merged_by_login": {
3942
+ "description": "The merger's GitHub login as this organization's developer record last saw it. Display\n metadata only. Null when the organization has no record of that user.",
3943
+ "type": [
3944
+ "string",
3945
+ "null"
3946
+ ]
3947
+ },
3948
+ "merged_by_name": {
3949
+ "description": "The merger's name, from the organization's developer record or their Proofline account.\n Display metadata only: `merged_by_github_user_id` stays the identity. Null when unknown.",
3950
+ "type": [
3951
+ "string",
3952
+ "null"
3953
+ ]
3954
+ },
3898
3955
  "merged_pull_request_number": {
3899
3956
  "description": "The actual pull request merged in the recorded bypass, which may differ from the captured PR.",
3900
3957
  "format": "int64",
@@ -4783,7 +4840,7 @@
4783
4840
  "$ref": "#/components/schemas/ExportReviewKind"
4784
4841
  }
4785
4842
  ],
4786
- "description": "Whether the review analyzes a pull request, a deployment, a local patch, pushed\n commits or selected whole files."
4843
+ "description": "Whether the review analyzes a pull request, a deployment, a local patch, pushed\n commits, selected whole files, a merge group or a revision scan."
4787
4844
  },
4788
4845
  "organization_id": {
4789
4846
  "description": "The organization that owns the review.",
@@ -5793,7 +5850,7 @@
5793
5850
  },
5794
5851
  "info": {
5795
5852
  "title": "Proofline Review API",
5796
- "version": "5.0.0"
5853
+ "version": "5.2.0"
5797
5854
  },
5798
5855
  "openapi": "3.1.0",
5799
5856
  "paths": {
@@ -7107,10 +7164,12 @@
7107
7164
  "style": "simple"
7108
7165
  },
7109
7166
  {
7167
+ "description": "The repository's name without its owner, or a name it had before a rename.",
7110
7168
  "in": "path",
7111
7169
  "name": "repository",
7112
7170
  "required": true,
7113
7171
  "schema": {
7172
+ "description": "The repository's name without its owner, or a name it had before a rename.",
7114
7173
  "type": "string"
7115
7174
  },
7116
7175
  "style": "simple"
@@ -7301,10 +7360,12 @@
7301
7360
  "style": "simple"
7302
7361
  },
7303
7362
  {
7363
+ "description": "The repository's name without its owner, or a name it had before a rename.",
7304
7364
  "in": "path",
7305
7365
  "name": "repository",
7306
7366
  "required": true,
7307
7367
  "schema": {
7368
+ "description": "The repository's name without its owner, or a name it had before a rename.",
7308
7369
  "type": "string"
7309
7370
  },
7310
7371
  "style": "simple"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proofline/sdk",
3
- "version": "5.0.1",
3
+ "version": "5.2.0",
4
4
  "description": "Typed clients for the token-scoped Proofline review API",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",