roosterjs 9.26.0 → 9.27.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.26.0)
+// Type definitions for roosterjs (Version 9.27.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -76,7 +76,7 @@ type ShallowMutableContentModelWithDataset<T> = ShallowMutableMark & {
     /**
  * The format object for a paragraph in Content Model
  */
-type ContentModelBlockFormat = BackgroundColorFormat & DirectionFormat & TextAlignFormat & HtmlAlignFormat & MarginFormat & PaddingFormat & LineHeightFormat & WhiteSpaceFormat & BorderFormat & TextIndentFormat;
+type ContentModelBlockFormat = BackgroundColorFormat & DirectionFormat & TextAlignFormat & HtmlAlignFormat & MarginFormat & PaddingFormat & LineHeightFormat & WhiteSpaceFormat & BorderFormat & TextIndentFormat & IdFormat;
 
     /**
  * Format of table cell
@@ -236,7 +236,7 @@ interface ContentModelFormatMap {
     /**
  * The format object for an image in Content Model
  */
-type ContentModelImageFormat = ContentModelSegmentFormat & IdFormat & SizeFormat & MarginFormat & PaddingFormat & BorderFormat & BoxShadowFormat & DisplayFormat & FloatFormat & VerticalAlignFormat;
+type ContentModelImageFormat = ContentModelSegmentFormat & IdFormat & SizeFormat & MarginFormat & PaddingFormat & BorderFormat & BoxShadowFormat & DisplayFormat & FloatFormat & VerticalAlignFormat & ImageStateFormat;
 
     /**
  * The format object for an entity in Content Model
@@ -307,6 +307,10 @@ interface FormatHandlerTypeMap {
      * Format for IdFormat
      */
     id: IdFormat;
+    /**
+     * Format of ImageStateFormat
+     */
+    imageState: ImageStateFormat;
     /**
      * Format for ItalicFormat
      */
@@ -891,6 +895,16 @@ type UndeletableFormat = {
     undeletable?: boolean;
 };
 
+    /**
+ * The hidden property of an image
+ */
+type ImageStateFormat = {
+    /**
+     * A hidden marker for the image state
+     */
+    imageState?: string;
+};
+
     /**
  * Represents dataset format of Content Model
  */
@@ -3590,9 +3604,15 @@ type ExperimentalFeature = /**
  */
  | 'LegacyImageSelection'
 /**
+ * @deprecated Please use the shouldHandleEnterKey option of the EditPlugin Options
  * Use Content Model handle ENTER key
  */
- | 'HandleEnterKey';
+ | 'HandleEnterKey'
+/**
+ *  Prevent default browser behavior for copy/cut event,
+ *  and set the clipboard data with custom implementation.
+ */
+ | 'CustomCopyCut';
 
     /**
  * Options for editor
@@ -4855,9 +4875,13 @@ interface ContentModelFormatState {
      */
     fontWeight?: string;
     /**
-     * Format of image, if there is table at cursor position
+     * Format of image, if there is image at cursor position
      */
     imageFormat?: ImageFormatState;
+    /**
+     * Editing metadata of image, if there is image at cursor position
+     */
+    imageEditingMetadata?: ImageMetadataFormat | null;
     /**
      * Letter spacing
      */
@@ -5306,7 +5330,15 @@ type TrustedHTMLHandler = DOMCreator | LegacyTrustedHTMLHandler;
  * A handler type to convert HTML string to a DOM object
  */
 interface DOMCreator {
+    /**
+     * Callback to convert HTML string to a DOM object
+     */
     htmlToDOM: (html: string) => Document;
+    /**
+     * Flag to indicate if this handler is bypassed or not.
+     * If this is true, it means that when converting HTML string to DOM object, we don't need to do any conversion.
+     */
+    isBypassed?: boolean;
 }
 
     /**
@@ -6964,6 +6996,14 @@ function normalizeSingleSegment(paragraph: ReadonlyContentModelParagraph, segmen
  */
 function mergeTextSegments(block: ShallowMutableContentModelParagraph): void;
 
+    /**
+ * Some format values can be changed when apply to DOM, such as font family.
+ * This function will normalize the format and return the same string after DOM modification.
+ * @param format The format to be normalized
+ * @return Normalized format
+ */
+function normalizeSegmentFormat(format: ContentModelSegmentFormat, environment: EditorEnvironment): ContentModelSegmentFormat;
+
     /**
  * For a given block, if it is a paragraph, set it to be not-implicit
  * @param block The block to check
@@ -7215,6 +7255,16 @@ function setParagraphMarker(element: HTMLElement, marker: string): void;
  */
 function getParagraphMarker(element: HTMLElement): string | undefined;
 
+    /**
+ * Set image state to element. This is used to store a image state.
+ */
+function setImageState(element: HTMLElement, marker: string): void;
+
+    /**
+ * Get image state from element. This is used to store a image state.
+ */
+function getImageState(element: HTMLElement): string | undefined;
+
     /**
  * Check if the given content model block or block group is of the expected block group type
  * @param input The object to check
@@ -7693,6 +7743,18 @@ const BulletListType: {
      * Bullet type circle
      */
     Circle: number;
+    /**
+     * Box Shadow bullet type
+     */
+    BoxShadow: number;
+    /**
+     * Rhombus with a cross inside
+     */
+    Xrhombus: number;
+    /**
+     * Check mark bullet type
+     */
+    CheckMark: number;
     /**
      * Maximum value of the enum
      */
@@ -8764,6 +8826,8 @@ class EditPlugin implements EditorPlugin  {
      * handleTabKey: A boolean that enables or disables Tab key handling. Defaults to true.
      */
     constructor(options?: EditOptions);
+    private createNormalEnterChecker;
+    private getHandleNormalEnter;
     /**
      * Get name of this plugin
      */
@@ -8814,6 +8878,13 @@ type EditOptions = {
      * @default true
      */
     handleExpandedSelectionOnDelete?: boolean;
+    /**
+     * Callback function to determine whether the Rooster should handle the Enter key press.
+     * If the function returns true, the Rooster will handle the Enter key press instead of the browser.
+     * @param editor - The editor instance.
+     * @returns A boolean
+     */
+    shouldHandleEnterKey?: ((editor: IEditor) => boolean) | boolean;
 };
 
     /**
@@ -8862,10 +8933,13 @@ class AutoFormatPlugin implements EditorPlugin  {
      * @param event The event to handle:
      */
     onPluginEvent(event: PluginEvent): void;
+    private autoLink;
+    private tabFeatures;
     private features;
+    private enterFeatures;
+    private handleKeyboardEvents;
     private handleEditorInputEvent;
     private handleKeyDownEvent;
-    private handleEnterKey;
     private handleContentChangedEvent;
 }