@burdenoff/fluidgrids-fe-sdk 2026.1111.16 → 2026.1111.17

package/README.md

@@ -304,6 +304,47 @@ if (route && workspaceId && workspaceToken) {
 - Without a started read the builder sends its read itself, on its own request
   (`context: { sendUnbatched: true }`), so a batching host client does not hold it.
 
+## Workflow pages as lazy modules
+
+A host that mounts the workflow pages on its own routes (microfe-workflows does)
+should take them from `./workflow-pages`. Each page there is its own lazy module
+under the main barrel's name, so a route loads only its own page instead of every
+page of the SDK. Render them inside a `<Suspense>` boundary.
+
+```tsx
+import { Suspense } from "react";
+import { Route, Routes } from "react-router";
+import {
+  WorkflowBuilderPage,
+  WorkflowsList,
+} from "@burdenoff/fluidgrids-fe-sdk/workflow-pages";
+
+<Suspense fallback={<Loading />}>
+  <Routes>
+    <Route path="list" element={<WorkflowsList />} />
+    <Route path="workflow/:id/:version" element={<WorkflowBuilderPage />} />
+  </Routes>
+</Suspense>;
+```
+
+- `preloadWorkflowPage(name)` starts a page's code without rendering it, for a
+  host that knows the route before it renders (at boot, on a cold load). The page
+  then renders from the same load. It never rejects; a failed load is left to the
+  page, which retries a failed chunk twice and then throws to the nearest error
+  boundary.
+- The entry imports no SDK module statically, so it can sit on a host's entry.
+
+`./workflow-host` carries what such a host wires around the pages: the config and
+client setters (`setFluidGridsConfig`, `setFluidGridsClient`,
+`setGlobalStoreClient` and their resets), `refreshNodeRegistry` (reloads the
+builder's node palette for new clients once the builder has loaded it), the
+translation, permissions and managed AI authority providers,
+`FLUIDGRIDS_PERMISSIONS`, and the flags the routes read. It shares its state
+with the pages and the main entry.
+
+`./flags` carries only the FluidGrids feature flag hooks, for a shell that reads
+a flag on every page (for example to list a navigation item).
+
 ## Agent tools (optional)
 
 `./agent-tools` carries FluidGrids' AI agent tools (`createFluidGridsAgentTools`)