@crvouga/mockingbird-service-clerk 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog — @crvouga/mockingbird-service-clerk
 
-## 0.1.0 (2026-10-11)
+## 0.2.0 (2026-10-12)
+
+### Features
+
+- unify the emulator control plane ([2068547](https://github.com/crvouga/mockingbird/commit/2068547bedde4e2e2331c1657c1a78120e84428b))
+
+### Dependencies
+
+- `@crvouga/mockingbird-service-sqlite`
+
+## 0.1.0 (2026-10-08)
 
 Initial release.

package/DISCOVERY.md

@@ -34,6 +34,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`
@@ -44,6 +45,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

@@ -13,11 +13,29 @@ npm install @crvouga/mockingbird-service-clerk
 ## Usage
 
 ```ts
-import { createRuntime } from "@crvouga/mockingbird-service-clerk"
-const runtime = createRuntime({ seed: 1 })
-const response = await runtime.fetch(new Request("https://api.clerk.com"))
+import { createServer } from "@crvouga/mockingbird-service-clerk/server"
+
+const server = await createServer({ seed: 1 })
+
+// The app's Backend API calls, with the emulator's URL in place of https://api.clerk.com.
+const headers = { authorization: "Bearer sk_test_fixture", "content-type": "application/json" }
+const created = await fetch(`${server.url}/v1/users`, {
+  method: "POST",
+  headers,
+  body: JSON.stringify({ email_address: ["ada@example.com"], first_name: "Ada" }),
+})
+const user = (await created.json()) as { id: string; first_name: string }
+const listed = await fetch(`${server.url}/v1/users?email_address=ada@example.com`, { headers })
+const { data } = (await listed.json()) as { data: { id: string }[] }
+console.log(data[0]?.id === user.id) // true
+await server.close()
 ```
 
+The example uses plain `fetch` because `@clerk/backend` only parses a response whose
+`content-type` is exactly `application/json`, and the emulator answers
+`application/json; charset=UTF-8`. With `createClerkClient({ secretKey, apiUrl: server.url })` the
+requests succeed but resources come back as unparsed JSON strings.
+
 ## API
 
 - `ClerkAPI`: portable provider instance; accepts SQLite, namespace, clock, fixtures and baseUrl.