@atlaskit/editor-common 74.45.5 → 74.46.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-common
 
+## 74.46.0
+
+### Minor Changes
+
+- [`24fc3925d73`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24fc3925d73) - Add a new hook called `usePreset` accesed via `@atlaskit/editor-core/use-preset`. This hook can be used to safely access state and commands from outside the editor using `EditorContext`.
+
 ## 74.45.5
 
 ### Patch Changes

package/dist/cjs/keymaps/index.js

@@ -80,7 +80,7 @@ Object.defineProperty(exports, "UP", {
 });
 exports.backspace = exports.altPaste = exports.alignLeft = exports.addRowBefore = exports.addRowAfter = exports.addLink = exports.addInlineComment = exports.addColumnBefore = exports.addColumnAfter = exports.addAltText = void 0;
 exports.bindKeymapWithCommand = bindKeymapWithCommand;
-exports.bindKeymapWithPluginCommand = bindKeymapWithPluginCommand;
+exports.bindKeymapWithEditorCommand = bindKeymapWithEditorCommand;
 exports.find = exports.escape = exports.enter = exports.deleteKey = exports.cut = exports.ctrlBackSpace = exports.copy = exports.clearFormatting = void 0;
 exports.findKeyMapForBrowser = findKeyMapForBrowser;
 exports.findKeymapByDescription = findKeymapByDescription;
@@ -105,7 +105,7 @@ var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/hel
 var _react = _interopRequireWildcard(require("react"));
 var _react2 = require("@emotion/react");
 var _colors = require("@atlaskit/theme/colors");
-var _pluginCommands = require("../preset/plugin-commands");
+var _editorCommands = require("../preset/editor-commands");
 var _utils = require("../utils");
 var _consts = require("./consts");
 var _keymap = require("./keymap");
@@ -363,8 +363,8 @@ function bindKeymapWithCommand(shortcut, cmd, keymap) {
   var oldCmd = keymap[shortcut];
   keymap[shortcut] = oldCmd ? combineWithOldCommand(cmd, oldCmd) : cmd;
 }
-function bindKeymapWithPluginCommand(shortcut, cmd, keymap) {
-  bindKeymapWithCommand(shortcut, (0, _pluginCommands.pluginCommandToPMCommand)(cmd), keymap);
+function bindKeymapWithEditorCommand(shortcut, cmd, keymap) {
+  bindKeymapWithCommand(shortcut, (0, _editorCommands.editorCommandToPMCommand)(cmd), keymap);
 }
 function findKeyMapForBrowser(keyMap) {
   if (keyMap) {

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "74.45.5";
+var packageVersion = "74.46.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/cjs/preset/{plugin-commands.js → editor-commands.js}

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.pluginCommandToPMCommand = pluginCommandToPMCommand;
+exports.editorCommandToPMCommand = editorCommandToPMCommand;
 /**
- * Convert a PluginCommand to a standard Prosemirror Command.
- * The preferred approach to dispatching a `PluginCommand` is via the
+ * Convert a EditorCommand to a standard Prosemirror Command.
+ * The preferred approach to dispatching a `EditorCommand` is via the
  * `executeCommand` on `pluginInjectionAPI`. In some cases
  * the type may require a Command until we refactor this out and this
  * function is suitable for those cases.
@@ -14,7 +14,7 @@ exports.pluginCommandToPMCommand = pluginCommandToPMCommand;
  * @param command A plugin command (a function that modifies and returns a `Transaction`)
  * @returns Command
  */
-function pluginCommandToPMCommand(command) {
+function editorCommandToPMCommand(command) {
   return function (_ref, dispatch) {
     var tr = _ref.tr;
     var newTr = command === null || command === void 0 ? void 0 : command({

package/dist/cjs/preset/index.js

@@ -15,12 +15,12 @@ Object.defineProperty(exports, "EditorPresetBuilder", {
     return _builder.EditorPresetBuilder;
   }
 });
-Object.defineProperty(exports, "pluginCommandToPMCommand", {
+Object.defineProperty(exports, "editorCommandToPMCommand", {
   enumerable: true,
   get: function get() {
-    return _pluginCommands.pluginCommandToPMCommand;
+    return _editorCommands.editorCommandToPMCommand;
   }
 });
 var _builder = require("./builder");
 var _pluginInjectionApi = require("./plugin-injection-api");
-var _pluginCommands = require("./plugin-commands");
+var _editorCommands = require("./editor-commands");

package/dist/cjs/preset/plugin-injection-api.js

@@ -13,7 +13,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _throttle = _interopRequireDefault(require("lodash/throttle"));
-var _pluginCommands = require("./plugin-commands");
+var _editorCommands = require("./editor-commands");
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
@@ -125,11 +125,11 @@ var ActionsAPI = /*#__PURE__*/function () {
   }]);
   return ActionsAPI;
 }();
-var PluginCommandsAPI = /*#__PURE__*/function () {
-  function PluginCommandsAPI() {
-    (0, _classCallCheck2.default)(this, PluginCommandsAPI);
+var EditorCommandsAPI = /*#__PURE__*/function () {
+  function EditorCommandsAPI() {
+    (0, _classCallCheck2.default)(this, EditorCommandsAPI);
   }
-  (0, _createClass2.default)(PluginCommandsAPI, [{
+  (0, _createClass2.default)(EditorCommandsAPI, [{
     key: "createAPI",
     value: function createAPI(plugin) {
       if (!plugin || !hasCommands(plugin)) {
@@ -143,7 +143,7 @@ var PluginCommandsAPI = /*#__PURE__*/function () {
       });
     }
   }]);
-  return PluginCommandsAPI;
+  return EditorCommandsAPI;
 }();
 var SharedStateAPI = /*#__PURE__*/function () {
   function SharedStateAPI(_ref4) {
@@ -271,7 +271,7 @@ var EditorPluginInjectionAPI = /*#__PURE__*/function () {
     });
     this.plugins = new Map();
     this.actionsAPI = new ActionsAPI();
-    this.commandsAPI = new PluginCommandsAPI();
+    this.commandsAPI = new EditorCommandsAPI();
     this.getEditorView = getEditorView;
   }
   (0, _createClass2.default)(EditorPluginInjectionAPI, [{
@@ -321,7 +321,7 @@ var EditorPluginInjectionAPI = /*#__PURE__*/function () {
       }
       var state = editorView.state,
         dispatch = editorView.dispatch;
-      return (0, _pluginCommands.pluginCommandToPMCommand)(command)(state, dispatch);
+      return (0, _editorCommands.editorCommandToPMCommand)(command)(state, dispatch);
     }
   }]);
   return EditorPluginInjectionAPI;

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ var _templateObject, _templateObject2, _templateObject3;
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /** @jsx jsx */
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.45.5";
+var packageVersion = "74.46.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.45.5",
+	"version": "74.46.0",
 	"sideEffects": false
 }

package/dist/es2019/keymaps/index.js

@@ -2,7 +2,7 @@
 import React, { Fragment } from 'react';
 import { css, jsx } from '@emotion/react';
 import { N400 } from '@atlaskit/theme/colors';
-import { pluginCommandToPMCommand } from '../preset/plugin-commands';
+import { editorCommandToPMCommand } from '../preset/editor-commands';
 import { browser } from '../utils';
 export const addAltText = makeKeyMapWithCommon('Add Alt Text', 'Mod-Alt-y');
 export const navToEditorToolbar = makeKeyMapWithCommon('Navigate to editor toolbar', 'Alt-F9');
@@ -196,8 +196,8 @@ export function bindKeymapWithCommand(shortcut, cmd, keymap) {
   const oldCmd = keymap[shortcut];
   keymap[shortcut] = oldCmd ? combineWithOldCommand(cmd, oldCmd) : cmd;
 }
-export function bindKeymapWithPluginCommand(shortcut, cmd, keymap) {
-  bindKeymapWithCommand(shortcut, pluginCommandToPMCommand(cmd), keymap);
+export function bindKeymapWithEditorCommand(shortcut, cmd, keymap) {
+  bindKeymapWithCommand(shortcut, editorCommandToPMCommand(cmd), keymap);
 }
 export function findKeyMapForBrowser(keyMap) {
   if (keyMap) {

package/dist/es2019/monitoring/error.js

@@ -1,6 +1,6 @@
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "74.45.5";
+const packageVersion = "74.46.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/es2019/preset/{plugin-commands.js → editor-commands.js}

@@ -1,6 +1,6 @@
 /**
- * Convert a PluginCommand to a standard Prosemirror Command.
- * The preferred approach to dispatching a `PluginCommand` is via the
+ * Convert a EditorCommand to a standard Prosemirror Command.
+ * The preferred approach to dispatching a `EditorCommand` is via the
  * `executeCommand` on `pluginInjectionAPI`. In some cases
  * the type may require a Command until we refactor this out and this
  * function is suitable for those cases.
@@ -8,7 +8,7 @@
  * @param command A plugin command (a function that modifies and returns a `Transaction`)
  * @returns Command
  */
-export function pluginCommandToPMCommand(command) {
+export function editorCommandToPMCommand(command) {
   return ({
     tr
   }, dispatch) => {

package/dist/es2019/preset/index.js

@@ -1,3 +1,3 @@
 export { EditorPresetBuilder } from './builder';
 export { EditorPluginInjectionAPI } from './plugin-injection-api';
-export { pluginCommandToPMCommand } from './plugin-commands';
+export { editorCommandToPMCommand } from './editor-commands';

package/dist/es2019/preset/plugin-injection-api.js

@@ -1,7 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import isEqual from 'lodash/isEqual';
 import throttle from 'lodash/throttle';
-import { pluginCommandToPMCommand } from './plugin-commands';
+import { editorCommandToPMCommand } from './editor-commands';
 function hasGetSharedState(plugin) {
   return typeof plugin.getSharedState === 'function';
 }
@@ -74,7 +74,7 @@ class ActionsAPI {
     });
   }
 }
-class PluginCommandsAPI {
+class EditorCommandsAPI {
   createAPI(plugin) {
     if (!plugin || !hasCommands(plugin)) {
       return {};
@@ -189,7 +189,7 @@ export class EditorPluginInjectionAPI {
     });
     this.plugins = new Map();
     this.actionsAPI = new ActionsAPI();
-    this.commandsAPI = new PluginCommandsAPI();
+    this.commandsAPI = new EditorCommandsAPI();
     this.getEditorView = getEditorView;
   }
   api() {
@@ -239,6 +239,6 @@ export class EditorPluginInjectionAPI {
       state,
       dispatch
     } = editorView;
-    return pluginCommandToPMCommand(command)(state, dispatch);
+    return editorCommandToPMCommand(command)(state, dispatch);
   }
 }

package/dist/es2019/ui/DropList/index.js

@@ -8,7 +8,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "74.45.5";
+const packageVersion = "74.46.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.45.5",
+	"version": "74.46.0",
 	"sideEffects": false
 }

package/dist/esm/keymaps/index.js

@@ -5,7 +5,7 @@ var _templateObject;
 import React, { Fragment } from 'react';
 import { css, jsx } from '@emotion/react';
 import { N400 } from '@atlaskit/theme/colors';
-import { pluginCommandToPMCommand } from '../preset/plugin-commands';
+import { editorCommandToPMCommand } from '../preset/editor-commands';
 import { browser } from '../utils';
 export var addAltText = makeKeyMapWithCommon('Add Alt Text', 'Mod-Alt-y');
 export var navToEditorToolbar = makeKeyMapWithCommon('Navigate to editor toolbar', 'Alt-F9');
@@ -192,8 +192,8 @@ export function bindKeymapWithCommand(shortcut, cmd, keymap) {
   var oldCmd = keymap[shortcut];
   keymap[shortcut] = oldCmd ? combineWithOldCommand(cmd, oldCmd) : cmd;
 }
-export function bindKeymapWithPluginCommand(shortcut, cmd, keymap) {
-  bindKeymapWithCommand(shortcut, pluginCommandToPMCommand(cmd), keymap);
+export function bindKeymapWithEditorCommand(shortcut, cmd, keymap) {
+  bindKeymapWithCommand(shortcut, editorCommandToPMCommand(cmd), keymap);
 }
 export function findKeyMapForBrowser(keyMap) {
   if (keyMap) {

package/dist/esm/monitoring/error.js

@@ -6,7 +6,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "74.45.5";
+var packageVersion = "74.46.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/preset/{plugin-commands.js → editor-commands.js}

@@ -1,6 +1,6 @@
 /**
- * Convert a PluginCommand to a standard Prosemirror Command.
- * The preferred approach to dispatching a `PluginCommand` is via the
+ * Convert a EditorCommand to a standard Prosemirror Command.
+ * The preferred approach to dispatching a `EditorCommand` is via the
  * `executeCommand` on `pluginInjectionAPI`. In some cases
  * the type may require a Command until we refactor this out and this
  * function is suitable for those cases.
@@ -8,7 +8,7 @@
  * @param command A plugin command (a function that modifies and returns a `Transaction`)
  * @returns Command
  */
-export function pluginCommandToPMCommand(command) {
+export function editorCommandToPMCommand(command) {
   return function (_ref, dispatch) {
     var tr = _ref.tr;
     var newTr = command === null || command === void 0 ? void 0 : command({

package/dist/esm/preset/index.js

@@ -1,3 +1,3 @@
 export { EditorPresetBuilder } from './builder';
 export { EditorPluginInjectionAPI } from './plugin-injection-api';
-export { pluginCommandToPMCommand } from './plugin-commands';
+export { editorCommandToPMCommand } from './editor-commands';

package/dist/esm/preset/plugin-injection-api.js

@@ -9,7 +9,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 import isEqual from 'lodash/isEqual';
 import throttle from 'lodash/throttle';
-import { pluginCommandToPMCommand } from './plugin-commands';
+import { editorCommandToPMCommand } from './editor-commands';
 function hasGetSharedState(plugin) {
   return typeof plugin.getSharedState === 'function';
 }
@@ -117,11 +117,11 @@ var ActionsAPI = /*#__PURE__*/function () {
   }]);
   return ActionsAPI;
 }();
-var PluginCommandsAPI = /*#__PURE__*/function () {
-  function PluginCommandsAPI() {
-    _classCallCheck(this, PluginCommandsAPI);
+var EditorCommandsAPI = /*#__PURE__*/function () {
+  function EditorCommandsAPI() {
+    _classCallCheck(this, EditorCommandsAPI);
   }
-  _createClass(PluginCommandsAPI, [{
+  _createClass(EditorCommandsAPI, [{
     key: "createAPI",
     value: function createAPI(plugin) {
       if (!plugin || !hasCommands(plugin)) {
@@ -135,7 +135,7 @@ var PluginCommandsAPI = /*#__PURE__*/function () {
       });
     }
   }]);
-  return PluginCommandsAPI;
+  return EditorCommandsAPI;
 }();
 export var SharedStateAPI = /*#__PURE__*/function () {
   function SharedStateAPI(_ref4) {
@@ -262,7 +262,7 @@ export var EditorPluginInjectionAPI = /*#__PURE__*/function () {
     });
     this.plugins = new Map();
     this.actionsAPI = new ActionsAPI();
-    this.commandsAPI = new PluginCommandsAPI();
+    this.commandsAPI = new EditorCommandsAPI();
     this.getEditorView = getEditorView;
   }
   _createClass(EditorPluginInjectionAPI, [{
@@ -312,7 +312,7 @@ export var EditorPluginInjectionAPI = /*#__PURE__*/function () {
       }
       var state = editorView.state,
         dispatch = editorView.dispatch;
-      return pluginCommandToPMCommand(command)(state, dispatch);
+      return editorCommandToPMCommand(command)(state, dispatch);
     }
   }]);
   return EditorPluginInjectionAPI;

package/dist/esm/ui/DropList/index.js

@@ -18,7 +18,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.45.5";
+var packageVersion = "74.46.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.45.5",
+	"version": "74.46.0",
 	"sideEffects": false
 }

package/dist/types/keymaps/index.d.ts

@@ -2,7 +2,7 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { Command } from '../types/command';
-import type { PluginCommand } from '../types/plugin-command';
+import type { EditorCommand } from '../types/editor-command';
 export declare const addAltText: Keymap;
 export declare const navToEditorToolbar: Keymap;
 export declare const navToFloatingToolbar: Keymap;
@@ -88,7 +88,7 @@ export interface Keymap {
 export declare function bindKeymapWithCommand(shortcut: string, cmd: Command, keymap: {
     [key: string]: Command;
 }): void;
-export declare function bindKeymapWithPluginCommand(shortcut: string, cmd: PluginCommand, keymap: {
+export declare function bindKeymapWithEditorCommand(shortcut: string, cmd: EditorCommand, keymap: {
     [key: string]: Command;
 }): void;
 export declare function findKeyMapForBrowser(keyMap: Keymap): string | undefined;

package/dist/types/mark/commands.d.ts

@@ -1,6 +1,6 @@
 import type { Mark, MarkType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { PluginCommand } from '../types';
+import type { EditorCommand } from '../types';
 export declare function filterChildrenBetween(doc: PMNode, from: number, to: number, predicate: (node: PMNode, pos: number, parent: PMNode | null) => boolean | undefined): {
     node: PMNode;
     pos: number;
@@ -15,4 +15,4 @@ export declare const applyMarkOnRange: (from: number, to: number, removeMark: bo
  */
 export declare const toggleMark: (markType: MarkType, attrs?: {
     [key: string]: any;
-} | undefined) => PluginCommand;
+} | undefined) => EditorCommand;

package/dist/{types-ts4.5/preset/plugin-commands.d.ts → types/preset/editor-commands.d.ts}

@@ -1,8 +1,8 @@
 import type { Command } from '../types/command';
-import type { PluginCommand } from '../types/plugin-command';
+import type { EditorCommand } from '../types/editor-command';
 /**
- * Convert a PluginCommand to a standard Prosemirror Command.
- * The preferred approach to dispatching a `PluginCommand` is via the
+ * Convert a EditorCommand to a standard Prosemirror Command.
+ * The preferred approach to dispatching a `EditorCommand` is via the
  * `executeCommand` on `pluginInjectionAPI`. In some cases
  * the type may require a Command until we refactor this out and this
  * function is suitable for those cases.
@@ -10,4 +10,4 @@ import type { PluginCommand } from '../types/plugin-command';
  * @param command A plugin command (a function that modifies and returns a `Transaction`)
  * @returns Command
  */
-export declare function pluginCommandToPMCommand(command: PluginCommand | undefined): Command;
+export declare function editorCommandToPMCommand(command: EditorCommand | undefined): Command;

package/dist/types/preset/index.d.ts

@@ -1,3 +1,3 @@
 export { EditorPresetBuilder } from './builder';
 export { EditorPluginInjectionAPI } from './plugin-injection-api';
-export { pluginCommandToPMCommand } from './plugin-commands';
+export { editorCommandToPMCommand } from './editor-commands';

package/dist/types/preset/plugin-injection-api.d.ts

@@ -1,7 +1,7 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorCommand } from '../types/editor-command';
 import type { DefaultEditorPlugin, NextEditorPlugin, PluginDependenciesAPI, PluginInjectionAPI } from '../types/next-editor-plugin';
-import type { PluginCommand } from '../types/plugin-command';
 type NextEditorPluginInitializedType = ReturnType<NextEditorPlugin<any>>;
 type SharedStateAPIProps = {
     getEditorState: () => EditorState | undefined;
@@ -43,7 +43,7 @@ export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefin
     constructor({ getEditorState, getEditorView }: PluginInjectionAPIProps);
     api<T extends NextEditorPlugin<any, any>>(): {
         dependencies: import("../types/next-editor-plugin").CreatePluginDependenciesAPI<[NextEditorPlugin<T extends (config?: any, api?: PluginInjectionAPI<infer Name extends string, any> | undefined) => DefaultEditorPlugin<infer Name extends string, any> ? Name : never, T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never>, ..."dependencies" extends keyof (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never) ? (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"] extends (((config?: any, api?: PluginInjectionAPI<any, any> | undefined) => DefaultEditorPlugin<any, any>) | import("../types/next-editor-plugin").OptionalPlugin<(config?: any, api?: PluginInjectionAPI<any, any> | undefined) => DefaultEditorPlugin<any, any>>)[] ? Exclude<(T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"], undefined> : [] : []]>;
-        executeCommand: (command: PluginCommand | undefined) => boolean;
+        executeCommand: (command: EditorCommand | undefined) => boolean;
     };
     private executeCommand;
     onEditorViewUpdated: ({ newEditorState, oldEditorState, }: EditorStateDiff) => void;

package/dist/types/types/editor-command.d.ts

@@ -0,0 +1,5 @@
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export type EditorCommand = (props: {
+    tr: Transaction;
+}) => Transaction | null;
+export type EditorCommandWithMetadata = (args: any) => EditorCommand;

package/dist/types/types/index.d.ts

@@ -28,8 +28,8 @@ export type { EditorReactContext } from './editor-react-context';
 export type { PMPluginFactoryParams, PMPluginFactory, PMPlugin, } from './plugin-factory';
 export type { NodeConfig, MarkConfig, NodeViewConfig, } from './prosemirror-config';
 export type { PluginsOptions, EditorPlugin, getPosHandler, getPosHandlerNode, } from './editor-plugin';
-export type { NextEditorPlugin, AllEditorPresetPluginTypes, PluginDependenciesAPI, ExtractPluginNameFromAllBuilderPlugins, SafePresetCheck, DefaultEditorPlugin, OptionalPlugin, PluginInjectionAPI, CreatePluginDependenciesAPI, NextEditorPluginMetadata, ExtractInjectionAPI, ExtractPluginActions, PluginInjectionAPIWithDependency, PluginInjectionAPIWithDependencies, } from './next-editor-plugin';
-export type { PluginCommand, PluginCommandWithMetadata, } from './plugin-command';
+export type { NextEditorPlugin, AllEditorPresetPluginTypes, PluginDependenciesAPI, ExtractPluginNameFromAllBuilderPlugins, SafePresetCheck, DefaultEditorPlugin, OptionalPlugin, PluginInjectionAPI, CreatePluginDependenciesAPI, NextEditorPluginMetadata, ExtractInjectionAPI, ExtractPluginActions, PluginInjectionAPIWithDependency, PluginInjectionAPIWithDependencies, PublicPluginAPI, } from './next-editor-plugin';
+export type { EditorCommand, EditorCommandWithMetadata, } from './editor-command';
 export type IconProps = {
     label?: string;
 };

package/dist/types/types/next-editor-plugin.d.ts

@@ -5,8 +5,8 @@
  * are put together - but for now `Builder` & `Preset` aim to beinterchangeable.
  */
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { EditorCommand, EditorCommandWithMetadata } from './editor-command';
 import type { EditorPlugin } from './editor-plugin';
-import type { PluginCommand, PluginCommandWithMetadata } from './plugin-command';
 type IsAny<T> = 0 extends 1 & T ? true : false;
 type PickSharedStatePropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractSharedStateFromMetadata<Metadata> extends never ? never : 'getSharedState';
 type WithSharedState<Metadata extends NextEditorPluginMetadata> = {
@@ -25,13 +25,13 @@ export type DefaultEditorPlugin<Name extends string, Metadata extends NextEditor
 };
 type MaybeAction = ((...agrs: any) => any) | ((...agrs: any) => void);
 type NextEditorPluginActions = Record<string, MaybeAction>;
-type NextEditorPluginCommands = Record<string, PluginCommandWithMetadata | PluginCommand>;
+type NextEditorEditorCommands = Record<string, EditorCommandWithMetadata | EditorCommand>;
 export interface NextEditorPluginMetadata {
     readonly sharedState?: any;
     readonly pluginConfiguration?: any;
     readonly dependencies?: DependencyPlugin[];
     readonly actions?: NextEditorPluginActions;
-    readonly commands?: NextEditorPluginCommands;
+    readonly commands?: NextEditorEditorCommands;
 }
 export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorPluginMetadata> = {
     dependencies: CreatePluginDependenciesAPI<[
@@ -39,13 +39,13 @@ export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorP
         ...ExtractPluginDependenciesFromMetadata<Metadata>
     ]>;
     /**
-     * Dispatches a PluginCommand to ProseMirror
+     * Dispatches an EditorCommand to ProseMirror
      *
-     * @param action A function (PluginCommand | undefined) that takes a `Transaction` and returns a `Transaction` if it
+     * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
      * is successful or `null` if it shouldn't be dispatched.
      * @returns (boolean) if the command was successful in dispatching
      */
-    executeCommand: (action: PluginCommand | undefined) => boolean;
+    executeCommand: (command: EditorCommand | undefined) => boolean;
 };
 export type PluginInjectionAPIWithDependency<Plugin> = Plugin extends NextEditorPlugin<infer Name, infer Metadata> ? {
     dependencies: CreatePluginDependenciesAPI<[
@@ -117,4 +117,15 @@ type CheckTupleRequirements<Plugin, Config, ArrayType> = unknown extends Config
 type CheckBasicPlugin<Plugin> = Plugin extends (args: any, api: any) => EditorPlugin ? CheckTupleRequirements<Plugin, ExtractPluginConfiguration<Plugin>, PluginAsArray<Plugin>> : never;
 export type ExtractPluginNameFromAllBuilderPlugins<Plugin extends AllEditorPresetPluginTypes> = Plugin extends Array<any> ? Plugin extends [infer MaybePlugin, ...any] ? MaybePlugin extends NextEditorPlugin<any, any> ? ExtractPluginName<MaybePlugin> : never : never : Plugin extends NextEditorPlugin<any, any> ? ExtractPluginName<Plugin> : never;
 export type ExtractInjectionAPI<Plugin> = Plugin extends NextEditorPlugin<infer Name, infer Metadata> ? PluginInjectionAPI<Name, Metadata> : never;
+export type PublicPluginAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
+    dependencies: CreatePluginDependenciesAPI<PluginList>;
+    /**
+     * Dispatches an EditorCommand to ProseMirror
+     *
+     * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
+     * is successful or `null` if it shouldn't be dispatched.
+     * @returns (boolean) if the command was successful in dispatching
+     */
+    executeCommand: (command: EditorCommand | undefined) => boolean;
+};
 export {};

package/dist/types-ts4.5/keymaps/index.d.ts

@@ -2,7 +2,7 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { Command } from '../types/command';
-import type { PluginCommand } from '../types/plugin-command';
+import type { EditorCommand } from '../types/editor-command';
 export declare const addAltText: Keymap;
 export declare const navToEditorToolbar: Keymap;
 export declare const navToFloatingToolbar: Keymap;
@@ -88,7 +88,7 @@ export interface Keymap {
 export declare function bindKeymapWithCommand(shortcut: string, cmd: Command, keymap: {
     [key: string]: Command;
 }): void;
-export declare function bindKeymapWithPluginCommand(shortcut: string, cmd: PluginCommand, keymap: {
+export declare function bindKeymapWithEditorCommand(shortcut: string, cmd: EditorCommand, keymap: {
     [key: string]: Command;
 }): void;
 export declare function findKeyMapForBrowser(keyMap: Keymap): string | undefined;

package/dist/types-ts4.5/mark/commands.d.ts

@@ -1,6 +1,6 @@
 import type { Mark, MarkType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { PluginCommand } from '../types';
+import type { EditorCommand } from '../types';
 export declare function filterChildrenBetween(doc: PMNode, from: number, to: number, predicate: (node: PMNode, pos: number, parent: PMNode | null) => boolean | undefined): {
     node: PMNode;
     pos: number;
@@ -15,4 +15,4 @@ export declare const applyMarkOnRange: (from: number, to: number, removeMark: bo
  */
 export declare const toggleMark: (markType: MarkType, attrs?: {
     [key: string]: any;
-} | undefined) => PluginCommand;
+} | undefined) => EditorCommand;

package/dist/{types/preset/plugin-commands.d.ts → types-ts4.5/preset/editor-commands.d.ts}

@@ -1,8 +1,8 @@
 import type { Command } from '../types/command';
-import type { PluginCommand } from '../types/plugin-command';
+import type { EditorCommand } from '../types/editor-command';
 /**
- * Convert a PluginCommand to a standard Prosemirror Command.
- * The preferred approach to dispatching a `PluginCommand` is via the
+ * Convert a EditorCommand to a standard Prosemirror Command.
+ * The preferred approach to dispatching a `EditorCommand` is via the
  * `executeCommand` on `pluginInjectionAPI`. In some cases
  * the type may require a Command until we refactor this out and this
  * function is suitable for those cases.
@@ -10,4 +10,4 @@ import type { PluginCommand } from '../types/plugin-command';
  * @param command A plugin command (a function that modifies and returns a `Transaction`)
  * @returns Command
  */
-export declare function pluginCommandToPMCommand(command: PluginCommand | undefined): Command;
+export declare function editorCommandToPMCommand(command: EditorCommand | undefined): Command;

package/dist/types-ts4.5/preset/index.d.ts

@@ -1,3 +1,3 @@
 export { EditorPresetBuilder } from './builder';
 export { EditorPluginInjectionAPI } from './plugin-injection-api';
-export { pluginCommandToPMCommand } from './plugin-commands';
+export { editorCommandToPMCommand } from './editor-commands';

package/dist/types-ts4.5/preset/plugin-injection-api.d.ts

@@ -1,7 +1,7 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorCommand } from '../types/editor-command';
 import type { DefaultEditorPlugin, NextEditorPlugin, PluginDependenciesAPI, PluginInjectionAPI } from '../types/next-editor-plugin';
-import type { PluginCommand } from '../types/plugin-command';
 type NextEditorPluginInitializedType = ReturnType<NextEditorPlugin<any>>;
 type SharedStateAPIProps = {
     getEditorState: () => EditorState | undefined;
@@ -48,7 +48,7 @@ export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefin
             ] : [
             ]
         ]>;
-        executeCommand: (command: PluginCommand | undefined) => boolean;
+        executeCommand: (command: EditorCommand | undefined) => boolean;
     };
     private executeCommand;
     onEditorViewUpdated: ({ newEditorState, oldEditorState, }: EditorStateDiff) => void;

package/dist/types-ts4.5/types/editor-command.d.ts

@@ -0,0 +1,5 @@
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export type EditorCommand = (props: {
+    tr: Transaction;
+}) => Transaction | null;
+export type EditorCommandWithMetadata = (args: any) => EditorCommand;

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

@@ -28,8 +28,8 @@ export type { EditorReactContext } from './editor-react-context';
 export type { PMPluginFactoryParams, PMPluginFactory, PMPlugin, } from './plugin-factory';
 export type { NodeConfig, MarkConfig, NodeViewConfig, } from './prosemirror-config';
 export type { PluginsOptions, EditorPlugin, getPosHandler, getPosHandlerNode, } from './editor-plugin';
-export type { NextEditorPlugin, AllEditorPresetPluginTypes, PluginDependenciesAPI, ExtractPluginNameFromAllBuilderPlugins, SafePresetCheck, DefaultEditorPlugin, OptionalPlugin, PluginInjectionAPI, CreatePluginDependenciesAPI, NextEditorPluginMetadata, ExtractInjectionAPI, ExtractPluginActions, PluginInjectionAPIWithDependency, PluginInjectionAPIWithDependencies, } from './next-editor-plugin';
-export type { PluginCommand, PluginCommandWithMetadata, } from './plugin-command';
+export type { NextEditorPlugin, AllEditorPresetPluginTypes, PluginDependenciesAPI, ExtractPluginNameFromAllBuilderPlugins, SafePresetCheck, DefaultEditorPlugin, OptionalPlugin, PluginInjectionAPI, CreatePluginDependenciesAPI, NextEditorPluginMetadata, ExtractInjectionAPI, ExtractPluginActions, PluginInjectionAPIWithDependency, PluginInjectionAPIWithDependencies, PublicPluginAPI, } from './next-editor-plugin';
+export type { EditorCommand, EditorCommandWithMetadata, } from './editor-command';
 export type IconProps = {
     label?: string;
 };

package/dist/types-ts4.5/types/next-editor-plugin.d.ts

@@ -5,8 +5,8 @@
  * are put together - but for now `Builder` & `Preset` aim to beinterchangeable.
  */
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { EditorCommand, EditorCommandWithMetadata } from './editor-command';
 import type { EditorPlugin } from './editor-plugin';
-import type { PluginCommand, PluginCommandWithMetadata } from './plugin-command';
 type IsAny<T> = 0 extends 1 & T ? true : false;
 type PickSharedStatePropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractSharedStateFromMetadata<Metadata> extends never ? never : 'getSharedState';
 type WithSharedState<Metadata extends NextEditorPluginMetadata> = {
@@ -25,13 +25,13 @@ export type DefaultEditorPlugin<Name extends string, Metadata extends NextEditor
 };
 type MaybeAction = ((...agrs: any) => any) | ((...agrs: any) => void);
 type NextEditorPluginActions = Record<string, MaybeAction>;
-type NextEditorPluginCommands = Record<string, PluginCommandWithMetadata | PluginCommand>;
+type NextEditorEditorCommands = Record<string, EditorCommandWithMetadata | EditorCommand>;
 export interface NextEditorPluginMetadata {
     readonly sharedState?: any;
     readonly pluginConfiguration?: any;
     readonly dependencies?: DependencyPlugin[];
     readonly actions?: NextEditorPluginActions;
-    readonly commands?: NextEditorPluginCommands;
+    readonly commands?: NextEditorEditorCommands;
 }
 export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorPluginMetadata> = {
     dependencies: CreatePluginDependenciesAPI<[
@@ -39,13 +39,13 @@ export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorP
         ...ExtractPluginDependenciesFromMetadata<Metadata>
     ]>;
     /**
-     * Dispatches a PluginCommand to ProseMirror
+     * Dispatches an EditorCommand to ProseMirror
      *
-     * @param action A function (PluginCommand | undefined) that takes a `Transaction` and returns a `Transaction` if it
+     * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
      * is successful or `null` if it shouldn't be dispatched.
      * @returns (boolean) if the command was successful in dispatching
      */
-    executeCommand: (action: PluginCommand | undefined) => boolean;
+    executeCommand: (command: EditorCommand | undefined) => boolean;
 };
 export type PluginInjectionAPIWithDependency<Plugin> = Plugin extends NextEditorPlugin<infer Name, infer Metadata> ? {
     dependencies: CreatePluginDependenciesAPI<[
@@ -135,4 +135,15 @@ export type ExtractPluginNameFromAllBuilderPlugins<Plugin extends AllEditorPrese
     ...any
 ] ? MaybePlugin extends NextEditorPlugin<any, any> ? ExtractPluginName<MaybePlugin> : never : never : Plugin extends NextEditorPlugin<any, any> ? ExtractPluginName<Plugin> : never;
 export type ExtractInjectionAPI<Plugin> = Plugin extends NextEditorPlugin<infer Name, infer Metadata> ? PluginInjectionAPI<Name, Metadata> : never;
+export type PublicPluginAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
+    dependencies: CreatePluginDependenciesAPI<PluginList>;
+    /**
+     * Dispatches an EditorCommand to ProseMirror
+     *
+     * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
+     * is successful or `null` if it shouldn't be dispatched.
+     * @returns (boolean) if the command was successful in dispatching
+     */
+    executeCommand: (command: EditorCommand | undefined) => boolean;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "74.45.5",
+  "version": "74.46.0",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/dist/types/types/plugin-command.d.ts

@@ -1,7 +0,0 @@
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-type PluginCommandProps = {
-    tr: Transaction;
-};
-export type PluginCommand = (props: PluginCommandProps) => Transaction | null;
-export type PluginCommandWithMetadata = (args: any) => PluginCommand;
-export {};

package/dist/types-ts4.5/types/plugin-command.d.ts

@@ -1,7 +0,0 @@
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-type PluginCommandProps = {
-    tr: Transaction;
-};
-export type PluginCommand = (props: PluginCommandProps) => Transaction | null;
-export type PluginCommandWithMetadata = (args: any) => PluginCommand;
-export {};