roosterjs 9.56.0 → 9.58.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.56.0)
+// Type definitions for roosterjs (Version 9.58.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -3890,6 +3890,11 @@ export interface IEditor {
      * @param featureName The name of feature to check
      */
     isExperimentalFeatureEnabled(featureName: ExperimentalFeature | string): boolean;
+    /**
+     * Get all experimental features enabled in this editor
+     * @returns An array of experimental feature names
+     */
+    getExperimentalFeatures(): ExperimentalFeature[];
 }
 
 /**
@@ -3920,7 +3925,11 @@ export type ExperimentalFeature = GraduatedExperimentalFeature
  * These characters can be used to hide text in HTML and may cause unexpected behavior.
  * @see https://embracethered.com/blog/posts/2024/hiding-and-finding-text-with-unicode-tags/
  */
- | 'FilterInvisibleUnicode';
+ | 'FilterInvisibleUnicode'
+/**
+ * Handle the drop event for content that is dropped from the same editor instance.
+ */
+ | 'HandleDropInternalContent';
 
 /**
  * Predefined experiment features (Graduated, only keep them for backward compatibility)
@@ -5101,6 +5110,10 @@ export interface FormatContentModelOptions {
      * When pass to true, scroll the editing caret into view after write DOM tree if need
      */
     scrollCaretIntoView?: boolean;
+    /**
+     * When pass to true, skip setting DOM selection after write DOM tree. @default false
+     */
+    skipDOMSelection?: boolean;
 }
 
 /**
@@ -5259,9 +5272,19 @@ export interface ContentModelFormatState {
 
 /**
  * Represents the PasteType parameter used to set the paste type to use.
- * It can be either the Paste Type value or a callback that retuns the Paste Type to use.
+ * It can be either the Paste Type value or a callback that returns the Paste Type to use.
  */
-export type PasteTypeOrGetter = PasteType | ((document: Document | null, clipboardData: ClipboardData) => PasteType);
+export type PasteTypeOrGetter = PasteType | PasteTypeGetter;
+
+/**
+ * A function that returns the Paste Type to use based on the pasted content and clipboard data.
+ * @param document The document parsed from the clipboard raw HTML, or null when there is no HTML
+ * @param clipboardData Clipboard data retrieved from clipboard
+ * @param environment The editor environment information
+ * @param htmlAttributes The metadata (HTML attributes) retrieved from the pasted content
+ * @returns The Paste Type to use
+ */
+export type PasteTypeGetter = (document: Document | null, clipboardData: ClipboardData, environment: EditorEnvironment, htmlAttributes: Record<string, string>) => PasteType;
 
 /**
  * Image Format
@@ -5724,7 +5747,14 @@ export 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
@@ -6041,6 +6071,11 @@ export 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;
 }
 
 /**
@@ -7929,6 +7964,16 @@ export function normalizeFontFamily(fontFamily: string): string;
  */
 export 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
+ */
+export 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.
@@ -8386,6 +8431,10 @@ export const ChangeSource: {
      * Content changed by paste
      */
     Paste: string;
+    /**
+     * Content changed by auto markdown conversion
+     */
+    AutoMarkdownConversion: string;
     /**
      * Content changed by setContent API
      */
@@ -8427,6 +8476,10 @@ export const ChangeSource: {
      * Content changed by replace
      */
     Replace: string;
+    /**
+     * Content changed by dragging content out the editor
+     */
+    DragOutOfEditor: string;
 };
 
 /**
@@ -8862,6 +8915,11 @@ export class Editor implements IEditor  {
      * @param featureName The name of feature to check
      */
     isExperimentalFeatureEnabled(featureName: ExperimentalFeature | string): boolean;
+    /**
+     * Get all experimental features enabled in this editor
+     * @returns An array of experimental feature names
+     * */
+    getExperimentalFeatures(): ExperimentalFeature[];
     /**
      * @returns the current EditorCore object
      * @throws a standard Error if there's no core object
@@ -10933,7 +10991,7 @@ export class AnnouncePlugin implements EditorPlugin  {
 export class DragAndDropPlugin implements EditorPlugin  {
     private editor;
     private forbiddenElements;
-    private isInternalDragging;
+    private internalDrag;
     private disposer;
     /**
      * Construct a new instance of DragAndDropPlugin
@@ -10963,6 +11021,8 @@ export class DragAndDropPlugin implements EditorPlugin  {
      * @param event The event to handle:
      */
     onPluginEvent(event: PluginEvent): void;
+    private adjustDraggingCursor;
+    private handleDragOutOfTheEditor;
 }
 
 /**