@xyo-network/module-model 2.75.2 → 2.75.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/dist/browser/Config.js +2 -1
  2. package/dist/browser/Config.js.map +1 -1
  3. package/dist/browser/CreatableModule/CreatableModule.js +1 -0
  4. package/dist/browser/CreatableModule/CreatableModule.js.map +1 -1
  5. package/dist/browser/CreatableModule/CreatableModuleRegistry.js +3 -2
  6. package/dist/browser/CreatableModule/CreatableModuleRegistry.js.map +1 -1
  7. package/dist/browser/CreatableModule/LabeledCreatableModuleFactory.js +2 -1
  8. package/dist/browser/CreatableModule/LabeledCreatableModuleFactory.js.map +1 -1
  9. package/dist/browser/CreatableModule/ModuleFactory.js +4 -3
  10. package/dist/browser/CreatableModule/ModuleFactory.js.map +1 -1
  11. package/dist/browser/CreatableModule/ModuleFactoryLocator.js +19 -4
  12. package/dist/browser/CreatableModule/ModuleFactoryLocator.js.map +1 -1
  13. package/dist/browser/CreatableModule/index.js +169 -6
  14. package/dist/browser/CreatableModule/index.js.map +1 -1
  15. package/dist/browser/EventsModels/index.js +0 -5
  16. package/dist/browser/EventsModels/index.js.map +1 -1
  17. package/dist/browser/Labels/Labels.js +2 -1
  18. package/dist/browser/Labels/Labels.js.map +1 -1
  19. package/dist/browser/Labels/index.js +11 -1
  20. package/dist/browser/Labels/index.js.map +1 -1
  21. package/dist/browser/Queries/Describe/Payload.js +2 -1
  22. package/dist/browser/Queries/Describe/Payload.js.map +1 -1
  23. package/dist/browser/Queries/Describe/Query.js +2 -1
  24. package/dist/browser/Queries/Describe/Query.js.map +1 -1
  25. package/dist/browser/Queries/Describe/index.js +9 -2
  26. package/dist/browser/Queries/Describe/index.js.map +1 -1
  27. package/dist/browser/Queries/Discover.js +2 -1
  28. package/dist/browser/Queries/Discover.js.map +1 -1
  29. package/dist/browser/Queries/Manifest.js +2 -1
  30. package/dist/browser/Queries/Manifest.js.map +1 -1
  31. package/dist/browser/Queries/ModuleAddress/Payload.js +2 -1
  32. package/dist/browser/Queries/ModuleAddress/Payload.js.map +1 -1
  33. package/dist/browser/Queries/ModuleAddress/Query.js +2 -1
  34. package/dist/browser/Queries/ModuleAddress/Query.js.map +1 -1
  35. package/dist/browser/Queries/ModuleAddress/index.js +10 -2
  36. package/dist/browser/Queries/ModuleAddress/index.js.map +1 -1
  37. package/dist/browser/Queries/Subscribe.js +2 -1
  38. package/dist/browser/Queries/Subscribe.js.map +1 -1
  39. package/dist/browser/Queries/index.js +30 -5
  40. package/dist/browser/Queries/index.js.map +1 -1
  41. package/dist/browser/index.js +332 -13
  42. package/dist/browser/index.js.map +1 -1
  43. package/dist/browser/instance/ModuleInstance.js +3 -2
  44. package/dist/browser/instance/ModuleInstance.js.map +1 -1
  45. package/dist/browser/instance/asModuleInstance.js +63 -2
  46. package/dist/browser/instance/asModuleInstance.js.map +1 -1
  47. package/dist/browser/instance/index.js +75 -4
  48. package/dist/browser/instance/index.js.map +1 -1
  49. package/dist/browser/instance/isModuleInstance.js +52 -4
  50. package/dist/browser/instance/isModuleInstance.js.map +1 -1
  51. package/dist/browser/lib/duplicateModules.js +2 -1
  52. package/dist/browser/lib/duplicateModules.js.map +1 -1
  53. package/dist/browser/lib/index.js +32 -2
  54. package/dist/browser/lib/index.js.map +1 -1
  55. package/dist/browser/lib/serializable.js +5 -4
  56. package/dist/browser/lib/serializable.js.map +1 -1
  57. package/dist/browser/module/IsModuleFactory.js +22 -4
  58. package/dist/browser/module/IsModuleFactory.js.map +1 -1
  59. package/dist/browser/module/asModule.js +50 -2
  60. package/dist/browser/module/asModule.js.map +1 -1
  61. package/dist/browser/module/asModuleObject.js +17 -2
  62. package/dist/browser/module/asModuleObject.js.map +1 -1
  63. package/dist/browser/module/index.js +60 -8
  64. package/dist/browser/module/index.js.map +1 -1
  65. package/dist/browser/module/isModule.js +38 -6
  66. package/dist/browser/module/isModule.js.map +1 -1
  67. package/dist/browser/module/isModuleObject.js +4 -3
  68. package/dist/browser/module/isModuleObject.js.map +1 -1
  69. package/dist/browser/withModule.js +63 -5
  70. package/dist/browser/withModule.js.map +1 -1
  71. package/dist/docs.json +1160 -1160
  72. package/package.json +17 -17
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/Queries/Subscribe.ts"],"sourcesContent":["import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\nexport const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\n\nexport interface ModuleSubscribeFilter {\n /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */\n schema?: string[]\n}\n\n//requests notification when a boundwitness is added to the modules chain that meets the filter criteria\nexport type ModuleSubscribeQuery = Query<{\n /** @field The address that will receive notifications */\n address: string\n /** @field A subscribe with a null for filter is an unsubscribe */\n filter?: ModuleSubscribeFilter | null\n /** @field The maximum events queued per send [may increase frequency] */\n maxQueue?: number\n schema: ModuleSubscribeQuerySchema\n}>\n"],"mappings":"AAGO,MAAM,6BAAyD;","names":[]}
1
+ {"version":3,"sources":["../../../src/Queries/Subscribe.ts"],"sourcesContent":["import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\nexport const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\n\nexport interface ModuleSubscribeFilter {\n /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */\n schema?: string[]\n}\n\n//requests notification when a boundwitness is added to the modules chain that meets the filter criteria\nexport type ModuleSubscribeQuery = Query<{\n /** @field The address that will receive notifications */\n address: string\n /** @field A subscribe with a null for filter is an unsubscribe */\n filter?: ModuleSubscribeFilter | null\n /** @field The maximum events queued per send [may increase frequency] */\n maxQueue?: number\n schema: ModuleSubscribeQuerySchema\n}>\n"],"mappings":";AAGO,IAAM,6BAAyD;","names":[]}
@@ -1,6 +1,31 @@
1
- export * from "./Describe";
2
- export * from "./Discover";
3
- export * from "./Manifest";
4
- export * from "./ModuleAddress";
5
- export * from "./Subscribe";
1
+ // src/Queries/Describe/Payload.ts
2
+ var ModuleDescriptionSchema = "network.xyo.module.description";
3
+
4
+ // src/Queries/Describe/Query.ts
5
+ var ModuleDescribeQuerySchema = "network.xyo.query.module.describe";
6
+
7
+ // src/Queries/Discover.ts
8
+ var ModuleDiscoverQuerySchema = "network.xyo.query.module.discover";
9
+
10
+ // src/Queries/Manifest.ts
11
+ var ModuleManifestQuerySchema = "network.xyo.query.module.manifest";
12
+
13
+ // src/Queries/ModuleAddress/Payload.ts
14
+ import { AddressSchema } from "@xyo-network/address-payload-plugin";
15
+ var AddressPreviousHashSchema = `${AddressSchema}.hash.previous`;
16
+
17
+ // src/Queries/ModuleAddress/Query.ts
18
+ var ModuleAddressQuerySchema = "network.xyo.query.module.address";
19
+
20
+ // src/Queries/Subscribe.ts
21
+ var ModuleSubscribeQuerySchema = "network.xyo.query.module.subscribe";
22
+ export {
23
+ AddressPreviousHashSchema,
24
+ ModuleAddressQuerySchema,
25
+ ModuleDescribeQuerySchema,
26
+ ModuleDescriptionSchema,
27
+ ModuleDiscoverQuerySchema,
28
+ ModuleManifestQuerySchema,
29
+ ModuleSubscribeQuerySchema
30
+ };
6
31
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/Queries/index.ts"],"sourcesContent":["import { Query } from '@xyo-network/payload-model'\n\nimport { ModuleDescribeQuery } from './Describe'\nimport { ModuleDiscoverQuery } from './Discover'\nimport { ModuleManifestQuery } from './Manifest'\nimport { ModuleAddressQuery } from './ModuleAddress'\nimport { ModuleSubscribeQuery } from './Subscribe'\n\nexport * from './Describe'\nexport * from './Discover'\nexport * from './Manifest'\nexport * from './ModuleAddress'\nexport * from './Subscribe'\n\nexport type ModuleQueryBase = ModuleDiscoverQuery | ModuleAddressQuery | ModuleSubscribeQuery | ModuleDescribeQuery | ModuleManifestQuery\n\nexport type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase\n"],"mappings":"AAQA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
1
+ {"version":3,"sources":["../../../src/Queries/Describe/Payload.ts","../../../src/Queries/Describe/Query.ts","../../../src/Queries/Discover.ts","../../../src/Queries/Manifest.ts","../../../src/Queries/ModuleAddress/Payload.ts","../../../src/Queries/ModuleAddress/Query.ts","../../../src/Queries/Subscribe.ts"],"sourcesContent":["import { Payload } from '@xyo-network/payload-model'\n\nimport { ModuleDescription } from '../../ModuleDescription'\n\nexport const ModuleDescriptionSchema = 'network.xyo.module.description'\nexport type ModuleDescriptionSchema = typeof ModuleDescriptionSchema\n\nexport type ModuleDescriptionPayload = Payload<ModuleDescription, ModuleDescriptionSchema>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'\nexport const ModuleDescribeQuerySchema: ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'\n\nexport type ModuleDescribeQuery = Query<{\n schema: ModuleDescribeQuerySchema\n}>\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 { Query } from '@xyo-network/payload-model'\n\nexport type ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'\nexport const ModuleManifestQuerySchema: ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'\n\nexport type ModuleManifestQuery = Query<{\n schema: ModuleManifestQuerySchema\n}>\n","import { AddressSchema } from '@xyo-network/address-payload-plugin'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport const AddressPreviousHashSchema = `${AddressSchema}.hash.previous`\nexport type AddressPreviousHashSchema = typeof AddressPreviousHashSchema\n\nexport type AddressPreviousHashPayload = Payload<{\n address: string\n previousHash?: string\n schema: AddressPreviousHashSchema\n}>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleAddressQuerySchema = 'network.xyo.query.module.address'\nexport const ModuleAddressQuerySchema: ModuleAddressQuerySchema = 'network.xyo.query.module.address'\n\nexport type ModuleAddressQuery = Query<{\n schema: ModuleAddressQuerySchema\n}>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\nexport const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\n\nexport interface ModuleSubscribeFilter {\n /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */\n schema?: string[]\n}\n\n//requests notification when a boundwitness is added to the modules chain that meets the filter criteria\nexport type ModuleSubscribeQuery = Query<{\n /** @field The address that will receive notifications */\n address: string\n /** @field A subscribe with a null for filter is an unsubscribe */\n filter?: ModuleSubscribeFilter | null\n /** @field The maximum events queued per send [may increase frequency] */\n maxQueue?: number\n schema: ModuleSubscribeQuerySchema\n}>\n"],"mappings":";AAIO,IAAM,0BAA0B;;;ACDhC,IAAM,4BAAuD;;;ACA7D,IAAM,4BAAuD;;;ACA7D,IAAM,4BAAuD;;;ACHpE,SAAS,qBAAqB;AAGvB,IAAM,4BAA4B,GAAG,aAAa;;;ACAlD,IAAM,2BAAqD;;;ACA3D,IAAM,6BAAyD;","names":[]}
@@ -1,14 +1,333 @@
1
- export * from "./Config";
2
- export * from "./CreatableModule";
3
- export * from "./EventsModels";
4
- export * from "./instance";
5
- export * from "./Labels";
6
- export * from "./lib";
7
- export * from "./module";
8
- export * from "./ModuleDescription";
9
- export * from "./ModuleParams";
10
- export * from "./ModuleQueryHandlerResult";
11
- export * from "./ModuleQueryResult";
12
- export * from "./Queries";
13
- export * from "./withModule";
1
+ // src/Config.ts
2
+ var ModuleConfigSchema = "network.xyo.module.config";
3
+
4
+ // src/CreatableModule/CreatableModule.ts
5
+ function creatableModule() {
6
+ return (constructor) => {
7
+ constructor;
8
+ };
9
+ }
10
+
11
+ // src/CreatableModule/CreatableModuleRegistry.ts
12
+ var toCreatableModuleRegistry = (dict) => {
13
+ return Object.entries(dict).reduce((registry, [schema, factory4]) => {
14
+ registry[schema] = Array.isArray(factory4) ? factory4 : [factory4];
15
+ return registry;
16
+ }, {});
17
+ };
18
+ var assignCreatableModuleRegistry = (target = {}, ...sources) => {
19
+ sources.map(
20
+ (source) => Object.entries(source).map(([schema, factories]) => {
21
+ if (factories) {
22
+ const existingFactories = target[schema];
23
+ target[schema] = existingFactories ? target[schema] = [...existingFactories, ...factories] : factories;
24
+ }
25
+ })
26
+ );
27
+ return target;
28
+ };
29
+
30
+ // src/CreatableModule/LabeledCreatableModuleFactory.ts
31
+ var hasLabels = (factory4) => {
32
+ return factory4.labels !== void 0;
33
+ };
34
+
35
+ // src/CreatableModule/ModuleFactory.ts
36
+ import { assertEx } from "@xylabs/assert";
37
+ import { merge } from "@xylabs/lodash";
38
+ var ModuleFactory = class _ModuleFactory {
39
+ configSchemas;
40
+ creatableModule;
41
+ defaultLogger;
42
+ defaultParams;
43
+ labels;
44
+ constructor(creatableModule2, params, labels = {}) {
45
+ this.creatableModule = creatableModule2;
46
+ this.defaultParams = params;
47
+ this.configSchemas = creatableModule2.configSchemas;
48
+ this.labels = Object.assign({}, creatableModule2.labels ?? {}, labels ?? {});
49
+ }
50
+ get configSchema() {
51
+ return this.configSchemas[0];
52
+ }
53
+ static withParams(creatableModule2, params, labels = {}) {
54
+ return new _ModuleFactory(creatableModule2, params, labels);
55
+ }
56
+ _getRootFunction(funcName) {
57
+ let anyThis = this;
58
+ while (anyThis.__proto__[funcName]) {
59
+ anyThis = anyThis.__proto__;
60
+ }
61
+ return anyThis[funcName];
62
+ }
63
+ _noOverride(functionName) {
64
+ const thisFunc = this[functionName];
65
+ const rootFunc = this._getRootFunction(functionName);
66
+ assertEx(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
67
+ }
68
+ create(params) {
69
+ const factory4 = this;
70
+ const schema = factory4.creatableModule.configSchema;
71
+ const mergedParams = merge({}, factory4.defaultParams, params, {
72
+ config: merge({}, factory4.defaultParams?.config, params?.config, { schema })
73
+ });
74
+ return factory4.creatableModule.create(mergedParams);
75
+ }
76
+ factory(_params) {
77
+ throw new Error("Method not implemented.");
78
+ }
79
+ };
80
+
81
+ // src/CreatableModule/ModuleFactoryLocator.ts
82
+ import { assertEx as assertEx2 } from "@xylabs/assert";
83
+
84
+ // src/Labels/Labels.ts
85
+ var hasAllLabels = (source, required) => {
86
+ if (!required)
87
+ return true;
88
+ return Object.entries(required).every(([key, value]) => {
89
+ return source?.hasOwnProperty(key) && source?.[key] === value;
90
+ });
91
+ };
92
+
93
+ // src/CreatableModule/ModuleFactoryLocator.ts
94
+ var ModuleFactoryLocator = class {
95
+ constructor(_registry = {}) {
96
+ this._registry = _registry;
97
+ }
98
+ /**
99
+ * The current registry for the module factory
100
+ */
101
+ get registry() {
102
+ return this._registry;
103
+ }
104
+ /**
105
+ * Locates a module factory that matches the supplied schema and labels
106
+ * @param schema The config schema for the module
107
+ * @param labels The labels for the module factory
108
+ * @returns A module factory that matches the supplied schema and labels or throws if one is not found
109
+ */
110
+ locate(schema, labels) {
111
+ return assertEx2(this.tryLocate(schema, labels), () => {
112
+ const configString = `config schema [${schema}]`;
113
+ const labelsString = labels ? ` & labels [${JSON.stringify(labels)}]` : "";
114
+ return `No module factory for the supplied ${configString}${labelsString} registered`;
115
+ });
116
+ }
117
+ /**
118
+ * Registers a single module factory (with optional tags) with the locator
119
+ * @param additional Additional module factories to register
120
+ */
121
+ register(mod, labels) {
122
+ mod.configSchemas.map((schema) => {
123
+ const existingFactories = this._registry[schema];
124
+ const factory4 = {
125
+ // Destructure instance properties
126
+ ...mod,
127
+ // Copy static methods
128
+ create: mod.create.bind(mod),
129
+ // Merge module & supplied labels
130
+ labels: Object.assign({}, mod.labels ?? {}, labels ?? {})
131
+ };
132
+ this._registry[schema] = existingFactories ? [...existingFactories, factory4] : [factory4];
133
+ });
134
+ return this;
135
+ }
136
+ /**
137
+ * Registers multiple module factories with the locator
138
+ * @param additional Additional module factories to register
139
+ */
140
+ registerMany(additional) {
141
+ Object.entries(additional).map(([schema, factories]) => {
142
+ if (factories) {
143
+ const existingFactories = this._registry[schema];
144
+ this._registry[schema] = existingFactories ? [...existingFactories, ...factories] : factories;
145
+ }
146
+ });
147
+ return this;
148
+ }
149
+ /**
150
+ * Tries to locate a module factory that matches the supplied schema and labels
151
+ * @param schema The config schema for the module
152
+ * @param labels The labels for the module factory
153
+ * @returns A module factory that matches the supplied schema and labels or undefined
154
+ */
155
+ tryLocate(schema, labels) {
156
+ return labels ? (
157
+ // Find the first factory that has labels and has all the labels provided
158
+ this._registry[schema]?.filter(hasLabels).find((factory4) => hasAllLabels(factory4?.labels, labels))
159
+ ) : (
160
+ // Otherwise, return the first factory
161
+ this._registry[schema]?.[0]
162
+ );
163
+ }
164
+ };
165
+
166
+ // src/instance/asModuleInstance.ts
167
+ import { AsObjectFactory as AsObjectFactory3 } from "@xyo-network/object";
168
+
169
+ // src/instance/isModuleInstance.ts
170
+ import { IsObjectFactory as IsObjectFactory2 } from "@xyo-network/object";
171
+
172
+ // src/module/asModule.ts
173
+ import { AsObjectFactory as AsObjectFactory2 } from "@xyo-network/object";
174
+
175
+ // src/Queries/Describe/Payload.ts
176
+ var ModuleDescriptionSchema = "network.xyo.module.description";
177
+
178
+ // src/Queries/Describe/Query.ts
179
+ var ModuleDescribeQuerySchema = "network.xyo.query.module.describe";
180
+
181
+ // src/Queries/Discover.ts
182
+ var ModuleDiscoverQuerySchema = "network.xyo.query.module.discover";
183
+
184
+ // src/Queries/Manifest.ts
185
+ var ModuleManifestQuerySchema = "network.xyo.query.module.manifest";
186
+
187
+ // src/Queries/ModuleAddress/Payload.ts
188
+ import { AddressSchema } from "@xyo-network/address-payload-plugin";
189
+ var AddressPreviousHashSchema = `${AddressSchema}.hash.previous`;
190
+
191
+ // src/Queries/ModuleAddress/Query.ts
192
+ var ModuleAddressQuerySchema = "network.xyo.query.module.address";
193
+
194
+ // src/Queries/Subscribe.ts
195
+ var ModuleSubscribeQuerySchema = "network.xyo.query.module.subscribe";
196
+
197
+ // src/module/asModuleObject.ts
198
+ import { AsObjectFactory } from "@xyo-network/object";
199
+
200
+ // src/module/isModuleObject.ts
201
+ import { IsObjectFactory } from "@xyo-network/object";
202
+ var requiredModuleFunctions = {
203
+ address: "string",
204
+ config: "object",
205
+ params: "object",
206
+ queries: "array",
207
+ query: "function",
208
+ queryable: "function"
209
+ };
210
+ var factory = new IsObjectFactory();
211
+ var isModuleObject = factory.create(requiredModuleFunctions);
212
+
213
+ // src/module/asModuleObject.ts
214
+ var asModuleObject = AsObjectFactory.create(isModuleObject);
215
+
216
+ // src/module/IsModuleFactory.ts
217
+ var IsModuleFactory = class {
218
+ create(expectedQueries, additionalChecks) {
219
+ return (obj, config) => {
220
+ const module = asModuleObject(obj);
221
+ const result = isModuleObject(module, config) && (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) && //perform additional checks
222
+ (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true);
223
+ return result;
224
+ };
225
+ }
226
+ };
227
+
228
+ // src/module/isModule.ts
229
+ var requiredModuleQueries = [
230
+ /* We need to update this once live module conform */
231
+ //ModuleDescribeQuerySchema,
232
+ //ModuleAddressQuerySchema,
233
+ ModuleDiscoverQuerySchema
234
+ //ModuleManifestQuerySchema,
235
+ //ModuleSubscribeQuerySchema,
236
+ ];
237
+ var factory2 = new IsModuleFactory();
238
+ var isModule = factory2.create(requiredModuleQueries, [isModuleObject]);
239
+
240
+ // src/module/asModule.ts
241
+ var asModule = AsObjectFactory2.create(isModule);
242
+
243
+ // src/instance/isModuleInstance.ts
244
+ var requiredModuleInstanceFunctions = {
245
+ describe: "function",
246
+ discover: "function",
247
+ manifest: "function",
248
+ moduleAddress: "function"
249
+ };
250
+ var factory3 = new IsObjectFactory2();
251
+ var isModuleInstance = factory3.create(requiredModuleInstanceFunctions, [isModule]);
252
+
253
+ // src/instance/asModuleInstance.ts
254
+ var asModuleInstance = AsObjectFactory3.create(isModuleInstance);
255
+
256
+ // src/instance/ModuleInstance.ts
257
+ import { IsObjectFactory as IsObjectFactory3 } from "@xyo-network/object";
258
+ var IsInstanceFactory = class extends IsObjectFactory3 {
259
+ };
260
+
261
+ // src/lib/duplicateModules.ts
262
+ var duplicateModules = (value, index, array) => {
263
+ return array.findIndex((v) => v.address === value.address) === index;
264
+ };
265
+
266
+ // src/lib/serializable.ts
267
+ import { every, isArray, isBoolean, isNull, isNumber, isPlainObject, isString, isUndefined, overSome } from "@xylabs/lodash";
268
+ var JSONPrimitiveChecks = [isUndefined, isNull, isBoolean, isNumber, isString];
269
+ var JSONComplexChecks = [isPlainObject, isArray];
270
+ var serializable = (field, depth) => {
271
+ let depthExceeded = false;
272
+ const decrementDepth = () => depth ? depth-- : void 0;
273
+ const recursiveSerializable = (field2) => {
274
+ if (depth !== void 0 && depth < 1) {
275
+ depthExceeded = true;
276
+ return false;
277
+ }
278
+ decrementDepth();
279
+ const nestedSerializable = (field3) => overSome(JSONComplexChecks)(field3) && every(field3, recursiveSerializable);
280
+ return overSome([...JSONPrimitiveChecks, nestedSerializable])(field2);
281
+ };
282
+ const valid = recursiveSerializable(field);
283
+ return depthExceeded ? null : valid;
284
+ };
285
+ var serializableField = (field) => {
286
+ return overSome([...JSONPrimitiveChecks, ...JSONComplexChecks])(field);
287
+ };
288
+
289
+ // src/withModule.ts
290
+ var WithFactory = {
291
+ create: (typeCheck) => {
292
+ return (module, closure) => {
293
+ return typeCheck(module) ? closure(module) : void 0;
294
+ };
295
+ }
296
+ };
297
+ var withModule = WithFactory.create(isModule);
298
+ var withModuleInstance = WithFactory.create(isModuleInstance);
299
+ export {
300
+ AddressPreviousHashSchema,
301
+ IsInstanceFactory,
302
+ IsModuleFactory,
303
+ ModuleAddressQuerySchema,
304
+ ModuleConfigSchema,
305
+ ModuleDescribeQuerySchema,
306
+ ModuleDescriptionSchema,
307
+ ModuleDiscoverQuerySchema,
308
+ ModuleFactory,
309
+ ModuleFactoryLocator,
310
+ ModuleManifestQuerySchema,
311
+ ModuleSubscribeQuerySchema,
312
+ WithFactory,
313
+ asModule,
314
+ asModuleInstance,
315
+ asModuleObject,
316
+ assignCreatableModuleRegistry,
317
+ creatableModule,
318
+ duplicateModules,
319
+ hasAllLabels,
320
+ hasLabels,
321
+ isModule,
322
+ isModuleInstance,
323
+ isModuleObject,
324
+ requiredModuleFunctions,
325
+ requiredModuleInstanceFunctions,
326
+ requiredModuleQueries,
327
+ serializable,
328
+ serializableField,
329
+ toCreatableModuleRegistry,
330
+ withModule,
331
+ withModuleInstance
332
+ };
14
333
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './Config'\nexport * from './CreatableModule'\nexport * from './EventsModels'\nexport * from './instance'\nexport * from './Labels'\nexport * from './lib'\nexport * from './module'\nexport * from './ModuleDescription'\nexport * from './ModuleParams'\nexport * from './ModuleQueryHandlerResult'\nexport * from './ModuleQueryResult'\nexport * from './Queries'\nexport * from './withModule'\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
1
+ {"version":3,"sources":["../../src/Config.ts","../../src/CreatableModule/CreatableModule.ts","../../src/CreatableModule/CreatableModuleRegistry.ts","../../src/CreatableModule/LabeledCreatableModuleFactory.ts","../../src/CreatableModule/ModuleFactory.ts","../../src/CreatableModule/ModuleFactoryLocator.ts","../../src/Labels/Labels.ts","../../src/instance/asModuleInstance.ts","../../src/instance/isModuleInstance.ts","../../src/module/asModule.ts","../../src/Queries/Describe/Payload.ts","../../src/Queries/Describe/Query.ts","../../src/Queries/Discover.ts","../../src/Queries/Manifest.ts","../../src/Queries/ModuleAddress/Payload.ts","../../src/Queries/ModuleAddress/Query.ts","../../src/Queries/Subscribe.ts","../../src/module/asModuleObject.ts","../../src/module/isModuleObject.ts","../../src/module/IsModuleFactory.ts","../../src/module/isModule.ts","../../src/instance/ModuleInstance.ts","../../src/lib/duplicateModules.ts","../../src/lib/serializable.ts","../../src/withModule.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","import { AccountInstance } from '@xyo-network/account-model'\nimport { Logger } from '@xyo-network/logger'\n\nimport { ModuleInstance } from '../instance'\n\nexport type CreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {\n create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>\n}\n\nexport interface CreatableModule<T extends ModuleInstance = ModuleInstance> {\n configSchema: string\n configSchemas: string[]\n defaultLogger?: Logger\n new (privateConstructorKey: string, params: T['params'], account: AccountInstance): T\n _noOverride(functionName: string): void\n create<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): Promise<T>\n factory<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>\n}\n\n/**\n * Class annotation to be used to decorate Modules which support\n * an asynchronous creation pattern\n * @returns The decorated Module requiring it implement the members\n * of the CreatableModule as statics properties/methods\n */\nexport function creatableModule<TModule extends ModuleInstance = ModuleInstance>() {\n return <U extends CreatableModule<TModule>>(constructor: U) => {\n constructor\n }\n}\n","import { CreatableModuleFactory } from './CreatableModule'\nimport { CreatableModuleDictionary } from './CreatableModuleDictionary'\nimport { LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'\n\nexport interface CreatableModuleRegistry {\n [key: string]: (CreatableModuleFactory | LabeledCreatableModuleFactory)[] | undefined\n}\n\nexport const toCreatableModuleRegistry = (dict: CreatableModuleDictionary | CreatableModuleRegistry): CreatableModuleRegistry => {\n return Object.entries(dict).reduce((registry, [schema, factory]) => {\n registry[schema] = Array.isArray(factory) ? factory : [factory]\n return registry\n }, {} as CreatableModuleRegistry)\n}\n\nexport const assignCreatableModuleRegistry = (\n target: CreatableModuleRegistry = {},\n ...sources: CreatableModuleRegistry[]\n): CreatableModuleRegistry => {\n sources.map((source) =>\n Object.entries(source).map(([schema, factories]) => {\n if (factories) {\n const existingFactories = target[schema]\n target[schema] = existingFactories ? (target[schema] = [...existingFactories, ...factories]) : factories\n }\n }),\n )\n return target\n}\n","import { ModuleInstance } from '../instance'\nimport { WithOptionalLabels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\n\nexport type LabeledCreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = CreatableModuleFactory<T> & WithOptionalLabels\n\nexport const hasLabels = (factory: CreatableModuleFactory | LabeledCreatableModuleFactory): factory is LabeledCreatableModuleFactory => {\n return (factory as LabeledCreatableModuleFactory).labels !== undefined\n}\n","import { assertEx } from '@xylabs/assert'\nimport { merge } from '@xylabs/lodash'\nimport { Logger } from '@xyo-network/logger'\n\nimport { ModuleInstance } from '../instance'\nimport { Labels, WithOptionalLabels } from '../Labels'\nimport { CreatableModule, CreatableModuleFactory } from './CreatableModule'\n\nexport class ModuleFactory<TModule extends ModuleInstance> implements CreatableModuleFactory<TModule> {\n configSchemas: CreatableModuleFactory<TModule>['configSchemas']\n\n creatableModule: CreatableModule<TModule>\n\n defaultLogger?: Logger | undefined\n\n defaultParams?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] }\n\n labels?: Labels\n\n constructor(\n creatableModule: CreatableModule<TModule>,\n params?: Omit<TModule['params'], 'config'> & { config?: TModule['params']['config'] },\n labels: Labels = {},\n ) {\n this.creatableModule = creatableModule\n this.defaultParams = params\n this.configSchemas = creatableModule.configSchemas\n this.labels = Object.assign({}, (creatableModule as WithOptionalLabels).labels ?? {}, labels ?? {})\n }\n\n get configSchema(): string {\n return this.configSchemas[0]\n }\n\n static withParams<T extends ModuleInstance>(\n creatableModule: CreatableModule<T>,\n params?: Omit<T['params'], 'config'> & { config?: T['params']['config'] },\n labels: Labels = {},\n ) {\n return new ModuleFactory(creatableModule, params, labels)\n }\n\n _getRootFunction(funcName: string) {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n let anyThis = this as any\n while (anyThis.__proto__[funcName]) {\n anyThis = anyThis.__proto__\n }\n return anyThis[funcName]\n }\n\n _noOverride(functionName: string) {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const thisFunc = (this as any)[functionName]\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const rootFunc = this._getRootFunction(functionName)\n assertEx(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`)\n }\n\n create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T> {\n const factory = this as ModuleFactory<T>\n const schema = factory.creatableModule.configSchema\n const mergedParams: TModule['params'] = merge({}, factory.defaultParams, params, {\n config: merge({}, factory.defaultParams?.config, params?.config, { schema }),\n })\n return factory.creatableModule.create<T>(mergedParams)\n }\n\n factory<T extends ModuleInstance>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T> {\n throw new Error('Method not implemented.')\n }\n}\n","import { assertEx } from '@xylabs/assert'\n\nimport { ModuleInstance } from '../instance'\nimport { hasAllLabels, Labels } from '../Labels'\nimport { CreatableModuleFactory } from './CreatableModule'\nimport { CreatableModuleRegistry } from './CreatableModuleRegistry'\nimport { hasLabels, LabeledCreatableModuleFactory } from './LabeledCreatableModuleFactory'\n\n/**\n * A class which encapsulates the Service Locator Pattern for Module Factories\n */\nexport class ModuleFactoryLocator {\n constructor(protected readonly _registry: CreatableModuleRegistry = {}) {}\n\n /**\n * The current registry for the module factory\n */\n get registry(): Readonly<CreatableModuleRegistry> {\n return this._registry\n }\n\n /**\n * Locates a module factory that matches the supplied schema and labels\n * @param schema The config schema for the module\n * @param labels The labels for the module factory\n * @returns A module factory that matches the supplied schema and labels or throws if one is not found\n */\n locate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory {\n return assertEx(this.tryLocate(schema, labels), () => {\n const configString = `config schema [${schema}]`\n const labelsString = labels ? ` & labels [${JSON.stringify(labels)}]` : ''\n return `No module factory for the supplied ${configString}${labelsString} registered`\n })\n }\n\n /**\n * Registers a single module factory (with optional tags) with the locator\n * @param additional Additional module factories to register\n */\n register<TModule extends ModuleInstance>(mod: CreatableModuleFactory<TModule>, labels?: Labels): this {\n mod.configSchemas.map((schema) => {\n const existingFactories = this._registry[schema]\n const factory: LabeledCreatableModuleFactory<TModule> = {\n // Destructure instance properties\n ...mod,\n // Copy static methods\n create: mod.create.bind(mod) as LabeledCreatableModuleFactory<TModule>['create'],\n // Merge module & supplied labels\n labels: Object.assign({}, (mod as LabeledCreatableModuleFactory).labels ?? {}, labels ?? {}),\n }\n this._registry[schema] = existingFactories ? [...existingFactories, factory] : [factory]\n })\n return this\n }\n\n /**\n * Registers multiple module factories with the locator\n * @param additional Additional module factories to register\n */\n registerMany(additional: CreatableModuleRegistry): this {\n Object.entries(additional).map(([schema, factories]) => {\n if (factories) {\n const existingFactories = this._registry[schema]\n this._registry[schema] = existingFactories ? [...existingFactories, ...factories] : factories\n }\n })\n return this\n }\n\n /**\n * Tries to locate a module factory that matches the supplied schema and labels\n * @param schema The config schema for the module\n * @param labels The labels for the module factory\n * @returns A module factory that matches the supplied schema and labels or undefined\n */\n tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {\n // If labels were provided\n return labels\n ? // Find the first factory that has labels and has all the labels provided\n this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))\n : // Otherwise, return the first factory\n this._registry[schema]?.[0]\n }\n}\n","/**\n * Object used to represent labels identifying a resource.\n */\nexport interface Labels {\n [key: string]: string | undefined\n}\n\n/**\n * Interface for objects that have labels.\n */\nexport interface WithLabels<T extends Labels = Labels> {\n labels: T\n}\n\n/**\n * Interface for objects that have labels.\n */\nexport interface WithOptionalLabels<T extends Labels = Labels> {\n labels?: T\n}\n\n/**\n * Returns true if the source object has all the labels from the required set\n * @param source Source object to check against\n * @param required Set of labels to check for in source\n * @returns True of the source object has all the labels from the required set\n */\nexport const hasAllLabels = (source?: Labels, required?: Labels): boolean => {\n if (!required) return true\n return Object.entries(required).every(([key, value]) => {\n // eslint-disable-next-line no-prototype-builtins\n return source?.hasOwnProperty(key as keyof typeof source) && source?.[key as keyof typeof source] === value\n })\n}\n","import { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModuleInstance } from './isModuleInstance'\n\nexport const asModuleInstance = AsObjectFactory.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 { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModule } from './isModule'\n\nexport const asModule = AsObjectFactory.create(isModule)\n","import { Payload } from '@xyo-network/payload-model'\n\nimport { ModuleDescription } from '../../ModuleDescription'\n\nexport const ModuleDescriptionSchema = 'network.xyo.module.description'\nexport type ModuleDescriptionSchema = typeof ModuleDescriptionSchema\n\nexport type ModuleDescriptionPayload = Payload<ModuleDescription, ModuleDescriptionSchema>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'\nexport const ModuleDescribeQuerySchema: ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'\n\nexport type ModuleDescribeQuery = Query<{\n schema: ModuleDescribeQuerySchema\n}>\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 { Query } from '@xyo-network/payload-model'\n\nexport type ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'\nexport const ModuleManifestQuerySchema: ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'\n\nexport type ModuleManifestQuery = Query<{\n schema: ModuleManifestQuerySchema\n}>\n","import { AddressSchema } from '@xyo-network/address-payload-plugin'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport const AddressPreviousHashSchema = `${AddressSchema}.hash.previous`\nexport type AddressPreviousHashSchema = typeof AddressPreviousHashSchema\n\nexport type AddressPreviousHashPayload = Payload<{\n address: string\n previousHash?: string\n schema: AddressPreviousHashSchema\n}>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleAddressQuerySchema = 'network.xyo.query.module.address'\nexport const ModuleAddressQuerySchema: ModuleAddressQuerySchema = 'network.xyo.query.module.address'\n\nexport type ModuleAddressQuery = Query<{\n schema: ModuleAddressQuerySchema\n}>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\nexport const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'\n\nexport interface ModuleSubscribeFilter {\n /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */\n schema?: string[]\n}\n\n//requests notification when a boundwitness is added to the modules chain that meets the filter criteria\nexport type ModuleSubscribeQuery = Query<{\n /** @field The address that will receive notifications */\n address: string\n /** @field A subscribe with a null for filter is an unsubscribe */\n filter?: ModuleSubscribeFilter | null\n /** @field The maximum events queued per send [may increase frequency] */\n maxQueue?: number\n schema: ModuleSubscribeQuerySchema\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 { IsObjectFactory, ObjectTypeCheck } from '@xyo-network/object'\nimport { Promisable } from '@xyo-network/promise'\n\nimport { AnyConfigSchema, ModuleConfig } from '../Config'\nimport { ModuleEventData } from '../EventsModels'\nimport { Module, ModuleQueryFunctions } from '../module'\nimport { ModuleParams } from '../ModuleParams'\n\nexport interface ResolveFunctions {\n resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>\n resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>\n resolve<T extends ModuleInstance = ModuleInstance>(\n nameOrAddressOrFilter?: ModuleFilter<T> | string,\n options?: ModuleFilterOptions<T>,\n ): Promisable<T | T[] | undefined>\n}\n\nexport interface ModuleResolver extends ResolveFunctions {\n addResolver: (resolver: ModuleResolver) => this\n isModuleResolver: boolean\n removeResolver: (resolver: ModuleResolver) => this\n}\n\nexport type ModuleInstance<\n TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,\n TEventData extends ModuleEventData = ModuleEventData,\n> = Module<TParams, TEventData> &\n ResolveFunctions &\n ModuleQueryFunctions & {\n /* The resolver is a 'down' resolver. It can resolve the module or any children (if it is a node for example), that are in the module*/\n readonly downResolver: Omit<ModuleResolver, 'resolve'>\n\n /* The resolver is a 'up' resolver. It can resolve the parent or any children of the parent*/\n /* This is set by a NodeModule when attaching to the module */\n readonly upResolver: Omit<ModuleResolver, 'resolve'>\n }\n\nexport type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = ObjectTypeCheck<T>\n\nexport class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {}\n\nexport interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {\n direction?: 'up' | 'down' | 'all'\n identity?: InstanceTypeCheck<T>\n maxDepth?: number\n visibility?: 'public' | 'private' | 'all'\n}\n\nexport interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n address: string[]\n}\n\nexport interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n name: string[]\n}\n\nexport interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n query: string[][]\n}\n\nexport type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> &\n Partial<NameModuleFilter<T>> &\n Partial<QueryModuleFilter<T>>\n\nexport type ModuleFilter<T extends ModuleInstance = ModuleInstance> =\n | ModuleFilterOptions<T>\n | AddressModuleFilter<T>\n | NameModuleFilter<T>\n | QueryModuleFilter<T>\n","import { Module } from '../module'\n\n/**\n * Used to filter duplicates from an array of modules\n * @example: modulesArray.filter(duplicateModules)\n * @param value Current Module\n * @param index Current Module's index\n * @param array Module Array\n * @returns True if the Module's address is the first occurrence of\n * that address in the array, false otherwise\n */\nexport const duplicateModules = (value: Module, index: number, array: Module[]): value is Module => {\n return array.findIndex((v) => v.address === value.address) === index\n}\n","// Inspired by https://stackoverflow.com/a/49079549/2803259\n\nimport { every, isArray, isBoolean, isNull, isNumber, isPlainObject, isString, isUndefined, overSome } from '@xylabs/lodash'\n\nconst JSONPrimitiveChecks = [isUndefined, isNull, isBoolean, isNumber, isString]\nconst JSONComplexChecks = [isPlainObject, isArray]\n\nexport const serializable = (field: unknown, depth?: number): boolean | null => {\n let depthExceeded = false\n const decrementDepth = () => (depth ? depth-- : undefined)\n\n const recursiveSerializable = (field: unknown) => {\n if (depth !== undefined && depth < 1) {\n depthExceeded = true\n return false\n }\n\n // decrement during every recursion\n decrementDepth()\n\n const nestedSerializable = (field: unknown): boolean => overSome(JSONComplexChecks)(field) && every(field as object, recursiveSerializable)\n\n return overSome([...JSONPrimitiveChecks, nestedSerializable])(field)\n }\n\n const valid = recursiveSerializable(field)\n\n return depthExceeded ? null : valid\n}\n\nexport const serializableField = (field: unknown) => {\n return overSome([...JSONPrimitiveChecks, ...JSONComplexChecks])(field)\n}\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":";AAMO,IAAM,qBAAyC;;;ACmB/C,SAAS,kBAAmE;AACjF,SAAO,CAAqC,gBAAmB;AAC7D;AAAA,EACF;AACF;;;ACrBO,IAAM,4BAA4B,CAAC,SAAuF;AAC/H,SAAO,OAAO,QAAQ,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQA,QAAO,MAAM;AAClE,aAAS,MAAM,IAAI,MAAM,QAAQA,QAAO,IAAIA,WAAU,CAACA,QAAO;AAC9D,WAAO;AAAA,EACT,GAAG,CAAC,CAA4B;AAClC;AAEO,IAAM,gCAAgC,CAC3C,SAAkC,CAAC,MAChC,YACyB;AAC5B,UAAQ;AAAA,IAAI,CAAC,WACX,OAAO,QAAQ,MAAM,EAAE,IAAI,CAAC,CAAC,QAAQ,SAAS,MAAM;AAClD,UAAI,WAAW;AACb,cAAM,oBAAoB,OAAO,MAAM;AACvC,eAAO,MAAM,IAAI,oBAAqB,OAAO,MAAM,IAAI,CAAC,GAAG,mBAAmB,GAAG,SAAS,IAAK;AAAA,MACjG;AAAA,IACF,CAAC;AAAA,EACH;AACA,SAAO;AACT;;;ACtBO,IAAM,YAAY,CAACC,aAA8G;AACtI,SAAQA,SAA0C,WAAW;AAC/D;;;ACRA,SAAS,gBAAgB;AACzB,SAAS,aAAa;AAOf,IAAM,gBAAN,MAAM,eAAyF;AAAA,EACpG;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA,YACEC,kBACA,QACA,SAAiB,CAAC,GAClB;AACA,SAAK,kBAAkBA;AACvB,SAAK,gBAAgB;AACrB,SAAK,gBAAgBA,iBAAgB;AACrC,SAAK,SAAS,OAAO,OAAO,CAAC,GAAIA,iBAAuC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,EACpG;AAAA,EAEA,IAAI,eAAuB;AACzB,WAAO,KAAK,cAAc,CAAC;AAAA,EAC7B;AAAA,EAEA,OAAO,WACLA,kBACA,QACA,SAAiB,CAAC,GAClB;AACA,WAAO,IAAI,eAAcA,kBAAiB,QAAQ,MAAM;AAAA,EAC1D;AAAA,EAEA,iBAAiB,UAAkB;AAEjC,QAAI,UAAU;AACd,WAAO,QAAQ,UAAU,QAAQ,GAAG;AAClC,gBAAU,QAAQ;AAAA,IACpB;AACA,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEA,YAAY,cAAsB;AAEhC,UAAM,WAAY,KAAa,YAAY;AAE3C,UAAM,WAAW,KAAK,iBAAiB,YAAY;AACnD,aAAS,aAAa,UAAU,6BAA6B,YAAY,gBAAgB,YAAY,iBAAiB;AAAA,EACxH;AAAA,EAEA,OAAkE,QAAoD;AACpH,UAAMC,WAAU;AAChB,UAAM,SAASA,SAAQ,gBAAgB;AACvC,UAAM,eAAkC,MAAM,CAAC,GAAGA,SAAQ,eAAe,QAAQ;AAAA,MAC/E,QAAQ,MAAM,CAAC,GAAGA,SAAQ,eAAe,QAAQ,QAAQ,QAAQ,EAAE,OAAO,CAAC;AAAA,IAC7E,CAAC;AACD,WAAOA,SAAQ,gBAAgB,OAAU,YAAY;AAAA,EACvD;AAAA,EAEA,QAA4D,SAA8D;AACxH,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC3C;AACF;;;ACvEA,SAAS,YAAAC,iBAAgB;;;AC2BlB,IAAM,eAAe,CAAC,QAAiB,aAA+B;AAC3E,MAAI,CAAC;AAAU,WAAO;AACtB,SAAO,OAAO,QAAQ,QAAQ,EAAE,MAAM,CAAC,CAAC,KAAK,KAAK,MAAM;AAEtD,WAAO,QAAQ,eAAe,GAA0B,KAAK,SAAS,GAA0B,MAAM;AAAA,EACxG,CAAC;AACH;;;ADtBO,IAAM,uBAAN,MAA2B;AAAA,EAChC,YAA+B,YAAqC,CAAC,GAAG;AAAzC;AAAA,EAA0C;AAAA;AAAA;AAAA;AAAA,EAKzE,IAAI,WAA8C;AAChD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,QAAgB,QAAyE;AAC9F,WAAOC,UAAS,KAAK,UAAU,QAAQ,MAAM,GAAG,MAAM;AACpD,YAAM,eAAe,kBAAkB,MAAM;AAC7C,YAAM,eAAe,SAAS,cAAc,KAAK,UAAU,MAAM,CAAC,MAAM;AACxE,aAAO,sCAAsC,YAAY,GAAG,YAAY;AAAA,IAC1E,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAyC,KAAsC,QAAuB;AACpG,QAAI,cAAc,IAAI,CAAC,WAAW;AAChC,YAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,YAAMC,WAAkD;AAAA;AAAA,QAEtD,GAAG;AAAA;AAAA,QAEH,QAAQ,IAAI,OAAO,KAAK,GAAG;AAAA;AAAA,QAE3B,QAAQ,OAAO,OAAO,CAAC,GAAI,IAAsC,UAAU,CAAC,GAAG,UAAU,CAAC,CAAC;AAAA,MAC7F;AACA,WAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmBA,QAAO,IAAI,CAACA,QAAO;AAAA,IACzF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,YAA2C;AACtD,WAAO,QAAQ,UAAU,EAAE,IAAI,CAAC,CAAC,QAAQ,SAAS,MAAM;AACtD,UAAI,WAAW;AACb,cAAM,oBAAoB,KAAK,UAAU,MAAM;AAC/C,aAAK,UAAU,MAAM,IAAI,oBAAoB,CAAC,GAAG,mBAAmB,GAAG,SAAS,IAAI;AAAA,MACtF;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgB,QAAqF;AAE7G,WAAO;AAAA;AAAA,MAEH,KAAK,UAAU,MAAM,GAAG,OAAO,SAAS,EAAE,KAAK,CAACA,aAAY,aAAaA,UAAS,QAAQ,MAAM,CAAC;AAAA;AAAA;AAAA,MAEjG,KAAK,UAAU,MAAM,IAAI,CAAC;AAAA;AAAA,EAChC;AACF;;;AEnFA,SAAS,mBAAAC,wBAAuB;;;ACAhC,SAAS,mBAAAC,wBAAyD;;;ACAlE,SAAS,mBAAAC,wBAAuB;;;ACIzB,IAAM,0BAA0B;;;ACDhC,IAAM,4BAAuD;;;ACA7D,IAAM,4BAAuD;;;ACA7D,IAAM,4BAAuD;;;ACHpE,SAAS,qBAAqB;AAGvB,IAAM,4BAA4B,GAAG,aAAa;;;ACAlD,IAAM,2BAAqD;;;ACA3D,IAAM,6BAAyD;;;ACHtE,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;;;AXfhG,IAAM,WAAWC,iBAAgB,OAAO,QAAQ;;;ADChD,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;;;ADXpH,IAAM,mBAAmBE,iBAAgB,OAAO,gBAAgB;;;AcJvE,SAAS,mBAAAC,wBAAwC;AAuC1C,IAAM,oBAAN,cAA2EA,iBAAmB;AAAC;;;AC5B/F,IAAM,mBAAmB,CAAC,OAAe,OAAe,UAAqC;AAClG,SAAO,MAAM,UAAU,CAAC,MAAM,EAAE,YAAY,MAAM,OAAO,MAAM;AACjE;;;ACXA,SAAS,OAAO,SAAS,WAAW,QAAQ,UAAU,eAAe,UAAU,aAAa,gBAAgB;AAE5G,IAAM,sBAAsB,CAAC,aAAa,QAAQ,WAAW,UAAU,QAAQ;AAC/E,IAAM,oBAAoB,CAAC,eAAe,OAAO;AAE1C,IAAM,eAAe,CAAC,OAAgB,UAAmC;AAC9E,MAAI,gBAAgB;AACpB,QAAM,iBAAiB,MAAO,QAAQ,UAAU;AAEhD,QAAM,wBAAwB,CAACC,WAAmB;AAChD,QAAI,UAAU,UAAa,QAAQ,GAAG;AACpC,sBAAgB;AAChB,aAAO;AAAA,IACT;AAGA,mBAAe;AAEf,UAAM,qBAAqB,CAACA,WAA4B,SAAS,iBAAiB,EAAEA,MAAK,KAAK,MAAMA,QAAiB,qBAAqB;AAE1I,WAAO,SAAS,CAAC,GAAG,qBAAqB,kBAAkB,CAAC,EAAEA,MAAK;AAAA,EACrE;AAEA,QAAM,QAAQ,sBAAsB,KAAK;AAEzC,SAAO,gBAAgB,OAAO;AAChC;AAEO,IAAM,oBAAoB,CAAC,UAAmB;AACnD,SAAO,SAAS,CAAC,GAAG,qBAAqB,GAAG,iBAAiB,CAAC,EAAE,KAAK;AACvE;;;AC3BO,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":["factory","factory","creatableModule","factory","assertEx","assertEx","factory","AsObjectFactory","IsObjectFactory","AsObjectFactory","factory","AsObjectFactory","factory","IsObjectFactory","AsObjectFactory","IsObjectFactory","field"]}
@@ -1,6 +1,7 @@
1
+ // src/instance/ModuleInstance.ts
1
2
  import { IsObjectFactory } from "@xyo-network/object";
2
- class IsInstanceFactory extends IsObjectFactory {
3
- }
3
+ var IsInstanceFactory = class extends IsObjectFactory {
4
+ };
4
5
  export {
5
6
  IsInstanceFactory
6
7
  };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/instance/ModuleInstance.ts"],"sourcesContent":["import { IsObjectFactory, ObjectTypeCheck } from '@xyo-network/object'\nimport { Promisable } from '@xyo-network/promise'\n\nimport { AnyConfigSchema, ModuleConfig } from '../Config'\nimport { ModuleEventData } from '../EventsModels'\nimport { Module, ModuleQueryFunctions } from '../module'\nimport { ModuleParams } from '../ModuleParams'\n\nexport interface ResolveFunctions {\n resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>\n resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>\n resolve<T extends ModuleInstance = ModuleInstance>(\n nameOrAddressOrFilter?: ModuleFilter<T> | string,\n options?: ModuleFilterOptions<T>,\n ): Promisable<T | T[] | undefined>\n}\n\nexport interface ModuleResolver extends ResolveFunctions {\n addResolver: (resolver: ModuleResolver) => this\n isModuleResolver: boolean\n removeResolver: (resolver: ModuleResolver) => this\n}\n\nexport type ModuleInstance<\n TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,\n TEventData extends ModuleEventData = ModuleEventData,\n> = Module<TParams, TEventData> &\n ResolveFunctions &\n ModuleQueryFunctions & {\n /* The resolver is a 'down' resolver. It can resolve the module or any children (if it is a node for example), that are in the module*/\n readonly downResolver: Omit<ModuleResolver, 'resolve'>\n\n /* The resolver is a 'up' resolver. It can resolve the parent or any children of the parent*/\n /* This is set by a NodeModule when attaching to the module */\n readonly upResolver: Omit<ModuleResolver, 'resolve'>\n }\n\nexport type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = ObjectTypeCheck<T>\n\nexport class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {}\n\nexport interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {\n direction?: 'up' | 'down' | 'all'\n identity?: InstanceTypeCheck<T>\n maxDepth?: number\n visibility?: 'public' | 'private' | 'all'\n}\n\nexport interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n address: string[]\n}\n\nexport interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n name: string[]\n}\n\nexport interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n query: string[][]\n}\n\nexport type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> &\n Partial<NameModuleFilter<T>> &\n Partial<QueryModuleFilter<T>>\n\nexport type ModuleFilter<T extends ModuleInstance = ModuleInstance> =\n | ModuleFilterOptions<T>\n | AddressModuleFilter<T>\n | NameModuleFilter<T>\n | QueryModuleFilter<T>\n"],"mappings":"AAAA,SAAS,uBAAwC;AAuC1C,MAAM,0BAAqE,gBAAmB;AAAC;","names":[]}
1
+ {"version":3,"sources":["../../../src/instance/ModuleInstance.ts"],"sourcesContent":["import { IsObjectFactory, ObjectTypeCheck } from '@xyo-network/object'\nimport { Promisable } from '@xyo-network/promise'\n\nimport { AnyConfigSchema, ModuleConfig } from '../Config'\nimport { ModuleEventData } from '../EventsModels'\nimport { Module, ModuleQueryFunctions } from '../module'\nimport { ModuleParams } from '../ModuleParams'\n\nexport interface ResolveFunctions {\n resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>\n resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>\n resolve<T extends ModuleInstance = ModuleInstance>(\n nameOrAddressOrFilter?: ModuleFilter<T> | string,\n options?: ModuleFilterOptions<T>,\n ): Promisable<T | T[] | undefined>\n}\n\nexport interface ModuleResolver extends ResolveFunctions {\n addResolver: (resolver: ModuleResolver) => this\n isModuleResolver: boolean\n removeResolver: (resolver: ModuleResolver) => this\n}\n\nexport type ModuleInstance<\n TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,\n TEventData extends ModuleEventData = ModuleEventData,\n> = Module<TParams, TEventData> &\n ResolveFunctions &\n ModuleQueryFunctions & {\n /* The resolver is a 'down' resolver. It can resolve the module or any children (if it is a node for example), that are in the module*/\n readonly downResolver: Omit<ModuleResolver, 'resolve'>\n\n /* The resolver is a 'up' resolver. It can resolve the parent or any children of the parent*/\n /* This is set by a NodeModule when attaching to the module */\n readonly upResolver: Omit<ModuleResolver, 'resolve'>\n }\n\nexport type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = ObjectTypeCheck<T>\n\nexport class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {}\n\nexport interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {\n direction?: 'up' | 'down' | 'all'\n identity?: InstanceTypeCheck<T>\n maxDepth?: number\n visibility?: 'public' | 'private' | 'all'\n}\n\nexport interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n address: string[]\n}\n\nexport interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n name: string[]\n}\n\nexport interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {\n query: string[][]\n}\n\nexport type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> &\n Partial<NameModuleFilter<T>> &\n Partial<QueryModuleFilter<T>>\n\nexport type ModuleFilter<T extends ModuleInstance = ModuleInstance> =\n | ModuleFilterOptions<T>\n | AddressModuleFilter<T>\n | NameModuleFilter<T>\n | QueryModuleFilter<T>\n"],"mappings":";AAAA,SAAS,uBAAwC;AAuC1C,IAAM,oBAAN,cAA2E,gBAAmB;AAAC;","names":[]}
@@ -1,6 +1,67 @@
1
+ // src/instance/asModuleInstance.ts
2
+ import { AsObjectFactory as AsObjectFactory2 } from "@xyo-network/object";
3
+
4
+ // src/instance/isModuleInstance.ts
5
+ import { IsObjectFactory as IsObjectFactory2 } from "@xyo-network/object";
6
+
7
+ // src/Queries/Discover.ts
8
+ var ModuleDiscoverQuerySchema = "network.xyo.query.module.discover";
9
+
10
+ // src/module/asModuleObject.ts
1
11
  import { AsObjectFactory } from "@xyo-network/object";
2
- import { isModuleInstance } from "./isModuleInstance";
3
- const asModuleInstance = AsObjectFactory.create(isModuleInstance);
12
+
13
+ // src/module/isModuleObject.ts
14
+ import { IsObjectFactory } from "@xyo-network/object";
15
+ var requiredModuleFunctions = {
16
+ address: "string",
17
+ config: "object",
18
+ params: "object",
19
+ queries: "array",
20
+ query: "function",
21
+ queryable: "function"
22
+ };
23
+ var factory = new IsObjectFactory();
24
+ var isModuleObject = factory.create(requiredModuleFunctions);
25
+
26
+ // src/module/asModuleObject.ts
27
+ var asModuleObject = AsObjectFactory.create(isModuleObject);
28
+
29
+ // src/module/IsModuleFactory.ts
30
+ var IsModuleFactory = class {
31
+ create(expectedQueries, additionalChecks) {
32
+ return (obj, config) => {
33
+ const module = asModuleObject(obj);
34
+ const result = isModuleObject(module, config) && (expectedQueries?.reduce((prev, query) => prev && obj.queries.includes(query), true) ?? true) && //perform additional checks
35
+ (additionalChecks?.reduce((prev, check) => prev && check(obj, config), true) ?? true);
36
+ return result;
37
+ };
38
+ }
39
+ };
40
+
41
+ // src/module/isModule.ts
42
+ var requiredModuleQueries = [
43
+ /* We need to update this once live module conform */
44
+ //ModuleDescribeQuerySchema,
45
+ //ModuleAddressQuerySchema,
46
+ ModuleDiscoverQuerySchema
47
+ //ModuleManifestQuerySchema,
48
+ //ModuleSubscribeQuerySchema,
49
+ ];
50
+ var factory2 = new IsModuleFactory();
51
+ var isModule = factory2.create(requiredModuleQueries, [isModuleObject]);
52
+
53
+ // src/instance/isModuleInstance.ts
54
+ var requiredModuleInstanceFunctions = {
55
+ describe: "function",
56
+ discover: "function",
57
+ manifest: "function",
58
+ moduleAddress: "function"
59
+ };
60
+ var factory3 = new IsObjectFactory2();
61
+ var isModuleInstance = factory3.create(requiredModuleInstanceFunctions, [isModule]);
62
+
63
+ // src/instance/asModuleInstance.ts
64
+ var asModuleInstance = AsObjectFactory2.create(isModuleInstance);
4
65
  export {
5
66
  asModuleInstance
6
67
  };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/instance/asModuleInstance.ts"],"sourcesContent":["import { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModuleInstance } from './isModuleInstance'\n\nexport const asModuleInstance = AsObjectFactory.create(isModuleInstance)\n"],"mappings":"AAAA,SAAS,uBAAuB;AAEhC,SAAS,wBAAwB;AAE1B,MAAM,mBAAmB,gBAAgB,OAAO,gBAAgB;","names":[]}
1
+ {"version":3,"sources":["../../../src/instance/asModuleInstance.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 { AsObjectFactory } from '@xyo-network/object'\n\nimport { isModuleInstance } from './isModuleInstance'\n\nexport const asModuleInstance = AsObjectFactory.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,SAAS,mBAAAA,wBAAuB;;;ACAhC,SAAS,mBAAAC,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;;;ADXpH,IAAM,mBAAmBE,iBAAgB,OAAO,gBAAgB;","names":["AsObjectFactory","IsObjectFactory","factory","factory","IsObjectFactory","AsObjectFactory"]}