@manuscripts/track-changes-plugin 0.2.0 → 0.3.0

package/README.md

@@ -2,15 +2,12 @@
 
 ProseMirror plugin to track inserts/deletes to nodes and text.
 
-If you have multiple versions of prosemirror packages, ensure that track-changes' dependencies `prosemirror-model` and `prosemirror-transform` are aliased/deduped to same instance. `prosemirror-state` and `prosemirror-view` are only used at type level. [Example](https://github.com/Atypon-OpenSource/manuscripts-quarterback/blob/main/examples-packages/client/vite.config.js).
-
-[More detailed overview](https://github.com/Atypon-OpenSource/manuscripts-quarterback/blob/main/quarterback-packages/track-changes-plugin/OVERVIEW.md)
-
 ## How to use
 
-First install the plugin: `npm i @manuscripts/track-changes-plugin`
+Requires normal ProseMirror editor dependencies.
 
-Then add the plugin to ProseMirror plugins:
+1. Install the plugin: `npm i @manuscripts/track-changes-plugin`
+2. Add it to ProseMirror plugins:
 
 ```ts
 import { EditorState } from 'prosemirror-state'
@@ -34,9 +31,9 @@ const view = new EditorView(document.querySelector('#editor') as HTMLElement, {
 })
 ```
 
-where `schema` is https://github.com/Atypon-OpenSource/manuscripts-quarterback/blob/main/quarterback-packages/track-changes-plugin/test/utils/schema.ts
+where `schema` contains `dataTracked` attributes for tracked nodes and `tracked_insert` & `tracked_delete` marks as shown here: https://github.com/Atypon-OpenSource/manuscripts-quarterback/blob/main/quarterback-packages/track-changes-plugin/test/utils/schema.ts
 
-Enable or disable the plugin with:
+3. That should start tracking all transactions. You can use the following commands to enable/disable/enter read-only mode:
 
 ```ts
 import { trackCommands, TrackChangesStatus } from '@manuscripts/track-changes-plugin'
@@ -54,7 +51,11 @@ trackCommands.setTrackingStatus(TrackChangesStatus.disabled))(view.state, view.d
 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
+See an example app at https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/examples-packages/client for a more complete boilerplate.
+
+**NOTE**: If you have multiple versions of prosemirror packages, ensure that track-changes' dependencies `prosemirror-model` and `prosemirror-transform` are aliased/deduped to same instance. `prosemirror-state` and `prosemirror-view` are only used at type level. [Example](https://github.com/Atypon-OpenSource/manuscripts-quarterback/blob/main/examples-packages/client/vite.config.js).
+
+[More detailed overview](https://github.com/Atypon-OpenSource/manuscripts-quarterback/blob/main/quarterback-packages/track-changes-plugin/OVERVIEW.md)
 
 ## API
 
@@ -130,44 +131,16 @@ export const refreshChanges = () => Command
 
 ### Actions
 
-Actions are used to access/set transaction meta fields. I don't think you ever would need to use other than `TrackChangesAction.skipTrack` but they are all exposed, nonetheless.
+Actions are used to access/set transaction meta fields internally. `skipTracking` is exposed publicly to set track-changes to skip certain transaction.
 
 ```ts
-export type TrackChangesActionParams = {
-  [TrackChangesAction.skipTrack]: boolean
-  [TrackChangesAction.setUserID]: string
-  [TrackChangesAction.setPluginStatus]: TrackChangesStatus
-  [TrackChangesAction.setChangeStatuses]: {
-    status: CHANGE_STATUS
-    ids: string[]
-  }
-  [TrackChangesAction.updateChanges]: string[]
-  [TrackChangesAction.refreshChanges]: boolean
-  [TrackChangesAction.applyAndRemoveChanges]: boolean
-}
 /**
- * Gets the value of a meta field, action payload, of a defined track-changes action.
+ * Skip tracking for a transaction, use this with caution to avoid race-conditions or just to otherwise
+ * omitting applying of track attributes or marks.
  * @param tr
- * @param action
+ * @returns
  */
-export function getAction<K extends keyof TrackChangesActionParams>(tr: Transaction, action: K) {
-  return tr.getMeta(action) as TrackChangesActionParams[K] | undefined
-}
-
-/**
- * Use this function to set meta keys to transactions that are consumed by the track-changes-plugin.
- * For example, you can skip tracking of a transaction with setAction(tr, TrackChangesAction.skipTrack, true)
- * @param tr
- * @param action
- * @param payload
- */
-export function setAction<K extends keyof TrackChangesActionParams>(
-  tr: Transaction,
-  action: K,
-  payload: TrackChangesActionParams[K]
-) {
-  return tr.setMeta(action, payload)
-}
+export const skipTracking = (tr: Transaction) => setAction(tr, TrackChangesAction.skipTrack, true)
 ```
 
 ### Types

package/dist/actions.d.ts

@@ -51,3 +51,10 @@ export declare function getAction<K extends keyof TrackChangesActionParams>(tr:
  * @param payload
  */
 export declare function setAction<K extends keyof TrackChangesActionParams>(tr: Transaction, action: K, payload: TrackChangesActionParams[K]): Transaction;
+/**
+ * Skip tracking for a transaction, use this with caution to avoid race-conditions or just to otherwise
+ * omitting applying of track attributes or marks.
+ * @param tr
+ * @returns
+ */
+export declare const skipTracking: (tr: Transaction) => Transaction;

package/dist/index.cjs

@@ -11,7 +11,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var debug__default = /*#__PURE__*/_interopDefaultLegacy(debug);
 
-exports.TrackChangesAction = void 0;
+var TrackChangesAction;
 (function (TrackChangesAction) {
     TrackChangesAction["skipTrack"] = "track-changes-skip-tracking";
     TrackChangesAction["setUserID"] = "track-changes-set-user-id";
@@ -20,7 +20,7 @@ exports.TrackChangesAction = void 0;
     TrackChangesAction["updateChanges"] = "track-changes-update-changes";
     TrackChangesAction["refreshChanges"] = "track-changes-refresh-changes";
     TrackChangesAction["applyAndRemoveChanges"] = "track-changes-apply-remove-changes";
-})(exports.TrackChangesAction || (exports.TrackChangesAction = {}));
+})(TrackChangesAction || (TrackChangesAction = {}));
 /**
  * Gets the value of a meta field, action payload, of a defined track-changes action.
  * @param tr
@@ -38,7 +38,14 @@ function getAction(tr, action) {
  */
 function setAction(tr, action, payload) {
     return tr.setMeta(action, payload);
-}
+}
+/**
+ * Skip tracking for a transaction, use this with caution to avoid race-conditions or just to otherwise
+ * omitting applying of track attributes or marks.
+ * @param tr
+ * @returns
+ */
+const skipTracking = (tr) => setAction(tr, TrackChangesAction.skipTrack, true);
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -291,10 +298,22 @@ class ChangeSet {
         if ('attrs' in attrs) {
             log.warn('passed "attrs" as property to isValidTrackedAttrs(attrs)', attrs);
         }
-        const trackedKeys = ['id', 'userID', 'operation', 'status', 'createdAt'];
-        const entries = Object.entries(attrs);
+        const trackedKeys = [
+            'id',
+            'authorID',
+            'operation',
+            'status',
+            'createdAt',
+            'updatedAt',
+        ];
+        // reviewedByID is set optional since either ProseMirror or Yjs doesn't like persisting null values inside attributes objects
+        // So it can be either omitted completely or at least null or string
+        const optionalKeys = ['reviewedByID'];
+        const entries = Object.entries(attrs).filter(([key, val]) => trackedKeys.includes(key));
+        const optionalEntries = Object.entries(attrs).filter(([key, val]) => optionalKeys.includes(key));
         return (entries.length === trackedKeys.length &&
             entries.every(([key, val]) => trackedKeys.includes(key) && val !== undefined) &&
+            optionalEntries.every(([key, val]) => optionalKeys.includes(key) && val !== undefined) &&
             (attrs.id || '').length > 0 // Changes created with undefined id have '' as placeholder
         );
     }
@@ -336,7 +355,7 @@ function deleteNode(node, pos, tr) {
     const startPos = tr.doc.resolve(pos + 1);
     const range = startPos.blockRange(tr.doc.resolve(startPos.pos - 2 + node.nodeSize));
     const targetDepth = range && prosemirrorTransform.liftTarget(range);
-    // Check with typeof since with old prosemirror-transform targetDepth is undefined
+    // Check with typeof since with prosemirror-transform pre 1.6.0 targetDepth is undefined
     if (range && typeof targetDepth === 'number') {
         return tr.lift(range, targetDepth);
     }
@@ -464,7 +483,7 @@ function shouldMergeTrackedAttributes(left, right) {
     }
     return (left.status === right.status &&
         left.operation === right.operation &&
-        left.userID === right.userID);
+        left.authorID === right.authorID);
 }
 function getMergeableMarkTrackedAttrs(node, attrs, schema) {
     const nodeAttrs = getInlineNodeTrackedMarkData(node, schema);
@@ -584,6 +603,7 @@ function findChanges(state) {
                         type: 'text-change',
                         from: pos,
                         to: pos + node.nodeSize,
+                        text: node.text,
                         attrs,
                     },
                     node,
@@ -628,13 +648,15 @@ function fixInconsistentChanges(changeSet, trackUserID, newTr, schema) {
     const iteratedIds = new Set();
     let changed = false;
     changeSet.invalidChanges.forEach((c) => {
-        const { id, userID, operation, status, createdAt } = c.attrs;
+        const { id, authorID, operation, reviewedByID, status, createdAt, updatedAt } = c.attrs;
         const newAttrs = {
             ...((!id || iteratedIds.has(id) || id.length === 0) && { id: uuidv4() }),
-            ...(!userID && { userID: trackUserID }),
+            ...(!authorID && { authorID: trackUserID }),
             ...(!operation && { operation: exports.CHANGE_OPERATION.insert }),
+            ...(!reviewedByID && { reviewedByID: null }),
             ...(!status && { status: exports.CHANGE_STATUS.pending }),
             ...(!createdAt && { createdAt: Date.now() }),
+            ...(!updatedAt && { updatedAt: Date.now() }),
         };
         if (Object.keys(newAttrs).length > 0) {
             updateChangeAttrs(newTr, c, { ...c.attrs, ...newAttrs }, schema);
@@ -853,10 +875,12 @@ function deleteTextIfInserted(node, pos, newTr, schema, deleteAttrs, from, to) {
         const rightMarks = getMergeableMarkTrackedAttrs(rightNode, deleteAttrs, schema);
         const fromStartOfMark = start - (leftNode && leftMarks ? leftNode.nodeSize : 0);
         const toEndOfMark = end + (rightNode && rightMarks ? rightNode.nodeSize : 0);
+        const createdAt = Math.min((leftMarks === null || leftMarks === void 0 ? void 0 : leftMarks.createdAt) || Number.MAX_VALUE, (rightMarks === null || rightMarks === void 0 ? void 0 : rightMarks.createdAt) || Number.MAX_VALUE, deleteAttrs.createdAt);
         const dataTracked = addTrackIdIfDoesntExist({
             ...leftMarks,
             ...rightMarks,
             ...deleteAttrs,
+            createdAt,
         });
         newTr.addMark(fromStartOfMark, toEndOfMark, schema.marks.tracked_delete.create({
             dataTracked,
@@ -873,7 +897,8 @@ function deleteTextIfInserted(node, pos, newTr, schema, deleteAttrs, from, to) {
  */
 function deleteOrSetNodeDeleted(node, pos, newTr, deleteAttrs) {
     const dataTracked = node.attrs.dataTracked;
-    const wasInsertedBySameUser = (dataTracked === null || dataTracked === void 0 ? void 0 : dataTracked.operation) === exports.CHANGE_OPERATION.insert && dataTracked.userID === deleteAttrs.userID;
+    const wasInsertedBySameUser = (dataTracked === null || dataTracked === void 0 ? void 0 : dataTracked.operation) === exports.CHANGE_OPERATION.insert &&
+        dataTracked.authorID === deleteAttrs.authorID;
     if (wasInsertedBySameUser) {
         deleteNode(node, pos, newTr);
     }
@@ -1070,18 +1095,21 @@ function mergeTrackedMarks(pos, doc, newTr, schema) {
     if (!nodeAfter || !nodeBefore || !leftMark || !rightMark || leftMark.type !== rightMark.type) {
         return;
     }
-    const leftAttrs = leftMark.attrs;
-    const rightAttrs = rightMark.attrs;
-    if (!shouldMergeTrackedAttributes(leftAttrs.dataTracked, rightAttrs.dataTracked)) {
+    const leftDataTracked = leftMark.attrs.dataTracked;
+    const rightDataTracked = rightMark.attrs.dataTracked;
+    if (!shouldMergeTrackedAttributes(leftDataTracked, rightDataTracked)) {
         return;
     }
-    const newAttrs = {
-        ...leftAttrs,
-        createdAt: Math.max(leftAttrs.createdAt || 0, rightAttrs.createdAt || 0) || Date.now(),
+    const isLeftOlder = (leftDataTracked.createdAt || Number.MAX_VALUE) <
+        (rightDataTracked.createdAt || Number.MAX_VALUE);
+    const ancestorAttrs = isLeftOlder ? leftDataTracked : rightDataTracked;
+    const dataTracked = {
+        ...ancestorAttrs,
+        updatedAt: Date.now(),
     };
     const fromStartOfMark = pos - nodeBefore.nodeSize;
     const toEndOfMark = pos + nodeAfter.nodeSize;
-    newTr.addMark(fromStartOfMark, toEndOfMark, leftMark.type.create(newAttrs));
+    newTr.addMark(fromStartOfMark, toEndOfMark, leftMark.type.create({ ...leftMark.attrs, dataTracked }));
 }
 
 /*!
@@ -1250,13 +1278,15 @@ const getSelectionStaticConstructor = (sel) => Object.getPrototypeOf(sel).constr
  * @param tr Original transaction
  * @param oldState State before transaction
  * @param newTr Transaction created from the new editor state
- * @param userID User id
+ * @param authorID User id
  * @returns newTr that inverts the initial tr and applies track attributes/marks
  */
-function trackTransaction(tr, oldState, newTr, userID) {
+function trackTransaction(tr, oldState, newTr, authorID) {
     const emptyAttrs = {
-        userID,
+        authorID,
+        reviewedByID: null,
         createdAt: tr.time,
+        updatedAt: tr.time,
         status: exports.CHANGE_STATUS.pending,
     };
     // Must use constructor.name instead of instanceof as aliasing prosemirror-state is a lot more
@@ -1368,8 +1398,8 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                 };
             },
             apply(tr, pluginState, _oldState, newState) {
-                const setUserID = getAction(tr, exports.TrackChangesAction.setUserID);
-                const setStatus = getAction(tr, exports.TrackChangesAction.setPluginStatus);
+                const setUserID = getAction(tr, TrackChangesAction.setUserID);
+                const setStatus = getAction(tr, TrackChangesAction.setPluginStatus);
                 if (setUserID) {
                     return { ...pluginState, userID: setUserID };
                 }
@@ -1384,8 +1414,8 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                     return { ...pluginState, changeSet: new ChangeSet() };
                 }
                 let { changeSet, ...rest } = pluginState;
-                const updatedChangeIds = getAction(tr, exports.TrackChangesAction.updateChanges);
-                if (updatedChangeIds || getAction(tr, exports.TrackChangesAction.refreshChanges)) {
+                const updatedChangeIds = getAction(tr, TrackChangesAction.updateChanges);
+                if (updatedChangeIds || getAction(tr, TrackChangesAction.refreshChanges)) {
                     changeSet = findChanges(newState);
                 }
                 return {
@@ -1414,27 +1444,27 @@ 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, exports.TrackChangesAction.skipTrack) ||
-                    (wasAppended && getAction(wasAppended, exports.TrackChangesAction.skipTrack));
+                const skipTrackUsed = getAction(tr, TrackChangesAction.skipTrack) ||
+                    (wasAppended && getAction(wasAppended, TrackChangesAction.skipTrack));
                 if (tr.docChanged && !skipMetaUsed && !skipTrackUsed && !tr.getMeta('history$')) {
                     createdTr = trackTransaction(tr, oldState, createdTr, userID);
                 }
                 docChanged = docChanged || tr.docChanged;
-                const setChangeStatuses = getAction(tr, exports.TrackChangesAction.setChangeStatuses);
+                const setChangeStatuses = getAction(tr, TrackChangesAction.setChangeStatuses);
                 if (setChangeStatuses) {
                     const { status, ids } = setChangeStatuses;
                     ids.forEach((changeId) => {
                         const change = changeSet === null || changeSet === void 0 ? void 0 : changeSet.get(changeId);
                         if (change) {
-                            createdTr = updateChangeAttrs(createdTr, change, { status }, oldState.schema);
-                            setAction(createdTr, exports.TrackChangesAction.updateChanges, [change.id]);
+                            createdTr = updateChangeAttrs(createdTr, change, { status, reviewedByID: userID }, oldState.schema);
+                            setAction(createdTr, TrackChangesAction.updateChanges, [change.id]);
                         }
                     });
                 }
-                else if (getAction(tr, exports.TrackChangesAction.applyAndRemoveChanges)) {
+                else if (getAction(tr, TrackChangesAction.applyAndRemoveChanges)) {
                     const mapping = applyAcceptedRejectedChanges(createdTr, oldState.schema, changeSet.nodeChanges);
                     applyAcceptedRejectedChanges(createdTr, oldState.schema, changeSet.textChanges, mapping);
-                    setAction(createdTr, exports.TrackChangesAction.refreshChanges, true);
+                    setAction(createdTr, TrackChangesAction.refreshChanges, true);
                 }
             });
             const changed = pluginState.changeSet.hasInconsistentData &&
@@ -1444,7 +1474,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
             }
             if (docChanged || createdTr.docChanged || changed) {
                 createdTr.setMeta('origin', trackChangesPluginKey);
-                return setAction(createdTr, exports.TrackChangesAction.refreshChanges, true);
+                return setAction(createdTr, TrackChangesAction.refreshChanges, true);
             }
             return null;
         },
@@ -1486,7 +1516,7 @@ const setTrackingStatus = (status) => (state, dispatch) => {
                     ? exports.TrackChangesStatus.disabled
                     : exports.TrackChangesStatus.enabled;
         }
-        dispatch && dispatch(setAction(state.tr, exports.TrackChangesAction.setPluginStatus, newStatus));
+        dispatch && dispatch(setAction(state.tr, TrackChangesAction.setPluginStatus, newStatus));
         return true;
     }
     return false;
@@ -1498,7 +1528,7 @@ const setTrackingStatus = (status) => (state, dispatch) => {
  */
 const setChangeStatuses = (status, ids) => (state, dispatch) => {
     dispatch &&
-        dispatch(setAction(state.tr, exports.TrackChangesAction.setChangeStatuses, {
+        dispatch(setAction(state.tr, TrackChangesAction.setChangeStatuses, {
             status,
             ids,
         }));
@@ -1509,21 +1539,21 @@ const setChangeStatuses = (status, ids) => (state, dispatch) => {
  * @param userID
  */
 const setUserID = (userID) => (state, dispatch) => {
-    dispatch && dispatch(setAction(state.tr, exports.TrackChangesAction.setUserID, userID));
+    dispatch && dispatch(setAction(state.tr, TrackChangesAction.setUserID, userID));
     return true;
 };
 /**
  * Appends a transaction that applies all 'accepted' and 'rejected' changes to the document.
  */
 const applyAndRemoveChanges = () => (state, dispatch) => {
-    dispatch && dispatch(setAction(state.tr, exports.TrackChangesAction.applyAndRemoveChanges, true));
+    dispatch && dispatch(setAction(state.tr, TrackChangesAction.applyAndRemoveChanges, true));
     return true;
 };
 /**
  * Runs `findChanges` to iterate over the document to collect changes into a new ChangeSet.
  */
 const refreshChanges = () => (state, dispatch) => {
-    dispatch && dispatch(setAction(state.tr, exports.TrackChangesAction.updateChanges, []));
+    dispatch && dispatch(setAction(state.tr, TrackChangesAction.updateChanges, []));
     return true;
 };
 /**
@@ -1555,8 +1585,7 @@ var commands = /*#__PURE__*/Object.freeze({
 
 exports.ChangeSet = ChangeSet;
 exports.enableDebug = enableDebug;
-exports.getAction = getAction;
-exports.setAction = setAction;
+exports.skipTracking = skipTracking;
 exports.trackChangesPlugin = trackChangesPlugin;
 exports.trackChangesPluginKey = trackChangesPluginKey;
 exports.trackCommands = commands;

package/dist/index.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export { trackChangesPluginKey, trackChangesPlugin } from './plugin';
-export * from './actions';
+export { skipTracking } from './actions';
 export * as trackCommands from './commands';
 export { enableDebug } from './utils/logger';
 export { ChangeSet } from './ChangeSet';

package/dist/index.js

@@ -30,7 +30,14 @@ function getAction(tr, action) {
  */
 function setAction(tr, action, payload) {
     return tr.setMeta(action, payload);
-}
+}
+/**
+ * Skip tracking for a transaction, use this with caution to avoid race-conditions or just to otherwise
+ * omitting applying of track attributes or marks.
+ * @param tr
+ * @returns
+ */
+const skipTracking = (tr) => setAction(tr, TrackChangesAction.skipTrack, true);
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -283,10 +290,22 @@ class ChangeSet {
         if ('attrs' in attrs) {
             log.warn('passed "attrs" as property to isValidTrackedAttrs(attrs)', attrs);
         }
-        const trackedKeys = ['id', 'userID', 'operation', 'status', 'createdAt'];
-        const entries = Object.entries(attrs);
+        const trackedKeys = [
+            'id',
+            'authorID',
+            'operation',
+            'status',
+            'createdAt',
+            'updatedAt',
+        ];
+        // reviewedByID is set optional since either ProseMirror or Yjs doesn't like persisting null values inside attributes objects
+        // So it can be either omitted completely or at least null or string
+        const optionalKeys = ['reviewedByID'];
+        const entries = Object.entries(attrs).filter(([key, val]) => trackedKeys.includes(key));
+        const optionalEntries = Object.entries(attrs).filter(([key, val]) => optionalKeys.includes(key));
         return (entries.length === trackedKeys.length &&
             entries.every(([key, val]) => trackedKeys.includes(key) && val !== undefined) &&
+            optionalEntries.every(([key, val]) => optionalKeys.includes(key) && val !== undefined) &&
             (attrs.id || '').length > 0 // Changes created with undefined id have '' as placeholder
         );
     }
@@ -328,7 +347,7 @@ function deleteNode(node, pos, tr) {
     const startPos = tr.doc.resolve(pos + 1);
     const range = startPos.blockRange(tr.doc.resolve(startPos.pos - 2 + node.nodeSize));
     const targetDepth = range && liftTarget(range);
-    // Check with typeof since with old prosemirror-transform targetDepth is undefined
+    // Check with typeof since with prosemirror-transform pre 1.6.0 targetDepth is undefined
     if (range && typeof targetDepth === 'number') {
         return tr.lift(range, targetDepth);
     }
@@ -456,7 +475,7 @@ function shouldMergeTrackedAttributes(left, right) {
     }
     return (left.status === right.status &&
         left.operation === right.operation &&
-        left.userID === right.userID);
+        left.authorID === right.authorID);
 }
 function getMergeableMarkTrackedAttrs(node, attrs, schema) {
     const nodeAttrs = getInlineNodeTrackedMarkData(node, schema);
@@ -576,6 +595,7 @@ function findChanges(state) {
                         type: 'text-change',
                         from: pos,
                         to: pos + node.nodeSize,
+                        text: node.text,
                         attrs,
                     },
                     node,
@@ -620,13 +640,15 @@ function fixInconsistentChanges(changeSet, trackUserID, newTr, schema) {
     const iteratedIds = new Set();
     let changed = false;
     changeSet.invalidChanges.forEach((c) => {
-        const { id, userID, operation, status, createdAt } = c.attrs;
+        const { id, authorID, operation, reviewedByID, status, createdAt, updatedAt } = c.attrs;
         const newAttrs = {
             ...((!id || iteratedIds.has(id) || id.length === 0) && { id: uuidv4() }),
-            ...(!userID && { userID: trackUserID }),
+            ...(!authorID && { authorID: trackUserID }),
             ...(!operation && { operation: CHANGE_OPERATION.insert }),
+            ...(!reviewedByID && { reviewedByID: null }),
             ...(!status && { status: CHANGE_STATUS.pending }),
             ...(!createdAt && { createdAt: Date.now() }),
+            ...(!updatedAt && { updatedAt: Date.now() }),
         };
         if (Object.keys(newAttrs).length > 0) {
             updateChangeAttrs(newTr, c, { ...c.attrs, ...newAttrs }, schema);
@@ -845,10 +867,12 @@ function deleteTextIfInserted(node, pos, newTr, schema, deleteAttrs, from, to) {
         const rightMarks = getMergeableMarkTrackedAttrs(rightNode, deleteAttrs, schema);
         const fromStartOfMark = start - (leftNode && leftMarks ? leftNode.nodeSize : 0);
         const toEndOfMark = end + (rightNode && rightMarks ? rightNode.nodeSize : 0);
+        const createdAt = Math.min((leftMarks === null || leftMarks === void 0 ? void 0 : leftMarks.createdAt) || Number.MAX_VALUE, (rightMarks === null || rightMarks === void 0 ? void 0 : rightMarks.createdAt) || Number.MAX_VALUE, deleteAttrs.createdAt);
         const dataTracked = addTrackIdIfDoesntExist({
             ...leftMarks,
             ...rightMarks,
             ...deleteAttrs,
+            createdAt,
         });
         newTr.addMark(fromStartOfMark, toEndOfMark, schema.marks.tracked_delete.create({
             dataTracked,
@@ -865,7 +889,8 @@ function deleteTextIfInserted(node, pos, newTr, schema, deleteAttrs, from, to) {
  */
 function deleteOrSetNodeDeleted(node, pos, newTr, deleteAttrs) {
     const dataTracked = node.attrs.dataTracked;
-    const wasInsertedBySameUser = (dataTracked === null || dataTracked === void 0 ? void 0 : dataTracked.operation) === CHANGE_OPERATION.insert && dataTracked.userID === deleteAttrs.userID;
+    const wasInsertedBySameUser = (dataTracked === null || dataTracked === void 0 ? void 0 : dataTracked.operation) === CHANGE_OPERATION.insert &&
+        dataTracked.authorID === deleteAttrs.authorID;
     if (wasInsertedBySameUser) {
         deleteNode(node, pos, newTr);
     }
@@ -1062,18 +1087,21 @@ function mergeTrackedMarks(pos, doc, newTr, schema) {
     if (!nodeAfter || !nodeBefore || !leftMark || !rightMark || leftMark.type !== rightMark.type) {
         return;
     }
-    const leftAttrs = leftMark.attrs;
-    const rightAttrs = rightMark.attrs;
-    if (!shouldMergeTrackedAttributes(leftAttrs.dataTracked, rightAttrs.dataTracked)) {
+    const leftDataTracked = leftMark.attrs.dataTracked;
+    const rightDataTracked = rightMark.attrs.dataTracked;
+    if (!shouldMergeTrackedAttributes(leftDataTracked, rightDataTracked)) {
         return;
     }
-    const newAttrs = {
-        ...leftAttrs,
-        createdAt: Math.max(leftAttrs.createdAt || 0, rightAttrs.createdAt || 0) || Date.now(),
+    const isLeftOlder = (leftDataTracked.createdAt || Number.MAX_VALUE) <
+        (rightDataTracked.createdAt || Number.MAX_VALUE);
+    const ancestorAttrs = isLeftOlder ? leftDataTracked : rightDataTracked;
+    const dataTracked = {
+        ...ancestorAttrs,
+        updatedAt: Date.now(),
     };
     const fromStartOfMark = pos - nodeBefore.nodeSize;
     const toEndOfMark = pos + nodeAfter.nodeSize;
-    newTr.addMark(fromStartOfMark, toEndOfMark, leftMark.type.create(newAttrs));
+    newTr.addMark(fromStartOfMark, toEndOfMark, leftMark.type.create({ ...leftMark.attrs, dataTracked }));
 }
 
 /*!
@@ -1242,13 +1270,15 @@ const getSelectionStaticConstructor = (sel) => Object.getPrototypeOf(sel).constr
  * @param tr Original transaction
  * @param oldState State before transaction
  * @param newTr Transaction created from the new editor state
- * @param userID User id
+ * @param authorID User id
  * @returns newTr that inverts the initial tr and applies track attributes/marks
  */
-function trackTransaction(tr, oldState, newTr, userID) {
+function trackTransaction(tr, oldState, newTr, authorID) {
     const emptyAttrs = {
-        userID,
+        authorID,
+        reviewedByID: null,
         createdAt: tr.time,
+        updatedAt: tr.time,
         status: CHANGE_STATUS.pending,
     };
     // Must use constructor.name instead of instanceof as aliasing prosemirror-state is a lot more
@@ -1418,7 +1448,7 @@ const trackChangesPlugin = (opts = { userID: 'anonymous:Anonymous' }) => {
                     ids.forEach((changeId) => {
                         const change = changeSet === null || changeSet === void 0 ? void 0 : changeSet.get(changeId);
                         if (change) {
-                            createdTr = updateChangeAttrs(createdTr, change, { status }, oldState.schema);
+                            createdTr = updateChangeAttrs(createdTr, change, { status, reviewedByID: userID }, oldState.schema);
                             setAction(createdTr, TrackChangesAction.updateChanges, [change.id]);
                         }
                     });
@@ -1545,4 +1575,4 @@ var commands = /*#__PURE__*/Object.freeze({
   setParagraphTestAttribute: setParagraphTestAttribute
 });
 
-export { CHANGE_OPERATION, CHANGE_STATUS, ChangeSet, TrackChangesAction, TrackChangesStatus, enableDebug, getAction, setAction, trackChangesPlugin, trackChangesPluginKey, commands as trackCommands };
+export { CHANGE_OPERATION, CHANGE_STATUS, ChangeSet, TrackChangesStatus, enableDebug, skipTracking, trackChangesPlugin, trackChangesPluginKey, commands as trackCommands };

package/dist/track/node-utils.d.ts

@@ -14,21 +14,14 @@
  * limitations under the License.
  */
 import { Node as PMNode, Schema } from 'prosemirror-model';
-import { Transaction } from 'prosemirror-state';
 import { CHANGE_OPERATION, TrackedAttrs } from '../types/change';
 export declare function addTrackIdIfDoesntExist(attrs: Partial<TrackedAttrs>): Partial<TrackedAttrs>;
-/**
- * Not in use, maybe for ReplaceAroundSteps but we'll see
- * @param pos
- * @param tr
- */
-export declare function liftNode(pos: number, tr: Transaction): Transaction | undefined;
-export declare function getInlineNodeTrackedMarkData(node: PMNode | undefined | null, schema: Schema): {
+export declare function getInlineNodeTrackedMarkData(node: PMNode | undefined | null, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
     operation: CHANGE_OPERATION;
-} | undefined;
+}) | undefined;
 export declare function getNodeTrackedData(node: PMNode | undefined | null, schema: Schema): Partial<TrackedAttrs> | undefined;
 export declare function equalMarks(n1: PMNode, n2: PMNode): boolean;
 export declare function shouldMergeTrackedAttributes(left?: Partial<TrackedAttrs>, right?: Partial<TrackedAttrs>): boolean;
-export declare function getMergeableMarkTrackedAttrs(node: PMNode | undefined | null, attrs: Partial<TrackedAttrs>, schema: Schema): {
+export declare function getMergeableMarkTrackedAttrs(node: PMNode | undefined | null, attrs: Partial<TrackedAttrs>, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
     operation: CHANGE_OPERATION;
-} | null;
+}) | null;

package/dist/track/steps/track-utils.d.ts

@@ -14,6 +14,5 @@
  * limitations under the License.
  */
 import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs } from '../../types/track';
-export declare function createNewEmptyAttrs(userID: string, createdAt: number): NewEmptyAttrs;
 export declare function createNewInsertAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
 export declare function createNewDeleteAttrs(attrs: NewEmptyAttrs): NewDeleteAttrs;

package/dist/track/trackTransaction.d.ts

@@ -11,7 +11,7 @@ import type { EditorState, Transaction } from 'prosemirror-state';
  * @param tr Original transaction
  * @param oldState State before transaction
  * @param newTr Transaction created from the new editor state
- * @param userID User id
+ * @param authorID 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;
+export declare function trackTransaction(tr: Transaction, oldState: EditorState, newTr: Transaction, authorID: string): Transaction;

package/dist/types/change.d.ts

@@ -29,10 +29,12 @@ export declare enum CHANGE_STATUS {
 }
 export interface TrackedAttrs {
     id: string;
-    userID: string;
+    authorID: string;
+    reviewedByID: string | null;
     operation: CHANGE_OPERATION;
     status: CHANGE_STATUS;
     createdAt: number;
+    updatedAt: number;
 }
 export declare type Change = {
     id: string;
@@ -42,6 +44,7 @@ export declare type Change = {
 };
 export declare type TextChange = Change & {
     type: 'text-change';
+    text: string;
 };
 export declare type NodeChange = Change & {
     type: 'node-change';

package/package.json

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