@manuscripts/track-changes-plugin 1.7.0 → 1.7.1

package/dist/index.cjs

@@ -531,9 +531,7 @@ function updateChangeAttrs(tr, change, trackedAttrs, schema) {
         return tr;
     }
     const { operation } = trackedAttrs;
-    const oldTrackData = change.type === 'text-change'
-        ? getTextNodeTrackedMarkData(node, schema)
-        : getBlockInlineTrackedData(node);
+    const oldTrackData = change.type === 'text-change' ? getTextNodeTrackedMarkData(node, schema) : getBlockInlineTrackedData(node);
     if (!operation) {
         log.warn('updateChangeAttrs: unable to determine operation of change ', change);
     }
@@ -554,7 +552,15 @@ function updateChangeAttrs(tr, change, trackedAttrs, schema) {
         tr.setNodeMarkup(change.from, undefined, { ...node.attrs, dataTracked: null }, node.marks);
     }
     else if (change.type === 'node-change' || change.type === 'node-attr-change') {
-        const newDataTracked = (getBlockInlineTrackedData(node) || []).map((oldTrack) => {
+        const trackedDataSource = getBlockInlineTrackedData(node) || [];
+        const targetDataTracked = trackedDataSource.find((t) => change.id === t.id);
+        const newDataTracked = trackedDataSource.map((oldTrack) => {
+            if (targetDataTracked) {
+                if (oldTrack.id === targetDataTracked.id) {
+                    return { ...oldTrack, ...trackedAttrs };
+                }
+                return oldTrack;
+            }
             if (oldTrack.operation === operation) {
                 return { ...oldTrack, ...trackedAttrs };
             }
@@ -578,6 +584,13 @@ function updateChangeChildrenAttributes(changes, tr, mapping) {
     });
 }
 
+function getUpdatedDataTracked(dataTracked, changeId) {
+    if (!dataTracked) {
+        return null;
+    }
+    const newDataTracked = dataTracked.filter((c) => c.id !== changeId);
+    return newDataTracked.length ? newDataTracked : null;
+}
 /**
  * Applies the accepted/rejected changes in the current document and sets them untracked
  *
@@ -587,10 +600,12 @@ function updateChangeChildrenAttributes(changes, tr, mapping) {
  * @param deleteMap
  */
 function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new prosemirrorTransform.Mapping()) {
+    const attrsChangesLog = new Map(); // map of node ids and applied change updatedAt timestamp
+    function addAttrLog(nodeId, changeId) {
+        const arr = attrsChangesLog.get(nodeId) || attrsChangesLog.set(nodeId, []).get(nodeId);
+        arr.push(changeId);
+    }
     changes.forEach((change) => {
-        if (change.dataTracked.status === exports.CHANGE_STATUS.pending) {
-            return;
-        }
         // Map change.from and skip those which dont need to be applied
         // or were already deleted by an applied block delete
         const { pos: from, deleted } = deleteMap.mapResult(change.from), node = tr.doc.nodeAt(from), noChangeNeeded = deleted || !ChangeSet.shouldDeleteChange(change);
@@ -598,6 +613,22 @@ function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new prose
             !deleted && log.warn('no node found to update for change', change);
             return;
         }
+        if (change.dataTracked.status === exports.CHANGE_STATUS.pending) {
+            if (ChangeSet.isNodeAttrChange(change)) {
+                /*
+                  Apply pending changes for attributes as well because applying accepted/rejected changes may override
+                  pending because we store the most recent change directly on the node attributes. But in case of pending attributes
+                  we don't need to remove dataTracked record. We need, however, to make sure we don't restore dataTracked records for
+                  the previously applied changes. To check for already applied changes we log them into "attrsChangesLog" Map.
+                */
+                const { dataTracked, ...attrs } = change.newAttrs;
+                const changeLog = attrsChangesLog.get(node.attrs.id);
+                const newDataTracked = changeLog && changeLog.length ? dataTracked.filter((c) => !changeLog.includes(c.id)) : dataTracked;
+                tr.setNodeMarkup(from, undefined, { ...attrs, dataTracked: newDataTracked.length ? newDataTracked : null }, node.marks);
+                // default is "null" for dataTracked in attrs in pm schema, so codebase generally relies on it being null when empty
+            }
+            return;
+        }
         if (ChangeSet.isTextChange(change) && noChangeNeeded) {
             tr.removeMark(from, deleteMap.map(change.to), schema.marks.tracked_insert);
             tr.removeMark(from, deleteMap.map(change.to), schema.marks.tracked_delete);
@@ -621,13 +652,13 @@ function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new prose
             }
             deleteMap.appendMap(tr.steps[tr.steps.length - 1].getMap());
         }
-        else if (ChangeSet.isNodeAttrChange(change) &&
-            change.dataTracked.status === exports.CHANGE_STATUS.accepted) {
-            tr.setNodeMarkup(from, undefined, { ...node.attrs, dataTracked: null }, node.marks);
+        else if (ChangeSet.isNodeAttrChange(change) && change.dataTracked.status === exports.CHANGE_STATUS.accepted) {
+            tr.setNodeMarkup(from, undefined, { ...change.newAttrs, dataTracked: getUpdatedDataTracked(node.attrs.dataTracked, change.id) }, node.marks);
+            addAttrLog(node.attrs.id, change.dataTracked.id);
         }
-        else if (ChangeSet.isNodeAttrChange(change) &&
-            change.dataTracked.status === exports.CHANGE_STATUS.rejected) {
-            tr.setNodeMarkup(from, undefined, { ...change.oldAttrs, dataTracked: null }, node.marks);
+        else if (ChangeSet.isNodeAttrChange(change) && change.dataTracked.status === exports.CHANGE_STATUS.rejected) {
+            tr.setNodeMarkup(from, undefined, { ...change.oldAttrs, dataTracked: getUpdatedDataTracked(node.attrs.dataTracked, change.id) }, node.marks);
+            addAttrLog(node.attrs.id, change.dataTracked.id);
         }
     });
     return deleteMap;
@@ -952,7 +983,7 @@ function createNewUpdateAttrs(attrs, oldAttrs) {
     return {
         ...attrs,
         operation: exports.CHANGE_OPERATION.set_node_attributes,
-        oldAttrs: restAttrs,
+        oldAttrs: JSON.parse(JSON.stringify(restAttrs)),
     };
 }
 
@@ -1203,7 +1234,8 @@ function trackReplaceAroundStep(step, oldState, tr, newTr, attrs) {
  */
 function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepDoc) {
     log.info('###### ReplaceStep ######');
-    let selectionPos = 0, changeSteps = [];
+    let selectionPos = 0;
+    const changeSteps = [];
     // Invert the transaction step to prevent it from actually deleting or inserting anything
     step.getMap().forEach((fromA, toA, fromB, toB) => {
         var _a, _b;
@@ -1427,15 +1459,29 @@ function processChangeSteps(changes, startPos, newTr, emptyAttrs, schema) {
         }
         else if (c.type === 'update-node-attrs') {
             const oldDataTracked = getBlockInlineTrackedData(c.node) || [];
-            const oldUpdate = oldDataTracked.find((d) => d.operation === exports.CHANGE_OPERATION.set_node_attributes && d.status === exports.CHANGE_STATUS.pending);
-            const { dataTracked, ...oldAttrs } = (oldUpdate === null || oldUpdate === void 0 ? void 0 : oldUpdate.oldAttrs) || c.node.attrs;
-            const newDataTracked = [...oldDataTracked.filter((d) => !oldUpdate || d.id !== oldUpdate.id)];
-            const newUpdate = oldUpdate
+            const oldUpdate = oldDataTracked.reverse().find((d) => {
+                // reversing to start from the most recent change
+                if (d.operation === exports.CHANGE_OPERATION.set_node_attributes &&
+                    (d.status === exports.CHANGE_STATUS.pending || d.status === exports.CHANGE_STATUS.rejected)) {
+                    return true;
+                }
+                return false;
+            });
+            // if the selected last change is with status "rejected" we need to use oldAttrs from it because
+            // node's actual attributes represent the "rejected" values
+            const lastChangeRejected = oldUpdate && oldUpdate.status === exports.CHANGE_STATUS.rejected;
+            const sourceAttrs = (oldUpdate === null || oldUpdate === void 0 ? void 0 : oldUpdate.oldAttrs) || c.node.attrs;
+            const { dataTracked, ...restAttrs } = sourceAttrs;
+            const oldAttrs = lastChangeRejected ? oldUpdate.oldAttrs : restAttrs;
+            const newDataTracked = [
+                ...oldDataTracked.filter((d) => !oldUpdate || d.id !== oldUpdate.id || lastChangeRejected),
+            ];
+            const newUpdate = oldUpdate && oldUpdate.status !== exports.CHANGE_STATUS.rejected
                 ? {
                     ...oldUpdate,
                     updatedAt: emptyAttrs.updatedAt,
                 }
-                : addTrackIdIfDoesntExist(createNewUpdateAttrs(emptyAttrs, c.node.attrs));
+                : addTrackIdIfDoesntExist(createNewUpdateAttrs(emptyAttrs, lastChangeRejected ? oldAttrs : c.node.attrs));
             // Dont add update changes if there exists already an insert change for this node
             if (JSON.stringify(oldAttrs) !== JSON.stringify(c.newAttrs) &&
                 !oldDataTracked.find((d) => d.operation === exports.CHANGE_OPERATION.insert)) {
@@ -1849,9 +1895,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
         },
         appendTransaction(trs, oldState, newState) {
             const pluginState = trackChangesPluginKey.getState(newState);
-            if (!pluginState ||
-                pluginState.status === exports.TrackChangesStatus.disabled ||
-                !(editorView === null || editorView === void 0 ? void 0 : editorView.editable)) {
+            if (!pluginState || pluginState.status === exports.TrackChangesStatus.disabled || !(editorView === null || editorView === void 0 ? void 0 : editorView.editable)) {
                 return null;
             }
             const { userID, changeSet } = pluginState;
@@ -1860,13 +1904,8 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
             trs.forEach((tr) => {
                 const wasAppended = tr.getMeta('appendedTransaction');
                 const skipMetaUsed = skipTrsWithMetas.some((m) => tr.getMeta(m) || (wasAppended === null || wasAppended === void 0 ? void 0 : wasAppended.getMeta(m)));
-                const skipTrackUsed = getAction(tr, TrackChangesAction.skipTrack) ||
-                    (wasAppended && getAction(wasAppended, TrackChangesAction.skipTrack));
-                if (tr.docChanged &&
-                    !skipMetaUsed &&
-                    !skipTrackUsed &&
-                    !tr.getMeta('history$') &&
-                    !(wasAppended && tr.getMeta('origin') === 'paragraphs')) {
+                const skipTrackUsed = getAction(tr, TrackChangesAction.skipTrack) || (wasAppended && getAction(wasAppended, TrackChangesAction.skipTrack));
+                if (tr.docChanged && !skipMetaUsed && !skipTrackUsed && !tr.getMeta('history$') && !(wasAppended && tr.getMeta('origin') === 'paragraphs')) {
                     createdTr = trackTransaction(tr, oldState, createdTr, userID);
                 }
                 docChanged = docChanged || tr.docChanged;
@@ -1886,8 +1925,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                     setAction(createdTr, TrackChangesAction.refreshChanges, true);
                 }
             });
-            const changed = pluginState.changeSet.hasInconsistentData &&
-                fixInconsistentChanges(pluginState.changeSet, userID, createdTr, oldState.schema);
+            const changed = pluginState.changeSet.hasInconsistentData && fixInconsistentChanges(pluginState.changeSet, userID, createdTr, oldState.schema);
             if (changed) {
                 log.warn('had to fix inconsistent changes in', createdTr);
             }

package/dist/index.js

@@ -523,9 +523,7 @@ function updateChangeAttrs(tr, change, trackedAttrs, schema) {
         return tr;
     }
     const { operation } = trackedAttrs;
-    const oldTrackData = change.type === 'text-change'
-        ? getTextNodeTrackedMarkData(node, schema)
-        : getBlockInlineTrackedData(node);
+    const oldTrackData = change.type === 'text-change' ? getTextNodeTrackedMarkData(node, schema) : getBlockInlineTrackedData(node);
     if (!operation) {
         log.warn('updateChangeAttrs: unable to determine operation of change ', change);
     }
@@ -546,7 +544,15 @@ function updateChangeAttrs(tr, change, trackedAttrs, schema) {
         tr.setNodeMarkup(change.from, undefined, { ...node.attrs, dataTracked: null }, node.marks);
     }
     else if (change.type === 'node-change' || change.type === 'node-attr-change') {
-        const newDataTracked = (getBlockInlineTrackedData(node) || []).map((oldTrack) => {
+        const trackedDataSource = getBlockInlineTrackedData(node) || [];
+        const targetDataTracked = trackedDataSource.find((t) => change.id === t.id);
+        const newDataTracked = trackedDataSource.map((oldTrack) => {
+            if (targetDataTracked) {
+                if (oldTrack.id === targetDataTracked.id) {
+                    return { ...oldTrack, ...trackedAttrs };
+                }
+                return oldTrack;
+            }
             if (oldTrack.operation === operation) {
                 return { ...oldTrack, ...trackedAttrs };
             }
@@ -570,6 +576,13 @@ function updateChangeChildrenAttributes(changes, tr, mapping) {
     });
 }
 
+function getUpdatedDataTracked(dataTracked, changeId) {
+    if (!dataTracked) {
+        return null;
+    }
+    const newDataTracked = dataTracked.filter((c) => c.id !== changeId);
+    return newDataTracked.length ? newDataTracked : null;
+}
 /**
  * Applies the accepted/rejected changes in the current document and sets them untracked
  *
@@ -579,10 +592,12 @@ function updateChangeChildrenAttributes(changes, tr, mapping) {
  * @param deleteMap
  */
 function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new Mapping()) {
+    const attrsChangesLog = new Map(); // map of node ids and applied change updatedAt timestamp
+    function addAttrLog(nodeId, changeId) {
+        const arr = attrsChangesLog.get(nodeId) || attrsChangesLog.set(nodeId, []).get(nodeId);
+        arr.push(changeId);
+    }
     changes.forEach((change) => {
-        if (change.dataTracked.status === CHANGE_STATUS.pending) {
-            return;
-        }
         // Map change.from and skip those which dont need to be applied
         // or were already deleted by an applied block delete
         const { pos: from, deleted } = deleteMap.mapResult(change.from), node = tr.doc.nodeAt(from), noChangeNeeded = deleted || !ChangeSet.shouldDeleteChange(change);
@@ -590,6 +605,22 @@ function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new Mappi
             !deleted && log.warn('no node found to update for change', change);
             return;
         }
+        if (change.dataTracked.status === CHANGE_STATUS.pending) {
+            if (ChangeSet.isNodeAttrChange(change)) {
+                /*
+                  Apply pending changes for attributes as well because applying accepted/rejected changes may override
+                  pending because we store the most recent change directly on the node attributes. But in case of pending attributes
+                  we don't need to remove dataTracked record. We need, however, to make sure we don't restore dataTracked records for
+                  the previously applied changes. To check for already applied changes we log them into "attrsChangesLog" Map.
+                */
+                const { dataTracked, ...attrs } = change.newAttrs;
+                const changeLog = attrsChangesLog.get(node.attrs.id);
+                const newDataTracked = changeLog && changeLog.length ? dataTracked.filter((c) => !changeLog.includes(c.id)) : dataTracked;
+                tr.setNodeMarkup(from, undefined, { ...attrs, dataTracked: newDataTracked.length ? newDataTracked : null }, node.marks);
+                // default is "null" for dataTracked in attrs in pm schema, so codebase generally relies on it being null when empty
+            }
+            return;
+        }
         if (ChangeSet.isTextChange(change) && noChangeNeeded) {
             tr.removeMark(from, deleteMap.map(change.to), schema.marks.tracked_insert);
             tr.removeMark(from, deleteMap.map(change.to), schema.marks.tracked_delete);
@@ -613,13 +644,13 @@ function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new Mappi
             }
             deleteMap.appendMap(tr.steps[tr.steps.length - 1].getMap());
         }
-        else if (ChangeSet.isNodeAttrChange(change) &&
-            change.dataTracked.status === CHANGE_STATUS.accepted) {
-            tr.setNodeMarkup(from, undefined, { ...node.attrs, dataTracked: null }, node.marks);
+        else if (ChangeSet.isNodeAttrChange(change) && change.dataTracked.status === CHANGE_STATUS.accepted) {
+            tr.setNodeMarkup(from, undefined, { ...change.newAttrs, dataTracked: getUpdatedDataTracked(node.attrs.dataTracked, change.id) }, node.marks);
+            addAttrLog(node.attrs.id, change.dataTracked.id);
         }
-        else if (ChangeSet.isNodeAttrChange(change) &&
-            change.dataTracked.status === CHANGE_STATUS.rejected) {
-            tr.setNodeMarkup(from, undefined, { ...change.oldAttrs, dataTracked: null }, node.marks);
+        else if (ChangeSet.isNodeAttrChange(change) && change.dataTracked.status === CHANGE_STATUS.rejected) {
+            tr.setNodeMarkup(from, undefined, { ...change.oldAttrs, dataTracked: getUpdatedDataTracked(node.attrs.dataTracked, change.id) }, node.marks);
+            addAttrLog(node.attrs.id, change.dataTracked.id);
         }
     });
     return deleteMap;
@@ -944,7 +975,7 @@ function createNewUpdateAttrs(attrs, oldAttrs) {
     return {
         ...attrs,
         operation: CHANGE_OPERATION.set_node_attributes,
-        oldAttrs: restAttrs,
+        oldAttrs: JSON.parse(JSON.stringify(restAttrs)),
     };
 }
 
@@ -1195,7 +1226,8 @@ function trackReplaceAroundStep(step, oldState, tr, newTr, attrs) {
  */
 function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepDoc) {
     log.info('###### ReplaceStep ######');
-    let selectionPos = 0, changeSteps = [];
+    let selectionPos = 0;
+    const changeSteps = [];
     // Invert the transaction step to prevent it from actually deleting or inserting anything
     step.getMap().forEach((fromA, toA, fromB, toB) => {
         var _a, _b;
@@ -1419,15 +1451,29 @@ function processChangeSteps(changes, startPos, newTr, emptyAttrs, schema) {
         }
         else if (c.type === 'update-node-attrs') {
             const oldDataTracked = getBlockInlineTrackedData(c.node) || [];
-            const oldUpdate = oldDataTracked.find((d) => d.operation === CHANGE_OPERATION.set_node_attributes && d.status === CHANGE_STATUS.pending);
-            const { dataTracked, ...oldAttrs } = (oldUpdate === null || oldUpdate === void 0 ? void 0 : oldUpdate.oldAttrs) || c.node.attrs;
-            const newDataTracked = [...oldDataTracked.filter((d) => !oldUpdate || d.id !== oldUpdate.id)];
-            const newUpdate = oldUpdate
+            const oldUpdate = oldDataTracked.reverse().find((d) => {
+                // reversing to start from the most recent change
+                if (d.operation === CHANGE_OPERATION.set_node_attributes &&
+                    (d.status === CHANGE_STATUS.pending || d.status === CHANGE_STATUS.rejected)) {
+                    return true;
+                }
+                return false;
+            });
+            // if the selected last change is with status "rejected" we need to use oldAttrs from it because
+            // node's actual attributes represent the "rejected" values
+            const lastChangeRejected = oldUpdate && oldUpdate.status === CHANGE_STATUS.rejected;
+            const sourceAttrs = (oldUpdate === null || oldUpdate === void 0 ? void 0 : oldUpdate.oldAttrs) || c.node.attrs;
+            const { dataTracked, ...restAttrs } = sourceAttrs;
+            const oldAttrs = lastChangeRejected ? oldUpdate.oldAttrs : restAttrs;
+            const newDataTracked = [
+                ...oldDataTracked.filter((d) => !oldUpdate || d.id !== oldUpdate.id || lastChangeRejected),
+            ];
+            const newUpdate = oldUpdate && oldUpdate.status !== CHANGE_STATUS.rejected
                 ? {
                     ...oldUpdate,
                     updatedAt: emptyAttrs.updatedAt,
                 }
-                : addTrackIdIfDoesntExist(createNewUpdateAttrs(emptyAttrs, c.node.attrs));
+                : addTrackIdIfDoesntExist(createNewUpdateAttrs(emptyAttrs, lastChangeRejected ? oldAttrs : c.node.attrs));
             // Dont add update changes if there exists already an insert change for this node
             if (JSON.stringify(oldAttrs) !== JSON.stringify(c.newAttrs) &&
                 !oldDataTracked.find((d) => d.operation === CHANGE_OPERATION.insert)) {
@@ -1841,9 +1887,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
         },
         appendTransaction(trs, oldState, newState) {
             const pluginState = trackChangesPluginKey.getState(newState);
-            if (!pluginState ||
-                pluginState.status === TrackChangesStatus.disabled ||
-                !(editorView === null || editorView === void 0 ? void 0 : editorView.editable)) {
+            if (!pluginState || pluginState.status === TrackChangesStatus.disabled || !(editorView === null || editorView === void 0 ? void 0 : editorView.editable)) {
                 return null;
             }
             const { userID, changeSet } = pluginState;
@@ -1852,13 +1896,8 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
             trs.forEach((tr) => {
                 const wasAppended = tr.getMeta('appendedTransaction');
                 const skipMetaUsed = skipTrsWithMetas.some((m) => tr.getMeta(m) || (wasAppended === null || wasAppended === void 0 ? void 0 : wasAppended.getMeta(m)));
-                const skipTrackUsed = getAction(tr, TrackChangesAction.skipTrack) ||
-                    (wasAppended && getAction(wasAppended, TrackChangesAction.skipTrack));
-                if (tr.docChanged &&
-                    !skipMetaUsed &&
-                    !skipTrackUsed &&
-                    !tr.getMeta('history$') &&
-                    !(wasAppended && tr.getMeta('origin') === 'paragraphs')) {
+                const skipTrackUsed = getAction(tr, TrackChangesAction.skipTrack) || (wasAppended && getAction(wasAppended, TrackChangesAction.skipTrack));
+                if (tr.docChanged && !skipMetaUsed && !skipTrackUsed && !tr.getMeta('history$') && !(wasAppended && tr.getMeta('origin') === 'paragraphs')) {
                     createdTr = trackTransaction(tr, oldState, createdTr, userID);
                 }
                 docChanged = docChanged || tr.docChanged;
@@ -1878,8 +1917,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                     setAction(createdTr, TrackChangesAction.refreshChanges, true);
                 }
             });
-            const changed = pluginState.changeSet.hasInconsistentData &&
-                fixInconsistentChanges(pluginState.changeSet, userID, createdTr, oldState.schema);
+            const changed = pluginState.changeSet.hasInconsistentData && fixInconsistentChanges(pluginState.changeSet, userID, createdTr, oldState.schema);
             if (changed) {
                 log.warn('had to fix inconsistent changes in', createdTr);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manuscripts/track-changes-plugin",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "author": "Atypon Systems LLC",
   "license": "Apache-2.0",
   "homepage": "https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/quarterback-packages/track-changes-plugin",