@dudousxd/nestjs-agent-react 0.18.0 → 0.20.0

package/README.md

@@ -352,46 +352,50 @@ menu (`ChatCommandPalette`, grown into the combobox's listbox) above the compose
 
 `@dudousxd/nestjs-agent-react/genui` draws server-pushed components (`ui` frames, persisted `ui[]`)
 with YOUR renderers. Headless: it adds no element and no style — only what your registry renders.
+Set it up once, at the root; `MessageItem` / `MessageList` then draw every pushed component with no
+`renderUi` of their own:
 
 ```tsx
-import { GenerativeUI, type GenuiRegistry } from '@dudousxd/nestjs-agent-react/genui';
-import { catalog } from './catalog'; // optional: a @dudousxd/nestjs-agent-genui catalog
+import { GenuiProvider, type GenuiRegistry } from '@dudousxd/nestjs-agent-react/genui';
+import { catalog } from './catalog'; // optional: the same file the server uses (@dudousxd/nestjs-agent-core/genui)
 
 const registry: GenuiRegistry = { DataTable: MyTable, Chart: MyChart, Card: MyCard, Text: MyText };
 
-<MessageItem
-  message={message}
-  renderUi={(block) => (
-    <GenerativeUI
-      part={block}
-      registry={registry}
-      catalog={catalog}
-      resolveComponent={(name, version) => loadTenantComponent(name, version)}
-      fallback={({ reason, item }) => <UnknownComponent name={item.component} reason={reason} />}
-      loading={<Skeleton />}
-    />
-  )}
-/>;
+<GenuiProvider
+  registry={registry}
+  catalog={catalog}
+  resolveComponent={(name, version) => loadTenantComponent(name, version)}
+  fallback={({ reason, item }) => <UnknownComponent name={item.component} reason={reason} />}
+  loading={<Skeleton />}
+>
+  <App />
+</GenuiProvider>;
 ```
 
 | Prop | |
 |---|---|
-| `part` | A transcript `ui` block, a `data-ui` message part, or a stored `{ id, component, props, version? }`. |
 | `registry` | Component name → your renderer. It receives the props spread (and `children` as a tree layout node). |
 | `catalog?` | Validate props before drawing (`catalog.validateSync` when it can, so no placeholder flashes). Components the catalog does not know render unvalidated. |
 | `resolveComponent?(name, version)` | For components the registry lacks, e.g. a tenant's own, at the exact version a message was rendered with. Sync or async, cached per resolver/name/version. |
 | `fallback?` | A node, or `({ reason: 'unknown' \| 'invalid' \| 'error', item, issues?, error? }) => node`. Default: nothing. |
 | `loading?`, `onError?` | While a resolver or async validation is pending; a renderer threw (each item has its own error boundary). |
+| `treeRenderer?` | Draws a whole `genui:tree` frame (e.g. json-render, below). Default: node by node through `registry`. |
+
+`<GenerativeUI part={block} />` draws one component (a transcript `ui` block, a `data-ui` message
+part, or a stored `{ id, component, props, version? }`) with the provider's settings; any of the
+props above passed to it win over the provider's. An explicit `renderUi` on `MessageItem` still
+wins too, and `useAmbientRenderUi()` (main entry) hands a custom transcript the provider's renderer.
 
 A `genui:tree` frame (tree mode) is drawn node by node through the same registry, catalog and
-fallbacks, each node in its own boundary; put a `genui:tree` entry in the registry to take over.
-`useGenerativeUI(part, options)` returns the state (`ready` with `Component`/`props`, `loading`,
-`problem`) for your own chrome; wrap it in `<GenerativeUIScope>` when it may draw a tree.
+fallbacks, each node in its own boundary. `useGenerativeUI(part, options?)` returns the state
+(`ready` with `Component`/`props`, `loading`, `problem`) for your own chrome, defaulting to the
+provider's settings; wrap it in `<GenerativeUIScope>` when it may draw a tree.
 
-**json-render** (optional peer `@json-render/react` >= 0.21):
-`@dudousxd/nestjs-agent-react/genui/json-render` renders tree frames through json-render's
-`Renderer` — `registry[GENUI_TREE_COMPONENT] = jsonRenderTree(toJsonRenderRegistry(registry))` —
-plus `JsonRenderTree` and `treeToJsonRenderSpec`.
+**json-render** (optional peer `@json-render/react` >= 0.21): import `GenuiProvider` from
+`@dudousxd/nestjs-agent-react/genui/json-render` instead — the same provider plus
+`jsonRender={myJsonRenderRegistry}` (or `jsonRender` alone, to derive one from `registry`), which
+draws tree frames through json-render's `Renderer`. `JsonRenderTree`, `jsonRenderTree`,
+`toJsonRenderRegistry` and `treeToJsonRenderSpec` are exported for hand wiring.
 
 ### Designed components, as copy-in source
 
@@ -705,6 +709,32 @@ An item is `uploading`, `ready`, `error` (retry with `files.retry(id)`) or `reje
 flight. `messageFiles(message)` reads the files back off any message — live or replayed — with a
 `kind` (`image`, `pdf`, `text`, …), the extension and, for replayed ones, the stored `mediaId`.
 
+#### Resumable uploads on nestjs-media (`@dudousxd/nestjs-agent-react/media`)
+
+With `AgentMediaAttachmentsModule` on the server (`@dudousxd/nestjs-agent/media`), one option turns
+it on — uploads go in chunks through nestjs-media's tus endpoint, with progress, abort (`remove`)
+and retry, on the chat client's own connection (base url, headers, credentials):
+
+```tsx
+import { mediaAttachments } from '@dudousxd/nestjs-agent-react/media';
+
+const chat = useAgentChat({ attachments: mediaAttachments() });
+const files = useAttachments({ backend: chat.backend });
+```
+
+Headless; `@dudousxd/nestjs-media-client` is an optional peer only this subpath uses. Extending it:
+
+- `mediaAttachments({ path: '/api/agent', chunkSize, retries })` — a prefixed API, tuning.
+- `new AgentClient({ …connection, attachments: mediaAttachments() })` — your own client instance.
+- `withMediaUploads(backend, connection)` — any other `AgentBackend`; `createMediaUpload(connection)`
+  — a bare `upload` for `useAttachments({ upload })`.
+- Refusals throw `MediaUploadError` with the HTTP `status` (`413`, `415`, …); an aborted or failed
+  upload is discarded on the server.
+
+Your own storage instead: `useAgentChat({ attachments: (file, { signal, onProgress }, connection) => … })`
+(an `AttachmentUploadStrategy`), or `useAttachments({ upload })`, resolving to a
+`{ mediaId, url, contentType, name }` your server's `AGENT_ATTACHMENT_STAGING` recognises.
+
 The rest of `AgentClient` works outside `useAgentChat` too — e.g. a standalone approvals inbox:
 
 ```ts

package/dist/client-0Wd-WPsu.d.cts

@@ -0,0 +1,285 @@
+import { ThreadSummary, ThreadDetail, MessageAttachment, ToolCatalogEntry, SkillCatalogEntry, QuotaView, QuotaReport, ModelCatalogView, AgentCatalogEntry, MessageFeedbackValue, MessageFeedback } from '@dudousxd/nestjs-agent-core';
+
+/**
+ * Partial update accepted by `PATCH <base>/threads/:threadId`. `defaultAgent: null` clears a
+ * previously-set default back to the module's own default; omitting it leaves the thread's
+ * current default untouched.
+ */
+interface ThreadPatch {
+    title?: string;
+    defaultAgent?: string | null;
+    /** Pin a catalog model on the thread; `null` unpins it. */
+    model?: string | null;
+}
+/** Starting a turn: the body `POST <base>/chat` takes (see docs/stream-protocol.md). */
+interface ChatStreamRequest {
+    /** `{ message, threadId?, agent?, model?, attachments?, pageContext?, regenerate?, … }`. */
+    body: Record<string, unknown>;
+    /** Per-request headers the AI SDK was handed for this send. */
+    headers?: Record<string, string>;
+    /** Aborted when the user stops the turn. */
+    signal?: AbortSignal;
+}
+/** Attaching to a run that is already streaming: `GET <base>/chat/:runId/stream?after=<seq>`. */
+interface ResumeStreamRequest {
+    runId: string;
+    /**
+     * The sequence number (SSE `id:`) of the last frame the client already has. Omitted → replay
+     * from the first frame. A backend that cannot skip may ignore it: the transport also drops frames
+     * at or below it.
+     */
+    after?: number;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+/**
+ * An open chat stream: the raw `text/event-stream` bytes in the stream-protocol framing, plus the
+ * identity a backend may learn before the first frame (the `X-Agent-Run-Id` / `X-Agent-Thread-Id`
+ * headers). The body's own `event: meta` frame supplies them otherwise.
+ */
+interface ChatStreamResponse {
+    body: ReadableStream<Uint8Array>;
+    runId?: string;
+    threadId?: string;
+}
+/** What `POST <base>/messages/:id/feedback` takes. `value: null` clears the rating. */
+interface MessageFeedbackInput {
+    value: MessageFeedbackValue | null;
+    comment?: string;
+}
+interface UploadAttachmentOptions {
+    signal?: AbortSignal;
+    /** Called with 0..1 as the upload progresses, when the backend can observe it. */
+    onProgress?: (fraction: number) => void;
+}
+/** How {@link AgentClient} reaches the server — handed to an {@link AttachmentUploadStrategy}. */
+interface AgentConnection {
+    /** Origin + base path, trailing slash removed (`''` for same-origin). */
+    baseUrl: string;
+    /** The client's static + per-request headers, resolved now (auth, CSRF). */
+    headers: () => Promise<Record<string, string>>;
+    credentials?: RequestCredentials;
+    fetch: typeof fetch;
+}
+/**
+ * Replaces {@link AgentClient}'s own `uploadAttachment` (`POST <base>/agent/attachments`) — e.g.
+ * `mediaAttachments()` from `@dudousxd/nestjs-agent-react/media`, or your own storage. Gets the
+ * client's connection so it needs no configuration of its own. Resolve with the attachment your
+ * server's `AGENT_ATTACHMENT_STAGING` recognises by `mediaId`.
+ */
+type AttachmentUploadStrategy = (file: File, options: UploadAttachmentOptions, connection: AgentConnection) => Promise<MessageAttachment>;
+/**
+ * Everything the React layer asks of a server — the seam between `useAgentChat` (and the other
+ * hooks) and whatever serves the agent. {@link AgentClient} is the default implementation, over the
+ * library's own REST routes with `fetch`. An app with its own client — a generated one, a different
+ * auth scheme (cookie session + CSRF header), a backend that is not this library at all but speaks
+ * docs/stream-protocol.md — implements this instead and passes it as `useAgentChat({ backend })`.
+ *
+ * The streaming, thread and cancel members are required: without them there is no chat. The rest
+ * are optional; a hook that needs one the backend does not have throws
+ * {@link AgentBackendUnsupportedError} when it is called, so a backend only implements what its
+ * server supports.
+ */
+interface AgentBackend {
+    /** Start a turn and return its SSE stream. Throw on a non-2xx answer. */
+    openChatStream(request: ChatStreamRequest): Promise<ChatStreamResponse>;
+    /** Attach to a streaming run. Resolve `null` when nothing is streaming under that id (HTTP 404). */
+    resumeChatStream(request: ResumeStreamRequest): Promise<ChatStreamResponse | null>;
+    /** Hard-stop a run server-side. */
+    cancelStream(runId: string): Promise<unknown>;
+    listThreads(): Promise<ThreadSummary[]>;
+    getThread(id: string): Promise<ThreadDetail>;
+    updateThread(id: string, patch: ThreadPatch): Promise<unknown>;
+    deleteThread(id: string): Promise<unknown>;
+    forkFromMessage?(threadId: string, messageId: string): Promise<ThreadSummary>;
+    promoteThread?(id: string): Promise<unknown>;
+    truncateFromMessage?(threadId: string, messageId: string): Promise<unknown>;
+    approveToolCall?(input: {
+        toolCallId: string;
+        remember?: boolean;
+        via?: string;
+    }): Promise<unknown>;
+    rejectToolCall?(input: {
+        toolCallId: string;
+        reason?: string;
+        via?: string;
+    }): Promise<unknown>;
+    answerToolCall?(input: {
+        toolCallId: string;
+        answers?: Record<string, string[]>;
+    }): Promise<unknown>;
+    skipToolCall?(input: {
+        toolCallId: string;
+    }): Promise<unknown>;
+    uploadAttachment?(file: File, options?: UploadAttachmentOptions): Promise<MessageAttachment>;
+    listTools?(agent?: string): Promise<ToolCatalogEntry[]>;
+    listSkills?(threadId?: string): Promise<SkillCatalogEntry[]>;
+    getQuotaToday?(): Promise<QuotaView>;
+    /** `GET <base>/quota` — every budget window, and which one blocks sends, if any. */
+    getQuota?(): Promise<QuotaReport>;
+    /** `GET <base>/models?agent=` — what a model picker offers. */
+    listModels?(agent?: string): Promise<ModelCatalogView>;
+    /** `GET <base>/agents` — what an agent picker offers. */
+    listAgents?(): Promise<AgentCatalogEntry[]>;
+    setMessageFeedback?(messageId: string, input: MessageFeedbackInput): Promise<{
+        feedback: MessageFeedback | null;
+    }>;
+}
+/** An optional {@link AgentBackend} member the bound backend does not implement was called. */
+declare class AgentBackendUnsupportedError extends Error {
+    readonly method: string;
+    constructor(method: string);
+}
+type OptionalMethod = {
+    [K in keyof AgentBackend]-?: undefined extends AgentBackend[K] ? K : never;
+}[keyof AgentBackend];
+/**
+ * The optional backend method `name`, bound — or a throw naming it. For hook code that has to call
+ * something a backend may not offer.
+ */
+declare function requireBackendMethod<K extends OptionalMethod>(backend: AgentBackend, name: K): NonNullable<AgentBackend[K]>;
+
+/**
+ * Thrown by {@link AgentClient} on a non-2xx response. Carries the HTTP `status` so callers can
+ * branch (e.g. 403 → "not your thread", 429 → quota) instead of string-matching a generic Error.
+ */
+declare class AgentHttpError extends Error {
+    readonly status: number;
+    readonly method: string;
+    readonly path: string;
+    constructor(status: number, method: string, path: string, statusText: string);
+}
+/** The quota-today read-model: usage, the configured limit (null → unlimited), and USD spend. */
+type QuotaToday = QuotaView;
+interface CancelResult {
+    aborted: boolean;
+}
+interface OkResult {
+    ok: boolean;
+}
+interface AgentClientOptions {
+    /** Origin + base path, e.g. `https://api.example.com`. Defaults to `''`. */
+    baseUrl?: string;
+    /** Static headers merged into every request. */
+    headers?: Record<string, string>;
+    /**
+     * Resolved per request — for short-lived bearer tokens, or a CSRF header read from a cookie
+     * (`{ 'X-XSRF-TOKEN': readCookie('XSRF-TOKEN') }`), which has to be read at request time because
+     * the server may rotate it.
+     */
+    getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
+    /**
+     * Forwarded to fetch so cookie auth works. Same-origin requests send cookies by default; set
+     * `'include'` when the API lives on another origin (and have it answer with credentialed CORS).
+     */
+    credentials?: RequestCredentials;
+    /** Injectable for tests / non-browser runtimes. */
+    fetch?: typeof fetch;
+    /**
+     * How `uploadAttachment` uploads. Omitted → `POST <base>/agent/attachments` (multipart). Pass
+     * `mediaAttachments()` from `@dudousxd/nestjs-agent-react/media` for resumable uploads through
+     * nestjs-media, or your own {@link AttachmentUploadStrategy}.
+     */
+    attachments?: AttachmentUploadStrategy;
+}
+/**
+ * Framework-agnostic REST client for the nestjs-agent endpoints — the default {@link AgentBackend}.
+ * Used by `useAgentChat`, but standalone-usable (vanilla fetch, no React).
+ */
+declare class AgentClient implements AgentBackend {
+    private readonly options;
+    constructor(options?: AgentClientOptions);
+    /** `POST /agent/chat` → the turn's SSE stream. Throws {@link AgentHttpError} on a non-2xx. */
+    openChatStream(request: ChatStreamRequest): Promise<ChatStreamResponse>;
+    /**
+     * `GET /agent/chat/:runId/stream[?after=<seq>]` → the run's SSE stream, or `null` when nothing is
+     * streaming under that id (404).
+     */
+    resumeChatStream(request: ResumeStreamRequest): Promise<ChatStreamResponse | null>;
+    /**
+     * Rate a message (`'up'`/`'down'`, optional comment) or clear its rating (`value: null`). Answers
+     * the stored rating.
+     */
+    setMessageFeedback(messageId: string, input: MessageFeedbackInput): Promise<{
+        feedback: MessageFeedback | null;
+    }>;
+    listThreads(): Promise<ThreadSummary[]>;
+    /**
+     * The skills this caller can invoke right now, scope-resolved — the same list, built by the same
+     * call, that the model is offered, so what a user can type after a `/` and what the agent can
+     * reach cannot drift apart. `threadId` reaches the host's own resolver, which may scope a skill to
+     * one conversation; omitted, the server reads it as a brand-new thread.
+     */
+    listSkills(threadId?: string): Promise<SkillCatalogEntry[]>;
+    /**
+     * The tools this caller can reach through `agent` (the default agent when omitted), each with the
+     * server-declared `presentation` a chat narrates it by — the same list the model is offered.
+     * Prefer {@link useToolCatalog}, which fetches it once and shares it.
+     */
+    listTools(agent?: string): Promise<ToolCatalogEntry[]>;
+    getThread(id: string): Promise<ThreadDetail>;
+    deleteThread(id: string): Promise<void>;
+    forkFromMessage(threadId: string, messageId: string): Promise<ThreadSummary>;
+    renameThread(id: string, title: string): Promise<OkResult>;
+    /** General `PATCH /agent/threads/:threadId` — title and/or the thread's pinned default agent. */
+    updateThread(id: string, patch: ThreadPatch): Promise<OkResult>;
+    /**
+     * Uploads a file (image/PDF) for a vision-capable model turn. Multipart, field name `file` —
+     * mirrors the backend's `POST /agent/attachments`. The returned {@link MessageAttachment} is
+     * what a caller then rides on `sendMessage({ text }, { body: { attachments: [...] } })`.
+     */
+    uploadAttachment(file: File, options?: UploadAttachmentOptions): Promise<MessageAttachment>;
+    private uploadWithProgress;
+    promoteThread(id: string): Promise<OkResult>;
+    truncateFromMessage(threadId: string, messageId: string): Promise<OkResult>;
+    /** `GET /agent/models?agent=` — the models this caller may pick, grouped by provider. */
+    listModels(agent?: string): Promise<ModelCatalogView>;
+    /** `GET /agent/agents` — the registered agents, the default one flagged. */
+    listAgents(): Promise<AgentCatalogEntry[]>;
+    /** `GET /agent/quota` — the caller's budget windows and the one blocking sends, if any. */
+    getQuota(): Promise<QuotaReport>;
+    getQuotaToday(): Promise<QuotaToday>;
+    cancelStream(runId: string): Promise<CancelResult>;
+    /**
+     * `remember` approves later calls of the same tool in the same thread; `via` names the surface
+     * the decision came through (the server records `'web'` when omitted).
+     */
+    approveToolCall(input: {
+        toolCallId: string;
+        remember?: boolean;
+        via?: string;
+    }): Promise<void>;
+    rejectToolCall(input: {
+        toolCallId: string;
+        reason?: string;
+        via?: string;
+    }): Promise<void>;
+    /**
+     * Settle a parked question set. `answers` is questionId → chosen option values; a question left
+     * out takes the pre-picked default the request carried, resolved server-side against the request
+     * the run already holds. Omit the whole object and the user has confirmed every pre-picked
+     * answer — which is the point of the surface, so it is a valid submission rather than a blank.
+     */
+    answerToolCall(input: {
+        toolCallId: string;
+        answers?: Record<string, string[]>;
+    }): Promise<void>;
+    /**
+     * Decline to answer and let the agent proceed on its own pre-picked values. Lands on the same
+     * values a confirmation would, and persists differently on purpose — only one of them is
+     * evidence the user chose them.
+     */
+    skipToolCall(input: {
+        toolCallId: string;
+    }): Promise<void>;
+    private fetchImpl;
+    /** This client's connection, for an {@link AttachmentUploadStrategy}. */
+    private connection;
+    private baseUrl;
+    private resolveHeaders;
+    private credentials;
+    private request;
+    private handleResponse;
+}
+
+export { type AgentBackend as A, type CancelResult as C, type MessageFeedbackInput as M, type QuotaToday as Q, type ResumeStreamRequest as R, type ThreadPatch as T, type UploadAttachmentOptions as U, AgentClient as a, type AttachmentUploadStrategy as b, AgentBackendUnsupportedError as c, type AgentClientOptions as d, type AgentConnection as e, AgentHttpError as f, type ChatStreamRequest as g, type ChatStreamResponse as h, requireBackendMethod as r };