@atlaskit/editor-plugin-block-menu 5.1.7 → 5.1.8

package/dist/esm/ui/utils/suggested-items-rank.js

@@ -18,22 +18,6 @@ var _TRANSFORM_SUGGESTED_;
  */
 
 import { TRANSFORM_STRUCTURE_PANEL_MENU_ITEM, TRANSFORM_STRUCTURE_EXPAND_MENU_ITEM, TRANSFORM_STRUCTURE_LAYOUT_MENU_ITEM, TRANSFORM_STRUCTURE_QUOTE_MENU_ITEM, TRANSFORM_STRUCTURE_CODE_BLOCK_MENU_ITEM, TRANSFORM_STRUCTURE_BULLETED_LIST_MENU_ITEM, TRANSFORM_STRUCTURE_NUMBERED_LIST_MENU_ITEM, TRANSFORM_STRUCTURE_TASK_LIST_MENU_ITEM, TRANSFORM_HEADINGS_H2_MENU_ITEM, TRANSFORM_HEADINGS_H3_MENU_ITEM, TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM } from '@atlaskit/editor-common/block-menu';
-/**
- * Node type keys that map to ProseMirror node types from the ADF schema.
- * These values must match the NodeTypeName type.
- *
- * TypeScript will enforce that all values are valid NodeTypeName values.
- * If a new node type is added, it must be added to NodeTypeName first.
- *
- * Reference: packages/editor/editor-plugin-block-menu/src/editor-commands/transform-node-utils/types.ts
- *
- * Note: 'heading' represents all heading levels (1-6) as a single node type.
- * The specific level is determined by the node's `attrs.level` property at runtime.
- *
- * @example
- * // Usage:
- * const nodeType = BLOCK_MENU_NODE_TYPES.PARAGRAPH; // Type: "paragraph"
- */
 export var BLOCK_MENU_NODE_TYPES = {
   PARAGRAPH: 'paragraph',
   EXPAND: 'expand',
@@ -53,35 +37,10 @@ export var BLOCK_MENU_NODE_TYPES = {
   EMBED_CARD: 'embedCard',
   TABLE: 'table'
 };
-
-/**
- * Type for node type values extracted from BLOCK_MENU_NODE_TYPES
- */
-
-/**
- * Type for the suggested items rank mapping
- */
-
-/**
- * Mapping of source node types to suggested transformation menu items with their ranks.
- * Lower rank number = higher priority in the suggested menu section.
- */
 export var TRANSFORM_SUGGESTED_ITEMS_RANK = (_TRANSFORM_SUGGESTED_ = {}, _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_TRANSFORM_SUGGESTED_, BLOCK_MENU_NODE_TYPES.PARAGRAPH, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_HEADINGS_H2_MENU_ITEM.key, 200), TRANSFORM_HEADINGS_H3_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.EXPAND, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_LAYOUT_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.BLOCKQUOTE, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_LAYOUT_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.LAYOUT_SECTION, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_EXPAND_MENU_ITEM.key, 200), TRANSFORM_HEADINGS_H2_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.PANEL, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_QUOTE_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_CODE_BLOCK_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.CODE_BLOCK, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_EXPAND_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_LAYOUT_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.DECISION, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_TASK_LIST_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.BULLET_LIST, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_NUMBERED_LIST_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_QUOTE_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.ORDERED_LIST, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_BULLETED_LIST_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_TASK_LIST_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.HEADING, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 100), TRANSFORM_HEADINGS_H2_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 300)), _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_TRANSFORM_SUGGESTED_, BLOCK_MENU_NODE_TYPES.TASK_LIST, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_NUMBERED_LIST_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_CODE_BLOCK_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.MEDIA_SINGLE, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_LAYOUT_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.EXTENSION, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_EXPAND_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.BODIED_EXTENSION, _defineProperty(_defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 200), TRANSFORM_STRUCTURE_EXPAND_MENU_ITEM.key, 300)), BLOCK_MENU_NODE_TYPES.BLOCK_CARD, _defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 200)), BLOCK_MENU_NODE_TYPES.EMBED_CARD, _defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_PANEL_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_PARAGRAPH_MENU_ITEM.key, 200)), BLOCK_MENU_NODE_TYPES.TABLE, _defineProperty(_defineProperty({}, TRANSFORM_STRUCTURE_EXPAND_MENU_ITEM.key, 100), TRANSFORM_STRUCTURE_LAYOUT_MENU_ITEM.key, 200)));
-
-/**
- * Get suggested menu items for a given node type
- * @param nodeType - The source node type (e.g., 'paragraph', 'heading')
- * @returns Object mapping menu item keys to their ranks, or undefined if no suggestions
- */
 export var getSuggestedItemsForNodeType = function getSuggestedItemsForNodeType(nodeType) {
   return TRANSFORM_SUGGESTED_ITEMS_RANK[nodeType];
 };
-
-/**
- * Get sorted suggested menu item keys for a given node type
- * @param nodeType - The source node type
- * @returns Array of menu item keys sorted by rank (highest priority first)
- */
 export var getSortedSuggestedItems = function getSortedSuggestedItems(nodeType) {
   var suggestions = getSuggestedItemsForNodeType(nodeType);
   if (!suggestions) {

package/dist/types/editor-commands/transform-node-utils/wrapMixedContentStep.d.ts

@@ -0,0 +1,20 @@
+import type { TransformStep } from './types';
+/**
+ * A wrap step that handles mixed content according to the Compatibility Matrix:
+ * - Wraps consecutive compatible nodes into the target container
+ * - Same-type containers break out as separate containers (preserved as-is)
+ * - NestedExpands break out as regular expands (converted since nestedExpand can't exist outside expand)
+ * - Container structures that can't be nested in target break out (not flattened)
+ * - Text/list nodes that can't be wrapped are flattened and merged into the container
+ * - Atomic nodes (tables, media, macros) break out
+ *
+ * What can be wrapped depends on the target container's schema:
+ * - expand → panel: tables break out, nestedExpands convert to expands and break out
+ * - expand → blockquote: tables/media break out, nestedExpands convert to expands and break out
+ * - expand → expand: tables/media stay inside (expands can contain them)
+ *
+ * Example: expand(p('a'), table(), p('b')) → panel: [panel(p('a')), table(), panel(p('b'))]
+ * Example: expand(p('a'), panel(p('x')), p('b')) → panel: [panel(p('a')), panel(p('x')), panel(p('b'))]
+ * Example: expand(p('a'), nestedExpand({title: 'inner'})(p('x')), p('b')) → panel: [panel(p('a')), expand({title: 'inner'})(p('x')), panel(p('b'))]
+ */
+export declare const wrapMixedContentStep: TransformStep;

package/dist/types/ui/suggested-items-renderer.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { BlockMenuPlugin } from '../blockMenuPluginType';
+type SuggestedItemsRendererProps = {
+    api: ExtractInjectionAPI<BlockMenuPlugin> | undefined;
+};
+export declare const SuggestedItemsRenderer: React.NamedExoticComponent<SuggestedItemsRendererProps>;
+export {};

package/dist/types/ui/utils/suggested-items-rank.d.ts

@@ -13,22 +13,6 @@
  *   }
  * }
  */
-/**
- * Node type keys that map to ProseMirror node types from the ADF schema.
- * These values must match the NodeTypeName type.
- *
- * TypeScript will enforce that all values are valid NodeTypeName values.
- * If a new node type is added, it must be added to NodeTypeName first.
- *
- * Reference: packages/editor/editor-plugin-block-menu/src/editor-commands/transform-node-utils/types.ts
- *
- * Note: 'heading' represents all heading levels (1-6) as a single node type.
- * The specific level is determined by the node's `attrs.level` property at runtime.
- *
- * @example
- * // Usage:
- * const nodeType = BLOCK_MENU_NODE_TYPES.PARAGRAPH; // Type: "paragraph"
- */
 export declare const BLOCK_MENU_NODE_TYPES: {
     readonly PARAGRAPH: "paragraph";
     readonly EXPAND: "expand";
@@ -48,34 +32,14 @@ export declare const BLOCK_MENU_NODE_TYPES: {
     readonly EMBED_CARD: "embedCard";
     readonly TABLE: "table";
 };
-/**
- * Type for node type values extracted from BLOCK_MENU_NODE_TYPES
- */
 export type BlockMenuNodeType = (typeof BLOCK_MENU_NODE_TYPES)[keyof typeof BLOCK_MENU_NODE_TYPES];
-/**
- * Type for the suggested items rank mapping
- */
 export type SuggestedItemsRankMap = {
     [nodeType: string]: {
         [menuItemKey: string]: number;
     };
 };
-/**
- * Mapping of source node types to suggested transformation menu items with their ranks.
- * Lower rank number = higher priority in the suggested menu section.
- */
 export declare const TRANSFORM_SUGGESTED_ITEMS_RANK: SuggestedItemsRankMap;
-/**
- * Get suggested menu items for a given node type
- * @param nodeType - The source node type (e.g., 'paragraph', 'heading')
- * @returns Object mapping menu item keys to their ranks, or undefined if no suggestions
- */
 export declare const getSuggestedItemsForNodeType: (nodeType: string) => {
     [menuItemKey: string]: number;
 } | undefined;
-/**
- * Get sorted suggested menu item keys for a given node type
- * @param nodeType - The source node type
- * @returns Array of menu item keys sorted by rank (highest priority first)
- */
 export declare const getSortedSuggestedItems: (nodeType: string) => string[];

package/dist/types-ts4.5/editor-commands/transform-node-utils/wrapMixedContentStep.d.ts

@@ -0,0 +1,20 @@
+import type { TransformStep } from './types';
+/**
+ * A wrap step that handles mixed content according to the Compatibility Matrix:
+ * - Wraps consecutive compatible nodes into the target container
+ * - Same-type containers break out as separate containers (preserved as-is)
+ * - NestedExpands break out as regular expands (converted since nestedExpand can't exist outside expand)
+ * - Container structures that can't be nested in target break out (not flattened)
+ * - Text/list nodes that can't be wrapped are flattened and merged into the container
+ * - Atomic nodes (tables, media, macros) break out
+ *
+ * What can be wrapped depends on the target container's schema:
+ * - expand → panel: tables break out, nestedExpands convert to expands and break out
+ * - expand → blockquote: tables/media break out, nestedExpands convert to expands and break out
+ * - expand → expand: tables/media stay inside (expands can contain them)
+ *
+ * Example: expand(p('a'), table(), p('b')) → panel: [panel(p('a')), table(), panel(p('b'))]
+ * Example: expand(p('a'), panel(p('x')), p('b')) → panel: [panel(p('a')), panel(p('x')), panel(p('b'))]
+ * Example: expand(p('a'), nestedExpand({title: 'inner'})(p('x')), p('b')) → panel: [panel(p('a')), expand({title: 'inner'})(p('x')), panel(p('b'))]
+ */
+export declare const wrapMixedContentStep: TransformStep;

package/dist/types-ts4.5/ui/suggested-items-renderer.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { BlockMenuPlugin } from '../blockMenuPluginType';
+type SuggestedItemsRendererProps = {
+    api: ExtractInjectionAPI<BlockMenuPlugin> | undefined;
+};
+export declare const SuggestedItemsRenderer: React.NamedExoticComponent<SuggestedItemsRendererProps>;
+export {};

package/dist/types-ts4.5/ui/utils/suggested-items-rank.d.ts

@@ -13,22 +13,6 @@
  *   }
  * }
  */
-/**
- * Node type keys that map to ProseMirror node types from the ADF schema.
- * These values must match the NodeTypeName type.
- *
- * TypeScript will enforce that all values are valid NodeTypeName values.
- * If a new node type is added, it must be added to NodeTypeName first.
- *
- * Reference: packages/editor/editor-plugin-block-menu/src/editor-commands/transform-node-utils/types.ts
- *
- * Note: 'heading' represents all heading levels (1-6) as a single node type.
- * The specific level is determined by the node's `attrs.level` property at runtime.
- *
- * @example
- * // Usage:
- * const nodeType = BLOCK_MENU_NODE_TYPES.PARAGRAPH; // Type: "paragraph"
- */
 export declare const BLOCK_MENU_NODE_TYPES: {
     readonly PARAGRAPH: "paragraph";
     readonly EXPAND: "expand";
@@ -48,34 +32,14 @@ export declare const BLOCK_MENU_NODE_TYPES: {
     readonly EMBED_CARD: "embedCard";
     readonly TABLE: "table";
 };
-/**
- * Type for node type values extracted from BLOCK_MENU_NODE_TYPES
- */
 export type BlockMenuNodeType = (typeof BLOCK_MENU_NODE_TYPES)[keyof typeof BLOCK_MENU_NODE_TYPES];
-/**
- * Type for the suggested items rank mapping
- */
 export type SuggestedItemsRankMap = {
     [nodeType: string]: {
         [menuItemKey: string]: number;
     };
 };
-/**
- * Mapping of source node types to suggested transformation menu items with their ranks.
- * Lower rank number = higher priority in the suggested menu section.
- */
 export declare const TRANSFORM_SUGGESTED_ITEMS_RANK: SuggestedItemsRankMap;
-/**
- * Get suggested menu items for a given node type
- * @param nodeType - The source node type (e.g., 'paragraph', 'heading')
- * @returns Object mapping menu item keys to their ranks, or undefined if no suggestions
- */
 export declare const getSuggestedItemsForNodeType: (nodeType: string) => {
     [menuItemKey: string]: number;
 } | undefined;
-/**
- * Get sorted suggested menu item keys for a given node type
- * @param nodeType - The source node type
- * @returns Array of menu item keys sorted by rank (highest priority first)
- */
 export declare const getSortedSuggestedItems: (nodeType: string) => string[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "5.1.7",
+	"version": "5.1.8",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -44,12 +44,12 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/platform-feature-flags-react": "^0.4.0",
 		"@atlaskit/primitives": "^16.4.0",
-		"@atlaskit/tmp-editor-statsig": "^14.7.0",
+		"@atlaskit/tmp-editor-statsig": "^14.8.0",
 		"@atlaskit/tokens": "^8.4.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.39.0",
+		"@atlaskit/editor-common": "^110.40.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},