@xyo-network/module-abstract 2.66.8 → 2.67.0-rc.1

package/package.json

@@ -12,29 +12,29 @@
   "dependencies": {
     "@xylabs/assert": "^2.9.3",
     "@xylabs/exists": "^2.9.3",
-    "@xyo-network/account": "~2.66.8",
-    "@xyo-network/account-model": "~2.66.8",
-    "@xyo-network/address-payload-plugin": "~2.66.8",
-    "@xyo-network/archivist-model": "~2.66.8",
-    "@xyo-network/boundwitness-builder": "~2.66.8",
-    "@xyo-network/boundwitness-model": "~2.66.8",
-    "@xyo-network/config-payload-plugin": "~2.66.8",
-    "@xyo-network/core": "~2.66.8",
-    "@xyo-network/error": "~2.66.8",
-    "@xyo-network/manifest-model": "~2.66.8",
-    "@xyo-network/module-events": "~2.66.8",
-    "@xyo-network/module-model": "~2.66.8",
-    "@xyo-network/payload-builder": "~2.66.8",
-    "@xyo-network/payload-model": "~2.66.8",
-    "@xyo-network/payload-wrapper": "~2.66.8",
-    "@xyo-network/promise": "~2.66.8",
-    "@xyo-network/query-payload-plugin": "~2.66.8",
-    "@xyo-network/shared": "~2.66.8",
+    "@xyo-network/account": "~2.67.0-rc.1",
+    "@xyo-network/account-model": "~2.67.0-rc.1",
+    "@xyo-network/address-payload-plugin": "~2.67.0-rc.1",
+    "@xyo-network/archivist-model": "~2.67.0-rc.1",
+    "@xyo-network/boundwitness-builder": "~2.67.0-rc.1",
+    "@xyo-network/boundwitness-model": "~2.67.0-rc.1",
+    "@xyo-network/config-payload-plugin": "~2.67.0-rc.1",
+    "@xyo-network/core": "~2.67.0-rc.1",
+    "@xyo-network/error": "~2.67.0-rc.1",
+    "@xyo-network/manifest-model": "~2.67.0-rc.1",
+    "@xyo-network/module-events": "~2.67.0-rc.1",
+    "@xyo-network/module-model": "~2.67.0-rc.1",
+    "@xyo-network/payload-builder": "~2.67.0-rc.1",
+    "@xyo-network/payload-model": "~2.67.0-rc.1",
+    "@xyo-network/payload-wrapper": "~2.67.0-rc.1",
+    "@xyo-network/promise": "~2.67.0-rc.1",
+    "@xyo-network/query-payload-plugin": "~2.67.0-rc.1",
+    "@xyo-network/shared": "~2.67.0-rc.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.18.11",
-    "@xylabs/tsconfig": "^2.18.11",
+    "@xylabs/ts-scripts-yarn3": "^2.19.0",
+    "@xylabs/tsconfig": "^2.19.0",
     "jest": "^29.6.1",
     "jest-mock-extended": "^3.0.4",
     "typescript": "^5.1.6"
@@ -72,5 +72,6 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.66.8"
+  "version": "2.67.0-rc.1",
+  "stableVersion": "2.66.9"
 }

package/src/AbstractIndirectModule.ts

@@ -23,6 +23,7 @@ import {
   ModuleBusyEventArgs,
   ModuleConfig,
   ModuleDescribeQuerySchema,
+  ModuleDescription,
   ModuleDescriptionPayload,
   ModuleDescriptionSchema,
   ModuleDiscoverQuerySchema,
@@ -125,7 +126,7 @@ export abstract class AbstractIndirectModule<TParams extends ModuleParams = Modu
   }
 
   get queries(): string[] {
-    return [ModuleDiscoverQuerySchema, ModuleAddressQuerySchema, ModuleSubscribeQuerySchema]
+    return [ModuleDiscoverQuerySchema, ModuleAddressQuerySchema, ModuleSubscribeQuerySchema, ModuleDescribeQuerySchema, ModuleManifestQuerySchema]
   }
 
   get queryAccountPaths(): Readonly<Record<Query['schema'], string | undefined>> {
@@ -199,7 +200,6 @@ export abstract class AbstractIndirectModule<TParams extends ModuleParams = Modu
       if (!account) console.warn(`AbstractModule.loadAccount: No account provided - Creating Random account [${this.config.schema}]`)
       this._account = account ?? (await HDWallet.random())
     }
-    this.downResolver.add(this as Module)
     return this._account
   }
 
@@ -571,4 +571,9 @@ export abstract class AbstractIndirectModule<TParams extends ModuleParams = Modu
     const resolved = await this.upResolver.resolve(filter)
     return asArchivistInstance(resolved)
   }
+
+  abstract describe(): Promise<ModuleDescription>
+  abstract discover(): Promisable<Payload[]>
+  abstract manifest(): Promisable<ModuleManifestPayload>
+  abstract moduleAddress(): Promisable<AddressPreviousHashPayload[]>
 }

package/src/AbstractModule.ts

@@ -29,6 +29,12 @@ export abstract class AbstractModule<TParams extends ModuleParams = ModuleParams
     })
   }
 
+  override async loadAccount() {
+    const account = await super.loadAccount()
+    this.downResolver.add(this)
+    return account
+  }
+
   manifest(): Promise<ModuleManifestPayload> {
     return this.busy(async () => {
       return await super.manifestHandler()

package/src/Resolver/CompositeModuleResolver.ts

@@ -1,6 +1,6 @@
 import { exists } from '@xylabs/exists'
 import { Base, BaseParams } from '@xyo-network/core'
-import { duplicateModules, Module, ModuleFilter, ModuleRepository, ModuleResolver } from '@xyo-network/module-model'
+import { duplicateModules, ModuleFilter, ModuleInstance, ModuleRepository, ModuleResolver } from '@xyo-network/module-model'
 
 import { SimpleModuleResolver } from './SimpleModuleResolver'
 
@@ -19,9 +19,9 @@ export class CompositeModuleResolver extends Base implements ModuleRepository, M
     return true
   }
 
-  add(module: Module): this
-  add(module: Module[]): this
-  add(module: Module | Module[]): this {
+  add(module: ModuleInstance): this
+  add(module: ModuleInstance[]): this
+  add(module: ModuleInstance | ModuleInstance[]): this {
     if (Array.isArray(module)) {
       module.forEach((module) => this.addSingleModule(module))
     } else {
@@ -49,28 +49,31 @@ export class CompositeModuleResolver extends Base implements ModuleRepository, M
     return this
   }
 
-  async resolve(filter?: ModuleFilter): Promise<Module[]>
-  async resolve(nameOrAddress: string): Promise<Module | undefined>
-  async resolve(nameOrAddressOrFilter?: ModuleFilter | string): Promise<Module | Module[] | undefined> {
+  async resolve(filter?: ModuleFilter): Promise<ModuleInstance[]>
+  async resolve(nameOrAddress: string): Promise<ModuleInstance | undefined>
+  async resolve(nameOrAddressOrFilter?: ModuleFilter | string): Promise<ModuleInstance | ModuleInstance[] | undefined> {
     if (typeof nameOrAddressOrFilter === 'string') {
-      const result = await Promise.all(
+      const results = await Promise.all(
         this.resolvers.map(async (resolver) => {
-          return await resolver.resolve(nameOrAddressOrFilter)
+          const result: ModuleInstance | undefined = await resolver.resolve(nameOrAddressOrFilter)
+          return result
         }),
       )
-      return result.filter(exists).filter(duplicateModules).pop()
+      const result: ModuleInstance | undefined = results.filter(exists).filter(duplicateModules).pop()
+      return result
     } else {
       const result = await Promise.all(
         this.resolvers.map(async (resolver) => {
-          return await resolver.resolve(nameOrAddressOrFilter)
+          const result: ModuleInstance[] = await resolver.resolve(nameOrAddressOrFilter)
+          return result
         }),
       )
-      const flatResult = result.flat()
+      const flatResult: ModuleInstance[] = result.flat()
       return flatResult.filter(duplicateModules)
     }
   }
 
-  private addSingleModule(module?: Module) {
+  private addSingleModule(module?: ModuleInstance) {
     if (module) {
       this.localResolver.add(module)
     }

package/src/Resolver/SimpleModuleResolver.ts

@@ -1,7 +1,7 @@
 import {
   AddressModuleFilter,
-  Module,
   ModuleFilter,
+  ModuleInstance,
   ModuleRepository,
   ModuleResolver,
   NameModuleFilter,
@@ -14,15 +14,15 @@ import flatten from 'lodash/flatten'
 //This class is now package private (not exported from index.ts)
 export class SimpleModuleResolver implements ModuleRepository {
   private addressToName: Record<string, string> = {}
-  private modules: Record<string, Module> = {}
+  private modules: Record<string, ModuleInstance> = {}
 
   get isModuleResolver() {
     return true
   }
 
-  add(module: Module): this
-  add(module: Module[]): this
-  add(module: Module | Module[]): this {
+  add(module: ModuleInstance): this
+  add(module: ModuleInstance[]): this
+  add(module: ModuleInstance | ModuleInstance[]): this {
     if (Array.isArray(module)) {
       module.forEach((module) => this.addSingleModule(module))
     } else {
@@ -48,19 +48,21 @@ export class SimpleModuleResolver implements ModuleRepository {
     throw 'Removing resolvers not supported'
   }
 
-  resolve(filter?: ModuleFilter): Promisable<Module[]>
-  resolve(nameOrAddress: string): Promisable<Module | undefined>
-  resolve(nameOrAddressOrFilter?: ModuleFilter | string): Promisable<Module | Module[] | undefined> {
+  resolve(filter?: ModuleFilter): Promisable<ModuleInstance[]>
+  resolve(nameOrAddress: string): Promisable<ModuleInstance | undefined>
+  resolve(nameOrAddressOrFilter?: ModuleFilter | string): Promisable<ModuleInstance[] | ModuleInstance | undefined> {
     if (nameOrAddressOrFilter) {
       if (typeof nameOrAddressOrFilter === 'string') {
-        return (
+        const result: ModuleInstance | undefined =
           this.resolveByName(Object.values(this.modules), [nameOrAddressOrFilter]).pop() ??
           this.resolveByAddress(Object.values(this.modules), [nameOrAddressOrFilter]).pop()
-        )
+        return result
       } else if ((nameOrAddressOrFilter as AddressModuleFilter).address) {
-        return this.resolveByAddress(Object.values(this.modules), (nameOrAddressOrFilter as AddressModuleFilter).address)
+        const result: ModuleInstance[] = this.resolveByAddress(Object.values(this.modules), (nameOrAddressOrFilter as AddressModuleFilter).address)
+        return result
       } else if ((nameOrAddressOrFilter as NameModuleFilter).name) {
-        return this.resolveByName(Object.values(this.modules), (nameOrAddressOrFilter as NameModuleFilter).name)
+        const result: ModuleInstance[] = this.resolveByName(Object.values(this.modules), (nameOrAddressOrFilter as NameModuleFilter).name)
+        return result
       } else if ((nameOrAddressOrFilter as QueryModuleFilter).query) {
         return this.resolveByQuery(Object.values(this.modules), (nameOrAddressOrFilter as QueryModuleFilter).query)
       }
@@ -69,7 +71,7 @@ export class SimpleModuleResolver implements ModuleRepository {
     }
   }
 
-  private addSingleModule(module?: Module) {
+  private addSingleModule(module?: ModuleInstance) {
     if (module) {
       this.modules[module.address] = module
     }
@@ -87,7 +89,7 @@ export class SimpleModuleResolver implements ModuleRepository {
     }
   }
 
-  private resolveByAddress<T extends Module = Module>(modules: T[], address?: string[]): T[] {
+  private resolveByAddress<T extends ModuleInstance = ModuleInstance>(modules: T[], address?: string[]): T[] {
     return address
       ? compact(
           flatten(
@@ -99,25 +101,26 @@ export class SimpleModuleResolver implements ModuleRepository {
       : modules
   }
 
-  private resolveByName<T extends Module = Module>(modules: T[], name?: string[]): T[] {
+  private resolveByName<T extends ModuleInstance = ModuleInstance>(modules: T[], name?: string[]): T[] {
     if (name) {
       return compact(name.map((name) => modules.filter((module) => module.config.name === name)).flat())
     }
     return modules
   }
 
-  private resolveByQuery<T extends Module = Module>(modules: T[], query?: string[][]): T[] {
+  private resolveByQuery<T extends ModuleInstance = ModuleInstance>(modules: T[], query?: string[][]): T[] {
     return query
       ? compact(
-          modules.filter((module) =>
-            query?.reduce((supported, queryList) => {
-              return (
-                queryList.reduce((supported, query) => {
-                  const queryable = module.queries.includes(query)
-                  return supported && queryable
-                }, true) || supported
-              )
-            }, false),
+          modules.filter(
+            (module) =>
+              query?.reduce((supported, queryList) => {
+                return (
+                  queryList.reduce((supported, query) => {
+                    const queryable = module.queries.includes(query)
+                    return supported && queryable
+                  }, true) || supported
+                )
+              }, false),
           ),
         )
       : modules