@capacitor/filesystem - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [1.0.1](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/filesystem@1.0.0...@capacitor/filesystem@1.0.1) (2021-06-09)
+
+**Note:** Version bump only for package @capacitor/filesystem
+
+
+
+
+
 # [1.0.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/filesystem@0.5.6...@capacitor/filesystem@1.0.0) (2021-05-19)
@@ -8,0 +16,0 @@

dist/docs.json

@@ -980,3 +980,3 @@ {
           ],
-          "docs": "The Documents directory\nOn iOS it's the app's documents directory.\nUse this directory to store user-generated content.\nOn Android it's the Public Documents folder, so it's accessible from other apps.\nIt's not accesible on Android 10 unless the app enables legacy External Storage\nby adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\nin the `AndroidManifest.xml`"
+          "docs": "The Documents directory\nOn iOS it's the app's documents directory.\nUse this directory to store user-generated content.\nOn Android it's the Public Documents folder, so it's accessible from other apps.\nIt's not accesible on Android 10 unless the app enables legacy External Storage\nby adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\nin the `AndroidManifest.xml`.\nIt's not accesible on Android 11 or newer."
         },
@@ -1025,3 +1025,3 @@ {
           ],
-          "docs": "The external storage directory\nOn iOS it will use the Documents directory\nOn Android it's the primary shared/external storage directory.\nIt's not accesible on Android 10 unless the app enables legacy External Storage\nby adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\nin the `AndroidManifest.xml`"
+          "docs": "The external storage directory\nOn iOS it will use the Documents directory\nOn Android it's the primary shared/external storage directory.\nIt's not accesible on Android 10 unless the app enables legacy External Storage\nby adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag\nin the `AndroidManifest.xml`.\nIt's not accesible on Android 11 or newer."
         }
@@ -1028,0 +1028,0 @@ ]

dist/esm/definitions.d.ts

@@ -13,3 +13,4 @@ import type { PermissionState } from '@capacitor/core';
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-     * in the `AndroidManifest.xml`
+     * in the `AndroidManifest.xml`.
+     * It's not accesible on Android 11 or newer.
      *
@@ -54,3 +55,4 @@ * @since 1.0.0
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-     * in the `AndroidManifest.xml`
+     * in the `AndroidManifest.xml`.
+     * It's not accesible on Android 11 or newer.
      *
@@ -57,0 +59,0 @@ * @since 1.0.0

dist/esm/definitions.js

@@ -10,3 +10,4 @@ export var Directory;
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-     * in the `AndroidManifest.xml`
+     * in the `AndroidManifest.xml`.
+     * It's not accesible on Android 11 or newer.
      *
@@ -51,3 +52,4 @@ * @since 1.0.0
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-     * in the `AndroidManifest.xml`
+     * in the `AndroidManifest.xml`.
+     * It's not accesible on Android 11 or newer.
      *
@@ -54,0 +56,0 @@ * @since 1.0.0

dist/plugin.cjs.js

@@ -16,3 +16,4 @@ 'use strict';
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-     * in the `AndroidManifest.xml`
+     * in the `AndroidManifest.xml`.
+     * It's not accesible on Android 11 or newer.
      *
@@ -57,3 +58,4 @@ * @since 1.0.0
      * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-     * in the `AndroidManifest.xml`
+     * in the `AndroidManifest.xml`.
+     * It's not accesible on Android 11 or newer.
      *
@@ -60,0 +62,0 @@ * @since 1.0.0

dist/plugin.js

@@ -13,3 +13,4 @@ var capacitorFilesystem = (function (exports, core) {
          * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-         * in the `AndroidManifest.xml`
+         * in the `AndroidManifest.xml`.
+         * It's not accesible on Android 11 or newer.
          *
@@ -54,3 +55,4 @@ * @since 1.0.0
          * by adding `android:requestLegacyExternalStorage="true"` in the `application` tag
-         * in the `AndroidManifest.xml`
+         * in the `AndroidManifest.xml`.
+         * It's not accesible on Android 11 or newer.
          *
@@ -57,0 +59,0 @@ * @since 1.0.0

package.json

 {
   "name": "@capacitor/filesystem",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "The Filesystem API provides a NodeJS-like API for working with files on the device.",
@@ -47,6 +47,6 @@ "main": "dist/plugin.cjs.js",
   "devDependencies": {
-    "@capacitor/android": "3.0.0",
-    "@capacitor/core": "3.0.0",
+    "@capacitor/android": "^3.0.0",
+    "@capacitor/core": "^3.0.0",
     "@capacitor/docgen": "0.0.16",
-    "@capacitor/ios": "3.0.0",
+    "@capacitor/ios": "^3.0.0",
     "@ionic/eslint-config": "^0.3.0",
@@ -64,3 +64,3 @@ "@ionic/prettier-config": "~1.0.1",
   "peerDependencies": {
-    "@capacitor/core": "3.0.0"
+    "@capacitor/core": "^3.0.0"
   },
@@ -83,3 +83,3 @@ "prettier": "@ionic/prettier-config",
   },
-  "gitHead": "d264b9e6547d97e86258e067bd37254311d9f1a5"
+  "gitHead": "4307cd7af743bd3ae1942d892982542b0ccd8599"
 }

README.md

@@ -12,2 +12,17 @@ # @capacitor/filesystem
 
+## Android
+
+If using <a href="#directory">`Directory.Documents`</a> or
+`Directory.ExternalStorage`, this API requires the following permissions be added to your `AndroidManifest.xml`:
+
+```xml
+<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+```
+
+Read about [Setting Permissions](https://capacitorjs.com/docs/android/configuration#setting-permissions) in the [Android Guide](https://capacitorjs.com/docs/android) for more information on setting Android permissions.
+
+Note that <a href="#directory">`Directory.Documents`</a> and
+`Directory.ExternalStorage` are only available on Android 9 or older.
+
 ## Understanding Directories and Files
@@ -476,9 +491,9 @@
 
-| Members               | Value                           | Description                                                                                                                                                                                                                                                                                                                                                                                           | Since |
-| --------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
-| **`Documents`**       | <code>'DOCUMENTS'</code>        | The Documents 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 by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` | 1.0.0 |
-| **`Data`**            | <code>'DATA'</code>             | The Data directory On iOS it will use the Documents directory On Android it's the directory holding application files. Files will be deleted when the application is uninstalled.                                                                                                                                                                                                                     | 1.0.0 |
-| **`Cache`**           | <code>'CACHE'</code>            | The Cache directory Can be deleted in cases of low memory, so use this directory to write app-specific files that your app can re-create easily.                                                                                                                                                                                                                                                      | 1.0.0 |
-| **`External`**        | <code>'EXTERNAL'</code>         | The external directory On iOS it will use the Documents directory On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled.                                      | 1.0.0 |
-| **`ExternalStorage`** | <code>'EXTERNAL_STORAGE'</code> | 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 by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`                                                                | 1.0.0 |
+| Members               | Value                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Since |
+| --------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`Documents`**       | <code>'DOCUMENTS'</code>        | The Documents 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 by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 |
+| **`Data`**            | <code>'DATA'</code>             | The Data directory On iOS it will use the Documents directory On Android it's the directory holding application files. Files will be deleted when the application is uninstalled.                                                                                                                                                                                                                                                                 | 1.0.0 |
+| **`Cache`**           | <code>'CACHE'</code>            | The Cache directory Can be deleted in cases of low memory, so use this directory to write app-specific files that your app can re-create easily.                                                                                                                                                                                                                                                                                                  | 1.0.0 |
+| **`External`**        | <code>'EXTERNAL'</code>         | The external directory On iOS it will use the Documents directory On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled.                                                                                  | 1.0.0 |
+| **`ExternalStorage`** | <code>'EXTERNAL_STORAGE'</code> | 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 by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer.                                                                | 1.0.0 |
 
@@ -485,0 +500,0 @@

No alert changes

Improved metrics

Total package byte prevSize

290982

increased by0.68%

Number of lines in readme file

508

increased by3.04%

Worsened metrics

Lines of code

3423

decreased by-16.14%

No dependency changes