@xyo-network/module-model 2.74.4 → 2.75.0

package/dist/browser/module/isModule.js

@@ -0,0 +1,50 @@
+// src/Queries/Discover.ts
+var ModuleDiscoverQuerySchema = "network.xyo.query.module.discover";
+
+// src/module/asModuleObject.ts
+import { AsObjectFactory } from "@xyo-network/object";
+
+// src/module/isModuleObject.ts
+import { IsObjectFactory } from "@xyo-network/object";
+var requiredModuleFunctions = {
+  address: "string",
+  config: "object",
+  params: "object",
+  queries: "array",
+  query: "function",
+  queryable: "function"
+};
+var factory = new IsObjectFactory();
+var isModuleObject = factory.create(requiredModuleFunctions);
+
+// src/module/asModuleObject.ts
+var asModuleObject = AsObjectFactory.create(isModuleObject);
+
+// src/module/IsModuleFactory.ts
+var IsModuleFactory = class {
+  create(expectedQueries, additionalChecks) {
+    return (obj, config) => {
+      const module = asModuleObject(obj);
+      const result = isModuleObject(module, config) && (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) && //perform additional checks
+      (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true);
+      return result;
+    };
+  }
+};
+
+// src/module/isModule.ts
+var requiredModuleQueries = [
+  /* We need to update this once live module conform */
+  //ModuleDescribeQuerySchema,
+  //ModuleAddressQuerySchema,
+  ModuleDiscoverQuerySchema
+  //ModuleManifestQuerySchema,
+  //ModuleSubscribeQuerySchema,
+];
+var factory2 = new IsModuleFactory();
+var isModule = factory2.create(requiredModuleQueries, [isModuleObject]);
+export {
+  isModule,
+  requiredModuleQueries
+};
+//# sourceMappingURL=isModule.js.map

package/dist/browser/module/isModule.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/Queries/Discover.ts","../../../src/module/asModuleObject.ts","../../../src/module/isModuleObject.ts","../../../src/module/IsModuleFactory.ts","../../../src/module/isModule.ts"],"sourcesContent":["import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'\nexport const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'\n\nexport type ModuleDiscoverQuery = Query<{\n  schema: ModuleDiscoverQuerySchema\n}>\n","import { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModuleObject } from './isModuleObject'\n\nexport const asModuleObject = AsObjectFactory.create(isModuleObject)\n","import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { Module } from './Module'\n\nexport const requiredModuleFunctions: ObjectTypeShape = {\n  address: 'string',\n  config: 'object',\n  params: 'object',\n  queries: 'array',\n  query: 'function',\n  queryable: 'function',\n}\n\nconst factory = new IsObjectFactory<Module>()\n\nexport const isModuleObject: ObjectTypeCheck<Module> = factory.create(requiredModuleFunctions)\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { asModuleObject } from './asModuleObject'\nimport { isModuleObject } from './isModuleObject'\nimport { Module } from './Module'\n\nexport type ModuleTypeCheck<T extends Module = Module> = ObjectTypeCheck<T>\n\nexport class IsModuleFactory<T extends Module = Module> {\n  create(expectedQueries?: string[], additionalChecks?: ObjectTypeCheck[]): ModuleTypeCheck<T> {\n    return (obj: any, config): obj is T => {\n      const module = asModuleObject(obj)\n      const result =\n        isModuleObject(module, config) &&\n        (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) &&\n        //perform additional checks\n        (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true)\n      return result\n    }\n  }\n}\n","import { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { ModuleDiscoverQuerySchema } from '../Queries'\nimport { IsModuleFactory } from './IsModuleFactory'\nimport { isModuleObject } from './isModuleObject'\nimport { Module } from './Module'\n\nexport const requiredModuleQueries: string[] = [\n  /* We need to update this once live module conform */\n  //ModuleDescribeQuerySchema,\n  //ModuleAddressQuerySchema,\n  ModuleDiscoverQuerySchema,\n  //ModuleManifestQuerySchema,\n  //ModuleSubscribeQuerySchema,\n]\n\n//we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsModuleFactory<Module>()\n\nexport const isModule: ObjectTypeCheck<Module> = factory.create(requiredModuleQueries, [isModuleObject])\n"],"mappings":";AAGO,IAAM,4BAAuD;;;ACHpE,SAAS,uBAAuB;;;ACAhC,SAAS,uBAAyD;AAI3D,IAAM,0BAA2C;AAAA,EACtD,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AACb;AAEA,IAAM,UAAU,IAAI,gBAAwB;AAErC,IAAM,iBAA0C,QAAQ,OAAO,uBAAuB;;;ADXtF,IAAM,iBAAiB,gBAAgB,OAAO,cAAc;;;AEK5D,IAAM,kBAAN,MAAiD;AAAA,EACtD,OAAO,iBAA4B,kBAA0D;AAC3F,WAAO,CAAC,KAAU,WAAqB;AACrC,YAAM,SAAS,eAAe,GAAG;AACjC,YAAM,SACJ,eAAe,QAAQ,MAAM,MAC5B,iBAAiB,OAAO,CAAC,MAAM,UAAU,QAAQ,IAAI,QAAQ,SAAS,KAAK,GAAG,IAAI,KAAK;AAAA,OAEvF,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,MAAM,GAAG,IAAI,KAAK;AAClF,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACdO,IAAM,wBAAkC;AAAA;AAAA;AAAA;AAAA,EAI7C;AAAA;AAAA;AAGF;AAGA,IAAMA,WAAU,IAAI,gBAAwB;AAErC,IAAM,WAAoCA,SAAQ,OAAO,uBAAuB,CAAC,cAAc,CAAC;","names":["factory"]}

package/dist/browser/module/isModuleObject.cjs

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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);
+
+// src/module/isModuleObject.ts
+var isModuleObject_exports = {};
+__export(isModuleObject_exports, {
+  isModuleObject: () => isModuleObject,
+  requiredModuleFunctions: () => requiredModuleFunctions
+});
+module.exports = __toCommonJS(isModuleObject_exports);
+var import_object = require("@xyo-network/object");
+var requiredModuleFunctions = {
+  address: "string",
+  config: "object",
+  params: "object",
+  queries: "array",
+  query: "function",
+  queryable: "function"
+};
+var factory = new import_object.IsObjectFactory();
+var isModuleObject = factory.create(requiredModuleFunctions);
+//# sourceMappingURL=isModuleObject.cjs.map

package/dist/browser/module/isModuleObject.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/module/isModuleObject.ts"],"sourcesContent":["import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { Module } from './Module'\n\nexport const requiredModuleFunctions: ObjectTypeShape = {\n  address: 'string',\n  config: 'object',\n  params: 'object',\n  queries: 'array',\n  query: 'function',\n  queryable: 'function',\n}\n\nconst factory = new IsObjectFactory<Module>()\n\nexport const isModuleObject: ObjectTypeCheck<Module> = factory.create(requiredModuleFunctions)\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAkE;AAI3D,IAAM,0BAA2C;AAAA,EACtD,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AACb;AAEA,IAAM,UAAU,IAAI,8BAAwB;AAErC,IAAM,iBAA0C,QAAQ,OAAO,uBAAuB;","names":[]}

package/dist/browser/module/isModuleObject.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isModuleObject.d.ts","sourceRoot":"","sources":["../../../src/module/isModuleObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,eAAe,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,eAAO,MAAM,uBAAuB,EAAE,eAOrC,CAAA;AAID,eAAO,MAAM,cAAc,EAAE,eAAe,CAAC,MAAM,CAA2C,CAAA"}

package/dist/browser/module/isModuleObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isModuleObject.d.ts","sourceRoot":"","sources":["../../../src/module/isModuleObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,eAAe,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,eAAO,MAAM,uBAAuB,EAAE,eAOrC,CAAA;AAID,eAAO,MAAM,cAAc,EAAE,eAAe,CAAC,MAAM,CAA2C,CAAA"}

package/dist/browser/module/isModuleObject.js

@@ -0,0 +1,17 @@
+// src/module/isModuleObject.ts
+import { IsObjectFactory } from "@xyo-network/object";
+var requiredModuleFunctions = {
+  address: "string",
+  config: "object",
+  params: "object",
+  queries: "array",
+  query: "function",
+  queryable: "function"
+};
+var factory = new IsObjectFactory();
+var isModuleObject = factory.create(requiredModuleFunctions);
+export {
+  isModuleObject,
+  requiredModuleFunctions
+};
+//# sourceMappingURL=isModuleObject.js.map

package/dist/browser/module/isModuleObject.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/module/isModuleObject.ts"],"sourcesContent":["import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { Module } from './Module'\n\nexport const requiredModuleFunctions: ObjectTypeShape = {\n  address: 'string',\n  config: 'object',\n  params: 'object',\n  queries: 'array',\n  query: 'function',\n  queryable: 'function',\n}\n\nconst factory = new IsObjectFactory<Module>()\n\nexport const isModuleObject: ObjectTypeCheck<Module> = factory.create(requiredModuleFunctions)\n"],"mappings":";AAAA,SAAS,uBAAyD;AAI3D,IAAM,0BAA2C;AAAA,EACtD,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AACb;AAEA,IAAM,UAAU,IAAI,gBAAwB;AAErC,IAAM,iBAA0C,QAAQ,OAAO,uBAAuB;","names":[]}

package/dist/browser/withModule.cjs

@@ -0,0 +1,98 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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);
+
+// src/withModule.ts
+var withModule_exports = {};
+__export(withModule_exports, {
+  WithFactory: () => WithFactory,
+  withModule: () => withModule,
+  withModuleInstance: () => withModuleInstance
+});
+module.exports = __toCommonJS(withModule_exports);
+
+// src/instance/isModuleInstance.ts
+var import_object3 = require("@xyo-network/object");
+
+// src/Queries/Discover.ts
+var ModuleDiscoverQuerySchema = "network.xyo.query.module.discover";
+
+// src/module/asModuleObject.ts
+var import_object2 = require("@xyo-network/object");
+
+// src/module/isModuleObject.ts
+var import_object = require("@xyo-network/object");
+var requiredModuleFunctions = {
+  address: "string",
+  config: "object",
+  params: "object",
+  queries: "array",
+  query: "function",
+  queryable: "function"
+};
+var factory = new import_object.IsObjectFactory();
+var isModuleObject = factory.create(requiredModuleFunctions);
+
+// src/module/asModuleObject.ts
+var asModuleObject = import_object2.AsObjectFactory.create(isModuleObject);
+
+// src/module/IsModuleFactory.ts
+var IsModuleFactory = class {
+  create(expectedQueries, additionalChecks) {
+    return (obj, config) => {
+      const module2 = asModuleObject(obj);
+      const result = isModuleObject(module2, config) && (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) && //perform additional checks
+      (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true);
+      return result;
+    };
+  }
+};
+
+// src/module/isModule.ts
+var requiredModuleQueries = [
+  /* We need to update this once live module conform */
+  //ModuleDescribeQuerySchema,
+  //ModuleAddressQuerySchema,
+  ModuleDiscoverQuerySchema
+  //ModuleManifestQuerySchema,
+  //ModuleSubscribeQuerySchema,
+];
+var factory2 = new IsModuleFactory();
+var isModule = factory2.create(requiredModuleQueries, [isModuleObject]);
+
+// src/instance/isModuleInstance.ts
+var requiredModuleInstanceFunctions = {
+  describe: "function",
+  discover: "function",
+  manifest: "function",
+  moduleAddress: "function"
+};
+var factory3 = new import_object3.IsObjectFactory();
+var isModuleInstance = factory3.create(requiredModuleInstanceFunctions, [isModule]);
+
+// src/withModule.ts
+var WithFactory = {
+  create: (typeCheck) => {
+    return (module2, closure) => {
+      return typeCheck(module2) ? closure(module2) : void 0;
+    };
+  }
+};
+var withModule = WithFactory.create(isModule);
+var withModuleInstance = WithFactory.create(isModuleInstance);
+//# sourceMappingURL=withModule.cjs.map

package/dist/browser/withModule.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/withModule.ts","../../src/instance/isModuleInstance.ts","../../src/Queries/Discover.ts","../../src/module/asModuleObject.ts","../../src/module/isModuleObject.ts","../../src/module/IsModuleFactory.ts","../../src/module/isModule.ts"],"sourcesContent":["import { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { isModuleInstance } from './instance'\nimport { isModule } from './module'\n\nexport const WithFactory = {\n  create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => {\n    return <R>(\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      module: any,\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      closure: (module: T) => R,\n    ): R | undefined => {\n      return typeCheck(module) ? closure(module) : undefined\n    }\n  },\n}\n\nexport const withModule = WithFactory.create(isModule)\nexport const withModuleInstance = WithFactory.create(isModuleInstance)\n","import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { isModule } from '../module'\nimport { ModuleInstance } from './ModuleInstance'\n\nexport const requiredModuleInstanceFunctions: ObjectTypeShape = {\n  describe: 'function',\n  discover: 'function',\n  manifest: 'function',\n  moduleAddress: 'function',\n}\n\n//we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsObjectFactory<ModuleInstance>()\n\nexport const isModuleInstance: ObjectTypeCheck<ModuleInstance> = factory.create(requiredModuleInstanceFunctions, [isModule])\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'\nexport const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'\n\nexport type ModuleDiscoverQuery = Query<{\n  schema: ModuleDiscoverQuerySchema\n}>\n","import { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModuleObject } from './isModuleObject'\n\nexport const asModuleObject = AsObjectFactory.create(isModuleObject)\n","import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { Module } from './Module'\n\nexport const requiredModuleFunctions: ObjectTypeShape = {\n  address: 'string',\n  config: 'object',\n  params: 'object',\n  queries: 'array',\n  query: 'function',\n  queryable: 'function',\n}\n\nconst factory = new IsObjectFactory<Module>()\n\nexport const isModuleObject: ObjectTypeCheck<Module> = factory.create(requiredModuleFunctions)\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { asModuleObject } from './asModuleObject'\nimport { isModuleObject } from './isModuleObject'\nimport { Module } from './Module'\n\nexport type ModuleTypeCheck<T extends Module = Module> = ObjectTypeCheck<T>\n\nexport class IsModuleFactory<T extends Module = Module> {\n  create(expectedQueries?: string[], additionalChecks?: ObjectTypeCheck[]): ModuleTypeCheck<T> {\n    return (obj: any, config): obj is T => {\n      const module = asModuleObject(obj)\n      const result =\n        isModuleObject(module, config) &&\n        (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) &&\n        //perform additional checks\n        (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true)\n      return result\n    }\n  }\n}\n","import { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { ModuleDiscoverQuerySchema } from '../Queries'\nimport { IsModuleFactory } from './IsModuleFactory'\nimport { isModuleObject } from './isModuleObject'\nimport { Module } from './Module'\n\nexport const requiredModuleQueries: string[] = [\n  /* We need to update this once live module conform */\n  //ModuleDescribeQuerySchema,\n  //ModuleAddressQuerySchema,\n  ModuleDiscoverQuerySchema,\n  //ModuleManifestQuerySchema,\n  //ModuleSubscribeQuerySchema,\n]\n\n//we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsModuleFactory<Module>()\n\nexport const isModule: ObjectTypeCheck<Module> = factory.create(requiredModuleQueries, [isModuleObject])\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,iBAAkE;;;ACG3D,IAAM,4BAAuD;;;ACHpE,IAAAC,iBAAgC;;;ACAhC,oBAAkE;AAI3D,IAAM,0BAA2C;AAAA,EACtD,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AACb;AAEA,IAAM,UAAU,IAAI,8BAAwB;AAErC,IAAM,iBAA0C,QAAQ,OAAO,uBAAuB;;;ADXtF,IAAM,iBAAiB,+BAAgB,OAAO,cAAc;;;AEK5D,IAAM,kBAAN,MAAiD;AAAA,EACtD,OAAO,iBAA4B,kBAA0D;AAC3F,WAAO,CAAC,KAAU,WAAqB;AACrC,YAAMC,UAAS,eAAe,GAAG;AACjC,YAAM,SACJ,eAAeA,SAAQ,MAAM,MAC5B,iBAAiB,OAAO,CAAC,MAAM,UAAU,QAAQ,IAAI,QAAQ,SAAS,KAAK,GAAG,IAAI,KAAK;AAAA,OAEvF,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,MAAM,GAAG,IAAI,KAAK;AAClF,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACdO,IAAM,wBAAkC;AAAA;AAAA;AAAA;AAAA,EAI7C;AAAA;AAAA;AAGF;AAGA,IAAMC,WAAU,IAAI,gBAAwB;AAErC,IAAM,WAAoCA,SAAQ,OAAO,uBAAuB,CAAC,cAAc,CAAC;;;ALdhG,IAAM,kCAAmD;AAAA,EAC9D,UAAU;AAAA,EACV,UAAU;AAAA,EACV,UAAU;AAAA,EACV,eAAe;AACjB;AAGA,IAAMC,WAAU,IAAI,+BAAgC;AAE7C,IAAM,mBAAoDA,SAAQ,OAAO,iCAAiC,CAAC,QAAQ,CAAC;;;ADVpH,IAAM,cAAc;AAAA,EACzB,QAAQ,CAAmB,cAAkC;AAC3D,WAAO,CAELC,SAEA,YACkB;AAClB,aAAO,UAAUA,OAAM,IAAI,QAAQA,OAAM,IAAI;AAAA,IAC/C;AAAA,EACF;AACF;AAEO,IAAM,aAAa,YAAY,OAAO,QAAQ;AAC9C,IAAM,qBAAqB,YAAY,OAAO,gBAAgB;","names":["import_object","import_object","module","factory","factory","module"]}

package/dist/browser/withModule.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAKrD,eAAO,MAAM,WAAW;6EAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}

package/dist/browser/withModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAKrD,eAAO,MAAM,WAAW;6EAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,+EAUqD,CAAA"}

package/dist/browser/withModule.js

@@ -0,0 +1,75 @@
+// src/instance/isModuleInstance.ts
+import { IsObjectFactory as IsObjectFactory2 } from "@xyo-network/object";
+
+// src/Queries/Discover.ts
+var ModuleDiscoverQuerySchema = "network.xyo.query.module.discover";
+
+// src/module/asModuleObject.ts
+import { AsObjectFactory } from "@xyo-network/object";
+
+// src/module/isModuleObject.ts
+import { IsObjectFactory } from "@xyo-network/object";
+var requiredModuleFunctions = {
+  address: "string",
+  config: "object",
+  params: "object",
+  queries: "array",
+  query: "function",
+  queryable: "function"
+};
+var factory = new IsObjectFactory();
+var isModuleObject = factory.create(requiredModuleFunctions);
+
+// src/module/asModuleObject.ts
+var asModuleObject = AsObjectFactory.create(isModuleObject);
+
+// src/module/IsModuleFactory.ts
+var IsModuleFactory = class {
+  create(expectedQueries, additionalChecks) {
+    return (obj, config) => {
+      const module = asModuleObject(obj);
+      const result = isModuleObject(module, config) && (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) && //perform additional checks
+      (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true);
+      return result;
+    };
+  }
+};
+
+// src/module/isModule.ts
+var requiredModuleQueries = [
+  /* We need to update this once live module conform */
+  //ModuleDescribeQuerySchema,
+  //ModuleAddressQuerySchema,
+  ModuleDiscoverQuerySchema
+  //ModuleManifestQuerySchema,
+  //ModuleSubscribeQuerySchema,
+];
+var factory2 = new IsModuleFactory();
+var isModule = factory2.create(requiredModuleQueries, [isModuleObject]);
+
+// src/instance/isModuleInstance.ts
+var requiredModuleInstanceFunctions = {
+  describe: "function",
+  discover: "function",
+  manifest: "function",
+  moduleAddress: "function"
+};
+var factory3 = new IsObjectFactory2();
+var isModuleInstance = factory3.create(requiredModuleInstanceFunctions, [isModule]);
+
+// src/withModule.ts
+var WithFactory = {
+  create: (typeCheck) => {
+    return (module, closure) => {
+      return typeCheck(module) ? closure(module) : void 0;
+    };
+  }
+};
+var withModule = WithFactory.create(isModule);
+var withModuleInstance = WithFactory.create(isModuleInstance);
+export {
+  WithFactory,
+  withModule,
+  withModuleInstance
+};
+//# sourceMappingURL=withModule.js.map

package/dist/browser/withModule.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/instance/isModuleInstance.ts","../../src/Queries/Discover.ts","../../src/module/asModuleObject.ts","../../src/module/isModuleObject.ts","../../src/module/IsModuleFactory.ts","../../src/module/isModule.ts","../../src/withModule.ts"],"sourcesContent":["import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { isModule } from '../module'\nimport { ModuleInstance } from './ModuleInstance'\n\nexport const requiredModuleInstanceFunctions: ObjectTypeShape = {\n  describe: 'function',\n  discover: 'function',\n  manifest: 'function',\n  moduleAddress: 'function',\n}\n\n//we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsObjectFactory<ModuleInstance>()\n\nexport const isModuleInstance: ObjectTypeCheck<ModuleInstance> = factory.create(requiredModuleInstanceFunctions, [isModule])\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'\nexport const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'\n\nexport type ModuleDiscoverQuery = Query<{\n  schema: ModuleDiscoverQuerySchema\n}>\n","import { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModuleObject } from './isModuleObject'\n\nexport const asModuleObject = AsObjectFactory.create(isModuleObject)\n","import { IsObjectFactory, ObjectTypeCheck, ObjectTypeShape } from '@xyo-network/object'\n\nimport { Module } from './Module'\n\nexport const requiredModuleFunctions: ObjectTypeShape = {\n  address: 'string',\n  config: 'object',\n  params: 'object',\n  queries: 'array',\n  query: 'function',\n  queryable: 'function',\n}\n\nconst factory = new IsObjectFactory<Module>()\n\nexport const isModuleObject: ObjectTypeCheck<Module> = factory.create(requiredModuleFunctions)\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { asModuleObject } from './asModuleObject'\nimport { isModuleObject } from './isModuleObject'\nimport { Module } from './Module'\n\nexport type ModuleTypeCheck<T extends Module = Module> = ObjectTypeCheck<T>\n\nexport class IsModuleFactory<T extends Module = Module> {\n  create(expectedQueries?: string[], additionalChecks?: ObjectTypeCheck[]): ModuleTypeCheck<T> {\n    return (obj: any, config): obj is T => {\n      const module = asModuleObject(obj)\n      const result =\n        isModuleObject(module, config) &&\n        (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) &&\n        //perform additional checks\n        (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true)\n      return result\n    }\n  }\n}\n","import { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { ModuleDiscoverQuerySchema } from '../Queries'\nimport { IsModuleFactory } from './IsModuleFactory'\nimport { isModuleObject } from './isModuleObject'\nimport { Module } from './Module'\n\nexport const requiredModuleQueries: string[] = [\n  /* We need to update this once live module conform */\n  //ModuleDescribeQuerySchema,\n  //ModuleAddressQuerySchema,\n  ModuleDiscoverQuerySchema,\n  //ModuleManifestQuerySchema,\n  //ModuleSubscribeQuerySchema,\n]\n\n//we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsModuleFactory<Module>()\n\nexport const isModule: ObjectTypeCheck<Module> = factory.create(requiredModuleQueries, [isModuleObject])\n","import { ObjectTypeCheck } from '@xyo-network/object'\n\nimport { isModuleInstance } from './instance'\nimport { isModule } from './module'\n\nexport const WithFactory = {\n  create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => {\n    return <R>(\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      module: any,\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      closure: (module: T) => R,\n    ): R | undefined => {\n      return typeCheck(module) ? closure(module) : undefined\n    }\n  },\n}\n\nexport const withModule = WithFactory.create(isModule)\nexport const withModuleInstance = WithFactory.create(isModuleInstance)\n"],"mappings":";AAAA,SAAS,mBAAAA,wBAAyD;;;ACG3D,IAAM,4BAAuD;;;ACHpE,SAAS,uBAAuB;;;ACAhC,SAAS,uBAAyD;AAI3D,IAAM,0BAA2C;AAAA,EACtD,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW;AACb;AAEA,IAAM,UAAU,IAAI,gBAAwB;AAErC,IAAM,iBAA0C,QAAQ,OAAO,uBAAuB;;;ADXtF,IAAM,iBAAiB,gBAAgB,OAAO,cAAc;;;AEK5D,IAAM,kBAAN,MAAiD;AAAA,EACtD,OAAO,iBAA4B,kBAA0D;AAC3F,WAAO,CAAC,KAAU,WAAqB;AACrC,YAAM,SAAS,eAAe,GAAG;AACjC,YAAM,SACJ,eAAe,QAAQ,MAAM,MAC5B,iBAAiB,OAAO,CAAC,MAAM,UAAU,QAAQ,IAAI,QAAQ,SAAS,KAAK,GAAG,IAAI,KAAK;AAAA,OAEvF,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,MAAM,GAAG,IAAI,KAAK;AAClF,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACdO,IAAM,wBAAkC;AAAA;AAAA;AAAA;AAAA,EAI7C;AAAA;AAAA;AAGF;AAGA,IAAMC,WAAU,IAAI,gBAAwB;AAErC,IAAM,WAAoCA,SAAQ,OAAO,uBAAuB,CAAC,cAAc,CAAC;;;ALdhG,IAAM,kCAAmD;AAAA,EAC9D,UAAU;AAAA,EACV,UAAU;AAAA,EACV,UAAU;AAAA,EACV,eAAe;AACjB;AAGA,IAAMC,WAAU,IAAIC,iBAAgC;AAE7C,IAAM,mBAAoDD,SAAQ,OAAO,iCAAiC,CAAC,QAAQ,CAAC;;;AMVpH,IAAM,cAAc;AAAA,EACzB,QAAQ,CAAmB,cAAkC;AAC3D,WAAO,CAEL,QAEA,YACkB;AAClB,aAAO,UAAU,MAAM,IAAI,QAAQ,MAAM,IAAI;AAAA,IAC/C;AAAA,EACF;AACF;AAEO,IAAM,aAAa,YAAY,OAAO,QAAQ;AAC9C,IAAM,qBAAqB,YAAY,OAAO,gBAAgB;","names":["IsObjectFactory","factory","factory","IsObjectFactory"]}

package/dist/node/Config.d.mts

@@ -0,0 +1,60 @@
+import { AnyObject, WithAdditional } from '@xyo-network/core';
+import { Payload, Schema } from '@xyo-network/payload-model';
+import { Labels } from './Labels';
+export type ModuleConfigSchema = 'network.xyo.module.config';
+export declare const ModuleConfigSchema: ModuleConfigSchema;
+export type AddressString = string;
+export type CosigningAddressSet = string[];
+export type SchemaString = string;
+export type NameOrAddress = string;
+export interface IndividualArchivistConfig {
+    readonly commit?: NameOrAddress;
+    readonly read?: NameOrAddress;
+    readonly write?: NameOrAddress;
+}
+export type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig;
+export type ModuleConfig<TConfig extends Payload | void = void, TAdditionalParams extends AnyObject | void = void, TSchema extends Schema | void = void> = Payload<WithAdditional<WithAdditional<{
+    /** @field The path to use when creating the account */
+    accountDerivationPath?: string;
+    /** @field The name/address of the Archivist to use for this module */
+    readonly archivist?: ArchivistModuleConfig;
+    /**
+     * @field The labels used for this module. If a label is specified, then the
+     * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
+     * labels to construct this module.
+     */
+    readonly labels?: Labels;
+    /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
+    readonly name?: string;
+    /** @field paging settings for queries */
+    readonly paging?: Record<string, {
+        size?: number;
+    }>;
+    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
+    readonly security?: {
+        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
+        readonly allowAnonymous?: boolean;
+        /** @field If schema in record, then only these address sets can access query */
+        readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
+        /** @field If schema in record, then anyone except these addresses can access query */
+        readonly disallowed?: Record<SchemaString, AddressString[]>;
+    };
+    /** @field sign every query */
+    readonly sign?: boolean;
+    /** @field Store the queries made to the module in an archivist if possible */
+    readonly storeQueries?: boolean;
+    /** @field add a timestamp payload to every query  */
+    readonly timestamp?: boolean;
+}, TConfig>, TAdditionalParams>, TSchema extends Schema ? TSchema : TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema>;
+export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+} = Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+}> = ModuleConfig<WithAdditional<Omit<TConfig, 'schema'>, {
+    schema: string;
+}>>;
+export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
+    schema?: TConfig['schema'];
+};
+export type AnyModuleConfig = AnyConfigSchema<ModuleConfig>;
+//# sourceMappingURL=Config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;CAC/B;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,yBAAyB,CAAA;AAE7E,MAAM,MAAM,YAAY,CACtB,OAAO,SAAS,OAAO,GAAG,IAAI,GAAG,IAAI,EACrC,iBAAiB,SAAS,SAAS,GAAG,IAAI,GAAG,IAAI,EACjD,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClC,OAAO,CACT,cAAc,CACZ,cAAc,CACZ;IACE,uDAAuD;IACvD,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAA;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB,gIAAgI;IAChI,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB,yCAAyC;IACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAEnD,iMAAiM;IACjM,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAClB,6FAA6F;QAC7F,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;QAEjC,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAEhF,sFAAsF;QACtF,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KAC5D,CAAA;IAED,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IAEvB,8EAA8E;IAC9E,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAE/B,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAC7B,EACD,OAAO,CACR,EACD,iBAAiB,CAClB,EACD,OAAO,SAAS,MAAM,GAAG,OAAO,GAAG,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CACpG,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAC/I,YAAY,CACV,cAAc,CACZ,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EACvB;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CACF,CACF,CAAA;AAEH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA"}

package/dist/node/Config.d.ts

@@ -0,0 +1,60 @@
+import { AnyObject, WithAdditional } from '@xyo-network/core';
+import { Payload, Schema } from '@xyo-network/payload-model';
+import { Labels } from './Labels';
+export type ModuleConfigSchema = 'network.xyo.module.config';
+export declare const ModuleConfigSchema: ModuleConfigSchema;
+export type AddressString = string;
+export type CosigningAddressSet = string[];
+export type SchemaString = string;
+export type NameOrAddress = string;
+export interface IndividualArchivistConfig {
+    readonly commit?: NameOrAddress;
+    readonly read?: NameOrAddress;
+    readonly write?: NameOrAddress;
+}
+export type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig;
+export type ModuleConfig<TConfig extends Payload | void = void, TAdditionalParams extends AnyObject | void = void, TSchema extends Schema | void = void> = Payload<WithAdditional<WithAdditional<{
+    /** @field The path to use when creating the account */
+    accountDerivationPath?: string;
+    /** @field The name/address of the Archivist to use for this module */
+    readonly archivist?: ArchivistModuleConfig;
+    /**
+     * @field The labels used for this module. If a label is specified, then the
+     * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
+     * labels to construct this module.
+     */
+    readonly labels?: Labels;
+    /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
+    readonly name?: string;
+    /** @field paging settings for queries */
+    readonly paging?: Record<string, {
+        size?: number;
+    }>;
+    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
+    readonly security?: {
+        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
+        readonly allowAnonymous?: boolean;
+        /** @field If schema in record, then only these address sets can access query */
+        readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
+        /** @field If schema in record, then anyone except these addresses can access query */
+        readonly disallowed?: Record<SchemaString, AddressString[]>;
+    };
+    /** @field sign every query */
+    readonly sign?: boolean;
+    /** @field Store the queries made to the module in an archivist if possible */
+    readonly storeQueries?: boolean;
+    /** @field add a timestamp payload to every query  */
+    readonly timestamp?: boolean;
+}, TConfig>, TAdditionalParams>, TSchema extends Schema ? TSchema : TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema>;
+export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+} = Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+}> = ModuleConfig<WithAdditional<Omit<TConfig, 'schema'>, {
+    schema: string;
+}>>;
+export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
+    schema?: TConfig['schema'];
+};
+export type AnyModuleConfig = AnyConfigSchema<ModuleConfig>;
+//# sourceMappingURL=Config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;CAC/B;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,yBAAyB,CAAA;AAE7E,MAAM,MAAM,YAAY,CACtB,OAAO,SAAS,OAAO,GAAG,IAAI,GAAG,IAAI,EACrC,iBAAiB,SAAS,SAAS,GAAG,IAAI,GAAG,IAAI,EACjD,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClC,OAAO,CACT,cAAc,CACZ,cAAc,CACZ;IACE,uDAAuD;IACvD,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAA;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB,gIAAgI;IAChI,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB,yCAAyC;IACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAEnD,iMAAiM;IACjM,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAClB,6FAA6F;QAC7F,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;QAEjC,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAEhF,sFAAsF;QACtF,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KAC5D,CAAA;IAED,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IAEvB,8EAA8E;IAC9E,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAE/B,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAC7B,EACD,OAAO,CACR,EACD,iBAAiB,CAClB,EACD,OAAO,SAAS,MAAM,GAAG,OAAO,GAAG,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CACpG,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAC/I,YAAY,CACV,cAAc,CACZ,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EACvB;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CACF,CACF,CAAA;AAEH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA"}

package/dist/node/Config.js

@@ -0,0 +1,29 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 Config_exports = {};
+__export(Config_exports, {
+  ModuleConfigSchema: () => ModuleConfigSchema
+});
+module.exports = __toCommonJS(Config_exports);
+const ModuleConfigSchema = "network.xyo.module.config";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ModuleConfigSchema
+});
+//# sourceMappingURL=Config.js.map

package/dist/node/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Config.ts"],"sourcesContent":["import { AnyObject, WithAdditional } from '@xyo-network/core'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { Labels } from './Labels'\n\nexport type ModuleConfigSchema = 'network.xyo.module.config'\nexport const ModuleConfigSchema: ModuleConfigSchema = 'network.xyo.module.config'\n\nexport type AddressString = string\nexport type CosigningAddressSet = string[]\nexport type SchemaString = string\n\nexport type NameOrAddress = string\n\nexport interface IndividualArchivistConfig {\n  readonly commit?: NameOrAddress\n  readonly read?: NameOrAddress\n  readonly write?: NameOrAddress\n}\n\nexport type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig\n\nexport type ModuleConfig<\n  TConfig extends Payload | void = void,\n  TAdditionalParams extends AnyObject | void = void,\n  TSchema extends Schema | void = void,\n> = Payload<\n  WithAdditional<\n    WithAdditional<\n      {\n        /** @field The path to use when creating the account */\n        accountDerivationPath?: string\n\n        /** @field The name/address of the Archivist to use for this module */\n        readonly archivist?: ArchivistModuleConfig\n\n        /**\n         * @field The labels used for this module. If a label is specified, then the\n         * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding\n         * labels to construct this module.\n         */\n        readonly labels?: Labels\n\n        /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */\n        readonly name?: string\n\n        /** @field paging settings for queries */\n        readonly paging?: Record<string, { size?: number }>\n\n        /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */\n        readonly security?: {\n          /** @field Will the module process queries that have unsigned BoundWitness in query tuples */\n          readonly allowAnonymous?: boolean\n\n          /** @field If schema in record, then only these address sets can access query */\n          readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>\n\n          /** @field If schema in record, then anyone except these addresses can access query */\n          readonly disallowed?: Record<SchemaString, AddressString[]>\n        }\n\n        /** @field sign every query */\n        readonly sign?: boolean\n\n        /** @field Store the queries made to the module in an archivist if possible */\n        readonly storeQueries?: boolean\n\n        /** @field add a timestamp payload to every query  */\n        readonly timestamp?: boolean\n      },\n      TConfig\n    >,\n    TAdditionalParams\n  >,\n  TSchema extends Schema ? TSchema : TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema\n>\n\nexport type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string } = Omit<ModuleConfig, 'schema'> & { schema: string }> =\n  ModuleConfig<\n    WithAdditional<\n      Omit<TConfig, 'schema'>,\n      {\n        schema: string\n      }\n    >\n  >\n\nexport type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {\n  schema?: TConfig['schema']\n}\n\nexport type AnyModuleConfig = AnyConfigSchema<ModuleConfig>\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,MAAM,qBAAyC;","names":[]}

package/dist/node/Config.mjs

@@ -0,0 +1,5 @@
+const ModuleConfigSchema = "network.xyo.module.config";
+export {
+  ModuleConfigSchema
+};
+//# sourceMappingURL=Config.mjs.map

package/dist/node/Config.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Config.ts"],"sourcesContent":["import { AnyObject, WithAdditional } from '@xyo-network/core'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { Labels } from './Labels'\n\nexport type ModuleConfigSchema = 'network.xyo.module.config'\nexport const ModuleConfigSchema: ModuleConfigSchema = 'network.xyo.module.config'\n\nexport type AddressString = string\nexport type CosigningAddressSet = string[]\nexport type SchemaString = string\n\nexport type NameOrAddress = string\n\nexport interface IndividualArchivistConfig {\n  readonly commit?: NameOrAddress\n  readonly read?: NameOrAddress\n  readonly write?: NameOrAddress\n}\n\nexport type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig\n\nexport type ModuleConfig<\n  TConfig extends Payload | void = void,\n  TAdditionalParams extends AnyObject | void = void,\n  TSchema extends Schema | void = void,\n> = Payload<\n  WithAdditional<\n    WithAdditional<\n      {\n        /** @field The path to use when creating the account */\n        accountDerivationPath?: string\n\n        /** @field The name/address of the Archivist to use for this module */\n        readonly archivist?: ArchivistModuleConfig\n\n        /**\n         * @field The labels used for this module. If a label is specified, then the\n         * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding\n         * labels to construct this module.\n         */\n        readonly labels?: Labels\n\n        /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */\n        readonly name?: string\n\n        /** @field paging settings for queries */\n        readonly paging?: Record<string, { size?: number }>\n\n        /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */\n        readonly security?: {\n          /** @field Will the module process queries that have unsigned BoundWitness in query tuples */\n          readonly allowAnonymous?: boolean\n\n          /** @field If schema in record, then only these address sets can access query */\n          readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>\n\n          /** @field If schema in record, then anyone except these addresses can access query */\n          readonly disallowed?: Record<SchemaString, AddressString[]>\n        }\n\n        /** @field sign every query */\n        readonly sign?: boolean\n\n        /** @field Store the queries made to the module in an archivist if possible */\n        readonly storeQueries?: boolean\n\n        /** @field add a timestamp payload to every query  */\n        readonly timestamp?: boolean\n      },\n      TConfig\n    >,\n    TAdditionalParams\n  >,\n  TSchema extends Schema ? TSchema : TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema\n>\n\nexport type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string } = Omit<ModuleConfig, 'schema'> & { schema: string }> =\n  ModuleConfig<\n    WithAdditional<\n      Omit<TConfig, 'schema'>,\n      {\n        schema: string\n      }\n    >\n  >\n\nexport type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {\n  schema?: TConfig['schema']\n}\n\nexport type AnyModuleConfig = AnyConfigSchema<ModuleConfig>\n"],"mappings":"AAMO,MAAM,qBAAyC;","names":[]}

package/dist/node/CreatableModule/CreatableModule.d.mts

@@ -0,0 +1,23 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { Logger } from '@xyo-network/logger';
+import { ModuleInstance } from '../instance';
+export type CreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {
+    create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>;
+};
+export interface CreatableModule<T extends ModuleInstance = ModuleInstance> {
+    configSchema: string;
+    configSchemas: string[];
+    defaultLogger?: Logger;
+    new (privateConstructorKey: string, params: T['params'], account: AccountInstance): T;
+    _noOverride(functionName: string): void;
+    create<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): Promise<T>;
+    factory<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>;
+}
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+export declare function creatableModule<TModule extends ModuleInstance = ModuleInstance>(): <U extends CreatableModule<TModule>>(constructor: U) => void;
+//# sourceMappingURL=CreatableModule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CreatableModule.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/CreatableModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,GAAG;IAChI,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CACpG,CAAA;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACxE,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,eAAe,GAAG,CAAC,CAAA;IACrF,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAC5F,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAA;CAC7G;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,SAAS,cAAc,GAAG,cAAc,kEAI9E"}

package/dist/node/CreatableModule/CreatableModule.d.ts

@@ -0,0 +1,23 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { Logger } from '@xyo-network/logger';
+import { ModuleInstance } from '../instance';
+export type CreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {
+    create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>;
+};
+export interface CreatableModule<T extends ModuleInstance = ModuleInstance> {
+    configSchema: string;
+    configSchemas: string[];
+    defaultLogger?: Logger;
+    new (privateConstructorKey: string, params: T['params'], account: AccountInstance): T;
+    _noOverride(functionName: string): void;
+    create<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): Promise<T>;
+    factory<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>;
+}
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+export declare function creatableModule<TModule extends ModuleInstance = ModuleInstance>(): <U extends CreatableModule<TModule>>(constructor: U) => void;
+//# sourceMappingURL=CreatableModule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CreatableModule.d.ts","sourceRoot":"","sources":["../../../src/CreatableModule/CreatableModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,GAAG;IAChI,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CACpG,CAAA;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACxE,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,qBAAqB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,eAAe,GAAG,CAAC,CAAA;IACrF,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAC5F,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAA;CAC7G;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,SAAS,cAAc,GAAG,cAAc,kEAI9E"}