@xyo-network/abstract-witness 2.74.5 → 2.75.1

package/dist/node/AbstractWitness.d.cts

@@ -0,0 +1,24 @@
+import { ArchivistInstance } from '@xyo-network/archivist-model';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable } from '@xyo-network/promise';
+import { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
+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> {
+    static readonly configSchemas: string[];
+    private _archivistInstance;
+    get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
+    get queries(): string[];
+    get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }) | undefined;
+    protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
+    getArchivistInstance(): Promise<ArchivistInstance | undefined>;
+    /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+    observe(inPayloads?: Payload[]): Promise<Payload[]>;
+    /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    /** @function observeHandler Implement or override to add custom functionality to a witness */
+    protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
+}
+//# sourceMappingURL=AbstractWitness.d.ts.map

package/dist/node/AbstractWitness.d.cts.map

@@ -0,0 +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"}

package/dist/node/AbstractWitness.d.mts

@@ -0,0 +1,24 @@
+import { ArchivistInstance } from '@xyo-network/archivist-model';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable } from '@xyo-network/promise';
+import { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
+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> {
+    static readonly configSchemas: string[];
+    private _archivistInstance;
+    get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
+    get queries(): string[];
+    get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }) | undefined;
+    protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
+    getArchivistInstance(): Promise<ArchivistInstance | undefined>;
+    /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+    observe(inPayloads?: Payload[]): Promise<Payload[]>;
+    /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    /** @function observeHandler Implement or override to add custom functionality to a witness */
+    protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
+}
+//# sourceMappingURL=AbstractWitness.d.ts.map

package/dist/node/AbstractWitness.d.mts.map

@@ -0,0 +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"}

package/dist/node/AbstractWitness.d.ts

@@ -0,0 +1,24 @@
+import { ArchivistInstance } from '@xyo-network/archivist-model';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable } from '@xyo-network/promise';
+import { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
+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> {
+    static readonly configSchemas: string[];
+    private _archivistInstance;
+    get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
+    get queries(): string[];
+    get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }) | undefined;
+    protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
+    getArchivistInstance(): Promise<ArchivistInstance | undefined>;
+    /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+    observe(inPayloads?: Payload[]): Promise<Payload[]>;
+    /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
+    /** @function observeHandler Implement or override to add custom functionality to a witness */
+    protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
+}
+//# sourceMappingURL=AbstractWitness.d.ts.map

package/dist/node/AbstractWitness.d.ts.map

@@ -0,0 +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"}

package/dist/node/AbstractWitness.js

@@ -0,0 +1,114 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/AbstractWitness.ts
+var AbstractWitness_exports = {};
+__export(AbstractWitness_exports, {
+  AbstractWitness: () => AbstractWitness
+});
+module.exports = __toCommonJS(AbstractWitness_exports);
+var import_assert = require("@xylabs/assert");
+var import_boundwitness_builder = require("@xyo-network/boundwitness-builder");
+var import_core = require("@xyo-network/core");
+var import_module = require("@xyo-network/module");
+var import_witness_model = require("@xyo-network/witness-model");
+(0, import_module.creatableModule)();
+var _AbstractWitness = class _AbstractWitness extends import_module.AbstractModuleInstance {
+  _archivistInstance;
+  get archivist() {
+    return this.config.archivist;
+  }
+  get queries() {
+    return [
+      import_witness_model.WitnessObserveQuerySchema,
+      ...super.queries
+    ];
+  }
+  get targetSet() {
+    var _a;
+    return (_a = this.config) == null ? void 0 : _a.targetSet;
+  }
+  get _queryAccountPaths() {
+    return {
+      "network.xyo.query.witness.observe": "1/1"
+    };
+  }
+  async getArchivistInstance() {
+    const archivistAddress = this.archivist;
+    this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
+    return this._archivistInstance;
+  }
+  /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+  async observe(inPayloads) {
+    this._noOverride("observe");
+    await this.started("throw");
+    await this.emit("observeStart", {
+      inPayloads,
+      module: this
+    });
+    const outPayloads = (0, import_assert.assertEx)(await this.observeHandler(inPayloads), "Trying to witness nothing");
+    (0, import_assert.assertEx)(outPayloads.length > 0, "Trying to witness empty list");
+    outPayloads == null ? void 0 : outPayloads.forEach((payload) => (0, import_assert.assertEx)(payload.schema, "observe: Missing Schema"));
+    const archivist = await this.getArchivistInstance();
+    if (archivist) {
+      await archivist.insert(outPayloads);
+    }
+    await this.emit("observeEnd", {
+      inPayloads,
+      module: this,
+      outPayloads
+    });
+    return outPayloads;
+  }
+  /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+  async queryHandler(query, payloads, queryConfig) {
+    const wrapper = import_boundwitness_builder.QueryBoundWitnessWrapper.parseQuery(query, payloads);
+    const queryPayload = await wrapper.getQuery();
+    (0, import_assert.assertEx)(this.queryable(query, payloads, queryConfig));
+    const resultPayloads = [];
+    const filteredObservation = await import_core.PayloadHasher.filterExclude(payloads, query.query);
+    switch (queryPayload.schema) {
+      case import_witness_model.WitnessObserveQuerySchema: {
+        const observePayloads = await this.observe(filteredObservation);
+        resultPayloads.push(...observePayloads);
+        break;
+      }
+      default: {
+        return super.queryHandler(query, payloads);
+      }
+    }
+    return resultPayloads;
+  }
+};
+__name(_AbstractWitness, "AbstractWitness");
+__publicField(_AbstractWitness, "configSchemas", [
+  import_witness_model.WitnessConfigSchema
+]);
+var AbstractWitness = _AbstractWitness;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AbstractWitness
+});
+//# sourceMappingURL=AbstractWitness.js.map

package/dist/node/AbstractWitness.js.map

@@ -0,0 +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;;;;;oBAAyB;AAEzB,kCAA4D;AAC5D,kBAA8B;AAC9B,oBAAgG;AAGhG,2BASO;IAEPA,+BAAAA;AACO,IAAeC,mBAAf,MAAeA,yBAIZC,qCAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;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,+CAAaI,QAAQ,CAACC,gBAAYJ,wBAASI,QAAQC,QAAQ,yBAAA;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;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["creatableModule","AbstractWitness","AbstractModuleInstance","_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","configSchemas","WitnessConfigSchema"]}

package/dist/node/AbstractWitness.mjs

@@ -0,0 +1,91 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/AbstractWitness.ts
+import { assertEx } from "@xylabs/assert";
+import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-builder";
+import { PayloadHasher } from "@xyo-network/core";
+import { AbstractModuleInstance, creatableModule } from "@xyo-network/module";
+import { WitnessConfigSchema, WitnessObserveQuerySchema } from "@xyo-network/witness-model";
+creatableModule();
+var _AbstractWitness = class _AbstractWitness extends AbstractModuleInstance {
+  _archivistInstance;
+  get archivist() {
+    return this.config.archivist;
+  }
+  get queries() {
+    return [
+      WitnessObserveQuerySchema,
+      ...super.queries
+    ];
+  }
+  get targetSet() {
+    var _a;
+    return (_a = this.config) == null ? void 0 : _a.targetSet;
+  }
+  get _queryAccountPaths() {
+    return {
+      "network.xyo.query.witness.observe": "1/1"
+    };
+  }
+  async getArchivistInstance() {
+    const archivistAddress = this.archivist;
+    this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
+    return this._archivistInstance;
+  }
+  /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+  async observe(inPayloads) {
+    this._noOverride("observe");
+    await this.started("throw");
+    await this.emit("observeStart", {
+      inPayloads,
+      module: this
+    });
+    const outPayloads = assertEx(await this.observeHandler(inPayloads), "Trying to witness nothing");
+    assertEx(outPayloads.length > 0, "Trying to witness empty list");
+    outPayloads == null ? void 0 : outPayloads.forEach((payload) => assertEx(payload.schema, "observe: Missing Schema"));
+    const archivist = await this.getArchivistInstance();
+    if (archivist) {
+      await archivist.insert(outPayloads);
+    }
+    await this.emit("observeEnd", {
+      inPayloads,
+      module: this,
+      outPayloads
+    });
+    return outPayloads;
+  }
+  /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+  async queryHandler(query, payloads, queryConfig) {
+    const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
+    const queryPayload = await wrapper.getQuery();
+    assertEx(this.queryable(query, payloads, queryConfig));
+    const resultPayloads = [];
+    const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query);
+    switch (queryPayload.schema) {
+      case WitnessObserveQuerySchema: {
+        const observePayloads = await this.observe(filteredObservation);
+        resultPayloads.push(...observePayloads);
+        break;
+      }
+      default: {
+        return super.queryHandler(query, payloads);
+      }
+    }
+    return resultPayloads;
+  }
+};
+__name(_AbstractWitness, "AbstractWitness");
+__publicField(_AbstractWitness, "configSchemas", [
+  WitnessConfigSchema
+]);
+var AbstractWitness = _AbstractWitness;
+export {
+  AbstractWitness
+};
+//# sourceMappingURL=AbstractWitness.mjs.map

package/dist/node/AbstractWitness.mjs.map

@@ -0,0 +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,mBAAf,MAAeA,yBAIZC,uBAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;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,+CAAaI,QAAQ,CAACC,YAAYJ,SAASI,QAAQC,QAAQ,yBAAA;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;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","creatableModule","AbstractWitness","AbstractModuleInstance","_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","configSchemas","WitnessConfigSchema"]}

package/dist/node/index.d.cts

@@ -0,0 +1,2 @@
+export * from './AbstractWitness';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/dist/node/index.d.mts

@@ -0,0 +1,2 @@
+export * from './AbstractWitness';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/dist/node/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AbstractWitness';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/dist/node/index.js

@@ -0,0 +1,116 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  AbstractWitness: () => AbstractWitness
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/AbstractWitness.ts
+var import_assert = require("@xylabs/assert");
+var import_boundwitness_builder = require("@xyo-network/boundwitness-builder");
+var import_core = require("@xyo-network/core");
+var import_module = require("@xyo-network/module");
+var import_witness_model = require("@xyo-network/witness-model");
+(0, import_module.creatableModule)();
+var _AbstractWitness = class _AbstractWitness extends import_module.AbstractModuleInstance {
+  _archivistInstance;
+  get archivist() {
+    return this.config.archivist;
+  }
+  get queries() {
+    return [
+      import_witness_model.WitnessObserveQuerySchema,
+      ...super.queries
+    ];
+  }
+  get targetSet() {
+    var _a;
+    return (_a = this.config) == null ? void 0 : _a.targetSet;
+  }
+  get _queryAccountPaths() {
+    return {
+      "network.xyo.query.witness.observe": "1/1"
+    };
+  }
+  async getArchivistInstance() {
+    const archivistAddress = this.archivist;
+    this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
+    return this._archivistInstance;
+  }
+  /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+  async observe(inPayloads) {
+    this._noOverride("observe");
+    await this.started("throw");
+    await this.emit("observeStart", {
+      inPayloads,
+      module: this
+    });
+    const outPayloads = (0, import_assert.assertEx)(await this.observeHandler(inPayloads), "Trying to witness nothing");
+    (0, import_assert.assertEx)(outPayloads.length > 0, "Trying to witness empty list");
+    outPayloads == null ? void 0 : outPayloads.forEach((payload) => (0, import_assert.assertEx)(payload.schema, "observe: Missing Schema"));
+    const archivist = await this.getArchivistInstance();
+    if (archivist) {
+      await archivist.insert(outPayloads);
+    }
+    await this.emit("observeEnd", {
+      inPayloads,
+      module: this,
+      outPayloads
+    });
+    return outPayloads;
+  }
+  /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+  async queryHandler(query, payloads, queryConfig) {
+    const wrapper = import_boundwitness_builder.QueryBoundWitnessWrapper.parseQuery(query, payloads);
+    const queryPayload = await wrapper.getQuery();
+    (0, import_assert.assertEx)(this.queryable(query, payloads, queryConfig));
+    const resultPayloads = [];
+    const filteredObservation = await import_core.PayloadHasher.filterExclude(payloads, query.query);
+    switch (queryPayload.schema) {
+      case import_witness_model.WitnessObserveQuerySchema: {
+        const observePayloads = await this.observe(filteredObservation);
+        resultPayloads.push(...observePayloads);
+        break;
+      }
+      default: {
+        return super.queryHandler(query, payloads);
+      }
+    }
+    return resultPayloads;
+  }
+};
+__name(_AbstractWitness, "AbstractWitness");
+__publicField(_AbstractWitness, "configSchemas", [
+  import_witness_model.WitnessConfigSchema
+]);
+var AbstractWitness = _AbstractWitness;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AbstractWitness
+});
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +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,mBAAf,MAAeA,yBAIZC,qCAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;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,+CAAaI,QAAQ,CAACC,gBAAYJ,wBAASI,QAAQC,QAAQ,yBAAA;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;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["creatableModule","AbstractWitness","AbstractModuleInstance","_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","configSchemas","WitnessConfigSchema"]}

package/dist/node/index.mjs

@@ -0,0 +1,91 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/AbstractWitness.ts
+import { assertEx } from "@xylabs/assert";
+import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-builder";
+import { PayloadHasher } from "@xyo-network/core";
+import { AbstractModuleInstance, creatableModule } from "@xyo-network/module";
+import { WitnessConfigSchema, WitnessObserveQuerySchema } from "@xyo-network/witness-model";
+creatableModule();
+var _AbstractWitness = class _AbstractWitness extends AbstractModuleInstance {
+  _archivistInstance;
+  get archivist() {
+    return this.config.archivist;
+  }
+  get queries() {
+    return [
+      WitnessObserveQuerySchema,
+      ...super.queries
+    ];
+  }
+  get targetSet() {
+    var _a;
+    return (_a = this.config) == null ? void 0 : _a.targetSet;
+  }
+  get _queryAccountPaths() {
+    return {
+      "network.xyo.query.witness.observe": "1/1"
+    };
+  }
+  async getArchivistInstance() {
+    const archivistAddress = this.archivist;
+    this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
+    return this._archivistInstance;
+  }
+  /** @function observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality */
+  async observe(inPayloads) {
+    this._noOverride("observe");
+    await this.started("throw");
+    await this.emit("observeStart", {
+      inPayloads,
+      module: this
+    });
+    const outPayloads = assertEx(await this.observeHandler(inPayloads), "Trying to witness nothing");
+    assertEx(outPayloads.length > 0, "Trying to witness empty list");
+    outPayloads == null ? void 0 : outPayloads.forEach((payload) => assertEx(payload.schema, "observe: Missing Schema"));
+    const archivist = await this.getArchivistInstance();
+    if (archivist) {
+      await archivist.insert(outPayloads);
+    }
+    await this.emit("observeEnd", {
+      inPayloads,
+      module: this,
+      outPayloads
+    });
+    return outPayloads;
+  }
+  /** @function queryHandler Calls observe for an observe query.  Override to support additional queries. */
+  async queryHandler(query, payloads, queryConfig) {
+    const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
+    const queryPayload = await wrapper.getQuery();
+    assertEx(this.queryable(query, payloads, queryConfig));
+    const resultPayloads = [];
+    const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query);
+    switch (queryPayload.schema) {
+      case WitnessObserveQuerySchema: {
+        const observePayloads = await this.observe(filteredObservation);
+        resultPayloads.push(...observePayloads);
+        break;
+      }
+      default: {
+        return super.queryHandler(query, payloads);
+      }
+    }
+    return resultPayloads;
+  }
+};
+__name(_AbstractWitness, "AbstractWitness");
+__publicField(_AbstractWitness, "configSchemas", [
+  WitnessConfigSchema
+]);
+var AbstractWitness = _AbstractWitness;
+export {
+  AbstractWitness
+};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +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,mBAAf,MAAeA,yBAIZC,uBAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;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,+CAAaI,QAAQ,CAACC,YAAYJ,SAASI,QAAQC,QAAQ,yBAAA;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;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","creatableModule","AbstractWitness","AbstractModuleInstance","_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","configSchemas","WitnessConfigSchema"]}