@atlaskit/editor-common 78.34.0 → 78.36.0

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/table/SortingIcon.js

@@ -0,0 +1,139 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _templateObject, _templateObject2;
+/** @jsx jsx */
+import { css, jsx } from '@emotion/react';
+import { injectIntl } from 'react-intl-next';
+import { N20, N30 } from '@atlaskit/theme/colors';
+import Tooltip from '@atlaskit/tooltip';
+import { SortOrder } from '../types';
+import { SORTABLE_COLUMN_ICON_CLASSNAME } from './consts';
+import { sortingAriaLabelMessages, sortingIconMessages } from './messages';
+export var StatusClassNames = /*#__PURE__*/function (StatusClassNames) {
+  StatusClassNames["ASC"] = "sorting-icon-svg__asc";
+  StatusClassNames["DESC"] = "sorting-icon-svg__desc";
+  StatusClassNames["NO_ORDER"] = "sorting-icon-svg__no_order";
+  StatusClassNames["SORTING_NOT_ALLOWED"] = "sorting-icon-svg__not-allowed";
+  return StatusClassNames;
+}({});
+
+// eslint-disable-next-line @atlaskit/design-system/no-css-tagged-template-expression -- needs manual remediation
+var buttonStyles = css(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  position: absolute;\n  display: flex;\n  height: 28px;\n  width: 28px;\n  margin: ", ";\n  right: 0;\n  top: 0;\n  border: 2px solid ", ";\n  border-radius: ", ";\n  background-color: ", ";\n  justify-content: center;\n  align-items: center;\n  cursor: pointer;\n\n  &:hover {\n    background-color: ", ";\n  }\n\n  &:active {\n    background-color: ", ";\n  }\n\n  &.", "__not-allowed {\n    cursor: not-allowed;\n  }\n"])), "var(--ds-space-075, 6px)", "var(--ds-border, #fff)", "var(--ds-border-radius-100, 4px)", "var(--ds-surface-overlay, ".concat(N20, ")"), "var(--ds-surface-overlay-hovered, ".concat(N30, ")"), "var(--ds-surface-overlay-pressed, rgba(179, 212, 255, 0.6))", SORTABLE_COLUMN_ICON_CLASSNAME);
+
+// eslint-disable-next-line @atlaskit/design-system/no-css-tagged-template-expression -- needs manual remediation
+var iconWrapperStyles = css(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n  width: 8px;\n  height: 12px;\n  transition: transform 0.3s cubic-bezier(0.15, 1, 0.3, 1);\n  transform-origin: 50% 50%;\n  display: flex;\n  justify-content: center;\n\n  &.", " {\n    transform: rotate(-180deg);\n  }\n\n  &.", "-inactive {\n    opacity: 0.7;\n  }\n"])), StatusClassNames.DESC, SORTABLE_COLUMN_ICON_CLASSNAME);
+
+// The icon is created with CSS due to the following Firefox issue: https://product-fabric.atlassian.net/browse/ED-8001
+// The TL;DR is that svg's in tables mess up how HTML is copied in Firefox. Using a styled div instead solves the problem.
+// For this reason, svg's should be avoided in tables until this issue is fixed: https://bugzilla.mozilla.org/show_bug.cgi?id=1664350
+var iconStyles = css({
+  height: '100%',
+  width: '2px',
+  borderRadius: '50px',
+  background: "var(--ds-icon, #42526E)",
+  '&::before, &::after': {
+    background: "var(--ds-icon, #42526E)",
+    content: "''",
+    height: '2px',
+    width: '6px',
+    position: 'absolute',
+    borderRadius: '50px'
+  },
+  '&::before': {
+    transform: 'rotate(45deg) translate(3.4px, 8.5px)'
+  },
+  '&::after': {
+    transform: 'rotate(-45deg) translate(-6.3px, 5.7px)'
+  }
+});
+var getIconClassName = function getIconClassName(isSortingAllowed, sortOrdered) {
+  var activated = sortOrdered !== SortOrder.NO_ORDER;
+  var activeStatusClass = "".concat(SORTABLE_COLUMN_ICON_CLASSNAME, "-").concat(activated ? 'active' : 'inactive');
+  if (!isSortingAllowed) {
+    return "".concat(StatusClassNames.SORTING_NOT_ALLOWED, " ").concat(activeStatusClass);
+  }
+  switch (sortOrdered) {
+    case SortOrder.ASC:
+      return "".concat(StatusClassNames.ASC, " ").concat(activeStatusClass);
+    case SortOrder.DESC:
+      return "".concat(StatusClassNames.DESC, " ").concat(activeStatusClass);
+    default:
+      return "".concat(StatusClassNames.NO_ORDER, " ").concat(activeStatusClass);
+  }
+};
+var getTooltipTitle = function getTooltipTitle(intl, isSortingAllowed, sortOrdered) {
+  var noOrderLabel = sortingIconMessages.noOrderLabel,
+    ascOrderLabel = sortingIconMessages.ascOrderLabel,
+    descOrderLabel = sortingIconMessages.descOrderLabel,
+    invalidLabel = sortingIconMessages.invalidLabel;
+  if (!isSortingAllowed) {
+    return intl.formatMessage(invalidLabel);
+  }
+  switch (sortOrdered) {
+    case SortOrder.NO_ORDER:
+      return intl.formatMessage(noOrderLabel);
+    case SortOrder.ASC:
+      return intl.formatMessage(ascOrderLabel);
+    case SortOrder.DESC:
+      return intl.formatMessage(descOrderLabel);
+  }
+  return '';
+};
+var getAriaLabel = function getAriaLabel(intl, isSortingAllowed, sortOrdered) {
+  var noOrderLabel = sortingAriaLabelMessages.noOrderLabel,
+    ascOrderLabel = sortingAriaLabelMessages.ascOrderLabel,
+    descOrderLabel = sortingAriaLabelMessages.descOrderLabel,
+    invalidLabel = sortingAriaLabelMessages.invalidLabel,
+    defaultLabel = sortingAriaLabelMessages.defaultLabel;
+  if (!isSortingAllowed) {
+    return intl.formatMessage(invalidLabel);
+  }
+  switch (sortOrdered) {
+    case SortOrder.NO_ORDER:
+      return intl.formatMessage(noOrderLabel);
+    case SortOrder.ASC:
+      return intl.formatMessage(ascOrderLabel);
+    case SortOrder.DESC:
+      return intl.formatMessage(descOrderLabel);
+  }
+  return intl.formatMessage(defaultLabel);
+};
+var SortingIcon = function SortingIcon(_ref) {
+  var isSortingAllowed = _ref.isSortingAllowed,
+    sortOrdered = _ref.sortOrdered,
+    intl = _ref.intl,
+    onClick = _ref.onClick,
+    onKeyDown = _ref.onKeyDown;
+  var buttonClassName = "".concat(SORTABLE_COLUMN_ICON_CLASSNAME, " ").concat(sortOrdered !== SortOrder.NO_ORDER ? 'is-active' : '').concat(isSortingAllowed ? '' : " ".concat(SORTABLE_COLUMN_ICON_CLASSNAME, "__not-allowed "));
+  var content = getTooltipTitle(intl, isSortingAllowed, sortOrdered);
+  var ariaLabel = getAriaLabel(intl, isSortingAllowed, sortOrdered);
+  var handleClick = function handleClick() {
+    if (isSortingAllowed) {
+      onClick();
+    }
+  };
+  var handleKeyDown = function handleKeyDown(event) {
+    if (isSortingAllowed) {
+      onKeyDown(event);
+    }
+  };
+  return jsx(Tooltip, {
+    delay: 0,
+    content: content,
+    position: "top"
+  }, jsx("div", {
+    css: buttonStyles,
+    className: buttonClassName,
+    role: "button",
+    tabIndex: isSortingAllowed ? 0 : -1,
+    "aria-label": ariaLabel,
+    "aria-disabled": !isSortingAllowed,
+    onClick: handleClick,
+    onKeyDown: handleKeyDown
+  }, jsx("div", {
+    css: iconWrapperStyles,
+    className: getIconClassName(isSortingAllowed, sortOrdered)
+  }, jsx("div", {
+    css: iconStyles
+  }))));
+};
+export default injectIntl(SortingIcon);

package/dist/esm/table/consts.js

@@ -0,0 +1 @@
+export var SORTABLE_COLUMN_ICON_CLASSNAME = "ak-renderer-tableHeader-sorting-icon";

package/dist/esm/table/index.js

@@ -0,0 +1,2 @@
+export { SORTABLE_COLUMN_ICON_CLASSNAME } from './consts';
+export { default as SortingIcon, StatusClassNames } from './SortingIcon';

package/dist/esm/table/messages.js

@@ -0,0 +1,50 @@
+import { defineMessages } from 'react-intl-next';
+export var sortingIconMessages = defineMessages({
+  noOrderLabel: {
+    id: 'fabric.editor.headingLink.noOrderLabel',
+    defaultMessage: 'Sort column A to Z',
+    description: 'Sort the column in ascending order'
+  },
+  ascOrderLabel: {
+    id: 'fabric.editor.headingLink.ascOrderLabel',
+    defaultMessage: 'Sort column Z to A',
+    description: 'Sort the column in descending order'
+  },
+  descOrderLabel: {
+    id: 'fabric.editor.headingLink.descOrderLabel',
+    defaultMessage: 'Clear sorting',
+    description: 'clear the sorting from this column'
+  },
+  invalidLabel: {
+    id: 'fabric.editor.headingLink.invalidLabel',
+    defaultMessage: "\u26A0\uFE0F  You can't sort a table with merged cells",
+    description: 'this sort is invalid for merged cells'
+  }
+});
+export var sortingAriaLabelMessages = defineMessages({
+  noOrderLabel: {
+    id: 'fabric.editor.tableHeader.sorting.no',
+    defaultMessage: 'No sort applied to the column',
+    description: 'Aria-label for Sort column button when sorting was not applied or the sorting has been cleared'
+  },
+  ascOrderLabel: {
+    id: 'fabric.editor.tableHeader.sorting.asc',
+    defaultMessage: 'Ascending sort applied',
+    description: 'Aria-label for Sort column button when ascending sorting was applied'
+  },
+  descOrderLabel: {
+    id: 'fabric.editor.tableHeader.sorting.desc',
+    defaultMessage: 'Descending sort applied',
+    description: 'Aria-label for Sort column button when descending sorting was applied'
+  },
+  invalidLabel: {
+    id: 'fabric.editor.tableHeader.sorting.invalid',
+    defaultMessage: "You can't sort a table with merged cells",
+    description: 'Aria-label for Sort column button when sorting is not possible'
+  },
+  defaultLabel: {
+    id: 'fabric.editor.tableHeader.sorting.default',
+    defaultMessage: 'Sort the column',
+    description: 'Default aria-label for Sort column button'
+  }
+});

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.36.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/table/SortingIcon.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import type { WrappedComponentProps } from 'react-intl-next';
+import { SortOrder } from '../types';
+export declare enum StatusClassNames {
+    ASC = "sorting-icon-svg__asc",
+    DESC = "sorting-icon-svg__desc",
+    NO_ORDER = "sorting-icon-svg__no_order",
+    SORTING_NOT_ALLOWED = "sorting-icon-svg__not-allowed"
+}
+declare const _default: import("react").FC<import("react-intl-next").WithIntlProps<{
+    isSortingAllowed: boolean;
+    sortOrdered?: SortOrder | undefined;
+    onClick: () => void;
+    onKeyDown: (event: import("react").KeyboardEvent<HTMLElement>) => void;
+} & WrappedComponentProps>> & {
+    WrappedComponent: import("react").ComponentType<{
+        isSortingAllowed: boolean;
+        sortOrdered?: SortOrder | undefined;
+        onClick: () => void;
+        onKeyDown: (event: import("react").KeyboardEvent<HTMLElement>) => void;
+    } & WrappedComponentProps>;
+};
+export default _default;

package/dist/types/table/consts.d.ts

@@ -0,0 +1 @@
+export declare const SORTABLE_COLUMN_ICON_CLASSNAME = "ak-renderer-tableHeader-sorting-icon";

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

@@ -0,0 +1,2 @@
+export { SORTABLE_COLUMN_ICON_CLASSNAME } from './consts';
+export { default as SortingIcon, StatusClassNames } from './SortingIcon';

package/dist/types/table/messages.d.ts

@@ -0,0 +1,49 @@
+export declare const sortingIconMessages: {
+    noOrderLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    ascOrderLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    descOrderLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    invalidLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const sortingAriaLabelMessages: {
+    noOrderLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    ascOrderLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    descOrderLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    invalidLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    defaultLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};