@beyondwork/docx-react-component 1.0.36 → 1.0.38

package/src/runtime/layout/index.ts

@@ -0,0 +1,233 @@
+/**
+ * Runtime-owned paginated layout engine — internal API surface.
+ *
+ * Runtime consumption (live, wired):
+ *   buildPageStack, computePageStack       — shipped façade
+ *   createLayoutEngine                     — stateful engine owned by DocumentRuntime
+ *   resolvePageStories                     — per-page header/footer variant selection
+ *   buildPageGraph                         — RuntimePageGraph construction
+ *   analyzeInvalidation / computeFieldDirtiness — invalidation + field dirtiness
+ *   createPageFragmentMapper               — offset ↔ fragment ↔ region mapping
+ *
+ * Measurement:
+ *   LayoutMeasurementProvider + empirical and canvas backends
+ *   DocxFontLoader — FontFace registration for canvas fidelity
+ *
+ * Nothing in this module is part of the package's public API.
+ */
+
+// ---------------------------------------------------------------------------
+// Façade (backward-compatible entry point)
+// ---------------------------------------------------------------------------
+
+export {
+  buildPageStack,
+  buildPageStackFrom,
+  computePageStack,
+  requiresFullRecompute,
+  type LayoutInvalidationReason,
+  type PageStackResult,
+} from "./paginated-layout-engine.ts";
+
+// ---------------------------------------------------------------------------
+// Stateful engine (Phase 1)
+// ---------------------------------------------------------------------------
+
+export {
+  createLayoutEngine,
+  findActivePageNode,
+  type LayoutEngineInstance,
+  type LayoutEngineViewState,
+  type LayoutEngineQueryInput,
+  type LayoutEngineEvent,
+  type CreateLayoutEngineOptions,
+} from "./layout-engine-instance.ts";
+
+// ---------------------------------------------------------------------------
+// Formatting resolution
+// ---------------------------------------------------------------------------
+
+export {
+  resolveBlockFormatting,
+  resolveTextWidth,
+  resolveCharsPerLine,
+  calculateParagraphHeight,
+  resolveNumberingPrefixLength,
+  type ResolvedParagraphFormatting,
+  type ResolvedTableRowFormatting,
+  type LayoutTabStop,
+} from "./resolved-formatting-state.ts";
+
+export {
+  buildResolvedFormattingState,
+  collectUsedFontFamilies,
+  populateNumberingInstances,
+  getResolvedParagraph,
+  getResolvedRun,
+  type ResolvedFormattingState,
+  type ResolvedRunFormatting,
+  type ResolvedFontCatalog,
+  type ResolvedFontDescriptor,
+  type ResolvedTabSettings,
+  type ResolvedNumberingGeometry,
+  type ResolvedDocumentSettings,
+  type NumberingInstanceMetadata,
+  type RunId,
+} from "./resolved-formatting-document.ts";
+
+// ---------------------------------------------------------------------------
+// Page story resolution + graph + fragment mapping
+// ---------------------------------------------------------------------------
+
+export {
+  resolvePageStories,
+  resolveDisplayPageNumber,
+  resolveTotalPageCount,
+  type ResolvedPageStories,
+} from "./page-story-resolver.ts";
+
+export {
+  buildPageGraph,
+  spliceGraph,
+  findPageNodeForOffset,
+  findPagesForSection,
+  findPageForStoryTarget,
+  toDocumentPageSnapshots,
+  type RuntimePageGraph,
+  type RuntimePageNode,
+  type RuntimePageRegions,
+  type RuntimePageRegion,
+  type RuntimeBlockFragment,
+  type RuntimeLineBox,
+  type RuntimeNoteAllocation,
+  type RuntimePageAnchor,
+  type BuildPageGraphInput,
+} from "./page-graph.ts";
+
+export {
+  createPageFragmentMapper,
+  rebuildMapper,
+  // Deprecated alias retained for one release after §6 E.5 rename:
+  updateMapperIncremental,
+  type PageFragmentMapper,
+  type PageFragmentLocation,
+  type PageSpan,
+} from "./page-fragment-mapper.ts";
+
+export {
+  derivePageLayoutSnapshotFromGraph,
+  deriveDocumentPageSnapshots,
+  deriveActivePageIndex,
+  deriveActiveSectionIndex,
+  deriveActivePage,
+} from "./page-layout-snapshot-adapter.ts";
+
+// ---------------------------------------------------------------------------
+// Invalidation + field dirtiness
+// ---------------------------------------------------------------------------
+
+export {
+  analyzeInvalidation,
+  computeFieldDirtiness,
+  type InvalidationResult,
+} from "./layout-invalidation.ts";
+
+// ---------------------------------------------------------------------------
+// Measurement provider
+// ---------------------------------------------------------------------------
+
+export {
+  createMeasurementProvider,
+  createEmpiricalMeasurementProvider,
+  type LayoutMeasurementProvider,
+  type MeasurementFidelity,
+  type MeasurementBackendPreference,
+  type CreateMeasurementProviderOptions,
+  type MeasureLineFragmentsInput,
+  type MeasuredLineFragments,
+  type MeasureInlineObjectInput,
+  type MeasuredInlineObject,
+  type MeasureTableBlockInput,
+  type MeasuredTableBlock,
+} from "./layout-measurement-provider.ts";
+
+export {
+  createDocxFontLoader,
+  type DocxFontLoader,
+  type FontLoaderInput,
+  type EmbeddedFontBytes,
+} from "./docx-font-loader.ts";
+
+// ---------------------------------------------------------------------------
+// Public facet (Phase 7)
+// ---------------------------------------------------------------------------
+
+export { createInertLayoutFacet } from "./inert-layout-facet.ts";
+
+export {
+  createLayoutFacet,
+  type WordReviewEditorLayoutFacet,
+  type PublicPageNode,
+  type PublicPageRegions,
+  type PublicPageRegion,
+  type PublicBlockFragment,
+  type PublicLineBox,
+  type PublicNoteAllocation,
+  type PublicPageAnchor,
+  type PublicPageSpan,
+  type PublicSectionNode,
+  type PublicResolvedPageStories,
+  type PublicResolvedParagraphFormatting,
+  type PublicResolvedRunFormatting,
+  type PublicBlockMeasurement,
+  type PublicMeasurementFidelity,
+  type PublicFieldDirtinessReport,
+  type LayoutFacetEvent,
+  type LayoutFacetInvalidationReason,
+  type RenderZoomSummary,
+  type CreateLayoutFacetInput,
+  type PageFormatDefinition,
+  type ActivePageFormat,
+  type MarginPresetDefinition,
+  type ActiveMarginPreset,
+} from "./public-facet.ts";
+
+// ---------------------------------------------------------------------------
+// Page-format catalog + margin preset catalog + locale defaults (R0.5)
+// ---------------------------------------------------------------------------
+
+export {
+  PAGE_FORMAT_CATALOG,
+  matchPageFormat,
+  getPageFormatById,
+  type PageFormatId,
+  type PageFormatRegion,
+  type PageFormatLocaleDefault,
+  type PageFormatDisplay,
+  type MatchPageFormatInput,
+} from "./page-format-catalog.ts";
+
+export {
+  MARGIN_PRESET_CATALOG,
+  matchMarginPreset,
+  getMarginPresetById,
+  type MarginPresetId,
+  type MatchMarginPresetInput,
+} from "./margin-preset-catalog.ts";
+
+export {
+  resolveDefaultPageFormat,
+  resolveDefaultPageSizeTwips,
+  type ResolveDefaultPageFormatOptions,
+} from "./default-page-format.ts";
+
+// ---------------------------------------------------------------------------
+// Workflow rail segments (R3a)
+// ---------------------------------------------------------------------------
+
+export {
+  collectScopeRailSegments,
+  type CollectScopeRailSegmentsInput,
+  type ScopeRailPosture,
+  type ScopeRailSegment,
+} from "../workflow-rail-segments.ts";

package/src/runtime/layout/inert-layout-facet.ts

@@ -0,0 +1,59 @@
+/**
+ * Inert layout facet used during the runtime-loading phase.
+ *
+ * Returns empty or null values for every query; `subscribe` is a no-op.
+ * The React shell replaces this with the real facet once the runtime is
+ * ready, so consumers never see a "missing" facet — only an empty one.
+ */
+
+import type {
+  LayoutFacetEvent,
+  PublicFieldDirtinessReport,
+  PublicMeasurementFidelity,
+  WordReviewEditorLayoutFacet,
+} from "./public-facet.ts";
+import { MARGIN_PRESET_CATALOG } from "./margin-preset-catalog.ts";
+import { PAGE_FORMAT_CATALOG } from "./page-format-catalog.ts";
+
+export function createInertLayoutFacet(): WordReviewEditorLayoutFacet {
+  const emptyReport: PublicFieldDirtinessReport = {
+    families: [],
+    revision: 0,
+  };
+  const fidelity: PublicMeasurementFidelity = "empirical";
+  return {
+    getPageCount: () => 0,
+    getPage: () => null,
+    getPages: () => [],
+    getSection: () => null,
+    getSections: () => [],
+    getPageForOffset: () => null,
+    getPageSpanForSelection: () => null,
+    getFragmentForOffset: () => null,
+    getAnchorForOffset: () => null,
+    getActiveStoriesOnPage: () => null,
+    getDisplayPageNumber: () => null,
+    getLineBoxes: () => [],
+    getLineBoxesForRegion: () => [],
+    getFragmentsForPage: () => [],
+    getPageFormatCatalog: () => PAGE_FORMAT_CATALOG,
+    getActivePageFormat: () => null,
+    getMarginPresetCatalog: () => MARGIN_PRESET_CATALOG,
+    getActiveMarginPreset: () => null,
+    getRenderFrame: () => null,
+    getRenderZoom: () => null,
+    hitTest: () => null,
+    getAnchorRects: () => [],
+    getScopeRailSegments: () => [],
+    getAllScopeRailSegments: () => [],
+    getResolvedFormatting: () => null,
+    getResolvedRunFormatting: () => null,
+    getMeasurement: () => null,
+    getMeasurementFidelity: () => fidelity,
+    whenMeasurementReady: () => Promise.resolve(),
+    getTableRenderPlan: () => null,
+    getDirtyFieldFamilies: () => [],
+    getFieldDirtinessReport: () => emptyReport,
+    subscribe: (_listener: (event: LayoutFacetEvent) => void) => () => undefined,
+  };
+}