@functionland/react-native-fula 1.12.0 → 1.13.1

package/src/protocols/fula.ts

@@ -1,301 +1,314 @@
-import Fula from '../interfaces/fulaNativeModule';
-
-/**
- * Get gets the value corresponding to the given key from the local datastore.
-// The key must be a valid ipld.Link.
- * @param config
- * @returns boolean
- */
-
-export const init = (
-  identity: string, //privateKey of did identity
-  storePath: string,
-  bloxAddr: string,
-  exchange: string,
-  autoFlush: boolean = false,
-  rootCid: string | null = null,
-  useRelay: boolean = true,
-  refresh: boolean = false
-): Promise<{ peerId: string; rootCid: string; private_ref: string }> => {
-  console.log(
-    'init in react-native started',
-    identity,
-    storePath,
-    bloxAddr,
-    exchange,
-    autoFlush,
-    useRelay
-  );
-  return Fula.init(identity, storePath, bloxAddr, exchange, autoFlush, rootCid, useRelay, refresh);
-};
-
-/**
- * Get gets the value corresponding to the given key from the local datastore.
-// The key must be a valid ipld.Link.
- * @param config
- * @returns boolean
- */
-
-export const newClient = (
-  identity: string, //privateKey of did identity
-  storePath: string,
-  bloxAddr: string,
-  exchange: string,
-  autoFlush: boolean = false,
-  useRelay: boolean = true,
-  refresh: boolean = false
-): Promise<string> => {
-  console.log(
-    'newClient in react-native started',
-    identity,
-    storePath,
-    bloxAddr,
-    exchange,
-    autoFlush,
-    useRelay,
-    refresh
-  );
-  return Fula.newClient(identity, storePath, bloxAddr, exchange, autoFlush, useRelay, refresh);
-};
-
-/**
- * rm removes all data
- * @param path
- * @returns string: new cid of the root
- */
-export const logout = (
-  identity: string,
-  storePath: string
-): Promise<boolean> => {
-  return Fula.logout(identity, storePath);
-};
-
-/**
- * Checks if there are any un-synced changes on the device
- */
-export const checkFailedActions = (
-  retry: boolean = false,
-  timeout: number = 20
-): Promise<boolean> => {
-  return Fula.checkFailedActions(retry, timeout);
-};
-
-/**
- * Lists the cids that failed to be sent to backend and are kept only locally
- */
-export const listFailedActions = (cids: string[] = []): Promise<string[]> => {
-  return Fula.listFailedActions(cids);
-};
-
-/**
- * Checks if there are any un-synced changes on the device
- */
-export const checkConnection = (timeout: number = 20): Promise<boolean> => {
-  return Fula.checkConnection(timeout);
-};
-
-/**
- * Get gets the value corresponding to the given key from the local datastore.
-// The key must be a valid ipld.Link.
- * @param key
- * @returns value
- */
-export const get = (key: string): Promise<string> => {
-  return Fula.get(key);
-};
-
-/**
- * Has checks whether the value corresponding to the given key is present in the local datastore.
-// The key must be a valid ipld.Link.
- * @param key
- * @returns boolean
- */
-export const has = (key: Uint8Array): Promise<boolean> => {
-  return Fula.has(key);
-};
-
-/**
- * Push requests the given addr to download the root cid from this node.
-// The addr must be a valid multiaddr that includes peer ID.
-// this function.
- * @param addr
- * @returns null or error
- */
-export const push = (): Promise<string> => {
-  return Fula.push();
-};
-
-//This method sends some test data to backedn
-export const testData = (
-  identity: string,
-  bloxAddr: string
-): Promise<string> => {
-  return Fula.testData(identity, bloxAddr);
-};
-
-/**
- * Put stores the given key value onto the local datastore.
-// The key must be a valid ipld.Link and the value must be the valid encoded ipld.Node corresponding
-// to the given key.
- * @param key, value
- * @returns null or string
- */
-export const put = (value: string, codec: string): Promise<string> => {
-  return Fula.put(value, codec);
-};
-
-/**
- * mkdir creates a directory at the given path.
- * @param path
- * @returns string: new cid of the root
- */
-export const mkdir = (path: string): Promise<string> => {
-  return Fula.mkdir(path);
-};
-
-/**
- * writeFileContent writes content at a given path
- * @param path
- * @returns string: new cid of the root
- */
-export const writeFileContent = (
-  path: string,
-  content: string
-): Promise<string> => {
-  return Fula.writeFileContent(path, content);
-};
-
-/*
-    // reads content of the file form localFilename (should include full absolute path to local file with read permission
-    // writes content to the specified location by fulaTargetFilename in Fula filesystem
-    // It keeps the original file modiifcation date
-    // fulaTargetFilename: a string including full path and filename of target file on Fula (e.g. root/pictures/cat.jpg)
-    // localFilename: a string containing full path and filename of local file on hte device (e.g /usr/bin/cat.jpg)
-    // Returns: new cid of the root after this file is placed in the tree
-     */
-export const writeFile = (
-  fulaTargetFilename: string,
-  localFilename: string
-): Promise<string> => {
-  return Fula.writeFile(fulaTargetFilename, localFilename);
-};
-
-/**
- * ls lists the name of files and folders at a given path
- * @param path
- * @returns string: list of items
- * TODO: Findout how is the string and convert to array
- */
-export const ls = (path: string): Promise<void | JSON> => {
-  return Fula.ls(path)
-    .then((res) => {
-      let lsResult = [];
-      let lsRows = res.split('!!!');
-      for (const element of lsRows) {
-        let rowItems = element.split('???');
-        if (rowItems && rowItems[0]) {
-          let item = {
-            name: '',
-            created: '',
-            modified: '',
-          };
-          item.name = rowItems[0];
-          if (rowItems[1]) {
-            item.created = rowItems[1];
-          }
-          if (rowItems[2]) {
-            item.modified = rowItems[2];
-          }
-          lsResult.push(item);
-        }
-      }
-      let jsonRes = JSON.parse(JSON.stringify(lsResult));
-      return jsonRes;
-    })
-    .catch((e) => {
-      return e;
-    });
-};
-
-/**
- * rm removes all files and folders at a given path
- * @param path
- * @returns string: new cid of the root
- */
-export const rm = (path: string): Promise<string> => {
-  return Fula.rm(path);
-};
-
-/**
- * cp copies the file or folder at the sourcePath to targetPath. targetPath is a folder that must exist already
- * @param sourcePath, targetPath
- * @returns string: new cid of the root
- */
-export const cp = (sourcePath: string, targetPath: string): Promise<string> => {
-  return Fula.cp(sourcePath, targetPath);
-};
-
-/**
- * mv moves the file or folder at the sourcePath to targetPath. targetPath is a folder that must exist already
- * @param sourcePath, targetPath
- * @returns string: new cid of the root
- */
-export const mv = (sourcePath: string, targetPath: string): Promise<string> => {
-  return Fula.mv(sourcePath, targetPath);
-};
-
-/*
-    // reads content of the file form localFilename (should include full absolute path to local file with read permission
-    // writes content to the specified location by fulaTargetFilename in Fula filesystem
-    // fulaTargetFilename: a string including full path and filename of target file on Fula (e.g. root/pictures/cat.jpg)
-    // localFilename: a string containing full path and filename of local file on hte device (e.g /usr/bin/cat.jpg)
-    // Returns: new cid of the root after this file is placed in the tree
-     */
-export const readFile = (
-  fulaTargetFilename: string,
-  localFilename: string
-): Promise<string> => {
-  return Fula.readFile(fulaTargetFilename, localFilename);
-};
-
-/**
- * readFile reads content of a given path
- * @param path
- * @returns string: cotent
- */
-export const readFileContent = (path: string): Promise<string> => {
-  return Fula.readFileContent(path);
-};
-
-/**
- * Shutdown closes all resources used by Client.
-// After calling this function Client must be discarded.
- * @param
- * @returns
- */
-export const shutdown = (): Promise<void> => {
-  return Fula.shutdown();
-};
-
-/**
- * setAuth adds or removes a peer from the list of peers that are allowed to push to this node.
- * This can only be called on a peer that is added as an owner of blox by --authorizer parameter
- * @param peerId, allow
- * @returns boolean: true if successful or false if not
- */
-export const setAuth = (
-  peerId: string,
-  allow: boolean
-): Promise<boolean> => {
-  return Fula.setAuth(peerId, allow);
-};
-
-
-/**
- * isReady checks if the connection is ready to be used.
- * @param filesystemCheck: also check if the wnfs is ready
- * @returns boolean: true if ready or false if not
- */
-export const isReady = (filesystemCheck: boolean = true): Promise<boolean> => {
-  return Fula.isReady(filesystemCheck);
-};
+import Fula from '../interfaces/fulaNativeModule';
+
+/**
+ * Get gets the value corresponding to the given key from the local datastore.
+// The key must be a valid ipld.Link.
+ * @param config
+ * @returns boolean
+ */
+
+export const init = (
+  identity: string, //privateKey of did identity
+  storePath: string,
+  bloxAddr: string,
+  exchange: string,
+  autoFlush: boolean = false,
+  rootCid: string | null = null,
+  useRelay: boolean = true,
+  refresh: boolean = false
+): Promise<{ peerId: string; rootCid: string }> => {
+  console.log(
+    'init in react-native started',
+    identity,
+    storePath,
+    bloxAddr,
+    exchange,
+    autoFlush,
+    useRelay
+  );
+  return Fula.init(
+    identity,
+    storePath,
+    bloxAddr,
+    exchange,
+    autoFlush,
+    rootCid,
+    useRelay,
+    refresh
+  );
+};
+
+/**
+ * Get gets the value corresponding to the given key from the local datastore.
+// The key must be a valid ipld.Link.
+ * @param config
+ * @returns boolean
+ */
+
+export const newClient = (
+  identity: string, //privateKey of did identity
+  storePath: string,
+  bloxAddr: string,
+  exchange: string,
+  autoFlush: boolean = false,
+  useRelay: boolean = true,
+  refresh: boolean = false
+): Promise<string> => {
+  console.log(
+    'newClient in react-native started',
+    identity,
+    storePath,
+    bloxAddr,
+    exchange,
+    autoFlush,
+    useRelay,
+    refresh
+  );
+  return Fula.newClient(
+    identity,
+    storePath,
+    bloxAddr,
+    exchange,
+    autoFlush,
+    useRelay,
+    refresh
+  );
+};
+
+/**
+ * rm removes all data
+ * @param path
+ * @returns string: new cid of the root
+ */
+export const logout = (
+  identity: string,
+  storePath: string
+): Promise<boolean> => {
+  return Fula.logout(identity, storePath);
+};
+
+/**
+ * Checks if there are any un-synced changes on the device
+ */
+export const checkFailedActions = (
+  retry: boolean = false,
+  timeout: number = 20
+): Promise<boolean> => {
+  return Fula.checkFailedActions(retry, timeout);
+};
+
+/**
+ * Lists the cids that failed to be sent to backend and are kept only locally
+ */
+export const listFailedActions = (cids: string[] = []): Promise<string[]> => {
+  return Fula.listFailedActions(cids);
+};
+
+/**
+ * Checks if there are any un-synced changes on the device
+ */
+export const checkConnection = (timeout: number = 20): Promise<boolean> => {
+  return Fula.checkConnection(timeout);
+};
+
+/**
+ * Get gets the value corresponding to the given key from the local datastore.
+// The key must be a valid ipld.Link.
+ * @param key
+ * @returns value
+ */
+export const get = (key: string): Promise<string> => {
+  return Fula.get(key);
+};
+
+/**
+ * Has checks whether the value corresponding to the given key is present in the local datastore.
+// The key must be a valid ipld.Link.
+ * @param key
+ * @returns boolean
+ */
+export const has = (key: Uint8Array): Promise<boolean> => {
+  return Fula.has(key);
+};
+
+/**
+ * Push requests the given addr to download the root cid from this node.
+// The addr must be a valid multiaddr that includes peer ID.
+// this function.
+ * @param addr
+ * @returns null or error
+ */
+export const push = (): Promise<string> => {
+  return Fula.push();
+};
+
+//This method sends some test data to backedn
+export const testData = (
+  identity: string,
+  bloxAddr: string
+): Promise<string> => {
+  return Fula.testData(identity, bloxAddr);
+};
+
+/**
+ * Put stores the given key value onto the local datastore.
+// The key must be a valid ipld.Link and the value must be the valid encoded ipld.Node corresponding
+// to the given key.
+ * @param key, value
+ * @returns null or string
+ */
+export const put = (value: string, codec: string): Promise<string> => {
+  return Fula.put(value, codec);
+};
+
+/**
+ * mkdir creates a directory at the given path.
+ * @param path
+ * @returns string: new cid of the root
+ */
+export const mkdir = (path: string): Promise<string> => {
+  return Fula.mkdir(path);
+};
+
+/**
+ * writeFileContent writes content at a given path
+ * @param path
+ * @returns string: new cid of the root
+ */
+export const writeFileContent = (
+  path: string,
+  content: string
+): Promise<string> => {
+  return Fula.writeFileContent(path, content);
+};
+
+/*
+    // reads content of the file form localFilename (should include full absolute path to local file with read permission
+    // writes content to the specified location by fulaTargetFilename in Fula filesystem
+    // It keeps the original file modiifcation date
+    // fulaTargetFilename: a string including full path and filename of target file on Fula (e.g. root/pictures/cat.jpg)
+    // localFilename: a string containing full path and filename of local file on hte device (e.g /usr/bin/cat.jpg)
+    // Returns: new cid of the root after this file is placed in the tree
+     */
+export const writeFile = (
+  fulaTargetFilename: string,
+  localFilename: string
+): Promise<string> => {
+  return Fula.writeFile(fulaTargetFilename, localFilename);
+};
+
+/**
+ * ls lists the name of files and folders at a given path
+ * @param path
+ * @returns string: list of items
+ * TODO: Findout how is the string and convert to array
+ */
+export const ls = (path: string): Promise<void | JSON> => {
+  return Fula.ls(path)
+    .then((res) => {
+      let lsResult = [];
+      let lsRows = res.split('!!!');
+      for (const element of lsRows) {
+        let rowItems = element.split('???');
+        if (rowItems && rowItems[0]) {
+          let item = {
+            name: '',
+            created: '',
+            modified: '',
+          };
+          item.name = rowItems[0];
+          if (rowItems[1]) {
+            item.created = rowItems[1];
+          }
+          if (rowItems[2]) {
+            item.modified = rowItems[2];
+          }
+          lsResult.push(item);
+        }
+      }
+      let jsonRes = JSON.parse(JSON.stringify(lsResult));
+      return jsonRes;
+    })
+    .catch((e) => {
+      return e;
+    });
+};
+
+/**
+ * rm removes all files and folders at a given path
+ * @param path
+ * @returns string: new cid of the root
+ */
+export const rm = (path: string): Promise<string> => {
+  return Fula.rm(path);
+};
+
+/**
+ * cp copies the file or folder at the sourcePath to targetPath. targetPath is a folder that must exist already
+ * @param sourcePath, targetPath
+ * @returns string: new cid of the root
+ */
+export const cp = (sourcePath: string, targetPath: string): Promise<string> => {
+  return Fula.cp(sourcePath, targetPath);
+};
+
+/**
+ * mv moves the file or folder at the sourcePath to targetPath. targetPath is a folder that must exist already
+ * @param sourcePath, targetPath
+ * @returns string: new cid of the root
+ */
+export const mv = (sourcePath: string, targetPath: string): Promise<string> => {
+  return Fula.mv(sourcePath, targetPath);
+};
+
+/*
+    // reads content of the file form localFilename (should include full absolute path to local file with read permission
+    // writes content to the specified location by fulaTargetFilename in Fula filesystem
+    // fulaTargetFilename: a string including full path and filename of target file on Fula (e.g. root/pictures/cat.jpg)
+    // localFilename: a string containing full path and filename of local file on hte device (e.g /usr/bin/cat.jpg)
+    // Returns: new cid of the root after this file is placed in the tree
+     */
+export const readFile = (
+  fulaTargetFilename: string,
+  localFilename: string
+): Promise<string> => {
+  return Fula.readFile(fulaTargetFilename, localFilename);
+};
+
+/**
+ * readFile reads content of a given path
+ * @param path
+ * @returns string: cotent
+ */
+export const readFileContent = (path: string): Promise<string> => {
+  return Fula.readFileContent(path);
+};
+
+/**
+ * Shutdown closes all resources used by Client.
+// After calling this function Client must be discarded.
+ * @param
+ * @returns
+ */
+export const shutdown = (): Promise<void> => {
+  return Fula.shutdown();
+};
+
+/**
+ * setAuth adds or removes a peer from the list of peers that are allowed to push to this node.
+ * This can only be called on a peer that is added as an owner of blox by --authorizer parameter
+ * @param peerId, allow
+ * @returns boolean: true if successful or false if not
+ */
+export const setAuth = (peerId: string, allow: boolean): Promise<boolean> => {
+  return Fula.setAuth(peerId, allow);
+};
+
+/**
+ * isReady checks if the connection is ready to be used.
+ * @param filesystemCheck: also check if the wnfs is ready
+ * @returns boolean: true if ready or false if not
+ */
+export const isReady = (filesystemCheck: boolean = true): Promise<boolean> => {
+  return Fula.isReady(filesystemCheck);
+};