@atlaskit/editor-plugin-track-changes
Version:
ShowDiff plugin for @atlaskit/editor-core
156 lines (152 loc) • 10.4 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.trackChangesPluginKey = exports.getBaselineFromSteps = exports.createTrackChangesPlugin = void 0;
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
var _state = require("@atlaskit/editor-prosemirror/state");
var _transform = require("@atlaskit/editor-prosemirror/transform");
var _filterSteps2 = require("./filterSteps");
var _invertableStep = require("./invertableStep");
var _types = require("./types");
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
var trackChangesPluginKey = exports.trackChangesPluginKey = new _state.PluginKey('trackChangesPlugin');
// Exported for test purposes
var getBaselineFromSteps = exports.getBaselineFromSteps = function getBaselineFromSteps(doc, steps) {
try {
// Filter out AttrStep's since attribute changes shouldn't affect baseline content comparison
var contentSteps = steps.filter(function (step) {
return !(step.step instanceof _transform.AttrStep);
});
var _iterator = _createForOfIteratorHelper(contentSteps.slice().reverse()),
_step;
try {
for (_iterator.s(); !(_step = _iterator.n()).done;) {
var step = _step.value;
var result = step.inverted.apply(doc);
if (result.failed === null && result.doc) {
doc = result.doc;
}
}
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
return doc;
} catch (_unused) {
// Temporary - we need to understand how this happens - but we want to unblock issues where this crashes the editor
return undefined;
}
};
var createTrackChangesPlugin = exports.createTrackChangesPlugin = function createTrackChangesPlugin(api) {
// Mark the state to be reset on next time the document has a meaningful change
var resetBaseline = false;
return new _safePlugin.SafePlugin({
key: trackChangesPluginKey,
state: {
init: function init() {
return {
steps: [],
shouldChangesBeDisplayed: false,
isShowDiffAvailable: false,
allocations: new Set()
};
},
apply: function apply(tr, state) {
var _api$history, _state$steps$at$alloc, _state$steps$at;
var metadata = tr.getMeta(trackChangesPluginKey);
if (metadata && metadata.action === _types.TOGGLE_TRACK_CHANGES_ACTION.RESET_BASELINE) {
return _objectSpread(_objectSpread({}, state), {}, {
steps: [],
isShowDiffAvailable: false
});
}
if (metadata && metadata.action === _types.TOGGLE_TRACK_CHANGES_ACTION.TOGGLE_TRACK_CHANGES) {
resetBaseline = true;
return _objectSpread(_objectSpread({}, state), {}, {
shouldChangesBeDisplayed: !state.shouldChangesBeDisplayed
});
}
var isDocChanged = tr.docChanged && tr.steps.some(function (step) {
return step instanceof _transform.ReplaceStep || step instanceof _transform.ReplaceAroundStep || step instanceof _transform.AddMarkStep || step instanceof _transform.RemoveMarkStep || step instanceof _transform.AttrStep;
});
var isAnnotationStep = function isAnnotationStep(step) {
return step instanceof _transform.AddMarkStep && step.mark.type.name === 'annotation';
};
if (!isDocChanged || tr.getMeta('isRemote') || tr.getMeta('replaceDocument') || tr.steps.some(isAnnotationStep)) {
// If the transaction is remote, we need to map the steps to the current document
return _objectSpread(_objectSpread({}, state), {}, {
steps: state.steps.map(function (s) {
var newStep = s.step.map(tr.mapping);
var newInvertedStep = s.inverted.map(tr.mapping);
if (newStep && newInvertedStep) {
return new _invertableStep.InvertableStep(newStep, newInvertedStep, s.allocation);
}
return undefined;
}).filter(function (s) {
return !!s;
})
});
}
// If we don't have the history plugin don't limit the change tracking
var historyState = api === null || api === void 0 || (_api$history = api.history) === null || _api$history === void 0 ? void 0 : _api$history.sharedState.currentState();
var currentAllocation = historyState ?
// Combine both done + undone so we have the total "distance".
historyState.done.eventCount + historyState.undone.eventCount : ((_state$steps$at$alloc = (_state$steps$at = state.steps.at(-1)) === null || _state$steps$at === void 0 ? void 0 : _state$steps$at.allocation) !== null && _state$steps$at$alloc !== void 0 ? _state$steps$at$alloc : 0) + 1;
var newSteps = tr.steps.map(function (step, idx) {
return new _invertableStep.InvertableStep(step, step.invert(tr.docs[idx]), currentAllocation);
});
var concatSteps = resetBaseline ? newSteps : [].concat((0, _toConsumableArray2.default)(state.steps), (0, _toConsumableArray2.default)(newSteps));
resetBaseline = false;
var _filterSteps = (0, _filterSteps2.filterSteps)(concatSteps, state.allocations.add(currentAllocation)),
allocations = _filterSteps.allocations,
steps = _filterSteps.steps;
// Calculate if there are actual changes by comparing current doc with baseline
var baselineDoc = getBaselineFromSteps(tr.doc, steps);
var hasChangesFromBaseline = baselineDoc ? !tr.doc.eq(baselineDoc) : false;
// Create a new ChangeSet based on document changes
return _objectSpread(_objectSpread({}, state), {}, {
allocations: allocations,
steps: steps,
shouldChangesBeDisplayed: false,
isShowDiffAvailable: hasChangesFromBaseline
});
}
},
view: function view() {
return {
update: function update(view, prevState) {
var _trackChangesPluginKe;
var prevShouldChangesBeDisplayed = (_trackChangesPluginKe = trackChangesPluginKey.getState(prevState)) === null || _trackChangesPluginKe === void 0 ? void 0 : _trackChangesPluginKe.shouldChangesBeDisplayed;
var currentPluginState = trackChangesPluginKey.getState(view.state);
var currentShouldChangesBeDisplayed = currentPluginState === null || currentPluginState === void 0 ? void 0 : currentPluginState.shouldChangesBeDisplayed;
if (prevShouldChangesBeDisplayed === false && currentShouldChangesBeDisplayed === true) {
var _currentPluginState$s;
var steps = (_currentPluginState$s = currentPluginState === null || currentPluginState === void 0 ? void 0 : currentPluginState.steps) !== null && _currentPluginState$s !== void 0 ? _currentPluginState$s : [];
var originalDoc = getBaselineFromSteps(view.state.doc, steps);
if (originalDoc) {
var _api$core, _api$showDiff;
api === null || api === void 0 || (_api$core = api.core) === null || _api$core === void 0 || _api$core.actions.execute(api === null || api === void 0 || (_api$showDiff = api.showDiff) === null || _api$showDiff === void 0 || (_api$showDiff = _api$showDiff.commands) === null || _api$showDiff === void 0 ? void 0 : _api$showDiff.showDiff({
originalDoc: originalDoc,
steps: steps.map(function (s) {
return s.step;
})
}));
}
} else if (currentShouldChangesBeDisplayed === false && prevShouldChangesBeDisplayed === true) {
var _api$core2, _api$showDiff2;
api === null || api === void 0 || (_api$core2 = api.core) === null || _api$core2 === void 0 || _api$core2.actions.execute(api === null || api === void 0 || (_api$showDiff2 = api.showDiff) === null || _api$showDiff2 === void 0 || (_api$showDiff2 = _api$showDiff2.commands) === null || _api$showDiff2 === void 0 ? void 0 : _api$showDiff2.hideDiff);
}
}
};
}
});
};