@xyo-network/abstract-witness 2.75.0 → 2.75.2

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.
@@ -0,0 +1,24 @@
1
+ import { ArchivistInstance } from '@xyo-network/archivist-model';
2
+ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
3
+ import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
4
+ import { Payload } from '@xyo-network/payload-model';
5
+ import { Promisable } from '@xyo-network/promise';
6
+ import { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
7
+ export declare abstract class AbstractWitness<TParams extends WitnessParams = WitnessParams, TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>> extends AbstractModuleInstance<TParams, TEventData> implements CustomWitnessInstance<TParams, TEventData> {
8
+ static readonly configSchemas: string[];
9
+ private _archivistInstance;
10
+ get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
11
+ get queries(): string[];
12
+ get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
13
+ schema: "network.xyo.payload.set";
14
+ }) | undefined;
15
+ protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
16
+ getArchivistInstance(): Promise<ArchivistInstance | undefined>;
17
+ /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
18
+ observe(inPayloads?: Payload[]): Promise<Payload[]>;
19
+ /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
20
+ protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
21
+ /** @function observeHandler Implement or override to add custom functionality to a witness */
22
+ protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
23
+ }
24
+ //# sourceMappingURL=AbstractWitness.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AbstractWitness.d.ts","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAA4B,MAAM,mCAAmC,CAAA;AAE/F,OAAO,EAAE,sBAAsB,EAAmB,YAAY,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AACrH,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EACL,qBAAqB,EAErB,eAAe,EACf,sBAAsB,EAEtB,aAAa,EAEb,gBAAgB,EACjB,MAAM,4BAA4B,CAAA;AAGnC,8BAAsB,eAAe,CACjC,OAAO,SAAS,aAAa,GAAG,aAAa,EAC7C,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAExH,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC;IAErD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwB;IAExE,OAAO,CAAC,kBAAkB,CAA+B;IAEzD,IAAI,SAAS,uIAEZ;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAED,IAAI,SAAS;;mBAEZ;IAED,cAAuB,kBAAkB,IAAI,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAItF;IAEK,oBAAoB;IAM1B,wJAAwJ;IAClJ,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBzD,0GAA0G;cACjF,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;IAoBpC,8FAA8F;IAC9F,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;CAC/E"}
@@ -1,14 +1,12 @@
1
1
  var __defProp = Object.defineProperty;
2
2
  var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
3
-
4
- // src/AbstractWitness.ts
5
3
  import { assertEx } from "@xylabs/assert";
6
4
  import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-builder";
7
5
  import { PayloadHasher } from "@xyo-network/core";
8
6
  import { AbstractModuleInstance, creatableModule } from "@xyo-network/module";
9
7
  import { WitnessConfigSchema, WitnessObserveQuerySchema } from "@xyo-network/witness-model";
10
8
  creatableModule();
11
- var AbstractWitness = class extends AbstractModuleInstance {
9
+ class AbstractWitness extends AbstractModuleInstance {
12
10
  static {
13
11
  __name(this, "AbstractWitness");
14
12
  }
@@ -79,7 +77,7 @@ var AbstractWitness = class extends AbstractModuleInstance {
79
77
  }
80
78
  return resultPayloads;
81
79
  }
82
- };
80
+ }
83
81
  export {
84
82
  AbstractWitness
85
83
  };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\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<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AAEzB,SAA4BC,gCAAgC;AAC5D,SAASC,qBAAqB;AAC9B,SAASC,wBAAwBC,uBAA+D;AAGhG,SAEEC,qBAGAC,iCAIK;AAEPC,gBAAAA;AACO,IAAeC,kBAAf,cAIGC,uBAAAA;EAvBV,OAuBUA;;;EAGR,OAAyBC,gBAA0B;IAACC;;EAE5CC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AACd,WAAO,KAAKH,QAAQG;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKP;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBQ,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKV;EACd;;EAGA,MAAMW,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,cAAcC,SAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,aAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,iBAAaI,QAAQ,CAACC,YAAYJ,SAASI,QAAQC,QAAQ,yBAAA,CAAA;AAE3D,UAAMtB,YAAY,MAAM,KAAKM,qBAAoB;AACjD,QAAIN,WAAW;AACb,YAAMA,UAAUuB,OAAOP,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBQ,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUC,yBAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,aAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,cAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,2BAA2B;AAC9B,cAAMmC,kBAAkB,MAAM,KAAK5B,QAAQyB,mBAAAA;AAC3CD,uBAAeK,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMd,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOQ;EACT;AAIF;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","creatableModule","AbstractWitness","AbstractModuleInstance","configSchemas","WitnessConfigSchema","_archivistInstance","archivist","config","queries","WitnessObserveQuerySchema","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","assertEx","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","PayloadHasher","filterExclude","observePayloads","push"]}
1
+ {"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\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<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;AAAA,SAASA,gBAAgB;AAEzB,SAA4BC,gCAAgC;AAC5D,SAASC,qBAAqB;AAC9B,SAASC,wBAAwBC,uBAA+D;AAGhG,SAEEC,qBAGAC,iCAIK;AAEPF,gBAAAA;AACO,MAAeG,wBAIZJ,uBAAAA;EAvBV,OAuBUA;;;EAGR,OAAyBK,gBAA0B;IAACH;;EAE5CI;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACN;SAA8B,MAAMM;;EAC9C;EAEA,IAAIC,YAAY;AACd,WAAO,KAAKF,QAAQE;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKN;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBO,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKT;EACd;;EAGA,MAAMU,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,cAAczB,SAAS,MAAM,KAAK0B,eAAeN,UAAAA,GAAa,2BAAA;AACpEpB,aAASyB,YAAYE,SAAS,GAAG,8BAAA;AACjCF,iBAAaG,QAAQ,CAACC,YAAY7B,SAAS6B,QAAQC,QAAQ,yBAAA,CAAA;AAE3D,UAAMpB,YAAY,MAAM,KAAKK,qBAAoB;AACjD,QAAIL,WAAW;AACb,YAAMA,UAAUqB,OAAON,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBO,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUnC,yBAAyBoC,WAAyBJ,OAAOC,QAAAA;AACzE,UAAMI,eAAe,MAAMF,QAAQG,SAAQ;AAC3CvC,aAAS,KAAKwC,UAAUP,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMM,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMxC,cAAcyC,cAAcT,UAAUD,MAAMA,KAAK;AACnF,YAAQK,aAAaR,QAAM;MACzB,KAAKxB,2BAA2B;AAC9B,cAAMsC,kBAAkB,MAAM,KAAKzB,QAAQuB,mBAAAA;AAC3CD,uBAAeI,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMZ,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOO;EACT;AAIF;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","AbstractWitness","configSchemas","_archivistInstance","archivist","config","queries","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","filterExclude","observePayloads","push"]}
@@ -0,0 +1,2 @@
1
+ export * from './AbstractWitness';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
@@ -1,86 +1,2 @@
1
- var __defProp = Object.defineProperty;
2
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
3
-
4
- // src/AbstractWitness.ts
5
- import { assertEx } from "@xylabs/assert";
6
- import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-builder";
7
- import { PayloadHasher } from "@xyo-network/core";
8
- import { AbstractModuleInstance, creatableModule } from "@xyo-network/module";
9
- import { WitnessConfigSchema, WitnessObserveQuerySchema } from "@xyo-network/witness-model";
10
- creatableModule();
11
- var AbstractWitness = class extends AbstractModuleInstance {
12
- static {
13
- __name(this, "AbstractWitness");
14
- }
15
- static configSchemas = [
16
- WitnessConfigSchema
17
- ];
18
- _archivistInstance;
19
- get archivist() {
20
- return this.config.archivist;
21
- }
22
- get queries() {
23
- return [
24
- WitnessObserveQuerySchema,
25
- ...super.queries
26
- ];
27
- }
28
- get targetSet() {
29
- return this.config?.targetSet;
30
- }
31
- get _queryAccountPaths() {
32
- return {
33
- "network.xyo.query.witness.observe": "1/1"
34
- };
35
- }
36
- async getArchivistInstance() {
37
- const archivistAddress = this.archivist;
38
- this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
39
- return this._archivistInstance;
40
- }
41
- /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
42
- async observe(inPayloads) {
43
- this._noOverride("observe");
44
- await this.started("throw");
45
- await this.emit("observeStart", {
46
- inPayloads,
47
- module: this
48
- });
49
- const outPayloads = assertEx(await this.observeHandler(inPayloads), "Trying to witness nothing");
50
- assertEx(outPayloads.length > 0, "Trying to witness empty list");
51
- outPayloads?.forEach((payload) => assertEx(payload.schema, "observe: Missing Schema"));
52
- const archivist = await this.getArchivistInstance();
53
- if (archivist) {
54
- await archivist.insert(outPayloads);
55
- }
56
- await this.emit("observeEnd", {
57
- inPayloads,
58
- module: this,
59
- outPayloads
60
- });
61
- return outPayloads;
62
- }
63
- /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
64
- async queryHandler(query, payloads, queryConfig) {
65
- const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
66
- const queryPayload = await wrapper.getQuery();
67
- assertEx(this.queryable(query, payloads, queryConfig));
68
- const resultPayloads = [];
69
- const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query);
70
- switch (queryPayload.schema) {
71
- case WitnessObserveQuerySchema: {
72
- const observePayloads = await this.observe(filteredObservation);
73
- resultPayloads.push(...observePayloads);
74
- break;
75
- }
76
- default: {
77
- return super.queryHandler(query, payloads);
78
- }
79
- }
80
- return resultPayloads;
81
- }
82
- };
83
- export {
84
- AbstractWitness
85
- };
1
+ export * from "./AbstractWitness";
86
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\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<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AAEzB,SAA4BC,gCAAgC;AAC5D,SAASC,qBAAqB;AAC9B,SAASC,wBAAwBC,uBAA+D;AAGhG,SAEEC,qBAGAC,iCAIK;AAEPC,gBAAAA;AACO,IAAeC,kBAAf,cAIGC,uBAAAA;EAvBV,OAuBUA;;;EAGR,OAAyBC,gBAA0B;IAACC;;EAE5CC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AACd,WAAO,KAAKH,QAAQG;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKP;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBQ,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKV;EACd;;EAGA,MAAMW,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,cAAcC,SAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,aAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,iBAAaI,QAAQ,CAACC,YAAYJ,SAASI,QAAQC,QAAQ,yBAAA,CAAA;AAE3D,UAAMtB,YAAY,MAAM,KAAKM,qBAAoB;AACjD,QAAIN,WAAW;AACb,YAAMA,UAAUuB,OAAOP,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBQ,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUC,yBAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,aAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,cAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,2BAA2B;AAC9B,cAAMmC,kBAAkB,MAAM,KAAK5B,QAAQyB,mBAAAA;AAC3CD,uBAAeK,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMd,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOQ;EACT;AAIF;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","creatableModule","AbstractWitness","AbstractModuleInstance","configSchemas","WitnessConfigSchema","_archivistInstance","archivist","config","queries","WitnessObserveQuerySchema","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","assertEx","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","PayloadHasher","filterExclude","observePayloads","push"]}
1
+ {"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './AbstractWitness'\n"],"mappings":"AAAA,cAAc;","names":[]}