roosterjs 9.2.0 → 9.3.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.2.0)
+// Type definitions for roosterjs (Version 9.3.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -2711,19 +2711,20 @@ type ColorTransformFunction = (lightColor: string, baseLValue?: number, colorTyp
  * An interface of Editor, built on top of Content Model
  */
 interface IEditor {
+    /**
+     * @deprecated Use formatContentModel() instead
+     */
+    getContentModelCopy(mode: 'connected'): ContentModelDocument;
     /**
      * Create Content Model from DOM tree in this editor
      * @param mode What kind of Content Model we want. Currently we support the following values:
-     * - connected: Returns a connect Content Model object. "Connected" means if there is any entity inside editor, the returned Content Model will
-     * contain the same wrapper element for entity. This option should only be used in some special cases. In most cases we should use "disconnected"
-     * to get a fully disconnected Content Model so that any change to the model will not impact editor content.
      * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
      * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
      * If editor is in dark mode, the cloned entity will be converted back to light mode.
      * - clean: Similar with disconnected, this will return a disconnected model, the difference is "clean" mode will not include any selection info.
      * This is usually used for exporting content
      */
-    getContentModelCopy(mode: 'connected' | 'disconnected' | 'clean'): ContentModelDocument;
+    getContentModelCopy(mode: 'disconnected' | 'clean'): ContentModelDocument;
     /**
      * Get current running environment, such as if editor is running on Mac
      */
@@ -3854,6 +3855,10 @@ interface FormatContentModelOptions {
      * When specified, use this selection range to override current selection inside editor
      */
     selectionOverride?: DOMSelection;
+    /**
+     * When pass to true, scroll the editing caret into view after write DOM tree if need
+     */
+    scrollCaretIntoView?: boolean;
 }
 
     /**
@@ -4758,6 +4763,60 @@ type ParsedTable = ParsedTableCell[][];
  */
 type ParsedTableCell = HTMLTableCellElement | 'spanLeft' | 'spanTop' | 'spanBoth';
 
+    /**
+ * Callback function type for converting a given Content Model object to plain text
+ * @param model The source model object to be converted to plain text
+ */
+type ModelToTextCallback<T> = (model: T) => string;
+
+    /**
+ * Callbacks to customize the behavior of contentModelToText function
+ */
+interface ModelToTextCallbacks {
+    /**
+     * Customize the behavior of converting entity segment to plain text
+     */
+    onEntitySegment?: ModelToTextCallback<ContentModelEntity>;
+    /**
+     * Customize the behavior of converting entity block to plain text
+     */
+    onEntityBlock?: ModelToTextCallback<ContentModelEntity>;
+    /**
+     * Customize the behavior of converting general segment to plain text
+     */
+    onGeneralSegment?: ModelToTextCallback<ContentModelGeneralSegment>;
+    /**
+     * Customize the behavior of converting text model to plain text
+     */
+    onText?: ModelToTextCallback<ContentModelText>;
+    /**
+     * Customize the behavior of converting image model to plain text
+     */
+    onImage?: ModelToTextCallback<ContentModelImage>;
+    /**
+     * Customize the behavior of converting divider model to plain text
+     */
+    onDivider?: ModelToTextCallback<ContentModelDivider>;
+    /**
+     * Customize the check if we should convert a paragraph model to plain text
+     */
+    onParagraph?: ModelToTextChecker<ContentModelParagraph>;
+    /**
+     * Customize the check if we should convert a table model to plain text
+     */
+    onTable?: ModelToTextChecker<ContentModelTable>;
+    /**
+     * Customize the check if we should convert a block group model to plain text
+     */
+    onBlockGroup?: ModelToTextChecker<ContentModelBlockGroup>;
+}
+
+    /**
+ * Callback function type for checking if we should convert to text for the given content model object
+ * @param model The source model to check if we should convert it to plain text
+ */
+type ModelToTextChecker<T> = (model: T) => boolean;
+
     /**
  * Editor plugin event interface
  */
@@ -5305,8 +5364,9 @@ function contentModelToDom(doc: Document, root: Node, model: ContentModelDocumen
  * Convert Content Model to plain text
  * @param model The source Content Model
  * @param [separator='\r\n'] The separator string used for connect lines
+ * @param callbacks  Callbacks to customize the behavior of contentModelToText function
  */
-function contentModelToText(model: ContentModelDocument, separator?: string): string;
+function contentModelToText(model: ContentModelDocument, separator?: string, callbacks?: ModelToTextCallbacks): string;
 
     /**
  * Content Model Element Processor for child elements
@@ -6571,9 +6631,6 @@ class Editor implements IEditor  {
     /**
      * Create Content Model from DOM tree in this editor
      * @param mode What kind of Content Model we want. Currently we support the following values:
-     * - connected: Returns a connect Content Model object. "Connected" means if there is any entity inside editor, the returned Content Model will
-     * contain the same wrapper element for entity. This option should only be used in some special cases. In most cases we should use "disconnected"
-     * to get a fully disconnected Content Model so that any change to the model will not impact editor content.
      * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
      * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
      * If editor is in dark mode, the cloned entity will be converted back to light mode.
@@ -6736,15 +6793,28 @@ class Editor implements IEditor  {
 function createModelFromHtml(html: string, options?: Partial<DomToModelOptionForSanitizing>, trustedHTMLHandler?: TrustedHTMLHandler, defaultSegmentFormat?: ContentModelSegmentFormat): ContentModelDocument;
 
     /**
- * Export string content of editor
+ * 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 plain text result. This is the default option
+ * @param options @optional Options for Model to DOM conversion
+ */
+function exportContent(editor: IEditor, mode?: 'HTML', options?: ModelToDomOption): string;
+
+    /**
+ * Export plain text content
+ * @param editor The editor to get content from
+ * @param mode Specify PlainText to get plain text result
+ * @param callbacks @optional Callbacks to customize conversion behavior
+ */
+function exportContent(editor: IEditor, mode: 'PlainText', callbacks?: ModelToTextCallbacks): string;
+
+    /**
+ * Export plain text using editor's textContent property directly
  * @param editor The editor to get content from
- * @param mode Mode of content to export. It supports:
- * - HTML: Export HTML content. If there are entities, this will cause EntityOperation event with option = 'replaceTemporaryContent' to get a dehydrated entity
- * - PlainText: Export plain text content
- * - PlainTextFast: Export plain text using editor's textContent property directly
+ * @param mode Specify PlainTextFast to get plain text result using textContent property
  * @param options @optional Options for Model to DOM conversion
  */
-function exportContent(editor: IEditor, mode?: ExportContentMode, options?: ModelToDomOption): string;
+function exportContent(editor: IEditor, mode: 'PlainTextFast'): string;
 
     /**
  * Undo to last undo snapshot
@@ -7165,6 +7235,15 @@ function formatSegmentWithContentModel(editor: IEditor, apiName: string, toggleS
  */
 function formatTextSegmentBeforeSelectionMarker(editor: IEditor, callback: (model: ContentModelDocument, previousSegment: ContentModelText, paragraph: ContentModelParagraph, markerFormat: ContentModelSegmentFormat, context: FormatContentModelContext) => boolean, options?: FormatContentModelOptions): boolean;
 
+    /**
+ * Format content model at a given insert point with a callback function
+ * @param editor The editor object
+ * @param insertPoint The insert point to format
+ * @param callback The callback function to format the content model
+ * @param options Options to control the behavior of the formatting
+ */
+function formatInsertPointWithContentModel(editor: IEditor, insertPoint: DOMInsertPoint, callback: (model: ContentModelDocument, context: FormatContentModelContext, insertPoint?: InsertPoint) => void, options?: FormatContentModelOptions): void;
+
     /**
  * Set a list type to content model
  * @param model the model document
@@ -7227,6 +7306,7 @@ function getListAnnounceData(path: ContentModelBlockGroup[]): AnnounceData | nul
 class TableEditPlugin implements EditorPlugin  {
     private anchorContainerSelector?;
     private onTableEditorCreated?;
+    private disableFeatures?;
     private editor;
     private onMouseMoveDisposer;
     private tableRectMap;
@@ -7237,8 +7317,9 @@ class TableEditPlugin implements EditorPlugin  {
      * The container must not be affected by transform: scale(), otherwise the position calculation will be wrong.
      * If not specified, the plugin will be inserted in document.body
      * @param onTableEditorCreated An optional callback to customize the Table Editors elements when created.
+     * @param disableFeatures An optional array of TableEditFeatures to disable
      */
-    constructor(anchorContainerSelector?: string | undefined, onTableEditorCreated?: OnTableEditorCreatedCallback | undefined);
+    constructor(anchorContainerSelector?: string | undefined, onTableEditorCreated?: OnTableEditorCreatedCallback | undefined, disableFeatures?: TableEditFeatureName[] | undefined);
     /**
      * Get a friendly name of this plugin
      */
@@ -7273,7 +7354,12 @@ class TableEditPlugin implements EditorPlugin  {
     /**
  * Optional callback when creating a TableEditPlugin, allows to customize the Selectors element as required.
  */
-type OnTableEditorCreatedCallback = (editorType: 'HorizontalTableInserter' | 'VerticalTableInserter' | 'TableMover' | 'TableResizer', element: HTMLElement) => () => void;
+type OnTableEditorCreatedCallback = (featureType: TableEditFeatureName, element: HTMLElement) => () => void;
+
+    /**
+ * Names of table edit features
+ */
+type TableEditFeatureName = 'HorizontalTableInserter' | 'VerticalTableInserter' | 'TableMover' | 'TableResizer' | 'TableSelector' | 'CellResizer';
 
     /**
  * Paste plugin, handles BeforePaste event and reformat some special content, including:
@@ -7701,7 +7787,7 @@ interface ContextMenuOptions<T> {
  * A watermark plugin to manage watermark string for roosterjs
  */
 class WatermarkPlugin implements EditorPlugin  {
-    private watermark;
+    protected watermark: string;
     private editor;
     private format;
     private isShowing;