@peripheries/renderer 0.29.0 → 0.30.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/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,7 +16,7 @@ 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';

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.30.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": [