@atlaskit/editor-plugin-show-diff 10.1.23 → 10.3.0

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

@@ -1,5 +1,5 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 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; }
@@ -12,6 +12,7 @@ import memoizeOne from 'memoize-one';
 import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
 import { areNodesEqualIgnoreAttrs } from '@atlaskit/editor-common/utils/document';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { areDocsEqualByBlockStructureAndText } from '../areDocsEqualByBlockStructureAndText';
 import { createDocMarginAnchorWidget } from '../decorations/createAnchorDecorationWidgets';
@@ -22,30 +23,71 @@ import { createNodeChangedDecorationWidget } from '../decorations/createNodeChan
 import { extractDiffDescriptors } from '../decorations/decorationKeys';
 import { getAttrChangeRanges, stepIsValidAttrChange } from '../decorations/utils/getAttrChangeRanges';
 import { getMarkChangeRanges } from '../decorations/utils/getMarkChangeRanges';
+import { isExtendedEnabled } from '../isExtendedEnabled';
 import { diffBySteps, getStepChanges } from './diffBySteps';
 import { groupChangesByBlock } from './groupChangesByBlock';
 import { optimizeChanges } from './optimizeChanges';
 import { simplifySteps } from './simplifySteps';
+import { classifySmartChanges } from './smart/classifySmartChanges';
+import { smartChangeLevel } from './smart/helpers';
 var getChanges = function getChanges(_ref) {
   var changeset = _ref.changeset,
     originalDoc = _ref.originalDoc,
     steppedDoc = _ref.steppedDoc,
     diffType = _ref.diffType,
     tr = _ref.tr,
-    steps = _ref.steps;
-  if (expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
+    steps = _ref.steps,
+    intl = _ref.intl,
+    smartThresholds = _ref.smartThresholds;
+  if (isExtendedEnabled(diffType)) {
+    // The `smart` diff type is gated behind `platform_editor_ai_smart_diff`. When the gate is
+    // off, `smart` falls through to the default (`inline`) path below so behaviour degrades
+    // gracefully (see docs/smart-diff-design.md §3).
+    if (diffType === 'smart' && fg('platform_editor_ai_smart_diff')) {
+      var _changes = simplifyChanges(changeset.changes, tr.doc);
+      return classifySmartChanges({
+        changes: _changes,
+        originalDoc: originalDoc,
+        newDoc: tr.doc,
+        locale: intl.locale,
+        thresholds: smartThresholds
+      });
+    }
     if (diffType === 'step') {
       return diffBySteps(originalDoc, steps);
     }
     if (diffType === 'block') {
       return groupChangesByBlock(changeset.changes, originalDoc, steppedDoc);
     }
-    var _changes = simplifyChanges(changeset.changes, tr.doc);
-    return optimizeChanges(_changes);
+    var _changes2 = simplifyChanges(changeset.changes, tr.doc);
+    return optimizeChanges(_changes2);
   }
   var changes = simplifyChanges(changeset.changes, tr.doc);
   return optimizeChanges(changes);
 };
+
+/**
+ * Collect the inline-content ranges of every leaf text-bearing block (paragraph, heading, …)
+ * whose content overlaps `[from, to)`. Used to clip a node-level `smart` insertion highlight to
+ * the actual added text, so the inserted background/underline never spans structural gaps
+ * (list markers, empty item slots, cell/column boundaries) which would render as phantom rows.
+ */
+var leafTextblockRanges = function leafTextblockRanges(doc, from, to) {
+  var ranges = [];
+  doc.nodesBetween(from, to, function (node, pos) {
+    if (node.isTextblock && node.content.size > 0) {
+      var contentFrom = Math.max(pos + 1, from);
+      var contentTo = Math.min(pos + 1 + node.content.size, to);
+      if (contentTo > contentFrom) {
+        ranges.push([contentFrom, contentTo]);
+      }
+      // Textblocks have no block children to descend into.
+      return false;
+    }
+    return true;
+  });
+  return ranges;
+};
 var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration(_ref2) {
   var doc = _ref2.doc,
     from = _ref2.from,
@@ -57,11 +99,12 @@ var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration
     _ref2$shouldHideDelet = _ref2.shouldHideDeleted,
     shouldHideDeleted = _ref2$shouldHideDelet === void 0 ? false : _ref2$shouldHideDelet,
     _ref2$showIndicators = _ref2.showIndicators,
-    showIndicators = _ref2$showIndicators === void 0 ? false : _ref2$showIndicators;
+    showIndicators = _ref2$showIndicators === void 0 ? false : _ref2$showIndicators,
+    diffType = _ref2.diffType;
   var decorations = [];
   // Iterate over the document nodes within the range
   doc.nodesBetween(from, to, function (node, pos) {
-    if (node.isBlock && (!expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) || pos + node.nodeSize <= to)) {
+    if (node.isBlock && (!isExtendedEnabled(diffType) || pos + node.nodeSize <= to)) {
       var nodeEnd = pos + node.nodeSize;
       var isActive = activeIndexPos && pos === activeIndexPos.from && nodeEnd === activeIndexPos.to;
       decorations.push.apply(decorations, _toConsumableArray(createBlockChangedDecoration({
@@ -75,7 +118,8 @@ var calculateNodesForBlockDecoration = function calculateNodesForBlockDecoration
         isActive: isActive,
         shouldHideDeleted: shouldHideDeleted,
         showIndicators: showIndicators,
-        doc: doc
+        doc: doc,
+        diffType: diffType
       })));
     }
   });
@@ -96,7 +140,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
     _ref3$hideDeletedDiff = _ref3.hideDeletedDiffs,
     hideDeletedDiffs = _ref3$hideDeletedDiff === void 0 ? false : _ref3$hideDeletedDiff,
     _ref3$showIndicators = _ref3.showIndicators,
-    showIndicators = _ref3$showIndicators === void 0 ? false : _ref3$showIndicators;
+    showIndicators = _ref3$showIndicators === void 0 ? false : _ref3$showIndicators,
+    smartThresholds = _ref3.smartThresholds,
+    _ref3$deletedDiffPlac = _ref3.deletedDiffPlacement,
+    deletedDiffPlacement = _ref3$deletedDiffPlac === void 0 ? 'top' : _ref3$deletedDiffPlac;
   var originalDoc = pluginState.originalDoc,
     steps = pluginState.steps,
     isDisplayingChanges = pluginState.isDisplayingChanges;
@@ -160,14 +207,16 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
     steppedDoc: steppedDoc,
     diffType: diffType,
     tr: tr,
-    steps: steps
+    steps: steps,
+    intl: intl,
+    smartThresholds: smartThresholds
   });
   var decorations = [];
 
   /**
    * If showIndicators is on, we create an anchor widget here to mark the doc margin.
    */
-  if (showIndicators && expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
+  if (showIndicators && isExtendedEnabled(diffType)) {
     decorations.push(createDocMarginAnchorWidget());
   }
 
@@ -179,33 +228,77 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
       // shouldHideDeleted for block/node decorations: suppressed when isInverted + hideDeletedDiffs,
       // or when showGranularWithBlock (block reference widget is shown instead).
       // isInverted gates both — on an inverted diff the inserted side is visually the deleted side.
-      var shouldHideDeleted = expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) ? isInverted && (hideDeletedDiffs || showGranularWithBlock) && change.deleted.length > 0 : false;
-      decorations.push.apply(decorations, _toConsumableArray(createInlineChangedDecoration(_objectSpread({
-        change: change,
-        doc: tr.doc,
-        colorScheme: colorScheme,
-        isActive: isActive
-      }, expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) && {
-        isInserted: isInserted,
-        shouldHideDeleted: shouldHideDeleted,
-        showIndicators: showIndicators
-      }))));
+      var shouldHideDeleted = isExtendedEnabled(diffType) ? isInverted && (hideDeletedDiffs || showGranularWithBlock) && change.deleted.length > 0 : false;
+
+      // For `smart` NODE-level promotions the change range spans a whole container
+      // (e.g. an entire list/table/layout, using outer node bounds). Applying a SINGLE
+      // inline decoration across that whole range would paint the inserted style across
+      // block boundaries and structural gaps (list markers, empty item slots), producing
+      // phantom "empty" rows above the real content. But skipping the inline highlight
+      // entirely leaves added text-bearing blocks (paragraphs/headings inside the added
+      // container) without the inserted background+underline, because block decorations
+      // return no style for paragraph/heading. So for node-level smart changes we instead
+      // emit ONE inline decoration per leaf text-bearing block within the range — the text
+      // gets highlighted, and structural gaps never do.
+      var isSmartNodeLevel = diffType === 'smart' && fg('platform_editor_ai_smart_diff') && smartChangeLevel(change) === 'node';
+      if (isSmartNodeLevel) {
+        var _iterator2 = _createForOfIteratorHelper(leafTextblockRanges(tr.doc, change.fromB, change.toB)),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var _step2$value = _slicedToArray(_step2.value, 2),
+              from = _step2$value[0],
+              to = _step2$value[1];
+            decorations.push.apply(decorations, _toConsumableArray(createInlineChangedDecoration(_objectSpread({
+              change: {
+                fromB: from,
+                toB: to
+              },
+              doc: tr.doc,
+              colorScheme: colorScheme,
+              isActive: isActive,
+              diffType: diffType
+            }, isExtendedEnabled(diffType) && {
+              isInserted: isInserted,
+              shouldHideDeleted: shouldHideDeleted,
+              showIndicators: showIndicators
+            }))));
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+      } else {
+        decorations.push.apply(decorations, _toConsumableArray(createInlineChangedDecoration(_objectSpread({
+          change: change,
+          doc: tr.doc,
+          colorScheme: colorScheme,
+          isActive: isActive,
+          diffType: diffType
+        }, isExtendedEnabled(diffType) && {
+          isInserted: isInserted,
+          shouldHideDeleted: shouldHideDeleted,
+          showIndicators: showIndicators
+        }))));
+      }
       decorations.push.apply(decorations, _toConsumableArray(calculateNodesForBlockDecoration(_objectSpread(_objectSpread({
         doc: tr.doc,
         from: change.fromB,
         to: change.toB,
         colorScheme: colorScheme
-      }, expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) && {
+      }, isExtendedEnabled(diffType) && {
         isInserted: isInserted,
         shouldHideDeleted: shouldHideDeleted,
         showIndicators: showIndicators
       }), {}, {
         activeIndexPos: activeIndexPos,
-        intl: intl
+        intl: intl,
+        diffType: diffType
       }))));
     }
     if (change.deleted.length > 0) {
-      var _shouldHideDeleted = expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) ? !isInverted && (hideDeletedDiffs || showGranularWithBlock) && change.inserted.length > 0 : false;
+      var _shouldHideDeleted = isExtendedEnabled(diffType) ? !isInverted && (hideDeletedDiffs || showGranularWithBlock) && change.inserted.length > 0 : false;
       if (!_shouldHideDeleted) {
         decorations.push.apply(decorations, _toConsumableArray(createNodeChangedDecorationWidget(_objectSpread(_objectSpread({
           change: change,
@@ -215,9 +308,13 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref3
           newDoc: tr.doc,
           intl: intl,
           activeIndexPos: activeIndexPos
-        }, expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true) && {
+        }, isExtendedEnabled(diffType) && {
           isInserted: !isInserted,
-          diffType: diffType
+          diffType: diffType,
+          // For `smart` node- and paragraph-level changes, optionally render the
+          // deleted content below the new content (gray + strikethrough) instead
+          // of above it. Controlled by `deletedDiffPlacement` (default `'top'`).
+          placeBelow: deletedDiffPlacement === 'bottom' && diffType === 'smart' && fg('platform_editor_ai_smart_diff') && (smartChangeLevel(change) === 'node' || smartChangeLevel(change) === 'paragraph')
         }), {}, {
           showIndicators: showIndicators
         }))));
@@ -358,7 +455,9 @@ function (_ref5, _ref6) {
     isInverted = _ref7$.isInverted,
     diffType = _ref7$.diffType,
     hideDeletedDiffs = _ref7$.hideDeletedDiffs,
-    showIndicators = _ref7$.showIndicators;
+    showIndicators = _ref7$.showIndicators,
+    smartThresholds = _ref7$.smartThresholds,
+    deletedDiffPlacement = _ref7$.deletedDiffPlacement;
   var _ref8 = _slicedToArray(_ref6, 1),
     _ref8$ = _ref8[0],
     lastPluginState = _ref8$.pluginState,
@@ -369,11 +468,13 @@ function (_ref5, _ref6) {
     lastIsInverted = _ref8$.isInverted,
     lastDiffType = _ref8$.diffType,
     lastHideDeletedDiffs = _ref8$.hideDeletedDiffs,
-    lastShowIndicators = _ref8$.showIndicators;
+    lastShowIndicators = _ref8$.showIndicators,
+    lastSmartThresholds = _ref8$.smartThresholds,
+    lastDeletedDiffPlacement = _ref8$.deletedDiffPlacement;
   var originalDocIsSame = lastPluginState.originalDoc && pluginState.originalDoc && pluginState.originalDoc.eq(lastPluginState.originalDoc);
-  if (expValEquals('platform_editor_diff_plugin_extended', 'isEnabled', true)) {
+  if (isExtendedEnabled(diffType)) {
     var _ref9;
-    return (_ref9 = colorScheme === lastColorScheme && intl.locale === lastIntl.locale && isInverted === lastIsInverted && diffType === lastDiffType && isEqual(activeIndexPos, lastActiveIndexPos) && originalDocIsSame && isEqual(pluginState.steps, lastPluginState.steps) && state.doc.eq(lastState.doc) && hideDeletedDiffs === lastHideDeletedDiffs && showIndicators === lastShowIndicators) !== null && _ref9 !== void 0 ? _ref9 : false;
+    return (_ref9 = colorScheme === lastColorScheme && intl.locale === lastIntl.locale && isInverted === lastIsInverted && diffType === lastDiffType && isEqual(activeIndexPos, lastActiveIndexPos) && originalDocIsSame && isEqual(pluginState.steps, lastPluginState.steps) && state.doc.eq(lastState.doc) && hideDeletedDiffs === lastHideDeletedDiffs && showIndicators === lastShowIndicators && isEqual(smartThresholds, lastSmartThresholds) && deletedDiffPlacement === lastDeletedDiffPlacement) !== null && _ref9 !== void 0 ? _ref9 : false;
   }
   return (_ref0 = originalDocIsSame && isEqual(pluginState.steps, lastPluginState.steps) && state.doc.eq(lastState.doc) && colorScheme === lastColorScheme && intl.locale === lastIntl.locale && isEqual(activeIndexPos, lastActiveIndexPos) && hideDeletedDiffs === lastHideDeletedDiffs) !== null && _ref0 !== void 0 ? _ref0 : false;
 });

package/dist/esm/pm-plugins/calculateDiff/computeDiffChanges.js

@@ -0,0 +1,107 @@
+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; }
+/**
+ * Generic, editor-state-free diff-change computation.
+ *
+ * Turns an `originalDoc` + forward `steps` into the classified `Change[]` for the
+ * requested `diffType`, plus the reconstructed new document — the same classifier
+ * the diff overlay uses (`calculateDiffDecorations` → `getChanges`), exposed as a
+ * reusable utility (e.g. to derive reviewable segments without rendering
+ * decorations). It runs the requested `diffType` DIRECTLY and does NOT apply the
+ * overlay's `platform_editor_ai_smart_diff` gate, so a `smart` result here can
+ * differ from what the overlay draws when that gate is off (the overlay falls back
+ * to inline); callers that need overlay parity must account for that gate.
+ *
+ * Pure: no `EditorState`, no transactions, no React. The new document is
+ * reconstructed by applying the (simplified) steps to `originalDoc`.
+ */
+import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
+import { diffBySteps } from './diffBySteps';
+import { groupChangesByBlock } from './groupChangesByBlock';
+import { optimizeChanges } from './optimizeChanges';
+import { simplifySteps } from './simplifySteps';
+import { classifySmartChanges } from './smart/classifySmartChanges';
+/**
+ * Apply the (simplified) steps to `originalDoc` to reconstruct the new doc, and
+ * compute the classified `Change[]` for the requested `diffType`. Mirrors the
+ * body of `calculateDiffDecorations` → `getChanges` so callers stay in lock-step
+ * with the rendered diff. Returns an empty change list (and `originalDoc` as the
+ * new doc) when there are no steps.
+ */
+export var computeDiffChanges = function computeDiffChanges(_ref) {
+  var originalDoc = _ref.originalDoc,
+    steps = _ref.steps,
+    _ref$diffType = _ref.diffType,
+    diffType = _ref$diffType === void 0 ? 'smart' : _ref$diffType,
+    _ref$locale = _ref.locale,
+    locale = _ref$locale === void 0 ? 'en' : _ref$locale,
+    smartThresholds = _ref.smartThresholds;
+  if (!steps || steps.length === 0) {
+    return {
+      changes: [],
+      newDoc: originalDoc
+    };
+  }
+  var simplifiedSteps = simplifySteps(steps, originalDoc);
+  var steppedDoc = originalDoc;
+  var stepMaps = [];
+  try {
+    var _iterator = _createForOfIteratorHelper(simplifiedSteps),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var step = _step.value;
+        var result = step.apply(steppedDoc);
+        if (result.failed === null && result.doc) {
+          stepMaps.push(step.getMap());
+          steppedDoc = result.doc;
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  } catch (_unused) {
+    // A step's positions fell outside the current doc — `ReplaceStep.apply`
+    // throws a RangeError (rather than returning a failed result) when a
+    // position exceeds the doc size. This can happen for pathological or
+    // inconsistent step sequences. Bail with no changes rather than letting the
+    // error propagate to the caller (which, for the PSR, would crash the
+    // toolbar); the consumer then falls back to its non-diff segmenting path.
+    return {
+      changes: [],
+      newDoc: originalDoc
+    };
+  }
+  var changeset = ChangeSet.create(originalDoc).addSteps(steppedDoc, stepMaps, steppedDoc);
+  if (diffType === 'smart') {
+    return {
+      changes: classifySmartChanges({
+        changes: simplifyChanges(changeset.changes, steppedDoc),
+        originalDoc: originalDoc,
+        newDoc: steppedDoc,
+        locale: locale,
+        thresholds: smartThresholds
+      }),
+      newDoc: steppedDoc
+    };
+  }
+  if (diffType === 'block') {
+    return {
+      changes: groupChangesByBlock(changeset.changes, originalDoc, steppedDoc),
+      newDoc: steppedDoc
+    };
+  }
+  if (diffType === 'step') {
+    return {
+      changes: diffBySteps(originalDoc, simplifiedSteps),
+      newDoc: steppedDoc
+    };
+  }
+  return {
+    changes: optimizeChanges(simplifyChanges(changeset.changes, steppedDoc)),
+    newDoc: steppedDoc
+  };
+};

package/dist/esm/pm-plugins/calculateDiff/groupChangesByBlock.js

@@ -3,10 +3,11 @@ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol
 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; }
 /**
- * Finds the position range of the top-level block (direct child of doc) that contains `pos`.
- * Returns null if `pos` is at the doc boundary or outside the doc content.
+ * Finds the position range (outer bounds) of the top-level block (direct child of doc) that
+ * contains the range [from, to]. Shared with the `smart` diff type so its block grouping is
+ * identical to the `block` diff type by construction.
  */
-function getTopLevelBlockAt(doc, from, to) {
+export function getTopLevelBlockAt(doc, from, to) {
   return {
     from: doc.resolve(from).before(1),
     to: doc.resolve(to).after(1)