roosterjs 9.54.0 → 9.56.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.54.0)
+// Type definitions for roosterjs (Version 9.56.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
      */
@@ -7363,9 +7418,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
@@ -7872,7 +7928,7 @@ function normalizeFontFamily(fontFamily: string): string;
  * @param allowedCustomPasteType Allowed custom content type when paste besides text/plain, text/html and images
     Only text types are supported, and do not add "text/" prefix to the type values
  */
-function extractClipboardItems(items: DataTransferItem[], allowedCustomPasteType?: string[]): Promise<ClipboardData>;
+function extractClipboardItems(items: DataTransferItem[], allowedCustomPasteType?: string[], isPasteNative?: boolean): Promise<ClipboardData>;
 
     /**
  * Gets the cached event data by cache key from event object if there is already one.
@@ -8109,6 +8165,13 @@ function setSelection(group: ReadonlyContentModelBlockGroup, start?: ReadonlySel
  */
 function cloneModel(model: ReadonlyContentModelDocument, options?: CloneModelOptions): ContentModelDocument;
 
+    /**
+ * Clone a content model for paste operations, ensuring that cached elements are handled appropriately.
+ * @param model The content model to clone
+ * @returns A cloned content model suitable for paste operations
+ */
+function cloneModelForPaste(model: ReadonlyContentModelDocument): ContentModelDocument;
+
     /**
  * Merge source model into target mode
  * @param target Target Content Model that will merge content into
@@ -11043,6 +11106,11 @@ interface MarkdownPasteOptions {
      * @default false
      */
     autoConversion: boolean;
+    /**
+     * When true, the plugin will undo the markdown conversion when the user undoes the action.
+     * @default false
+     */
+    undoConversion: boolean;
 }
 
 }