roosterjs 9.55.0 → 9.57.0

package/dist/rooster-amd.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
 
@@ -102,6 +102,11 @@ export type ContentModelHyperLinkFormat = LinkFormat & TextColorFormat & Backgro
  */
 export type ContentModelCodeFormat = FontFamilyFormat & DisplayFormat;
 
+/**
+ * The format object for a data element (<data>) in Content Model
+ */
+export type ContentModelDataFormat = DataValueFormat;
+
 /**
  * Type for FormatContainer
  */
@@ -216,6 +221,10 @@ export interface ContentModelFormatMap {
      * Format type for code
      */
     code: FontFamilyFormat;
+    /**
+     * Format type for data, used by HTML <data> element
+     */
+    data: ContentModelDataFormat;
     /**
      * Format type for dataset
      */
@@ -284,6 +293,10 @@ export interface FormatHandlerTypeMap {
      * Format for DatasetFormat
      */
     dataset: DatasetFormat;
+    /**
+     * Format for DataValueFormat, used by HTML <data> element
+     */
+    dataValue: DataValueFormat;
     /**
      * Format for DirectionFormat
      */
@@ -505,6 +518,16 @@ export type LetterSpacingFormat = {
     letterSpacing?: string;
 };
 
+/**
+ * Format of the value of a HTML "data" element
+ */
+export type DataValueFormat = {
+    /**
+     * The machine-readable value, represented by the "value" attribute of a HTML "data" element
+     */
+    dataValue?: string;
+};
+
 /**
  * Format of line height
  */
@@ -2170,6 +2193,10 @@ export interface ContentModelSegmentBase<T extends ContentModelSegmentType, TFor
      * Code info
      */
     code?: ContentModelCode;
+    /**
+     * Data info, used by HTML &lt;data&gt; element
+     */
+    data?: ContentModelData;
 }
 
 /**
@@ -2194,6 +2221,10 @@ export interface ReadonlyContentModelSegmentBase<T extends ContentModelSegmentTy
      * Code info
      */
     readonly code?: ReadonlyContentModelCode;
+    /**
+     * Data info, used by HTML &lt;data&gt; element
+     */
+    readonly data?: ReadonlyContentModelData;
 }
 
 /**
@@ -2208,6 +2239,10 @@ export interface ShallowMutableContentModelSegmentBase<T extends ContentModelSeg
      * Code info
      */
     code?: ContentModelCode;
+    /**
+     * Data info, used by HTML &lt;data&gt; element
+     */
+    data?: ContentModelData;
 }
 
 /**
@@ -2241,6 +2276,22 @@ export interface ContentModelCode extends MutableMark, ContentModelWithFormat<Co
 export 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
+ */
+export 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
+ */
+export interface ReadonlyContentModelData extends ReadonlyMark, ReadonlyContentModelWithFormat<ContentModelDataFormat> {
+}
+
 /**
  * Represent link info of Content Model.
  * ContentModelLink is not a standalone model type, instead it need to be put inside a ContentModelSegment
@@ -2286,12 +2337,12 @@ export interface ReadonlyContentModelParagraphDecorator extends ReadonlyMark, Re
 /**
  * Union type for segment decorators
  */
-export type ContentModelDecorator = ContentModelLink | ContentModelCode | ContentModelListLevel;
+export type ContentModelDecorator = ContentModelLink | ContentModelCode | ContentModelData | ContentModelListLevel;
 
 /**
  * Union type for segment decorators (Readonly)
  */
-export type ReadonlyContentModelDecorator = ReadonlyContentModelLink | ReadonlyContentModelCode | ReadonlyContentModelListLevel;
+export type ReadonlyContentModelDecorator = ReadonlyContentModelLink | ReadonlyContentModelCode | ReadonlyContentModelData | ReadonlyContentModelListLevel;
 
 /**
  * Content Model of List Level
@@ -3047,6 +3098,10 @@ export 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
      */
@@ -3835,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[];
 }
 
 /**
@@ -3865,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)
@@ -5046,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;
 }
 
 /**
@@ -5204,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 | 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 PasteTypeOrGetter = PasteType | ((document: Document | null, clipboardData: ClipboardData) => PasteType);
+export type PasteTypeGetter = (document: Document | null, clipboardData: ClipboardData, environment: EditorEnvironment, htmlAttributes: Record<string, string>) => PasteType;
 
 /**
  * Image Format
@@ -7362,9 +7440,10 @@ export function createTableCell(spanLeftOrColSpan?: boolean | number, spanAboveO
  * @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
  */
-export function createText(text: string, format?: Readonly<ContentModelSegmentFormat>, link?: ReadonlyContentModelLink, code?: ReadonlyContentModelCode): ContentModelText;
+export function createText(text: string, format?: Readonly<ContentModelSegmentFormat>, link?: ReadonlyContentModelLink, code?: ReadonlyContentModelCode, data?: ReadonlyContentModelData): ContentModelText;
 
 /**
  * Create a ContentModelImage model
@@ -8330,6 +8409,10 @@ export const ChangeSource: {
      * Content changed by paste
      */
     Paste: string;
+    /**
+     * Content changed by auto markdown conversion
+     */
+    AutoMarkdownConversion: string;
     /**
      * Content changed by setContent API
      */
@@ -8806,6 +8889,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
@@ -10877,7 +10965,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