@manuscripts/track-changes-plugin 1.6.1 → 1.7.0-LEAN-2850

package/dist/actions.d.ts

@@ -22,7 +22,8 @@ export declare enum TrackChangesAction {
     setPluginStatus = "track-changes-set-track-status",
     setChangeStatuses = "track-changes-set-change-statuses",
     refreshChanges = "track-changes-refresh-changes",
-    applyAndRemoveChanges = "track-changes-apply-remove-changes"
+    applyAndRemoveChanges = "track-changes-apply-remove-changes",
+    updateMetaNode = "track-changes-update-meta-node"
 }
 export declare type TrackChangesActionParams = {
     [TrackChangesAction.skipTrack]: boolean;
@@ -34,6 +35,7 @@ export declare type TrackChangesActionParams = {
     };
     [TrackChangesAction.refreshChanges]: boolean;
     [TrackChangesAction.applyAndRemoveChanges]: boolean;
+    [TrackChangesAction.updateMetaNode]: boolean;
 };
 /**
  * Gets the value of a meta field, action payload, of a defined track-changes action.

package/dist/index.cjs

@@ -19,6 +19,7 @@ var TrackChangesAction;
     TrackChangesAction["setChangeStatuses"] = "track-changes-set-change-statuses";
     TrackChangesAction["refreshChanges"] = "track-changes-refresh-changes";
     TrackChangesAction["applyAndRemoveChanges"] = "track-changes-apply-remove-changes";
+    TrackChangesAction["updateMetaNode"] = "track-changes-update-meta-node";
 })(TrackChangesAction || (TrackChangesAction = {}));
 /**
  * Gets the value of a meta field, action payload, of a defined track-changes action.
@@ -161,13 +162,14 @@ const enableDebug = (enabled) => {
     }
 };
 
-var _ChangeSet_changes;
+var _ChangeSet_instances, _ChangeSet_changes, _ChangeSet_isSameNodeChange, _ChangeSet_isNotPendingOrDeleted;
 /**
  * ChangeSet is a data structure to contain the tracked changes with some utility methods and computed
  * values to allow easier operability.
  */
 class ChangeSet {
     constructor(changes = []) {
+        _ChangeSet_instances.add(this);
         _ChangeSet_changes.set(this, void 0);
         __classPrivateFieldSet(this, _ChangeSet_changes, changes, "f");
     }
@@ -198,7 +200,10 @@ class ChangeSet {
                 rootNodes.push(currentNodeChange);
                 currentNodeChange = undefined;
             }
-            if (currentNodeChange && c.from < currentNodeChange.to) {
+            if (currentNodeChange &&
+                c.from < currentNodeChange.to &&
+                !(__classPrivateFieldGet(this, _ChangeSet_instances, "m", _ChangeSet_isSameNodeChange).call(this, currentNodeChange, c) &&
+                    __classPrivateFieldGet(this, _ChangeSet_instances, "m", _ChangeSet_isNotPendingOrDeleted).call(this, currentNodeChange))) {
                 currentNodeChange.children.push(c);
             }
             else if (c.type === 'node-change') {
@@ -320,7 +325,12 @@ class ChangeSet {
         return change.type === 'node-attr-change';
     }
 }
-_ChangeSet_changes = new WeakMap();
+_ChangeSet_changes = new WeakMap(), _ChangeSet_instances = new WeakSet(), _ChangeSet_isSameNodeChange = function _ChangeSet_isSameNodeChange(currentChange, nextChange) {
+    return currentChange.from === nextChange.from && currentChange.to === nextChange.to;
+}, _ChangeSet_isNotPendingOrDeleted = function _ChangeSet_isNotPendingOrDeleted(change) {
+    return (change.dataTracked.operation !== exports.CHANGE_OPERATION.delete &&
+        change.dataTracked.status !== exports.CHANGE_STATUS.pending);
+};
 
 /*!
  * © 2021 Atypon Systems LLC
@@ -1137,7 +1147,7 @@ function deleteAndMergeSplitNodes(from, to, gap, startDoc, newTr, schema, trackA
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-function trackReplaceAroundStep(step, oldState, newTr, attrs) {
+function trackReplaceAroundStep(step, oldState, tr, newTr, attrs) {
     log.info('###### ReplaceAroundStep ######');
     // @ts-ignore
     const { from, to, gapFrom, gapTo, insert, slice, structure, } = step;
@@ -1158,14 +1168,18 @@ function trackReplaceAroundStep(step, oldState, newTr, attrs) {
     log.info('DELETE STEPS: ', deleteSteps);
     // We only want to insert when there something inside the gap (actually would this be always true?)
     // or insert slice wasn't just start/end tokens (which we already merged inside deleteAndMergeSplitBlockNodes)
-    if (gap.size > 0 || (!structure && newSliceContent.size > 0)) {
+    // ^^answering above comment we could have meta node like(bibliography_item, contributor) will not have content at all,
+    // and that case gap will be 0, for that will use updateMetaNode to indicate that we are going just to update that node
+    if (gap.size > 0 ||
+        (!structure && newSliceContent.size > 0) ||
+        tr.getMeta(TrackChangesAction.updateMetaNode)) {
         log.info('newSliceContent', newSliceContent);
         // Since deleteAndMergeSplitBlockNodes modified the slice to not to contain any merged nodes,
         // the sides should be equal. TODO can they be other than 0?
         const openStart = slice.openStart !== slice.openEnd || newSliceContent.size === 0 ? 0 : slice.openStart;
         const openEnd = slice.openStart !== slice.openEnd || newSliceContent.size === 0 ? 0 : slice.openEnd;
         let insertedSlice = new prosemirrorModel.Slice(setFragmentAsInserted(newSliceContent, createNewInsertAttrs(attrs), oldState.schema), openStart, openEnd);
-        if (gap.size > 0) {
+        if (gap.size > 0 || tr.getMeta(TrackChangesAction.updateMetaNode)) {
             log.info('insertedSlice before inserted gap', insertedSlice);
             insertedSlice = insertedSlice.insertAt(insertedSlice.size === 0 ? 0 : insert, gap.content);
             log.info('insertedSlice after inserted gap', insertedSlice);
@@ -1432,8 +1446,11 @@ function processChangeSteps(changes, startPos, newTr, emptyAttrs, schema) {
                 }
                 : addTrackIdIfDoesntExist(createNewUpdateAttrs(emptyAttrs, 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)) {
+            if ((JSON.stringify(oldAttrs) !== JSON.stringify(c.newAttrs) ||
+                c.node.type === c.node.type.schema.nodes.citation) &&
+                !oldDataTracked.find((d) => (d.operation === exports.CHANGE_OPERATION.insert ||
+                    d.operation === exports.CHANGE_OPERATION.set_node_attributes) &&
+                    d.status === exports.CHANGE_STATUS.pending)) {
                 newDataTracked.push(newUpdate);
             }
             newTr.setNodeMarkup(mapping.map(c.pos), undefined, {
@@ -1724,7 +1741,7 @@ function trackTransaction(tr, oldState, newTr, authorID) {
             }
         }
         else if (step instanceof prosemirrorTransform.ReplaceAroundStep) {
-            let steps = trackReplaceAroundStep(step, oldState, newTr, emptyAttrs);
+            let steps = trackReplaceAroundStep(step, oldState, tr, newTr, emptyAttrs);
             const deleted = steps.filter((s) => s.type !== 'insert-slice');
             const inserted = steps.filter((s) => s.type === 'insert-slice');
             log.info('INSERT STEPS: ', inserted);

package/dist/index.js

@@ -11,6 +11,7 @@ var TrackChangesAction;
     TrackChangesAction["setChangeStatuses"] = "track-changes-set-change-statuses";
     TrackChangesAction["refreshChanges"] = "track-changes-refresh-changes";
     TrackChangesAction["applyAndRemoveChanges"] = "track-changes-apply-remove-changes";
+    TrackChangesAction["updateMetaNode"] = "track-changes-update-meta-node";
 })(TrackChangesAction || (TrackChangesAction = {}));
 /**
  * Gets the value of a meta field, action payload, of a defined track-changes action.
@@ -153,13 +154,14 @@ const enableDebug = (enabled) => {
     }
 };
 
-var _ChangeSet_changes;
+var _ChangeSet_instances, _ChangeSet_changes, _ChangeSet_isSameNodeChange, _ChangeSet_isNotPendingOrDeleted;
 /**
  * ChangeSet is a data structure to contain the tracked changes with some utility methods and computed
  * values to allow easier operability.
  */
 class ChangeSet {
     constructor(changes = []) {
+        _ChangeSet_instances.add(this);
         _ChangeSet_changes.set(this, void 0);
         __classPrivateFieldSet(this, _ChangeSet_changes, changes, "f");
     }
@@ -190,7 +192,10 @@ class ChangeSet {
                 rootNodes.push(currentNodeChange);
                 currentNodeChange = undefined;
             }
-            if (currentNodeChange && c.from < currentNodeChange.to) {
+            if (currentNodeChange &&
+                c.from < currentNodeChange.to &&
+                !(__classPrivateFieldGet(this, _ChangeSet_instances, "m", _ChangeSet_isSameNodeChange).call(this, currentNodeChange, c) &&
+                    __classPrivateFieldGet(this, _ChangeSet_instances, "m", _ChangeSet_isNotPendingOrDeleted).call(this, currentNodeChange))) {
                 currentNodeChange.children.push(c);
             }
             else if (c.type === 'node-change') {
@@ -312,7 +317,12 @@ class ChangeSet {
         return change.type === 'node-attr-change';
     }
 }
-_ChangeSet_changes = new WeakMap();
+_ChangeSet_changes = new WeakMap(), _ChangeSet_instances = new WeakSet(), _ChangeSet_isSameNodeChange = function _ChangeSet_isSameNodeChange(currentChange, nextChange) {
+    return currentChange.from === nextChange.from && currentChange.to === nextChange.to;
+}, _ChangeSet_isNotPendingOrDeleted = function _ChangeSet_isNotPendingOrDeleted(change) {
+    return (change.dataTracked.operation !== CHANGE_OPERATION.delete &&
+        change.dataTracked.status !== CHANGE_STATUS.pending);
+};
 
 /*!
  * © 2021 Atypon Systems LLC
@@ -1129,7 +1139,7 @@ function deleteAndMergeSplitNodes(from, to, gap, startDoc, newTr, schema, trackA
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-function trackReplaceAroundStep(step, oldState, newTr, attrs) {
+function trackReplaceAroundStep(step, oldState, tr, newTr, attrs) {
     log.info('###### ReplaceAroundStep ######');
     // @ts-ignore
     const { from, to, gapFrom, gapTo, insert, slice, structure, } = step;
@@ -1150,14 +1160,18 @@ function trackReplaceAroundStep(step, oldState, newTr, attrs) {
     log.info('DELETE STEPS: ', deleteSteps);
     // We only want to insert when there something inside the gap (actually would this be always true?)
     // or insert slice wasn't just start/end tokens (which we already merged inside deleteAndMergeSplitBlockNodes)
-    if (gap.size > 0 || (!structure && newSliceContent.size > 0)) {
+    // ^^answering above comment we could have meta node like(bibliography_item, contributor) will not have content at all,
+    // and that case gap will be 0, for that will use updateMetaNode to indicate that we are going just to update that node
+    if (gap.size > 0 ||
+        (!structure && newSliceContent.size > 0) ||
+        tr.getMeta(TrackChangesAction.updateMetaNode)) {
         log.info('newSliceContent', newSliceContent);
         // Since deleteAndMergeSplitBlockNodes modified the slice to not to contain any merged nodes,
         // the sides should be equal. TODO can they be other than 0?
         const openStart = slice.openStart !== slice.openEnd || newSliceContent.size === 0 ? 0 : slice.openStart;
         const openEnd = slice.openStart !== slice.openEnd || newSliceContent.size === 0 ? 0 : slice.openEnd;
         let insertedSlice = new Slice(setFragmentAsInserted(newSliceContent, createNewInsertAttrs(attrs), oldState.schema), openStart, openEnd);
-        if (gap.size > 0) {
+        if (gap.size > 0 || tr.getMeta(TrackChangesAction.updateMetaNode)) {
             log.info('insertedSlice before inserted gap', insertedSlice);
             insertedSlice = insertedSlice.insertAt(insertedSlice.size === 0 ? 0 : insert, gap.content);
             log.info('insertedSlice after inserted gap', insertedSlice);
@@ -1424,8 +1438,11 @@ function processChangeSteps(changes, startPos, newTr, emptyAttrs, schema) {
                 }
                 : addTrackIdIfDoesntExist(createNewUpdateAttrs(emptyAttrs, 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)) {
+            if ((JSON.stringify(oldAttrs) !== JSON.stringify(c.newAttrs) ||
+                c.node.type === c.node.type.schema.nodes.citation) &&
+                !oldDataTracked.find((d) => (d.operation === CHANGE_OPERATION.insert ||
+                    d.operation === CHANGE_OPERATION.set_node_attributes) &&
+                    d.status === CHANGE_STATUS.pending)) {
                 newDataTracked.push(newUpdate);
             }
             newTr.setNodeMarkup(mapping.map(c.pos), undefined, {
@@ -1716,7 +1733,7 @@ function trackTransaction(tr, oldState, newTr, authorID) {
             }
         }
         else if (step instanceof ReplaceAroundStep) {
-            let steps = trackReplaceAroundStep(step, oldState, newTr, emptyAttrs);
+            let steps = trackReplaceAroundStep(step, oldState, tr, newTr, emptyAttrs);
             const deleted = steps.filter((s) => s.type !== 'insert-slice');
             const inserted = steps.filter((s) => s.type === 'insert-slice');
             log.info('INSERT STEPS: ', inserted);

package/dist/steps/trackReplaceAroundStep.d.ts

@@ -2,4 +2,4 @@ import type { EditorState, Transaction } from 'prosemirror-state';
 import { ReplaceAroundStep } from 'prosemirror-transform';
 import { NewEmptyAttrs } from '../types/track';
 import { ChangeStep } from '../types/step';
-export declare function trackReplaceAroundStep(step: ReplaceAroundStep, oldState: EditorState, newTr: Transaction, attrs: NewEmptyAttrs): ChangeStep[];
+export declare function trackReplaceAroundStep(step: ReplaceAroundStep, oldState: EditorState, tr: Transaction, newTr: Transaction, attrs: NewEmptyAttrs): ChangeStep[];

package/package.json

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