@proofline/sdk 5.8.0 → 5.10.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
@@ -479,6 +479,8 @@ export interface components {
479
479
  github_user_id: number;
480
480
  /** @description The login they were known by when they acted. Display metadata. */
481
481
  login: string;
482
+ /** @description Profile name resolved for this organization. Display metadata only. */
483
+ name?: string | null;
482
484
  /** @description Their profile on the deployment's GitHub host. */
483
485
  profile_url?: string | null;
484
486
  };
@@ -1098,8 +1100,9 @@ export interface components {
1098
1100
  incompleteness_kind?: string | null;
1099
1101
  /**
1100
1102
  * @description Public causes of an `INCOMPLETE` code assessment: `OUT_OF_CREDITS`
1101
- * when credits refused its model. Absent otherwise; other recorded
1102
- * details stay private.
1103
+ * when credits refused its model, and `MODEL_ANSWER_WITHHELD` when the
1104
+ * credential mask withheld its model's answer after the source was read.
1105
+ * Absent otherwise; other recorded details stay private.
1103
1106
  */
1104
1107
  reason_codes?: string[] | null;
1105
1108
  /**
@@ -1623,6 +1626,12 @@ export interface components {
1623
1626
  * @description One-based, append-only ordinal within one repository pull request.
1624
1627
  */
1625
1628
  run_number?: number | null;
1629
+ /**
1630
+ * @description Where an unfinished review's runs stand: running, queued for a worker,
1631
+ * waiting for a scheduled step, or due again after an attempt that did
1632
+ * not finish. Null once the review has ended.
1633
+ */
1634
+ run_progress?: components["schemas"]["RunProgress"] | null;
1626
1635
  /** @description The review's lifecycle status: `PENDING`, `RUNNING`, `COMPLETED`, `INCOMPLETE`, `FAILED`, `SUPERSEDED`, `STOPPED` or `EXCLUDED`. */
1627
1636
  status: string;
1628
1637
  /**
@@ -3279,6 +3288,34 @@ export interface components {
3279
3288
  */
3280
3289
  run_number: number;
3281
3290
  };
3291
+ /** @description Where an unfinished review's runs stand. */
3292
+ RunProgress: {
3293
+ /**
3294
+ * Format: int32
3295
+ * @description Attempts begun by the run in `state`, counting worker claims.
3296
+ */
3297
+ attempts: number;
3298
+ /**
3299
+ * Format: date-time
3300
+ * @description When the run in `state` is due: in the past for `QUEUED`, the next
3301
+ * attempt for `RETRY_SCHEDULED` and the next check for `WAITING`. Null
3302
+ * for `RUNNING`.
3303
+ */
3304
+ due_at?: string | null;
3305
+ /**
3306
+ * Format: date-time
3307
+ * @description When any of the review's runs last recorded a completed step. Null
3308
+ * before the first.
3309
+ */
3310
+ last_progress_at?: string | null;
3311
+ /**
3312
+ * @description The most telling state among the review's unfinished runs: a scheduled
3313
+ * retry, then a running worker, then a queued run, then a wait.
3314
+ */
3315
+ state: components["schemas"]["RunProgressState"];
3316
+ };
3317
+ /** @description What an unfinished review's runs are doing now. */
3318
+ RunProgressState: "WAITING" | "QUEUED" | "RUNNING" | "RETRY_SCHEDULED";
3282
3319
  /** @description One request to scan a ref or an exact commit of the repository. */
3283
3320
  ScanRequestBody: {
3284
3321
  /**
package/dist/transport.js CHANGED
@@ -1,4 +1,4 @@
1
- const VERSION = "5.8.0";
1
+ const VERSION = "5.10.0";
2
2
  const MAX_RESPONSE_BYTES = 8 * 1024 * 1024;
3
3
  const MAX_RETRIES = 3;
4
4
  const MAX_RETRY_SECONDS = 60;
@@ -22,6 +22,13 @@
22
22
  "description": "The login they were known by when they acted. Display metadata.",
23
23
  "type": "string"
24
24
  },
25
+ "name": {
26
+ "description": "Profile name resolved for this organization. Display metadata only.",
27
+ "type": [
28
+ "string",
29
+ "null"
30
+ ]
31
+ },
25
32
  "profile_url": {
26
33
  "description": "Their profile on the deployment's GitHub host.",
27
34
  "type": [
@@ -1245,7 +1252,7 @@
1245
1252
  ]
1246
1253
  },
1247
1254
  "reason_codes": {
1248
- "description": "Public causes of an `INCOMPLETE` code assessment: `OUT_OF_CREDITS`\n when credits refused its model. Absent otherwise; other recorded\n details stay private.",
1255
+ "description": "Public causes of an `INCOMPLETE` code assessment: `OUT_OF_CREDITS`\n when credits refused its model, and `MODEL_ANSWER_WITHHELD` when the\n credential mask withheld its model's answer after the source was read.\n Absent otherwise; other recorded details stay private.",
1249
1256
  "items": {
1250
1257
  "type": "string"
1251
1258
  },
@@ -2072,6 +2079,17 @@
2072
2079
  "null"
2073
2080
  ]
2074
2081
  },
2082
+ "run_progress": {
2083
+ "anyOf": [
2084
+ {
2085
+ "$ref": "#/components/schemas/RunProgress"
2086
+ },
2087
+ {
2088
+ "type": "null"
2089
+ }
2090
+ ],
2091
+ "description": "Where an unfinished review's runs stand: running, queued for a worker,\n waiting for a scheduled step, or due again after an attempt that did\n not finish. Null once the review has ended."
2092
+ },
2075
2093
  "status": {
2076
2094
  "description": "The review's lifecycle status: `PENDING`, `RUNNING`, `COMPLETED`, `INCOMPLETE`, `FAILED`, `SUPERSEDED`, `STOPPED` or `EXCLUDED`.",
2077
2095
  "type": "string"
@@ -5480,6 +5498,70 @@
5480
5498
  ],
5481
5499
  "type": "object"
5482
5500
  },
5501
+ "RunProgress": {
5502
+ "description": "Where an unfinished review's runs stand.",
5503
+ "properties": {
5504
+ "attempts": {
5505
+ "description": "Attempts begun by the run in `state`, counting worker claims.",
5506
+ "format": "int32",
5507
+ "type": "integer"
5508
+ },
5509
+ "due_at": {
5510
+ "description": "When the run in `state` is due: in the past for `QUEUED`, the next\n attempt for `RETRY_SCHEDULED` and the next check for `WAITING`. Null\n for `RUNNING`.",
5511
+ "format": "date-time",
5512
+ "type": [
5513
+ "string",
5514
+ "null"
5515
+ ]
5516
+ },
5517
+ "last_progress_at": {
5518
+ "description": "When any of the review's runs last recorded a completed step. Null\n before the first.",
5519
+ "format": "date-time",
5520
+ "type": [
5521
+ "string",
5522
+ "null"
5523
+ ]
5524
+ },
5525
+ "state": {
5526
+ "allOf": [
5527
+ {
5528
+ "$ref": "#/components/schemas/RunProgressState"
5529
+ }
5530
+ ],
5531
+ "description": "The most telling state among the review's unfinished runs: a scheduled\n retry, then a running worker, then a queued run, then a wait."
5532
+ }
5533
+ },
5534
+ "required": [
5535
+ "state",
5536
+ "attempts"
5537
+ ],
5538
+ "type": "object"
5539
+ },
5540
+ "RunProgressState": {
5541
+ "description": "What an unfinished review's runs are doing now.",
5542
+ "oneOf": [
5543
+ {
5544
+ "const": "WAITING",
5545
+ "description": "A run waits for a scheduled step, such as a push's quiet period, a\n resource another run holds, or its assessments, and is checked again\n at `due_at`.",
5546
+ "type": "string"
5547
+ },
5548
+ {
5549
+ "const": "QUEUED",
5550
+ "description": "A run is due and no worker has claimed it yet. It has been due since\n `due_at`.",
5551
+ "type": "string"
5552
+ },
5553
+ {
5554
+ "const": "RUNNING",
5555
+ "description": "A worker is running one of the review's runs.",
5556
+ "type": "string"
5557
+ },
5558
+ {
5559
+ "const": "RETRY_SCHEDULED",
5560
+ "description": "An attempt of a run ended without finishing, and the run starts again\n at `due_at`.",
5561
+ "type": "string"
5562
+ }
5563
+ ]
5564
+ },
5483
5565
  "ScanRequestBody": {
5484
5566
  "additionalProperties": false,
5485
5567
  "description": "One request to scan a ref or an exact commit of the repository.",
@@ -6075,7 +6157,7 @@
6075
6157
  },
6076
6158
  "info": {
6077
6159
  "title": "Proofline Review API",
6078
- "version": "5.8.0"
6160
+ "version": "5.10.0"
6079
6161
  },
6080
6162
  "openapi": "3.1.0",
6081
6163
  "paths": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proofline/sdk",
3
- "version": "5.8.0",
3
+ "version": "5.10.0",
4
4
  "description": "Typed clients for the token-scoped Proofline review API",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",