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

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 1.6.0
+
+### Minor Changes
+
+- [#157845](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/157845)
+  [`036086b523133`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/036086b523133) -
+  Removed onInsert from quickInsert plugin actions, as the behavior is now encapsulated within
+  insertItem
+
 ## 1.5.1
 
 ### Patch Changes

package/dist/cjs/commands.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.openElementBrowserModal = exports.insertItem = exports.closeElementBrowserModal = void 0;
+exports.openElementBrowserModal = exports.createInsertItem = exports.closeElementBrowserModal = void 0;
 var _insert = require("@atlaskit/editor-common/insert");
 var _pluginKey = require("./plugin-key");
 var openElementBrowserModal = exports.openElementBrowserModal = function openElementBrowserModal(_ref) {
@@ -22,20 +22,26 @@ var closeElementBrowserModal = exports.closeElementBrowserModal = function close
     return true;
   };
 };
+var createInsertItem = exports.createInsertItem = function createInsertItem(onInsert) {
+  return insertItem(onInsert);
+};
 
 // this method was adapted from the typeahead plugin so we respect the API for quick insert items
-var insertItem = exports.insertItem = function insertItem(item, source) {
-  return function (state, dispatch) {
-    var insert = function insert(maybeNode) {
-      var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-      return (0, _insert.insertSelectedItem)(maybeNode, opts)(state, state.tr, state.selection.head);
-    };
-    var tr = item.action(insert, state, source);
+var insertItem = function insertItem(onInsert) {
+  return function (item, source) {
+    return function (state, dispatch) {
+      var insert = function insert(maybeNode) {
+        var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        return (0, _insert.insertSelectedItem)(maybeNode, opts)(state, state.tr, state.selection.head);
+      };
+      var tr = item.action(insert, state, source);
 
-    /** @note There is no transaction when called without a search currently (different insert) */
-    if (tr && dispatch) {
-      dispatch(tr);
-    }
-    return true;
+      /** @note There is no transaction when called without a search currently (different insert) */
+      if (tr && dispatch) {
+        dispatch(tr);
+      }
+      onInsert === null || onInsert === void 0 || onInsert(item);
+      return true;
+    };
   };
 };

package/dist/cjs/plugin.js

@@ -96,7 +96,7 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
       };
     },
     actions: {
-      insertItem: _commands.insertItem,
+      insertItem: (0, _commands.createInsertItem)(onInsert),
       openTypeAhead: function openTypeAhead(inputMethod) {
         var _api$typeAhead;
         return Boolean(api === null || api === void 0 || (_api$typeAhead = api.typeAhead) === null || _api$typeAhead === void 0 ? void 0 : _api$typeAhead.actions.open({
@@ -115,8 +115,7 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
           });
         }
         return (0, _search.getQuickInsertSuggestions)(searchOptions, lazyDefaultItems, providedItems);
-      },
-      onInsert: onInsert
+      }
     },
     commands: {
       openElementBrowserModal: _commands.openElementBrowserModal,

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

@@ -17,7 +17,7 @@ var Modal = function Modal(_ref) {
   var quickInsertState = _ref.quickInsertState,
     editorView = _ref.editorView,
     helpUrl = _ref.helpUrl,
-    onInsert = _ref.onInsert;
+    insertItem = _ref.insertItem;
   var getItems = (0, _react.useCallback)(function (query, category) {
     return (0, _search.getQuickInsertSuggestions)({
       query: query,
@@ -35,10 +35,9 @@ 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, onInsert]);
+  }, [editorView]);
   var onClose = (0, _react.useCallback)(function () {
     (0, _commands.closeElementBrowserModal)()(editorView.state, editorView.dispatch);
     focusInEditor();
@@ -51,8 +50,8 @@ var Modal = function Modal(_ref) {
     var item = insertableItem.current;
     insertableItem.current = null;
     focusInEditor();
-    (0, _commands.insertItem)(item)(editorView.state, editorView.dispatch);
-  }, [editorView, focusInEditor]);
+    insertItem === null || insertItem === void 0 || insertItem(item)(editorView.state, editorView.dispatch);
+  }, [editorView, focusInEditor, insertItem]);
   return /*#__PURE__*/_react.default.createElement(_ModalElementBrowser.default, {
     getItems: getItems,
     onInsertItem: onInsertItem,
@@ -75,6 +74,6 @@ var _default = exports.default = function _default(_ref2) {
     quickInsertState: quickInsertState !== null && quickInsertState !== void 0 ? quickInsertState : undefined,
     editorView: editorView,
     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
+    insertItem: 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.insertItem
   });
 };

package/dist/es2019/commands.js

@@ -13,9 +13,10 @@ export const closeElementBrowserModal = () => (state, dispatch) => {
   }
   return true;
 };
+export const createInsertItem = onInsert => insertItem(onInsert);
 
 // this method was adapted from the typeahead plugin so we respect the API for quick insert items
-export const insertItem = (item, source) => (state, dispatch) => {
+const insertItem = onInsert => (item, source) => (state, dispatch) => {
   const insert = (maybeNode, opts = {}) => {
     return insertSelectedItem(maybeNode, opts)(state, state.tr, state.selection.head);
   };
@@ -25,5 +26,6 @@ export const insertItem = (item, source) => (state, dispatch) => {
   if (tr && dispatch) {
     dispatch(tr);
   }
+  onInsert === null || onInsert === void 0 ? void 0 : onInsert(item);
   return true;
 };

package/dist/es2019/plugin.js

@@ -3,7 +3,7 @@ import { useIntl } from 'react-intl-next';
 import { memoProcessQuickInsertItems } from '@atlaskit/editor-common/quick-insert';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
-import { insertItem, openElementBrowserModal } from './commands';
+import { createInsertItem, openElementBrowserModal } from './commands';
 import { pluginKey } from './plugin-key';
 import { getQuickInsertSuggestions } from './search';
 import ModalElementBrowser from './ui/ModalElementBrowser';
@@ -85,7 +85,7 @@ export const quickInsertPlugin = ({
       };
     },
     actions: {
-      insertItem,
+      insertItem: createInsertItem(onInsert),
       openTypeAhead(inputMethod) {
         var _api$typeAhead;
         return Boolean(api === null || api === void 0 ? void 0 : (_api$typeAhead = api.typeAhead) === null || _api$typeAhead === void 0 ? void 0 : _api$typeAhead.actions.open({
@@ -106,8 +106,7 @@ export const quickInsertPlugin = ({
           };
         }
         return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
-      },
-      onInsert
+      }
     },
     commands: {
       openElementBrowserModal,

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

@@ -1,13 +1,13 @@
 import React, { useCallback } from 'react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
-import { closeElementBrowserModal, insertItem } from '../../commands';
+import { closeElementBrowserModal } from '../../commands';
 import { getQuickInsertSuggestions } from '../../search';
 import ModalElementBrowser from './ModalElementBrowser';
 const Modal = ({
   quickInsertState,
   editorView,
   helpUrl,
-  onInsert
+  insertItem
 }) => {
   const getItems = useCallback((query, category) => getQuickInsertSuggestions({
     query,
@@ -24,10 +24,9 @@ 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, onInsert]);
+  }, [editorView]);
   const onClose = useCallback(() => {
     closeElementBrowserModal()(editorView.state, editorView.dispatch);
     focusInEditor();
@@ -40,8 +39,8 @@ const Modal = ({
     const item = insertableItem.current;
     insertableItem.current = null;
     focusInEditor();
-    insertItem(item)(editorView.state, editorView.dispatch);
-  }, [editorView, focusInEditor]);
+    insertItem === null || insertItem === void 0 ? void 0 : insertItem(item)(editorView.state, editorView.dispatch);
+  }, [editorView, focusInEditor, insertItem]);
   return /*#__PURE__*/React.createElement(ModalElementBrowser, {
     getItems: getItems,
     onInsertItem: onInsertItem,
@@ -66,6 +65,6 @@ export default (({
     quickInsertState: quickInsertState !== null && quickInsertState !== void 0 ? quickInsertState : undefined,
     editorView: editorView,
     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
+    insertItem: 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.insertItem
   });
 });

package/dist/esm/commands.js

@@ -16,20 +16,26 @@ export var closeElementBrowserModal = function closeElementBrowserModal() {
     return true;
   };
 };
+export var createInsertItem = function createInsertItem(onInsert) {
+  return insertItem(onInsert);
+};
 
 // this method was adapted from the typeahead plugin so we respect the API for quick insert items
-export var insertItem = function insertItem(item, source) {
-  return function (state, dispatch) {
-    var insert = function insert(maybeNode) {
-      var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-      return insertSelectedItem(maybeNode, opts)(state, state.tr, state.selection.head);
-    };
-    var tr = item.action(insert, state, source);
+var insertItem = function insertItem(onInsert) {
+  return function (item, source) {
+    return function (state, dispatch) {
+      var insert = function insert(maybeNode) {
+        var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        return insertSelectedItem(maybeNode, opts)(state, state.tr, state.selection.head);
+      };
+      var tr = item.action(insert, state, source);
 
-    /** @note There is no transaction when called without a search currently (different insert) */
-    if (tr && dispatch) {
-      dispatch(tr);
-    }
-    return true;
+      /** @note There is no transaction when called without a search currently (different insert) */
+      if (tr && dispatch) {
+        dispatch(tr);
+      }
+      onInsert === null || onInsert === void 0 || onInsert(item);
+      return true;
+    };
   };
 };

package/dist/esm/plugin.js

@@ -9,7 +9,7 @@ import { useIntl } from 'react-intl-next';
 import { memoProcessQuickInsertItems } from '@atlaskit/editor-common/quick-insert';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
-import { insertItem, openElementBrowserModal } from './commands';
+import { createInsertItem, openElementBrowserModal } from './commands';
 import { pluginKey } from './plugin-key';
 import { getQuickInsertSuggestions } from './search';
 import ModalElementBrowser from './ui/ModalElementBrowser';
@@ -89,7 +89,7 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
       };
     },
     actions: {
-      insertItem: insertItem,
+      insertItem: createInsertItem(onInsert),
       openTypeAhead: function openTypeAhead(inputMethod) {
         var _api$typeAhead;
         return Boolean(api === null || api === void 0 || (_api$typeAhead = api.typeAhead) === null || _api$typeAhead === void 0 ? void 0 : _api$typeAhead.actions.open({
@@ -108,8 +108,7 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
           });
         }
         return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
-      },
-      onInsert: onInsert
+      }
     },
     commands: {
       openElementBrowserModal: openElementBrowserModal,

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

@@ -1,13 +1,13 @@
 import React, { useCallback } from 'react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
-import { closeElementBrowserModal, insertItem } from '../../commands';
+import { closeElementBrowserModal } from '../../commands';
 import { getQuickInsertSuggestions } from '../../search';
 import ModalElementBrowser from './ModalElementBrowser';
 var Modal = function Modal(_ref) {
   var quickInsertState = _ref.quickInsertState,
     editorView = _ref.editorView,
     helpUrl = _ref.helpUrl,
-    onInsert = _ref.onInsert;
+    insertItem = _ref.insertItem;
   var getItems = useCallback(function (query, category) {
     return getQuickInsertSuggestions({
       query: query,
@@ -25,10 +25,9 @@ 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, onInsert]);
+  }, [editorView]);
   var onClose = useCallback(function () {
     closeElementBrowserModal()(editorView.state, editorView.dispatch);
     focusInEditor();
@@ -41,8 +40,8 @@ var Modal = function Modal(_ref) {
     var item = insertableItem.current;
     insertableItem.current = null;
     focusInEditor();
-    insertItem(item)(editorView.state, editorView.dispatch);
-  }, [editorView, focusInEditor]);
+    insertItem === null || insertItem === void 0 || insertItem(item)(editorView.state, editorView.dispatch);
+  }, [editorView, focusInEditor, insertItem]);
   return /*#__PURE__*/React.createElement(ModalElementBrowser, {
     getItems: getItems,
     onInsertItem: onInsertItem,
@@ -65,6 +64,6 @@ export default (function (_ref2) {
     quickInsertState: quickInsertState !== null && quickInsertState !== void 0 ? quickInsertState : undefined,
     editorView: editorView,
     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
+    insertItem: 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.insertItem
   });
 });

package/dist/types/commands.d.ts

@@ -3,4 +3,4 @@ import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { Command, EditorCommand } from '@atlaskit/editor-common/types';
 export declare const openElementBrowserModal: EditorCommand;
 export declare const closeElementBrowserModal: () => Command;
-export declare const insertItem: (item: QuickInsertItem, source?: INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR) => Command;
+export declare const createInsertItem: (onInsert?: ((item: QuickInsertItem) => void) | undefined) => (item: QuickInsertItem, source?: INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR) => Command;

package/dist/types/plugin.d.ts

@@ -14,7 +14,6 @@ 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/commands.d.ts

@@ -3,4 +3,4 @@ import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { Command, EditorCommand } from '@atlaskit/editor-common/types';
 export declare const openElementBrowserModal: EditorCommand;
 export declare const closeElementBrowserModal: () => Command;
-export declare const insertItem: (item: QuickInsertItem, source?: INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR) => Command;
+export declare const createInsertItem: (onInsert?: ((item: QuickInsertItem) => void) | undefined) => (item: QuickInsertItem, source?: INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR) => Command;

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

@@ -16,7 +16,6 @@ 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.5.1",
+	"version": "1.6.0",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,7 +32,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/button": "^20.3.0",
-		"@atlaskit/editor-common": "^94.2.0",
+		"@atlaskit/editor-common": "^94.8.0",
 		"@atlaskit/editor-plugin-type-ahead": "^1.10.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
 		"@atlaskit/icon": "^22.24.0",