@stll/folio-core 0.12.0 → 0.13.0

package/dist/layout-painter/renderParagraph.js

@@ -1,6 +1,7 @@
 import { parseXmlDocument } from "../docx/xmlParser.js";
 import { resolveFontFamily } from "../utils/fontResolver.js";
 import { detectBaseDirection } from "../utils/baseDirection.js";
+import { applySanitizedImageSrc } from "../utils/sanitizeImageSrc.js";
 import { AUTHOR_COLORS, getAuthorColorIdx } from "../utils/authorColors.js";
 import { FONT_KERNING_MODE, countCompressibleSpaces, getFontKerningMode, getRunFontKerningMode, toPaintedText } from "../layout-engine/measure/textMeasurementPolicy.js";
 import "../utils/fontWeights.js";
@@ -12,7 +13,7 @@ import { isFloatingImageRun } from "../layout-engine/types.js";
 import { getListMarkerInlineWidth, getListMarkerVisualOffset } from "../layout-engine/measure/listMarkerWidth.js";
 import { resolveImageLineAlign } from "./renderUtils.js";
 import { applySdtDataAttrs } from "./sdtBoundary.js";
-import { applyImageVisualAttrs, hasImageVisualAttrs, wrapImageWithCrop } from "./renderImage.js";
+import { applyImageBorder, applyImageVisualAttrs, hasImageCrop, hasImageVisualAttrs, wrapImageWithCrop } from "./renderImage.js";
 import { ommlToMathml } from "../docx/mathToMathml.js";
 import { evaluateFieldInstruction } from "../fields/evaluateField.js";
 import { borderStrokeToCss, resolveParagraphBorderHorizontalOutsets } from "./borderStroke.js";
@@ -75,6 +76,9 @@ function isMathRun(run) {
 const AUTOMATIC_TEXT_COLOR_VALUES = /* @__PURE__ */ new Set(["auto", "windowtext"]);
 const DEFAULT_BLACK_TEXT_COLOR_VALUES = /* @__PURE__ */ new Set(["000000", "000"]);
 const DOCX_SUPERSCRIPT_SCALE = .75;
+const SUGGESTION_COLOR_CSS = "var(--suggestion-color, #6d3bd6)";
+const SUGGESTION_TINT_CSS = "var(--suggestion-bg, color-mix(in oklch, #6d3bd6 12%, transparent))";
+const SUGGESTION_TINT_LAYER_CSS = `linear-gradient(${SUGGESTION_TINT_CSS}, ${SUGGESTION_TINT_CSS})`;
 function normalizeTextColorValue(color) {
 	return color.trim().toLowerCase().replace(/^#/u, "");
 }
@@ -192,13 +196,21 @@ function applyRunStyles(element, run) {
 	if (run.isInsertion) {
 		const authorIdx = getAuthorColorIdx(run.changeAuthor ?? "");
 		const authorColor = AUTHOR_COLORS[authorIdx];
-		element.style.color = authorColor;
+		const strokeColor = run.isSuggestion ? SUGGESTION_COLOR_CSS : authorColor;
+		element.style.color = strokeColor;
 		if (!decorations.includes("underline")) decorations.push("underline");
-		element.style.textDecorationColor = authorColor;
+		element.style.textDecorationColor = strokeColor;
 		element.classList.add("docx-insertion");
 		element.dataset["tcAuthorIdx"] = String(authorIdx);
+		if (run.isSuggestion) {
+			element.classList.add("docx-insertion--suggested");
+			element.style.textDecorationStyle = "dotted";
+			element.style.backgroundImage = SUGGESTION_TINT_LAYER_CSS;
+			element.dataset["provenance"] = "suggested";
+			if (run.suggestionId) element.dataset["suggestionId"] = run.suggestionId;
+		}
 		const insertionParts = [run.changeAuthor, run.changeDate ? new Date(run.changeDate).toLocaleDateString() : ""].filter(Boolean);
-		if (insertionParts.length > 0) element.title = `Inserted: ${insertionParts.join(", ")}`;
+		if (insertionParts.length > 0) element.title = `${run.isSuggestion ? "Suggested" : "Inserted"}: ${insertionParts.join(", ")}`;
 		if (run.changeAuthor) element.dataset["changeAuthor"] = run.changeAuthor;
 		if (run.changeDate) element.dataset["changeDate"] = run.changeDate;
 		if (run.changeRevisionId !== void 0) element.dataset["revisionId"] = String(run.changeRevisionId);
@@ -206,13 +218,21 @@ function applyRunStyles(element, run) {
 	if (run.isDeletion) {
 		const authorIdx = getAuthorColorIdx(run.changeAuthor ?? "");
 		const authorColor = AUTHOR_COLORS[authorIdx];
-		element.style.color = authorColor;
+		const strokeColor = run.isSuggestion ? SUGGESTION_COLOR_CSS : authorColor;
+		element.style.color = strokeColor;
 		if (!decorations.includes("line-through")) decorations.push("line-through");
-		element.style.textDecorationColor = authorColor;
+		element.style.textDecorationColor = strokeColor;
 		element.classList.add("docx-deletion");
 		element.dataset["tcAuthorIdx"] = String(authorIdx);
+		if (run.isSuggestion) {
+			element.classList.add("docx-deletion--suggested");
+			element.style.textDecorationStyle = "dotted";
+			element.style.backgroundImage = SUGGESTION_TINT_LAYER_CSS;
+			element.dataset["provenance"] = "suggested";
+			if (run.suggestionId) element.dataset["suggestionId"] = run.suggestionId;
+		}
 		const deletionParts = [run.changeAuthor, run.changeDate ? new Date(run.changeDate).toLocaleDateString() : ""].filter(Boolean);
-		if (deletionParts.length > 0) element.title = `Deleted: ${deletionParts.join(", ")}`;
+		if (deletionParts.length > 0) element.title = `${run.isSuggestion ? "Suggested deletion" : "Deleted"}: ${deletionParts.join(", ")}`;
 		if (run.changeAuthor) element.dataset["changeAuthor"] = run.changeAuthor;
 		if (run.changeDate) element.dataset["changeDate"] = run.changeDate;
 		if (run.changeRevisionId !== void 0) element.dataset["revisionId"] = String(run.changeRevisionId);
@@ -368,7 +388,7 @@ function getLeaderChar(leader) {
 function renderInlineImageRun(run, doc) {
 	const img = doc.createElement("img");
 	img.className = `${PARAGRAPH_CLASS_NAMES.run} ${PARAGRAPH_CLASS_NAMES.image}`;
-	img.src = run.src;
+	applySanitizedImageSrc(img, run.src);
 	img.width = run.width;
 	img.height = run.height;
 	img.style.width = `${run.width}px`;
@@ -378,6 +398,7 @@ function renderInlineImageRun(run, doc) {
 		img.style.transform = run.transform;
 		img.style.transformOrigin = "center center";
 	}
+	if (!hasImageCrop(run)) applyImageBorder(img, run);
 	const rotation = parseRotationDegrees(run.transform);
 	if (rotation !== 0) {
 		const bbox = rotatedBoundingBox(run.width, run.height, rotation);
@@ -407,6 +428,7 @@ function renderInlineImageRun(run, doc) {
 		wrapper.style.verticalAlign = "middle";
 		if (run.distTop) wrapper.style.marginTop = `${run.distTop}px`;
 		if (run.distBottom) wrapper.style.marginBottom = `${run.distBottom}px`;
+		if (hasImageCrop(run)) applyImageBorder(wrapper, run);
 		applyPmPositions(wrapper, run.pmStart, run.pmEnd);
 		return wrapper;
 	}
@@ -434,7 +456,7 @@ function renderBlockImage(run, doc) {
 	container.style.marginTop = `${run.distTop ?? 6}px`;
 	container.style.marginBottom = `${run.distBottom ?? 6}px`;
 	const img = doc.createElement("img");
-	img.src = run.src;
+	applySanitizedImageSrc(img, run.src);
 	img.width = run.width;
 	img.height = run.height;
 	if (run.alt) img.alt = run.alt;
@@ -442,6 +464,7 @@ function renderBlockImage(run, doc) {
 		img.style.transform = run.transform;
 		img.style.transformOrigin = "center center";
 	}
+	if (!hasImageCrop(run)) applyImageBorder(img, run);
 	const rotation = parseRotationDegrees(run.transform);
 	if (rotation !== 0) {
 		const bbox = rotatedBoundingBox(run.width, run.height, rotation);
@@ -463,6 +486,7 @@ function renderBlockImage(run, doc) {
 			widthPx: run.width,
 			heightPx: run.height
 		});
+		if (hasImageCrop(run)) applyImageBorder(wrapper, run);
 		applyPmPositions(container, run.pmStart, run.pmEnd);
 		container.append(wrapper);
 		return container;

package/dist/layout-painter/renderTable.js

@@ -1,4 +1,5 @@
 import { emuToPixels } from "../utils/units.js";
+import { applySanitizedImageSrc } from "../utils/sanitizeImageSrc.js";
 import { getTableRowLeadingWidth, isFloatingImageRun, isFloatingTextBoxBlock, tableColumnsArePinned } from "../layout-engine/types.js";
 import { measureParagraph } from "../layout-engine/measure/measureParagraph.js";
 import { resolveAnchoredImagePosition } from "./anchoredImagePosition.js";
@@ -70,7 +71,7 @@ function renderCellContent({ cell, cellMeasure, context, doc, contentWidthOverri
 			if (img.pmStart !== void 0) imgContainer.dataset["pmStart"] = String(img.pmStart);
 			if (img.pmEnd !== void 0) imgContainer.dataset["pmEnd"] = String(img.pmEnd);
 			const imgEl = doc.createElement("img");
-			imgEl.src = img.src;
+			applySanitizedImageSrc(imgEl, img.src);
 			imgEl.style.width = `${img.width}px`;
 			imgEl.style.height = `${img.height}px`;
 			imgEl.style.display = "block";

package/dist/layout-painter/renderWatermark.d.ts

@@ -3,7 +3,7 @@ import { Page } from "../layout-engine/types.js";
 
 //#region src/layout-painter/renderWatermark.d.ts
 type RenderWatermarkOptions = {
-  /** Resolved image src for picture watermarks (data URL or http URL). */imageSrc?: string;
+  /** Resolved image src for picture watermarks (`data:` / `blob:` only). */imageSrc?: string;
 };
 /**
  * Build the watermark overlay element for a page. Returns `null` when

package/dist/layout-painter/renderWatermark.js

@@ -1,4 +1,5 @@
 import { resolveFontFamily } from "../utils/fontResolver.js";
+import { applySanitizedImageSrc } from "../utils/sanitizeImageSrc.js";
 //#region src/layout-painter/renderWatermark.ts
 const WATERMARK_CLASS = "layout-page-watermark";
 /**
@@ -47,7 +48,7 @@ function renderTextWatermark(watermark, doc) {
 }
 function renderPictureWatermark(watermark, imageSrc, doc) {
 	const img = doc.createElement("img");
-	img.src = imageSrc;
+	applySanitizedImageSrc(img, imageSrc);
 	img.alt = "";
 	img.setAttribute("aria-hidden", "true");
 	const scalePct = (watermark.scale ?? 1) * 100;

package/dist/markdown/fromMarkdown.js

@@ -1,5 +1,5 @@
-import { createEmptyDocument } from "../utils/createDocument.js";
 import { sanitizeExternalUrl } from "../utils/urlSecurity.js";
+import { createEmptyDocument } from "../utils/createDocument.js";
 import { marked } from "marked";
 //#region src/markdown/fromMarkdown.ts
 /**

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

@@ -1,5 +1,5 @@
-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, 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 { Mark, Node } from "prosemirror-model";
 
 //#region src/prosemirror/attrs/index.d.ts

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 = [
@@ -600,7 +601,10 @@ 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");
@@ -609,6 +613,8 @@ const readRunPropertyChangeMarkAttrs = (mark) => {
 	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");
@@ -934,6 +940,9 @@ const optionalTableRowRevision = (attrs, key, issues) => {
 	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"];
@@ -962,9 +971,21 @@ const optionalTableCellRevision = (attrs, issues) => {
 	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) => {

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

@@ -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 };