@xyo-network/module-factory-locator 5.3.30 → 5.4.1

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 (2) hide show
  1. package/README.md +0 -320
  2. package/package.json +68 -72
package/README.md CHANGED
@@ -38,326 +38,6 @@ bun add {{name}}
38
38
 
39
39
  See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
40
 
41
- ## Reference
42
-
43
- ### packages
44
-
45
- ### modules
46
-
47
- ### packages
48
-
49
- ### module
50
-
51
- ### packages
52
-
53
- ### locator
54
-
55
- ### .temp-typedoc
56
-
57
- ### classes
58
-
59
- ### <a id="ModuleFactoryLocator"></a>ModuleFactoryLocator
60
-
61
- [**@xyo-network/module-factory-locator**](#../README)
62
-
63
- ***
64
-
65
- A class which encapsulates the Service Locator Pattern for Module Factories
66
-
67
- ## Implements
68
-
69
- - `ModuleFactoryLocatorInstance`
70
-
71
- ## Constructors
72
-
73
- ### Constructor
74
-
75
- ```ts
76
- new ModuleFactoryLocator(_registry?): ModuleFactoryLocator;
77
- ```
78
-
79
- ### Parameters
80
-
81
- #### \_registry?
82
-
83
- `CreatableModuleRegistry` = `...`
84
-
85
- ### Returns
86
-
87
- `ModuleFactoryLocator`
88
-
89
- ## Properties
90
-
91
- ### \_registry
92
-
93
- ```ts
94
- protected readonly _registry: CreatableModuleRegistry;
95
- ```
96
-
97
- ## Accessors
98
-
99
- ### registry
100
-
101
- ### Get Signature
102
-
103
- ```ts
104
- get registry(): Readonly<CreatableModuleRegistry>;
105
- ```
106
-
107
- The current registry for the module factory
108
-
109
- #### Returns
110
-
111
- `Readonly`\<`CreatableModuleRegistry`\>
112
-
113
- ### Implementation of
114
-
115
- ```ts
116
- ModuleFactoryLocatorInstance.registry
117
- ```
118
-
119
- ## Methods
120
-
121
- ### empty()
122
-
123
- ```ts
124
- static empty(): ModuleFactoryLocator;
125
- ```
126
-
127
- ### Returns
128
-
129
- `ModuleFactoryLocator`
130
-
131
- ***
132
-
133
- ### standard()
134
-
135
- ```ts
136
- static standard(): ModuleFactoryLocator;
137
- ```
138
-
139
- ### Returns
140
-
141
- `ModuleFactoryLocator`
142
-
143
- ***
144
-
145
- ### freeze()
146
-
147
- ```ts
148
- freeze(): void;
149
- ```
150
-
151
- ### Returns
152
-
153
- `void`
154
-
155
- ### Implementation of
156
-
157
- ```ts
158
- ModuleFactoryLocatorInstance.freeze
159
- ```
160
-
161
- ***
162
-
163
- ### locate()
164
-
165
- ```ts
166
- locate(schema, labels?):
167
- | CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>
168
- | LabeledCreatableModuleFactory;
169
- ```
170
-
171
- Locates a module factory that matches the supplied schema and labels
172
-
173
- ### Parameters
174
-
175
- #### schema
176
-
177
- `Schema`
178
-
179
- The config schema for the module
180
-
181
- #### labels?
182
-
183
- `Labels`
184
-
185
- The labels for the module factory
186
-
187
- ### Returns
188
-
189
- \| `CreatableModuleFactory`\<`CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
190
- \| `LabeledCreatableModuleFactory`
191
-
192
- A module factory that matches the supplied schema and labels or throws if one is not found
193
-
194
- ### Implementation of
195
-
196
- ```ts
197
- ModuleFactoryLocatorInstance.locate
198
- ```
199
-
200
- ***
201
-
202
- ### merge()
203
-
204
- ```ts
205
- merge(locator): ModuleFactoryLocatorInstance;
206
- ```
207
-
208
- ### Parameters
209
-
210
- #### locator
211
-
212
- `ModuleFactoryLocatorInstance`
213
-
214
- ### Returns
215
-
216
- `ModuleFactoryLocatorInstance`
217
-
218
- ### Implementation of
219
-
220
- ```ts
221
- ModuleFactoryLocatorInstance.merge
222
- ```
223
-
224
- ***
225
-
226
- ### register()
227
-
228
- ```ts
229
- register(
230
- factory,
231
- labels?,
232
- primary?): this;
233
- ```
234
-
235
- Registers a single module factory (with optional tags) with the locator
236
-
237
- ### Parameters
238
-
239
- #### factory
240
-
241
- `CreatableModuleFactory`
242
-
243
- The factory to register
244
-
245
- #### labels?
246
-
247
- `Labels`
248
-
249
- The labels for the module factory
250
-
251
- #### primary?
252
-
253
- `boolean` \| `Schema` \| `Schema`[]
254
-
255
- ### Returns
256
-
257
- `this`
258
-
259
- ### Implementation of
260
-
261
- ```ts
262
- ModuleFactoryLocatorInstance.register
263
- ```
264
-
265
- ***
266
-
267
- ### registerMany()
268
-
269
- ```ts
270
- registerMany(factories): this;
271
- ```
272
-
273
- Registers multiple module factories with the locator
274
-
275
- ### Parameters
276
-
277
- #### factories
278
-
279
- `CreatableModuleFactory`\<`CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>[]
280
-
281
- The factories to register
282
-
283
- ### Returns
284
-
285
- `this`
286
-
287
- ### Implementation of
288
-
289
- ```ts
290
- ModuleFactoryLocatorInstance.registerMany
291
- ```
292
-
293
- ***
294
-
295
- ### tryLocate()
296
-
297
- ```ts
298
- tryLocate(schema, labels?):
299
- | CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>
300
- | LabeledCreatableModuleFactory
301
- | undefined;
302
- ```
303
-
304
- Tries to locate a module factory that matches the supplied schema and labels
305
-
306
- ### Parameters
307
-
308
- #### schema
309
-
310
- `Schema`
311
-
312
- The config schema for the module
313
-
314
- #### labels?
315
-
316
- `Labels`
317
-
318
- The labels for the module factory
319
-
320
- ### Returns
321
-
322
- \| `CreatableModuleFactory`\<`CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
323
- \| `LabeledCreatableModuleFactory`
324
- \| `undefined`
325
-
326
- A module factory that matches the supplied schema and labels or undefined
327
-
328
- ### Implementation of
329
-
330
- ```ts
331
- ModuleFactoryLocatorInstance.tryLocate
332
- ```
333
-
334
- ### functions
335
-
336
- ### <a id="standardCreatableFactories"></a>standardCreatableFactories
337
-
338
- [**@xyo-network/module-factory-locator**](#../README)
339
-
340
- ***
341
-
342
- ```ts
343
- function standardCreatableFactories(): CreatableModuleRegistry;
344
- ```
345
-
346
- ## Returns
347
-
348
- `CreatableModuleRegistry`
349
-
350
- ### variables
351
-
352
- ### <a id="standardCreatableModulesList"></a>standardCreatableModulesList
353
-
354
- [**@xyo-network/module-factory-locator**](#../README)
355
-
356
- ***
357
-
358
- ```ts
359
- const standardCreatableModulesList: (CreatableModuleFactory | LabeledCreatableModuleFactory)[];
360
- ```
361
41
 
362
42
 
363
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/module-factory-locator",
3
- "version": "5.3.30",
3
+ "version": "5.4.1",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,12 +22,10 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
- "import": "./dist/neutral/index.mjs",
26
25
  "default": "./dist/neutral/index.mjs"
27
26
  },
28
27
  "./package.json": "./package.json"
29
28
  },
30
- "types": "dist/neutral/index.d.ts",
31
29
  "files": [
32
30
  "dist",
33
31
  "!**/*.bench.*",
@@ -36,84 +34,82 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/bridge-http": "~5.3.30",
40
- "@xyo-network/payload-model": "~5.3.30"
37
+ "@xyo-network/payload-model": "~5.4.1",
38
+ "@xyo-network/bridge-http": "~5.4.1"
41
39
  },
42
40
  "devDependencies": {
43
41
  "@opentelemetry/api": "^1.9.1",
44
- "@xylabs/sdk-js": "^5.0.95",
45
- "@xylabs/ts-scripts-common": "~7.8.7",
46
- "@xylabs/ts-scripts-pnpm": "~7.8.7",
47
- "@xylabs/tsconfig": "~7.8.7",
48
- "axios": "^1.14.0",
42
+ "@xylabs/sdk-js": "^5.0.97",
43
+ "@xylabs/toolchain": "~7.10.8",
44
+ "@xylabs/tsconfig": "~7.10.8",
49
45
  "ethers": "^6.16.0",
50
46
  "pako": "~2.1.0",
51
47
  "typescript": "~5.9.3",
52
48
  "zod": "^4.3.6",
53
- "@xyo-network/account-model": "~5.3.30",
54
- "@xyo-network/archivist-abstract": "~5.3.30",
55
- "@xyo-network/archivist-generic": "~5.3.30",
56
- "@xyo-network/archivist-memory": "~5.3.30",
57
- "@xyo-network/archivist-view": "~5.3.30",
58
- "@xyo-network/archivist-wrapper": "~5.3.30",
59
- "@xyo-network/archivist-model": "~5.3.30",
60
- "@xyo-network/boundwitness-builder": "~5.3.30",
61
- "@xyo-network/bridge-abstract": "~5.3.30",
62
- "@xyo-network/boundwitness-validator": "~5.3.30",
63
- "@xyo-network/bridge-model": "~5.3.30",
64
- "@xyo-network/data": "~5.3.30",
65
- "@xyo-network/config-payload-plugin": "~5.3.30",
66
- "@xyo-network/diviner-abstract": "~5.3.30",
67
- "@xyo-network/diviner-identity": "~5.3.30",
68
- "@xyo-network/diviner-boundwitness-memory": "~5.3.30",
69
- "@xyo-network/diviner-payload-model": "~5.3.30",
70
- "@xyo-network/diviner-model": "~5.3.30",
71
- "@xyo-network/diviner-payload-generic": "~5.3.30",
72
- "@xyo-network/hash": "~5.3.30",
73
- "@xyo-network/elliptic": "~5.3.30",
74
- "@xyo-network/module-abstract": "~5.3.30",
75
- "@xyo-network/module-model": "~5.3.30",
76
- "@xyo-network/module-resolver": "~5.3.30",
77
- "@xyo-network/module-wrapper": "~5.3.30",
78
- "@xyo-network/node-abstract": "~5.3.30",
79
- "@xyo-network/node-memory": "~5.3.30",
80
- "@xyo-network/node-model": "~5.3.30",
81
- "@xyo-network/manifest-model": "~5.3.30",
82
- "@xyo-network/diviner-wrapper": "~5.3.30",
83
- "@xyo-network/node-view": "~5.3.30",
84
- "@xyo-network/payload-builder": "~5.3.30",
85
- "@xyo-network/node-wrapper": "~5.3.30",
86
- "@xyo-network/payload-validator": "~5.3.30",
87
- "@xyo-network/previous-hash-store-model": "~5.3.30",
88
- "@xyo-network/sentinel-abstract": "~5.3.30",
89
- "@xyo-network/sentinel-memory": "~5.3.30",
90
- "@xyo-network/wallet-model": "~5.3.30",
91
- "@xyo-network/sentinel-model": "~5.3.30",
92
- "@xyo-network/wasm": "~5.3.30",
93
- "@xyo-network/witness-adhoc": "~5.3.30",
94
- "@xyo-network/witness-model": "~5.3.30"
49
+ "@xyo-network/account-model": "~5.4.1",
50
+ "@xyo-network/archivist-generic": "~5.4.1",
51
+ "@xyo-network/archivist-memory": "~5.4.1",
52
+ "@xyo-network/archivist-abstract": "~5.4.1",
53
+ "@xyo-network/archivist-view": "~5.4.1",
54
+ "@xyo-network/archivist-wrapper": "~5.4.1",
55
+ "@xyo-network/boundwitness-builder": "~5.4.1",
56
+ "@xyo-network/bridge-abstract": "~5.4.1",
57
+ "@xyo-network/bridge-model": "~5.4.1",
58
+ "@xyo-network/config-payload-plugin": "~5.4.1",
59
+ "@xyo-network/data": "~5.4.1",
60
+ "@xyo-network/diviner-abstract": "~5.4.1",
61
+ "@xyo-network/diviner-boundwitness-memory": "~5.4.1",
62
+ "@xyo-network/diviner-model": "~5.4.1",
63
+ "@xyo-network/diviner-payload-generic": "~5.4.1",
64
+ "@xyo-network/diviner-identity": "~5.4.1",
65
+ "@xyo-network/diviner-payload-model": "~5.4.1",
66
+ "@xyo-network/elliptic": "~5.4.1",
67
+ "@xyo-network/diviner-wrapper": "~5.4.1",
68
+ "@xyo-network/manifest-model": "~5.4.1",
69
+ "@xyo-network/module-resolver": "~5.4.1",
70
+ "@xyo-network/module-abstract": "~5.4.1",
71
+ "@xyo-network/module-wrapper": "~5.4.1",
72
+ "@xyo-network/node-abstract": "~5.4.1",
73
+ "@xyo-network/module-model": "~5.4.1",
74
+ "@xyo-network/node-memory": "~5.4.1",
75
+ "@xyo-network/hash": "~5.4.1",
76
+ "@xyo-network/node-model": "~5.4.1",
77
+ "@xyo-network/payload-builder": "~5.4.1",
78
+ "@xyo-network/payload-validator": "~5.4.1",
79
+ "@xyo-network/previous-hash-store-model": "~5.4.1",
80
+ "@xyo-network/sentinel-abstract": "~5.4.1",
81
+ "@xyo-network/sentinel-memory": "~5.4.1",
82
+ "@xyo-network/sentinel-model": "~5.4.1",
83
+ "@xyo-network/archivist-model": "~5.4.1",
84
+ "@xyo-network/wallet-model": "~5.4.1",
85
+ "@xyo-network/node-view": "~5.4.1",
86
+ "@xyo-network/wasm": "~5.4.1",
87
+ "@xyo-network/witness-adhoc": "~5.4.1",
88
+ "@xyo-network/witness-model": "~5.4.1",
89
+ "@xyo-network/boundwitness-validator": "~5.4.1",
90
+ "@xyo-network/node-wrapper": "~5.4.1"
95
91
  },
96
92
  "peerDependencies": {
97
- "@xylabs/sdk-js": "^5",
98
- "@xyo-network/archivist-view": "~5.3.30",
99
- "@xyo-network/bridge-abstract": "~5.3.30",
100
- "@xyo-network/account-model": "~5.3.30",
101
- "@xyo-network/archivist-memory": "~5.3.30",
102
- "@xyo-network/data": "~5.3.30",
103
- "@xyo-network/config-payload-plugin": "~5.3.30",
104
- "@xyo-network/diviner-payload-generic": "~5.3.30",
105
- "@xyo-network/bridge-model": "~5.3.30",
106
- "@xyo-network/manifest-model": "~5.3.30",
107
- "@xyo-network/diviner-boundwitness-memory": "~5.3.30",
108
- "@xyo-network/elliptic": "~5.3.30",
109
- "@xyo-network/module-model": "~5.3.30",
110
- "@xyo-network/node-model": "~5.3.30",
111
- "@xyo-network/node-memory": "~5.3.30",
112
- "@xyo-network/node-view": "~5.3.30",
113
- "@xyo-network/previous-hash-store-model": "~5.3.30",
114
- "@xyo-network/diviner-identity": "~5.3.30",
115
- "@xyo-network/sentinel-memory": "~5.3.30",
116
- "@xyo-network/witness-adhoc": "~5.3.30"
93
+ "@xylabs/sdk-js": "^5.0.97",
94
+ "@xyo-network/account-model": "~5.4",
95
+ "@xyo-network/archivist-memory": "~5.4",
96
+ "@xyo-network/archivist-view": "~5.4",
97
+ "@xyo-network/bridge-abstract": "~5.4",
98
+ "@xyo-network/bridge-model": "~5.4",
99
+ "@xyo-network/config-payload-plugin": "~5.4",
100
+ "@xyo-network/data": "~5.4",
101
+ "@xyo-network/diviner-boundwitness-memory": "~5.4",
102
+ "@xyo-network/diviner-identity": "~5.4",
103
+ "@xyo-network/diviner-payload-generic": "~5.4",
104
+ "@xyo-network/elliptic": "~5.4",
105
+ "@xyo-network/manifest-model": "~5.4",
106
+ "@xyo-network/module-model": "~5.4",
107
+ "@xyo-network/node-memory": "~5.4",
108
+ "@xyo-network/node-model": "~5.4",
109
+ "@xyo-network/node-view": "~5.4",
110
+ "@xyo-network/previous-hash-store-model": "~5.4",
111
+ "@xyo-network/sentinel-memory": "~5.4",
112
+ "@xyo-network/witness-adhoc": "~5.4"
117
113
  },
118
114
  "publishConfig": {
119
115
  "access": "public"