@functionland/react-native-fula 1.0.0 → 1.1.5

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Mahdi Ghorbani
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Mahdi Ghorbani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,133 +1,190 @@
-# react-native-fula
-
-This package is a bridge to use the Fula protocols in the react-native. It uses WNFS to create the Merkle dag from files and folders and transfer the DAG using Graphsync to the nodes. 
-
-## Installation
-
-```sh
-npm install react-native-fula
-```
-
-## Usage
-
-```js
-import { fula } from 'react-native-fula'; // Until the library becomes stable, we suggest importing from github directly
-```
-
-```js
-//Initialize the fula client, which creates the libp2p connection. Note that input is not an object e.g. init('','','','noop')
-[
-    peerId, //returns peerId of the created libp2p instance in form of a string of bytes
-    cid, //return the root cid of the WNFS merkle DAG in form of a string
-    private_ref //return the keys needed to decode hte encrypted WNFS tree in form of a string of object
-] 
-= 
-await fula.init( 
-    identity: string, //bytes of the privateKey of did identity in string format
-    storePath: string, // leave empty to use the default temp one
-    bloxAddr: string, //leave empty for testing without a backend node
-    exchange: 'noop'|'' //add noop for testing without a backend
-);
-```
-
-```js
-//Creates a Folder
-const cid //returns the cid of the new root. Note that on every write action the root cid changes.
-= 
-await fula.mkdir(
-    path: string // This is the Fula path to create a folder and always starts with "root/" and should not start or end with a slash e.g "root/pictures"
-);
-```
-
-```js
-//Write a local file on the device to the Fula tree (upload). It keeps the original file modification date.
-const cid //returns the cid of the new root. Note that on every write action the root cid changes.
-= 
-await fula.writeFile(
-    fulaTargetFilename: string, //path to the file on the tree. It should include the filename and extension and start from the "root/". e.g. "root/pictures/cat.jpg"
-    localFilename: string //path to the local file. e.g the file that needs to be uploaded
-);
-//// TODO: This needs to be improved by using stream to not overload the memory for large files
-```
-
-```js
-//reads a file on fula tree to a local file on the device (download)
-const localFilePath //returns the path to the local file and includes the filename
-= 
-await fula.readFile(
-    fulaTargetFilename: string, //path to the file on the tree. It should include the filename and extension and start from the "root/". e.g. "root/pictures/cat.jpg"
-    localFilename: string //path to the local file. It should include the filename and extension. e.g. "/temp/cat.jpg"
-);
-//// TODO: This needs to be improved by using stream to not overload the memory for large files
-```
-
-```js
-//shows all files and folders under the specified path on Fula
-const fileList //returns all the files and folders in a string separated by \n
-= 
-await fula.ls(
-    path: string, //path to the folder on the tree. It always starts from the "root". e.g. "root" or "root/pictures"
-);
-//// TODO: This needs to be improved by returning an array of files and folders and in chunks to not overload hte memory for large folders
-```
-
-```js
-//removes all files and folders at the specified path on Fula
-const cid //returns the cid of the new root. Note that on every write action the root cid changes.
-= 
-await fula.rm(
-    path: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures" or "root/pictures/cat.jpg"
-);
-
-```
-
-```js
-//copies the specified file or folder at sourcePath to the filename at targetPath. the path itself(apart from filename) must exist
-const cid //returns the cid of the new root. Note that on every write action the root cid changes.
-= 
-await fula.cp(
-    sourcePath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures" or "root/pictures/cat.jpg"
-    targetPath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures2" or "root/pictures2/cat.jpg"
-);
-
-```
-
-```js
-//moves the specified file or folder at sourcePath to the filename at targetPath. the path itself(apart from filename) must exist
-const cid //returns the cid of the new root. Note that on every write action the root cid changes.
-= 
-await fula.mv(
-    sourcePath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures" or "root/pictures/cat.jpg"
-    targetPath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures2" or "root/pictures2/cat.jpg"
-);
-
-```
-
-```js
-//removes all Fula related data and information (Except the encrypted filesystem) at the specified storage local path
-const result //returns true if succesful and false if fails
-= 
-await fula.logout(
-    identity: string, //bytes of the privateKey of did identity in string format
-    storePath: string, // leave empty to use the default temp one
-);
-
-```
-
-## Roadmap
-
-Please note the following might not be done in order:
-
-- [x] Initial version with all functions included
-- [x] Add WNFS tree encryption key generation from an input (deterministically)
-- [x] Improve ead function to use a stream. ( :100: v1 Release here )
-- [ ] Connect to Blockchain codes using APIs
-- [ ] Connect to backend
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
-
-## License
-
-MIT
+# react-native-fula
+
+This package is a bridge to use the [Fula protocols](https://github.com/functionland/go-fula) in the react-native. It uses [WNFS](https://github.com/wnfs-wg/rs-wnfs) to create the Merkle dag from files and folders and transfer the DAG using Graphsync to the nodes. 
+
+## Installation
+
+```sh
+npm install react-native-fula
+```
+
+## Usage
+
+```js
+import { fula } from 'react-native-fula'; // Until the library becomes stable, we suggest importing from github directly
+```
+
+```js
+// Creates a new client without creating a filesystem. It is better to call this instead of directly calling init
+const peerId //returns peerId as string
+=  newClient(
+  identity: string, //privateKey of did identity
+  storePath: string, // leave empty to use the default temp one
+  bloxAddr: string, //leave empty for testing without a backend node
+  exchange: 'noop'|'', //add noop for testing without a backend
+  autoFlush: boolean, //Default to false. Always set to false unless you know what you are doing. explicitly write data to disk after each operation if set to true
+  useRelay: boolean //default to true. If true it forces the connection through relay
+)
+```
+
+```js
+//Initialize the fula client, which creates the libp2p connection if newClient is not called before, and creates filesystem. Note that input is not an object e.g. init('','','','noop', false)
+[
+    peerId, //returns peerId of the created libp2p instance in form of a string of bytes
+    cid, //return the root cid of the WNFS merkle DAG in form of a string
+    private_ref //return the keys needed to decode hte encrypted WNFS tree in form of a string of object
+] 
+= 
+await fula.init( 
+    identity: string, //bytes of the privateKey of did identity in string format
+    storePath: string, // leave empty to use the default temp one
+    bloxAddr: string, //leave empty for testing without a backend node
+    exchange: 'noop'|'', //add noop for testing without a backend
+    autoFlush: boolean, //Default to false. Always set to false unless you know what you are doing. explicitly write data to disk after each operation if set to true
+    useRelay: boolean, //default to true. If true it forces the connection through relay
+    refresh: boolean //forces the fula object to be recreated. default is false
+);
+```
+
+```js
+//Creates a Folder
+const cid //returns the cid of the new root. Note that on every write action the root cid changes.
+= 
+await fula.mkdir(
+    path: string // This is the Fula path to create a folder and always starts with "root/" and should not start or end with a slash e.g "root/pictures"
+);
+```
+
+```js
+//Write a local file on the device to the Fula tree (upload). It keeps the original file modification date.
+const cid //returns the cid of the new root. Note that on every write action the root cid changes.
+= 
+await fula.writeFile(
+    fulaTargetFilename: string, //path to the file on the tree. It should include the filename and extension and start from the "root/". e.g. "root/pictures/cat.jpg"
+    localFilename: string //path to the local file. e.g the file that needs to be uploaded
+);
+//// TODO: This needs to be improved by using stream to not overload the memory for large files
+```
+
+```js
+//reads a file on fula tree to a local file on the device (download). It is stream so does not affect memory for large files.
+const localFilePath //returns the path to the local file and includes the filename
+= 
+await fula.readFile(
+    fulaTargetFilename: string, //path to the file on the tree. It should include the filename and extension and start from the "root/". e.g. "root/pictures/cat.jpg"
+    localFilename: string //path to the local file. It should include the filename and extension. e.g. "/temp/cat.jpg"
+);
+```
+
+```js
+//shows all files and folders under the specified path on Fula
+const fileList //returns all the files and folders in a string separated by \n
+= 
+await fula.ls(
+    path: string, //path to the folder on the tree. It always starts from the "root". e.g. "root" or "root/pictures"
+);
+//// TODO: This needs to be improved by returning an array of files and folders and in chunks to not overload hte memory for large folders
+```
+
+```js
+//removes all files and folders at the specified path on Fula
+const cid //returns the cid of the new root. Note that on every write action the root cid changes.
+= 
+await fula.rm(
+    path: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures" or "root/pictures/cat.jpg"
+);
+
+```
+
+```js
+//copies the specified file or folder at sourcePath to the filename at targetPath. the path itself(apart from filename) must exist
+const cid //returns the cid of the new root. Note that on every write action the root cid changes.
+= 
+await fula.cp(
+    sourcePath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures" or "root/pictures/cat.jpg"
+    targetPath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures2" or "root/pictures2/cat.jpg"
+);
+
+```
+
+```js
+//moves the specified file or folder at sourcePath to the filename at targetPath. the path itself(apart from filename) must exist
+const cid //returns the cid of the new root. Note that on every write action the root cid changes.
+= 
+await fula.mv(
+    sourcePath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures" or "root/pictures/cat.jpg"
+    targetPath: string, //path to the file or folder on the tree. It always starts from the "root". e.g. "root/pictures2" or "root/pictures2/cat.jpg"
+);
+
+```
+
+```js
+//checks if fula is ready (initialized through newClient or init)
+const result //returns true if succesful and false if fails
+= 
+await fula.isReady(
+    filesystemCheck: boolean //Default is true. If true it checks if both WNFS and Fula are ready. If false it only checks fula
+);
+
+```
+
+```js
+//checks if client can reach server
+const result //returns true if it can, and false if it cannot
+= 
+await fula.checkConnection();
+
+```
+
+```js
+//checks if there are any un-synced actions on the client
+const result //returns true if there are, and false if everything is synced with server
+= 
+await fula.checkFailedActions(
+    retry: boolean //if true, it tries to sync device with server, if not, it only checks
+);
+```
+
+```js
+//shuts down the fula libp2p and datastore
+await fula.shutdown();
+```
+
+```js
+//removes all Fula related data and information (Except the encrypted filesystem) at the specified storage local path
+const result //returns true if succesful and false if fails
+= 
+await fula.logout(
+    identity: string, //bytes of the privateKey of did identity in string format
+    storePath: string, // leave empty to use the default temp one
+);
+
+```
+
+## Roadmap
+
+Please note the following might not be done in order:
+
+- [x] Initial version with all functions included
+- [x] Add WNFS tree encryption key generation from an input (deterministically)
+- [x] Improve ead function to use a stream. ( :100: v1 Release here )
+- [x] Connect to backend
+- [ ] Connect to Blockchain codes using APIs
+
+## Other related libraries
+
+| Name | Description |
+| --- | --- |
+| [WNFS for Android](https://github.com/functionland/wnfs-android) | Android build for WNFS rust version |
+| [WNFS for iOS](https://github.com/functionland/wnfs-ios) | iOS build for WNFS rust version |
+| [WNFS Build](https://github.com/functionland/wnfs-build-aar) | Android .aar for WNFS |
+| [Fula Build](https://github.com/functionland/fula-build-aar) | android .aar file for Fula |
+| [Fx Fotos](https://github.com/functionland/fx-fotos) | Fx Fotos dApp using react-native-fula |
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -1,2 +1,2 @@
-#Sun Dec 11 21:25:25 EST 2022
-gradle.version=7.5.1
+#Sat Dec 17 20:00:09 EST 2022
+gradle.version=7.5.1

package/android/.idea/compiler.xml

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CompilerConfiguration">
-    <bytecodeTargetLevel target="11" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CompilerConfiguration">
+    <bytecodeTargetLevel target="11" />
+  </component>
 </project>

package/android/.idea/gradle.xml

@@ -1,18 +1,19 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GradleMigrationSettings" migrationVersion="1" />
-  <component name="GradleSettings">
-    <option name="linkedExternalProjectsSettings">
-      <GradleProjectSettings>
-        <option name="testRunner" value="GRADLE" />
-        <option name="distributionType" value="DEFAULT_WRAPPED" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="modules">
-          <set>
-            <option value="$PROJECT_DIR$" />
-          </set>
-        </option>
-      </GradleProjectSettings>
-    </option>
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GradleMigrationSettings" migrationVersion="1" />
+  <component name="GradleSettings">
+    <option name="linkedExternalProjectsSettings">
+      <GradleProjectSettings>
+        <option name="testRunner" value="GRADLE" />
+        <option name="distributionType" value="DEFAULT_WRAPPED" />
+        <option name="externalProjectPath" value="$PROJECT_DIR$" />
+        <option name="gradleHome" value="$PROJECT_DIR$/../../../../../../Gradle/gradle-7.6" />
+        <option name="modules">
+          <set>
+            <option value="$PROJECT_DIR$" />
+          </set>
+        </option>
+      </GradleProjectSettings>
+    </option>
+  </component>
 </project>

package/android/.idea/jarRepositories.xml

@@ -1,45 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="RemoteRepositoriesConfiguration">
-    <remote-repository>
-      <option name="id" value="central" />
-      <option name="name" value="Maven Central repository" />
-      <option name="url" value="https://repo1.maven.org/maven2" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="jboss.community" />
-      <option name="name" value="JBoss Community repository" />
-      <option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="MavenRepo" />
-      <option name="name" value="MavenRepo" />
-      <option name="url" value="https://repo.maven.apache.org/maven2/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven" />
-      <option name="name" value="maven" />
-      <option name="url" value="file:$PROJECT_DIR$/../node_modules/react-native/android/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="BintrayJCenter" />
-      <option name="name" value="BintrayJCenter" />
-      <option name="url" value="https://jcenter.bintray.com/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="MavenLocal" />
-      <option name="name" value="MavenLocal" />
-      <option name="url" value="file:$USER_HOME$/.m2/repository/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="Google" />
-      <option name="name" value="Google" />
-      <option name="url" value="https://dl.google.com/dl/android/maven2/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven2" />
-      <option name="name" value="maven2" />
-      <option name="url" value="https://jitpack.io" />
-    </remote-repository>
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RemoteRepositoriesConfiguration">
+    <remote-repository>
+      <option name="id" value="central" />
+      <option name="name" value="Maven Central repository" />
+      <option name="url" value="https://repo1.maven.org/maven2" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="jboss.community" />
+      <option name="name" value="JBoss Community repository" />
+      <option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="MavenRepo" />
+      <option name="name" value="MavenRepo" />
+      <option name="url" value="https://repo.maven.apache.org/maven2/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="maven" />
+      <option name="name" value="maven" />
+      <option name="url" value="file:/$PROJECT_DIR$/../node_modules/react-native/android" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="MavenLocal" />
+      <option name="name" value="MavenLocal" />
+      <option name="url" value="file:/$USER_HOME$/.m2/repository/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="BintrayJCenter" />
+      <option name="name" value="BintrayJCenter" />
+      <option name="url" value="https://jcenter.bintray.com/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="Google" />
+      <option name="name" value="Google" />
+      <option name="url" value="https://dl.google.com/dl/android/maven2/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="maven2" />
+      <option name="name" value="maven2" />
+      <option name="url" value="https://jitpack.io" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="maven" />
+      <option name="name" value="maven" />
+      <option name="url" value="file:/$PROJECT_DIR$/../node_modules/react-native/android/" />
+    </remote-repository>
+  </component>
 </project>

package/android/.idea/misc.xml

@@ -1,10 +1,10 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="Android Studio default JDK" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/build/classes" />
-  </component>
-  <component name="ProjectType">
-    <option name="id" value="Android" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="Android Studio default JDK" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/build/classes" />
+  </component>
+  <component name="ProjectType">
+    <option name="id" value="Android" />
+  </component>
 </project>

package/android/.idea/vcs.xml

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
+  </component>
 </project>