roosterjs 8.45.1 → 8.46.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.45.1)
+// Type definitions for roosterjs (Version 8.46.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -402,6 +402,19 @@ function extractClipboardItems(items: DataTransferItem[], options?: ExtractClipb
  */
 function extractClipboardItemsForIE(dataTransfer: DataTransfer, callback: (data: ClipboardData) => void, options?: ExtractClipboardItemsForIEOptions): void;
 
+    /**
+ * Create a DocumentFragment for paste from a ClipboardData
+ * @param core The EditorCore object.
+ * @param clipboardData Clipboard data retrieved from clipboard
+ * @param position The position to paste to
+ * @param pasteAsText True to force use plain text as the content to paste, false to choose HTML or Image if any
+ * @param applyCurrentStyle True if apply format of current selection to the pasted content,
+ * @param pasteAsImage Whether to force paste as image
+ * @param event Event to trigger.
+ * false to keep original format
+ */
+function createFragmentFromClipboardData(core: EditorCore, clipboardData: ClipboardData, position: NodePosition | null, pasteAsText: boolean, applyCurrentStyle: boolean, pasteAsImage: boolean, event: BeforePasteEvent): DocumentFragment;
+
     /**
  * Browser object contains browser and operating system information of current environment
  */
@@ -1782,8 +1795,7 @@ function removeImportantStyleRule(element: HTMLElement, styleProperties: string[
  * Add global css styles
  * @param doc The document object
  * @param cssRule The css rule that must added to the selection
- * @param editorId Te id of the editor
- * @param styleId the ID of the style tag
+ * @param styleId The id of the style tag
  */
 function setGlobalCssStyles(doc: Document, cssRule: string, styleId: string): void;
 
@@ -1946,6 +1958,14 @@ function toArray<T extends Element>(collection: HTMLCollectionOf<T>): T[];
  */
 function toArray<T>(array: readonly T[]): T[];
 
+    /**
+ * This function tries to get the source of the Pasted content
+ * @param event the before paste event
+ * @param shouldConvertSingleImage Whether convert single image is enabled.
+ * @returns The Type of pasted content, if no type found will return {KnownSourceType.Default}
+ */
+function getPasteSource(event: BeforePasteEvent, shouldConvertSingleImage: boolean): KnownPasteSourceType;
+
     /**
  * RoosterJs core editor class
  */
@@ -2094,7 +2114,7 @@ class EditorBase<TEditorCore extends EditorCore, TEditorOptions extends EditorOp
      * Focus to this editor, the selection was restored to where it was before, no unexpected scroll.
      */
     focus(): void;
-    select(arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection, arg3?: Node, arg4?: number | PositionType): boolean;
+    select(arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection | null, arg3?: Node, arg4?: number | PositionType): boolean;
     /**
      * Get current focused position. Return null if editor doesn't have focus at this time.
      */
@@ -3771,6 +3791,10 @@ const enum ExperimentalFeatures {
      * Reuse existing DOM structure if possible when convert Content Model back to DOM tree
      */
     ReusableContentModel = "ReusableContentModel",
+    /**
+     * Apply default format on editor container
+     */
+    DefaultFormatOnContainer = "DefaultFormatOnContainer",
     /**
      * Delete table with Backspace key with the whole was selected with table selector
      */
@@ -3778,7 +3802,11 @@ const enum ExperimentalFeatures {
     /**
      * Add entities around a Read Only  Inline entity to prevent cursor to be hidden when cursor is next of it.
      */
-    InlineEntityReadOnlyDelimiters = "InlineEntityReadOnlyDelimiters"
+    InlineEntityReadOnlyDelimiters = "InlineEntityReadOnlyDelimiters",
+    /**
+     * Paste with Content model
+     */
+    ContentModelPaste = "ContentModelPaste"
 }
 
     /**
@@ -4152,6 +4180,20 @@ const enum KnownCreateElementDataIndex {
     EmptyLineFormatInSpan = 12
 }
 
+    /**
+ * Represent the types of sources to handle in the Paste Plugin
+ */
+const enum KnownPasteSourceType {
+    WordDesktop = 0,
+    ExcelDesktop = 1,
+    ExcelOnline = 2,
+    PowerPointDesktop = 3,
+    GoogleSheets = 4,
+    WacComponents = 5,
+    Default = 6,
+    SingleImage = 7
+}
+
     /**
  * Table format border
  */
@@ -6072,7 +6114,7 @@ interface HtmlSanitizerOptions {
      *
      * For other unknown tags, we will respect the value of unknownTagReplacement with the same meaning
      */
-    additionalTagReplacements?: Record<string, string>;
+    additionalTagReplacements?: Record<string, string | null>;
     /**
      * Allowed HTML attributes in addition to default attributes, in lower case
      */
@@ -6454,9 +6496,9 @@ interface IEditor {
     /**
      * Select content using the Table Selection
      * @param table to select
-     * @param coordinates first and last cell of the range
+     * @param coordinates first and last cell of the range, if null is provided will remove the selection on the table
      */
-    select(table: HTMLTableElement, coordinates: TableSelection): boolean;
+    select(table: HTMLTableElement, coordinates: TableSelection | null): boolean;
     /**
      * Select content SelectionRangeEx
      * @param rangeEx SelectionRangeEx object to specify what to select
@@ -7124,7 +7166,7 @@ interface CoreApiMap {
      * There are a bunch of allowed combination of parameters. See IEditor.select for more details
      * @param core The editor core object
      * @param arg1 A DOM Range, or SelectionRangeEx, or NodePosition, or Node, or Selection Path
-     * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection
+     * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection, or null
      * @param arg3 (optional) A Node
      * @param arg4 (optional) An offset number, or a PositionType
      */
@@ -7282,11 +7324,11 @@ type RestoreUndoSnapshot = (core: EditorCore, step: number) => void;
  * There are a bunch of allowed combination of parameters. See IEditor.select for more details
  * @param core The editor core object
  * @param arg1 A DOM Range, or SelectionRangeEx, or NodePosition, or Node, or Selection Path
- * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection
+ * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection, or null
  * @param arg3 (optional) A Node
  * @param arg4 (optional) An offset number, or a PositionType
  */
-type Select = (core: EditorCore, arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection, arg3?: Node, arg4?: number | PositionType) => boolean;
+type Select = (core: EditorCore, arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection | null, arg3?: Node, arg4?: number | PositionType) => boolean;
 
     /**
  * Change the editor selection to the given range
@@ -8409,6 +8451,10 @@ enum CompatibleExperimentalFeatures {
      * Reuse existing DOM structure if possible when convert Content Model back to DOM tree
      */
     ReusableContentModel = "ReusableContentModel",
+    /**
+     * Apply default format on editor container
+     */
+    DefaultFormatOnContainer = "DefaultFormatOnContainer",
     /**
      * Delete table with Backspace key with the whole was selected with table selector
      */
@@ -8416,7 +8462,11 @@ enum CompatibleExperimentalFeatures {
     /**
      * Add entities around a Read Only  Inline entity to prevent cursor to be hidden when cursor is next of it.
      */
-    InlineEntityReadOnlyDelimiters = "InlineEntityReadOnlyDelimiters"
+    InlineEntityReadOnlyDelimiters = "InlineEntityReadOnlyDelimiters",
+    /**
+     * Paste with Content model
+     */
+    ContentModelPaste = "ContentModelPaste"
 }
 
     /**
@@ -9510,6 +9560,20 @@ enum CompatibleKnownCreateElementDataIndex {
     EmptyLineFormatInSpan = 12
 }
 
+    /**
+ * Represent the types of sources to handle in the Paste Plugin
+ */
+enum CompatibleKnownPasteSourceType {
+    WordDesktop = 0,
+    ExcelDesktop = 1,
+    ExcelOnline = 2,
+    PowerPointDesktop = 3,
+    GoogleSheets = 4,
+    WacComponents = 5,
+    Default = 6,
+    SingleImage = 7
+}
+
     /**
  * Type of list (numbering or bullet)
  */
@@ -10405,15 +10469,8 @@ class Watermark implements EditorPlugin  {
  */
 class TableCellSelection implements EditorPlugin  {
     private editor;
-    private lastTarget;
-    private firstTarget;
-    private tableRange;
-    private tableSelection;
-    private startedSelection;
-    private vTable;
-    private firstTable;
-    private targetTable;
-    private preventKeyUp;
+    private state;
+    private shadowEditCoordinatesBackup;
     constructor();
     /**
      * Get a friendly name of  this plugin
@@ -10433,37 +10490,8 @@ class TableCellSelection implements EditorPlugin  {
      * @param event PluginEvent object
      */
     onPluginEvent(event: PluginEvent): void;
-    /**
-     * Handle Scroll Event and mantains the selection range,
-     * Since when we scroll the cursor does not trigger the on Mouse Move event
-     * The table selection gets removed.
-     */
-    private handleScrollEvent;
-    /**
-     * Handles the on key event.
-     * @param event the plugin event
-     */
-    private handleKeyDownEvent;
-    private handleKeyUpEvent;
-    private handleKeySelectionInsideTable;
-    private handleMouseDownEvent;
-    private onMouseMove;
-    private onMouseUp;
-    private restoreSelection;
-    /**
-     * @internal
-     * Public only for unit testing
-     * @param event mouse event
-     */
-    selectionInsideTableMouseMove(event: MouseEvent): void;
-    private removeMouseUpEventListener;
-    private clearState;
-    private getNextTD;
-    private prepareSelection;
-    private setData;
-    private isAfter;
-    private shouldConvertToTableSelection;
-    selectTable(): void;
+    private handleLeavingShadowEdit;
+    private handleEnteredShadowEdit;
 }
 
     /**