roosterjs 8.41.0 → 8.43.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.41.0)
+// Type definitions for roosterjs (Version 8.43.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -188,6 +188,19 @@ class PositionContentSearcher implements IPositionContentSearcher  {
     private traverse;
 }
 
+    /**
+ * Adds delimiters to the element provided.
+ * @param element element to be between delimiters
+ */
+function addDelimiters(element: HTMLElement): void;
+
+    /**
+ * 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;
+
     /**
  * Get the inline element at a node
  * @param rootNode The root node of current scope
@@ -753,6 +766,12 @@ function getIntersectedRect(elements: HTMLElement[], additionalRects?: Rect[]):
  */
 function isNodeAfter(node1: Node, node2: Node): boolean;
 
+    /**
+ * Parse color string to r/g/b value.
+ * If the given color is not in a recognized format, return null
+ */
+function parseColor(color: string): [number, number, number] | null;
+
     /**
  * A virtual table class, represent an HTML table, by expand all merged cells to each separated cells
  */
@@ -2298,7 +2317,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;
 }
 
     /**
@@ -2384,19 +2403,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 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 imageFileOrSrc Either the image file blob or source string of the image.
  * @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
@@ -3487,6 +3497,20 @@ const enum DarkModeDatasetNames {
     OriginalAttributeBackgroundColor = "ogab"
 }
 
+    /**
+ * Class names for Delimiter
+ */
+const enum DelimiterClasses {
+    /**
+     * Class name to specify this delimiter is before an entity
+     */
+    DELIMITER_BEFORE = "entityDelimiterBefore",
+    /**
+     *  Class name to specify this delimiter is after an entity
+     */
+    DELIMITER_AFTER = "entityDelimiterAfter"
+}
+
     /**
  * enum for setting block direction, used by setDirection API
  */
@@ -3698,7 +3722,15 @@ const enum ExperimentalFeatures {
      * 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"
+    VariableBasedDarkColor = "VariableBasedDarkColor",
+    /**
+     * Delete table with Backspace key with the whole was selected with table selector
+     */
+    DeleteTableWithBackspace = "DeleteTableWithBackspace",
+    /**
+     * Add entities around a Read Only  Inline entity to prevent cursor to be hidden when cursor is next of it.
+     */
+    InlineEntityReadOnlyDelimiters = "InlineEntityReadOnlyDelimiters"
 }
 
     /**
@@ -5364,6 +5396,26 @@ interface StyleBasedFormatState {
      * Mode independent background color for dark mode
      */
     textColors?: ModeIndependentColor;
+    /**
+     * Line height
+     */
+    lineHeight?: string;
+    /**
+     * Margin Top
+     */
+    marginTop?: string;
+    /**
+     * Margin Bottom
+     */
+    marginBottom?: string;
+    /**
+     * Text Align
+     */
+    textAlign?: string;
+    /**
+     * Direction of the element ('ltr' or 'rtl')
+     */
+    direction?: string;
 }
 
     /**
@@ -5844,6 +5896,10 @@ interface Snapshot {
      * Metadata of the editor content state
      */
     metadata: ContentMetadata | null;
+    /**
+     * Known colors for dark mode
+     */
+    knownColors: Readonly<ModeIndependentColor>[];
 }
 
     /**
@@ -6634,6 +6690,15 @@ interface DarkColorHandler {
      * @param color The color string to parse
      */
     parseColorValue(color: string | null | undefined): ColorKeyAndValue;
+    /**
+     * Get a copy of known colors
+     */
+    getKnownColorsCopy(): Readonly<ModeIndependentColor>[];
+    /**
+     * Find related light mode color from dark mode color.
+     * @param darkColor The existing dark color
+     */
+    findLightColorFromDarkColor(darkColor: string): string | null;
 }
 
     /**
@@ -7531,6 +7596,11 @@ interface TableFeatureSettings {
      * IndentTableOnTab edit feature, provides the ability to indent the table if it is all cells are selected.
      */
     indentTableOnTab: boolean;
+    /**
+     * Requires @see ExperimentalFeatures.DeleteTableWithBackspace
+     * Delete a table selected with the table selector pressing  Backspace key
+     */
+    deleteTableWithBackspace: boolean;
 }
 
     /**
@@ -8216,7 +8286,15 @@ enum CompatibleExperimentalFeatures {
      * 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"
+    VariableBasedDarkColor = "VariableBasedDarkColor",
+    /**
+     * Delete table with Backspace key with the whole was selected with table selector
+     */
+    DeleteTableWithBackspace = "DeleteTableWithBackspace",
+    /**
+     * Add entities around a Read Only  Inline entity to prevent cursor to be hidden when cursor is next of it.
+     */
+    InlineEntityReadOnlyDelimiters = "InlineEntityReadOnlyDelimiters"
 }
 
     /**
@@ -8868,6 +8946,20 @@ enum CompatibleDarkModeDatasetNames {
     OriginalAttributeBackgroundColor = "ogab"
 }
 
+    /**
+ * Class names for Delimiter
+ */
+enum CompatibleDelimiterClasses {
+    /**
+     * Class name to specify this delimiter is before an entity
+     */
+    DELIMITER_BEFORE = "entityDelimiterBefore",
+    /**
+     *  Class name to specify this delimiter is after an entity
+     */
+    DELIMITER_AFTER = "entityDelimiterAfter"
+}
+
     /**
  * enum for setting block direction, used by setDirection API
  */
@@ -9811,7 +9903,7 @@ class HyperLink implements EditorPlugin  {
  */
 class ImageEdit implements EditorPlugin  {
     private onShowResizeHandle?;
-    protected editor: IEditor;
+    protected editor: IEditor | null;
     protected options: ImageEditOptions;
     private disposer;
     private allowedOperations;
@@ -9840,7 +9932,7 @@ class ImageEdit implements EditorPlugin  {
      * To customize the resize handle element, add this callback and change the attributes of elementData then it
      * will be picked up by ImageEdit code
      */
-    constructor(options?: ImageEditOptions, onShowResizeHandle?: OnShowResizeHandle);
+    constructor(options?: ImageEditOptions, onShowResizeHandle?: OnShowResizeHandle | undefined);
     /**
      * Get a friendly name of this plugin
      */