npm - @atlaskit/editor-plugin-quick-insert - Versions diffs - 0.1.2 → 0.2.0 - Mend

@atlaskit/editor-plugin-quick-insert 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/CHANGELOG.md +10 -0
package/dist/cjs/plugin.js +30 -21
package/dist/es2019/plugin.js +82 -71
package/dist/esm/plugin.js +30 -21
package/dist/types/index.d.ts +1 -1
package/dist/types/plugin.d.ts +7 -1
package/dist/types-ts4.5/index.d.ts +1 -1
package/dist/types-ts4.5/plugin.d.ts +9 -1
package/package.json +3 -2
package/report.api.md +11 -1
package/tmp/api-report-tmp.d.ts +11 -1

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,15 @@
 # @atlaskit/editor-plugin-quick-insert
+## 0.2.0
+### Minor Changes
+- [#41143](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41143) [`7d6dfe2befa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7d6dfe2befa) - [ED-20003] Replace TyepAhead API for Editor Plugin Injection API
+### Patch Changes
+- Updated dependencies
 ## 0.1.2
 ### Patch Changes

package/dist/cjs/plugin.js CHANGED Viewed

@@ -21,38 +21,39 @@ 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 typeAhead = {
+    id: _typeAhead.TypeAheadAvailableNodes.QUICK_INSERT,
+    trigger: '/',
+    headless: options === null || options === void 0 ? void 0 : options.headless,
+    getItems: function getItems(_ref2) {
+      var query = _ref2.query,
+        editorState = _ref2.editorState;
+      var quickInsertState = _pluginKey.pluginKey.getState(editorState);
+      return Promise.resolve((0, _search.getQuickInsertSuggestions)({
+        query: query,
+        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
+      }, 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);
+    }
+  };
   return {
     name: 'quickInsert',
     pmPlugins: function pmPlugins(defaultItems) {
       return [{
         name: 'quickInsert',
         // It's important that this plugin is above TypeAheadPlugin
-        plugin: function plugin(_ref2) {
-          var providerFactory = _ref2.providerFactory,
-            getIntl = _ref2.getIntl,
-            dispatch = _ref2.dispatch;
+        plugin: function plugin(_ref3) {
+          var providerFactory = _ref3.providerFactory,
+            getIntl = _ref3.getIntl,
+            dispatch = _ref3.dispatch;
           return quickInsertPluginFactory(defaultItems, providerFactory, getIntl, dispatch, options === null || options === void 0 ? void 0 : options.emptyStateHandler);
         }
       }];
     },
     pluginsOptions: {
-      typeAhead: {
-        id: _typeAhead.TypeAheadAvailableNodes.QUICK_INSERT,
-        trigger: '/',
-        headless: options === null || options === void 0 ? void 0 : options.headless,
-        getItems: function getItems(_ref3) {
-          var query = _ref3.query,
-            editorState = _ref3.editorState;
-          var quickInsertState = _pluginKey.pluginKey.getState(editorState);
-          return Promise.resolve((0, _search.getQuickInsertSuggestions)({
-            query: query,
-            disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
-          }, 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);
-        }
-      }
+      typeAhead: typeAhead
     },
     contentComponent: function contentComponent(_ref4) {
       var editorView = _ref4.editorView;
@@ -74,6 +75,7 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
         return null;
       }
       return {
+        typeAheadHandler: typeAhead,
         lazyDefaultItems: quickInsertState.lazyDefaultItems,
         emptyStateHandler: quickInsertState.emptyStateHandler,
         providedItems: quickInsertState.providedItems,
@@ -82,6 +84,13 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
     },
     actions: {
       insertItem: _commands.insertItem,
+      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({
+          triggerHandler: typeAhead,
+          inputMethod: inputMethod
+        }));
+      },
       getSuggestions: function getSuggestions(searchOptions) {
         var _api$quickInsert$shar;
         var _ref5 = (_api$quickInsert$shar = api === null || api === void 0 ? void 0 : api.quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {},

package/dist/es2019/plugin.js CHANGED Viewed

@@ -9,81 +9,92 @@ import ModalElementBrowser from './ui/ModalElementBrowser';
 export const quickInsertPlugin = ({
   config: options,
   api
-}) => ({
-  name: 'quickInsert',
-  pmPlugins(defaultItems) {
-    return [{
-      name: 'quickInsert',
-      // It's important that this plugin is above TypeAheadPlugin
-      plugin: ({
-        providerFactory,
-        getIntl,
-        dispatch
-      }) => quickInsertPluginFactory(defaultItems, providerFactory, getIntl, dispatch, options === null || options === void 0 ? void 0 : options.emptyStateHandler)
-    }];
-  },
-  pluginsOptions: {
-    typeAhead: {
-      id: TypeAheadAvailableNodes.QUICK_INSERT,
-      trigger: '/',
-      headless: options === null || options === void 0 ? void 0 : options.headless,
-      getItems({
+}) => {
+  const typeAhead = {
+    id: TypeAheadAvailableNodes.QUICK_INSERT,
+    trigger: '/',
+    headless: options === null || options === void 0 ? void 0 : options.headless,
+    getItems({
+      query,
+      editorState
+    }) {
+      const quickInsertState = pluginKey.getState(editorState);
+      return Promise.resolve(getQuickInsertSuggestions({
         query,
-        editorState
-      }) {
-        const quickInsertState = pluginKey.getState(editorState);
-        return Promise.resolve(getQuickInsertSuggestions({
-          query,
-          disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
-        }, 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);
-      }
-    }
-  },
-  contentComponent({
-    editorView
-  }) {
-    if (options !== null && options !== void 0 && options.enableElementBrowser) {
-      return /*#__PURE__*/React.createElement(ModalElementBrowser, {
-        editorView: editorView,
-        helpUrl: options === null || options === void 0 ? void 0 : options.elementBrowserHelpUrl,
-        pluginInjectionAPI: api
-      });
-    }
-    return null;
-  },
-  getSharedState(editorState) {
-    if (!editorState) {
-      return null;
+        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
+      }, 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 quickInsertState = pluginKey.getState(editorState);
-    if (!quickInsertState) {
+  };
+  return {
+    name: 'quickInsert',
+    pmPlugins(defaultItems) {
+      return [{
+        name: 'quickInsert',
+        // It's important that this plugin is above TypeAheadPlugin
+        plugin: ({
+          providerFactory,
+          getIntl,
+          dispatch
+        }) => quickInsertPluginFactory(defaultItems, providerFactory, getIntl, dispatch, options === null || options === void 0 ? void 0 : options.emptyStateHandler)
+      }];
+    },
+    pluginsOptions: {
+      typeAhead
+    },
+    contentComponent({
+      editorView
+    }) {
+      if (options !== null && options !== void 0 && options.enableElementBrowser) {
+        return /*#__PURE__*/React.createElement(ModalElementBrowser, {
+          editorView: editorView,
+          helpUrl: options === null || options === void 0 ? void 0 : options.elementBrowserHelpUrl,
+          pluginInjectionAPI: api
+        });
+      }
       return null;
+    },
+    getSharedState(editorState) {
+      if (!editorState) {
+        return null;
+      }
+      const quickInsertState = pluginKey.getState(editorState);
+      if (!quickInsertState) {
+        return null;
+      }
+      return {
+        typeAheadHandler: typeAhead,
+        lazyDefaultItems: quickInsertState.lazyDefaultItems,
+        emptyStateHandler: quickInsertState.emptyStateHandler,
+        providedItems: quickInsertState.providedItems,
+        isElementBrowserModalOpen: quickInsertState.isElementBrowserModalOpen
+      };
+    },
+    actions: {
+      insertItem,
+      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({
+          triggerHandler: typeAhead,
+          inputMethod
+        }));
+      },
+      getSuggestions: searchOptions => {
+        var _api$quickInsert$shar;
+        const {
+          lazyDefaultItems,
+          providedItems
+        } = (_api$quickInsert$shar = api === null || api === void 0 ? void 0 : api.quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {};
+        return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
+      }
+    },
+    commands: {
+      openElementBrowserModal
     }
-    return {
-      lazyDefaultItems: quickInsertState.lazyDefaultItems,
-      emptyStateHandler: quickInsertState.emptyStateHandler,
-      providedItems: quickInsertState.providedItems,
-      isElementBrowserModalOpen: quickInsertState.isElementBrowserModalOpen
-    };
-  },
-  actions: {
-    insertItem,
-    getSuggestions: searchOptions => {
-      var _api$quickInsert$shar;
-      const {
-        lazyDefaultItems,
-        providedItems
-      } = (_api$quickInsert$shar = api === null || api === void 0 ? void 0 : api.quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {};
-      return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
-    }
-  },
-  commands: {
-    openElementBrowserModal
-  }
-});
+  };
+};
 const setProviderState = providerState => (state, dispatch) => {
   if (dispatch) {
     dispatch(state.tr.setMeta(pluginKey, providerState));

package/dist/esm/plugin.js CHANGED Viewed

@@ -14,38 +14,39 @@ import ModalElementBrowser from './ui/ModalElementBrowser';
 export var quickInsertPlugin = function quickInsertPlugin(_ref) {
   var options = _ref.config,
     api = _ref.api;
+  var typeAhead = {
+    id: TypeAheadAvailableNodes.QUICK_INSERT,
+    trigger: '/',
+    headless: options === null || options === void 0 ? void 0 : options.headless,
+    getItems: function getItems(_ref2) {
+      var query = _ref2.query,
+        editorState = _ref2.editorState;
+      var quickInsertState = pluginKey.getState(editorState);
+      return Promise.resolve(getQuickInsertSuggestions({
+        query: query,
+        disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
+      }, 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);
+    }
+  };
   return {
     name: 'quickInsert',
     pmPlugins: function pmPlugins(defaultItems) {
       return [{
         name: 'quickInsert',
         // It's important that this plugin is above TypeAheadPlugin
-        plugin: function plugin(_ref2) {
-          var providerFactory = _ref2.providerFactory,
-            getIntl = _ref2.getIntl,
-            dispatch = _ref2.dispatch;
+        plugin: function plugin(_ref3) {
+          var providerFactory = _ref3.providerFactory,
+            getIntl = _ref3.getIntl,
+            dispatch = _ref3.dispatch;
           return quickInsertPluginFactory(defaultItems, providerFactory, getIntl, dispatch, options === null || options === void 0 ? void 0 : options.emptyStateHandler);
         }
       }];
     },
     pluginsOptions: {
-      typeAhead: {
-        id: TypeAheadAvailableNodes.QUICK_INSERT,
-        trigger: '/',
-        headless: options === null || options === void 0 ? void 0 : options.headless,
-        getItems: function getItems(_ref3) {
-          var query = _ref3.query,
-            editorState = _ref3.editorState;
-          var quickInsertState = pluginKey.getState(editorState);
-          return Promise.resolve(getQuickInsertSuggestions({
-            query: query,
-            disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems
-          }, 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);
-        }
-      }
+      typeAhead: typeAhead
     },
     contentComponent: function contentComponent(_ref4) {
       var editorView = _ref4.editorView;
@@ -67,6 +68,7 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
         return null;
       }
       return {
+        typeAheadHandler: typeAhead,
         lazyDefaultItems: quickInsertState.lazyDefaultItems,
         emptyStateHandler: quickInsertState.emptyStateHandler,
         providedItems: quickInsertState.providedItems,
@@ -75,6 +77,13 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
     },
     actions: {
       insertItem: insertItem,
+      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({
+          triggerHandler: typeAhead,
+          inputMethod: inputMethod
+        }));
+      },
       getSuggestions: function getSuggestions(searchOptions) {
         var _api$quickInsert$shar;
         var _ref5 = (_api$quickInsert$shar = api === null || api === void 0 ? void 0 : api.quickInsert.sharedState.currentState()) !== null && _api$quickInsert$shar !== void 0 ? _api$quickInsert$shar : {},

package/dist/types/index.d.ts CHANGED Viewed

@@ -1,2 +1,2 @@
 export { quickInsertPlugin } from './plugin';
-export type { QuickInsertPlugin } from './plugin';
+export type { QuickInsertPlugin, QuickInsertSharedState } from './plugin';

package/dist/types/plugin.d.ts CHANGED Viewed

@@ -1,10 +1,16 @@
 import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
-import type { Command, EditorCommand, NextEditorPlugin, QuickInsertPluginOptions, QuickInsertSearchOptions, QuickInsertSharedState } from '@atlaskit/editor-common/types';
+import type { Command, QuickInsertSharedState as CommonQuickInsertSharedState, EditorCommand, NextEditorPlugin, QuickInsertPluginOptions, QuickInsertSearchOptions, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadInputMethod, TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 export type { QuickInsertPluginOptions };
+export type QuickInsertSharedState = CommonQuickInsertSharedState & {
+    typeAheadHandler: TypeAheadHandler;
+};
 export type QuickInsertPlugin = NextEditorPlugin<'quickInsert', {
     pluginConfiguration: QuickInsertPluginOptions | undefined;
+    dependencies: [TypeAheadPlugin];
     sharedState: QuickInsertSharedState | null;
     actions: {
+        openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         insertItem: (item: QuickInsertItem) => Command;
         getSuggestions: (searchOptions: QuickInsertSearchOptions) => QuickInsertItem[];
     };

package/dist/types-ts4.5/index.d.ts CHANGED Viewed

@@ -1,2 +1,2 @@
 export { quickInsertPlugin } from './plugin';
-export type { QuickInsertPlugin } from './plugin';
+export type { QuickInsertPlugin, QuickInsertSharedState } from './plugin';

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

@@ -1,10 +1,18 @@
 import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
-import type { Command, EditorCommand, NextEditorPlugin, QuickInsertPluginOptions, QuickInsertSearchOptions, QuickInsertSharedState } from '@atlaskit/editor-common/types';
+import type { Command, QuickInsertSharedState as CommonQuickInsertSharedState, EditorCommand, NextEditorPlugin, QuickInsertPluginOptions, QuickInsertSearchOptions, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadInputMethod, TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 export type { QuickInsertPluginOptions };
+export type QuickInsertSharedState = CommonQuickInsertSharedState & {
+    typeAheadHandler: TypeAheadHandler;
+};
 export type QuickInsertPlugin = NextEditorPlugin<'quickInsert', {
     pluginConfiguration: QuickInsertPluginOptions | undefined;
+    dependencies: [
+        TypeAheadPlugin
+    ];
     sharedState: QuickInsertSharedState | null;
     actions: {
+        openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         insertItem: (item: QuickInsertItem) => Command;
         getSuggestions: (searchOptions: QuickInsertSearchOptions) => QuickInsertItem[];
     };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-quick-insert",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Quick insert plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -36,7 +36,8 @@
   },
   "dependencies": {
     "@atlaskit/button": "^16.10.0",
-    "@atlaskit/editor-common": "^76.3.0",
+    "@atlaskit/editor-common": "^76.6.0",
+    "@atlaskit/editor-plugin-type-ahead": "^0.5.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/modal-dialog": "^12.8.0",

package/report.api.md CHANGED Viewed

@@ -21,15 +21,20 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { QuickInsertPluginOptions } from '@atlaskit/editor-common/types';
 import type { QuickInsertSearchOptions } from '@atlaskit/editor-common/types';
-import type { QuickInsertSharedState } from '@atlaskit/editor-common/types';
+import type { QuickInsertSharedState as QuickInsertSharedState_2 } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadInputMethod } from '@atlaskit/editor-plugin-type-ahead';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 // @public (undocumented)
 export type QuickInsertPlugin = NextEditorPlugin<
   'quickInsert',
   {
     pluginConfiguration: QuickInsertPluginOptions | undefined;
+    dependencies: [TypeAheadPlugin];
     sharedState: QuickInsertSharedState | null;
     actions: {
+      openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
       insertItem: (item: QuickInsertItem) => Command;
       getSuggestions: (
         searchOptions: QuickInsertSearchOptions,
@@ -44,6 +49,11 @@ export type QuickInsertPlugin = NextEditorPlugin<
 // @public (undocumented)
 export const quickInsertPlugin: QuickInsertPlugin;
+// @public (undocumented)
+export type QuickInsertSharedState = QuickInsertSharedState_2 & {
+  typeAheadHandler: TypeAheadHandler;
+};
 // (No @packageDocumentation comment for this package)
 ```

package/tmp/api-report-tmp.d.ts CHANGED Viewed

@@ -10,13 +10,18 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { QuickInsertPluginOptions } from '@atlaskit/editor-common/types';
 import type { QuickInsertSearchOptions } from '@atlaskit/editor-common/types';
-import type { QuickInsertSharedState } from '@atlaskit/editor-common/types';
+import type { QuickInsertSharedState as QuickInsertSharedState_2 } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadInputMethod } from '@atlaskit/editor-plugin-type-ahead';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 // @public (undocumented)
 export type QuickInsertPlugin = NextEditorPlugin<'quickInsert', {
     pluginConfiguration: QuickInsertPluginOptions | undefined;
+    dependencies: [TypeAheadPlugin];
     sharedState: QuickInsertSharedState | null;
     actions: {
+        openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         insertItem: (item: QuickInsertItem) => Command;
         getSuggestions: (searchOptions: QuickInsertSearchOptions) => QuickInsertItem[];
     };
@@ -28,6 +33,11 @@ export type QuickInsertPlugin = NextEditorPlugin<'quickInsert', {
 // @public (undocumented)
 export const quickInsertPlugin: QuickInsertPlugin;
+// @public (undocumented)
+export type QuickInsertSharedState = QuickInsertSharedState_2 & {
+    typeAheadHandler: TypeAheadHandler;
+};
 // (No @packageDocumentation comment for this package)
 ```