[image_picker] add requestFullMetadata for iOS (optional permissions) - platform interface (#5603)

Author: PiotrMitkowski

packages/image_picker/image_picker_platform_interface/CHANGELOG.md

@@ -1,6 +1,10 @@
-## NEXT
+## 2.5.0
 
-* Minor fixes for new analysis options.
+* Deprecates `getImage` in favor of a new method `getImageFromSource`.
+    * Adds `requestFullMetadata` option that allows disabling extra permission requests
+      on certain platforms.
+    * Moves optional image picking parameters to `ImagePickerOptions` class.
+* Minor fixes for new analysis options. 
 
 ## 2.4.4
 

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

@@ -87,6 +87,7 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
     double? maxHeight,
     int? imageQuality,
     CameraDevice preferredCameraDevice = CameraDevice.rear,
+    bool requestFullMetadata = true,
   }) {
     if (imageQuality != null && (imageQuality < 0 || imageQuality > 100)) {
       throw ArgumentError.value(
@@ -108,7 +109,8 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
         'maxWidth': maxWidth,
         'maxHeight': maxHeight,
         'imageQuality': imageQuality,
-        'cameraDevice': preferredCameraDevice.index
+        'cameraDevice': preferredCameraDevice.index,
+        'requestFullMetadata': requestFullMetadata,
       },
     );
   }
@@ -197,6 +199,22 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
     return path != null ? XFile(path) : null;
   }
 
+  @override
+  Future<XFile?> getImageFromSource({
+    required ImageSource source,
+    ImagePickerOptions options = const ImagePickerOptions(),
+  }) async {
+    final String? path = await _getImagePath(
+      source: source,
+      maxHeight: options.maxHeight,
+      maxWidth: options.maxWidth,
+      imageQuality: options.imageQuality,
+      preferredCameraDevice: options.preferredCameraDevice,
+      requestFullMetadata: options.requestFullMetadata,
+    );
+    return path != null ? XFile(path) : null;
+  }
+
   @override
   Future<List<XFile>?> getMultiImage({
     double? maxWidth,

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

@@ -146,6 +146,8 @@ abstract class ImagePickerPlatform extends PlatformInterface {
     throw UnimplementedError('retrieveLostData() has not been implemented.');
   }
 
+  /// This method is deprecated in favor of [getImageFromSource] and will be removed in a future update.
+  ///
   /// Returns an [XFile] with the image that was picked.
   ///
   /// The `source` argument controls where the image comes from. This can
@@ -251,4 +253,34 @@ abstract class ImagePickerPlatform extends PlatformInterface {
   Future<LostDataResponse> getLostData() {
     throw UnimplementedError('getLostData() has not been implemented.');
   }
+
+  /// Returns an [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].
+  ///
+  /// The `options` argument controls additional settings that can be used when
+  /// picking an image. See [ImagePickerOptions] for more details.
+  ///
+  /// Where iOS supports HEIC images, Android 8 and below doesn't. Android 9 and
+  /// above only support HEIC images if used in addition to a size modification,
+  /// of which the usage is explained in [ImagePickerOptions].
+  ///
+  /// In Android, the MainActivity can be destroyed for various reasons. If that
+  /// happens, the result will be lost in this call. You can then call [getLostData]
+  /// when your app relaunches to retrieve the lost data.
+  ///
+  /// If no images were picked, the return value is null.
+  Future<XFile?> getImageFromSource({
+    required ImageSource source,
+    ImagePickerOptions options = const ImagePickerOptions(),
+  }) {
+    return getImage(
+      source: source,
+      maxHeight: options.maxHeight,
+      maxWidth: options.maxWidth,
+      imageQuality: options.imageQuality,
+      preferredCameraDevice: options.preferredCameraDevice,
+    );
+  }
 }

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

@@ -0,0 +1,50 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:image_picker_platform_interface/src/types/types.dart';
+
+/// Specifies options for picking a single image from the device's camera or gallery.
+class ImagePickerOptions {
+  /// Creates an instance with the given [maxHeight], [maxWidth], [imageQuality],
+  /// [referredCameraDevice] and [requestFullMetadata].
+  const ImagePickerOptions({
+    this.maxHeight,
+    this.maxWidth,
+    this.imageQuality,
+    this.preferredCameraDevice = CameraDevice.rear,
+    this.requestFullMetadata = true,
+  });
+
+  /// The maximum width of the image, in pixels.
+  ///
+  /// If null, the image will only be resized if [maxHeight] is specified.
+  final double? maxWidth;
+
+  /// The maximum height of the image, in pixels.
+  ///
+  /// If null, the image will only be resized if [maxWidth] is specified.
+  final double? maxHeight;
+
+  /// Modifies the quality of the image, ranging from 0-100 where 100 is the
+  /// original/max quality.
+  ///
+  /// Compression is only supported for certain image types such as JPEG. If
+  /// compression is not supported for the image that is picked, a warning
+  /// message will be logged.
+  ///
+  /// If null, the image will be returned with the original quality.
+  final int? imageQuality;
+
+  /// Used to specify the camera to use when the `source` is [ImageSource.camera].
+  ///
+  /// Ignored if the source is not [ImageSource.camera], or the chosen camera is not
+  /// supported on the device. Defaults to [CameraDevice.rear].
+  final CameraDevice preferredCameraDevice;
+
+  /// If true, requests full image metadata, which may require extra permissions
+  /// on some platforms, (e.g., NSPhotoLibraryUsageDescription on iOS).
+  //
+  // Defaults to true.
+  final bool requestFullMetadata;
+}

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

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 export 'camera_device.dart';
+export 'image_picker_options.dart';
 export 'image_source.dart';
 export 'lost_data_response.dart';
 export 'picked_file/picked_file.dart';

packages/image_picker/image_picker_platform_interface/pubspec.yaml

@@ -4,7 +4,7 @@ repository: https://github.com/flutter/plugins/tree/main/packages/image_picker/i
 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.4.4
+version: 2.5.0
 
 environment:
   sdk: ">=2.12.0 <3.0.0"