@capacitor/filesystem 8.0.0 → 8.1.0

package/CapacitorFilesystem.podspec

@@ -9,10 +9,13 @@ Pod::Spec.new do |s|
   s.license = package['license']
   s.homepage = package['repository']['url']
   s.author = package['author']
-  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
-  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.source = { :git => package['repository']['url'], :tag => "v#{s.version}" }
+  s.source_files = [
+    'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}',
+    'packages/capacitor-plugin/ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  ]
   s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
-  s.dependency 'IONFilesystemLib', spec='~> 1.0.1'
+  s.dependency 'IONFilesystemLib', spec='~> 1.1.0'
   s.swift_version = '5.1'
 end

package/Package.swift

@@ -11,7 +11,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
-        .package(url: "https://github.com/ionic-team/ion-ios-filesystem.git", from: "1.0.1")
+        .package(url: "https://github.com/ionic-team/ion-ios-filesystem.git", from: "1.1.0")
     ],
     targets: [
         .target(

package/README.md

@@ -541,11 +541,13 @@ We recommend using the @capacitor/file-transfer plugin instead, in conjunction w
 
 #### ReadFileOptions
 
-| Prop            | Type                                            | Description                                                                                                                                                                 | Since |
-| --------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
-| **`path`**      | <code>string</code>                             | The path of the file to read                                                                                                                                                | 1.0.0 |
-| **`directory`** | <code><a href="#directory">Directory</a></code> | The <a href="#directory">`Directory`</a> to read the file from                                                                                                              | 1.0.0 |
-| **`encoding`**  | <code><a href="#encoding">Encoding</a></code>   | The encoding to read the file in, if not provided, data is read as binary and returned as base64 encoded. Pass <a href="#encoding">Encoding.UTF8</a> to read data as string | 1.0.0 |
+| Prop            | Type                                            | Description                                                                                                                                                                                            | Default         | Since |
+| --------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------- | ----- |
+| **`path`**      | <code>string</code>                             | The path of the file to read                                                                                                                                                                           |                 | 1.0.0 |
+| **`directory`** | <code><a href="#directory">Directory</a></code> | The <a href="#directory">`Directory`</a> to read the file from                                                                                                                                         |                 | 1.0.0 |
+| **`encoding`**  | <code><a href="#encoding">Encoding</a></code>   | The encoding to read the file in, if not provided, data is read as binary and returned as base64 encoded. Pass <a href="#encoding">Encoding.UTF8</a> to read data as string                            |                 | 1.0.0 |
+| **`offset`**    | <code>number</code>                             | The offset to start reading the file from, in bytes. Native only (not available in web). Can be used in conjunction with length to partially read files.                                               | <code>0</code>  | 8.1.0 |
+| **`length`**    | <code>number</code>                             | The length of data to read, in bytes. Any non-positive value means to read to the end of the file. Native only (not available in web). Can be used in conjunction with offset to partially read files. | <code>-1</code> | 8.1.0 |
 
 
 #### ReadFileInChunksOptions

package/android/build.gradle

@@ -58,7 +58,7 @@ repositories {
 
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
-    implementation "io.ionic.libs:ionfilesystem-android:1.0.0"
+    implementation "io.ionic.libs:ionfilesystem-android:1.1.0"
     implementation project(':capacitor-android')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
 

package/android/src/main/kotlin/com/capacitorjs/plugins/filesystem/FilesystemErrors.kt

@@ -97,5 +97,7 @@ fun Throwable.toFilesystemError(methodName: String): FilesystemErrors.ErrorInfo
     is IONFILEExceptions.CopyRenameFailed.NoParentDirectory ->
         FilesystemErrors.missingParentDirectories
 
+    is IllegalArgumentException -> FilesystemErrors.invalidInputMethod(methodName)
+
     else -> FilesystemErrors.operationFailed(methodName, this.localizedMessage ?: "")
 }

package/android/src/main/kotlin/com/capacitorjs/plugins/filesystem/FilesystemMethodOptions.kt

@@ -1,6 +1,7 @@
 package com.capacitorjs.plugins.filesystem
 
 import com.getcapacitor.PluginCall
+import io.ionic.libs.ionfilesystemlib.model.IONFILEConstants
 import io.ionic.libs.ionfilesystemlib.model.IONFILEEncoding
 import io.ionic.libs.ionfilesystemlib.model.IONFILEFolderType
 import io.ionic.libs.ionfilesystemlib.model.IONFILEReadInChunksOptions
@@ -13,6 +14,8 @@ internal const val INPUT_APPEND = "append"
 private const val INPUT_PATH = "path"
 private const val INPUT_DIRECTORY = "directory"
 private const val INPUT_ENCODING = "encoding"
+private const val INPUT_OFFSET = "offset"
+private const val INPUT_LENGTH = "length"
 private const val INPUT_CHUNK_SIZE = "chunkSize"
 private const val INPUT_DATA = "data"
 private const val INPUT_RECURSIVE = "recursive"
@@ -52,7 +55,15 @@ internal data class DoubleUri(
 internal fun PluginCall.getReadFileOptions(): ReadFileOptions? {
     val uri = getSingleIONFILEUri() ?: return null
     val encoding = IONFILEEncoding.fromEncodingName(getString(INPUT_ENCODING))
-    return ReadFileOptions(uri = uri, options = IONFILEReadOptions(encoding))
+    val offsetAndLength = getOffsetAndLength()
+    return ReadFileOptions(
+        uri = uri,
+        options = IONFILEReadOptions(
+            encoding,
+            offset = offsetAndLength.first,
+            length = offsetAndLength.second
+        )
+    )
 }
 
 /**
@@ -62,9 +73,15 @@ internal fun PluginCall.getReadFileInChunksOptions(): ReadFileInChunksOptions? {
     val uri = getSingleIONFILEUri() ?: return null
     val encoding = IONFILEEncoding.fromEncodingName(getString(INPUT_ENCODING))
     val chunkSize = getInt(INPUT_CHUNK_SIZE)?.takeIf { it > 0 } ?: return null
+    val offsetAndLength = getOffsetAndLength()
     return ReadFileInChunksOptions(
         uri = uri,
-        options = IONFILEReadInChunksOptions(encoding, chunkSize)
+        options = IONFILEReadInChunksOptions(
+            encoding,
+            chunkSize = chunkSize,
+            offset = offsetAndLength.first,
+            length = offsetAndLength.second
+        )
     )
 }
 
@@ -123,6 +140,11 @@ internal fun PluginCall.getSingleIONFILEUri(): IONFILEUri.Unresolved? {
     return unresolvedUri(path, directoryAlias)
 }
 
+private fun PluginCall.getOffsetAndLength(): Pair<Int, Int> = Pair(
+    getInt(INPUT_OFFSET)?.takeIf { it >= 0 } ?: 0,
+    getInt(INPUT_LENGTH)?.takeIf { it > 0 } ?: IONFILEConstants.LENGTH_READ_TIL_EOF
+)
+
 private fun unresolvedUri(path: String, directoryAlias: String?) = IONFILEUri.Unresolved(
     parentFolder = IONFILEFolderType.fromStringAlias(directoryAlias),
     uriPath = path

package/dist/docs.json

@@ -512,6 +512,38 @@
             "Encoding"
           ],
           "type": "Encoding"
+        },
+        {
+          "name": "offset",
+          "tags": [
+            {
+              "text": "8.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0",
+              "name": "default"
+            }
+          ],
+          "docs": "The offset to start reading the file from, in bytes.\nNative only (not available in web).\nCan be used in conjunction with length to partially read files.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "length",
+          "tags": [
+            {
+              "text": "8.1.0",
+              "name": "since"
+            },
+            {
+              "text": "-1",
+              "name": "default"
+            }
+          ],
+          "docs": "The length of data to read, in bytes.\nAny non-positive value means to read to the end of the file.\nNative only (not available in web).\nCan be used in conjunction with offset to partially read files.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -203,6 +203,25 @@ export interface ReadFileOptions {
      * @since 1.0.0
      */
     encoding?: Encoding;
+    /**
+     * The offset to start reading the file from, in bytes.
+     * Native only (not available in web).
+     * Can be used in conjunction with length to partially read files.
+     *
+     * @since 8.1.0
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * The length of data to read, in bytes.
+     * Any non-positive value means to read to the end of the file.
+     * Native only (not available in web).
+     * Can be used in conjunction with offset to partially read files.
+     *
+     * @since 8.1.0
+     * @default -1
+     */
+    length?: number;
 }
 export interface ReadFileInChunksOptions extends ReadFileOptions {
     /**

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"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"]}
+{"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;AAooBD;;;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  /**\n   * The offset to start reading the file from, in bytes.\n   * Native only (not available in web).\n   * Can be used in conjunction with length to partially read files.\n   *\n   * @since 8.1.0\n   * @default 0\n   */\n  offset?: number;\n\n  /**\n   * The length of data to read, in bytes.\n   * Any non-positive value means to read to the end of the file.\n   * Native only (not available in web).\n   * Can be used in conjunction with offset to partially read files.\n   *\n   * @since 8.1.0\n   * @default -1\n   */\n  length?: number;\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/ios/Sources/FilesystemPlugin/FilesystemConstants.swift

@@ -26,6 +26,8 @@ struct Constants {
         static let directory = "directory"
         static let encoding = "encoding"
         static let chunkSize = "chunkSize"
+        static let offset = "offset"
+        static let length = "length"
         static let from = "from"
         static let path = "path"
         static let recursive = "recursive"

package/ios/Sources/FilesystemPlugin/FilesystemOperation.swift

@@ -3,8 +3,8 @@ import IONFilesystemLib
 
 enum FilesystemOperation {
     // Read Operations
-    case readFile(url: URL, encoding: IONFILEEncoding)
-    case readFileInChunks(url: URL, encoding: IONFILEEncoding, chunkSize: Int)
+    case readFile(url: URL, encoding: IONFILEEncoding, offset: Int, length: Int)
+    case readFileInChunks(url: URL, encoding: IONFILEEncoding, chunkSize: Int, offset: Int, length: Int)
     case readdir(url: URL)
     case stat(url: URL)
     case getUri(url: URL)

package/ios/Sources/FilesystemPlugin/FilesystemOperationExecutor.swift

@@ -16,11 +16,11 @@ class FilesystemOperationExecutor {
             var resultData: PluginCallResultData?
 
             switch operation {
-            case .readFile(let url, let encoding):
-                let data = try service.readEntireFile(atURL: url, withEncoding: encoding).textValue
+            case .readFile(let url, let encoding, let offset, let length):
+                let data = try service.readEntireFile(atURL: url, withEncoding: encoding, andOffset: offset, andLength: length).textValue
                 resultData = [Constants.ResultDataKey.data: data]
-            case .readFileInChunks(let url, let encoding, let chunkSize):
-                try processFileInChunks(at: url, withEncoding: encoding, chunkSize: chunkSize, for: operation, call)
+            case .readFileInChunks(let url, let encoding, let chunkSize, let offset, let length):
+                try processFileInChunks(at: url, withEncoding: encoding, chunkSize: chunkSize, offset: offset, length: length, for: operation, call)
                 return
             case .write(let url, let encodingMapper, let recursive):
                 try service.saveFile(atURL: url, withEncodingAndData: encodingMapper, includeIntermediateDirectories: recursive)
@@ -56,9 +56,9 @@ class FilesystemOperationExecutor {
 }
 
 private extension FilesystemOperationExecutor {
-    func processFileInChunks(at url: URL, withEncoding encoding: IONFILEEncoding, chunkSize: Int, for operation: FilesystemOperation, _ call: CAPPluginCall) throws {
+    func processFileInChunks(at url: URL, withEncoding encoding: IONFILEEncoding, chunkSize: Int, offset: Int, length: Int, for operation: FilesystemOperation, _ call: CAPPluginCall) throws {
         let chunkSizeToUse = chunkSizeToUse(basedOn: chunkSize, and: encoding)
-        try service.readFileInChunks(atURL: url, withEncoding: encoding, andChunkSize: chunkSizeToUse)
+        try service.readFileInChunks(atURL: url, withEncoding: encoding, andChunkSize: chunkSizeToUse, andOffset: offset, andLength: length)
             .sink(receiveCompletion: { completion in
                 switch completion {
                 case .finished:
@@ -82,8 +82,8 @@ private extension FilesystemOperationExecutor {
         var path = ""
         var method: IONFileMethod = IONFileMethod.getUri
         switch operation {
-        case .readFile(let url, _): path = url.absoluteString; method = .readFile
-        case .readFileInChunks(let url, _, _): path = url.absoluteString; method = .readFileInChunks
+        case .readFile(let url, _, _, _): path = url.absoluteString; method = .readFile
+        case .readFileInChunks(let url, _, _, _, _): path = url.absoluteString; method = .readFileInChunks
         case .write(let url, _, _): path = url.absoluteString; method = .writeFile
         case .append(let url, _, _): path = url.absoluteString; method = .appendFile
         case .delete(let url): path = url.absoluteString; method = .deleteFile

package/ios/Sources/FilesystemPlugin/FilesystemPlugin.swift

@@ -59,8 +59,10 @@ private extension FilesystemPlugin {
      */
     @objc func readFile(_ call: CAPPluginCall) {
         let encoding = call.getEncoding(Constants.MethodParameter.encoding)
+        let offset = call.getInt(Constants.MethodParameter.offset) ?? 0
+        let length = call.getInt(Constants.MethodParameter.length) ?? -1
         performSinglePathOperation(call) {
-            .readFile(url: $0, encoding: encoding)
+            .readFile(url: $0, encoding: encoding, offset: offset, length: length)
         }
     }
 
@@ -69,8 +71,10 @@ private extension FilesystemPlugin {
         guard let chunkSize = call.getInt(Constants.MethodParameter.chunkSize) else {
             return call.handleError(.invalidInput(method: call.getIONFileMethod()))
         }
+        let offset = call.getInt(Constants.MethodParameter.offset) ?? 0
+        let length = call.getInt(Constants.MethodParameter.length) ?? -1
         performSinglePathOperation(call) {
-            .readFileInChunks(url: $0, encoding: encoding, chunkSize: chunkSize)
+            .readFileInChunks(url: $0, encoding: encoding, chunkSize: chunkSize, offset: offset, length: length)
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/filesystem",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "The Filesystem API provides a NodeJS-like API for working with files on the device.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -43,7 +43,8 @@
     "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "publish:cocoapod": "pod trunk push ./CapacitorFilesystem.podspec --allow-warnings"
   },
   "dependencies": {
     "@capacitor/synapse": "^1.0.4"