@xyo-network/sentinel-model 5.3.20 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/sentinel-model",
-  "version": "5.3.20",
+  "version": "5.3.24",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,27 +30,39 @@
   "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/archivist-model": "~5.3.20",
-    "@xyo-network/boundwitness-model": "~5.3.20",
-    "@xyo-network/diviner-model": "~5.3.20",
-    "@xyo-network/module-model": "~5.3.20",
-    "@xyo-network/payload-model": "~5.3.20",
-    "@xyo-network/witness-model": "~5.3.20"
+    "@xyo-network/account-model": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/diviner-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/witness-model": "~5.3.24",
+    "@xyo-network/archivist-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/boundwitness-model": "~5.3.24",
+    "@xyo-network/diviner-model": "~5.3.24",
+    "@xyo-network/witness-model": "~5.3.24",
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
@@ -59,4 +71,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Automation.ts

@@ -1,58 +0,0 @@
-import type { EventName } from '@xylabs/sdk-js'
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-import { asSchema, isPayloadOfSchemaType } from '@xyo-network/payload-model'
-
-export const SentinelAutomationSchema = asSchema('network.xyo.automation', true)
-export type SentinelAutomationSchema = typeof SentinelAutomationSchema
-
-export const SentinelIntervalAutomationSchema = asSchema('network.xyo.automation.interval', true)
-export type SentinelIntervalAutomationSchema = typeof SentinelIntervalAutomationSchema
-
-export const SentinelModuleEventAutomationSchema = asSchema('network.xyo.automation.event.module', true)
-export type SentinelModuleEventAutomationSchema = typeof SentinelModuleEventAutomationSchema
-
-export type SentinelBaseAutomationPayload<T extends Payload> = Payload<
-  {
-    type?: 'interval' | 'event'
-  } & T
->
-
-/** Settings for an Interval Automation */
-export type SentinelIntervalAutomationPayload = SentinelBaseAutomationPayload<{
-  /** Epoch after which any reoccurrence stops */
-  end?: number
-
-  /** Time between triggers [non-repeating if undefined] */
-  frequency?: number
-
-  /** Units for frequency field [hour if undefined] */
-  frequencyUnits?: 'second' | 'minute' | 'hour' | 'day' | 'millis'
-
-  /** Remaining triggers [infinite if undefined] */
-  remaining?: number
-
-  schema: SentinelIntervalAutomationSchema
-
-  /** Epoch of the next trigger */
-  start: number
-
-  /** The type of automation */
-  type: 'interval'
-}>
-
-export const isSentinelIntervalAutomation = isPayloadOfSchemaType<SentinelIntervalAutomationPayload>(SentinelIntervalAutomationSchema)
-
-/** Settings for an Module Event Automation */
-export type SentinelModuleEventAutomationPayload = SentinelBaseAutomationPayload<{
-  eventName: EventName
-  schema: SentinelModuleEventAutomationSchema
-  source: ModuleIdentifier
-  type: 'event'
-}>
-
-/** Settings for an Automation */
-export type SentinelAutomationPayload = Payload<
-  SentinelIntervalAutomationPayload | SentinelModuleEventAutomationPayload,
-  SentinelAutomationSchema | SentinelIntervalAutomationSchema | SentinelModuleEventAutomationSchema
->

package/src/Config.ts

@@ -1,25 +0,0 @@
-import type { WithAdditional } from '@xylabs/sdk-js'
-import type { ModuleConfig } from '@xyo-network/module-model'
-import {
-  asSchema, type Payload, type Schema,
-} from '@xyo-network/payload-model'
-
-import type { SentinelAutomationPayload } from './Automation.ts'
-import type { Task } from './Task.ts'
-
-export const SentinelConfigSchema = asSchema('network.xyo.sentinel.config', true)
-export type SentinelConfigSchema = typeof SentinelConfigSchema
-
-export type SentinelConfig<TConfig extends Payload | void = void, TSchema extends Schema | void = void> = ModuleConfig<
-  WithAdditional<
-    {
-      automations?: SentinelAutomationPayload[]
-      schema: TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema
-      synchronous?: boolean
-      tasks: Task[]
-      throwErrors?: boolean
-    },
-    TConfig
-  >,
-  TSchema
->

package/src/EventData.ts

@@ -1,19 +0,0 @@
-import type { ModuleEventData, QueryableModule } from '@xyo-network/module-model'
-
-import type {
-  JobEndEventData,
-  JobStartEventData,
-  ReportEndEventData,
-  ReportStartEventData,
-  TaskEndEventData,
-  TaskStartEventData,
-} from './EventsModels/index.ts'
-
-export interface SentinelModuleEventData<T extends QueryableModule = QueryableModule>
-  extends TaskEndEventData<T>,
-  TaskStartEventData<T>,
-  JobEndEventData<T>,
-  JobStartEventData<T>,
-  ReportEndEventData<T>,
-  ReportStartEventData<T>,
-  ModuleEventData<T> {}

package/src/EventsModels/JobEnd.ts

@@ -1,15 +0,0 @@
-import type { Address, EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export type JobEndEventArgs<T extends QueryableModule = QueryableModule> = ModuleEventArgs<
-  T,
-  {
-    finalResult?: Record<Address, Payload[]>
-    inPayloads?: Payload[]
-  }
->
-
-export interface JobEndEventData<T extends QueryableModule = QueryableModule> extends EventData {
-  jobEnd: JobEndEventArgs<T>
-}

package/src/EventsModels/JobStart.ts

@@ -1,14 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export type JobStartEventArgs<T extends QueryableModule = QueryableModule> = ModuleEventArgs<
-  T,
-  {
-    inPayloads?: Payload[]
-  }
->
-
-export interface JobStartEventData<T extends QueryableModule = QueryableModule> extends EventData {
-  jobStart: JobStartEventArgs<T>
-}

package/src/EventsModels/ReportEnd.ts

@@ -1,17 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export type ReportEndEventArgs<T extends QueryableModule = QueryableModule> = ModuleEventArgs<
-  T,
-  {
-    boundwitness?: BoundWitness
-    inPayloads?: Payload[]
-    outPayloads?: Payload[]
-  }
->
-
-export interface ReportEndEventData<T extends QueryableModule = QueryableModule> extends EventData {
-  reportEnd: ReportEndEventArgs<T>
-}

package/src/EventsModels/ReportStart.ts

@@ -1,14 +0,0 @@
-import type { EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export type ReportStartEventArgs<T extends QueryableModule = QueryableModule> = ModuleEventArgs<
-  T,
-  {
-    inPayloads?: Payload[]
-  }
->
-
-export interface ReportStartEventData<T extends QueryableModule = QueryableModule> extends EventData {
-  reportStart: ReportStartEventArgs<T>
-}

package/src/EventsModels/TaskEnd.ts

@@ -1,17 +0,0 @@
-import type { Address, EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export type TaskEndEventArgs<T extends QueryableModule = QueryableModule> = ModuleEventArgs<
-  T,
-  {
-    address: Address
-    inPayloads?: Payload[]
-    name?: string
-    outPayloads?: Payload[]
-  }
->
-
-export interface TaskEndEventData<T extends QueryableModule = QueryableModule> extends EventData {
-  taskEnd: TaskEndEventArgs<T>
-}

package/src/EventsModels/TaskStart.ts

@@ -1,16 +0,0 @@
-import type { Address, EventData } from '@xylabs/sdk-js'
-import type { ModuleEventArgs, QueryableModule } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export type TaskStartEventArgs<T extends QueryableModule = QueryableModule> = ModuleEventArgs<
-  T,
-  {
-    address: Address
-    inPayloads?: Payload[]
-    name?: string
-  }
->
-
-export interface TaskStartEventData<T extends QueryableModule = QueryableModule> extends EventData {
-  taskStart: TaskStartEventArgs<T>
-}

package/src/EventsModels/index.ts

@@ -1,6 +0,0 @@
-export * from './JobEnd.ts'
-export * from './JobStart.ts'
-export * from './ReportEnd.ts'
-export * from './ReportStart.ts'
-export * from './TaskEnd.ts'
-export * from './TaskStart.ts'

package/src/Instance.ts

@@ -1,20 +0,0 @@
-import type { ModuleInstance } from '@xyo-network/module-model'
-
-import type { SentinelModuleEventData } from './EventData.ts'
-import type { CustomSentinelModule, SentinelModule } from './Module.ts'
-import type { SentinelParams } from './Params.ts'
-import type { Sentinel } from './Sentinel.ts'
-
-export interface SentinelInstance<
-  TParams extends SentinelParams = SentinelParams,
-  TEventData extends SentinelModuleEventData = SentinelModuleEventData,
-> extends SentinelModule<TParams, TEventData>,
-  Sentinel,
-  ModuleInstance<TParams, TEventData> {}
-
-export interface CustomSentinelInstance<
-  TParams extends SentinelParams = SentinelParams,
-  TEvents extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,
-> extends CustomSentinelModule<TParams, TEvents>,
-  Sentinel,
-  SentinelInstance<TParams, TEvents> {}

package/src/Job.ts

@@ -1,5 +0,0 @@
-import type { ResolvedTask } from './ResolvedTask.ts'
-
-export interface SentinelJob {
-  tasks: ResolvedTask[][]
-}

package/src/Module.ts

@@ -1,12 +0,0 @@
-import type { QueryableModule } from '@xyo-network/module-model'
-
-import type { SentinelModuleEventData } from './EventData.ts'
-import type { SentinelParams } from './Params.ts'
-
-export interface SentinelModule<TParams extends SentinelParams = SentinelParams, TEventData extends SentinelModuleEventData = SentinelModuleEventData>
-  extends QueryableModule<TParams, TEventData> {}
-
-export interface CustomSentinelModule<
-  TParams extends SentinelParams = SentinelParams,
-  TEvents extends SentinelModuleEventData<SentinelModule<TParams>> = SentinelModuleEventData<SentinelModule<TParams>>,
-> extends QueryableModule<TParams, TEvents> {}

package/src/Params.ts

@@ -1,9 +0,0 @@
-import type { AnyConfigSchema, QueryableModuleParams } from '@xyo-network/module-model'
-
-import type { SentinelConfig } from './Config.ts'
-
-export interface SentinelParams<
-  TConfig extends AnyConfigSchema<SentinelConfig> = AnyConfigSchema<SentinelConfig>,
-> extends QueryableModuleParams<TConfig> {
-
-}

package/src/Queries/Report.ts

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

package/src/Queries/index.ts

@@ -1,8 +0,0 @@
-export * from './Report.ts'
-
-import type { ModuleQueries } from '@xyo-network/module-model'
-
-import type { SentinelReportQuery } from './Report.ts'
-
-export type SentinelQueries = SentinelReportQuery
-export type SentinelModuleQueries = ModuleQueries | SentinelQueries

package/src/ResolvedTask.ts

@@ -1,19 +0,0 @@
-import type { ArchivistInstance } from '@xyo-network/archivist-model'
-import type { DivinerInstance } from '@xyo-network/diviner-model'
-import type { ModuleInstance } from '@xyo-network/module-model'
-import type { WitnessInstance } from '@xyo-network/witness-model'
-
-import type {
-  ArchivistTask, DivinerTask, ModuleTask, WitnessTask,
-} from './Task.ts'
-
-export type ResolvedModuleTask<TTask extends ModuleTask = ModuleTask, TInstance extends ModuleInstance = ModuleInstance> = Omit<TTask, 'mod'> & {
-  /** @field the modules that performs the task */
-  mod: TInstance
-}
-
-export type ResolvedArchivistTask = ResolvedModuleTask<ArchivistTask, ArchivistInstance>
-export type ResolvedDivinerTask = ResolvedModuleTask<DivinerTask, DivinerInstance>
-export type ResolvedWitnessTask = ResolvedModuleTask<WitnessTask, WitnessInstance>
-
-export type ResolvedTask = ResolvedArchivistTask | ResolvedDivinerTask | ResolvedWitnessTask | ResolvedModuleTask

package/src/Sentinel.ts

@@ -1,9 +0,0 @@
-import type { Promisable } from '@xylabs/sdk-js'
-import type { AccountInstance } from '@xyo-network/account-model'
-import type { ModuleQueryResult } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
-
-export interface Sentinel<TIn extends Payload = Payload, TOut extends Payload = Payload> {
-  report: (payloads?: TIn[]) => Promisable<TOut[]>
-  reportQuery: (payloads?: TIn[], account?: AccountInstance) => Promisable<ModuleQueryResult<TOut>>
-}

package/src/Task.ts

@@ -1,17 +0,0 @@
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-
-export interface ModuleTask<TEndpoints extends string = string> {
-  /** @field the name of the endPoint that is being called.  If not specified, the default endPoint is used */
-  endPoint?: TEndpoints
-  /** @field determines what inputs are sent to each module - if string, that is the output from other module (name/address) */
-  input?: boolean | ModuleIdentifier | ModuleIdentifier[]
-  /** @field the modules that performs the task */
-  mod: ModuleIdentifier
-  required?: boolean
-}
-
-export type ArchivistTask = ModuleTask<'all' | 'clear' | 'commit' | 'delete' | 'get' | 'insert'>
-export type DivinerTask = ModuleTask<'divine'>
-export type WitnessTask = ModuleTask<'observe'>
-
-export type Task = WitnessTask | DivinerTask | ArchivistTask | ModuleTask

package/src/attachable/AttachableInstance.ts

@@ -1,19 +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 { SentinelModuleEventData } from '../EventData.ts'
-import type { SentinelInstance } from '../Instance.ts'
-import type { SentinelModule } from '../Module.ts'
-import type { SentinelParams } from '../Params.ts'
-
-export interface AttachableSentinelInstance<
-  TParams extends SentinelParams = SentinelParams,
-  TEventData extends SentinelModuleEventData = SentinelModuleEventData,
-> extends SentinelModule<TParams, TEventData>,
-  AttachableModuleInstance<TParams, TEventData>,
-  SentinelInstance<TParams, TEventData> {}
-
-export type AttachableSentinelInstanceTypeCheck<T extends AttachableSentinelInstance = AttachableSentinelInstance> = TypeCheck<T>
-
-export class IsAttachableSentinelInstanceFactory<T extends AttachableSentinelInstance = AttachableSentinelInstance> extends IsObjectFactory<T> {}

package/src/attachable/asAttachableInstance.ts

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

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 { isSentinelInstance } from '../typeChecks.ts'
-import type { AttachableSentinelInstance } from './AttachableInstance.ts'
-
-export const requiredAttachableSentinelInstanceFunctions: ObjectTypeShape = {}
-
-// we do not use IsInstanceFactory here to prevent a cycle
-const factory = new IsObjectFactory<AttachableSentinelInstance>()
-
-export const isAttachableSentinelInstance: TypeCheck<AttachableSentinelInstance> = factory.create(requiredAttachableSentinelInstanceFunctions, [
-  isSentinelInstance,
-  isAttachableModuleInstance,
-])

package/src/index.ts

@@ -1,14 +0,0 @@
-export * from './attachable/index.ts'
-export * from './Automation.ts'
-export * from './Config.ts'
-export * from './EventData.ts'
-export * from './EventsModels/index.ts'
-export * from './Instance.ts'
-export * from './Job.ts'
-export * from './Module.ts'
-export * from './Params.ts'
-export * from './Queries/index.ts'
-export * from './ResolvedTask.ts'
-export * from './Sentinel.ts'
-export * from './Task.ts'
-export * from './typeChecks.ts'

package/src/typeChecks.ts

@@ -1,22 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import {
-  // eslint-disable-next-line sonarjs/deprecation
-  IsInstanceFactory, isModuleInstance, IsQueryableModuleFactory, WithFactory,
-} from '@xyo-network/module-model'
-
-import type { SentinelInstance } from './Instance.ts'
-import type { SentinelModule } from './Module.ts'
-import { SentinelReportQuerySchema } from './Queries/index.ts'
-
-export const isSentinelInstance = new IsInstanceFactory<SentinelInstance>().create({ report: 'function' }, [isModuleInstance])
-export const isSentinelModule = new IsQueryableModuleFactory<SentinelModule>().create([SentinelReportQuerySchema])
-
-export const asSentinelModule = AsObjectFactory.create(isSentinelModule)
-export const asSentinelInstance = AsObjectFactory.create(isSentinelInstance)
-
-/** @deprecated use narrowing instead [ if(is) ] */
-// eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated
-export const withSentinelModule = WithFactory.create(isSentinelModule)
-/** @deprecated use narrowing instead [ if(is) ] */
-// eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated
-export const withSentinelInstance = WithFactory.create(isSentinelInstance)