roosterjs 9.57.0 → 9.59.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.57.0)
+// Type definitions for roosterjs (Version 9.59.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -3911,10 +3911,6 @@ type ExperimentalFeature = GraduatedExperimentalFeature
  * the original formatting of the selection marker is kept to match the pending format.
  */
  | 'KeepSelectionMarkerWhenEnteringTextNode'
-/**
- * Transform the table border colors when switching from light to dark mode
- */
- | 'TransformTableBorderColors'
 /**
  * When the editor content div is inside a Shadow DOM, enable shadow root detection
  * in DOMHelper so that selection, focus, and element appending work correctly within
@@ -3971,7 +3967,12 @@ type GraduatedExperimentalFeature = /**
  * @deprecated
  * Allow caching list item elements.
  */
- | 'CacheList';
+ | 'CacheList'
+/**
+ * @deprecated
+ * Transform the table border colors when switching from light to dark mode
+ */
+ | 'TransformTableBorderColors';
 
     /**
  * Options for editor
@@ -4936,6 +4937,10 @@ interface EditorEnvironment {
      * Whether current browser is on mobile or a tablet
      */
     readonly isMobileOrTablet?: boolean;
+    /**
+     * Whether current browser supports touch input
+     */
+    readonly isTouchSupported?: boolean;
     /**
      * Settings used by DOM to Content Model conversion
      */
@@ -5748,7 +5753,14 @@ type KnownAnnounceStrings = /**
  * @example
  * {0}, unselected
  */
- | 'unselected';
+ | 'unselected'
+/**
+ * String announced when a new line is inserted in the editor.
+ * Used when Enter is pressed and a new line is inserted in the editor.
+ * @example
+ * New line inserted
+ */
+ | 'newLineInserted';
 
     /**
  * Options for announcing format changes
@@ -6039,7 +6051,9 @@ interface LinkData {
  */
 interface MergeModelOption {
     /**
-     * When there is only a table to merge, whether merge this table into current table (if any), or just directly insert (nested table).
+     * When there is only a table to merge, whether to merge this table into the current table,
+     * or into the table immediately before the insert position. Otherwise, insert it as a
+     * separate or nested table.
      * This is usually used when paste table inside a table
      * @default false
      */
@@ -6065,6 +6079,11 @@ interface MergeModelOption {
      * Whether to add a paragraph after the merged content.
      */
     addParagraphAfterMergedContent?: boolean;
+    /**
+     * Whether to merge into an empty paragraph immediately after a list as a new list item.
+     * @default false
+     */
+    mergeParagraphAfterList?: boolean;
 }
 
     /**
@@ -7018,6 +7037,49 @@ interface FindResultChangedEvent extends BasePluginEvent<'findResultChanged'> {
     readonly alternativeRange?: Range | null;
 }
 
+    /**
+ * An optional global hook for developer tools (such as the RoosterJS DevTools browser extension) to
+ * discover and inspect editor instances on a page.
+ *
+ * A developer tool installs an object implementing this interface on
+ * `window.__ROOSTERJS_DEVTOOLS_HOOK__`. When present, each editor will call its callbacks on
+ * creation, disposal and for every plugin event. This mirrors the React DevTools global hook
+ * pattern: the editor only detects and calls the hook, while all developer-tools logic lives in the
+ * tool that installs it.
+ *
+ * For tools that attach after editors are created (for example, a script pasted into the console),
+ * the library also maintains the array of live editors on `window.__ROOSTERJS_DEVTOOLS_EDITORS__`.
+ *
+ * All members are optional so the contract can grow without breaking older tools. The editor calls
+ * each callback defensively and swallows any error, so a faulty tool can never break editing.
+ */
+interface RoosterJsDevToolsHook {
+    /**
+     * The contract version the editor was built against. The editor stamps this onto the hook when
+     * it detects it, so a tool can read it to stay compatible across editor versions. The current
+     * contract version is exported as `RoosterJsDevToolsHookVersion` from
+     * `roosterjs-content-model-core`.
+     */
+    version?: number;
+    /**
+     * Called right after an editor finishes initialization.
+     * @param editor The editor that was created
+     */
+    onEditorCreated?: (editor: IEditor) => void;
+    /**
+     * Called right before an editor is disposed.
+     * @param editor The editor that is being disposed
+     */
+    onEditorDisposed?: (editor: IEditor) => void;
+    /**
+     * Called for every plugin event dispatched by an editor, so a tool can react to content and
+     * selection changes. Tools are expected to filter and debounce as needed.
+     * @param editor The editor that dispatched the event
+     * @param event The plugin event being dispatched
+     */
+    onPluginEvent?: (editor: IEditor, event: PluginEvent) => void;
+}
+
     /**
  * Create Content Model from DOM tree in this editor
  * @param root Root element of DOM tree to create Content Model from
@@ -7953,6 +8015,16 @@ function normalizeFontFamily(fontFamily: string): string;
  */
 function extractClipboardItems(items: DataTransferItem[], allowedCustomPasteType?: string[], isPasteNative?: boolean): Promise<ClipboardData>;
 
+    /**
+ * Create a document fragment from clipboard content using the specified paste type
+ * @param document The document used to create the fragment
+ * @param clipboardData The clipboard data to convert
+ * @param pasteType The paste type that determines which clipboard content to use
+ * @param root The optional root element containing the parsed HTML content
+ * @returns A document fragment containing the content to paste
+ */
+function createPasteFragment(document: Document, clipboardData: ClipboardData, pasteType: PasteType, root: HTMLElement | undefined): DocumentFragment;
+
     /**
  * Gets the cached event data by cache key from event object if there is already one.
  * Otherwise, call getter function to create one, and cache it.
@@ -8455,6 +8527,10 @@ const ChangeSource: {
      * Content changed by replace
      */
     Replace: string;
+    /**
+     * Content changed by dragging content out the editor
+     */
+    DragOutOfEditor: string;
 };
 
     /**
@@ -8973,6 +9049,17 @@ function paste(editor: IEditor, clipboardData: ClipboardData, pasteTypeOrGetter?
  */
 function getContentForCopy(editor: IEditor, isCut: boolean, event: ClipboardEvent): TextAndHtmlContentForCopy | null;
 
+    /**
+ * The current version of the RoosterJS DevTools hook contract (see
+ * {@link RoosterJsDevToolsHook}). The editor stamps this onto the installed hook so a developer
+ * tool can adapt to the editor's capabilities. Bump this whenever the shape of the contract changes
+ * in a way tools may need to detect.
+ *
+ * History:
+ * - 1: onEditorCreated, onEditorDisposed, onPluginEvent
+ */
+const RoosterJsDevToolsHookVersion: number;
+
     /**
  * Insert table into editor at current selection
  * @param editor The editor instance
@@ -9445,6 +9532,12 @@ function findListItemsInSameThread(group: ReadonlyContentModelBlockGroup, curren
  */
 function setModelIndentation(model: ReadonlyContentModelDocument, indentation: 'indent' | 'outdent', length?: number, context?: FormatContentModelContext): boolean;
 
+    /**
+ * Determine text direction from the first strong directional character
+ * @param text Text to scan
+ */
+function getTextDirection(text: string): 'ltr' | 'rtl' | undefined;
+
     /**
  * Try to match a given string with link match rules, return matched link
  * @param url Input url to match
@@ -9545,12 +9638,14 @@ class TableEditPlugin implements EditorPlugin  {
      */
     onPluginEvent(e: PluginEvent): void;
     private onMouseMove;
+    private onTouchStart;
+    private updateTableEditor;
     /**
      * @internal Public only for unit test
      * @param entry Table to use when setting the Editors
      * @param event (Optional) Mouse event
      */
-    setTableEditor(entry: TableWithRoot | null, event?: MouseEvent): void;
+    setTableEditor(entry: TableWithRoot | null, event?: Event): void;
     private invalidateTableRects;
     private disposeTableEditor;
     private ensureTableRects;
@@ -9773,6 +9868,7 @@ interface HandleTabOptions {
 class AutoFormatPlugin implements EditorPlugin  {
     private options;
     private editor;
+    private blockDirections;
     /**
      * @param options An optional parameter that takes in an object of type AutoFormatOptions, which includes the following properties:
      *  - autoBullet: A boolean that enables or disables automatic bullet list formatting. Defaults to false.
@@ -9786,6 +9882,7 @@ class AutoFormatPlugin implements EditorPlugin  {
      *  - autoTel: A boolean that enables or disables automatic hyperlink telephone numbers transformation. Defaults to false.
      *  - autoMailto: A boolean that enables or disables automatic hyperlink email address transformation. Defaults to false.
      *  - autoHorizontalLine: A boolean that enables or disables automatic horizontal line creation. Defaults to false.
+     *  - autoDirection: A boolean that enables or disables automatic text direction. Defaults to false.
      */
     constructor(options?: AutoFormatOptions);
     /**
@@ -9820,6 +9917,8 @@ class AutoFormatPlugin implements EditorPlugin  {
     private enterFeatures;
     private handleKeyboardEvents;
     private handleEditorInputEvent;
+    private handleCompositionEndEvent;
+    private handleAutoDirection;
     private handleKeyDownEvent;
     private handleContentChangedEvent;
 }
@@ -9856,6 +9955,10 @@ interface AutoFormatOptions extends AutoLinkOptions  {
      * Auto Horizontal line
      */
     autoHorizontalLine?: boolean;
+    /**
+     * Automatically update block direction based on the first strong directional character
+     */
+    autoDirection?: boolean;
 }
 
     /**
@@ -10996,6 +11099,8 @@ class DragAndDropPlugin implements EditorPlugin  {
      * @param event The event to handle:
      */
     onPluginEvent(event: PluginEvent): void;
+    private adjustDraggingCursor;
+    private handleDragOutOfTheEditor;
 }
 
     /**