feat(docs-drawing): preserve image history semantics

Author: DR-Univer

packages/docs-drawing/src/commands/commands/__tests__/update-doc-drawing-transform.command.spec.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { IUpdateDrawingDocTransformCommandParams } from '@univerjs/docs-drawing';
+import { ICommandService, ImageSourceType } from '@univerjs/core';
+import { DocHistoryAction, RichTextEditingMutation } from '@univerjs/docs';
+import { UpdateDrawingDocTransformCommand } from '@univerjs/docs-drawing';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { createFacadeTestBed } from '../../../facade/__tests__/create-test-bed';
+
+class MockImage {
+    width = 800;
+    height = 400;
+    onload: (() => void) | null = null;
+    onerror: (() => void) | null = null;
+
+    get src(): string {
+        return '';
+    }
+
+    set src(_value: string) {
+        queueMicrotask(() => this.onload?.());
+    }
+}
+
+describe('UpdateDrawingDocTransformCommand', () => {
+    let testBed: ReturnType<typeof createFacadeTestBed>;
+
+    beforeEach(() => {
+        vi.stubGlobal('Image', MockImage);
+        testBed = createFacadeTestBed();
+    });
+
+    afterEach(() => {
+        testBed.univer.dispose();
+        vi.unstubAllGlobals();
+    });
+
+    it('marks image transforms for history action summaries', async () => {
+        const image = await testBed.document.insertImage({
+            source: 'data:image/png;base64,image',
+            imageSourceType: ImageSourceType.BASE64,
+            width: 160,
+            height: 90,
+            textRange: {
+                startOffset: 3,
+                endOffset: 3,
+                collapsed: true,
+                segmentId: '',
+            },
+        });
+        const commandService = testBed.injector.get(ICommandService);
+        const mutationSpy = vi.spyOn(commandService, 'syncExecuteCommand');
+
+        const result = commandService.syncExecuteCommand<IUpdateDrawingDocTransformCommandParams>(
+            UpdateDrawingDocTransformCommand.id,
+            {
+                unitId: 'test-doc',
+                subUnitId: 'test-doc',
+                drawings: [{ drawingId: image!.getId(), key: 'angle', value: 15 }],
+            }
+        );
+
+        expect(result).toBe(true);
+        expect(mutationSpy).toHaveBeenCalledWith(
+            RichTextEditingMutation.id,
+            expect.objectContaining({ historyAction: DocHistoryAction.UpdateImage })
+        );
+    });
+});

packages/docs-drawing/src/commands/commands/__tests__/update-doc-drawing-wrapping-style.command.spec.ts

@@ -26,6 +26,7 @@ import {
     PositionedObjectLayoutType,
     UniverInstanceType,
 } from '@univerjs/core';
+import { DocHistoryAction, RichTextEditingMutation } from '@univerjs/docs';
 import { TextWrappingStyle, UpdateDocDrawingWrappingStyleCommand } from '@univerjs/docs-drawing';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { createFacadeTestBed } from '../../../facade/__tests__/create-test-bed';
@@ -86,7 +87,9 @@ describe('UpdateDocDrawingWrappingStyleCommand', () => {
         );
         testBed.injector.get(IUniverInstanceService).focusUnit(otherDocument.getUnitId());
 
-        const result = testBed.injector.get(ICommandService).syncExecuteCommand<IUpdateDocDrawingWrappingStyleParams>(
+        const commandService = testBed.injector.get(ICommandService);
+        const mutationSpy = vi.spyOn(commandService, 'syncExecuteCommand');
+        const result = commandService.syncExecuteCommand<IUpdateDocDrawingWrappingStyleParams>(
             UpdateDocDrawingWrappingStyleCommand.id,
             {
                 unitId: 'test-doc',
@@ -100,6 +103,10 @@ describe('UpdateDocDrawingWrappingStyleCommand', () => {
         );
 
         expect(result).toBe(true);
+        expect(mutationSpy).toHaveBeenCalledWith(
+            RichTextEditingMutation.id,
+            expect.objectContaining({ historyAction: DocHistoryAction.UpdateImage })
+        );
         expect(testBed.document.getImage(image!.getId())?.getImageData()).toMatchObject({
             layoutType: PositionedObjectLayoutType.WRAP_NONE,
             behindDoc: BooleanNumber.TRUE,

packages/docs-drawing/src/commands/commands/update-doc-drawing-transform.command.ts

@@ -19,13 +19,14 @@ import type { IRichTextEditingMutationParams } from '@univerjs/docs';
 import type { IDocImage } from '../../services/doc-drawing.service';
 import {
     CommandType,
+    DrawingTypeEnum,
     ICommandService,
     IUniverInstanceService,
     JSONX,
     Tools,
     UniverInstanceType,
 } from '@univerjs/core';
-import { RichTextEditingMutation } from '@univerjs/docs';
+import { DocHistoryAction, RichTextEditingMutation } from '@univerjs/docs';
 
 export interface IDrawingDocTransform {
     drawingId: string;
@@ -57,6 +58,11 @@ export const UpdateDrawingDocTransformCommand: ICommand = {
         }
 
         const oldDrawings = documentDataModel.getSnapshot().drawings ?? {};
+        const historyAction = drawings.length > 0 && drawings.every(({ drawingId }) =>
+            oldDrawings[drawingId]?.drawingType === DrawingTypeEnum.DRAWING_IMAGE
+        )
+            ? DocHistoryAction.UpdateImage
+            : undefined;
         const jsonX = JSONX.getInstance();
         const actions: JSONXActions = [];
 
@@ -78,6 +84,7 @@ export const UpdateDrawingDocTransformCommand: ICommand = {
 
         return Boolean(commandService.syncExecuteCommand<IRichTextEditingMutationParams, IRichTextEditingMutationParams>(RichTextEditingMutation.id, {
             unitId,
+            historyAction,
             actions: actions.reduce((acc, action) => JSONX.compose(acc, action as JSONXActions), null as JSONXActions),
             textRanges: null,
             debounce: true,

packages/docs-drawing/src/commands/commands/update-doc-drawing-wrapping-style.command.ts

@@ -20,14 +20,15 @@ import type { IDocDrawing } from '../../services/doc-drawing.service';
 import {
     BooleanNumber,
     CommandType,
+    DrawingTypeEnum,
     ICommandService,
     IUniverInstanceService,
     JSONX,
     PositionedObjectLayoutType,
     Tools,
     UniverInstanceType,
 } from '@univerjs/core';
-import { RichTextEditingMutation } from '@univerjs/docs';
+import { DocHistoryAction, RichTextEditingMutation } from '@univerjs/docs';
 
 /**
  * Controls how a document drawing participates in text layout.
@@ -106,6 +107,11 @@ export const UpdateDocDrawingWrappingStyleCommand: ICommand = {
         }
 
         const oldDrawings = documentDataModel.getDrawings() ?? {};
+        const historyAction = drawings.length > 0 && drawings.every(({ drawingId }) =>
+            oldDrawings[drawingId]?.drawingType === DrawingTypeEnum.DRAWING_IMAGE
+        )
+            ? DocHistoryAction.UpdateImage
+            : undefined;
         const jsonX = JSONX.getInstance();
         const rawActions: JSONXActions = [];
 
@@ -142,6 +148,7 @@ export const UpdateDocDrawingWrappingStyleCommand: ICommand = {
             id: RichTextEditingMutation.id,
             params: {
                 unitId,
+                historyAction,
                 actions: rawActions.reduce(
                     (actions, action) => JSONX.compose(actions, action as JSONXActions),
                     null as JSONXActions

packages/docs/src/index.ts

@@ -19,6 +19,7 @@ export enum DocHistoryAction {
     EditTableCell = 'edit-table-cell',
     FormatParagraph = 'format-paragraph',
     InsertCustomRange = 'insert-custom-range',
+    UpdateImage = 'update-image',
     UpdatePageLayout = 'update-page-layout',
 }