@functionland/react-native-fula 0.4.0

package/lib/module/protocols/fula.js

@@ -0,0 +1,113 @@
+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, storePath, bloxAddr) => {
+  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 => {
+  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 => {
+  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 = () => {
+  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, codec) => {
+  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 => {
+  return Fula.mkdir(path);
+};
+
+/**
+ * writeFileContent writes content at a given path
+ * @param path
+ * @returns string: new cid of the root
+ */
+export const writeFileContent = (path, content) => {
+  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, localFilename) => {
+  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 => {
+  return Fula.ls(path);
+};
+
+/**
+ * readFile reads content of a given path
+ * @param path
+ * @returns string: cotent
+ */
+export const readFile = path => {
+  return Fula.readFile(path);
+};
+
+/**
+ * Shutdown closes all resources used by Client.
+// After calling this function Client must be discarded.
+ * @param
+ * @returns
+ */
+export const shutdown = () => {
+  return Fula.shutdown();
+};
+//# sourceMappingURL=fula.js.map

package/lib/module/protocols/fula.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["Fula","init","identity","storePath","bloxAddr","console","log","get","key","has","push","put","value","codec","mkdir","path","writeFileContent","content","writeFile","fulaTargetFilename","localFilename","ls","readFile","shutdown"],"sources":["fula.ts"],"sourcesContent":["import Fula from '../interfaces/fulaNativeModule';\n\n/**\n * Get gets the value corresponding to the given key from the local datastore.\n// The key must be a valid ipld.Link.\n * @param config\n * @returns boolean\n */\nexport const init = (\n  identity: string | null, //privateKey of did identity\n  storePath: string | null,\n  bloxAddr: string,\n): Promise<[string]> => {\n  console.log('init in react-native started',identity, storePath, bloxAddr);\n  return Fula.init(identity, storePath, bloxAddr);\n};\n\n/**\n * Get gets the value corresponding to the given key from the local datastore.\n// The key must be a valid ipld.Link.\n * @param key\n * @returns value\n */\nexport const get = (key: string): Promise<string> => {\n  return Fula.get(key);\n};\n\n/**\n * Has checks whether the value corresponding to the given key is present in the local datastore.\n// The key must be a valid ipld.Link.\n * @param key\n * @returns boolean\n */\nexport const has = (key: Uint8Array): Promise<boolean> => {\n  return Fula.has(key);\n};\n\n/**\n * Push requests the given addr to download the root cid from this node.\n// The addr must be a valid multiaddr that includes peer ID.\n// this function.\n * @param addr\n * @returns null or error\n */\nexport const push = (): Promise<string> => {\n  return Fula.push();\n};\n\n/**\n * Put stores the given key value onto the local datastore.\n// The key must be a valid ipld.Link and the value must be the valid encoded ipld.Node corresponding\n// to the given key.\n * @param key, value\n * @returns null or string\n */\nexport const put = (value: string, codec: string): Promise<string> => {\n  return Fula.put(value, codec);\n};\n\n/**\n * mkdir creates a directory at the given path.\n * @param path\n * @returns string: new cid of the root\n */\nexport const mkdir = (path: string): Promise<string> => {\n  return Fula.mkdir(path);\n};\n\n/**\n * writeFileContent writes content at a given path\n * @param path\n * @returns string: new cid of the root\n */\nexport const writeFileContent = (path: string, content: string): Promise<string> => {\n  return Fula.writeFileContent(path, content);\n};\n\n/*\n    // reads content of the file form localFilename (should include full absolute path to local file with read permission\n    // writes content to the specified location by fulaTargetFilename in Fula filesystem\n    // fulaTargetFilename: a string including full path and filename of target file on Fula (e.g. root/pictures/cat.jpg)\n    // localFilename: a string containing full path and filename of local file on hte device (e.g /usr/bin/cat.jpg)\n    // Returns: new cid of the root after this file is placed in the tree\n     */\nexport const writeFile = (fulaTargetFilename: string, localFilename: string): Promise<string> => {\n  return Fula.writeFile(fulaTargetFilename, localFilename);\n};\n\n/**\n * ls lists the name of files and folders at a given path\n * @param path\n * @returns string: list of items\n * TODO: Findout how is the string and convert to array\n */\n export const ls = (path: string): Promise<string> => {\n  return Fula.ls(path);\n};\n\n/**\n * readFile reads content of a given path\n * @param path\n * @returns string: cotent\n */\n export const readFile = (path: string): Promise<string> => {\n  return Fula.readFile(path);\n};\n\n/**\n * Shutdown closes all resources used by Client.\n// After calling this function Client must be discarded.\n * @param\n * @returns\n */\nexport const shutdown = (): Promise<void> => {\n  return Fula.shutdown();\n};\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,gCAAgC;;AAEjD;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,IAAI,GAAG,CAClBC,QAAuB,EACvBC,SAAwB,EACxBC,QAAgB,KACM;EACtBC,OAAO,CAACC,GAAG,CAAC,8BAA8B,EAACJ,QAAQ,EAAEC,SAAS,EAAEC,QAAQ,CAAC;EACzE,OAAOJ,IAAI,CAACC,IAAI,CAACC,QAAQ,EAAEC,SAAS,EAAEC,QAAQ,CAAC;AACjD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMG,GAAG,GAAIC,GAAW,IAAsB;EACnD,OAAOR,IAAI,CAACO,GAAG,CAACC,GAAG,CAAC;AACtB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,GAAG,GAAID,GAAe,IAAuB;EACxD,OAAOR,IAAI,CAACS,GAAG,CAACD,GAAG,CAAC;AACtB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAME,IAAI,GAAG,MAAuB;EACzC,OAAOV,IAAI,CAACU,IAAI,EAAE;AACpB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,GAAG,GAAG,CAACC,KAAa,EAAEC,KAAa,KAAsB;EACpE,OAAOb,IAAI,CAACW,GAAG,CAACC,KAAK,EAAEC,KAAK,CAAC;AAC/B,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,KAAK,GAAIC,IAAY,IAAsB;EACtD,OAAOf,IAAI,CAACc,KAAK,CAACC,IAAI,CAAC;AACzB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,gBAAgB,GAAG,CAACD,IAAY,EAAEE,OAAe,KAAsB;EAClF,OAAOjB,IAAI,CAACgB,gBAAgB,CAACD,IAAI,EAAEE,OAAO,CAAC;AAC7C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAG,CAACC,kBAA0B,EAAEC,aAAqB,KAAsB;EAC/F,OAAOpB,IAAI,CAACkB,SAAS,CAACC,kBAAkB,EAAEC,aAAa,CAAC;AAC1D,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACC,OAAO,MAAMC,EAAE,GAAIN,IAAY,IAAsB;EACpD,OAAOf,IAAI,CAACqB,EAAE,CAACN,IAAI,CAAC;AACtB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACC,OAAO,MAAMO,QAAQ,GAAIP,IAAY,IAAsB;EAC1D,OAAOf,IAAI,CAACsB,QAAQ,CAACP,IAAI,CAAC;AAC5B,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMQ,QAAQ,GAAG,MAAqB;EAC3C,OAAOvB,IAAI,CAACuB,QAAQ,EAAE;AACxB,CAAC"}

package/lib/typescript/index.d.ts

@@ -0,0 +1 @@
+export * as fula from './protocols/fula';

package/lib/typescript/interfaces/fulaNativeModule.d.ts

@@ -0,0 +1,17 @@
+interface FulaNativeModule {
+    init: (identity: string | null, //Private key of did identity
+    storePath: string | null, //You can leave empty
+    bloxAddr: string) => 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>;
+}
+declare const _default: FulaNativeModule;
+export default _default;

package/lib/typescript/protocols/fula.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 declare const init: (identity: string | null, storePath: string | null, bloxAddr: string) => Promise<[string]>;
+/**
+ * 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 declare const get: (key: string) => Promise<string>;
+/**
+ * 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 declare const has: (key: Uint8Array) => Promise<boolean>;
+/**
+ * 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 declare const push: () => Promise<string>;
+/**
+ * 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 declare const put: (value: string, codec: string) => Promise<string>;
+/**
+ * mkdir creates a directory at the given path.
+ * @param path
+ * @returns string: new cid of the root
+ */
+export declare const mkdir: (path: string) => Promise<string>;
+/**
+ * writeFileContent writes content at a given path
+ * @param path
+ * @returns string: new cid of the root
+ */
+export declare const writeFileContent: (path: string, content: string) => Promise<string>;
+export declare const writeFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
+/**
+ * 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 declare const ls: (path: string) => Promise<string>;
+/**
+ * readFile reads content of a given path
+ * @param path
+ * @returns string: cotent
+ */
+export declare const readFile: (path: string) => Promise<string>;
+/**
+ * Shutdown closes all resources used by Client.
+// After calling this function Client must be discarded.
+ * @param
+ * @returns
+ */
+export declare const shutdown: () => Promise<void>;

package/package.json

@@ -0,0 +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"
+        }
+      ]
+    ]
+  }
+}

package/react-native-fula.podspec

@@ -0,0 +1,19 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-fula"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "10.0" }
+  s.source       = { :git => "https://github.com/functionland/react-native-fula.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm}"
+  s.dependency "React-Core"
+  s.dependency 'Mobile','~> 0.0.3'
+end

package/src/index.tsx

@@ -0,0 +1 @@
+export * as fula from './protocols/fula';

package/src/interfaces/fulaNativeModule.ts

@@ -0,0 +1,39 @@
+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;

package/src/protocols/fula.ts

@@ -0,0 +1,116 @@
+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();
+};