@functionland/react-native-fula 0.4.0 → 0.4.2

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 teh DAG using Graphsync to the nodes.
+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
 
@@ -11,21 +11,86 @@ npm install react-native-fula
 ## Usage
 
 ```js
-import { fula } from 'react-native-fula';
-
-// ...
+import { fula } from 'react-native-fula'; // Until the library becomes stable, we suggest importing from github directly
+```
 
-//Initialize the fula client, which creates the libp2p connection
-[peerId, cid, private_ref] = await fula.init('', ''); //private key of user's did which will be used to encrypt and store private key of generated peerId for this app, storePath which you can leave empty
+```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 = await fula.mkdir(valueString);
+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"
+);
+```
 
-//Write a file to the pth
-const cid = await fula.writeFile(valueString, ciduint8.toString());
+```js
+//Write a local file on the device to the Fula tree (upload)
+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"
+);
+
+```
+
+## 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 )
+- [ ] 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.

package/android/build.gradle

@@ -1,67 +1,67 @@
-buildscript {
-    if (project == rootProject) {
-        repositories {
-            google()
-            mavenCentral()
-            jcenter()
-        }
-
-        dependencies {
-            classpath 'com.android.tools.build:gradle:7.0.4'
-        }
-    }
-}
-
-apply plugin: 'com.android.library'
-
-def safeExtGet(prop, fallback) {
-    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
-}
-
-android {
-    compileSdkVersion safeExtGet('Fula_compileSdkVersion', 31)
-    defaultConfig {
-        minSdkVersion safeExtGet('Fula_minSdkVersion', 26)
-        targetSdkVersion safeExtGet('Fula_targetSdkVersion', 31)
-        versionCode 1
-        versionName "1.0"
-
-    }
-
-    buildTypes {
-        release {
-            minifyEnabled false
-        }
-    }
-    lintOptions {
-        disable 'GradleCompatible'
-    }
-    compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
-    }
-}
-
-repositories {
-    mavenLocal()
-    google()
-    jcenter()
-    mavenCentral()
-    maven {
-        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
-        url("$rootDir/../node_modules/react-native/android")
-    }
-
-
-
-    // Add this repo to get go-fula package
-    maven { url 'https://jitpack.io' }
-}
-
-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.3' // From jitpack.io
-    // implementation files('mobile.aar')
-}
+buildscript {
+    if (project == rootProject) {
+        repositories {
+            google()
+            mavenCentral()
+            jcenter()
+        }
+
+        dependencies {
+            classpath 'com.android.tools.build:gradle:7.0.4'
+        }
+    }
+}
+
+apply plugin: 'com.android.library'
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+    compileSdkVersion safeExtGet('Fula_compileSdkVersion', 31)
+    defaultConfig {
+        minSdkVersion safeExtGet('Fula_minSdkVersion', 26)
+        targetSdkVersion safeExtGet('Fula_targetSdkVersion', 31)
+        versionCode 1
+        versionName "1.0"
+
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+    }
+    lintOptions {
+        disable 'GradleCompatible'
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+repositories {
+    mavenLocal()
+    google()
+    jcenter()
+    mavenCentral()
+    maven {
+        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+        url("$rootDir/../node_modules/react-native/android")
+    }
+
+
+
+    // Add this repo to get go-fula package
+    maven { url 'https://jitpack.io' }
+}
+
+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 files('mobile.aar')
+}