@xyo-network/module-abstract 2.57.5 → 2.58.0

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 (57) hide show
  1. package/dist/cjs/AbstractModule.js +57 -37
  2. package/dist/cjs/AbstractModule.js.map +1 -1
  3. package/dist/cjs/ModuleFactory.js +6 -1
  4. package/dist/cjs/ModuleFactory.js.map +1 -1
  5. package/dist/cjs/Resolver/CompositeModuleResolver.js +11 -0
  6. package/dist/cjs/Resolver/CompositeModuleResolver.js.map +1 -1
  7. package/dist/cjs/Resolver/SimpleModuleResolver.js +9 -0
  8. package/dist/cjs/Resolver/SimpleModuleResolver.js.map +1 -1
  9. package/dist/docs.json +40449 -21105
  10. package/dist/esm/AbstractModule.js +46 -33
  11. package/dist/esm/AbstractModule.js.map +1 -1
  12. package/dist/esm/ModuleFactory.js +4 -1
  13. package/dist/esm/ModuleFactory.js.map +1 -1
  14. package/dist/esm/Resolver/CompositeModuleResolver.js +9 -0
  15. package/dist/esm/Resolver/CompositeModuleResolver.js.map +1 -1
  16. package/dist/esm/Resolver/SimpleModuleResolver.js +9 -0
  17. package/dist/esm/Resolver/SimpleModuleResolver.js.map +1 -1
  18. package/dist/types/AbstractModule.d.ts +106 -4
  19. package/dist/types/AbstractModule.d.ts.map +1 -1
  20. package/dist/types/ModuleFactory.d.ts.map +1 -1
  21. package/dist/types/Resolver/CompositeModuleResolver.d.ts +1 -0
  22. package/dist/types/Resolver/CompositeModuleResolver.d.ts.map +1 -1
  23. package/dist/types/Resolver/SimpleModuleResolver.d.ts +1 -0
  24. package/dist/types/Resolver/SimpleModuleResolver.d.ts.map +1 -1
  25. package/dist/types/lib/duplicateModules.d.ts +18 -16
  26. package/dist/types/lib/duplicateModules.d.ts.map +1 -1
  27. package/docs/assets/search.js +1 -1
  28. package/docs/classes/AbstractModule.html +115 -70
  29. package/docs/classes/BaseEmitter.html +13 -13
  30. package/docs/classes/CompositeModuleResolver.html +39 -18
  31. package/docs/classes/ModuleConfigQueryValidator.html +11 -11
  32. package/docs/classes/ModuleErrorBuilder.html +7 -7
  33. package/docs/classes/ModuleFactory.html +13 -13
  34. package/docs/classes/QueryBoundWitnessBuilder.html +10 -10
  35. package/docs/classes/QueryBoundWitnessValidator.html +6 -6
  36. package/docs/classes/QueryBoundWitnessWrapper.html +63 -15
  37. package/docs/classes/SimpleModuleResolver.html +45 -24
  38. package/docs/classes/SupportedQueryValidator.html +6 -6
  39. package/docs/functions/duplicateModules.html +5 -5
  40. package/docs/functions/isQuerySupportedByModule.html +2 -2
  41. package/docs/functions/mixinResolverEventEmitter.html +1 -1
  42. package/docs/functions/serializable.html +1 -1
  43. package/docs/functions/serializableField.html +1 -1
  44. package/docs/interfaces/CreatableModuleDictionary.html +1 -1
  45. package/docs/interfaces/ModuleResolvedEventArgs.html +4 -4
  46. package/docs/interfaces/QueryValidator.html +2 -2
  47. package/docs/interfaces/ResolverEventEmitter.html +2 -2
  48. package/docs/types/ModuleError.html +1 -1
  49. package/docs/types/ModuleErrorSchema.html +2 -2
  50. package/docs/types/Queryable.html +1 -1
  51. package/docs/types/SortedPipedAddressesString.html +1 -1
  52. package/docs/variables/ModuleErrorSchema-1.html +2 -2
  53. package/package.json +24 -23
  54. package/src/AbstractModule.ts +55 -39
  55. package/src/ModuleFactory.ts +4 -1
  56. package/src/Resolver/CompositeModuleResolver.ts +9 -0
  57. package/src/Resolver/SimpleModuleResolver.ts +9 -0
package/docs/classes/BaseEmitter.html CHANGED
@@ -35,7 +35,7 @@
35
35
  <ul class="tsd-hierarchy">
36
36
  <li><span class="tsd-signature-type ">EventFunctions</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TEventData</span><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources">
37
37
  <ul>
38
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L4">modules/packages/module/packages/abstract/src/BaseEmitter.ts:4</a></li></ul></aside>
38
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L4">modules/packages/module/packages/abstract/src/BaseEmitter.ts:4</a></li></ul></aside>
39
39
  <section class="tsd-panel-group tsd-index-group">
40
40
  <section class="tsd-panel tsd-index-panel">
41
41
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -90,7 +90,7 @@
90
90
  <h4 class="tsd-returns-title">Returns <a href="BaseEmitter.html" class="tsd-signature-type tsd-kind-class">BaseEmitter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TParams</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TEventData</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
91
91
  <p>Overrides Base&lt;TParams&gt;.constructor</p>
92
92
  <ul>
93
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L13">modules/packages/module/packages/abstract/src/BaseEmitter.ts:13</a></li></ul></aside></li></ul></section></section>
93
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L13">modules/packages/module/packages/abstract/src/BaseEmitter.ts:13</a></li></ul></aside></li></ul></section></section>
94
94
  <section class="tsd-panel-group tsd-member-group">
95
95
  <h2>Properties</h2>
96
96
  <section class="tsd-panel tsd-member"><a id="eventData" class="tsd-anchor"></a>
@@ -98,12 +98,12 @@
98
98
  <div class="tsd-signature"><span class="tsd-kind-property">event<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">TEventData</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
99
99
  <p>Implementation of EventFunctions.eventData</p>
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L9">modules/packages/module/packages/abstract/src/BaseEmitter.ts:9</a></li></ul></aside></section>
101
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L9">modules/packages/module/packages/abstract/src/BaseEmitter.ts:9</a></li></ul></aside></section>
102
102
  <section class="tsd-panel tsd-member tsd-is-private"><a id="events" class="tsd-anchor"></a>
103
103
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
104
104
  <div class="tsd-signature"><span class="tsd-kind-property">events</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Events</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TEventData</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L11">modules/packages/module/packages/abstract/src/BaseEmitter.ts:11</a></li></ul></aside></section>
106
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L11">modules/packages/module/packages/abstract/src/BaseEmitter.ts:11</a></li></ul></aside></section>
107
107
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="params" class="tsd-anchor"></a>
108
108
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>params</span><a href="#params" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
109
109
  <div class="tsd-signature"><span class="tsd-kind-property">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">TParams</span></div><aside class="tsd-sources">
@@ -142,7 +142,7 @@
142
142
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
143
143
  <p>Implementation of EventFunctions.clearListeners</p>
144
144
  <ul>
145
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L18">modules/packages/module/packages/abstract/src/BaseEmitter.ts:18</a></li></ul></aside></li></ul></section>
145
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L18">modules/packages/module/packages/abstract/src/BaseEmitter.ts:18</a></li></ul></aside></li></ul></section>
146
146
  <section class="tsd-panel tsd-member"><a id="emit" class="tsd-anchor"></a>
147
147
  <h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
148
148
  <ul class="tsd-signatures">
@@ -165,7 +165,7 @@
165
165
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
166
166
  <p>Implementation of EventFunctions.emit</p>
167
167
  <ul>
168
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L22">modules/packages/module/packages/abstract/src/BaseEmitter.ts:22</a></li></ul></aside></li></ul></section>
168
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L22">modules/packages/module/packages/abstract/src/BaseEmitter.ts:22</a></li></ul></aside></li></ul></section>
169
169
  <section class="tsd-panel tsd-member"><a id="emitSerial" class="tsd-anchor"></a>
170
170
  <h3 class="tsd-anchor-link"><span>emit<wbr/>Serial</span><a href="#emitSerial" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
171
171
  <ul class="tsd-signatures">
@@ -188,7 +188,7 @@
188
188
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
189
189
  <p>Implementation of EventFunctions.emitSerial</p>
190
190
  <ul>
191
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L29">modules/packages/module/packages/abstract/src/BaseEmitter.ts:29</a></li></ul></aside></li></ul></section>
191
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L29">modules/packages/module/packages/abstract/src/BaseEmitter.ts:29</a></li></ul></aside></li></ul></section>
192
192
  <section class="tsd-panel tsd-member"><a id="listenerCount" class="tsd-anchor"></a>
193
193
  <h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
194
194
  <ul class="tsd-signatures">
@@ -202,7 +202,7 @@
202
202
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
203
203
  <p>Implementation of EventFunctions.listenerCount</p>
204
204
  <ul>
205
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L36">modules/packages/module/packages/abstract/src/BaseEmitter.ts:36</a></li></ul></aside></li></ul></section>
205
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L36">modules/packages/module/packages/abstract/src/BaseEmitter.ts:36</a></li></ul></aside></li></ul></section>
206
206
  <section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a>
207
207
  <h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
208
208
  <ul class="tsd-signatures">
@@ -223,7 +223,7 @@
223
223
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
224
224
  <p>Implementation of EventFunctions.off</p>
225
225
  <ul>
226
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L40">modules/packages/module/packages/abstract/src/BaseEmitter.ts:40</a></li></ul></aside></li></ul></section>
226
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L40">modules/packages/module/packages/abstract/src/BaseEmitter.ts:40</a></li></ul></aside></li></ul></section>
227
227
  <section class="tsd-panel tsd-member"><a id="offAny" class="tsd-anchor"></a>
228
228
  <h3 class="tsd-anchor-link"><span>off<wbr/>Any</span><a href="#offAny" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
229
229
  <ul class="tsd-signatures">
@@ -237,7 +237,7 @@
237
237
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
238
238
  <p>Implementation of EventFunctions.offAny</p>
239
239
  <ul>
240
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L44">modules/packages/module/packages/abstract/src/BaseEmitter.ts:44</a></li></ul></aside></li></ul></section>
240
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L44">modules/packages/module/packages/abstract/src/BaseEmitter.ts:44</a></li></ul></aside></li></ul></section>
241
241
  <section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a>
242
242
  <h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
243
243
  <ul class="tsd-signatures">
@@ -264,7 +264,7 @@
264
264
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><aside class="tsd-sources">
265
265
  <p>Implementation of EventFunctions.on</p>
266
266
  <ul>
267
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L48">modules/packages/module/packages/abstract/src/BaseEmitter.ts:48</a></li></ul></aside></li></ul></section>
267
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L48">modules/packages/module/packages/abstract/src/BaseEmitter.ts:48</a></li></ul></aside></li></ul></section>
268
268
  <section class="tsd-panel tsd-member"><a id="onAny" class="tsd-anchor"></a>
269
269
  <h3 class="tsd-anchor-link"><span>on<wbr/>Any</span><a href="#onAny" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
270
270
  <ul class="tsd-signatures">
@@ -284,7 +284,7 @@
284
284
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><aside class="tsd-sources">
285
285
  <p>Implementation of EventFunctions.onAny</p>
286
286
  <ul>
287
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L52">modules/packages/module/packages/abstract/src/BaseEmitter.ts:52</a></li></ul></aside></li></ul></section>
287
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L52">modules/packages/module/packages/abstract/src/BaseEmitter.ts:52</a></li></ul></aside></li></ul></section>
288
288
  <section class="tsd-panel tsd-member"><a id="once" class="tsd-anchor"></a>
289
289
  <h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
290
290
  <ul class="tsd-signatures">
@@ -311,7 +311,7 @@
311
311
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><aside class="tsd-sources">
312
312
  <p>Implementation of EventFunctions.once</p>
313
313
  <ul>
314
- <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/2e2024303/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L56">modules/packages/module/packages/abstract/src/BaseEmitter.ts:56</a></li></ul></aside></li></ul></section></section></div>
314
+ <li>Defined in <a href="https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/24e3ae188/packages/modules/packages/module/packages/abstract/src/BaseEmitter.ts#L56">modules/packages/module/packages/abstract/src/BaseEmitter.ts:56</a></li></ul></aside></li></ul></section></section></div>
315
315
  <div class="col-sidebar">
316
316
  <div class="page-menu">
317
317
  <div class="tsd-navigation settings">