roosterjs-content-model-dom 0.28.0 → 9.1.0

package/README.md

@@ -6,13 +6,17 @@ Rooster is a framework-independent JavaScript rich-text editor neatly nested
 inside one HTML `<div>` element. Editing operations performed by end users are
 handled in simple ways to generate the final HTML.
 
-To view the sample site, please click the link below:
+Rooster is working on top of a middle layer data structure called "Content Model".
+All format API and editing operation are using this Content Model layer as content format,
+and finally convert to HTML and show it in editor.
 
-[RoosterJs Sample Site](https://microsoft.github.io/roosterjs/index.html).
+To view the demo site, please click the link below:
 
-## Upgrade from RoosterJs 7.\*
+[RoosterJs Demo Site](https://microsoft.github.io/roosterjs/index.html).
 
-Please see [here](https://github.com/microsoft/roosterjs/wiki/RoosterJs-8).
+## Upgrade from RoosterJs 8.\*
+
+Please see [here](https://github.com/microsoft/roosterjs/wiki/RoosterJs-9).
 
 ## Features
 
@@ -25,24 +29,22 @@ Rooster contains 6 basic packages.
    `createEditor()` function in roosterjs to create an editor with default
    configurations.
 
-2. [roosterjs-editor-core](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_core.html):
-   Defines the core editor and plugin infrastructure. Use `roosterjs-editor-core`
+2. [roosterjs-content-model-core](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_content_model_core.html):
+   Defines the core editor and plugin infrastructure. Use `roosterjs-content-model-core`
    instead of `roosterjs` to build and customize your own editor.
 
-3. [roosterjs-editor-api](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_api.html):
+3. [roosterjs-content-model-api](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_content_model_api.html):
    Defines APIs for editor operations. Use these APIs to modify content and
-   formatting in the editor you built using `roosterjs-editor-core`.
+   formatting in the editor you built using `roosterjs-content-model-core`.
 
-4. [roosterjs-editor-dom](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_dom.html):
-   Defines APIs for DOM operations. Use `roosterjs-editor-api` instead unless
-   you want to access DOM API directly.
+4. [roosterjs-content-model-dom](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_content_model_dom.html):
+   Defines APIs for Content Model and DOM operations. This package do conversion between DOM tree and roosterjs Content Model.
 
-5. [roosterjs-editor-plugins](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_plugins.html):
-   Defines basic plugins for common features. Examples: making hyperlinks,
-   pasting HTML content, inserting inline images.
+5. [roosterjs-content-model-plugins](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_content_model_plugins.html):
+   Defines basic plugins for common features.
 
-6. [roosterjs-editor-types](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_types.html):
-   Defines public interfaces and enumerations.
+6. [roosterjs-content-model-types](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_content_model_types.html):
+   Defines public interfaces and enumerations, including Content Model types, API parameters and other types.
 
 There are also some extension packages to provide additional functionalities.
 
@@ -52,30 +54,38 @@ There are also some extension packages to provide additional functionalities.
 2. [roosterjs-react](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_react.html):
    Provide a React wrapper of roosterjs so it can be easily used with React.
 
-3. [roosterjs-editor-types-compatible](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_types_compatible.html):
-   Provide types that are compatible with isolatedModules mode. When using isolatedModules mode,
-   "const enum" will not work correctly, this package provides enums with prefix "Compatible" in
-   their names and they have the same value with const enums in roosterjs-editor-types package
+To be compatible with old (8.\*) versions, you can use `EditorAdapter` class from the following package which can act as a 8.\* Editor:
+
+1. [roosterjs-editor-adapter](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_adapter.html):
+   Provide a adapter class `EditorAdapter` to work with Editor (9.\*) and legacy plugins (via [EditorAdapterOptions.legacyPlugins](https://microsoft.github.io/roosterjs/docs/interfaces/roosterjs_editor_adapter.editoradapteroptions.html#legacyplugins))
+
+And the following packages are for old (8.\*) compatibility:
+
+1. [roosterjs-editor-core](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_core.html):
+2. [roosterjs-editor-api](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_api.html):
+3. [roosterjs-editor-dom](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_dom.html):
+4. [roosterjs-editor-plugins](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_plugins.html):
+5. [roosterjs-editor-types](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_types.html):
+6. [roosterjs-editor-types-compatible](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_types_compatible.html):
 
 ### APIs
 
-Rooster provides DOM level APIs (in `roosterjs-editor-dom`), core APIs (in `roosterjs-editor-core`), and formatting APIs
-(in `roosterjs-editor-api`) to perform editing operations.
+Rooster provides Content Model level APIs (in `roosterjs-content-model-dom`), core APIs (in `roosterjs-content-model-core`), and formatting APIs
+(in `roosterjs-content-modelapi`) to perform editing operations.
 
-`roosterjs-editor-dom` provides several levels of DOM operations:
+`roosterjs-content-model-dom` provides several levels of Content Model operations:
 
--   Perform basic DOM operations such as `wrap()`, `unwrap()`, ...
--   Wrap a given DOM node with `InlineElement` or `BlockElement` and perform
-    operations with DOM Walker API.
--   Perform DOM operations on a given scope using scopers.
--   Travel among `InlineElements` and `BlockElements` with scope using
-    ContentTraverser API.
+-   Create Content Model elements
+-   Convert DOM tree to Content Model
+-   Convert Content Model to DOM tree
+-   Format handlers
+-   A few DOM level API
 
-`roosterjs-editor-core` provides APIs for editor core. Editor class will call such
-APIs to perform basic editor operations. These APIs are overridable by specifying
+`roosterjs-content-model-core` provides APIs for editor core. Editor class will call such
+APIs to perform basic editor operations. These APIs can be overridden by specifying
 API overrides in Editor options when creating the editor.
 
-`roosterjs-editor-api` provides APIs for scenario-based operations triggered by
+`roosterjs-content-model-api` provides APIs for scenario-based operations triggered by
 user interaction.
 
 ## Plugins
@@ -99,7 +109,7 @@ class HelloRooster implements EditorPlugin {
     dispose() {}
 
     onPluginEvent(e: PluginEvent) {
-        if (e.eventType == PluginEventType.KeyPress && e.rawEvent.which == 65) {
+        if (e.eventType == 'input' && e.rawEvent.which == 65) {
             alert('Hello Rooster');
         }
     }
@@ -114,9 +124,9 @@ Install via NPM or Yarn:
 
 You can also install sub packages separately:
 
-`yarn add roosterjs-editor-core`
+`yarn add roosterjs-content-model-core`
 
-`yarn add roosterjs-editor-api`
+`yarn add roosterjs-content-model-api`
 
 `...`
 
@@ -161,9 +171,9 @@ In order to run the code below, you may also need to install [webpack](https://w
 
 ## Sample code
 
-To view the sample site, please click [here](https://microsoft.github.io/roosterjs/index.html).
+To view the demo site, please click [here](https://microsoft.github.io/roosterjs/index.html).
 
-To build the sample site code yourself, follow these instructions:
+To build the demo site code yourself, follow these instructions:
 
 1. Get dependencies using [yarn](https://yarnpkg.com) or [npm](https://www.npmjs.com/):
 

package/lib/config/defaultContentModelFormatMap.js

@@ -8,6 +8,7 @@ exports.defaultContentModelFormatMap = void 0;
 exports.defaultContentModelFormatMap = {
     a: {
         underline: true,
+        textColor: undefined, // Set to undefined to force override color from parent element so we can write correct link color if any, because browser will assign a default color for link if it doesn't have one
     },
     blockquote: {
         marginTop: '1em',

package/lib/config/defaultContentModelFormatMap.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaultContentModelFormatMap.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-dom/lib/config/defaultContentModelFormatMap.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACU,QAAA,4BAA4B,GAA6B;IAClE,CAAC,EAAE;QACC,SAAS,EAAE,IAAI;KAClB;IACD,UAAU,EAAE;QACR,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,MAAM;QAClB,WAAW,EAAE,MAAM;KACtB;IACD,IAAI,EAAE;QACF,UAAU,EAAE,WAAW;KAC1B;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,KAAK;KAClB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,OAAO;KACpB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;KACrB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,KAAK,EAAE,wFAAwF;KAC5G;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;KACrB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;KACrB;IACD,CAAC,EAAE;QACC,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;KACtB;IACD,GAAG,EAAE;QACD,UAAU,EAAE,WAAW;QACvB,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;KACtB;CACJ,CAAC","sourcesContent":["import type { DefaultImplicitFormatMap } from 'roosterjs-content-model-types';\n\n/**\n * @internal\n * A map from tag name to its default implicit formats\n */\nexport const defaultContentModelFormatMap: DefaultImplicitFormatMap = {\n    a: {\n        underline: true,\n    },\n    blockquote: {\n        marginTop: '1em',\n        marginBottom: '1em',\n        marginLeft: '40px',\n        marginRight: '40px',\n    },\n    code: {\n        fontFamily: 'monospace',\n    },\n    h1: {\n        fontWeight: 'bold',\n        fontSize: '2em',\n    },\n    h2: {\n        fontWeight: 'bold',\n        fontSize: '1.5em',\n    },\n    h3: {\n        fontWeight: 'bold',\n        fontSize: '1.17em',\n    },\n    h4: {\n        fontWeight: 'bold',\n        fontSize: '1em', // Set this default value here to overwrite existing font size when change heading level\n    },\n    h5: {\n        fontWeight: 'bold',\n        fontSize: '0.83em',\n    },\n    h6: {\n        fontWeight: 'bold',\n        fontSize: '0.67em',\n    },\n    p: {\n        marginTop: '1em',\n        marginBottom: '1em',\n    },\n    pre: {\n        fontFamily: 'monospace',\n        whiteSpace: 'pre',\n        marginTop: '1em',\n        marginBottom: '1em',\n    },\n};\n"]}
+{"version":3,"file":"defaultContentModelFormatMap.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-dom/lib/config/defaultContentModelFormatMap.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACU,QAAA,4BAA4B,GAA6B;IAClE,CAAC,EAAE;QACC,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,SAAS,EAAE,sLAAsL;KAC/M;IACD,UAAU,EAAE;QACR,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,MAAM;QAClB,WAAW,EAAE,MAAM;KACtB;IACD,IAAI,EAAE;QACF,UAAU,EAAE,WAAW;KAC1B;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,KAAK;KAClB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,OAAO;KACpB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;KACrB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,KAAK,EAAE,wFAAwF;KAC5G;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;KACrB;IACD,EAAE,EAAE;QACA,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;KACrB;IACD,CAAC,EAAE;QACC,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;KACtB;IACD,GAAG,EAAE;QACD,UAAU,EAAE,WAAW;QACvB,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;KACtB;CACJ,CAAC","sourcesContent":["import type { DefaultImplicitFormatMap } from 'roosterjs-content-model-types';\n\n/**\n * @internal\n * A map from tag name to its default implicit formats\n */\nexport const defaultContentModelFormatMap: DefaultImplicitFormatMap = {\n    a: {\n        underline: true,\n        textColor: undefined, // Set to undefined to force override color from parent element so we can write correct link color if any, because browser will assign a default color for link if it doesn't have one\n    },\n    blockquote: {\n        marginTop: '1em',\n        marginBottom: '1em',\n        marginLeft: '40px',\n        marginRight: '40px',\n    },\n    code: {\n        fontFamily: 'monospace',\n    },\n    h1: {\n        fontWeight: 'bold',\n        fontSize: '2em',\n    },\n    h2: {\n        fontWeight: 'bold',\n        fontSize: '1.5em',\n    },\n    h3: {\n        fontWeight: 'bold',\n        fontSize: '1.17em',\n    },\n    h4: {\n        fontWeight: 'bold',\n        fontSize: '1em', // Set this default value here to overwrite existing font size when change heading level\n    },\n    h5: {\n        fontWeight: 'bold',\n        fontSize: '0.83em',\n    },\n    h6: {\n        fontWeight: 'bold',\n        fontSize: '0.67em',\n    },\n    p: {\n        marginTop: '1em',\n        marginBottom: '1em',\n    },\n    pre: {\n        fontFamily: 'monospace',\n        whiteSpace: 'pre',\n        marginTop: '1em',\n        marginBottom: '1em',\n    },\n};\n"]}

package/lib/constants/BulletListType.d.ts

@@ -0,0 +1,49 @@
+/**
+ *  Enum used to control the different types of bullet list
+ */
+export declare const BulletListType: {
+    /**
+     * Minimum value of the enum
+     */
+    Min: number;
+    /**
+     * Bullet triggered by *
+     */
+    Disc: number;
+    /**
+     * Bullet triggered by -
+     */
+    Dash: number;
+    /**
+     * Bullet triggered by --
+     */
+    Square: number;
+    /**
+     * Bullet triggered by >
+     */
+    ShortArrow: number;
+    /**
+     * Bullet triggered by ->
+     */
+    LongArrow: number;
+    /**
+     * Bullet triggered by =>
+     */
+    UnfilledArrow: number;
+    /**
+     * Bullet triggered by —
+     */
+    Hyphen: number;
+    /**
+     * Bullet triggered by -->
+     */
+    DoubleLongArrow: number;
+    /**
+     * Bullet type circle
+     */
+    Circle: number;
+    /**
+     * Maximum value of the enum
+     */
+    Max: number;
+};

package/lib/constants/BulletListType.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulletListType = void 0;
+/**
+ *  Enum used to control the different types of bullet list
+ */
+exports.BulletListType = {
+    /**
+     * Minimum value of the enum
+     */
+    Min: 1,
+    /**
+     * Bullet triggered by *
+     */
+    Disc: 1,
+    /**
+     * Bullet triggered by -
+     */
+    Dash: 2,
+    /**
+     * Bullet triggered by --
+     */
+    Square: 3,
+    /**
+     * Bullet triggered by >
+     */
+    ShortArrow: 4,
+    /**
+     * Bullet triggered by ->
+     */
+    LongArrow: 5,
+    /**
+     * Bullet triggered by =>
+     */
+    UnfilledArrow: 6,
+    /**
+     * Bullet triggered by —
+     */
+    Hyphen: 7,
+    /**
+     * Bullet triggered by -->
+     */
+    DoubleLongArrow: 8,
+    /**
+     * Bullet type circle
+     */
+    Circle: 9,
+    /**
+     * Maximum value of the enum
+     */
+    Max: 9,
+};
+//# sourceMappingURL=BulletListType.js.map

package/lib/constants/BulletListType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BulletListType.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-dom/lib/constants/BulletListType.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,cAAc,GAAG;IAC1B;;OAEG;IACH,GAAG,EAAE,CAAC;IACN;;OAEG;IACH,IAAI,EAAE,CAAC;IACP;;OAEG;IACH,IAAI,EAAE,CAAC;IACP;;OAEG;IACH,MAAM,EAAE,CAAC;IACT;;OAEG;IACH,UAAU,EAAE,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,CAAC;IACZ;;OAEG;IACH,aAAa,EAAE,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,CAAC;IACT;;OAEG;IACH,eAAe,EAAE,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,CAAC;IACT;;OAEG;IACH,GAAG,EAAE,CAAC;CACT,CAAC","sourcesContent":["/**\n *  Enum used to control the different types of bullet list\n */\nexport const BulletListType = {\n    /**\n     * Minimum value of the enum\n     */\n    Min: 1,\n    /**\n     * Bullet triggered by *\n     */\n    Disc: 1,\n    /**\n     * Bullet triggered by -\n     */\n    Dash: 2,\n    /**\n     * Bullet triggered by --\n     */\n    Square: 3,\n    /**\n     * Bullet triggered by >\n     */\n    ShortArrow: 4,\n    /**\n     * Bullet triggered by ->\n     */\n    LongArrow: 5,\n    /**\n     * Bullet triggered by =>\n     */\n    UnfilledArrow: 6,\n    /**\n     * Bullet triggered by —\n     */\n    Hyphen: 7,\n    /**\n     * Bullet triggered by -->\n     */\n    DoubleLongArrow: 8,\n    /**\n     * Bullet type circle\n     */\n    Circle: 9,\n    /**\n     * Maximum value of the enum\n     */\n    Max: 9,\n};\n"]}

package/lib/constants/ChangeSource.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Possible change sources. Here are the predefined sources.
+ * It can also be other string if the change source can't fall into these sources.
+ */
+export declare const ChangeSource: {
+    /**
+     * Content changed by auto link
+     */
+    AutoLink: string;
+    /**
+     * Content changed by create link
+     */
+    CreateLink: string;
+    /**
+     * Content changed by format
+     */
+    Format: string;
+    /**
+     * Content changed by image resize
+     */
+    ImageResize: string;
+    /**
+     * Content changed by paste
+     */
+    Paste: string;
+    /**
+     * Content changed by setContent API
+     */
+    SetContent: string;
+    /**
+     * Content changed by cut operation
+     */
+    Cut: string;
+    /**
+     * Content changed by drag & drop operation
+     */
+    Drop: string;
+    /**
+     * Insert a new entity into editor
+     */
+    InsertEntity: string;
+    /**
+     * Editor is switched to dark mode, content color is changed
+     */
+    SwitchToDarkMode: string;
+    /**
+     * Editor is switched to light mode, content color is changed
+     */
+    SwitchToLightMode: string;
+    /**
+     * List chain reorganized numbers of lists
+     */
+    ListChain: string;
+    /**
+     * Keyboard event, used by Content Model.
+     * Data of this event will be the key code number
+     */
+    Keyboard: string;
+};

package/lib/constants/ChangeSource.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangeSource = void 0;
+/**
+ * Possible change sources. Here are the predefined sources.
+ * It can also be other string if the change source can't fall into these sources.
+ */
+exports.ChangeSource = {
+    /**
+     * Content changed by auto link
+     */
+    AutoLink: 'AutoLink',
+    /**
+     * Content changed by create link
+     */
+    CreateLink: 'CreateLink',
+    /**
+     * Content changed by format
+     */
+    Format: 'Format',
+    /**
+     * Content changed by image resize
+     */
+    ImageResize: 'ImageResize',
+    /**
+     * Content changed by paste
+     */
+    Paste: 'Paste',
+    /**
+     * Content changed by setContent API
+     */
+    SetContent: 'SetContent',
+    /**
+     * Content changed by cut operation
+     */
+    Cut: 'Cut',
+    /**
+     * Content changed by drag & drop operation
+     */
+    Drop: 'Drop',
+    /**
+     * Insert a new entity into editor
+     */
+    InsertEntity: 'InsertEntity',
+    /**
+     * Editor is switched to dark mode, content color is changed
+     */
+    SwitchToDarkMode: 'SwitchToDarkMode',
+    /**
+     * Editor is switched to light mode, content color is changed
+     */
+    SwitchToLightMode: 'SwitchToLightMode',
+    /**
+     * List chain reorganized numbers of lists
+     */
+    ListChain: 'ListChain',
+    /**
+     * Keyboard event, used by Content Model.
+     * Data of this event will be the key code number
+     */
+    Keyboard: 'Keyboard',
+};
+//# sourceMappingURL=ChangeSource.js.map

package/lib/constants/ChangeSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeSource.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-dom/lib/constants/ChangeSource.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,YAAY,GAAG;IACxB;;OAEG;IACH,QAAQ,EAAE,UAAU;IACpB;;OAEG;IACH,UAAU,EAAE,YAAY;IACxB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAChB;;OAEG;IACH,WAAW,EAAE,aAAa;IAC1B;;OAEG;IACH,KAAK,EAAE,OAAO;IACd;;OAEG;IACH,UAAU,EAAE,YAAY;IACxB;;OAEG;IACH,GAAG,EAAE,KAAK;IACV;;OAEG;IACH,IAAI,EAAE,MAAM;IACZ;;OAEG;IACH,YAAY,EAAE,cAAc;IAC5B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;IACpC;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;IACtC;;OAEG;IACH,SAAS,EAAE,WAAW;IACtB;;;OAGG;IACH,QAAQ,EAAE,UAAU;CACvB,CAAC","sourcesContent":["/**\n * Possible change sources. Here are the predefined sources.\n * It can also be other string if the change source can't fall into these sources.\n */\nexport const ChangeSource = {\n    /**\n     * Content changed by auto link\n     */\n    AutoLink: 'AutoLink',\n    /**\n     * Content changed by create link\n     */\n    CreateLink: 'CreateLink',\n    /**\n     * Content changed by format\n     */\n    Format: 'Format',\n    /**\n     * Content changed by image resize\n     */\n    ImageResize: 'ImageResize',\n    /**\n     * Content changed by paste\n     */\n    Paste: 'Paste',\n    /**\n     * Content changed by setContent API\n     */\n    SetContent: 'SetContent',\n    /**\n     * Content changed by cut operation\n     */\n    Cut: 'Cut',\n    /**\n     * Content changed by drag & drop operation\n     */\n    Drop: 'Drop',\n    /**\n     * Insert a new entity into editor\n     */\n    InsertEntity: 'InsertEntity',\n    /**\n     * Editor is switched to dark mode, content color is changed\n     */\n    SwitchToDarkMode: 'SwitchToDarkMode',\n    /**\n     * Editor is switched to light mode, content color is changed\n     */\n    SwitchToLightMode: 'SwitchToLightMode',\n    /**\n     * List chain reorganized numbers of lists\n     */\n    ListChain: 'ListChain',\n    /**\n     * Keyboard event, used by Content Model.\n     * Data of this event will be the key code number\n     */\n    Keyboard: 'Keyboard',\n};\n"]}

package/lib/constants/NumberingListType.d.ts

@@ -0,0 +1,93 @@
+/**
+ *  Enum used to control the different types of numbering list
+ */
+export declare const NumberingListType: {
+    /**
+     * Minimum value of the enum
+     */
+    Min: number;
+    /**
+     * Numbering triggered by 1.
+     */
+    Decimal: number;
+    /**
+     * Numbering triggered by 1-
+     */
+    DecimalDash: number;
+    /**
+     * Numbering triggered by 1)
+     */
+    DecimalParenthesis: number;
+    /**
+     * Numbering triggered by (1)
+     */
+    DecimalDoubleParenthesis: number;
+    /**
+     * Numbering triggered by a.
+     */
+    LowerAlpha: number;
+    /**
+     * Numbering triggered by a)
+     */
+    LowerAlphaParenthesis: number;
+    /**
+     * Numbering triggered by (a)
+     */
+    LowerAlphaDoubleParenthesis: number;
+    /**
+     * Numbering triggered by a-
+     */
+    LowerAlphaDash: number;
+    /**
+     * Numbering triggered by A.
+     */
+    UpperAlpha: number;
+    /**
+     * Numbering triggered by A)
+     */
+    UpperAlphaParenthesis: number;
+    /**
+     * Numbering triggered by (A)
+     */
+    UpperAlphaDoubleParenthesis: number;
+    /**
+     * Numbering triggered by A-
+     */
+    UpperAlphaDash: number;
+    /**
+     * Numbering triggered by i.
+     */
+    LowerRoman: number;
+    /**
+     * Numbering triggered by i)
+     */
+    LowerRomanParenthesis: number;
+    /**
+     * Numbering triggered by (i)
+     */
+    LowerRomanDoubleParenthesis: number;
+    /**
+     * Numbering triggered by i-
+     */
+    LowerRomanDash: number;
+    /**
+     * Numbering triggered by I.
+     */
+    UpperRoman: number;
+    /**
+     * Numbering triggered by I)
+     */
+    UpperRomanParenthesis: number;
+    /**
+     * Numbering triggered by (I)
+     */
+    UpperRomanDoubleParenthesis: number;
+    /**
+     * Numbering triggered by I-
+     */
+    UpperRomanDash: number;
+    /**
+     * Maximum value of the enum
+     */
+    Max: number;
+};

package/lib/constants/NumberingListType.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberingListType = void 0;
+/**
+ *  Enum used to control the different types of numbering list
+ */
+exports.NumberingListType = {
+    /**
+     * Minimum value of the enum
+     */
+    Min: 1,
+    /**
+     * Numbering triggered by 1.
+     */
+    Decimal: 1,
+    /**
+     * Numbering triggered by 1-
+     */
+    DecimalDash: 2,
+    /**
+     * Numbering triggered by 1)
+     */
+    DecimalParenthesis: 3,
+    /**
+     * Numbering triggered by (1)
+     */
+    DecimalDoubleParenthesis: 4,
+    /**
+     * Numbering triggered by a.
+     */
+    LowerAlpha: 5,
+    /**
+     * Numbering triggered by a)
+     */
+    LowerAlphaParenthesis: 6,
+    /**
+     * Numbering triggered by (a)
+     */
+    LowerAlphaDoubleParenthesis: 7,
+    /**
+     * Numbering triggered by a-
+     */
+    LowerAlphaDash: 8,
+    /**
+     * Numbering triggered by A.
+     */
+    UpperAlpha: 9,
+    /**
+     * Numbering triggered by A)
+     */
+    UpperAlphaParenthesis: 10,
+    /**
+     * Numbering triggered by (A)
+     */
+    UpperAlphaDoubleParenthesis: 11,
+    /**
+     * Numbering triggered by A-
+     */
+    UpperAlphaDash: 12,
+    /**
+     * Numbering triggered by i.
+     */
+    LowerRoman: 13,
+    /**
+     * Numbering triggered by i)
+     */
+    LowerRomanParenthesis: 14,
+    /**
+     * Numbering triggered by (i)
+     */
+    LowerRomanDoubleParenthesis: 15,
+    /**
+     * Numbering triggered by i-
+     */
+    LowerRomanDash: 16,
+    /**
+     * Numbering triggered by I.
+     */
+    UpperRoman: 17,
+    /**
+     * Numbering triggered by I)
+     */
+    UpperRomanParenthesis: 18,
+    /**
+     * Numbering triggered by (I)
+     */
+    UpperRomanDoubleParenthesis: 19,
+    /**
+     * Numbering triggered by I-
+     */
+    UpperRomanDash: 20,
+    /**
+     * Maximum value of the enum
+     */
+    Max: 20,
+};
+//# sourceMappingURL=NumberingListType.js.map

package/lib/constants/NumberingListType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberingListType.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-dom/lib/constants/NumberingListType.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC7B;;OAEG;IACH,GAAG,EAAE,CAAC;IACN;;OAEG;IACH,OAAO,EAAE,CAAC;IACV;;OAEG;IACH,WAAW,EAAE,CAAC;IACd;;OAEG;IACH,kBAAkB,EAAE,CAAC;IACrB;;OAEG;IACH,wBAAwB,EAAE,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,CAAC;IACb;;OAEG;IACH,qBAAqB,EAAE,CAAC;IACxB;;OAEG;IACH,2BAA2B,EAAE,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,CAAC;IACb;;OAEG;IACH,qBAAqB,EAAE,EAAE;IACzB;;OAEG;IACH,2BAA2B,EAAE,EAAE;IAC/B;;OAEG;IACH,cAAc,EAAE,EAAE;IAClB;;OAEG;IACH,UAAU,EAAE,EAAE;IACd;;OAEG;IACH,qBAAqB,EAAE,EAAE;IACzB;;OAEG;IACH,2BAA2B,EAAE,EAAE;IAC/B;;OAEG;IACH,cAAc,EAAE,EAAE;IAClB;;OAEG;IACH,UAAU,EAAE,EAAE;IACd;;OAEG;IACH,qBAAqB,EAAE,EAAE;IACzB;;OAEG;IACH,2BAA2B,EAAE,EAAE;IAC/B;;OAEG;IACH,cAAc,EAAE,EAAE;IAClB;;OAEG;IACH,GAAG,EAAE,EAAE;CACV,CAAC","sourcesContent":["/**\n *  Enum used to control the different types of numbering list\n */\nexport const NumberingListType = {\n    /**\n     * Minimum value of the enum\n     */\n    Min: 1,\n    /**\n     * Numbering triggered by 1.\n     */\n    Decimal: 1,\n    /**\n     * Numbering triggered by 1-\n     */\n    DecimalDash: 2,\n    /**\n     * Numbering triggered by 1)\n     */\n    DecimalParenthesis: 3,\n    /**\n     * Numbering triggered by (1)\n     */\n    DecimalDoubleParenthesis: 4,\n    /**\n     * Numbering triggered by a.\n     */\n    LowerAlpha: 5,\n    /**\n     * Numbering triggered by a)\n     */\n    LowerAlphaParenthesis: 6,\n    /**\n     * Numbering triggered by (a)\n     */\n    LowerAlphaDoubleParenthesis: 7,\n    /**\n     * Numbering triggered by a-\n     */\n    LowerAlphaDash: 8,\n    /**\n     * Numbering triggered by A.\n     */\n    UpperAlpha: 9,\n    /**\n     * Numbering triggered by A)\n     */\n    UpperAlphaParenthesis: 10,\n    /**\n     * Numbering triggered by (A)\n     */\n    UpperAlphaDoubleParenthesis: 11,\n    /**\n     * Numbering triggered by A-\n     */\n    UpperAlphaDash: 12,\n    /**\n     * Numbering triggered by i.\n     */\n    LowerRoman: 13,\n    /**\n     * Numbering triggered by i)\n     */\n    LowerRomanParenthesis: 14,\n    /**\n     * Numbering triggered by (i)\n     */\n    LowerRomanDoubleParenthesis: 15,\n    /**\n     * Numbering triggered by i-\n     */\n    LowerRomanDash: 16,\n    /**\n     * Numbering triggered by I.\n     */\n    UpperRoman: 17,\n    /**\n     * Numbering triggered by I)\n     */\n    UpperRomanParenthesis: 18,\n    /**\n     * Numbering triggered by (I)\n     */\n    UpperRomanDoubleParenthesis: 19,\n    /**\n     * Numbering triggered by I-\n     */\n    UpperRomanDash: 20,\n    /**\n     * Maximum value of the enum\n     */\n    Max: 20,\n};\n"]}

package/lib/constants/OrderedListStyleMap.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Style map for ordered list
+ */
+export declare const OrderedListStyleMap: Record<number, string>;

package/lib/constants/OrderedListStyleMap.js

@@ -0,0 +1,31 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderedListStyleMap = void 0;
+var NumberingListType_1 = require("./NumberingListType");
+/**
+ * Style map for ordered list
+ */
+exports.OrderedListStyleMap = (_a = {},
+    _a[NumberingListType_1.NumberingListType.Decimal] = 'decimal',
+    _a[NumberingListType_1.NumberingListType.DecimalDash] = '"${Number}- "',
+    _a[NumberingListType_1.NumberingListType.DecimalParenthesis] = '"${Number}) "',
+    _a[NumberingListType_1.NumberingListType.DecimalDoubleParenthesis] = '"(${Number}) "',
+    _a[NumberingListType_1.NumberingListType.LowerAlpha] = 'lower-alpha',
+    _a[NumberingListType_1.NumberingListType.LowerAlphaDash] = '"${LowerAlpha}- "',
+    _a[NumberingListType_1.NumberingListType.LowerAlphaParenthesis] = '"${LowerAlpha}) "',
+    _a[NumberingListType_1.NumberingListType.LowerAlphaDoubleParenthesis] = '"(${LowerAlpha}) "',
+    _a[NumberingListType_1.NumberingListType.UpperAlpha] = 'upper-alpha',
+    _a[NumberingListType_1.NumberingListType.UpperAlphaDash] = '"${UpperAlpha}- "',
+    _a[NumberingListType_1.NumberingListType.UpperAlphaParenthesis] = '"${UpperAlpha}) "',
+    _a[NumberingListType_1.NumberingListType.UpperAlphaDoubleParenthesis] = '"(${UpperAlpha}) "',
+    _a[NumberingListType_1.NumberingListType.LowerRoman] = 'lower-roman',
+    _a[NumberingListType_1.NumberingListType.LowerRomanDash] = '"${LowerRoman}- "',
+    _a[NumberingListType_1.NumberingListType.LowerRomanParenthesis] = '"${LowerRoman}) "',
+    _a[NumberingListType_1.NumberingListType.LowerRomanDoubleParenthesis] = '"(${LowerRoman}) "',
+    _a[NumberingListType_1.NumberingListType.UpperRoman] = 'upper-roman',
+    _a[NumberingListType_1.NumberingListType.UpperRomanDash] = '"${UpperRoman}- "',
+    _a[NumberingListType_1.NumberingListType.UpperRomanParenthesis] = '"${UpperRoman}) "',
+    _a[NumberingListType_1.NumberingListType.UpperRomanDoubleParenthesis] = '"(${UpperRoman}) "',
+    _a);
+//# sourceMappingURL=OrderedListStyleMap.js.map

package/lib/constants/OrderedListStyleMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderedListStyleMap.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-dom/lib/constants/OrderedListStyleMap.ts"],"names":[],"mappings":";;;;AAAA,yDAAwD;AAExD;;GAEG;AACU,QAAA,mBAAmB;IAC5B,GAAC,qCAAiB,CAAC,OAAO,IAAG,SAAS;IACtC,GAAC,qCAAiB,CAAC,WAAW,IAAG,eAAe;IAChD,GAAC,qCAAiB,CAAC,kBAAkB,IAAG,eAAe;IACvD,GAAC,qCAAiB,CAAC,wBAAwB,IAAG,gBAAgB;IAC9D,GAAC,qCAAiB,CAAC,UAAU,IAAG,aAAa;IAC7C,GAAC,qCAAiB,CAAC,cAAc,IAAG,mBAAmB;IACvD,GAAC,qCAAiB,CAAC,qBAAqB,IAAG,mBAAmB;IAC9D,GAAC,qCAAiB,CAAC,2BAA2B,IAAG,oBAAoB;IACrE,GAAC,qCAAiB,CAAC,UAAU,IAAG,aAAa;IAC7C,GAAC,qCAAiB,CAAC,cAAc,IAAG,mBAAmB;IACvD,GAAC,qCAAiB,CAAC,qBAAqB,IAAG,mBAAmB;IAC9D,GAAC,qCAAiB,CAAC,2BAA2B,IAAG,oBAAoB;IACrE,GAAC,qCAAiB,CAAC,UAAU,IAAG,aAAa;IAC7C,GAAC,qCAAiB,CAAC,cAAc,IAAG,mBAAmB;IACvD,GAAC,qCAAiB,CAAC,qBAAqB,IAAG,mBAAmB;IAC9D,GAAC,qCAAiB,CAAC,2BAA2B,IAAG,oBAAoB;IACrE,GAAC,qCAAiB,CAAC,UAAU,IAAG,aAAa;IAC7C,GAAC,qCAAiB,CAAC,cAAc,IAAG,mBAAmB;IACvD,GAAC,qCAAiB,CAAC,qBAAqB,IAAG,mBAAmB;IAC9D,GAAC,qCAAiB,CAAC,2BAA2B,IAAG,oBAAoB;QACvE","sourcesContent":["import { NumberingListType } from './NumberingListType';\n\n/**\n * Style map for ordered list\n */\nexport const OrderedListStyleMap: Record<number, string> = {\n    [NumberingListType.Decimal]: 'decimal',\n    [NumberingListType.DecimalDash]: '\"${Number}- \"',\n    [NumberingListType.DecimalParenthesis]: '\"${Number}) \"',\n    [NumberingListType.DecimalDoubleParenthesis]: '\"(${Number}) \"',\n    [NumberingListType.LowerAlpha]: 'lower-alpha',\n    [NumberingListType.LowerAlphaDash]: '\"${LowerAlpha}- \"',\n    [NumberingListType.LowerAlphaParenthesis]: '\"${LowerAlpha}) \"',\n    [NumberingListType.LowerAlphaDoubleParenthesis]: '\"(${LowerAlpha}) \"',\n    [NumberingListType.UpperAlpha]: 'upper-alpha',\n    [NumberingListType.UpperAlphaDash]: '\"${UpperAlpha}- \"',\n    [NumberingListType.UpperAlphaParenthesis]: '\"${UpperAlpha}) \"',\n    [NumberingListType.UpperAlphaDoubleParenthesis]: '\"(${UpperAlpha}) \"',\n    [NumberingListType.LowerRoman]: 'lower-roman',\n    [NumberingListType.LowerRomanDash]: '\"${LowerRoman}- \"',\n    [NumberingListType.LowerRomanParenthesis]: '\"${LowerRoman}) \"',\n    [NumberingListType.LowerRomanDoubleParenthesis]: '\"(${LowerRoman}) \"',\n    [NumberingListType.UpperRoman]: 'upper-roman',\n    [NumberingListType.UpperRomanDash]: '\"${UpperRoman}- \"',\n    [NumberingListType.UpperRomanParenthesis]: '\"${UpperRoman}) \"',\n    [NumberingListType.UpperRomanDoubleParenthesis]: '\"(${UpperRoman}) \"',\n};\n"]}