roosterjs 9.50.0 → 9.51.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.50.0)
+// Type definitions for roosterjs (Version 9.51.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -2976,6 +2976,7 @@ interface EditorContext {
      */
     allowCacheElement?: boolean;
     /**
+     * @deprecated This is now always be treated as true
      * Whether to allow caching list item elements separately.
      */
     allowCacheListItem?: boolean;
@@ -3058,6 +3059,11 @@ interface DomToModelListFormat {
      * Current list type stack
      */
     levels: ContentModelListLevel[];
+    /**
+     * This is used for handling an abnormal case where list items are not inside a ul or ol tag
+     * It is not common and against the HTML specification, but we need to handle it for robustness
+     */
+    potentialListType?: 'OL' | 'UL';
 }
 
     /**
@@ -3812,11 +3818,6 @@ interface IEditor {
  * when create editor
  */
 type ExperimentalFeature = GraduatedExperimentalFeature
-/**
- * @deprecated Please use the shouldHandleEnterKey option of the EditPlugin Options
- * Use Content Model handle ENTER key
- */
- | 'HandleEnterKey'
 /**
  * For CJK keyboard input on mobile, if the user toggles bold/italic/underline on an empty div,
  * the pending format will be applied on the selection marker. When typing text, the selection moves to the text node and the
@@ -3824,19 +3825,6 @@ type ExperimentalFeature = GraduatedExperimentalFeature
  * the original formatting of the selection marker is kept to match the pending format.
  */
  | 'KeepSelectionMarkerWhenEnteringTextNode'
-/**
- * Export editor content as HTML using HTMLFast option
- */
- | 'ExportHTMLFast'
-/**
- * Get cloned root element from an independent HTML document instead of current document.
- * So any operation to the cloned root won't trigger network request for resources like images
- */
- | 'CloneIndependentRoot'
-/**
- * Allow caching list item elements.
- */
- | 'CacheList'
 /**
  * Transform the table border colors when switching from light to dark mode
  */
@@ -3860,7 +3848,28 @@ type GraduatedExperimentalFeature = /**
  * Prevent default browser behavior for copy/cut event,
  * and set the clipboard data with custom implementation.
  */
- | 'CustomCopyCut';
+ | 'CustomCopyCut'
+/**
+ * @deprecated
+ * Export editor content as HTML using HTMLFast option
+ */
+ | 'ExportHTMLFast'
+/**
+ * @deprecated Please use the shouldHandleEnterKey option of the EditPlugin Options
+ * Use Content Model handle ENTER key
+ */
+ | 'HandleEnterKey'
+/**
+ * @deprecated
+ * Get cloned root element from an independent HTML document instead of current document.
+ * So any operation to the cloned root won't trigger network request for resources like images
+ */
+ | 'CloneIndependentRoot'
+/**
+ * @deprecated
+ * Allow caching list item elements.
+ */
+ | 'CacheList';
 
     /**
  * Options for editor
@@ -7425,15 +7434,6 @@ function normalizeParagraph(paragraph: ReadonlyContentModelParagraph): void;
  */
 function normalizeContentModel(group: ReadonlyContentModelBlockGroup): void;
 
-    /**
- * Strip invisible Unicode characters from all text and link hrefs in a content model.
- * This sanitizes the model at initialization time to prevent hidden content in links
- * or text (e.g. zero-width chars, bidirectional marks, Unicode Tags).
- * For General segments, all Text nodes under the element are also sanitized.
- * @param model The content model document to sanitize in-place
- */
-function sanitizeInvisibleUnicode(model: ContentModelDocument): void;
-
     /**
  * Check if the given block group is a general segment
  * @param group The group to check
@@ -7751,19 +7751,6 @@ function isSpace(char: string): boolean;
  */
 function normalizeText(txt: string, isForward: boolean): string;
 
-    /**
- * Strip invisible Unicode characters from a string.
- * This removes zero-width characters, bidirectional marks, Unicode Tags (U+E0001-U+E00FF),
- * interlinear annotation anchors, Mongolian free variation selectors,
- * and other invisible formatting characters that can be used to hide content in links.
- *
- * @remarks This function strips ZWJ (U+200D) which may affect emoji sequences.
- * It should only be applied to href attributes, not to visible text content.
- * @param value The string to strip invisible characters from
- * @returns The string with invisible characters removed
- */
-function stripInvisibleUnicode(value: string): string;
-
     /**
  * Parse a table into a two dimensions array of TD elements. For those merged cells, the value will be null.
  * @param table Input HTML Table element
@@ -8767,7 +8754,7 @@ function createModelFromHtml(html: string, options?: Partial<DomToModelOptionFor
     /**
  * Export HTML content. If there are entities, this will cause EntityOperation event with option = 'replaceTemporaryContent' to get a dehydrated entity
  * @param editor The editor to get content from
- * @param mode Specify HTML to get HTML. This is the default option
+ * @param mode Specify HTML to get HTML.
  * @param options @optional Options for Model to DOM conversion
  */
 function exportContent(editor: IEditor, mode?: 'HTML', options?: ModelToDomOption): string;
@@ -8776,9 +8763,9 @@ function exportContent(editor: IEditor, mode?: 'HTML', options?: ModelToDomOptio
  * Export HTML content. If there are entities, this will cause EntityOperation event with option = 'replaceTemporaryContent' to get a dehydrated entity.
  * This is a fast version, it retrieve HTML content directly from editor without going through content model conversion.
  * @param editor The editor to get content from
- * @param mode Specify HTMLFast to get HTML result.
+ * @param mode Specify HTMLFast to get HTML result. This is the default option
  */
-function exportContent(editor: IEditor, mode: 'HTMLFast'): string;
+function exportContent(editor: IEditor, mode?: 'HTMLFast'): string;
 
     /**
  * Export plain text content
@@ -9495,15 +9482,12 @@ class EditPlugin implements EditorPlugin  {
     private disposer;
     private shouldHandleNextInputEvent;
     private selectionAfterDelete;
-    private handleNormalEnter;
     private options;
     /**
      * @param options An optional parameter that takes in an object of type EditOptions, which includes the following properties:
      * handleTabKey: A boolean or HandleTabOptions object that controls Tab key handling. When a boolean, true enables all features and false disables all. When an object, individual features can be controlled. Defaults to all enabled.
      */
     constructor(options?: EditOptions);
-    private createNormalEnterChecker;
-    private getHandleNormalEnter;
     /**
      * Get name of this plugin
      */
@@ -9559,6 +9543,7 @@ type EditOptions = {
      */
     handleExpandedSelectionOnDelete?: boolean;
     /**
+     * @deprecated This is always treated as true now
      * 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.