tool-db 2.5.4 → 2.5.6

package/lib/types/message.ts

@@ -1,4 +1,9 @@
-import { Peer } from "..";
+import {
+  AllowedFunctionArguments,
+  AllowedFunctionReturn,
+  FunctionCodes,
+  Peer,
+} from "..";
 
 export enum VerifyResult {
   CustomVerificationFailed = "CustomVerificationFailed",
@@ -53,6 +58,8 @@ export type MessageType =
   | "pong"
   | "query"
   | "queryAck"
+  | "function"
+  | "functionReturn"
   | "subscribe"
   | "get"
   | "put"
@@ -96,6 +103,18 @@ export interface QueryAckMessage extends BaseMessage {
   keys: string[];
 }
 
+export interface FunctionMessage extends BaseMessage {
+  type: "function";
+  function: string;
+  args: AllowedFunctionArguments<any>;
+}
+
+export interface FunctionReturnMessage extends BaseMessage {
+  type: "functionReturn";
+  code: FunctionCodes;
+  return: AllowedFunctionReturn<any>;
+}
+
 export interface SubscribeMessage extends BaseMessage {
   type: "subscribe";
   key: string;
@@ -126,6 +145,8 @@ export type ToolDbMessage =
   | PongMessage
   | QueryMessage
   | QueryAckMessage
+  | FunctionMessage
+  | FunctionReturnMessage
   | SubscribeMessage
   | GetMessage
   | PutMessage

package/lib/types/tooldb.ts

@@ -93,5 +93,47 @@ export interface ToolDbOptions {
    * The name of the server (works like a domain)
    */
   serverName: string | undefined;
-  // [extra: string]: any;
+  /*
+   * Used only for modules extra options
+   * Ideally should be uesd as an internal key within
+   * like "db.options.hybrid.url" to avoid conflicts between modules using the same keys
+   */
+  modules: {
+    [module: string]: any;
+  };
 }
+
+export type GenericObject = { [key: string]: any };
+
+export type AllowedFunctionArguments<A = GenericObject> = A;
+
+export type AllowedFunctionReturn<R = unknown> = R;
+
+export type FunctionCodes = "OK" | "ERR" | "NOT_FOUND";
+
+export type ServerFunction<R, A = GenericObject> = (
+  args: AllowedFunctionArguments<A>
+) => Promise<AllowedFunctionReturn<R>>;
+
+export interface FunctionReturnBase {
+  code: FunctionCodes;
+}
+export interface FunctionReturnOk<R> extends FunctionReturnBase {
+  return: AllowedFunctionReturn<R>;
+  code: "OK";
+}
+
+export interface FunctionReturnErr extends FunctionReturnBase {
+  return: string;
+  code: "ERR";
+}
+
+export interface FunctionReturnNotFound extends FunctionReturnBase {
+  return: string;
+  code: "NOT_FOUND";
+}
+
+export type FunctionReturn<R> =
+  | FunctionReturnOk<R>
+  | FunctionReturnErr
+  | FunctionReturnNotFound;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tool-db",
-  "version": "2.5.4",
+  "version": "2.5.6",
   "description": "A decentralized database model for federated p2p networks.n",
   "author": "Manwe <manuel.etchegaray7@gmail.com>",
   "homepage": "https://github.com/Manwe-777/tool-db#readme",
@@ -28,5 +28,5 @@
     "typescript": "^4.7.4",
     "uglify-js": "^3.16.2"
   },
-  "gitHead": "9497db7d2c5e79edc056f0bb1f2fcf21264b7654"
+  "gitHead": "ca8b876dcf1e78ad92d9369961d7479e07df0954"
 }