@stll/folio-core 0.11.0 → 0.13.0

package/dist/prosemirror/attrs/index.d.ts

@@ -1,5 +1,5 @@
+import { CharacterSpacingAttrs, CharacterStyleAttrs, CommentAttrs, EmphasisMarkAttrs, FontFamilyAttrs, FontSizeAttrs, FootnoteRefAttrs, HighlightAttrs, HyperlinkAttrs, LanguageAttrs, RunFormattingOverrideAttrs, RunPropertyChangeMarkAttrs, RunShadingAttrs, StrikeAttrs, TextColorAttrs, TextEffectAttrs, TrackedChangeMarkAttrs, UnderlineAttrs } from "../schema/marks.js";
 import { BlockSdtAttrs, FieldAttrs, HardBreakAttrs, ImageAttrs, MathAttrs, ParagraphAttrs, SdtAttrs, ShapeAttrs, TableAttrs, TableCellAttrs, TableRowAttrs, TextBoxAttrs } from "../schema/nodes.js";
-import { CharacterSpacingAttrs, CharacterStyleAttrs, CommentAttrs, EmphasisMarkAttrs, FontFamilyAttrs, FontSizeAttrs, FootnoteRefAttrs, HighlightAttrs, HyperlinkAttrs, LanguageAttrs, RunFormattingOverrideAttrs, RunShadingAttrs, StrikeAttrs, TextColorAttrs, TextEffectAttrs, TrackedChangeMarkAttrs, UnderlineAttrs } from "../schema/marks.js";
 import { Mark, Node } from "prosemirror-model";
 
 //#region src/prosemirror/attrs/index.d.ts
@@ -68,6 +68,8 @@ declare const readCommentMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<C
 declare const expectCommentMarkAttrs: (mark: Mark) => CommentAttrs;
 declare const readTrackedChangeMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<TrackedChangeMarkAttrs>;
 declare const expectTrackedChangeMarkAttrs: (mark: Mark) => TrackedChangeMarkAttrs;
+declare const readRunPropertyChangeMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<RunPropertyChangeMarkAttrs>;
+declare const expectRunPropertyChangeMarkAttrs: (mark: Mark) => RunPropertyChangeMarkAttrs;
 declare const readRunFormattingOverrideMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<RunFormattingOverrideAttrs>;
 declare const expectRunFormattingOverrideMarkAttrs: (mark: Mark) => RunFormattingOverrideAttrs;
 declare const readHyperlinkMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<HyperlinkAttrs>;
@@ -79,4 +81,4 @@ declare const mergeTableAttrs: (node: Node, patch: NodeAttrPatch<TableAttrs>) =>
 declare const mergeTableRowAttrs: (node: Node, patch: NodeAttrPatch<TableRowAttrs>) => TableRowAttrs;
 declare const mergeTableCellAttrs: (node: Node, patch: NodeAttrPatch<TableCellAttrs>) => TableCellAttrs;
 //#endregion
-export { ProseMirrorAttrIssue, ReadProseMirrorAttrsResult, expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs, mergeImageAttrs, mergeParagraphAttrs, mergeTableAttrs, mergeTableCellAttrs, mergeTableRowAttrs, readBlockSdtAttrs, readCharacterSpacingMarkAttrs, readCharacterStyleMarkAttrs, readCommentMarkAttrs, readEmphasisMarkAttrs, readFieldAttrs, readFontFamilyMarkAttrs, readFontSizeMarkAttrs, readFootnoteRefMarkAttrs, readHardBreakAttrs, readHighlightMarkAttrs, readHyperlinkMarkAttrs, readImageAttrs, readLanguageMarkAttrs, readMathAttrs, readParagraphAttrs, readRunFormattingOverrideMarkAttrs, readRunShadingMarkAttrs, readSdtAttrs, readShapeAttrs, readStrikeMarkAttrs, readTableAttrs, readTableCellAttrs, readTableRowAttrs, readTextBoxAttrs, readTextColorMarkAttrs, readTextEffectMarkAttrs, readTrackedChangeMarkAttrs, readUnderlineMarkAttrs };
+export { ProseMirrorAttrIssue, ReadProseMirrorAttrsResult, expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs, expectRunPropertyChangeMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs, mergeImageAttrs, mergeParagraphAttrs, mergeTableAttrs, mergeTableCellAttrs, mergeTableRowAttrs, readBlockSdtAttrs, readCharacterSpacingMarkAttrs, readCharacterStyleMarkAttrs, readCommentMarkAttrs, readEmphasisMarkAttrs, readFieldAttrs, readFontFamilyMarkAttrs, readFontSizeMarkAttrs, readFootnoteRefMarkAttrs, readHardBreakAttrs, readHighlightMarkAttrs, readHyperlinkMarkAttrs, readImageAttrs, readLanguageMarkAttrs, readMathAttrs, readParagraphAttrs, readRunFormattingOverrideMarkAttrs, readRunPropertyChangeMarkAttrs, readRunShadingMarkAttrs, readSdtAttrs, readShapeAttrs, readStrikeMarkAttrs, readTableAttrs, readTableCellAttrs, readTableRowAttrs, readTextBoxAttrs, readTextColorMarkAttrs, readTextEffectMarkAttrs, readTrackedChangeMarkAttrs, readUnderlineMarkAttrs };

package/dist/prosemirror/attrs/index.js

@@ -1,5 +1,6 @@
 import { FIELD_TYPE_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LINE_SPACING_RULE_VALUES, OUTLINE_STYLE_ATTR_VALUES, PARAGRAPH_ALIGNMENT_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES } from "../../types/documentEnumValues.js";
 import { isParagraphDirection } from "../paragraphDirection.js";
+import { TRACKED_CHANGE_PROVENANCE_VALUES } from "../schema/marks.js";
 import { panic } from "better-result";
 //#region src/prosemirror/attrs/index.ts
 const SECTION_BREAK_TYPES = [
@@ -67,6 +68,12 @@ const NOTE_TYPES = ["footnote", "endnote"];
 const NOTE_REF_VERT_ALIGNS = ["baseline", "superscript"];
 const TEXT_BOX_DOCX_PLACEMENTS = ["standalone", "inlineWithPrevious"];
 const TRACKED_CHANGE_MOVE_KINDS = ["moveTo", "moveFrom"];
+const TEXT_BOX_TRACKED_CHANGE_TYPES = [
+	"insertion",
+	"deletion",
+	"moveFrom",
+	"moveTo"
+];
 const HARD_BREAK_TYPES = ["column"];
 const RUN_FORMATTING_OVERRIDE_FALSE_KEYS = [
 	"bold",
@@ -136,6 +143,7 @@ const textEffectAttrsCache = /* @__PURE__ */ new WeakMap();
 const footnoteRefAttrsCache = /* @__PURE__ */ new WeakMap();
 const commentAttrsCache = /* @__PURE__ */ new WeakMap();
 const trackedChangeAttrsCache = /* @__PURE__ */ new WeakMap();
+const runPropertyChangeAttrsCache = /* @__PURE__ */ new WeakMap();
 const runFormattingOverrideAttrsCache = /* @__PURE__ */ new WeakMap();
 const hyperlinkAttrsCache = /* @__PURE__ */ new WeakMap();
 const readParagraphAttrs = (node) => {
@@ -152,6 +160,7 @@ const readParagraphAttrs = (node) => {
 	optionalNumber(attrs, "spaceBefore", "paragraph.attrs.spaceBefore", issues);
 	optionalNumber(attrs, "spaceAfter", "paragraph.attrs.spaceAfter", issues);
 	optionalNumber(attrs, "lineSpacing", "paragraph.attrs.lineSpacing", issues);
+	optionalBoolean(attrs, "snapToGrid", "paragraph.attrs.snapToGrid", issues);
 	optionalOneOf(attrs, "lineSpacingRule", "paragraph.attrs.lineSpacingRule", issues, LINE_SPACING_RULE_VALUES);
 	optionalNumber(attrs, "indentLeft", "paragraph.attrs.indentLeft", issues);
 	optionalNumber(attrs, "indentRight", "paragraph.attrs.indentRight", issues);
@@ -178,6 +187,7 @@ const readParagraphAttrs = (node) => {
 	optionalNumber(attrs, "listStartOverride", "paragraph.attrs.listStartOverride", issues);
 	optionalBoolean(attrs, "pageBreakBefore", "paragraph.attrs.pageBreakBefore", issues);
 	optionalBoolean(attrs, "renderedPageBreakBefore", "paragraph.attrs.renderedPageBreakBefore", issues);
+	optionalBoolean(attrs, "_trailingPageBreak", "paragraph.attrs._trailingPageBreak", issues);
 	optionalBoolean(attrs, "runInWithNext", "paragraph.attrs.runInWithNext", issues);
 	optionalBoolean(attrs, "keepNext", "paragraph.attrs.keepNext", issues);
 	optionalBoolean(attrs, "keepLines", "paragraph.attrs.keepLines", issues);
@@ -203,6 +213,7 @@ const readParagraphAttrs = (node) => {
 	optionalTabStops(attrs, "tabs", "paragraph.attrs.tabs", issues);
 	optionalRecord(attrs, "spacingExplicit", "paragraph.attrs.spacingExplicit", issues);
 	optionalRecord(attrs, "spacingFromDocDefaults", "paragraph.attrs.spacingFromDocDefaults", issues);
+	optionalRecord(attrs, "spacingFromImplicitDefaultStyle", "paragraph.attrs.spacingFromImplicitDefaultStyle", issues);
 	optionalTextFormatting(attrs, "defaultTextFormatting", "paragraph.attrs.defaultTextFormatting", issues);
 	optionalRecord(attrs, "numPr", "paragraph.attrs.numPr", issues);
 	validateNumPr(attrs["numPr"], issues);
@@ -255,6 +266,12 @@ const readTableRowAttrs = (node) => {
 	optionalBoolean(attrs, "isHeader", "tableRow.attrs.isHeader", issues);
 	optionalBoolean(attrs, "hidden", "tableRow.attrs.hidden", issues);
 	optionalRecord(attrs, "_originalFormatting", "tableRow.attrs._originalFormatting", issues);
+	optionalTableRowRevision(attrs, "trIns", issues);
+	optionalTableRowRevision(attrs, "trDel", issues);
+	if (attrs["trIns"] != null && attrs["trDel"] != null) issues.push({
+		path: "tableRow.attrs",
+		message: "Expected at most one structural revision marker."
+	});
 	return attrsResult(attrs, issues);
 };
 const expectTableRowAttrs = (node) => expectCachedNodeAttrs(node, tableRowAttrsCache, readTableRowAttrs, "table row attrs");
@@ -272,6 +289,7 @@ const readTableCellAttrs = (node) => {
 	optionalString(attrs, "_resolvedBackgroundColor", "tableCell.attrs._resolvedBackgroundColor", issues);
 	optionalOneOf(attrs, "textDirection", "tableCell.attrs.textDirection", issues, TABLE_CELL_TEXT_DIRECTION_VALUES);
 	optionalBoolean(attrs, "noWrap", "tableCell.attrs.noWrap", issues);
+	optionalBoolean(attrs, "hideMark", "tableCell.attrs.hideMark", issues);
 	optionalBorderMap(attrs, "borders", "tableCell.attrs.borders", issues, [
 		"top",
 		"bottom",
@@ -282,6 +300,7 @@ const readTableCellAttrs = (node) => {
 	]);
 	optionalInsetMap(attrs, "margins", "tableCell.attrs.margins", issues);
 	optionalRecord(attrs, "_originalFormatting", "tableCell.attrs._originalFormatting", issues);
+	optionalTableCellRevision(attrs, issues);
 	optionalBoolean(attrs, "_preserveVMergeRestart", "tableCell.attrs._preserveVMergeRestart", issues);
 	optionalArray(attrs, "_docxVMergeContinuationCells", "tableCell.attrs._docxVMergeContinuationCells", issues);
 	return attrsResult(attrs, issues);
@@ -344,20 +363,7 @@ const readSdtAttrs = (node) => {
 	const attrs = attrsRecord(node.attrs);
 	const issues = [];
 	expectNodeType(node, "sdt", issues);
-	requiredOneOf(attrs, "sdtType", "sdt.attrs.sdtType", issues, SDT_TYPE_VALUES);
-	optionalString(attrs, "alias", "sdt.attrs.alias", issues);
-	optionalString(attrs, "tag", "sdt.attrs.tag", issues);
-	optionalNumber(attrs, "id", "sdt.attrs.id", issues);
-	optionalOneOf(attrs, "lock", "sdt.attrs.lock", issues, SDT_LOCK_VALUES);
-	optionalString(attrs, "placeholder", "sdt.attrs.placeholder", issues);
-	optionalBoolean(attrs, "showingPlaceholder", "sdt.attrs.showingPlaceholder", issues);
-	optionalString(attrs, "dateFormat", "sdt.attrs.dateFormat", issues);
-	optionalString(attrs, "dateValueISO", "sdt.attrs.dateValueISO", issues);
-	optionalSdtListItems(attrs, "listItems", "sdt.attrs.listItems", issues);
-	optionalString(attrs, "dropdownLastValue", "sdt.attrs.dropdownLastValue", issues);
-	optionalBoolean(attrs, "checked", "sdt.attrs.checked", issues);
-	optionalString(attrs, "rawPropertiesXml", "sdt.attrs.rawPropertiesXml", issues);
-	optionalString(attrs, "rawEndPropertiesXml", "sdt.attrs.rawEndPropertiesXml", issues);
+	validateSdtAttrsRecord(attrs, "sdt.attrs", issues);
 	return attrsResult(attrs, issues);
 };
 const expectSdtAttrs = (node) => expectCachedNodeAttrs(node, sdtAttrsCache, readSdtAttrs, "sdt attrs");
@@ -452,6 +458,9 @@ const readTextBoxAttrs = (node) => {
 	optionalImagePosition(attrs, "position", "textBox.attrs.position", issues);
 	optionalOneOf(attrs, "_docxPlacement", "textBox.attrs._docxPlacement", issues, TEXT_BOX_DOCX_PLACEMENTS);
 	optionalString(attrs, "_docxGroupId", "textBox.attrs._docxGroupId", issues);
+	optionalString(attrs, "_docxAnchorId", "textBox.attrs._docxAnchorId", issues);
+	optionalTextBoxTrackedChange(attrs, issues);
+	optionalTextBoxInlineSdts(attrs, issues);
 	return attrsResult(attrs, issues);
 };
 const expectTextBoxAttrs = (node) => expectCachedNodeAttrs(node, textBoxAttrsCache, readTextBoxAttrs, "text box attrs");
@@ -592,10 +601,23 @@ const readTrackedChangeMarkAttrs = (mark) => {
 	requiredNumber(attrs, "revisionId", `${mark.type.name}.attrs.revisionId`, issues);
 	requiredString(attrs, "author", `${mark.type.name}.attrs.author`, issues);
 	optionalString(attrs, "date", `${mark.type.name}.attrs.date`, issues);
+	optionalString(attrs, "initials", `${mark.type.name}.attrs.initials`, issues);
 	optionalOneOf(attrs, "moveKind", `${mark.type.name}.attrs.moveKind`, issues, TRACKED_CHANGE_MOVE_KINDS);
+	optionalOneOf(attrs, "provenance", `${mark.type.name}.attrs.provenance`, issues, TRACKED_CHANGE_PROVENANCE_VALUES);
+	optionalString(attrs, "suggestionId", `${mark.type.name}.attrs.suggestionId`, issues);
 	return attrsResult(attrs, issues);
 };
 const expectTrackedChangeMarkAttrs = (mark) => expectCachedMarkAttrs(mark, trackedChangeAttrsCache, readTrackedChangeMarkAttrs, "tracked change attrs");
+const readRunPropertyChangeMarkAttrs = (mark) => {
+	const attrs = attrsRecord(mark.attrs);
+	const issues = [];
+	expectMarkType(mark, "runPropertyChange", issues);
+	optionalPropertyChanges(attrs, "changes", "runPropertyChange.attrs.changes", issues, ["runPropertyChange"]);
+	optionalOneOf(attrs, "provenance", "runPropertyChange.attrs.provenance", issues, TRACKED_CHANGE_PROVENANCE_VALUES);
+	optionalString(attrs, "suggestionId", "runPropertyChange.attrs.suggestionId", issues);
+	return attrsResult(attrs, issues);
+};
+const expectRunPropertyChangeMarkAttrs = (mark) => expectCachedMarkAttrs(mark, runPropertyChangeAttrsCache, readRunPropertyChangeMarkAttrs, "run property change attrs");
 const readRunFormattingOverrideMarkAttrs = (mark) => {
 	const attrs = attrsRecord(mark.attrs);
 	const issues = [];
@@ -640,11 +662,23 @@ const attrsResult = (attrs, issues) => {
 		ok: false,
 		issues
 	};
-	const normalizedAttrs = {};
-	for (const [key, value] of Object.entries(attrs)) if (value !== null) normalizedAttrs[key] = value;
+	let normalizedAttrs;
 	return {
 		ok: true,
-		value: normalizedAttrs
+		get value() {
+			if (normalizedAttrs !== void 0) return normalizedAttrs;
+			const presentAttrs = {};
+			for (const key in attrs) {
+				if (!Object.hasOwn(attrs, key)) continue;
+				const value = attrs[key];
+				if (value !== null) presentAttrs[key] = value;
+			}
+			normalizedAttrs = presentAttrs;
+			return normalizedAttrs;
+		},
+		set value(value) {
+			normalizedAttrs = value;
+		}
 	};
 };
 const expectAttrs = (result, label) => {
@@ -892,6 +926,129 @@ const optionalRecord = (attrs, key, path, issues) => {
 		message: "Expected an object."
 	});
 };
+const optionalTableRowRevision = (attrs, key, issues) => {
+	const value = attrs[key];
+	if (value === void 0 || value === null) return;
+	const path = `tableRow.attrs.${key}`;
+	if (!isRecord(value)) {
+		issues.push({
+			path,
+			message: "Expected an object."
+		});
+		return;
+	}
+	requiredNumber(value, "revisionId", `${path}.revisionId`, issues);
+	requiredString(value, "author", `${path}.author`, issues);
+	optionalString(value, "date", `${path}.date`, issues);
+	optionalString(value, "initials", `${path}.initials`, issues);
+	optionalOneOf(value, "provenance", `${path}.provenance`, issues, TRACKED_CHANGE_PROVENANCE_VALUES);
+	optionalString(value, "suggestionId", `${path}.suggestionId`, issues);
+};
+const optionalTableCellRevision = (attrs, issues) => {
+	const value = attrs["cellMarker"];
+	if (value === void 0 || value === null) return;
+	const path = "tableCell.attrs.cellMarker";
+	if (!isRecord(value)) {
+		issues.push({
+			path,
+			message: "Expected an object."
+		});
+		return;
+	}
+	requiredOneOf(value, "kind", `${path}.kind`, issues, [
+		"ins",
+		"del",
+		"merge"
+	]);
+	const info = value["info"];
+	if (!isRecord(info)) {
+		issues.push({
+			path: `${path}.info`,
+			message: "Expected an object."
+		});
+		return;
+	}
+	requiredNumber(info, "revisionId", `${path}.info.revisionId`, issues);
+	requiredString(info, "author", `${path}.info.author`, issues);
+	optionalString(info, "date", `${path}.info.date`, issues);
+	optionalString(info, "initials", `${path}.info.initials`, issues);
+	if (value["kind"] === "merge") {
+		if (info["provenance"] !== void 0) issues.push({
+			path: `${path}.info.provenance`,
+			message: "Not allowed on a merge marker."
+		});
+		if (info["suggestionId"] !== void 0) issues.push({
+			path: `${path}.info.suggestionId`,
+			message: "Not allowed on a merge marker."
+		});
+		optionalOneOf(value, "verticalMerge", `${path}.verticalMerge`, issues, ["continue", "rest"]);
+		optionalOneOf(value, "verticalMergeOriginal", `${path}.verticalMergeOriginal`, issues, ["continue", "rest"]);
+	} else {
+		optionalOneOf(info, "provenance", `${path}.info.provenance`, issues, TRACKED_CHANGE_PROVENANCE_VALUES);
+		optionalString(info, "suggestionId", `${path}.info.suggestionId`, issues);
+	}
+};
+const optionalTextBoxTrackedChange = (attrs, issues) => {
+	const value = attrs["_docxTrackedChange"];
+	if (value === void 0 || value === null) return;
+	if (!isRecord(value)) {
+		issues.push({
+			path: "textBox.attrs._docxTrackedChange",
+			message: "Expected an object."
+		});
+		return;
+	}
+	requiredOneOf(value, "type", "textBox.attrs._docxTrackedChange.type", issues, TEXT_BOX_TRACKED_CHANGE_TYPES);
+	const info = value["info"];
+	if (!isRecord(info)) {
+		issues.push({
+			path: "textBox.attrs._docxTrackedChange.info",
+			message: "Expected an object."
+		});
+		return;
+	}
+	requiredNumber(info, "id", "textBox.attrs._docxTrackedChange.info.id", issues);
+	requiredString(info, "author", "textBox.attrs._docxTrackedChange.info.author", issues);
+	optionalString(info, "date", "textBox.attrs._docxTrackedChange.info.date", issues);
+};
+const optionalTextBoxInlineSdts = (attrs, issues) => {
+	const value = attrs["_docxInlineSdts"];
+	if (value === void 0 || value === null) return;
+	if (!Array.isArray(value)) {
+		issues.push({
+			path: "textBox.attrs._docxInlineSdts",
+			message: "Expected an array."
+		});
+		return;
+	}
+	for (const [index, item] of value.entries()) {
+		const path = `textBox.attrs._docxInlineSdts[${index}]`;
+		if (!isRecord(item)) {
+			issues.push({
+				path,
+				message: "Expected an object."
+			});
+			continue;
+		}
+		validateSdtAttrsRecord(item, path, issues);
+	}
+};
+const validateSdtAttrsRecord = (attrs, path, issues) => {
+	requiredOneOf(attrs, "sdtType", `${path}.sdtType`, issues, SDT_TYPE_VALUES);
+	optionalString(attrs, "alias", `${path}.alias`, issues);
+	optionalString(attrs, "tag", `${path}.tag`, issues);
+	optionalNumber(attrs, "id", `${path}.id`, issues);
+	optionalOneOf(attrs, "lock", `${path}.lock`, issues, SDT_LOCK_VALUES);
+	optionalString(attrs, "placeholder", `${path}.placeholder`, issues);
+	optionalBoolean(attrs, "showingPlaceholder", `${path}.showingPlaceholder`, issues);
+	optionalString(attrs, "dateFormat", `${path}.dateFormat`, issues);
+	optionalString(attrs, "dateValueISO", `${path}.dateValueISO`, issues);
+	optionalSdtListItems(attrs, "listItems", `${path}.listItems`, issues);
+	optionalString(attrs, "dropdownLastValue", `${path}.dropdownLastValue`, issues);
+	optionalBoolean(attrs, "checked", `${path}.checked`, issues);
+	optionalString(attrs, "rawPropertiesXml", `${path}.rawPropertiesXml`, issues);
+	optionalString(attrs, "rawEndPropertiesXml", `${path}.rawEndPropertiesXml`, issues);
+};
 const optionalAutospacingBase = (attrs, issues) => {
 	const value = attrs["_autospacingBase"];
 	if (value === void 0 || value === null) return;
@@ -1249,4 +1406,4 @@ const optionalEmptyHyperlinkArray = (value, issues) => {
 	}
 };
 //#endregion
-export { expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs, mergeImageAttrs, mergeParagraphAttrs, mergeTableAttrs, mergeTableCellAttrs, mergeTableRowAttrs, readBlockSdtAttrs, readCharacterSpacingMarkAttrs, readCharacterStyleMarkAttrs, readCommentMarkAttrs, readEmphasisMarkAttrs, readFieldAttrs, readFontFamilyMarkAttrs, readFontSizeMarkAttrs, readFootnoteRefMarkAttrs, readHardBreakAttrs, readHighlightMarkAttrs, readHyperlinkMarkAttrs, readImageAttrs, readLanguageMarkAttrs, readMathAttrs, readParagraphAttrs, readRunFormattingOverrideMarkAttrs, readRunShadingMarkAttrs, readSdtAttrs, readShapeAttrs, readStrikeMarkAttrs, readTableAttrs, readTableCellAttrs, readTableRowAttrs, readTextBoxAttrs, readTextColorMarkAttrs, readTextEffectMarkAttrs, readTrackedChangeMarkAttrs, readUnderlineMarkAttrs };
+export { expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs, expectRunPropertyChangeMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs, mergeImageAttrs, mergeParagraphAttrs, mergeTableAttrs, mergeTableCellAttrs, mergeTableRowAttrs, readBlockSdtAttrs, readCharacterSpacingMarkAttrs, readCharacterStyleMarkAttrs, readCommentMarkAttrs, readEmphasisMarkAttrs, readFieldAttrs, readFontFamilyMarkAttrs, readFontSizeMarkAttrs, readFootnoteRefMarkAttrs, readHardBreakAttrs, readHighlightMarkAttrs, readHyperlinkMarkAttrs, readImageAttrs, readLanguageMarkAttrs, readMathAttrs, readParagraphAttrs, readRunFormattingOverrideMarkAttrs, readRunPropertyChangeMarkAttrs, readRunShadingMarkAttrs, readSdtAttrs, readShapeAttrs, readStrikeMarkAttrs, readTableAttrs, readTableCellAttrs, readTableRowAttrs, readTextBoxAttrs, readTextColorMarkAttrs, readTextEffectMarkAttrs, readTrackedChangeMarkAttrs, readUnderlineMarkAttrs };

package/dist/prosemirror/commands/comments.d.ts

@@ -39,12 +39,12 @@ declare function acceptAllChanges(): Command;
  */
 declare function rejectAllChanges(): Command;
 /**
- * Find the document range covered by all insertion/deletion marks
+ * Find the document range covered by all inline revision marks
  * carrying any of the given AI-edit `revisionIds`. Returns null when
  * none of those marks are present (already accepted/rejected, or
  * never existed). A replace operation typically passes two ids (one
  * for its deletion side, one for its insertion side); inserts and
- * standalone deletions pass a single id.
+ * standalone deletions and formatting changes pass a single id.
  */
 declare function findAIEditRevisionRange(state: EditorState, revisionIds: number | readonly number[]): {
   from: number;
@@ -52,7 +52,7 @@ declare function findAIEditRevisionRange(state: EditorState, revisionIds: number
 } | null;
 /**
  * Accept the tracked-change marks belonging to an AI-edit operation.
- * Pass a single revisionId for inserts/standalone deletions, or the
+ * Pass a single revisionId for inserts, standalone deletions, or formatting changes; or the
  * full id list for a replace (one id per side). Returns false when
  * none of the ids match anything in the doc.
  */
@@ -62,6 +62,81 @@ declare function acceptAIEditRevision(revisionIds: number | readonly number[]):
  * See {@link acceptAIEditRevision} for the id semantics.
  */
 declare function rejectAIEditRevision(revisionIds: number | readonly number[]): Command;
+type SuggestionKind = "insertion" | "deletion" | "formatting" | "insertBlock" | "insertTable" | "insertRow" | "deleteRow" | "insertColumn" | "deleteColumn";
+/**
+ * How a suggestion is applied when accepted:
+ * - `"tracked"` — converts to a normal OOXML tracked change (`w:ins`/`w:del`,
+ *   paragraph-mark `w:ins`, row/cell `w:ins`/`w:del`);
+ * - `"direct"` — no OOXML tracked representation exists (a whole inserted
+ *   table), so accepting applies it directly;
+ * - `"mixed"` — a heterogeneous group (one `suggestionId` spanning a whole
+ *   inserted table AND other edits) whose parts apply both ways. Accept still
+ *   resolves the whole group in one transaction; this flag lets the host
+ *   message that some parts landed directly.
+ */
+type SuggestionAppliedAs = "tracked" | "direct" | "mixed";
+type FolioSuggestion = {
+  suggestionId: string; /** Contiguous document ranges the suggestion covers, in document order. */
+  ranges: readonly {
+    from: number;
+    to: number;
+  }[]; /** Which kinds of change the suggestion contains (deduped, in a stable order). */
+  kinds: readonly SuggestionKind[]; /** How accepting this suggestion applies it (see {@link SuggestionAppliedAs}). */
+  appliedAs: SuggestionAppliedAs;
+};
+/**
+ * List every suggestion in the document for host consumption: its id, the
+ * contiguous ranges it covers, which kinds of change it contains, and how
+ * accepting it applies (tracked vs direct).
+ */
+declare function getSuggestions(state: EditorState): FolioSuggestion[];
+/**
+ * The document range covering every mark belonging to `suggestionId`, plus the
+ * revision ids those marks carry. Returns null when the suggestion is absent
+ * (already accepted/rejected, or never existed).
+ */
+declare function findSuggestionRange(state: EditorState, suggestionId: string): {
+  from: number;
+  to: number;
+  revisionIds: number[];
+} | null;
+type AcceptSuggestionOptions = {
+  author: string;
+  /**
+   * Date stamped on the resulting user tracked change (serialized as `w:date`);
+   * defaults to now. A malformed / non-parseable value is normalized to now, and
+   * a valid value is canonicalized to ISO 8601, so an invalid date can never be
+   * written into the document.
+   */
+  date?: string;
+};
+/**
+ * Accept one suggestion: convert its inline marks and block/table node
+ * revisions into normal tracked changes authored by `author`, keeping revision
+ * ids. A whole inserted table (which OOXML cannot track) is applied directly;
+ * everything else becomes a tracked change. See {@link getSuggestions} for the
+ * per-suggestion `appliedAs`.
+ */
+declare function acceptSuggestion(suggestionId: string, options: AcceptSuggestionOptions): Command;
+/** Accept every suggestion in the document. */
+declare function acceptAllSuggestions(options: AcceptSuggestionOptions): Command;
+/**
+ * Reject one suggestion: inverse-apply it in a single transaction. Runs BOTH
+ * phases so a heterogeneous group (one `suggestionId` spanning whole-node
+ * inserts AND other edits) is fully resolved:
+ *  1. inline marks and suggested `trIns`/`trDel`/`cellMarker` revisions are
+ *     inverse-applied through {@link resolveChange} (delete suggested-inserted
+ *     text/rows/cells, drop suggested deletions/formatting);
+ *  2. any remaining whole-node inserts (paragraph/table) are then deleted,
+ *     mapped through the accumulated transaction so positions stay valid.
+ *
+ * A paragraph whole-node insert carries inline marks with the same revision id,
+ * so phase 1 empties its text and phase 2 removes the now-empty node; a whole
+ * inserted table has no matching revision, so only phase 2 removes it.
+ */
+declare function rejectSuggestion(suggestionId: string): Command;
+/** Reject every suggestion in the document. */
+declare function rejectAllSuggestions(): Command;
 type ChangeRange = {
   from: number;
   to: number;
@@ -90,4 +165,4 @@ declare function findNextChange(state: EditorState, startPos: number): ChangeRan
  */
 declare function findPreviousChange(state: EditorState, startPos: number): ChangeRange | null;
 //#endregion
-export { ParagraphBoundaryChange, acceptAIEditRevision, acceptAllChanges, acceptChange, addCommentMark, findAIEditRevisionRange, findChangeAtPosition, findNextChange, findParagraphBoundaryChangeAtPosition, findPreviousChange, rejectAIEditRevision, rejectAllChanges, rejectChange, removeCommentMark };
+export { AcceptSuggestionOptions, FolioSuggestion, ParagraphBoundaryChange, SuggestionAppliedAs, SuggestionKind, acceptAIEditRevision, acceptAllChanges, acceptAllSuggestions, acceptChange, acceptSuggestion, addCommentMark, findAIEditRevisionRange, findChangeAtPosition, findNextChange, findParagraphBoundaryChangeAtPosition, findPreviousChange, findSuggestionRange, getSuggestions, rejectAIEditRevision, rejectAllChanges, rejectAllSuggestions, rejectChange, rejectSuggestion, removeCommentMark };