@zksecurity/zkao-sdk 0.13.0-next.8 → 0.14.0-next.9

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +14 -0
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -596,6 +596,18 @@ interface components {
596
596
  /** @description Null for a scan launched without a budget. */
597
597
  budget?: components["schemas"]["ScanBudget"] | null;
598
598
  };
599
+ /** @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. */
600
+ ScanTrigger: {
601
+ /**
602
+ * @description What asked for the scan.
603
+ * @enum {string}
604
+ */
605
+ kind: "github_action" | "pr_comment" | "agent" | "api";
606
+ /** @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. */
607
+ pullRequest?: number | null;
608
+ /** @description The comment that asked for the scan, so the link lands on it. Requires pullRequest. */
609
+ commentId?: string | null;
610
+ };
599
611
  /** @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. */
600
612
  ScanBudget: {
601
613
  /** @description The most the scan could spend, in credits. */
@@ -716,6 +728,8 @@ interface components {
716
728
  commitMessage?: string | null;
717
729
  /** @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. */
718
730
  baseCommit?: string | null;
731
+ /** @description Where this launch came from, shown on the scan page. Optional, and display only: nothing in the pipeline reads it. */
732
+ trigger?: components["schemas"]["ScanTrigger"] | null;
719
733
  /** @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. */
720
734
  auditAreaKeys?: string[];
721
735
  /** @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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zksecurity/zkao-sdk",
3
- "version": "0.13.0-next.8",
3
+ "version": "0.14.0-next.9",
4
4
  "description": "TypeScript SDK for the zkao Project API",
5
5
  "license": "MIT",
6
6
  "author": "zkSecurity",