@stll/folio-core 0.43.0 → 0.44.0

package/dist/ai-edits/headless.js

@@ -264,11 +264,12 @@ const formatBlockLine = (block, text) => {
 	return `${label} ${text}`;
 };
 const formatBlockForLLM = (block) => formatBlockLine(block, block.text);
-const headingLevel = (block) => {
-	const digits = /(\d+)/u.exec(block.styleId ?? block.displayLabel ?? "")?.[1];
-	const level = digits ? Number.parseInt(digits, 10) : 1;
-	return level >= 1 && level <= 9 ? level : 1;
-};
+/**
+* The level the snapshot already classified. Scraping a digit out of the style
+* id instead read `ClauseParagraph2` as an h2 and every localized heading id
+* without a digit as an h1.
+*/
+const headingLevel = (block) => block.headingLevel ?? 1;
 const revisionIdOf = (target) => typeof target === "number" ? target : target.id;
 const commentPlainText = (comment) => (comment.content ?? []).map(paragraphPlainText).join("\n");
 const paragraphPlainText = (paragraph) => {

package/dist/ai-edits/index.d.ts

@@ -6,8 +6,8 @@ import { DocPositionRange, clampRangeToDocSize, resolveFolioAIBlockRange, resolv
 import { buildAnnotatedBlockText } from "./clean-text.js";
 import { ApplyFolioDocumentOperationsOptions, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_LINE_SPACING_RULE_VALUES, FOLIO_PARAGRAPH_ALIGNMENT_VALUES, FolioDocumentOperation, FolioDocumentOperationAffectedTarget, FolioDocumentOperationBatch, FolioDocumentOperationCapabilities, FolioDocumentOperationIssue, FolioDocumentOperationMode, FolioDocumentOperationPrecondition, FolioDocumentOperationReceipt, FolioDocumentOperationRecovery, FolioDocumentOperationResult, FolioDocumentOperationResultBase, FolioDocumentOperationStatus, FolioDocumentOperationStory, FolioDocumentOperationType, FolioDocumentOperationUndoFailureReason, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "../document-operations.js";
 import { FolioCommentAnchor, FolioReviewChange, FolioReviewChangeKind, getCommentAnchorsFromDoc, getTrackedChangesFromDoc } from "./read.js";
-import { createFolioAIEditSnapshot, createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./snapshot.js";
+import { createFolioAIEditSnapshot, createFolioAIEditSnapshotWithStyleResolver, createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./snapshot.js";
 import { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioApplyDocumentOperationsToStoryOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioEditableDocumentStoryHandle, FolioReadReviewedStoryOptions, FolioResolveReviewedStoryOptions, FolioResolvedReviewedView, FolioReviewedStory, FolioReviewedView, UnsupportedFolioReviewedViewError, isFolioResolvedReviewedView, isFolioReviewedView } from "./headless.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./scoped-reading.js";
 import { getFolioParaIdFromBlockId } from "../types/block-id.js";
-export { type ApplyFolioDocumentOperationsOptions, type DocPositionRange, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_LINE_SPACING_RULE_VALUES, FOLIO_PARAGRAPH_ALIGNMENT_VALUES, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIBlockStructuralBoundary, type FolioAIBlockTableLocation, type FolioAIComment, type FolioAIEditAppliedOperation, type FolioAIEditApplyMode, type FolioAIEditApplyOutcome, type FolioAIEditApplyResult, type FolioAIEditNormalization, type FolioAIEditNormalizationCode, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditReviewMeta, type FolioAIEditSeverity, type FolioAIEditSkipReason, type FolioAIEditSkippedOperation, type FolioAIEditSnapshot, type FolioAIEditView, type FolioAIInlineBooleanProperty, type FolioAIInlineFormatting, type FolioAIInlineFormattingPatch, type FolioAIInsertFormattingScope, type FolioAIParagraphSpacing, type FolioAISignatureParty, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsToStoryOptions, type FolioCommentAnchor, type FolioContentParagraphKind, type FolioDocumentNavigationTarget, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationResultBase, type FolioDocumentOperationStatus, type FolioDocumentOperationStory, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentOutline, type FolioDocumentOutlineEntry, type FolioDocumentSection, type FolioDocumentSectionHandle, type FolioDocumentSectionReadResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, type FolioEditableDocumentStoryHandle, type FolioReadReviewedStoryOptions, type FolioResolveReviewedStoryOptions, type FolioResolvedReviewedView, type FolioReviewChange, type FolioReviewChangeKind, type FolioReviewedStory, type FolioReviewedView, type FolioRevisionStamp, type FolioWordDiffOptions, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, WORD_DIFF_GRANULARITIES, type WordDiffGranularity, type WordDiffNormalization, type WordDiffOptions, type WordDiffSegment, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioAIContentBlock, isFolioDocumentOperationModeSupported, isFolioResolvedReviewedView, isFolioReviewedView, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange, resolvePassageRange };
+export { type ApplyFolioDocumentOperationsOptions, type DocPositionRange, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_LINE_SPACING_RULE_VALUES, FOLIO_PARAGRAPH_ALIGNMENT_VALUES, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIBlockStructuralBoundary, type FolioAIBlockTableLocation, type FolioAIComment, type FolioAIEditAppliedOperation, type FolioAIEditApplyMode, type FolioAIEditApplyOutcome, type FolioAIEditApplyResult, type FolioAIEditNormalization, type FolioAIEditNormalizationCode, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditReviewMeta, type FolioAIEditSeverity, type FolioAIEditSkipReason, type FolioAIEditSkippedOperation, type FolioAIEditSnapshot, type FolioAIEditView, type FolioAIInlineBooleanProperty, type FolioAIInlineFormatting, type FolioAIInlineFormattingPatch, type FolioAIInsertFormattingScope, type FolioAIParagraphSpacing, type FolioAISignatureParty, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsToStoryOptions, type FolioCommentAnchor, type FolioContentParagraphKind, type FolioDocumentNavigationTarget, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationResultBase, type FolioDocumentOperationStatus, type FolioDocumentOperationStory, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentOutline, type FolioDocumentOutlineEntry, type FolioDocumentSection, type FolioDocumentSectionHandle, type FolioDocumentSectionReadResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, type FolioEditableDocumentStoryHandle, type FolioReadReviewedStoryOptions, type FolioResolveReviewedStoryOptions, type FolioResolvedReviewedView, type FolioReviewChange, type FolioReviewChangeKind, type FolioReviewedStory, type FolioReviewedView, type FolioRevisionStamp, type FolioWordDiffOptions, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, WORD_DIFF_GRANULARITIES, type WordDiffGranularity, type WordDiffNormalization, type WordDiffOptions, type WordDiffSegment, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAIEditSnapshotWithStyleResolver, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioAIContentBlock, isFolioDocumentOperationModeSupported, isFolioResolvedReviewedView, isFolioReviewedView, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange, resolvePassageRange };

package/dist/ai-edits/index.js

@@ -6,6 +6,6 @@ import { buildAnnotatedBlockText } from "./clean-text.js";
 import { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, UnsupportedFolioReviewedViewError, isFolioResolvedReviewedView, isFolioReviewedView } from "./headless.js";
 import { getCommentAnchorsFromDoc, getTrackedChangesFromDoc } from "./read.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./scoped-reading.js";
-import { createFolioAIEditSnapshot, createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./snapshot.js";
+import { createFolioAIEditSnapshot, createFolioAIEditSnapshotWithStyleResolver, createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./snapshot.js";
 import { WORD_DIFF_GRANULARITIES, diffWordSegments } from "./word-diff.js";
-export { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_LINE_SPACING_RULE_VALUES, FOLIO_PARAGRAPH_ALIGNMENT_VALUES, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, WORD_DIFF_GRANULARITIES, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioAIContentBlock, isFolioDocumentOperationModeSupported, isFolioResolvedReviewedView, isFolioReviewedView, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange, resolvePassageRange };
+export { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_LINE_SPACING_RULE_VALUES, FOLIO_PARAGRAPH_ALIGNMENT_VALUES, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, WORD_DIFF_GRANULARITIES, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAIEditSnapshotWithStyleResolver, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioAIContentBlock, isFolioDocumentOperationModeSupported, isFolioResolvedReviewedView, isFolioReviewedView, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange, resolvePassageRange };

package/dist/ai-edits/snapshot.js

@@ -1,3 +1,4 @@
+import { EMPTY_BUILT_IN_STYLE_INDEX, resolveHeadingLevel } from "../docx/builtInStyles.js";
 import { recreateProseNodeWithParagraphPropertySource } from "../docx/paragraphPropertySource.js";
 import { expectCharacterStyleMarkAttrs, expectHyperlinkMarkAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs } from "../prosemirror/attrs/index.js";
 import { marksToTextFormatting } from "../prosemirror/conversion/fromProseDoc.js";
@@ -335,6 +336,7 @@ const getTableLocation = ({ path, blockIndex, tableIndexByStart }) => {
 	}
 };
 const createFolioAIEditSnapshotInternal = (doc, styleResolver) => {
+	const builtInStyles = styleResolver?.builtInStyles ?? EMPTY_BUILT_IN_STYLE_INDEX;
 	const draftBlocks = [];
 	const hashCounts = /* @__PURE__ */ new Map();
 	const usedBlockIds = /* @__PURE__ */ new Set();
@@ -394,9 +396,9 @@ const createFolioAIEditSnapshotInternal = (doc, styleResolver) => {
 			});
 		}
 		usedBlockIds.add(id);
-		const headingLevel = getHeadingLevel(node);
+		const headingLevel = getHeadingLevel(node, builtInStyles);
 		const kind = getBlockKind(node, headingLevel);
-		const displayLabel = getDisplayLabel(node);
+		const displayLabel = getDisplayLabel(node, kind === "heading");
 		const styleId = getStyleId(node);
 		const listLevel = getListLevel(node);
 		const listReference = getListReference(node);
@@ -477,19 +479,21 @@ const getBlockKind = (node, headingLevel) => {
 	if (headingLevel !== void 0) return "heading";
 	return "paragraph";
 };
-const getHeadingLevel = (node) => {
+/** The block's 1-based heading level, as {@link resolveHeadingLevel} classifies it. */
+const getHeadingLevel = (node, styles) => {
 	const outlineLevel = node.attrs["outlineLevel"];
-	if (typeof outlineLevel === "number" && Number.isInteger(outlineLevel) && outlineLevel >= 0 && outlineLevel <= 8) return outlineLevel + 1;
 	const styleId = node.attrs["styleId"];
-	if (typeof styleId !== "string") return;
-	const level = /^heading(?<level>[1-9])$/iu.exec(styleId)?.groups?.["level"];
-	return level === void 0 ? void 0 : Number.parseInt(level, 10);
+	const level = resolveHeadingLevel({
+		outlineLevel: typeof outlineLevel === "number" ? outlineLevel : null,
+		styleId: typeof styleId === "string" ? styleId : null
+	}, styles);
+	return level === void 0 ? void 0 : level + 1;
 };
-const getDisplayLabel = (node) => {
+const getDisplayLabel = (node, isHeading) => {
 	const listMarker = node.attrs["listMarker"];
 	if (typeof listMarker === "string" && listMarker.trim().length > 0) return listMarker.trim();
 	const styleId = node.attrs["styleId"];
-	if (typeof styleId === "string" && /^heading/iu.test(styleId)) return styleId;
+	if (isHeading && typeof styleId === "string") return styleId;
 };
 const getListLevel = (node) => {
 	const numPr = node.attrs["numPr"];

package/dist/compare/content-alignment.js

@@ -1171,7 +1171,22 @@ const contentStructureEvidenceIndexes = (base, revised) => {
 		revised: index(revised)
 	};
 };
-const sortedIndexesLeaveRange = (indexes, start, end) => indexes !== void 0 && ((indexes.at(0) ?? start) < start || (indexes.at(-1) ?? end - 1) >= end);
+/**
+* Whether the evidence lies outside the range, and only outside it.
+*
+* Evidence inside the range is at least as good a counterpart as evidence
+* beyond it, so a match that is also present locally does not make the local
+* pair suspect. Without the second test, two structurally identical tables in
+* one document cancel each other: each shares every exact signature and anchor
+* text with the other by construction, so each looks like it belongs
+* elsewhere, and comparing the document with itself reports both deleted and
+* both re-inserted.
+*/
+const sortedIndexesLeaveRange = (indexes, start, end) => {
+	if (indexes === void 0) return false;
+	if ((indexes.at(0) ?? start) >= start && (indexes.at(-1) ?? end - 1) < end) return false;
+	return !indexes.some((index) => index >= start && index < end);
+};
 const profileHasEvidenceOutsideRange = (profile, opposite, start, end) => {
 	const exactKey = opposite.exactKeyByProfile.get(profile);
 	if (exactKey !== void 0 && sortedIndexesLeaveRange(opposite.exactIndexes.get(exactKey), start, end)) return true;

package/dist/compare/inline-atoms.js

@@ -69,7 +69,7 @@ const atomBlockOf = ({ node, from }) => {
 		}
 		const prepared = prepareTargetInlineAtom(child);
 		if (!prepared) {
-			unalignable = true;
+			unsupportedTopology.push(`${offset}:${child.type.name}:${canonicalJson(child.attrs)}`);
 			return false;
 		}
 		supported.push({

package/dist/compare/style-resources.js

@@ -213,6 +213,12 @@ const importReferencedStyleDefinitions = ({ sourceStyles, destinationStyles, sou
 		styleIdMap: /* @__PURE__ */ new Map(),
 		importedStyleIds: []
 	};
+	if (requested.length === 0 && !sourceStyles && !destinationStyles) return {
+		status: "unchanged",
+		styles: destinationStyles,
+		styleIdMap: /* @__PURE__ */ new Map(),
+		importedStyleIds: []
+	};
 	if (!sourceStyles) return {
 		status: "unalignable",
 		detail: "the target has no style definitions"

package/dist/docx/appVersionNormalization.d.ts

@@ -1,22 +1,4 @@
 //#region src/docx/appVersionNormalization.d.ts
-/**
- * Keep the application version a package states about itself in the form the
- * schema gives it.
- *
- * `AppVersion` in the extended-properties part is `XX.YYYY`: a one- or
- * two-digit integer, a dot, and four digits. Producers exist that write a
- * three-part version there instead, and folio copies `docProps/app.xml`
- * through verbatim when it saves a document it did not create — so a package
- * can carry a value with two dots in, and a save that copies it out hands a
- * consumer a package it refuses to open at all.
- *
- * {@link appVersionInSchemaForm} is the one mapping, and it is a pure function
- * of the value alone: it keeps the leading integer where the value opens with
- * one the form allows, and writes the build digits the form requires. Nothing
- * else in the part is touched, and a package that carries no extended
- * properties keeps carrying none — synthesizing metadata a document never
- * stated is a different decision.
- */
 declare const AppVersionSchemaError_base: import("better-result").TaggedErrorClass<"AppVersionSchemaError">;
 /**
  * A value reached the package that the schema form does not accept.

package/dist/docx/blockContentParser.js

@@ -1,3 +1,4 @@
+import { attachPendingRangeMarkers, attachTrailingRangeMarkers, isBlockRangeMarker } from "./blockRangeMarkers.js";
 import { parseBookmarkEnd, parseBookmarkStart } from "./bookmarkParser.js";
 import { appendBookmarkMarkerToLastParagraphInBlocks, prependBookmarkMarkersToFirstParagraphInBlocks } from "./bookmarkPlacement.js";
 import { convertBulletToUnicode } from "./bulletMarkers.js";
@@ -106,6 +107,7 @@ const parseBlockContentWithState = (parent, styles, theme, numbering, rels, medi
 	const content = [];
 	const children = getChildElements(parent);
 	const pendingBookmarkMarkers = [];
+	const pendingRangeMarkers = [];
 	for (const child of children) {
 		const localName = getLocalName(child.name ?? "");
 		if (localName === "p") {
@@ -119,6 +121,7 @@ const parseBlockContentWithState = (parent, styles, theme, numbering, rels, medi
 				restartedNumIds: state.restartedNumIds,
 				previousList: state.previousList
 			});
+			attachPendingRangeMarkers(paragraph, pendingRangeMarkers);
 			content.push(paragraph);
 			continue;
 		}
@@ -126,6 +129,7 @@ const parseBlockContentWithState = (parent, styles, theme, numbering, rels, medi
 			const table = parseTable(child, styles, theme, numbering, rels, media, state.options);
 			if (!table) continue;
 			if (prependBookmarkMarkersToFirstParagraphInBlocks([table], pendingBookmarkMarkers)) pendingBookmarkMarkers.length = 0;
+			attachPendingRangeMarkers(table, pendingRangeMarkers);
 			content.push(table);
 			continue;
 		}
@@ -143,6 +147,7 @@ const parseBlockContentWithState = (parent, styles, theme, numbering, rels, medi
 				content: sdtContent ? parseBlockContentWithState(sdtContent, styles, theme, numbering, rels, media, withContainerXmlns(withContainerXmlns(state, child), sdtContent)) : []
 			};
 			if (prependBookmarkMarkersToFirstParagraphInBlocks(blockSdt.content, pendingBookmarkMarkers)) pendingBookmarkMarkers.length = 0;
+			attachPendingRangeMarkers(blockSdt, pendingRangeMarkers);
 			content.push(blockSdt);
 			continue;
 		}
@@ -154,12 +159,15 @@ const parseBlockContentWithState = (parent, styles, theme, numbering, rels, medi
 		if (localName === "bookmarkStart" || localName === "bookmarkEnd") {
 			const marker = parseBookmarkMarker(child, localName);
 			if (!appendBookmarkMarkerToLastParagraphInBlocks(content, marker)) pendingBookmarkMarkers.push(marker);
+			continue;
 		}
+		if (isBlockRangeMarker(localName)) pendingRangeMarkers.push(captureVerbatimXml(child));
 	}
 	if (pendingBookmarkMarkers.length > 0) content.push({
 		type: "paragraph",
 		content: [...pendingBookmarkMarkers]
 	});
+	attachTrailingRangeMarkers(content, pendingRangeMarkers);
 	return content;
 };
 /**

package/dist/docx/blockRangeMarkers.d.ts

@@ -0,0 +1,36 @@
+//#region src/docx/blockRangeMarkers.d.ts
+/**
+ * Range markers that stand between two blocks.
+ *
+ * `w:body`, `w:tc`, a header and an SDT's content all admit
+ * `EG_RunLevelElts` and `EG_RangeMarkupElements` beside their paragraphs, and
+ * every block container dropped them: a `w:permStart` between two paragraphs
+ * is the whole of a document-protection range, so losing it removes the
+ * protection from the saved file without a word. folio models none of these,
+ * and their position is their meaning, so they are captured verbatim and
+ * replayed where they stood — the same treatment `w:sdt`'s sibling markers
+ * already get (MS-OE376 §2.5.2.30).
+ *
+ * Bookmarks are absent from the set on purpose: they are modelled, and the
+ * block containers already relocate them into the neighbouring paragraph.
+ */
+declare const isBlockRangeMarker: (localName: string) => boolean;
+/** Hand the markers collected so far to the block they stood before. */
+declare const attachPendingRangeMarkers: (block: {
+  rawMarkersBefore?: string;
+}, pending: string[]) => void;
+/**
+ * Markers after the last block ride on it, since there is no block after them.
+ * With no block at all they are dropped: a container holding markers and no
+ * content has nothing for them to delimit.
+ */
+declare const attachTrailingRangeMarkers: (blocks: readonly {
+  rawMarkersAfter?: string;
+}[], pending: string[]) => void;
+/** Wrap a serialized block in the markup that stood around it. */
+declare const withBlockRangeMarkers: (block: {
+  rawMarkersBefore?: string;
+  rawMarkersAfter?: string;
+}, xml: string) => string;
+//#endregion
+export { attachPendingRangeMarkers, attachTrailingRangeMarkers, isBlockRangeMarker, withBlockRangeMarkers };

package/dist/docx/blockRangeMarkers.js

@@ -0,0 +1,59 @@
+//#region src/docx/blockRangeMarkers.ts
+/**
+* Range markers that stand between two blocks.
+*
+* `w:body`, `w:tc`, a header and an SDT's content all admit
+* `EG_RunLevelElts` and `EG_RangeMarkupElements` beside their paragraphs, and
+* every block container dropped them: a `w:permStart` between two paragraphs
+* is the whole of a document-protection range, so losing it removes the
+* protection from the saved file without a word. folio models none of these,
+* and their position is their meaning, so they are captured verbatim and
+* replayed where they stood — the same treatment `w:sdt`'s sibling markers
+* already get (MS-OE376 §2.5.2.30).
+*
+* Bookmarks are absent from the set on purpose: they are modelled, and the
+* block containers already relocate them into the neighbouring paragraph.
+*/
+const BLOCK_RANGE_MARKER_NAMES = /* @__PURE__ */ new Set([
+	"commentRangeEnd",
+	"commentRangeStart",
+	"customXmlDelRangeEnd",
+	"customXmlDelRangeStart",
+	"customXmlInsRangeEnd",
+	"customXmlInsRangeStart",
+	"customXmlMoveFromRangeEnd",
+	"customXmlMoveFromRangeStart",
+	"customXmlMoveToRangeEnd",
+	"customXmlMoveToRangeStart",
+	"moveFromRangeEnd",
+	"moveFromRangeStart",
+	"moveToRangeEnd",
+	"moveToRangeStart",
+	"permEnd",
+	"permStart"
+]);
+const isBlockRangeMarker = (localName) => BLOCK_RANGE_MARKER_NAMES.has(localName);
+/** Hand the markers collected so far to the block they stood before. */
+const attachPendingRangeMarkers = (block, pending) => {
+	if (pending.length === 0) return;
+	block.rawMarkersBefore = pending.join("");
+	pending.length = 0;
+};
+/**
+* Markers after the last block ride on it, since there is no block after them.
+* With no block at all they are dropped: a container holding markers and no
+* content has nothing for them to delimit.
+*/
+const attachTrailingRangeMarkers = (blocks, pending) => {
+	const last = blocks.at(-1);
+	if (pending.length === 0 || last === void 0) {
+		pending.length = 0;
+		return;
+	}
+	last.rawMarkersAfter = pending.join("");
+	pending.length = 0;
+};
+/** Wrap a serialized block in the markup that stood around it. */
+const withBlockRangeMarkers = (block, xml) => `${block.rawMarkersBefore ?? ""}${xml}${block.rawMarkersAfter ?? ""}`;
+//#endregion
+export { attachPendingRangeMarkers, attachTrailingRangeMarkers, isBlockRangeMarker, withBlockRangeMarkers };

package/dist/docx/bookmarkParser.d.ts

@@ -1,27 +1,9 @@
 import { document_d_exports } from "../types/document.js";
 import { XmlElement } from "./xmlParser.js";
 //#region src/docx/bookmarkParser.d.ts
-/**
- * Parse a bookmark start element (w:bookmarkStart)
- *
- * Extracts:
- * - id: Numeric identifier (required, matches with bookmarkEnd)
- * - name: Bookmark name (required, used by hyperlinks)
- * - colFirst: First column for table bookmarks (optional)
- * - colLast: Last column for table bookmarks (optional)
- *
- * @param node - The w:bookmarkStart XML element
- * @returns Parsed BookmarkStart object
- */
+/** Parse a bookmark start element (w:bookmarkStart, CT_Bookmark). */
 declare function parseBookmarkStart(node: XmlElement): document_d_exports.BookmarkStart;
-/**
- * Parse a bookmark end element (w:bookmarkEnd)
- *
- * Bookmark ends only contain an ID that matches the corresponding start marker.
- *
- * @param node - The w:bookmarkEnd XML element
- * @returns Parsed BookmarkEnd object
- */
+/** Parse a bookmark end element (w:bookmarkEnd, CT_MarkupRange). */
 declare function parseBookmarkEnd(node: XmlElement): document_d_exports.BookmarkEnd;
 /**
  * Bookmark map for quick lookup by ID or name

package/dist/docx/bookmarkParser.js

@@ -1,41 +1,17 @@
-import { getAttribute, parseNumericAttribute } from "./xmlParser.js";
+import { parseBookmarkRangeMarker, parseMarkupRangeMarker } from "./markupRangeMarker.js";
 //#region src/docx/bookmarkParser.ts
-/**
-* Parse a bookmark start element (w:bookmarkStart)
-*
-* Extracts:
-* - id: Numeric identifier (required, matches with bookmarkEnd)
-* - name: Bookmark name (required, used by hyperlinks)
-* - colFirst: First column for table bookmarks (optional)
-* - colLast: Last column for table bookmarks (optional)
-*
-* @param node - The w:bookmarkStart XML element
-* @returns Parsed BookmarkStart object
-*/
+/** Parse a bookmark start element (w:bookmarkStart, CT_Bookmark). */
 function parseBookmarkStart(node) {
-	const bookmark = {
+	return {
 		type: "bookmarkStart",
-		id: parseNumericAttribute(node, "w", "id") ?? 0,
-		name: getAttribute(node, "w", "name") ?? ""
+		...parseBookmarkRangeMarker(node)
 	};
-	const colFirst = parseNumericAttribute(node, "w", "colFirst");
-	if (colFirst !== void 0) bookmark.colFirst = colFirst;
-	const colLast = parseNumericAttribute(node, "w", "colLast");
-	if (colLast !== void 0) bookmark.colLast = colLast;
-	return bookmark;
 }
-/**
-* Parse a bookmark end element (w:bookmarkEnd)
-*
-* Bookmark ends only contain an ID that matches the corresponding start marker.
-*
-* @param node - The w:bookmarkEnd XML element
-* @returns Parsed BookmarkEnd object
-*/
+/** Parse a bookmark end element (w:bookmarkEnd, CT_MarkupRange). */
 function parseBookmarkEnd(node) {
 	return {
 		type: "bookmarkEnd",
-		id: parseNumericAttribute(node, "w", "id") ?? 0
+		...parseMarkupRangeMarker(node)
 	};
 }
 /**

package/dist/docx/borderParser.d.ts

@@ -0,0 +1,13 @@
+import { document_d_exports } from "../types/document.js";
+import { ParseContext } from "./parseContext.js";
+import { XmlElement } from "./xmlParser.js";
+//#region src/docx/borderParser.d.ts
+/**
+ * `w:val` is `use="required"` on `CT_Border`. An element without it states no
+ * style at all, so the border is dropped rather than invented as `none`:
+ * `none` is an authored token that cancels an inherited border, and a
+ * malformed element is not evidence the author wanted that.
+ */
+declare function parseBorderSpec(border: XmlElement | null, context?: ParseContext): document_d_exports.BorderSpec | undefined;
+//#endregion
+export { parseBorderSpec };

package/dist/docx/borderParser.js

@@ -0,0 +1,71 @@
+import { BorderStyleSchema, ThemeColorSlotSchema, narrowEnum } from "./parserEnums.js";
+import { getAttribute, parseNumericAttribute, parseOnOffAttribute } from "./xmlParser.js";
+import { PARSE_WARNING_CODES } from "@stll/docx-core/model";
+//#region src/docx/borderParser.ts
+/**
+* The one reader for `CT_Border`, shared by the paragraph (`w:pBdr`), style,
+* table (`w:tblBorders`/`w:tcBorders`) and page (`w:pgBorders`) tiers.
+*
+* `w:val` is `ST_Border`, whose 193 members include two distinct "no border"
+* tokens: `nil` and `none`. They are not interchangeable downstream, and an
+* explicit one overrides a border inherited from the container, so the member
+* the author wrote is preserved exactly. Members outside the model's known
+* union survive verbatim rather than collapsing to a default, which is how the
+* repo already treats `w:numFmt`, `w:suff` and `w:tab`.
+*/
+const parseBorderColor = (border) => {
+	const rgb = getAttribute(border, "w", "color");
+	const themeColor = getAttribute(border, "w", "themeColor");
+	const themeTint = getAttribute(border, "w", "themeTint");
+	const themeShade = getAttribute(border, "w", "themeShade");
+	if (rgb === null && themeColor === null && themeTint === null && themeShade === null) return;
+	const color = {};
+	if (rgb === "auto") color.auto = true;
+	else if (rgb) color.rgb = rgb;
+	const validatedThemeColor = narrowEnum(themeColor, ThemeColorSlotSchema);
+	if (validatedThemeColor) color.themeColor = validatedThemeColor;
+	if (themeTint) color.themeTint = themeTint;
+	if (themeShade) color.themeShade = themeShade;
+	return color;
+};
+/**
+* `w:val` is `use="required"` on `CT_Border`. An element without it states no
+* style at all, so the border is dropped rather than invented as `none`:
+* `none` is an authored token that cancels an inherited border, and a
+* malformed element is not evidence the author wanted that.
+*/
+function parseBorderSpec(border, context) {
+	if (!border) return;
+	const rawStyle = getAttribute(border, "w", "val");
+	if (!rawStyle) {
+		context?.warn({
+			code: PARSE_WARNING_CODES.borderWithoutValue,
+			element: border.name ?? "border"
+		});
+		return;
+	}
+	const spec = { style: narrowEnum(rawStyle, BorderStyleSchema) ?? rawStyle };
+	const color = parseBorderColor(border);
+	if (color) spec.color = color;
+	const size = parseNumericAttribute(border, "w", "sz");
+	if (size !== void 0) spec.size = size;
+	const space = parseNumericAttribute(border, "w", "space");
+	if (space !== void 0) spec.space = space;
+	const shadow = parseOnOffAttribute(border, "w", "shadow");
+	if (shadow !== void 0) spec.shadow = shadow;
+	const frame = parseOnOffAttribute(border, "w", "frame");
+	if (frame !== void 0) spec.frame = frame;
+	const artRelationshipId = getAttribute(border, "w", "id")?.trim();
+	if (artRelationshipId) spec.artRelationshipId = artRelationshipId;
+	const topLeftArtRelationshipId = getAttribute(border, "w", "topLeft")?.trim();
+	if (topLeftArtRelationshipId) spec.topLeftArtRelationshipId = topLeftArtRelationshipId;
+	const topRightArtRelationshipId = getAttribute(border, "w", "topRight")?.trim();
+	if (topRightArtRelationshipId) spec.topRightArtRelationshipId = topRightArtRelationshipId;
+	const bottomLeftArtRelationshipId = getAttribute(border, "w", "bottomLeft")?.trim();
+	if (bottomLeftArtRelationshipId) spec.bottomLeftArtRelationshipId = bottomLeftArtRelationshipId;
+	const bottomRightArtRelationshipId = getAttribute(border, "w", "bottomRight")?.trim();
+	if (bottomRightArtRelationshipId) spec.bottomRightArtRelationshipId = bottomRightArtRelationshipId;
+	return spec;
+}
+//#endregion
+export { parseBorderSpec };