@rest-rpc/next 0.1.0-beta.7 → 0.1.0-beta.9

package/README.md

@@ -2,44 +2,80 @@
 
 REST-shaped APIs with function-shaped TypeScript.
 
-`rest-rpc` lets you define HTTP routes in a shared TypeScript contract, then use
-that contract to derive typed server handlers, typed fetch clients, TanStack Query
-options, and OpenAPI documents.
+Define your HTTP API once as a shared TypeScript contract, then derive typed
+server handlers, fetch clients, openAPI documents, and more from it.
 
-The API stays REST-shaped. Everyday application code can feel like function
-calls.
+## Features
+
+- Shared TypeScript contracts for HTTP APIs.
+- Typed server handlers for Express, Hono, Fastify, Next.js, and Fetch runtimes.
+- Typed fetch client.
+- Typed TanStack Query helpers.
+- Typed WebSockets, streaming, non-JSON requests/responses.
+- OpenAPI documents generated from the TypeScript contract.
+- Standard Schema support.
+
+## Minimal Example
+
+Define a contract
 
 ```ts
-const todo = await api.todos.get.fetch({ id: "todo_1" });
+import { router } from "@rest-rpc/core";
+import { z } from "zod";
+
+export const api = router({
+	todos: {
+		get: {
+			method: "GET",
+			path: "/todos/:id",
+			response: z.object({
+				id: z.string(),
+				title: z.string(),
+			}),
+		},
+	},
+});
 ```
 
-That call is still a normal HTTP request:
+Implement the contract on the server
 
-```http
-GET /todos/todo_1
-```
+```ts
+const routes = router(api, {
+	todos: {
+		get({ id }) {
+			return getTodo(id);
+		},
+	},
+});
 
-## Packages
+registerRoutes(app, routes);
+```
 
-- `@rest-rpc/core`: contracts, fetch client, OpenAPI generation, core helpers.
-- `@rest-rpc/express`: Express server adapter.
-- `@rest-rpc/hono`: Hono server adapter.
-- `@rest-rpc/fastify`: Fastify server adapter.
-- `@rest-rpc/web`: Web `Request`/`Response` HTTP handler adapter.
-- `@rest-rpc/next`: Next.js server adapter.
-- `@rest-rpc/tanstack-query`: TanStack Query options and key helpers.
+use the contract on the client with RPC-style function calls
 
-`@rest-rpc/server` contains shared adapter infrastructure and is mainly useful
-for adapter authors.
+```ts
+import { initClient } from "@rest-rpc/core";
+import { api } from "./contract";
 
-## Design
+const client = initClient(api, {
+	baseUrl: "https://api.example.com",
+});
 
-- REST routes remain explicit in the contract.
-- Handler and client calls use flattened request input.
-- Responses are keyed by HTTP status.
-- Server adapters are thin integrations with existing frameworks.
-- Schema libraries, OpenAPI UI, middleware, auth, and app structure stay your choice.
+const todo = await client.todos.get.fetch({
+	id: "todo_1",
+});
+```
 
 ## Documentation
 
-[rest-rpc.dev](https://rest-rpc.dev)
+Full documentation is available at [rest-rpc.dev](https://rest-rpc.dev)
+
+## Packages
+
+- [`@rest-rpc/core`](https://npmx.dev/package/@rest-rpc/core): API contract, client and openAPI generation.
+- [`@rest-rpc/express`](https://npmx.dev/package/@rest-rpc/express): Express server adapter.
+- [`@rest-rpc/fastify`](https://npmx.dev/package/@rest-rpc/fastify): Fastify server adapter.
+- [`@rest-rpc/hono`](https://npmx.dev/package/@rest-rpc/hono): Hono server adapter.
+- [`@rest-rpc/next`](https://npmx.dev/package/@rest-rpc/next): Next.js adapter.
+- [`@rest-rpc/web`](https://npmx.dev/package/@rest-rpc/web): Fetch runtime adapter
+- [`@rest-rpc/tanstack-query`](https://npmx.dev/package/@rest-rpc/tanstack-query): TanStack Query adapter.

package/dist/server.d.ts

@@ -1,5 +1,5 @@
 import type { HttpMethod, HttpRouteDeclaration, RequestBodySchema } from "@rest-rpc/core/contract";
-import { type CreateWebHandlerOptions, type RouteHandler as WebRouteHandler, type WebRouteParseBodyInput, type RouteRequest as WebRouteRequest, type RouteResponse as WebRouteResponse } from "@rest-rpc/web";
+import { type CreateWebHandlerOptions, type RouteHandler as WebRouteHandler, type WebRouteParseBodyInput, type RouteRequest as WebRouteRequest, type RouteResponse as WebRouteResponse, type WebRouteRuntimeContext } from "@rest-rpc/web";
 type WebContract = HttpRouteDeclaration | {
     [key: string]: WebContract;
 };
@@ -13,16 +13,17 @@ type RouteHandlerMap<E extends HttpRouteDeclaration> = {
 type RouterHandlerMap = {
     [K in HttpMethod]: WebRequestHandler;
 };
-export type NextRouteHandlerContext = {
+type NextRouteAdapterContext = {
     request: Request;
 };
-export type RouteRequest<E extends HttpRouteDeclaration> = WebRouteRequest<E, NextRouteHandlerContext>;
+export type NextRouteHandlerContext = WebRouteRuntimeContext<NextRouteAdapterContext>;
+export type RouteRequest<E extends HttpRouteDeclaration> = WebRouteRequest<E, NextRouteAdapterContext>;
 export type RouteResponse<E extends HttpRouteDeclaration> = WebRouteResponse<E>;
 export type RouteHandler<E extends HttpRouteDeclaration> = WebRouteHandler<E, NextRouteHandlerContext>;
 export type NextRouteParseBodyInput = WebRouteParseBodyInput;
 export type NextRouteParseBody = (input: NextRouteParseBodyInput) => unknown | Promise<unknown>;
 export type CreateRouteHandlerOptions = {
-    errorHandlers?: CreateWebHandlerOptions<NextRouteHandlerContext>["errorHandlers"];
+    errorHandlers?: CreateWebHandlerOptions<NextRouteAdapterContext>["errorHandlers"];
     parseBody?: NextRouteParseBody;
 };
 export declare function createRouteHandler<E extends HttpRouteDeclaration>(route: E, handler: RouteHandler<E>, options?: CreateRouteHandlerOptions): RouteHandlerMap<E>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rest-rpc/next",
-  "version": "0.1.0-beta.7",
+  "version": "0.1.0-beta.9",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -19,8 +19,8 @@
     "dist"
   ],
   "dependencies": {
-    "@rest-rpc/core": "^0.1.0-beta.7",
-    "@rest-rpc/web": "^0.1.0-beta.7"
+    "@rest-rpc/core": "^0.1.0-beta.9",
+    "@rest-rpc/web": "^0.1.0-beta.9"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",