@manuscripts/track-changes-plugin 0.0.2 → 0.1.1

package/README.md

@@ -40,16 +40,16 @@ Enable or disable the plugin with:
 import { trackCommands, TrackChangesStatus } from '@manuscripts/track-changes-plugin'
 
 // toggle
-cmd(view.state, view.dispatch, view)(trackCommands.setTrackingStatus())
+trackCommands.setTrackingStatus())(view.state, view.dispatch, view)
 
 // enable
-cmd(view.state, view.dispatch, view)(trackCommands.setTrackingStatus(TrackChangesStatus.enabled))
+trackCommands.setTrackingStatus(TrackChangesStatus.enabled))(view.state, view.dispatch, view)
 
 // disable
-cmd(view.state, view.dispatch, view)(trackCommands.setTrackingStatus(TrackChangesStatus.disabled))
+trackCommands.setTrackingStatus(TrackChangesStatus.disabled))(view.state, view.dispatch, view)
 
 // sets editor's 'editable' prop to false, making it ready-only
-cmd(view.state, view.dispatch, view)(trackCommands.setTrackingStatus(TrackChangesStatus.viewSnapshots))
+trackCommands.setTrackingStatus(TrackChangesStatus.viewSnapshots))(view.state, view.dispatch, view)
 ```
 
 See an example app at https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/examples-packages/client

package/dist/index.es.js

@@ -327,8 +327,9 @@ function deleteNode(node, pos, tr) {
     var _a;
     const startPos = tr.doc.resolve(pos + 1);
     const range = startPos.blockRange(tr.doc.resolve(startPos.pos - 2 + node.nodeSize));
-    const targetDepth = range ? Number(liftTarget(range)) : NaN;
-    if (range && !Number.isNaN(targetDepth)) {
+    const targetDepth = range && liftTarget(range);
+    // Check with typeof since with old prosemirror-transform targetDepth is undefined
+    if (range && typeof targetDepth === 'number') {
         return tr.lift(range, targetDepth);
     }
     const resPos = tr.doc.resolve(pos);
@@ -501,9 +502,11 @@ function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new Mappi
         if (change.attrs.status === CHANGE_STATUS.pending) {
             return;
         }
-        const from = deleteMap.map(change.from), node = tr.doc.nodeAt(from), noChangeNeeded = ChangeSet.shouldNotDelete(change);
+        // 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.shouldNotDelete(change);
         if (!node) {
-            log.warn('no node found to update for change', change);
+            !deleted && log.warn('no node found to update for change', change);
             return;
         }
         if (ChangeSet.isTextChange(change) && noChangeNeeded) {
@@ -927,6 +930,7 @@ function deleteAndMergeSplitNodes(from, to, gap, startDoc, newTr, schema, trackA
         // But from what I remember what it safeguards against is, when you've already deleted a node
         // say an inserted blockquote that had all its children deleted, nodesBetween still iterates over those
         // nodes and therefore we have to make this check to ensure they still exist in the doc.
+        //
         if (nodeEnd > offsetFrom && !nodeWasDeleted && !wasWithinGap) {
             // |<p>asdf</p>| -> node deleted completely
             const nodeCompletelyDeleted = offsetPos >= offsetFrom && nodeEnd <= offsetTo;
@@ -1207,11 +1211,9 @@ function trackReplaceStep(step, oldState, newTr, attrs) {
  * This skips the direct dependency to prosemirror-state where multiple versions might cause conflicts
  * as the created instances might belong to different prosemirror-state import than one used in the editor.
  * @param sel
- * @param doc
- * @param from
  * @returns
  */
-const getSelectionStaticCreate = (sel, doc, from) => Object.getPrototypeOf(sel).constructor.create(doc, from);
+const getSelectionStaticConstructor = (sel) => Object.getPrototypeOf(sel).constructor;
 /**
  * Inverts transactions to wrap their contents/operations with track data instead
  *
@@ -1255,7 +1257,12 @@ function trackTransaction(tr, oldState, newTr, userID) {
         else if (step instanceof ReplaceStep) {
             const selectionPos = trackReplaceStep(step, oldState, newTr, emptyAttrs);
             if (!wasNodeSelection) {
-                newTr.setSelection(getSelectionStaticCreate(tr.selection, newTr.doc, selectionPos));
+                const sel = getSelectionStaticConstructor(tr.selection);
+                // Use Selection.near to fix selections that point to a block node instead of inline content
+                // eg when inserting a complete new paragraph. -1 finds the first valid position moving backwards
+                // inside the content
+                const near = sel.near(newTr.doc.resolve(selectionPos), -1);
+                newTr.setSelection(near);
             }
         }
         else if (step instanceof ReplaceAroundStep) {
@@ -1266,13 +1273,12 @@ function trackTransaction(tr, oldState, newTr, userID) {
         // TODO: here we could check whether adjacent inserts & deletes cancel each other out.
         // However, this should not be done by diffing and only matching node or char by char instead since
         // it's A easier and B more intuitive to user.
-        const { meta } = tr;
-        // This is quite non-optimal in some sense but to ensure no information is lost
-        // we have to re-add all the old meta keys, such as inputType or uiEvent.
-        // This should prevent bugs incase other plugins/widgets rely upon them existing (and they
-        // are not able to process the transactions before track-changes).
-        // TODO: will this cause race-condition if a meta causes another appendTransaction to fire
-        Object.keys(meta).forEach((key) => newTr.setMeta(key, tr.getMeta(key)));
+        // The old meta keys are not copied to the new transaction since this will cause race-conditions
+        // when a single meta-field is expected to having been processed / removed. Generic input meta keys,
+        // inputType and uiEvent, are re-added since some plugins might depend on them and process the transaction
+        // after track-changes plugin.
+        tr.getMeta('inputType') && newTr.setMeta('inputType', tr.getMeta('inputType'));
+        tr.getMeta('uiEvent') && newTr.setMeta('uiEvent', tr.getMeta('uiEvent'));
     });
     // This is kinda hacky solution at the moment to maintain NodeSelections over transactions
     // These are required by at least cross-references that need it to activate the selector pop-up
@@ -1280,7 +1286,8 @@ function trackTransaction(tr, oldState, newTr, userID) {
         const mappedPos = newTr.mapping.map(tr.selection.from);
         const resPos = newTr.doc.resolve(mappedPos);
         const nodePos = mappedPos - (((_a = resPos.nodeBefore) === null || _a === void 0 ? void 0 : _a.nodeSize) || 0);
-        newTr.setSelection(getSelectionStaticCreate(tr.selection, newTr.doc, nodePos));
+        const sel = getSelectionStaticConstructor(tr.selection);
+        newTr.setSelection(sel.create(newTr.doc, nodePos));
     }
     log.info('NEW transaction', newTr);
     return newTr;
@@ -1330,7 +1337,8 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
         key: trackChangesPluginKey,
         props: {
             editable(state) {
-                return this.getState(state).status !== TrackChangesStatus.viewSnapshots;
+                var _a;
+                return ((_a = trackChangesPluginKey.getState(state)) === null || _a === void 0 ? void 0 : _a.status) !== TrackChangesStatus.viewSnapshots;
             },
         },
         state: {
@@ -1400,7 +1408,6 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                     (wasAppended && getAction(wasAppended, TrackChangesAction.skipTrack));
                 if (tr.docChanged && !skipMetaUsed && !skipTrackUsed && !tr.getMeta('history$')) {
                     createdTr = trackTransaction(tr, oldState, createdTr, userID);
-                    createdTr.setMeta('origin', trackChangesPluginKey);
                     infiniteLoopCounter.iters += 1;
                 }
                 docChanged = docChanged || tr.docChanged;
@@ -1427,6 +1434,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                 log.warn('had to fix inconsistent changes in', createdTr);
             }
             if (docChanged || createdTr.docChanged || changed) {
+                createdTr.setMeta('origin', trackChangesPluginKey);
                 return setAction(createdTr, TrackChangesAction.refreshChanges, true);
             }
             return null;

package/dist/index.js

@@ -335,8 +335,9 @@ function deleteNode(node, pos, tr) {
     var _a;
     const startPos = tr.doc.resolve(pos + 1);
     const range = startPos.blockRange(tr.doc.resolve(startPos.pos - 2 + node.nodeSize));
-    const targetDepth = range ? Number(prosemirrorTransform.liftTarget(range)) : NaN;
-    if (range && !Number.isNaN(targetDepth)) {
+    const targetDepth = range && prosemirrorTransform.liftTarget(range);
+    // Check with typeof since with old prosemirror-transform targetDepth is undefined
+    if (range && typeof targetDepth === 'number') {
         return tr.lift(range, targetDepth);
     }
     const resPos = tr.doc.resolve(pos);
@@ -509,9 +510,11 @@ function applyAcceptedRejectedChanges(tr, schema, changes, deleteMap = new prose
         if (change.attrs.status === exports.CHANGE_STATUS.pending) {
             return;
         }
-        const from = deleteMap.map(change.from), node = tr.doc.nodeAt(from), noChangeNeeded = ChangeSet.shouldNotDelete(change);
+        // 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.shouldNotDelete(change);
         if (!node) {
-            log.warn('no node found to update for change', change);
+            !deleted && log.warn('no node found to update for change', change);
             return;
         }
         if (ChangeSet.isTextChange(change) && noChangeNeeded) {
@@ -935,6 +938,7 @@ function deleteAndMergeSplitNodes(from, to, gap, startDoc, newTr, schema, trackA
         // But from what I remember what it safeguards against is, when you've already deleted a node
         // say an inserted blockquote that had all its children deleted, nodesBetween still iterates over those
         // nodes and therefore we have to make this check to ensure they still exist in the doc.
+        //
         if (nodeEnd > offsetFrom && !nodeWasDeleted && !wasWithinGap) {
             // |<p>asdf</p>| -> node deleted completely
             const nodeCompletelyDeleted = offsetPos >= offsetFrom && nodeEnd <= offsetTo;
@@ -1215,11 +1219,9 @@ function trackReplaceStep(step, oldState, newTr, attrs) {
  * This skips the direct dependency to prosemirror-state where multiple versions might cause conflicts
  * as the created instances might belong to different prosemirror-state import than one used in the editor.
  * @param sel
- * @param doc
- * @param from
  * @returns
  */
-const getSelectionStaticCreate = (sel, doc, from) => Object.getPrototypeOf(sel).constructor.create(doc, from);
+const getSelectionStaticConstructor = (sel) => Object.getPrototypeOf(sel).constructor;
 /**
  * Inverts transactions to wrap their contents/operations with track data instead
  *
@@ -1263,7 +1265,12 @@ function trackTransaction(tr, oldState, newTr, userID) {
         else if (step instanceof prosemirrorTransform.ReplaceStep) {
             const selectionPos = trackReplaceStep(step, oldState, newTr, emptyAttrs);
             if (!wasNodeSelection) {
-                newTr.setSelection(getSelectionStaticCreate(tr.selection, newTr.doc, selectionPos));
+                const sel = getSelectionStaticConstructor(tr.selection);
+                // Use Selection.near to fix selections that point to a block node instead of inline content
+                // eg when inserting a complete new paragraph. -1 finds the first valid position moving backwards
+                // inside the content
+                const near = sel.near(newTr.doc.resolve(selectionPos), -1);
+                newTr.setSelection(near);
             }
         }
         else if (step instanceof prosemirrorTransform.ReplaceAroundStep) {
@@ -1274,13 +1281,12 @@ function trackTransaction(tr, oldState, newTr, userID) {
         // TODO: here we could check whether adjacent inserts & deletes cancel each other out.
         // However, this should not be done by diffing and only matching node or char by char instead since
         // it's A easier and B more intuitive to user.
-        const { meta } = tr;
-        // This is quite non-optimal in some sense but to ensure no information is lost
-        // we have to re-add all the old meta keys, such as inputType or uiEvent.
-        // This should prevent bugs incase other plugins/widgets rely upon them existing (and they
-        // are not able to process the transactions before track-changes).
-        // TODO: will this cause race-condition if a meta causes another appendTransaction to fire
-        Object.keys(meta).forEach((key) => newTr.setMeta(key, tr.getMeta(key)));
+        // The old meta keys are not copied to the new transaction since this will cause race-conditions
+        // when a single meta-field is expected to having been processed / removed. Generic input meta keys,
+        // inputType and uiEvent, are re-added since some plugins might depend on them and process the transaction
+        // after track-changes plugin.
+        tr.getMeta('inputType') && newTr.setMeta('inputType', tr.getMeta('inputType'));
+        tr.getMeta('uiEvent') && newTr.setMeta('uiEvent', tr.getMeta('uiEvent'));
     });
     // This is kinda hacky solution at the moment to maintain NodeSelections over transactions
     // These are required by at least cross-references that need it to activate the selector pop-up
@@ -1288,7 +1294,8 @@ function trackTransaction(tr, oldState, newTr, userID) {
         const mappedPos = newTr.mapping.map(tr.selection.from);
         const resPos = newTr.doc.resolve(mappedPos);
         const nodePos = mappedPos - (((_a = resPos.nodeBefore) === null || _a === void 0 ? void 0 : _a.nodeSize) || 0);
-        newTr.setSelection(getSelectionStaticCreate(tr.selection, newTr.doc, nodePos));
+        const sel = getSelectionStaticConstructor(tr.selection);
+        newTr.setSelection(sel.create(newTr.doc, nodePos));
     }
     log.info('NEW transaction', newTr);
     return newTr;
@@ -1338,7 +1345,8 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
         key: trackChangesPluginKey,
         props: {
             editable(state) {
-                return this.getState(state).status !== exports.TrackChangesStatus.viewSnapshots;
+                var _a;
+                return ((_a = trackChangesPluginKey.getState(state)) === null || _a === void 0 ? void 0 : _a.status) !== exports.TrackChangesStatus.viewSnapshots;
             },
         },
         state: {
@@ -1408,7 +1416,6 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                     (wasAppended && getAction(wasAppended, exports.TrackChangesAction.skipTrack));
                 if (tr.docChanged && !skipMetaUsed && !skipTrackUsed && !tr.getMeta('history$')) {
                     createdTr = trackTransaction(tr, oldState, createdTr, userID);
-                    createdTr.setMeta('origin', trackChangesPluginKey);
                     infiniteLoopCounter.iters += 1;
                 }
                 docChanged = docChanged || tr.docChanged;
@@ -1435,6 +1442,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                 log.warn('had to fix inconsistent changes in', createdTr);
             }
             if (docChanged || createdTr.docChanged || changed) {
+                createdTr.setMeta('origin', trackChangesPluginKey);
                 return setAction(createdTr, exports.TrackChangesAction.refreshChanges, true);
             }
             return null;

package/dist/plugin.d.ts

@@ -15,11 +15,11 @@
  */
 import { Plugin, PluginKey } from 'prosemirror-state';
 import { TrackChangesOptions, TrackChangesState } from './types/track';
-export declare const trackChangesPluginKey: PluginKey<TrackChangesState, any>;
+export declare const trackChangesPluginKey: PluginKey<TrackChangesState>;
 /**
  * The ProseMirror plugin needed to enable track-changes.
  *
  * Accepts an empty options object as an argument but note that this uses 'anonymous:Anonymous' as the default userID.
  * @param opts
  */
-export declare const trackChangesPlugin: (opts?: TrackChangesOptions) => Plugin<TrackChangesState, any>;
+export declare const trackChangesPlugin: (opts?: TrackChangesOptions) => Plugin<TrackChangesState>;

package/dist/track/deleteNode.d.ts

@@ -24,4 +24,4 @@ import { Transaction } from 'prosemirror-state';
  * @param tr
  * @returns
  */
-export declare function deleteNode(node: PMNode, pos: number, tr: Transaction): Transaction<any>;
+export declare function deleteNode(node: PMNode, pos: number, tr: Transaction): Transaction;

package/dist/track/steps/deleteAndMergeSplitNodes.d.ts

@@ -49,5 +49,5 @@ export declare function deleteAndMergeSplitNodes(from: number, to: number, gap:
 } | undefined, startDoc: PMNode, newTr: Transaction, schema: Schema, trackAttrs: NewEmptyAttrs, insertSlice: ExposedSlice): {
     deleteMap: Mapping;
     mergedInsertPos: undefined;
-    newSliceContent: Fragment<any>;
+    newSliceContent: Fragment;
 };

package/dist/track/steps/setFragmentAsInserted.d.ts

@@ -15,4 +15,4 @@
  */
 import { Fragment, Schema } from 'prosemirror-model';
 import { NewInsertAttrs } from '../../types/track';
-export declare function setFragmentAsInserted(inserted: Fragment, insertAttrs: NewInsertAttrs, schema: Schema): Fragment<any>;
+export declare function setFragmentAsInserted(inserted: Fragment, insertAttrs: NewInsertAttrs, schema: Schema): Fragment;

package/dist/track/trackTransaction.d.ts

@@ -14,4 +14,4 @@ import type { EditorState, Transaction } from 'prosemirror-state';
  * @param userID User id
  * @returns newTr that inverts the initial tr and applies track attributes/marks
  */
-export declare function trackTransaction(tr: Transaction, oldState: EditorState, newTr: Transaction, userID: string): Transaction<any>;
+export declare function trackTransaction(tr: Transaction, oldState: EditorState, newTr: Transaction, userID: string): Transaction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manuscripts/track-changes-plugin",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "author": "Atypon Systems LLC",
   "license": "Apache-2.0",
   "homepage": "https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/quarterback-packages/track-changes-plugin",
@@ -21,38 +21,33 @@
     "access": "public"
   },
   "devDependencies": {
+    "@manuscripts/manuscript-transform": "^0.49.1",
     "@rollup/plugin-commonjs": "^22.0.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "27.5.1",
     "@types/node": "^17.0.35",
-    "@types/prosemirror-commands": "^1.0.4",
-    "@types/prosemirror-model": "^1.16.2",
-    "@types/prosemirror-schema-list": "^1.0.3",
-    "@types/prosemirror-state": "^1.3.0",
-    "@types/prosemirror-transform": "^1.4.1",
-    "@types/prosemirror-view": "^1.23.3",
-    "jest": "28.1.0",
-    "jest-environment-jsdom": "28.1.0",
+    "jest": "27.5.1",
+    "jest-environment-jsdom": "27.5.1",
     "jsdom": "^19.0.0",
-    "prosemirror-commands": "^1.2.2",
-    "prosemirror-example-setup": "^1.1.2",
-    "prosemirror-keymap": "^1.1.5",
-    "prosemirror-model": "^1.16.1",
-    "prosemirror-schema-list": "^1.1.6",
-    "prosemirror-state": "^1.3.4",
-    "prosemirror-transform": "^1.4.2",
-    "prosemirror-view": "^1.23.13",
+    "prosemirror-commands": "^1.3.0",
+    "prosemirror-example-setup": "^1.2.1",
+    "prosemirror-keymap": "^1.2.0",
+    "prosemirror-model": "^1.18.1",
+    "prosemirror-schema-list": "^1.2.0",
+    "prosemirror-state": "^1.4.1",
+    "prosemirror-transform": "^1.6.0",
+    "prosemirror-view": "^1.26.2",
     "rollup": "^2.74.0",
     "rollup-plugin-typescript2": "^0.31.2",
-    "ts-jest": "28.0.2",
+    "ts-jest": "27.1.4",
     "tslib": "^2.4.0",
     "typescript": "^4.6.4"
   },
   "peerDependencies": {
-    "prosemirror-model": "^1.16.1",
-    "prosemirror-state": "^1.3.4",
-    "prosemirror-transform": "^1.3.3",
-    "prosemirror-view": "^1.23.6"
+    "prosemirror-model": ">=1.14.0",
+    "prosemirror-state": ">=1.3.0",
+    "prosemirror-transform": ">=1.3.0",
+    "prosemirror-view": ">=1.18.0"
   },
   "dependencies": {
     "debug": "^4.3.4"
@@ -62,6 +57,7 @@
     "watch": "rollup -cw",
     "test": "jest --runInBand",
     "format": "prettier --write \"*.+(js|json|yml|yaml|ts|md|graphql|mdx)\" src/ test/",
+    "typecheck": "tsc --project tsconfig.test.json --noEmit",
     "lint": "eslint --cache --ext .js,.ts, ./src ./test",
     "lint:fix": "eslint --fix --ext .js,.ts, ./src ./test"
   }