@atlaskit/editor-plugin-block-menu 0.0.12 → 0.0.14

package/dist/types-ts4.5/blockMenuPluginType.d.ts

@@ -1,13 +1,18 @@
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, OptionalPlugin, EditorCommand } from '@atlaskit/editor-common/types';
 import type { BlockControlsPlugin } from '@atlaskit/editor-plugin-block-controls';
 import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { FormatNodeTargetType } from './editor-commands/transforms/types';
 export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
     actions: {
         getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
         registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
     };
+    commands: {
+        formatNode: (currentNode: PMNode, targetType: FormatNodeTargetType) => EditorCommand;
+    };
     dependencies: [
         OptionalPlugin<BlockControlsPlugin>,
         OptionalPlugin<UserIntentPlugin>,
@@ -33,6 +38,19 @@ type WithRank<T> = T & {
 export type Parent<T> = WithRank<T>;
 type ComponentType = BlockMenuSection | BlockMenuItem | BlockMenuNested;
 export type ComponentTypes = Array<ComponentType>;
+/**
+ * The relationship between BlockMenuItem, BlockMenuSection, BlockMenuNested
+ * BlockMenuSection can have BlockMenuItem or BlockMenuNested as children
+ * BlockMenuNested can have BlockMenuSection as children,
+ * BlockMenuNested, with BlockMenuSection and BlockMenuItem, is a nested menu
+ *  _______________________________________
+ * | Block menu (no typing)
+ * |  |BlockMenuSection
+ * |  |  |BlockMenuItem
+ * |  |  |BlockMenuNested
+ * |  |  |  |BlockMenuSection
+ * |  |  |  |  |BlockMenuItem
+ */
 type BlockMenuItem = {
     key: string;
     type: 'block-menu-item';
@@ -45,10 +63,15 @@ type BlockMenuNested = {
     key: string;
     type: 'block-menu-nested';
 };
-export type BlockMenuNestedComponent = () => React.ReactNode;
+export type BlockMenuNestedComponent = (props?: {
+    children: React.ReactNode;
+}) => React.ReactNode;
 export type BlockMenuSectionComponent = (props: {
     children: React.ReactNode;
 }) => React.ReactNode;
+export type BlockMenuNestedSectionComponent = (props: {
+    children: React.ReactNode;
+}) => React.ReactNode;
 export type BlockMenuItemComponent = () => React.ReactNode;
 export type RegisterBlockMenuNested = BlockMenuNested & {
     component?: BlockMenuNestedComponent;
@@ -56,7 +79,8 @@ export type RegisterBlockMenuNested = BlockMenuNested & {
 };
 export type RegisterBlockMenuSection = BlockMenuSection & {
     component?: BlockMenuSectionComponent;
-    rank: number;
+    parent?: Parent<BlockMenuNested>;
+    rank?: number;
 };
 export type RegisterBlockMenuItem = BlockMenuItem & {
     component?: BlockMenuItemComponent;

package/dist/types-ts4.5/editor-commands/formatNode.d.ts

@@ -0,0 +1,9 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { FormatNodeTargetType } from './transforms/types';
+/**
+ * Formats the current node or selection to the specified target type
+ * @param currentNode - The current node
+ * @param targetType - The target node type to convert to
+ */
+export declare const formatNode: (currentNode: PMNode, targetType: FormatNodeTargetType) => EditorCommand;

package/dist/types-ts4.5/editor-commands/transforms/block-transforms.d.ts

@@ -0,0 +1,5 @@
+import type { TransformFunction } from './types';
+/**
+ * Transform block nodes (paragraph, heading, codeblock)
+ */
+export declare const transformBlockNode: TransformFunction;

package/dist/types-ts4.5/editor-commands/transforms/container-transforms.d.ts

@@ -0,0 +1,17 @@
+import type { TransformFunction } from './types';
+/**
+ * Transform selection to container type
+ */
+export declare const transformToContainer: () => null;
+/**
+ * Transform container nodes (panel, expand, blockquote)
+ */
+export declare const transformContainerNode: TransformFunction;
+/**
+ * Unwrap container node and convert content to block type
+ */
+export declare const unwrapAndConvertToBlockType: () => null;
+/**
+ * Unwrap container node and convert content to list
+ */
+export declare const unwrapAndConvertToList: () => null;

package/dist/types-ts4.5/editor-commands/transforms/list-transforms.d.ts

@@ -0,0 +1,17 @@
+import type { TransformFunction } from './types';
+/**
+ * Transform selection to list type
+ */
+export declare const transformToList: () => null;
+/**
+ * Transform list nodes
+ */
+export declare const transformListNode: TransformFunction;
+/**
+ * Lift list content and convert to block type
+ */
+export declare const liftListToBlockType: () => null;
+/**
+ * Transform between different list types
+ */
+export declare const transformBetweenListTypes: () => null;

package/dist/types-ts4.5/editor-commands/transforms/transformNodeToTargetType.d.ts

@@ -0,0 +1,4 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { FormatNodeTargetType } from './types';
+export declare function transformNodeToTargetType(tr: Transaction, sourceNode: PMNode, sourcePos: number | null, targetType: FormatNodeTargetType): Transaction | null;

package/dist/types-ts4.5/editor-commands/transforms/types.d.ts

@@ -0,0 +1,11 @@
+import type { Node as PMNode, NodeType } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export type FormatNodeTargetType = 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'paragraph' | 'blockquote' | 'expand' | 'panel' | 'codeblock' | 'bulletList' | 'orderedList' | 'taskList';
+export interface TransformContext {
+    tr: Transaction;
+    sourceNode: PMNode;
+    sourcePos: number | null;
+    targetNodeType: NodeType;
+    targetAttrs?: Record<string, unknown>;
+}
+export type TransformFunction = (context: TransformContext) => Transaction | null;

package/dist/types-ts4.5/editor-commands/transforms/utils.d.ts

@@ -0,0 +1,12 @@
+import type { Node as PMNode, NodeType } from '@atlaskit/editor-prosemirror/model';
+import type { FormatNodeTargetType } from './types';
+export declare const getTargetNodeInfo: (targetType: FormatNodeTargetType, nodes: Record<string, NodeType>) => {
+    nodeType: NodeType;
+    attrs?: Record<string, unknown>;
+} | null;
+export declare const isBlockNode: (node: PMNode) => boolean;
+export declare const isListNode: (node: PMNode) => boolean;
+export declare const isContainerNode: (node: PMNode) => boolean;
+export declare const isBlockNodeType: (nodeType: NodeType) => boolean;
+export declare const isListNodeType: (nodeType: NodeType) => boolean;
+export declare const isContainerNodeType: (nodeType: NodeType) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "0.0.12",
+	"version": "0.0.14",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,9 +27,6 @@
 	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
-	"af:exports": {
-		".": "./src/index.ts"
-	},
 	"dependencies": {
 		"@atlaskit/css": "^0.12.0",
 		"@atlaskit/dropdown-menu": "^16.3.0",
@@ -40,15 +37,16 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/editor-tables": "^2.9.0",
-		"@atlaskit/editor-toolbar": "^0.3.0",
-		"@atlaskit/icon": "^28.0.0",
-		"@atlaskit/icon-lab": "^5.6.0",
-		"@atlaskit/primitives": "^14.11.0",
-		"@atlaskit/tokens": "^6.0.0",
+		"@atlaskit/editor-toolbar": "^0.4.0",
+		"@atlaskit/icon": "^28.1.0",
+		"@atlaskit/icon-lab": "^5.7.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/primitives": "^14.12.0",
+		"@atlaskit/tokens": "^6.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.31.0",
+		"@atlaskit/editor-common": "^107.32.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
@@ -87,5 +85,10 @@
 				"import-no-extraneous-disable-for-examples-and-docs"
 			]
 		}
+	},
+	"platform-feature-flags": {
+		"platform_editor_block_menu_format": {
+			"type": "boolean"
+		}
 	}
 }