roosterjs 8.22.1 → 8.24.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.22.1)
+// Type definitions for roosterjs (Version 8.24.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -391,9 +391,10 @@ export const Browser: BrowserInfo;
  * Get current browser information from user agent string
  * @param userAgent The userAgent string of a browser
  * @param appVersion The appVersion string of a browser
+ * @param vendor The vendor string of a browser
  * @returns The BrowserInfo object calculated from the given userAgent and appVersion
  */
-export function getBrowserInfo(userAgent: string, appVersion: string): BrowserInfo;
+export function getBrowserInfo(userAgent: string, appVersion: string, vendor?: string): BrowserInfo;
 
 /**
  * Apply format to an HTML element
@@ -985,6 +986,12 @@ export class VList {
      * @param targetType Target list type
      */
     changeListType(start: NodePosition, end: NodePosition, targetType: ListType | CompatibleListType): void;
+    /**
+     * Change list style 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 style
+     * @param targetStyle Target list style
+     */
+    setListStyleType(targetStyle: NumberingListType | BulletListType | CompatibleBulletListType | CompatibleNumberingListType): void;
     /**
      * Append a new item to this VList
      * @param node node of the item to append. If it is not wrapped with LI tag, it will be wrapped
@@ -1123,6 +1130,12 @@ export class VListItem {
      * @param isDummy Whether the item is a dummy item
      */
     setNewListStart(startNumber: number): void;
+    /**
+     * Apply the list style type
+     * @param rootList the vList that receives the style
+     * @param index the list item index
+     */
+    applyListStyle(rootList: HTMLOListElement | HTMLUListElement, index: number): void;
     /**
      * Write the change result back into DOM
      * @param listStack current stack of list elements
@@ -1697,6 +1710,88 @@ export function deleteSelectedContent(root: HTMLElement, range: Range): null;
  */
 export function getTextContent(rootNode: Node): string;
 
+/**
+ * Validate the given object with a type definition object
+ * @param input The object to validate
+ * @param def The type definition object used for validation
+ * @returns True if the object passed the validation, otherwise false
+ */
+export function validate<T>(input: any, def: Definition<T>): input is T;
+
+/**
+ * Create a number definition
+ * @param isOptional Whether this property is optional
+ * @param value Optional value of the number
+ * @param minValue Optional minimum value
+ * @param maxValue Optional maximum value
+ * @param allowNull Allow the property to be null
+ * @returns The number definition object
+ */
+export function createNumberDefinition(isOptional?: boolean, value?: number, minValue?: number, maxValue?: number, allowNull?: boolean): NumberDefinition;
+
+/**
+ * Create a boolean definition
+ * @param isOptional  Whether this property is optional
+ * @param value Optional expected boolean value
+ * @param allowNull Allow the property to be null
+ * @returns  The boolean definition object
+ */
+export function createBooleanDefinition(isOptional?: boolean, value?: boolean, allowNull?: boolean): BooleanDefinition;
+
+/**
+ * Create a string definition
+ * @param isOptional  Whether this property is optional
+ * @param value Optional expected string value
+ * @param allowNull Allow the property to be null
+ * @returns  The string definition object
+ */
+export function createStringDefinition(isOptional?: boolean, value?: string, allowNull?: boolean): StringDefinition;
+
+/**
+ * Create an array definition
+ * @param itemDef Definition of each item of the related array
+ * @param isOptional  Whether this property is optional
+ * @param allowNull Allow the property to be null
+ * @returns  The array definition object
+ */
+export function createArrayDefinition<T>(itemDef: Definition<T>, isOptional?: boolean, minLength?: number, maxLength?: number, allowNull?: boolean): ArrayDefinition<T[]>;
+
+/**
+ * Create an object definition
+ * @param propertyDef Definition of each property of the related object
+ * @param isOptional  Whether this property is optional
+ * @param allowNull Allow the property to be null
+ * @returns  The object definition object
+ */
+export function createObjectDefinition<T extends Object>(propertyDef: ObjectPropertyDefinition<T>, isOptional?: boolean, allowNull?: boolean): ObjectDefinition<T>;
+
+/**
+ * Get metadata object from an HTML element
+ * @param element The HTML element to get metadata object from
+ * @param definition The type definition of this metadata used for validate this metadata object.
+ * If not specified, no validation will be performed and always return whatever we get from the element
+ * @param defaultValue The default value to return if the retrieved object cannot pass the validation,
+ * or there is no metadata object at all
+ * @returns The strong-type metadata object if it can be validated, or null
+ */
+export function getMetadata<T>(element: HTMLElement, definition?: Definition<T>, defaultValue?: T): T | null;
+
+/**
+ * Set metadata object into an HTML element
+ * @param element The HTML element to set metadata object to
+ * @param metadata The metadata object to set
+ * @param def An optional type definition object used for validate this metadata object.
+ * If not specified, metadata will be set without validation
+ * @returns True if metadata is set, otherwise false
+ */
+export function setMetadata<T>(element: HTMLElement, metadata: T, def?: Definition<T>): boolean;
+
+/**
+ * Remove metadata from the given element if any
+ * @param element The element to remove metadata from
+ */
+export function removeMetadata(element: HTMLElement): void;
+
 /**
  * RoosterJs core editor class
  */
@@ -1872,7 +1967,7 @@ export class Editor implements IEditor  {
      * @returns the event object which is really passed into plugins. Some plugin may modify the event object so
      * the result of this function provides a chance to read the modified result
      */
-    triggerPluginEvent<T extends PluginEventType>(eventType: T, data: PluginEventData<T>, broadcast?: boolean): PluginEventFromType<T>;
+    triggerPluginEvent<T extends PluginEventType | CompatiblePluginEventType>(eventType: T, data: PluginEventData<T>, broadcast?: boolean): PluginEventFromType<T>;
     /**
      * Trigger a ContentChangedEvent
      * @param source Source of this event, by default is 'SetContent'
@@ -2143,15 +2238,17 @@ export function insertEntity(editor: IEditor, type: string, contentNode: Node, i
  * @param editor The editor instance
  * @param imageFile The image file. There are at least 3 ways to obtain the file object:
  * From local file, from clipboard data, from drag-and-drop
+ * @param attributes Optional image element attributes
  */
-export function insertImage(editor: IEditor, imageFile: File): void;
+export function insertImage(editor: IEditor, imageFile: File, attributes?: Record<string, string>): void;
 
 /**
  * Insert an image to editor at current selection
  * @param editor The editor instance
- * @param imageFile The image link.
+ * @param url The image link
+ * @param attributes Optional image element attributes
  */
-export function insertImage(editor: IEditor, url: string): void;
+export function insertImage(editor: IEditor, url: string, attributes?: Record<string, string>): void;
 
 /**
  * Insert table into editor at current selection
@@ -2321,8 +2418,9 @@ export function toggleBold(editor: IEditor): void;
  * If selection contains both bullet/numbering and normal text, the behavior is decided by corresponding
  * browser execCommand API
  * @param editor The editor instance
+ * @param listStyle (Optional) the style of the bullet list. If not defined, the style will be set to disc.
  */
-export function toggleBullet(editor: IEditor): void;
+export function toggleBullet(editor: IEditor, listStyle?: BulletListType | CompatibleBulletListType): void;
 
 /**
  * Toggle italic at selection
@@ -2342,8 +2440,9 @@ export function toggleItalic(editor: IEditor): void;
  * realization of browser execCommand API
  * @param editor The editor instance
  * @param startNumber (Optional) Start number of the list
+ * @param listStyle (Optional) The style of the numbering list. If not defined, the style will be set to decimal.
  */
-export function toggleNumbering(editor: IEditor, startNumber?: number): void;
+export function toggleNumbering(editor: IEditor, startNumber?: number, listStyle?: NumberingListType | CompatibleNumberingListType): void;
 
 /**
  * Resets Ordered List Numbering back to the value of the parameter startNumber
@@ -2445,8 +2544,9 @@ export function applyCellShading(editor: IEditor, color: string | ModeIndependen
  * @param listType The list type to toggle
  * @param startNumber (Optional) Start number of the list
  * @param includeSiblingLists Sets wether the operation should include Sibling Lists, by default true
+ * @param listStyle (Optional) the style of an ordered or unordered list. If If not defined, the style will be set to disc or decimal.
  */
-export function toggleListType(editor: IEditor, listType: ListType | CompatibleListType, startNumber?: number, includeSiblingLists?: boolean): void;
+export function toggleListType(editor: IEditor, listType: ListType | CompatibleListType, startNumber?: number, includeSiblingLists?: boolean, listStyle?: BulletListType | NumberingListType | CompatibleBulletListType | CompatibleNumberingListType): void;
 
 /**
  * Split selection into regions, and perform a block-wise formatting action for each region.
@@ -2514,6 +2614,10 @@ export interface BrowserInfo {
      * Whether current OS is Android
      */
     readonly isAndroid?: boolean;
+    /**
+     * Whether current browser is on mobile or a tablet
+     */
+    readonly isMobileOrTablet?: boolean;
 }
 
 /**
@@ -3364,7 +3468,16 @@ export const enum ExperimentalFeatures {
     /**
      * Align list elements elements to left, center and right using setAlignment API
      */
-    ListItemAlignment = "ListItemAlignment"
+    ListItemAlignment = "ListItemAlignment",
+    /**
+     * Trigger formatting by a especial characters. Ex: (A), 1. i).
+     */
+    AutoFormatList = "AutoFormatList",
+    /**
+     * @deprecated this feature is always disabled
+     * Automatically transform -- into hyphen, if typed between two words.
+     */
+    AutoHyphen = "AutoHyphen"
 }
 
 /**
@@ -3916,6 +4029,152 @@ export const enum SelectionRangeTypes {
     TableSelection = 1
 }
 
+/**
+ *  Enum used to control the different types of numbering list
+ */
+export const enum NumberingListType {
+    /**
+     * Numbering triggered by 1.
+     */
+    Decimal = 0,
+    /**
+     * Numbering triggered by 1-
+     */
+    DecimalDash = 1,
+    /**
+     * Numbering triggered by 1)
+     */
+    DecimalParenthesis = 2,
+    /**
+     * Numbering triggered by (1)
+     */
+    DecimalDoubleParenthesis = 3,
+    /**
+     * Numbering triggered by a.
+     */
+    LowerAlpha = 4,
+    /**
+     * Numbering triggered by a)
+     */
+    LowerAlphaParenthesis = 5,
+    /**
+     * Numbering triggered by (a)
+     */
+    LowerAlphaDoubleParenthesis = 6,
+    /**
+     * Numbering triggered by a-
+     */
+    LowerAlphaDash = 7,
+    /**
+     * Numbering triggered by A.
+     */
+    UpperAlpha = 8,
+    /**
+     * Numbering triggered by A)
+     */
+    UpperAlphaParenthesis = 9,
+    /**
+     * Numbering triggered by (A)
+     */
+    UpperAlphaDoubleParenthesis = 10,
+    /**
+     * Numbering triggered by A-
+     */
+    UpperAlphaDash = 11,
+    /**
+     * Numbering triggered by i.
+     */
+    LowerRoman = 12,
+    /**
+     * Numbering triggered by i)
+     */
+    LowerRomanParenthesis = 13,
+    /**
+     * Numbering triggered by (i)
+     */
+    LowerRomanDoubleParenthesis = 14,
+    /**
+     * Numbering triggered by i-
+     */
+    LowerRomanDash = 15,
+    /**
+     * Numbering triggered by I.
+     */
+    UpperRoman = 16,
+    /**
+     * Numbering triggered by I)
+     */
+    UpperRomanParenthesis = 17,
+    /**
+     * Numbering triggered by (I)
+     */
+    UpperRomanDoubleParenthesis = 18,
+    /**
+     * Numbering triggered by I-
+     */
+    UpperRomanDash = 19
+}
+
+/**
+ *  Enum used to control the different types of bullet list
+ */
+export const enum BulletListType {
+    /**
+     * Bullet triggered by *
+     */
+    Disc = 0,
+    /**
+     * Bullet triggered by -
+     */
+    Dash = 1,
+    /**
+     * Bullet triggered by --
+     */
+    Square = 2,
+    /**
+     * Bullet triggered by >
+     */
+    ShortArrow = 3,
+    /**
+     * Bullet triggered by -> or -->
+     */
+    LongArrow = 4,
+    /**
+     * Bullet triggered by =>
+     */
+    UnfilledArrow = 5
+}
+
+/**
+ * Types of definitions, used by Definition type
+ */
+export const enum DefinitionType {
+    /**
+     * Boolean type definition, represents a boolean type value
+     */
+    Boolean = 0,
+    /**
+     * Number type definition, represents a number type value
+     */
+    Number = 1,
+    /**
+     * String type definition, represents a string type value
+     */
+    String = 2,
+    /**
+     * Array type definition, represents an array with a given item type
+     */
+    Array = 3,
+    /**
+     * Object type definition, represents an object with the given property types
+     */
+    Object = 4,
+    /**
+     * Customize type definition, represents a customized type with a validator function
+     */
+    Customize = 5
+}
+
 /**
  * Provides a chance for plugin to change the content before it is copied from editor.
  */
@@ -3941,7 +4200,7 @@ export interface BeforeCutCopyEvent extends BasePluginEvent<PluginEventType.Befo
 /**
  * Editor plugin event interface
  */
-export interface BasePluginEvent<T extends PluginEventType> {
+export interface BasePluginEvent<T extends PluginEventType | CompatiblePluginEventType> {
     /**
      * Type of this event
      */
@@ -4108,7 +4367,7 @@ export type PluginDomEvent = PluginCompositionEvent | PluginMouseEvent | PluginK
 /**
  * A base interface of all DOM events
  */
-export interface PluginDomEventBase<TEventType extends PluginEventType, TRawEvent extends Event> extends BasePluginEvent<TEventType> {
+export interface PluginDomEventBase<TEventType extends PluginEventType | CompatiblePluginEventType, TRawEvent extends Event> extends BasePluginEvent<TEventType> {
     rawEvent: TRawEvent;
 }
 
@@ -4195,24 +4454,24 @@ export type PluginEvent = BeforeCutCopyEvent | BeforePasteEvent | ContentChanged
 /**
  * A type to extract data part of a plugin event type. Data part is the plugin event without eventType field.
  */
-export type PluginEventData<T extends PluginEventType> = PluginEventDataGeneric<PluginEvent, T>;
+export type PluginEventData<T extends PluginEventType | CompatiblePluginEventType> = PluginEventDataGeneric<PluginEvent, T>;
 
 /**
  * A type to extract data part of a plugin event type. Data part is the plugin event without eventType field.
  * This type is a middle result and only used by PluginEventData type
  */
-export type PluginEventDataGeneric<E extends PluginEvent, T extends PluginEventType> = E extends BasePluginEvent<T> ? Pick<E, Exclude<keyof E, 'eventType'>> : never;
+export type PluginEventDataGeneric<E extends PluginEvent, T extends PluginEventType | CompatiblePluginEventType> = E extends BasePluginEvent<T> ? Pick<E, Exclude<keyof E, 'eventType'>> : never;
 
 /**
  * A type to get specify plugin event type from eventType parameter.
  */
-export type PluginEventFromType<T extends PluginEventType> = PluginEventFromTypeGeneric<PluginEvent, T>;
+export type PluginEventFromType<T extends PluginEventType | CompatiblePluginEventType> = PluginEventFromTypeGeneric<PluginEvent, T>;
 
 /**
  * A type to get specify plugin event type from eventType parameter.
  * This type is a middle result and only used by PluginEventFromType type
  */
-export type PluginEventFromTypeGeneric<E extends PluginEvent, T extends PluginEventType> = E extends BasePluginEvent<T> ? E : never;
+export type PluginEventFromTypeGeneric<E extends PluginEvent, T extends PluginEventType | CompatiblePluginEventType> = E extends BasePluginEvent<T> ? E : never;
 
 /**
  * A plugin triggered right after editor has entered Shadow Edit mode
@@ -5549,7 +5808,7 @@ export interface IEditor {
      * @returns the event object which is really passed into plugins. Some plugin may modify the event object so
      * the result of this function provides a chance to read the modified result
      */
-    triggerPluginEvent<T extends PluginEventType>(eventType: T, data: PluginEventData<T>, broadcast?: boolean): PluginEventFromType<T>;
+    triggerPluginEvent<T extends PluginEventType | CompatiblePluginEventType>(eventType: T, data: PluginEventData<T>, broadcast?: boolean): PluginEventFromType<T>;
     /**
      * Trigger a ContentChangedEvent
      * @param source Source of this event, by default is 'SetContent'
@@ -6573,6 +6832,12 @@ export interface TextFeatureSettings {
      *      If Whole Paragraph selected, outdent paragraph
      */
     outdentWhenTabText: boolean;
+    /**
+     * @deprecated
+     * Requires @see ExperimentalFeatures.AutoHyphen to be enabled
+     * Automatically transform -- into hyphen, if typed between two words.
+     */
+    autoHyphen: boolean;
 }
 
 /**
@@ -6615,7 +6880,7 @@ export interface UndoSnapshotsService<T = string> {
      * @param step The step to move
      * @returns If can move with the given step, returns the snapshot after move, otherwise null
      */
-    move(step: number): T;
+    move(step: number): T | null;
     /**
      * Add a new undo snapshot
      * @param snapshot The snapshot to add
@@ -6961,7 +7226,7 @@ export interface DOMEventHandlerObject {
 /**
  * Combined event handler type with all 3 possibilities
  */
-export type DOMEventHandler = PluginEventType | DOMEventHandlerFunction | DOMEventHandlerObject;
+export type DOMEventHandler = PluginEventType | CompatiblePluginEventType | DOMEventHandlerFunction | DOMEventHandlerObject;
 
 /**
  * A handler type to convert HTML string to a trust HTML string
@@ -6977,6 +7242,120 @@ export type TrustedHTMLHandler = (html: string) => string;
  */
 export type SizeTransformer = (size: number) => number;
 
+/**
+ * A type template to get item type of an array
+ */
+export type ArrayItemType<T extends any[]> = T extends (infer U)[] ? U : never;
+
+/**
+ * Base interface of property definition
+ */
+export interface DefinitionBase<T extends DefinitionType | CompatibleDefinitionType> {
+    /**
+     * Type of this property
+     */
+    type: T;
+    /**
+     * Whether this property is optional
+     */
+    isOptional?: boolean;
+    /**
+     * Whether this property is allowed to be null
+     */
+    allowNull?: boolean;
+}
+
+/**
+ * String property definition. This definition can also be used for string based enum property
+ */
+export interface StringDefinition extends DefinitionBase<DefinitionType.String | CompatibleDefinitionType.String> {
+    /**
+     * An optional value of this property. When specified, the given property must have exactly same value of this value
+     */
+    value?: string;
+}
+
+/**
+ * Number property definition. This definition can also be used for number based enum property
+ */
+export interface NumberDefinition extends DefinitionBase<DefinitionType.Number | CompatibleDefinitionType.Number> {
+    /**
+     * An optional value of this property. When specified, the given property must have same value of this value
+     */
+    value?: number;
+    /**
+     * An optional minimum value of this property. When specified, the given property must be greater or equal to this value
+     */
+    minValue?: number;
+    /**
+     * An optional maximum value of this property. When specified, the given property must be less or equal to this value
+     */
+    maxValue?: number;
+}
+
+/**
+ * Boolean property definition
+ */
+export interface BooleanDefinition extends DefinitionBase<DefinitionType.Boolean | CompatibleDefinitionType.Boolean> {
+    /**
+     * An optional value of this property. When specified, the given property must have same value of this value
+     */
+    value?: boolean;
+}
+
+/**
+ * Array property definition.
+ */
+export interface ArrayDefinition<T extends any[]> extends DefinitionBase<DefinitionType.Array | CompatibleDefinitionType.Array> {
+    /**
+     * Definition of each item of this array. All items of the given array must have the same type. Otherwise, use CustomizeDefinition instead.
+     */
+    itemDef: Definition<ArrayItemType<T>>;
+    /**
+     * An optional minimum length of this array. When specified, the given array must have at least this value of items
+     */
+    minLength?: number;
+    /**
+     * An optional maximum length of this array. When specified, the given array must have at most this value of items
+     */
+    maxLength?: number;
+}
+
+/**
+ * Object property definition.
+ */
+export interface ObjectDefinition<T extends Object> extends DefinitionBase<DefinitionType.Object | CompatibleDefinitionType.Object> {
+    /**
+     * A key-value map to specify the definition of each possible property of this object
+     */
+    propertyDef: ObjectPropertyDefinition<T>;
+}
+
+/**
+ * Object property definition type used by Object Definition
+ */
+export type ObjectPropertyDefinition<T extends Object> = {
+    [Key in keyof T]: Definition<T[Key]>;
+};
+
+/**
+ * Customize property definition. When all other property definition type cannot satisfy your requirement,
+ * use this definition with a customized validator function to do property validation.
+ */
+export interface CustomizeDefinition extends DefinitionBase<DefinitionType.Customize | CompatibleDefinitionType.Customize> {
+    /**
+     * The customized validator function to do customized validation
+     * @param input The value to validate
+     * @returns True means the given value is of the specified type, otherwise false
+     */
+    validator: (input: any) => boolean;
+}
+
+/**
+ * A combination of all definition types
+ */
+export type Definition<T> = CustomizeDefinition | (T extends any[] ? ArrayDefinition<T> : T extends Record<string, any> ? ObjectDefinition<T> : T extends String ? StringDefinition : T extends Number ? NumberDefinition : T extends Boolean ? BooleanDefinition : never);
+
 /**
  * Experimental feature flags
  */
@@ -7041,7 +7420,114 @@ export enum CompatibleExperimentalFeatures {
     /**
      * Align list elements elements to left, center and right using setAlignment API
      */
-    ListItemAlignment = "ListItemAlignment"
+    ListItemAlignment = "ListItemAlignment",
+    /**
+     * Trigger formatting by a especial characters. Ex: (A), 1. i).
+     */
+    AutoFormatList = "AutoFormatList",
+    /**
+     * @deprecated this feature is always disabled
+     * Automatically transform -- into hyphen, if typed between two words.
+     */
+    AutoHyphen = "AutoHyphen"
+}
+
+/**
+ * Editor plugin event type
+ */
+export enum CompatiblePluginEventType {
+    /**
+     * HTML KeyDown event
+     */
+    KeyDown = 0,
+    /**
+     * HTML KeyPress event
+     */
+    KeyPress = 1,
+    /**
+     * HTML KeyUp event
+     */
+    KeyUp = 2,
+    /**
+     * HTML Input / TextInput event
+     */
+    Input = 3,
+    /**
+     * HTML CompositionEnd event
+     */
+    CompositionEnd = 4,
+    /**
+     * HTML MouseDown event
+     */
+    MouseDown = 5,
+    /**
+     * HTML MouseUp event
+     */
+    MouseUp = 6,
+    /**
+     * Content changed event
+     */
+    ContentChanged = 7,
+    /**
+     * Extract Content with a DOM tree event
+     * This event is triggered when getContent() is called with triggerExtractContentEvent = true
+     * Plugin can handle this event to remove the UI only markups to return clean HTML
+     * by operating on a cloned DOM tree
+     */
+    ExtractContentWithDom = 8,
+    /**
+     * Before Paste event, provide a chance to change copied content
+     */
+    BeforeCutCopy = 9,
+    /**
+     * Before Paste event, provide a chance to change paste content
+     */
+    BeforePaste = 10,
+    /**
+     * Let plugin know editor is ready now
+     */
+    EditorReady = 11,
+    /**
+     * Let plugin know editor is about to dispose
+     */
+    BeforeDispose = 12,
+    /**
+     * Pending format state (bold, italic, underline, ... with collapsed selection) is changed
+     */
+    PendingFormatStateChanged = 13,
+    /**
+     * Scroll event triggered by scroll container
+     */
+    Scroll = 14,
+    /**
+     * Operating on an entity. See enum EntityOperation for more details about each operation
+     */
+    EntityOperation = 15,
+    /**
+     * HTML ContextMenu event
+     */
+    ContextMenu = 16,
+    /**
+     * Editor has entered shadow edit mode
+     */
+    EnteredShadowEdit = 17,
+    /**
+     * Editor is about to leave shadow edit mode
+     */
+    LeavingShadowEdit = 18,
+    /**
+     * Content of image is being changed from client side
+     */
+    EditImage = 19,
+    /**
+     * Content of editor is about to be cleared by SetContent API, handle this event to cache anything you need
+     * before it is gone
+     */
+    BeforeSetContent = 20,
+    /**
+     * Zoom scale value is changed, triggered by Editor.setZoomScale() when set a different scale number
+     */
+    ZoomChanged = 21
 }
 
 /**
@@ -7355,101 +7841,33 @@ export enum CompatibleSelectionRangeTypes {
 }
 
 /**
- * Editor plugin event type
+ * Types of definitions, used by Definition type
  */
-export enum CompatiblePluginEventType {
+export enum CompatibleDefinitionType {
     /**
-     * HTML KeyDown event
+     * Boolean type definition, represents a boolean type value
      */
-    KeyDown = 0,
+    Boolean = 0,
     /**
-     * HTML KeyPress event
+     * Number type definition, represents a number type value
      */
-    KeyPress = 1,
+    Number = 1,
     /**
-     * HTML KeyUp event
+     * String type definition, represents a string type value
      */
-    KeyUp = 2,
+    String = 2,
     /**
-     * HTML Input / TextInput event
+     * Array type definition, represents an array with a given item type
      */
-    Input = 3,
+    Array = 3,
     /**
-     * HTML CompositionEnd event
+     * Object type definition, represents an object with the given property types
      */
-    CompositionEnd = 4,
+    Object = 4,
     /**
-     * HTML MouseDown event
+     * Customize type definition, represents a customized type with a validator function
      */
-    MouseDown = 5,
-    /**
-     * HTML MouseUp event
-     */
-    MouseUp = 6,
-    /**
-     * Content changed event
-     */
-    ContentChanged = 7,
-    /**
-     * Extract Content with a DOM tree event
-     * This event is triggered when getContent() is called with triggerExtractContentEvent = true
-     * Plugin can handle this event to remove the UI only markups to return clean HTML
-     * by operating on a cloned DOM tree
-     */
-    ExtractContentWithDom = 8,
-    /**
-     * Before Paste event, provide a chance to change copied content
-     */
-    BeforeCutCopy = 9,
-    /**
-     * Before Paste event, provide a chance to change paste content
-     */
-    BeforePaste = 10,
-    /**
-     * Let plugin know editor is ready now
-     */
-    EditorReady = 11,
-    /**
-     * Let plugin know editor is about to dispose
-     */
-    BeforeDispose = 12,
-    /**
-     * Pending format state (bold, italic, underline, ... with collapsed selection) is changed
-     */
-    PendingFormatStateChanged = 13,
-    /**
-     * Scroll event triggered by scroll container
-     */
-    Scroll = 14,
-    /**
-     * Operating on an entity. See enum EntityOperation for more details about each operation
-     */
-    EntityOperation = 15,
-    /**
-     * HTML ContextMenu event
-     */
-    ContextMenu = 16,
-    /**
-     * Editor has entered shadow edit mode
-     */
-    EnteredShadowEdit = 17,
-    /**
-     * Editor is about to leave shadow edit mode
-     */
-    LeavingShadowEdit = 18,
-    /**
-     * Content of image is being changed from client side
-     */
-    EditImage = 19,
-    /**
-     * Content of editor is about to be cleared by SetContent API, handle this event to cache anything you need
-     * before it is gone
-     */
-    BeforeSetContent = 20,
-    /**
-     * Zoom scale value is changed, triggered by Editor.setZoomScale() when set a different scale number
-     */
-    ZoomChanged = 21
+    Customize = 5
 }
 
 /**
@@ -7470,6 +7888,36 @@ export enum CompatibleAlignment {
     Right = 2
 }
 
+/**
+ *  Enum used to control the different types of bullet list
+ */
+export enum CompatibleBulletListType {
+    /**
+     * Bullet triggered by *
+     */
+    Disc = 0,
+    /**
+     * Bullet triggered by -
+     */
+    Dash = 1,
+    /**
+     * Bullet triggered by --
+     */
+    Square = 2,
+    /**
+     * Bullet triggered by >
+     */
+    ShortArrow = 3,
+    /**
+     * Bullet triggered by -> or -->
+     */
+    LongArrow = 4,
+    /**
+     * Bullet triggered by =>
+     */
+    UnfilledArrow = 5
+}
+
 /**
  * The enum used for controlling the capitalization of text.
  * Used by changeCapitalization API
@@ -8074,6 +8522,92 @@ export enum CompatibleNodeType {
     DocumentFragment = 11
 }
 
+/**
+ *  Enum used to control the different types of numbering list
+ */
+export enum CompatibleNumberingListType {
+    /**
+     * Numbering triggered by 1.
+     */
+    Decimal = 0,
+    /**
+     * Numbering triggered by 1-
+     */
+    DecimalDash = 1,
+    /**
+     * Numbering triggered by 1)
+     */
+    DecimalParenthesis = 2,
+    /**
+     * Numbering triggered by (1)
+     */
+    DecimalDoubleParenthesis = 3,
+    /**
+     * Numbering triggered by a.
+     */
+    LowerAlpha = 4,
+    /**
+     * Numbering triggered by a)
+     */
+    LowerAlphaParenthesis = 5,
+    /**
+     * Numbering triggered by (a)
+     */
+    LowerAlphaDoubleParenthesis = 6,
+    /**
+     * Numbering triggered by a-
+     */
+    LowerAlphaDash = 7,
+    /**
+     * Numbering triggered by A.
+     */
+    UpperAlpha = 8,
+    /**
+     * Numbering triggered by A)
+     */
+    UpperAlphaParenthesis = 9,
+    /**
+     * Numbering triggered by (A)
+     */
+    UpperAlphaDoubleParenthesis = 10,
+    /**
+     * Numbering triggered by A-
+     */
+    UpperAlphaDash = 11,
+    /**
+     * Numbering triggered by i.
+     */
+    LowerRoman = 12,
+    /**
+     * Numbering triggered by i)
+     */
+    LowerRomanParenthesis = 13,
+    /**
+     * Numbering triggered by (i)
+     */
+    LowerRomanDoubleParenthesis = 14,
+    /**
+     * Numbering triggered by i-
+     */
+    LowerRomanDash = 15,
+    /**
+     * Numbering triggered by I.
+     */
+    UpperRoman = 16,
+    /**
+     * Numbering triggered by I)
+     */
+    UpperRomanParenthesis = 17,
+    /**
+     * Numbering triggered by (I)
+     */
+    UpperRomanDoubleParenthesis = 18,
+    /**
+     * Numbering triggered by I-
+     */
+    UpperRomanDash = 19
+}
+
 /**
  * Represent the type of a position
  */
@@ -8435,6 +8969,7 @@ export class HyperLink implements EditorPlugin  {
  * ImageEdit plugin provides the ability to edit an inline image in editor, including image resizing, rotation and cropping
  */
 export class ImageEdit implements EditorPlugin  {
+    private onShowResizeHandle?;
     protected editor: IEditor;
     protected options: ImageEditOptions;
     private disposer;
@@ -8450,8 +8985,11 @@ export class ImageEdit implements EditorPlugin  {
     /**
      * Create a new instance of ImageEdit
      * @param options Image editing options
+     * @param onShowResizeHandle An optional callback to allow customize resize handle element of image resizing.
+     * To customize the resize handle element, add this callback and change the attributes of elementData then it
+     * will be picked up by ImageEdit code
      */
-    constructor(options?: ImageEditOptions);
+    constructor(options?: ImageEditOptions, onShowResizeHandle?: OnShowResizeHandle);
     /**
      * Get a friendly name of this plugin
      */
@@ -8553,6 +9091,25 @@ export function isResizedTo(image: HTMLImageElement, percentage: number): boolea
  */
 export function resetImage(editor: IEditor, image: HTMLImageElement): void;
 
+/**
+ * An optional callback to allow customize resize handle element of image resizing.
+ * To customize the resize handle element, add this callback and change the attributes of elementData then it
+ * will be picked up by ImageEdit code
+ */
+export interface OnShowResizeHandle {
+    (elementData: CreateElementData, x: DNDDirectionX, y: DnDDirectionY): void;
+}
+
+/**
+ * Horizontal direction types for image edit
+ */
+export type DNDDirectionX = 'w' | '' | 'e';
+
+/**
+ * Vertical direction types for image edit
+ */
+export type DnDDirectionY = 'n' | '' | 's';
+
 /**
  * @deprecated Use ImageEdit plugin instead
  */
@@ -8833,3 +9390,29 @@ export class TableCellSelection implements EditorPlugin  {
     selectTable(): void;
 }
 
+/**
+ * Automatically transform -- into hyphen, if typed between two words.
+ */
+export class AutoFormat implements EditorPlugin  {
+    private editor;
+    private lastKeyTyped;
+    /**
+     * Get a friendly name of this plugin
+     */
+    getName(): string;
+    /**
+     * Initialize this plugin
+     * @param editor The editor instance
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * Dispose this plugin
+     */
+    dispose(): void;
+    /**
+     * Handle events triggered from editor
+     * @param event PluginEvent object
+     */
+    onPluginEvent(event: PluginEvent): void;
+}
+