@atlaskit/editor-plugin-quick-insert 30.0.0 → 30.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 30.0.1
+
+### Patch Changes
+
+- [`f2e219b3ca00d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2e219b3ca00d) -
+  Rank slash command search results with matcher priority groups while retaining the current
+  ordering for items without a group. Recommended results for audited search terms, including Jira,
+  receive fixed scores in group 0 under platform_editor_slash_command. The Element Browser applies
+  the same priority groups to its search results. Menu item matchers now require the item's key in
+  their context; callers must pass the registration key.
+- Updated dependencies
+
 ## 30.0.0
 
 ### Minor Changes

package/dist/cjs/ui/RegistryElementBrowser/model.js

@@ -127,17 +127,31 @@ var getRegistryElementBrowserItems = exports.getRegistryElementBrowserItems = fu
   if (!normalizedQuery) {
     return itemsWithDescriptions;
   }
-  return itemsWithDescriptions.flatMap(function (item) {
+  var matches = itemsWithDescriptions.flatMap(function (item) {
     var _item$registration$ma, _item$registration;
     var result = (_item$registration$ma = (_item$registration = item.registration).match) === null || _item$registration$ma === void 0 ? void 0 : _item$registration$ma.call(_item$registration, {
       formatMessage: formatMessage,
+      itemKey: item.registration.key,
       query: normalizedQuery
     });
     return result ? [_objectSpread(_objectSpread({}, item), {}, {
+      priorityGroup: result.priorityGroup !== undefined && Number.isFinite(result.priorityGroup) ? result.priorityGroup : undefined,
       score: Math.min(1, Math.max(0, result.score))
     })] : [];
-  }).sort(function (left, right) {
+  });
+  var prioritized = matches.filter(function (_ref4) {
+    var priorityGroup = _ref4.priorityGroup;
+    return priorityGroup !== undefined;
+  });
+  var unprioritized = matches.filter(function (_ref5) {
+    var priorityGroup = _ref5.priorityGroup;
+    return priorityGroup === undefined;
+  });
+  return [].concat((0, _toConsumableArray2.default)(prioritized.sort(function (left, right) {
+    var _right$priorityGroup, _left$priorityGroup;
+    return ((_right$priorityGroup = right.priorityGroup) !== null && _right$priorityGroup !== void 0 ? _right$priorityGroup : 0) - ((_left$priorityGroup = left.priorityGroup) !== null && _left$priorityGroup !== void 0 ? _left$priorityGroup : 0) || left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
+  })), (0, _toConsumableArray2.default)(unprioritized.sort(function (left, right) {
     var _left$ranks$, _right$ranks$;
     return ((_left$ranks$ = left.ranks[0]) !== null && _left$ranks$ !== void 0 ? _left$ranks$ : 0) - ((_right$ranks$ = right.ranks[0]) !== null && _right$ranks$ !== void 0 ? _right$ranks$ : 0) || left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
-  });
+  })));
 };

package/dist/cjs/ui/registered-menu/get-quick-insert-menu-model.js

@@ -41,6 +41,10 @@ var compareMatchedItems = function compareMatchedItems(a, b) {
 var compareSearchResults = function compareSearchResults(a, b) {
   return a.score - b.score || a.sectionRank - b.sectionRank || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
 };
+var comparePrioritizedSearchResults = function comparePrioritizedSearchResults(a, b) {
+  var _b$priorityGroup, _a$priorityGroup;
+  return ((_b$priorityGroup = b.priorityGroup) !== null && _b$priorityGroup !== void 0 ? _b$priorityGroup : 0) - ((_a$priorityGroup = a.priorityGroup) !== null && _a$priorityGroup !== void 0 ? _a$priorityGroup : 0) || compareSearchResults(a, b);
+};
 var getSearchResults = function getSearchResults(matches) {
   var topMatches = Array.from(matches).sort(compareSearchResults).slice(0, SEARCH_TOP_MATCH_LIMIT);
   var topMatchIdentities = new Set(topMatches.map(function (_ref) {
@@ -129,6 +133,7 @@ var buildSearchSections = function buildSearchSections(_ref5) {
           }
           var match = (_item$match = item.match) === null || _item$match === void 0 ? void 0 : _item$match.call(item, {
             formatMessage: formatMessage,
+            itemKey: item.key,
             query: query
           });
           if (item.match && match === null) {
@@ -138,6 +143,7 @@ var buildSearchSections = function buildSearchSections(_ref5) {
             identity: "".concat(item.type, ":").concat(item.key),
             item: item,
             itemRank: getParentRank(item, section.key),
+            priorityGroup: (match === null || match === void 0 ? void 0 : match.priorityGroup) !== undefined && Number.isFinite(match.priorityGroup) ? match.priorityGroup : undefined,
             score: Math.min(1, Math.max(0, (_match$score = match === null || match === void 0 ? void 0 : match.score) !== null && _match$score !== void 0 ? _match$score : 0)),
             sourceIndex: (_sourceIndexByCompone = sourceIndexByComponent.get(item)) !== null && _sourceIndexByCompone !== void 0 ? _sourceIndexByCompone : Number.MAX_SAFE_INTEGER,
             sectionRank: getParentRank(section, root.key)
@@ -159,11 +165,22 @@ var buildSearchSections = function buildSearchSections(_ref5) {
     _iterator2.f();
   }
   var uniqueMatches = Array.from(matches.values()).sort(compareMatchedItems);
-  var searchResults = getSearchResults(uniqueMatches);
-  if (searchResults.length > 0) {
+  var prioritizedMatches = uniqueMatches.filter(function (_ref6) {
+    var priorityGroup = _ref6.priorityGroup;
+    return priorityGroup !== undefined;
+  });
+  var unprioritizedMatches = uniqueMatches.filter(function (_ref7) {
+    var priorityGroup = _ref7.priorityGroup;
+    return priorityGroup === undefined;
+  });
+  var orderedSearchResults = [].concat((0, _toConsumableArray2.default)(prioritizedMatches.sort(comparePrioritizedSearchResults).map(function (_ref8) {
+    var item = _ref8.item;
+    return item;
+  })), (0, _toConsumableArray2.default)(getSearchResults(unprioritizedMatches)));
+  if (orderedSearchResults.length > 0) {
     return {
       fallbackItems: [],
-      sections: [[SEARCH_RESULTS_HEADING].concat((0, _toConsumableArray2.default)(searchResults))]
+      sections: [[SEARCH_RESULTS_HEADING].concat((0, _toConsumableArray2.default)(orderedSearchResults))]
     };
   }
   var fallbackItem = contentSections.flatMap(function (section) {
@@ -182,14 +199,14 @@ var buildSearchSections = function buildSearchSections(_ref5) {
  * Builds the registered quick-insert menu model. An empty query browses every
  * category; a non-empty query returns ranked matches. The footer is shared by both.
  */
-var getQuickInsertMenuModel = exports.getQuickInsertMenuModel = function getQuickInsertMenuModel(_ref6) {
-  var components = _ref6.components,
-    formatMessage = _ref6.formatMessage,
-    getItemRank = _ref6.getItemRank,
-    query = _ref6.query,
-    rootComponent = _ref6.rootComponent,
-    selectCategoryItems = _ref6.selectCategoryItems,
-    surfaceContext = _ref6.surfaceContext;
+var getQuickInsertMenuModel = exports.getQuickInsertMenuModel = function getQuickInsertMenuModel(_ref9) {
+  var components = _ref9.components,
+    formatMessage = _ref9.formatMessage,
+    getItemRank = _ref9.getItemRank,
+    query = _ref9.query,
+    rootComponent = _ref9.rootComponent,
+    selectCategoryItems = _ref9.selectCategoryItems,
+    surfaceContext = _ref9.surfaceContext;
   var rankedComponents = (0, _itemRank.applyRegisteredItemRanks)(components, getItemRank);
   var _resolveSurface = (0, _surfaceRenderer.resolveSurface)(rankedComponents, rootComponent),
     childrenMap = _resolveSurface.childrenMap,
@@ -207,12 +224,12 @@ var getQuickInsertMenuModel = exports.getQuickInsertMenuModel = function getQuic
   var renderedSections = topLevelChildren.filter(function (section) {
     return section.type === 'menu-section' && (0, _surfaceRenderer.willComponentRender)(section, childrenMap, surfaceContext);
   });
-  var footerSection = renderedSections.find(function (_ref7) {
-    var key = _ref7.key;
+  var footerSection = renderedSections.find(function (_ref0) {
+    var key = _ref0.key;
     return (0, _typeAheadIsMenuFooterSectionKey.isMenuFooterSectionKey)(key);
   });
-  var contentSections = renderedSections.filter(function (_ref8) {
-    var key = _ref8.key;
+  var contentSections = renderedSections.filter(function (_ref1) {
+    var key = _ref1.key;
     return !(0, _typeAheadIsMenuFooterSectionKey.isMenuFooterSectionKey)(key);
   });
   var content = query === '' ? buildBrowseSections({

package/dist/es2019/ui/RegistryElementBrowser/model.js

@@ -96,18 +96,30 @@ export const getRegistryElementBrowserItems = ({
   if (!normalizedQuery) {
     return itemsWithDescriptions;
   }
-  return itemsWithDescriptions.flatMap(item => {
+  const matches = itemsWithDescriptions.flatMap(item => {
     var _item$registration$ma, _item$registration;
     const result = (_item$registration$ma = (_item$registration = item.registration).match) === null || _item$registration$ma === void 0 ? void 0 : _item$registration$ma.call(_item$registration, {
       formatMessage,
+      itemKey: item.registration.key,
       query: normalizedQuery
     });
     return result ? [{
       ...item,
+      priorityGroup: result.priorityGroup !== undefined && Number.isFinite(result.priorityGroup) ? result.priorityGroup : undefined,
       score: Math.min(1, Math.max(0, result.score))
     }] : [];
-  }).sort((left, right) => {
+  });
+  const prioritized = matches.filter(({
+    priorityGroup
+  }) => priorityGroup !== undefined);
+  const unprioritized = matches.filter(({
+    priorityGroup
+  }) => priorityGroup === undefined);
+  return [...prioritized.sort((left, right) => {
+    var _right$priorityGroup, _left$priorityGroup;
+    return ((_right$priorityGroup = right.priorityGroup) !== null && _right$priorityGroup !== void 0 ? _right$priorityGroup : 0) - ((_left$priorityGroup = left.priorityGroup) !== null && _left$priorityGroup !== void 0 ? _left$priorityGroup : 0) || left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
+  }), ...unprioritized.sort((left, right) => {
     var _left$ranks$, _right$ranks$;
     return ((_left$ranks$ = left.ranks[0]) !== null && _left$ranks$ !== void 0 ? _left$ranks$ : 0) - ((_right$ranks$ = right.ranks[0]) !== null && _right$ranks$ !== void 0 ? _right$ranks$ : 0) || left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
-  });
+  })];
 };

package/dist/es2019/ui/registered-menu/get-quick-insert-menu-model.js

@@ -21,6 +21,10 @@ const getParentRank = (component, parentKey) => {
 };
 const compareMatchedItems = (a, b) => a.sectionRank - b.sectionRank || a.score - b.score || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
 const compareSearchResults = (a, b) => a.score - b.score || a.sectionRank - b.sectionRank || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
+const comparePrioritizedSearchResults = (a, b) => {
+  var _b$priorityGroup, _a$priorityGroup;
+  return ((_b$priorityGroup = b.priorityGroup) !== null && _b$priorityGroup !== void 0 ? _b$priorityGroup : 0) - ((_a$priorityGroup = a.priorityGroup) !== null && _a$priorityGroup !== void 0 ? _a$priorityGroup : 0) || compareSearchResults(a, b);
+};
 const getSearchResults = matches => {
   const topMatches = Array.from(matches).sort(compareSearchResults).slice(0, SEARCH_TOP_MATCH_LIMIT);
   const topMatchIdentities = new Set(topMatches.map(({
@@ -83,6 +87,7 @@ const buildSearchSections = ({
       }
       const match = (_item$match = item.match) === null || _item$match === void 0 ? void 0 : _item$match.call(item, {
         formatMessage,
+        itemKey: item.key,
         query
       });
       if (item.match && match === null) {
@@ -92,6 +97,7 @@ const buildSearchSections = ({
         identity: `${item.type}:${item.key}`,
         item,
         itemRank: getParentRank(item, section.key),
+        priorityGroup: (match === null || match === void 0 ? void 0 : match.priorityGroup) !== undefined && Number.isFinite(match.priorityGroup) ? match.priorityGroup : undefined,
         score: Math.min(1, Math.max(0, (_match$score = match === null || match === void 0 ? void 0 : match.score) !== null && _match$score !== void 0 ? _match$score : 0)),
         sourceIndex: (_sourceIndexByCompone = sourceIndexByComponent.get(item)) !== null && _sourceIndexByCompone !== void 0 ? _sourceIndexByCompone : Number.MAX_SAFE_INTEGER,
         sectionRank: getParentRank(section, root.key)
@@ -103,11 +109,19 @@ const buildSearchSections = ({
     }
   }
   const uniqueMatches = Array.from(matches.values()).sort(compareMatchedItems);
-  const searchResults = getSearchResults(uniqueMatches);
-  if (searchResults.length > 0) {
+  const prioritizedMatches = uniqueMatches.filter(({
+    priorityGroup
+  }) => priorityGroup !== undefined);
+  const unprioritizedMatches = uniqueMatches.filter(({
+    priorityGroup
+  }) => priorityGroup === undefined);
+  const orderedSearchResults = [...prioritizedMatches.sort(comparePrioritizedSearchResults).map(({
+    item
+  }) => item), ...getSearchResults(unprioritizedMatches)];
+  if (orderedSearchResults.length > 0) {
     return {
       fallbackItems: [],
-      sections: [[SEARCH_RESULTS_HEADING, ...searchResults]]
+      sections: [[SEARCH_RESULTS_HEADING, ...orderedSearchResults]]
     };
   }
   const fallbackItem = contentSections.flatMap(section => {

package/dist/esm/ui/RegistryElementBrowser/model.js

@@ -120,17 +120,31 @@ export var getRegistryElementBrowserItems = function getRegistryElementBrowserIt
   if (!normalizedQuery) {
     return itemsWithDescriptions;
   }
-  return itemsWithDescriptions.flatMap(function (item) {
+  var matches = itemsWithDescriptions.flatMap(function (item) {
     var _item$registration$ma, _item$registration;
     var result = (_item$registration$ma = (_item$registration = item.registration).match) === null || _item$registration$ma === void 0 ? void 0 : _item$registration$ma.call(_item$registration, {
       formatMessage: formatMessage,
+      itemKey: item.registration.key,
       query: normalizedQuery
     });
     return result ? [_objectSpread(_objectSpread({}, item), {}, {
+      priorityGroup: result.priorityGroup !== undefined && Number.isFinite(result.priorityGroup) ? result.priorityGroup : undefined,
       score: Math.min(1, Math.max(0, result.score))
     })] : [];
-  }).sort(function (left, right) {
+  });
+  var prioritized = matches.filter(function (_ref4) {
+    var priorityGroup = _ref4.priorityGroup;
+    return priorityGroup !== undefined;
+  });
+  var unprioritized = matches.filter(function (_ref5) {
+    var priorityGroup = _ref5.priorityGroup;
+    return priorityGroup === undefined;
+  });
+  return [].concat(_toConsumableArray(prioritized.sort(function (left, right) {
+    var _right$priorityGroup, _left$priorityGroup;
+    return ((_right$priorityGroup = right.priorityGroup) !== null && _right$priorityGroup !== void 0 ? _right$priorityGroup : 0) - ((_left$priorityGroup = left.priorityGroup) !== null && _left$priorityGroup !== void 0 ? _left$priorityGroup : 0) || left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
+  })), _toConsumableArray(unprioritized.sort(function (left, right) {
     var _left$ranks$, _right$ranks$;
     return ((_left$ranks$ = left.ranks[0]) !== null && _left$ranks$ !== void 0 ? _left$ranks$ : 0) - ((_right$ranks$ = right.ranks[0]) !== null && _right$ranks$ !== void 0 ? _right$ranks$ : 0) || left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
-  });
+  })));
 };

package/dist/esm/ui/registered-menu/get-quick-insert-menu-model.js

@@ -34,6 +34,10 @@ var compareMatchedItems = function compareMatchedItems(a, b) {
 var compareSearchResults = function compareSearchResults(a, b) {
   return a.score - b.score || a.sectionRank - b.sectionRank || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
 };
+var comparePrioritizedSearchResults = function comparePrioritizedSearchResults(a, b) {
+  var _b$priorityGroup, _a$priorityGroup;
+  return ((_b$priorityGroup = b.priorityGroup) !== null && _b$priorityGroup !== void 0 ? _b$priorityGroup : 0) - ((_a$priorityGroup = a.priorityGroup) !== null && _a$priorityGroup !== void 0 ? _a$priorityGroup : 0) || compareSearchResults(a, b);
+};
 var getSearchResults = function getSearchResults(matches) {
   var topMatches = Array.from(matches).sort(compareSearchResults).slice(0, SEARCH_TOP_MATCH_LIMIT);
   var topMatchIdentities = new Set(topMatches.map(function (_ref) {
@@ -122,6 +126,7 @@ var buildSearchSections = function buildSearchSections(_ref5) {
           }
           var match = (_item$match = item.match) === null || _item$match === void 0 ? void 0 : _item$match.call(item, {
             formatMessage: formatMessage,
+            itemKey: item.key,
             query: query
           });
           if (item.match && match === null) {
@@ -131,6 +136,7 @@ var buildSearchSections = function buildSearchSections(_ref5) {
             identity: "".concat(item.type, ":").concat(item.key),
             item: item,
             itemRank: getParentRank(item, section.key),
+            priorityGroup: (match === null || match === void 0 ? void 0 : match.priorityGroup) !== undefined && Number.isFinite(match.priorityGroup) ? match.priorityGroup : undefined,
             score: Math.min(1, Math.max(0, (_match$score = match === null || match === void 0 ? void 0 : match.score) !== null && _match$score !== void 0 ? _match$score : 0)),
             sourceIndex: (_sourceIndexByCompone = sourceIndexByComponent.get(item)) !== null && _sourceIndexByCompone !== void 0 ? _sourceIndexByCompone : Number.MAX_SAFE_INTEGER,
             sectionRank: getParentRank(section, root.key)
@@ -152,11 +158,22 @@ var buildSearchSections = function buildSearchSections(_ref5) {
     _iterator2.f();
   }
   var uniqueMatches = Array.from(matches.values()).sort(compareMatchedItems);
-  var searchResults = getSearchResults(uniqueMatches);
-  if (searchResults.length > 0) {
+  var prioritizedMatches = uniqueMatches.filter(function (_ref6) {
+    var priorityGroup = _ref6.priorityGroup;
+    return priorityGroup !== undefined;
+  });
+  var unprioritizedMatches = uniqueMatches.filter(function (_ref7) {
+    var priorityGroup = _ref7.priorityGroup;
+    return priorityGroup === undefined;
+  });
+  var orderedSearchResults = [].concat(_toConsumableArray(prioritizedMatches.sort(comparePrioritizedSearchResults).map(function (_ref8) {
+    var item = _ref8.item;
+    return item;
+  })), _toConsumableArray(getSearchResults(unprioritizedMatches)));
+  if (orderedSearchResults.length > 0) {
     return {
       fallbackItems: [],
-      sections: [[SEARCH_RESULTS_HEADING].concat(_toConsumableArray(searchResults))]
+      sections: [[SEARCH_RESULTS_HEADING].concat(_toConsumableArray(orderedSearchResults))]
     };
   }
   var fallbackItem = contentSections.flatMap(function (section) {
@@ -175,14 +192,14 @@ var buildSearchSections = function buildSearchSections(_ref5) {
  * Builds the registered quick-insert menu model. An empty query browses every
  * category; a non-empty query returns ranked matches. The footer is shared by both.
  */
-export var getQuickInsertMenuModel = function getQuickInsertMenuModel(_ref6) {
-  var components = _ref6.components,
-    formatMessage = _ref6.formatMessage,
-    getItemRank = _ref6.getItemRank,
-    query = _ref6.query,
-    rootComponent = _ref6.rootComponent,
-    selectCategoryItems = _ref6.selectCategoryItems,
-    surfaceContext = _ref6.surfaceContext;
+export var getQuickInsertMenuModel = function getQuickInsertMenuModel(_ref9) {
+  var components = _ref9.components,
+    formatMessage = _ref9.formatMessage,
+    getItemRank = _ref9.getItemRank,
+    query = _ref9.query,
+    rootComponent = _ref9.rootComponent,
+    selectCategoryItems = _ref9.selectCategoryItems,
+    surfaceContext = _ref9.surfaceContext;
   var rankedComponents = applyRegisteredItemRanks(components, getItemRank);
   var _resolveSurface = resolveSurface(rankedComponents, rootComponent),
     childrenMap = _resolveSurface.childrenMap,
@@ -200,12 +217,12 @@ export var getQuickInsertMenuModel = function getQuickInsertMenuModel(_ref6) {
   var renderedSections = topLevelChildren.filter(function (section) {
     return section.type === 'menu-section' && willComponentRender(section, childrenMap, surfaceContext);
   });
-  var footerSection = renderedSections.find(function (_ref7) {
-    var key = _ref7.key;
+  var footerSection = renderedSections.find(function (_ref0) {
+    var key = _ref0.key;
     return isMenuFooterSectionKey(key);
   });
-  var contentSections = renderedSections.filter(function (_ref8) {
-    var key = _ref8.key;
+  var contentSections = renderedSections.filter(function (_ref1) {
+    var key = _ref1.key;
     return !isMenuFooterSectionKey(key);
   });
   var content = query === '' ? buildBrowseSections({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "30.0.0",
+	"version": "30.0.1",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -38,7 +38,7 @@
 		"@atlaskit/editor-prosemirror": "^9.0.0",
 		"@atlaskit/editor-shared-styles": "^4.6.0",
 		"@atlaskit/editor-tables": "^3.2.0",
-		"@atlaskit/editor-ui-control-model": "^2.10.0",
+		"@atlaskit/editor-ui-control-model": "^3.0.0",
 		"@atlaskit/heading": "^8.0.0",
 		"@atlaskit/icon": "^38.0.0",
 		"@atlaskit/menu": "^11.0.0",
@@ -47,7 +47,7 @@
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/primitives": "^22.6.0",
 		"@atlaskit/textfield": "^10.2.0",
-		"@atlaskit/tmp-editor-statsig": "^246.1.0",
+		"@atlaskit/tmp-editor-statsig": "^247.0.0",
 		"@atlaskit/tokens": "^20.8.0",
 		"@atlaskit/tooltip": "^24.4.0",
 		"@babel/runtime": "^7.0.0",