roosterjs 9.34.0 → 9.35.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.34.0)
+// Type definitions for roosterjs (Version 9.35.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -4284,13 +4284,13 @@ interface CachePluginState {
      */
     paragraphMap?: ParagraphMap & ParagraphIndexer;
     /**
-     * @optional Indexer for CachePlugin, to help build backward relationship from DOM node to Content Model
+     * Indexer for CachePlugin, to help build backward relationship from DOM node to Content Model
      */
-    domIndexer?: DomIndexer;
+    domIndexer: DomIndexer;
     /**
-     * @optional A wrapper of MutationObserver to help detect text changes in editor
+     * A wrapper of MutationObserver to help detect text changes in editor
      */
-    textMutationObserver?: TextMutationObserver;
+    textMutationObserver: TextMutationObserver;
 }
 
     /**
@@ -6093,7 +6093,11 @@ interface ContentChangedEvent extends BasePluginEvent<'contentChanged'> {
      */
     readonly formatApiName?: string;
     /**
-     * @deprecated Call editor.announce(announceData) directly insteaad
+     * When set to true, the change will not be added to the undo stack
+     */
+    readonly skipUndo?: boolean;
+    /**
+     * @deprecated Call editor.announce(announceData) directly instead
      */
     readonly announceData?: AnnounceData;
 }
@@ -7490,8 +7494,9 @@ function getFirstSelectedTable(model: ReadonlyContentModelDocument): [ReadonlyCo
  * @param blockGroupTypes The expected block group types
  * @param stopTypes Block group types that will stop searching when hit
  * @param deepFirst True means search in deep first, otherwise wide first
+ * @param isValidTarget @optional An additional callback to validate whether a matching block group is a valid target
  */
-function getOperationalBlocks<T extends ContentModelBlockGroup>(group: ContentModelBlockGroup, blockGroupTypes: TypeOfBlockGroup<T>[], stopTypes: ContentModelBlockGroupType[], deepFirst?: boolean): OperationalBlocks<T>[];
+function getOperationalBlocks<T extends ContentModelBlockGroup>(group: ContentModelBlockGroup, blockGroupTypes: TypeOfBlockGroup<T>[], stopTypes: ContentModelBlockGroupType[], deepFirst?: boolean, isValidTarget?: (block: ReadonlyContentModelBlockGroup) => boolean): OperationalBlocks<T>[];
 
     /**
  * Get an array of block group - block pair that is of the expected block group type from selection (Readonly)
@@ -7499,8 +7504,9 @@ function getOperationalBlocks<T extends ContentModelBlockGroup>(group: ContentMo
  * @param blockGroupTypes The expected block group types
  * @param stopTypes Block group types that will stop searching when hit
  * @param deepFirst True means search in deep first, otherwise wide first
+ * @param isValidTarget @optional An additional callback to validate whether a matching block group is a valid target
  */
-function getOperationalBlocks<T extends ReadonlyContentModelBlockGroup>(group: ReadonlyContentModelBlockGroup, blockGroupTypes: TypeOfBlockGroup<T>[], stopTypes: ContentModelBlockGroupType[], deepFirst?: boolean): ReadonlyOperationalBlocks<T>[];
+function getOperationalBlocks<T extends ReadonlyContentModelBlockGroup>(group: ReadonlyContentModelBlockGroup, blockGroupTypes: TypeOfBlockGroup<T>[], stopTypes: ContentModelBlockGroupType[], deepFirst?: boolean, isValidTarget?: (block: ReadonlyContentModelBlockGroup) => boolean): ReadonlyOperationalBlocks<T>[];
 
     /**
  * Get any array of selected paragraphs from a content model
@@ -7737,8 +7743,9 @@ function getSegmentTextFormat(segment: ReadonlyContentModelSegment, includingBIU
  * @param path The block group path, from the closest one to root
  * @param blockGroupTypes The expected block group types
  * @param stopTypes @optional Block group types that will cause stop searching
+ * @param isValidTarget @optional An additional callback to validate whether a matching block group is a valid target
  */
-function getClosestAncestorBlockGroupIndex<T extends ContentModelBlockGroup>(path: ReadonlyContentModelBlockGroup[], blockGroupTypes: TypeOfBlockGroup<T>[], stopTypes?: ContentModelBlockGroupType[]): number;
+function getClosestAncestorBlockGroupIndex<T extends ContentModelBlockGroup>(path: ReadonlyContentModelBlockGroup[], blockGroupTypes: TypeOfBlockGroup<T>[], stopTypes?: ContentModelBlockGroupType[], isValidTarget?: (block: ReadonlyContentModelBlockGroup) => boolean): number;
 
     /**
  * Run editing steps on top of a given context object which includes current insert point and previous editing result
@@ -10058,13 +10065,20 @@ function getDarkColor(color: string, baseLValue?: number): string;
 
     /**
  * Convert the whole content to ContentModel with the given plain text
- * @param editor The editor instance
  * @param text The markdown text
  * @param splitLinesPattern The pattern to split lines. Default is /\r\n|\r|\\n|\n/
  * @returns The ContentModelDocument
  */
 function convertMarkdownToContentModel(text: string, splitLinesPattern?: string): ContentModelDocument;
 
+    /**
+ * Convert the whole content to ContentModel with the given plain text
+ * @param text The markdown text
+ * @param options The markdown options
+ * @returns The ContentModelDocument
+ */
+function convertMarkdownToContentModel(text: string, options?: MarkdownToModelOptions): ContentModelDocument;
+
     /**
  * Export content model document to markdown
  * @param selection The editor selection
@@ -10081,4 +10095,22 @@ interface MarkdownLineBreaks {
     lineBreak: string;
 }
 
+    /**
+ * Options for processing markdown text.
+ */
+interface MarkdownToModelOptions {
+    /**
+     * The pattern to split lines in the markdown text.
+     */
+    splitLinesPattern?: string;
+    /**
+     * Specify how should we process empty lines in the markdown text.
+     * - 'preserve': Keep empty lines as they are.
+     * - 'remove': Remove empty lines.
+     * - 'merge': Merge empty lines with adjacent paragraphs.
+     * @default 'merge'
+     */
+    emptyLine?: 'preserve' | 'remove' | 'merge';
+}
+
 }