@atlaskit/editor-core 223.0.6 → 223.1.0

package/dist/esm/ui/quick-insert/executeExtensionQuickInsertItem.js

@@ -0,0 +1,91 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, fireAnalyticsEvent, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { resolveImport } from '@atlaskit/editor-common/extensions';
+import { safeInsert } from '@atlaskit/editor-common/insert';
+import { logException } from '@atlaskit/editor-common/monitoring';
+import { processRawValue } from '@atlaskit/editor-common/process-raw-value';
+import { findInsertLocation } from '@atlaskit/editor-common/utils/analytics';
+var sendAnalytics = function sendAnalytics(item, selection, createAnalyticsEvent, source) {
+  if (createAnalyticsEvent) {
+    var insertLocation = findInsertLocation(selection);
+    fireAnalyticsEvent(createAnalyticsEvent)({
+      payload: {
+        action: ACTION.INSERTED,
+        actionSubject: ACTION_SUBJECT.DOCUMENT,
+        actionSubjectId: ACTION_SUBJECT_ID.EXTENSION,
+        attributes: _objectSpread({
+          extensionType: item.extensionType,
+          extensionKey: item.extensionKey,
+          key: item.key,
+          inputMethod: source || INPUT_METHOD.QUICK_INSERT
+        }, insertLocation ? {
+          insertLocation: insertLocation
+        } : {}),
+        eventType: EVENT_TYPE.TRACK
+      }
+    });
+  }
+};
+var warnDummyAPI = function warnDummyAPI(location) {
+  if (process.env.NODE_ENV !== 'production') {
+    // eslint-disable-next-line no-console
+    console.warn('Extension plugin not attached to editor - cannot use extension API in ' + location);
+  }
+};
+var dummyExtensionAPI = {
+  editInContextPanel: function editInContextPanel() {
+    return warnDummyAPI('editInContextPanel');
+  },
+  _editInLegacyMacroBrowser: function _editInLegacyMacroBrowser() {
+    return warnDummyAPI('_editInLegacyMacroBrowser');
+  },
+  getNodeWithPosByLocalId: function getNodeWithPosByLocalId() {
+    return {
+      node: null,
+      pos: null
+    };
+  },
+  doc: {
+    insertAfter: function insertAfter() {
+      return warnDummyAPI('doc:insertAfter');
+    },
+    scrollTo: function scrollTo() {
+      return warnDummyAPI('doc:scrollTo');
+    },
+    update: function update() {
+      return warnDummyAPI('doc:update');
+    }
+  }
+};
+export var executeExtensionQuickInsertItem = function executeExtensionQuickInsertItem(_ref) {
+  var apiRef = _ref.apiRef,
+    createAnalyticsEvent = _ref.createAnalyticsEvent,
+    insert = _ref.insert,
+    item = _ref.item,
+    source = _ref.source,
+    state = _ref.state;
+  if (typeof item.node === 'function') {
+    var _apiRef$current$exten, _apiRef$current;
+    var extensionAPI = (_apiRef$current$exten = (_apiRef$current = apiRef.current) === null || _apiRef$current === void 0 || (_apiRef$current = _apiRef$current.extension) === null || _apiRef$current === void 0 || (_apiRef$current = _apiRef$current.actions) === null || _apiRef$current === void 0 ? void 0 : _apiRef$current.api()) !== null && _apiRef$current$exten !== void 0 ? _apiRef$current$exten : dummyExtensionAPI;
+    void resolveImport(item.node(extensionAPI)).then(function (node) {
+      sendAnalytics(item, state.selection, createAnalyticsEvent, source);
+      if (node && apiRef.current) {
+        apiRef.current.core.actions.execute(function (_ref2) {
+          var _safeInsert$scrollInt, _safeInsert;
+          var tr = _ref2.tr;
+          var content = processRawValue(tr.doc.type.schema, node);
+          return content ? (_safeInsert$scrollInt = (_safeInsert = safeInsert(content)(tr)) === null || _safeInsert === void 0 ? void 0 : _safeInsert.scrollIntoView()) !== null && _safeInsert$scrollInt !== void 0 ? _safeInsert$scrollInt : null : null;
+        });
+      }
+    }).catch(function (error) {
+      return logException(error, {
+        location: 'editor-core/quick-insert'
+      });
+    });
+    return insert('');
+  }
+  sendAnalytics(item, state.selection, createAnalyticsEvent, source);
+  return insert(item.node);
+};

package/dist/esm/ui/quick-insert/getExtensionQuickInsertComponents.js

@@ -0,0 +1,29 @@
+import React from 'react';
+import { getQuickInsertMenuItemParents } from '@atlaskit/editor-common/quick-insert/get-menu-item-parents';
+import { EXTENSION_ITEM_RANK } from '@atlaskit/editor-common/quick-insert/rank';
+import { ExtensionQuickInsertMenuItem } from './ExtensionQuickInsertMenuItem';
+export var getExtensionQuickInsertComponents = function getExtensionQuickInsertComponents(_ref) {
+  var apiRef = _ref.apiRef,
+    createAnalyticsEvent = _ref.createAnalyticsEvent,
+    items = _ref.items;
+  return items.map(function (item, index) {
+    var _item$priority;
+    return {
+      type: 'menu-item',
+      key: item.key,
+      parents: getQuickInsertMenuItemParents({
+        categories: item.categories,
+        rank: EXTENSION_ITEM_RANK + ((_item$priority = item.priority) !== null && _item$priority !== void 0 ? _item$priority : index)
+      }),
+      component: function component(props) {
+        var onInsert = typeof props.onInsert === 'function' ? props.onInsert : undefined;
+        return /*#__PURE__*/React.createElement(ExtensionQuickInsertMenuItem, {
+          apiRef: apiRef,
+          createAnalyticsEvent: createAnalyticsEvent,
+          item: item,
+          onInsert: onInsert
+        });
+      }
+    };
+  });
+};

package/dist/esm/utils/combineQuickInsertProviders.js

@@ -1,8 +1,12 @@
 import { combineProviders } from '@atlaskit/editor-common/provider-helpers';
 export function combineQuickInsertProviders(quickInsertProviders) {
   var _combineProviders = combineProviders(quickInsertProviders),
-    invokeList = _combineProviders.invokeList;
+    invokeList = _combineProviders.invokeList,
+    invokeOptionalList = _combineProviders.invokeOptionalList;
   return {
+    getComponents: function getComponents() {
+      return invokeOptionalList('getComponents');
+    },
     getItems: function getItems() {
       return invokeList('getItems');
     }

package/dist/esm/utils/extensions.js

@@ -8,6 +8,8 @@ import Loadable from 'react-loadable';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, fireAnalyticsEvent, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { getQuickInsertItemsFromModule, resolveImport } from '@atlaskit/editor-common/extensions';
 import { findInsertLocation } from '@atlaskit/editor-common/utils/analytics';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
+import { getExtensionQuickInsertComponents } from '../ui/quick-insert/getExtensionQuickInsertComponents';
 
 // Structural shape of the markdown-mode plugin's slice of the injection API.
 // Used to read `isMarkdownMode` without importing the `MarkdownModePlugin`
@@ -15,7 +17,7 @@ import { findInsertLocation } from '@atlaskit/editor-common/utils/analytics';
 // dependency graph and force every consuming product to rebuild.
 
 /**
- * Utils to send analytics event when a extension is inserted using quickInsert
+ * Utils to send analytics event when an extension is inserted using quickInsert
  */
 function sendExtensionQuickInsertAnalytics(item, selection, createAnalyticsEvent, source) {
   if (createAnalyticsEvent) {
@@ -29,7 +31,6 @@ function sendExtensionQuickInsertAnalytics(item, selection, createAnalyticsEvent
           extensionType: item.extensionType,
           extensionKey: item.extensionKey,
           key: item.key,
-          // @note inputMethod defaults to QUICK_INSERT if not provided
           inputMethod: source || INPUT_METHOD.QUICK_INSERT
         }, insertLocation ? {
           insertLocation: insertLocation
@@ -70,12 +71,14 @@ var dummyExtensionAPI = {
     }
   }
 };
+
+/** Creates legacy and registered Quick Insert representations for extensions. */
 export function extensionProviderToQuickInsertProvider(_x, _x2, _x3, _x4) {
   return _extensionProviderToQuickInsertProvider.apply(this, arguments);
 }
 function _extensionProviderToQuickInsertProvider() {
   _extensionProviderToQuickInsertProvider = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(extensionProvider, editorActions, apiRef, createAnalyticsEvent) {
-    var extensions;
+    var extensions, getMenuItems;
     return _regeneratorRuntime.wrap(function (_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -83,14 +86,31 @@ function _extensionProviderToQuickInsertProvider() {
           return extensionProvider.getExtensions();
         case 1:
           extensions = _context.sent;
+          getMenuItems = function getMenuItems() {
+            return getQuickInsertItemsFromModule(extensions, function (item) {
+              return item;
+            });
+          };
           return _context.abrupt("return", {
-            getItems: function getItems() {
+            getComponents: function getComponents() {
               var _apiRef$current;
+              var isMarkdownMode = (_apiRef$current = apiRef.current) === null || _apiRef$current === void 0 || (_apiRef$current = _apiRef$current.markdownMode) === null || _apiRef$current === void 0 || (_apiRef$current = _apiRef$current.sharedState.currentState()) === null || _apiRef$current === void 0 ? void 0 : _apiRef$current.isMarkdownMode;
+              if (!isExperimentEnabled('platform_editor_slash_command') || isMarkdownMode) {
+                return Promise.resolve([]);
+              }
+              return Promise.resolve(getExtensionQuickInsertComponents({
+                apiRef: apiRef,
+                createAnalyticsEvent: createAnalyticsEvent,
+                items: getMenuItems()
+              }));
+            },
+            getItems: function getItems() {
+              var _apiRef$current2;
               // `extensionProvider` is supplied independently of the preset, so
               // suppress its items in markdown mode where rich-only content cannot
               // be inserted. See `MarkdownModeReader` above for why this is read
               // via a structural cast rather than the typed plugin API.
-              var isMarkdownMode = (_apiRef$current = apiRef.current) === null || _apiRef$current === void 0 || (_apiRef$current = _apiRef$current.markdownMode) === null || _apiRef$current === void 0 || (_apiRef$current = _apiRef$current.sharedState.currentState()) === null || _apiRef$current === void 0 ? void 0 : _apiRef$current.isMarkdownMode;
+              var isMarkdownMode = (_apiRef$current2 = apiRef.current) === null || _apiRef$current2 === void 0 || (_apiRef$current2 = _apiRef$current2.markdownMode) === null || _apiRef$current2 === void 0 || (_apiRef$current2 = _apiRef$current2.sharedState.currentState()) === null || _apiRef$current2 === void 0 ? void 0 : _apiRef$current2.isMarkdownMode;
               if (isMarkdownMode) {
                 return Promise.resolve([]);
               }
@@ -121,10 +141,12 @@ function _extensionProviderToQuickInsertProvider() {
                   lozenge: item.lozenge
                 }), {}, {
                   isDisabledOffline: true,
+                  // This legacy action intentionally mirrors executeExtensionQuickInsertItem,
+                  // which serves the registered representation of the same item.
                   action: function action(insert, state, source) {
                     if (typeof item.node === 'function') {
-                      var _apiRef$current2;
-                      var extensionAPI = apiRef === null || apiRef === void 0 || (_apiRef$current2 = apiRef.current) === null || _apiRef$current2 === void 0 || (_apiRef$current2 = _apiRef$current2.extension) === null || _apiRef$current2 === void 0 || (_apiRef$current2 = _apiRef$current2.actions) === null || _apiRef$current2 === void 0 ? void 0 : _apiRef$current2.api();
+                      var _apiRef$current3;
+                      var extensionAPI = apiRef === null || apiRef === void 0 || (_apiRef$current3 = apiRef.current) === null || _apiRef$current3 === void 0 || (_apiRef$current3 = _apiRef$current3.extension) === null || _apiRef$current3 === void 0 || (_apiRef$current3 = _apiRef$current3.actions) === null || _apiRef$current3 === void 0 ? void 0 : _apiRef$current3.api();
                       // While this should only run when the extension some setups of editor
                       // may not have the extension API
                       if (extensionAPI) {
@@ -137,8 +159,7 @@ function _extensionProviderToQuickInsertProvider() {
                       } else {
                         // Originally it was understood we could only use this if we were using the extension plugin
                         // However there are some edge cases where this is not true (ie. in jira)
-                        // Since making it optional now would be a breaking change - instead we can just pass a dummy
-                        // extension API to consumers that warns them of using the methods.
+                        // Since making it optional now would be a breaking change - instead we can just pass a dummy extension API to consumers that warns them of using the methods.
                         resolveImport(item.node(dummyExtensionAPI)).then(function (node) {
                           sendExtensionQuickInsertAnalytics(item, state.selection, createAnalyticsEvent, source);
                           if (node) {

package/dist/esm/version-wrapper.js

@@ -1,3 +1,3 @@
 export var name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export var version = "223.0.5";
+export var version = "223.0.7";

package/dist/types/ui/quick-insert/ExtensionQuickInsertIcon.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import type { MenuItem } from '@atlaskit/editor-common/extensions';
+export declare const ExtensionQuickInsertIcon: ({ getIcon, label, }: {
+    getIcon?: MenuItem['icon'];
+    label: string;
+}) => React.JSX.Element;

package/dist/types/ui/quick-insert/ExtensionQuickInsertMenuItem.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
+import type { MenuItem } from '@atlaskit/editor-common/extensions';
+import type { PublicPluginAPI } from '@atlaskit/editor-common/types';
+import type { ExtensionPlugin } from '@atlaskit/editor-plugins/extension';
+export declare const ExtensionQuickInsertMenuItem: ({ apiRef, createAnalyticsEvent, item, onInsert, }: {
+    apiRef: React.MutableRefObject<PublicPluginAPI<[ExtensionPlugin]> | undefined>;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+    item: MenuItem;
+    onInsert?: () => void;
+}) => React.JSX.Element;

package/dist/types/ui/quick-insert/executeExtensionQuickInsertItem.d.ts

@@ -0,0 +1,16 @@
+import type React from 'react';
+import type { EditorState, Transaction } from 'prosemirror-state';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { MenuItem } from '@atlaskit/editor-common/extensions';
+import type { QuickInsertActionInsert } from '@atlaskit/editor-common/provider-factory';
+import type { PublicPluginAPI } from '@atlaskit/editor-common/types';
+import type { ExtensionPlugin } from '@atlaskit/editor-plugins/extension';
+export declare const executeExtensionQuickInsertItem: ({ apiRef, createAnalyticsEvent, insert, item, source, state, }: {
+    apiRef: React.MutableRefObject<PublicPluginAPI<[ExtensionPlugin]> | undefined>;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+    insert: QuickInsertActionInsert;
+    item: MenuItem;
+    source?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.ELEMENT_BROWSER;
+    state: EditorState;
+}) => Transaction | false;

package/dist/types/ui/quick-insert/getExtensionQuickInsertComponents.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
+import type { MenuItem } from '@atlaskit/editor-common/extensions';
+import type { PublicPluginAPI } from '@atlaskit/editor-common/types';
+import type { ExtensionPlugin } from '@atlaskit/editor-plugins/extension';
+import type { RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+export declare const getExtensionQuickInsertComponents: ({ apiRef, createAnalyticsEvent, items, }: {
+    apiRef: React.MutableRefObject<PublicPluginAPI<[ExtensionPlugin]> | undefined>;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+    items: MenuItem[];
+}) => RegisterMenuItem[];

package/dist/types/utils/extensions.d.ts

@@ -5,4 +5,5 @@ import type { QuickInsertProvider } from '@atlaskit/editor-common/provider-facto
 import type { PublicPluginAPI } from '@atlaskit/editor-common/types';
 import type { ExtensionPlugin } from '@atlaskit/editor-plugins/extension';
 import type EditorActions from '../actions';
+/** Creates legacy and registered Quick Insert representations for extensions. */
 export declare function extensionProviderToQuickInsertProvider(extensionProvider: ExtensionProvider, editorActions: EditorActions, apiRef: React.MutableRefObject<PublicPluginAPI<[ExtensionPlugin]> | undefined>, createAnalyticsEvent?: CreateUIAnalyticsEvent): Promise<QuickInsertProvider>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "223.0.6",
+	"version": "223.1.0",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -48,7 +48,7 @@
 		"@atlaskit/editor-json-transformer": "^9.2.0",
 		"@atlaskit/editor-performance-metrics": "^3.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^14.0.0",
-		"@atlaskit/editor-plugin-quick-insert": "^14.0.0",
+		"@atlaskit/editor-plugin-quick-insert": "^14.1.0",
 		"@atlaskit/editor-plugin-user-preferences": "^12.0.0",
 		"@atlaskit/editor-plugins": "^15.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
@@ -86,7 +86,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^118.4.0",
+		"@atlaskit/editor-common": "^118.8.0",
 		"@atlaskit/link-provider": "^5.3.0",
 		"@atlaskit/media-core": "^38.0.0",
 		"react": "^18.2.0",
@@ -169,9 +169,6 @@
 		"platform_comment_container_query": {
 			"type": "boolean"
 		},
-		"platform_editor_reconfigure_filter_plugins": {
-			"type": "boolean"
-		},
 		"platform_editor_reconfigure_reconcile_plugin_api": {
 			"type": "boolean"
 		},
@@ -293,9 +290,6 @@
 		"platform-dst-top-layer-tooltip": {
 			"type": "boolean",
 			"referenceOnly": true
-		},
-		"platform_editor_table_q4_patch_1": {
-			"type": "boolean"
 		}
 	},
 	"stricter": {