@zksecurity/zkao-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zkSecurity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# @zksecurity/zkao-sdk
+
+Typed TypeScript client for the [zkao](https://zkao.io) Project API. Drive a
+single zkao security-audit project with a project API token: list repositories,
+launch and poll scans, read and triage findings, and publish results.
+
+```bash
+npm install @zksecurity/zkao-sdk
+```
+
+```ts
+import { ZkaoClient } from "@zksecurity/zkao-sdk";
+
+const zkao = new ZkaoClient({
+  token: process.env.ZKAO_API_TOKEN!,
+  projectId: process.env.ZKAO_PROJECT_ID!,
+});
+
+const { scanId } = await zkao.launchScan({ repositoryId, creditBudget: 500 });
+const scan = await zkao.waitForScan(scanId, { onPoll: (s) => console.log(s.status) });
+const findings = await zkao.listFindings({ scanId });
+```
+
+Every method is fully typed from the OpenAPI spec. Non-2xx responses throw
+`ZkaoApiError` (with `.status` and `.code`). The base URL comes from the
+`baseUrl` option, else `ZKAO_URL`, else production.
+
+Cancel a running or queued scan with `zkao.cancelScan(scanId)`; you are charged
+only for analysis already done and the rest of the reserved budget is released.
+
+Full docs, the CLI (`@zksecurity/zkao-cli`), and the OpenAPI contract:
+**https://github.com/zksecurity/zkao-sdk**
+
+## License
+
+MIT