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

package/dist/node/index.cjs

@@ -52,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_model2 = require("@xyo-network/module-model");
+var import_module_model = 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");
@@ -253,95 +253,27 @@ 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_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"
+    [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"
   };
   _lastError;
   _queryAccounts = {
-    [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
+    [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
   };
   _startPromise = void 0;
   _started = void 0;
@@ -372,6 +304,9 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     var _a;
     return !!((_a = this.config.security) == null ? void 0 : _a.allowAnonymous);
   }
+  get archiving() {
+    return this.config.archiving;
+  }
   get config() {
     return this.params.config;
   }
@@ -386,12 +321,12 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
   }
   get queries() {
     return [
-      import_module_model2.ModuleDiscoverQuerySchema,
-      import_module_model2.ModuleAddressQuerySchema,
-      import_module_model2.ModuleSubscribeQuerySchema,
-      import_module_model2.ModuleDescribeQuerySchema,
-      import_module_model2.ModuleManifestQuerySchema,
-      import_module_model2.ModuleStateQuerySchema
+      import_module_model.ModuleDiscoverQuerySchema,
+      import_module_model.ModuleAddressQuerySchema,
+      import_module_model.ModuleSubscribeQuerySchema,
+      import_module_model.ModuleDescribeQuerySchema,
+      import_module_model.ModuleManifestQuerySchema,
+      import_module_model.ModuleStateQuerySchema
     ];
   }
   get queryAccountPaths() {
@@ -439,7 +374,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_model2.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_model.isModuleName)(params.config.name), () => {
       var _a2;
       return `Invalid module name: ${(_a2 = params == null ? void 0 : params.config) == null ? void 0 : _a2.name}`;
     });
@@ -472,7 +407,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     return await determineAccount(params, this.allowRandomAccount);
   }
   static factory(params) {
-    return import_module_model2.ModuleFactory.withParams(this, params);
+    return import_module_model.ModuleFactory.withParams(this, params);
   }
   _getRootFunction(funcName) {
     let anyThis = this;
@@ -571,31 +506,6 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     ];
     return validators.every((validator) => validator(query, payloads));
   }
-  async resolve(idOrFilter = "*", options = {}) {
-    switch (typeof idOrFilter) {
-      case "string": {
-        return await ResolveHelper.resolve({
-          dead: this.dead,
-          downResolver: this.downResolver,
-          upResolver: this.upResolver
-        }, idOrFilter, options);
-      }
-      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);
-      }
-    }
-  }
   start(_timeout) {
     this._startPromise = this._startPromise ?? this.startHandler();
     const result = this._startPromise;
@@ -661,7 +571,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
   }
   _checkDead() {
     if (this.dead) {
-      throw new import_module_model2.DeadModuleError(this.id, this._lastError);
+      throw new import_module_model.DeadModuleError(this.id, this._lastError);
     }
   }
   _noOverride(functionName) {
@@ -712,7 +622,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
       await Promise.all(payloads.map((payload) => import_payload_builder2.PayloadBuilder.build(payload))),
       await Promise.all((_a = errors ?? []) == null ? void 0 : _a.map((error) => import_payload_builder2.PayloadBuilder.build(error)))
     ];
-    if (this.config.archiving) {
+    if (this.archiving) {
       await this.storeToArchivists(result.flat());
     }
     return result;
@@ -722,7 +632,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     const description = {
       address: this.address,
       queries: this.queries,
-      schema: import_module_model2.ModuleDescriptionSchema
+      schema: import_module_model.ModuleDescriptionSchema
     };
     if ((_a = this.config) == null ? void 0 : _a.name) {
       description.name = this.config.name;
@@ -788,11 +698,11 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
       }
     }
   }
-  async manifestHandler(_depth, _ignoreAddresses) {
+  async manifestHandler(maxDepth = 1, _ignoreAddresses = []) {
     const name = this.config.name ?? "Anonymous";
     const children = await this.downResolver.resolve("*", {
       direction: "down",
-      maxDepth: 1
+      maxDepth
     });
     const childAddressToName = {};
     for (const child of children) {
@@ -827,7 +737,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
         {
           address: address2,
           previousHash: previousHash2,
-          schema: import_module_model2.AddressPreviousHashSchema
+          schema: import_module_model.AddressPreviousHashSchema
         }
       ];
     });
@@ -845,10 +755,10 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     const moduleAccountPreviousHash = previousHash ? {
       address,
       previousHash,
-      schema: import_module_model2.AddressPreviousHashSchema
+      schema: import_module_model.AddressPreviousHashSchema
     } : {
       address,
-      schema: import_module_model2.AddressPreviousHashSchema
+      schema: import_module_model.AddressPreviousHashSchema
     };
     return [
       moduleAccount,
@@ -863,28 +773,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_model2.ModuleManifestQuerySchema: {
+      case import_module_model.ModuleManifestQuerySchema: {
         resultPayloads.push(await this.manifestHandler(queryPayload.maxDepth));
         break;
       }
-      case import_module_model2.ModuleDiscoverQuerySchema: {
+      case import_module_model.ModuleDiscoverQuerySchema: {
         const { maxDepth } = queryPayload;
         resultPayloads.push(...await this.discoverHandler(maxDepth));
         break;
       }
-      case import_module_model2.ModuleDescribeQuerySchema: {
+      case import_module_model.ModuleDescribeQuerySchema: {
         resultPayloads.push(await this.describeHandler());
         break;
       }
-      case import_module_model2.ModuleAddressQuerySchema: {
+      case import_module_model.ModuleAddressQuerySchema: {
         resultPayloads.push(...await this.moduleAddressHandler());
         break;
       }
-      case import_module_model2.ModuleStateQuerySchema: {
+      case import_module_model.ModuleStateQuerySchema: {
         resultPayloads.push(...await this.stateHandler());
         break;
       }
-      case import_module_model2.ModuleSubscribeQuerySchema: {
+      case import_module_model.ModuleSubscribeQuerySchema: {
         this.subscribeHandler();
         break;
       }
@@ -894,14 +804,6 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     }
     return resultPayloads;
   }
-  async resolveArchivingArchivists() {
-    var _a;
-    const archivists = (_a = this.config.archiving) == null ? void 0 : _a.archivists;
-    if (!archivists)
-      return [];
-    const resolved = await Promise.all(archivists.map((archivist) => this.resolve(archivist)));
-    return (0, import_lodash.compact)(resolved.map((mod) => (0, import_archivist_model.asArchivistInstance)(mod)));
-  }
   async startHandler() {
     this.validateConfig();
     await this.initializeQueryAccounts();
@@ -919,13 +821,6 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
     this._started = void 0;
     return true;
   }
-  async storeToArchivists(payloads) {
-    const archivists = await this.resolveArchivingArchivists();
-    return (await Promise.all(archivists.map((archivist) => {
-      var _a;
-      return (_a = archivist.insert) == null ? void 0 : _a.call(archivist, payloads);
-    }))).map(([bw]) => bw);
-  }
   subscribeHandler() {
     return;
   }
@@ -949,7 +844,7 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
               }, true) && valid
             );
           }
-          if (!(0, import_module_model2.serializableField)(value)) {
+          if (!(0, import_module_model.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;
           }
@@ -968,13 +863,107 @@ var _AbstractModule = class _AbstractModule extends BaseEmitter {
 __name(_AbstractModule, "AbstractModule");
 __publicField(_AbstractModule, "allowRandomAccount", true);
 __publicField(_AbstractModule, "configSchemas");
-__publicField(_AbstractModule, "defaultLogger", new import_logger.ConsoleLogger(import_logger.LogLevel.log));
+__publicField(_AbstractModule, "defaultLogger", new import_logger.ConsoleLogger(import_logger.LogLevel.warn));
 __publicField(_AbstractModule, "enableLazyLoad", false);
 __publicField(_AbstractModule, "privateConstructorKey", Date.now().toString());
 var AbstractModule = _AbstractModule;
 
 // src/AbstractModuleInstance.ts
 var import_assert3 = require("@xylabs/assert");
+var import_lodash2 = require("@xylabs/lodash");
+var import_archivist_model2 = require("@xyo-network/archivist-model");
+
+// src/ResolveHelper.ts
+var import_logger2 = require("@xylabs/logger");
+var import_object3 = require("@xylabs/object");
+var import_module_model2 = require("@xyo-network/module-model");
+var _ResolveHelper = class _ResolveHelper {
+  static async resolve(config, idOrFilter = "*", { visibility, maxDepth = 5, required = "log", ...options } = {}) {
+    const { module: module2, logger = this.defaultLogger, dead = false, upResolver, downResolver } = config;
+    const log = logger ? new import_logger2.IdLogger(logger, () => `ResolveHelper [${module2.id}][${idOrFilter}][${visibility}]`) : void 0;
+    const childOptions = {
+      ...options,
+      direction: "down",
+      maxDepth: maxDepth - 1,
+      required: false,
+      visibility
+    };
+    const direction = (options == null ? void 0 : options.direction) ?? "all";
+    const up = direction === "up" || direction === "all";
+    const down = direction === "down" || direction === "all";
+    let result;
+    log == null ? void 0 : log.debug("start", idOrFilter, maxDepth);
+    if (idOrFilter === "*") {
+      if (dead) {
+        log == null ? void 0 : log.warn("failed [dead]", idOrFilter);
+        return [];
+      }
+      const modules = [
+        ...down ? await downResolver.resolve("*", childOptions) : [],
+        ...up ? await upResolver.resolve("*", childOptions) : []
+      ].filter(import_module_model2.duplicateModules).filter((module3) => module3.address !== config.address);
+      if (modules.length > 0) {
+        log == null ? void 0 : log.log("modules [count]", modules.length);
+        log == null ? void 0 : log.debug("modules", (0, import_object3.toJsonString)(modules, 4));
+      }
+      if (maxDepth === 0) {
+        return modules;
+      }
+      const childModules = (await Promise.all(modules.map(async (module3) => await module3.resolve("*", childOptions)))).flat().filter(import_module_model2.duplicateModules);
+      return [
+        module2,
+        ...modules,
+        ...childModules
+      ].filter(import_module_model2.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_model2.duplicateModules);
+          break;
+        }
+      }
+    }
+    this.validateRequiredResolve(required, result, idOrFilter, logger);
+    return result;
+  }
+  static validateRequiredResolve(required, result, idOrFilter, logger = this.defaultLogger) {
+    const log = logger ? new import_logger2.IdLogger(logger, () => `validateRequiredResolve [${idOrFilter}][${result}]`) : void 0;
+    if (required && (result === void 0 || Array.isArray(result) && result.length > 0)) {
+      switch (required) {
+        case "warn": {
+          log == null ? void 0 : log.warn("resolve failed", idOrFilter);
+          break;
+        }
+        case "log": {
+          log == null ? void 0 : log.log("resolve failed", idOrFilter);
+          break;
+        }
+        default: {
+          throw new Error(`resolve failed [${idOrFilter}]`);
+        }
+      }
+    }
+  }
+};
+__name(_ResolveHelper, "ResolveHelper");
+__publicField(_ResolveHelper, "defaultLogger");
+var ResolveHelper = _ResolveHelper;
+
+// src/AbstractModuleInstance.ts
 var _AbstractModuleInstance = class _AbstractModuleInstance extends AbstractModule {
   constructor(privateConstructorKey, params, account) {
     (0, import_assert3.assertEx)(AbstractModule.privateConstructorKey === privateConstructorKey, () => "Use create function instead of constructor");
@@ -991,10 +980,10 @@ var _AbstractModuleInstance = class _AbstractModuleInstance extends AbstractModu
       return await this.describeHandler();
     });
   }
-  discover() {
+  discover(maxDepth = 5) {
     this._checkDead();
     return this.busy(async () => {
-      return await this.discoverHandler();
+      return await this.discoverHandler(maxDepth);
     });
   }
   manifest(maxDepth, ignoreAddresses) {
@@ -1009,6 +998,30 @@ var _AbstractModuleInstance = class _AbstractModuleInstance extends AbstractModu
       return await this.moduleAddressHandler();
     });
   }
+  async resolve(idOrFilter = "*", options = {}) {
+    const config = {
+      address: this.address,
+      dead: this.dead,
+      downResolver: this.downResolver,
+      logger: this.logger,
+      module: this,
+      upResolver: this.upResolver
+    };
+    if (idOrFilter === "*") {
+      return await ResolveHelper.resolve(config, idOrFilter, options);
+    }
+    switch (typeof idOrFilter) {
+      case "string": {
+        return await ResolveHelper.resolve(config, idOrFilter, options);
+      }
+      case "object": {
+        return await ResolveHelper.resolve(config, idOrFilter, options);
+      }
+      default: {
+        return await ResolveHelper.resolve(config, idOrFilter, options);
+      }
+    }
+  }
   state() {
     this._checkDead();
     return this.busy(async () => {
@@ -1019,6 +1032,21 @@ var _AbstractModuleInstance = class _AbstractModuleInstance extends AbstractModu
     this._checkDead();
     return this.subscribeHandler();
   }
+  async resolveArchivingArchivists() {
+    var _a;
+    const archivists = (_a = this.config.archiving) == null ? void 0 : _a.archivists;
+    if (!archivists)
+      return [];
+    const resolved = await Promise.all(archivists.map((archivist) => this.resolve(archivist)));
+    return (0, import_lodash2.compact)(resolved.map((mod) => (0, import_archivist_model2.asArchivistInstance)(mod)));
+  }
+  async storeToArchivists(payloads) {
+    const archivists = await this.resolveArchivingArchivists();
+    return (await Promise.all(archivists.map((archivist) => {
+      var _a;
+      return (_a = archivist.insert) == null ? void 0 : _a.call(archivist, payloads);
+    }))).map(([bw]) => bw);
+  }
 };
 __name(_AbstractModuleInstance, "AbstractModuleInstance");
 var AbstractModuleInstance = _AbstractModuleInstance;