@atlaskit/editor-plugin-expand 11.0.0 → 11.0.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-expand
 
+## 11.0.1
+
+### Patch Changes
+
+- [`c50b6810de5a3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c50b6810de5a3) -
+  Fix `toggleExpandRange` to set a `forceExpandOpen` node decoration via transaction meta (gated by
+  `platform_editor_expand_force_open_decoration`) so `ExpandNodeView.update()` correctly opens
+  expands visually regardless of whether the `platform_editor_aifc_expand_collapses_oncreate_fix`
+  experiment is active. Also returns `null` when no expand nodes are found or no state changes, and
+  removes stray debug `console.log` statements.
+
 ## 11.0.0
 
 ### Major Changes

package/dist/cjs/editor-commands/toggleExpandRange.js

@@ -3,9 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.toggleExpandRange = void 0;
+exports.toggleExpandRange = exports.TOGGLE_EXPAND_RANGE_META_KEY = void 0;
 var _expand = require("@atlaskit/editor-common/expand");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
+var TOGGLE_EXPAND_RANGE_META_KEY = exports.TOGGLE_EXPAND_RANGE_META_KEY = 'toggleExpandRange';
 var toggleExpandRange = exports.toggleExpandRange = function toggleExpandRange(from, to) {
   var open = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
   return function (_ref) {
@@ -15,11 +17,28 @@ var toggleExpandRange = exports.toggleExpandRange = function toggleExpandRange(f
       nestedExpand = _tr$doc$type$schema$n.nestedExpand;
     var fromClamped = from && from >= 0 ? from : 0;
     var toClamped = to && to <= tr.doc.content.size ? to : tr.doc.content.size;
-    tr.doc.nodesBetween(fromClamped, toClamped, function (node) {
+    var positions = [];
+    tr.doc.nodesBetween(fromClamped, toClamped, function (node, pos) {
       if ([expand, nestedExpand].includes(node.type)) {
         _expand.expandedState.set(node, open);
+        positions.push(pos);
       }
     });
+    if ((0, _platformFeatureFlags.fg)('platform_editor_show_diff_scroll_navigation')) {
+      if (positions.length === 0) {
+        // No expand nodes found in the range — nothing to dispatch.
+        return null;
+      }
+
+      // Set meta so the expand PM plugin can add node decorations.
+      // This ensures ExpandNodeView.update() receives the decoration and visually
+      // opens or closes the expand, even when the experiment below is disabled.
+      tr.setMeta(TOGGLE_EXPAND_RANGE_META_KEY, {
+        positions: positions,
+        open: open
+      });
+      return tr;
+    }
     if ((0, _expValEquals.expValEquals)('platform_editor_aifc_expand_collapses_oncreate_fix', 'isEnabled', true)) {
       return tr;
     }

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

@@ -13,6 +13,9 @@ var _selection = require("@atlaskit/editor-common/selection");
 var _styles = require("@atlaskit/editor-common/styles");
 var _transforms = require("@atlaskit/editor-common/transforms");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _view2 = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _toggleExpandRange = require("../../editor-commands/toggleExpandRange");
 var _nodeViews = _interopRequireDefault(require("../node-views"));
 // Ignored via go/ees005
 // eslint-disable-next-line import/no-named-as-default
@@ -32,7 +35,44 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, getInt
   var isMobile = false;
   return new _safePlugin.SafePlugin({
     key: pluginKey,
+    state: {
+      init: function init() {
+        return _view2.DecorationSet.empty;
+      },
+      apply: function apply(tr, decorationSet) {
+        if (!(0, _platformFeatureFlags.fg)('platform_editor_show_diff_scroll_navigation')) {
+          return _view2.DecorationSet.empty;
+        }
+        var meta = tr.getMeta(_toggleExpandRange.TOGGLE_EXPAND_RANGE_META_KEY);
+        if (meta && meta.positions.length > 0) {
+          // Add node decorations for each expand node that was toggled.
+          // ExpandNodeView.update() uses these decorations to detect it needs to
+          // visually open or close, even when expandedState was set before the
+          // transaction replaced the node objects.
+          // We do NOT map or carry forward existing decorations — we start fresh
+          // each time the meta is present.
+          var decorations = meta.positions.map(function (pos) {
+            var _tr$doc$nodeAt$nodeSi, _tr$doc$nodeAt;
+            return _view2.Decoration.node(pos, pos + ((_tr$doc$nodeAt$nodeSi = (_tr$doc$nodeAt = tr.doc.nodeAt(pos)) === null || _tr$doc$nodeAt === void 0 ? void 0 : _tr$doc$nodeAt.nodeSize) !== null && _tr$doc$nodeAt$nodeSi !== void 0 ? _tr$doc$nodeAt$nodeSi : 0), {}, {
+              forceExpandOpen: meta.open
+            });
+          });
+          return _view2.DecorationSet.create(tr.doc, decorations);
+        }
+
+        // Map existing decorations through document changes.
+        // They will be naturally cleared when they no longer match any node
+        // (e.g. if the expand is deleted), or on the next toggleExpandRange call.
+        return decorationSet.map(tr.mapping, tr.doc);
+      }
+    },
     props: {
+      decorations: function decorations(state) {
+        if (!(0, _platformFeatureFlags.fg)('platform_editor_show_diff_scroll_navigation')) {
+          return undefined;
+        }
+        return pluginKey.getState(state);
+      },
       nodeViews: {
         expand: (0, _nodeViews.default)({
           getIntl: getIntl,

package/dist/es2019/editor-commands/toggleExpandRange.js

@@ -1,5 +1,7 @@
 import { expandedState } from '@atlaskit/editor-common/expand';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+export const TOGGLE_EXPAND_RANGE_META_KEY = 'toggleExpandRange';
 export const toggleExpandRange = (from, to, open = true) => ({
   tr
 }) => {
@@ -9,11 +11,28 @@ export const toggleExpandRange = (from, to, open = true) => ({
   } = tr.doc.type.schema.nodes;
   const fromClamped = from && from >= 0 ? from : 0;
   const toClamped = to && to <= tr.doc.content.size ? to : tr.doc.content.size;
-  tr.doc.nodesBetween(fromClamped, toClamped, node => {
+  const positions = [];
+  tr.doc.nodesBetween(fromClamped, toClamped, (node, pos) => {
     if ([expand, nestedExpand].includes(node.type)) {
       expandedState.set(node, open);
+      positions.push(pos);
     }
   });
+  if (fg('platform_editor_show_diff_scroll_navigation')) {
+    if (positions.length === 0) {
+      // No expand nodes found in the range — nothing to dispatch.
+      return null;
+    }
+
+    // Set meta so the expand PM plugin can add node decorations.
+    // This ensures ExpandNodeView.update() receives the decoration and visually
+    // opens or closes the expand, even when the experiment below is disabled.
+    tr.setMeta(TOGGLE_EXPAND_RANGE_META_KEY, {
+      positions,
+      open
+    });
+    return tr;
+  }
   if (expValEquals('platform_editor_aifc_expand_collapses_oncreate_fix', 'isEnabled', true)) {
     return tr;
   }

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

@@ -3,6 +3,9 @@ import { createSelectionClickHandler } from '@atlaskit/editor-common/selection';
 import { expandClassNames } from '@atlaskit/editor-common/styles';
 import { transformSliceExpandToNestedExpand, transformSliceNestedExpandToExpand } from '@atlaskit/editor-common/transforms';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { TOGGLE_EXPAND_RANGE_META_KEY } from '../../editor-commands/toggleExpandRange';
 // Ignored via go/ees005
 // eslint-disable-next-line import/no-named-as-default
 import ExpandNodeView from '../node-views';
@@ -15,7 +18,44 @@ export const createPlugin = (dispatch, getIntl, appearance = 'full-page', useLon
   const isMobile = false;
   return new SafePlugin({
     key: pluginKey,
+    state: {
+      init() {
+        return DecorationSet.empty;
+      },
+      apply(tr, decorationSet) {
+        if (!fg('platform_editor_show_diff_scroll_navigation')) {
+          return DecorationSet.empty;
+        }
+        const meta = tr.getMeta(TOGGLE_EXPAND_RANGE_META_KEY);
+        if (meta && meta.positions.length > 0) {
+          // Add node decorations for each expand node that was toggled.
+          // ExpandNodeView.update() uses these decorations to detect it needs to
+          // visually open or close, even when expandedState was set before the
+          // transaction replaced the node objects.
+          // We do NOT map or carry forward existing decorations — we start fresh
+          // each time the meta is present.
+          const decorations = meta.positions.map(pos => {
+            var _tr$doc$nodeAt$nodeSi, _tr$doc$nodeAt;
+            return Decoration.node(pos, pos + ((_tr$doc$nodeAt$nodeSi = (_tr$doc$nodeAt = tr.doc.nodeAt(pos)) === null || _tr$doc$nodeAt === void 0 ? void 0 : _tr$doc$nodeAt.nodeSize) !== null && _tr$doc$nodeAt$nodeSi !== void 0 ? _tr$doc$nodeAt$nodeSi : 0), {}, {
+              forceExpandOpen: meta.open
+            });
+          });
+          return DecorationSet.create(tr.doc, decorations);
+        }
+
+        // Map existing decorations through document changes.
+        // They will be naturally cleared when they no longer match any node
+        // (e.g. if the expand is deleted), or on the next toggleExpandRange call.
+        return decorationSet.map(tr.mapping, tr.doc);
+      }
+    },
     props: {
+      decorations(state) {
+        if (!fg('platform_editor_show_diff_scroll_navigation')) {
+          return undefined;
+        }
+        return pluginKey.getState(state);
+      },
       nodeViews: {
         expand: ExpandNodeView({
           getIntl,

package/dist/esm/editor-commands/toggleExpandRange.js

@@ -1,5 +1,7 @@
 import { expandedState } from '@atlaskit/editor-common/expand';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+export var TOGGLE_EXPAND_RANGE_META_KEY = 'toggleExpandRange';
 export var toggleExpandRange = function toggleExpandRange(from, to) {
   var open = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
   return function (_ref) {
@@ -9,11 +11,28 @@ export var toggleExpandRange = function toggleExpandRange(from, to) {
       nestedExpand = _tr$doc$type$schema$n.nestedExpand;
     var fromClamped = from && from >= 0 ? from : 0;
     var toClamped = to && to <= tr.doc.content.size ? to : tr.doc.content.size;
-    tr.doc.nodesBetween(fromClamped, toClamped, function (node) {
+    var positions = [];
+    tr.doc.nodesBetween(fromClamped, toClamped, function (node, pos) {
       if ([expand, nestedExpand].includes(node.type)) {
         expandedState.set(node, open);
+        positions.push(pos);
       }
     });
+    if (fg('platform_editor_show_diff_scroll_navigation')) {
+      if (positions.length === 0) {
+        // No expand nodes found in the range — nothing to dispatch.
+        return null;
+      }
+
+      // Set meta so the expand PM plugin can add node decorations.
+      // This ensures ExpandNodeView.update() receives the decoration and visually
+      // opens or closes the expand, even when the experiment below is disabled.
+      tr.setMeta(TOGGLE_EXPAND_RANGE_META_KEY, {
+        positions: positions,
+        open: open
+      });
+      return tr;
+    }
     if (expValEquals('platform_editor_aifc_expand_collapses_oncreate_fix', 'isEnabled', true)) {
       return tr;
     }

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

@@ -3,6 +3,9 @@ import { createSelectionClickHandler } from '@atlaskit/editor-common/selection';
 import { expandClassNames } from '@atlaskit/editor-common/styles';
 import { transformSliceExpandToNestedExpand, transformSliceNestedExpandToExpand } from '@atlaskit/editor-common/transforms';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { TOGGLE_EXPAND_RANGE_META_KEY } from '../../editor-commands/toggleExpandRange';
 // Ignored via go/ees005
 // eslint-disable-next-line import/no-named-as-default
 import ExpandNodeView from '../node-views';
@@ -21,7 +24,44 @@ export var createPlugin = function createPlugin(dispatch, getIntl) {
   var isMobile = false;
   return new SafePlugin({
     key: pluginKey,
+    state: {
+      init: function init() {
+        return DecorationSet.empty;
+      },
+      apply: function apply(tr, decorationSet) {
+        if (!fg('platform_editor_show_diff_scroll_navigation')) {
+          return DecorationSet.empty;
+        }
+        var meta = tr.getMeta(TOGGLE_EXPAND_RANGE_META_KEY);
+        if (meta && meta.positions.length > 0) {
+          // Add node decorations for each expand node that was toggled.
+          // ExpandNodeView.update() uses these decorations to detect it needs to
+          // visually open or close, even when expandedState was set before the
+          // transaction replaced the node objects.
+          // We do NOT map or carry forward existing decorations — we start fresh
+          // each time the meta is present.
+          var decorations = meta.positions.map(function (pos) {
+            var _tr$doc$nodeAt$nodeSi, _tr$doc$nodeAt;
+            return Decoration.node(pos, pos + ((_tr$doc$nodeAt$nodeSi = (_tr$doc$nodeAt = tr.doc.nodeAt(pos)) === null || _tr$doc$nodeAt === void 0 ? void 0 : _tr$doc$nodeAt.nodeSize) !== null && _tr$doc$nodeAt$nodeSi !== void 0 ? _tr$doc$nodeAt$nodeSi : 0), {}, {
+              forceExpandOpen: meta.open
+            });
+          });
+          return DecorationSet.create(tr.doc, decorations);
+        }
+
+        // Map existing decorations through document changes.
+        // They will be naturally cleared when they no longer match any node
+        // (e.g. if the expand is deleted), or on the next toggleExpandRange call.
+        return decorationSet.map(tr.mapping, tr.doc);
+      }
+    },
     props: {
+      decorations: function decorations(state) {
+        if (!fg('platform_editor_show_diff_scroll_navigation')) {
+          return undefined;
+        }
+        return pluginKey.getState(state);
+      },
       nodeViews: {
         expand: ExpandNodeView({
           getIntl: getIntl,

package/dist/types/editor-commands/toggleExpandRange.d.ts

@@ -1,2 +1,3 @@
 import type { EditorCommand } from '@atlaskit/editor-common/types';
+export declare const TOGGLE_EXPAND_RANGE_META_KEY = "toggleExpandRange";
 export declare const toggleExpandRange: (from?: number, to?: number, open?: boolean) => EditorCommand;

package/dist/types-ts4.5/editor-commands/toggleExpandRange.d.ts

@@ -1,2 +1,3 @@
 import type { EditorCommand } from '@atlaskit/editor-common/types';
+export declare const TOGGLE_EXPAND_RANGE_META_KEY = "toggleExpandRange";
 export declare const toggleExpandRange: (from?: number, to?: number, open?: boolean) => EditorCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-expand",
-	"version": "11.0.0",
+	"version": "11.0.1",
 	"description": "Expand plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -109,6 +109,9 @@
 		},
 		"platform_editor_block_menu_v2_patch_3": {
 			"type": "boolean"
+		},
+		"platform_editor_show_diff_scroll_navigation": {
+			"type": "boolean"
 		}
 	}
 }