hypha-rpc 0.20.3 → 0.20.5

package/dist/hypha-rpc-websocket.js

@@ -24,8 +24,9 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   RPC: () => (/* binding */ RPC)
 /* harmony export */ });
 /* harmony import */ var _utils__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./utils */ "./src/utils/index.js");
-/* harmony import */ var _msgpack_msgpack__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! @msgpack/msgpack */ "./node_modules/@msgpack/msgpack/dist.es5+esm/decode.mjs");
-/* harmony import */ var _msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! @msgpack/msgpack */ "./node_modules/@msgpack/msgpack/dist.es5+esm/encode.mjs");
+/* harmony import */ var _utils_schema__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./utils/schema */ "./src/utils/schema.js");
+/* harmony import */ var _msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! @msgpack/msgpack */ "./node_modules/@msgpack/msgpack/dist.es5+esm/decode.mjs");
+/* harmony import */ var _msgpack_msgpack__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! @msgpack/msgpack */ "./node_modules/@msgpack/msgpack/dist.es5+esm/encode.mjs");
 /**
  * Contains the RPC object used both by the application
  * site, and by each plugin
@@ -34,6 +35,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
+
 const API_VERSION = "0.3.0";
 const CHUNK_SIZE = 1024 * 500;
 
@@ -82,8 +84,86 @@ function _get_schema(obj, name = null, skipContext = false) {
     } else {
       return { type: "function" };
     }
+  } else if (typeof obj === "number") {
+    return { type: "number" };
+  } else if (typeof obj === "string") {
+    return { type: "string" };
+  } else if (typeof obj === "boolean") {
+    return { type: "boolean" };
+  } else if (obj === null) {
+    return { type: "null" };
+  } else {
+    return {};
   }
-  return obj;
+}
+
+function _annotate_service(service, serviceTypeInfo) {
+  function validateKeys(serviceDict, schemaDict, path = "root") {
+    // Validate that all keys in schemaDict exist in serviceDict
+    for (let key in schemaDict) {
+      if (!serviceDict.hasOwnProperty(key)) {
+        throw new Error(`Missing key '${key}' in service at path '${path}'`);
+      }
+    }
+
+    // Check for any unexpected keys in serviceDict
+    for (let key in serviceDict) {
+      if (key !== "type" && !schemaDict.hasOwnProperty(key)) {
+        throw new Error(`Unexpected key '${key}' in service at path '${path}'`);
+      }
+    }
+  }
+
+  function annotateRecursive(newService, schemaInfo, path = "root") {
+    if (typeof newService === "object" && !Array.isArray(newService)) {
+      validateKeys(newService, schemaInfo, path);
+      for (let k in newService) {
+        let v = newService[k];
+        let newPath = `${path}.${k}`;
+        if (typeof v === "object" && !Array.isArray(v)) {
+          annotateRecursive(v, schemaInfo[k], newPath);
+        } else if (typeof v === "function") {
+          if (schemaInfo.hasOwnProperty(k)) {
+            newService[k] = (0,_utils_schema__WEBPACK_IMPORTED_MODULE_1__.schemaFunction)(v, {
+              name: schemaInfo[k]["name"],
+              description: schemaInfo[k].description || "",
+              parameters: schemaInfo[k]["parameters"],
+            });
+          } else {
+            throw new Error(
+              `Missing schema for function '${k}' at path '${newPath}'`,
+            );
+          }
+        }
+      }
+    } else if (Array.isArray(newService)) {
+      if (newService.length !== schemaInfo.length) {
+        throw new Error(`Length mismatch at path '${path}'`);
+      }
+      newService.forEach((v, i) => {
+        let newPath = `${path}[${i}]`;
+        if (typeof v === "object" && !Array.isArray(v)) {
+          annotateRecursive(v, schemaInfo[i], newPath);
+        } else if (typeof v === "function") {
+          if (schemaInfo.hasOwnProperty(i)) {
+            newService[i] = (0,_utils_schema__WEBPACK_IMPORTED_MODULE_1__.schemaFunction)(v, {
+              name: schemaInfo[i]["name"],
+              description: schemaInfo[i].description || "",
+              parameters: schemaInfo[i]["parameters"],
+            });
+          } else {
+            throw new Error(
+              `Missing schema for function at index ${i} in path '${newPath}'`,
+            );
+          }
+        }
+      });
+    }
+  }
+
+  validateKeys(service, serviceTypeInfo["definition"]);
+  annotateRecursive(service, serviceTypeInfo["definition"]);
+  return service;
 }
 
 function getFunctionInfo(func) {
@@ -377,7 +457,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
     }
     cache[key] = concatArrayBuffers(cache[key]);
     console.debug(`Processing message ${key} (bytes=${cache[key].byteLength})`);
-    let unpacker = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_1__.decodeMulti)(cache[key]);
+    let unpacker = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__.decodeMulti)(cache[key]);
     const { done, value } = unpacker.next();
     const main = value;
     // Make sure the fields are from trusted source
@@ -405,7 +485,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
       const main = JSON.parse(message);
       this._fire(main["type"], main);
     } else if (message instanceof ArrayBuffer) {
-      let unpacker = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_1__.decodeMulti)(message);
+      let unpacker = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__.decodeMulti)(message);
       const { done, value } = unpacker.next();
       const main = value;
       // Add trusted context to the method call
@@ -629,15 +709,36 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
 
   _extract_service_info(service) {
     const skipContext = service.config.require_context;
-    const serviceInfo = _get_schema(service, null, skipContext);
-    (serviceInfo.id = `${this._client_id}:${service["id"]}`),
-      (serviceInfo.description = service["description"] || ""),
-      (serviceInfo.app_id = this._app_id);
+    const serviceSchema = _get_schema(service, null, skipContext);
+    const serviceInfo = {
+      config: service.config,
+      id: `${this._client_id}:${service["id"]}`,
+      name: service.name || service["id"],
+      description: service.description || "",
+      type: service.type || "generic",
+      docs: service.docs || null,
+      app_id: this._app_id,
+      service_schema: serviceSchema,
+    };
     return serviceInfo;
   }
 
-  async register_service(api, overwrite, notify) {
-    if (notify === undefined) notify = true;
+  async get_service_schema(service) {
+    const skipContext = service.config.require_context;
+    return _get_schema(service, null, skipContext);
+  }
+
+  async register_service(api, overwrite, notify = true, check_type = false) {
+    if (check_type && api.type) {
+      try {
+        const manager_svc = await this.get_manager_service();
+        const type_info = await manager_svc.get_service_type(api.type);
+        api = _annotate_service(api, type_info);
+      } catch (e) {
+        throw new Error(`Failed to get service type ${api.type}, error: ${e}`);
+      }
+    }
+
     const service = this.add_service(api, overwrite);
     const serviceInfo = this._extract_service_info(service);
     if (notify) {
@@ -822,9 +923,9 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
       this._fire(main_message.type, main_message);
       return;
     }
-    let message_package = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__.encode)(main_message);
+    let message_package = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_3__.encode)(main_message);
     if (extra_data) {
-      const extra = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__.encode)(extra_data);
+      const extra = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_3__.encode)(extra_data);
       message_package = new Uint8Array([...message_package, ...extra]);
     }
     const total_size = message_package.length;
@@ -947,9 +1048,9 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
           );
         }
         // The message consists of two segments, the main message and extra data
-        let message_package = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__.encode)(main_message);
+        let message_package = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_3__.encode)(main_message);
         if (extra_data) {
-          const extra = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_2__.encode)(extra_data);
+          const extra = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_3__.encode)(extra_data);
           message_package = new Uint8Array([...message_package, ...extra]);
         }
         const total_size = message_package.length;
@@ -4868,6 +4969,21 @@ async function connectToServer(config) {
       type: "object",
     },
   });
+  wm.getServiceSchema = (0,_utils_schema_js__WEBPACK_IMPORTED_MODULE_2__.schemaFunction)(rpc.get_service_schema, {
+    name: "getServiceSchema",
+    description: "Get the service schema.",
+    parameters: {
+      properties: {
+        service: {
+          description: "The service to extract schema",
+          type: "object",
+        },
+      },
+      required: ["service"],
+      type: "object",
+    },
+  });
+
   wm.registerService = (0,_utils_schema_js__WEBPACK_IMPORTED_MODULE_2__.schemaFunction)(rpc.register_service.bind(rpc), {
     name: "registerService",
     description: "Register a service.",