@beignet/core 0.0.45 → 0.0.46

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @beignet/core
 
+## 0.0.46
+
+### Patch Changes
+
+- 3184f87: Document and verify external TypeScript clients generated from Beignet OpenAPI documents.
+
 ## 0.0.45
 
 ### Patch Changes

package/README.md

@@ -2274,6 +2274,36 @@ OpenAPI `operationId` defaults to the stable contract name. Explicit operation
 IDs are supported when an external SDK needs a different method name; server
 registration and OpenAPI generation reject duplicates.
 
+### External TypeScript clients
+
+Applications outside the contract-owning codebase can generate types from the
+served OpenAPI document and use them with an independent client:
+
+```bash
+bun add openapi-fetch
+bun add --dev openapi-typescript typescript
+bunx openapi-typescript https://api.example.com/api/openapi --output src/generated/api.ts
+```
+
+```ts
+import createClient from "openapi-fetch";
+import type { paths } from "./generated/api";
+
+const api = createClient<paths>({
+  baseUrl: "https://api.example.com",
+});
+
+const { data, error } = await api.GET("/api/todos/{id}", {
+  params: { path: { id: "todo_123" } },
+});
+```
+
+The generated client types cover paths, parameters, JSON bodies, responses,
+and declared catalog errors. Map OpenAPI `string/binary` schemas to `Blob`
+through the generator's Node API for typed uploads and downloads. See the
+[OpenAPI guide](https://beignetjs.com/openapi) for the complete generation,
+non-JSON media, authentication, and CI drift workflow.
+
 ### Schema introspection
 
 Contracts expose their schemas for runtime introspection:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beignet/core",
-  "version": "0.0.45",
+  "version": "0.0.46",
   "type": "module",
   "description": "Core framework primitives for Beignet",
   "exports": {
@@ -215,6 +215,8 @@
   "devDependencies": {
     "@types/bun": "^1.3.13",
     "@types/node": "^20.10.0",
+    "openapi-fetch": "^0.17.0",
+    "openapi-typescript": "^7.13.0",
     "typescript": "^5.3.0",
     "zod": "^4.0.0"
   }