roosterjs 8.40.2 → 8.42.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.40.2)
+// Type definitions for roosterjs (Version 8.42.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -395,8 +395,10 @@ function getBrowserInfo(userAgent: string, appVersion: string, vendor?: string):
  * Apply format to an HTML element
  * @param element The HTML element to apply format to
  * @param format The format to apply
+ * @param isDarkMode Whether the content should be formatted in dark mode
+ * @param darkColorHandler An optional dark color handler object. When it is passed, we will use this handler to do variable-based dark color instead of original dataset base dark color
  */
-function applyFormat(element: HTMLElement, format: DefaultFormat, isDarkMode?: boolean): void;
+function applyFormat(element: HTMLElement, format: DefaultFormat, isDarkMode?: boolean, darkColorHandler?: DarkColorHandler | null): void;
 
     /**
  * Change tag of an HTML Element to a new one, and replace it from DOM tree
@@ -684,9 +686,9 @@ function getInnerHTML(node: HTMLElement | DocumentFragment): string;
  * @param isBackgroundColor Whether set background color or text color
  * @param isDarkMode Whether current mode is dark mode. @default false
  * @param shouldAdaptTheFontColor Whether the font color needs to be adapted to be visible in a dark or bright background color. @default false
- * @param defaultFontColor Set the default colors that needs to be set to the to be visible.
+ * @param darkColorHandler An optional dark color handler object. When it is passed, we will use this handler to do variable-based dark color instead of original dataset base dark color
  */
-function setColor(element: HTMLElement, color: string | ModeIndependentColor, isBackgroundColor: boolean, isDarkMode?: boolean, shouldAdaptTheFontColor?: boolean): void;
+function setColor(element: HTMLElement, color: string | ModeIndependentColor, isBackgroundColor: boolean, isDarkMode?: boolean, shouldAdaptTheFontColor?: boolean, darkColorHandler?: DarkColorHandler | null): void;
 
     /**
  * A wrapper function of Element.matches
@@ -2237,6 +2239,10 @@ class Editor implements IEditor  {
      * @param node The node to transform
      */
     transformToDarkColor(node: Node): void;
+    /**
+     * Get a darkColorHandler object for this editor. It will return null if experimental feature "VariableBasedDarkColor" is not enabled
+     */
+    getDarkColorHandler(): DarkColorHandler | null;
     /**
      * Make the editor in "Shadow Edit" mode.
      * In Shadow Edit mode, all format change will finally be ignored.
@@ -2292,7 +2298,7 @@ class Editor implements IEditor  {
      * @returns the current EditorCore object
      * @throws a standard Error if there's no core object
      */
-    private getCore;
+    protected getCore(): EditorCore;
 }
 
     /**
@@ -2378,19 +2384,10 @@ function insertEntity(editor: IEditor, type: string, contentNode: Node, isBlock:
     /**
  * Insert an image to editor at current selection
  * @param editor The editor instance
- * @param imageFile The image file. There are at least 3 ways to obtain the file object:
- * From local file, from clipboard data, from drag-and-drop
+ * @param imageFileOrSrc Either the image file blob or source string of the image.
  * @param attributes Optional image element attributes
  */
-function insertImage(editor: IEditor, imageFile: File, attributes?: Record<string, string>): void;
-
-    /**
- * Insert an image to editor at current selection
- * @param editor The editor instance
- * @param url The image link
- * @param attributes Optional image element attributes
- */
-function insertImage(editor: IEditor, url: string, attributes?: Record<string, string>): void;
+function insertImage(editor: IEditor, imageFileOrSrc: File | string, attributes?: Record<string, string>): void;
 
     /**
  * Insert table into editor at current selection
@@ -3686,7 +3683,13 @@ const enum ExperimentalFeatures {
      * When apply default format when initialize or user type, apply the format on a SPAN element rather than
      * the block element (In most case, the DIV element) so keep the block element clean.
      */
-    DefaultFormatInSpan = "DefaultFormatInSpan"
+    DefaultFormatInSpan = "DefaultFormatInSpan",
+    /**
+     * Use variable-based dark mode solution rather than dataset-based solution.
+     * When enable this feature, need to pass in a DarkModelHandler object to each call of setColor and applyFormat
+     * if you need them work for dark mode
+     */
+    VariableBasedDarkColor = "VariableBasedDarkColor"
 }
 
     /**
@@ -5286,6 +5289,10 @@ interface ElementBasedFormatState {
      * Whether the text is in block quote
      */
     isBlockQuote?: boolean;
+    /**
+     * Whether the text is in Code block
+     */
+    isCodeBlock?: boolean;
     /**
      * Whether unlink command can be called to the text
      */
@@ -5314,6 +5321,10 @@ interface ElementBasedFormatState {
      * If there is a table, whether the table has header row
      */
     tableHasHeader?: boolean;
+    /**
+     * Whether we can execute table cell merge operation
+     */
+    canMergeTableCell?: boolean;
 }
 
     /**
@@ -5344,6 +5355,18 @@ interface StyleBasedFormatState {
      * Mode independent background color for dark mode
      */
     textColors?: ModeIndependentColor;
+    /**
+     * Line height
+     */
+    lineHeight?: string;
+    /**
+     * Margin Top
+     */
+    marginTop?: string;
+    /**
+     * Margin Bottom
+     */
+    marginBottom?: string;
 }
 
     /**
@@ -6536,6 +6559,10 @@ interface IEditor {
      * @param node The node to transform
      */
     transformToDarkColor(node: Node): void;
+    /**
+     * Get a darkColorHandler object for this editor. It will return null if experimental feature "VariableBasedDarkColor" is not enabled
+     */
+    getDarkColorHandler(): DarkColorHandler | null;
     /**
      * Make the editor in "Shadow Edit" mode.
      * In Shadow Edit mode, all format change will finally be ignored.
@@ -6588,6 +6615,48 @@ interface IEditor {
     getVisibleViewport(): Rect | null;
 }
 
+    /**
+ * A handler object for dark color, used for variable-based dark color solution
+ */
+interface DarkColorHandler {
+    /**
+     * Given a light mode color value and an optional dark mode color value, register this color
+     * so that editor can handle it, then return the CSS color value for current color mode.
+     * @param lightModeColor Light mode color value
+     * @param isDarkMode Whether current color mode is dark mode
+     * @param darkModeColor Optional dark mode color value. If not passed, we will calculate one.
+     */
+    registerColor(lightModeColor: string, isDarkMode: boolean, darkModeColor?: string): string;
+    /**
+     * Reset known color record, clean up registered color variables.
+     */
+    reset(): void;
+    /**
+     * Parse an existing color value, if it is in variable-based color format, extract color key,
+     * light color and query related dark color if any
+     * @param color The color string to parse
+     */
+    parseColorValue(color: string | null | undefined): ColorKeyAndValue;
+}
+
+    /**
+ * Represents a combination of color key, light color and dark color, parsed from existing color value
+ */
+interface ColorKeyAndValue {
+    /**
+     * Key of color, if found, otherwise undefined
+     */
+    key?: string;
+    /**
+     * Light mode color value
+     */
+    lightModeColor: string;
+    /**
+     * Dark mode color value, if found, otherwise undefined
+     */
+    darkModeColor?: string;
+}
+
     /**
  * ContentEditFeature interface that handles keyboard event
  */
@@ -6811,6 +6880,11 @@ interface EditorCore extends PluginState  {
      * Color of the border of a selectedImage. Default color: '#DB626C'
      */
     imageSelectionBorderColor?: string;
+    /**
+     * Dark model handler for the editor, used for variable-based solution.
+     * If keep it null, editor will still use original dataset-based dark mode solution.
+     */
+    darkColorHandler?: DarkColorHandler;
 }
 
     /**
@@ -8139,7 +8213,13 @@ enum CompatibleExperimentalFeatures {
      * When apply default format when initialize or user type, apply the format on a SPAN element rather than
      * the block element (In most case, the DIV element) so keep the block element clean.
      */
-    DefaultFormatInSpan = "DefaultFormatInSpan"
+    DefaultFormatInSpan = "DefaultFormatInSpan",
+    /**
+     * Use variable-based dark mode solution rather than dataset-based solution.
+     * When enable this feature, need to pass in a DarkModelHandler object to each call of setColor and applyFormat
+     * if you need them work for dark mode
+     */
+    VariableBasedDarkColor = "VariableBasedDarkColor"
 }
 
     /**
@@ -9749,9 +9829,13 @@ class ImageEdit implements EditorPlugin  {
      */
     private wasResized;
     /**
-     * Editor zoom scale
+     * The span element that wraps the image and opens shadow dom
+     */
+    private shadowSpan;
+    /**
+     * The span element that wraps the image and opens shadow dom
      */
-    private zoomWrapper;
+    private isCropping;
     /**
      * Create a new instance of ImageEdit
      * @param options Image editing options
@@ -9806,7 +9890,6 @@ class ImageEdit implements EditorPlugin  {
      * Create editing wrapper for the image
      */
     private createWrapper;
-    private toggleImageVisibility;
     private insertImageWrapper;
     /**
      * Remove the temp wrapper of the image