roosterjs 8.23.0 → 8.25.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.23.0)
+// Type definitions for roosterjs (Version 8.25.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -375,13 +375,6 @@ export function extractClipboardItems(items: DataTransferItem[], options?: Extra
  */
 export function extractClipboardItemsForIE(dataTransfer: DataTransfer, callback: (data: ClipboardData) => void, options?: ExtractClipboardItemsForIEOptions): void;
 
-/**
- * A type-safe wrapper for Array.prototype.push.apply()
- * @param mainArray The main array to push items into
- * @param itemsArray The items to push to main array
- */
-export function arrayPush<T>(mainArray: T[], itemsArray: T[]): void;
-
 /**
  * Browser object contains browser and operating system information of current environment
  */
@@ -528,7 +521,7 @@ export function isBlockElement(node: Node): node is HTMLElement;
  * Default value is false
  * @returns True if there isn't any visible element inside node, otherwise false
  */
-export function isNodeEmpty(node: Node, trimContent?: boolean): boolean;
+export function isNodeEmpty(node: Node, trimContent?: boolean, shouldCountBrAsVisible?: boolean): boolean;
 
 /**
  * Check if the given node is html void element. Void element cannot have children
@@ -661,38 +654,6 @@ export function splitTextNode(textNode: Text, offset: number, returnFirstPart: b
  */
 export function normalizeRect(clientRect: DOMRect): Rect | null;
 
-/**
- * Convert a named node map to an array
- * @param collection The map to convert
- */
-export function toArray(collection: NamedNodeMap): Attr[];
-
-/**
- * Convert a named node map to an array
- * @param collection The map to convert
- */
-export function toArray(collection: DataTransferItemList): DataTransferItem[];
-
-/**
- * Convert a collection to an array
- * @param collection The collection to convert
- */
-export function toArray<T extends Node>(collection: NodeListOf<T>): T[];
-
-/**
- * Convert a collection to an array
- * @param collection The collection to convert
- */
-export function toArray<T extends Element>(collection: HTMLCollectionOf<T>): T[];
-
-/**
- * Convert an array to an array.
- * This is to satisfy typescript compiler. For some cases the object can be a collection at runtime,
- * but the declaration is an array. e.g. ClipboardData.types
- * @param array The array to convert
- */
-export function toArray<T>(array: readonly T[]): T[];
-
 /**
  * Check if the given object is instance of the target type
  * @param obj Object to check
@@ -989,9 +950,10 @@ export class VList {
     /**
      * 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
+     * @param orderedStyle The style of ordered list
+     * @param unorderedStyle The style of unordered list
      */
-    setListStyleType(targetStyle: NumberingListType | BulletListType | CompatibleBulletListType | CompatibleNumberingListType): void;
+    setListStyleType(orderedStyle?: NumberingListType | CompatibleNumberingListType, unorderedStyle?: BulletListType | CompatibleBulletListType): 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
@@ -1792,6 +1754,52 @@ export function setMetadata<T>(element: HTMLElement, metadata: T, def?: Definiti
  */
 export function removeMetadata(element: HTMLElement): void;
 
+/**
+ * A type-safe wrapper for Array.prototype.push.apply()
+ * @param mainArray The main array to push items into
+ * @param itemsArray The items to push to main array
+ */
+export function arrayPush<T>(mainArray: T[], itemsArray: T[]): void;
+
+/**
+ * Provide a strong-typed version of Object.keys()
+ * @param obj The source object
+ * @returns Array of keys
+ */
+export function getObjectKeys<T extends string | number | symbol>(obj: Record<T, any> | Partial<Record<T, any>>): T[];
+
+/**
+ * Convert a named node map to an array
+ * @param collection The map to convert
+ */
+export function toArray(collection: NamedNodeMap): Attr[];
+
+/**
+ * Convert a named node map to an array
+ * @param collection The map to convert
+ */
+export function toArray(collection: DataTransferItemList): DataTransferItem[];
+
+/**
+ * Convert a collection to an array
+ * @param collection The collection to convert
+ */
+export function toArray<T extends Node>(collection: NodeListOf<T>): T[];
+
+/**
+ * Convert a collection to an array
+ * @param collection The collection to convert
+ */
+export function toArray<T extends Element>(collection: HTMLCollectionOf<T>): T[];
+
+/**
+ * Convert an array to an array.
+ * This is to satisfy typescript compiler. For some cases the object can be a collection at runtime,
+ * but the declaration is an array. e.g. ClipboardData.types
+ * @param array The array to convert
+ */
+export function toArray<T>(array: readonly T[]): T[];
+
 /**
  * RoosterJs core editor class
  */
@@ -2544,9 +2552,10 @@ 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.
+ * @param orderedStyle (Optional) the style of an ordered. If not defined, the style will be set to decimal.
+ * @param unorderedStyle (Optional) the style of an unordered list. If not defined, the style will be set to disc.
  */
-export function toggleListType(editor: IEditor, listType: ListType | CompatibleListType, startNumber?: number, includeSiblingLists?: boolean, listStyle?: BulletListType | NumberingListType | CompatibleBulletListType | CompatibleNumberingListType): void;
+export function toggleListType(editor: IEditor, listType: ListType | CompatibleListType, startNumber?: number, includeSiblingLists?: boolean, orderedStyle?: NumberingListType | CompatibleNumberingListType, unorderedStyle?: BulletListType | CompatibleBulletListType): void;
 
 /**
  * Split selection into regions, and perform a block-wise formatting action for each region.
@@ -3474,6 +3483,7 @@ export const enum ExperimentalFeatures {
      */
     AutoFormatList = "AutoFormatList",
     /**
+     * @deprecated this feature is always disabled
      * Automatically transform -- into hyphen, if typed between two words.
      */
     AutoHyphen = "AutoHyphen"
@@ -4032,116 +4042,136 @@ export const enum SelectionRangeTypes {
  *  Enum used to control the different types of numbering list
  */
 export const enum NumberingListType {
+    /**
+     * Minimum value of the enum
+     */
+    Min = 1,
     /**
      * Numbering triggered by 1.
      */
-    Decimal = 0,
+    Decimal = 1,
     /**
      * Numbering triggered by 1-
      */
-    DecimalDash = 1,
+    DecimalDash = 2,
     /**
      * Numbering triggered by 1)
      */
-    DecimalParenthesis = 2,
+    DecimalParenthesis = 3,
     /**
      * Numbering triggered by (1)
      */
-    DecimalDoubleParenthesis = 3,
+    DecimalDoubleParenthesis = 4,
     /**
      * Numbering triggered by a.
      */
-    LowerAlpha = 4,
+    LowerAlpha = 5,
     /**
      * Numbering triggered by a)
      */
-    LowerAlphaParenthesis = 5,
+    LowerAlphaParenthesis = 6,
     /**
      * Numbering triggered by (a)
      */
-    LowerAlphaDoubleParenthesis = 6,
+    LowerAlphaDoubleParenthesis = 7,
     /**
      * Numbering triggered by a-
      */
-    LowerAlphaDash = 7,
+    LowerAlphaDash = 8,
     /**
      * Numbering triggered by A.
      */
-    UpperAlpha = 8,
+    UpperAlpha = 9,
     /**
      * Numbering triggered by A)
      */
-    UpperAlphaParenthesis = 9,
+    UpperAlphaParenthesis = 10,
     /**
      * Numbering triggered by (A)
      */
-    UpperAlphaDoubleParenthesis = 10,
+    UpperAlphaDoubleParenthesis = 11,
     /**
      * Numbering triggered by A-
      */
-    UpperAlphaDash = 11,
+    UpperAlphaDash = 12,
     /**
      * Numbering triggered by i.
      */
-    LowerRoman = 12,
+    LowerRoman = 13,
     /**
      * Numbering triggered by i)
      */
-    LowerRomanParenthesis = 13,
+    LowerRomanParenthesis = 14,
     /**
      * Numbering triggered by (i)
      */
-    LowerRomanDoubleParenthesis = 14,
+    LowerRomanDoubleParenthesis = 15,
     /**
      * Numbering triggered by i-
      */
-    LowerRomanDash = 15,
+    LowerRomanDash = 16,
     /**
      * Numbering triggered by I.
      */
-    UpperRoman = 16,
+    UpperRoman = 17,
     /**
      * Numbering triggered by I)
      */
-    UpperRomanParenthesis = 17,
+    UpperRomanParenthesis = 18,
     /**
      * Numbering triggered by (I)
      */
-    UpperRomanDoubleParenthesis = 18,
+    UpperRomanDoubleParenthesis = 19,
     /**
      * Numbering triggered by I-
      */
-    UpperRomanDash = 19
+    UpperRomanDash = 20,
+    /**
+     * Maximum value of the enum
+     */
+    Max = 20
 }
 
 /**
  *  Enum used to control the different types of bullet list
  */
 export const enum BulletListType {
+    /**
+     * Minimum value of the enum
+     */
+    Min = 1,
     /**
      * Bullet triggered by *
      */
-    Disc = 0,
+    Disc = 1,
     /**
      * Bullet triggered by -
      */
-    Dash = 1,
+    Dash = 2,
     /**
      * Bullet triggered by --
      */
-    Square = 2,
+    Square = 3,
     /**
      * Bullet triggered by >
      */
-    ShortArrow = 3,
+    ShortArrow = 4,
     /**
      * Bullet triggered by -> or -->
      */
-    LongArrow = 4,
+    LongArrow = 5,
     /**
      * Bullet triggered by =>
      */
-    UnfilledArrow = 5
+    UnfilledArrow = 6,
+    /**
+     * Bullet triggered by —
+     */
+    Hyphen = 7,
+    /**
+     * Maximum value of the enum
+     */
+    Max = 7
 }
 
 /**
@@ -6725,6 +6755,16 @@ export interface ListFeatureSettings {
      * When delete key is pressed before the first item, indent the correct list of numbers
      */
     maintainListChainWhenDelete: boolean;
+    /**
+     * When press space after *, -, --, ->, -->, >, =>  in an empty line, toggle bullet
+     * @default true
+     */
+    autoBulletList: boolean;
+    /**
+     * When press space after an number, a letter or roman number followed by ), ., -, or between parenthesis in an empty line, toggle numbering
+     * @default true
+     */
+    autoNumberingList: boolean;
 }
 
 /**
@@ -6832,6 +6872,7 @@ export interface TextFeatureSettings {
      */
     outdentWhenTabText: boolean;
     /**
+     * @deprecated
      * Requires @see ExperimentalFeatures.AutoHyphen to be enabled
      * Automatically transform -- into hyphen, if typed between two words.
      */
@@ -7035,7 +7076,7 @@ export interface ImageEditOptions {
      * Color of resize/rotate border, handle and icon
      * @default #DB626C
      */
-    borderColor?: string;
+    borderColor?: string | ModeIndependentColor;
     /**
      * Minimum resize/crop width
      * @default 10
@@ -7424,6 +7465,7 @@ export enum CompatibleExperimentalFeatures {
      */
     AutoFormatList = "AutoFormatList",
     /**
+     * @deprecated this feature is always disabled
      * Automatically transform -- into hyphen, if typed between two words.
      */
     AutoHyphen = "AutoHyphen"
@@ -7889,30 +7931,42 @@ export enum CompatibleAlignment {
  *  Enum used to control the different types of bullet list
  */
 export enum CompatibleBulletListType {
+    /**
+     * Minimum value of the enum
+     */
+    Min = 1,
     /**
      * Bullet triggered by *
      */
-    Disc = 0,
+    Disc = 1,
     /**
      * Bullet triggered by -
      */
-    Dash = 1,
+    Dash = 2,
     /**
      * Bullet triggered by --
      */
-    Square = 2,
+    Square = 3,
     /**
      * Bullet triggered by >
      */
-    ShortArrow = 3,
+    ShortArrow = 4,
     /**
      * Bullet triggered by -> or -->
      */
-    LongArrow = 4,
+    LongArrow = 5,
     /**
      * Bullet triggered by =>
      */
-    UnfilledArrow = 5
+    UnfilledArrow = 6,
+    /**
+     * Bullet triggered by —
+     */
+    Hyphen = 7,
+    /**
+     * Maximum value of the enum
+     */
+    Max = 7
 }
 
 /**
@@ -8523,86 +8577,94 @@ export enum CompatibleNodeType {
  *  Enum used to control the different types of numbering list
  */
 export enum CompatibleNumberingListType {
+    /**
+     * Minimum value of the enum
+     */
+    Min = 1,
     /**
      * Numbering triggered by 1.
      */
-    Decimal = 0,
+    Decimal = 1,
     /**
      * Numbering triggered by 1-
      */
-    DecimalDash = 1,
+    DecimalDash = 2,
     /**
      * Numbering triggered by 1)
      */
-    DecimalParenthesis = 2,
+    DecimalParenthesis = 3,
     /**
      * Numbering triggered by (1)
      */
-    DecimalDoubleParenthesis = 3,
+    DecimalDoubleParenthesis = 4,
     /**
      * Numbering triggered by a.
      */
-    LowerAlpha = 4,
+    LowerAlpha = 5,
     /**
      * Numbering triggered by a)
      */
-    LowerAlphaParenthesis = 5,
+    LowerAlphaParenthesis = 6,
     /**
      * Numbering triggered by (a)
      */
-    LowerAlphaDoubleParenthesis = 6,
+    LowerAlphaDoubleParenthesis = 7,
     /**
      * Numbering triggered by a-
      */
-    LowerAlphaDash = 7,
+    LowerAlphaDash = 8,
     /**
      * Numbering triggered by A.
      */
-    UpperAlpha = 8,
+    UpperAlpha = 9,
     /**
      * Numbering triggered by A)
      */
-    UpperAlphaParenthesis = 9,
+    UpperAlphaParenthesis = 10,
     /**
      * Numbering triggered by (A)
      */
-    UpperAlphaDoubleParenthesis = 10,
+    UpperAlphaDoubleParenthesis = 11,
     /**
      * Numbering triggered by A-
      */
-    UpperAlphaDash = 11,
+    UpperAlphaDash = 12,
     /**
      * Numbering triggered by i.
      */
-    LowerRoman = 12,
+    LowerRoman = 13,
     /**
      * Numbering triggered by i)
      */
-    LowerRomanParenthesis = 13,
+    LowerRomanParenthesis = 14,
     /**
      * Numbering triggered by (i)
      */
-    LowerRomanDoubleParenthesis = 14,
+    LowerRomanDoubleParenthesis = 15,
     /**
      * Numbering triggered by i-
      */
-    LowerRomanDash = 15,
+    LowerRomanDash = 16,
     /**
      * Numbering triggered by I.
      */
-    UpperRoman = 16,
+    UpperRoman = 17,
     /**
      * Numbering triggered by I)
      */
-    UpperRomanParenthesis = 17,
+    UpperRomanParenthesis = 18,
     /**
      * Numbering triggered by (I)
      */
-    UpperRomanDoubleParenthesis = 18,
+    UpperRomanDoubleParenthesis = 19,
     /**
      * Numbering triggered by I-
      */
-    UpperRomanDash = 19
+    UpperRomanDash = 20,
+    /**
+     * Maximum value of the enum
+     */
+    Max = 20
 }
 
 /**
@@ -9387,3 +9449,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;
+}
+