@xyo-network/module-model 2.90.23 → 2.91.1

package/dist/node/withModule.d.cts

@@ -15,8 +15,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -32,8 +32,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -56,8 +56,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -73,8 +73,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;

package/dist/node/withModule.d.mts

@@ -15,8 +15,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -32,8 +32,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -56,8 +56,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -73,8 +73,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;

package/dist/node/withModule.d.ts

@@ -15,8 +15,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -32,8 +32,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -56,8 +56,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -73,8 +73,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;

package/package.json

@@ -10,23 +10,23 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.14.3",
-    "@xylabs/hex": "^2.14.3",
-    "@xylabs/lodash": "^2.14.3",
-    "@xylabs/logger": "^2.14.3",
-    "@xylabs/object": "^2.89.3",
-    "@xylabs/promise": "^2.14.3",
-    "@xylabs/retry": "^2.14.3",
-    "@xyo-network/account-model": "~2.90.23",
-    "@xyo-network/address-payload-plugin": "~2.90.23",
-    "@xyo-network/boundwitness-model": "~2.90.23",
-    "@xyo-network/manifest-model": "~2.90.23",
-    "@xyo-network/module-events": "~2.90.23",
-    "@xyo-network/payload-model": "~2.90.23"
+    "@xylabs/assert": "^3.0.2",
+    "@xylabs/hex": "^3.0.2",
+    "@xylabs/lodash": "^3.0.2",
+    "@xylabs/logger": "^3.0.2",
+    "@xylabs/object": "^3.0.2",
+    "@xylabs/promise": "^3.0.2",
+    "@xylabs/retry": "^3.0.2",
+    "@xyo-network/account-model": "~2.91.1",
+    "@xyo-network/address-payload-plugin": "~2.91.1",
+    "@xyo-network/boundwitness-model": "~2.91.1",
+    "@xyo-network/manifest-model": "~2.91.1",
+    "@xyo-network/module-events": "~2.91.1",
+    "@xyo-network/payload-model": "~2.91.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.2.42",
-    "@xylabs/tsconfig": "^3.2.42",
+    "@xylabs/ts-scripts-yarn3": "^3.4.1",
+    "@xylabs/tsconfig": "^3.4.1",
     "typescript": "^5.3.3"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -68,6 +68,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.90.23",
+  "version": "2.91.1",
   "type": "module"
 }

package/src/Config.ts

@@ -3,6 +3,7 @@ import { EmptyObject, WithAdditional } from '@xylabs/object'
 import { RetryConfig } from '@xylabs/retry'
 import { Payload, Schema } from '@xyo-network/payload-model'
 
+import { ModuleIdentifier, ModuleName } from './instance'
 import { Labels } from './Labels'
 
 export type ModuleConfigSchema = 'network.xyo.module.config'
@@ -10,12 +11,11 @@ export const ModuleConfigSchema: ModuleConfigSchema = 'network.xyo.module.config
 
 export type CosigningAddressSet = string[]
 export type SchemaString = string
-export type ModuleName = string
 export type NameOrAddress = Address | ModuleName
 
 export interface ArchivingModuleConfig {
   readonly archiving?: {
-    readonly archivists?: NameOrAddress[]
+    readonly archivists?: ModuleIdentifier[]
   }
 }
 
@@ -23,7 +23,7 @@ export type ModuleConfig<TConfig extends EmptyObject | Payload | void = void, TS
   WithAdditional<
     {
       /** @field The name/address of the Archivist to use for this module */
-      readonly archivist?: NameOrAddress
+      readonly archivist?: ModuleIdentifier
 
       /**
        * @field The labels used for this module. If a label is specified, then the
@@ -33,7 +33,7 @@ export type ModuleConfig<TConfig extends EmptyObject | Payload | void = void, TS
       readonly labels?: Labels
 
       /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
-      readonly name?: string
+      readonly name?: ModuleName
 
       /** @field paging settings for queries */
       readonly paging?: Record<string, { size?: number }>

package/src/CreatableModule/ModuleFactoryLocator.ts

@@ -75,8 +75,8 @@ export class ModuleFactoryLocator {
    */
   tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {
     // If labels were provided
-    return labels
-      ? // Find the first factory that has labels and has all the labels provided
+    return labels ?
+        // Find the first factory that has labels and has all the labels provided
         this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))
       : // Otherwise, return the first factory
         this._registry[schema]?.[0]

package/src/EventsModels/ModuleEventArgs.ts

@@ -1,7 +1,8 @@
 import { EventArgs } from '@xyo-network/module-events'
 
-export type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs
-  ? {
+export type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> =
+  TArgs extends EventArgs ?
+    {
       module: TModule
     } & TArgs
   : {

package/src/ModuleDescription.ts

@@ -1,6 +1,9 @@
+import { Address } from '@xylabs/hex'
+
+import { ModuleName } from './instance'
 export interface ModuleDescription {
-  address: string
+  address: Address
   children?: string[]
-  name?: string
+  name?: ModuleName
   queries: string[]
 }

package/src/Queries/ModuleAddress/Payload.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { AddressSchema } from '@xyo-network/address-payload-plugin'
 import { Payload } from '@xyo-network/payload-model'
 
@@ -5,7 +6,7 @@ export const AddressPreviousHashSchema = `${AddressSchema}.hash.previous`
 export type AddressPreviousHashSchema = typeof AddressPreviousHashSchema
 
 export type AddressPreviousHashPayload = Payload<{
-  address: string
+  address: Address
   previousHash?: string
   schema: AddressPreviousHashSchema
 }>

package/src/Queries/State.ts

@@ -0,0 +1,6 @@
+import { Query } from '@xyo-network/payload-model'
+
+export const ModuleStateQuerySchema = 'network.xyo.query.module.state'
+export type ModuleStateQuerySchema = typeof ModuleStateQuerySchema
+
+export type ModuleStateQuery = Query<void, ModuleStateQuerySchema>

package/src/Queries/Subscribe.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { Query } from '@xyo-network/payload-model'
 
 export type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
@@ -11,7 +12,7 @@ export interface ModuleSubscribeFilter {
 //requests notification when a boundwitness is added to the modules chain that meets the filter criteria
 export type ModuleSubscribeQuery = Query<{
   /** @field The address that will receive notifications */
-  address: string
+  address: Address
   /** @field A subscribe with a null for filter is an unsubscribe */
   filter?: ModuleSubscribeFilter | null
   /** @field The maximum events queued per send [may increase frequency] */

package/src/Queries/index.ts

@@ -1,17 +1,21 @@
-import { Query } from '@xyo-network/payload-model'
-
 import { ModuleDescribeQuery } from './Describe'
 import { ModuleDiscoverQuery } from './Discover'
 import { ModuleManifestQuery } from './Manifest'
 import { ModuleAddressQuery } from './ModuleAddress'
+import { ModuleStateQuery } from './State'
 import { ModuleSubscribeQuery } from './Subscribe'
 
 export * from './Describe'
 export * from './Discover'
 export * from './Manifest'
 export * from './ModuleAddress'
+export * from './State'
 export * from './Subscribe'
 
-export type ModuleQueryBase = ModuleDiscoverQuery | ModuleAddressQuery | ModuleSubscribeQuery | ModuleDescribeQuery | ModuleManifestQuery
-
-export type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase
+export type ModuleQueries =
+  | ModuleDiscoverQuery
+  | ModuleAddressQuery
+  | ModuleSubscribeQuery
+  | ModuleDescribeQuery
+  | ModuleManifestQuery
+  | ModuleStateQuery

package/src/instance/Instance.ts

@@ -0,0 +1,26 @@
+import { IsObjectFactory, TypeCheck } from '@xylabs/object'
+
+import { ModuleEventData } from '../EventsModels'
+import { Module, ModuleQueryFunctions } from '../module'
+import { ModuleParams } from '../ModuleParams'
+import { ObjectResolver, ObjectResolverInstance } from './ObjectResolver'
+
+export type ModulePipeLine = Lowercase<'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many'>
+
+export interface ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData>
+  extends Module<TParams, TEventData>,
+    ObjectResolver<ModuleInstance>,
+    ModuleQueryFunctions {
+  /* The resolver is a 'down' resolver.  It can resolve the module or any children (if it is a node for example), that are in the module*/
+  readonly downResolver: Omit<ObjectResolverInstance<ModuleInstance>, 'resolve'>
+
+  readonly pipeline?: ModulePipeLine
+
+  /* The resolver is a 'up' resolver.  It can resolve the parent or any children of the parent*/
+  /* This is set by a NodeModule when attaching to the module */
+  readonly upResolver: Omit<ObjectResolverInstance<ModuleInstance>, 'resolve'>
+}
+
+export type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = TypeCheck<T>
+
+export class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {}

package/src/instance/ModuleFilter.ts

@@ -0,0 +1,30 @@
+import { ModuleInstance } from './Instance'
+import {
+  AddressObjectFilter,
+  AnyObjectFilter,
+  isAddressObjectFilter,
+  isNameObjectFilter,
+  isQueryObjectFilter,
+  NameObjectFilter,
+  ObjectFilter,
+  ObjectFilterOptions,
+  QueryObjectFilter,
+} from './ObjectFilter'
+
+export interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> extends ObjectFilterOptions<T> {}
+
+export const isAddressModuleFilter = isAddressObjectFilter<ModuleInstance>
+
+export const isNameModuleFilter = isNameObjectFilter<ModuleInstance>
+
+export const isQueryModuleFilter = isQueryObjectFilter<ModuleInstance>
+
+export type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = AnyObjectFilter<T>
+
+export type AddressModuleFilter<T extends ModuleInstance = ModuleInstance> = AddressObjectFilter<T>
+
+export type NameModuleFilter<T extends ModuleInstance = ModuleInstance> = NameObjectFilter<T>
+
+export type QueryModuleFilter<T extends ModuleInstance = ModuleInstance> = QueryObjectFilter<T>
+
+export type ModuleFilter<T extends ModuleInstance = ModuleInstance> = ObjectFilter<T>

package/src/instance/ModuleIdentifier.ts

@@ -0,0 +1,65 @@
+import { Address, isAddress } from '@xylabs/hex'
+
+export const DisallowedModuleIdentifierCharacters = {
+  ' ': true,
+  '!': true,
+  '"': true,
+  '#': true,
+  $: true,
+  '%': true,
+  '&': true,
+  "'": true,
+  '(': true,
+  ')': true,
+  '*': true,
+  ',': true,
+  '.': true,
+  '/': true,
+  ':': true,
+  ';': true,
+  '<': true,
+  '=': true,
+  '>': true,
+  '?': true,
+  '@': true,
+  '[': true,
+  ']': true,
+  '^': true,
+  _: true,
+  '{': true,
+  '|': true,
+  '}': true,
+  '~': true,
+}
+export type ReservedModuleIdentifierCharacter = keyof typeof DisallowedModuleIdentifierCharacters
+export const ReservedModuleIdentifierCharacters = new Set<ReservedModuleIdentifierCharacter>(
+  Object.keys(DisallowedModuleIdentifierCharacters) as ReservedModuleIdentifierCharacter[],
+)
+
+//using Exclude to make this type not allowed to take a naked string
+export type ModuleName = Exclude<string, 'reserved-module-name-56487634'>
+
+export type ModuleIdentifier =
+  | ColonPair<ModuleIdentifierPart>
+  | ColonPair<ColonPair<ModuleIdentifierPart>>
+  | ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>
+  | ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>
+  | ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>>
+  | ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>>>
+  | ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ColonPair<ModuleIdentifierPart>>>>>>>
+
+export type ColonPair<T extends string> = `${T}:${T}` | T
+
+export type ModuleIdentifierPart = Address | ModuleName
+
+export const isModuleName = (value: unknown): value is ModuleName => {
+  return typeof value === 'string' && !isAddress(value) && !includesReservedModuleIdentifierCharacter(value)
+}
+
+export const includesReservedModuleIdentifierCharacter = (value: unknown): boolean => {
+  return typeof value === 'string' && [...value].some((char) => ReservedModuleIdentifierCharacters.has(char as ReservedModuleIdentifierCharacter))
+}
+
+export const isModuleIdentifierPart = (value: unknown): value is ModuleIdentifierPart => {
+  return isModuleName(value) || isAddress(value)
+}

package/src/instance/ModuleRepository.ts

@@ -1,10 +1,12 @@
-import { Module } from '../module'
-import { ModuleResolverInstance } from './ModuleInstance'
+import { Address } from '@xylabs/hex'
 
-export interface ModuleRepository extends ModuleResolverInstance {
-  add(module: Module): this
-  add(module: Module[]): this
-  add(module: Module | Module[]): this
+import { ModuleInstance } from './Instance'
+import { ModuleResolverInstance } from './ModuleResolver'
 
-  remove(address: string | string[]): this
+export interface ModuleRepository<T extends ModuleInstance = ModuleInstance> extends ModuleResolverInstance<T> {
+  add(module: T): this
+  add(module: T[]): this
+  add(module: T | T[]): this
+
+  remove(address: Address | string[]): this
 }

package/src/instance/ModuleResolver.ts

@@ -0,0 +1,11 @@
+import { ModuleInstance } from './Instance'
+import { isObjectResolver, ObjectResolver } from './ObjectResolver'
+
+export const isModuleResolver = isObjectResolver<ModuleInstance>
+
+export interface ModuleResolver<TResult extends ModuleInstance = ModuleInstance> extends ObjectResolver<TResult> {}
+
+export interface ModuleResolverInstance<TResult extends ModuleInstance = ModuleInstance> extends ModuleResolver<TResult> {
+  addResolver: (resolver: ModuleResolverInstance<TResult>) => this
+  removeResolver: (resolver: ModuleResolverInstance<TResult>) => this
+}

package/src/instance/ObjectFilter.ts

@@ -0,0 +1,41 @@
+import { Address } from '@xylabs/hex'
+import { AnyObject, EmptyObject, TypeCheck } from '@xylabs/object'
+
+import { ModuleName } from './ModuleIdentifier'
+
+export type Direction = 'up' | 'down' | 'all'
+export type Visibility = 'public' | 'private' | 'all'
+
+export interface ObjectFilterOptions<T extends EmptyObject = AnyObject> {
+  direction?: Direction
+  identity?: TypeCheck<T>
+  maxDepth?: number
+  visibility?: Visibility
+}
+
+export interface AddressObjectFilter<T extends EmptyObject = AnyObject> extends ObjectFilterOptions<T> {
+  address: Address[]
+}
+
+export const isAddressObjectFilter = <T extends EmptyObject = AnyObject>(value: unknown): value is AddressObjectFilter<T> =>
+  (value as AddressObjectFilter<T>).address !== undefined
+
+export interface NameObjectFilter<T extends EmptyObject = AnyObject> extends ObjectFilterOptions<T> {
+  name: ModuleName[]
+}
+
+export const isNameObjectFilter = <T extends EmptyObject = AnyObject>(value: unknown): value is NameObjectFilter<T> =>
+  (value as NameObjectFilter<T>).name !== undefined
+
+export interface QueryObjectFilter<T extends EmptyObject = AnyObject> extends ObjectFilterOptions<T> {
+  query: string[][]
+}
+
+export const isQueryObjectFilter = <T extends EmptyObject = AnyObject>(value: unknown): value is QueryObjectFilter<T> =>
+  (value as QueryObjectFilter<T>).query !== undefined
+
+export type AnyObjectFilter<T extends EmptyObject = AnyObject> = Partial<AddressObjectFilter<T>> &
+  Partial<NameObjectFilter<T>> &
+  Partial<QueryObjectFilter<T>>
+
+export type ObjectFilter<T extends EmptyObject> = ObjectFilterOptions<T> | AddressObjectFilter<T> | NameObjectFilter<T> | QueryObjectFilter<T>

package/src/instance/ObjectResolver.ts

@@ -0,0 +1,23 @@
+import { AnyObject, EmptyObject } from '@xylabs/object'
+import { Promisable } from '@xylabs/promise'
+
+import { ModuleIdentifier } from './ModuleIdentifier'
+import { ObjectFilter, ObjectFilterOptions } from './ObjectFilter'
+
+export const isObjectResolver = <T extends EmptyObject = AnyObject>(value?: unknown): value is ObjectResolver<T> => {
+  return typeof (value as Partial<ObjectResolver<T>>).resolve === 'function'
+}
+
+export interface ObjectResolver<TResult extends EmptyObject> {
+  resolve<T extends TResult = TResult>(filter?: ObjectFilter<T>, options?: ObjectFilterOptions<T>): Promisable<T[]>
+  resolve<T extends TResult = TResult>(nameOrAddress: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promisable<T | undefined>
+  resolve<T extends TResult = TResult>(
+    nameOrAddressOrFilter?: ObjectFilter<T> | ModuleIdentifier,
+    options?: ObjectFilterOptions<T>,
+  ): Promisable<T | T[] | undefined>
+}
+
+export interface ObjectResolverInstance<TResult extends EmptyObject> extends ObjectResolver<TResult> {
+  addResolver: (resolver: ObjectResolverInstance<TResult>) => this
+  removeResolver: (resolver: ObjectResolverInstance<TResult>) => this
+}

package/src/instance/index.ts

@@ -1,4 +1,9 @@
 export * from './asModuleInstance'
+export * from './Instance'
 export * from './isModuleInstance'
-export * from './ModuleInstance'
+export * from './ModuleFilter'
+export * from './ModuleIdentifier'
 export * from './ModuleRepository'
+export * from './ModuleResolver'
+export * from './ObjectFilter'
+export * from './ObjectResolver'

package/src/instance/isModuleInstance.ts

@@ -1,7 +1,7 @@
 import { IsObjectFactory, ObjectTypeShape, TypeCheck } from '@xylabs/object'
 
 import { isModule } from '../module'
-import { ModuleInstance } from './ModuleInstance'
+import { ModuleInstance } from './Instance'
 
 export const requiredModuleInstanceFunctions: ObjectTypeShape = {
   describe: 'function',

package/src/module/ModuleFields.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { Promisable } from '@xylabs/promise'
 import { QueryBoundWitness } from '@xyo-network/boundwitness-model'
 import { Payload } from '@xyo-network/payload-model'
@@ -7,7 +8,7 @@ import { ModuleParams } from '../ModuleParams'
 import { ModuleQueryResult } from '../ModuleQueryResult'
 
 export type ModuleFields<TParams extends ModuleParams = ModuleParams> = {
-  address: string
+  address: Address
   config: TParams['config']
 
   /** The name (if specified) or address of the module */

package/src/module/ModuleQueryFunctions.ts

@@ -10,4 +10,5 @@ export type ModuleQueryFunctions = {
   discover: () => Promisable<Payload[]>
   manifest: (maxDepth?: number, ignoreAddresses?: string[]) => Promisable<ModuleManifestPayload>
   moduleAddress: () => Promisable<AddressPreviousHashPayload[]>
+  state: () => Promisable<Payload[]>
 }

package/dist/browser/instance/ModuleInstance.d.cts

@@ -1,42 +0,0 @@
-import { IsObjectFactory, TypeCheck } from '@xylabs/object';
-import { Promisable } from '@xylabs/promise';
-import { ModuleEventData } from '../EventsModels';
-import { Module, ModuleQueryFunctions } from '../module';
-import { ModuleParams } from '../ModuleParams';
-export type ModulePipeLine = 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many';
-export declare const isModuleResolver: (value?: unknown) => value is ModuleResolver;
-export interface ModuleResolver {
-    resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>;
-    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>;
-    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddressOrFilter?: ModuleFilter<T> | string, options?: ModuleFilterOptions<T>): Promisable<T | T[] | undefined>;
-}
-export interface ModuleResolverInstance extends ModuleResolver {
-    addResolver: (resolver: ModuleResolverInstance) => this;
-    removeResolver: (resolver: ModuleResolverInstance) => this;
-}
-export interface ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> extends Module<TParams, TEventData>, ModuleResolver, ModuleQueryFunctions {
-    readonly downResolver: Omit<ModuleResolverInstance, 'resolve'>;
-    readonly pipeline?: ModulePipeLine;
-    readonly upResolver: Omit<ModuleResolverInstance, 'resolve'>;
-}
-export type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = TypeCheck<T>;
-export declare class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {
-}
-export interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {
-    direction?: 'up' | 'down' | 'all';
-    identity?: InstanceTypeCheck<T>;
-    maxDepth?: number;
-    visibility?: 'public' | 'private' | 'all';
-}
-export interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
-    address: string[];
-}
-export interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
-    name: string[];
-}
-export interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
-    query: string[][];
-}
-export type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> & Partial<NameModuleFilter<T>> & Partial<QueryModuleFilter<T>>;
-export type ModuleFilter<T extends ModuleInstance = ModuleInstance> = ModuleFilterOptions<T> | AddressModuleFilter<T> | NameModuleFilter<T> | QueryModuleFilter<T>;
-//# sourceMappingURL=ModuleInstance.d.ts.map