expo-file-system 56.0.3 → 56.0.5

package/CHANGELOG.md

@@ -10,6 +10,19 @@
 
 ### 💡 Others
 
+## 56.0.5 — 2026-05-15
+
+### 💡 Others
+
+- Migrated to the single-payload `SharedObject.emit` API. ([#45596](https://github.com/expo/expo/pull/45596) by [@tsapeta](https://github.com/tsapeta))
+
+## 56.0.4 — 2026-05-08
+
+### 💡 Others
+
+- Improved public API docs. ([#45530](https://github.com/expo/expo/pull/45530) by [@barthap](https://github.com/barthap))
+- Re-organized package TypeScript code. ([#45531](https://github.com/expo/expo/pull/45531) by [@barthap](https://github.com/barthap))
+
 ## 56.0.3 — 2026-05-06
 
 _This version does not introduce any user-facing changes._

package/android/build.gradle

@@ -4,13 +4,13 @@ plugins {
 }
 
 group = 'host.exp.exponent'
-version = '56.0.3'
+version = '56.0.5'
 
 android {
   namespace "expo.modules.filesystem"
   defaultConfig {
     versionCode 30
-    versionName "56.0.3"
+    versionName "56.0.5"
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
   }
   testOptions {

package/build/Directory.d.ts

@@ -0,0 +1,67 @@
+import ExpoFileSystem from './ExpoFileSystem';
+import { File } from './File';
+import type { WatchEvent, WatchOptions, WatchSubscription } from './FileSystemWatcher.types';
+/**
+ * Represents a directory on the filesystem.
+ *
+ * A `Directory` instance can be created for any path, and does not need to exist on the filesystem during creation.
+ *
+ * The constructor accepts an array of strings that are joined to create the directory URI. The first argument can also be a `Directory` instance (like `Paths.cache`).
+ * @example
+ * ```ts
+ * const directory = new Directory(Paths.cache, "subdirName");
+ * ```
+ */
+export declare class Directory extends ExpoFileSystem.FileSystemDirectory {
+    static pickDirectoryAsync: (initialUri?: string) => Promise<Directory>;
+    /**
+     * Creates an instance of a directory. It can be created for any path, and does not need to exist on the filesystem during creation.
+     *
+     * The constructor accepts an array of strings that are joined to create the directory URI. The first argument can also be a `Directory` instance (like `Paths.cache`).
+     * @param uris An array of: `file:///` string URIs, `File` instances, and `Directory` instances representing an arbitrary location on the file system.
+     * @example
+     * ```ts
+     * const directory = new Directory(Paths.cache, "subdirName");
+     * ```
+     */
+    constructor(...uris: (string | File | Directory)[]);
+    get parentDirectory(): Directory;
+    /**
+     * Lists the contents of a directory.
+     * Calling this method if the parent directory does not exist will throw an error.
+     * @returns An array of `Directory` and `File` instances.
+     */
+    list(): (Directory | File)[];
+    /**
+     * Directory name.
+     */
+    get name(): string;
+    createFile(name: string, mimeType: string | null): File;
+    createDirectory(name: string): Directory;
+    /**
+     * Watches this directory for changes to its contents or the directory itself.
+     *
+     * Events are emitted when files or subdirectories are created, modified, deleted, or renamed
+     * within this directory. On iOS, child changes are surfaced as a coarse-grained `modified` event
+     * on the directory itself, so filtering for child-level `created`, `deleted`, or `renamed` events
+     * is not reliable. The watcher automatically stops when the directory is deleted or renamed.
+     * To stop watching manually, call `remove()` on the returned subscription.
+     *
+     * @param callback Invoked when a change is detected. Receives a `WatchEvent` describing what changed.
+     * @param options Configuration for debouncing and filtering events.
+     * @return A subscription handle. Call `remove()` to stop watching.
+     *
+     * @example
+     * ```ts
+     * const cacheDir = new Directory(Paths.cache);
+     * const subscription = cacheDir.watch((event) => {
+     *   console.log(`${event.type}: ${event.target.uri}`);
+     * });
+     *
+     * // Later, stop watching:
+     * subscription.remove();
+     * ```
+     */
+    watch(callback: (event: WatchEvent<File | Directory>) => void, options?: WatchOptions): WatchSubscription;
+}
+//# sourceMappingURL=Directory.d.ts.map

package/build/Directory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Directory.d.ts","sourceRoot":"","sources":["../src/Directory.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAI7F;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,cAAc,CAAC,mBAAmB;IAC/D,MAAM,CAAC,kBAAkB,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IAEvE;;;;;;;;;OASG;gBACS,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE;IAQlD,IAAI,eAAe,cAElB;IAED;;;;OAIG;IACM,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE;IAOrC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAKvD,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAIxC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CACH,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,IAAI,EACvD,OAAO,CAAC,EAAE,YAAY,GACrB,iBAAiB;CAQrB"}

package/build/Directory.types.d.ts

@@ -0,0 +1,49 @@
+export type DirectoryCreateOptions = {
+    /**
+     * Whether to create intermediate directories if they do not exist.
+     * @default false
+     */
+    intermediates?: boolean;
+    /**
+     * Whether to overwrite the directory if it exists.
+     * @default false
+     */
+    overwrite?: boolean;
+    /**
+     * This flag controls whether the `create` operation is idempotent
+     * (safe to call multiple times without error).
+     *
+     * If `true`, creating a file or directory that already exists will succeed silently.
+     * If `false`, an error will be thrown when the target already exists.
+     *
+     * @default false
+     */
+    idempotent?: boolean;
+};
+export type DirectoryInfo = {
+    /**
+     * Indicates whether the directory exists.
+     */
+    exists: boolean;
+    /**
+     * A `file://` URI pointing to the directory.
+     */
+    uri?: string;
+    /**
+     * The size of the file in bytes.
+     */
+    size?: number;
+    /**
+     * The last modification time of the directory expressed in milliseconds since epoch.
+     */
+    modificationTime?: number;
+    /**
+     * A creation time of the directory expressed in milliseconds since epoch. Returns null if the Android version is earlier than API 26.
+     */
+    creationTime?: number;
+    /**
+     * A list of file names contained within a directory.
+     */
+    files?: string[];
+};
+//# sourceMappingURL=Directory.types.d.ts.map

package/build/Directory.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Directory.types.d.ts","sourceRoot":"","sources":["../src/Directory.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}

package/build/ExpoFileSystem.d.ts

@@ -1,46 +1,19 @@
-import { NativeModule, type SharedObject } from 'expo-modules-core';
-import type { Directory, File, DownloadOptions, DownloadProgress, PathInfo, WatchEventType, WatchOptions, PickSingleFileOptions, PickMultipleFilesOptions, UploadProgress, UploadResult } from './ExpoFileSystem.types';
+import { NativeModule } from 'expo-modules-core';
+import type { Directory } from './Directory';
+import type { File } from './File';
+import type { PickMultipleFilesOptions, PickSingleFileOptions } from './File.types';
+import type { DownloadOptions, DownloadProgress } from './NetworkTasks.types';
+import type { PathInfo } from './Paths.types';
+import type { FileSystemDownloadTask, FileSystemUploadTask, NativeFileSystemDirectory, NativeFileSystemFile, NativeFileSystemWatcher } from './internal/NativeFileSystem.types';
 type FileSystemEvents = {
     downloadProgress: (data: {
         uuid: string;
         data: DownloadProgress;
     }) => void;
 };
-type UploadTaskEvents = {
-    progress: (data: UploadProgress) => void;
-};
-type DownloadTaskEvents = {
-    progress: (data: DownloadProgress) => void;
-};
-declare class FileSystemUploadTask extends SharedObject<UploadTaskEvents> {
-    start(url: string, file: File, options: Record<string, any>): Promise<UploadResult>;
-    cancel(): void;
-}
-declare class FileSystemDownloadTask extends SharedObject<DownloadTaskEvents> {
-    start(url: string, to: File | Directory, options?: Record<string, any>): Promise<string | null>;
-    pause(): any;
-    resume(url: string, to: File | Directory, resumeData: string, options?: Record<string, any>): Promise<string | null>;
-    cancel(): void;
-}
-type FileSystemWatcherEvent = {
-    type: WatchEventType;
-    path: string;
-    isDirectory: boolean;
-    nativeEventFlags?: number;
-    newPath?: string;
-    newPathIsDirectory?: boolean;
-};
-type FileSystemWatcherEvents = {
-    change: (event: FileSystemWatcherEvent) => void;
-};
-declare class NativeFileSystemWatcher extends SharedObject<FileSystemWatcherEvents> {
-    constructor(path: string, options?: WatchOptions);
-    start(): void;
-    stop(): void;
-}
 declare class ExpoFileSystemModule extends NativeModule<FileSystemEvents> {
-    FileSystemDirectory: typeof Directory;
-    FileSystemFile: typeof File;
+    FileSystemDirectory: typeof NativeFileSystemDirectory;
+    FileSystemFile: typeof NativeFileSystemFile;
     FileSystemUploadTask: typeof FileSystemUploadTask;
     FileSystemDownloadTask: typeof FileSystemDownloadTask;
     FileSystemWatcher: typeof NativeFileSystemWatcher;

package/build/ExpoFileSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoFileSystem.d.ts","sourceRoot":"","sources":["../src/ExpoFileSystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEzF,OAAO,KAAK,EACV,SAAS,EACT,IAAI,EACJ,eAAe,EACf,gBAAgB,EAChB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,qBAAqB,EACrB,wBAAwB,EACxB,cAAc,EACd,YAAY,EACb,MAAM,wBAAwB,CAAC;AAEhC,KAAK,gBAAgB,GAAG;IACtB,gBAAgB,EAAE,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,gBAAgB,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5E,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC;CAC1C,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC5C,CAAC;AAEF,OAAO,OAAO,oBAAqB,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IACvE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IACnF,MAAM,IAAI,IAAI;CACf;AAED,OAAO,OAAO,sBAAuB,SAAQ,YAAY,CAAC,kBAAkB,CAAC;IAC3E,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAC/F,KAAK,IAAI,GAAG;IACZ,MAAM,CACJ,GAAG,EAAE,MAAM,EACX,EAAE,EAAE,IAAI,GAAG,SAAS,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,IAAI,IAAI;CACf;AAED,KAAK,sBAAsB,GAAG;IAC5B,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,KAAK,uBAAuB,GAAG;IAC7B,MAAM,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;CACjD,CAAC;AAEF,OAAO,OAAO,uBAAwB,SAAQ,YAAY,CAAC,uBAAuB,CAAC;gBACrE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAChD,KAAK,IAAI,IAAI;IACb,IAAI,IAAI,IAAI;CACb;AAED,OAAO,OAAO,oBAAqB,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IACvE,mBAAmB,EAAE,OAAO,SAAS,CAAC;IACtC,cAAc,EAAE,OAAO,IAAI,CAAC;IAC5B,oBAAoB,EAAE,OAAO,oBAAoB,CAAC;IAClD,sBAAsB,EAAE,OAAO,sBAAsB,CAAC;IACtD,iBAAiB,EAAE,OAAO,uBAAuB,CAAC;IAClD,iBAAiB,CACf,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,IAAI,GAAG,SAAS,EAC7B,OAAO,CAAC,EAAE,eAAe,EACzB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IAClB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IACvC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAC3D,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5D,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACjE,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChD;;AAED,wBAAuE"}
+{"version":3,"file":"ExpoFileSystem.d.ts","sourceRoot":"","sources":["../src/ExpoFileSystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,mBAAmB,CAAC;AAEtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,mCAAmC,CAAC;AAE3C,KAAK,gBAAgB,GAAG;IACtB,gBAAgB,EAAE,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,gBAAgB,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5E,CAAC;AAEF,OAAO,OAAO,oBAAqB,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IACvE,mBAAmB,EAAE,OAAO,yBAAyB,CAAC;IACtD,cAAc,EAAE,OAAO,oBAAoB,CAAC;IAC5C,oBAAoB,EAAE,OAAO,oBAAoB,CAAC;IAClD,sBAAsB,EAAE,OAAO,sBAAsB,CAAC;IACtD,iBAAiB,EAAE,OAAO,uBAAuB,CAAC;IAClD,iBAAiB,CACf,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,IAAI,GAAG,SAAS,EAC7B,OAAO,CAAC,EAAE,eAAe,EACzB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IAClB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IACvC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAC3D,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5D,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACjE,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChD;;AAED,wBAAuE"}