@stll/folio-core 0.51.0 → 0.53.0

package/dist/docx/commentRangeIntegrity.js

@@ -1,6 +1,11 @@
 import { cloneParagraphWithPropertySource } from "./paragraphPropertySource.js";
 //#region src/docx/commentRangeIntegrity.ts
-const COMMENT_RANGE_MARKER_PATTERN = /<w:commentRange(Start|End)\s[^>]*w:id="(\d+)"/gu;
+/**
+* A range marker under any prefix, or none: this is the guard a splice is
+* refused by, and a guard that only knows `w:` passes every patch of a part
+* that spells WordprocessingML another way.
+*/
+const COMMENT_RANGE_MARKER_PATTERN = /<(?:[\w.-]+:)?commentRange(Start|End)(?:\s[^>]*?)?\s(?:[\w.-]+:)?id=["'](\d+)["']/gu;
 /**
 * Comment ids whose range is not a start followed by an end in this story's
 * XML. Either half alone is invalid OOXML and anchors nothing: Word shows no
@@ -147,7 +152,7 @@ const withoutOrphanBlockMarkers = (blocks, validCommentIds) => {
 const withoutOrphanBlockMarker = (block, validCommentIds) => {
 	if (block.type === "paragraph") return withoutOrphanParagraphMarkers(block, validCommentIds);
 	if (block.type === "table") return withoutOrphanTableMarkers(block, validCommentIds);
-	if (block.type !== "blockSdt") return block;
+	if (block.type !== "blockSdt" && block.type !== "blockCustomXml") return block;
 	const content = withoutOrphanBlockMarkers(block.content, validCommentIds);
 	if (!content) return block;
 	return {
@@ -204,7 +209,7 @@ const withoutOrphanTableCellBlockMarkers = (blocks, validCommentIds) => {
 const withoutOrphanTableCellBlockMarker = (block, validCommentIds) => {
 	if (block.type === "paragraph") return withoutOrphanParagraphMarkers(block, validCommentIds);
 	if (block.type === "table") return withoutOrphanTableMarkers(block, validCommentIds);
-	if (block.type === "blockSdt") {
+	if (block.type === "blockSdt" || block.type === "blockCustomXml") {
 		const content = withoutOrphanTableCellBlockMarkers(block.content, validCommentIds);
 		return content ? {
 			...block,

package/dist/docx/commentReferenceNormalization.js

@@ -40,7 +40,7 @@ const normalizeCommentReferences = ({ documentBody, comments, headers, footers,
 			normalizeTable(block);
 			return;
 		}
-		if (block.type !== "blockSdt") return;
+		if (block.type !== "blockSdt" && block.type !== "blockCustomXml") return;
 		normalizeBlocks(block.content);
 	};
 	const normalizeBlocks = (blocks) => {

package/dist/docx/commentReplyMarkers.js

@@ -25,7 +25,7 @@ const eachParagraph = (blocks, visit) => {
 			for (const row of block.rows ?? []) for (const cell of row.cells ?? []) eachParagraph(cell.content ?? [], visit);
 			continue;
 		}
-		if (block.type !== "blockSdt") continue;
+		if (block.type !== "blockSdt" && block.type !== "blockCustomXml") continue;
 		eachParagraph(block.content ?? [], visit);
 	}
 };
@@ -42,6 +42,24 @@ const commentParentedReplies = (comments) => {
 	const commentIds = new Set(comments.map((comment) => comment.id));
 	return comments.filter((comment) => comment.parentId !== void 0 && commentIds.has(comment.parentId));
 };
+/** Match the order fromProseDoc uses when several ranges share a boundary. */
+const orderCoLocatedRanges = (content) => {
+	for (let start = 0; start < content.length;) {
+		const type = content[start]?.type;
+		if (type !== "commentRangeStart" && type !== "commentRangeEnd") {
+			start += 1;
+			continue;
+		}
+		let end = start + 1;
+		while (content[end]?.type === type) end += 1;
+		const ordered = content.slice(start, end).toSorted((left, right) => {
+			if ((left.type === "commentRangeStart" || left.type === "commentRangeEnd") && (right.type === "commentRangeStart" || right.type === "commentRangeEnd")) return left.id - right.id;
+			return 0;
+		});
+		content.splice(start, end - start, ...ordered);
+		start = end;
+	}
+};
 const injectIntoParagraph = (paragraph, replyIdsByParent) => {
 	const content = paragraph.content ?? [];
 	if (!content.some((item) => (item.type === "commentRangeStart" || item.type === "commentRangeEnd" || item.type === "commentReference") && replyIdsByParent.has(item.id))) return 0;
@@ -68,6 +86,7 @@ const injectIntoParagraph = (paragraph, replyIdsByParent) => {
 			injected += 1;
 		}
 	}
+	orderCoLocatedRanges(next);
 	paragraph.content = next;
 	return injected;
 };

package/dist/docx/compatibility.d.ts

@@ -1,7 +1,7 @@
 import { document_d_exports } from "../types/document.js";
 import { DrawingSafetyClass } from "./imageRawXml.js";
 //#region src/docx/compatibility.d.ts
-type DocxCompatibilityReason = "opaqueDrawing";
+type DocxCompatibilityReason = "opaqueDrawing" | "unsupportedAltChunk";
 type FolioDocxCompatibilityHost = "browser" | "server" | "unknown";
 type FolioDocxCompatibilityProfile = document_d_exports.DocxConformanceClass;
 type DocxCompatibilityContext = {

package/dist/docx/compatibility.js

@@ -1,3 +1,4 @@
+import { isAltChunkMarkup } from "./altChunk.js";
 import { DRAWING_SAFETY_CLASSES, classifyDrawingSafety } from "./imageRawXml.js";
 import { panic } from "better-result";
 import { DOCX_CONFORMANCE_CLASSES } from "@stll/docx-core/model";
@@ -24,17 +25,20 @@ const inspectDocxCompatibility = (doc, options = {}) => {
 	const record = (drawing) => {
 		drawings.push(drawing);
 		if (drawing.class !== DRAWING_SAFETY_CLASSES.OPAQUE) return;
-		const code = "opaqueDrawing";
-		reasons.add(code);
-		issues.push({
-			code,
+		recordIssue({
+			code: "opaqueDrawing",
 			location: drawing.location
 		});
 	};
+	const recordIssue = (issue) => {
+		reasons.add(issue.code);
+		issues.push(issue);
+	};
 	inspectBlocks(doc.package.document.content, {
 		part: { type: "document" },
 		path: "package.document.content",
-		record
+		record,
+		recordIssue
 	});
 	for (const [relationshipId, header] of doc.package.headers?.entries() ?? []) inspectHeaderFooter(header, {
 		part: {
@@ -42,7 +46,8 @@ const inspectDocxCompatibility = (doc, options = {}) => {
 			relationshipId
 		},
 		path: `package.headers.get(${JSON.stringify(relationshipId)}).content`,
-		record
+		record,
+		recordIssue
 	});
 	for (const [relationshipId, footer] of doc.package.footers?.entries() ?? []) inspectHeaderFooter(footer, {
 		part: {
@@ -50,7 +55,8 @@ const inspectDocxCompatibility = (doc, options = {}) => {
 			relationshipId
 		},
 		path: `package.footers.get(${JSON.stringify(relationshipId)}).content`,
-		record
+		record,
+		recordIssue
 	});
 	for (const footnote of doc.package.footnotes ?? []) inspectBlocks(footnote.content, {
 		part: {
@@ -58,7 +64,8 @@ const inspectDocxCompatibility = (doc, options = {}) => {
 			id: footnote.id
 		},
 		path: `package.footnotes[id=${footnote.id}].content`,
-		record
+		record,
+		recordIssue
 	});
 	for (const endnote of doc.package.endnotes ?? []) inspectBlocks(endnote.content, {
 		part: {
@@ -66,7 +73,8 @@ const inspectDocxCompatibility = (doc, options = {}) => {
 			id: endnote.id
 		},
 		path: `package.endnotes[id=${endnote.id}].content`,
-		record
+		record,
+		recordIssue
 	});
 	return {
 		schemaVersion: 2,
@@ -86,7 +94,8 @@ function inspectBlocks(blocks, context) {
 				...block.paraId === void 0 ? {} : { blockId: block.paraId },
 				part: context.part,
 				path: `${blockPath}.content`,
-				record: context.record
+				record: context.record,
+				recordIssue: context.recordIssue
 			});
 			continue;
 		}
@@ -94,15 +103,27 @@ function inspectBlocks(blocks, context) {
 			for (const [rowIndex, row] of block.rows.entries()) for (const [cellIndex, cell] of row.cells.entries()) inspectBlocks(cell.content, {
 				part: context.part,
 				path: `${blockPath}.rows[${rowIndex}].cells[${cellIndex}].content`,
-				record: context.record
+				record: context.record,
+				recordIssue: context.recordIssue
+			});
+			continue;
+		}
+		if (block.type === "preservedBlock" && isAltChunkMarkup(block.xml)) {
+			context.recordIssue({
+				code: "unsupportedAltChunk",
+				location: {
+					part: context.part,
+					path: blockPath
+				}
 			});
 			continue;
 		}
-		if (block.type !== "blockSdt") continue;
+		if (block.type !== "blockSdt" && block.type !== "blockCustomXml") continue;
 		inspectBlocks(block.content, {
 			part: context.part,
 			path: `${blockPath}.content`,
-			record: context.record
+			record: context.record,
+			recordIssue: context.recordIssue
 		});
 	}
 }

package/dist/docx/containerChildren.gen.d.ts

@@ -28,7 +28,7 @@ declare const CONTAINER_CHILDREN: {
   readonly "w:comment": readonly ["altChunk", "bookmarkEnd", "bookmarkStart", "commentRangeEnd", "commentRangeStart", "customXml", "customXmlDelRangeEnd", "customXmlDelRangeStart", "customXmlInsRangeEnd", "customXmlInsRangeStart", "customXmlMoveFromRangeEnd", "customXmlMoveFromRangeStart", "customXmlMoveToRangeEnd", "customXmlMoveToRangeStart", "del", "ins", "moveFrom", "moveFromRangeEnd", "moveFromRangeStart", "moveTo", "moveToRangeEnd", "moveToRangeStart", "p", "permEnd", "permStart", "proofErr", "sdt", "tbl"];
   readonly "run-level-content": readonly ["bdo", "bookmarkEnd", "bookmarkStart", "commentRangeEnd", "commentRangeStart", "customXml", "customXmlDelRangeEnd", "customXmlDelRangeStart", "customXmlInsRangeEnd", "customXmlInsRangeStart", "customXmlMoveFromRangeEnd", "customXmlMoveFromRangeStart", "customXmlMoveToRangeEnd", "customXmlMoveToRangeStart", "customXmlPr", "del", "dir", "fldSimple", "hyperlink", "ins", "moveFrom", "moveFromRangeEnd", "moveFromRangeStart", "moveTo", "moveToRangeEnd", "moveToRangeStart", "pPr", "permEnd", "permStart", "proofErr", "r", "sdt", "smartTag", "smartTagPr", "subDoc"];
   readonly "table-content": readonly ["bookmarkEnd", "bookmarkStart", "commentRangeEnd", "commentRangeStart", "customXml", "customXmlDelRangeEnd", "customXmlDelRangeStart", "customXmlInsRangeEnd", "customXmlInsRangeStart", "customXmlMoveFromRangeEnd", "customXmlMoveFromRangeStart", "customXmlMoveToRangeEnd", "customXmlMoveToRangeStart", "customXmlPr", "del", "ins", "moveFrom", "moveFromRangeEnd", "moveFromRangeStart", "moveTo", "moveToRangeEnd", "moveToRangeStart", "permEnd", "permStart", "proofErr", "sdt", "tblGrid", "tblPr", "tr"];
-  readonly "row-content": readonly ["bookmarkEnd", "bookmarkStart", "commentRangeEnd", "commentRangeStart", "customXml", "customXmlDelRangeEnd", "customXmlDelRangeStart", "customXmlInsRangeEnd", "customXmlInsRangeStart", "customXmlMoveFromRangeEnd", "customXmlMoveFromRangeStart", "customXmlMoveToRangeEnd", "customXmlMoveToRangeStart", "del", "ins", "moveFrom", "moveFromRangeEnd", "moveFromRangeStart", "moveTo", "moveToRangeEnd", "moveToRangeStart", "permEnd", "permStart", "proofErr", "sdt", "tblPrEx", "tc", "tr", "trPr"];
+  readonly "row-content": readonly ["bookmarkEnd", "bookmarkStart", "commentRangeEnd", "commentRangeStart", "customXml", "customXmlDelRangeEnd", "customXmlDelRangeStart", "customXmlInsRangeEnd", "customXmlInsRangeStart", "customXmlMoveFromRangeEnd", "customXmlMoveFromRangeStart", "customXmlMoveToRangeEnd", "customXmlMoveToRangeStart", "customXmlPr", "del", "ins", "moveFrom", "moveFromRangeEnd", "moveFromRangeStart", "moveTo", "moveToRangeEnd", "moveToRangeStart", "permEnd", "permStart", "proofErr", "sdt", "tblPrEx", "tc", "tr", "trPr"];
   readonly "w:fonts": readonly ["font"];
   readonly "w:font": readonly ["altName", "charset", "embedBold", "embedBoldItalic", "embedItalic", "embedRegular", "family", "notTrueType", "panose1", "pitch", "sig"];
   readonly "w:hyperlink": readonly ["bdo", "bookmarkEnd", "bookmarkStart", "commentRangeEnd", "commentRangeStart", "customXml", "customXmlDelRangeEnd", "customXmlDelRangeStart", "customXmlInsRangeEnd", "customXmlInsRangeStart", "customXmlMoveFromRangeEnd", "customXmlMoveFromRangeStart", "customXmlMoveToRangeEnd", "customXmlMoveToRangeStart", "del", "dir", "fldSimple", "hyperlink", "ins", "moveFrom", "moveFromRangeEnd", "moveFromRangeStart", "moveTo", "moveToRangeEnd", "moveToRangeStart", "permEnd", "permStart", "proofErr", "r", "sdt", "smartTag", "subDoc"];

package/dist/docx/containerChildren.gen.js

@@ -125,6 +125,7 @@ const CONTAINER_CHILDREN = {
 		"customXmlMoveFromRangeStart",
 		"customXmlMoveToRangeEnd",
 		"customXmlMoveToRangeStart",
+		"customXmlPr",
 		"del",
 		"ins",
 		"moveFrom",

package/dist/docx/documentParser.js

@@ -40,7 +40,7 @@ function extractAllTemplateVariables(content) {
 	} else if (block.type === "table") {
 		const tableVars = extractTableVariables(block);
 		for (const v of tableVars) if (!variables.includes(v)) variables.push(v);
-	} else if (block.type === "blockSdt") {
+	} else if (block.type === "blockSdt" || block.type === "blockCustomXml") {
 		for (const v of extractAllTemplateVariables(block.content)) if (!variables.includes(v)) variables.push(v);
 	}
 	return variables;
@@ -56,7 +56,7 @@ function extractTableVariables(table) {
 	} else if (cellContent.type === "table") {
 		const nestedVars = extractTableVariables(cellContent);
 		for (const v of nestedVars) if (!variables.includes(v)) variables.push(v);
-	} else if (cellContent.type === "blockSdt") {
+	} else if (cellContent.type === "blockSdt" || cellContent.type === "blockCustomXml") {
 		for (const v of extractAllTemplateVariables(cellContent.content)) if (!variables.includes(v)) variables.push(v);
 	}
 	return variables;
@@ -153,7 +153,7 @@ function parseDocumentBackground(documentEl, context) {
 function parseDocumentBody(xml, styles = null, theme = null, numbering = null, rels = null, media = null, context, previews = standalonePreviewLedger()) {
 	const result = { content: [] };
 	if (!xml) return result;
-	const documentEl = (parseXml(xml).elements ?? []).find((el) => el.type === "element" && (el.name === "w:document" || el.name?.endsWith(":document")));
+	const documentEl = (parseXml(xml).elements ?? []).find((el) => el.type === "element" && getLocalName(el.name ?? "") === "document");
 	if (!documentEl) return result;
 	const background = parseDocumentBackground(documentEl, context);
 	if (background !== void 0) result.background = background;
@@ -177,14 +177,14 @@ function getAllParagraphs(body) {
 	const paragraphs = [];
 	for (const block of body.content) if (block.type === "paragraph") paragraphs.push(block);
 	else if (block.type === "table") paragraphs.push(...getTableParagraphs(block));
-	else if (block.type === "blockSdt") paragraphs.push(...getParagraphsFromBlocks(block.content));
+	else if (block.type === "blockSdt" || block.type === "blockCustomXml") paragraphs.push(...getParagraphsFromBlocks(block.content));
 	return paragraphs;
 }
 const getParagraphsFromBlocks = (blocks) => {
 	const paragraphs = [];
 	for (const block of blocks) if (block.type === "paragraph") paragraphs.push(block);
 	else if (block.type === "table") paragraphs.push(...getTableParagraphs(block));
-	else if (block.type === "blockSdt") paragraphs.push(...getParagraphsFromBlocks(block.content));
+	else if (block.type === "blockSdt" || block.type === "blockCustomXml") paragraphs.push(...getParagraphsFromBlocks(block.content));
 	return paragraphs;
 };
 /**
@@ -194,7 +194,7 @@ function getTableParagraphs(table) {
 	const paragraphs = [];
 	for (const row of table.rows) for (const cell of row.cells) for (const content of cell.content) if (content.type === "paragraph") paragraphs.push(content);
 	else if (content.type === "table") paragraphs.push(...getTableParagraphs(content));
-	else if (content.type === "blockSdt") paragraphs.push(...getParagraphsFromBlocks(content.content));
+	else if (content.type === "blockSdt" || content.type === "blockCustomXml") paragraphs.push(...getParagraphsFromBlocks(content.content));
 	return paragraphs;
 }
 /**
@@ -205,13 +205,13 @@ function getAllTables(body) {
 	for (const block of body.content) if (block.type === "table") {
 		tables.push(block);
 		tables.push(...getNestedTables(block));
-	} else if (block.type === "blockSdt") tables.push(...getTablesFromBlocks(block.content));
+	} else if (block.type === "blockSdt" || block.type === "blockCustomXml") tables.push(...getTablesFromBlocks(block.content));
 	return tables;
 }
 const getTablesFromBlocks = (blocks) => {
 	const tables = [];
 	for (const block of blocks) if (block.type === "table") tables.push(block, ...getNestedTables(block));
-	else if (block.type === "blockSdt") tables.push(...getTablesFromBlocks(block.content));
+	else if (block.type === "blockSdt" || block.type === "blockCustomXml") tables.push(...getTablesFromBlocks(block.content));
 	return tables;
 };
 /**
@@ -222,7 +222,7 @@ function getNestedTables(table) {
 	for (const row of table.rows) for (const cell of row.cells) for (const content of cell.content) if (content.type === "table") {
 		tables.push(content);
 		tables.push(...getNestedTables(content));
-	} else if (content.type === "blockSdt") tables.push(...getTablesFromBlocks(content.content));
+	} else if (content.type === "blockSdt" || content.type === "blockCustomXml") tables.push(...getTablesFromBlocks(content.content));
 	return tables;
 }
 /**
@@ -232,13 +232,13 @@ function getDocumentText(body) {
 	const lines = [];
 	for (const block of body.content) if (block.type === "paragraph") lines.push(getParagraphText(block));
 	else if (block.type === "table") lines.push(getTableText(block));
-	else if (block.type === "blockSdt") lines.push(getTextFromBlocks(block.content));
+	else if (block.type === "blockSdt" || block.type === "blockCustomXml") lines.push(getTextFromBlocks(block.content));
 	return lines.join("\n");
 }
 const getTextFromBlocks = (blocks) => blocks.flatMap((block) => {
 	if (block.type === "paragraph") return [getParagraphText(block)];
 	if (block.type === "table") return [getTableText(block)];
-	return block.type === "blockSdt" ? [getTextFromBlocks(block.content)] : [];
+	return block.type === "blockSdt" || block.type === "blockCustomXml" ? [getTextFromBlocks(block.content)] : [];
 }).join("\n");
 /**
 * Get plain text from a table
@@ -251,7 +251,7 @@ function getTableText(table) {
 			const cellTexts = [];
 			for (const content of cell.content) if (content.type === "paragraph") cellTexts.push(getParagraphText(content));
 			else if (content.type === "table") cellTexts.push(getTableText(content));
-			else if (content.type === "blockSdt") cellTexts.push(getTextFromBlocks(content.content));
+			else if (content.type === "blockSdt" || content.type === "blockCustomXml") cellTexts.push(getTextFromBlocks(content.content));
 			rowTexts.push(cellTexts.join("\n"));
 		}
 		lines.push(rowTexts.join("	"));

package/dist/docx/drawingIdNormalization.d.ts

@@ -1,5 +1,7 @@
 import { DocxParagraphSurfaces } from "./paragraphTraversal.js";
 //#region src/docx/drawingIdNormalization.d.ts
+/** Drawing IDs are package-local identifiers, not image content. */
+declare const drawingXmlWithoutIdentity: (xml: string) => string;
 declare const normalizeDrawingIds: (surfaces: DocxParagraphSurfaces) => void;
 //#endregion
-export { normalizeDrawingIds };
+export { drawingXmlWithoutIdentity, normalizeDrawingIds };

package/dist/docx/drawingIdNormalization.js

@@ -22,6 +22,11 @@ const reassignRawDrawingId = ({ xml, id }) => {
 	visit(root);
 	return foundDocPr ? (root.elements ?? []).map(captureVerbatimXml).join("") : null;
 };
+/** Drawing IDs are package-local identifiers, not image content. */
+const drawingXmlWithoutIdentity = (xml) => reassignRawDrawingId({
+	xml,
+	id: "0"
+}) ?? xml;
 const needsGeneratedId = ({ id }) => id === void 0 || id === "" || id === "0";
 const normalizeDrawingIds = (surfaces) => {
 	const entries = [];
@@ -73,4 +78,4 @@ const normalizeDrawingIds = (surfaces) => {
 	}
 };
 //#endregion
-export { normalizeDrawingIds };
+export { drawingXmlWithoutIdentity, normalizeDrawingIds };