@atlaskit/editor-common 78.34.0 → 78.36.0

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

@@ -0,0 +1,183 @@
+/** @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 let 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
+const buttonStyles = css`
+  position: absolute;
+  display: flex;
+  height: 28px;
+  width: 28px;
+  margin: ${"var(--ds-space-075, 6px)"};
+  right: 0;
+  top: 0;
+  border: 2px solid ${"var(--ds-border, #fff)"};
+  border-radius: ${"var(--ds-border-radius-100, 4px)"};
+  background-color: ${`var(--ds-surface-overlay, ${N20})`};
+  justify-content: center;
+  align-items: center;
+  cursor: pointer;
+
+  &:hover {
+    background-color: ${`var(--ds-surface-overlay-hovered, ${N30})`};
+  }
+
+  &:active {
+    background-color: ${"var(--ds-surface-overlay-pressed, rgba(179, 212, 255, 0.6))"};
+  }
+
+  &.${SORTABLE_COLUMN_ICON_CLASSNAME}__not-allowed {
+    cursor: not-allowed;
+  }
+`;
+
+// eslint-disable-next-line @atlaskit/design-system/no-css-tagged-template-expression -- needs manual remediation
+const iconWrapperStyles = css`
+  width: 8px;
+  height: 12px;
+  transition: transform 0.3s cubic-bezier(0.15, 1, 0.3, 1);
+  transform-origin: 50% 50%;
+  display: flex;
+  justify-content: center;
+
+  &.${StatusClassNames.DESC} {
+    transform: rotate(-180deg);
+  }
+
+  &.${SORTABLE_COLUMN_ICON_CLASSNAME}-inactive {
+    opacity: 0.7;
+  }
+`;
+
+// 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
+const 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)'
+  }
+});
+const getIconClassName = (isSortingAllowed, sortOrdered) => {
+  const activated = sortOrdered !== SortOrder.NO_ORDER;
+  const activeStatusClass = `${SORTABLE_COLUMN_ICON_CLASSNAME}-${activated ? 'active' : 'inactive'}`;
+  if (!isSortingAllowed) {
+    return `${StatusClassNames.SORTING_NOT_ALLOWED} ${activeStatusClass}`;
+  }
+  switch (sortOrdered) {
+    case SortOrder.ASC:
+      return `${StatusClassNames.ASC} ${activeStatusClass}`;
+    case SortOrder.DESC:
+      return `${StatusClassNames.DESC} ${activeStatusClass}`;
+    default:
+      return `${StatusClassNames.NO_ORDER} ${activeStatusClass}`;
+  }
+};
+const getTooltipTitle = (intl, isSortingAllowed, sortOrdered) => {
+  const {
+    noOrderLabel,
+    ascOrderLabel,
+    descOrderLabel,
+    invalidLabel
+  } = sortingIconMessages;
+  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 '';
+};
+const getAriaLabel = (intl, isSortingAllowed, sortOrdered) => {
+  const {
+    noOrderLabel,
+    ascOrderLabel,
+    descOrderLabel,
+    invalidLabel,
+    defaultLabel
+  } = sortingAriaLabelMessages;
+  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);
+};
+const SortingIcon = ({
+  isSortingAllowed,
+  sortOrdered,
+  intl,
+  onClick,
+  onKeyDown
+}) => {
+  const buttonClassName = `${SORTABLE_COLUMN_ICON_CLASSNAME} ${sortOrdered !== SortOrder.NO_ORDER ? 'is-active' : ''}${isSortingAllowed ? '' : ` ${SORTABLE_COLUMN_ICON_CLASSNAME}__not-allowed `}`;
+  const content = getTooltipTitle(intl, isSortingAllowed, sortOrdered);
+  const ariaLabel = getAriaLabel(intl, isSortingAllowed, sortOrdered);
+  const handleClick = () => {
+    if (isSortingAllowed) {
+      onClick();
+    }
+  };
+  const 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/es2019/table/consts.js

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

package/dist/es2019/table/index.js

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

package/dist/es2019/table/messages.js

@@ -0,0 +1,50 @@
+import { defineMessages } from 'react-intl-next';
+export const 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: `⚠️  You can't sort a table with merged cells`,
+    description: 'this sort is invalid for merged cells'
+  }
+});
+export const 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/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.36.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.36.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);
+}