@stll/folio-core 0.56.0 → 0.57.0

package/dist/ai-edits/apply.js

@@ -1,6 +1,7 @@
 import { paragraphNumberingReference, paragraphNumberingReferenceId } from "../docx/numberingReference.js";
 import { formattingEquals } from "../docx/runConsolidator.js";
 import { isStyleSourcedParagraphNumbering } from "../internal/paragraphFormattingSerialization.js";
+import { addTrackedDeletionMark } from "../prosemirror/addTrackedDeletionMark.js";
 import { deleteTextBoxesAnchoredAt, droppedTextBoxAnchorIds, endOfParagraphWithItsTextBoxes, gatherTextBoxesAfterParagraph, textBoxAnchorIdOf, textBoxAnchorIdsBetween } from "../prosemirror/anchoredTextBoxes.js";
 import { expectParagraphAttrs, expectRunPropertyChangeMarkAttrs, expectTableRowAttrs } from "../prosemirror/attrs/index.js";
 import { hasSerializableParagraphPropertyChange, paragraphPropertiesSnapshot } from "../prosemirror/commands/propertyChangeScope.js";
@@ -34,7 +35,7 @@ import { removeRowsWithoutCellsAfterBatch } from "../prosemirror/tableGridMutati
 import { isZeroWidthAnchor } from "../prosemirror/zeroWidthAnchors.js";
 import { getFolioParaIdFromBlockId } from "../types/block-id.js";
 import { CANONICAL_GAP } from "../types/canonicalCapabilities.js";
-import { BatchClaims } from "./batch-claims.js";
+import { BatchClaims, compareBatchTieOrder } from "./batch-claims.js";
 import { stripBlockIdentityAttrs } from "./block-identity.js";
 import { describeCharacterSplit } from "./character-boundaries.js";
 import { buildCleanBlockText, resolveCleanTextRange } from "./clean-text.js";
@@ -2417,7 +2418,7 @@ const applyFolioAIEditOperationsInternal = ({ view, snapshot, operations: reques
 			if (leftCellShape.tablePosition !== rightCellShape.tablePosition) return rightCellShape.tablePosition - leftCellShape.tablePosition;
 			if (leftCellShape.rectangle.bottom !== rightCellShape.rectangle.bottom) return rightCellShape.rectangle.bottom - leftCellShape.rectangle.bottom;
 			if (leftCellShape.rectangle.right !== rightCellShape.rectangle.right) return rightCellShape.rectangle.right - leftCellShape.rectangle.right;
-			return right.originalIndex - left.originalIndex;
+			return compareBatchTieOrder(left.originalIndex, right.originalIndex);
 		}
 		const leftColumn = left.tableColumnInsertion ?? left.tableColumnDeletion;
 		const rightColumn = right.tableColumnInsertion ?? right.tableColumnDeletion;
@@ -2428,10 +2429,10 @@ const applyFolioAIEditOperationsInternal = ({ view, snapshot, operations: reques
 			if (leftColumn.columnIndex !== rightColumn.columnIndex) return rightColumn.columnIndex - leftColumn.columnIndex;
 			const leftIsInsertion = left.tableColumnInsertion !== void 0;
 			if (leftIsInsertion !== (right.tableColumnInsertion !== void 0)) return leftIsInsertion ? -1 : 1;
-			return right.originalIndex - left.originalIndex;
+			return compareBatchTieOrder(left.originalIndex, right.originalIndex);
 		}
 		if (left.from !== right.from) return right.from - left.from;
-		return right.originalIndex - left.originalIndex;
+		return compareBatchTieOrder(left.originalIndex, right.originalIndex);
 	});
 	for (let executionIndex = 0; executionIndex < executionOrder.length; executionIndex++) {
 		const item = executionOrder[executionIndex];
@@ -3186,9 +3187,21 @@ const applyFolioAIEditOperationsInternal = ({ view, snapshot, operations: reques
 						...isPairedMove(item.operation.moveId) && { moveKind: "moveFrom" },
 						...trackedRevisionExtras
 					});
-					tr = tr.addMark(item.from, item.to, deletionMark);
+					addTrackedDeletionMark({
+						insertionPolicy: "preserve-pending",
+						tr,
+						from: item.from,
+						to: item.to,
+						mark: deletionMark
+					});
 					const atomRanges = undeletedContentAtomRanges(tr, item.blockFrom);
-					for (const { from, to } of atomRanges) tr = tr.addMark(from, to, deletionMark);
+					for (const { from, to } of atomRanges) addTrackedDeletionMark({
+						insertionPolicy: "preserve-pending",
+						tr,
+						from,
+						to,
+						mark: deletionMark
+					});
 					for (const anchorId of textBoxAnchorIdsBetween(tr.doc, tr.mapping.map(item.blockFrom), tr.mapping.map(item.blockTo))) deletedTextBoxAnchorIds.add(anchorId);
 					encloseWholeControls({
 						tr,
@@ -3481,12 +3494,18 @@ const applyFolioAIEditOperationsInternal = ({ view, snapshot, operations: reques
 					appliedRevisionIds = [revisionIdMark];
 					if (item.to > item.from && deletionType) {
 						const revisionIdSeparator = operationRevisionSeed++;
-						tr = tr.addMark(item.from, item.to, deletionType.create({
-							revisionId: revisionIdSeparator,
-							author,
-							date,
-							...trackedRevisionExtras
-						}));
+						addTrackedDeletionMark({
+							insertionPolicy: "preserve-pending",
+							tr,
+							from: item.from,
+							to: item.to,
+							mark: deletionType.create({
+								revisionId: revisionIdSeparator,
+								author,
+								date,
+								...trackedRevisionExtras
+							})
+						});
 						appliedRevisionIds.push(revisionIdSeparator);
 					}
 					tr = tr.split(item.from);
@@ -3982,7 +4001,13 @@ const applyTextReplacement = ({ tr, item, mode, author, date, revisionIdDelete,
 		if (commentMark) nextTr = nextTr.addMark(inserted.start, inserted.end, commentMark);
 	}
 	if (item.to > item.from && deletionType) {
-		nextTr = nextTr.addMark(item.from, item.to, deletionType.create(delAttrs));
+		addTrackedDeletionMark({
+			insertionPolicy: "preserve-pending",
+			tr: nextTr,
+			from: item.from,
+			to: item.to,
+			mark: deletionType.create(delAttrs)
+		});
 		if (commentMark && replacement.length === 0) nextTr = nextTr.addMark(item.from, item.to, commentMark);
 	}
 	return nextTr;
@@ -4474,7 +4499,13 @@ const applyMinimalTrackedReplacement = ({ tr, item, noteReferences, replacement,
 			removedFrom = first.from;
 			marks = addCarriedMarks(inheritedReplacementMarks(doc, styleSource.from, styleSource.to), surveyReplacedAnnotations(doc, first.from, last.to).carried);
 			for (const piece of change.pieces) {
-				nextTr = nextTr.addMark(piece.from, piece.to, deletion);
+				addTrackedDeletionMark({
+					insertionPolicy: "preserve-pending",
+					tr: nextTr,
+					from: piece.from,
+					to: piece.to,
+					mark: deletion
+				});
 				if (commentMark) nextTr = nextTr.addMark(piece.from, piece.to, commentMark);
 			}
 		}

package/dist/ai-edits/batch-claims.d.ts

@@ -21,6 +21,8 @@
  * Positions are the ones the batch resolved against. A block is keyed by the
  * position before its node.
  */
+/** Equal snapshot coordinates execute in reverse input order. */
+declare const compareBatchTieOrder: (leftIndex: number, rightIndex: number) => number;
 type PositionRange = {
   from: number;
   to: number;
@@ -142,4 +144,4 @@ declare class BatchClaims {
   add(operationId: string, claim: BatchClaim): void;
 }
 //#endregion
-export { BatchClaim, BatchClaims };
+export { BatchClaim, BatchClaims, compareBatchTieOrder };

package/dist/ai-edits/batch-claims.js

@@ -1,4 +1,28 @@
 //#region src/ai-edits/batch-claims.ts
+/**
+* Which operations of one batch may not share their targets.
+*
+* A batch resolves every operation against the document as it was read and
+* applies them from the end of the document backwards, so an operation never
+* moves the positions an earlier-placed one resolved to. That holds only while
+* the operations' targets are disjoint. Two operations on the same stretch of
+* text, or an operation inside a paragraph another one deletes, rewrites,
+* splits or merges away, are applied against coordinates the first one has
+* already invalidated — and the second then edits whatever now sits there,
+* which can be a paragraph neither operation named.
+*
+* Each operation therefore states what it claims before anything is applied,
+* and the later of two operations whose claims conflict is refused
+* (`overlappingOperation`). The caller re-reads the document after the batch
+* and sends the refused operation again against the result. What remains
+* applies exactly as the same operations applied one at a time, from the end
+* of the document backwards, would.
+*
+* Positions are the ones the batch resolved against. A block is keyed by the
+* position before its node.
+*/
+/** Equal snapshot coordinates execute in reverse input order. */
+const compareBatchTieOrder = (leftIndex, rightIndex) => rightIndex - leftIndex;
 const blockRolesOf = (claim) => {
 	switch (claim.type) {
 		case "text":
@@ -272,4 +296,4 @@ var BatchClaims = class {
 	}
 };
 //#endregion
-export { BatchClaims };
+export { BatchClaims, compareBatchTieOrder };

package/dist/ai-edits/table-row-column-mutations.js

@@ -1,3 +1,4 @@
+import { addTrackedDeletionMark } from "../prosemirror/addTrackedDeletionMark.js";
 import { markStructuralChange } from "../prosemirror/extensions/features/ParagraphChangeTrackerExtension.js";
 import { markRowsEmptiedInBatch, reconcileTableGridAfterColumnInsertion, reconcileTableGridAfterColumnRemoval, removeRowsWithoutCells, removeTableRow } from "../prosemirror/tableGridMutation.js";
 import { stripBlockIdentityAttrs } from "./block-identity.js";
@@ -130,7 +131,7 @@ const markTableRowContent = ({ tr, rowPosition, kind, revision }) => {
 		if (!node.isInline) return true;
 		if (node.marks.some(isTrackedChangeMark)) {
 			wholeRowMarkable = false;
-			if (kind === "insertion" || node.marks.some(({ type }) => type.name === "deletion")) return false;
+			if (kind === "insertion") return false;
 		}
 		const from = contentFrom + offset;
 		markable.push({
@@ -140,10 +141,23 @@ const markTableRowContent = ({ tr, rowPosition, kind, revision }) => {
 		return false;
 	});
 	if (wholeRowMarkable) {
-		tr.addMark(contentFrom, rowPosition + row.nodeSize - 1, mark);
+		if (kind === "deletion") addTrackedDeletionMark({
+			insertionPolicy: "preserve-pending",
+			tr,
+			from: contentFrom,
+			to: rowPosition + row.nodeSize - 1,
+			mark
+		});
+		else tr.addMark(contentFrom, rowPosition + row.nodeSize - 1, mark);
 		return;
 	}
-	for (const range of markable) tr.addMark(range.from, range.to, mark);
+	for (const range of markable) if (kind === "deletion") addTrackedDeletionMark({
+		insertionPolicy: "preserve-pending",
+		tr,
+		...range,
+		mark
+	});
+	else tr.addMark(range.from, range.to, mark);
 };
 const isTrackedChangeMark = (mark) => mark.type.name === "insertion" || mark.type.name === "deletion";
 const isRowSpanningCell = (node) => {

package/dist/ai-suggestions/apply.js

@@ -1,6 +1,19 @@
+import { addTrackedDeletionMark } from "../prosemirror/addTrackedDeletionMark.js";
 import { mintRevisionId, seedRevisionIdsFromDoc } from "../prosemirror/plugins/revisionIds.js";
 import { resolveSuggestionAnchor } from "./conflict.js";
 //#region src/ai-suggestions/apply.ts
+/**
+* Apply AI suggestions to the document.
+*
+* Two modes:
+*  - "direct": replace text in place.
+*  - "tracked-changes": insertion + deletion marks, attributed to the
+*    configured author. Reuses the editor's existing tracked-change
+*    schema and resolution commands.
+*
+* Apply is always preceded by anchor resolution; stale suggestions are
+* skipped and reported back to the caller.
+*/
 function applySuggestions(options) {
 	const { view, suggestions, mode, author } = options;
 	const applied = [];
@@ -51,7 +64,13 @@ function applySuggestions(options) {
 				tr.insertText(suggestion.suggestedText, to, to);
 				tr.addMark(to, to + suggestion.suggestedText.length, insertionType.create(attrs));
 			}
-			if (to > from) tr.addMark(from, to, deletionType.create(attrs));
+			if (to > from) addTrackedDeletionMark({
+				insertionPolicy: "preserve-pending",
+				tr,
+				from,
+				to,
+				mark: deletionType.create(attrs)
+			});
 			applied.push(suggestion.id);
 		}
 	}

package/dist/compare/inline-atoms.js

@@ -2,7 +2,9 @@ import { buildCleanBlockText } from "../ai-edits/clean-text.js";
 import { noteReferenceOf } from "../ai-edits/note-references.js";
 import { collectNoteReferenceLabels, sourceDocumentOf } from "../ai-edits/snapshot.js";
 import { drawingXmlWithoutIdentity } from "../docx/drawingIdNormalization.js";
+import { addTrackedDeletionMark } from "../prosemirror/addTrackedDeletionMark.js";
 import { resolveAllChangesInHeadlessStateWithMapping } from "../prosemirror/commands/comments.js";
+import { mintNoteReferenceOccurrenceId } from "../prosemirror/noteReferenceOccurrences.js";
 import { runFormattingInlineAtomResultText } from "../prosemirror/runFormattingInlineCarriers.js";
 import { canonicalJson } from "../utils/canonicalJson.js";
 import { prepareTargetInlineAtom } from "./inline-atom-resources.js";
@@ -618,11 +620,17 @@ const matchInlineAtoms = ({ state, targetSnapshot, revisionStamp, originalRevisi
 			const to = transaction.mapping.map(action.to, -1);
 			if (from >= to) return { status: "unalignable" };
 			if (action.textDisposition === "inserted") transaction.delete(from, to);
-			else transaction.addMark(from, to, deletionType.create({
-				revisionId: nextRevisionId++,
-				author,
-				date: revisionStamp.date
-			}));
+			else addTrackedDeletionMark({
+				insertionPolicy: "preserve-pending",
+				tr: transaction,
+				from,
+				to,
+				mark: deletionType.create({
+					revisionId: nextRevisionId++,
+					author,
+					date: revisionStamp.date
+				})
+			});
 			const at = transaction.mapping.map(action.from, -1);
 			transaction.insert(at, action.node.mark(insertionType.create({
 				revisionId: nextRevisionId++,
@@ -638,7 +646,11 @@ const matchInlineAtoms = ({ state, targetSnapshot, revisionStamp, originalRevisi
 			const written = transaction.doc.nodeAt(from);
 			const noteMark = action.node.marks.find(({ type }) => type.name === "footnoteRef");
 			if (from >= to || !written?.isText || !noteMark) return { status: "unalignable" };
-			transaction.replaceWith(from, to, state.schema.text(action.node.text ?? "", noteMark.addToSet(written.marks)));
+			const restoredNoteMark = noteMark.type.create({
+				...noteMark.attrs,
+				occurrenceId: mintNoteReferenceOccurrenceId()
+			});
+			transaction.replaceWith(from, to, state.schema.text(action.node.text ?? "", restoredNoteMark.addToSet(written.marks)));
 			if (action.targetBlockId) changedTargetBlockIds.add(action.targetBlockId);
 			continue;
 		}
@@ -648,11 +660,17 @@ const matchInlineAtoms = ({ state, targetSnapshot, revisionStamp, originalRevisi
 			const node = transaction.doc.nodeAt(from);
 			if (!node || node.nodeSize !== to - from || node.type.name !== "field") return { status: "unalignable" };
 			if (action.atomDisposition === "inserted") transaction.delete(from, to);
-			else transaction.addMark(from, to, deletionType.create({
-				revisionId: nextRevisionId++,
-				author,
-				date: revisionStamp.date
-			}));
+			else addTrackedDeletionMark({
+				insertionPolicy: "preserve-pending",
+				tr: transaction,
+				from,
+				to,
+				mark: deletionType.create({
+					revisionId: nextRevisionId++,
+					author,
+					date: revisionStamp.date
+				})
+			});
 			const at = transaction.mapping.map(action.from, -1);
 			transaction.insert(at, state.schema.text(action.text, insertionType.create({
 				revisionId: nextRevisionId++,
@@ -675,11 +693,17 @@ const matchInlineAtoms = ({ state, targetSnapshot, revisionStamp, originalRevisi
 			continue;
 		}
 		if (node.marks.some(({ type }) => type === deletionType)) return { status: "unalignable" };
-		transaction.addMark(from, to, deletionType.create({
-			revisionId: nextRevisionId++,
-			author,
-			date: revisionStamp.date
-		}));
+		addTrackedDeletionMark({
+			insertionPolicy: "preserve-pending",
+			tr: transaction,
+			from,
+			to,
+			mark: deletionType.create({
+				revisionId: nextRevisionId++,
+				author,
+				date: revisionStamp.date
+			})
+		});
 		if (action.targetBlockId) changedTargetBlockIds.add(action.targetBlockId);
 	}
 	return {

package/dist/compare/inline-provenance.js

@@ -1,4 +1,5 @@
 import { sourceDocumentOf, styleResolverOf } from "../ai-edits/snapshot.js";
+import { addTrackedDeletionMark } from "../prosemirror/addTrackedDeletionMark.js";
 import { expectHyperlinkMarkAttrs, expectRunPropertyChangeMarkAttrs, expectTableCellAttrs } from "../prosemirror/attrs/index.js";
 import { getDocumentStyleResolver } from "../prosemirror/plugins/documentStyleState.js";
 import { applyMarksToRunFormattingRepresentation, expandRunFormattingCarrier, runFormattingCarrierReviewText } from "../prosemirror/runFormattingInlineCarriers.js";
@@ -252,11 +253,17 @@ const matchInlineProvenance = ({ state, targetSnapshot, revisionStamp, originalR
 					date: revisionStamp.date
 				}).addToSet(marks);
 				const text = state.doc.textBetween(change.live.from, change.live.to);
-				transaction.addMark(change.live.from, change.live.to, deletionType.create({
-					revisionId: nextRevisionId++,
-					author,
-					date: revisionStamp.date
-				}));
+				addTrackedDeletionMark({
+					insertionPolicy: "preserve-pending",
+					tr: transaction,
+					from: change.live.from,
+					to: change.live.to,
+					mark: deletionType.create({
+						revisionId: nextRevisionId++,
+						author,
+						date: revisionStamp.date
+					})
+				});
 				transaction.insert(change.live.to, state.schema.text(text, marks));
 				changedTargetBlockIds.add(change.targetBlockId);
 				continue;

package/dist/compat/eigenpal.d.ts

@@ -17,6 +17,7 @@ import { MAX_COMPARE_OPERATIONS, compareDocx } from "../compare/compare.js";
 import { DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DocumentPreset, DocumentStyleSet } from "../style-sets/types.js";
 import { CreateEmptyDocumentOptions, createEmptyDocument } from "../utils/createDocument.js";
 import { mergeDocumentContent } from "../utils/mergeDocumentContent.js";
+import { DEFAULT_OUTLINE_DEPTH, OutlineDepth, filterHeadingsByDepth } from "../utils/outlineDepth.js";
 import { DocumentStyleCatalog, DocumentStyleCatalogEntry, ExtractDocumentStyleSetOptions, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, inspectDocumentStyles, inspectDocumentStylesFromDocx } from "../style-sets/extract.js";
 import { STELLA_STYLE_SET_NAME, createStellaStyleDocumentPreset, createStellaStyleSet } from "../style-sets/stellaStyle.js";
 import { DocumentPropertiesOptions, createDocx } from "../docx/rezip.js";
@@ -41,4 +42,4 @@ import { FOLIO_YJS_ATTR_SCHEMA_VERSION, FolioYjsAttrSchemaVersion, FolioYjsAttrS
 import { DOCX_CONFORMANCE_CLASSES } from "../index.js";
 type Document = document_d_exports.Document;
 type DocxConformanceClass = document_d_exports.DocxConformanceClass;
-export { type AIBarStatus, type AIChatMode, type AICitation, type AICitationRange, type AICitationSource, type AIGenerateInput, type AISuggestion, type AISuggestionApplyMode, type AISuggestionPreset, type AISuggestionSeverity, type AISuggestionStatus, type AcceptAutocompleteResult, type AnonymizationMatch, type AnonymizationTerm, type ApplyFolioDocumentOperationsOptions, type ApplyResult, type AutocompleteSuggestionPluginOptions, type AutocompleteSuggestionState, type AutocompleteSuggestionStatus, type AutocompleteTriggerCheck, type AutocompleteTriggerOptions, type AutocompleteTriggerSkipReason, type BlockRect, COMPARE_REVISION_FORMATS, COMPARE_UNSUPPORTED_REASONS, COMPARE_VERIFICATION_CAUSES, COMPARE_VERIFICATION_INVARIANTS, type CompareChange, type CompareChangeLocation, type CompareCompatibility, type CompareContentOptions, CompareDocxApplyError, type CompareDocxError, CompareDocxFinalParagraphMarkError, CompareDocxOperationLimitError, type CompareDocxOptions, CompareDocxParseError, CompareDocxRoundTripError, CompareDocxSerializeError, type CompareFolioRequirement, type CompareResult, type CompareRevisionFormat, type CompareUnsupportedPart, type CompareUnsupportedReason, type CompareVerification, type CompareVerificationCause, type CompareVerificationFailure, type CompareVerificationInvariant, type CreateEmptyDocumentOptions, DEFAULT_AI_SUGGESTION_PRESETS, DEFAULT_AUTOCOMPLETE_DEAD_ZONE_NODES, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DOCX_CONFORMANCE_CLASSES, DRAWING_SAFETY_CLASSES, type DeriveBlockIdInput, type DirectiveKind, type DirectiveRange, type Document, type DocumentPreset, type DocumentPropertiesOptions, type DocumentStyleCatalog, type DocumentStyleCatalogEntry, type DocumentStyleSet, type DocxCompatibility, type DocxCompatibilityContext, type DocxCompatibilityIssue, type DocxCompatibilityLocation, type DocxCompatibilityPart, type DocxConformanceClass, type DocxDrawingClassification, type DrawingSafetyClass, type EmbeddedFont, type EmbeddedFontParts, type ExtractDocumentStyleSetOptions, FOLIO_CONTENT_COMPARISON_LIMITS, 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_YJS_ATTR_SCHEMA_VERSION, type FinalParagraphMarkRevision, 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 FolioAIInlineBooleanProperty, type FolioAIInlineFormatting, type FolioAIInlineFormattingPatch, type FolioAIParagraphSpacing, type FolioAISignatureParty, type FolioBlockId, type FolioContentBlock, type FolioContentBlockProperty, type FolioContentComparison, type FolioContentComparisonError, type FolioContentComparisonEvent, type FolioContentComparisonLimit, FolioContentComparisonLimitError, type FolioContentContainerPathEntry, type FolioContentFormatRange, type FolioContentFormattingChange, type FolioContentIdStability, type FolioContentInlineBooleanProperty, type FolioContentInlineComparisonResult, type FolioContentInlineFormatting, type FolioContentInlineFormattingPatch, FolioContentInlinePresentationProjectionError, type FolioContentLineSpacingRule, type FolioContentParagraphAlignment, type FolioContentParagraphFormattingPatch, type FolioContentParagraphKind, type FolioContentParagraphSpacing, type FolioContentRun, type FolioContentSnapshot, type FolioContentStructuralChange, type FolioContentTableLocation, type FolioContentTextSegment, 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 FolioDocxCompatibilityHost, type FolioDocxCompatibilityProfile, type FolioRevisionStamp, type FolioWordDiffOptions, type FolioYjsAttrSchemaVersion, FolioYjsAttrSchemaVersionError, type ImageMeta, type ImageRef, type InspectDocxCompatibilityOptions, InvalidCompareDocxOptionsError, InvalidFolioContentComparisonError, InvalidFolioDocumentOperationBatchError, MAX_COMPARE_OPERATIONS, type MarkdownOptions, type MarkdownResult, type PositionalText, type ResolvedAnchor, STELLA_STYLE_SET_NAME, type TemplatePreviewHiddenRange, type TemplatePreviewSpan, type TemplatePreviewValue, type TemplatePreviewValues, type TemplateSlashMenuKeyAction, type TemplateSlashMenuState, UnsupportedFolioDocumentOperationVersionError, WORD_DIFF_GRANULARITIES, type WordDiffGranularity, type WordDiffNormalization, type WordDiffOptions, type WordDiffSegment, acceptAutocompleteSuggestion, acceptAutocompleteWord, anonymizationDecorationsKey, appendAutocompleteToken, applyFolioAIEditOperations, applyFolioDocumentOperations, applySuggestions, assertSupportedFolioDocumentOperationVersion, autocompleteSuggestionKey, autocompleteSuggestionPlugin, buildEmbeddedFontFamilyMap, buildPositionalText, clearAutocompleteSuggestion, clearTemplateSlashMenu, compareContent, compareDocx, consumeTemplateSlashQuery, createAICitationDecorationsPlugin, createDocx, createEmptyDocument, createFolioAIEditSnapshot, createStellaStyleDocumentPreset, createStellaStyleSet, currentFolioBlockId, deriveBlockId, diffWordSegments, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractEmbeddedFonts, finishAutocompleteSuggestion, fromMarkdown, getAnonymizationMatches, getAutocompleteSuggestion, getEmbeddedFontFaces, getFolioCaretViewportRect, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioParaIdFromBlockId, getFolioSelectionViewportRect, getGoogleFontsEnabled, getTemplateDirectives, getTemplateSlashMenu, hashFolioAIBlockText, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxCompatibility, isFolioAIContentBlock, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSuggestionStale, isSupportedFolioDocumentOperationVersion, mergeDocumentContent, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, resetTemplateSlashQuery, resolveSuggestionAnchor, scanDirectives, scopeEmbeddedFontFamily, scrollFolioPositionIntoView, setAICitationsMeta, setAISuggestionsMeta, setActiveCitationMeta, setAnonymizationTermsMeta, setEmbeddedFontFamilyMap, setFocusedSuggestionMeta, setGoogleFontsEnabled, setTemplatePreviewValues, shouldTriggerAutocomplete, startAutocompleteSuggestion, templateSlashMenuKey, toMarkdown, toMarkdownResult };
+export { type AIBarStatus, type AIChatMode, type AICitation, type AICitationRange, type AICitationSource, type AIGenerateInput, type AISuggestion, type AISuggestionApplyMode, type AISuggestionPreset, type AISuggestionSeverity, type AISuggestionStatus, type AcceptAutocompleteResult, type AnonymizationMatch, type AnonymizationTerm, type ApplyFolioDocumentOperationsOptions, type ApplyResult, type AutocompleteSuggestionPluginOptions, type AutocompleteSuggestionState, type AutocompleteSuggestionStatus, type AutocompleteTriggerCheck, type AutocompleteTriggerOptions, type AutocompleteTriggerSkipReason, type BlockRect, COMPARE_REVISION_FORMATS, COMPARE_UNSUPPORTED_REASONS, COMPARE_VERIFICATION_CAUSES, COMPARE_VERIFICATION_INVARIANTS, type CompareChange, type CompareChangeLocation, type CompareCompatibility, type CompareContentOptions, CompareDocxApplyError, type CompareDocxError, CompareDocxFinalParagraphMarkError, CompareDocxOperationLimitError, type CompareDocxOptions, CompareDocxParseError, CompareDocxRoundTripError, CompareDocxSerializeError, type CompareFolioRequirement, type CompareResult, type CompareRevisionFormat, type CompareUnsupportedPart, type CompareUnsupportedReason, type CompareVerification, type CompareVerificationCause, type CompareVerificationFailure, type CompareVerificationInvariant, type CreateEmptyDocumentOptions, DEFAULT_AI_SUGGESTION_PRESETS, DEFAULT_AUTOCOMPLETE_DEAD_ZONE_NODES, DEFAULT_OUTLINE_DEPTH, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DOCX_CONFORMANCE_CLASSES, DRAWING_SAFETY_CLASSES, type DeriveBlockIdInput, type DirectiveKind, type DirectiveRange, type Document, type DocumentPreset, type DocumentPropertiesOptions, type DocumentStyleCatalog, type DocumentStyleCatalogEntry, type DocumentStyleSet, type DocxCompatibility, type DocxCompatibilityContext, type DocxCompatibilityIssue, type DocxCompatibilityLocation, type DocxCompatibilityPart, type DocxConformanceClass, type DocxDrawingClassification, type DrawingSafetyClass, type EmbeddedFont, type EmbeddedFontParts, type ExtractDocumentStyleSetOptions, FOLIO_CONTENT_COMPARISON_LIMITS, 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_YJS_ATTR_SCHEMA_VERSION, type FinalParagraphMarkRevision, 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 FolioAIInlineBooleanProperty, type FolioAIInlineFormatting, type FolioAIInlineFormattingPatch, type FolioAIParagraphSpacing, type FolioAISignatureParty, type FolioBlockId, type FolioContentBlock, type FolioContentBlockProperty, type FolioContentComparison, type FolioContentComparisonError, type FolioContentComparisonEvent, type FolioContentComparisonLimit, FolioContentComparisonLimitError, type FolioContentContainerPathEntry, type FolioContentFormatRange, type FolioContentFormattingChange, type FolioContentIdStability, type FolioContentInlineBooleanProperty, type FolioContentInlineComparisonResult, type FolioContentInlineFormatting, type FolioContentInlineFormattingPatch, FolioContentInlinePresentationProjectionError, type FolioContentLineSpacingRule, type FolioContentParagraphAlignment, type FolioContentParagraphFormattingPatch, type FolioContentParagraphKind, type FolioContentParagraphSpacing, type FolioContentRun, type FolioContentSnapshot, type FolioContentStructuralChange, type FolioContentTableLocation, type FolioContentTextSegment, 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 FolioDocxCompatibilityHost, type FolioDocxCompatibilityProfile, type FolioRevisionStamp, type FolioWordDiffOptions, type FolioYjsAttrSchemaVersion, FolioYjsAttrSchemaVersionError, type ImageMeta, type ImageRef, type InspectDocxCompatibilityOptions, InvalidCompareDocxOptionsError, InvalidFolioContentComparisonError, InvalidFolioDocumentOperationBatchError, MAX_COMPARE_OPERATIONS, type MarkdownOptions, type MarkdownResult, type OutlineDepth, type PositionalText, type ResolvedAnchor, STELLA_STYLE_SET_NAME, type TemplatePreviewHiddenRange, type TemplatePreviewSpan, type TemplatePreviewValue, type TemplatePreviewValues, type TemplateSlashMenuKeyAction, type TemplateSlashMenuState, UnsupportedFolioDocumentOperationVersionError, WORD_DIFF_GRANULARITIES, type WordDiffGranularity, type WordDiffNormalization, type WordDiffOptions, type WordDiffSegment, acceptAutocompleteSuggestion, acceptAutocompleteWord, anonymizationDecorationsKey, appendAutocompleteToken, applyFolioAIEditOperations, applyFolioDocumentOperations, applySuggestions, assertSupportedFolioDocumentOperationVersion, autocompleteSuggestionKey, autocompleteSuggestionPlugin, buildEmbeddedFontFamilyMap, buildPositionalText, clearAutocompleteSuggestion, clearTemplateSlashMenu, compareContent, compareDocx, consumeTemplateSlashQuery, createAICitationDecorationsPlugin, createDocx, createEmptyDocument, createFolioAIEditSnapshot, createStellaStyleDocumentPreset, createStellaStyleSet, currentFolioBlockId, deriveBlockId, diffWordSegments, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractEmbeddedFonts, filterHeadingsByDepth, finishAutocompleteSuggestion, fromMarkdown, getAnonymizationMatches, getAutocompleteSuggestion, getEmbeddedFontFaces, getFolioCaretViewportRect, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioParaIdFromBlockId, getFolioSelectionViewportRect, getGoogleFontsEnabled, getTemplateDirectives, getTemplateSlashMenu, hashFolioAIBlockText, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxCompatibility, isFolioAIContentBlock, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSuggestionStale, isSupportedFolioDocumentOperationVersion, mergeDocumentContent, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, resetTemplateSlashQuery, resolveSuggestionAnchor, scanDirectives, scopeEmbeddedFontFamily, scrollFolioPositionIntoView, setAICitationsMeta, setAISuggestionsMeta, setActiveCitationMeta, setAnonymizationTermsMeta, setEmbeddedFontFamilyMap, setFocusedSuggestionMeta, setGoogleFontsEnabled, setTemplatePreviewValues, shouldTriggerAutocomplete, startAutocompleteSuggestion, templateSlashMenuKey, toMarkdown, toMarkdownResult };

package/dist/compat/eigenpal.js

@@ -34,4 +34,5 @@ import { currentFolioBlockId, deriveBlockId, getFolioParaIdFromBlockId, isFolioB
 import { createEmptyDocument } from "../utils/createDocument.js";
 import { getGoogleFontsEnabled, setEmbeddedFontFamilyMap, setGoogleFontsEnabled } from "../utils/fontResolver.js";
 import { mergeDocumentContent } from "../utils/mergeDocumentContent.js";
-export { COMPARE_REVISION_FORMATS, COMPARE_UNSUPPORTED_REASONS, COMPARE_VERIFICATION_CAUSES, COMPARE_VERIFICATION_INVARIANTS, CompareDocxApplyError, CompareDocxFinalParagraphMarkError, CompareDocxOperationLimitError, CompareDocxParseError, CompareDocxRoundTripError, CompareDocxSerializeError, DEFAULT_AI_SUGGESTION_PRESETS, DEFAULT_AUTOCOMPLETE_DEAD_ZONE_NODES, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DOCX_CONFORMANCE_CLASSES, DRAWING_SAFETY_CLASSES, FOLIO_CONTENT_COMPARISON_LIMITS, 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_YJS_ATTR_SCHEMA_VERSION, FolioContentComparisonLimitError, FolioContentInlinePresentationProjectionError, FolioYjsAttrSchemaVersionError, InvalidCompareDocxOptionsError, InvalidFolioContentComparisonError, InvalidFolioDocumentOperationBatchError, MAX_COMPARE_OPERATIONS, STELLA_STYLE_SET_NAME, UnsupportedFolioDocumentOperationVersionError, WORD_DIFF_GRANULARITIES, acceptAutocompleteSuggestion, acceptAutocompleteWord, anonymizationDecorationsKey, appendAutocompleteToken, applyFolioAIEditOperations, applyFolioDocumentOperations, applySuggestions, assertSupportedFolioDocumentOperationVersion, autocompleteSuggestionKey, autocompleteSuggestionPlugin, buildEmbeddedFontFamilyMap, buildPositionalText, clearAutocompleteSuggestion, clearTemplateSlashMenu, compareContent, compareDocx, consumeTemplateSlashQuery, createAICitationDecorationsPlugin, createDocx, createEmptyDocument, createFolioAIEditSnapshot, createStellaStyleDocumentPreset, createStellaStyleSet, currentFolioBlockId, deriveBlockId, diffWordSegments, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractEmbeddedFonts, finishAutocompleteSuggestion, fromMarkdown, getAnonymizationMatches, getAutocompleteSuggestion, getEmbeddedFontFaces, getFolioCaretViewportRect, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioParaIdFromBlockId, getFolioSelectionViewportRect, getGoogleFontsEnabled, getTemplateDirectives, getTemplateSlashMenu, hashFolioAIBlockText, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxCompatibility, isFolioAIContentBlock, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSuggestionStale, isSupportedFolioDocumentOperationVersion, mergeDocumentContent, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, resetTemplateSlashQuery, resolveSuggestionAnchor, scanDirectives, scopeEmbeddedFontFamily, scrollFolioPositionIntoView, setAICitationsMeta, setAISuggestionsMeta, setActiveCitationMeta, setAnonymizationTermsMeta, setEmbeddedFontFamilyMap, setFocusedSuggestionMeta, setGoogleFontsEnabled, setTemplatePreviewValues, shouldTriggerAutocomplete, startAutocompleteSuggestion, templateSlashMenuKey, toMarkdown, toMarkdownResult };
+import { DEFAULT_OUTLINE_DEPTH, filterHeadingsByDepth } from "../utils/outlineDepth.js";
+export { COMPARE_REVISION_FORMATS, COMPARE_UNSUPPORTED_REASONS, COMPARE_VERIFICATION_CAUSES, COMPARE_VERIFICATION_INVARIANTS, CompareDocxApplyError, CompareDocxFinalParagraphMarkError, CompareDocxOperationLimitError, CompareDocxParseError, CompareDocxRoundTripError, CompareDocxSerializeError, DEFAULT_AI_SUGGESTION_PRESETS, DEFAULT_AUTOCOMPLETE_DEAD_ZONE_NODES, DEFAULT_OUTLINE_DEPTH, DOCUMENT_PRESET_VERSION, DOCUMENT_STYLE_SET_VERSION, DOCX_CONFORMANCE_CLASSES, DRAWING_SAFETY_CLASSES, FOLIO_CONTENT_COMPARISON_LIMITS, 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_YJS_ATTR_SCHEMA_VERSION, FolioContentComparisonLimitError, FolioContentInlinePresentationProjectionError, FolioYjsAttrSchemaVersionError, InvalidCompareDocxOptionsError, InvalidFolioContentComparisonError, InvalidFolioDocumentOperationBatchError, MAX_COMPARE_OPERATIONS, STELLA_STYLE_SET_NAME, UnsupportedFolioDocumentOperationVersionError, WORD_DIFF_GRANULARITIES, acceptAutocompleteSuggestion, acceptAutocompleteWord, anonymizationDecorationsKey, appendAutocompleteToken, applyFolioAIEditOperations, applyFolioDocumentOperations, applySuggestions, assertSupportedFolioDocumentOperationVersion, autocompleteSuggestionKey, autocompleteSuggestionPlugin, buildEmbeddedFontFamilyMap, buildPositionalText, clearAutocompleteSuggestion, clearTemplateSlashMenu, compareContent, compareDocx, consumeTemplateSlashQuery, createAICitationDecorationsPlugin, createDocx, createEmptyDocument, createFolioAIEditSnapshot, createStellaStyleDocumentPreset, createStellaStyleSet, currentFolioBlockId, deriveBlockId, diffWordSegments, extractDocumentStyleSet, extractDocumentStyleSetFromDocx, extractEmbeddedFonts, filterHeadingsByDepth, finishAutocompleteSuggestion, fromMarkdown, getAnonymizationMatches, getAutocompleteSuggestion, getEmbeddedFontFaces, getFolioCaretViewportRect, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioParaIdFromBlockId, getFolioSelectionViewportRect, getGoogleFontsEnabled, getTemplateDirectives, getTemplateSlashMenu, hashFolioAIBlockText, inspectDocumentStyles, inspectDocumentStylesFromDocx, inspectDocxCompatibility, isFolioAIContentBlock, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSuggestionStale, isSupportedFolioDocumentOperationVersion, mergeDocumentContent, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, resetTemplateSlashQuery, resolveSuggestionAnchor, scanDirectives, scopeEmbeddedFontFamily, scrollFolioPositionIntoView, setAICitationsMeta, setAISuggestionsMeta, setActiveCitationMeta, setAnonymizationTermsMeta, setEmbeddedFontFamilyMap, setFocusedSuggestionMeta, setGoogleFontsEnabled, setTemplatePreviewValues, shouldTriggerAutocomplete, startAutocompleteSuggestion, templateSlashMenuKey, toMarkdown, toMarkdownResult };

package/dist/controller/canonicalClipboard.js

@@ -1,4 +1,5 @@
 import { createNumberingIdAllocator } from "../docx/numberingIds.js";
+import { copyParagraphIndentationProjection } from "../docx/paragraphPropertySource.js";
 import { visitInlineContentSlots, visitParagraphRuns } from "../docx/paragraphTraversal.js";
 import { captureVerbatimXml } from "../docx/verbatimCapture.js";
 import { OFFICE_RELATIONSHIP_NAMESPACE_URIS, OOXML_NAMESPACE_SCOPE, findAttributeByNamespaceUri, getLocalName, parseXml } from "../docx/xmlParser.js";
@@ -203,7 +204,12 @@ const prepareCanonicalPaste = ({ session, state, slice, plain = false, moveTarge
 	const paragraphs = [];
 	for (const block of converted.value) {
 		if (block.type !== "paragraph") return refuse("The clipboard contains an unsupported block.");
-		paragraphs.push(structuredClone(block));
+		const paragraph = structuredClone(block);
+		copyParagraphIndentationProjection({
+			target: paragraph,
+			source: block
+		});
+		paragraphs.push(paragraph);
 	}
 	if (moveTarget === void 0 && (plain || sourceDocument === void 0)) flattenClipboardStyleReferences(paragraphs);
 	const from = session.projection.addressAt(pasteTarget ?? moveSource?.from ?? state.selection.from);

package/dist/controller/canonicalComments.d.ts

@@ -0,0 +1,41 @@
+import { document_d_exports } from "../types/document.js";
+import { CANONICAL_GAP } from "../types/canonicalCapabilities.js";
+import { Comment } from "../types/content.js";
+import { CreateCommentOp, DocumentOp } from "@stll/docx-core/ops";
+//#region src/controller/canonicalComments.d.ts
+declare const CanonicalCommentError_base: import("better-result").TaggedErrorClass<"CanonicalCommentError">;
+declare class CanonicalCommentError extends CanonicalCommentError_base<{
+  message: string;
+  gap: typeof CANONICAL_GAP.comments;
+}> {}
+type CanonicalCommentCommand = {
+  type: "create";
+  comment: CreateCommentOp["comment"];
+  anchor: CreateCommentOp["anchor"];
+} | {
+  type: "update";
+  id: number;
+  content: Comment["content"];
+} | {
+  type: "resolve";
+  id: number;
+  status: "open" | "resolved";
+} | {
+  type: "delete";
+  id: number;
+} | {
+  type: "replace";
+  comments: readonly Comment[];
+};
+type CompileCanonicalCommentsOptions = {
+  document: document_d_exports.Document;
+  command: CanonicalCommentCommand;
+};
+declare const compileCanonicalComments: ({ document, command }: CompileCanonicalCommentsOptions) => import("better-result").Err<never, CanonicalCommentError> | import("better-result").Ok<{
+  ops: DocumentOp[];
+  document: document_d_exports.Document;
+  commentId: number | undefined;
+}, never>;
+declare const canonicalCommentBody: (document: document_d_exports.Document, text: string) => Comment["content"];
+//#endregion
+export { CanonicalCommentCommand, CanonicalCommentError, canonicalCommentBody, compileCanonicalComments };

package/dist/controller/canonicalComments.js

@@ -0,0 +1,152 @@
+import { CANONICAL_GAP } from "../types/canonicalCapabilities.js";
+import { canonicalJson } from "../utils/canonicalJson.js";
+import { Result, TaggedError } from "better-result";
+import { DOCUMENT_OP_TYPES, allocateCommentAnchorIds, applyDocumentOps, packageParagraphIds } from "@stll/docx-core/ops";
+//#region src/controller/canonicalComments.ts
+/** The one semantic compiler for canonical sidebar, controlled and public comments. */
+var CanonicalCommentError = class extends TaggedError("CanonicalCommentError") {};
+const refuse = (message) => Result.err(new CanonicalCommentError({
+	message,
+	gap: CANONICAL_GAP.comments
+}));
+const compileCanonicalComments = ({ document, command }) => {
+	const current = document.package.document.comments ?? [];
+	const byId = new Map(current.map((comment) => [comment.id, comment]));
+	const ops = [];
+	let commentId;
+	switch (command.type) {
+		case "create":
+			ops.push({
+				type: DOCUMENT_OP_TYPES.CREATE_COMMENT,
+				comment: command.comment,
+				anchor: command.anchor
+			});
+			commentId = command.comment.id;
+			break;
+		case "update":
+			ops.push({
+				type: DOCUMENT_OP_TYPES.UPDATE_COMMENT_CONTENT,
+				id: command.id,
+				content: command.content
+			});
+			break;
+		case "resolve":
+			ops.push({
+				type: DOCUMENT_OP_TYPES.SET_COMMENT_RESOLUTION,
+				id: command.id,
+				status: command.status
+			});
+			break;
+		case "delete": {
+			const comment = byId.get(command.id);
+			if (!comment) return refuse("The comment no longer exists.");
+			ops.push({
+				type: DOCUMENT_OP_TYPES.DELETE_COMMENT,
+				id: command.id,
+				scope: comment.parentId !== void 0 && byId.has(comment.parentId) ? "reply" : "thread"
+			});
+			break;
+		}
+		case "replace": {
+			const nextById = new Map(command.comments.map((comment) => [comment.id, comment]));
+			if (nextById.size !== command.comments.length) return refuse("Comment ids must be unique.");
+			for (const comment of current) {
+				if (nextById.has(comment.id) && comment.parentId !== void 0 && byId.has(comment.parentId) && !nextById.has(comment.parentId)) return refuse("A retained reply requires its parent thread.");
+				if (nextById.has(comment.id)) continue;
+				if (comment.parentId !== void 0 && !nextById.has(comment.parentId) && byId.has(comment.parentId)) continue;
+				ops.push({
+					type: DOCUMENT_OP_TYPES.DELETE_COMMENT,
+					id: comment.id,
+					scope: comment.parentId !== void 0 && byId.has(comment.parentId) ? "reply" : "thread"
+				});
+			}
+			const pending = command.comments.filter((comment) => !byId.has(comment.id));
+			const available = new Set(current.filter((comment) => nextById.has(comment.id)).map((comment) => comment.id));
+			while (pending.length > 0) {
+				const index = pending.findIndex((comment) => comment.parentId !== void 0 && available.has(comment.parentId));
+				if (index < 0) return refuse("New controlled comments require an existing anchored parent without cycles.");
+				const next = pending.splice(index, 1).at(0);
+				if (next === void 0 || next.parentId === void 0) return refuse("The controlled reply is missing its parent.");
+				const { parentId, ...comment } = next;
+				ops.push({
+					type: DOCUMENT_OP_TYPES.CREATE_COMMENT,
+					comment,
+					anchor: {
+						kind: "reply",
+						parentId
+					}
+				});
+				available.add(next.id);
+			}
+			for (const next of command.comments) {
+				const previous = byId.get(next.id);
+				if (!previous) continue;
+				const { content: priorContent, done: priorDone, author: priorAuthor, initials: priorInitials, date: priorDate, ...priorMetadata } = previous;
+				const { content: nextContent, done: nextDone, author: nextAuthor, initials: nextInitials, date: nextDate, ...nextMetadata } = next;
+				if (canonicalJson(priorMetadata) !== canonicalJson(nextMetadata)) return refuse("Controlled comment identity and opaque metadata cannot be replaced.");
+				const patch = {
+					...priorAuthor === nextAuthor ? {} : { author: nextAuthor },
+					...priorInitials === nextInitials ? {} : { initials: Object.hasOwn(next, "initials") ? nextInitials : null },
+					...priorDate === nextDate ? {} : { date: Object.hasOwn(next, "date") ? nextDate : null }
+				};
+				if (canonicalJson(priorContent) !== canonicalJson(nextContent) || Object.keys(patch).length > 0) ops.push({
+					type: DOCUMENT_OP_TYPES.UPDATE_COMMENT_CONTENT,
+					id: next.id,
+					content: nextContent,
+					patch
+				});
+				if (priorDone !== nextDone) {
+					if (nextDone === void 0) return refuse("Resolution changes must name an open or resolved state.");
+					ops.push({
+						type: DOCUMENT_OP_TYPES.SET_COMMENT_RESOLUTION,
+						id: next.id,
+						status: nextDone ? "resolved" : "open"
+					});
+				}
+			}
+			break;
+		}
+		default: return command;
+	}
+	const compiled = [];
+	let draft = document;
+	for (const op of ops) {
+		const materialized = (() => {
+			if (op.type !== DOCUMENT_OP_TYPES.CREATE_COMMENT) return Result.ok(op);
+			const allocation = allocateCommentAnchorIds(draft, op);
+			if (allocation.isErr()) return Result.err(allocation.error);
+			return Result.ok({
+				...op,
+				newIds: allocation.value
+			});
+		})();
+		if (materialized.isErr()) return refuse(materialized.error.message);
+		const applied = applyDocumentOps(draft, [materialized.value]);
+		if (applied.isErr()) return refuse(applied.error.message);
+		compiled.push(materialized.value);
+		draft = applied.value.document;
+	}
+	return Result.ok({
+		ops: compiled,
+		document: draft,
+		commentId
+	});
+};
+const canonicalCommentBody = (document, text) => {
+	const occupied = new Set(packageParagraphIds(document.package).map((id) => id.toUpperCase()));
+	let id = 1;
+	while (occupied.has(id.toString(16).padStart(8, "0").toUpperCase())) id += 1;
+	return [{
+		type: "paragraph",
+		paraId: id.toString(16).padStart(8, "0").toUpperCase(),
+		content: [{
+			type: "run",
+			content: [{
+				type: "text",
+				text
+			}]
+		}]
+	}];
+};
+//#endregion
+export { CanonicalCommentError, canonicalCommentBody, compileCanonicalComments };