@manuscripts/track-changes-plugin 1.5.2 → 1.6.1-LEAN-2737

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.
@@ -448,7 +449,8 @@ function deleteNode(node, pos, tr) {
     const resPos = tr.doc.resolve(pos);
     // Block nodes can be deleted by just removing their start token which should then merge the text
     // content to above node's content (if there is one)
-    const canMergeToNodeAbove = (resPos.parent !== tr.doc || resPos.nodeBefore) && node.isBlock && ((_a = node.firstChild) === null || _a === void 0 ? void 0 : _a.isText);
+    // this will work just for the node after the first child
+    const canMergeToNodeAbove = resPos.parent !== tr.doc && resPos.nodeBefore && node.isBlock && ((_a = node.firstChild) === null || _a === void 0 ? void 0 : _a.isText);
     if (canMergeToNodeAbove) {
         return tr.replaceWith(pos - 1, pos + 1, prosemirrorModel.Fragment.empty);
     }
@@ -509,9 +511,9 @@ function mergeNode(node, pos, tr) {
     if (prosemirrorTransform.canJoin(tr.doc, pos)) {
         return tr.join(pos);
     }
-    else if (prosemirrorTransform.canJoin(tr.doc, pos + node.nodeSize)) {
-        // TODO should copy the attributes from the merged node below
-        return tr.join(pos + node.nodeSize);
+    else if (!tr.doc.resolve(pos).nodeBefore) {
+        // for this case will just delete that node in `deleteNode.ts` as the join will not work
+        return undefined;
     }
     // TODO is this the same thing as join to above?
     const resPos = tr.doc.resolve(pos);
@@ -1136,7 +1138,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;
@@ -1157,14 +1159,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);
@@ -1200,6 +1206,7 @@ function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepD
     let selectionPos = 0, changeSteps = [];
     // Invert the transaction step to prevent it from actually deleting or inserting anything
     step.getMap().forEach((fromA, toA, fromB, toB) => {
+        var _a, _b;
         log.info(`changed ranges: ${fromA} ${toA} ${fromB} ${toB}`);
         const { slice } = step;
         log.info('TR: steps before applying delete', [...newTr.steps]);
@@ -1247,9 +1254,6 @@ function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepD
                 type: 'insert-slice',
                 from: textWasDeleted ? fromB : toA,
                 to: textWasDeleted ? toB - 1 : toA,
-                /* it's not entirely clear why using "fromB" is needed at all but in cases where there areno content deleted before
-                    - it will gointo infinite loop if toB -1 is used
-                */
                 sliceWasSplit,
                 slice: new prosemirrorModel.Slice(setFragmentAsInserted(newSliceContent, createNewInsertAttrs(attrs), oldState.schema), openStart, openEnd),
             });
@@ -1257,7 +1261,10 @@ function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepD
         else {
             // Incase only deletion was applied, check whether tracked marks around deleted content can be merged
             // mergeTrackedMarks(adjustedInsertPos, newTr.doc, newTr, oldState.schema)
-            selectionPos = fromA;
+            // When DEL is used, the selection is set to the end of the deleted content
+            // TODO: 'window.event' is deprecated, find a better way to detect the key used for deletion
+            // @ts-ignore
+            selectionPos = ((_a = window.event) === null || _a === void 0 ? void 0 : _a.code) === 'Delete' || ((_b = window.event) === null || _b === void 0 ? void 0 : _b.inputType) === 'deleteContentForward' ? toA : fromA;
         }
     });
     return [changeSteps, selectionPos];
@@ -1722,7 +1729,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.
@@ -440,7 +441,8 @@ function deleteNode(node, pos, tr) {
     const resPos = tr.doc.resolve(pos);
     // Block nodes can be deleted by just removing their start token which should then merge the text
     // content to above node's content (if there is one)
-    const canMergeToNodeAbove = (resPos.parent !== tr.doc || resPos.nodeBefore) && node.isBlock && ((_a = node.firstChild) === null || _a === void 0 ? void 0 : _a.isText);
+    // this will work just for the node after the first child
+    const canMergeToNodeAbove = resPos.parent !== tr.doc && resPos.nodeBefore && node.isBlock && ((_a = node.firstChild) === null || _a === void 0 ? void 0 : _a.isText);
     if (canMergeToNodeAbove) {
         return tr.replaceWith(pos - 1, pos + 1, Fragment.empty);
     }
@@ -501,9 +503,9 @@ function mergeNode(node, pos, tr) {
     if (canJoin(tr.doc, pos)) {
         return tr.join(pos);
     }
-    else if (canJoin(tr.doc, pos + node.nodeSize)) {
-        // TODO should copy the attributes from the merged node below
-        return tr.join(pos + node.nodeSize);
+    else if (!tr.doc.resolve(pos).nodeBefore) {
+        // for this case will just delete that node in `deleteNode.ts` as the join will not work
+        return undefined;
     }
     // TODO is this the same thing as join to above?
     const resPos = tr.doc.resolve(pos);
@@ -1128,7 +1130,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;
@@ -1149,14 +1151,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);
@@ -1192,6 +1198,7 @@ function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepD
     let selectionPos = 0, changeSteps = [];
     // Invert the transaction step to prevent it from actually deleting or inserting anything
     step.getMap().forEach((fromA, toA, fromB, toB) => {
+        var _a, _b;
         log.info(`changed ranges: ${fromA} ${toA} ${fromB} ${toB}`);
         const { slice } = step;
         log.info('TR: steps before applying delete', [...newTr.steps]);
@@ -1239,9 +1246,6 @@ function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepD
                 type: 'insert-slice',
                 from: textWasDeleted ? fromB : toA,
                 to: textWasDeleted ? toB - 1 : toA,
-                /* it's not entirely clear why using "fromB" is needed at all but in cases where there areno content deleted before
-                    - it will gointo infinite loop if toB -1 is used
-                */
                 sliceWasSplit,
                 slice: new Slice(setFragmentAsInserted(newSliceContent, createNewInsertAttrs(attrs), oldState.schema), openStart, openEnd),
             });
@@ -1249,7 +1253,10 @@ function trackReplaceStep(step, oldState, newTr, attrs, stepResult, currentStepD
         else {
             // Incase only deletion was applied, check whether tracked marks around deleted content can be merged
             // mergeTrackedMarks(adjustedInsertPos, newTr.doc, newTr, oldState.schema)
-            selectionPos = fromA;
+            // When DEL is used, the selection is set to the end of the deleted content
+            // TODO: 'window.event' is deprecated, find a better way to detect the key used for deletion
+            // @ts-ignore
+            selectionPos = ((_a = window.event) === null || _a === void 0 ? void 0 : _a.code) === 'Delete' || ((_b = window.event) === null || _b === void 0 ? void 0 : _b.inputType) === 'deleteContentForward' ? toA : fromA;
         }
     });
     return [changeSteps, selectionPos];
@@ -1714,7 +1721,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.5.2",
+  "version": "1.6.1-LEAN-2737",
   "author": "Atypon Systems LLC",
   "license": "Apache-2.0",
   "homepage": "https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/quarterback-packages/track-changes-plugin",
@@ -61,6 +61,7 @@
   "scripts": {
     "build": "rollup -c",
     "watch": "rollup -cw",
+    "dev": "yarn run watch",
     "test": "jest --runInBand",
     "format": "prettier --write \"*.+(js|json|yml|yaml|ts|md|graphql|mdx)\" src/ test/",
     "typecheck": "tsc --project tsconfig.test.json --noEmit",