roosterjs-content-model-types 0.0.3

package/LICENSE

@@ -0,0 +1,25 @@
+    RoosterJS
+    Copyright (c) Microsoft Corporation
+    All rights reserved.
+
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,262 @@
+[![Build Status](https://github.com/microsoft/roosterjs/actions/workflows/build-and-deploy.yml/badge.svg)](https://github.com/microsoft/roosterjs/actions/workflows/build-and-deploy.yml)
+
+# Rooster
+
+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:
+
+[RoosterJs Sample Site](https://microsoft.github.io/roosterjs/index.html).
+
+## Upgrade from RoosterJs 7.\*
+
+Please see [here](https://github.com/microsoft/roosterjs/wiki/RoosterJs-8).
+
+## Features
+
+### Packages
+
+Rooster contains 6 basic packages.
+
+1. [roosterjs](https://microsoft.github.io/roosterjs/docs/modules/roosterjs.html):
+   A facade of all Rooster code for those who want a quick start. Use the
+   `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`
+   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):
+   Defines APIs for editor operations. Use these APIs to modify content and
+   formatting in the editor you built using `roosterjs-editor-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.
+
+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.
+
+6. [roosterjs-editor-types](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_editor_types.html):
+   Defines public interfaces and enumerations.
+
+There are also some extension packages to provide additional functionalities.
+
+1. [roosterjs-color-utils](https://microsoft.github.io/roosterjs/docs/modules/roosterjs_color_utils.html):
+   Provide color transformation utility to make editor work under dark mode.
+
+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
+
+### 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.
+
+`roosterjs-editor-dom` provides several levels of DOM 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.
+
+`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
+API overrides in Editor options when creating the editor.
+
+`roosterjs-editor-api` provides APIs for scenario-based operations triggered by
+user interaction.
+
+## Plugins
+
+Rooster supports plugins. You can use built-in plugins or build your own.
+Plugins call APIs to communicate with the editor. When an operation is
+performed by the user or when content is changed by code, the editor will
+trigger events for the plugins to handle.
+
+Here's a sample plugin which will show a dialog containing "Hello Rooster" when
+an "a" is typed in the editor:
+
+```typescript
+class HelloRooster implements EditorPlugin {
+    getName() {
+        return 'HelloRooster';
+    }
+
+    initialize(editor: IEditor) {}
+
+    dispose() {}
+
+    onPluginEvent(e: PluginEvent) {
+        if (e.eventType == PluginEventType.KeyPress && e.rawEvent.which == 65) {
+            alert('Hello Rooster');
+        }
+    }
+}
+```
+
+## Installation
+
+Install via NPM or Yarn:
+
+`yarn add roosterjs`
+
+You can also install sub packages separately:
+
+`yarn add roosterjs-editor-core`
+
+`yarn add roosterjs-editor-api`
+
+`...`
+
+In order to run the code below, you may also need to install [webpack](https://webpack.js.org/):
+
+`yarn add webpack -g`
+
+## Usage
+
+### A quick start
+
+1. Create `editor.htm` which contains a DIV with some styles, buttons to handle some click events and a reference to rooster.js (update with the path to your rooster.js file):
+
+```html
+<html>
+    <body>
+        <div style="width: 500px; height: 400px; border: solid 1px black" id="contentDiv"></div>
+        <button id="buttonB">B</button> <button id="buttonI">I</button>
+        <button id="buttonU">U</button>
+        <script src="rooster.js"></script>
+        <script>
+            var contentDiv = document.getElementById('contentDiv');
+            var editor = roosterjs.createEditor(contentDiv);
+
+            editor.setContent('Welcome to <b>RoosterJs</b>!');
+            document.getElementById('buttonB').addEventListener('click', function () {
+                roosterjs.toggleBold(editor);
+            });
+            document.getElementById('buttonI').addEventListener('click', function () {
+                roosterjs.toggleItalic(editor);
+            });
+            document.getElementById('buttonU').addEventListener('click', function () {
+                roosterjs.toggleUnderline(editor);
+            });
+        </script>
+    </body>
+</html>
+```
+
+2. Navigate to editor.htm, you will see a editor shown in the page which includes buttons with bold, italic, underline
+   actions.
+
+## Sample code
+
+To view the sample site, please click [here](https://microsoft.github.io/roosterjs/index.html).
+
+To build the sample site code yourself, follow these instructions:
+
+1. Get dependencies using [yarn](https://yarnpkg.com) or [npm](https://www.npmjs.com/):
+
+    ```cmd
+    yarn
+    ```
+
+2. Build the source code, and start the sample editor:
+
+    ```
+    yarn start
+    ```
+
+    or
+
+    ```
+    npm start
+    ```
+
+## Debugging
+
+There are two options for debugging:
+
+1. Debugging from VSCode
+
+    - Ensure the sample editor is running
+    - Set the breakpoints within VSCode
+    - Select "Debug app in Chrome" from the VSCode debugging configuration dropdown
+      <img src="/assets/readme-images/debug-in-VSCode.png" width="411" height="278"><br>
+    - Run the scenario that needs to be debugged
+
+2. Debugging directly from the development tools within the web browser
+    - The directions for how to do this are specific to each web browser. By opening the developer
+      tools for the web browser that Rooster is running on, you will be able to set breakpoints in
+      the code and debug accordingly.
+
+## Running tests
+
+There are two ways that tests can be run:
+
+1. Run all tests or a single test from VSCode<br>
+    - (Skip if running all tests) Ensure the file that you want to test is selected (ie: toggleBold.ts
+      or toggleBoldTest.ts)
+    - Select "Test all files" or "Test current file" from the VSCode debugging configuration dropdown
+      <img src="/assets/readme-images/test-in-VSCode.png" width="402" height="268">
+2. Run all tests from command line
+    ```
+    yarn test
+    ```
+
+## Dependencies
+
+As a NodeJs package, RoosterJs has dependencies for runtime (specified in package.json under each sub
+packages in "dependencies" section) and dependencies for build time (specified in package.json under
+root path in "devDependencies" section).
+
+For runtime dependencies, there are two parts:
+
+-   Internal dependencies (a RoosterJs package depends on other RoosterJs packages)
+-   External dependencies (RoosterJs depends on other NPM packages)
+
+Currently we have very few external dependencies. Before adding any new dependency, we need to check:
+
+1. What's the value of the new dependency and the code using the dependency bring into roosterjs?
+   If we add a new dependency and create our new API to just call into the dependency, that new API
+   doesn't actually bring too much value, and people who uses roosterjs in their project can do this
+   themselves in their code, and we should not add such dependency to people who don't really need it.
+
+2. What's the dependency tree of the dependency?
+   If we introduce a new dependency which has a deep dependency tree, we need to be careful since it
+   means we are actually adding a lot of new dependencies and our code size may be increased a lot.
+
+3. How much functionalities do we need from the dependency?
+   If the dependency provides a lot of functionalities but we actually only need a small piece of them,
+   we may need to consider other solutions, such as find another smaller one, or do it ourselves.
+
+4. What's the license of the dependency?
+   A dependency package under MIT license is good to be used for RoosterJs. For other licenses, we need
+   to review and see if we can take it as a dependency.
+
+If you still feel a new dependency is required after checking these questions, we can review it and
+finally decide whether we should add the new dependency.
+
+For build time dependencies, it is more flexible to add new dependencies since it won't increase runtime
+code size or dependencies.
+
+## More documentation
+
+We are still working on more documentation in [roosterjs wiki](https://github.com/Microsoft/roosterjs/wiki) and [API reference](https://microsoft.github.io/roosterjs/docs/index.html).
+
+## License - MIT
+
+License
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Licensed under the [MIT](LICENSE) License.

package/lib/block/ContentModelBlock.d.ts

@@ -0,0 +1,11 @@
+import type { ContentModelDivider } from './ContentModelDivider';
+import type { ContentModelEntity } from '../entity/ContentModelEntity';
+import type { ContentModelFormatContainer } from '../group/ContentModelFormatContainer';
+import type { ContentModelGeneralBlock } from '../group/ContentModelGeneralBlock';
+import type { ContentModelListItem } from '../group/ContentModelListItem';
+import type { ContentModelParagraph } from './ContentModelParagraph';
+import type { ContentModelTable } from './ContentModelTable';
+/**
+ * A union type of Content Model Block
+ */
+export declare type ContentModelBlock = ContentModelFormatContainer | ContentModelListItem | ContentModelGeneralBlock | ContentModelTable | ContentModelParagraph | ContentModelEntity | ContentModelDivider;

package/lib/block/ContentModelBlock.js

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

package/lib/block/ContentModelBlock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelBlock.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelBlock.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelDivider } from './ContentModelDivider';\r\nimport type { ContentModelEntity } from '../entity/ContentModelEntity';\r\nimport type { ContentModelFormatContainer } from '../group/ContentModelFormatContainer';\r\nimport type { ContentModelGeneralBlock } from '../group/ContentModelGeneralBlock';\r\nimport type { ContentModelListItem } from '../group/ContentModelListItem';\r\nimport type { ContentModelParagraph } from './ContentModelParagraph';\r\nimport type { ContentModelTable } from './ContentModelTable';\r\n\r\n/**\r\n * A union type of Content Model Block\r\n */\r\nexport type ContentModelBlock =\r\n    | ContentModelFormatContainer\r\n    | ContentModelListItem\r\n    | ContentModelGeneralBlock\r\n    | ContentModelTable\r\n    | ContentModelParagraph\r\n    | ContentModelEntity\r\n    | ContentModelDivider;\r\n"]}

package/lib/block/ContentModelBlockBase.d.ts

@@ -0,0 +1,12 @@
+import type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';
+import type { ContentModelBlockType } from '../enum/BlockType';
+import type { ContentModelWithFormat } from '../format/ContentModelWithFormat';
+/**
+ * Base type of a block
+ */
+export interface ContentModelBlockBase<T extends ContentModelBlockType, TFormat extends ContentModelBlockFormat = ContentModelBlockFormat> extends ContentModelWithFormat<TFormat> {
+    /**
+     * Type of this block
+     */
+    blockType: T;
+}

package/lib/block/ContentModelBlockBase.js

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

package/lib/block/ContentModelBlockBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelBlockBase.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelBlockBase.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';\r\nimport type { ContentModelBlockType } from '../enum/BlockType';\r\nimport type { ContentModelWithFormat } from '../format/ContentModelWithFormat';\r\n\r\n/**\r\n * Base type of a block\r\n */\r\nexport interface ContentModelBlockBase<\r\n    T extends ContentModelBlockType,\r\n    TFormat extends ContentModelBlockFormat = ContentModelBlockFormat\r\n> extends ContentModelWithFormat<TFormat> {\r\n    /**\r\n     * Type of this block\r\n     */\r\n    blockType: T;\r\n}\r\n"]}

package/lib/block/ContentModelBlockWithCache.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Represent a Content Model block with cached element
+ */
+export interface ContentModelBlockWithCache<TElement extends HTMLElement = HTMLElement> {
+    /**
+     * Cached element for reuse
+     */
+    cachedElement?: TElement;
+}

package/lib/block/ContentModelBlockWithCache.js

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

package/lib/block/ContentModelBlockWithCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelBlockWithCache.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelBlockWithCache.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Represent a Content Model block with cached element\r\n */\r\nexport interface ContentModelBlockWithCache<TElement extends HTMLElement = HTMLElement> {\r\n    /**\r\n     * Cached element for reuse\r\n     */\r\n    cachedElement?: TElement;\r\n}\r\n"]}

package/lib/block/ContentModelDivider.d.ts

@@ -0,0 +1,17 @@
+import type { ContentModelBlockBase } from './ContentModelBlockBase';
+import type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';
+import type { ContentModelDividerFormat } from '../format/ContentModelDividerFormat';
+import type { Selectable } from '../selection/Selectable';
+/**
+ * Content Model of horizontal divider
+ */
+export interface ContentModelDivider extends Selectable, ContentModelBlockWithCache, ContentModelBlockBase<'Divider', ContentModelDividerFormat> {
+    /**
+     * Tag name of this element, either HR or DIV
+     */
+    tagName: 'hr' | 'div';
+    /**
+     * Size property for HR
+     */
+    size?: string;
+}

package/lib/block/ContentModelDivider.js

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

package/lib/block/ContentModelDivider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelDivider.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelDivider.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelBlockBase } from './ContentModelBlockBase';\r\nimport type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';\r\nimport type { ContentModelDividerFormat } from '../format/ContentModelDividerFormat';\r\nimport type { Selectable } from '../selection/Selectable';\r\n\r\n/**\r\n * Content Model of horizontal divider\r\n */\r\nexport interface ContentModelDivider\r\n    extends Selectable,\r\n        ContentModelBlockWithCache,\r\n        ContentModelBlockBase<'Divider', ContentModelDividerFormat> {\r\n    /**\r\n     * Tag name of this element, either HR or DIV\r\n     */\r\n    tagName: 'hr' | 'div';\r\n\r\n    /**\r\n     * Size property for HR\r\n     */\r\n    size?: string;\r\n}\r\n"]}

package/lib/block/ContentModelParagraph.d.ts

@@ -0,0 +1,27 @@
+import type { ContentModelBlockBase } from './ContentModelBlockBase';
+import type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';
+import type { ContentModelParagraphDecorator } from '../decorator/ContentModelParagraphDecorator';
+import type { ContentModelSegment } from '../segment/ContentModelSegment';
+import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
+/**
+ * Content Model of Paragraph
+ */
+export interface ContentModelParagraph extends ContentModelBlockWithCache, ContentModelBlockBase<'Paragraph'> {
+    /**
+     * Segments within this paragraph
+     */
+    segments: ContentModelSegment[];
+    /**
+     * Segment format on this paragraph. This is mostly used for default format
+     */
+    segmentFormat?: ContentModelSegmentFormat;
+    /**
+     * Decorator info for this paragraph, used by heading and P tags
+     */
+    decorator?: ContentModelParagraphDecorator;
+    /**
+     * Whether this block was created from a block HTML element or just some simple segment between other block elements.
+     * True means it doesn't have a related block element, false means it was from a block element
+     */
+    isImplicit?: boolean;
+}

package/lib/block/ContentModelParagraph.js

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

package/lib/block/ContentModelParagraph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelParagraph.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelParagraph.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelBlockBase } from './ContentModelBlockBase';\r\nimport type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';\r\nimport type { ContentModelParagraphDecorator } from '../decorator/ContentModelParagraphDecorator';\r\nimport type { ContentModelSegment } from '../segment/ContentModelSegment';\r\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\r\n\r\n/**\r\n * Content Model of Paragraph\r\n */\r\nexport interface ContentModelParagraph\r\n    extends ContentModelBlockWithCache,\r\n        ContentModelBlockBase<'Paragraph'> {\r\n    /**\r\n     * Segments within this paragraph\r\n     */\r\n    segments: ContentModelSegment[];\r\n\r\n    /**\r\n     * Segment format on this paragraph. This is mostly used for default format\r\n     */\r\n    segmentFormat?: ContentModelSegmentFormat;\r\n\r\n    /**\r\n     * Decorator info for this paragraph, used by heading and P tags\r\n     */\r\n    decorator?: ContentModelParagraphDecorator;\r\n\r\n    /**\r\n     * Whether this block was created from a block HTML element or just some simple segment between other block elements.\r\n     * True means it doesn't have a related block element, false means it was from a block element\r\n     */\r\n    isImplicit?: boolean;\r\n}\r\n"]}

package/lib/block/ContentModelTable.d.ts

@@ -0,0 +1,19 @@
+import type { ContentModelBlockBase } from './ContentModelBlockBase';
+import type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';
+import type { ContentModelTableFormat } from '../format/ContentModelTableFormat';
+import type { ContentModelTableRow } from './ContentModelTableRow';
+import type { ContentModelWithDataset } from '../format/ContentModelWithDataset';
+import type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';
+/**
+ * Content Model of Table
+ */
+export interface ContentModelTable extends ContentModelBlockBase<'Table', ContentModelTableFormat>, ContentModelWithDataset<TableMetadataFormat>, ContentModelBlockWithCache<HTMLTableElement> {
+    /**
+     * Widths of each column
+     */
+    widths: number[];
+    /**
+     * Cells of this table
+     */
+    rows: ContentModelTableRow[];
+}

package/lib/block/ContentModelTable.js

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

package/lib/block/ContentModelTable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelTable.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelTable.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelBlockBase } from './ContentModelBlockBase';\r\nimport type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';\r\nimport type { ContentModelTableFormat } from '../format/ContentModelTableFormat';\r\nimport type { ContentModelTableRow } from './ContentModelTableRow';\r\nimport type { ContentModelWithDataset } from '../format/ContentModelWithDataset';\r\nimport type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';\r\n\r\n/**\r\n * Content Model of Table\r\n */\r\nexport interface ContentModelTable\r\n    extends ContentModelBlockBase<'Table', ContentModelTableFormat>,\r\n        ContentModelWithDataset<TableMetadataFormat>,\r\n        ContentModelBlockWithCache<HTMLTableElement> {\r\n    /**\r\n     * Widths of each column\r\n     */\r\n    widths: number[];\r\n\r\n    /**\r\n     * Cells of this table\r\n     */\r\n    rows: ContentModelTableRow[];\r\n}\r\n"]}

package/lib/block/ContentModelTableRow.d.ts

@@ -0,0 +1,17 @@
+import type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';
+import type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';
+import type { ContentModelTableCell } from '../group/ContentModelTableCell';
+import type { ContentModelWithFormat } from '../format/ContentModelWithFormat';
+/**
+ * Content Model of Table
+ */
+export interface ContentModelTableRow extends ContentModelBlockWithCache<HTMLTableRowElement>, ContentModelWithFormat<ContentModelBlockFormat> {
+    /**
+     * Heights of each row
+     */
+    height: number;
+    /**
+     * Cells of this table
+     */
+    cells: ContentModelTableCell[];
+}

package/lib/block/ContentModelTableRow.js

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

package/lib/block/ContentModelTableRow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelTableRow.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/block/ContentModelTableRow.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';\r\nimport type { ContentModelBlockWithCache } from './ContentModelBlockWithCache';\r\nimport type { ContentModelTableCell } from '../group/ContentModelTableCell';\r\nimport type { ContentModelWithFormat } from '../format/ContentModelWithFormat';\r\n\r\n/**\r\n * Content Model of Table\r\n */\r\nexport interface ContentModelTableRow\r\n    extends ContentModelBlockWithCache<HTMLTableRowElement>,\r\n        ContentModelWithFormat<ContentModelBlockFormat> {\r\n    /**\r\n     * Heights of each row\r\n     */\r\n    height: number;\r\n\r\n    /**\r\n     * Cells of this table\r\n     */\r\n    cells: ContentModelTableCell[];\r\n}\r\n"]}

package/lib/context/ContentModelHandler.d.ts

@@ -0,0 +1,34 @@
+import type { ContentModelBlock } from '../block/ContentModelBlock';
+import type { ContentModelBlockGroup } from '../group/ContentModelBlockGroup';
+import type { ContentModelDecorator } from '../decorator/ContentModelDecorator';
+import type { ContentModelSegment } from '../segment/ContentModelSegment';
+import type { ModelToDomContext } from './ModelToDomContext';
+/**
+ * Type of Content Model to DOM handler
+ * @param doc Target HTML Document object
+ * @param parent Parent HTML node to append the new node from the given model
+ * @param model The Content Model to handle
+ * @param context The context object to provide related information
+ */
+export declare type ContentModelHandler<T extends ContentModelSegment | ContentModelBlockGroup | ContentModelDecorator> = (doc: Document, parent: Node, model: T, context: ModelToDomContext) => void;
+/**
+ * Type of Content Model to DOM handler for block
+ * @param doc Target HTML Document object
+ * @param parent Parent HTML node to append the new node from the given model
+ * @param model The Content Model to handle
+ * @param context The context object to provide related information
+ * @param refNode Reference node. This is the next node the new node to be inserted.
+ * It is used when write DOM tree onto existing DOM true. If there is no reference node, pass null.
+ */
+export declare type ContentModelBlockHandler<T extends ContentModelBlock | ContentModelBlockGroup> = (doc: Document, parent: Node, model: T, context: ModelToDomContext, refNode: Node | null) => Node | null;
+/**
+ * Type of Content Model to DOM handler for block
+ * @param doc Target HTML Document object
+ * @param parent Parent HTML node to append the new node from the given model
+ * @param model The Content Model to handle
+ * @param context The context object to provide related information
+ * @param segmentNodes Nodes that created to represent this segment. In most cases there will be one node returned, except
+ * - For segments with decorators: decorator elements will also be included
+ * - For inline entity segment, the delimiter SPANs will also be included
+ */
+export declare type ContentModelSegmentHandler<T extends ContentModelSegment> = (doc: Document, parent: Node, model: T, context: ModelToDomContext, segmentNodes: Node[]) => void;

package/lib/context/ContentModelHandler.js

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

package/lib/context/ContentModelHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelHandler.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/ContentModelHandler.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelBlock } from '../block/ContentModelBlock';\r\nimport type { ContentModelBlockGroup } from '../group/ContentModelBlockGroup';\r\nimport type { ContentModelDecorator } from '../decorator/ContentModelDecorator';\r\nimport type { ContentModelSegment } from '../segment/ContentModelSegment';\r\nimport type { ModelToDomContext } from './ModelToDomContext';\r\n\r\n/**\r\n * Type of Content Model to DOM handler\r\n * @param doc Target HTML Document object\r\n * @param parent Parent HTML node to append the new node from the given model\r\n * @param model The Content Model to handle\r\n * @param context The context object to provide related information\r\n */\r\nexport type ContentModelHandler<\r\n    T extends ContentModelSegment | ContentModelBlockGroup | ContentModelDecorator\r\n> = (doc: Document, parent: Node, model: T, context: ModelToDomContext) => void;\r\n\r\n/**\r\n * Type of Content Model to DOM handler for block\r\n * @param doc Target HTML Document object\r\n * @param parent Parent HTML node to append the new node from the given model\r\n * @param model The Content Model to handle\r\n * @param context The context object to provide related information\r\n * @param refNode Reference node. This is the next node the new node to be inserted.\r\n * It is used when write DOM tree onto existing DOM true. If there is no reference node, pass null.\r\n */\r\nexport type ContentModelBlockHandler<T extends ContentModelBlock | ContentModelBlockGroup> = (\r\n    doc: Document,\r\n    parent: Node,\r\n    model: T,\r\n    context: ModelToDomContext,\r\n    refNode: Node | null\r\n) => Node | null;\r\n\r\n/**\r\n * Type of Content Model to DOM handler for block\r\n * @param doc Target HTML Document object\r\n * @param parent Parent HTML node to append the new node from the given model\r\n * @param model The Content Model to handle\r\n * @param context The context object to provide related information\r\n * @param segmentNodes Nodes that created to represent this segment. In most cases there will be one node returned, except\r\n * - For segments with decorators: decorator elements will also be included\r\n * - For inline entity segment, the delimiter SPANs will also be included\r\n */\r\nexport type ContentModelSegmentHandler<T extends ContentModelSegment> = (\r\n    doc: Document,\r\n    parent: Node,\r\n    model: T,\r\n    context: ModelToDomContext,\r\n    segmentNodes: Node[]\r\n) => void;\r\n"]}

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/context/DarkColorHandler.js

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

package/lib/context/DarkColorHandler.js.map

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

package/lib/context/DomIndexer.d.ts

@@ -0,0 +1,37 @@
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { ContentModelParagraph } from '../block/ContentModelParagraph';
+import type { ContentModelSegment } from '../segment/ContentModelSegment';
+import type { ContentModelTable } from '../block/ContentModelTable';
+import type { DOMSelection } from '../selection/DOMSelection';
+/**
+ * Represents an indexer object which provides methods to help build backward relationship
+ * from DOM node to Content Model
+ */
+export interface DomIndexer {
+    /**
+     * Invoked when processing a segment
+     * @param segmentNode The new DOM node for this segment
+     * @param paragraph Parent paragraph of this segment
+     * @param segments The source segments
+     */
+    onSegment: (segmentNode: Node, paragraph: ContentModelParagraph, segments: ContentModelSegment[]) => void;
+    /**
+     * Invoked when new paragraph node is created in DOM tree
+     * @param paragraphElement The new DOM node for this paragraph
+     */
+    onParagraph: (paragraphElement: HTMLElement) => void;
+    /**
+     * Invoked when new table node is created in DOM tree
+     * @param tableElement The new DOM node for this table
+     */
+    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;
+    /**
+     * When document content or selection is changed by user, we need to use this function to update the content model
+     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.
+     * @param model Current cached content model
+     * @param newSelection Latest selection
+     * @param oldSelection @optional Original selection before this change
+     * @returns True if reconcile successfully, otherwise false
+     */
+    reconcileSelection: (model: ContentModelDocument, newSelection: DOMSelection, oldSelection?: DOMSelection) => boolean;
+}

package/lib/context/DomIndexer.js

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