roosterjs-content-model-types 0.19.0 → 0.20.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,137 @@
+import type { EditorCore, SwitchShadowEdit } from 'roosterjs-editor-types';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { ContentModelPluginState } from '../pluginState/ContentModelPluginState';
+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 & EditorCore) => 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 & EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection) => ContentModelDocument;
+/**
+ * Get current DOM selection from editor
+ * @param core The StandaloneEditorCore object
+ */
+export declare type GetDOMSelection = (core: StandaloneEditorCore & EditorCore) => 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 & 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 StandaloneEditorCore object
+ * @param selection The selection to set
+ */
+export declare type SetDOMSelection = (core: StandaloneEditorCore & EditorCore, 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 & EditorCore, formatter: ContentModelFormatter, options?: FormatWithContentModelOptions) => void;
+/**
+ * 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 {
+    /**
+     * 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;
+    switchShadowEdit: SwitchShadowEdit;
+}
+/**
+ * Represents the core data structure of a Content Model editor
+ */
+export interface StandaloneEditorCore extends ContentModelPluginState {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Editor running environment
+     */
+    environment: EditorEnvironment;
+}

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 { EditorCore, SwitchShadowEdit } from 'roosterjs-editor-types';\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\nimport type { ContentModelPluginState } from '../pluginState/ContentModelPluginState';\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 & EditorCore) => 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 & EditorCore,\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 & EditorCore) => 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 & EditorCore,\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 = (\n    core: StandaloneEditorCore & EditorCore,\n    selection: DOMSelection\n) => 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 & EditorCore,\n    formatter: ContentModelFormatter,\n    options?: FormatWithContentModelOptions\n) => void;\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 {\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    // TODO: This is copied from legacy editor core, will be ported to use new types later\n    switchShadowEdit: SwitchShadowEdit;\n}\n\n/**\n * Represents the core data structure of a Content Model editor\n */\nexport interface StandaloneEditorCore extends ContentModelPluginState {\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     * 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    /**\n     * Editor running environment\n     */\n    environment: EditorEnvironment;\n}\n"]}

package/lib/editor/StandaloneEditorOptions.d.ts

@@ -0,0 +1,19 @@
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+/**
+ * Options for Content Model editor
+ */
+export interface StandaloneEditorOptions {
+    /**
+     * 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;
+}

package/lib/editor/StandaloneEditorOptions.js

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

package/lib/editor/StandaloneEditorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StandaloneEditorOptions.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/StandaloneEditorOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { DomToModelOption } from '../context/DomToModelOption';\nimport type { ModelToDomOption } from '../context/ModelToDomOption';\n\n/**\n * Options for Content Model editor\n */\nexport interface StandaloneEditorOptions {\n    /**\n     * Default options used for DOM to Content Model conversion\n     */\n    defaultDomToModelOptions?: DomToModelOption;\n\n    /**\n     * Default options used for Content Model to DOM conversion\n     */\n    defaultModelToDomOptions?: ModelToDomOption;\n\n    /**\n     * Reuse existing DOM structure if possible, and update the model when content or selection is changed\n     */\n    cacheModel?: boolean;\n}\n"]}

package/lib/enum/BorderOperations.d.ts

@@ -0,0 +1,36 @@
+/**
+ * All Border operations
+ */
+export declare type BorderOperations = 
+/**
+ * Apply border format to all borders
+ */
+'allBorders'
+/**
+ * Remove al borders
+ */
+ | 'noBorders'
+/**
+ * Apply border format to left borders
+ */
+ | 'leftBorders'
+/**
+ * Apply border format to right borders
+ */
+ | 'rightBorders'
+/**
+ * Apply border format to top borders
+ */
+ | 'topBorders'
+/**
+ * Apply border format to bottom borders
+ */
+ | 'bottomBorders'
+/**
+ * Apply border format to inside borders
+ */
+ | 'insideBorders'
+/**
+ * Apply border format to outside borders
+ */
+ | 'outsideBorders';

package/lib/enum/BorderOperations.js

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

package/lib/enum/BorderOperations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BorderOperations.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/enum/BorderOperations.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * All Border operations\n */\nexport type BorderOperations =\n    /**\n     * Apply border format to all borders\n     */\n    | 'allBorders'\n    /**\n     * Remove al borders\n     */\n    | 'noBorders'\n    /**\n     * Apply border format to left borders\n     */\n    | 'leftBorders'\n    /**\n     * Apply border format to right borders\n     */\n    | 'rightBorders'\n    /**\n     * Apply border format to top borders\n     */\n    | 'topBorders'\n    /**\n     * Apply border format to bottom borders\n     */\n    | 'bottomBorders'\n    /**\n     * Apply border format to inside borders\n     */\n    | 'insideBorders'\n    /**\n     * Apply border format to outside borders\n     */\n    | 'outsideBorders';\n"]}

package/lib/enum/DeleteResult.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Delete selection result
+ */
+export declare type DeleteResult = 
+/**
+ * Content Model could not finish deletion, need to let browser handle it
+ */
+'notDeleted'
+/**
+ * Deleted a single char, no need to let browser keep handling
+ */
+ | 'singleChar'
+/**
+ * Deleted a range, no need to let browser keep handling
+ */
+ | 'range'
+/**
+ * There is nothing to delete, no need to let browser keep handling
+ */
+ | 'nothingToDelete';

package/lib/enum/DeleteResult.js

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

package/lib/enum/DeleteResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeleteResult.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/enum/DeleteResult.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Delete selection result\n */\nexport type DeleteResult =\n    /**\n     * Content Model could not finish deletion, need to let browser handle it\n     */\n    | 'notDeleted'\n\n    /**\n     * Deleted a single char, no need to let browser keep handling\n     */\n    | 'singleChar'\n\n    /**\n     * Deleted a range, no need to let browser keep handling\n     */\n    | 'range'\n\n    /**\n     * There is nothing to delete, no need to let browser keep handling\n     */\n    | 'nothingToDelete';\n"]}

package/lib/enum/EntityOperation.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Define entity lifecycle related operations
+ */
+export declare type EntityLifecycleOperation = 
+/**
+ * Notify plugins that there is a new plugin was added into editor.
+ * Plugin can handle this event to entity hydration.
+ * This event will be only fired once for each entity DOM node.
+ * After undo, or copy/paste, since new DOM nodes were added, this event will be fired
+ * for those entities represented by newly added nodes.
+ */
+'newEntity'
+/**
+ * Notify plugins that editor is generating HTML content for save.
+ * Plugin should use this event to remove any temporary content, and only leave DOM nodes that
+ * should be saved as HTML string.
+ * This event will provide a cloned DOM tree for each entity, do NOT compare the DOM nodes with cached nodes
+ * because it will always return false.
+ */
+ | 'replaceTemporaryContent'
+/**
+ * Notify plugins that a new entity state need to be updated to an entity.
+ * This is normally happened when user undo/redo the content with an entity snapshot added by a plugin that handles entity
+ */
+ | 'UpdateEntityState';
+/**
+ * Define entity removal related operations
+ */
+export declare type EntityRemovalOperation = 
+/**
+ * Notify plugins that user is removing an entity from its start position using DELETE key
+ */
+'removeFromStart'
+/**
+ * Notify plugins that user is remove an entity from its end position using BACKSPACE key
+ */
+ | 'removeFromEnd'
+/**
+ * Notify plugins that an entity is being overwritten.
+ * This can be caused by key in, cut, paste, delete, backspace ... on a selection
+ * which contains some entities.
+ */
+ | 'overwrite';
+/**
+ * Define possible operations to an entity
+ */
+export declare type EntityOperation = EntityLifecycleOperation | EntityRemovalOperation;

package/lib/enum/EntityOperation.js

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

package/lib/enum/EntityOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityOperation.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/enum/EntityOperation.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Define entity lifecycle related operations\n */\nexport type EntityLifecycleOperation =\n    /**\n     * Notify plugins that there is a new plugin was added into editor.\n     * Plugin can handle this event to entity hydration.\n     * This event will be only fired once for each entity DOM node.\n     * After undo, or copy/paste, since new DOM nodes were added, this event will be fired\n     * for those entities represented by newly added nodes.\n     */\n    | 'newEntity'\n\n    /**\n     * Notify plugins that editor is generating HTML content for save.\n     * Plugin should use this event to remove any temporary content, and only leave DOM nodes that\n     * should be saved as HTML string.\n     * This event will provide a cloned DOM tree for each entity, do NOT compare the DOM nodes with cached nodes\n     * because it will always return false.\n     */\n    | 'replaceTemporaryContent'\n    /**\n     * Notify plugins that a new entity state need to be updated to an entity.\n     * This is normally happened when user undo/redo the content with an entity snapshot added by a plugin that handles entity\n     */\n    | 'UpdateEntityState';\n\n/**\n * Define entity removal related operations\n */\nexport type EntityRemovalOperation =\n    /**\n     * Notify plugins that user is removing an entity from its start position using DELETE key\n     */\n    | 'removeFromStart'\n\n    /**\n     * Notify plugins that user is remove an entity from its end position using BACKSPACE key\n     */\n    | 'removeFromEnd'\n\n    /**\n     * Notify plugins that an entity is being overwritten.\n     * This can be caused by key in, cut, paste, delete, backspace ... on a selection\n     * which contains some entities.\n     */\n    | 'overwrite';\n\n/**\n * Define possible operations to an entity\n */\nexport type EntityOperation = EntityLifecycleOperation | EntityRemovalOperation;\n"]}

package/lib/enum/InsertEntityPosition.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Define the position of the entity to insert. It can be:
+ * "focus": insert at current focus. If insert a block entity, it will be inserted under the paragraph where focus is
+ * "begin": insert at beginning of content. When insert an inline entity, it will be wrapped with a paragraph.
+ * "end": insert at end of content. When insert an inline entity, it will be wrapped with a paragraph.
+ * "root": insert at the root level of current region
+ */
+export declare type InsertEntityPosition = 'focus' | 'begin' | 'end' | 'root';

package/lib/enum/InsertEntityPosition.js

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

package/lib/enum/InsertEntityPosition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsertEntityPosition.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/enum/InsertEntityPosition.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Define the position of the entity to insert. It can be:\n * \"focus\": insert at current focus. If insert a block entity, it will be inserted under the paragraph where focus is\n * \"begin\": insert at beginning of content. When insert an inline entity, it will be wrapped with a paragraph.\n * \"end\": insert at end of content. When insert an inline entity, it will be wrapped with a paragraph.\n * \"root\": insert at the root level of current region\n */\nexport type InsertEntityPosition = 'focus' | 'begin' | 'end' | 'root';\n"]}

package/lib/enum/PasteType.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Specify what type of content to paste
+ */
+export declare type PasteType = 
+/**
+ * Default paste behavior
+ */
+'normal'
+/**
+ * Paste only the plain text
+ */
+ | 'asPlainText'
+/**
+ * Apply the current style to pasted content
+ */
+ | 'mergeFormat'
+/**
+ * If there is a image uri in the clipboard, paste the content as image element
+ */
+ | 'asImage';

package/lib/enum/PasteType.js

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

package/lib/enum/PasteType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PasteType.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/enum/PasteType.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Specify what type of content to paste\n */\nexport type PasteType =\n    /**\n     * Default paste behavior\n     */\n    | 'normal'\n\n    /**\n     * Paste only the plain text\n     */\n    | 'asPlainText'\n\n    /**\n     * Apply the current style to pasted content\n     */\n    | 'mergeFormat'\n\n    /**\n     * If there is a image uri in the clipboard, paste the content as image element\n     */\n    | 'asImage';\n"]}

package/lib/enum/TableOperation.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Operations used by editTable() API for insert table cell vertically
+ */
+export declare type TableVerticalInsertOperation = 
+/**
+ * Insert a row above current row
+ */
+'insertAbove'
+/**
+ * Insert a row below current row
+ */
+ | 'insertBelow';
+/**
+ * Operations used by editTable() API for insert table cell horizontally
+ */
+export declare type TableHorizontalInsertOperation = 
+/**
+ * Insert a column on the left of current column
+ */
+'insertLeft'
+/**
+ * Insert a column on the right of current column
+ */
+ | 'insertRight';
+/**
+ * Operations used by editTable() API for delete table cells
+ */
+export declare type TableDeleteOperation = 
+/**
+ * Delete the whole table
+ */
+'deleteTable'
+/**
+ * Delete current column
+ */
+ | 'deleteColumn'
+/**
+ * Delete current row
+ */
+ | 'deleteRow';
+/**
+ * Operations used by editTable() API for merge table cells vertically
+ */
+export declare type TableVerticalMergeOperation = 
+/**
+ * Merge current row with the row above
+ */
+'mergeAbove'
+/**
+ * Merge current row with the row below
+ */
+ | 'mergeBelow';
+/**
+ * Operations used by editTable() API for merge table cells horizontally
+ */
+export declare type TableHorizontalMergeOperation = 
+/**
+ * Merge current column with the column on the left
+ */
+'mergeLeft'
+/**
+ * Merge current column with the column on the right
+ */
+ | 'mergeRight';
+/**
+ * Operations used by editTable() API for merge selected table cells
+ */
+export declare type TableCellMergeOperation = 
+/**
+ * Merge all selected cells
+ */
+'mergeCells';
+/**
+ * Operations used by editTable() API for split table cells
+ */
+export declare type TableSplitOperation = 
+/**
+ * Split current table cell horizontally
+ */
+'splitHorizontally'
+/**
+ * Split current table cell vertically
+ */
+ | 'splitVertically';
+/**
+ * Operations used by editTable() API for align table
+ */
+export declare type TableAlignOperation = 
+/**
+ * Align current table at the center
+ */
+'alignCenter'
+/**
+ * Align current table at the left
+ */
+ | 'alignLeft'
+/**
+ * Align current table at the right
+ */
+ | 'alignRight';
+/**
+ * Operations used by editTable() API for align table cell horizontally
+ */
+export declare type TableCellHorizontalAlignOperation = 
+/**
+ * Align current content table cell at the left
+ */
+'alignCellLeft'
+/**
+ * Align current content table cell at the center
+ */
+ | 'alignCellCenter'
+/**
+ * Align current content table cell at the right
+ */
+ | 'alignCellRight';
+/**
+ * Operations used by editTable() API for align table cell vertically
+ */
+export declare type TableCellVerticalAlignOperation = 
+/**
+ * Align current content table cell at the top
+ */
+'alignCellTop'
+/**
+ * Align current table cell at the middle
+ */
+ | 'alignCellMiddle'
+/**
+ * Align current table cell at the bottom
+ */
+ | 'alignCellBottom';
+/**
+ * Operations used by editTable() API
+ */
+export declare type TableOperation = TableVerticalInsertOperation | TableHorizontalInsertOperation | TableDeleteOperation | TableVerticalMergeOperation | TableHorizontalMergeOperation | TableCellMergeOperation | TableSplitOperation | TableAlignOperation | TableCellHorizontalAlignOperation | TableCellVerticalAlignOperation;

package/lib/enum/TableOperation.js

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

package/lib/enum/TableOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TableOperation.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/enum/TableOperation.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Operations used by editTable() API for insert table cell vertically\n */\nexport type TableVerticalInsertOperation =\n    /**\n     * Insert a row above current row\n     */\n    | 'insertAbove'\n\n    /**\n     * Insert a row below current row\n     */\n    | 'insertBelow';\n\n/**\n * Operations used by editTable() API for insert table cell horizontally\n */\nexport type TableHorizontalInsertOperation =\n    /**\n     * Insert a column on the left of current column\n     */\n    | 'insertLeft'\n\n    /**\n     * Insert a column on the right of current column\n     */\n    | 'insertRight';\n\n/**\n * Operations used by editTable() API for delete table cells\n */\nexport type TableDeleteOperation =\n    /**\n     * Delete the whole table\n     */\n    | 'deleteTable'\n\n    /**\n     * Delete current column\n     */\n    | 'deleteColumn'\n\n    /**\n     * Delete current row\n     */\n    | 'deleteRow';\n\n/**\n * Operations used by editTable() API for merge table cells vertically\n */\nexport type TableVerticalMergeOperation =\n    /**\n     * Merge current row with the row above\n     */\n    | 'mergeAbove'\n\n    /**\n     * Merge current row with the row below\n     */\n    | 'mergeBelow';\n\n/**\n * Operations used by editTable() API for merge table cells horizontally\n */\nexport type TableHorizontalMergeOperation =\n    /**\n     * Merge current column with the column on the left\n     */\n    | 'mergeLeft'\n\n    /**\n     * Merge current column with the column on the right\n     */\n    | 'mergeRight';\n\n/**\n * Operations used by editTable() API for merge selected table cells\n */\nexport type TableCellMergeOperation =\n    /**\n     * Merge all selected cells\n     */\n    'mergeCells';\n\n/**\n * Operations used by editTable() API for split table cells\n */\nexport type TableSplitOperation =\n    /**\n     * Split current table cell horizontally\n     */\n    | 'splitHorizontally'\n\n    /**\n     * Split current table cell vertically\n     */\n    | 'splitVertically';\n\n/**\n * Operations used by editTable() API for align table\n */\nexport type TableAlignOperation =\n    /**\n     * Align current table at the center\n     */\n    | 'alignCenter'\n\n    /**\n     * Align current table at the left\n     */\n    | 'alignLeft'\n\n    /**\n     * Align current table at the right\n     */\n    | 'alignRight';\n\n/**\n * Operations used by editTable() API for align table cell horizontally\n */\nexport type TableCellHorizontalAlignOperation =\n    /**\n     * Align current content table cell at the left\n     */\n    | 'alignCellLeft'\n\n    /**\n     * Align current content table cell at the center\n     */\n    | 'alignCellCenter'\n\n    /**\n     * Align current content table cell at the right\n     */\n    | 'alignCellRight';\n\n/**\n * Operations used by editTable() API for align table cell vertically\n */\nexport type TableCellVerticalAlignOperation =\n    /**\n     * Align current content table cell at the top\n     */\n    | 'alignCellTop'\n\n    /**\n     * Align current table cell at the middle\n     */\n    | 'alignCellMiddle'\n\n    /**\n     * Align current table cell at the bottom\n     */\n    | 'alignCellBottom';\n\n/**\n * Operations used by editTable() API\n */\nexport type TableOperation =\n    | TableVerticalInsertOperation\n    | TableHorizontalInsertOperation\n    | TableDeleteOperation\n    | TableVerticalMergeOperation\n    | TableHorizontalMergeOperation\n    | TableCellMergeOperation\n    | TableSplitOperation\n    | TableAlignOperation\n    | TableCellHorizontalAlignOperation\n    | TableCellVerticalAlignOperation;\n"]}