@atlaskit/editor-plugin-show-diff 9.1.2 → 10.0.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 10.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
+### Minor Changes
+
+- [`4759c2ac86196`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4759c2ac86196) -
+  EDITOR-7523: Add diff descriptors with new diff ids and types.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.1.2
 
 ### Patch Changes

package/dist/cjs/pm-plugins/calculateDiff/calculateDiffDecorations.js

@@ -18,6 +18,7 @@ var _areDocsEqualByBlockStructureAndText = require("../areDocsEqualByBlockStruct
 var _createBlockChangedDecoration = require("../decorations/createBlockChangedDecoration");
 var _createInlineChangedDecoration = require("../decorations/createInlineChangedDecoration");
 var _createNodeChangedDecorationWidget = require("../decorations/createNodeChangedDecorationWidget");
+var _decorationKeys = require("../decorations/decorationKeys");
 var _getAttrChangeRanges = require("../decorations/utils/getAttrChangeRanges");
 var _getMarkChangeRanges = require("../decorations/utils/getMarkChangeRanges");
 var _diffBySteps = require("./diffBySteps");
@@ -65,7 +66,7 @@ var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration
     if (node.isBlock && (!(0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) || pos + node.nodeSize <= to)) {
       var nodeEnd = pos + node.nodeSize;
       var isActive = activeIndexPos && pos === activeIndexPos.from && nodeEnd === activeIndexPos.to;
-      var blockChangedDecorations = (0, _createBlockChangedDecoration.createBlockChangedDecoration)({
+      decorations.push.apply(decorations, (0, _toConsumableArray2.default)((0, _createBlockChangedDecoration.createBlockChangedDecoration)({
         change: {
           from: pos,
           to: nodeEnd,
@@ -75,10 +76,7 @@ var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration
         isInserted: isInserted,
         isActive: isActive,
         shouldHideDeleted: shouldHideDeleted
-      });
-      if (blockChangedDecorations.length) {
-        decorations.push.apply(decorations, (0, _toConsumableArray2.default)(blockChangedDecorations));
-      }
+      })));
     }
   });
   return decorations;
@@ -100,7 +98,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
   var originalDoc = pluginState.originalDoc,
     steps = pluginState.steps;
   if (!originalDoc || !pluginState.isDisplayingChanges) {
-    return _view.DecorationSet.empty;
+    return {
+      decorations: _view.DecorationSet.empty,
+      diffDescriptors: []
+    };
   }
   var tr = state.tr;
   var steppedDoc = originalDoc;
@@ -143,7 +144,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
       }
     });
     if (!recoveredViaContentEquality) {
-      return _view.DecorationSet.empty;
+      return {
+        decorations: _view.DecorationSet.empty,
+        diffDescriptors: []
+      };
     }
   }
   var changeset = _prosemirrorChangeset.ChangeSet.create(originalDoc).addSteps(steppedDoc, stepMaps, tr.doc);
@@ -162,14 +166,14 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
     var isInserted = !isInverted;
     if (change.inserted.length > 0) {
       var shouldHideDeleted = (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? isInverted && hideDeletedDiffs : false;
-      decorations.push((0, _createInlineChangedDecoration.createInlineChangedDecoration)(_objectSpread({
+      decorations.push.apply(decorations, (0, _toConsumableArray2.default)((0, _createInlineChangedDecoration.createInlineChangedDecoration)(_objectSpread({
         change: change,
         colorScheme: colorScheme,
         isActive: isActive
       }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) && {
         isInserted: isInserted,
         shouldHideDeleted: shouldHideDeleted
-      })));
+      }))));
       decorations.push.apply(decorations, (0, _toConsumableArray2.default)(calculateNodesForBlockDecoration(_objectSpread(_objectSpread({
         doc: tr.doc,
         from: change.fromB,
@@ -186,7 +190,7 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
     if (change.deleted.length > 0) {
       var _shouldHideDeleted = (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? !isInverted && hideDeletedDiffs : false;
       if (!_shouldHideDeleted) {
-        var decoration = (0, _createNodeChangedDecorationWidget.createNodeChangedDecorationWidget)(_objectSpread({
+        decorations.push.apply(decorations, (0, _toConsumableArray2.default)((0, _createNodeChangedDecorationWidget.createNodeChangedDecorationWidget)(_objectSpread({
           change: change,
           doc: originalDoc,
           nodeViewSerializer: nodeViewSerializer,
@@ -197,32 +201,29 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
         }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) && {
           isInserted: !isInserted,
           diffType: diffType
-        }));
-        if (decoration) {
-          decorations.push.apply(decorations, (0, _toConsumableArray2.default)(decoration));
-        }
+        }))));
       }
     }
   });
   (0, _getMarkChangeRanges.getMarkChangeRanges)(steps).forEach(function (change) {
     var isActive = activeIndexPos && change.fromB === activeIndexPos.from && change.toB === activeIndexPos.to;
-    decorations.push((0, _createInlineChangedDecoration.createInlineChangedDecoration)({
+    decorations.push.apply(decorations, (0, _toConsumableArray2.default)((0, _createInlineChangedDecoration.createInlineChangedDecoration)({
       change: change,
       colorScheme: colorScheme,
       isActive: isActive,
       isInserted: true
-    }));
+    })));
   });
   (0, _getAttrChangeRanges.getAttrChangeRanges)(tr.doc, attrSteps).forEach(function (change) {
     if (change.isInline) {
       // Inline nodes (e.g. date) need an inline decoration rather than a block decoration
       var isActive = activeIndexPos && change.fromB === activeIndexPos.from && change.toB === activeIndexPos.to;
-      decorations.push((0, _createInlineChangedDecoration.createInlineChangedDecoration)({
+      decorations.push.apply(decorations, (0, _toConsumableArray2.default)((0, _createInlineChangedDecoration.createInlineChangedDecoration)({
         change: change,
         colorScheme: colorScheme,
         isActive: isActive,
         isInserted: true
-      }));
+      })));
     } else {
       decorations.push.apply(decorations, (0, _toConsumableArray2.default)(calculateNodesForBlockDecoration({
         doc: tr.doc,
@@ -235,7 +236,11 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
       })));
     }
   });
-  return _view.DecorationSet.empty.add(tr.doc, decorations);
+  var decorationSet = _view.DecorationSet.empty.add(tr.doc, decorations);
+  return {
+    decorations: decorationSet,
+    diffDescriptors: (0, _decorationKeys.extractDiffDescriptors)(decorationSet)
+  };
 };
 var calculateDiffDecorations = exports.calculateDiffDecorations = (0, _memoizeOne.default)(calculateDiffDecorationsInner,
 // Cache results unless relevant inputs change

package/dist/cjs/pm-plugins/decorations/createBlockChangedDecoration.js

@@ -115,15 +115,16 @@ var createBlockChangedDecoration = exports.createBlockChangedDecoration = functi
     _ref2$shouldHideDelet = _ref2.shouldHideDeleted,
     shouldHideDeleted = _ref2$shouldHideDelet === void 0 ? false : _ref2$shouldHideDelet;
   var decorations = [];
+  var diffId = crypto.randomUUID();
   if (shouldHideDeleted) {
     return [_view.Decoration.node(change.from, change.to, {
       style: displayNoneStyle
-    }, {
-      key: (0, _decorationKeys.buildDiffDecorationKey)({
-        type: _decorationKeys.DiffDecorationKey.block
-      }),
+    }, (0, _decorationKeys.buildDiffDecorationSpec)({
+      decorationType: 'block',
+      diffId: diffId,
+      isActive: isActive,
       nodeName: change.name
-    })];
+    }))];
   }
   var style;
   if ((0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) && ['tableCell', 'tableHeader'].includes(change.name)) {
@@ -132,11 +133,10 @@ var createBlockChangedDecoration = exports.createBlockChangedDecoration = functi
     cellOverlay.setAttribute('style', cellOverlayStyle);
     decorations.push(
     // change.to - 1 to position the overlay inside the end of the cell
+    // this key doesn't use the spec / key builder since this is just for
+    // decorating the cells, this is part of a bigger table diff
     _view.Decoration.widget(change.to - 1, cellOverlay, {
-      key: (0, _decorationKeys.buildDiffDecorationKey)({
-        type: _decorationKeys.DiffDecorationKey.widget,
-        isActive: isActive
-      })
+      key: 'cell-overlay-decoration'
     }));
   }
   if ((0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
@@ -159,12 +159,12 @@ var createBlockChangedDecoration = exports.createBlockChangedDecoration = functi
       style: style,
       'data-testid': 'show-diff-changed-decoration-node',
       class: className
-    }, {
-      key: (0, _decorationKeys.buildDiffDecorationKey)({
-        type: _decorationKeys.DiffDecorationKey.block
-      }),
+    }, (0, _decorationKeys.buildDiffDecorationSpec)({
+      decorationType: 'block',
+      diffId: diffId,
+      isActive: isActive,
       nodeName: change.name
-    }));
+    })));
   }
   return decorations;
 };

package/dist/cjs/pm-plugins/decorations/createChangedRowDecorationWidgets.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createChangedRowDecorationWidgets = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _document = require("@atlaskit/editor-common/utils/document");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
@@ -13,7 +14,10 @@ var _tableMap = require("@atlaskit/editor-tables/table-map");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _standard = require("./colorSchemes/standard");
 var _traditional = require("./colorSchemes/traditional");
+var _decorationKeys = require("./decorationKeys");
 var _findSafeInsertPos = require("./utils/findSafeInsertPos");
+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; }
@@ -210,6 +214,11 @@ var createChangedRowDecorationWidgets = exports.createChangedRowDecorationWidget
     var safeInsertPos = (0, _findSafeInsertPos.findSafeInsertPos)(newDoc, changedRow.fromB - 1,
     // -1 to find the first safe position from the table
     originalDoc.slice(changedRow.fromA, changedRow.toA));
-    return _view.Decoration.widget(safeInsertPos, rowDOM, {});
+    var diffId = crypto.randomUUID();
+    return _view.Decoration.widget(safeInsertPos, rowDOM, _objectSpread({}, (0, _decorationKeys.buildDiffDecorationSpec)({
+      decorationType: 'widget',
+      diffId: diffId,
+      isActive: false
+    })));
   });
 };

package/dist/cjs/pm-plugins/decorations/createInlineChangedDecoration.js

@@ -29,14 +29,15 @@ var createInlineChangedDecoration = exports.createInlineChangedDecoration = func
     isInserted = _ref$isInserted === void 0 ? true : _ref$isInserted,
     _ref$shouldHideDelete = _ref.shouldHideDeleted,
     shouldHideDeleted = _ref$shouldHideDelete === void 0 ? false : _ref$shouldHideDelete;
+  var diffId = crypto.randomUUID();
   if (shouldHideDeleted) {
-    return _view.Decoration.inline(change.fromB, change.toB, {
+    return [_view.Decoration.inline(change.fromB, change.toB, {
       style: displayNoneStyle
-    }, {
-      key: (0, _decorationKeys.buildDiffDecorationKey)({
-        type: _decorationKeys.DiffDecorationKey.inline
-      })
-    });
+    }, (0, _decorationKeys.buildDiffDecorationSpec)({
+      decorationType: 'inline',
+      diffId: diffId,
+      isActive: isActive
+    }))];
   }
   var style;
   if ((0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
@@ -66,12 +67,12 @@ var createInlineChangedDecoration = exports.createInlineChangedDecoration = func
       style = isActive ? _standard.editingStyleActive : _standard.editingStyle;
     }
   }
-  return _view.Decoration.inline(change.fromB, change.toB, {
+  return [_view.Decoration.inline(change.fromB, change.toB, {
     style: style,
     'data-testid': 'show-diff-changed-decoration'
-  }, {
-    key: (0, _decorationKeys.buildDiffDecorationKey)({
-      type: _decorationKeys.DiffDecorationKey.inline
-    })
-  });
+  }, (0, _decorationKeys.buildDiffDecorationSpec)({
+    decorationType: 'inline',
+    diffId: diffId,
+    isActive: isActive
+  }))];
 };

package/dist/cjs/pm-plugins/decorations/createNodeChangedDecorationWidget.js

@@ -122,7 +122,7 @@ var createNodeChangedDecorationWidget = exports.createNodeChangedDecorationWidge
   var safeInsertPos = (0, _findSafeInsertPos.findSafeInsertPos)(newDoc, change.fromB, slice);
   var isActive = activeIndexPos && safeInsertPos === activeIndexPos.from && safeInsertPos === activeIndexPos.to;
   if (slice.content.content.length === 0 || shouldSkipDeletedEmptyParagraphDecoration) {
-    return;
+    return [];
   }
   var isTableCellContent = slice.content.content.some(function () {
     return slice.content.content.some(function (siblingNode) {
@@ -135,7 +135,7 @@ var createNodeChangedDecorationWidget = exports.createNodeChangedDecorationWidge
     });
   });
   if (isTableCellContent) {
-    return;
+    return [];
   }
   if (isTableRowContent) {
     return (0, _createChangedRowDecorationWidgets.createChangedRowDecorationWidgets)({
@@ -256,14 +256,14 @@ var createNodeChangedDecorationWidget = exports.createNodeChangedDecorationWidge
     }
   });
   dom.setAttribute('data-testid', 'show-diff-deleted-decoration');
+  var diffId = crypto.randomUUID();
   var decorations = [];
-  decorations.push(_view.Decoration.widget(safeInsertPos, dom, _objectSpread({
-    key: (0, _decorationKeys.buildDiffDecorationKey)({
-      type: _decorationKeys.DiffDecorationKey.widget,
-      isActive: isActive
-    })
+  decorations.push(_view.Decoration.widget(safeInsertPos, dom, (0, _decorationKeys.buildDiffDecorationSpec)(_objectSpread({
+    decorationType: 'widget',
+    diffId: diffId,
+    isActive: isActive
   }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) && {
     side: -1
-  })));
+  }))));
   return decorations;
 };

package/dist/cjs/pm-plugins/decorations/decorationKeys.js

@@ -1,24 +1,29 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.buildDiffDecorationKey = exports.DiffDecorationKey = exports.DIFF_KEY_PREFIX = void 0;
+exports.extractDiffDescriptors = exports.buildDiffDecorationSpec = exports.buildDiffDecorationKey = exports.DiffDecorationKey = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
+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; }
 /**
  * Shared prefix for every decoration key produced by the show-diff plugin.
  * All keys derive from this, so the full set of plugin decorations can be
  * identified by this single prefix.
  */
-var DIFF_KEY_PREFIX = exports.DIFF_KEY_PREFIX = 'diff';
+var DIFF_DECORATION_FAMILY = 'diff';
 /**
  * The kinds of decoration the show-diff plugin produces. Each value is the
  * leading segment of the generated key, so a decoration's kind can be matched
  * with `key?.startsWith(DiffDecorationKey.inline)` etc.
  */
 var DiffDecorationKey = exports.DiffDecorationKey = {
-  inline: "".concat(DIFF_KEY_PREFIX, "-inline"),
-  block: "".concat(DIFF_KEY_PREFIX, "-block"),
-  widget: "".concat(DIFF_KEY_PREFIX, "-widget")
+  inline: "".concat(DIFF_DECORATION_FAMILY, "-inline"),
+  block: "".concat(DIFF_DECORATION_FAMILY, "-block"),
+  widget: "".concat(DIFF_DECORATION_FAMILY, "-widget")
 };
 
 /**
@@ -26,7 +31,43 @@ var DiffDecorationKey = exports.DiffDecorationKey = {
  * (e.g. `diff-inline-active`).
  */
 var buildDiffDecorationKey = exports.buildDiffDecorationKey = function buildDiffDecorationKey(_ref) {
-  var type = _ref.type,
-    isActive = _ref.isActive;
-  return isActive !== undefined ? "".concat(type, "-").concat(isActive ? 'active' : 'inactive') : type;
+  var decorationKeyPrefix = _ref.decorationKeyPrefix,
+    isActive = _ref.isActive,
+    diffId = _ref.diffId;
+  if ((0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
+    return "".concat(decorationKeyPrefix, "-").concat(diffId, "-").concat(isActive ? 'active' : 'inactive');
+  }
+  return isActive !== undefined ? "".concat(decorationKeyPrefix, "-").concat(isActive ? 'active' : 'inactive') : decorationKeyPrefix;
+};
+var buildDiffDecorationSpec = exports.buildDiffDecorationSpec = function buildDiffDecorationSpec(_ref2) {
+  var decorationType = _ref2.decorationType,
+    diffId = _ref2.diffId,
+    isActive = _ref2.isActive,
+    nodeName = _ref2.nodeName,
+    side = _ref2.side;
+  return _objectSpread(_objectSpread({
+    decorationFamily: DIFF_DECORATION_FAMILY,
+    decorationType: decorationType,
+    diffId: diffId,
+    key: buildDiffDecorationKey({
+      decorationKeyPrefix: DiffDecorationKey[decorationType],
+      diffId: diffId,
+      isActive: isActive
+    })
+  }, nodeName ? {
+    nodeName: nodeName
+  } : {}), side !== undefined ? {
+    side: side
+  } : {});
+};
+var extractDiffDescriptors = exports.extractDiffDescriptors = function extractDiffDescriptors(decorations) {
+  return decorations.find(undefined, undefined, function (spec) {
+    return spec.decorationFamily === 'diff';
+  }).map(function (_ref3) {
+    var spec = _ref3.spec;
+    return {
+      id: spec.diffId,
+      type: spec.decorationType
+    };
+  });
 };

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

@@ -41,7 +41,8 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
         }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
           isInverted: false,
           diffType: 'inline',
-          hideDeletedDiffs: false
+          hideDeletedDiffs: false,
+          diffDescriptors: []
         } : {});
       },
       apply: function apply(tr, currentPluginState, oldState, newState) {
@@ -56,21 +57,26 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
               activeIndex: undefined
             });
             // Calculate and store decorations in state
-            var decorations = (0, _calculateDiffDecorations.calculateDiffDecorations)(_objectSpread({
-              state: newState,
-              pluginState: newPluginState,
-              nodeViewSerializer: nodeViewSerializer,
-              colorScheme: config === null || config === void 0 ? void 0 : config.colorScheme,
-              intl: getIntl(),
-              activeIndexPos: newPluginState.activeIndexPos,
-              api: api
-            }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
-              isInverted: (_newPluginState = newPluginState) === null || _newPluginState === void 0 ? void 0 : _newPluginState.isInverted,
-              diffType: (_newPluginState2 = newPluginState) === null || _newPluginState2 === void 0 ? void 0 : _newPluginState2.diffType,
-              hideDeletedDiffs: (_newPluginState3 = newPluginState) === null || _newPluginState3 === void 0 ? void 0 : _newPluginState3.hideDeletedDiffs
-            } : {}));
-            // Update the decorations
+            var _calculateDiffDecorat = (0, _calculateDiffDecorations.calculateDiffDecorations)(_objectSpread({
+                state: newState,
+                pluginState: newPluginState,
+                nodeViewSerializer: nodeViewSerializer,
+                colorScheme: config === null || config === void 0 ? void 0 : config.colorScheme,
+                intl: getIntl(),
+                activeIndexPos: newPluginState.activeIndexPos,
+                api: api
+              }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
+                isInverted: (_newPluginState = newPluginState) === null || _newPluginState === void 0 ? void 0 : _newPluginState.isInverted,
+                diffType: (_newPluginState2 = newPluginState) === null || _newPluginState2 === void 0 ? void 0 : _newPluginState2.diffType,
+                hideDeletedDiffs: (_newPluginState3 = newPluginState) === null || _newPluginState3 === void 0 ? void 0 : _newPluginState3.hideDeletedDiffs
+              } : {})),
+              decorations = _calculateDiffDecorat.decorations,
+              diffDescriptors = _calculateDiffDecorat.diffDescriptors;
+            // Update the decorations and their ids
             newPluginState.decorations = decorations;
+            if ((0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
+              newPluginState.diffDescriptors = diffDescriptors;
+            }
           } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'HIDE_DIFF') {
             newPluginState = _objectSpread(_objectSpread(_objectSpread({}, currentPluginState), meta), {}, {
               decorations: _view.DecorationSet.empty,
@@ -79,7 +85,8 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
             }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
               isInverted: false,
               diffType: 'inline',
-              hideDeletedDiffs: false
+              hideDeletedDiffs: false,
+              diffDescriptors: []
             } : {});
           } else if ((meta === null || meta === void 0 ? void 0 : meta.action) === 'SCROLL_TO_NEXT' || (meta === null || meta === void 0 ? void 0 : meta.action) === 'SCROLL_TO_PREVIOUS') {
             // Update the active index in plugin state and recalculate decorations
@@ -109,20 +116,25 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
                 } : undefined
               });
               // Recalculate decorations with the new active index
-              var updatedDecorations = (0, _calculateDiffDecorations.calculateDiffDecorations)(_objectSpread({
-                state: newState,
-                pluginState: newPluginState,
-                nodeViewSerializer: nodeViewSerializer,
-                colorScheme: config === null || config === void 0 ? void 0 : config.colorScheme,
-                intl: getIntl(),
-                activeIndexPos: newPluginState.activeIndexPos,
-                api: api
-              }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
-                isInverted: newPluginState.isInverted,
-                diffType: newPluginState.diffType,
-                hideDeletedDiffs: newPluginState.hideDeletedDiffs
-              } : {}));
+              var _calculateDiffDecorat2 = (0, _calculateDiffDecorations.calculateDiffDecorations)(_objectSpread({
+                  state: newState,
+                  pluginState: newPluginState,
+                  nodeViewSerializer: nodeViewSerializer,
+                  colorScheme: config === null || config === void 0 ? void 0 : config.colorScheme,
+                  intl: getIntl(),
+                  activeIndexPos: newPluginState.activeIndexPos,
+                  api: api
+                }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
+                  isInverted: newPluginState.isInverted,
+                  diffType: newPluginState.diffType,
+                  hideDeletedDiffs: newPluginState.hideDeletedDiffs
+                } : {})),
+                updatedDecorations = _calculateDiffDecorat2.decorations,
+                updatedDiffDescriptors = _calculateDiffDecorat2.diffDescriptors;
               newPluginState.decorations = updatedDecorations;
+              if ((0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
+                newPluginState.diffDescriptors = updatedDiffDescriptors;
+              }
             }
           } else {
             newPluginState = _objectSpread(_objectSpread({}, currentPluginState), meta);

package/dist/cjs/showDiffPlugin.js

@@ -68,18 +68,22 @@ var showDiffPlugin = exports.showDiffPlugin = function showDiffPlugin(_ref) {
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {
-        return {
+        return _objectSpread({
           isDisplayingChanges: false,
           activeIndex: undefined
-        };
+        }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
+          diffDescriptors: []
+        } : {});
       }
       var pluginState = _main.showDiffPluginKey.getState(editorState);
       var decorationCount = (0, _getScrollableDecorations.getScrollableDecorations)(pluginState === null || pluginState === void 0 ? void 0 : pluginState.decorations, editorState.doc);
-      return {
+      return _objectSpread({
         isDisplayingChanges: decorationCount.length > 0,
         activeIndex: pluginState === null || pluginState === void 0 ? void 0 : pluginState.activeIndex,
         numberOfChanges: decorationCount.length
-      };
+      }, (0, _expValEquals.expValEquals)('platform_editor_diff_plugin_extended', 'isEnabled', true) ? {
+        diffDescriptors: pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffDescriptors
+      } : {});
     }
   };
 };

package/dist/es2019/pm-plugins/calculateDiff/calculateDiffDecorations.js

@@ -9,6 +9,7 @@ import { areDocsEqualByBlockStructureAndText } from '../areDocsEqualByBlockStruc
 import { createBlockChangedDecoration } from '../decorations/createBlockChangedDecoration';
 import { createInlineChangedDecoration } from '../decorations/createInlineChangedDecoration';
 import { createNodeChangedDecorationWidget } from '../decorations/createNodeChangedDecorationWidget';
+import { extractDiffDescriptors } from '../decorations/decorationKeys';
 import { getAttrChangeRanges, stepIsValidAttrChange } from '../decorations/utils/getAttrChangeRanges';
 import { getMarkChangeRanges } from '../decorations/utils/getMarkChangeRanges';
 import { diffBySteps } from './diffBySteps';
@@ -51,7 +52,7 @@ const calculateNodesForBlockDecoration = ({
     if (node.isBlock && (!expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) || pos + node.nodeSize <= to)) {
       const nodeEnd = pos + node.nodeSize;
       const isActive = activeIndexPos && pos === activeIndexPos.from && nodeEnd === activeIndexPos.to;
-      const blockChangedDecorations = createBlockChangedDecoration({
+      decorations.push(...createBlockChangedDecoration({
         change: {
           from: pos,
           to: nodeEnd,
@@ -61,10 +62,7 @@ const calculateNodesForBlockDecoration = ({
         isInserted,
         isActive,
         shouldHideDeleted
-      });
-      if (blockChangedDecorations.length) {
-        decorations.push(...blockChangedDecorations);
-      }
+      }));
     }
   });
   return decorations;
@@ -86,7 +84,10 @@ const calculateDiffDecorationsInner = ({
     steps
   } = pluginState;
   if (!originalDoc || !pluginState.isDisplayingChanges) {
-    return DecorationSet.empty;
+    return {
+      decorations: DecorationSet.empty,
+      diffDescriptors: []
+    };
   }
   const {
     tr
@@ -122,7 +123,10 @@ const calculateDiffDecorationsInner = ({
       }
     });
     if (!recoveredViaContentEquality) {
-      return DecorationSet.empty;
+      return {
+        decorations: DecorationSet.empty,
+        diffDescriptors: []
+      };
     }
   }
   const changeset = ChangeSet.create(originalDoc).addSteps(steppedDoc, stepMaps, tr.doc);
@@ -141,7 +145,7 @@ const calculateDiffDecorationsInner = ({
     const isInserted = !isInverted;
     if (change.inserted.length > 0) {
       const shouldHideDeleted = expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) ? isInverted && hideDeletedDiffs : false;
-      decorations.push(createInlineChangedDecoration({
+      decorations.push(...createInlineChangedDecoration({
         change,
         colorScheme,
         isActive,
@@ -166,7 +170,7 @@ const calculateDiffDecorationsInner = ({
     if (change.deleted.length > 0) {
       const shouldHideDeleted = expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) ? !isInverted && hideDeletedDiffs : false;
       if (!shouldHideDeleted) {
-        const decoration = createNodeChangedDecorationWidget({
+        decorations.push(...createNodeChangedDecorationWidget({
           change,
           doc: originalDoc,
           nodeViewSerializer,
@@ -178,16 +182,13 @@ const calculateDiffDecorationsInner = ({
             isInserted: !isInserted,
             diffType
           })
-        });
-        if (decoration) {
-          decorations.push(...decoration);
-        }
+        }));
       }
     }
   });
   getMarkChangeRanges(steps).forEach(change => {
     const isActive = activeIndexPos && change.fromB === activeIndexPos.from && change.toB === activeIndexPos.to;
-    decorations.push(createInlineChangedDecoration({
+    decorations.push(...createInlineChangedDecoration({
       change,
       colorScheme,
       isActive,
@@ -198,7 +199,7 @@ const calculateDiffDecorationsInner = ({
     if (change.isInline) {
       // Inline nodes (e.g. date) need an inline decoration rather than a block decoration
       const isActive = activeIndexPos && change.fromB === activeIndexPos.from && change.toB === activeIndexPos.to;
-      decorations.push(createInlineChangedDecoration({
+      decorations.push(...createInlineChangedDecoration({
         change,
         colorScheme,
         isActive,
@@ -216,7 +217,11 @@ const calculateDiffDecorationsInner = ({
       }));
     }
   });
-  return DecorationSet.empty.add(tr.doc, decorations);
+  const decorationSet = DecorationSet.empty.add(tr.doc, decorations);
+  return {
+    decorations: decorationSet,
+    diffDescriptors: extractDiffDescriptors(decorationSet)
+  };
 };
 export const calculateDiffDecorations = memoizeOne(calculateDiffDecorationsInner,
 // Cache results unless relevant inputs change