@xyo-network/module-abstract 2.92.10 → 2.93.0-rc.1

package/dist/node/index.cjs

@@ -31,6 +31,7 @@ __export(src_exports, {
   BaseEmitter: () => BaseEmitter,
   ModuleConfigQueryValidator: () => ModuleConfigQueryValidator,
   ModuleErrorBuilder: () => ModuleErrorBuilder,
+  ResolveHelper: () => ResolveHelper,
   SupportedQueryValidator: () => SupportedQueryValidator,
   isQuerySupportedByModule: () => isQuerySupportedByModule
 });
@@ -51,7 +52,7 @@ var import_boundwitness_builder = require("@xyo-network/boundwitness-builder");
 var import_boundwitness_wrapper3 = require("@xyo-network/boundwitness-wrapper");
 var import_config_payload_plugin = require("@xyo-network/config-payload-plugin");
 var import_manifest_model = require("@xyo-network/manifest-model");
-var import_module_model = require("@xyo-network/module-model");
+var import_module_model2 = require("@xyo-network/module-model");
 var import_module_resolver = require("@xyo-network/module-resolver");
 var import_payload_builder2 = require("@xyo-network/payload-builder");
 var import_query_payload_plugin = require("@xyo-network/query-payload-plugin");
@@ -252,27 +253,95 @@ var _SupportedQueryValidator = class _SupportedQueryValidator {
 __name(_SupportedQueryValidator, "SupportedQueryValidator");
 var SupportedQueryValidator = _SupportedQueryValidator;
 
+// src/ResolveHelper.ts
+var import_module_model = require("@xyo-network/module-model");
+var _ResolveHelper = class _ResolveHelper {
+  static async resolve(config, idOrFilter = "*", { required = "log", ...options } = {}) {
+    const { dead = false, upResolver, downResolver } = config;
+    const childOptions = {
+      ...options,
+      required: false
+    };
+    const direction = (options == null ? void 0 : options.direction) ?? "all";
+    const up = direction === "up" || direction === "all";
+    const down = direction === "down" || direction === "all";
+    let result;
+    if (idOrFilter === "*") {
+      if (dead) {
+        return [];
+      }
+      return [
+        ...down ? await downResolver.resolve("*", childOptions) : [],
+        ...up ? await upResolver.resolve("*", childOptions) : []
+      ].filter(import_module_model.duplicateModules);
+    } else {
+      switch (typeof idOrFilter) {
+        case "string": {
+          if (dead) {
+            return void 0;
+          }
+          result = (down ? await downResolver.resolve(idOrFilter, childOptions) : void 0) ?? (up ? await upResolver.resolve(idOrFilter, childOptions) : void 0);
+          break;
+        }
+        default: {
+          if (dead) {
+            return [];
+          }
+          const filter = idOrFilter;
+          result = [
+            ...down ? await downResolver.resolve(filter, childOptions) : [],
+            ...up ? await upResolver.resolve(filter, childOptions) : []
+          ].filter(import_module_model.duplicateModules);
+          break;
+        }
+      }
+    }
+    this.validateRequiredResolve(required, result, idOrFilter);
+    return result;
+  }
+  static validateRequiredResolve(required, result, idOrFilter, logger) {
+    if (required && (result === void 0 || Array.isArray(result) && result.length > 0)) {
+      switch (required) {
+        case "warn": {
+          logger == null ? void 0 : logger.warn("resolve failed", idOrFilter);
+          break;
+        }
+        case "log": {
+          logger == null ? void 0 : logger.log("resolve failed", idOrFilter);
+          break;
+        }
+        default: {
+          logger == null ? void 0 : logger.error("resolve failed", idOrFilter);
+          break;
+        }
+      }
+    }
+  }
+};
+__name(_ResolveHelper, "ResolveHelper");
+var ResolveHelper = _ResolveHelper;
+
 // src/AbstractModule.ts
 var _AbstractModule = class _AbstractModule extends BaseEmitter {
   downResolver = new import_module_resolver.CompositeModuleResolver();
   upResolver = new import_module_resolver.CompositeModuleResolver();
   _account = void 0;
   _baseModuleQueryAccountPaths = {
-    [import_module_model.ModuleAddressQuerySchema]: "1",
-    [import_module_model.ModuleDescribeQuerySchema]: "4",
-    [import_module_model.ModuleDiscoverQuerySchema]: "2",
-    [import_module_model.ModuleManifestQuerySchema]: "5",
-    [import_module_model.ModuleStateQuerySchema]: "6",
-    [import_module_model.ModuleSubscribeQuerySchema]: "3"
+    [import_module_model2.ModuleAddressQuerySchema]: "1",
+    [import_module_model2.ModuleDescribeQuerySchema]: "4",
+    [import_module_model2.ModuleDiscoverQuerySchema]: "2",
+    [import_module_model2.ModuleManifestQuerySchema]: "5",
+    [import_module_model2.ModuleStateQuerySchema]: "6",
+    [import_module_model2.ModuleSubscribeQuerySchema]: "3"
   };
   _lastError;
   _queryAccounts = {
-    [import_module_model.ModuleAddressQuerySchema]: void 0,
-    [import_module_model.ModuleDescribeQuerySchema]: void 0,
-    [import_module_model.ModuleDiscoverQuerySchema]: void 0,
-    [import_module_model.ModuleManifestQuerySchema]: void 0,
-    [import_module_model.ModuleStateQuerySchema]: void 0,
-    [import_module_model.ModuleSubscribeQuerySchema]: void 0
+    [import_module_model2.ModuleAddressQuerySchema]: void 0,
+    [import_module_model2.ModuleDescribeQuerySchema]: void 0,
+    [import_module_model2.ModuleDiscoverQuerySchema]: void 0,
+    [import_module_model2.ModuleManifestQuerySchema]: void 0,
+    [import_module_model2.ModuleStateQuerySchema]: void 0,
+    [import_module_model2.ModuleSubscribeQuerySchema]: void 0
   };
   _startPromise = void 0;
   _started = void 0;
@@ -317,12 +386,12 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
   }
   get queries() {
     return [
-      import_module_model.ModuleDiscoverQuerySchema,
-      import_module_model.ModuleAddressQuerySchema,
-      import_module_model.ModuleSubscribeQuerySchema,
-      import_module_model.ModuleDescribeQuerySchema,
-      import_module_model.ModuleManifestQuerySchema,
-      import_module_model.ModuleStateQuerySchema
+      import_module_model2.ModuleDiscoverQuerySchema,
+      import_module_model2.ModuleAddressQuerySchema,
+      import_module_model2.ModuleSubscribeQuerySchema,
+      import_module_model2.ModuleDescribeQuerySchema,
+      import_module_model2.ModuleManifestQuerySchema,
+      import_module_model2.ModuleStateQuerySchema
     ];
   }
   get queryAccountPaths() {
@@ -370,7 +439,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     if (!this.configSchemas || this.configSchemas.length === 0) {
       throw new Error(`Missing configSchema [${(_a = params == null ? void 0 : params.config) == null ? void 0 : _a.schema}][${this.name}]`);
     }
-    (0, import_assert2.assertEx)(((_b = params == null ? void 0 : params.config) == null ? void 0 : _b.name) === void 0 || (0, import_module_model.isModuleName)(params.config.name), () => {
+    (0, import_assert2.assertEx)(((_b = params == null ? void 0 : params.config) == null ? void 0 : _b.name) === void 0 || (0, import_module_model2.isModuleName)(params.config.name), () => {
       var _a2;
       return `Invalid module name: ${(_a2 = params == null ? void 0 : params.config) == null ? void 0 : _a2.name}`;
     });
@@ -403,7 +472,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     return await determineAccount(params, this.allowRandomAccount);
   }
   static factory(params) {
-    return import_module_model.ModuleFactory.withParams(this, params);
+    return import_module_model2.ModuleFactory.withParams(this, params);
   }
   _getRootFunction(funcName) {
     let anyThis = this;
@@ -502,47 +571,30 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     ];
     return validators.every((validator) => validator(query, payloads));
   }
-  async resolve(idOrFilter = "*", { required = "log", ...options } = {}) {
-    const childOptions = {
-      ...options,
-      required: false
-    };
-    const direction = (options == null ? void 0 : options.direction) ?? "all";
-    const up = direction === "up" || direction === "all";
-    const down = direction === "down" || direction === "all";
-    let result;
-    if (idOrFilter === "*") {
-      if (this.dead) {
-        return [];
+  async resolve(idOrFilter = "*", options = {}) {
+    switch (typeof idOrFilter) {
+      case "string": {
+        return await ResolveHelper.resolve({
+          dead: this.dead,
+          downResolver: this.downResolver,
+          upResolver: this.upResolver
+        }, idOrFilter, options);
       }
-      return [
-        ...down ? await this.downResolver.resolve("*", childOptions) : [],
-        ...up ? await this.upResolver.resolve("*", childOptions) : []
-      ].filter(import_module_model.duplicateModules);
-    } else {
-      switch (typeof idOrFilter) {
-        case "string": {
-          if (this.dead) {
-            return void 0;
-          }
-          result = (down ? await this.downResolver.resolve(idOrFilter, childOptions) : void 0) ?? (up ? await this.upResolver.resolve(idOrFilter, childOptions) : void 0);
-          break;
-        }
-        default: {
-          if (this.dead) {
-            return [];
-          }
-          const filter = idOrFilter;
-          result = [
-            ...down ? await this.downResolver.resolve(filter, childOptions) : [],
-            ...up ? await this.upResolver.resolve(filter, childOptions) : []
-          ].filter(import_module_model.duplicateModules);
-          break;
-        }
+      case "object": {
+        return await ResolveHelper.resolve({
+          dead: this.dead,
+          downResolver: this.downResolver,
+          upResolver: this.upResolver
+        }, idOrFilter, options);
+      }
+      default: {
+        return await ResolveHelper.resolve({
+          dead: this.dead,
+          downResolver: this.downResolver,
+          upResolver: this.upResolver
+        }, idOrFilter, options);
       }
     }
-    this.validateRequiredResolve(required, result, idOrFilter);
-    return result;
   }
   start(_timeout) {
     this._startPromise = this._startPromise ?? this.startHandler();
@@ -609,7 +661,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
   }
   _checkDead() {
     if (this.dead) {
-      throw new import_module_model.DeadModuleError(this.id, this._lastError);
+      throw new import_module_model2.DeadModuleError(this.id, this._lastError);
     }
   }
   _noOverride(functionName) {
@@ -670,7 +722,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     const description = {
       address: this.address,
       queries: this.queries,
-      schema: import_module_model.ModuleDescriptionSchema
+      schema: import_module_model2.ModuleDescriptionSchema
     };
     if ((_a = this.config) == null ? void 0 : _a.name) {
       description.name = this.config.name;
@@ -684,7 +736,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
   }
   async discoverHandler(_maxDepth) {
     var _a;
-    const config = this.config;
+    const config = await import_payload_builder2.PayloadBuilder.build(this.config);
     const address = await new import_payload_builder2.PayloadBuilder({
       schema: import_address_payload_plugin.AddressSchema
     }).fields({
@@ -698,10 +750,10 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
         query
       }).build();
     }));
-    const configSchema = {
+    const configSchema = await import_payload_builder2.PayloadBuilder.build({
       config: config.schema,
       schema: import_config_payload_plugin.ConfigSchema
-    };
+    });
     return (0, import_lodash.compact)([
       config,
       configSchema,
@@ -736,8 +788,18 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
       }
     }
   }
-  manifestHandler(_depth, _ignoreAddresses) {
+  async manifestHandler(_depth, _ignoreAddresses) {
     const name = this.config.name ?? "Anonymous";
+    const children = await this.downResolver.resolve("*", {
+      direction: "down",
+      maxDepth: 1
+    });
+    const childAddressToName = {};
+    for (const child of children) {
+      if (child.address !== this.address) {
+        childAddressToName[child.address] = child.config.name ?? null;
+      }
+    }
     return {
       config: {
         name,
@@ -745,7 +807,8 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
       },
       schema: import_manifest_model.ModuleManifestPayloadSchema,
       status: {
-        address: this.address
+        address: this.address,
+        children: childAddressToName
       }
     };
   }
@@ -764,7 +827,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
         {
           address: address2,
           previousHash: previousHash2,
-          schema: import_module_model.AddressPreviousHashSchema
+          schema: import_module_model2.AddressPreviousHashSchema
         }
       ];
     });
@@ -782,10 +845,10 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     const moduleAccountPreviousHash = previousHash ? {
       address,
       previousHash,
-      schema: import_module_model.AddressPreviousHashSchema
+      schema: import_module_model2.AddressPreviousHashSchema
     } : {
       address,
-      schema: import_module_model.AddressPreviousHashSchema
+      schema: import_module_model2.AddressPreviousHashSchema
     };
     return [
       moduleAccount,
@@ -800,28 +863,28 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     (0, import_assert2.assertEx)(await this.queryable(query, payloads, queryConfig));
     const resultPayloads = [];
     switch (queryPayload.schema) {
-      case import_module_model.ModuleManifestQuerySchema: {
+      case import_module_model2.ModuleManifestQuerySchema: {
         resultPayloads.push(await this.manifestHandler(queryPayload.maxDepth));
         break;
       }
-      case import_module_model.ModuleDiscoverQuerySchema: {
+      case import_module_model2.ModuleDiscoverQuerySchema: {
         const { maxDepth } = queryPayload;
         resultPayloads.push(...await this.discoverHandler(maxDepth));
         break;
       }
-      case import_module_model.ModuleDescribeQuerySchema: {
+      case import_module_model2.ModuleDescribeQuerySchema: {
         resultPayloads.push(await this.describeHandler());
         break;
       }
-      case import_module_model.ModuleAddressQuerySchema: {
+      case import_module_model2.ModuleAddressQuerySchema: {
         resultPayloads.push(...await this.moduleAddressHandler());
         break;
       }
-      case import_module_model.ModuleStateQuerySchema: {
+      case import_module_model2.ModuleStateQuerySchema: {
         resultPayloads.push(...await this.stateHandler());
         break;
       }
-      case import_module_model.ModuleSubscribeQuerySchema: {
+      case import_module_model2.ModuleSubscribeQuerySchema: {
         this.subscribeHandler();
         break;
       }
@@ -886,7 +949,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
               }, true) && valid
             );
           }
-          if (!(0, import_module_model.serializableField)(value)) {
+          if (!(0, import_module_model2.serializableField)(value)) {
             (_b = this.logger) == null ? void 0 : _b.warn(`Fields that are not serializable to JSON are not allowed in config [${parents == null ? void 0 : parents.join(".")}.${key}]`);
             return false;
           }
@@ -901,24 +964,6 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
       }
     }, true);
   }
-  validateRequiredResolve(required, result, idOrFilter) {
-    if (required && (result === void 0 || Array.isArray(result) && result.length > 0)) {
-      switch (required) {
-        case "warn": {
-          this.logger.warn("resolve failed", idOrFilter);
-          break;
-        }
-        case "log": {
-          this.logger.log("resolve failed", idOrFilter);
-          break;
-        }
-        default: {
-          this.logger.error("resolve failed", idOrFilter);
-          break;
-        }
-      }
-    }
-  }
 };
 __name(_AbstractModule, "AbstractModule");
 __publicField(_AbstractModule, "allowRandomAccount", true);
@@ -984,6 +1029,7 @@ var AbstractModuleInstance = _AbstractModuleInstance;
   BaseEmitter,
   ModuleConfigQueryValidator,
   ModuleErrorBuilder,
+  ResolveHelper,
   SupportedQueryValidator,
   isQuerySupportedByModule
 });