roosterjs 8.9.0 → 8.10.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.9.0)
+// Type definitions for roosterjs (Version 8.10.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -656,7 +656,17 @@ export const enum EntityOperation {
      * This event will provide a cloned DOM tree for each entity, do NOT compare the DOM nodes with cached nodes
      * because it will always return false.
      */
-    ReplaceTemporaryContent = 8
+    ReplaceTemporaryContent = 8,
+    /**
+     * Notify plugins that editor has attached shadow root for an entity.
+     * Plugins can handle this event to do extra operations to the shadow root
+     */
+    AddShadowRoot = 9,
+    /**
+     * Notify plugins that editor has removed the shadow root of an entity
+     * Plugins can handle this event to do any necessary clean up for shadow root
+     */
+    RemoveShadowRoot = 10
 }
 
 /**
@@ -1202,6 +1212,18 @@ export interface EntityOperationEvent extends BasePluginEvent<PluginEventType.En
      * Optional raw event. Need to do null check before use its value
      */
     rawEvent?: Event;
+    /**
+     * A document fragment for entity based on Shadow DOM. This property is only available for NewEntity operation.
+     * Putting DOM nodes under this fragment will cause a shadow root to be attached to the entity wrapper
+     * with these DOM nodes under it.
+     *
+     * If there is already cached DOM nodes, they will also be put under this fragment.
+     * Plugin need to decide:
+     * 1. Apply the cache: do nothing and the DOM nodes will be appended as shadow DOM entity content
+     * 2. Discard the cache and use new content instead: clear the fragment and append new DOM nodes, then new DOM nodes will be used
+     * 3. Dehydrate this entity: clear the fragment, and leave it empty
+     */
+    contentForShadowEntity?: DocumentFragment;
 }
 
 /**
@@ -2750,8 +2772,9 @@ export interface IEditor {
     /**
      * Run a callback function asynchronously
      * @param callback The callback function to run
+     * @returns a function to cancel this async run
      */
-    runAsync(callback: (editor: IEditor) => void): void;
+    runAsync(callback: (editor: IEditor) => void): () => void;
     /**
      * Set DOM attribute of editor content DIV
      * @param name Name of the attribute
@@ -3887,9 +3910,10 @@ export interface EditPluginState {
  */
 export interface EntityPluginState {
     /**
+     * @deprecated
      * Last clicking point when mouse down event happens
      */
-    clickingPoint: {
+    clickingPoint?: {
         pageX: number;
         pageY: number;
     };
@@ -3897,6 +3921,12 @@ export interface EntityPluginState {
      * All known entity elements
      */
     knownEntityElements: HTMLElement[];
+    /**
+     * Cache for the hydrated content of shadow DOM entity.
+     * When set content to replace the whole editor, we will cache the hydrated content
+     * before it is gone, then after that we can use the cached content to rehydrate entity
+     */
+    shadowEntityCache: Record<string, HTMLElement>;
 }
 
 /**
@@ -4825,6 +4855,14 @@ export const KnownCreateElementData: Record<KnownCreateElementDataIndex, CreateE
  */
 export function moveChildNodes(target: Node, source?: Node, keepExistingChildren?: boolean): void;
 
+/**
+ * Set the Style of a List Item provided, with the styles that the inline child elements have
+ * If the child inline elements have different styles, it will not modify the styles of the list item
+ * @param element the LI Element to set the styles
+ * @param styles The styles that should be applied to the element.
+ */
+export function setListItemStyle(element: HTMLLIElement, styles: string[]): void;
+
 /**
  * A virtual table class, represent an HTML table, by expand all merged cells to each separated cells
  */
@@ -5856,8 +5894,9 @@ export class Editor implements IEditor  {
     /**
      * Run a callback function asynchronously
      * @param callback The callback function to run
+     * @returns a function to cancel this async run
      */
-    runAsync(callback: (editor: IEditor) => void): void;
+    runAsync(callback: (editor: IEditor) => void): () => void;
     /**
      * Set DOM attribute of editor content DIV
      * @param name Name of the attribute
@@ -6586,6 +6625,10 @@ export class ImageEdit implements EditorPlugin  {
     private editInfo;
     private lastSrc;
     private dndHelpers;
+    /**
+     * Identify if the image was resized by the user.
+     */
+    private wasResized;
     /**
      * Create a new instance of ImageEdit
      * @param options Image editing options