roosterjs 8.44.1 → 8.45.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.44.1)
+// Type definitions for roosterjs (Version 8.45.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -197,13 +197,13 @@ export function addDelimiters(node: Element): Element[];
  * Adds delimiter after the element provided.
  * @param element element to use
  */
-export function addDelimiterAfter(element: Element): Element;
+export function addDelimiterAfter(element: Element): HTMLElement;
 
 /**
  * Adds delimiter before the element provided.
  * @param element element to use
  */
-export function addDelimiterBefore(element: Element): Element;
+export function addDelimiterBefore(element: Element): HTMLElement;
 
 /**
  * Retrieves Delimiter information from a provided element.
@@ -1948,14 +1948,26 @@ export function toArray<T>(array: readonly T[]): T[];
 /**
  * RoosterJs core editor class
  */
-export class Editor implements IEditor  {
-    private core;
+export class Editor extends EditorBase<EditorCore, EditorOptions> {
     /**
-     * Creates an instance of Editor
+     * Creates an instance of EditorBase
      * @param contentDiv The DIV HTML element which will be the container element of editor
      * @param options An optional options object to customize the editor
      */
     constructor(contentDiv: HTMLDivElement, options?: EditorOptions);
+}
+
+/**
+ * Base class of editor
+ */
+export class EditorBase<TEditorCore extends EditorCore, TEditorOptions extends EditorOptions> implements IEditor  {
+    private core;
+    /**
+     * Creates an instance of EditorBase
+     * @param contentDiv The DIV HTML element which will be the container element of editor
+     * @param options An optional options object to customize the editor
+     */
+    constructor(contentDiv: HTMLDivElement, options: TEditorOptions, coreCreator: CoreCreator<TEditorCore, TEditorOptions>);
     /**
      * Dispose this editor, dispose all plugins and custom data
      */
@@ -2049,7 +2061,7 @@ export class Editor implements IEditor  {
      * @param applyCurrentStyle True if apply format of current selection to the pasted content,
      * false to keep original format.  Default value is false. When pasteAsText is true, this parameter is ignored
      */
-    paste(clipboardData: ClipboardData, pasteAsText?: boolean, applyCurrentFormat?: boolean): void;
+    paste(clipboardData: ClipboardData, pasteAsText?: boolean, applyCurrentFormat?: boolean, pasteAsImage?: boolean): void;
     /**
      * Get current selection range from Editor.
      * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache.
@@ -2328,9 +2340,24 @@ export class Editor implements IEditor  {
      * @returns the current EditorCore object
      * @throws a standard Error if there's no core object
      */
-    protected getCore(): EditorCore;
+    protected getCore(): TEditorCore;
 }
 
+/**
+ * Check if the given experimental feature is enabled
+ * @param featureSet All enabled features
+ * @param feature The feature to check
+ * @returns True if the given feature is enabled, otherwise false
+ */
+export function isFeatureEnabled(featureSet: (ExperimentalFeatures | CompatibleExperimentalFeatures)[] | undefined, feature: ExperimentalFeatures | CompatibleExperimentalFeatures): boolean;
+
+/**
+ * Create a new instance of Editor Core
+ * @param contentDiv The DIV HTML element which will be the container element of editor
+ * @param options An optional options object to customize the editor
+ */
+export const createEditorCore: CoreCreator<EditorCore, EditorOptions>;
+
 /**
  * Increase or decrease font size in selection
  * @param editor The editor instance
@@ -2724,7 +2751,7 @@ export function toggleListType(editor: IEditor, listType: ListType | CompatibleL
 /**
  * Split selection into regions, and perform a block-wise formatting action for each region.
  */
-export function blockFormat(editor: IEditor, callback: (region: Region, start: NodePosition, end: NodePosition, chains: VListChain[]) => void, beforeRunCallback?: () => boolean, apiName?: string): void;
+export function blockFormat(editor: IEditor, callback: (region: Region, start: NodePosition | null, end: NodePosition | null, chains: VListChain[]) => void, beforeRunCallback?: () => boolean, apiName?: string): void;
 
 /**
  * Commit changes of all list changes when experiment features are allowed
@@ -3437,7 +3464,12 @@ export const enum ChangeSource {
     /**
      * List chain reorganized numbers of lists
      */
-    ListChain = "ListChain"
+    ListChain = "ListChain",
+    /**
+     * Keyboard event, used by Content Model.
+     * Data of this event will be the key code number
+     */
+    Keyboard = "Keyboard"
 }
 
 /**
@@ -6341,7 +6373,7 @@ export interface IEditor {
      * @param applyCurrentStyle True if apply format of current selection to the pasted content,
      * false to keep original format.  Default value is false. When pasteAsText is true, this parameter is ignored
      */
-    paste(clipboardData: ClipboardData, pasteAsText?: boolean, applyCurrentFormat?: boolean): void;
+    paste(clipboardData: ClipboardData, pasteAsText?: boolean, applyCurrentFormat?: boolean, pasteAsImage?: boolean): void;
     /**
      * Get current selection range from Editor.
      * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache.
@@ -7086,6 +7118,16 @@ export interface CoreApiMap {
      * @param step Steps to move, can be 0, positive or negative
      */
     restoreUndoSnapshot: RestoreUndoSnapshot;
+    /**
+     * Select content according to the given information.
+     * There are a bunch of allowed combination of parameters. See IEditor.select for more details
+     * @param core The editor core object
+     * @param arg1 A DOM Range, or SelectionRangeEx, or NodePosition, or Node, or Selection Path
+     * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection
+     * @param arg3 (optional) A Node
+     * @param arg4 (optional) An offset number, or a PositionType
+     */
+    select: Select;
     /**
      * Change the editor selection to the given range
      * @param core The EditorCore object
@@ -7157,7 +7199,7 @@ export interface CoreApiMap {
  * @param applyCurrentStyle True if apply format of current selection to the pasted content,
  * false to keep original format
  */
-export type CreatePasteFragment = (core: EditorCore, clipboardData: ClipboardData, position: NodePosition | null, pasteAsText: boolean, applyCurrentStyle: boolean) => DocumentFragment | null;
+export type CreatePasteFragment = (core: EditorCore, clipboardData: ClipboardData, position: NodePosition | null, pasteAsText: boolean, applyCurrentStyle: boolean, pasteAsImage: boolean) => DocumentFragment | null;
 
 /**
  * Ensure user will type into a container element rather than into the editor content DIV directly
@@ -7234,6 +7276,17 @@ export type InsertNode = (core: EditorCore, node: Node, option: InsertOption | n
  */
 export type RestoreUndoSnapshot = (core: EditorCore, step: number) => void;
 
+/**
+ * Select content according to the given information.
+ * There are a bunch of allowed combination of parameters. See IEditor.select for more details
+ * @param core The editor core object
+ * @param arg1 A DOM Range, or SelectionRangeEx, or NodePosition, or Node, or Selection Path
+ * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection
+ * @param arg3 (optional) A Node
+ * @param arg4 (optional) An offset number, or a PositionType
+ */
+export type Select = (core: EditorCore, arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection, arg3?: Node, arg4?: number | PositionType) => boolean;
+
 /**
  * Change the editor selection to the given range
  * @param core The EditorCore object
@@ -7413,7 +7466,7 @@ export interface EditorOptions {
 /**
  * A list to specify whether each of the listed content edit features is enabled
  */
-export interface ContentEditFeatureSettings extends ListFeatureSettings, QuoteFeatureSettings, TableFeatureSettings, StructuredNodeFeatureSettings, AutoLinkFeatureSettings, ShortcutFeatureSettings, CursorFeatureSettings, MarkdownFeatureSettings, EntityFeatureSettings, TextFeatureSettings  {
+export interface ContentEditFeatureSettings extends ListFeatureSettings, QuoteFeatureSettings, TableFeatureSettings, StructuredNodeFeatureSettings, AutoLinkFeatureSettings, ShortcutFeatureSettings, CursorFeatureSettings, MarkdownFeatureSettings, EntityFeatureSettings, TextFeatureSettings, CodeFeatureSettings  {
 }
 
 /**
@@ -7542,6 +7595,16 @@ export interface ListFeatureSettings {
      * @default true
      */
     mergeListOnBackspaceAfterList: boolean;
+    /**
+     * indentWhenAltShiftRight edit feature, provides the ability to indent or outdent current list when user press Alt+shift+Right
+     * @default when browser is in Mac it is default disabled, else it is enabled
+     */
+    indentWhenAltShiftRight: boolean;
+    /**
+     * outdentWhenAltShiftLeft edit feature, provides the ability to indent or outdent current list when user press Alt+shift+Left
+     * @default when browser is in Mac it is default disabled, else it is enabled
+     */
+    outdentWhenAltShiftLeft: boolean;
 }
 
 /**
@@ -7661,6 +7724,22 @@ export interface TextFeatureSettings {
     autoHyphen: boolean;
 }
 
+/**
+ * Settings for code features
+ */
+export interface CodeFeatureSettings {
+    /**
+     * When inside a code block, exit the code block by pressing Enter twice, or once on an empty line
+     * @default true
+     */
+    removeCodeWhenEnterOnEmptyLine: boolean;
+    /**
+     * When inside an empty code block (or an empty first line), exit the code block by pressing Backspace
+     * @default true
+     */
+    removeCodeWhenBackspaceOnEmptyFirstLine: boolean;
+}
+
 /**
  * An interface to define a replacement rule for CustomReplace plugin
  */
@@ -8205,6 +8284,13 @@ export interface CustomizeDefinition extends DefinitionBase<DefinitionType.Custo
  */
 export type Definition<T> = CustomizeDefinition | (T extends any[] ? ArrayDefinition<T> : T extends Record<string, any> ? ObjectDefinition<T> : T extends String ? StringDefinition : T extends Number ? NumberDefinition : T extends Boolean ? BooleanDefinition : never);
 
+/**
+ * Type of Editor Core Creator
+ * @param contentDiv The DIV HTML element which will be the container element of editor
+ * @param options An optional options object to customize the editor
+ */
+export type CoreCreator<TEditorCore extends EditorCore, TEditorOptions extends EditorOptions> = (contentDiv: HTMLDivElement, options: TEditorOptions) => TEditorCore;
+
 /**
  * Experimental feature flags
  */
@@ -8487,7 +8573,12 @@ export enum CompatibleChangeSource {
     /**
      * List chain reorganized numbers of lists
      */
-    ListChain = "ListChain"
+    ListChain = "ListChain",
+    /**
+     * Keyboard event, used by Content Model.
+     * Data of this event will be the key code number
+     */
+    Keyboard = "Keyboard"
 }
 
 /**
@@ -9715,7 +9806,7 @@ export class ContentEdit implements EditorPlugin  {
      * @param settingsOverride An optional feature set to override default feature settings
      * @param additionalFeatures Optional. More features to add
      */
-    constructor(settingsOverride?: Partial<ContentEditFeatureSettings>, additionalFeatures?: GenericContentEditFeature<PluginEvent>[]);
+    constructor(settingsOverride?: Partial<ContentEditFeatureSettings> | undefined, additionalFeatures?: GenericContentEditFeature<PluginEvent>[] | undefined);
     /**
      * Get a friendly name of  this plugin
      */
@@ -10006,6 +10097,18 @@ export class ImageEdit implements EditorPlugin  {
      * @param selectImage True to select this image after quit editing mode
      */
     setEditingImage(image: null, selectImage?: boolean): void;
+    /**
+     * Flip the image.
+     * @param image The image to be flipped
+     * @param direction
+     */
+    flipImage(image: HTMLImageElement, direction: 'vertical' | 'horizontal'): void;
+    /**
+     * Rotate the image in radian angle.
+     * @param image The image to be rotated
+     * @param angleRad The angle in radian that the image must be rotated.
+     */
+    rotateImage(image: HTMLImageElement, angleRad: number): void;
     /**
      * quit editing mode when editor lose focus
      */