Add createWSApi - WebSocket API definition layer#220
Merged
Conversation
Assign all 10 assertions to branch feature/create-ws-api with dependency tree: - ws-client-like-type (root, no deps) - create-ws-api-function (depends-on: ws-client-like-type) - 8 leaf assertions (all depend-on: create-ws-api-function, parallelizable)
Add WSClientLike type to src/api/types.ts defining the minimal transport-agnostic WebSocket client interface (send, on, off). Export from src/api/index.ts and src/index.ts. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Implement createWSApi in src/api/create-ws-api.ts with full TypeScript inference from Zod shapes. Returns typed send/on/off methods, supports send-only and receive-only APIs, empty payloads, snake_case conversion on send, and camelCase conversion on receive with parseResponse validation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
WSClientLiketype defining the minimal transport-agnostic WebSocket client interface (send,on,off)src/api/types.ts,src/api/index.ts, andsrc/index.tscreateWSApifunction that mirrorscreateApifor event-driven APIsTest Plan
npm test— 140 passing)tsc --noEmit)spekk next)src/api/tests/ws-client-like.test.tsSpecs Addressed
Implementation Notes
WSClientLikeis intentionally minimal — no pings, pongs, reconnection, or heartbeatsAxiosLikepattern used for HTTP client abstraction increateApi