@xyo-network/node-model 5.3.20 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/node-model",
-  "version": "5.3.20",
+  "version": "5.3.24",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,23 +30,31 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
-    "!**/*.test.*"
+    "!**/*.test.*",
+    "README.md"
   ],
   "dependencies": {
-    "@xyo-network/account-model": "~5.3.20",
-    "@xyo-network/module-model": "~5.3.20",
-    "@xyo-network/payload-model": "~5.3.20"
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/account-model": "~5.3.24"
   },
   "devDependencies": {
-    "@xylabs/sdk-js": "^5.0.90",
-    "@xylabs/ts-scripts-common": "~7.5.6",
-    "@xylabs/ts-scripts-yarn3": "~7.5.6",
-    "@xylabs/tsconfig": "~7.5.6",
+    "@opentelemetry/api": "^1.9.1",
+    "@types/node": "^25.5.0",
+    "@xylabs/sdk-js": "^5.0.93",
+    "@xylabs/ts-scripts-common": "~7.6.16",
+    "@xylabs/ts-scripts-pnpm": "~7.6.16",
+    "@xylabs/tsconfig": "~7.6.16",
+    "acorn": "^8.16.0",
+    "axios": "^1.14.0",
+    "esbuild": "^0.28.0",
     "typescript": "~5.9.3",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/account-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
@@ -55,4 +63,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/ChildCertification.ts

@@ -1,12 +0,0 @@
-import type { Address } from '@xylabs/sdk-js'
-import { asSchema, type Payload } from '@xyo-network/payload-model'
-
-export const ChildCertificationSchema = asSchema('network.xyo.child.certification', true)
-export type ChildCertificationSchema = typeof ChildCertificationSchema
-
-export interface ChildCertificationFields {
-  address: Address
-  expiration: number
-}
-
-export type ChildCertification = Payload<ChildCertificationFields, ChildCertificationSchema>

package/src/Config.ts

@@ -1,24 +0,0 @@
-import type { EmptyObject, WithAdditional } from '@xylabs/sdk-js'
-import type { ModuleConfig } from '@xyo-network/module-model'
-import type {
-  Payload,
-  Schema,
-} from '@xyo-network/payload-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-export const NodeConfigSchema = asSchema('network.xyo.node.config', true)
-export type NodeConfigSchema = typeof NodeConfigSchema
-
-export type NodeConfig<TConfig extends EmptyObject | Payload | void = void, TSchema extends Schema | void = void> = ModuleConfig<
-  WithAdditional<
-    {
-      archivist?: string
-    },
-    TConfig
-  >,
-  TSchema extends void
-    ? TConfig extends Payload
-      ? TConfig['schema']
-      : NodeConfigSchema
-    : TSchema
->

package/src/EventsModels/ModuleAttached.ts

@@ -1,8 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-
-export type ModuleAttachedEventArgs<TModule extends QueryableModule = QueryableModule> = ModuleEventArgs<TModule>
-
-export interface ModuleAttachedEventData extends EventData {
-  moduleAttached: ModuleAttachedEventArgs
-}

package/src/EventsModels/ModuleDetached.ts

@@ -1,8 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-
-export type ModuleDetachedEventArgs<TModule extends QueryableModule = QueryableModule> = ModuleEventArgs<TModule>
-
-export interface ModuleDetachedEventData extends EventData {
-  moduleDetached: ModuleDetachedEventArgs
-}

package/src/EventsModels/ModuleRegistered.ts

@@ -1,8 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-
-export type ModuleRegisteredEventArgs<TModule extends QueryableModule = QueryableModule> = ModuleEventArgs<TModule>
-
-export interface ModuleRegisteredEventData extends EventData {
-  moduleRegistered: ModuleRegisteredEventArgs
-}

package/src/EventsModels/ModuleUnregistered.ts

@@ -1,8 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-
-export type ModuleUnregisteredEventArgs<TModule extends QueryableModule = QueryableModule> = ModuleEventArgs<TModule>
-
-export interface ModuleUnregisteredEventData extends EventData {
-  moduleUnregistered: ModuleUnregisteredEventArgs
-}

package/src/EventsModels/index.ts

@@ -1,4 +0,0 @@
-export * from './ModuleAttached.ts'
-export * from './ModuleDetached.ts'
-export * from './ModuleRegistered.ts'
-export * from './ModuleUnregistered.ts'

package/src/Node.ts

@@ -1,16 +0,0 @@
-import type { ModuleEventData, QueryableModule } from '@xyo-network/module-model'
-
-import type {
-  ModuleAttachedEventData, ModuleDetachedEventData, ModuleRegisteredEventData, ModuleUnregisteredEventData,
-} from './EventsModels/index.ts'
-import type { NodeParams } from './Params.ts'
-
-export interface NodeModuleEventData
-  extends ModuleAttachedEventData,
-  ModuleDetachedEventData,
-  ModuleRegisteredEventData,
-  ModuleUnregisteredEventData,
-  ModuleEventData {}
-
-export interface NodeModule<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData>
-  extends QueryableModule<TParams, TEventData> {}

package/src/Params.ts

@@ -1,13 +0,0 @@
-import type {
-  AnyConfigSchema, ModuleInstanceParams, QueryableModuleParams,
-} from '@xyo-network/module-model'
-
-import type { NodeConfig } from './Config.ts'
-
-export interface NodeParams<
-  TConfig extends AnyConfigSchema<NodeConfig> = AnyConfigSchema<NodeConfig>,
-> extends QueryableModuleParams<TConfig> {}
-
-export interface NodeInstanceParams<
-  TConfig extends AnyConfigSchema<NodeConfig> = AnyConfigSchema<NodeConfig>,
-> extends ModuleInstanceParams<TConfig> {}

package/src/Queries/Attach.ts

@@ -1,11 +0,0 @@
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import { asSchema, type Query } from '@xyo-network/payload-model'
-
-export const NodeAttachQuerySchema = asSchema('network.xyo.query.node.attach', true)
-export type NodeAttachQuerySchema = typeof NodeAttachQuerySchema
-
-export type NodeAttachQuery = Query<{
-  external?: boolean
-  id: ModuleIdentifier
-  schema: NodeAttachQuerySchema
-}>

package/src/Queries/Attached.ts

@@ -1,8 +0,0 @@
-import { asSchema, type Query } from '@xyo-network/payload-model'
-
-export const NodeAttachedQuerySchema = asSchema('network.xyo.query.node.attached', true)
-export type NodeAttachedQuerySchema = typeof NodeAttachedQuerySchema
-
-export type NodeAttachedQuery = Query<{
-  schema: NodeAttachedQuerySchema
-}>

package/src/Queries/Certify.ts

@@ -1,10 +0,0 @@
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import { asSchema, type Query } from '@xyo-network/payload-model'
-
-export const NodeCertifyQuerySchema = asSchema('network.xyo.query.node.certify', true)
-export type NodeCertifyQuerySchema = typeof NodeCertifyQuerySchema
-
-export type NodeCertifyQuery = Query<{
-  id: ModuleIdentifier
-  schema: NodeCertifyQuerySchema
-}>

package/src/Queries/Detach.ts

@@ -1,10 +0,0 @@
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import { asSchema, type Query } from '@xyo-network/payload-model'
-
-export const NodeDetachQuerySchema = asSchema('network.xyo.query.node.detach', true)
-export type NodeDetachQuerySchema = typeof NodeDetachQuerySchema
-
-export type NodeDetachQuery = Query<{
-  id: ModuleIdentifier
-  schema: NodeDetachQuerySchema
-}>

package/src/Queries/Registered.ts

@@ -1,8 +0,0 @@
-import { asSchema, type Query } from '@xyo-network/payload-model'
-
-export const NodeRegisteredQuerySchema = asSchema('network.xyo.query.node.registered', true)
-export type NodeRegisteredQuerySchema = typeof NodeRegisteredQuerySchema
-
-export type NodeRegisteredQuery = Query<{
-  schema: NodeRegisteredQuerySchema
-}>

package/src/Queries/index.ts

@@ -1,16 +0,0 @@
-import type { ModuleQueries } from '@xyo-network/module-model'
-
-import type { NodeAttachQuery } from './Attach.ts'
-import type { NodeAttachedQuery } from './Attached.ts'
-import type { NodeCertifyQuery } from './Certify.ts'
-import type { NodeDetachQuery } from './Detach.ts'
-import type { NodeRegisteredQuery } from './Registered.ts'
-
-export * from './Attach.ts'
-export * from './Attached.ts'
-export * from './Certify.ts'
-export * from './Detach.ts'
-export * from './Registered.ts'
-
-export type NodeQueries = NodeAttachQuery | NodeCertifyQuery | NodeDetachQuery | NodeAttachedQuery | NodeRegisteredQuery
-export type NodeModuleQueries = ModuleQueries | NodeQueries

package/src/attachable/AttachableInstance.ts

@@ -1,16 +0,0 @@
-import type { TypeCheck } from '@xylabs/sdk-js'
-import { IsObjectFactory } from '@xylabs/sdk-js'
-import type { AttachableModuleInstance } from '@xyo-network/module-model'
-
-import type { NodeInstance } from '../instance.ts'
-import type { NodeModule, NodeModuleEventData } from '../Node.ts'
-import type { NodeParams } from '../Params.ts'
-
-export interface AttachableNodeInstance<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData>
-  extends NodeModule<TParams, TEventData>,
-  AttachableModuleInstance<TParams, TEventData>,
-  NodeInstance<TParams, TEventData> {}
-
-export type AttachableNodeInstanceTypeCheck<T extends AttachableNodeInstance = AttachableNodeInstance> = TypeCheck<T>
-
-export class IsAttachableNodeInstanceFactory<T extends AttachableNodeInstance = AttachableNodeInstance> extends IsObjectFactory<T> {}

package/src/attachable/asAttachableInstance.ts

@@ -1,5 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-
-import { isAttachableNodeInstance } from './isAttachableInstance.ts'
-
-export const asAttachableNodeInstance = AsObjectFactory.create(isAttachableNodeInstance)

package/src/attachable/index.ts

@@ -1,3 +0,0 @@
-export * from './asAttachableInstance.ts'
-export * from './AttachableInstance.ts'
-export * from './isAttachableInstance.ts'

package/src/attachable/isAttachableInstance.ts

@@ -1,16 +0,0 @@
-import type { ObjectTypeShape, TypeCheck } from '@xylabs/sdk-js'
-import { IsObjectFactory } from '@xylabs/sdk-js'
-import { isAttachableModuleInstance } from '@xyo-network/module-model'
-
-import { isNodeInstance } from '../typeChecks.ts'
-import type { AttachableNodeInstance } from './AttachableInstance.ts'
-
-export const requiredAttachableNodeInstanceFunctions: ObjectTypeShape = {}
-
-// we do not use IsInstanceFactory here to prevent a cycle
-const factory = new IsObjectFactory<AttachableNodeInstance>()
-
-export const isAttachableNodeInstance: TypeCheck<AttachableNodeInstance> = factory.create(requiredAttachableNodeInstanceFunctions, [
-  isNodeInstance,
-  isAttachableModuleInstance,
-])

package/src/index.ts

@@ -1,9 +0,0 @@
-export * from './attachable/index.ts'
-export * from './ChildCertification.ts'
-export * from './Config.ts'
-export * from './EventsModels/index.ts'
-export * from './instance.ts'
-export * from './Node.ts'
-export * from './Params.ts'
-export * from './Queries/index.ts'
-export * from './typeChecks.ts'

package/src/instance.ts

@@ -1,34 +0,0 @@
-import type { Address } from '@xylabs/sdk-js'
-import type { AccountInstance } from '@xyo-network/account-model'
-import type {
-  AddressPayload, AttachableModuleInstance, ModuleIdentifier, ModuleInstance, ModuleQueryResult,
-} from '@xyo-network/module-model'
-
-import type { ChildCertification, ChildCertificationFields } from './ChildCertification.ts'
-import type { NodeModule, NodeModuleEventData } from './Node.ts'
-import type { NodeParams } from './Params.ts'
-
-export interface NodeQueryFunctions {
-  attach: (id: ModuleIdentifier, external?: boolean) => Promise<Address | undefined>
-  attachQuery: (id: ModuleIdentifier, external?: boolean, account?: AccountInstance) => Promise<ModuleQueryResult<AddressPayload>>
-  attached: () => Promise<Address[]>
-  attachedQuery: (account?: AccountInstance) => Promise<ModuleQueryResult<AddressPayload>>
-  certify: (id: ModuleIdentifier) => Promise<ChildCertificationFields | undefined>
-  certifyQuery: (id: ModuleIdentifier, account?: AccountInstance) => Promise<ModuleQueryResult<ChildCertification>>
-  detach: (id: ModuleIdentifier) => Promise<Address | undefined>
-  detachQuery: (id: ModuleIdentifier, account?: AccountInstance) => Promise<ModuleQueryResult<AddressPayload>>
-  registered: () => Promise<Address[]>
-  registeredQuery: (account?: AccountInstance) => Promise<ModuleQueryResult<AddressPayload>>
-}
-
-export interface NodeRegistrationFunctions {
-  register?: (mod: AttachableModuleInstance) => Promise<void>
-  registeredModules?: () => AttachableModuleInstance[]
-  unregister?: (mod: ModuleInstance) => Promise<ModuleInstance>
-}
-
-export interface NodeInstance<TParams extends NodeParams = NodeParams, TEventData extends NodeModuleEventData = NodeModuleEventData>
-  extends NodeModule<TParams, TEventData>,
-  NodeQueryFunctions,
-  NodeRegistrationFunctions,
-  ModuleInstance<TParams, TEventData> {}

package/src/typeChecks.ts

@@ -1,35 +0,0 @@
-import type { TypeCheck } from '@xylabs/sdk-js'
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import {
-  // eslint-disable-next-line sonarjs/deprecation
-  IsInstanceFactory, isModuleInstance, IsQueryableModuleFactory, WithFactory,
-} from '@xyo-network/module-model'
-
-import type { NodeInstance } from './instance.ts'
-import type { NodeModule } from './Node.ts'
-import { NodeAttachedQuerySchema } from './Queries/index.ts'
-
-const instanceFactory = new IsInstanceFactory<NodeInstance>()
-
-export const isNodeInstance: TypeCheck<NodeInstance> = instanceFactory.create(
-  {
-    attach: 'function',
-    attached: 'function',
-    certify: 'function',
-    detach: 'function',
-    registered: 'function',
-  },
-  [isModuleInstance],
-)
-
-export const isNodeModule: TypeCheck<NodeModule> = new IsQueryableModuleFactory<NodeModule>().create([NodeAttachedQuerySchema])
-
-export const asNodeModule = AsObjectFactory.create(isNodeModule)
-export const asNodeInstance = AsObjectFactory.create(isNodeInstance)
-
-/** @deprecated use narrowing instead [ if(is) ] */
-// eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated
-export const withNodeModule = WithFactory.create(isNodeModule)
-/** @deprecated use narrowing instead [ if(is) ] */
-// eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated
-export const withNodeInstance = WithFactory.create(isNodeInstance)