tool-db 2.6.2 → 2.6.6

package/lib/toolDbCrdtPut.ts

@@ -1,78 +0,0 @@
-import {
-  ToolDb,
-  CrdtPutMessage,
-  textRandom,
-  VerificationData,
-  proofOfWork,
-  BaseCrdt,
-} 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 toolDbCrdtPut<T = any>(
-  this: ToolDb,
-  key: string,
-  crdt: BaseCrdt<T, any, any>,
-  userNamespaced = false,
-  to?: string[]
-): Promise<CrdtPutMessage | 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.getAddress()) {
-      reject(new Error("You need to log in before you can PUT."));
-      return;
-    }
-
-    const timestamp = new Date().getTime();
-
-    const crdtChanges = crdt.getChanges();
-
-    const encodedData = JSON.stringify(crdtChanges);
-
-    const dataString = `${encodedData}${this.userAccount.getAddress()}${timestamp}`;
-
-    // WORK
-    proofOfWork(dataString, this.options.pow)
-      .then(({ hash, nonce }) => {
-        this.userAccount.signData(hash).then((signature) => {
-          if (signature && this.userAccount.getAddress()) {
-            // Compose the message
-            const data: VerificationData<any> = {
-              k: userNamespaced
-                ? `:${this.userAccount.getAddress()}.${key}`
-                : key,
-              a: this.userAccount.getAddress() || "",
-              n: nonce,
-              t: timestamp,
-              h: hash,
-              s: signature,
-              v: crdtChanges,
-              c: crdt.type,
-            };
-
-            this.logger("PUT CRDT", key, data);
-
-            const finalMessage: CrdtPutMessage<any> = {
-              type: "crdtPut",
-              id: textRandom(10),
-              to: to || [],
-              data,
-            };
-            this.network.sendToAll(finalMessage);
-            resolve(finalMessage);
-          }
-        });
-      })
-      .catch(reject);
-  });
-}

package/lib/toolDbFunction.ts

@@ -1,49 +0,0 @@
-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,81 +0,0 @@
-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,13 +0,0 @@
-import { ToolDb, randomAnimal } from ".";
-
-export default async function toolDbKeysSignIn(
-  this: ToolDb,
-  privateKey: string,
-  username?: string
-): Promise<unknown> {
-  if (!this.userAccount) return Promise.resolve(undefined);
-
-  const newAccount = await this.userAccount.getAccountFromPrivate(privateKey);
-  await this.userAccount.setUser(newAccount, username || randomAnimal());
-  return newAccount;
-}

package/lib/toolDbPut.ts

@@ -1,84 +0,0 @@
-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,71 +0,0 @@
-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;
-
-    let gotLocalKeys = false;
-
-    this.store
-      .query(finalKey)
-      .then((localKeys) => {
-        foundKeys = [...foundKeys, ...localKeys];
-        gotLocalKeys = true;
-        timeout = setTimeout(finishListening, timeoutMs);
-      })
-      .catch((e) => {
-        gotLocalKeys = true;
-        timeout = setTimeout(finishListening, timeoutMs);
-      });
-
-    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);
-        }
-        if (gotLocalKeys) {
-          timeout = setTimeout(finishListening, timeoutMs);
-        }
-      }
-    });
-
-    // Do get
-    this.network.sendToAll({
-      type: "query",
-      to: to || [],
-      key: finalKey,
-      id: msgId,
-    });
-  });
-}

package/lib/toolDbSignIn.ts

@@ -1,37 +0,0 @@
-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, 2000, to).then((_user) => {
-      if (!_user) {
-        reject("Could not find user");
-        return;
-      }
-
-      try {
-        this.userAccount
-          .decryptAccount(_user, sha256(password))
-          .then(async (newAccount) => {
-            await this.userAccount.setUser(
-              newAccount,
-              user || `Anonymous ${randomAnimal()}`
-            );
-
-            resolve(_user);
-          })
-          .catch((e) => {
-            reject(e);
-          });
-      } catch (e) {
-        reject(e);
-      }
-    }).catch((e) => {
-      reject(e);
-    });
-  });
-}

package/lib/toolDbSignUp.ts

@@ -1,72 +0,0 @@
-import {
-  ToolDb,
-  PutMessage,
-  textRandom,
-  VerificationData,
-  proofOfWork,
-  sha256,
-} from ".";
-
-export default async function toolDbSignUp(
-  this: ToolDb,
-  user: string,
-  password: string,
-  to?: string[]
-): Promise<PutMessage<any>> {
-  const userRoot = `==${user}`;
-  return new Promise((resolve, reject) => {
-    this.getData(userRoot, false, 3000, to)
-      .then((data) => {
-        if (data === null) {
-          const account = new this.options.userAdapter(this);
-          account.encryptAccount(sha256(password)).then((userData) => {
-            const timestamp = new Date().getTime();
-            const userDataString = `${JSON.stringify(
-              userData
-            )}${account.getAddress()}${timestamp}`;
-
-            proofOfWork(userDataString, this.options.pow)
-              .then(({ hash, nonce }) => {
-                account.signData(hash).then((signature) => {
-                  const signupMessage: VerificationData = {
-                    k: userRoot,
-                    a: account.getAddress() || "",
-                    n: nonce,
-                    t: timestamp,
-                    h: hash,
-                    s: signature,
-                    v: userData,
-                    c: null,
-                  };
-
-                  this.logger("SIGNUP PUT", userRoot, signupMessage);
-
-                  const finalMsg = {
-                    type: "put",
-                    id: textRandom(10),
-                    to: to || [],
-                    data: signupMessage,
-                  } as PutMessage;
-
-                  this.network.sendToAll(finalMsg);
-                  this.store
-                    .put(userRoot, JSON.stringify(signupMessage))
-                    .catch((e) => {
-                      // do nothing
-                    })
-                    .finally(() => {
-                      resolve(finalMsg);
-                    });
-                });
-              })
-              .catch(reject);
-          });
-        } else {
-          reject(new Error("User already exists!"));
-        }
-      })
-      .catch(() => {
-        reject(new Error("Could not fetch user"));
-      });
-  });
-}

package/lib/toolDbSubscribe.ts

@@ -1,54 +0,0 @@
-import { ToolDb, textRandom } from ".";
-
-/**
- * Subscribe to all PUT updates for this key.
- * @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.
- * @returns Promise<Data>
- */
-export default function toolDbSubscribe(
-  this: ToolDb,
-  key: string,
-  userNamespaced = false,
-  to?: string[]
-): Promise<void> {
-  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("SUBSCRIBE", finalKey);
-
-    const msgId = textRandom(10);
-
-    this.network.sendToAll({
-      type: "subscribe",
-      key: finalKey,
-      to: to || [],
-      id: msgId,
-    });
-
-    this.store
-      .get(finalKey)
-      .then((data) => {
-        try {
-          const message = JSON.parse(data);
-          this.triggerKeyListener(finalKey, message);
-        } catch (e) {
-          // do nothing
-        }
-      })
-      .catch((e) => {
-        // do nothing
-      })
-      .finally(() => {
-        resolve();
-      });
-  });
-}

package/lib/toolDbVerificationWrapper.ts

@@ -1,55 +0,0 @@
-import { ToolDb, VerificationData, VerifyResult } from ".";
-
-export default function toolDbVerificationWrapper(
-  this: ToolDb,
-  data: VerificationData<any>
-) {
-  // This wrapper function adds our custom verification functions to all messages.
-  return new Promise((resolve) => {
-    this.verifyMessage(data, this.options.pow).then(async (verified) => {
-      if (verified) {
-        let skipCustom = true;
-        this._customVerificator.forEach((listener) => {
-          if (listener && data.k && data.k.startsWith(listener.key)) {
-            skipCustom = false;
-
-            let previousData: any = undefined;
-            // Get the previously stored value of this key
-            this.store
-              .get(data.k)
-              .then((prev) => {
-                try {
-                  previousData = JSON.parse(prev);
-                } catch (e) {
-                  // do nothing
-                }
-              })
-              .catch((e) => {
-                // do nothing
-              })
-              .finally(() => {
-                listener
-                  .fn(data, previousData)
-                  .then((verified: boolean) => {
-                    if (verified) {
-                      resolve(VerifyResult.Verified);
-                    } else {
-                      resolve(VerifyResult.CustomVerificationFailed);
-                    }
-                  })
-                  .catch((e) => {
-                    resolve(VerifyResult.CustomVerificationFailed);
-                  });
-              });
-          }
-        });
-
-        if (skipCustom) {
-          resolve(verified);
-        }
-      } else {
-        resolve(VerifyResult.InvalidVerification);
-      }
-    });
-  });
-}