roosterjs 8.43.0 → 8.44.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.43.0)
+// Type definitions for roosterjs (Version 8.44.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -189,17 +189,29 @@ class PositionContentSearcher implements IPositionContentSearcher  {
 }
 
     /**
- * Adds delimiters to the element provided.
- * @param element element to be between delimiters
+ * Adds delimiters to the element provided. If the delimiters already exists, will not be added
+ * @param node the node to add the delimiters
  */
-function addDelimiters(element: HTMLElement): void;
+function addDelimiters(node: Element): Element[];
+
+    /**
+ * Adds delimiter after the element provided.
+ * @param element element to use
+ */
+function addDelimiterAfter(element: Element): Element;
+
+    /**
+ * Adds delimiter before the element provided.
+ * @param element element to use
+ */
+function addDelimiterBefore(element: Element): Element;
 
     /**
  * Retrieves Delimiter information from a provided element.
  * @param element element to try to retrieve a delimiter
  * @returns delimiter info if it is a Delimiter, else null
  */
-function getDelimiterFromElement(element: HTMLElement | Element | null | undefined): Element | null;
+function getDelimiterFromElement(element: Node | null | undefined): Element | null;
 
     /**
  * Get the inline element at a node
@@ -3665,23 +3677,11 @@ const enum ExperimentalFeatures {
      * Align table elements to left, center and right using setAlignment API
      */
     TableAlignment = "TableAlignment",
-    /**
-     * Provide additional Tab Key Features. Requires Text Features Content Editable Features
-     */
-    TabKeyTextFeatures = "TabKeyTextFeatures",
     /**
      * @deprecated this feature is always enabled
      * Provide a circular resize handles that adaptive the number od handles to the size of the image
      */
     AdaptiveHandlesResizer = "AdaptiveHandlesResizer",
-    /**
-     * Align list elements elements to left, center and right using setAlignment API
-     */
-    ListItemAlignment = "ListItemAlignment",
-    /**
-     * Trigger formatting by a especial characters. Ex: (A), 1. i).
-     */
-    AutoFormatList = "AutoFormatList",
     /**
      * @deprecated this feature is always disabled
      * Automatically transform -- into hyphen, if typed between two words.
@@ -3705,6 +3705,18 @@ const enum ExperimentalFeatures {
      * When a html image is selected, the selected image data will be stored by editor core.
      */
     ImageSelection = "ImageSelection",
+    /**
+     * Provide additional Tab Key Features. Requires Text Features Content Editable Features
+     */
+    TabKeyTextFeatures = "TabKeyTextFeatures",
+    /**
+     * Align list elements elements to left, center and right using setAlignment API
+     */
+    ListItemAlignment = "ListItemAlignment",
+    /**
+     * Trigger formatting by a especial characters. Ex: (A), 1. i).
+     */
+    AutoFormatList = "AutoFormatList",
     /**
      * With this feature enabled, when writing back a list item we will re-use all
      * ancestor list elements, even if they don't match the types currently in the
@@ -3723,6 +3735,10 @@ const enum ExperimentalFeatures {
      * if you need them work for dark mode
      */
     VariableBasedDarkColor = "VariableBasedDarkColor",
+    /**
+     * Reuse existing DOM structure if possible when convert Content Model back to DOM tree
+     */
+    ReusableContentModel = "ReusableContentModel",
     /**
      * Delete table with Backspace key with the whole was selected with table selector
      */
@@ -5330,6 +5346,10 @@ interface ElementBasedFormatState {
      * Whether the text is in block quote
      */
     isBlockQuote?: boolean;
+    /**
+     * Whether the text is in Code element
+     */
+    isCodeInline?: boolean;
     /**
      * Whether the text is in Code block
      */
@@ -6688,8 +6708,10 @@ interface DarkColorHandler {
      * 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
+     * @param isInDarkMode Whether current content is in dark mode. When set to true, if the color value is not in dark var format,
+     * we will treat is as a dark mode color and try to find a matched dark mode color.
      */
-    parseColorValue(color: string | null | undefined): ColorKeyAndValue;
+    parseColorValue(color: string | null | undefined, isInDarkMode?: boolean): ColorKeyAndValue;
     /**
      * Get a copy of known colors
      */
@@ -7097,6 +7119,7 @@ interface CoreApiMap {
      * @param direction To specify the transform direction, light to dark, or dark to light
      * @param forceTransform By default this function will only work when editor core is in dark mode.
      * Pass true to this value to force do color transformation even editor core is in light mode
+     * @param fromDarkModel Whether the given content is already in dark mode
      */
     transformColor: TransformColor;
     /**
@@ -7247,8 +7270,9 @@ type SwitchShadowEdit = (core: EditorCore, isOn: boolean) => void;
  * @param direction To specify the transform direction, light to dark, or dark to light
  * @param forceTransform By default this function will only work when editor core is in dark mode.
  * Pass true to this value to force do color transformation even editor core is in light mode
+ * @param fromDarkModel Whether the given content is already in dark mode
  */
-type TransformColor = (core: EditorCore, rootNode: Node | null, includeSelf: boolean, callback: (() => void) | null, direction: ColorTransformDirection | CompatibleColorTransformDirection, forceTransform?: boolean) => void;
+type TransformColor = (core: EditorCore, rootNode: Node | null, includeSelf: boolean, callback: (() => void) | null, direction: ColorTransformDirection | CompatibleColorTransformDirection, forceTransform?: boolean, fromDarkMode?: boolean) => void;
 
     /**
  * Trigger a plugin event
@@ -7452,6 +7476,14 @@ interface EntityFeatureSettings {
      * press DELETE right after an entity
      */
     deleteBeforeEntity: boolean;
+    /**
+     * Content edit feature to move the cursor from Delimiters around Entities when using Right or Left Arrow Keys
+     */
+    moveBetweenDelimitersFeature: boolean;
+    /**
+     * Content edit Feature to trigger a Delete Entity Operation when one of the Delimiter is about to be removed with DELETE or Backspace
+     */
+    removeEntityBetweenDelimiters: boolean;
 }
 
     /**
@@ -8229,23 +8261,11 @@ enum CompatibleExperimentalFeatures {
      * Align table elements to left, center and right using setAlignment API
      */
     TableAlignment = "TableAlignment",
-    /**
-     * Provide additional Tab Key Features. Requires Text Features Content Editable Features
-     */
-    TabKeyTextFeatures = "TabKeyTextFeatures",
     /**
      * @deprecated this feature is always enabled
      * Provide a circular resize handles that adaptive the number od handles to the size of the image
      */
     AdaptiveHandlesResizer = "AdaptiveHandlesResizer",
-    /**
-     * Align list elements elements to left, center and right using setAlignment API
-     */
-    ListItemAlignment = "ListItemAlignment",
-    /**
-     * Trigger formatting by a especial characters. Ex: (A), 1. i).
-     */
-    AutoFormatList = "AutoFormatList",
     /**
      * @deprecated this feature is always disabled
      * Automatically transform -- into hyphen, if typed between two words.
@@ -8269,6 +8289,18 @@ enum CompatibleExperimentalFeatures {
      * When a html image is selected, the selected image data will be stored by editor core.
      */
     ImageSelection = "ImageSelection",
+    /**
+     * Provide additional Tab Key Features. Requires Text Features Content Editable Features
+     */
+    TabKeyTextFeatures = "TabKeyTextFeatures",
+    /**
+     * Align list elements elements to left, center and right using setAlignment API
+     */
+    ListItemAlignment = "ListItemAlignment",
+    /**
+     * Trigger formatting by a especial characters. Ex: (A), 1. i).
+     */
+    AutoFormatList = "AutoFormatList",
     /**
      * With this feature enabled, when writing back a list item we will re-use all
      * ancestor list elements, even if they don't match the types currently in the
@@ -8287,6 +8319,10 @@ enum CompatibleExperimentalFeatures {
      * if you need them work for dark mode
      */
     VariableBasedDarkColor = "VariableBasedDarkColor",
+    /**
+     * Reuse existing DOM structure if possible when convert Content Model back to DOM tree
+     */
+    ReusableContentModel = "ReusableContentModel",
     /**
      * Delete table with Backspace key with the whole was selected with table selector
      */