@stll/folio-core 0.47.7 → 0.49.0

package/dist/layout-engine/types.d.ts

@@ -2,7 +2,7 @@ import { OutlineStyleAttr } from "../types/documentEnumValues.js";
 import { CssBorderStyle } from "../utils/borderCss.js";
 import { ImagePosition, ImageWrap, InlineWrapper, NumberFormat, OutlineLevel, ParagraphNumberingOverride, PreviewDescriptor, SdtProperties, SdtType, SectionStart, ShapeTextBody, TableCellFormatting, TableWidthType, UnderlineStyle, VerticalAlign } from "@stll/docx-core/model";
 declare namespace types_d_exports {
-  export { BlockId, BorderStyle, CellBorderSpec, CellBorders, ColumnBreakBlock, ColumnBreakMeasure, ColumnLayout, DEFAULT_TEXTBOX_MARGINS, DEFAULT_TEXTBOX_WIDTH, DocumentPosition, FOOTNOTE_ENTRY_MARGIN_BOTTOM, FOOTNOTE_FALLBACK_LINE_HEIGHT, FOOTNOTE_SEPARATOR_HEIGHT, FieldRun, FloatingTablePosition, FlowBlock, FootnoteContent, Fragment, FragmentBase, HeaderFooterContent, HeaderFooterContentHeights, HeaderFooterLayout, HitTestResult, HyperlinkInfo, ImageBlock, ImageFragment, ImageMeasure, ImageRun, ImageRunPosition, Layout, LayoutOptions, LineBreakRun, ListMarkerFormatting, MathRun, Measure, MeasuredLine, Page, PageBreakBlock, PageBreakMeasure, PageHeaderFooterRefs, PageMargins, ParagraphAttrs, ParagraphBlock, ParagraphBorders, ParagraphFragment, ParagraphIndent, ParagraphMeasure, ParagraphSpacing, RenderedPageBreakRun, Run, RunFormatting, SdtGroup, SectionBreakBlock, SectionBreakMeasure, SectionPageNumbering, TabAlignment, TabRun, TabStop, TableBlock, TableCell, TableCellMeasure, TableFragment, TableMeasure, TableRow, TableRowMeasure, TextBoxBlock, TextBoxFlowAttrs, TextBoxFragment, TextBoxMeasure, TextRun, floatingTextBoxReservesBand, floatingTextBoxWrapsText, getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, isListNumPr, isTextWrappingFloatingImageRun, resolveTableCellPadding, resolveTableWidthPx, tableColumnsArePinned };
+  export { BlockId, BorderStyle, CellBorderSpec, CellBorders, ColumnBreakBlock, ColumnBreakMeasure, ColumnLayout, DEFAULT_TEXTBOX_MARGINS, DEFAULT_TEXTBOX_WIDTH, DocumentPosition, FOOTNOTE_ENTRY_MARGIN_BOTTOM, FOOTNOTE_FALLBACK_LINE_HEIGHT, FOOTNOTE_SEPARATOR_HEIGHT, FieldRun, FloatingTablePosition, FlowBlock, FootnoteContent, Fragment, FragmentBase, HeaderFooterContent, HeaderFooterContentHeights, HeaderFooterLayout, HitTestResult, HyperlinkInfo, ImageBlock, ImageFragment, ImageMeasure, ImageRun, ImageRunPosition, Layout, LayoutOptions, LineBreakRun, ListMarkerFormatting, MathRun, Measure, MeasuredLine, NOTE_SEPARATOR_RULE_THICKNESS, NOTE_SEPARATOR_WIDTH_FRACTION, NoteAreaLayout, NoteSeparatorKind, NoteSeparatorRule, Page, PageBreakBlock, PageBreakMeasure, PageHeaderFooterRefs, PageMargins, ParagraphAttrs, ParagraphBlock, ParagraphBorders, ParagraphFragment, ParagraphIndent, ParagraphMeasure, ParagraphSpacing, RenderedPageBreakRun, Run, RunFormatting, SdtGroup, SectionBreakBlock, SectionBreakMeasure, SectionPageNumbering, TabAlignment, TabRun, TabStop, TableBlock, TableCell, TableCellMeasure, TableFragment, TableMeasure, TableRow, TableRowMeasure, TextBoxBlock, TextBoxFlowAttrs, TextBoxFragment, TextBoxGradientFill, TextBoxMeasure, TextRun, floatingTextBoxReservesBand, floatingTextBoxWrapsText, getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, isListNumPr, isTextWrappingFloatingImageRun, resolveTableCellPadding, resolveTableWidthPx, stripFlowBlockPmAnchors, tableColumnsArePinned };
 }
 /**
  * Unique identifier for a block in the document.
@@ -47,6 +47,11 @@ type RunFormatting = {
   eastAsiaFontFamily?: string;
   /** OOXML alternate-name fallback for `eastAsiaFontFamily`. */
   eastAsiaAlternateFontFamily?: string;
+  /**
+   * `w:rFonts/@w:hint="eastAsia"`: the symbols and punctuation shared with East
+   * Asian text also take `eastAsiaFontFamily` (see `isEastAsiaHintCodePoint`).
+   */
+  eastAsiaHint?: boolean;
   /**
    * Resolved complex-script font (`w:cs` / `cstheme`). Arabic, Hebrew, Indic
    * and South-East Asian code points in this run measure and paint with this
@@ -155,7 +160,7 @@ type RunFormatting = {
   /** Groups a suggestion's runs for accept/reject and scroll-to. */
   suggestionId?: string;
 };
-type ListMarkerFormatting = Pick<RunFormatting, "fontFamily" | "alternateFontFamily" | "eastAsiaFontFamily" | "eastAsiaAlternateFontFamily" | "complexScriptFontFamily" | "complexScriptAlternateFontFamily" | "fontSize" | "complexScriptFontSize" | "bold" | "complexScriptBold" | "italic" | "complexScriptItalic" | "rtl" | "forceComplexScript">;
+type ListMarkerFormatting = Pick<RunFormatting, "fontFamily" | "alternateFontFamily" | "eastAsiaFontFamily" | "eastAsiaAlternateFontFamily" | "complexScriptFontFamily" | "complexScriptAlternateFontFamily" | "fontSize" | "complexScriptFontSize" | "bold" | "complexScriptBold" | "italic" | "complexScriptItalic" | "rtl" | "forceComplexScript" | "color">;
 /**
  * Hyperlink information for a run.
  */
@@ -519,6 +524,12 @@ type ParagraphAttrs = {
    * one space glyph; `nothing` lets body text butt against the marker.
    */
   listMarkerSuffix?: "tab" | "space" | "nothing";
+  /**
+   * `w:doNotUseIndentAsNumberingTabStop` (§17.15.3): the hanging indent is
+   * not an implicit stop for the tab after the number, so the first custom
+   * stop past the marker wins wherever it is.
+   */
+  listNumberingTabIgnoresIndent?: boolean;
   /**
    * Tracked-change state of the list numbering itself. When a list is applied
    * (or removed) under suggesting mode, the marker paints in the insertion /
@@ -681,6 +692,14 @@ type TableBlock = {
   justification?: "left" | "center" | "right";
   /** Table indent from the leading margin (in pixels, from w:tblInd). */
   indent?: number;
+  /**
+   * Default cell spacing in pixels (`w:tblCellSpacing`, §17.4.43). Each cell
+   * box sits this far inside its grid slot on every side, so adjacent cells
+   * stand twice this apart, and the table edge adds one more unit around the
+   * outermost cells. Borders then follow the separated model: every cell
+   * paints its own four edges.
+   */
+  cellSpacing?: number;
   /**
    * Pre-Word-2013 `w:tblInd` semantics: the indent measures to the leading
    * cell's text edge instead of the table border. Derived from the document's
@@ -830,6 +849,21 @@ declare const DEFAULT_TEXTBOX_MARGINS: {
 };
 /** Default text box width in pixels when no width is specified */
 declare const DEFAULT_TEXTBOX_WIDTH = 200;
+/**
+ * A linear DrawingML gradient fill with its colors resolved (ECMA-376
+ * §20.1.8.33, §20.1.8.41). It runs along `angle`, in degrees clockwise from
+ * the positive x axis; when `scaled`, that angle is stated in the unit square
+ * and stretched with the box.
+ */
+type TextBoxGradientFill = {
+  angle: number;
+  scaled: boolean;
+  /** Stops in ascending order; `offset` runs 0 to 1. */
+  stops: {
+    offset: number;
+    color: string;
+  }[];
+};
 /**
  * Text box block — positioned container with block content.
  */
@@ -850,6 +884,8 @@ type TextBoxBlock = {
   verticalAlign?: ShapeTextBody["anchor"];
   /** Fill/background color */
   fillColor?: string;
+  /** Gradient fill, painted when no `fillColor` states a solid one. */
+  fillGradient?: TextBoxGradientFill;
   /** Border width in pixels */
   outlineWidth?: number;
   /** Border color */
@@ -865,6 +901,23 @@ type TextBoxBlock = {
     left: number;
     right: number;
   };
+  /**
+   * An inline box's `wp:effectExtent`, in pixels. The line reserves these
+   * beyond the box's own extent on each side, so the box sits `left`/`top`
+   * inside the space it occupies (ECMA-376 §20.4.2.6).
+   */
+  effectExtent?: {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+  };
+  /**
+   * The paragraph an inline box is the only content of. The box is run
+   * content of that paragraph, so its spacing surrounds the box and its
+   * indentation and alignment place it on the line.
+   */
+  hostParagraph?: ParagraphAttrs;
   /** Flow blocks inside the text box */
   content: (ParagraphBlock | TableBlock)[];
   /** Display mode copied from the ProseMirror text box node. */
@@ -1208,9 +1261,23 @@ type Page = {
   footnoteIds?: number[];
   /** Height reserved for the footnote area at page bottom (pixels). */
   footnoteReservedHeight?: number;
+  /**
+   * Rules drawn for the `w:separator` / `w:continuationSeparator` marks of a
+   * note area that flows with the body (endnotes), in page coordinates.
+   */
+  noteSeparators?: NoteSeparatorRule[];
   /** Column layout for this page (if multi-column). */
   columns?: ColumnLayout;
 };
+/**
+ * One separator rule of a flowed note area: the top-left corner of a
+ * `NOTE_SEPARATOR_RULE_THICKNESS`-high rule and its width, in page pixels.
+ */
+type NoteSeparatorRule = {
+  x: number;
+  y: number;
+  width: number;
+};
 /**
  * Column layout configuration.
  */
@@ -1291,6 +1358,8 @@ type LayoutOptions = {
   firstPageMargins?: PageMargins;
   /** Per-section body margins used on even authored page numbers. */
   sectionEvenPageMargins?: (PageMargins | undefined)[];
+  /** Per-section body margins used on the first page of a `w:titlePg` section. */
+  sectionFirstPageMargins?: (PageMargins | undefined)[];
   /** Page-number policy for the initial section. */
   pageNumbering?: SectionPageNumbering;
   /** Body-level final section page size. */
@@ -1341,6 +1410,32 @@ type LayoutOptions = {
   footnoteHeightById?: Map<number, number>;
   /** Header/footer references for each document section, by section index. */
   sectionHeaderFooterRefs?: PageHeaderFooterRefs[];
+  /** Note areas (endnotes) whose blocks flow with the body blocks. */
+  noteAreas?: NoteAreaLayout;
+};
+/** Which separator story a flowed note-area block renders. */
+type NoteSeparatorKind = "separator" | "continuationSeparator";
+/**
+ * Note areas laid out in the body flow (ECMA-376 §17.11): endnotes collected
+ * at the end of the document or of a section. Their blocks sit in the body's
+ * block list; this names the ones the paginator treats specially.
+ */
+type NoteAreaLayout = {
+  /**
+   * Separator-story paragraphs that carry a `w:separator` mark, keyed by block
+   * id. A rule is drawn across the first line of each of their fragments.
+   */
+  separatorBlockIds: ReadonlyMap<string, NoteSeparatorKind>;
+  /**
+   * Note content blocks. A page opened while one of them is laid out
+   * continues the area, so it starts with the continuation separator.
+   */
+  contentBlockIds: ReadonlySet<string>;
+  /** The `w:continuationSeparator` story's first paragraph, already measured. */
+  continuationSeparator?: {
+    block: ParagraphBlock;
+    measure: ParagraphMeasure;
+  };
 };
 /**
  * Result of hit-testing a click position.
@@ -1383,6 +1478,10 @@ declare const FOOTNOTE_SEPARATOR_HEIGHT = 12;
  * present in the source DOCX.
  */
 declare const FOOTNOTE_ENTRY_MARGIN_BOTTOM = 0;
+/** Thickness of a note separator rule, in the footnote band and in flowed endnotes. */
+declare const NOTE_SEPARATOR_RULE_THICKNESS = 0.5;
+/** Width of a `w:separator` rule as a fraction of its column. */
+declare const NOTE_SEPARATOR_WIDTH_FRACTION = 0.33;
 /**
  * Line height used when a footnote entry has no measured line height yet.
  * Conservative fallback so a missing measure does not collapse the entry.
@@ -1489,5 +1588,11 @@ declare function tableColumnsArePinned(table: TableBlock): boolean;
 declare function resolveTableWidthPx(width: number | undefined, widthType: TableWidthType | undefined, containerWidth: number): number | undefined;
 /** Return the leading visual offset for a row with omitted grid columns. */
 declare const getTableRowLeadingWidth: (row: TableRow, columnWidths: readonly number[]) => number;
+/**
+ * A copy of a block with every ProseMirror anchor removed. A note story's
+ * blocks carry positions in the note's own document; painted beside the body
+ * they must not resolve a click, a selection or a caret into the body.
+ */
+declare function stripFlowBlockPmAnchors(block: FlowBlock): FlowBlock;
 //#endregion
-export { BlockId, BorderStyle, CellBorderSpec, CellBorders, ColumnBreakBlock, ColumnBreakMeasure, ColumnLayout, DEFAULT_TEXTBOX_MARGINS, DEFAULT_TEXTBOX_WIDTH, DocumentPosition, FOOTNOTE_ENTRY_MARGIN_BOTTOM, FOOTNOTE_FALLBACK_LINE_HEIGHT, FOOTNOTE_SEPARATOR_HEIGHT, FieldRun, FloatingTablePosition, FlowBlock, FootnoteContent, Fragment, FragmentBase, HeaderFooterContent, HeaderFooterContentHeights, HeaderFooterLayout, HitTestResult, HyperlinkInfo, ImageBlock, ImageFragment, ImageMeasure, ImageRun, ImageRunPosition, Layout, LayoutOptions, LineBreakRun, ListMarkerFormatting, MathRun, Measure, MeasuredLine, Page, PageBreakBlock, PageBreakMeasure, PageHeaderFooterRefs, PageMargins, ParagraphAttrs, ParagraphBlock, ParagraphBorders, ParagraphFragment, ParagraphIndent, ParagraphMeasure, ParagraphSpacing, RenderedPageBreakRun, Run, RunFormatting, SdtGroup, SectionBreakBlock, SectionBreakMeasure, SectionPageNumbering, TabAlignment, TabRun, TabStop, TableBlock, TableCell, TableCellMeasure, TableFragment, TableMeasure, TableRow, TableRowMeasure, TextBoxBlock, TextBoxFlowAttrs, TextBoxFragment, TextBoxMeasure, TextRun, floatingTextBoxReservesBand, floatingTextBoxWrapsText, getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, isListNumPr, isTextWrappingFloatingImageRun, resolveTableCellPadding, resolveTableWidthPx, tableColumnsArePinned, types_d_exports };
+export { BlockId, BorderStyle, CellBorderSpec, CellBorders, ColumnBreakBlock, ColumnBreakMeasure, ColumnLayout, DEFAULT_TEXTBOX_MARGINS, DEFAULT_TEXTBOX_WIDTH, DocumentPosition, FOOTNOTE_ENTRY_MARGIN_BOTTOM, FOOTNOTE_FALLBACK_LINE_HEIGHT, FOOTNOTE_SEPARATOR_HEIGHT, FieldRun, FloatingTablePosition, FlowBlock, FootnoteContent, Fragment, FragmentBase, HeaderFooterContent, HeaderFooterContentHeights, HeaderFooterLayout, HitTestResult, HyperlinkInfo, ImageBlock, ImageFragment, ImageMeasure, ImageRun, ImageRunPosition, Layout, LayoutOptions, LineBreakRun, ListMarkerFormatting, MathRun, Measure, MeasuredLine, NOTE_SEPARATOR_RULE_THICKNESS, NOTE_SEPARATOR_WIDTH_FRACTION, NoteAreaLayout, NoteSeparatorKind, NoteSeparatorRule, Page, PageBreakBlock, PageBreakMeasure, PageHeaderFooterRefs, PageMargins, ParagraphAttrs, ParagraphBlock, ParagraphBorders, ParagraphFragment, ParagraphIndent, ParagraphMeasure, ParagraphSpacing, RenderedPageBreakRun, Run, RunFormatting, SdtGroup, SectionBreakBlock, SectionBreakMeasure, SectionPageNumbering, TabAlignment, TabRun, TabStop, TableBlock, TableCell, TableCellMeasure, TableFragment, TableMeasure, TableRow, TableRowMeasure, TextBoxBlock, TextBoxFlowAttrs, TextBoxFragment, TextBoxGradientFill, TextBoxMeasure, TextRun, floatingTextBoxReservesBand, floatingTextBoxWrapsText, getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, isListNumPr, isTextWrappingFloatingImageRun, resolveTableCellPadding, resolveTableWidthPx, stripFlowBlockPmAnchors, tableColumnsArePinned, types_d_exports };

package/dist/layout-engine/types.js

@@ -7,6 +7,8 @@ var types_exports = /* @__PURE__ */ __exportAll({
 	FOOTNOTE_ENTRY_MARGIN_BOTTOM: () => 0,
 	FOOTNOTE_FALLBACK_LINE_HEIGHT: () => 13,
 	FOOTNOTE_SEPARATOR_HEIGHT: () => 12,
+	NOTE_SEPARATOR_RULE_THICKNESS: () => NOTE_SEPARATOR_RULE_THICKNESS,
+	NOTE_SEPARATOR_WIDTH_FRACTION: () => NOTE_SEPARATOR_WIDTH_FRACTION,
 	floatingTextBoxReservesBand: () => floatingTextBoxReservesBand,
 	floatingTextBoxWrapsText: () => floatingTextBoxWrapsText,
 	getTableRowLeadingWidth: () => getTableRowLeadingWidth,
@@ -16,6 +18,7 @@ var types_exports = /* @__PURE__ */ __exportAll({
 	isTextWrappingFloatingImageRun: () => isTextWrappingFloatingImageRun,
 	resolveTableCellPadding: () => resolveTableCellPadding,
 	resolveTableWidthPx: () => resolveTableWidthPx,
+	stripFlowBlockPmAnchors: () => stripFlowBlockPmAnchors,
 	tableColumnsArePinned: () => tableColumnsArePinned
 });
 /**
@@ -69,6 +72,10 @@ const FOOTNOTE_SEPARATOR_HEIGHT = 12;
 * present in the source DOCX.
 */
 const FOOTNOTE_ENTRY_MARGIN_BOTTOM = 0;
+/** Thickness of a note separator rule, in the footnote band and in flowed endnotes. */
+const NOTE_SEPARATOR_RULE_THICKNESS = .5;
+/** Width of a `w:separator` rule as a fraction of its column. */
+const NOTE_SEPARATOR_WIDTH_FRACTION = .33;
 /**
 * Line height used when a footnote entry has no measured line height yet.
 * Conservative fallback so a missing measure does not collapse the entry.
@@ -189,5 +196,93 @@ const getTableRowLeadingWidth = (row, columnWidths) => {
 	if (tableRowOwnsNestedGrid(row)) return 0;
 	return columnWidths.slice(0, row.gridBefore ?? 0).reduce((sum, columnWidth) => sum + columnWidth, 0);
 };
+/**
+* A copy of a block with every ProseMirror anchor removed. A note story's
+* blocks carry positions in the note's own document; painted beside the body
+* they must not resolve a click, a selection or a caret into the body.
+*/
+function stripFlowBlockPmAnchors(block) {
+	switch (block.kind) {
+		case "paragraph": return stripParagraphPmAnchors(block);
+		case "table": return stripTablePmAnchors(block);
+		case "image": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...image } = block;
+			return image;
+		}
+		case "textBox": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...textBox } = block;
+			return {
+				...textBox,
+				content: textBox.content.map((contentBlock) => contentBlock.kind === "table" ? stripTablePmAnchors(contentBlock) : stripParagraphPmAnchors(contentBlock))
+			};
+		}
+		case "pageBreak":
+		case "columnBreak": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...breakBlock } = block;
+			return breakBlock;
+		}
+		case "sectionBreak": return block;
+		default: return block;
+	}
+}
+function stripTablePmAnchors(block) {
+	const { pmStart: _pmStart, pmEnd: _pmEnd, ...table } = block;
+	return {
+		...table,
+		rows: table.rows.map(stripTableRowPmAnchors)
+	};
+}
+function stripTableRowPmAnchors(row) {
+	return {
+		...row,
+		cells: row.cells.map(stripTableCellPmAnchors)
+	};
+}
+function stripTableCellPmAnchors(cell) {
+	return {
+		...cell,
+		blocks: cell.blocks.map(stripFlowBlockPmAnchors)
+	};
+}
+function stripParagraphPmAnchors(block) {
+	const { pmStart: _pmStart, pmEnd: _pmEnd, ...paragraph } = block;
+	return {
+		...paragraph,
+		runs: paragraph.runs.map(stripRunPmAnchors)
+	};
+}
+function stripRunPmAnchors(run) {
+	switch (run.kind) {
+		case "text": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...textRun } = run;
+			return textRun;
+		}
+		case "tab": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...tabRun } = run;
+			return tabRun;
+		}
+		case "image": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...imageRun } = run;
+			return imageRun;
+		}
+		case "lineBreak": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...lineBreakRun } = run;
+			return lineBreakRun;
+		}
+		case "field": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...fieldRun } = run;
+			return fieldRun;
+		}
+		case "math": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...mathRun } = run;
+			return mathRun;
+		}
+		case "renderedPageBreak": {
+			const { pmStart: _pmStart, pmEnd: _pmEnd, ...breakRun } = run;
+			return breakRun;
+		}
+		default: return run;
+	}
+}
 //#endregion
-export { DEFAULT_TEXTBOX_MARGINS, DEFAULT_TEXTBOX_WIDTH, FOOTNOTE_ENTRY_MARGIN_BOTTOM, FOOTNOTE_FALLBACK_LINE_HEIGHT, FOOTNOTE_SEPARATOR_HEIGHT, floatingTextBoxReservesBand, floatingTextBoxWrapsText, getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, isListNumPr, isTextWrappingFloatingImageRun, resolveTableCellPadding, resolveTableWidthPx, tableColumnsArePinned, types_exports };
+export { DEFAULT_TEXTBOX_MARGINS, DEFAULT_TEXTBOX_WIDTH, FOOTNOTE_ENTRY_MARGIN_BOTTOM, FOOTNOTE_FALLBACK_LINE_HEIGHT, FOOTNOTE_SEPARATOR_HEIGHT, NOTE_SEPARATOR_RULE_THICKNESS, NOTE_SEPARATOR_WIDTH_FRACTION, floatingTextBoxReservesBand, floatingTextBoxWrapsText, getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, isListNumPr, isTextWrappingFloatingImageRun, resolveTableCellPadding, resolveTableWidthPx, stripFlowBlockPmAnchors, tableColumnsArePinned, types_exports };

package/dist/layout-painter/index.d.ts

@@ -1,4 +1,5 @@
 import { FlowBlock, Layout, Measure } from "../layout-engine/types.js";
+import { NoteStoryKey } from "../types/editor-story.js";
 import { RenderContext } from "./renderUtils.js";
 import { BlockFor, FeatureDispatchInput, FeatureFallback, FeatureModule, FeatureRenderInput, FragmentFor, MeasureFor } from "./registry/types.js";
 import { FeatureRegistry, createFeatureRegistry } from "./registry/registry.js";
@@ -17,6 +18,8 @@ type BlockLookupEntry = {
   block: FlowBlock;
   measure: Measure;
   version?: string;
+  /** The note story a block flowed with the body belongs to (endnote content). */
+  noteStory?: NoteStoryKey;
 };
 /**
  * Block lookup map type

package/dist/layout-painter/renderPage.js

@@ -1,8 +1,9 @@
 import { resolveFloatingTableX } from "../layout-engine/measure/floatingTablePosition.js";
 import { rectsToFloatingZones } from "../layout-engine/measure/floatingZones.js";
+import { DEFAULT_FONT_FAMILY } from "../layout-engine/measure/measureHelpers.js";
 import { measureParagraph } from "../layout-engine/measure/measureParagraph.js";
 import { resolveTableInlineOffset } from "../layout-engine/measure/tableInlinePlacement.js";
-import { floatingTextBoxReservesBand, floatingTextBoxWrapsText, isFloatingImageRun, isFloatingTextBoxBlock, isTextWrappingFloatingImageRun } from "../layout-engine/types.js";
+import { NOTE_SEPARATOR_RULE_THICKNESS, NOTE_SEPARATOR_WIDTH_FRACTION, floatingTextBoxReservesBand, floatingTextBoxWrapsText, isFloatingImageRun, isFloatingTextBoxBlock, isTextWrappingFloatingImageRun, stripFlowBlockPmAnchors } from "../layout-engine/types.js";
 import { cssBorderStyle } from "../utils/borderCss.js";
 import { resolveFontFamily } from "../utils/fontResolver.js";
 import { borderToStyle } from "../utils/formatToStyle.js";
@@ -43,7 +44,7 @@ const PAGE_CLASS_NAMES = {
 };
 const HEADER_FOOTER_RULE_CLIP_MARGIN = pointsToPixels(1.5);
 const DEFAULT_MARGIN_GUIDE_COLOR = "#c0c0c0";
-const getDefaultPageFontFamily = () => resolveFontFamily("Calibri").cssFallback;
+const getDefaultPageFontFamily = () => resolveFontFamily(DEFAULT_FONT_FAMILY).cssFallback;
 /**
 * Apply page styles to an element
 */
@@ -603,6 +604,25 @@ function calculateFootnoteAreaRenderHeight(footnotes) {
 	}
 	return height;
 }
+/** A note separator rule: the canvas ink colour, `NOTE_SEPARATOR_RULE_THICKNESS` high. */
+function applyNoteSeparatorRuleStyles(element, width) {
+	element.style.width = `${width}px`;
+	element.style.height = `${NOTE_SEPARATOR_RULE_THICKNESS}px`;
+	element.style.backgroundColor = "var(--doc-canvas-text, #000)";
+}
+/** The separator rules of a note area that flows with the body (endnotes). */
+function renderFlowedNoteSeparators(page, contentEl, doc) {
+	for (const rule of page.noteSeparators ?? []) {
+		const ruleEl = doc.createElement("div");
+		ruleEl.className = "layout-note-separator";
+		applyNoteSeparatorRuleStyles(ruleEl, rule.width);
+		ruleEl.style.position = "absolute";
+		ruleEl.style.left = `${rule.x - page.margins.left}px`;
+		ruleEl.style.top = `${rule.y - page.margins.top}px`;
+		ruleEl.style.pointerEvents = "none";
+		contentEl.append(ruleEl);
+	}
+}
 /**
 * Render the footnote area at the bottom of a page.
 * Includes a separator line (33% width) and footnote entries.
@@ -612,11 +632,8 @@ function renderFootnoteArea(footnotes, contentWidth, doc, context) {
 	container.className = "layout-footnote-area";
 	container.style.width = `${contentWidth}px`;
 	const separator = doc.createElement("div");
-	const separatorRuleHeight = .5;
-	const separatorMargin = (12 - separatorRuleHeight) / 2;
-	separator.style.width = "33%";
-	separator.style.height = `${separatorRuleHeight}px`;
-	separator.style.backgroundColor = "var(--doc-canvas-text, #000)";
+	const separatorMargin = (12 - NOTE_SEPARATOR_RULE_THICKNESS) / 2;
+	applyNoteSeparatorRuleStyles(separator, contentWidth * NOTE_SEPARATOR_WIDTH_FRACTION);
 	separator.style.marginTop = `${separatorMargin}px`;
 	separator.style.marginBottom = `${separatorMargin}px`;
 	container.append(separator);
@@ -674,7 +691,7 @@ function renderFootnoteContent(footnote, contentWidth, doc, context) {
 	return wrapper;
 }
 function renderFootnoteBlock(block, measure, contentWidth, y, context, doc) {
-	const renderBlock = stripFootnotePmAnchors(block);
+	const renderBlock = stripFlowBlockPmAnchors(block);
 	if (renderBlock.kind === "paragraph" && measure.kind === "paragraph") {
 		const element = renderParagraphFragment({
 			kind: "paragraph",
@@ -732,81 +749,6 @@ function renderFootnoteBlock(block, measure, contentWidth, y, context, doc) {
 	}
 	return null;
 }
-function stripFootnotePmAnchors(block) {
-	switch (block.kind) {
-		case "paragraph": return stripFootnoteParagraphPmAnchors(block);
-		case "table": return stripFootnoteTablePmAnchors(block);
-		case "image": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...image } = block;
-			return image;
-		}
-		case "textBox": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...textBox } = block;
-			return {
-				...textBox,
-				content: textBox.content.map((contentBlock) => contentBlock.kind === "table" ? stripFootnoteTablePmAnchors(contentBlock) : stripFootnoteParagraphPmAnchors(contentBlock))
-			};
-		}
-		case "pageBreak":
-		case "columnBreak": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...breakBlock } = block;
-			return breakBlock;
-		}
-		case "sectionBreak": return block;
-		default: return block;
-	}
-}
-function stripFootnoteTablePmAnchors(block) {
-	const { pmStart: _pmStart, pmEnd: _pmEnd, ...table } = block;
-	return {
-		...table,
-		rows: table.rows.map(stripFootnoteTableRowPmAnchors)
-	};
-}
-function stripFootnoteTableRowPmAnchors(row) {
-	return {
-		...row,
-		cells: row.cells.map(stripFootnoteTableCellPmAnchors)
-	};
-}
-function stripFootnoteTableCellPmAnchors(cell) {
-	return {
-		...cell,
-		blocks: cell.blocks.map(stripFootnotePmAnchors)
-	};
-}
-function stripFootnoteParagraphPmAnchors(block) {
-	const { pmStart: _pmStart, pmEnd: _pmEnd, ...paragraph } = block;
-	return {
-		...paragraph,
-		runs: paragraph.runs.map(stripFootnoteRunPmAnchors)
-	};
-}
-function stripFootnoteRunPmAnchors(run) {
-	switch (run.kind) {
-		case "text": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...textRun } = run;
-			return textRun;
-		}
-		case "tab": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...tabRun } = run;
-			return tabRun;
-		}
-		case "image": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...imageRun } = run;
-			return imageRun;
-		}
-		case "lineBreak": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...lineBreakRun } = run;
-			return lineBreakRun;
-		}
-		case "field": {
-			const { pmStart: _pmStart, pmEnd: _pmEnd, ...fieldRun } = run;
-			return fieldRun;
-		}
-		default: return run;
-	}
-}
 function positionFootnoteBlock(element, top, width, height) {
 	element.style.position = "absolute";
 	element.style.left = "0";
@@ -1040,6 +982,11 @@ function renderPage(page, context, options = {}) {
 			left: page.margins.left,
 			top: page.margins.top
 		});
+		const noteStory = options.blockLookup?.get(String(fragment.blockId))?.noteStory;
+		if (noteStory) {
+			fragmentEl.dataset["noteKind"] = noteStory.kind;
+			fragmentEl.dataset["noteId"] = String(noteStory.noteId);
+		}
 		contentEl.append(fragmentEl);
 	}
 	if (frontFloatingImages.length > 0) {
@@ -1064,6 +1011,7 @@ function renderPage(page, context, options = {}) {
 			contentEl.append(line);
 		}
 	}
+	renderFlowedNoteSeparators(page, contentEl, doc);
 	if (options.footnoteArea && options.footnoteArea.length > 0) {
 		const fnAreaEl = renderFootnoteArea(options.footnoteArea, contentWidth, doc, context);
 		fnAreaEl.style.position = "absolute";
@@ -1425,6 +1373,7 @@ function runContentKey(run) {
 	if (run.forceComplexScript !== void 0) parts.push(`cs-force:${run.forceComplexScript}`);
 	if (run.eastAsiaFontFamily) parts.push(`ea:${run.eastAsiaFontFamily}`);
 	if (run.eastAsiaAlternateFontFamily) parts.push(`ea-alt:${run.eastAsiaAlternateFontFamily}`);
+	if (run.eastAsiaHint !== void 0) parts.push(`ea-hint:${run.eastAsiaHint}`);
 	if (run.fontSize !== void 0) parts.push(`fs:${run.fontSize}`);
 	if (run.letterSpacing !== void 0) parts.push(`ls:${run.letterSpacing}`);
 	if (run.superscript) parts.push("sup");

package/dist/layout-painter/renderParagraph.d.ts

@@ -30,6 +30,11 @@ type RenderParagraphOptions = {
   renderedInlineImageKeys?: Set<string>;
 };
 declare function getRenderableTextColor(run: TextRun | TabRun): string | undefined;
+/**
+ * The colour a list marker paints in, or undefined for the canvas text colour.
+ * Black and `auto` fall back to the canvas colour, as they do for runs.
+ */
+declare function getRenderableListMarkerColor(color: string | undefined): string | undefined;
 /**
  * How CSS spells each bidirectional wrapper: an override switches the
  * bidirectional algorithm off for its content, an embedding opens a level and
@@ -147,4 +152,4 @@ declare const paragraphHasTrackedChanges: (block: ParagraphBlock) => boolean;
  */
 declare function renderParagraphFragment(fragment: ParagraphFragment, block: ParagraphBlock, measure: ParagraphMeasure, context: RenderContext, options?: RenderParagraphOptions): HTMLElement;
 //#endregion
-export { PARAGRAPH_CLASS_NAMES, RenderParagraphOptions, UNICODE_BIDI_BY_WRAPPER_CONTROL, getLeaderChar, getRenderableTextColor, paragraphHasTrackedChanges, renderLine, renderParagraphFragment, sliceRunsForLine, splitCollapsibleLineEdgeSpaces, splitTextRunsByEastAsia, startsAfterSoftWrap };
+export { PARAGRAPH_CLASS_NAMES, RenderParagraphOptions, UNICODE_BIDI_BY_WRAPPER_CONTROL, getLeaderChar, getRenderableListMarkerColor, getRenderableTextColor, paragraphHasTrackedChanges, renderLine, renderParagraphFragment, sliceRunsForLine, splitCollapsibleLineEdgeSpaces, splitTextRunsByEastAsia, startsAfterSoftWrap };