@atlaskit/editor-plugin-show-diff 11.0.4 → 11.0.5

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 11.0.5
+
+### Patch Changes
+
+- [`67209770a447f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/67209770a447f) -
+  [ED-8371] Fix `scrollToDiff` not always scrolling to the first diff decoration. When
+  `scrollIntoView` was requested on an extended diff (e.g. AI Suggested Edits),
+  `scrollToFirstDecoration` selected its target using `DecorationSet.find()`, which returns
+  decorations in the set's internal order rather than document position and applies no scrollability
+  filtering. As a result it could scroll to a later decoration (for example a `removeNode` deletion)
+  instead of the topmost one. It now scrolls to the first entry of `getScrollableDecorations` — the
+  same filtered, position-sorted list used by the active-index navigation path — so "first" reliably
+  means the topmost scrollable diff in the document.
+- Updated dependencies
+
 ## 11.0.4
 
 ### Patch Changes

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

@@ -179,11 +179,13 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
           }
           var pluginState = showDiffPluginKey.getState(view.state);
 
-          // Scroll to the first decoration when scrollIntoView was requested
+          // Scroll to the first decoration when scrollIntoView was requested.
+          // Use the same filtered/position-sorted list as the active-index path
+          // so "first" reliably means the topmost scrollable diff in the document.
           if (pluginState !== null && pluginState !== void 0 && pluginState.scrollIntoView && (0, _isExtendedEnabled.isExtendedEnabled)(pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType)) {
             var _cancelPendingScrollT;
             (_cancelPendingScrollT = cancelPendingScrollToDecoration) === null || _cancelPendingScrollT === void 0 || _cancelPendingScrollT();
-            cancelPendingScrollToDecoration = (0, _scrollToDiff.scrollToFirstDecoration)(view, pluginState.decorations);
+            cancelPendingScrollToDecoration = (0, _scrollToDiff.scrollToFirstDecoration)(view, (0, _getScrollableDecorations.getScrollableDecorations)(pluginState.decorations, view.state.doc, pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType));
 
             // Reset the flag so we don't scroll again on subsequent updates
             view.dispatch(view.state.tr.setMeta(showDiffPluginKey, {

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

@@ -44,38 +44,17 @@ function scrollToSelection(node) {
  * Unlike `scrollToActiveDecoration`, this does not require an active index —
  * it simply scrolls to bring the first decoration into view.
  *
+ * The caller must pass the list of scrollable decorations as produced by
+ * `getScrollableDecorations`, which is filtered (non-scrollable decorations
+ * removed) and sorted by document position. This guarantees "first" means the
+ * topmost scrollable diff in the document rather than an arbitrary decoration
+ * from the raw `DecorationSet` ordering. This is delegated to
+ * `scrollToActiveDecoration` at index 0 so both scroll paths behave identically.
+ *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-var scrollToFirstDecoration = exports.scrollToFirstDecoration = function scrollToFirstDecoration(view, set) {
-  var decoration = set.find(undefined, undefined, _decorationKeys.isDiffDecorationSpec).find(_decorationKeys.isDiffDecoration);
-  if (!decoration) {
-    return function () {};
-  }
-  var rafId = requestAnimationFrame(function () {
-    var _decoration$type;
-    rafId = null;
-    // @ts-expect-error - decoration.type is not typed public API
-    if (decoration.spec.decorationType === 'widget' && decoration !== null && decoration !== void 0 && (_decoration$type = decoration.type) !== null && _decoration$type !== void 0 && _decoration$type.toDOM) {
-      // @ts-expect-error - decoration.type is not typed public API
-      var widgetDom = decoration.type.toDOM;
-      // Always scroll to the top of this decoration even if it's in view already
-      scrollToSelection(widgetDom);
-    } else {
-      var _view$domAtPos;
-      var targetNode = view.nodeDOM(decoration === null || decoration === void 0 ? void 0 : decoration.from);
-      var node = targetNode instanceof Element ? targetNode : (_view$domAtPos = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos === void 0 ? void 0 : _view$domAtPos.node;
-      if (node instanceof HTMLElement) {
-        // Always scroll to the top of this decoration even if it's in view already
-        scrollToSelection(node);
-      }
-    }
-  });
-  return function () {
-    if (rafId !== null) {
-      cancelAnimationFrame(rafId);
-      rafId = null;
-    }
-  };
+var scrollToFirstDecoration = exports.scrollToFirstDecoration = function scrollToFirstDecoration(view, scrollableDecorations) {
+  return scrollToActiveDecoration(view, scrollableDecorations, 0);
 };
 
 /**
@@ -91,14 +70,14 @@ var scrollToActiveDecoration = exports.scrollToActiveDecoration = function scrol
   var rafId = requestAnimationFrame(function () {
     rafId = null;
     if ((0, _decorationKeys.isDiffDecoration)(decoration) && decoration.spec.decorationType === 'widget') {
-      var _decoration$type2;
+      var _decoration$type;
       // @ts-expect-error - decoration.type is not typed public API
-      var widgetDom = decoration === null || decoration === void 0 || (_decoration$type2 = decoration.type) === null || _decoration$type2 === void 0 ? void 0 : _decoration$type2.toDOM;
+      var widgetDom = decoration === null || decoration === void 0 || (_decoration$type = decoration.type) === null || _decoration$type === void 0 ? void 0 : _decoration$type.toDOM;
       scrollToSelection(widgetDom);
     } else {
-      var _view$domAtPos2;
+      var _view$domAtPos;
       var targetNode = view.nodeDOM(decoration === null || decoration === void 0 ? void 0 : decoration.from);
-      var node = targetNode instanceof Element ? targetNode : (_view$domAtPos2 = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos2 === void 0 ? void 0 : _view$domAtPos2.node;
+      var node = targetNode instanceof Element ? targetNode : (_view$domAtPos = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos === void 0 ? void 0 : _view$domAtPos.node;
       scrollToSelection(node);
     }
   });

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

@@ -186,11 +186,13 @@ export const createPlugin = (config, getIntl, api) => {
           }
           const pluginState = showDiffPluginKey.getState(view.state);
 
-          // Scroll to the first decoration when scrollIntoView was requested
+          // Scroll to the first decoration when scrollIntoView was requested.
+          // Use the same filtered/position-sorted list as the active-index path
+          // so "first" reliably means the topmost scrollable diff in the document.
           if (pluginState !== null && pluginState !== void 0 && pluginState.scrollIntoView && isExtendedEnabled(pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType)) {
             var _cancelPendingScrollT;
             (_cancelPendingScrollT = cancelPendingScrollToDecoration) === null || _cancelPendingScrollT === void 0 ? void 0 : _cancelPendingScrollT();
-            cancelPendingScrollToDecoration = scrollToFirstDecoration(view, pluginState.decorations);
+            cancelPendingScrollToDecoration = scrollToFirstDecoration(view, getScrollableDecorations(pluginState.decorations, view.state.doc, pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType));
 
             // Reset the flag so we don't scroll again on subsequent updates
             view.dispatch(view.state.tr.setMeta(showDiffPluginKey, {

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

@@ -1,4 +1,4 @@
-import { isDiffDecoration, isDiffDecorationSpec } from './decorations/decorationKeys';
+import { isDiffDecoration } from './decorations/decorationKeys';
 
 /**
  * Extra space above the scrolled-to element so it does not sit flush under the
@@ -39,39 +39,16 @@ function scrollToSelection(node) {
  * Unlike `scrollToActiveDecoration`, this does not require an active index —
  * it simply scrolls to bring the first decoration into view.
  *
+ * The caller must pass the list of scrollable decorations as produced by
+ * `getScrollableDecorations`, which is filtered (non-scrollable decorations
+ * removed) and sorted by document position. This guarantees "first" means the
+ * topmost scrollable diff in the document rather than an arbitrary decoration
+ * from the raw `DecorationSet` ordering. This is delegated to
+ * `scrollToActiveDecoration` at index 0 so both scroll paths behave identically.
+ *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-export const scrollToFirstDecoration = (view, set) => {
-  const decoration = set.find(undefined, undefined, isDiffDecorationSpec).find(isDiffDecoration);
-  if (!decoration) {
-    return () => {};
-  }
-  let rafId = requestAnimationFrame(() => {
-    var _decoration$type;
-    rafId = null;
-    // @ts-expect-error - decoration.type is not typed public API
-    if (decoration.spec.decorationType === 'widget' && decoration !== null && decoration !== void 0 && (_decoration$type = decoration.type) !== null && _decoration$type !== void 0 && _decoration$type.toDOM) {
-      // @ts-expect-error - decoration.type is not typed public API
-      const widgetDom = decoration.type.toDOM;
-      // Always scroll to the top of this decoration even if it's in view already
-      scrollToSelection(widgetDom);
-    } else {
-      var _view$domAtPos;
-      const targetNode = view.nodeDOM(decoration === null || decoration === void 0 ? void 0 : decoration.from);
-      const node = targetNode instanceof Element ? targetNode : (_view$domAtPos = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos === void 0 ? void 0 : _view$domAtPos.node;
-      if (node instanceof HTMLElement) {
-        // Always scroll to the top of this decoration even if it's in view already
-        scrollToSelection(node);
-      }
-    }
-  });
-  return () => {
-    if (rafId !== null) {
-      cancelAnimationFrame(rafId);
-      rafId = null;
-    }
-  };
-};
+export const scrollToFirstDecoration = (view, scrollableDecorations) => scrollToActiveDecoration(view, scrollableDecorations, 0);
 
 /**
  * Schedules scrolling to the decoration at the given index after the next frame.
@@ -86,14 +63,14 @@ export const scrollToActiveDecoration = (view, decorations, activeIndex) => {
   let rafId = requestAnimationFrame(() => {
     rafId = null;
     if (isDiffDecoration(decoration) && decoration.spec.decorationType === 'widget') {
-      var _decoration$type2;
+      var _decoration$type;
       // @ts-expect-error - decoration.type is not typed public API
-      const widgetDom = decoration === null || decoration === void 0 ? void 0 : (_decoration$type2 = decoration.type) === null || _decoration$type2 === void 0 ? void 0 : _decoration$type2.toDOM;
+      const widgetDom = decoration === null || decoration === void 0 ? void 0 : (_decoration$type = decoration.type) === null || _decoration$type === void 0 ? void 0 : _decoration$type.toDOM;
       scrollToSelection(widgetDom);
     } else {
-      var _view$domAtPos2;
+      var _view$domAtPos;
       const targetNode = view.nodeDOM(decoration === null || decoration === void 0 ? void 0 : decoration.from);
-      const node = targetNode instanceof Element ? targetNode : (_view$domAtPos2 = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos2 === void 0 ? void 0 : _view$domAtPos2.node;
+      const node = targetNode instanceof Element ? targetNode : (_view$domAtPos = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos === void 0 ? void 0 : _view$domAtPos.node;
       scrollToSelection(node);
     }
   });

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

@@ -172,11 +172,13 @@ export var createPlugin = function createPlugin(config, getIntl, api) {
           }
           var pluginState = showDiffPluginKey.getState(view.state);
 
-          // Scroll to the first decoration when scrollIntoView was requested
+          // Scroll to the first decoration when scrollIntoView was requested.
+          // Use the same filtered/position-sorted list as the active-index path
+          // so "first" reliably means the topmost scrollable diff in the document.
           if (pluginState !== null && pluginState !== void 0 && pluginState.scrollIntoView && isExtendedEnabled(pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType)) {
             var _cancelPendingScrollT;
             (_cancelPendingScrollT = cancelPendingScrollToDecoration) === null || _cancelPendingScrollT === void 0 || _cancelPendingScrollT();
-            cancelPendingScrollToDecoration = scrollToFirstDecoration(view, pluginState.decorations);
+            cancelPendingScrollToDecoration = scrollToFirstDecoration(view, getScrollableDecorations(pluginState.decorations, view.state.doc, pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType));
 
             // Reset the flag so we don't scroll again on subsequent updates
             view.dispatch(view.state.tr.setMeta(showDiffPluginKey, {

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

@@ -1,4 +1,4 @@
-import { isDiffDecoration, isDiffDecorationSpec } from './decorations/decorationKeys';
+import { isDiffDecoration } from './decorations/decorationKeys';
 
 /**
  * Extra space above the scrolled-to element so it does not sit flush under the
@@ -39,38 +39,17 @@ function scrollToSelection(node) {
  * Unlike `scrollToActiveDecoration`, this does not require an active index —
  * it simply scrolls to bring the first decoration into view.
  *
+ * The caller must pass the list of scrollable decorations as produced by
+ * `getScrollableDecorations`, which is filtered (non-scrollable decorations
+ * removed) and sorted by document position. This guarantees "first" means the
+ * topmost scrollable diff in the document rather than an arbitrary decoration
+ * from the raw `DecorationSet` ordering. This is delegated to
+ * `scrollToActiveDecoration` at index 0 so both scroll paths behave identically.
+ *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-export var scrollToFirstDecoration = function scrollToFirstDecoration(view, set) {
-  var decoration = set.find(undefined, undefined, isDiffDecorationSpec).find(isDiffDecoration);
-  if (!decoration) {
-    return function () {};
-  }
-  var rafId = requestAnimationFrame(function () {
-    var _decoration$type;
-    rafId = null;
-    // @ts-expect-error - decoration.type is not typed public API
-    if (decoration.spec.decorationType === 'widget' && decoration !== null && decoration !== void 0 && (_decoration$type = decoration.type) !== null && _decoration$type !== void 0 && _decoration$type.toDOM) {
-      // @ts-expect-error - decoration.type is not typed public API
-      var widgetDom = decoration.type.toDOM;
-      // Always scroll to the top of this decoration even if it's in view already
-      scrollToSelection(widgetDom);
-    } else {
-      var _view$domAtPos;
-      var targetNode = view.nodeDOM(decoration === null || decoration === void 0 ? void 0 : decoration.from);
-      var node = targetNode instanceof Element ? targetNode : (_view$domAtPos = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos === void 0 ? void 0 : _view$domAtPos.node;
-      if (node instanceof HTMLElement) {
-        // Always scroll to the top of this decoration even if it's in view already
-        scrollToSelection(node);
-      }
-    }
-  });
-  return function () {
-    if (rafId !== null) {
-      cancelAnimationFrame(rafId);
-      rafId = null;
-    }
-  };
+export var scrollToFirstDecoration = function scrollToFirstDecoration(view, scrollableDecorations) {
+  return scrollToActiveDecoration(view, scrollableDecorations, 0);
 };
 
 /**
@@ -86,14 +65,14 @@ export var scrollToActiveDecoration = function scrollToActiveDecoration(view, de
   var rafId = requestAnimationFrame(function () {
     rafId = null;
     if (isDiffDecoration(decoration) && decoration.spec.decorationType === 'widget') {
-      var _decoration$type2;
+      var _decoration$type;
       // @ts-expect-error - decoration.type is not typed public API
-      var widgetDom = decoration === null || decoration === void 0 || (_decoration$type2 = decoration.type) === null || _decoration$type2 === void 0 ? void 0 : _decoration$type2.toDOM;
+      var widgetDom = decoration === null || decoration === void 0 || (_decoration$type = decoration.type) === null || _decoration$type === void 0 ? void 0 : _decoration$type.toDOM;
       scrollToSelection(widgetDom);
     } else {
-      var _view$domAtPos2;
+      var _view$domAtPos;
       var targetNode = view.nodeDOM(decoration === null || decoration === void 0 ? void 0 : decoration.from);
-      var node = targetNode instanceof Element ? targetNode : (_view$domAtPos2 = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos2 === void 0 ? void 0 : _view$domAtPos2.node;
+      var node = targetNode instanceof Element ? targetNode : (_view$domAtPos = view.domAtPos(decoration === null || decoration === void 0 ? void 0 : decoration.from)) === null || _view$domAtPos === void 0 ? void 0 : _view$domAtPos.node;
       scrollToSelection(node);
     }
   });

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

@@ -1,12 +1,19 @@
-import type { EditorView, Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { EditorView, Decoration } from '@atlaskit/editor-prosemirror/view';
 /**
  * Schedules scrolling to the first diff decoration after the next frame.
  * Unlike `scrollToActiveDecoration`, this does not require an active index —
  * it simply scrolls to bring the first decoration into view.
  *
+ * The caller must pass the list of scrollable decorations as produced by
+ * `getScrollableDecorations`, which is filtered (non-scrollable decorations
+ * removed) and sorted by document position. This guarantees "first" means the
+ * topmost scrollable diff in the document rather than an arbitrary decoration
+ * from the raw `DecorationSet` ordering. This is delegated to
+ * `scrollToActiveDecoration` at index 0 so both scroll paths behave identically.
+ *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-export declare const scrollToFirstDecoration: (view: EditorView, set: DecorationSet) => (() => void);
+export declare const scrollToFirstDecoration: (view: EditorView, scrollableDecorations: Decoration[]) => (() => void);
 /**
  * Schedules scrolling to the decoration at the given index after the next frame.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "11.0.4",
+	"version": "11.0.5",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -54,7 +54,7 @@
 		"react-intl": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^117.4.0",
+		"@atlaskit/editor-common": "^117.5.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"techstack": {