@atlaskit/editor-plugin-show-diff 0.0.3 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 0.1.1
+
+### Patch Changes
+
+- [`941fdc429d140`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/941fdc429d140) -
+  Show formatting changes in the diff
+- Updated dependencies
+
+## 0.1.0
+
+### Minor Changes
+
+- [`81ec1e909620a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/81ec1e909620a) -
+  [EDITOR-1206] Have `editor-plugin-show-diff` expose if the plugin is displaying the diff.
+  Deprecate the state in `editor-plugin-track-changes` as it depends on `editor-plugin-show-diff`
+  and it's better to have the state in the plugin that actually shows the diff
+
 ## 0.0.3
 
 ### Patch Changes

package/afm-passionfruit/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"extends": "../../../../tsconfig.entry-points.passionfruit.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../passionfruit/tsDist/@atlaskit__editor-plugin-show-diff/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../../design-system/tokens/afm-passionfruit/tsconfig.json"
+		},
+		{
+			"path": "../../editor-common/afm-passionfruit/tsconfig.json"
+		}
+	]
+}

package/afm-volt/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"extends": "../../../../tsconfig.entry-points.volt.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../volt/tsDist/@atlaskit__editor-plugin-show-diff/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../../design-system/tokens/afm-volt/tsconfig.json"
+		},
+		{
+			"path": "../../editor-common/afm-volt/tsconfig.json"
+		}
+	]
+}

package/dist/cjs/pm-plugins/main.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.showDiffPluginKey = exports.createPlugin = void 0;
-var _readOnlyError2 = _interopRequireDefault(require("@babel/runtime/helpers/readOnlyError"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _prosemirrorChangeset = require("prosemirror-changeset");
 var _processRawValue = require("@atlaskit/editor-common/process-raw-value");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
@@ -13,81 +13,121 @@ var _state = require("@atlaskit/editor-prosemirror/state");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _view = require("@atlaskit/editor-prosemirror/view");
 var _decorations = require("./decorations");
+var _markDecorations = require("./markDecorations");
+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; }
+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; } // eslint-disable-next-line @atlassian/tangerine/import/entry-points
+var calculateDecorations = function calculateDecorations(_ref) {
+  var state = _ref.state,
+    pluginState = _ref.pluginState;
+  var originalDoc = pluginState.originalDoc,
+    steps = pluginState.steps;
+  if (!originalDoc || !pluginState.isDisplayingChanges) {
+    return _view.DecorationSet.empty;
+  }
+  var tr = state.tr;
+  var steppedDoc = originalDoc;
+  var changeset = _prosemirrorChangeset.ChangeSet.create(originalDoc);
+  var _iterator = _createForOfIteratorHelper(steps),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      var result = step.apply(steppedDoc);
+      if (result.failed === null && result.doc) {
+        steppedDoc = result.doc;
+        changeset = changeset.addSteps(steppedDoc, [step.getMap()], tr.doc);
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  if (!steppedDoc.eq(tr.doc)) {
+    return _view.DecorationSet.empty;
+  }
+  var changes = (0, _prosemirrorChangeset.simplifyChanges)(changeset.changes, tr.doc);
+  var decorations = [];
+  changes.forEach(function (change) {
+    if (change.inserted.length > 0) {
+      decorations.push((0, _decorations.createInlineChangedDecoration)(change));
+    }
+    if (change.deleted.length > 0) {
+      decorations.push((0, _decorations.createDeletedContentDecoration)({
+        change: change,
+        doc: originalDoc,
+        tr: tr
+      }));
+    }
+  });
+  (0, _markDecorations.getMarkChangeRanges)(steps).forEach(function (change) {
+    decorations.push((0, _decorations.createInlineChangedDecoration)(change));
+  });
+  return _view.DecorationSet.empty.add(tr.doc, decorations);
+};
 var showDiffPluginKey = exports.showDiffPluginKey = new _state.PluginKey('showDiffPlugin');
 var createPlugin = exports.createPlugin = function createPlugin(config) {
   return new _safePlugin.SafePlugin({
     key: showDiffPluginKey,
     state: {
       init: function init(_, state) {
-        var _config$steps;
+        var _config$steps, _config$steps2;
         var schema = state.schema;
+        var isDisplayingChanges = ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).length > 0;
         return {
-          steps: ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).map(function (step) {
+          steps: ((_config$steps2 = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps2 !== void 0 ? _config$steps2 : []).map(function (step) {
             return _transform.Step.fromJSON(schema, step);
           }),
-          originalDoc: config !== null && config !== void 0 && config.originalDoc ? (0, _processRawValue.processRawValue)(state.schema, config.originalDoc) : undefined
+          originalDoc: config !== null && config !== void 0 && config.originalDoc ? (0, _processRawValue.processRawValue)(state.schema, config.originalDoc) : undefined,
+          decorations: calculateDecorations({
+            state: state,
+            pluginState: {
+              steps: [],
+              originalDoc: config !== null && config !== void 0 && config.originalDoc ? (0, _processRawValue.processRawValue)(state.schema, config.originalDoc) : undefined,
+              isDisplayingChanges: isDisplayingChanges
+            }
+          }),
+          isDisplayingChanges: isDisplayingChanges
         };
       },
-      apply: function apply(tr, currentPluginState) {
+      apply: function apply(tr, currentPluginState, oldState, newState) {
         var meta = tr.getMeta(showDiffPluginKey);
+        var newPluginState = currentPluginState;
         if (meta) {
-          return meta;
+          if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SHOW_DIFF') {
+            newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              isDisplayingChanges: true
+            });
+          } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
+            newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              isDisplayingChanges: false
+            });
+          } else {
+            newPluginState = _objectSpread(_objectSpread({}, currentPluginState), meta);
+          }
         }
-        return currentPluginState;
+
+        // Calculate and store decorations in state
+        var decorations = calculateDecorations({
+          state: newState,
+          pluginState: {
+            steps: newPluginState.steps,
+            originalDoc: newPluginState.originalDoc,
+            isDisplayingChanges: newPluginState.isDisplayingChanges
+          }
+        });
+        return _objectSpread(_objectSpread({}, newPluginState), {}, {
+          decorations: decorations
+        });
       }
     },
     props: {
       decorations: function decorations(state) {
         var pluginState = showDiffPluginKey.getState(state);
-        if (!pluginState) {
-          return undefined;
-        }
-        var originalDoc = pluginState.originalDoc,
-          steps = pluginState.steps;
-        if (!originalDoc) {
-          return undefined;
-        }
-        var tr = state.tr;
-        var steppedDoc = originalDoc;
-        var changeset = _prosemirrorChangeset.ChangeSet.create(originalDoc);
-        var _iterator = _createForOfIteratorHelper(steps),
-          _step;
-        try {
-          for (_iterator.s(); !(_step = _iterator.n()).done;) {
-            var step = _step.value;
-            var result = step.apply(steppedDoc);
-            if (result.failed === null && result.doc) {
-              steppedDoc = result.doc;
-              changeset = changeset.addSteps(steppedDoc, [step.getMap()], tr.doc);
-            }
-          }
-        } catch (err) {
-          _iterator.e(err);
-        } finally {
-          _iterator.f();
-        }
-        if (!steppedDoc.eq(tr.doc)) {
-          return undefined;
-        }
-        var changes = (0, _prosemirrorChangeset.simplifyChanges)(changeset.changes, tr.doc);
-        var decoration = _view.DecorationSet.empty;
-        var decorations = [];
-        changes.forEach(function (change) {
-          if (change.inserted.length > 0) {
-            decorations.push((0, _decorations.createInlineChangedDecoration)(change));
-          }
-          if (change.deleted.length > 0) {
-            decorations.push((0, _decorations.createDeletedContentDecoration)({
-              change: change,
-              doc: originalDoc,
-              tr: tr
-            }));
-          }
-        });
-        return decoration.add(tr.doc, decorations);
+        return pluginState === null || pluginState === void 0 ? void 0 : pluginState.decorations;
       }
     }
   });

package/dist/cjs/pm-plugins/markDecorations.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getMarkChangeRanges = void 0;
+var _transform = require("@atlaskit/editor-prosemirror/transform");
+var filterUndefined = function filterUndefined(x) {
+  return !!x;
+};
+var getMarkChangeRanges = exports.getMarkChangeRanges = function getMarkChangeRanges(steps) {
+  return steps.map(function (step) {
+    if (step instanceof _transform.AddMarkStep || step instanceof _transform.RemoveMarkStep) {
+      return {
+        fromB: step.from,
+        toB: step.to
+      };
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

package/dist/cjs/showDiffPlugin.js

@@ -1,10 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.showDiffPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _main = require("./pm-plugins/main");
+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; }
 var showDiffPlugin = exports.showDiffPlugin = function showDiffPlugin(_ref) {
   var api = _ref.api,
     config = _ref.config;
@@ -14,13 +18,16 @@ var showDiffPlugin = exports.showDiffPlugin = function showDiffPlugin(_ref) {
       showDiff: function showDiff(params) {
         return function (_ref2) {
           var tr = _ref2.tr;
-          return tr.setMeta(_main.showDiffPluginKey, params);
+          return tr.setMeta(_main.showDiffPluginKey, _objectSpread(_objectSpread({}, params), {}, {
+            action: 'SHOW_DIFF'
+          }));
         };
       },
       hideDiff: function hideDiff(_ref3) {
         var tr = _ref3.tr;
         return tr.setMeta(_main.showDiffPluginKey, {
-          steps: []
+          steps: [],
+          action: 'HIDE_DIFF'
         });
       }
     },
@@ -31,6 +38,19 @@ var showDiffPlugin = exports.showDiffPlugin = function showDiffPlugin(_ref) {
           return (0, _main.createPlugin)(config);
         }
       }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      var _pluginState$decorati;
+      if (!editorState) {
+        return {
+          isDisplayingChanges: false
+        };
+      }
+      var pluginState = _main.showDiffPluginKey.getState(editorState);
+      var decorationCount = (pluginState === null || pluginState === void 0 || (_pluginState$decorati = pluginState.decorations) === null || _pluginState$decorati === void 0 ? void 0 : _pluginState$decorati.find()) || [];
+      return {
+        isDisplayingChanges: decorationCount.length > 0
+      };
     }
   };
 };

package/dist/es2019/pm-plugins/main.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
 import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
 import { processRawValue } from '@atlaskit/editor-common/process-raw-value';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
@@ -5,71 +6,118 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { createInlineChangedDecoration, createDeletedContentDecoration } from './decorations';
+import { getMarkChangeRanges } from './markDecorations';
+const calculateDecorations = ({
+  state,
+  pluginState
+}) => {
+  const {
+    originalDoc,
+    steps
+  } = pluginState;
+  if (!originalDoc || !pluginState.isDisplayingChanges) {
+    return DecorationSet.empty;
+  }
+  const {
+    tr
+  } = state;
+  let steppedDoc = originalDoc;
+  let changeset = ChangeSet.create(originalDoc);
+  for (const step of steps) {
+    const result = step.apply(steppedDoc);
+    if (result.failed === null && result.doc) {
+      steppedDoc = result.doc;
+      changeset = changeset.addSteps(steppedDoc, [step.getMap()], tr.doc);
+    }
+  }
+  if (!steppedDoc.eq(tr.doc)) {
+    return DecorationSet.empty;
+  }
+  const changes = simplifyChanges(changeset.changes, tr.doc);
+  const decorations = [];
+  changes.forEach(change => {
+    if (change.inserted.length > 0) {
+      decorations.push(createInlineChangedDecoration(change));
+    }
+    if (change.deleted.length > 0) {
+      decorations.push(createDeletedContentDecoration({
+        change,
+        doc: originalDoc,
+        tr
+      }));
+    }
+  });
+  getMarkChangeRanges(steps).forEach(change => {
+    decorations.push(createInlineChangedDecoration(change));
+  });
+  return DecorationSet.empty.add(tr.doc, decorations);
+};
 export const showDiffPluginKey = new PluginKey('showDiffPlugin');
 export const createPlugin = config => {
   return new SafePlugin({
     key: showDiffPluginKey,
     state: {
       init(_, state) {
-        var _config$steps;
+        var _config$steps, _config$steps2;
         const schema = state.schema;
+        const isDisplayingChanges = ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).length > 0;
         return {
-          steps: ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).map(step => ProseMirrorStep.fromJSON(schema, step)),
-          originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined
+          steps: ((_config$steps2 = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps2 !== void 0 ? _config$steps2 : []).map(step => ProseMirrorStep.fromJSON(schema, step)),
+          originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
+          decorations: calculateDecorations({
+            state,
+            pluginState: {
+              steps: [],
+              originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
+              isDisplayingChanges
+            }
+          }),
+          isDisplayingChanges
         };
       },
-      apply: (tr, currentPluginState) => {
+      apply: (tr, currentPluginState, oldState, newState) => {
         const meta = tr.getMeta(showDiffPluginKey);
+        let newPluginState = currentPluginState;
         if (meta) {
-          return meta;
+          if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SHOW_DIFF') {
+            newPluginState = {
+              ...currentPluginState,
+              ...meta,
+              isDisplayingChanges: true
+            };
+          } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
+            newPluginState = {
+              ...currentPluginState,
+              ...meta,
+              isDisplayingChanges: false
+            };
+          } else {
+            newPluginState = {
+              ...currentPluginState,
+              ...meta
+            };
+          }
         }
-        return currentPluginState;
+
+        // Calculate and store decorations in state
+        const decorations = calculateDecorations({
+          state: newState,
+          pluginState: {
+            steps: newPluginState.steps,
+            originalDoc: newPluginState.originalDoc,
+            isDisplayingChanges: newPluginState.isDisplayingChanges
+          }
+        });
+        return {
+          ...newPluginState,
+          decorations
+        };
       }
     },
     props: {
       decorations: state => {
         const pluginState = showDiffPluginKey.getState(state);
-        if (!pluginState) {
-          return undefined;
-        }
-        const {
-          originalDoc,
-          steps
-        } = pluginState;
-        if (!originalDoc) {
-          return undefined;
-        }
-        const {
-          tr
-        } = state;
-        let steppedDoc = originalDoc;
-        let changeset = ChangeSet.create(originalDoc);
-        for (const step of steps) {
-          const result = step.apply(steppedDoc);
-          if (result.failed === null && result.doc) {
-            steppedDoc = result.doc;
-            changeset = changeset.addSteps(steppedDoc, [step.getMap()], tr.doc);
-          }
-        }
-        if (!steppedDoc.eq(tr.doc)) {
-          return undefined;
-        }
-        const changes = simplifyChanges(changeset.changes, tr.doc);
-        const decoration = DecorationSet.empty;
-        const decorations = [];
-        changes.forEach(change => {
-          if (change.inserted.length > 0) {
-            decorations.push(createInlineChangedDecoration(change));
-          }
-          if (change.deleted.length > 0) {
-            decorations.push(createDeletedContentDecoration({
-              change,
-              doc: originalDoc,
-              tr
-            }));
-          }
-        });
-        return decoration.add(tr.doc, decorations);
+        return pluginState === null || pluginState === void 0 ? void 0 : pluginState.decorations;
       }
     }
   });

package/dist/es2019/pm-plugins/markDecorations.js

@@ -0,0 +1,13 @@
+import { AddMarkStep, RemoveMarkStep } from '@atlaskit/editor-prosemirror/transform';
+const filterUndefined = x => !!x;
+export const getMarkChangeRanges = steps => {
+  return steps.map(step => {
+    if (step instanceof AddMarkStep || step instanceof RemoveMarkStep) {
+      return {
+        fromB: step.from,
+        toB: step.to
+      };
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

package/dist/es2019/showDiffPlugin.js

@@ -8,13 +8,17 @@ export const showDiffPlugin = ({
     showDiff: params => ({
       tr
     }) => {
-      return tr.setMeta(showDiffPluginKey, params);
+      return tr.setMeta(showDiffPluginKey, {
+        ...params,
+        action: 'SHOW_DIFF'
+      });
     },
     hideDiff: ({
       tr
     }) => {
       return tr.setMeta(showDiffPluginKey, {
-        steps: []
+        steps: [],
+        action: 'HIDE_DIFF'
       });
     }
   },
@@ -23,5 +27,18 @@ export const showDiffPlugin = ({
       name: 'showDiffPlugin',
       plugin: () => createPlugin(config)
     }];
+  },
+  getSharedState: editorState => {
+    var _pluginState$decorati;
+    if (!editorState) {
+      return {
+        isDisplayingChanges: false
+      };
+    }
+    const pluginState = showDiffPluginKey.getState(editorState);
+    const decorationCount = (pluginState === null || pluginState === void 0 ? void 0 : (_pluginState$decorati = pluginState.decorations) === null || _pluginState$decorati === void 0 ? void 0 : _pluginState$decorati.find()) || [];
+    return {
+      isDisplayingChanges: decorationCount.length > 0
+    };
   }
 });

package/dist/esm/pm-plugins/main.js

@@ -1,7 +1,10 @@
-import _readOnlyError from "@babel/runtime/helpers/readOnlyError";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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) { _defineProperty(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; }
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
 import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
 import { processRawValue } from '@atlaskit/editor-common/process-raw-value';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
@@ -9,78 +12,116 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { createInlineChangedDecoration, createDeletedContentDecoration } from './decorations';
+import { getMarkChangeRanges } from './markDecorations';
+var calculateDecorations = function calculateDecorations(_ref) {
+  var state = _ref.state,
+    pluginState = _ref.pluginState;
+  var originalDoc = pluginState.originalDoc,
+    steps = pluginState.steps;
+  if (!originalDoc || !pluginState.isDisplayingChanges) {
+    return DecorationSet.empty;
+  }
+  var tr = state.tr;
+  var steppedDoc = originalDoc;
+  var changeset = ChangeSet.create(originalDoc);
+  var _iterator = _createForOfIteratorHelper(steps),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      var result = step.apply(steppedDoc);
+      if (result.failed === null && result.doc) {
+        steppedDoc = result.doc;
+        changeset = changeset.addSteps(steppedDoc, [step.getMap()], tr.doc);
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  if (!steppedDoc.eq(tr.doc)) {
+    return DecorationSet.empty;
+  }
+  var changes = simplifyChanges(changeset.changes, tr.doc);
+  var decorations = [];
+  changes.forEach(function (change) {
+    if (change.inserted.length > 0) {
+      decorations.push(createInlineChangedDecoration(change));
+    }
+    if (change.deleted.length > 0) {
+      decorations.push(createDeletedContentDecoration({
+        change: change,
+        doc: originalDoc,
+        tr: tr
+      }));
+    }
+  });
+  getMarkChangeRanges(steps).forEach(function (change) {
+    decorations.push(createInlineChangedDecoration(change));
+  });
+  return DecorationSet.empty.add(tr.doc, decorations);
+};
 export var showDiffPluginKey = new PluginKey('showDiffPlugin');
 export var createPlugin = function createPlugin(config) {
   return new SafePlugin({
     key: showDiffPluginKey,
     state: {
       init: function init(_, state) {
-        var _config$steps;
+        var _config$steps, _config$steps2;
         var schema = state.schema;
+        var isDisplayingChanges = ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).length > 0;
         return {
-          steps: ((_config$steps = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps !== void 0 ? _config$steps : []).map(function (step) {
+          steps: ((_config$steps2 = config === null || config === void 0 ? void 0 : config.steps) !== null && _config$steps2 !== void 0 ? _config$steps2 : []).map(function (step) {
             return ProseMirrorStep.fromJSON(schema, step);
           }),
-          originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined
+          originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
+          decorations: calculateDecorations({
+            state: state,
+            pluginState: {
+              steps: [],
+              originalDoc: config !== null && config !== void 0 && config.originalDoc ? processRawValue(state.schema, config.originalDoc) : undefined,
+              isDisplayingChanges: isDisplayingChanges
+            }
+          }),
+          isDisplayingChanges: isDisplayingChanges
         };
       },
-      apply: function apply(tr, currentPluginState) {
+      apply: function apply(tr, currentPluginState, oldState, newState) {
         var meta = tr.getMeta(showDiffPluginKey);
+        var newPluginState = currentPluginState;
         if (meta) {
-          return meta;
+          if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SHOW_DIFF') {
+            newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              isDisplayingChanges: true
+            });
+          } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
+            newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
+              isDisplayingChanges: false
+            });
+          } else {
+            newPluginState = _objectSpread(_objectSpread({}, currentPluginState), meta);
+          }
         }
-        return currentPluginState;
+
+        // Calculate and store decorations in state
+        var decorations = calculateDecorations({
+          state: newState,
+          pluginState: {
+            steps: newPluginState.steps,
+            originalDoc: newPluginState.originalDoc,
+            isDisplayingChanges: newPluginState.isDisplayingChanges
+          }
+        });
+        return _objectSpread(_objectSpread({}, newPluginState), {}, {
+          decorations: decorations
+        });
       }
     },
     props: {
       decorations: function decorations(state) {
         var pluginState = showDiffPluginKey.getState(state);
-        if (!pluginState) {
-          return undefined;
-        }
-        var originalDoc = pluginState.originalDoc,
-          steps = pluginState.steps;
-        if (!originalDoc) {
-          return undefined;
-        }
-        var tr = state.tr;
-        var steppedDoc = originalDoc;
-        var changeset = ChangeSet.create(originalDoc);
-        var _iterator = _createForOfIteratorHelper(steps),
-          _step;
-        try {
-          for (_iterator.s(); !(_step = _iterator.n()).done;) {
-            var step = _step.value;
-            var result = step.apply(steppedDoc);
-            if (result.failed === null && result.doc) {
-              steppedDoc = result.doc;
-              changeset = changeset.addSteps(steppedDoc, [step.getMap()], tr.doc);
-            }
-          }
-        } catch (err) {
-          _iterator.e(err);
-        } finally {
-          _iterator.f();
-        }
-        if (!steppedDoc.eq(tr.doc)) {
-          return undefined;
-        }
-        var changes = simplifyChanges(changeset.changes, tr.doc);
-        var decoration = DecorationSet.empty;
-        var decorations = [];
-        changes.forEach(function (change) {
-          if (change.inserted.length > 0) {
-            decorations.push(createInlineChangedDecoration(change));
-          }
-          if (change.deleted.length > 0) {
-            decorations.push(createDeletedContentDecoration({
-              change: change,
-              doc: originalDoc,
-              tr: tr
-            }));
-          }
-        });
-        return decoration.add(tr.doc, decorations);
+        return pluginState === null || pluginState === void 0 ? void 0 : pluginState.decorations;
       }
     }
   });

package/dist/esm/pm-plugins/markDecorations.js

@@ -0,0 +1,15 @@
+import { AddMarkStep, RemoveMarkStep } from '@atlaskit/editor-prosemirror/transform';
+var filterUndefined = function filterUndefined(x) {
+  return !!x;
+};
+export var getMarkChangeRanges = function getMarkChangeRanges(steps) {
+  return steps.map(function (step) {
+    if (step instanceof AddMarkStep || step instanceof RemoveMarkStep) {
+      return {
+        fromB: step.from,
+        toB: step.to
+      };
+    }
+    return undefined;
+  }).filter(filterUndefined);
+};

package/dist/esm/showDiffPlugin.js

@@ -1,3 +1,6 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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) { _defineProperty(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; }
 import { createPlugin, showDiffPluginKey } from './pm-plugins/main';
 export var showDiffPlugin = function showDiffPlugin(_ref) {
   var api = _ref.api,
@@ -8,13 +11,16 @@ export var showDiffPlugin = function showDiffPlugin(_ref) {
       showDiff: function showDiff(params) {
         return function (_ref2) {
           var tr = _ref2.tr;
-          return tr.setMeta(showDiffPluginKey, params);
+          return tr.setMeta(showDiffPluginKey, _objectSpread(_objectSpread({}, params), {}, {
+            action: 'SHOW_DIFF'
+          }));
         };
       },
       hideDiff: function hideDiff(_ref3) {
         var tr = _ref3.tr;
         return tr.setMeta(showDiffPluginKey, {
-          steps: []
+          steps: [],
+          action: 'HIDE_DIFF'
         });
       }
     },
@@ -25,6 +31,19 @@ export var showDiffPlugin = function showDiffPlugin(_ref) {
           return createPlugin(config);
         }
       }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      var _pluginState$decorati;
+      if (!editorState) {
+        return {
+          isDisplayingChanges: false
+        };
+      }
+      var pluginState = showDiffPluginKey.getState(editorState);
+      var decorationCount = (pluginState === null || pluginState === void 0 || (_pluginState$decorati = pluginState.decorations) === null || _pluginState$decorati === void 0 ? void 0 : _pluginState$decorati.find()) || [];
+      return {
+        isDisplayingChanges: decorationCount.length > 0
+      };
     }
   };
 };

package/dist/types/pm-plugins/decorations.d.ts

@@ -8,7 +8,10 @@ import { Decoration } from '@atlaskit/editor-prosemirror/view';
  * @param change Changeset "change" containing information about the change content + range
  * @returns Prosemirror inline decoration
  */
-export declare const createInlineChangedDecoration: (change: Change) => Decoration;
+export declare const createInlineChangedDecoration: (change: {
+    fromB: number;
+    toB: number;
+}) => Decoration;
 interface DeletedContentDecorationProps {
     change: Change;
     doc: PMNode;

package/dist/types/pm-plugins/main.d.ts

@@ -2,11 +2,14 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import type { DiffParams } from '../showDiffPluginType';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { type DiffParams } from '../showDiffPluginType';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
 type ShowDiffPluginState = {
     steps: ProseMirrorStep[];
     originalDoc: PMNode | undefined;
+    decorations: DecorationSet;
+    isDisplayingChanges: boolean;
 };
 export declare const createPlugin: (config: DiffParams | undefined) => SafePlugin<ShowDiffPluginState>;
 export {};

package/dist/types/pm-plugins/markDecorations.d.ts

@@ -0,0 +1,7 @@
+import { type Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+type StepRange = {
+    fromB: number;
+    toB: number;
+};
+export declare const getMarkChangeRanges: (steps: ProseMirrorStep[]) => StepRange[];
+export {};

package/dist/types/showDiffPluginType.d.ts

@@ -17,10 +17,18 @@ export type PMDiffParams = {
     steps: Step[];
     originalDoc: Node;
 };
+export type ACTION = 'SHOW_DIFF' | 'HIDE_DIFF';
 export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
     pluginConfiguration: DiffParams | undefined;
     commands: {
         showDiff: (config: PMDiffParams) => EditorCommand;
         hideDiff: EditorCommand;
     };
+    sharedState: {
+        /**
+         * Whether the show diff feature is currently displaying changes.
+         * Defaults to false.
+         */
+        isDisplayingChanges: boolean;
+    };
 }>;

package/dist/types-ts4.5/pm-plugins/decorations.d.ts

@@ -8,7 +8,10 @@ import { Decoration } from '@atlaskit/editor-prosemirror/view';
  * @param change Changeset "change" containing information about the change content + range
  * @returns Prosemirror inline decoration
  */
-export declare const createInlineChangedDecoration: (change: Change) => Decoration;
+export declare const createInlineChangedDecoration: (change: {
+    fromB: number;
+    toB: number;
+}) => Decoration;
 interface DeletedContentDecorationProps {
     change: Change;
     doc: PMNode;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -2,11 +2,14 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import type { DiffParams } from '../showDiffPluginType';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { type DiffParams } from '../showDiffPluginType';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
 type ShowDiffPluginState = {
     steps: ProseMirrorStep[];
     originalDoc: PMNode | undefined;
+    decorations: DecorationSet;
+    isDisplayingChanges: boolean;
 };
 export declare const createPlugin: (config: DiffParams | undefined) => SafePlugin<ShowDiffPluginState>;
 export {};

package/dist/types-ts4.5/pm-plugins/markDecorations.d.ts

@@ -0,0 +1,7 @@
+import { type Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+type StepRange = {
+    fromB: number;
+    toB: number;
+};
+export declare const getMarkChangeRanges: (steps: ProseMirrorStep[]) => StepRange[];
+export {};

package/dist/types-ts4.5/showDiffPluginType.d.ts

@@ -17,10 +17,18 @@ export type PMDiffParams = {
     steps: Step[];
     originalDoc: Node;
 };
+export type ACTION = 'SHOW_DIFF' | 'HIDE_DIFF';
 export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
     pluginConfiguration: DiffParams | undefined;
     commands: {
         showDiff: (config: PMDiffParams) => EditorCommand;
         hideDiff: EditorCommand;
     };
+    sharedState: {
+        /**
+         * Whether the show diff feature is currently displaying changes.
+         * Defaults to false.
+         */
+        isDisplayingChanges: boolean;
+    };
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "0.0.3",
+	"version": "0.1.1",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -37,7 +37,7 @@
 		"prosemirror-changeset": "^2.2.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.19.0",
+		"@atlaskit/editor-common": "^107.23.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {