roosterjs 8.44.2 → 8.45.1

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.44.2)
+// Type definitions for roosterjs (Version 8.45.1)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -1949,14 +1949,26 @@ function toArray<T>(array: readonly T[]): T[];
     /**
  * RoosterJs core editor class
  */
-class Editor implements IEditor  {
-    private core;
+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
+ */
+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
      */
@@ -2050,7 +2062,7 @@ 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.
@@ -2329,9 +2341,24 @@ 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
+ */
+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
+ */
+const createEditorCore: CoreCreator<EditorCore, EditorOptions>;
+
     /**
  * Increase or decrease font size in selection
  * @param editor The editor instance
@@ -3438,7 +3465,12 @@ 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"
 }
 
     /**
@@ -6342,7 +6374,7 @@ 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.
@@ -7087,6 +7119,16 @@ 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
@@ -7158,7 +7200,7 @@ interface CoreApiMap {
  * @param applyCurrentStyle True if apply format of current selection to the pasted content,
  * false to keep original format
  */
-type CreatePasteFragment = (core: EditorCore, clipboardData: ClipboardData, position: NodePosition | null, pasteAsText: boolean, applyCurrentStyle: boolean) => DocumentFragment | null;
+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
@@ -7235,6 +7277,17 @@ type InsertNode = (core: EditorCore, node: Node, option: InsertOption | null) =>
  */
 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
+ */
+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
@@ -7414,7 +7467,7 @@ interface EditorOptions {
     /**
  * A list to specify whether each of the listed content edit features is enabled
  */
-interface ContentEditFeatureSettings extends ListFeatureSettings, QuoteFeatureSettings, TableFeatureSettings, StructuredNodeFeatureSettings, AutoLinkFeatureSettings, ShortcutFeatureSettings, CursorFeatureSettings, MarkdownFeatureSettings, EntityFeatureSettings, TextFeatureSettings  {
+interface ContentEditFeatureSettings extends ListFeatureSettings, QuoteFeatureSettings, TableFeatureSettings, StructuredNodeFeatureSettings, AutoLinkFeatureSettings, ShortcutFeatureSettings, CursorFeatureSettings, MarkdownFeatureSettings, EntityFeatureSettings, TextFeatureSettings, CodeFeatureSettings  {
 }
 
     /**
@@ -7543,6 +7596,16 @@ 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;
 }
 
     /**
@@ -7662,6 +7725,22 @@ interface TextFeatureSettings {
     autoHyphen: boolean;
 }
 
+    /**
+ * Settings for code features
+ */
+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
  */
@@ -8206,6 +8285,13 @@ interface CustomizeDefinition extends DefinitionBase<DefinitionType.Customize |
  */
 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
+ */
+type CoreCreator<TEditorCore extends EditorCore, TEditorOptions extends EditorOptions> = (contentDiv: HTMLDivElement, options: TEditorOptions) => TEditorCore;
+
     /**
  * Experimental feature flags
  */
@@ -8488,7 +8574,12 @@ 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"
 }
 
     /**
@@ -9716,7 +9807,7 @@ 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
      */