@forgebook/react 0.2.1 → 0.2.3

package/README.md

@@ -3,7 +3,7 @@
 React for [Forgebook](https://www.npmjs.com/package/forgebook): the story types, the renderer the frame mounts a story
 with, and the adapter that reads a React component's props from its TypeScript types.
 
-**Requirements:** React 18.2 or 19 · `forgebook` · Vite 8 · [MIT licence](https://github.com/ensiria/forgebook/blob/develop/packages/react/LICENSE)
+**Requirements:** React 18.2 or 19 · `forgebook` · Vite 8.3.4+ · [MIT licence](https://github.com/ensiria/forgebook/blob/develop/packages/react/LICENSE)
 
 ```sh
 npm install --save-dev forgebook @forgebook/react

package/dist/src/reactRenderer.d.ts

@@ -8,6 +8,20 @@
  *
  * @module
  */
-import type { StoryRenderer } from "forgebook/renderer";
+import type { StoryDrawing, StoryRenderer } from "forgebook/renderer";
+/**
+ * A story's HTML once everything it waits for came, as a framework's server sends a page: for an adapter whose stories
+ * wait for data while they render, which `renderToString` gives up on.
+ *
+ * @remarks
+ * Every render error fails it, one inside a `Suspense` boundary too: a real server would hand that boundary to the
+ * browser to try again, which a server test has none of.
+ *
+ * @param drawing - the story.
+ * @param signal - gives up on what still waits.
+ * @returns the HTML.
+ * @throws the first error of the render.
+ */
+export declare const awaitedRenderToString: (drawing: StoryDrawing, signal: AbortSignal) => Promise<string>;
 /** React as the frame draws with it and the server tests render with it. */
 export declare const reactRenderer: StoryRenderer;

package/dist/src/reactRenderer.js

@@ -12,6 +12,37 @@ import { storyContextOf } from "forgebook/renderer";
 import { reactFrameRenderer } from "./reactFrameRenderer.js";
 import { storyElement } from "./storyElement.js";
 import { inProviders } from "./storyProviders.js";
+/**
+ * A story's HTML once everything it waits for came, as a framework's server sends a page: for an adapter whose stories
+ * wait for data while they render, which `renderToString` gives up on.
+ *
+ * @remarks
+ * Every render error fails it, one inside a `Suspense` boundary too: a real server would hand that boundary to the
+ * browser to try again, which a server test has none of.
+ *
+ * @param drawing - the story.
+ * @param signal - gives up on what still waits.
+ * @returns the HTML.
+ * @throws the first error of the render.
+ */
+export const awaitedRenderToString = async (drawing, signal) => {
+    // the entry for a server with web streams: Node's own has them only from React 19.2
+    const { renderToReadableStream } = await import("react-dom/server.edge");
+    const context = storyContextOf(drawing, drawing.args, () => document.body);
+    const errors = [];
+    const stream = await renderToReadableStream(inProviders(drawing, storyElement(drawing.story, context, drawing.decorators)), 
+    // no chunk limit: past it React writes a boundary apart, its fallback and a script in the HTML, however long it waited
+    {
+        signal,
+        progressiveChunkSize: Number.POSITIVE_INFINITY,
+        onError: (error) => void errors.push(error)
+    });
+    // read before everything came, the stream would hold fallbacks too
+    await stream.allReady;
+    if (errors.length > 0)
+        throw errors[0];
+    return await new Response(stream).text();
+};
 /** React as the frame draws with it and the server tests render with it. */
 export const reactRenderer = {
     ...reactFrameRenderer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forgebook/react",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Forgebook for React: the story types and hooks, the renderer the frame mounts a story with, and the adapter that reads a React component's props.",
   "license": "MIT",
   "repository": {
@@ -60,12 +60,12 @@
   },
   "dependencies": {
     "@vitejs/plugin-react": "6.1.2",
-    "@forgebook/story-format": "0.2.1"
+    "@forgebook/story-format": "0.2.3"
   },
   "peerDependencies": {
     "react": "^18.2.0 || ^19.0.0",
     "react-dom": "^18.2.0 || ^19.0.0",
-    "forgebook": "^0.3.0"
+    "forgebook": "^0.3.2"
   },
   "devDependencies": {
     "@types/node": "24.19.2",
@@ -76,10 +76,10 @@
     "react-dom": "19.3.0",
     "vite": "8.3.5",
     "vitest": "5.0.5",
+    "@forgebook/testing": "0.2.3",
     "@forgebook/tools": "0.0.0",
     "@forgebook/typescript-config": "0.0.0",
-    "forgebook": "0.3.0",
-    "@forgebook/testing": "0.2.1"
+    "forgebook": "0.3.2"
   },
   "publishConfig": {
     "access": "public"