roosterjs-content-model-types 9.5.1 → 9.7.0

package/lib/context/DomIndexer.d.ts

@@ -35,4 +35,14 @@ export interface DomIndexer {
      * @returns True if reconcile successfully, otherwise false
      */
     reconcileSelection: (model: ContentModelDocument, newSelection: DOMSelection, oldSelection?: CacheSelection) => boolean;
+    /**
+     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.
+     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,
+     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment
+     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model
+     * @param addedNodes Nodes added by browser during mutation
+     * @param removedNodes Nodes removed by browser during mutation
+     * @returns True if the changed nodes are successfully reconciled, otherwise false
+     */
+    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;
 }

package/lib/context/DomIndexer.js.map

@@ -1 +1 @@
-{"version":3,"file":"DomIndexer.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/DomIndexer.ts"],"names":[],"mappings":"","sourcesContent":["import type { CacheSelection } from '../pluginState/CachePluginState';\nimport type { ContentModelDocument } from '../contentModel/blockGroup/ContentModelDocument';\nimport type { ContentModelParagraph } from '../contentModel/block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../contentModel/segment/ContentModelSegment';\nimport type { ContentModelTable } from '../contentModel/block/ContentModelTable';\nimport type { DOMSelection } from '../selection/DOMSelection';\n\n/**\n * Represents an indexer object which provides methods to help build backward relationship\n * from DOM node to Content Model\n */\nexport interface DomIndexer {\n    /**\n     * Invoked when processing a segment\n     * @param segmentNode The new DOM node for this segment\n     * @param paragraph Parent paragraph of this segment\n     * @param segments The source segments\n     */\n    onSegment: (\n        segmentNode: Node,\n        paragraph: ContentModelParagraph,\n        segments: ContentModelSegment[]\n    ) => void;\n\n    /**\n     * Invoked when new paragraph node is created in DOM tree\n     * @param paragraphElement The new DOM node for this paragraph\n     */\n    onParagraph: (paragraphElement: HTMLElement) => void;\n\n    /**\n     * Invoked when new table node is created in DOM tree\n     * @param tableElement The new DOM node for this table\n     */\n    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;\n\n    /**\n     * When document content or selection is changed by user, we need to use this function to update the content model\n     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.\n     * @param model Current cached content model\n     * @param newSelection Latest selection\n     * @param oldSelection @optional Original selection before this change\n     * @returns True if reconcile successfully, otherwise false\n     */\n    reconcileSelection: (\n        model: ContentModelDocument,\n        newSelection: DOMSelection,\n        oldSelection?: CacheSelection\n    ) => boolean;\n}\n"]}
+{"version":3,"file":"DomIndexer.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/DomIndexer.ts"],"names":[],"mappings":"","sourcesContent":["import type { CacheSelection } from '../pluginState/CachePluginState';\nimport type { ContentModelDocument } from '../contentModel/blockGroup/ContentModelDocument';\nimport type { ContentModelParagraph } from '../contentModel/block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../contentModel/segment/ContentModelSegment';\nimport type { ContentModelTable } from '../contentModel/block/ContentModelTable';\nimport type { DOMSelection } from '../selection/DOMSelection';\n\n/**\n * Represents an indexer object which provides methods to help build backward relationship\n * from DOM node to Content Model\n */\nexport interface DomIndexer {\n    /**\n     * Invoked when processing a segment\n     * @param segmentNode The new DOM node for this segment\n     * @param paragraph Parent paragraph of this segment\n     * @param segments The source segments\n     */\n    onSegment: (\n        segmentNode: Node,\n        paragraph: ContentModelParagraph,\n        segments: ContentModelSegment[]\n    ) => void;\n\n    /**\n     * Invoked when new paragraph node is created in DOM tree\n     * @param paragraphElement The new DOM node for this paragraph\n     */\n    onParagraph: (paragraphElement: HTMLElement) => void;\n\n    /**\n     * Invoked when new table node is created in DOM tree\n     * @param tableElement The new DOM node for this table\n     */\n    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;\n\n    /**\n     * When document content or selection is changed by user, we need to use this function to update the content model\n     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.\n     * @param model Current cached content model\n     * @param newSelection Latest selection\n     * @param oldSelection @optional Original selection before this change\n     * @returns True if reconcile successfully, otherwise false\n     */\n    reconcileSelection: (\n        model: ContentModelDocument,\n        newSelection: DOMSelection,\n        oldSelection?: CacheSelection\n    ) => boolean;\n\n    /**\n     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.\n     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,\n     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment\n     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model\n     * @param addedNodes Nodes added by browser during mutation\n     * @param removedNodes Nodes removed by browser during mutation\n     * @returns True if the changed nodes are successfully reconciled, otherwise false\n     */\n    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;\n}\n"]}

package/lib/context/TextMutationObserver.d.ts

@@ -11,7 +11,9 @@ export interface TextMutationObserver {
      */
     stopObserving(): void;
     /**
-     * Flush all pending mutations that have not be handled in order to ignore them
+     * Flush all pending mutations and update cached model if need
+     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.
+     * This should only be used when we already have a up-to-date content model and will set it as latest cache
      */
-    flushMutations(): void;
+    flushMutations(ignoreMutations?: boolean): void;
 }

package/lib/context/TextMutationObserver.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextMutationObserver.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/TextMutationObserver.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A wrapper of MutationObserver to observe text change from editor\n */\nexport interface TextMutationObserver {\n    /**\n     * Start observing mutations from editor\n     */\n    startObserving(): void;\n\n    /**\n     * Stop observing mutations from editor\n     */\n    stopObserving(): void;\n\n    /**\n     * Flush all pending mutations that have not be handled in order to ignore them\n     */\n    flushMutations(): void;\n}\n"]}
+{"version":3,"file":"TextMutationObserver.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/TextMutationObserver.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A wrapper of MutationObserver to observe text change from editor\n */\nexport interface TextMutationObserver {\n    /**\n     * Start observing mutations from editor\n     */\n    startObserving(): void;\n\n    /**\n     * Stop observing mutations from editor\n     */\n    stopObserving(): void;\n\n    /**\n     * Flush all pending mutations and update cached model if need\n     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.\n     * This should only be used when we already have a up-to-date content model and will set it as latest cache\n     */\n    flushMutations(ignoreMutations?: boolean): void;\n}\n"]}

package/lib-amd/context/DomIndexer.d.ts

@@ -35,4 +35,14 @@ export interface DomIndexer {
      * @returns True if reconcile successfully, otherwise false
      */
     reconcileSelection: (model: ContentModelDocument, newSelection: DOMSelection, oldSelection?: CacheSelection) => boolean;
+    /**
+     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.
+     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,
+     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment
+     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model
+     * @param addedNodes Nodes added by browser during mutation
+     * @param removedNodes Nodes removed by browser during mutation
+     * @returns True if the changed nodes are successfully reconciled, otherwise false
+     */
+    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;
 }

package/lib-amd/context/DomIndexer.js.map

@@ -1 +1 @@
-{"version":3,"file":"DomIndexer.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/DomIndexer.ts"],"names":[],"mappings":"","sourcesContent":["import type { CacheSelection } from '../pluginState/CachePluginState';\nimport type { ContentModelDocument } from '../contentModel/blockGroup/ContentModelDocument';\nimport type { ContentModelParagraph } from '../contentModel/block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../contentModel/segment/ContentModelSegment';\nimport type { ContentModelTable } from '../contentModel/block/ContentModelTable';\nimport type { DOMSelection } from '../selection/DOMSelection';\n\n/**\n * Represents an indexer object which provides methods to help build backward relationship\n * from DOM node to Content Model\n */\nexport interface DomIndexer {\n    /**\n     * Invoked when processing a segment\n     * @param segmentNode The new DOM node for this segment\n     * @param paragraph Parent paragraph of this segment\n     * @param segments The source segments\n     */\n    onSegment: (\n        segmentNode: Node,\n        paragraph: ContentModelParagraph,\n        segments: ContentModelSegment[]\n    ) => void;\n\n    /**\n     * Invoked when new paragraph node is created in DOM tree\n     * @param paragraphElement The new DOM node for this paragraph\n     */\n    onParagraph: (paragraphElement: HTMLElement) => void;\n\n    /**\n     * Invoked when new table node is created in DOM tree\n     * @param tableElement The new DOM node for this table\n     */\n    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;\n\n    /**\n     * When document content or selection is changed by user, we need to use this function to update the content model\n     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.\n     * @param model Current cached content model\n     * @param newSelection Latest selection\n     * @param oldSelection @optional Original selection before this change\n     * @returns True if reconcile successfully, otherwise false\n     */\n    reconcileSelection: (\n        model: ContentModelDocument,\n        newSelection: DOMSelection,\n        oldSelection?: CacheSelection\n    ) => boolean;\n}\n"]}
+{"version":3,"file":"DomIndexer.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/DomIndexer.ts"],"names":[],"mappings":"","sourcesContent":["import type { CacheSelection } from '../pluginState/CachePluginState';\nimport type { ContentModelDocument } from '../contentModel/blockGroup/ContentModelDocument';\nimport type { ContentModelParagraph } from '../contentModel/block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../contentModel/segment/ContentModelSegment';\nimport type { ContentModelTable } from '../contentModel/block/ContentModelTable';\nimport type { DOMSelection } from '../selection/DOMSelection';\n\n/**\n * Represents an indexer object which provides methods to help build backward relationship\n * from DOM node to Content Model\n */\nexport interface DomIndexer {\n    /**\n     * Invoked when processing a segment\n     * @param segmentNode The new DOM node for this segment\n     * @param paragraph Parent paragraph of this segment\n     * @param segments The source segments\n     */\n    onSegment: (\n        segmentNode: Node,\n        paragraph: ContentModelParagraph,\n        segments: ContentModelSegment[]\n    ) => void;\n\n    /**\n     * Invoked when new paragraph node is created in DOM tree\n     * @param paragraphElement The new DOM node for this paragraph\n     */\n    onParagraph: (paragraphElement: HTMLElement) => void;\n\n    /**\n     * Invoked when new table node is created in DOM tree\n     * @param tableElement The new DOM node for this table\n     */\n    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;\n\n    /**\n     * When document content or selection is changed by user, we need to use this function to update the content model\n     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.\n     * @param model Current cached content model\n     * @param newSelection Latest selection\n     * @param oldSelection @optional Original selection before this change\n     * @returns True if reconcile successfully, otherwise false\n     */\n    reconcileSelection: (\n        model: ContentModelDocument,\n        newSelection: DOMSelection,\n        oldSelection?: CacheSelection\n    ) => boolean;\n\n    /**\n     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.\n     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,\n     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment\n     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model\n     * @param addedNodes Nodes added by browser during mutation\n     * @param removedNodes Nodes removed by browser during mutation\n     * @returns True if the changed nodes are successfully reconciled, otherwise false\n     */\n    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;\n}\n"]}

package/lib-amd/context/TextMutationObserver.d.ts

@@ -11,7 +11,9 @@ export interface TextMutationObserver {
      */
     stopObserving(): void;
     /**
-     * Flush all pending mutations that have not be handled in order to ignore them
+     * Flush all pending mutations and update cached model if need
+     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.
+     * This should only be used when we already have a up-to-date content model and will set it as latest cache
      */
-    flushMutations(): void;
+    flushMutations(ignoreMutations?: boolean): void;
 }

package/lib-amd/context/TextMutationObserver.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextMutationObserver.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/TextMutationObserver.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A wrapper of MutationObserver to observe text change from editor\n */\nexport interface TextMutationObserver {\n    /**\n     * Start observing mutations from editor\n     */\n    startObserving(): void;\n\n    /**\n     * Stop observing mutations from editor\n     */\n    stopObserving(): void;\n\n    /**\n     * Flush all pending mutations that have not be handled in order to ignore them\n     */\n    flushMutations(): void;\n}\n"]}
+{"version":3,"file":"TextMutationObserver.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/TextMutationObserver.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A wrapper of MutationObserver to observe text change from editor\n */\nexport interface TextMutationObserver {\n    /**\n     * Start observing mutations from editor\n     */\n    startObserving(): void;\n\n    /**\n     * Stop observing mutations from editor\n     */\n    stopObserving(): void;\n\n    /**\n     * Flush all pending mutations and update cached model if need\n     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.\n     * This should only be used when we already have a up-to-date content model and will set it as latest cache\n     */\n    flushMutations(ignoreMutations?: boolean): void;\n}\n"]}

package/lib-mjs/context/DomIndexer.d.ts

@@ -35,4 +35,14 @@ export interface DomIndexer {
      * @returns True if reconcile successfully, otherwise false
      */
     reconcileSelection: (model: ContentModelDocument, newSelection: DOMSelection, oldSelection?: CacheSelection) => boolean;
+    /**
+     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.
+     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,
+     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment
+     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model
+     * @param addedNodes Nodes added by browser during mutation
+     * @param removedNodes Nodes removed by browser during mutation
+     * @returns True if the changed nodes are successfully reconciled, otherwise false
+     */
+    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;
 }

package/lib-mjs/context/DomIndexer.js.map

@@ -1 +1 @@
-{"version":3,"file":"DomIndexer.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/DomIndexer.ts"],"names":[],"mappings":"","sourcesContent":["import type { CacheSelection } from '../pluginState/CachePluginState';\nimport type { ContentModelDocument } from '../contentModel/blockGroup/ContentModelDocument';\nimport type { ContentModelParagraph } from '../contentModel/block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../contentModel/segment/ContentModelSegment';\nimport type { ContentModelTable } from '../contentModel/block/ContentModelTable';\nimport type { DOMSelection } from '../selection/DOMSelection';\n\n/**\n * Represents an indexer object which provides methods to help build backward relationship\n * from DOM node to Content Model\n */\nexport interface DomIndexer {\n    /**\n     * Invoked when processing a segment\n     * @param segmentNode The new DOM node for this segment\n     * @param paragraph Parent paragraph of this segment\n     * @param segments The source segments\n     */\n    onSegment: (\n        segmentNode: Node,\n        paragraph: ContentModelParagraph,\n        segments: ContentModelSegment[]\n    ) => void;\n\n    /**\n     * Invoked when new paragraph node is created in DOM tree\n     * @param paragraphElement The new DOM node for this paragraph\n     */\n    onParagraph: (paragraphElement: HTMLElement) => void;\n\n    /**\n     * Invoked when new table node is created in DOM tree\n     * @param tableElement The new DOM node for this table\n     */\n    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;\n\n    /**\n     * When document content or selection is changed by user, we need to use this function to update the content model\n     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.\n     * @param model Current cached content model\n     * @param newSelection Latest selection\n     * @param oldSelection @optional Original selection before this change\n     * @returns True if reconcile successfully, otherwise false\n     */\n    reconcileSelection: (\n        model: ContentModelDocument,\n        newSelection: DOMSelection,\n        oldSelection?: CacheSelection\n    ) => boolean;\n}\n"]}
+{"version":3,"file":"DomIndexer.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/DomIndexer.ts"],"names":[],"mappings":"","sourcesContent":["import type { CacheSelection } from '../pluginState/CachePluginState';\nimport type { ContentModelDocument } from '../contentModel/blockGroup/ContentModelDocument';\nimport type { ContentModelParagraph } from '../contentModel/block/ContentModelParagraph';\nimport type { ContentModelSegment } from '../contentModel/segment/ContentModelSegment';\nimport type { ContentModelTable } from '../contentModel/block/ContentModelTable';\nimport type { DOMSelection } from '../selection/DOMSelection';\n\n/**\n * Represents an indexer object which provides methods to help build backward relationship\n * from DOM node to Content Model\n */\nexport interface DomIndexer {\n    /**\n     * Invoked when processing a segment\n     * @param segmentNode The new DOM node for this segment\n     * @param paragraph Parent paragraph of this segment\n     * @param segments The source segments\n     */\n    onSegment: (\n        segmentNode: Node,\n        paragraph: ContentModelParagraph,\n        segments: ContentModelSegment[]\n    ) => void;\n\n    /**\n     * Invoked when new paragraph node is created in DOM tree\n     * @param paragraphElement The new DOM node for this paragraph\n     */\n    onParagraph: (paragraphElement: HTMLElement) => void;\n\n    /**\n     * Invoked when new table node is created in DOM tree\n     * @param tableElement The new DOM node for this table\n     */\n    onTable: (tableElement: HTMLTableElement, tableModel: ContentModelTable) => void;\n\n    /**\n     * When document content or selection is changed by user, we need to use this function to update the content model\n     * to reflect the latest document. This process can fail since the selected node may not have a related model data structure.\n     * @param model Current cached content model\n     * @param newSelection Latest selection\n     * @param oldSelection @optional Original selection before this change\n     * @returns True if reconcile successfully, otherwise false\n     */\n    reconcileSelection: (\n        model: ContentModelDocument,\n        newSelection: DOMSelection,\n        oldSelection?: CacheSelection\n    ) => boolean;\n\n    /**\n     * When child list of editor content is changed, we can use this method to do sync the change from editor into content model.\n     * This is mostly used when user start to type in an empty line. In that case browser will remove the existing BR node in the empty line if any,\n     * and create a new TEXT node for the typed text. Here we use these information to remove original Br segment and create a new Text segment\n     * in content model. But if we find anything that cannot be handled, return false so caller will invalidate the cached model\n     * @param addedNodes Nodes added by browser during mutation\n     * @param removedNodes Nodes removed by browser during mutation\n     * @returns True if the changed nodes are successfully reconciled, otherwise false\n     */\n    reconcileChildList: (addedNodes: ArrayLike<Node>, removedNodes: ArrayLike<Node>) => boolean;\n}\n"]}

package/lib-mjs/context/TextMutationObserver.d.ts

@@ -11,7 +11,9 @@ export interface TextMutationObserver {
      */
     stopObserving(): void;
     /**
-     * Flush all pending mutations that have not be handled in order to ignore them
+     * Flush all pending mutations and update cached model if need
+     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.
+     * This should only be used when we already have a up-to-date content model and will set it as latest cache
      */
-    flushMutations(): void;
+    flushMutations(ignoreMutations?: boolean): void;
 }

package/lib-mjs/context/TextMutationObserver.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextMutationObserver.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/TextMutationObserver.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A wrapper of MutationObserver to observe text change from editor\n */\nexport interface TextMutationObserver {\n    /**\n     * Start observing mutations from editor\n     */\n    startObserving(): void;\n\n    /**\n     * Stop observing mutations from editor\n     */\n    stopObserving(): void;\n\n    /**\n     * Flush all pending mutations that have not be handled in order to ignore them\n     */\n    flushMutations(): void;\n}\n"]}
+{"version":3,"file":"TextMutationObserver.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/context/TextMutationObserver.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A wrapper of MutationObserver to observe text change from editor\n */\nexport interface TextMutationObserver {\n    /**\n     * Start observing mutations from editor\n     */\n    startObserving(): void;\n\n    /**\n     * Stop observing mutations from editor\n     */\n    stopObserving(): void;\n\n    /**\n     * Flush all pending mutations and update cached model if need\n     * @param ignoreMutations When pass true, all mutations will be ignored and do not update content model.\n     * This should only be used when we already have a up-to-date content model and will set it as latest cache\n     */\n    flushMutations(ignoreMutations?: boolean): void;\n}\n"]}

package/package.json

@@ -2,7 +2,7 @@
     "name": "roosterjs-content-model-types",
     "description": "Types for roosterjs",
     "dependencies": {},
-    "version": "9.5.1",
+    "version": "9.7.0",
     "main": "./lib/index.js",
     "typings": "./lib/index.d.ts",
     "module": "./lib-mjs/index.js",