roosterjs 9.32.0 → 9.34.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.32.0)
+// Type definitions for roosterjs (Version 9.34.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -41,7 +41,7 @@ interface ReadonlyContentModelWithFormat<T extends ContentModelFormatBase> {
     /**
  * Format of Table
  */
-type ContentModelTableFormat = ContentModelBlockFormat & IdFormat & AriaFormat & BorderFormat & BorderBoxFormat & SpacingFormat & MarginFormat & DisplayFormat & TableLayoutFormat & SizeFormat;
+type ContentModelTableFormat = ContentModelBlockFormat & IdFormat & AriaFormat & BorderFormat & BorderBoxFormat & DirectionFormat & SpacingFormat & MarginFormat & DisplayFormat & TableLayoutFormat & SizeFormat;
 
     /**
  * Represents base format of an element that supports dataset and/or metadata
@@ -2560,6 +2560,33 @@ interface ModelToDomSettings {
      * Map of metadata appliers
      */
     metadataAppliers: MetadataAppliers;
+    /**
+     * Default format for each tag name used for generating DOM tree from content model.
+     *
+     * This map defines the default implicit formats for specific HTML tag names. It is used during
+     * the conversion of a content model to a DOM tree to ensure that elements are styled correctly
+     * based on their tag name. Each entry in the map associates a tag name (in lowercase) with a
+     * combination of segment and block formats.
+     *
+     * Example:
+     * {
+     *     "p": {
+     *         fontSize: "12px",
+     *         lineHeight: "1.5",
+     *         marginTop: "10px",
+     *         marginBottom: "10px"
+     *     },
+     *     "h1": {
+     *         fontSize: "24px",
+     *         fontWeight: "bold",
+     *         marginTop: "20px",
+     *         marginBottom: "20px"
+     *     }
+     * }
+     */
+    defaultContentModelFormatMap: {
+        [tagName: string]: ContentModelSegmentFormat & ContentModelBlockFormat;
+    };
     /**
      * Default Content Model to DOM handlers before overriding.
      * This provides a way to call original handler from an overridden handler function
@@ -2732,6 +2759,10 @@ interface DomToModelSettings {
      * This provides a way to call original format parser from an overridden parser function
      */
     defaultFormatParsers: Readonly<FormatParsers>;
+    /**
+     * If true elements that has display:none style will be processed
+     */
+    processNonVisibleElements?: boolean;
 }
 
     /**
@@ -3070,6 +3101,10 @@ interface DomToModelOption {
      * Provide additional format parsers for each format type
      */
     additionalFormatParsers?: Partial<FormatParsersPerCategory>;
+    /**
+     * If true elements that has display:none style will be processed
+     */
+    processNonVisibleElements?: boolean;
 }
 
     /**
@@ -3137,6 +3172,31 @@ interface ModelToDomOption {
      * When set to true, selection from content model will not be applied
      */
     ignoreSelection?: boolean;
+    /**
+     * Overrides the default content model formats for specific HTML tags.
+     *
+     * This property allows you to specify custom formats for both segment and block-level
+     * content models for specific tags. The key is the tag name (e.g., 'div', 'span'),
+     * and the value is an object containing both segment and block format overrides.
+     *
+     * Example:
+     * ```
+     * defaultContentModelFormatOverride: {
+     *     div: {
+     *         fontSize: '16px',
+     *         textAlign: 'center',
+     *         backgroundColor: 'lightblue',
+     *     },
+     *     span: {
+     *         fontWeight: 'bold',
+     *         color: 'red',
+     *     },
+     * }
+     * ```
+     */
+    defaultContentModelFormatOverride?: {
+        [tagName: string]: ContentModelSegmentFormat & ContentModelBlockFormat;
+    };
 }
 
     /**
@@ -3624,7 +3684,11 @@ type ExperimentalFeature = /**
  * selection marker may be recreated during reconciliation, potentially losing its original formatting. This feature ensures
  * the original formatting of the selection marker is kept to match the pending format.
  */
- | 'KeepSelectionMarkerWhenEnteringTextNode';
+ | 'KeepSelectionMarkerWhenEnteringTextNode'
+/**
+ * Export editor content as HTML using HTMLFast option
+ */
+ | 'ExportHTMLFast';
 
     /**
  * Options for editor
@@ -5210,6 +5274,10 @@ interface DOMEventRecord<E = Event> {
      * when correlated DOM event is fired
      */
     beforeDispatch?: DOMEventHandlerFunction<E> | null;
+    /**
+     * Whether the event should be captured in the capturing phase.
+     */
+    capture?: boolean;
 }
 
     /**
@@ -5482,8 +5550,10 @@ interface DOMHelper {
     getClonedRoot(): HTMLElement;
     /**
      * Get format of the container element
+     * @param isInDarkMode Optional flag to indicate if the environment is in dark mode
+     * @param darkColorHandler Optional DarkColorHandler to retrieve dark mode colors
      */
-    getContainerFormat(): ContentModelSegmentFormat;
+    getContainerFormat(isInDarkMode?: boolean, darkColorHandler?: DarkColorHandler): ContentModelSegmentFormat;
 }
 
     /**
@@ -6504,7 +6574,6 @@ function handleRegularSelection(index: number, context: DomToModelContext, group
  * @param group The parent block group
  * @param parent Parent DOM node to process
  * @param context DOM to Content Model context
- *
  */
 function processChildNode(group: ContentModelBlockGroup, child: Node, context: DomToModelContext): void;
 
@@ -7144,8 +7213,9 @@ const DeprecatedColors: string[];
  * @param isBackground True to get background color, false to get text color
  * @param isDarkMode Whether element is in dark mode now
  * @param darkColorHandler @optional The dark color handler object to help manager dark mode color
+ * @param fallback @optional Fallback color to use if no color is found from the element
  */
-function getColor(element: HTMLElement, isBackground: boolean, isDarkMode: boolean, darkColorHandler?: DarkColorHandler): string | undefined;
+function getColor(element: HTMLElement, isBackground: boolean, isDarkMode: boolean, darkColorHandler?: DarkColorHandler, fallback?: string): string | undefined;
 
     /**
  * Set color to given HTML element
@@ -7639,8 +7709,12 @@ function setTableCellBackgroundColor(cell: ShallowMutableContentModelTableCell,
  * @param pendingFormat Existing pending format, if any
  * @param formatState Existing format state object, used for receiving the result
  * @param conflictSolution The strategy for handling format conflicts
+ * @param domHelper Optional DOMHelper to retrieve container format
+ * @param isInDarkMode Optional flag to indicate if the environment is in dark mode
+ * @param colorHandler Optional DarkColorHandler to handle dark mode colors
+ *
  */
-function retrieveModelFormatState(model: ReadonlyContentModelDocument, pendingFormat: ContentModelSegmentFormat | null, formatState: ContentModelFormatState, conflictSolution?: ConflictFormatSolution, domHelper?: DOMHelper): void;
+function retrieveModelFormatState(model: ReadonlyContentModelDocument, pendingFormat: ContentModelSegmentFormat | null, formatState: ContentModelFormatState, conflictSolution?: ConflictFormatSolution, domHelper?: DOMHelper, isInDarkMode?: boolean, colorHandler?: DarkColorHandler): void;
 
     /**
  * Gets the list style type that the bullet is part of, using the Constant record
@@ -8247,11 +8321,19 @@ function createModelFromHtml(html: string, options?: Partial<DomToModelOptionFor
     /**
  * Export HTML content. If there are entities, this will cause EntityOperation event with option = 'replaceTemporaryContent' to get a dehydrated entity
  * @param editor The editor to get content from
- * @param mode Specify HTML to get plain text result. This is the default option
+ * @param mode Specify HTML to get HTML. This is the default option
  * @param options @optional Options for Model to DOM conversion
  */
 function exportContent(editor: IEditor, mode?: 'HTML', options?: ModelToDomOption): string;
 
+    /**
+ * Export HTML content. If there are entities, this will cause EntityOperation event with option = 'replaceTemporaryContent' to get a dehydrated entity.
+ * This is a fast version, it retrieve HTML content directly from editor without going through content model conversion.
+ * @param editor The editor to get content from
+ * @param mode Specify HTMLFast to get HTML result.
+ */
+function exportContent(editor: IEditor, mode: 'HTMLFast'): string;
+
     /**
  * Export plain text content
  * @param editor The editor to get content from
@@ -9786,7 +9868,6 @@ interface CustomReplace {
  * - Flip image
  */
 class ImageEditPlugin implements ImageEditor, EditorPlugin  {
-    protected options: ImageEditOptions;
     protected editor: IEditor | null;
     private shadowSpan;
     private selectedImage;
@@ -9804,6 +9885,7 @@ class ImageEditPlugin implements ImageEditor, EditorPlugin  {
     private zoomScale;
     private disposer;
     protected isEditing: boolean;
+    protected options: ImageEditOptions;
     constructor(options?: ImageEditOptions);
     /**
      * Get name of this plugin
@@ -9844,7 +9926,10 @@ class ImageEditPlugin implements ImageEditor, EditorPlugin  {
      */
     protected applyFormatWithContentModel(editor: IEditor, isCropMode: boolean, shouldSelectImage: boolean, isApiOperation?: boolean): void;
     private startEditing;
+    private updateImageDimensionsIfZero;
+    private startEditingInternal;
     startRotateAndResize(editor: IEditor, image: HTMLImageElement): void;
+    private updateResizeHandleDirection;
     private updateRotateHandleState;
     isOperationAllowed(operation: ImageEditOperation): boolean;
     canRegenerateImage(image: HTMLImageElement): boolean;