@xyo-network/sentinel-abstract 3.5.2 → 3.6.0-rc.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/neutral/AbstractSentinel.d.ts +2 -2
  2. package/dist/neutral/AbstractSentinel.d.ts.map +1 -1
  3. package/dist/neutral/index.mjs +3 -2
  4. package/dist/neutral/index.mjs.map +1 -1
  5. package/package.json +17 -15
  6. package/src/AbstractSentinel.ts +7 -4
package/dist/neutral/AbstractSentinel.d.ts CHANGED
@@ -2,7 +2,7 @@ import type { AccountInstance } from '@xyo-network/account-model';
2
2
  import type { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model';
3
3
  import { AbstractModuleInstance } from '@xyo-network/module-abstract';
4
4
  import type { ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult } from '@xyo-network/module-model';
5
- import type { Payload, Schema } from '@xyo-network/payload-model';
5
+ import type { Payload, Schema, WithoutPrivateStorageMeta } from '@xyo-network/payload-model';
6
6
  import type { CustomSentinelInstance, SentinelInstance, SentinelJob, SentinelModuleEventData, SentinelParams } from '@xyo-network/sentinel-model';
7
7
  export declare abstract class AbstractSentinel<TParams extends SentinelParams = SentinelParams, TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>> extends AbstractModuleInstance<TParams, TEventData> implements CustomSentinelInstance<TParams, TEventData> {
8
8
  static readonly configSchemas: Schema[];
@@ -14,7 +14,7 @@ export declare abstract class AbstractSentinel<TParams extends SentinelParams =
14
14
  get queries(): string[];
15
15
  get synchronous(): boolean;
16
16
  get throwErrors(): boolean;
17
- report(inPayloads?: Payload[]): Promise<Payload[]>;
17
+ report(inPayloads?: Payload[]): Promise<WithoutPrivateStorageMeta<Payload>[]>;
18
18
  reportQuery(payloads?: Payload[], account?: AccountInstance): Promise<ModuleQueryResult>;
19
19
  protected emitReportEnd(inPayloads?: Payload[], payloads?: Payload[]): Promise<void>;
20
20
  protected generateJob(): Promise<SentinelJob>;
package/dist/neutral/AbstractSentinel.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"AbstractSentinel.d.ts","sourceRoot":"","sources":["../../src/AbstractSentinel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAGtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EACV,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAC1D,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EACV,sBAAsB,EAEtB,gBAAgB,EAChB,WAAW,EACX,uBAAuB,EACvB,cAAc,EAGf,MAAM,6BAA6B,CAAA;AAMpC,8BAAsB,gBAAgB,CACpC,OAAO,SAAS,cAAc,GAAG,cAAc,EAC/C,UAAU,SAAS,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAE1H,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAAC;IACtD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAiD;IACjG,gBAAyB,mBAAmB,EAAE,MAAM,CAAuB;IAC3E,gBAAyB,UAAU,SAA8D;IACjG,OAAO,EAAE,YAAY,EAAE,CAAK;IAC5B,OAAO,CAAC,WAAW,CAAC,CAAsB;IAE1C,IAAI,UAAU,yBAGb;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAEK,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAwBlD,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;cAK9E,aAAa,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE;cAS1D,WAAW;cA+CF,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,EAChI,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,wBAAwB,CAAC;IAiBpC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CACjE"}
1
+ {"version":3,"file":"AbstractSentinel.d.ts","sourceRoot":"","sources":["../../src/AbstractSentinel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAGtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EACV,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAC1D,MAAM,2BAA2B,CAAA;AAElC,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAC3C,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EACV,sBAAsB,EAEtB,gBAAgB,EAChB,WAAW,EACX,uBAAuB,EACvB,cAAc,EAGf,MAAM,6BAA6B,CAAA;AAMpC,8BAAsB,gBAAgB,CACpC,OAAO,SAAS,cAAc,GAAG,cAAc,EAC/C,UAAU,SAAS,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAE1H,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAAC;IACtD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAiD;IACjG,gBAAyB,mBAAmB,EAAE,MAAM,CAAuB;IAC3E,gBAAyB,UAAU,SAA8D;IACjG,OAAO,EAAE,YAAY,EAAE,CAAK;IAC5B,OAAO,CAAC,WAAW,CAAC,CAAsB;IAE1C,IAAI,UAAU,yBAGb;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAEK,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;IAwB7E,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;cAK9E,aAAa,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE;cAS1D,WAAW;cA+CF,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,EAChI,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,wBAAwB,CAAC;IAiBpC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CACjE"}
package/dist/neutral/index.mjs CHANGED
@@ -9,6 +9,7 @@ import { BoundWitnessBuilder } from "@xyo-network/boundwitness-builder";
9
9
  import { isBoundWitness, notBoundWitness } from "@xyo-network/boundwitness-model";
10
10
  import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-wrapper";
11
11
  import { AbstractModuleInstance } from "@xyo-network/module-abstract";
12
+ import { PayloadBuilder } from "@xyo-network/payload-builder";
12
13
  import { SentinelConfigSchema, SentinelReportQuerySchema } from "@xyo-network/sentinel-model";
13
14
  var AbstractSentinel = class _AbstractSentinel extends AbstractModuleInstance {
14
15
  static {
@@ -113,7 +114,7 @@ var AbstractSentinel = class _AbstractSentinel extends AbstractModuleInstance {
113
114
  return job;
114
115
  }
115
116
  async queryHandler(query, payloads, queryConfig) {
116
- const wrapper = await QueryBoundWitnessWrapper.parseQuery(query, payloads);
117
+ const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
117
118
  const queryPayload = await wrapper.getQuery();
118
119
  assertEx(await this.queryable(query, payloads, queryConfig));
119
120
  const resultPayloads = [];
@@ -126,7 +127,7 @@ var AbstractSentinel = class _AbstractSentinel extends AbstractModuleInstance {
126
127
  return super.queryHandler(query, payloads);
127
128
  }
128
129
  }
129
- return resultPayloads;
130
+ return PayloadBuilder.omitPrivateStorageMeta(resultPayloads);
130
131
  }
131
132
  };
132
133
  export {
package/dist/neutral/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/AbstractSentinel.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { forget } from '@xylabs/forget'\nimport { globallyUnique } from '@xylabs/object'\nimport type { AccountInstance } from '@xyo-network/account-model'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\nimport type { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitness, notBoundWitness } from '@xyo-network/boundwitness-model'\nimport { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport type {\n ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult,\n} from '@xyo-network/module-model'\nimport type { Payload, Schema } from '@xyo-network/payload-model'\nimport type {\n CustomSentinelInstance,\n ResolvedTask,\n SentinelInstance,\n SentinelJob,\n SentinelModuleEventData,\n SentinelParams,\n SentinelQueries,\n SentinelReportQuery,\n} from '@xyo-network/sentinel-model'\nimport {\n SentinelConfigSchema,\n SentinelReportQuerySchema,\n} from '@xyo-network/sentinel-model'\n\nexport abstract class AbstractSentinel<\n TParams extends SentinelParams = SentinelParams,\n TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,\n>\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomSentinelInstance<TParams, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, SentinelConfigSchema]\n static override readonly defaultConfigSchema: Schema = SentinelConfigSchema\n static override readonly uniqueName = globallyUnique('AbstractSentinel', AbstractSentinel, 'xyo')\n history: BoundWitness[] = []\n private _jobPromise?: Promise<SentinelJob>\n\n get jobPromise() {\n this._jobPromise = this._jobPromise ?? this.generateJob()\n return this._jobPromise\n }\n\n override get queries(): string[] {\n return [SentinelReportQuerySchema, ...super.queries]\n }\n\n get synchronous(): boolean {\n return this.config.synchronous ?? false\n }\n\n get throwErrors(): boolean {\n return this.config.throwErrors ?? true\n }\n\n async report(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('report')\n const reportPromise = (async () => {\n await this.emit('reportStart', { inPayloads, mod: this })\n const payloads = await this.reportHandler(inPayloads)\n\n // create boundwitness\n const result = (await new BoundWitnessBuilder().payloads(payloads).signer(this.account).build()).flat()\n\n if (this.config.archiving) {\n forget(this.storeToArchivists(result))\n }\n\n await this.emitReportEnd(inPayloads, result)\n return result\n })()\n if (this.synchronous) {\n return await reportPromise\n } else {\n forget(reportPromise)\n return []\n }\n }\n\n async reportQuery(payloads?: Payload[], account?: AccountInstance): Promise<ModuleQueryResult> {\n const queryPayload: SentinelReportQuery = { schema: SentinelReportQuerySchema }\n return await this.sendQueryRaw(queryPayload, payloads, account)\n }\n\n protected async emitReportEnd(inPayloads?: Payload[], payloads?: Payload[]) {\n const boundwitnesses = payloads?.filter(isBoundWitness) ?? []\n const outPayloads = payloads?.filter(notBoundWitness) ?? []\n const boundwitness = boundwitnesses.find(bw => bw.addresses.includes(this.address))\n await this.emit('reportEnd', {\n boundwitness, inPayloads, mod: this, outPayloads,\n })\n }\n\n protected async generateJob() {\n const job: SentinelJob = { tasks: [] }\n let tasks: ResolvedTask[] = await Promise.all(\n this.config.tasks.map(async task => ({\n input: task.input ?? false,\n mod: assertEx(await this.resolve(task.mod), () => `Unable to resolve task module [${task.mod}]`),\n })),\n )\n while (tasks.length > 0) {\n const previousTasks = job.tasks.at(-1) ?? []\n const newListCandidates\n // add all tasks that either require no previous input or have the previous input module already added\n = tasks.filter((task) => {\n const input = task.input\n if (input === undefined) {\n return true\n }\n if (typeof input === 'boolean') {\n return true\n }\n if (typeof input === 'string') {\n return previousTasks.find(prevTask => prevTask.mod.address === input || prevTask.mod.modName === input)\n }\n if (Array.isArray(input)) {\n return previousTasks.find(\n prevTask => input.includes(prevTask.mod.address) || input.includes(prevTask.mod.modName ?? prevTask.mod.address),\n )\n }\n })\n // remove any tasks that have inputs that are in the current list or the remaining tasks\n const newList = newListCandidates.filter((taskCandidate) => {\n const input = taskCandidate.input\n return !(\n Array.isArray(input)\n && tasks.some(\n remainingTask => input.includes(remainingTask.mod.address) || input.includes(remainingTask.mod.modName ?? remainingTask.mod.address),\n )\n )\n })\n assertEx(newList.length > 0, () => `Unable to generateJob [${tasks.length}]`)\n job.tasks.push(newList)\n // remove the tasks we just added\n tasks = tasks.filter(task => !newList.includes(task))\n }\n return job\n }\n\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = await QueryBoundWitnessWrapper.parseQuery<SentinelQueries>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(await this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n switch (queryPayload.schema) {\n case SentinelReportQuerySchema: {\n resultPayloads.push(...(await this.report(payloads)))\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n abstract reportHandler(payloads?: Payload[]): Promise<Payload[]>\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,cAAc;AACvB,SAASC,sBAAsB;AAE/B,SAASC,2BAA2B;AAEpC,SAASC,gBAAgBC,uBAAuB;AAChD,SAASC,gCAAgC;AACzC,SAASC,8BAA8B;AAevC,SACEC,sBACAC,iCACK;AAEA,IAAeC,mBAAf,MAAeA,0BAIZC,uBAAAA;EAhCV,OAgCUA;;;EAER,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeC;;EAC5E,OAAyBC,sBAA8BD;EACvD,OAAyBE,aAAaC,eAAe,oBAAoBN,mBAAkB,KAAA;EAC3FO,UAA0B,CAAA;EAClBC;EAER,IAAIC,aAAa;AACf,SAAKD,cAAc,KAAKA,eAAe,KAAKE,YAAW;AACvD,WAAO,KAAKF;EACd;EAEA,IAAaG,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,cAAuB;AACzB,WAAO,KAAKC,OAAOD,eAAe;EACpC;EAEA,IAAIE,cAAuB;AACzB,WAAO,KAAKD,OAAOC,eAAe;EACpC;EAEA,MAAMC,OAAOC,YAA4C;AACvD,SAAKC,YAAY,QAAA;AACjB,UAAMC,iBAAiB,YAAA;AACrB,YAAM,KAAKC,KAAK,eAAe;QAAEH;QAAYI,KAAK;MAAK,CAAA;AACvD,YAAMC,WAAW,MAAM,KAAKC,cAAcN,UAAAA;AAG1C,YAAMO,UAAU,MAAM,IAAIC,oBAAAA,EAAsBH,SAASA,QAAAA,EAAUI,OAAO,KAAKC,OAAO,EAAEC,MAAK,GAAIC,KAAI;AAErG,UAAI,KAAKf,OAAOgB,WAAW;AACzBC,eAAO,KAAKC,kBAAkBR,MAAAA,CAAAA;MAChC;AAEA,YAAM,KAAKS,cAAchB,YAAYO,MAAAA;AACrC,aAAOA;IACT,GAAA;AACA,QAAI,KAAKX,aAAa;AACpB,aAAO,MAAMM;IACf,OAAO;AACLY,aAAOZ,aAAAA;AACP,aAAO,CAAA;IACT;EACF;EAEA,MAAMe,YAAYZ,UAAsBK,SAAuD;AAC7F,UAAMQ,eAAoC;MAAEC,QAAQxB;IAA0B;AAC9E,WAAO,MAAM,KAAKyB,aAAaF,cAAcb,UAAUK,OAAAA;EACzD;EAEA,MAAgBM,cAAchB,YAAwBK,UAAsB;AAC1E,UAAMgB,iBAAiBhB,UAAUiB,OAAOC,cAAAA,KAAmB,CAAA;AAC3D,UAAMC,cAAcnB,UAAUiB,OAAOG,eAAAA,KAAoB,CAAA;AACzD,UAAMC,eAAeL,eAAeM,KAAKC,CAAAA,OAAMA,GAAGC,UAAUC,SAAS,KAAKC,OAAO,CAAA;AACjF,UAAM,KAAK5B,KAAK,aAAa;MAC3BuB;MAAc1B;MAAYI,KAAK;MAAMoB;IACvC,CAAA;EACF;EAEA,MAAgB/B,cAAc;AAC5B,UAAMuC,MAAmB;MAAEC,OAAO,CAAA;IAAG;AACrC,QAAIA,QAAwB,MAAMC,QAAQC,IACxC,KAAKtC,OAAOoC,MAAMG,IAAI,OAAMC,UAAS;MACnCC,OAAOD,KAAKC,SAAS;MACrBlC,KAAKmC,SAAS,MAAM,KAAKC,QAAQH,KAAKjC,GAAG,GAAG,MAAM,kCAAkCiC,KAAKjC,GAAG,GAAG;IACjG,EAAA,CAAA;AAEF,WAAO6B,MAAMQ,SAAS,GAAG;AACvB,YAAMC,gBAAgBV,IAAIC,MAAMU,GAAG,EAAC,KAAM,CAAA;AAC1C,YAAMC,oBAEFX,MAAMX,OAAO,CAACe,SAAAA;AACd,cAAMC,QAAQD,KAAKC;AACnB,YAAIA,UAAUO,QAAW;AACvB,iBAAO;QACT;AACA,YAAI,OAAOP,UAAU,WAAW;AAC9B,iBAAO;QACT;AACA,YAAI,OAAOA,UAAU,UAAU;AAC7B,iBAAOI,cAAcf,KAAKmB,CAAAA,aAAYA,SAAS1C,IAAI2B,YAAYO,SAASQ,SAAS1C,IAAI2C,YAAYT,KAAAA;QACnG;AACA,YAAIU,MAAMC,QAAQX,KAAAA,GAAQ;AACxB,iBAAOI,cAAcf,KACnBmB,CAAAA,aAAYR,MAAMR,SAASgB,SAAS1C,IAAI2B,OAAO,KAAKO,MAAMR,SAASgB,SAAS1C,IAAI2C,WAAWD,SAAS1C,IAAI2B,OAAO,CAAA;QAEnH;MACF,CAAA;AAEF,YAAMmB,UAAUN,kBAAkBtB,OAAO,CAAC6B,kBAAAA;AACxC,cAAMb,QAAQa,cAAcb;AAC5B,eAAO,EACLU,MAAMC,QAAQX,KAAAA,KACXL,MAAMmB,KACPC,CAAAA,kBAAiBf,MAAMR,SAASuB,cAAcjD,IAAI2B,OAAO,KAAKO,MAAMR,SAASuB,cAAcjD,IAAI2C,WAAWM,cAAcjD,IAAI2B,OAAO,CAAA;MAGzI,CAAA;AACAQ,eAASW,QAAQT,SAAS,GAAG,MAAM,0BAA0BR,MAAMQ,MAAM,GAAG;AAC5ET,UAAIC,MAAMqB,KAAKJ,OAAAA;AAEfjB,cAAQA,MAAMX,OAAOe,CAAAA,SAAQ,CAACa,QAAQpB,SAASO,IAAAA,CAAAA;IACjD;AACA,WAAOL;EACT;EAEA,MAAyBuB,aACvBC,OACAnD,UACAoD,aACmC;AACnC,UAAMC,UAAU,MAAMC,yBAAyBC,WAA4BJ,OAAOnD,QAAAA;AAClF,UAAMa,eAAe,MAAMwC,QAAQG,SAAQ;AAC3CtB,aAAS,MAAM,KAAKuB,UAAUN,OAAOnD,UAAUoD,WAAAA,CAAAA;AAC/C,UAAMM,iBAA4B,CAAA;AAClC,YAAQ7C,aAAaC,QAAM;MACzB,KAAKxB,2BAA2B;AAC9BoE,uBAAeT,KAAI,GAAK,MAAM,KAAKvD,OAAOM,QAAAA,CAAAA;AAC1C;MACF;MACA,SAAS;AACP,eAAO,MAAMkD,aAAaC,OAAOnD,QAAAA;MACnC;IACF;AACA,WAAO0D;EACT;AAGF;","names":["assertEx","forget","globallyUnique","BoundWitnessBuilder","isBoundWitness","notBoundWitness","QueryBoundWitnessWrapper","AbstractModuleInstance","SentinelConfigSchema","SentinelReportQuerySchema","AbstractSentinel","AbstractModuleInstance","configSchemas","SentinelConfigSchema","defaultConfigSchema","uniqueName","globallyUnique","history","_jobPromise","jobPromise","generateJob","queries","SentinelReportQuerySchema","synchronous","config","throwErrors","report","inPayloads","_noOverride","reportPromise","emit","mod","payloads","reportHandler","result","BoundWitnessBuilder","signer","account","build","flat","archiving","forget","storeToArchivists","emitReportEnd","reportQuery","queryPayload","schema","sendQueryRaw","boundwitnesses","filter","isBoundWitness","outPayloads","notBoundWitness","boundwitness","find","bw","addresses","includes","address","job","tasks","Promise","all","map","task","input","assertEx","resolve","length","previousTasks","at","newListCandidates","undefined","prevTask","modName","Array","isArray","newList","taskCandidate","some","remainingTask","push","queryHandler","query","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","getQuery","queryable","resultPayloads"]}
1
+ {"version":3,"sources":["../../src/AbstractSentinel.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { forget } from '@xylabs/forget'\nimport { globallyUnique } from '@xylabs/object'\nimport type { AccountInstance } from '@xyo-network/account-model'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\nimport type { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitness, notBoundWitness } from '@xyo-network/boundwitness-model'\nimport { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport type {\n ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult,\n} from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, Schema, WithoutPrivateStorageMeta,\n} from '@xyo-network/payload-model'\nimport type {\n CustomSentinelInstance,\n ResolvedTask,\n SentinelInstance,\n SentinelJob,\n SentinelModuleEventData,\n SentinelParams,\n SentinelQueries,\n SentinelReportQuery,\n} from '@xyo-network/sentinel-model'\nimport {\n SentinelConfigSchema,\n SentinelReportQuerySchema,\n} from '@xyo-network/sentinel-model'\n\nexport abstract class AbstractSentinel<\n TParams extends SentinelParams = SentinelParams,\n TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,\n>\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomSentinelInstance<TParams, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, SentinelConfigSchema]\n static override readonly defaultConfigSchema: Schema = SentinelConfigSchema\n static override readonly uniqueName = globallyUnique('AbstractSentinel', AbstractSentinel, 'xyo')\n history: BoundWitness[] = []\n private _jobPromise?: Promise<SentinelJob>\n\n get jobPromise() {\n this._jobPromise = this._jobPromise ?? this.generateJob()\n return this._jobPromise\n }\n\n override get queries(): string[] {\n return [SentinelReportQuerySchema, ...super.queries]\n }\n\n get synchronous(): boolean {\n return this.config.synchronous ?? false\n }\n\n get throwErrors(): boolean {\n return this.config.throwErrors ?? true\n }\n\n async report(inPayloads?: Payload[]): Promise<WithoutPrivateStorageMeta<Payload>[]> {\n this._noOverride('report')\n const reportPromise = (async () => {\n await this.emit('reportStart', { inPayloads, mod: this })\n const payloads = await this.reportHandler(inPayloads)\n\n // create boundwitness\n const result = (await new BoundWitnessBuilder().payloads(payloads).signer(this.account).build()).flat()\n\n if (this.config.archiving) {\n forget(this.storeToArchivists(result))\n }\n\n await this.emitReportEnd(inPayloads, result)\n return result\n })()\n if (this.synchronous) {\n return await reportPromise\n } else {\n forget(reportPromise)\n return []\n }\n }\n\n async reportQuery(payloads?: Payload[], account?: AccountInstance): Promise<ModuleQueryResult> {\n const queryPayload: SentinelReportQuery = { schema: SentinelReportQuerySchema }\n return await this.sendQueryRaw(queryPayload, payloads, account)\n }\n\n protected async emitReportEnd(inPayloads?: Payload[], payloads?: Payload[]) {\n const boundwitnesses = payloads?.filter(isBoundWitness) ?? []\n const outPayloads = payloads?.filter(notBoundWitness) ?? []\n const boundwitness = boundwitnesses.find(bw => bw.addresses.includes(this.address))\n await this.emit('reportEnd', {\n boundwitness, inPayloads, mod: this, outPayloads,\n })\n }\n\n protected async generateJob() {\n const job: SentinelJob = { tasks: [] }\n let tasks: ResolvedTask[] = await Promise.all(\n this.config.tasks.map(async task => ({\n input: task.input ?? false,\n mod: assertEx(await this.resolve(task.mod), () => `Unable to resolve task module [${task.mod}]`),\n })),\n )\n while (tasks.length > 0) {\n const previousTasks = job.tasks.at(-1) ?? []\n const newListCandidates\n // add all tasks that either require no previous input or have the previous input module already added\n = tasks.filter((task) => {\n const input = task.input\n if (input === undefined) {\n return true\n }\n if (typeof input === 'boolean') {\n return true\n }\n if (typeof input === 'string') {\n return previousTasks.find(prevTask => prevTask.mod.address === input || prevTask.mod.modName === input)\n }\n if (Array.isArray(input)) {\n return previousTasks.find(\n prevTask => input.includes(prevTask.mod.address) || input.includes(prevTask.mod.modName ?? prevTask.mod.address),\n )\n }\n })\n // remove any tasks that have inputs that are in the current list or the remaining tasks\n const newList = newListCandidates.filter((taskCandidate) => {\n const input = taskCandidate.input\n return !(\n Array.isArray(input)\n && tasks.some(\n remainingTask => input.includes(remainingTask.mod.address) || input.includes(remainingTask.mod.modName ?? remainingTask.mod.address),\n )\n )\n })\n assertEx(newList.length > 0, () => `Unable to generateJob [${tasks.length}]`)\n job.tasks.push(newList)\n // remove the tasks we just added\n tasks = tasks.filter(task => !newList.includes(task))\n }\n return job\n }\n\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<SentinelQueries>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(await this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n switch (queryPayload.schema) {\n case SentinelReportQuerySchema: {\n resultPayloads.push(...(await this.report(payloads)))\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return PayloadBuilder.omitPrivateStorageMeta(resultPayloads)\n }\n\n abstract reportHandler(payloads?: Payload[]): Promise<Payload[]>\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,cAAc;AACvB,SAASC,sBAAsB;AAE/B,SAASC,2BAA2B;AAEpC,SAASC,gBAAgBC,uBAAuB;AAChD,SAASC,gCAAgC;AACzC,SAASC,8BAA8B;AAIvC,SAASC,sBAAsB;AAc/B,SACEC,sBACAC,iCACK;AAEA,IAAeC,mBAAf,MAAeA,0BAIZC,uBAAAA;EAnCV,OAmCUA;;;EAER,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeC;;EAC5E,OAAyBC,sBAA8BD;EACvD,OAAyBE,aAAaC,eAAe,oBAAoBN,mBAAkB,KAAA;EAC3FO,UAA0B,CAAA;EAClBC;EAER,IAAIC,aAAa;AACf,SAAKD,cAAc,KAAKA,eAAe,KAAKE,YAAW;AACvD,WAAO,KAAKF;EACd;EAEA,IAAaG,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,cAAuB;AACzB,WAAO,KAAKC,OAAOD,eAAe;EACpC;EAEA,IAAIE,cAAuB;AACzB,WAAO,KAAKD,OAAOC,eAAe;EACpC;EAEA,MAAMC,OAAOC,YAAuE;AAClF,SAAKC,YAAY,QAAA;AACjB,UAAMC,iBAAiB,YAAA;AACrB,YAAM,KAAKC,KAAK,eAAe;QAAEH;QAAYI,KAAK;MAAK,CAAA;AACvD,YAAMC,WAAW,MAAM,KAAKC,cAAcN,UAAAA;AAG1C,YAAMO,UAAU,MAAM,IAAIC,oBAAAA,EAAsBH,SAASA,QAAAA,EAAUI,OAAO,KAAKC,OAAO,EAAEC,MAAK,GAAIC,KAAI;AAErG,UAAI,KAAKf,OAAOgB,WAAW;AACzBC,eAAO,KAAKC,kBAAkBR,MAAAA,CAAAA;MAChC;AAEA,YAAM,KAAKS,cAAchB,YAAYO,MAAAA;AACrC,aAAOA;IACT,GAAA;AACA,QAAI,KAAKX,aAAa;AACpB,aAAO,MAAMM;IACf,OAAO;AACLY,aAAOZ,aAAAA;AACP,aAAO,CAAA;IACT;EACF;EAEA,MAAMe,YAAYZ,UAAsBK,SAAuD;AAC7F,UAAMQ,eAAoC;MAAEC,QAAQxB;IAA0B;AAC9E,WAAO,MAAM,KAAKyB,aAAaF,cAAcb,UAAUK,OAAAA;EACzD;EAEA,MAAgBM,cAAchB,YAAwBK,UAAsB;AAC1E,UAAMgB,iBAAiBhB,UAAUiB,OAAOC,cAAAA,KAAmB,CAAA;AAC3D,UAAMC,cAAcnB,UAAUiB,OAAOG,eAAAA,KAAoB,CAAA;AACzD,UAAMC,eAAeL,eAAeM,KAAKC,CAAAA,OAAMA,GAAGC,UAAUC,SAAS,KAAKC,OAAO,CAAA;AACjF,UAAM,KAAK5B,KAAK,aAAa;MAC3BuB;MAAc1B;MAAYI,KAAK;MAAMoB;IACvC,CAAA;EACF;EAEA,MAAgB/B,cAAc;AAC5B,UAAMuC,MAAmB;MAAEC,OAAO,CAAA;IAAG;AACrC,QAAIA,QAAwB,MAAMC,QAAQC,IACxC,KAAKtC,OAAOoC,MAAMG,IAAI,OAAMC,UAAS;MACnCC,OAAOD,KAAKC,SAAS;MACrBlC,KAAKmC,SAAS,MAAM,KAAKC,QAAQH,KAAKjC,GAAG,GAAG,MAAM,kCAAkCiC,KAAKjC,GAAG,GAAG;IACjG,EAAA,CAAA;AAEF,WAAO6B,MAAMQ,SAAS,GAAG;AACvB,YAAMC,gBAAgBV,IAAIC,MAAMU,GAAG,EAAC,KAAM,CAAA;AAC1C,YAAMC,oBAEFX,MAAMX,OAAO,CAACe,SAAAA;AACd,cAAMC,QAAQD,KAAKC;AACnB,YAAIA,UAAUO,QAAW;AACvB,iBAAO;QACT;AACA,YAAI,OAAOP,UAAU,WAAW;AAC9B,iBAAO;QACT;AACA,YAAI,OAAOA,UAAU,UAAU;AAC7B,iBAAOI,cAAcf,KAAKmB,CAAAA,aAAYA,SAAS1C,IAAI2B,YAAYO,SAASQ,SAAS1C,IAAI2C,YAAYT,KAAAA;QACnG;AACA,YAAIU,MAAMC,QAAQX,KAAAA,GAAQ;AACxB,iBAAOI,cAAcf,KACnBmB,CAAAA,aAAYR,MAAMR,SAASgB,SAAS1C,IAAI2B,OAAO,KAAKO,MAAMR,SAASgB,SAAS1C,IAAI2C,WAAWD,SAAS1C,IAAI2B,OAAO,CAAA;QAEnH;MACF,CAAA;AAEF,YAAMmB,UAAUN,kBAAkBtB,OAAO,CAAC6B,kBAAAA;AACxC,cAAMb,QAAQa,cAAcb;AAC5B,eAAO,EACLU,MAAMC,QAAQX,KAAAA,KACXL,MAAMmB,KACPC,CAAAA,kBAAiBf,MAAMR,SAASuB,cAAcjD,IAAI2B,OAAO,KAAKO,MAAMR,SAASuB,cAAcjD,IAAI2C,WAAWM,cAAcjD,IAAI2B,OAAO,CAAA;MAGzI,CAAA;AACAQ,eAASW,QAAQT,SAAS,GAAG,MAAM,0BAA0BR,MAAMQ,MAAM,GAAG;AAC5ET,UAAIC,MAAMqB,KAAKJ,OAAAA;AAEfjB,cAAQA,MAAMX,OAAOe,CAAAA,SAAQ,CAACa,QAAQpB,SAASO,IAAAA,CAAAA;IACjD;AACA,WAAOL;EACT;EAEA,MAAyBuB,aACvBC,OACAnD,UACAoD,aACmC;AACnC,UAAMC,UAAUC,yBAAyBC,WAA4BJ,OAAOnD,QAAAA;AAC5E,UAAMa,eAAe,MAAMwC,QAAQG,SAAQ;AAC3CtB,aAAS,MAAM,KAAKuB,UAAUN,OAAOnD,UAAUoD,WAAAA,CAAAA;AAC/C,UAAMM,iBAA4B,CAAA;AAClC,YAAQ7C,aAAaC,QAAM;MACzB,KAAKxB,2BAA2B;AAC9BoE,uBAAeT,KAAI,GAAK,MAAM,KAAKvD,OAAOM,QAAAA,CAAAA;AAC1C;MACF;MACA,SAAS;AACP,eAAO,MAAMkD,aAAaC,OAAOnD,QAAAA;MACnC;IACF;AACA,WAAO2D,eAAeC,uBAAuBF,cAAAA;EAC/C;AAGF;","names":["assertEx","forget","globallyUnique","BoundWitnessBuilder","isBoundWitness","notBoundWitness","QueryBoundWitnessWrapper","AbstractModuleInstance","PayloadBuilder","SentinelConfigSchema","SentinelReportQuerySchema","AbstractSentinel","AbstractModuleInstance","configSchemas","SentinelConfigSchema","defaultConfigSchema","uniqueName","globallyUnique","history","_jobPromise","jobPromise","generateJob","queries","SentinelReportQuerySchema","synchronous","config","throwErrors","report","inPayloads","_noOverride","reportPromise","emit","mod","payloads","reportHandler","result","BoundWitnessBuilder","signer","account","build","flat","archiving","forget","storeToArchivists","emitReportEnd","reportQuery","queryPayload","schema","sendQueryRaw","boundwitnesses","filter","isBoundWitness","outPayloads","notBoundWitness","boundwitness","find","bw","addresses","includes","address","job","tasks","Promise","all","map","task","input","assertEx","resolve","length","previousTasks","at","newListCandidates","undefined","prevTask","modName","Array","isArray","newList","taskCandidate","some","remainingTask","push","queryHandler","query","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","getQuery","queryable","resultPayloads","PayloadBuilder","omitPrivateStorageMeta"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/sentinel-abstract",
3
- "version": "3.5.2",
3
+ "version": "3.6.0-rc.10",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,24 +29,26 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/assert": "^4.4.9",
33
- "@xylabs/forget": "^4.4.9",
34
- "@xylabs/object": "^4.4.9",
35
- "@xyo-network/account-model": "^3.5.2",
36
- "@xyo-network/boundwitness-builder": "^3.5.2",
37
- "@xyo-network/boundwitness-model": "^3.5.2",
38
- "@xyo-network/boundwitness-wrapper": "^3.5.2",
39
- "@xyo-network/module-abstract": "^3.5.2",
40
- "@xyo-network/module-model": "^3.5.2",
41
- "@xyo-network/payload-model": "^3.5.2",
42
- "@xyo-network/sentinel-model": "^3.5.2"
32
+ "@xylabs/assert": "^4.4.21",
33
+ "@xylabs/forget": "^4.4.21",
34
+ "@xylabs/object": "^4.4.21",
35
+ "@xyo-network/account-model": "^3.6.0-rc.10",
36
+ "@xyo-network/boundwitness-builder": "^3.6.0-rc.10",
37
+ "@xyo-network/boundwitness-model": "^3.6.0-rc.10",
38
+ "@xyo-network/boundwitness-wrapper": "^3.6.0-rc.10",
39
+ "@xyo-network/module-abstract": "^3.6.0-rc.10",
40
+ "@xyo-network/module-model": "^3.6.0-rc.10",
41
+ "@xyo-network/payload-builder": "^3.6.0-rc.10",
42
+ "@xyo-network/payload-model": "^3.6.0-rc.10",
43
+ "@xyo-network/sentinel-model": "^3.6.0-rc.10"
43
44
  },
44
45
  "devDependencies": {
45
- "@xylabs/ts-scripts-yarn3": "^4.2.4",
46
- "@xylabs/tsconfig": "^4.2.4",
46
+ "@xylabs/ts-scripts-yarn3": "^4.2.6",
47
+ "@xylabs/tsconfig": "^4.2.6",
47
48
  "typescript": "^5.7.2"
48
49
  },
49
50
  "publishConfig": {
50
51
  "access": "public"
51
- }
52
+ },
53
+ "stableVersion": "3.5.2"
52
54
  }
package/src/AbstractSentinel.ts CHANGED
@@ -10,7 +10,10 @@ import { AbstractModuleInstance } from '@xyo-network/module-abstract'
10
10
  import type {
11
11
  ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult,
12
12
  } from '@xyo-network/module-model'
13
- import type { Payload, Schema } from '@xyo-network/payload-model'
13
+ import { PayloadBuilder } from '@xyo-network/payload-builder'
14
+ import type {
15
+ Payload, Schema, WithoutPrivateStorageMeta,
16
+ } from '@xyo-network/payload-model'
14
17
  import type {
15
18
  CustomSentinelInstance,
16
19
  ResolvedTask,
@@ -55,7 +58,7 @@ export abstract class AbstractSentinel<
55
58
  return this.config.throwErrors ?? true
56
59
  }
57
60
 
58
- async report(inPayloads?: Payload[]): Promise<Payload[]> {
61
+ async report(inPayloads?: Payload[]): Promise<WithoutPrivateStorageMeta<Payload>[]> {
59
62
  this._noOverride('report')
60
63
  const reportPromise = (async () => {
61
64
  await this.emit('reportStart', { inPayloads, mod: this })
@@ -145,7 +148,7 @@ export abstract class AbstractSentinel<
145
148
  payloads?: Payload[],
146
149
  queryConfig?: TConfig,
147
150
  ): Promise<ModuleQueryHandlerResult> {
148
- const wrapper = await QueryBoundWitnessWrapper.parseQuery<SentinelQueries>(query, payloads)
151
+ const wrapper = QueryBoundWitnessWrapper.parseQuery<SentinelQueries>(query, payloads)
149
152
  const queryPayload = await wrapper.getQuery()
150
153
  assertEx(await this.queryable(query, payloads, queryConfig))
151
154
  const resultPayloads: Payload[] = []
@@ -158,7 +161,7 @@ export abstract class AbstractSentinel<
158
161
  return super.queryHandler(query, payloads)
159
162
  }
160
163
  }
161
- return resultPayloads
164
+ return PayloadBuilder.omitPrivateStorageMeta(resultPayloads)
162
165
  }
163
166
 
164
167
  abstract reportHandler(payloads?: Payload[]): Promise<Payload[]>