roosterjs-content-model-types 0.23.0 → 0.24.0

package/lib/context/DarkColorHandler.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Represents a combination of color key, light color and dark color, parsed from existing color value
+ */
+export interface Colors {
+    /**
+     * Light mode color value
+     */
+    lightModeColor: string;
+    /**
+     * Dark mode color value, if found, otherwise undefined
+     */
+    darkModeColor: string;
+}
+/**
+ * A util function type to transform light mode color to dark mode color
+ * Default value is to return the original light color
+ * @param lightColor Source color string in light mode
+ * @param baseLValue Base value of light used for dark value calculation
+ * @param colorType @optional Type of color, can be text, background, or border
+ * @param element @optional Source HTML element of the color
+ */
+export declare type ColorTransformFunction = (lightColor: string, baseLValue?: number, colorType?: 'text' | 'background' | 'border', element?: HTMLElement) => string;
+/**
+ * A handler object for dark color, used for variable-based dark color solution
+ */
+export interface DarkColorHandler {
+    /**
+     * Map of known colors
+     */
+    readonly knownColors: Record<string, Colors>;
+    /**
+     * Update all known colors to root container.
+     * @param isDarkMode Whether container is in dark mode. When in dark mode, we add CSS color variables for all known colors.
+     * When in light mode, we will remove all those CSS color variables
+     */
+    updateKnownColor(isDarkMode: boolean): void;
+    /**
+     * Register a known color, and update it to root container via CSS color variable when in dark mode
+     * @param isDarkMode Whether container is in dark mode.
+     * @param key The key of color, normally it is the name of color variable
+     * @param colorPair A pair value of light color and dark color
+     */
+    updateKnownColor(isDarkMode: boolean, key: string, colorPair: Colors): void;
+    /**
+     * Reset known color record, clean up registered color variables.
+     */
+    reset(): void;
+    /**
+     * A util function to transform light mode color to dark mode color
+     */
+    getDarkColor: ColorTransformFunction;
+}

package/lib/{pluginState/StandaloneEditorPluginState.js → context/DarkColorHandler.js}

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

package/lib/context/DarkColorHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DarkColorHandler.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/DarkColorHandler.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents a combination of color key, light color and dark color, parsed from existing color value\n */\nexport interface Colors {\n    /**\n     * Light mode color value\n     */\n    lightModeColor: string;\n\n    /**\n     * Dark mode color value, if found, otherwise undefined\n     */\n    darkModeColor: string;\n}\n\n/**\n * A util function type to transform light mode color to dark mode color\n * Default value is to return the original light color\n * @param lightColor Source color string in light mode\n * @param baseLValue Base value of light used for dark value calculation\n * @param colorType @optional Type of color, can be text, background, or border\n * @param element @optional Source HTML element of the color\n */\nexport type ColorTransformFunction = (\n    lightColor: string,\n    baseLValue?: number,\n    colorType?: 'text' | 'background' | 'border',\n    element?: HTMLElement\n) => string;\n\n/**\n * A handler object for dark color, used for variable-based dark color solution\n */\nexport interface DarkColorHandler {\n    /**\n     * Map of known colors\n     */\n    readonly knownColors: Record<string, Colors>;\n\n    /**\n     * Update all known colors to root container.\n     * @param isDarkMode Whether container is in dark mode. When in dark mode, we add CSS color variables for all known colors.\n     * When in light mode, we will remove all those CSS color variables\n     */\n    updateKnownColor(isDarkMode: boolean): void;\n\n    /**\n     * Register a known color, and update it to root container via CSS color variable when in dark mode\n     * @param isDarkMode Whether container is in dark mode.\n     * @param key The key of color, normally it is the name of color variable\n     * @param colorPair A pair value of light color and dark color\n     */\n    updateKnownColor(isDarkMode: boolean, key: string, colorPair: Colors): void;\n\n    /**\n     * Reset known color record, clean up registered color variables.\n     */\n    reset(): void;\n\n    /**\n     * A util function to transform light mode color to dark mode color\n     */\n    getDarkColor: ColorTransformFunction;\n}\n"]}

package/lib/context/DomToModelSettings.d.ts

@@ -1,3 +1,4 @@
+import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
 import type { ContentModelFormatBase } from '../format/ContentModelFormatBase';
 import type { ContentModelFormatMap } from '../format/ContentModelFormatMap';
 import type { DomToModelContext } from './DomToModelContext';
@@ -22,6 +23,13 @@ export declare type DefaultStyleMap = {
  * @param defaultStyle Default CSS style of the given HTML element
  */
 export declare type FormatParser<TFormat extends ContentModelFormatBase> = (format: TFormat, element: HTMLElement, context: DomToModelContext, defaultStyle: Readonly<Partial<CSSStyleDeclaration>>) => void;
+/**
+ * Parse format from the given text node
+ * @param format The format object to parse into
+ * @param textNode The text node to parse format from
+ * @param context The context object that provide related context information
+ */
+export declare type TextFormatParser<TFormat extends ContentModelSegmentFormat = ContentModelSegmentFormat> = (format: TFormat, textNode: Text, context: DomToModelContext) => void;
 /**
  * All format parsers
  */
@@ -29,11 +37,17 @@ export declare type FormatParsers = {
     [Key in FormatKey]: FormatParser<FormatHandlerTypeMap[Key]> | null;
 };
 /**
- * A map from format parser category name to an array of parsers
+ * A map from format parser category name to an array of parsers. This is for HTML Element only
  */
-export declare type FormatParsersPerCategory = {
+export declare type ElementFormatParserPerCategory = {
     [Key in keyof ContentModelFormatMap]: (FormatParser<ContentModelFormatMap[Key]> | null)[];
 };
+/**
+ * A map from format parser category name to an array of parsers
+ */
+export declare type FormatParsersPerCategory = ElementFormatParserPerCategory & {
+    text: TextFormatParser[];
+};
 /**
  * A map from element processor name to its processor type
  */

package/lib/context/DomToModelSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"DomToModelSettings.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/DomToModelSettings.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelFormatBase } from '../format/ContentModelFormatBase';\nimport type { ContentModelFormatMap } from '../format/ContentModelFormatMap';\nimport type { DomToModelContext } from './DomToModelContext';\nimport type { ElementProcessor } from './ElementProcessor';\nimport type { FormatHandlerTypeMap, FormatKey } from '../format/FormatHandlerTypeMap';\n\n/**\n * A type of Default style map, from tag name string (in upper case) to a static style object\n */\nexport type DefaultStyleMap = {\n    [key in keyof HTMLElementDeprecatedTagNameMap]?: Readonly<Partial<CSSStyleDeclaration>>;\n} &\n    {\n        [key in keyof HTMLElementTagNameMap]?: Readonly<Partial<CSSStyleDeclaration>>;\n    } & {\n        // Workaround typescript 4.4.4 which does not have these elements in its declaration file\n        center?: Partial<CSSStyleDeclaration>;\n        strike?: Partial<CSSStyleDeclaration>;\n    };\n\n/**\n * Parse format from the given HTML element and default style\n * @param format The format object to parse into\n * @param element The HTML element to parse format from\n * @param context The context object that provide related context information\n * @param defaultStyle Default CSS style of the given HTML element\n */\nexport type FormatParser<TFormat extends ContentModelFormatBase> = (\n    format: TFormat,\n    element: HTMLElement,\n    context: DomToModelContext,\n    defaultStyle: Readonly<Partial<CSSStyleDeclaration>>\n) => void;\n\n/**\n * All format parsers\n */\nexport type FormatParsers = {\n    [Key in FormatKey]: FormatParser<FormatHandlerTypeMap[Key]> | null;\n};\n\n/**\n * A map from format parser category name to an array of parsers\n */\nexport type FormatParsersPerCategory = {\n    [Key in keyof ContentModelFormatMap]: (FormatParser<ContentModelFormatMap[Key]> | null)[];\n};\n\n/**\n * A map from element processor name to its processor type\n */\nexport type ElementProcessorMap = {\n    [key in keyof HTMLElementDeprecatedTagNameMap]?: ElementProcessor<\n        HTMLElementDeprecatedTagNameMap[key]\n    >;\n} &\n    {\n        [key in keyof HTMLElementTagNameMap]?: ElementProcessor<HTMLElementTagNameMap[key]>;\n    } & {\n        /**\n         * Processors for all other HTML elements\n         */\n        '*': ElementProcessor<HTMLElement>;\n\n        /**\n         * Processor for text node\n         */\n        '#text': ElementProcessor<Text>;\n\n        /**\n         * Processor for entity\n         */\n        entity: ElementProcessor<HTMLElement>;\n\n        /**\n         * Common processor dispatch for all elements\n         */\n        element: ElementProcessor<HTMLElement>;\n\n        /**\n         * Common processor for child nodes of a given element\n         */\n        child: ElementProcessor<ParentNode>;\n\n        /**\n         * Workaround for typescript 4.4.4 that doesn't have element \"strike\" in its element type\n         */\n        strike?: ElementProcessor<HTMLElement>;\n\n        /**\n         * Workaround for typescript 4.4.4 that doesn't have element \"center\" in its element type\n         */\n        center?: ElementProcessor<HTMLElement>;\n\n        /**\n         * Processor for Inline Readonly Delimiters\n         */\n        delimiter?: ElementProcessor<Node>;\n    };\n\n/**\n * Represents settings to customize DOM to Content Model conversion\n */\nexport interface DomToModelSettings {\n    /**\n     * Map of element processors\n     */\n    elementProcessors: ElementProcessorMap;\n\n    /**\n     * Map of format parsers\n     */\n    formatParsers: FormatParsersPerCategory;\n\n    /**\n     * Default DOM to Content Model processors before overriding.\n     * This provides a way to call original processor from an overridden processor function\n     */\n    defaultElementProcessors: Readonly<ElementProcessorMap>;\n\n    /**\n     * Default format parsers before overriding.\n     * This provides a way to call original format parser from an overridden parser function\n     */\n    defaultFormatParsers: Readonly<FormatParsers>;\n}\n"]}
+{"version":3,"file":"DomToModelSettings.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/DomToModelSettings.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\nimport type { ContentModelFormatBase } from '../format/ContentModelFormatBase';\nimport type { ContentModelFormatMap } from '../format/ContentModelFormatMap';\nimport type { DomToModelContext } from './DomToModelContext';\nimport type { ElementProcessor } from './ElementProcessor';\nimport type { FormatHandlerTypeMap, FormatKey } from '../format/FormatHandlerTypeMap';\n\n/**\n * A type of Default style map, from tag name string (in upper case) to a static style object\n */\nexport type DefaultStyleMap = {\n    [key in keyof HTMLElementDeprecatedTagNameMap]?: Readonly<Partial<CSSStyleDeclaration>>;\n} &\n    {\n        [key in keyof HTMLElementTagNameMap]?: Readonly<Partial<CSSStyleDeclaration>>;\n    } & {\n        // Workaround typescript 4.4.4 which does not have these elements in its declaration file\n        center?: Partial<CSSStyleDeclaration>;\n        strike?: Partial<CSSStyleDeclaration>;\n    };\n\n/**\n * Parse format from the given HTML element and default style\n * @param format The format object to parse into\n * @param element The HTML element to parse format from\n * @param context The context object that provide related context information\n * @param defaultStyle Default CSS style of the given HTML element\n */\nexport type FormatParser<TFormat extends ContentModelFormatBase> = (\n    format: TFormat,\n    element: HTMLElement,\n    context: DomToModelContext,\n    defaultStyle: Readonly<Partial<CSSStyleDeclaration>>\n) => void;\n\n/**\n * Parse format from the given text node\n * @param format The format object to parse into\n * @param textNode The text node to parse format from\n * @param context The context object that provide related context information\n */\nexport type TextFormatParser<\n    TFormat extends ContentModelSegmentFormat = ContentModelSegmentFormat\n> = (format: TFormat, textNode: Text, context: DomToModelContext) => void;\n\n/**\n * All format parsers\n */\nexport type FormatParsers = {\n    [Key in FormatKey]: FormatParser<FormatHandlerTypeMap[Key]> | null;\n};\n\n/**\n * A map from format parser category name to an array of parsers. This is for HTML Element only\n */\nexport type ElementFormatParserPerCategory = {\n    [Key in keyof ContentModelFormatMap]: (FormatParser<ContentModelFormatMap[Key]> | null)[];\n};\n\n/**\n * A map from format parser category name to an array of parsers\n */\nexport type FormatParsersPerCategory = ElementFormatParserPerCategory & {\n    text: TextFormatParser[];\n};\n\n/**\n * A map from element processor name to its processor type\n */\nexport type ElementProcessorMap = {\n    [key in keyof HTMLElementDeprecatedTagNameMap]?: ElementProcessor<\n        HTMLElementDeprecatedTagNameMap[key]\n    >;\n} &\n    {\n        [key in keyof HTMLElementTagNameMap]?: ElementProcessor<HTMLElementTagNameMap[key]>;\n    } & {\n        /**\n         * Processors for all other HTML elements\n         */\n        '*': ElementProcessor<HTMLElement>;\n\n        /**\n         * Processor for text node\n         */\n        '#text': ElementProcessor<Text>;\n\n        /**\n         * Processor for entity\n         */\n        entity: ElementProcessor<HTMLElement>;\n\n        /**\n         * Common processor dispatch for all elements\n         */\n        element: ElementProcessor<HTMLElement>;\n\n        /**\n         * Common processor for child nodes of a given element\n         */\n        child: ElementProcessor<ParentNode>;\n\n        /**\n         * Workaround for typescript 4.4.4 that doesn't have element \"strike\" in its element type\n         */\n        strike?: ElementProcessor<HTMLElement>;\n\n        /**\n         * Workaround for typescript 4.4.4 that doesn't have element \"center\" in its element type\n         */\n        center?: ElementProcessor<HTMLElement>;\n\n        /**\n         * Processor for Inline Readonly Delimiters\n         */\n        delimiter?: ElementProcessor<Node>;\n    };\n\n/**\n * Represents settings to customize DOM to Content Model conversion\n */\nexport interface DomToModelSettings {\n    /**\n     * Map of element processors\n     */\n    elementProcessors: ElementProcessorMap;\n\n    /**\n     * Map of format parsers\n     */\n    formatParsers: FormatParsersPerCategory;\n\n    /**\n     * Default DOM to Content Model processors before overriding.\n     * This provides a way to call original processor from an overridden processor function\n     */\n    defaultElementProcessors: Readonly<ElementProcessorMap>;\n\n    /**\n     * Default format parsers before overriding.\n     * This provides a way to call original format parser from an overridden parser function\n     */\n    defaultFormatParsers: Readonly<FormatParsers>;\n}\n"]}

package/lib/context/EditorContext.d.ts

@@ -1,6 +1,7 @@
-import type { ColorManager } from './ColorManager';
+import type { DarkColorHandler } from './DarkColorHandler';
 import type { ContentModelDomIndexer } from './ContentModelDomIndexer';
 import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
+import type { PendingFormat } from '../pluginState/ContentModelFormatPluginState';
 /**
  * An editor context interface used by ContentModel PAI
  */
@@ -13,10 +14,14 @@ export interface EditorContext {
      * Default format of editor
      */
     defaultFormat?: ContentModelSegmentFormat;
+    /**
+     * Pending format if any
+     */
+    pendingFormat?: PendingFormat;
     /**
      * Color manager, to help manager color in dark mode
      */
-    darkColorHandler?: ColorManager;
+    darkColorHandler?: DarkColorHandler;
     /**
      * Whether to handle delimiters in Content Model
      */

package/lib/context/EditorContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditorContext.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/EditorContext.ts"],"names":[],"mappings":"","sourcesContent":["import type { ColorManager } from './ColorManager';\nimport type { ContentModelDomIndexer } from './ContentModelDomIndexer';\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\n\n/**\n * An editor context interface used by ContentModel PAI\n */\nexport interface EditorContext {\n    /**\n     * Whether current content is in dark mode\n     */\n    isDarkMode?: boolean;\n\n    /**\n     * Default format of editor\n     */\n    defaultFormat?: ContentModelSegmentFormat;\n\n    /**\n     * Color manager, to help manager color in dark mode\n     */\n    darkColorHandler?: ColorManager;\n\n    /**\n     * Whether to handle delimiters in Content Model\n     */\n    addDelimiterForEntity?: boolean;\n\n    /**\n     * Zoom scale number\n     */\n    zoomScale?: number;\n\n    /**\n     * Whether the content is in Right-to-left from root level\n     */\n    isRootRtl?: boolean;\n\n    /**\n     * Whether put the source element into Content Model when possible.\n     * When pass true, this cached element will be used to create DOM tree back when convert Content Model to DOM\n     */\n    allowCacheElement?: boolean;\n\n    /**\n     * @optional Indexer for content model, to help build backward relationship from DOM node to Content Model\n     */\n    domIndexer?: ContentModelDomIndexer;\n}\n"]}
+{"version":3,"file":"EditorContext.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/EditorContext.ts"],"names":[],"mappings":"","sourcesContent":["import type { DarkColorHandler } from './DarkColorHandler';\nimport type { ContentModelDomIndexer } from './ContentModelDomIndexer';\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\nimport type { PendingFormat } from '../pluginState/ContentModelFormatPluginState';\n\n/**\n * An editor context interface used by ContentModel PAI\n */\nexport interface EditorContext {\n    /**\n     * Whether current content is in dark mode\n     */\n    isDarkMode?: boolean;\n\n    /**\n     * Default format of editor\n     */\n    defaultFormat?: ContentModelSegmentFormat;\n\n    /**\n     * Pending format if any\n     */\n    pendingFormat?: PendingFormat;\n\n    /**\n     * Color manager, to help manager color in dark mode\n     */\n    darkColorHandler?: DarkColorHandler;\n\n    /**\n     * Whether to handle delimiters in Content Model\n     */\n    addDelimiterForEntity?: boolean;\n\n    /**\n     * Zoom scale number\n     */\n    zoomScale?: number;\n\n    /**\n     * Whether the content is in Right-to-left from root level\n     */\n    isRootRtl?: boolean;\n\n    /**\n     * Whether put the source element into Content Model when possible.\n     * When pass true, this cached element will be used to create DOM tree back when convert Content Model to DOM\n     */\n    allowCacheElement?: boolean;\n\n    /**\n     * @optional Indexer for content model, to help build backward relationship from DOM node to Content Model\n     */\n    domIndexer?: ContentModelDomIndexer;\n}\n"]}

package/lib/context/ModelToDomSettings.d.ts

@@ -36,6 +36,13 @@ export declare type DefaultImplicitFormatMap = Record<string, Readonly<ContentMo
  * @param context The context object that provide related context information
  */
 export declare type FormatApplier<TFormat extends ContentModelFormatBase> = (format: TFormat, element: HTMLElement, context: ModelToDomContext) => void;
+/**
+ * Apply format to the given text node
+ * @param format The format object to apply
+ * @param textNode The text node to apply format to
+ * @param context The context object that provide related context information
+ */
+export declare type TextFormatApplier<TFormat extends ContentModelSegmentFormat = ContentModelSegmentFormat> = (format: TFormat, textNode: Text, context: ModelToDomContext) => void;
 /**
  * All format appliers
  */
@@ -43,11 +50,17 @@ export declare type FormatAppliers = {
     [Key in FormatKey]: FormatApplier<FormatHandlerTypeMap[Key]> | null;
 };
 /**
- * A map from format parser category name to an array of parsers
+ * A map from format parser category name to an array of parsers. This is for HTMLElement only
  */
-export declare type FormatAppliersPerCategory = {
+export declare type ElementFormatAppliersPerCategory = {
     [Key in keyof ContentModelFormatMap]: (FormatApplier<ContentModelFormatMap[Key]> | null)[];
 };
+/**
+ * A map from format parser category name to an array of parsers
+ */
+export declare type FormatAppliersPerCategory = ElementFormatAppliersPerCategory & {
+    text: TextFormatApplier[];
+};
 /**
  * Represents a map from content model handler name to its handle type
  */

package/lib/context/ModelToDomSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelToDomSettings.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/ModelToDomSettings.ts"],"names":[],"mappings":"","sourcesContent":["import type { Definition } from '../metadata/Definition';\nimport type { ContentModelBlock } from '../block/ContentModelBlock';\nimport type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';\nimport type { ContentModelBlockGroup } from '../group/ContentModelBlockGroup';\nimport type { ContentModelBr } from '../segment/ContentModelBr';\nimport type { ContentModelDecorator } from '../decorator/ContentModelDecorator';\nimport type { ContentModelDivider } from '../block/ContentModelDivider';\nimport type { ContentModelEntity } from '../entity/ContentModelEntity';\nimport type { ContentModelFormatBase } from '../format/ContentModelFormatBase';\nimport type { ContentModelFormatContainer } from '../group/ContentModelFormatContainer';\nimport type { ContentModelFormatMap } from '../format/ContentModelFormatMap';\nimport type { ContentModelGeneralBlock } from '../group/ContentModelGeneralBlock';\nimport type { ContentModelGeneralSegment } from '../segment/ContentModelGeneralSegment';\nimport type { ContentModelImage } from '../segment/ContentModelImage';\nimport type { ContentModelListItem } from '../group/ContentModelListItem';\nimport type { ContentModelListItemFormat } from '../format/ContentModelListItemFormat';\nimport type { ContentModelListItemLevelFormat } from '../format/ContentModelListItemLevelFormat';\nimport type { ContentModelParagraph } from '../block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../segment/ContentModelSegment';\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\nimport type { ContentModelTable } from '../block/ContentModelTable';\nimport type { ContentModelTableRow } from '../block/ContentModelTableRow';\nimport type { ContentModelText } from '../segment/ContentModelText';\nimport type { FormatHandlerTypeMap, FormatKey } from '../format/FormatHandlerTypeMap';\nimport type { ModelToDomContext } from './ModelToDomContext';\nimport type { ListMetadataFormat } from '../format/metadata/ListMetadataFormat';\nimport type {\n    ContentModelHandler,\n    ContentModelBlockHandler,\n    ContentModelSegmentHandler,\n} from './ContentModelHandler';\n\n/**\n * Default implicit format map from tag name (lower case) to segment format\n */\nexport type DefaultImplicitFormatMap = Record<\n    string,\n    Readonly<ContentModelSegmentFormat & ContentModelBlockFormat>\n>;\n\n/**\n * Apply format to the given HTML element\n * @param format The format object to apply\n * @param element The HTML element to apply format to\n * @param context The context object that provide related context information\n */\nexport type FormatApplier<TFormat extends ContentModelFormatBase> = (\n    format: TFormat,\n    element: HTMLElement,\n    context: ModelToDomContext\n) => void;\n\n/**\n * All format appliers\n */\nexport type FormatAppliers = {\n    [Key in FormatKey]: FormatApplier<FormatHandlerTypeMap[Key]> | null;\n};\n\n/**\n * A map from format parser category name to an array of parsers\n */\nexport type FormatAppliersPerCategory = {\n    [Key in keyof ContentModelFormatMap]: (FormatApplier<ContentModelFormatMap[Key]> | null)[];\n};\n\n/**\n * Represents a map from content model handler name to its handle type\n */\nexport type ContentModelHandlerMap = {\n    /**\n     * Content Model type for ContentModelBlock\n     */\n    block: ContentModelBlockHandler<ContentModelBlock>;\n\n    /**\n     * Content Model type for child models of ContentModelBlockGroup\n     */\n    blockGroupChildren: ContentModelHandler<ContentModelBlockGroup>;\n\n    /**\n     * Content Model type for ContentModelBr\n     */\n    br: ContentModelSegmentHandler<ContentModelBr>;\n\n    /**\n     * Content Model type for child models of ContentModelEntity\n     */\n    entityBlock: ContentModelBlockHandler<ContentModelEntity>;\n\n    /**\n     * Content Model type for child models of ContentModelEntity\n     */\n    entitySegment: ContentModelSegmentHandler<ContentModelEntity>;\n\n    /**\n     * Content Model type for ContentModelGeneralBlock\n     */\n    generalBlock: ContentModelBlockHandler<ContentModelGeneralBlock>;\n\n    /**\n     * Content Model type for ContentModelGeneralBlock\n     */\n    generalSegment: ContentModelSegmentHandler<ContentModelGeneralSegment>;\n\n    /**\n     * Content Model type for ContentModelHR\n     */\n    divider: ContentModelBlockHandler<ContentModelDivider>;\n\n    /**\n     * Content Model type for ContentModelImage\n     */\n    image: ContentModelSegmentHandler<ContentModelImage>;\n\n    /**\n     * Content Model type for list group of ContentModelListItem\n     */\n    list: ContentModelBlockHandler<ContentModelListItem>;\n\n    /**\n     * Content Model type for list item of ContentModelListItem\n     */\n    listItem: ContentModelBlockHandler<ContentModelListItem>;\n\n    /**\n     * Content Model type for ContentModelParagraph\n     */\n    paragraph: ContentModelBlockHandler<ContentModelParagraph>;\n\n    /**\n     * Content Model type for ContentModelFormatContainer\n     */\n    formatContainer: ContentModelBlockHandler<ContentModelFormatContainer>;\n\n    /**\n     * Content Model type for ContentModelSegment\n     */\n    segment: ContentModelSegmentHandler<ContentModelSegment>;\n\n    /**\n     * Content Model type for ContentModelCode\n     */\n    segmentDecorator: ContentModelSegmentHandler<ContentModelSegment>;\n\n    /**\n     * Content Model type for ContentModelTable\n     */\n    table: ContentModelBlockHandler<ContentModelTable>;\n\n    /**\n     * Content Model type for ContentModelText\n     */\n    text: ContentModelSegmentHandler<ContentModelText>;\n};\n\n/**\n * Function type to apply metadata value into format\n * @param metadata The metadata object to apply\n * @param format The format object to apply metadata to\n * @param context Content Model to DOM context\n */\nexport type ApplyMetadata<TMetadata, TFormat extends ContentModelFormatBase> = (\n    metadata: TMetadata | null,\n    format: TFormat,\n    context: ModelToDomContext\n) => void;\n\n/**\n * Metadata applier interface\n */\nexport interface MetadataApplier<TMetadata, TFormat extends ContentModelFormatBase> {\n    /**\n     * The metadata applier function\n     */\n    applierFunction: ApplyMetadata<TMetadata, TFormat>;\n\n    /**\n     * @optional Metadata definition, used for validate the metadata object\n     */\n    metadataDefinition?: Definition<TMetadata>;\n}\n\n/**\n * Map of metadata handlers\n */\nexport type MetadataAppliers = {\n    /**\n     * Metadata handler for list item\n     */\n    listItem?: MetadataApplier<ListMetadataFormat, ContentModelListItemFormat>;\n\n    /**\n     * Metadata handler for list level\n     */\n    listLevel?: MetadataApplier<ListMetadataFormat, ContentModelListItemLevelFormat>;\n};\n\n/**\n * An optional callback that will be called when a DOM node is created\n * @param modelElement The related Content Model element\n * @param node The node created for this model element\n */\nexport type OnNodeCreated = (\n    modelElement:\n        | ContentModelBlock\n        | ContentModelBlockGroup\n        | ContentModelSegment\n        | ContentModelDecorator\n        | ContentModelTableRow,\n    node: Node\n) => void;\n\n/**\n * Represents settings to customize DOM to Content Model conversion\n */\nexport interface ModelToDomSettings {\n    /**\n     * Map of Content Model handlers\n     */\n    modelHandlers: ContentModelHandlerMap;\n\n    /**\n     * Map of format appliers\n     */\n    formatAppliers: FormatAppliersPerCategory;\n\n    /**\n     * Map of metadata appliers\n     */\n    metadataAppliers: MetadataAppliers;\n\n    /**\n     * Default Content Model to DOM handlers before overriding.\n     * This provides a way to call original handler from an overridden handler function\n     */\n    defaultModelHandlers: Readonly<ContentModelHandlerMap>;\n\n    /**\n     * Default format parsers before overriding.\n     * This provides a way to call original format applier from an overridden applier function\n     */\n    defaultFormatAppliers: Readonly<FormatAppliers>;\n\n    /**\n     * An optional callback that will be called when a DOM node is created\n     * @param modelElement The related Content Model element\n     * @param node The node created for this model element\n     */\n    onNodeCreated?: OnNodeCreated;\n}\n"]}
+{"version":3,"file":"ModelToDomSettings.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/context/ModelToDomSettings.ts"],"names":[],"mappings":"","sourcesContent":["import type { Definition } from '../metadata/Definition';\nimport type { ContentModelBlock } from '../block/ContentModelBlock';\nimport type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';\nimport type { ContentModelBlockGroup } from '../group/ContentModelBlockGroup';\nimport type { ContentModelBr } from '../segment/ContentModelBr';\nimport type { ContentModelDecorator } from '../decorator/ContentModelDecorator';\nimport type { ContentModelDivider } from '../block/ContentModelDivider';\nimport type { ContentModelEntity } from '../entity/ContentModelEntity';\nimport type { ContentModelFormatBase } from '../format/ContentModelFormatBase';\nimport type { ContentModelFormatContainer } from '../group/ContentModelFormatContainer';\nimport type { ContentModelFormatMap } from '../format/ContentModelFormatMap';\nimport type { ContentModelGeneralBlock } from '../group/ContentModelGeneralBlock';\nimport type { ContentModelGeneralSegment } from '../segment/ContentModelGeneralSegment';\nimport type { ContentModelImage } from '../segment/ContentModelImage';\nimport type { ContentModelListItem } from '../group/ContentModelListItem';\nimport type { ContentModelListItemFormat } from '../format/ContentModelListItemFormat';\nimport type { ContentModelListItemLevelFormat } from '../format/ContentModelListItemLevelFormat';\nimport type { ContentModelParagraph } from '../block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../segment/ContentModelSegment';\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\nimport type { ContentModelTable } from '../block/ContentModelTable';\nimport type { ContentModelTableRow } from '../block/ContentModelTableRow';\nimport type { ContentModelText } from '../segment/ContentModelText';\nimport type { FormatHandlerTypeMap, FormatKey } from '../format/FormatHandlerTypeMap';\nimport type { ModelToDomContext } from './ModelToDomContext';\nimport type { ListMetadataFormat } from '../format/metadata/ListMetadataFormat';\nimport type {\n    ContentModelHandler,\n    ContentModelBlockHandler,\n    ContentModelSegmentHandler,\n} from './ContentModelHandler';\n\n/**\n * Default implicit format map from tag name (lower case) to segment format\n */\nexport type DefaultImplicitFormatMap = Record<\n    string,\n    Readonly<ContentModelSegmentFormat & ContentModelBlockFormat>\n>;\n\n/**\n * Apply format to the given HTML element\n * @param format The format object to apply\n * @param element The HTML element to apply format to\n * @param context The context object that provide related context information\n */\nexport type FormatApplier<TFormat extends ContentModelFormatBase> = (\n    format: TFormat,\n    element: HTMLElement,\n    context: ModelToDomContext\n) => void;\n\n/**\n * Apply format to the given text node\n * @param format The format object to apply\n * @param textNode The text node to apply format to\n * @param context The context object that provide related context information\n */\nexport type TextFormatApplier<\n    TFormat extends ContentModelSegmentFormat = ContentModelSegmentFormat\n> = (format: TFormat, textNode: Text, context: ModelToDomContext) => void;\n\n/**\n * All format appliers\n */\nexport type FormatAppliers = {\n    [Key in FormatKey]: FormatApplier<FormatHandlerTypeMap[Key]> | null;\n};\n\n/**\n * A map from format parser category name to an array of parsers. This is for HTMLElement only\n */\nexport type ElementFormatAppliersPerCategory = {\n    [Key in keyof ContentModelFormatMap]: (FormatApplier<ContentModelFormatMap[Key]> | null)[];\n};\n\n/**\n * A map from format parser category name to an array of parsers\n */\nexport type FormatAppliersPerCategory = ElementFormatAppliersPerCategory & {\n    text: TextFormatApplier[];\n};\n\n/**\n * Represents a map from content model handler name to its handle type\n */\nexport type ContentModelHandlerMap = {\n    /**\n     * Content Model type for ContentModelBlock\n     */\n    block: ContentModelBlockHandler<ContentModelBlock>;\n\n    /**\n     * Content Model type for child models of ContentModelBlockGroup\n     */\n    blockGroupChildren: ContentModelHandler<ContentModelBlockGroup>;\n\n    /**\n     * Content Model type for ContentModelBr\n     */\n    br: ContentModelSegmentHandler<ContentModelBr>;\n\n    /**\n     * Content Model type for child models of ContentModelEntity\n     */\n    entityBlock: ContentModelBlockHandler<ContentModelEntity>;\n\n    /**\n     * Content Model type for child models of ContentModelEntity\n     */\n    entitySegment: ContentModelSegmentHandler<ContentModelEntity>;\n\n    /**\n     * Content Model type for ContentModelGeneralBlock\n     */\n    generalBlock: ContentModelBlockHandler<ContentModelGeneralBlock>;\n\n    /**\n     * Content Model type for ContentModelGeneralBlock\n     */\n    generalSegment: ContentModelSegmentHandler<ContentModelGeneralSegment>;\n\n    /**\n     * Content Model type for ContentModelHR\n     */\n    divider: ContentModelBlockHandler<ContentModelDivider>;\n\n    /**\n     * Content Model type for ContentModelImage\n     */\n    image: ContentModelSegmentHandler<ContentModelImage>;\n\n    /**\n     * Content Model type for list group of ContentModelListItem\n     */\n    list: ContentModelBlockHandler<ContentModelListItem>;\n\n    /**\n     * Content Model type for list item of ContentModelListItem\n     */\n    listItem: ContentModelBlockHandler<ContentModelListItem>;\n\n    /**\n     * Content Model type for ContentModelParagraph\n     */\n    paragraph: ContentModelBlockHandler<ContentModelParagraph>;\n\n    /**\n     * Content Model type for ContentModelFormatContainer\n     */\n    formatContainer: ContentModelBlockHandler<ContentModelFormatContainer>;\n\n    /**\n     * Content Model type for ContentModelSegment\n     */\n    segment: ContentModelSegmentHandler<ContentModelSegment>;\n\n    /**\n     * Content Model type for ContentModelCode\n     */\n    segmentDecorator: ContentModelSegmentHandler<ContentModelSegment>;\n\n    /**\n     * Content Model type for ContentModelTable\n     */\n    table: ContentModelBlockHandler<ContentModelTable>;\n\n    /**\n     * Content Model type for ContentModelText\n     */\n    text: ContentModelSegmentHandler<ContentModelText>;\n};\n\n/**\n * Function type to apply metadata value into format\n * @param metadata The metadata object to apply\n * @param format The format object to apply metadata to\n * @param context Content Model to DOM context\n */\nexport type ApplyMetadata<TMetadata, TFormat extends ContentModelFormatBase> = (\n    metadata: TMetadata | null,\n    format: TFormat,\n    context: ModelToDomContext\n) => void;\n\n/**\n * Metadata applier interface\n */\nexport interface MetadataApplier<TMetadata, TFormat extends ContentModelFormatBase> {\n    /**\n     * The metadata applier function\n     */\n    applierFunction: ApplyMetadata<TMetadata, TFormat>;\n\n    /**\n     * @optional Metadata definition, used for validate the metadata object\n     */\n    metadataDefinition?: Definition<TMetadata>;\n}\n\n/**\n * Map of metadata handlers\n */\nexport type MetadataAppliers = {\n    /**\n     * Metadata handler for list item\n     */\n    listItem?: MetadataApplier<ListMetadataFormat, ContentModelListItemFormat>;\n\n    /**\n     * Metadata handler for list level\n     */\n    listLevel?: MetadataApplier<ListMetadataFormat, ContentModelListItemLevelFormat>;\n};\n\n/**\n * An optional callback that will be called when a DOM node is created\n * @param modelElement The related Content Model element\n * @param node The node created for this model element\n */\nexport type OnNodeCreated = (\n    modelElement:\n        | ContentModelBlock\n        | ContentModelBlockGroup\n        | ContentModelSegment\n        | ContentModelDecorator\n        | ContentModelTableRow,\n    node: Node\n) => void;\n\n/**\n * Represents settings to customize DOM to Content Model conversion\n */\nexport interface ModelToDomSettings {\n    /**\n     * Map of Content Model handlers\n     */\n    modelHandlers: ContentModelHandlerMap;\n\n    /**\n     * Map of format appliers\n     */\n    formatAppliers: FormatAppliersPerCategory;\n\n    /**\n     * Map of metadata appliers\n     */\n    metadataAppliers: MetadataAppliers;\n\n    /**\n     * Default Content Model to DOM handlers before overriding.\n     * This provides a way to call original handler from an overridden handler function\n     */\n    defaultModelHandlers: Readonly<ContentModelHandlerMap>;\n\n    /**\n     * Default format parsers before overriding.\n     * This provides a way to call original format applier from an overridden applier function\n     */\n    defaultFormatAppliers: Readonly<FormatAppliers>;\n\n    /**\n     * An optional callback that will be called when a DOM node is created\n     * @param modelElement The related Content Model element\n     * @param node The node created for this model element\n     */\n    onNodeCreated?: OnNodeCreated;\n}\n"]}

package/lib/editor/ContextMenuProvider.d.ts

@@ -0,0 +1,12 @@
+import type { EditorPlugin } from './EditorPlugin';
+/**
+ * An extended Editor plugin interface which supports providing context menu items
+ */
+export interface ContextMenuProvider<T> extends EditorPlugin {
+    /**
+     * A callback to return context menu items
+     * @param target Target node that triggered a ContextMenu event
+     * @returns An array of context menu items, or null means no items needed
+     */
+    getContextMenuItems: (target: Node) => T[] | null;
+}

package/lib/{event/ContentModelBeforePasteEvent.js → editor/ContextMenuProvider.js}

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

package/lib/editor/ContextMenuProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextMenuProvider.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/ContextMenuProvider.ts"],"names":[],"mappings":"","sourcesContent":["import type { EditorPlugin } from './EditorPlugin';\n\n/**\n * An extended Editor plugin interface which supports providing context menu items\n */\nexport interface ContextMenuProvider<T> extends EditorPlugin {\n    /**\n     * A callback to return context menu items\n     * @param target Target node that triggered a ContextMenu event\n     * @returns An array of context menu items, or null means no items needed\n     */\n    getContextMenuItems: (target: Node) => T[] | null;\n}\n"]}

package/lib/editor/EditorPlugin.d.ts

@@ -0,0 +1,40 @@
+import type { PluginEvent } from '../event/PluginEvent';
+import type { IStandaloneEditor } from './IStandaloneEditor';
+/**
+ * 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: IStandaloneEditor) => 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/{context/ColorManager.js → editor/EditorPlugin.js}

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

package/lib/editor/EditorPlugin.js.map

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

package/lib/editor/IStandaloneEditor.d.ts

@@ -1,9 +1,10 @@
+import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
+import type { PluginEventType } from '../event/PluginEventType';
 import type { PasteType } from '../enum/PasteType';
 import type { ClipboardData } from '../parameter/ClipboardData';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
 import type { SnapshotsManager } from '../parameter/SnapshotsManager';
 import type { Snapshot } from '../parameter/Snapshot';
-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';
@@ -12,7 +13,8 @@ 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 { DarkColorHandler, PluginEventData, PluginEventFromType, PluginEventType } from 'roosterjs-editor-types';
+import type { DarkColorHandler } from '../context/DarkColorHandler';
+import type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';
 /**
  * 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)
@@ -84,7 +86,7 @@ export interface IStandaloneEditor {
      * @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>;
+    triggerEvent<T extends PluginEventType>(eventType: T, data: PluginEventData<T>, broadcast?: boolean): PluginEventFromType<T>;
     /**
      * Get undo snapshots manager
      */
@@ -106,10 +108,16 @@ export interface IStandaloneEditor {
      * @returns current zoom scale number
      */
     getZoomScale(): number;
+    /**
+     * Set 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
+     */
+    setZoomScale(scale: number): void;
     /**
      * Add a single undo snapshot to undo stack
      */
-    takeSnapshot(): void;
+    takeSnapshot(): Snapshot | null;
     /**
      * Restore an undo snapshot into editor
      * @param snapshot The snapshot to restore
@@ -156,7 +164,7 @@ export interface IStandaloneEditor {
     /**
      * Get a darkColorHandler object for this editor.
      */
-    getDarkColorHandler(): DarkColorHandler;
+    getColorManager(): DarkColorHandler;
     /**
      * Dispose this editor, dispose all plugins and custom data
      */
@@ -166,4 +174,11 @@ export interface IStandaloneEditor {
      * @returns true if focus is in editor, otherwise false
      */
     hasFocus(): boolean;
+    /**
+     * Get a function to convert HTML string to trusted HTML string.
+     * By default it will just return the input HTML directly. To override this behavior,
+     * pass your own trusted HTML handler to EditorOptions.trustedHTMLHandler
+     * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/trusted-types
+     */
+    getTrustedHTMLHandler(): TrustedHTMLHandler;
 }

package/lib/editor/IStandaloneEditor.js.map

@@ -1 +1 @@
-{"version":3,"file":"IStandaloneEditor.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/IStandaloneEditor.ts"],"names":[],"mappings":"","sourcesContent":["import type { PasteType } from '../enum/PasteType';\nimport type { ClipboardData } from '../parameter/ClipboardData';\nimport type { DOMEventRecord } from '../parameter/DOMEventRecord';\nimport type { SnapshotsManager } from '../parameter/SnapshotsManager';\nimport type { Snapshot } from '../parameter/Snapshot';\nimport 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    DarkColorHandler,\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 | null): 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    /**\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     * Get undo snapshots manager\n     */\n    getSnapshotsManager(): SnapshotsManager;\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     * Set the dark mode state and transforms the content to match the new state.\n     * @param isDarkMode The next status of dark mode. True if the editor should be in dark mode, false if not.\n     */\n    setDarkModeState(isDarkMode?: boolean): void;\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    /**\n     * Add a single undo snapshot to undo stack\n     */\n    takeSnapshot(): void;\n\n    /**\n     * Restore an undo snapshot into editor\n     * @param snapshot The snapshot to restore\n     */\n    restoreSnapshot(snapshot: Snapshot): void;\n\n    /**\n     * Check if editor is in IME input sequence\n     * @returns True if editor is in IME input sequence, otherwise false\n     */\n    isInIME(): boolean;\n\n    /**\n     * Attach a DOM event to the editor content DIV\n     * @param eventMap A map from event name to its handler\n     */\n    attachDomEvent(eventMap: Record<string, DOMEventRecord>): () => void;\n\n    /**\n     * Check if editor is in Shadow Edit mode\n     */\n    isInShadowEdit(): boolean;\n\n    /**\n     * Make the editor in \"Shadow Edit\" mode.\n     * In Shadow Edit mode, all format change will finally be ignored.\n     * This can be used for building a live preview feature for format button, to allow user\n     * see format result without really apply it.\n     * This function can be called repeated. If editor is already in shadow edit mode, we can still\n     * use this function to do more shadow edit operation.\n     */\n    startShadowEdit(): void;\n\n    /**\n     * Leave \"Shadow Edit\" mode, all changes made during shadow edit will be discarded\n     */\n    stopShadowEdit(): void;\n\n    /**\n     * Check if the given DOM node is in editor\n     * @param node The node to check\n     */\n    isNodeInEditor(node: Node): boolean;\n\n    /**\n     * Paste into editor using a clipboardData object\n     * @param clipboardData Clipboard data retrieved from clipboard\n     * @param pasteType Type of paste\n     */\n    pasteFromClipboard(clipboardData: ClipboardData, pasteType?: PasteType): void;\n\n    /**\n     * Get a darkColorHandler object for this editor.\n     */\n    getDarkColorHandler(): DarkColorHandler;\n\n    /**\n     * Dispose this editor, dispose all plugins and custom data\n     */\n    dispose(): void;\n    /**\n     * Check if focus is in editor now\n     * @returns true if focus is in editor, otherwise false\n     */\n    hasFocus(): boolean;\n}\n"]}
+{"version":3,"file":"IStandaloneEditor.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/IStandaloneEditor.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';\nimport type { PluginEventType } from '../event/PluginEventType';\nimport type { PasteType } from '../enum/PasteType';\nimport type { ClipboardData } from '../parameter/ClipboardData';\nimport type { DOMEventRecord } from '../parameter/DOMEventRecord';\nimport type { SnapshotsManager } from '../parameter/SnapshotsManager';\nimport type { Snapshot } from '../parameter/Snapshot';\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 { DarkColorHandler } from '../context/DarkColorHandler';\nimport type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';\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 | null): 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    /**\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    triggerEvent<T extends PluginEventType>(\n        eventType: T,\n        data: PluginEventData<T>,\n        broadcast?: boolean\n    ): PluginEventFromType<T>;\n\n    /**\n     * Get undo snapshots manager\n     */\n    getSnapshotsManager(): SnapshotsManager;\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     * Set the dark mode state and transforms the content to match the new state.\n     * @param isDarkMode The next status of dark mode. True if the editor should be in dark mode, false if not.\n     */\n    setDarkModeState(isDarkMode?: boolean): void;\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    /**\n     * Set 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     */\n    setZoomScale(scale: number): void;\n\n    /**\n     * Add a single undo snapshot to undo stack\n     */\n    takeSnapshot(): Snapshot | null;\n\n    /**\n     * Restore an undo snapshot into editor\n     * @param snapshot The snapshot to restore\n     */\n    restoreSnapshot(snapshot: Snapshot): void;\n\n    /**\n     * Check if editor is in IME input sequence\n     * @returns True if editor is in IME input sequence, otherwise false\n     */\n    isInIME(): boolean;\n\n    /**\n     * Attach a DOM event to the editor content DIV\n     * @param eventMap A map from event name to its handler\n     */\n    attachDomEvent(eventMap: Record<string, DOMEventRecord>): () => void;\n\n    /**\n     * Check if editor is in Shadow Edit mode\n     */\n    isInShadowEdit(): boolean;\n\n    /**\n     * Make the editor in \"Shadow Edit\" mode.\n     * In Shadow Edit mode, all format change will finally be ignored.\n     * This can be used for building a live preview feature for format button, to allow user\n     * see format result without really apply it.\n     * This function can be called repeated. If editor is already in shadow edit mode, we can still\n     * use this function to do more shadow edit operation.\n     */\n    startShadowEdit(): void;\n\n    /**\n     * Leave \"Shadow Edit\" mode, all changes made during shadow edit will be discarded\n     */\n    stopShadowEdit(): void;\n\n    /**\n     * Check if the given DOM node is in editor\n     * @param node The node to check\n     */\n    isNodeInEditor(node: Node): boolean;\n\n    /**\n     * Paste into editor using a clipboardData object\n     * @param clipboardData Clipboard data retrieved from clipboard\n     * @param pasteType Type of paste\n     */\n    pasteFromClipboard(clipboardData: ClipboardData, pasteType?: PasteType): void;\n\n    /**\n     * Get a darkColorHandler object for this editor.\n     */\n    getColorManager(): DarkColorHandler;\n\n    /**\n     * Dispose this editor, dispose all plugins and custom data\n     */\n    dispose(): void;\n    /**\n     * Check if focus is in editor now\n     * @returns true if focus is in editor, otherwise false\n     */\n    hasFocus(): boolean;\n\n    /**\n     * Get a function to convert HTML string to trusted HTML string.\n     * By default it will just return the input HTML directly. To override this behavior,\n     * pass your own trusted HTML handler to EditorOptions.trustedHTMLHandler\n     * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/trusted-types\n     */\n    getTrustedHTMLHandler(): TrustedHTMLHandler;\n}\n"]}

package/lib/editor/PluginWithState.d.ts

@@ -0,0 +1,11 @@
+import type { EditorPlugin } from './EditorPlugin';
+/**
+ * An editor plugin which have a state object stored on editor core
+ * so that editor and core api can access it
+ */
+export interface PluginWithState<T> extends EditorPlugin {
+    /**
+     * Get plugin state object
+     */
+    getState(): T;
+}

package/lib/{event/ContentModelContentChangedEvent.js → editor/PluginWithState.js}

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

package/lib/editor/PluginWithState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginWithState.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/PluginWithState.ts"],"names":[],"mappings":"","sourcesContent":["import type { EditorPlugin } from './EditorPlugin';\n\n/**\n * An editor plugin which have a state object stored on editor core\n * so that editor and core api can access it\n */\nexport interface PluginWithState<T> extends EditorPlugin {\n    /**\n     * Get plugin state object\n     */\n    getState(): T;\n}\n"]}

package/lib/editor/StandaloneEditorCore.d.ts

@@ -1,11 +1,13 @@
+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/FormatWithContentModelContext';
-import type { DarkColorHandler, EditorPlugin, PluginEvent, Rect, TrustedHTMLHandler } from 'roosterjs-editor-types';
+import type { DarkColorHandler } from '../context/DarkColorHandler';
 import type { ContentModelDocument } from '../group/ContentModelDocument';
-import type { StandaloneEditorCorePluginState } from '../pluginState/StandaloneEditorPluginState';
 import type { DOMSelection } from '../selection/DOMSelection';
 import type { DomToModelOption } from '../context/DomToModelOption';
 import type { DomToModelSettings } from '../context/DomToModelSettings';
@@ -13,6 +15,8 @@ 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, FormatWithContentModelOptions } from '../parameter/FormatWithContentModelOptions';
 /**
  * Create a EditorContext object used by ContentModel API
@@ -77,7 +81,7 @@ export declare type TriggerEvent = (core: StandaloneEditorCore, pluginEvent: Plu
  * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState
  * when undo/redo to this snapshot
  */
-export declare type AddUndoSnapshot = (core: StandaloneEditorCore, canUndoByBackspace: boolean, entityStates?: EntityState[]) => void;
+export declare type AddUndoSnapshot = (core: StandaloneEditorCore, canUndoByBackspace: boolean, entityStates?: EntityState[]) => Snapshot | null;
 /**
  * Retrieves the rect of the visible viewport of the editor.
  * @param core The StandaloneEditorCore object
@@ -219,7 +223,7 @@ export interface StandaloneCoreApiMap {
 /**
  * Represents the core data structure of a Content Model editor
  */
-export interface StandaloneEditorCore extends StandaloneEditorCorePluginState {
+export interface StandaloneEditorCore extends PluginState {
     /**
      * The content DIV element of this editor
      */

package/lib/editor/StandaloneEditorCore.js.map

@@ -1 +1 @@
-{"version":3,"file":"StandaloneEditorCore.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/StandaloneEditorCore.ts"],"names":[],"mappings":"","sourcesContent":["import type { ClipboardData } from '../parameter/ClipboardData';\nimport type { PasteType } from '../enum/PasteType';\nimport type { DOMEventRecord } from '../parameter/DOMEventRecord';\nimport type { Snapshot } from '../parameter/Snapshot';\nimport type { EntityState } from '../parameter/FormatWithContentModelContext';\nimport type {\n    DarkColorHandler,\n    EditorPlugin,\n    PluginEvent,\n    Rect,\n    TrustedHTMLHandler,\n} from 'roosterjs-editor-types';\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\nimport type { StandaloneEditorCorePluginState } 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 * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent\n */\nexport type SetDOMSelection = (\n    core: StandaloneEditorCore,\n    selection: DOMSelection | null,\n    skipSelectionChangedEvent?: boolean\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,\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 * 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 * Add an undo snapshot to current undo snapshot stack\n * @param core The StandaloneEditorCore object\n * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\n * @param entityStates @optional Entity states related to this snapshot.\n * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\n * when undo/redo to this snapshot\n */\nexport type AddUndoSnapshot = (\n    core: StandaloneEditorCore,\n    canUndoByBackspace: boolean,\n    entityStates?: EntityState[]\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 * 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 * 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, DOMEventRecord>\n) => () => void;\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, snapshot: Snapshot) => void;\n\n/**\n * Paste into editor using a clipboardData object\n * @param core The StandaloneEditorCore object.\n * @param clipboardData Clipboard data retrieved from clipboard\n * @param pasteType Type of content to paste. @default normal\n */\nexport type Paste = (\n    core: StandaloneEditorCore,\n    clipboardData: ClipboardData,\n    pasteType: PasteType\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     * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent\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     * 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     * Add an undo snapshot to current undo snapshot stack\n     * @param core The StandaloneEditorCore object\n     * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\n     * @param entityStates @optional Entity states related to this snapshot.\n     * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\n     * when undo/redo to this snapshot\n     */\n    addUndoSnapshot: AddUndoSnapshot;\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     * 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     */\n    attachDomEvent: AttachDomEvent;\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     * Paste into editor using a clipboardData object\n     * @param editor The editor to paste content into\n     * @param clipboardData Clipboard data retrieved from clipboard\n     * @param pasteType Type of content to paste. @default normal\n     */\n    paste: Paste;\n}\n\n/**\n * Represents the core data structure of a Content Model editor\n */\nexport interface StandaloneEditorCore extends StandaloneEditorCorePluginState {\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     * Settings used by DOM to Content Model conversion\n     */\n    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;\n\n    /**\n     * Settings used by Content Model to DOM conversion\n     */\n    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;\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     * A callback to be invoked when any exception is thrown during disposing editor\n     * @param plugin The plugin that causes exception\n     * @param error The error object we got\n     */\n    readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;\n\n    /**\n     * @deprecated Will be removed soon.\n     * Current zoom scale, default value is 1\n     * When editor is put under a zoomed container, need to pass the zoom scale number using this property\n     * to let editor behave correctly especially for those mouse drag/drop behaviors\n     */\n    zoomScale: number;\n}\n\n/**\n * Default DOM and Content Model conversion settings for an editor\n */\nexport interface ContentModelSettings<OptionType, ConfigType> {\n    /**\n     * Built in options used by editor\n     */\n    builtIn: OptionType;\n\n    /**\n     * Customize options passed in from Editor Options, used for overwrite default option.\n     * This will also be used by copy/paste\n     */\n    customized: OptionType;\n\n    /**\n     * Configuration calculated from default and customized options.\n     * This is a cached object so that we don't need to cache it every time when we use Content Model\n     */\n    calculated: ConfigType;\n}\n"]}
+{"version":3,"file":"StandaloneEditorCore.js","sourceRoot":"","sources":["../../../../packages-content-model/roosterjs-content-model-types/lib/editor/StandaloneEditorCore.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginEvent } from '../event/PluginEvent';\nimport type { PluginState } from '../pluginState/PluginState';\nimport type { EditorPlugin } from './EditorPlugin';\nimport type { ClipboardData } from '../parameter/ClipboardData';\nimport type { PasteType } from '../enum/PasteType';\nimport type { DOMEventRecord } from '../parameter/DOMEventRecord';\nimport type { Snapshot } from '../parameter/Snapshot';\nimport type { EntityState } from '../parameter/FormatWithContentModelContext';\nimport type { DarkColorHandler } from '../context/DarkColorHandler';\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\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 { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';\nimport type { Rect } from '../parameter/Rect';\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 * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent\n */\nexport type SetDOMSelection = (\n    core: StandaloneEditorCore,\n    selection: DOMSelection | null,\n    skipSelectionChangedEvent?: boolean\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,\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 * 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 * Add an undo snapshot to current undo snapshot stack\n * @param core The StandaloneEditorCore object\n * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\n * @param entityStates @optional Entity states related to this snapshot.\n * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\n * when undo/redo to this snapshot\n */\nexport type AddUndoSnapshot = (\n    core: StandaloneEditorCore,\n    canUndoByBackspace: boolean,\n    entityStates?: EntityState[]\n) => Snapshot | null;\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 * 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 * 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, DOMEventRecord>\n) => () => void;\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, snapshot: Snapshot) => void;\n\n/**\n * Paste into editor using a clipboardData object\n * @param core The StandaloneEditorCore object.\n * @param clipboardData Clipboard data retrieved from clipboard\n * @param pasteType Type of content to paste. @default normal\n */\nexport type Paste = (\n    core: StandaloneEditorCore,\n    clipboardData: ClipboardData,\n    pasteType: PasteType\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     * @param skipSelectionChangedEvent @param Pass true to skip triggering a SelectionChangedEvent\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     * 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     * Add an undo snapshot to current undo snapshot stack\n     * @param core The StandaloneEditorCore object\n     * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete).\n     * @param entityStates @optional Entity states related to this snapshot.\n     * Each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\n     * when undo/redo to this snapshot\n     */\n    addUndoSnapshot: AddUndoSnapshot;\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     * 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     */\n    attachDomEvent: AttachDomEvent;\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     * Paste into editor using a clipboardData object\n     * @param editor The editor to paste content into\n     * @param clipboardData Clipboard data retrieved from clipboard\n     * @param pasteType Type of content to paste. @default normal\n     */\n    paste: Paste;\n}\n\n/**\n * Represents the core data structure of a Content Model editor\n */\nexport interface StandaloneEditorCore extends PluginState {\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     * Settings used by DOM to Content Model conversion\n     */\n    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;\n\n    /**\n     * Settings used by Content Model to DOM conversion\n     */\n    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;\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     * A callback to be invoked when any exception is thrown during disposing editor\n     * @param plugin The plugin that causes exception\n     * @param error The error object we got\n     */\n    readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;\n\n    /**\n     * @deprecated Will be removed soon.\n     * Current zoom scale, default value is 1\n     * When editor is put under a zoomed container, need to pass the zoom scale number using this property\n     * to let editor behave correctly especially for those mouse drag/drop behaviors\n     */\n    zoomScale: number;\n}\n\n/**\n * Default DOM and Content Model conversion settings for an editor\n */\nexport interface ContentModelSettings<OptionType, ConfigType> {\n    /**\n     * Built in options used by editor\n     */\n    builtIn: OptionType;\n\n    /**\n     * Customize options passed in from Editor Options, used for overwrite default option.\n     * This will also be used by copy/paste\n     */\n    customized: OptionType;\n\n    /**\n     * Configuration calculated from default and customized options.\n     * This is a cached object so that we don't need to cache it every time when we use Content Model\n     */\n    calculated: ConfigType;\n}\n"]}

package/lib/editor/StandaloneEditorCorePlugins.d.ts

@@ -1,3 +1,4 @@
+import type { PluginWithState } from './PluginWithState';
 import type { CopyPastePluginState } from '../pluginState/CopyPastePluginState';
 import type { UndoPluginState } from '../pluginState/UndoPluginState';
 import type { SelectionPluginState } from '../pluginState/SelectionPluginState';
@@ -6,7 +7,6 @@ import type { LifecyclePluginState } from '../pluginState/LifecyclePluginState';
 import type { DOMEventPluginState } from '../pluginState/DOMEventPluginState';
 import type { ContentModelCachePluginState } from '../pluginState/ContentModelCachePluginState';
 import type { ContentModelFormatPluginState } from '../pluginState/ContentModelFormatPluginState';
-import type { PluginWithState } from 'roosterjs-editor-types';
 /**
  * Core plugins for standalone editor
  */