@atlaskit/editor-common 74.36.4 → 74.38.0

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

@@ -6,25 +6,32 @@
  */
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 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> = {
     [Property in keyof Pick<Metadata, 'sharedState'> as PickSharedStatePropertyName<Metadata>]: (editorState: EditorState | undefined) => ExtractSharedStateFromMetadata<Metadata>;
 };
 type PickActionsPropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractActionsFromMetadata<Metadata> extends never ? never : 'actions';
+type PickCommandsPropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractCommandsFromMetadata<Metadata> extends never ? never : 'commands';
 type WithActions<Metadata extends NextEditorPluginMetadata> = {
     [Property in keyof Pick<Metadata, 'actions'> as PickActionsPropertyName<Metadata>]: ExtractActionsFromMetadata<Metadata>;
 };
-export type DefaultEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata> = EditorPlugin & WithSharedState<Metadata> & WithActions<Metadata> & {
+type WithCommands<Metadata extends NextEditorPluginMetadata> = {
+    [Property in keyof Pick<Metadata, 'commands'> as PickCommandsPropertyName<Metadata>]: ExtractCommandsFromMetadata<Metadata>;
+};
+export type DefaultEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata> = EditorPlugin & WithSharedState<Metadata> & WithActions<Metadata> & WithCommands<Metadata> & {
     name: Name;
 };
 type MaybeAction = ((...agrs: any) => any) | ((...agrs: any) => void);
 type NextEditorPluginActions = Record<string, MaybeAction>;
+type NextEditorPluginCommands = Record<string, PluginCommandWithMetadata | PluginCommand>;
 export interface NextEditorPluginMetadata {
     readonly sharedState?: any;
     readonly pluginConfiguration?: any;
     readonly dependencies?: DependencyPlugin[];
     readonly actions?: NextEditorPluginActions;
+    readonly commands?: NextEditorPluginCommands;
 }
 export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorPluginMetadata> = {
     dependencies: CreatePluginDependenciesAPI<[
@@ -56,6 +63,7 @@ type ExtractPluginDependenciesFromMetadataWithoutOptionals<Metadata extends Next
 type ExtractPluginDependenciesFromMetadata<Metadata> = 'dependencies' extends keyof Metadata ? Metadata['dependencies'] extends DependencyPlugin[] ? Exclude<Metadata['dependencies'], undefined> : [] : [];
 type ExtractSharedStateFromMetadata<Metadata> = 'sharedState' extends keyof Metadata ? Metadata['sharedState'] : never;
 type ExtractActionsFromMetadata<Metadata> = 'actions' extends keyof Metadata ? Metadata['actions'] : never;
+type ExtractCommandsFromMetadata<Metadata> = 'commands' extends keyof Metadata ? Metadata['commands'] : never;
 type ExtractPluginConfigurationFromMetadata<Metadata> = 'pluginConfiguration' extends keyof Metadata ? Metadata['pluginConfiguration'] : never;
 export type ExtractPluginDependencies<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginDependenciesFromMetadataWithoutOptionals<Metadata> : never : never;
 type ExtractPluginConfiguration<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginConfigurationFromMetadata<Metadata> : never : never;
@@ -72,6 +80,7 @@ export type PluginDependenciesAPI<Plugin extends NextEditorPlugin<any, any>> = {
         }) => void) => Unsubscribe;
     };
     actions: ExtractPluginActions<Plugin>;
+    commands: Plugin extends NextEditorPlugin<any, infer Metadata> ? ExtractCommandsFromMetadata<Metadata> : never;
 };
 export type CreatePluginDependenciesAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
     [Plugin in PluginList[number] as `${ExtractPluginName<Plugin>}`]: Plugin extends OptionalPlugin<NextEditorPlugin<any, any>> ? PluginDependenciesAPI<Plugin> | undefined : Plugin extends NextEditorPlugin<any, any> ? PluginDependenciesAPI<Plugin> : never;

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

@@ -0,0 +1,7 @@
+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/types/selection.d.ts

@@ -0,0 +1,3 @@
+export interface LongPressSelectionPluginOptions {
+    useLongPressSelection?: boolean;
+}

package/dist/types/ui/MediaSingle/styled.d.ts

@@ -1,7 +1,8 @@
 /** @jsx jsx */
-import React, { RefObject } from 'react';
+import type { RefObject } from 'react';
+import React from 'react';
 import { jsx } from '@emotion/react';
-import { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
+import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
 /**
  * Calculates the image width for non-resized images.
  *

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

@@ -1,6 +1,8 @@
+import type { ReactElement } from 'react';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { Providers } from '../provider-factory';
 export type NewCollabSyncUpErrorAttributes = {
     lengthOfUnconfirmedSteps?: number;
     tries: number;
@@ -348,4 +350,27 @@ export interface CollabEditProvider<Events extends CollabEvents = CollabEvents>
     } & Events[K]): void;
     getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
 }
+export type CollabEditOptions = {
+    provider?: Providers['collabEditProvider'];
+    userId?: string;
+    useNativePlugin?: boolean;
+} & CollabInviteToEditProps & CollabAnalyticsProps;
+export type InviteToEditButtonProps = {
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    selected: boolean;
+};
+export type InviteToEditComponentProps = {
+    children: ReactElement<InviteToEditButtonProps>;
+};
+export interface CollabInviteToEditProps {
+    inviteToEditHandler?: (event: React.MouseEvent<HTMLElement>) => void;
+    isInviteToEditButtonSelected?: boolean;
+    inviteToEditComponent?: React.ComponentType<InviteToEditComponentProps>;
+}
+export interface CollabAnalyticsProps {
+    /**
+     * @description Control wether Synchrony entity error events are tracked
+     */
+    EXPERIMENTAL_allowInternalErrorAnalytics?: boolean;
+}
 export {};

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

@@ -1 +1,2 @@
 export declare const MEDIA_DYNAMIC_GUIDELINE_PREFIX = "media_";
+export declare const INNER_GRID_GUIDELINE_PREFIX = "grid_";

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

@@ -1,4 +1,4 @@
-import { EditorState } from '@atlaskit/editor-prosemirror/state';
+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?: {

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

@@ -2,7 +2,7 @@ export { generateDynamicGuidelines } from './dynamicGuideline';
 export { createFixedGuidelinesFromLengths, createGuidesFromLengths, } from './fixedGuideline';
 export { generateDefaultGuidelines } from './defaultGuideline';
 export { getGuidelinesWithHighlights } from './updateGuideline';
-export { MEDIA_DYNAMIC_GUIDELINE_PREFIX } from './constants';
-export type { WidthTypes, Position, GuidelineConfig, GuidelinePluginState, GuidelinePluginOptions, DisplayGuideline, DisplayGrid, VerticalPosition, HorizontalPosition, } from './types';
-export { getSnapWidth, findClosestSnap } from './snapping';
+export { MEDIA_DYNAMIC_GUIDELINE_PREFIX, INNER_GRID_GUIDELINE_PREFIX, } from './constants';
+export type { WidthTypes, Position, GuidelineConfig, GuidelinePluginState, GuidelinePluginOptions, DisplayGuideline, DisplayGrid, VerticalPosition, HorizontalPosition, GuidelineSnap, GuidelineSnapsReference, } from './types';
+export { getGuidelineSnaps, findClosestSnap } from './snapping';
 export { isVerticalPosition, getContainerWidthOrFullEditorWidth, } from './utils';

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

@@ -1,18 +1,19 @@
-import { RichMediaLayout } from '@atlaskit/adf-schema';
-import type { GuidelineConfig } from './types';
-export type SnapTo = {
-    guidelineKey: string;
-    width: number;
-};
+import type { RichMediaLayout } from '@atlaskit/adf-schema';
+import type { GuidelineConfig, GuidelineSnap } from './types';
 /**
  * Returns keys of guidelines that are closest to the image and withthin the snapGap.
  * If both default and dynamic guidelines present, only returns default guidelines
  */
-export declare const findClosestSnap: (mediaSingleWidth: number, snapArray: number[], snapTo: SnapTo[], snapGap?: number) => {
+export declare const findClosestSnap: (mediaSingleWidth: number, snapArray: number[], guidelineSnaps: GuidelineSnap[], snapGap?: number) => {
     gap: number;
     keys: string[];
 };
-/**
- * Get snapping widths and respective guideline keys
- */
-export declare const getSnapWidth: (guidelines: GuidelineConfig[], mediaSingleWidth: number, snap: number, layout: RichMediaLayout | null) => SnapTo[];
+export declare const getGuidelineSnaps: import("memoize-one").MemoizedFn<(guidelines: GuidelineConfig[], editorWidth: number, layout?: RichMediaLayout) => {
+    guidelineReference: {
+        guidelineKey: string;
+        width: number;
+    }[];
+    snaps: {
+        x: number[] | undefined;
+    };
+}>;

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

@@ -1,5 +1,5 @@
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
-import { CSSToken } from '@atlaskit/tokens';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { CSSToken } from '@atlaskit/tokens';
 export declare enum WidthTypes {
     PERCENTAGE = "percentage",
     PIXEL = "pixel"
@@ -40,3 +40,14 @@ export interface GuidelinePluginOptions {
 }
 export type DisplayGrid = (props: Required<GuidelinePluginState>) => boolean;
 export type DisplayGuideline = (view: EditorView) => DisplayGrid;
+export type GuidelineSnap = {
+    guidelineKey: string;
+    width: number;
+};
+export type GuidelineSnapsReference = {
+    snaps: {
+        x?: number[];
+        y?: number[];
+    };
+    guidelineReference: GuidelineSnap[];
+};

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

@@ -2,6 +2,7 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { Command } from '../types/command';
+import type { PluginCommand } from '../types/plugin-command';
 export declare const addAltText: Keymap;
 export declare const navToEditorToolbar: Keymap;
 export declare const navToFloatingToolbar: Keymap;
@@ -85,7 +86,10 @@ export interface Keymap {
     common?: string;
 }
 export declare function bindKeymapWithCommand(shortcut: string, cmd: Command, keymap: {
-    [key: string]: Function;
+    [key: string]: Command;
+}): void;
+export declare function bindKeymapWithPluginCommand(shortcut: string, cmd: PluginCommand, keymap: {
+    [key: string]: Command;
 }): void;
 export declare function findKeyMapForBrowser(keyMap: Keymap): string | undefined;
 export { DOWN, HEADING_KEYS, KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6, LEFT, RIGHT, UP, } from './consts';

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

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

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

@@ -0,0 +1,3 @@
+import type { Command } from '../types/command';
+import type { PluginCommand } from '../types/plugin-command';
+export declare function pluginCommandToPMCommand(command: PluginCommand | undefined): Command;

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

@@ -32,6 +32,7 @@ interface PluginInjectionAPIDefinition {
 export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefinition {
     private sharedStateAPI;
     private actionsAPI;
+    private commandsAPI;
     private plugins;
     constructor({ getEditorState }: SharedStateAPIProps);
     api<T extends NextEditorPlugin<any, any>>(): {

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

@@ -1,4 +1,4 @@
-import { Node } from '@atlaskit/editor-prosemirror/model';
+import type { Node } from '@atlaskit/editor-prosemirror/model';
 export interface Transformer<T> {
     encode(node: Node): T;
     parse(content: T): Node;
@@ -29,6 +29,7 @@ export type { PMPluginFactoryParams, PMPluginFactory, PMPlugin, } from './plugin
 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 IconProps = {
     label?: string;
 };
@@ -43,3 +44,5 @@ export type { AllowedBlockTypes, HeadingLevels, NormalTextLevel, HeadingLevelsAn
 export type { ColumnResizingPluginState } from './tables';
 export type { InputRuleHandler, OnHandlerApply, InputRuleWrapper, } from './input-rules';
 export type { TextFormattingOptions, TextFormattingState, InputMethodToolbar, InputMethodBasic, } from './text-formatting';
+export type { LayoutPluginOptions } from './layout';
+export type { LongPressSelectionPluginOptions } from './selection';

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

@@ -0,0 +1,6 @@
+import type { LongPressSelectionPluginOptions } from './selection';
+export interface LayoutPluginOptions extends LongPressSelectionPluginOptions {
+    allowBreakout?: boolean;
+    UNSAFE_addSidebarLayouts?: boolean;
+    UNSAFE_allowSingleColumnLayout?: boolean;
+}

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

@@ -6,25 +6,32 @@
  */
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 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> = {
     [Property in keyof Pick<Metadata, 'sharedState'> as PickSharedStatePropertyName<Metadata>]: (editorState: EditorState | undefined) => ExtractSharedStateFromMetadata<Metadata>;
 };
 type PickActionsPropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractActionsFromMetadata<Metadata> extends never ? never : 'actions';
+type PickCommandsPropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractCommandsFromMetadata<Metadata> extends never ? never : 'commands';
 type WithActions<Metadata extends NextEditorPluginMetadata> = {
     [Property in keyof Pick<Metadata, 'actions'> as PickActionsPropertyName<Metadata>]: ExtractActionsFromMetadata<Metadata>;
 };
-export type DefaultEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata> = EditorPlugin & WithSharedState<Metadata> & WithActions<Metadata> & {
+type WithCommands<Metadata extends NextEditorPluginMetadata> = {
+    [Property in keyof Pick<Metadata, 'commands'> as PickCommandsPropertyName<Metadata>]: ExtractCommandsFromMetadata<Metadata>;
+};
+export type DefaultEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata> = EditorPlugin & WithSharedState<Metadata> & WithActions<Metadata> & WithCommands<Metadata> & {
     name: Name;
 };
 type MaybeAction = ((...agrs: any) => any) | ((...agrs: any) => void);
 type NextEditorPluginActions = Record<string, MaybeAction>;
+type NextEditorPluginCommands = Record<string, PluginCommandWithMetadata | PluginCommand>;
 export interface NextEditorPluginMetadata {
     readonly sharedState?: any;
     readonly pluginConfiguration?: any;
     readonly dependencies?: DependencyPlugin[];
     readonly actions?: NextEditorPluginActions;
+    readonly commands?: NextEditorPluginCommands;
 }
 export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorPluginMetadata> = {
     dependencies: CreatePluginDependenciesAPI<[
@@ -62,6 +69,7 @@ type ExtractPluginDependenciesFromMetadata<Metadata> = 'dependencies' extends ke
 ];
 type ExtractSharedStateFromMetadata<Metadata> = 'sharedState' extends keyof Metadata ? Metadata['sharedState'] : never;
 type ExtractActionsFromMetadata<Metadata> = 'actions' extends keyof Metadata ? Metadata['actions'] : never;
+type ExtractCommandsFromMetadata<Metadata> = 'commands' extends keyof Metadata ? Metadata['commands'] : never;
 type ExtractPluginConfigurationFromMetadata<Metadata> = 'pluginConfiguration' extends keyof Metadata ? Metadata['pluginConfiguration'] : never;
 export type ExtractPluginDependencies<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginDependenciesFromMetadataWithoutOptionals<Metadata> : never : never;
 type ExtractPluginConfiguration<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginConfigurationFromMetadata<Metadata> : never : never;
@@ -78,6 +86,7 @@ export type PluginDependenciesAPI<Plugin extends NextEditorPlugin<any, any>> = {
         }) => void) => Unsubscribe;
     };
     actions: ExtractPluginActions<Plugin>;
+    commands: Plugin extends NextEditorPlugin<any, infer Metadata> ? ExtractCommandsFromMetadata<Metadata> : never;
 };
 export type CreatePluginDependenciesAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
     [Plugin in PluginList[number] as `${ExtractPluginName<Plugin>}`]: Plugin extends OptionalPlugin<NextEditorPlugin<any, any>> ? PluginDependenciesAPI<Plugin> | undefined : Plugin extends NextEditorPlugin<any, any> ? PluginDependenciesAPI<Plugin> : never;

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

@@ -0,0 +1,7 @@
+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/selection.d.ts

@@ -0,0 +1,3 @@
+export interface LongPressSelectionPluginOptions {
+    useLongPressSelection?: boolean;
+}

package/dist/types-ts4.5/ui/MediaSingle/styled.d.ts

@@ -1,7 +1,8 @@
 /** @jsx jsx */
-import React, { RefObject } from 'react';
+import type { RefObject } from 'react';
+import React from 'react';
 import { jsx } from '@emotion/react';
-import { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
+import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
 /**
  * Calculates the image width for non-resized images.
  *

package/package.json

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