roosterjs 8.30.2 → 8.32.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.30.2)
+// Type definitions for roosterjs (Version 8.32.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -716,6 +716,33 @@ const KnownCreateElementData: Record<KnownCreateElementDataIndex, CreateElementD
  */
 function moveChildNodes(target: Node, source?: Node, keepExistingChildren?: boolean): void;
 
+    /**
+ * Get the intersected Rect of elements provided
+ *
+ * @example
+ * The result of the following Elements Rects would be:
+    {
+        top: Element2.top,
+        bottom: Element1.bottom,
+        left: Element2.left,
+        right: Element2.right
+    }
+    +-------------------------+
+    | Element 1               |
+    |   +-----------------+   |
+    |   | Element2        |   |
+    |   |                 |   |
+    |   |                 |   |
+    +-------------------------+
+        |                 |
+        +-----------------+
+
+ * @param elements Elements to use.
+ * @param additionalRects additional rects to use
+ * @returns If the Rect is valid return the rect, if not, return null.
+ */
+function getIntersectedRect(elements: HTMLElement[], additionalRects?: Rect[]): Rect | null;
+
     /**
  * A virtual table class, represent an HTML table, by expand all merged cells to each separated cells
  */
@@ -736,15 +763,12 @@ class VTable {
      * Current column index
      */
     col: number | undefined;
-    /**
-     * Selected range of cells with the coordinates of the first and last cell selected.
-     */
-    selection: TableSelection | null;
     /**
      * Current format of the table
      */
     formatInfo: Required<TableFormat> | null;
     private trs;
+    private tableSelection;
     /**
      * Create a new instance of VTable object using HTML TABLE or TD node
      * @param node The HTML Table or TD node
@@ -752,12 +776,18 @@ class VTable {
      * @param zoomScale When the table is under a zoomed container, pass in the zoom scale here
      */
     constructor(node: HTMLTableElement | HTMLTableCellElement, normalizeSize?: boolean, zoomScale?: number | SizeTransformer);
+    /**
+     * Selected range of cells with the coordinates of the first and last cell selected.
+     */
+    get selection(): TableSelection | null;
+    set selection(value: TableSelection | null);
     /**
      * Write the virtual table back to DOM tree to represent the change of VTable
      * @param skipApplyFormat Do not reapply table format when write back.
      * Only use this parameter when you are pretty sure there is no format or table structure change during the process.
      */
     writeBack(skipApplyFormat?: boolean): void;
+    private recalculateCellHeight;
     /**
      * Apply the given table format to this virtual table
      * @param format Table format to apply
@@ -775,6 +805,8 @@ class VTable {
     edit(operation: TableOperation | CompatibleTableOperation): void;
     setAlignmentToSelectedCells(firstRow: number, lastRow: number, firstColumn: number, lastColumn: number, alignmentType: string, isVertical?: boolean): void;
     private mergeCells;
+    private isEmptyCell;
+    private mergeCellContents;
     /**
      * Loop each cell of current column and invoke a callback function
      * @param callback The callback function to invoke
@@ -907,8 +939,10 @@ class VList {
     /**
      * Write the result back into DOM tree
      * After that, this VList becomes unavailable because we set this.rootList to null
+     *
+     * @param shouldReuseAllAncestorListElements Optional - defaults to false.
      */
-    writeBack(): void;
+    writeBack(shouldReuseAllAncestorListElements?: boolean): void;
     /**
      * Sets the New List Start Property, that is going to be used to create a new List in the WriteBack function
      * @param separator The HTML element that indicates when to split the VList
@@ -1104,8 +1138,10 @@ class VListItem {
      * Write the change result back into DOM
      * @param listStack current stack of list elements
      * @param originalRoot Original list root element. It will be reused when write back if possible
+     * @param shouldReuseAllAncestorListElements Optional - defaults to false. If true, only make
+     *              sure the direct parent of this list matches the list types when writing back.
      */
-    writeBack(listStack: Node[], originalRoot?: HTMLOListElement | HTMLUListElement): void;
+    writeBack(listStack: Node[], originalRoot?: HTMLOListElement | HTMLUListElement, shouldReuseAllAncestorListElements?: boolean): void;
     /**
      * Get the index of how deep is the current node parent list inside of the original root list.
      * @example In the following structure this function would return 2
@@ -1167,7 +1203,7 @@ class VListChain {
      * After change the lists, commit the change to all lists in this chain to update the list number,
      * and clear the temporary dataset values added to list node
      */
-    commit(): void;
+    commit(shouldReuseAllAncestorListElements?: boolean): void;
     /**
      * Construct a new instance of VListChain class
      * @param editor Editor object
@@ -1203,6 +1239,13 @@ function setListItemStyle(element: HTMLLIElement, styles: string[]): void;
  */
 function getTableFormatInfo(table: HTMLTableElement): Required<TableFormat> | null;
 
+    /**
+ * Add metadata to a cell
+ * @param cell The table cell to add the metadata
+ * @param format The format of the table
+ */
+function saveTableCellMetadata(cell: HTMLTableCellElement, format: TableCellMetadataFormat): void;
+
     /**
  * Get regions impacted by the given range under the root node
  * @param root Root node to get regions from
@@ -1613,7 +1656,7 @@ function getEntitySelector(type?: string, id?: string): string;
  * @param key Cache key string, need to be unique
  * @param getter Getter function to get the object when it is not in cache yet
  */
-function cacheGetEventData<T>(event: PluginEvent, key: string, getter: () => T): T;
+function cacheGetEventData<T>(event: PluginEvent | null, key: string, getter: () => T): T;
 
     /**
  * Clear a cached object by its key from an event object
@@ -1672,7 +1715,7 @@ function adjustInsertPosition(root: HTMLElement, nodeToInsert: Node, position: N
  * @param core The EditorCore object.
  * @param range The range to delete
  */
-function deleteSelectedContent(root: HTMLElement, range: Range): null;
+function deleteSelectedContent(root: HTMLElement, range: Range): NodePosition | null;
 
     /**
  * get block element's text content.
@@ -1859,7 +1902,7 @@ class Editor implements IEditor  {
      * @param node The node to create InlineElement
      * @returns The BlockElement result
      */
-    getBlockElementAtNode(node: Node): BlockElement;
+    getBlockElementAtNode(node: Node): BlockElement | null;
     contains(arg: Node | Range): boolean;
     queryElements(selector: string, scopeOrCallback?: QueryScope | CompatibleQueryScope | ((node: Node) => any), callback?: (node: Node) => any): HTMLElement[];
     /**
@@ -1905,7 +1948,7 @@ class Editor implements IEditor  {
     /**
      * Delete selected content
      */
-    deleteSelectedContent(): NodePosition;
+    deleteSelectedContent(): NodePosition | null;
     /**
      * Paste into editor using a clipboardData object
      * @param clipboardData Clipboard data retrieved from clipboard
@@ -1921,7 +1964,7 @@ class Editor implements IEditor  {
      * Default value is true
      * @returns current selection range, or null if editor never got focus before
      */
-    getSelectionRange(tryGetFromCache?: boolean): Range;
+    getSelectionRange(tryGetFromCache?: boolean): Range | null;
     /**
      * Get current selection range from Editor.
      * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache.
@@ -1935,7 +1978,7 @@ class Editor implements IEditor  {
      * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache.
      * @returns current selection path, or null if editor never got focus before
      */
-    getSelectionPath(): SelectionPath;
+    getSelectionPath(): SelectionPath | null;
     /**
      * Check if focus is in editor now
      * @returns true if focus is in editor, otherwise false
@@ -1945,11 +1988,11 @@ class Editor implements IEditor  {
      * Focus to this editor, the selection was restored to where it was before, no unexpected scroll.
      */
     focus(): void;
-    select(arg1: any, arg2?: any, arg3?: any, arg4?: any): boolean;
+    select(arg1: Range | NodePosition | Node | SelectionPath | HTMLTableElement | HTMLImageElement | null, arg2?: NodePosition | number | PositionType | TableSelection, arg3?: Node, arg4?: number | PositionType): boolean;
     /**
      * Get current focused position. Return null if editor doesn't have focus at this time.
      */
-    getFocusedPosition(): NodePosition;
+    getFocusedPosition(): NodePosition | null;
     /**
      * Get an HTML element from current cursor position.
      * When expectedTags is not specified, return value is the current node (if it is HTML element)
@@ -1962,7 +2005,7 @@ class Editor implements IEditor  {
      * @param event Optional, if specified, editor will try to get cached result from the event object first.
      * If it is not cached before, query from DOM and cache the result into the event object
      */
-    getElementAtCursor(selector?: string, startFrom?: Node, event?: PluginEvent): HTMLElement;
+    getElementAtCursor(selector?: string, startFrom?: Node, event?: PluginEvent): HTMLElement | null;
     /**
      * Check if this position is at beginning of the editor.
      * This will return true if all nodes between the beginning of target node and the position are empty.
@@ -2009,7 +2052,7 @@ class Editor implements IEditor  {
      * a ContentChangedEvent will be fired with change source equal to this value
      * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).
      */
-    addUndoSnapshot(callback?: (start: NodePosition, end: NodePosition) => any, changeSource?: ChangeSource | CompatibleChangeSource | string, canUndoByBackspace?: boolean, additionalData?: ContentChangedData): void;
+    addUndoSnapshot(callback?: (start: NodePosition | null, end: NodePosition | null) => any, changeSource?: ChangeSource | CompatibleChangeSource | string, canUndoByBackspace?: boolean, additionalData?: ContentChangedData): void;
     /**
      * Whether there is an available undo/redo snapshot
      */
@@ -2049,19 +2092,22 @@ class Editor implements IEditor  {
     getBodyTraverser(startNode?: Node): IContentTraverser;
     /**
      * Get a content traverser for current selection
+     * @returns A content traverser, or null if editor never got focus before
      */
-    getSelectionTraverser(range?: Range): IContentTraverser;
+    getSelectionTraverser(range?: Range): IContentTraverser | null;
     /**
      * Get a content traverser for current block element start from specified position
      * @param startFrom Start position of the traverser. Default value is ContentPosition.SelectionStart
+     * @returns A content traverser, or null if editor never got focus before
      */
-    getBlockTraverser(startFrom?: ContentPosition | CompatibleContentPosition): IContentTraverser;
+    getBlockTraverser(startFrom?: ContentPosition | CompatibleContentPosition): IContentTraverser | null;
     /**
      * Get a text traverser of current selection
      * @param event Optional, if specified, editor will try to get cached result from the event object first.
      * If it is not cached before, query from DOM and cache the result into the event object
+     * @returns A content traverser, or null if editor never got focus before
      */
-    getContentSearcherOfCursor(event?: PluginEvent): IPositionContentSearcher;
+    getContentSearcherOfCursor(event?: PluginEvent): IPositionContentSearcher | null;
     /**
      * Run a callback function asynchronously
      * @param callback The callback function to run
@@ -2075,18 +2121,20 @@ class Editor implements IEditor  {
      */
     setEditorDomAttribute(name: string, value: string): void;
     /**
-     * get DOM attribute of editor content DIV
+     * Get DOM attribute of editor content DIV, null if there is no such attribute.
      * @param name Name of the attribute
      */
-    getEditorDomAttribute(name: string): string;
+    getEditorDomAttribute(name: string): string | null;
     /**
+     * @deprecated Use getVisibleViewport() instead.
+     *
      * Get current relative distance from top-left corner of the given element to top-left corner of editor content DIV.
      * @param element The element to calculate from. If the given element is not in editor, return value will be null
      * @param addScroll When pass true, The return value will also add scrollLeft and scrollTop if any. So the value
      * may be different than what user is seeing from the view. When pass false, scroll position will be ignored.
      * @returns An [x, y] array which contains the left and top distances, or null if the given element is not in editor.
      */
-    getRelativeDistanceToEditor(element: HTMLElement, addScroll?: boolean): number[];
+    getRelativeDistanceToEditor(element: HTMLElement, addScroll?: boolean): number[] | null;
     /**
      * Add a Content Edit feature.
      * @param feature The feature to add
@@ -2170,6 +2218,15 @@ class Editor implements IEditor  {
      * @param scale The new scale number to set. It should be positive number and no greater than 10, otherwise it will be ignored.
      */
     setZoomScale(scale: number): void;
+    /**
+     * Retrieves the rect of the visible viewport of the editor.
+     */
+    getVisibleViewport(): Rect | null;
+    /**
+     * @returns the current EditorCore object
+     * @throws a standard Error if there's no core object
+     */
+    private getCore;
 }
 
     /**
@@ -2579,7 +2636,13 @@ function blockFormat(editor: IEditor, callback: (region: Region, start: NodePosi
  * @param editor The Editor object
  * @param chains List chains to commit
  */
-function experimentCommitListChains(editor: IEditor, chains: VListChain[]): void;
+function commitListChains(editor: IEditor, chains: VListChain[]): void;
+
+    /**
+ * @deprecated
+ * Same with commitListChains, keep this export just for backward compatibility
+ */
+const experimentCommitListChains: typeof commitListChains;
 
     /**
  * Get dark mode color for a given color
@@ -2695,6 +2758,10 @@ interface DOMEventPluginState {
      * Context menu providers, that can provide context menu items
      */
     contextMenuProviders: ContextMenuProvider<any>[];
+    /**
+     * Image selection range
+     */
+    imageSelectionRange: ImageSelectionRange | null;
 }
 
     /**
@@ -2771,6 +2838,10 @@ interface LifecyclePluginState {
      * Cached table selection path for original content
      */
     shadowEditTableSelectionPath: SelectionPath[] | null;
+    /**
+     * Cached image selection path for original content
+     */
+    shadowEditImageSelectionPath: SelectionPath[] | null;
 }
 
     /**
@@ -3471,7 +3542,7 @@ const enum ExperimentalFeatures {
      */
     ImageRotate = "ImageRotate",
     /**
-     * Crop an inline image (requires ImageEdit plugin)
+     * @deprecated This feature is always enabled
      */
     ImageCrop = "ImageCrop",
     /**
@@ -3518,7 +3589,18 @@ const enum ExperimentalFeatures {
      * Normalize list to make sure it can be displayed correctly in other client
      * e.g. We will move list items with "display: block" into previous list item and change tag to be DIV
      */
-    NormalizeList = "NormalizeList"
+    NormalizeList = "NormalizeList",
+    /**
+     * When a html image is selected, the selected image data will be stored by editor core.
+     */
+    ImageSelection = "ImageSelection",
+    /**
+     * With this feature enabled, when writing back a list item we will re-use all
+     * ancestor list elements, even if they don't match the types currently in the
+     * listTypes array for that item. The only list that we will ensure is correct
+     * is the one closest to the item.
+     */
+    ReuseAllAncestorListElements = "ReuseAllAncestorListElements"
 }
 
     /**
@@ -4071,7 +4153,11 @@ const enum SelectionRangeTypes {
     /**
      * Selection made inside of a single table.
      */
-    TableSelection = 1
+    TableSelection = 1,
+    /**
+     * Selection made in a image.
+     */
+    ImageSelection = 2
 }
 
     /**
@@ -4193,7 +4279,7 @@ const enum BulletListType {
      */
     ShortArrow = 4,
     /**
-     * Bullet triggered by -> or -->
+     * Bullet triggered by ->
      */
     LongArrow = 5,
     /**
@@ -4204,10 +4290,18 @@ const enum BulletListType {
      * Bullet triggered by —
      */
     Hyphen = 7,
+    /**
+     * Bullet triggered by -->
+     */
+    DoubleLongArrow = 8,
+    /**
+     * Bullet type circle
+     */
+    Circle = 9,
     /**
      * Maximum value of the enum
      */
-    Max = 7
+    Max = 9
 }
 
     /**
@@ -5650,6 +5744,16 @@ interface TableFormat {
     keepCellShade?: boolean;
 }
 
+    /**
+ * Format of table cell that stored as metadata
+ */
+interface TableCellMetadataFormat {
+    /**
+     * Override default background color
+     */
+    bgColorOverride?: boolean;
+}
+
     /**
  * Represents a selection made inside of a table
  */
@@ -5912,7 +6016,7 @@ interface IEditor {
      * @param node The node to create InlineElement
      * @returns The BlockElement result
      */
-    getBlockElementAtNode(node: Node): BlockElement;
+    getBlockElementAtNode(node: Node): BlockElement | null;
     /**
      * Check if the node falls in the editor content
      * @param node The node to check
@@ -5998,7 +6102,7 @@ interface IEditor {
     /**
      * Delete selected content
      */
-    deleteSelectedContent(): NodePosition;
+    deleteSelectedContent(): NodePosition | null;
     /**
      * Paste into editor using a clipboardData object
      * @param clipboardData Clipboard data retrieved from clipboard
@@ -6014,7 +6118,7 @@ interface IEditor {
      * Default value is true
      * @returns current selection range, or null if editor never got focus before
      */
-    getSelectionRange(tryGetFromCache?: boolean): Range;
+    getSelectionRange(tryGetFromCache?: boolean): Range | null;
     /**
      * Get current selection range from Editor.
      * It does a live pull on the selection.
@@ -6026,7 +6130,7 @@ interface IEditor {
      * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache.
      * @returns current selection path, or null if editor never got focus before
      */
-    getSelectionPath(): SelectionPath;
+    getSelectionPath(): SelectionPath | null;
     /**
      * Check if focus is in editor now
      * @returns true if focus is in editor, otherwise false
@@ -6092,7 +6196,7 @@ interface IEditor {
     /**
      * Get current focused position. Return null if editor doesn't have focus at this time.
      */
-    getFocusedPosition(): NodePosition;
+    getFocusedPosition(): NodePosition | null;
     /**
      * Get an HTML element from current cursor position.
      * When expectedTags is not specified, return value is the current node (if it is HTML element)
@@ -6105,7 +6209,7 @@ interface IEditor {
      * @param event Optional, if specified, editor will try to get cached result from the event object first.
      * If it is not cached before, query from DOM and cache the result into the event object
      */
-    getElementAtCursor(selector?: string, startFrom?: Node, event?: PluginEvent): HTMLElement;
+    getElementAtCursor(selector?: string, startFrom?: Node, event?: PluginEvent): HTMLElement | null;
     /**
      * Check if this position is at beginning of the editor.
      * This will return true if all nodes between the beginning of target node and the position are empty.
@@ -6207,19 +6311,22 @@ interface IEditor {
     getBodyTraverser(startNode?: Node): IContentTraverser;
     /**
      * Get a content traverser for current selection
+     * @returns A content traverser, or null if editor never got focus before and no range is provided
      */
-    getSelectionTraverser(range?: Range): IContentTraverser;
+    getSelectionTraverser(range?: Range): IContentTraverser | null;
     /**
      * Get a content traverser for current block element start from specified position
      * @param startFrom Start position of the traverser. Default value is ContentPosition.SelectionStart
+     * @returns A content traverser, or null if editor never got focus before
      */
-    getBlockTraverser(startFrom?: ContentPosition | CompatibleContentPosition): IContentTraverser;
+    getBlockTraverser(startFrom?: ContentPosition | CompatibleContentPosition): IContentTraverser | null;
     /**
      * Get a text traverser of current selection
      * @param event Optional, if specified, editor will try to get cached result from the event object first.
      * If it is not cached before, query from DOM and cache the result into the event object
+     * @returns A content traverser, or null if editor never got focus before
      */
-    getContentSearcherOfCursor(event?: PluginEvent): IPositionContentSearcher;
+    getContentSearcherOfCursor(event?: PluginEvent): IPositionContentSearcher | null;
     /**
      * Run a callback function asynchronously
      * @param callback The callback function to run
@@ -6233,18 +6340,20 @@ interface IEditor {
      */
     setEditorDomAttribute(name: string, value: string): void;
     /**
-     * Get DOM attribute of editor content DIV
+     * Get DOM attribute of editor content DIV, null if there is no such attribute.
      * @param name Name of the attribute
      */
-    getEditorDomAttribute(name: string): string;
+    getEditorDomAttribute(name: string): string | null;
     /**
+     * @deprecated Use getVisibleViewport() instead
+     *
      * Get current relative distance from top-left corner of the given element to top-left corner of editor content DIV.
      * @param element The element to calculate from. If the given element is not in editor, return value will be null
      * @param addScroll When pass true, The return value will also add scrollLeft and scrollTop if any. So the value
      * may be different than what user is seeing from the view. When pass false, scroll position will be ignored.
      * @returns An [x, y] array which contains the left and top distances, or null if the given element is not in editor.
      */
-    getRelativeDistanceToEditor(element: HTMLElement, addScroll?: boolean): number[];
+    getRelativeDistanceToEditor(element: HTMLElement, addScroll?: boolean): number[] | null;
     /**
      * Add a Content Edit feature.
      * @param feature The feature to add
@@ -6327,6 +6436,10 @@ interface IEditor {
      * @deprecated Use getZoomScale() instead
      */
     getSizeTransformer(): SizeTransformer;
+    /**
+     * Retrieves the rect of the visible viewport of the editor.
+     */
+    getVisibleViewport(): Rect | null;
 }
 
     /**
@@ -6540,6 +6653,14 @@ interface EditorCore extends PluginState  {
      * @deprecated Use zoomScale instead
      */
     sizeTransformer: SizeTransformer;
+    /**
+     * Retrieves the Visible Viewport of the editor.
+     */
+    getVisibleViewport: () => Rect | null;
+    /**
+     * Color of the border of a selectedImage. Default color: '#DB626C'
+     */
+    imageSelectionBorderColor?: string;
 }
 
     /**
@@ -6707,6 +6828,14 @@ interface CoreApiMap {
      * @returns true if successful
      */
     selectTable: SelectTable;
+    /**
+     * Select a image and save data of the selected range
+     * @param core The EditorCore object
+     * @param image image to select
+     * @param imageId the id of the image element
+     * @returns true if successful
+     */
+    selectImage: SelectImage;
 }
 
     /**
@@ -6718,7 +6847,7 @@ interface CoreApiMap {
  * @param applyCurrentStyle True if apply format of current selection to the pasted content,
  * false to keep original format
  */
-type CreatePasteFragment = (core: EditorCore, clipboardData: ClipboardData, position: NodePosition, pasteAsText: boolean, applyCurrentStyle: boolean) => DocumentFragment | null;
+type CreatePasteFragment = (core: EditorCore, clipboardData: ClipboardData, position: NodePosition | null, pasteAsText: boolean, applyCurrentStyle: boolean) => DocumentFragment | null;
 
     /**
  * Ensure user will type into a container element rather than into the editor content DIV directly
@@ -6762,7 +6891,7 @@ type GetSelectionRangeEx = (core: EditorCore) => SelectionRangeEx;
  * @param core The EditorCore objects
  * @param node The node to get style from
  */
-type GetStyleBasedFormatState = (core: EditorCore, node: Node) => StyleBasedFormatState;
+type GetStyleBasedFormatState = (core: EditorCore, node: Node | null) => StyleBasedFormatState;
 
     /**
  * Get the pendable format such as underline and bold
@@ -6784,7 +6913,7 @@ type HasFocus = (core: EditorCore) => boolean;
  * @param core The EditorCore object. No op if null.
  * @param option An insert option object to specify how to insert the node
  */
-type InsertNode = (core: EditorCore, node: Node, option: InsertOption) => boolean;
+type InsertNode = (core: EditorCore, node: Node, option: InsertOption | null) => boolean;
 
     /**
  * Restore an undo snapshot into editor
@@ -6829,7 +6958,7 @@ type SwitchShadowEdit = (core: EditorCore, isOn: boolean) => void;
  * @param forceTransform By default this function will only work when editor core is in dark mode.
  * Pass true to this value to force do color transformation even editor core is in light mode
  */
-type TransformColor = (core: EditorCore, rootNode: Node, includeSelf: boolean, callback: (() => void) | null, direction: ColorTransformDirection | CompatibleColorTransformDirection, forceTransform?: boolean) => void;
+type TransformColor = (core: EditorCore, rootNode: Node | null, includeSelf: boolean, callback: (() => void) | null, direction: ColorTransformDirection | CompatibleColorTransformDirection, forceTransform?: boolean) => void;
 
     /**
  * Trigger a plugin event
@@ -6847,7 +6976,15 @@ type TriggerEvent = (core: EditorCore, pluginEvent: PluginEvent, broadcast: bool
  * selecting, will unselect the table.
  * @returns true if successful
  */
-type SelectTable = (core: EditorCore, table: HTMLTableElement, coordinates?: TableSelection) => TableSelectionRange | null;
+type SelectTable = (core: EditorCore, table: HTMLTableElement | null, coordinates?: TableSelection) => TableSelectionRange | null;
+
+    /**
+ * Select a table and save data of the selected range
+ * @param core The EditorCore object
+ * @param image image to select
+ * @returns true if successful
+ */
+type SelectImage = (core: EditorCore, image: HTMLImageElement | null) => ImageSelectionRange | null;
 
     /**
  * The options to specify parameters customizing an editor, used by ctor of Editor class
@@ -6950,6 +7087,14 @@ interface EditorOptions {
      * @deprecated Use zoomScale instead
      */
     sizeTransformer?: SizeTransformer;
+    /**
+     * Retrieves the visible viewport of the Editor. The default viewport is the Rect of the scrollContainer.
+     */
+    getVisibleViewport?: () => Rect | null;
+    /**
+     * Color of the border of a selectedImage. Default color: '#DB626C'
+     */
+    imageSelectionBorderColor?: string;
 }
 
     /**
@@ -7504,10 +7649,20 @@ interface TableSelectionRange extends SelectionRangeExBase<SelectionRangeTypes.T
     coordinates: TableSelection | undefined;
 }
 
+    /**
+ * Represents a selected image.
+ */
+interface ImageSelectionRange extends SelectionRangeExBase<SelectionRangeTypes.ImageSelection | CompatibleSelectionRangeTypes.ImageSelection> {
+    /**
+     * Selected Image
+     */
+    image: HTMLImageElement;
+}
+
     /**
  * Types of ranges used in editor api getSelectionRangeEx
  */
-type SelectionRangeEx = NormalSelectionRange | TableSelectionRange;
+type SelectionRangeEx = NormalSelectionRange | TableSelectionRange | ImageSelectionRange;
 
     /**
  * Attribute callback, will be called when HtmlSanitizer process an attribute with given name
@@ -7751,7 +7906,7 @@ enum CompatibleExperimentalFeatures {
      */
     ImageRotate = "ImageRotate",
     /**
-     * Crop an inline image (requires ImageEdit plugin)
+     * @deprecated This feature is always enabled
      */
     ImageCrop = "ImageCrop",
     /**
@@ -7798,7 +7953,18 @@ enum CompatibleExperimentalFeatures {
      * Normalize list to make sure it can be displayed correctly in other client
      * e.g. We will move list items with "display: block" into previous list item and change tag to be DIV
      */
-    NormalizeList = "NormalizeList"
+    NormalizeList = "NormalizeList",
+    /**
+     * When a html image is selected, the selected image data will be stored by editor core.
+     */
+    ImageSelection = "ImageSelection",
+    /**
+     * With this feature enabled, when writing back a list item we will re-use all
+     * ancestor list elements, even if they don't match the types currently in the
+     * listTypes array for that item. The only list that we will ensure is correct
+     * is the one closest to the item.
+     */
+    ReuseAllAncestorListElements = "ReuseAllAncestorListElements"
 }
 
     /**
@@ -8210,7 +8376,11 @@ enum CompatibleSelectionRangeTypes {
     /**
      * Selection made inside of a single table.
      */
-    TableSelection = 1
+    TableSelection = 1,
+    /**
+     * Selection made in a image.
+     */
+    ImageSelection = 2
 }
 
     /**
@@ -8286,7 +8456,7 @@ enum CompatibleBulletListType {
      */
     ShortArrow = 4,
     /**
-     * Bullet triggered by -> or -->
+     * Bullet triggered by ->
      */
     LongArrow = 5,
     /**
@@ -8297,10 +8467,18 @@ enum CompatibleBulletListType {
      * Bullet triggered by —
      */
     Hyphen = 7,
+    /**
+     * Bullet triggered by -->
+     */
+    DoubleLongArrow = 8,
+    /**
+     * Bullet type circle
+     */
+    Circle = 9,
     /**
      * Maximum value of the enum
      */
-    Max = 7
+    Max = 9
 }
 
     /**
@@ -9687,13 +9865,14 @@ class TableResize implements EditorPlugin  {
 class Watermark implements EditorPlugin  {
     private watermark;
     private format?;
+    private customClass?;
     private editor;
     private disposer;
     /**
      * Create an instance of Watermark plugin
      * @param watermark The watermark string
      */
-    constructor(watermark: string, format?: DefaultFormat);
+    constructor(watermark: string, format?: DefaultFormat, customClass?: string);
     /**
      * Get a friendly name of  this plugin
      */
@@ -9755,12 +9934,6 @@ class TableCellSelection implements EditorPlugin  {
      * The table selection gets removed.
      */
     private handleScrollEvent;
-    /**
-     * Handles the Before Copy Event.
-     * Clear the selection range from the cloned Root.
-     * @param event plugin event
-     */
-    private handleBeforeCutCopy;
     /**
      * Handles the on key event.
      * @param event the plugin event
@@ -9779,10 +9952,6 @@ class TableCellSelection implements EditorPlugin  {
      */
     selectionInsideTableMouseMove(event: MouseEvent): void;
     private removeMouseUpEventListener;
-    /**
-     * When press Backspace, delete the contents inside of the selection, if it is Table Selection
-     */
-    DeleteTableContents: BuildInEditFeature<PluginKeyboardEvent>;
     private clearState;
     private getNextTD;
     private prepareSelection;
@@ -9818,4 +9987,27 @@ class AutoFormat implements EditorPlugin  {
     onPluginEvent(event: PluginEvent): void;
 }
 
+    /**
+ * Detect image selection and help highlight the image
+ */
+class ImageSelection implements EditorPlugin  {
+    private editor;
+    private imageId;
+    constructor();
+    /**
+     * Get a friendly name of  this plugin
+     */
+    getName(): string;
+    /**
+     * Initialize this plugin. This should only be called from Editor
+     * @param editor Editor instance
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * Dispose this plugin
+     */
+    dispose(): void;
+    onPluginEvent(event: PluginEvent): void;
+}
+
 }