roosterjs 8.14.0 → 8.16.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.14.0)
+// Type definitions for roosterjs (Version 8.16.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -1132,20 +1132,20 @@ const enum TableBorderFormat {
     FIRST_COLUMN_HEADER_EXTERNAL = 4,
     /**
      * The header row has no vertical border, except for the first one
-     * The only horizontal border of the table is the top and bottom of header row
+     * The first column has no horizontal border, except for the first one
      *  __ __ __
      * |__ __ __
-     * |  |     |
-     * |  |     |
+     * |  |__|__|
+     * |  |__|__|
      */
     ESPECIAL_TYPE_1 = 5,
     /**
      * The header row has no vertical border, except for the first one
-     * The first column has no horizontal border, except for the first one
+     * The only horizontal border of the table is the top and bottom of header row
      *  __ __ __
      * |__ __ __
-     * |  |__|__|
-     * |  |__|__|
+     * |  |     |
+     * |  |     |
      */
     ESPECIAL_TYPE_2 = 6,
     /**
@@ -1431,7 +1431,7 @@ interface PluginScrollEvent extends PluginDomEventBase<PluginEventType.Scroll, U
     /**
  * Editor plugin event interface
  */
-type PluginEvent = BeforeCutCopyEvent | BeforePasteEvent | ContentChangedEvent | EntityOperationEvent | ExtractContentWithDomEvent | PluginDomEvent | EditorReadyEvent | BeforeDisposeEvent | PendingFormatStateChangedEvent | EnterShadowEditEvent | LeaveShadowEditEvent | EditImageEvent | BeforeSetContentEvent;
+type PluginEvent = BeforeCutCopyEvent | BeforePasteEvent | ContentChangedEvent | EntityOperationEvent | ExtractContentWithDomEvent | PluginDomEvent | EditorReadyEvent | BeforeDisposeEvent | PendingFormatStateChangedEvent | EnterShadowEditEvent | LeaveShadowEditEvent | EditImageEvent | BeforeSetContentEvent | ZoomChangedEvent;
 
     /**
  * Editor plugin event type
@@ -1524,7 +1524,11 @@ const enum PluginEventType {
      * 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
+    BeforeSetContent = 20,
+    /**
+     * Zoom scale value is changed, triggered by Editor.setZoomScale() when set a different scale number
+     */
+    ZoomChanged = 21
 }
 
     /**
@@ -1569,6 +1573,22 @@ interface EnterShadowEditEvent extends BasePluginEvent<PluginEventType.EnteredSh
 interface LeaveShadowEditEvent extends BasePluginEvent<PluginEventType.LeavingShadowEdit> {
 }
 
+    /**
+ * Represents an event object triggered from Editor.setZoomScale() API.
+ * Plugins can handle this event when they need to do something for zoom changing.
+ *
+ */
+interface ZoomChangedEvent extends BasePluginEvent<PluginEventType.ZoomChanged> {
+    /**
+     * Zoom scale value before this change
+     */
+    oldZoomScale: number;
+    /**
+     * Zoom scale value after this change
+     */
+    newZoomScale: number;
+}
+
     /**
  * This refers to a "content block" in editor that serves as a content parsing boundary
  * It is most those html block like tags, i.e. &lt;p&gt;, &lt;div&gt;, &lt;li&gt;, &lt;td&gt; etc.
@@ -1623,7 +1643,7 @@ interface ClipboardData {
      * When set to null, it means there's no HTML from clipboard event.
      * When set to undefined, it means there may be HTML in clipboard event, but fail to retrieve
      */
-    rawHtml: string;
+    rawHtml: string | null | undefined;
     /**
      * Link Preview information provided by Edge
      */
@@ -1631,7 +1651,7 @@ interface ClipboardData {
     /**
      * Image file from clipboard event
      */
-    image: File;
+    image: File | null;
     /**
      * Html extracted from raw html string and remove content before and after fragment tag
      */
@@ -1643,7 +1663,7 @@ interface ClipboardData {
     /**
      * BASE64 encoded data uri of the image if any
      */
-    imageDataUri?: string;
+    imageDataUri?: string | null;
     /**
      * Array of tag names of the first level child nodes
      */
@@ -2387,10 +2407,10 @@ interface HtmlSanitizerOptions {
      * Define a replacement tag name of unknown tags.
      * A star "*" means keep as it is, no replacement
      * Other valid string means replace the tag name with this string.
-     * Empty string, undefined or null means drop such elements and all its children
+     * Empty string, undefined means drop such elements and all its children
      * @default undefined
      */
-    unknownTagReplacement?: string;
+    unknownTagReplacement?: string | null;
 }
 
     /**
@@ -2737,6 +2757,12 @@ interface IEditor {
      * @returns True if content is selected, otherwise false
      */
     select(path: SelectionPath): boolean;
+    /**
+     * Select content using the Table Selection
+     * @param table to select
+     * @param coordinates first and last cell of the range
+     */
+    select(table: HTMLTableElement, coordinates: TableSelection): boolean;
     /**
      * Get current focused position. Return null if editor doesn't have focus at this time.
      */
@@ -2953,7 +2979,20 @@ interface IEditor {
      */
     getTrustedHTMLHandler(): TrustedHTMLHandler;
     /**
-     * Get a transformer function. It transform the size changes according to current situation.
+     * Get current zoom scale, default value is 1
+     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
+     * to let editor behave correctly especially for those mouse drag/drop behaviors
+     * @returns current zoom scale number
+     */
+    getZoomScale(): number;
+    /**
+     * Set current zoom scale, default value is 1
+     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
+     * to let editor behave correctly especially for those mouse drag/drop behaviors
+     */
+    setZoomScale(scale: number): void;
+    /**
+     * @deprecated Use getZoomScale() instead
      */
     getSizeTransformer(): SizeTransformer;
 }
@@ -3156,10 +3195,9 @@ interface EditorCore extends PluginState  {
      * To override, pass your own trusted HTML handler to EditorOptions.trustedHTMLHandler
      */
     readonly trustedHTMLHandler: TrustedHTMLHandler;
+    zoomScale: number;
     /**
-     * A transformer function. It transform the size changes according to current situation.
-     * A typical scenario to use this function is when editor is located under a scaled container, so we need to
-     * calculate the scaled size change according to current zoom rate.
+     * @deprecated Use zoomScale instead
      */
     sizeTransformer: SizeTransformer;
 }
@@ -3316,6 +3354,16 @@ interface CoreApiMap {
      * @param broadcast Set to true to skip the shouldHandleEventExclusively check
      */
     triggerEvent: TriggerEvent;
+    /**
+     * Select a table and save data of the selected range
+     * @param core The EditorCore object
+     * @param table table to select
+     * @param coordinates first and last cell of the selection, if this parameter is null, instead of
+     * selecting, will unselect the table.
+     * @param shouldAddStyles Whether need to update the style elements
+     * @returns true if successful
+     */
+    selectTable: SelectTable;
 }
 
     /**
@@ -3446,6 +3494,16 @@ type TransformColor = (core: EditorCore, rootNode: Node, includeSelf: boolean, c
  */
 type TriggerEvent = (core: EditorCore, pluginEvent: PluginEvent, broadcast: boolean) => void;
 
+    /**
+ * Select a table and save data of the selected range
+ * @param core The EditorCore object
+ * @param table table to select
+ * @param coordinates first and last cell of the selection, if this parameter is null, instead of
+ * selecting, will unselect the table.
+ * @returns true if successful
+ */
+type SelectTable = (core: EditorCore, table: HTMLTableElement, coordinates?: TableSelection) => TableSelectionRange;
+
     /**
  * The options to specify parameters customizing an editor, used by ctor of Editor class
  */
@@ -3532,9 +3590,13 @@ interface EditorOptions {
      */
     trustedHTMLHandler?: TrustedHTMLHandler;
     /**
-     * A transformer function. It transform the size changes according to current situation.
-     * A typical scenario to use this function is when editor is located under a scaled container, so we need to
-     * calculate the scaled size change according to current zoom rate.
+     * Current zoom scale, @default value is 1
+     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
+     * to let editor behave correctly especially for those mouse drag/drop behaviors
+     */
+    zoomScale?: number;
+    /**
+     * @deprecated Use zoomScale instead
      */
     sizeTransformer?: SizeTransformer;
 }
@@ -4031,6 +4093,10 @@ interface TableSelectionRange extends SelectionRangeExBase<SelectionRangeTypes.T
      * Table that has cells selected
      */
     table: HTMLTableElement;
+    /**
+     * Coordinates of first and last Cell
+     */
+    coordinates: TableSelection;
 }
 
     /**
@@ -4068,6 +4134,10 @@ interface DOMEventPluginState {
      * Cached selection range
      */
     selectionRange: Range;
+    /**
+     * Table selection range
+     */
+    tableSelectionRange: TableSelectionRange;
     /**
      * stop propagation of a printable keyboard event
      */
@@ -4148,6 +4218,10 @@ interface LifecyclePluginState {
      * Cached selection path for original content
      */
     shadowEditSelectionPath: SelectionPath;
+    /**
+     * Cached table selection path for original content
+     */
+    shadowEditTableSelectionPath: SelectionPath[];
 }
 
     /**
@@ -4653,7 +4727,7 @@ function extractClipboardItems(items: DataTransferItem[], options?: ExtractClipb
  *   When set to undefined, it means can't retrieve HTML string, there may be HTML string but direct retrieving is
  *   not supported by browser.
  */
-function extractClipboardItemsForIE(dataTransfer: DataTransfer, callback: (data: ClipboardData) => void, options: ExtractClipboardItemsForIEOptions): void;
+function extractClipboardItemsForIE(dataTransfer: DataTransfer, callback: (data: ClipboardData) => void, options?: ExtractClipboardItemsForIEOptions): void;
 
     /**
  * A type-safe wrapper for Array.prototype.push.apply()
@@ -5050,22 +5124,22 @@ class VTable {
      * Current column index
      */
     col: number;
-    /**
-     * Current format of the table
-     */
-    formatInfo: TableFormat;
     /**
      * Selected range of cells with the coordinates of the first and last cell selected.
      */
     selection: TableSelection;
+    /**
+     * Current format of the table
+     */
+    formatInfo: TableFormat;
     private trs;
     /**
      * Create a new instance of VTable object using HTML TABLE or TD node
      * @param node The HTML Table or TD node
      * @param normalizeSize Whether table size needs to be normalized
-     * @param sizeTransformer A size transformer function used for normalize table size
+     * @param zoomScale When the table is under a zoomed container, pass in the zoom scale here
      */
-    constructor(node: HTMLTableElement | HTMLTableCellElement, normalizeSize?: boolean, sizeTransformer?: SizeTransformer);
+    constructor(node: HTMLTableElement | HTMLTableCellElement, normalizeSize?: boolean, zoomScale?: number | SizeTransformer);
     /**
      * Write the virtual table back to DOM tree to represent the change of VTable
      */
@@ -5076,39 +5150,10 @@ class VTable {
      */
     applyFormat(format: Partial<TableFormat>): void;
     /**
-     * Set color to the table
-     * @param format
-     */
-    private setColor;
-    /**
-     * Set color to borders of an table
-     * @param format
-     * @returns
-     */
-    private setBorderColors;
-    /**
-     * Format the border type
-     * @returns
-     */
-    private formatBorders;
-    /**
-     * Organize the borders of table according to a border type
-     * @param format
-     * @returns
+     * Remove the cellshade dataset to apply a new style format at the cell.
+     * @param cells
      */
-    private setBordersType;
-    /**
-     * Apply custom design to the first table column
-     * @param format
-     * @returns
-     */
-    private setFirstColumnFormat;
-    /**
-     * Apply custom design to the Header Row
-     * @param format
-     * @returns
-     */
-    private setHeaderRowFormat;
+    private deleteCellShadeDataset;
     /**
      * Edit table with given operation.
      * @param operation Table operation
@@ -5172,7 +5217,7 @@ class VTable {
     private countSpanLeft;
     private countSpanAbove;
     private normalizeEmptyTableCells;
-    normalizeTableCellSize(sizeTransformer?: SizeTransformer): void;
+    normalizeTableCellSize(zoomScale?: number | SizeTransformer): void;
     private normalizeSize;
 }
 
@@ -5758,7 +5803,7 @@ class HtmlSanitizer {
      * @param currentStyles Current CSS styles. Inheritable styles in the given node which has
      * the same value with current styles will be ignored.
      */
-    sanitize(rootNode: Node, currentStyles?: StringMap): string;
+    sanitize(rootNode: Node, currentStyles?: StringMap): "" | undefined;
     /**
      * Convert global CSS into inline CSS
      * @param rootNode The HTML Document
@@ -5775,7 +5820,7 @@ class HtmlSanitizer {
  * Get inheritable CSS style values from the given element
  * @param element The element to get style from
  */
-function getInheritableStyles(element: HTMLElement): StringMap;
+function getInheritableStyles(element: HTMLElement | null): StringMap;
 
     /**
  * Create default value of HtmlSanitizerOptions with every property set
@@ -6229,9 +6274,23 @@ class Editor implements IEditor  {
      */
     getTrustedHTMLHandler(): TrustedHTMLHandler;
     /**
-     * Get a transformer function. It transform the size changes according to current situation.
+     * @deprecated Use getZoomScale() instead
      */
     getSizeTransformer(): SizeTransformer;
+    /**
+     * Get current zoom scale, default value is 1
+     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
+     * to let editor behave correctly especially for those mouse drag/drop behaviors
+     * @returns current zoom scale number
+     */
+    getZoomScale(): number;
+    /**
+     * Set current zoom scale, default value is 1
+     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
+     * to let editor behave correctly especially for those mouse drag/drop behaviors
+     * @param scale The new scale number to set. It should be positive number and no greater than 10, otherwise it will be ignored.
+     */
+    setZoomScale(scale: number): void;
 }
 
     /**
@@ -7260,13 +7319,13 @@ class TableCellSelection implements EditorPlugin  {
      * When press Backspace, delete the contents inside of the selection, if it is Table Selection
      */
     DeleteTableContents: BuildInEditFeature<PluginKeyboardEvent>;
-    private clearTableCellSelection;
     private clearState;
     private getNextTD;
     private prepareSelection;
     private setData;
     private isAfter;
     private shouldConvertToTableSelection;
+    selectTable(): void;
 }
 
 }