rouzer 5.0.0 → 5.1.0

package/README.md

@@ -103,8 +103,10 @@ const { message } = await client.hello({
 ```
 
 `handler` can be mounted with any Hattip adapter. Generated client action calls
-validate route arguments before `fetch`; server handlers validate matched path,
-query, headers, and JSON bodies before your handler runs.
+validate flat route arguments before `fetch`; server handlers validate matched
+path, query, headers, and JSON bodies before your handler runs. Per-request
+headers, abort signals, and other `RequestInit` options are passed as a second
+client action argument.
 
 ### Typed status responses
 
@@ -185,7 +187,7 @@ for await (const event of await client.events()) {
 
 ## Documentation
 
-- [Concepts, API selection, and v2->v3 migration notes](docs/context.md)
+- [Concepts, API selection, v5 client input notes, and migration notes](docs/context.md)
 - [Runnable shared-route example](examples/basic-usage.ts)
 - [Runnable typed error response example](examples/error-responses.ts)
 - [Runnable NDJSON response-stream example](examples/ndjson-stream.ts)

package/dist/client/index.d.ts

@@ -1,7 +1,8 @@
 import { Promisable } from '../common.js';
 import { type HttpAction, type HttpResource, type HttpRouteTree } from '../http.js';
 import { type ClientResponsePlugin } from '../response.js';
-import type { RouteInput, RouteOptions } from '../types/args.js';
+import type { RouteFetchOptions, RouteInput, RouteOptions } from '../types/args.js';
+import type { RawBodySchema } from '../types/schema.js';
 import type { InferRouteResponse } from '../types/response.js';
 import type { RouteSchema } from '../types/schema.js';
 /** Client type inferred from an HTTP route tree passed to `createClient`. */
@@ -33,7 +34,7 @@ export declare function createClient<TRoutes extends HttpRouteTree = Record<stri
      * @example
      * ```ts
      * const client = createClient({ baseURL: 'https://example.com/api/', routes })
-     * await client.users.list({ query: { page: 1 } })
+     * await client.users.list({ page: 1 })
      * ```
      */
     routes: TRoutes;
@@ -72,7 +73,7 @@ export declare function createClient<TRoutes extends HttpRouteTree = Record<stri
          * @example
          * ```ts
          * const client = createClient({ baseURL: 'https://example.com/api/', routes })
-         * await client.users.list({ query: { page: 1 } })
+         * await client.users.list({ page: 1 })
          * ```
          */
         routes: TRoutes;
@@ -106,7 +107,13 @@ export type ClientTree<T extends HttpRouteTree, TPrefix extends string = ''> = {
  * plugin's client result type. Actions without a response marker return the raw
  * `Response`.
  */
-export type RouteFunction<T extends RouteSchema, P extends string> = (...p: RouteInput<T, P> extends infer TInput ? {} extends TInput ? [input?: TInput, options?: RouteOptions<T>] : [input: TInput, options?: RouteOptions<T>] : never) => Promise<T extends {
+export type RouteFunction<T extends RouteSchema, P extends string> = T extends {
+    body: RawBodySchema;
+} ? RouteInput<T, P> extends infer TInput ? {} extends TInput ? (body: BodyInit | null, options?: RouteFetchOptions<T>) => Promise<T extends {
+    response: any;
+} ? InferRouteResponse<T> : Response> : (input: TInput, options: RouteOptions<T>) => Promise<T extends {
+    response: any;
+} ? InferRouteResponse<T> : Response> : never : (...p: RouteInput<T, P> extends infer TInput ? {} extends TInput ? [input?: TInput, options?: RouteOptions<T>] : [input: TInput, options?: RouteOptions<T>] : never) => Promise<T extends {
     response: any;
 } ? InferRouteResponse<T> : Response>;
 export {};

package/dist/client/index.js

@@ -134,14 +134,20 @@ function connectTree(tree, prefix, plainRequest, parsedRequest) {
         const fetch = node.schema.response ? parsedRequest : plainRequest;
         return [
             key,
-            (input, options) => fetch({
-                schema: node.schema,
-                path,
-                method: node.method,
-                input,
-                options,
-                $result: undefined,
-            }),
+            (input, options) => {
+                if (isRawBodySchema(node.schema.body) && !hasRouteInput(node, path)) {
+                    options = { ...options, body: input };
+                    input = undefined;
+                }
+                return fetch({
+                    schema: node.schema,
+                    path,
+                    method: node.method,
+                    input,
+                    options,
+                    $result: undefined,
+                });
+            },
         ];
     }));
 }
@@ -165,6 +171,9 @@ function validateClientResponsePlugins(tree, plugins) {
 function missingClientResponsePlugin(pluginId) {
     return new Error(`Missing client response plugin for ${pluginId}`);
 }
+function hasRouteInput(node, path) {
+    return Boolean(node.schema.path || node.schema.query || /(^|\/)[:*]/.test(path.source));
+}
 function pickObjectSchemaFields(schema, input) {
     if (typeof input !== 'object' || input === null) {
         return input;

package/dist/response-map.js

@@ -1,4 +1,4 @@
-import { getResponsePluginMarkerId, responsePluginMarker, } from './response.js';
+import { getResponsePluginMarkerId, responsePluginMarker } from './response.js';
 import { $error } from './type.js';
 /** Return true when the response schema is a status-keyed response map. */
 export function isResponseMap(response) {

package/dist/types/args.d.ts

@@ -30,13 +30,14 @@ export type RouteInput<T extends RouteSchema = any, P extends string = string> =
  * @remarks `headers` remains optional because required route headers may be
  * supplied by `createClient({ headers })` defaults.
  */
+export type RouteFetchOptions<T extends RouteSchema = any> = Omit<RequestInit, 'method' | 'body' | 'headers'> & {
+    /** Headers for this request. Undefined values are removed before `fetch`. */
+    headers?: HeaderInput<T>;
+};
 type RouteBodyOption<T> = T extends {
     body: RawBodySchema;
 } ? {
     body: BodyInit | null;
 } : {};
-export type RouteOptions<T extends RouteSchema = any> = Omit<RequestInit, 'method' | 'body' | 'headers'> & RouteBodyOption<T> & {
-    /** Headers for this request. Undefined values are removed before `fetch`. */
-    headers?: HeaderInput<T>;
-};
+export type RouteOptions<T extends RouteSchema = any> = RouteFetchOptions<T> & RouteBodyOption<T>;
 export {};

package/docs/context.md

@@ -213,6 +213,10 @@ requests with an `Origin` header.
 
 `createClient({ baseURL, routes })` creates a client tree that mirrors
 `routes`, with action functions such as `client.profiles.get(args)`.
+Generated action functions accept a flattened first argument containing path,
+query, and JSON body fields. Per-request `RequestInit` options, including
+headers and abort signals, are passed as the optional second argument.
+
 Generated action functions include:
 
 - raw `Response` results for actions without a response schema
@@ -261,16 +265,22 @@ string-coercion step.
 
 ### Call client actions
 
-Use generated client action functions for application calls:
+Use generated client action functions for application calls. The first argument
+is a flat object containing all path, query, and JSON body fields. The optional
+second argument is for per-request `RequestInit` options such as headers or an
+abort signal.
 
 ```ts
-await client.profiles.get({ path: { id: '42' } })
-await client.profiles.update({
-  path: { id: '42' },
-  body: { name: 'Ada' },
-})
+await client.profiles.get({ id: '42', includePosts: true })
+await client.profiles.update(
+  { id: '42', name: 'Ada' },
+  { headers: { 'x-request-id': 'docs' } }
+)
 ```
 
+Avoid duplicate field names across an action's path, query, and body schemas;
+the client input is flat, so duplicate keys cannot represent separate values.
+
 ### Handle declared error responses
 
 Use `$error<T>()` inside a response map when an error status is part of the route
@@ -308,9 +318,7 @@ const client = createClient({
   routes,
 })
 
-const [error, user, status] = await client.getUser({
-  path: { id: 'missing' },
-})
+const [error, user, status] = await client.getUser({ id: 'missing' })
 
 if (status === 404) {
   console.log(error.message)
@@ -384,11 +392,29 @@ export const organizations = http.resource('orgs/:orgId', {
   }),
 })
 
-await client.organizations.members.get({
-  path: { orgId: 'acme', memberId: '42' },
+await client.organizations.members.get({ orgId: 'acme', memberId: '42' })
+```
+
+### Send raw request bodies
+
+Use `http.rawBody()` for mutation actions whose client should pass a `BodyInit`
+through to `fetch` without JSON encoding or Zod body parsing:
+
+```ts
+export const uploadAvatar = http.post('profiles/:id/avatar', {
+  body: http.rawBody(),
+  headers: z.object({ 'content-type': z.string() }),
 })
+
+await client.uploadAvatar(
+  { id: '42' },
+  { body: file, headers: { 'content-type': file.type } }
+)
 ```
 
+Path fields still live in the flat first argument. The raw body itself is passed
+as `body` in the second argument because it is a `RequestInit` value.
+
 ### Return custom responses
 
 Return a `Response` from a handler for non-JSON payloads, custom status codes, or
@@ -434,7 +460,8 @@ export const profiles = http.resource('profiles/:id', {
 export const routes = { profiles }
 ```
 
-Handler maps and client calls mirror the new action names:
+Handler maps mirror the action names, while v5 client calls use flat input
+objects:
 
 ```ts
 createRouter().use(routes, {
@@ -448,11 +475,8 @@ createRouter().use(routes, {
   },
 })
 
-await client.profiles.get({ path: { id: '42' } })
-await client.profiles.update({
-  path: { id: '42' },
-  body: { name: 'Ada' },
-})
+await client.profiles.get({ id: '42' })
+await client.profiles.update({ id: '42', name: 'Ada' })
 ```
 
 ## Patterns to prefer
@@ -480,8 +504,8 @@ await client.profiles.update({
 - `$type<T>()`, `$error<T>()`, and `ndjson.$type<T>()` are compile-time-only type
   contracts. Rouzer does not re-validate handler return values at the server
   boundary.
-- NDJSON support is for response streams; request bodies still use the existing
-  JSON body schema path.
+- NDJSON support is for response streams; request bodies use JSON body schemas
+  unless an action declares `body: http.rawBody()`.
 - Declared `$error<T>()` responses are JSON responses. Use a custom `Response`
   for non-JSON error payloads.
 - Routes that use a response plugin fail fast if the matching client or router
@@ -489,10 +513,10 @@ await client.profiles.update({
 - Pathname route patterns expect an absolute client `baseURL`.
 - Resource and action keys are API names only; paths come from the pattern
   strings passed to `http.resource(...)` and action helpers.
-- Extra `RequestInit` fields in route args, such as `signal` or `credentials`,
-  are forwarded by `createClient`; `method` and `body` are reserved for Rouzer's
-  action metadata and validated call arguments. Use route args or client defaults
-  for request headers.
+- Path, query, and JSON body fields are flattened into the first client action
+  argument. Per-request `RequestInit` fields, such as `signal`, `credentials`,
+  and `headers`, belong in the second argument. `method` is reserved by Rouzer;
+  `body` is only accepted in the second argument for `http.rawBody()` actions.
 - The HTTP action API has no `ALL` fallback route. Declare explicit actions for
   supported methods.
 - Rouzer does not automatically set `Access-Control-Allow-Credentials`; set it in

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rouzer",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "type": "module",
   "exports": {
     ".": {