roosterjs-content-model-types 0.0.3

package/lib/editor/EditorCore.d.ts

@@ -0,0 +1,304 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
+import type { PluginEvent } from '../event/PluginEvent';
+import type { PluginState } from '../pluginState/PluginState';
+import type { EditorPlugin } from './EditorPlugin';
+import type { ClipboardData } from '../parameter/ClipboardData';
+import type { PasteType } from '../enum/PasteType';
+import type { DOMEventRecord } from '../parameter/DOMEventRecord';
+import type { Snapshot } from '../parameter/Snapshot';
+import type { EntityState } from '../parameter/FormatContentModelContext';
+import type { DarkColorHandler } from '../context/DarkColorHandler';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+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 { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';
+import type { Rect } from '../parameter/Rect';
+import type { ContentModelFormatter, FormatContentModelOptions } from '../parameter/FormatContentModelOptions';
+/**
+ * Create a EditorContext object used by ContentModel API
+ * @param core The EditorCore object
+ * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
+ */
+export declare type CreateEditorContext = (core: EditorCore, saveIndex: boolean) => EditorContext;
+/**
+ * Create Content Model from DOM tree in this editor
+ * @param core The EditorCore 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: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection) => ContentModelDocument;
+/**
+ * Get current DOM selection from editor
+ * @param core The EditorCore object
+ */
+export declare type GetDOMSelection = (core: EditorCore) => DOMSelection | null;
+/**
+ * Set content with content model. This is the replacement of core API getSelectionRangeEx
+ * @param core The EditorCore 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: EditorCore, 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 EditorCore object
+ * @param selection The selection to set
+ * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent
+ */
+export declare type SetDOMSelection = (core: EditorCore, selection: DOMSelection | null, skipSelectionChangedEvent?: boolean) => 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 EditorCore object
+ * @param formatter Formatter function, see ContentModelFormatter
+ * @param options More options, see FormatContentModelOptions
+ */
+export declare type FormatContentModel = (core: EditorCore, formatter: ContentModelFormatter, options?: FormatContentModelOptions) => void;
+/**
+ * Switch the Shadow Edit mode of editor On/Off
+ * @param core The EditorCore object
+ * @param isOn True to switch On, False to switch Off
+ */
+export declare type SwitchShadowEdit = (core: EditorCore, isOn: boolean) => void;
+/**
+ * Trigger a plugin event
+ * @param core The EditorCore object
+ * @param pluginEvent The event object to trigger
+ * @param broadcast Set to true to skip the shouldHandleEventExclusively check
+ */
+export declare type TriggerEvent = (core: EditorCore, pluginEvent: PluginEvent, broadcast: boolean) => void;
+/**
+ * Add an undo snapshot to current undo snapshot stack
+ * @param core The EditorCore object
+ * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).
+ * @param entityStates @optional Entity states related to this snapshot.
+ * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState
+ * when undo/redo to this snapshot
+ */
+export declare type AddUndoSnapshot = (core: EditorCore, canUndoByBackspace: boolean, entityStates?: EntityState[]) => Snapshot | null;
+/**
+ * Retrieves the rect of the visible viewport of the editor.
+ * @param core The EditorCore object
+ */
+export declare type GetVisibleViewport = (core: EditorCore) => Rect | null;
+/**
+ * Check if the editor has focus now
+ * @param core The EditorCore object
+ * @returns True if the editor has focus, otherwise false
+ */
+export declare type HasFocus = (core: EditorCore) => boolean;
+/**
+ * Focus to editor. If there is a cached selection range, use it as current selection
+ * @param core The EditorCore object
+ */
+export declare type Focus = (core: EditorCore) => void;
+/**
+ * Attach a DOM event to the editor content DIV
+ * @param core The EditorCore object
+ * @param eventMap A map from event name to its handler
+ */
+export declare type AttachDomEvent = (core: EditorCore, eventMap: Record<string, DOMEventRecord>) => () => void;
+/**
+ * Restore an undo snapshot into editor
+ * @param core The EditorCore object
+ * @param step Steps to move, can be 0, positive or negative
+ */
+export declare type RestoreUndoSnapshot = (core: EditorCore, snapshot: Snapshot) => void;
+/**
+ * Paste into editor using a clipboardData object
+ * @param core The EditorCore object.
+ * @param clipboardData Clipboard data retrieved from clipboard
+ * @param pasteType Type of content to paste. @default normal
+ */
+export declare type Paste = (core: EditorCore, clipboardData: ClipboardData, pasteType: PasteType) => void;
+/**
+ * The interface for the map of core API for Editor.
+ * Editor can call call API from this map under EditorCore object
+ */
+export interface CoreApiMap {
+    /**
+     * Create a EditorContext object used by ContentModel API
+     * @param core The EditorCore object
+     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
+     */
+    createEditorContext: CreateEditorContext;
+    /**
+     * Create Content Model from DOM tree in this editor
+     * @param core The EditorCore 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 EditorCore object
+     */
+    getDOMSelection: GetDOMSelection;
+    /**
+     * Set content with content model
+     * @param core The EditorCore 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 EditorCore object
+     * @param selection The selection to set
+     * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent
+     */
+    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 EditorCore object
+     * @param formatter Formatter function, see ContentModelFormatter
+     * @param options More options, see FormatContentModelOptions
+     */
+    formatContentModel: FormatContentModel;
+    /**
+     * Switch the Shadow Edit mode of editor On/Off
+     * @param core The EditorCore 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 EditorCore object
+     */
+    getVisibleViewport: GetVisibleViewport;
+    /**
+     * Check if the editor has focus now
+     * @param core The EditorCore 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 EditorCore object
+     */
+    focus: Focus;
+    /**
+     * Add an undo snapshot to current undo snapshot stack
+     * @param core The EditorCore object
+     * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).
+     * @param entityStates @optional Entity states related to this snapshot.
+     * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState
+     * when undo/redo to this snapshot
+     */
+    addUndoSnapshot: AddUndoSnapshot;
+    /**
+     * 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;
+    /**
+     * Attach a DOM event to the editor content DIV
+     * @param core The EditorCore object
+     * @param eventMap A map from event name to its handler
+     */
+    attachDomEvent: AttachDomEvent;
+    /**
+     * Trigger a plugin event
+     * @param core The EditorCore object
+     * @param pluginEvent The event object to trigger
+     * @param broadcast Set to true to skip the shouldHandleEventExclusively check
+     */
+    triggerEvent: TriggerEvent;
+    /**
+     * Paste into editor using a clipboardData object
+     * @param editor The editor to paste content into
+     * @param clipboardData Clipboard data retrieved from clipboard
+     * @param pasteType Type of content to paste. @default normal
+     */
+    paste: Paste;
+}
+/**
+ * Represents the core data structure of an editor
+ */
+export interface EditorCore extends PluginState {
+    /**
+     * The root DIV element of this editor (formerly contentDiv)
+     */
+    readonly physicalRoot: HTMLDivElement;
+    /**
+     * The content DIV element that operations should be applied to
+     * By default, the logical root is the same as the physical root,
+     * but if nested editors are used, the logical root changes to that of the inner editor
+     */
+    logicalRoot: HTMLDivElement;
+    /**
+     * Core API map of this editor
+     */
+    readonly api: CoreApiMap;
+    /**
+     * 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: CoreApiMap;
+    /**
+     * An array of editor plugins.
+     */
+    readonly plugins: EditorPlugin[];
+    /**
+     * Settings used by DOM to Content Model conversion
+     */
+    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
+    /**
+     * Settings used by Content Model to DOM conversion
+     */
+    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
+    /**
+     * 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;
+    /**
+     * A helper class to provide DOM access APIs
+     */
+    readonly domHelper: DOMHelper;
+    /**
+     * A callback to be invoked when any exception is thrown during disposing editor
+     * @param plugin The plugin that causes exception
+     * @param error The error object we got
+     */
+    readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
+}
+/**
+ * Default DOM and Content Model conversion settings for an editor
+ */
+export interface ContentModelSettings<OptionType, ConfigType> {
+    /**
+     * Built in options used by editor
+     */
+    builtIn: OptionType;
+    /**
+     * Customize options passed in from Editor Options, used for overwrite default option.
+     * This will also be used by copy/paste
+     */
+    customized: OptionType;
+    /**
+     * Configuration calculated from default and customized options.
+     * This is a cached object so that we don't need to cache it every time when we use Content Model
+     */
+    calculated: ConfigType;
+}

package/lib/editor/EditorCore.js

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

package/lib/editor/EditorCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorCore.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/editor/EditorCore.ts"],"names":[],"mappings":"","sourcesContent":["import type { DOMHelper } from '../parameter/DOMHelper';\r\nimport type { PluginEvent } from '../event/PluginEvent';\r\nimport type { PluginState } from '../pluginState/PluginState';\r\nimport type { EditorPlugin } from './EditorPlugin';\r\nimport type { ClipboardData } from '../parameter/ClipboardData';\r\nimport type { PasteType } from '../enum/PasteType';\r\nimport type { DOMEventRecord } from '../parameter/DOMEventRecord';\r\nimport type { Snapshot } from '../parameter/Snapshot';\r\nimport type { EntityState } from '../parameter/FormatContentModelContext';\r\nimport type { DarkColorHandler } from '../context/DarkColorHandler';\r\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\r\nimport type { DOMSelection } from '../selection/DOMSelection';\r\nimport type { DomToModelOption } from '../context/DomToModelOption';\r\nimport type { DomToModelSettings } from '../context/DomToModelSettings';\r\nimport type { EditorContext } from '../context/EditorContext';\r\nimport type { EditorEnvironment } from '../parameter/EditorEnvironment';\r\nimport type { ModelToDomOption } from '../context/ModelToDomOption';\r\nimport type { ModelToDomSettings, OnNodeCreated } from '../context/ModelToDomSettings';\r\nimport type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';\r\nimport type { Rect } from '../parameter/Rect';\r\nimport type {\r\n    ContentModelFormatter,\r\n    FormatContentModelOptions,\r\n} from '../parameter/FormatContentModelOptions';\r\n\r\n/**\r\n * Create a EditorContext object used by ContentModel API\r\n * @param core The EditorCore object\r\n * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false\r\n */\r\nexport type CreateEditorContext = (core: EditorCore, saveIndex: boolean) => EditorContext;\r\n\r\n/**\r\n * Create Content Model from DOM tree in this editor\r\n * @param core The EditorCore object\r\n * @param option The option to customize the behavior of DOM to Content Model conversion\r\n * @param selectionOverride When passed, use this selection range instead of current selection in editor\r\n */\r\nexport type CreateContentModel = (\r\n    core: EditorCore,\r\n    option?: DomToModelOption,\r\n    selectionOverride?: DOMSelection\r\n) => ContentModelDocument;\r\n\r\n/**\r\n * Get current DOM selection from editor\r\n * @param core The EditorCore object\r\n */\r\nexport type GetDOMSelection = (core: EditorCore) => DOMSelection | null;\r\n\r\n/**\r\n * Set content with content model. This is the replacement of core API getSelectionRangeEx\r\n * @param core The EditorCore object\r\n * @param model The content model to set\r\n * @param option Additional options to customize the behavior of Content Model to DOM conversion\r\n * @param onNodeCreated An optional callback that will be called when a DOM node is created\r\n */\r\nexport type SetContentModel = (\r\n    core: EditorCore,\r\n    model: ContentModelDocument,\r\n    option?: ModelToDomOption,\r\n    onNodeCreated?: OnNodeCreated\r\n) => DOMSelection | null;\r\n\r\n/**\r\n * Set current DOM selection from editor. This is the replacement of core API select\r\n * @param core The EditorCore object\r\n * @param selection The selection to set\r\n * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent\r\n */\r\nexport type SetDOMSelection = (\r\n    core: EditorCore,\r\n    selection: DOMSelection | null,\r\n    skipSelectionChangedEvent?: boolean\r\n) => void;\r\n\r\n/**\r\n * The general API to do format change with Content Model\r\n * It will grab a Content Model for current editor content, and invoke a callback function\r\n * to do format change. Then according to the return value, write back the modified content model into editor.\r\n * If there is cached model, it will be used and updated.\r\n * @param core The EditorCore object\r\n * @param formatter Formatter function, see ContentModelFormatter\r\n * @param options More options, see FormatContentModelOptions\r\n */\r\nexport type FormatContentModel = (\r\n    core: EditorCore,\r\n    formatter: ContentModelFormatter,\r\n    options?: FormatContentModelOptions\r\n) => void;\r\n\r\n/**\r\n * Switch the Shadow Edit mode of editor On/Off\r\n * @param core The EditorCore object\r\n * @param isOn True to switch On, False to switch Off\r\n */\r\nexport type SwitchShadowEdit = (core: EditorCore, isOn: boolean) => void;\r\n\r\n/**\r\n * Trigger a plugin event\r\n * @param core The EditorCore object\r\n * @param pluginEvent The event object to trigger\r\n * @param broadcast Set to true to skip the shouldHandleEventExclusively check\r\n */\r\nexport type TriggerEvent = (core: EditorCore, pluginEvent: PluginEvent, broadcast: boolean) => void;\r\n\r\n/**\r\n * Add an undo snapshot to current undo snapshot stack\r\n * @param core The EditorCore object\r\n * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\r\n * @param entityStates @optional Entity states related to this snapshot.\r\n * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\r\n * when undo/redo to this snapshot\r\n */\r\nexport type AddUndoSnapshot = (\r\n    core: EditorCore,\r\n    canUndoByBackspace: boolean,\r\n    entityStates?: EntityState[]\r\n) => Snapshot | null;\r\n\r\n/**\r\n * Retrieves the rect of the visible viewport of the editor.\r\n * @param core The EditorCore object\r\n */\r\nexport type GetVisibleViewport = (core: EditorCore) => Rect | null;\r\n\r\n/**\r\n * Check if the editor has focus now\r\n * @param core The EditorCore object\r\n * @returns True if the editor has focus, otherwise false\r\n */\r\nexport type HasFocus = (core: EditorCore) => boolean;\r\n\r\n/**\r\n * Focus to editor. If there is a cached selection range, use it as current selection\r\n * @param core The EditorCore object\r\n */\r\nexport type Focus = (core: EditorCore) => void;\r\n\r\n/**\r\n * Attach a DOM event to the editor content DIV\r\n * @param core The EditorCore object\r\n * @param eventMap A map from event name to its handler\r\n */\r\nexport type AttachDomEvent = (\r\n    core: EditorCore,\r\n    eventMap: Record<string, DOMEventRecord>\r\n) => () => void;\r\n\r\n/**\r\n * Restore an undo snapshot into editor\r\n * @param core The EditorCore object\r\n * @param step Steps to move, can be 0, positive or negative\r\n */\r\nexport type RestoreUndoSnapshot = (core: EditorCore, snapshot: Snapshot) => void;\r\n\r\n/**\r\n * Paste into editor using a clipboardData object\r\n * @param core The EditorCore object.\r\n * @param clipboardData Clipboard data retrieved from clipboard\r\n * @param pasteType Type of content to paste. @default normal\r\n */\r\nexport type Paste = (core: EditorCore, clipboardData: ClipboardData, pasteType: PasteType) => void;\r\n\r\n/**\r\n * The interface for the map of core API for Editor.\r\n * Editor can call call API from this map under EditorCore object\r\n */\r\nexport interface CoreApiMap {\r\n    /**\r\n     * Create a EditorContext object used by ContentModel API\r\n     * @param core The EditorCore object\r\n     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false\r\n     */\r\n    createEditorContext: CreateEditorContext;\r\n\r\n    /**\r\n     * Create Content Model from DOM tree in this editor\r\n     * @param core The EditorCore object\r\n     * @param option The option to customize the behavior of DOM to Content Model conversion\r\n     */\r\n    createContentModel: CreateContentModel;\r\n\r\n    /**\r\n     * Get current DOM selection from editor\r\n     * @param core The EditorCore object\r\n     */\r\n    getDOMSelection: GetDOMSelection;\r\n\r\n    /**\r\n     * Set content with content model\r\n     * @param core The EditorCore object\r\n     * @param model The content model to set\r\n     * @param option Additional options to customize the behavior of Content Model to DOM conversion\r\n     */\r\n    setContentModel: SetContentModel;\r\n\r\n    /**\r\n     * Set current DOM selection from editor. This is the replacement of core API select\r\n     * @param core The EditorCore object\r\n     * @param selection The selection to set\r\n     * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent\r\n     */\r\n    setDOMSelection: SetDOMSelection;\r\n\r\n    /**\r\n     * The general API to do format change with Content Model\r\n     * It will grab a Content Model for current editor content, and invoke a callback function\r\n     * to do format change. Then according to the return value, write back the modified content model into editor.\r\n     * If there is cached model, it will be used and updated.\r\n     * @param core The EditorCore object\r\n     * @param formatter Formatter function, see ContentModelFormatter\r\n     * @param options More options, see FormatContentModelOptions\r\n     */\r\n    formatContentModel: FormatContentModel;\r\n\r\n    /**\r\n     * Switch the Shadow Edit mode of editor On/Off\r\n     * @param core The EditorCore object\r\n     * @param isOn True to switch On, False to switch Off\r\n     */\r\n    switchShadowEdit: SwitchShadowEdit;\r\n\r\n    /**\r\n     * Retrieves the rect of the visible viewport of the editor.\r\n     * @param core The EditorCore object\r\n     */\r\n    getVisibleViewport: GetVisibleViewport;\r\n\r\n    /**\r\n     * Check if the editor has focus now\r\n     * @param core The EditorCore object\r\n     * @returns True if the editor has focus, otherwise false\r\n     */\r\n    hasFocus: HasFocus;\r\n\r\n    /**\r\n     * Focus to editor. If there is a cached selection range, use it as current selection\r\n     * @param core The EditorCore object\r\n     */\r\n    focus: Focus;\r\n\r\n    /**\r\n     * Add an undo snapshot to current undo snapshot stack\r\n     * @param core The EditorCore object\r\n     * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\r\n     * @param entityStates @optional Entity states related to this snapshot.\r\n     * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\r\n     * when undo/redo to this snapshot\r\n     */\r\n    addUndoSnapshot: AddUndoSnapshot;\r\n\r\n    /**\r\n     * Restore an undo snapshot into editor\r\n     * @param core The editor core object\r\n     * @param step Steps to move, can be 0, positive or negative\r\n     */\r\n    restoreUndoSnapshot: RestoreUndoSnapshot;\r\n\r\n    /**\r\n     * Attach a DOM event to the editor content DIV\r\n     * @param core The EditorCore object\r\n     * @param eventMap A map from event name to its handler\r\n     */\r\n    attachDomEvent: AttachDomEvent;\r\n\r\n    /**\r\n     * Trigger a plugin event\r\n     * @param core The EditorCore object\r\n     * @param pluginEvent The event object to trigger\r\n     * @param broadcast Set to true to skip the shouldHandleEventExclusively check\r\n     */\r\n    triggerEvent: TriggerEvent;\r\n\r\n    /**\r\n     * Paste into editor using a clipboardData object\r\n     * @param editor The editor to paste content into\r\n     * @param clipboardData Clipboard data retrieved from clipboard\r\n     * @param pasteType Type of content to paste. @default normal\r\n     */\r\n    paste: Paste;\r\n}\r\n\r\n/**\r\n * Represents the core data structure of an editor\r\n */\r\nexport interface EditorCore extends PluginState {\r\n    /**\r\n     * The root DIV element of this editor (formerly contentDiv)\r\n     */\r\n    readonly physicalRoot: HTMLDivElement;\r\n\r\n    /**\r\n     * The content DIV element that operations should be applied to\r\n     * By default, the logical root is the same as the physical root,\r\n     * but if nested editors are used, the logical root changes to that of the inner editor\r\n     */\r\n    logicalRoot: HTMLDivElement;\r\n\r\n    /**\r\n     * Core API map of this editor\r\n     */\r\n    readonly api: CoreApiMap;\r\n\r\n    /**\r\n     * Original API map of this editor. Overridden core API can use API from this map to call the original version of core API.\r\n     */\r\n    readonly originalApi: CoreApiMap;\r\n\r\n    /**\r\n     * An array of editor plugins.\r\n     */\r\n    readonly plugins: EditorPlugin[];\r\n\r\n    /**\r\n     * Settings used by DOM to Content Model conversion\r\n     */\r\n    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;\r\n\r\n    /**\r\n     * Settings used by Content Model to DOM conversion\r\n     */\r\n    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;\r\n\r\n    /**\r\n     * Editor running environment\r\n     */\r\n    readonly environment: EditorEnvironment;\r\n\r\n    /**\r\n     * Dark model handler for the editor, used for variable-based solution.\r\n     * If keep it null, editor will still use original dataset-based dark mode solution.\r\n     */\r\n    readonly darkColorHandler: DarkColorHandler;\r\n\r\n    /**\r\n     * A handler to convert HTML string to a trust HTML string.\r\n     * By default it will just return the original HTML string directly.\r\n     * To override, pass your own trusted HTML handler to EditorOptions.trustedHTMLHandler\r\n     */\r\n    readonly trustedHTMLHandler: TrustedHTMLHandler;\r\n\r\n    /**\r\n     * A helper class to provide DOM access APIs\r\n     */\r\n    readonly domHelper: DOMHelper;\r\n\r\n    /**\r\n     * A callback to be invoked when any exception is thrown during disposing editor\r\n     * @param plugin The plugin that causes exception\r\n     * @param error The error object we got\r\n     */\r\n    readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;\r\n}\r\n\r\n/**\r\n * Default DOM and Content Model conversion settings for an editor\r\n */\r\nexport interface ContentModelSettings<OptionType, ConfigType> {\r\n    /**\r\n     * Built in options used by editor\r\n     */\r\n    builtIn: OptionType;\r\n\r\n    /**\r\n     * Customize options passed in from Editor Options, used for overwrite default option.\r\n     * This will also be used by copy/paste\r\n     */\r\n    customized: OptionType;\r\n\r\n    /**\r\n     * Configuration calculated from default and customized options.\r\n     * This is a cached object so that we don't need to cache it every time when we use Content Model\r\n     */\r\n    calculated: ConfigType;\r\n}\r\n"]}

package/lib/editor/EditorCorePlugins.d.ts

@@ -0,0 +1,51 @@
+import type { ContextMenuPluginState } from '../pluginState/ContextMenuPluginState';
+import type { PluginWithState } from './PluginWithState';
+import type { CopyPastePluginState } from '../pluginState/CopyPastePluginState';
+import type { UndoPluginState } from '../pluginState/UndoPluginState';
+import type { SelectionPluginState } from '../pluginState/SelectionPluginState';
+import type { EntityPluginState } from '../pluginState/EntityPluginState';
+import type { LifecyclePluginState } from '../pluginState/LifecyclePluginState';
+import type { DOMEventPluginState } from '../pluginState/DOMEventPluginState';
+import type { CachePluginState } from '../pluginState/CachePluginState';
+import type { FormatPluginState } from '../pluginState/FormatPluginState';
+/**
+ * Core plugins for editor
+ */
+export interface EditorCorePlugins {
+    /**
+     * ContentModel cache plugin manages cached Content Model, and refresh the cache when necessary
+     */
+    readonly cache: PluginWithState<CachePluginState>;
+    /**
+     * ContentModelFormat plugins helps editor to do formatting on top of content model.
+     */
+    readonly format: PluginWithState<FormatPluginState>;
+    /**
+     * Copy and paste plugin for handling onCopy and onPaste event
+     */
+    readonly copyPaste: PluginWithState<CopyPastePluginState>;
+    /**
+     * DomEvent plugin helps handle additional DOM events such as IME composition, cut, drop.
+     */
+    readonly domEvent: PluginWithState<DOMEventPluginState>;
+    /**
+     * Selection plugin handles selection, including range selection, table selection, and image selection
+     */
+    readonly selection: PluginWithState<SelectionPluginState>;
+    /**
+     * Entity Plugin handles all operations related to an entity and generate entity specified events
+     */
+    readonly entity: PluginWithState<EntityPluginState>;
+    /**
+     * Undo plugin provides the ability to undo/redo
+     */
+    readonly undo: PluginWithState<UndoPluginState>;
+    /**
+     * Undo plugin provides the ability get context menu items and trigger ContextMenu event
+     */
+    readonly contextMenu: PluginWithState<ContextMenuPluginState>;
+    /**
+     * Lifecycle plugin handles editor initialization and disposing
+     */
+    readonly lifecycle: PluginWithState<LifecyclePluginState>;
+}

package/lib/editor/EditorCorePlugins.js

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

package/lib/editor/EditorCorePlugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorCorePlugins.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/editor/EditorCorePlugins.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContextMenuPluginState } from '../pluginState/ContextMenuPluginState';\r\nimport type { PluginWithState } from './PluginWithState';\r\nimport type { CopyPastePluginState } from '../pluginState/CopyPastePluginState';\r\nimport type { UndoPluginState } from '../pluginState/UndoPluginState';\r\nimport type { SelectionPluginState } from '../pluginState/SelectionPluginState';\r\nimport type { EntityPluginState } from '../pluginState/EntityPluginState';\r\nimport type { LifecyclePluginState } from '../pluginState/LifecyclePluginState';\r\nimport type { DOMEventPluginState } from '../pluginState/DOMEventPluginState';\r\nimport type { CachePluginState } from '../pluginState/CachePluginState';\r\nimport type { FormatPluginState } from '../pluginState/FormatPluginState';\r\n\r\n/**\r\n * Core plugins for editor\r\n */\r\nexport interface EditorCorePlugins {\r\n    /**\r\n     * ContentModel cache plugin manages cached Content Model, and refresh the cache when necessary\r\n     */\r\n    readonly cache: PluginWithState<CachePluginState>;\r\n\r\n    /**\r\n     * ContentModelFormat plugins helps editor to do formatting on top of content model.\r\n     */\r\n    readonly format: PluginWithState<FormatPluginState>;\r\n\r\n    /**\r\n     * Copy and paste plugin for handling onCopy and onPaste event\r\n     */\r\n    readonly copyPaste: PluginWithState<CopyPastePluginState>;\r\n\r\n    /**\r\n     * DomEvent plugin helps handle additional DOM events such as IME composition, cut, drop.\r\n     */\r\n    readonly domEvent: PluginWithState<DOMEventPluginState>;\r\n\r\n    /**\r\n     * Selection plugin handles selection, including range selection, table selection, and image selection\r\n     */\r\n    readonly selection: PluginWithState<SelectionPluginState>;\r\n\r\n    /**\r\n     * Entity Plugin handles all operations related to an entity and generate entity specified events\r\n     */\r\n    readonly entity: PluginWithState<EntityPluginState>;\r\n\r\n    /**\r\n     * Undo plugin provides the ability to undo/redo\r\n     */\r\n    readonly undo: PluginWithState<UndoPluginState>;\r\n\r\n    /**\r\n     * Undo plugin provides the ability get context menu items and trigger ContextMenu event\r\n     */\r\n    readonly contextMenu: PluginWithState<ContextMenuPluginState>;\r\n\r\n    /**\r\n     * Lifecycle plugin handles editor initialization and disposing\r\n     */\r\n    readonly lifecycle: PluginWithState<LifecyclePluginState>;\r\n}\r\n"]}

package/lib/editor/EditorOptions.d.ts

@@ -0,0 +1,100 @@
+import type { PasteType } from '../enum/PasteType';
+import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
+import type { EditorPlugin } from './EditorPlugin';
+import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
+import type { CoreApiMap } from './EditorCore';
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { Snapshots } from '../parameter/Snapshot';
+import type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';
+/**
+ * Options for editor
+ */
+export interface EditorOptions {
+    /**
+     * Default options used for DOM to Content Model conversion
+     */
+    defaultDomToModelOptions?: DomToModelOption;
+    /**
+     * Default options used for Content Model to DOM conversion
+     */
+    defaultModelToDomOptions?: ModelToDomOption;
+    /**
+     * Reuse existing DOM structure if possible, and update the model when content or selection is changed
+     */
+    cacheModel?: boolean;
+    /**
+     * List of plugins.
+     * The order of plugins here determines in what order each event will be dispatched.
+     * Plugins not appear in this list will not be added to editor, including built-in plugins.
+     * Default value is empty array.
+     */
+    plugins?: EditorPlugin[];
+    /**
+     * Default format of editor content. This will be applied to empty content.
+     * If there is already content inside editor, format of existing content will not be changed.
+     * Default value is the computed style of editor content DIV
+     */
+    defaultSegmentFormat?: ContentModelSegmentFormat;
+    /**
+     * 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
+     */
+    allowedCustomPasteType?: string[];
+    /**
+     * The scroll container to get scroll event from.
+     * By default, the scroll container will be the same with editor content DIV
+     */
+    scrollContainer?: HTMLElement;
+    /**
+     * A util function to transform light mode color to dark mode color
+     * Default value is to return the original light color
+     */
+    getDarkColor?: ColorTransformFunction;
+    /**
+     * Existing known color pairs
+     */
+    knownColors?: Record<string, Colors>;
+    /**
+     * Customized trusted type handler used for sanitizing HTML string before assign to DOM tree
+     * This is required when trusted-type Content-Security-Policy (CSP) is enabled.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/trusted-types
+     */
+    trustedHTMLHandler?: TrustedHTMLHandler;
+    /**
+     * A function map to override default core API implementation
+     * Default value is null
+     */
+    coreApiOverride?: Partial<CoreApiMap>;
+    /**
+     * Color of the border of a selectedImage. Default color: '#DB626C'
+     */
+    imageSelectionBorderColor?: string;
+    /**
+     * Initial Content Model
+     */
+    initialModel?: ContentModelDocument;
+    /**
+     * Whether to skip the adjust editor process when for light/dark mode
+     */
+    doNotAdjustEditorColor?: boolean;
+    /**
+     * If the editor is currently in dark mode
+     */
+    inDarkMode?: boolean;
+    /**
+     * Undo snapshot. Use this parameter to provide an external storage of undo snapshots
+     */
+    snapshots?: Snapshots;
+    /**
+     * A callback to be invoked when any exception is thrown during disposing editor
+     * @param plugin The plugin that causes exception
+     * @param error The error object we got
+     */
+    disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
+    /**
+     * Default paste type. By default will use the normal (as-is) paste type.
+     */
+    defaultPasteType?: PasteType;
+}

package/lib/editor/EditorOptions.js

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

package/lib/editor/EditorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorOptions.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/editor/EditorOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PasteType } from '../enum/PasteType';\r\nimport type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';\r\nimport type { EditorPlugin } from './EditorPlugin';\r\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\r\nimport type { CoreApiMap } from './EditorCore';\r\nimport type { DomToModelOption } from '../context/DomToModelOption';\r\nimport type { ModelToDomOption } from '../context/ModelToDomOption';\r\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\r\nimport type { Snapshots } from '../parameter/Snapshot';\r\nimport type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';\r\n\r\n/**\r\n * Options for editor\r\n */\r\nexport interface EditorOptions {\r\n    /**\r\n     * Default options used for DOM to Content Model conversion\r\n     */\r\n    defaultDomToModelOptions?: DomToModelOption;\r\n\r\n    /**\r\n     * Default options used for Content Model to DOM conversion\r\n     */\r\n    defaultModelToDomOptions?: ModelToDomOption;\r\n\r\n    /**\r\n     * Reuse existing DOM structure if possible, and update the model when content or selection is changed\r\n     */\r\n    cacheModel?: boolean;\r\n\r\n    /**\r\n     * List of plugins.\r\n     * The order of plugins here determines in what order each event will be dispatched.\r\n     * Plugins not appear in this list will not be added to editor, including built-in plugins.\r\n     * Default value is empty array.\r\n     */\r\n    plugins?: EditorPlugin[];\r\n\r\n    /**\r\n     * Default format of editor content. This will be applied to empty content.\r\n     * If there is already content inside editor, format of existing content will not be changed.\r\n     * Default value is the computed style of editor content DIV\r\n     */\r\n    defaultSegmentFormat?: ContentModelSegmentFormat;\r\n\r\n    /**\r\n     * Allowed custom content type when paste besides text/plain, text/html and images\r\n     * Only text types are supported, and do not add \"text/\" prefix to the type values\r\n     */\r\n    allowedCustomPasteType?: string[];\r\n\r\n    /**\r\n     * The scroll container to get scroll event from.\r\n     * By default, the scroll container will be the same with editor content DIV\r\n     */\r\n    scrollContainer?: HTMLElement;\r\n\r\n    /**\r\n     * A util function to transform light mode color to dark mode color\r\n     * Default value is to return the original light color\r\n     */\r\n    getDarkColor?: ColorTransformFunction;\r\n\r\n    /**\r\n     * Existing known color pairs\r\n     */\r\n    knownColors?: Record<string, Colors>;\r\n\r\n    /**\r\n     * Customized trusted type handler used for sanitizing HTML string before assign to DOM tree\r\n     * This is required when trusted-type Content-Security-Policy (CSP) is enabled.\r\n     * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/trusted-types\r\n     */\r\n    trustedHTMLHandler?: TrustedHTMLHandler;\r\n\r\n    /**\r\n     * A function map to override default core API implementation\r\n     * Default value is null\r\n     */\r\n    coreApiOverride?: Partial<CoreApiMap>;\r\n\r\n    /**\r\n     * Color of the border of a selectedImage. Default color: '#DB626C'\r\n     */\r\n    imageSelectionBorderColor?: string;\r\n\r\n    /**\r\n     * Initial Content Model\r\n     */\r\n    initialModel?: ContentModelDocument;\r\n\r\n    /**\r\n     * Whether to skip the adjust editor process when for light/dark mode\r\n     */\r\n    doNotAdjustEditorColor?: boolean;\r\n\r\n    /**\r\n     * If the editor is currently in dark mode\r\n     */\r\n    inDarkMode?: boolean;\r\n\r\n    /**\r\n     * Undo snapshot. Use this parameter to provide an external storage of undo snapshots\r\n     */\r\n    snapshots?: Snapshots;\r\n\r\n    /**\r\n     * A callback to be invoked when any exception is thrown during disposing editor\r\n     * @param plugin The plugin that causes exception\r\n     * @param error The error object we got\r\n     */\r\n    disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;\r\n\r\n    /**\r\n     * Default paste type. By default will use the normal (as-is) paste type.\r\n     */\r\n    defaultPasteType?: PasteType;\r\n}\r\n"]}

package/lib/editor/EditorPlugin.d.ts

@@ -0,0 +1,40 @@
+import type { PluginEvent } from '../event/PluginEvent';
+import type { IEditor } from './IEditor';
+/**
+ * Interface of an editor plugin
+ */
+export interface EditorPlugin {
+    /**
+     * Get a friendly 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;
+    /**
+     * Check if the plugin should handle the given event exclusively.
+     * Handle an event exclusively means other plugin will not receive this event in
+     * onPluginEvent method.
+     * If two plugins will return true in willHandleEventExclusively() for the same event,
+     * the final result depends on the order of the plugins are added into editor
+     * @param event The event to check:
+     */
+    willHandleEventExclusively?: (event: PluginEvent) => boolean;
+    /**
+     * 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;
+}

package/lib/editor/EditorPlugin.js

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

package/lib/editor/EditorPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorPlugin.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/editor/EditorPlugin.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginEvent } from '../event/PluginEvent';\r\nimport type { IEditor } from './IEditor';\r\n\r\n/**\r\n * Interface of an editor plugin\r\n */\r\nexport interface EditorPlugin {\r\n    /**\r\n     * Get a friendly name of this plugin\r\n     */\r\n    getName: () => string;\r\n\r\n    /**\r\n     * The first method that editor will call to a plugin when editor is initializing.\r\n     * It will pass in the editor instance, plugin should take this chance to save the\r\n     * editor reference so that it can call to any editor method or format API later.\r\n     * @param editor The editor object\r\n     */\r\n    initialize: (editor: IEditor) => void;\r\n\r\n    /**\r\n     * The last method that editor will call to a plugin before it is disposed.\r\n     * Plugin can take this chance to clear the reference to editor. After this method is\r\n     * called, plugin should not call to any editor method since it will result in error.\r\n     */\r\n    dispose: () => void;\r\n\r\n    /**\r\n     * Check if the plugin should handle the given event exclusively.\r\n     * Handle an event exclusively means other plugin will not receive this event in\r\n     * onPluginEvent method.\r\n     * If two plugins will return true in willHandleEventExclusively() for the same event,\r\n     * the final result depends on the order of the plugins are added into editor\r\n     * @param event The event to check:\r\n     */\r\n    willHandleEventExclusively?: (event: PluginEvent) => boolean;\r\n\r\n    /**\r\n     * Core method for a plugin. Once an event happens in editor, editor will call this\r\n     * method of each plugin to handle the event as long as the event is not handled\r\n     * exclusively by another plugin.\r\n     * @param event The event to handle:\r\n     */\r\n    onPluginEvent?: (event: PluginEvent) => void;\r\n}\r\n"]}