@xyo-network/sdk-js 4.2.1 → 5.0.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 (758) hide show
  1. package/package.json +19 -15
  2. package/src/spec/loading.spec.ts +12 -0
  3. package/BUILD_STATUS.md +0 -27
  4. package/build/neutral/index.d.ts +0 -4
  5. package/build/neutral/index.d.ts.map +0 -1
  6. package/docker/grafana/provisioning/dashboards/NodeJS Application Dashboard-11159.json +0 -951
  7. package/docker/grafana/provisioning/dashboards/Nodejs Metrics-11956.json +0 -1759
  8. package/docker/grafana/provisioning/dashboards/dashboard.yml +0 -12
  9. package/docker/grafana/provisioning/datasources/datasource.yml +0 -11
  10. package/docker/prometheus/prometheus.yml +0 -14
  11. package/docker-compose.metrics.yml +0 -33
  12. package/docker-compose.yml +0 -62
  13. package/docs/README.md +0 -748
  14. package/docs/classes/AbstractData.md +0 -127
  15. package/docs/classes/AbstractModuleResolver.md +0 -666
  16. package/docs/classes/Account.md +0 -431
  17. package/docs/classes/AddressValue.md +0 -251
  18. package/docs/classes/ArchivistWrapper.md +0 -2073
  19. package/docs/classes/BaseEmitter.md +0 -643
  20. package/docs/classes/BoundWitnessBuilder.md +0 -1387
  21. package/docs/classes/BoundWitnessValidator.md +0 -243
  22. package/docs/classes/BoundWitnessWrapper.md +0 -697
  23. package/docs/classes/BridgeWrapper.md +0 -1807
  24. package/docs/classes/CompositeModuleResolver.md +0 -824
  25. package/docs/classes/Data.md +0 -173
  26. package/docs/classes/DeadModuleError.md +0 -191
  27. package/docs/classes/DivinerWrapper.md +0 -1819
  28. package/docs/classes/EllipticKey.md +0 -180
  29. package/docs/classes/Events.md +0 -743
  30. package/docs/classes/Huri.md +0 -161
  31. package/docs/classes/IsAttachableArchivistInstanceFactory.md +0 -55
  32. package/docs/classes/IsAttachableBridgeInstanceFactory.md +0 -55
  33. package/docs/classes/IsAttachableDivinerInstanceFactory.md +0 -55
  34. package/docs/classes/IsAttachableModuleInstanceFactory.md +0 -55
  35. package/docs/classes/IsAttachableNodeInstanceFactory.md +0 -55
  36. package/docs/classes/IsAttachableSentinelInstanceFactory.md +0 -55
  37. package/docs/classes/IsAttachableWitnessInstanceFactory.md +0 -55
  38. package/docs/classes/IsInstanceFactory.md +0 -55
  39. package/docs/classes/IsModuleFactory.md +0 -43
  40. package/docs/classes/ManifestWrapper.md +0 -689
  41. package/docs/classes/ManifestWrapperEx.md +0 -743
  42. package/docs/classes/ModuleDetailsError.md +0 -179
  43. package/docs/classes/ModuleFactory.md +0 -243
  44. package/docs/classes/ModuleWrapper.md +0 -1559
  45. package/docs/classes/NameRegistrarTransformer.md +0 -53
  46. package/docs/classes/NodeWrapper.md +0 -1983
  47. package/docs/classes/ObjectHasher.md +0 -657
  48. package/docs/classes/PayloadBuilder.md +0 -967
  49. package/docs/classes/PayloadHasher.md +0 -657
  50. package/docs/classes/PayloadValidator.md +0 -121
  51. package/docs/classes/PayloadWrapper.md +0 -462
  52. package/docs/classes/PayloadWrapperBase.md +0 -225
  53. package/docs/classes/PrivateKey.md +0 -265
  54. package/docs/classes/PublicKey.md +0 -261
  55. package/docs/classes/QueryBoundWitnessBuilder.md +0 -1459
  56. package/docs/classes/QueryBoundWitnessWrapper.md +0 -861
  57. package/docs/classes/ResolveHelper.md +0 -217
  58. package/docs/classes/SequenceParser.md +0 -469
  59. package/docs/classes/SimpleModuleResolver.md +0 -779
  60. package/docs/classes/WasmSupport.md +0 -231
  61. package/docs/classes/WitnessWrapper.md +0 -1803
  62. package/docs/functions/constructableModuleWrapper.md +0 -33
  63. package/docs/functions/creatableModule.md +0 -39
  64. package/docs/functions/creatableModuleFactory.md +0 -39
  65. package/docs/functions/isPayloadOfSchemaType.md +0 -33
  66. package/docs/functions/labeledCreatableModuleFactory.md +0 -39
  67. package/docs/interfaces/AddressChildFields.md +0 -41
  68. package/docs/interfaces/AddressFields.md +0 -17
  69. package/docs/interfaces/AddressObjectFilter.md +0 -95
  70. package/docs/interfaces/AddressToWeakInstanceCache.md +0 -45
  71. package/docs/interfaces/AllArchivist.md +0 -35
  72. package/docs/interfaces/AllArchivistFunctions.md +0 -27
  73. package/docs/interfaces/ArchivingModuleConfig.md +0 -21
  74. package/docs/interfaces/ArchivingReentrancyConfig.md +0 -21
  75. package/docs/interfaces/Archivist.md +0 -163
  76. package/docs/interfaces/ArchivistInstance.md +0 -1299
  77. package/docs/interfaces/ArchivistLabels.md +0 -23
  78. package/docs/interfaces/ArchivistModuleEventData.md +0 -157
  79. package/docs/interfaces/ArchivistModuleInstance.md +0 -486
  80. package/docs/interfaces/ArchivistNextOptions.md +0 -57
  81. package/docs/interfaces/ArchivistParamFields.md +0 -13
  82. package/docs/interfaces/ArchivistParentInstances.md +0 -29
  83. package/docs/interfaces/ArchivistParents.md +0 -29
  84. package/docs/interfaces/ArchivistRawQueryFunctions.md +0 -151
  85. package/docs/interfaces/ArchivistStorage.md +0 -15
  86. package/docs/interfaces/AttachableArchivistInstance.md +0 -1331
  87. package/docs/interfaces/AttachableBridgeInstance.md +0 -1141
  88. package/docs/interfaces/AttachableDivinerInstance.md +0 -1085
  89. package/docs/interfaces/AttachableModuleInstance.md +0 -1018
  90. package/docs/interfaces/AttachableNodeInstance.md +0 -1309
  91. package/docs/interfaces/AttachableSentinelInstance.md +0 -1069
  92. package/docs/interfaces/AttachableWitnessInstance.md +0 -1077
  93. package/docs/interfaces/BoundWitnessBlockField.md +0 -17
  94. package/docs/interfaces/BoundWitnessChainField.md +0 -17
  95. package/docs/interfaces/BoundWitnessFields.md +0 -105
  96. package/docs/interfaces/BoundWitnessMeta.md +0 -29
  97. package/docs/interfaces/BoundWitnessOptionalFields.md +0 -49
  98. package/docs/interfaces/BoundWitnessRequiredFields.md +0 -45
  99. package/docs/interfaces/BridgeExposeOptions.md +0 -25
  100. package/docs/interfaces/BridgeInstance.md +0 -1105
  101. package/docs/interfaces/BridgeModule.md +0 -486
  102. package/docs/interfaces/BridgeModuleEventData.md +0 -269
  103. package/docs/interfaces/BridgeParams.md +0 -143
  104. package/docs/interfaces/BridgeQueryFunctions.md +0 -97
  105. package/docs/interfaces/BridgeRawQueryFunctions.md +0 -93
  106. package/docs/interfaces/BridgeUnexposeOptions.md +0 -33
  107. package/docs/interfaces/CacheConfig.md +0 -29
  108. package/docs/interfaces/ChildCertificationFields.md +0 -21
  109. package/docs/interfaces/CompositeModuleResolverParams.md +0 -69
  110. package/docs/interfaces/ConfigManifest.md +0 -61
  111. package/docs/interfaces/CreatableModule.md +0 -139
  112. package/docs/interfaces/CreatableModuleRegistry.md +0 -9
  113. package/docs/interfaces/CustomSentinelInstance.md +0 -1033
  114. package/docs/interfaces/CustomSentinelModule.md +0 -485
  115. package/docs/interfaces/DataHashStorageMeta.md +0 -17
  116. package/docs/interfaces/DataInstance.md +0 -37
  117. package/docs/interfaces/DivineEndEventData.md +0 -55
  118. package/docs/interfaces/DivineStartEventData.md +0 -43
  119. package/docs/interfaces/DivinerInstance.md +0 -1053
  120. package/docs/interfaces/DivinerModule.md +0 -485
  121. package/docs/interfaces/DivinerQueryFunctions.md +0 -67
  122. package/docs/interfaces/EventFunctions.md +0 -235
  123. package/docs/interfaces/ExposedEventData.md +0 -43
  124. package/docs/interfaces/FetchedPayload.md +0 -27
  125. package/docs/interfaces/FullArchivist.md +0 -147
  126. package/docs/interfaces/HashStorageMeta.md +0 -33
  127. package/docs/interfaces/HuriOptions.md +0 -21
  128. package/docs/interfaces/JobEndEventData.md +0 -47
  129. package/docs/interfaces/JobStartEventData.md +0 -43
  130. package/docs/interfaces/Labels.md +0 -15
  131. package/docs/interfaces/Manifest.md +0 -18
  132. package/docs/interfaces/ManifestWrapperExParams.md +0 -45
  133. package/docs/interfaces/Module.md +0 -492
  134. package/docs/interfaces/ModuleAttachedEventData.md +0 -29
  135. package/docs/interfaces/ModuleBusyEventData.md +0 -43
  136. package/docs/interfaces/ModuleConfigFields.md +0 -130
  137. package/docs/interfaces/ModuleDescription.md +0 -37
  138. package/docs/interfaces/ModuleDetachedEventData.md +0 -29
  139. package/docs/interfaces/ModuleErrorEventData.md +0 -43
  140. package/docs/interfaces/ModuleEventData.md +0 -106
  141. package/docs/interfaces/ModuleFactoryLocatorInstance.md +0 -159
  142. package/docs/interfaces/ModuleFamilyFunctions.md +0 -131
  143. package/docs/interfaces/ModuleFields.md +0 -173
  144. package/docs/interfaces/ModuleFilterOptions.md +0 -87
  145. package/docs/interfaces/ModuleIdentifierTransformer.md +0 -13
  146. package/docs/interfaces/ModuleInstance.md +0 -987
  147. package/docs/interfaces/ModuleManifest.md +0 -57
  148. package/docs/interfaces/ModuleNameResolver.md +0 -39
  149. package/docs/interfaces/ModuleQueriedEventData.md +0 -51
  150. package/docs/interfaces/ModuleQueryFunctions.md +0 -99
  151. package/docs/interfaces/ModuleRegisteredEventData.md +0 -29
  152. package/docs/interfaces/ModuleRepository.md +0 -391
  153. package/docs/interfaces/ModuleResolvedEventArgs.md +0 -21
  154. package/docs/interfaces/ModuleResolver.md +0 -243
  155. package/docs/interfaces/ModuleResolverInstance.md +0 -317
  156. package/docs/interfaces/ModuleResolverParams.md +0 -41
  157. package/docs/interfaces/ModuleSecurityConfig.md +0 -41
  158. package/docs/interfaces/ModuleSubscribeFilter.md +0 -17
  159. package/docs/interfaces/ModuleTask.md +0 -55
  160. package/docs/interfaces/ModuleUnregisteredEventData.md +0 -29
  161. package/docs/interfaces/NameObjectFilter.md +0 -95
  162. package/docs/interfaces/NextOptions.md +0 -47
  163. package/docs/interfaces/NodeInstance.md +0 -1277
  164. package/docs/interfaces/NodeManifest.md +0 -85
  165. package/docs/interfaces/NodeManifestPayload.md +0 -93
  166. package/docs/interfaces/NodeModule.md +0 -486
  167. package/docs/interfaces/NodeModuleEventData.md +0 -157
  168. package/docs/interfaces/NodeQueryFunctions.md +0 -197
  169. package/docs/interfaces/NodeRegistrationFunctions.md +0 -57
  170. package/docs/interfaces/ObjectFilterOptions.md +0 -86
  171. package/docs/interfaces/ObjectResolver.md +0 -209
  172. package/docs/interfaces/ObjectResolverInstance.md +0 -275
  173. package/docs/interfaces/ObserveEndEventData.md +0 -55
  174. package/docs/interfaces/ObserveStartEventData.md +0 -43
  175. package/docs/interfaces/PackageManifest.md +0 -37
  176. package/docs/interfaces/PayloadBuilderOptions.md +0 -21
  177. package/docs/interfaces/PayloadFields.md +0 -23
  178. package/docs/interfaces/PayloadFindFilter.md +0 -29
  179. package/docs/interfaces/PayloadMetaFields.md +0 -21
  180. package/docs/interfaces/PayloadSet.md +0 -21
  181. package/docs/interfaces/QueryFields.md +0 -53
  182. package/docs/interfaces/QueryFulfillFinishedEventData.md +0 -55
  183. package/docs/interfaces/QueryFulfillStartedEventData.md +0 -47
  184. package/docs/interfaces/QueryObjectFilter.md +0 -95
  185. package/docs/interfaces/QuerySendFinishedEventData.md +0 -55
  186. package/docs/interfaces/QuerySendStartedEventData.md +0 -47
  187. package/docs/interfaces/ReadArchivist.md +0 -68
  188. package/docs/interfaces/ReadArchivistFunctions.md +0 -55
  189. package/docs/interfaces/ReadWriteArchivist.md +0 -135
  190. package/docs/interfaces/ReportEndEventData.md +0 -51
  191. package/docs/interfaces/ReportStartEventData.md +0 -43
  192. package/docs/interfaces/ResolveHelperConfig.md +0 -69
  193. package/docs/interfaces/ResolveStrategy.md +0 -41
  194. package/docs/interfaces/ResolverEventEmitter.md +0 -27
  195. package/docs/interfaces/SchemaField.md +0 -23
  196. package/docs/interfaces/SchemaFields.md +0 -21
  197. package/docs/interfaces/SearchableStorage.md +0 -37
  198. package/docs/interfaces/Sentinel.md +0 -60
  199. package/docs/interfaces/SentinelInstance.md +0 -1038
  200. package/docs/interfaces/SentinelJob.md +0 -13
  201. package/docs/interfaces/SentinelModule.md +0 -486
  202. package/docs/interfaces/SentinelModuleEventData.md +0 -275
  203. package/docs/interfaces/SequenceStorageMeta.md +0 -17
  204. package/docs/interfaces/SourcesMetaField.md +0 -17
  205. package/docs/interfaces/StashArchivist.md +0 -35
  206. package/docs/interfaces/StashArchivistFunctions.md +0 -28
  207. package/docs/interfaces/State.md +0 -19
  208. package/docs/interfaces/StateDictionary.md +0 -9
  209. package/docs/interfaces/StorageMeta.md +0 -45
  210. package/docs/interfaces/TaskEndEventData.md +0 -55
  211. package/docs/interfaces/TaskStartEventData.md +0 -51
  212. package/docs/interfaces/Timestamp.md +0 -15
  213. package/docs/interfaces/UnexposedEventData.md +0 -43
  214. package/docs/interfaces/WithLabels.md +0 -21
  215. package/docs/interfaces/WithOptionalLabels.md +0 -21
  216. package/docs/interfaces/WitnessInstance.md +0 -1045
  217. package/docs/interfaces/WitnessModule.md +0 -485
  218. package/docs/interfaces/WitnessQueryFunctions.md +0 -59
  219. package/docs/interfaces/WriteArchivist.md +0 -92
  220. package/docs/interfaces/WriteArchivistFunctions.md +0 -75
  221. package/docs/type-aliases/AddressChildPayload.md +0 -7
  222. package/docs/type-aliases/AddressChildSchema.md +0 -7
  223. package/docs/type-aliases/AddressModuleFilter.md +0 -13
  224. package/docs/type-aliases/AddressPayload.md +0 -7
  225. package/docs/type-aliases/AddressPreviousHashPayload.md +0 -7
  226. package/docs/type-aliases/AddressPreviousHashSchema.md +0 -7
  227. package/docs/type-aliases/AddressSchema.md +0 -7
  228. package/docs/type-aliases/AllValidator.md +0 -19
  229. package/docs/type-aliases/AllValidatorFactory.md +0 -17
  230. package/docs/type-aliases/AnyBoundWitness.md +0 -7
  231. package/docs/type-aliases/AnyConfigSchema.md +0 -13
  232. package/docs/type-aliases/AnyModuleConfig.md +0 -7
  233. package/docs/type-aliases/AnyModuleFilter.md +0 -13
  234. package/docs/type-aliases/AnyObjectFilter.md +0 -13
  235. package/docs/type-aliases/AnyPayload.md +0 -7
  236. package/docs/type-aliases/ArchivistAllQuery.md +0 -7
  237. package/docs/type-aliases/ArchivistAllQuerySchema.md +0 -7
  238. package/docs/type-aliases/ArchivistClearQuery.md +0 -7
  239. package/docs/type-aliases/ArchivistClearQuerySchema.md +0 -7
  240. package/docs/type-aliases/ArchivistCommitQuery.md +0 -7
  241. package/docs/type-aliases/ArchivistCommitQuerySchema.md +0 -7
  242. package/docs/type-aliases/ArchivistConfig.md +0 -17
  243. package/docs/type-aliases/ArchivistConfigSchema.md +0 -7
  244. package/docs/type-aliases/ArchivistDeleteQuery.md +0 -7
  245. package/docs/type-aliases/ArchivistDeleteQuerySchema.md +0 -7
  246. package/docs/type-aliases/ArchivistGetQuery.md +0 -7
  247. package/docs/type-aliases/ArchivistGetQuerySchema.md +0 -7
  248. package/docs/type-aliases/ArchivistInsertQuery.md +0 -7
  249. package/docs/type-aliases/ArchivistInsertQuerySchema.md +0 -7
  250. package/docs/type-aliases/ArchivistModuleQueries.md +0 -7
  251. package/docs/type-aliases/ArchivistNextQuery.md +0 -7
  252. package/docs/type-aliases/ArchivistNextQuerySchema.md +0 -7
  253. package/docs/type-aliases/ArchivistParams.md +0 -17
  254. package/docs/type-aliases/ArchivistQueries.md +0 -7
  255. package/docs/type-aliases/ArchivistTask.md +0 -7
  256. package/docs/type-aliases/AsyncPayloadValidationFunction.md +0 -25
  257. package/docs/type-aliases/AttachableArchivistInstanceTypeCheck.md +0 -13
  258. package/docs/type-aliases/AttachableBridgeInstanceTypeCheck.md +0 -13
  259. package/docs/type-aliases/AttachableDivinerInstanceTypeCheck.md +0 -13
  260. package/docs/type-aliases/AttachableModuleInstanceTypeCheck.md +0 -13
  261. package/docs/type-aliases/AttachableNodeInstanceTypeCheck.md +0 -13
  262. package/docs/type-aliases/AttachableSentinelInstanceTypeCheck.md +0 -13
  263. package/docs/type-aliases/AttachableWitnessInstanceTypeCheck.md +0 -13
  264. package/docs/type-aliases/BoundWitness.md +0 -13
  265. package/docs/type-aliases/BoundWitnessSchema.md +0 -7
  266. package/docs/type-aliases/BridgeClientConfig.md +0 -31
  267. package/docs/type-aliases/BridgeConfig.md +0 -25
  268. package/docs/type-aliases/BridgeConfigSchema.md +0 -7
  269. package/docs/type-aliases/BridgeConnectQuery.md +0 -7
  270. package/docs/type-aliases/BridgeConnectQuerySchema.md +0 -7
  271. package/docs/type-aliases/BridgeDisconnectQuery.md +0 -7
  272. package/docs/type-aliases/BridgeDisconnectQuerySchema.md +0 -7
  273. package/docs/type-aliases/BridgeExposeQuery.md +0 -7
  274. package/docs/type-aliases/BridgeExposeQuerySchema.md +0 -7
  275. package/docs/type-aliases/BridgeHostConfig.md +0 -23
  276. package/docs/type-aliases/BridgeModuleQueries.md +0 -7
  277. package/docs/type-aliases/BridgeQueries.md +0 -7
  278. package/docs/type-aliases/BridgeUnexposeQuery.md +0 -7
  279. package/docs/type-aliases/BridgeUnexposeQuerySchema.md +0 -7
  280. package/docs/type-aliases/ChildCertification.md +0 -7
  281. package/docs/type-aliases/ChildCertificationSchema.md +0 -7
  282. package/docs/type-aliases/ColonPair.md +0 -13
  283. package/docs/type-aliases/ConstructableModuleWrapper.md +0 -177
  284. package/docs/type-aliases/CosigningAddressSet.md +0 -7
  285. package/docs/type-aliases/CreatableModuleFactory.md +0 -39
  286. package/docs/type-aliases/CustomWitnessInstance.md +0 -25
  287. package/docs/type-aliases/CustomWitnessModule.md +0 -25
  288. package/docs/type-aliases/DappPackageManifestPayloadSchema.md +0 -7
  289. package/docs/type-aliases/DebugLogger.md +0 -36
  290. package/docs/type-aliases/DebugOptions.md +0 -33
  291. package/docs/type-aliases/Direction.md +0 -7
  292. package/docs/type-aliases/DivineEndEventArgs.md +0 -21
  293. package/docs/type-aliases/DivineStartEventArgs.md +0 -17
  294. package/docs/type-aliases/DivinedPayload.md +0 -17
  295. package/docs/type-aliases/DivinerConfig.md +0 -17
  296. package/docs/type-aliases/DivinerConfigSchema.md +0 -7
  297. package/docs/type-aliases/DivinerDivineQuery.md +0 -7
  298. package/docs/type-aliases/DivinerDivineQuerySchema.md +0 -7
  299. package/docs/type-aliases/DivinerDivineResult.md +0 -13
  300. package/docs/type-aliases/DivinerModuleEventData.md +0 -21
  301. package/docs/type-aliases/DivinerModuleQueries.md +0 -7
  302. package/docs/type-aliases/DivinerParams.md +0 -17
  303. package/docs/type-aliases/DivinerQueries.md +0 -7
  304. package/docs/type-aliases/DivinerTask.md +0 -7
  305. package/docs/type-aliases/Epoch.md +0 -7
  306. package/docs/type-aliases/EventAnyListener.md +0 -27
  307. package/docs/type-aliases/EventArgs.md +0 -7
  308. package/docs/type-aliases/EventData.md +0 -11
  309. package/docs/type-aliases/EventListener.md +0 -23
  310. package/docs/type-aliases/EventListenerInfo.md +0 -29
  311. package/docs/type-aliases/EventName.md +0 -7
  312. package/docs/type-aliases/EventUnsubscribeFunction.md +0 -11
  313. package/docs/type-aliases/EventsParams.md +0 -7
  314. package/docs/type-aliases/ExposedEventArgs.md +0 -13
  315. package/docs/type-aliases/GeneratedBoundWitnessFields.md +0 -7
  316. package/docs/type-aliases/HuriFetchFunction.md +0 -17
  317. package/docs/type-aliases/HydratedBoundWitness.md +0 -17
  318. package/docs/type-aliases/HydratedBoundWitnessWithStorageMeta.md +0 -17
  319. package/docs/type-aliases/IdentityFunction.md +0 -23
  320. package/docs/type-aliases/IndexDescription.md +0 -49
  321. package/docs/type-aliases/IndexDirection.md +0 -9
  322. package/docs/type-aliases/InstanceTypeCheck.md +0 -13
  323. package/docs/type-aliases/JobEndEventArgs.md +0 -13
  324. package/docs/type-aliases/JobStartEventArgs.md +0 -13
  325. package/docs/type-aliases/LabeledCreatableModuleFactory.md +0 -13
  326. package/docs/type-aliases/LocalSequence.md +0 -7
  327. package/docs/type-aliases/MetaEventData.md +0 -45
  328. package/docs/type-aliases/ModuleAddressQuery.md +0 -7
  329. package/docs/type-aliases/ModuleAddressQuerySchema.md +0 -7
  330. package/docs/type-aliases/ModuleAlias.md +0 -7
  331. package/docs/type-aliases/ModuleAttachedEventArgs.md +0 -13
  332. package/docs/type-aliases/ModuleBusyEventArgs.md +0 -13
  333. package/docs/type-aliases/ModuleConfig.md +0 -17
  334. package/docs/type-aliases/ModuleConfigSchema.md +0 -7
  335. package/docs/type-aliases/ModuleDescriptionPayload.md +0 -7
  336. package/docs/type-aliases/ModuleDescriptionSchema.md +0 -7
  337. package/docs/type-aliases/ModuleDetachedEventArgs.md +0 -13
  338. package/docs/type-aliases/ModuleError.md +0 -7
  339. package/docs/type-aliases/ModuleErrorEventArgs.md +0 -13
  340. package/docs/type-aliases/ModuleErrorSchema.md +0 -7
  341. package/docs/type-aliases/ModuleEventArgs.md +0 -17
  342. package/docs/type-aliases/ModuleFilter.md +0 -17
  343. package/docs/type-aliases/ModuleFilterPayload.md +0 -7
  344. package/docs/type-aliases/ModuleFilterPayloadSchema.md +0 -7
  345. package/docs/type-aliases/ModuleIdentifier.md +0 -7
  346. package/docs/type-aliases/ModuleIdentifierPart.md +0 -7
  347. package/docs/type-aliases/ModuleIdentifierTransformerFunc.md +0 -17
  348. package/docs/type-aliases/ModuleLimitationLabelName.md +0 -7
  349. package/docs/type-aliases/ModuleManifestPayload.md +0 -7
  350. package/docs/type-aliases/ModuleManifestPayloadSchema.md +0 -7
  351. package/docs/type-aliases/ModuleManifestQuery.md +0 -7
  352. package/docs/type-aliases/ModuleManifestQuerySchema.md +0 -7
  353. package/docs/type-aliases/ModuleName.md +0 -7
  354. package/docs/type-aliases/ModuleParams.md +0 -17
  355. package/docs/type-aliases/ModulePipeLine.md +0 -7
  356. package/docs/type-aliases/ModuleQueriedEventArgs.md +0 -13
  357. package/docs/type-aliases/ModuleQueries.md +0 -7
  358. package/docs/type-aliases/ModuleQueryHandlerResult.md +0 -7
  359. package/docs/type-aliases/ModuleQueryResult.md +0 -21
  360. package/docs/type-aliases/ModuleRegisteredEventArgs.md +0 -13
  361. package/docs/type-aliases/ModuleResolveDirection.md +0 -7
  362. package/docs/type-aliases/ModuleState.md +0 -13
  363. package/docs/type-aliases/ModuleStateQuery.md +0 -7
  364. package/docs/type-aliases/ModuleStateQuerySchema.md +0 -7
  365. package/docs/type-aliases/ModuleStateSchema.md +0 -7
  366. package/docs/type-aliases/ModuleStatus.md +0 -7
  367. package/docs/type-aliases/ModuleSubscribeQuery.md +0 -7
  368. package/docs/type-aliases/ModuleSubscribeQuerySchema.md +0 -7
  369. package/docs/type-aliases/ModuleTypeCheck.md +0 -13
  370. package/docs/type-aliases/ModuleUnregisteredEventArgs.md +0 -13
  371. package/docs/type-aliases/ModuleWrapperParams.md +0 -13
  372. package/docs/type-aliases/NameModuleFilter.md +0 -13
  373. package/docs/type-aliases/NodeAttachQuery.md +0 -7
  374. package/docs/type-aliases/NodeAttachQuerySchema.md +0 -7
  375. package/docs/type-aliases/NodeAttachedQuery.md +0 -7
  376. package/docs/type-aliases/NodeAttachedQuerySchema.md +0 -7
  377. package/docs/type-aliases/NodeCertifyQuery.md +0 -7
  378. package/docs/type-aliases/NodeCertifyQuerySchema.md +0 -7
  379. package/docs/type-aliases/NodeConfig.md +0 -17
  380. package/docs/type-aliases/NodeConfigSchema.md +0 -7
  381. package/docs/type-aliases/NodeDetachQuery.md +0 -7
  382. package/docs/type-aliases/NodeDetachQuerySchema.md +0 -7
  383. package/docs/type-aliases/NodeManifestPayloadSchema.md +0 -7
  384. package/docs/type-aliases/NodeModuleQueries.md +0 -7
  385. package/docs/type-aliases/NodeParams.md +0 -17
  386. package/docs/type-aliases/NodeQueries.md +0 -7
  387. package/docs/type-aliases/NodeRegisteredQuery.md +0 -7
  388. package/docs/type-aliases/NodeRegisteredQuerySchema.md +0 -7
  389. package/docs/type-aliases/Nonce.md +0 -7
  390. package/docs/type-aliases/ObjectCategory.md +0 -7
  391. package/docs/type-aliases/ObjectFilter.md +0 -13
  392. package/docs/type-aliases/ObjectResolverPriority.md +0 -7
  393. package/docs/type-aliases/ObserveEndEventArgs.md +0 -21
  394. package/docs/type-aliases/ObserveStartEventArgs.md +0 -17
  395. package/docs/type-aliases/OptionalConfigSchema.md +0 -19
  396. package/docs/type-aliases/OverridablePayload.md +0 -13
  397. package/docs/type-aliases/PackageManifestPayload.md +0 -7
  398. package/docs/type-aliases/PackageManifestPayloadSchema.md +0 -7
  399. package/docs/type-aliases/Payload.md +0 -19
  400. package/docs/type-aliases/PayloadLoader.md +0 -17
  401. package/docs/type-aliases/PayloadLoaderFactory.md +0 -11
  402. package/docs/type-aliases/PayloadProperty.md +0 -15
  403. package/docs/type-aliases/PayloadSchema.md +0 -7
  404. package/docs/type-aliases/PayloadSetPayload.md +0 -7
  405. package/docs/type-aliases/PayloadSetSchema.md +0 -7
  406. package/docs/type-aliases/PayloadValidationFunction.md +0 -15
  407. package/docs/type-aliases/PayloadValue.md +0 -19
  408. package/docs/type-aliases/PayloadValueExpression.md +0 -33
  409. package/docs/type-aliases/PayloadWithOptionalSources.md +0 -21
  410. package/docs/type-aliases/PayloadWithSources.md +0 -17
  411. package/docs/type-aliases/QualifiedSequence.md +0 -7
  412. package/docs/type-aliases/Query.md +0 -17
  413. package/docs/type-aliases/QueryBoundWitness.md +0 -7
  414. package/docs/type-aliases/QueryBoundWitnessFields.md +0 -23
  415. package/docs/type-aliases/QueryFulfillFinishedEventArgs.md +0 -13
  416. package/docs/type-aliases/QueryFulfillStartedEventArgs.md +0 -13
  417. package/docs/type-aliases/QueryModuleFilter.md +0 -13
  418. package/docs/type-aliases/QuerySendFinishedEventArgs.md +0 -13
  419. package/docs/type-aliases/QuerySendStartedEventArgs.md +0 -13
  420. package/docs/type-aliases/ReportEndEventArgs.md +0 -13
  421. package/docs/type-aliases/ReportStartEventArgs.md +0 -13
  422. package/docs/type-aliases/ReservedModuleIdentifierCharacter.md +0 -7
  423. package/docs/type-aliases/ResolvedArchivistTask.md +0 -7
  424. package/docs/type-aliases/ResolvedDivinerTask.md +0 -7
  425. package/docs/type-aliases/ResolvedModuleTask.md +0 -27
  426. package/docs/type-aliases/ResolvedTask.md +0 -7
  427. package/docs/type-aliases/ResolvedWitnessTask.md +0 -7
  428. package/docs/type-aliases/Schema.md +0 -9
  429. package/docs/type-aliases/SentinelAutomationPayload.md +0 -9
  430. package/docs/type-aliases/SentinelAutomationSchema.md +0 -7
  431. package/docs/type-aliases/SentinelBaseAutomationPayload.md +0 -13
  432. package/docs/type-aliases/SentinelConfig.md +0 -17
  433. package/docs/type-aliases/SentinelConfigSchema.md +0 -7
  434. package/docs/type-aliases/SentinelEventAutomationPayload.md +0 -9
  435. package/docs/type-aliases/SentinelEventAutomationSchema.md +0 -7
  436. package/docs/type-aliases/SentinelIntervalAutomationPayload.md +0 -9
  437. package/docs/type-aliases/SentinelIntervalAutomationSchema.md +0 -7
  438. package/docs/type-aliases/SentinelModuleQueries.md +0 -7
  439. package/docs/type-aliases/SentinelParams.md +0 -17
  440. package/docs/type-aliases/SentinelQueries.md +0 -7
  441. package/docs/type-aliases/SentinelReportQuery.md +0 -7
  442. package/docs/type-aliases/SentinelReportQuerySchema.md +0 -7
  443. package/docs/type-aliases/Sequence.md +0 -7
  444. package/docs/type-aliases/Signed.md +0 -19
  445. package/docs/type-aliases/SignedBoundWitness.md +0 -7
  446. package/docs/type-aliases/SignedHydratedBoundWitness.md +0 -17
  447. package/docs/type-aliases/SignedHydratedBoundWitnessWithStorageMeta.md +0 -17
  448. package/docs/type-aliases/SimpleModuleResolverParams.md +0 -13
  449. package/docs/type-aliases/SyncPayloadValidationFunction.md +0 -25
  450. package/docs/type-aliases/Task.md +0 -7
  451. package/docs/type-aliases/TaskEndEventArgs.md +0 -13
  452. package/docs/type-aliases/TaskStartEventArgs.md +0 -13
  453. package/docs/type-aliases/UnexposedEventArgs.md +0 -13
  454. package/docs/type-aliases/UnsignedBoundWitness.md +0 -13
  455. package/docs/type-aliases/UnsignedQueryBoundWitness.md +0 -7
  456. package/docs/type-aliases/Visibility.md +0 -7
  457. package/docs/type-aliases/WasmFeature.md +0 -7
  458. package/docs/type-aliases/WithAnySchema.md +0 -13
  459. package/docs/type-aliases/WithBlock.md +0 -7
  460. package/docs/type-aliases/WithDataHashStorageMeta.md +0 -13
  461. package/docs/type-aliases/WithHashStorageMeta.md +0 -13
  462. package/docs/type-aliases/WithOnlyClientMeta.md +0 -13
  463. package/docs/type-aliases/WithOptionalSchema.md +0 -13
  464. package/docs/type-aliases/WithOptionalSources.md +0 -17
  465. package/docs/type-aliases/WithPartialDataHashStorageMeta.md +0 -13
  466. package/docs/type-aliases/WithPartialHashStorageMeta.md +0 -13
  467. package/docs/type-aliases/WithPartialSequenceStorageMeta.md +0 -13
  468. package/docs/type-aliases/WithPartialStorageMeta.md +0 -13
  469. package/docs/type-aliases/WithPayload.md +0 -13
  470. package/docs/type-aliases/WithSchema.md +0 -15
  471. package/docs/type-aliases/WithSequenceStorageMeta.md +0 -13
  472. package/docs/type-aliases/WithSources.md +0 -13
  473. package/docs/type-aliases/WithStorageMeta.md +0 -13
  474. package/docs/type-aliases/WithTimestamp.md +0 -15
  475. package/docs/type-aliases/WithoutClientMeta.md +0 -13
  476. package/docs/type-aliases/WithoutMeta.md +0 -13
  477. package/docs/type-aliases/WithoutPrivateStorageMeta.md +0 -13
  478. package/docs/type-aliases/WithoutSchema.md +0 -13
  479. package/docs/type-aliases/WithoutStorageMeta.md +0 -13
  480. package/docs/type-aliases/WitnessConfig.md +0 -17
  481. package/docs/type-aliases/WitnessConfigSchema.md +0 -7
  482. package/docs/type-aliases/WitnessModuleEventData.md +0 -21
  483. package/docs/type-aliases/WitnessModuleQueries.md +0 -7
  484. package/docs/type-aliases/WitnessObserveQuery.md +0 -7
  485. package/docs/type-aliases/WitnessObserveQuerySchema.md +0 -7
  486. package/docs/type-aliases/WitnessParams.md +0 -17
  487. package/docs/type-aliases/WitnessQueries.md +0 -7
  488. package/docs/type-aliases/WitnessTask.md +0 -7
  489. package/docs/variables/AddressChildSchema.md +0 -7
  490. package/docs/variables/AddressPreviousHashSchema.md +0 -7
  491. package/docs/variables/AddressRegEx.md +0 -7
  492. package/docs/variables/AddressSchema.md +0 -7
  493. package/docs/variables/ArchivistAllQuerySchema.md +0 -7
  494. package/docs/variables/ArchivistClearQuerySchema.md +0 -7
  495. package/docs/variables/ArchivistCommitQuerySchema.md +0 -7
  496. package/docs/variables/ArchivistConfigSchema.md +0 -7
  497. package/docs/variables/ArchivistDeleteQuerySchema.md +0 -7
  498. package/docs/variables/ArchivistGetQuerySchema.md +0 -7
  499. package/docs/variables/ArchivistInsertQuerySchema.md +0 -7
  500. package/docs/variables/ArchivistNextQuerySchema.md +0 -7
  501. package/docs/variables/BoundWitnessJsonSchema-1.md +0 -107
  502. package/docs/variables/BoundWitnessSchema.md +0 -7
  503. package/docs/variables/BridgeConfigSchema.md +0 -7
  504. package/docs/variables/BridgeConnectQuerySchema.md +0 -7
  505. package/docs/variables/BridgeDisconnectQuerySchema.md +0 -7
  506. package/docs/variables/BridgeExposeQuerySchema.md +0 -7
  507. package/docs/variables/BridgeUnexposeQuerySchema.md +0 -7
  508. package/docs/variables/ChildCertificationSchema.md +0 -7
  509. package/docs/variables/DappPackageManifestPayloadSchema.md +0 -7
  510. package/docs/variables/DisallowedModuleIdentifierCharacters.md +0 -125
  511. package/docs/variables/DivinerConfigSchema.md +0 -7
  512. package/docs/variables/DivinerDivineQuerySchema.md +0 -7
  513. package/docs/variables/GeneratedBoundWitnessFields.md +0 -7
  514. package/docs/variables/HashRegEx.md +0 -7
  515. package/docs/variables/HexRegEx.md +0 -7
  516. package/docs/variables/HexRegExMinMax.md +0 -21
  517. package/docs/variables/IndexSeparator.md +0 -7
  518. package/docs/variables/LocalSequenceConstants.md +0 -65
  519. package/docs/variables/MODULE_PATH_SEPARATOR.md +0 -7
  520. package/docs/variables/ModuleAddressQuerySchema.md +0 -7
  521. package/docs/variables/ModuleConfigSchema.md +0 -7
  522. package/docs/variables/ModuleDescriptionSchema.md +0 -7
  523. package/docs/variables/ModuleErrorSchema.md +0 -7
  524. package/docs/variables/ModuleFilterPayloadSchema.md +0 -7
  525. package/docs/variables/ModuleLimitationLabelName.md +0 -7
  526. package/docs/variables/ModuleLimitationViewLabel.md +0 -13
  527. package/docs/variables/ModuleManifestPayloadSchema.md +0 -7
  528. package/docs/variables/ModuleManifestQuerySchema.md +0 -7
  529. package/docs/variables/ModuleStateQuerySchema.md +0 -7
  530. package/docs/variables/ModuleStateSchema.md +0 -7
  531. package/docs/variables/ModuleSubscribeQuerySchema.md +0 -7
  532. package/docs/variables/NodeAttachQuerySchema.md +0 -7
  533. package/docs/variables/NodeAttachedQuerySchema.md +0 -7
  534. package/docs/variables/NodeCertifyQuerySchema.md +0 -7
  535. package/docs/variables/NodeConfigSchema.md +0 -7
  536. package/docs/variables/NodeDetachQuerySchema.md +0 -7
  537. package/docs/variables/NodeManifestPayloadSchema.md +0 -7
  538. package/docs/variables/NodeRegisteredQuerySchema.md +0 -7
  539. package/docs/variables/ObjectResolverPriority.md +0 -33
  540. package/docs/variables/PackageManifestPayloadSchema.md +0 -7
  541. package/docs/variables/PayloadSchema.md +0 -7
  542. package/docs/variables/PayloadSetSchema.md +0 -7
  543. package/docs/variables/QualifiedSequenceConstants.md +0 -21
  544. package/docs/variables/ReservedModuleIdentifierCharacters.md +0 -7
  545. package/docs/variables/SchemaRegEx.md +0 -7
  546. package/docs/variables/SentinelAutomationSchema.md +0 -7
  547. package/docs/variables/SentinelConfigSchema.md +0 -7
  548. package/docs/variables/SentinelEventAutomationSchema.md +0 -7
  549. package/docs/variables/SentinelIntervalAutomationSchema.md +0 -7
  550. package/docs/variables/SentinelReportQuerySchema.md +0 -7
  551. package/docs/variables/SequenceComparer.md +0 -17
  552. package/docs/variables/SequenceComponentLengths.md +0 -29
  553. package/docs/variables/SequenceComponentMinMax.md +0 -33
  554. package/docs/variables/SequenceConstants.md +0 -77
  555. package/docs/variables/SequenceNonceComponentLengths.md +0 -17
  556. package/docs/variables/SignatureRegEx.md +0 -7
  557. package/docs/variables/Uint256RegEx.md +0 -7
  558. package/docs/variables/WasmFeatureDetectors.md +0 -435
  559. package/docs/variables/WithFactory.md +0 -49
  560. package/docs/variables/WitnessConfigSchema.md +0 -7
  561. package/docs/variables/WitnessObserveQuerySchema.md +0 -7
  562. package/docs/variables/addressesContains.md +0 -27
  563. package/docs/variables/addressesContainsAll.md +0 -29
  564. package/docs/variables/addressesContainsAny.md +0 -31
  565. package/docs/variables/asAddressPayload.md +0 -59
  566. package/docs/variables/asAnyPayload.md +0 -59
  567. package/docs/variables/asArchivistInstance.md +0 -59
  568. package/docs/variables/asArchivistModule.md +0 -59
  569. package/docs/variables/asAttachableArchivistInstance.md +0 -59
  570. package/docs/variables/asAttachableBridgeInstance.md +0 -59
  571. package/docs/variables/asAttachableDivinerInstance.md +0 -59
  572. package/docs/variables/asAttachableModuleInstance.md +0 -59
  573. package/docs/variables/asAttachableNodeInstance.md +0 -59
  574. package/docs/variables/asAttachableSentinelInstance.md +0 -59
  575. package/docs/variables/asAttachableWitnessInstance.md +0 -59
  576. package/docs/variables/asBlock.md +0 -17
  577. package/docs/variables/asBoundWitness.md +0 -23
  578. package/docs/variables/asBoundWitnessWithStorageMeta.md +0 -23
  579. package/docs/variables/asBridgeInstance.md +0 -59
  580. package/docs/variables/asBridgeModule.md +0 -59
  581. package/docs/variables/asDataHashStorageMeta.md +0 -59
  582. package/docs/variables/asDivinerInstance.md +0 -59
  583. package/docs/variables/asDivinerModule.md +0 -59
  584. package/docs/variables/asHashStorageMeta.md +0 -59
  585. package/docs/variables/asModule.md +0 -59
  586. package/docs/variables/asModuleInstance.md +0 -59
  587. package/docs/variables/asModuleObject.md +0 -59
  588. package/docs/variables/asModuleState.md +0 -59
  589. package/docs/variables/asNodeInstance.md +0 -59
  590. package/docs/variables/asNodeModule.md +0 -59
  591. package/docs/variables/asOptionalAddressPayload.md +0 -23
  592. package/docs/variables/asOptionalBoundWitness.md +0 -23
  593. package/docs/variables/asOptionalBoundWitnessWithStorageMeta.md +0 -23
  594. package/docs/variables/asOptionalDataHashStorageMeta.md +0 -23
  595. package/docs/variables/asOptionalHashStorageMeta.md +0 -23
  596. package/docs/variables/asOptionalSequenceStorageMeta.md +0 -23
  597. package/docs/variables/asOptionalStorageMeta.md +0 -23
  598. package/docs/variables/asPayload.md +0 -69
  599. package/docs/variables/asSchema.md +0 -59
  600. package/docs/variables/asSentinelInstance.md +0 -59
  601. package/docs/variables/asSentinelModule.md +0 -59
  602. package/docs/variables/asSequenceStorageMeta.md +0 -59
  603. package/docs/variables/asStorageMeta.md +0 -59
  604. package/docs/variables/asWitnessInstance.md +0 -59
  605. package/docs/variables/asWitnessModule.md +0 -59
  606. package/docs/variables/assignCreatableModuleRegistry.md +0 -25
  607. package/docs/variables/boundWitnessJsonSchema.md +0 -7
  608. package/docs/variables/boundWitnessProperties.md +0 -7
  609. package/docs/variables/buildStandardIndexName.md +0 -24
  610. package/docs/variables/combineWalletPaths.md +0 -21
  611. package/docs/variables/duplicateModules.md +0 -37
  612. package/docs/variables/formatWalletPath.md +0 -17
  613. package/docs/variables/getBoundWitness.md +0 -21
  614. package/docs/variables/getTypedBoundWitness.md +0 -31
  615. package/docs/variables/hasAllLabels.md +0 -29
  616. package/docs/variables/hasBlock.md +0 -17
  617. package/docs/variables/hasEmptyFields.md +0 -23
  618. package/docs/variables/hasLabels.md +0 -17
  619. package/docs/variables/hydrateBoundWitness.md +0 -21
  620. package/docs/variables/hydrateTypedBoundWitness.md +0 -31
  621. package/docs/variables/includesReservedModuleIdentifierCharacter.md +0 -17
  622. package/docs/variables/isAddressModuleFilter.md +0 -17
  623. package/docs/variables/isAddressObjectFilter.md +0 -23
  624. package/docs/variables/isAddressPayload.md +0 -19
  625. package/docs/variables/isAnyPayload.md +0 -17
  626. package/docs/variables/isArchivistInstance.md +0 -7
  627. package/docs/variables/isArchivistModule.md +0 -7
  628. package/docs/variables/isAttachableArchivistInstance.md +0 -7
  629. package/docs/variables/isAttachableBridgeInstance.md +0 -7
  630. package/docs/variables/isAttachableDivinerInstance.md +0 -7
  631. package/docs/variables/isAttachableModuleInstance.md +0 -7
  632. package/docs/variables/isAttachableNodeInstance.md +0 -7
  633. package/docs/variables/isAttachableSentinelInstance.md +0 -7
  634. package/docs/variables/isAttachableWitnessInstance.md +0 -7
  635. package/docs/variables/isBoundWitness.md +0 -17
  636. package/docs/variables/isBoundWitnessWithStorageMeta.md +0 -17
  637. package/docs/variables/isBoundWitnessWrapper.md +0 -27
  638. package/docs/variables/isBridgeInstance.md +0 -7
  639. package/docs/variables/isBridgeModule.md +0 -7
  640. package/docs/variables/isDataHashStorageMeta.md +0 -17
  641. package/docs/variables/isDivinerInstance.md +0 -7
  642. package/docs/variables/isDivinerModule.md +0 -7
  643. package/docs/variables/isEpoch.md +0 -17
  644. package/docs/variables/isHashStorageMeta.md +0 -17
  645. package/docs/variables/isLocalSequence.md +0 -17
  646. package/docs/variables/isModule.md +0 -7
  647. package/docs/variables/isModuleError.md +0 -17
  648. package/docs/variables/isModuleIdentifierPart.md +0 -17
  649. package/docs/variables/isModuleInstance.md +0 -7
  650. package/docs/variables/isModuleName.md +0 -17
  651. package/docs/variables/isModuleObject.md +0 -7
  652. package/docs/variables/isModuleResolver.md +0 -17
  653. package/docs/variables/isModuleState.md +0 -23
  654. package/docs/variables/isModuleStateWithSources.md +0 -23
  655. package/docs/variables/isNameModuleFilter.md +0 -17
  656. package/docs/variables/isNameObjectFilter.md +0 -23
  657. package/docs/variables/isNodeInstance.md +0 -7
  658. package/docs/variables/isNodeModule.md +0 -7
  659. package/docs/variables/isNonce.md +0 -17
  660. package/docs/variables/isObjectResolver.md +0 -23
  661. package/docs/variables/isPackageManifestPayload.md +0 -17
  662. package/docs/variables/isPayload.md +0 -33
  663. package/docs/variables/isPayloadOfSchemaTypeWithSources.md +0 -33
  664. package/docs/variables/isPayloadWrapper.md +0 -17
  665. package/docs/variables/isPayloadWrapperBase.md +0 -17
  666. package/docs/variables/isQualifiedSequence.md +0 -17
  667. package/docs/variables/isQueryBoundWitness.md +0 -17
  668. package/docs/variables/isQueryBoundWitnessWithStorageMeta.md +0 -17
  669. package/docs/variables/isQueryModuleFilter.md +0 -17
  670. package/docs/variables/isQueryObjectFilter.md +0 -23
  671. package/docs/variables/isSchema.md +0 -17
  672. package/docs/variables/isSentinelInstance.md +0 -7
  673. package/docs/variables/isSentinelIntervalAutomation.md +0 -17
  674. package/docs/variables/isSentinelModule.md +0 -7
  675. package/docs/variables/isSequence.md +0 -17
  676. package/docs/variables/isSequenceStorageMeta.md +0 -17
  677. package/docs/variables/isSerializable.md +0 -21
  678. package/docs/variables/isSigned.md +0 -17
  679. package/docs/variables/isStorageMeta.md +0 -17
  680. package/docs/variables/isUnsigned.md +0 -17
  681. package/docs/variables/isValidAbsoluteWalletPath.md +0 -17
  682. package/docs/variables/isValidRelativeWalletPath.md +0 -17
  683. package/docs/variables/isWitnessInstance.md +0 -7
  684. package/docs/variables/isWitnessModule.md +0 -7
  685. package/docs/variables/mixinResolverEventEmitter.md +0 -23
  686. package/docs/variables/notBoundWitness.md +0 -17
  687. package/docs/variables/notPayloadOfSchemaType.md +0 -33
  688. package/docs/variables/omitSchema.md +0 -23
  689. package/docs/variables/payloadHashesContains.md +0 -29
  690. package/docs/variables/payloadHashesContainsAll.md +0 -29
  691. package/docs/variables/payloadHashesContainsAny.md +0 -31
  692. package/docs/variables/payloadJsonSchema.md +0 -7
  693. package/docs/variables/payloadPropertiesJsonSchema.md +0 -7
  694. package/docs/variables/payloadSchemasContains.md +0 -29
  695. package/docs/variables/payloadSchemasContainsAll.md +0 -29
  696. package/docs/variables/payloadSchemasContainsAny.md +0 -31
  697. package/docs/variables/registerCreatableModuleFactories.md +0 -25
  698. package/docs/variables/registerCreatableModuleFactory.md +0 -35
  699. package/docs/variables/removeEmptyFields.md +0 -23
  700. package/docs/variables/requiredAttachableArchivistInstanceFunctions.md +0 -7
  701. package/docs/variables/requiredAttachableBridgeInstanceFunctions.md +0 -7
  702. package/docs/variables/requiredAttachableDivinerInstanceFunctions.md +0 -7
  703. package/docs/variables/requiredAttachableModuleInstanceFunctions.md +0 -7
  704. package/docs/variables/requiredAttachableNodeInstanceFunctions.md +0 -7
  705. package/docs/variables/requiredAttachableSentinelInstanceFunctions.md +0 -7
  706. package/docs/variables/requiredAttachableWitnessInstanceFunctions.md +0 -7
  707. package/docs/variables/requiredModuleInstanceFunctions.md +0 -7
  708. package/docs/variables/requiredModuleQueries.md +0 -7
  709. package/docs/variables/requiredModuleShape.md +0 -7
  710. package/docs/variables/resolveAddressToInstance.md +0 -33
  711. package/docs/variables/resolveAddressToInstanceAll.md +0 -29
  712. package/docs/variables/resolveAddressToInstanceDown.md +0 -29
  713. package/docs/variables/resolveAddressToInstanceSiblings.md +0 -29
  714. package/docs/variables/resolveAddressToInstanceUp.md +0 -29
  715. package/docs/variables/resolveAll.md +0 -25
  716. package/docs/variables/resolveAllDown.md +0 -29
  717. package/docs/variables/resolveAllUp.md +0 -25
  718. package/docs/variables/resolveLocalNameToAddress.md +0 -29
  719. package/docs/variables/resolveLocalNameToAddressAll.md +0 -25
  720. package/docs/variables/resolveLocalNameToAddressDown.md +0 -25
  721. package/docs/variables/resolveLocalNameToAddressUp.md +0 -21
  722. package/docs/variables/resolveLocalNameToInstance.md +0 -29
  723. package/docs/variables/resolveLocalNameToInstanceAll.md +0 -25
  724. package/docs/variables/resolveLocalNameToInstanceDown.md +0 -25
  725. package/docs/variables/resolveLocalNameToInstanceUp.md +0 -21
  726. package/docs/variables/resolvePathToAddress.md +0 -29
  727. package/docs/variables/resolvePathToInstance.md +0 -29
  728. package/docs/variables/sortFields.md +0 -23
  729. package/docs/variables/transformModuleIdentifier.md +0 -21
  730. package/docs/variables/tryGetTypedBoundWitness.md +0 -31
  731. package/docs/variables/tryHydrateTypedBoundWitness.md +0 -31
  732. package/docs/variables/withArchivistInstance.md +0 -27
  733. package/docs/variables/withArchivistModule.md +0 -27
  734. package/docs/variables/withBridgeInstance.md +0 -27
  735. package/docs/variables/withBridgeModule.md +0 -27
  736. package/docs/variables/withDivinerInstance.md +0 -27
  737. package/docs/variables/withDivinerModule.md +0 -27
  738. package/docs/variables/withModule.md +0 -27
  739. package/docs/variables/withModuleInstance.md +0 -27
  740. package/docs/variables/withNodeInstance.md +0 -27
  741. package/docs/variables/withNodeModule.md +0 -27
  742. package/docs/variables/withSentinelInstance.md +0 -27
  743. package/docs/variables/withSentinelModule.md +0 -27
  744. package/docs/variables/withWitnessInstance.md +0 -27
  745. package/docs/variables/withWitnessModule.md +0 -27
  746. package/eslint.config.mjs +0 -33
  747. package/knip.config.ts +0 -68
  748. package/scripts/README.template.md +0 -23
  749. package/scripts/clear-scrollback-buffer.sh +0 -3
  750. package/scripts/generate-typedoc.mjs +0 -168
  751. package/scripts/mongo/README.md +0 -33
  752. package/scripts/mongo/docker-entrypoint-initdb.d/00-create-key.sh +0 -5
  753. package/scripts/mongo/opt/mongo/joinReplicaSet.js +0 -13
  754. package/scripts/readme-gen.mjs +0 -50
  755. package/scripts/run-cycle.mjs +0 -71
  756. package/vitest.config.ts +0 -19
  757. package/vitest.workspace.ts +0 -5
  758. package/xy.config.ts +0 -10
@@ -1,1018 +0,0 @@
1
- [@xyo-network/sdk-js](../README.md) / AttachableModuleInstance
2
-
3
- # Interface: AttachableModuleInstance\<TParams, TEventData\>
4
-
5
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:7
6
-
7
- ## Extends
8
-
9
- - [`ModuleInstance`](ModuleInstance.md)\<`TParams`, `TEventData`\>
10
-
11
- ## Extended by
12
-
13
- - [`AttachableArchivistInstance`](AttachableArchivistInstance.md)
14
- - [`AttachableBridgeInstance`](AttachableBridgeInstance.md)
15
- - [`AttachableDivinerInstance`](AttachableDivinerInstance.md)
16
- - [`AttachableNodeInstance`](AttachableNodeInstance.md)
17
- - [`AttachableSentinelInstance`](AttachableSentinelInstance.md)
18
- - [`AttachableWitnessInstance`](AttachableWitnessInstance.md)
19
-
20
- ## Type Parameters
21
-
22
- ### TParams
23
-
24
- `TParams` *extends* [`ModuleParams`](../type-aliases/ModuleParams.md) = [`ModuleParams`](../type-aliases/ModuleParams.md)
25
-
26
- ### TEventData
27
-
28
- `TEventData` *extends* [`ModuleEventData`](ModuleEventData.md) = [`ModuleEventData`](ModuleEventData.md)
29
-
30
- ## Properties
31
-
32
- ### account?
33
-
34
- > `optional` **account**: `AccountInstance`
35
-
36
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:24
37
-
38
- #### Inherited from
39
-
40
- [`ModuleInstance`](ModuleInstance.md).[`account`](ModuleInstance.md#account)
41
-
42
- ***
43
-
44
- ### addParent()
45
-
46
- > **addParent**: (`mod`) => `void`
47
-
48
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:25
49
-
50
- #### Parameters
51
-
52
- ##### mod
53
-
54
- [`ModuleInstance`](ModuleInstance.md)
55
-
56
- #### Returns
57
-
58
- `void`
59
-
60
- #### Inherited from
61
-
62
- [`ModuleInstance`](ModuleInstance.md).[`addParent`](ModuleInstance.md#addparent)
63
-
64
- ***
65
-
66
- ### address
67
-
68
- > **address**: `Lowercase`\<`string`\>
69
-
70
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:10
71
-
72
- #### Inherited from
73
-
74
- [`ModuleInstance`](ModuleInstance.md).[`address`](ModuleInstance.md#address)
75
-
76
- ***
77
-
78
- ### addressCache()?
79
-
80
- > `optional` **addressCache**: (`direction`, `includePrivate`) => `undefined` \| [`AddressToWeakInstanceCache`](AddressToWeakInstanceCache.md)
81
-
82
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:26
83
-
84
- #### Parameters
85
-
86
- ##### direction
87
-
88
- [`Direction`](../type-aliases/Direction.md)
89
-
90
- ##### includePrivate
91
-
92
- `boolean`
93
-
94
- #### Returns
95
-
96
- `undefined` \| [`AddressToWeakInstanceCache`](AddressToWeakInstanceCache.md)
97
-
98
- #### Inherited from
99
-
100
- [`ModuleInstance`](ModuleInstance.md).[`addressCache`](ModuleInstance.md#addresscache)
101
-
102
- ***
103
-
104
- ### config
105
-
106
- > **config**: `TParams`\[`"config"`\]
107
-
108
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:11
109
-
110
- #### Inherited from
111
-
112
- [`ModuleInstance`](ModuleInstance.md).[`config`](ModuleInstance.md#config)
113
-
114
- ***
115
-
116
- ### downResolver
117
-
118
- > `readonly` **downResolver**: [`ModuleResolverInstance`](ModuleResolverInstance.md)
119
-
120
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:8
121
-
122
- ***
123
-
124
- ### eventData
125
-
126
- > **eventData**: `TEventData`
127
-
128
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:11
129
-
130
- #### Inherited from
131
-
132
- [`ModuleInstance`](ModuleInstance.md).[`eventData`](ModuleInstance.md#eventdata)
133
-
134
- ***
135
-
136
- ### id
137
-
138
- > **id**: `string`
139
-
140
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:13
141
-
142
- The name (if specified) or address of the module
143
-
144
- #### Inherited from
145
-
146
- [`ModuleInstance`](ModuleInstance.md).[`id`](ModuleInstance.md#id)
147
-
148
- ***
149
-
150
- ### manifest()
151
-
152
- > **manifest**: (`maxDepth?`, `ignoreAddresses?`) => `Promisable`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
153
-
154
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:9
155
-
156
- #### Parameters
157
-
158
- ##### maxDepth?
159
-
160
- `number`
161
-
162
- ##### ignoreAddresses?
163
-
164
- `Lowercase`\<`string`\>[]
165
-
166
- #### Returns
167
-
168
- `Promisable`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
169
-
170
- #### Inherited from
171
-
172
- [`ModuleInstance`](ModuleInstance.md).[`manifest`](ModuleInstance.md#manifest)
173
-
174
- ***
175
-
176
- ### manifestQuery()
177
-
178
- > **manifestQuery**: (`account`, `maxDepth?`, `ignoreAddresses?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
179
-
180
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:10
181
-
182
- #### Parameters
183
-
184
- ##### account
185
-
186
- `AccountInstance`
187
-
188
- ##### maxDepth?
189
-
190
- `number`
191
-
192
- ##### ignoreAddresses?
193
-
194
- `Lowercase`\<`string`\>[]
195
-
196
- #### Returns
197
-
198
- `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
199
-
200
- #### Inherited from
201
-
202
- [`ModuleInstance`](ModuleInstance.md).[`manifestQuery`](ModuleInstance.md#manifestquery)
203
-
204
- ***
205
-
206
- ### modName?
207
-
208
- > `optional` **modName**: `string`
209
-
210
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:14
211
-
212
- #### Inherited from
213
-
214
- [`ModuleInstance`](ModuleInstance.md).[`modName`](ModuleInstance.md#modname)
215
-
216
- ***
217
-
218
- ### moduleAddress()
219
-
220
- > **moduleAddress**: () => `Promisable`\<([`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md) \| [`AddressPayload`](../type-aliases/AddressPayload.md))[]\>
221
-
222
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:11
223
-
224
- #### Returns
225
-
226
- `Promisable`\<([`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md) \| [`AddressPayload`](../type-aliases/AddressPayload.md))[]\>
227
-
228
- #### Inherited from
229
-
230
- [`ModuleInstance`](ModuleInstance.md).[`moduleAddress`](ModuleInstance.md#moduleaddress)
231
-
232
- ***
233
-
234
- ### params
235
-
236
- > **params**: `TParams`
237
-
238
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:15
239
-
240
- #### Inherited from
241
-
242
- [`ModuleInstance`](ModuleInstance.md).[`params`](ModuleInstance.md#params)
243
-
244
- ***
245
-
246
- ### parents()
247
-
248
- > **parents**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
249
-
250
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:28
251
-
252
- #### Returns
253
-
254
- `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
255
-
256
- #### Inherited from
257
-
258
- [`ModuleInstance`](ModuleInstance.md).[`parents`](ModuleInstance.md#parents)
259
-
260
- ***
261
-
262
- ### pipeline?
263
-
264
- > `readonly` `optional` **pipeline**: `"one-to-one"` \| `"one-to-many"` \| `"many-to-one"` \| `"many-to-many"`
265
-
266
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:35
267
-
268
- #### Inherited from
269
-
270
- [`ModuleInstance`](ModuleInstance.md).[`pipeline`](ModuleInstance.md#pipeline)
271
-
272
- ***
273
-
274
- ### previousHash()
275
-
276
- > **previousHash**: () => `Promisable`\<`undefined` \| `string`\>
277
-
278
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:16
279
-
280
- #### Returns
281
-
282
- `Promisable`\<`undefined` \| `string`\>
283
-
284
- #### Inherited from
285
-
286
- [`ModuleInstance`](ModuleInstance.md).[`previousHash`](ModuleInstance.md#previoushash)
287
-
288
- ***
289
-
290
- ### priority
291
-
292
- > **priority**: [`ObjectResolverPriority`](../type-aliases/ObjectResolverPriority.md)
293
-
294
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:16
295
-
296
- #### Inherited from
297
-
298
- [`ModuleInstance`](ModuleInstance.md).[`priority`](ModuleInstance.md#priority)
299
-
300
- ***
301
-
302
- ### privateChildren()
303
-
304
- > **privateChildren**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
305
-
306
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:29
307
-
308
- #### Returns
309
-
310
- `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
311
-
312
- #### Inherited from
313
-
314
- [`ModuleInstance`](ModuleInstance.md).[`privateChildren`](ModuleInstance.md#privatechildren)
315
-
316
- ***
317
-
318
- ### privateResolver
319
-
320
- > `readonly` **privateResolver**: [`ModuleResolverInstance`](ModuleResolverInstance.md)
321
-
322
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:9
323
-
324
- ***
325
-
326
- ### publicChildren()
327
-
328
- > **publicChildren**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
329
-
330
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:30
331
-
332
- #### Returns
333
-
334
- `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
335
-
336
- #### Inherited from
337
-
338
- [`ModuleInstance`](ModuleInstance.md).[`publicChildren`](ModuleInstance.md#publicchildren)
339
-
340
- ***
341
-
342
- ### queries
343
-
344
- > **queries**: `string`[]
345
-
346
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:17
347
-
348
- #### Inherited from
349
-
350
- [`ModuleInstance`](ModuleInstance.md).[`queries`](ModuleInstance.md#queries)
351
-
352
- ***
353
-
354
- ### query()
355
-
356
- > **query**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
357
-
358
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:18
359
-
360
- #### Type Parameters
361
-
362
- ##### T
363
-
364
- `T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
365
-
366
- ##### TConf
367
-
368
- `TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
369
-
370
- #### Parameters
371
-
372
- ##### query
373
-
374
- `T`
375
-
376
- ##### payloads?
377
-
378
- [`Payload`](../type-aliases/Payload.md)[]
379
-
380
- ##### queryConfig?
381
-
382
- `TConf`
383
-
384
- #### Returns
385
-
386
- `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
387
-
388
- #### Inherited from
389
-
390
- [`ModuleInstance`](ModuleInstance.md).[`query`](ModuleInstance.md#query)
391
-
392
- ***
393
-
394
- ### queryable()
395
-
396
- > **queryable**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<`boolean`\>
397
-
398
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:19
399
-
400
- #### Type Parameters
401
-
402
- ##### T
403
-
404
- `T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
405
-
406
- ##### TConf
407
-
408
- `TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
409
-
410
- #### Parameters
411
-
412
- ##### query
413
-
414
- `T`
415
-
416
- ##### payloads?
417
-
418
- [`Payload`](../type-aliases/Payload.md)[]
419
-
420
- ##### queryConfig?
421
-
422
- `TConf`
423
-
424
- #### Returns
425
-
426
- `Promisable`\<`boolean`\>
427
-
428
- #### Inherited from
429
-
430
- [`ModuleInstance`](ModuleInstance.md).[`queryable`](ModuleInstance.md#queryable)
431
-
432
- ***
433
-
434
- ### removeParent()
435
-
436
- > **removeParent**: (`address`) => `void`
437
-
438
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:31
439
-
440
- #### Parameters
441
-
442
- ##### address
443
-
444
- `Lowercase`\<`string`\>
445
-
446
- #### Returns
447
-
448
- `void`
449
-
450
- #### Inherited from
451
-
452
- [`ModuleInstance`](ModuleInstance.md).[`removeParent`](ModuleInstance.md#removeparent)
453
-
454
- ***
455
-
456
- ### siblings()
457
-
458
- > **siblings**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
459
-
460
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:32
461
-
462
- #### Returns
463
-
464
- `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
465
-
466
- #### Inherited from
467
-
468
- [`ModuleInstance`](ModuleInstance.md).[`siblings`](ModuleInstance.md#siblings)
469
-
470
- ***
471
-
472
- ### start()?
473
-
474
- > `optional` **start**: () => `Promisable`\<`boolean`\>
475
-
476
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:20
477
-
478
- #### Returns
479
-
480
- `Promisable`\<`boolean`\>
481
-
482
- #### Inherited from
483
-
484
- [`ModuleInstance`](ModuleInstance.md).[`start`](ModuleInstance.md#start)
485
-
486
- ***
487
-
488
- ### state()
489
-
490
- > **state**: () => `Promisable`\<[`Payload`](../type-aliases/Payload.md)[]\>
491
-
492
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:12
493
-
494
- #### Returns
495
-
496
- `Promisable`\<[`Payload`](../type-aliases/Payload.md)[]\>
497
-
498
- #### Inherited from
499
-
500
- [`ModuleInstance`](ModuleInstance.md).[`state`](ModuleInstance.md#state)
501
-
502
- ***
503
-
504
- ### stateQuery()
505
-
506
- > **stateQuery**: (`account`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
507
-
508
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:13
509
-
510
- #### Parameters
511
-
512
- ##### account
513
-
514
- `AccountInstance`
515
-
516
- #### Returns
517
-
518
- `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
519
-
520
- #### Inherited from
521
-
522
- [`ModuleInstance`](ModuleInstance.md).[`stateQuery`](ModuleInstance.md#statequery)
523
-
524
- ***
525
-
526
- ### status
527
-
528
- > `readonly` **status**: [`ModuleStatus`](../type-aliases/ModuleStatus.md)
529
-
530
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:36
531
-
532
- #### Inherited from
533
-
534
- [`ModuleInstance`](ModuleInstance.md).[`status`](ModuleInstance.md#status)
535
-
536
- ***
537
-
538
- ### stop()?
539
-
540
- > `optional` **stop**: () => `Promisable`\<`boolean`\>
541
-
542
- Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:21
543
-
544
- #### Returns
545
-
546
- `Promisable`\<`boolean`\>
547
-
548
- #### Inherited from
549
-
550
- [`ModuleInstance`](ModuleInstance.md).[`stop`](ModuleInstance.md#stop)
551
-
552
- ***
553
-
554
- ### upResolver
555
-
556
- > `readonly` **upResolver**: [`ModuleResolverInstance`](ModuleResolverInstance.md)
557
-
558
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:10
559
-
560
- ## Methods
561
-
562
- ### clearListeners()
563
-
564
- > **clearListeners**(`eventNames`): `void`
565
-
566
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:12
567
-
568
- #### Parameters
569
-
570
- ##### eventNames
571
-
572
- keyof `TEventData` | keyof `TEventData`[]
573
-
574
- #### Returns
575
-
576
- `void`
577
-
578
- #### Inherited from
579
-
580
- [`ModuleInstance`](ModuleInstance.md).[`clearListeners`](ModuleInstance.md#clearlisteners)
581
-
582
- ***
583
-
584
- ### emit()
585
-
586
- > **emit**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
587
-
588
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:13
589
-
590
- #### Type Parameters
591
-
592
- ##### TEventName
593
-
594
- `TEventName` *extends* `string` \| `number` \| `symbol`
595
-
596
- #### Parameters
597
-
598
- ##### eventName
599
-
600
- `TEventName`
601
-
602
- ##### eventArgs
603
-
604
- `TEventData`\[`TEventName`\]
605
-
606
- #### Returns
607
-
608
- `Promise`\<`void`\>
609
-
610
- #### Inherited from
611
-
612
- [`ModuleInstance`](ModuleInstance.md).[`emit`](ModuleInstance.md#emit)
613
-
614
- ***
615
-
616
- ### emitSerial()
617
-
618
- > **emitSerial**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
619
-
620
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:14
621
-
622
- #### Type Parameters
623
-
624
- ##### TEventName
625
-
626
- `TEventName` *extends* `string` \| `number` \| `symbol`
627
-
628
- #### Parameters
629
-
630
- ##### eventName
631
-
632
- `TEventName`
633
-
634
- ##### eventArgs
635
-
636
- `TEventData`\[`TEventName`\]
637
-
638
- #### Returns
639
-
640
- `Promise`\<`void`\>
641
-
642
- #### Inherited from
643
-
644
- [`ModuleInstance`](ModuleInstance.md).[`emitSerial`](ModuleInstance.md#emitserial)
645
-
646
- ***
647
-
648
- ### listenerCount()
649
-
650
- > **listenerCount**(`eventNames`): `number`
651
-
652
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:15
653
-
654
- #### Parameters
655
-
656
- ##### eventNames
657
-
658
- keyof `TEventData` | keyof `TEventData`[]
659
-
660
- #### Returns
661
-
662
- `number`
663
-
664
- #### Inherited from
665
-
666
- [`ModuleInstance`](ModuleInstance.md).[`listenerCount`](ModuleInstance.md#listenercount)
667
-
668
- ***
669
-
670
- ### off()
671
-
672
- > **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
673
-
674
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:16
675
-
676
- #### Type Parameters
677
-
678
- ##### TEventName
679
-
680
- `TEventName` *extends* `string` \| `number` \| `symbol`
681
-
682
- #### Parameters
683
-
684
- ##### eventNames
685
-
686
- `TEventName` | `TEventName`[]
687
-
688
- ##### listener
689
-
690
- [`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
691
-
692
- #### Returns
693
-
694
- `void`
695
-
696
- #### Inherited from
697
-
698
- [`ModuleInstance`](ModuleInstance.md).[`off`](ModuleInstance.md#off)
699
-
700
- ***
701
-
702
- ### offAny()
703
-
704
- > **offAny**(`listener`): `void`
705
-
706
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:17
707
-
708
- #### Parameters
709
-
710
- ##### listener
711
-
712
- `Promise`\<`void`\> | [`EventAnyListener`](../type-aliases/EventAnyListener.md)\<[`EventArgs`](../type-aliases/EventArgs.md)\>
713
-
714
- #### Returns
715
-
716
- `void`
717
-
718
- #### Inherited from
719
-
720
- [`ModuleInstance`](ModuleInstance.md).[`offAny`](ModuleInstance.md#offany)
721
-
722
- ***
723
-
724
- ### on()
725
-
726
- > **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
727
-
728
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:18
729
-
730
- #### Type Parameters
731
-
732
- ##### TEventName
733
-
734
- `TEventName` *extends* `string` \| `number` \| `symbol`
735
-
736
- #### Parameters
737
-
738
- ##### eventNames
739
-
740
- `TEventName` | `TEventName`[]
741
-
742
- ##### listener
743
-
744
- [`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
745
-
746
- #### Returns
747
-
748
- [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
749
-
750
- #### Inherited from
751
-
752
- [`ModuleInstance`](ModuleInstance.md).[`on`](ModuleInstance.md#on)
753
-
754
- ***
755
-
756
- ### onAny()
757
-
758
- > **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
759
-
760
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:19
761
-
762
- #### Parameters
763
-
764
- ##### listener
765
-
766
- [`EventAnyListener`](../type-aliases/EventAnyListener.md)
767
-
768
- #### Returns
769
-
770
- [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
771
-
772
- #### Inherited from
773
-
774
- [`ModuleInstance`](ModuleInstance.md).[`onAny`](ModuleInstance.md#onany)
775
-
776
- ***
777
-
778
- ### once()
779
-
780
- > **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
781
-
782
- Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:20
783
-
784
- #### Type Parameters
785
-
786
- ##### TEventName
787
-
788
- `TEventName` *extends* `string` \| `number` \| `symbol`
789
-
790
- #### Parameters
791
-
792
- ##### eventName
793
-
794
- `TEventName`
795
-
796
- ##### listener
797
-
798
- [`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
799
-
800
- #### Returns
801
-
802
- [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
803
-
804
- #### Inherited from
805
-
806
- [`ModuleInstance`](ModuleInstance.md).[`once`](ModuleInstance.md#once)
807
-
808
- ***
809
-
810
- ### resolve()
811
-
812
- #### Call Signature
813
-
814
- > **resolve**\<`T`\>(): `Promisable`\<`undefined` \| `T`\>
815
-
816
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:18
817
-
818
- ##### Type Parameters
819
-
820
- ###### T
821
-
822
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
823
-
824
- ##### Returns
825
-
826
- `Promisable`\<`undefined` \| `T`\>
827
-
828
- ##### Deprecated
829
-
830
- do not pass undefined. If trying to get all, pass '*'
831
-
832
- ##### Inherited from
833
-
834
- [`ModuleInstance`](ModuleInstance.md).[`resolve`](ModuleInstance.md#resolve)
835
-
836
- #### Call Signature
837
-
838
- > **resolve**\<`T`\>(`all`, `options?`): `Promisable`\<`T`[]\>
839
-
840
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:19
841
-
842
- ##### Type Parameters
843
-
844
- ###### T
845
-
846
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
847
-
848
- ##### Parameters
849
-
850
- ###### all
851
-
852
- `"*"`
853
-
854
- ###### options?
855
-
856
- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
857
-
858
- ##### Returns
859
-
860
- `Promisable`\<`T`[]\>
861
-
862
- ##### Inherited from
863
-
864
- [`ModuleInstance`](ModuleInstance.md).[`resolve`](ModuleInstance.md#resolve)
865
-
866
- #### Call Signature
867
-
868
- > **resolve**\<`T`\>(`id`, `options?`): `Promisable`\<`undefined` \| `T`\>
869
-
870
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:20
871
-
872
- ##### Type Parameters
873
-
874
- ###### T
875
-
876
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
877
-
878
- ##### Parameters
879
-
880
- ###### id
881
-
882
- `string`
883
-
884
- ###### options?
885
-
886
- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
887
-
888
- ##### Returns
889
-
890
- `Promisable`\<`undefined` \| `T`\>
891
-
892
- ##### Inherited from
893
-
894
- [`ModuleInstance`](ModuleInstance.md).[`resolve`](ModuleInstance.md#resolve)
895
-
896
- #### Call Signature
897
-
898
- > **resolve**\<`T`\>(`id?`, `options?`): `Promisable`\<`undefined` \| `T` \| `T`[]\>
899
-
900
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:21
901
-
902
- ##### Type Parameters
903
-
904
- ###### T
905
-
906
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
907
-
908
- ##### Parameters
909
-
910
- ###### id?
911
-
912
- `string`
913
-
914
- ###### options?
915
-
916
- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
917
-
918
- ##### Returns
919
-
920
- `Promisable`\<`undefined` \| `T` \| `T`[]\>
921
-
922
- ##### Inherited from
923
-
924
- [`ModuleInstance`](ModuleInstance.md).[`resolve`](ModuleInstance.md#resolve)
925
-
926
- ***
927
-
928
- ### resolvePrivate()
929
-
930
- #### Call Signature
931
-
932
- > **resolvePrivate**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
933
-
934
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:22
935
-
936
- ##### Type Parameters
937
-
938
- ###### T
939
-
940
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
941
-
942
- ##### Parameters
943
-
944
- ###### all
945
-
946
- `"*"`
947
-
948
- ###### options?
949
-
950
- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
951
-
952
- ##### Returns
953
-
954
- `Promise`\<`T`[]\>
955
-
956
- ##### Inherited from
957
-
958
- [`ModuleInstance`](ModuleInstance.md).[`resolvePrivate`](ModuleInstance.md#resolveprivate)
959
-
960
- #### Call Signature
961
-
962
- > **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T`\>
963
-
964
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:23
965
-
966
- ##### Type Parameters
967
-
968
- ###### T
969
-
970
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
971
-
972
- ##### Parameters
973
-
974
- ###### id
975
-
976
- `string`
977
-
978
- ###### options?
979
-
980
- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
981
-
982
- ##### Returns
983
-
984
- `Promise`\<`undefined` \| `T`\>
985
-
986
- ##### Inherited from
987
-
988
- [`ModuleInstance`](ModuleInstance.md).[`resolvePrivate`](ModuleInstance.md#resolveprivate)
989
-
990
- #### Call Signature
991
-
992
- > **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T` \| `T`[]\>
993
-
994
- Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:24
995
-
996
- ##### Type Parameters
997
-
998
- ###### T
999
-
1000
- `T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
1001
-
1002
- ##### Parameters
1003
-
1004
- ###### id
1005
-
1006
- `string`
1007
-
1008
- ###### options?
1009
-
1010
- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
1011
-
1012
- ##### Returns
1013
-
1014
- `Promise`\<`undefined` \| `T` \| `T`[]\>
1015
-
1016
- ##### Inherited from
1017
-
1018
- [`ModuleInstance`](ModuleInstance.md).[`resolvePrivate`](ModuleInstance.md#resolveprivate)