roosterjs 9.48.0 → 9.50.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.48.0)
+// Type definitions for roosterjs (Version 9.50.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -3158,6 +3158,12 @@ export interface ModelToDomListContext {
      * A stack of current list element chain, start from the parent node of top level list
      */
     nodeStack: ModelToDomListStackItem[];
+    /**
+     * Current level of list item being processed, start from 0
+     * This is used by metadata applier to determine which level of list item is being processed,
+     * so it can apply correct list style for that level. It will be updated by list handler before processing each list item, and reset to 0 when processing a new list.
+     */
+    currentLevel: number;
 }
 
 /**
@@ -6255,6 +6261,12 @@ export interface BeforeCutCopyEvent extends BasePluginDomEvent<'beforeCutCopy',
 export interface BeforeDisposeEvent extends BasePluginEvent<'beforeDispose'> {
 }
 
+/**
+ * Data of BeforeDropEvent
+ */
+export interface BeforeDropEvent extends BasePluginDomEvent<'beforeDrop', DragEvent> {
+}
+
 /**
  * Provides a chance for plugin to change the content before it is copied from editor.
  */
@@ -6609,7 +6621,7 @@ export interface DoubleClickEvent extends BasePluginDomEvent<'doubleClick', Mous
 /**
  * Editor plugin event interface
  */
-export 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 | FindResultChangedEvent;
+export type PluginEvent = BeforeAddUndoSnapshotEvent | BeforeCutCopyEvent | BeforeDisposeEvent | BeforeDropEvent | 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 | FindResultChangedEvent;
 
 /**
  * A type to extract data part of a plugin event type. Data part is the plugin event without eventType field.
@@ -6770,7 +6782,11 @@ export type PluginEventType = /**
 /**
  * Find result changed event
  */
- | 'findResultChanged';
+ | 'findResultChanged'
+/**
+ * Let plugin know when a content will be dropped
+ */
+ | 'beforeDrop';
 
 /**
  * This interface represents a PluginEvent wrapping native scroll event
@@ -7408,6 +7424,15 @@ export function normalizeParagraph(paragraph: ReadonlyContentModelParagraph): vo
  */
 export function normalizeContentModel(group: ReadonlyContentModelBlockGroup): void;
 
+/**
+ * Strip invisible Unicode characters from all text and link hrefs in a content model.
+ * This sanitizes the model at initialization time to prevent hidden content in links
+ * or text (e.g. zero-width chars, bidirectional marks, Unicode Tags).
+ * For General segments, all Text nodes under the element are also sanitized.
+ * @param model The content model document to sanitize in-place
+ */
+export function sanitizeInvisibleUnicode(model: ContentModelDocument): void;
+
 /**
  * Check if the given block group is a general segment
  * @param group The group to check
@@ -7725,6 +7750,19 @@ export function isSpace(char: string): boolean;
  */
 export function normalizeText(txt: string, isForward: boolean): string;
 
+/**
+ * Strip invisible Unicode characters from a string.
+ * This removes zero-width characters, bidirectional marks, Unicode Tags (U+E0001-U+E00FF),
+ * interlinear annotation anchors, Mongolian free variation selectors,
+ * and other invisible formatting characters that can be used to hide content in links.
+ *
+ * @remarks This function strips ZWJ (U+200D) which may affect emoji sequences.
+ * It should only be applied to href attributes, not to visible text content.
+ * @param value The string to strip invisible characters from
+ * @returns The string with invisible characters removed
+ */
+export function stripInvisibleUnicode(value: string): string;
+
 /**
  * Parse a table into a two dimensions array of TD elements. For those merged cells, the value will be null.
  * @param table Input HTML Table element
@@ -7909,6 +7947,14 @@ export function getSelectedParagraphs(model: ContentModelDocument): ContentModel
  */
 export function getSelectedParagraphs(model: ReadonlyContentModelDocument, mutate: true): ShallowMutableContentModelParagraph[];
 
+/**
+ * Get any array of selected paragraphs from a content model, return mutable paragraphs
+ * @param model The Content Model to get selection from
+ * @param mutate Set to true to indicate we will mutate the selected paragraphs
+ * @param removeUnmeaningful True to remove unmeaningful selection like only selection marker is selected, or head/tail paragraph is selected with selection marker at the wrong place
+ */
+export function getSelectedParagraphs(model: ReadonlyContentModelDocument, mutate: true, removeUnmeaningful: boolean): ShallowMutableContentModelParagraph[];
+
 /**
  * Get any array of selected paragraphs from a content model (Readonly)
  * @param model The Content Model to get selection from
@@ -10767,6 +10813,56 @@ export class AnnouncePlugin implements EditorPlugin  {
     onPluginEvent(event: PluginEvent): void;
 }
 
+/**
+ * DragAndDrop plugin, handles ContentChanged event when change source is "Drop"
+ * to sanitize dropped content, similar to how PastePlugin sanitizes pasted content.
+ */
+export class DragAndDropPlugin implements EditorPlugin  {
+    private editor;
+    private forbiddenElements;
+    private isInternalDragging;
+    private disposer;
+    /**
+     * Construct a new instance of DragAndDropPlugin
+     */
+    constructor(options?: DragAndDropOptions);
+    /**
+     * Get name of this plugin
+     */
+    getName(): string;
+    /**
+     * The first method that editor will call to a plugin when editor is initializing.
+     * It will pass in the editor instance, plugin should take this chance to save the
+     * editor reference so that it can call to any editor method or format API later.
+     * @param editor The editor object
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * The last method that editor will call to a plugin before it is disposed.
+     * Plugin can take this chance to clear the reference to editor. After this method is
+     * called, plugin should not call to any editor method since it will result in error.
+     */
+    dispose(): void;
+    /**
+     * Core method for a plugin. Once an event happens in editor, editor will call this
+     * method of each plugin to handle the event as long as the event is not handled
+     * exclusively by another plugin.
+     * @param event The event to handle:
+     */
+    onPluginEvent(event: PluginEvent): void;
+}
+
+/**
+ * Options for DragAndDrop plugin
+ */
+export interface DragAndDropOptions {
+    /**
+     * Forbidden elements that cannot be dropped in the editor
+     * @default ['iframe']
+     */
+    forbiddenElements?: string[];
+}
+
 /**
  * Get dark mode color for a given color
  * @param color The color to calculate from