suaveplan/openspec/archive/2026-05-25-api-ws/tasks.md

Tasks — @suaveplan/api-ws

Every checkbox MUST reflect work actually done in this change.

0. Pre-flight (non-negotiable)

• 0.1 Confirm clean working tree (git status reports nothing) and no in-flight worktrees with uncommitted work (git worktree list then git status in each)
• 0.2 If any worktrees exist under .claude/worktrees/, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (git worktree remove) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
• 0.3 Confirm the package set in MANIFEST.md matches find packages -maxdepth 3 -name package.json count. Drift here means a prior change archived without regenerating the manifest.

1. Spec authoring

• 1.1 Read design doc §11.1 (lifecycle), §11.2 (bus), §11.3 (multi-host), §11.4 (backpressure/heartbeat), §11.5 (reconnect), §11.8 (worker tier)
• 1.2 Read openspec/specs/api-ws/spec.md (does not exist yet)
• 1.3 Read openspec/AGENTS.md Sections 13, 14
• 1.4 Draft proposal.md
• 1.5 Source-mapping table
• 1.6 Draft specs/api-ws/spec.md
• 1.7 **Verified by:** line on every requirement

2. Implementation

• 2.1 Scaffold packages/api/api-ws/ ("version": "0.1.0", "sideEffects": false, deps: @suaveplan/api-types, @suaveplan/error, @suaveplan/types, zod)
• 2.2 src/connection/ — WsConnection interface
• 2.3 src/connection-registry/ — ConnectionRegistry
• 2.4 src/subscription-bus/ — SubscriptionBus + cross-tenant gate
• 2.5 src/broker/ — WsBroker
• 2.6 src/envelope/ — Zod schema (always import z from "zod")
• 2.7 src/backpressure/ — BackpressurePolicy (constants + helper)
• 2.8 src/heartbeat/ — HeartbeatPolicy
• 2.9 src/reconnect-token/ — ReconnectToken shape + HMAC verify helper
• 2.10 src/capability-id/ — augmentation file adding "ws" + "ws.broadcast-cross-tenant"
• 2.11 src/error-codes/ — WS_CODES
• 2.12 src/testing/ — runWsEngineConformance(factory)
• 2.13 src/index.ts — explicit named re-exports
• 2.14 package.json exports per subpath

3. Tests

• 3.1 Unit tests per feature
• 3.2 Spec-conformance type tests
• 3.3 Property test on connection-registry multi-index lookup
• 3.4 Every it(...) carries { timeout: 5000 }

4. Documentation

• 4.1 Sibling .md for every implementation .ts
• 4.2 README.md linking every .md
• 4.3 No CLAUDE.md update

5. Pre-archive verification

• 5.1 bun run check — 0/0/0
• 5.2 bunx turbo lint typecheck test --filter=@suaveplan/api-ws — green
• 5.3 bunx turbo test:coverage --filter=@suaveplan/api-ws — 100/100/100/100
• 5.4 bun scripts/openspec-conformance.ts @suaveplan/api-ws — exit 0
• 5.5 bunx turbo build --filter=@suaveplan/api-ws — green

6. Pre-archive 7-row checklist

• 6.1 Generics on SubscriptionBus<Payload>; expectTypeOf on every literal-type claim
• 6.2 Zod wired at the envelope boundary
• 6.3 Every WS_CODES entry thrown
• 6.4 Backpressure / heartbeat strict-mode behaviors tested on / off
• 6.5 OTel — N/A (engines emit)
• 6.6 Lifecycle dedup — connection registration is idempotent; tested
• 6.7 No retroactive tick

7. Archive

• 7.1 Fold spec delta
• 7.2 Move to openspec/archive/<yyyy-mm-dd>-api-ws/
• 7.3 Tick umbrella 1.5
• 7.4 Refresh MANIFEST.md