@atlaskit/editor-plugin-block-menu 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 4.0.3
+
+### Patch Changes
+
+- [`c158b1ba4f0fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c158b1ba4f0fd) -
+  ED-29388: fix converting empty list
+- Updated dependencies
+
 ## 4.0.2
 
 ### Patch Changes

package/afm-dev-agents/tsconfig.json

@@ -23,6 +23,9 @@
 		{
 			"path": "../../../design-system/dropdown-menu/afm-dev-agents/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-analytics/afm-dev-agents/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-block-controls/afm-dev-agents/tsconfig.json"
 		},

package/afm-jira/tsconfig.json

@@ -23,6 +23,9 @@
 		{
 			"path": "../../../design-system/dropdown-menu/afm-jira/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-analytics/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-block-controls/afm-jira/tsconfig.json"
 		},

package/afm-passionfruit/tsconfig.json

@@ -23,6 +23,9 @@
 		{
 			"path": "../../../design-system/dropdown-menu/afm-passionfruit/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-analytics/afm-passionfruit/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-block-controls/afm-passionfruit/tsconfig.json"
 		},

package/afm-post-office/tsconfig.json

@@ -23,6 +23,9 @@
 		{
 			"path": "../../../design-system/dropdown-menu/afm-post-office/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-analytics/afm-post-office/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-block-controls/afm-post-office/tsconfig.json"
 		},

package/afm-rovo-extension/tsconfig.json

@@ -23,6 +23,9 @@
 		{
 			"path": "../../../design-system/dropdown-menu/afm-rovo-extension/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-analytics/afm-rovo-extension/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-block-controls/afm-rovo-extension/tsconfig.json"
 		},

package/afm-townsquare/tsconfig.json

@@ -23,6 +23,9 @@
 		{
 			"path": "../../../design-system/dropdown-menu/afm-townsquare/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-analytics/afm-townsquare/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-block-controls/afm-townsquare/tsconfig.json"
 		},

package/dist/cjs/editor-commands/formatNode.js

@@ -3,14 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.formatNode = void 0;
+exports.formatNodeSelectEmptyList = exports.formatNode = void 0;
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _state = require("@atlaskit/editor-prosemirror/state");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEqualsNoExposure = require("@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure");
 var _selection = require("./selection");
 var _layoutTransforms = require("./transforms/layout-transforms");
 var _transformNodeToTargetType = require("./transforms/transformNodeToTargetType");
+var _utils2 = require("./transforms/utils");
 /**
  * Handles formatting when selection is empty by inserting a new target node
  */
@@ -50,6 +52,42 @@ var formatNodeWhenSelectionEmpty = function formatNodeWhenSelectionEmpty(tr, tar
   return tr;
 };
 
+/**
+ * Handles formatting when an empty list is selected
+ * Converting an empty list to a target node, will remove the list and replace with an empty target node
+ */
+var formatNodeSelectEmptyList = exports.formatNodeSelectEmptyList = function formatNodeSelectEmptyList(tr, targetType, listNode, schema) {
+  var nodes = schema.nodes;
+  var headingLevel = 1;
+  var finalTargetType = targetType;
+  if (targetType.startsWith('heading')) {
+    var levelString = targetType.slice(-1);
+    var level = parseInt(levelString, 10);
+    if (!isNaN(level) && level >= 1 && level <= 6) {
+      headingLevel = level;
+      finalTargetType = 'heading';
+    }
+  }
+  var replaceNode = null;
+  if (finalTargetType === 'layoutSection') {
+    var emptyPara = nodes.paragraph.createAndFill();
+    if (emptyPara) {
+      replaceNode = (0, _layoutTransforms.createDefaultLayoutSection)(schema, emptyPara);
+    }
+  } else if (finalTargetType === 'heading') {
+    replaceNode = nodes.heading.createAndFill({
+      level: headingLevel
+    });
+  } else {
+    replaceNode = nodes[finalTargetType].createAndFill();
+  }
+  if (replaceNode) {
+    tr.replaceWith(listNode.pos, listNode.pos + listNode.node.nodeSize, replaceNode);
+    tr.setSelection(new _state.TextSelection(tr.doc.resolve(listNode.pos)));
+  }
+  return tr;
+};
+
 /**
  * Formats the current node or selection to the specified target type
  * @param api - The editor API injection that provides access to analytics and other plugin actions
@@ -69,7 +107,26 @@ var formatNode = exports.formatNode = function formatNode(api) {
 
       // when selection is empty, we insert a empty target node
       if (selection.empty && (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu_empty_line', 'isEnabled', true)) {
-        return formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
+        var listNodes = [];
+        // need to find if there is any list node in the current selection
+        // As when select a empty list, selection is empty, but we want to convert the list instead of inserting a target node
+        // findSelectedNodeOfType does not work when selection is empty, so we use nodesBetween
+        tr.doc.nodesBetween(selection.from, selection.to, function (node, pos) {
+          if ((0, _utils2.isListNodeType)(node.type)) {
+            listNodes.push({
+              node: node,
+              pos: pos
+            });
+          }
+        });
+        //	get the first list node as when click on drag handle if there are list node
+        //  can only select one list at a time, so we just need to find the first one
+        if (listNodes.length > 0 && (0, _platformFeatureFlags.fg)('platform_editor_block_menu_patch_2')) {
+          var firstChild = listNodes[0];
+          return formatNodeSelectEmptyList(tr, targetType, firstChild, schema);
+        } else {
+          return formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
+        }
       }
 
       // Try to find the current node from selection

package/dist/es2019/editor-commands/formatNode.js

@@ -1,10 +1,13 @@
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { findParentNodeOfType, findSelectedNodeOfType, safeInsert as pmSafeInsert } from '@atlaskit/editor-prosemirror/utils';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
 import { setSelectionAfterTransform } from './selection';
 import { createDefaultLayoutSection } from './transforms/layout-transforms';
 import { transformNodeToTargetType } from './transforms/transformNodeToTargetType';
+import { isListNodeType } from './transforms/utils';
+
 /**
  * Handles formatting when selection is empty by inserting a new target node
  */
@@ -48,6 +51,44 @@ const formatNodeWhenSelectionEmpty = (tr, targetType, nodePos, schema) => {
   return tr;
 };
 
+/**
+ * Handles formatting when an empty list is selected
+ * Converting an empty list to a target node, will remove the list and replace with an empty target node
+ */
+export const formatNodeSelectEmptyList = (tr, targetType, listNode, schema) => {
+  const {
+    nodes
+  } = schema;
+  let headingLevel = 1;
+  let finalTargetType = targetType;
+  if (targetType.startsWith('heading')) {
+    const levelString = targetType.slice(-1);
+    const level = parseInt(levelString, 10);
+    if (!isNaN(level) && level >= 1 && level <= 6) {
+      headingLevel = level;
+      finalTargetType = 'heading';
+    }
+  }
+  let replaceNode = null;
+  if (finalTargetType === 'layoutSection') {
+    const emptyPara = nodes.paragraph.createAndFill();
+    if (emptyPara) {
+      replaceNode = createDefaultLayoutSection(schema, emptyPara);
+    }
+  } else if (finalTargetType === 'heading') {
+    replaceNode = nodes.heading.createAndFill({
+      level: headingLevel
+    });
+  } else {
+    replaceNode = nodes[finalTargetType].createAndFill();
+  }
+  if (replaceNode) {
+    tr.replaceWith(listNode.pos, listNode.pos + listNode.node.nodeSize, replaceNode);
+    tr.setSelection(new TextSelection(tr.doc.resolve(listNode.pos)));
+  }
+  return tr;
+};
+
 /**
  * Formats the current node or selection to the specified target type
  * @param api - The editor API injection that provides access to analytics and other plugin actions
@@ -71,7 +112,26 @@ export const formatNode = api => targetType => {
 
     // when selection is empty, we insert a empty target node
     if (selection.empty && expValEqualsNoExposure('platform_editor_block_menu_empty_line', 'isEnabled', true)) {
-      return formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
+      const listNodes = [];
+      // need to find if there is any list node in the current selection
+      // As when select a empty list, selection is empty, but we want to convert the list instead of inserting a target node
+      // findSelectedNodeOfType does not work when selection is empty, so we use nodesBetween
+      tr.doc.nodesBetween(selection.from, selection.to, (node, pos) => {
+        if (isListNodeType(node.type)) {
+          listNodes.push({
+            node,
+            pos
+          });
+        }
+      });
+      //	get the first list node as when click on drag handle if there are list node
+      //  can only select one list at a time, so we just need to find the first one
+      if (listNodes.length > 0 && fg('platform_editor_block_menu_patch_2')) {
+        const firstChild = listNodes[0];
+        return formatNodeSelectEmptyList(tr, targetType, firstChild, schema);
+      } else {
+        return formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
+      }
     }
 
     // Try to find the current node from selection

package/dist/esm/editor-commands/formatNode.js

@@ -1,10 +1,13 @@
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { findParentNodeOfType, findSelectedNodeOfType, safeInsert as pmSafeInsert } from '@atlaskit/editor-prosemirror/utils';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
 import { setSelectionAfterTransform } from './selection';
 import { createDefaultLayoutSection } from './transforms/layout-transforms';
 import { transformNodeToTargetType } from './transforms/transformNodeToTargetType';
+import { isListNodeType } from './transforms/utils';
+
 /**
  * Handles formatting when selection is empty by inserting a new target node
  */
@@ -44,6 +47,42 @@ var formatNodeWhenSelectionEmpty = function formatNodeWhenSelectionEmpty(tr, tar
   return tr;
 };
 
+/**
+ * Handles formatting when an empty list is selected
+ * Converting an empty list to a target node, will remove the list and replace with an empty target node
+ */
+export var formatNodeSelectEmptyList = function formatNodeSelectEmptyList(tr, targetType, listNode, schema) {
+  var nodes = schema.nodes;
+  var headingLevel = 1;
+  var finalTargetType = targetType;
+  if (targetType.startsWith('heading')) {
+    var levelString = targetType.slice(-1);
+    var level = parseInt(levelString, 10);
+    if (!isNaN(level) && level >= 1 && level <= 6) {
+      headingLevel = level;
+      finalTargetType = 'heading';
+    }
+  }
+  var replaceNode = null;
+  if (finalTargetType === 'layoutSection') {
+    var emptyPara = nodes.paragraph.createAndFill();
+    if (emptyPara) {
+      replaceNode = createDefaultLayoutSection(schema, emptyPara);
+    }
+  } else if (finalTargetType === 'heading') {
+    replaceNode = nodes.heading.createAndFill({
+      level: headingLevel
+    });
+  } else {
+    replaceNode = nodes[finalTargetType].createAndFill();
+  }
+  if (replaceNode) {
+    tr.replaceWith(listNode.pos, listNode.pos + listNode.node.nodeSize, replaceNode);
+    tr.setSelection(new TextSelection(tr.doc.resolve(listNode.pos)));
+  }
+  return tr;
+};
+
 /**
  * Formats the current node or selection to the specified target type
  * @param api - The editor API injection that provides access to analytics and other plugin actions
@@ -63,7 +102,26 @@ export var formatNode = function formatNode(api) {
 
       // when selection is empty, we insert a empty target node
       if (selection.empty && expValEqualsNoExposure('platform_editor_block_menu_empty_line', 'isEnabled', true)) {
-        return formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
+        var listNodes = [];
+        // need to find if there is any list node in the current selection
+        // As when select a empty list, selection is empty, but we want to convert the list instead of inserting a target node
+        // findSelectedNodeOfType does not work when selection is empty, so we use nodesBetween
+        tr.doc.nodesBetween(selection.from, selection.to, function (node, pos) {
+          if (isListNodeType(node.type)) {
+            listNodes.push({
+              node: node,
+              pos: pos
+            });
+          }
+        });
+        //	get the first list node as when click on drag handle if there are list node
+        //  can only select one list at a time, so we just need to find the first one
+        if (listNodes.length > 0 && fg('platform_editor_block_menu_patch_2')) {
+          var firstChild = listNodes[0];
+          return formatNodeSelectEmptyList(tr, targetType, firstChild, schema);
+        } else {
+          return formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
+        }
       }
 
       // Try to find the current node from selection

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

@@ -1,6 +1,16 @@
 import type { EditorCommand, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type Schema, type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { type Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { BlockMenuPlugin } from '../blockMenuPluginType';
 import type { FormatNodeTargetType } from './transforms/types';
+/**
+ * Handles formatting when an empty list is selected
+ * Converting an empty list to a target node, will remove the list and replace with an empty target node
+ */
+export declare const formatNodeSelectEmptyList: (tr: Transaction, targetType: FormatNodeTargetType, listNode: {
+    node: PMNode;
+    pos: number;
+}, schema: Schema) => Transaction;
 /**
  * Formats the current node or selection to the specified target type
  * @param api - The editor API injection that provides access to analytics and other plugin actions

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

@@ -1,6 +1,16 @@
 import type { EditorCommand, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type Schema, type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { type Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { BlockMenuPlugin } from '../blockMenuPluginType';
 import type { FormatNodeTargetType } from './transforms/types';
+/**
+ * Handles formatting when an empty list is selected
+ * Converting an empty list to a target node, will remove the list and replace with an empty target node
+ */
+export declare const formatNodeSelectEmptyList: (tr: Transaction, targetType: FormatNodeTargetType, listNode: {
+    node: PMNode;
+    pos: number;
+}, schema: Schema) => Transaction;
 /**
  * Formats the current node or selection to the specified target type
  * @param api - The editor API injection that provides access to analytics and other plugin actions

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "4.0.2",
+	"version": "4.0.3",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,7 +30,7 @@
 	"dependencies": {
 		"@atlaskit/css": "^0.14.0",
 		"@atlaskit/dropdown-menu": "^16.3.0",
-		"@atlaskit/editor-plugin-analytics": "^6.0.0",
+		"@atlaskit/editor-plugin-analytics": "^6.1.0",
 		"@atlaskit/editor-plugin-block-controls": "^7.1.0",
 		"@atlaskit/editor-plugin-decorations": "^6.1.0",
 		"@atlaskit/editor-plugin-selection": "^6.0.0",
@@ -40,7 +40,7 @@
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/editor-toolbar": "^0.10.0",
 		"@atlaskit/icon": "^28.3.0",
-		"@atlaskit/icon-lab": "^5.7.0",
+		"@atlaskit/icon-lab": "^5.8.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^14.15.0",
 		"@atlaskit/tmp-editor-statsig": "^12.32.0",
@@ -48,7 +48,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.2.0",
+		"@atlaskit/editor-common": "^110.3.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},