@atlaskit/editor-common 72.1.2 → 72.2.1

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "72.1.2",
+	"version": "72.2.1",
 	"sideEffects": false
 }

package/dist/esm/with-plugin-state/index.js

@@ -5,15 +5,10 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 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; }
-
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
 import React from 'react';
 import PropTypes from 'prop-types';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '../analytics';
@@ -22,7 +17,6 @@ import { analyticsEventKey, startMeasure, stopMeasure } from '../utils';
 import { getParticipantsCount } from '../utils/collab';
 var DEFAULT_SAMPLING_RATE = 100;
 var DEFAULT_SLOW_THRESHOLD = 4;
-
 /**
  * Wraps component in a high order component that watches state changes of given plugins
  * and passes those states to the wrapped component.
@@ -41,32 +35,20 @@ var DEFAULT_SLOW_THRESHOLD = 4;
  */
 var WithPluginState = /*#__PURE__*/function (_React$Component) {
   _inherits(WithPluginState, _React$Component);
-
   var _super = _createSuper(WithPluginState);
-
   function WithPluginState() {
     var _this;
-
     _classCallCheck(this, WithPluginState);
-
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-
     _this = _super.call.apply(_super, [this].concat(args));
-
     _defineProperty(_assertThisInitialized(_this), "listeners", {});
-
     _defineProperty(_assertThisInitialized(_this), "debounce", null);
-
     _defineProperty(_assertThisInitialized(_this), "notAppliedState", {});
-
     _defineProperty(_assertThisInitialized(_this), "isSubscribed", false);
-
     _defineProperty(_assertThisInitialized(_this), "callsCount", 0);
-
     _defineProperty(_assertThisInitialized(_this), "state", _this.getPluginsStates(_this.props.plugins, _this.getEditorView(_this.props, _this.context)));
-
     _defineProperty(_assertThisInitialized(_this), "handlePluginStateChange", function (propName, pluginName, performanceOptions, skipEqualityCheck) {
       return function (pluginState) {
         // skipEqualityCheck is being used for old plugins since they are mutating plugin state instead of creating a new one
@@ -79,17 +61,14 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
         }
       };
     });
-
     _defineProperty(_assertThisInitialized(_this), "updateState", function (_ref) {
       var stateSubset = _ref.stateSubset,
-          pluginName = _ref.pluginName,
-          performanceOptions = _ref.performanceOptions;
+        pluginName = _ref.pluginName,
+        performanceOptions = _ref.performanceOptions;
       _this.notAppliedState = _objectSpread(_objectSpread({}, _this.notAppliedState), stateSubset);
-
       if (_this.debounce) {
         window.clearTimeout(_this.debounce);
       }
-
       var debounce = _this.props.debounce !== false ? function (fn) {
         return window.setTimeout(fn, 0);
       } : function (fn) {
@@ -98,13 +77,11 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       _this.debounce = debounce(function () {
         var measure = "\uD83E\uDD89".concat(pluginName, "::WithPluginState");
         performanceOptions.trackingEnabled && startMeasure(measure);
-
         _this.setState(_this.notAppliedState, function () {
           performanceOptions.trackingEnabled && stopMeasure(measure, function (duration) {
             // Each WithPluginState component will fire analytics event no more than once every `samplingLimit` times
             if (++_this.callsCount % performanceOptions.samplingRate === 0 && duration > performanceOptions.slowThreshold) {
               var _editorView = _this.getEditorView();
-
               _this.dispatchAnalyticsEvent({
                 action: ACTION.WITH_PLUGIN_STATE_CALLED,
                 actionSubject: ACTION_SUBJECT.EDITOR,
@@ -118,15 +95,12 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
             }
           });
         });
-
         _this.debounce = null;
         _this.notAppliedState = {};
       });
     });
-
     _defineProperty(_assertThisInitialized(_this), "dispatchAnalyticsEvent", function (payload) {
       var eventDispatcher = _this.getEventDispatcher();
-
       if (eventDispatcher) {
         var dispatch = createDispatch(eventDispatcher);
         dispatch(analyticsEventKey, {
@@ -134,14 +108,11 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
         });
       }
     });
-
     _defineProperty(_assertThisInitialized(_this), "onContextUpdate", function () {
       _this.subscribe(_this.props);
     });
-
     return _this;
   }
-
   _createClass(WithPluginState, [{
     key: "getEditorView",
     value: function getEditorView(maybeProps, maybeContext) {
@@ -161,15 +132,12 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       if (!editorView || !plugins) {
         return {};
       }
-
       var keys = Object.keys(plugins);
       return keys.reduce(function (acc, propName) {
         var pluginKey = plugins[propName];
-
         if (!pluginKey) {
           return acc;
         }
-
         acc[propName] = pluginKey.getState(editorView.state);
         return acc;
       }, {});
@@ -178,20 +146,18 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
     key: "subscribe",
     value: function subscribe(props) {
       var _uiTracking$samplingR,
-          _uiTracking$slowThres,
-          _this2 = this;
-
+        _uiTracking$slowThres,
+        _this2 = this;
       var plugins = props.plugins;
       var eventDispatcher = this.getEventDispatcher(props);
       var editorView = this.getEditorView(props);
-
       if (!eventDispatcher || !editorView || this.isSubscribed) {
         return;
-      } // TODO: ED-15663
+      }
+
+      // TODO: ED-15663
       // Please, do not copy or use this kind of code below
       // @ts-ignore
-
-
       var fakePluginKey = {
         key: 'analyticsPlugin$',
         getState: function getState(state) {
@@ -208,27 +174,22 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       this.setState(pluginsStates);
       Object.keys(plugins).forEach(function (propName) {
         var pluginKey = plugins[propName];
-
         if (!pluginKey) {
           return;
         }
-
         var pluginName = pluginKey.key;
         var pluginState = pluginsStates[propName];
         var isPluginWithSubscribe = pluginState && pluginState.subscribe;
-
         var handler = _this2.handlePluginStateChange(propName, pluginName, {
           samplingRate: samplingRate,
           slowThreshold: slowThreshold,
           trackingEnabled: trackingEnabled
         }, isPluginWithSubscribe);
-
         if (isPluginWithSubscribe) {
           pluginState.subscribe(handler);
         } else {
           eventDispatcher.on(pluginKey.key, handler);
         }
-
         _this2.listeners[pluginKey.key] = {
           handler: handler,
           pluginKey: pluginKey
@@ -239,17 +200,13 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
     key: "unsubscribe",
     value: function unsubscribe() {
       var _this3 = this;
-
       var eventDispatcher = this.getEventDispatcher();
       var editorView = this.getEditorView();
-
       if (!eventDispatcher || !editorView || !this.isSubscribed) {
         return;
       }
-
       Object.keys(this.listeners).forEach(function (key) {
         var pluginState = _this3.listeners[key].pluginKey.getState(editorView.state);
-
         if (pluginState && pluginState.unsubscribe) {
           pluginState.unsubscribe(_this3.listeners[key].handler);
         } else {
@@ -291,7 +248,6 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       if (this.debounce) {
         window.clearTimeout(this.debounce);
       }
-
       this.unsubscribeFromContextUpdates(this.context);
       this.unsubscribe();
     }
@@ -302,15 +258,11 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       return render(this.state);
     }
   }]);
-
   return WithPluginState;
 }(React.Component);
-
 _defineProperty(WithPluginState, "displayName", 'WithPluginState');
-
 _defineProperty(WithPluginState, "contextTypes", {
   editorActions: PropTypes.object,
   editorSharedConfig: PropTypes.object
 });
-
 export { WithPluginState };

package/dist/types/analytics/types/enums.d.ts

@@ -89,7 +89,7 @@ export declare enum ACTION {
     SYNCHRONY_ENTITY_ERROR = "synchronyEntityError",
     SYNCHRONY_ERROR = "synchronyError",
     TEXT_LINK_MARK_TRANSFORMED = "textLinkMarkTransformed",
-    DEDUPE_MARKS_TRANSFORMED = "dedupeMarksTransformed",
+    DEDUPE_MARKS_TRANSFORMED_V2 = "dedupeMarksTransformedV2",
     NODES_MISSING_CONTENT_TRANSFORMED = "nodesMissingContentTransformed",
     INDENTATION_MARKS_TRANSFORMED = "indentationMarksTransformed",
     INVALID_MEDIA_CONTENT_TRANSFORMED = "invalidMediaContentTransformed",

package/dist/types/analytics/types/events.d.ts

@@ -90,13 +90,14 @@ declare type SynchronyEntityErrorAEP = OperationalAEP<ACTION.SYNCHRONY_ENTITY_ER
 declare type ContentComponentErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.CONTENT_COMPONENT, undefined, {
     component: CONTENT_COMPONENT;
     error: string;
-    errorStack?: string;
     selection: {
         [key: string]: string;
     };
     position: number;
     docSize: number;
-}, undefined>;
+}, {
+    errorStack?: string;
+}>;
 export declare type ErrorEventAttributes = {
     error: Error;
     errorInfo: React.ErrorInfo;

package/dist/types/analytics/types/general-events.d.ts

@@ -1,5 +1,4 @@
 import type { RichMediaLayout } from '@atlaskit/adf-schema';
-import type { ADFEntityMark } from '@atlaskit/adf-utils/types';
 import type { FeatureFlagKey } from '../../types/feature-flags';
 import { PropsDifference, ShallowPropsDifference } from '../../utils';
 import type { SEVERITY } from '../../utils/analytics';
@@ -172,8 +171,14 @@ declare type CodeBlockLanguageSelectedAEP = TrackAEP<ACTION.LANGUAGE_SELECTED, A
 }, undefined>;
 declare type MediaLinkTransformedAEP = OperationalAEP<ACTION.MEDIA_LINK_TRANSFORMED, ACTION_SUBJECT.EDITOR, undefined, undefined, undefined>;
 declare type TextLinkCodeMarkTransformedAEP = OperationalAEP<ACTION.TEXT_LINK_MARK_TRANSFORMED, ACTION_SUBJECT.EDITOR, undefined, undefined, undefined>;
-declare type DedupeMarksTransformedAEP = OperationalAEP<ACTION.DEDUPE_MARKS_TRANSFORMED, ACTION_SUBJECT.EDITOR, undefined, {
-    discardedMarks: ADFEntityMark[];
+declare type DedupeMarksTransformedAEP = OperationalAEP<ACTION.DEDUPE_MARKS_TRANSFORMED_V2, ACTION_SUBJECT.EDITOR, undefined, 
+/** UGC WARNING
+ *
+ * DO NOT include `mark` attributes - only the types
+ *
+ */
+{
+    discardedMarkTypes: string[];
 }, undefined>;
 declare type IndentationMarksTransformedAEP = OperationalAEP<ACTION.INDENTATION_MARKS_TRANSFORMED, ACTION_SUBJECT.EDITOR, undefined, undefined, undefined>;
 declare type NodesMissingContentTransformedAEP = OperationalAEP<ACTION.NODES_MISSING_CONTENT_TRANSFORMED, ACTION_SUBJECT.EDITOR, undefined, undefined, undefined>;

package/dist/types/types/editor-plugin.d.ts

@@ -9,9 +9,20 @@ import type { TypeAheadHandler } from './type-ahead';
 import type { UIComponentFactory } from './ui-components';
 export declare type PluginsOptions = {
     [pluginName: string]: any;
+    /**
+     * Handler returns an array of QuickInsertItem that are added to the Element Browser, Insert Menu and Quick Insert
+     */
     quickInsert?: QuickInsertHandler;
     typeAhead?: TypeAheadHandler;
+    /**
+     * See: `FloatingToolbarConfig`
+     */
     floatingToolbar?: FloatingToolbarHandler;
+    /**
+     * Handler returning a React component that is added to the context panel.
+     *
+     * See https://product-fabric.atlassian.net/wiki/spaces/E/pages/1406016239/Context+Panel
+     */
     contextPanel?: ContextPanelHandler;
 };
 declare type EditorViewStateUpdatedCallbackProps = {
@@ -34,19 +45,27 @@ export interface EditorPlugin {
      */
     pmPlugins?: (pluginOptions?: any) => Array<PMPlugin>;
     /**
-     * List of Nodes to add to the schema.
+     * A list of `NodeConfig`s with a name and a `NodeSpec`. (`NodeSpec` is imported from @atlaskit/adf-schema)
+     *
      */
     nodes?: () => NodeConfig[];
     /**
-     * List of Marks to add to the schema.
+     * A list of `MarkConfig`s with a name and a `MarkSpec` (`MarkSpec` is imported from @atlaskit/adf-schema)
      */
     marks?: () => MarkConfig[];
     /**
      * Optional UI-component that lives inside the actual content-area (like mention-picker, floating toolbar for links, etc.)
+     *
+     * Handler returns a React component that is added to the top of the editor content area (PluginSlot).
+     * Although it’s common to specify a custom mount point (eg. date picker)
      */
     contentComponent?: UIComponentFactory;
     /**
      * Optional UI-component that will be added to the toolbar at the top of the editor (doesn't exist in the compact-editor).
+     *
+     * Handler returns a React component that is added to the toolbar at the top of the editor
+     *
+     * Plugins use <ToolbarButton> component to maintain design consistency.
      */
     primaryToolbarComponent?: ToolbarUIComponentFactory;
     /**
@@ -54,6 +73,9 @@ export interface EditorPlugin {
      * In compact mode this toolbar lives on the right-hand side of the editor.
      */
     secondaryToolbarComponent?: UIComponentFactory;
+    /**
+     * Called after EditorView state is updated.
+     */
     onEditorViewStateUpdated?: (props: EditorViewStateUpdatedCallbackProps) => void;
 }
 export declare type getPosHandler = getPosHandlerNode | boolean;

package/dist/types/types/floating-toolbar.d.ts

@@ -204,6 +204,7 @@ declare type FloatingToolbarExtensionsPlaceholder = {
 export declare type FloatingToolbarFallbackItem<T> = FloatingToolbarButton<T> | FloatingToolbarCopyButton | FloatingToolbarDropdown<T> | FloatingToolbarSelect<T> | FloatingToolbarInput<T> | FloatingToolbarSeparator;
 export declare type FloatingToolbarItem<T> = FloatingToolbarButton<T> | FloatingToolbarCopyButton | FloatingToolbarDropdown<T> | FloatingToolbarSelect<T> | FloatingToolbarInput<T> | FloatingToolbarCustom<T> | FloatingToolbarSeparator | FloatingToolbarExtensionsPlaceholder;
 export interface FloatingToolbarConfig {
+    /** Used for the ariaLabel on the <Popup /> component */
     title: string;
     /**
      * Override the DOM reference used to apply as the target for the
@@ -213,17 +214,26 @@ export interface FloatingToolbarConfig {
      * head of the current selection.
      */
     getDomRef?: (view: EditorView) => HTMLElement | undefined;
+    /** Can prevent the Toolbar from rendering */
     visible?: boolean;
     /**
      * nodeType or list of `nodeType`s this floating toolbar should be shown for.
      **/
     nodeType: NodeType | NodeType[];
+    /** Items that will populate the Toolbar.
+     *
+     * See: `FloatingToolbarItem`
+     */
     items: Array<FloatingToolbarItem<Command>> | ((node: Node) => Array<FloatingToolbarItem<Command>>);
     align?: AlignType;
+    /** Class added to Toolbar wrapper */
     className?: string;
+    /** Toolbar height */
     height?: number;
+    /** Toolbar width */
     width?: number;
     zIndex?: number;
+    /** Offset the position of the toolbar. */
     offset?: [number, number];
     forcePlacement?: boolean;
     onPositionCalculated?: (editorView: EditorView, nextPos: Position) => Position;

package/dist/types/types/type-ahead.d.ts

@@ -42,17 +42,25 @@ export declare type TypeAheadItem = {
 export declare type TypeAheadForceSelect = (props: TypeAheadForceSelectProps) => TypeAheadItem | undefined;
 export declare type TypeAheadHandler = {
     id: TypeAheadAvailableNodes;
+    /** Pattern that will trigger the TypeAhead */
     trigger: string;
+    /** Custom regex must have a capture group around trigger so it's possible to
+     * use it without needing to scan through all triggers again */
     customRegex?: string;
     headless?: boolean;
+    /** Handler returns typeahead item based on query. Used to find which item to insert. */
     forceSelect?: TypeAheadForceSelect;
     onInvokeAnalytics?: TypeAheadPayload;
+    /** Handler executes logic when TypeAhead opens */
     onOpen?: (editorState: EditorState) => void;
+    /** Handler returns an array of TypeAheadItem based on query to be displayed in the TypeAhead */
     getItems: (props: {
         query: string;
         editorState: EditorState;
     }) => Promise<Array<TypeAheadItem>>;
+    /** Handler returns a transaction which inserts the TypeAheadItem into the doc */
     selectItem: TypeAheadSelectItem;
+    /** Handler executes logic when TypeAhead is dismissed */
     dismiss?: (props: {
         editorState: EditorState;
         query: string;

package/dist/types/ui-menu/DropdownMenu/index.d.ts

@@ -13,7 +13,7 @@ export default class DropdownMenuWrapper extends PureComponent<Props, State> {
     state: State;
     private handleRef;
     private updatePopupPlacement;
-    private handleCloseandFocus;
+    private handleCloseAndFocus;
     private handleClose;
     private renderDropdownMenu;
     render(): jsx.JSX.Element;

package/dist/types/ui-menu/DropdownMenu/types.d.ts

@@ -48,4 +48,5 @@ export interface MenuItem {
 export interface State {
     target?: HTMLElement;
     popupPlacement: [string, string];
+    selectionIndex: number;
 }

package/dist/types/ui-menu/MenuArrowKeyNavigationProvider/index.d.ts

@@ -5,11 +5,12 @@ declare type SimpleEventHandler<T> = (event: T) => void;
  * This component is a wrapper of vertical menus which listens to keydown events of children
  * and handles up/down arrow key navigation
  */
-export declare const MenuArrowKeyNavigationProvider: ({ children, handleClose, disableArrowKeyNavigation, keyDownHandlerContext, closeonTab, }: {
+export declare const MenuArrowKeyNavigationProvider: ({ children, handleClose, disableArrowKeyNavigation, keyDownHandlerContext, closeOnTab, onSelection, }: {
     children: ReactNode;
     handleClose?: SimpleEventHandler<KeyboardEvent> | undefined;
     disableArrowKeyNavigation?: boolean | undefined;
     keyDownHandlerContext?: KeyDownHandlerContext | undefined;
-    closeonTab?: boolean | undefined;
+    onSelection?: ((index: number) => void) | undefined;
+    closeOnTab?: boolean | undefined;
 }) => JSX.Element;
 export {};

package/dist/types/ui-react/with-react-editor-view-outer-listeners.d.ts

@@ -5,7 +5,7 @@ export interface WithOutsideClickProps {
     handleEscapeKeydown?: SimpleEventHandler<KeyboardEvent>;
     handleEnterKeydown?: SimpleEventHandler<KeyboardEvent>;
     targetRef?: any;
-    closeonTab?: boolean;
+    closeOnTab?: boolean;
 }
 export default function withReactEditorViewOuterListeners<P>(Component: ComponentClass<P> | StatelessComponent<P>): React.FC<P & WithOutsideClickProps>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "72.1.2",
+  "version": "72.2.1",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -67,22 +67,22 @@
     "@atlaskit/code": "^14.4.0",
     "@atlaskit/codemod-utils": "^4.1.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
-    "@atlaskit/editor-palette": "0.1.0",
+    "@atlaskit/editor-palette": "1.0.0",
     "@atlaskit/editor-shared-styles": "^2.3.0",
     "@atlaskit/emoji": "^67.0.0",
     "@atlaskit/icon": "^21.11.0",
     "@atlaskit/in-product-testing": "^0.1.0",
-    "@atlaskit/media-card": "^74.4.0",
+    "@atlaskit/media-card": "^74.5.0",
     "@atlaskit/media-client": "^20.0.0",
-    "@atlaskit/media-picker": "^64.1.0",
+    "@atlaskit/media-picker": "^64.2.0",
     "@atlaskit/mention": "^21.0.0",
     "@atlaskit/menu": "^1.4.0",
     "@atlaskit/profilecard": "^18.2.0",
-    "@atlaskit/smart-card": "^23.13.0",
+    "@atlaskit/smart-card": "^23.14.0",
     "@atlaskit/smart-user-picker": "^6.0.0",
     "@atlaskit/task-decision": "^17.5.0",
     "@atlaskit/theme": "^12.2.0",
-    "@atlaskit/tokens": "^0.13.0",
+    "@atlaskit/tokens": "^1.0.0",
     "@atlaskit/tooltip": "^17.6.0",
     "@atlaskit/ufo": "^0.1.0",
     "@atlaskit/width-detector": "^4.0.0",
@@ -114,9 +114,9 @@
     "react-intl-next": "npm:react-intl@^5.18.1"
   },
   "devDependencies": {
-    "@atlaskit/editor-core": "^178.0.0",
+    "@atlaskit/editor-core": "^178.1.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
-    "@atlaskit/editor-plugin-table": "^1.0.0",
+    "@atlaskit/editor-plugin-table": "^1.1.0",
     "@atlaskit/editor-test-helpers": "^18.0.0",
     "@atlaskit/media-core": "^34.0.0",
     "@atlaskit/util-data-test": "^17.6.0",