@atlaskit/editor-plugin-block-menu 5.0.24 → 5.1.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 5.1.1
+
+### Patch Changes
+
+- [`55bf82f6468ac`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/55bf82f6468ac) -
+  Update transformNode command to work with preservedSelection
+- Updated dependencies
+
+## 5.1.0
+
+### Minor Changes
+
+- [`bd911d5eca1cb`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bd911d5eca1cb) -
+  Use new transfromNode command in existing block menu items. Update transformNode analytics type.
+
 ## 5.0.24
 
 ### Patch Changes

package/dist/cjs/editor-commands/transform-node-utils/utils.js

@@ -16,10 +16,12 @@ var getSelectedNode = exports.getSelectedNode = function getSelectedNode(selecti
       // ?
       depth: selection.$from.depth
     };
-  } else if (selection instanceof _editorTables.CellSelection) {
+  }
+  if (selection instanceof _editorTables.CellSelection) {
     var tableSelected = (0, _utils.findParentNodeOfType)(selection.$from.doc.type.schema.nodes.table)(selection);
     return tableSelected;
-  } else if (selection instanceof _state.TextSelection) {
+  }
+  if (selection instanceof _state.TextSelection) {
     var _selection$$from$doc$ = selection.$from.doc.type.schema.nodes,
       blockquote = _selection$$from$doc$.blockquote,
       bulletList = _selection$$from$doc$.bulletList,

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

@@ -4,27 +4,48 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.transformNode = void 0;
-var _utils = require("../editor-commands/transform-node-utils/utils");
+var _model = require("@atlaskit/editor-prosemirror/model");
 var _transform = require("./transform-node-utils/transform");
 var transformNode = exports.transformNode = function transformNode(api) {
-  return function (targetType, analyticsAttrs) {
-    return function (_ref) {
-      var tr = _ref.tr;
-      var selection = tr.selection;
-      var source = (0, _utils.getSelectedNode)(selection);
-      if (!source) {
+  return (
+    // eslint-disable-next-line no-unused-vars
+    function (targetType, analyticsAttrs) {
+      return function (_ref) {
+        var _api$blockControls;
+        var tr = _ref.tr;
+        var preservedSelection = api === null || api === void 0 || (_api$blockControls = api.blockControls) === null || _api$blockControls === void 0 || (_api$blockControls = _api$blockControls.sharedState.currentState()) === null || _api$blockControls === void 0 ? void 0 : _api$blockControls.preservedSelection;
+        if (!preservedSelection) {
+          return tr;
+        }
+        var from = preservedSelection.from,
+          to = preservedSelection.to,
+          $from = preservedSelection.$from;
+        var selectedParent = $from.parent;
+        var fragment = _model.Fragment.empty;
+        // top level selections can safely be transformed without checking for depth
+        var isWithinSelectedRange = $from.depth === 0;
+        tr.doc.nodesBetween(from, to, function (node) {
+          // need to only transform selected content, for nested selections nodesBetween includes the path to the selected parent
+          if (!isWithinSelectedRange && node.eq(selectedParent)) {
+            isWithinSelectedRange = true;
+            return true;
+          }
+          if (isWithinSelectedRange) {
+            var outputNode = (0, _transform.getOutputNodes)({
+              sourceNode: node,
+              targetNodeType: targetType,
+              schema: tr.doc.type.schema
+            });
+            if (outputNode) {
+              fragment = fragment.append(_model.Fragment.fromArray(outputNode));
+            }
+            return false;
+          }
+          return true;
+        });
+        tr.replaceWith(preservedSelection.from, preservedSelection.to, fragment);
         return tr;
-      }
-      var outputNodes = (0, _transform.getOutputNodes)({
-        sourceNode: source.node,
-        targetNodeType: targetType,
-        schema: selection.$from.doc.type.schema
-      });
-      if (!outputNodes) {
-        return tr;
-      }
-      tr.replaceWith(source.pos, source.pos + source.node.nodeSize, outputNodes);
-      return tr;
-    };
-  };
+      };
+    }
+  );
 };

package/dist/es2019/editor-commands/transform-node-utils/utils.js

@@ -10,10 +10,12 @@ export const getSelectedNode = selection => {
       // ?
       depth: selection.$from.depth
     };
-  } else if (selection instanceof CellSelection) {
+  }
+  if (selection instanceof CellSelection) {
     const tableSelected = findParentNodeOfType(selection.$from.doc.type.schema.nodes.table)(selection);
     return tableSelected;
-  } else if (selection instanceof TextSelection) {
+  }
+  if (selection instanceof TextSelection) {
     const {
       blockquote,
       bulletList,

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

@@ -1,25 +1,45 @@
-import { getSelectedNode } from '../editor-commands/transform-node-utils/utils';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { getOutputNodes } from './transform-node-utils/transform';
-export const transformNode = api => (targetType, analyticsAttrs) => {
+export const transformNode = api =>
+// eslint-disable-next-line no-unused-vars
+(targetType, analyticsAttrs) => {
   return ({
     tr
   }) => {
-    const {
-      selection
-    } = tr;
-    const source = getSelectedNode(selection);
-    if (!source) {
+    var _api$blockControls, _api$blockControls$sh;
+    const preservedSelection = api === null || api === void 0 ? void 0 : (_api$blockControls = api.blockControls) === null || _api$blockControls === void 0 ? void 0 : (_api$blockControls$sh = _api$blockControls.sharedState.currentState()) === null || _api$blockControls$sh === void 0 ? void 0 : _api$blockControls$sh.preservedSelection;
+    if (!preservedSelection) {
       return tr;
     }
-    const outputNodes = getOutputNodes({
-      sourceNode: source.node,
-      targetNodeType: targetType,
-      schema: selection.$from.doc.type.schema
+    const {
+      from,
+      to,
+      $from
+    } = preservedSelection;
+    const selectedParent = $from.parent;
+    let fragment = Fragment.empty;
+    // top level selections can safely be transformed without checking for depth
+    let isWithinSelectedRange = $from.depth === 0;
+    tr.doc.nodesBetween(from, to, node => {
+      // need to only transform selected content, for nested selections nodesBetween includes the path to the selected parent
+      if (!isWithinSelectedRange && node.eq(selectedParent)) {
+        isWithinSelectedRange = true;
+        return true;
+      }
+      if (isWithinSelectedRange) {
+        const outputNode = getOutputNodes({
+          sourceNode: node,
+          targetNodeType: targetType,
+          schema: tr.doc.type.schema
+        });
+        if (outputNode) {
+          fragment = fragment.append(Fragment.fromArray(outputNode));
+        }
+        return false;
+      }
+      return true;
     });
-    if (!outputNodes) {
-      return tr;
-    }
-    tr.replaceWith(source.pos, source.pos + source.node.nodeSize, outputNodes);
+    tr.replaceWith(preservedSelection.from, preservedSelection.to, fragment);
     return tr;
   };
 };

package/dist/esm/editor-commands/transform-node-utils/utils.js

@@ -10,10 +10,12 @@ export var getSelectedNode = function getSelectedNode(selection) {
       // ?
       depth: selection.$from.depth
     };
-  } else if (selection instanceof CellSelection) {
+  }
+  if (selection instanceof CellSelection) {
     var tableSelected = findParentNodeOfType(selection.$from.doc.type.schema.nodes.table)(selection);
     return tableSelected;
-  } else if (selection instanceof TextSelection) {
+  }
+  if (selection instanceof TextSelection) {
     var _selection$$from$doc$ = selection.$from.doc.type.schema.nodes,
       blockquote = _selection$$from$doc$.blockquote,
       bulletList = _selection$$from$doc$.bulletList,

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

@@ -1,24 +1,45 @@
-import { getSelectedNode } from '../editor-commands/transform-node-utils/utils';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { getOutputNodes } from './transform-node-utils/transform';
 export var transformNode = function transformNode(api) {
-  return function (targetType, analyticsAttrs) {
-    return function (_ref) {
-      var tr = _ref.tr;
-      var selection = tr.selection;
-      var source = getSelectedNode(selection);
-      if (!source) {
+  return (
+    // eslint-disable-next-line no-unused-vars
+    function (targetType, analyticsAttrs) {
+      return function (_ref) {
+        var _api$blockControls;
+        var tr = _ref.tr;
+        var preservedSelection = api === null || api === void 0 || (_api$blockControls = api.blockControls) === null || _api$blockControls === void 0 || (_api$blockControls = _api$blockControls.sharedState.currentState()) === null || _api$blockControls === void 0 ? void 0 : _api$blockControls.preservedSelection;
+        if (!preservedSelection) {
+          return tr;
+        }
+        var from = preservedSelection.from,
+          to = preservedSelection.to,
+          $from = preservedSelection.$from;
+        var selectedParent = $from.parent;
+        var fragment = Fragment.empty;
+        // top level selections can safely be transformed without checking for depth
+        var isWithinSelectedRange = $from.depth === 0;
+        tr.doc.nodesBetween(from, to, function (node) {
+          // need to only transform selected content, for nested selections nodesBetween includes the path to the selected parent
+          if (!isWithinSelectedRange && node.eq(selectedParent)) {
+            isWithinSelectedRange = true;
+            return true;
+          }
+          if (isWithinSelectedRange) {
+            var outputNode = getOutputNodes({
+              sourceNode: node,
+              targetNodeType: targetType,
+              schema: tr.doc.type.schema
+            });
+            if (outputNode) {
+              fragment = fragment.append(Fragment.fromArray(outputNode));
+            }
+            return false;
+          }
+          return true;
+        });
+        tr.replaceWith(preservedSelection.from, preservedSelection.to, fragment);
         return tr;
-      }
-      var outputNodes = getOutputNodes({
-        sourceNode: source.node,
-        targetNodeType: targetType,
-        schema: selection.$from.doc.type.schema
-      });
-      if (!outputNodes) {
-        return tr;
-      }
-      tr.replaceWith(source.pos, source.pos + source.node.nodeSize, outputNodes);
-      return tr;
-    };
-  };
+      };
+    }
+  );
 };

package/dist/types/blockMenuPluginType.d.ts

@@ -5,12 +5,12 @@ 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 { NodeType } from '@atlaskit/editor-prosemirror/model';
-import type { FormatNodeTargetType, FormatNodeAnalyticsAttrs } from './editor-commands/transforms/types';
+import type { FormatNodeAnalyticsAttrs, FormatNodeTargetType, TransformNodeAnalyticsAttrs } from './editor-commands/transforms/types';
 export declare enum FLAG_ID {
     LINK_COPIED_TO_CLIPBOARD = "link-copied-to-clipboard"
 }
 type FormatNodeCommand = (targetType: FormatNodeTargetType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;
-type TransformNodeCommand = (targetType: NodeType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;
+type TransformNodeCommand = (targetType: NodeType, analyticsAttrs?: TransformNodeAnalyticsAttrs) => EditorCommand;
 export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
     actions: {
         getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;

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

@@ -1,5 +1,5 @@
 import type { EditorCommand, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { NodeType } from '@atlaskit/editor-prosemirror/model';
+import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { BlockMenuPlugin } from '../blockMenuPluginType';
-import type { FormatNodeAnalyticsAttrs } from './transforms/types';
-export declare const transformNode: (api?: ExtractInjectionAPI<BlockMenuPlugin>) => (targetType: NodeType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;
+import type { TransformNodeAnalyticsAttrs } from './transforms/types';
+export declare const transformNode: (api?: ExtractInjectionAPI<BlockMenuPlugin>) => (targetType: NodeType, analyticsAttrs?: TransformNodeAnalyticsAttrs) => EditorCommand;

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

@@ -2,8 +2,12 @@ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { TransformContext } from '@atlaskit/editor-common/transforms';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export type FormatNodeTargetType = 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'paragraph' | 'blockquote' | 'expand' | 'layoutSection' | 'panel' | 'codeBlock' | 'bulletList' | 'orderedList' | 'taskList';
+export type TransfromNodeTargetType = FormatNodeTargetType;
 export type FormatNodeAnalyticsAttrs = {
     inputMethod: INPUT_METHOD.BLOCK_MENU;
     triggeredFrom: INPUT_METHOD.MOUSE | INPUT_METHOD.KEYBOARD;
 };
+export type TransformNodeAnalyticsAttrs = FormatNodeAnalyticsAttrs & {
+    targetTypeName: TransfromNodeTargetType;
+};
 export type TransformFunction = (context: TransformContext) => Transaction | null;

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

@@ -5,12 +5,12 @@ 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 { NodeType } from '@atlaskit/editor-prosemirror/model';
-import type { FormatNodeTargetType, FormatNodeAnalyticsAttrs } from './editor-commands/transforms/types';
+import type { FormatNodeAnalyticsAttrs, FormatNodeTargetType, TransformNodeAnalyticsAttrs } from './editor-commands/transforms/types';
 export declare enum FLAG_ID {
     LINK_COPIED_TO_CLIPBOARD = "link-copied-to-clipboard"
 }
 type FormatNodeCommand = (targetType: FormatNodeTargetType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;
-type TransformNodeCommand = (targetType: NodeType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;
+type TransformNodeCommand = (targetType: NodeType, analyticsAttrs?: TransformNodeAnalyticsAttrs) => EditorCommand;
 export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
     actions: {
         getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;

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

@@ -1,5 +1,5 @@
 import type { EditorCommand, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { NodeType } from '@atlaskit/editor-prosemirror/model';
+import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { BlockMenuPlugin } from '../blockMenuPluginType';
-import type { FormatNodeAnalyticsAttrs } from './transforms/types';
-export declare const transformNode: (api?: ExtractInjectionAPI<BlockMenuPlugin>) => (targetType: NodeType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;
+import type { TransformNodeAnalyticsAttrs } from './transforms/types';
+export declare const transformNode: (api?: ExtractInjectionAPI<BlockMenuPlugin>) => (targetType: NodeType, analyticsAttrs?: TransformNodeAnalyticsAttrs) => EditorCommand;

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

@@ -2,8 +2,12 @@ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { TransformContext } from '@atlaskit/editor-common/transforms';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export type FormatNodeTargetType = 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'paragraph' | 'blockquote' | 'expand' | 'layoutSection' | 'panel' | 'codeBlock' | 'bulletList' | 'orderedList' | 'taskList';
+export type TransfromNodeTargetType = FormatNodeTargetType;
 export type FormatNodeAnalyticsAttrs = {
     inputMethod: INPUT_METHOD.BLOCK_MENU;
     triggeredFrom: INPUT_METHOD.MOUSE | INPUT_METHOD.KEYBOARD;
 };
+export type TransformNodeAnalyticsAttrs = FormatNodeAnalyticsAttrs & {
+    targetTypeName: TransfromNodeTargetType;
+};
 export type TransformFunction = (context: TransformContext) => Transaction | null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "5.0.24",
+	"version": "5.1.1",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -31,7 +31,7 @@
 		"@atlaskit/css": "^0.17.0",
 		"@atlaskit/dropdown-menu": "^16.3.0",
 		"@atlaskit/editor-plugin-analytics": "^6.2.0",
-		"@atlaskit/editor-plugin-block-controls": "^7.10.0",
+		"@atlaskit/editor-plugin-block-controls": "^7.11.0",
 		"@atlaskit/editor-plugin-decorations": "^6.1.0",
 		"@atlaskit/editor-plugin-selection": "^6.1.0",
 		"@atlaskit/editor-plugin-user-intent": "^4.0.0",
@@ -44,7 +44,7 @@
 		"@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.1.0",
+		"@atlaskit/tmp-editor-statsig": "^14.3.0",
 		"@atlaskit/tokens": "^8.4.0",
 		"@babel/runtime": "^7.0.0"
 	},