@atlaskit/editor-core 179.0.3 → 179.1.0

package/dist/esm/create-editor/create-plugins-list.js

@@ -1,15 +1,10 @@
-import _typeof from "@babel/runtime/helpers/typeof";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-import { breakoutPlugin, collabEditPlugin, dataConsumerMarkPlugin, datePlugin, emojiPlugin, extensionPlugin, fragmentMarkPlugin, helpDialogPlugin, imageUploadPlugin, insertBlockPlugin, jiraIssuePlugin, layoutPlugin, listPlugin, toolbarListsIndentationPlugin, macroPlugin, maxContentSizePlugin, mediaPlugin, mentionsPlugin, panelPlugin, placeholderTextPlugin, rulePlugin, saveOnEnterPlugin, tasksAndDecisionsPlugin, textColorPlugin, cardPlugin, gridPlugin, statusPlugin, alignmentPlugin, indentationPlugin, analyticsPlugin, customAutoformatPlugin, feedbackDialogPlugin, historyPlugin, expandPlugin, isExpandInsertionEnabled, scrollIntoViewPlugin, mobileDimensionsPlugin, findReplacePlugin, contextPanelPlugin, mobileSelectionPlugin, annotationPlugin, captionPlugin, avatarGroupPlugin, viewUpdateSubscriptionPlugin, beforePrimaryToolbarPlugin, codeBidiWarningPlugin, copyButtonPlugin } from '../plugins';
-import { tablesPlugin } from '@atlaskit/editor-plugin-table';
-import { isFullPage as fullPageCheck } from '../utils/is-full-page';
+import createUniversalPreset from '../labs/next/presets/universal';
 import { GUTTER_SIZE_MOBILE_IN_PX } from '../plugins/base/pm-plugins/scroll-gutter';
-import { createFeatureFlagsFromProps } from '../plugins/feature-flags-context/feature-flags-from-props';
-import { getMediaFeatureFlag } from '@atlaskit/media-common';
-import { createDefaultPreset } from '../labs/next/presets/default';
-import { shouldForceTracking } from '@atlaskit/editor-common/utils';
+import { isFullPage as fullPageCheck } from '../utils/is-full-page';
+import { createFeatureFlagsFromProps } from './feature-flags-from-props';
 var isCodeBlockAllowed = function isCodeBlockAllowed(options) {
   var exclude = options && options.allowBlockType && options.allowBlockType.exclude ? options.allowBlockType.exclude : [];
   return exclude.indexOf('codeBlock') === -1;
@@ -44,7 +39,7 @@ export function getDefaultPresetOptionsFromEditorProps(props, createAnalyticsEve
   var isMobile = appearance === 'mobile';
   var inputTracking = (_props$performanceTra = props.performanceTracking) === null || _props$performanceTra === void 0 ? void 0 : _props$performanceTra.inputTracking;
   var cardOptions = ((_props$linking = props.linking) === null || _props$linking === void 0 ? void 0 : _props$linking.smartLinks) || props.smartLinks || props.UNSAFE_cards;
-  return {
+  return _objectSpread(_objectSpread({}, props), {}, {
     createAnalyticsEvent: createAnalyticsEvent,
     typeAhead: {
       createAnalyticsEvent: createAnalyticsEvent,
@@ -97,7 +92,7 @@ export function getDefaultPresetOptionsFromEditorProps(props, createAnalyticsEve
       appearance: props.appearance,
       allowCompositionInputOverride: isMobile
     })
-  };
+  });
 }
 
 /**
@@ -107,283 +102,7 @@ export function getDefaultPresetOptionsFromEditorProps(props, createAnalyticsEve
  * their placement in the editor toolbar
  */
 export default function createPluginsList(props, prevProps, createAnalyticsEvent, insertNodeAPI, editorAnalyticsAPI, editorSelectionAPI, getEditorContainerWidth) {
-  var _props$linking3;
-  var appearance = props.appearance;
-  var isMobile = appearance === 'mobile';
-  var isComment = appearance === 'comment';
-  var isFullPage = fullPageCheck(appearance);
-  var preset = createDefaultPreset(getDefaultPresetOptionsFromEditorProps(props, createAnalyticsEvent));
-  var featureFlags = createFeatureFlagsFromProps(props);
-  var getEditorFeatureFlags = function getEditorFeatureFlags() {
-    return featureFlags;
-  };
-  if (props.allowAnalyticsGASV3) {
-    var performanceTracking = props.performanceTracking;
-    preset.add([analyticsPlugin, {
-      createAnalyticsEvent: createAnalyticsEvent,
-      performanceTracking: performanceTracking
-    }]);
-  }
-  if (props.allowBreakout && isFullPage) {
-    preset.add([breakoutPlugin, {
-      allowBreakoutButton: props.appearance === 'full-page'
-    }]);
-  }
-  if (props.allowTextAlignment) {
-    preset.add(alignmentPlugin);
-  }
-  preset.add(dataConsumerMarkPlugin);
-  if (props.allowTextColor) {
-    preset.add([textColorPlugin, props.allowTextColor]);
-  }
-
-  // Needs to be after allowTextColor as order of buttons in toolbar depends on it
-  preset.add([listPlugin, {
-    restartNumberedLists: featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.restartNumberedLists,
-    restartNumberedListsToolbar: featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.restartNumberedListsToolbar,
-    listNumberContinuity: featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.listNumberContinuity
-  }]);
-  if (props.allowRule) {
-    preset.add(rulePlugin);
-  }
-  if (props.allowExpand) {
-    preset.add([expandPlugin, {
-      allowInsertion: isExpandInsertionEnabled(props),
-      useLongPressSelection: false,
-      appearance: props.appearance
-    }]);
-  }
-  if (props.media) {
-    preset.add([gridPlugin, {
-      shouldCalcBreakoutGridLines: isFullPage
-    }]);
-    var alignLeftOnInsert = typeof props.media.alignLeftOnInsert !== 'undefined' ? props.media.alignLeftOnInsert : isComment;
-    var showMediaLayoutOptions = typeof props.media.allowAdvancedToolBarOptions !== 'undefined' ? props.media.allowAdvancedToolBarOptions : isFullPage || isComment;
-    preset.add([mediaPlugin, _objectSpread(_objectSpread({}, props.media), {}, {
-      allowLazyLoading: !isMobile,
-      allowBreakoutSnapPoints: isFullPage,
-      allowAdvancedToolBarOptions: showMediaLayoutOptions,
-      allowDropzoneDropLine: isFullPage,
-      allowMediaSingleEditable: !isMobile,
-      allowRemoteDimensionsFetch: !isMobile,
-      editorSelectionAPI: editorSelectionAPI,
-      // This is a wild one. I didnt quite understand what the code was doing
-      // so a bit of guess for now.
-      allowMarkingUploadsAsIncomplete: isMobile,
-      fullWidthEnabled: props.appearance === 'full-width',
-      uploadErrorHandler: props.uploadErrorHandler,
-      waitForMediaUpload: props.waitForMediaUpload,
-      isCopyPasteEnabled: !isMobile,
-      alignLeftOnInsert: alignLeftOnInsert
-    })]);
-
-    // EDM-799: inside caption plugin we do the feature flag in enabling the plugin
-    if (getMediaFeatureFlag('captions', props.media.featureFlags)) {
-      preset.add(captionPlugin);
-    }
-  }
-  if (props.mentionProvider) {
-    var _props$mention$insert, _props$mention, _props$mention2;
-    preset.add([mentionsPlugin, {
-      createAnalyticsEvent: createAnalyticsEvent,
-      sanitizePrivateContent: props.sanitizePrivateContent,
-      insertDisplayName: (_props$mention$insert = (_props$mention = props.mention) === null || _props$mention === void 0 ? void 0 : _props$mention.insertDisplayName) !== null && _props$mention$insert !== void 0 ? _props$mention$insert : props.mentionInsertDisplayName,
-      allowZeroWidthSpaceAfter: !isMobile,
-      HighlightComponent: (_props$mention2 = props.mention) === null || _props$mention2 === void 0 ? void 0 : _props$mention2.HighlightComponent
-    }]);
-  }
-  if (props.emojiProvider) {
-    preset.add([emojiPlugin, {
-      createAnalyticsEvent: createAnalyticsEvent
-    }]);
-  }
-  if (props.allowTables) {
-    var tableOptions = !props.allowTables || typeof props.allowTables === 'boolean' ? {} : props.allowTables;
-    preset.add([tablesPlugin, {
-      tableOptions: tableOptions,
-      breakoutEnabled: props.appearance === 'full-page',
-      allowContextualMenu: !isMobile,
-      fullWidthEnabled: props.appearance === 'full-width',
-      wasFullWidthEnabled: prevProps && prevProps.appearance === 'full-width',
-      editorAnalyticsAPI: editorAnalyticsAPI,
-      editorSelectionAPI: editorSelectionAPI,
-      getEditorFeatureFlags: getEditorFeatureFlags
-    }]);
-  }
-  if (props.allowTasksAndDecisions || props.taskDecisionProvider) {
-    preset.add([tasksAndDecisionsPlugin, {
-      allowNestedTasks: props.allowNestedTasks,
-      consumeTabs: isFullPage,
-      useLongPressSelection: false
-    }]);
-  }
-  if (props.feedbackInfo) {
-    preset.add([feedbackDialogPlugin, props.feedbackInfo]);
-  }
-  if (props.allowHelpDialog) {
-    preset.add([helpDialogPlugin, !!props.legacyImageUploadProvider]);
-  }
-  if (props.saveOnEnter && props.onSave) {
-    preset.add([saveOnEnterPlugin, props.onSave]);
-  }
-  if (props.legacyImageUploadProvider) {
-    preset.add(imageUploadPlugin);
-    if (!props.media) {
-      preset.add([mediaPlugin, {
-        allowMediaSingle: {
-          disableLayout: true
-        },
-        allowMediaGroup: false,
-        isCopyPasteEnabled: true,
-        editorSelectionAPI: editorSelectionAPI
-      }]);
-    }
-  }
-  if (props.collabEdit || props.collabEditProvider) {
-    var _collabEditOptions$EX;
-    var collabEditOptions = {
-      sanitizePrivateContent: props.sanitizePrivateContent,
-      createAnalyticsEvent: createAnalyticsEvent
-    };
-    if (props.collabEdit) {
-      collabEditOptions = _objectSpread(_objectSpread({}, props.collabEdit), collabEditOptions);
-    }
-    preset.add([collabEditPlugin, _objectSpread(_objectSpread({}, collabEditOptions), {}, {
-      EXPERIMENTAL_allowInternalErrorAnalytics: (_collabEditOptions$EX = collabEditOptions.EXPERIMENTAL_allowInternalErrorAnalytics) !== null && _collabEditOptions$EX !== void 0 ? _collabEditOptions$EX : shouldForceTracking()
-    })]);
-  }
-  if (props.maxContentSize) {
-    preset.add([maxContentSizePlugin, props.maxContentSize]);
-  }
-  if (props.allowJiraIssue) {
-    preset.add(jiraIssuePlugin);
-  }
-  if (props.allowPanel) {
-    preset.add([panelPlugin, {
-      useLongPressSelection: false,
-      allowCustomPanel: props.allowPanel.allowCustomPanel,
-      allowCustomPanelEdit: props.allowPanel.allowCustomPanelEdit
-    }]);
-  }
-  if (props.allowExtension) {
-    var extensionConfig = _typeof(props.allowExtension) === 'object' ? props.allowExtension : {};
-    preset.add([extensionPlugin, {
-      breakoutEnabled: props.appearance === 'full-page' && extensionConfig.allowBreakout !== false,
-      allowAutoSave: extensionConfig.allowAutoSave,
-      extensionHandlers: props.extensionHandlers,
-      useLongPressSelection: false,
-      appearance: appearance
-    }]);
-  }
-  if (props.macroProvider) {
-    preset.add(macroPlugin);
-  }
-
-  // See default list for when adding annotations with a provider
-  if (!props.annotationProviders && props.allowConfluenceInlineComment) {
-    preset.add([annotationPlugin, undefined]);
-  }
-  if (props.allowDate) {
-    preset.add(datePlugin);
-  }
-  if (props.allowTemplatePlaceholders) {
-    var options = props.allowTemplatePlaceholders !== true ? props.allowTemplatePlaceholders : {};
-    preset.add([placeholderTextPlugin, options]);
-  }
-  if (props.allowLayouts) {
-    preset.add([layoutPlugin, _objectSpread(_objectSpread({}, typeof props.allowLayouts === 'boolean' ? {} : props.allowLayouts), {}, {
-      useLongPressSelection: false,
-      UNSAFE_allowSingleColumnLayout: props.allowLayouts.UNSAFE_allowSingleColumnLayout
-    })]);
-  }
-  if ((_props$linking3 = props.linking) !== null && _props$linking3 !== void 0 && _props$linking3.smartLinks || props.smartLinks || props.UNSAFE_cards) {
-    var _props$linking4, _props$linking5;
-    var fullWidthMode = props.appearance === 'full-width';
-    preset.add([cardPlugin, _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, props.UNSAFE_cards), props.smartLinks), (_props$linking4 = props.linking) === null || _props$linking4 === void 0 ? void 0 : _props$linking4.smartLinks), {}, {
-      platform: isMobile ? 'mobile' : 'web',
-      fullWidthMode: fullWidthMode,
-      createAnalyticsEvent: createAnalyticsEvent,
-      linkPicker: (_props$linking5 = props.linking) === null || _props$linking5 === void 0 ? void 0 : _props$linking5.linkPicker
-    })]);
-  }
-  if (props.autoformattingProvider) {
-    preset.add(customAutoformatPlugin);
-  }
-  var statusMenuDisabled = true;
-  if (props.allowStatus) {
-    statusMenuDisabled = _typeof(props.allowStatus) === 'object' ? props.allowStatus.menuDisabled : false;
-    preset.add([statusPlugin, {
-      menuDisabled: statusMenuDisabled,
-      allowZeroWidthSpaceAfter: !isMobile
-    }]);
-  }
-  if (props.allowIndentation) {
-    preset.add(indentationPlugin);
-  }
-  if (isFullPage) {
-    preset.add(contextPanelPlugin);
-  }
-  if (props.autoScrollIntoView !== false) {
-    preset.add(scrollIntoViewPlugin);
-  }
-  if (isMobile || props.allowUndoRedoButtons) {
-    preset.add(historyPlugin);
-  }
-  if (isMobile) {
-    preset.add(mobileDimensionsPlugin);
-    preset.add(mobileSelectionPlugin);
-  }
-
-  // UI only plugins
-  preset.add([toolbarListsIndentationPlugin, {
-    showIndentationButtons: !!featureFlags.indentationButtonsInTheToolbar,
-    allowHeadingAndParagraphIndentation: !!props.allowIndentation
-  }]);
-  preset.add([insertBlockPlugin, {
-    allowTables: !!props.allowTables,
-    allowExpand: isExpandInsertionEnabled(props),
-    insertMenuItems: props.insertMenuItems,
-    horizontalRuleEnabled: props.allowRule,
-    nativeStatusSupported: !statusMenuDisabled,
-    showElementBrowserLink: props.elementBrowser && props.elementBrowser.showModal || false,
-    replacePlusMenuWithElementBrowser: props.elementBrowser && props.elementBrowser.replacePlusMenu || false,
-    insertNodeAPI: insertNodeAPI
-  }]);
-  var hasBeforePrimaryToolbar = function hasBeforePrimaryToolbar(components) {
-    if (components && 'before' in components) {
-      return !!components.before;
-    }
-    return false;
-  };
-  if (hasBeforePrimaryToolbar(props.primaryToolbarComponents) && !featureFlags.twoLineEditorToolbar) {
-    preset.add([beforePrimaryToolbarPlugin, {
-      beforePrimaryToolbarComponents: props.primaryToolbarComponents.before
-    }]);
-  }
-  if (featureFlags.showAvatarGroupAsPlugin === true && !featureFlags.twoLineEditorToolbar) {
-    preset.add([avatarGroupPlugin, {
-      collabEdit: props.collabEdit,
-      takeFullWidth: !hasBeforePrimaryToolbar(props.primaryToolbarComponents)
-    }]);
-  }
-  if (props.allowFindReplace) {
-    preset.add([findReplacePlugin, {
-      takeFullWidth: !!featureFlags.showAvatarGroupAsPlugin === false && !hasBeforePrimaryToolbar(props.primaryToolbarComponents),
-      twoLineEditorToolbar: !!featureFlags.twoLineEditorToolbar
-    }]);
-  }
-  if (props.allowFragmentMark) {
-    preset.add(fragmentMarkPlugin);
-  }
-  if (featureFlags.enableViewUpdateSubscription) {
-    preset.add(viewUpdateSubscriptionPlugin);
-  }
-  preset.add([codeBidiWarningPlugin, {
-    appearance: props.appearance
-  }]);
-  if (featureFlags.floatingToolbarCopyButton) {
-    preset.add(copyButtonPlugin);
-  }
+  var preset = createUniversalPreset(props.appearance, getDefaultPresetOptionsFromEditorProps(props, createAnalyticsEvent), createFeatureFlagsFromProps(props), prevProps === null || prevProps === void 0 ? void 0 : prevProps.appearance, createAnalyticsEvent, insertNodeAPI, editorAnalyticsAPI, editorSelectionAPI, getEditorContainerWidth);
   var excludes = new Set();
   if (!isCodeBlockAllowed({
     allowBlockType: props.allowBlockType

package/dist/esm/editor.js

@@ -35,10 +35,10 @@ import { PortalProviderWithThemeProviders, PortalRenderer } from './ui/PortalPro
 import { nextMajorVersion } from './version-wrapper';
 import { ContextAdapter } from './nodeviews/context-adapter';
 import measurements from './utils/performance/measure-enum';
-import { combineQuickInsertProviders, extensionProviderToQuickInsertProvider } from './utils/extensions';
+import prepareQuickInsertProvider from './utils/prepare-quick-insert-provider';
 import { fireAnalyticsEvent, EVENT_TYPE, ACTION_SUBJECT, ACTION } from './plugins/analytics';
 import ErrorBoundary from './create-editor/ErrorBoundary';
-import { createFeatureFlagsFromProps } from './plugins/feature-flags-context/feature-flags-from-props';
+import { createFeatureFlagsFromProps } from './create-editor/feature-flags-from-props';
 import { RenderTracking } from './utils/performance/components/RenderTracking';
 var fullHeight = css(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  height: 100%;\n"])));
 var Editor = /*#__PURE__*/function (_React$Component) {
@@ -59,9 +59,7 @@ var Editor = /*#__PURE__*/function (_React$Component) {
       return combineExtensionProviders(extensionProviders);
     }));
     _defineProperty(_assertThisInitialized(_this), "prepareQuickInsertProvider", function (extensionProvider, quickInsert) {
-      var quickInsertProvider = quickInsert && typeof quickInsert !== 'boolean' && quickInsert.provider;
-      var extensionQuickInsertProvider = extensionProvider && extensionProviderToQuickInsertProvider(extensionProvider, _this.editorActions, _this.createAnalyticsEvent);
-      return quickInsertProvider && extensionQuickInsertProvider ? combineQuickInsertProviders([quickInsertProvider, extensionQuickInsertProvider]) : quickInsertProvider || extensionQuickInsertProvider;
+      return prepareQuickInsertProvider(_this.editorActions, extensionProvider, quickInsert, _this.createAnalyticsEvent);
     });
     _defineProperty(_assertThisInitialized(_this), "handleSave", function (view) {
       if (!_this.props.onSave) {
@@ -121,10 +119,10 @@ var Editor = /*#__PURE__*/function (_React$Component) {
       }, (_props$performanceTra5 = props.performanceTracking) === null || _props$performanceTra5 === void 0 ? void 0 : (_props$performanceTra6 = _props$performanceTra5.ttiTracking) === null || _props$performanceTra6 === void 0 ? void 0 : _props$performanceTra6.ttiIdleThreshold, (_props$performanceTra7 = props.performanceTracking) === null || _props$performanceTra7 === void 0 ? void 0 : (_props$performanceTra8 = _props$performanceTra7.ttiTracking) === null || _props$performanceTra8 === void 0 ? void 0 : _props$performanceTra8.ttiCancelTimeout);
     }
     var _extensionProvider = _this.prepareExtensionProvider(props.extensionProviders);
-    var _quickInsertProvider = _this.prepareQuickInsertProvider(_extensionProvider, props.quickInsert);
+    var quickInsertProvider = _this.prepareQuickInsertProvider(_extensionProvider, props.quickInsert);
     _this.state = {
       extensionProvider: _extensionProvider,
-      quickInsertProvider: _quickInsertProvider
+      quickInsertProvider: quickInsertProvider
     };
     return _this;
   }
@@ -173,6 +171,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
         });
       }
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an anti-pattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "trackEditorActions",
     value: function trackEditorActions(editorActions, props) {
@@ -259,9 +264,23 @@ var Editor = /*#__PURE__*/function (_React$Component) {
       }
       return editorActions;
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "onEditorCreated",
-    value: function onEditorCreated(instance) {
+    value:
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
+    function onEditorCreated(instance) {
       var _this$props$featureFl2;
       this.registerEditorForActions(instance.view, instance.eventDispatcher, instance.transformer);
       if ((_this$props$featureFl2 = this.props.featureFlags) !== null && _this$props$featureFl2 !== void 0 && _this$props$featureFl2.ufo) {
@@ -365,6 +384,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
         console.warn("\"allowMoreTextColors\" field of \"allowTextColor\" property is deprecated. It will be removedin editor-core@".concat(nextVersion, ". The color palette now shows more colors by default."));
       }
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "onEditorDestroyed",
     value: function onEditorDestroyed(_instance) {
@@ -436,6 +462,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
     value: function getBaseFontSize() {
       return !['comment', 'chromeless', 'mobile'].includes(this.props.appearance) ? akEditorFullPageDefaultFontSize : undefined;
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "render",
     value: function render() {