@functionland/react-native-fula 0.4.2 → 1.0.0

package/src/interfaces/fulaNativeModule.ts

@@ -1,42 +1,52 @@
-import { NativeModules, Platform } from 'react-native';
-
-interface FulaNativeModule {
-  init: (
-    identity: string | null, //Private key of did identity
-    storePath: string | null, //You can leave empty
-    bloxAddr: string, //Blox multiadddr needs to be manually entered now
-    exchange: string //set to 'noope' for testing
-  ) => Promise<[string, string, string]>;
-  get: (key: string) => Promise<string>;
-  has: (key: Uint8Array) => Promise<boolean>;
-  push: () => Promise<string>;
-  put: (content: string, codec: string) => Promise<string>;
-  mkdir: (path: string) => Promise<string>;
-  writeFileContent: (path: string, content: string) => Promise<string>;
-  writeFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
-  ls: (path: string) => Promise<string>;
-  rm: (path: string) => Promise<string>;
-  readFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
-  readFileContent: (path: string) => Promise<string>;
-
-  shutdown: () => Promise<void>;
-}
-
-const LINKING_ERROR =
-  `The package 'react-native-fula' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo managed workflow\n';
-
-const Fula = NativeModules.FulaModule
-  ? NativeModules.FulaModule
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
-
-export default Fula as FulaNativeModule;
+import { NativeModules, Platform } from 'react-native';
+
+interface FulaNativeModule {
+  init: (
+    identity: string, //Private key of did identity
+    storePath: string, //You can leave empty
+    bloxAddr: string, //Blox multiadddr needs to be manually entered now
+    exchange: string, //set to 'noope' for testing
+    rootCid: string | null //if you have the latest rootCid you can send it and it generates the private_ref for filesystem
+  ) => Promise<{ peerId: string; rootCid: string; private_ref: string }>;
+  logout: (identity: string, storePath: string) => Promise<boolean>;
+  get: (key: string) => Promise<string>;
+  has: (key: Uint8Array) => Promise<boolean>;
+  push: () => Promise<string>;
+  put: (content: string, codec: string) => Promise<string>;
+  mkdir: (path: string) => Promise<string>;
+  writeFileContent: (path: string, content: string) => Promise<string>;
+  writeFile: (
+    fulaTargetFilename: string,
+    localFilename: string
+  ) => Promise<string>;
+  ls: (path: string) => Promise<string>;
+  rm: (path: string) => Promise<string>;
+  cp: (sourcePath: string, targetPath: string) => Promise<string>;
+  mv: (sourcePath: string, targetPath: string) => Promise<string>;
+  readFile: (
+    fulaTargetFilename: string,
+    localFilename: string
+  ) => Promise<string>;
+  readFileContent: (path: string) => Promise<string>;
+
+  shutdown: () => Promise<void>;
+}
+
+const LINKING_ERROR =
+  `The package 'react-native-fula' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo managed workflow\n';
+
+const Fula = NativeModules.FulaModule
+  ? NativeModules.FulaModule
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
+
+export default Fula as FulaNativeModule;

package/src/protocols/fula.ts

@@ -1,138 +1,212 @@
-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
-): Promise<[string, string, string]> => {
-  console.log('init in react-native started',identity, storePath, bloxAddr, exchange);
-  return Fula.init(identity, storePath, bloxAddr, exchange);
-};
-
-/**
- * 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();
-};
-
-/**
- * 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
-    // 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<string> => {
-  return Fula.ls(path);
-};
-
-/**
- * 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);
-};
-
-/*
-    // 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();
-};
+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,
+  rootCid: string | null = null
+): Promise<{ peerId: string; rootCid: string; private_ref: string }> => {
+  console.log(
+    'init in react-native started',
+    identity,
+    storePath,
+    bloxAddr,
+    exchange
+  );
+  return Fula.init(identity, storePath, bloxAddr, exchange, rootCid);
+};
+
+/**
+ * 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);
+};
+
+/**
+ * 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();
+};
+
+/**
+ * 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();
+};