@atlaskit/editor-plugin-show-diff 13.0.7 → 13.0.8

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 13.0.8
+
+### Patch Changes
+
+- [`d4fbe7dee465e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d4fbe7dee465e) -
+  Consolidate diff decoration scrolling into a single internal helper.
+- Updated dependencies
+
 ## 13.0.7
 
 ### Patch Changes

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

@@ -187,7 +187,7 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
           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, (0, _getScrollableDecorations.getScrollableDecorations)(pluginState.decorations, view.state.doc, pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType));
+            cancelPendingScrollToDecoration = (0, _scrollToDiff.scrollToDecoration)(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, {
@@ -208,7 +208,7 @@ var createPlugin = exports.createPlugin = function createPlugin(config, getIntl,
               // avoid a circular dependency; expand picks up the meta if loaded (no-op if not).
               api === null || api === void 0 || api.core.actions.execute((0, _expand.toggleExpandRange)(activeDecoration.from, activeDecoration.to, true));
             }
-            cancelPendingScrollToDecoration = (0, _scrollToDiff.scrollToActiveDecoration)(view, scrollableDecorations, pluginState.activeIndex);
+            cancelPendingScrollToDecoration = (0, _scrollToDiff.scrollToDecoration)(view, scrollableDecorations, pluginState.activeIndex);
           }
         },
         destroy: function destroy() {

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.scrollToFirstDecoration = exports.scrollToActiveDecoration = void 0;
+exports.scrollToDecoration = void 0;
 var _decorationKeys = require("./decorations/decorationKeys");
 /**
  * Extra space above the scrolled-to element so it does not sit flush under the
@@ -40,29 +40,13 @@ function scrollToSelection(node) {
 }
 
 /**
- * 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.
- */
-var scrollToFirstDecoration = exports.scrollToFirstDecoration = function scrollToFirstDecoration(view, scrollableDecorations) {
-  return scrollToActiveDecoration(view, scrollableDecorations, 0);
-};
-
-/**
- * Schedules scrolling to the decoration at the given index after the next frame.
+ * Schedules scrolling to the decoration at the given index after the next frame. Defaults to the
+ * first decoration when no index is provided.
  *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-var scrollToActiveDecoration = exports.scrollToActiveDecoration = function scrollToActiveDecoration(view, decorations, activeIndex) {
+var scrollToDecoration = exports.scrollToDecoration = function scrollToDecoration(view, decorations) {
+  var activeIndex = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
   var decoration = decorations[activeIndex];
   if (!decoration) {
     return function () {};

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

@@ -9,7 +9,7 @@ import { enforceCustomStepRegisters } from './enforceCustomStepRegisters';
 import { getScrollableDecorations } from './getScrollableDecorations';
 import { isExtendedEnabled } from './isExtendedEnabled';
 import { NodeViewSerializer } from './NodeViewSerializer';
-import { scrollToActiveDecoration, scrollToFirstDecoration } from './scrollToDiff';
+import { scrollToDecoration } from './scrollToDiff';
 export const showDiffPluginKey = new PluginKey('showDiffPlugin');
 export const createPlugin = (config, getIntl, api, onEditorView) => {
   enforceCustomStepRegisters();
@@ -194,7 +194,7 @@ export const createPlugin = (config, getIntl, api, onEditorView) => {
           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, getScrollableDecorations(pluginState.decorations, view.state.doc, pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType));
+            cancelPendingScrollToDecoration = scrollToDecoration(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, {
@@ -215,7 +215,7 @@ export const createPlugin = (config, getIntl, api, onEditorView) => {
               // avoid a circular dependency; expand picks up the meta if loaded (no-op if not).
               api === null || api === void 0 ? void 0 : api.core.actions.execute(toggleExpandRange(activeDecoration.from, activeDecoration.to, true));
             }
-            cancelPendingScrollToDecoration = scrollToActiveDecoration(view, scrollableDecorations, pluginState.activeIndex);
+            cancelPendingScrollToDecoration = scrollToDecoration(view, scrollableDecorations, pluginState.activeIndex);
           }
         },
         destroy() {

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

@@ -35,27 +35,12 @@ function scrollToSelection(node) {
 }
 
 /**
- * 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 const scrollToFirstDecoration = (view, scrollableDecorations) => scrollToActiveDecoration(view, scrollableDecorations, 0);
-
-/**
- * Schedules scrolling to the decoration at the given index after the next frame.
+ * Schedules scrolling to the decoration at the given index after the next frame. Defaults to the
+ * first decoration when no index is provided.
  *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-export const scrollToActiveDecoration = (view, decorations, activeIndex) => {
+export const scrollToDecoration = (view, decorations, activeIndex = 0) => {
   const decoration = decorations[activeIndex];
   if (!decoration) {
     return () => {};

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

@@ -12,7 +12,7 @@ import { enforceCustomStepRegisters } from './enforceCustomStepRegisters';
 import { getScrollableDecorations } from './getScrollableDecorations';
 import { isExtendedEnabled } from './isExtendedEnabled';
 import { NodeViewSerializer } from './NodeViewSerializer';
-import { scrollToActiveDecoration, scrollToFirstDecoration } from './scrollToDiff';
+import { scrollToDecoration } from './scrollToDiff';
 export var showDiffPluginKey = new PluginKey('showDiffPlugin');
 export var createPlugin = function createPlugin(config, getIntl, api, onEditorView) {
   enforceCustomStepRegisters();
@@ -180,7 +180,7 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
           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, getScrollableDecorations(pluginState.decorations, view.state.doc, pluginState === null || pluginState === void 0 ? void 0 : pluginState.diffType));
+            cancelPendingScrollToDecoration = scrollToDecoration(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, {
@@ -201,7 +201,7 @@ export var createPlugin = function createPlugin(config, getIntl, api, onEditorVi
               // avoid a circular dependency; expand picks up the meta if loaded (no-op if not).
               api === null || api === void 0 || api.core.actions.execute(toggleExpandRange(activeDecoration.from, activeDecoration.to, true));
             }
-            cancelPendingScrollToDecoration = scrollToActiveDecoration(view, scrollableDecorations, pluginState.activeIndex);
+            cancelPendingScrollToDecoration = scrollToDecoration(view, scrollableDecorations, pluginState.activeIndex);
           }
         },
         destroy: function destroy() {

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

@@ -35,29 +35,13 @@ function scrollToSelection(node) {
 }
 
 /**
- * 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 var scrollToFirstDecoration = function scrollToFirstDecoration(view, scrollableDecorations) {
-  return scrollToActiveDecoration(view, scrollableDecorations, 0);
-};
-
-/**
- * Schedules scrolling to the decoration at the given index after the next frame.
+ * Schedules scrolling to the decoration at the given index after the next frame. Defaults to the
+ * first decoration when no index is provided.
  *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-export var scrollToActiveDecoration = function scrollToActiveDecoration(view, decorations, activeIndex) {
+export var scrollToDecoration = function scrollToDecoration(view, decorations) {
+  var activeIndex = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
   var decoration = decorations[activeIndex];
   if (!decoration) {
     return function () {};

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

@@ -1,22 +1,8 @@
 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, scrollableDecorations: Decoration[]) => (() => void);
-/**
- * Schedules scrolling to the decoration at the given index after the next frame.
+ * Schedules scrolling to the decoration at the given index after the next frame. Defaults to the
+ * first decoration when no index is provided.
  *
  * @returns A function that cancels the scheduled `requestAnimationFrame` if it has not run yet.
  */
-export declare const scrollToActiveDecoration: (view: EditorView, decorations: Decoration[], activeIndex: number) => (() => void);
+export declare const scrollToDecoration: (view: EditorView, decorations: Decoration[], activeIndex?: number) => (() => void);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "13.0.7",
+	"version": "13.0.8",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -37,7 +37,7 @@
 	},
 	"devDependencies": {
 		"@atlaskit/adf-utils": "^20.6.0",
-		"@atlaskit/button": "^25.0.0",
+		"@atlaskit/button": "^25.1.0",
 		"@atlaskit/css": "^1.0.0",
 		"@atlaskit/dropdown-menu": "^18.0.0",
 		"@atlaskit/editor-core": "^224.1.0",
@@ -53,7 +53,7 @@
 		"react-intl": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.7.0",
+		"@atlaskit/editor-common": "^119.8.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"techstack": {