tool-db 2.5.3 → 2.5.4

package/lib/types/message.ts

@@ -1,133 +1,133 @@
-import { Peer } from "..";
-
-export enum VerifyResult {
-  CustomVerificationFailed = "CustomVerificationFailed",
-  InvalidData = "InvalidData",
-  InvalidVerification = "InvalidVerification",
-  CantOverwrite = "CantOverwrite",
-  InvalidTimestamp = "InvalidTimestamp",
-  AddressMismatch = "AddressMismatch",
-  NoProofOfWork = "NoProofOfWork",
-  InvalidHashNonce = "InvalidHashNonce",
-  InvalidSignature = "InvalidSignature",
-  Verified = "Verified",
-}
-
-export interface VerificationData<T = any> {
-  /**
-   * Key/id
-   */
-  k: string;
-  /**
-   * Address
-   */
-  a: string;
-  /**
-   * Nonce
-   */
-  n: number;
-  /**
-   * Hash of JSON.stringify(value) + nonce
-   */
-  h: string;
-  /**
-   * Timestamp this was created
-   */
-  t: number;
-  /**
-   * Signature
-   */
-  s: string;
-  /**
-   * Value
-   */
-  v: T;
-  /**
-   * CRDT type (null for regular values)
-   */
-  c: string | null;
-}
-
-export type MessageType =
-  | "ping"
-  | "pong"
-  | "query"
-  | "queryAck"
-  | "subscribe"
-  | "get"
-  | "put"
-  | "crdtPut"
-  | "crdtGet"
-  | "crdt";
-
-export interface BaseMessage {
-  type: MessageType;
-  /**
-   * Unique random id for the message, to ack back
-   */
-  id: string;
-  /**
-   * Who was this message sent to already
-   */
-  to: string[];
-}
-
-export interface PingMessage extends BaseMessage {
-  type: "ping";
-  isServer: boolean;
-  clientId: string;
-  peer: Peer;
-}
-
-export interface PongMessage extends BaseMessage {
-  type: "pong";
-  isServer: boolean;
-  clientId: string;
-  servers: Peer[];
-}
-
-export interface QueryMessage extends BaseMessage {
-  type: "query";
-  key: string; // key we want to get
-}
-
-export interface QueryAckMessage extends BaseMessage {
-  type: "queryAck";
-  keys: string[];
-}
-
-export interface SubscribeMessage extends BaseMessage {
-  type: "subscribe";
-  key: string;
-}
-
-export interface GetMessage extends BaseMessage {
-  type: "get";
-  key: string; // key we want to get
-}
-
-export interface PutMessage<T = any> extends BaseMessage {
-  type: "put";
-  data: VerificationData<T>;
-}
-
-export interface CrdtPutMessage<T = any> extends BaseMessage {
-  type: "crdtPut";
-  data: VerificationData<T>;
-}
-
-export interface CrdtGetMessage<T = any> extends BaseMessage {
-  type: "crdtGet";
-  key: string;
-}
-
-export type ToolDbMessage =
-  | PingMessage
-  | PongMessage
-  | QueryMessage
-  | QueryAckMessage
-  | SubscribeMessage
-  | GetMessage
-  | PutMessage
-  | CrdtPutMessage
-  | CrdtGetMessage;
+import { Peer } from "..";
+
+export enum VerifyResult {
+  CustomVerificationFailed = "CustomVerificationFailed",
+  InvalidData = "InvalidData",
+  InvalidVerification = "InvalidVerification",
+  CantOverwrite = "CantOverwrite",
+  InvalidTimestamp = "InvalidTimestamp",
+  AddressMismatch = "AddressMismatch",
+  NoProofOfWork = "NoProofOfWork",
+  InvalidHashNonce = "InvalidHashNonce",
+  InvalidSignature = "InvalidSignature",
+  Verified = "Verified",
+}
+
+export interface VerificationData<T = any> {
+  /**
+   * Key/id
+   */
+  k: string;
+  /**
+   * Address
+   */
+  a: string;
+  /**
+   * Nonce
+   */
+  n: number;
+  /**
+   * Hash of JSON.stringify(value) + nonce
+   */
+  h: string;
+  /**
+   * Timestamp this was created
+   */
+  t: number;
+  /**
+   * Signature
+   */
+  s: string;
+  /**
+   * Value
+   */
+  v: T;
+  /**
+   * CRDT type (null for regular values)
+   */
+  c: string | null;
+}
+
+export type MessageType =
+  | "ping"
+  | "pong"
+  | "query"
+  | "queryAck"
+  | "subscribe"
+  | "get"
+  | "put"
+  | "crdtPut"
+  | "crdtGet"
+  | "crdt";
+
+export interface BaseMessage {
+  type: MessageType;
+  /**
+   * Unique random id for the message, to ack back
+   */
+  id: string;
+  /**
+   * Who was this message sent to already
+   */
+  to: string[];
+}
+
+export interface PingMessage extends BaseMessage {
+  type: "ping";
+  isServer: boolean;
+  clientId: string;
+  peer: Peer;
+}
+
+export interface PongMessage extends BaseMessage {
+  type: "pong";
+  isServer: boolean;
+  clientId: string;
+  servers: Peer[];
+}
+
+export interface QueryMessage extends BaseMessage {
+  type: "query";
+  key: string; // key we want to get
+}
+
+export interface QueryAckMessage extends BaseMessage {
+  type: "queryAck";
+  keys: string[];
+}
+
+export interface SubscribeMessage extends BaseMessage {
+  type: "subscribe";
+  key: string;
+}
+
+export interface GetMessage extends BaseMessage {
+  type: "get";
+  key: string; // key we want to get
+}
+
+export interface PutMessage<T = any> extends BaseMessage {
+  type: "put";
+  data: VerificationData<T>;
+}
+
+export interface CrdtPutMessage<T = any> extends BaseMessage {
+  type: "crdtPut";
+  data: VerificationData<T>;
+}
+
+export interface CrdtGetMessage<T = any> extends BaseMessage {
+  type: "crdtGet";
+  key: string;
+}
+
+export type ToolDbMessage =
+  | PingMessage
+  | PongMessage
+  | QueryMessage
+  | QueryAckMessage
+  | SubscribeMessage
+  | GetMessage
+  | PutMessage
+  | CrdtPutMessage
+  | CrdtGetMessage;

package/lib/types/tooldb.ts

@@ -1,97 +1,97 @@
-import { Server as HTTPServer } from "http";
-import { Server as HTTPSServer } from "https";
-
-import {
-  ToolDb,
-  ToolDbMessage,
-  ToolDbNetworkAdapter,
-  ToolDbStorageAdapter,
-  ToolDbUserAdapter,
-} from "..";
-
-export interface Peer {
-  topic: string;
-  timestamp: number;
-  host: string;
-  port: number;
-  address: string;
-  sig: string;
-}
-
-export type ToolDbMessageHandler = (
-  this: ToolDb,
-  message: ToolDbMessage,
-  remotePeerId: string
-) => void;
-
-export interface ToolDbOptions {
-  /**
-   * Show debug console logs
-   */
-  debug: boolean;
-  /**
-   * Array of peers to connect to
-   */
-  peers: { host: string; port: number }[];
-  /**
-   * Max number of tries when a connection fails
-   */
-  maxRetries: number;
-  /**
-   * How long to wait (max) for a debounced key listener recv
-   */
-  triggerDebouce: number;
-  /**
-   * How long to wait between retries
-   */
-  wait: number;
-  /**
-   * Port to listen incoming connections (server only)
-   */
-  pow: number;
-  /**
-   * Whether we are a server or not
-   */
-  server: boolean;
-  /**
-   * A server instance like Express (server only)
-   */
-  httpServer: HTTPServer | HTTPSServer | undefined;
-  /**
-   * Our hostname (server only)
-   */
-  host: string;
-  /**
-   * Port to listen incoming connections (server only, default is 8080)
-   */
-  port: number;
-  /**
-   * If we are listening over SSL or not
-   */
-  ssl: boolean;
-  /**
-   * Our storage namespace (default is "tooldb")
-   */
-  storageName: string;
-  /**
-   * A custom network adapter class
-   */
-  networkAdapter: typeof ToolDbNetworkAdapter;
-  /**
-   * A custom storage adapter function
-   */
-  storageAdapter: typeof ToolDbStorageAdapter;
-  /**
-   * A custom user storage and validation adapter class
-   */
-  userAdapter: typeof ToolDbUserAdapter;
-  /**
-   * The namespace/topic of our app (default is "tool-db-default")
-   */
-  topic: string;
-  /*
-   * The name of the server (works like a domain)
-   */
-  serverName: string | undefined;
-  // [extra: string]: any;
-}
+import { Server as HTTPServer } from "http";
+import { Server as HTTPSServer } from "https";
+
+import {
+  ToolDb,
+  ToolDbMessage,
+  ToolDbNetworkAdapter,
+  ToolDbStorageAdapter,
+  ToolDbUserAdapter,
+} from "..";
+
+export interface Peer {
+  topic: string;
+  timestamp: number;
+  host: string;
+  port: number;
+  address: string;
+  sig: string;
+}
+
+export type ToolDbMessageHandler = (
+  this: ToolDb,
+  message: ToolDbMessage,
+  remotePeerId: string
+) => void;
+
+export interface ToolDbOptions {
+  /**
+   * Show debug console logs
+   */
+  debug: boolean;
+  /**
+   * Array of peers to connect to
+   */
+  peers: { host: string; port: number }[];
+  /**
+   * Max number of tries when a connection fails
+   */
+  maxRetries: number;
+  /**
+   * How long to wait (max) for a debounced key listener recv
+   */
+  triggerDebouce: number;
+  /**
+   * How long to wait between retries
+   */
+  wait: number;
+  /**
+   * Port to listen incoming connections (server only)
+   */
+  pow: number;
+  /**
+   * Whether we are a server or not
+   */
+  server: boolean;
+  /**
+   * A server instance like Express (server only)
+   */
+  httpServer: HTTPServer | HTTPSServer | undefined;
+  /**
+   * Our hostname (server only)
+   */
+  host: string;
+  /**
+   * Port to listen incoming connections (server only, default is 8080)
+   */
+  port: number;
+  /**
+   * If we are listening over SSL or not
+   */
+  ssl: boolean;
+  /**
+   * Our storage namespace (default is "tooldb")
+   */
+  storageName: string;
+  /**
+   * A custom network adapter class
+   */
+  networkAdapter: typeof ToolDbNetworkAdapter;
+  /**
+   * A custom storage adapter function
+   */
+  storageAdapter: typeof ToolDbStorageAdapter;
+  /**
+   * A custom user storage and validation adapter class
+   */
+  userAdapter: typeof ToolDbUserAdapter;
+  /**
+   * The namespace/topic of our app (default is "tool-db-default")
+   */
+  topic: string;
+  /*
+   * The name of the server (works like a domain)
+   */
+  serverName: string | undefined;
+  // [extra: string]: any;
+}

package/lib/utils/catchReturn.ts

@@ -1,4 +1,4 @@
-export default function catchReturn(arg: any) {
-  // console.error(arg);
-  return undefined;
-}
+export default function catchReturn(arg: any) {
+  // console.error(arg);
+  return undefined;
+}

package/lib/utils/encoding/arrayBufferToHex.ts

@@ -1,18 +1,18 @@
-export default function arrayBufferToHex(buffer: ArrayBuffer) {
-  const data_view = new DataView(buffer);
-  let iii;
-  let len;
-  let hex = "";
-  let c;
-
-  for (iii = 0, len = data_view.byteLength; iii < len; iii += 1) {
-    c = data_view.getUint8(iii).toString(16);
-    if (c.length < 2) {
-      c = "0" + c;
-    }
-
-    hex += c;
-  }
-
-  return hex.toLowerCase();
-}
+export default function arrayBufferToHex(buffer: ArrayBuffer) {
+  const data_view = new DataView(buffer);
+  let iii;
+  let len;
+  let hex = "";
+  let c;
+
+  for (iii = 0, len = data_view.byteLength; iii < len; iii += 1) {
+    c = data_view.getUint8(iii).toString(16);
+    if (c.length < 2) {
+      c = "0" + c;
+    }
+
+    hex += c;
+  }
+
+  return hex.toLowerCase();
+}

package/lib/utils/encoding/arrayBufferToString.ts

@@ -1,8 +1,8 @@
-export default function arrayBufferToString(arr: ArrayBuffer) {
-  const byteArray = new Uint8Array(arr);
-  let byteString = "";
-  for (let i = 0; i < byteArray.byteLength; i += 1) {
-    byteString += String.fromCodePoint(byteArray[i]);
-  }
-  return byteString;
-}
+export default function arrayBufferToString(arr: ArrayBuffer) {
+  const byteArray = new Uint8Array(arr);
+  let byteString = "";
+  for (let i = 0; i < byteArray.byteLength; i += 1) {
+    byteString += String.fromCodePoint(byteArray[i]);
+  }
+  return byteString;
+}

package/lib/utils/encoding/hexToArrayBuffer.ts

@@ -1,13 +1,13 @@
-export default function hexToArrayBuffer(hex: string): ArrayBuffer {
-  const pairs = hex.toUpperCase().match(/[\dA-F]{2}/gi);
-
-  if (!pairs) return new Uint8Array();
-
-  // convert the octets to integers
-  const integers = pairs.map((s) => {
-    return parseInt(s, 16);
-  });
-
-  const array = new Uint8Array(integers);
-  return array.buffer;
-}
+export default function hexToArrayBuffer(hex: string): ArrayBuffer {
+  const pairs = hex.toUpperCase().match(/[\dA-F]{2}/gi);
+
+  if (!pairs) return new Uint8Array();
+
+  // convert the octets to integers
+  const integers = pairs.map((s) => {
+    return parseInt(s, 16);
+  });
+
+  const array = new Uint8Array(integers);
+  return array.buffer;
+}

package/lib/utils/encoding/hexToString.ts

@@ -1,8 +1,8 @@
-export default function hexToString(hexString: string) {
-  const hex = hexString.toString();
-  let str = "";
-  for (let n = 0; n < hex.length; n += 2) {
-    str += String.fromCharCode(parseInt(hex.substr(n, 2), 16));
-  }
-  return str;
-}
+export default function hexToString(hexString: string) {
+  const hex = hexString.toString();
+  let str = "";
+  for (let n = 0; n < hex.length; n += 2) {
+    str += String.fromCharCode(parseInt(hex.substr(n, 2), 16));
+  }
+  return str;
+}

package/lib/utils/encoding/hexToUint8.ts

@@ -1,5 +1,5 @@
-import { hexToArrayBuffer } from "../..";
-
-export default function hexToUint8(hex: string) {
-  return new Uint8Array(hexToArrayBuffer(hex));
-}
+import { hexToArrayBuffer } from "../..";
+
+export default function hexToUint8(hex: string) {
+  return new Uint8Array(hexToArrayBuffer(hex));
+}

package/lib/utils/encoding/stringToArrayBuffer.ts

@@ -1,8 +1,8 @@
-export default function stringToArrayBuffer(str: string) {
-  const buf = new ArrayBuffer(str.length);
-  const bufView = new Uint8Array(buf);
-  for (let i = 0, strLen = str.length; i < strLen; i += 1) {
-    bufView[i] = str.charCodeAt(i);
-  }
-  return buf;
-}
+export default function stringToArrayBuffer(str: string) {
+  const buf = new ArrayBuffer(str.length);
+  const bufView = new Uint8Array(buf);
+  for (let i = 0, strLen = str.length; i < strLen; i += 1) {
+    bufView[i] = str.charCodeAt(i);
+  }
+  return buf;
+}

package/lib/utils/getPeerSignature.ts

@@ -1,12 +1,12 @@
-import { ToolDbUserAdapter, sha256 } from "..";
-
-export default function getPeerSignature(
-  account: ToolDbUserAdapter,
-  topic: string,
-  timestamp: number,
-  host: string,
-  port: number
-) {
-  const dataToSign = sha256(`${topic}-${timestamp}-${host}:${port}`);
-  return account.signData(dataToSign);
-}
+import { ToolDbUserAdapter, sha256 } from "..";
+
+export default function getPeerSignature(
+  account: ToolDbUserAdapter,
+  topic: string,
+  timestamp: number,
+  host: string,
+  port: number
+) {
+  const dataToSign = sha256(`${topic}-${timestamp}-${host}:${port}`);
+  return account.signData(dataToSign);
+}

package/lib/utils/getTimestamp.ts

@@ -1,3 +1,3 @@
-export default function getTimestamp() {
-  return new Date().getTime();
-}
+export default function getTimestamp() {
+  return new Date().getTime();
+}

package/lib/utils/proofOfWork.ts

@@ -1,16 +1,16 @@
-import { sha256 } from "..";
-
-export default function proofOfWork(
-  value: string,
-  difficulty: number
-): Promise<{ nonce: number; hash: string }> {
-  return new Promise((resolve) => {
-    let nonce = 0;
-    let hash = sha256(`${value}${nonce}`);
-    while (hash.substring(0, difficulty) !== Array(difficulty + 1).join("0")) {
-      nonce += 1;
-      hash = sha256(`${value}${nonce}`);
-    }
-    resolve({ nonce, hash });
-  });
-}
+import { sha256 } from "..";
+
+export default function proofOfWork(
+  value: string,
+  difficulty: number
+): Promise<{ nonce: number; hash: string }> {
+  return new Promise((resolve) => {
+    let nonce = 0;
+    let hash = sha256(`${value}${nonce}`);
+    while (hash.substring(0, difficulty) !== Array(difficulty + 1).join("0")) {
+      nonce += 1;
+      hash = sha256(`${value}${nonce}`);
+    }
+    resolve({ nonce, hash });
+  });
+}