@functionland/react-native-fula 0.4.2 → 1.1.4

package/README.md

@@ -1,6 +1,6 @@
 # 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. 
+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
 
@@ -15,7 +15,20 @@ import { fula } from 'react-native-fula'; // Until the library becomes stable, w
 ```
 
 ```js
-//Initialize the fula client, which creates the libp2p connection. Note that input is not an object e.g. init('','','','noop')
+// 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
@@ -26,7 +39,10 @@ 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
+    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
 );
 ```
 
@@ -40,7 +56,7 @@ await fula.mkdir(
 ```
 
 ```js
-//Write a local file on the device to the Fula tree (upload)
+//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(
@@ -51,14 +67,13 @@ await fula.writeFile(
 ```
 
 ```js
-//reads a file on fula tree to a local file on the device (download)
+//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"
 );
-//// TODO: This needs to be improved by using stream to not overload the memory for large files
 ```
 
 ```js
@@ -81,15 +96,90 @@ await fula.rm(
 
 ```
 
+```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
-- [ ] Add WNFS tree encryption key generation from an input (deterministically)
-- [ ] Improve ls, read, and write functions to use a stream. ( :100: v1.0.0 Release here )
+- [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
-- [ ] Connect to backend
+
+## 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
 

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

@@ -1,2 +1,2 @@
-#Mon Nov 28 14:42:26 EST 2022
+#Sat Dec 17 20:00:09 EST 2022
 gradle.version=7.5.1

package/android/.idea/jarRepositories.xml

@@ -19,18 +19,18 @@
     <remote-repository>
       <option name="id" value="maven" />
       <option name="name" value="maven" />
-      <option name="url" value="file:/$PROJECT_DIR$/../node_modules/react-native/android/" />
+      <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="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" />
@@ -42,9 +42,9 @@
       <option name="url" value="https://jitpack.io" />
     </remote-repository>
     <remote-repository>
-      <option name="id" value="MavenLocal" />
-      <option name="name" value="MavenLocal" />
-      <option name="url" value="file:/$USER_HOME$/.m2/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/build.gradle

@@ -7,7 +7,7 @@ buildscript {
         }
 
         dependencies {
-            classpath 'com.android.tools.build:gradle:7.0.4'
+            classpath 'com.android.tools.build:gradle:4.2.2'
         }
     }
 }
@@ -19,8 +19,8 @@ def safeExtGet(prop, fallback) {
 }
 
 android {
-    compileSdkVersion safeExtGet('Fula_compileSdkVersion', 31)
-    defaultConfig {
+  compileSdk 33
+  defaultConfig {
         minSdkVersion safeExtGet('Fula_minSdkVersion', 26)
         targetSdkVersion safeExtGet('Fula_targetSdkVersion', 31)
         versionCode 1
@@ -40,6 +40,7 @@ android {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
+  ndkVersion '25.1.8937393'
 }
 
 repositories {
@@ -61,7 +62,8 @@ repositories {
 dependencies {
     //noinspection GradleDynamicVersion
     implementation "com.facebook.react:react-native:+"  // From node_modules
-    implementation 'com.github.functionland:fula-build-aar:v0.7.3' // From jitpack.io
-    implementation 'com.github.functionland:wnfs-build-aar:v1.2.4' // From jitpack.io
+    implementation 'com.github.functionland:fula-build-aar:0.8.7beta' // From jitpack.io
+    implementation 'com.github.functionland:wnfs-build-aar:v1.4.1' // From jitpack.io
+    implementation 'commons-io:commons-io:20030203.000550'
     // implementation files('mobile.aar')
 }

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
-#Wed Nov 16 15:32:27 EST 2022
-distributionBase=GRADLE_USER_HOME
-distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip
+#Wed Nov 16 15:32:27 EST 2022
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip

package/android/gradle.properties

@@ -1 +1 @@
-android.useAndroidX=true
+android.useAndroidX=true

package/android/gradlew

@@ -2,6 +2,7 @@
 
 #
 # Copyright © 2015-2021 the original authors.
+# Copyright © 2015-2021 the original authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -60,10 +61,54 @@
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
 #
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
 ##############################################################################
 
 # Attempt to set APP_HOME
 
+
 # Resolve links: $0 may be a link
 app_path=$0
 
@@ -79,6 +124,8 @@ do
       *)    app_path=$APP_HOME$link ;;
     esac
 done
+app_path=$0
+
 
 APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
@@ -90,6 +137,7 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
+MAX_FD=maximum
 
 warn () {
     echo "$*"
@@ -117,13 +165,16 @@ esac
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
         # IBM's JDK on AIX uses strange locations for the executables
         JAVACMD=$JAVA_HOME/jre/sh/java
+        JAVACMD=$JAVA_HOME/jre/sh/java
     else
         JAVACMD=$JAVA_HOME/bin/java
+        JAVACMD=$JAVA_HOME/bin/java
     fi
     if [ ! -x "$JAVACMD" ] ; then
         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
@@ -211,6 +262,7 @@ then
     die "xargs is not available"
 fi
 
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
@@ -236,5 +288,4 @@ eval "set -- $(
         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
         tr '\n' ' '
     )" '"$@"'
-
-exec "$JAVACMD" "$@"
+exec "$JAVACMD" "$@"

package/android/local.properties

@@ -4,5 +4,5 @@
 # Location of the SDK. This is only used by Gradle.
 # For customization when using a Version Control System, please read the
 # header note.
-#Wed Nov 30 17:21:01 EST 2022
+#Sat Dec 17 19:59:53 EST 2022
 sdk.dir=C\:\\Users\\ehsan\\AppData\\Local\\Android\\Sdk