merge: pull request #622 from hm21:dev

fix(state-manager): ensure background images are copied when updated

Author: hm21

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 11.2.1
+- **FIX**(state-history): Resolve issue where updating the background-image overwrote previous states.
+
 ## 11.2.0
 - **FEAT**(state-history): Added support for undo and redo when the background image is changed in the state history.
 

lib/core/models/editor_image.dart

@@ -229,6 +229,35 @@ class EditorImage {
     if (list == null) return 0;
     return list.fold(0, (hash, byte) => hash * 31 + byte);
   }
+
+  /// Creates a copy of this [EditorImage] with optional new values for its
+  /// fields.
+  ///
+  /// If a parameter is not provided, the current value from this instance
+  /// is used.
+  /// - [byteArray]: The new image data as a [Uint8List]. If provided, a
+  /// copy is created.
+  /// - [file]: The new image file as a [File]. If provided, a new [File]
+  /// instance is created with the same path.
+  /// - [networkUrl]: The new network URL for the image.
+  /// - [assetPath]: The new asset path for the image.
+  ///
+  /// Returns a new [EditorImage] instance with the updated values.
+  EditorImage copyWith({
+    Uint8List? byteArray,
+    File? file,
+    String? networkUrl,
+    String? assetPath,
+  }) {
+    final bytes = byteArray ?? this.byteArray;
+    final fileHelper = file ?? this.file;
+    return EditorImage(
+      byteArray: bytes != null ? Uint8List.fromList(bytes) : null,
+      file: fileHelper != null ? File(fileHelper.path) : null,
+      networkUrl: networkUrl ?? this.networkUrl,
+      assetPath: assetPath ?? this.assetPath,
+    );
+  }
 }
 
 /// Flutter EditorImageType Enum Documentation

lib/features/main_editor/main_editor.dart

@@ -1023,14 +1023,15 @@ class ProImageEditorState extends State<ProImageEditor>
       }
       stateManager.activeBackgroundImage = image;
     } else {
+      addHistory();
       stateManager.updateBackgroundImages(
         oldImage: editorImage ?? widget.editorImage!,
         newImage: image,
       );
-      addHistory();
     }
 
     await decodeImage();
+    _rebuildController.add(null);
   }
 
   @override

lib/features/main_editor/services/state_manager.dart

@@ -69,9 +69,9 @@ class StateManager {
     required EditorImage oldImage,
     required EditorImage newImage,
   }) {
-    _backgroundImages[historyPointer] = oldImage;
-    _backgroundImages[historyPointer + 1] = newImage;
-    activeBackgroundImage = newImage;
+    _backgroundImages[historyPointer - 1] ??= oldImage.copyWith();
+    _backgroundImages[historyPointer] = newImage.copyWith();
+    activeBackgroundImage = newImage.copyWith();
   }
 
   /// A setter for updating the state history list.
@@ -132,7 +132,7 @@ class StateManager {
     onStateHistoryChange?.call();
 
     if (_backgroundImages[historyPointer] != null) {
-      activeBackgroundImage = _backgroundImages[historyPointer];
+      activeBackgroundImage = _backgroundImages[historyPointer]!.copyWith();
     }
   }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: pro_image_editor
 description: "A Flutter image editor: Seamlessly enhance your images with user-friendly editing features."
-version: 11.2.0
+version: 11.2.1
 homepage: https://github.com/hm21/pro_image_editor/
 repository: https://github.com/hm21/pro_image_editor/
 documentation: https://github.com/hm21/pro_image_editor/