@manuscripts/track-changes-plugin 2.1.1 → 2.2.1

package/dist/cjs/utils/track-utils.js

@@ -1,239 +0,0 @@
-"use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateBlockNodesAttrs = exports.filterMeaninglessMoveSteps = exports.handleDirectPendingMoveDeletions = exports.isDirectPendingMoveDeletion = exports.isDeletingPendingMovedNode = exports.isPendingChange = exports.HasMoveOperations = exports.trFromHistory = void 0;
-exports.createNewInsertAttrs = createNewInsertAttrs;
-exports.createNewWrapAttrs = createNewWrapAttrs;
-exports.createNewSplitAttrs = createNewSplitAttrs;
-exports.createNewReferenceAttrs = createNewReferenceAttrs;
-exports.createNewDeleteAttrs = createNewDeleteAttrs;
-exports.createNewMoveAttrs = createNewMoveAttrs;
-exports.createNewUpdateAttrs = createNewUpdateAttrs;
-exports.createNewStructureAttrs = createNewStructureAttrs;
-exports.isValidTrackableMark = isValidTrackableMark;
-exports.excludeFromTracked = excludeFromTracked;
-exports.isInlineMarkChange = isInlineMarkChange;
-const prosemirror_model_1 = require("prosemirror-model");
-const prosemirror_transform_1 = require("prosemirror-transform");
-const actions_1 = require("../actions");
-const change_1 = require("../types/change");
-const uuidv4_1 = require("./uuidv4");
-function createNewInsertAttrs(attrs) {
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.insert });
-}
-function createNewWrapAttrs(attrs) {
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.wrap_with_node });
-}
-function createNewSplitAttrs(attrs) {
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.node_split });
-}
-function createNewReferenceAttrs(attrs, id) {
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.reference, referenceId: id });
-}
-function createNewDeleteAttrs(attrs) {
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.delete });
-}
-function createNewMoveAttrs(attrs, indentationType) {
-    return Object.assign(Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.move }), (indentationType && { indentationType }));
-}
-function createNewUpdateAttrs(attrs, oldAttrs) {
-    const { dataTracked } = oldAttrs, restAttrs = __rest(oldAttrs, ["dataTracked"]);
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.set_node_attributes, oldAttrs: JSON.parse(JSON.stringify(restAttrs)) });
-}
-function createNewStructureAttrs(attrs) {
-    return Object.assign(Object.assign({}, attrs), { operation: change_1.CHANGE_OPERATION.structure });
-}
-const trFromHistory = (tr) => Object.keys(tr.meta).find((s) => s.startsWith('history$'));
-exports.trFromHistory = trFromHistory;
-const HasMoveOperations = (tr) => {
-    const movingAssoc = new Map();
-    if (tr.steps.length < 2) {
-        return movingAssoc;
-    }
-    if (tr.getMeta(actions_1.TrackChangesAction.structuralChangeAction)) {
-        const commonID = (0, uuidv4_1.uuidv4)();
-        movingAssoc.set(tr.steps[0], commonID);
-        movingAssoc.set(tr.steps[1], commonID);
-        return movingAssoc;
-    }
-    const matched = [];
-    for (let i = 0; i < tr.steps.length; i++) {
-        if (matched.includes(i)) {
-            continue;
-        }
-        const step = tr.steps[i];
-        const doc = tr.docs[i];
-        if (!step.slice) {
-            continue;
-        }
-        const stepDeletesContent = step.from !== step.to && step.slice.size === 0;
-        const stepInsertsContent = step.slice.size && step.slice.content.firstChild ? true : false;
-        for (let g = 0; g < tr.steps.length; g++) {
-            if (g === i || matched.includes(g)) {
-                continue;
-            }
-            const peerStep = tr.steps[g];
-            if (!peerStep.slice) {
-                continue;
-            }
-            const peerStepInsertsContent = peerStep.slice.size && peerStep.slice.content.firstChild;
-            const peerStepDeletesContent = peerStep.from !== peerStep.to && peerStep.slice.size === 0;
-            if (stepDeletesContent) {
-                const deletedContent = doc.slice(step.from, step.to);
-                if (peerStepInsertsContent &&
-                    deletedContent.content.firstChild &&
-                    peerStep.slice.content.firstChild.toString() === deletedContent.content.firstChild.toString()) {
-                    const commonID = (0, uuidv4_1.uuidv4)();
-                    movingAssoc.set(peerStep, commonID);
-                    movingAssoc.set(step, commonID);
-                    matched.push(i, g);
-                }
-                continue;
-            }
-            if (stepInsertsContent && peerStepDeletesContent) {
-                const insertedContent = step.slice;
-                const deletedPeerContent = tr.docs[g].slice(peerStep.from, peerStep.to);
-                if (insertedContent.content.firstChild &&
-                    deletedPeerContent.content.firstChild &&
-                    insertedContent.content.firstChild.toString() === deletedPeerContent.content.firstChild.toString()) {
-                    const commonID = (0, uuidv4_1.uuidv4)();
-                    movingAssoc.set(peerStep, commonID);
-                    movingAssoc.set(step, commonID);
-                }
-                matched.push(i, g);
-            }
-        }
-    }
-    return movingAssoc;
-};
-exports.HasMoveOperations = HasMoveOperations;
-const isPendingChange = (trackedAttrs, operation) => {
-    return !!(trackedAttrs === null || trackedAttrs === void 0 ? void 0 : trackedAttrs.some((t) => t.operation === operation));
-};
-exports.isPendingChange = isPendingChange;
-const isDeletingPendingMovedNode = (step, doc) => {
-    if (!step.slice || step.from === step.to || step.slice.content.size > 0) {
-        return undefined;
-    }
-    const node = doc.nodeAt(step.from);
-    if (!node) {
-        return undefined;
-    }
-    const trackedAttrs = node.attrs.dataTracked;
-    const found = trackedAttrs === null || trackedAttrs === void 0 ? void 0 : trackedAttrs.find((tracked) => tracked.operation === change_1.CHANGE_OPERATION.move && tracked.status === change_1.CHANGE_STATUS.pending);
-    if (found === null || found === void 0 ? void 0 : found.moveNodeId) {
-        return found.moveNodeId;
-    }
-    return undefined;
-};
-exports.isDeletingPendingMovedNode = isDeletingPendingMovedNode;
-const isDirectPendingMoveDeletion = (step, doc, movingSteps) => {
-    if (step.from === step.to || step.slice.content.size > 0) {
-        return false;
-    }
-    if (movingSteps.has(step)) {
-        return false;
-    }
-    const node = doc.nodeAt(step.from);
-    if (!node) {
-        return false;
-    }
-    return (0, exports.isPendingChange)(node.attrs.dataTracked, change_1.CHANGE_OPERATION.move);
-};
-exports.isDirectPendingMoveDeletion = isDirectPendingMoveDeletion;
-const handleDirectPendingMoveDeletions = (tr, newTr, movingSteps) => {
-    tr.steps.forEach((step) => {
-        if (step instanceof prosemirror_transform_1.ReplaceStep) {
-            const doc = tr.docs[tr.steps.indexOf(step)];
-            if ((0, exports.isDirectPendingMoveDeletion)(step, doc, movingSteps)) {
-                const node = doc.nodeAt(step.from);
-                if (node === null || node === void 0 ? void 0 : node.attrs.dataTracked) {
-                    newTr.setNodeMarkup(step.from, undefined, Object.assign(Object.assign({}, node.attrs), { dataTracked: node.attrs.dataTracked.filter((t) => !(t.operation === change_1.CHANGE_OPERATION.move && t.status === change_1.CHANGE_STATUS.pending)) }));
-                }
-            }
-        }
-    });
-};
-exports.handleDirectPendingMoveDeletions = handleDirectPendingMoveDeletions;
-const filterMeaninglessMoveSteps = (tr, movingSteps) => {
-    var _a;
-    const cleanSteps = [];
-    for (let i = 0; i < tr.steps.length; i++) {
-        const step = tr.steps[i];
-        const moveID = movingSteps.get(step);
-        if (moveID) {
-            const prevMoveID = (0, exports.isDeletingPendingMovedNode)(step, tr.docs[i]);
-            if (prevMoveID) {
-                movingSteps.forEach((replaceStepMoveID, replaceStep) => {
-                    if (replaceStep !== step && moveID === replaceStepMoveID) {
-                        movingSteps.set(replaceStep, prevMoveID);
-                    }
-                });
-                continue;
-            }
-            if (step instanceof prosemirror_transform_1.ReplaceStep && !tr.getMeta(actions_1.TrackChangesAction.structuralChangeAction)) {
-                const { slice } = step;
-                if ((_a = slice === null || slice === void 0 ? void 0 : slice.content) === null || _a === void 0 ? void 0 : _a.firstChild) {
-                    const insertedNode = slice.content.firstChild;
-                    if (insertedNode.attrs.dataTracked) {
-                        const isPendingInsert = (0, exports.isPendingChange)(insertedNode.attrs.dataTracked, change_1.CHANGE_OPERATION.insert);
-                        if (isPendingInsert) {
-                            continue;
-                        }
-                    }
-                }
-            }
-        }
-        cleanSteps.push(step);
-    }
-    return cleanSteps;
-};
-exports.filterMeaninglessMoveSteps = filterMeaninglessMoveSteps;
-const updateBlockNodesAttrs = (fragment, predicate) => {
-    const updatedNodes = [];
-    fragment.forEach((child) => {
-        if (!child.isBlock) {
-            updatedNodes.push(child);
-            return;
-        }
-        const newContent = child.content.size ? (0, exports.updateBlockNodesAttrs)(child.content, predicate) : child.content;
-        const newAttrs = predicate(child.attrs, child);
-        updatedNodes.push(child.type.create(newAttrs, newContent, child.marks));
-    });
-    return prosemirror_model_1.Fragment.fromArray(updatedNodes);
-};
-exports.updateBlockNodesAttrs = updateBlockNodesAttrs;
-function isValidTrackableMark(mark) {
-    var _a, _b;
-    const spec = mark.type.spec;
-    const name = mark.type.name;
-    if (!name.startsWith('tracked_') &&
-        ((_a = spec.attrs) === null || _a === void 0 ? void 0 : _a.dataTracked) &&
-        typeof ((_b = spec.attrs) === null || _b === void 0 ? void 0 : _b.dataTracked) === 'object') {
-        return true;
-    }
-    return false;
-}
-function excludeFromTracked(dataTracked, changeIdToExclude) {
-    if (!dataTracked) {
-        return null;
-    }
-    const newDataTracked = dataTracked.filter((c) => c.id !== changeIdToExclude);
-    return newDataTracked.length ? newDataTracked : null;
-}
-function isInlineMarkChange(change) {
-    if (change.type == 'mark-change') {
-        return change.nodeType.isInline || change.nodeType.isText;
-    }
-    return false;
-}

package/dist/es/compute/nodeHelpers.js

@@ -1,73 +0,0 @@
-import { CHANGE_OPERATION } from '../types/change';
-import { log } from '../utils/logger';
-import { isValidTrackableMark } from '../utils/track-utils';
-import { uuidv4 } from '../utils/uuidv4';
-export function addTrackIdIfDoesntExist(attrs) {
-    if (!attrs.id) {
-        return Object.assign({ id: uuidv4() }, attrs);
-    }
-    return attrs;
-}
-export function getTextNodeTrackedMarkData(node, schema) {
-    if (!node || !node.isText) {
-        return undefined;
-    }
-    const marksTrackedData = [];
-    node.marks.forEach((mark) => {
-        if (mark.type === schema.marks.tracked_insert || mark.type === schema.marks.tracked_delete) {
-            const operation = mark.type === schema.marks.tracked_insert ? CHANGE_OPERATION.insert : CHANGE_OPERATION.delete;
-            marksTrackedData.push(Object.assign(Object.assign({}, mark.attrs.dataTracked), { operation }));
-        }
-    });
-    if (marksTrackedData.length > 1) {
-        log.warn('inline node with more than 1 of tracked marks', marksTrackedData);
-    }
-    return marksTrackedData[0] || undefined;
-}
-export function getBlockInlineTrackedData(node) {
-    const { dataTracked } = node.attrs;
-    if (dataTracked && !Array.isArray(dataTracked)) {
-        return [dataTracked];
-    }
-    return dataTracked || [];
-}
-export function getMarkTrackedData(node) {
-    const tracked = node === null || node === void 0 ? void 0 : node.marks.reduce((acc, current) => {
-        if (isValidTrackableMark(current) && current.attrs.dataTracked) {
-            acc.set(current, current.attrs.dataTracked);
-        }
-        return acc;
-    }, new Map());
-    return tracked || new Map();
-}
-export function getNodeTrackedData(node, schema) {
-    let tracked;
-    if (node && !node.isText) {
-        tracked = getBlockInlineTrackedData(node);
-    }
-    else if (node === null || node === void 0 ? void 0 : node.isText) {
-        tracked = getTextNodeTrackedMarkData(node, schema);
-    }
-    if (tracked && !Array.isArray(tracked)) {
-        tracked = [tracked];
-    }
-    return tracked;
-}
-export function equalMarks(n1, n2) {
-    return (n1.marks.length === n2.marks.length &&
-        n1.marks.every((mark) => n1.marks.find((m) => m.type === mark.type)));
-}
-export function shouldMergeTrackedAttributes(left, right) {
-    if (!left || !right) {
-        log.warn('passed undefined dataTracked attributes to shouldMergeTrackedAttributes', {
-            left,
-            right,
-        });
-        return false;
-    }
-    return (left.status === right.status && left.operation === right.operation && left.authorID === right.authorID);
-}
-export function getMergeableMarkTrackedAttrs(node, attrs, schema) {
-    const nodeAttrs = getTextNodeTrackedMarkData(node, schema);
-    return nodeAttrs && shouldMergeTrackedAttributes(nodeAttrs, attrs) ? nodeAttrs : null;
-}

package/dist/es/steps/trackTransaction.js

@@ -1,156 +0,0 @@
-import { NodeSelection as NodeSelectionClass, TextSelection, } from 'prosemirror-state';
-import { AddMarkStep, AddNodeMarkStep, AttrStep, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, } from 'prosemirror-transform';
-import { getAction, TrackChangesAction } from '../actions';
-import { diffChangeSteps } from '../change-steps/diffChangeSteps';
-import { processChangeSteps } from '../change-steps/processChangeSteps';
-import { updateChangeAttrs } from '../changes/updateChangeAttrs';
-import { getNodeTrackedData } from '../compute/nodeHelpers';
-import { CHANGE_STATUS } from '../types/change';
-import { log } from '../utils/logger';
-import { mapChangeSteps } from '../utils/mapChangeStep';
-import { filterMeaninglessMoveSteps, handleDirectPendingMoveDeletions, HasMoveOperations, } from '../utils/track-utils';
-import { uuidv4 } from '../utils/uuidv4';
-import trackAttrsChange from './trackAttrsChange';
-import { trackAddMarkStep, trackAddNodeMarkStep, trackRemoveMarkStep, trackRemoveNodeMarkStep, } from './trackMarkSteps';
-import { trackReplaceAroundStep } from './trackReplaceAroundStep';
-import { trackReplaceStep } from './trackReplaceStep';
-import { isStructureSteps } from './utils';
-const getSelectionStaticConstructor = (sel) => Object.getPrototypeOf(sel).constructor;
-const isHighlightMarkerNode = (node) => node && node.type === node.type.schema.nodes.highlight_marker;
-export function trackTransaction(tr, oldState, newTr, authorID, changeSet) {
-    var _a, _b, _c, _d, _e, _f;
-    const emptyAttrs = {
-        authorID,
-        reviewedByID: null,
-        createdAt: tr.time,
-        updatedAt: tr.time,
-        statusUpdateAt: 0,
-        status: CHANGE_STATUS.pending,
-    };
-    const action = (_a = getAction(tr, TrackChangesAction.indentationAction)) === null || _a === void 0 ? void 0 : _a.action;
-    const isIndentation = action === 'indent' || action === 'unindent';
-    const wasNodeSelection = tr.selection instanceof NodeSelectionClass;
-    const setsNewSelection = tr.selectionSet;
-    const deletedNodeMapping = new Mapping();
-    let iters = 0;
-    log.info('ORIGINAL transaction', tr);
-    let trContext = {};
-    let movingStepsAssociated = HasMoveOperations(tr);
-    if (isIndentation) {
-        const moveId = uuidv4();
-        tr.steps.forEach((step) => {
-            if (step instanceof ReplaceStep) {
-                movingStepsAssociated.set(step, moveId);
-            }
-        });
-    }
-    handleDirectPendingMoveDeletions(tr, newTr, movingStepsAssociated);
-    const cleanSteps = filterMeaninglessMoveSteps(tr, movingStepsAssociated);
-    for (let i = cleanSteps.length - 1; i >= 0; i--) {
-        const step = cleanSteps[i];
-        log.info('transaction step', step);
-        iters += 1;
-        const uiEvent = tr.getMeta('uiEvent');
-        const isMassReplace = tr.getMeta('massSearchReplace');
-        if (iters > 20 && uiEvent != 'cut' && !isMassReplace) {
-            console.error('@manuscripts/track-changes-plugin: Possible infinite loop in iterating tr.steps, tracking skipped!\n' +
-                'This is probably an error with the library, please report back to maintainers with a reproduction if possible', newTr);
-            continue;
-        }
-        else if (!(step instanceof ReplaceStep) && step.constructor.name === 'ReplaceStep') {
-            console.error('@manuscripts/track-changes-plugin: Multiple prosemirror-transform packages imported, alias/dedupe them ' +
-                'or instanceof checks fail as well as creating new steps');
-            continue;
-        }
-        else if (step instanceof ReplaceStep) {
-            const { slice } = step;
-            if (((_c = (_b = slice === null || slice === void 0 ? void 0 : slice.content) === null || _b === void 0 ? void 0 : _b.content) === null || _c === void 0 ? void 0 : _c.length) === 1 && isHighlightMarkerNode(slice.content.content[0])) {
-                continue;
-            }
-            const invertedStep = step.invert(tr.docs[i]);
-            const isDelete = step.from !== step.to && step.slice.content.size < invertedStep.slice.content.size;
-            let thisStepMapping = tr.mapping.slice(i + 1, i + 1);
-            if (isDelete || isStructureSteps(tr)) {
-                thisStepMapping = deletedNodeMapping;
-            }
-            const newStep = new ReplaceStep(thisStepMapping.map(invertedStep.from), thisStepMapping.map(invertedStep.to), invertedStep.slice);
-            const stepResult = newTr.maybeStep(newStep);
-            let [steps, startPos] = trackReplaceStep(step, oldState, newTr, emptyAttrs, stepResult, tr.docs[i], tr, movingStepsAssociated.get(step));
-            if (steps.length === 1) {
-                const step = steps[0];
-                if (isHighlightMarkerNode((step === null || step === void 0 ? void 0 : step.node) || ((_e = (_d = step === null || step === void 0 ? void 0 : step.slice) === null || _d === void 0 ? void 0 : _d.content) === null || _e === void 0 ? void 0 : _e.content[0]))) {
-                    continue;
-                }
-            }
-            startPos = thisStepMapping.map(startPos);
-            steps = mapChangeSteps(steps, thisStepMapping);
-            log.info('CHANGES: ', steps);
-            const deleted = steps.filter((s) => s.type !== 'insert-slice');
-            const inserted = steps.filter((s) => s.type === 'insert-slice');
-            steps = diffChangeSteps(deleted, inserted);
-            log.info('DIFFED STEPS: ', steps);
-            const [mapping, selectionPos] = processChangeSteps(steps, startPos || tr.selection.head, newTr, movingStepsAssociated.has(step)
-                ? Object.assign(Object.assign({}, emptyAttrs), { moveNodeId: movingStepsAssociated.get(step) }) : emptyAttrs, oldState.schema, deletedNodeMapping);
-            if (!wasNodeSelection && !setsNewSelection) {
-                const sel = getSelectionStaticConstructor(tr.selection);
-                const near = sel.near(newTr.doc.resolve(selectionPos), -1);
-                newTr.setSelection(near);
-            }
-        }
-        else if (step instanceof ReplaceAroundStep) {
-            let steps = trackReplaceAroundStep(step, oldState, tr, newTr, emptyAttrs, tr.docs[i], trContext);
-            const deleted = steps.filter((s) => s.type !== 'insert-slice');
-            const inserted = steps.filter((s) => s.type === 'insert-slice');
-            log.info('INSERT STEPS: ', inserted);
-            steps = diffChangeSteps(deleted, inserted);
-            log.info('DIFFED STEPS: ', steps);
-            const [mapping, selectionPos] = processChangeSteps(steps, tr.selection.from, newTr, emptyAttrs, oldState.schema, deletedNodeMapping);
-        }
-        else if (step instanceof AttrStep) {
-            const changeSteps = trackAttrsChange(step, oldState, tr, newTr, emptyAttrs, tr.docs[i]);
-            const [mapping, selectionPos] = processChangeSteps(changeSteps, tr.selection.from, newTr, emptyAttrs, oldState.schema, deletedNodeMapping);
-        }
-        else if (step instanceof AddMarkStep) {
-            trackAddMarkStep(step, emptyAttrs, newTr, tr.docs[i]);
-            const dataTracked = (_f = getNodeTrackedData(newTr.doc.nodeAt(step.from), oldState.schema)) === null || _f === void 0 ? void 0 : _f.pop();
-            if (dataTracked) {
-                updateChangeAttrs(newTr, { id: dataTracked.id, from: step.from, to: step.to, type: 'text-change', dataTracked }, Object.assign(Object.assign({}, dataTracked), { id: uuidv4() }), oldState.schema);
-            }
-        }
-        else if (step instanceof RemoveMarkStep) {
-            trackRemoveMarkStep(step, emptyAttrs, newTr, tr.docs[i]);
-        }
-        else if (step instanceof RemoveNodeMarkStep) {
-            trackRemoveNodeMarkStep(step, emptyAttrs, newTr, tr.docs[i]);
-        }
-        else if (step instanceof AddNodeMarkStep) {
-            trackAddNodeMarkStep(step, emptyAttrs, newTr, tr.docs[i]);
-        }
-        tr.getMeta('inputType') && newTr.setMeta('inputType', tr.getMeta('inputType'));
-        tr.getMeta('uiEvent') && newTr.setMeta('uiEvent', tr.getMeta('uiEvent'));
-    }
-    if (setsNewSelection && tr.selection instanceof TextSelection) {
-        let from = tr.selection.from;
-        if (isStructureSteps(tr)) {
-            const selectionMapping = new Mapping();
-            tr.steps.map((step) => {
-                const isDeleteStep = step instanceof ReplaceStep && step.from !== step.to && step.slice.size === 0;
-                if (isDeleteStep) {
-                    selectionMapping.appendMap(step.getMap().invert());
-                }
-            });
-            selectionMapping.appendMapping(deletedNodeMapping);
-            from = selectionMapping.map(tr.selection.from);
-        }
-        const newPos = newTr.doc.resolve(from);
-        newTr.setSelection(new TextSelection(newPos));
-    }
-    if (wasNodeSelection) {
-        log.info('Getting into node select!');
-        const mappedPos = newTr.mapping.map(tr.selection.from, -1);
-        const sel = getSelectionStaticConstructor(tr.selection);
-        newTr.setSelection(sel.create(newTr.doc, mappedPos));
-    }
-    log.info('NEW transaction', newTr);
-    return newTr;
-}

package/dist/es/types/step.js

@@ -1 +0,0 @@
-export {};