@stll/folio-core 0.32.1 → 0.33.0

package/dist/prosemirror/validation.js

@@ -25,63 +25,91 @@ const validateProseMirrorDocument = (doc) => {
 		issues
 	};
 };
+/**
+* Locate a bookmark boundary by the paragraph holding it, so a failure names a
+* place a reader can find rather than only a node path.
+*
+* The paragraph's text is deliberately left out. Validation messages travel
+* into logs and error reports, and document text is not log data.
+*/
+const describeParagraph = (attrs, path) => {
+	const paraId = attrs?.ok === true ? attrs.value.paraId : void 0;
+	return paraId !== void 0 && paraId.length > 0 ? `paragraph ${paraId}` : `paragraph at ${path}`;
+};
+const describeBookmark = (id, name) => name === null || name.length === 0 ? `Bookmark id ${id}` : `Bookmark "${name}" (id ${id})`;
 const validateBookmarkBoundaryStructure = (doc, issues) => {
 	const open = /* @__PURE__ */ new Map();
-	const startedIds = /* @__PURE__ */ new Set();
-	const registerStart = (id, path) => {
-		if (startedIds.has(id)) {
+	const startedBy = /* @__PURE__ */ new Map();
+	/** Whether the boundary opened, and so needs a matching end registered later. */
+	const registerStart = (boundary) => {
+		const { id, name, path, paragraph, origin } = boundary;
+		const previousOrigin = startedBy.get(id);
+		if (previousOrigin !== void 0) {
+			if (origin === "attr" && previousOrigin === "attr") return false;
 			issues.push({
 				path,
-				message: `Bookmark id ${id} has more than one start boundary.`
+				message: `${describeBookmark(id, name)} has more than one start boundary (${paragraph}).`
 			});
-			return;
+			return false;
 		}
-		startedIds.add(id);
-		open.set(id, {
-			id,
-			path
-		});
+		startedBy.set(id, origin);
+		open.set(id, boundary);
+		return true;
 	};
-	const registerEnd = (id, path) => {
-		if (!open.get(id)) {
+	const registerEnd = (id, path, paragraph) => {
+		if (!open.has(id)) {
 			issues.push({
 				path,
-				message: `Bookmark id ${id} has no open start boundary.`
+				message: `${describeBookmark(id, null)} has no open start boundary (${paragraph}).`
 			});
 			return;
 		}
 		open.delete(id);
 	};
-	const visit = (node, path) => {
+	const visit = (node, path, paragraph) => {
 		const paragraphAttrs = node.type.name === "paragraph" ? readParagraphAttrs(node) : null;
-		if (paragraphAttrs?.ok) for (const [index, bookmark] of (paragraphAttrs.value.bookmarks ?? []).entries()) registerStart(bookmark.id, `${path}.paragraph.attrs.bookmarks[${index}]`);
+		const enclosingParagraph = node.type.name === "paragraph" ? describeParagraph(paragraphAttrs, path) : paragraph;
+		const openedAttrBookmarks = [];
+		if (paragraphAttrs?.ok) for (const [index, bookmark] of (paragraphAttrs.value.bookmarks ?? []).entries()) {
+			const bookmarkPath = `${path}.paragraph.attrs.bookmarks[${index}]`;
+			if (registerStart({
+				id: bookmark.id,
+				name: bookmark.name,
+				path: bookmarkPath,
+				paragraph: enclosingParagraph,
+				origin: "attr"
+			})) openedAttrBookmarks.push({
+				id: bookmark.id,
+				path: bookmarkPath
+			});
+		}
 		if (node.type.name === "bookmarkBoundary") {
 			const result = readBookmarkBoundaryAttrs(node);
 			if (result.ok) {
 				const attrs = result.value;
-				const hasHyperlink = node.marks.some((mark) => mark.type.name === "hyperlink");
-				const trackedChanges = node.marks.filter((mark) => mark.type.name === "insertion" || mark.type.name === "deletion");
-				if (trackedChanges.length > 1) issues.push({
+				if (node.marks.filter((mark) => mark.type.name === "insertion" || mark.type.name === "deletion").length > 1) issues.push({
 					path,
-					message: "Bookmark boundaries cannot carry multiple tracked-change parents."
+					message: `Bookmark boundaries cannot carry multiple tracked-change parents (${enclosingParagraph}).`
 				});
-				else if (trackedChanges.length === 1 && !hasHyperlink) issues.push({
+				if (attrs.type === "start") registerStart({
+					id: attrs.id,
+					name: attrs.name ?? null,
 					path,
-					message: "Bookmark boundaries inside tracked changes require a hyperlink serialization parent."
+					paragraph: enclosingParagraph,
+					origin: "node"
 				});
-				if (attrs.type === "start") registerStart(attrs.id, path);
-				else registerEnd(attrs.id, path);
+				else registerEnd(attrs.id, path, enclosingParagraph);
 			}
 		}
 		node.forEach((child, _offset, index) => {
-			visit(child, `${path}.content[${index}]`);
+			visit(child, `${path}.content[${index}]`, enclosingParagraph);
 		});
-		if (paragraphAttrs?.ok) for (const [index, bookmark] of (paragraphAttrs.value.bookmarks ?? []).entries()) registerEnd(bookmark.id, `${path}.paragraph.attrs.bookmarks[${index}]`);
+		for (const { id, path: bookmarkPath } of openedAttrBookmarks) registerEnd(id, bookmarkPath, enclosingParagraph);
 	};
-	visit(doc, "doc");
+	visit(doc, "doc", "the document root");
 	for (const boundary of open.values()) issues.push({
 		path: boundary.path,
-		message: `Bookmark id ${boundary.id} has no matching end boundary.`
+		message: `${describeBookmark(boundary.id, boundary.name)} has no matching end boundary (${boundary.paragraph}).`
 	});
 };
 const assertValidProseMirrorDocument = (doc, context) => {

package/dist/prosemirror/zeroWidthAnchors.d.ts

@@ -0,0 +1,10 @@
+import { Node } from "prosemirror-model";
+//#region src/prosemirror/zeroWidthAnchors.d.ts
+declare const isZeroWidthAnchor: (node: Node) => boolean;
+/**
+ * Whether the textblock holds nothing but zero-width anchors, which is what
+ * "everything in it was resolved away" looks like in the document.
+ */
+declare const holdsNoContent: (block: Node) => boolean;
+//#endregion
+export { holdsNoContent, isZeroWidthAnchor };

package/dist/prosemirror/zeroWidthAnchors.js

@@ -0,0 +1,23 @@
+import { BOOKMARK_BOUNDARY_NODE_NAME } from "./extensions/nodes/BookmarkBoundaryExtension.js";
+import { RENDERED_PAGE_BREAK_NODE_NAME } from "./extensions/nodes/RenderedPageBreakExtension.js";
+import { TEXT_BOX_ANCHOR_NODE_NAME } from "./extensions/nodes/TextBoxAnchorExtension.js";
+//#region src/prosemirror/zeroWidthAnchors.ts
+const ZERO_WIDTH_ANCHOR_NODE_NAMES = /* @__PURE__ */ new Set([
+	BOOKMARK_BOUNDARY_NODE_NAME,
+	RENDERED_PAGE_BREAK_NODE_NAME,
+	TEXT_BOX_ANCHOR_NODE_NAME
+]);
+const isZeroWidthAnchor = (node) => ZERO_WIDTH_ANCHOR_NODE_NAMES.has(node.type.name);
+/**
+* Whether the textblock holds nothing but zero-width anchors, which is what
+* "everything in it was resolved away" looks like in the document.
+*/
+const holdsNoContent = (block) => {
+	let empty = true;
+	block.forEach((child) => {
+		if (!isZeroWidthAnchor(child)) empty = false;
+	});
+	return empty;
+};
+//#endregion
+export { holdsNoContent, isZeroWidthAnchor };

package/dist/redline.js

@@ -1,9 +1,10 @@
 import { FolioDocxReviewer, isFolioResolvedReviewedView } from "./ai-edits/headless.js";
-import { createFolioAITextRangeHandle } from "./ai-edits/snapshot.js";
+import { createFolioAITextRangeHandle, trailingBodyBlockId } from "./ai-edits/snapshot.js";
+import { inlineFormattingSegments } from "./compare/formatting.js";
 import "./document-operations.js";
 import { pairFolioDocumentStories } from "./document-stories.js";
 import { resolveFolioDocumentPrivacyTransforms, rewriteDocxMetadataPrivacy } from "./docx/metadataPrivacy.js";
-import { GenerateRedlineDocxOperationLimitError } from "./redlineOperationLimit.js";
+import { GenerateRedlineDocxOperationLimitError, MAX_GENERATED_REDLINE_OPERATIONS } from "./redlineOperationLimit.js";
 import { alignFolioBlocks } from "./version-comparison.js";
 import { TaggedError, panic } from "better-result";
 //#region src/redline.ts
@@ -31,73 +32,15 @@ const nextBaseBlockIdByIndex = (events) => {
 	}
 	return nextIds;
 };
-const changedSupportedFormatting = (base, revised) => ({
-	...Boolean(base.bold) !== Boolean(revised.bold) && { bold: Boolean(revised.bold) },
-	...Boolean(base.italic) !== Boolean(revised.italic) && { italic: Boolean(revised.italic) },
-	...Boolean(base.underline) !== Boolean(revised.underline) && { underline: Boolean(revised.underline) }
-});
-const sameInlineFormatting = (left, right) => left.bold === right.bold && left.italic === right.italic && left.underline === right.underline;
-const hasInlineFormatting = (formatting) => formatting.bold !== void 0 || formatting.italic !== void 0 || formatting.underline !== void 0;
-const previewRunsForBlock = (block) => {
-	const runs = block.previewRuns ?? [{ text: block.text }];
-	return runs.map(({ text }) => text).join("") === block.text ? runs : null;
-};
-const formattingSegments = (baseBlock, revisedBlock) => {
-	const baseRuns = previewRunsForBlock(baseBlock);
-	const revisedRuns = previewRunsForBlock(revisedBlock);
-	if (!baseRuns || !revisedRuns || baseBlock.text.length === 0) return [];
-	const segments = [];
-	let baseRunIndex = 0;
-	let revisedRunIndex = 0;
-	let baseRunOffset = 0;
-	let revisedRunOffset = 0;
-	let textOffset = 0;
-	while (baseRunIndex < baseRuns.length && revisedRunIndex < revisedRuns.length) {
-		const baseRun = baseRuns[baseRunIndex];
-		const revisedRun = revisedRuns[revisedRunIndex];
-		if (!baseRun || !revisedRun) break;
-		const length = Math.min(baseRun.text.length - baseRunOffset, revisedRun.text.length - revisedRunOffset);
-		if (length <= 0) {
-			if (baseRunOffset >= baseRun.text.length) {
-				baseRunIndex++;
-				baseRunOffset = 0;
-			}
-			if (revisedRunOffset >= revisedRun.text.length) {
-				revisedRunIndex++;
-				revisedRunOffset = 0;
-			}
-			continue;
-		}
-		const formatting = changedSupportedFormatting(baseRun, revisedRun);
-		if (hasInlineFormatting(formatting)) {
-			const previous = segments.at(-1);
-			if (previous && previous.endOffset === textOffset && sameInlineFormatting(previous.formatting, formatting)) previous.endOffset += length;
-			else {
-				if (segments.length >= 1e4) throw new GenerateRedlineDocxOperationLimitError({ message: "The document comparison exceeds the generated operation limit." });
-				segments.push({
-					startOffset: textOffset,
-					endOffset: textOffset + length,
-					formatting
-				});
-			}
-		}
-		textOffset += length;
-		baseRunOffset += length;
-		revisedRunOffset += length;
-		if (baseRunOffset >= baseRun.text.length) {
-			baseRunIndex++;
-			baseRunOffset = 0;
-		}
-		if (revisedRunOffset >= revisedRun.text.length) {
-			revisedRunIndex++;
-			revisedRunOffset = 0;
-		}
-	}
-	return segments;
-};
 const buildFormattingRedlineOperations = ({ baseBlock, revisedBlock, nextOperationId }) => {
+	const segments = inlineFormattingSegments({
+		baseBlock,
+		targetBlock: revisedBlock,
+		maxSegments: MAX_GENERATED_REDLINE_OPERATIONS
+	});
+	if (segments === null) throw new GenerateRedlineDocxOperationLimitError({ message: "The document comparison exceeds the generated operation limit." });
 	const operations = [];
-	for (const { startOffset, endOffset, formatting } of formattingSegments(baseBlock, revisedBlock)) {
+	for (const { startOffset, endOffset, formatting } of segments) {
 		const range = createFolioAITextRangeHandle({
 			blockId: baseBlock.id,
 			text: baseBlock.text,
@@ -119,7 +62,7 @@ const buildRedlineOperations = ({ baseSnapshot, revisedBlocks, nextOperationId }
 	const anchorIds = nextBaseBlockIdByIndex(events);
 	const operations = [];
 	const trailingAdditions = [];
-	const lastBaseBlockId = baseSnapshot.blocks.at(-1)?.id ?? null;
+	const lastBaseBlockId = trailingBodyBlockId(baseSnapshot);
 	events.forEach((event, eventIndex) => {
 		if (event.type === "pair") {
 			if (event.baseBlock.text !== event.revisedBlock.text) operations.push({
@@ -159,20 +102,10 @@ const buildRedlineOperations = ({ baseSnapshot, revisedBlocks, nextOperationId }
 			...event.block.styleId !== void 0 && { styleId: event.block.styleId }
 		});
 	});
-	if (lastBaseBlockId === null && baseSnapshot.emptyDocumentAnchorId !== void 0) {
-		const firstAddition = trailingAdditions.shift();
-		if (firstAddition !== void 0) operations.push({
-			id: nextOperationId(),
-			type: "replaceBlock",
-			blockId: baseSnapshot.emptyDocumentAnchorId,
-			text: firstAddition.text,
-			...firstAddition.styleId !== void 0 && { styleId: firstAddition.styleId }
-		});
-	}
 	for (const addition of trailingAdditions) operations.push({
 		id: nextOperationId(),
 		type: "insertAfterBlock",
-		blockId: lastBaseBlockId ?? baseSnapshot.emptyDocumentAnchorId ?? "redline-unanchored",
+		blockId: lastBaseBlockId ?? "redline-unanchored",
 		text: addition.text,
 		...addition.styleId !== void 0 && { styleId: addition.styleId }
 	});

package/dist/server.d.ts

@@ -1,8 +1,8 @@
-import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditApplyMode, FolioAIEditApplyResult, FolioAIEditOperation, FolioAIEditPrecondition, FolioAIEditSnapshot, FolioAIInlineFormatting, FolioAITextRangeHandle, FolioDocumentNavigationTarget, FolioDocumentOutline, FolioDocumentOutlineEntry, FolioDocumentSection, FolioDocumentSectionHandle, FolioDocumentSectionReadResult } from "./ai-edits/types.js";
-import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocumentOperation, FolioDocumentOperationAffectedTarget, FolioDocumentOperationBatch, FolioDocumentOperationBatchPrecondition, FolioDocumentOperationCapabilities, FolioDocumentOperationIssue, FolioDocumentOperationMode, FolioDocumentOperationPrecondition, FolioDocumentOperationQueuedOperation, FolioDocumentOperationReceipt, FolioDocumentOperationRecovery, FolioDocumentOperationResult, FolioDocumentOperationStatus, FolioDocumentOperationStory, FolioDocumentOperationType, FolioDocumentOperationUndoFailureReason, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
+import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditApplyMode, FolioAIEditApplyResult, FolioAIEditNormalization, FolioAIEditNormalizationCode, FolioAIEditOperation, FolioAIEditPrecondition, FolioAIEditSnapshot, FolioAIInlineFormatting, FolioAITextRangeHandle, FolioDocumentNavigationTarget, FolioDocumentOutline, FolioDocumentOutlineEntry, FolioDocumentSection, FolioDocumentSectionHandle, FolioDocumentSectionReadResult } from "./ai-edits/types.js";
+import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocumentOperation, FolioDocumentOperationAffectedTarget, FolioDocumentOperationBatch, FolioDocumentOperationBatchPrecondition, FolioDocumentOperationCapabilities, FolioDocumentOperationIssue, FolioDocumentOperationMode, FolioDocumentOperationPrecondition, FolioDocumentOperationQueuedOperation, FolioDocumentOperationReceipt, FolioDocumentOperationRecovery, FolioDocumentOperationResult, FolioDocumentOperationResultBase, FolioDocumentOperationStatus, FolioDocumentOperationStory, FolioDocumentOperationType, FolioDocumentOperationUndoFailureReason, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
 import { FolioReviewChange, FolioReviewChangeKind } from "./ai-edits/read.js";
 import { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioApplyDocumentOperationsOptions, FolioApplyDocumentOperationsToStoryOptions, FolioApplyOperationsOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioDocxReviewer, FolioDocxReviewerOptions, FolioEditableDocumentStoryHandle, FolioReadReviewedStoryOptions, FolioResolveReviewedStoryOptions, FolioResolvedReviewedView, FolioReviewChangeFilter, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, FolioReviewedStory, FolioReviewedView, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView } from "./ai-edits/headless.js";
-import { createFolioAITextRangeHandle, hashFolioAIBlockText, normalizeFolioAIBlockText } from "./ai-edits/snapshot.js";
+import { createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./ai-edits/snapshot.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./ai-edits/scoped-reading.js";
 import { DeriveBlockIdInput, FolioBlockId, deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DocumentPreset, DocumentStyleSet } from "./style-sets/types.js";
@@ -27,4 +27,4 @@ import { FOLIO_DOCX_PACKAGE_INSPECTION_DEFAULTS, FOLIO_DOCX_PACKAGE_INSPECTION_E
 import { FOLIO_YJS_DOCX_MATERIALIZATION_ERROR_CODES, FOLIO_YJS_PROSEMIRROR_FRAGMENT_NAME, FOLIO_YJS_UPDATE_MAX_BYTES, FolioYjsDocxMaterializationError, FolioYjsDocxMaterializationErrorCode, MaterializeYjsDocxOptions, materializeYjsDocx } from "./docx/server/materializeYjsDocx.js";
 import { GenerateRedlineDocxOptions, GenerateRedlineDocxResult, GenerateRedlineUnprocessedStory, InvalidGenerateRedlineDocxOptionsError, generateRedlineDocx } from "./redline.js";
 import { FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, FolioBlockDiff, FolioCompareDocxVersionsOptions, FolioDocumentMetadataValue, FolioFormatProperty, FolioMetadataDiff, FolioStoryDiff, FolioVersionBlockHandle, FolioVersionComparisonPrivacyTransform, FolioVersionComparisonScope, FolioVersionDiff, FolioVersionDiffPrivacyOptions, FolioVersionDiffPrivacyReport, FolioVersionDiffSegment, FolioVersionDiffSummaryCounts, InvalidFolioVersionComparisonOptionsError, applyFolioVersionDiffPrivacy, compareDocxVersions, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope } from "./version-comparison.js";
-export { type ApplyDocxXmlPatchProposalArgs, type ApplyFolioAIEditsToBufferOptions, type ApplyFolioAIEditsToBufferResult, BILINGUAL_TABLE_LAYOUTS, type BilingualBorders, type BilingualParagraphRef, type BilingualRow, type BilingualRowKind, type BilingualTableLayout, type BilingualTableParagraphRef, type CreateBilingualDocumentOptions, type CreateBilingualDocumentResult, type CreateBilingualDocxOptions, type CreateBilingualDocxResult, type CreateCommentReplyInput, type CreateEmptyDocumentOptions, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, type DeriveBlockIdInput, type DocumentPreset, type DocumentStyleCatalog, type DocumentStyleCatalogEntry, type DocumentStyleSet, DocxArchiveError, type DocxArchiveOptions, type DocxParagraphSource, type DocxTableRowKind, type DocxTableRowPosition, EnsureParaIdsError, type EnsureParaIdsOptions, type EnsureParaIdsResult, type EvaluateDocxXmlPatchProposalArgs, type ExtractDocumentStyleSetOptions, type ExtractedDocxParagraph, type ExtractedDocxTableCell, type ExtractedDocxTableCellParagraph, type ExtractedDocxText, FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FOLIO_DOCX_CONFORMANCE_CHECKS, FOLIO_DOCX_CONFORMANCE_ISSUE_CODES, FOLIO_DOCX_CONFORMANCE_PROFILE, FOLIO_DOCX_CONFORMANCE_REPORT_VERSION, FOLIO_DOCX_PACKAGE_INSPECTION_DEFAULTS, FOLIO_DOCX_PACKAGE_INSPECTION_ERROR_CODES, FOLIO_DOCX_PACKAGE_INSPECTION_VERSION, FOLIO_DOCX_XML_PATCH_APPLICATION_PROFILE, FOLIO_DOCX_XML_PATCH_APPLICATION_VERSION, FOLIO_DOCX_XML_PATCH_PROPOSAL_DEFAULTS, FOLIO_DOCX_XML_PATCH_PROPOSAL_ISSUE_CODES, FOLIO_DOCX_XML_PATCH_PROPOSAL_PROFILE, FOLIO_DOCX_XML_PATCH_PROPOSAL_VERSION, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, FOLIO_YJS_DOCX_MATERIALIZATION_ERROR_CODES, FOLIO_YJS_PROSEMIRROR_FRAGMENT_NAME, FOLIO_YJS_UPDATE_MAX_BYTES, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIComment, type FolioAIEditApplyMode, type FolioAIEditApplyResult, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditSnapshot, type FolioAIInlineFormatting, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsOptions, type FolioApplyDocumentOperationsToStoryOptions, type FolioApplyOperationsOptions, type FolioBlockDiff, type FolioBlockId, type FolioCompareDocxVersionsOptions, type FolioDocumentMetadataProperty, type FolioDocumentMetadataValue, type FolioDocumentNavigationTarget, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationBatchPrecondition, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationQueuedOperation, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationStatus, type FolioDocumentOperationStory, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentOutline, type FolioDocumentOutlineEntry, FolioDocumentPrivacyArchiveError, type FolioDocumentPrivacyOptions, type FolioDocumentPrivacyReport, type FolioDocumentPrivacyTransform, type FolioDocumentSection, type FolioDocumentSectionHandle, type FolioDocumentSectionReadResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, type FolioDocxConformanceCheck, type FolioDocxConformanceCheckId, type FolioDocxConformanceCheckStatus, type FolioDocxConformanceIssue, type FolioDocxConformanceIssueCode, type FolioDocxConformanceReport, type FolioDocxConformanceStatus, type FolioDocxInspectedXmlPart, type FolioDocxPackageInspection, FolioDocxPackageInspectionError, type FolioDocxPackageInspectionErrorCode, type FolioDocxPackageInspectionLimits, type FolioDocxPackagePart, type FolioDocxPackagePartKind, type FolioDocxPreparedXmlReplacement, FolioDocxReviewer, type FolioDocxReviewerOptions, type FolioDocxXmlPatchApplication, FolioDocxXmlPatchApplicationError, type FolioDocxXmlPatchApplicationReceipt, type FolioDocxXmlPatchProposal, type FolioDocxXmlPatchProposalEvaluation, type FolioDocxXmlPatchProposalIssue, type FolioDocxXmlPatchProposalIssueCode, type FolioDocxXmlPatchProposalLimits, type FolioDocxXmlReplacement, type FolioEditableDocumentStoryHandle, type FolioFormatProperty, type FolioMetadataDiff, type FolioReadReviewedStoryOptions, type FolioResolveReviewedStoryOptions, type FolioResolvedReviewedView, type FolioReviewChange, type FolioReviewChangeFilter, type FolioReviewChangeKind, type FolioReviewComment, type FolioReviewCommentFilter, type FolioReviewCommentReply, type FolioReviewReplyInput, type FolioReviewedStory, type FolioReviewedView, type FolioStoryDiff, type FolioVersionBlockHandle, type FolioVersionComparisonPrivacyTransform, type FolioVersionComparisonScope, type FolioVersionDiff, type FolioVersionDiffPrivacyOptions, type FolioVersionDiffPrivacyReport, type FolioVersionDiffSegment, type FolioVersionDiffSummaryCounts, FolioYjsDocxMaterializationError, type FolioYjsDocxMaterializationErrorCode, type GenerateRedlineDocxOptions, type GenerateRedlineDocxResult, type GenerateRedlineUnprocessedStory, HEADING_LEVELS, type HeadingLevel, type InspectDocxPackageOptions, InvalidBilingualDocumentOptionsError, InvalidFolioDocumentOperationBatchError, InvalidFolioDocumentPrivacyOptionsError, InvalidFolioDocxXmlPatchProposalError, InvalidFolioDocxXmlPatchProposalOptionsError, InvalidFolioReportBuilderOptionsError, InvalidFolioVersionComparisonOptionsError, InvalidGenerateRedlineDocxOptionsError, type MaterializeYjsDocxOptions, type ParseOptions, type RewriteDocxMetadataPrivacyResult, STELLA_STYLE_SET_NAME, type TableCellSpec, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioDocxXmlPatchApplicationProfileError, UnsupportedFolioReviewedViewError, type ValidateDocxConformanceOptions, applyDocxXmlPatchProposal, applyFolioAIEditsToBuffer, applyFolioVersionDiffPrivacy, assertSupportedFolioDocumentOperationVersion, bookmark, compareDocxVersions, createBilingualDocument, createBilingualDocx, createDocx, createEmptyDocument, createFolioAITextRangeHandle, createStellaStyleDocumentPreset, createStellaStyleSet, createTableOfContentsField, deriveBlockId, docxToMarkdown, endnote, ensureParaIds, evaluateDocxXmlPatchProposal, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractDocxText, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, hashFolioAIBlockText, heading, hyperlink, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxPackage, isFolioBlockId, isFolioDocumentOperationModeSupported, isFolioDocumentPrivacyTransform, isFolioResolvedReviewedView, isFolioReviewedView, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, materializeYjsDocx, normalizeFolioAIBlockText, pageBreak, paragraph, parseDocx, parseFolioDocumentOperationBatch, parseFolioDocxXmlPatchProposal, readBilingualDocument, readBilingualDocx, readFolioDocumentSection, replyToComment, rewriteDocxMetadataPrivacy, run, table, validateDocxConformance };
+export { type ApplyDocxXmlPatchProposalArgs, type ApplyFolioAIEditsToBufferOptions, type ApplyFolioAIEditsToBufferResult, BILINGUAL_TABLE_LAYOUTS, type BilingualBorders, type BilingualParagraphRef, type BilingualRow, type BilingualRowKind, type BilingualTableLayout, type BilingualTableParagraphRef, type CreateBilingualDocumentOptions, type CreateBilingualDocumentResult, type CreateBilingualDocxOptions, type CreateBilingualDocxResult, type CreateCommentReplyInput, type CreateEmptyDocumentOptions, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, type DeriveBlockIdInput, type DocumentPreset, type DocumentStyleCatalog, type DocumentStyleCatalogEntry, type DocumentStyleSet, DocxArchiveError, type DocxArchiveOptions, type DocxParagraphSource, type DocxTableRowKind, type DocxTableRowPosition, EnsureParaIdsError, type EnsureParaIdsOptions, type EnsureParaIdsResult, type EvaluateDocxXmlPatchProposalArgs, type ExtractDocumentStyleSetOptions, type ExtractedDocxParagraph, type ExtractedDocxTableCell, type ExtractedDocxTableCellParagraph, type ExtractedDocxText, FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FOLIO_DOCX_CONFORMANCE_CHECKS, FOLIO_DOCX_CONFORMANCE_ISSUE_CODES, FOLIO_DOCX_CONFORMANCE_PROFILE, FOLIO_DOCX_CONFORMANCE_REPORT_VERSION, FOLIO_DOCX_PACKAGE_INSPECTION_DEFAULTS, FOLIO_DOCX_PACKAGE_INSPECTION_ERROR_CODES, FOLIO_DOCX_PACKAGE_INSPECTION_VERSION, FOLIO_DOCX_XML_PATCH_APPLICATION_PROFILE, FOLIO_DOCX_XML_PATCH_APPLICATION_VERSION, FOLIO_DOCX_XML_PATCH_PROPOSAL_DEFAULTS, FOLIO_DOCX_XML_PATCH_PROPOSAL_ISSUE_CODES, FOLIO_DOCX_XML_PATCH_PROPOSAL_PROFILE, FOLIO_DOCX_XML_PATCH_PROPOSAL_VERSION, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, FOLIO_YJS_DOCX_MATERIALIZATION_ERROR_CODES, FOLIO_YJS_PROSEMIRROR_FRAGMENT_NAME, FOLIO_YJS_UPDATE_MAX_BYTES, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIComment, type FolioAIEditApplyMode, type FolioAIEditApplyResult, type FolioAIEditNormalization, type FolioAIEditNormalizationCode, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditSnapshot, type FolioAIInlineFormatting, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsOptions, type FolioApplyDocumentOperationsToStoryOptions, type FolioApplyOperationsOptions, type FolioBlockDiff, type FolioBlockId, type FolioCompareDocxVersionsOptions, type FolioDocumentMetadataProperty, type FolioDocumentMetadataValue, type FolioDocumentNavigationTarget, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationBatchPrecondition, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationQueuedOperation, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationResultBase, type FolioDocumentOperationStatus, type FolioDocumentOperationStory, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentOutline, type FolioDocumentOutlineEntry, FolioDocumentPrivacyArchiveError, type FolioDocumentPrivacyOptions, type FolioDocumentPrivacyReport, type FolioDocumentPrivacyTransform, type FolioDocumentSection, type FolioDocumentSectionHandle, type FolioDocumentSectionReadResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, type FolioDocxConformanceCheck, type FolioDocxConformanceCheckId, type FolioDocxConformanceCheckStatus, type FolioDocxConformanceIssue, type FolioDocxConformanceIssueCode, type FolioDocxConformanceReport, type FolioDocxConformanceStatus, type FolioDocxInspectedXmlPart, type FolioDocxPackageInspection, FolioDocxPackageInspectionError, type FolioDocxPackageInspectionErrorCode, type FolioDocxPackageInspectionLimits, type FolioDocxPackagePart, type FolioDocxPackagePartKind, type FolioDocxPreparedXmlReplacement, FolioDocxReviewer, type FolioDocxReviewerOptions, type FolioDocxXmlPatchApplication, FolioDocxXmlPatchApplicationError, type FolioDocxXmlPatchApplicationReceipt, type FolioDocxXmlPatchProposal, type FolioDocxXmlPatchProposalEvaluation, type FolioDocxXmlPatchProposalIssue, type FolioDocxXmlPatchProposalIssueCode, type FolioDocxXmlPatchProposalLimits, type FolioDocxXmlReplacement, type FolioEditableDocumentStoryHandle, type FolioFormatProperty, type FolioMetadataDiff, type FolioReadReviewedStoryOptions, type FolioResolveReviewedStoryOptions, type FolioResolvedReviewedView, type FolioReviewChange, type FolioReviewChangeFilter, type FolioReviewChangeKind, type FolioReviewComment, type FolioReviewCommentFilter, type FolioReviewCommentReply, type FolioReviewReplyInput, type FolioReviewedStory, type FolioReviewedView, type FolioStoryDiff, type FolioVersionBlockHandle, type FolioVersionComparisonPrivacyTransform, type FolioVersionComparisonScope, type FolioVersionDiff, type FolioVersionDiffPrivacyOptions, type FolioVersionDiffPrivacyReport, type FolioVersionDiffSegment, type FolioVersionDiffSummaryCounts, FolioYjsDocxMaterializationError, type FolioYjsDocxMaterializationErrorCode, type GenerateRedlineDocxOptions, type GenerateRedlineDocxResult, type GenerateRedlineUnprocessedStory, HEADING_LEVELS, type HeadingLevel, type InspectDocxPackageOptions, InvalidBilingualDocumentOptionsError, InvalidFolioDocumentOperationBatchError, InvalidFolioDocumentPrivacyOptionsError, InvalidFolioDocxXmlPatchProposalError, InvalidFolioDocxXmlPatchProposalOptionsError, InvalidFolioReportBuilderOptionsError, InvalidFolioVersionComparisonOptionsError, InvalidGenerateRedlineDocxOptionsError, type MaterializeYjsDocxOptions, type ParseOptions, type RewriteDocxMetadataPrivacyResult, STELLA_STYLE_SET_NAME, type TableCellSpec, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioDocxXmlPatchApplicationProfileError, UnsupportedFolioReviewedViewError, type ValidateDocxConformanceOptions, applyDocxXmlPatchProposal, applyFolioAIEditsToBuffer, applyFolioVersionDiffPrivacy, assertSupportedFolioDocumentOperationVersion, bookmark, compareDocxVersions, createBilingualDocument, createBilingualDocx, createDocx, createEmptyDocument, createFolioAITextRangeHandle, createStellaStyleDocumentPreset, createStellaStyleSet, createTableOfContentsField, deriveBlockId, docxToMarkdown, endnote, ensureParaIds, evaluateDocxXmlPatchProposal, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractDocxText, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, hashFolioAIBlockText, heading, hyperlink, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxPackage, isFolioAIContentBlock, isFolioBlockId, isFolioDocumentOperationModeSupported, isFolioDocumentPrivacyTransform, isFolioResolvedReviewedView, isFolioReviewedView, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, materializeYjsDocx, normalizeFolioAIBlockText, pageBreak, paragraph, parseDocx, parseFolioDocumentOperationBatch, parseFolioDocxXmlPatchProposal, readBilingualDocument, readBilingualDocx, readFolioDocumentSection, replyToComment, rewriteDocxMetadataPrivacy, run, table, validateDocxConformance };

package/dist/server.js

@@ -1,6 +1,6 @@
 import { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, FolioDocxReviewer, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView } from "./ai-edits/headless.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./ai-edits/scoped-reading.js";
-import { createFolioAITextRangeHandle, hashFolioAIBlockText, normalizeFolioAIBlockText } from "./ai-edits/snapshot.js";
+import { createFolioAITextRangeHandle, hashFolioAIBlockText, isFolioAIContentBlock, normalizeFolioAIBlockText } from "./ai-edits/snapshot.js";
 import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
 import { EnsureParaIdsError, ensureParaIds } from "./docx/ensureParaIds.js";
 import { FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FolioDocumentPrivacyArchiveError, InvalidFolioDocumentPrivacyOptionsError, isFolioDocumentPrivacyTransform, rewriteDocxMetadataPrivacy } from "./docx/metadataPrivacy.js";
@@ -25,4 +25,4 @@ import { DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION } from "./style-set
 import { deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { createEmptyDocument } from "./utils/createDocument.js";
 import { FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, InvalidFolioVersionComparisonOptionsError, applyFolioVersionDiffPrivacy, compareDocxVersions, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope } from "./version-comparison.js";
-export { BILINGUAL_TABLE_LAYOUTS, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DocxArchiveError, EnsureParaIdsError, FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FOLIO_DOCX_CONFORMANCE_CHECKS, FOLIO_DOCX_CONFORMANCE_ISSUE_CODES, FOLIO_DOCX_CONFORMANCE_PROFILE, FOLIO_DOCX_CONFORMANCE_REPORT_VERSION, FOLIO_DOCX_PACKAGE_INSPECTION_DEFAULTS, FOLIO_DOCX_PACKAGE_INSPECTION_ERROR_CODES, FOLIO_DOCX_PACKAGE_INSPECTION_VERSION, FOLIO_DOCX_XML_PATCH_APPLICATION_PROFILE, FOLIO_DOCX_XML_PATCH_APPLICATION_VERSION, FOLIO_DOCX_XML_PATCH_PROPOSAL_DEFAULTS, FOLIO_DOCX_XML_PATCH_PROPOSAL_ISSUE_CODES, FOLIO_DOCX_XML_PATCH_PROPOSAL_PROFILE, FOLIO_DOCX_XML_PATCH_PROPOSAL_VERSION, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, FOLIO_YJS_DOCX_MATERIALIZATION_ERROR_CODES, FOLIO_YJS_PROSEMIRROR_FRAGMENT_NAME, FOLIO_YJS_UPDATE_MAX_BYTES, FolioDocumentPrivacyArchiveError, FolioDocumentStoryNotFoundError, FolioDocxPackageInspectionError, FolioDocxReviewer, FolioDocxXmlPatchApplicationError, FolioYjsDocxMaterializationError, HEADING_LEVELS, InvalidBilingualDocumentOptionsError, InvalidFolioDocumentOperationBatchError, InvalidFolioDocumentPrivacyOptionsError, InvalidFolioDocxXmlPatchProposalError, InvalidFolioDocxXmlPatchProposalOptionsError, InvalidFolioReportBuilderOptionsError, InvalidFolioVersionComparisonOptionsError, InvalidGenerateRedlineDocxOptionsError, STELLA_STYLE_SET_NAME, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioDocxXmlPatchApplicationProfileError, UnsupportedFolioReviewedViewError, applyDocxXmlPatchProposal, applyFolioAIEditsToBuffer, applyFolioVersionDiffPrivacy, assertSupportedFolioDocumentOperationVersion, bookmark, compareDocxVersions, createBilingualDocument, createBilingualDocx, createDocx, createEmptyDocument, createFolioAITextRangeHandle, createStellaStyleDocumentPreset, createStellaStyleSet, createTableOfContentsField, deriveBlockId, docxToMarkdown, endnote, ensureParaIds, evaluateDocxXmlPatchProposal, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractDocxText, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, hashFolioAIBlockText, heading, hyperlink, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxPackage, isFolioBlockId, isFolioDocumentOperationModeSupported, isFolioDocumentPrivacyTransform, isFolioResolvedReviewedView, isFolioReviewedView, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, materializeYjsDocx, normalizeFolioAIBlockText, pageBreak, paragraph, parseDocx, parseFolioDocumentOperationBatch, parseFolioDocxXmlPatchProposal, readBilingualDocument, readBilingualDocx, readFolioDocumentSection, replyToComment, rewriteDocxMetadataPrivacy, run, table, validateDocxConformance };
+export { BILINGUAL_TABLE_LAYOUTS, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DocxArchiveError, EnsureParaIdsError, FOLIO_DOCUMENT_METADATA_PROPERTIES, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_BATCH_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_KEYS_BY_TYPE, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_DOCUMENT_PRIVACY_TRANSFORMS, FOLIO_DOCX_CONFORMANCE_CHECKS, FOLIO_DOCX_CONFORMANCE_ISSUE_CODES, FOLIO_DOCX_CONFORMANCE_PROFILE, FOLIO_DOCX_CONFORMANCE_REPORT_VERSION, FOLIO_DOCX_PACKAGE_INSPECTION_DEFAULTS, FOLIO_DOCX_PACKAGE_INSPECTION_ERROR_CODES, FOLIO_DOCX_PACKAGE_INSPECTION_VERSION, FOLIO_DOCX_XML_PATCH_APPLICATION_PROFILE, FOLIO_DOCX_XML_PATCH_APPLICATION_VERSION, FOLIO_DOCX_XML_PATCH_PROPOSAL_DEFAULTS, FOLIO_DOCX_XML_PATCH_PROPOSAL_ISSUE_CODES, FOLIO_DOCX_XML_PATCH_PROPOSAL_PROFILE, FOLIO_DOCX_XML_PATCH_PROPOSAL_VERSION, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FOLIO_VERSION_COMPARISON_PRIVACY_TRANSFORMS, FOLIO_VERSION_COMPARISON_SCOPES, FOLIO_YJS_DOCX_MATERIALIZATION_ERROR_CODES, FOLIO_YJS_PROSEMIRROR_FRAGMENT_NAME, FOLIO_YJS_UPDATE_MAX_BYTES, FolioDocumentPrivacyArchiveError, FolioDocumentStoryNotFoundError, FolioDocxPackageInspectionError, FolioDocxReviewer, FolioDocxXmlPatchApplicationError, FolioYjsDocxMaterializationError, HEADING_LEVELS, InvalidBilingualDocumentOptionsError, InvalidFolioDocumentOperationBatchError, InvalidFolioDocumentPrivacyOptionsError, InvalidFolioDocxXmlPatchProposalError, InvalidFolioDocxXmlPatchProposalOptionsError, InvalidFolioReportBuilderOptionsError, InvalidFolioVersionComparisonOptionsError, InvalidGenerateRedlineDocxOptionsError, STELLA_STYLE_SET_NAME, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioDocxXmlPatchApplicationProfileError, UnsupportedFolioReviewedViewError, applyDocxXmlPatchProposal, applyFolioAIEditsToBuffer, applyFolioVersionDiffPrivacy, assertSupportedFolioDocumentOperationVersion, bookmark, compareDocxVersions, createBilingualDocument, createBilingualDocx, createDocx, createEmptyDocument, createFolioAITextRangeHandle, createStellaStyleDocumentPreset, createStellaStyleSet, createTableOfContentsField, deriveBlockId, docxToMarkdown, endnote, ensureParaIds, evaluateDocxXmlPatchProposal, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractDocxText, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, hashFolioAIBlockText, heading, hyperlink, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxPackage, isFolioAIContentBlock, isFolioBlockId, isFolioDocumentOperationModeSupported, isFolioDocumentPrivacyTransform, isFolioResolvedReviewedView, isFolioReviewedView, isFolioVersionComparisonPrivacyTransform, isFolioVersionComparisonScope, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, materializeYjsDocx, normalizeFolioAIBlockText, pageBreak, paragraph, parseDocx, parseFolioDocumentOperationBatch, parseFolioDocxXmlPatchProposal, readBilingualDocument, readBilingualDocx, readFolioDocumentSection, replyToComment, rewriteDocxMetadataPrivacy, run, table, validateDocxConformance };

package/dist/shaping/placeRun.d.ts

@@ -0,0 +1,51 @@
+import { Shaper, ShapingDirection } from "./shaper.js";
+//#region src/shaping/placeRun.d.ts
+/**
+ * One glyph, placed. Advances and offsets are in CSS pixels at the run's size;
+ * the glyph id belongs to the face that was shaped, not to any subset of it.
+ */
+type PlacedGlyph = {
+  readonly glyphId: number;
+  /**
+   * Index into the run's code points of the cluster this glyph belongs to.
+   * Several glyphs share it when a cluster shapes to more than one glyph, and
+   * one glyph carries it for every code point of a ligature.
+   */
+  readonly clusterIndex: number;
+  readonly xAdvancePx: number;
+  readonly xOffsetPx: number;
+  readonly yOffsetPx: number;
+};
+type PlaceRunOptions = {
+  readonly shaper: Shaper;
+  /** sfnt bytes of the binary that covers this text. */
+  readonly font: Uint8Array;
+  readonly text: string;
+  readonly fontSizePx: number;
+  /** Omitted means: from the text's own script. */
+  readonly direction?: ShapingDirection;
+};
+/** Whether a run's glyphs can be chosen from its code points alone. */
+declare const needsShaping: (text: string) => boolean;
+declare const directionOf: (text: string) => ShapingDirection;
+/**
+ * Shape and place one run against one binary.
+ *
+ * The text must be served by the face's bytes throughout: a run split across
+ * subsets of a family is placed one segment at a time, because a glyph id only
+ * means anything in the binary it came from.
+ */
+declare const placeRun: ({ shaper, font, text, fontSizePx, direction }: PlaceRunOptions) => readonly PlacedGlyph[];
+/**
+ * The run's advance spread over its code points, one number each.
+ *
+ * A cluster's whole advance sits on the first code point that produced it and
+ * the rest carry zero. Shaping is what decides how many glyphs a cluster
+ * becomes, so there is no per-code-point advance to report: two code points
+ * that ligated into one glyph have one width between them, and splitting it
+ * would invent a boundary the font does not have. The sum is exact, which is
+ * what line breaking and every caller downstream reads.
+ */
+declare const advancesPerCodePointPx: (glyphs: readonly PlacedGlyph[], codePointCount: number) => readonly number[];
+//#endregion
+export { PlaceRunOptions, PlacedGlyph, advancesPerCodePointPx, directionOf, needsShaping, placeRun };

package/dist/shaping/placeRun.js

@@ -0,0 +1,84 @@
+import { hasComplexScript, hasRightToLeft } from "../utils/scriptSegments.js";
+import { SHAPING_DIRECTION } from "./shaper.js";
+//#region src/shaping/placeRun.ts
+/**
+* Placement: shaped glyphs in the units the rest of folio works in.
+*
+* The shaper answers in font design units and byte offsets. Both consumers want
+* the same answer in CSS pixels and code-point indices, and they must want it
+* from the same code: a measurer that scaled one way and a painter that scaled
+* another would lay out and paint two different pages.
+*/
+/** Whether a run's glyphs can be chosen from its code points alone. */
+const needsShaping = (text) => hasComplexScript(text);
+const directionOf = (text) => hasRightToLeft(text) ? SHAPING_DIRECTION.rightToLeft : SHAPING_DIRECTION.leftToRight;
+/**
+* Code-point index for each UTF-8 byte offset the shaper can report as a
+* cluster. Only cluster starts are ever looked up, so offsets inside a
+* character are left absent rather than filled in with a neighbour's index.
+*/
+const codePointIndexByByteOffset = (text) => {
+	const byOffset = /* @__PURE__ */ new Map();
+	let offset = 0;
+	let index = 0;
+	for (const character of text) {
+		byOffset.set(offset, index);
+		const codePoint = character.codePointAt(0);
+		offset += utf8Length(codePoint);
+		index += 1;
+	}
+	return byOffset;
+};
+const UTF8_TWO_BYTE_MINIMUM = 128;
+const UTF8_THREE_BYTE_MINIMUM = 2048;
+const UTF8_FOUR_BYTE_MINIMUM = 65536;
+const utf8Length = (codePoint) => {
+	if (codePoint < UTF8_TWO_BYTE_MINIMUM) return 1;
+	if (codePoint < UTF8_THREE_BYTE_MINIMUM) return 2;
+	return codePoint < UTF8_FOUR_BYTE_MINIMUM ? 3 : 4;
+};
+/**
+* Shape and place one run against one binary.
+*
+* The text must be served by the face's bytes throughout: a run split across
+* subsets of a family is placed one segment at a time, because a glyph id only
+* means anything in the binary it came from.
+*/
+const placeRun = ({ shaper, font, text, fontSizePx, direction }) => {
+	const shaped = shaper.shapeRun({
+		font,
+		text,
+		direction: direction ?? directionOf(text)
+	});
+	if (shaped.unitsPerEm <= 0) return [];
+	const scale = fontSizePx / shaped.unitsPerEm;
+	const indexByOffset = codePointIndexByByteOffset(text);
+	return shaped.glyphs.map(({ glyphId, cluster, xAdvance, xOffset, yOffset }) => ({
+		glyphId,
+		clusterIndex: indexByOffset.get(cluster) ?? 0,
+		xAdvancePx: xAdvance * scale,
+		xOffsetPx: xOffset * scale,
+		yOffsetPx: yOffset * scale
+	}));
+};
+/**
+* The run's advance spread over its code points, one number each.
+*
+* A cluster's whole advance sits on the first code point that produced it and
+* the rest carry zero. Shaping is what decides how many glyphs a cluster
+* becomes, so there is no per-code-point advance to report: two code points
+* that ligated into one glyph have one width between them, and splitting it
+* would invent a boundary the font does not have. The sum is exact, which is
+* what line breaking and every caller downstream reads.
+*/
+const advancesPerCodePointPx = (glyphs, codePointCount) => {
+	const advances = Array.from({ length: codePointCount }, () => 0);
+	for (const { clusterIndex, xAdvancePx } of glyphs) {
+		const at = Math.min(clusterIndex, codePointCount - 1);
+		if (at < 0) continue;
+		advances[at] = (advances[at] ?? 0) + xAdvancePx;
+	}
+	return advances;
+};
+//#endregion
+export { advancesPerCodePointPx, directionOf, needsShaping, placeRun };

package/dist/shaping/shaper.d.ts

@@ -0,0 +1,92 @@
+//#region src/shaping/shaper.d.ts
+/**
+ * The boundary to the text shaper.
+ *
+ * Shaping is the one part of text layout that cannot be derived from code
+ * points: Arabic letters take their form from their neighbours, lam-alef
+ * ligates, Devanagari reorders and forms conjuncts, Hebrew points hang off the
+ * letter they belong to. One implementation answers that question, in Rust, and
+ * every caller reaches it through this module: a measurement in CSS pixels and
+ * a PDF text matrix scale the same glyph ids and the same advances, so the two
+ * cannot describe different text.
+ *
+ * The artifact is loaded on demand. It carries the OpenType layout engine and
+ * the Unicode data that engine needs, and a document in Latin, Cyrillic or
+ * Greek needs none of it: `getShaper` is called only once a run in a shaping
+ * script is about to be measured or painted, and never before.
+ */
+/** Which way a run advances. Resolved by the producer, never guessed here. */
+declare const SHAPING_DIRECTION: {
+  readonly leftToRight: "ltr";
+  readonly rightToLeft: "rtl";
+};
+type ShapingDirection = (typeof SHAPING_DIRECTION)[keyof typeof SHAPING_DIRECTION];
+type ShapeRunRequest = {
+  /** sfnt bytes of the face to shape with, which must be the face measured. */
+  readonly font: Uint8Array;
+  /** Index within a font collection; 0 for a plain font file. */
+  readonly faceIndex?: number;
+  readonly text: string;
+  readonly direction: ShapingDirection;
+  /** ISO-15924 tag, or omitted to let the shaper detect the script. */
+  readonly script?: string;
+  /** BCP-47 language, or omitted. Selects locale-specific substitutions. */
+  readonly language?: string;
+  /** OpenType features to force on, such as `liga` or `kern`. */
+  readonly featuresOn?: readonly string[];
+  /** Features to force off. */
+  readonly featuresOff?: readonly string[];
+};
+/** One shaped glyph, in the face's design units. */
+type ShapedGlyph = {
+  /** Glyph id in the face that was shaped, not a code point. */
+  readonly glyphId: number;
+  /**
+   * UTF-8 byte offset into the request's text of the character this glyph came
+   * from. A ligature's glyphs share one offset, which is what lets a caller map
+   * a glyph back to text for extraction and for a `/ToUnicode` map.
+   */
+  readonly cluster: number;
+  readonly xAdvance: number;
+  readonly yAdvance: number;
+  readonly xOffset: number;
+  readonly yOffset: number;
+};
+type ShapedRun = {
+  readonly glyphs: readonly ShapedGlyph[];
+  /** Design units per em, so a caller scales without re-reading the face. */
+  readonly unitsPerEm: number;
+};
+type Shaper = {
+  readonly shapeRun: (request: ShapeRunRequest) => ShapedRun;
+};
+declare const ShaperError_base: import("better-result").TaggedErrorClass<"ShaperError">;
+declare class ShaperError extends ShaperError_base<{
+  message: string;
+  cause?: unknown;
+}> {}
+/**
+ * Loads the shaper, once, and hands back the single implementation both the
+ * measurer and the PDF backend use.
+ *
+ * Calling this is what fetches the artifact, so a caller asks for it only after
+ * establishing that some run actually needs shaping.
+ */
+declare const getShaper: () => Promise<Shaper>;
+/**
+ * Whether the artifact has been loaded in this process.
+ *
+ * Exists for the test that a document in a non-shaping script never pays for
+ * it, which is the whole reason this is a separate artifact.
+ */
+declare const shaperLoaded: () => boolean;
+/**
+ * The shaper if it is already loaded, and never a load.
+ *
+ * The measure seam is synchronous: a measurement cannot await an artifact. So
+ * whoever is about to measure text that shapes resolves {@link getShaper}
+ * first, and the measurer reads the result here.
+ */
+declare const resolvedShaper: () => Shaper | null;
+//#endregion
+export { SHAPING_DIRECTION, ShapeRunRequest, ShapedGlyph, ShapedRun, Shaper, ShaperError, ShapingDirection, getShaper, resolvedShaper, shaperLoaded };