@atlaskit/editor-core 175.0.5 → 176.0.0

package/report.api.md

@@ -1,12 +1,17 @@
+<!-- API Report Version: 2.2 -->
+
 ## API Report File for "@atlaskit/editor-core"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
 
-<!--
-	Generated API Report version: 2.0
--->
+- [Main Entry Types](#main-entry-types)
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 /// <reference types="cypress" />
@@ -119,6 +124,7 @@ import { Schema } from 'prosemirror-model';
 import type { SearchProvider } from '@atlaskit/editor-common/provider-factory';
 import { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
 import type { SelectOption } from '@atlaskit/editor-common/types';
+import { setTextSelection } from '@atlaskit/editor-common/utils';
 import { SEVERITY } from '@atlaskit/editor-common/utils';
 import { TaskDecisionProvider } from '@atlaskit/task-decision';
 import { TeamMentionProvider } from '@atlaskit/mention/resource';
@@ -159,7 +165,7 @@ type AddItemTransactionCreator = (opts: {
 }) => Transaction | null;
 
 // @public (undocumented)
-type AllowedBlockTypes = 'heading' | 'blockquote' | 'hardBreak' | 'codeBlock';
+type AllowedBlockTypes = 'blockquote' | 'codeBlock' | 'hardBreak' | 'heading';
 
 // @public (undocumented)
 interface AllSelectionData {
@@ -236,7 +242,7 @@ interface BasePluginOptions {
 type BasePortalProviderProps = {
   render: (
     portalProviderAPI: PortalProviderAPI,
-  ) => React_2.ReactChild | JSX.Element | null;
+  ) => JSX.Element | React_2.ReactChild | null;
   onAnalyticsEvent?: FireAnalyticsCallback;
   useAnalyticsContext?: boolean;
   themeMode?: ThemeModes;
@@ -271,7 +277,7 @@ export class BaseReactEditorView<T = {}> extends React_2.Component<
   createEditorState: (options: {
     props: EditorViewProps;
     context: EditorReactContext;
-    doc?: string | Object | Node_2<any> | undefined;
+    doc?: Object | Node_2<any> | string | undefined;
     resetting?: boolean | undefined;
     selectionAtStart?: boolean | undefined;
   }) => EditorState<any>;
@@ -358,11 +364,11 @@ interface BlockType {
 
 // @public (undocumented)
 export type BlockTypeInputMethod =
-  | INPUT_METHOD.TOOLBAR
+  | INPUT_METHOD.FORMATTING
   | INPUT_METHOD.INSERT_MENU
+  | INPUT_METHOD.KEYBOARD
   | INPUT_METHOD.SHORTCUT
-  | INPUT_METHOD.FORMATTING
-  | INPUT_METHOD.KEYBOARD;
+  | INPUT_METHOD.TOOLBAR;
 
 // @public (undocumented)
 interface BlockTypePluginOptions {
@@ -619,7 +625,7 @@ export const datePluginKey: PluginKey<DatePluginState, any>;
 export type DatePluginState = {
   isQuickInsertAction?: boolean;
   isNew: boolean;
-  showDatePickerAt: number | null;
+  showDatePickerAt: null | number;
   isDateEmpty: boolean;
   focusDateInput: boolean;
 };
@@ -635,7 +641,7 @@ type DateType = {
 };
 
 // @public (undocumented)
-export function dedupe<T>(list?: T[], iteratee?: (p: T) => T[keyof T] | T): T[];
+export function dedupe<T>(list?: T[], iteratee?: (p: T) => T | T[keyof T]): T[];
 
 export { DEFAULT_BORDER_COLOR };
 
@@ -730,14 +736,14 @@ export class Editor extends React_2.Component<EditorProps, State> {
     props: EditorProps,
   ): EditorActions<any> & {
     _contentRetrievalTracking?:
+      | undefined
       | {
           getValueTracked: boolean;
           samplingCounters: {
             success: number;
             failure: number;
           };
-        }
-      | undefined;
+        };
   };
 }
 
@@ -768,7 +774,7 @@ export class EditorActions<T = any> implements EditorActionsOptions<T> {
   getResolvedEditorState: () => Promise<ResolvedEditorState | undefined>;
   getSelectedNode(): Node_2 | undefined;
   // (undocumented)
-  getValue(): Promise<JSONDocNode | T | undefined>;
+  getValue(): Promise<T | JSONDocNode | undefined>;
   // (undocumented)
   isDocumentEmpty(): boolean;
   // (undocumented)
@@ -887,7 +893,7 @@ interface EditorPresetProps {
 }
 
 // @public (undocumented)
-type EditorProduct = 'bitbucket' | 'jira' | 'confluence' | 'stride' | undefined;
+type EditorProduct = 'bitbucket' | 'confluence' | 'jira' | 'stride' | undefined;
 
 // @public (undocumented)
 export interface EditorProps {
@@ -911,9 +917,9 @@ export interface EditorProps {
         allowInteractiveExpand?: boolean;
       };
   // (undocumented)
-  allowExtension?: boolean | ExtensionConfig;
+  allowExtension?: ExtensionConfig | boolean;
   // (undocumented)
-  allowFindReplace?: boolean | FindReplaceOptions;
+  allowFindReplace?: FindReplaceOptions | boolean;
   allowFragmentMark?: boolean;
   // (undocumented)
   allowHelpDialog?: boolean;
@@ -924,12 +930,12 @@ export interface EditorProps {
   // (undocumented)
   allowKeyboardAccessibleDatepicker?: boolean;
   // (undocumented)
-  allowLayouts?: boolean | LayoutPluginOptions;
+  allowLayouts?: LayoutPluginOptions | boolean;
   // (undocumented)
   allowNestedTasks?: boolean;
   allowNewInsertionBehaviour?: boolean;
   // (undocumented)
-  allowPanel?: boolean | PanelPluginConfig;
+  allowPanel?: PanelPluginConfig | boolean;
   // (undocumented)
   allowRule?: boolean;
   // (undocumented)
@@ -939,15 +945,15 @@ export interface EditorProps {
         menuDisabled: boolean;
       };
   // (undocumented)
-  allowTables?: boolean | PluginConfig;
+  allowTables?: PluginConfig | boolean;
   // (undocumented)
   allowTasksAndDecisions?: boolean;
   // (undocumented)
-  allowTemplatePlaceholders?: boolean | PlaceholderTextOptions;
+  allowTemplatePlaceholders?: PlaceholderTextOptions | boolean;
   // (undocumented)
   allowTextAlignment?: boolean;
   // (undocumented)
-  allowTextColor?: boolean | TextColorPluginConfig;
+  allowTextColor?: TextColorPluginConfig | boolean;
   // (undocumented)
   allowUndoRedoButtons?: boolean;
   // (undocumented)
@@ -976,7 +982,7 @@ export interface EditorProps {
     __plugins: EditorPlugin[];
   };
   // (undocumented)
-  defaultValue?: Node_2 | string | Object;
+  defaultValue?: Node_2 | Object | string;
   // (undocumented)
   disabled?: boolean;
   // (undocumented)
@@ -997,7 +1003,7 @@ export interface EditorProps {
   // (undocumented)
   extensionProviders?: ExtensionProvidersProp;
   featureFlags?: {
-    [featureFlag: string]: string | boolean;
+    [featureFlag: string]: boolean | string;
   };
   // (undocumented)
   feedbackInfo?: FeedbackInfo;
@@ -1074,17 +1080,17 @@ export interface EditorProps {
   // (undocumented)
   textFormatting?: TextFormattingOptions;
   trackValidTransactions?:
+    | boolean
     | {
         samplingRate: number;
-      }
-    | boolean;
+      };
   // @deprecated (undocumented)
   UNSAFE_cards?: CardOptions;
   // (undocumented)
   UNSAFE_useAnalyticsContext?: boolean;
   // (undocumented)
   uploadErrorHandler?: (state: MediaState) => void;
-  useStickyToolbar?: boolean | RefObject<HTMLElement>;
+  useStickyToolbar?: RefObject<HTMLElement> | boolean;
   // (undocumented)
   waitForMediaUpload?: boolean;
 }
@@ -1094,7 +1100,7 @@ type EditorProps_2 = {
   plugins?: Array<EditorPlugin>;
   transformer?: (schema: Schema) => Transformer_2<any>;
   children?: React.ReactChild;
-  defaultValue?: string | object;
+  defaultValue?: object | string;
   popupsMountPoint?: HTMLElement;
   popupsBoundariesElement?: HTMLElement;
   popupsScrollableElement?: HTMLElement;
@@ -1104,7 +1110,7 @@ type EditorProps_2 = {
   onChange?: (
     value: any,
     meta: {
-      source: 'remote' | 'local';
+      source: 'local' | 'remote';
     },
   ) => void;
   onSave?: (value: any) => void;
@@ -1184,8 +1190,6 @@ interface ExtensionConfig {
   allowBreakout?: boolean;
   // (undocumented)
   allowExtendFloatingToolbars?: boolean;
-  // (undocumented)
-  stickToolbarToBottom?: boolean;
 }
 
 // @public (undocumented)
@@ -1222,7 +1226,7 @@ type FindReplaceOptions = {
 // @public (undocumented)
 type FireAnalyticsCallback = <T>(
   payload: FireAnalyticsEventPayload<T>,
-) => void | undefined;
+) => undefined | void;
 
 // @public (undocumented)
 type FireAnalyticsEventPayload<T = void> = {
@@ -1292,7 +1296,7 @@ export const getListCommands: () => {
 export function getNodesCount(node: Node_2): Record<string, number>;
 
 // @public (undocumented)
-type getPosHandler = getPosHandlerNode | boolean;
+type getPosHandler = boolean | getPosHandlerNode;
 
 // @public (undocumented)
 type getPosHandlerNode = () => number;
@@ -1408,8 +1412,8 @@ interface InputTracking {
 
 // @public (undocumented)
 export type InsertBlockInputMethodToolbar =
-  | INPUT_METHOD.TOOLBAR
-  | INPUT_METHOD.INSERT_MENU;
+  | INPUT_METHOD.INSERT_MENU
+  | INPUT_METHOD.TOOLBAR;
 
 // @public (undocumented)
 export function insertBlockType(name: string): Command;
@@ -1434,11 +1438,11 @@ export const insertExpand: Command;
 // @public (undocumented)
 export const insertHorizontalRule: (
   inputMethod:
-    | INPUT_METHOD.QUICK_INSERT
-    | INPUT_METHOD.TOOLBAR
-    | INPUT_METHOD.INSERT_MENU
     | INPUT_METHOD.FORMATTING
-    | INPUT_METHOD.SHORTCUT,
+    | INPUT_METHOD.INSERT_MENU
+    | INPUT_METHOD.QUICK_INSERT
+    | INPUT_METHOD.SHORTCUT
+    | INPUT_METHOD.TOOLBAR,
 ) => Command;
 
 // @public (undocumented)
@@ -1552,7 +1556,7 @@ export type LinkInputMethod = INPUT_METHOD.MANUAL | INPUT_METHOD.TYPEAHEAD;
 interface LinkPickerOptions extends Partial<LinkPickerProps> {}
 
 // @public (undocumented)
-type LinkToolbarState = EditState | EditInsertedState | InsertState | undefined;
+type LinkToolbarState = EditInsertedState | EditState | InsertState | undefined;
 
 // @public (undocumented)
 type Listener = (data: any) => void;
@@ -1639,7 +1643,7 @@ export interface MediaOptions {
   // (undocumented)
   allowMediaGroup?: boolean;
   // (undocumented)
-  allowMediaSingle?: boolean | MediaSingleOptions;
+  allowMediaSingle?: MediaSingleOptions | boolean;
   // (undocumented)
   allowMediaSingleEditable?: boolean;
   // (undocumented)
@@ -1649,7 +1653,7 @@ export interface MediaOptions {
   // (undocumented)
   allowResizingInTables?: boolean;
   // (undocumented)
-  allowTemplatePlaceholders?: boolean | PlaceholderTextOptions;
+  allowTemplatePlaceholders?: PlaceholderTextOptions | boolean;
   // (undocumented)
   altTextValidator?: (value: string) => string[];
   // (undocumented)
@@ -1794,7 +1798,7 @@ interface MediaPluginState {
   // (undocumented)
   updateAndDispatch(
     props: Partial<
-      Pick<this, 'allowsUploads' | 'allUploadsFinished' | 'isFullscreen'>
+      Pick<this, 'allUploadsFinished' | 'allowsUploads' | 'isFullscreen'>
     >,
   ): void;
   // (undocumented)
@@ -1804,7 +1808,7 @@ interface MediaPluginState {
     id: string,
     attrs: object,
     isMediaSingle: boolean,
-  ) => undefined | boolean;
+  ) => boolean | undefined;
   // (undocumented)
   uploadMediaClientConfig?: MediaClientConfig;
   // (undocumented)
@@ -1866,12 +1870,12 @@ type MediaStateEventSubscriber = (listener: MediaStateEventListener) => void;
 
 // @public (undocumented)
 type MediaStateStatus =
-  | 'unknown'
-  | 'ready'
   | 'cancelled'
-  | 'preview'
   | 'error'
-  | 'mobile-upload-end';
+  | 'mobile-upload-end'
+  | 'preview'
+  | 'ready'
+  | 'unknown';
 
 // @public (undocumented)
 interface MentionPluginConfig {
@@ -1987,7 +1991,6 @@ interface PanelPluginConfig {
 
 // @public (undocumented)
 type PastePluginOptions = {
-  plainTextPasteLinkification?: boolean;
   cardOptions?: CardOptions;
   sanitizePrivateContent?: boolean;
 };
@@ -2060,7 +2063,7 @@ type PickerFacadeConfig = {
 };
 
 // @public (undocumented)
-type PickerType = 'clipboard' | 'dropzone' | 'customMediaPicker';
+type PickerType = 'clipboard' | 'customMediaPicker' | 'dropzone';
 
 // @public (undocumented)
 interface PlaceholderPluginOptions {
@@ -2113,7 +2116,7 @@ export class PortalProviderAPI extends EventDispatcher {
   remove(container: HTMLElement): void;
   // (undocumented)
   render(
-    children: () => React_2.ReactChild | JSX.Element | null,
+    children: () => JSX.Element | React_2.ReactChild | null,
     container: HTMLElement,
     hasAnalyticsContext?: boolean,
     hasIntlContext?: boolean,
@@ -2237,8 +2240,8 @@ export { QuickInsertActionInsert };
 
 // @public (undocumented)
 type QuickInsertHandler =
-  | Array<QuickInsertItem>
-  | ((intl: IntlShape) => Array<QuickInsertItem>);
+  | ((intl: IntlShape) => Array<QuickInsertItem>)
+  | Array<QuickInsertItem>;
 
 export { QuickInsertItem };
 
@@ -2325,10 +2328,10 @@ type ScrollGutterPluginOptions = {
 // @public (undocumented)
 export type SelectionData =
   | AllSelectionData
-  | NodeSelectionData
-  | TextSelectionData
+  | CellSelectionData
   | GapSelectionData
-  | CellSelectionData;
+  | NodeSelectionData
+  | TextSelectionData;
 
 // @public (undocumented)
 export interface SelectionDataState {
@@ -2370,15 +2373,10 @@ export const setMobilePaddingTop: (paddingTop: number) => Command_2;
 
 // @public (undocumented)
 export const setStatusPickerAt: (
-  showStatusPickerAt: number | null,
+  showStatusPickerAt: null | number,
 ) => (state: EditorState, dispatch: (tr: Transaction) => void) => boolean;
 
-// @public (undocumented)
-export function setTextSelection(
-  view: EditorView,
-  anchor: number,
-  head?: number,
-): void;
+export { setTextSelection };
 
 // @public (undocumented)
 interface SimpleEntry {
@@ -2434,7 +2432,7 @@ export const statusPluginKey: PluginKey<StatusState, any>;
 // @public (undocumented)
 export type StatusState = {
   isNew: boolean;
-  showStatusPickerAt: number | null;
+  showStatusPickerAt: null | number;
 };
 
 // @public (undocumented)
@@ -2471,14 +2469,14 @@ export const subscribeTypeAheadUpdates: SubscribeTypeAheadUpdates;
 
 // @public (undocumented)
 export type TaskDecisionInputMethod =
-  | INPUT_METHOD.TOOLBAR
+  | INPUT_METHOD.FORMATTING
   | INPUT_METHOD.INSERT_MENU
+  | INPUT_METHOD.KEYBOARD
   | INPUT_METHOD.QUICK_INSERT
-  | INPUT_METHOD.FORMATTING
-  | INPUT_METHOD.KEYBOARD;
+  | INPUT_METHOD.TOOLBAR;
 
 // @public (undocumented)
-type TaskDecisionListType = 'taskList' | 'decisionList';
+type TaskDecisionListType = 'decisionList' | 'taskList';
 
 export { TeamMentionResource };
 
@@ -2505,14 +2503,14 @@ export type TextColorPluginState = {
   paletteExpanded?: Array<PaletteColor>;
   defaultColor: string;
   disabled?: boolean;
-  color: string | null;
+  color: null | string;
 };
 
 // @public (undocumented)
 export type TextFormattingInputMethodBasic =
-  | TextFormattingInputMethodToolbar
+  | INPUT_METHOD.FORMATTING
   | INPUT_METHOD.SHORTCUT
-  | INPUT_METHOD.FORMATTING;
+  | TextFormattingInputMethodToolbar;
 
 // @public (undocumented)
 export type TextFormattingInputMethodToolbar = INPUT_METHOD.TOOLBAR;
@@ -2822,7 +2820,7 @@ export class WithEditorActions extends React_2.Component<
   // (undocumented)
   render(): React_2.ReactElement<
     any,
-    string | React_2.JSXElementConstructor<any>
+    React_2.JSXElementConstructor<any> | string
   > | null;
 }
 
@@ -2853,3 +2851,5 @@ export { WithPluginState };
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->