feat: list API init commit

packages/amplify_core/lib/src/category/amplify_storage_category.dart

@@ -37,7 +37,7 @@ class StorageCategory extends AmplifyCategory<StoragePluginInterface> {
   /// returns a [StorageListOperation].
   /// {@endtemplate}
   StorageListOperation list({
-    String? path,
+    required StoragePath path,
     StorageListOptions? options,
   }) {
     return identifyCall(

packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart

@@ -16,7 +16,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface {
 
   /// {@macro amplify_core.amplify_storage_category.list}
   StorageListOperation list({
-    String? path,
+    required StoragePath path,
     StorageListOptions? options,
   }) {
     throw UnimplementedError('list() has not been implemented.');

packages/amplify_core/lib/src/types/storage/list_request.dart

@@ -9,12 +9,12 @@ import 'package:amplify_core/amplify_core.dart';
 class StorageListRequest {
   /// {@macro amplify_core.storage.list_request}
   const StorageListRequest({
-    this.path,
+    required this.path,
     this.options,
   });
 
   /// Path to list objects under.
-  final String? path;
+  final StoragePath path;
 
   /// Configurable options of the [StorageListRequest].
   final StorageListOptions? options;

packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart

@@ -702,8 +702,8 @@ void main() {
 
             // Call list() and ensure length of result matches pageSize.
             final listResult = await Amplify.Storage.list(
+              path: StoragePath.withIdentityId((identityId) => '/private/$identityId/'),
               options: const StorageListOptions(
-                accessLevel: accessLevel,
                 pageSize: filesToList,
               ),
             ).result;
@@ -749,12 +749,15 @@ void main() {
             do {
               // Call list() until nextToken is null and ensure we paginated expected times.
               final listResult = await Amplify.Storage.list(
+                path: StoragePath.withIdentityId(
+                  (identityId) => '/private/$identityId/',
+                ),
                 options: StorageListOptions(
                   accessLevel: accessLevel,
                   pageSize: filesToList,
                   nextToken: lastNextToken,
                 ),
-                path: keyPrefix,
+                // path: keyPrefix,
               ).result;
               lastNextToken = listResult.nextToken;
               timesCalled++;
@@ -774,9 +777,10 @@ void main() {
               'remove many objects belongs to the currently signed user',
               (WidgetTester tester) async {
             final listedObjects = await Amplify.Storage.list(
-              options: const StorageListOptions(
-                accessLevel: StorageAccessLevel.private,
+              path: StoragePath.withIdentityId(
+                (identityId) => '/private/$identityId/',
               ),
+              options: const StorageListOptions(),
             ).result;
             expect(listedObjects.items, hasLength(2));
 
@@ -814,9 +818,10 @@ void main() {
             'remove many objects belongs to the currently signed user',
             (WidgetTester tester) async {
           final listedObjects = await Amplify.Storage.list(
-            options: const StorageListOptions(
-              accessLevel: StorageAccessLevel.private,
+            path: StoragePath.withIdentityId(
+              (identityId) => '/private/$identityId/',
             ),
+            options: const StorageListOptions(),
           ).result;
           expect(listedObjects.items, hasLength(2));
 

packages/storage/amplify_storage_s3/example/lib/main.dart

@@ -162,8 +162,8 @@ class _HomeScreenState extends State<HomeScreen> {
   Future<void> _listAllPublicFiles() async {
     try {
       final result = await Amplify.Storage.list(
+        path: const StoragePath.fromString('/public'),
         options: const StorageListOptions(
-          accessLevel: StorageAccessLevel.guest,
           pluginOptions: S3ListPluginOptions.listAll(),
         ),
       ).result;

packages/storage/amplify_storage_s3_dart/example/bin/example.dart

@@ -95,7 +95,7 @@ Future<void> listOperation() async {
           pageSize: pageSize,
         );
   final operation = s3Plugin.list(
-    path: path,
+    path: StoragePath.fromString(path),
     options: options,
   );
 
@@ -133,7 +133,7 @@ Future<void> listOperation() async {
 
     result = await s3Plugin
         .list(
-          path: path,
+          path: StoragePath.fromString(path),
           options: StorageListOptions(
             accessLevel: accessLevel,
             pageSize: pageSize,

packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart

@@ -141,15 +141,14 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
 
   @override
   S3ListOperation list({
-    String? path,
+    required StoragePath path,
     StorageListOptions? options,
   }) {
     final s3PluginOptions = reifyPluginOptions(
       pluginOptions: options?.pluginOptions,
       defaultPluginOptions: const S3ListPluginOptions(),
     );
     final s3Options = StorageListOptions(
-      accessLevel: options?.accessLevel,
       pluginOptions: s3PluginOptions,
       nextToken: options?.nextToken,
       pageSize: options?.pageSize ?? 1000,

packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart

@@ -131,7 +131,7 @@ class StorageS3Service {
   /// service returned [smithy.UnknownSmithyHttpException] if any.
   /// {@endtemplate}
   Future<S3ListResult> list({
-    String? path,
+    required StoragePath path,
     required StorageListOptions options,
   }) async {
     final s3PluginOptions = options.pluginOptions as S3ListPluginOptions? ??

packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart

@@ -134,7 +134,7 @@ void main() {
     });
 
     group('list()', () {
-      const testPath = 'some/path';
+      const testPath = StoragePath.fromString('/some/path');
       final testResult = S3ListResult(
         <S3Item>[],
         hasNextPage: false,
@@ -189,7 +189,6 @@ void main() {
 
       test('should forward options to StorageS3Service.list() API', () async {
         const testOptions = StorageListOptions(
-          accessLevel: testAccessLevelProtected,
           pluginOptions: S3ListPluginOptions(excludeSubPaths: true),
           nextToken: 'next-token-123',
           pageSize: 2,

packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart

@@ -97,7 +97,7 @@ void main() {
         //StorageListOption<>(S3ListOptions.forIdentity('throw exception for me');
 
         await expectLater(
-          storageS3Service.list(path: 'a path', options: testOptions),
+          storageS3Service.list(path: const StoragePath.fromString('/a path'), options: testOptions),
           throwsA(isA<StorageException>()),
         );
 
@@ -133,7 +133,7 @@ void main() {
               ),
             )
             .toList();
-        const testPath = 'album';
+        const testPath = StoragePath.fromString('/album');
         const testTargetIdentityId = 'someone-else-id';
         const testOptions = StorageListOptions(
           pageSize: testPageSize,
@@ -211,7 +211,7 @@ void main() {
               ),
             )
             .toList();
-        const testPath = 'album';
+        const testPath = StoragePath.fromString('album');
         const testOptions = StorageListOptions(
           accessLevel: testStorageAccessLevel,
           pageSize: testPageSize,
@@ -278,7 +278,7 @@ void main() {
 
         expect(
           storageS3Service.list(
-            path: 'a path',
+            path: const StoragePath.fromString('apath'),
             options: testOptions,
           ),
           throwsA(isA<StorageAccessDeniedException>()),
@@ -297,7 +297,7 @@ void main() {
               ),
             )
             .toList();
-        const testPath = 'album';
+        const testPath = StoragePath.fromString('album');
         const testOptions = StorageListOptions(
           accessLevel: StorageAccessLevel.private,
           pageSize: testPageSize,
@@ -407,7 +407,7 @@ void main() {
 
         expect(
           storageS3Service.list(
-            path: 'a path',
+            path: const StoragePath.fromString('apath'),
             options: testOptions,
           ),
           throwsA(isA<NetworkException>()),