@atlaskit/editor-plugin-quick-insert 15.0.10 → 15.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 15.1.0
+
+### Minor Changes
+
+- [`edcef04b6350e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/edcef04b6350e) -
+  Add the Quick Insert recommendation resolver API and typed surface context support for the gated
+  `platform_editor_slash_command` Recommended menu. TypeAhead uses immutable surface context for
+  visibility and React context for registered Quick Insert rendering, while Quick Insert keeps one
+  recommendation snapshot per menu open. Fix Quick Insert declaration generation.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 15.0.10
 
 ### Patch Changes

package/dist/cjs/quickInsertPlugin.js

@@ -99,7 +99,8 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
     var _api$uiControlRegistr;
     api === null || api === void 0 || (_api$uiControlRegistr = api.uiControlRegistry) === null || _api$uiControlRegistr === void 0 || _api$uiControlRegistr.actions.register((0, _getQuickInsertComponents.getQuickInsertComponents)({
       api: api,
-      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true
+      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true,
+      isRecommendedItem: options === null || options === void 0 ? void 0 : options.isRecommendedItem
     }));
   }
   var openElementBrowser = function openElementBrowser(options) {

package/dist/cjs/ui/QuickInsertRecommendedSlot.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.QuickInsertRecommendedSlot = void 0;
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _useQuickInsertContext = require("@atlaskit/editor-common/quick-insert/use-quick-insert-context");
+var _excluded = ["index", "getSnapshot"];
+var QuickInsertRecommendedSlot = exports.QuickInsertRecommendedSlot = function QuickInsertRecommendedSlot(_ref) {
+  var index = _ref.index,
+    getSnapshot = _ref.getSnapshot,
+    props = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var _useQuickInsertContex = (0, _useQuickInsertContext.useQuickInsertContext)(),
+    surfaceContext = _useQuickInsertContex.surfaceContext;
+  var item = getSnapshot(surfaceContext)[index];
+  return item !== null && item !== void 0 && item.component ? /*#__PURE__*/_react.default.createElement(item.component, props) : null;
+};

package/dist/cjs/ui/getQuickInsertComponents.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getQuickInsertComponents = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireDefault(require("react"));
 var _reactIntl = require("react-intl");
 var _keys = require("@atlaskit/editor-common/quick-insert/keys");
@@ -16,7 +17,11 @@ 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 _QuickInsertMenuFooterItem = require("./QuickInsertMenuFooterItem");
+var _QuickInsertRecommendedSlot = require("./QuickInsertRecommendedSlot");
 var _QuickInsertSectionOverflowMenuItem = require("./QuickInsertSectionOverflowMenuItem");
+var _getRecommendedComponents = require("./getRecommendedComponents");
+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) { (0, _defineProperty2.default)(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; }
 var categories = [{
   message: _messages.messages.categoryRecommended,
   section: _keys.RECOMMENDED_SECTION
@@ -58,14 +63,46 @@ var createSectionComponent = function createSectionComponent(message) {
 };
 var getQuickInsertComponents = exports.getQuickInsertComponents = function getQuickInsertComponents(_ref2) {
   var api = _ref2.api,
-    includeElementBrowserItems = _ref2.includeElementBrowserItems;
+    includeElementBrowserItems = _ref2.includeElementBrowserItems,
+    isRecommendedItem = _ref2.isRecommendedItem;
+  var recommendedSnapshot = (0, _getRecommendedComponents.createRecommendedSnapshotCache)({
+    api: api,
+    isRecommendedItem: isRecommendedItem
+  });
+  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(props) {
+        return /*#__PURE__*/_react.default.createElement(_QuickInsertRecommendedSlot.QuickInsertRecommendedSlot, _objectSpread(_objectSpread({}, props), {}, {
+          index: index,
+          getSnapshot: recommendedSnapshot.getSnapshot
+        }));
+      }
+    };
+  });
   return [{
     key: _keys.MENU.key,
     type: _keys.MENU.type,
     component: _menuRoot.QuickInsertMenuRoot
-  }].concat((0, _toConsumableArray2.default)(categories.flatMap(function (_ref3) {
-    var message = _ref3.message,
-      section = _ref3.section;
+  }].concat(recommendedSlots, (0, _toConsumableArray2.default)(categories.flatMap(function (_ref4) {
+    var message = _ref4.message,
+      section = _ref4.section;
     return [{
       key: section.key,
       type: section.type,
@@ -74,8 +111,13 @@ var getQuickInsertComponents = exports.getQuickInsertComponents = function getQu
         type: _keys.MENU.type,
         rank: _rank.QUICK_INSERT_MENU_RANK[section.key]
       }],
-      component: createSectionComponent(message)
-    }].concat((0, _toConsumableArray2.default)(includeElementBrowserItems ? [{
+      component: createSectionComponent(message),
+      isHidden: section.key === _keys.RECOMMENDED_SECTION.key ? function () {
+        var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+          surfaceContext = _ref5.surfaceContext;
+        return recommendedSnapshot.getSnapshot(surfaceContext).length === 0;
+      } : undefined
+    }].concat((0, _toConsumableArray2.default)(includeElementBrowserItems && section.key !== _keys.RECOMMENDED_SECTION.key ? [{
       key: (0, _typeAheadGetSectionOverflowItemKey.getSectionOverflowItemKey)(section.key),
       type: 'menu-item',
       parents: [{

package/dist/cjs/ui/getRecommendedComponents.js

@@ -0,0 +1,88 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isRecommendedSlotKey = exports.getRecommendedComponents = exports.createRecommendedSnapshotCache = exports.RECOMMENDED_SLOT_KEY_PREFIX = exports.MAX_RECOMMENDED_ITEMS = void 0;
+var _keys = require("@atlaskit/editor-common/quick-insert/keys");
+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 _isRecommendedItem = require("@atlaskit/editor-common/quick-insert/is-recommended-item");
+var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _typeAheadSurfaceContext = require("@atlaskit/editor-common/type-ahead-surface-context");
+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 (0, _typeAheadIsMenuFooterSectionKey.isMenuFooterSectionKey)(parent.key);
+  });
+};
+var getRecommendedComponents = exports.getRecommendedComponents = function getRecommendedComponents(_ref) {
+  var components = _ref.components,
+    context = _ref.context,
+    _ref$isRecommendedIte = _ref.isRecommendedItem,
+    isRecommendedItem = _ref$isRecommendedIte === void 0 ? _isRecommendedItem.defaultIsRecommendedItem : _ref$isRecommendedIte;
+  return components.filter(isRecommendationCandidate).flatMap(function (component, index) {
+    var _component$isHidden;
+    var result = isRecommendedItem({
+      itemKey: component.key
+    });
+    if (result === null) {
+      return [];
+    }
+    if (Number.isNaN(result)) {
+      void (0, _monitoring.logException)(new Error('Invalid Quick Insert recommended item rank'), {
+        location: 'editor-plugin-quick-insert/getRecommendedComponents'
+      });
+      return [];
+    }
+    if ((_component$isHidden = component.isHidden) !== null && _component$isHidden !== void 0 && _component$isHidden.call(component, {
+      surfaceContext: context
+    })) {
+      return [];
+    }
+    return [{
+      component: component,
+      index: index,
+      rank: result
+    }];
+  }).sort(function (first, second) {
+    return first.rank === second.rank ? first.index - second.index : first.rank - second.rank;
+  }).slice(0, MAX_RECOMMENDED_ITEMS).map(function (_ref2) {
+    var component = _ref2.component;
+    return component;
+  });
+};
+
+/** Keeps only the current menu-open recommendation snapshot. */
+
+var createRecommendedSnapshotCache = exports.createRecommendedSnapshotCache = function createRecommendedSnapshotCache(_ref3) {
+  var api = _ref3.api,
+    isRecommendedItem = _ref3.isRecommendedItem;
+  var snapshot;
+  var getSnapshot = function getSnapshot(surfaceContext) {
+    var _surfaceContext$get, _snapshot;
+    var menuOpenId = surfaceContext === null || surfaceContext === void 0 || (_surfaceContext$get = surfaceContext.get(_typeAheadSurfaceContext.TYPE_AHEAD_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
+        })
+      };
+    }
+    return snapshot.items;
+  };
+  return {
+    getSnapshot: getSnapshot
+  };
+};

package/dist/es2019/quickInsertPlugin.js

@@ -90,7 +90,8 @@ export const quickInsertPlugin = ({
     var _api$uiControlRegistr;
     api === null || api === void 0 ? void 0 : (_api$uiControlRegistr = api.uiControlRegistry) === null || _api$uiControlRegistr === void 0 ? void 0 : _api$uiControlRegistr.actions.register(getQuickInsertComponents({
       api,
-      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true
+      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true,
+      isRecommendedItem: options === null || options === void 0 ? void 0 : options.isRecommendedItem
     }));
   }
   const openElementBrowser = options => ({

package/dist/es2019/ui/QuickInsertRecommendedSlot.js

@@ -0,0 +1,13 @@
+import React from 'react';
+import { useQuickInsertContext } from '@atlaskit/editor-common/quick-insert/use-quick-insert-context';
+export const QuickInsertRecommendedSlot = ({
+  index,
+  getSnapshot,
+  ...props
+}) => {
+  const {
+    surfaceContext
+  } = useQuickInsertContext();
+  const item = getSnapshot(surfaceContext)[index];
+  return item !== null && item !== void 0 && item.component ? /*#__PURE__*/React.createElement(item.component, props) : null;
+};

package/dist/es2019/ui/getQuickInsertComponents.js

@@ -8,7 +8,9 @@ import { CATEGORY_VIEW_MORE_RANK, QUICK_INSERT_MENU_RANK } from '@atlaskit/edito
 import { getMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-get-menu-footer-section-key';
 import { getSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-get-section-overflow-item-key';
 import { QuickInsertMenuFooterItem } from './QuickInsertMenuFooterItem';
+import { QuickInsertRecommendedSlot } from './QuickInsertRecommendedSlot';
 import { QuickInsertSectionOverflowMenuItem } from './QuickInsertSectionOverflowMenuItem';
+import { createRecommendedSnapshotCache, MAX_RECOMMENDED_ITEMS, RECOMMENDED_SLOT_KEY_PREFIX } from './getRecommendedComponents';
 const categories = [{
   message: messages.categoryRecommended,
   section: RECOMMENDED_SECTION
@@ -52,52 +54,82 @@ const createSectionComponent = message => {
 };
 export const getQuickInsertComponents = ({
   api,
-  includeElementBrowserItems
-}) => [{
-  key: MENU.key,
-  type: MENU.type,
-  component: QuickInsertMenuRoot
-}, ...categories.flatMap(({
-  message,
-  section
-}) => [{
-  key: section.key,
-  type: section.type,
-  parents: [{
+  includeElementBrowserItems,
+  isRecommendedItem
+}) => {
+  const recommendedSnapshot = createRecommendedSnapshotCache({
+    api,
+    isRecommendedItem
+  });
+  const recommendedSlots = Array.from({
+    length: MAX_RECOMMENDED_ITEMS
+  }, (_, index) => ({
+    key: `${RECOMMENDED_SLOT_KEY_PREFIX}${index}`,
+    type: 'menu-item',
+    parents: [{
+      key: RECOMMENDED_SECTION.key,
+      type: RECOMMENDED_SECTION.type,
+      rank: index
+    }],
+    match: () => null,
+    isHidden: ({
+      surfaceContext
+    } = {}) => !recommendedSnapshot.getSnapshot(surfaceContext)[index],
+    component: props => /*#__PURE__*/React.createElement(QuickInsertRecommendedSlot, {
+      ...props,
+      index,
+      getSnapshot: recommendedSnapshot.getSnapshot
+    })
+  }));
+  return [{
     key: MENU.key,
     type: MENU.type,
-    rank: QUICK_INSERT_MENU_RANK[section.key]
-  }],
-  component: createSectionComponent(message)
-}, ...(includeElementBrowserItems ? [{
-  key: getSectionOverflowItemKey(section.key),
-  type: 'menu-item',
-  parents: [{
+    component: QuickInsertMenuRoot
+  }, ...recommendedSlots, ...categories.flatMap(({
+    message,
+    section
+  }) => [{
     key: section.key,
     type: section.type,
-    rank: CATEGORY_VIEW_MORE_RANK
-  }],
-  component: () => /*#__PURE__*/React.createElement(QuickInsertSectionOverflowMenuItem, {
-    api,
-    category: section.key
-  })
-}] : [])]), ...(includeElementBrowserItems ? [{
-  key: getMenuFooterSectionKey(MENU.key),
-  type: 'menu-section',
-  parents: [{
-    key: MENU.key,
-    type: MENU.type,
-    rank: Number.MAX_SAFE_INTEGER
-  }]
-}, {
-  key: VIEW_ALL_ELEMENTS_MENU_ITEM.key,
-  type: VIEW_ALL_ELEMENTS_MENU_ITEM.type,
-  parents: [{
+    parents: [{
+      key: MENU.key,
+      type: MENU.type,
+      rank: QUICK_INSERT_MENU_RANK[section.key]
+    }],
+    component: createSectionComponent(message),
+    isHidden: section.key === RECOMMENDED_SECTION.key ? ({
+      surfaceContext
+    } = {}) => recommendedSnapshot.getSnapshot(surfaceContext).length === 0 : undefined
+  }, ...(includeElementBrowserItems && section.key !== RECOMMENDED_SECTION.key ? [{
+    key: getSectionOverflowItemKey(section.key),
+    type: 'menu-item',
+    parents: [{
+      key: section.key,
+      type: section.type,
+      rank: CATEGORY_VIEW_MORE_RANK
+    }],
+    component: () => /*#__PURE__*/React.createElement(QuickInsertSectionOverflowMenuItem, {
+      api,
+      category: section.key
+    })
+  }] : [])]), ...(includeElementBrowserItems ? [{
     key: getMenuFooterSectionKey(MENU.key),
     type: 'menu-section',
-    rank: 100
-  }],
-  component: () => /*#__PURE__*/React.createElement(QuickInsertMenuFooterItem, {
-    api
-  })
-}] : [])];
+    parents: [{
+      key: MENU.key,
+      type: MENU.type,
+      rank: Number.MAX_SAFE_INTEGER
+    }]
+  }, {
+    key: VIEW_ALL_ELEMENTS_MENU_ITEM.key,
+    type: VIEW_ALL_ELEMENTS_MENU_ITEM.type,
+    parents: [{
+      key: getMenuFooterSectionKey(MENU.key),
+      type: 'menu-section',
+      rank: 100
+    }],
+    component: () => /*#__PURE__*/React.createElement(QuickInsertMenuFooterItem, {
+      api
+    })
+  }] : [])];
+};

package/dist/es2019/ui/getRecommendedComponents.js

@@ -0,0 +1,74 @@
+import { MENU } from '@atlaskit/editor-common/quick-insert/keys';
+import { isMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-is-menu-footer-section-key';
+import { isSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-is-section-overflow-item-key';
+import { defaultIsRecommendedItem } from '@atlaskit/editor-common/quick-insert/is-recommended-item';
+import { logException } from '@atlaskit/editor-common/monitoring';
+import { TYPE_AHEAD_SURFACE_CONTEXT } from '@atlaskit/editor-common/type-ahead-surface-context';
+export const MAX_RECOMMENDED_ITEMS = 5;
+export const RECOMMENDED_SLOT_KEY_PREFIX = 'quick-insert-recommended-slot-';
+export const isRecommendedSlotKey = key => key.startsWith(RECOMMENDED_SLOT_KEY_PREFIX);
+const isRecommendationCandidate = component => component.type === 'menu-item' && !isRecommendedSlotKey(component.key) && !isSectionOverflowItemKey(component.key) && !component.parents.some(parent => isMenuFooterSectionKey(parent.key));
+export const getRecommendedComponents = ({
+  components,
+  context,
+  isRecommendedItem = defaultIsRecommendedItem
+}) => {
+  return components.filter(isRecommendationCandidate).flatMap((component, index) => {
+    var _component$isHidden;
+    const result = isRecommendedItem({
+      itemKey: component.key
+    });
+    if (result === null) {
+      return [];
+    }
+    if (Number.isNaN(result)) {
+      void logException(new Error('Invalid Quick Insert recommended item rank'), {
+        location: 'editor-plugin-quick-insert/getRecommendedComponents'
+      });
+      return [];
+    }
+    if ((_component$isHidden = component.isHidden) !== null && _component$isHidden !== void 0 && _component$isHidden.call(component, {
+      surfaceContext: context
+    })) {
+      return [];
+    }
+    return [{
+      component,
+      index,
+      rank: result
+    }];
+  }).sort((first, second) => first.rank === second.rank ? first.index - second.index : first.rank - second.rank).slice(0, MAX_RECOMMENDED_ITEMS).map(({
+    component
+  }) => component);
+};
+
+/** Keeps only the current menu-open recommendation snapshot. */
+
+export const createRecommendedSnapshotCache = ({
+  api,
+  isRecommendedItem
+}) => {
+  let snapshot;
+  const getSnapshot = surfaceContext => {
+    var _surfaceContext$get, _snapshot;
+    const menuOpenId = surfaceContext === null || surfaceContext === void 0 ? void 0 : (_surfaceContext$get = surfaceContext.get(TYPE_AHEAD_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 ? void 0 : (_api$uiControlRegistr2 = api.uiControlRegistry) === null || _api$uiControlRegistr2 === void 0 ? void 0 : _api$uiControlRegistr2.actions.getComponents(MENU.key)) !== null && _api$uiControlRegistr !== void 0 ? _api$uiControlRegistr : [],
+          context: surfaceContext,
+          isRecommendedItem
+        })
+      };
+    }
+    return snapshot.items;
+  };
+  return {
+    getSnapshot
+  };
+};

package/dist/esm/quickInsertPlugin.js

@@ -92,7 +92,8 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
     var _api$uiControlRegistr;
     api === null || api === void 0 || (_api$uiControlRegistr = api.uiControlRegistry) === null || _api$uiControlRegistr === void 0 || _api$uiControlRegistr.actions.register(getQuickInsertComponents({
       api: api,
-      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true
+      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true,
+      isRecommendedItem: options === null || options === void 0 ? void 0 : options.isRecommendedItem
     }));
   }
   var openElementBrowser = function openElementBrowser(options) {

package/dist/esm/ui/QuickInsertRecommendedSlot.js

@@ -0,0 +1,13 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["index", "getSnapshot"];
+import React from 'react';
+import { useQuickInsertContext } from '@atlaskit/editor-common/quick-insert/use-quick-insert-context';
+export var QuickInsertRecommendedSlot = function QuickInsertRecommendedSlot(_ref) {
+  var index = _ref.index,
+    getSnapshot = _ref.getSnapshot,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _useQuickInsertContex = useQuickInsertContext(),
+    surfaceContext = _useQuickInsertContex.surfaceContext;
+  var item = getSnapshot(surfaceContext)[index];
+  return item !== null && item !== void 0 && item.component ? /*#__PURE__*/React.createElement(item.component, props) : null;
+};

package/dist/esm/ui/getQuickInsertComponents.js

@@ -1,4 +1,7 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
 import React from 'react';
 import { useIntl } from 'react-intl';
 import { BLOCK_TEMPLATES_SECTION, DATA_AND_CHARTS_SECTION, EMBED_SECTION, MEDIA_SECTION, MENU, OTHER_SECTION, RECOMMENDED_SECTION, ROVO_SECTION, STRUCTURE_SECTION, TEXT_FORMATTING_SECTION, VIEW_ALL_ELEMENTS_MENU_ITEM } from '@atlaskit/editor-common/quick-insert/keys';
@@ -9,7 +12,9 @@ import { CATEGORY_VIEW_MORE_RANK, QUICK_INSERT_MENU_RANK } from '@atlaskit/edito
 import { getMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-get-menu-footer-section-key';
 import { getSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-get-section-overflow-item-key';
 import { QuickInsertMenuFooterItem } from './QuickInsertMenuFooterItem';
+import { QuickInsertRecommendedSlot } from './QuickInsertRecommendedSlot';
 import { QuickInsertSectionOverflowMenuItem } from './QuickInsertSectionOverflowMenuItem';
+import { createRecommendedSnapshotCache, MAX_RECOMMENDED_ITEMS, RECOMMENDED_SLOT_KEY_PREFIX } from './getRecommendedComponents';
 var categories = [{
   message: messages.categoryRecommended,
   section: RECOMMENDED_SECTION
@@ -51,14 +56,46 @@ var createSectionComponent = function createSectionComponent(message) {
 };
 export var getQuickInsertComponents = function getQuickInsertComponents(_ref2) {
   var api = _ref2.api,
-    includeElementBrowserItems = _ref2.includeElementBrowserItems;
+    includeElementBrowserItems = _ref2.includeElementBrowserItems,
+    isRecommendedItem = _ref2.isRecommendedItem;
+  var recommendedSnapshot = createRecommendedSnapshotCache({
+    api: api,
+    isRecommendedItem: isRecommendedItem
+  });
+  var recommendedSlots = Array.from({
+    length: MAX_RECOMMENDED_ITEMS
+  }, function (_, index) {
+    return {
+      key: "".concat(RECOMMENDED_SLOT_KEY_PREFIX).concat(index),
+      type: 'menu-item',
+      parents: [{
+        key: RECOMMENDED_SECTION.key,
+        type: 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(props) {
+        return /*#__PURE__*/React.createElement(QuickInsertRecommendedSlot, _objectSpread(_objectSpread({}, props), {}, {
+          index: index,
+          getSnapshot: recommendedSnapshot.getSnapshot
+        }));
+      }
+    };
+  });
   return [{
     key: MENU.key,
     type: MENU.type,
     component: QuickInsertMenuRoot
-  }].concat(_toConsumableArray(categories.flatMap(function (_ref3) {
-    var message = _ref3.message,
-      section = _ref3.section;
+  }].concat(recommendedSlots, _toConsumableArray(categories.flatMap(function (_ref4) {
+    var message = _ref4.message,
+      section = _ref4.section;
     return [{
       key: section.key,
       type: section.type,
@@ -67,8 +104,13 @@ export var getQuickInsertComponents = function getQuickInsertComponents(_ref2) {
         type: MENU.type,
         rank: QUICK_INSERT_MENU_RANK[section.key]
       }],
-      component: createSectionComponent(message)
-    }].concat(_toConsumableArray(includeElementBrowserItems ? [{
+      component: createSectionComponent(message),
+      isHidden: section.key === RECOMMENDED_SECTION.key ? function () {
+        var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+          surfaceContext = _ref5.surfaceContext;
+        return recommendedSnapshot.getSnapshot(surfaceContext).length === 0;
+      } : undefined
+    }].concat(_toConsumableArray(includeElementBrowserItems && section.key !== RECOMMENDED_SECTION.key ? [{
       key: getSectionOverflowItemKey(section.key),
       type: 'menu-item',
       parents: [{

package/dist/esm/ui/getRecommendedComponents.js

@@ -0,0 +1,82 @@
+import { MENU } from '@atlaskit/editor-common/quick-insert/keys';
+import { isMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-is-menu-footer-section-key';
+import { isSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-is-section-overflow-item-key';
+import { defaultIsRecommendedItem } from '@atlaskit/editor-common/quick-insert/is-recommended-item';
+import { logException } from '@atlaskit/editor-common/monitoring';
+import { TYPE_AHEAD_SURFACE_CONTEXT } from '@atlaskit/editor-common/type-ahead-surface-context';
+export var MAX_RECOMMENDED_ITEMS = 5;
+export var RECOMMENDED_SLOT_KEY_PREFIX = 'quick-insert-recommended-slot-';
+export var isRecommendedSlotKey = function isRecommendedSlotKey(key) {
+  return key.startsWith(RECOMMENDED_SLOT_KEY_PREFIX);
+};
+var isRecommendationCandidate = function isRecommendationCandidate(component) {
+  return component.type === 'menu-item' && !isRecommendedSlotKey(component.key) && !isSectionOverflowItemKey(component.key) && !component.parents.some(function (parent) {
+    return isMenuFooterSectionKey(parent.key);
+  });
+};
+export var getRecommendedComponents = function getRecommendedComponents(_ref) {
+  var components = _ref.components,
+    context = _ref.context,
+    _ref$isRecommendedIte = _ref.isRecommendedItem,
+    isRecommendedItem = _ref$isRecommendedIte === void 0 ? defaultIsRecommendedItem : _ref$isRecommendedIte;
+  return components.filter(isRecommendationCandidate).flatMap(function (component, index) {
+    var _component$isHidden;
+    var result = isRecommendedItem({
+      itemKey: component.key
+    });
+    if (result === null) {
+      return [];
+    }
+    if (Number.isNaN(result)) {
+      void logException(new Error('Invalid Quick Insert recommended item rank'), {
+        location: 'editor-plugin-quick-insert/getRecommendedComponents'
+      });
+      return [];
+    }
+    if ((_component$isHidden = component.isHidden) !== null && _component$isHidden !== void 0 && _component$isHidden.call(component, {
+      surfaceContext: context
+    })) {
+      return [];
+    }
+    return [{
+      component: component,
+      index: index,
+      rank: result
+    }];
+  }).sort(function (first, second) {
+    return first.rank === second.rank ? first.index - second.index : first.rank - second.rank;
+  }).slice(0, MAX_RECOMMENDED_ITEMS).map(function (_ref2) {
+    var component = _ref2.component;
+    return component;
+  });
+};
+
+/** Keeps only the current menu-open recommendation snapshot. */
+
+export var createRecommendedSnapshotCache = function createRecommendedSnapshotCache(_ref3) {
+  var api = _ref3.api,
+    isRecommendedItem = _ref3.isRecommendedItem;
+  var snapshot;
+  var getSnapshot = function getSnapshot(surfaceContext) {
+    var _surfaceContext$get, _snapshot;
+    var menuOpenId = surfaceContext === null || surfaceContext === void 0 || (_surfaceContext$get = surfaceContext.get(TYPE_AHEAD_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(MENU.key)) !== null && _api$uiControlRegistr !== void 0 ? _api$uiControlRegistr : [],
+          context: surfaceContext,
+          isRecommendedItem: isRecommendedItem
+        })
+      };
+    }
+    return snapshot.items;
+  };
+  return {
+    getSnapshot: getSnapshot
+  };
+};

package/dist/types/ui/QuickInsertRecommendedSlot.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { RegisterMenuItem, SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
+type Props = Record<string, unknown> & {
+    getSnapshot: (surfaceContext?: SurfaceContext) => RegisterMenuItem[];
+    index: number;
+};
+export declare const QuickInsertRecommendedSlot: ({ index, getSnapshot, ...props }: Props) => React.ReactNode;
+export {};

package/dist/types/ui/getQuickInsertComponents.d.ts

@@ -1,9 +1,11 @@
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { RegisterComponent } from '@atlaskit/editor-ui-control-model/types';
+import type { IsRecommendedItem } from '@atlaskit/editor-common/quick-insert/is-recommended-item';
 import type { QuickInsertPlugin } from '../quickInsertPluginType';
 type Params = {
     api: ExtractInjectionAPI<QuickInsertPlugin> | undefined;
     includeElementBrowserItems: boolean;
+    isRecommendedItem?: IsRecommendedItem;
 };
-export declare const getQuickInsertComponents: ({ api, includeElementBrowserItems, }: Params) => RegisterComponent[];
+export declare const getQuickInsertComponents: ({ api, includeElementBrowserItems, isRecommendedItem, }: Params) => RegisterComponent[];
 export {};

package/dist/types/ui/getRecommendedComponents.d.ts

@@ -0,0 +1,21 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type IsRecommendedItem } from '@atlaskit/editor-common/quick-insert/is-recommended-item';
+import type { RegisterComponent, RegisterMenuItem, SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
+import type { QuickInsertPlugin } from '../quickInsertPluginType';
+export declare const MAX_RECOMMENDED_ITEMS = 5;
+export declare const RECOMMENDED_SLOT_KEY_PREFIX = "quick-insert-recommended-slot-";
+export declare const isRecommendedSlotKey: (key: string) => boolean;
+export declare const getRecommendedComponents: ({ components, context, isRecommendedItem, }: {
+    components: RegisterComponent[];
+    context: SurfaceContext;
+    isRecommendedItem?: IsRecommendedItem;
+}) => RegisterMenuItem[];
+/** Keeps only the current menu-open recommendation snapshot. */
+type RecommendedSnapshotCache = {
+    getSnapshot: (surfaceContext?: SurfaceContext) => RegisterMenuItem[];
+};
+export declare const createRecommendedSnapshotCache: ({ api, isRecommendedItem, }: {
+    api: ExtractInjectionAPI<QuickInsertPlugin> | undefined;
+    isRecommendedItem?: IsRecommendedItem;
+}) => RecommendedSnapshotCache;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "15.0.10",
+	"version": "15.1.0",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,7 +28,7 @@
 		"@atlaskit/editor-plugin-type-ahead": "^16.1.0",
 		"@atlaskit/editor-plugin-ui-control-registry": "^9.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
-		"@atlaskit/editor-ui-control-model": "^2.7.0",
+		"@atlaskit/editor-ui-control-model": "^2.8.0",
 		"@atlaskit/icon": "^37.5.0",
 		"@atlaskit/modal-dialog": "^16.5.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
@@ -39,7 +39,7 @@
 		"@emotion/react": "^11.7.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.13.0",
+		"@atlaskit/editor-common": "^119.14.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"