@dudousxd/nestjs-agent-react 0.19.0 → 0.21.0

package/dist/client-ePlgRwP-.d.ts

@@ -0,0 +1,302 @@
+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 {
+    /** The server's origin, trailing slash removed (`''` for same-origin). */
+    baseUrl: string;
+    /** The agent's route prefix, normalized to a leading slash (`'/agent'`), or `''`. */
+    path: 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 <path>/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 `<AgentProvider backend>` (or
+ * per hook, `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 {
+    /**
+     * The server's origin, e.g. `https://api.example.com`. Defaults to `''` (same origin). The
+     * agent's route prefix is {@link AgentClientOptions.path}, not part of this.
+     */
+    baseUrl?: string;
+    /**
+     * The agent's route prefix — `AgentModule`'s `path`, with any global prefix in front
+     * (`'api/agent'`). Leading/trailing slashes are optional. Defaults to `'agent'`.
+     */
+    path?: 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;
+    /** Attachment uploads. */
+    attachments?: {
+        /**
+         * How `uploadAttachment` uploads. Omitted → `POST <path>/attachments` (multipart). Pass
+         * `mediaAttachments()` from `@dudousxd/nestjs-agent-react/media` for resumable uploads through
+         * nestjs-media, or your own {@link AttachmentUploadStrategy}.
+         */
+        upload?: 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 <path>/chat` → the turn's SSE stream. Throws {@link AgentHttpError} on a non-2xx. */
+    openChatStream(request: ChatStreamRequest): Promise<ChatStreamResponse>;
+    /**
+     * `GET <path>/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 <path>/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 <path>/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 <path>/models?agent=` — the models this caller may pick, grouped by provider. */
+    listModels(agent?: string): Promise<ModelCatalogView>;
+    /** `GET <path>/agents` — the registered agents, the default one flagged. */
+    listAgents(): Promise<AgentCatalogEntry[]>;
+    /** `GET <path>/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 agentPath;
+    /** Origin + agent path: what every route hangs off. */
+    private root;
+    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, type AttachmentUploadStrategy as a, AgentBackendUnsupportedError as b, AgentClient as c, type AgentClientOptions as d, type AgentConnection as e, AgentHttpError as f, type ChatStreamRequest as g, type ChatStreamResponse as h, requireBackendMethod as r };

package/dist/{model-gHqjNjLJ.d.cts → generative-ui-9AJNVKBZ.d.cts}

@@ -1,3 +1,5 @@
+import * as React from 'react';
+import { ComponentType, ReactNode } from 'react';
 import { ElicitationQuestion, ElicitationInputType, ToolPresentation, ToolCatalogEntry, ToolResultField, ToolResultView, ToolPresentationTone, ElicitationInput } from '@dudousxd/nestjs-agent-core';
 import { ToolUIPart, DynamicToolUIPart, UIMessage } from 'ai';
 
@@ -558,4 +560,166 @@ declare function describeTimestamp(createdAt: string | null | undefined): Timest
  */
 declare function formatRelativeTime(date: Date): string;
 
-export { resolveResultView as $, type ApproveOptions as A, type BuildBlocksOptions as B, type ChatStatus as C, type DescribeToolCallOptions as D, type ElicitationBlockOptions as E, type TranscriptToolBlock as F, type GroupToolActivityOptions as G, type TranscriptToolCall as H, buildTranscriptBlocks as I, coerceAnswer as J, correctedCallIds as K, describeTimestamp as L, type MessageUsageInfo as M, describeToolCall as N, describeUsage as O, extractMessageText as P, fillTemplate as Q, type RawAnswer as R, type SettleAction as S, type TranscriptUiBlock as T, type UsageSummary as U, formatRelativeTime as V, groupToolActivity as W, inferResultView as X, isActionCall as Y, phraseFor as Z, readPath as _, type TranscriptBlock as a, toolCallState as a0, toolCatalogFrom as a1, type TimestampInfo as b, type ToolCatalog as c, type AnyToolUIPart as d, type TranscriptFile as e, type ApprovalBlockOptions as f, type CoercibleQuestion as g, type ResolvedReading as h, type ResolvedResultView as i, type RetrievedPassage as j, type ToolActivityGroup as k, type ToolCallDescription as l, type ToolCallState as m, type ToolCallStatus as n, type TranscriptApproval as o, type TranscriptApprovalStatus as p, type TranscriptElicitationBlock as q, type TranscriptElicitationOutcome as r, type TranscriptFilesBlock as s, type TranscriptQuestion as t, type TranscriptQuestionOption as u, type TranscriptReasoningBlock as v, type TranscriptSettleState as w, type TranscriptSource as x, type TranscriptSourcesBlock as y, type TranscriptTextBlock as z };
+/** The `ui` frame component a composed tree is pushed under (`GENUI_TREE_COMPONENT` of `@dudousxd/nestjs-agent-core/genui`). */
+declare const GENUI_TREE_COMPONENT = "genui:tree";
+/** One pushed component, normalized from whatever carried it (a transcript block, a `data-ui` part, a stored entry). */
+interface GenerativeUIItem {
+    id: string;
+    component: string;
+    props: Record<string, unknown>;
+    version: number | null;
+    toolCallId: string | null;
+}
+/** A node of a composed tree (`genui:tree` frames): `{ type, props, children? }`. */
+interface GenerativeUIElement {
+    type: string;
+    props: Record<string, unknown>;
+    children?: GenerativeUIElement[];
+}
+/**
+ * An app's renderer for one component: it receives the component's props spread, plus `children`
+ * when it is a layout node in a tree. Any React component — the library never styles anything.
+ */
+type GenuiRenderer<P = any> = ComponentType<P & {
+    children?: ReactNode;
+}>;
+/** Component name → the app's renderer. */
+type GenuiRegistry = Record<string, GenuiRenderer>;
+/**
+ * Resolve a component the registry does not have — typically a tenant's own component, fetched for
+ * the exact `version` a message was rendered with. Return `null`/`undefined` for "no such
+ * component". May be async; results are cached per resolver, name and version.
+ */
+type ResolveComponent = (name: string, version: number | null) => GenuiRenderer | null | undefined | Promise<GenuiRenderer | null | undefined>;
+interface GenuiIssueLike {
+    path: (string | number)[];
+    message: string;
+}
+type ValidationLike = {
+    ok: true;
+    value: Record<string, unknown>;
+} | {
+    ok: false;
+    issues: GenuiIssueLike[];
+};
+/**
+ * What the renderer needs from a catalog to validate props before drawing them. A `Catalog` from
+ * `@dudousxd/nestjs-agent-core/genui` satisfies it; declared structurally so any catalog-shaped
+ * object does too.
+ */
+interface GenuiCatalogLike {
+    has(name: string): boolean;
+    validate(name: string, props: unknown): Promise<ValidationLike>;
+    validateSync?(name: string, props: unknown): ValidationLike | undefined;
+}
+interface GenerativeUIOptions {
+    registry: GenuiRegistry;
+    /** Validate props against it before rendering. Components the catalog does not know render unvalidated. */
+    catalog?: GenuiCatalogLike;
+    resolveComponent?: ResolveComponent;
+    /**
+     * Draws a composed tree frame (`genui:tree`) whole — e.g. through json-render (see the
+     * `/genui/json-render` subpath's `GenuiProvider`). Omitted → trees render node by node through
+     * `registry`.
+     */
+    treeRenderer?: GenuiRenderer<{
+        root?: GenerativeUIElement;
+    }>;
+}
+/** Why an item did not render. */
+type GenerativeUIProblem = {
+    reason: 'unknown';
+    item: GenerativeUIItem;
+} | {
+    reason: 'invalid';
+    item: GenerativeUIItem;
+    issues: GenuiIssueLike[];
+} | {
+    reason: 'error';
+    item: GenerativeUIItem;
+    error: unknown;
+};
+type GenerativeUIState = {
+    status: 'ready';
+    item: GenerativeUIItem;
+    Component: GenuiRenderer;
+    props: Record<string, unknown>;
+} | {
+    status: 'loading';
+    item: GenerativeUIItem;
+} | ({
+    status: 'problem';
+} & GenerativeUIProblem);
+
+/** What to draw instead of a component that did not render. Default: nothing. */
+type GenerativeUIFallback = ReactNode | ((problem: GenerativeUIProblem) => ReactNode);
+/**
+ * Renders a `genui:tree` frame's `{ root }` node by node through the same registry, catalog and
+ * resolver as top-level components. Used automatically for tree frames unless a `treeRenderer`
+ * (e.g. the json-render one) or a registry entry for `genui:tree` takes over.
+ */
+declare function GenuiTree({ root }: {
+    root?: GenerativeUIElement;
+}): React.JSX.Element | null;
+interface GenerativeUIScopeProps extends GenerativeUIOptions {
+    fallback?: GenerativeUIFallback;
+    loading?: ReactNode;
+    onError?: (error: unknown, item: GenerativeUIItem) => void;
+    children?: ReactNode;
+}
+/**
+ * The registry, catalog and fallbacks tree nodes render with. `<GenerativeUI>` provides it; wrap
+ * your own chrome in it when you draw `useGenerativeUI`'s `Component` yourself and it may be a tree.
+ */
+declare function GenerativeUIScope({ registry, catalog, resolveComponent, fallback, loading, onError, children, }: GenerativeUIScopeProps): React.JSX.Element;
+/** What `<GenuiProvider>` hands every `<GenerativeUI>` / `useGenerativeUI` below it. */
+interface GenuiProviderValue extends Partial<GenerativeUIOptions> {
+    fallback?: GenerativeUIFallback;
+    loading?: ReactNode;
+    onError?: (error: unknown, item: GenerativeUIItem) => void;
+}
+/** The enclosing `<GenuiProvider>`'s settings, or `null` outside one. */
+declare function useGenuiProvider(): GenuiProviderValue | null;
+interface GenuiProviderProps extends GenuiProviderValue {
+    children?: ReactNode;
+}
+/**
+ * Set generative UI up once, at the app root: the registry of your renderers, the catalog to
+ * validate against, a resolver for components the registry lacks, and what to draw when one does
+ * not render. Every `<GenerativeUI>` below reads it (its own props still win), and `MessageItem` /
+ * `MessageList` draw pushed components with it — no `renderUi` per message.
+ *
+ * ```tsx
+ * <GenuiProvider registry={registry} catalog={catalog} fallback={({ item }) => <Unknown name={item.component} />}>
+ *   <App />
+ * </GenuiProvider>
+ * ```
+ */
+declare function GenuiProvider({ registry, catalog, resolveComponent, treeRenderer, fallback, loading, onError, children, }: GenuiProviderProps): React.JSX.Element;
+/**
+ * The headless half of {@link GenerativeUI}: what to draw for one pushed component, or `null` when
+ * `part` is not one. Options default to the enclosing `<GenuiProvider>`'s.
+ */
+declare function useGenerativeUI(part: unknown, options?: Partial<GenerativeUIOptions>): GenerativeUIState | null;
+interface GenerativeUIProps extends Partial<GenerativeUIOptions> {
+    /** A transcript `ui` block, a `data-ui` message part, or a stored `{ id, component, props, version? }`. */
+    part: TranscriptUiBlock | GenerativeUIItem | unknown;
+    /** Drawn for an unknown component, invalid props, or a renderer that threw. Default: the provider's, else nothing. */
+    fallback?: GenerativeUIFallback;
+    /** Drawn while a resolver or an async validation is pending. Default: the provider's, else nothing. */
+    loading?: ReactNode;
+    /** A renderer threw (the item shows `fallback`). */
+    onError?: (error: unknown, item: GenerativeUIItem) => void;
+}
+/**
+ * Draws one server-pushed component with the app's own renderer. Headless: it adds no element and
+ * no style of its own — only what the registry's component renders (and whatever `fallback` /
+ * `loading` you pass). Everything but `part` defaults to the enclosing `<GenuiProvider>`.
+ *
+ * ```tsx
+ * <GenerativeUI part={block} />
+ * ```
+ */
+declare function GenerativeUI({ part, registry, catalog, resolveComponent, treeRenderer, fallback: ownFallback, loading: ownLoading, onError: ownOnError, }: GenerativeUIProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | React.JSX.Element | null | undefined;
+
+export { type TranscriptQuestionOption as $, type ApproveOptions as A, type BuildBlocksOptions as B, type ChatStatus as C, type CoercibleQuestion as D, type DescribeToolCallOptions as E, type ElicitationBlockOptions as F, type GenerativeUIItem as G, type GroupToolActivityOptions as H, type RawAnswer as I, type ResolvedReading as J, type ResolvedResultView as K, type RetrievedPassage as L, type MessageUsageInfo as M, type ToolActivityGroup as N, type ToolCallDescription as O, type ToolCallState as P, type ToolCallStatus as Q, type ResolveComponent as R, type SettleAction as S, type TranscriptUiBlock as T, type UsageSummary as U, type TranscriptApproval as V, type TranscriptApprovalStatus as W, type TranscriptElicitationBlock as X, type TranscriptElicitationOutcome as Y, type TranscriptFilesBlock as Z, type TranscriptQuestion as _, GENUI_TREE_COMPONENT as a, type TranscriptReasoningBlock as a0, type TranscriptSettleState as a1, type TranscriptSource as a2, type TranscriptSourcesBlock as a3, type TranscriptTextBlock as a4, type TranscriptToolBlock as a5, type TranscriptToolCall as a6, buildTranscriptBlocks as a7, coerceAnswer as a8, correctedCallIds as a9, describeTimestamp as aa, describeToolCall as ab, describeUsage as ac, extractMessageText as ad, fillTemplate as ae, formatRelativeTime as af, groupToolActivity as ag, inferResultView as ah, isActionCall as ai, phraseFor as aj, readPath as ak, resolveResultView as al, toolCallState as am, toolCatalogFrom as an, GenerativeUI as b, type GenerativeUIElement as c, type GenerativeUIFallback as d, type GenerativeUIOptions as e, type GenerativeUIProblem as f, type GenerativeUIProps as g, GenerativeUIScope as h, type GenerativeUIScopeProps as i, type GenerativeUIState as j, type GenuiCatalogLike as k, type GenuiIssueLike as l, GenuiProvider as m, type GenuiProviderProps as n, type GenuiProviderValue as o, type GenuiRegistry as p, type GenuiRenderer as q, GenuiTree as r, useGenuiProvider as s, type TranscriptBlock as t, useGenerativeUI as u, type TimestampInfo as v, type ToolCatalog as w, type AnyToolUIPart as x, type TranscriptFile as y, type ApprovalBlockOptions as z };

package/dist/{model-gHqjNjLJ.d.ts → generative-ui-9AJNVKBZ.d.ts}

@@ -1,3 +1,5 @@
+import * as React from 'react';
+import { ComponentType, ReactNode } from 'react';
 import { ElicitationQuestion, ElicitationInputType, ToolPresentation, ToolCatalogEntry, ToolResultField, ToolResultView, ToolPresentationTone, ElicitationInput } from '@dudousxd/nestjs-agent-core';
 import { ToolUIPart, DynamicToolUIPart, UIMessage } from 'ai';
 
@@ -558,4 +560,166 @@ declare function describeTimestamp(createdAt: string | null | undefined): Timest
  */
 declare function formatRelativeTime(date: Date): string;
 
-export { resolveResultView as $, type ApproveOptions as A, type BuildBlocksOptions as B, type ChatStatus as C, type DescribeToolCallOptions as D, type ElicitationBlockOptions as E, type TranscriptToolBlock as F, type GroupToolActivityOptions as G, type TranscriptToolCall as H, buildTranscriptBlocks as I, coerceAnswer as J, correctedCallIds as K, describeTimestamp as L, type MessageUsageInfo as M, describeToolCall as N, describeUsage as O, extractMessageText as P, fillTemplate as Q, type RawAnswer as R, type SettleAction as S, type TranscriptUiBlock as T, type UsageSummary as U, formatRelativeTime as V, groupToolActivity as W, inferResultView as X, isActionCall as Y, phraseFor as Z, readPath as _, type TranscriptBlock as a, toolCallState as a0, toolCatalogFrom as a1, type TimestampInfo as b, type ToolCatalog as c, type AnyToolUIPart as d, type TranscriptFile as e, type ApprovalBlockOptions as f, type CoercibleQuestion as g, type ResolvedReading as h, type ResolvedResultView as i, type RetrievedPassage as j, type ToolActivityGroup as k, type ToolCallDescription as l, type ToolCallState as m, type ToolCallStatus as n, type TranscriptApproval as o, type TranscriptApprovalStatus as p, type TranscriptElicitationBlock as q, type TranscriptElicitationOutcome as r, type TranscriptFilesBlock as s, type TranscriptQuestion as t, type TranscriptQuestionOption as u, type TranscriptReasoningBlock as v, type TranscriptSettleState as w, type TranscriptSource as x, type TranscriptSourcesBlock as y, type TranscriptTextBlock as z };
+/** The `ui` frame component a composed tree is pushed under (`GENUI_TREE_COMPONENT` of `@dudousxd/nestjs-agent-core/genui`). */
+declare const GENUI_TREE_COMPONENT = "genui:tree";
+/** One pushed component, normalized from whatever carried it (a transcript block, a `data-ui` part, a stored entry). */
+interface GenerativeUIItem {
+    id: string;
+    component: string;
+    props: Record<string, unknown>;
+    version: number | null;
+    toolCallId: string | null;
+}
+/** A node of a composed tree (`genui:tree` frames): `{ type, props, children? }`. */
+interface GenerativeUIElement {
+    type: string;
+    props: Record<string, unknown>;
+    children?: GenerativeUIElement[];
+}
+/**
+ * An app's renderer for one component: it receives the component's props spread, plus `children`
+ * when it is a layout node in a tree. Any React component — the library never styles anything.
+ */
+type GenuiRenderer<P = any> = ComponentType<P & {
+    children?: ReactNode;
+}>;
+/** Component name → the app's renderer. */
+type GenuiRegistry = Record<string, GenuiRenderer>;
+/**
+ * Resolve a component the registry does not have — typically a tenant's own component, fetched for
+ * the exact `version` a message was rendered with. Return `null`/`undefined` for "no such
+ * component". May be async; results are cached per resolver, name and version.
+ */
+type ResolveComponent = (name: string, version: number | null) => GenuiRenderer | null | undefined | Promise<GenuiRenderer | null | undefined>;
+interface GenuiIssueLike {
+    path: (string | number)[];
+    message: string;
+}
+type ValidationLike = {
+    ok: true;
+    value: Record<string, unknown>;
+} | {
+    ok: false;
+    issues: GenuiIssueLike[];
+};
+/**
+ * What the renderer needs from a catalog to validate props before drawing them. A `Catalog` from
+ * `@dudousxd/nestjs-agent-core/genui` satisfies it; declared structurally so any catalog-shaped
+ * object does too.
+ */
+interface GenuiCatalogLike {
+    has(name: string): boolean;
+    validate(name: string, props: unknown): Promise<ValidationLike>;
+    validateSync?(name: string, props: unknown): ValidationLike | undefined;
+}
+interface GenerativeUIOptions {
+    registry: GenuiRegistry;
+    /** Validate props against it before rendering. Components the catalog does not know render unvalidated. */
+    catalog?: GenuiCatalogLike;
+    resolveComponent?: ResolveComponent;
+    /**
+     * Draws a composed tree frame (`genui:tree`) whole — e.g. through json-render (see the
+     * `/genui/json-render` subpath's `GenuiProvider`). Omitted → trees render node by node through
+     * `registry`.
+     */
+    treeRenderer?: GenuiRenderer<{
+        root?: GenerativeUIElement;
+    }>;
+}
+/** Why an item did not render. */
+type GenerativeUIProblem = {
+    reason: 'unknown';
+    item: GenerativeUIItem;
+} | {
+    reason: 'invalid';
+    item: GenerativeUIItem;
+    issues: GenuiIssueLike[];
+} | {
+    reason: 'error';
+    item: GenerativeUIItem;
+    error: unknown;
+};
+type GenerativeUIState = {
+    status: 'ready';
+    item: GenerativeUIItem;
+    Component: GenuiRenderer;
+    props: Record<string, unknown>;
+} | {
+    status: 'loading';
+    item: GenerativeUIItem;
+} | ({
+    status: 'problem';
+} & GenerativeUIProblem);
+
+/** What to draw instead of a component that did not render. Default: nothing. */
+type GenerativeUIFallback = ReactNode | ((problem: GenerativeUIProblem) => ReactNode);
+/**
+ * Renders a `genui:tree` frame's `{ root }` node by node through the same registry, catalog and
+ * resolver as top-level components. Used automatically for tree frames unless a `treeRenderer`
+ * (e.g. the json-render one) or a registry entry for `genui:tree` takes over.
+ */
+declare function GenuiTree({ root }: {
+    root?: GenerativeUIElement;
+}): React.JSX.Element | null;
+interface GenerativeUIScopeProps extends GenerativeUIOptions {
+    fallback?: GenerativeUIFallback;
+    loading?: ReactNode;
+    onError?: (error: unknown, item: GenerativeUIItem) => void;
+    children?: ReactNode;
+}
+/**
+ * The registry, catalog and fallbacks tree nodes render with. `<GenerativeUI>` provides it; wrap
+ * your own chrome in it when you draw `useGenerativeUI`'s `Component` yourself and it may be a tree.
+ */
+declare function GenerativeUIScope({ registry, catalog, resolveComponent, fallback, loading, onError, children, }: GenerativeUIScopeProps): React.JSX.Element;
+/** What `<GenuiProvider>` hands every `<GenerativeUI>` / `useGenerativeUI` below it. */
+interface GenuiProviderValue extends Partial<GenerativeUIOptions> {
+    fallback?: GenerativeUIFallback;
+    loading?: ReactNode;
+    onError?: (error: unknown, item: GenerativeUIItem) => void;
+}
+/** The enclosing `<GenuiProvider>`'s settings, or `null` outside one. */
+declare function useGenuiProvider(): GenuiProviderValue | null;
+interface GenuiProviderProps extends GenuiProviderValue {
+    children?: ReactNode;
+}
+/**
+ * Set generative UI up once, at the app root: the registry of your renderers, the catalog to
+ * validate against, a resolver for components the registry lacks, and what to draw when one does
+ * not render. Every `<GenerativeUI>` below reads it (its own props still win), and `MessageItem` /
+ * `MessageList` draw pushed components with it — no `renderUi` per message.
+ *
+ * ```tsx
+ * <GenuiProvider registry={registry} catalog={catalog} fallback={({ item }) => <Unknown name={item.component} />}>
+ *   <App />
+ * </GenuiProvider>
+ * ```
+ */
+declare function GenuiProvider({ registry, catalog, resolveComponent, treeRenderer, fallback, loading, onError, children, }: GenuiProviderProps): React.JSX.Element;
+/**
+ * The headless half of {@link GenerativeUI}: what to draw for one pushed component, or `null` when
+ * `part` is not one. Options default to the enclosing `<GenuiProvider>`'s.
+ */
+declare function useGenerativeUI(part: unknown, options?: Partial<GenerativeUIOptions>): GenerativeUIState | null;
+interface GenerativeUIProps extends Partial<GenerativeUIOptions> {
+    /** A transcript `ui` block, a `data-ui` message part, or a stored `{ id, component, props, version? }`. */
+    part: TranscriptUiBlock | GenerativeUIItem | unknown;
+    /** Drawn for an unknown component, invalid props, or a renderer that threw. Default: the provider's, else nothing. */
+    fallback?: GenerativeUIFallback;
+    /** Drawn while a resolver or an async validation is pending. Default: the provider's, else nothing. */
+    loading?: ReactNode;
+    /** A renderer threw (the item shows `fallback`). */
+    onError?: (error: unknown, item: GenerativeUIItem) => void;
+}
+/**
+ * Draws one server-pushed component with the app's own renderer. Headless: it adds no element and
+ * no style of its own — only what the registry's component renders (and whatever `fallback` /
+ * `loading` you pass). Everything but `part` defaults to the enclosing `<GenuiProvider>`.
+ *
+ * ```tsx
+ * <GenerativeUI part={block} />
+ * ```
+ */
+declare function GenerativeUI({ part, registry, catalog, resolveComponent, treeRenderer, fallback: ownFallback, loading: ownLoading, onError: ownOnError, }: GenerativeUIProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | React.JSX.Element | null | undefined;
+
+export { type TranscriptQuestionOption as $, type ApproveOptions as A, type BuildBlocksOptions as B, type ChatStatus as C, type CoercibleQuestion as D, type DescribeToolCallOptions as E, type ElicitationBlockOptions as F, type GenerativeUIItem as G, type GroupToolActivityOptions as H, type RawAnswer as I, type ResolvedReading as J, type ResolvedResultView as K, type RetrievedPassage as L, type MessageUsageInfo as M, type ToolActivityGroup as N, type ToolCallDescription as O, type ToolCallState as P, type ToolCallStatus as Q, type ResolveComponent as R, type SettleAction as S, type TranscriptUiBlock as T, type UsageSummary as U, type TranscriptApproval as V, type TranscriptApprovalStatus as W, type TranscriptElicitationBlock as X, type TranscriptElicitationOutcome as Y, type TranscriptFilesBlock as Z, type TranscriptQuestion as _, GENUI_TREE_COMPONENT as a, type TranscriptReasoningBlock as a0, type TranscriptSettleState as a1, type TranscriptSource as a2, type TranscriptSourcesBlock as a3, type TranscriptTextBlock as a4, type TranscriptToolBlock as a5, type TranscriptToolCall as a6, buildTranscriptBlocks as a7, coerceAnswer as a8, correctedCallIds as a9, describeTimestamp as aa, describeToolCall as ab, describeUsage as ac, extractMessageText as ad, fillTemplate as ae, formatRelativeTime as af, groupToolActivity as ag, inferResultView as ah, isActionCall as ai, phraseFor as aj, readPath as ak, resolveResultView as al, toolCallState as am, toolCatalogFrom as an, GenerativeUI as b, type GenerativeUIElement as c, type GenerativeUIFallback as d, type GenerativeUIOptions as e, type GenerativeUIProblem as f, type GenerativeUIProps as g, GenerativeUIScope as h, type GenerativeUIScopeProps as i, type GenerativeUIState as j, type GenuiCatalogLike as k, type GenuiIssueLike as l, GenuiProvider as m, type GenuiProviderProps as n, type GenuiProviderValue as o, type GenuiRegistry as p, type GenuiRenderer as q, GenuiTree as r, useGenuiProvider as s, type TranscriptBlock as t, useGenerativeUI as u, type TimestampInfo as v, type ToolCatalog as w, type AnyToolUIPart as x, type TranscriptFile as y, type ApprovalBlockOptions as z };

package/dist/genui-json-render.d.cts

@@ -1,7 +1,6 @@
 import * as React from 'react';
 import { ComponentRegistry } from '@json-render/react';
-import { n as GenuiProviderProps$1, c as GenerativeUIElement, q as GenuiRenderer, p as GenuiRegistry } from './generative-ui-C53b3FoA.cjs';
-import './model-gHqjNjLJ.cjs';
+import { n as GenuiProviderProps$1, c as GenerativeUIElement, q as GenuiRenderer, p as GenuiRegistry } from './generative-ui-9AJNVKBZ.cjs';
 import '@dudousxd/nestjs-agent-core';
 import 'ai';