@buildinternet/releases-api-types 0.58.3 → 0.60.0

package/README.md

@@ -1,12 +1,12 @@
 # @buildinternet/releases-api-types
 
-**Scope:** request/response wire types for the public API worker — types only, zero runtime dependencies. No request logic, no client code, no server handlers.
+**Scope:** request/response wire types for the public API worker. No request logic, no client code, no server handlers.
 
-Wire protocol types for the [Releases](https://releases.sh) registry API.
-
-Pure TypeScript types — zero runtime dependencies — describing request/response
-shapes for the public HTTP API served at `api.releases.sh`. Consumed by the web
-frontend, the remote MCP server, and the [Releases CLI](../../apps/cli).
+Wire protocol for the [Releases](https://releases.sh) registry API: TypeScript
+types plus the Zod schemas they are inferred from, describing the request and
+response shapes served at `api.releases.sh`. Consumed by the web frontend, the
+remote MCP server, and the [Releases CLI](../../apps/cli). Ships as compiled
+ES modules with declarations, so it works in Node, Bun, Deno, and bundlers.
 
 ## Install
 
@@ -26,6 +26,14 @@ async function listOrgs(): Promise<OrgListResponse> {
 }
 ```
 
+To validate a response at runtime, use the matching schema:
+
+```ts
+import { OrgListResponseSchema } from "@buildinternet/releases-api-types";
+
+const orgs = OrgListResponseSchema.parse(await res.json());
+```
+
 Paginated list endpoints return a `ListResponse<T>` envelope (`{ items, pagination }`). The shared pagination semantics also live in
 `@buildinternet/releases-core/cli-contracts` for CLI callers.