@zksecurity/zkao-sdk 0.12.0-next.7 → 0.14.0-next.9

package/dist/index.d.ts

@@ -593,6 +593,32 @@ interface components {
             completedAt?: string | null;
             /** @description Phase progress while the scan is in flight. Null once the scan reaches a terminal state, and null before it has been dispatched (no phases exist yet). */
             progress?: components["schemas"]["ScanProgress"] | null;
+            /** @description Null for a scan launched without a budget. */
+            budget?: components["schemas"]["ScanBudget"] | null;
+        };
+        /** @description Where a launch came from. References only: no URL is accepted, and the link the scan page shows is built from the scanned repository, so a token can never point that page somewhere of its own choosing. */
+        ScanTrigger: {
+            /**
+             * @description What asked for the scan.
+             * @enum {string}
+             */
+            kind: "github_action" | "pr_comment" | "agent" | "api";
+            /** @description Pull request number in the scanned repository. Its existence is not checked: a wrong number only yields a dead link in your own repository. */
+            pullRequest?: number | null;
+            /** @description The comment that asked for the scan, so the link lands on it. Requires pullRequest. */
+            commentId?: string | null;
+        };
+        /** @description What a scan was allowed to spend, what it was charged, and whether the next scan of its type and scope should get more. Check the last scan of a type before choosing the next one's budget. */
+        ScanBudget: {
+            /** @description The most the scan could spend, in credits. */
+            limitCredits: number;
+            /** @description Credits charged for the scan. Null until it finishes. */
+            spentCredits: number | null;
+            /**
+             * @description Whether the next scan of this type and scope should keep this budget or raise it. A raise is half again, never above twice the scan type's minimum. A raise can follow a scan that spent well under its limit: the limit is divided between the parts of the analysis, and one part cannot use another's unspent share. Null until the scan completes.
+             * @enum {string|null}
+             */
+            nextBudgetRecommendation: "keep" | "raise" | null;
         };
         /** @description How far a running scan has got through its phases. Deliberately not a time estimate: a phase's duration moves with the guidance it was given, the repository, and the model that ran it. */
         ScanProgress: {
@@ -702,6 +728,8 @@ interface components {
             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. */
             baseCommit?: string | null;
+            /** @description Where this launch came from, shown on the scan page. Optional, and display only: nothing in the pipeline reads it. */
+            trigger?: components["schemas"]["ScanTrigger"] | null;
             /** @description Area keys from /audit-areas to scope this scan to. Omit or send an empty array to scan the whole repository. A key the repository's current map no longer names fails the launch rather than being dropped, so a scan budgeted for one subsystem never silently runs against everything. */
             auditAreaKeys?: string[];
             /** @description Guidance for this scan only, replacing the repository's configured guidance layer (it is still layered over any committed zkao.md). Omit the field to inherit the repository's guidance; send null to scan with no guidance layer. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zksecurity/zkao-sdk",
-  "version": "0.12.0-next.7",
+  "version": "0.14.0-next.9",
   "description": "TypeScript SDK for the zkao Project API",
   "license": "MIT",
   "author": "zkSecurity",