@atlaskit/editor-plugin-block-menu 6.0.33 → 6.0.34

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

@@ -1,263 +0,0 @@
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { logException } from '@atlaskit/editor-common/monitoring';
-import { TextSelection } from '@atlaskit/editor-prosemirror/state';
-import { findParentNodeOfType, findSelectedNodeOfType, safeInsert as pmSafeInsert } from '@atlaskit/editor-prosemirror/utils';
-import { setSelectionAfterTransform } from './selection';
-import { createDefaultLayoutSection } from './transforms/layout-transforms';
-import { transformNodeToTargetType } from './transforms/transformNodeToTargetType';
-import { isListNodeType, getConversionType } from './transforms/utils';
-
-/**
- * Handles formatting when selection is empty by inserting a new target node
- */
-var formatNodeWhenSelectionEmpty = function formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema) {
-  var _pmSafeInsert;
-  var nodes = schema.nodes;
-  var paragraph = nodes.paragraph;
-  // if not using the ' ' here, the safeInsert from editor-common will fail to insert the heading
-  // and the pmSafeInsert introduce an issue that after inserting heading, and click on the handle, selection will go to top of the doc
-  // as an workaround, use the spaceTextNode here
-  var spaceTextNode = schema.text(' ');
-  var targetNode;
-  if (targetType.startsWith('heading')) {
-    var levelString = targetType.slice(-1);
-    var level = parseInt(levelString, 10);
-    if (isNaN(level) || level < 1 || level > 6) {
-      return null;
-    }
-    targetNode = nodes.heading.createAndFill({
-      level: level
-    }, spaceTextNode);
-  } else if (targetType === 'paragraph') {
-    targetNode = nodes.paragraph.createAndFill({}, spaceTextNode);
-  } else if (targetType === 'layoutSection') {
-    var contentAsParagraph = paragraph.createAndFill({}, spaceTextNode);
-    if (contentAsParagraph) {
-      targetNode = createDefaultLayoutSection(schema, contentAsParagraph);
-    }
-  } else {
-    var targetNodeType = nodes[targetType];
-    targetNode = targetNodeType.createAndFill();
-  }
-  if (!targetNode) {
-    return tr;
-  }
-  tr = (_pmSafeInsert = pmSafeInsert(targetNode, nodePos)(tr)) !== null && _pmSafeInsert !== void 0 ? _pmSafeInsert : tr;
-  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
- * @param targetType - The target node type to convert to
- * @param analyticsAttrs - Attributes required for formatNode analytics like: inputMethod and triggeredFrom
- */
-export var formatNode = function formatNode(api) {
-  return function (targetType, analyticsAttrs) {
-    return function (_ref) {
-      var tr = _ref.tr;
-      var selection = tr.selection;
-      var schema = tr.doc.type.schema;
-      var nodes = schema.nodes;
-
-      // Find the node to format from the current selection
-      var nodeToFormat;
-      var nodePos = selection.from;
-
-      // when selection is empty, we insert a empty target node
-      if (selection.empty) {
-        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) {
-          var firstChild = listNodes[0];
-          var newTr = formatNodeSelectEmptyList(tr, targetType, firstChild, schema);
-          if (newTr) {
-            var _api$analytics;
-            var sourceTypeName = firstChild.node.type.name;
-            api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || _api$analytics.attachAnalyticsEvent({
-              action: ACTION.CONVERTED,
-              actionSubject: ACTION_SUBJECT.ELEMENT,
-              eventType: EVENT_TYPE.TRACK,
-              attributes: {
-                from: sourceTypeName,
-                to: targetType,
-                eventCategory: getConversionType(sourceTypeName, targetType),
-                triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.MOUSE,
-                inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.BLOCK_MENU,
-                conversionSource: 'emptyList'
-              }
-            })(newTr);
-          }
-          return newTr;
-        } else {
-          var _newTr = formatNodeWhenSelectionEmpty(tr, targetType, nodePos, schema);
-          var allowedNodes = [nodes.blockquote, nodes.panel, nodes.codeBlock, nodes.layoutSection, nodes.expand];
-          var _sourceTypeName = 'paragraph';
-          var conversionSource;
-          var containerNode = findParentNodeOfType(allowedNodes)(selection);
-          var paragraphOrHeading = findParentNodeOfType([nodes.heading, nodes.paragraph])(selection);
-          if (containerNode) {
-            // At the moment this branch is executed for converstions from an empty blockquote
-            _sourceTypeName = containerNode.node.type.name;
-            conversionSource = undefined; // could be 'emptyNode' or something else
-          } else if (paragraphOrHeading) {
-            _sourceTypeName = paragraphOrHeading.node.type.name;
-            if (_sourceTypeName === 'heading') {
-              _sourceTypeName = "heading".concat(paragraphOrHeading.node.attrs.level);
-            }
-            conversionSource = 'emptyLine';
-          }
-          if (_newTr) {
-            var _api$analytics2;
-            api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || (_api$analytics2 = _api$analytics2.actions) === null || _api$analytics2 === void 0 || _api$analytics2.attachAnalyticsEvent({
-              action: ACTION.CONVERTED,
-              actionSubject: ACTION_SUBJECT.ELEMENT,
-              eventType: EVENT_TYPE.TRACK,
-              attributes: {
-                from: _sourceTypeName,
-                to: targetType,
-                eventCategory: getConversionType(_sourceTypeName, targetType),
-                triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.MOUSE,
-                inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.BLOCK_MENU,
-                conversionSource: conversionSource
-              }
-            })(_newTr);
-          }
-          return _newTr;
-        }
-      }
-
-      // Try to find the current node from selection
-      var selectedNode = findSelectedNodeOfType([nodes.paragraph, nodes.heading, nodes.blockquote, nodes.panel, nodes.expand, nodes.codeBlock, nodes.bulletList, nodes.orderedList, nodes.taskList, nodes.layoutSection])(selection);
-      if (selectedNode) {
-        nodeToFormat = selectedNode.node;
-        nodePos = selectedNode.pos;
-      } else {
-        // Try to find parent node (including list parents)
-        var parentNode = findParentNodeOfType([nodes.blockquote, nodes.panel, nodes.expand, nodes.codeBlock, nodes.listItem, nodes.taskItem, nodes.layoutSection])(selection);
-        if (parentNode) {
-          nodeToFormat = parentNode.node;
-          nodePos = parentNode.pos;
-          var paragraphOrHeadingNode = findParentNodeOfType([nodes.paragraph, nodes.heading])(selection);
-          // Special case: if we found a listItem, check if we need the parent list instead
-          if (parentNode.node.type === nodes.listItem || parentNode.node.type === nodes.taskItem) {
-            var listParent = findParentNodeOfType([nodes.bulletList, nodes.orderedList, nodes.taskList])(selection);
-            if (listParent) {
-              // For list transformations, we want the list parent, not the listItem
-              nodeToFormat = listParent.node;
-              nodePos = listParent.pos;
-            }
-          } else if (parentNode.node.type !== nodes.blockquote && paragraphOrHeadingNode) {
-            nodeToFormat = paragraphOrHeadingNode.node;
-            nodePos = paragraphOrHeadingNode.pos;
-          }
-        }
-      }
-      if (!nodeToFormat) {
-        nodeToFormat = selection.$from.node();
-        nodePos = selection.$from.pos;
-      }
-      try {
-        var _nodeToFormat$attrs;
-        var _newTr2 = transformNodeToTargetType(tr, nodeToFormat, nodePos, targetType);
-        var _sourceTypeName2 = nodeToFormat.type.name;
-        if (_sourceTypeName2 === 'heading' && (_nodeToFormat$attrs = nodeToFormat.attrs) !== null && _nodeToFormat$attrs !== void 0 && _nodeToFormat$attrs.level) {
-          _sourceTypeName2 = "heading".concat(nodeToFormat.attrs.level);
-        }
-        if (_newTr2 && _sourceTypeName2 !== targetType) {
-          var _api$analytics3;
-          api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 || (_api$analytics3 = _api$analytics3.actions) === null || _api$analytics3 === void 0 || _api$analytics3.attachAnalyticsEvent({
-            action: ACTION.CONVERTED,
-            actionSubject: ACTION_SUBJECT.ELEMENT,
-            eventType: EVENT_TYPE.TRACK,
-            attributes: {
-              from: _sourceTypeName2,
-              to: targetType,
-              eventCategory: getConversionType(_sourceTypeName2, targetType),
-              triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.MOUSE,
-              inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.BLOCK_MENU
-            }
-          })(_newTr2);
-        }
-        return _newTr2 ? setSelectionAfterTransform(_newTr2, nodePos, targetType) : _newTr2;
-      } catch (error) {
-        var _nodeToFormat$attrs2, _api$analytics4;
-        logException(error, {
-          location: 'editor-plugin-block-menu'
-        });
-
-        // Fire error analytics event
-        var _sourceTypeName3 = nodeToFormat.type.name;
-        if (_sourceTypeName3 === 'heading' && (_nodeToFormat$attrs2 = nodeToFormat.attrs) !== null && _nodeToFormat$attrs2 !== void 0 && _nodeToFormat$attrs2.level) {
-          _sourceTypeName3 = "heading".concat(nodeToFormat.attrs.level);
-        }
-        api === null || api === void 0 || (_api$analytics4 = api.analytics) === null || _api$analytics4 === void 0 || (_api$analytics4 = _api$analytics4.actions) === null || _api$analytics4 === void 0 || _api$analytics4.fireAnalyticsEvent({
-          action: ACTION.ERRORED,
-          actionSubject: ACTION_SUBJECT.ELEMENT,
-          actionSubjectId: ACTION_SUBJECT_ID.TRANSFORM,
-          eventType: EVENT_TYPE.OPERATIONAL,
-          attributes: {
-            error: error.message,
-            errorStack: error.stack,
-            docSize: tr.doc.nodeSize,
-            from: _sourceTypeName3,
-            to: targetType,
-            position: tr.selection.from,
-            selection: tr.selection.toJSON(),
-            inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.BLOCK_MENU,
-            triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.MOUSE
-          }
-        });
-        return null;
-      }
-    };
-  };
-};

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

@@ -1,20 +0,0 @@
-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 { FormatNodeAnalyticsAttrs, 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
- * @param targetType - The target node type to convert to
- * @param analyticsAttrs - Attributes required for formatNode analytics like: inputMethod and triggeredFrom
- */
-export declare const formatNode: (api?: ExtractInjectionAPI<BlockMenuPlugin>) => (targetType: FormatNodeTargetType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;

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

@@ -1,20 +0,0 @@
-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 { FormatNodeAnalyticsAttrs, 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
- * @param targetType - The target node type to convert to
- * @param analyticsAttrs - Attributes required for formatNode analytics like: inputMethod and triggeredFrom
- */
-export declare const formatNode: (api?: ExtractInjectionAPI<BlockMenuPlugin>) => (targetType: FormatNodeTargetType, analyticsAttrs?: FormatNodeAnalyticsAttrs) => EditorCommand;