✨ Integrate PermissionRequestOption for callers (#517)

CHANGELOG.md

@@ -6,6 +6,12 @@ that can be found in the LICENSE file. -->
 
 See the [Migration Guide](guides/migration_guide.md) for the details of breaking changes between versions.
 
+## 9.0.0-dev.1
+
+### Breaking changes
+
+- Integrate `PermissionRequestOption` for callers.
+
 ## 8.9.0-dev.1
 
 ### Breaking changes

example/android/app/build.gradle

@@ -27,7 +27,7 @@ apply plugin: 'kotlin-kapt'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 33
+    compileSdkVersion 34
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
@@ -40,7 +40,7 @@ android {
     defaultConfig {
         applicationId "com.fluttercandies.wechatAssetsPickerExample"
         minSdkVersion 21
-        targetSdkVersion 33
+        targetSdkVersion 34
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

example/lib/customs/pickers/insta_asset_picker.dart

@@ -59,8 +59,14 @@ class _InstaAssetPickerState extends State<InstaAssetPicker> {
   }
 
   Future<void> callPicker(BuildContext context) async {
-    final PermissionState ps = await AssetPicker.permissionCheck();
-
+    final PermissionState ps = await AssetPicker.permissionCheck(
+      requestOption: PermissionRequestOption(
+        androidPermission: AndroidPermission(
+          type: provider.requestType,
+          mediaLocation: false,
+        ),
+      ),
+    );
     final InstaAssetPickerBuilder builder = InstaAssetPickerBuilder(
       provider: provider,
       initialPermission: ps,

example/lib/customs/pickers/multi_tabs_assets_picker.dart

@@ -30,7 +30,14 @@ class _MultiTabAssetPickerState extends State<MultiTabAssetPicker> {
   bool isDisplayingDetail = true;
 
   Future<void> callPicker(BuildContext context) async {
-    final PermissionState ps = await AssetPicker.permissionCheck();
+    final PermissionState ps = await AssetPicker.permissionCheck(
+      requestOption: const PermissionRequestOption(
+        androidPermission: AndroidPermission(
+          type: RequestType.all,
+          mediaLocation: false,
+        ),
+      ),
+    );
 
     final DefaultAssetPickerProvider provider = DefaultAssetPickerProvider(
       selectedAssets: entities,

example/pubspec.yaml

@@ -1,6 +1,6 @@
 name: wechat_assets_picker_demo
 description: The demo project for the wechat_assets_picker package.
-version: 8.8.0+47
+version: 9.0.0+48
 publish_to: none
 
 environment:

guides/migration_guide.md

@@ -8,6 +8,7 @@ This document gathered all breaking changes and migrations requirement between m
 
 ## Major versions
 
+- [9.0.0](#900)
 - [8.6.0](#860)
 - [8.3.0](#830)
 - [8.2.0](#820)
@@ -16,6 +17,65 @@ This document gathered all breaking changes and migrations requirement between m
 - [6.0.0](#600)
 - [5.0.0](#500)
 
+## 9.0.0
+
+### Summary
+
+`PermissionRequestOption` has been added to
+`AssetPickerDelegate.permissionCheck` and
+`AssetPickerDelegate.pickAssetsWithDelegate` as an argument.
+Classes that extend `AssetPickerDelegate` and override these methods must migrate,
+Delegates that use `AssetPicker.permissionCheck`
+should choose whether to pass the request option.
+
+### Details
+
+Before:
+
+1. ```dart
+   AssetPicker.permissionCheck();
+   ```
+
+2. ```dart
+   Future<PermissionState> permissionCheck();
+   ```
+
+3. ```dart
+   Future<List<Asset>?> pickAssetsWithDelegate<Asset, Path,
+      PickerProvider extends AssetPickerProvider<Asset, Path>>(
+    BuildContext context, {
+    required AssetPickerBuilderDelegate<Asset, Path> delegate,
+    Key? key,
+    bool useRootNavigator = true,
+    AssetPickerPageRouteBuilder<List<Asset>>? pageRouteBuilder,
+   })
+   ```
+
+After:
+
+1. ```dart
+   AssetPicker.permissionCheck(requestOption: ...);
+   ```
+
+2. ```dart
+   Future<PermissionState> permissionCheck({
+     PermissionRequestOption requestOption = const PermissionRequestOption,
+   });
+   ```
+
+3. ```dart
+   Future<List<Asset>?> pickAssetsWithDelegate<Asset, Path,
+      PickerProvider extends AssetPickerProvider<Asset, Path>>(
+    BuildContext context, {
+    required AssetPickerBuilderDelegate<Asset, Path> delegate,
+    PermissionRequestOption requestOption =
+        const PermissionRequestOption,
+    Key? key,
+    bool useRootNavigator = true,
+    AssetPickerPageRouteBuilder<List<Asset>>? pageRouteBuilder,
+   })
+   ```
+
 ## 8.6.0
 
 ### Summary

lib/src/delegates/asset_picker_delegate.dart

@@ -29,8 +29,12 @@ class AssetPickerDelegate {
   /// See also:
   ///  * [PermissionState] which defined all states of required permissions.
   /// {@endtemplate}
-  Future<PermissionState> permissionCheck() async {
-    final PermissionState ps = await PhotoManager.requestPermissionExtend();
+  Future<PermissionState> permissionCheck({
+    PermissionRequestOption requestOption = const PermissionRequestOption(),
+  }) async {
+    final PermissionState ps = await PhotoManager.requestPermissionExtend(
+      requestOption: requestOption,
+    );
     if (ps != PermissionState.authorized && ps != PermissionState.limited) {
       throw StateError('Permission state error with $ps.');
     }
@@ -64,7 +68,14 @@ class AssetPickerDelegate {
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<AssetEntity>>? pageRouteBuilder,
   }) async {
-    final PermissionState ps = await permissionCheck();
+    final PermissionState ps = await permissionCheck(
+      requestOption: PermissionRequestOption(
+        androidPermission: AndroidPermission(
+          type: pickerConfig.requestType,
+          mediaLocation: false,
+        ),
+      ),
+    );
     final AssetPickerPageRoute<List<AssetEntity>> route =
         pageRouteBuilder?.call(const SizedBox.shrink()) ??
             AssetPickerPageRoute<List<AssetEntity>>(
@@ -134,11 +145,13 @@ class AssetPickerDelegate {
       PickerProvider extends AssetPickerProvider<Asset, Path>>(
     BuildContext context, {
     required AssetPickerBuilderDelegate<Asset, Path> delegate,
+    PermissionRequestOption permissionRequestOption =
+        const PermissionRequestOption(),
     Key? key,
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<Asset>>? pageRouteBuilder,
   }) async {
-    await permissionCheck();
+    await permissionCheck(requestOption: permissionRequestOption);
     final Widget picker = AssetPicker<Asset, Path>(
       key: key,
       builder: delegate,

lib/src/widget/asset_picker.dart

@@ -31,8 +31,10 @@ class AssetPicker<Asset, Path> extends StatefulWidget {
   }
 
   /// {@macro wechat_assets_picker.delegates.AssetPickerDelegate.permissionCheck}
-  static Future<PermissionState> permissionCheck() {
-    return _pickerDelegate.permissionCheck();
+  static Future<PermissionState> permissionCheck({
+    PermissionRequestOption requestOption = const PermissionRequestOption(),
+  }) {
+    return _pickerDelegate.permissionCheck(requestOption: requestOption);
   }
 
   /// {@macro wechat_assets_picker.delegates.AssetPickerDelegate.pickAssets}

lib/src/widget/asset_picker_viewer.dart

@@ -41,8 +41,10 @@ class AssetPickerViewer<Asset, Path> extends StatefulWidget {
     int? maxAssets,
     bool shouldReversePreview = false,
     AssetSelectPredicate<AssetEntity>? selectPredicate,
+    PermissionRequestOption permissionRequestOption =
+        const PermissionRequestOption(),
   }) async {
-    await AssetPicker.permissionCheck();
+    await AssetPicker.permissionCheck(requestOption: permissionRequestOption);
     final Widget viewer = AssetPickerViewer<AssetEntity, AssetPathEntity>(
       builder: DefaultAssetPickerViewerBuilderDelegate(
         currentIndex: currentIndex,
@@ -82,8 +84,10 @@ class AssetPickerViewer<Asset, Path> extends StatefulWidget {
   static Future<List<A>?> pushToViewerWithDelegate<A, P>(
     BuildContext context, {
     required AssetPickerViewerBuilderDelegate<A, P> delegate,
+    PermissionRequestOption permissionRequestOption =
+        const PermissionRequestOption(),
   }) async {
-    await AssetPicker.permissionCheck();
+    await AssetPicker.permissionCheck(requestOption: permissionRequestOption);
     final Widget viewer = AssetPickerViewer<A, P>(builder: delegate);
     final PageRouteBuilder<List<A>> pageRoute = PageRouteBuilder<List<A>>(
       pageBuilder: (_, __, ___) => viewer,

pubspec.yaml

@@ -1,5 +1,5 @@
 name: wechat_assets_picker
-version: 8.9.0-dev.1
+version: 9.0.0-dev.1
 description: |
   An image picker (also with videos and audio)
   for Flutter projects based on WeChat's UI,

test/test_utils.dart

@@ -73,7 +73,9 @@ class TestPhotoManagerPlugin extends PhotoManagerPlugin {
 
 class TestAssetPickerDelegate extends AssetPickerDelegate {
   @override
-  Future<PermissionState> permissionCheck() async {
+  Future<PermissionState> permissionCheck({
+    PermissionRequestOption requestOption = const PermissionRequestOption(),
+  }) async {
     return SynchronousFuture<PermissionState>(PermissionState.authorized);
   }
 
@@ -85,7 +87,14 @@ class TestAssetPickerDelegate extends AssetPickerDelegate {
     bool useRootNavigator = true,
     AssetPickerPageRouteBuilder<List<AssetEntity>>? pageRouteBuilder,
   }) async {
-    final PermissionState ps = await permissionCheck();
+    final PermissionState ps = await permissionCheck(
+      requestOption: PermissionRequestOption(
+        androidPermission: AndroidPermission(
+          type: pickerConfig.requestType,
+          mediaLocation: false,
+        ),
+      ),
+    );
     final AssetPathEntity pathEntity = AssetPathEntity(
       id: 'test',
       name: 'pathEntity',