roosterjs 8.18.0 → 8.19.2

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.18.0)
+// Type definitions for roosterjs (Version 8.19.2)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -948,50 +948,54 @@ const enum TableOperation {
      * Merge current column with the column on the right
      */
     MergeRight = 10,
+    /**
+     * Merge all selected cells
+     */
+    MergeCells = 11,
     /**
      * Split current table cell horizontally
      */
-    SplitHorizontally = 11,
+    SplitHorizontally = 12,
     /**
      * Split current table cell vertically
      */
-    SplitVertically = 12,
+    SplitVertically = 13,
     /**
      * Align current table at the center
      */
-    AlignCenter = 13,
+    AlignCenter = 14,
     /**
      * Align current table at the left
      */
-    AlignLeft = 14,
+    AlignLeft = 15,
     /**
      * Align current table at the right
      */
-    AlignRight = 15,
+    AlignRight = 16,
     /**
      * Align current content table cell at the left
      */
-    AlignCellLeft = 16,
+    AlignCellLeft = 17,
     /**
      * Align current content table cell at the center
      */
-    AlignCellCenter = 17,
+    AlignCellCenter = 18,
     /**
      * Align current content table cell at the right
      */
-    AlignCellRight = 18,
+    AlignCellRight = 19,
     /**
      * Align current content table cell at the top
      */
-    AlignCellTop = 19,
+    AlignCellTop = 20,
     /**
      * Align current table cell at the middle
      */
-    AlignCellMiddle = 20,
+    AlignCellMiddle = 21,
     /**
      * Align current table cell at the bottom
      */
-    AlignCellBottom = 21
+    AlignCellBottom = 22
 }
 
     /**
@@ -1660,6 +1664,10 @@ interface ClipboardData {
      * Image file from clipboard event
      */
     image: File | null;
+    /**
+     * General file from clipboard event
+     */
+    files?: File[];
     /**
      * Html extracted from raw html string and remove content before and after fragment tag
      */
@@ -1943,27 +1951,27 @@ interface IContentTraverser {
     /**
      * Get current block
      */
-    currentBlockElement: BlockElement;
+    currentBlockElement: BlockElement | null;
     /**
      * Get next block element
      */
-    getNextBlockElement(): BlockElement;
+    getNextBlockElement(): BlockElement | null;
     /**
      * Get previous block element
      */
-    getPreviousBlockElement(): BlockElement;
+    getPreviousBlockElement(): BlockElement | null;
     /**
      * Current inline element getter
      */
-    currentInlineElement: InlineElement;
+    currentInlineElement: InlineElement | null;
     /**
      * Get next inline element
      */
-    getNextInlineElement(): InlineElement;
+    getNextInlineElement(): InlineElement | null;
     /**
      * Get previous inline element
      */
-    getPreviousInlineElement(): InlineElement;
+    getPreviousInlineElement(): InlineElement | null;
 }
 
     /**
@@ -2076,12 +2084,12 @@ interface IPositionContentSearcher {
      * Get the inline element before position
      * @returns The inlineElement before position
      */
-    getInlineElementBefore(): InlineElement;
+    getInlineElementBefore(): InlineElement | null;
     /**
      * Get the inline element after position
      * @returns The inline element after position
      */
-    getInlineElementAfter(): InlineElement;
+    getInlineElementAfter(): InlineElement | null;
     /**
      * Get X number of chars before position
      * The actual returned chars may be less than what is requested.
@@ -2097,7 +2105,7 @@ interface IPositionContentSearcher {
      * @param exactMatch Whether it is an exact match
      * @returns The range for the matched text, null if unable to find a match
      */
-    getRangeFromText(text: string, exactMatch: boolean): Range;
+    getRangeFromText(text: string, exactMatch: boolean): Range | null;
     /**
      * Get text section before position till stop condition is met.
      * This offers consumers to retrieve text section by section
@@ -2111,7 +2119,7 @@ interface IPositionContentSearcher {
      * Get first non textual inline element before position
      * @returns First non textual inline element before position or null if no such element exists
      */
-    getNearestNonTextInlineElement(): InlineElement;
+    getNearestNonTextInlineElement(): InlineElement | null;
 }
 
     /**
@@ -2271,11 +2279,11 @@ interface SelectionPath {
     /**
  * Represents a data structure of snapshots, this is usually used for undo snapshots
  */
-interface Snapshots {
+interface Snapshots<T = string> {
     /**
      * The snapshot array
      */
-    snapshots: string[];
+    snapshots: T[];
     /**
      * Size of all snapshots
      */
@@ -2294,6 +2302,59 @@ interface Snapshots {
     readonly maxSize: number;
 }
 
+    /**
+ * Common part of NormalContentMetadata and TableContentMetadata
+ */
+interface ContentMetadataBase<T extends SelectionRangeTypes> {
+    isDarkMode: boolean;
+    type: T;
+}
+
+    /**
+ * A content metadata is a data structure storing information other than HTML content,
+ * such as dark mode info, selection info, ...
+ *
+ * NormalContentMetadata is content metadata for normal selection with a start and end selection path.
+ *
+ * When do any change to this type, also need to fix function isUndoMetadata to make sure
+ * the check is correct
+ */
+interface NormalContentMetadata extends SelectionPath, ContentMetadataBase<SelectionRangeTypes.Normal> {
+}
+
+    /**
+ * A content metadata is a data structure storing information other than HTML content,
+ * such as dark mode info, selection info, ...
+ *
+ * TableContentMetadata is content metadata for table selection with table id and start and end coordinates
+ *
+ * When do any change to this type, also need to fix function isUndoMetadata to make sure
+ * the check is correct
+ */
+interface TableContentMetadata extends TableSelection, ContentMetadataBase<SelectionRangeTypes.TableSelection> {
+    tableId: string;
+}
+
+    /**
+ * A content metadata is a data structure storing information other than HTML content,
+ * such as dark mode info, selection info, ...
+ */
+type ContentMetadata = NormalContentMetadata | TableContentMetadata;
+
+    /**
+ * A serializable snapshot of editor content, including the html content and metadata
+ */
+interface Snapshot {
+    /**
+     * HTML content string
+     */
+    html: string;
+    /**
+     * Metadata of the editor content state
+     */
+    metadata: ContentMetadata | null;
+}
+
     /**
  * Table format
  */
@@ -2973,6 +3034,11 @@ interface IEditor {
      * @returns True if the editor is in dark mode, otherwise false
      */
     isDarkMode(): boolean;
+    /**
+     * Transform the given node and all its child nodes to dark mode color if editor is in dark mode
+     * @param node The node to transform
+     */
+    transformToDarkColor(node: Node): void;
     /**
      * Make the editor in "Shadow Edit" mode.
      * In Shadow Edit mode, all format change will finally be ignored.
@@ -3157,6 +3223,10 @@ interface CorePlugins {
      * Entity Plugin handles all operations related to an entity and generate entity specified events
      */
     readonly entity: PluginWithState<EntityPluginState>;
+    /**
+     * NormalizeTable plugin makes sure each table in editor has TBODY/THEAD/TFOOT tag around TR tags
+     */
+    readonly normalizeTable: EditorPlugin;
     /**
      * Lifecycle plugin handles editor initialization and disposing
      */
@@ -3369,6 +3439,8 @@ interface CoreApiMap {
      * @param includeSelf True to transform the root node as well, otherwise false
      * @param callback The callback function to invoke before do color transformation
      * @param direction To specify the transform direction, light to dark, or dark to light
+     * @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
      */
     transformColor: TransformColor;
     /**
@@ -3491,7 +3563,7 @@ type SelectRange = (core: EditorCore, range: Range, skipSameRange?: boolean) =>
  * @param content HTML content to set in
  * @param triggerContentChangedEvent True to trigger a ContentChanged event. Default value is true
  */
-type SetContent = (core: EditorCore, content: string, triggerContentChangedEvent: boolean) => void;
+type SetContent = (core: EditorCore, content: string, triggerContentChangedEvent: boolean, metadata?: ContentMetadata) => void;
 
     /**
  * Switch the Shadow Edit mode of editor On/Off
@@ -3507,8 +3579,10 @@ type SwitchShadowEdit = (core: EditorCore, isOn: boolean) => void;
  * @param includeSelf True to transform the root node as well, otherwise false
  * @param callback The callback function to invoke before do color transformation
  * @param direction To specify the transform direction, light to dark, or dark to light
+ * @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, direction: ColorTransformDirection) => void;
+type TransformColor = (core: EditorCore, rootNode: Node, includeSelf: boolean, callback: () => void, direction: ColorTransformDirection, forceTransform?: boolean) => void;
 
     /**
  * Trigger a plugin event
@@ -3546,9 +3620,15 @@ interface EditorOptions {
      */
     defaultFormat?: DefaultFormat;
     /**
+     * @deprecated Use undoMetadataSnapshotService instead
      * Undo snapshot service. Use this parameter to customize the undo snapshot service.
      */
-    undoSnapshotService?: UndoSnapshotsService;
+    undoSnapshotService?: UndoSnapshotsService<string>;
+    /**
+     * Undo snapshot service based on content metadata. Use this parameter to customize the undo snapshot service.
+     * When this property is set, value of undoSnapshotService will be ignored.
+     */
+    undoMetadataSnapshotService?: UndoSnapshotsService<Snapshot>;
     /**
      * Initial HTML content
      * Default value is whatever already inside the editor content DIV
@@ -3815,6 +3895,10 @@ interface TableFeatureSettings {
      * @default true for Chrome and safari, false for other browsers since they already have correct behavior
      */
     upDownInTable: boolean;
+    /**
+     * IndentTableOnTab edit feature, provides the ability to indent the table if it is all cells are selected.
+     */
+    indentTableOnTab: boolean;
 }
 
     /**
@@ -3866,7 +3950,7 @@ interface CustomReplacement {
     /**
  * Represent an interface to provide functionalities for Undo Snapshots
  */
-interface UndoSnapshotsService {
+interface UndoSnapshotsService<T = string> {
     /**
      * Check whether can move current undo snapshot with the given step
      * @param step The step to check, can be positive, negative or 0
@@ -3878,12 +3962,12 @@ interface UndoSnapshotsService {
      * @param step The step to move
      * @returns If can move with the given step, returns the snapshot after move, otherwise null
      */
-    move(step: number): string;
+    move(step: number): T;
     /**
      * Add a new undo snapshot
      * @param snapshot The snapshot to add
      */
-    addSnapshot(snapshot: string, isAutoCompleteSnapshot: boolean): void;
+    addSnapshot(snapshot: T, isAutoCompleteSnapshot: boolean): void;
     /**
      * Clear all undo snapshots after the current one
      */
@@ -4006,7 +4090,7 @@ interface VCell {
     /**
      * The table cell object. The value will be null if this is an expanded virtual cell
      */
-    td?: HTMLTableCellElement;
+    td?: HTMLTableCellElement | null;
     /**
      * Whether this cell is spanned from left
      */
@@ -4290,7 +4374,7 @@ interface UndoPluginState {
     /**
      * Snapshot service for undo, it helps handle snapshot add, remove and retrieve
      */
-    snapshotsService: UndoSnapshotsService;
+    snapshotsService: UndoSnapshotsService<Snapshot>;
     /**
      * Whether restoring of undo snapshot is in progress.
      */
@@ -4436,7 +4520,7 @@ type SizeTransformer = (size: number) => number;
  * @param rootNode Root node of the scope, the block element will be inside of this node
  * @param node The node to get BlockElement start from
  */
-function getBlockElementAtNode(rootNode: Node, node: Node): BlockElement;
+function getBlockElementAtNode(rootNode: Node, node: Node | null): BlockElement | null;
 
     /**
  * Get the first/last BlockElement of under the root node.
@@ -4444,7 +4528,7 @@ function getBlockElementAtNode(rootNode: Node, node: Node): BlockElement;
  * @param rootNode The root node to get BlockElement from
  * @param isFirst True to get first BlockElement, false to get last BlockElement
  */
-function getFirstLastBlockElement(rootNode: Node, isFirst: boolean): BlockElement;
+function getFirstLastBlockElement(rootNode: Node, isFirst: boolean): BlockElement | null;
 
     /**
  * The provides traversing of content inside editor.
@@ -4489,28 +4573,28 @@ class ContentTraverser implements IContentTraverser  {
     /**
      * Get current block
      */
-    get currentBlockElement(): BlockElement;
+    get currentBlockElement(): BlockElement | null;
     /**
      * Get next block element
      */
-    getNextBlockElement(): BlockElement;
+    getNextBlockElement(): BlockElement | null;
     /**
      * Get previous block element
      */
-    getPreviousBlockElement(): BlockElement;
+    getPreviousBlockElement(): BlockElement | null;
     private getPreviousNextBlockElement;
     /**
      * Current inline element getter
      */
-    get currentInlineElement(): InlineElement;
+    get currentInlineElement(): InlineElement | null;
     /**
      * Get next inline element
      */
-    getNextInlineElement(): InlineElement;
+    getNextInlineElement(): InlineElement | null;
     /**
      * Get previous inline element
      */
-    getPreviousInlineElement(): InlineElement;
+    getPreviousInlineElement(): InlineElement | null;
     private getPreviousNextInlineElement;
 }
 
@@ -4544,12 +4628,12 @@ class PositionContentSearcher implements IPositionContentSearcher  {
      * Get the inline element before position
      * @returns The inlineElement before position
      */
-    getInlineElementBefore(): InlineElement;
+    getInlineElementBefore(): InlineElement | null;
     /**
      * Get the inline element after position
      * @returns The inline element after position
      */
-    getInlineElementAfter(): InlineElement;
+    getInlineElementAfter(): InlineElement | null;
     /**
      * Get X number of chars before position
      * The actual returned chars may be less than what is requested.
@@ -4565,7 +4649,7 @@ class PositionContentSearcher implements IPositionContentSearcher  {
      * @param exactMatch Whether it is an exact match
      * @returns The range for the matched text, null if unable to find a match
      */
-    getRangeFromText(text: string, exactMatch: boolean): Range;
+    getRangeFromText(text: string, exactMatch: boolean): Range | null;
     /**
      * Get text section before position till stop condition is met.
      * This offers consumers to retrieve text section by section
@@ -4579,7 +4663,7 @@ class PositionContentSearcher implements IPositionContentSearcher  {
      * Get first non textual inline element before position
      * @returns First non textual inline element before position or null if no such element exists
      */
-    getNearestNonTextInlineElement(): InlineElement;
+    getNearestNonTextInlineElement(): InlineElement | null;
     /**
      * Continue traversing backward till stop condition is met or begin of block is reached
      */
@@ -4591,14 +4675,14 @@ class PositionContentSearcher implements IPositionContentSearcher  {
  * @param rootNode The root node of current scope
  * @param node The node to get InlineElement from
  */
-function getInlineElementAtNode(rootNode: Node, node: Node): InlineElement;
+function getInlineElementAtNode(rootNode: Node, node: Node | null): InlineElement;
 
     /**
  * Get the inline element at a node
  * @param parentBlock Parent BlockElement of this node
  * @param node The node to get InlineElement from
  */
-function getInlineElementAtNode(parentBlock: BlockElement, node: Node): InlineElement;
+function getInlineElementAtNode(parentBlock: BlockElement, node: Node | null): InlineElement;
 
     /**
  * This is an inline element representing an Html image
@@ -4668,9 +4752,9 @@ class NodeInlineElement implements InlineElement  {
  */
 class PartialInlineElement implements InlineElement  {
     private inlineElement;
-    private start?;
-    private end?;
-    constructor(inlineElement: InlineElement, start?: NodePosition, end?: NodePosition);
+    private start;
+    private end;
+    constructor(inlineElement: InlineElement, start?: NodePosition | null, end?: NodePosition | null);
     /**
      * Get the full inline element that this partial inline decorates
      */
@@ -4698,11 +4782,11 @@ class PartialInlineElement implements InlineElement  {
     /**
      * Get next partial inline element if it is not at the end boundary yet
      */
-    get nextInlineElement(): PartialInlineElement;
+    get nextInlineElement(): PartialInlineElement | null;
     /**
      * Get previous partial inline element if it is not at the begin boundary yet
      */
-    get previousInlineElement(): PartialInlineElement;
+    get previousInlineElement(): PartialInlineElement | null;
     /**
      * Checks if it contains a position
      */
@@ -4725,8 +4809,8 @@ class PartialInlineElement implements InlineElement  {
  * Apply style using a styler function to the given container node in the given range
  * @param container The container node to apply style to
  * @param styler The styler function
- * @param from From position
- * @param to To position
+ * @param fromPosition From position
+ * @param toPosition To position
  */
 function applyTextStyle(container: Node, styler: (node: HTMLElement, isInnerNode?: boolean) => any, from?: NodePosition, to?: NodePosition): void;
 
@@ -4840,7 +4924,7 @@ function collapseNodes(root: Node, start: Node, end: Node, canSplitParent: boole
  * @returns True if contained is inside container, or they are the same node when treatSameNodeAsContain is true.
  * Otherwise false.
  */
-function contains(container: Node | null, contained: Node | null, treatSameNodeAsContain?: boolean): boolean;
+function contains(container: Node | null | undefined, contained: Node | null | undefined, treatSameNodeAsContain?: boolean): boolean;
 
     /**
  * Test if a node contains a given range
@@ -4848,7 +4932,7 @@ function contains(container: Node | null, contained: Node | null, treatSameNodeA
  * @param contained The range to check if it is inside container
  * @returns True if contained is inside container, otherwise false
  */
-function contains(container: Node | null, contained: Range | null): boolean;
+function contains(container: Node | null | undefined, contained: Range | null | undefined): boolean;
 
     /**
  * Find closest element ancestor start from the given node which matches the given selector
@@ -4910,7 +4994,7 @@ type PendableFormatNames = keyof PendableFormatState;
  * @param node The node to get tag of
  * @returns Tag name in upper case if the given node is an Element, or empty string otherwise
  */
-function getTagOfNode(node: Node): string;
+function getTagOfNode(node: Node | null): string;
 
     /**
  * Checks if the node is a block like element. Block like element are usually those P, DIV, LI, TD etc.
@@ -4955,7 +5039,7 @@ function matchLink(url: string): LinkData | null;
  * @param range The selection range to query with. This is required when scope is not Body
  * @returns HTML Element array of the query result
  */
-function queryElements(container: ParentNode, selector: string, forEachCallback?: (node: HTMLElement) => any, scope?: QueryScope, range?: Range): HTMLElement[];
+function queryElements(container: ParentNode, selector: string, forEachCallback?: ((node: HTMLElement) => any) | null, scope?: QueryScope, range?: Range): HTMLElement[];
 
     /**
  * Split parent node of the given node before/after the given node.
@@ -5162,23 +5246,23 @@ class VTable {
     /**
      * Virtual cells
      */
-    cells: VCell[][];
+    cells: VCell[][] | null;
     /**
      * Current row index
      */
-    row: number;
+    row: number | undefined;
     /**
      * Current column index
      */
-    col: number;
+    col: number | undefined;
     /**
      * Selected range of cells with the coordinates of the first and last cell selected.
      */
-    selection: TableSelection;
+    selection: TableSelection | null;
     /**
      * Current format of the table
      */
-    formatInfo: Required<TableFormat>;
+    formatInfo: Required<TableFormat> | null;
     private trs;
     /**
      * Create a new instance of VTable object using HTML TABLE or TD node
@@ -5208,6 +5292,8 @@ class VTable {
      * @param operation Table operation
      */
     edit(operation: TableOperation): void;
+    setAlignmentToSelectedCells(firstRow: number, lastRow: number, firstColumn: number, lastColumn: number, alignmentType: string, isVertical?: boolean): void;
+    private mergeCells;
     /**
      * Loop each cell of current column and invoke a callback function
      * @param callback The callback function to invoke
@@ -5253,13 +5339,13 @@ class VTable {
     /**
      * Get current HTML table cell object. If the current table cell is a virtual expanded cell, return its root cell
      */
-    getCurrentTd(): HTMLTableCellElement;
+    getCurrentTd(): HTMLTableCellElement | null;
     /**
      * Get the Table Cell in a provided coordinate
      * @param row row of the cell
      * @param col column of the cell
      */
-    getTd(row: number, col: number): HTMLTableCellElement;
+    getTd(row: number | undefined, col: number | undefined): HTMLTableCellElement | null;
     private forEachCellOfColumn;
     private forEachCellOfRow;
     private recalculateSpans;
@@ -5270,6 +5356,14 @@ class VTable {
     private normalizeSize;
 }
 
+    /**
+ * Check if the whole table is selected
+ * @param vTable VTable to check whether all cells are selected
+ * @param selection Table selection with first cell selected and last cell selected coordinates.
+ * @returns
+ */
+function isWholeTableSelected(vTable: VTable, selection: TableSelection): boolean;
+
     /**
  * Represent a bullet or a numbering list
  *
@@ -5354,8 +5448,10 @@ class VList {
      * @param indentation Specify to outdent
      * @param softOutdent (Optional) True to make the item to by dummy (no bullet or number) if the item is not dummy,
      * otherwise outdent the item
+     * @param preventItemRemoval (Optional) True to prevent the indentation to remove the bullet when outdenting a first
+     * level list item, by default is false
      */
-    setIndentation(start: NodePosition, end: NodePosition, indentation: Indentation.Decrease, softOutdent?: boolean): void;
+    setIndentation(start: NodePosition, end: NodePosition, indentation: Indentation.Decrease, softOutdent?: boolean, preventItemRemoval?: boolean): void;
     /**
      * Change list type of the given range of this list.
      * If some of the items are not real list item yet, this will make them to be list item with given type
@@ -5382,6 +5478,25 @@ class VList {
     mergeVList(list: VList): void;
     /**
      * Get the index of the List Item in the current List
+     * If the root list is:
+     * Ordered list, the listIndex start count is going to be the start property of the OL - 1,
+     * @example For example if we want to find the index of Item 2 in the list below, the returned index is going to be 6
+     *  * ```html
+     * <ol start="5">
+     *   <li>item 1</li>
+     *   <li>item 2</li> <!-- Node to find -->
+     *   <li>item 3</li>
+     * </ol>
+     * ```
+     * Unordered list, the listIndex start count starts from 0
+     * @example For example if we want to find the index of Item 2 in the list below, the returned index is going to be 2
+     * ```html
+     * <ul>
+     *   <li>item 1</li>
+     *   <li>item 2</li> <!-- Node to find -->
+     *   <li>item 3</li>
+     * </ul>
+     * ```
      * @param input List item to find in the root list
      */
     getListItemIndex(input: Node): number;
@@ -5462,8 +5577,13 @@ class VListItem {
     /**
      * Outdent this item
      * If this item is already not an list item, it will be no op
+     * @param preventItemRemoval Whether prevent the list item to be removed for the listItem by default false
      */
-    outdent(): void;
+    outdent(preventItemRemoval?: boolean): void;
+    /**
+     * Add negative margin to the List item
+     */
+    addNegativeMargins(): void;
     /**
      * Change list type of this item
      * @param targetType The target list type to change to
@@ -5495,7 +5615,7 @@ class VListItem {
  * @param startNode (Optional) When specified, try get VList which will contain this node.
  * If not specified, get VList from selection of this region
  */
-function createVListFromRegion(region: Region, includeSiblingLists?: boolean, startNode?: Node): VList;
+function createVListFromRegion(region: Region, includeSiblingLists?: boolean, startNode?: Node): VList | null;
 
     /**
  * Represent a chain of list nodes.
@@ -5524,7 +5644,7 @@ class VListChain {
      * @param container The container node to create list at
      * @param startNumber Start number of the new list
      */
-    createVListAtBlock(container: Node, startNumber: number): VList;
+    createVListAtBlock(container: Node, startNumber: number): VList | null;
     /**
      * 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
@@ -5725,7 +5845,7 @@ function getPositionRect(position: NodePosition): Rect | null;
  * @param targetNode The node to check
  * @returns True if position is at beginning of the node, otherwise false
  */
-function isPositionAtBeginningOf(position: NodePosition, targetNode: Node): boolean;
+function isPositionAtBeginningOf(position: NodePosition, targetNode: Node | null): boolean;
 
     /**
  * Get path of the given selection range related to the given rootNode
@@ -5744,14 +5864,26 @@ function getSelectionPath(rootNode: Node, range: Range | null): SelectionPath |
 function getHtmlWithSelectionPath(rootNode: HTMLElement | DocumentFragment, range: Range): string;
 
     /**
- * Restore inner Html of a root element from given html string. If the string contains selection path,
+ * @deprecated Use setHtmlWithMetadata instead
+ * Restore inner HTML of a root element from given html string. If the string contains selection path,
  * remove the selection path and return a range represented by the path
  * @param root The root element
- * @param html The html to restore
+ * @param html The HTML to restore
+ * @param trustedHTMLHandler An optional trusted HTML handler to convert HTML string to security string
  * @returns A selection range if the html contains a valid selection path, otherwise null
  */
 function setHtmlWithSelectionPath(rootNode: HTMLElement, html: string, trustedHTMLHandler?: TrustedHTMLHandler): Range | null;
 
+    /**
+ * Restore inner HTML of a root element from given html string. If the string contains metadata,
+ * remove it from DOM tree and return the metadata
+ * @param root The root element
+ * @param html The HTML to restore
+ * @param trustedHTMLHandler An optional trusted HTML handler to convert HTML string to security string
+ * @returns Content metadata if any, or undefined
+ */
+function setHtmlWithMetadata(rootNode: HTMLElement, html: string, trustedHTMLHandler?: TrustedHTMLHandler): ContentMetadata | undefined;
+
     /**
  * Add the given range into selection of the given document
  * @param range The range to select
@@ -5764,10 +5896,28 @@ function addRangeToSelection(range: Range, skipSameRange?: boolean): void;
     /**
  * Add a new snapshot to the given snapshots data structure
  * @param snapshots The snapshots data structure to add new snapshot into
- * @param snapshot The snapshot to add
+ * @param html The snapshot HTML to add
+ * @param isAutoCompleteSnapshot Whether this is a snapshot before auto complete action
+ */
+function addSnapshot(snapshots: Snapshots<string>, html: string, isAutoCompleteSnapshot: boolean): void;
+
+    /**
+ * Add a new snapshot to the given snapshots data structure
+ * @param snapshots The snapshots data structure to add new snapshot into
+ * @param snapshot The generic snapshot object to add
  * @param isAutoCompleteSnapshot Whether this is a snapshot before auto complete action
+ * @param getLength A callback function to calculate length of the snapshot
+ * @param isSame A callback function to check if the given snapshots are the same
  */
-function addSnapshot(snapshots: Snapshots, snapshot: string, isAutoCompleteSnapshot: boolean): void;
+function addSnapshot<T>(snapshots: Snapshots<T>, snapshot: T, isAutoCompleteSnapshot: boolean, getLength: (snapshot: T) => number, isSame: (snapshot1: T, snapshot2: T) => boolean): void;
+
+    /**
+ * Add a new snapshot to the given snapshots data structure
+ * @param snapshots The snapshots data structure to add new snapshot into
+ * @param snapshot The snapshot object to add
+ * @param isAutoCompleteSnapshot Whether this is a snapshot before auto complete action
+ */
+function addSnapshotV2(snapshots: Snapshots<Snapshot>, snapshot: Snapshot, isAutoCompleteSnapshot: boolean): void;
 
     /**
  * Check whether can move current snapshot with the given step
@@ -5775,13 +5925,25 @@ function addSnapshot(snapshots: Snapshots, snapshot: string, isAutoCompleteSnaps
  * @param step The step to check, can be positive, negative or 0
  * @returns True if can move current snapshot with the given step, otherwise false
  */
-function canMoveCurrentSnapshot(snapshots: Snapshots, step: number): boolean;
+function canMoveCurrentSnapshot<T = string>(snapshots: Snapshots<T>, step: number): boolean;
+
+    /**
+ * Clear all snapshots after the current one
+ * @param snapshots The snapshots data structure to clear
+ */
+function clearProceedingSnapshots(snapshots: Snapshots<string>): void;
 
     /**
  * Clear all snapshots after the current one
  * @param snapshots The snapshots data structure to clear
  */
-function clearProceedingSnapshots(snapshots: Snapshots): void;
+function clearProceedingSnapshots<T>(snapshots: Snapshots<T>, getLength: (snapshot: T) => number): void;
+
+    /**
+ * Clear all snapshots after the current one
+ * @param snapshots The snapshots data structure to clear
+ */
+function clearProceedingSnapshotsV2(snapshots: Snapshots<Snapshot>): void;
 
     /**
  * Move current snapshot with the given step if can move this step. Otherwise no action and return null
@@ -5789,7 +5951,7 @@ function clearProceedingSnapshots(snapshots: Snapshots): void;
  * @param step The step to move
  * @returns If can move with the given step, returns the snapshot after move, otherwise null
  */
-function moveCurrentSnapshot(snapshots: Snapshots, step: number): string | null;
+function moveCurrentSnapshot<T = string>(snapshots: Snapshots<T>, step: number): T | null;
 
     /**
  * @deprecated
@@ -5801,12 +5963,12 @@ const moveCurrentSnapsnot: typeof moveCurrentSnapshot;
  * Create initial snapshots
  * @param maxSize max size of all snapshots
  */
-function createSnapshots(maxSize: number): Snapshots;
+function createSnapshots<T = string>(maxSize: number): Snapshots<T>;
 
     /**
  * Whether there is a snapshot added before auto complete and it can be undone now
  */
-function canUndoAutoComplete(snapshots: Snapshots): boolean;
+function canUndoAutoComplete<T = string>(snapshots: Snapshots<T>): boolean;
 
     /**
  * HTML sanitizer class provides two features:
@@ -5985,7 +6147,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): Position;
+function deleteSelectedContent(root: HTMLElement, range: Range): null;
 
     /**
  * get block element's text content.
@@ -6303,6 +6465,11 @@ class Editor implements IEditor  {
      * @returns True if the editor is in dark mode, otherwise false
      */
     isDarkMode(): boolean;
+    /**
+     * Transform the given node and all its child nodes to dark mode color if editor is in dark mode
+     * @param node The node to transform
+     */
+    transformToDarkColor(node: Node): void;
     /**
      * Make the editor in "Shadow Edit" mode.
      * In Shadow Edit mode, all format change will finally be ignored.
@@ -7325,6 +7492,7 @@ class TableCellSelection implements EditorPlugin  {
     private vTable;
     private firstTable;
     private targetTable;
+    private preventKeyUp;
     constructor();
     /**
      * Get a friendly name of  this plugin