@functionland/react-native-fula 1.0.0 → 1.1.5

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

@@ -1,28 +1,58 @@
-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) => 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>;
-}
-declare const _default: FulaNativeModule;
-export default _default;
+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
+    autoFlush: boolean, //set to false always unless you know what you are doing. This is to write actions to disk explicitly after each write
+    rootCid: string | null, //if you have the latest rootCid you can send it and it generates the private_ref for filesystem
+    useRelay: boolean | null, // if true it forces the use of relay
+    refresh: boolean) => Promise<{
+        peerId: string;
+        rootCid: string;
+        private_ref: string;
+    }>;
+    newClient: (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
+    autoFlush: boolean, //set to false always unless you know what you are doing. This is to write actions to disk explicitly after each write
+    useRelay: boolean | null, // if true it forces the use of relay
+    refresh: boolean) => Promise<string>;
+    isReady: (filesystemCheck: boolean) => Promise<boolean>;
+    logout: (identity: string, storePath: string) => Promise<boolean>;
+    checkFailedActions: (retry: boolean) => Promise<boolean>;
+    checkConnection: () => 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>;
+    setAuth: (peerId: string, allow: boolean) => Promise<boolean>;
+    shutdown: () => Promise<void>;
+    createAccount: (seed: string) => Promise<string>;
+    checkAccountExists: (account: string) => Promise<string>;
+    createPool: (seed: string, poolName: string) => Promise<string>;
+    listPools: () => Promise<string>;
+    joinPool: (seed: string, poolID: number) => Promise<string>;
+    leavePool: (seed: string, poolID: number) => Promise<string>;
+    cancelPoolJoin: (seed: string, poolID: number) => Promise<string>;
+    listPoolJoinRequests: (poolID: number) => Promise<string>;
+    votePoolJoinRequest: (seed: string, poolID: number, account: string, accept: boolean) => Promise<string>;
+    newReplicationRequest: (seed: string, poolID: number, replicationFactor: number, cid: string) => Promise<string>;
+    newStoreRequest: (seed: string, poolID: number, uploader: string, cid: string) => Promise<string>;
+    listAvailableReplicationRequests: (poolID: number) => Promise<string>;
+    removeReplicationRequest: (seed: string, poolID: number, cid: string) => Promise<string>;
+    removeStorer: (seed: string, storer: string, poolID: number, cid: string) => Promise<string>;
+    removeStoredReplication: (seed: string, uploader: string, poolID: number, cid: string) => Promise<string>;
+    bloxFreeSpace: () => Promise<string>;
+}
+declare const _default: FulaNativeModule;
+export default _default;

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

@@ -0,0 +1,17 @@
+import type * as BType from '../types/blockchain';
+export declare const createAccount: (seed: string) => Promise<BType.SeededResponse>;
+export declare const checkAccountExists: (account: string) => Promise<BType.AccountExistsResponse>;
+export declare const createPool: (seed: string, poolName: string) => Promise<BType.PoolCreateResponse>;
+export declare const listPools: () => Promise<BType.PoolListResponse>;
+export declare const joinPool: (seed: string, poolID: number) => Promise<BType.PoolJoinResponse>;
+export declare const leavePool: (seed: string, poolID: number) => Promise<BType.PoolLeaveResponse>;
+export declare const cancelPoolJoin: (seed: string, poolID: number) => Promise<BType.PoolCancelJoinResponse>;
+export declare const listPoolJoinRequests: (poolID: number) => Promise<BType.PoolRequestsResponse>;
+export declare const votePoolJoinRequest: (seed: string, poolID: number, account: string, accept: boolean) => Promise<BType.PoolVoteResponse>;
+export declare const newReplicationRequest: (seed: string, poolID: number, replicationFactor: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const newStoreRequest: (seed: string, poolID: number, uploader: string, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const listAvailableReplicationRequests: (poolID: number) => Promise<BType.ManifestUploadResponse[]>;
+export declare const removeReplicationRequest: (seed: string, poolID: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const removeStorer: (seed: string, storer: string, poolID: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const removeStoredReplication: (seed: string, uploader: string, poolID: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const bloxFreeSpace: () => Promise<BType.BloxFreeSpaceResponse>;

package/lib/typescript/protocols/chain-api.d.ts

@@ -0,0 +1,6 @@
+import { ApiPromise } from '@polkadot/api';
+import type * as BType from '../types/blockchain';
+export declare const init: (wsAddress?: string) => Promise<ApiPromise>;
+export declare const disconnectApi: (api: ApiPromise) => Promise<void>;
+export declare const listPools: (api: ApiPromise | undefined, start?: number, length?: number) => Promise<BType.PoolListResponse>;
+export declare const checkJoinRequest: (api: ApiPromise | undefined, poolId: number, accountId: string) => Promise<BType.PoolRequest | null>;

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

@@ -1,99 +1,127 @@
-/**
- * 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, storePath: string, bloxAddr: string, exchange: string, rootCid?: string | null) => Promise<{
-    peerId: string;
-    rootCid: string;
-    private_ref: string;
-}>;
-/**
- * rm removes all data
- * @param path
- * @returns string: new cid of the root
- */
-export declare const logout: (identity: string, storePath: string) => Promise<boolean>;
-/**
- * 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<void | JSON>;
-/**
- * rm removes all files and folders at a given path
- * @param path
- * @returns string: new cid of the root
- */
-export declare const rm: (path: string) => Promise<string>;
-/**
- * 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 declare const cp: (sourcePath: string, targetPath: string) => Promise<string>;
-/**
- * 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 declare const mv: (sourcePath: string, targetPath: string) => Promise<string>;
-export declare const readFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
-/**
- * readFile reads content of a given path
- * @param path
- * @returns string: cotent
- */
-export declare const readFileContent: (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>;
+/**
+ * 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, storePath: string, bloxAddr: string, exchange: string, autoFlush?: boolean, rootCid?: string | null, useRelay?: boolean, refresh?: boolean) => Promise<{
+    peerId: string;
+    rootCid: string;
+    private_ref: string;
+}>;
+/**
+ * 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 newClient: (identity: string, storePath: string, bloxAddr: string, exchange: string, autoFlush?: boolean, useRelay?: boolean, refresh?: boolean) => Promise<string>;
+/**
+ * rm removes all data
+ * @param path
+ * @returns string: new cid of the root
+ */
+export declare const logout: (identity: string, storePath: string) => Promise<boolean>;
+/**
+ * Checks if there are any un-synced changes on the device
+ */
+export declare const checkFailedActions: (retry?: boolean) => Promise<boolean>;
+/**
+ * Checks if there are any un-synced changes on the device
+ */
+export declare const checkConnection: () => Promise<boolean>;
+/**
+ * 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<void | JSON>;
+/**
+ * rm removes all files and folders at a given path
+ * @param path
+ * @returns string: new cid of the root
+ */
+export declare const rm: (path: string) => Promise<string>;
+/**
+ * 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 declare const cp: (sourcePath: string, targetPath: string) => Promise<string>;
+/**
+ * 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 declare const mv: (sourcePath: string, targetPath: string) => Promise<string>;
+export declare const readFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
+/**
+ * readFile reads content of a given path
+ * @param path
+ * @returns string: cotent
+ */
+export declare const readFileContent: (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>;
+/**
+ * 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 declare const setAuth: (peerId: string, allow: boolean) => Promise<boolean>;
+/**
+ * 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 declare const isReady: (filesystemCheck?: boolean) => Promise<boolean>;

package/lib/typescript/types/blockchain.d.ts

@@ -0,0 +1,68 @@
+export interface SeededResponse {
+    seed: string;
+    account: string;
+}
+export interface AccountExistsResponse {
+    account: string;
+    exists: boolean;
+}
+export interface PoolCreateResponse {
+    owner: string;
+    poolID: number;
+}
+export interface PoolJoinResponse {
+    account: string;
+    poolID: number;
+}
+export interface PoolCancelJoinResponse {
+    account: string;
+    poolID: number;
+}
+export interface PoolRequestsResponse {
+    poolRequests: PoolRequest[];
+}
+export interface PoolListResponse {
+    pools: Pool[];
+}
+export interface PoolVoteResponse {
+    account: string;
+    poolID: number;
+}
+export interface PoolLeaveResponse {
+    account: string;
+    poolID: number;
+}
+export interface ManifestUploadResponse {
+    uploader: string;
+    storage: string[];
+    manifestMetadata: ManifestMetadata;
+    poolID: number;
+}
+export interface PoolRequest {
+    poolID: number;
+    account: string;
+    voted: string[];
+    positiveVotes: number;
+    peerID: string;
+}
+export interface Pool {
+    poolID: number;
+    owner: string;
+    poolName: string;
+    parent: string;
+    participants: string[];
+}
+export interface ManifestMetadata {
+    job: ManifestJob;
+}
+export interface ManifestJob {
+    work: string;
+    engine: string;
+    uri: string;
+}
+export interface BloxFreeSpaceResponse {
+    size: number;
+    avail: number;
+    used: number;
+    used_percentage: number;
+}