roosterjs-content-model-types 0.19.0 → 0.21.0

package/lib/editor/IStandaloneEditor.d.ts

@@ -0,0 +1,99 @@
+import type { CompatiblePluginEventType } from 'roosterjs-editor-types/lib/compatibleTypes';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
+import type { DOMSelection } from '../selection/DOMSelection';
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { EditorEnvironment } from '../parameter/EditorEnvironment';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+import type { OnNodeCreated } from '../context/ModelToDomSettings';
+import type { ContentModelFormatter, FormatWithContentModelOptions } from '../parameter/FormatWithContentModelOptions';
+import type { EditorUndoState, PluginEventData, PluginEventFromType, PluginEventType } from 'roosterjs-editor-types';
+/**
+ * An interface of standalone Content Model editor.
+ * (This interface is still under development, and may still be changed in the future with some breaking changes)
+ */
+export interface IStandaloneEditor {
+    /**
+     * Create Content Model from DOM tree in this editor
+     * @param rootNode Optional start node. If provided, Content Model will be created from this node (including itself),
+     * otherwise it will create Content Model for the whole content in editor.
+     * @param option The options to customize the behavior of DOM to Content Model conversion
+     * @param selectionOverride When specified, use this selection to override existing selection inside editor
+     */
+    createContentModel(option?: DomToModelOption, selectionOverride?: DOMSelection): ContentModelDocument;
+    /**
+     * Set content with content model
+     * @param model The content model to set
+     * @param option Additional options to customize the behavior of Content Model to DOM conversion
+     * @param onNodeCreated An optional callback that will be called when a DOM node is created
+     */
+    setContentModel(model: ContentModelDocument, option?: ModelToDomOption, onNodeCreated?: OnNodeCreated): DOMSelection | null;
+    /**
+     * Get current running environment, such as if editor is running on Mac
+     */
+    getEnvironment(): EditorEnvironment;
+    /**
+     * Get current DOM selection.
+     * This is the replacement of IEditor.getSelectionRangeEx.
+     */
+    getDOMSelection(): DOMSelection | null;
+    /**
+     * Set DOMSelection into editor content.
+     * This is the replacement of IEditor.select.
+     * @param selection The selection to set
+     */
+    setDOMSelection(selection: DOMSelection): void;
+    /**
+     * The general API to do format change with Content Model
+     * It will grab a Content Model for current editor content, and invoke a callback function
+     * to do format change. Then according to the return value, write back the modified content model into editor.
+     * If there is cached model, it will be used and updated.
+     * @param formatter Formatter function, see ContentModelFormatter
+     * @param options More options, see FormatWithContentModelOptions
+     */
+    formatContentModel(formatter: ContentModelFormatter, options?: FormatWithContentModelOptions): void;
+    /**
+     * Get pending format of editor if any, or return null
+     */
+    getPendingFormat(): ContentModelSegmentFormat | null;
+    /**
+     * Get whether this editor is disposed
+     * @returns True if editor is disposed, otherwise false
+     */
+    isDisposed(): boolean;
+    /**
+     * Get document which contains this editor
+     * @returns The HTML document which contains this editor
+     */
+    getDocument(): Document;
+    /**
+     * Focus to this editor, the selection was restored to where it was before, no unexpected scroll.
+     */
+    focus(): void;
+    /**
+     * Trigger an event to be dispatched to all plugins
+     * @param eventType Type of the event
+     * @param data data of the event with given type, this is the rest part of PluginEvent with the given type
+     * @param broadcast indicates if the event needs to be dispatched to all plugins
+     * True means to all, false means to allow exclusive handling from one plugin unless no one wants that
+     * @returns the event object which is really passed into plugins. Some plugin may modify the event object so
+     * the result of this function provides a chance to read the modified result
+     */
+    triggerPluginEvent<T extends PluginEventType | CompatiblePluginEventType>(eventType: T, data: PluginEventData<T>, broadcast?: boolean): PluginEventFromType<T>;
+    /**
+     * Whether there is an available undo/redo snapshot
+     */
+    getUndoState(): EditorUndoState;
+    /**
+     * Check if the editor is in dark mode
+     * @returns True if the editor is in dark mode, otherwise false
+     */
+    isDarkMode(): boolean;
+    /**
+     * Get current zoom scale, default value is 1
+     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
+     * to let editor behave correctly especially for those mouse drag/drop behaviors
+     * @returns current zoom scale number
+     */
+    getZoomScale(): number;
+}

package/lib/editor/IStandaloneEditor.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IStandaloneEditor.js.map

package/lib/editor/IStandaloneEditor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStandaloneEditor.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/IStandaloneEditor.ts"],"names":[],"mappings":"","sourcesContent":["import type { CompatiblePluginEventType } from 'roosterjs-editor-types/lib/compatibleTypes';\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\nimport type { DOMSelection } from '../selection/DOMSelection';\nimport type { DomToModelOption } from '../context/DomToModelOption';\nimport type { EditorEnvironment } from '../parameter/EditorEnvironment';\nimport type { ModelToDomOption } from '../context/ModelToDomOption';\nimport type { OnNodeCreated } from '../context/ModelToDomSettings';\nimport type {\n    ContentModelFormatter,\n    FormatWithContentModelOptions,\n} from '../parameter/FormatWithContentModelOptions';\nimport type {\n    EditorUndoState,\n    PluginEventData,\n    PluginEventFromType,\n    PluginEventType,\n} from 'roosterjs-editor-types';\n\n/**\n * An interface of standalone Content Model editor.\n * (This interface is still under development, and may still be changed in the future with some breaking changes)\n */\nexport interface IStandaloneEditor {\n    /**\n     * Create Content Model from DOM tree in this editor\n     * @param rootNode Optional start node. If provided, Content Model will be created from this node (including itself),\n     * otherwise it will create Content Model for the whole content in editor.\n     * @param option The options to customize the behavior of DOM to Content Model conversion\n     * @param selectionOverride When specified, use this selection to override existing selection inside editor\n     */\n    createContentModel(\n        option?: DomToModelOption,\n        selectionOverride?: DOMSelection\n    ): ContentModelDocument;\n\n    /**\n     * Set content with content model\n     * @param model The content model to set\n     * @param option Additional options to customize the behavior of Content Model to DOM conversion\n     * @param onNodeCreated An optional callback that will be called when a DOM node is created\n     */\n    setContentModel(\n        model: ContentModelDocument,\n        option?: ModelToDomOption,\n        onNodeCreated?: OnNodeCreated\n    ): DOMSelection | null;\n\n    /**\n     * Get current running environment, such as if editor is running on Mac\n     */\n    getEnvironment(): EditorEnvironment;\n\n    /**\n     * Get current DOM selection.\n     * This is the replacement of IEditor.getSelectionRangeEx.\n     */\n    getDOMSelection(): DOMSelection | null;\n\n    /**\n     * Set DOMSelection into editor content.\n     * This is the replacement of IEditor.select.\n     * @param selection The selection to set\n     */\n    setDOMSelection(selection: DOMSelection): void;\n\n    /**\n     * The general API to do format change with Content Model\n     * It will grab a Content Model for current editor content, and invoke a callback function\n     * to do format change. Then according to the return value, write back the modified content model into editor.\n     * If there is cached model, it will be used and updated.\n     * @param formatter Formatter function, see ContentModelFormatter\n     * @param options More options, see FormatWithContentModelOptions\n     */\n    formatContentModel(\n        formatter: ContentModelFormatter,\n        options?: FormatWithContentModelOptions\n    ): void;\n\n    /**\n     * Get pending format of editor if any, or return null\n     */\n    getPendingFormat(): ContentModelSegmentFormat | null;\n\n    //#region Editor API copied from legacy editor, will be ported to use Content Model instead\n\n    /**\n     * Get whether this editor is disposed\n     * @returns True if editor is disposed, otherwise false\n     */\n    isDisposed(): boolean;\n\n    /**\n     * Get document which contains this editor\n     * @returns The HTML document which contains this editor\n     */\n    getDocument(): Document;\n\n    /**\n     * Focus to this editor, the selection was restored to where it was before, no unexpected scroll.\n     */\n    focus(): void;\n\n    /**\n     * Trigger an event to be dispatched to all plugins\n     * @param eventType Type of the event\n     * @param data data of the event with given type, this is the rest part of PluginEvent with the given type\n     * @param broadcast indicates if the event needs to be dispatched to all plugins\n     * True means to all, false means to allow exclusive handling from one plugin unless no one wants that\n     * @returns the event object which is really passed into plugins. Some plugin may modify the event object so\n     * the result of this function provides a chance to read the modified result\n     */\n    triggerPluginEvent<T extends PluginEventType | CompatiblePluginEventType>(\n        eventType: T,\n        data: PluginEventData<T>,\n        broadcast?: boolean\n    ): PluginEventFromType<T>;\n\n    /**\n     * Whether there is an available undo/redo snapshot\n     */\n    getUndoState(): EditorUndoState;\n\n    /**\n     * Check if the editor is in dark mode\n     * @returns True if the editor is in dark mode, otherwise false\n     */\n    isDarkMode(): boolean;\n\n    /**\n     * Get current zoom scale, default value is 1\n     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale\n     * to let editor behave correctly especially for those mouse drag/drop behaviors\n     * @returns current zoom scale number\n     */\n    getZoomScale(): number;\n\n    //#endregion\n}\n"]}

package/lib/editor/StandaloneEditorCore.d.ts

@@ -0,0 +1,466 @@
+import type { CompatibleColorTransformDirection, CompatibleGetContentMode } from 'roosterjs-editor-types/lib/compatibleTypes';
+import type { ColorTransformDirection, ContentChangedData, ContentMetadata, DOMEventHandler, DarkColorHandler, EditorPlugin, GetContentMode, ImageSelectionRange, InsertOption, NodePosition, PluginEvent, PositionType, Rect, SelectionPath, SelectionRangeEx, StyleBasedFormatState, TableSelection, TableSelectionRange, TrustedHTMLHandler } from 'roosterjs-editor-types';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { StandaloneEditorCorePluginState, UnportedCorePluginState } from '../pluginState/StandaloneEditorPluginState';
+import type { DOMSelection } from '../selection/DOMSelection';
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { DomToModelSettings } from '../context/DomToModelSettings';
+import type { EditorContext } from '../context/EditorContext';
+import type { EditorEnvironment } from '../parameter/EditorEnvironment';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+import type { ModelToDomSettings, OnNodeCreated } from '../context/ModelToDomSettings';
+import type { ContentModelFormatter, FormatWithContentModelOptions } from '../parameter/FormatWithContentModelOptions';
+/**
+ * Create a EditorContext object used by ContentModel API
+ * @param core The StandaloneEditorCore object
+ */
+export declare type CreateEditorContext = (core: StandaloneEditorCore) => EditorContext;
+/**
+ * Create Content Model from DOM tree in this editor
+ * @param core The StandaloneEditorCore object
+ * @param option The option to customize the behavior of DOM to Content Model conversion
+ * @param selectionOverride When passed, use this selection range instead of current selection in editor
+ */
+export declare type CreateContentModel = (core: StandaloneEditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection) => ContentModelDocument;
+/**
+ * Get current DOM selection from editor
+ * @param core The StandaloneEditorCore object
+ */
+export declare type GetDOMSelection = (core: StandaloneEditorCore) => DOMSelection | null;
+/**
+ * Set content with content model. This is the replacement of core API getSelectionRangeEx
+ * @param core The StandaloneEditorCore object
+ * @param model The content model to set
+ * @param option Additional options to customize the behavior of Content Model to DOM conversion
+ * @param onNodeCreated An optional callback that will be called when a DOM node is created
+ */
+export declare type SetContentModel = (core: StandaloneEditorCore, model: ContentModelDocument, option?: ModelToDomOption, onNodeCreated?: OnNodeCreated) => DOMSelection | null;
+/**
+ * Set current DOM selection from editor. This is the replacement of core API select
+ * @param core The StandaloneEditorCore object
+ * @param selection The selection to set
+ */
+export declare type SetDOMSelection = (core: StandaloneEditorCore, selection: DOMSelection) => void;
+/**
+ * The general API to do format change with Content Model
+ * It will grab a Content Model for current editor content, and invoke a callback function
+ * to do format change. Then according to the return value, write back the modified content model into editor.
+ * If there is cached model, it will be used and updated.
+ * @param core The StandaloneEditorCore object
+ * @param formatter Formatter function, see ContentModelFormatter
+ * @param options More options, see FormatWithContentModelOptions
+ */
+export declare type FormatContentModel = (core: StandaloneEditorCore, formatter: ContentModelFormatter, options?: FormatWithContentModelOptions) => void;
+/**
+ * Switch the Shadow Edit mode of editor On/Off
+ * @param core The StandaloneEditorCore object
+ * @param isOn True to switch On, False to switch Off
+ */
+export declare type SwitchShadowEdit = (core: StandaloneEditorCore, isOn: boolean) => void;
+/**
+ * TODO: Remove this Core API and use setDOMSelection instead
+ * 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, or null
+ * @param arg3 (optional) A Node
+ * @param arg4 (optional) An offset number, or a PositionType
+ */
+export declare type Select = (core: StandaloneEditorCore, arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection | null, arg3?: Node, arg4?: number | PositionType) => boolean;
+/**
+ * Trigger a plugin event
+ * @param core The StandaloneEditorCore object
+ * @param pluginEvent The event object to trigger
+ * @param broadcast Set to true to skip the shouldHandleEventExclusively check
+ */
+export declare type TriggerEvent = (core: StandaloneEditorCore, pluginEvent: PluginEvent, broadcast: boolean) => void;
+/**
+ * Get current selection range
+ * @param core The StandaloneEditorCore object
+ * @returns A Range object of the selection range
+ */
+export declare type GetSelectionRangeEx = (core: StandaloneEditorCore) => SelectionRangeEx;
+/**
+ * Edit and transform color of elements between light mode and dark mode
+ * @param core The StandaloneEditorCore object
+ * @param rootNode The root HTML node to transform
+ * @param includeSelf True to transform the root node as well, otherwise false
+ * @param callback The callback function to invoke before do color transformation
+ * @param direction To specify the transform direction, light to dark, or dark to light
+ * @param forceTransform By default this function will only work when editor core is in dark mode.
+ * Pass true to this value to force do color transformation even editor core is in light mode
+ * @param fromDarkModel Whether the given content is already in dark mode
+ */
+export declare type TransformColor = (core: StandaloneEditorCore, rootNode: Node | null, includeSelf: boolean, callback: (() => void) | null, direction: ColorTransformDirection | CompatibleColorTransformDirection, forceTransform?: boolean, fromDarkMode?: boolean) => void;
+/**
+ * Call an editing callback with adding undo snapshots around, and trigger a ContentChanged event if change source is specified.
+ * Undo snapshot will not be added if this call is nested inside another addUndoSnapshot() call.
+ * @param core The StandaloneEditorCore object
+ * @param callback The editing callback, accepting current selection start and end position, returns an optional object used as the data field of ContentChangedEvent.
+ * @param changeSource The ChangeSource string of ContentChangedEvent. @default ChangeSource.Format. Set to null to avoid triggering ContentChangedEvent
+ * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).
+ * @param additionalData Optional parameter to provide additional data related to the ContentChanged Event.
+ */
+export declare type AddUndoSnapshot = (core: StandaloneEditorCore, callback: ((start: NodePosition | null, end: NodePosition | null) => any) | null, changeSource: string | null, canUndoByBackspace: boolean, additionalData?: ContentChangedData) => void;
+/**
+ * Retrieves the rect of the visible viewport of the editor.
+ * @param core The StandaloneEditorCore object
+ */
+export declare type GetVisibleViewport = (core: StandaloneEditorCore) => Rect | null;
+/**
+ * Change the editor selection to the given range
+ * @param core The StandaloneEditorCore object
+ * @param range The range to select
+ * @param skipSameRange When set to true, do nothing if the given range is the same with current selection
+ * in editor, otherwise it will always remove current selection range and set to the given one.
+ * This parameter is always treated as true in Edge to avoid some weird runtime exception.
+ */
+export declare type SelectRange = (core: StandaloneEditorCore, range: Range, skipSameRange?: boolean) => boolean;
+/**
+ * Select a table and save data of the selected range
+ * @param core The StandaloneEditorCore object
+ * @param image image to select
+ * @returns true if successful
+ */
+export declare type SelectImage = (core: StandaloneEditorCore, image: HTMLImageElement | null) => ImageSelectionRange | null;
+/**
+ * Select a table and save data of the selected range
+ * @param core The StandaloneEditorCore object
+ * @param table table to select
+ * @param coordinates first and last cell of the selection, if this parameter is null, instead of
+ * selecting, will unselect the table.
+ * @returns true if successful
+ */
+export declare type SelectTable = (core: StandaloneEditorCore, table: HTMLTableElement | null, coordinates?: TableSelection) => TableSelectionRange | null;
+/**
+ * Set HTML content to this editor. All existing content will be replaced. A ContentChanged event will be triggered
+ * if triggerContentChangedEvent is set to true
+ * @param core The StandaloneEditorCore object
+ * @param content HTML content to set in
+ * @param triggerContentChangedEvent True to trigger a ContentChanged event. Default value is true
+ */
+export declare type SetContent = (core: StandaloneEditorCore, content: string, triggerContentChangedEvent: boolean, metadata?: ContentMetadata) => void;
+/**
+ * Get current or cached selection range
+ * @param core The StandaloneEditorCore object
+ * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now
+ * @returns A Range object of the selection range
+ */
+export declare type GetSelectionRange = (core: StandaloneEditorCore, tryGetFromCache: boolean) => Range | null;
+/**
+ * Check if the editor has focus now
+ * @param core The StandaloneEditorCore object
+ * @returns True if the editor has focus, otherwise false
+ */
+export declare type HasFocus = (core: StandaloneEditorCore) => boolean;
+/**
+ * Focus to editor. If there is a cached selection range, use it as current selection
+ * @param core The StandaloneEditorCore object
+ */
+export declare type Focus = (core: StandaloneEditorCore) => void;
+/**
+ * Insert a DOM node into editor content
+ * @param core The StandaloneEditorCore object. No op if null.
+ * @param option An insert option object to specify how to insert the node
+ */
+export declare type InsertNode = (core: StandaloneEditorCore, node: Node, option: InsertOption | null) => boolean;
+/**
+ * Attach a DOM event to the editor content DIV
+ * @param core The StandaloneEditorCore object
+ * @param eventMap A map from event name to its handler
+ */
+export declare type AttachDomEvent = (core: StandaloneEditorCore, eventMap: Record<string, DOMEventHandler>) => () => void;
+/**
+ * Get current editor content as HTML string
+ * @param core The StandaloneEditorCore object
+ * @param mode specify what kind of HTML content to retrieve
+ * @returns HTML string representing current editor content
+ */
+export declare type GetContent = (core: StandaloneEditorCore, mode: GetContentMode | CompatibleGetContentMode) => string;
+/**
+ * Get style based format state from current selection, including font name/size and colors
+ * @param core The StandaloneEditorCore objects
+ * @param node The node to get style from
+ */
+export declare type GetStyleBasedFormatState = (core: StandaloneEditorCore, node: Node | null) => StyleBasedFormatState;
+/**
+ * Restore an undo snapshot into editor
+ * @param core The StandaloneEditorCore object
+ * @param step Steps to move, can be 0, positive or negative
+ */
+export declare type RestoreUndoSnapshot = (core: StandaloneEditorCore, step: number) => void;
+/**
+ * Ensure user will type into a container element rather than into the editor content DIV directly
+ * @param core The StandaloneEditorCore object.
+ * @param position The position that user is about to type to
+ * @param keyboardEvent Optional keyboard event object
+ * @param deprecated Deprecated parameter, not used
+ */
+export declare type EnsureTypeInContainer = (core: StandaloneEditorCore, position: NodePosition, keyboardEvent?: KeyboardEvent, deprecated?: boolean) => void;
+/**
+ * Temp interface
+ * TODO: Port other core API
+ */
+export interface PortedCoreApiMap {
+    /**
+     * Create a EditorContext object used by ContentModel API
+     * @param core The StandaloneEditorCore object
+     */
+    createEditorContext: CreateEditorContext;
+    /**
+     * Create Content Model from DOM tree in this editor
+     * @param core The StandaloneEditorCore object
+     * @param option The option to customize the behavior of DOM to Content Model conversion
+     */
+    createContentModel: CreateContentModel;
+    /**
+     * Get current DOM selection from editor
+     * @param core The StandaloneEditorCore object
+     */
+    getDOMSelection: GetDOMSelection;
+    /**
+     * Set content with content model
+     * @param core The StandaloneEditorCore object
+     * @param model The content model to set
+     * @param option Additional options to customize the behavior of Content Model to DOM conversion
+     */
+    setContentModel: SetContentModel;
+    /**
+     * Set current DOM selection from editor. This is the replacement of core API select
+     * @param core The StandaloneEditorCore object
+     * @param selection The selection to set
+     */
+    setDOMSelection: SetDOMSelection;
+    /**
+     * The general API to do format change with Content Model
+     * It will grab a Content Model for current editor content, and invoke a callback function
+     * to do format change. Then according to the return value, write back the modified content model into editor.
+     * If there is cached model, it will be used and updated.
+     * @param core The StandaloneEditorCore object
+     * @param formatter Formatter function, see ContentModelFormatter
+     * @param options More options, see FormatWithContentModelOptions
+     */
+    formatContentModel: FormatContentModel;
+    /**
+     * Switch the Shadow Edit mode of editor On/Off
+     * @param core The StandaloneEditorCore object
+     * @param isOn True to switch On, False to switch Off
+     */
+    switchShadowEdit: SwitchShadowEdit;
+    /**
+     * Retrieves the rect of the visible viewport of the editor.
+     * @param core The StandaloneEditorCore object
+     */
+    getVisibleViewport: GetVisibleViewport;
+}
+/**
+ * Temp interface
+ * TODO: Port these core API
+ */
+export interface UnportedCoreApiMap {
+    /**
+     * 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, or null
+     * @param arg3 (optional) A Node
+     * @param arg4 (optional) An offset number, or a PositionType
+     */
+    select: Select;
+    /**
+     * Trigger a plugin event
+     * @param core The StandaloneEditorCore object
+     * @param pluginEvent The event object to trigger
+     * @param broadcast Set to true to skip the shouldHandleEventExclusively check
+     */
+    triggerEvent: TriggerEvent;
+    /**
+     * Get current or cached selection range
+     * @param core The StandaloneEditorCore object
+     * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now
+     * @returns A Range object of the selection range
+     */
+    getSelectionRangeEx: GetSelectionRangeEx;
+    /**
+     * Edit and transform color of elements between light mode and dark mode
+     * @param core The StandaloneEditorCore object
+     * @param rootNode The root HTML element to transform
+     * @param includeSelf True to transform the root node as well, otherwise false
+     * @param callback The callback function to invoke before do color transformation
+     * @param direction To specify the transform direction, light to dark, or dark to light
+     * @param forceTransform By default this function will only work when editor core is in dark mode.
+     * Pass true to this value to force do color transformation even editor core is in light mode
+     * @param fromDarkModel Whether the given content is already in dark mode
+     */
+    transformColor: TransformColor;
+    /**
+     * Call an editing callback with adding undo snapshots around, and trigger a ContentChanged event if change source is specified.
+     * Undo snapshot will not be added if this call is nested inside another addUndoSnapshot() call.
+     * @param core The StandaloneEditorCore object
+     * @param callback The editing callback, accepting current selection start and end position, returns an optional object used as the data field of ContentChangedEvent.
+     * @param changeSource The ChangeSource string of ContentChangedEvent. @default ChangeSource.Format. Set to null to avoid triggering ContentChangedEvent
+     * @param canUndoByBackspace True if this action can be undone when user presses Backspace key (aka Auto Complete).
+     */
+    addUndoSnapshot: AddUndoSnapshot;
+    /**
+     * Change the editor selection to the given range
+     * @param core The StandaloneEditorCore object
+     * @param range The range to select
+     * @param skipSameRange When set to true, do nothing if the given range is the same with current selection
+     * in editor, otherwise it will always remove current selection range and set to the given one.
+     * This parameter is always treated as true in Edge to avoid some weird runtime exception.
+     */
+    selectRange: SelectRange;
+    /**
+     * Select a image and save data of the selected range
+     * @param core The StandaloneEditorCore object
+     * @param image image to select
+     * @param imageId the id of the image element
+     * @returns true if successful
+     */
+    selectImage: SelectImage;
+    /**
+     * Select a table and save data of the selected range
+     * @param core The StandaloneEditorCore object
+     * @param table table to select
+     * @param coordinates first and last cell of the selection, if this parameter is null, instead of
+     * selecting, will unselect the table.
+     * @param shouldAddStyles Whether need to update the style elements
+     * @returns true if successful
+     */
+    selectTable: SelectTable;
+    /**
+     * Set HTML content to this editor. All existing content will be replaced. A ContentChanged event will be triggered
+     * if triggerContentChangedEvent is set to true
+     * @param core The StandaloneEditorCore object
+     * @param content HTML content to set in
+     * @param triggerContentChangedEvent True to trigger a ContentChanged event. Default value is true
+     */
+    setContent: SetContent;
+    /**
+     * Get current or cached selection range
+     * @param core The StandaloneEditorCore object
+     * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now
+     * @returns A Range object of the selection range
+     */
+    getSelectionRange: GetSelectionRange;
+    /**
+     * Check if the editor has focus now
+     * @param core The StandaloneEditorCore object
+     * @returns True if the editor has focus, otherwise false
+     */
+    hasFocus: HasFocus;
+    /**
+     * Focus to editor. If there is a cached selection range, use it as current selection
+     * @param core The StandaloneEditorCore object
+     */
+    focus: Focus;
+    /**
+     * Insert a DOM node into editor content
+     * @param core The StandaloneEditorCore object. No op if null.
+     * @param option An insert option object to specify how to insert the node
+     */
+    insertNode: InsertNode;
+    /**
+     * Attach a DOM event to the editor content DIV
+     * @param core The StandaloneEditorCore object
+     * @param eventName The DOM event name
+     * @param pluginEventType Optional event type. When specified, editor will trigger a plugin event with this name when the DOM event is triggered
+     * @param beforeDispatch Optional callback function to be invoked when the DOM event is triggered before trigger plugin event
+     */
+    attachDomEvent: AttachDomEvent;
+    /**
+     * Get current editor content as HTML string
+     * @param core The StandaloneEditorCore object
+     * @param mode specify what kind of HTML content to retrieve
+     * @returns HTML string representing current editor content
+     */
+    getContent: GetContent;
+    /**
+     * Get style based format state from current selection, including font name/size and colors
+     * @param core The StandaloneEditorCore objects
+     * @param node The node to get style from
+     */
+    getStyleBasedFormatState: GetStyleBasedFormatState;
+    /**
+     * Restore an undo snapshot into editor
+     * @param core The editor core object
+     * @param step Steps to move, can be 0, positive or negative
+     */
+    restoreUndoSnapshot: RestoreUndoSnapshot;
+    /**
+     * Ensure user will type into a container element rather than into the editor content DIV directly
+     * @param core The EditorCore object.
+     * @param position The position that user is about to type to
+     * @param keyboardEvent Optional keyboard event object
+     * @param deprecated Deprecated parameter, not used
+     */
+    ensureTypeInContainer: EnsureTypeInContainer;
+}
+/**
+ * The interface for the map of core API for Content Model editor.
+ * Editor can call call API from this map under StandaloneEditorCore object
+ */
+export interface StandaloneCoreApiMap extends PortedCoreApiMap, UnportedCoreApiMap {
+}
+/**
+ * Represents the core data structure of a Content Model editor
+ */
+export interface StandaloneEditorCore extends StandaloneEditorCorePluginState, UnportedCorePluginState, StandaloneEditorDefaultSettings {
+    /**
+     * The content DIV element of this editor
+     */
+    readonly contentDiv: HTMLDivElement;
+    /**
+     * Core API map of this editor
+     */
+    readonly api: StandaloneCoreApiMap;
+    /**
+     * Original API map of this editor. Overridden core API can use API from this map to call the original version of core API.
+     */
+    readonly originalApi: StandaloneCoreApiMap;
+    /**
+     * An array of editor plugins.
+     */
+    readonly plugins: EditorPlugin[];
+    /**
+     * Editor running environment
+     */
+    readonly environment: EditorEnvironment;
+    /**
+     * Dark model handler for the editor, used for variable-based solution.
+     * If keep it null, editor will still use original dataset-based dark mode solution.
+     */
+    readonly darkColorHandler: DarkColorHandler;
+    /**
+     * A handler to convert HTML string to a trust HTML string.
+     * By default it will just return the original HTML string directly.
+     * To override, pass your own trusted HTML handler to EditorOptions.trustedHTMLHandler
+     */
+    readonly trustedHTMLHandler: TrustedHTMLHandler;
+}
+/**
+ * Default DOM and Content Model conversion settings for an editor
+ */
+export interface StandaloneEditorDefaultSettings {
+    /**
+     * Default DOM to Content Model options
+     */
+    defaultDomToModelOptions: (DomToModelOption | undefined)[];
+    /**
+     * Default Content Model to DOM options
+     */
+    defaultModelToDomOptions: (ModelToDomOption | undefined)[];
+    /**
+     * Default DOM to Content Model config, calculated from defaultDomToModelOptions,
+     * will be used for creating content model if there is no other customized options
+     */
+    defaultDomToModelConfig: DomToModelSettings;
+    /**
+     * Default Content Model to DOM config, calculated from defaultModelToDomOptions,
+     * will be used for setting content model if there is no other customized options
+     */
+    defaultModelToDomConfig: ModelToDomSettings;
+}

package/lib/editor/StandaloneEditorCore.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=StandaloneEditorCore.js.map

package/lib/editor/StandaloneEditorCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StandaloneEditorCore.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/StandaloneEditorCore.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n    CompatibleColorTransformDirection,\n    CompatibleGetContentMode,\n} from 'roosterjs-editor-types/lib/compatibleTypes';\nimport type {\n    ColorTransformDirection,\n    ContentChangedData,\n    ContentMetadata,\n    DOMEventHandler,\n    DarkColorHandler,\n    EditorPlugin,\n    GetContentMode,\n    ImageSelectionRange,\n    InsertOption,\n    NodePosition,\n    PluginEvent,\n    PositionType,\n    Rect,\n    SelectionPath,\n    SelectionRangeEx,\n    StyleBasedFormatState,\n    TableSelection,\n    TableSelectionRange,\n    TrustedHTMLHandler,\n} from 'roosterjs-editor-types';\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\nimport type {\n    StandaloneEditorCorePluginState,\n    UnportedCorePluginState,\n} from '../pluginState/StandaloneEditorPluginState';\nimport type { DOMSelection } from '../selection/DOMSelection';\nimport type { DomToModelOption } from '../context/DomToModelOption';\nimport type { DomToModelSettings } from '../context/DomToModelSettings';\nimport type { EditorContext } from '../context/EditorContext';\nimport type { EditorEnvironment } from '../parameter/EditorEnvironment';\nimport type { ModelToDomOption } from '../context/ModelToDomOption';\nimport type { ModelToDomSettings, OnNodeCreated } from '../context/ModelToDomSettings';\nimport type {\n    ContentModelFormatter,\n    FormatWithContentModelOptions,\n} from '../parameter/FormatWithContentModelOptions';\n\n/**\n * Create a EditorContext object used by ContentModel API\n * @param core The StandaloneEditorCore object\n */\nexport type CreateEditorContext = (core: StandaloneEditorCore) => EditorContext;\n\n/**\n * Create Content Model from DOM tree in this editor\n * @param core The StandaloneEditorCore object\n * @param option The option to customize the behavior of DOM to Content Model conversion\n * @param selectionOverride When passed, use this selection range instead of current selection in editor\n */\nexport type CreateContentModel = (\n    core: StandaloneEditorCore,\n    option?: DomToModelOption,\n    selectionOverride?: DOMSelection\n) => ContentModelDocument;\n\n/**\n * Get current DOM selection from editor\n * @param core The StandaloneEditorCore object\n */\nexport type GetDOMSelection = (core: StandaloneEditorCore) => DOMSelection | null;\n\n/**\n * Set content with content model. This is the replacement of core API getSelectionRangeEx\n * @param core The StandaloneEditorCore object\n * @param model The content model to set\n * @param option Additional options to customize the behavior of Content Model to DOM conversion\n * @param onNodeCreated An optional callback that will be called when a DOM node is created\n */\nexport type SetContentModel = (\n    core: StandaloneEditorCore,\n    model: ContentModelDocument,\n    option?: ModelToDomOption,\n    onNodeCreated?: OnNodeCreated\n) => DOMSelection | null;\n\n/**\n * Set current DOM selection from editor. This is the replacement of core API select\n * @param core The StandaloneEditorCore object\n * @param selection The selection to set\n */\nexport type SetDOMSelection = (core: StandaloneEditorCore, selection: DOMSelection) => void;\n\n/**\n * The general API to do format change with Content Model\n * It will grab a Content Model for current editor content, and invoke a callback function\n * to do format change. Then according to the return value, write back the modified content model into editor.\n * If there is cached model, it will be used and updated.\n * @param core The StandaloneEditorCore object\n * @param formatter Formatter function, see ContentModelFormatter\n * @param options More options, see FormatWithContentModelOptions\n */\nexport type FormatContentModel = (\n    core: StandaloneEditorCore,\n    formatter: ContentModelFormatter,\n    options?: FormatWithContentModelOptions\n) => void;\n\n/**\n * Switch the Shadow Edit mode of editor On/Off\n * @param core The StandaloneEditorCore object\n * @param isOn True to switch On, False to switch Off\n */\nexport type SwitchShadowEdit = (core: StandaloneEditorCore, isOn: boolean) => void;\n\n/**\n * TODO: Remove this Core API and use setDOMSelection instead\n * Select content according to the given information.\n * There are a bunch of allowed combination of parameters. See IEditor.select for more details\n * @param core The editor core object\n * @param arg1 A DOM Range, or SelectionRangeEx, or NodePosition, or Node, or Selection Path\n * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection, or null\n * @param arg3 (optional) A Node\n * @param arg4 (optional) An offset number, or a PositionType\n */\nexport type Select = (\n    core: StandaloneEditorCore,\n    arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null,\n    arg2?: NodePosition | number | PositionType | TableSelection | null,\n    arg3?: Node,\n    arg4?: number | PositionType\n) => boolean;\n\n/**\n * Trigger a plugin event\n * @param core The StandaloneEditorCore object\n * @param pluginEvent The event object to trigger\n * @param broadcast Set to true to skip the shouldHandleEventExclusively check\n */\nexport type TriggerEvent = (\n    core: StandaloneEditorCore,\n    pluginEvent: PluginEvent,\n    broadcast: boolean\n) => void;\n\n/**\n * Get current selection range\n * @param core The StandaloneEditorCore object\n * @returns A Range object of the selection range\n */\nexport type GetSelectionRangeEx = (core: StandaloneEditorCore) => SelectionRangeEx;\n\n/**\n * Edit and transform color of elements between light mode and dark mode\n * @param core The StandaloneEditorCore object\n * @param rootNode The root HTML node to transform\n * @param includeSelf True to transform the root node as well, otherwise false\n * @param callback The callback function to invoke before do color transformation\n * @param direction To specify the transform direction, light to dark, or dark to light\n * @param forceTransform By default this function will only work when editor core is in dark mode.\n * Pass true to this value to force do color transformation even editor core is in light mode\n * @param fromDarkModel Whether the given content is already in dark mode\n */\nexport type TransformColor = (\n    core: StandaloneEditorCore,\n    rootNode: Node | null,\n    includeSelf: boolean,\n    callback: (() => void) | null,\n    direction: ColorTransformDirection | CompatibleColorTransformDirection,\n    forceTransform?: boolean,\n    fromDarkMode?: boolean\n) => void;\n\n/**\n * Call an editing callback with adding undo snapshots around, and trigger a ContentChanged event if change source is specified.\n * Undo snapshot will not be added if this call is nested inside another addUndoSnapshot() call.\n * @param core The StandaloneEditorCore object\n * @param callback The editing callback, accepting current selection start and end position, returns an optional object used as the data field of ContentChangedEvent.\n * @param changeSource The ChangeSource string of ContentChangedEvent. @default ChangeSource.Format. Set to null to avoid triggering ContentChangedEvent\n * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\n * @param additionalData Optional parameter to provide additional data related to the ContentChanged Event.\n */\nexport type AddUndoSnapshot = (\n    core: StandaloneEditorCore,\n    callback: ((start: NodePosition | null, end: NodePosition | null) => any) | null,\n    changeSource: string | null,\n    canUndoByBackspace: boolean,\n    additionalData?: ContentChangedData\n) => void;\n\n/**\n * Retrieves the rect of the visible viewport of the editor.\n * @param core The StandaloneEditorCore object\n */\nexport type GetVisibleViewport = (core: StandaloneEditorCore) => Rect | null;\n\n/**\n * Change the editor selection to the given range\n * @param core The StandaloneEditorCore object\n * @param range The range to select\n * @param skipSameRange When set to true, do nothing if the given range is the same with current selection\n * in editor, otherwise it will always remove current selection range and set to the given one.\n * This parameter is always treated as true in Edge to avoid some weird runtime exception.\n */\nexport type SelectRange = (\n    core: StandaloneEditorCore,\n    range: Range,\n    skipSameRange?: boolean\n) => boolean;\n\n/**\n * Select a table and save data of the selected range\n * @param core The StandaloneEditorCore object\n * @param image image to select\n * @returns true if successful\n */\nexport type SelectImage = (\n    core: StandaloneEditorCore,\n    image: HTMLImageElement | null\n) => ImageSelectionRange | null;\n\n/**\n * Select a table and save data of the selected range\n * @param core The StandaloneEditorCore object\n * @param table table to select\n * @param coordinates first and last cell of the selection, if this parameter is null, instead of\n * selecting, will unselect the table.\n * @returns true if successful\n */\nexport type SelectTable = (\n    core: StandaloneEditorCore,\n    table: HTMLTableElement | null,\n    coordinates?: TableSelection\n) => TableSelectionRange | null;\n\n/**\n * Set HTML content to this editor. All existing content will be replaced. A ContentChanged event will be triggered\n * if triggerContentChangedEvent is set to true\n * @param core The StandaloneEditorCore object\n * @param content HTML content to set in\n * @param triggerContentChangedEvent True to trigger a ContentChanged event. Default value is true\n */\nexport type SetContent = (\n    core: StandaloneEditorCore,\n    content: string,\n    triggerContentChangedEvent: boolean,\n    metadata?: ContentMetadata\n) => void;\n\n/**\n * Get current or cached selection range\n * @param core The StandaloneEditorCore object\n * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now\n * @returns A Range object of the selection range\n */\nexport type GetSelectionRange = (\n    core: StandaloneEditorCore,\n    tryGetFromCache: boolean\n) => Range | null;\n\n/**\n * Check if the editor has focus now\n * @param core The StandaloneEditorCore object\n * @returns True if the editor has focus, otherwise false\n */\nexport type HasFocus = (core: StandaloneEditorCore) => boolean;\n\n/**\n * Focus to editor. If there is a cached selection range, use it as current selection\n * @param core The StandaloneEditorCore object\n */\nexport type Focus = (core: StandaloneEditorCore) => void;\n\n/**\n * Insert a DOM node into editor content\n * @param core The StandaloneEditorCore object. No op if null.\n * @param option An insert option object to specify how to insert the node\n */\nexport type InsertNode = (\n    core: StandaloneEditorCore,\n    node: Node,\n    option: InsertOption | null\n) => boolean;\n\n/**\n * Attach a DOM event to the editor content DIV\n * @param core The StandaloneEditorCore object\n * @param eventMap A map from event name to its handler\n */\nexport type AttachDomEvent = (\n    core: StandaloneEditorCore,\n    eventMap: Record<string, DOMEventHandler>\n) => () => void;\n\n/**\n * Get current editor content as HTML string\n * @param core The StandaloneEditorCore object\n * @param mode specify what kind of HTML content to retrieve\n * @returns HTML string representing current editor content\n */\nexport type GetContent = (\n    core: StandaloneEditorCore,\n    mode: GetContentMode | CompatibleGetContentMode\n) => string;\n\n/**\n * Get style based format state from current selection, including font name/size and colors\n * @param core The StandaloneEditorCore objects\n * @param node The node to get style from\n */\nexport type GetStyleBasedFormatState = (\n    core: StandaloneEditorCore,\n    node: Node | null\n) => StyleBasedFormatState;\n\n/**\n * Restore an undo snapshot into editor\n * @param core The StandaloneEditorCore object\n * @param step Steps to move, can be 0, positive or negative\n */\nexport type RestoreUndoSnapshot = (core: StandaloneEditorCore, step: number) => void;\n\n/**\n * Ensure user will type into a container element rather than into the editor content DIV directly\n * @param core The StandaloneEditorCore object.\n * @param position The position that user is about to type to\n * @param keyboardEvent Optional keyboard event object\n * @param deprecated Deprecated parameter, not used\n */\nexport type EnsureTypeInContainer = (\n    core: StandaloneEditorCore,\n    position: NodePosition,\n    keyboardEvent?: KeyboardEvent,\n    deprecated?: boolean\n) => void;\n\n/**\n * Temp interface\n * TODO: Port other core API\n */\nexport interface PortedCoreApiMap {\n    /**\n     * Create a EditorContext object used by ContentModel API\n     * @param core The StandaloneEditorCore object\n     */\n    createEditorContext: CreateEditorContext;\n\n    /**\n     * Create Content Model from DOM tree in this editor\n     * @param core The StandaloneEditorCore object\n     * @param option The option to customize the behavior of DOM to Content Model conversion\n     */\n    createContentModel: CreateContentModel;\n\n    /**\n     * Get current DOM selection from editor\n     * @param core The StandaloneEditorCore object\n     */\n    getDOMSelection: GetDOMSelection;\n\n    /**\n     * Set content with content model\n     * @param core The StandaloneEditorCore object\n     * @param model The content model to set\n     * @param option Additional options to customize the behavior of Content Model to DOM conversion\n     */\n    setContentModel: SetContentModel;\n\n    /**\n     * Set current DOM selection from editor. This is the replacement of core API select\n     * @param core The StandaloneEditorCore object\n     * @param selection The selection to set\n     */\n    setDOMSelection: SetDOMSelection;\n\n    /**\n     * The general API to do format change with Content Model\n     * It will grab a Content Model for current editor content, and invoke a callback function\n     * to do format change. Then according to the return value, write back the modified content model into editor.\n     * If there is cached model, it will be used and updated.\n     * @param core The StandaloneEditorCore object\n     * @param formatter Formatter function, see ContentModelFormatter\n     * @param options More options, see FormatWithContentModelOptions\n     */\n    formatContentModel: FormatContentModel;\n\n    /**\n     * Switch the Shadow Edit mode of editor On/Off\n     * @param core The StandaloneEditorCore object\n     * @param isOn True to switch On, False to switch Off\n     */\n    switchShadowEdit: SwitchShadowEdit;\n\n    /**\n     * Retrieves the rect of the visible viewport of the editor.\n     * @param core The StandaloneEditorCore object\n     */\n    getVisibleViewport: GetVisibleViewport;\n}\n\n/**\n * Temp interface\n * TODO: Port these core API\n */\nexport interface UnportedCoreApiMap {\n    /**\n     * Select content according to the given information.\n     * There are a bunch of allowed combination of parameters. See IEditor.select for more details\n     * @param core The editor core object\n     * @param arg1 A DOM Range, or SelectionRangeEx, or NodePosition, or Node, or Selection Path\n     * @param arg2 (optional) A NodePosition, or an offset number, or a PositionType, or a TableSelection, or null\n     * @param arg3 (optional) A Node\n     * @param arg4 (optional) An offset number, or a PositionType\n     */\n    select: Select;\n\n    /**\n     * Trigger a plugin event\n     * @param core The StandaloneEditorCore object\n     * @param pluginEvent The event object to trigger\n     * @param broadcast Set to true to skip the shouldHandleEventExclusively check\n     */\n    triggerEvent: TriggerEvent;\n\n    /**\n     * Get current or cached selection range\n     * @param core The StandaloneEditorCore object\n     * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now\n     * @returns A Range object of the selection range\n     */\n    getSelectionRangeEx: GetSelectionRangeEx;\n\n    /**\n     * Edit and transform color of elements between light mode and dark mode\n     * @param core The StandaloneEditorCore object\n     * @param rootNode The root HTML element to transform\n     * @param includeSelf True to transform the root node as well, otherwise false\n     * @param callback The callback function to invoke before do color transformation\n     * @param direction To specify the transform direction, light to dark, or dark to light\n     * @param forceTransform By default this function will only work when editor core is in dark mode.\n     * Pass true to this value to force do color transformation even editor core is in light mode\n     * @param fromDarkModel Whether the given content is already in dark mode\n     */\n    transformColor: TransformColor;\n\n    /**\n     * Call an editing callback with adding undo snapshots around, and trigger a ContentChanged event if change source is specified.\n     * Undo snapshot will not be added if this call is nested inside another addUndoSnapshot() call.\n     * @param core The StandaloneEditorCore object\n     * @param callback The editing callback, accepting current selection start and end position, returns an optional object used as the data field of ContentChangedEvent.\n     * @param changeSource The ChangeSource string of ContentChangedEvent. @default ChangeSource.Format. Set to null to avoid triggering ContentChangedEvent\n     * @param canUndoByBackspace True if this action can be undone when user presses Backspace key (aka Auto Complete).\n     */\n    addUndoSnapshot: AddUndoSnapshot;\n\n    /**\n     * Change the editor selection to the given range\n     * @param core The StandaloneEditorCore object\n     * @param range The range to select\n     * @param skipSameRange When set to true, do nothing if the given range is the same with current selection\n     * in editor, otherwise it will always remove current selection range and set to the given one.\n     * This parameter is always treated as true in Edge to avoid some weird runtime exception.\n     */\n    selectRange: SelectRange;\n\n    /**\n     * Select a image and save data of the selected range\n     * @param core The StandaloneEditorCore object\n     * @param image image to select\n     * @param imageId the id of the image element\n     * @returns true if successful\n     */\n    selectImage: SelectImage;\n\n    /**\n     * Select a table and save data of the selected range\n     * @param core The StandaloneEditorCore object\n     * @param table table to select\n     * @param coordinates first and last cell of the selection, if this parameter is null, instead of\n     * selecting, will unselect the table.\n     * @param shouldAddStyles Whether need to update the style elements\n     * @returns true if successful\n     */\n    selectTable: SelectTable;\n\n    /**\n     * Set HTML content to this editor. All existing content will be replaced. A ContentChanged event will be triggered\n     * if triggerContentChangedEvent is set to true\n     * @param core The StandaloneEditorCore object\n     * @param content HTML content to set in\n     * @param triggerContentChangedEvent True to trigger a ContentChanged event. Default value is true\n     */\n    setContent: SetContent;\n\n    /**\n     * Get current or cached selection range\n     * @param core The StandaloneEditorCore object\n     * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now\n     * @returns A Range object of the selection range\n     */\n    getSelectionRange: GetSelectionRange;\n\n    /**\n     * Check if the editor has focus now\n     * @param core The StandaloneEditorCore object\n     * @returns True if the editor has focus, otherwise false\n     */\n    hasFocus: HasFocus;\n\n    /**\n     * Focus to editor. If there is a cached selection range, use it as current selection\n     * @param core The StandaloneEditorCore object\n     */\n    focus: Focus;\n\n    /**\n     * Insert a DOM node into editor content\n     * @param core The StandaloneEditorCore object. No op if null.\n     * @param option An insert option object to specify how to insert the node\n     */\n    insertNode: InsertNode;\n\n    /**\n     * Attach a DOM event to the editor content DIV\n     * @param core The StandaloneEditorCore object\n     * @param eventName The DOM event name\n     * @param pluginEventType Optional event type. When specified, editor will trigger a plugin event with this name when the DOM event is triggered\n     * @param beforeDispatch Optional callback function to be invoked when the DOM event is triggered before trigger plugin event\n     */\n    attachDomEvent: AttachDomEvent;\n\n    /**\n     * Get current editor content as HTML string\n     * @param core The StandaloneEditorCore object\n     * @param mode specify what kind of HTML content to retrieve\n     * @returns HTML string representing current editor content\n     */\n    getContent: GetContent;\n\n    /**\n     * Get style based format state from current selection, including font name/size and colors\n     * @param core The StandaloneEditorCore objects\n     * @param node The node to get style from\n     */\n    getStyleBasedFormatState: GetStyleBasedFormatState;\n\n    /**\n     * Restore an undo snapshot into editor\n     * @param core The editor core object\n     * @param step Steps to move, can be 0, positive or negative\n     */\n    restoreUndoSnapshot: RestoreUndoSnapshot;\n\n    /**\n     * Ensure user will type into a container element rather than into the editor content DIV directly\n     * @param core The EditorCore object.\n     * @param position The position that user is about to type to\n     * @param keyboardEvent Optional keyboard event object\n     * @param deprecated Deprecated parameter, not used\n     */\n    ensureTypeInContainer: EnsureTypeInContainer;\n}\n\n/**\n * The interface for the map of core API for Content Model editor.\n * Editor can call call API from this map under StandaloneEditorCore object\n */\nexport interface StandaloneCoreApiMap extends PortedCoreApiMap, UnportedCoreApiMap {}\n\n/**\n * Represents the core data structure of a Content Model editor\n */\nexport interface StandaloneEditorCore\n    extends StandaloneEditorCorePluginState,\n        UnportedCorePluginState,\n        StandaloneEditorDefaultSettings {\n    /**\n     * The content DIV element of this editor\n     */\n    readonly contentDiv: HTMLDivElement;\n\n    /**\n     * Core API map of this editor\n     */\n    readonly api: StandaloneCoreApiMap;\n\n    /**\n     * Original API map of this editor. Overridden core API can use API from this map to call the original version of core API.\n     */\n    readonly originalApi: StandaloneCoreApiMap;\n\n    /**\n     * An array of editor plugins.\n     */\n    readonly plugins: EditorPlugin[];\n\n    /**\n     * Editor running environment\n     */\n    readonly environment: EditorEnvironment;\n\n    /**\n     * Dark model handler for the editor, used for variable-based solution.\n     * If keep it null, editor will still use original dataset-based dark mode solution.\n     */\n    readonly darkColorHandler: DarkColorHandler;\n\n    /**\n     * A handler to convert HTML string to a trust HTML string.\n     * By default it will just return the original HTML string directly.\n     * To override, pass your own trusted HTML handler to EditorOptions.trustedHTMLHandler\n     */\n    readonly trustedHTMLHandler: TrustedHTMLHandler;\n}\n\n/**\n * Default DOM and Content Model conversion settings for an editor\n */\nexport interface StandaloneEditorDefaultSettings {\n    /**\n     * Default DOM to Content Model options\n     */\n    defaultDomToModelOptions: (DomToModelOption | undefined)[];\n\n    /**\n     * Default Content Model to DOM options\n     */\n    defaultModelToDomOptions: (ModelToDomOption | undefined)[];\n\n    /**\n     * Default DOM to Content Model config, calculated from defaultDomToModelOptions,\n     * will be used for creating content model if there is no other customized options\n     */\n    defaultDomToModelConfig: DomToModelSettings;\n\n    /**\n     * Default Content Model to DOM config, calculated from defaultModelToDomOptions,\n     * will be used for setting content model if there is no other customized options\n     */\n    defaultModelToDomConfig: ModelToDomSettings;\n}\n"]}