@peripheries/renderer 0.29.0 → 0.31.0

package/README.md

@@ -56,6 +56,15 @@ const runtime = await loadPageData(page, source, { params, baseProps, viewer, co
   small "hidden (empty)" placeholder instead of nothing.
 - `showProblemCodes`: a cell's problem notice adds its diagnostic code, for
   staff and editors; without it a viewer reads only the plain wording.
+- `mockCell(cellId)`: a design preview's stand-in for a cell. It returns
+  `{ props?, data? }`: the props are merged over the cell's resolved ones, and
+  `data` becomes its whole data bundle, settled (`isLoading: false`, no error).
+  `context` and `style` are never the mock's to set. A cell it returns nothing
+  for is drawn as the page has it; the page's own reads still run. It is read
+  only in a Vite build made with `VITE_PREVIEW=true` (the host's preview
+  build): a production build replaces the flag with `false` and drops the
+  code, so it adds no bytes to what a phone loads (a build without
+  `import.meta.env` ignores it too).
 
 A consumer with resolved values instead of a graph (the component repos'
 harness) builds its runtime with `pageRuntimeFromValues(page, { values,

package/dist/chunks/{load-CAus-wv_.js → load-BU9C8x6-.js}

@@ -137,25 +137,19 @@ function loadChunked(row, files, plan, wanted) {
 			const doImport = files.import ?? browserImport;
 			const asked = row.components.filter((c) => c.component_name && (wanted === "all" || wanted.has(c.component_name)));
 			const inPlan = asked.every((c) => Object.hasOwn(plan.entries, exportOf(c)));
-			const manifestUrl = `${plan.base}manifest.json`;
 			let manifest = null;
-			if (wanted === "all" || !inPlan) {
-				let m = manifests.get(manifestUrl);
-				if (!m) {
-					m = get(manifestUrl).then(async (r) => {
-						const parsed = r.ok ? parseComponentManifest(await r.json().catch(() => null)) : null;
-						if (!parsed) throw new Error(`[bundles] ${row.org_slug}/${row.bundle_name}: manifest.json is not readable`);
-						return parsed;
-					});
-					m.catch(() => manifests.delete(manifestUrl));
-					manifests.set(manifestUrl, m);
-				}
-				manifest = await m;
-			}
+			if (wanted === "all" || !inPlan) manifest = await manifestOf(row, plan, get);
 			const fileOf = (name) => plan.entries[name] ?? manifest?.components[name]?.js;
 			const exportsWanted = [...new Set([...asked.map(exportOf), ...wanted === "all" && manifest ? BUNDLE_LEVEL_EXPORTS.filter((n) => manifest.components[n]) : []])].filter((n) => fileOf(n));
 			const css = new Set();
 			for (const n of exportsWanted) for (const f of manifest?.components[n]?.css ?? (plan.entries[n] ? plan.css : [])) css.add(f);
+			const closure = new Set();
+			for (const n of exportsWanted) {
+				const m = manifest?.components[n];
+				if (m) for (const f of [m.js, ...m.imports ?? []]) closure.add(f);
+			}
+			if (closure.size) files.preload?.([...closure].map((f) => `${plan.base}${f}`));
+			if (css.size) files.linkStyles?.([...css].map((f) => `${plan.base}${f}`));
 			const contractsUrl = `${plan.base}contracts.json`;
 			let contractsP = contractsOf.get(contractsUrl);
 			if (!contractsP) {
@@ -173,7 +167,6 @@ function loadChunked(row, files, plan, wanted) {
 				return [n, (await m)[n]];
 			});
 			const [loaded, contracts] = await Promise.all([Promise.all(imports), contractsP]);
-			if (css.size) files.linkStyles?.([...css].map((f) => `${plan.base}${f}`));
 			return projectModule(row, Object.fromEntries(loaded), contracts);
 		})();
 		pending.catch(() => chunkedBundles.delete(key));
@@ -181,6 +174,25 @@ function loadChunked(row, files, plan, wanted) {
 	}
 	return pending;
 }
+function manifestOf(row, plan, get) {
+	const manifestUrl = `${plan.base}manifest.json`;
+	let m = manifests.get(manifestUrl);
+	if (!m) {
+		m = get(manifestUrl).then(async (r) => {
+			const parsed = r.ok ? parseComponentManifest(await r.json().catch(() => null)) : null;
+			if (!parsed) throw new Error(`[bundles] ${row.org_slug}/${row.bundle_name}: manifest.json is not readable`);
+			return parsed;
+		});
+		m.catch(() => manifests.delete(manifestUrl));
+		manifests.set(manifestUrl, m);
+	}
+	return m;
+}
+function warmChunkManifest(row, files) {
+	const plan = row.specifier ? files.chunkPlan?.(row.specifier) : null;
+	if (!plan) return;
+	manifestOf(row, plan, files.fetch ?? ((u) => fetch(u))).catch(() => void 0);
+}
 var requiresOf = (row, files) => row.requires ?? (row.specifier && files.chunkPlan?.(row.specifier) ? row.specifier === "@stack/core" ? [] : ["@stack/core"] : void 0);
 var escapeRe = (v) => v.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 async function sharedDependencies(rows, files) {
@@ -274,4 +286,4 @@ function _clearBundleCache() {
 	manifests.clear();
 	contractsOf.clear();
 }
-export { loadBundlesSettled as a, chunkPlan as c, loadBundles as i, parseChunkPlans as l, isComponentExport as n, projectModule as o, loadBundle as r, runtimeReady as s, _clearBundleCache as t, parseComponentManifest as u };
+export { loadBundlesSettled as a, warmChunkManifest as c, parseComponentManifest as d, loadBundles as i, chunkPlan as l, isComponentExport as n, projectModule as o, loadBundle as r, runtimeReady as s, _clearBundleCache as t, parseChunkPlans as u };

package/dist/core.js

@@ -2,7 +2,7 @@ import { A as rootCells, C as CONTENT_FIELDS, D as hasRef, E as STORE_FIELDS, O
 import { C as passesConditions, S as pageContext, T as settled, _ as EACH, a as VARIABLE_NAMESPACES, b as cellResolutionContext, c as pageVariables, d as resolveDescriptorVariables, f as selectionShape, g as variableReferences, h as variableLabels, i as UnsafeDocumentError, l as prepareDocument, m as validateDescriptor, n as RENDER_FUNCTIONS, o as descriptorShape, p as shapeAt, r as RENDER_FUNCTIONS_AHEAD, s as orderByVariable, t as PAGING_VARIABLES, u as queryKey, v as EACH_DEFAULT_AS, w as resolveReferences, x as isEach, y as cellContext } from "./chunks/query-D_f73wsU.js";
 import { S as walkRequest, _ as stateNames, a as eachFormProblems, b as systemsFromProcess, c as validatePage, d as mergeStates, f as needsWalk, g as resolveWalkStart, h as referencedLabels, i as componentsFor, l as selectionIssues, m as readWalk, n as STORE_SCOPES, o as nearestNames, p as readField, r as WALK_DIRECTIONS, s as validateCell, t as RESPONSIVE_BUCKETS, u as RESERVED_LABELS, v as stateValue, x as walkKey, y as systemsFromGraphs } from "./chunks/validate-BfXuQLmV.js";
 import { C as actionReferences, D as resolveAction, E as projectCellActions, S as actionProblems, T as normalizeActionDeclaration, _ as HOST_READ_KEY, a as deriveSectionReferences, b as isHostRead, c as nodePrintStyle, d as referencesFor, f as sectionAnchor, g as usesStructureLayout, h as tableOfContents, i as deriveSectionNumbering, l as normalizeStructure, m as structureIssues, n as SECTION_KINDS, r as deriveElementReferences, s as mergeSectionReferences, t as PAGE_DOCUMENT, u as numberingFor, v as bindHostReads, w as declaredActions, x as actionBindingKey, y as hostReadProblem } from "./chunks/structure-Ds2wfhkH.js";
-import { a as loadBundlesSettled, c as chunkPlan, i as loadBundles, l as parseChunkPlans, n as isComponentExport, o as projectModule, r as loadBundle, s as runtimeReady, t as _clearBundleCache, u as parseComponentManifest } from "./chunks/load-CAus-wv_.js";
+import { a as loadBundlesSettled, c as warmChunkManifest, d as parseComponentManifest, i as loadBundles, l as chunkPlan, n as isComponentExport, o as projectModule, r as loadBundle, s as runtimeReady, t as _clearBundleCache, u as parseChunkPlans } from "./chunks/load-BU9C8x6-.js";
 import { a as normalizeRef, i as bundleScope, n as MAIN, o as refKey, r as PUBLIC, t as CORE_SPECIFIER } from "./chunks/refs-Csgh6rXq.js";
 import { a as rowsInScope, i as rowForCell, n as pageBundleRefs, o as rowsNeededBy, r as pageBundles, t as componentNames } from "./chunks/page-bundles-dUYH4D73.js";
 import { a as createStackStore, i as saveScope, n as clearScope, r as loadScope } from "./chunks/persistence-hurkUUQ0.js";
@@ -1184,4 +1184,4 @@ function manifestPageFrom(graphNodeId, data) {
 		}
 	};
 }
-export { CONTENT_FIELDS, CORE_SPECIFIER, DIAGNOSTICS, EACH, EACH_DEFAULT_AS, HOST_READ_KEY, HYDRATED_CELL_FIELDS, LAYER_ROLES, LAYOUT_TYPES, MAIN, PAGE_DOCUMENT, PAGE_RULES, PAGING_VARIABLES, PUBLIC, RENDER_FIELDS, RENDER_FUNCTIONS, RENDER_FUNCTIONS_AHEAD, RESERVED_LABELS, RESPONSIVE_BUCKETS, SECTION_KINDS, STORE_FIELDS, STORE_SCOPES, STRUCTURE_FIELDS, TOOL_OWNED_KEYS, UnsafeDocumentError, VARIABLE_NAMESPACES, WALK_DIRECTIONS, _clearBundleCache, actionBindingKey, actionProblems, actionReferences, assembleCellProps, attachSelectionSetters, attachViewStateSetters, bindHostReads, buildDataContext, bundleScope, cellAttributes, cellContext, cellPlacementStyle, cellPropSources, cellResolutionContext, chunkPlan, clearScope, collectDeclarations, collectDescriptors, collectScopeIds, collectStatic, componentNames, componentsFor, createStackStore, declaredActions, deriveElementReferences, deriveSectionNumbering, deriveSectionReferences, descriptorShape, eachFormProblems, editTarget, hasRef, hiddenWhenEmpty, hideWhenEmptyProblem, hostReadProblem, isComponentExport, isEach, isEmptyPropValue, isHostRead, layerName, loadBundle, loadBundles, loadBundlesSettled, loadPageData, loadScope, manifestPageFrom, mergeSectionReferences, mergeStates, nearestNames, needsWalk, nodePrintStyle, normalizeActionDeclaration, normalizeCell, normalizeRef, normalizeStructure, numberingFor, orderByVariable, pageBundleRefs, pageBundles, pageContainerStyle, pageContext, pageForCell, pageRuntimeFromValues, pageScopeKey, pageVariables, parseChunkPlans, parseComponentManifest, passesConditions, patchAt, prepareDocument, projectCellActions, projectCellData, projectLive, projectModule, projectScopeKey, projectSelections, projectViewState, queryKey, readField, readWalk, refKey, referencedLabels, referencesFor, resolveAction, resolveCell, resolveComponent, resolveDataSystem, resolveDeclarations, resolveDescriptorVariables, resolveReferences, resolveScopeId, resolveSystems, resolveWalkStart, rootCells, rowForCell, rowsInScope, rowsNeededBy, runtimeReady, saveScope, sectionAnchor, selectionIssues, selectionShape, settled, shallowEqualBundle, shapeAt, stateNames, stateValue, structureIssues, systemsFromGraphs, systemsFromProcess, tableOfContents, usesStructureLayout, validateCell, validateDescriptor, validateManifest, validatePage, variableLabels, variableReferences, walkKey, walkRequest };
+export { CONTENT_FIELDS, CORE_SPECIFIER, DIAGNOSTICS, EACH, EACH_DEFAULT_AS, HOST_READ_KEY, HYDRATED_CELL_FIELDS, LAYER_ROLES, LAYOUT_TYPES, MAIN, PAGE_DOCUMENT, PAGE_RULES, PAGING_VARIABLES, PUBLIC, RENDER_FIELDS, RENDER_FUNCTIONS, RENDER_FUNCTIONS_AHEAD, RESERVED_LABELS, RESPONSIVE_BUCKETS, SECTION_KINDS, STORE_FIELDS, STORE_SCOPES, STRUCTURE_FIELDS, TOOL_OWNED_KEYS, UnsafeDocumentError, VARIABLE_NAMESPACES, WALK_DIRECTIONS, _clearBundleCache, actionBindingKey, actionProblems, actionReferences, assembleCellProps, attachSelectionSetters, attachViewStateSetters, bindHostReads, buildDataContext, bundleScope, cellAttributes, cellContext, cellPlacementStyle, cellPropSources, cellResolutionContext, chunkPlan, clearScope, collectDeclarations, collectDescriptors, collectScopeIds, collectStatic, componentNames, componentsFor, createStackStore, declaredActions, deriveElementReferences, deriveSectionNumbering, deriveSectionReferences, descriptorShape, eachFormProblems, editTarget, hasRef, hiddenWhenEmpty, hideWhenEmptyProblem, hostReadProblem, isComponentExport, isEach, isEmptyPropValue, isHostRead, layerName, loadBundle, loadBundles, loadBundlesSettled, loadPageData, loadScope, manifestPageFrom, mergeSectionReferences, mergeStates, nearestNames, needsWalk, nodePrintStyle, normalizeActionDeclaration, normalizeCell, normalizeRef, normalizeStructure, numberingFor, orderByVariable, pageBundleRefs, pageBundles, pageContainerStyle, pageContext, pageForCell, pageRuntimeFromValues, pageScopeKey, pageVariables, parseChunkPlans, parseComponentManifest, passesConditions, patchAt, prepareDocument, projectCellActions, projectCellData, projectLive, projectModule, projectScopeKey, projectSelections, projectViewState, queryKey, readField, readWalk, refKey, referencedLabels, referencesFor, resolveAction, resolveCell, resolveComponent, resolveDataSystem, resolveDeclarations, resolveDescriptorVariables, resolveReferences, resolveScopeId, resolveSystems, resolveWalkStart, rootCells, rowForCell, rowsInScope, rowsNeededBy, runtimeReady, saveScope, sectionAnchor, selectionIssues, selectionShape, settled, shallowEqualBundle, shapeAt, stateNames, stateValue, structureIssues, systemsFromGraphs, systemsFromProcess, tableOfContents, usesStructureLayout, validateCell, validateDescriptor, validateManifest, validatePage, variableLabels, variableReferences, walkKey, walkRequest, warmChunkManifest };

package/dist/runtime.js

@@ -1,4 +1,4 @@
-import { s as runtimeReady } from "./chunks/load-CAus-wv_.js";
+import { s as runtimeReady } from "./chunks/load-BU9C8x6-.js";
 import { a as createStackStore, t as clearAllScopes } from "./chunks/persistence-hurkUUQ0.js";
 import { PINNED_RUNTIMES, READY_GLOBAL, RESOLVE_GLOBAL, RUNTIME_GLOBAL, buildImportMap } from "@peripheries/runtime";
 import * as React from "react";

package/dist/testing.js

@@ -1,5 +1,5 @@
 import { l as prepareDocument } from "./chunks/query-D_f73wsU.js";
-import { o as projectModule } from "./chunks/load-CAus-wv_.js";
+import { o as projectModule } from "./chunks/load-BU9C8x6-.js";
 import { i as bundleScope } from "./chunks/refs-Csgh6rXq.js";
 import { n as pageBundleRefs, r as pageBundles } from "./chunks/page-bundles-dUYH4D73.js";
 import { r as fromPageSteps } from "./chunks/forms-DxA9WzCt.js";

package/dist/types/core/bundles/load.d.ts

@@ -33,9 +33,11 @@ export type BundleFiles = {
     fetch?: (url: string) => Promise<Response>;
     chunkPlan?: (specifier: string) => ChunkPlan | null;
     linkStyles?: (urls: string[]) => void;
+    preload?: (urls: string[]) => void;
 };
 export declare function runtimeReady(g?: Record<string, unknown>): Promise<void>;
 export declare function loadBundle(row: BundleRow, files: BundleFiles, wanted?: ReadonlySet<string> | 'all'): Promise<LoadedBundle>;
+export declare function warmChunkManifest(row: BundleRow, files: Pick<BundleFiles, 'chunkPlan' | 'fetch'>): void;
 export type LoadedBundles = {
     loaded: LoadedBundle[];
     failed: string[];

package/dist/types/core/cell-props.d.ts

@@ -12,6 +12,10 @@ export declare function failedLabels(cell: PageCell, data: DataContext): string[
 export declare function isEmptyPropValue(value: unknown): boolean;
 export declare function hideWhenEmptyProblem(cell: Pick<PageCell, 'hide_when_empty' | 'props'>, data: DataContext): 'QUERY_UNRESOLVED' | null;
 export declare function hiddenWhenEmpty(cell: Pick<PageCell, 'hide_when_empty' | 'props'>, props: Record<string, unknown>, data: DataContext): boolean;
+export type CellMock = {
+    props?: Record<string, unknown>;
+    data?: unknown;
+};
 export type AssembledInputs = {
     resolvedProps: Record<string, unknown>;
     children: unknown;
@@ -34,5 +38,6 @@ export type AssembledInputs = {
     navigate: (to: string) => void;
     context: Record<string, unknown>;
     renderComponent?: (key: string, props?: Record<string, unknown>) => unknown;
+    mock?: CellMock;
 };
 export declare function assembleCellProps(i: AssembledInputs): Record<string, unknown>;

package/dist/types/core/index.d.ts

@@ -16,10 +16,10 @@ export { pageRuntimeFromValues } from './values.js';
 export { actionBindingKey, actionProblems, actionReferences, declaredActions, normalizeActionDeclaration, projectCellActions, resolveAction, type RunAction } from './actions.js';
 export type { ActionDeclaration } from '@peripheries/runtime';
 export type * from './types.js';
-export { assembleCellProps, hiddenWhenEmpty, hideWhenEmptyProblem, isEmptyPropValue, projectCellData, type CellStatus } from './cell-props.js';
+export { assembleCellProps, hiddenWhenEmpty, hideWhenEmptyProblem, isEmptyPropValue, projectCellData, type CellMock, type CellStatus } from './cell-props.js';
 export { cellAttributes, cellPlacementStyle, pageContainerStyle } from './layout.js';
 export { deriveElementReferences, deriveSectionNumbering, deriveSectionReferences, mergeSectionReferences, nodePrintStyle, normalizeStructure, numberingFor, PAGE_DOCUMENT, referencesFor, SECTION_KINDS, sectionAnchor, structureIssues, tableOfContents, usesStructureLayout, type ContentsEntry, type LayoutNode, type SectionNumbering, type SectionReference, type SectionReferences, } from './structure.js';
-export { _clearBundleCache, isComponentExport, loadBundle, loadBundles, loadBundlesSettled, projectModule, runtimeReady, type BundleFiles, type BundleRow, type LoadedBundle, type LoadedBundles, } from './bundles/load.js';
+export { _clearBundleCache, isComponentExport, loadBundle, loadBundles, loadBundlesSettled, projectModule, runtimeReady, warmChunkManifest, type BundleFiles, type BundleRow, type LoadedBundle, type LoadedBundles, } from './bundles/load.js';
 export { chunkPlan, parseChunkPlans, parseComponentManifest, type ChunkPlan, type ComponentManifest, type ManifestComponent } from './bundles/component-manifest.js';
 export { componentNames, pageBundleRefs, pageBundles, rowForCell, rowsInScope, rowsNeededBy, type PageBundles } from './bundles/page-bundles.js';
 export { bundleScope, CORE_SPECIFIER, MAIN, normalizeRef, PUBLIC, refKey, type BundleRef, type BundleScopeInput, type LineageRef, type SharedLineage } from './bundles/refs.js';

package/dist/types/react/cell-view.d.ts

@@ -4,6 +4,7 @@ import type { LoadedBundle } from '../core/bundles/load.js';
 import type { Diagnostic } from '../core/graph.js';
 import { type CoreRegistry } from '../core/bundles/resolve.js';
 import { type RunAction } from '../core/actions.js';
+import { type CellMock } from '../core/cell-props.js';
 import { type HostReads } from '../core/host-reads.js';
 import type { CellData } from '../core/load-page.js';
 import { type ResolutionContext } from '../core/references.js';
@@ -44,6 +45,7 @@ export type CellEnvironment = {
     cellProps?: (cell: PageCell) => Record<string, unknown> | undefined;
     showHiddenCells?: boolean;
     showProblemCodes?: boolean;
+    mockCell?: (cellId: string) => CellMock | undefined;
 };
 export type FrameProps = {
     attributes?: Record<string, string>;

package/dist/types/react/page-renderer.d.ts

@@ -1,6 +1,7 @@
 import type { CellAction, ComponentContract } from '@peripheries/runtime';
 import type { RunAction } from '../core/actions.js';
 import type { PageBundles } from '../core/bundles/page-bundles.js';
+import type { CellMock } from '../core/cell-props.js';
 import type { CoreRegistry } from '../core/bundles/resolve.js';
 import type { HostReads } from '../core/host-reads.js';
 import type { Diagnostic } from '../core/graph.js';
@@ -27,6 +28,7 @@ export type RendererEnvironment = {
     cellProps?: (cell: PageCell) => Record<string, unknown> | undefined;
     showHiddenCells?: boolean;
     showProblemCodes?: boolean;
+    mockCell?: (cellId: string) => CellMock | undefined;
 };
 export type PageRendererProps = {
     runtime: PageRuntime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peripheries/renderer",
-  "version": "0.29.0",
+  "version": "0.31.0",
   "description": "The one renderer for pages of federated component bundles: a framework-free core, a React renderer, the runtime a page boots with, and golden pages for testing.",
   "type": "module",
   "sideEffects": [