roosterjs 9.53.0 → 9.55.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.53.0)
+// Type definitions for roosterjs (Version 9.55.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -1511,7 +1511,11 @@ export type PasteType = /**
 /**
  * If there is a image uri in the clipboard, paste the content as image element
  */
- | 'asImage';
+ | 'asImage'
+/**
+ * If the editor includes a markdown plugin @see MarkdownPastePlugin, and there is markdown content in the clipboard, paste it as markdown
+ */
+ | 'asMarkdown';
 
 /**
  * All Border operations
@@ -2883,6 +2887,13 @@ export interface DomToModelSettings {
      * If true elements that has display:none style will be processed
      */
     processNonVisibleElements?: boolean;
+    /**
+     * When set to true, if a container element could be represented by a FormatContainer, always keep the
+     * FormatContainer and never fall back to a paragraph, even when it only has a single child.
+     * Set this when the intermediate FormatContainer is persisted during DOM to Content Model conversion
+     * and is later used during formatting.
+     */
+    skipFormatContainerFallbackCheck?: boolean;
 }
 
 /**
@@ -3303,6 +3314,13 @@ export interface DomToModelOptionForCreateModel extends DomToModelOption  {
      * When this option is passed, "tryGetFromCache" will be ignored.
      */
     recalculateTableSize?: boolean | 'all' | 'selected' | 'none';
+    /**
+     * When set to true, if a container element could be represented by a FormatContainer, always keep the
+     * FormatContainer and never fall back to a paragraph, even when it only has a single child.
+     * Set this when the intermediate FormatContainer is persisted during DOM to Content Model conversion
+     * and is later used during formatting.
+     */
+    skipFormatContainerFallbackCheck?: boolean;
 }
 
 /**
@@ -3412,6 +3430,14 @@ export interface DomIndexer {
      * @returns True if successfully updated, otherwise false
      */
     reconcileElementId: (element: HTMLElement) => boolean;
+    /**
+     * When src or a data-* attribute is changed on an indexed IMG element, update the related
+     * ContentModelImage (src property or dataset) so the cached model stays valid.
+     * @param element The element that has an attribute changed
+     * @param attributeName The name of the changed attribute
+     * @returns True if successfully updated, otherwise false
+     */
+    reconcileImageAttribute: (element: HTMLElement, attributeName: string) => boolean;
     /**
      * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.
      * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,
@@ -6335,7 +6361,7 @@ export interface BeforePasteEvent extends BasePluginEvent<'beforePaste'> {
      */
     readonly htmlAttributes: Record<string, string>;
     /**
-     * Paste type option (as plain text, merge format, normal, as image)
+     * Paste type option (as plain text, merge format, normal, as image, asMarkdown (@see MarkdownPastePlugin ))
      */
     readonly pasteType: PasteType;
     /**
@@ -7667,7 +7693,7 @@ export function createDomToModelContext(editorContext?: EditorContext, ...option
  * @param config A full config object to define how to convert DOM tree to Content Model
  * @param editorContext Context of editor
  */
-export function createDomToModelContextWithConfig(config: DomToModelSettings, editorContext?: EditorContext): any;
+export function createDomToModelContextWithConfig(config: DomToModelSettings, editorContext?: EditorContext): DomToModelContext;
 
 /**
  * Create Dom to Content Model Config object
@@ -7845,7 +7871,7 @@ export function normalizeFontFamily(fontFamily: string): string;
  * @param allowedCustomPasteType Allowed custom content type when paste besides text/plain, text/html and images
     Only text types are supported, and do not add "text/" prefix to the type values
  */
-export function extractClipboardItems(items: DataTransferItem[], allowedCustomPasteType?: string[]): Promise<ClipboardData>;
+export function extractClipboardItems(items: DataTransferItem[], allowedCustomPasteType?: string[], isPasteNative?: boolean): Promise<ClipboardData>;
 
 /**
  * Gets the cached event data by cache key from event object if there is already one.
@@ -8082,6 +8108,13 @@ export function setSelection(group: ReadonlyContentModelBlockGroup, start?: Read
  */
 export function cloneModel(model: ReadonlyContentModelDocument, options?: CloneModelOptions): ContentModelDocument;
 
+/**
+ * Clone a content model for paste operations, ensuring that cached elements are handled appropriately.
+ * @param model The content model to clone
+ * @returns A cloned content model suitable for paste operations
+ */
+export function cloneModelForPaste(model: ReadonlyContentModelDocument): ContentModelDocument;
+
 /**
  * Merge source model into target mode
  * @param target Target Content Model that will merge content into
@@ -10918,6 +10951,23 @@ export function convertMarkdownToContentModel(text: string, options?: MarkdownTo
  */
 export function convertContentModelToMarkdown(model: ContentModelDocument, newLine?: MarkdownLineBreaks): string;
 
+/**
+ * Detect whether the given plain text contains any markdown markup.
+ * Recognizes block-level patterns (headings, blockquotes, lists, horizontal rules, tables)
+ * and inline patterns (bold, italic, strikethrough, links, images).
+ * @param text The plain text to check.
+ * @returns True if the text contains any markdown markup, false otherwise.
+ */
+export function isContentMarkdown(text: string): boolean;
+
+/**
+ * Detect whether the given clipboard content can be interpreted as markdown.
+ * @param editor The editor instance.
+ * @param clipboardData The clipboard data to check.
+ * @returns True if the content can be interpreted as markdown, false otherwise.
+ */
+export function isPastedContentMarkdown(editor: IEditor, clipboardData: ClipboardData): boolean;
+
 /**
  * The characters to add line breaks and new lines
  */
@@ -10949,3 +10999,60 @@ export interface MarkdownToModelOptions {
     direction?: 'ltr' | 'rtl' | undefined;
 }
 
+/**
+ * Markdown paste plugin. Handles the BeforePaste event and, when the pasted content
+ * can be interpreted as markdown, converts the plain text into a Content Model and
+ * pastes it as rich markdown content instead of the original clipboard HTML.
+ */
+export class MarkdownPastePlugin implements EditorPlugin  {
+    private editor;
+    private options;
+    /**
+     * Construct a new instance of MarkdownPastePlugin
+     * @param options Options to control the markdown paste behavior
+     */
+    constructor(options?: MarkdownPasteOptions);
+    /**
+     * Get name of this plugin
+     */
+    getName(): string;
+    /**
+     * The first method that editor will call to a plugin when editor is initializing.
+     * It will pass in the editor instance, plugin should take this chance to save the
+     * editor reference so that it can call to any editor method or format API later.
+     * @param editor The editor object
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * The last method that editor will call to a plugin before it is disposed.
+     * Plugin can take this chance to clear the reference to editor. After this method is
+     * called, plugin should not call to any editor method since it will result in error.
+     */
+    dispose(): void;
+    /**
+     * Core method for a plugin. Once an event happens in editor, editor will call this
+     * method of each plugin to handle the event as long as the event is not handled
+     * exclusively by another plugin.
+     * @param event The event to handle:
+     */
+    onPluginEvent(event: PluginEvent): void;
+}
+
+/**
+ * Options for MarkdownPastePlugin
+ */
+export interface MarkdownPasteOptions {
+    /**
+     * When true, content that can be interpreted as markdown is automatically converted
+     * into rich content on every paste, without requiring an explicit "Paste as Markdown"
+     * command.
+     * @default false
+     */
+    autoConversion: boolean;
+    /**
+     * When true, the plugin will undo the markdown conversion when the user undoes the action.
+     * @default false
+     */
+    undoConversion: boolean;
+}
+