@phis/ui 0.4.1 → 0.4.3

package/components/cms/phi-cms-layout-renderer.js

@@ -1,5 +1,6 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { cloneElement, isValidElement } from "react";
+import { resolvePhiRenderFailureCode } from "../widgets/config/strict-config-reader";
 import { readPhiCmsRegionPageScope, resolvePhiCmsRegionPageScope } from "../../helpers/region-page-scope";
 import { isPhiCmsWidgetContentUnpublished } from "../../helpers/cms-content-binding";
 import { comparePhiCmsInstanceIds } from "../../types/cms-instance-id";
@@ -435,7 +436,7 @@ function renderContentWidget(widget, context) {
         }
         catch (error) {
             return renderCmsDiagnostic({
-                code: "render-failed",
+                code: resolvePhiRenderFailureCode(error),
                 kind: "widget",
                 type: widget.widgetType,
                 blockId: widget.id,
@@ -507,7 +508,7 @@ function withLayoutRenderKey(node, key) {
 /** What a Widget that threw while rendering on the server reports in its place. */
 export function buildPhiRenderFailureIssue(error, options) {
     return {
-        code: "render-failed",
+        code: resolvePhiRenderFailureCode(error),
         kind: options.kind,
         type: options.typeKey ?? "unknown",
         blockId: options.blockId,
@@ -703,7 +704,7 @@ function renderLayoutNode(node, context) {
         }
         catch (error) {
             return renderCmsDiagnostic({
-                code: "render-failed",
+                code: resolvePhiRenderFailureCode(error),
                 kind: "layout",
                 type: node.widgetType,
                 blockId: node.id,

package/components/cms/phi-cms-page-render-scope.d.ts

@@ -1,12 +1,11 @@
-import type { ReactNode } from "react";
+import { type ReactNode } from "react";
 import type { PhiBlockRuntime } from "../../types";
 import type { PhiCmsSiteBridge } from "../../types/cms-plugins";
 import type { loadPhiCmsRootRequest } from "../../server-helpers/cms-root";
 type PhiCmsResolvedRootRequest = NonNullable<Awaited<ReturnType<typeof loadPhiCmsRootRequest>>["resolvedRequest"]>;
 /**
- * What a Page and each of its Region slots work out before they render: the Module scope of the Area,
- * the tree filtered to what this viewer may see, the registry of what the tree needs, and the Page's
- * Controllers for the Regions in question.
+ * What a Page and each of its Region slots work out before they render: the shared part above, and the
+ * Page's Controllers for the Regions in question.
  *
  * The Page and the slot used to carry this as two copies, four blocks apart, and the slot's trailed the
  * Page's. One resolution, parameterised by the Regions it is for.
@@ -36,7 +35,7 @@ export declare function resolvePhiCmsPageRenderScope({ cmsBridge, resolvedReques
     };
     runtimeRegistry: import("../../types/cms-plugins").PhiCmsRuntimeRenderRegistry;
     pageControllerSettings: import("../../types").PhiRuntimeControllerSetting[];
-    controllerConfigOverlays: {
+    controllerConfigOverlays: readonly {
         address: `controller:${string}/${string}:${string}`;
         config: Record<string, unknown>;
     }[];

package/components/cms/phi-cms-page-render-scope.js

@@ -1,4 +1,5 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { cache } from "react";
 import { PhiRuntimeControllerServerHost } from "../runtime/runtime-controller-server-host";
 import { collectPhiRuntimeControllerConfigOverlays, materializePhiRuntimeControllerSettings, } from "../runtime/runtime-controller-materialization";
 import { PhiRuntimeControllerConfigOverlays } from "../runtime/runtime-controller-config-overlays";
@@ -9,15 +10,17 @@ import { buildPhiRuntimeModuleAccessRegistry, filterPhiCmsRenderableTreeForViewe
 import { resolvePhiCmsAreaRuntimeModuleScope, resolvePhiCmsTreeRuntimeRegistry, } from "./phi-cms-runtime-registry";
 import { resolvePhiPageTour } from "../../server-helpers/page-tour";
 import { PHI_PAGE_TOUR_CONFIG_KEY, PHI_PAGE_TOUR_CONTROLLER_FLAG, readPhiTourTargets, } from "../../types/tours";
-/**
- * What a Page and each of its Region slots work out before they render: the Module scope of the Area,
- * the tree filtered to what this viewer may see, the registry of what the tree needs, and the Page's
- * Controllers for the Regions in question.
+/*
+ * What a Page and every one of its Region slots share: the Area's Module scope, the Page's Tour, the tree
+ * filtered for this viewer, the registry of what that tree needs, and the Controller config the tree
+ * carries. None of it depends on the Region.
  *
- * The Page and the slot used to carry this as two copies, four blocks apart, and the slot's trailed the
- * Page's. One resolution, parameterised by the Regions it is for.
+ * The Page and its six slots render in parallel and each worked all of it out again -- up to seven
+ * filters of the same tree and seven registries per request (audit R9). The root request is memoized per
+ * request (`loadPhiCmsRootRequest`), so every slot holds the same object, and React's `cache` keyed by it
+ * and the bridge keeps this for exactly that request.
  */
-export async function resolvePhiCmsPageRenderScope({ cmsBridge, resolvedRequest, regionTypes, includeOverlays = false, }) {
+const resolvePhiCmsPageRenderBase = cache(async (cmsBridge, resolvedRequest) => {
     const runtimeModuleScope = await resolvePhiCmsAreaRuntimeModuleScope({
         cmsBridge,
         area: resolvedRequest.runtime.area,
@@ -47,20 +50,6 @@ export async function resolvePhiCmsPageRenderScope({ cmsBridge, resolvedRequest,
     });
     // What the Area runs for every Page: a Page setting for one of these configures it, it is not a second.
     const enclosingSettings = runtimeModuleScope.moduleSet.areaControllerSettings;
-    const pageControllerSettings = materializePhiRuntimeControllerSettings({
-        tree: filteredPageTree,
-        ownerMountScope: "page",
-        widgetPluginsByType: runtimeModuleScope.widgetDefinitionsByType,
-        enclosingSettings,
-        activeControllerTypes: [...runtimeModuleScope.moduleSet.controllerDescriptorsByType.keys()],
-        regionTypes,
-        ...(includeOverlays ? { includeOverlays: true } : {}),
-    });
-    const controllerDefinitionsByType = await resolvePhiRuntimeControllerDefinitions({
-        catalog: cmsBridge.runtimeModuleCatalog,
-        moduleSet: runtimeModuleScope.moduleSet,
-        settings: pageControllerSettings,
-    });
     const controllerConfigOverlays = collectPhiRuntimeControllerConfigOverlays({
         tree: filteredPageTree,
         ownerMountScope: "page",
@@ -83,8 +72,40 @@ export async function resolvePhiCmsPageRenderScope({ cmsBridge, resolvedRequest,
         runtimeModuleScope,
         filteredPageTree,
         runtimeRegistry,
+        enclosingSettings,
+        controllerConfigOverlays: controllerConfigOverlays,
+    };
+});
+/**
+ * What a Page and each of its Region slots work out before they render: the shared part above, and the
+ * Page's Controllers for the Regions in question.
+ *
+ * The Page and the slot used to carry this as two copies, four blocks apart, and the slot's trailed the
+ * Page's. One resolution, parameterised by the Regions it is for.
+ */
+export async function resolvePhiCmsPageRenderScope({ cmsBridge, resolvedRequest, regionTypes, includeOverlays = false, }) {
+    const base = await resolvePhiCmsPageRenderBase(cmsBridge, resolvedRequest);
+    const { runtimeModuleScope, filteredPageTree } = base;
+    const pageControllerSettings = materializePhiRuntimeControllerSettings({
+        tree: filteredPageTree,
+        ownerMountScope: "page",
+        widgetPluginsByType: runtimeModuleScope.widgetDefinitionsByType,
+        enclosingSettings: base.enclosingSettings,
+        activeControllerTypes: [...runtimeModuleScope.moduleSet.controllerDescriptorsByType.keys()],
+        regionTypes,
+        ...(includeOverlays ? { includeOverlays: true } : {}),
+    });
+    const controllerDefinitionsByType = await resolvePhiRuntimeControllerDefinitions({
+        catalog: cmsBridge.runtimeModuleCatalog,
+        moduleSet: runtimeModuleScope.moduleSet,
+        settings: pageControllerSettings,
+    });
+    return {
+        runtimeModuleScope,
+        filteredPageTree,
+        runtimeRegistry: base.runtimeRegistry,
         pageControllerSettings,
-        controllerConfigOverlays,
+        controllerConfigOverlays: base.controllerConfigOverlays,
         controllerDefinitionsByType,
     };
 }

package/components/cms/phi-cms-render-diagnostic-client.js

@@ -13,6 +13,8 @@ function buildIssueTitle(issue) {
         return `${formatKind(issue.kind)} visibility unresolved`;
     if (issue.code === "missing-node")
         return `${formatKind(issue.kind)} root missing`;
+    if (issue.code === "invalid-config")
+        return `${formatKind(issue.kind)} settings invalid`;
     return `${formatKind(issue.kind)} not renderable`;
 }
 function buildIssueDescription(issue) {
@@ -24,9 +26,11 @@ function buildIssueDescription(issue) {
             ? "A Module its condition reads could not be asked this render."
             : issue.code === "missing-node"
                 ? "The stored tree names a node it does not contain."
-                : issue.moduleId
-                    ? `Module: ${issue.moduleId}.`
-                    : "The required renderer is unavailable.";
+                : issue.code === "invalid-config"
+                    ? "Correct the field in the Inspector; on the live page this block is left out until then."
+                    : issue.moduleId
+                        ? `Module: ${issue.moduleId}.`
+                        : "The required renderer is unavailable.";
     return `${issue.type}. ${moduleDescription}${issue.detail ? ` ${issue.detail}` : ""}`;
 }
 function buildIssueKey(issue) {

package/components/cms/phi-cms-render-error-boundary.js

@@ -2,6 +2,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Component } from "react";
 import { PhiCmsRenderDiagnostic } from "./phi-cms-render-diagnostic";
+import { resolvePhiRenderFailureCode } from "../widgets/config/strict-config-reader";
 export class PhiCmsRenderErrorBoundary extends Component {
     state = {
         error: null,
@@ -20,7 +21,7 @@ export class PhiCmsRenderErrorBoundary extends Component {
     render() {
         if (this.state.error) {
             return _jsx(PhiCmsRenderDiagnostic, { issue: {
-                    code: "render-failed",
+                    code: resolvePhiRenderFailureCode(this.state.error),
                     kind: this.props.kind,
                     type: this.props.typeKey ?? "unknown",
                     blockId: this.props.blockId,

package/components/controls/phi-bullet-list-control.js

@@ -1,4 +1,4 @@
-import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { PhiIcon } from "../shell/phi-icon";
 import { phiSurfaceDrawsChrome, resolvePhiSurfaceStyle } from "../../helpers/surface-style";
 import { PHI_COLOR, PHI_RADIUS, PHI_SPACE } from "../../theme/antd-css-var-contract";
@@ -7,6 +7,21 @@ import { PhiBulletListFlag, resolvePhiBulletListLevel, resolvePhiBulletListStyle
 import { hasPhiFlag } from "../../helpers/flags";
 const PHI_BULLET_LIST_MARKER_SIZE = PHI_SPACE.xs;
 const PHI_BULLET_LIST_ICON_SIZE = 14;
+/*
+ * An entry's state stands in place of the level's marker: a tick for what is included, a dash for what is
+ * not. Neither is the list's colour: included is the Theme's success, excluded the tertiary text, so a
+ * plan's list reads the same whatever marker its neutral entries take.
+ */
+function renderStateMarker(state) {
+    switch (state) {
+        case "included":
+            return _jsx(PhiIcon, { name: "antd:check-outlined", size: PHI_BULLET_LIST_ICON_SIZE, style: { color: PHI_COLOR.success } });
+        case "excluded":
+            return _jsx(PhiIcon, { name: "antd:minus-outlined", size: PHI_BULLET_LIST_ICON_SIZE, style: { color: PHI_COLOR.textTertiary } });
+        default:
+            return null;
+    }
+}
 function renderMarker(marker, icon, number) {
     switch (marker) {
         case "none":
@@ -69,5 +84,19 @@ export function PhiBulletListControl({ items, listStyle = resolvePhiBulletListSt
                 ...surface.style,
                 ...(boxed ? { padding: `${PHI_SPACE.sm} ${PHI_SPACE.md}` } : {}),
                 ...(divided && index > 0 ? { borderTop: `1px solid ${PHI_COLOR.borderSecondary}`, paddingTop: gap } : {}),
-            }, children: [marker === "none" ? null : (_jsx("span", { "aria-hidden": "true", style: { display: "inline-flex", alignItems: "center", justifyContent: "center", flexShrink: 0, height: markerLineHeight }, children: renderMarker(marker, listStyle.icon, start + index) })), _jsxs("div", { style: { display: "grid", gap, flex: 1, minWidth: 0 }, children: [item.content, item.children?.length ? (_jsx(PhiBulletListControl, { items: item.children, listStyle: listStyle, depth: depth + 1, markerLineHeight: markerLineHeight })) : null] })] }, index))) }));
+            }, children: [(() => {
+                    const stated = renderStateMarker(item.state);
+                    /* An editor's marker is a button, so a list whose marker is `none` still offers one. */
+                    const drawn = stated ?? renderMarker(marker === "none" && item.onMarkerClick ? "dot" : marker, listStyle.icon, start + index);
+                    if (drawn == null)
+                        return null;
+                    const markerStyle = {
+                        display: "inline-flex",
+                        alignItems: "center",
+                        justifyContent: "center",
+                        flexShrink: 0,
+                        height: markerLineHeight,
+                    };
+                    return item.onMarkerClick ? (_jsx("button", { type: "button", className: "phi-bullet-list__marker-button", "aria-label": `State: ${item.state ?? "neutral"}`, onClick: item.onMarkerClick, style: { ...markerStyle, padding: 0, border: 0, background: "none", cursor: "pointer", color: "inherit" }, children: drawn })) : (_jsx("span", { "aria-hidden": "true", style: markerStyle, children: drawn }));
+                })(), _jsxs("div", { style: { display: "grid", gap, flex: 1, minWidth: 0, ...(item.state === "excluded" ? { color: PHI_COLOR.textTertiary } : {}) }, children: [item.content, item.children?.length ? (_jsx(PhiBulletListControl, { items: item.children, listStyle: listStyle, depth: depth + 1, markerLineHeight: markerLineHeight })) : null] })] }, index))) }));
 }

package/components/controls/phi-ribbon-control.d.ts

@@ -0,0 +1,29 @@
+import type { CSSProperties, ReactNode } from "react";
+export type PhiRibbonControlProps = {
+    children: ReactNode;
+    /** The band's ground; absent, the Theme's primary. Its words are the light text on any ground. */
+    color?: string;
+    /**
+     * Where the band stands: `corner` flush with the box's top and end edge, its top end corner the box's
+     * own; `edge` a small padding down the end edge. Either way it floats: nothing in the box moves for it.
+     */
+    placement?: "corner" | "edge";
+    style?: CSSProperties;
+};
+/**
+ * A band of words at the end edge of a box: "Popular", "New", "-20 %".
+ *
+ * Ant Design draws this as `Badge.Ribbon`, with a fold that hangs past the box's edge. Not that one: it
+ * wraps the box in an element of its own, and its fold needs the box not to clip -- a card clips, so its
+ * picture keeps its corners. This band stands inside the box and needs nothing from it but a position
+ * to stand against. It is drawn on the server as well, without hooks.
+ *
+ * It floats and takes no room, so boxes side by side in a row start their content on one line whether
+ * they carry a band or not. A band on a line of its own pushed its box's words down; squeezed into the
+ * box's top inset it was too thin to read. In the corner it stands over the inset and a little into the
+ * first line's end, which a long eyebrow in a narrow box can reach.
+ *
+ * It sits above what the box draws, the highlight's ring included, and takes no clicks, so a card that
+ * is a link stays one under its band.
+ */
+export declare function PhiRibbonControl({ children, color, placement, style }: PhiRibbonControlProps): import("react").JSX.Element;

package/components/controls/phi-ribbon-control.js

@@ -0,0 +1,53 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { PHI_COLOR, PHI_FONT_SIZE, PHI_SPACE } from "../../theme/antd-css-var-contract";
+/**
+ * A band of words at the end edge of a box: "Popular", "New", "-20 %".
+ *
+ * Ant Design draws this as `Badge.Ribbon`, with a fold that hangs past the box's edge. Not that one: it
+ * wraps the box in an element of its own, and its fold needs the box not to clip -- a card clips, so its
+ * picture keeps its corners. This band stands inside the box and needs nothing from it but a position
+ * to stand against. It is drawn on the server as well, without hooks.
+ *
+ * It floats and takes no room, so boxes side by side in a row start their content on one line whether
+ * they carry a band or not. A band on a line of its own pushed its box's words down; squeezed into the
+ * box's top inset it was too thin to read. In the corner it stands over the inset and a little into the
+ * first line's end, which a long eyebrow in a narrow box can reach.
+ *
+ * It sits above what the box draws, the highlight's ring included, and takes no clicks, so a card that
+ * is a link stays one under its band.
+ */
+export function PhiRibbonControl({ children, color, placement = "edge", style }) {
+    const radius = "var(--phi-control-radius-sm)";
+    const position = placement === "corner"
+        ? {
+            top: 0,
+            paddingBlock: PHI_SPACE.xxs,
+            // The top end corner is the box's own, which clips it; only the corner inside the box is rounded.
+            borderEndStartRadius: radius,
+        }
+        : {
+            top: PHI_SPACE.sm,
+            paddingBlock: PHI_SPACE.xxs,
+            borderStartStartRadius: radius,
+            borderEndStartRadius: radius,
+        };
+    return (_jsx("span", { className: "phi-ribbon-control", style: {
+            position: "absolute",
+            insetInlineEnd: 0,
+            zIndex: 4,
+            maxWidth: "70%",
+            boxSizing: "border-box",
+            paddingInline: PHI_SPACE.sm,
+            background: color ?? PHI_COLOR.primary,
+            color: PHI_COLOR.textLightSolid,
+            fontSize: PHI_FONT_SIZE.sm,
+            fontWeight: 600,
+            lineHeight: 2,
+            whiteSpace: "nowrap",
+            overflow: "hidden",
+            textOverflow: "ellipsis",
+            pointerEvents: "none",
+            ...position,
+            ...style,
+        }, children: children }));
+}

package/components/controls/phi-table-control.d.ts

@@ -44,7 +44,10 @@ export type PhiTableControlColumn<TRow extends Record<string, unknown>> = {
 export type PhiTableControlPagination = {
     page: number;
     pageSize: number;
+    /** The rows the whole query has. Absent, the Table pages without a count: back, this page, next. */
     total?: number;
+    /** Without a count: whether a page follows this one. */
+    hasMore?: boolean;
     pageSizeOptions?: readonly number[];
     showSizeChanger?: boolean;
     onChange: (page: number, pageSize: number) => void;

package/components/controls/phi-table-control.js

@@ -1022,7 +1022,19 @@ export function PhiTableControl({ rows, rowIdentityPath, columns, columnOrder, s
             ...{ [PHI_VISUAL_ANCHOR_PART_ATTRIBUTE]: "pagination" },
             current: pagination.page,
             pageSize: pagination.pageSize,
-            total: pagination.total,
+            ...(pagination.total === undefined
+                ? {
+                    /*
+                     * No count: a total that reaches exactly one row past this page when another follows, and
+                     * only the current page's number drawn -- page numbers beyond it would be a guess.
+                     */
+                    total: pagination.page * pagination.pageSize + (pagination.hasMore ? 1 : 0),
+                    showLessItems: true,
+                    itemRender: (page, type, element) => type === "page" ? (page === pagination.page ? element : null)
+                        : type === "jump-prev" || type === "jump-next" ? null
+                            : element,
+                }
+                : { total: pagination.total }),
             pageSizeOptions: pagination.pageSizeOptions?.map(String),
             showSizeChanger: pagination.showSizeChanger,
             onChange: pagination.onChange,

package/components/controls/phi-tree-control.js

@@ -154,8 +154,8 @@ export function PhiTreeControl({ nodes, nodeIdentityPath, parentNodeIdentityPath
             padding: token.paddingSM,
             background: token.colorBgContainer,
             border: `1px solid ${token.colorBorderSecondary}`,
-            // The frame is the surface; its corner is the Site's step, with the old token as the fallback
-            // for a Tree rendered outside the Provider.
-            borderRadius: "var(--phi-surface-radius, var(--ant-border-radius-lg))",
+            // The frame is the surface; its corner is the Site's step, declared by the Provider every Tree
+            // renders under (THEME.md, "Control shape").
+            borderRadius: "var(--phi-surface-radius)",
         }, children: tree })) : tree;
 }

package/components/forms/shared-form-provider-registry.js

@@ -31,11 +31,8 @@ placeholderRows = 1) {
              * Control line, which on the one-row placeholder is exactly the capsule and on a taller one is the
              * capsule held -- the same answer the field itself will give when it arrives, so the shape does not
              * change under the reader at the moment the chunk lands.
-             *
-             * Here the fallback is the plain surface radius and not the large one: this is an ordinary `div`,
-             * not an Ant Design Control, so nothing has redefined `--ant-border-radius` on it.
              */
-            borderRadius: "var(--phi-control-radius-grown-md, var(--ant-border-radius))",
+            borderRadius: "var(--phi-control-radius-grown-md)",
             background: "var(--ant-color-fill-quaternary)",
         } }));
     return function PhiLazyFormFieldControl(props) {

package/components/media/asset-collection-runtime.js

@@ -3,9 +3,9 @@ import { useEffect, useMemo } from "react";
 import { PHI_MEDIA_LIBRARY_DATA_PROVIDER_KEYS } from "../../constants/media-library-provider-keys";
 import { usePhiCollectionProvider } from "../widgets/client/shared/phi-collection-provider";
 import { usePhiMediaSpaceSelectionAllowed } from "./media-space-selection";
+import { readPhiMediaAssetTiles, readPhiMediaFolders, readPhiMediaPagination, readPhiMediaSpace, readPhiMediaSpaces, } from "./phi-image-preview-data";
 import { PHI_ASSET_CONTROLLER_STORE_KEY, } from "./asset-controller-signals";
 import { setPhiImagePreviewError, setPhiImagePreviewLoading, setPhiImagePreviewResults, usePhiImagePreviewStore, } from "./phi-image-preview-store";
-import { isPhiRecord } from "../../helpers/is-record";
 export const PHI_ASSET_COLLECTION_DATA_SOURCE = {
     providerKey: PHI_MEDIA_LIBRARY_DATA_PROVIDER_KEYS.collection,
     resourceKey: "assets",
@@ -29,22 +29,12 @@ export function buildPhiAssetCollectionQuery(state) {
     };
 }
 export function applyPhiAssetCollectionData(data, resolvedCollectionRequestKey) {
-    const folders = Array.isArray(data.meta?.folders)
-        ? data.meta.folders.filter(isPhiRecord)
-        : [];
-    const pagination = isPhiRecord(data.meta?.pagination)
-        ? data.meta.pagination
-        : null;
     setPhiImagePreviewResults(PHI_ASSET_CONTROLLER_STORE_KEY, {
-        activeSpace: isPhiRecord(data.meta?.activeSpace)
-            ? data.meta.activeSpace
-            : null,
-        spaces: Array.isArray(data.meta?.spaces)
-            ? data.meta.spaces.filter(isPhiRecord)
-            : [],
-        assets: data.items.filter(isPhiRecord),
-        folders,
-        pagination,
+        activeSpace: readPhiMediaSpace(data.meta?.activeSpace),
+        spaces: readPhiMediaSpaces(data.meta?.spaces),
+        assets: readPhiMediaAssetTiles(data.items),
+        folders: readPhiMediaFolders(data.meta?.folders),
+        pagination: readPhiMediaPagination(data.meta?.pagination),
         resolvedCollectionRequestKey,
     });
 }

package/components/media/media-font-metrics.d.ts

@@ -0,0 +1,3 @@
+import { type PhiFontMetrics } from "@phis/contracts/media";
+import { type PhiConfigReader } from "../widgets/config/strict-config-reader";
+export declare function readPhiFontMetricsFields(reader: PhiConfigReader): PhiFontMetrics;

package/components/media/media-font-metrics.js

@@ -0,0 +1,43 @@
+import { isPhiFontSubsetKey } from "@phis/contracts/media";
+import { requirePhiField, } from "../widgets/config/strict-config-reader";
+/*
+ * A font's metrics, read as the contract states them (`@phis/contracts/media`).
+ *
+ * The server measures them once, at upload, and writes every field. Two readers took them on trust: the
+ * public reference projection checked nothing below `font`, and the font list of the Theme took a stored
+ * `meta.font` for metrics as soon as it had a unit grid -- a record missing its ascent would have set a
+ * fallback face with `NaN` overrides. Both read through this now, so a wrong record is an error naming
+ * the field. `coverage` is the one field allowed to be absent: a font uploaded before cuts existed has
+ * none and is delivered whole.
+ */
+const nullableNumber = (reader, key) => reader.number(key) ?? null;
+const requiredNumber = (reader, key) => requirePhiField(reader, key, "a number", reader.number);
+function readPhiFontCoverage(reader) {
+    const subsets = requirePhiField(reader, "subsets", "a list of subset keys", (key) => reader.value(key, "a list of subset keys", (value) => Array.isArray(value) && value.every(isPhiFontSubsetKey) ? value : undefined));
+    const restRanges = reader.value("restRanges", "a list of [start, end] code point ranges", (value) => Array.isArray(value) && value.every((entry) => Array.isArray(entry) && entry.length === 2 &&
+        Number.isInteger(entry[0]) && Number.isInteger(entry[1]) &&
+        entry[0] >= 0 && entry[0] <= entry[1] && entry[1] <= 0x10ffff)
+        ? value
+        : undefined) ?? [];
+    return { subsets, restRanges };
+}
+export function readPhiFontMetricsFields(reader) {
+    const unitsPerEm = requiredNumber(reader, "unitsPerEm");
+    if (unitsPerEm <= 0)
+        reader.fail("unitsPerEm", "a positive number");
+    const coverage = reader.object("coverage", readPhiFontCoverage);
+    return {
+        format: requirePhiField(reader, "format", "a font container", (key) => reader.oneOf(key, ["sfnt", "woff", "woff2"])),
+        familyName: reader.string("familyName")?.trim() || null,
+        unitsPerEm,
+        ascent: requiredNumber(reader, "ascent"),
+        descent: requiredNumber(reader, "descent"),
+        lineGap: requiredNumber(reader, "lineGap"),
+        capHeight: nullableNumber(reader, "capHeight"),
+        xHeight: nullableNumber(reader, "xHeight"),
+        xWidthAvg: nullableNumber(reader, "xWidthAvg"),
+        xWidthAvgSource: reader.oneOf("xWidthAvgSource", ["glyphs", "os2"]) ?? null,
+        category: reader.oneOf("category", ["serif", "sans-serif", "monospace"]) ?? null,
+        ...(coverage ? { coverage } : {}),
+    };
+}