Bump RoosterJS 9.24.0 (#2981)

juliaroldi · JiuqingSong · web-flow · commit 8e54faa94fdb · 2025-04-07T19:14:53.000-03:00
* Support undeletable anchor Step 1: Support hidden properties (#2970) * Support undeletable anchor Step 1: Support hidden properties * improve comments * Support undeletable anchor Step 2: Add undeletable property to link (#2971) * Support undeletable anchor Step 1: Support hidden properties * Support undeletable anchor step 2 * improve comments * Support undeletable anchor Step 3: Support anchor (#2972) * Support undeletable anchor Step 1: Support hidden properties * Support undeletable anchor step 2 * improve comments * Support undeletable anchor Step 3 * Find previously marked paragraph (#2975) * Support undeletable anchor Step 4: Prevent deleting undeletable anchor (#2973) * Support undeletable anchor Step 1: Support hidden properties * Support undeletable anchor step 2 * improve comments * Support undeletable anchor Step 3 * Support undeletable anchor Step 4 * improve * add test * fix typo * Do not enable paragraph map by default (#2978) * Check selection for empty anchor (#2979) Co-authored-by: Julia Roldi <87443959+juliaroldi@users.noreply.github.com> * fix test --------- Co-authored-by: Jiuqing Song <jisong@microsoft.com>
diff --git a/packages/roosterjs-content-model-core/lib/corePlugin/cache/CachePlugin.ts b/packages/roosterjs-content-model-core/lib/corePlugin/cache/CachePlugin.ts
@@ -25,16 +25,22 @@ class CachePlugin implements PluginWithState<CachePluginState> {
      * @param contentDiv The editor content DIV
      */
     constructor(option: EditorOptions, contentDiv: HTMLDivElement) {
-        this.state = option.disableCache
-            ? {}
-            : {
-                  domIndexer: new DomIndexerImpl(
-                      option.experimentalFeatures &&
-                          option.experimentalFeatures.indexOf('PersistCache') >= 0
-                  ),
-                  textMutationObserver: createTextMutationObserver(contentDiv, this.onMutation),
-                  paragraphMap: createParagraphMap(),
-              };
+        this.state = {};
+
+        if (!option.disableCache) {
+            this.state.domIndexer = new DomIndexerImpl(
+                option.experimentalFeatures &&
+                    option.experimentalFeatures.indexOf('PersistCache') >= 0
+            );
+            this.state.textMutationObserver = createTextMutationObserver(
+                contentDiv,
+                this.onMutation
+            );
+        }
+
+        if (option.enableParagraphMap) {
+            this.state.paragraphMap = createParagraphMap();
+        }
     }
 
     /**
diff --git a/packages/roosterjs-content-model-core/test/corePlugin/cache/CachePluginTest.ts b/packages/roosterjs-content-model-core/test/corePlugin/cache/CachePluginTest.ts
@@ -76,7 +76,7 @@ describe('CachePlugin', () => {
             expect(plugin.getState()).toEqual({});
         });
 
-        it('initialize with cache', () => {
+        it('initialize without paragraph map', () => {
             const startObservingSpy = jasmine.createSpy('startObserving');
             const stopObservingSpy = jasmine.createSpy('stopObserving');
             const mockedObserver = {
@@ -90,6 +90,29 @@ describe('CachePlugin', () => {
                 disableCache: false,
             });
             expect(addEventListenerSpy).toHaveBeenCalledWith('selectionchange', jasmine.anything());
+            expect(plugin.getState()).toEqual({
+                domIndexer: new DomIndexerImpl(),
+                textMutationObserver: mockedObserver,
+            });
+            expect(resetMapSpy).not.toHaveBeenCalled();
+            expect(startObservingSpy).toHaveBeenCalledTimes(1);
+        });
+
+        it('initialize with cache and paragraph map', () => {
+            const startObservingSpy = jasmine.createSpy('startObserving');
+            const stopObservingSpy = jasmine.createSpy('stopObserving');
+            const mockedObserver = {
+                startObserving: startObservingSpy,
+                stopObserving: stopObservingSpy,
+            } as any;
+            spyOn(textMutationObserver, 'createTextMutationObserver').and.returnValue(
+                mockedObserver
+            );
+            init({
+                disableCache: false,
+                enableParagraphMap: true,
+            });
+            expect(addEventListenerSpy).toHaveBeenCalledWith('selectionchange', jasmine.anything());
             expect(plugin.getState()).toEqual({
                 domIndexer: new DomIndexerImpl(),
                 textMutationObserver: mockedObserver,
@@ -115,7 +138,9 @@ describe('CachePlugin', () => {
                 'createTextMutationObserver'
             ).and.returnValue(mockedObserver);
 
-            init({});
+            init({
+                enableParagraphMap: true,
+            });
 
             const state = plugin.getState();
 
@@ -371,7 +396,7 @@ describe('CachePlugin', () => {
 
     describe('ContentChanged', () => {
         beforeEach(() => {
-            init({ disableCache: true });
+            init({ disableCache: true, enableParagraphMap: true });
         });
         afterEach(() => {
             plugin.dispose();
@@ -392,9 +417,10 @@ describe('CachePlugin', () => {
             expect(state).toEqual({
                 cachedModel: undefined,
                 cachedSelection: undefined,
+                paragraphMap: mockedParagraphMap,
             });
             expect(reconcileSelectionSpy).not.toHaveBeenCalled();
-            expect(resetMapSpy).toHaveBeenCalledTimes(0);
+            expect(resetMapSpy).toHaveBeenCalledTimes(1);
         });
 
         it('No domIndexer, has model in event', () => {
@@ -418,9 +444,10 @@ describe('CachePlugin', () => {
             expect(state).toEqual({
                 cachedModel: undefined,
                 cachedSelection: undefined,
+                paragraphMap: mockedParagraphMap,
             });
             expect(reconcileSelectionSpy).not.toHaveBeenCalled();
-            expect(resetMapSpy).toHaveBeenCalledTimes(0);
+            expect(resetMapSpy).toHaveBeenCalledTimes(1);
         });
 
         it('Has domIndexer, has model in event', () => {
@@ -446,6 +473,7 @@ describe('CachePlugin', () => {
                 cachedModel: model,
                 cachedSelection: newRangeEx,
                 domIndexer,
+                paragraphMap: mockedParagraphMap,
             });
             expect(reconcileSelectionSpy).not.toHaveBeenCalled();
             expect(resetMapSpy).toHaveBeenCalledTimes(0);
@@ -479,7 +507,7 @@ describe('CachePlugin', () => {
                 }
             );
 
-            init({});
+            init({ enableParagraphMap: true });
 
             mockedIndexer = {
                 reconcileSelection: reconcileSelectionSpy,
diff --git a/packages/roosterjs-content-model-dom/lib/domToModel/processors/linkProcessor.ts b/packages/roosterjs-content-model-dom/lib/domToModel/processors/linkProcessor.ts
@@ -27,13 +27,16 @@ export const linkProcessor: ElementProcessor<HTMLElement> = (group, element, con
 
             if (isAnchor && !element.firstChild) {
                 // Empty anchor, need to make sure it has some child in model
-                addSegment(
-                    group,
-                    createText('', context.segmentFormat, {
-                        dataset: context.link.dataset,
-                        format: context.link.format,
-                    })
-                );
+                const emptyText = createText('', context.segmentFormat, {
+                    dataset: context.link.dataset,
+                    format: context.link.format,
+                });
+
+                if (context.isInSelection) {
+                    emptyText.isSelected = true;
+                }
+
+                addSegment(group, emptyText);
             } else {
                 knownElementProcessor(group, element, context);
             }
diff --git a/packages/roosterjs-content-model-dom/test/domToModel/processors/linkProcessorTest.ts b/packages/roosterjs-content-model-dom/test/domToModel/processors/linkProcessorTest.ts
@@ -359,4 +359,79 @@ describe('linkProcessor', () => {
             dataset: {},
         });
     });
+
+    it('empty anchor', () => {
+        const group = createContentModelDocument();
+        const a = document.createElement('a');
+
+        a.name = 'name';
+
+        linkProcessor(group, a, context);
+
+        expect(group).toEqual({
+            blockGroupType: 'Document',
+
+            blocks: [
+                {
+                    blockType: 'Paragraph',
+                    format: {},
+                    isImplicit: true,
+                    segments: [
+                        {
+                            segmentType: 'Text',
+                            format: {},
+                            link: {
+                                format: { name: 'name' },
+                                dataset: {},
+                            },
+                            text: '',
+                        },
+                    ],
+                },
+            ],
+        });
+        expect(context.link).toEqual({
+            format: {},
+            dataset: {},
+        });
+    });
+
+    it('selected empty anchor', () => {
+        const group = createContentModelDocument();
+        const a = document.createElement('a');
+
+        a.name = 'name';
+
+        context.isInSelection = true;
+
+        linkProcessor(group, a, context);
+
+        expect(group).toEqual({
+            blockGroupType: 'Document',
+
+            blocks: [
+                {
+                    blockType: 'Paragraph',
+                    format: {},
+                    isImplicit: true,
+                    segments: [
+                        {
+                            segmentType: 'Text',
+                            format: {},
+                            isSelected: true,
+                            link: {
+                                format: { name: 'name' },
+                                dataset: {},
+                            },
+                            text: '',
+                        },
+                    ],
+                },
+            ],
+        });
+        expect(context.link).toEqual({
+            format: {},
+            dataset: {},
+        });
+    });
 });
diff --git a/packages/roosterjs-content-model-types/lib/editor/EditorOptions.ts b/packages/roosterjs-content-model-types/lib/editor/EditorOptions.ts
@@ -174,6 +174,12 @@ export interface EditorBaseOptions {
      * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
      */
     announcerStringGetter?: (key: KnownAnnounceStrings) => string;
+
+    /**
+     * Whether to enable paragraph map. Default value is false.
+     * Paragraph map is used to save a marker for paragraphs so it can be found even content is changed from a previous marked paragraph.
+     */
+    enableParagraphMap?: boolean;
 }
 
 /**
diff --git a/versions.json b/versions.json
@@ -1,6 +1,6 @@
 {
     "react": "9.0.2",
-    "main": "9.23.0",
+    "main": "9.24.0",
     "legacyAdapter": "8.63.2",
     "overrides": {}
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"react": "9.0.2",`
`3`		`- "main": "9.23.0",`
	`3`	`+ "main": "9.24.0",`
`4`	`4`	`"legacyAdapter": "8.63.2",`
`5`	`5`	`"overrides": {}`
`6`	`6`	`}`