@atlaskit/editor-common 74.45.5 → 74.46.1

package/dist/types/guideline/dynamicGuideline.d.ts

@@ -1,27 +1,6 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { GuidelineConfig } from './types';
-export declare const generateDynamicGuidelines: (state: EditorState, editorWidth: number, styles?: Omit<GuidelineConfig, 'key' | 'position'>) => ({
-    styles?: {
-        capStyle?: "line" | undefined;
-        lineStyle?: "dashed" | "solid" | undefined;
-        color?: import("@atlaskit/tokens").CSSToken | undefined;
-    } | undefined;
-    show?: boolean | undefined;
-    active?: boolean | undefined;
-    position: {
-        x: number;
-    };
-    key: string;
-} | {
-    styles?: {
-        capStyle?: "line" | undefined;
-        lineStyle?: "dashed" | "solid" | undefined;
-        color?: import("@atlaskit/tokens").CSSToken | undefined;
-    } | undefined;
-    show?: boolean | undefined;
-    active?: boolean | undefined;
-    position: {
-        x: number;
-    };
-    key: string;
-})[];
+import type { GuidelineConfig, GuidelineStyles, RelativeGuides } from './types';
+export declare const generateDynamicGuidelines: (state: EditorState, editorWidth: number, styles?: GuidelineStyles) => {
+    dynamicGuides: GuidelineConfig[];
+    relativeGuides: RelativeGuides;
+};

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

@@ -3,6 +3,7 @@ export { createFixedGuidelinesFromLengths, createGuidesFromLengths, } from './fi
 export { generateDefaultGuidelines } from './defaultGuideline';
 export { getGuidelinesWithHighlights } from './updateGuideline';
 export { MEDIA_DYNAMIC_GUIDELINE_PREFIX, INNER_GRID_GUIDELINE_PREFIX, } from './constants';
-export type { WidthTypes, Position, GuidelineConfig, GuidelinePluginState, GuidelinePluginOptions, DisplayGuideline, DisplayGrid, VerticalPosition, HorizontalPosition, GuidelineSnap, GuidelineSnapsReference, GuidelineTypes, } from './types';
+export type { WidthTypes, Position, GuidelineStyles, GuidelineConfig, GuidelinePluginState, GuidelinePluginOptions, DisplayGuideline, DisplayGrid, VerticalPosition, HorizontalPosition, RelativeGuides, GuidelineSnap, GuidelineSnapsReference, GuidelineTypes, } from './types';
 export { getGuidelineSnaps, findClosestSnap } from './snapping';
-export { isVerticalPosition, getContainerWidthOrFullEditorWidth, getGuidelineTypeFromKey, } from './utils';
+export { isVerticalPosition, getMediaSingleDimensions, getContainerWidthOrFullEditorWidth, getGuidelineTypeFromKey, } from './utils';
+export { getRelativeGuideSnaps, getRelativeGuidelines, } from './relativeGuideline';

package/dist/types/guideline/relativeGuideline.d.ts

@@ -0,0 +1,8 @@
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { GuidelineConfig, RelativeGuides } from './types';
+export declare const getRelativeGuideSnaps: (relativeGuides: RelativeGuides, aspectRatio: number) => number[];
+export declare const getRelativeGuidelines: (relativeGuides: RelativeGuides, nodeWithPos: NodeWithPos, view: EditorView, editorWidth: number, size: {
+    width: number;
+    height: number;
+}) => GuidelineConfig[];

package/dist/types/guideline/types.d.ts

@@ -1,3 +1,4 @@
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { CSSToken } from '@atlaskit/tokens';
 export type WidthTypes = 'percentage' | 'pixel';
@@ -19,9 +20,7 @@ export type HorizontalPosition = {
     y: number;
 };
 export type Position = VerticalPosition | HorizontalPosition;
-export type GuidelineConfig = {
-    key: string;
-    position: Position;
+export type GuidelineStyles = {
     active?: boolean;
     show?: boolean;
     styles?: {
@@ -30,6 +29,10 @@ export type GuidelineConfig = {
         color?: CSSToken;
     };
 };
+export type GuidelineConfig = {
+    key: string;
+    position: Position;
+} & GuidelineStyles;
 export type GuidelinePluginState = {
     guidelines: GuidelineConfig[];
 };
@@ -49,3 +52,11 @@ export type GuidelineSnapsReference = {
     guidelineReference: GuidelineSnap[];
 };
 export type GuidelineTypes = 'default' | 'temporary' | 'relative' | 'none';
+export type RelativeGuides = {
+    width?: {
+        [key: number]: NodeWithPos[];
+    };
+    height?: {
+        [key: number]: NodeWithPos[];
+    };
+};

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/guideline/dynamicGuideline.d.ts

@@ -1,27 +1,6 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { GuidelineConfig } from './types';
-export declare const generateDynamicGuidelines: (state: EditorState, editorWidth: number, styles?: Omit<GuidelineConfig, 'key' | 'position'>) => ({
-    styles?: {
-        capStyle?: "line" | undefined;
-        lineStyle?: "dashed" | "solid" | undefined;
-        color?: import("@atlaskit/tokens").CSSToken | undefined;
-    } | undefined;
-    show?: boolean | undefined;
-    active?: boolean | undefined;
-    position: {
-        x: number;
-    };
-    key: string;
-} | {
-    styles?: {
-        capStyle?: "line" | undefined;
-        lineStyle?: "dashed" | "solid" | undefined;
-        color?: import("@atlaskit/tokens").CSSToken | undefined;
-    } | undefined;
-    show?: boolean | undefined;
-    active?: boolean | undefined;
-    position: {
-        x: number;
-    };
-    key: string;
-})[];
+import type { GuidelineConfig, GuidelineStyles, RelativeGuides } from './types';
+export declare const generateDynamicGuidelines: (state: EditorState, editorWidth: number, styles?: GuidelineStyles) => {
+    dynamicGuides: GuidelineConfig[];
+    relativeGuides: RelativeGuides;
+};

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

@@ -3,6 +3,7 @@ export { createFixedGuidelinesFromLengths, createGuidesFromLengths, } from './fi
 export { generateDefaultGuidelines } from './defaultGuideline';
 export { getGuidelinesWithHighlights } from './updateGuideline';
 export { MEDIA_DYNAMIC_GUIDELINE_PREFIX, INNER_GRID_GUIDELINE_PREFIX, } from './constants';
-export type { WidthTypes, Position, GuidelineConfig, GuidelinePluginState, GuidelinePluginOptions, DisplayGuideline, DisplayGrid, VerticalPosition, HorizontalPosition, GuidelineSnap, GuidelineSnapsReference, GuidelineTypes, } from './types';
+export type { WidthTypes, Position, GuidelineStyles, GuidelineConfig, GuidelinePluginState, GuidelinePluginOptions, DisplayGuideline, DisplayGrid, VerticalPosition, HorizontalPosition, RelativeGuides, GuidelineSnap, GuidelineSnapsReference, GuidelineTypes, } from './types';
 export { getGuidelineSnaps, findClosestSnap } from './snapping';
-export { isVerticalPosition, getContainerWidthOrFullEditorWidth, getGuidelineTypeFromKey, } from './utils';
+export { isVerticalPosition, getMediaSingleDimensions, getContainerWidthOrFullEditorWidth, getGuidelineTypeFromKey, } from './utils';
+export { getRelativeGuideSnaps, getRelativeGuidelines, } from './relativeGuideline';

package/dist/types-ts4.5/guideline/relativeGuideline.d.ts

@@ -0,0 +1,8 @@
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { GuidelineConfig, RelativeGuides } from './types';
+export declare const getRelativeGuideSnaps: (relativeGuides: RelativeGuides, aspectRatio: number) => number[];
+export declare const getRelativeGuidelines: (relativeGuides: RelativeGuides, nodeWithPos: NodeWithPos, view: EditorView, editorWidth: number, size: {
+    width: number;
+    height: number;
+}) => GuidelineConfig[];

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

@@ -1,3 +1,4 @@
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { CSSToken } from '@atlaskit/tokens';
 export type WidthTypes = 'percentage' | 'pixel';
@@ -19,9 +20,7 @@ export type HorizontalPosition = {
     y: number;
 };
 export type Position = VerticalPosition | HorizontalPosition;
-export type GuidelineConfig = {
-    key: string;
-    position: Position;
+export type GuidelineStyles = {
     active?: boolean;
     show?: boolean;
     styles?: {
@@ -30,6 +29,10 @@ export type GuidelineConfig = {
         color?: CSSToken;
     };
 };
+export type GuidelineConfig = {
+    key: string;
+    position: Position;
+} & GuidelineStyles;
 export type GuidelinePluginState = {
     guidelines: GuidelineConfig[];
 };
@@ -49,3 +52,11 @@ export type GuidelineSnapsReference = {
     guidelineReference: GuidelineSnap[];
 };
 export type GuidelineTypes = 'default' | 'temporary' | 'relative' | 'none';
+export type RelativeGuides = {
+    width?: {
+        [key: number]: NodeWithPos[];
+    };
+    height?: {
+        [key: number]: NodeWithPos[];
+    };
+};

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.1",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

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 {};