@magic-marker/prosemirror-suggest-changes 0.3.3-wrap-unwrap.29 → 0.3.3-wrap-unwrap.30

package/dist/commands.js

@@ -5,6 +5,7 @@ import { suggestChangesKey } from "./plugin.js";
 import { getSuggestionMarks } from "./utils.js";
 import { ZWSP } from "./constants.js";
 import { maybeRevertJoinMark } from "./features/joinOnDelete/index.js";
+import { isJoinMark } from "./features/joinOnDelete/types.js";
 import { revertAllStructureSuggestions, revertStructureSuggestion } from "./features/wrapUnwrap/revert/index.js";
 import { applyAllStructureSuggestions, applyStructureSuggestion } from "./features/wrapUnwrap/apply/index.js";
 /**
@@ -65,7 +66,9 @@ import { applyAllStructureSuggestions, applyStructureSuggestion } from "./featur
             tr.removeMark(insertionFrom, insertionTo, markTypeToApply);
             const joinRevertResult = maybeRevertJoinMark(tr, insertionFrom, insertionTo, child, markTypeToApply);
             // reverting a join mark may produce new structure marks that were serialized in the join metadata
-            if (joinRevertResult) joinRevertResult.restoredStructureSuggestionIds.forEach((id)=>restoredStructureSuggestionIds.add(id));
+            if (joinRevertResult) {
+                joinRevertResult.restoredStructureSuggestionIds.forEach((id)=>restoredStructureSuggestionIds.add(id));
+            }
             if (!joinRevertResult && child.text === ZWSP) {
                 tr.delete(insertionFrom, insertionTo);
             }
@@ -78,6 +81,47 @@ import { applyAllStructureSuggestions, applyStructureSuggestion } from "./featur
         restoredStructureSuggestionIds
     };
 }
+/**
+ * Collect suggestion IDs of join marks in the node
+ *
+ * @param node
+ * @param deletion
+ * @returns an array of suggestion IDs
+ */ function findJoinSuggestionIds(node, deletion) {
+    const joinSuggestionIds = [];
+    node.descendants((child)=>{
+        const mark = deletion.isInSet(child.marks);
+        if (!mark || !isJoinMark(mark)) return true;
+        if (!child.isText || child.text !== ZWSP) return true;
+        joinSuggestionIds.push(mark.attrs.id);
+        return true;
+    });
+    return joinSuggestionIds.reverse();
+}
+/**
+ * Revert suggestions revealed by reverting a join mark
+ * Prioritize reverting revealed suggestions with the same id as the join mark
+ * (that means they are linked to the join mark and has to be reverted together as one)
+ * Revert other revealed suggestions as well so the user doesn't have to revert multiple times at the same place
+ *
+ * @param tr
+ * @param suggestionId
+ * @param restoredStructureSuggestionIds
+ */ function revertRestoredStructureSuggestions(tr, suggestionId, restoredStructureSuggestionIds) {
+    if (restoredStructureSuggestionIds.has(suggestionId)) {
+        const restoredStructureTransform = revertStructureSuggestion(tr.doc, suggestionId);
+        restoredStructureTransform.steps.forEach((step)=>{
+            tr.step(step);
+        });
+    }
+    restoredStructureSuggestionIds.forEach((restoredSuggestionId)=>{
+        if (restoredSuggestionId === suggestionId) return;
+        const restoredStructureTransform = revertStructureSuggestion(tr.doc, restoredSuggestionId);
+        restoredStructureTransform.steps.forEach((step)=>{
+            tr.step(step);
+        });
+    });
+}
 function revertModifications(node, pos, tr) {
     const { modification } = getSuggestionMarks(node.type.schema);
     const existingMods = node.marks.filter((mark)=>mark.type === modification);
@@ -291,7 +335,17 @@ export function applySuggestionsToRange(doc, from, to) {
     const { deletion, insertion } = getSuggestionMarks(state.schema);
     // create a structure transform that reverts all structure changes on the given document
     const structureTransform = revertAllStructureSuggestions(state.doc);
-    // then start a clear transform from the document where the structure changes are reverted
+    // revert all join marks first as well as any structure marks they contain serialized
+    const joinSuggestionIds = findJoinSuggestionIds(structureTransform.doc, deletion);
+    joinSuggestionIds.forEach((suggestionId)=>{
+        const suggestionsTransform = new Transform(structureTransform.doc);
+        const { restoredStructureSuggestionIds } = applySuggestionsToTransform(suggestionsTransform.doc, suggestionsTransform, deletion, insertion, suggestionId);
+        suggestionsTransform.steps.forEach((step)=>{
+            structureTransform.step(step);
+        });
+        revertRestoredStructureSuggestions(structureTransform, suggestionId, restoredStructureSuggestionIds);
+    });
+    // then start a clear transform from the document where the structure changes and join marks are reverted
     const suggestionsTransform = new Transform(structureTransform.doc);
     applySuggestionsToTransform(suggestionsTransform.doc, suggestionsTransform, deletion, insertion);
     applyModificationsToTransform(suggestionsTransform.doc, suggestionsTransform, -1);
@@ -370,19 +424,9 @@ export function applySuggestionsToRange(doc, from, to) {
         suggestionsTransform.steps.forEach((step)=>{
             structureTransform.step(step);
         });
-        if (restoredStructureSuggestionIds.has(suggestionId)) {
-            const restoredStructureTransform = revertStructureSuggestion(structureTransform.doc, suggestionId);
-            restoredStructureTransform.steps.forEach((step)=>{
-                structureTransform.step(step);
-            });
-        }
-        restoredStructureSuggestionIds.forEach((restoredSuggestionId)=>{
-            if (restoredSuggestionId === suggestionId) return;
-            const restoredStructureTransform = revertStructureSuggestion(structureTransform.doc, restoredSuggestionId);
-            restoredStructureTransform.steps.forEach((step)=>{
-                structureTransform.step(step);
-            });
-        });
+        // in case there are structure marks revealed after join mark revert,
+        // revert them as well
+        revertRestoredStructureSuggestions(structureTransform, suggestionId, restoredStructureSuggestionIds);
         // apply the structure transform to the transaction
         const transaction = state.tr;
         structureTransform.steps.forEach((step)=>{

package/dist/features/joinOnDelete/types.d.ts

@@ -1,4 +1,5 @@
 import { type Mark, type Attrs, type Node } from "prosemirror-model";
+import { type SuggestionId } from "../../generateId.js";
 export interface SerializedJoinNode {
     type: string;
     attrs: object;
@@ -7,6 +8,7 @@ export interface SerializedJoinNode {
     }[];
 }
 export interface JoinMarkAttrs {
+    id: SuggestionId;
     type: "join";
     data: {
         leftNode?: SerializedJoinNode;

package/dist/features/joinOnDelete/types.js

@@ -5,6 +5,9 @@ export function isSerializedJoinNode(node) {
     return typeof data.type === "string" && typeof data.attrs === "object" && data.attrs !== null && Array.isArray(data.marks);
 }
 export function isJoinMarkAttrs(attrs) {
+    if (typeof attrs["id"] !== "string" && typeof attrs["id"] !== "number") {
+        return false;
+    }
     if (attrs["type"] !== "join") return false;
     if (attrs["data"] == null) return false;
     return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic-marker/prosemirror-suggest-changes",
-  "version": "0.3.3-wrap-unwrap.29",
+  "version": "0.3.3-wrap-unwrap.30",
   "license": "MIT",
   "type": "module",
   "module": "dist/index.js",