@functionland/react-native-fula 0.4.0 → 0.4.2

package/package.json

@@ -1,152 +1,152 @@
-{
-  "name": "@functionland/react-native-fula",
-  "version": "0.4.0",
-  "description": "This package is a bridge to use the Fula libp2p protocols in the react-native which is using wnfs",
-  "main": "lib/commonjs/index",
-  "module": "lib/module/index",
-  "types": "lib/typescript/index.d.ts",
-  "react-native": "src/index",
-  "source": "src/index",
-  "files": [
-    "src",
-    "lib",
-    "android",
-    "ios",
-    "cpp",
-    "!example/",
-    "react-native-fula.podspec",
-    "!lib/typescript/example",
-    "!android/build",
-    "!ios/build",
-    "!**/__tests__",
-    "!**/__fixtures__",
-    "!**/__mocks__"
-  ],
-  "scripts": {
-    "test": "jest",
-    "typescript": "tsc --noEmit",
-    "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepare": "bob build",
-    "release": "release-it",
-    "example": "yarn --cwd example",
-    "pods": "cd example && pod-install --quiet",
-    "bootstrap": "yarn example && yarn && yarn pods"
-  },
-  "keywords": [
-    "react-native",
-    "ios",
-    "android"
-  ],
-  "repository": "https://github.com/functionland/react-native-fula",
-  "author": "Ehsan Shariati <ehsan6sha@gmail.com> (https://github.com/ehsan6sha)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/functionland/react-native-fula/issues"
-  },
-  "homepage": "https://github.com/functionland/react-native-fula#readme",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
-  "dependencies": {
-
-  },
-  "devDependencies": {
-    "@babel/plugin-proposal-export-namespace-from": "^7.16.7",
-    "@commitlint/config-conventional": "^11.0.0",
-    "@react-native-community/eslint-config": "^2.0.0",
-    "@release-it/conventional-changelog": "^2.0.0",
-    "@types/jest": "^26.0.0",
-    "@types/react": "^16.9.19",
-    "@types/react-native": "0.62.13",
-    "commitlint": "^11.0.0",
-    "eslint": "^7.2.0",
-    "eslint-config-prettier": "^7.0.0",
-    "eslint-plugin-prettier": "^3.1.3",
-    "husky": "^6.0.0",
-    "jest": "^26.0.1",
-    "pod-install": "^0.1.0",
-    "prettier": "^2.0.5",
-    "react": "16.13.1",
-    "react-native": "0.63.4",
-    "react-native-builder-bob": "^0.18.0",
-    "release-it": "^14.2.2",
-    "typescript": "^4.1.3"
-  },
-  "peerDependencies": {
-    "react": "*",
-    "react-native": "*"
-  },
-  "jest": {
-    "preset": "react-native",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/example/node_modules",
-      "<rootDir>/lib/"
-    ]
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "release-it": {
-    "git": {
-      "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
-    },
-    "npm": {
-      "publish": true
-    },
-    "github": {
-      "release": true
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular"
-      }
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@react-native-community",
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/"
-  ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
-  "react-native-builder-bob": {
-    "source": "src",
-    "output": "lib",
-    "targets": [
-      "commonjs",
-      "module",
-      [
-        "typescript",
-        {
-          "project": "tsconfig.build.json"
-        }
-      ]
-    ]
-  }
-}
+{
+  "name": "@functionland/react-native-fula",
+  "version": "0.4.2",
+  "description": "This package is a bridge to use the Fula libp2p protocols in the react-native which is using wnfs",
+  "main": "lib/commonjs/index",
+  "module": "lib/module/index",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "!example/",
+    "react-native-fula.podspec",
+    "!lib/typescript/example",
+    "!android/build",
+    "!ios/build",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "prepare": "bob build",
+    "release": "release-it",
+    "example": "yarn --cwd example",
+    "pods": "cd example && pod-install --quiet",
+    "bootstrap": "yarn example && yarn && yarn pods"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": "https://github.com/functionland/react-native-fula",
+  "author": "Ehsan Shariati <ehsan6sha@gmail.com> (https://github.com/ehsan6sha)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/functionland/react-native-fula/issues"
+  },
+  "homepage": "https://github.com/functionland/react-native-fula#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "dependencies": {
+
+  },
+  "devDependencies": {
+    "@babel/plugin-proposal-export-namespace-from": "^7.16.7",
+    "@commitlint/config-conventional": "^11.0.0",
+    "@react-native-community/eslint-config": "^2.0.0",
+    "@release-it/conventional-changelog": "^2.0.0",
+    "@types/jest": "^26.0.0",
+    "@types/react": "^16.9.19",
+    "@types/react-native": "0.62.13",
+    "commitlint": "^11.0.0",
+    "eslint": "^7.2.0",
+    "eslint-config-prettier": "^7.0.0",
+    "eslint-plugin-prettier": "^3.1.3",
+    "husky": "^6.0.0",
+    "jest": "^26.0.1",
+    "pod-install": "^0.1.0",
+    "prettier": "^2.0.5",
+    "react": "16.13.1",
+    "react-native": "0.63.4",
+    "react-native-builder-bob": "^0.18.0",
+    "release-it": "^14.2.2",
+    "typescript": "^4.1.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native-community",
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  }
+}

package/src/interfaces/fulaNativeModule.ts

@@ -1,39 +1,42 @@
-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
-  ) => Promise<[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>;
-  readFile: (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 | 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;

package/src/protocols/fula.ts

@@ -1,116 +1,138 @@
-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 | null, //privateKey of did identity
-  storePath: string | null,
-  bloxAddr: string,
-): Promise<[string]> => {
-  console.log('init in react-native started',identity, storePath, bloxAddr);
-  return Fula.init(identity, storePath, bloxAddr);
-};
-
-/**
- * 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);
-};
-
-/**
- * readFile reads content of a given path
- * @param path
- * @returns string: cotent
- */
- export const readFile = (path: string): Promise<string> => {
-  return Fula.readFile(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
+): 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();
+};