@xyo-network/module-model 5.3.4 → 5.3.6

package/dist/neutral/lib/duplicateModules.d.ts

@@ -1,4 +1,4 @@
-import type { Module } from '../module/index.ts';
+import type { QueryableModule } from '../QueryableModule/index.ts';
 /**
  * Used to filter duplicates from an array of modules
  * @example: modulesArray.filter(duplicateModules)
@@ -8,5 +8,5 @@ import type { Module } from '../module/index.ts';
  * @returns True if the Module's address is the first occurrence of
  * that address in the array, false otherwise
  */
-export declare const duplicateModules: (value: Module, index: number, array: Module[]) => value is Module;
+export declare const duplicateModules: (value: QueryableModule, index: number, array: QueryableModule[]) => value is QueryableModule;
 //# sourceMappingURL=duplicateModules.d.ts.map

package/dist/neutral/lib/duplicateModules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"duplicateModules.d.ts","sourceRoot":"","sources":["../../../src/lib/duplicateModules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,KAAG,KAAK,IAAI,MAEzF,CAAA"}
+{"version":3,"file":"duplicateModules.d.ts","sourceRoot":"","sources":["../../../src/lib/duplicateModules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAElE;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,eAAe,EAAE,OAAO,MAAM,EAAE,OAAO,eAAe,EAAE,KAAG,KAAK,IAAI,eAE3G,CAAA"}

package/dist/neutral/withModule.d.ts

@@ -1,7 +1,6 @@
 import type { TypeCheck } from '@xylabs/sdk-js';
+/** @deprecated use narrowing instead [ if(is) ] */
 export declare const WithFactory: {
     create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(mod: any, closure: (mod: T) => R) => R | undefined;
 };
-export declare const withModule: <R>(mod: any, closure: (mod: import("./module/Module.ts").Module<import("./ModuleParams.ts").ModuleParams<import("./index.ts").AnyConfigSchema<import("./index.ts").ModuleConfig>>, import("./index.ts").ModuleEventData<object>>) => R) => R | undefined;
-export declare const withModuleInstance: <R>(mod: any, closure: (mod: import("./instance/Instance.ts").ModuleInstance<import("./ModuleParams.ts").ModuleParams<import("./index.ts").AnyConfigSchema<import("./index.ts").ModuleConfig>>, import("./index.ts").ModuleEventData<object>>) => R) => R | undefined;
 //# sourceMappingURL=withModule.d.ts.map

package/dist/neutral/withModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAK/C,eAAO,MAAM,WAAW;aACb,CAAC,SAAS,MAAM,aAAa,SAAS,CAAC,CAAC,CAAC,MACxC,CAAC,EAEP,KAAK,GAAG,EAER,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KACrB,CAAC,GAAG,SAAS;CAInB,CAAA;AAED,eAAO,MAAM,UAAU,GAXX,CAAC,OAEF,GAAG,6OASwC,CAAA;AACtD,eAAO,MAAM,kBAAkB,GAZnB,CAAC,OAEF,GAAG,yPAUwD,CAAA"}
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,mDAAmD;AACnD,eAAO,MAAM,WAAW;aACb,CAAC,SAAS,MAAM,aAAa,SAAS,CAAC,CAAC,CAAC,MACxC,CAAC,EAEP,KAAK,GAAG,EAER,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KACrB,CAAC,GAAG,SAAS;CAInB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-model",
-  "version": "5.3.4",
+  "version": "5.3.6",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -36,10 +36,10 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xyo-network/account-model": "~5.3.4",
-    "@xyo-network/boundwitness-model": "~5.3.4",
-    "@xyo-network/manifest-model": "~5.3.4",
-    "@xyo-network/payload-model": "~5.3.4"
+    "@xyo-network/account-model": "~5.3.6",
+    "@xyo-network/boundwitness-model": "~5.3.6",
+    "@xyo-network/manifest-model": "~5.3.6",
+    "@xyo-network/payload-model": "~5.3.6"
   },
   "devDependencies": {
     "@xylabs/sdk-js": "^5.0.79",

package/src/CreatableModule/CreatableModule.ts

@@ -5,11 +5,9 @@ import type { Schema } from '@xyo-network/payload-model'
 
 import type { ModuleEventData } from '../EventsModels/index.ts'
 import type { AttachableModuleInstance } from '../instance/index.ts'
-import type { WithOptionalLabels } from '../Labels/index.ts'
-import type { ModuleParams } from '../ModuleParams.ts'
-import type { LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory.ts'
+import type { QueryableModuleParams } from '../QueryableModule/index.ts'
 
-export interface CreatableModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData>
+export interface CreatableModuleInstance<TParams extends QueryableModuleParams = QueryableModuleParams, TEventData extends ModuleEventData = ModuleEventData>
   extends CreatableInstance<TParams, TEventData>, AttachableModuleInstance<TParams, TEventData> {}
 
 export interface CreatableModuleFactory<T extends CreatableModuleInstance = CreatableModuleInstance>
@@ -22,10 +20,6 @@ export interface CreatableModuleFactory<T extends CreatableModuleInstance = Crea
     params?: Partial<T['params']>): Promise<T>
 }
 
-export interface LabeledCreatableModule<T extends CreatableModuleInstance = CreatableModuleInstance> extends CreatableModule<T>, WithOptionalLabels {
-  factory(params?: Partial<T['params']>): LabeledCreatableModuleFactory<T>
-}
-
 export interface CreatableModule<T extends CreatableModuleInstance = CreatableModuleInstance> extends Creatable<T> {
   configSchemas: Schema[]
   defaultConfigSchema: Schema
@@ -46,16 +40,3 @@ export function creatableModule<TModule extends CreatableModuleInstance = Creata
     constructor
   }
 }
-
-/**
- * Class annotation to be used to decorate Modules which support
- * an asynchronous creation pattern
- * @returns The decorated Module requiring it implement the members
- * of the CreatableModule as statics properties/methods
- */
-export function labeledCreatableModule<TModule extends CreatableModuleInstance = CreatableModuleInstance>() {
-  return <U extends LabeledCreatableModule<TModule>>(constructor: U) => {
-    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-    constructor
-  }
-}

package/src/CreatableModule/LabeledCreatableModule.ts

@@ -0,0 +1,20 @@
+import type { WithOptionalLabels } from '../Labels/index.ts'
+import type { CreatableModule, CreatableModuleInstance } from './CreatableModule.ts'
+import type { LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory.ts'
+
+export interface LabeledCreatableModule<T extends CreatableModuleInstance = CreatableModuleInstance> extends CreatableModule<T>, WithOptionalLabels {
+  factory(params?: Partial<T['params']>): LabeledCreatableModuleFactory<T>
+}
+
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+export function labeledCreatableModule<TModule extends CreatableModuleInstance = CreatableModuleInstance>() {
+  return <U extends LabeledCreatableModule<TModule>>(constructor: U) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    constructor
+  }
+}

package/src/CreatableModule/index.ts

@@ -1,4 +1,5 @@
 export * from './CreatableModule.ts'
 export * from './CreatableModuleRegistry.ts'
+export * from './LabeledCreatableModule.ts'
 export * from './LabeledCreatableModuleFactory.ts'
 export * from './ModuleFactory.ts'

package/src/QueryableModule/IsQueryableModuleFactory.ts

@@ -0,0 +1,34 @@
+import type {
+  AnyNonPromise,
+  AnyObject, EmptyObject, TypeCheck,
+  TypeCheckConfig,
+} from '@xylabs/sdk-js'
+
+import { asQueryableModuleObject } from './asQueryableModuleObject.ts'
+import { isQueryableModuleObject } from './isQueryableModuleObject.ts'
+import type { QueryableModule } from './QueryableModule.ts'
+
+export type QueryableModuleTypeCheck<T extends QueryableModule = QueryableModule> = TypeCheck<T>
+
+/** @deprecated use QueryableModuleTypeCheck instead */
+export type ModuleTypeCheck<T extends QueryableModule = QueryableModule> = TypeCheck<T>
+
+export class IsQueryableModuleFactory<T extends QueryableModule = QueryableModule> {
+  create(expectedQueries?: string[], additionalChecks?: TypeCheck<AnyObject | EmptyObject>[]): QueryableModuleTypeCheck<T> {
+    const result = (obj: AnyNonPromise, config?: TypeCheckConfig | number): obj is T => {
+      const mod = asQueryableModuleObject(obj)
+      return (
+        isQueryableModuleObject(mod, config)
+        // eslint-disable-next-line unicorn/no-array-reduce
+        && (expectedQueries?.reduce((prev, query) => prev && mod.queries.includes(query), true) ?? true)
+        // perform additional checks
+        // eslint-disable-next-line unicorn/no-array-reduce
+        && (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true)
+      )
+    }
+    return result
+  }
+}
+
+/** @deprecated use IsQueryableModuleFactory instead */
+export class IsModuleFactory<T extends QueryableModule = QueryableModule> extends IsQueryableModuleFactory<T> {}

package/src/QueryableModule/QueryableModule.ts

@@ -0,0 +1,14 @@
+import type { CreatableInstance } from '@xylabs/sdk-js'
+
+import type { ModuleEventData } from '../EventsModels/index.ts'
+import type { QueryableModuleFields } from './QueryableModuleFields.ts'
+import type { QueryableModuleParams } from './QueryableModuleParams.ts'
+
+export interface QueryableModule<TParams extends QueryableModuleParams = QueryableModuleParams,
+  TEventData extends ModuleEventData<object> = ModuleEventData<object>>
+  extends QueryableModuleFields<TParams>, CreatableInstance<TParams, TEventData> {
+}
+
+/** @deprecated use QueryableModule instead */
+export interface Module<TParams extends QueryableModuleParams = QueryableModuleParams, TEventData extends ModuleEventData<object> = ModuleEventData<object>>
+  extends QueryableModule<TParams, TEventData> {}

package/src/{module/ModuleFields.ts → QueryableModule/QueryableModuleFields.ts}

@@ -4,10 +4,10 @@ import type { Payload } from '@xyo-network/payload-model'
 
 import type { ModuleConfig } from '../Config/index.ts'
 import type { ModuleName } from '../ModuleIdentifier.ts'
-import type { ModuleParams } from '../ModuleParams.ts'
 import type { ModuleQueryResult } from '../ModuleQueryResult.ts'
+import type { QueryableModuleParams } from './QueryableModuleParams.ts'
 
-export interface ModuleFields<TParams extends ModuleParams = ModuleParams> {
+export interface QueryableModuleFields<TParams extends QueryableModuleParams = QueryableModuleParams> {
   address: Address
   config: TParams['config']
 
@@ -32,3 +32,6 @@ export interface ModuleFields<TParams extends ModuleParams = ModuleParams> {
     queryConfig?: TConf,
   ) => Promisable<boolean>
 }
+
+/** @deprecated use QueryableModuleFields instead */
+export interface ModuleFields<TParams extends QueryableModuleParams = QueryableModuleParams> extends QueryableModuleFields<TParams> {}

package/src/{module/ModuleQueryFunctions.ts → QueryableModule/QueryableModuleFunctions.ts}

@@ -6,10 +6,13 @@ import type { Payload } from '@xyo-network/payload-model'
 import type { ModuleQueryResult } from '../ModuleQueryResult.ts'
 import type { AddressPayload, AddressPreviousHashPayload } from '../Payload/index.ts'
 
-export interface ModuleQueryFunctions {
+export interface QueryableModuleFunctions {
   manifest: (maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleManifestPayload>
   manifestQuery: (account: AccountInstance, maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleQueryResult<ModuleManifestPayload>>
   moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>
   state: () => Promisable<Payload[]>
   stateQuery: (account: AccountInstance) => Promisable<ModuleQueryResult>
 }
+
+/** @deprecated use QueryableModuleFunctions instead */
+export interface ModuleQueryFunctions extends QueryableModuleFunctions {}

package/src/QueryableModule/QueryableModuleParams.ts

@@ -0,0 +1,20 @@
+import type { CreatableParams } from '@xylabs/sdk-js'
+import type { AccountInstance } from '@xyo-network/account-model'
+
+import type { AnyConfigSchema, ModuleConfig } from '../Config/index.ts'
+import type { ModuleIdentifierTransformer } from '../ModuleIdentifierTransformer.ts'
+import type { ModuleStatusReporter } from '../ModuleStatusReporter.ts'
+
+export interface QueryableModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> extends CreatableParams {
+  account?: AccountInstance | 'random'
+  addToResolvers?: boolean
+  additionalSigners?: AccountInstance[]
+  allowNameResolution?: boolean
+  config: Partial<TConfig>
+  ephemeralQueryAccountEnabled?: boolean
+  moduleIdentifierTransformers?: ModuleIdentifierTransformer[]
+  statusReporter?: ModuleStatusReporter
+}
+
+/** @deprecated use QueryableModuleParams instead */
+export interface ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> extends QueryableModuleParams<TConfig> {}

package/src/QueryableModule/asQueryableModule.ts

@@ -0,0 +1,8 @@
+import { AsObjectFactory } from '@xylabs/sdk-js'
+
+import { isQueryableModule } from './isQueryableModule.ts'
+
+export const asQueryableModule = AsObjectFactory.create(isQueryableModule)
+
+/** @deprecated use asQueryableModule instead */
+export const asModule = asQueryableModule

package/src/QueryableModule/asQueryableModuleObject.ts

@@ -0,0 +1,8 @@
+import { AsObjectFactory } from '@xylabs/sdk-js'
+
+import { isQueryableModuleObject } from './isQueryableModuleObject.ts'
+
+export const asQueryableModuleObject = AsObjectFactory.create(isQueryableModuleObject)
+
+/** @deprecated use asQueryableModuleObject instead */
+export const asModuleObject = asQueryableModuleObject

package/src/QueryableModule/index.ts

@@ -0,0 +1,9 @@
+export * from './asQueryableModule.ts'
+export * from './asQueryableModuleObject.ts'
+export * from './isQueryableModule.ts'
+export * from './IsQueryableModuleFactory.ts'
+export * from './isQueryableModuleObject.ts'
+export * from './QueryableModule.ts'
+export * from './QueryableModuleFields.ts'
+export * from './QueryableModuleFunctions.ts'
+export * from './QueryableModuleParams.ts'

package/src/QueryableModule/isQueryableModule.ts

@@ -0,0 +1,20 @@
+import type { TypeCheck } from '@xylabs/sdk-js'
+import type { Schema } from '@xyo-network/payload-model'
+
+import { ModuleStateQuerySchema } from '../Queries/index.ts'
+import { IsQueryableModuleFactory } from './IsQueryableModuleFactory.ts'
+import { isQueryableModuleObject } from './isQueryableModuleObject.ts'
+import type { QueryableModule } from './QueryableModule.ts'
+
+export const requiredQueryableModuleQueries: Schema[] = [ModuleStateQuerySchema]
+
+/** @deprecated use requiredQueryableModuleQueries instead */
+export const requiredModuleQueries: Schema[] = requiredQueryableModuleQueries
+
+// we do not use IsInstanceFactory here to prevent a cycle
+const factory = new IsQueryableModuleFactory<QueryableModule>()
+
+export const isQueryableModule: TypeCheck<QueryableModule> = factory.create(requiredQueryableModuleQueries, [isQueryableModuleObject])
+
+/** @deprecated use isQueryableModule instead */
+export const isModule: TypeCheck<QueryableModule> = isQueryableModule

package/src/QueryableModule/isQueryableModuleObject.ts

@@ -0,0 +1,20 @@
+import type { ObjectTypeShape, TypeCheck } from '@xylabs/sdk-js'
+import { IsObjectFactory } from '@xylabs/sdk-js'
+
+import type { QueryableModule } from './QueryableModule.ts'
+
+export const requiredQueryableModuleShape: ObjectTypeShape = {
+  address: 'string',
+  queries: 'array',
+  query: 'function',
+}
+
+/** @deprecated use requiredQueryableModuleShape instead */
+export const requiredModuleShape: ObjectTypeShape = requiredQueryableModuleShape
+
+const factory = new IsObjectFactory<QueryableModule>()
+
+export const isQueryableModuleObject: TypeCheck<QueryableModule> = factory.create(requiredQueryableModuleShape)
+
+/** @deprecated use isQueryableModuleObject instead */
+export const isModuleObject: TypeCheck<QueryableModule> = isQueryableModuleObject

package/src/index.ts

@@ -6,16 +6,15 @@ export * from './EventsModels/index.ts'
 export * from './instance/index.ts'
 export * from './Labels/index.ts'
 export * from './lib/index.ts'
-export * from './module/index.ts'
 export * from './ModuleDescription.ts'
 export * from './ModuleFactoryLocatorInstance.ts'
 export * from './ModuleIdentifier.ts'
 export * from './ModuleIdentifierTransformer.ts'
-export * from './ModuleParams.ts'
 export * from './ModuleQueryHandlerResult.ts'
 export * from './ModuleQueryResult.ts'
 export * from './ModuleStatusReporter.ts'
 export * from './Payload/index.ts'
 export * from './Queries/index.ts'
+export * from './QueryableModule/index.ts'
 export * from './ResolveHelper/index.ts'
 export * from './withModule.ts'

package/src/instance/Instance.ts

@@ -6,9 +6,11 @@ import { IsObjectFactory, toSafeJsonString } from '@xylabs/sdk-js'
 import type { AccountInstance } from '@xyo-network/account-model'
 
 import type { ModuleEventData } from '../EventsModels/index.ts'
-import type { Module, ModuleQueryFunctions } from '../module/index.ts'
 import type { ModuleIdentifier, ModuleName } from '../ModuleIdentifier.ts'
-import type { ModuleParams } from '../ModuleParams.ts'
+import type {
+  QueryableModule, QueryableModuleFunctions,
+  QueryableModuleParams,
+} from '../QueryableModule/index.ts'
 import type { Direction } from './ObjectFilter.ts'
 import type { ObjectResolver } from './ObjectResolver.ts'
 
@@ -50,10 +52,10 @@ export interface ModuleFamilyFunctions {
   siblings: () => Promisable<ModuleInstance[]>
 }
 
-export interface ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData>
-  extends Module<TParams, TEventData>,
+export interface ModuleInstance<TParams extends QueryableModuleParams = QueryableModuleParams, TEventData extends ModuleEventData = ModuleEventData>
+  extends QueryableModule<TParams, TEventData>,
   ObjectResolver<ModuleInstance>,
-  ModuleQueryFunctions,
+  QueryableModuleFunctions,
   ModuleFamilyFunctions {
   readonly pipeline?: ModulePipeLine
 

package/src/instance/ModuleInstanceParams.ts

@@ -0,0 +1,11 @@
+import type { AnyConfigSchema, ModuleConfig } from '../Config/index.ts'
+import type { QueryableModuleParams } from '../QueryableModule/index.ts'
+import type { ModuleInstance } from './Instance.ts'
+
+export type ModuleInstanceChildrenParams = {
+  privateChildren?: ModuleInstance[]
+  publicChildren?: ModuleInstance[]
+}
+
+export interface ModuleInstanceParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> extends
+  QueryableModuleParams<TConfig>, ModuleInstanceChildrenParams {}

package/src/instance/ObjectResolver.ts

@@ -22,8 +22,6 @@ export type ObjectResolverPriority = typeof ObjectResolverPriority[keyof typeof
 
 export interface ObjectResolver<TResult extends EmptyObject> {
   priority: ObjectResolverPriority
-  /** @deprecated do not pass undefined.  If trying to get all, pass '*' */
-  resolve<T extends TResult = TResult>(): Promisable<T | undefined>
   resolve<T extends TResult = TResult>(all: '*', options?: ObjectFilterOptions<T>): Promisable<T[]>
   resolve<T extends TResult = TResult>(id: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promisable<T | undefined>
   resolve<T extends TResult = TResult>(

package/src/instance/attachable/AttachableInstance.ts

@@ -2,11 +2,11 @@ import type { CreatableInstance, TypeCheck } from '@xylabs/sdk-js'
 import { IsObjectFactory } from '@xylabs/sdk-js'
 
 import type { ModuleEventData } from '../../EventsModels/index.ts'
-import type { ModuleParams } from '../../ModuleParams.ts'
+import type { QueryableModuleParams } from '../../QueryableModule/index.ts'
 import type { ModuleInstance } from '../Instance.ts'
 import type { ModuleResolverInstance } from '../ModuleResolver.ts'
 
-export interface AttachableModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData>
+export interface AttachableModuleInstance<TParams extends QueryableModuleParams = QueryableModuleParams, TEventData extends ModuleEventData = ModuleEventData>
   extends ModuleInstance<TParams, TEventData>, CreatableInstance<TParams, TEventData> {
   config: TParams['config']
   /* 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 */

package/src/instance/index.ts

@@ -3,6 +3,7 @@ export * from './attachable/index.ts'
 export * from './Instance.ts'
 export * from './isModuleInstance.ts'
 export * from './ModuleFilter.ts'
+export * from './ModuleInstanceParams.ts'
 export * from './ModuleRepository.ts'
 export * from './ModuleResolver.ts'
 export * from './ObjectFilter.ts'

package/src/instance/isModuleInstance.ts

@@ -1,7 +1,7 @@
 import type { ObjectTypeShape, TypeCheck } from '@xylabs/sdk-js'
 import { IsObjectFactory } from '@xylabs/sdk-js'
 
-import { isModule } from '../module/index.ts'
+import { isQueryableModule } from '../QueryableModule/index.ts'
 import type { ModuleInstance } from './Instance.ts'
 
 export const requiredModuleInstanceFunctions: ObjectTypeShape = {
@@ -12,4 +12,4 @@ export const requiredModuleInstanceFunctions: ObjectTypeShape = {
 // we do not use IsInstanceFactory here to prevent a cycle
 const factory = new IsObjectFactory<ModuleInstance>()
 
-export const isModuleInstance: TypeCheck<ModuleInstance> = factory.create(requiredModuleInstanceFunctions, [isModule])
+export const isModuleInstance: TypeCheck<ModuleInstance> = factory.create(requiredModuleInstanceFunctions, [isQueryableModule])

package/src/lib/duplicateModules.ts

@@ -1,4 +1,4 @@
-import type { Module } from '../module/index.ts'
+import type { QueryableModule } from '../QueryableModule/index.ts'
 
 /**
  * Used to filter duplicates from an array of modules
@@ -9,6 +9,6 @@ import type { Module } from '../module/index.ts'
  * @returns True if the Module's address is the first occurrence of
  * that address in the array, false otherwise
  */
-export const duplicateModules = (value: Module, index: number, array: Module[]): value is Module => {
+export const duplicateModules = (value: QueryableModule, index: number, array: QueryableModule[]): value is QueryableModule => {
   return array.findIndex(v => v.address === value.address) === index
 }

package/src/withModule.ts

@@ -1,8 +1,6 @@
 import type { TypeCheck } from '@xylabs/sdk-js'
 
-import { isModuleInstance } from './instance/index.ts'
-import { isModule } from './module/index.ts'
-
+/** @deprecated use narrowing instead [ if(is) ] */
 export const WithFactory = {
   create: <T extends object>(typeCheck: TypeCheck<T>) => {
     return <R>(
@@ -15,6 +13,3 @@ export const WithFactory = {
     }
   },
 }
-
-export const withModule = WithFactory.create(isModule)
-export const withModuleInstance = WithFactory.create(isModuleInstance)

package/dist/neutral/ModuleParams.d.ts

@@ -1,21 +0,0 @@
-import type { CreatableParams } from '@xylabs/sdk-js';
-import type { AccountInstance } from '@xyo-network/account-model';
-import type { AnyConfigSchema, ModuleConfig } from './Config/index.ts';
-import type { ModuleInstance } from './instance/index.ts';
-import type { ModuleIdentifierTransformer } from './ModuleIdentifierTransformer.ts';
-import type { ModuleStatusReporter } from './ModuleStatusReporter.ts';
-export type ModuleChildrenParams = {
-    privateChildren?: ModuleInstance[];
-    publicChildren?: ModuleInstance[];
-};
-export interface ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> extends CreatableParams, ModuleChildrenParams {
-    account?: AccountInstance | 'random';
-    addToResolvers?: boolean;
-    additionalSigners?: AccountInstance[];
-    allowNameResolution?: boolean;
-    config: Partial<TConfig>;
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
-    statusReporter?: ModuleStatusReporter;
-}
-//# sourceMappingURL=ModuleParams.d.ts.map

package/dist/neutral/ModuleParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleParams.d.ts","sourceRoot":"","sources":["../../src/ModuleParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AACnF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAErE,MAAM,MAAM,oBAAoB,GAAG;IACjC,eAAe,CAAC,EAAE,cAAc,EAAE,CAAA;IAClC,cAAc,CAAC,EAAE,cAAc,EAAE,CAAA;CAClC,CAAA;AAED,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,CAAE,SAAQ,eAAe,EAAE,oBAAoB;IACxJ,OAAO,CAAC,EAAE,eAAe,GAAG,QAAQ,CAAA;IACpC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAA;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IACxB,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,4BAA4B,CAAC,EAAE,2BAA2B,EAAE,CAAA;IAC5D,cAAc,CAAC,EAAE,oBAAoB,CAAA;CACtC"}

package/dist/neutral/module/IsModuleFactory.d.ts

@@ -1,7 +0,0 @@
-import type { AnyObject, EmptyObject, TypeCheck } from '@xylabs/sdk-js';
-import type { Module } from './Module.ts';
-export type ModuleTypeCheck<T extends Module = Module> = TypeCheck<T>;
-export declare class IsModuleFactory<T extends Module = Module> {
-    create(expectedQueries?: string[], additionalChecks?: TypeCheck<AnyObject | EmptyObject>[]): ModuleTypeCheck<T>;
-}
-//# sourceMappingURL=IsModuleFactory.d.ts.map

package/dist/neutral/module/IsModuleFactory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IsModuleFactory.d.ts","sourceRoot":"","sources":["../../../src/module/IsModuleFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,SAAS,EAAE,WAAW,EAAE,SAAS,EAElC,MAAM,gBAAgB,CAAA;AAIvB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,SAAS,CAAC,CAAC,CAAC,CAAA;AAErE,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACpD,MAAM,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,EAAE,gBAAgB,CAAC,EAAE,SAAS,CAAC,SAAS,GAAG,WAAW,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC;CAchH"}

package/dist/neutral/module/Module.d.ts

@@ -1,7 +0,0 @@
-import type { CreatableInstance } from '@xylabs/sdk-js';
-import type { ModuleEventData } from '../EventsModels/index.ts';
-import type { ModuleParams } from '../ModuleParams.ts';
-import type { ModuleFields } from './ModuleFields.ts';
-export interface Module<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData<object> = ModuleEventData<object>> extends ModuleFields<TParams>, CreatableInstance<TParams, TEventData> {
-}
-//# sourceMappingURL=Module.d.ts.map

package/dist/neutral/module/Module.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../../src/module/Module.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAEvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EAAE,UAAU,SAAS,eAAe,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CACvI,SAAQ,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;CACtE"}

package/dist/neutral/module/ModuleFields.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleFields.d.ts","sourceRoot":"","sources":["../../../src/module/ModuleFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAEhE,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY;IACvE,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEzB,uDAAuD;IACvD,EAAE,EAAE,MAAM,CAAA;IAEV,OAAO,CAAC,EAAE,UAAU,CAAA;IAEpB,MAAM,EAAE,OAAO,CAAA;IAEf,YAAY,EAAE,MAAM,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAElD,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAChG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACpG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;CACzB"}

package/dist/neutral/module/ModuleQueryFunctions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleQueryFunctions.d.ts","sourceRoot":"","sources":["../../../src/module/ModuleQueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAErF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAC/F,aAAa,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC,CAAA;IACjJ,aAAa,EAAE,MAAM,UAAU,CAAC,CAAC,0BAA0B,GAAG,cAAc,CAAC,EAAE,CAAC,CAAA;IAChF,KAAK,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IAClC,UAAU,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,UAAU,CAAC,iBAAiB,CAAC,CAAA;CACxE"}

package/dist/neutral/module/asModule.d.ts

@@ -1,2 +0,0 @@
-export declare const asModule: import("@xylabs/sdk-js").AsTypeFunction<import("./Module.ts").Module<import("../ModuleParams.ts").ModuleParams<import("../index.ts").AnyConfigSchema<import("../index.ts").ModuleConfig>>, import("../index.ts").ModuleEventData<object>>>;
-//# sourceMappingURL=asModule.d.ts.map

package/dist/neutral/module/asModule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"asModule.d.ts","sourceRoot":"","sources":["../../../src/module/asModule.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,QAAQ,4OAAmC,CAAA"}

package/dist/neutral/module/asModuleObject.d.ts

@@ -1,2 +0,0 @@
-export declare const asModuleObject: import("@xylabs/sdk-js").AsTypeFunction<import("./Module.ts").Module<import("../ModuleParams.ts").ModuleParams<import("../index.ts").AnyConfigSchema<import("../index.ts").ModuleConfig>>, import("../index.ts").ModuleEventData<object>>>;
-//# sourceMappingURL=asModuleObject.d.ts.map

package/dist/neutral/module/asModuleObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"asModuleObject.d.ts","sourceRoot":"","sources":["../../../src/module/asModuleObject.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,cAAc,4OAAyC,CAAA"}

package/dist/neutral/module/index.d.ts

@@ -1,9 +0,0 @@
-export * from './asModule.ts';
-export * from './asModuleObject.ts';
-export * from './isModule.ts';
-export * from './IsModuleFactory.ts';
-export * from './isModuleObject.ts';
-export * from './Module.ts';
-export * from './ModuleFields.ts';
-export * from './ModuleQueryFunctions.ts';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/module/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/module/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,eAAe,CAAA;AAC7B,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA"}

package/dist/neutral/module/isModule.d.ts

@@ -1,6 +0,0 @@
-import type { TypeCheck } from '@xylabs/sdk-js';
-import type { Schema } from '@xyo-network/payload-model';
-import type { Module } from './Module.ts';
-export declare const requiredModuleQueries: Schema[];
-export declare const isModule: TypeCheck<Module>;
-//# sourceMappingURL=isModule.d.ts.map

package/dist/neutral/module/isModule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"isModule.d.ts","sourceRoot":"","sources":["../../../src/module/isModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAKxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,eAAO,MAAM,qBAAqB,EAAE,MAAM,EAA6B,CAAA;AAKvE,eAAO,MAAM,QAAQ,EAAE,SAAS,CAAC,MAAM,CAA2D,CAAA"}

package/dist/neutral/module/isModuleObject.d.ts

@@ -1,5 +0,0 @@
-import type { ObjectTypeShape, TypeCheck } from '@xylabs/sdk-js';
-import type { Module } from './Module.ts';
-export declare const requiredModuleShape: ObjectTypeShape;
-export declare const isModuleObject: TypeCheck<Module>;
-//# sourceMappingURL=isModuleObject.d.ts.map

package/dist/neutral/module/isModuleObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"isModuleObject.d.ts","sourceRoot":"","sources":["../../../src/module/isModuleObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAGhE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,eAAO,MAAM,mBAAmB,EAAE,eAIjC,CAAA;AAID,eAAO,MAAM,cAAc,EAAE,SAAS,CAAC,MAAM,CAAuC,CAAA"}

package/src/ModuleParams.ts

@@ -1,23 +0,0 @@
-import type { CreatableParams } from '@xylabs/sdk-js'
-import type { AccountInstance } from '@xyo-network/account-model'
-
-import type { AnyConfigSchema, ModuleConfig } from './Config/index.ts'
-import type { ModuleInstance } from './instance/index.ts'
-import type { ModuleIdentifierTransformer } from './ModuleIdentifierTransformer.ts'
-import type { ModuleStatusReporter } from './ModuleStatusReporter.ts'
-
-export type ModuleChildrenParams = {
-  privateChildren?: ModuleInstance[]
-  publicChildren?: ModuleInstance[]
-}
-
-export interface ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> extends CreatableParams, ModuleChildrenParams {
-  account?: AccountInstance | 'random'
-  addToResolvers?: boolean
-  additionalSigners?: AccountInstance[]
-  allowNameResolution?: boolean
-  config: Partial<TConfig>
-  ephemeralQueryAccountEnabled?: boolean
-  moduleIdentifierTransformers?: ModuleIdentifierTransformer[]
-  statusReporter?: ModuleStatusReporter
-}