@atlaskit/editor-plugin-quick-insert 10.4.2 → 10.4.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 10.4.4
+
+### Patch Changes
+
+- [`bc59bccc2fc5c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bc59bccc2fc5c) -
+  Reorder advanced layout quick insert suggestions
+- Updated dependencies
+
+## 10.4.3
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.4.2
 
 ### Patch Changes

package/dist/cjs/quickInsertPlugin.js

@@ -34,6 +34,7 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
     var _options$onInsert;
     options === null || options === void 0 || (_options$onInsert = options.onInsert) === null || _options$onInsert === void 0 || _options$onInsert.call(options, item);
   };
+  var typeAheadPrioritySortingFn = (0, _expValEquals.expValEquals)('platform_editor_layout_typeahead_reorder', 'isEnabled', true) ? (0, _search.withLayoutQuickInsertPrioritySorting)(options === null || options === void 0 ? void 0 : options.prioritySortingFn) : options === null || options === void 0 ? void 0 : options.prioritySortingFn;
   var typeAhead = {
     id: _typeAhead.TypeAheadAvailableNodes.QUICK_INSERT,
     trigger: '/',
@@ -42,13 +43,14 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
       var query = _ref2.query,
         editorState = _ref2.editorState;
       var quickInsertState = _pluginKey.pluginKey.getState(editorState);
-      return Promise.resolve((0, _search.getQuickInsertSuggestions)({
+      var items = (0, _search.getQuickInsertSuggestions)({
         query: query,
         disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
-        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn,
+        prioritySortingFn: typeAheadPrioritySortingFn,
         // EDITOR-6558: pass through consumer-supplied filter (e.g. Markdown Mode allowlist)
         itemFilter: options === null || options === void 0 ? void 0 : options.itemFilter
-      }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
+      }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems);
+      return Promise.resolve(items);
     },
     getEmptyItem: function getEmptyItem(_ref3) {
       var editorState = _ref3.editorState;
@@ -165,7 +167,12 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
         var _ref7 = (_api$quickInsert$shar = api === null || api === void 0 || (_api$quickInsert = api.quickInsert) === null || _api$quickInsert === void 0 ? void 0 : _api$quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {},
           lazyDefaultItems = _ref7.lazyDefaultItems,
           providedItems = _ref7.providedItems;
-        if (options !== null && options !== void 0 && options.prioritySortingFn) {
+        if ((0, _expValEquals.expValEquals)('platform_editor_layout_typeahead_reorder', 'isEnabled', true)) {
+          var _options$prioritySort;
+          searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
+            prioritySortingFn: (0, _search.withLayoutQuickInsertPrioritySorting)((_options$prioritySort = options === null || options === void 0 ? void 0 : options.prioritySortingFn) !== null && _options$prioritySort !== void 0 ? _options$prioritySort : searchOptions.prioritySortingFn)
+          });
+        } else if (options !== null && options !== void 0 && options.prioritySortingFn) {
           searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
             prioritySortingFn: options.prioritySortingFn
           });

package/dist/cjs/ui/search.js

@@ -4,11 +4,44 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getQuickInsertSuggestions = void 0;
+exports.withLayoutQuickInsertPrioritySorting = exports.getQuickInsertSuggestions = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _quickInsert = require("@atlaskit/editor-common/quick-insert");
 var _utils = require("@atlaskit/editor-common/utils");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var isRegisteredLayoutQuickInsertItem = function isRegisteredLayoutQuickInsertItem(item) {
+  var _item$keywords, _item$keywords2;
+  return Boolean(item.id && item.id !== 'layout' && ((_item$keywords = item.keywords) === null || _item$keywords === void 0 ? void 0 : _item$keywords.includes('layout')) && ((_item$keywords2 = item.keywords) === null || _item$keywords2 === void 0 ? void 0 : _item$keywords2.includes('column')));
+};
+var getLayoutQuickInsertItemIdRank = function getLayoutQuickInsertItemIdRank(items) {
+  return new Map(items.filter(isRegisteredLayoutQuickInsertItem).map(function (item, index) {
+    return [item.id, index];
+  }));
+};
+var getQuickInsertItemId = function getQuickInsertItemId(items, result) {
+  var _items$result$idx;
+  return (_items$result$idx = items[result.idx]) === null || _items$result$idx === void 0 ? void 0 : _items$result$idx.id;
+};
+var withLayoutQuickInsertPrioritySorting = exports.withLayoutQuickInsertPrioritySorting = function withLayoutQuickInsertPrioritySorting(prioritySortingFn) {
+  return function (items) {
+    var consumerSortFn = prioritySortingFn === null || prioritySortingFn === void 0 ? void 0 : prioritySortingFn(items);
+    var layoutItemIdRank = getLayoutQuickInsertItemIdRank(items);
+    if (layoutItemIdRank.size < 2) {
+      return consumerSortFn;
+    }
+    return function (firstItem, secondItem) {
+      var firstLayoutItemRank = layoutItemIdRank.get(getQuickInsertItemId(items, firstItem));
+      var secondLayoutItemRank = layoutItemIdRank.get(getQuickInsertItemId(items, secondItem));
+      if (firstLayoutItemRank !== undefined && secondLayoutItemRank !== undefined) {
+        return firstLayoutItemRank - secondLayoutItemRank;
+      }
+      if (consumerSortFn) {
+        return consumerSortFn(firstItem, secondItem);
+      }
+      return firstItem.score === secondItem.score ? firstItem.idx < secondItem.idx ? -1 : 1 : firstItem.score < secondItem.score ? -1 : 1;
+    };
+  };
+};
 var getQuickInsertSuggestions = exports.getQuickInsertSuggestions = function getQuickInsertSuggestions(searchOptions) {
   var lazyDefaultItems = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function () {
     return [];

package/dist/es2019/quickInsertPlugin.js

@@ -12,7 +12,7 @@ import { createInsertItem, openElementBrowserModal } from './pm-plugins/commands
 import { getQuickInsertOpenExperiencePlugin } from './pm-plugins/experiences/quick-insert-open-experience';
 import { pluginKey } from './pm-plugins/plugin-key';
 import ModalElementBrowser from './ui/ModalElementBrowser';
-import { getQuickInsertSuggestions } from './ui/search';
+import { getQuickInsertSuggestions, withLayoutQuickInsertPrioritySorting } from './ui/search';
 export const quickInsertPlugin = ({
   config: options,
   api
@@ -22,6 +22,7 @@ export const quickInsertPlugin = ({
     var _options$onInsert;
     options === null || options === void 0 ? void 0 : (_options$onInsert = options.onInsert) === null || _options$onInsert === void 0 ? void 0 : _options$onInsert.call(options, item);
   };
+  const typeAheadPrioritySortingFn = expValEquals('platform_editor_layout_typeahead_reorder', 'isEnabled', true) ? withLayoutQuickInsertPrioritySorting(options === null || options === void 0 ? void 0 : options.prioritySortingFn) : options === null || options === void 0 ? void 0 : options.prioritySortingFn;
   const typeAhead = {
     id: TypeAheadAvailableNodes.QUICK_INSERT,
     trigger: '/',
@@ -31,13 +32,14 @@ export const quickInsertPlugin = ({
       editorState
     }) {
       const quickInsertState = pluginKey.getState(editorState);
-      return Promise.resolve(getQuickInsertSuggestions({
+      const items = getQuickInsertSuggestions({
         query: query,
         disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
-        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn,
+        prioritySortingFn: typeAheadPrioritySortingFn,
         // EDITOR-6558: pass through consumer-supplied filter (e.g. Markdown Mode allowlist)
         itemFilter: options === null || options === void 0 ? void 0 : options.itemFilter
-      }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
+      }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems);
+      return Promise.resolve(items);
     },
     getEmptyItem({
       editorState
@@ -155,7 +157,13 @@ export const quickInsertPlugin = ({
           lazyDefaultItems,
           providedItems
         } = (_api$quickInsert$shar = api === null || api === void 0 ? void 0 : (_api$quickInsert = api.quickInsert) === null || _api$quickInsert === void 0 ? void 0 : _api$quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {};
-        if (options !== null && options !== void 0 && options.prioritySortingFn) {
+        if (expValEquals('platform_editor_layout_typeahead_reorder', 'isEnabled', true)) {
+          var _options$prioritySort;
+          searchOptions = {
+            ...searchOptions,
+            prioritySortingFn: withLayoutQuickInsertPrioritySorting((_options$prioritySort = options === null || options === void 0 ? void 0 : options.prioritySortingFn) !== null && _options$prioritySort !== void 0 ? _options$prioritySort : searchOptions.prioritySortingFn)
+          };
+        } else if (options !== null && options !== void 0 && options.prioritySortingFn) {
           searchOptions = {
             ...searchOptions,
             prioritySortingFn: options.prioritySortingFn

package/dist/es2019/ui/search.js

@@ -1,6 +1,33 @@
 import { find } from '@atlaskit/editor-common/quick-insert';
 import { dedupe } from '@atlaskit/editor-common/utils';
 import { fg } from '@atlaskit/platform-feature-flags';
+const isRegisteredLayoutQuickInsertItem = item => {
+  var _item$keywords, _item$keywords2;
+  return Boolean(item.id && item.id !== 'layout' && ((_item$keywords = item.keywords) === null || _item$keywords === void 0 ? void 0 : _item$keywords.includes('layout')) && ((_item$keywords2 = item.keywords) === null || _item$keywords2 === void 0 ? void 0 : _item$keywords2.includes('column')));
+};
+const getLayoutQuickInsertItemIdRank = items => new Map(items.filter(isRegisteredLayoutQuickInsertItem).map((item, index) => [item.id, index]));
+const getQuickInsertItemId = (items, result) => {
+  var _items$result$idx;
+  return (_items$result$idx = items[result.idx]) === null || _items$result$idx === void 0 ? void 0 : _items$result$idx.id;
+};
+export const withLayoutQuickInsertPrioritySorting = prioritySortingFn => items => {
+  const consumerSortFn = prioritySortingFn === null || prioritySortingFn === void 0 ? void 0 : prioritySortingFn(items);
+  const layoutItemIdRank = getLayoutQuickInsertItemIdRank(items);
+  if (layoutItemIdRank.size < 2) {
+    return consumerSortFn;
+  }
+  return (firstItem, secondItem) => {
+    const firstLayoutItemRank = layoutItemIdRank.get(getQuickInsertItemId(items, firstItem));
+    const secondLayoutItemRank = layoutItemIdRank.get(getQuickInsertItemId(items, secondItem));
+    if (firstLayoutItemRank !== undefined && secondLayoutItemRank !== undefined) {
+      return firstLayoutItemRank - secondLayoutItemRank;
+    }
+    if (consumerSortFn) {
+      return consumerSortFn(firstItem, secondItem);
+    }
+    return firstItem.score === secondItem.score ? firstItem.idx < secondItem.idx ? -1 : 1 : firstItem.score < secondItem.score ? -1 : 1;
+  };
+};
 export const getQuickInsertSuggestions = (searchOptions, lazyDefaultItems = () => [], providedItems) => {
   // @ts-ignore
   const {

package/dist/esm/quickInsertPlugin.js

@@ -18,7 +18,7 @@ import { createInsertItem, openElementBrowserModal as _openElementBrowserModal }
 import { getQuickInsertOpenExperiencePlugin } from './pm-plugins/experiences/quick-insert-open-experience';
 import { pluginKey } from './pm-plugins/plugin-key';
 import ModalElementBrowser from './ui/ModalElementBrowser';
-import { getQuickInsertSuggestions } from './ui/search';
+import { getQuickInsertSuggestions, withLayoutQuickInsertPrioritySorting } from './ui/search';
 export var quickInsertPlugin = function quickInsertPlugin(_ref) {
   var options = _ref.config,
     api = _ref.api;
@@ -27,6 +27,7 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
     var _options$onInsert;
     options === null || options === void 0 || (_options$onInsert = options.onInsert) === null || _options$onInsert === void 0 || _options$onInsert.call(options, item);
   };
+  var typeAheadPrioritySortingFn = expValEquals('platform_editor_layout_typeahead_reorder', 'isEnabled', true) ? withLayoutQuickInsertPrioritySorting(options === null || options === void 0 ? void 0 : options.prioritySortingFn) : options === null || options === void 0 ? void 0 : options.prioritySortingFn;
   var typeAhead = {
     id: TypeAheadAvailableNodes.QUICK_INSERT,
     trigger: '/',
@@ -35,13 +36,14 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
       var query = _ref2.query,
         editorState = _ref2.editorState;
       var quickInsertState = pluginKey.getState(editorState);
-      return Promise.resolve(getQuickInsertSuggestions({
+      var items = getQuickInsertSuggestions({
         query: query,
         disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
-        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn,
+        prioritySortingFn: typeAheadPrioritySortingFn,
         // EDITOR-6558: pass through consumer-supplied filter (e.g. Markdown Mode allowlist)
         itemFilter: options === null || options === void 0 ? void 0 : options.itemFilter
-      }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
+      }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems);
+      return Promise.resolve(items);
     },
     getEmptyItem: function getEmptyItem(_ref3) {
       var editorState = _ref3.editorState;
@@ -158,7 +160,12 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
         var _ref7 = (_api$quickInsert$shar = api === null || api === void 0 || (_api$quickInsert = api.quickInsert) === null || _api$quickInsert === void 0 ? void 0 : _api$quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {},
           lazyDefaultItems = _ref7.lazyDefaultItems,
           providedItems = _ref7.providedItems;
-        if (options !== null && options !== void 0 && options.prioritySortingFn) {
+        if (expValEquals('platform_editor_layout_typeahead_reorder', 'isEnabled', true)) {
+          var _options$prioritySort;
+          searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
+            prioritySortingFn: withLayoutQuickInsertPrioritySorting((_options$prioritySort = options === null || options === void 0 ? void 0 : options.prioritySortingFn) !== null && _options$prioritySort !== void 0 ? _options$prioritySort : searchOptions.prioritySortingFn)
+          });
+        } else if (options !== null && options !== void 0 && options.prioritySortingFn) {
           searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
             prioritySortingFn: options.prioritySortingFn
           });

package/dist/esm/ui/search.js

@@ -2,6 +2,39 @@ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import { find } from '@atlaskit/editor-common/quick-insert';
 import { dedupe } from '@atlaskit/editor-common/utils';
 import { fg } from '@atlaskit/platform-feature-flags';
+var isRegisteredLayoutQuickInsertItem = function isRegisteredLayoutQuickInsertItem(item) {
+  var _item$keywords, _item$keywords2;
+  return Boolean(item.id && item.id !== 'layout' && ((_item$keywords = item.keywords) === null || _item$keywords === void 0 ? void 0 : _item$keywords.includes('layout')) && ((_item$keywords2 = item.keywords) === null || _item$keywords2 === void 0 ? void 0 : _item$keywords2.includes('column')));
+};
+var getLayoutQuickInsertItemIdRank = function getLayoutQuickInsertItemIdRank(items) {
+  return new Map(items.filter(isRegisteredLayoutQuickInsertItem).map(function (item, index) {
+    return [item.id, index];
+  }));
+};
+var getQuickInsertItemId = function getQuickInsertItemId(items, result) {
+  var _items$result$idx;
+  return (_items$result$idx = items[result.idx]) === null || _items$result$idx === void 0 ? void 0 : _items$result$idx.id;
+};
+export var withLayoutQuickInsertPrioritySorting = function withLayoutQuickInsertPrioritySorting(prioritySortingFn) {
+  return function (items) {
+    var consumerSortFn = prioritySortingFn === null || prioritySortingFn === void 0 ? void 0 : prioritySortingFn(items);
+    var layoutItemIdRank = getLayoutQuickInsertItemIdRank(items);
+    if (layoutItemIdRank.size < 2) {
+      return consumerSortFn;
+    }
+    return function (firstItem, secondItem) {
+      var firstLayoutItemRank = layoutItemIdRank.get(getQuickInsertItemId(items, firstItem));
+      var secondLayoutItemRank = layoutItemIdRank.get(getQuickInsertItemId(items, secondItem));
+      if (firstLayoutItemRank !== undefined && secondLayoutItemRank !== undefined) {
+        return firstLayoutItemRank - secondLayoutItemRank;
+      }
+      if (consumerSortFn) {
+        return consumerSortFn(firstItem, secondItem);
+      }
+      return firstItem.score === secondItem.score ? firstItem.idx < secondItem.idx ? -1 : 1 : firstItem.score < secondItem.score ? -1 : 1;
+    };
+  };
+};
 export var getQuickInsertSuggestions = function getQuickInsertSuggestions(searchOptions) {
   var lazyDefaultItems = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function () {
     return [];

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

@@ -1,5 +1,6 @@
 import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { QuickInsertSearchOptions } from '@atlaskit/editor-common/types';
 type GetQuickInsertSuggestions = (searchOptions: QuickInsertSearchOptions, lazyDefaultItems?: () => QuickInsertItem[], providedItems?: QuickInsertItem[]) => QuickInsertItem[];
+export declare const withLayoutQuickInsertPrioritySorting: (prioritySortingFn?: QuickInsertSearchOptions["prioritySortingFn"]) => QuickInsertSearchOptions["prioritySortingFn"];
 export declare const getQuickInsertSuggestions: GetQuickInsertSuggestions;
 export {};

package/dist/types-ts4.5/ui/search.d.ts

@@ -1,5 +1,6 @@
 import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { QuickInsertSearchOptions } from '@atlaskit/editor-common/types';
 type GetQuickInsertSuggestions = (searchOptions: QuickInsertSearchOptions, lazyDefaultItems?: () => QuickInsertItem[], providedItems?: QuickInsertItem[]) => QuickInsertItem[];
+export declare const withLayoutQuickInsertPrioritySorting: (prioritySortingFn?: QuickInsertSearchOptions["prioritySortingFn"]) => QuickInsertSearchOptions["prioritySortingFn"];
 export declare const getQuickInsertSuggestions: GetQuickInsertSuggestions;
 export {};

package/editor-plugin-quick-insert.docs.tsx

@@ -5,13 +5,14 @@
 
 import path from 'path';
 
-import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
 
 import packageJson from './package.json';
 
 const packagePath = path.resolve(__dirname);
 
-const documentation: ComponentStructuredContentSource[] = [
+const documentation: StructuredContentSource = {
+	components: [
 	{
 		name: 'Editor Plugin Quick Insert',
 		description: 'Quick insert plugin for @atlaskit/editor-core',
@@ -30,6 +31,7 @@ const documentation: ComponentStructuredContentSource[] = [
 		categories: ['editor'],
 		examples: [],
 	},
-];
+	],
+};
 
 export default documentation;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "10.4.2",
+	"version": "10.4.4",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,18 +33,18 @@
 		"@atlaskit/editor-plugin-analytics": "^10.1.0",
 		"@atlaskit/editor-plugin-connectivity": "^10.1.0",
 		"@atlaskit/editor-plugin-metrics": "^11.1.0",
-		"@atlaskit/editor-plugin-type-ahead": "^10.1.0",
+		"@atlaskit/editor-plugin-type-ahead": "^10.2.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/icon": "^35.0.0",
-		"@atlaskit/modal-dialog": "^15.0.0",
+		"@atlaskit/modal-dialog": "^15.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^81.1.0",
+		"@atlaskit/tmp-editor-statsig": "^82.5.0",
 		"@atlaskit/tokens": "^13.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.35.0",
+		"@atlaskit/editor-common": "^114.42.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
@@ -52,6 +52,8 @@
 	"devDependencies": {
 		"@atlassian/structured-docs-types": "workspace:^",
 		"@testing-library/react": "^16.3.0",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0",
 		"react-intl": "^6.6.2",
 		"wait-for-expect": "^1.2.0"
 	},