Remove parameter "reduced" from editor.getContentModelCopy (#2539)

* Fix 262677: Allow insert entity to a specified position without changing selection

* Remove "reduced" from getContentModelCopy

packages/roosterjs-content-model-core/lib/override/reducedModelChildProcessor.ts → packages/roosterjs-content-model-api/lib/modelApi/common/reducedModelChildProcessor.ts

@@ -20,7 +20,6 @@ interface FormatStateContext extends DomToModelContext {
 
 /**
  * @internal
- * Export for test only
  * In order to get format, we can still use the regular child processor. However, to improve performance, we don't need to create
  * content model for the whole doc, instead we only need to traverse the tree path that can arrive current selected node.
  * This "reduced" child processor will first create a node stack that stores DOM node from root to current common ancestor node of selection,

packages/roosterjs-content-model-api/lib/publicApi/format/getFormatState.ts

@@ -1,3 +1,4 @@
+import { reducedModelChildProcessor } from '../../modelApi/common/reducedModelChildProcessor';
 import { retrieveModelFormatState } from 'roosterjs-content-model-dom';
 import type { IEditor, ContentModelFormatState } from 'roosterjs-content-model-types';
 
@@ -7,15 +8,26 @@ import type { IEditor, ContentModelFormatState } from 'roosterjs-content-model-t
  */
 export function getFormatState(editor: IEditor): ContentModelFormatState {
     const pendingFormat = editor.getPendingFormat();
-    const model = editor.getContentModelCopy('reduced');
     const manager = editor.getSnapshotsManager();
     const result: ContentModelFormatState = {
         canUndo: manager.hasNewContent || manager.canMove(-1),
         canRedo: manager.canMove(1),
         isDarkMode: editor.isDarkMode(),
     };
 
-    retrieveModelFormatState(model, pendingFormat, result);
+    editor.formatContentModel(
+        model => {
+            retrieveModelFormatState(model, pendingFormat, result);
+
+            return false;
+        },
+        undefined /*options*/,
+        {
+            processorOverride: {
+                child: reducedModelChildProcessor,
+            },
+        }
+    );
 
     return result;
 }

packages/roosterjs-content-model-core/test/overrides/reducedModelChildProcessorTest.ts → packages/roosterjs-content-model-api/test/modelApi/common/reducedModelChildProcessorTest.ts

@@ -1,7 +1,7 @@
 import * as getSelectionRootNode from 'roosterjs-content-model-dom/lib/domUtils/selection/getSelectionRootNode';
 import { createContentModelDocument, createDomToModelContext } from 'roosterjs-content-model-dom';
 import { DomToModelContext } from 'roosterjs-content-model-types';
-import { reducedModelChildProcessor } from '../../lib/override/reducedModelChildProcessor';
+import { reducedModelChildProcessor } from '../../../lib/modelApi/common/reducedModelChildProcessor';
 
 describe('reducedModelChildProcessor', () => {
     let context: DomToModelContext;

packages/roosterjs-content-model-api/test/publicApi/format/getFormatStateTest.ts

@@ -3,7 +3,7 @@ import { ContentModelDocument, ContentModelSegmentFormat } from 'roosterjs-conte
 import { ContentModelFormatState } from 'roosterjs-content-model-types';
 import { getFormatState } from '../../../lib/publicApi/format/getFormatState';
 import { IEditor } from 'roosterjs-content-model-types';
-import { reducedModelChildProcessor } from 'roosterjs-content-model-core/lib/override/reducedModelChildProcessor';
+import { reducedModelChildProcessor } from '../../../lib/modelApi/common/reducedModelChildProcessor';
 import {
     createContentModelDocument,
     createDomToModelContext,
@@ -31,7 +31,7 @@ describe('getFormatState', () => {
             isDarkMode: () => false,
             getZoomScale: () => 1,
             getPendingFormat: () => pendingFormat,
-            getContentModelCopy: () => {
+            formatContentModel: (callback: Function) => {
                 const model = createContentModelDocument();
                 const editorDiv = document.createElement('div');
 
@@ -58,7 +58,7 @@ describe('getFormatState', () => {
 
                 normalizeContentModel(model);
 
-                return model;
+                callback(model);
             },
         } as any) as IEditor;
 

packages/roosterjs-content-model-core/lib/editor/Editor.ts

@@ -1,5 +1,4 @@
 import { createEditorCore } from './core/createEditorCore';
-import { reducedModelChildProcessor } from '../override/reducedModelChildProcessor';
 import {
     createEmptyModel,
     tableProcessor,
@@ -93,14 +92,10 @@ export class Editor implements IEditor {
      * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
      * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
      * If editor is in dark mode, the cloned entity will be converted back to light mode.
-     * - reduced: Returns a reduced Content Model that only contains the model of current selection. If there is already a up-to-date cached model, use it
-     * instead to improve performance. This is mostly used for retrieve current format state.
      * - clean: Similar with disconnected, this will return a disconnected model, the difference is "clean" mode will not include any selection info.
      * This is usually used for exporting content
      */
-    getContentModelCopy(
-        mode: 'connected' | 'disconnected' | 'reduced' | 'clean'
-    ): ContentModelDocument {
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'clean'): ContentModelDocument {
         const core = this.getCore();
 
         switch (mode) {
@@ -125,13 +120,6 @@ export class Editor implements IEditor {
                     core.api.createEditorContext(core, false /*saveIndex*/)
                 );
                 return domToContentModel(core.physicalRoot, domToModelContext);
-
-            case 'reduced':
-                return core.api.createContentModel(core, {
-                    processorOverride: {
-                        child: reducedModelChildProcessor,
-                    },
-                });
         }
     }
 

packages/roosterjs-content-model-core/test/editor/EditorTest.ts

@@ -7,7 +7,6 @@ import * as transformColor from 'roosterjs-content-model-dom/lib/domUtils/style/
 import { CachedElementHandler, EditorCore, Rect } from 'roosterjs-content-model-types';
 import { ChangeSource, tableProcessor } from 'roosterjs-content-model-dom';
 import { Editor } from '../../lib/editor/Editor';
-import { reducedModelChildProcessor } from '../../lib/override/reducedModelChildProcessor';
 
 describe('Editor', () => {
     let createEditorCoreSpy: jasmine.Spy;
@@ -134,18 +133,8 @@ describe('Editor', () => {
         expect(model1).toBe(mockedModel);
         expect(createContentModelSpy).toHaveBeenCalledWith(mockedCore);
 
-        const model2 = editor.getContentModelCopy('reduced');
-
-        expect(model2).toBe(mockedModel);
-        expect(createContentModelSpy).toHaveBeenCalledWith(mockedCore, {
-            processorOverride: {
-                child: reducedModelChildProcessor,
-            },
-        });
-
         editor.dispose();
         expect(() => editor.getContentModelCopy('connected')).toThrow();
-        expect(() => editor.getContentModelCopy('reduced')).toThrow();
         expect(resetSpy).toHaveBeenCalledWith();
     });
 

packages/roosterjs-content-model-types/lib/editor/IEditor.ts

@@ -31,14 +31,10 @@ export interface IEditor {
      * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
      * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
      * If editor is in dark mode, the cloned entity will be converted back to light mode.
-     * - reduced: Returns a reduced Content Model that only contains the model of current selection. If there is already a up-to-date cached model, use it
-     * instead to improve performance. This is mostly used for retrieve current format state.
      * - clean: Similar with disconnected, this will return a disconnected model, the difference is "clean" mode will not include any selection info.
      * This is usually used for exporting content
      */
-    getContentModelCopy(
-        mode: 'connected' | 'disconnected' | 'reduced' | 'clean'
-    ): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'clean'): ContentModelDocument;
 
     /**
      * Get current running environment, such as if editor is running on Mac

packages/roosterjs-editor-adapter/lib/editor/EditorAdapter.ts

@@ -1122,9 +1122,12 @@ export class EditorAdapter extends Editor implements ILegacyEditor {
     private retrieveFormatState(): ContentModelFormatState {
         const pendingFormat = this.getPendingFormat();
         const result: ContentModelFormatState = {};
-        const model = this.getContentModelCopy('reduced');
 
-        retrieveModelFormatState(model, pendingFormat, result);
+        this.formatContentModel(model => {
+            retrieveModelFormatState(model, pendingFormat, result);
+
+            return false;
+        });
 
         return result;
     }