@capacitor/filesystem 7.0.2-nightly-20250526T150552.0 → 7.1.0-dev.1

package/dist/esm/definitions.d.ts

@@ -1,4 +1,5 @@
 import type { HttpOptions, PermissionState, PluginListenerHandle } from '@capacitor/core';
+export type CallbackID = string;
 export interface PermissionStatus {
     publicStorage: PermissionState;
 }
@@ -8,7 +9,7 @@ export declare enum Directory {
      * On iOS it's the app's documents directory.
      * Use this directory to store user-generated content.
      * On Android it's the Public Documents folder, so it's accessible from other apps.
-     * It's not accesible on Android 10 unless the app enables legacy External Storage
+     * It's not accessible on Android 10 unless the app enables legacy External Storage
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
      * in the `AndroidManifest.xml`.
      * On Android 11 or newer the app can only access the files/folders the app created.
@@ -58,14 +59,36 @@ export declare enum Directory {
      * The external storage directory.
      * On iOS it will use the Documents directory.
      * On Android it's the primary shared/external storage directory.
-     * It's not accesible on Android 10 unless the app enables legacy External Storage
+     * It's not accessible on Android 10 unless the app enables legacy External Storage
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
      * in the `AndroidManifest.xml`.
-     * It's not accesible on Android 11 or newer.
+     * It's not accessible on Android 11 or newer.
      *
      * @since 1.0.0
      */
-    ExternalStorage = "EXTERNAL_STORAGE"
+    ExternalStorage = "EXTERNAL_STORAGE",
+    /**
+     * The external cache directory.
+     * On iOS it will use the Documents directory.
+     * On Android it's the primary shared/external cache.
+     *
+     * @since 7.1.0
+     */
+    ExternalCache = "EXTERNAL_CACHE",
+    /**
+     * The Library directory without cloud backup. Used in iOS.
+     * On Android it's the directory holding application files.
+     *
+     * @since 7.1.0
+     */
+    LibraryNoCloud = "LIBRARY_NO_CLOUD",
+    /**
+     * A temporary directory for iOS.
+     * On Android it's the directory holding the application cache.
+     *
+     * @since 7.1.0
+     */
+    Temporary = "TEMPORARY"
 }
 export declare enum Encoding {
     /**
@@ -181,6 +204,14 @@ export interface ReadFileOptions {
      */
     encoding?: Encoding;
 }
+export interface ReadFileInChunksOptions extends ReadFileOptions {
+    /**
+     * Size of the chunks in bytes.
+     *
+     * @since 7.1.0
+     */
+    chunkSize: number;
+}
 export interface DeleteFileOptions {
     /**
      * The path of the file to delete
@@ -306,7 +337,7 @@ export interface CopyOptions {
      */
     toDirectory?: Directory;
 }
-export declare type RenameOptions = CopyOptions;
+export type RenameOptions = CopyOptions;
 export interface ReadFileResult {
     /**
      * The representation of the data contained in the file
@@ -336,6 +367,8 @@ export interface ReaddirResult {
 export interface FileInfo {
     /**
      * Name of the file or directory.
+     *
+     * @since 7.1.0
      */
     name: string;
     /**
@@ -355,13 +388,13 @@ export interface FileInfo {
      *
      * It's not available on Android 7 and older devices.
      *
-     * @since 4.0.0
+     * @since 7.1.0
      */
     ctime?: number;
     /**
      * Time of last modification in milliseconds.
      *
-     * @since 4.0.0
+     * @since 7.1.0
      */
     mtime: number;
     /**
@@ -379,40 +412,7 @@ export interface GetUriResult {
      */
     uri: string;
 }
-export interface StatResult {
-    /**
-     * Type of the file.
-     *
-     * @since 1.0.0
-     */
-    type: 'directory' | 'file';
-    /**
-     * Size of the file in bytes.
-     *
-     * @since 1.0.0
-     */
-    size: number;
-    /**
-     * Time of creation in milliseconds.
-     *
-     * It's not available on Android 7 and older devices.
-     *
-     * @since 1.0.0
-     */
-    ctime?: number;
-    /**
-     * Time of last modification in milliseconds.
-     *
-     * @since 1.0.0
-     */
-    mtime: number;
-    /**
-     * The uri of the file
-     *
-     * @since 1.0.0
-     */
-    uri: string;
-}
+export type StatResult = FileInfo;
 export interface CopyResult {
     /**
      * The uri where the file was copied into
@@ -487,19 +487,50 @@ export interface ProgressStatus {
      */
     contentLength: number;
 }
+/**
+ * Callback for receiving chunks read from a file, or error if something went wrong.
+ *
+ * @since 7.1.0
+ */
+export type ReadFileInChunksCallback = (chunkRead: ReadFileResult | null, err?: any) => void;
 /**
  * A listener function that receives progress events.
  *
  * @since 5.1.0
  */
-export declare type ProgressListener = (progress: ProgressStatus) => void;
+export type ProgressListener = (progress: ProgressStatus) => void;
 export interface FilesystemPlugin {
+    /**
+     * Check read/write permissions.
+     * Required on Android, only when using `Directory.Documents` or
+     * `Directory.ExternalStorage`.
+     *
+     * @since 1.0.0
+     */
+    checkPermissions(): Promise<PermissionStatus>;
+    /**
+     * Request read/write permissions.
+     * Required on Android, only when using `Directory.Documents` or
+     * `Directory.ExternalStorage`.
+     *
+     * @since 1.0.0
+     */
+    requestPermissions(): Promise<PermissionStatus>;
     /**
      * Read a file from disk
      *
      * @since 1.0.0
      */
     readFile(options: ReadFileOptions): Promise<ReadFileResult>;
+    /**
+     * Read a file from disk, in chunks.
+     * Native only (not available in web).
+     * Use the callback to receive each read chunk.
+     * If empty chunk is returned, it means file has been completely read.
+     *
+     * @since 7.1.0
+     */
+    readFileInChunks(options: ReadFileInChunksOptions, callback: ReadFileInChunksCallback): Promise<CallbackID>;
     /**
      * Write a file to disk in the specified location on device
      *
@@ -560,71 +591,78 @@ export interface FilesystemPlugin {
      * @since 1.0.0
      */
     copy(options: CopyOptions): Promise<CopyResult>;
-    /**
-     * Check read/write permissions.
-     * Required on Android, only when using `Directory.Documents` or
-     * `Directory.ExternalStorage`.
-     *
-     * @since 1.0.0
-     */
-    checkPermissions(): Promise<PermissionStatus>;
-    /**
-     * Request read/write permissions.
-     * Required on Android, only when using `Directory.Documents` or
-     * `Directory.ExternalStorage`.
-     *
-     * @since 1.0.0
-     */
-    requestPermissions(): Promise<PermissionStatus>;
     /**
      * Perform a http request to a server and download the file to the specified destination.
      *
+     * This method has been deprecated since version 7.1.0.
+     * We recommend using the @capacitor/file-transfer plugin instead, in conjunction with this plugin.
+     *
      * @since 5.1.0
+     * @deprecated Use the @capacitor/file-transfer plugin instead.
      */
     downloadFile(options: DownloadFileOptions): Promise<DownloadFileResult>;
     /**
      * Add a listener to file download progress events.
      *
+     * This method has been deprecated since version 7.1.0.
+     * We recommend using the @capacitor/file-transfer plugin instead, in conjunction with this plugin.
+     *
      * @since 5.1.0
+     * @deprecated Use the @capacitor/file-transfer plugin instead.
      */
     addListener(eventName: 'progress', listenerFunc: ProgressListener): Promise<PluginListenerHandle>;
     /**
      * Remove all listeners for this plugin.
      *
+     * This method has been deprecated since version 7.1.0.
+     * We recommend using the @capacitor/file-transfer plugin instead, in conjunction with this plugin.
+     *
      * @since 5.2.0
+     * @deprecated Use the @capacitor/file-transfer plugin instead.
      */
     removeAllListeners(): Promise<void>;
 }
+/**
+ * Structure for errors returned by the plugin.
+ *
+ * `code` follows "OS-PLUG-FILE-XXXX" format
+ *
+ * @since 1.0.0
+ */
+export type PluginError = {
+    code: string;
+    message: string;
+};
 /**
  * @deprecated Use `ReadFileOptions`.
  * @since 1.0.0
  */
-export declare type FileReadOptions = ReadFileOptions;
+export type FileReadOptions = ReadFileOptions;
 /**
  * @deprecated Use `ReadFileResult`.
  * @since 1.0.0
  */
-export declare type FileReadResult = ReadFileResult;
+export type FileReadResult = ReadFileResult;
 /**
  * @deprecated Use `WriteFileOptions`.
  * @since 1.0.0
  */
-export declare type FileWriteOptions = WriteFileOptions;
+export type FileWriteOptions = WriteFileOptions;
 /**
  * @deprecated Use `WriteFileResult`.
  * @since 1.0.0
  */
-export declare type FileWriteResult = WriteFileResult;
+export type FileWriteResult = WriteFileResult;
 /**
  * @deprecated Use `AppendFileOptions`.
  * @since 1.0.0
  */
-export declare type FileAppendOptions = AppendFileOptions;
+export type FileAppendOptions = AppendFileOptions;
 /**
  * @deprecated Use `DeleteFileOptions`.
  * @since 1.0.0
  */
-export declare type FileDeleteOptions = DeleteFileOptions;
+export type FileDeleteOptions = DeleteFileOptions;
 /**
  * @deprecated Use `Directory`.
  * @since 1.0.0

package/dist/esm/definitions.js

@@ -5,7 +5,7 @@ export var Directory;
      * On iOS it's the app's documents directory.
      * Use this directory to store user-generated content.
      * On Android it's the Public Documents folder, so it's accessible from other apps.
-     * It's not accesible on Android 10 unless the app enables legacy External Storage
+     * It's not accessible on Android 10 unless the app enables legacy External Storage
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
      * in the `AndroidManifest.xml`.
      * On Android 11 or newer the app can only access the files/folders the app created.
@@ -55,14 +55,36 @@ export var Directory;
      * The external storage directory.
      * On iOS it will use the Documents directory.
      * On Android it's the primary shared/external storage directory.
-     * It's not accesible on Android 10 unless the app enables legacy External Storage
+     * It's not accessible on Android 10 unless the app enables legacy External Storage
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
      * in the `AndroidManifest.xml`.
-     * It's not accesible on Android 11 or newer.
+     * It's not accessible on Android 11 or newer.
      *
      * @since 1.0.0
      */
     Directory["ExternalStorage"] = "EXTERNAL_STORAGE";
+    /**
+     * The external cache directory.
+     * On iOS it will use the Documents directory.
+     * On Android it's the primary shared/external cache.
+     *
+     * @since 7.1.0
+     */
+    Directory["ExternalCache"] = "EXTERNAL_CACHE";
+    /**
+     * The Library directory without cloud backup. Used in iOS.
+     * On Android it's the directory holding application files.
+     *
+     * @since 7.1.0
+     */
+    Directory["LibraryNoCloud"] = "LIBRARY_NO_CLOUD";
+    /**
+     * A temporary directory for iOS.
+     * On Android it's the directory holding the application cache.
+     *
+     * @since 7.1.0
+     */
+    Directory["Temporary"] = "TEMPORARY";
 })(Directory || (Directory = {}));
 export var Encoding;
 (function (Encoding) {

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAUA,MAAM,CAAN,IAAY,SAqEX;AArED,WAAY,SAAS;IACnB;;;;;;;;;;;OAWG;IACH,oCAAuB,CAAA;IAEvB;;;;;;;OAOG;IACH,0BAAa,CAAA;IAEb;;;;;;;OAOG;IACH,gCAAmB,CAAA;IAEnB;;;;;;OAMG;IACH,4BAAe,CAAA;IAEf;;;;;;;;;;OAUG;IACH,kCAAqB,CAAA;IAErB;;;;;;;;;;OAUG;IACH,iDAAoC,CAAA;AACtC,CAAC,EArEW,SAAS,KAAT,SAAS,QAqEpB;AAED,MAAM,CAAN,IAAY,QAyBX;AAzBD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,yBAAa,CAAA;IAEb;;;;;;OAMG;IACH,2BAAe,CAAA;IAEf;;;;;;OAMG;IACH,2BAAe,CAAA;AACjB,CAAC,EAzBW,QAAQ,KAAR,QAAQ,QAyBnB;AAimBD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC","sourcesContent":["import type {\n  HttpOptions,\n  PermissionState,\n  PluginListenerHandle,\n} from '@capacitor/core';\n\nexport interface PermissionStatus {\n  publicStorage: PermissionState;\n}\n\nexport enum Directory {\n  /**\n   * The Documents directory.\n   * On iOS it's the app's documents directory.\n   * Use this directory to store user-generated content.\n   * On Android it's the Public Documents folder, so it's accessible from other apps.\n   * It's not accesible on Android 10 unless the app enables legacy External Storage\n   * by adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\n   * in the `AndroidManifest.xml`.\n   * On Android 11 or newer the app can only access the files/folders the app created.\n   *\n   * @since 1.0.0\n   */\n  Documents = 'DOCUMENTS',\n\n  /**\n   * The Data directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the directory holding application files.\n   * Files will be deleted when the application is uninstalled.\n   *\n   * @since 1.0.0\n   */\n  Data = 'DATA',\n\n  /**\n   * The Library directory.\n   * On iOS it will use the Library directory.\n   * On Android it's the directory holding application files.\n   * Files will be deleted when the application is uninstalled.\n   *\n   * @since 1.1.0\n   */\n  Library = 'LIBRARY',\n\n  /**\n   * The Cache directory.\n   * Can be deleted in cases of low memory, so use this directory to write app-specific files.\n   * that your app can re-create easily.\n   *\n   * @since 1.0.0\n   */\n  Cache = 'CACHE',\n\n  /**\n   * The external directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the directory on the primary shared/external\n   * storage device where the application can place persistent files it owns.\n   * These files are internal to the applications, and not typically visible\n   * to the user as media.\n   * Files will be deleted when the application is uninstalled.\n   *\n   * @since 1.0.0\n   */\n  External = 'EXTERNAL',\n\n  /**\n   * The external storage directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the primary shared/external storage directory.\n   * It's not accesible on Android 10 unless the app enables legacy External Storage\n   * by adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\n   * in the `AndroidManifest.xml`.\n   * It's not accesible on Android 11 or newer.\n   *\n   * @since 1.0.0\n   */\n  ExternalStorage = 'EXTERNAL_STORAGE',\n}\n\nexport enum Encoding {\n  /**\n   * Eight-bit UCS Transformation Format\n   *\n   * @since 1.0.0\n   */\n  UTF8 = 'utf8',\n\n  /**\n   * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the\n   * Unicode character set\n   * This encoding is only supported on Android.\n   *\n   * @since 1.0.0\n   */\n  ASCII = 'ascii',\n\n  /**\n   * Sixteen-bit UCS Transformation Format, byte order identified by an\n   * optional byte-order mark\n   * This encoding is only supported on Android.\n   *\n   * @since 1.0.0\n   */\n  UTF16 = 'utf16',\n}\n\nexport interface WriteFileOptions {\n  /**\n   * The path of the file to write\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The data to write\n   *\n   * Note: Blob data is only supported on Web.\n   *\n   * @since 1.0.0\n   */\n  data: string | Blob;\n\n  /**\n   * The `Directory` to store the file in\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The encoding to write the file in. If not provided, data\n   * is written as base64 encoded.\n   *\n   * Pass Encoding.UTF8 to write data as string\n   *\n   * @since 1.0.0\n   */\n  encoding?: Encoding;\n\n  /**\n   * Whether to create any missing parent directories.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  recursive?: boolean;\n}\n\nexport interface AppendFileOptions {\n  /**\n   * The path of the file to append\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The data to write\n   *\n   * @since 1.0.0\n   */\n  data: string;\n\n  /**\n   * The `Directory` to store the file in\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The encoding to write the file in. If not provided, data\n   * is written as base64 encoded.\n   *\n   * Pass Encoding.UTF8 to write data as string\n   *\n   * @since 1.0.0\n   */\n  encoding?: Encoding;\n}\n\nexport interface ReadFileOptions {\n  /**\n   * The path of the file to read\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to read the file from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The encoding to read the file in, if not provided, data\n   * is read as binary and returned as base64 encoded.\n   *\n   * Pass Encoding.UTF8 to read data as string\n   *\n   * @since 1.0.0\n   */\n  encoding?: Encoding;\n}\n\nexport interface DeleteFileOptions {\n  /**\n   * The path of the file to delete\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to delete the file from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n}\n\nexport interface MkdirOptions {\n  /**\n   * The path of the new directory\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to make the new directory in\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * Whether to create any missing parent directories as well.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  recursive?: boolean;\n}\n\nexport interface RmdirOptions {\n  /**\n   * The path of the directory to remove\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to remove the directory from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * Whether to recursively remove the contents of the directory\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  recursive?: boolean;\n}\n\nexport interface ReaddirOptions {\n  /**\n   * The path of the directory to read\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to list files from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n}\n\nexport interface GetUriOptions {\n  /**\n   * The path of the file to get the URI for\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to get the file under\n   *\n   * @since 1.0.0\n   */\n  directory: Directory;\n}\n\nexport interface StatOptions {\n  /**\n   * The path of the file to get data about\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to get the file under\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n}\n\nexport interface CopyOptions {\n  /**\n   * The existing file or directory\n   *\n   * @since 1.0.0\n   */\n  from: string;\n\n  /**\n   * The destination file or directory\n   *\n   * @since 1.0.0\n   */\n  to: string;\n\n  /**\n   * The `Directory` containing the existing file or directory\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The `Directory` containing the destination file or directory. If not supplied will use the 'directory'\n   * parameter as the destination\n   *\n   * @since 1.0.0\n   */\n  toDirectory?: Directory;\n}\n\nexport type RenameOptions = CopyOptions;\n\nexport interface ReadFileResult {\n  /**\n   * The representation of the data contained in the file\n   *\n   * Note: Blob is only available on Web. On native, the data is returned as a string.\n   *\n   * @since 1.0.0\n   */\n  data: string | Blob;\n}\n\nexport interface WriteFileResult {\n  /**\n   * The uri where the file was written into\n   *\n   * @since 1.0.0\n   */\n  uri: string;\n}\n\nexport interface ReaddirResult {\n  /**\n   * List of files and directories inside the directory\n   *\n   * @since 1.0.0\n   */\n  files: FileInfo[];\n}\n\nexport interface FileInfo {\n  /**\n   * Name of the file or directory.\n   */\n  name: string;\n  /**\n   * Type of the file.\n   *\n   * @since 4.0.0\n   */\n  type: 'directory' | 'file';\n\n  /**\n   * Size of the file in bytes.\n   *\n   * @since 4.0.0\n   */\n  size: number;\n\n  /**\n   * Time of creation in milliseconds.\n   *\n   * It's not available on Android 7 and older devices.\n   *\n   * @since 4.0.0\n   */\n  ctime?: number;\n\n  /**\n   * Time of last modification in milliseconds.\n   *\n   * @since 4.0.0\n   */\n  mtime: number;\n\n  /**\n   * The uri of the file.\n   *\n   * @since 4.0.0\n   */\n  uri: string;\n}\n\nexport interface GetUriResult {\n  /**\n   * The uri of the file\n   *\n   * @since 1.0.0\n   */\n  uri: string;\n}\n\nexport interface StatResult {\n  /**\n   * Type of the file.\n   *\n   * @since 1.0.0\n   */\n  type: 'directory' | 'file';\n\n  /**\n   * Size of the file in bytes.\n   *\n   * @since 1.0.0\n   */\n  size: number;\n\n  /**\n   * Time of creation in milliseconds.\n   *\n   * It's not available on Android 7 and older devices.\n   *\n   * @since 1.0.0\n   */\n  ctime?: number;\n\n  /**\n   * Time of last modification in milliseconds.\n   *\n   * @since 1.0.0\n   */\n  mtime: number;\n\n  /**\n   * The uri of the file\n   *\n   * @since 1.0.0\n   */\n  uri: string;\n}\n\nexport interface CopyResult {\n  /**\n   * The uri where the file was copied into\n   *\n   * @since 4.0.0\n   */\n  uri: string;\n}\n\nexport interface DownloadFileOptions extends HttpOptions {\n  /**\n   * The path the downloaded file should be moved to.\n   *\n   * @since 5.1.0\n   */\n  path: string;\n  /**\n   * The directory to write the file to.\n   * If this option is used, filePath can be a relative path rather than absolute.\n   * The default is the `DATA` directory.\n   *\n   * @since 5.1.0\n   */\n  directory?: Directory;\n  /**\n   * An optional listener function to receive downloaded progress events.\n   * If this option is used, progress event should be dispatched on every chunk received.\n   * Chunks are throttled to every 100ms on Android/iOS to avoid slowdowns.\n   *\n   * @since 5.1.0\n   */\n  progress?: boolean;\n  /**\n   * Whether to create any missing parent directories.\n   *\n   * @default false\n   * @since 5.1.2\n   */\n  recursive?: boolean;\n}\n\nexport interface DownloadFileResult {\n  /**\n   * The path the file was downloaded to.\n   *\n   * @since 5.1.0\n   */\n  path?: string;\n  /**\n   * The blob data of the downloaded file.\n   * This is only available on web.\n   *\n   * @since 5.1.0\n   */\n  blob?: Blob;\n}\nexport interface ProgressStatus {\n  /**\n   * The url of the file being downloaded.\n   *\n   * @since 5.1.0\n   */\n  url: string;\n  /**\n   * The number of bytes downloaded so far.\n   *\n   * @since 5.1.0\n   */\n  bytes: number;\n  /**\n   * The total number of bytes to download for this file.\n   *\n   * @since 5.1.0\n   */\n  contentLength: number;\n}\n\n/**\n * A listener function that receives progress events.\n *\n * @since 5.1.0\n */\nexport type ProgressListener = (progress: ProgressStatus) => void;\n\nexport interface FilesystemPlugin {\n  /**\n   * Read a file from disk\n   *\n   * @since 1.0.0\n   */\n  readFile(options: ReadFileOptions): Promise<ReadFileResult>;\n\n  /**\n   * Write a file to disk in the specified location on device\n   *\n   * @since 1.0.0\n   */\n  writeFile(options: WriteFileOptions): Promise<WriteFileResult>;\n\n  /**\n   * Append to a file on disk in the specified location on device\n   *\n   * @since 1.0.0\n   */\n  appendFile(options: AppendFileOptions): Promise<void>;\n\n  /**\n   * Delete a file from disk\n   *\n   * @since 1.0.0\n   */\n  deleteFile(options: DeleteFileOptions): Promise<void>;\n\n  /**\n   * Create a directory.\n   *\n   * @since 1.0.0\n   */\n  mkdir(options: MkdirOptions): Promise<void>;\n\n  /**\n   * Remove a directory\n   *\n   * @since 1.0.0\n   */\n  rmdir(options: RmdirOptions): Promise<void>;\n\n  /**\n   * Return a list of files from the directory (not recursive)\n   *\n   * @since 1.0.0\n   */\n  readdir(options: ReaddirOptions): Promise<ReaddirResult>;\n\n  /**\n   * Return full File URI for a path and directory\n   *\n   * @since 1.0.0\n   */\n  getUri(options: GetUriOptions): Promise<GetUriResult>;\n\n  /**\n   * Return data about a file\n   *\n   * @since 1.0.0\n   */\n  stat(options: StatOptions): Promise<StatResult>;\n\n  /**\n   * Rename a file or directory\n   *\n   * @since 1.0.0\n   */\n  rename(options: RenameOptions): Promise<void>;\n\n  /**\n   * Copy a file or directory\n   *\n   * @since 1.0.0\n   */\n  copy(options: CopyOptions): Promise<CopyResult>;\n\n  /**\n   * Check read/write permissions.\n   * Required on Android, only when using `Directory.Documents` or\n   * `Directory.ExternalStorage`.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request read/write permissions.\n   * Required on Android, only when using `Directory.Documents` or\n   * `Directory.ExternalStorage`.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Perform a http request to a server and download the file to the specified destination.\n   *\n   * @since 5.1.0\n   */\n  downloadFile(options: DownloadFileOptions): Promise<DownloadFileResult>;\n\n  /**\n   * Add a listener to file download progress events.\n   *\n   * @since 5.1.0\n   */\n  addListener(\n    eventName: 'progress',\n    listenerFunc: ProgressListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 5.2.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @deprecated Use `ReadFileOptions`.\n * @since 1.0.0\n */\nexport type FileReadOptions = ReadFileOptions;\n\n/**\n * @deprecated Use `ReadFileResult`.\n * @since 1.0.0\n */\nexport type FileReadResult = ReadFileResult;\n\n/**\n * @deprecated Use `WriteFileOptions`.\n * @since 1.0.0\n */\nexport type FileWriteOptions = WriteFileOptions;\n\n/**\n * @deprecated Use `WriteFileResult`.\n * @since 1.0.0\n */\nexport type FileWriteResult = WriteFileResult;\n\n/**\n * @deprecated Use `AppendFileOptions`.\n * @since 1.0.0\n */\nexport type FileAppendOptions = AppendFileOptions;\n\n/**\n * @deprecated Use `DeleteFileOptions`.\n * @since 1.0.0\n */\nexport type FileDeleteOptions = DeleteFileOptions;\n\n/**\n * @deprecated Use `Directory`.\n * @since 1.0.0\n */\nexport const FilesystemDirectory = Directory;\n\n/**\n * @deprecated Use `Encoding`.\n * @since 1.0.0\n */\nexport const FilesystemEncoding = Encoding;\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAQA,MAAM,CAAN,IAAY,SA8FX;AA9FD,WAAY,SAAS;IACnB;;;;;;;;;;;OAWG;IACH,oCAAuB,CAAA;IAEvB;;;;;;;OAOG;IACH,0BAAa,CAAA;IAEb;;;;;;;OAOG;IACH,gCAAmB,CAAA;IAEnB;;;;;;OAMG;IACH,4BAAe,CAAA;IAEf;;;;;;;;;;OAUG;IACH,kCAAqB,CAAA;IAErB;;;;;;;;;;OAUG;IAEH,iDAAoC,CAAA;IACpC;;;;;;OAMG;IACH,6CAAgC,CAAA;IAEhC;;;;;OAKG;IACH,gDAAmC,CAAA;IAEnC;;;;;OAKG;IACH,oCAAuB,CAAA;AACzB,CAAC,EA9FW,SAAS,KAAT,SAAS,QA8FpB;AAED,MAAM,CAAN,IAAY,QAyBX;AAzBD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,yBAAa,CAAA;IAEb;;;;;;OAMG;IACH,2BAAe,CAAA;IAEf;;;;;;OAMG;IACH,2BAAe,CAAA;AACjB,CAAC,EAzBW,QAAQ,KAAR,QAAQ,QAyBnB;AA+mBD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC","sourcesContent":["import type { HttpOptions, PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type CallbackID = string;\n\nexport interface PermissionStatus {\n  publicStorage: PermissionState;\n}\n\nexport enum Directory {\n  /**\n   * The Documents directory.\n   * On iOS it's the app's documents directory.\n   * Use this directory to store user-generated content.\n   * On Android it's the Public Documents folder, so it's accessible from other apps.\n   * It's not accessible on Android 10 unless the app enables legacy External Storage\n   * by adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\n   * in the `AndroidManifest.xml`.\n   * On Android 11 or newer the app can only access the files/folders the app created.\n   *\n   * @since 1.0.0\n   */\n  Documents = 'DOCUMENTS',\n\n  /**\n   * The Data directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the directory holding application files.\n   * Files will be deleted when the application is uninstalled.\n   *\n   * @since 1.0.0\n   */\n  Data = 'DATA',\n\n  /**\n   * The Library directory.\n   * On iOS it will use the Library directory.\n   * On Android it's the directory holding application files.\n   * Files will be deleted when the application is uninstalled.\n   *\n   * @since 1.1.0\n   */\n  Library = 'LIBRARY',\n\n  /**\n   * The Cache directory.\n   * Can be deleted in cases of low memory, so use this directory to write app-specific files.\n   * that your app can re-create easily.\n   *\n   * @since 1.0.0\n   */\n  Cache = 'CACHE',\n\n  /**\n   * The external directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the directory on the primary shared/external\n   * storage device where the application can place persistent files it owns.\n   * These files are internal to the applications, and not typically visible\n   * to the user as media.\n   * Files will be deleted when the application is uninstalled.\n   *\n   * @since 1.0.0\n   */\n  External = 'EXTERNAL',\n\n  /**\n   * The external storage directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the primary shared/external storage directory.\n   * It's not accessible on Android 10 unless the app enables legacy External Storage\n   * by adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\n   * in the `AndroidManifest.xml`.\n   * It's not accessible on Android 11 or newer.\n   *\n   * @since 1.0.0\n   */\n\n  ExternalStorage = 'EXTERNAL_STORAGE',\n  /**\n   * The external cache directory.\n   * On iOS it will use the Documents directory.\n   * On Android it's the primary shared/external cache.\n   *\n   * @since 7.1.0\n   */\n  ExternalCache = 'EXTERNAL_CACHE',\n\n  /**\n   * The Library directory without cloud backup. Used in iOS.\n   * On Android it's the directory holding application files.\n   *\n   * @since 7.1.0\n   */\n  LibraryNoCloud = 'LIBRARY_NO_CLOUD',\n\n  /**\n   * A temporary directory for iOS.\n   * On Android it's the directory holding the application cache.\n   *\n   * @since 7.1.0\n   */\n  Temporary = 'TEMPORARY',\n}\n\nexport enum Encoding {\n  /**\n   * Eight-bit UCS Transformation Format\n   *\n   * @since 1.0.0\n   */\n  UTF8 = 'utf8',\n\n  /**\n   * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the\n   * Unicode character set\n   * This encoding is only supported on Android.\n   *\n   * @since 1.0.0\n   */\n  ASCII = 'ascii',\n\n  /**\n   * Sixteen-bit UCS Transformation Format, byte order identified by an\n   * optional byte-order mark\n   * This encoding is only supported on Android.\n   *\n   * @since 1.0.0\n   */\n  UTF16 = 'utf16',\n}\n\nexport interface WriteFileOptions {\n  /**\n   * The path of the file to write\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The data to write\n   *\n   * Note: Blob data is only supported on Web.\n   *\n   * @since 1.0.0\n   */\n  data: string | Blob;\n\n  /**\n   * The `Directory` to store the file in\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The encoding to write the file in. If not provided, data\n   * is written as base64 encoded.\n   *\n   * Pass Encoding.UTF8 to write data as string\n   *\n   * @since 1.0.0\n   */\n  encoding?: Encoding;\n\n  /**\n   * Whether to create any missing parent directories.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  recursive?: boolean;\n}\n\nexport interface AppendFileOptions {\n  /**\n   * The path of the file to append\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The data to write\n   *\n   * @since 1.0.0\n   */\n  data: string;\n\n  /**\n   * The `Directory` to store the file in\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The encoding to write the file in. If not provided, data\n   * is written as base64 encoded.\n   *\n   * Pass Encoding.UTF8 to write data as string\n   *\n   * @since 1.0.0\n   */\n  encoding?: Encoding;\n}\n\nexport interface ReadFileOptions {\n  /**\n   * The path of the file to read\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to read the file from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The encoding to read the file in, if not provided, data\n   * is read as binary and returned as base64 encoded.\n   *\n   * Pass Encoding.UTF8 to read data as string\n   *\n   * @since 1.0.0\n   */\n  encoding?: Encoding;\n}\n\nexport interface ReadFileInChunksOptions extends ReadFileOptions {\n  /**\n   * Size of the chunks in bytes.\n   *\n   * @since 7.1.0\n   */\n  chunkSize: number;\n}\n\nexport interface DeleteFileOptions {\n  /**\n   * The path of the file to delete\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to delete the file from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n}\n\nexport interface MkdirOptions {\n  /**\n   * The path of the new directory\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to make the new directory in\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * Whether to create any missing parent directories as well.\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  recursive?: boolean;\n}\n\nexport interface RmdirOptions {\n  /**\n   * The path of the directory to remove\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to remove the directory from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * Whether to recursively remove the contents of the directory\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  recursive?: boolean;\n}\n\nexport interface ReaddirOptions {\n  /**\n   * The path of the directory to read\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to list files from\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n}\n\nexport interface GetUriOptions {\n  /**\n   * The path of the file to get the URI for\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to get the file under\n   *\n   * @since 1.0.0\n   */\n  directory: Directory;\n}\n\nexport interface StatOptions {\n  /**\n   * The path of the file to get data about\n   *\n   * @since 1.0.0\n   */\n  path: string;\n\n  /**\n   * The `Directory` to get the file under\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n}\n\nexport interface CopyOptions {\n  /**\n   * The existing file or directory\n   *\n   * @since 1.0.0\n   */\n  from: string;\n\n  /**\n   * The destination file or directory\n   *\n   * @since 1.0.0\n   */\n  to: string;\n\n  /**\n   * The `Directory` containing the existing file or directory\n   *\n   * @since 1.0.0\n   */\n  directory?: Directory;\n\n  /**\n   * The `Directory` containing the destination file or directory. If not supplied will use the 'directory'\n   * parameter as the destination\n   *\n   * @since 1.0.0\n   */\n  toDirectory?: Directory;\n}\n\nexport type RenameOptions = CopyOptions;\n\nexport interface ReadFileResult {\n  /**\n   * The representation of the data contained in the file\n   *\n   * Note: Blob is only available on Web. On native, the data is returned as a string.\n   *\n   * @since 1.0.0\n   */\n  data: string | Blob;\n}\n\nexport interface WriteFileResult {\n  /**\n   * The uri where the file was written into\n   *\n   * @since 1.0.0\n   */\n  uri: string;\n}\n\nexport interface ReaddirResult {\n  /**\n   * List of files and directories inside the directory\n   *\n   * @since 1.0.0\n   */\n  files: FileInfo[];\n}\n\nexport interface FileInfo {\n  /**\n   * Name of the file or directory.\n   *\n   * @since 7.1.0\n   */\n  name: string;\n\n  /**\n   * Type of the file.\n   *\n   * @since 4.0.0\n   */\n  type: 'directory' | 'file';\n\n  /**\n   * Size of the file in bytes.\n   *\n   * @since 4.0.0\n   */\n  size: number;\n\n  /**\n   * Time of creation in milliseconds.\n   *\n   * It's not available on Android 7 and older devices.\n   *\n   * @since 7.1.0\n   */\n  ctime?: number;\n\n  /**\n   * Time of last modification in milliseconds.\n   *\n   * @since 7.1.0\n   */\n  mtime: number;\n\n  /**\n   * The uri of the file.\n   *\n   * @since 4.0.0\n   */\n  uri: string;\n}\n\nexport interface GetUriResult {\n  /**\n   * The uri of the file\n   *\n   * @since 1.0.0\n   */\n  uri: string;\n}\n\nexport type StatResult = FileInfo;\nexport interface CopyResult {\n  /**\n   * The uri where the file was copied into\n   *\n   * @since 4.0.0\n   */\n  uri: string;\n}\n\nexport interface DownloadFileOptions extends HttpOptions {\n  /**\n   * The path the downloaded file should be moved to.\n   *\n   * @since 5.1.0\n   */\n  path: string;\n  /**\n   * The directory to write the file to.\n   * If this option is used, filePath can be a relative path rather than absolute.\n   * The default is the `DATA` directory.\n   *\n   * @since 5.1.0\n   */\n  directory?: Directory;\n  /**\n   * An optional listener function to receive downloaded progress events.\n   * If this option is used, progress event should be dispatched on every chunk received.\n   * Chunks are throttled to every 100ms on Android/iOS to avoid slowdowns.\n   *\n   * @since 5.1.0\n   */\n  progress?: boolean;\n  /**\n   * Whether to create any missing parent directories.\n   *\n   * @default false\n   * @since 5.1.2\n   */\n  recursive?: boolean;\n}\n\nexport interface DownloadFileResult {\n  /**\n   * The path the file was downloaded to.\n   *\n   * @since 5.1.0\n   */\n  path?: string;\n  /**\n   * The blob data of the downloaded file.\n   * This is only available on web.\n   *\n   * @since 5.1.0\n   */\n  blob?: Blob;\n}\n\nexport interface ProgressStatus {\n  /**\n   * The url of the file being downloaded.\n   *\n   * @since 5.1.0\n   */\n  url: string;\n  /**\n   * The number of bytes downloaded so far.\n   *\n   * @since 5.1.0\n   */\n  bytes: number;\n  /**\n   * The total number of bytes to download for this file.\n   *\n   * @since 5.1.0\n   */\n  contentLength: number;\n}\n\n/**\n * Callback for receiving chunks read from a file, or error if something went wrong.\n *\n * @since 7.1.0\n */\nexport type ReadFileInChunksCallback = (chunkRead: ReadFileResult | null, err?: any) => void;\n\n/**\n * A listener function that receives progress events.\n *\n * @since 5.1.0\n */\nexport type ProgressListener = (progress: ProgressStatus) => void;\n\nexport interface FilesystemPlugin {\n  /**\n   * Check read/write permissions.\n   * Required on Android, only when using `Directory.Documents` or\n   * `Directory.ExternalStorage`.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request read/write permissions.\n   * Required on Android, only when using `Directory.Documents` or\n   * `Directory.ExternalStorage`.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Read a file from disk\n   *\n   * @since 1.0.0\n   */\n  readFile(options: ReadFileOptions): Promise<ReadFileResult>;\n\n  /**\n   * Read a file from disk, in chunks.\n   * Native only (not available in web).\n   * Use the callback to receive each read chunk.\n   * If empty chunk is returned, it means file has been completely read.\n   *\n   * @since 7.1.0\n   */\n  readFileInChunks(options: ReadFileInChunksOptions, callback: ReadFileInChunksCallback): Promise<CallbackID>;\n\n  /**\n   * Write a file to disk in the specified location on device\n   *\n   * @since 1.0.0\n   */\n  writeFile(options: WriteFileOptions): Promise<WriteFileResult>;\n\n  /**\n   * Append to a file on disk in the specified location on device\n   *\n   * @since 1.0.0\n   */\n  appendFile(options: AppendFileOptions): Promise<void>;\n\n  /**\n   * Delete a file from disk\n   *\n   * @since 1.0.0\n   */\n  deleteFile(options: DeleteFileOptions): Promise<void>;\n\n  /**\n   * Create a directory.\n   *\n   * @since 1.0.0\n   */\n  mkdir(options: MkdirOptions): Promise<void>;\n\n  /**\n   * Remove a directory\n   *\n   * @since 1.0.0\n   */\n  rmdir(options: RmdirOptions): Promise<void>;\n\n  /**\n   * Return a list of files from the directory (not recursive)\n   *\n   * @since 1.0.0\n   */\n  readdir(options: ReaddirOptions): Promise<ReaddirResult>;\n\n  /**\n   * Return full File URI for a path and directory\n   *\n   * @since 1.0.0\n   */\n  getUri(options: GetUriOptions): Promise<GetUriResult>;\n\n  /**\n   * Return data about a file\n   *\n   * @since 1.0.0\n   */\n  stat(options: StatOptions): Promise<StatResult>;\n\n  /**\n   * Rename a file or directory\n   *\n   * @since 1.0.0\n   */\n  rename(options: RenameOptions): Promise<void>;\n\n  /**\n   * Copy a file or directory\n   *\n   * @since 1.0.0\n   */\n  copy(options: CopyOptions): Promise<CopyResult>;\n\n  /**\n   * Perform a http request to a server and download the file to the specified destination.\n   *\n   * This method has been deprecated since version 7.1.0.\n   * We recommend using the @capacitor/file-transfer plugin instead, in conjunction with this plugin.\n   *\n   * @since 5.1.0\n   * @deprecated Use the @capacitor/file-transfer plugin instead.\n   */\n  downloadFile(options: DownloadFileOptions): Promise<DownloadFileResult>;\n\n  /**\n   * Add a listener to file download progress events.\n   *\n   * This method has been deprecated since version 7.1.0.\n   * We recommend using the @capacitor/file-transfer plugin instead, in conjunction with this plugin.\n   *\n   * @since 5.1.0\n   * @deprecated Use the @capacitor/file-transfer plugin instead.\n   */\n  addListener(eventName: 'progress', listenerFunc: ProgressListener): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * This method has been deprecated since version 7.1.0.\n   * We recommend using the @capacitor/file-transfer plugin instead, in conjunction with this plugin.\n   *\n   * @since 5.2.0\n   * @deprecated Use the @capacitor/file-transfer plugin instead.\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * Structure for errors returned by the plugin.\n *\n * `code` follows \"OS-PLUG-FILE-XXXX\" format\n *\n * @since 1.0.0\n */\nexport type PluginError = {\n  code: string;\n  message: string;\n};\n\n/**\n * @deprecated Use `ReadFileOptions`.\n * @since 1.0.0\n */\nexport type FileReadOptions = ReadFileOptions;\n\n/**\n * @deprecated Use `ReadFileResult`.\n * @since 1.0.0\n */\nexport type FileReadResult = ReadFileResult;\n\n/**\n * @deprecated Use `WriteFileOptions`.\n * @since 1.0.0\n */\nexport type FileWriteOptions = WriteFileOptions;\n\n/**\n * @deprecated Use `WriteFileResult`.\n * @since 1.0.0\n */\nexport type FileWriteResult = WriteFileResult;\n\n/**\n * @deprecated Use `AppendFileOptions`.\n * @since 1.0.0\n */\nexport type FileAppendOptions = AppendFileOptions;\n\n/**\n * @deprecated Use `DeleteFileOptions`.\n * @since 1.0.0\n */\nexport type FileDeleteOptions = DeleteFileOptions;\n\n/**\n * @deprecated Use `Directory`.\n * @since 1.0.0\n */\nexport const FilesystemDirectory = Directory;\n\n/**\n * @deprecated Use `Encoding`.\n * @since 1.0.0\n */\nexport const FilesystemEncoding = Encoding;\n"]}

package/dist/esm/index.js

@@ -1,7 +1,9 @@
 import { registerPlugin } from '@capacitor/core';
+import { exposeSynapse } from '@capacitor/synapse';
 const Filesystem = registerPlugin('Filesystem', {
-    web: () => import('./web').then(m => new m.FilesystemWeb()),
+    web: () => import('./web').then((m) => new m.FilesystemWeb()),
 });
+exposeSynapse();
 export * from './definitions';
 export { Filesystem };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,UAAU,GAAG,cAAc,CAAmB,YAAY,EAAE;IAChE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;CAC5D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { FilesystemPlugin } from './definitions';\n\nconst Filesystem = registerPlugin<FilesystemPlugin>('Filesystem', {\n  web: () => import('./web').then(m => new m.FilesystemWeb()),\n});\n\nexport * from './definitions';\nexport { Filesystem };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAInD,MAAM,UAAU,GAAG,cAAc,CAAmB,YAAY,EAAE;IAChE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,aAAa,EAAE,CAAC;AAEhB,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\nimport { exposeSynapse } from '@capacitor/synapse';\n\nimport type { FilesystemPlugin } from './definitions';\n\nconst Filesystem = registerPlugin<FilesystemPlugin>('Filesystem', {\n  web: () => import('./web').then((m) => new m.FilesystemWeb()),\n});\n\nexposeSynapse();\n\nexport * from './definitions';\nexport { Filesystem };\n"]}

package/dist/esm/web.d.ts

@@ -1,6 +1,7 @@
 import { WebPlugin } from '@capacitor/core';
-import type { AppendFileOptions, CopyOptions, CopyResult, DeleteFileOptions, FilesystemPlugin, GetUriOptions, GetUriResult, MkdirOptions, PermissionStatus, ReadFileOptions, ReadFileResult, ReaddirOptions, ReaddirResult, RenameOptions, RmdirOptions, StatOptions, StatResult, WriteFileOptions, WriteFileResult, DownloadFileOptions, DownloadFileResult } from './definitions';
+import type { AppendFileOptions, CopyOptions, CopyResult, DeleteFileOptions, FilesystemPlugin, GetUriOptions, GetUriResult, MkdirOptions, PermissionStatus, ReadFileOptions, ReadFileResult, ReaddirOptions, ReaddirResult, RenameOptions, RmdirOptions, StatOptions, StatResult, WriteFileOptions, WriteFileResult, ReadFileInChunksOptions, CallbackID, DownloadFileOptions, DownloadFileResult, ReadFileInChunksCallback } from './definitions';
 export declare class FilesystemWeb extends WebPlugin implements FilesystemPlugin {
+    readFileInChunks(_options: ReadFileInChunksOptions, _callback: ReadFileInChunksCallback): Promise<CallbackID>;
     DB_VERSION: number;
     DB_NAME: string;
     private _writeCmds;
@@ -89,6 +90,7 @@ export declare class FilesystemWeb extends WebPlugin implements FilesystemPlugin
     /**
      * Function that performs a http request to a server and downloads the file to the specified destination
      *
+     * @deprecated Use the @capacitor/file-transfer plugin instead.
      * @param options the options for the download operation
      * @returns a promise that resolves with the download file result
      */

package/dist/esm/web.js

@@ -1,12 +1,10 @@
 import { WebPlugin, buildRequestInit } from '@capacitor/core';
 import { Encoding } from './definitions';
 function resolve(path) {
-    const posix = path.split('/').filter(item => item !== '.');
+    const posix = path.split('/').filter((item) => item !== '.');
     const newPosix = [];
-    posix.forEach(item => {
-        if (item === '..' &&
-            newPosix.length > 0 &&
-            newPosix[newPosix.length - 1] !== '..') {
+    posix.forEach((item) => {
+        if (item === '..' && newPosix.length > 0 && newPosix[newPosix.length - 1] !== '..') {
             newPosix.pop();
         }
         else {
@@ -20,8 +18,7 @@ function isPathParent(parent, children) {
     children = resolve(children);
     const pathsA = parent.split('/');
     const pathsB = children.split('/');
-    return (parent !== children &&
-        pathsA.every((value, index) => value === pathsB[index]));
+    return parent !== children && pathsA.every((value, index) => value === pathsB[index]);
 }
 export class FilesystemWeb extends WebPlugin {
     constructor() {
@@ -32,6 +29,7 @@ export class FilesystemWeb extends WebPlugin {
         /**
          * Function that performs a http request to a server and downloads the file to the specified destination
          *
+         * @deprecated Use the @capacitor/file-transfer plugin instead.
          * @param options the options for the download operation
          * @returns a promise that resolves with the download file result
          */
@@ -82,6 +80,9 @@ export class FilesystemWeb extends WebPlugin {
             return { path: result.uri, blob };
         };
     }
+    readFileInChunks(_options, _callback) {
+        throw this.unavailable('Method not implemented.');
+    }
     async initDb() {
         if (this._db !== undefined) {
             return this._db;
@@ -278,9 +279,7 @@ export class FilesystemWeb extends WebPlugin {
         const entry = (await this.dbRequest('get', [path]));
         if (entry === undefined)
             throw Error('File does not exist.');
-        const entries = await this.dbIndexRequest('by_folder', 'getAllKeys', [
-            IDBKeyRange.only(path),
-        ]);
+        const entries = await this.dbIndexRequest('by_folder', 'getAllKeys', [IDBKeyRange.only(path)]);
         if (entries.length !== 0)
             throw Error('Folder is not empty.');
         await this.dbRequest('delete', [path]);
@@ -405,6 +404,7 @@ export class FilesystemWeb extends WebPlugin {
         if (entry === undefined)
             throw Error('Entry does not exist.');
         return {
+            name: entry.path.substring(path.length + 1),
             type: entry.type,
             size: entry.size,
             ctime: entry.ctime,