@crvouga/mockingbird-service-plane 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog — @crvouga/mockingbird-service-plane
 
+## 3.1.0 (2026-10-08)
+
+### Features
+
+- redesign emulator experience ([d6038c2](https://github.com/crvouga/mockingbird/commit/d6038c27eebbaa1751f02bc9305002a5b1304779))
+
+### Dependencies
+
+- `@crvouga/mockingbird-service-sqlite`
+
 ## 3.0.0 (2026-10-07)
 
 ### ⚠️ Breaking changes
@@ -14,10 +24,6 @@
 - typecheck the brand gate before builds ([fc36095](https://github.com/crvouga/mockingbird/commit/fc3609514de70ffe3170a5d216fb8a49f9ce7cbb))
 - format the emulates records query ([8698872](https://github.com/crvouga/mockingbird/commit/8698872509d06002be5a8fcdc85d79f8462320c3))
 
-### Dependencies
-
-- `@crvouga/mockingbird-service-sqlite`
-
 ## 2.3.0 (2026-10-04)
 
 ### Features

package/DISCOVERY.md

@@ -1,7 +1,7 @@
 # @crvouga/mockingbird-service-plane discovery
 
 This is the installed-package index for coding agents and tooling. All relative links resolve
-inside `node_modules/@crvouga/mockingbird-service-plane/`; no repository checkout is needed to discover the mock's
+inside `node_modules/@crvouga/mockingbird-service-plane/`; no repository checkout is needed to discover the emulator's
 supported surface or documented behavior.
 
 ## Capability and behavior sources
@@ -48,7 +48,7 @@ designed for assertions and diagnosis by consuming test suites.
 ## 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,
-operation/command, a minimal redacted request, actual mock result, expected oracle result or vendor
+operation/command, a minimal redacted request, actual emulator result, expected oracle result or vendor
 documentation, and whether the mismatch appears in the matrix. Never include keys, tokens,
 customer data, prompts, PHI, card data, or unredacted recordings.
 

package/README.md

@@ -1,8 +1,8 @@
 # @crvouga/mockingbird-service-plane
 
-> Familiar calls. Faithful echoes. Part of [Mockingbird](https://github.com/crvouga/mockingbird).
+> Local emulators. Real API contracts. Part of [Mockingbird](https://github.com/crvouga/mockingbird).
 
-Stateful mock of the **Plane** REST API (v1) for test suites, covering what our bug-report
+Stateful emulator of the **Plane** REST API (v1) for test suites, covering what our bug-report
 dedup and resolution jobs call on one project: work items (Plane's cursor-paginated list, get,
 create, patch), comments, links, states and labels, with Plane's rate limit and error shapes.
 Projects are provisioned on first use with Plane's default workflow (Backlog, Todo, In
@@ -25,7 +25,7 @@ any Fetch server.
 ## Usage
 
 The backend hardcodes `https://api.plane.so` (`plane-http-client.ts`, seam **G-Y1**: make it
-env-driven). Point it at the mock; `PLANE_ACCESS_TOKEN`, `PLANE_WORKSPACE_SLUG` and
+env-driven). Point it at the emulator; `PLANE_ACCESS_TOKEN`, `PLANE_WORKSPACE_SLUG` and
 `PLANE_BUGS_PROJECT_ID` can be any values (the project id must be a UUID, as our config
 validates).
 
@@ -82,7 +82,7 @@ patch. GET returns both `type_id` and `type`, as Plane's
 does. Unknown IDs fail with a DRF `type_id` error before any field or sequence number changes.
 Creation inherits a seeded default type; an explicit patch `type_id: null` clears it.
 
-Cycle dates use UTC project days and the mock clock, following Plane's
+Cycle dates use UTC project days and the emulator clock, following Plane's
 [cycle endpoint](https://github.com/makeplane/plane/blob/c7a5afee6afd15f16038ebda1ec1489ebd8af67d/apps/api/plane/api/views/cycle.py)
 and [date converter](https://github.com/makeplane/plane/blob/c7a5afee6afd15f16038ebda1ec1489ebd8af67d/apps/api/plane/utils/timezone_converter.py):
 future/past starts are 00:00:01, today's start is the creation time, and ends are 23:59:00.
@@ -101,7 +101,7 @@ throttled. Expected available in N seconds."}` with `x-ratelimit-*` headers.
 | `GET /__admin/work-items` | The namespace's work items. |
 | `POST /__admin/projects` | `{workspace, project}`: provision a project now; answers its states and labels. |
 | `POST /__admin/work-item-types` | `{workspace, project, types: [{name, description?, is_default?}]}`: seed project type metadata with stable IDs; repeat calls update metadata and preserve creation time. Types start empty. Invalid batches do not partially write. |
-| `GET/PUT /__admin/settings` | `{apiKeys?, rateLimitPerMinute?: number \| null, projects?: ["<slug>/<uuid>"]}`. `rateLimitPerMinute: 60` reproduces Plane's limit on the mock clock; `projects` pins which projects exist (others 404). |
+| `GET/PUT /__admin/settings` | `{apiKeys?, rateLimitPerMinute?: number \| null, projects?: ["<slug>/<uuid>"]}`. `rateLimitPerMinute: 60` reproduces Plane's limit on the emulator clock; `projects` pins which projects exist (others 404). |
 
 Fault presets (`POST /__admin/faults {"preset": "<name>", "count"?: n}`): `rate_limited` (429),
 `server_error` (500), `bad_gateway` (502 HTML), `unauthorized` (401), `invalid_json` (200
@@ -127,13 +127,13 @@ never retried.
 
 | Export | Kind | Description |
 | --- | --- | --- |
-| `PlaneAPI` | class | The in-process mock: `fetch(request)`, `reset()`, `ensureProject(slug, id)`, `statesOf(id)`, `labelsOf(id)`, `moveToState(itemId, stateIdOrName)`, `applyPatch(item, patch)`, `workItems()`. Options: `sqlite`, `now`, `namespace`, `settings`. |
-| `createRuntime` | function | The mock with the full service contract (health, admin, namespaces, credentials, presets). Options: `settings`, `clock`, `seed`, `adminKey`, `onLog`, `sqlite`. |
+| `PlaneAPI` | class | The in-process emulator: `fetch(request)`, `reset()`, `ensureProject(slug, id)`, `statesOf(id)`, `labelsOf(id)`, `moveToState(itemId, stateIdOrName)`, `applyPatch(item, patch)`, `workItems()`. Options: `sqlite`, `now`, `namespace`, `settings`. |
+| `createRuntime` | function | The emulator with the full service contract (health, admin, namespaces, credentials, presets). Options: `settings`, `clock`, `seed`, `adminKey`, `onLog`, `sqlite`. |
 | `PLANE_PRESETS` | object | Every named fault preset. |
 | `PLANE_NAMESPACE` | string | The service name, `"plane"`. |
 | `DEFAULT_STATES` | array | The workflow a new project starts with. |
 | `apiKeyCredential` | function | The `X-API-Key` a request carries (how credentials map to namespaces). |
-| `uuidFrom` | function | The deterministic v4-shaped UUID the mock derives from a string. |
+| `uuidFrom` | function | The deterministic v4-shaped UUID the emulator derives from a string. |
 | `document`, `operationIds`, `supportedOperationIds` | values | The OpenAPI contract and its operation ids. |
 | `createServer`, `serveTarget`, `DEFAULT_PORT` (`./server`) | Node | Serve over `node:http`; the `serve` CLI target (`--api-key`, `--rate-limit`); port 8821. |
 

package/SUPPORT.md

@@ -3,10 +3,10 @@
 Generated from `openapi.yaml`; do not edit by hand.
 
 - operations in spec: **16**
-- supported by the mock: **16**
+- supported by the emulator: **16**
 - parity enabled: **16**
 
-| operationId | route | mock | parity | notes |
+| operationId | route | emulator | parity | notes |
 | --- | --- | --- | --- | --- |
 | `ListWorkItems` | `GET /api/v1/workspaces/{slug}/projects/{project_id}/work-items/` | ✅ supported | ✅ |  |
 | `CreateWorkItem` | `POST /api/v1/workspaces/{slug}/projects/{project_id}/work-items/` | ✅ supported | ⚠️ unsafe (opt-in) |  |