@xyo-network/module-model 2.82.0 → 2.83.0

package/dist/node/withModule.d.cts

@@ -1,6 +1,6 @@
-import { ObjectTypeCheck } from '@xyo-network/object';
+import { TypeCheck } from '@xyo-network/object';
 export declare const WithFactory: {
-    create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
+    create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
 };
 export declare const withModule: <R>(module: any, closure: (module: import("./module").Module) => R) => R | undefined;
 export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance) => R) => R | undefined;

package/dist/node/withModule.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAKrD,eAAO,MAAM,WAAW;6EAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}

package/dist/node/withModule.d.mts

@@ -1,6 +1,6 @@
-import { ObjectTypeCheck } from '@xyo-network/object';
+import { TypeCheck } from '@xyo-network/object';
 export declare const WithFactory: {
-    create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
+    create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
 };
 export declare const withModule: <R>(module: any, closure: (module: import("./module").Module) => R) => R | undefined;
 export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance) => R) => R | undefined;

package/dist/node/withModule.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAKrD,eAAO,MAAM,WAAW;6EAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}

package/dist/node/withModule.d.ts

@@ -1,6 +1,6 @@
-import { ObjectTypeCheck } from '@xyo-network/object';
+import { TypeCheck } from '@xyo-network/object';
 export declare const WithFactory: {
-    create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
+    create: <T extends object>(typeCheck: TypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
 };
 export declare const withModule: <R>(module: any, closure: (module: import("./module").Module) => R) => R | undefined;
 export declare const withModuleInstance: <R>(module: any, closure: (module: import("./instance").ModuleInstance) => R) => R | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAKrD,eAAO,MAAM,WAAW;6EAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAK/C,eAAO,MAAM,WAAW;uEAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}

package/package.json

@@ -15,15 +15,14 @@
     "@xylabs/lodash": "^2.13.20",
     "@xylabs/logger": "^2.13.20",
     "@xylabs/promise": "^2.13.20",
-    "@xyo-network/account-model": "~2.82.0",
-    "@xyo-network/address-payload-plugin": "^2.82.0",
-    "@xyo-network/boundwitness-model": "~2.82.0",
-    "@xyo-network/core": "~2.82.0",
-    "@xyo-network/manifest-model": "~2.82.0",
-    "@xyo-network/module-events": "~2.82.0",
-    "@xyo-network/object": "~2.82.0",
-    "@xyo-network/payload-model": "~2.82.0",
-    "@xyo-network/wallet-model": "~2.82.0"
+    "@xyo-network/account-model": "~2.83.0",
+    "@xyo-network/address-payload-plugin": "^2.82.2",
+    "@xyo-network/boundwitness-model": "~2.83.0",
+    "@xyo-network/manifest-model": "~2.83.0",
+    "@xyo-network/module-events": "~2.83.0",
+    "@xyo-network/object": "~2.83.0",
+    "@xyo-network/payload-model": "~2.83.0",
+    "@xyo-network/wallet-model": "~2.83.0"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^3.2.10",
@@ -70,5 +69,5 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.82.0"
+  "version": "2.83.0"
 }

package/src/Config.ts

@@ -1,5 +1,5 @@
 import { Address } from '@xylabs/hex'
-import { AnyObject, WithAdditional } from '@xyo-network/core'
+import { EmptyObject, WithAdditional } from '@xyo-network/object'
 import { Payload, Schema } from '@xyo-network/payload-model'
 
 import { Labels } from './Labels'
@@ -30,7 +30,7 @@ export interface ArchivingModuleConfig {
 
 export type ModuleConfig<
   TConfig extends Payload | void = void,
-  TAdditionalParams extends AnyObject | void = void,
+  TAdditionalParams extends EmptyObject | void = void,
   TSchema extends Schema | void = void,
 > = Payload<
   WithAdditional<
@@ -85,12 +85,10 @@ export type ModuleConfig<
 
 export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string } = Omit<ModuleConfig, 'schema'> & { schema: string }> =
   ModuleConfig<
-    WithAdditional<
-      Omit<TConfig, 'schema'>,
-      {
-        schema: string
-      }
-    >
+    {
+      schema: string
+    },
+    Omit<TConfig, 'schema'>
   >
 
 export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {

package/src/ModuleParams.ts

@@ -1,12 +1,12 @@
 import { AccountInstance } from '@xyo-network/account-model'
-import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core'
+import { BaseParams, EmptyObject, WithAdditional } from '@xyo-network/object'
 import { WalletInstance } from '@xyo-network/wallet-model'
 
 import { AnyConfigSchema, ModuleConfig } from './Config'
 
 export type ModuleParams<
   TConfig extends AnyConfigSchema<ModuleConfig> | void = void,
-  TAdditionalParams extends AnyObject | void = void,
+  TAdditionalParams extends EmptyObject | void = void,
 > = WithAdditional<
   BaseParams<{
     account?: AccountInstance | 'random'

package/src/instance/ModuleInstance.ts

@@ -1,7 +1,6 @@
 import { Promisable } from '@xylabs/promise'
-import { IsObjectFactory, ObjectTypeCheck } from '@xyo-network/object'
+import { IsObjectFactory, TypeCheck } from '@xyo-network/object'
 
-import { AnyConfigSchema, ModuleConfig } from '../Config'
 import { ModuleEventData } from '../EventsModels'
 import { Module, ModuleQueryFunctions } from '../module'
 import { ModuleParams } from '../ModuleParams'
@@ -21,10 +20,10 @@ export interface ModuleResolver extends ResolveFunctions {
   removeResolver: (resolver: ModuleResolver) => this
 }
 
-export type ModuleInstance<
-  TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
-  TEventData extends ModuleEventData = ModuleEventData,
-> = Module<TParams, TEventData> &
+export type ModuleInstance<TParams extends ModuleParams = ModuleParams, TEventData extends ModuleEventData = ModuleEventData> = Module<
+  TParams,
+  TEventData
+> &
   ResolveFunctions &
   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*/
@@ -35,7 +34,7 @@ export type ModuleInstance<
     readonly upResolver: Omit<ModuleResolver, 'resolve'>
   }
 
-export type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = ObjectTypeCheck<T>
+export type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = TypeCheck<T>
 
 export class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {}
 

package/src/instance/isModuleInstance.ts

@@ -1,4 +1,4 @@
-import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'
+import { IsObjectFactory, ObjectTypeShape, TypeCheck } from '@xyo-network/object'
 
 import { isModule } from '../module'
 import { ModuleInstance } from './ModuleInstance'
@@ -13,4 +13,4 @@ export const requiredModuleInstanceFunctions: ObjectTypeShape = {
 //we do not use IsInstanceFactory here to prevent a cycle
 const factory = new IsObjectFactory<ModuleInstance>()
 
-export const isModuleInstance: ObjectTypeCheck<ModuleInstance> = factory.create(requiredModuleInstanceFunctions, [isModule])
+export const isModuleInstance: TypeCheck<ModuleInstance> = factory.create(requiredModuleInstanceFunctions, [isModule])

package/src/module/IsModuleFactory.ts

@@ -1,19 +1,18 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { ObjectTypeCheck } from '@xyo-network/object'
+import { AnyObject, EmptyObject, TypeCheck } from '@xyo-network/object'
 
 import { asModuleObject } from './asModuleObject'
 import { isModuleObject } from './isModuleObject'
 import { Module } from './Module'
 
-export type ModuleTypeCheck<T extends Module = Module> = ObjectTypeCheck<T>
+export type ModuleTypeCheck<T extends Module = Module> = TypeCheck<T>
 
 export class IsModuleFactory<T extends Module = Module> {
-  create(expectedQueries?: string[], additionalChecks?: ObjectTypeCheck[]): ModuleTypeCheck<T> {
-    return (obj: any, config): obj is T => {
+  create(expectedQueries?: string[], additionalChecks?: TypeCheck<AnyObject | EmptyObject>[]): ModuleTypeCheck<T> {
+    return (obj: unknown, config): obj is T => {
       const module = asModuleObject(obj)
       const result =
         isModuleObject(module, config) &&
-        (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) &&
+        (expectedQueries?.reduce((prev, query) => prev && module.queries.includes(query), true) ?? true) &&
         //perform additional checks
         (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true)
       return result

package/src/module/isModule.ts

@@ -1,4 +1,4 @@
-import { ObjectTypeCheck } from '@xyo-network/object'
+import { TypeCheck } from '@xyo-network/object'
 
 import { ModuleDiscoverQuerySchema } from '../Queries'
 import { IsModuleFactory } from './IsModuleFactory'
@@ -17,4 +17,4 @@ export const requiredModuleQueries: string[] = [
 //we do not use IsInstanceFactory here to prevent a cycle
 const factory = new IsModuleFactory<Module>()
 
-export const isModule: ObjectTypeCheck<Module> = factory.create(requiredModuleQueries, [isModuleObject])
+export const isModule: TypeCheck<Module> = factory.create(requiredModuleQueries, [isModuleObject])

package/src/module/isModuleObject.ts

@@ -1,8 +1,8 @@
-import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'
+import { IsObjectFactory, ObjectTypeShape } from '@xyo-network/object'
 
 import { Module } from './Module'
 
-export const requiredModuleFunctions: ObjectTypeShape = {
+export const requiredModuleShape: ObjectTypeShape = {
   address: 'string',
   config: 'object',
   params: 'object',
@@ -13,4 +13,4 @@ export const requiredModuleFunctions: ObjectTypeShape = {
 
 const factory = new IsObjectFactory<Module>()
 
-export const isModuleObject: ObjectTypeCheck<Module> = factory.create(requiredModuleFunctions)
+export const isModuleObject = factory.create(requiredModuleShape)

package/src/withModule.ts

@@ -1,10 +1,10 @@
-import { ObjectTypeCheck } from '@xyo-network/object'
+import { TypeCheck } from '@xyo-network/object'
 
 import { isModuleInstance } from './instance'
 import { isModule } from './module'
 
 export const WithFactory = {
-  create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => {
+  create: <T extends object>(typeCheck: TypeCheck<T>) => {
     return <R>(
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       module: any,