@xyo-network/module-model 2.42.16

package/dist/esm/Config.d.ts

@@ -0,0 +1,14 @@
+import { EmptyObject } from '@xyo-network/core';
+import { XyoPayload } from '@xyo-network/payload-model';
+export type AbstractModuleConfigSchema = 'network.xyo.module.config';
+export declare const AbstractModuleConfigSchema: AbstractModuleConfigSchema;
+export type AddressString = string;
+export type SchemaString = string;
+export type AbstractModuleConfigBase<T extends EmptyObject = EmptyObject> = XyoPayload<{
+    security?: {
+        allowed?: Record<SchemaString, AddressString[][]>;
+        disallowed?: Record<SchemaString, AddressString[]>;
+    };
+} & T>;
+export type AbstractModuleConfig<TConfig extends XyoPayload = XyoPayload> = AbstractModuleConfigBase<TConfig>;
+//# sourceMappingURL=Config.d.ts.map

package/dist/esm/Config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,MAAM,0BAA0B,GAAG,2BAA2B,CAAA;AACpE,eAAO,MAAM,0BAA0B,EAAE,0BAAwD,CAAA;AAEjG,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,UAAU,CACpF;IAEE,QAAQ,CAAC,EAAE;QAET,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,CAAC,CAAA;QAEjD,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KACnD,CAAA;CACF,GAAG,CAAC,CACN,CAAA;AAED,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,IAAI,wBAAwB,CAAC,OAAO,CAAC,CAAA"}

package/dist/esm/Config.js

@@ -0,0 +1,2 @@
+export const AbstractModuleConfigSchema = 'network.xyo.module.config';
+//# sourceMappingURL=Config.js.map

package/dist/esm/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,0BAA0B,GAA+B,2BAA2B,CAAA"}

package/dist/esm/ModuleDescription.d.ts

@@ -0,0 +1,6 @@
+export interface ModuleDescription {
+    address: string;
+    children?: ModuleDescription[];
+    queries: string[];
+}
+//# sourceMappingURL=ModuleDescription.d.ts.map

package/dist/esm/ModuleDescription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleDescription.d.ts","sourceRoot":"","sources":["../../src/ModuleDescription.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB"}

package/dist/esm/ModuleDescription.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleDescription.js.map

package/dist/esm/ModuleDescription.js.map

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

package/dist/esm/ModuleFilter.d.ts

@@ -0,0 +1,7 @@
+export interface ModuleFilter {
+    address?: string[];
+    config?: string[];
+    name?: string[];
+    query?: string[][];
+}
+//# sourceMappingURL=ModuleFilter.d.ts.map

package/dist/esm/ModuleFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleFilter.d.ts","sourceRoot":"","sources":["../../src/ModuleFilter.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,CAAA;CACnB"}

package/dist/esm/ModuleFilter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleFilter.js.map

package/dist/esm/ModuleFilter.js.map

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

package/dist/esm/ModuleQueryResult.d.ts

@@ -0,0 +1,4 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model';
+import { XyoPayload } from '@xyo-network/payload-model';
+export type ModuleQueryResult<T extends XyoPayload = XyoPayload> = [XyoBoundWitness, T[]];
+//# sourceMappingURL=ModuleQueryResult.d.ts.map

package/dist/esm/ModuleQueryResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleQueryResult.d.ts","sourceRoot":"","sources":["../../src/ModuleQueryResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,IAAI,CAAC,eAAe,EAAE,CAAC,EAAE,CAAC,CAAA"}

package/dist/esm/ModuleQueryResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleQueryResult.js.map

package/dist/esm/ModuleQueryResult.js.map

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

package/dist/esm/PartialConfig.d.ts

@@ -0,0 +1,5 @@
+import { AbstractModuleConfig } from './Config';
+export type PartialModuleConfig<T extends AbstractModuleConfig> = Omit<T, 'schema'> & {
+    schema?: T['schema'];
+};
+//# sourceMappingURL=PartialConfig.d.ts.map

package/dist/esm/PartialConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PartialConfig.d.ts","sourceRoot":"","sources":["../../src/PartialConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IACpF,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;CACrB,CAAA"}

package/dist/esm/PartialConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PartialConfig.js.map

package/dist/esm/PartialConfig.js.map

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

package/dist/esm/Queries/Discover.d.ts

@@ -0,0 +1,7 @@
+import { XyoQuery } from '../Query';
+export type AbstractModuleDiscoverQuerySchema = 'network.xyo.query.module.discover';
+export declare const AbstractModuleDiscoverQuerySchema: AbstractModuleDiscoverQuerySchema;
+export type AbstractModuleDiscoverQuery = XyoQuery<{
+    schema: AbstractModuleDiscoverQuerySchema;
+}>;
+//# sourceMappingURL=Discover.d.ts.map

package/dist/esm/Queries/Discover.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Discover.d.ts","sourceRoot":"","sources":["../../../src/Queries/Discover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEnC,MAAM,MAAM,iCAAiC,GAAG,mCAAmC,CAAA;AACnF,eAAO,MAAM,iCAAiC,EAAE,iCAAuE,CAAA;AAEvH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAAC;IACjD,MAAM,EAAE,iCAAiC,CAAA;CAC1C,CAAC,CAAA"}

package/dist/esm/Queries/Discover.js

@@ -0,0 +1,2 @@
+export const AbstractModuleDiscoverQuerySchema = 'network.xyo.query.module.discover';
+//# sourceMappingURL=Discover.js.map

package/dist/esm/Queries/Discover.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Discover.js","sourceRoot":"","sources":["../../../src/Queries/Discover.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,iCAAiC,GAAsC,mCAAmC,CAAA"}

package/dist/esm/Queries/Subscribe.d.ts

@@ -0,0 +1,17 @@
+import { XyoQuery } from '../Query';
+export type AbstractModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe';
+export declare const AbstractModuleSubscribeQuerySchema: AbstractModuleSubscribeQuerySchema;
+export interface AbstractModuleSubscribeFilter {
+    /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */
+    schema?: string[];
+}
+export type AbstractModuleSubscribeQuery = XyoQuery<{
+    /** @field The address that will receive notifications */
+    address: string;
+    /** @field A subscribe with a null for filter is an unsubscribe */
+    filter?: AbstractModuleSubscribeFilter | null;
+    /** @field The maximum events queued per send [may increase frequency] */
+    maxQueue?: number;
+    schema: AbstractModuleSubscribeQuerySchema;
+}>;
+//# sourceMappingURL=Subscribe.d.ts.map

package/dist/esm/Queries/Subscribe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Subscribe.d.ts","sourceRoot":"","sources":["../../../src/Queries/Subscribe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEnC,MAAM,MAAM,kCAAkC,GAAG,oCAAoC,CAAA;AACrF,eAAO,MAAM,kCAAkC,EAAE,kCAAyE,CAAA;AAE1H,MAAM,WAAW,6BAA6B;IAC5C,qHAAqH;IACrH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAGD,MAAM,MAAM,4BAA4B,GAAG,QAAQ,CAAC;IAClD,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAA;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,6BAA6B,GAAG,IAAI,CAAA;IAC7C,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,kCAAkC,CAAA;CAC3C,CAAC,CAAA"}

package/dist/esm/Queries/Subscribe.js

@@ -0,0 +1,2 @@
+export const AbstractModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe';
+//# sourceMappingURL=Subscribe.js.map

package/dist/esm/Queries/Subscribe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Subscribe.js","sourceRoot":"","sources":["../../../src/Queries/Subscribe.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,kCAAkC,GAAuC,oCAAoC,CAAA"}

package/dist/esm/Queries/index.d.ts

@@ -0,0 +1,8 @@
+import { XyoQuery } from '../Query';
+import { AbstractModuleDiscoverQuery } from './Discover';
+import { AbstractModuleSubscribeQuery } from './Subscribe';
+export * from './Discover';
+export * from './Subscribe';
+export type AbstractModuleQueryBase = AbstractModuleSubscribeQuery | AbstractModuleDiscoverQuery;
+export type AbstractModuleQuery<T extends XyoQuery | void = void> = T extends XyoQuery ? AbstractModuleQueryBase | T : AbstractModuleQueryBase;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/Queries/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnC,OAAO,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAA;AAE1D,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAE3B,MAAM,MAAM,uBAAuB,GAAG,4BAA4B,GAAG,2BAA2B,CAAA;AAEhG,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,QAAQ,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,QAAQ,GAAG,uBAAuB,GAAG,CAAC,GAAG,uBAAuB,CAAA"}

package/dist/esm/Queries/index.js

@@ -0,0 +1,3 @@
+export * from './Discover';
+export * from './Subscribe';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":"AAIA,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

package/dist/esm/Query/Payload.d.ts

@@ -0,0 +1,13 @@
+import { XyoPayload } from '@xyo-network/payload-model';
+export interface XyoQueryFields {
+    /** @field The addresses of the intended handlers */
+    address?: string | [string];
+    /** @field The maximum XYO that can be spent executing the query */
+    budget?: number;
+    /** @field The frequency on which this query can be rerun */
+    maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+    /** @field The starting point for the bidding on the query */
+    minBid?: number;
+}
+export type XyoQuery<T extends XyoPayload | void = void> = T extends XyoPayload ? XyoPayload<T & XyoQueryFields> : XyoPayload<XyoQueryFields>;
+//# sourceMappingURL=Payload.d.ts.map

package/dist/esm/Query/Payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Query/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,CAAC,CAAA;IAE3B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAExF,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,UAAU,GAAG,UAAU,CAAC,CAAC,GAAG,cAAc,CAAC,GAAG,UAAU,CAAC,cAAc,CAAC,CAAA"}

package/dist/esm/Query/Payload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Payload.js.map

package/dist/esm/Query/Payload.js.map

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

package/dist/esm/Query/XyoQueryBoundWitness.d.ts

@@ -0,0 +1,9 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model';
+export type XyoQueryBoundWitnessSchema = 'network.xyo.boundwitness.query';
+export declare const XyoQueryBoundWitnessSchema: XyoQueryBoundWitnessSchema;
+export type XyoQueryBoundWitness = XyoBoundWitness<{
+    query: string;
+    resultSet?: string;
+    schema: XyoQueryBoundWitnessSchema;
+}>;
+//# sourceMappingURL=XyoQueryBoundWitness.d.ts.map

package/dist/esm/Query/XyoQueryBoundWitness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoQueryBoundWitness.d.ts","sourceRoot":"","sources":["../../../src/Query/XyoQueryBoundWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEjE,MAAM,MAAM,0BAA0B,GAAG,gCAAgC,CAAA;AACzE,eAAO,MAAM,0BAA0B,EAAE,0BAA6D,CAAA;AAEtG,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAAC;IACjD,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,0BAA0B,CAAA;CACnC,CAAC,CAAA"}

package/dist/esm/Query/XyoQueryBoundWitness.js

@@ -0,0 +1,2 @@
+export const XyoQueryBoundWitnessSchema = 'network.xyo.boundwitness.query';
+//# sourceMappingURL=XyoQueryBoundWitness.js.map

package/dist/esm/Query/XyoQueryBoundWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoQueryBoundWitness.js","sourceRoot":"","sources":["../../../src/Query/XyoQueryBoundWitness.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,0BAA0B,GAA+B,gCAAgC,CAAA"}

package/dist/esm/Query/index.d.ts

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

package/dist/esm/Query/index.d.ts.map

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

package/dist/esm/Query/index.js

@@ -0,0 +1,3 @@
+export * from './Payload';
+export * from './XyoQueryBoundWitness';
+//# sourceMappingURL=index.js.map

package/dist/esm/Query/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Query/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,wBAAwB,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+export * from './Config';
+export * from './model';
+export * from './ModuleDescription';
+export * from './ModuleFilter';
+export * from './ModuleQueryResult';
+export * from './PartialConfig';
+export * from './Queries';
+export * from './Query';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,9 @@
+export * from './Config';
+export * from './model';
+export * from './ModuleDescription';
+export * from './ModuleFilter';
+export * from './ModuleQueryResult';
+export * from './PartialConfig';
+export * from './Queries';
+export * from './Query';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/dist/esm/model/Module.d.ts

@@ -0,0 +1,14 @@
+import { XyoPayload } from '@xyo-network/payload-model';
+import { Promisable } from '@xyo-network/promise';
+import { ModuleDescription } from '../ModuleDescription';
+import { ModuleQueryResult } from '../ModuleQueryResult';
+import { XyoQueryBoundWitness } from '../Query';
+export interface Module<TConfig extends XyoPayload = XyoPayload> {
+    address: string;
+    config: TConfig;
+    description: () => Promisable<ModuleDescription>;
+    queries: () => string[];
+    query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness>(query: T, payloads?: XyoPayload[]) => Promisable<ModuleQueryResult>;
+    queryable: (schema: string, addresses?: string[]) => boolean;
+}
+//# sourceMappingURL=Module.d.ts.map

package/dist/esm/model/Module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../../src/model/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU;IAC7D,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IACf,WAAW,EAAE,MAAM,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAChD,OAAO,EAAE,MAAM,MAAM,EAAE,CAAA;IACvB,KAAK,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,EAAE,KAAK,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClI,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAA;CAC7D"}

package/dist/esm/model/Module.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Module.js.map

package/dist/esm/model/Module.js.map

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

package/dist/esm/model/ModuleResolver.d.ts

@@ -0,0 +1,9 @@
+import { Promisable } from '@xyo-network/promise';
+import { ModuleFilter } from '../ModuleFilter';
+import { Module } from './Module';
+export interface ModuleResolver<TModule extends Module = Module> {
+    isModuleResolver: boolean;
+    resolve(filter?: ModuleFilter): Promisable<TModule[]>;
+    tryResolve(filter?: ModuleFilter): Promisable<TModule[]>;
+}
+//# sourceMappingURL=ModuleResolver.d.ts.map

package/dist/esm/model/ModuleResolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleResolver.d.ts","sourceRoot":"","sources":["../../../src/model/ModuleResolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM;IAC7D,gBAAgB,EAAE,OAAO,CAAA;IACzB,OAAO,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IACrD,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;CACzD"}

package/dist/esm/model/ModuleResolver.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleResolver.js.map

package/dist/esm/model/ModuleResolver.js.map

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

package/dist/esm/model/index.d.ts

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

package/dist/esm/model/index.d.ts.map

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

package/dist/esm/model/index.js

@@ -0,0 +1,3 @@
+export * from './Module';
+export * from './ModuleResolver';
+//# sourceMappingURL=index.js.map

package/dist/esm/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@xyo-network/module-model",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xyo-network/boundwitness-model": "^2.42.16",
+    "@xyo-network/core": "^2.42.16",
+    "@xyo-network/payload-model": "^2.42.15",
+    "@xyo-network/promise": "^2.42.16"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.10.25"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.42.16"
+}

package/src/Config.ts

@@ -0,0 +1,22 @@
+import { EmptyObject } from '@xyo-network/core'
+import { XyoPayload } from '@xyo-network/payload-model'
+
+export type AbstractModuleConfigSchema = 'network.xyo.module.config'
+export const AbstractModuleConfigSchema: AbstractModuleConfigSchema = 'network.xyo.module.config'
+
+export type AddressString = string
+export type SchemaString = string
+
+export type AbstractModuleConfigBase<T extends EmptyObject = EmptyObject> = XyoPayload<
+  {
+    //if both allowed and disallowed is specified, then disallowed takes priority
+    security?: {
+      //if schema in record, then only these address sets can access query
+      allowed?: Record<SchemaString, AddressString[][]>
+      //if schema in record, then anyone except these addresses can access query
+      disallowed?: Record<SchemaString, AddressString[]>
+    }
+  } & T
+>
+
+export type AbstractModuleConfig<TConfig extends XyoPayload = XyoPayload> = AbstractModuleConfigBase<TConfig>

package/src/ModuleDescription.ts

@@ -0,0 +1,5 @@
+export interface ModuleDescription {
+  address: string
+  children?: ModuleDescription[]
+  queries: string[]
+}

package/src/ModuleFilter.ts

@@ -0,0 +1,6 @@
+export interface ModuleFilter {
+  address?: string[]
+  config?: string[]
+  name?: string[]
+  query?: string[][]
+}

package/src/ModuleQueryResult.ts

@@ -0,0 +1,4 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model'
+import { XyoPayload } from '@xyo-network/payload-model'
+
+export type ModuleQueryResult<T extends XyoPayload = XyoPayload> = [XyoBoundWitness, T[]]

package/src/PartialConfig.ts

@@ -0,0 +1,5 @@
+import { AbstractModuleConfig } from './Config'
+
+export type PartialModuleConfig<T extends AbstractModuleConfig> = Omit<T, 'schema'> & {
+  schema?: T['schema']
+}

package/src/Queries/Discover.ts

@@ -0,0 +1,8 @@
+import { XyoQuery } from '../Query'
+
+export type AbstractModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'
+export const AbstractModuleDiscoverQuerySchema: AbstractModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'
+
+export type AbstractModuleDiscoverQuery = XyoQuery<{
+  schema: AbstractModuleDiscoverQuerySchema
+}>

package/src/Queries/Subscribe.ts

@@ -0,0 +1,20 @@
+import { XyoQuery } from '../Query'
+
+export type AbstractModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
+export const AbstractModuleSubscribeQuerySchema: AbstractModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
+
+export interface AbstractModuleSubscribeFilter {
+  /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */
+  schema?: string[]
+}
+
+//requests notification when a boundwitness is added to the modules chain that meets the filter criteria
+export type AbstractModuleSubscribeQuery = XyoQuery<{
+  /** @field The address that will receive notifications */
+  address: string
+  /** @field A subscribe with a null for filter is an unsubscribe */
+  filter?: AbstractModuleSubscribeFilter | null
+  /** @field The maximum events queued per send [may increase frequency] */
+  maxQueue?: number
+  schema: AbstractModuleSubscribeQuerySchema
+}>

package/src/Queries/index.ts

@@ -0,0 +1,10 @@
+import { XyoQuery } from '../Query'
+import { AbstractModuleDiscoverQuery } from './Discover'
+import { AbstractModuleSubscribeQuery } from './Subscribe'
+
+export * from './Discover'
+export * from './Subscribe'
+
+export type AbstractModuleQueryBase = AbstractModuleSubscribeQuery | AbstractModuleDiscoverQuery
+
+export type AbstractModuleQuery<T extends XyoQuery | void = void> = T extends XyoQuery ? AbstractModuleQueryBase | T : AbstractModuleQueryBase

package/src/Query/Payload.ts

@@ -0,0 +1,17 @@
+import { XyoPayload } from '@xyo-network/payload-model'
+
+export interface XyoQueryFields {
+  /** @field The addresses of the intended handlers */
+  address?: string | [string]
+
+  /** @field The maximum XYO that can be spent executing the query */
+  budget?: number
+
+  /** @field The frequency on which this query can be rerun */
+  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
+
+  /** @field The starting point for the bidding on the query */
+  minBid?: number
+}
+
+export type XyoQuery<T extends XyoPayload | void = void> = T extends XyoPayload ? XyoPayload<T & XyoQueryFields> : XyoPayload<XyoQueryFields>

package/src/Query/XyoQueryBoundWitness.ts

@@ -0,0 +1,10 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model'
+
+export type XyoQueryBoundWitnessSchema = 'network.xyo.boundwitness.query'
+export const XyoQueryBoundWitnessSchema: XyoQueryBoundWitnessSchema = 'network.xyo.boundwitness.query'
+
+export type XyoQueryBoundWitness = XyoBoundWitness<{
+  query: string
+  resultSet?: string
+  schema: XyoQueryBoundWitnessSchema
+}>

package/src/Query/index.ts

@@ -0,0 +1,2 @@
+export * from './Payload'
+export * from './XyoQueryBoundWitness'

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from './Config'
+export * from './model'
+export * from './ModuleDescription'
+export * from './ModuleFilter'
+export * from './ModuleQueryResult'
+export * from './PartialConfig'
+export * from './Queries'
+export * from './Query'

package/src/model/Module.ts

@@ -0,0 +1,15 @@
+import { XyoPayload } from '@xyo-network/payload-model'
+import { Promisable } from '@xyo-network/promise'
+
+import { ModuleDescription } from '../ModuleDescription'
+import { ModuleQueryResult } from '../ModuleQueryResult'
+import { XyoQueryBoundWitness } from '../Query'
+
+export interface Module<TConfig extends XyoPayload = XyoPayload> {
+  address: string
+  config: TConfig
+  description: () => Promisable<ModuleDescription>
+  queries: () => string[]
+  query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness>(query: T, payloads?: XyoPayload[]) => Promisable<ModuleQueryResult>
+  queryable: (schema: string, addresses?: string[]) => boolean
+}

package/src/model/ModuleResolver.ts

@@ -0,0 +1,10 @@
+import { Promisable } from '@xyo-network/promise'
+
+import { ModuleFilter } from '../ModuleFilter'
+import { Module } from './Module'
+
+export interface ModuleResolver<TModule extends Module = Module> {
+  isModuleResolver: boolean
+  resolve(filter?: ModuleFilter): Promisable<TModule[]>
+  tryResolve(filter?: ModuleFilter): Promisable<TModule[]>
+}

package/src/model/index.ts

@@ -0,0 +1,2 @@
+export * from './Module'
+export * from './ModuleResolver'