reamkit 1.30.0 → 1.32.0

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,22 +238,46 @@ 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);
 	};
 	const visit = (el) => {
 		if (el.kind === "paragraph") visitParagraph(el.paragraph);
-		else if (el.kind === "table") for (const row of el.table.rows) for (const cell of row.cells) for (const child of cell.content) visit(child);
-		else if (el.kind === "shape") {
+		else if (el.kind === "table") {
+			for (const row of el.table.rows) for (const cell of row.cells) for (const child of cell.content) visit(child);
+			for (const drawing of el.table.overlay?.drawings ?? []) visit(drawing);
+		} else if (el.kind === "shape") {
 			const shapeText = (sh) => {
 				for (const child of sh.text?.content ?? []) visit(child);
 				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/excel/column-bands.d.ts

@@ -1,4 +1,21 @@
 import { BodyElement, TableProperties, TableRow } from '../core/document-model/index.js';
+/** §18.3.1.70 — the width of the row-number column, in twips. */
+export declare const HEADING_COL_TWIPS = 460;
+/**
+ * §18.3.1.70 — how the printed headings stand: the sheet's print scale shrinks
+ * them with it, as it shrinks everything else on the page.
+ */
+export interface HeadingBand {
+    /** How tall the letters row stands — exactly, so a drawing anchored to the
+     *  grid can be moved down by just as much. */
+    readonly lettersPt?: number;
+    /** The row-number column's width, in twips; {@link HEADING_COL_TWIPS} unscaled. */
+    readonly colTwips?: number;
+    /** The size the letters and numbers are set in; the sheet's default unscaled. */
+    readonly fontPt?: number;
+    /** The width of the boxes' lines; 0.5pt unscaled. */
+    readonly lineWidthPt?: number;
+}
 /**
  * Wrap a grid in its printed row and column headings (§18.3.1.70 `headings`):
  * the column letters across the top, the row numbers down the left, each in a
@@ -7,14 +24,23 @@ import { BodyElement, TableProperties, TableRow } from '../core/document-model/i
  *
  * @param rows       The band's rows.
  * @param widths     The band's column widths in twips.
- * @param colStart   The absolute index of the band's first column.
+ * @param columns    The absolute index of each of those columns — a hidden
+ *   one between them is skipped, and so is its letter.
  * @param rowNumbers The absolute 1-based row number of each row.
+ * @param band       How the headings stand, at the print scale.
  * @returns The rows and widths with the heading band added.
  */
-export declare function withHeadingBand(rows: ReadonlyArray<TableRow>, widths: ReadonlyArray<number>, colStart: number, rowNumbers: ReadonlyArray<number>): {
+export declare function withHeadingBand(rows: ReadonlyArray<TableRow>, widths: ReadonlyArray<number>, columns: ReadonlyArray<number>, rowNumbers: ReadonlyArray<number>, band?: HeadingBand): {
     rows: Array<TableRow>;
     widths: Array<number>;
 };
+/** Where a drawing lies on its sheet, in points from the sheet's top-left corner. */
+export interface DrawingBox {
+    readonly xPt: number;
+    readonly yPt: number;
+    readonly widthPt: number;
+    readonly heightPt: number;
+}
 /** A contiguous run of columns that prints together as one band (E-SHEET SE1). */
 export interface ColumnBand {
     /** First local column index (inclusive). */
@@ -50,12 +76,19 @@ export declare function computeColumnBands(columnWidths: ReadonlyArray<number>,
  * @param titleRowIndex The print-title row, or -1.
  * @param drawingReachTwips How far right the sheet's drawings reach (0 if none).
  * @param headings §18.3.1.70 — the printed row/column headings, when the sheet
- *   asks for them: the absolute index of the grid's first column and the sheet
- *   row number of each emitted row. Each band gets ITS OWN letters, which is
- *   what both references print across the top of a continuation page.
+ *   asks for them: the absolute index of each column and the sheet row number
+ *   of each emitted row. Each band gets ITS OWN letters, which is what both
+ *   references print across the top of a continuation page.
+ * @param sheet    §20.5 — where the grid's first column stands on the sheet and
+ *   where its printed drawings lie, at the print scale: each band is framed
+ *   for the drawings over it (TableOverlay) and keeps the rows they cover.
  * @returns One table body element per band, in band order.
  */
 export declare function bandedTables(rows: ReadonlyArray<TableRow>, columnWidths: ReadonlyArray<number>, bands: ReadonlyArray<ColumnBand>, properties: TableProperties, titleRowIndex?: number, drawingReachTwips?: number, headings?: {
-    readonly colStart: number;
+    readonly columns: ReadonlyArray<number>;
     readonly rowNumbers: ReadonlyArray<number>;
+    readonly band?: HeadingBand;
+}, sheet?: {
+    readonly sheetLeftPt: number;
+    readonly drawings: ReadonlyArray<DrawingBox>;
 }): Array<BodyElement>;

package/dist/esm/excel/column-bands.js

@@ -1,7 +1,4 @@
-import { twipsToPt } from "../core/ir/units.js";
-//#region src/excel/column-bands.ts
-/** §18.3.1.70 — the width of the row-number column, in twips. */
-var HEADING_COL_TWIPS = 460;
+import { pt, twipsToPt } from "../core/ir/units.js";
 /** The A1-style letters of an absolute column index (0 → A, 26 → AA). */
 function columnLetters(index) {
 	let n = index;
@@ -20,14 +17,17 @@ function columnLetters(index) {
 *
 * @param rows       The band's rows.
 * @param widths     The band's column widths in twips.
-* @param colStart   The absolute index of the band's first column.
+* @param columns    The absolute index of each of those columns — a hidden
+*   one between them is skipped, and so is its letter.
 * @param rowNumbers The absolute 1-based row number of each row.
+* @param band       How the headings stand, at the print scale.
 * @returns The rows and widths with the heading band added.
 */
-function withHeadingBand(rows, widths, colStart, rowNumbers) {
+function withHeadingBand(rows, widths, columns, rowNumbers, band = {}) {
+	const { lettersPt, colTwips = 460, fontPt, lineWidthPt = .5 } = band;
 	const border = {
 		style: "single",
-		width: .5,
+		width: lineWidthPt,
 		colorHex: "808080"
 	};
 	const borders = {
@@ -47,15 +47,21 @@ function withHeadingBand(rows, widths, colStart, rowNumbers) {
 				properties: { alignment: "center" },
 				runs: [{
 					text,
-					properties: {}
+					properties: fontPt !== void 0 ? { fontSizePt: pt(fontPt) } : {}
 				}]
 			}
 		}]
 	});
 	const letters = [head("")];
-	for (let i = 0; i < widths.length; i++) letters.push(head(columnLetters(colStart + i)));
+	for (let i = 0; i < widths.length; i++) letters.push(head(columnLetters(columns[i] ?? i)));
 	const out = [{
-		properties: { isHeader: true },
+		properties: {
+			isHeader: true,
+			...lettersPt !== void 0 ? {
+				height: pt(lettersPt),
+				heightRule: "exact"
+			} : {}
+		},
 		cells: letters
 	}];
 	rows.forEach((row, i) => {
@@ -66,7 +72,7 @@ function withHeadingBand(rows, widths, colStart, rowNumbers) {
 	});
 	return {
 		rows: out,
-		widths: [HEADING_COL_TWIPS, ...widths]
+		widths: [colTwips, ...widths]
 	};
 }
 /**
@@ -122,16 +128,33 @@ function computeColumnBands(columnWidths, contentWidthTwips, colBreaks) {
 * @param titleRowIndex The print-title row, or -1.
 * @param drawingReachTwips How far right the sheet's drawings reach (0 if none).
 * @param headings §18.3.1.70 — the printed row/column headings, when the sheet
-*   asks for them: the absolute index of the grid's first column and the sheet
-*   row number of each emitted row. Each band gets ITS OWN letters, which is
-*   what both references print across the top of a continuation page.
+*   asks for them: the absolute index of each column and the sheet row number
+*   of each emitted row. Each band gets ITS OWN letters, which is what both
+*   references print across the top of a continuation page.
+* @param sheet    §20.5 — where the grid's first column stands on the sheet and
+*   where its printed drawings lie, at the print scale: each band is framed
+*   for the drawings over it (TableOverlay) and keeps the rows they cover.
 * @returns One table body element per band, in band order.
 */
-function bandedTables(rows, columnWidths, bands, properties, titleRowIndex = -1, drawingReachTwips = 0, headings) {
+function bandedTables(rows, columnWidths, bands, properties, titleRowIndex = -1, drawingReachTwips = 0, headings, sheet) {
 	return bands.flatMap((band, bandIndex) => {
 		const bandLeft = columnWidths.slice(0, band.start).reduce((sum, w) => sum + w, 0);
 		const bandTwips = columnWidths.slice(band.start, band.end + 1);
 		const grid = bandTwips.map((w) => twipsToPt(w));
+		const sheetLeftPt = sheet ? sheet.sheetLeftPt + twipsToPt(bandLeft) : 0;
+		const sheetRightPt = sheetLeftPt + grid.reduce((sum, w) => sum + w, 0);
+		const overlayAt = (leftPt) => sheet ? { overlay: {
+			sheetLeftPt: pt(sheetLeftPt),
+			widthPt: pt(sheetRightPt - sheetLeftPt),
+			leftPt: pt(leftPt),
+			drawings: []
+		} } : {};
+		const underDrawing = (row) => {
+			const top = row.properties.sheetTopPt;
+			if (top === void 0 || !sheet) return false;
+			const bottom = top + (row.properties.height ?? 0);
+			return sheet.drawings.some((d) => d.xPt < sheetRightPt && d.xPt + d.widthPt > sheetLeftPt && d.yPt < bottom && d.yPt + d.heightPt > top);
+		};
 		const bandRowNumbers = [...headings?.rowNumbers ?? []];
 		const bandRows = rows.map((row, rowIndex) => {
 			const cells = sliceRowCells(row.cells, band);
@@ -144,7 +167,7 @@ function bandedTables(rows, columnWidths, bands, properties, titleRowIndex = -1,
 			};
 		});
 		if (bandIndex > 0 && !(bandLeft < drawingReachTwips) && !bandRows.some(rowDrawsSomething)) return [];
-		while (bandRows.length > 1 && !rowDrawsSomething(bandRows[bandRows.length - 1])) {
+		while (bandRows.length > 1 && !rowDrawsSomething(bandRows[bandRows.length - 1]) && !underDrawing(bandRows[bandRows.length - 1])) {
 			bandRows.pop();
 			bandRowNumbers.pop();
 		}
@@ -158,11 +181,12 @@ function bandedTables(rows, columnWidths, bands, properties, titleRowIndex = -1,
 			rows: bandRows,
 			numbers: bandRowNumbers
 		}]).map((part) => {
-			const headed = headings ? withHeadingBand(part.rows, bandTwips, headings.colStart + band.start, part.numbers) : void 0;
+			const headed = headings ? withHeadingBand(part.rows, bandTwips, headings.columns.slice(band.start, band.end + 1), part.numbers, headings.band) : void 0;
 			return {
 				kind: "table",
 				table: {
 					properties,
+					...overlayAt(headed ? twipsToPt(headings?.band?.colTwips ?? 460) : 0),
 					grid: headed ? headed.widths.map((w) => twipsToPt(w)) : grid,
 					rows: headed ? leadWithBandBreak(headed.rows) : part.rows
 				}

package/dist/esm/excel/comments-parser.js

@@ -1,4 +1,5 @@
 import { resolveInternalEntities } from "../core/opc/xml-entities.js";
+import { richRun } from "./shared-strings-parser.js";
 import { XMLParser } from "fast-xml-parser";
 //#region src/excel/comments-parser.ts
 var decoder = new TextDecoder("utf-8");
@@ -32,10 +33,12 @@ function parseLegacyComments(data) {
 		const author = Number.isInteger(authorIdx) ? authors[authorIdx] : void 0;
 		const text = stripAuthorPrefix(richText(obj["text"]), author);
 		if (text.length === 0 && !author) continue;
+		const runs = richRuns(obj["text"]);
 		out.push({
 			ref,
 			...author ? { author } : {},
 			text,
+			...runs.length > 0 ? { runs } : {},
 			threaded: false
 		});
 	}
@@ -95,6 +98,22 @@ function richText(node) {
 	if (direct) return direct;
 	return toArray(obj["r"]).map((r) => textOf(asObject(r)?.["t"])).join("");
 }
+function richRuns(node) {
+	const obj = asObject(node);
+	if (!obj) {
+		const plain = textOf(node);
+		return plain ? [{ text: plain }] : [];
+	}
+	const direct = textOf(obj["t"]);
+	if (direct) return [{ text: direct }];
+	const out = [];
+	for (const r of toArray(obj["r"])) {
+		const run = asObject(r);
+		const text = textOf(run?.["t"]);
+		if (text.length > 0) out.push(richRun(text, run?.["rPr"]));
+	}
+	return out;
+}
 function stripAuthorPrefix(text, author) {
 	if (!author) return text;
 	const prefix = `${author}:`;

package/dist/esm/excel/conditional-format.d.ts

@@ -1,5 +1,5 @@
 import { CellIcon } from '../core/document-model/index.js';
-import { ConditionalFormat, DefinedName, WorksheetCell, XlsxBorder, XlsxStyles } from '../core/spreadsheet-model/index.js';
+import { ConditionalFormat, DefinedName, ExcelTable, WorksheetCell, XlsxBorder, XlsxStyles } from '../core/spreadsheet-model/index.js';
 /**
  * A resolved per-cell override the print model layers over a cell's base format: a
  * solid highlight fill, font tweaks, an in-cell data bar (fraction of the cell
@@ -25,12 +25,14 @@ export interface CfOverride {
         readonly colorHex: string;
         readonly startFraction?: number;
         readonly negative?: boolean;
+        readonly solid?: boolean;
     };
     readonly icon?: CellIcon;
     /**
      * §18.3.1.28 `<dataBar showValue="0">` — the cell shows its BAR and not its
      * number. Excel's "Show Bar Only": the figure would otherwise sit on top of
-     * its own gauge.
+     * its own gauge. §18.3.1.49 `<iconSet showValue="0">` is the same for an
+     * icon: "Show Icon Only".
      */
     readonly hideValue?: boolean;
 }
@@ -69,11 +71,13 @@ blank?: boolean) => CfOverride | undefined;
  *                           driving `TODAY()`/`NOW()` and the `timePeriod` windows;
  *                           absent ⇒ those constructs no-op (deterministic output).
  * @param sheetGrids         The whole workbook, for an `expression` rule that reaches
- *                           another sheet (`Sheet2!A1`) or a defined name; absent ⇒
+ *                           another sheet (`Sheet2!A1`), a defined name or a table
+ *                           by its columns (`tblIncome[Amount]`); absent ⇒
  *                           same-sheet references only.
  * @param currentSheet       The rule sheet's name, for resolving sheet-local names.
  * @param definedNames       The workbook defined names visible to `expression` rules.
  */
 export declare function buildConditionalFormatter(conditionalFormats: ReadonlyArray<ConditionalFormat> | undefined, styles: XlsxStyles, cells: ReadonlyArray<WorksheetCell>, resolveText?: (cell: WorksheetCell) => string, date1904?: boolean, now?: Date, sheetGrids?: ReadonlyMap<string, {
     readonly cells: ReadonlyArray<WorksheetCell>;
+    readonly tables?: ReadonlyArray<ExcelTable>;
 }>, currentSheet?: string, definedNames?: ReadonlyArray<DefinedName>): CellConditionalFormatter | undefined;