roosterjs 9.36.0 → 9.37.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.36.0)
+// Type definitions for roosterjs (Version 9.37.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -6336,10 +6336,16 @@ interface MouseUpEvent extends BasePluginDomEvent<'mouseUp', MouseEvent> {
     isClicking?: boolean;
 }
 
+    /**
+ * This interface represents a PluginEvent wrapping native dblClick event
+ */
+interface DoubleClickEvent extends BasePluginDomEvent<'doubleClick', MouseEvent> {
+}
+
     /**
  * Editor plugin event interface
  */
-type PluginEvent = BeforeAddUndoSnapshotEvent | BeforeCutCopyEvent | BeforeDisposeEvent | BeforeKeyboardEditingEvent | BeforeLogicalRootChangeEvent | BeforePasteEvent | BeforeSetContentEvent | CompositionEndEvent | ContentChangedEvent | ContextMenuEvent | RewriteFromModelEvent | EditImageEvent | EditorReadyEvent | EnterShadowEditEvent | EntityOperationEvent | ExtractContentWithDomEvent | EditorInputEvent | KeyDownEvent | KeyPressEvent | KeyUpEvent | LeaveShadowEditEvent | LogicalRootChangedEvent | MouseDownEvent | MouseUpEvent | ScrollEvent | SelectionChangedEvent | ZoomChangedEvent;
+type PluginEvent = BeforeAddUndoSnapshotEvent | BeforeCutCopyEvent | BeforeDisposeEvent | BeforeKeyboardEditingEvent | BeforeLogicalRootChangeEvent | BeforePasteEvent | BeforeSetContentEvent | CompositionEndEvent | ContentChangedEvent | ContextMenuEvent | RewriteFromModelEvent | EditImageEvent | EditorReadyEvent | EnterShadowEditEvent | EntityOperationEvent | ExtractContentWithDomEvent | EditorInputEvent | KeyDownEvent | KeyPressEvent | KeyUpEvent | LeaveShadowEditEvent | LogicalRootChangedEvent | MouseDownEvent | MouseUpEvent | ScrollEvent | SelectionChangedEvent | ZoomChangedEvent | PointerDownEvent | PointerUpEvent | DoubleClickEvent;
 
     /**
  * A type to extract data part of a plugin event type. Data part is the plugin event without eventType field.
@@ -6484,7 +6490,19 @@ type PluginEventType = /**
  * Before an undo snapshot is added to the undo stack.
  * This event is used to give plugins a chance to add additional state to the snapshot.
  */
- | 'beforeAddUndoSnapshot';
+ | 'beforeAddUndoSnapshot'
+/**
+ * HTML PointerDown event - for touch only
+ */
+ | 'pointerDown'
+/**
+ * HTML PointerUp event - for touch only
+ */
+ | 'pointerUp'
+/**
+ * HTML double click event
+ */
+ | 'doubleClick';
 
     /**
  * This interface represents a PluginEvent wrapping native scroll event
@@ -6530,6 +6548,20 @@ interface ZoomChangedEvent extends BasePluginEvent<'zoomChanged'> {
     newZoomScale: number;
 }
 
+    /**
+ * This interface represents a PluginEvent wrapping native PointerDown event
+ */
+interface PointerDownEvent extends BasePluginDomEvent<'pointerDown', PointerEvent> {
+    originalEvent: MouseEvent | TouchEvent;
+}
+
+    /**
+ * This interface represents a PluginEvent wrapping native PointerUp event
+ */
+interface PointerUpEvent extends BasePluginDomEvent<'pointerUp', PointerEvent> {
+    originalEvent: MouseEvent | TouchEvent;
+}
+
     /**
  * Create Content Model from DOM tree in this editor
  * @param root Root element of DOM tree to create Content Model from
@@ -9078,6 +9110,7 @@ class EditPlugin implements EditorPlugin  {
     willHandleEventExclusively(event: PluginEvent): boolean;
     private handleKeyDownEvent;
     private handleBeforeInputEvent;
+    private shouldBrowserHandleBackspace;
 }
 
     /**
@@ -9100,6 +9133,13 @@ type EditOptions = {
      * @returns A boolean
      */
     shouldHandleEnterKey?: ((editor: IEditor) => boolean) | boolean;
+    /**
+     * Callback or boolean to determine whether the browser (not Content Model) should handle the Backspace key press.
+     * If the value/callback returns true, Rooster will NOT handle Backspace and will defer to the browser's native behavior.
+     * @param editor - The editor instance (when using callback).
+     * @returns A boolean
+     */
+    shouldHandleBackspaceKey?: ((editor: IEditor) => boolean) | boolean;
 };
 
     /**
@@ -9935,7 +9975,7 @@ class ImageEditPlugin implements ImageEditor, EditorPlugin  {
     /**
      * EXPOSED FOR TESTING PURPOSE ONLY
      */
-    protected applyFormatWithContentModel(editor: IEditor, isCropMode: boolean, shouldSelectImage: boolean, isApiOperation?: boolean): void;
+    protected applyFormatWithContentModel(editor: IEditor, isCropMode: boolean, shouldSelectImage?: boolean, isApiOperation?: boolean): void;
     private startEditing;
     private updateImageDimensionsIfZero;
     private startEditingInternal;
@@ -9978,7 +10018,7 @@ interface ImageEditOptions {
     /**
      * Whether preserve width/height ratio when resize
      * Pressing SHIFT key when resize will for preserve ratio even this value is set to false
-     * @default false
+     * @default true
      */
     preserveRatio?: boolean;
     /**
@@ -10060,6 +10100,38 @@ interface HiddenPropertyOptions {
     undeletableLinkChecker?: (link: HTMLAnchorElement) => boolean;
 }
 
+    /**
+ * Touch plugin to manage touch behaviors
+ */
+class TouchPlugin implements EditorPlugin  {
+    private editor;
+    private timer;
+    private isDblClicked;
+    private isTouchPenPointerEvent;
+    /**
+     * Create an instance of Touch plugin
+     */
+    constructor();
+    /**
+     * Get a friendly name of  this plugin
+     */
+    getName(): string;
+    /**
+     * Initialize this plugin. This should only be called from Editor
+     * @param editor Editor instance
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * Dispose this plugin
+     */
+    dispose(): void;
+    /**
+     * Handle events triggered from editor
+     * @param event PluginEvent object
+     */
+    onPluginEvent(event: PluginEvent): void;
+}
+
     /**
  * Get dark mode color for a given color
  * @param color The color to calculate from