chore: update download apis to use path

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

@@ -91,43 +91,43 @@ class StorageCategory extends AmplifyCategory<StoragePluginInterface> {
   }
 
   /// {@template amplify_core.amplify_storage_category.download_data}
-  /// Downloads bytes of object specified by [key] into memory with optional
+  /// Downloads bytes of object specified by [path] into memory with optional
   /// [onProgress] and [StorageDownloadDataOptions], and returns a
   /// [StorageDownloadDataOperation].
   ///
   /// Ensure you are managing the data in memory properly to avoid unexpected
   /// memory leaks.
   /// {@endtemplate}
   StorageDownloadDataOperation downloadData({
-    required String key,
+    required StoragePath path,
     void Function(StorageTransferProgress)? onProgress,
     StorageDownloadDataOptions? options,
   }) {
     return identifyCall(
       StorageCategoryMethod.downloadData,
       () => defaultPlugin.downloadData(
-        key: key,
+        path: path,
         onProgress: onProgress,
         options: options,
       ),
     );
   }
 
   /// {@template amplify_core.amplify_storage_category.download_file}
-  /// Downloads the object specified by [key] to [localFile] with optional
+  /// Downloads the object specified by [path] to [localFile] with optional
   /// [onProgress] and [StorageDownloadFileOptions], and returns a
   /// [StorageDownloadFileOperation].
   /// {@endtemplate}
   StorageDownloadFileOperation downloadFile({
-    required String key,
+    required StoragePath path,
     required AWSFile localFile,
     void Function(StorageTransferProgress)? onProgress,
     StorageDownloadFileOptions? options,
   }) {
     return identifyCall(
       StorageCategoryMethod.downloadFile,
       () => defaultPlugin.downloadFile(
-        key: key,
+        path: path,
         localFile: localFile,
         onProgress: onProgress,
         options: options,

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

@@ -40,7 +40,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface {
 
   /// {@macro amplify_core.amplify_storage_category.download_data}
   StorageDownloadDataOperation downloadData({
-    required String key,
+    required StoragePath path,
     void Function(StorageTransferProgress)? onProgress,
     StorageDownloadDataOptions? options,
   }) {
@@ -49,7 +49,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface {
 
   /// {@macro amplify_core.amplify_storage_category.download_file}
   StorageDownloadFileOperation downloadFile({
-    required String key,
+    required StoragePath path,
     required AWSFile localFile,
     void Function(StorageTransferProgress)? onProgress,
     StorageDownloadFileOptions? options,

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

@@ -9,12 +9,12 @@ import 'package:amplify_core/amplify_core.dart';
 class StorageDownloadDataRequest {
   /// {@macro amplify_core.storage.download_data_request}
   const StorageDownloadDataRequest({
-    required this.key,
+    required this.path,
     this.options,
   });
 
-  /// Key of the object to download.
-  final String key;
+  /// Path of the object to download.
+  final StoragePath path;
 
   /// Configurable options of the [StorageDownloadDataRequest].
   final StorageDownloadDataOptions? options;

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

@@ -9,13 +9,13 @@ import 'package:amplify_core/amplify_core.dart';
 class StorageDownloadFileRequest {
   /// {@macro amplify_core.storage.download_file_request}
   const StorageDownloadFileRequest({
-    required this.key,
+    required this.path,
     required this.localFile,
     this.options,
   });
 
-  /// Key of the object to download.
-  final String key;
+  /// Path of the object to download.
+  final StoragePath path;
 
   /// Reference to the local file that download the object to.
   final AWSFile localFile;

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

@@ -72,10 +72,11 @@ void testTransferAcceleration({
             test('S3DataPayload ${entry.key}', () async {
               final dataPayload = entry.value;
               final result = await Amplify.Storage.downloadData(
-                key: dataPayload.targetKey,
-                options: StorageDownloadDataOptions(
-                  accessLevel: dataPayload.targetAccessLevel,
-                  pluginOptions: const S3DownloadDataPluginOptions(
+                path: StoragePath.fromString(
+                  '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}',
+                ),
+                options: const StorageDownloadDataOptions(
+                  pluginOptions: S3DownloadDataPluginOptions(
                     useAccelerateEndpoint: true,
                   ),
                 ),
@@ -156,9 +157,10 @@ void testTransferAcceleration({
               const end = 5 * 1024 + 12;
               final awsFile = entry.value;
               final result = await Amplify.Storage.downloadData(
-                key: awsFile.targetKey,
+                path: StoragePath.fromString(
+                  '${awsFile.targetAccessLevel}/${awsFile.targetKey}',
+                ),
                 options: StorageDownloadDataOptions(
-                  accessLevel: awsFile.targetAccessLevel,
                   pluginOptions: S3DownloadDataPluginOptions(
                     useAccelerateEndpoint: true,
                     bytesRange: S3DataBytesRange(start: start, end: end),

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

@@ -320,13 +320,14 @@ void main() {
         });
 
         testWidgets(
-            skip: true,
+            // skip: true,
             'download object as bytes data in memory with access level private'
             ' for the currently signed in user', (WidgetTester tester) async {
           final result = await Amplify.Storage.downloadData(
-            key: testObjectKey3,
+            path: StoragePath.withIdentityId(
+              (identityId) => '/private/$identityId/$testObjectKey3',
+            ),
             options: const StorageDownloadDataOptions(
-              accessLevel: StorageAccessLevel.private,
               pluginOptions: S3DownloadDataPluginOptions(
                 getProperties: true,
               ),
@@ -338,15 +339,16 @@ void main() {
         });
 
         testWidgets(
-            skip: true,
+            // skip: true,
             'download a range of bytes of an object with access level private'
             ' for the currently signed in user', (WidgetTester tester) async {
           const start = 5 * 1024;
           const end = 5 * 1024 + 12;
           final result = await Amplify.Storage.downloadData(
-            key: testObjectKey3,
+            path: StoragePath.withIdentityId(
+              (identityId) => '/private/$identityId/$testObjectKey3',
+            ),
             options: StorageDownloadDataOptions(
-              accessLevel: StorageAccessLevel.private,
               pluginOptions: S3DownloadDataPluginOptions(
                 getProperties: true,
                 bytesRange: S3DataBytesRange(
@@ -366,7 +368,7 @@ void main() {
         });
 
         testWidgets(
-          skip: true,
+          // skip: true,
           'download file with access level private for the currently signed in user',
           (WidgetTester tester) async {
             final s3Plugin =
@@ -377,10 +379,11 @@ void main() {
 
             final result = await s3Plugin
                 .downloadFile(
-                  key: testObjectKey3,
+                  path: StoragePath.withIdentityId(
+                    (identityId) => '/private/$identityId/$testObjectKey3',
+                  ),
                   localFile: localFile,
                   options: const StorageDownloadFileOptions(
-                    accessLevel: StorageAccessLevel.private,
                     pluginOptions: S3DownloadFilePluginOptions(
                       getProperties: true,
                     ),
@@ -618,14 +621,15 @@ void main() {
           });
 
           testWidgets(
-              skip: true,
+              // skip: true,
               'download data of object with access level protected and a target'
               ' identity id for the currently signed user',
               (WidgetTester tester) async {
             final result = await Amplify.Storage.downloadData(
-              key: testObjectKey2,
+              path: StoragePath.withIdentityId(
+                (identityId) => '/protected/$identityId/$testObjectKey2',
+              ),
               options: StorageDownloadDataOptions(
-                accessLevel: StorageAccessLevel.protected,
                 pluginOptions: S3DownloadDataPluginOptions.forIdentity(
                   user1IdentityId,
                   getProperties: true,
@@ -637,14 +641,15 @@ void main() {
           });
 
           testWidgets(
-              skip: true,
+              // skip: true,
               'download data of object (belongs to other user) with access level'
               ' private for the currently signed user',
               (WidgetTester tester) async {
             final operation = Amplify.Storage.downloadData(
-              key: testObjectKey3,
+              path: StoragePath.withIdentityId(
+                (identityId) => '/private/$identityId/$testObjectKey3',
+              ),
               options: const StorageDownloadDataOptions(
-                accessLevel: StorageAccessLevel.private,
                 pluginOptions: S3DownloadDataPluginOptions(
                   getProperties: true,
                 ),

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

@@ -181,7 +181,7 @@ class _HomeScreenState extends State<HomeScreen> {
     final filepath = '${documentsDir.path}/$key';
     try {
       await Amplify.Storage.downloadFile(
-        key: key,
+        path: StoragePath.fromString(key),
         localFile: AWSFile.fromPath(filepath),
         onProgress: (p0) => _logger
             .debug('Progress: ${(p0.transferredBytes / p0.totalBytes) * 100}%'),
@@ -196,7 +196,7 @@ class _HomeScreenState extends State<HomeScreen> {
   Future<void> downloadFileWeb(String key) async {
     try {
       await Amplify.Storage.downloadFile(
-        key: key,
+        path: StoragePath.fromString(key),
         localFile: AWSFile.fromPath(key),
         onProgress: (p0) => _logger
             .debug('Progress: ${(p0.transferredBytes / p0.totalBytes) * 100}%'),

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

@@ -207,7 +207,8 @@ Future<void> downloadDataOperation() async {
 
   final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey);
   final downloadDataOperation = s3Plugin.downloadData(
-    key: key,
+    // key: key,
+    path: StoragePath.fromString(key),
     options: StorageDownloadDataOptions(
       accessLevel: accessLevel,
       pluginOptions: const S3DownloadDataPluginOptions(
@@ -251,7 +252,8 @@ Future<void> downloadFileOperation() async {
 
   final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey);
   final downloadFileOperation = s3Plugin.downloadFile(
-    key: key,
+    // key: key,
+    path: StoragePath.fromString(key),
     localFile: localFile,
     options: StorageDownloadFileOptions(
       accessLevel: accessLevel,

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

@@ -222,7 +222,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
 
   @override
   S3DownloadDataOperation downloadData({
-    required String key,
+    required StoragePath path,
     StorageDownloadDataOptions? options,
     void Function(S3TransferProgress)? onProgress,
   }) {
@@ -232,21 +232,20 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
     );
 
     final s3Options = StorageDownloadDataOptions(
-      accessLevel: options?.accessLevel,
       pluginOptions: s3PluginOptions,
     );
 
     final bytes = BytesBuilder();
     final downloadTask = storageS3Service.downloadData(
-      key: key,
+      path: path,
       options: s3Options,
       onProgress: onProgress,
       onData: bytes.add,
     );
 
     return S3DownloadDataOperation(
       request: StorageDownloadDataRequest(
-        key: key,
+        path: path,
         options: options,
       ),
       result: downloadTask.result.then(
@@ -263,7 +262,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
 
   @override
   S3DownloadFileOperation downloadFile({
-    required String key,
+    required StoragePath path,
     required AWSFile localFile,
     void Function(S3TransferProgress)? onProgress,
     StorageDownloadFileOptions? options,
@@ -273,11 +272,10 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
       defaultPluginOptions: const S3DownloadFilePluginOptions(),
     );
     options = StorageDownloadFileOptions(
-      accessLevel: options?.accessLevel,
       pluginOptions: s3PluginOptions,
     );
     return download_file_impl.downloadFile(
-      key: key,
+      path: path,
       localFile: localFile,
       options: options,
       s3pluginConfig: s3pluginConfig,

packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart

@@ -20,7 +20,8 @@ S3DownloadFileOperation downloadFile({
 
   return S3DownloadFileOperation(
     request: StorageDownloadFileRequest(
-      key: key,
+      // TODO(khatruong2009): update to use path from customer
+      path: StoragePath.fromString(key),
       localFile: localFile,
       options: options,
     ),

packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart

@@ -7,12 +7,11 @@ import 'package:amplify_core/amplify_core.dart';
 import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart';
 import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart';
 import 'package:meta/meta.dart';
-import 'package:path/path.dart' as path;
 
 /// The io implementation of `downloadFile` API.
 @internal
 S3DownloadFileOperation downloadFile({
-  required String key,
+  required StoragePath path,
   required AWSFile localFile,
   required StorageDownloadFileOptions options,
   required S3PluginConfig s3pluginConfig,
@@ -27,7 +26,6 @@ S3DownloadFileOperation downloadFile({
   final s3PluginOptions = options.pluginOptions as S3DownloadFilePluginOptions;
   final targetIdentityId = s3PluginOptions.targetIdentityId;
   final downloadDataOptions = StorageDownloadDataOptions(
-    accessLevel: options.accessLevel,
     pluginOptions: targetIdentityId == null
         ? S3DownloadDataPluginOptions(
             getProperties: s3PluginOptions.getProperties,
@@ -41,17 +39,14 @@ S3DownloadFileOperation downloadFile({
   );
 
   final downloadDataTask = storageS3Service.downloadData(
-    key: key,
+    path: path,
     options: downloadDataOptions,
     // Ensure destination file is writable. Exception thrown in the check
     // will be forwarded to the Future, downloadDataTask.result below
     preStart: () async {
       destinationPath = await _ensureDestinationWritable(localFile);
       tempFile = File(
-        path.join(
-          await appPathProvider.getTemporaryPath(),
-          'amplify_storage_s3_temp_${uuid()}',
-        ),
+        uuid(),
       );
       sink = tempFile.openWrite(mode: FileMode.append);
     },
@@ -78,7 +73,7 @@ S3DownloadFileOperation downloadFile({
 
   return S3DownloadFileOperation(
     request: StorageDownloadFileRequest(
-      key: key,
+      path: path,
       localFile: localFile,
       options: options,
     ),

packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart

@@ -7,7 +7,7 @@ import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_servic
 
 /// Interface of the platform implementation of the `downloadFile` API.
 S3DownloadFileOperation downloadFile({
-  required String key,
+  required StoragePath path,
   required AWSFile localFile,
   required StorageDownloadFileOptions options,
   required S3PluginConfig s3pluginConfig,