roosterjs 9.41.0 → 9.44.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.41.0)
+// Type definitions for roosterjs (Version 9.44.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -2872,6 +2872,10 @@ interface EditorContext {
      * When pass true, this cached element will be used to create DOM tree back when convert Content Model to DOM
      */
     allowCacheElement?: boolean;
+    /**
+     * Whether to allow caching list item elements separately.
+     */
+    allowCacheListItem?: boolean;
     /**
      * @optional Indexer for content model, to help build backward relationship from DOM node to Content Model
      */
@@ -2892,6 +2896,11 @@ interface EditorContext {
      * When set to true, size of table will be recalculated when converting from DOM to Content Model.
      */
     recalculateTableSize?: boolean | 'all' | 'selected' | 'none';
+    /**
+     * Width of the editor's editable area in pixels, excluding padding.
+     * This value is typically used for layout calculations such as constraining pasted image sizes.
+     */
+    editorViewWidth?: number;
 }
 
     /**
@@ -3017,6 +3026,10 @@ interface ModelToDomListStackItem extends Partial<ContentModelListLevel> {
      * DOM node of this list stack
      */
     node: Node;
+    /**
+     * Reference node to insert next list item under this list
+     */
+    refNode: Node | null;
 }
 
     /**
@@ -3676,27 +3689,12 @@ interface IEditor {
  * By default these features are not enabled. To enable them, pass the feature name into EditorOptions.experimentalFeatures
  * when create editor
  */
-type ExperimentalFeature = /**
- * @deprecated When this feature is enabled, we will persist a content model in memory as long as we can,
- * and use cached element when write back if it is not changed.
- */
-'PersistCache'
-/**
- * @deprecated
- * Workaround for the Legacy Image Edit
- */
- | 'LegacyImageSelection'
+type ExperimentalFeature = GraduatedExperimentalFeature
 /**
  * @deprecated Please use the shouldHandleEnterKey option of the EditPlugin Options
  * Use Content Model handle ENTER key
  */
  | 'HandleEnterKey'
-/**
- * @deprecated
- * Prevent default browser behavior for copy/cut event,
- * and set the clipboard data with custom implementation.
- */
- | 'CustomCopyCut'
 /**
  * For CJK keyboard input on mobile, if the user toggles bold/italic/underline on an empty div,
  * the pending format will be applied on the selection marker. When typing text, the selection moves to the text node and the
@@ -3712,7 +3710,31 @@ type ExperimentalFeature = /**
  * Get cloned root element from an independent HTML document instead of current document.
  * So any operation to the cloned root won't trigger network request for resources like images
  */
- | 'CloneIndependentRoot';
+ | 'CloneIndependentRoot'
+/**
+ * Allow caching list item elements.
+ */
+ | 'CacheList';
+
+    /**
+ * Predefined experiment features (Graduated, only keep them for backward compatibility)
+ */
+type GraduatedExperimentalFeature = /**
+ * @deprecated When this feature is enabled, we will persist a content model in memory as long as we can,
+ * and use cached element when write back if it is not changed.
+ */
+'PersistCache'
+/**
+ * @deprecated
+ * Workaround for the Legacy Image Edit
+ */
+ | 'LegacyImageSelection'
+/**
+ * @deprecated
+ * Prevent default browser behavior for copy/cut event,
+ * and set the clipboard data with custom implementation.
+ */
+ | 'CustomCopyCut';
 
     /**
  * Options for editor
@@ -6027,6 +6049,20 @@ interface TextAndHtmlContentForCopy {
     textContent: string;
 }
 
+    /**
+ * The link label and  href for promoted link
+ */
+interface PromotedLink {
+    /**
+     * The label for the promoted link
+     */
+    label: string;
+    /**
+     * The href for the promoted link
+     */
+    href: string;
+}
+
     /**
  * Editor plugin event interface
  */
@@ -7549,6 +7585,13 @@ function parseTableCells(table: HTMLTableElement): ParsedTable;
  */
 function readFile(file: File, callback: (dataUrl: string | null) => void): void;
 
+    /**
+ * Retrieves metadata from the given document, including HTML attributes and meta tags.
+ * @param doc The document from which to retrieve metadata.
+ * @returns A record containing metadata key-value pairs.
+ */
+function retrieveDocumentMetadata(doc: Document): Record<string, string>;
+
     /**
  * Edit and transform color of elements between light mode and dark mode
  * @param rootNode The root DOM node to transform
@@ -8576,10 +8619,10 @@ function getContentForCopy(editor: IEditor, isCut: boolean, event: ClipboardEven
  * @param columns Number of columns in table, it also controls the default table cell width:
  * if columns &lt;= 4, width = 120px; if columns &lt;= 6, width = 100px; else width = 70px
  * @param rows Number of rows in table
- * @param format (Optional) The table format. If not passed, the default format will be applied:
- * background color: #FFF; border color: #ABABAB
+ * @param tableMetadataFormat (Optional) The table format that are stored as metadata. If not passed, the default format will be applied: background color: #FFF; border color: #ABABAB
+ * @param format (Optional) The table format used for style attributes
  */
-function insertTable(editor: IEditor, columns: number, rows: number, format?: Partial<TableMetadataFormat>): void;
+function insertTable(editor: IEditor, columns: number, rows: number, tableMetadataFormat?: Partial<TableMetadataFormat>, format?: ContentModelTableFormat): void;
 
     /**
  * Format current focused table with the given format
@@ -9066,6 +9109,14 @@ function matchLink(url: string): LinkData | null;
  */
 function promoteLink(segment: ContentModelText, paragraph: ShallowMutableContentModelParagraph, autoLinkOptions: AutoLinkOptions): ContentModelText | null;
 
+    /**
+ * Verify if the link can be promoted
+ * @param segment The text segment to search link text from
+ * @param options Options of auto link
+ * @returns if a link can be promoted
+ */
+function getPromoteLink(segment: ContentModelText, autoLinkOptions: AutoLinkOptions): PromotedLink | undefined;
+
     /**
  * Get announce data for list item
  * @param path Content model path that include the list item
@@ -9227,15 +9278,15 @@ const DefaultSanitizers: Record<string, ValueSanitizer>;
  * 3. Tab Key
  */
 class EditPlugin implements EditorPlugin  {
-    private options;
     private editor;
     private disposer;
     private shouldHandleNextInputEvent;
     private selectionAfterDelete;
     private handleNormalEnter;
+    private options;
     /**
      * @param options An optional parameter that takes in an object of type EditOptions, which includes the following properties:
-     * handleTabKey: A boolean that enables or disables Tab key handling. Defaults to true.
+     * handleTabKey: A boolean or HandleTabOptions object that controls Tab key handling. When a boolean, true enables all features and false disables all. When an object, individual features can be controlled. Defaults to all enabled.
      */
     constructor(options?: EditOptions);
     private createNormalEnterChecker;
@@ -9283,9 +9334,12 @@ class EditPlugin implements EditorPlugin  {
  */
 type EditOptions = {
     /**
-     * Whether to handle Tab key in keyboard. @default true
+     * Whether to handle Tab key in keyboard, or an object to control specific Tab key behaviors.
+     * When true, all Tab features are enabled. When false, all are disabled.
+     * When an object, individual features can be controlled via HandleTabOptions.
+     * @default true
      */
-    handleTabKey?: boolean;
+    handleTabKey?: HandleTabOptions | boolean;
     /**
      * Whether expanded selection within a text node should be handled by CM when pressing Backspace/Delete key.
      * @default true
@@ -9323,6 +9377,37 @@ type EditOptions = {
     formatsToPreserveOnMerge?: string[];
 };
 
+    /**
+ * Options for handling Tab key in Edit plugin
+ */
+interface HandleTabOptions {
+    /**
+     * Whether to indent/outdent multiple selected blocks when Tab/Shift+Tab is pressed and multiple blocks are selected.
+     * @default true
+     */
+    indentMultipleBlocks?: boolean;
+    /**
+     * Whether to indent/outdent table cells when Tab key is pressed and a table is selected
+     * @default true
+     */
+    indentTable?: boolean;
+    /**
+     * Whether to append a new row when Tab key is pressed in the last cell of a table
+     * @default true
+     */
+    appendTableRow?: boolean;
+    /**
+     * Whether to indent/outdent list items when Tab key is pressed
+     * @default true
+     */
+    indentList?: boolean;
+    /**
+     * Whether to indent/outdent paragraph when Tab key is pressed
+     * @default true
+     */
+    indentParagraph?: boolean;
+}
+
     /**
  * Auto Format plugin handles auto formatting, such as transforming * characters into a bullet list.
  * It can be customized with options to enable or disable auto list features.