@stll/folio-core 0.52.0 → 0.54.0

package/dist/docx/archiveInflation.js

@@ -0,0 +1,181 @@
+//#region src/docx/archiveInflation.ts
+/**
+* Default ceiling on inflated bytes per compressed byte.
+*
+* Document parts in the repository's fixtures stay under 75:1, and parts over a
+* mebibyte under 15:1. A DEFLATE stream tops out near 1032:1, which is the
+* shape of an entry made of one repeated byte.
+*/
+const DOCX_MAX_COMPRESSION_RATIO = 200;
+/**
+* Inflated size below which the ratio cap does not apply.
+*
+* A small part can compress extremely well without costing anything to hold,
+* so the ratio only has to bound entries (and packages) large enough to
+* matter. The byte caps still apply below this size.
+*/
+const DOCX_COMPRESSION_RATIO_GRACE_BYTES = 4 * 1024 * 1024;
+const CENTRAL_DIRECTORY_RECORD_SIGNATURE = [
+	80,
+	75,
+	1,
+	2
+];
+/**
+* Upper bound on the central-directory records in `bytes`, counted without
+* parsing the archive and stopping once the count passes `stopAfter`.
+*
+* Every record JSZip reads starts with the record signature, so the number of
+* signature occurrences cannot be lower than the number of entries JSZip would
+* build, whatever the end-of-central-directory record claims.
+*/
+const countCentralDirectoryRecords = (bytes, stopAfter) => {
+	const [first, second, third, fourth] = CENTRAL_DIRECTORY_RECORD_SIGNATURE;
+	let count = 0;
+	let offset = bytes.indexOf(first);
+	while (offset !== -1 && offset + 3 < bytes.length) {
+		if (bytes[offset + 1] === second && bytes[offset + 2] === third && bytes[offset + 3] === fourth) {
+			count += 1;
+			if (count > stopAfter) return count;
+		}
+		offset = bytes.indexOf(first, offset + 1);
+	}
+	return count;
+};
+const finiteSize = (value) => typeof value === "number" && Number.isFinite(value) && value >= 0 ? value : null;
+/** Declared sizes of an entry JSZip loaded from an archive. */
+const getZipEntrySizes = (entry) => {
+	const data = "_data" in entry ? entry._data : void 0;
+	if (typeof data !== "object" || data === null) return {
+		compressedBytes: null,
+		uncompressedBytes: null
+	};
+	return {
+		compressedBytes: "compressedSize" in data ? finiteSize(data.compressedSize) : null,
+		uncompressedBytes: "uncompressedSize" in data ? finiteSize(data.uncompressedSize) : null
+	};
+};
+const STORED_COMPRESSION_MAGIC = "\0\0";
+/**
+* Whether a loaded entry is stored rather than compressed. A stored entry
+* reads back exactly the bytes the archive carries, so it cannot expand.
+*/
+const isStoredZipEntry = (entry) => {
+	const data = "_data" in entry ? entry._data : void 0;
+	if (typeof data !== "object" || data === null || !("compression" in data)) return false;
+	const { compression } = data;
+	return typeof compression === "object" && compression !== null && "magic" in compression && compression.magic === STORED_COMPRESSION_MAGIC;
+};
+const RATIO_BOUNDED_EXTENSIONS = /* @__PURE__ */ new Set([
+	"xml",
+	"rels",
+	"vml",
+	"txt",
+	"htm",
+	"html",
+	"mht",
+	"mhtml",
+	"rtf"
+]);
+/**
+* Whether the per-entry ratio cap applies to a part. Markup and text parts
+* never compress anywhere near the cap. Binary parts can: an uncompressed
+* bitmap of one colour compresses like a run of one byte. Those stay bounded
+* by the byte caps and the package-wide ratio instead.
+*/
+const isRatioBoundedPart = (path) => RATIO_BOUNDED_EXTENSIONS.has(path.slice(path.lastIndexOf(".") + 1).toLowerCase());
+/** The per-entry ratio cap for `path`: `maxRatio`, or none for a binary part. */
+const compressionRatioLimitFor = (path, maxRatio) => isRatioBoundedPart(path) ? maxRatio : Number.POSITIVE_INFINITY;
+/**
+* Whether `inflatedBytes` produced from `compressedBytes` passes the ratio cap.
+* Sizes under {@link DOCX_COMPRESSION_RATIO_GRACE_BYTES} never do, and an
+* unknown compressed size is left to the byte caps.
+*/
+const exceedsCompressionRatio = ({ inflatedBytes, compressedBytes, maxRatio }) => compressedBytes !== null && inflatedBytes > 4194304 && inflatedBytes > compressedBytes * maxRatio;
+const createInflationBudget = (maxTotalBytes) => ({
+	maxTotalBytes,
+	inflatedBytes: 0,
+	aborted: false
+});
+const EMPTY_BYTES = /* @__PURE__ */ new Uint8Array(0);
+const concatChunks = (chunks, totalBytes) => {
+	const merged = new Uint8Array(totalBytes);
+	let offset = 0;
+	for (const chunk of chunks) {
+		merged.set(chunk, offset);
+		offset += chunk.length;
+	}
+	return merged;
+};
+/**
+* Inflate one entry chunk by chunk, checking every bound before a chunk is
+* kept. Pausing the stream abandons the rest of the entry, so a limit bounds
+* memory rather than reporting an overrun afterwards.
+*
+* The budget is charged as chunks arrive, which keeps concurrent inflations
+* of one package honest, and refunded when this entry stops at a limit or
+* fails, since none of its bytes are kept. Stream errors (a corrupt entry)
+* reject; limits resolve with `ok: false` for the caller to map onto its own
+* error or skip policy.
+*/
+const inflateEntryWithinLimits = async ({ entry, maxEntryBytes, maxCompressionRatio, budget, retain = true }) => {
+	const { compressedBytes, uncompressedBytes } = getZipEntrySizes(entry);
+	return await new Promise((resolve, reject) => {
+		const stream = entry.internalStream("uint8array");
+		const chunks = [];
+		let entryBytes = 0;
+		let settled = false;
+		const settle = () => {
+			if (settled) return false;
+			settled = true;
+			return true;
+		};
+		const refund = () => {
+			budget.inflatedBytes -= entryBytes;
+		};
+		const stop = (limit) => {
+			if (!settle()) return;
+			stream.pause();
+			refund();
+			resolve({
+				ok: false,
+				limit
+			});
+		};
+		const limitFor = () => {
+			if (budget.aborted) return "aborted";
+			if (uncompressedBytes !== null && entryBytes > uncompressedBytes) return "declared-size";
+			if (exceedsCompressionRatio({
+				inflatedBytes: entryBytes,
+				compressedBytes,
+				maxRatio: maxCompressionRatio
+			})) return "compression-ratio";
+			if (entryBytes > maxEntryBytes) return "entry";
+			if (budget.inflatedBytes > budget.maxTotalBytes) return "total";
+			return null;
+		};
+		stream.on("data", (chunk) => {
+			if (settled) return;
+			entryBytes += chunk.length;
+			budget.inflatedBytes += chunk.length;
+			const limit = limitFor();
+			if (limit !== null) {
+				stop(limit);
+				return;
+			}
+			if (retain) chunks.push(chunk);
+		}).on("end", () => {
+			if (!settle()) return;
+			resolve({
+				ok: true,
+				bytes: retain ? concatChunks(chunks, entryBytes) : EMPTY_BYTES
+			});
+		}).on("error", (error) => {
+			if (!settle()) return;
+			refund();
+			reject(error);
+		}).resume();
+	});
+};
+//#endregion
+export { DOCX_COMPRESSION_RATIO_GRACE_BYTES, DOCX_MAX_COMPRESSION_RATIO, compressionRatioLimitFor, countCentralDirectoryRecords, createInflationBudget, exceedsCompressionRatio, getZipEntrySizes, inflateEntryWithinLimits, isRatioBoundedPart, isStoredZipEntry };

package/dist/docx/attributeRemainder.d.ts

@@ -1,5 +1,5 @@
-import { ModelledAttributes } from "./propertyElementAttributes.js";
 import { XmlElement } from "./xmlParser.js";
+import { ModelledAttributes } from "./propertyElementAttributes.js";
 import { PreservedAttribute } from "@stll/docx-core/model";
 //#region src/docx/attributeRemainder.d.ts
 declare const InvalidPreservedAttributeError_base: import("better-result").TaggedErrorClass<"InvalidPreservedAttributeError">;

package/dist/docx/blockContentParser.d.ts

@@ -2,6 +2,7 @@ import { document_d_exports } from "../types/document.js";
 import { NumberingMap } from "./numberingParser.js";
 import { ParseContext } from "./parseContext.js";
 import { XmlElement } from "./xmlParser.js";
+import { OwnedElsewhere } from "./containerChildren.js";
 import { PreviewLedger } from "./previewBudget.js";
 import { StyleMap } from "./styleParser.js";
 //#region src/docx/blockContentParser.d.ts
@@ -11,6 +12,68 @@ type ParseBlockContentOptions = {
   context?: ParseContext | undefined;
   previews?: PreviewLedger;
 };
+/** The options every block below the entry point reads, with its ledger settled. */
+type BlockContentScope = ParseBlockContentOptions & {
+  previews: PreviewLedger;
+};
+type PreviousListState = {
+  abstractNumId: number | null;
+  fromStyle: boolean;
+  numId: number | null;
+};
+type ParseBlockContentState = {
+  listCounters: Map<number, number[]>;
+  abstractCounters: Map<number, number[]>;
+  restartedNumIds: Set<number>;
+  previousList: PreviousListState;
+  options: BlockContentScope;
+};
 declare const parseBlockContent: (parent: XmlElement, styles: StyleMap | null, theme: document_d_exports.Theme | null, numbering: NumberingMap | null, rels: document_d_exports.RelationshipMap | null, media: Map<string, document_d_exports.MediaFile> | null, options?: ParseBlockContentOptions) => document_d_exports.BlockContent[];
+/** The parts and maps a block sequence is read against. */
+type BlockContentResources = {
+  styles: StyleMap | null;
+  theme: document_d_exports.Theme | null;
+  numbering: NumberingMap | null;
+  rels: document_d_exports.RelationshipMap | null;
+  media: Map<string, document_d_exports.MediaFile> | null;
+};
+/** One block container's children as they are read. */
+type BlockContentWalk = {
+  resources: BlockContentResources;
+  state: ParseBlockContentState;
+  modelled: document_d_exports.BlockContent[];
+};
+declare const BLOCK_CONTENT_HANDLERS: {
+  readonly altChunk: "capture";
+  readonly commentRangeEnd: "capture";
+  readonly commentRangeStart: "capture";
+  readonly customXmlDelRangeEnd: "capture";
+  readonly customXmlDelRangeStart: "capture";
+  readonly customXmlInsRangeEnd: "capture";
+  readonly customXmlInsRangeStart: "capture";
+  readonly customXmlMoveFromRangeEnd: "capture";
+  readonly customXmlMoveFromRangeStart: "capture";
+  readonly customXmlMoveToRangeEnd: "capture";
+  readonly customXmlMoveToRangeStart: "capture";
+  readonly del: "capture";
+  readonly ins: "capture";
+  readonly moveFrom: "capture";
+  readonly moveFromRangeEnd: "capture";
+  readonly moveFromRangeStart: "capture";
+  readonly moveTo: "capture";
+  readonly moveToRangeEnd: "capture";
+  readonly moveToRangeStart: "capture";
+  readonly permEnd: "capture";
+  readonly permStart: "capture";
+  readonly proofErr: "capture";
+  readonly sectPr: OwnedElsewhere<"block-content", "sectPr">;
+  readonly tcPr: OwnedElsewhere<"block-content", "tcPr">;
+  readonly p: (child: XmlElement, { resources: { styles, theme, numbering, rels, media }, state, modelled }: BlockContentWalk) => void;
+  readonly tbl: (child: XmlElement, { resources: { styles, theme, numbering, rels, media }, state, modelled }: BlockContentWalk) => "capture" | undefined;
+  readonly sdt: (child: XmlElement, { resources: { styles, theme, numbering, rels, media }, state, modelled }: BlockContentWalk) => void;
+  readonly customXml: (child: XmlElement, { resources: { styles, theme, numbering, rels, media }, state, modelled }: BlockContentWalk) => void;
+  readonly bookmarkStart: (child: XmlElement, { modelled }: BlockContentWalk) => void;
+  readonly bookmarkEnd: (child: XmlElement, { modelled }: BlockContentWalk) => void;
+};
 //#endregion
-export { parseBlockContent };
+export { BLOCK_CONTENT_HANDLERS, parseBlockContent };

package/dist/docx/blockContentParser.js

@@ -1,3 +1,4 @@
+import { blockCustomXmlShell } from "./blockCustomXmlShell.js";
 import { parseBookmarkEnd, parseBookmarkStart } from "./bookmarkParser.js";
 import { bulletMarkerFontName, convertBulletToUnicode } from "./bulletMarkers.js";
 import { CAPTURE, dispatchChildrenWithContext, ownedElsewhere, withPreservedChildren } from "./containerChildren.js";
@@ -8,7 +9,7 @@ import { enrichParagraphTextBoxes } from "./paragraphTextBoxEnrichment.js";
 import { standalonePreviewLedger } from "./previewBudget.js";
 import { captureSdtSiblingMarkers, parseSdtProperties } from "./sdtProperties.js";
 import { parseTable } from "./tableParser.js";
-import { findWordprocessingChild, mergeXmlnsDeclarations, selectAlternateContentBranch } from "./xmlParser.js";
+import { findWordprocessingChild, getLocalName, mergeXmlnsDeclarations, selectAlternateContentBranch } from "./xmlParser.js";
 //#region src/docx/blockContentParser.ts
 const computeListMarker = (paragraph, { numbering, listCounters, abstractCounters, restartedNumIds, previousList }) => {
 	const listRendering = paragraph.listRendering;
@@ -131,6 +132,13 @@ const BLOCK_CONTENT_UNDECLARED = { AlternateContent: (child, { resources: { styl
 	if (!selectedBranch) return;
 	modelled.push(...parseBlockContentWithState(selectedBranch, styles, theme, numbering, rels, media, withContainerXmlns(withContainerXmlns(state, child), selectedBranch)));
 } };
+const parseBlockCustomXml = (child, styles, theme, numbering, rels, media, state) => {
+	return {
+		type: "blockCustomXml",
+		...blockCustomXmlShell(child),
+		content: parseBlockContentWithState(child, styles, theme, numbering, rels, media, withContainerXmlns(state, child))
+	};
+};
 const BLOCK_CONTENT_HANDLERS = {
 	p: (child, { resources: { styles, theme, numbering, rels, media }, state, modelled }) => {
 		const paragraph = parseParagraph(child, styles, theme, numbering, rels, media, {
@@ -149,12 +157,18 @@ const BLOCK_CONTENT_HANDLERS = {
 	},
 	tbl: (child, { resources: { styles, theme, numbering, rels, media }, state, modelled }) => {
 		const table = parseTable(child, styles, theme, numbering, rels, media, state.options);
-		if (!table) return;
+		if (!table) return child.elements?.some((tableChild) => {
+			const localName = getLocalName(tableChild.name ?? "");
+			return localName !== "tblPr" && localName !== "tblGrid";
+		}) ?? false ? CAPTURE : void 0;
 		modelled.push(table);
 	},
 	sdt: (child, { resources: { styles, theme, numbering, rels, media }, state, modelled }) => {
 		modelled.push(parseBlockSdt(child, styles, theme, numbering, rels, media, state));
 	},
+	customXml: (child, { resources: { styles, theme, numbering, rels, media }, state, modelled }) => {
+		modelled.push(parseBlockCustomXml(child, styles, theme, numbering, rels, media, state));
+	},
 	bookmarkStart: (child, { modelled }) => {
 		modelled.push(parseBookmarkStart(child));
 	},
@@ -165,7 +179,6 @@ const BLOCK_CONTENT_HANDLERS = {
 	altChunk: CAPTURE,
 	commentRangeEnd: CAPTURE,
 	commentRangeStart: CAPTURE,
-	customXml: CAPTURE,
 	customXmlDelRangeEnd: CAPTURE,
 	customXmlDelRangeStart: CAPTURE,
 	customXmlInsRangeEnd: CAPTURE,
@@ -223,4 +236,4 @@ const parseBlockSdt = (child, styles, theme, numbering, rels, media, state) => {
 	};
 };
 //#endregion
-export { parseBlockContent };
+export { BLOCK_CONTENT_HANDLERS, parseBlockContent };

package/dist/docx/blockCustomXmlShell.d.ts

@@ -0,0 +1,7 @@
+import { document_d_exports } from "../types/document.js";
+import { XmlElement } from "./xmlParser.js";
+//#region src/docx/blockCustomXmlShell.d.ts
+/** Capture the wrapper independently of its modeled and preserved children. */
+declare const blockCustomXmlShell: (element: XmlElement) => Pick<document_d_exports.BlockCustomXml, "openingXml" | "closingXml">;
+//#endregion
+export { blockCustomXmlShell };

package/dist/docx/blockCustomXmlShell.js

@@ -0,0 +1,14 @@
+import { captureVerbatimXml } from "./verbatimCapture.js";
+import { cloneElement } from "./xmlParser.js";
+//#region src/docx/blockCustomXmlShell.ts
+/** Capture the wrapper independently of its modeled and preserved children. */
+const blockCustomXmlShell = (element) => {
+	const shell = captureVerbatimXml(cloneElement(element, { elements: [] }));
+	const name = element.name ?? "w:customXml";
+	return {
+		openingXml: shell.endsWith("/>") ? `${shell.slice(0, -2)}>` : shell,
+		closingXml: `</${name}>`
+	};
+};
+//#endregion
+export { blockCustomXmlShell };

package/dist/docx/blockPlainText.js

@@ -1,3 +1,5 @@
+import { ALT_CHUNK_READER_DIAGNOSTIC, isAltChunkMarkup } from "./altChunk.js";
+import { OPAQUE_REVISION_CARRIER_READER_DIAGNOSTIC, isOpaqueNestedRowMarkup, opaqueRevisionCarrierName } from "./opaqueCarrier.js";
 import { getParagraphText } from "./paragraphParser.js";
 import { panic } from "better-result";
 //#region src/docx/blockPlainText.ts
@@ -29,9 +31,14 @@ const collectBlockTexts = (blocks) => {
 			}
 			break;
 		case "blockSdt":
+		case "blockCustomXml":
 			texts.push(...collectBlockTexts(block.content));
 			break;
 		case "preservedBlock":
+			if (isAltChunkMarkup(block.xml)) texts.push(block.readerText === void 0 ? ALT_CHUNK_READER_DIAGNOSTIC : `${ALT_CHUNK_READER_DIAGNOSTIC}\n${block.readerText}`);
+			else if (opaqueRevisionCarrierName(block.xml) !== void 0) texts.push(OPAQUE_REVISION_CARRIER_READER_DIAGNOSTIC);
+			else if (isOpaqueNestedRowMarkup(block.xml)) texts.push("[Unsupported nested w:tr content]");
+			break;
 		case "bookmarkStart":
 		case "bookmarkEnd": break;
 		default: panic(`Unsupported block in plain-text extraction: ${JSON.stringify(block)}`);

package/dist/docx/commentAnchorIndex.js

@@ -19,7 +19,7 @@ const visitCommentMarkers = (blocks, visit) => {
 			for (const row of block.rows) for (const cell of row.cells) visitBlocks(cell.content);
 			return;
 		}
-		if (block.type !== "blockSdt") return;
+		if (block.type !== "blockSdt" && block.type !== "blockCustomXml") return;
 		visitBlocks(block.content);
 	};
 	const visitBlocks = (nested) => {

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",