@zksecurity/zkao-sdk 0.11.0-next.3 → 0.12.0-next.5

package/dist/index.d.ts

@@ -167,8 +167,7 @@ interface paths {
          *     scanned commit, and requires `baseCommit`. Every other preset refuses
          *     it. A malformed, unknown, or misplaced base is a `400` with code
          *     `diff_base_required`, `diff_base_not_allowed`, or `diff_base_invalid`.
-         *     A diff scan also needs an earlier full scan of the branch, and a
-         *     change to audit (otherwise `422`).
+         *     A diff scan also needs a change to audit (otherwise `422`).
          */
         post: operations["launchScan"];
         delete?: never;
@@ -237,6 +236,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/projects/{projectId}/findings/details": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get many findings (full detail)
+         * @description Requires scope: `read`. The full detail of a scan's findings, of a set of findings, or both, in one call. Returns the findings shown in the app: confirmed or inconclusive, on scans the project can see.
+         */
+        get: operations["listFindingDetails"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/projects/{projectId}/findings/{findingId}": {
         parameters: {
             query?: never;
@@ -529,7 +548,7 @@ 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" | "diff_overview_missing" | "rate_limited" | "internal";
+                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";
                 message: string;
             };
         };
@@ -625,6 +644,9 @@ interface components {
         };
         FindingDetail: components["schemas"]["Finding"] & {
             description: string;
+            impact: string;
+            recommendation: string;
+            assumptions: string[];
             pocReport?: string | null;
             recommendedFix?: string | null;
             scanId: string;
@@ -650,6 +672,14 @@ interface components {
             limit: number;
             total: number;
         };
+        PaginatedFindingDetails: {
+            items: components["schemas"]["FindingDetail"][];
+            page: number;
+            limit: number;
+            total: number;
+            /** @description The requested `ids` that matched no finding. */
+            missing: string[];
+        };
         ScanPreset: {
             /** @description Pass as `presetRef` when launching. */
             ref: string;
@@ -838,7 +868,7 @@ interface components {
                 "application/json": components["schemas"]["Error"];
             };
         };
-        /** @description The diff scan cannot run on this repository yet. Code `diff_empty`: the base and the scanned commit have no change between them. Code `diff_overview_missing`: no earlier full scan of the branch (or the default branch) exists to compare against. Run a full scan first. */
+        /** @description The diff scan has nothing to audit. Code `diff_empty`: the base and the scanned commit have no change between them. */
         DiffUnavailable: {
             headers: {
                 [name: string]: unknown;
@@ -1248,6 +1278,39 @@ interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    listFindingDetails: {
+        parameters: {
+            query?: {
+                page?: components["parameters"]["Page"];
+                limit?: number;
+                /** @description Only findings belonging to this scan. */
+                scanId?: string;
+                /** @description Comma-separated finding ids or `ZK-` labels, at most 50. Ids that match nothing are listed in `missing`. */
+                ids?: string;
+            };
+            header?: never;
+            path: {
+                projectId: components["parameters"]["ProjectId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedFindingDetails"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
     getFinding: {
         parameters: {
             query?: never;
@@ -1605,6 +1668,7 @@ type Scan = Schemas["Scan"];
 type ScanDetail = Schemas["ScanDetail"];
 type Finding = Schemas["Finding"];
 type FindingDetail = Schemas["FindingDetail"];
+type FindingDetailsPage = Schemas["PaginatedFindingDetails"];
 type FindingNote = Schemas["FindingNote"];
 type ScanPreset = Schemas["ScanPreset"];
 type LaunchScanRequest = Schemas["LaunchScanRequest"];
@@ -1805,6 +1869,17 @@ declare class ZkaoClient {
         limit?: number;
         scanId?: string;
     }): Promise<Paginated<Finding>>;
+    /**
+     * Full detail of many findings in one call: a scan's, a set of ids or `ZK-`
+     * labels (at most 50), or both. Returns the findings shown in the app.
+     * Requested ids that matched nothing come back in `missing`.
+     */
+    listFindingDetails(opts?: {
+        page?: number;
+        limit?: number;
+        scanId?: string;
+        ids?: string[];
+    }): Promise<FindingDetailsPage>;
     getFinding(findingId: string): Promise<FindingDetail>;
     addFindingNote(findingId: string, content: string): Promise<{
         noteId: string;

package/dist/index.js

@@ -386,6 +386,25 @@ var ZkaoClient = class {
     });
     return unwrap(res);
   }
+  /**
+   * Full detail of many findings in one call: a scan's, a set of ids or `ZK-`
+   * labels (at most 50), or both. Returns the findings shown in the app.
+   * Requested ids that matched nothing come back in `missing`.
+   */
+  async listFindingDetails(opts = {}) {
+    const res = await this.http.GET("/projects/{projectId}/findings/details", {
+      params: {
+        path: this.path,
+        query: {
+          page: opts.page,
+          limit: opts.limit,
+          scanId: opts.scanId,
+          ids: opts.ids?.join(",")
+        }
+      }
+    });
+    return unwrap(res);
+  }
   async getFinding(findingId) {
     const res = await this.http.GET("/projects/{projectId}/findings/{findingId}", {
       params: { path: { ...this.path, findingId } }

package/package.json

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