tool-db 2.5.3 → 2.5.5

package/lib/toolDbFunction.ts

@@ -0,0 +1,49 @@
+import {
+  AllowedFunctionArguments,
+  FunctionReturn,
+  GenericObject,
+  textRandom,
+  ToolDb,
+} from ".";
+
+/**
+ * Triggers a FUNCTION request to other peers. If the function executes sucessfully it will return code "OK"
+ * @param function function name
+ * @param args arguments for the function
+ * @param timeout Max time to wait for remote.
+ * @returns Promise<FunctionReturn>
+ */
+export default function toolDbFunction<R, A = GenericObject>(
+  this: ToolDb,
+  fName: string,
+  args: AllowedFunctionArguments<A>,
+  timeoutMs = 10000
+): Promise<FunctionReturn<R>> {
+  return new Promise((resolve, reject) => {
+    this.logger("FUNCTION > " + fName);
+
+    const msgId = textRandom(10);
+
+    const cancelTimeout = setTimeout(() => {
+      resolve({ return: "Timed out", code: "ERR" });
+    }, timeoutMs);
+
+    this.addIdListener(msgId, (msg) => {
+      this.logger("FUNCTION RECV  > " + fName, msg);
+
+      clearTimeout(cancelTimeout);
+      if (msg.type === "functionReturn") {
+        resolve({ return: msg.return, code: msg.code });
+      }
+    });
+
+    // Do get
+    this.network.sendToAll({
+      type: "function",
+      to: [],
+      function: fName,
+      args: args,
+      id: msgId,
+    });
+  });
+}

package/lib/toolDbGet.ts

@@ -1,80 +1,81 @@
-import { ToolDb, textRandom } from ".";
-
-/**
- * Triggers a GET request to other peers. If the data is available locally it will return that instead.
- * @param key key of the data
- * @param userNamespaced If this key bolongs to a user or its public. Making it private will enforce validation for our address and signatures.
- * @param timeout Max time to wait for remote.
- * @returns Promise<Data>
- */
-export default function toolDbGet<T = any>(
-  this: ToolDb,
-  key: string,
-  userNamespaced = false,
-  timeoutMs = 1000
-): Promise<T | null> {
-  return new Promise((resolve, reject) => {
-    if (userNamespaced && this.userAccount.getAddress() === undefined) {
-      reject(new Error("You are not authorized yet!"));
-      return;
-    }
-    const finalKey = userNamespaced
-      ? `:${this.userAccount.getAddress()}.${key}`
-      : key;
-    this.logger("GET", finalKey);
-
-    const msgId = textRandom(10);
-
-    const cancelTimeout = setTimeout(() => {
-      this.store
-        .get(finalKey)
-        .then((data) => {
-          try {
-            const message = JSON.parse(data);
-            this.emit("data", message);
-            resolve(message.v);
-          } catch (e) {
-            resolve(null);
-          }
-        })
-        .catch((e) => {
-          resolve(null);
-        });
-    }, timeoutMs);
-
-    this.addIdListener(msgId, (msg) => {
-      this.logger("GET RECV", finalKey);
-
-      clearTimeout(cancelTimeout);
-      if (msg.type === "put") {
-        resolve(msg.data.v);
-      }
-    });
-
-    this.store
-      .get(finalKey)
-      .then((data) => {
-        try {
-          const parsed = JSON.parse(data);
-          const val = parsed.v;
-          clearTimeout(cancelTimeout);
-          this.removeIdListener(msgId);
-          this.emit("data", parsed);
-          resolve(val);
-        } catch (e) {
-          // do nothing
-        }
-      })
-      .catch((e) => {
-        // do nothing
-      });
-
-    // Do get
-    this.network.sendToAll({
-      type: "get",
-      to: [],
-      key: finalKey,
-      id: msgId,
-    });
-  });
-}
+import { ToolDb, textRandom } from ".";
+
+/**
+ * Triggers a GET request to other peers. If the data is available locally it will return that instead.
+ * @param key key of the data
+ * @param userNamespaced If this key bolongs to a user or its public. Making it private will enforce validation for our address and signatures.
+ * @param timeout Max time to wait for remote.
+ * @returns Promise<Data>
+ */
+export default function toolDbGet<T = any>(
+  this: ToolDb,
+  key: string,
+  userNamespaced = false,
+  timeoutMs = 1000,
+  to?: string[]
+): Promise<T | null> {
+  return new Promise((resolve, reject) => {
+    if (userNamespaced && this.userAccount.getAddress() === undefined) {
+      reject(new Error("You are not authorized yet!"));
+      return;
+    }
+    const finalKey = userNamespaced
+      ? `:${this.userAccount.getAddress()}.${key}`
+      : key;
+    this.logger("GET", finalKey);
+
+    const msgId = textRandom(10);
+
+    const cancelTimeout = setTimeout(() => {
+      this.store
+        .get(finalKey)
+        .then((data) => {
+          try {
+            const message = JSON.parse(data);
+            this.emit("data", message);
+            resolve(message.v);
+          } catch (e) {
+            resolve(null);
+          }
+        })
+        .catch((e) => {
+          resolve(null);
+        });
+    }, timeoutMs);
+
+    this.addIdListener(msgId, (msg) => {
+      this.logger("GET RECV", finalKey);
+
+      clearTimeout(cancelTimeout);
+      if (msg.type === "put") {
+        resolve(msg.data.v);
+      }
+    });
+
+    this.store
+      .get(finalKey)
+      .then((data) => {
+        try {
+          const parsed = JSON.parse(data);
+          const val = parsed.v;
+          clearTimeout(cancelTimeout);
+          this.removeIdListener(msgId);
+          this.emit("data", parsed);
+          resolve(val);
+        } catch (e) {
+          // do nothing
+        }
+      })
+      .catch((e) => {
+        // do nothing
+      });
+
+    // Do get
+    this.network.sendToAll({
+      type: "get",
+      to: to || [],
+      key: finalKey,
+      id: msgId,
+    });
+  });
+}

package/lib/toolDbKeysSignIn.ts

@@ -1,16 +1,16 @@
-import { ToolDb, randomAnimal } from ".";
-
-export default function toolDbKeysSignIn(
-  this: ToolDb,
-  privateKey: string,
-  username?: string
-): Promise<unknown> {
-  if (!this.userAccount) return Promise.resolve(undefined);
-
-  return this.userAccount
-    .getAccountFromPrivate(privateKey)
-    .then((newAccount) => {
-      this.userAccount.setUser(newAccount, username || randomAnimal());
-      return newAccount;
-    });
-}
+import { ToolDb, randomAnimal } from ".";
+
+export default function toolDbKeysSignIn(
+  this: ToolDb,
+  privateKey: string,
+  username?: string
+): Promise<unknown> {
+  if (!this.userAccount) return Promise.resolve(undefined);
+
+  return this.userAccount
+    .getAccountFromPrivate(privateKey)
+    .then((newAccount) => {
+      this.userAccount.setUser(newAccount, username || randomAnimal());
+      return newAccount;
+    });
+}

package/lib/toolDbPut.ts

@@ -1,83 +1,84 @@
-import {
-  ToolDb,
-  PutMessage,
-  textRandom,
-  VerificationData,
-  proofOfWork,
-} from ".";
-
-/**
- * Triggers a PUT request to other peers.
- * @param key key where we want to put the data at.
- * @param value Data we want to any (any type)
- * @param userNamespaced If this key bolongs to a user or its public. Making it private will enforce validation for our address and signatures.
- * @returns Promise<Data | null>
- */
-export default function toolDbPut<T = any>(
-  this: ToolDb,
-  key: string,
-  value: T,
-  userNamespaced = false
-): Promise<PutMessage<T> | null> {
-  return new Promise((resolve, reject) => {
-    if (key.includes(".")) {
-      // Dots are used as a delimitator character between bublic keys and the key of the user's data
-      reject(new Error(`Key cannot include dots!; ${key}`));
-      return;
-    }
-
-    if (!this.userAccount || !this.userAccount.getAddress()) {
-      reject(new Error("You need to log in before you can PUT."));
-      return;
-    }
-
-    const timestamp = new Date().getTime();
-    const dataString = `${JSON.stringify(
-      value
-    )}${this.userAccount.getAddress()}${timestamp}`;
-
-    // WORK
-    proofOfWork(dataString, this.options.pow)
-      .then(({ hash, nonce }) => {
-        this.userAccount.signData(hash).then((signature) => {
-          if (signature && this.userAccount.getAddress()) {
-            const finalKey = userNamespaced
-              ? `:${this.userAccount.getAddress()}.${key}`
-              : key;
-
-            // Compose the message
-            const data: VerificationData = {
-              k: finalKey,
-              a: this.userAccount.getAddress() || "",
-              n: nonce,
-              t: timestamp,
-              h: hash,
-              s: signature,
-              v: value,
-              c: null,
-            };
-
-            this.logger("PUT", key, data);
-
-            const finalMessage: PutMessage = {
-              type: "put",
-              id: textRandom(10),
-              to: [],
-              data,
-            };
-
-            this.network.sendToAll(finalMessage);
-            this.store
-              .put(finalKey, JSON.stringify(data))
-              .catch((e) => {
-                // do nothing
-              })
-              .finally(() => {
-                resolve(finalMessage);
-              });
-          }
-        });
-      })
-      .catch(reject);
-  });
-}
+import {
+  ToolDb,
+  PutMessage,
+  textRandom,
+  VerificationData,
+  proofOfWork,
+} from ".";
+
+/**
+ * Triggers a PUT request to other peers.
+ * @param key key where we want to put the data at.
+ * @param value Data we want to any (any type)
+ * @param userNamespaced If this key bolongs to a user or its public. Making it private will enforce validation for our address and signatures.
+ * @returns Promise<Data | null>
+ */
+export default function toolDbPut<T = any>(
+  this: ToolDb,
+  key: string,
+  value: T,
+  userNamespaced = false,
+  to?: string[]
+): Promise<PutMessage<T> | null> {
+  return new Promise((resolve, reject) => {
+    if (key.includes(".")) {
+      // Dots are used as a delimitator character between bublic keys and the key of the user's data
+      reject(new Error(`Key cannot include dots!; ${key}`));
+      return;
+    }
+
+    if (!this.userAccount || !this.userAccount.getAddress()) {
+      reject(new Error("You need to log in before you can PUT."));
+      return;
+    }
+
+    const timestamp = new Date().getTime();
+    const dataString = `${JSON.stringify(
+      value
+    )}${this.userAccount.getAddress()}${timestamp}`;
+
+    // WORK
+    proofOfWork(dataString, this.options.pow)
+      .then(({ hash, nonce }) => {
+        this.userAccount.signData(hash).then((signature) => {
+          if (signature && this.userAccount.getAddress()) {
+            const finalKey = userNamespaced
+              ? `:${this.userAccount.getAddress()}.${key}`
+              : key;
+
+            // Compose the message
+            const data: VerificationData = {
+              k: finalKey,
+              a: this.userAccount.getAddress() || "",
+              n: nonce,
+              t: timestamp,
+              h: hash,
+              s: signature,
+              v: value,
+              c: null,
+            };
+
+            this.logger("PUT", key, data);
+
+            const finalMessage: PutMessage = {
+              type: "put",
+              id: textRandom(10),
+              to: to || [],
+              data,
+            };
+
+            this.network.sendToAll(finalMessage);
+            this.store
+              .put(finalKey, JSON.stringify(data))
+              .catch((e) => {
+                // do nothing
+              })
+              .finally(() => {
+                resolve(finalMessage);
+              });
+          }
+        });
+      })
+      .catch(reject);
+  });
+}

package/lib/toolDbQueryKeys.ts

@@ -1,64 +1,65 @@
-import { ToolDb, textRandom, uniq } from ".";
-
-/**
- * Triggers a QUERY request to other peers.
- * @param key start of the key
- * @param userNamespaced If this key bolongs to a user or its public.
- * @returns Promise<Data>
- */
-export default function toolDbQueryKeys(
-  this: ToolDb,
-  key: string,
-  userNamespaced = false,
-  timeoutMs = 1000
-): Promise<string[] | null> {
-  const user = this.userAccount;
-
-  return new Promise((resolve, reject) => {
-    if (userNamespaced && user.getAddress() === undefined) {
-      reject(new Error("You are not authorized yet!"));
-      return;
-    }
-    const finalKey = userNamespaced ? `:${user.getAddress()}.${key}` : key;
-    this.logger("QUERY", finalKey);
-
-    const msgId = textRandom(10);
-    let foundKeys: string[] = [];
-    let timeout: NodeJS.Timeout | undefined;
-
-    this.store
-      .query(finalKey)
-      .then((localKeys) => {
-        foundKeys = [...foundKeys, ...localKeys];
-        timeout = setTimeout(finishListening, timeoutMs);
-      })
-      .catch((e) => {
-        // do nothing
-      });
-
-    const finishListening = () => {
-      resolve(uniq(foundKeys));
-    };
-
-    this.addIdListener(msgId, (msg) => {
-      this.logger("QUERY RECV", finalKey);
-
-      if (msg.type === "queryAck") {
-        foundKeys = [...foundKeys, ...msg.keys];
-
-        if (timeout) {
-          clearTimeout(timeout);
-        }
-        timeout = setTimeout(finishListening, timeoutMs);
-      }
-    });
-
-    // Do get
-    this.network.sendToAll({
-      type: "query",
-      to: [],
-      key: finalKey,
-      id: msgId,
-    });
-  });
-}
+import { ToolDb, textRandom, uniq } from ".";
+
+/**
+ * Triggers a QUERY request to other peers.
+ * @param key start of the key
+ * @param userNamespaced If this key bolongs to a user or its public.
+ * @returns Promise<Data>
+ */
+export default function toolDbQueryKeys(
+  this: ToolDb,
+  key: string,
+  userNamespaced = false,
+  timeoutMs = 1000,
+  to?: string[]
+): Promise<string[] | null> {
+  const user = this.userAccount;
+
+  return new Promise((resolve, reject) => {
+    if (userNamespaced && user.getAddress() === undefined) {
+      reject(new Error("You are not authorized yet!"));
+      return;
+    }
+    const finalKey = userNamespaced ? `:${user.getAddress()}.${key}` : key;
+    this.logger("QUERY", finalKey);
+
+    const msgId = textRandom(10);
+    let foundKeys: string[] = [];
+    let timeout: NodeJS.Timeout | undefined;
+
+    this.store
+      .query(finalKey)
+      .then((localKeys) => {
+        foundKeys = [...foundKeys, ...localKeys];
+        timeout = setTimeout(finishListening, timeoutMs);
+      })
+      .catch((e) => {
+        // do nothing
+      });
+
+    const finishListening = () => {
+      resolve(uniq(foundKeys));
+    };
+
+    this.addIdListener(msgId, (msg) => {
+      this.logger("QUERY RECV", finalKey);
+
+      if (msg.type === "queryAck") {
+        foundKeys = [...foundKeys, ...msg.keys];
+
+        if (timeout) {
+          clearTimeout(timeout);
+        }
+        timeout = setTimeout(finishListening, timeoutMs);
+      }
+    });
+
+    // Do get
+    this.network.sendToAll({
+      type: "query",
+      to: to || [],
+      key: finalKey,
+      id: msgId,
+    });
+  });
+}

package/lib/toolDbSignIn.ts

@@ -1,31 +1,32 @@
-import { ToolDb, sha256, randomAnimal } from ".";
-
-export default function toolDbSignIn(
-  this: ToolDb,
-  user: string,
-  password: string
-): Promise<unknown | undefined> {
-  return new Promise((resolve, reject) => {
-    this.getData<unknown>(`==${user}`, false, 5000).then((_user) => {
-      if (!_user) {
-        reject("Could not find user");
-        return;
-      }
-
-      try {
-        this.userAccount
-          .decryptAccount(_user, sha256(password))
-          .then((newAccount) => {
-            this.userAccount.setUser(
-              newAccount,
-              user || `Anonymous ${randomAnimal()}`
-            );
-
-            resolve(_user);
-          });
-      } catch (e) {
-        reject(e);
-      }
-    });
-  });
-}
+import { ToolDb, sha256, randomAnimal } from ".";
+
+export default function toolDbSignIn(
+  this: ToolDb,
+  user: string,
+  password: string,
+  to?: string[]
+): Promise<unknown | undefined> {
+  return new Promise((resolve, reject) => {
+    this.getData<unknown>(`==${user}`, false, 5000, to).then((_user) => {
+      if (!_user) {
+        reject("Could not find user");
+        return;
+      }
+
+      try {
+        this.userAccount
+          .decryptAccount(_user, sha256(password))
+          .then((newAccount) => {
+            this.userAccount.setUser(
+              newAccount,
+              user || `Anonymous ${randomAnimal()}`
+            );
+
+            resolve(_user);
+          });
+      } catch (e) {
+        reject(e);
+      }
+    });
+  });
+}