roosterjs 9.5.1 → 9.7.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.5.1)
+// Type definitions for roosterjs (Version 9.7.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -3068,6 +3068,16 @@ interface DomIndexer {
      * @returns True if reconcile successfully, otherwise false
      */
     reconcileSelection: (model: ContentModelDocument, newSelection: DOMSelection, oldSelection?: CacheSelection) => boolean;
+    /**
+     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.
+     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,
+     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment
+     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model
+     * @param addedNodes Nodes added by browser during mutation
+     * @param removedNodes Nodes removed by browser during mutation
+     * @returns True if the changed nodes are successfully reconciled, otherwise false
+     */
+    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;
 }
 
     /**
@@ -3083,9 +3093,11 @@ interface TextMutationObserver {
      */
     stopObserving(): void;
     /**
-     * Flush all pending mutations that have not be handled in order to ignore them
+     * Flush all pending mutations and update cached model if need
+     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.
+     * This should only be used when we already have a up-to-date content model and will set it as latest cache
      */
-    flushMutations(): void;
+    flushMutations(ignoreMutations?: boolean): void;
 }
 
     /**
@@ -7493,6 +7505,11 @@ const OrderedListStyleMap: Record<number, string>;
  */
 const UnorderedListStyleMap: Record<number, string>;
 
+    /**
+ * Provide a default empty instance of segment format with all its properties
+ */
+const EmptySegmentFormat: Readonly<Required<ContentModelSegmentFormat>>;
+
     /**
  * The main editor class based on Content Model
  */
@@ -7874,6 +7891,16 @@ function applySegmentFormat(editor: IEditor, newFormat: Readonly<ContentModelSeg
  */
 function changeCapitalization(editor: IEditor, capitalization: 'sentence' | 'lowerCase' | 'upperCase' | 'capitalize', language?: string): void;
 
+    /**
+ * Split given text segments from the given range
+ * @param textSegment segment to split
+ * @param parent parent paragraph the text segment exist in
+ * @param start starting point of the split
+ * @param end ending point of the split
+ * @returns text segment from the indicated split.
+ */
+function splitTextSegment(textSegment: ContentModelText, parent: ShallowMutableContentModelParagraph, start: number, end: number): ContentModelText;
+
     /**
  * Insert an image into current selected position
  * @param editor The editor to operate on
@@ -8310,11 +8337,17 @@ class PastePlugin implements EditorPlugin  {
  * 3. Tab Key
  */
 class EditPlugin implements EditorPlugin  {
+    private options;
     private editor;
     private disposer;
     private shouldHandleNextInputEvent;
     private selectionAfterDelete;
     private handleNormalEnter;
+    /**
+     * @param options An optional parameter that takes in an object of type EditOptions, which includes the following properties:
+     * handleTabKey: A boolean that enables or disables Tab key handling. Defaults to true.
+     */
+    constructor(options?: EditOptions);
     /**
      * Get name of this plugin
      */
@@ -8352,6 +8385,16 @@ class EditPlugin implements EditorPlugin  {
     private handleBeforeInputEvent;
 }
 
+    /**
+ * Options to customize the keyboard handling behavior of Edit plugin
+ */
+type EditOptions = {
+    /**
+     * Whether to handle Tab key in keyboard. @default true
+     */
+    handleTabKey?: boolean;
+};
+
     /**
  * Auto Format plugin handles auto formatting, such as transforming * characters into a bullet list.
  * It can be customized with options to enable or disable auto list features.
@@ -8701,6 +8744,7 @@ class WatermarkPlugin implements EditorPlugin  {
     private editor;
     private format;
     private isShowing;
+    private darkTextColor;
     /**
      * Create an instance of Watermark plugin
      * @param watermark The watermark string
@@ -8726,6 +8770,7 @@ class WatermarkPlugin implements EditorPlugin  {
     onPluginEvent(event: PluginEvent): void;
     private showHide;
     protected show(editor: IEditor): void;
+    private applyWatermarkStyle;
     protected hide(editor: IEditor): void;
 }
 
@@ -9114,7 +9159,7 @@ class ImageEditPlugin implements ImageEditor, EditorPlugin  {
     protected editor: IEditor | null;
     private shadowSpan;
     private selectedImage;
-    wrapper: HTMLSpanElement | null;
+    protected wrapper: HTMLSpanElement | null;
     private imageEditInfo;
     private imageHTMLOptions;
     private dndHelpers;
@@ -9127,6 +9172,7 @@ class ImageEditPlugin implements ImageEditor, EditorPlugin  {
     private croppers;
     private zoomScale;
     private disposer;
+    protected isEditing: boolean;
     constructor(options?: ImageEditOptions);
     /**
      * Get name of this plugin
@@ -9151,20 +9197,25 @@ class ImageEditPlugin implements ImageEditor, EditorPlugin  {
      * exclusively by another plugin.
      * @param event The event to handle:
      */
-    onPluginEvent(_event: PluginEvent): void;
+    onPluginEvent(event: PluginEvent): void;
+    private isImageSelection;
+    private mouseUpHandler;
+    private selectBeforeEditingImage;
+    private keyDownHandler;
+    private applyFormatWithContentModel;
     private startEditing;
-    startRotateAndResize(editor: IEditor, image: HTMLImageElement, apiOperation?: 'resize' | 'rotate'): void;
+    startRotateAndResize(editor: IEditor, image: HTMLImageElement): void;
     private updateRotateHandleState;
     isOperationAllowed(operation: ImageEditOperation): boolean;
     canRegenerateImage(image: HTMLImageElement): boolean;
+    private startCropMode;
     cropImage(): void;
     private editImage;
     private cleanInfo;
-    private formatImageWithContentModel;
     private removeImageWrapper;
     flipImage(direction: 'horizontal' | 'vertical'): void;
     rotateImage(angleRad: number): void;
-    getWrapper(): HTMLSpanElement | null;
+    get isEditingImage(): boolean;
 }
 
     /**
@@ -9219,7 +9270,7 @@ interface ImageEditOptions {
      * Which operations will be executed when image is selected
      * @default resizeAndRotate
      */
-    onSelectState?: ImageEditOperation;
+    onSelectState?: ImageEditOperation[];
 }
 
     /**