How simoalanne/rest-rpc works
rest-rpc provides typed REST route contracts, server runtimes, Fetch clients, OpenAPI support, and a TanStack Query adapter. The principal workflow defines routes and handlers, builds a server app, matches and processes HTTP requests, then lets a typed client call the routes and receive typed responses. The graph also includes codecs, validation, errors, streaming, Node support, and query integration. Edges follow README statements or indexed source references; unsampled subsystems are included where documented, without inferring their internal calls.
Main entry points: dispatch.ts Request dispatch · createClient.ts Typed Fetch client · createApp.ts Fetch app · routeBuilder.ts Server implementation
Components 21
Route contracts
- Route builder
packages/core/src/contract/routeBuilder.ts - Route definitions
packages/core/src/contract/routeDefinition.ts - Schema validation
packages/core/src/standard-schema/standardSchemaValidator.ts - Route errors
packages/core/src/contract/routeError.ts
Server runtimes
- Server implementation
packages/server/src/builder/routeBuilder.ts - Middleware context
packages/server/src/builder/context.ts - Fetch app
packages/server/src/fetch/createApp.ts - Fetch handlers
packages/server/src/fetch/createRouteHandlers.ts - Node handlers
packages/server/src/node/createRouteHandlers.ts - Route matching
packages/server/src/routing/match.ts - Request dispatch
packages/server/src/pipeline/dispatch.ts - Response serialization
packages/server/src/pipeline/serializeHttpRouteResult.ts - Server-sent events
packages/server/src/pipeline/sse.ts
Client and codecs
- Typed Fetch client
packages/core/src/client/createClient.ts - Request encoding
packages/core/src/client/request.ts - Client responses
packages/core/src/client/response.ts - Body codecs
packages/core/src/codecs/registry.ts
API integrations
- OpenAPI generation
packages/core/src/openapi/document.ts - TanStack Query utils
packages/tanstack-query/src/createUtils.ts
Other components
- Application developer
- HTTP caller
Connections 24
- Application developer → Route builder: defines routes
README.md - Route builder → Route definitions: builds definitions
packages/core/src/contract/routeBuilder.ts - Application developer → Server implementation: implements handlers
README.md - Server implementation → Middleware context: uses context
packages/server/src/builder/routeBuilder.ts - Server implementation → Fetch app: configures app
README.md - Fetch app → Route matching: matches requests
packages/server/src/fetch/createApp.ts - Fetch app → Fetch handlers: creates handlers
packages/server/src/fetch/createApp.ts - Fetch handlers → Request dispatch: compiles routes
packages/server/src/fetch/createRouteHandlers.ts - Node handlers → Request dispatch: compiles routes
packages/server/src/node/createRouteHandlers.ts - Node handlers → Route matching: matches requests
packages/server/src/node/createRouteHandlers.ts - Route matching → Route definitions: enumerates routes
packages/server/src/routing/match.ts - Request dispatch → Schema validation: validates input
packages/server/src/pipeline/dispatch.ts - Request dispatch → Response serialization: serializes results
packages/server/src/pipeline/dispatch.ts - Request dispatch → Route errors: resolves errors
packages/server/src/pipeline/dispatch.ts - Request dispatch → Server-sent events: handles streams
packages/server/src/pipeline/dispatch.ts - Application developer → Typed Fetch client: creates client
README.md - Typed Fetch client → Route definitions: traverses routes
packages/core/src/client/createClient.ts - Typed Fetch client → Request encoding: builds requests
packages/core/src/client/createClient.ts - Typed Fetch client → Client responses: parses responses
packages/core/src/client/createClient.ts - Request encoding → Body codecs: encodes bodies
packages/core/src/client/request.ts - Typed Fetch client → HTTP caller: sends requests
README.md - HTTP caller → Fetch app: delivers request
README.md - Application developer → OpenAPI generation: generates API docs
README.md - Application developer → TanStack Query utils: uses query utilities
README.md