roosterjs 9.11.2 → 9.13.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.11.2)
+// Type definitions for roosterjs (Version 9.13.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -2852,6 +2852,10 @@ export interface ModelToDomBlockAndSegmentNode {
      * Segment node of this position. When provided, it represents the position right after this node
      */
     segment: Node | null;
+    /**
+     * Offset number of this position. It is only used for Text node, default value is 0
+     */
+    offset?: number;
 }
 
 /**
@@ -3064,6 +3068,14 @@ export interface DomIndexer {
      * @param parent Parent of entity. For block element, this should be the parent block group. For inline entity, this should be the parent paragraph
      */
     onBlockEntity: (entity: ContentModelEntity, group: ContentModelBlockGroup) => void;
+    /**
+     * Invoke when merge two continuous text nodes, we need to merge their indexes as well
+     * @param targetText Target text node to merge into
+     * @param sourceText Source text node to merge from
+     * @example Assume we have two text nodes: Node1="Foo", Node2="Bar", after merge,
+     * Node1 will become "FooBar", Node2 will be removed from DOM tree
+     */
+    onMergeText: (targetText: Text, sourceText: Text) => void;
     /**
      * When document content or selection is changed by user, we need to use this function to update the content model
      * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.
@@ -4359,6 +4371,28 @@ export interface ContextMenuPluginState {
     contextMenuProviders: ContextMenuProvider<any>[];
 }
 
+/**
+ * Options to customize the Auto link options in Auto Format Plugin
+ */
+export interface AutoLinkOptions {
+    /**
+     * When press backspace before a link, remove the hyperlink
+     */
+    autoUnlink?: boolean;
+    /**
+     * When paste or type content with a link, create hyperlink for the link
+     */
+    autoLink?: boolean;
+    /**
+     * When paste content or type content with telephone, create hyperlink for the telephone number
+     */
+    autoTel?: boolean;
+    /**
+     * When paste or type a content with mailto, create hyperlink for the content
+     */
+    autoMailto?: boolean;
+}
+
 /**
  * Current running environment
  */
@@ -5333,14 +5367,16 @@ export interface MergeModelOption {
     insertPosition?: InsertPoint;
     /**
      * Use this to decide whether to change the source model format when doing the merge.
-     * 'mergeAll': segment format of the insert position will be merged into the content that is merged into current model.
+     * 'mergeAll': (deprecated) Use PreferSource Instead, segment format of the insert position will be merged into the content that is merged into current model.
      * If the source model already has some format, it will not be overwritten.
      * 'keepSourceEmphasisFormat': format of the insert position will be set into the content that is merged into current model.
      * If the source model already has emphasis format, such as, fontWeight, Italic or underline different than the default style, it will not be overwritten.
      * 'none' the source segment format will not be modified.
+     * 'preferSource' Will merge both formatting, but source will overwrite target
+     * 'preferTarget' Will merge both formatting, but target will overwrite source
      * @default undefined
      */
-    mergeFormat?: 'mergeAll' | 'keepSourceEmphasisFormat' | 'none';
+    mergeFormat?: 'mergeAll' | 'keepSourceEmphasisFormat' | 'none' | 'preferSource' | 'preferTarget';
     /**
      * Whether to add a paragraph after the merged content.
      */
@@ -7181,9 +7217,10 @@ export function getListStyleTypeFromString(listType: 'OL' | 'UL', bullet: string
 /**
  * Get the text format of a segment, this function will return only format that is applicable to text
  * @param segment The segment to get format from
+ * @param includingBIU When pass true, also get Bold/Italic/Underline format
  * @returns
  */
-export function getSegmentTextFormat(segment: ReadonlyContentModelSegment): ContentModelSegmentFormat;
+export function getSegmentTextFormat(segment: ReadonlyContentModelSegment, includingBIU?: boolean): ContentModelSegmentFormat;
 
 /**
  * Get index of closest ancestor block group of the expected block group type. If not found, return -1
@@ -8269,6 +8306,19 @@ export function setModelIndentation(model: ReadonlyContentModelDocument, indenta
  */
 export function matchLink(url: string): LinkData | null;
 
+/**
+ * Promote the given text segment to a hyper link when the segment text is ending with a valid link format.
+ * When the whole text segment if of a link, promote the whole segment.
+ * When the text segment ends with a link format, split the segment and promote the second part
+ * When link is in middle of the text segment, no action.
+ * This is mainly used for doing auto link when there is a link before cursor
+ * @param segment The text segment to search link text from
+ * @param paragraph Parent paragraph of the segment
+ * @param options Options of auto link
+ * @returns If a link is promoted, return this segment. Otherwise return null
+ */
+export function promoteLink(segment: ContentModelText, paragraph: ShallowMutableContentModelParagraph, autoLinkOptions: AutoLinkOptions): ContentModelText | null;
+
 /**
  * Get announce data for list item
  * @param path Content model path that include the list item
@@ -8527,28 +8577,6 @@ export interface AutoFormatOptions extends AutoLinkOptions  {
     autoOrdinals?: boolean;
 }
 
-/**
- * Options to customize the Auto link options in Auto Format Plugin
- */
-export interface AutoLinkOptions {
-    /**
-     * When press backspace before a link, remove the hyperlink
-     */
-    autoUnlink?: boolean;
-    /**
-     * When paste or type content with a link, create hyperlink for the link
-     */
-    autoLink?: boolean;
-    /**
-     * When paste content or type content with telephone, create hyperlink for the telephone number
-     */
-    autoTel?: boolean;
-    /**
-     * When paste or type a content with mailto, create hyperlink for the content
-     */
-    autoMailto?: boolean;
-}
-
 /**
  * Shortcut command for Bold
  * Windows: Ctrl + B