@xyo-network/sentinel 2.67.0 → 2.69.0-rc.1

package/src/MemorySentinel.ts

@@ -1,34 +1,26 @@
 import { assertEx } from '@xylabs/assert'
 import { fulfilled, rejected } from '@xylabs/promise'
-import { Account } from '@xyo-network/account'
-import { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'
-import { handleError, handleErrorAsync } from '@xyo-network/error'
-import { AnyConfigSchema, ModuleConfig, ModuleErrorBuilder, ModuleQueryResult } from '@xyo-network/module'
-import { ModuleError, Payload } from '@xyo-network/payload-model'
+import { handleError } from '@xyo-network/error'
+import { AnyConfigSchema } from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
 import { WitnessInstance } from '@xyo-network/witness'
 
 import { AbstractSentinel } from './AbstractSentinel'
-import { SentinelConfig, SentinelConfigSchema } from './Config'
-import { SentinelQuery, SentinelReportQuerySchema } from './Queries'
-import { SentinelModule, SentinelModuleEventData, SentinelParams } from './SentinelModel'
+import { SentinelConfig, SentinelConfigSchema, SentinelInstance, SentinelModuleEventData, SentinelParams, SentinelReportQuerySchema } from './model'
 
 export type MemorySentinelParams<TConfig extends AnyConfigSchema<SentinelConfig> = AnyConfigSchema<SentinelConfig>> = SentinelParams<
   AnyConfigSchema<TConfig>
 >
 
 export class MemorySentinel<
-    TParams extends MemorySentinelParams = MemorySentinelParams,
-    TEventData extends SentinelModuleEventData = SentinelModuleEventData,
-  >
-  extends AbstractSentinel<TParams, TEventData>
-  implements SentinelModule<TParams, TEventData>
-{
+  TParams extends MemorySentinelParams = MemorySentinelParams,
+  TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,
+> extends AbstractSentinel<TParams, TEventData> {
   static override configSchemas = [SentinelConfigSchema]
 
-  async report(payloads: Payload[] = []): Promise<Payload[]> {
+  async reportHandler(payloads: Payload[] = []): Promise<Payload[]> {
     await this.started('throw')
     const errors: Error[] = []
-    await this.emit('reportStart', { inPayloads: payloads, module: this as SentinelModule })
     const allWitnesses = [...(await this.getWitnesses())]
     const resultPayloads: Payload[] = []
 
@@ -43,47 +35,11 @@ export class MemorySentinel<
       })
     }
 
-    const [[boundWitness]] = await this.bindQueryResult({ schema: SentinelReportQuerySchema }, resultPayloads)
+    const [boundWitness] = await this.bindQueryResult({ schema: SentinelReportQuerySchema }, resultPayloads)
     this.history.push(assertEx(boundWitness))
-    await this.emit('reportEnd', { boundWitness, errors, inPayloads: payloads, module: this as SentinelModule, outPayloads: resultPayloads })
     return [boundWitness, ...resultPayloads]
   }
 
-  protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(
-    query: T,
-    payloads?: Payload[],
-    queryConfig?: TConfig,
-  ): Promise<ModuleQueryResult> {
-    const wrapper = QueryBoundWitnessWrapper.parseQuery<SentinelQuery>(query, payloads)
-    const queryPayload = await wrapper.getQuery()
-    assertEx(this.queryable(query, payloads, queryConfig))
-    const queryAccount = Account.randomSync()
-    const resultPayloads: Payload[] = []
-    const errorPayloads: ModuleError[] = []
-    try {
-      switch (queryPayload.schema) {
-        case SentinelReportQuerySchema: {
-          resultPayloads.push(...(await this.report(payloads)))
-          break
-        }
-        default:
-          return super.queryHandler(query, payloads)
-      }
-    } catch (ex) {
-      await handleErrorAsync(ex, async (error) => {
-        errorPayloads.push(
-          new ModuleErrorBuilder()
-            .sources([await wrapper.hashAsync()])
-            .name(this.config.name ?? '<Unknown>')
-            .query(query.schema)
-            .message(error.message)
-            .build(),
-        )
-      })
-    }
-    return (await this.bindQueryResult(queryPayload, resultPayloads, [queryAccount], errorPayloads))[0]
-  }
-
   private async generateResults(witnesses: WitnessInstance[]): Promise<[Payload[], Error[]]> {
     const results = await Promise.allSettled(witnesses?.map((witness) => witness.observe()))
     const payloads = results

package/src/SentinelRunner.ts

@@ -3,8 +3,8 @@ import { Payload } from '@xyo-network/payload-model'
 import { PayloadWrapper } from '@xyo-network/payload-wrapper'
 
 import { SentinelAutomationPayload, SentinelIntervalAutomationPayload } from './Automation'
+import { SentinelInstance } from './model'
 import { SentinelIntervalAutomationWrapper } from './SentinelIntervalAutomationWrapper'
-import { SentinelInstance } from './SentinelModel'
 
 export type OnSentinelRunnerTriggerResult = (result: Payload[]) => void
 

package/src/Wrapper.ts

@@ -1,8 +1,7 @@
 import { constructableModuleWrapper, ModuleWrapper } from '@xyo-network/module'
 import { Payload } from '@xyo-network/payload-model'
 
-import { SentinelReportQuery, SentinelReportQuerySchema } from './Queries'
-import { SentinelInstance, SentinelModule } from './SentinelModel'
+import { SentinelInstance, SentinelModule, SentinelReportQuery, SentinelReportQuerySchema } from './model'
 import { isSentinelInstance, isSentinelModule } from './typeChecks'
 
 constructableModuleWrapper()

package/src/index.ts

@@ -1,10 +1,8 @@
 export * from './AbstractSentinel'
 export * from './Automation'
-export * from './Config'
 export * from './MemorySentinel'
-export * from './Queries'
+export * from './model'
 export * from './SentinelIntervalAutomationWrapper'
-export * from './SentinelModel'
 export * from './SentinelRunner'
 export * from './typeChecks'
 export * from './Wrapper'

package/src/model/EventData.ts

@@ -0,0 +1,5 @@
+import { Module, ModuleEventData } from '@xyo-network/module-model'
+
+import { ReportEndEventData, ReportStartEventData } from './Events'
+
+export interface SentinelModuleEventData<T extends Module = Module> extends ReportEndEventData<T>, ReportStartEventData<T>, ModuleEventData<T> {}

package/src/model/Events/ReportEnd.ts

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

package/src/model/Events/ReportStart.ts

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

package/src/model/Events/index.ts

@@ -0,0 +1,2 @@
+export * from './ReportEnd'
+export * from './ReportStart'

package/src/model/Instance.ts

@@ -0,0 +1,13 @@
+import { ModuleInstance } from '@xyo-network/module-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
+
+export type CustomSentinelInstance<
+  TParams extends SentinelParams = SentinelParams,
+  TEvents extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,
+> = CustomSentinelModule<TParams, TEvents> & Sentinel & ModuleInstance<TParams, TEvents>

package/src/model/Module.ts

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

package/src/model/Params.ts

@@ -0,0 +1,9 @@
+import { AnyObject } from '@xyo-network/core'
+import { AnyConfigSchema, ModuleParams } from '@xyo-network/module-model'
+
+import { SentinelConfig } from './Config'
+
+export type SentinelParams<
+  TConfig extends AnyConfigSchema<SentinelConfig> = AnyConfigSchema<SentinelConfig>,
+  TAdditionalParams extends AnyObject | undefined = undefined,
+> = ModuleParams<TConfig, TAdditionalParams>

package/src/model/Sentinel.ts

@@ -0,0 +1,6 @@
+import { Payload } from '@xyo-network/payload-model'
+import { Promisable } from '@xyo-network/promise'
+
+export interface Sentinel {
+  report: (payloads?: Payload[]) => Promisable<Payload[]>
+}

package/src/model/index.ts

@@ -0,0 +1,8 @@
+export * from './Config'
+export * from './EventData'
+export * from './Events'
+export * from './Instance'
+export * from './Module'
+export * from './Params'
+export * from './Queries'
+export * from './Sentinel'

package/src/typeChecks.ts

@@ -1,8 +1,7 @@
 import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'
 import { AsObjectFactory } from '@xyo-network/object-identity'
 
-import { SentinelReportQuerySchema } from './Queries'
-import { SentinelInstance, SentinelModule } from './SentinelModel'
+import { SentinelInstance, SentinelModule, SentinelReportQuerySchema } from './model'
 
 export const isSentinelInstance = new IsInstanceFactory<SentinelInstance>().create({ report: 'function' }, [isModuleInstance])
 export const isSentinelModule = new IsModuleFactory<SentinelModule>().create([SentinelReportQuerySchema])

package/dist/cjs/Config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":";;;AAKa,QAAA,oBAAoB,GAAyB,6BAA6B,CAAA"}

package/dist/cjs/Queries/Report.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Report.js","sourceRoot":"","sources":["../../../src/Queries/Report.ts"],"names":[],"mappings":";;;AAGa,QAAA,yBAAyB,GAA8B,mCAAmC,CAAA"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB"}

package/dist/cjs/SentinelModel.js.map

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