@atlaskit/editor-plugin-decorations 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-plugin-decorations
 
+## 3.1.0
+
+### Minor Changes
+
+- [`f0b0ea63f59bc`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f0b0ea63f59bc) -
+  [ux] ED-28803 Register Delete Button in block menu and add delete functionality and hover styles
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.0.1
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+
 ## 3.0.0
 
 ### Major Changes

package/dist/cjs/decorationsPlugin.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.decorationsPlugin = void 0;
+var _expValEqualsNoExposure = require("@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure");
+var _commands = require("./pm-plugins/commands");
 var _main = _interopRequireWildcard(require("./pm-plugins/main"));
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 /**
@@ -33,6 +35,21 @@ var decorationsPlugin = exports.decorationsPlugin = function decorationsPlugin()
         };
       }
       return _main.decorationStateKey.getState(editorState);
+    },
+    commands: {
+      hoverDecoration: (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu', 'isEnabled', true) ? function (_ref) {
+        var nodeType = _ref.nodeType,
+          add = _ref.add,
+          className = _ref.className;
+        return (0, _commands.hoverDecorationCommand)({
+          nodeType: nodeType,
+          add: add,
+          className: className
+        });
+      } : undefined,
+      removeDecoration: (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu', 'isEnabled', true) ? function () {
+        return (0, _commands.removeDecorationCommand)();
+      } : undefined
     }
   };
 };

package/dist/cjs/pm-plugins/commands.js

@@ -0,0 +1,105 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeDecorationCommand = exports.hoverDecorationCommand = void 0;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _utils = require("@atlaskit/editor-prosemirror/utils");
+var _view = require("@atlaskit/editor-prosemirror/view");
+var _editorTables = require("@atlaskit/editor-tables");
+var _utils2 = require("@atlaskit/editor-tables/utils");
+var _main = require("./main");
+var hoverDecorationCommand = exports.hoverDecorationCommand = function hoverDecorationCommand(_ref) {
+  var nodeType = _ref.nodeType,
+    add = _ref.add,
+    _ref$className = _ref.className,
+    className = _ref$className === void 0 ? 'danger' : _ref$className;
+  return function (_ref2) {
+    var tr = _ref2.tr;
+    var from;
+    var parentNode;
+    var decoration;
+    if (tr.selection instanceof _state.NodeSelection) {
+      var selectedNode = tr.selection.node;
+      var nodeTypes = Array.isArray(nodeType) ? nodeType : [nodeType];
+      var isNodeTypeMatching = nodeTypes.indexOf(selectedNode.type) > -1;
+      // This adds danger styling if the selected node is the one that requires
+      // the decoration to be added, e.g. if a layout is selected and the user
+      // hovers over the layout's delete button.
+      if (isNodeTypeMatching) {
+        from = tr.selection.from;
+        parentNode = selectedNode;
+      }
+    }
+
+    // This adds danger styling if the selection is not a node selection, OR if
+    // the selected node is a child of the one that requires the decoration to
+    // be added, e.g. if a decision item is selected inside a layout and the
+    // user hovers over the layout's delete button.
+    var foundParentNode = (0, _utils.findParentNodeOfType)(nodeType)(tr.selection);
+    if (from === undefined && foundParentNode) {
+      from = foundParentNode.pos;
+      parentNode = foundParentNode.node;
+    }
+
+    // Note: can't use !from as from could be 0, which is falsy but valid
+    if (from === undefined || parentNode === undefined) {
+      return tr;
+    }
+    decoration = _view.Decoration.node(from, from + parentNode.nodeSize, {
+      class: className
+    }, {
+      key: 'decorationNode'
+    });
+    if (tr.selection instanceof _state.TextSelection) {
+      decoration = _view.Decoration.inline(from, tr.selection.to, {
+        class: className,
+        style: "background-color: ".concat("var(--ds-background-danger, #FFECEB)", ";")
+      }, {
+        key: 'decorationNode'
+      });
+    }
+    if (tr.selection instanceof _editorTables.CellSelection) {
+      var table = (0, _editorTables.findTable)(tr.selection);
+      if (!table) {
+        return tr;
+      }
+      var map = _editorTables.TableMap.get(table.node);
+      var rect = (0, _utils2.getSelectionRect)(tr.selection);
+      if (!map || !rect) {
+        return tr;
+      }
+      var updatedCells = map.cellsInRect(rect).map(function (x) {
+        return x + table.start;
+      });
+      var tableCellDecorations = updatedCells.map(function (pos) {
+        var cell = tr.doc.nodeAt(pos);
+        if (!cell) {
+          return;
+        }
+        return _view.Decoration.node(pos, pos + cell.nodeSize, {
+          class: className
+        }, {
+          key: 'decorationNode'
+        });
+      }).filter(function (decoration) {
+        return !!decoration;
+      });
+      decoration = _view.DecorationSet.create(tr.doc, tableCellDecorations);
+    }
+    tr.setMeta(_main.decorationStateKey, {
+      action: add ? _main.ACTIONS.DECORATION_ADD : _main.ACTIONS.DECORATION_REMOVE,
+      data: decoration
+    }).setMeta('addToHistory', false);
+    return tr;
+  };
+};
+var removeDecorationCommand = exports.removeDecorationCommand = function removeDecorationCommand() {
+  return function (_ref3) {
+    var tr = _ref3.tr;
+    return tr.setMeta(_main.decorationStateKey, {
+      action: _main.ACTIONS.DECORATION_REMOVE
+    });
+  };
+};

package/dist/cjs/pm-plugins/main.js

@@ -8,6 +8,7 @@ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _expValEqualsNoExposure = require("@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure");
 var decorationStateKey = exports.decorationStateKey = new _state.PluginKey('decorationPlugin');
 var ACTIONS = exports.ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS[ACTIONS["DECORATION_ADD"] = 0] = "DECORATION_ADD";
@@ -81,7 +82,7 @@ var _default = exports.default = function _default() {
         };
       },
       apply: function apply(tr, pluginState) {
-        if (pluginState.decoration) {
+        if (pluginState.decoration && pluginState.decoration instanceof _view.Decoration) {
           var mapResult = tr.mapping.mapResult(pluginState.decoration.from);
           if (mapResult.deleted) {
             pluginState = {
@@ -89,6 +90,9 @@ var _default = exports.default = function _default() {
             };
           }
         }
+        if (pluginState.decoration && pluginState.decoration instanceof _view.DecorationSet && (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu', 'isEnabled', true)) {
+          pluginState.decoration = pluginState.decoration.map(tr.mapping, tr.doc);
+        }
         var meta = tr.getMeta(decorationStateKey);
         if (!meta) {
           return pluginState;
@@ -112,9 +116,12 @@ var _default = exports.default = function _default() {
         var doc = state.doc;
         var _ref2 = decorationStateKey.getState(state),
           decoration = _ref2.decoration;
-        if (decoration) {
+        if (decoration instanceof _view.Decoration) {
           return _view.DecorationSet.create(doc, [decoration]);
         }
+        if (decoration instanceof _view.DecorationSet && (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu', 'isEnabled', true)) {
+          return decoration;
+        }
         return null;
       }
     }

package/dist/es2019/decorationsPlugin.js

@@ -1,3 +1,5 @@
+import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
+import { hoverDecorationCommand, removeDecorationCommand } from './pm-plugins/commands';
 import decorationPlugin, { decorationStateKey, hoverDecoration, removeDecoration } from './pm-plugins/main';
 
 /**
@@ -23,5 +25,17 @@ export const decorationsPlugin = () => ({
       };
     }
     return decorationStateKey.getState(editorState);
+  },
+  commands: {
+    hoverDecoration: expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) ? ({
+      nodeType,
+      add,
+      className
+    }) => hoverDecorationCommand({
+      nodeType,
+      add,
+      className
+    }) : undefined,
+    removeDecoration: expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) ? () => removeDecorationCommand() : undefined
   }
 });

package/dist/es2019/pm-plugins/commands.js

@@ -0,0 +1,93 @@
+import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { CellSelection, findTable, TableMap } from '@atlaskit/editor-tables';
+import { getSelectionRect } from '@atlaskit/editor-tables/utils';
+import { ACTIONS, decorationStateKey } from './main';
+export const hoverDecorationCommand = ({
+  nodeType,
+  add,
+  className = 'danger'
+}) => ({
+  tr
+}) => {
+  let from;
+  let parentNode;
+  let decoration;
+  if (tr.selection instanceof NodeSelection) {
+    const selectedNode = tr.selection.node;
+    const nodeTypes = Array.isArray(nodeType) ? nodeType : [nodeType];
+    const isNodeTypeMatching = nodeTypes.indexOf(selectedNode.type) > -1;
+    // This adds danger styling if the selected node is the one that requires
+    // the decoration to be added, e.g. if a layout is selected and the user
+    // hovers over the layout's delete button.
+    if (isNodeTypeMatching) {
+      from = tr.selection.from;
+      parentNode = selectedNode;
+    }
+  }
+
+  // This adds danger styling if the selection is not a node selection, OR if
+  // the selected node is a child of the one that requires the decoration to
+  // be added, e.g. if a decision item is selected inside a layout and the
+  // user hovers over the layout's delete button.
+  const foundParentNode = findParentNodeOfType(nodeType)(tr.selection);
+  if (from === undefined && foundParentNode) {
+    from = foundParentNode.pos;
+    parentNode = foundParentNode.node;
+  }
+
+  // Note: can't use !from as from could be 0, which is falsy but valid
+  if (from === undefined || parentNode === undefined) {
+    return tr;
+  }
+  decoration = Decoration.node(from, from + parentNode.nodeSize, {
+    class: className
+  }, {
+    key: 'decorationNode'
+  });
+  if (tr.selection instanceof TextSelection) {
+    decoration = Decoration.inline(from, tr.selection.to, {
+      class: className,
+      style: `background-color: ${"var(--ds-background-danger, #FFECEB)"};`
+    }, {
+      key: 'decorationNode'
+    });
+  }
+  if (tr.selection instanceof CellSelection) {
+    const table = findTable(tr.selection);
+    if (!table) {
+      return tr;
+    }
+    const map = TableMap.get(table.node);
+    const rect = getSelectionRect(tr.selection);
+    if (!map || !rect) {
+      return tr;
+    }
+    const updatedCells = map.cellsInRect(rect).map(x => x + table.start);
+    const tableCellDecorations = updatedCells.map(pos => {
+      const cell = tr.doc.nodeAt(pos);
+      if (!cell) {
+        return;
+      }
+      return Decoration.node(pos, pos + cell.nodeSize, {
+        class: className
+      }, {
+        key: 'decorationNode'
+      });
+    }).filter(decoration => !!decoration);
+    decoration = DecorationSet.create(tr.doc, tableCellDecorations);
+  }
+  tr.setMeta(decorationStateKey, {
+    action: add ? ACTIONS.DECORATION_ADD : ACTIONS.DECORATION_REMOVE,
+    data: decoration
+  }).setMeta('addToHistory', false);
+  return tr;
+};
+export const removeDecorationCommand = () => ({
+  tr
+}) => {
+  return tr.setMeta(decorationStateKey, {
+    action: ACTIONS.DECORATION_REMOVE
+  });
+};

package/dist/es2019/pm-plugins/main.js

@@ -2,6 +2,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { NodeSelection, PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
 export const decorationStateKey = new PluginKey('decorationPlugin');
 export let ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS[ACTIONS["DECORATION_ADD"] = 0] = "DECORATION_ADD";
@@ -73,7 +74,7 @@ export default (() => {
         decoration: undefined
       }),
       apply(tr, pluginState) {
-        if (pluginState.decoration) {
+        if (pluginState.decoration && pluginState.decoration instanceof Decoration) {
           const mapResult = tr.mapping.mapResult(pluginState.decoration.from);
           if (mapResult.deleted) {
             pluginState = {
@@ -81,6 +82,9 @@ export default (() => {
             };
           }
         }
+        if (pluginState.decoration && pluginState.decoration instanceof DecorationSet && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true)) {
+          pluginState.decoration = pluginState.decoration.map(tr.mapping, tr.doc);
+        }
         const meta = tr.getMeta(decorationStateKey);
         if (!meta) {
           return pluginState;
@@ -107,9 +111,12 @@ export default (() => {
         const {
           decoration
         } = decorationStateKey.getState(state);
-        if (decoration) {
+        if (decoration instanceof Decoration) {
           return DecorationSet.create(doc, [decoration]);
         }
+        if (decoration instanceof DecorationSet && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true)) {
+          return decoration;
+        }
         return null;
       }
     }

package/dist/esm/decorationsPlugin.js

@@ -1,3 +1,5 @@
+import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
+import { hoverDecorationCommand, removeDecorationCommand } from './pm-plugins/commands';
 import decorationPlugin, { decorationStateKey, hoverDecoration, removeDecoration } from './pm-plugins/main';
 
 /**
@@ -26,6 +28,21 @@ export var decorationsPlugin = function decorationsPlugin() {
         };
       }
       return decorationStateKey.getState(editorState);
+    },
+    commands: {
+      hoverDecoration: expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) ? function (_ref) {
+        var nodeType = _ref.nodeType,
+          add = _ref.add,
+          className = _ref.className;
+        return hoverDecorationCommand({
+          nodeType: nodeType,
+          add: add,
+          className: className
+        });
+      } : undefined,
+      removeDecoration: expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) ? function () {
+        return removeDecorationCommand();
+      } : undefined
     }
   };
 };

package/dist/esm/pm-plugins/commands.js

@@ -0,0 +1,99 @@
+import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { CellSelection, findTable, TableMap } from '@atlaskit/editor-tables';
+import { getSelectionRect } from '@atlaskit/editor-tables/utils';
+import { ACTIONS, decorationStateKey } from './main';
+export var hoverDecorationCommand = function hoverDecorationCommand(_ref) {
+  var nodeType = _ref.nodeType,
+    add = _ref.add,
+    _ref$className = _ref.className,
+    className = _ref$className === void 0 ? 'danger' : _ref$className;
+  return function (_ref2) {
+    var tr = _ref2.tr;
+    var from;
+    var parentNode;
+    var decoration;
+    if (tr.selection instanceof NodeSelection) {
+      var selectedNode = tr.selection.node;
+      var nodeTypes = Array.isArray(nodeType) ? nodeType : [nodeType];
+      var isNodeTypeMatching = nodeTypes.indexOf(selectedNode.type) > -1;
+      // This adds danger styling if the selected node is the one that requires
+      // the decoration to be added, e.g. if a layout is selected and the user
+      // hovers over the layout's delete button.
+      if (isNodeTypeMatching) {
+        from = tr.selection.from;
+        parentNode = selectedNode;
+      }
+    }
+
+    // This adds danger styling if the selection is not a node selection, OR if
+    // the selected node is a child of the one that requires the decoration to
+    // be added, e.g. if a decision item is selected inside a layout and the
+    // user hovers over the layout's delete button.
+    var foundParentNode = findParentNodeOfType(nodeType)(tr.selection);
+    if (from === undefined && foundParentNode) {
+      from = foundParentNode.pos;
+      parentNode = foundParentNode.node;
+    }
+
+    // Note: can't use !from as from could be 0, which is falsy but valid
+    if (from === undefined || parentNode === undefined) {
+      return tr;
+    }
+    decoration = Decoration.node(from, from + parentNode.nodeSize, {
+      class: className
+    }, {
+      key: 'decorationNode'
+    });
+    if (tr.selection instanceof TextSelection) {
+      decoration = Decoration.inline(from, tr.selection.to, {
+        class: className,
+        style: "background-color: ".concat("var(--ds-background-danger, #FFECEB)", ";")
+      }, {
+        key: 'decorationNode'
+      });
+    }
+    if (tr.selection instanceof CellSelection) {
+      var table = findTable(tr.selection);
+      if (!table) {
+        return tr;
+      }
+      var map = TableMap.get(table.node);
+      var rect = getSelectionRect(tr.selection);
+      if (!map || !rect) {
+        return tr;
+      }
+      var updatedCells = map.cellsInRect(rect).map(function (x) {
+        return x + table.start;
+      });
+      var tableCellDecorations = updatedCells.map(function (pos) {
+        var cell = tr.doc.nodeAt(pos);
+        if (!cell) {
+          return;
+        }
+        return Decoration.node(pos, pos + cell.nodeSize, {
+          class: className
+        }, {
+          key: 'decorationNode'
+        });
+      }).filter(function (decoration) {
+        return !!decoration;
+      });
+      decoration = DecorationSet.create(tr.doc, tableCellDecorations);
+    }
+    tr.setMeta(decorationStateKey, {
+      action: add ? ACTIONS.DECORATION_ADD : ACTIONS.DECORATION_REMOVE,
+      data: decoration
+    }).setMeta('addToHistory', false);
+    return tr;
+  };
+};
+export var removeDecorationCommand = function removeDecorationCommand() {
+  return function (_ref3) {
+    var tr = _ref3.tr;
+    return tr.setMeta(decorationStateKey, {
+      action: ACTIONS.DECORATION_REMOVE
+    });
+  };
+};

package/dist/esm/pm-plugins/main.js

@@ -2,6 +2,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { NodeSelection, PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure';
 export var decorationStateKey = new PluginKey('decorationPlugin');
 export var ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS[ACTIONS["DECORATION_ADD"] = 0] = "DECORATION_ADD";
@@ -75,7 +76,7 @@ export default (function () {
         };
       },
       apply: function apply(tr, pluginState) {
-        if (pluginState.decoration) {
+        if (pluginState.decoration && pluginState.decoration instanceof Decoration) {
           var mapResult = tr.mapping.mapResult(pluginState.decoration.from);
           if (mapResult.deleted) {
             pluginState = {
@@ -83,6 +84,9 @@ export default (function () {
             };
           }
         }
+        if (pluginState.decoration && pluginState.decoration instanceof DecorationSet && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true)) {
+          pluginState.decoration = pluginState.decoration.map(tr.mapping, tr.doc);
+        }
         var meta = tr.getMeta(decorationStateKey);
         if (!meta) {
           return pluginState;
@@ -106,9 +110,12 @@ export default (function () {
         var doc = state.doc;
         var _ref2 = decorationStateKey.getState(state),
           decoration = _ref2.decoration;
-        if (decoration) {
+        if (decoration instanceof Decoration) {
           return DecorationSet.create(doc, [decoration]);
         }
+        if (decoration instanceof DecorationSet && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true)) {
+          return decoration;
+        }
         return null;
       }
     }

package/dist/types/decorationsPluginType.d.ts

@@ -1,9 +1,20 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, EditorCommand } from '@atlaskit/editor-common/types';
+import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugins/main';
+export type HoverDecorationProps = {
+    add: boolean;
+    className?: string;
+    nodeType: NodeType | Array<NodeType>;
+};
+export type HoverDecorationCommand = ({ nodeType, add, className, }: HoverDecorationProps) => EditorCommand;
 export type DecorationsPlugin = NextEditorPlugin<'decorations', {
-    sharedState: DecorationState;
     actions: {
         hoverDecoration: HoverDecorationHandler;
         removeDecoration: typeof removeDecoration;
     };
+    commands: {
+        hoverDecoration?: HoverDecorationCommand;
+        removeDecoration?: () => EditorCommand;
+    };
+    sharedState: DecorationState;
 }>;

package/dist/types/pm-plugins/commands.d.ts

@@ -0,0 +1,4 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { HoverDecorationCommand } from '../decorationsPluginType';
+export declare const hoverDecorationCommand: HoverDecorationCommand;
+export declare const removeDecorationCommand: () => EditorCommand;

package/dist/types/pm-plugins/main.d.ts

@@ -2,7 +2,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { Command } from '@atlaskit/editor-common/types';
 import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { Decoration } from '@atlaskit/editor-prosemirror/view';
+import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export declare const decorationStateKey: PluginKey<any>;
 export declare enum ACTIONS {
     DECORATION_ADD = 0,
@@ -11,7 +11,7 @@ export declare enum ACTIONS {
 export declare const removeDecoration: Command;
 export declare const hoverDecoration: (nodeType: NodeType | Array<NodeType>, add: boolean, className?: string) => Command;
 export type DecorationState = {
-    decoration?: Decoration;
+    decoration?: Decoration | DecorationSet;
 };
 type HoverDecorationHandler = typeof hoverDecoration;
 export type { HoverDecorationHandler };

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

@@ -1,9 +1,20 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, EditorCommand } from '@atlaskit/editor-common/types';
+import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugins/main';
+export type HoverDecorationProps = {
+    add: boolean;
+    className?: string;
+    nodeType: NodeType | Array<NodeType>;
+};
+export type HoverDecorationCommand = ({ nodeType, add, className, }: HoverDecorationProps) => EditorCommand;
 export type DecorationsPlugin = NextEditorPlugin<'decorations', {
-    sharedState: DecorationState;
     actions: {
         hoverDecoration: HoverDecorationHandler;
         removeDecoration: typeof removeDecoration;
     };
+    commands: {
+        hoverDecoration?: HoverDecorationCommand;
+        removeDecoration?: () => EditorCommand;
+    };
+    sharedState: DecorationState;
 }>;

package/dist/types-ts4.5/pm-plugins/commands.d.ts

@@ -0,0 +1,4 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { HoverDecorationCommand } from '../decorationsPluginType';
+export declare const hoverDecorationCommand: HoverDecorationCommand;
+export declare const removeDecorationCommand: () => EditorCommand;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -2,7 +2,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { Command } from '@atlaskit/editor-common/types';
 import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { Decoration } from '@atlaskit/editor-prosemirror/view';
+import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export declare const decorationStateKey: PluginKey<any>;
 export declare enum ACTIONS {
     DECORATION_ADD = 0,
@@ -11,7 +11,7 @@ export declare enum ACTIONS {
 export declare const removeDecoration: Command;
 export declare const hoverDecoration: (nodeType: NodeType | Array<NodeType>, add: boolean, className?: string) => Command;
 export type DecorationState = {
-    decoration?: Decoration;
+    decoration?: Decoration | DecorationSet;
 };
 type HoverDecorationHandler = typeof hoverDecoration;
 export type { HoverDecorationHandler };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-decorations",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"description": "Decorations plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -23,18 +23,20 @@
 	},
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/tmp-editor-statsig": "^11.6.0",
+		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.6.0",
+		"@atlaskit/editor-common": "^107.29.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"devDependencies": {
-		"@atlaskit/editor-plugin-mentions": "^5.0.0",
+		"@atlaskit/editor-plugin-mentions": "^5.2.0",
 		"@testing-library/react": "^13.4.0",
-		"typescript": "~5.4.2",
 		"wait-for-expect": "^1.2.0"
 	},
 	"techstack": {