@atlaskit/editor-core 172.3.2 → 173.0.0

package/report.api.md

@@ -1,6 +1,8 @@
-## API Report File for "@atlaskit/editor-core"
+## 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 by [API Extractor](https://api-extractor.com/).
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ````ts
 /// <reference types="node" />
@@ -36,6 +38,7 @@ import { Fragment } from 'prosemirror-model';
 import { IntlShape } from 'react-intl-next';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { jsx } from '@emotion/react';
+import { LinkPickerProps } from '@atlaskit/link-picker';
 import { MacroAttributes } from '@atlaskit/editor-common/provider-factory';
 import { MacroProvider } from '@atlaskit/editor-common/provider-factory';
 import { Mapping } from 'prosemirror-transform';
@@ -365,6 +368,7 @@ export declare enum ACTION_SUBJECT_ID {
   EDIT_LINK = 'editLink',
   UNLINK = 'unlink',
   OPEN_LINK = 'openLink',
+  GOTO_SMART_LINK_SETTINGS = 'goToSmartLinkSettings',
   EMBEDS = 'embeds',
   HYPERLINK = 'hyperlink',
 }
@@ -452,6 +456,7 @@ export declare type AnalyticsEventPayload<T = void> =
   | TypeAheadPayload
   | UnlinkToolbarAEP
   | EditLinkToolbarAEP
+  | OpenSettingsToolbarAEP
   | CustomPanelEventPayload
   | FeatureExposureAEP
   | NewCollabSyncUpErrorAEP
@@ -595,6 +600,7 @@ export declare class BaseReactEditorView<T = {}> extends React_2.Component<
   transactionTracker: TransactionTracker;
   validTransactionCount: number;
   experienceStore?: ExperienceStore;
+  editorRef: React_2.RefObject<HTMLDivElement>;
   static contextTypes: {
     getAtlaskitAnalyticsEventHandlers: PropTypes.Requireable<
       (...args: any[]) => any
@@ -740,6 +746,8 @@ declare type BrowserFreezetracking = {
   severityDegradedThreshold?: number;
 };
 
+declare type Browsers = typeof SupportedBrowsers[number];
+
 declare type ButtonAEP<ActionSubjectID, Attributes> = UIAEP<
   ACTION.CLICKED,
   ACTION_SUBJECT.BUTTON,
@@ -1095,6 +1103,8 @@ declare type CopyAEP = TrackAEP<
   undefined,
   {
     content: string[];
+    inputMethod?: string;
+    nodeType?: string;
   },
   undefined
 >;
@@ -1322,6 +1332,7 @@ declare type DefaultPresetPluginOptions = {
   codeBlock?: CodeBlockOptions;
   selection?: SelectionPluginOptions;
   cardOptions?: CardOptions;
+  hyperlinkOptions?: HyperlinkPluginOptions;
   createAnalyticsEvent?: CreateUIAnalyticsEvent;
   typeAhead?: TypeAheadPluginOptions;
 };
@@ -1375,6 +1386,10 @@ declare type DeletePanelAEP = TrackAEP<
   undefined
 >;
 
+declare type DisableSpellcheckByBrowser = {
+  [b in Browsers]?: Range_2;
+};
+
 declare type DismissedCreateLinkInlineDialogAEP = UIAEP<
   ACTION.DISMISSED,
   ACTION_SUBJECT.CREATE_LINK_INLINE_DIALOG,
@@ -1442,6 +1457,7 @@ export declare interface DropdownOptionT<T> {
   hidden?: boolean;
   testId?: string;
   tooltip?: string;
+  elemAfter?: React_2.ReactNode;
 }
 
 declare type EditInsertedState = {
@@ -1635,6 +1651,7 @@ declare interface EditorAppearanceComponentProps {
   enableToolbarMinWidth?: boolean;
   featureFlags?: EditorFeatureFlags;
   useStickyToolbar?: boolean | RefObject<HTMLElement>;
+  innerRef?: RefObject<HTMLDivElement>;
 }
 
 declare interface EditorConfig {
@@ -1853,23 +1870,6 @@ export declare type EditorFeatureFlags = {
    * @default false
    */
   tableOverflowShadowsOptimization?: boolean;
-  /**
-   * @decsription
-   * Enables optional code syntax highlighting for code-block nodes
-   *
-   * @see https://product-fabric.atlassian.net/browse/ED-10368
-   * @default false
-   */
-  codeBlockSyntaxHighlighting?: boolean;
-  /**
-   * @description
-   * Disables decorating code snippets with bidi character warnings
-   * when they are used in inline code and code blocks.
-   *
-   * @see https://product-fabric.atlassian.net/browse/ED-13860
-   * @default true
-   */
-  codeBidiWarnings?: boolean;
   /**
    * @description
    * Yield to user interaction work before sending analytics
@@ -1949,12 +1949,6 @@ export declare type EditorFeatureFlags = {
    * @default false
    */
   saferDispatchedTransactions?: boolean;
-  /**
-   * Disable Spellchecking for chrome version below the max unsafe number
-   * @see https://ops.internal.atlassian.com/jira/browse/HOT-97409
-   * @default null
-   */
-  maxUnsafeChromeSpellcheckingVersion?: number;
   /**
    * Create non-smart hyperlinks on plain text paste (Cmd/Ctrl+Shift+v)
    * @see https://product-fabric.atlassian.net/browse/EDM-2492
@@ -1975,6 +1969,12 @@ export declare type EditorFeatureFlags = {
    * @default undefined
    */
   chromeCursorHandlerFixedVersion?: number;
+  /**
+   * Enable table cell options in the floating toolbar
+   * @see https://product-fabric.atlassian.net/browse/ED-14418
+   * @default false
+   */
+  tableCellOptionsInFloatingToolbar?: boolean;
   /**
    * Number to distinguish between which different toolbar is being displayed
    * as part of the smart link view changing experiment run by the Linking Platform.
@@ -1984,12 +1984,66 @@ export declare type EditorFeatureFlags = {
   viewChangingExperimentToolbarStyle?: string;
   /**
    * @description
-   * Enable display of a prewiew modal on mouse over of inline smart card
+   * Enable display of a preview modal on mouse over of inline smart card
    *
    * @see https://product-fabric.atlassian.net/browse/EDM-2860
    * @default false
    */
   showHoverPreview?: boolean;
+  /**
+   * @description
+   * Generic way of disabling spellcheck per browser by version range
+   *
+   * @see https://product-fabric.atlassian.net/browse/ED-14510
+   * @default {}
+   * Example:
+   * {
+   *    ie: {
+   *      minimum: 101,
+   *    },
+   *    chrome: {
+   *      minimum: 96,
+   *      maximum: 109,
+   *    },
+   * };
+   */
+  disableSpellcheckByBrowser?: DisableSpellcheckByBrowser | undefined;
+  /**
+   * @description
+   * Show indentation buttons in the Editor toolbar
+   *
+   * @see https://product-fabric.atlassian.net/wiki/spaces/E/pages/3237512038/EXPLORE+Indentation+buttons+in+the+Editor+toolbar
+   * @see https://product-fabric.atlassian.net/browse/ED-15067
+   * @default false
+   */
+  indentationButtonsInTheToolbar?: boolean;
+  /**
+   * @description
+   * Show copy buttons in the Floating toolbar
+   *
+   * @see https://product-fabric.atlassian.net/wiki/spaces/E/pages/3237609689/Cubone+Mini+project+-+Copy+button+in+the+floating+toolbar
+   * @see https://product-fabric.atlassian.net/browse/ED-15090
+   * @default false
+   */
+  floatingToolbarCopyButton?: boolean;
+  /**
+   * @description
+   * Use the linking platform link picker for link insertion and edit
+   *
+   * @see https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3158246501/PP+Link+Picker+-+Standalone
+   * @see https://product-fabric.atlassian.net/browse/EDM-2577
+   * @default false
+   */
+  lpLinkPicker?: boolean;
+  /**
+   * @description
+   * Show link settings button in the Floating toolbar
+   *
+   * @see https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3199172609/POP+Some+users+need+to+work+with+URLs+to+get+their+job+done
+   * @see https://product-fabric.atlassian.net/browse/EDM-3268
+   * @default null
+   */
+  floatingToolbarLinkSettingsButton?: string;
 };
 
 export declare interface EditorInstance {
@@ -2026,6 +2080,7 @@ declare type EditorPerfAEP = OperationalAEPWithObjectId<
     nodes?: Record<string, number>;
     ttfb?: number;
     severity?: SEVERITY;
+    distortedDuration?: boolean;
   },
   undefined
 >;
@@ -2109,11 +2164,6 @@ export declare interface EditorProps {
     | {
         menuDisabled: boolean;
       };
-  /**
-   * @deprecated [ED-14507] This feature has been turned off since 2020
-   * and is no longer affecting any behaviour
-   */
-  allowDynamicTextSizing?: boolean;
   allowTextAlignment?: boolean;
   allowIndentation?: boolean;
   /**
@@ -2131,7 +2181,12 @@ export declare interface EditorProps {
   quickInsert?: QuickInsertOptions;
   /** @deprecated Use smartLinks instead. */
   UNSAFE_cards?: CardOptions;
+  /** @deprecated Use linking instead. */
   smartLinks?: CardOptions;
+  /**
+   *  Configure and extend editor linking behaviour
+   */
+  linking?: LinkingOptions;
   allowExpand?:
     | boolean
     | {
@@ -2398,6 +2453,7 @@ declare interface EditorViewProps {
     eventDispatcher: EventDispatcher;
     transformer?: Transformer_2<string>;
     dispatchAnalyticsEvent: DispatchAnalyticsEvent;
+    editorRef: React_2.RefObject<HTMLDivElement>;
   }) => JSX.Element;
   onEditorCreated: (instance: {
     view: EditorView;
@@ -2804,6 +2860,8 @@ export declare type FloatingToolbarDropdown<T> = {
   hideExpandIcon?: boolean;
   disabled?: boolean;
   tooltip?: string;
+  dropdownWidth?: number;
+  showSelected?: boolean;
 };
 
 export declare type FloatingToolbarEmojiPicker<T> = FloatingToolbarSelectBase<
@@ -2841,7 +2899,6 @@ declare type FloatingToolbarHandler = (
   state: EditorState,
   intl: IntlShape,
   providerFactory: ProviderFactory,
-  cardOptions?: CardOptions,
 ) => FloatingToolbarConfig | undefined;
 
 export declare type FloatingToolbarInput<T> = {
@@ -3211,6 +3268,15 @@ export declare enum HyperlinkInsertStatus {
   EDIT_INSERTED_TOOLBAR = 'EDIT_INSERTED',
 }
 
+/**
+ * Configuration for the Hyperlink plugin
+ */
+declare interface HyperlinkPluginOptions {
+  cardOptions?: CardOptions;
+  linkPicker?: LinkPickerOptions;
+  platform?: 'mobile' | 'web';
+}
+
 export declare interface HyperlinkState {
   activeText?: string;
   activeLinkMark?: LinkToolbarState;
@@ -3793,17 +3859,6 @@ declare type InsertTableAEP = InsertAEP<
   undefined
 >;
 
-export declare const insertTaskDecision: (
-  view: EditorView,
-  listType: TaskDecisionListType,
-  inputMethod?:
-    | INPUT_METHOD.FORMATTING
-    | INPUT_METHOD.QUICK_INSERT
-    | InsertBlockInputMethodToolbar,
-  listLocalId?: string | undefined,
-  itemLocalId?: string | undefined,
-) => Command;
-
 export declare const insertTaskDecisionCommand: (
   listType: TaskDecisionListType,
   inputMethod?:
@@ -3923,10 +3978,32 @@ declare enum LINK_STATUS {
   UNRESOLVED = 'unresolved',
 }
 
+/**
+ * Configuration for editor linking behaviours
+ */
+declare interface LinkingOptions {
+  /**
+   * Initial props to configure the link picker component with. Primarily used to provide link search and suggestions capabilities.
+   * @see https://atlaskit.atlassian.com/packages/editor/editor-core/example/full-page-with-link-picker
+   * @see https://atlaskit.atlassian.com/packages/linking-platform/link-picker
+   */
+  linkPicker?: LinkPickerOptions;
+  /**
+   * Enables and configure smart link behaviour
+   */
+  smartLinks?: CardOptions;
+}
+
 export declare type LinkInputMethod =
   | INPUT_METHOD.MANUAL
   | INPUT_METHOD.TYPEAHEAD;
 
+/**
+ * Configuration for the link picker
+ * Extends `LinkPickerProps` to provide future extensibility out-of-the-box
+ */
+declare interface LinkPickerOptions extends Partial<LinkPickerProps> {}
+
 declare type LinkToolbarState =
   | EditState
   | EditInsertedState
@@ -4202,7 +4279,6 @@ declare interface MediaPluginState {
   layout: RichMediaLayout;
   mediaNodes: MediaNodeWithPosHandler[];
   mediaGroupNodes: Record<string, any>;
-  mobileUploadComplete: Record<string, boolean>;
   options: MediaPluginOptions;
   mediaProvider?: MediaProvider_2;
   pickers: PickerFacade[];
@@ -4247,7 +4323,6 @@ declare interface MediaPluginState {
     attrs: object,
     isMediaSingle: boolean,
   ) => undefined | boolean;
-  isMobileUploadCompleted: (mediaId: string) => boolean | undefined;
   removeNodeById: (state: MediaState) => void;
   removeSelectedMediaContainer: () => boolean;
   selectedMediaContainerNode: () => Node_2 | undefined;
@@ -4634,6 +4709,14 @@ declare type OpenAEP_2 = UIAEP<
 
 export declare const openDatePicker: () => Command;
 
+declare type OpenSettingsToolbarAEP = UIAEP<
+  ACTION.CLICKED,
+  ACTION_SUBJECT.BUTTON,
+  ACTION_SUBJECT_ID.GOTO_SMART_LINK_SETTINGS,
+  {},
+  undefined
+>;
+
 declare type OperationalAEP<
   Action,
   ActionSubject,
@@ -4797,6 +4880,7 @@ declare type PastedTimedAEP = PasteBaseOperationalAEP<
     pasteIntoNode: PASTE_ACTION_SUBJECT_ID;
     content: Array<string>;
     time: number;
+    distortedDuration: boolean;
   },
   undefined
 >;
@@ -5077,7 +5161,13 @@ export declare class PortalProviderAPI extends EventDispatcher {
     hasAnalyticsContext?: boolean,
     hasIntlContext?: boolean,
   ): void;
-  forceUpdate({ intl }: { intl: IntlShape }): void;
+  forceUpdate({
+    intl,
+    themeMode,
+  }: {
+    intl: IntlShape;
+    themeMode: ThemeModes | undefined;
+  }): void;
   remove(container: HTMLElement): void;
 }
 
@@ -5241,6 +5331,11 @@ declare type QuickSearchPerfAEP = OperationalAEP<
   }
 >;
 
+declare type Range_2 = {
+  minimum: number;
+  maximum?: number;
+};
+
 declare type ReactComponents = ReactElement<any> | ReactElement<any>[];
 
 export declare const ReactEditorView: React_2.FC<
@@ -5727,6 +5822,8 @@ declare type SubstituteSymbolAEP = SubstituteAEP<
   }
 >;
 
+declare const SupportedBrowsers: readonly ['ie', 'gecko', 'chrome', 'safari'];
+
 declare enum SYMBOL {
   ARROW_RIGHT = 'rightArrow',
   ARROW_LEFT = 'leftArrow',
@@ -5777,6 +5874,7 @@ declare enum TABLE_ACTION {
   REPLACED = 'replaced',
   ATTEMPTED_TABLE_WIDTH_CHANGE = 'attemptedTableWidthChange',
   DISTRIBUTED_COLUMNS_WIDTHS = 'distributedColumnsWidths',
+  FIXED = 'fixed',
 }
 
 declare enum TABLE_BREAKOUT {
@@ -5845,6 +5943,8 @@ declare type TableCollapsedAEP = TableAEP<
 declare type TableColorAEP = TableAEP<
   TABLE_ACTION.COLORED,
   {
+    inputMethod: INPUT_METHOD.CONTEXT_MENU | INPUT_METHOD.FLOATING_TB;
+  } & {
     cellColor: string;
   } & AllCellInfo,
   undefined
@@ -5880,7 +5980,7 @@ declare type TableDeleteRowOrColumnAEP = TableAEP<
 declare type TableDistributeColumnsWidthsAEP = TableAEP<
   TABLE_ACTION.DISTRIBUTED_COLUMNS_WIDTHS,
   {
-    inputMethod: INPUT_METHOD.CONTEXT_MENU;
+    inputMethod: INPUT_METHOD.CONTEXT_MENU | INPUT_METHOD.FLOATING_TB;
     position: number;
     count: number;
   } & TotalRowAndColCount,
@@ -5901,11 +6001,22 @@ declare type TableEventPayload =
   | TableReplaceAEP
   | TableAttemptedResizeAEP
   | TableDistributeColumnsWidthsAEP
-  | TableCollapsedAEP;
+  | TableCollapsedAEP
+  | TableFixedAEP;
+
+declare type TableFixedAEP = TableAEP<
+  TABLE_ACTION.FIXED,
+  {
+    reason: string;
+  },
+  undefined
+>;
 
 declare type TableMergeSplitAEP = TableAEP<
   TABLE_ACTION.MERGED | TABLE_ACTION.SPLIT,
-  AllCellInfo,
+  {
+    inputMethod: INPUT_METHOD.CONTEXT_MENU | INPUT_METHOD.FLOATING_TB;
+  } & AllCellInfo,
   undefined
 >;
 
@@ -5924,6 +6035,7 @@ declare type TableSortColumnAEP = TableAEP<
       | INPUT_METHOD.SHORTCUT
       | INPUT_METHOD.CONTEXT_MENU
       | INPUT_METHOD.BUTTON
+      | INPUT_METHOD.FLOATING_TB
       | INPUT_METHOD.KEYBOARD;
     position: number;
   } & TotalRowAndColCount &