@proofline/sdk 7.2.0 → 7.3.1

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
@@ -33,7 +33,7 @@ export interface paths {
33
33
  };
34
34
  /**
35
35
  * Export review metadata
36
- * @description Returns one page of a version-1 export dataset (`reviews`, `finding_outcomes`, `finding_validations`, `spend` or `findings`) for an RFC3339 window of at most 31 days, as NDJSON by default or CSV. Rows respect the token's repository restriction.
36
+ * @description Returns one page of an export dataset (`reviews`, `finding_outcomes`, `finding_validations`, `spend` or `findings`) for an RFC3339 window of at most 31 days, as NDJSON by default or CSV. Each dataset has its own row version, which the `X-Proofline-Export-Version` response header states on every page, including a page with no rows. Rows respect the token's repository restriction.
37
37
  */
38
38
  get: operations["export_reviews"];
39
39
  put?: never;
@@ -857,6 +857,13 @@ export interface components {
857
857
  github_environment?: string | null;
858
858
  /** @description Whether any check recorded `REGRESSED`, whatever its gaps. */
859
859
  regressed: boolean;
860
+ /**
861
+ * @description Present when the deploy is a rollback: the previous deploy of the same
862
+ * task ran a commit that a recorded merge into this commit's branch made
863
+ * after this commit, as the deploy's console page reads it. Absent for a
864
+ * forward deploy and when either merge is unrecorded.
865
+ */
866
+ rollback?: components["schemas"]["CommitDeployRollback"] | null;
860
867
  /** @description Where the deploy's verification stands. */
861
868
  state: components["schemas"]["DeployCoverageState"];
862
869
  /**
@@ -880,6 +887,21 @@ export interface components {
880
887
  */
881
888
  workflow_run_id?: number | null;
882
889
  };
890
+ /** @description What a rollback deploy rolled back, and what it restored. */
891
+ CommitDeployRollback: {
892
+ /**
893
+ * @description The latest earlier deploy of this commit by the same task, before the
894
+ * deploys this one rolls back, within 30 days. Absent when the ledger
895
+ * holds none.
896
+ */
897
+ restores?: components["schemas"]["CommitRollbackDeploy"] | null;
898
+ /**
899
+ * @description Each deploy of the same task that landed a commit merged into this
900
+ * commit's branch after it, after `restores` and before this deploy,
901
+ * newest first.
902
+ */
903
+ rolls_back: components["schemas"]["CommitRollbackDeploy"][];
904
+ };
883
905
  /**
884
906
  * @description The deploys of one commit that Proofline recorded, across the
885
907
  * organization's environments.
@@ -923,6 +945,18 @@ export interface components {
923
945
  */
924
946
  review_id: string;
925
947
  };
948
+ /** @description One deploy a rollback names. */
949
+ CommitRollbackDeploy: {
950
+ /** @description The commit that deploy ran. */
951
+ commit_sha: string;
952
+ /** @description The deploy's console page. */
953
+ deploy_url?: string | null;
954
+ /**
955
+ * Format: date-time
956
+ * @description When its last deployment first succeeded, or its AWS run ended.
957
+ */
958
+ landed_at: string;
959
+ };
926
960
  /**
927
961
  * @description What a review is counted under: the cause its assessments recorded, or
928
962
  * `OUT_OF_CREDITS` where an assessment recorded the credit refusal. An
@@ -1803,6 +1837,12 @@ export interface components {
1803
1837
  * repositories, workflow runs, artifacts or deployments.
1804
1838
  */
1805
1839
  subjects: components["schemas"]["SubjectView"][];
1840
+ /**
1841
+ * @description Every distinct review Proofline submitted on the pull request for this
1842
+ * run, including the early code publisher's, oldest first. Absent when it
1843
+ * submitted none.
1844
+ */
1845
+ submitted_reviews?: components["schemas"]["SubmittedReview"][];
1806
1846
  /**
1807
1847
  * Format: uuid
1808
1848
  * @description The newer review that superseded this one. Null when none did or the
@@ -1855,6 +1895,13 @@ export interface components {
1855
1895
  * delay, landing inventory reread, successor wait and transient-read retries.
1856
1896
  */
1857
1897
  due_at: string;
1898
+ /**
1899
+ * @description The gaps this window's check recorded, beside its recorded result;
1900
+ * empty while no check of this window is recorded. The deploy's `gaps`
1901
+ * unite those that leave it unproven.
1902
+ * @default []
1903
+ */
1904
+ gaps?: components["schemas"]["DeployVerificationGap"][];
1858
1905
  /** @description The recorded result; absent while no check of this window is recorded. */
1859
1906
  result?: components["schemas"]["DeployCheckResult"] | null;
1860
1907
  };
@@ -3923,6 +3970,12 @@ export interface components {
3923
3970
  */
3924
3971
  workflow_run_id?: number | null;
3925
3972
  };
3973
+ /** @description One review Proofline submitted on the pull request. */
3974
+ SubmittedReview: {
3975
+ /** @description The commit the review was submitted for. */
3976
+ commit_sha?: string | null;
3977
+ url: string;
3978
+ };
3926
3979
  /** @enum {string} */
3927
3980
  SummaryRoute: "DETERMINISTIC_ONLY" | "SHORT" | "FULL";
3928
3981
  /** @enum {string} */
@@ -4106,7 +4159,7 @@ export interface operations {
4106
4159
  "X-Proofline-Export-Next-Cursor"?: string;
4107
4160
  /** @description Frozen RFC3339 horizon, five minutes before the first request. */
4108
4161
  "X-Proofline-Export-Settled-Until": string;
4109
- /** @description Dataset version 1. */
4162
+ /** @description The row version of the selected dataset, sent on every page, including a page with no rows: `reviews` 1, `finding_outcomes` 1, `finding_validations` 2, `spend` 1, `findings` 2. */
4110
4163
  "X-Proofline-Export-Version": string;
4111
4164
  [name: string]: unknown;
4112
4165
  };
package/dist/transport.js CHANGED
@@ -1,4 +1,4 @@
1
- const VERSION = "7.2.0";
1
+ const VERSION = "7.3.1";
2
2
  const DEFAULT_BASE_URL = "https://proofline.sh";
3
3
  const MAX_RESPONSE_BYTES = 8 * 1024 * 1024;
4
4
  const MAX_RETRIES = 3;
@@ -845,6 +845,17 @@
845
845
  "description": "Whether any check recorded `REGRESSED`, whatever its gaps.",
846
846
  "type": "boolean"
847
847
  },
848
+ "rollback": {
849
+ "anyOf": [
850
+ {
851
+ "$ref": "#/components/schemas/CommitDeployRollback"
852
+ },
853
+ {
854
+ "type": "null"
855
+ }
856
+ ],
857
+ "description": "Present when the deploy is a rollback: the previous deploy of the same\n task ran a commit that a recorded merge into this commit's branch made\n after this commit, as the deploy's console page reads it. Absent for a\n forward deploy and when either merge is unrecorded."
858
+ },
848
859
  "state": {
849
860
  "allOf": [
850
861
  {
@@ -887,6 +898,33 @@
887
898
  ],
888
899
  "type": "object"
889
900
  },
901
+ "CommitDeployRollback": {
902
+ "description": "What a rollback deploy rolled back, and what it restored.",
903
+ "properties": {
904
+ "restores": {
905
+ "anyOf": [
906
+ {
907
+ "$ref": "#/components/schemas/CommitRollbackDeploy"
908
+ },
909
+ {
910
+ "type": "null"
911
+ }
912
+ ],
913
+ "description": "The latest earlier deploy of this commit by the same task, before the\n deploys this one rolls back, within 30 days. Absent when the ledger\n holds none."
914
+ },
915
+ "rolls_back": {
916
+ "description": "Each deploy of the same task that landed a commit merged into this\n commit's branch after it, after `restores` and before this deploy,\n newest first.",
917
+ "items": {
918
+ "$ref": "#/components/schemas/CommitRollbackDeploy"
919
+ },
920
+ "type": "array"
921
+ }
922
+ },
923
+ "required": [
924
+ "rolls_back"
925
+ ],
926
+ "type": "object"
927
+ },
890
928
  "CommitDeployVerifications": {
891
929
  "description": "The deploys of one commit that Proofline recorded, across the\n organization's environments.",
892
930
  "properties": {
@@ -946,6 +984,32 @@
946
984
  ],
947
985
  "type": "object"
948
986
  },
987
+ "CommitRollbackDeploy": {
988
+ "description": "One deploy a rollback names.",
989
+ "properties": {
990
+ "commit_sha": {
991
+ "description": "The commit that deploy ran.",
992
+ "type": "string"
993
+ },
994
+ "deploy_url": {
995
+ "description": "The deploy's console page.",
996
+ "type": [
997
+ "string",
998
+ "null"
999
+ ]
1000
+ },
1001
+ "landed_at": {
1002
+ "description": "When its last deployment first succeeded, or its AWS run ended.",
1003
+ "format": "date-time",
1004
+ "type": "string"
1005
+ }
1006
+ },
1007
+ "required": [
1008
+ "commit_sha",
1009
+ "landed_at"
1010
+ ],
1011
+ "type": "object"
1012
+ },
949
1013
  "CountedCause": {
950
1014
  "anyOf": [
951
1015
  {
@@ -2333,6 +2397,13 @@
2333
2397
  },
2334
2398
  "type": "array"
2335
2399
  },
2400
+ "submitted_reviews": {
2401
+ "description": "Every distinct review Proofline submitted on the pull request for this\n run, including the early code publisher's, oldest first. Absent when it\n submitted none.",
2402
+ "items": {
2403
+ "$ref": "#/components/schemas/SubmittedReview"
2404
+ },
2405
+ "type": "array"
2406
+ },
2336
2407
  "superseded_by_review_id": {
2337
2408
  "description": "The newer review that superseded this one. Null when none did or the\n caller cannot see it.",
2338
2409
  "format": "uuid",
@@ -2472,6 +2543,14 @@
2472
2543
  "format": "date-time",
2473
2544
  "type": "string"
2474
2545
  },
2546
+ "gaps": {
2547
+ "default": [],
2548
+ "description": "The gaps this window's check recorded, beside its recorded result;\n empty while no check of this window is recorded. The deploy's `gaps`\n unite those that leave it unproven.",
2549
+ "items": {
2550
+ "$ref": "#/components/schemas/DeployVerificationGap"
2551
+ },
2552
+ "type": "array"
2553
+ },
2475
2554
  "result": {
2476
2555
  "anyOf": [
2477
2556
  {
@@ -6774,6 +6853,25 @@
6774
6853
  ],
6775
6854
  "type": "object"
6776
6855
  },
6856
+ "SubmittedReview": {
6857
+ "description": "One review Proofline submitted on the pull request.",
6858
+ "properties": {
6859
+ "commit_sha": {
6860
+ "description": "The commit the review was submitted for.",
6861
+ "type": [
6862
+ "string",
6863
+ "null"
6864
+ ]
6865
+ },
6866
+ "url": {
6867
+ "type": "string"
6868
+ }
6869
+ },
6870
+ "required": [
6871
+ "url"
6872
+ ],
6873
+ "type": "object"
6874
+ },
6777
6875
  "SummaryRoute": {
6778
6876
  "enum": [
6779
6877
  "DETERMINISTIC_ONLY",
@@ -7045,7 +7143,7 @@
7045
7143
  },
7046
7144
  "info": {
7047
7145
  "title": "Proofline Review API",
7048
- "version": "7.2.0"
7146
+ "version": "7.3.0"
7049
7147
  },
7050
7148
  "openapi": "3.1.0",
7051
7149
  "paths": {
@@ -7108,7 +7206,7 @@
7108
7206
  },
7109
7207
  "/api/v1/organizations/{org_id}/exports/{dataset}": {
7110
7208
  "get": {
7111
- "description": "Returns one page of a version-1 export dataset (`reviews`, `finding_outcomes`, `finding_validations`, `spend` or `findings`) for an RFC3339 window of at most 31 days, as NDJSON by default or CSV. Rows respect the token's repository restriction.",
7209
+ "description": "Returns one page of an export dataset (`reviews`, `finding_outcomes`, `finding_validations`, `spend` or `findings`) for an RFC3339 window of at most 31 days, as NDJSON by default or CSV. Each dataset has its own row version, which the `X-Proofline-Export-Version` response header states on every page, including a page with no rows. Rows respect the token's repository restriction.",
7112
7210
  "operationId": "export_reviews",
7113
7211
  "parameters": [
7114
7212
  {
@@ -7238,7 +7336,7 @@
7238
7336
  "style": "simple"
7239
7337
  },
7240
7338
  "X-Proofline-Export-Version": {
7241
- "description": "Dataset version 1.",
7339
+ "description": "The row version of the selected dataset, sent on every page, including a page with no rows: `reviews` 1, `finding_outcomes` 1, `finding_validations` 2, `spend` 1, `findings` 2.",
7242
7340
  "required": true,
7243
7341
  "schema": {
7244
7342
  "$schema": "https://json-schema.org/draft/2020-12/schema",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proofline/sdk",
3
- "version": "7.2.0",
3
+ "version": "7.3.1",
4
4
  "description": "Typed clients for the token-scoped Proofline review API",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",