@atlaskit/editor-common 78.34.0 → 78.36.0

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/dist/types-ts4.5/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-ts4.5/table/consts.d.ts

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

package/dist/types-ts4.5/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-ts4.5/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;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "78.34.0",
+  "version": "78.36.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",
@@ -91,7 +92,8 @@
     "./annotation": "./src/annotation/index.ts",
     "./constants": "./src/link/constants.ts",
     "./doc-utils": "./src/doc-utils/index.ts",
-    "./expand": "./src/expand/index.ts"
+    "./expand": "./src/expand/index.ts",
+    "./table": "./src/table/index.ts"
   },
   "dependencies": {
     "@atlaskit/activity-provider": "^2.4.0",

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"
+      ]
+    }
+  }
+}

package/table/package.json

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