roosterjs 9.55.0 → 9.57.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.55.0)
+// Type definitions for roosterjs (Version 9.57.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -103,6 +103,11 @@ type ContentModelHyperLinkFormat = LinkFormat & TextColorFormat & BackgroundColo
  */
 type ContentModelCodeFormat = FontFamilyFormat & DisplayFormat;
 
+    /**
+ * The format object for a data element (<data>) in Content Model
+ */
+type ContentModelDataFormat = DataValueFormat;
+
     /**
  * Type for FormatContainer
  */
@@ -217,6 +222,10 @@ interface ContentModelFormatMap {
      * Format type for code
      */
     code: FontFamilyFormat;
+    /**
+     * Format type for data, used by HTML <data> element
+     */
+    data: ContentModelDataFormat;
     /**
      * Format type for dataset
      */
@@ -285,6 +294,10 @@ interface FormatHandlerTypeMap {
      * Format for DatasetFormat
      */
     dataset: DatasetFormat;
+    /**
+     * Format for DataValueFormat, used by HTML <data> element
+     */
+    dataValue: DataValueFormat;
     /**
      * Format for DirectionFormat
      */
@@ -506,6 +519,16 @@ type LetterSpacingFormat = {
     letterSpacing?: string;
 };
 
+    /**
+ * Format of the value of a HTML "data" element
+ */
+type DataValueFormat = {
+    /**
+     * The machine-readable value, represented by the "value" attribute of a HTML "data" element
+     */
+    dataValue?: string;
+};
+
     /**
  * Format of line height
  */
@@ -2171,6 +2194,10 @@ interface ContentModelSegmentBase<T extends ContentModelSegmentType, TFormat ext
      * Code info
      */
     code?: ContentModelCode;
+    /**
+     * Data info, used by HTML &lt;data&gt; element
+     */
+    data?: ContentModelData;
 }
 
     /**
@@ -2195,6 +2222,10 @@ interface ReadonlyContentModelSegmentBase<T extends ContentModelSegmentType, TFo
      * Code info
      */
     readonly code?: ReadonlyContentModelCode;
+    /**
+     * Data info, used by HTML &lt;data&gt; element
+     */
+    readonly data?: ReadonlyContentModelData;
 }
 
     /**
@@ -2209,6 +2240,10 @@ interface ShallowMutableContentModelSegmentBase<T extends ContentModelSegmentTyp
      * Code info
      */
     code?: ContentModelCode;
+    /**
+     * Data info, used by HTML &lt;data&gt; element
+     */
+    data?: ContentModelData;
 }
 
     /**
@@ -2240,6 +2275,22 @@ interface ContentModelCode extends MutableMark, ContentModelWithFormat<ContentMo
  * since code is also a kind of segment, with some extra information
  */
 interface ReadonlyContentModelCode extends ReadonlyMark, ReadonlyContentModelWithFormat<ContentModelCodeFormat> {
+}
+
+    /**
+ * Represent data info of Content Model, used by HTML &lt;data&gt; element.
+ * ContentModelData is a decorator but not a standalone model type, instead it need to be put inside a ContentModelSegment
+ * since the &lt;data&gt; element is also a kind of segment, with some extra information
+ */
+interface ContentModelData extends MutableMark, ContentModelWithFormat<ContentModelDataFormat> {
+}
+
+    /**
+ * Represent data info of Content Model, used by HTML &lt;data&gt; element. (Readonly)
+ * ContentModelData is a decorator but not a standalone model type, instead it need to be put inside a ContentModelSegment
+ * since the &lt;data&gt; element is also a kind of segment, with some extra information
+ */
+interface ReadonlyContentModelData extends ReadonlyMark, ReadonlyContentModelWithFormat<ContentModelDataFormat> {
 }
 
     /**
@@ -2287,12 +2338,12 @@ interface ReadonlyContentModelParagraphDecorator extends ReadonlyMark, ReadonlyC
     /**
  * Union type for segment decorators
  */
-type ContentModelDecorator = ContentModelLink | ContentModelCode | ContentModelListLevel;
+type ContentModelDecorator = ContentModelLink | ContentModelCode | ContentModelData | ContentModelListLevel;
 
     /**
  * Union type for segment decorators (Readonly)
  */
-type ReadonlyContentModelDecorator = ReadonlyContentModelLink | ReadonlyContentModelCode | ReadonlyContentModelListLevel;
+type ReadonlyContentModelDecorator = ReadonlyContentModelLink | ReadonlyContentModelCode | ReadonlyContentModelData | ReadonlyContentModelListLevel;
 
     /**
  * Content Model of List Level
@@ -3048,6 +3099,10 @@ interface DomToModelDecoratorContext {
      * Context of code info
      */
     code: ContentModelCode;
+    /**
+     * Context of data info, used by HTML &lt;data&gt; element
+     */
+    data: ContentModelData;
     /**
      * Context for paragraph decorator
      */
@@ -3836,6 +3891,11 @@ 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[];
 }
 
     /**
@@ -3866,7 +3926,11 @@ 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)
@@ -5047,6 +5111,10 @@ 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;
 }
 
     /**
@@ -5205,9 +5273,19 @@ 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.
+ */
+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
  */
-type PasteTypeOrGetter = PasteType | ((document: Document | null, clipboardData: ClipboardData) => PasteType);
+type PasteTypeGetter = (document: Document | null, clipboardData: ClipboardData, environment: EditorEnvironment, htmlAttributes: Record<string, string>) => PasteType;
 
     /**
  * Image Format
@@ -7363,9 +7441,10 @@ function createTableCell(spanLeftOrColSpan?: boolean | number, spanAboveOrRowSpa
  * @param text Text of this model
  * @param format @optional The format of this model
  * @param link @optional The link decorator
- * @param code @option The code decorator
+ * @param code @optional The code decorator
+ * @param data @optional The data decorator
  */
-function createText(text: string, format?: Readonly<ContentModelSegmentFormat>, link?: ReadonlyContentModelLink, code?: ReadonlyContentModelCode): ContentModelText;
+function createText(text: string, format?: Readonly<ContentModelSegmentFormat>, link?: ReadonlyContentModelLink, code?: ReadonlyContentModelCode, data?: ReadonlyContentModelData): ContentModelText;
 
     /**
  * Create a ContentModelImage model
@@ -8331,6 +8410,10 @@ const ChangeSource: {
      * Content changed by paste
      */
     Paste: string;
+    /**
+     * Content changed by auto markdown conversion
+     */
+    AutoMarkdownConversion: string;
     /**
      * Content changed by setContent API
      */
@@ -8807,6 +8890,11 @@ 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
@@ -10878,7 +10966,7 @@ class AnnouncePlugin implements EditorPlugin  {
 class DragAndDropPlugin implements EditorPlugin  {
     private editor;
     private forbiddenElements;
-    private isInternalDragging;
+    private internalDrag;
     private disposer;
     /**
      * Construct a new instance of DragAndDropPlugin