roosterjs 8.10.0 → 8.11.2

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.10.0)
+// Type definitions for roosterjs (Version 8.11.2)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -348,7 +348,11 @@ const enum Keys {
     RIGHT = 39,
     DOWN = 40,
     DELETE = 46,
+    /**
+     * @deprecated Just for backward compatibility
+     */
     EIGHT_ASTIRISK = 56,
+    EIGHT_ASTERISK = 56,
     B = 66,
     I = 73,
     U = 85,
@@ -357,7 +361,11 @@ const enum Keys {
     COMMA = 188,
     DASH_UNDERSCORE = 189,
     PERIOD = 190,
+    /**
+     * @deprecated Just for backward compatibility
+     */
     FORWARDSLASH = 191,
+    FORWARD_SLASH = 191,
     GRAVE_TILDE = 192,
     CONTENTCHANGED = 257,
     RANGE = 258,
@@ -1018,7 +1026,7 @@ const enum ClearFormatMode {
      */
     Block = 1,
     /**
-     * Detect Inline or Block format based on the current editor selectior.
+     * Detect Inline or Block format based on the current editor selector.
      */
     AutoDetect = 2
 }
@@ -1028,7 +1036,7 @@ const enum ClearFormatMode {
  */
 const enum KnownCreateElementDataIndex {
     /**
-     * Set a none value to help createElement funciton ignore falsy value
+     * Set a none value to help createElement function ignore falsy value
      */
     None = 0,
     /**
@@ -1056,7 +1064,7 @@ const enum KnownCreateElementDataIndex {
      */
     ImageEditWrapper = 6,
     /**
-     * Table resizers
+     * Table resizer elements
      */
     TableHorizontalResizer = 7,
     TableVerticalResizer = 8,
@@ -2268,9 +2276,10 @@ interface SanitizeHtmlOptions extends HtmlSanitizerOptions  {
  *
  * !!!Note: This file is generated from /tools/generateTargetWindow.js. Do NOT modify this file directly!!!
  */
-interface TargetWindow {
+interface TargetWindowBase {
     Range: Range;
     Node: Node;
+    ParentNode: ParentNode;
     Element: Element;
     SVGElement: SVGElement;
     SVGViewElement: SVGViewElement;
@@ -2283,6 +2292,7 @@ interface TargetWindow {
     SVGMetadataElement: SVGMetadataElement;
     SVGMaskElement: SVGMaskElement;
     SVGMarkerElement: SVGMarkerElement;
+    SVGMPathElement: SVGMPathElement;
     SVGGraphicsElement: SVGGraphicsElement;
     SVGUseElement: SVGUseElement;
     SVGTextContentElement: SVGTextContentElement;
@@ -2292,12 +2302,12 @@ interface TargetWindow {
     SVGTextPathElement: SVGTextPathElement;
     SVGSwitchElement: SVGSwitchElement;
     SVGSVGElement: SVGSVGElement;
-    SVGPathElement: SVGPathElement;
     SVGImageElement: SVGImageElement;
     SVGGeometryElement: SVGGeometryElement;
     SVGRectElement: SVGRectElement;
     SVGPolylineElement: SVGPolylineElement;
     SVGPolygonElement: SVGPolygonElement;
+    SVGPathElement: SVGPathElement;
     SVGLineElement: SVGLineElement;
     SVGEllipseElement: SVGEllipseElement;
     SVGCircleElement: SVGCircleElement;
@@ -2331,7 +2341,6 @@ interface TargetWindow {
     SVGFEColorMatrixElement: SVGFEColorMatrixElement;
     SVGFEBlendElement: SVGFEBlendElement;
     SVGDescElement: SVGDescElement;
-    SVGCursorElement: SVGCursorElement;
     SVGComponentTransferFunctionElement: SVGComponentTransferFunctionElement;
     SVGFEFuncRElement: SVGFEFuncRElement;
     SVGFEFuncGElement: SVGFEFuncGElement;
@@ -2339,9 +2348,11 @@ interface TargetWindow {
     SVGFEFuncAElement: SVGFEFuncAElement;
     SVGClipPathElement: SVGClipPathElement;
     SVGAnimationElement: SVGAnimationElement;
+    SVGSetElement: SVGSetElement;
     SVGAnimateTransformElement: SVGAnimateTransformElement;
     SVGAnimateMotionElement: SVGAnimateMotionElement;
     SVGAnimateElement: SVGAnimateElement;
+    MathMLElement: MathMLElement;
     HTMLElement: HTMLElement;
     HTMLUnknownElement: HTMLUnknownElement;
     HTMLUListElement: HTMLUListElement;
@@ -2411,11 +2422,9 @@ interface TargetWindow {
     HTMLCanvasElement: HTMLCanvasElement;
     HTMLButtonElement: HTMLButtonElement;
     HTMLBodyElement: HTMLBodyElement;
-    HTMLBaseFontElement: HTMLBaseFontElement;
     HTMLBaseElement: HTMLBaseElement;
     HTMLBRElement: HTMLBRElement;
     HTMLAreaElement: HTMLAreaElement;
-    HTMLAppletElement: HTMLAppletElement;
     HTMLAnchorElement: HTMLAnchorElement;
     DocumentType: DocumentType;
     DocumentFragment: DocumentFragment;
@@ -2432,6 +2441,24 @@ interface TargetWindow {
     Attr: Attr;
 }
 
+    /**
+ * Define DOM types of window, used by safeInstanceOf() to check if a given object is of the specified type of its own window
+ */
+interface TargetWindow extends TargetWindowBase  {
+    /**
+     * @deprecated Just for backward compatibility
+     */
+    SVGCursorElement: Element;
+    /**
+     * @deprecated Just for backward compatibility
+     */
+    HTMLBaseFontElement: Element;
+    /**
+     * @deprecated Just for backward compatibility
+     */
+    HTMLAppletElement: Element;
+}
+
     /**
  * Interface of roosterjs editor object
  */
@@ -2805,7 +2832,7 @@ interface IEditor {
      */
     getStyleBasedFormatState(node?: Node): StyleBasedFormatState;
     /**
-     * Get the pendable format state from the current selection, incluing formats as underline, bold, italics
+     * Get the pendable format state from the current selection, including formats as underline, bold, italics
      * @param forceGetStateFromDOM If set to true, will not consider the cached format and will get the format state directly from DOM tree
      * @return The pending format state of editor.
      */
@@ -3484,7 +3511,7 @@ interface EntityFeatureSettings {
  */
 interface ListFeatureSettings {
     /**
-     * When press space after an astirisk or number in an empty line, toggle bullet/numbering
+     * When press space after an asterisk or number in an empty line, toggle bullet/numbering
      * @default true
      */
     autoBullet: boolean;
@@ -3836,7 +3863,7 @@ interface ImageEditOptions {
 }
 
     /**
- * An interface represents the data for creating element used by createElemnet()
+ * An interface represents the data for creating element used by createElement()
  */
 interface CreateElementData {
     /**
@@ -4700,7 +4727,7 @@ function wrap(nodes: Node | Node[], wrapper?: string): HTMLElement;
 function wrap(nodes: Node | Node[], wrapper?: HTMLElement): HTMLElement;
 
     /**
- * Wrapp all the nodes with CreateElementData or an index of a known CreateElementData
+ * Wraps all the nodes with CreateElementData or an index of a known CreateElementData
  * @param nodes The nodes to wrap
  * @param wrapper The CreateElementData or an index of a known CreateElementData
  */
@@ -6926,6 +6953,12 @@ class TableResize implements EditorPlugin  {
     private frameAnimateResizeCells;
     private resizeTable;
     private resizeRows;
+    /**
+     *
+     * @param newPos The position to where we want to move the vertical border
+     * @returns if the move is allowed, or, if any of the cells on either side of the vertical border is smaller than
+     * the minimum width, such move is not allowed
+     */
     private canResizeColumns;
     private resizeColumns;
     private resizeCells;