@xyo-network/abstract-witness 2.72.9 → 2.73.0

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.
@@ -1,15 +1,18 @@
1
+ import * as _xyo_network_payload_model from '@xyo-network/payload-model';
2
+ import { Payload } from '@xyo-network/payload-model';
3
+ import * as _xyo_network_module_model from '@xyo-network/module-model';
1
4
  import { ArchivistInstance } from '@xyo-network/archivist-model';
2
5
  import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
3
6
  import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
4
- import { Payload } from '@xyo-network/payload-model';
5
7
  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
+ import { WitnessParams, WitnessModuleEventData, WitnessInstance, CustomWitnessInstance, WitnessQueryBase } from '@xyo-network/witness-model';
9
+
10
+ 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
11
  static readonly configSchemas: string[];
9
12
  private _archivistInstance;
10
- get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
13
+ get archivist(): (_xyo_network_module_model.ArchivistModuleConfig & (_xyo_network_module_model.ArchivistModuleConfig & string)) | undefined;
11
14
  get queries(): string[];
12
- get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
15
+ get targetSet(): (_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_payload_model.PayloadSet & {
13
16
  schema: "network.xyo.payload.set";
14
17
  }) | undefined;
15
18
  protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
@@ -21,4 +24,5 @@ export declare abstract class AbstractWitness<TParams extends WitnessParams = Wi
21
24
  /** @function observeHandler Implement or override to add custom functionality to a witness */
22
25
  protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
23
26
  }
24
- //# sourceMappingURL=AbstractWitness.d.ts.map
27
+
28
+ export { AbstractWitness };
@@ -0,0 +1,28 @@
1
+ import * as _xyo_network_payload_model from '@xyo-network/payload-model';
2
+ import { Payload } from '@xyo-network/payload-model';
3
+ import * as _xyo_network_module_model from '@xyo-network/module-model';
4
+ import { ArchivistInstance } from '@xyo-network/archivist-model';
5
+ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
6
+ import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
7
+ import { Promisable } from '@xyo-network/promise';
8
+ import { WitnessParams, WitnessModuleEventData, WitnessInstance, CustomWitnessInstance, WitnessQueryBase } from '@xyo-network/witness-model';
9
+
10
+ declare abstract class AbstractWitness<TParams extends WitnessParams = WitnessParams, TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>> extends AbstractModuleInstance<TParams, TEventData> implements CustomWitnessInstance<TParams, TEventData> {
11
+ static readonly configSchemas: string[];
12
+ private _archivistInstance;
13
+ get archivist(): (_xyo_network_module_model.ArchivistModuleConfig & (_xyo_network_module_model.ArchivistModuleConfig & string)) | undefined;
14
+ get queries(): string[];
15
+ get targetSet(): (_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_payload_model.PayloadSet & {
16
+ schema: "network.xyo.payload.set";
17
+ }) | undefined;
18
+ protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
19
+ getArchivistInstance(): Promise<ArchivistInstance | undefined>;
20
+ /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
21
+ observe(inPayloads?: Payload[]): Promise<Payload[]>;
22
+ /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
23
+ protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
24
+ /** @function observeHandler Implement or override to add custom functionality to a witness */
25
+ protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
26
+ }
27
+
28
+ export { AbstractWitness };
package/dist/index.js ADDED
@@ -0,0 +1,111 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
7
+ var __export = (target, all) => {
8
+ for (var name in all)
9
+ __defProp(target, name, { get: all[name], enumerable: true });
10
+ };
11
+ var __copyProps = (to, from, except, desc) => {
12
+ if (from && typeof from === "object" || typeof from === "function") {
13
+ for (let key of __getOwnPropNames(from))
14
+ if (!__hasOwnProp.call(to, key) && key !== except)
15
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
16
+ }
17
+ return to;
18
+ };
19
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
20
+
21
+ // src/index.ts
22
+ var src_exports = {};
23
+ __export(src_exports, {
24
+ AbstractWitness: () => AbstractWitness
25
+ });
26
+ module.exports = __toCommonJS(src_exports);
27
+
28
+ // src/AbstractWitness.ts
29
+ var import_assert = require("@xylabs/assert");
30
+ var import_boundwitness_builder = require("@xyo-network/boundwitness-builder");
31
+ var import_core = require("@xyo-network/core");
32
+ var import_module = require("@xyo-network/module");
33
+ var import_witness_model = require("@xyo-network/witness-model");
34
+ (0, import_module.creatableModule)();
35
+ var AbstractWitness = class extends import_module.AbstractModuleInstance {
36
+ static {
37
+ __name(this, "AbstractWitness");
38
+ }
39
+ static configSchemas = [
40
+ import_witness_model.WitnessConfigSchema
41
+ ];
42
+ _archivistInstance;
43
+ get archivist() {
44
+ return this.config.archivist;
45
+ }
46
+ get queries() {
47
+ return [
48
+ import_witness_model.WitnessObserveQuerySchema,
49
+ ...super.queries
50
+ ];
51
+ }
52
+ get targetSet() {
53
+ return this.config?.targetSet;
54
+ }
55
+ get _queryAccountPaths() {
56
+ return {
57
+ "network.xyo.query.witness.observe": "1/1"
58
+ };
59
+ }
60
+ async getArchivistInstance() {
61
+ const archivistAddress = this.archivist;
62
+ this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
63
+ return this._archivistInstance;
64
+ }
65
+ /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
66
+ async observe(inPayloads) {
67
+ this._noOverride("observe");
68
+ await this.started("throw");
69
+ await this.emit("observeStart", {
70
+ inPayloads,
71
+ module: this
72
+ });
73
+ const outPayloads = (0, import_assert.assertEx)(await this.observeHandler(inPayloads), "Trying to witness nothing");
74
+ (0, import_assert.assertEx)(outPayloads.length > 0, "Trying to witness empty list");
75
+ outPayloads?.forEach((payload) => (0, import_assert.assertEx)(payload.schema, "observe: Missing Schema"));
76
+ const archivist = await this.getArchivistInstance();
77
+ if (archivist) {
78
+ await archivist.insert(outPayloads);
79
+ }
80
+ await this.emit("observeEnd", {
81
+ inPayloads,
82
+ module: this,
83
+ outPayloads
84
+ });
85
+ return outPayloads;
86
+ }
87
+ /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
88
+ async queryHandler(query, payloads, queryConfig) {
89
+ const wrapper = import_boundwitness_builder.QueryBoundWitnessWrapper.parseQuery(query, payloads);
90
+ const queryPayload = await wrapper.getQuery();
91
+ (0, import_assert.assertEx)(this.queryable(query, payloads, queryConfig));
92
+ const resultPayloads = [];
93
+ const filteredObservation = await import_core.PayloadHasher.filterExclude(payloads, query.query);
94
+ switch (queryPayload.schema) {
95
+ case import_witness_model.WitnessObserveQuerySchema: {
96
+ const observePayloads = await this.observe(filteredObservation);
97
+ resultPayloads.push(...observePayloads);
98
+ break;
99
+ }
100
+ default: {
101
+ return super.queryHandler(query, payloads);
102
+ }
103
+ }
104
+ return resultPayloads;
105
+ }
106
+ };
107
+ // Annotate the CommonJS export names for ESM import in node:
108
+ 0 && (module.exports = {
109
+ AbstractWitness
110
+ });
111
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/AbstractWitness.ts"],"sourcesContent":["export * from './AbstractWitness'\n","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;;;;;;;ACAA,oBAAyB;AAEzB,kCAA4D;AAC5D,kBAA8B;AAC9B,oBAAgG;AAGhG,2BASO;IAEPA,+BAAAA;AACO,IAAeC,kBAAf,cAIGC,qCAAAA;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,kBAAcC,wBAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,gCAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,iBAAaI,QAAQ,CAACC,gBAAYJ,wBAASI,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,qDAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,gCAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,0BAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,gDAA2B;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":["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"]}
package/dist/index.mjs ADDED
@@ -0,0 +1,86 @@
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
+ };
86
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +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"]}
package/package.json CHANGED
@@ -10,42 +10,56 @@
10
10
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
11
  },
12
12
  "dependencies": {
13
- "@xylabs/assert": "^2.9.3",
14
- "@xyo-network/archivist-model": "~2.72.9",
15
- "@xyo-network/boundwitness-builder": "~2.72.9",
16
- "@xyo-network/core": "~2.72.9",
17
- "@xyo-network/module": "~2.72.9",
18
- "@xyo-network/payload-model": "~2.72.9",
19
- "@xyo-network/promise": "~2.72.9",
20
- "@xyo-network/witness-model": "~2.72.9"
13
+ "@xylabs/assert": "^2.10.7",
14
+ "@xyo-network/archivist-model": "~2.73.0",
15
+ "@xyo-network/boundwitness-builder": "~2.73.0",
16
+ "@xyo-network/core": "~2.73.0",
17
+ "@xyo-network/module": "~2.73.0",
18
+ "@xyo-network/payload-model": "~2.73.0",
19
+ "@xyo-network/promise": "~2.73.0",
20
+ "@xyo-network/witness-model": "~2.73.0"
21
21
  },
22
22
  "devDependencies": {
23
- "@xylabs/ts-scripts-yarn3": "^2.19.3",
24
- "@xylabs/tsconfig": "^2.19.3",
23
+ "@xylabs/ts-scripts-yarn3": "^2.19.5",
24
+ "@xylabs/tsconfig": "^2.19.5",
25
+ "publint": "^0.2.2",
26
+ "tsup": "^7.2.0",
25
27
  "typescript": "^5.2.2"
26
28
  },
29
+ "scripts": {
30
+ "package-compile": "tsup && publint",
31
+ "package-recompile": "tsup && publint"
32
+ },
27
33
  "description": "Primary SDK for using XYO Protocol 2.0",
28
- "browser": "dist/esm/index.js",
29
34
  "docs": "dist/docs.json",
35
+ "types": "dist/index.d.ts",
30
36
  "exports": {
31
37
  ".": {
32
- "node": {
33
- "import": "./dist/esm/index.js",
34
- "require": "./dist/cjs/index.js"
35
- },
36
- "browser": {
37
- "import": "./dist/esm/index.js",
38
- "require": "./dist/cjs/index.js"
38
+ "require": {
39
+ "types": "./dist/index.d.ts",
40
+ "default": "./dist/index.js"
39
41
  },
40
- "default": "./dist/esm/index.js"
42
+ "import": {
43
+ "types": "./dist/index.d.mts",
44
+ "default": "./dist/index.mjs"
45
+ }
41
46
  },
42
47
  "./dist/docs.json": {
43
48
  "default": "./dist/docs.json"
44
49
  },
50
+ "./cjs": {
51
+ "default": "./dist/index.js"
52
+ },
53
+ "./docs": {
54
+ "default": "./dist/docs.json"
55
+ },
56
+ "./esm": {
57
+ "default": "./dist/index.mjs"
58
+ },
45
59
  "./package.json": "./package.json"
46
60
  },
47
- "main": "dist/cjs/index.js",
48
- "module": "dist/esm/index.js",
61
+ "main": "dist/index.js",
62
+ "module": "dist/index.mjs",
49
63
  "homepage": "https://xyo.network",
50
64
  "license": "LGPL-3.0",
51
65
  "publishConfig": {
@@ -56,6 +70,5 @@
56
70
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
57
71
  },
58
72
  "sideEffects": false,
59
- "types": "dist/types/index.d.ts",
60
- "version": "2.72.9"
73
+ "version": "2.73.0"
61
74
  }
package/tsup.config.ts ADDED
@@ -0,0 +1,16 @@
1
+ import { defineConfig } from 'tsup'
2
+
3
+ // eslint-disable-next-line import/no-default-export
4
+ export default defineConfig({
5
+ bundle: true,
6
+ cjsInterop: true,
7
+ clean: true,
8
+ dts: {
9
+ entry: ['src/index.ts'],
10
+ },
11
+ entry: ['src/index.ts'],
12
+ format: ['cjs', 'esm'],
13
+ sourcemap: true,
14
+ splitting: false,
15
+ tsconfig: 'tsconfig.json',
16
+ })
@@ -1,80 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AbstractWitness = void 0;
4
- const tslib_1 = require("tslib");
5
- const assert_1 = require("@xylabs/assert");
6
- const boundwitness_builder_1 = require("@xyo-network/boundwitness-builder");
7
- const core_1 = require("@xyo-network/core");
8
- const module_1 = require("@xyo-network/module");
9
- const witness_model_1 = require("@xyo-network/witness-model");
10
- (0, module_1.creatableModule)();
11
- class AbstractWitness extends module_1.AbstractModuleInstance {
12
- get archivist() {
13
- return this.config.archivist;
14
- }
15
- get queries() {
16
- return [witness_model_1.WitnessObserveQuerySchema, ...super.queries];
17
- }
18
- get targetSet() {
19
- var _a;
20
- return (_a = this.config) === null || _a === void 0 ? void 0 : _a.targetSet;
21
- }
22
- get _queryAccountPaths() {
23
- return {
24
- 'network.xyo.query.witness.observe': '1/1',
25
- };
26
- }
27
- getArchivistInstance() {
28
- var _a;
29
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
30
- const archivistAddress = this.archivist;
31
- this._archivistInstance = (_a = this._archivistInstance) !== null && _a !== void 0 ? _a : (archivistAddress ? yield this.resolve(archivistAddress) : undefined);
32
- return this._archivistInstance;
33
- });
34
- }
35
- /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
36
- observe(inPayloads) {
37
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
38
- this._noOverride('observe');
39
- yield this.started('throw');
40
- yield this.emit('observeStart', { inPayloads: inPayloads, module: this });
41
- const outPayloads = (0, assert_1.assertEx)(yield this.observeHandler(inPayloads), 'Trying to witness nothing');
42
- (0, assert_1.assertEx)(outPayloads.length > 0, 'Trying to witness empty list');
43
- outPayloads === null || outPayloads === void 0 ? void 0 : outPayloads.forEach((payload) => (0, assert_1.assertEx)(payload.schema, 'observe: Missing Schema'));
44
- const archivist = yield this.getArchivistInstance();
45
- if (archivist) {
46
- yield archivist.insert(outPayloads);
47
- }
48
- yield this.emit('observeEnd', { inPayloads, module: this, outPayloads });
49
- return outPayloads;
50
- });
51
- }
52
- /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
53
- queryHandler(query, payloads, queryConfig) {
54
- const _super = Object.create(null, {
55
- queryHandler: { get: () => super.queryHandler }
56
- });
57
- return tslib_1.__awaiter(this, void 0, void 0, function* () {
58
- const wrapper = boundwitness_builder_1.QueryBoundWitnessWrapper.parseQuery(query, payloads);
59
- const queryPayload = yield wrapper.getQuery();
60
- (0, assert_1.assertEx)(this.queryable(query, payloads, queryConfig));
61
- const resultPayloads = [];
62
- // Remove the query payload from the arguments passed to us so we don't observe it
63
- const filteredObservation = yield core_1.PayloadHasher.filterExclude(payloads, query.query);
64
- switch (queryPayload.schema) {
65
- case witness_model_1.WitnessObserveQuerySchema: {
66
- const observePayloads = yield this.observe(filteredObservation);
67
- resultPayloads.push(...observePayloads);
68
- break;
69
- }
70
- default: {
71
- return _super.queryHandler.call(this, query, payloads);
72
- }
73
- }
74
- return resultPayloads;
75
- });
76
- }
77
- }
78
- exports.AbstractWitness = AbstractWitness;
79
- AbstractWitness.configSchemas = [witness_model_1.WitnessConfigSchema];
80
- //# sourceMappingURL=AbstractWitness.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"AbstractWitness.js","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":";;;;AAAA,2CAAyC;AAEzC,4EAA+F;AAC/F,4CAAiD;AACjD,gDAAqH;AAGrH,8DASmC;AAEnC,IAAA,wBAAe,GAAE,CAAA;AACjB,MAAsB,eAIpB,SAAQ,+BAA2C;IAOnD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAA;IAC9B,CAAC;IAED,IAAa,OAAO;QAClB,OAAO,CAAC,yCAAyB,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC;IAED,IAAI,SAAS;;QACX,OAAO,MAAA,IAAI,CAAC,MAAM,0CAAE,SAAS,CAAA;IAC/B,CAAC;IAED,IAAuB,kBAAkB;QACvC,OAAO;YACL,mCAAmC,EAAE,KAAK;SAC3C,CAAA;IACH,CAAC;IAEK,oBAAoB;;;YACxB,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAA;YACvC,IAAI,CAAC,kBAAkB,GAAG,MAAA,IAAI,CAAC,kBAAkB,mCAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAC1H,OAAO,IAAI,CAAC,kBAAkB,CAAA;;KAC/B;IAED,wJAAwJ;IAClJ,OAAO,CAAC,UAAsB;;YAClC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;YAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAC3B,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;YACzE,MAAM,WAAW,GAAG,IAAA,iBAAQ,EAAC,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,2BAA2B,CAAC,CAAA;YAChG,IAAA,iBAAQ,EAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,8BAA8B,CAAC,CAAA;YAChE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,OAAO,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC,CAAA;YAEtF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAA;YACnD,IAAI,SAAS,EAAE;gBACb,MAAM,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;aACpC;YAED,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;YAExE,OAAO,WAAW,CAAA;QACpB,CAAC;KAAA;IAED,0GAA0G;IACjF,YAAY,CACnC,KAAQ,EACR,QAAoB,EACpB,WAAqB;;;;;YAErB,MAAM,OAAO,GAAG,+CAAwB,CAAC,UAAU,CAAe,KAAK,EAAE,QAAQ,CAAC,CAAA;YAClF,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAA;YAC7C,IAAA,iBAAQ,EAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAA;YACtD,MAAM,cAAc,GAAc,EAAE,CAAA;YACpC,kFAAkF;YAClF,MAAM,mBAAmB,GAAG,MAAM,oBAAa,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;YACpF,QAAQ,YAAY,CAAC,MAAM,EAAE;gBAC3B,KAAK,yCAAyB,CAAC,CAAC;oBAC9B,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;oBAC/D,cAAc,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAA;oBACvC,MAAK;iBACN;gBACD,OAAO,CAAC,CAAC;oBACP,OAAO,OAAM,YAAY,YAAC,KAAK,EAAE,QAAQ,EAAC;iBAC3C;aACF;YACD,OAAO,cAAc,CAAA;QACvB,CAAC;KAAA;;AA7EH,0CAiFC;AA1E0B,6BAAa,GAAa,CAAC,mCAAmB,CAAC,CAAA"}
package/dist/cjs/index.js DELETED
@@ -1,5 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./AbstractWitness"), exports);
5
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC"}