roosterjs 8.10.0 → 8.11.2

package/dist/rooster-amd.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
 
@@ -347,7 +347,11 @@ export 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,
@@ -356,7 +360,11 @@ export 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,
@@ -1017,7 +1025,7 @@ export 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
 }
@@ -1027,7 +1035,7 @@ export const enum ClearFormatMode {
  */
 export 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,
     /**
@@ -1055,7 +1063,7 @@ export const enum KnownCreateElementDataIndex {
      */
     ImageEditWrapper = 6,
     /**
-     * Table resizers
+     * Table resizer elements
      */
     TableHorizontalResizer = 7,
     TableVerticalResizer = 8,
@@ -2267,9 +2275,10 @@ export interface SanitizeHtmlOptions extends HtmlSanitizerOptions  {
  *
  * !!!Note: This file is generated from /tools/generateTargetWindow.js. Do NOT modify this file directly!!!
  */
-export interface TargetWindow {
+export interface TargetWindowBase {
     Range: Range;
     Node: Node;
+    ParentNode: ParentNode;
     Element: Element;
     SVGElement: SVGElement;
     SVGViewElement: SVGViewElement;
@@ -2282,6 +2291,7 @@ export interface TargetWindow {
     SVGMetadataElement: SVGMetadataElement;
     SVGMaskElement: SVGMaskElement;
     SVGMarkerElement: SVGMarkerElement;
+    SVGMPathElement: SVGMPathElement;
     SVGGraphicsElement: SVGGraphicsElement;
     SVGUseElement: SVGUseElement;
     SVGTextContentElement: SVGTextContentElement;
@@ -2291,12 +2301,12 @@ export 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;
@@ -2330,7 +2340,6 @@ export interface TargetWindow {
     SVGFEColorMatrixElement: SVGFEColorMatrixElement;
     SVGFEBlendElement: SVGFEBlendElement;
     SVGDescElement: SVGDescElement;
-    SVGCursorElement: SVGCursorElement;
     SVGComponentTransferFunctionElement: SVGComponentTransferFunctionElement;
     SVGFEFuncRElement: SVGFEFuncRElement;
     SVGFEFuncGElement: SVGFEFuncGElement;
@@ -2338,9 +2347,11 @@ export interface TargetWindow {
     SVGFEFuncAElement: SVGFEFuncAElement;
     SVGClipPathElement: SVGClipPathElement;
     SVGAnimationElement: SVGAnimationElement;
+    SVGSetElement: SVGSetElement;
     SVGAnimateTransformElement: SVGAnimateTransformElement;
     SVGAnimateMotionElement: SVGAnimateMotionElement;
     SVGAnimateElement: SVGAnimateElement;
+    MathMLElement: MathMLElement;
     HTMLElement: HTMLElement;
     HTMLUnknownElement: HTMLUnknownElement;
     HTMLUListElement: HTMLUListElement;
@@ -2410,11 +2421,9 @@ export interface TargetWindow {
     HTMLCanvasElement: HTMLCanvasElement;
     HTMLButtonElement: HTMLButtonElement;
     HTMLBodyElement: HTMLBodyElement;
-    HTMLBaseFontElement: HTMLBaseFontElement;
     HTMLBaseElement: HTMLBaseElement;
     HTMLBRElement: HTMLBRElement;
     HTMLAreaElement: HTMLAreaElement;
-    HTMLAppletElement: HTMLAppletElement;
     HTMLAnchorElement: HTMLAnchorElement;
     DocumentType: DocumentType;
     DocumentFragment: DocumentFragment;
@@ -2431,6 +2440,24 @@ export 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
+ */
+export 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
  */
@@ -2804,7 +2831,7 @@ export 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.
      */
@@ -3483,7 +3510,7 @@ export interface EntityFeatureSettings {
  */
 export 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;
@@ -3835,7 +3862,7 @@ export interface ImageEditOptions {
 }
 
 /**
- * An interface represents the data for creating element used by createElemnet()
+ * An interface represents the data for creating element used by createElement()
  */
 export interface CreateElementData {
     /**
@@ -4699,7 +4726,7 @@ export function wrap(nodes: Node | Node[], wrapper?: string): HTMLElement;
 export 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
  */
@@ -6925,6 +6952,12 @@ export 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;