rouzer 5.1.1 → 5.2.1

package/README.md

@@ -181,6 +181,28 @@ await client.upload(file, { headers: { 'content-type': file.type } })
 Server handlers for raw-body routes read from `ctx.request` directly with Fetch
 APIs such as `arrayBuffer()`, `blob()`, `formData()`, or `text()`.
 
+### Client lifecycle hooks
+
+Pass `clientHook` to observe generated client action calls without wrapping the
+client tree:
+
+```ts
+const client = createClient({
+  baseURL: 'https://example.com/api/',
+  routes,
+  clientHook(event) {
+    if (event.type === 'request.success') {
+      console.log(event.routeName, event.durationMs)
+    }
+  },
+})
+```
+
+Rouzer emits `request.start` before client-side validation, then
+`request.success` when the action resolves or `request.error` when it rejects.
+Terminal events include the parsed response or thrown error plus `durationMs`.
+Hook errors are swallowed.
+
 ### NDJSON response streams
 
 Use `response: ndjson.$type<T>()` for endpoints that stream
@@ -215,6 +237,12 @@ for await (const event of await client.events()) {
 }
 ```
 
+If a client aborts the request signal or stops iteration early by breaking from
+`for await` or calling the iterator's `return()`, Rouzer cancels the response
+body and calls the server source iterator's `return()`. Sources that wait for
+future events should make those waits abort-aware when they need cleanup to run
+while an awaited operation is still pending.
+
 ## Documentation
 
 - [Concepts, API selection, v5 client input notes, and migration notes](docs/context.md)

package/dist/client/index.d.ts

@@ -5,6 +5,37 @@ import type { RouteFetchOptions, RouteInput, RouteOptions } from '../types/args.
 import type { RawBodySchema } from '../types/schema.js';
 import type { InferRouteResponse } from '../types/response.js';
 import type { RouteSchema } from '../types/schema.js';
+/** Lifecycle event emitted by generated client action functions. */
+export type RouzerClientHookEvent = {
+    type: 'request.start';
+    opId: string;
+    routeName: string;
+    method: string;
+    pathPattern: string;
+    payload: unknown;
+} | {
+    type: 'request.success';
+    opId: string;
+    routeName: string;
+    method: string;
+    pathPattern: string;
+    payload: unknown;
+    response: unknown;
+    status?: number;
+    durationMs: number;
+} | {
+    type: 'request.error';
+    opId: string;
+    routeName: string;
+    method: string;
+    pathPattern: string;
+    payload: unknown;
+    error: unknown;
+    status?: number;
+    durationMs: number;
+};
+/** Best-effort observer for generated client action lifecycles. */
+export type RouzerClientHook = (event: RouzerClientHookEvent) => void;
 /** Client type inferred from an HTTP route tree passed to `createClient`. */
 export type RouzerClient<TRoutes extends HttpRouteTree = Record<string, never>> = ReturnType<typeof createClient<TRoutes>>;
 /**
@@ -51,6 +82,12 @@ export declare function createClient<TRoutes extends HttpRouteTree = Record<stri
     onJsonError?: (response: Response) => Promisable<unknown>;
     /** Custom `fetch` implementation to use for requests. */
     fetch?: typeof globalThis.fetch;
+    /**
+     * Best-effort lifecycle observer for generated client action calls.
+     *
+     * @remarks Hook errors are swallowed and never change request behavior.
+     */
+    clientHook?: RouzerClientHook;
 }): ClientTree<TRoutes, ""> & {
     clientConfig: {
         /**
@@ -90,6 +127,12 @@ export declare function createClient<TRoutes extends HttpRouteTree = Record<stri
         onJsonError?: (response: Response) => Promisable<unknown>;
         /** Custom `fetch` implementation to use for requests. */
         fetch?: typeof globalThis.fetch;
+        /**
+         * Best-effort lifecycle observer for generated client action calls.
+         *
+         * @remarks Hook errors are swallowed and never change request behavior.
+         */
+        clientHook?: RouzerClientHook;
     };
 };
 type Join<A extends string, B extends string> = A extends '' ? B : B extends '' ? A : `${A}/${B}`;

package/dist/client/index.js

@@ -4,6 +4,7 @@ import { shake } from '../common.js';
 import { isRawBodySchema, } from '../http.js';
 import { getResponseMapPluginIds, isErrorMarker, isResponseMap, } from '../response-map.js';
 import { createResponsePluginMap, getResponsePluginMarkerId, } from '../response.js';
+let nextClientOpId = 0;
 /**
  * Create a typed fetch client for an HTTP route tree.
  *
@@ -16,7 +17,10 @@ export function createClient(config) {
     const fetch = config.fetch ?? globalThis.fetch;
     const responsePlugins = createResponsePluginMap(config.plugins, 'client response');
     validateClientResponsePlugins(config.routes, responsePlugins);
-    async function plainRequest({ path: pathPattern, method, input = {}, options: { body: rawBody, headers, ...init } = {}, schema, }) {
+    async function plainRequest(props) {
+        const { path: pathPattern, method, input = {}, schema } = props;
+        const { body: rawBody, ...options } = props.options ?? {};
+        let { headers, ...init } = options;
         const path = schema.path
             ? schema.path.parse(pickObjectSchemaFields(schema.path, input))
             : input;
@@ -48,7 +52,7 @@ export function createClient(config) {
         if (schema.headers) {
             headers = schema.headers.parse(headers);
         }
-        return fetch(url, {
+        return (await fetch(url, {
             ...init,
             method,
             body: isRawBodySchema(schema.body)
@@ -57,10 +61,9 @@ export function createClient(config) {
                     ? JSON.stringify(body)
                     : undefined,
             headers: (headers ?? defaultHeaders),
-        });
+        }));
     }
-    async function parsedRequest(props) {
-        const response = await plainRequest(props);
+    async function parseResponse(response, props) {
         const responseSchema = props.schema.response;
         // Handle status-keyed response maps
         if (isResponseMap(responseSchema)) {
@@ -106,6 +109,25 @@ export function createClient(config) {
         }
         return response.json();
     }
+    async function plainClientRequest(props) {
+        const response = await plainRequest(props);
+        return {
+            value: response,
+            status: response.status,
+        };
+    }
+    async function parsedClientRequest(props) {
+        const response = await plainRequest(props);
+        try {
+            return {
+                value: await parseResponse(response, props),
+                status: response.status,
+            };
+        }
+        catch (error) {
+            throw new ClientRequestFailure(error, response.status);
+        }
+    }
     async function handleResponseError(response, props) {
         if (config.onJsonError) {
             return config.onJsonError(response);
@@ -118,39 +140,118 @@ export function createClient(config) {
         throw error;
     }
     return {
-        ...connectTree(config.routes, '', plainRequest, parsedRequest),
+        ...connectTree(config.routes, '', '', plainClientRequest, parsedClientRequest, config.clientHook),
         clientConfig: config,
     };
 }
-function connectTree(tree, prefix, plainRequest, parsedRequest) {
+class ClientRequestFailure {
+    error;
+    status;
+    constructor(error, status) {
+        this.error = error;
+        this.status = status;
+    }
+}
+function connectTree(tree, prefix, namePrefix, plainRequest, parsedRequest, clientHook) {
     return Object.fromEntries(Object.entries(tree).map(([key, node]) => {
         if (node.kind === 'resource') {
             return [
                 key,
-                connectTree(node.children, joinPaths(prefix, node.path.source), plainRequest, parsedRequest),
+                connectTree(node.children, joinPaths(prefix, node.path.source), joinNames(namePrefix, key), plainRequest, parsedRequest, clientHook),
             ];
         }
         const path = RoutePattern.parse(joinPaths(prefix, node.path?.source ?? ''));
         const fetch = node.schema.response ? parsedRequest : plainRequest;
+        const routeName = joinNames(namePrefix, key);
         return [
             key,
             (input, options) => {
+                const payload = input;
                 if (isRawBodySchema(node.schema.body) && !hasRouteInput(node, path)) {
                     options = { ...options, body: input };
                     input = undefined;
                 }
-                return fetch({
+                return runClientRequest({
                     schema: node.schema,
                     path,
+                    routeName,
                     method: node.method,
                     input,
+                    payload,
                     options,
                     $result: undefined,
-                });
+                }, fetch, clientHook);
             },
         ];
     }));
 }
+async function runClientRequest(request, fetch, clientHook) {
+    if (!clientHook) {
+        try {
+            return (await fetch(request)).value;
+        }
+        catch (error) {
+            throw getClientRequestFailure(error)?.error ?? error;
+        }
+    }
+    const opId = createClientOpId();
+    const startTime = Date.now();
+    const baseEvent = {
+        opId,
+        routeName: request.routeName,
+        method: request.method,
+        pathPattern: request.path.source,
+        payload: request.payload,
+    };
+    emitClientHook(clientHook, {
+        type: 'request.start',
+        ...baseEvent,
+    });
+    try {
+        const result = await fetch(request);
+        emitClientHook(clientHook, {
+            type: 'request.success',
+            ...baseEvent,
+            response: result.value,
+            ...clientRequestStatus(result.status),
+            durationMs: Date.now() - startTime,
+        });
+        return result.value;
+    }
+    catch (error) {
+        const failure = getClientRequestFailure(error);
+        const eventError = failure ? failure.error : error;
+        emitClientHook(clientHook, {
+            type: 'request.error',
+            ...baseEvent,
+            error: eventError,
+            ...clientRequestStatus(failure?.status),
+            durationMs: Date.now() - startTime,
+        });
+        throw eventError;
+    }
+}
+function emitClientHook(clientHook, event) {
+    try {
+        clientHook(event);
+    }
+    catch {
+        // Lifecycle hooks are observability-only and must not affect requests.
+    }
+}
+function createClientOpId() {
+    nextClientOpId += 1;
+    return `rouzer:${Date.now().toString(36)}:${nextClientOpId.toString(36)}`;
+}
+function getClientRequestFailure(error) {
+    return error instanceof ClientRequestFailure ? error : undefined;
+}
+function clientRequestStatus(status) {
+    return status === undefined ? {} : { status };
+}
+function joinNames(left, right) {
+    return [left, right].filter(Boolean).join('.');
+}
 function validateClientResponsePlugins(tree, plugins) {
     for (const node of Object.values(tree)) {
         if (node.kind === 'resource') {

package/dist/ndjson.d.ts

@@ -2,6 +2,11 @@ import { type ClientResponsePlugin, type ResponsePluginMarker, type RouterRespon
 declare const codecId = "rouzer/ndjson";
 /** Values accepted by Rouzer's NDJSON response encoder. */
 export type NdjsonSource<T = unknown> = Iterable<T> | AsyncIterable<T>;
+/** Options for Rouzer's NDJSON response encoder. */
+export type NdjsonEncodeOptions = {
+    /** Signal whose abort cancels the source iterator and closes the stream. */
+    signal?: AbortSignal;
+};
 /**
  * Create a compile-time marker for newline-delimited JSON response items.
  *
@@ -32,9 +37,11 @@ export declare const routerPlugin: RouterResponsePlugin;
  *
  * @remarks Each yielded value is serialized with `JSON.stringify` and followed
  * by `\n`. Values that cannot be represented as a JSON text, such as
- * `undefined`, cause the stream to error when read.
+ * `undefined`, cause the stream to error when read. When `options.signal`
+ * aborts, the source iterator's `return()` method is called and the stream is
+ * closed.
  */
-export declare function encodeNdjson(source: NdjsonSource): ReadableStream<Uint8Array>;
+export declare function encodeNdjson(source: NdjsonSource, options?: NdjsonEncodeOptions): ReadableStream<Uint8Array>;
 /**
  * Decode a newline-delimited JSON byte stream.
  *
@@ -50,5 +57,5 @@ export declare function decodeNdjson<T = unknown>(stream: ReadableStream<Uint8Ar
  * `content-type: application/x-ndjson; charset=utf-8` unless the caller supplies
  * a content type in `init.headers`.
  */
-export declare function ndjsonResponse<T>(source: NdjsonSource<T>, init?: ResponseInit): Response;
+export declare function ndjsonResponse<T>(source: NdjsonSource<T>, init?: ResponseInit & NdjsonEncodeOptions): Response;
 export {};

package/dist/ndjson.js

@@ -36,8 +36,10 @@ export const clientPlugin = {
  */
 export const routerPlugin = {
     id: codecId,
-    encode(value) {
-        return ndjsonResponse(value);
+    encode(value, { request }) {
+        return ndjsonResponse(value, {
+            signal: request.signal,
+        });
     },
 };
 /**
@@ -45,15 +47,58 @@ export const routerPlugin = {
  *
  * @remarks Each yielded value is serialized with `JSON.stringify` and followed
  * by `\n`. Values that cannot be represented as a JSON text, such as
- * `undefined`, cause the stream to error when read.
+ * `undefined`, cause the stream to error when read. When `options.signal`
+ * aborts, the source iterator's `return()` method is called and the stream is
+ * closed.
  */
-export function encodeNdjson(source) {
+export function encodeNdjson(source, options = {}) {
     const iterator = getAsyncIterator(source);
     const encoder = new TextEncoder();
+    const { signal } = options;
+    let cancelled = false;
+    let cleanup;
+    let abortHandler;
+    function removeAbortHandler() {
+        if (signal && abortHandler) {
+            signal.removeEventListener('abort', abortHandler);
+            abortHandler = undefined;
+        }
+    }
+    function cancelIterator(reason) {
+        cancelled = true;
+        removeAbortHandler();
+        cleanup ??= Promise.resolve(iterator.return?.(reason)).then(() => { });
+        return cleanup;
+    }
     return new ReadableStream({
+        start(controller) {
+            if (!signal) {
+                return;
+            }
+            abortHandler = () => {
+                void cancelIterator(signal.reason).catch(() => { });
+                try {
+                    controller.close();
+                }
+                catch { }
+            };
+            if (signal.aborted) {
+                abortHandler();
+                return;
+            }
+            signal.addEventListener('abort', abortHandler, { once: true });
+        },
         async pull(controller) {
+            if (cancelled) {
+                controller.close();
+                return;
+            }
             const { done, value } = await iterator.next();
+            if (cancelled) {
+                return;
+            }
             if (done) {
+                removeAbortHandler();
                 controller.close();
                 return;
             }
@@ -64,7 +109,7 @@ export function encodeNdjson(source) {
             controller.enqueue(encoder.encode(`${line}\n`));
         },
         async cancel(reason) {
-            await iterator.return?.(reason);
+            await cancelIterator(reason);
         },
     });
 }
@@ -118,12 +163,13 @@ export async function* decodeNdjson(stream) {
  * a content type in `init.headers`.
  */
 export function ndjsonResponse(source, init = {}) {
+    const { signal, ...responseInit } = init;
     const headers = new Headers(init.headers);
     if (!headers.has('content-type')) {
         headers.set('content-type', 'application/x-ndjson; charset=utf-8');
     }
-    return new Response(encodeNdjson(source), {
-        ...init,
+    return new Response(encodeNdjson(source, { signal }), {
+        ...responseInit,
         headers,
     });
 }

package/docs/context.md

@@ -242,6 +242,54 @@ top, and a custom `fetch` implementation can be supplied for tests or non-browse
 runtimes. The returned client exposes the original options as `clientConfig`, so
 route actions named `config` remain available as `client.config(...)`.
 
+### Client lifecycle hooks
+
+`createClient({ clientHook })` observes generated client action calls without
+wrapping the returned client tree:
+
+```ts
+const client = createClient({
+  baseURL: 'https://example.com/api/',
+  routes,
+  clientHook(event) {
+    if (event.type === 'request.success') {
+      console.log({
+        opId: event.opId,
+        routeName: event.routeName,
+        durationMs: event.durationMs,
+      })
+    }
+  },
+})
+```
+
+Rouzer emits:
+
+- `request.start` before client-side validation
+- `request.success` when the generated action resolves
+- `request.error` when the generated action rejects
+
+Each event includes an opaque per-call `opId`, the generated client route name
+such as `session.create`, the HTTP method, the joined route path pattern, and
+the generated action's first argument as `payload`. Terminal events include
+`durationMs`, either the resolved `response` or thrown `error`, and `status` when
+an HTTP response was received.
+
+`request.error` covers client validation failures, transport failures,
+undeclared HTTP errors, JSON parsing failures, response plugin decode failures,
+and rejected `onJsonError` handlers. A declared error response returned as data
+from a response map is a successful generated action and emits
+`request.success`.
+
+Lifecycle hooks are best-effort observability only. If `clientHook` throws,
+Rouzer swallows that hook error and preserves the generated action's original
+behavior.
+
+For response plugins that return streams, such as NDJSON, `request.success` is
+emitted when the generated action resolves to the stream object. Errors that
+happen later while the caller consumes the stream are outside the first lifecycle
+hook surface.
+
 ## Lifecycle
 
 1. Define shared HTTP actions/resources with `rouzer/http` and Zod schemas.
@@ -376,6 +424,12 @@ Rouzer's decoder accepts `\n` and `\r\n`, handles UTF-8 chunk boundaries, and
 throws a `SyntaxError` with a line number for malformed JSON. If a consumer stops
 reading early, the response body is cancelled.
 
+If a client aborts the request signal or stops iteration early by breaking from
+`for await` or calling the iterator's `return()`, Rouzer cancels the response
+body and calls the server source iterator's `return()`. Sources that wait for
+future events should make those waits abort-aware when they need cleanup to run
+while an awaited operation is still pending.
+
 Rouzer does not convert handler or generator failures into extra NDJSON items. If
 an async generator throws after the response starts, the response stream errors
 and the client's `for await` loop throws. Model application-level stream errors

package/examples/ndjson-stream.ts

@@ -2,17 +2,34 @@ import type { HattipHandler } from '@hattip/core'
 import { createClient, createRouter } from 'rouzer'
 import * as http from 'rouzer/http'
 import * as ndjson from 'rouzer/ndjson'
+import { z } from 'zod'
 
 type Event = {
   id: number
   message: string
 }
 
+const EventFilter = z.object({
+  names: z.array(z.string()),
+  where: z.array(
+    z.object({
+      path: z.string(),
+      equals: z.string(),
+    })
+  ),
+})
+
 export const events = http.get('events', {
   response: ndjson.$type<Event>(),
 })
 
-export const routes = { events }
+// NDJSON responses work for POST routes with ordinary JSON body schemas too.
+export const stream = http.post('events/stream', {
+  body: EventFilter,
+  response: ndjson.$type<Event>(),
+})
+
+export const routes = { events, stream }
 
 /**
  * Tiny Hattip adapter used only to keep this example self-contained. Real apps
@@ -46,6 +63,17 @@ async function collect<T>(source: AsyncIterable<T>) {
   return values
 }
 
+async function readFirst<T>(source: AsyncIterable<T>) {
+  const iterator = source[Symbol.asyncIterator]()
+  try {
+    return (await iterator.next()).value
+  } finally {
+    // Closing the client iterator cancels the response body. For Rouzer NDJSON
+    // routes, that cancellation reaches the server source iterator's return().
+    await iterator.return?.()
+  }
+}
+
 export async function runNdjsonStreamExample() {
   const handler = createRouter({
     basePath: 'api/',
@@ -55,6 +83,14 @@ export async function runNdjsonStreamExample() {
       yield { id: 1, message: 'ready' }
       yield { id: 2, message: 'done' }
     },
+    async *stream({ body }) {
+      // The POST body was parsed and validated before the stream starts.
+      yield {
+        id: 1,
+        message: `${body.names[0]} for ${body.where[0]?.equals}`,
+      }
+      yield { id: 2, message: 'done' }
+    },
   })
 
   const client = createClient({
@@ -64,5 +100,16 @@ export async function runNdjsonStreamExample() {
     fetch: createLocalFetch(handler),
   })
 
-  return collect(await client.events())
+  const allEvents = await collect(await client.events())
+
+  // This call sends a JSON body, receives an AsyncIterable, and then stops after
+  // one event. Request signals can also be used to cancel long-lived streams.
+  const firstMatchingEvent = await readFirst(
+    await client.stream({
+      names: ['session.message'],
+      where: [{ path: 'id', equals: 'ses_123' }],
+    })
+  )
+
+  return { allEvents, firstMatchingEvent }
 }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "rouzer",
-  "version": "5.1.1",
+  "version": "5.2.1",
+  "packageManager": "pnpm@11.5.1",
   "type": "module",
   "exports": {
     ".": {
@@ -16,6 +17,12 @@
       "import": "./dist/ndjson.js"
     }
   },
+  "scripts": {
+    "build": "rm -rf dist && tsgo -b tsconfig.json",
+    "format": "prettier --write src test",
+    "test": "vitest run",
+    "prepublishOnly": "pnpm build"
+  },
   "peerDependencies": {
     "zod": ">=4"
   },
@@ -34,7 +41,7 @@
   },
   "dependencies": {
     "@hattip/core": "^0.0.49",
-    "@remix-run/route-pattern": "^0.21.1",
+    "@remix-run/route-pattern": "^0.22.1",
     "alien-middleware": "^0.11.6"
   },
   "prettier": "@alloc/prettier-config",
@@ -49,10 +56,5 @@
     "examples",
     "README.md",
     "!*.tsbuildinfo"
-  ],
-  "scripts": {
-    "build": "rm -rf dist && tsgo -b tsconfig.json",
-    "format": "prettier --write src test",
-    "test": "vitest run"
-  }
-}
+  ]
+}