expo-file-system 19.0.0-canary-20250404-3c3b5fd → 19.0.0-canary-20250811-5c940c0

package/CHANGELOG.md

@@ -4,6 +4,81 @@
 
 ### 🛠 Breaking changes
 
+- Make the modern filesystem API the default, move previous one to `expo-file-system/legacy`. ([#38404](https://github.com/expo/expo/pull/38404) by [@aleqsio](https://github.com/aleqsio))
+
+### 🎉 New features
+
+- Make file implement blob interface directly. ([#38160](https://github.com/expo/expo/pull/38160) by [@aleqsio](https://github.com/aleqsio))
+- Add directory info function ([#37910](https://github.com/expo/expo/pull/37910) by [@Wenszel](https://github.com/Wenszel))
+- Add total and available sizes, directory sizes. ([#37594](https://github.com/expo/expo/pull/37594) by [@aleqsio](https://github.com/aleqsio))
+- Add info method, modificationTime and creationTime properties to file-system/next. ([#37505](https://github.com/expo/expo/pull/37505) by [@Wenszel](https://github.com/Wenszel))
+- Add support for custom headers in downloadFileAsync ([#36108](https://github.com/expo/expo/pull/36108) by [@leonhh](https://github.com/leonhh))
+- [next] Add limited support for SAF Uris. ([#38075](https://github.com/expo/expo/pull/38075) by [@aleqsio](https://github.com/aleqsio))
+- [next] Add full support for SAF Uris. ([#38075](https://github.com/expo/expo/pull/38075) by [@aleqsio](https://github.com/aleqsio))
+
+### 🐛 Bug fixes
+
+- Update exists logic to align with documentation ([#37692](https://github.com/expo/expo/pull/37692) by [@Wenszel](https://github.com/Wenszel))
+- Fix memory usage issue in getInfoAsync ([#37417](https://github.com/expo/expo/pull/37417) by [@Wenszel](https://github.com/Wenszel))
+- Improved type safety in the FileSystem module to support tsconfig setups with stricter rules than the default. ([#37107](https://github.com/expo/expo/pull/37107) by [@hirbod](https://github.com/hirbod))
+- Added required modifiers in the FileSystem module to support tsconfig setups with stricter rules than the default. ([#37467](https://github.com/expo/expo/pull/37467)
+
+### 💡 Others
+
+## 18.1.11 - 2025-07-01
+
+### 💡 Others
+
+- Remove "Please" from warnings and errors ([#36862](https://github.com/expo/expo/pull/36862) by [@brentvatne](https://github.com/brentvatne))
+
+## 18.1.10 — 2025-05-08
+
+### 🐛 Bug fixes
+
+- Fix the `UploadTask.uploadAsync` method's return type did not indicate that the method could resolve to `null`. ([#36476](https://github.com/expo/expo/pull/36476) by [@DoctorJohn](https://github.com/DoctorJohn))
+
+## 18.1.9 — 2025-05-03
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.8 — 2025-04-30
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.7 — 2025-04-28
+
+### 💡 Others
+
+- Remove `web-streams-polyfill` in favor of `expo` support. ([#36407](https://github.com/expo/expo/pull/36407) by [@EvanBacon](https://github.com/EvanBacon))
+
+## 18.1.6 — 2025-04-25
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.5 — 2025-04-21
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.4 — 2025-04-14
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.3 — 2025-04-11
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.2 — 2025-04-11
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.1 — 2025-04-09
+
+_This version does not introduce any user-facing changes._
+
+## 18.1.0 — 2025-04-04
+
+### 🛠 Breaking changes
+
 - Bump minimum macOS version to 11.0. ([#34980](https://github.com/expo/expo/pull/34980) by [@gabrieldonadel](https://github.com/gabrieldonadel))
 
 ### 🎉 New features
@@ -12,6 +87,7 @@
 
 ### 🐛 Bug fixes
 
+- [next] Fix inconsistent behavior when using special chars in filenames. ([#35801](https://github.com/expo/expo/pull/35801) by [@aleqsio](https://github.com/aleqsio))
 - Fix expo-updates breaking filesystem on Android API 24 and 25. ([#33694](https://github.com/expo/expo/pull/33694) by [@aleqsio](https://github.com/aleqsio))
 
 ### 💡 Others

package/android/build.gradle

@@ -4,13 +4,13 @@ plugins {
 }
 
 group = 'host.exp.exponent'
-version = '18.0.4'
+version = '19.0.0-canary-20250811-5c940c0'
 
 android {
   namespace "expo.modules.filesystem"
   defaultConfig {
     versionCode 30
-    versionName "18.0.4"
+    versionName "19.0.0-canary-20250811-5c940c0"
   }
 }
 
@@ -21,4 +21,5 @@ dependencies {
   api 'com.squareup.okhttp3:okhttp-urlconnection:4.9.2'
   api 'com.squareup.okio:okio:2.9.0'
   api "androidx.legacy:legacy-support-v4:1.0.0"
+  api "androidx.documentfile:documentfile:1.1.0"
 }

package/android/src/main/java/expo/modules/filesystem/FileSystemDirectory.kt

@@ -0,0 +1,104 @@
+package expo.modules.filesystem
+
+import android.net.Uri
+import expo.modules.interfaces.filesystem.Permission
+
+class FileSystemDirectory(uri: Uri) : FileSystemPath(uri) {
+  fun validatePath() {
+// Kept empty for now, but can be used to validate if the path is a valid directory path.
+  }
+
+  override fun validateType() {
+    if (file.exists() && !file.isDirectory()) {
+      throw InvalidTypeFolderException()
+    }
+  }
+
+  val exists: Boolean get() {
+    return if (checkPermission(Permission.READ)) {
+      file.isDirectory()
+    } else {
+      false
+    }
+  }
+
+  val size: Long get() {
+    validatePermission(Permission.READ)
+    validateType()
+    return file.walkTopDown().filter { it.isFile() }.map { it.length() }.sum()
+  }
+
+  fun info(): DirectoryInfo {
+    validateType()
+    validatePermission(Permission.READ)
+    if (!file.exists()) {
+      val directoryInfo = DirectoryInfo(
+        exists = false,
+        uri = slashifyFilePath(file.uri.toString())
+      )
+      return directoryInfo
+    }
+
+    val directoryInfo = DirectoryInfo(
+      exists = true,
+      uri = slashifyFilePath(file.uri.toString()),
+      files = file.listFilesAsUnified().mapNotNull { i -> i.fileName },
+      modificationTime = modificationTime,
+      creationTime = creationTime,
+      size = size
+    )
+    return directoryInfo
+  }
+
+  fun create(options: CreateOptions = CreateOptions()) {
+    validateType()
+    validatePermission(Permission.WRITE)
+    validateCanCreate(options)
+    if (uri.isContentUri) {
+      throw UnableToCreateException("create function does not work with SAF Uris, use `createDirectory` and `createFile` instead")
+    }
+    if (options.overwrite && file.exists()) {
+      file.delete()
+    }
+    val created = if (options.intermediates) {
+      javaFile.mkdirs()
+    } else {
+      javaFile.mkdir()
+    }
+    if (!created) {
+      throw UnableToCreateException("directory already exists or could not be created")
+    }
+  }
+
+  fun createFile(mimeType: String?, fileName: String): FileSystemFile {
+    validateType()
+    validatePermission(Permission.WRITE)
+    val newFile = file.createFile(mimeType ?: "text/plain", fileName) ?: throw UnableToCreateException("file could not be created")
+    return FileSystemFile(newFile.uri)
+  }
+
+  fun createDirectory(fileName: String): FileSystemDirectory {
+    validateType()
+    validatePermission(Permission.WRITE)
+    val newDirectory = file.createDirectory(fileName) ?: throw UnableToCreateException("directory could not be created")
+    return FileSystemDirectory(newDirectory.uri)
+  }
+
+  // this function is internal and will be removed in the future (when returning arrays of shared objects is supported)
+  fun listAsRecords(): List<Map<String, Any>> {
+    validateType()
+    validatePermission(Permission.READ)
+    return file.listFilesAsUnified().map {
+      val uriString = it.uri.toString()
+      mapOf(
+        "isDirectory" to it.isDirectory(),
+        "uri" to if (uriString.endsWith("/")) uriString else "$uriString/"
+      )
+    }
+  }
+
+  fun asString(): String {
+    val uriString = file.uri.toString()
+    return if (uriString.endsWith("/")) uriString else "$uriString/"
+  }
+}

package/android/src/main/java/expo/modules/filesystem/FileSystemExceptions.kt

@@ -1,48 +1,55 @@
 package expo.modules.filesystem
-
-import android.net.Uri
+import expo.modules.interfaces.filesystem.Permission
 import expo.modules.kotlin.exception.CodedException
 
-internal class FileSystemOkHttpNullException :
-  CodedException("okHttpClient is null")
+internal class CopyOrMoveDirectoryToFileException :
+  CodedException("Unable to copy or move a folder to a file")
 
-internal class FileSystemCannotReadDirectoryException(uri: Uri?) :
-  CodedException("Uri '$uri' doesn't exist or isn't a directory")
+internal class InvalidTypeFolderException :
+  CodedException("A file with the same name already exists in the folder location")
 
-internal class FileSystemCannotCreateDirectoryException(uri: Uri?) :
-  CodedException(
-    uri?.let {
-      "Directory '$it' could not be created or already exists"
-    } ?: "Unknown error"
-  )
+internal class InvalidTypeFileException :
+  CodedException("A folder with the same name already exists in the file location")
 
-internal class FileSystemUnreadableDirectoryException(uri: String) :
-  CodedException("No readable files with the uri '$uri'. Please use other uri")
+internal class DestinationDoesNotExistException :
+  CodedException("The destination path does not exist")
 
-internal class FileSystemCannotCreateFileException(uri: Uri?) :
+internal class UnableToDownloadException(reason: String) :
   CodedException(
-    uri?.let {
-      "Provided uri '$it' is not pointing to a directory"
-    } ?: "Unknown error"
+    "Unable to download a file: $reason"
   )
 
-internal class FileSystemFileNotFoundException(uri: Uri?) :
-  CodedException("File '$uri' could not be deleted because it could not be found")
+internal class UnableToDeleteException(reason: String) :
+  CodedException(
+    "Unable to delete file or directory: $reason"
+  )
 
-internal class FileSystemPendingPermissionsRequestException :
-  CodedException("You have an unfinished permission request")
+internal class UnableToCreateException(reason: String) :
+  CodedException(
+    "Unable to create file or directory: $reason"
+  )
 
-internal class FileSystemCannotMoveFileException(fromUri: Uri, toUri: Uri) :
-  CodedException("File '$fromUri' could not be moved to '$toUri'")
+internal class InvalidPermissionException(permission: Permission) :
+  CodedException(
+    "Missing '${permission.name}' permission for accessing the file."
+  )
 
-internal class FileSystemUnsupportedSchemeException :
-  CodedException("Can't read Storage Access Framework directory, use StorageAccessFramework.readDirectoryAsync() instead")
+internal class UnableToReadHandleException(reason: String) :
+  CodedException(
+    "Unable to read from a file handle: '$reason'"
+  )
 
-internal class FileSystemCannotFindTaskException :
-  CodedException("Cannot find task")
+internal class UnableToWriteHandleException(reason: String) :
+  CodedException(
+    "Unable to write to a file handle: '$reason'"
+  )
 
-internal class FileSystemCopyFailedException(uri: Uri?) :
-  CodedException("File '$uri' could not be copied because it could not be found")
+internal class UnableToGetInfoException(reason: String) :
+  CodedException(
+    "Unable to get info from a file: '$reason'"
+  )
 
-internal class CookieHandlerNotFoundException :
-  CodedException("Failed to find CookieHandler")
+internal class DestinationAlreadyExistsException :
+  CodedException(
+    "Destination already exists"
+  )

package/android/src/main/java/expo/modules/filesystem/{next/FileSystemFile.kt → FileSystemFile.kt}

@@ -1,17 +1,15 @@
-package expo.modules.filesystem.next
+package expo.modules.filesystem
 
 import android.net.Uri
 import android.util.Base64
-import android.webkit.MimeTypeMap
 import expo.modules.interfaces.filesystem.Permission
 import expo.modules.kotlin.apifeatures.EitherType
 import expo.modules.kotlin.typedarray.TypedArray
-import java.io.File
 import java.io.FileOutputStream
 import java.security.MessageDigest
 
 @OptIn(EitherType::class)
-class FileSystemFile(file: File) : FileSystemPath(file) {
+class FileSystemFile(uri: Uri) : FileSystemPath(uri) {
   // Kept empty for now, but can be used to validate if the uri is a valid file uri. // TODO: Move to the constructor once also moved on iOS
   fun validatePath() {
   }
@@ -20,27 +18,33 @@ class FileSystemFile(file: File) : FileSystemPath(file) {
   // After calling this function, we can use the `isDirectory` and `isFile` functions safely as they will match the shared class used.
   override fun validateType() {
     validatePermission(Permission.READ)
-    if (file.exists() && file.isDirectory) {
+    if (file.exists() && file.isDirectory()) {
       throw InvalidTypeFileException()
     }
   }
 
   val exists: Boolean get() {
-    validatePermission(Permission.READ)
-    return file.isFile
+    return if (checkPermission(Permission.READ)) {
+      file.isFile()
+    } else {
+      false
+    }
   }
 
   fun create(options: CreateOptions = CreateOptions()) {
     validateType()
     validatePermission(Permission.WRITE)
     validateCanCreate(options)
-    if (options.overwrite && file.exists()) {
-      file.delete()
+    if (uri.isContentUri) {
+      throw UnableToCreateException("create function does not work with SAF Uris, use `createDirectory` and `createFile` instead")
+    }
+    if (options.overwrite && exists) {
+      javaFile.delete()
     }
     if (options.intermediates) {
-      file.parentFile?.mkdirs()
+      javaFile.parentFile?.mkdirs()
     }
-    val created = file.createNewFile()
+    val created = javaFile.createNewFile()
     if (!created) {
       throw UnableToCreateException("file already exists or could not be created")
     }
@@ -52,8 +56,8 @@ class FileSystemFile(file: File) : FileSystemPath(file) {
     if (!exists) {
       create()
     }
-    FileOutputStream(file).use {
-      it.write(content.toByteArray())
+    file.outputStream().use { outputStream ->
+      outputStream.write(content.toByteArray())
     }
   }
 
@@ -63,40 +67,56 @@ class FileSystemFile(file: File) : FileSystemPath(file) {
     if (!exists) {
       create()
     }
-    FileOutputStream(file).use {
-      it.channel.write(content.toDirectBuffer())
+    if (uri.isContentUri) {
+      file.outputStream().use { outputStream ->
+        val array = ByteArray(content.length)
+        content.toDirectBuffer().get(array)
+        outputStream.write(array)
+      }
+    } else {
+      FileOutputStream(javaFile).use {
+        it.channel.write(content.toDirectBuffer())
+      }
     }
   }
 
   fun asString(): String {
-    val uriString = Uri.fromFile(file).toString()
+    val uriString = file.uri.toString()
     return if (uriString.endsWith("/")) uriString.dropLast(1) else uriString
   }
 
   fun text(): String {
     validateType()
     validatePermission(Permission.READ)
-    return file.readText()
+    return file.inputStream().use { inputStream ->
+      inputStream.bufferedReader().use { it.readText() }
+    }
   }
 
   fun base64(): String {
     validateType()
     validatePermission(Permission.READ)
-    return Base64.encodeToString(file.readBytes(), Base64.NO_WRAP)
+    file.inputStream().use {
+      return Base64.encodeToString(it.readBytes(), Base64.NO_WRAP)
+    }
   }
 
   fun bytes(): ByteArray {
     validateType()
     validatePermission(Permission.READ)
-    return file.readBytes()
+    file.inputStream().use {
+      return it.readBytes()
+    }
   }
 
   @OptIn(ExperimentalStdlibApi::class)
   val md5: String get() {
     validatePermission(Permission.READ)
     val md = MessageDigest.getInstance("MD5")
-    val digest = md.digest(file.readBytes())
-    return digest.toHexString()
+    file.inputStream().use {
+      val digest = md.digest(it.readBytes())
+      return digest.toHexString()
+    }
   }
 
   val size: Long? get() {
@@ -108,7 +128,29 @@ class FileSystemFile(file: File) : FileSystemPath(file) {
   }
 
   val type: String? get() {
-    return MimeTypeMap.getFileExtensionFromUrl(file.path)
-      ?.run { MimeTypeMap.getSingleton().getMimeTypeFromExtension(lowercase()) }
+    return file.type
+  }
+
+  fun info(options: InfoOptions?): FileInfo {
+    validateType()
+    validatePermission(Permission.READ)
+    if (!file.exists()) {
+      val fileInfo = FileInfo(
+        exists = false,
+        uri = slashifyFilePath(file.uri.toString())
+      )
+      return fileInfo
+    }
+    val fileInfo = FileInfo(
+      exists = true,
+      uri = slashifyFilePath(file.uri.toString()),
+      size = size,
+      modificationTime = modificationTime,
+      creationTime = creationTime
+    )
+    if (options != null && options.md5 == true) {
+      fileInfo.md5 = md5
+    }
+    return fileInfo
   }
 }

package/android/src/main/java/expo/modules/filesystem/{next/FileSystemFileHandle.kt → FileSystemFileHandle.kt}

@@ -1,10 +1,10 @@
-package expo.modules.filesystem.next
+package expo.modules.filesystem
 
 import expo.modules.kotlin.sharedobjects.SharedRef
 import java.io.RandomAccessFile
 import java.nio.ByteBuffer
 import java.nio.channels.FileChannel
-class FileSystemFileHandle(file: FileSystemFile) : SharedRef<FileChannel>(RandomAccessFile(file.file, "rw").channel), AutoCloseable {
+class FileSystemFileHandle(file: FileSystemFile) : SharedRef<FileChannel>(RandomAccessFile(file.javaFile, "rw").channel), AutoCloseable {
   private val fileChannel: FileChannel = ref
 
   private fun ensureIsOpen() {