@atlaskit/editor-common 93.4.3 → 93.5.0

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

@@ -1,19 +1,22 @@
+import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _extends from "@babel/runtime/helpers/extends";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
 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(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; }
 function _createSuper(t) { var r = _isNativeReflectConstruct(); return function () { var e, o = _getPrototypeOf(t); if (r) { var s = _getPrototypeOf(this).constructor; e = Reflect.construct(o, arguments, s); } else e = o.apply(this, arguments); return _possibleConstructorReturn(this, e); }; }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import React from 'react';
 import PropTypes from 'prop-types';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '../analytics';
 import { createDispatch } from '../event-dispatcher';
 import { startMeasure, stopMeasure } from '../performance-measures';
+import { EditorContext } from '../ui/EditorContext';
 import { analyticsEventKey } from '../utils';
 var DEFAULT_SAMPLING_RATE = 100;
 var DEFAULT_SLOW_THRESHOLD = 4;
@@ -61,10 +64,34 @@ var DEFAULT_SLOW_THRESHOLD = 4;
 var WithPluginState = /*#__PURE__*/function (_React$Component) {
   _inherits(WithPluginState, _React$Component);
   var _super = _createSuper(WithPluginState);
-  function WithPluginState(props, context) {
-    var _this;
+  function WithPluginState(props) {
     _classCallCheck(this, WithPluginState);
-    _this = _super.call(this, props, context);
+    return _super.call(this, props);
+  }
+  _createClass(WithPluginState, [{
+    key: "render",
+    value: function render() {
+      if (fg('platform_editor_react18_phase2')) {
+        return /*#__PURE__*/React.createElement(WithPluginStateNew, this.props);
+      }
+      return /*#__PURE__*/React.createElement(WithPluginStateOld, this.props);
+    }
+  }]);
+  return WithPluginState;
+}(React.Component);
+function WithPluginStateNew(props) {
+  var context = React.useContext(EditorContext);
+  return /*#__PURE__*/React.createElement(WithPluginStateInner, _extends({}, props, {
+    editorActions: context === null || context === void 0 ? void 0 : context.editorActions
+  }));
+}
+export var WithPluginStateInner = /*#__PURE__*/function (_React$Component2) {
+  _inherits(WithPluginStateInner, _React$Component2);
+  var _super2 = _createSuper(WithPluginStateInner);
+  function WithPluginStateInner(props) {
+    var _this;
+    _classCallCheck(this, WithPluginStateInner);
+    _this = _super2.call(this, props);
     _defineProperty(_assertThisInitialized(_this), "listeners", {});
     _defineProperty(_assertThisInitialized(_this), "debounce", null);
     _defineProperty(_assertThisInitialized(_this), "notAppliedState", {});
@@ -130,24 +157,22 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
         });
       }
     });
-    _defineProperty(_assertThisInitialized(_this), "onContextUpdate", function () {
-      _this.subscribe(_this.props);
-    });
-    _this.state = _this.getPluginsStates(_this.props.plugins, _this.getEditorView(props, context));
+    _this.state = _this.getPluginsStates(_this.props.plugins, _this.getEditorView(props));
     return _this;
   }
-  _createClass(WithPluginState, [{
+  _createClass(WithPluginStateInner, [{
     key: "getEditorView",
-    value: function getEditorView(maybeProps, maybeContext) {
+    value: function getEditorView(maybeProps) {
       var props = maybeProps || this.props;
-      var context = maybeContext || this.context;
-      return props.editorView || context && context.editorActions && context.editorActions._privateGetEditorView() || context && context.editorSharedConfig && context.editorSharedConfig.editorView;
+      var editorActions = props.editorActions;
+      return props.editorView || (editorActions === null || editorActions === void 0 ? void 0 : editorActions._privateGetEditorView());
     }
   }, {
     key: "getEventDispatcher",
     value: function getEventDispatcher(maybeProps) {
+      var _props$editorActions;
       var props = maybeProps || this.props;
-      return props.eventDispatcher || this.context && this.context.editorActions && this.context.editorActions._privateGetEventDispatcher() || this.context && this.context.editorSharedConfig && this.context.editorSharedConfig.eventDispatcher;
+      return props.eventDispatcher || ((_props$editorActions = props.editorActions) === null || _props$editorActions === void 0 ? void 0 : _props$editorActions._privateGetEventDispatcher());
     }
   }, {
     key: "getPluginsStates",
@@ -238,6 +263,236 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       });
       this.listeners = [];
     }
+  }, {
+    key: "subscribeToContextUpdates",
+    value: function subscribeToContextUpdates() {
+      var _this$props$editorAct,
+        _this4 = this;
+      (_this$props$editorAct = this.props.editorActions) === null || _this$props$editorAct === void 0 || _this$props$editorAct._privateSubscribe(function () {
+        return _this4.subscribe(_this4.props);
+      });
+    }
+  }, {
+    key: "unsubscribeFromContextUpdates",
+    value: function unsubscribeFromContextUpdates() {
+      var _this$props$editorAct2,
+        _this5 = this;
+      (_this$props$editorAct2 = this.props.editorActions) === null || _this$props$editorAct2 === void 0 || _this$props$editorAct2._privateUnsubscribe(function () {
+        return _this5.subscribe(_this5.props);
+      });
+    }
+  }, {
+    key: "componentDidMount",
+    value: function componentDidMount() {
+      this.subscribe(this.props);
+      this.subscribeToContextUpdates();
+    }
+  }, {
+    key: "UNSAFE_componentWillReceiveProps",
+    value: function UNSAFE_componentWillReceiveProps(nextProps) {
+      if (!this.isSubscribed) {
+        this.subscribe(nextProps);
+      }
+    }
+  }, {
+    key: "componentWillUnmount",
+    value: function componentWillUnmount() {
+      if (this.debounce) {
+        window.clearTimeout(this.debounce);
+      }
+      this.unsubscribeFromContextUpdates();
+      this.unsubscribe();
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      var render = this.props.render;
+      return render(this.state);
+    }
+  }]);
+  return WithPluginStateInner;
+}(React.Component);
+_defineProperty(WithPluginStateInner, "displayName", 'WithPluginState');
+export var WithPluginStateOld = /*#__PURE__*/function (_React$Component3) {
+  _inherits(WithPluginStateOld, _React$Component3);
+  var _super3 = _createSuper(WithPluginStateOld);
+  function WithPluginStateOld(props, context) {
+    var _this6;
+    _classCallCheck(this, WithPluginStateOld);
+    _this6 = _super3.call(this, props, context);
+    _defineProperty(_assertThisInitialized(_this6), "listeners", {});
+    _defineProperty(_assertThisInitialized(_this6), "debounce", null);
+    _defineProperty(_assertThisInitialized(_this6), "notAppliedState", {});
+    _defineProperty(_assertThisInitialized(_this6), "isSubscribed", false);
+    _defineProperty(_assertThisInitialized(_this6), "callsCount", 0);
+    _defineProperty(_assertThisInitialized(_this6), "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
+        if (_this6.state[propName] !== pluginState || skipEqualityCheck) {
+          _this6.updateState({
+            stateSubset: _defineProperty({}, propName, pluginState),
+            pluginName: pluginName,
+            performanceOptions: performanceOptions
+          });
+        }
+      };
+    });
+    /**
+     * Debounces setState calls in order to reduce number of re-renders caused by several plugin state changes.
+     */
+    _defineProperty(_assertThisInitialized(_this6), "updateState", function (_ref2) {
+      var stateSubset = _ref2.stateSubset,
+        pluginName = _ref2.pluginName,
+        performanceOptions = _ref2.performanceOptions;
+      _this6.notAppliedState = _objectSpread(_objectSpread({}, _this6.notAppliedState), stateSubset);
+      if (_this6.debounce) {
+        window.clearTimeout(_this6.debounce);
+      }
+      var debounce = _this6.props.debounce !== false ? function (fn) {
+        return window.setTimeout(fn, 0);
+      } : function (fn) {
+        return fn();
+      };
+      _this6.debounce = debounce(function () {
+        var measure = "\uD83E\uDD89".concat(pluginName, "::WithPluginState");
+        performanceOptions.trackingEnabled && startMeasure(measure);
+        _this6.setState(_this6.notAppliedState, function () {
+          performanceOptions.trackingEnabled && stopMeasure(measure, function (duration) {
+            // Each WithPluginState component will fire analytics event no more than once every `samplingLimit` times
+            if (++_this6.callsCount % performanceOptions.samplingRate === 0 && duration > performanceOptions.slowThreshold) {
+              _this6.dispatchAnalyticsEvent({
+                action: ACTION.WITH_PLUGIN_STATE_CALLED,
+                actionSubject: ACTION_SUBJECT.EDITOR,
+                eventType: EVENT_TYPE.OPERATIONAL,
+                attributes: {
+                  plugin: pluginName,
+                  duration: duration
+                }
+              });
+            }
+          });
+        });
+        _this6.debounce = null;
+        _this6.notAppliedState = {};
+      });
+    });
+    _defineProperty(_assertThisInitialized(_this6), "dispatchAnalyticsEvent", function (payload) {
+      var eventDispatcher = _this6.getEventDispatcher();
+      if (eventDispatcher) {
+        var dispatch = createDispatch(eventDispatcher);
+        dispatch(analyticsEventKey, {
+          payload: payload
+        });
+      }
+    });
+    _defineProperty(_assertThisInitialized(_this6), "onContextUpdate", function () {
+      _this6.subscribe(_this6.props);
+    });
+    _this6.state = _this6.getPluginsStates(_this6.props.plugins, _this6.getEditorView(props, context));
+    return _this6;
+  }
+  _createClass(WithPluginStateOld, [{
+    key: "getEditorView",
+    value: function getEditorView(maybeProps, maybeContext) {
+      var props = maybeProps || this.props;
+      var context = maybeContext || this.context;
+      return props.editorView || context && context.editorActions && context.editorActions._privateGetEditorView() || context && context.editorSharedConfig && context.editorSharedConfig.editorView;
+    }
+  }, {
+    key: "getEventDispatcher",
+    value: function getEventDispatcher(maybeProps) {
+      var props = maybeProps || this.props;
+      return props.eventDispatcher || this.context && this.context.editorActions && this.context.editorActions._privateGetEventDispatcher() || this.context && this.context.editorSharedConfig && this.context.editorSharedConfig.eventDispatcher;
+    }
+  }, {
+    key: "getPluginsStates",
+    value: function getPluginsStates(plugins, editorView) {
+      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;
+      }, {});
+    }
+  }, {
+    key: "subscribe",
+    value: function subscribe(props) {
+      var _uiTracking$samplingR2,
+        _uiTracking$slowThres2,
+        _this7 = this;
+      var plugins = props.plugins;
+      var eventDispatcher = this.getEventDispatcher(props);
+      var editorView = this.getEditorView(props);
+      if (!eventDispatcher || !editorView || this.isSubscribed) {
+        return;
+      }
+
+      // TODO: ED-15663
+      // Please, do not copy or use this kind of code below
+      // @ts-ignore
+      var fakePluginKey = {
+        key: 'analyticsPlugin$',
+        getState: function getState(state) {
+          return state['analyticsPlugin$'];
+        }
+      };
+      var analyticsPlugin = fakePluginKey.getState(editorView.state);
+      var uiTracking = analyticsPlugin && analyticsPlugin.performanceTracking ? analyticsPlugin.performanceTracking.uiTracking || {} : {};
+      var trackingEnabled = uiTracking.enabled === true;
+      var samplingRate = (_uiTracking$samplingR2 = uiTracking.samplingRate) !== null && _uiTracking$samplingR2 !== void 0 ? _uiTracking$samplingR2 : DEFAULT_SAMPLING_RATE;
+      var slowThreshold = (_uiTracking$slowThres2 = uiTracking.slowThreshold) !== null && _uiTracking$slowThres2 !== void 0 ? _uiTracking$slowThres2 : DEFAULT_SLOW_THRESHOLD;
+      this.isSubscribed = true;
+      var pluginsStates = this.getPluginsStates(plugins, editorView);
+      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 = _this7.handlePluginStateChange(propName, pluginName, {
+          samplingRate: samplingRate,
+          slowThreshold: slowThreshold,
+          trackingEnabled: trackingEnabled
+        }, isPluginWithSubscribe);
+        if (isPluginWithSubscribe) {
+          pluginState.subscribe(handler);
+        } else {
+          eventDispatcher.on(pluginKey.key, handler);
+        }
+        _this7.listeners[pluginKey.key] = {
+          handler: handler,
+          pluginKey: pluginKey
+        };
+      });
+    }
+  }, {
+    key: "unsubscribe",
+    value: function unsubscribe() {
+      var _this8 = this;
+      var eventDispatcher = this.getEventDispatcher();
+      var editorView = this.getEditorView();
+      if (!eventDispatcher || !editorView || !this.isSubscribed) {
+        return;
+      }
+      Object.keys(this.listeners).forEach(function (key) {
+        var pluginState = _this8.listeners[key].pluginKey.getState(editorView.state);
+        if (pluginState && pluginState.unsubscribe) {
+          pluginState.unsubscribe(_this8.listeners[key].handler);
+        } else {
+          eventDispatcher.off(key, _this8.listeners[key].handler);
+        }
+      });
+      this.listeners = [];
+    }
   }, {
     key: "subscribeToContextUpdates",
     value: function subscribeToContextUpdates(context) {
@@ -281,10 +536,10 @@ var WithPluginState = /*#__PURE__*/function (_React$Component) {
       return render(this.state);
     }
   }]);
-  return WithPluginState;
+  return WithPluginStateOld;
 }(React.Component);
-_defineProperty(WithPluginState, "displayName", 'WithPluginState');
-_defineProperty(WithPluginState, "contextTypes", {
+_defineProperty(WithPluginStateOld, "displayName", 'WithPluginState');
+_defineProperty(WithPluginStateOld, "contextTypes", {
   editorActions: PropTypes.object,
   editorSharedConfig: PropTypes.object
 });

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

@@ -5,5 +5,6 @@ export type ViewInlineCommentsButtonEventAEP = UIAEP<ACTION.VIEWED, ACTION_SUBJE
     isDisabled: boolean;
     mode: MODE.EDITOR;
     inputMethod: INPUT_METHOD.FLOATING_TB;
+    isNonTextInlineNodeInludedInComment: boolean;
 }, undefined>;
 export type ViewEventPayload = ViewInlineCommentsButtonEventAEP;

package/dist/types/ui/EditorContext/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const EditorContext: React.Context<{}>;

package/dist/types/with-plugin-state/index.d.ts

@@ -73,7 +73,41 @@ export interface Props<P extends NamedPluginKeys> {
  * ```
  *
  */
-declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
+declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    constructor(props: WithPluginStateInnerProps<P>);
+    render(): JSX.Element;
+}
+type WithPluginStateInnerProps<P extends NamedPluginKeys> = Props<P> & {
+    editorActions?: EditorActionsPrivateAccess;
+};
+export declare class WithPluginStateInner<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    static displayName: string;
+    private listeners;
+    private debounce;
+    private notAppliedState;
+    private isSubscribed;
+    private callsCount;
+    state: NamedPluginStates<P>;
+    constructor(props: Props<P>);
+    private getEditorView;
+    private getEventDispatcher;
+    private handlePluginStateChange;
+    /**
+     * Debounces setState calls in order to reduce number of re-renders caused by several plugin state changes.
+     */
+    private updateState;
+    private dispatchAnalyticsEvent;
+    private getPluginsStates;
+    private subscribe;
+    private unsubscribe;
+    private subscribeToContextUpdates;
+    private unsubscribeFromContextUpdates;
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props<P>): void;
+    componentWillUnmount(): void;
+    render(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+}
+export declare class WithPluginStateOld<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
     static displayName: string;
     private listeners;
     private debounce;

package/dist/types-ts4.5/analytics/types/view-events.d.ts

@@ -5,5 +5,6 @@ export type ViewInlineCommentsButtonEventAEP = UIAEP<ACTION.VIEWED, ACTION_SUBJE
     isDisabled: boolean;
     mode: MODE.EDITOR;
     inputMethod: INPUT_METHOD.FLOATING_TB;
+    isNonTextInlineNodeInludedInComment: boolean;
 }, undefined>;
 export type ViewEventPayload = ViewInlineCommentsButtonEventAEP;

package/dist/types-ts4.5/ui/EditorContext/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const EditorContext: React.Context<{}>;

package/dist/types-ts4.5/with-plugin-state/index.d.ts

@@ -73,7 +73,41 @@ export interface Props<P extends NamedPluginKeys> {
  * ```
  *
  */
-declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
+declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    constructor(props: WithPluginStateInnerProps<P>);
+    render(): JSX.Element;
+}
+type WithPluginStateInnerProps<P extends NamedPluginKeys> = Props<P> & {
+    editorActions?: EditorActionsPrivateAccess;
+};
+export declare class WithPluginStateInner<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    static displayName: string;
+    private listeners;
+    private debounce;
+    private notAppliedState;
+    private isSubscribed;
+    private callsCount;
+    state: NamedPluginStates<P>;
+    constructor(props: Props<P>);
+    private getEditorView;
+    private getEventDispatcher;
+    private handlePluginStateChange;
+    /**
+     * Debounces setState calls in order to reduce number of re-renders caused by several plugin state changes.
+     */
+    private updateState;
+    private dispatchAnalyticsEvent;
+    private getPluginsStates;
+    private subscribe;
+    private unsubscribe;
+    private subscribeToContextUpdates;
+    private unsubscribeFromContextUpdates;
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props<P>): void;
+    componentWillUnmount(): void;
+    render(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+}
+export declare class WithPluginStateOld<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
     static displayName: string;
     private listeners;
     private debounce;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "93.4.3",
+	"version": "93.5.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -105,11 +105,12 @@
 		"./intl-error-boundary": "./src/ui/IntlErrorBoundary/index.tsx",
 		"./code-block": "./src/code-block/index.ts",
 		"./table": "./src/table/index.ts",
-		"./lazy-node-view": "./src/lazy-node-view/index.ts"
+		"./lazy-node-view": "./src/lazy-node-view/index.ts",
+		"./UNSAFE_do_not_use_editor_context": "./src/ui/EditorContext/index.ts"
 	},
 	"dependencies": {
 		"@atlaskit/activity-provider": "^2.4.0",
-		"@atlaskit/adf-schema": "^40.9.4",
+		"@atlaskit/adf-schema": "^42.0.2",
 		"@atlaskit/adf-utils": "^19.9.0",
 		"@atlaskit/analytics-listeners": "^8.11.0",
 		"@atlaskit/analytics-namespaced-context": "^6.12.0",
@@ -137,7 +138,7 @@
 		"@atlaskit/media-file-preview": "^0.9.0",
 		"@atlaskit/media-picker": "^66.7.0",
 		"@atlaskit/media-ui": "^25.15.0",
-		"@atlaskit/media-viewer": "49.1.0",
+		"@atlaskit/media-viewer": "49.1.1",
 		"@atlaskit/mention": "^23.3.0",
 		"@atlaskit/menu": "^2.12.0",
 		"@atlaskit/onboarding": "^11.2.0",
@@ -150,7 +151,7 @@
 		"@atlaskit/spinner": "^16.3.0",
 		"@atlaskit/task-decision": "^17.11.0",
 		"@atlaskit/textfield": "^6.5.0",
-		"@atlaskit/tmp-editor-statsig": "^2.4.0",
+		"@atlaskit/tmp-editor-statsig": "^2.5.0",
 		"@atlaskit/tokens": "^2.0.0",
 		"@atlaskit/tooltip": "^18.8.0",
 		"@atlaskit/ufo": "^0.3.0",