reamkit 1.30.0 → 1.31.0

package/dist/esm/core/font/ttf-subset.d.ts

@@ -22,3 +22,22 @@ export declare function subsetTtf(parsed: ParsedTtf, usedGids: Iterable<number>)
  * @returns The closed set of glyph ids.
  */
 export declare function glyphClosure(parsed: ParsedTtf, usedGids: Iterable<number>): Set<number>;
+/**
+ * The sfnt table directory's binary-search fields for `numTables` tables.
+ *
+ * @param numTables How many tables the font holds.
+ * @returns `searchRange`, `entrySelector` and `rangeShift`, as the header states them.
+ */
+export declare function directoryGeometry(numTables: number): {
+    searchRange: number;
+    entrySelector: number;
+    rangeShift: number;
+};
+/**
+ * An sfnt table checksum: the sum of its big-endian 32-bit words, the last one
+ * padded with zeros.
+ *
+ * @param data The table's bytes (or the whole font's).
+ * @returns The checksum, as an unsigned 32-bit value.
+ */
+export declare function paddedChecksum(data: Uint8Array): number;

package/dist/esm/core/font/ttf-subset.js

@@ -193,6 +193,12 @@ function assembleSubsetTtf(parsed, newGlyf, newLoca) {
 	outView.setUint32(head.offset + HEAD_CHECKSUM_ADJUSTMENT_OFFSET, adjustment, false);
 	return out;
 }
+/**
+* The sfnt table directory's binary-search fields for `numTables` tables.
+*
+* @param numTables How many tables the font holds.
+* @returns `searchRange`, `entrySelector` and `rangeShift`, as the header states them.
+*/
 function directoryGeometry(numTables) {
 	let entrySelector = 0;
 	let pow2 = 1;
@@ -208,6 +214,13 @@ function directoryGeometry(numTables) {
 		rangeShift
 	};
 }
+/**
+* An sfnt table checksum: the sum of its big-endian 32-bit words, the last one
+* padded with zeros.
+*
+* @param data The table's bytes (or the whole font's).
+* @returns The checksum, as an unsigned 32-bit value.
+*/
 function paddedChecksum(data) {
 	let sum = 0;
 	const len = data.length;
@@ -244,4 +257,4 @@ function concatBytes(parts) {
 	return out;
 }
 //#endregion
-export { glyphClosure, subsetTtf };
+export { directoryGeometry, glyphClosure, paddedChecksum, subsetTtf };

package/dist/esm/core/fonts/provider.d.ts

@@ -45,6 +45,23 @@ export declare function embeddedDocFontProvider(embedded: ReadonlyMap<string, Fo
  * Open CDN substitutes (Arimo / Tinos / Cousine / Carlito / Caladea — the
  * LibreOffice metric-compatible mapping).
  * Always answers; the chain reports it as a substitution.
+ *
+ * A family's set is shared by every request for it, those made while the
+ * download is in flight included, and a whole set is downloaded once per
+ * provider. A set whose regular face cannot be downloaded rejects `resolve`
+ * with {@link fetchFontSet}'s error rather than answering {@link NO_FONT}: this
+ * is the chain's last resort, and a chain that answers none sends the
+ * conversion to the auto-download path, which records no substitution. The
+ * failed set is not kept, so the next request asks the network again.
+ *
+ * Nor is a set kept that came without a bold or italic face. The requests that
+ * waited on it fall back to the faces it has, and the next request assembles
+ * the set anew: a face the network lost is asked for again, and one the CDN
+ * answered with an HTTP error is not, since the download cache beneath
+ * {@link fetchFontSet} remembers it as missing.
+ *
+ * @param options An injectable `fetch` (defaults to the global one).
+ * @returns The `'remote'` provider.
  */
 export declare function remoteFontProvider(options?: {
     readonly fetch?: FetchLike;

package/dist/esm/core/fonts/provider.js

@@ -66,6 +66,23 @@ function embeddedDocFontProvider(embedded) {
 * Open CDN substitutes (Arimo / Tinos / Cousine / Carlito / Caladea — the
 * LibreOffice metric-compatible mapping).
 * Always answers; the chain reports it as a substitution.
+*
+* A family's set is shared by every request for it, those made while the
+* download is in flight included, and a whole set is downloaded once per
+* provider. A set whose regular face cannot be downloaded rejects `resolve`
+* with {@link fetchFontSet}'s error rather than answering {@link NO_FONT}: this
+* is the chain's last resort, and a chain that answers none sends the
+* conversion to the auto-download path, which records no substitution. The
+* failed set is not kept, so the next request asks the network again.
+*
+* Nor is a set kept that came without a bold or italic face. The requests that
+* waited on it fall back to the faces it has, and the next request assembles
+* the set anew: a face the network lost is asked for again, and one the CDN
+* answered with an HTTP error is not, since the download cache beneath
+* {@link fetchFontSet} remembers it as missing.
+*
+* @param options An injectable `fetch` (defaults to the global one).
+* @returns The `'remote'` provider.
 */
 function remoteFontProvider(options = {}) {
 	const cache = /* @__PURE__ */ new Map();
@@ -81,10 +98,18 @@ function remoteFontProvider(options = {}) {
 				});
 				cache.set(family, set);
 			}
-			const fonts = await set;
+			let fonts;
+			try {
+				fonts = await set;
+			} catch (error) {
+				if (cache.get(family) === set) cache.delete(family);
+				throw error;
+			}
+			if ((fonts.bold === void 0 || fonts.italic === void 0 || fonts.boldItalic === void 0) && cache.get(family) === set) cache.delete(family);
+			const picked = pickVariant((x) => fonts[x] !== void 0, req.bold, req.italic) ?? "regular";
 			return {
 				kind: "bytes",
-				bytes: fonts[pickVariant((x) => fonts[x] !== void 0, req.bold, req.italic) ?? "regular"] ?? fonts.regular,
+				bytes: fonts[picked] ?? fonts.regular,
 				faceName: family,
 				providerId: "remote"
 			};

package/dist/esm/core/fonts/remote-fonts.js

@@ -330,7 +330,14 @@ async function fetchTtf(url, fetchImpl, required) {
 		})();
 		cache.set(url, pending);
 	}
-	const result = await pending;
+	let result;
+	try {
+		result = await pending;
+	} catch (cause) {
+		if (cache.get(url) === pending) cache.delete(url);
+		if (!required) return void 0;
+		throw new Error(`Failed to download font from ${url}`, { cause });
+	}
 	if (!result && required) {
 		cache.delete(url);
 		throw new Error(`Failed to download font from ${url}`);

package/dist/esm/core/ir/flow.d.ts

@@ -1,5 +1,5 @@
 import { BodyElement, Chart, Comment, DocumentInfo, Numbering, Section, SectionProperties, ShapeFill, StyleSheet } from '../document-model/index.js';
-import { FontRegistry } from '../font/index.js';
+import { FontRegistry, GlyphSeg } from '../font/index.js';
 import { ResourceStore } from './resources.js';
 /**
  * A face's family as a word processor names it (ECMA-376 §17.8.3.9 `w:font`).
@@ -10,6 +10,55 @@ export interface FaceFamily {
     /** §17.8.3.10 `w:family` — the kind of face, for a reader that has to substitute. */
     readonly generic: 'roman' | 'swiss' | 'modern';
 }
+/**
+ * The outlines a face drew a document's characters with — what a writer needs
+ * to EMBED the face, so a reader that lacks it sets the text in the face the
+ * source was set in instead of a substitute (ECMA-376 §17.8.1).
+ */
+export interface FaceOutlines {
+    /** Each character (one code point) the document shows in the face → its glyph. */
+    readonly glyphs: ReadonlyMap<string, FaceGlyph>;
+    /**
+     * The pairs the source KERNED the face by: two characters → the adjustment
+     * to the first one's advance, in thousandths of an em (negative tightens).
+     */
+    readonly kerning?: ReadonlyMap<string, number>;
+    /**
+     * The ligatures the source drew in the face: the letters one glyph stands
+     * for ("fi", "ffl") → that glyph.
+     */
+    readonly ligatures?: ReadonlyMap<string, FaceGlyph>;
+    /**
+     * OS/2 `fsType` — the embedding the face's licence allows, as its program
+     * states it; absent where the program states nothing.
+     */
+    readonly fsType?: number;
+    /** The style the face IS, which is the slot a family embeds it in. */
+    readonly bold: boolean;
+    readonly italic: boolean;
+    /** The program's own name for the face, without a subset tag. */
+    readonly postScriptName: string;
+    /**
+     * The line to set the face in, above and below the baseline, in thousandths
+     * of an em — `descent` negative. A reader that reconstructs a page gives the
+     * line it measured the page against, so a paragraph set in the face's single
+     * spacing lands where the page put it.
+     */
+    readonly ascent: number;
+    readonly descent: number;
+    readonly capHeight?: number;
+    readonly xHeight?: number;
+    /** Degrees counterclockwise from the vertical; a face slanted right is negative. */
+    readonly italicAngle: number;
+    readonly fixedPitch: boolean;
+}
+/** One glyph of a {@link FaceOutlines}: what it draws and how far it advances. */
+export interface FaceGlyph {
+    /** Its contours in a one-unit em, y up, filled by the nonzero rule; empty when blank. */
+    readonly outline: ReadonlyArray<GlyphSeg>;
+    /** How far the pen moves after it, in thousandths of an em. */
+    readonly advance: number;
+}
 /**
  * The semantic IR tree (ir-design §5): everything a reader extracts from the
  * document bytes, format-neutrally — the flow `body` plus its document-scoped
@@ -59,6 +108,11 @@ export interface FlowDoc {
      * to another program names the family, which is the name that program knows.
      */
     readonly faceFamilies?: ReadonlyMap<string, FaceFamily>;
+    /**
+     * The outlines of the faces a run names, keyed as {@link faceFamilies} is —
+     * for a writer that embeds them (see {@link FaceOutlines}).
+     */
+    readonly faceOutlines?: ReadonlyMap<string, FaceOutlines>;
     /** Document metadata from docProps/core.xml. */
     readonly info?: DocumentInfo;
     /** Document natural language hint (BCP-47), e.g. for tagged-PDF /Lang. */
@@ -85,4 +139,20 @@ export interface FlowDoc {
      * @w:gutter` reserves belongs to the TOP margin rather than the left.
      */
     readonly gutterAtTop?: boolean;
+    /**
+     * [MS-DOCX] `w:compatSetting` `compatibilityMode` — the version of Word
+     * whose layout the document asks for: 15 is Word 2013's, which every Word
+     * since sets a new document by. Word opens a document that states none in
+     * Compatibility Mode, and forms there none of the OpenType ligatures its
+     * faces carry.
+     */
+    readonly compatibilityMode?: number;
+    /**
+     * The application whose rules the document is set by: `'word'` for one Word
+     * sets — lines as tall as the faces on them make them (§17.3.1.33), table
+     * rows as tall as their borders make them (§17.4.38); see the layout's
+     * `TypesetBy`. Absent, the layout's flat 1.2× lines and borders that take no
+     * room.
+     */
+    readonly typesetBy?: 'word';
 }

package/dist/esm/core/numbering/index.d.ts

@@ -1,2 +1,2 @@
-export { NumberingState, formatLevelMarker } from './state.js';
+export { NumberingState, formatCounter, formatLevelMarker } from './state.js';
 export { applyNumbering, applyNumberingToHeadersFooters } from './apply.js';

package/dist/esm/core/numbering/state.d.ts

@@ -1,4 +1,4 @@
-import { AbstractNumbering, Numbering, NumberingInstance, NumberingLevel, NumberingReference } from '../document-model/index.js';
+import { AbstractNumbering, Numbering, NumberingFormat, NumberingInstance, NumberingLevel, NumberingReference } from '../document-model/index.js';
 /**
  * §17.9.27 — the levels an INSTANCE actually numbers by: its abstract
  * definition's, with any `w:lvlOverride/w:lvl` shadowing them. Cached per
@@ -31,3 +31,13 @@ export declare class NumberingState {
     resolveMarker(numbering: Numbering, ref: NumberingReference): string | null;
 }
 export declare function formatLevelMarker(abstractNum: AbstractNumbering, currentLevel: NumberingLevel, counters: ReadonlyArray<number>): string;
+/**
+ * A counter in the numerals a §17.18.59 format names: `lowerRoman` 4 is "iv".
+ * A format with no numeral for the number — a letter or a roman zero — gives
+ * the empty string.
+ *
+ * @param format The number format.
+ * @param n      The counter's value.
+ * @returns The counter as that format writes it.
+ */
+export declare function formatCounter(format: NumberingFormat, n: number): string;

package/dist/esm/core/numbering/state.js

@@ -77,6 +77,15 @@ function formatLevelMarker(abstractNum, currentLevel, counters) {
 		return formatCounter(currentLevel.isLegal === true && lvlIdx !== currentLevel.ilvl ? "decimal" : level?.format ?? "decimal", counter);
 	});
 }
+/**
+* A counter in the numerals a §17.18.59 format names: `lowerRoman` 4 is "iv".
+* A format with no numeral for the number — a letter or a roman zero — gives
+* the empty string.
+*
+* @param format The number format.
+* @param n      The counter's value.
+* @returns The counter as that format writes it.
+*/
 function formatCounter(format, n) {
 	if (n < 0) return "";
 	switch (format) {
@@ -336,4 +345,4 @@ function normalizeBullet(lvlText) {
 	return lvlText;
 }
 //#endregion
-export { NumberingState, effectiveAbstract, formatLevelMarker };
+export { NumberingState, effectiveAbstract, formatCounter, formatLevelMarker };

package/dist/esm/core/style-cascade/resolver.js

@@ -137,7 +137,10 @@ function mergeRun(base, override) {
 		...lang !== void 0 ? { lang } : {},
 		...(override.shadingColorHex ?? base.shadingColorHex) !== void 0 ? { shadingColorHex: override.shadingColorHex ?? base.shadingColorHex } : {},
 		...(override.textOutline ?? base.textOutline) !== void 0 ? { textOutline: override.textOutline ?? base.textOutline } : {},
-		...(override.letterSpacingPt ?? base.letterSpacingPt) !== void 0 ? { letterSpacingPt: override.letterSpacingPt ?? base.letterSpacingPt } : {}
+		...(override.letterSpacingPt ?? base.letterSpacingPt) !== void 0 ? { letterSpacingPt: override.letterSpacingPt ?? base.letterSpacingPt } : {},
+		...(override.widthScale ?? base.widthScale) !== void 0 ? { widthScale: override.widthScale ?? base.widthScale } : {},
+		...(override.kerningMinPt ?? base.kerningMinPt) !== void 0 ? { kerningMinPt: override.kerningMinPt ?? base.kerningMinPt } : {},
+		...(override.ligatures ?? base.ligatures) !== void 0 ? { ligatures: override.ligatures ?? base.ligatures } : {}
 	};
 }
 function mergePar(base, override) {
@@ -152,6 +155,7 @@ function mergePar(base, override) {
 	const sectionBreak = override.sectionBreak ?? base.sectionBreak;
 	const textDirection = override.textDirection ?? base.textDirection;
 	const snapToGrid = override.snapToGrid ?? base.snapToGrid;
+	const beforeAuto = override.spacingBeforeAuto ?? (override.spacingBefore === void 0 ? base.spacingBeforeAuto : void 0);
 	return {
 		alignment: override.alignment ?? base.alignment,
 		spacingBefore: override.spacingBeforeAuto ?? override.spacingBefore ?? base.spacingBefore,
@@ -162,6 +166,9 @@ function mergePar(base, override) {
 		indentRight: override.indentRight ?? base.indentRight,
 		indentFirstLine: override.indentFirstLine ?? base.indentFirstLine,
 		pageBreakBefore: override.pageBreakBefore ?? base.pageBreakBefore,
+		keepNext: override.keepNext ?? base.keepNext,
+		keepLines: override.keepLines ?? base.keepLines,
+		widowControl: override.widowControl ?? base.widowControl,
 		contextualSpacing: override.contextualSpacing ?? base.contextualSpacing,
 		tabs: override.tabs ?? base.tabs,
 		bidi: override.bidi ?? base.bidi,
@@ -174,7 +181,8 @@ function mergePar(base, override) {
 		...frame !== void 0 ? { frame } : {},
 		...sectionBreak !== void 0 ? { sectionBreak } : {},
 		...textDirection !== void 0 ? { textDirection } : {},
-		...snapToGrid !== void 0 ? { snapToGrid } : {}
+		...snapToGrid !== void 0 ? { snapToGrid } : {},
+		...beforeAuto !== void 0 ? { spacingBeforeAuto: beforeAuto } : {}
 	};
 }
 function mergeRunPartial(base, override) {
@@ -222,6 +230,7 @@ function primeParagraphFixpoint(para) {
 	}
 	if (!bySheet.has(para)) bySheet.set(para, para);
 }
+var markCascadeCache = /* @__PURE__ */ new WeakMap();
 /**
 * Resolve the style cascade across an entire body so the tree carries final
 * effective run/paragraph properties (FlowDoc transform, ir-design stage 6).
@@ -229,9 +238,25 @@ function primeParagraphFixpoint(para) {
 * resolving again over {@link EMPTY_STYLE_SHEET} is the identity.
 */
 function resolveBodyStyles(body, sheet) {
+	let bySheet = markCascadeCache.get(sheet);
+	if (!bySheet) {
+		bySheet = /* @__PURE__ */ new WeakMap();
+		markCascadeCache.set(sheet, bySheet);
+	}
+	const marks = bySheet;
+	const withResolvedMark = (pp) => {
+		const hit = marks.get(pp);
+		if (hit) return hit;
+		const resolved = {
+			...resolveParagraphProperties(pp, sheet),
+			runProperties: resolveRunProperties(pp.runProperties ?? {}, pp, sheet)
+		};
+		marks.set(pp, resolved);
+		return resolved;
+	};
 	const visitParagraph = (p) => {
 		for (const r of p.runs) r.properties = resolveRunProperties(r.properties, p.properties, sheet);
-		p.properties = resolveParagraphProperties(p.properties, sheet);
+		p.properties = withResolvedMark(p.properties);
 		primeParagraphFixpoint(p.properties);
 		for (const r of p.runs) primeResolvedFixpoint(r.properties, p.properties);
 	};
@@ -244,7 +269,13 @@ function resolveBodyStyles(body, sheet) {
 				for (const member of sh.children ?? []) shapeText(member.shape);
 			};
 			shapeText(el.shape);
-		}
+			standsOn(el.shape);
+		} else if (el.kind === "image") standsOn(el.image);
+		else standsOn(el.chart);
+	};
+	const standsOn = (block) => {
+		if (block.float !== void 0) return;
+		block.paragraphProperties = withResolvedMark(block.paragraphProperties);
 	};
 	for (const el of body) visit(el);
 	return body;

package/dist/esm/core/style-cascade/types.d.ts

@@ -1,4 +1,4 @@
-import { Alignment, CellBorders, CellShading, FontFamilyMap, FrameProperties, NumberingReference, RunProperties, TabStop, TextOutline, UnderlineStyle, VerticalAlign } from '../document-model/index.js';
+import { Alignment, CellBorders, CellShading, FontFamilyMap, FrameProperties, Ligatures, NumberingReference, RunProperties, TabStop, TextOutline, UnderlineStyle, VerticalAlign } from '../document-model/index.js';
 import { Pt } from '../ir/index.js';
 /**
  * A run's fully-resolved properties: every field required because the cascade
@@ -30,6 +30,12 @@ export interface ResolvedRunProperties {
     readonly shadingColorHex?: string;
     /** §17.3.2.35 — extra space between the run's characters, in points. */
     readonly letterSpacingPt?: Pt;
+    /** §17.3.2.43 — the share of its own width each character is set at. */
+    readonly widthScale?: number;
+    /** §17.3.2.19 — the run is kerned at this size and above (0: not at all). */
+    readonly kerningMinPt?: Pt;
+    /** [MS-DOCX] `w14:ligatures` — the face's ligatures the run is set with. */
+    readonly ligatures?: Ligatures;
     /** §21.1.2.3.9 — a line drawn round the glyphs themselves. */
     readonly textOutline?: TextOutline;
 }
@@ -40,6 +46,12 @@ export interface ResolvedRunProperties {
 export interface ResolvedParagraphProperties {
     readonly alignment: Alignment;
     readonly spacingBefore: Pt;
+    /**
+     * §17.3.1.3 `w:beforeAutospacing` — present, and equal to
+     * {@link spacingBefore}, where the space before is the automatic (HTML) one:
+     * Word does not give it to the document's first paragraph.
+     */
+    readonly spacingBeforeAuto?: Pt;
     readonly spacingAfter: Pt;
     readonly spacingLine: Pt;
     readonly spacingLineRule: 'auto' | 'exact' | 'atLeast';
@@ -47,6 +59,12 @@ export interface ResolvedParagraphProperties {
     readonly indentRight: Pt;
     readonly indentFirstLine: Pt;
     readonly pageBreakBefore: boolean;
+    /** §17.3.1.14 — on the same page as the start of the next paragraph. */
+    readonly keepNext: boolean;
+    /** §17.3.1.15 — every line on one page. */
+    readonly keepLines: boolean;
+    /** §17.3.1.44 — no first or last line left alone on a page. */
+    readonly widowControl: boolean;
     /** §17.3.1.9 — drop the space between this paragraph and a same-styled neighbour. */
     readonly contextualSpacing: boolean;
     /** §17.3.1.37 — the paragraph's tab stops, in ascending position order. */

package/dist/esm/core/style-cascade/types.js

@@ -25,6 +25,9 @@ var DEFAULT_RESOLVED_PARAGRAPH = {
 	indentRight: twipsToPt(0),
 	indentFirstLine: twipsToPt(0),
 	pageBreakBefore: false,
+	keepNext: false,
+	keepLines: false,
+	widowControl: true,
 	contextualSpacing: false,
 	tabs: [],
 	bidi: false

package/dist/esm/index.d.ts

@@ -29,12 +29,12 @@ export { signPdf } from './pdf/index.js';
 export type { SignaturePlaceholder, SignerCredentials, SignatureOptions } from './pdf/index.js';
 export type { PdfEncryptOptions, PdfPermissions } from './pdf/index.js';
 export { FontRegistry, parseTtf, subsetTtf } from './core/font/index.js';
-export type { FontBytesByVariant, FontVariant, ParsedTtf } from './core/font/index.js';
+export type { FontBytesByVariant, FontVariant, GlyphSeg, ParsedTtf } from './core/font/index.js';
 export { getHyphenator, createLanguageHyphenator, createHyphenator, splitPatternBundle, } from './core/hyphenation/index.js';
 export type { Hyphenator, HyphenatorOptions, SupportedLanguage } from './core/hyphenation/index.js';
 export type { Pt, ResourceId, Feature, KnownFeature, Loss, LossReport, LossSeverity, NativeBag, } from './core/ir/index.js';
 export { FEATURES, ResourceStore, ConversionLossError, formatLoss, pt, twipsToPt, halfPtToPt, eighthPtToPt, emuToPt, pxToPt, inchToPt, mmToPt, } from './core/ir/index.js';
-export type { FaceFamily, FlowDoc } from './core/ir/flow.js';
+export type { FaceFamily, FaceGlyph, FaceOutlines, FlowDoc } from './core/ir/flow.js';
 export type { DocumentReader, DocumentWriter, ReadOptions, ReadResult, WriteOptions, WriteResult, } from './core/ir/adapters.js';
 export { docxReader, readDocx } from './word/docx-reader.js';
 export { xlsxReader, readXlsx } from './excel/xlsx-reader.js';

package/dist/esm/layout/page-doc.d.ts

@@ -198,12 +198,19 @@ export interface Line {
     readonly mathAscentPt?: number;
     readonly mathDescentPt?: number;
     /**
-     * E-PARITY: metric-derived single-line height and descent (Pt), the max over
-     * the line's text-token fonts under a non-default `layoutProfile`. Absent under
-     * `'ream'`, where leading stays the flat 1.2×/0.2 model (byte-identical).
+     * §17.3.1.33 — the line's single height and descent (Pt) from the faces on
+     * it, pictures included, where the line model reads faces (a Word document,
+     * or a renderer-compat `layoutProfile`). Absent under the flat 1.2×/0.2
+     * model.
      */
     readonly metricHeightPt?: number;
     readonly metricDescentPt?: number;
+    /**
+     * The line of its TEXT alone (the paragraph mark's, on a line with none):
+     * what a spacing of more lines adds per line, where a picture on the line
+     * adds nothing.
+     */
+    readonly metricTextHeightPt?: number;
 }
 /** An image bound into a {@link LaidOutDocument}: its resource name plus the decoded/validated bytes. */
 /**

package/dist/esm/layout/styled-layout.d.ts

@@ -7,6 +7,7 @@ import { LaidOutDocument, PageItem } from './page-doc.js';
 import { AttachedFile } from '../pdf/embedded-file.js';
 import { SignaturePlaceholder } from '../pdf/signature.js';
 import { PdfEncryptOptions } from '../pdf/encryption.js';
+import { Sheet } from './turned-section.js';
 import { StructTreeBuilder } from '../pdf/struct-tree.js';
 /**
  * PDF/A conformance string: part 1 (ISO 19005-1, PDF 1.4) / 2 (ISO 19005-2) / 3
@@ -24,15 +25,27 @@ export interface PdfAProfile {
     readonly version: '1.4' | '1.7';
 }
 /**
- * E-PARITY: renderer-compatibility profile for the line-height model.
- *   `'ream'` (default) — Ream's flat 1.2× leading; byte-identical to before.
- *   `'word'` — leading from the font's OS/2 usWin metrics (the GDI cell box).
- *   `'libreoffice'` — leading from hhea (or OS/2 typo when USE_TYPO_METRICS is set).
+ * E-PARITY: renderer-compatibility profile — how lines are measured, broken
+ * and stacked.
+ *   `'ream'` (default) — kerned measuring, Knuth-Plass breaking, and the line
+ *     height the document asks for (see {@link TypesetBy}).
+ *   `'word'` — kern-free measuring, first-fit breaking, and lines as Word sets
+ *     them whatever the document.
+ *   `'libreoffice'` — first-fit breaking, lines from the face in hand: hhea, or
+ *     the OS/2 typo line when USE_TYPO_METRICS is set.
  *
- * Opt-in: a profile emulates that renderer's vertical rhythm for closer visual
- * parity. It never changes default (`'ream'`) output.
+ * Opt-in: a profile emulates that renderer for closer visual parity.
  */
 export type LayoutProfile = 'ream' | 'word' | 'libreoffice';
+/**
+ * The application whose rules a document is set by: `'word'` stands its
+ * lines as tall as the faces on them make them (§17.3.1.33, see
+ * `fontLeadingPt`) rather than Ream's flat 1.2× of the size, and gives every
+ * horizontal table border the room it is wide (§17.4.38, see
+ * `withBorderBands`) rather than none. A Word document's reader asks for it
+ * (see `FlowDoc.typesetBy`).
+ */
+export type TypesetBy = 'word';
 /**
  * The full option set the layout engine and PDF emitter consume: the resolved
  * font registry, the style/numbering tables, the section model and page
@@ -46,6 +59,8 @@ export interface StyledRenderOptions {
     readonly registry: FontRegistry;
     /** Renderer-compatibility profile for the line-height model (default `'ream'`). */
     readonly layoutProfile?: LayoutProfile;
+    /** The application whose rules the document is set by (see {@link TypesetBy}). */
+    readonly typesetBy?: TypesetBy;
     /**
      * Per-run font resolution: when supplied, each text run picks the registry of
      * its declared family (sans→arimo / serif→tinos / mono→cousine via the run's
@@ -173,6 +188,12 @@ export interface StyledRenderOptions {
      * TOP margin, not the left.
      */
     readonly gutterAtTop?: boolean;
+    /**
+     * [MS-DOCX] `compatibilityMode` — the version of Word whose layout the
+     * document asks for; a Word document that states none is an older Word's
+     * (see {@link legacyTableOutdent}).
+     */
+    readonly compatibilityMode?: number;
     /**
      * §7.6 PDF encryption (AES-256, R6). Only honoured on the ASYNC conversion
      * path (WebCrypto); mutually exclusive with `pdfA` (ISO 19005 forbids
@@ -302,6 +323,12 @@ export interface SectionRenderCtx {
     }>;
     readonly headerSet: HeaderFooterSet;
     readonly footerSet: HeaderFooterSet;
+    /**
+     * §17.10 — where the body starts and ends on a page that shows each band:
+     * below the header band and above the footer band that page carries, each
+     * as tall as it is. Absent ⇒ every page takes `marginTop`/`marginBottom`.
+     */
+    readonly bandMargins?: Readonly<Record<HfBand, BodyMargins>>;
     readonly titlePg: boolean;
     readonly evenAndOddHeaders: boolean;
     /**
@@ -316,10 +343,24 @@ export interface SectionRenderCtx {
      * paragraph in it. Absent on a bare context built outside a layout run.
      */
     readonly options?: StyledRenderOptions;
+    /**
+     * §17.6.20 — the sheet a section whose lines run DOWN it prints on. Such a
+     * section's body is laid out in the frame its text reads in, which the
+     * geometry above describes — the sheet turned back a quarter — and turned
+     * onto this sheet page by page, while its header and footer are laid out
+     * on the sheet itself (see ./turned-section). Absent ⇒ the frame is the sheet.
+     */
+    readonly sheet?: Sheet;
+}
+type HfBand = 'default' | 'first' | 'even';
+/** The distances from the paper's top and bottom edges to the body's. */
+interface BodyMargins {
+    readonly top: number;
+    readonly bottom: number;
 }
 interface HfBandEntry {
     readonly commands: Array<PageItem>;
-    readonly renderDynamic?: (pageNumber: number, totalPages: number) => Array<PageItem>;
+    readonly renderDynamic?: (pageText: string, totalPages: number) => Array<PageItem>;
     /** Laid-out height of the band, so the body can be kept clear of it. */
     readonly heightPt?: number;
 }