@atlaskit/editor-common 78.34.0 → 78.35.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-common
 
+## 78.35.0
+
+### Minor Changes
+
+- [#93196](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/93196) [`2528bcaa6643`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2528bcaa6643) - Added new PortalProvider implementation + tests
+
 ## 78.34.0
 
 ### Minor Changes

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 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 = "78.34.0";
+var packageVersion = "78.35.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/cjs/portal/PortalBucket.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PortalBucket = PortalBucket;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = _interopRequireWildcard(require("react"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/**
+ * A component for rendering portals managed by a `PortalManager`.
+ * It subscribes to a `PortalManager` instance to listen for changes in the portal content
+ * and renders the content of its assigned portal bucket.
+ *
+ * @param {PortalBucketProps} props The component props.
+ * @param {number} props.id The ID for the portal bucket. This ID is used by the `PortalManager` to manage the content of this bucket.
+ * @param {PortalManager} props.portalManager An instance of `PortalManager` which manages the registration and unregistration of portal buckets and their content.
+ * @returns {React.ReactElement} The React element(s) that are currently registered to this portal bucket.
+ */
+function PortalBucket(_ref) {
+  var id = _ref.id,
+    portalManager = _ref.portalManager;
+  // State to hold the current portals for this bucket
+  var _useState = (0, _react.useState)({}),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    portals = _useState2[0],
+    setPortals = _useState2[1];
+  // Effect to register/unregister this bucket with the portal manager on mount/unmount
+  (0, _react.useLayoutEffect)(function () {
+    portalManager.registerBucket(id, setPortals);
+    return function () {
+      portalManager.unregisterBucket(id);
+    };
+  }, [id, portalManager]);
+  // Memoize the portal elements to avoid unnecessary re-renders
+  var portalElements = (0, _react.useMemo)(function () {
+    return Object.values(portals);
+  }, [portals]);
+  // Render the current portal elements
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, portalElements);
+}

package/dist/cjs/portal/PortalManager.js

@@ -0,0 +1,209 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PortalManager = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+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; }
+var DEFAULT_INITIAL_BUCKETS = 50;
+var DEFAULT_MAX_BUCKET_CAPACITY = 50;
+var DEFAULT_SCALE_RATIO = 0.5;
+
+/**
+ * Creates an empty bucket object with a specified capacity. Each bucket is designed
+ * to hold a certain number of React portals and has an associated updater function
+ * which can be null initially.
+ *
+ * @function createEmptyBucket
+ * @param {number} capacity - The maximum capacity of the bucket.
+ * @returns {PortalBucketType} An object representing an empty bucket with the specified capacity.
+ */
+function createEmptyBucket(capacity) {
+  return {
+    portals: {},
+    capacity: capacity,
+    updater: null
+  };
+}
+
+/**
+ * A utility class to manage and dynamically scale React portals across multiple buckets.
+ * It allows for efficient rendering of large numbers of React portals by distributing them
+ * across "buckets" and updating these buckets as necessary to balance load and performance.
+ *
+ * @class PortalManager
+ * @typedef {Object} PortalManager
+ *
+ * @property {number} maxBucketCapacity - The maximum capacity of each bucket before a new bucket is created.
+ * @property {number} scaleRatio - The ratio to determine the number of new buckets to add when scaling up.
+ * @property {Array<PortalBucketType>} buckets - An array of bucket objects where each bucket holds a record of React portals.
+ * @property {Set<number>} availableBuckets - A set of indices representing buckets that have available capacity.
+ * @property {Map<React.Key, number>} portalToBucketMap - A map of React portal keys to their corresponding bucket indices.
+ * @property {PortalRendererUpdater|null} portalRendererUpdater - A function to trigger updates to the rendering of portals.
+ * @property {number} scaleCapacityThreshold - The threshold at which the buckets are scaled up to accommodate more portals.
+ *
+ * @param {number} [initialBuckets=DEFAULT_INITIAL_BUCKETS] - The initial number of buckets to create.
+ * @param {number} [maxBucketCapacity=DEFAULT_MAX_BUCKET_CAPACITY] - The maximum number of portals a single bucket can hold.
+ * @param {number} [scaleRatio=DEFAULT_SCALE_RATIO] - The ratio used to calculate the number of new buckets to add when scaling.
+ */
+var PortalManager = exports.PortalManager = /*#__PURE__*/function () {
+  function PortalManager() {
+    var initialBuckets = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_INITIAL_BUCKETS;
+    var maxBucketCapacity = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_MAX_BUCKET_CAPACITY;
+    var scaleRatio = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_SCALE_RATIO;
+    (0, _classCallCheck2.default)(this, PortalManager);
+    this.maxBucketCapacity = maxBucketCapacity;
+    this.scaleRatio = scaleRatio;
+
+    // Initialise buckets array by creating an array of length `initialBuckets` containing empty buckets
+    this.buckets = Array.from({
+      length: initialBuckets
+    }, function () {
+      return createEmptyBucket(maxBucketCapacity);
+    });
+    this.portalToBucketMap = new Map();
+    this.availableBuckets = new Set(Array.from({
+      length: initialBuckets
+    }, function (_, i) {
+      return i;
+    }));
+    this.portalRendererUpdater = null;
+    this.scaleCapacityThreshold = maxBucketCapacity / 2;
+  }
+  (0, _createClass2.default)(PortalManager, [{
+    key: "getCurrentBucket",
+    value: function getCurrentBucket() {
+      return this.availableBuckets.values().next().value;
+    }
+  }, {
+    key: "createBucket",
+    value: function createBucket() {
+      var _this$portalRendererU;
+      var currentBucket = this.getCurrentBucket();
+
+      //If the current bucket has capacity, skip this logic
+      if (this.buckets[currentBucket].capacity > 0) {
+        return;
+      } else {
+        // The current bucket is full, delete the bucket from the list of available buckets
+        this.availableBuckets.delete(currentBucket);
+      }
+
+      // Skip creating new bucket if there are buckets still available
+      if (this.availableBuckets.size > 0) {
+        return;
+      }
+
+      // Scale the buckets up only if there are no available buckets left
+      // Calculate how many new buckets need to be added
+      var numBucketsToAdd = Math.floor(this.buckets.length * this.scaleRatio);
+      this.buckets = (0, _toConsumableArray2.default)(this.buckets);
+      for (var i = 0; i < numBucketsToAdd; i++) {
+        this.buckets.push(createEmptyBucket(this.maxBucketCapacity));
+        this.availableBuckets.add(this.buckets.length - 1);
+      }
+      (_this$portalRendererU = this.portalRendererUpdater) === null || _this$portalRendererU === void 0 || _this$portalRendererU.call(this, this.buckets);
+    }
+  }, {
+    key: "getBuckets",
+    value: function getBuckets() {
+      return this.buckets;
+    }
+  }, {
+    key: "registerBucket",
+    value: function registerBucket(id, updater) {
+      var _this$buckets$id$upda,
+        _this$buckets$id,
+        _this = this;
+      this.buckets[id].updater = updater;
+      (_this$buckets$id$upda = (_this$buckets$id = this.buckets[id]).updater) === null || _this$buckets$id$upda === void 0 || _this$buckets$id$upda.call(_this$buckets$id, function () {
+        return _objectSpread({}, _this.buckets[id].portals);
+      });
+    }
+  }, {
+    key: "unregisterBucket",
+    value: function unregisterBucket(id) {
+      this.buckets[id].updater = null;
+    }
+  }, {
+    key: "updateBuckets",
+    value: function updateBuckets(id) {
+      var _this$buckets$id$upda2,
+        _this$buckets$id2,
+        _this2 = this;
+      (_this$buckets$id$upda2 = (_this$buckets$id2 = this.buckets[id]).updater) === null || _this$buckets$id$upda2 === void 0 || _this$buckets$id$upda2.call(_this$buckets$id2, function () {
+        // new object is required to trigger react updates
+        return _objectSpread({}, _this2.buckets[id].portals);
+      });
+    }
+  }, {
+    key: "registerPortal",
+    value: function registerPortal(key, portal) {
+      var _this$portalToBucketM,
+        _this3 = this;
+      this.createBucket();
+      this.buckets[this.getCurrentBucket()].capacity -= 1;
+      var id = (_this$portalToBucketM = this.portalToBucketMap.get(key)) !== null && _this$portalToBucketM !== void 0 ? _this$portalToBucketM : this.getCurrentBucket();
+      this.portalToBucketMap.set(key, id);
+      if (this.buckets[id].portals[key] !== portal) {
+        this.buckets[id].portals[key] = portal;
+        this.updateBuckets(id);
+      }
+
+      //returns a function to unregister the portal
+      return function () {
+        delete _this3.buckets[id].portals[key];
+        _this3.portalToBucketMap.delete(key);
+        _this3.buckets[id].capacity += 1;
+        if (_this3.buckets[id].capacity > _this3.scaleCapacityThreshold) {
+          _this3.availableBuckets.add(id);
+        }
+        _this3.updateBuckets(id);
+      };
+    }
+  }, {
+    key: "registerPortalRenderer",
+    value: function registerPortalRenderer(updater) {
+      var _this4 = this;
+      if (!this.portalRendererUpdater) {
+        updater(function () {
+          return _this4.buckets;
+        });
+      }
+      this.portalRendererUpdater = updater;
+    }
+  }, {
+    key: "unregisterPortalRenderer",
+    value: function unregisterPortalRenderer() {
+      this.portalRendererUpdater = null;
+    }
+
+    /**
+     * Cleans up resources used by the PortalManager. This includes clearing all portals,
+     * unregistering all buckets, and resetting internal state.
+     */
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      var _this5 = this;
+      // Iterate through each bucket and clear its portals and unset the updater function
+      this.buckets.forEach(function (bucket, id) {
+        bucket.portals = {}; // Clearing all portals from the bucket
+        bucket.updater = null; // Unsetting the bucket's updater function
+        _this5.availableBuckets.add(id); // Mark all buckets as available
+      });
+      this.portalToBucketMap.clear();
+      this.portalRendererUpdater = null;
+      this.availableBuckets = new Set(this.buckets.map(function (_, index) {
+        return index;
+      }));
+    }
+  }]);
+  return PortalManager;
+}();

package/dist/cjs/portal/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "PortalBucket", {
+  enumerable: true,
+  get: function get() {
+    return _PortalBucket.PortalBucket;
+  }
+});
+Object.defineProperty(exports, "PortalManager", {
+  enumerable: true,
+  get: function get() {
+    return _PortalManager.PortalManager;
+  }
+});
+Object.defineProperty(exports, "usePortalProvider", {
+  enumerable: true,
+  get: function get() {
+    return _usePortalProvider.usePortalProvider;
+  }
+});
+var _PortalManager = require("./PortalManager");
+var _PortalBucket = require("./PortalBucket");
+var _usePortalProvider = require("./usePortalProvider");

package/dist/cjs/portal/usePortalProvider.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usePortalProvider = usePortalProvider;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = _interopRequireWildcard(require("react"));
+var _reactDom = require("react-dom");
+var _PortalBucket = require("./PortalBucket");
+var _PortalManager = require("./PortalManager");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function createPortalRendererComponent(portalManager) {
+  return function PortalRenderer() {
+    var _useState = (0, _react.useState)(portalManager.getBuckets()),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+      buckets = _useState2[0],
+      setBuckets = _useState2[1];
+    (0, _react.useLayoutEffect)(function () {
+      portalManager.registerPortalRenderer(setBuckets);
+      return function () {
+        portalManager.unregisterPortalRenderer();
+      };
+    }, []);
+    var portalsElements = (0, _react.useMemo)(function () {
+      return buckets.map(function (_, i) {
+        return /*#__PURE__*/_react.default.createElement(_PortalBucket.PortalBucket, {
+          key: i,
+          id: i,
+          portalManager: portalManager
+        });
+      });
+    }, [buckets]);
+    return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, portalsElements);
+  };
+}
+
+/**
+ * Initializes PortalManager and creates PortalRendererComponent. Offers an API (portalProviderAPI) for managing portals.
+ * @returns {[PortalProviderAPI, PortalRendererComponent]} An array containing two elements:
+ *         1. portalProviderAPI: An object providing an API for rendering and removing portals.
+ *         2. PortalRenderer: A React component responsible for rendering the portal content.
+ */
+function usePortalProvider() {
+  var portalManager = (0, _react.useMemo)(function () {
+    return new _PortalManager.PortalManager();
+  }, []);
+  var PortalRenderer = (0, _react.useMemo)(function () {
+    return createPortalRendererComponent(portalManager);
+  }, [portalManager]);
+  var portalProviderAPI = (0, _react.useMemo)(function () {
+    var portalsMap = new Map();
+    return {
+      render: function render(key, children, container) {
+        var portal = /*#__PURE__*/(0, _reactDom.createPortal)(children(), container, key);
+        portalsMap.set(key, portalManager.registerPortal(key, portal));
+      },
+      remove: function remove(key) {
+        var _portalsMap$get;
+        (_portalsMap$get = portalsMap.get(key)) === null || _portalsMap$get === void 0 || _portalsMap$get();
+        portalsMap.delete(key);
+      },
+      destroy: function destroy() {
+        portalsMap.clear();
+        portalManager.destroy();
+      }
+    };
+  }, [portalManager]);
+
+  // Cleanup on unmount
+  (0, _react.useEffect)(function () {
+    return function () {
+      portalProviderAPI.destroy();
+    };
+  }, [portalManager, portalProviderAPI]);
+  return [portalProviderAPI, PortalRenderer];
+}

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

@@ -20,7 +20,7 @@ var _Layer = _interopRequireDefault(require("../Layer"));
 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() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /** @jsx jsx */
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "78.34.0";
+var packageVersion = "78.35.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

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 = "78.34.0";
+const packageVersion = "78.35.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/es2019/portal/PortalBucket.js

@@ -0,0 +1,29 @@
+import React, { useLayoutEffect, useMemo, useState } from 'react';
+/**
+ * A component for rendering portals managed by a `PortalManager`.
+ * It subscribes to a `PortalManager` instance to listen for changes in the portal content
+ * and renders the content of its assigned portal bucket.
+ *
+ * @param {PortalBucketProps} props The component props.
+ * @param {number} props.id The ID for the portal bucket. This ID is used by the `PortalManager` to manage the content of this bucket.
+ * @param {PortalManager} props.portalManager An instance of `PortalManager` which manages the registration and unregistration of portal buckets and their content.
+ * @returns {React.ReactElement} The React element(s) that are currently registered to this portal bucket.
+ */
+export function PortalBucket({
+  id,
+  portalManager
+}) {
+  // State to hold the current portals for this bucket
+  const [portals, setPortals] = useState({});
+  // Effect to register/unregister this bucket with the portal manager on mount/unmount
+  useLayoutEffect(() => {
+    portalManager.registerBucket(id, setPortals);
+    return () => {
+      portalManager.unregisterBucket(id);
+    };
+  }, [id, portalManager]);
+  // Memoize the portal elements to avoid unnecessary re-renders
+  const portalElements = useMemo(() => Object.values(portals), [portals]);
+  // Render the current portal elements
+  return /*#__PURE__*/React.createElement(React.Fragment, null, portalElements);
+}

package/dist/es2019/portal/PortalManager.js

@@ -0,0 +1,157 @@
+const DEFAULT_INITIAL_BUCKETS = 50;
+const DEFAULT_MAX_BUCKET_CAPACITY = 50;
+const DEFAULT_SCALE_RATIO = 0.5;
+
+/**
+ * Creates an empty bucket object with a specified capacity. Each bucket is designed
+ * to hold a certain number of React portals and has an associated updater function
+ * which can be null initially.
+ *
+ * @function createEmptyBucket
+ * @param {number} capacity - The maximum capacity of the bucket.
+ * @returns {PortalBucketType} An object representing an empty bucket with the specified capacity.
+ */
+function createEmptyBucket(capacity) {
+  return {
+    portals: {},
+    capacity,
+    updater: null
+  };
+}
+
+/**
+ * A utility class to manage and dynamically scale React portals across multiple buckets.
+ * It allows for efficient rendering of large numbers of React portals by distributing them
+ * across "buckets" and updating these buckets as necessary to balance load and performance.
+ *
+ * @class PortalManager
+ * @typedef {Object} PortalManager
+ *
+ * @property {number} maxBucketCapacity - The maximum capacity of each bucket before a new bucket is created.
+ * @property {number} scaleRatio - The ratio to determine the number of new buckets to add when scaling up.
+ * @property {Array<PortalBucketType>} buckets - An array of bucket objects where each bucket holds a record of React portals.
+ * @property {Set<number>} availableBuckets - A set of indices representing buckets that have available capacity.
+ * @property {Map<React.Key, number>} portalToBucketMap - A map of React portal keys to their corresponding bucket indices.
+ * @property {PortalRendererUpdater|null} portalRendererUpdater - A function to trigger updates to the rendering of portals.
+ * @property {number} scaleCapacityThreshold - The threshold at which the buckets are scaled up to accommodate more portals.
+ *
+ * @param {number} [initialBuckets=DEFAULT_INITIAL_BUCKETS] - The initial number of buckets to create.
+ * @param {number} [maxBucketCapacity=DEFAULT_MAX_BUCKET_CAPACITY] - The maximum number of portals a single bucket can hold.
+ * @param {number} [scaleRatio=DEFAULT_SCALE_RATIO] - The ratio used to calculate the number of new buckets to add when scaling.
+ */
+export class PortalManager {
+  constructor(initialBuckets = DEFAULT_INITIAL_BUCKETS, maxBucketCapacity = DEFAULT_MAX_BUCKET_CAPACITY, scaleRatio = DEFAULT_SCALE_RATIO) {
+    this.maxBucketCapacity = maxBucketCapacity;
+    this.scaleRatio = scaleRatio;
+
+    // Initialise buckets array by creating an array of length `initialBuckets` containing empty buckets
+    this.buckets = Array.from({
+      length: initialBuckets
+    }, () => createEmptyBucket(maxBucketCapacity));
+    this.portalToBucketMap = new Map();
+    this.availableBuckets = new Set(Array.from({
+      length: initialBuckets
+    }, (_, i) => i));
+    this.portalRendererUpdater = null;
+    this.scaleCapacityThreshold = maxBucketCapacity / 2;
+  }
+  getCurrentBucket() {
+    return this.availableBuckets.values().next().value;
+  }
+  createBucket() {
+    var _this$portalRendererU;
+    const currentBucket = this.getCurrentBucket();
+
+    //If the current bucket has capacity, skip this logic
+    if (this.buckets[currentBucket].capacity > 0) {
+      return;
+    } else {
+      // The current bucket is full, delete the bucket from the list of available buckets
+      this.availableBuckets.delete(currentBucket);
+    }
+
+    // Skip creating new bucket if there are buckets still available
+    if (this.availableBuckets.size > 0) {
+      return;
+    }
+
+    // Scale the buckets up only if there are no available buckets left
+    // Calculate how many new buckets need to be added
+    const numBucketsToAdd = Math.floor(this.buckets.length * this.scaleRatio);
+    this.buckets = [...this.buckets];
+    for (let i = 0; i < numBucketsToAdd; i++) {
+      this.buckets.push(createEmptyBucket(this.maxBucketCapacity));
+      this.availableBuckets.add(this.buckets.length - 1);
+    }
+    (_this$portalRendererU = this.portalRendererUpdater) === null || _this$portalRendererU === void 0 ? void 0 : _this$portalRendererU.call(this, this.buckets);
+  }
+  getBuckets() {
+    return this.buckets;
+  }
+  registerBucket(id, updater) {
+    var _this$buckets$id$upda, _this$buckets$id;
+    this.buckets[id].updater = updater;
+    (_this$buckets$id$upda = (_this$buckets$id = this.buckets[id]).updater) === null || _this$buckets$id$upda === void 0 ? void 0 : _this$buckets$id$upda.call(_this$buckets$id, () => ({
+      ...this.buckets[id].portals
+    }));
+  }
+  unregisterBucket(id) {
+    this.buckets[id].updater = null;
+  }
+  updateBuckets(id) {
+    var _this$buckets$id$upda2, _this$buckets$id2;
+    (_this$buckets$id$upda2 = (_this$buckets$id2 = this.buckets[id]).updater) === null || _this$buckets$id$upda2 === void 0 ? void 0 : _this$buckets$id$upda2.call(_this$buckets$id2, () => {
+      // new object is required to trigger react updates
+      return {
+        ...this.buckets[id].portals
+      };
+    });
+  }
+  registerPortal(key, portal) {
+    var _this$portalToBucketM;
+    this.createBucket();
+    this.buckets[this.getCurrentBucket()].capacity -= 1;
+    const id = (_this$portalToBucketM = this.portalToBucketMap.get(key)) !== null && _this$portalToBucketM !== void 0 ? _this$portalToBucketM : this.getCurrentBucket();
+    this.portalToBucketMap.set(key, id);
+    if (this.buckets[id].portals[key] !== portal) {
+      this.buckets[id].portals[key] = portal;
+      this.updateBuckets(id);
+    }
+
+    //returns a function to unregister the portal
+    return () => {
+      delete this.buckets[id].portals[key];
+      this.portalToBucketMap.delete(key);
+      this.buckets[id].capacity += 1;
+      if (this.buckets[id].capacity > this.scaleCapacityThreshold) {
+        this.availableBuckets.add(id);
+      }
+      this.updateBuckets(id);
+    };
+  }
+  registerPortalRenderer(updater) {
+    if (!this.portalRendererUpdater) {
+      updater(() => this.buckets);
+    }
+    this.portalRendererUpdater = updater;
+  }
+  unregisterPortalRenderer() {
+    this.portalRendererUpdater = null;
+  }
+
+  /**
+   * Cleans up resources used by the PortalManager. This includes clearing all portals,
+   * unregistering all buckets, and resetting internal state.
+   */
+  destroy() {
+    // Iterate through each bucket and clear its portals and unset the updater function
+    this.buckets.forEach((bucket, id) => {
+      bucket.portals = {}; // Clearing all portals from the bucket
+      bucket.updater = null; // Unsetting the bucket's updater function
+      this.availableBuckets.add(id); // Mark all buckets as available
+    });
+    this.portalToBucketMap.clear();
+    this.portalRendererUpdater = null;
+    this.availableBuckets = new Set(this.buckets.map((_, index) => index));
+  }
+}

package/dist/es2019/portal/index.js

@@ -0,0 +1,3 @@
+export { PortalManager } from './PortalManager';
+export { PortalBucket } from './PortalBucket';
+export { usePortalProvider } from './usePortalProvider';

package/dist/es2019/portal/usePortalProvider.js

@@ -0,0 +1,58 @@
+import React, { useEffect, useLayoutEffect, useMemo, useState } from 'react';
+import { createPortal } from 'react-dom';
+import { PortalBucket } from './PortalBucket';
+import { PortalManager } from './PortalManager';
+function createPortalRendererComponent(portalManager) {
+  return function PortalRenderer() {
+    const [buckets, setBuckets] = useState(portalManager.getBuckets());
+    useLayoutEffect(() => {
+      portalManager.registerPortalRenderer(setBuckets);
+      return () => {
+        portalManager.unregisterPortalRenderer();
+      };
+    }, []);
+    const portalsElements = useMemo(() => buckets.map((_, i) => /*#__PURE__*/React.createElement(PortalBucket, {
+      key: i,
+      id: i,
+      portalManager: portalManager
+    })), [buckets]);
+    return /*#__PURE__*/React.createElement(React.Fragment, null, portalsElements);
+  };
+}
+
+/**
+ * Initializes PortalManager and creates PortalRendererComponent. Offers an API (portalProviderAPI) for managing portals.
+ * @returns {[PortalProviderAPI, PortalRendererComponent]} An array containing two elements:
+ *         1. portalProviderAPI: An object providing an API for rendering and removing portals.
+ *         2. PortalRenderer: A React component responsible for rendering the portal content.
+ */
+export function usePortalProvider() {
+  const portalManager = useMemo(() => new PortalManager(), []);
+  const PortalRenderer = useMemo(() => createPortalRendererComponent(portalManager), [portalManager]);
+  const portalProviderAPI = useMemo(() => {
+    const portalsMap = new Map();
+    return {
+      render: (key, children, container) => {
+        const portal = /*#__PURE__*/createPortal(children(), container, key);
+        portalsMap.set(key, portalManager.registerPortal(key, portal));
+      },
+      remove: key => {
+        var _portalsMap$get;
+        (_portalsMap$get = portalsMap.get(key)) === null || _portalsMap$get === void 0 ? void 0 : _portalsMap$get();
+        portalsMap.delete(key);
+      },
+      destroy: () => {
+        portalsMap.clear();
+        portalManager.destroy();
+      }
+    };
+  }, [portalManager]);
+
+  // Cleanup on unmount
+  useEffect(() => {
+    return () => {
+      portalProviderAPI.destroy();
+    };
+  }, [portalManager, portalProviderAPI]);
+  return [portalProviderAPI, PortalRenderer];
+}

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

@@ -7,7 +7,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "78.34.0";
+const packageVersion = "78.35.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

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 = "78.34.0";
+var packageVersion = "78.35.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/portal/PortalBucket.js

@@ -0,0 +1,34 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import React, { useLayoutEffect, useMemo, useState } from 'react';
+/**
+ * A component for rendering portals managed by a `PortalManager`.
+ * It subscribes to a `PortalManager` instance to listen for changes in the portal content
+ * and renders the content of its assigned portal bucket.
+ *
+ * @param {PortalBucketProps} props The component props.
+ * @param {number} props.id The ID for the portal bucket. This ID is used by the `PortalManager` to manage the content of this bucket.
+ * @param {PortalManager} props.portalManager An instance of `PortalManager` which manages the registration and unregistration of portal buckets and their content.
+ * @returns {React.ReactElement} The React element(s) that are currently registered to this portal bucket.
+ */
+export function PortalBucket(_ref) {
+  var id = _ref.id,
+    portalManager = _ref.portalManager;
+  // State to hold the current portals for this bucket
+  var _useState = useState({}),
+    _useState2 = _slicedToArray(_useState, 2),
+    portals = _useState2[0],
+    setPortals = _useState2[1];
+  // Effect to register/unregister this bucket with the portal manager on mount/unmount
+  useLayoutEffect(function () {
+    portalManager.registerBucket(id, setPortals);
+    return function () {
+      portalManager.unregisterBucket(id);
+    };
+  }, [id, portalManager]);
+  // Memoize the portal elements to avoid unnecessary re-renders
+  var portalElements = useMemo(function () {
+    return Object.values(portals);
+  }, [portals]);
+  // Render the current portal elements
+  return /*#__PURE__*/React.createElement(React.Fragment, null, portalElements);
+}

package/dist/esm/portal/PortalManager.js

@@ -0,0 +1,202 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+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; }
+var DEFAULT_INITIAL_BUCKETS = 50;
+var DEFAULT_MAX_BUCKET_CAPACITY = 50;
+var DEFAULT_SCALE_RATIO = 0.5;
+
+/**
+ * Creates an empty bucket object with a specified capacity. Each bucket is designed
+ * to hold a certain number of React portals and has an associated updater function
+ * which can be null initially.
+ *
+ * @function createEmptyBucket
+ * @param {number} capacity - The maximum capacity of the bucket.
+ * @returns {PortalBucketType} An object representing an empty bucket with the specified capacity.
+ */
+function createEmptyBucket(capacity) {
+  return {
+    portals: {},
+    capacity: capacity,
+    updater: null
+  };
+}
+
+/**
+ * A utility class to manage and dynamically scale React portals across multiple buckets.
+ * It allows for efficient rendering of large numbers of React portals by distributing them
+ * across "buckets" and updating these buckets as necessary to balance load and performance.
+ *
+ * @class PortalManager
+ * @typedef {Object} PortalManager
+ *
+ * @property {number} maxBucketCapacity - The maximum capacity of each bucket before a new bucket is created.
+ * @property {number} scaleRatio - The ratio to determine the number of new buckets to add when scaling up.
+ * @property {Array<PortalBucketType>} buckets - An array of bucket objects where each bucket holds a record of React portals.
+ * @property {Set<number>} availableBuckets - A set of indices representing buckets that have available capacity.
+ * @property {Map<React.Key, number>} portalToBucketMap - A map of React portal keys to their corresponding bucket indices.
+ * @property {PortalRendererUpdater|null} portalRendererUpdater - A function to trigger updates to the rendering of portals.
+ * @property {number} scaleCapacityThreshold - The threshold at which the buckets are scaled up to accommodate more portals.
+ *
+ * @param {number} [initialBuckets=DEFAULT_INITIAL_BUCKETS] - The initial number of buckets to create.
+ * @param {number} [maxBucketCapacity=DEFAULT_MAX_BUCKET_CAPACITY] - The maximum number of portals a single bucket can hold.
+ * @param {number} [scaleRatio=DEFAULT_SCALE_RATIO] - The ratio used to calculate the number of new buckets to add when scaling.
+ */
+export var PortalManager = /*#__PURE__*/function () {
+  function PortalManager() {
+    var initialBuckets = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_INITIAL_BUCKETS;
+    var maxBucketCapacity = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_MAX_BUCKET_CAPACITY;
+    var scaleRatio = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_SCALE_RATIO;
+    _classCallCheck(this, PortalManager);
+    this.maxBucketCapacity = maxBucketCapacity;
+    this.scaleRatio = scaleRatio;
+
+    // Initialise buckets array by creating an array of length `initialBuckets` containing empty buckets
+    this.buckets = Array.from({
+      length: initialBuckets
+    }, function () {
+      return createEmptyBucket(maxBucketCapacity);
+    });
+    this.portalToBucketMap = new Map();
+    this.availableBuckets = new Set(Array.from({
+      length: initialBuckets
+    }, function (_, i) {
+      return i;
+    }));
+    this.portalRendererUpdater = null;
+    this.scaleCapacityThreshold = maxBucketCapacity / 2;
+  }
+  _createClass(PortalManager, [{
+    key: "getCurrentBucket",
+    value: function getCurrentBucket() {
+      return this.availableBuckets.values().next().value;
+    }
+  }, {
+    key: "createBucket",
+    value: function createBucket() {
+      var _this$portalRendererU;
+      var currentBucket = this.getCurrentBucket();
+
+      //If the current bucket has capacity, skip this logic
+      if (this.buckets[currentBucket].capacity > 0) {
+        return;
+      } else {
+        // The current bucket is full, delete the bucket from the list of available buckets
+        this.availableBuckets.delete(currentBucket);
+      }
+
+      // Skip creating new bucket if there are buckets still available
+      if (this.availableBuckets.size > 0) {
+        return;
+      }
+
+      // Scale the buckets up only if there are no available buckets left
+      // Calculate how many new buckets need to be added
+      var numBucketsToAdd = Math.floor(this.buckets.length * this.scaleRatio);
+      this.buckets = _toConsumableArray(this.buckets);
+      for (var i = 0; i < numBucketsToAdd; i++) {
+        this.buckets.push(createEmptyBucket(this.maxBucketCapacity));
+        this.availableBuckets.add(this.buckets.length - 1);
+      }
+      (_this$portalRendererU = this.portalRendererUpdater) === null || _this$portalRendererU === void 0 || _this$portalRendererU.call(this, this.buckets);
+    }
+  }, {
+    key: "getBuckets",
+    value: function getBuckets() {
+      return this.buckets;
+    }
+  }, {
+    key: "registerBucket",
+    value: function registerBucket(id, updater) {
+      var _this$buckets$id$upda,
+        _this$buckets$id,
+        _this = this;
+      this.buckets[id].updater = updater;
+      (_this$buckets$id$upda = (_this$buckets$id = this.buckets[id]).updater) === null || _this$buckets$id$upda === void 0 || _this$buckets$id$upda.call(_this$buckets$id, function () {
+        return _objectSpread({}, _this.buckets[id].portals);
+      });
+    }
+  }, {
+    key: "unregisterBucket",
+    value: function unregisterBucket(id) {
+      this.buckets[id].updater = null;
+    }
+  }, {
+    key: "updateBuckets",
+    value: function updateBuckets(id) {
+      var _this$buckets$id$upda2,
+        _this$buckets$id2,
+        _this2 = this;
+      (_this$buckets$id$upda2 = (_this$buckets$id2 = this.buckets[id]).updater) === null || _this$buckets$id$upda2 === void 0 || _this$buckets$id$upda2.call(_this$buckets$id2, function () {
+        // new object is required to trigger react updates
+        return _objectSpread({}, _this2.buckets[id].portals);
+      });
+    }
+  }, {
+    key: "registerPortal",
+    value: function registerPortal(key, portal) {
+      var _this$portalToBucketM,
+        _this3 = this;
+      this.createBucket();
+      this.buckets[this.getCurrentBucket()].capacity -= 1;
+      var id = (_this$portalToBucketM = this.portalToBucketMap.get(key)) !== null && _this$portalToBucketM !== void 0 ? _this$portalToBucketM : this.getCurrentBucket();
+      this.portalToBucketMap.set(key, id);
+      if (this.buckets[id].portals[key] !== portal) {
+        this.buckets[id].portals[key] = portal;
+        this.updateBuckets(id);
+      }
+
+      //returns a function to unregister the portal
+      return function () {
+        delete _this3.buckets[id].portals[key];
+        _this3.portalToBucketMap.delete(key);
+        _this3.buckets[id].capacity += 1;
+        if (_this3.buckets[id].capacity > _this3.scaleCapacityThreshold) {
+          _this3.availableBuckets.add(id);
+        }
+        _this3.updateBuckets(id);
+      };
+    }
+  }, {
+    key: "registerPortalRenderer",
+    value: function registerPortalRenderer(updater) {
+      var _this4 = this;
+      if (!this.portalRendererUpdater) {
+        updater(function () {
+          return _this4.buckets;
+        });
+      }
+      this.portalRendererUpdater = updater;
+    }
+  }, {
+    key: "unregisterPortalRenderer",
+    value: function unregisterPortalRenderer() {
+      this.portalRendererUpdater = null;
+    }
+
+    /**
+     * Cleans up resources used by the PortalManager. This includes clearing all portals,
+     * unregistering all buckets, and resetting internal state.
+     */
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      var _this5 = this;
+      // Iterate through each bucket and clear its portals and unset the updater function
+      this.buckets.forEach(function (bucket, id) {
+        bucket.portals = {}; // Clearing all portals from the bucket
+        bucket.updater = null; // Unsetting the bucket's updater function
+        _this5.availableBuckets.add(id); // Mark all buckets as available
+      });
+      this.portalToBucketMap.clear();
+      this.portalRendererUpdater = null;
+      this.availableBuckets = new Set(this.buckets.map(function (_, index) {
+        return index;
+      }));
+    }
+  }]);
+  return PortalManager;
+}();

package/dist/esm/portal/index.js

@@ -0,0 +1,3 @@
+export { PortalManager } from './PortalManager';
+export { PortalBucket } from './PortalBucket';
+export { usePortalProvider } from './usePortalProvider';

package/dist/esm/portal/usePortalProvider.js

@@ -0,0 +1,70 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import React, { useEffect, useLayoutEffect, useMemo, useState } from 'react';
+import { createPortal } from 'react-dom';
+import { PortalBucket } from './PortalBucket';
+import { PortalManager } from './PortalManager';
+function createPortalRendererComponent(portalManager) {
+  return function PortalRenderer() {
+    var _useState = useState(portalManager.getBuckets()),
+      _useState2 = _slicedToArray(_useState, 2),
+      buckets = _useState2[0],
+      setBuckets = _useState2[1];
+    useLayoutEffect(function () {
+      portalManager.registerPortalRenderer(setBuckets);
+      return function () {
+        portalManager.unregisterPortalRenderer();
+      };
+    }, []);
+    var portalsElements = useMemo(function () {
+      return buckets.map(function (_, i) {
+        return /*#__PURE__*/React.createElement(PortalBucket, {
+          key: i,
+          id: i,
+          portalManager: portalManager
+        });
+      });
+    }, [buckets]);
+    return /*#__PURE__*/React.createElement(React.Fragment, null, portalsElements);
+  };
+}
+
+/**
+ * Initializes PortalManager and creates PortalRendererComponent. Offers an API (portalProviderAPI) for managing portals.
+ * @returns {[PortalProviderAPI, PortalRendererComponent]} An array containing two elements:
+ *         1. portalProviderAPI: An object providing an API for rendering and removing portals.
+ *         2. PortalRenderer: A React component responsible for rendering the portal content.
+ */
+export function usePortalProvider() {
+  var portalManager = useMemo(function () {
+    return new PortalManager();
+  }, []);
+  var PortalRenderer = useMemo(function () {
+    return createPortalRendererComponent(portalManager);
+  }, [portalManager]);
+  var portalProviderAPI = useMemo(function () {
+    var portalsMap = new Map();
+    return {
+      render: function render(key, children, container) {
+        var portal = /*#__PURE__*/createPortal(children(), container, key);
+        portalsMap.set(key, portalManager.registerPortal(key, portal));
+      },
+      remove: function remove(key) {
+        var _portalsMap$get;
+        (_portalsMap$get = portalsMap.get(key)) === null || _portalsMap$get === void 0 || _portalsMap$get();
+        portalsMap.delete(key);
+      },
+      destroy: function destroy() {
+        portalsMap.clear();
+        portalManager.destroy();
+      }
+    };
+  }, [portalManager]);
+
+  // Cleanup on unmount
+  useEffect(function () {
+    return function () {
+      portalProviderAPI.destroy();
+    };
+  }, [portalManager, portalProviderAPI]);
+  return [portalProviderAPI, PortalRenderer];
+}

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

@@ -15,7 +15,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "78.34.0";
+var packageVersion = "78.35.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/types/portal/PortalBucket.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import type { PortalManager } from './PortalManager';
+type PortalBucketProps = {
+    id: number;
+    portalManager: PortalManager;
+};
+/**
+ * A component for rendering portals managed by a `PortalManager`.
+ * It subscribes to a `PortalManager` instance to listen for changes in the portal content
+ * and renders the content of its assigned portal bucket.
+ *
+ * @param {PortalBucketProps} props The component props.
+ * @param {number} props.id The ID for the portal bucket. This ID is used by the `PortalManager` to manage the content of this bucket.
+ * @param {PortalManager} props.portalManager An instance of `PortalManager` which manages the registration and unregistration of portal buckets and their content.
+ * @returns {React.ReactElement} The React element(s) that are currently registered to this portal bucket.
+ */
+export declare function PortalBucket({ id, portalManager }: PortalBucketProps): JSX.Element;
+export {};

package/dist/types/portal/PortalManager.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="react" />
+type PortalsBucketUpdater = React.Dispatch<React.SetStateAction<Record<React.Key, React.ReactPortal>>>;
+type PortalRendererUpdater = React.Dispatch<React.SetStateAction<Array<PortalBucketType>>>;
+type PortalBucketType = {
+    portals: Record<React.Key, React.ReactPortal>;
+    capacity: number;
+    updater: PortalsBucketUpdater | null;
+};
+/**
+ * A utility class to manage and dynamically scale React portals across multiple buckets.
+ * It allows for efficient rendering of large numbers of React portals by distributing them
+ * across "buckets" and updating these buckets as necessary to balance load and performance.
+ *
+ * @class PortalManager
+ * @typedef {Object} PortalManager
+ *
+ * @property {number} maxBucketCapacity - The maximum capacity of each bucket before a new bucket is created.
+ * @property {number} scaleRatio - The ratio to determine the number of new buckets to add when scaling up.
+ * @property {Array<PortalBucketType>} buckets - An array of bucket objects where each bucket holds a record of React portals.
+ * @property {Set<number>} availableBuckets - A set of indices representing buckets that have available capacity.
+ * @property {Map<React.Key, number>} portalToBucketMap - A map of React portal keys to their corresponding bucket indices.
+ * @property {PortalRendererUpdater|null} portalRendererUpdater - A function to trigger updates to the rendering of portals.
+ * @property {number} scaleCapacityThreshold - The threshold at which the buckets are scaled up to accommodate more portals.
+ *
+ * @param {number} [initialBuckets=DEFAULT_INITIAL_BUCKETS] - The initial number of buckets to create.
+ * @param {number} [maxBucketCapacity=DEFAULT_MAX_BUCKET_CAPACITY] - The maximum number of portals a single bucket can hold.
+ * @param {number} [scaleRatio=DEFAULT_SCALE_RATIO] - The ratio used to calculate the number of new buckets to add when scaling.
+ */
+export declare class PortalManager {
+    private maxBucketCapacity;
+    private scaleRatio;
+    private buckets;
+    private availableBuckets;
+    private portalToBucketMap;
+    private portalRendererUpdater;
+    private scaleCapacityThreshold;
+    constructor(initialBuckets?: number, maxBucketCapacity?: number, scaleRatio?: number);
+    private getCurrentBucket;
+    private createBucket;
+    getBuckets(): PortalBucketType[];
+    registerBucket(id: number, updater: PortalsBucketUpdater): void;
+    unregisterBucket(id: number): void;
+    updateBuckets(id: number): void;
+    registerPortal(key: React.Key, portal: React.ReactPortal): () => void;
+    registerPortalRenderer(updater: PortalRendererUpdater): void;
+    unregisterPortalRenderer(): void;
+    /**
+     * Cleans up resources used by the PortalManager. This includes clearing all portals,
+     * unregistering all buckets, and resetting internal state.
+     */
+    destroy(): void;
+}
+export {};

package/dist/types/portal/index.d.ts

@@ -0,0 +1,3 @@
+export { PortalManager } from './PortalManager';
+export { PortalBucket } from './PortalBucket';
+export { usePortalProvider } from './usePortalProvider';

package/dist/types/portal/usePortalProvider.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+type RenderFn = (key: string, children: () => React.ReactChild | JSX.Element | null, container: HTMLElement) => void;
+type RemoveFn = (key: string) => void;
+interface PortalProviderAPI {
+    render: RenderFn;
+    remove: RemoveFn;
+    destroy: () => void;
+}
+type PortalRendererComponent = () => JSX.Element;
+type UsePortalProviderReturnType = [PortalProviderAPI, PortalRendererComponent];
+/**
+ * Initializes PortalManager and creates PortalRendererComponent. Offers an API (portalProviderAPI) for managing portals.
+ * @returns {[PortalProviderAPI, PortalRendererComponent]} An array containing two elements:
+ *         1. portalProviderAPI: An object providing an API for rendering and removing portals.
+ *         2. PortalRenderer: A React component responsible for rendering the portal content.
+ */
+export declare function usePortalProvider(): UsePortalProviderReturnType;
+export {};

package/dist/types-ts4.5/portal/PortalBucket.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import type { PortalManager } from './PortalManager';
+type PortalBucketProps = {
+    id: number;
+    portalManager: PortalManager;
+};
+/**
+ * A component for rendering portals managed by a `PortalManager`.
+ * It subscribes to a `PortalManager` instance to listen for changes in the portal content
+ * and renders the content of its assigned portal bucket.
+ *
+ * @param {PortalBucketProps} props The component props.
+ * @param {number} props.id The ID for the portal bucket. This ID is used by the `PortalManager` to manage the content of this bucket.
+ * @param {PortalManager} props.portalManager An instance of `PortalManager` which manages the registration and unregistration of portal buckets and their content.
+ * @returns {React.ReactElement} The React element(s) that are currently registered to this portal bucket.
+ */
+export declare function PortalBucket({ id, portalManager }: PortalBucketProps): JSX.Element;
+export {};

package/dist/types-ts4.5/portal/PortalManager.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="react" />
+type PortalsBucketUpdater = React.Dispatch<React.SetStateAction<Record<React.Key, React.ReactPortal>>>;
+type PortalRendererUpdater = React.Dispatch<React.SetStateAction<Array<PortalBucketType>>>;
+type PortalBucketType = {
+    portals: Record<React.Key, React.ReactPortal>;
+    capacity: number;
+    updater: PortalsBucketUpdater | null;
+};
+/**
+ * A utility class to manage and dynamically scale React portals across multiple buckets.
+ * It allows for efficient rendering of large numbers of React portals by distributing them
+ * across "buckets" and updating these buckets as necessary to balance load and performance.
+ *
+ * @class PortalManager
+ * @typedef {Object} PortalManager
+ *
+ * @property {number} maxBucketCapacity - The maximum capacity of each bucket before a new bucket is created.
+ * @property {number} scaleRatio - The ratio to determine the number of new buckets to add when scaling up.
+ * @property {Array<PortalBucketType>} buckets - An array of bucket objects where each bucket holds a record of React portals.
+ * @property {Set<number>} availableBuckets - A set of indices representing buckets that have available capacity.
+ * @property {Map<React.Key, number>} portalToBucketMap - A map of React portal keys to their corresponding bucket indices.
+ * @property {PortalRendererUpdater|null} portalRendererUpdater - A function to trigger updates to the rendering of portals.
+ * @property {number} scaleCapacityThreshold - The threshold at which the buckets are scaled up to accommodate more portals.
+ *
+ * @param {number} [initialBuckets=DEFAULT_INITIAL_BUCKETS] - The initial number of buckets to create.
+ * @param {number} [maxBucketCapacity=DEFAULT_MAX_BUCKET_CAPACITY] - The maximum number of portals a single bucket can hold.
+ * @param {number} [scaleRatio=DEFAULT_SCALE_RATIO] - The ratio used to calculate the number of new buckets to add when scaling.
+ */
+export declare class PortalManager {
+    private maxBucketCapacity;
+    private scaleRatio;
+    private buckets;
+    private availableBuckets;
+    private portalToBucketMap;
+    private portalRendererUpdater;
+    private scaleCapacityThreshold;
+    constructor(initialBuckets?: number, maxBucketCapacity?: number, scaleRatio?: number);
+    private getCurrentBucket;
+    private createBucket;
+    getBuckets(): PortalBucketType[];
+    registerBucket(id: number, updater: PortalsBucketUpdater): void;
+    unregisterBucket(id: number): void;
+    updateBuckets(id: number): void;
+    registerPortal(key: React.Key, portal: React.ReactPortal): () => void;
+    registerPortalRenderer(updater: PortalRendererUpdater): void;
+    unregisterPortalRenderer(): void;
+    /**
+     * Cleans up resources used by the PortalManager. This includes clearing all portals,
+     * unregistering all buckets, and resetting internal state.
+     */
+    destroy(): void;
+}
+export {};

package/dist/types-ts4.5/portal/index.d.ts

@@ -0,0 +1,3 @@
+export { PortalManager } from './PortalManager';
+export { PortalBucket } from './PortalBucket';
+export { usePortalProvider } from './usePortalProvider';

package/dist/types-ts4.5/portal/usePortalProvider.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+type RenderFn = (key: string, children: () => React.ReactChild | JSX.Element | null, container: HTMLElement) => void;
+type RemoveFn = (key: string) => void;
+interface PortalProviderAPI {
+    render: RenderFn;
+    remove: RemoveFn;
+    destroy: () => void;
+}
+type PortalRendererComponent = () => JSX.Element;
+type UsePortalProviderReturnType = [
+    PortalProviderAPI,
+    PortalRendererComponent
+];
+/**
+ * Initializes PortalManager and creates PortalRendererComponent. Offers an API (portalProviderAPI) for managing portals.
+ * @returns {[PortalProviderAPI, PortalRendererComponent]} An array containing two elements:
+ *         1. portalProviderAPI: An object providing an API for rendering and removing portals.
+ *         2. PortalRenderer: A React component responsible for rendering the portal content.
+ */
+export declare function usePortalProvider(): UsePortalProviderReturnType;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "78.34.0",
+  "version": "78.35.0",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -49,6 +49,7 @@
     "./collab": "./src/collab/index.ts",
     "./emoji": "./src/emoji.ts",
     "./mention": "./src/mention.ts",
+    "./portal": "./src/portal/index.ts",
     "./provider-helpers": "./src/provider-helpers/index.ts",
     "./icons": "./src/icons/index.ts",
     "./safe-plugin": "./src/safe-plugin/index.ts",

package/portal/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-common/portal",
+  "main": "../dist/cjs/portal/index.js",
+  "module": "../dist/esm/portal/index.js",
+  "module:es2019": "../dist/es2019/portal/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/portal/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/portal/index.d.ts"
+      ]
+    }
+  }
+}