@xyo-network/sentinel-model 2.75.18 → 2.76.1

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts","../../src/Config.ts","../../src/Queries/Report.ts","../../src/typeChecks.ts"],"sourcesContent":["export * from './Config'\nexport * from './EventData'\nexport * from './EventsModels'\nexport * from './Instance'\nexport * from './Module'\nexport * from './Params'\nexport * from './Queries'\nexport * from './Sentinel'\nexport * from './typeChecks'\n","import { ModuleConfig } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport type SentinelConfigSchema = 'network.xyo.sentinel.config'\nexport const SentinelConfigSchema: SentinelConfigSchema = 'network.xyo.sentinel.config'\n\nexport type SentinelConfig<TConfig extends Payload | void = void> = ModuleConfig<\n  TConfig,\n  {\n    passthrough?: boolean\n    witnesses?: string[]\n  },\n  TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema\n>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\nexport const SentinelReportQuerySchema: SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\n\nexport type SentinelReportQuery = Query<{\n  schema: SentinelReportQuerySchema\n}>\n","import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'\nimport { AsObjectFactory } from '@xyo-network/object'\n\nimport { SentinelInstance } from './Instance'\nimport { SentinelModule } from './Module'\nimport { SentinelReportQuerySchema } from './Queries'\n\nexport const isSentinelInstance = new IsInstanceFactory<SentinelInstance>().create({ report: 'function' }, [isModuleInstance])\nexport const isSentinelModule = new IsModuleFactory<SentinelModule>().create([SentinelReportQuerySchema])\n\nexport const asSentinelModule = AsObjectFactory.create(isSentinelModule)\nexport const asSentinelInstance = AsObjectFactory.create(isSentinelInstance)\nexport const withSentinelModule = WithFactory.create(isSentinelModule)\nexport const withSentinelInstance = WithFactory.create(isSentinelInstance)\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACIO,IAAM,uBAA6C;;;ACDnD,IAAM,4BAAuD;;;ACHpE,0BAAkF;AAClF,oBAAgC;AAMzB,IAAM,qBAAqB,IAAI,sCAAoC,EAAE,OAAO,EAAE,QAAQ,WAAW,GAAG,CAAC,oCAAgB,CAAC;AACtH,IAAM,mBAAmB,IAAI,oCAAgC,EAAE,OAAO,CAAC,yBAAyB,CAAC;AAEjG,IAAM,mBAAmB,8BAAgB,OAAO,gBAAgB;AAChE,IAAM,qBAAqB,8BAAgB,OAAO,kBAAkB;AACpE,IAAM,qBAAqB,gCAAY,OAAO,gBAAgB;AAC9D,IAAM,uBAAuB,gCAAY,OAAO,kBAAkB;","names":[]}
+{"version":3,"sources":["../../src/index.ts","../../src/Config.ts","../../src/Queries/Report.ts","../../src/typeChecks.ts"],"sourcesContent":["export * from './Config'\nexport * from './EventData'\nexport * from './EventsModels'\nexport * from './Instance'\nexport * from './Job'\nexport * from './Module'\nexport * from './Params'\nexport * from './Queries'\nexport * from './Sentinel'\nexport * from './Task'\nexport * from './typeChecks'\n","import { ModuleConfig } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { SentinelTask } from './Task'\n\nexport type SentinelConfigSchema = 'network.xyo.sentinel.config'\nexport const SentinelConfigSchema: SentinelConfigSchema = 'network.xyo.sentinel.config'\n\nexport type SentinelConfig<TConfig extends Payload | void = void> = ModuleConfig<\n  TConfig,\n  {\n    tasks: SentinelTask[]\n  },\n  TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema\n>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\nexport const SentinelReportQuerySchema: SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\n\nexport type SentinelReportQuery = Query<{\n  schema: SentinelReportQuerySchema\n}>\n","import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'\nimport { AsObjectFactory } from '@xyo-network/object'\n\nimport { SentinelInstance } from './Instance'\nimport { SentinelModule } from './Module'\nimport { SentinelReportQuerySchema } from './Queries'\n\nexport const isSentinelInstance = new IsInstanceFactory<SentinelInstance>().create({ report: 'function' }, [isModuleInstance])\nexport const isSentinelModule = new IsModuleFactory<SentinelModule>().create([SentinelReportQuerySchema])\n\nexport const asSentinelModule = AsObjectFactory.create(isSentinelModule)\nexport const asSentinelInstance = AsObjectFactory.create(isSentinelInstance)\nexport const withSentinelModule = WithFactory.create(isSentinelModule)\nexport const withSentinelInstance = WithFactory.create(isSentinelInstance)\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMO,IAAM,uBAA6C;;;ACHnD,IAAM,4BAAuD;;;ACHpE,0BAAkF;AAClF,oBAAgC;AAMzB,IAAM,qBAAqB,IAAI,sCAAoC,EAAE,OAAO,EAAE,QAAQ,WAAW,GAAG,CAAC,oCAAgB,CAAC;AACtH,IAAM,mBAAmB,IAAI,oCAAgC,EAAE,OAAO,CAAC,yBAAyB,CAAC;AAEjG,IAAM,mBAAmB,8BAAgB,OAAO,gBAAgB;AAChE,IAAM,qBAAqB,8BAAgB,OAAO,kBAAkB;AACpE,IAAM,qBAAqB,gCAAY,OAAO,gBAAgB;AAC9D,IAAM,uBAAuB,gCAAY,OAAO,kBAAkB;","names":[]}

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Config.ts","../../src/Queries/Report.ts","../../src/typeChecks.ts"],"sourcesContent":["import { ModuleConfig } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport type SentinelConfigSchema = 'network.xyo.sentinel.config'\nexport const SentinelConfigSchema: SentinelConfigSchema = 'network.xyo.sentinel.config'\n\nexport type SentinelConfig<TConfig extends Payload | void = void> = ModuleConfig<\n  TConfig,\n  {\n    passthrough?: boolean\n    witnesses?: string[]\n  },\n  TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema\n>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\nexport const SentinelReportQuerySchema: SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\n\nexport type SentinelReportQuery = Query<{\n  schema: SentinelReportQuerySchema\n}>\n","import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'\nimport { AsObjectFactory } from '@xyo-network/object'\n\nimport { SentinelInstance } from './Instance'\nimport { SentinelModule } from './Module'\nimport { SentinelReportQuerySchema } from './Queries'\n\nexport const isSentinelInstance = new IsInstanceFactory<SentinelInstance>().create({ report: 'function' }, [isModuleInstance])\nexport const isSentinelModule = new IsModuleFactory<SentinelModule>().create([SentinelReportQuerySchema])\n\nexport const asSentinelModule = AsObjectFactory.create(isSentinelModule)\nexport const asSentinelInstance = AsObjectFactory.create(isSentinelInstance)\nexport const withSentinelModule = WithFactory.create(isSentinelModule)\nexport const withSentinelInstance = WithFactory.create(isSentinelInstance)\n"],"mappings":";AAIO,IAAM,uBAA6C;;;ACDnD,IAAM,4BAAuD;;;ACHpE,SAAS,mBAAmB,iBAAiB,kBAAkB,mBAAmB;AAClF,SAAS,uBAAuB;AAMzB,IAAM,qBAAqB,IAAI,kBAAoC,EAAE,OAAO,EAAE,QAAQ,WAAW,GAAG,CAAC,gBAAgB,CAAC;AACtH,IAAM,mBAAmB,IAAI,gBAAgC,EAAE,OAAO,CAAC,yBAAyB,CAAC;AAEjG,IAAM,mBAAmB,gBAAgB,OAAO,gBAAgB;AAChE,IAAM,qBAAqB,gBAAgB,OAAO,kBAAkB;AACpE,IAAM,qBAAqB,YAAY,OAAO,gBAAgB;AAC9D,IAAM,uBAAuB,YAAY,OAAO,kBAAkB;","names":[]}
+{"version":3,"sources":["../../src/Config.ts","../../src/Queries/Report.ts","../../src/typeChecks.ts"],"sourcesContent":["import { ModuleConfig } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { SentinelTask } from './Task'\n\nexport type SentinelConfigSchema = 'network.xyo.sentinel.config'\nexport const SentinelConfigSchema: SentinelConfigSchema = 'network.xyo.sentinel.config'\n\nexport type SentinelConfig<TConfig extends Payload | void = void> = ModuleConfig<\n  TConfig,\n  {\n    tasks: SentinelTask[]\n  },\n  TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema\n>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\nexport const SentinelReportQuerySchema: SentinelReportQuerySchema = 'network.xyo.query.sentinel.report'\n\nexport type SentinelReportQuery = Query<{\n  schema: SentinelReportQuerySchema\n}>\n","import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'\nimport { AsObjectFactory } from '@xyo-network/object'\n\nimport { SentinelInstance } from './Instance'\nimport { SentinelModule } from './Module'\nimport { SentinelReportQuerySchema } from './Queries'\n\nexport const isSentinelInstance = new IsInstanceFactory<SentinelInstance>().create({ report: 'function' }, [isModuleInstance])\nexport const isSentinelModule = new IsModuleFactory<SentinelModule>().create([SentinelReportQuerySchema])\n\nexport const asSentinelModule = AsObjectFactory.create(isSentinelModule)\nexport const asSentinelInstance = AsObjectFactory.create(isSentinelInstance)\nexport const withSentinelModule = WithFactory.create(isSentinelModule)\nexport const withSentinelInstance = WithFactory.create(isSentinelInstance)\n"],"mappings":";AAMO,IAAM,uBAA6C;;;ACHnD,IAAM,4BAAuD;;;ACHpE,SAAS,mBAAmB,iBAAiB,kBAAkB,mBAAmB;AAClF,SAAS,uBAAuB;AAMzB,IAAM,qBAAqB,IAAI,kBAAoC,EAAE,OAAO,EAAE,QAAQ,WAAW,GAAG,CAAC,gBAAgB,CAAC;AACtH,IAAM,mBAAmB,IAAI,gBAAgC,EAAE,OAAO,CAAC,yBAAyB,CAAC;AAEjG,IAAM,mBAAmB,gBAAgB,OAAO,gBAAgB;AAChE,IAAM,qBAAqB,gBAAgB,OAAO,kBAAkB;AACpE,IAAM,qBAAqB,YAAY,OAAO,gBAAgB;AAC9D,IAAM,uBAAuB,YAAY,OAAO,kBAAkB;","names":[]}

package/package.json

@@ -10,19 +10,18 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/boundwitness-model": "~2.75.18",
-    "@xyo-network/core": "~2.75.18",
-    "@xyo-network/module-events": "~2.75.18",
-    "@xyo-network/module-model": "~2.75.18",
-    "@xyo-network/object": "~2.75.18",
-    "@xyo-network/payload-model": "~2.75.18",
-    "@xyo-network/promise": "~2.75.18",
-    "@xyo-network/witness-model": "~2.75.18"
+    "@xyo-network/boundwitness-model": "~2.76.1",
+    "@xyo-network/core": "~2.76.1",
+    "@xyo-network/module-events": "~2.76.1",
+    "@xyo-network/module-model": "~2.76.1",
+    "@xyo-network/object": "~2.76.1",
+    "@xyo-network/payload-model": "~2.76.1",
+    "@xyo-network/promise": "~2.76.1"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.1.9",
-    "@xylabs/tsconfig": "^3.1.9",
+    "@xylabs/ts-scripts-yarn3": "^3.1.12",
+    "@xylabs/tsconfig": "^3.1.12",
     "typescript": "^5.2.2"
   },
   "docs": "dist/docs.json",
@@ -50,15 +49,12 @@
         }
       }
     },
-    "./docs": {
-      "default": "./dist/docs.json"
-    },
     "./package.json": "./package.json"
   },
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",
   "homepage": "https://xyo.network",
-  "license": "LGPL-3.0",
+  "license": "LGPL-3.0-only",
   "publishConfig": {
     "access": "public"
   },
@@ -67,5 +63,5 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.75.18"
+  "version": "2.76.1"
 }

package/src/Config.ts

@@ -1,14 +1,15 @@
 import { ModuleConfig } from '@xyo-network/module-model'
 import { Payload } from '@xyo-network/payload-model'
 
+import { SentinelTask } from './Task'
+
 export type SentinelConfigSchema = 'network.xyo.sentinel.config'
 export const SentinelConfigSchema: SentinelConfigSchema = 'network.xyo.sentinel.config'
 
 export type SentinelConfig<TConfig extends Payload | void = void> = ModuleConfig<
   TConfig,
   {
-    passthrough?: boolean
-    witnesses?: string[]
+    tasks: SentinelTask[]
   },
   TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema
 >

package/src/Instance.ts

@@ -1,17 +1,11 @@
 import { ModuleInstance } from '@xyo-network/module-model'
-import { Promisable } from '@xyo-network/promise'
-import { WitnessInstance } from '@xyo-network/witness-model'
 
 import { SentinelModuleEventData } from './EventData'
 import { CustomSentinelModule, SentinelModule } from './Module'
 import { SentinelParams } from './Params'
 import { Sentinel } from './Sentinel'
 
-export type SentinelInstance<TParams extends SentinelParams = SentinelParams> = SentinelModule<TParams> &
-  Sentinel &
-  ModuleInstance<TParams> & {
-    witnesses: () => Promisable<WitnessInstance[]>
-  }
+export type SentinelInstance<TParams extends SentinelParams = SentinelParams> = SentinelModule<TParams> & Sentinel & ModuleInstance<TParams>
 
 export type CustomSentinelInstance<
   TParams extends SentinelParams = SentinelParams,

package/src/Job.ts

@@ -0,0 +1,12 @@
+import { ModuleInstance } from '@xyo-network/module-model'
+
+import { SentinelTask } from './Task'
+
+export type ResolvedSentinelTask = Omit<SentinelTask, 'module'> & {
+  /** @field the modules that performs the task */
+  module: ModuleInstance
+}
+
+export interface SentinelJob {
+  tasks: ResolvedSentinelTask[][]
+}

package/src/Task.ts

@@ -0,0 +1,8 @@
+import { NameOrAddress } from '@xyo-network/module-model'
+
+export interface SentinelTask {
+  /** @field determines what inputs are sent to each witness */
+  input?: boolean | string
+  /** @field the modules that performs the task */
+  module: NameOrAddress
+}

package/src/index.ts

@@ -2,8 +2,10 @@ export * from './Config'
 export * from './EventData'
 export * from './EventsModels'
 export * from './Instance'
+export * from './Job'
 export * from './Module'
 export * from './Params'
 export * from './Queries'
 export * from './Sentinel'
+export * from './Task'
 export * from './typeChecks'