@atlaskit/editor-common 75.3.0 → 75.3.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-common
 
+## 75.3.1
+
+### Patch Changes
+
+- [`32e751116bb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/32e751116bb) - [ED-20088] Debounce updates into the useSharedPluginState to avoid blocking the main thread with unnecessary UI updates
+
 ## 75.3.0
 
 ### Minor Changes

package/dist/cjs/hooks/useSharedPluginState.js

@@ -8,6 +8,7 @@ exports.useSharedPluginState = useSharedPluginState;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
+var _debounce = _interopRequireDefault(require("lodash/debounce"));
 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) { (0, _defineProperty2.default)(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; }
 /**
@@ -39,6 +40,35 @@ function useStaticPlugins(plugins) {
 }
 
 /**
+ *
+ * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
+ * If the plugins you are listening to generate multiple shared states while the user is typing,
+ * your React Component will get only the last one.
+ *
+ * Usually, for UI updates, you may need only the last state. But, if you have a specific scenario requiring you to access all states,
+ * do not use this hook. Instead, you can subscribe directly to the plugin sharedState API:
+ *
+ * ```typescript
+ *
+ * function ExampleSpecialCase({ api }: Props) {
+ *   const [dogState, setDogState] = React.useState(null);
+ *   useEffect(() => {
+ *     const unsub = api.dog.sharedState.onChange(({ nextSharedState, prevSharedState }) => {
+ *        setDogState(nextSharedState);
+ *     });
+ *
+ *     return unsub;
+ *   }, [api]);
+ *
+ *   useEffect(() => {
+ *    someCriticalAndWeirdUseCase(dogState);
+ *
+ *   }, [dogState]);
+ *
+ *   return null;
+ * }
+ *
+ * ```
  *
  * Used to return the current plugin state of
  * input dependencies
@@ -88,7 +118,13 @@ function useSharedPluginStateInternal(externalPlugins) {
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
     pluginStates = _useState2[0],
     setPluginState = _useState2[1];
+  var refStates = (0, _react.useRef)({});
   (0, _react.useLayoutEffect)(function () {
+    var debouncedPluginStateUpdate = (0, _debounce.default)(function () {
+      setPluginState(function (currentPluginStates) {
+        return _objectSpread(_objectSpread({}, currentPluginStates), refStates.current);
+      });
+    });
     var unsubs = Object.entries(externalPlugins).map(function (_ref3) {
       var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
         pluginKey = _ref4[0],
@@ -99,12 +135,12 @@ function useSharedPluginStateInternal(externalPlugins) {
         if (prevSharedState === nextSharedState) {
           return;
         }
-        setPluginState(function (currentPluginStates) {
-          return _objectSpread(_objectSpread({}, currentPluginStates), {}, (0, _defineProperty2.default)({}, pluginKey, nextSharedState));
-        });
+        refStates.current[pluginKey] = nextSharedState;
+        debouncedPluginStateUpdate();
       });
     });
     return function () {
+      refStates.current = {};
       unsubs.forEach(function (cb) {
         return cb === null || cb === void 0 ? void 0 : cb();
       });

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "75.3.0";
+var packageVersion = "75.3.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ var _templateObject, _templateObject2, _templateObject3;
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(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; } } /** @jsx jsx */
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "75.3.0";
+var packageVersion = "75.3.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/es2019/hooks/useSharedPluginState.js

@@ -1,4 +1,5 @@
-import { useLayoutEffect, useMemo, useState } from 'react';
+import { useLayoutEffect, useMemo, useRef, useState } from 'react';
+import debounce from 'lodash/debounce';
 /**
  *
  * Directly map object values
@@ -24,6 +25,35 @@ function useStaticPlugins(plugins) {
 }
 
 /**
+ *
+ * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
+ * If the plugins you are listening to generate multiple shared states while the user is typing,
+ * your React Component will get only the last one.
+ *
+ * Usually, for UI updates, you may need only the last state. But, if you have a specific scenario requiring you to access all states,
+ * do not use this hook. Instead, you can subscribe directly to the plugin sharedState API:
+ *
+ * ```typescript
+ *
+ * function ExampleSpecialCase({ api }: Props) {
+ *   const [dogState, setDogState] = React.useState(null);
+ *   useEffect(() => {
+ *     const unsub = api.dog.sharedState.onChange(({ nextSharedState, prevSharedState }) => {
+ *        setDogState(nextSharedState);
+ *     });
+ *
+ *     return unsub;
+ *   }, [api]);
+ *
+ *   useEffect(() => {
+ *    someCriticalAndWeirdUseCase(dogState);
+ *
+ *   }, [dogState]);
+ *
+ *   return null;
+ * }
+ *
+ * ```
  *
  * Used to return the current plugin state of
  * input dependencies
@@ -67,7 +97,14 @@ export function useSharedPluginState(injectionApi, plugins) {
 }
 function useSharedPluginStateInternal(externalPlugins) {
   const [pluginStates, setPluginState] = useState(mapValues(externalPlugins, value => value === null || value === void 0 ? void 0 : value.sharedState.currentState()));
+  const refStates = useRef({});
   useLayoutEffect(() => {
+    const debouncedPluginStateUpdate = debounce(() => {
+      setPluginState(currentPluginStates => ({
+        ...currentPluginStates,
+        ...refStates.current
+      }));
+    });
     const unsubs = Object.entries(externalPlugins).map(([pluginKey, externalPlugin]) => {
       return externalPlugin === null || externalPlugin === void 0 ? void 0 : externalPlugin.sharedState.onChange(({
         nextSharedState,
@@ -76,13 +113,12 @@ function useSharedPluginStateInternal(externalPlugins) {
         if (prevSharedState === nextSharedState) {
           return;
         }
-        setPluginState(currentPluginStates => ({
-          ...currentPluginStates,
-          [pluginKey]: nextSharedState
-        }));
+        refStates.current[pluginKey] = nextSharedState;
+        debouncedPluginStateUpdate();
       });
     });
     return () => {
+      refStates.current = {};
       unsubs.forEach(cb => cb === null || cb === void 0 ? void 0 : cb());
     };
     // Do not re-render due to state changes, we only need to check this when

package/dist/es2019/monitoring/error.js

@@ -1,6 +1,6 @@
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "75.3.0";
+const packageVersion = "75.3.1";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/es2019/ui/DropList/index.js

@@ -9,7 +9,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "75.3.0";
+const packageVersion = "75.3.1";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/esm/hooks/useSharedPluginState.js

@@ -2,7 +2,8 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 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 { useLayoutEffect, useMemo, useState } from 'react';
+import { useLayoutEffect, useMemo, useRef, useState } from 'react';
+import debounce from 'lodash/debounce';
 /**
  *
  * Directly map object values
@@ -32,6 +33,35 @@ function useStaticPlugins(plugins) {
 }
 
 /**
+ *
+ * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
+ * If the plugins you are listening to generate multiple shared states while the user is typing,
+ * your React Component will get only the last one.
+ *
+ * Usually, for UI updates, you may need only the last state. But, if you have a specific scenario requiring you to access all states,
+ * do not use this hook. Instead, you can subscribe directly to the plugin sharedState API:
+ *
+ * ```typescript
+ *
+ * function ExampleSpecialCase({ api }: Props) {
+ *   const [dogState, setDogState] = React.useState(null);
+ *   useEffect(() => {
+ *     const unsub = api.dog.sharedState.onChange(({ nextSharedState, prevSharedState }) => {
+ *        setDogState(nextSharedState);
+ *     });
+ *
+ *     return unsub;
+ *   }, [api]);
+ *
+ *   useEffect(() => {
+ *    someCriticalAndWeirdUseCase(dogState);
+ *
+ *   }, [dogState]);
+ *
+ *   return null;
+ * }
+ *
+ * ```
  *
  * Used to return the current plugin state of
  * input dependencies
@@ -81,7 +111,13 @@ function useSharedPluginStateInternal(externalPlugins) {
     _useState2 = _slicedToArray(_useState, 2),
     pluginStates = _useState2[0],
     setPluginState = _useState2[1];
+  var refStates = useRef({});
   useLayoutEffect(function () {
+    var debouncedPluginStateUpdate = debounce(function () {
+      setPluginState(function (currentPluginStates) {
+        return _objectSpread(_objectSpread({}, currentPluginStates), refStates.current);
+      });
+    });
     var unsubs = Object.entries(externalPlugins).map(function (_ref3) {
       var _ref4 = _slicedToArray(_ref3, 2),
         pluginKey = _ref4[0],
@@ -92,12 +128,12 @@ function useSharedPluginStateInternal(externalPlugins) {
         if (prevSharedState === nextSharedState) {
           return;
         }
-        setPluginState(function (currentPluginStates) {
-          return _objectSpread(_objectSpread({}, currentPluginStates), {}, _defineProperty({}, pluginKey, nextSharedState));
-        });
+        refStates.current[pluginKey] = nextSharedState;
+        debouncedPluginStateUpdate();
       });
     });
     return function () {
+      refStates.current = {};
       unsubs.forEach(function (cb) {
         return cb === null || cb === void 0 ? void 0 : cb();
       });

package/dist/esm/monitoring/error.js

@@ -6,7 +6,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "75.3.0";
+var packageVersion = "75.3.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/ui/DropList/index.js

@@ -19,7 +19,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "75.3.0";
+var packageVersion = "75.3.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/types/hooks/useSharedPluginState.d.ts

@@ -4,6 +4,35 @@ type NamedPluginStatesFromInjectionAPI<API extends PublicPluginAPI<any> | undefi
 }>;
 type ExtractPluginNames<API extends PublicPluginAPI<any>> = API extends PublicPluginAPI<any> ? keyof API : never;
 /**
+ *
+ * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
+ * If the plugins you are listening to generate multiple shared states while the user is typing,
+ * your React Component will get only the last one.
+ *
+ * Usually, for UI updates, you may need only the last state. But, if you have a specific scenario requiring you to access all states,
+ * do not use this hook. Instead, you can subscribe directly to the plugin sharedState API:
+ *
+ * ```typescript
+ *
+ * function ExampleSpecialCase({ api }: Props) {
+ *   const [dogState, setDogState] = React.useState(null);
+ *   useEffect(() => {
+ *     const unsub = api.dog.sharedState.onChange(({ nextSharedState, prevSharedState }) => {
+ *        setDogState(nextSharedState);
+ *     });
+ *
+ *     return unsub;
+ *   }, [api]);
+ *
+ *   useEffect(() => {
+ *    someCriticalAndWeirdUseCase(dogState);
+ *
+ *   }, [dogState]);
+ *
+ *   return null;
+ * }
+ *
+ * ```
  *
  * Used to return the current plugin state of
  * input dependencies

package/dist/types-ts4.5/hooks/useSharedPluginState.d.ts

@@ -4,6 +4,35 @@ type NamedPluginStatesFromInjectionAPI<API extends PublicPluginAPI<any> | undefi
 }>;
 type ExtractPluginNames<API extends PublicPluginAPI<any>> = API extends PublicPluginAPI<any> ? keyof API : never;
 /**
+ *
+ * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
+ * If the plugins you are listening to generate multiple shared states while the user is typing,
+ * your React Component will get only the last one.
+ *
+ * Usually, for UI updates, you may need only the last state. But, if you have a specific scenario requiring you to access all states,
+ * do not use this hook. Instead, you can subscribe directly to the plugin sharedState API:
+ *
+ * ```typescript
+ *
+ * function ExampleSpecialCase({ api }: Props) {
+ *   const [dogState, setDogState] = React.useState(null);
+ *   useEffect(() => {
+ *     const unsub = api.dog.sharedState.onChange(({ nextSharedState, prevSharedState }) => {
+ *        setDogState(nextSharedState);
+ *     });
+ *
+ *     return unsub;
+ *   }, [api]);
+ *
+ *   useEffect(() => {
+ *    someCriticalAndWeirdUseCase(dogState);
+ *
+ *   }, [dogState]);
+ *
+ *   return null;
+ * }
+ *
+ * ```
  *
  * Used to return the current plugin state of
  * input dependencies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "75.3.0",
+  "version": "75.3.1",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"