@atlaskit/editor-plugin-quick-insert 30.0.2 → 30.0.4

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 30.0.4
+
+### Patch Changes
+
+- [`fc6a743d65633`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/fc6a743d65633) -
+  Remove unused @atlaskit/platform-feature-flags and @atlaskit/tmp-editor-statsig dependencies
+- [`7efec208f3bb4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7efec208f3bb4) -
+  Remove unused runtime dependencies
+- [`b199ccfabf69b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b199ccfabf69b) -
+  EDITOR-9784: Under the platform_editor_slash_command experiment, the quick insert registered menus
+  pass the menu's selection source to RegisteredMenuList, so hovering an item no longer scrolls a
+  partially clipped item into view.
+- Updated dependencies
+
+## 30.0.3
+
+### Patch Changes
+
+- [`9e0f075939161`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9e0f075939161) -
+  Deduplicate registered Quick Insert items across recommended, search, and browse views, while
+  preserving selection identity and registration context when `platform_editor_slash_command` is
+  enabled.
+- Updated dependencies
+
 ## 30.0.2
 
 ### Patch Changes

package/dist/cjs/quickInsertPlugin.js

@@ -28,6 +28,7 @@ var _pluginKey = require("./pm-plugins/plugin-key");
 var _blockControlQuickInsert = require("./ui/block-control-quick-insert");
 var _getLegacyCompatibleComponents = require("./ui/getLegacyCompatibleComponents");
 var _getQuickInsertComponents = require("./ui/getQuickInsertComponents");
+var _getRecommendedComponents = require("./ui/getRecommendedComponents");
 var _ModalElementBrowser = _interopRequireDefault(require("./ui/ModalElementBrowser"));
 var _RegistryElementBrowser = require("./ui/RegistryElementBrowser");
 var _search = require("./ui/search");
@@ -43,6 +44,10 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
   };
   var typeAheadPrioritySortingFn = (0, _search.withLayoutQuickInsertPrioritySorting)(options === null || options === void 0 ? void 0 : options.prioritySortingFn);
   var getItemRank = (0, _quickInsertRank.createQuickInsertRankResolver)(options === null || options === void 0 ? void 0 : options.getItemRank);
+  var getRecommendedItems = (0, _getRecommendedComponents.createRecommendedItemsResolver)({
+    isRecommendedItem: options === null || options === void 0 ? void 0 : options.isRecommendedItem,
+    maxRecommendedItems: options === null || options === void 0 ? void 0 : options.maxRecommendedItems
+  });
   var typeAhead = {
     id: _typeAhead.TypeAheadAvailableNodes.QUICK_INSERT,
     registeredMenuKey: (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_slash_command') ? _keys.MENU.key : undefined,
@@ -91,8 +96,7 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
     api === null || api === void 0 || (_api$uiControlRegistr = api.uiControlRegistry) === null || _api$uiControlRegistr === void 0 || _api$uiControlRegistr.actions.register((0, _getQuickInsertComponents.getQuickInsertComponents)({
       api: api,
       getItemRank: getItemRank,
-      isRecommendedItem: options === null || options === void 0 ? void 0 : options.isRecommendedItem,
-      maxRecommendedItems: options === null || options === void 0 ? void 0 : options.maxRecommendedItems,
+      getRecommendedItems: getRecommendedItems,
       emptyStateHandler: options === null || options === void 0 ? void 0 : options.emptyStateHandler,
       fireAnalyticsEvent: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent,
       includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true

package/dist/cjs/ui/getQuickInsertComponents.js

@@ -13,9 +13,7 @@ var _messages = require("@atlaskit/editor-common/quick-insert/messages");
 var _rank = require("@atlaskit/editor-common/quick-insert/rank");
 var _typeAheadGetMenuFooterSectionKey = require("@atlaskit/editor-common/type-ahead-get-menu-footer-section-key");
 var _typeAheadGetSectionOverflowItemKey = require("@atlaskit/editor-common/type-ahead-get-section-overflow-item-key");
-var _getRecommendedComponents = require("./getRecommendedComponents");
 var _QuickInsertMenuFooterItem = require("./QuickInsertMenuFooterItem");
-var _QuickInsertRecommendedSlot = require("./QuickInsertRecommendedSlot");
 var _QuickInsertSectionOverflowMenuItem = require("./QuickInsertSectionOverflowMenuItem");
 var _QuickInsertMenuRoot = _interopRequireDefault(require("./registered-menu/QuickInsertMenuRoot"));
 var _QuickInsertMenuSection = require("./registered-menu/QuickInsertMenuSection");
@@ -64,62 +62,24 @@ var createSectionComponent = function createSectionComponent(message) {
 var getQuickInsertComponents = exports.getQuickInsertComponents = function getQuickInsertComponents(_ref2) {
   var api = _ref2.api,
     includeElementBrowserItems = _ref2.includeElementBrowserItems,
-    isRecommendedItem = _ref2.isRecommendedItem,
-    maxRecommendedItems = _ref2.maxRecommendedItems,
     getItemRank = _ref2.getItemRank,
+    getRecommendedItems = _ref2.getRecommendedItems,
     emptyStateHandler = _ref2.emptyStateHandler,
     fireAnalyticsEvent = _ref2.fireAnalyticsEvent;
-  var recommendedSnapshot = (0, _getRecommendedComponents.createRecommendedSnapshotCache)({
-    api: api,
-    isRecommendedItem: isRecommendedItem,
-    maxRecommendedItems: maxRecommendedItems
-  });
-  var recommendedSlots = Array.from({
-    length: _getRecommendedComponents.MAX_RECOMMENDED_ITEMS
-  }, function (_, index) {
-    return {
-      key: "".concat(_getRecommendedComponents.RECOMMENDED_SLOT_KEY_PREFIX).concat(index),
-      type: 'menu-item',
-      parents: [{
-        key: _keys.RECOMMENDED_SECTION.key,
-        type: _keys.RECOMMENDED_SECTION.type,
-        rank: index
-      }],
-      match: function match() {
-        return null;
-      },
-      isHidden: function isHidden() {
-        var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-          surfaceContext = _ref3.surfaceContext;
-        return !recommendedSnapshot.getSnapshot(surfaceContext)[index];
-      },
-      component: function component(_ref4) {
-        var children = _ref4.children,
-          parents = _ref4.parents,
-          surfaceContext = _ref4.surfaceContext;
-        return /*#__PURE__*/_react.default.createElement(_QuickInsertRecommendedSlot.QuickInsertRecommendedSlot, {
-          parents: parents,
-          surfaceContext: surfaceContext,
-          index: index,
-          getSnapshot: recommendedSnapshot.getSnapshot
-        }, children);
-      }
-    };
-  });
   return [{
     key: _keys.MENU.key,
     type: _keys.MENU.type,
-    component: function component(_ref5) {
-      var children = _ref5.children;
+    component: function component() {
       return /*#__PURE__*/_react.default.createElement(_QuickInsertMenuRoot.default, {
         getItemRank: getItemRank,
+        getRecommendedItems: getRecommendedItems,
         emptyStateHandler: emptyStateHandler,
         fireAnalyticsEvent: fireAnalyticsEvent
-      }, children);
+      });
     }
-  }].concat(recommendedSlots, (0, _toConsumableArray2.default)(categories.flatMap(function (_ref6) {
-    var message = _ref6.message,
-      section = _ref6.section;
+  }].concat((0, _toConsumableArray2.default)(categories.flatMap(function (_ref3) {
+    var message = _ref3.message,
+      section = _ref3.section;
     return [{
       key: section.key,
       type: section.type,
@@ -128,12 +88,7 @@ var getQuickInsertComponents = exports.getQuickInsertComponents = function getQu
         type: _keys.MENU.type,
         rank: _rank.QUICK_INSERT_MENU_RANK[section.key]
       }],
-      component: createSectionComponent(message),
-      isHidden: section.key === _keys.RECOMMENDED_SECTION.key ? function () {
-        var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-          surfaceContext = _ref7.surfaceContext;
-        return recommendedSnapshot.getSnapshot(surfaceContext).length === 0;
-      } : undefined
+      component: createSectionComponent(message)
     }].concat((0, _toConsumableArray2.default)(includeElementBrowserItems && section.key !== _keys.RECOMMENDED_SECTION.key ? [{
       key: (0, _typeAheadGetSectionOverflowItemKey.getSectionOverflowItemKey)(section.key),
       type: 'menu-item',

package/dist/cjs/ui/getRecommendedComponents.js

@@ -3,32 +3,26 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resolveMaxRecommendedItems = exports.isRecommendedSlotKey = exports.getRecommendedComponents = exports.createRecommendedSnapshotCache = exports.RECOMMENDED_SLOT_KEY_PREFIX = exports.MAX_RECOMMENDED_ITEMS = void 0;
+exports.resolveMaxRecommendedItems = exports.getRecommendedComponents = exports.createRecommendedItemsResolver = exports.MAX_RECOMMENDED_ITEMS = void 0;
 var _error = require("@atlaskit/editor-common/monitoring/error");
 var _getProviderMenuItemKey = require("@atlaskit/editor-common/quick-insert/get-provider-menu-item-key");
 var _isRecommendedItem = require("@atlaskit/editor-common/quick-insert/is-recommended-item");
-var _keys = require("@atlaskit/editor-common/quick-insert/keys");
-var _surfaceContext = require("@atlaskit/editor-common/registered-menu/surface-context");
 var _typeAheadIsMenuFooterSectionKey = require("@atlaskit/editor-common/type-ahead-is-menu-footer-section-key");
 var _typeAheadIsSectionOverflowItemKey = require("@atlaskit/editor-common/type-ahead-is-section-overflow-item-key");
 var MAX_RECOMMENDED_ITEMS = exports.MAX_RECOMMENDED_ITEMS = 5;
-var RECOMMENDED_SLOT_KEY_PREFIX = exports.RECOMMENDED_SLOT_KEY_PREFIX = 'quick-insert-recommended-slot-';
-var isRecommendedSlotKey = exports.isRecommendedSlotKey = function isRecommendedSlotKey(key) {
-  return key.startsWith(RECOMMENDED_SLOT_KEY_PREFIX);
-};
 var isRecommendationCandidate = function isRecommendationCandidate(component) {
-  return component.type === 'menu-item' && !isRecommendedSlotKey(component.key) && !(0, _typeAheadIsSectionOverflowItemKey.isSectionOverflowItemKey)(component.key) && !component.parents.some(function (parent) {
+  return component.type === 'menu-item' && !(0, _typeAheadIsSectionOverflowItemKey.isSectionOverflowItemKey)(component.key) && !component.parents.some(function (parent) {
     return (0, _typeAheadIsMenuFooterSectionKey.isMenuFooterSectionKey)(parent.key);
   });
 };
 
-/** Normalises a consumer-supplied limit to the number of available recommended slots. */
+/** Normalises a consumer-supplied limit to the supported number of recommended items. */
 var resolveMaxRecommendedItems = exports.resolveMaxRecommendedItems = function resolveMaxRecommendedItems(maxRecommendedItems) {
   if (maxRecommendedItems === undefined || !Number.isFinite(maxRecommendedItems)) {
     return MAX_RECOMMENDED_ITEMS;
   }
   if (maxRecommendedItems > MAX_RECOMMENDED_ITEMS) {
-    void (0, _error.logException)(new Error('Quick Insert maxRecommendedItems exceeds the available slots'), {
+    void (0, _error.logException)(new Error('Quick Insert maxRecommendedItems exceeds the supported maximum'), {
       location: 'editor-plugin-quick-insert/getRecommendedComponents'
     });
   }
@@ -73,34 +67,21 @@ var getRecommendedComponents = exports.getRecommendedComponents = function getRe
   });
 };
 
-/** Keeps only the current menu-open recommendation snapshot. */
-
-var createRecommendedSnapshotCache = exports.createRecommendedSnapshotCache = function createRecommendedSnapshotCache(_ref3) {
-  var api = _ref3.api,
-    isRecommendedItem = _ref3.isRecommendedItem,
+/**
+ * Resolves the Recommended section for a browse-mode menu. Callers memoise per components array,
+ * so the resolver itself keeps no state.
+ */
+var createRecommendedItemsResolver = exports.createRecommendedItemsResolver = function createRecommendedItemsResolver(_ref3) {
+  var isRecommendedItem = _ref3.isRecommendedItem,
     maxRecommendedItems = _ref3.maxRecommendedItems;
-  var snapshot;
-  var getSnapshot = function getSnapshot(surfaceContext) {
-    var _surfaceContext$get, _snapshot;
-    var menuOpenId = surfaceContext === null || surfaceContext === void 0 || (_surfaceContext$get = surfaceContext.get(_surfaceContext.REGISTERED_MENU_SURFACE_CONTEXT)) === null || _surfaceContext$get === void 0 ? void 0 : _surfaceContext$get.menuOpenId;
-    if (!surfaceContext || !menuOpenId) {
-      return [];
-    }
-    if (((_snapshot = snapshot) === null || _snapshot === void 0 ? void 0 : _snapshot.id) !== menuOpenId) {
-      var _api$uiControlRegistr, _api$uiControlRegistr2;
-      snapshot = {
-        id: menuOpenId,
-        items: getRecommendedComponents({
-          components: (_api$uiControlRegistr = api === null || api === void 0 || (_api$uiControlRegistr2 = api.uiControlRegistry) === null || _api$uiControlRegistr2 === void 0 ? void 0 : _api$uiControlRegistr2.actions.getComponents(_keys.MENU.key)) !== null && _api$uiControlRegistr !== void 0 ? _api$uiControlRegistr : [],
-          context: surfaceContext,
-          isRecommendedItem: isRecommendedItem,
-          maxRecommendedItems: maxRecommendedItems
-        })
-      };
-    }
-    return snapshot.items;
-  };
-  return {
-    getSnapshot: getSnapshot
+  return function (_ref4) {
+    var components = _ref4.components,
+      surfaceContext = _ref4.surfaceContext;
+    return surfaceContext ? getRecommendedComponents({
+      components: components,
+      context: surfaceContext,
+      isRecommendedItem: isRecommendedItem,
+      maxRecommendedItems: maxRecommendedItems
+    }) : [];
   };
 };

package/dist/cjs/ui/registered-menu/QuickInsertMenuRoot.js

@@ -27,7 +27,7 @@ var _selectQuickInsertCategoryItems = require("./selectQuickInsertCategoryItems"
 var _ToolbarQuickInsertMenu = require("./ToolbarQuickInsertMenu");
 var _TypeAheadQuickInsertMenu = require("./TypeAheadQuickInsertMenu");
 var _useQuickInsertSearchAnalytics = require("./useQuickInsertSearchAnalytics");
-var _excluded = ["rows", "selectableItems", "selectedItemIndex", "activeItemKey"];
+var _excluded = ["rows", "selectableItems", "selectedItemIndex", "activeItemKey", "selectionSource"];
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 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; }
 var DEFAULT_MENU_MAX_HEIGHT = 480;
@@ -38,7 +38,8 @@ var QuickInsertMenuRoot = function QuickInsertMenuRoot(_ref) {
   var _surfaceContext$get, _registeredMenu$maxHe;
   var emptyStateHandler = _ref.emptyStateHandler,
     fireAnalyticsEvent = _ref.fireAnalyticsEvent,
-    getItemRank = _ref.getItemRank;
+    getItemRank = _ref.getItemRank,
+    getRecommendedItems = _ref.getRecommendedItems;
   var registeredMenu = (0, _context.useRegisteredMenuContext)();
   var _registeredMenu$query = registeredMenu.query,
     query = _registeredMenu$query === void 0 ? '' : _registeredMenu$query,
@@ -58,6 +59,7 @@ var QuickInsertMenuRoot = function QuickInsertMenuRoot(_ref) {
       components: components,
       formatMessage: formatMessage,
       getItemRank: runtimeItemRank !== null && runtimeItemRank !== void 0 ? runtimeItemRank : getItemRank,
+      getRecommendedItems: getRecommendedItems,
       query: query,
       rootComponent: rootComponent,
       selectCategoryItems: components.some(function (_ref2) {
@@ -66,7 +68,7 @@ var QuickInsertMenuRoot = function QuickInsertMenuRoot(_ref) {
       }) ? _selectQuickInsertCategoryItems.selectQuickInsertCategoryItems : undefined,
       surfaceContext: surfaceContext
     });
-  }, [components, formatMessage, getItemRank, query, rootComponent, runtimeItemRank, surfaceContext]);
+  }, [components, formatMessage, getItemRank, getRecommendedItems, query, rootComponent, runtimeItemRank, surfaceContext]);
   var resultCount = (0, _react.useMemo)(function () {
     return model.sections.reduce(function (count, _ref3) {
       var _ref4 = (0, _toArray2.default)(_ref3),
@@ -110,6 +112,7 @@ var QuickInsertMenuRoot = function QuickInsertMenuRoot(_ref) {
     selectableItems = _useRegisteredMenu.selectableItems,
     selectedItemIndex = _useRegisteredMenu.selectedItemIndex,
     activeItemKey = _useRegisteredMenu.activeItemKey,
+    selectionSource = _useRegisteredMenu.selectionSource,
     listEvents = (0, _objectWithoutProperties2.default)(_useRegisteredMenu, _excluded);
   var listId = (0, _react.useId)();
   var _useState = (0, _react.useState)({
@@ -196,7 +199,8 @@ var QuickInsertMenuRoot = function QuickInsertMenuRoot(_ref) {
     onRenderedItemsChange: setRenderedItems,
     query: query,
     rows: rows,
-    selectedItemIndex: selectedItemIndex
+    selectedItemIndex: selectedItemIndex,
+    selectionSource: selectionSource
   }) : /*#__PURE__*/_react.default.createElement(_ToolbarQuickInsertMenu.ToolbarQuickInsertMenu, {
     Item: _RegisteredQuickInsertMenuItem.RegisteredQuickInsertMenuItem,
     activePreviewItemKey: activeItemKey,
@@ -214,7 +218,8 @@ var QuickInsertMenuRoot = function QuickInsertMenuRoot(_ref) {
     onRenderedItemsChange: setRenderedItems,
     query: query,
     rows: rows,
-    selectedItemIndex: selectedItemIndex
+    selectedItemIndex: selectedItemIndex,
+    selectionSource: selectionSource
   }))));
 };
 var _default = exports.default = QuickInsertMenuRoot;

package/dist/cjs/ui/registered-menu/RegisteredQuickInsertMenuItem.js

@@ -10,7 +10,6 @@ var _provider = require("@atlaskit/editor-common/quick-insert/provider");
 var _useQuickInsertContext = require("@atlaskit/editor-common/quick-insert/use-quick-insert-context");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var RegisteredQuickInsertMenuItem = exports.RegisteredQuickInsertMenuItem = function RegisteredQuickInsertMenuItem(_ref) {
-  var _registration$compone;
   var id = _ref.id,
     isSelected = _ref.isSelected,
     isActive = _ref.isActive,
@@ -35,8 +34,11 @@ var RegisteredQuickInsertMenuItem = exports.RegisteredQuickInsertMenuItem = func
       surfaceContext: surfaceContext
     };
   }, [editorView, isOffline, popupsMountPoint, select, surfaceContext, isActive, id, isSelected]);
-  var Component = (_registration$compone = registration.component) !== null && _registration$compone !== void 0 ? _registration$compone : _react.default.Fragment;
+  var Component = registration.component;
   return /*#__PURE__*/_react.default.createElement(_provider.QuickInsertProvider, {
     value: value
-  }, /*#__PURE__*/_react.default.createElement(Component, null, null));
+  }, Component ? /*#__PURE__*/_react.default.createElement(Component, {
+    parents: registration.parents,
+    surfaceContext: surfaceContext
+  }, null) : null);
 };

package/dist/cjs/ui/registered-menu/ToolbarQuickInsertMenu.js

@@ -40,7 +40,8 @@ var ToolbarQuickInsertMenu = exports.ToolbarQuickInsertMenu = function ToolbarQu
     onItemVisibilityChange = _ref.onItemVisibilityChange,
     onRenderedItemsChange = _ref.onRenderedItemsChange,
     query = _ref.query,
-    selectedItemIndex = _ref.selectedItemIndex;
+    selectedItemIndex = _ref.selectedItemIndex,
+    selectionSource = _ref.selectionSource;
   var footerItemIndex = itemCount - 1;
   var footerItemId = (0, _getQuickInsertMenuItemId.getQuickInsertMenuItemId)(listId, footerItemIndex);
   var isEmptySearch = query !== '' && model.sections.length === 0;
@@ -91,6 +92,7 @@ var ToolbarQuickInsertMenu = exports.ToolbarQuickInsertMenu = function ToolbarQu
     getItemId: getItemId,
     activeItemKey: activePreviewItemKey,
     selectedItemIndex: selectedItemIndex,
+    selectionSource: selectionSource,
     scrollResetKey: query,
     onItemHover: onItemHover,
     onItemFocus: onItemFocus,

package/dist/cjs/ui/registered-menu/TypeAheadQuickInsertMenu.js

@@ -38,6 +38,7 @@ var TypeAheadQuickInsertMenu = exports.TypeAheadQuickInsertMenu = function TypeA
     _ref$query = _ref.query,
     query = _ref$query === void 0 ? '' : _ref$query,
     selectedItemIndex = _ref.selectedItemIndex,
+    selectionSource = _ref.selectionSource,
     _ref$hasScrollPadding = _ref.hasScrollPadding,
     hasScrollPadding = _ref$hasScrollPadding === void 0 ? false : _ref$hasScrollPadding;
   var footerItemIndex = itemCount - 1;
@@ -65,6 +66,7 @@ var TypeAheadQuickInsertMenu = exports.TypeAheadQuickInsertMenu = function TypeA
     getItemId: getItemId,
     activeItemKey: activeItemKey,
     selectedItemIndex: selectedItemIndex,
+    selectionSource: selectionSource,
     scrollResetKey: query,
     hasScrollPadding: hasScrollPadding,
     scrollTo: "top-on-reset",