@rest-rpc/next 0.1.0-beta.12 → 0.1.0-beta.14

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export { type ClearCookieOptions, clearCookie, type RouteErrors, type RouteRequestData, RouteResponseError, type RouteResponseShorthand, type SetCookieOptions, setCookie, } from "@rest-rpc/web";
-export { type CreateRouteHandlerOptions, createRouteHandler, type NextRouteMiddleware, type RouteRequest, type RouteResponse, route, router, } from "./server.ts";
+export { type CreateRouteHandlerOptions, createRouteHandler, type NextRouteMiddleware, type RouteHandlers, type RouteRequest, type RouteResponse, route, router, } from "./server.ts";

package/dist/server.d.ts

@@ -1,16 +1,70 @@
 import type { HttpRouteDeclaration } from "@rest-rpc/core/contract";
-import { type CreateWebHandlerOptions, type WebContract, type WebImplementationTree, type WebRouteBuilder, type WebRouteMiddleware, type WebRouteParseBodyInput, type RouteRequest as WebRouteRequest, type RouteResponse as WebRouteResponse, type WebRouterBuilder } from "@rest-rpc/web";
+import { type CreateWebHandlerOptions, type WebContract, type WebImplementationTree, type WebRouteBuilder, type RouteHandlers as WebRouteHandlers, type WebRouteMiddleware, type WebRouteParseBodyInput, type RouteRequest as WebRouteRequest, type RouteResponse as WebRouteResponse, type WebRouterBuilder } from "@rest-rpc/web";
 import type { NextRequest } from "next/server.js";
+/**
+ * Middleware function shape for Next.js route handlers.
+ *
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#framework-context}
+ */
 export type NextRouteMiddleware<TContext extends Record<string, unknown>> = WebRouteMiddleware<Record<never, never>, TContext, NextRequest>;
+/**
+ * Infers the Next.js route handler request type for a route declaration.
+ *
+ * @see {@link https://rest-rpc.dev/docs/type-helpers#server}
+ */
 export type RouteRequest<E extends HttpRouteDeclaration, TContext extends Record<string, unknown> = Record<string, unknown>> = WebRouteRequest<E, TContext, NextRequest>;
+/**
+ * Infers the explicit response union for a Next.js HTTP route.
+ *
+ * @see {@link https://rest-rpc.dev/docs/type-helpers#server}
+ */
 export type RouteResponse<E extends HttpRouteDeclaration> = WebRouteResponse<E>;
+/**
+ * Handler tree accepted by `router().handlers()` when building a Next.js implementation tree.
+ *
+ * @remarks Use this type with `implements` to check class-based route handler
+ * services against a contract tree.
+ *
+ * @example
+ * ```ts
+ * class TodoHandlers implements RouteHandlers<typeof api.todos> {
+ *   get(request: RouteRequest<typeof api.todos.get>) {
+ *     return { id: request.id };
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link https://rest-rpc.dev/docs/recipes/class-handlers}
+ */
+export type RouteHandlers<TContract extends WebContract, TContext extends Record<string, unknown> = Record<string, unknown>> = WebRouteHandlers<TContract, TContext, NextRequest>;
+/**
+ * Options for creating Next.js route handler exports.
+ *
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#options}
+ */
 export type CreateRouteHandlerOptions = {
     errorHandlers?: CreateWebHandlerOptions["errorHandlers"];
     parseBody?: (input: WebRouteParseBodyInput) => unknown | Promise<unknown>;
 };
-export declare const route: <const TRoute extends HttpRouteDeclaration>(contract: TRoute) => WebRouteBuilder<TRoute, Record<never, never>, NextRequest>;
-export declare const router: <const TContract extends WebContract>(contract: TContract) => WebRouterBuilder<TContract, Record<never, never>, NextRequest>;
-export declare const createRouteHandler: (implementations: WebImplementationTree, options?: CreateRouteHandlerOptions) => {
+/**
+ * Creates a Next.js route implementation builder for a single HTTP route.
+ *
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#single-route-handler}
+ */
+export declare function route<const TRoute extends HttpRouteDeclaration>(contract: TRoute): WebRouteBuilder<TRoute, Record<never, never>, NextRequest>;
+/**
+ * Creates a Next.js router implementation builder for a contract tree.
+ *
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#catch-all-route-handler}
+ */
+export declare function router<const TContract extends WebContract>(contract: TContract): WebRouterBuilder<TContract, Record<never, never>, NextRequest>;
+/**
+ * Creates Next.js route handler exports from route implementations.
+ *
+ * @remarks This wrapper passes only the `NextRequest`; use `@rest-rpc/web` directly for custom runtime context.
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#custom-runtime-context}
+ */
+export declare function createRouteHandler(implementations: WebImplementationTree, options?: CreateRouteHandlerOptions): {
     DELETE: (request: Request) => Promise<Response>;
     GET: (request: Request) => Promise<Response>;
     PATCH: (request: Request) => Promise<Response>;

package/dist/server.js

@@ -1,7 +1,27 @@
 import { createRouteHandler as createWebRouteHandler, route as webRoute, router as webRouter, } from "@rest-rpc/web";
-export const route = (contract) => webRoute(contract);
-export const router = (contract) => webRouter(contract);
-export const createRouteHandler = (implementations, options) => {
+/**
+ * Creates a Next.js route implementation builder for a single HTTP route.
+ *
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#single-route-handler}
+ */
+export function route(contract) {
+    return webRoute(contract);
+}
+/**
+ * Creates a Next.js router implementation builder for a contract tree.
+ *
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#catch-all-route-handler}
+ */
+export function router(contract) {
+    return webRouter(contract);
+}
+/**
+ * Creates Next.js route handler exports from route implementations.
+ *
+ * @remarks This wrapper passes only the `NextRequest`; use `@rest-rpc/web` directly for custom runtime context.
+ * @see {@link https://rest-rpc.dev/docs/server/next.js#custom-runtime-context}
+ */
+export function createRouteHandler(implementations, options) {
     const handle = createWebRouteHandler(implementations, {
         errorHandlers: options?.errorHandlers,
         parseBody: options?.parseBody,
@@ -14,4 +34,4 @@ export const createRouteHandler = (implementations, options) => {
         POST: nextHandler,
         PUT: nextHandler,
     };
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rest-rpc/next",
-  "version": "0.1.0-beta.12",
+  "version": "0.1.0-beta.14",
   "type": "module",
   "license": "MIT",
   "description": "Next.js adapter for serving and consuming rest-rpc contracts in App Router projects.",
@@ -40,8 +40,8 @@
     "directory": "test-d"
   },
   "dependencies": {
-    "@rest-rpc/core": "0.1.0-beta.12",
-    "@rest-rpc/web": "0.1.0-beta.12"
+    "@rest-rpc/web": "0.1.0-beta.14",
+    "@rest-rpc/core": "0.1.0-beta.14"
   },
   "peerDependencies": {
     "next": ">=15"