@lofcz/platejs-suggestion 53.0.0 → 53.2.3

package/dist/index.d.ts

@@ -61,6 +61,7 @@ declare function diffToSuggestions<E extends SlateEditor>(editor: E, doc0: Desce
   getInsertProps,
   getUpdateProps,
   isInline,
+  generatePairId,
   ...options
 }?: Partial<ComputeDiffOptions>): ValueOf<E>;
 //#endregion
@@ -185,6 +186,7 @@ declare const removeNodesSuggestion: (editor: SlateEditor, nodes: NodeEntry<TEle
 //#region src/lib/transforms/setSuggestionNodes.d.ts
 declare const setSuggestionNodes: (editor: SlateEditor, options?: {
   createdAt?: number;
+  includeInlineElements?: boolean;
   suggestionDeletion?: boolean;
   suggestionId?: string;
 } & SetNodesOptions) => void;

package/dist/index.js

@@ -1,3 +1,3 @@
-import { A as SkipSuggestionDeletes, C as getSuggestionUserIdByKey, D as getInlineSuggestionData, E as isSuggestionKey, O as getSuggestionKeyId, S as getSuggestionUserId, T as isCurrentUserSuggestion, _ as getTransientSuggestionKey, a as BaseSuggestionPlugin, b as getSuggestionKey, c as removeMarkSuggestion, d as deleteFragmentSuggestion, f as deleteSuggestion, g as findInlineSuggestionNode, h as findSuggestionProps, i as acceptSuggestion, k as keyId2SuggestionId, l as insertTextSuggestion, m as addMarkSuggestion, n as rejectSuggestion, o as withSuggestion, p as setSuggestionNodes, r as getSuggestionProps, s as removeNodesSuggestion, t as diffToSuggestions, u as insertFragmentSuggestion, v as getActiveSuggestionDescriptions, w as getSuggestionUserIds, x as getSuggestionKeys, y as getSuggestionNodeEntries } from "./src-CruTaHKh.js";
+import { A as SkipSuggestionDeletes, C as getSuggestionUserIdByKey, D as getInlineSuggestionData, E as isSuggestionKey, O as getSuggestionKeyId, S as getSuggestionUserId, T as isCurrentUserSuggestion, _ as getTransientSuggestionKey, a as BaseSuggestionPlugin, b as getSuggestionKey, c as removeMarkSuggestion, d as deleteFragmentSuggestion, f as deleteSuggestion, g as findInlineSuggestionNode, h as findSuggestionProps, i as acceptSuggestion, k as keyId2SuggestionId, l as insertTextSuggestion, m as addMarkSuggestion, n as rejectSuggestion, o as withSuggestion, p as setSuggestionNodes, r as getSuggestionProps, s as removeNodesSuggestion, t as diffToSuggestions, u as insertFragmentSuggestion, v as getActiveSuggestionDescriptions, w as getSuggestionUserIds, x as getSuggestionKeys, y as getSuggestionNodeEntries } from "./src-CTTgK2Pn.js";
 
 export { BaseSuggestionPlugin, SkipSuggestionDeletes, acceptSuggestion, addMarkSuggestion, deleteFragmentSuggestion, deleteSuggestion, diffToSuggestions, findInlineSuggestionNode, findSuggestionProps, getActiveSuggestionDescriptions, getInlineSuggestionData, getSuggestionKey, getSuggestionKeyId, getSuggestionKeys, getSuggestionNodeEntries, getSuggestionProps, getSuggestionUserId, getSuggestionUserIdByKey, getSuggestionUserIds, getTransientSuggestionKey, insertFragmentSuggestion, insertTextSuggestion, isCurrentUserSuggestion, isSuggestionKey, keyId2SuggestionId, rejectSuggestion, removeMarkSuggestion, removeNodesSuggestion, setSuggestionNodes, withSuggestion };

package/dist/react/index.js

@@ -1,4 +1,4 @@
-import { a as BaseSuggestionPlugin } from "../src-CruTaHKh.js";
+import { a as BaseSuggestionPlugin } from "../src-CTTgK2Pn.js";
 import { toPlatePlugin } from "platejs/react";
 
 //#region src/react/SuggestionPlugin.tsx

package/dist/{src-CruTaHKh.js → src-CTTgK2Pn.js}

@@ -116,10 +116,15 @@ const findSuggestionProps = (editor, { at, type }) => {
 		createdAt: Date.now()
 	};
 	const api = editor.getApi(BaseSuggestionPlugin);
+	const getInlineElementEntry = (point) => editor.api.above({
+		at: point,
+		match: (node) => ElementApi.isElement(node) && editor.api.isInline(node) && !!api.suggestion.nodeId(node)
+	});
 	let entry = api.suggestion.node({
 		at,
 		isText: true
 	});
+	let inlineEntry;
 	if (!entry) {
 		let start;
 		let end;
@@ -129,16 +134,22 @@ const findSuggestionProps = (editor, { at, type }) => {
 			return defaultProps;
 		}
 		const nextPoint = editor.api.after(end);
-		if (nextPoint) entry = api.suggestion.node({
-			at: nextPoint,
-			isText: true
-		});
-		if (!entry) {
-			const prevPoint = editor.api.before(start);
-			if (prevPoint) entry = api.suggestion.node({
-				at: prevPoint,
+		if (nextPoint) {
+			entry = api.suggestion.node({
+				at: nextPoint,
 				isText: true
 			});
+			if (!entry) inlineEntry = getInlineElementEntry(nextPoint);
+		}
+		if (!entry && !inlineEntry) {
+			const prevPoint = editor.api.before(start);
+			if (prevPoint) {
+				entry = api.suggestion.node({
+					at: prevPoint,
+					isText: true
+				});
+				if (!entry) inlineEntry = getInlineElementEntry(prevPoint);
+			}
 			const blockEntry = editor.api.block({ at: start });
 			if (!entry && blockEntry && editor.api.isStart(start, blockEntry[1])) {
 				const lineBreakData = editor.api.above({ at: prevPoint ?? start })?.[0].suggestion;
@@ -153,6 +164,11 @@ const findSuggestionProps = (editor, { at, type }) => {
 		id: api.suggestion.nodeId(entry[0]) ?? nanoid(),
 		createdAt: getInlineSuggestionData(entry[0])?.createdAt ?? Date.now()
 	};
+	const inlineSuggestionData = inlineEntry && api.suggestion.suggestionData(inlineEntry[0]);
+	if (inlineEntry && inlineSuggestionData?.type === type && isCurrentUserSuggestion(editor, inlineEntry[0])) return {
+		id: api.suggestion.nodeId(inlineEntry[0]) ?? nanoid(),
+		createdAt: inlineSuggestionData.createdAt ?? Date.now()
+	};
 	return defaultProps;
 };
 
@@ -198,10 +214,10 @@ const setSuggestionNodes = (editor, options) => {
 	const at = getAt(editor, options?.at) ?? editor.selection;
 	if (!at) return;
 	const { suggestionId = nanoid() } = options ?? {};
-	const nodeEntries = [...editor.api.nodes({
+	const nodeEntries = [...options?.includeInlineElements ?? true ? editor.api.nodes({
 		match: (n) => ElementApi.isElement(n) && editor.api.isInline(n),
 		...options
-	})];
+	}) : []];
 	editor.tf.withoutNormalizing(() => {
 		const data = {
 			id: suggestionId,
@@ -235,6 +251,23 @@ const setSuggestionNodes = (editor, options) => {
 */
 const deleteSuggestion = (editor, at, { reverse } = {}) => {
 	let resId;
+	const getInlineEntryAt = (point) => editor.api.above({
+		at: point,
+		match: (node) => ElementApi.isElement(node) && editor.api.isInline(node)
+	});
+	const getAdjacentInlineVoidEntry = (point, { reverse: reverse$1 }) => {
+		try {
+			const adjacentPath = reverse$1 ? PathApi.previous(point.path) : PathApi.next(point.path);
+			if (!adjacentPath) return;
+			const entry = editor.api.node(adjacentPath);
+			if (entry && ElementApi.isElement(entry[0]) && editor.api.isInline(entry[0]) && editor.api.isVoid(entry[0])) return entry;
+		} catch {}
+	};
+	const isBoundaryPoint = (point, { reverse: reverse$1 }) => {
+		const range = editor.api.range(point.path);
+		if (!range) return false;
+		return reverse$1 ? editor.api.isStart(point, range) : editor.api.isEnd(point, range);
+	};
 	editor.tf.withoutNormalizing(() => {
 		const { anchor: from, focus: to } = at;
 		const { id, createdAt } = findSuggestionProps(editor, {
@@ -249,6 +282,7 @@ const deleteSuggestion = (editor, at, { reverse } = {}) => {
 			if (!pointCurrent) break;
 			const pointTarget = toRef.current;
 			if (!pointTarget) break;
+			if (PointApi.equals(pointCurrent, pointTarget)) break;
 			if (!editor.api.isAt({
 				at: {
 					anchor: pointCurrent,
@@ -256,13 +290,19 @@ const deleteSuggestion = (editor, at, { reverse } = {}) => {
 				},
 				blocks: true
 			})) {
-				if (editor.api.string(reverse ? {
+				const inlineRange = reverse ? {
 					anchor: pointTarget,
 					focus: pointCurrent
 				} : {
 					anchor: pointCurrent,
 					focus: pointTarget
-				}).length === 0) break;
+				};
+				const str = editor.api.string(inlineRange);
+				const hasInlineNode = editor.api.some({
+					at: inlineRange,
+					match: (n) => ElementApi.isElement(n) && editor.api.isInline(n)
+				});
+				if (str.length === 0 && !hasInlineNode) break;
 			}
 			const pointNext = (reverse ? editor.api.before : editor.api.after)(pointCurrent, { unit: "character" });
 			if (!pointNext) break;
@@ -274,6 +314,40 @@ const deleteSuggestion = (editor, at, { reverse } = {}) => {
 				focus: pointNext
 			};
 			range = editor.api.unhangRange(range, { character: true });
+			const inlineEntryAtNext = getInlineEntryAt(pointNext);
+			const inlineEntryAtCurrent = inlineEntryAtNext ? void 0 : getInlineEntryAt(pointCurrent);
+			const canUseAdjacentInlineFallback = isBoundaryPoint(pointCurrent, { reverse });
+			const adjacentInlineEntry = inlineEntryAtNext || inlineEntryAtCurrent || !canUseAdjacentInlineFallback ? void 0 : getAdjacentInlineVoidEntry(pointCurrent, { reverse });
+			const inlineEntryAtCurrentIsNonSelectable = !!inlineEntryAtCurrent && !editor.api.isSelectable(inlineEntryAtCurrent[0]);
+			const adjacentInlineEntryIsNonSelectable = !!adjacentInlineEntry && !editor.api.isSelectable(adjacentInlineEntry[0]);
+			const inlineEntry = inlineEntryAtNext ?? (inlineEntryAtCurrentIsNonSelectable ? inlineEntryAtCurrent : void 0) ?? (adjacentInlineEntryIsNonSelectable ? adjacentInlineEntry : void 0);
+			const pointCurrentInsideInline = !!inlineEntry && PathApi.isAncestor(inlineEntry[1], pointCurrent.path);
+			if (inlineEntry && editor.api.isVoid(inlineEntry[0]) && (!inlineEntryAtNext || !pointCurrentInsideInline)) {
+				editor.tf.setNodes({
+					[getSuggestionKey(id)]: {
+						id,
+						createdAt,
+						type: "remove",
+						userId: editor.getOptions(BaseSuggestionPlugin).currentUserId
+					},
+					[KEYS.suggestion]: true
+				}, { at: inlineEntry[1] });
+				const beforeInlineElement = editor.api.before(inlineEntry[1]);
+				const targetIsInsideInlineElement = PathApi.equals(inlineEntry[1], pointTarget.path) || PathApi.isAncestor(inlineEntry[1], pointTarget.path);
+				if (reverse) {
+					if (beforeInlineElement) {
+						editor.tf.select(beforeInlineElement);
+						if (!targetIsInsideInlineElement && !PointApi.equals(beforeInlineElement, pointTarget)) continue;
+					}
+					break;
+				}
+				const afterInlineElement = editor.api.after(inlineEntry[1]);
+				if (afterInlineElement) {
+					editor.tf.select(afterInlineElement);
+					if (!PointApi.equals(afterInlineElement, pointTarget)) continue;
+				} else if (beforeInlineElement) editor.tf.select(beforeInlineElement);
+				break;
+			}
 			const entryBlock = editor.api.node({
 				at: pointCurrent,
 				block: true,
@@ -303,11 +377,13 @@ const deleteSuggestion = (editor, at, { reverse } = {}) => {
 						break;
 					}
 					if (!isBlockSuggestion) {
+						const isPreviousBlockVoid = editor.api.isVoid(previousAboveNode[0]) && !editor.api.isInline(previousAboveNode[0]);
 						editor.tf.setNodes({ [KEYS.suggestion]: {
 							id,
 							createdAt,
 							type: "remove",
-							userId: editor.getOptions(BaseSuggestionPlugin).currentUserId
+							userId: editor.getOptions(BaseSuggestionPlugin).currentUserId,
+							...isPreviousBlockVoid ? {} : { isLineBreak: true }
 						} }, { at: previousAboveNode[1] });
 						editor.tf.move({
 							reverse,
@@ -336,6 +412,7 @@ const deleteSuggestion = (editor, at, { reverse } = {}) => {
 			setSuggestionNodes(editor, {
 				at: range,
 				createdAt,
+				includeInlineElements: false,
 				suggestionDeletion: true,
 				suggestionId: id
 			});
@@ -475,7 +552,8 @@ const removeNodesSuggestion = (editor, nodes) => {
 		editor.tf.setNodes({ [KEYS.suggestion]: {
 			id,
 			createdAt,
-			type: "remove"
+			type: "remove",
+			userId: editor.getOptions(BaseSuggestionPlugin).currentUserId
 		} }, { at: blockPath });
 	});
 };
@@ -491,11 +569,12 @@ const withSuggestion = ({ api, editor, getOptions, tf: { addMark, apply, deleteB
 		return apply(operation);
 	},
 	deleteBackward(unit) {
+		const resolvedUnit = unit ?? "character";
 		const selection = editor.selection;
-		const pointTarget = editor.api.before(selection, { unit });
+		const pointTarget = editor.api.before(selection, { unit: resolvedUnit });
 		if (getOptions().isSuggesting) {
 			const node = editor.api.above();
-			if (node?.[0][KEYS.suggestion] && !node?.[0].suggestion.isLineBreak) return deleteBackward(unit);
+			if (node?.[0][KEYS.suggestion] && !node?.[0].suggestion.isLineBreak) return deleteBackward(resolvedUnit);
 			if (!pointTarget) return;
 			deleteSuggestion(editor, {
 				anchor: selection.anchor,
@@ -512,12 +591,13 @@ const withSuggestion = ({ api, editor, getOptions, tf: { addMark, apply, deleteB
 				blocks: true
 			})) editor.tf.unsetNodes([KEYS.suggestion], { at: pointTarget });
 		}
-		deleteBackward(unit);
+		deleteBackward(resolvedUnit);
 	},
 	deleteForward(unit) {
+		const resolvedUnit = unit ?? "character";
 		if (getOptions().isSuggesting) {
 			const selection = editor.selection;
-			const pointTarget = editor.api.after(selection, { unit });
+			const pointTarget = editor.api.after(selection, { unit: resolvedUnit });
 			if (!pointTarget) return;
 			deleteSuggestion(editor, {
 				anchor: selection.anchor,
@@ -525,7 +605,7 @@ const withSuggestion = ({ api, editor, getOptions, tf: { addMark, apply, deleteB
 			});
 			return;
 		}
-		deleteForward(unit);
+		deleteForward(resolvedUnit);
 	},
 	deleteFragment(direction) {
 		if (getOptions().isSuggesting) {
@@ -778,6 +858,14 @@ const getSuggestionProps = (editor, node, { id = nanoid(), createdAt = Date.now(
 //#region src/lib/transforms/rejectSuggestion.ts
 const rejectSuggestion = (editor, description) => {
 	editor.tf.withoutNormalizing(() => {
+		const inlineInsertElementEntries = [...editor.api.nodes({
+			at: [],
+			match: (n) => {
+				if (!ElementApi.isElement(n) || !editor.api.isInline(n)) return false;
+				const suggestionData = getInlineSuggestionData(n);
+				return suggestionData?.type === "insert" && suggestionData.id === description.suggestionId;
+			}
+		})];
 		[...editor.api.nodes({
 			at: [],
 			match: (n) => {
@@ -799,7 +887,7 @@ const rejectSuggestion = (editor, description) => {
 			at: [],
 			mode: "all",
 			match: (n) => {
-				if (TextApi.isText(n)) {
+				if (TextApi.isText(n) || ElementApi.isElement(n) && editor.api.isInline(n)) {
 					const suggestionData = getInlineSuggestionData(n);
 					if (suggestionData) return suggestionData.type === "remove" && suggestionData.id === description.suggestionId;
 					return false;
@@ -828,6 +916,9 @@ const rejectSuggestion = (editor, description) => {
 				return false;
 			}
 		});
+		inlineInsertElementEntries.reverse().forEach(([, path]) => {
+			editor.tf.removeNodes({ at: path });
+		});
 		[...editor.api.nodes({
 			at: [],
 			match: (n) => {
@@ -856,12 +947,16 @@ const rejectSuggestion = (editor, description) => {
 
 //#endregion
 //#region src/lib/diffToSuggestions.ts
-function diffToSuggestions(editor, doc0, doc1, { getDeleteProps = (node) => getSuggestionProps(editor, node, { suggestionDeletion: true }), getInsertProps = (node) => getSuggestionProps(editor, node), getUpdateProps = (node, _properties, newProperties) => getSuggestionProps(editor, node, { suggestionUpdate: newProperties }), isInline = editor.api.isInline, ...options } = {}) {
+function diffToSuggestions(editor, doc0, doc1, { getDeleteProps = (node, ctx) => getSuggestionProps(editor, node, {
+	id: ctx?.pairId,
+	suggestionDeletion: true
+}), getInsertProps = (node, ctx) => getSuggestionProps(editor, node, { id: ctx?.pairId }), getUpdateProps = (node, _properties, newProperties) => getSuggestionProps(editor, node, { suggestionUpdate: newProperties }), isInline = editor.api.isInline, generatePairId = () => nanoid(), ...options } = {}) {
 	const values = computeDiff(doc0, doc1, {
 		getDeleteProps,
 		getInsertProps,
 		getUpdateProps,
 		isInline,
+		generatePairId,
 		...options
 	});
 	const traverseNodes = (nodes) => {
@@ -877,35 +972,48 @@ function diffToSuggestions(editor, doc0, doc1, { getDeleteProps = (node) => getS
 	return traverseNodes(values);
 }
 /**
-* Unifies the ID of adjacent insert and remove suggestions. When an insert
-* suggestion follows a remove suggestion, the insert suggestion inherits the ID
-* and creation time from the remove suggestion. This allows the UI to treat
-* them as a single suggestion for display and interaction purposes.
+* Unifies the ID of adjacent insert and remove suggestions so the UI treats
+* them as a single reviewable change.
+*
+* Two orderings are handled:
+*
+*   - Remove → Insert (default / `delete-first` flush order):
+*     the insert leaf inherits the remove leaf's id + createdAt.
+*   - Insert → Remove (`insert-first` flush order):
+*     the remove leaf inherits the insert leaf's id + createdAt.
+*
+* Without this pass, the new-above-old presentation would emit two separate
+* suggestion groups for what is conceptually one change.
 */
 function unifyAdjacentSuggestionIds(node, index, nodes, editor) {
 	const api = editor.getApi(BaseSuggestionPlugin);
 	const currentNodeData = api.suggestion.suggestionData(node);
-	if (currentNodeData?.type === "insert") {
-		const previousNode = index > 0 ? nodes[index - 1] : null;
-		if (previousNode?.[KEYS.suggestion]) {
-			const previousData = api.suggestion.suggestionData(previousNode);
-			if (previousData?.type === "remove") {
-				const updatedNode = {
-					...node,
-					[getSuggestionKey(previousData.id)]: {
-						...currentNodeData,
-						id: previousData.id,
-						createdAt: previousData.createdAt
-					}
-				};
-				const key = getSuggestionKey(currentNodeData.id);
-				delete updatedNode[key];
-				return updatedNode;
-			}
-		}
+	if (!currentNodeData) return node;
+	const previousNode = index > 0 ? nodes[index - 1] : null;
+	index < nodes.length - 1 && nodes[index + 1];
+	if (currentNodeData.type === "insert" && previousNode?.[KEYS.suggestion]) {
+		const previousData = api.suggestion.suggestionData(previousNode);
+		if (previousData?.type === "remove") return rewriteSuggestionId(node, currentNodeData, previousData.id, previousData.createdAt);
+	}
+	if (currentNodeData.type === "remove" && previousNode?.[KEYS.suggestion]) {
+		const previousData = api.suggestion.suggestionData(previousNode);
+		if (previousData?.type === "insert") return rewriteSuggestionId(node, currentNodeData, previousData.id, previousData.createdAt);
 	}
 	return node;
 }
+function rewriteSuggestionId(node, currentNodeData, targetId, targetCreatedAt) {
+	const updatedNode = {
+		...node,
+		[getSuggestionKey(targetId)]: {
+			...currentNodeData,
+			id: targetId,
+			createdAt: targetCreatedAt
+		}
+	};
+	const oldKey = getSuggestionKey(currentNodeData.id);
+	if (oldKey !== getSuggestionKey(targetId)) delete updatedNode[oldKey];
+	return updatedNode;
+}
 
 //#endregion
 export { SkipSuggestionDeletes as A, getSuggestionUserIdByKey as C, getInlineSuggestionData as D, isSuggestionKey as E, getSuggestionKeyId as O, getSuggestionUserId as S, isCurrentUserSuggestion as T, getTransientSuggestionKey as _, BaseSuggestionPlugin as a, getSuggestionKey as b, removeMarkSuggestion as c, deleteFragmentSuggestion as d, deleteSuggestion as f, findInlineSuggestionNode as g, findSuggestionProps as h, acceptSuggestion as i, keyId2SuggestionId as k, insertTextSuggestion as l, addMarkSuggestion as m, rejectSuggestion as n, withSuggestion as o, setSuggestionNodes as p, getSuggestionProps as r, removeNodesSuggestion as s, diffToSuggestions as t, insertFragmentSuggestion as u, getActiveSuggestionDescriptions as v, getSuggestionUserIds as w, getSuggestionKeys as x, getSuggestionNodeEntries as y };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lofcz/platejs-suggestion",
-  "version": "53.0.0",
+  "version": "53.2.3",
   "description": "Plate plugin for suggestions",
   "keywords": [
     "plate",
@@ -31,14 +31,14 @@
   "dependencies": {
     "lodash": "^4.17.21",
     "react-compiler-runtime": "^1.0.0",
-    "@platejs/diff": "npm:@lofcz/platejs-diff@53.0.0"
+    "@platejs/diff": "npm:@lofcz/platejs-diff@53.1.3"
   },
   "devDependencies": {
     "@plate/scripts": "1.0.0",
-    "platejs": "npm:@lofcz/platejs@53.0.0"
+    "platejs": "npm:@lofcz/platejs@53.2.4"
   },
   "peerDependencies": {
-    "platejs": ">=53.0.0",
+    "platejs": ">=53.0.3",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0"
   },