@openwop/openwop-conformance 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 David Tufts and openwop contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing permissions
+   and limitations under the License.

package/README.md

@@ -0,0 +1,241 @@
+# `@openwop/openwop-conformance` — Conformance Suite for the Multi-Agent Workflow Orchestration Protocol
+
+**openwop is an open, wire-level protocol for multi-agent workflow orchestration** — a single contract for runs in which LLM agents, deterministic tools, sub-workflows, and human reviewers collaborate, with durable suspend / resume, replay, version negotiation, and observability owned by the protocol itself. This package is the black-box conformance suite: point it at any OpenWOP-compliant server (your own or a third party's) and it issues real HTTP requests against the spec'd endpoints and asserts that responses match.
+
+```bash
+npm install @openwop/openwop-conformance
+# or run without install:
+npx @openwop/openwop-conformance --base-url https://api.example.com --api-key hk_test_...
+```
+
+> **Spec:** [github.com/openwop/openwop](https://github.com/openwop/openwop) · See `CHANGELOG.md` below for release history.
+
+The suite is intentionally self-contained — it does NOT depend on the reference implementation. A spec-compliant server written in any language can run this suite against itself by spinning up its server, exporting the env vars, and running `npx vitest run`.
+
+> **Status:** Tracks the FINAL v1 protocol contract. The suite version evolves independently as new scenarios ship (vendor-neutral redaction, cost attribution, post-v1 ecosystem triggers); see [`CHANGELOG.md`](./CHANGELOG.md) for the current release.
+
+---
+
+## Quickstart
+
+Two ways to run: the friendly `openwop-conformance` CLI (recommended for
+operators) or `vitest` directly (recommended for CI).
+
+### CLI
+
+```bash
+cd conformance
+npm install
+
+# Build the CLI binary
+npm run build:cli
+
+# Server-free subset (no deployment target needed)
+./dist/cli.js --offline
+
+# Full suite against a deployed server
+./dist/cli.js \
+  --base-url https://api.example.com \
+  --api-key hk_test_abc123 \
+  --impl acme-openwop-server --impl-version 1.0
+
+# Filter by test-name pattern
+./dist/cli.js --base-url ... --api-key ... --filter "discovery|errors"
+```
+
+`./dist/cli.js --help` for the full flag reference. Env vars
+(`OPENWOP_BASE_URL`, `OPENWOP_API_KEY`, `OPENWOP_IMPLEMENTATION_*`) override CLI
+flags only when the flag is unset.
+
+### Direct vitest
+
+```bash
+cd conformance
+npm install
+
+export OPENWOP_BASE_URL="https://api.example.com"
+export OPENWOP_API_KEY="hk_test_..."
+
+npx vitest run                                 # full suite
+npx vitest run src/scenarios/discovery.test.ts # single file
+```
+
+Exit code is non-zero on any failed assertion.
+
+---
+
+## What's Covered
+
+The current suite has 85 scenario files under `src/scenarios/`. This includes 18 Multi-Agent Shift scenarios (Phases 1-5) added 2026-05-10. The maintained scenario-to-spec map lives in [`coverage.md`](./coverage.md); this README keeps the operator quickstart and the historical scenario notes below.
+
+High-level coverage includes:
+
+- Server-free corpus checks for fixtures, JSON Schema, OpenAPI, AsyncAPI, and prose status metadata.
+- Server-required checks for discovery, auth, error envelopes, run lifecycle, idempotency, cancellation, interrupts, streaming, replay/fork, version negotiation, storage failover, redaction, cost attribution, node-pack registry behavior, and optional profile derivation.
+- Fixture-gated checks that skip cleanly unless the host advertises the corresponding fixture IDs.
+
+## Historical Coverage Notes
+
+Server-free (run anywhere, including CI without a deployment target):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Fixtures** | [`fixtures.md`](./fixtures.md) | Every fixture JSON in `fixtures/*.json` validates against `../schemas/workflow-definition.schema.json`; `id` matches filename; manual trigger present. (12 assertions) |
+| **Spec corpus** | the whole `` tree | JSON Schemas compile under Ajv2020; OpenAPI 3.1 + AsyncAPI 3.1 YAMLs structurally valid + their `$ref`s resolve; every prose `.md` carries a `Status:` legend tag; `fixtures.md` ↔ `fixtures/*.json` round-trip is consistent. (24 assertions) |
+
+Server-required (requires `OPENWOP_BASE_URL` + `OPENWOP_API_KEY` + seeded fixtures):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Discovery** | [`capabilities.md`](../spec/v1/capabilities.md) | `/.well-known/openwop` returns valid Capabilities shape with required fields; `Cache-Control` present; non-zero limits. |
+| **Discovery** | [`rest-endpoints.md`](../spec/v1/rest-endpoints.md) | `/v1/openapi.json` returns a parseable OpenAPI 3.1 document. |
+| **Auth** | [`auth.md`](../spec/v1/auth.md) | Missing/invalid API key returns `401` with canonical error envelope. |
+| **Errors** | [`rest-endpoints.md`](../spec/v1/rest-endpoints.md) | All error responses share the `{error, message, details?}` envelope. |
+| **Run lifecycle** | [`rest-endpoints.md`](../spec/v1/rest-endpoints.md) + [`fixtures.md`](./fixtures.md) | `POST /v1/runs` with `conformance-noop` fixture reaches terminal `completed` within bounded time. |
+| **Idempotency** | [`idempotency.md`](../spec/v1/idempotency.md) | Same `Idempotency-Key` + same body replays (carries `openwop-Idempotent-Replay` header, returns same runId); same key + different body returns 409. |
+| **Cancellation** | [`rest-endpoints.md`](../spec/v1/rest-endpoints.md) | `POST /v1/runs/{runId}/cancel` mid-flight on `conformance-cancellable` reaches terminal `cancelled` within 5s. |
+| **HITL approval** | [`interrupt.md`](../spec/v1/interrupt.md) | `conformance-approval` suspends at `waiting-approval`; `{action: 'accept'}` resolve drives terminal `completed`. Invalid action and unknown nodeId return 400/422 and 404. |
+| **HITL clarification** | [`interrupt.md`](../spec/v1/interrupt.md) | `conformance-clarification` suspends at `waiting-input`; `{answers: {q1: ...}}` resolve drives terminal `completed`. |
+| **Failure path** | [`rest-endpoints.md`](../spec/v1/rest-endpoints.md) | `conformance-failure` reaches terminal `failed`; `RunSnapshot.error` is `{code: string, message: string}`. |
+| **Identity passthrough** | [`fixtures.md`](./fixtures.md) | `conformance-identity` deep-equals nested JSON input through `inputs.payload` → `variables.payload`. |
+| **Multi-node ordering** | [`fixtures.md`](./fixtures.md) | `conformance-multi-node` emits `node.completed` events for nodeIds a, b, c in topological order via `event.sequence`. Exercises `GET /v1/runs/{runId}/events/poll`. |
+| **Stream modes** | [`stream-modes.md`](../spec/v1/stream-modes.md) | `updates` mode emits `run.started` + `run.completed` and the server closes on terminal; unsupported `streamMode` returns 400 with `supported` array; `debug` mode event count ≥ `updates` mode. Uses `conformance-delay` and a hand-rolled SSE client. |
+| **Replay / fork** | [`replay.md`](../spec/v1/replay.md) | `POST /v1/runs/{runId}:fork` from a finished `conformance-noop` run reaches terminal `completed` in both `replay` and `branch` modes. Validation: negative `fromSeq` → 400; `fromSeq` past source log → 422; `replay` + non-empty overlay → 400; fork on unknown run → 404. |
+| **Version negotiation** | [`version-negotiation.md`](../spec/v1/version-negotiation.md) + [`run-event.schema.json`](../schemas/run-event.schema.json) | `Capabilities.protocolVersion` advertised; every persisted event carries the 6 required `RunEventDoc` fields (`eventId`, `runId`, `type`, `payload`, `timestamp`, `sequence`); per-run sequence is strictly monotonic; `events/poll?lastSequence=` past end returns 200+empty (not 4xx). Cross-version compat scenarios deferred — need server-controllable `engineVersion` releases. |
+
+Server-required (added in 1):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Cap breach (recursion limit)** | [`run-options.md`](../spec/v1/run-options.md) §recursionLimit + [`observability.md`](../spec/v1/observability.md) §cap.breached | `conformance-cap-breach` with `configurable.recursionLimit: 3`: terminal `failed` with `error.code = "recursion_limit_exceeded"`; `cap.breached {kind: "node-executions", limit, observed, nodeId}` payload; cap.breached precedes run.failed in sequence; exactly `limit` `node.started` events emitted (over-limit node MUST NOT receive node.started). |
+
+Server-required (added in 1.2.0):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Sub-workflow dispatch** | [`node-packs.md`](../spec/v1/node-packs.md) §Reserved Core openwop typeIds + [`fixtures.md`](./fixtures.md) §F2 | `conformance-subworkflow-parent` invokes `conformance-subworkflow-child` via `core.subWorkflow` with blocking dispatch + outputMapping. Asserts: parent reaches terminal `completed`; child variable propagates via outputMapping (`childOutcome === "child-completed"`); child run snapshot carries `parentRunId` + `parentNodeId` linkage; child reaches terminal `completed`. |
+
+Server-required (added in 1.3.0):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Channel TTL** | [`channels-and-reducers.md`](../spec/v1/channels-and-reducers.md) §append + §TTL | `conformance-channel-ttl` writes 3 entries with `ttlMs: 200`, waits 300ms via `core.delay`, writes a 4th. Asserts: final `variables.events.length === 1`; surviving entry value `"d"`; entry carries numeric `_ts`. Validates the write-time TTL filter drops priors. |
+
+Server-required (added in 1.4.0):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **SSE buffering** | [`stream-modes.md`](../spec/v1/stream-modes.md) §Aggregation hint | `?bufferMs=` query parameter. Reuses `conformance-delay` fixture. Asserts: server accepts in-range value (0..5000) and emits `event: batch` SSE frames with array data; out-of-range `99999` returns 400 `validation_error`; force-flush on terminal events (run.completed bundled BEFORE the timer would fire); `bufferMs=0` behaves identically to omitting (per-event mode). |
+
+Server-required (added in 1.5.0):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **SSE mixed mode** | [`stream-modes.md`](../spec/v1/stream-modes.md) §Mixed mode | Comma-separated `?streamMode=` query. Reuses `conformance-delay` fixture. Asserts: server accepts `updates,messages` and emits server-closed stream containing run.completed; `values,updates` returns 400 `unsupported_stream_mode` (values is exclusive); `updates,bogus` returns 400 (partial-unknown lists fail wholesale); union semantics — `updates,debug` includes every event type `updates`-only includes. |
+
+Placeholder (added in 1.6.0, gated on observable-span access):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Cost attribution** | [`observability.md`](../spec/v1/observability.md) §Cost attribution attributes | 5 `it.todo()` scenarios documenting the contract for `openwop.cost.*` OTel attributes (allowlist of 6 — provider, model, tokens.input, tokens.output, usd, duration_ms; redaction enforcement). Runs when a deployed reference exposes OTel spans or surfaces cost via the run snapshot. Runtime side + redaction unit tests are shipped. |
+
+Server-required (added in 1.7.0):
+
+| Category | Spec doc | Coverage |
+|---|---|---|
+| **Redaction** | [`capabilities.md`](../spec/v1/capabilities.md) §"Secrets" + NFR-7 + §"aiProviders" | Vendor-neutral assertions that the server doesn't leak secret material. Three scenario groups: (a) discovery shape contract — `secrets` + `aiProviders` advertisements are well-formed regardless of `secrets.supported`; when `supported === true`, scopes MUST be non-empty + `resolution === 'host-managed'`; `byok ⊆ supported`. (b) bearer-token redaction — invalid Bearer canary in `Authorization` header is not echoed in the 401 response body. (c) credentialRef echo control — gated on `secrets.supported === true`; canary planted in `configurable.ai.credentialRef` MUST NOT appear in any RunEvent payload (poll-based capture; transport-agnostic). Uses runtime-built canary fixtures (`lib/canaries.ts`) that defeat static secret scanners. 6 scenarios. |
+
+Current source tree: 85 scenario files. Use [`coverage.md`](./coverage.md) for current grade/gap tracking.
+
+## Remaining Gaps
+
+| Gap | Why it remains |
+|---|---|
+| `values` mode `state.snapshot` payload | Schema is implementation-shaped per spec gap S1 (`stream-modes.md`); cross-impl assertions blocked until schema firms up. |
+| `messages` mode AI chunks | Needs server-side AI provider mock (fixture spec gap F1 in `fixtures.md`). |
+| Cross-version compat | Needs server-controllable `engineVersion` cycle to test forward-fold-best-effort. |
+| Capability-limit fixtures | Needs fixtures that deliberately exceed `clarificationRounds` / `schemaRounds` / `envelopesPerTurn` to assert `cap.breached` shape beyond the shipped node-execution cap case. |
+| Auth profiles | Needs API-key rotation, OAuth2 client-credentials, and mTLS scenarios for hosts that claim those profiles. |
+| Interrupt profiles | Needs quorum approval, auth-required resume, external-event correlation, and parent/child cancel cascade scenarios. |
+| Production profile | Needs backpressure envelope, restart durability, retention, and debug-bundle truncation scenarios. |
+
+---
+
+## Repo layout
+
+```
+conformance/
+  README.md                    — this file
+  fixtures.md                  — standardized fixture-workflow contract
+  fixtures/                    — canonical WorkflowDefinition JSONs (servers seed verbatim)
+    conformance-noop.json
+    conformance-identity.json
+    conformance-delay.json
+    conformance-failure.json
+    conformance-approval.json
+    conformance-clarification.json
+    conformance-multi-node.json
+    conformance-idempotent.json
+    conformance-cancellable.json
+  package.json                 — @openwop/openwop-conformance package manifest
+  vitest.config.ts             — test runner config
+  tsconfig.json                — strict TypeScript
+  src/
+    lib/
+      driver.ts                — OpenWOP driver class (auth, request helpers, response asserts)
+      env.ts                   — env-var validation + defaults
+      polling.ts               — pollUntil/pollUntilStatus/pollUntilTerminal helpers
+      sse.ts                   — minimal native-fetch SSE client (no eventsource dep)
+    scenarios/
+      fixtures-valid.test.ts            — fixture JSONs validate against workflow-definition schema (no server)
+      discovery.test.ts                 — /.well-known/openwop + /v1/openapi.json
+      auth.test.ts                      — 401 / 403 envelopes
+      errors.test.ts                    — error envelope shape
+      runs-lifecycle.test.ts            — POST /v1/runs + terminal status (uses conformance-noop)
+      idempotency.test.ts               — same key replay + body-mismatch 409 (uses conformance-idempotent)
+      cancellation.test.ts              — :cancel mid-flight (uses conformance-cancellable)
+      interrupt-approval.test.ts        — accept/reject + invalid action + unknown node (uses conformance-approval)
+      interrupt-clarification.test.ts   — answers payload resume (uses conformance-clarification)
+      failure-path.test.ts              — terminal `failed` + RunSnapshot.error shape (uses conformance-failure)
+      identity-passthrough.test.ts      — nested JSON round-trip (uses conformance-identity)
+      multi-node-ordering.test.ts       — node.completed sequence in DAG order (uses conformance-multi-node + events/poll)
+      stream-modes.test.ts              — updates termination + 400 unsupported-mode + debug ⊇ updates (uses conformance-delay + SSE)
+      replay-fork.test.ts               — :fork in replay + branch modes + 4 validation paths (uses conformance-noop)
+      version-negotiation.test.ts       — protocolVersion + RunEventDoc shape + monotonic sequence + events/poll forward-compat
+      spec-corpus-validity.test.ts      — server-free meta-check that the whole spec corpus is internally consistent
+```
+
+---
+
+## How to extend
+
+Add a new scenario file under `src/scenarios/<category>.test.ts`:
+
+```typescript
+import { describe, it, expect } from 'vitest';
+import { driver } from '../lib/driver';
+
+describe('my-spec-category', () => {
+  it('does the thing per spec section 4.2', async () => {
+    const res = await driver.get('/v1/some-endpoint');
+    expect(res.status).toBe(200);
+    // ... spec-derived assertions
+  });
+});
+```
+
+Each `expect(...)` should have a corresponding spec quote in the assertion message so failures cite the requirement, not just "expected X got Y".
+
+---
+
+## Future: publishable npm package
+
+Once the suite stabilizes, this directory will be extracted to its own repo and published as `@openwop/openwop-conformance`. Until then, `npm install` is run from this subdirectory only — it is intentionally NOT a workspace member of the parent monorepo so its deps don't pollute the impl's lockfile.
+
+## References
+
+
+- Spec corpus: `../README.md`
+- OpenAPI: `../api/openapi.yaml`
+- AsyncAPI: `../api/asyncapi.yaml`
+- JSON Schemas: `../schemas/`