@crvouga/mockingbird-service-workos 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,14 +1,16 @@
 # Changelog — @crvouga/mockingbird-service-workos
 
-## 1.1.0 (2026-10-09)
+## 1.2.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))
+
+## 1.1.0 (2026-10-08)
 
-### Dependencies
+### Features
 
-- `@crvouga/mockingbird-service-sqlite`
+- match Emulate provider coverage ([16b65ce](https://github.com/crvouga/mockingbird/commit/16b65ce791fa216f28ec1521df636f57771d9c5e))
 
 ## 1.0.0 (2026-10-08)
 

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

@@ -14,14 +14,39 @@ bun add -d @crvouga/mockingbird-service-workos
 ## Usage
 
 ```ts
+import { WorkOS } from "@workos-inc/node"
 import { createServer } from "@crvouga/mockingbird-service-workos/server"
+
 const server = await createServer()
-// Set AuthKit WORKOS_API_HOSTNAME/WORKOS_API_PORT from server.url and WORKOS_API_HTTPS=false.
-// WORKOS_API_KEY=mock_workos_key, WORKOS_CLIENT_ID=client_mock.
-// Register your callback in the clients seed and use a local WORKOS_COOKIE_PASSWORD.
+const url = new URL(server.url)
+
+// The app's own WorkOS client. Only its API host changes.
+const workos = new WorkOS("mock_workos_key", {
+  clientId: "client_mock",
+  apiHostname: url.hostname,
+  port: Number(url.port),
+  https: false,
+})
+const authorizationUrl = workos.userManagement.getAuthorizationUrl({
+  provider: "authkit",
+  clientId: "client_mock",
+  redirectUri: "http://localhost:3000/callback",
+})
+
+// The test stands in for the browser: the emulator signs in the seeded user and redirects with a code.
+const redirect = await fetch(authorizationUrl, { redirect: "manual" })
+const code = new URL(redirect.headers.get("location") ?? "").searchParams.get("code") ?? ""
+
+const { user } = await workos.userManagement.authenticateWithCode({ code })
+const { data: users } = await workos.userManagement.listUsers({ email: user.email })
+console.log(users[0]?.id === user.id) // true
 await server.close()
 ```
 
+For AuthKit, set `WORKOS_API_HOSTNAME`/`WORKOS_API_PORT` from `server.url` and
+`WORKOS_API_HTTPS=false`, with `WORKOS_API_KEY=mock_workos_key` and `WORKOS_CLIENT_ID=client_mock`.
+Register your callback in the clients seed and use a local `WORKOS_COOKIE_PASSWORD`.
+
 `createRuntime().fetch(Request)` supports in-process adapters. Raw user mirrors should use
 the server URL in place of `https://api.workos.com`. The default registered callback is
 `http://localhost:3000/callback`; authorization immediately chooses the client's seeded user.