@dudousxd/nestjs-agent-react 0.32.0 → 0.34.0

package/dist/types-DZtFsWec.d.ts

@@ -0,0 +1,99 @@
+import { ComponentType, ReactNode } from 'react';
+
+/** 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 {
+    fallbackText?: string;
+    componentVersions?: Record<string, number>;
+    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 {
+    get?(name: string): {
+        version?: number;
+    } | undefined;
+    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);
+
+export { type GenerativeUIItem as G, type ResolveComponent as R, GENUI_TREE_COMPONENT as a, type GenerativeUIElement as b, type GenerativeUIOptions as c, type GenerativeUIProblem as d, type GenerativeUIState as e, type GenuiCatalogLike as f, type GenuiIssueLike as g, type GenuiRegistry as h, type GenuiRenderer as i };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dudousxd/nestjs-agent-react",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/DavideCarvalho/nestjs-agent.git",
@@ -77,13 +77,33 @@
         "types": "./dist/media.d.cts",
         "default": "./dist/media.cjs"
       }
+    },
+    "./genui/server": {
+      "import": {
+        "types": "./dist/genui-server.d.ts",
+        "default": "./dist/genui-server.js"
+      },
+      "require": {
+        "types": "./dist/genui-server.d.cts",
+        "default": "./dist/genui-server.cjs"
+      }
+    },
+    "./genui/server/playwright": {
+      "import": {
+        "types": "./dist/genui-server-playwright.d.ts",
+        "default": "./dist/genui-server-playwright.js"
+      },
+      "require": {
+        "types": "./dist/genui-server-playwright.d.cts",
+        "default": "./dist/genui-server-playwright.cjs"
+      }
     }
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@dudousxd/nestjs-agent-core": "0.39.0"
+    "@dudousxd/nestjs-agent-core": "0.41.0"
   },
   "peerDependencies": {
     "@ai-sdk/react": "^4.0.0",
@@ -96,13 +116,15 @@
     "katex": "^0.16.45",
     "prism-react-renderer": "^2.4.1",
     "react": ">=18",
+    "react-dom": ">=18",
     "react-markdown": "^10.1.0",
     "rehype-katex": "^7.0.1",
     "rehype-sanitize": "^6.0.0",
     "remark-gfm": "^4.0.1",
     "remark-math": "^6.0.0",
     "streamdown": "^2.5.0",
-    "unist-util-visit": "^5.1.0"
+    "unist-util-visit": "^5.1.0",
+    "playwright-core": ">=1.48 <2"
   },
   "peerDependenciesMeta": {
     "@dudousxd/nestjs-media-client": {
@@ -146,6 +168,12 @@
     },
     "unist-util-visit": {
       "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "playwright-core": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -154,14 +182,16 @@
     "@json-render/core": "0.21.0",
     "@json-render/react": "0.21.0",
     "@streamdown/code": "1.1.1",
-    "@streamdown/math": "1.0.2",
-    "@streamdown/mermaid": "1.0.2",
+    "@streamdown/math": "1.0.3",
+    "@streamdown/mermaid": "1.0.3",
     "@testing-library/dom": "10.4.2",
     "@testing-library/react": "16.3.3",
     "@types/react": "19.3.0",
+    "@types/react-dom": "19.3.0",
     "ai": "7.0.16",
     "jsdom": "26.1.0",
     "katex": "0.16.45",
+    "playwright-core": "^1.63.0",
     "prism-react-renderer": "2.4.1",
     "react": "19.3.0",
     "react-dom": "19.3.0",