@zksecurity/zkao-sdk 0.25.0-next.17 → 0.27.0-next.18

package/dist/index.d.ts

@@ -762,8 +762,10 @@ interface components {
         Error: {
             error: {
                 /** @enum {string} */
-                code: "unauthorized" | "forbidden" | "not_found" | "bad_request" | "conflict" | "insufficient_credits" | "repository_initializing" | "diff_base_required" | "diff_base_not_allowed" | "diff_base_invalid" | "diff_empty" | "rate_limited" | "internal";
+                code: "unauthorized" | "forbidden" | "not_found" | "bad_request" | "conflict" | "insufficient_credits" | "budget_below_minimum" | "repository_initializing" | "diff_base_required" | "diff_base_not_allowed" | "diff_base_invalid" | "diff_empty" | "rate_limited" | "internal";
                 message: string;
+                /** @description budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan's first scan of a repository also builds its overview, so its minimum is higher. */
+                minimumCredits?: number;
             };
         };
         /** @enum {string} */
@@ -1070,7 +1072,7 @@ interface components {
         };
         LaunchScanRequest: {
             repositoryId: string;
-            /** @description Max budget for the scan, in credits. Reserved at launch. Omit it to launch at the budget zkao recommends for this scan type and scope on this repository. That is the last such scan's budget, or half again when that scan ran short of it, never above twice the scan type's minimum. A first scan starts at twice the minimum. A diff scan is sized from its change instead: the minimum for up to 500 changed lines, then in proportion, up to three times the minimum. */
+            /** @description Max budget for the scan, in credits. Reserved at launch. Omit it to launch at the budget zkao recommends for this scan type and scope on this repository. A Flash or Max scan of the code is sized from the audit areas it reads: the selected areas, or every area in the repository map. One area gets the minimum, and the budget grows with the square root of the area count. With no map, or with `auditScope`, it is twice the minimum. It is half again the last budget when the last scan of the same scope ran short of it. A diff scan is sized from its change instead: the minimum for up to 500 changed lines, then in proportion, up to three times the minimum. Other scan types use the last such scan's budget, or half again when that scan ran short of it, and a first scan starts at twice the minimum. Except for a diff, the recommendation never exceeds twice the minimum. A budget below the minimum is refused with `400` `budget_below_minimum`, whose `minimumCredits` names it. */
             creditBudget?: number;
             /** @description A preset ref from /scan-presets. Defaults to the first active preset. */
             presetRef?: string;
@@ -1079,7 +1081,7 @@ interface components {
             /** @description Pin a specific commit SHA (7-40 hex chars). */
             commitHash?: string | null;
             commitMessage?: string | null;
-            /** @description What a diff scan's change is measured from: a commit SHA, branch, or tag. Required by a diff scan preset and refused by every other. The scan records the merge base of this and the scanned commit. */
+            /** @description What a diff scan's change is measured from: a commit SHA, branch, or tag. Required by a diff scan preset and refused by every other. The scan records the merge base of this and the scanned commit. When no earlier scan of the repository built its overview, the diff scan builds one first, and its minimum and recommended budgets rise. */
             baseCommit?: string | null;
             /** @description Options for Recheck open findings. Omit to reassess eligible Not started findings on the selected branch. Fresh rechecks require the branch's latest commit and reject a pinned commit or audit scope. */
             backlogRecheck?: {
@@ -1104,6 +1106,8 @@ interface components {
             queued: boolean;
             /** @description The budget the scan was launched with, in credits. */
             creditBudget: number;
+            /** @description True when no earlier scan of the repository built its overview, so this diff scan builds one first. It takes longer, and its minimum and recommended budgets are higher. */
+            buildsOverview: boolean;
         };
         RepositoryGuidance: {
             repositoryId: string;
@@ -2677,7 +2681,9 @@ type WaitForScanOptions = {
 declare class ZkaoApiError extends Error {
     readonly status: number;
     readonly code: string;
-    constructor(status: number, code: string, message: string);
+    /** `budget_below_minimum` only: the least the launch could reserve, in credits. */
+    readonly minimumCredits?: number;
+    constructor(status: number, code: string, message: string, minimumCredits?: number);
 }
 /**
  * Typed client for one zkao project. Every call is scoped to the project the

package/dist/index.js

@@ -81,11 +81,16 @@ function isTerminalScanStatus(status) {
 var ZkaoApiError = class extends Error {
   status;
   code;
-  constructor(status, code, message) {
+  /** `budget_below_minimum` only: the least the launch could reserve, in credits. */
+  minimumCredits;
+  constructor(status, code, message, minimumCredits) {
     super(message);
     this.name = "ZkaoApiError";
     this.status = status;
     this.code = code;
+    if (minimumCredits !== void 0) {
+      this.minimumCredits = minimumCredits;
+    }
   }
 };
 function unwrap(result) {
@@ -93,10 +98,12 @@ function unwrap(result) {
     return result.data;
   }
   const envelope = result.error;
+  const minimumCredits = envelope?.error?.minimumCredits;
   throw new ZkaoApiError(
     result.response.status,
     envelope?.error?.code ?? "error",
-    envelope?.error?.message ?? result.response.statusText
+    envelope?.error?.message ?? result.response.statusText,
+    typeof minimumCredits === "number" ? minimumCredits : void 0
   );
 }
 async function getTokenInfo(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zksecurity/zkao-sdk",
-  "version": "0.25.0-next.17",
+  "version": "0.27.0-next.18",
   "description": "TypeScript SDK for the zkao Project API",
   "license": "MIT",
   "author": "zkSecurity",