@atlaskit/editor-plugin-quick-insert 1.4.7 → 1.5.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 1.5.1
+
+### Patch Changes
+
+- [#155735](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/155735)
+  [`1beeeda29023a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1beeeda29023a) -
+  Upgrades editor packages to react 18
+- Updated dependencies
+
+## 1.5.0
+
+### Minor Changes
+
+- [#154398](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/154398)
+  [`ca1591355d790`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ca1591355d790) -
+  [ux] Allows for passing functions to the quickInsert plugin that allow for capturing element
+  insertion metrics and then using that data to change the element sort order
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.4.7
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -7,8 +7,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.quickInsertPlugin = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireDefault(require("react"));
 var _reactIntlNext = require("react-intl-next");
 var _quickInsert = require("@atlaskit/editor-common/quick-insert");
@@ -23,6 +23,10 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_ref) {
   var options = _ref.config,
     api = _ref.api;
+  var onInsert = function onInsert(item) {
+    var _options$onInsert;
+    options === null || options === void 0 || (_options$onInsert = options.onInsert) === null || _options$onInsert === void 0 || _options$onInsert.call(options, item);
+  };
   var typeAhead = {
     id: _typeAhead.TypeAheadAvailableNodes.QUICK_INSERT,
     trigger: '/',
@@ -33,11 +37,17 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
       var quickInsertState = _pluginKey.pluginKey.getState(editorState);
       return Promise.resolve((0, _search.getQuickInsertSuggestions)({
         query: query,
-        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
+        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
+        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn
       }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
     },
     selectItem: function selectItem(state, item, insert) {
-      return item.action(insert, state);
+      var quickInsertItem = item;
+      var result = quickInsertItem.action(insert, state);
+      if (result) {
+        onInsert(quickInsertItem);
+      }
+      return result;
     }
   };
   var intl;
@@ -99,8 +109,14 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
         var _ref5 = (_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 = _ref5.lazyDefaultItems,
           providedItems = _ref5.providedItems;
+        if (options !== null && options !== void 0 && options.prioritySortingFn) {
+          searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
+            prioritySortingFn: options.prioritySortingFn
+          });
+        }
         return (0, _search.getQuickInsertSuggestions)(searchOptions, lazyDefaultItems, providedItems);
-      }
+      },
+      onInsert: onInsert
     },
     commands: {
       openElementBrowserModal: _commands.openElementBrowserModal,

package/dist/cjs/search.js

@@ -18,7 +18,8 @@ var getQuickInsertSuggestions = exports.getQuickInsertSuggestions = function get
     category = searchOptions.category,
     disableDefaultItems = searchOptions.disableDefaultItems,
     featuredItems = searchOptions.featuredItems,
-    templateItems = searchOptions.templateItems;
+    templateItems = searchOptions.templateItems,
+    prioritySortingFn = searchOptions.prioritySortingFn;
   var defaultItems = disableDefaultItems ? [] : lazyDefaultItems();
   var items = providedItems ? (0, _utils.dedupe)([].concat((0, _toConsumableArray2.default)(defaultItems), (0, _toConsumableArray2.default)(providedItems)), function (item) {
     return item.title;
@@ -39,5 +40,5 @@ var getQuickInsertSuggestions = exports.getQuickInsertSuggestions = function get
   }
   return (0, _quickInsert.find)(query || '', category === 'all' || !category ? items : items.filter(function (item) {
     return item.categories && item.categories.includes(category);
-  }));
+  }), prioritySortingFn);
 };

package/dist/cjs/ui/ModalElementBrowser/index.js

@@ -16,7 +16,8 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 var Modal = function Modal(_ref) {
   var quickInsertState = _ref.quickInsertState,
     editorView = _ref.editorView,
-    helpUrl = _ref.helpUrl;
+    helpUrl = _ref.helpUrl,
+    onInsert = _ref.onInsert;
   var getItems = (0, _react.useCallback)(function (query, category) {
     return (0, _search.getQuickInsertSuggestions)({
       query: query,
@@ -34,9 +35,10 @@ var Modal = function Modal(_ref) {
   // We wait until modal close is complete, refocus the editor and then add the item
   var insertableItem = _react.default.useRef(null);
   var onInsertItem = (0, _react.useCallback)(function (item) {
+    onInsert === null || onInsert === void 0 || onInsert(item);
     (0, _commands.closeElementBrowserModal)()(editorView.state, editorView.dispatch);
     insertableItem.current = item;
-  }, [editorView]);
+  }, [editorView, onInsert]);
   var onClose = (0, _react.useCallback)(function () {
     (0, _commands.closeElementBrowserModal)()(editorView.state, editorView.dispatch);
     focusInEditor();
@@ -63,6 +65,7 @@ var Modal = function Modal(_ref) {
   });
 };
 var _default = exports.default = function _default(_ref2) {
+  var _pluginInjectionAPI$q;
   var editorView = _ref2.editorView,
     helpUrl = _ref2.helpUrl,
     pluginInjectionAPI = _ref2.pluginInjectionAPI;
@@ -71,6 +74,7 @@ var _default = exports.default = function _default(_ref2) {
   return /*#__PURE__*/_react.default.createElement(Modal, {
     quickInsertState: quickInsertState !== null && quickInsertState !== void 0 ? quickInsertState : undefined,
     editorView: editorView,
-    helpUrl: helpUrl
+    helpUrl: helpUrl,
+    onInsert: pluginInjectionAPI === null || pluginInjectionAPI === void 0 || (_pluginInjectionAPI$q = pluginInjectionAPI.quickInsert) === null || _pluginInjectionAPI$q === void 0 || (_pluginInjectionAPI$q = _pluginInjectionAPI$q.actions) === null || _pluginInjectionAPI$q === void 0 ? void 0 : _pluginInjectionAPI$q.onInsert
   });
 };

package/dist/es2019/plugin.js

@@ -11,6 +11,10 @@ export const quickInsertPlugin = ({
   config: options,
   api
 }) => {
+  const onInsert = item => {
+    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 typeAhead = {
     id: TypeAheadAvailableNodes.QUICK_INSERT,
     trigger: '/',
@@ -22,11 +26,17 @@ export const quickInsertPlugin = ({
       const quickInsertState = pluginKey.getState(editorState);
       return Promise.resolve(getQuickInsertSuggestions({
         query,
-        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
+        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
+        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn
       }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
     },
     selectItem: (state, item, insert) => {
-      return item.action(insert, state);
+      const quickInsertItem = item;
+      const result = quickInsertItem.action(insert, state);
+      if (result) {
+        onInsert(quickInsertItem);
+      }
+      return result;
     }
   };
   let intl;
@@ -89,8 +99,15 @@ 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) {
+          searchOptions = {
+            ...searchOptions,
+            prioritySortingFn: options.prioritySortingFn
+          };
+        }
         return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
-      }
+      },
+      onInsert
     },
     commands: {
       openElementBrowserModal,

package/dist/es2019/search.js

@@ -7,7 +7,8 @@ export const getQuickInsertSuggestions = (searchOptions, lazyDefaultItems = () =
     category,
     disableDefaultItems,
     featuredItems,
-    templateItems
+    templateItems,
+    prioritySortingFn
   } = searchOptions;
   const defaultItems = disableDefaultItems ? [] : lazyDefaultItems();
   const items = providedItems ? dedupe([...defaultItems, ...providedItems], item => item.title) : defaultItems;
@@ -23,5 +24,5 @@ export const getQuickInsertSuggestions = (searchOptions, lazyDefaultItems = () =
   if (featuredItems) {
     return items.filter(item => item.featured);
   }
-  return find(query || '', category === 'all' || !category ? items : items.filter(item => item.categories && item.categories.includes(category)));
+  return find(query || '', category === 'all' || !category ? items : items.filter(item => item.categories && item.categories.includes(category)), prioritySortingFn);
 };

package/dist/es2019/ui/ModalElementBrowser/index.js

@@ -6,7 +6,8 @@ import ModalElementBrowser from './ModalElementBrowser';
 const Modal = ({
   quickInsertState,
   editorView,
-  helpUrl
+  helpUrl,
+  onInsert
 }) => {
   const getItems = useCallback((query, category) => getQuickInsertSuggestions({
     query,
@@ -23,9 +24,10 @@ const Modal = ({
   // We wait until modal close is complete, refocus the editor and then add the item
   const insertableItem = React.useRef(null);
   const onInsertItem = useCallback(item => {
+    onInsert === null || onInsert === void 0 ? void 0 : onInsert(item);
     closeElementBrowserModal()(editorView.state, editorView.dispatch);
     insertableItem.current = item;
-  }, [editorView]);
+  }, [editorView, onInsert]);
   const onClose = useCallback(() => {
     closeElementBrowserModal()(editorView.state, editorView.dispatch);
     focusInEditor();
@@ -56,12 +58,14 @@ export default (({
   helpUrl,
   pluginInjectionAPI
 }) => {
+  var _pluginInjectionAPI$q, _pluginInjectionAPI$q2;
   const {
     quickInsertState
   } = useSharedPluginState(pluginInjectionAPI, ['quickInsert']);
   return /*#__PURE__*/React.createElement(Modal, {
     quickInsertState: quickInsertState !== null && quickInsertState !== void 0 ? quickInsertState : undefined,
     editorView: editorView,
-    helpUrl: helpUrl
+    helpUrl: helpUrl,
+    onInsert: pluginInjectionAPI === null || pluginInjectionAPI === void 0 ? void 0 : (_pluginInjectionAPI$q = pluginInjectionAPI.quickInsert) === null || _pluginInjectionAPI$q === void 0 ? void 0 : (_pluginInjectionAPI$q2 = _pluginInjectionAPI$q.actions) === null || _pluginInjectionAPI$q2 === void 0 ? void 0 : _pluginInjectionAPI$q2.onInsert
   });
 });

package/dist/esm/plugin.js

@@ -1,6 +1,6 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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; }
@@ -16,6 +16,10 @@ import ModalElementBrowser from './ui/ModalElementBrowser';
 export var quickInsertPlugin = function quickInsertPlugin(_ref) {
   var options = _ref.config,
     api = _ref.api;
+  var onInsert = function onInsert(item) {
+    var _options$onInsert;
+    options === null || options === void 0 || (_options$onInsert = options.onInsert) === null || _options$onInsert === void 0 || _options$onInsert.call(options, item);
+  };
   var typeAhead = {
     id: TypeAheadAvailableNodes.QUICK_INSERT,
     trigger: '/',
@@ -26,11 +30,17 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
       var quickInsertState = pluginKey.getState(editorState);
       return Promise.resolve(getQuickInsertSuggestions({
         query: query,
-        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
+        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
+        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn
       }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
     },
     selectItem: function selectItem(state, item, insert) {
-      return item.action(insert, state);
+      var quickInsertItem = item;
+      var result = quickInsertItem.action(insert, state);
+      if (result) {
+        onInsert(quickInsertItem);
+      }
+      return result;
     }
   };
   var intl;
@@ -92,8 +102,14 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
         var _ref5 = (_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 = _ref5.lazyDefaultItems,
           providedItems = _ref5.providedItems;
+        if (options !== null && options !== void 0 && options.prioritySortingFn) {
+          searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
+            prioritySortingFn: options.prioritySortingFn
+          });
+        }
         return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
-      }
+      },
+      onInsert: onInsert
     },
     commands: {
       openElementBrowserModal: openElementBrowserModal,

package/dist/esm/search.js

@@ -11,7 +11,8 @@ export var getQuickInsertSuggestions = function getQuickInsertSuggestions(search
     category = searchOptions.category,
     disableDefaultItems = searchOptions.disableDefaultItems,
     featuredItems = searchOptions.featuredItems,
-    templateItems = searchOptions.templateItems;
+    templateItems = searchOptions.templateItems,
+    prioritySortingFn = searchOptions.prioritySortingFn;
   var defaultItems = disableDefaultItems ? [] : lazyDefaultItems();
   var items = providedItems ? dedupe([].concat(_toConsumableArray(defaultItems), _toConsumableArray(providedItems)), function (item) {
     return item.title;
@@ -32,5 +33,5 @@ export var getQuickInsertSuggestions = function getQuickInsertSuggestions(search
   }
   return find(query || '', category === 'all' || !category ? items : items.filter(function (item) {
     return item.categories && item.categories.includes(category);
-  }));
+  }), prioritySortingFn);
 };

package/dist/esm/ui/ModalElementBrowser/index.js

@@ -6,7 +6,8 @@ import ModalElementBrowser from './ModalElementBrowser';
 var Modal = function Modal(_ref) {
   var quickInsertState = _ref.quickInsertState,
     editorView = _ref.editorView,
-    helpUrl = _ref.helpUrl;
+    helpUrl = _ref.helpUrl,
+    onInsert = _ref.onInsert;
   var getItems = useCallback(function (query, category) {
     return getQuickInsertSuggestions({
       query: query,
@@ -24,9 +25,10 @@ var Modal = function Modal(_ref) {
   // We wait until modal close is complete, refocus the editor and then add the item
   var insertableItem = React.useRef(null);
   var onInsertItem = useCallback(function (item) {
+    onInsert === null || onInsert === void 0 || onInsert(item);
     closeElementBrowserModal()(editorView.state, editorView.dispatch);
     insertableItem.current = item;
-  }, [editorView]);
+  }, [editorView, onInsert]);
   var onClose = useCallback(function () {
     closeElementBrowserModal()(editorView.state, editorView.dispatch);
     focusInEditor();
@@ -53,6 +55,7 @@ var Modal = function Modal(_ref) {
   });
 };
 export default (function (_ref2) {
+  var _pluginInjectionAPI$q;
   var editorView = _ref2.editorView,
     helpUrl = _ref2.helpUrl,
     pluginInjectionAPI = _ref2.pluginInjectionAPI;
@@ -61,6 +64,7 @@ export default (function (_ref2) {
   return /*#__PURE__*/React.createElement(Modal, {
     quickInsertState: quickInsertState !== null && quickInsertState !== void 0 ? quickInsertState : undefined,
     editorView: editorView,
-    helpUrl: helpUrl
+    helpUrl: helpUrl,
+    onInsert: pluginInjectionAPI === null || pluginInjectionAPI === void 0 || (_pluginInjectionAPI$q = pluginInjectionAPI.quickInsert) === null || _pluginInjectionAPI$q === void 0 || (_pluginInjectionAPI$q = _pluginInjectionAPI$q.actions) === null || _pluginInjectionAPI$q === void 0 ? void 0 : _pluginInjectionAPI$q.onInsert
   });
 });

package/dist/types/plugin.d.ts

@@ -14,6 +14,7 @@ export type QuickInsertPlugin = NextEditorPlugin<'quickInsert', {
         openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         insertItem: (item: QuickInsertItem, source?: INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR) => Command;
         getSuggestions: (searchOptions: QuickInsertSearchOptions) => QuickInsertItem[];
+        onInsert: (item: QuickInsertItem) => void;
     };
     commands: {
         openElementBrowserModal: EditorCommand;

package/dist/types-ts4.5/plugin.d.ts

@@ -16,6 +16,7 @@ export type QuickInsertPlugin = NextEditorPlugin<'quickInsert', {
         openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         insertItem: (item: QuickInsertItem, source?: INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR) => Command;
         getSuggestions: (searchOptions: QuickInsertSearchOptions) => QuickInsertItem[];
+        onInsert: (item: QuickInsertItem) => void;
     };
     commands: {
         openElementBrowserModal: EditorCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "1.4.7",
+	"version": "1.5.1",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -10,7 +10,7 @@
 	"atlassian": {
 		"team": "Editor: Lego",
 		"singleton": true,
-		"runReact18": false
+		"runReact18": true
 	},
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
 	"main": "dist/cjs/index.js",
@@ -31,11 +31,11 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/button": "^20.2.0",
-		"@atlaskit/editor-common": "^94.0.0",
+		"@atlaskit/button": "^20.3.0",
+		"@atlaskit/editor-common": "^94.2.0",
 		"@atlaskit/editor-plugin-type-ahead": "^1.10.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
-		"@atlaskit/icon": "^22.23.0",
+		"@atlaskit/icon": "^22.24.0",
 		"@atlaskit/modal-dialog": "^12.17.0",
 		"@atlaskit/theme": "^14.0.0",
 		"@atlaskit/tokens": "^2.0.0",
@@ -44,6 +44,7 @@
 	},
 	"peerDependencies": {
 		"react": "^16.8.0 || ^17.0.0 || ~18.2.0",
+		"react-dom": "^16.8.0 || ^17.0.0 || ^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"devDependencies": {
@@ -51,7 +52,6 @@
 		"@atlaskit/ssr": "*",
 		"@atlaskit/visual-regression": "*",
 		"@testing-library/react": "^12.1.5",
-		"react-dom": "^16.8.0",
 		"typescript": "~5.4.2",
 		"wait-for-expect": "^1.2.0"
 	},