[image_picker] Migrate image_picker to package:cross_file

packages/image_picker/image_picker_platform_interface/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.0.0
+
+* Breaking changes:
+    * pickImage now returns XFile instead of PickedFile
+    * pickVideo now returns XFile instead of PickedFile
+    * changed LostData file parameter type to XFile
+    * removed PickedFile class and its tests
+
 ## 2.1.0
 
 * Add `pickMultiImage` method.

packages/image_picker/image_picker_platform_interface/lib/image_picker_platform_interface.dart

@@ -4,3 +4,4 @@
 
 export 'package:image_picker_platform_interface/src/platform_interface/image_picker_platform.dart';
 export 'package:image_picker_platform_interface/src/types/types.dart';
+export 'package:cross_file/cross_file.dart';

packages/image_picker/image_picker_platform_interface/lib/src/method_channel/method_channel_image_picker.dart

@@ -6,6 +6,7 @@ import 'dart:async';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
+import 'package:image_picker_platform_interface/src/types/lost_data.dart';
 import 'package:meta/meta.dart' show visibleForTesting;
 
 import 'package:image_picker_platform_interface/image_picker_platform_interface.dart';
@@ -19,7 +20,7 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
   MethodChannel get channel => _channel;
 
   @override
-  Future<PickedFile?> pickImage({
+  Future<XFile?> pickImage({
     required ImageSource source,
     double? maxWidth,
     double? maxHeight,
@@ -33,11 +34,11 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
       imageQuality: imageQuality,
       preferredCameraDevice: preferredCameraDevice,
     );
-    return path != null ? PickedFile(path) : null;
+    return path != null ? XFile(path) : null;
   }
 
   @override
-  Future<List<PickedFile>?> pickMultiImage({
+  Future<List<XFile>?> pickMultiImage({
     double? maxWidth,
     double? maxHeight,
     int? imageQuality,
@@ -49,9 +50,9 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
     );
     if (paths == null) return null;
 
-    final List<PickedFile> files = [];
+    final List<XFile> files = [];
     for (final path in paths) {
-      files.add(PickedFile(path));
+      files.add(XFile(path));
     }
     return files;
   }
@@ -117,7 +118,7 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
   }
 
   @override
-  Future<PickedFile?> pickVideo({
+  Future<XFile?> pickVideo({
     required ImageSource source,
     CameraDevice preferredCameraDevice = CameraDevice.rear,
     Duration? maxDuration,
@@ -127,7 +128,7 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
       maxDuration: maxDuration,
       preferredCameraDevice: preferredCameraDevice,
     );
-    return path != null ? PickedFile(path) : null;
+    return path != null ? XFile(path) : null;
   }
 
   Future<String?> _pickVideoPath({
@@ -175,7 +176,7 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
     final String? path = result['path'];
 
     return LostData(
-      file: path != null ? PickedFile(path) : null,
+      file: path != null ? XFile(path) : null,
       exception: exception,
       type: retrieveType,
     );

packages/image_picker/image_picker_platform_interface/lib/src/platform_interface/image_picker_platform.dart

@@ -3,6 +3,8 @@
 // found in the LICENSE file.
 
 import 'dart:async';
+import 'package:cross_file/cross_file.dart';
+import 'package:image_picker_platform_interface/src/types/lost_data.dart';
 
 import 'package:plugin_platform_interface/plugin_platform_interface.dart';
 
@@ -40,7 +42,7 @@ abstract class ImagePickerPlatform extends PlatformInterface {
 
   // Next version of the API.
 
-  /// Returns a [PickedFile] with the image that was picked.
+  /// Returns a [XFile] with the image that was picked.
   ///
   /// The `source` argument controls where the image comes from. This can
   /// be either [ImageSource.camera] or [ImageSource.gallery].
@@ -68,7 +70,7 @@ abstract class ImagePickerPlatform extends PlatformInterface {
   /// in this call. You can then call [retrieveLostData] when your app relaunches to retrieve the lost data.
   ///
   /// If no images were picked, the return value is null.
-  Future<PickedFile?> pickImage({
+  Future<XFile?> pickImage({
     required ImageSource source,
     double? maxWidth,
     double? maxHeight,
@@ -78,7 +80,7 @@ abstract class ImagePickerPlatform extends PlatformInterface {
     throw UnimplementedError('pickImage() has not been implemented.');
   }
 
-  /// Returns a [List<PickedFile>] with the images that were picked.
+  /// Returns a [List<XFile>] with the images that were picked.
   ///
   /// The images come from the [ImageSource.gallery].
   ///
@@ -96,15 +98,15 @@ abstract class ImagePickerPlatform extends PlatformInterface {
   /// a warning message will be logged.
   ///
   /// If no images were picked, the return value is null.
-  Future<List<PickedFile>?> pickMultiImage({
+  Future<List<XFile>?> pickMultiImage({
     double? maxWidth,
     double? maxHeight,
     int? imageQuality,
   }) {
     throw UnimplementedError('pickMultiImage() has not been implemented.');
   }
 
-  /// Returns a [PickedFile] containing the video that was picked.
+  /// Returns a [XFile] containing the video that was picked.
   ///
   /// The [source] argument controls where the video comes from. This can
   /// be either [ImageSource.camera] or [ImageSource.gallery].
@@ -120,15 +122,15 @@ abstract class ImagePickerPlatform extends PlatformInterface {
   /// in this call. You can then call [retrieveLostData] when your app relaunches to retrieve the lost data.
   ///
   /// If no images were picked, the return value is null.
-  Future<PickedFile?> pickVideo({
+  Future<XFile?> pickVideo({
     required ImageSource source,
     CameraDevice preferredCameraDevice = CameraDevice.rear,
     Duration? maxDuration,
   }) {
     throw UnimplementedError('pickVideo() has not been implemented.');
   }
 
-  /// Retrieve the lost [PickedFile] file when [pickImage] or [pickVideo] failed because the MainActivity is destroyed. (Android only)
+  /// Retrieve the lost [XFile] file when [pickImage] or [pickVideo] failed because the MainActivity is destroyed. (Android only)
   ///
   /// Image or video can be lost if the MainActivity is destroyed. And there is no guarantee that the MainActivity is always alive.
   /// Call this method to retrieve the lost data and process the data according to your APP's business logic.

packages/image_picker/image_picker_platform_interface/lib/src/types/picked_file/lost_data.dart → packages/image_picker/image_picker_platform_interface/lib/src/types/lost_data.dart

@@ -2,6 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'package:cross_file/cross_file.dart';
 import 'package:flutter/services.dart';
 import 'package:image_picker_platform_interface/src/types/types.dart';
 
@@ -31,7 +32,7 @@ class LostData {
   /// The file that was lost in a previous [pickImage] or [pickVideo] call due to MainActivity being destroyed.
   ///
   /// Can be null if [exception] exists.
-  final PickedFile? file;
+  final XFile? file;
 
   /// The exception of the last [pickImage] or [pickVideo].
   ///

packages/image_picker/image_picker_platform_interface/lib/src/types/types.dart

@@ -5,7 +5,7 @@
 export 'camera_device.dart';
 export 'image_source.dart';
 export 'retrieve_type.dart';
-export 'picked_file/picked_file.dart';
+export 'lost_data.dart';
 
 /// Denotes that an image is being picked.
 const String kTypeImage = 'image';

packages/image_picker/image_picker_platform_interface/pubspec.yaml

@@ -4,7 +4,7 @@ repository: https://github.com/flutter/plugins/tree/master/packages/image_picker
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+image_picker%22
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 2.1.0
+version: 3.0.0
 
 environment:
   sdk: ">=2.12.0 <3.0.0"
@@ -16,6 +16,7 @@ dependencies:
   http: ^0.13.0
   meta: ^1.3.0
   plugin_platform_interface: ^2.0.0
+  cross_file: ^0.3.1+1
 
 dev_dependencies:
   flutter_test: