@crvouga/mockingbird-service-openai 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,15 +1,21 @@
 # Changelog — @crvouga/mockingbird-service-openai
 
-## 1.2.0 (2026-10-09)
+## 1.3.0 (2026-10-12)
 
 ### Features
 
-- match Emulate provider coverage ([16b65ce](https://github.com/crvouga/mockingbird/commit/16b65ce791fa216f28ec1521df636f57771d9c5e))
+- unify the emulator control plane ([2068547](https://github.com/crvouga/mockingbird/commit/2068547bedde4e2e2331c1657c1a78120e84428b))
 
 ### Dependencies
 
 - `@crvouga/mockingbird-service-sqlite`
 
+## 1.2.0 (2026-10-08)
+
+### Features
+
+- match Emulate provider coverage ([16b65ce](https://github.com/crvouga/mockingbird/commit/16b65ce791fa216f28ec1521df636f57771d9c5e))
+
 ## 1.1.0 (2026-10-08)
 
 ### Features

package/DISCOVERY.md

@@ -35,6 +35,7 @@ repository; live parity is an additional oracle check, not a substitute for the
 
 - `GET /__admin/health`
 - `GET /__admin`
+- `GET /__admin/controls`
 - `GET /__admin/state`
 - `GET /__admin/requests`
 - `GET /__admin/metrics`
@@ -45,6 +46,28 @@ For HTTP services, use `x-mockingbird-namespace` (or the documented credential/p
 parallel tests do not share state. Admin state, journal, metrics and fault-preset endpoints are
 designed for assertions and diagnosis by consuming test suites.
 
+## Admin controls
+
+Every HTTP emulator takes the same controls, and each means the same thing at boot
+(`createRuntime({ adminControls })`, `serve --admin-controls`), over `/__admin`, and in a request header:
+
+| Control | Admin API | Request header | Interface |
+| --- | --- | --- | --- |
+| Isolate state by key | `GET /__admin/namespaces` | `x-mockingbird-namespace: <key>` | [Namespaces](https://mockingbird.chrisvouga.dev/docs/admin-controls/namespaces) |
+| Reset to boot | `POST /__admin/reset` | `x-mockingbird-reset: true` | [Reset](https://mockingbird.chrisvouga.dev/docs/admin-controls/reset) |
+| Snapshot and restore | `POST /__admin/snapshots`, `POST /__admin/snapshots/<id>/restore` | `x-mockingbird-snapshot: <name>`, `x-mockingbird-restore: <name>` | [Snapshot and restore](https://mockingbird.chrisvouga.dev/docs/admin-controls/snapshot-and-restore) |
+| Move the clock | `POST /__admin/clock` | `x-mockingbird-time: <instant>`, `x-mockingbird-advance: <duration>` | [Clock](https://mockingbird.chrisvouga.dev/docs/admin-controls/clock) |
+| Read or branch from old state | `GET /__admin/timeline` | `x-mockingbird-at: <checkpoint>`, `x-mockingbird-branch: <name>` | [Checkpoints and branches](https://mockingbird.chrisvouga.dev/docs/admin-controls/checkpoints-and-branches) |
+| Inject a fault | `POST /__admin/faults` | `x-mockingbird-fault: <fault>` | [Faults](https://mockingbird.chrisvouga.dev/docs/admin-controls/faults) |
+| Latency and timeouts | `PUT /__admin/latency` | `x-mockingbird-delay: <duration>`, `x-mockingbird-timeout: <duration>` | [Latency and timeouts](https://mockingbird.chrisvouga.dev/docs/admin-controls/latency-and-timeouts) |
+| Replay from a seed | `PUT /__admin/controls` | `x-mockingbird-seed: <seed>` | [Seed and determinism](https://mockingbird.chrisvouga.dev/docs/admin-controls/seed-and-determinism) |
+| See what happened | `GET /__admin/requests`, `GET /__admin/state` | | [Journal, metrics and state](https://mockingbird.chrisvouga.dev/docs/admin-controls/journal-and-state) |
+
+`GET /__admin` lists every route and header with a one-line summary, and `GET /__admin/controls`
+is the namespace's current control document. The same seed and the same requests give the same
+bytes. Setting controls as an emulator starts is [Boot](https://mockingbird.chrisvouga.dev/docs/admin-controls/boot); every route and header is in
+the [Reference](https://mockingbird.chrisvouga.dev/docs/admin-controls/reference). The full guide: <https://mockingbird.chrisvouga.dev/docs/admin-controls>.
+
 ## Report a mismatch or missing capability
 
 Follow the [agent reporting contract](https://github.com/crvouga/mockingbird/blob/main/docs/REPORTING_ISSUES.md). Include package version,

package/README.md

@@ -15,9 +15,13 @@ bun add @crvouga/mockingbird-service-openai
 
 ## Usage
 
+The examples use the official `openai@7.27.0` SDK.
+
 ```ts
+import OpenAI from "openai"
 import { createRuntime, DEFAULT_TOKEN } from "@crvouga/mockingbird-service-openai"
 
+// Test setup: the emulator, scripted with the reply the test expects.
 const emulator = createRuntime({
   scripts: [{
     kind: "chat",
@@ -25,18 +29,26 @@ const emulator = createRuntime({
     usage: { prompt_tokens: 12, completion_tokens: 3, cached_tokens: 8 },
   }],
 })
-const response = await emulator.fetch(new Request("http://emulator.local/v1/chat/completions", {
-  method: "POST",
-  headers: { authorization: `Bearer ${DEFAULT_TOKEN}`, "content-type": "application/json" },
-  body: JSON.stringify({ model: "fixture-chat", messages: [{ role: "user", content: "Fixture question" }] }),
-}))
-console.log(await response.json())
+
+// The app's own OpenAI client. Only its fetch changes: requests reach the
+// emulator in this process instead of api.openai.com.
+const openai = new OpenAI({
+  apiKey: DEFAULT_TOKEN,
+  fetch: (url: RequestInfo | URL, init?: RequestInit) => emulator.fetch(new Request(url, init)),
+})
+const completion = await openai.chat.completions.create({
+  model: "fixture-chat",
+  messages: [{ role: "user", content: "Fixture question" }],
+})
+console.log(completion.choices[0]?.message.content) // "Fixture answer"
+console.log(completion.usage?.total_tokens) // 15
 ```
 
-For this optional SDK example, also install `@ai-sdk/openai@4.0.83` and `ai@7.0.127`.
+For the Vercel AI SDK, also install `@ai-sdk/openai@4.0.83` and `ai@7.0.127`, and point the
+provider's `baseURL` at a listening server.
 Use the explicit `.chat()` provider: the provider's default model uses the Responses API.
 
-```js
+```ts
 import { createOpenAI } from "@ai-sdk/openai"
 import { generateText } from "ai"
 import { createServer } from "@crvouga/mockingbird-service-openai/server"