rtf-codec 1.0.0 → 1.1.1

package/dist/write.js

@@ -1,6 +1,8 @@
 import { base64ToBytes, bytesToHex } from "./base64.js";
 import { RtfDiagnosticCodes, RtfUnsupportedDocumentKindError } from "./diagnostics.js";
 import { pointsToHalfPoints, pointsToTwips } from "./units.js";
+import { borderControlWords } from "./cell-format.js";
+import { bookmarkResidueControlWords, dttmFromIso, isBookmarkAnchor } from "./constructs.js";
 import { parseRtfListNumId } from "./list-id.js";
 import { clampHeadingLevel, colorToRgbHex, flattenTree } from "document-schema.js";
 //#region src/write.ts
@@ -11,28 +13,47 @@ const LIST_MARKER_HANG_TWIPS = 360;
 const BULLET_LEVEL_TEXT = "\\'01\\u183 ?";
 const ARABIC_LEVEL_TEXT = "\\'02\\'00.";
 const OUTPUT_CODEPAGE = 1252;
+const SECTION_BREAK_CONTROL_WORDS = /* @__PURE__ */ new Map([
+	["continuous", "\\sbknone"],
+	["evenPage", "\\sbkeven"],
+	["oddPage", "\\sbkodd"]
+]);
 const ALIGNMENT_CONTROL_WORDS = /* @__PURE__ */ new Map([
 	["left", "\\ql"],
 	["center", "\\qc"],
 	["right", "\\qr"],
 	["justify", "\\qj"]
 ]);
+const UNKNOWN_REVISION_AUTHOR = "Unknown";
 const DEFAULT_FONT_NAME = "Times New Roman";
 function collectTables(document) {
 	const fonts = /* @__PURE__ */ new Map([[DEFAULT_FONT_NAME, 0]]);
 	const colors = /* @__PURE__ */ new Map();
 	const headingStyles = /* @__PURE__ */ new Map();
 	const lists = /* @__PURE__ */ new Map();
+	const revisionAuthors = /* @__PURE__ */ new Map([[UNKNOWN_REVISION_AUTHOR, 0]]);
+	const noteDescriptor = (descriptor) => {
+		if (descriptor.kind !== "provenance") return;
+		const author = descriptor.author;
+		if (author !== void 0 && !revisionAuthors.has(author)) revisionAuthors.set(author, revisionAuthors.size);
+	};
+	const noteColor = (color) => {
+		if (color === void 0) return;
+		const hex = colorToRgbHex(color);
+		if (!colors.has(hex)) colors.set(hex, colors.size + 1);
+	};
 	const noteRun = (run) => {
 		if (run.fontFamily !== void 0 && !fonts.has(run.fontFamily)) fonts.set(run.fontFamily, fonts.size);
-		if (run.color !== void 0) {
-			const hex = colorToRgbHex(run.color);
-			if (!colors.has(hex)) colors.set(hex, colors.size + 1);
-		}
+		noteColor(run.color);
 	};
 	const noteBlock = (block) => {
+		if (block.kind === "constructStart") {
+			noteDescriptor(block.descriptor);
+			return;
+		}
 		if (block.kind === "paragraph") {
 			for (const run of block.runs) noteRun(run);
+			for (const extent of block.constructs ?? []) noteDescriptor(extent.descriptor);
 			if (block.headingLevel !== void 0) {
 				const level = clampHeadingLevel(block.headingLevel);
 				if (!headingStyles.has(level)) headingStyles.set(level, level);
@@ -50,14 +71,19 @@ function collectTables(document) {
 			}
 			return;
 		}
-		if (block.kind === "table") for (const row of block.rows) for (const cell of row.cells) for (const inner of cell.blocks) noteBlock(inner);
+		if (block.kind === "table") for (const row of block.rows) for (const cell of row.cells) {
+			noteColor(cell.background);
+			for (const side of CELL_BORDER_ORDER) noteColor(cell.borders?.[side]?.color);
+			for (const inner of cell.blocks) noteBlock(inner);
+		}
 	};
 	if (document.kind === "wordprocessing") for (const section of document.sections) for (const block of section.blocks) noteBlock(block);
 	return {
 		fonts,
 		colors,
 		headingStyles,
-		lists
+		lists,
+		revisionAuthors
 	};
 }
 function escapeText(text) {
@@ -94,11 +120,76 @@ function escapeText(text) {
 	}
 	return out;
 }
+function bookmarkStartGroup(descriptor) {
+	if (!isBookmarkAnchor(descriptor)) return "";
+	return `{\\*\\bkmkstart${bookmarkResidueControlWords(descriptor)} ${escapeText(descriptor.name)}}`;
+}
+const CHREV_CONTROL_WORDS = {
+	insertion: {
+		flag: "\\revised",
+		author: "revauth",
+		date: "revdttm"
+	},
+	deletion: {
+		flag: "\\deleted",
+		author: "revauthdel",
+		date: "revdttmdel"
+	},
+	moveFrom: {
+		flag: "\\mvf",
+		author: "mvauth",
+		date: "mvdate"
+	},
+	moveTo: {
+		flag: "\\mvt",
+		author: "mvauth",
+		date: "mvdate"
+	},
+	formatChange: {
+		flag: "",
+		author: "crauth",
+		date: "crdate"
+	}
+};
+function revisionsCovering(extents, index) {
+	return extents.filter((extent) => extent.descriptor.kind === "provenance" && extent.startRun <= index && index < extent.endRun).map((extent) => extent.descriptor).filter((descriptor) => descriptor.kind === "provenance");
+}
+const CELL_BORDER_ORDER = [
+	"top",
+	"left",
+	"bottom",
+	"right"
+];
+function verticalMergeCoverage(table) {
+	const covered = table.rows.map((row) => row.cells.map(() => false));
+	for (const [rowIndex, row] of table.rows.entries()) for (const [cellIndex, cell] of row.cells.entries()) {
+		const rowSpan = cell.rowSpan ?? 1;
+		for (let next = 1; next < rowSpan; next += 1) {
+			const target = covered[rowIndex + next];
+			if (target !== void 0 && cellIndex < target.length) target[cellIndex] = true;
+		}
+	}
+	return covered;
+}
+function nameOf(descriptor) {
+	return isBookmarkAnchor(descriptor) ? descriptor.name : "";
+}
+function describeConstructGap(descriptor) {
+	switch (descriptor.kind) {
+		case "contentControl": return "structured-document-tag equivalent; its own \\*\\formfield production is a narrower construct this writer does not yet mint";
+		case "provenance": return "block-scoped revision mark: its <chrev> production is a character property, so a tracked change reaches RTF only as a run-level extent";
+		case "anchor": return `spelling for a '${descriptor.anchorType}' anchor, whose body would need the note or annotation destination this reader does not place`;
+		case "field": return "block-scoped field: a field is a character-stream construct, written from a run's own hyperlink rather than from a block marker";
+		case "link": return "block-scoped link; an external target rides ContentRun.hyperlink instead";
+		default: return "equivalent construct";
+	}
+}
 var RtfWriter = class {
 	tables;
 	sink;
 	lineEnding;
 	out = "";
+	openConstructs = [];
 	constructor(tables, sink, lineEnding) {
 		this.tables = tables;
 		this.sink = sink;
@@ -115,10 +206,12 @@ var RtfWriter = class {
 	}
 	writeHeader(document) {
 		this.raw(`{\\rtf1\\ansi\\ansicpg${String(OUTPUT_CODEPAGE)}\\deff0\\uc1`);
+		this.writeDocumentGeometry(document);
 		this.writeFontTable();
 		this.writeColorTable();
 		this.writeStyleSheet();
 		this.writeListTables();
+		this.writeRevisionTable();
 		this.writeInfoGroup(document);
 		this.line("");
 	}
@@ -164,6 +257,12 @@ var RtfWriter = class {
 		for (const entry of entries) this.raw(`{\\listoverride\\listid${String(1e3 + entry.index)}\\listoverridecount0\\ls${String(entry.index)}}`);
 		this.raw("}");
 	}
+	writeRevisionTable() {
+		if (this.tables.revisionAuthors.size <= 1) return;
+		this.raw("{\\*\\revtbl");
+		for (const [author] of [...this.tables.revisionAuthors].sort((left, right) => left[1] - right[1])) this.raw(`{${escapeText(author)};}`);
+		this.raw("}");
+	}
 	writeInfoGroup(document) {
 		const { title, author, subject, keywords } = document.metadata;
 		const fields = [];
@@ -173,9 +272,14 @@ var RtfWriter = class {
 		if (keywords !== void 0 && keywords.length > 0) fields.push(`{\\keywords ${escapeText(keywords.join("; "))}}`);
 		if (fields.length > 0) this.raw(`{\\info${fields.join("")}}`);
 	}
+	writeDocumentGeometry(document) {
+		const first = document.sections[0];
+		if (first === void 0) return;
+		this.raw(`\\paperw${String(pointsToTwips(first.pageSize.widthPt))}\\paperh${String(pointsToTwips(first.pageSize.heightPt))}\\margl${String(pointsToTwips(first.margins.leftPt))}\\margr${String(pointsToTwips(first.margins.rightPt))}\\margt${String(pointsToTwips(first.margins.topPt))}\\margb${String(pointsToTwips(first.margins.bottomPt))}`);
+	}
 	writeSection(section, isFirst) {
 		if (!isFirst) this.line("\\sect");
-		this.line(`\\sectd\\paperw${String(pointsToTwips(section.pageSize.widthPt))}\\paperh${String(pointsToTwips(section.pageSize.heightPt))}\\margl${String(pointsToTwips(section.margins.leftPt))}\\margr${String(pointsToTwips(section.margins.rightPt))}\\margt${String(pointsToTwips(section.margins.topPt))}\\margb${String(pointsToTwips(section.margins.bottomPt))}`);
+		this.line(`\\sectd${SECTION_BREAK_CONTROL_WORDS.get(section.breakType ?? "") ?? ""}\\pgwsxn${String(pointsToTwips(section.pageSize.widthPt))}\\pghsxn${String(pointsToTwips(section.pageSize.heightPt))}\\marglsxn${String(pointsToTwips(section.margins.leftPt))}\\margrsxn${String(pointsToTwips(section.margins.rightPt))}\\margtsxn${String(pointsToTwips(section.margins.topPt))}\\margbsxn${String(pointsToTwips(section.margins.bottomPt))}`);
 		this.writeBlocks(section.blocks);
 	}
 	writeBlocks(blocks) {
@@ -203,24 +307,52 @@ var RtfWriter = class {
 				});
 				return;
 			case "constructStart":
+				this.openConstruct(block.descriptor);
+				return;
 			case "constructEnd":
-				this.sink({
-					code: RtfDiagnosticCodes.CONSTRUCT_UNREPRESENTED,
-					severity: "warning",
-					message: `a ${block.kind} boundary marker is dropped; this writer emits no RTF construct for the fidelity-construct vocabulary`
-				});
+				this.closeConstruct();
 				return;
 			default: return;
 		}
 	}
+	openConstruct(descriptor) {
+		if (!isBookmarkAnchor(descriptor)) {
+			this.sink({
+				code: RtfDiagnosticCodes.CONSTRUCT_UNREPRESENTED,
+				severity: "warning",
+				message: `a ${descriptor.kind} construct is dropped: RTF has no ${describeConstructGap(descriptor)}`
+			});
+			this.openConstructs.push(void 0);
+			return;
+		}
+		this.openConstructs.push(descriptor.name);
+		this.line(bookmarkStartGroup(descriptor));
+	}
+	closeConstruct() {
+		const name = this.openConstructs.pop();
+		if (name !== void 0) this.line(`{\\*\\bkmkend ${escapeText(name)}}`);
+	}
 	writeParagraph(paragraph, inTable) {
 		this.raw("\\pard\\plain");
 		if (inTable) this.raw("\\intbl");
 		this.raw(this.paragraphProperties(paragraph));
 		this.raw(" ");
-		for (const run of paragraph.runs) this.writeRun(run);
+		const bookmarks = (paragraph.constructs ?? []).filter((extent) => isBookmarkAnchor(extent.descriptor));
+		const revisions = (paragraph.constructs ?? []).filter((extent) => extent.descriptor.kind === "provenance");
+		for (const [index, run] of paragraph.runs.entries()) {
+			this.writeRunBoundaries(bookmarks, index);
+			this.writeRun(run, revisionsCovering(revisions, index));
+		}
+		this.writeRunBoundaries(bookmarks, paragraph.runs.length);
 		if (!inTable) this.line("\\par");
 	}
+	writeRunBoundaries(extents, position) {
+		for (const extent of extents) if (extent.endRun === position && extent.startRun !== position) this.raw(`{\\*\\bkmkend ${escapeText(nameOf(extent.descriptor))}}`);
+		for (const extent of extents) if (extent.startRun === position) {
+			this.raw(bookmarkStartGroup(extent.descriptor));
+			if (extent.endRun === position) this.raw(`{\\*\\bkmkend ${escapeText(nameOf(extent.descriptor))}}`);
+		}
+	}
 	paragraphProperties(paragraph) {
 		let out = "";
 		const level = paragraph.headingLevel === void 0 ? void 0 : clampHeadingLevel(paragraph.headingLevel);
@@ -250,8 +382,8 @@ var RtfWriter = class {
 		if (paragraph.pageBreakBefore === true) out += "\\pagebb";
 		return out;
 	}
-	writeRun(run) {
-		const properties = this.runProperties(run);
+	writeRun(run, revisions = []) {
+		const properties = this.runProperties(run) + this.revisionProperties(revisions);
 		const body = `${properties}${properties.length > 0 ? " " : ""}${escapeText(run.text)}`;
 		if (run.hyperlink === void 0) {
 			this.raw(`{${body}}`);
@@ -259,6 +391,19 @@ var RtfWriter = class {
 		}
 		this.raw(`{\\field{\\*\\fldinst{HYPERLINK "${escapeText(run.hyperlink)}"}}{\\fldrslt{${body}}}}`);
 	}
+	revisionProperties(revisions) {
+		let out = "";
+		for (const descriptor of revisions) {
+			const author = descriptor.author;
+			const authorIndex = author === void 0 ? void 0 : this.tables.revisionAuthors.get(author);
+			const dttm = descriptor.dateIso === void 0 ? void 0 : dttmFromIso(descriptor.dateIso);
+			const words = CHREV_CONTROL_WORDS[descriptor.change];
+			out += words.flag;
+			if (authorIndex !== void 0) out += `\\${words.author}${String(authorIndex)}`;
+			if (dttm !== void 0) out += `\\${words.date}${String(dttm)}`;
+		}
+		return out;
+	}
 	runProperties(run) {
 		let out = "";
 		const fontIndex = run.fontFamily === void 0 ? void 0 : this.tables.fonts.get(run.fontFamily);
@@ -274,28 +419,51 @@ var RtfWriter = class {
 		return out;
 	}
 	writeTable(table) {
-		for (const row of table.rows) {
+		const covered = verticalMergeCoverage(table);
+		for (const [rowIndex, row] of table.rows.entries()) {
 			let right = 0;
-			const boundaries = [];
-			for (let column = 0; column < row.cells.length; column += 1) {
-				right += pointsToTwips(table.columnWidthsPt[column] ?? 0);
-				boundaries.push(right);
+			let column = 0;
+			const definitions = [];
+			const marks = [];
+			for (const [cellIndex, cell] of row.cells.entries()) {
+				const colSpan = cell.colSpan ?? 1;
+				for (let offset = 0; offset < colSpan; offset += 1) {
+					right += pointsToTwips(table.columnWidthsPt[column] ?? 0);
+					column += 1;
+					definitions.push(this.cellDefinition(cell, covered[rowIndex]?.[cellIndex] === true, colSpan > 1 ? offset === 0 ? "mergeFirst" : "mergeContinuation" : "single", right));
+					marks.push({
+						cell,
+						empty: offset > 0
+					});
+				}
 			}
-			const rowDefinition = `\\trowd\\trgaph108\\trleft0${boundaries.map((boundary) => `\\cellx${String(boundary)}`).join("")}`;
+			const rowDefinition = `\\trowd\\trgaph108\\trleft0${definitions.join("")}`;
 			this.line(rowDefinition);
-			for (const cell of row.cells) {
-				if (cell.borders !== void 0 || cell.background !== void 0) this.sink({
-					code: RtfDiagnosticCodes.CELL_BORDER_DROPPED,
-					severity: "info",
-					message: "a table cell's borders or background are dropped; this writer emits cell boundaries only"
-				});
-				this.writeCellBlocks(cell.blocks);
+			for (const mark of marks) {
+				this.writeCellBlocks(mark.empty ? [] : mark.cell.blocks);
 				this.raw("\\cell");
 			}
 			this.line(`${rowDefinition}\\row`);
 		}
 		this.line("\\pard");
 	}
+	cellDefinition(cell, isVerticalContinuation, horizontal, rightTwips) {
+		let out = "";
+		if (isVerticalContinuation) out += "\\clvmrg";
+		else if ((cell.rowSpan ?? 1) > 1) out += "\\clvmgf";
+		if (horizontal === "mergeFirst") out += "\\clmgf";
+		else if (horizontal === "mergeContinuation") return `${out}\\clmrg\\cellx${String(rightTwips)}`;
+		const borders = cell.borders;
+		if (borders !== void 0) for (const side of CELL_BORDER_ORDER) {
+			const border = borders[side];
+			if (border !== void 0) out += borderControlWords(side, border, colorIndexOf(border.color, this.tables.colors));
+		}
+		if (cell.background !== void 0) {
+			const index = colorIndexOf(cell.background, this.tables.colors);
+			if (index !== void 0) out += `\\clcbpat${String(index)}`;
+		}
+		return `${out}\\cellx${String(rightTwips)}`;
+	}
 	writeCellBlocks(blocks) {
 		const paragraphs = blocks.filter((block) => block.kind === "paragraph");
 		if (paragraphs.length === 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rtf-codec",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Hand-written Rich Text Format (RTF 1.9.1) reader and writer against the shared document-schema.js content pivot.",
   "type": "module",
   "repository": {
@@ -78,7 +78,7 @@
   "license": "MIT",
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
-    "document-schema.js": "^5.4.0",
+    "document-schema.js": "^5.5.1",
     "zod": "^4.4.3"
   },
   "devDependencies": {