feat: Filesystem.copy should return new filepath

[dotNetkow]

Feature Request

Description

After copying a file to a new location using Filesystem.copy, the CopyResult object returned is an empty object. It's difficult to determine the full filepath to that new location, so I'd like to request that the path gets added to the CopyResult.

My use case is moving a photo taken with the official Camera plugin (stored in temp storage, "cache" folder) to permanent storage (data directory). Complete example in the Ionic First App tutorial, where I'm converting the photo to base64 then using FS.writeFile(). It'd require much less code to use copy() instead.

Here's an example use case:

const cameraPhoto = await Camera.getPhoto({
  resultType: CameraResultType.Uri
});

// path is: file:///data/user/0/io.ionic.pg.ng.cap/cache/JPEG_20201211_140602.jpg
// extract just the filename for the Filesystem API
const photoFilename = cameraPhoto.path.substr(cameraPhoto.path.lastIndexOf('/') + 1);
// photoFilename = JPEG_20201211_140602.jpg

const savedFile = await Filesystem.copy({
   from: photoFilename,  
   directory: FilesystemDirectory.Cache,
    to: "newPhoto.jpg",
    toDirectory: FilesystemDirectory.Data
});

// empty object!
console.log(savedFile);

The challenge is understanding what the underlying path of the new file actually is, which is required for many use cases such as displaying the newly captured photo in an app or saving that path for retrieval later (in a database, etc).

Platform(s)

web, ios, android

Preferred Solution

const savedFile = await Filesystem.copy({
   from: photoFilename,  
   directory: FilesystemDirectory.Cache,
    to: "newPhoto.jpg",
    toDirectory: FilesystemDirectory.Data
});

// no longer empty, path prop added that points to complete filepath
console.log(savedFile.path);
// path is: file:///data/user/0/io.ionic.pg.ng.cap/files/myPhoto.jpg

[jcesarmobile]

4.0.0 beta 0 now returns the new file path

[ionitron-bot]

Thanks for the issue! This issue is being locked to prevent comments that are not relevant to the original issue. If this is still an issue with the latest version of the plugin, please create a new issue and ensure the template is fully filled out.