@xyo-network/module-model 2.64.10 → 2.65.0

package/dist/types/Queries/Manifest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Manifest.d.ts","sourceRoot":"","sources":["../../../src/Queries/Manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhC,MAAM,MAAM,yBAAyB,GAAG,mCAAmC,CAAA;AAC3E,eAAO,MAAM,yBAAyB,EAAE,yBAA+D,CAAA;AAEvG,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC;IACtC,MAAM,EAAE,yBAAyB,CAAA;CAClC,CAAC,CAAA"}
+{"version":3,"file":"Manifest.d.ts","sourceRoot":"","sources":["../../../src/Queries/Manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,MAAM,MAAM,yBAAyB,GAAG,mCAAmC,CAAA;AAC3E,eAAO,MAAM,yBAAyB,EAAE,yBAA+D,CAAA;AAEvG,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC;IACtC,MAAM,EAAE,yBAAyB,CAAA;CAClC,CAAC,CAAA"}

package/dist/types/Queries/ModuleAddress/Query.d.ts

@@ -1,4 +1,4 @@
-import { Query } from '../../Query';
+import { Query } from '@xyo-network/payload-model';
 export type ModuleAddressQuerySchema = 'network.xyo.query.module.address';
 export declare const ModuleAddressQuerySchema: ModuleAddressQuerySchema;
 export type ModuleAddressQuery = Query<{

package/dist/types/Queries/ModuleAddress/Query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/Query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,MAAM,MAAM,wBAAwB,GAAG,kCAAkC,CAAA;AACzE,eAAO,MAAM,wBAAwB,EAAE,wBAA6D,CAAA;AAEpG,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;IACrC,MAAM,EAAE,wBAAwB,CAAA;CACjC,CAAC,CAAA"}
+{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/Query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,MAAM,MAAM,wBAAwB,GAAG,kCAAkC,CAAA;AACzE,eAAO,MAAM,wBAAwB,EAAE,wBAA6D,CAAA;AAEpG,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;IACrC,MAAM,EAAE,wBAAwB,CAAA;CACjC,CAAC,CAAA"}

package/dist/types/Queries/Subscribe.d.ts

@@ -1,4 +1,4 @@
-import { Query } from '../Query';
+import { Query } from '@xyo-network/payload-model';
 export type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe';
 export declare const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema;
 export interface ModuleSubscribeFilter {

package/dist/types/Queries/Subscribe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Subscribe.d.ts","sourceRoot":"","sources":["../../../src/Queries/Subscribe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhC,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAA;AAC7E,eAAO,MAAM,0BAA0B,EAAE,0BAAiE,CAAA;AAE1G,MAAM,WAAW,qBAAqB;IACpC,qHAAqH;IACrH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAGD,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC;IACvC,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAA;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACrC,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,0BAA0B,CAAA;CACnC,CAAC,CAAA"}
+{"version":3,"file":"Subscribe.d.ts","sourceRoot":"","sources":["../../../src/Queries/Subscribe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAA;AAC7E,eAAO,MAAM,0BAA0B,EAAE,0BAAiE,CAAA;AAE1G,MAAM,WAAW,qBAAqB;IACpC,qHAAqH;IACrH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAGD,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC;IACvC,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAA;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACrC,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,0BAA0B,CAAA;CACnC,CAAC,CAAA"}

package/dist/types/Queries/index.d.ts

@@ -1,4 +1,4 @@
-import { Query } from '../Query';
+import { Query } from '@xyo-network/payload-model';
 import { ModuleDescribeQuery } from './Describe';
 import { ModuleDiscoverQuery } from './Discover';
 import { ModuleAddressQuery } from './ModuleAddress';

package/dist/types/Queries/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAE3B,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,mBAAmB,CAAA;AAEnH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,KAAK,GAAG,eAAe,GAAG,CAAC,GAAG,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAE3B,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,mBAAmB,CAAA;AAEnH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,KAAK,GAAG,eAAe,GAAG,CAAC,GAAG,eAAe,CAAA"}

package/dist/types/index.d.ts

@@ -1,15 +1,17 @@
 export * from './asModule';
 export * from './Config';
 export * from './CreatableModule';
-export * from './Error';
+export * from './CreatableModuleDictionary';
+export * from './Events';
 export * from './isModule';
+export * from './lib';
 export * from './Module';
 export * from './ModuleDescription';
+export * from './ModuleFactory';
 export * from './ModuleFilter';
 export * from './ModuleParams';
 export * from './ModuleQueryResult';
 export * from './ModuleRepository';
 export * from './Queries';
-export * from './Query';
 export * from './withModule';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"duplicateModules.d.ts","sourceRoot":"","sources":["../../../src/lib/duplicateModules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,UAAW,cAAc,SAAS,MAAM,SAAS,cAAc,EAAE,4BAE7F,CAAA"}

package/dist/types/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './duplicateModules';
+export * from './serializable';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA"}

package/dist/types/lib/serializable.d.ts

@@ -0,0 +1,3 @@
+export declare const serializable: (field: unknown, depth?: number) => boolean | null;
+export declare const serializableField: (field: unknown) => boolean;
+//# sourceMappingURL=serializable.d.ts.map

package/dist/types/lib/serializable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializable.d.ts","sourceRoot":"","sources":["../../../src/lib/serializable.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,YAAY,UAAW,OAAO,UAAU,MAAM,KAAG,OAAO,GAAG,IAqBvE,CAAA;AAED,eAAO,MAAM,iBAAiB,UAAW,OAAO,YAE/C,CAAA"}

package/package.json

@@ -11,19 +11,21 @@
   },
   "dependencies": {
     "@xylabs/assert": "^2.9.3",
-    "@xyo-network/account-model": "^2.64.10",
-    "@xyo-network/address-payload-plugin": "^2.64.10",
-    "@xyo-network/boundwitness-model": "^2.64.10",
-    "@xyo-network/core": "^2.64.10",
-    "@xyo-network/manifest-model": "^2.64.10",
-    "@xyo-network/module-events": "^2.64.10",
-    "@xyo-network/payload-model": "^2.64.10",
-    "@xyo-network/promise": "^2.64.10",
-    "@xyo-network/wallet-model": "^2.64.10"
+    "@xyo-network/account-model": "^2.65.0",
+    "@xyo-network/address-payload-plugin": "^2.65.0",
+    "@xyo-network/boundwitness-builder": "^2.65.0",
+    "@xyo-network/boundwitness-model": "^2.65.0",
+    "@xyo-network/core": "^2.65.0",
+    "@xyo-network/manifest-model": "^2.65.0",
+    "@xyo-network/module-events": "^2.65.0",
+    "@xyo-network/payload-model": "^2.65.0",
+    "@xyo-network/promise": "^2.65.0",
+    "@xyo-network/wallet-model": "^2.65.0",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.18.7",
-    "@xylabs/tsconfig": "^2.18.7",
+    "@xylabs/ts-scripts-yarn3": "^2.18.10",
+    "@xylabs/tsconfig": "^2.18.10",
     "typescript": "^5.1.6"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -59,5 +61,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.64.10"
+  "version": "2.65.0"
 }

package/src/CreatableModule.ts

@@ -1,18 +1,18 @@
 import { Logger } from '@xyo-network/core'
 
-import { Module } from './Module'
+import { IndirectModule } from './Module'
 
-export interface CreatableModule<T extends Module = Module> {
+export interface CreatableModule<T extends IndirectModule = IndirectModule> {
   configSchema: string
   configSchemas: string[]
   defaultLogger?: Logger
   new (privateConstructorKey: string, params: T['params']): T
-  create<T extends Module>(this: CreatableModule<T>, params?: T['params']): Promise<T>
-  factory<T extends Module>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>
+  create<T extends IndirectModule>(this: CreatableModule<T>, params?: T['params']): Promise<T>
+  factory<T extends IndirectModule>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>
 }
 
-export type CreatableModuleFactory<T extends Module = Module> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {
-  create<T extends Module>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>
+export type CreatableModuleFactory<T extends IndirectModule = IndirectModule> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {
+  create<T extends IndirectModule>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>
 }
 
 /**
@@ -21,7 +21,7 @@ export type CreatableModuleFactory<T extends Module = Module> = Omit<Omit<Creata
  * @returns The decorated Module requiring it implement the members
  * of the CreatableModule as statics properties/methods
  */
-export function creatableModule<TModule extends Module = Module>() {
+export function creatableModule<TModule extends IndirectModule = IndirectModule>() {
   return <U extends CreatableModule<TModule>>(constructor: U) => {
     constructor
   }

package/src/CreatableModuleDictionary.ts

@@ -0,0 +1,5 @@
+import { CreatableModuleFactory } from './CreatableModule'
+
+export interface CreatableModuleDictionary {
+  [key: string]: CreatableModuleFactory
+}

package/src/Events/ModuleBusy.ts

@@ -0,0 +1,9 @@
+import { EventData } from '@xyo-network/module-events'
+
+import { IndirectModule, ModuleEventArgs } from '../Module'
+
+export type ModuleBusyEventArgs<TModule extends IndirectModule = IndirectModule> = ModuleEventArgs<TModule, { busy: boolean }>
+
+export interface ModuleBusyEventData extends EventData {
+  moduleBusy: ModuleBusyEventArgs
+}

package/src/Events/ModuleQueried.ts

@@ -0,0 +1,19 @@
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder'
+import { EventData } from '@xyo-network/module-events'
+import { Payload } from '@xyo-network/payload-model'
+
+import { IndirectModule, ModuleEventArgs } from '../Module'
+import { ModuleQueryResult } from '../ModuleQueryResult'
+
+export type ModuleQueriedEventArgs = ModuleEventArgs<
+  IndirectModule,
+  {
+    payloads?: Payload[]
+    query: QueryBoundWitness
+    result: ModuleQueryResult
+  }
+>
+
+export interface ModuleQueriedEventData extends EventData {
+  moduleQueried: ModuleQueriedEventArgs
+}

package/src/Events/index.ts

@@ -0,0 +1,2 @@
+export * from './ModuleBusy'
+export * from './ModuleQueried'

package/src/Module.ts

@@ -1,32 +1,28 @@
 import { AccountInstance } from '@xyo-network/account-model'
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder'
 import { ModuleManifestPayload } from '@xyo-network/manifest-model'
-import { EventArgs, EventData, EventFunctions } from '@xyo-network/module-events'
+import { EventArgs, EventFunctions } from '@xyo-network/module-events'
 import { Payload } from '@xyo-network/payload-model'
 import { Promisable } from '@xyo-network/promise'
 
 import { AnyConfigSchema, ModuleConfig } from './Config'
+import { ModuleBusyEventData, ModuleQueriedEventData } from './Events'
 import { ModuleDescription } from './ModuleDescription'
 import { ModuleFilter } from './ModuleFilter'
 import { ModuleParams } from './ModuleParams'
 import { ModuleQueryResult } from './ModuleQueryResult'
 import { AddressPreviousHashPayload } from './Queries'
-import { QueryBoundWitness } from './Query'
 
-export interface ModuleResolver {
+export interface ResolveFunctions {
+  resolve<TModule extends Module = Module>(filter?: ModuleFilter): Promisable<TModule[]>
+  resolve<TModule extends Module = Module>(nameOrAddress: string): Promisable<TModule | undefined>
+  resolve<TModule extends Module = Module>(nameOrAddressOrFilter?: ModuleFilter | string): Promisable<TModule | TModule[] | undefined>
+}
+
+export interface ModuleResolver extends ResolveFunctions {
   addResolver: (resolver: ModuleResolver) => this
   isModuleResolver: boolean
   removeResolver: (resolver: ModuleResolver) => this
-  /**
-   * Resolves all modules matching the supplied filter. If no filter
-   * is supplied, all modules are returned
-   * @param filter Filter criteria for the desired modules
-   */
-  resolve<T extends IndirectModule = IndirectModule>(filter?: ModuleFilter): Promisable<T[]>
-  /**
-   * Resolves a single module, or undefined if no modules matched the filter.
-   * @param filter The desired Module's Address or Name
-   */
-  resolveOne<T extends IndirectModule = IndirectModule>(filter: string): Promisable<T | undefined>
 }
 
 export type ModuleEventArgs<
@@ -40,18 +36,7 @@ export type ModuleEventArgs<
       module: TModule
     }
 
-export type ModuleQueriedEventArgs = ModuleEventArgs<
-  IndirectModule,
-  {
-    payloads?: Payload[]
-    query: QueryBoundWitness
-    result: ModuleQueryResult
-  }
->
-
-export interface ModuleEventData extends EventData {
-  moduleQueried: ModuleQueriedEventArgs
-}
+export interface ModuleEventData extends ModuleQueriedEventData, ModuleBusyEventData {}
 
 export type ModuleQueryFunctions = {
   addressPreviousHash: () => Promisable<AddressPreviousHashPayload>
@@ -100,7 +85,7 @@ export type IndirectModule<
 export type DirectModule<
   TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
   TEventData extends ModuleEventData = ModuleEventData,
-> = IndirectModule<TParams, TEventData> & ModuleQueryFunctions
+> = IndirectModule<TParams, TEventData> & ModuleQueryFunctions & ResolveFunctions
 
 export type ModuleInstance<
   TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,

package/src/ModuleFactory.ts

@@ -0,0 +1,40 @@
+import { Logger } from '@xyo-network/core'
+import merge from 'lodash/merge'
+
+import { CreatableModule, CreatableModuleFactory } from './CreatableModule'
+import { IndirectModule } from './Module'
+
+export class ModuleFactory<TModule extends IndirectModule> implements CreatableModuleFactory<TModule> {
+  configSchemas: CreatableModuleFactory<TModule>['configSchemas']
+
+  creatableModule: CreatableModule<TModule>
+
+  defaultLogger?: Logger | undefined
+
+  defaultParams?: TModule['params']
+
+  constructor(creatableModule: CreatableModule<TModule>, params?: TModule['params']) {
+    this.creatableModule = creatableModule
+    this.defaultParams = params
+    this.configSchemas = creatableModule.configSchemas
+  }
+
+  get configSchema(): string {
+    return this.configSchemas[0]
+  }
+
+  static withParams<T extends IndirectModule>(creatableModule: CreatableModule<T>, params?: T['params']) {
+    return new ModuleFactory(creatableModule, params)
+  }
+
+  create<T extends IndirectModule>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T> {
+    const factory = this as ModuleFactory<T>
+    const schema = factory.creatableModule.configSchema
+    const mergedParams: TModule['params'] = merge(factory.defaultParams ?? {}, params, { config: { schema } })
+    return factory.creatableModule.create<T>(mergedParams)
+  }
+
+  factory<T extends IndirectModule>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T> {
+    throw new Error('Method not implemented.')
+  }
+}

package/src/ModuleQueryResult.ts

@@ -1,4 +1,4 @@
 import { BoundWitness } from '@xyo-network/boundwitness-model'
 import { Payload } from '@xyo-network/payload-model'
 
-export type ModuleQueryResult<T extends Payload = Payload> = [BoundWitness, T[], Payload[]]
+export type ModuleQueryResult<E extends Payload[] = Payload[]> = [BoundWitness, Payload[], E]

package/src/Queries/Describe/Query.ts

@@ -1,4 +1,4 @@
-import { Query } from '../../Query'
+import { Query } from '@xyo-network/payload-model'
 
 export type ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'
 export const ModuleDescribeQuerySchema: ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'

package/src/Queries/Discover.ts

@@ -1,4 +1,4 @@
-import { Query } from '../Query'
+import { Query } from '@xyo-network/payload-model'
 
 export type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'
 export const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'

package/src/Queries/Manifest.ts

@@ -1,4 +1,4 @@
-import { Query } from '../Query'
+import { Query } from '@xyo-network/payload-model'
 
 export type ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'
 export const ModuleManifestQuerySchema: ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'

package/src/Queries/ModuleAddress/Query.ts

@@ -1,4 +1,4 @@
-import { Query } from '../../Query'
+import { Query } from '@xyo-network/payload-model'
 
 export type ModuleAddressQuerySchema = 'network.xyo.query.module.address'
 export const ModuleAddressQuerySchema: ModuleAddressQuerySchema = 'network.xyo.query.module.address'

package/src/Queries/Subscribe.ts

@@ -1,4 +1,4 @@
-import { Query } from '../Query'
+import { Query } from '@xyo-network/payload-model'
 
 export type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
 export const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'

package/src/Queries/index.ts

@@ -1,4 +1,5 @@
-import { Query } from '../Query'
+import { Query } from '@xyo-network/payload-model'
+
 import { ModuleDescribeQuery } from './Describe'
 import { ModuleDiscoverQuery } from './Discover'
 import { ModuleAddressQuery } from './ModuleAddress'

package/src/index.ts

@@ -1,14 +1,16 @@
 export * from './asModule'
 export * from './Config'
 export * from './CreatableModule'
-export * from './Error'
+export * from './CreatableModuleDictionary'
+export * from './Events'
 export * from './isModule'
+export * from './lib'
 export * from './Module'
 export * from './ModuleDescription'
+export * from './ModuleFactory'
 export * from './ModuleFilter'
 export * from './ModuleParams'
 export * from './ModuleQueryResult'
 export * from './ModuleRepository'
 export * from './Queries'
-export * from './Query'
 export * from './withModule'

package/src/lib/duplicateModules.ts

@@ -0,0 +1,14 @@
+import { IndirectModule } from '../Module'
+
+/**
+ * Used to filter duplicates from an array of modules
+ * @example: modulesArray.filter(duplicateModules)
+ * @param value Current Module
+ * @param index Current Module's index
+ * @param array Module Array
+ * @returns True if the Module's address is the first occurrence of
+ * that address in the array, false otherwise
+ */
+export const duplicateModules = (value: IndirectModule, index: number, array: IndirectModule[]): value is IndirectModule => {
+  return array.findIndex((v) => v.address === value.address) === index
+}

package/src/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './duplicateModules'
+export * from './serializable'

package/src/lib/serializable.ts

@@ -0,0 +1,41 @@
+// Inspired by https://stackoverflow.com/a/49079549/2803259
+
+import every from 'lodash/every'
+import isArray from 'lodash/isArray'
+import isBoolean from 'lodash/isBoolean'
+import isNull from 'lodash/isNull'
+import isNumber from 'lodash/isNumber'
+import isPlainObject from 'lodash/isPlainObject'
+import isString from 'lodash/isString'
+import isUndefined from 'lodash/isUndefined'
+import overSome from 'lodash/overSome'
+
+const JSONPrimitiveChecks = [isUndefined, isNull, isBoolean, isNumber, isString]
+const JSONComplexChecks = [isPlainObject, isArray]
+
+export const serializable = (field: unknown, depth?: number): boolean | null => {
+  let depthExceeded = false
+  const decrementDepth = () => (depth ? depth-- : undefined)
+
+  const recursiveSerializable = (field: unknown) => {
+    if (depth !== undefined && depth < 1) {
+      depthExceeded = true
+      return false
+    }
+
+    // decrement during every recursion
+    decrementDepth()
+
+    const nestedSerializable = (field: unknown): boolean => overSome(JSONComplexChecks)(field) && every(field as object, recursiveSerializable)
+
+    return overSome([...JSONPrimitiveChecks, nestedSerializable])(field)
+  }
+
+  const valid = recursiveSerializable(field)
+
+  return depthExceeded ? null : valid
+}
+
+export const serializableField = (field: unknown) => {
+  return overSome([...JSONPrimitiveChecks, ...JSONComplexChecks])(field)
+}

package/dist/cjs/Error.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModuleErrorSchema = void 0;
-exports.ModuleErrorSchema = 'network.xyo.error.module';
-//# sourceMappingURL=Error.js.map

package/dist/cjs/Error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":";;;AAGa,QAAA,iBAAiB,GAAsB,0BAA0B,CAAA"}

package/dist/cjs/Query/Payload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../src/Query/Payload.ts"],"names":[],"mappings":""}

package/dist/cjs/Query/QueryBoundWitness.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isQueryBoundWitness = exports.QueryBoundWitnessSchema = void 0;
-const boundwitness_model_1 = require("@xyo-network/boundwitness-model");
-exports.QueryBoundWitnessSchema = boundwitness_model_1.BoundWitnessSchema;
-const isQueryBoundWitness = (x) => (0, boundwitness_model_1.isBoundWitness)(x) && (x === null || x === void 0 ? void 0 : x.query) !== undefined;
-exports.isQueryBoundWitness = isQueryBoundWitness;
-//# sourceMappingURL=QueryBoundWitness.js.map

package/dist/cjs/Query/QueryBoundWitness.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryBoundWitness.js","sourceRoot":"","sources":["../../../src/Query/QueryBoundWitness.ts"],"names":[],"mappings":";;;AAAA,wEAAkG;AAIrF,QAAA,uBAAuB,GAA4B,uCAAkB,CAAA;AAQ3E,MAAM,mBAAmB,GAAG,CAAC,CAAkB,EAA0B,EAAE,CAAC,IAAA,mCAAc,EAAC,CAAC,CAAC,IAAI,CAAC,CAAuB,aAAvB,CAAC,uBAAD,CAAC,CAAwB,KAAK,MAAK,SAAS,CAAA;AAAxI,QAAA,mBAAmB,uBAAqH"}

package/dist/cjs/Query/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./Payload"), exports);
-tslib_1.__exportStar(require("./QueryBoundWitness"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/Query/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Query/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,8DAAmC"}