@xyo-network/sdk-js 3.14.16 → 3.14.17

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 (738) hide show
  1. package/README.md +9 -84
  2. package/docs/README.md +748 -0
  3. package/docs/classes/AbstractData.md +127 -0
  4. package/docs/classes/AbstractModuleResolver.md +666 -0
  5. package/docs/classes/Account.md +431 -0
  6. package/docs/classes/AddressValue.md +251 -0
  7. package/docs/classes/ArchivistWrapper.md +2073 -0
  8. package/docs/classes/BaseEmitter.md +643 -0
  9. package/docs/classes/BoundWitnessBuilder.md +1387 -0
  10. package/docs/classes/BoundWitnessValidator.md +243 -0
  11. package/docs/classes/BoundWitnessWrapper.md +697 -0
  12. package/docs/classes/BridgeWrapper.md +1807 -0
  13. package/docs/classes/CompositeModuleResolver.md +824 -0
  14. package/docs/classes/Data.md +173 -0
  15. package/docs/classes/DeadModuleError.md +191 -0
  16. package/docs/classes/DivinerWrapper.md +1819 -0
  17. package/docs/classes/EllipticKey.md +180 -0
  18. package/docs/classes/Events.md +743 -0
  19. package/docs/classes/Huri.md +161 -0
  20. package/docs/classes/IsAttachableArchivistInstanceFactory.md +55 -0
  21. package/docs/classes/IsAttachableBridgeInstanceFactory.md +55 -0
  22. package/docs/classes/IsAttachableDivinerInstanceFactory.md +55 -0
  23. package/docs/classes/IsAttachableModuleInstanceFactory.md +55 -0
  24. package/docs/classes/IsAttachableNodeInstanceFactory.md +55 -0
  25. package/docs/classes/IsAttachableSentinelInstanceFactory.md +55 -0
  26. package/docs/classes/IsAttachableWitnessInstanceFactory.md +55 -0
  27. package/docs/classes/IsInstanceFactory.md +55 -0
  28. package/docs/classes/IsModuleFactory.md +43 -0
  29. package/docs/classes/ManifestWrapper.md +689 -0
  30. package/docs/classes/ManifestWrapperEx.md +743 -0
  31. package/docs/classes/ModuleDetailsError.md +179 -0
  32. package/docs/classes/ModuleFactory.md +243 -0
  33. package/docs/classes/ModuleWrapper.md +1559 -0
  34. package/docs/classes/NameRegistrarTransformer.md +53 -0
  35. package/docs/classes/NodeWrapper.md +1983 -0
  36. package/docs/classes/ObjectHasher.md +657 -0
  37. package/docs/classes/PayloadBuilder.md +967 -0
  38. package/docs/classes/PayloadHasher.md +657 -0
  39. package/docs/classes/PayloadValidator.md +121 -0
  40. package/docs/classes/PayloadWrapper.md +462 -0
  41. package/docs/classes/PayloadWrapperBase.md +225 -0
  42. package/docs/classes/PrivateKey.md +265 -0
  43. package/docs/classes/PublicKey.md +261 -0
  44. package/docs/classes/QueryBoundWitnessBuilder.md +1459 -0
  45. package/docs/classes/QueryBoundWitnessWrapper.md +861 -0
  46. package/docs/classes/ResolveHelper.md +217 -0
  47. package/docs/classes/SequenceParser.md +469 -0
  48. package/docs/classes/SimpleModuleResolver.md +779 -0
  49. package/docs/classes/WasmSupport.md +231 -0
  50. package/docs/classes/WitnessWrapper.md +1803 -0
  51. package/docs/functions/constructableModuleWrapper.md +33 -0
  52. package/docs/functions/creatableModule.md +39 -0
  53. package/docs/functions/creatableModuleFactory.md +39 -0
  54. package/docs/functions/isPayloadOfSchemaType.md +33 -0
  55. package/docs/functions/labeledCreatableModuleFactory.md +39 -0
  56. package/docs/interfaces/AddressChildFields.md +41 -0
  57. package/docs/interfaces/AddressFields.md +17 -0
  58. package/docs/interfaces/AddressObjectFilter.md +95 -0
  59. package/docs/interfaces/AddressToWeakInstanceCache.md +45 -0
  60. package/docs/interfaces/AllArchivist.md +35 -0
  61. package/docs/interfaces/AllArchivistFunctions.md +27 -0
  62. package/docs/interfaces/ArchivingModuleConfig.md +21 -0
  63. package/docs/interfaces/ArchivingReentrancyConfig.md +21 -0
  64. package/docs/interfaces/Archivist.md +163 -0
  65. package/docs/interfaces/ArchivistInstance.md +1299 -0
  66. package/docs/interfaces/ArchivistLabels.md +23 -0
  67. package/docs/interfaces/ArchivistModuleEventData.md +157 -0
  68. package/docs/interfaces/ArchivistModuleInstance.md +486 -0
  69. package/docs/interfaces/ArchivistNextOptions.md +57 -0
  70. package/docs/interfaces/ArchivistParamFields.md +13 -0
  71. package/docs/interfaces/ArchivistParentInstances.md +29 -0
  72. package/docs/interfaces/ArchivistParents.md +29 -0
  73. package/docs/interfaces/ArchivistRawQueryFunctions.md +151 -0
  74. package/docs/interfaces/ArchivistStorage.md +15 -0
  75. package/docs/interfaces/AttachableArchivistInstance.md +1331 -0
  76. package/docs/interfaces/AttachableBridgeInstance.md +1141 -0
  77. package/docs/interfaces/AttachableDivinerInstance.md +1085 -0
  78. package/docs/interfaces/AttachableModuleInstance.md +1018 -0
  79. package/docs/interfaces/AttachableNodeInstance.md +1309 -0
  80. package/docs/interfaces/AttachableSentinelInstance.md +1069 -0
  81. package/docs/interfaces/AttachableWitnessInstance.md +1077 -0
  82. package/docs/interfaces/BoundWitnessBlockField.md +17 -0
  83. package/docs/interfaces/BoundWitnessChainField.md +17 -0
  84. package/docs/interfaces/BoundWitnessFields.md +105 -0
  85. package/docs/interfaces/BoundWitnessMeta.md +29 -0
  86. package/docs/interfaces/BoundWitnessOptionalFields.md +49 -0
  87. package/docs/interfaces/BoundWitnessRequiredFields.md +45 -0
  88. package/docs/interfaces/BridgeExposeOptions.md +25 -0
  89. package/docs/interfaces/BridgeInstance.md +1105 -0
  90. package/docs/interfaces/BridgeModule.md +486 -0
  91. package/docs/interfaces/BridgeModuleEventData.md +269 -0
  92. package/docs/interfaces/BridgeParams.md +143 -0
  93. package/docs/interfaces/BridgeQueryFunctions.md +97 -0
  94. package/docs/interfaces/BridgeRawQueryFunctions.md +93 -0
  95. package/docs/interfaces/BridgeUnexposeOptions.md +33 -0
  96. package/docs/interfaces/CacheConfig.md +29 -0
  97. package/docs/interfaces/ChildCertificationFields.md +21 -0
  98. package/docs/interfaces/CompositeModuleResolverParams.md +69 -0
  99. package/docs/interfaces/ConfigManifest.md +61 -0
  100. package/docs/interfaces/CreatableModule.md +139 -0
  101. package/docs/interfaces/CreatableModuleRegistry.md +9 -0
  102. package/docs/interfaces/CustomSentinelInstance.md +1033 -0
  103. package/docs/interfaces/CustomSentinelModule.md +485 -0
  104. package/docs/interfaces/DataHashStorageMeta.md +17 -0
  105. package/docs/interfaces/DataInstance.md +37 -0
  106. package/docs/interfaces/DivineEndEventData.md +55 -0
  107. package/docs/interfaces/DivineStartEventData.md +43 -0
  108. package/docs/interfaces/DivinerInstance.md +1053 -0
  109. package/docs/interfaces/DivinerModule.md +485 -0
  110. package/docs/interfaces/DivinerQueryFunctions.md +67 -0
  111. package/docs/interfaces/EventFunctions.md +235 -0
  112. package/docs/interfaces/ExposedEventData.md +43 -0
  113. package/docs/interfaces/FetchedPayload.md +27 -0
  114. package/docs/interfaces/FullArchivist.md +147 -0
  115. package/docs/interfaces/HashStorageMeta.md +33 -0
  116. package/docs/interfaces/HuriOptions.md +21 -0
  117. package/docs/interfaces/JobEndEventData.md +47 -0
  118. package/docs/interfaces/JobStartEventData.md +43 -0
  119. package/docs/interfaces/Labels.md +15 -0
  120. package/docs/interfaces/Manifest.md +18 -0
  121. package/docs/interfaces/ManifestWrapperExParams.md +45 -0
  122. package/docs/interfaces/Module.md +492 -0
  123. package/docs/interfaces/ModuleAttachedEventData.md +29 -0
  124. package/docs/interfaces/ModuleBusyEventData.md +43 -0
  125. package/docs/interfaces/ModuleConfigFields.md +130 -0
  126. package/docs/interfaces/ModuleDescription.md +37 -0
  127. package/docs/interfaces/ModuleDetachedEventData.md +29 -0
  128. package/docs/interfaces/ModuleErrorEventData.md +43 -0
  129. package/docs/interfaces/ModuleEventData.md +106 -0
  130. package/docs/interfaces/ModuleFactoryLocatorInstance.md +159 -0
  131. package/docs/interfaces/ModuleFamilyFunctions.md +131 -0
  132. package/docs/interfaces/ModuleFields.md +173 -0
  133. package/docs/interfaces/ModuleFilterOptions.md +87 -0
  134. package/docs/interfaces/ModuleIdentifierTransformer.md +13 -0
  135. package/docs/interfaces/ModuleInstance.md +987 -0
  136. package/docs/interfaces/ModuleManifest.md +57 -0
  137. package/docs/interfaces/ModuleNameResolver.md +39 -0
  138. package/docs/interfaces/ModuleQueriedEventData.md +51 -0
  139. package/docs/interfaces/ModuleQueryFunctions.md +99 -0
  140. package/docs/interfaces/ModuleRegisteredEventData.md +29 -0
  141. package/docs/interfaces/ModuleRepository.md +391 -0
  142. package/docs/interfaces/ModuleResolvedEventArgs.md +21 -0
  143. package/docs/interfaces/ModuleResolver.md +243 -0
  144. package/docs/interfaces/ModuleResolverInstance.md +317 -0
  145. package/docs/interfaces/ModuleResolverParams.md +41 -0
  146. package/docs/interfaces/ModuleSecurityConfig.md +41 -0
  147. package/docs/interfaces/ModuleSubscribeFilter.md +17 -0
  148. package/docs/interfaces/ModuleTask.md +55 -0
  149. package/docs/interfaces/ModuleUnregisteredEventData.md +29 -0
  150. package/docs/interfaces/NameObjectFilter.md +95 -0
  151. package/docs/interfaces/NextOptions.md +47 -0
  152. package/docs/interfaces/NodeInstance.md +1277 -0
  153. package/docs/interfaces/NodeManifest.md +85 -0
  154. package/docs/interfaces/NodeManifestPayload.md +93 -0
  155. package/docs/interfaces/NodeModule.md +486 -0
  156. package/docs/interfaces/NodeModuleEventData.md +157 -0
  157. package/docs/interfaces/NodeQueryFunctions.md +197 -0
  158. package/docs/interfaces/NodeRegistrationFunctions.md +57 -0
  159. package/docs/interfaces/ObjectFilterOptions.md +86 -0
  160. package/docs/interfaces/ObjectResolver.md +209 -0
  161. package/docs/interfaces/ObjectResolverInstance.md +275 -0
  162. package/docs/interfaces/ObserveEndEventData.md +55 -0
  163. package/docs/interfaces/ObserveStartEventData.md +43 -0
  164. package/docs/interfaces/PackageManifest.md +37 -0
  165. package/docs/interfaces/PayloadBuilderOptions.md +21 -0
  166. package/docs/interfaces/PayloadFields.md +23 -0
  167. package/docs/interfaces/PayloadFindFilter.md +29 -0
  168. package/docs/interfaces/PayloadMetaFields.md +21 -0
  169. package/docs/interfaces/PayloadSet.md +21 -0
  170. package/docs/interfaces/QueryFields.md +53 -0
  171. package/docs/interfaces/QueryFulfillFinishedEventData.md +55 -0
  172. package/docs/interfaces/QueryFulfillStartedEventData.md +47 -0
  173. package/docs/interfaces/QueryObjectFilter.md +95 -0
  174. package/docs/interfaces/QuerySendFinishedEventData.md +55 -0
  175. package/docs/interfaces/QuerySendStartedEventData.md +47 -0
  176. package/docs/interfaces/ReadArchivist.md +68 -0
  177. package/docs/interfaces/ReadArchivistFunctions.md +55 -0
  178. package/docs/interfaces/ReadWriteArchivist.md +135 -0
  179. package/docs/interfaces/ReportEndEventData.md +51 -0
  180. package/docs/interfaces/ReportStartEventData.md +43 -0
  181. package/docs/interfaces/ResolveHelperConfig.md +69 -0
  182. package/docs/interfaces/ResolveStrategy.md +41 -0
  183. package/docs/interfaces/ResolverEventEmitter.md +27 -0
  184. package/docs/interfaces/SchemaField.md +23 -0
  185. package/docs/interfaces/SchemaFields.md +21 -0
  186. package/docs/interfaces/SearchableStorage.md +37 -0
  187. package/docs/interfaces/Sentinel.md +60 -0
  188. package/docs/interfaces/SentinelInstance.md +1038 -0
  189. package/docs/interfaces/SentinelJob.md +13 -0
  190. package/docs/interfaces/SentinelModule.md +486 -0
  191. package/docs/interfaces/SentinelModuleEventData.md +275 -0
  192. package/docs/interfaces/SequenceStorageMeta.md +17 -0
  193. package/docs/interfaces/SourcesMetaField.md +17 -0
  194. package/docs/interfaces/StashArchivist.md +35 -0
  195. package/docs/interfaces/StashArchivistFunctions.md +28 -0
  196. package/docs/interfaces/State.md +19 -0
  197. package/docs/interfaces/StateDictionary.md +9 -0
  198. package/docs/interfaces/StorageMeta.md +45 -0
  199. package/docs/interfaces/TaskEndEventData.md +55 -0
  200. package/docs/interfaces/TaskStartEventData.md +51 -0
  201. package/docs/interfaces/Timestamp.md +15 -0
  202. package/docs/interfaces/UnexposedEventData.md +43 -0
  203. package/docs/interfaces/WithLabels.md +21 -0
  204. package/docs/interfaces/WithOptionalLabels.md +21 -0
  205. package/docs/interfaces/WitnessInstance.md +1045 -0
  206. package/docs/interfaces/WitnessModule.md +485 -0
  207. package/docs/interfaces/WitnessQueryFunctions.md +59 -0
  208. package/docs/interfaces/WriteArchivist.md +92 -0
  209. package/docs/interfaces/WriteArchivistFunctions.md +75 -0
  210. package/docs/type-aliases/AddressChildPayload.md +7 -0
  211. package/docs/type-aliases/AddressChildSchema.md +7 -0
  212. package/docs/type-aliases/AddressModuleFilter.md +13 -0
  213. package/docs/type-aliases/AddressPayload.md +7 -0
  214. package/docs/type-aliases/AddressPreviousHashPayload.md +7 -0
  215. package/docs/type-aliases/AddressPreviousHashSchema.md +7 -0
  216. package/docs/type-aliases/AddressSchema.md +7 -0
  217. package/docs/type-aliases/AllValidator.md +19 -0
  218. package/docs/type-aliases/AllValidatorFactory.md +17 -0
  219. package/docs/type-aliases/AnyBoundWitness.md +7 -0
  220. package/docs/type-aliases/AnyConfigSchema.md +13 -0
  221. package/docs/type-aliases/AnyModuleConfig.md +7 -0
  222. package/docs/type-aliases/AnyModuleFilter.md +13 -0
  223. package/docs/type-aliases/AnyObjectFilter.md +13 -0
  224. package/docs/type-aliases/AnyPayload.md +7 -0
  225. package/docs/type-aliases/ArchivistAllQuery.md +7 -0
  226. package/docs/type-aliases/ArchivistAllQuerySchema.md +7 -0
  227. package/docs/type-aliases/ArchivistClearQuery.md +7 -0
  228. package/docs/type-aliases/ArchivistClearQuerySchema.md +7 -0
  229. package/docs/type-aliases/ArchivistCommitQuery.md +7 -0
  230. package/docs/type-aliases/ArchivistCommitQuerySchema.md +7 -0
  231. package/docs/type-aliases/ArchivistConfig.md +17 -0
  232. package/docs/type-aliases/ArchivistConfigSchema.md +7 -0
  233. package/docs/type-aliases/ArchivistDeleteQuery.md +7 -0
  234. package/docs/type-aliases/ArchivistDeleteQuerySchema.md +7 -0
  235. package/docs/type-aliases/ArchivistGetQuery.md +7 -0
  236. package/docs/type-aliases/ArchivistGetQuerySchema.md +7 -0
  237. package/docs/type-aliases/ArchivistInsertQuery.md +7 -0
  238. package/docs/type-aliases/ArchivistInsertQuerySchema.md +7 -0
  239. package/docs/type-aliases/ArchivistModuleQueries.md +7 -0
  240. package/docs/type-aliases/ArchivistNextQuery.md +7 -0
  241. package/docs/type-aliases/ArchivistNextQuerySchema.md +7 -0
  242. package/docs/type-aliases/ArchivistParams.md +17 -0
  243. package/docs/type-aliases/ArchivistQueries.md +7 -0
  244. package/docs/type-aliases/ArchivistTask.md +7 -0
  245. package/docs/type-aliases/AsyncPayloadValidationFunction.md +25 -0
  246. package/docs/type-aliases/AttachableArchivistInstanceTypeCheck.md +13 -0
  247. package/docs/type-aliases/AttachableBridgeInstanceTypeCheck.md +13 -0
  248. package/docs/type-aliases/AttachableDivinerInstanceTypeCheck.md +13 -0
  249. package/docs/type-aliases/AttachableModuleInstanceTypeCheck.md +13 -0
  250. package/docs/type-aliases/AttachableNodeInstanceTypeCheck.md +13 -0
  251. package/docs/type-aliases/AttachableSentinelInstanceTypeCheck.md +13 -0
  252. package/docs/type-aliases/AttachableWitnessInstanceTypeCheck.md +13 -0
  253. package/docs/type-aliases/BoundWitness.md +13 -0
  254. package/docs/type-aliases/BoundWitnessSchema.md +7 -0
  255. package/docs/type-aliases/BridgeClientConfig.md +31 -0
  256. package/docs/type-aliases/BridgeConfig.md +25 -0
  257. package/docs/type-aliases/BridgeConfigSchema.md +7 -0
  258. package/docs/type-aliases/BridgeConnectQuery.md +7 -0
  259. package/docs/type-aliases/BridgeConnectQuerySchema.md +7 -0
  260. package/docs/type-aliases/BridgeDisconnectQuery.md +7 -0
  261. package/docs/type-aliases/BridgeDisconnectQuerySchema.md +7 -0
  262. package/docs/type-aliases/BridgeExposeQuery.md +7 -0
  263. package/docs/type-aliases/BridgeExposeQuerySchema.md +7 -0
  264. package/docs/type-aliases/BridgeHostConfig.md +23 -0
  265. package/docs/type-aliases/BridgeModuleQueries.md +7 -0
  266. package/docs/type-aliases/BridgeQueries.md +7 -0
  267. package/docs/type-aliases/BridgeUnexposeQuery.md +7 -0
  268. package/docs/type-aliases/BridgeUnexposeQuerySchema.md +7 -0
  269. package/docs/type-aliases/ChildCertification.md +7 -0
  270. package/docs/type-aliases/ChildCertificationSchema.md +7 -0
  271. package/docs/type-aliases/ColonPair.md +13 -0
  272. package/docs/type-aliases/ConstructableModuleWrapper.md +177 -0
  273. package/docs/type-aliases/CosigningAddressSet.md +7 -0
  274. package/docs/type-aliases/CreatableModuleFactory.md +39 -0
  275. package/docs/type-aliases/CustomWitnessInstance.md +25 -0
  276. package/docs/type-aliases/CustomWitnessModule.md +25 -0
  277. package/docs/type-aliases/DappPackageManifestPayloadSchema.md +7 -0
  278. package/docs/type-aliases/DebugLogger.md +36 -0
  279. package/docs/type-aliases/DebugOptions.md +33 -0
  280. package/docs/type-aliases/Direction.md +7 -0
  281. package/docs/type-aliases/DivineEndEventArgs.md +21 -0
  282. package/docs/type-aliases/DivineStartEventArgs.md +17 -0
  283. package/docs/type-aliases/DivinedPayload.md +17 -0
  284. package/docs/type-aliases/DivinerConfig.md +17 -0
  285. package/docs/type-aliases/DivinerConfigSchema.md +7 -0
  286. package/docs/type-aliases/DivinerDivineQuery.md +7 -0
  287. package/docs/type-aliases/DivinerDivineQuerySchema.md +7 -0
  288. package/docs/type-aliases/DivinerDivineResult.md +13 -0
  289. package/docs/type-aliases/DivinerModuleEventData.md +21 -0
  290. package/docs/type-aliases/DivinerModuleQueries.md +7 -0
  291. package/docs/type-aliases/DivinerParams.md +17 -0
  292. package/docs/type-aliases/DivinerQueries.md +7 -0
  293. package/docs/type-aliases/DivinerTask.md +7 -0
  294. package/docs/type-aliases/Epoch.md +7 -0
  295. package/docs/type-aliases/EventAnyListener.md +27 -0
  296. package/docs/type-aliases/EventArgs.md +7 -0
  297. package/docs/type-aliases/EventData.md +11 -0
  298. package/docs/type-aliases/EventListener.md +23 -0
  299. package/docs/type-aliases/EventListenerInfo.md +29 -0
  300. package/docs/type-aliases/EventName.md +7 -0
  301. package/docs/type-aliases/EventUnsubscribeFunction.md +11 -0
  302. package/docs/type-aliases/EventsParams.md +7 -0
  303. package/docs/type-aliases/ExposedEventArgs.md +13 -0
  304. package/docs/type-aliases/GeneratedBoundWitnessFields.md +7 -0
  305. package/docs/type-aliases/HuriFetchFunction.md +17 -0
  306. package/docs/type-aliases/HydratedBoundWitness.md +17 -0
  307. package/docs/type-aliases/HydratedBoundWitnessWithStorageMeta.md +17 -0
  308. package/docs/type-aliases/IdentityFunction.md +23 -0
  309. package/docs/type-aliases/IndexDescription.md +49 -0
  310. package/docs/type-aliases/IndexDirection.md +9 -0
  311. package/docs/type-aliases/InstanceTypeCheck.md +13 -0
  312. package/docs/type-aliases/JobEndEventArgs.md +13 -0
  313. package/docs/type-aliases/JobStartEventArgs.md +13 -0
  314. package/docs/type-aliases/LabeledCreatableModuleFactory.md +13 -0
  315. package/docs/type-aliases/LocalSequence.md +7 -0
  316. package/docs/type-aliases/MetaEventData.md +45 -0
  317. package/docs/type-aliases/ModuleAddressQuery.md +7 -0
  318. package/docs/type-aliases/ModuleAddressQuerySchema.md +7 -0
  319. package/docs/type-aliases/ModuleAlias.md +7 -0
  320. package/docs/type-aliases/ModuleAttachedEventArgs.md +13 -0
  321. package/docs/type-aliases/ModuleBusyEventArgs.md +13 -0
  322. package/docs/type-aliases/ModuleConfig.md +17 -0
  323. package/docs/type-aliases/ModuleConfigSchema.md +7 -0
  324. package/docs/type-aliases/ModuleDescriptionPayload.md +7 -0
  325. package/docs/type-aliases/ModuleDescriptionSchema.md +7 -0
  326. package/docs/type-aliases/ModuleDetachedEventArgs.md +13 -0
  327. package/docs/type-aliases/ModuleError.md +7 -0
  328. package/docs/type-aliases/ModuleErrorEventArgs.md +13 -0
  329. package/docs/type-aliases/ModuleErrorSchema.md +7 -0
  330. package/docs/type-aliases/ModuleEventArgs.md +17 -0
  331. package/docs/type-aliases/ModuleFilter.md +17 -0
  332. package/docs/type-aliases/ModuleFilterPayload.md +7 -0
  333. package/docs/type-aliases/ModuleFilterPayloadSchema.md +7 -0
  334. package/docs/type-aliases/ModuleIdentifier.md +7 -0
  335. package/docs/type-aliases/ModuleIdentifierPart.md +7 -0
  336. package/docs/type-aliases/ModuleIdentifierTransformerFunc.md +17 -0
  337. package/docs/type-aliases/ModuleLimitationLabelName.md +7 -0
  338. package/docs/type-aliases/ModuleManifestPayload.md +7 -0
  339. package/docs/type-aliases/ModuleManifestPayloadSchema.md +7 -0
  340. package/docs/type-aliases/ModuleManifestQuery.md +7 -0
  341. package/docs/type-aliases/ModuleManifestQuerySchema.md +7 -0
  342. package/docs/type-aliases/ModuleName.md +7 -0
  343. package/docs/type-aliases/ModuleParams.md +17 -0
  344. package/docs/type-aliases/ModulePipeLine.md +7 -0
  345. package/docs/type-aliases/ModuleQueriedEventArgs.md +13 -0
  346. package/docs/type-aliases/ModuleQueries.md +7 -0
  347. package/docs/type-aliases/ModuleQueryHandlerResult.md +7 -0
  348. package/docs/type-aliases/ModuleQueryResult.md +21 -0
  349. package/docs/type-aliases/ModuleRegisteredEventArgs.md +13 -0
  350. package/docs/type-aliases/ModuleResolveDirection.md +7 -0
  351. package/docs/type-aliases/ModuleState.md +13 -0
  352. package/docs/type-aliases/ModuleStateQuery.md +7 -0
  353. package/docs/type-aliases/ModuleStateQuerySchema.md +7 -0
  354. package/docs/type-aliases/ModuleStateSchema.md +7 -0
  355. package/docs/type-aliases/ModuleStatus.md +7 -0
  356. package/docs/type-aliases/ModuleSubscribeQuery.md +7 -0
  357. package/docs/type-aliases/ModuleSubscribeQuerySchema.md +7 -0
  358. package/docs/type-aliases/ModuleTypeCheck.md +13 -0
  359. package/docs/type-aliases/ModuleUnregisteredEventArgs.md +13 -0
  360. package/docs/type-aliases/ModuleWrapperParams.md +13 -0
  361. package/docs/type-aliases/NameModuleFilter.md +13 -0
  362. package/docs/type-aliases/NodeAttachQuery.md +7 -0
  363. package/docs/type-aliases/NodeAttachQuerySchema.md +7 -0
  364. package/docs/type-aliases/NodeAttachedQuery.md +7 -0
  365. package/docs/type-aliases/NodeAttachedQuerySchema.md +7 -0
  366. package/docs/type-aliases/NodeCertifyQuery.md +7 -0
  367. package/docs/type-aliases/NodeCertifyQuerySchema.md +7 -0
  368. package/docs/type-aliases/NodeConfig.md +17 -0
  369. package/docs/type-aliases/NodeConfigSchema.md +7 -0
  370. package/docs/type-aliases/NodeDetachQuery.md +7 -0
  371. package/docs/type-aliases/NodeDetachQuerySchema.md +7 -0
  372. package/docs/type-aliases/NodeManifestPayloadSchema.md +7 -0
  373. package/docs/type-aliases/NodeModuleQueries.md +7 -0
  374. package/docs/type-aliases/NodeParams.md +17 -0
  375. package/docs/type-aliases/NodeQueries.md +7 -0
  376. package/docs/type-aliases/NodeRegisteredQuery.md +7 -0
  377. package/docs/type-aliases/NodeRegisteredQuerySchema.md +7 -0
  378. package/docs/type-aliases/Nonce.md +7 -0
  379. package/docs/type-aliases/ObjectCategory.md +7 -0
  380. package/docs/type-aliases/ObjectFilter.md +13 -0
  381. package/docs/type-aliases/ObjectResolverPriority.md +7 -0
  382. package/docs/type-aliases/ObserveEndEventArgs.md +21 -0
  383. package/docs/type-aliases/ObserveStartEventArgs.md +17 -0
  384. package/docs/type-aliases/OptionalConfigSchema.md +19 -0
  385. package/docs/type-aliases/OverridablePayload.md +13 -0
  386. package/docs/type-aliases/PackageManifestPayload.md +7 -0
  387. package/docs/type-aliases/PackageManifestPayloadSchema.md +7 -0
  388. package/docs/type-aliases/Payload.md +19 -0
  389. package/docs/type-aliases/PayloadLoader.md +17 -0
  390. package/docs/type-aliases/PayloadLoaderFactory.md +11 -0
  391. package/docs/type-aliases/PayloadProperty.md +15 -0
  392. package/docs/type-aliases/PayloadSchema.md +7 -0
  393. package/docs/type-aliases/PayloadSetPayload.md +7 -0
  394. package/docs/type-aliases/PayloadSetSchema.md +7 -0
  395. package/docs/type-aliases/PayloadValidationFunction.md +15 -0
  396. package/docs/type-aliases/PayloadValue.md +19 -0
  397. package/docs/type-aliases/PayloadValueExpression.md +33 -0
  398. package/docs/type-aliases/PayloadWithOptionalSources.md +21 -0
  399. package/docs/type-aliases/PayloadWithSources.md +17 -0
  400. package/docs/type-aliases/QualifiedSequence.md +7 -0
  401. package/docs/type-aliases/Query.md +17 -0
  402. package/docs/type-aliases/QueryBoundWitness.md +7 -0
  403. package/docs/type-aliases/QueryBoundWitnessFields.md +23 -0
  404. package/docs/type-aliases/QueryFulfillFinishedEventArgs.md +13 -0
  405. package/docs/type-aliases/QueryFulfillStartedEventArgs.md +13 -0
  406. package/docs/type-aliases/QueryModuleFilter.md +13 -0
  407. package/docs/type-aliases/QuerySendFinishedEventArgs.md +13 -0
  408. package/docs/type-aliases/QuerySendStartedEventArgs.md +13 -0
  409. package/docs/type-aliases/ReportEndEventArgs.md +13 -0
  410. package/docs/type-aliases/ReportStartEventArgs.md +13 -0
  411. package/docs/type-aliases/ReservedModuleIdentifierCharacter.md +7 -0
  412. package/docs/type-aliases/ResolvedArchivistTask.md +7 -0
  413. package/docs/type-aliases/ResolvedDivinerTask.md +7 -0
  414. package/docs/type-aliases/ResolvedModuleTask.md +27 -0
  415. package/docs/type-aliases/ResolvedTask.md +7 -0
  416. package/docs/type-aliases/ResolvedWitnessTask.md +7 -0
  417. package/docs/type-aliases/Schema.md +9 -0
  418. package/docs/type-aliases/SentinelAutomationPayload.md +9 -0
  419. package/docs/type-aliases/SentinelAutomationSchema.md +7 -0
  420. package/docs/type-aliases/SentinelBaseAutomationPayload.md +13 -0
  421. package/docs/type-aliases/SentinelConfig.md +17 -0
  422. package/docs/type-aliases/SentinelConfigSchema.md +7 -0
  423. package/docs/type-aliases/SentinelEventAutomationPayload.md +9 -0
  424. package/docs/type-aliases/SentinelEventAutomationSchema.md +7 -0
  425. package/docs/type-aliases/SentinelIntervalAutomationPayload.md +9 -0
  426. package/docs/type-aliases/SentinelIntervalAutomationSchema.md +7 -0
  427. package/docs/type-aliases/SentinelModuleQueries.md +7 -0
  428. package/docs/type-aliases/SentinelParams.md +17 -0
  429. package/docs/type-aliases/SentinelQueries.md +7 -0
  430. package/docs/type-aliases/SentinelReportQuery.md +7 -0
  431. package/docs/type-aliases/SentinelReportQuerySchema.md +7 -0
  432. package/docs/type-aliases/Sequence.md +7 -0
  433. package/docs/type-aliases/Signed.md +19 -0
  434. package/docs/type-aliases/SignedBoundWitness.md +7 -0
  435. package/docs/type-aliases/SignedHydratedBoundWitness.md +17 -0
  436. package/docs/type-aliases/SignedHydratedBoundWitnessWithStorageMeta.md +17 -0
  437. package/docs/type-aliases/SimpleModuleResolverParams.md +13 -0
  438. package/docs/type-aliases/SyncPayloadValidationFunction.md +25 -0
  439. package/docs/type-aliases/Task.md +7 -0
  440. package/docs/type-aliases/TaskEndEventArgs.md +13 -0
  441. package/docs/type-aliases/TaskStartEventArgs.md +13 -0
  442. package/docs/type-aliases/UnexposedEventArgs.md +13 -0
  443. package/docs/type-aliases/UnsignedBoundWitness.md +13 -0
  444. package/docs/type-aliases/UnsignedQueryBoundWitness.md +7 -0
  445. package/docs/type-aliases/Visibility.md +7 -0
  446. package/docs/type-aliases/WasmFeature.md +7 -0
  447. package/docs/type-aliases/WithAnySchema.md +13 -0
  448. package/docs/type-aliases/WithBlock.md +7 -0
  449. package/docs/type-aliases/WithDataHashStorageMeta.md +13 -0
  450. package/docs/type-aliases/WithHashStorageMeta.md +13 -0
  451. package/docs/type-aliases/WithOnlyClientMeta.md +13 -0
  452. package/docs/type-aliases/WithOptionalSchema.md +13 -0
  453. package/docs/type-aliases/WithOptionalSources.md +17 -0
  454. package/docs/type-aliases/WithPartialDataHashStorageMeta.md +13 -0
  455. package/docs/type-aliases/WithPartialHashStorageMeta.md +13 -0
  456. package/docs/type-aliases/WithPartialSequenceStorageMeta.md +13 -0
  457. package/docs/type-aliases/WithPartialStorageMeta.md +13 -0
  458. package/docs/type-aliases/WithPayload.md +13 -0
  459. package/docs/type-aliases/WithSchema.md +15 -0
  460. package/docs/type-aliases/WithSequenceStorageMeta.md +13 -0
  461. package/docs/type-aliases/WithSources.md +13 -0
  462. package/docs/type-aliases/WithStorageMeta.md +13 -0
  463. package/docs/type-aliases/WithTimestamp.md +15 -0
  464. package/docs/type-aliases/WithoutClientMeta.md +13 -0
  465. package/docs/type-aliases/WithoutMeta.md +13 -0
  466. package/docs/type-aliases/WithoutPrivateStorageMeta.md +13 -0
  467. package/docs/type-aliases/WithoutSchema.md +13 -0
  468. package/docs/type-aliases/WithoutStorageMeta.md +13 -0
  469. package/docs/type-aliases/WitnessConfig.md +17 -0
  470. package/docs/type-aliases/WitnessConfigSchema.md +7 -0
  471. package/docs/type-aliases/WitnessModuleEventData.md +21 -0
  472. package/docs/type-aliases/WitnessModuleQueries.md +7 -0
  473. package/docs/type-aliases/WitnessObserveQuery.md +7 -0
  474. package/docs/type-aliases/WitnessObserveQuerySchema.md +7 -0
  475. package/docs/type-aliases/WitnessParams.md +17 -0
  476. package/docs/type-aliases/WitnessQueries.md +7 -0
  477. package/docs/type-aliases/WitnessTask.md +7 -0
  478. package/docs/variables/AddressChildSchema.md +7 -0
  479. package/docs/variables/AddressPreviousHashSchema.md +7 -0
  480. package/docs/variables/AddressRegEx.md +7 -0
  481. package/docs/variables/AddressSchema.md +7 -0
  482. package/docs/variables/ArchivistAllQuerySchema.md +7 -0
  483. package/docs/variables/ArchivistClearQuerySchema.md +7 -0
  484. package/docs/variables/ArchivistCommitQuerySchema.md +7 -0
  485. package/docs/variables/ArchivistConfigSchema.md +7 -0
  486. package/docs/variables/ArchivistDeleteQuerySchema.md +7 -0
  487. package/docs/variables/ArchivistGetQuerySchema.md +7 -0
  488. package/docs/variables/ArchivistInsertQuerySchema.md +7 -0
  489. package/docs/variables/ArchivistNextQuerySchema.md +7 -0
  490. package/docs/variables/BoundWitnessJsonSchema-1.md +107 -0
  491. package/docs/variables/BoundWitnessSchema.md +7 -0
  492. package/docs/variables/BridgeConfigSchema.md +7 -0
  493. package/docs/variables/BridgeConnectQuerySchema.md +7 -0
  494. package/docs/variables/BridgeDisconnectQuerySchema.md +7 -0
  495. package/docs/variables/BridgeExposeQuerySchema.md +7 -0
  496. package/docs/variables/BridgeUnexposeQuerySchema.md +7 -0
  497. package/docs/variables/ChildCertificationSchema.md +7 -0
  498. package/docs/variables/DappPackageManifestPayloadSchema.md +7 -0
  499. package/docs/variables/DisallowedModuleIdentifierCharacters.md +125 -0
  500. package/docs/variables/DivinerConfigSchema.md +7 -0
  501. package/docs/variables/DivinerDivineQuerySchema.md +7 -0
  502. package/docs/variables/GeneratedBoundWitnessFields.md +7 -0
  503. package/docs/variables/HashRegEx.md +7 -0
  504. package/docs/variables/HexRegEx.md +7 -0
  505. package/docs/variables/HexRegExMinMax.md +21 -0
  506. package/docs/variables/IndexSeparator.md +7 -0
  507. package/docs/variables/LocalSequenceConstants.md +65 -0
  508. package/docs/variables/MODULE_PATH_SEPARATOR.md +7 -0
  509. package/docs/variables/ModuleAddressQuerySchema.md +7 -0
  510. package/docs/variables/ModuleConfigSchema.md +7 -0
  511. package/docs/variables/ModuleDescriptionSchema.md +7 -0
  512. package/docs/variables/ModuleErrorSchema.md +7 -0
  513. package/docs/variables/ModuleFilterPayloadSchema.md +7 -0
  514. package/docs/variables/ModuleLimitationLabelName.md +7 -0
  515. package/docs/variables/ModuleLimitationViewLabel.md +13 -0
  516. package/docs/variables/ModuleManifestPayloadSchema.md +7 -0
  517. package/docs/variables/ModuleManifestQuerySchema.md +7 -0
  518. package/docs/variables/ModuleStateQuerySchema.md +7 -0
  519. package/docs/variables/ModuleStateSchema.md +7 -0
  520. package/docs/variables/ModuleSubscribeQuerySchema.md +7 -0
  521. package/docs/variables/NodeAttachQuerySchema.md +7 -0
  522. package/docs/variables/NodeAttachedQuerySchema.md +7 -0
  523. package/docs/variables/NodeCertifyQuerySchema.md +7 -0
  524. package/docs/variables/NodeConfigSchema.md +7 -0
  525. package/docs/variables/NodeDetachQuerySchema.md +7 -0
  526. package/docs/variables/NodeManifestPayloadSchema.md +7 -0
  527. package/docs/variables/NodeRegisteredQuerySchema.md +7 -0
  528. package/docs/variables/ObjectResolverPriority.md +33 -0
  529. package/docs/variables/PackageManifestPayloadSchema.md +7 -0
  530. package/docs/variables/PayloadSchema.md +7 -0
  531. package/docs/variables/PayloadSetSchema.md +7 -0
  532. package/docs/variables/QualifiedSequenceConstants.md +21 -0
  533. package/docs/variables/ReservedModuleIdentifierCharacters.md +7 -0
  534. package/docs/variables/SchemaRegEx.md +7 -0
  535. package/docs/variables/SentinelAutomationSchema.md +7 -0
  536. package/docs/variables/SentinelConfigSchema.md +7 -0
  537. package/docs/variables/SentinelEventAutomationSchema.md +7 -0
  538. package/docs/variables/SentinelIntervalAutomationSchema.md +7 -0
  539. package/docs/variables/SentinelReportQuerySchema.md +7 -0
  540. package/docs/variables/SequenceComparer.md +17 -0
  541. package/docs/variables/SequenceComponentLengths.md +29 -0
  542. package/docs/variables/SequenceComponentMinMax.md +33 -0
  543. package/docs/variables/SequenceConstants.md +77 -0
  544. package/docs/variables/SequenceNonceComponentLengths.md +17 -0
  545. package/docs/variables/SignatureRegEx.md +7 -0
  546. package/docs/variables/Uint256RegEx.md +7 -0
  547. package/docs/variables/WasmFeatureDetectors.md +435 -0
  548. package/docs/variables/WithFactory.md +49 -0
  549. package/docs/variables/WitnessConfigSchema.md +7 -0
  550. package/docs/variables/WitnessObserveQuerySchema.md +7 -0
  551. package/docs/variables/addressesContains.md +27 -0
  552. package/docs/variables/addressesContainsAll.md +29 -0
  553. package/docs/variables/addressesContainsAny.md +31 -0
  554. package/docs/variables/asAddressPayload.md +59 -0
  555. package/docs/variables/asAnyPayload.md +59 -0
  556. package/docs/variables/asArchivistInstance.md +59 -0
  557. package/docs/variables/asArchivistModule.md +59 -0
  558. package/docs/variables/asAttachableArchivistInstance.md +59 -0
  559. package/docs/variables/asAttachableBridgeInstance.md +59 -0
  560. package/docs/variables/asAttachableDivinerInstance.md +59 -0
  561. package/docs/variables/asAttachableModuleInstance.md +59 -0
  562. package/docs/variables/asAttachableNodeInstance.md +59 -0
  563. package/docs/variables/asAttachableSentinelInstance.md +59 -0
  564. package/docs/variables/asAttachableWitnessInstance.md +59 -0
  565. package/docs/variables/asBlock.md +17 -0
  566. package/docs/variables/asBoundWitness.md +23 -0
  567. package/docs/variables/asBoundWitnessWithStorageMeta.md +23 -0
  568. package/docs/variables/asBridgeInstance.md +59 -0
  569. package/docs/variables/asBridgeModule.md +59 -0
  570. package/docs/variables/asDataHashStorageMeta.md +59 -0
  571. package/docs/variables/asDivinerInstance.md +59 -0
  572. package/docs/variables/asDivinerModule.md +59 -0
  573. package/docs/variables/asHashStorageMeta.md +59 -0
  574. package/docs/variables/asModule.md +59 -0
  575. package/docs/variables/asModuleInstance.md +59 -0
  576. package/docs/variables/asModuleObject.md +59 -0
  577. package/docs/variables/asModuleState.md +59 -0
  578. package/docs/variables/asNodeInstance.md +59 -0
  579. package/docs/variables/asNodeModule.md +59 -0
  580. package/docs/variables/asOptionalAddressPayload.md +23 -0
  581. package/docs/variables/asOptionalBoundWitness.md +23 -0
  582. package/docs/variables/asOptionalBoundWitnessWithStorageMeta.md +23 -0
  583. package/docs/variables/asOptionalDataHashStorageMeta.md +23 -0
  584. package/docs/variables/asOptionalHashStorageMeta.md +23 -0
  585. package/docs/variables/asOptionalSequenceStorageMeta.md +23 -0
  586. package/docs/variables/asOptionalStorageMeta.md +23 -0
  587. package/docs/variables/asPayload.md +69 -0
  588. package/docs/variables/asSchema.md +59 -0
  589. package/docs/variables/asSentinelInstance.md +59 -0
  590. package/docs/variables/asSentinelModule.md +59 -0
  591. package/docs/variables/asSequenceStorageMeta.md +59 -0
  592. package/docs/variables/asStorageMeta.md +59 -0
  593. package/docs/variables/asWitnessInstance.md +59 -0
  594. package/docs/variables/asWitnessModule.md +59 -0
  595. package/docs/variables/assignCreatableModuleRegistry.md +25 -0
  596. package/docs/variables/boundWitnessJsonSchema.md +7 -0
  597. package/docs/variables/boundWitnessProperties.md +7 -0
  598. package/docs/variables/buildStandardIndexName.md +24 -0
  599. package/docs/variables/combineWalletPaths.md +21 -0
  600. package/docs/variables/duplicateModules.md +37 -0
  601. package/docs/variables/formatWalletPath.md +17 -0
  602. package/docs/variables/getBoundWitness.md +21 -0
  603. package/docs/variables/getTypedBoundWitness.md +31 -0
  604. package/docs/variables/hasAllLabels.md +29 -0
  605. package/docs/variables/hasBlock.md +17 -0
  606. package/docs/variables/hasEmptyFields.md +23 -0
  607. package/docs/variables/hasLabels.md +17 -0
  608. package/docs/variables/hydrateBoundWitness.md +21 -0
  609. package/docs/variables/hydrateTypedBoundWitness.md +31 -0
  610. package/docs/variables/includesReservedModuleIdentifierCharacter.md +17 -0
  611. package/docs/variables/isAddressModuleFilter.md +17 -0
  612. package/docs/variables/isAddressObjectFilter.md +23 -0
  613. package/docs/variables/isAddressPayload.md +19 -0
  614. package/docs/variables/isAnyPayload.md +17 -0
  615. package/docs/variables/isArchivistInstance.md +7 -0
  616. package/docs/variables/isArchivistModule.md +7 -0
  617. package/docs/variables/isAttachableArchivistInstance.md +7 -0
  618. package/docs/variables/isAttachableBridgeInstance.md +7 -0
  619. package/docs/variables/isAttachableDivinerInstance.md +7 -0
  620. package/docs/variables/isAttachableModuleInstance.md +7 -0
  621. package/docs/variables/isAttachableNodeInstance.md +7 -0
  622. package/docs/variables/isAttachableSentinelInstance.md +7 -0
  623. package/docs/variables/isAttachableWitnessInstance.md +7 -0
  624. package/docs/variables/isBoundWitness.md +17 -0
  625. package/docs/variables/isBoundWitnessWithStorageMeta.md +17 -0
  626. package/docs/variables/isBoundWitnessWrapper.md +27 -0
  627. package/docs/variables/isBridgeInstance.md +7 -0
  628. package/docs/variables/isBridgeModule.md +7 -0
  629. package/docs/variables/isDataHashStorageMeta.md +17 -0
  630. package/docs/variables/isDivinerInstance.md +7 -0
  631. package/docs/variables/isDivinerModule.md +7 -0
  632. package/docs/variables/isEpoch.md +17 -0
  633. package/docs/variables/isHashStorageMeta.md +17 -0
  634. package/docs/variables/isLocalSequence.md +17 -0
  635. package/docs/variables/isModule.md +7 -0
  636. package/docs/variables/isModuleError.md +17 -0
  637. package/docs/variables/isModuleIdentifierPart.md +17 -0
  638. package/docs/variables/isModuleInstance.md +7 -0
  639. package/docs/variables/isModuleName.md +17 -0
  640. package/docs/variables/isModuleObject.md +7 -0
  641. package/docs/variables/isModuleResolver.md +17 -0
  642. package/docs/variables/isModuleState.md +23 -0
  643. package/docs/variables/isModuleStateWithSources.md +23 -0
  644. package/docs/variables/isNameModuleFilter.md +17 -0
  645. package/docs/variables/isNameObjectFilter.md +23 -0
  646. package/docs/variables/isNodeInstance.md +7 -0
  647. package/docs/variables/isNodeModule.md +7 -0
  648. package/docs/variables/isNonce.md +17 -0
  649. package/docs/variables/isObjectResolver.md +23 -0
  650. package/docs/variables/isPackageManifestPayload.md +17 -0
  651. package/docs/variables/isPayload.md +33 -0
  652. package/docs/variables/isPayloadOfSchemaTypeWithSources.md +33 -0
  653. package/docs/variables/isPayloadWrapper.md +17 -0
  654. package/docs/variables/isPayloadWrapperBase.md +17 -0
  655. package/docs/variables/isQualifiedSequence.md +17 -0
  656. package/docs/variables/isQueryBoundWitness.md +17 -0
  657. package/docs/variables/isQueryBoundWitnessWithStorageMeta.md +17 -0
  658. package/docs/variables/isQueryModuleFilter.md +17 -0
  659. package/docs/variables/isQueryObjectFilter.md +23 -0
  660. package/docs/variables/isSchema.md +17 -0
  661. package/docs/variables/isSentinelInstance.md +7 -0
  662. package/docs/variables/isSentinelIntervalAutomation.md +17 -0
  663. package/docs/variables/isSentinelModule.md +7 -0
  664. package/docs/variables/isSequence.md +17 -0
  665. package/docs/variables/isSequenceStorageMeta.md +17 -0
  666. package/docs/variables/isSerializable.md +21 -0
  667. package/docs/variables/isSigned.md +17 -0
  668. package/docs/variables/isStorageMeta.md +17 -0
  669. package/docs/variables/isUnsigned.md +17 -0
  670. package/docs/variables/isValidAbsoluteWalletPath.md +17 -0
  671. package/docs/variables/isValidRelativeWalletPath.md +17 -0
  672. package/docs/variables/isWitnessInstance.md +7 -0
  673. package/docs/variables/isWitnessModule.md +7 -0
  674. package/docs/variables/mixinResolverEventEmitter.md +23 -0
  675. package/docs/variables/notBoundWitness.md +17 -0
  676. package/docs/variables/notPayloadOfSchemaType.md +33 -0
  677. package/docs/variables/omitSchema.md +23 -0
  678. package/docs/variables/payloadHashesContains.md +29 -0
  679. package/docs/variables/payloadHashesContainsAll.md +29 -0
  680. package/docs/variables/payloadHashesContainsAny.md +31 -0
  681. package/docs/variables/payloadJsonSchema.md +7 -0
  682. package/docs/variables/payloadPropertiesJsonSchema.md +7 -0
  683. package/docs/variables/payloadSchemasContains.md +29 -0
  684. package/docs/variables/payloadSchemasContainsAll.md +29 -0
  685. package/docs/variables/payloadSchemasContainsAny.md +31 -0
  686. package/docs/variables/registerCreatableModuleFactories.md +25 -0
  687. package/docs/variables/registerCreatableModuleFactory.md +35 -0
  688. package/docs/variables/removeEmptyFields.md +23 -0
  689. package/docs/variables/requiredAttachableArchivistInstanceFunctions.md +7 -0
  690. package/docs/variables/requiredAttachableBridgeInstanceFunctions.md +7 -0
  691. package/docs/variables/requiredAttachableDivinerInstanceFunctions.md +7 -0
  692. package/docs/variables/requiredAttachableModuleInstanceFunctions.md +7 -0
  693. package/docs/variables/requiredAttachableNodeInstanceFunctions.md +7 -0
  694. package/docs/variables/requiredAttachableSentinelInstanceFunctions.md +7 -0
  695. package/docs/variables/requiredAttachableWitnessInstanceFunctions.md +7 -0
  696. package/docs/variables/requiredModuleInstanceFunctions.md +7 -0
  697. package/docs/variables/requiredModuleQueries.md +7 -0
  698. package/docs/variables/requiredModuleShape.md +7 -0
  699. package/docs/variables/resolveAddressToInstance.md +33 -0
  700. package/docs/variables/resolveAddressToInstanceAll.md +29 -0
  701. package/docs/variables/resolveAddressToInstanceDown.md +29 -0
  702. package/docs/variables/resolveAddressToInstanceSiblings.md +29 -0
  703. package/docs/variables/resolveAddressToInstanceUp.md +29 -0
  704. package/docs/variables/resolveAll.md +25 -0
  705. package/docs/variables/resolveAllDown.md +29 -0
  706. package/docs/variables/resolveAllUp.md +25 -0
  707. package/docs/variables/resolveLocalNameToAddress.md +29 -0
  708. package/docs/variables/resolveLocalNameToAddressAll.md +25 -0
  709. package/docs/variables/resolveLocalNameToAddressDown.md +25 -0
  710. package/docs/variables/resolveLocalNameToAddressUp.md +21 -0
  711. package/docs/variables/resolveLocalNameToInstance.md +29 -0
  712. package/docs/variables/resolveLocalNameToInstanceAll.md +25 -0
  713. package/docs/variables/resolveLocalNameToInstanceDown.md +25 -0
  714. package/docs/variables/resolveLocalNameToInstanceUp.md +21 -0
  715. package/docs/variables/resolvePathToAddress.md +29 -0
  716. package/docs/variables/resolvePathToInstance.md +29 -0
  717. package/docs/variables/sortFields.md +23 -0
  718. package/docs/variables/transformModuleIdentifier.md +21 -0
  719. package/docs/variables/tryGetTypedBoundWitness.md +31 -0
  720. package/docs/variables/tryHydrateTypedBoundWitness.md +31 -0
  721. package/docs/variables/withArchivistInstance.md +27 -0
  722. package/docs/variables/withArchivistModule.md +27 -0
  723. package/docs/variables/withBridgeInstance.md +27 -0
  724. package/docs/variables/withBridgeModule.md +27 -0
  725. package/docs/variables/withDivinerInstance.md +27 -0
  726. package/docs/variables/withDivinerModule.md +27 -0
  727. package/docs/variables/withModule.md +27 -0
  728. package/docs/variables/withModuleInstance.md +27 -0
  729. package/docs/variables/withNodeInstance.md +27 -0
  730. package/docs/variables/withNodeModule.md +27 -0
  731. package/docs/variables/withSentinelInstance.md +27 -0
  732. package/docs/variables/withSentinelModule.md +27 -0
  733. package/docs/variables/withWitnessInstance.md +27 -0
  734. package/docs/variables/withWitnessModule.md +27 -0
  735. package/package.json +19 -18
  736. package/scripts/README.template.md +23 -0
  737. package/scripts/generate-docs-for-package.mjs +71 -0
  738. package/scripts/readme-gen.mjs +37 -0
@@ -0,0 +1,17 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleIdentifierTransformerFunc
2
+
3
+ # Type Alias: ModuleIdentifierTransformerFunc()
4
+
5
+ > **ModuleIdentifierTransformerFunc** = (`id`) => `Promisable`\<[`ModuleIdentifier`](ModuleIdentifier.md) \| `undefined`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/ModuleIdentifierTransformer.d.ts:3
8
+
9
+ ## Parameters
10
+
11
+ ### id
12
+
13
+ [`ModuleIdentifier`](ModuleIdentifier.md)
14
+
15
+ ## Returns
16
+
17
+ `Promisable`\<[`ModuleIdentifier`](ModuleIdentifier.md) \| `undefined`\>
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleLimitationLabelName
2
+
3
+ # Type Alias: ModuleLimitationLabelName
4
+
5
+ > **ModuleLimitationLabelName** = *typeof* [`ModuleLimitationLabelName`](../variables/ModuleLimitationLabelName.md)
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Labels/standard/View.d.ts:1
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleManifestPayload
2
+
3
+ # Type Alias: ModuleManifestPayload
4
+
5
+ > **ModuleManifestPayload** = [`Payload`](Payload.md)\<[`ModuleManifest`](../interfaces/ModuleManifest.md), [`ModuleManifestPayloadSchema`](ModuleManifestPayloadSchema.md) \| [`NodeManifestPayloadSchema`](NodeManifestPayloadSchema.md)\>
6
+
7
+ Defined in: packages/manifest/packages/model/dist/types/Payload.d.ts:14
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleManifestPayloadSchema
2
+
3
+ # Type Alias: ModuleManifestPayloadSchema
4
+
5
+ > **ModuleManifestPayloadSchema** = *typeof* [`ModuleManifestPayloadSchema`](../variables/ModuleManifestPayloadSchema.md)
6
+
7
+ Defined in: packages/manifest/packages/model/dist/types/Payload.d.ts:5
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleManifestQuery
2
+
3
+ # Type Alias: ModuleManifestQuery
4
+
5
+ > **ModuleManifestQuery** = [`Query`](Query.md)\<\{ `maxDepth?`: `number`; `schema`: [`ModuleManifestQuerySchema`](ModuleManifestQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/Manifest.d.ts:4
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleManifestQuerySchema
2
+
3
+ # Type Alias: ModuleManifestQuerySchema
4
+
5
+ > **ModuleManifestQuerySchema** = *typeof* [`ModuleManifestQuerySchema`](../variables/ModuleManifestQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/Manifest.d.ts:2
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleName
2
+
3
+ # Type Alias: ModuleName
4
+
5
+ > **ModuleName** = `Exclude`\<`string`, `"reserved-module-name-56487634"`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/ModuleIdentifier.d.ts:36
@@ -0,0 +1,17 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleParams
2
+
3
+ # Type Alias: ModuleParams\<TConfig, TAdditionalParams\>
4
+
5
+ > **ModuleParams**\<`TConfig`, `TAdditionalParams`\> = `WithAdditional`\<`BaseParams`\<\{ `account?`: `AccountInstance` \| `"random"`; `additionalSigners?`: `AccountInstance`[]; `addToResolvers?`: `boolean`; `allowNameResolution?`: `boolean`; `config`: `TConfig` *extends* [`AnyConfigSchema`](AnyConfigSchema.md)\<[`ModuleConfig`](ModuleConfig.md)\> ? `TConfig` : [`AnyConfigSchema`](AnyConfigSchema.md)\<[`ModuleConfig`](ModuleConfig.md)\>; `ephemeralQueryAccountEnabled?`: `boolean`; `moduleIdentifierTransformers?`: [`ModuleIdentifierTransformer`](../interfaces/ModuleIdentifierTransformer.md)[]; `privateChildren?`: [`ModuleInstance`](../interfaces/ModuleInstance.md)[]; `publicChildren?`: [`ModuleInstance`](../interfaces/ModuleInstance.md)[]; \}\>, `TAdditionalParams`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/ModuleParams.d.ts:7
8
+
9
+ ## Type Parameters
10
+
11
+ ### TConfig
12
+
13
+ `TConfig` *extends* [`AnyConfigSchema`](AnyConfigSchema.md)\<[`ModuleConfig`](ModuleConfig.md)\> \| `void` = `void`
14
+
15
+ ### TAdditionalParams
16
+
17
+ `TAdditionalParams` *extends* `EmptyObject` \| `void` = `void`
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModulePipeLine
2
+
3
+ # Type Alias: ModulePipeLine
4
+
5
+ > **ModulePipeLine** = `Lowercase`\<`"one-to-one"` \| `"one-to-many"` \| `"many-to-one"` \| `"many-to-many"`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:12
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleQueriedEventArgs
2
+
3
+ # Type Alias: ModuleQueriedEventArgs\<TModule\>
4
+
5
+ > **ModuleQueriedEventArgs**\<`TModule`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`TModule`, \{ `payloads?`: [`Payload`](Payload.md)[]; `query`: [`QueryBoundWitness`](QueryBoundWitness.md); `result`: [`ModuleQueryResult`](ModuleQueryResult.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/EventsModels/ModuleQueried.d.ts:6
8
+
9
+ ## Type Parameters
10
+
11
+ ### TModule
12
+
13
+ `TModule` *extends* `object` = `object`
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleQueries
2
+
3
+ # Type Alias: ModuleQueries
4
+
5
+ > **ModuleQueries** = [`ModuleAddressQuery`](ModuleAddressQuery.md) \| [`ModuleSubscribeQuery`](ModuleSubscribeQuery.md) \| [`ModuleManifestQuery`](ModuleManifestQuery.md) \| [`ModuleStateQuery`](ModuleStateQuery.md)
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/index.d.ts:9
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleQueryHandlerResult
2
+
3
+ # Type Alias: ModuleQueryHandlerResult
4
+
5
+ > **ModuleQueryHandlerResult** = [`Payload`](Payload.md)[]
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/ModuleQueryHandlerResult.d.ts:2
@@ -0,0 +1,21 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleQueryResult
2
+
3
+ # Type Alias: ModuleQueryResult\<P, E, B\>
4
+
5
+ > **ModuleQueryResult**\<`P`, `E`, `B`\> = \[[`WithoutPrivateStorageMeta`](WithoutPrivateStorageMeta.md)\<`B`\>, [`WithoutPrivateStorageMeta`](WithoutPrivateStorageMeta.md)\<`P`\>[], [`WithoutPrivateStorageMeta`](WithoutPrivateStorageMeta.md)\<`E`\>[]\]
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/ModuleQueryResult.d.ts:3
8
+
9
+ ## Type Parameters
10
+
11
+ ### P
12
+
13
+ `P` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
14
+
15
+ ### E
16
+
17
+ `E` *extends* [`ModuleError`](ModuleError.md) = [`ModuleError`](ModuleError.md)
18
+
19
+ ### B
20
+
21
+ `B` *extends* [`BoundWitness`](BoundWitness.md) = [`BoundWitness`](BoundWitness.md)
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleRegisteredEventArgs
2
+
3
+ # Type Alias: ModuleRegisteredEventArgs\<TModule\>
4
+
5
+ > **ModuleRegisteredEventArgs**\<`TModule`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`TModule`\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/EventsModels/ModuleRegistered.d.ts:3
8
+
9
+ ## Type Parameters
10
+
11
+ ### TModule
12
+
13
+ `TModule` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleResolveDirection
2
+
3
+ # Type Alias: ModuleResolveDirection
4
+
5
+ > **ModuleResolveDirection** = `"all"` \| `"up"` \| `"down"`
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/model.d.ts:1
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleState
2
+
3
+ # Type Alias: ModuleState\<T\>
4
+
5
+ > **ModuleState**\<`T`\> = [`Payload`](Payload.md)\<[`State`](../interfaces/State.md)\<`T`\>, [`ModuleStateSchema`](ModuleStateSchema.md)\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Payload/ModuleState.d.ts:10
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* [`StateDictionary`](../interfaces/StateDictionary.md) = [`StateDictionary`](../interfaces/StateDictionary.md)
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleStateQuery
2
+
3
+ # Type Alias: ModuleStateQuery
4
+
5
+ > **ModuleStateQuery** = [`Query`](Query.md)\<`void`, [`ModuleStateQuerySchema`](ModuleStateQuerySchema.md)\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/State.d.ts:4
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleStateQuerySchema
2
+
3
+ # Type Alias: ModuleStateQuerySchema
4
+
5
+ > **ModuleStateQuerySchema** = *typeof* [`ModuleStateQuerySchema`](../variables/ModuleStateQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/State.d.ts:2
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleStateSchema
2
+
3
+ # Type Alias: ModuleStateSchema
4
+
5
+ > **ModuleStateSchema** = *typeof* [`ModuleStateSchema`](../variables/ModuleStateSchema.md)
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Payload/ModuleState.d.ts:8
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleStatus
2
+
3
+ # Type Alias: ModuleStatus
4
+
5
+ > **ModuleStatus** = `"started"` \| `"stopped"` \| `"dead"` \| `"wrapped"` \| `"proxy"`
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:13
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleSubscribeQuery
2
+
3
+ # Type Alias: ModuleSubscribeQuery
4
+
5
+ > **ModuleSubscribeQuery** = [`Query`](Query.md)\<\{ `address`: `Address`; `filter?`: [`ModuleSubscribeFilter`](../interfaces/ModuleSubscribeFilter.md) \| `null`; `maxQueue?`: `number`; `schema`: [`ModuleSubscribeQuerySchema`](ModuleSubscribeQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/Subscribe.d.ts:9
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleSubscribeQuerySchema
2
+
3
+ # Type Alias: ModuleSubscribeQuerySchema
4
+
5
+ > **ModuleSubscribeQuerySchema** = *typeof* [`ModuleSubscribeQuerySchema`](../variables/ModuleSubscribeQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/Subscribe.d.ts:3
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleTypeCheck
2
+
3
+ # Type Alias: ModuleTypeCheck\<T\>
4
+
5
+ > **ModuleTypeCheck**\<`T`\> = `TypeCheck`\<`T`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/module/IsModuleFactory.d.ts:3
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleUnregisteredEventArgs
2
+
3
+ # Type Alias: ModuleUnregisteredEventArgs\<TModule\>
4
+
5
+ > **ModuleUnregisteredEventArgs**\<`TModule`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`TModule`\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/EventsModels/ModuleUnregistered.d.ts:3
8
+
9
+ ## Type Parameters
10
+
11
+ ### TModule
12
+
13
+ `TModule` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ModuleWrapperParams
2
+
3
+ # Type Alias: ModuleWrapperParams\<TWrappedModule\>
4
+
5
+ > **ModuleWrapperParams**\<`TWrappedModule`\> = `BaseParams`\<\{ `account`: `AccountInstance`; `additionalSigners?`: `AccountInstance`[]; `mod`: `TWrappedModule`; \}\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/models.d.ts:4
8
+
9
+ ## Type Parameters
10
+
11
+ ### TWrappedModule
12
+
13
+ `TWrappedModule` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / NameModuleFilter
2
+
3
+ # Type Alias: NameModuleFilter\<T\>
4
+
5
+ > **NameModuleFilter**\<`T`\> = [`NameObjectFilter`](../interfaces/NameObjectFilter.md)\<`T`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleFilter.d.ts:40
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md) = [`ModuleInstance`](../interfaces/ModuleInstance.md)
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeAttachQuery
2
+
3
+ # Type Alias: NodeAttachQuery
4
+
5
+ > **NodeAttachQuery** = [`Query`](Query.md)\<\{ `external?`: `boolean`; `id`: [`ModuleIdentifier`](ModuleIdentifier.md); `schema`: [`NodeAttachQuerySchema`](NodeAttachQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Attach.d.ts:5
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeAttachQuerySchema
2
+
3
+ # Type Alias: NodeAttachQuerySchema
4
+
5
+ > **NodeAttachQuerySchema** = *typeof* [`NodeAttachQuerySchema`](../variables/NodeAttachQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Attach.d.ts:3
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeAttachedQuery
2
+
3
+ # Type Alias: NodeAttachedQuery
4
+
5
+ > **NodeAttachedQuery** = [`Query`](Query.md)\<\{ `schema`: [`NodeAttachedQuerySchema`](NodeAttachedQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Attached.d.ts:4
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeAttachedQuerySchema
2
+
3
+ # Type Alias: NodeAttachedQuerySchema
4
+
5
+ > **NodeAttachedQuerySchema** = *typeof* [`NodeAttachedQuerySchema`](../variables/NodeAttachedQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Attached.d.ts:2
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeCertifyQuery
2
+
3
+ # Type Alias: NodeCertifyQuery
4
+
5
+ > **NodeCertifyQuery** = [`Query`](Query.md)\<\{ `id`: [`ModuleIdentifier`](ModuleIdentifier.md); `schema`: [`NodeCertifyQuerySchema`](NodeCertifyQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Certify.d.ts:5
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeCertifyQuerySchema
2
+
3
+ # Type Alias: NodeCertifyQuerySchema
4
+
5
+ > **NodeCertifyQuerySchema** = *typeof* [`NodeCertifyQuerySchema`](../variables/NodeCertifyQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Certify.d.ts:3
@@ -0,0 +1,17 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeConfig
2
+
3
+ # Type Alias: NodeConfig\<TConfig, TSchema\>
4
+
5
+ > **NodeConfig**\<`TConfig`, `TSchema`\> = [`ModuleConfig`](ModuleConfig.md)\<`WithAdditional`\<\{ `archivist?`: `string`; \}, `TConfig`\>, `TSchema` *extends* `void` ? `TConfig` *extends* [`Payload`](Payload.md) ? `TConfig`\[`"schema"`\] : [`NodeConfigSchema`](NodeConfigSchema.md) : `TSchema`\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Config.d.ts:6
8
+
9
+ ## Type Parameters
10
+
11
+ ### TConfig
12
+
13
+ `TConfig` *extends* `EmptyObject` \| [`Payload`](Payload.md) \| `void` = `void`
14
+
15
+ ### TSchema
16
+
17
+ `TSchema` *extends* `string` \| `void` = `void`
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeConfigSchema
2
+
3
+ # Type Alias: NodeConfigSchema
4
+
5
+ > **NodeConfigSchema** = *typeof* [`NodeConfigSchema`](../variables/NodeConfigSchema.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Config.d.ts:4
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeDetachQuery
2
+
3
+ # Type Alias: NodeDetachQuery
4
+
5
+ > **NodeDetachQuery** = [`Query`](Query.md)\<\{ `id`: [`ModuleIdentifier`](ModuleIdentifier.md); `schema`: [`NodeDetachQuerySchema`](NodeDetachQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Detach.d.ts:5
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeDetachQuerySchema
2
+
3
+ # Type Alias: NodeDetachQuerySchema
4
+
5
+ > **NodeDetachQuerySchema** = *typeof* [`NodeDetachQuerySchema`](../variables/NodeDetachQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Detach.d.ts:3
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeManifestPayloadSchema
2
+
3
+ # Type Alias: NodeManifestPayloadSchema
4
+
5
+ > **NodeManifestPayloadSchema** = *typeof* [`NodeManifestPayloadSchema`](../variables/NodeManifestPayloadSchema.md)
6
+
7
+ Defined in: packages/manifest/packages/model/dist/types/Payload.d.ts:7
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeModuleQueries
2
+
3
+ # Type Alias: NodeModuleQueries
4
+
5
+ > **NodeModuleQueries** = [`ModuleQueries`](ModuleQueries.md) \| [`NodeQueries`](NodeQueries.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/index.d.ts:13
@@ -0,0 +1,17 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeParams
2
+
3
+ # Type Alias: NodeParams\<TConfig, TAdditionalParams\>
4
+
5
+ > **NodeParams**\<`TConfig`, `TAdditionalParams`\> = [`ModuleParams`](ModuleParams.md)\<`TConfig`, `TAdditionalParams`\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Params.d.ts:4
8
+
9
+ ## Type Parameters
10
+
11
+ ### TConfig
12
+
13
+ `TConfig` *extends* [`AnyConfigSchema`](AnyConfigSchema.md)\<[`NodeConfig`](NodeConfig.md)\> = [`AnyConfigSchema`](AnyConfigSchema.md)\<[`NodeConfig`](NodeConfig.md)\>
14
+
15
+ ### TAdditionalParams
16
+
17
+ `TAdditionalParams` *extends* `EmptyObject` \| `void` = `void`
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeQueries
2
+
3
+ # Type Alias: NodeQueries
4
+
5
+ > **NodeQueries** = [`NodeAttachQuery`](NodeAttachQuery.md) \| [`NodeCertifyQuery`](NodeCertifyQuery.md) \| [`NodeDetachQuery`](NodeDetachQuery.md) \| [`NodeAttachedQuery`](NodeAttachedQuery.md) \| [`NodeRegisteredQuery`](NodeRegisteredQuery.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/index.d.ts:12
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeRegisteredQuery
2
+
3
+ # Type Alias: NodeRegisteredQuery
4
+
5
+ > **NodeRegisteredQuery** = [`Query`](Query.md)\<\{ `schema`: [`NodeRegisteredQuerySchema`](NodeRegisteredQuerySchema.md); \}\>
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Registered.d.ts:4
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / NodeRegisteredQuerySchema
2
+
3
+ # Type Alias: NodeRegisteredQuerySchema
4
+
5
+ > **NodeRegisteredQuerySchema** = *typeof* [`NodeRegisteredQuerySchema`](../variables/NodeRegisteredQuerySchema.md)
6
+
7
+ Defined in: packages/modules/packages/node/packages/model/dist/types/Queries/Registered.d.ts:2
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / Nonce
2
+
3
+ # Type Alias: Nonce
4
+
5
+ > **Nonce** = `Hex` & `Exclude`\<`string`, `"reserved-nonce-sequence-value"`\>
6
+
7
+ Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Sequence.d.ts:7
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ObjectCategory
2
+
3
+ # Type Alias: ObjectCategory
4
+
5
+ > **ObjectCategory** = `"block"` \| `"payload"`
6
+
7
+ Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:3
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / ObjectFilter
2
+
3
+ # Type Alias: ObjectFilter\<T\>
4
+
5
+ > **ObjectFilter**\<`T`\> = [`ObjectFilterOptions`](../interfaces/ObjectFilterOptions.md)\<`T`\> \| [`AddressObjectFilter`](../interfaces/AddressObjectFilter.md)\<`T`\> \| [`NameObjectFilter`](../interfaces/NameObjectFilter.md)\<`T`\> \| [`QueryObjectFilter`](../interfaces/QueryObjectFilter.md)\<`T`\>
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:29
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* `EmptyObject`
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / ObjectResolverPriority
2
+
3
+ # Type Alias: ObjectResolverPriority
4
+
5
+ > **ObjectResolverPriority** = *typeof* [`ObjectResolverPriority`](../variables/ObjectResolverPriority.md)\[keyof *typeof* [`ObjectResolverPriority`](../variables/ObjectResolverPriority.md)\]
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:6
@@ -0,0 +1,21 @@
1
+ [@xyo-network/sdk-js](../README.md) / ObserveEndEventArgs
2
+
3
+ # Type Alias: ObserveEndEventArgs\<T, TIn, TOut\>
4
+
5
+ > **ObserveEndEventArgs**\<`T`, `TIn`, `TOut`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `errors?`: `Error`[]; `inPayloads?`: `TIn`[]; `outPayloads?`: `TOut`[]; \}\>
6
+
7
+ Defined in: packages/modules/packages/witness/packages/model/dist/types/EventsModels/ObserveEnd.d.ts:4
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md) = [`ModuleInstance`](../interfaces/ModuleInstance.md)
14
+
15
+ ### TIn
16
+
17
+ `TIn` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
18
+
19
+ ### TOut
20
+
21
+ `TOut` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
@@ -0,0 +1,17 @@
1
+ [@xyo-network/sdk-js](../README.md) / ObserveStartEventArgs
2
+
3
+ # Type Alias: ObserveStartEventArgs\<T, TIn\>
4
+
5
+ > **ObserveStartEventArgs**\<`T`, `TIn`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `inPayloads?`: `TIn`[]; \}\>
6
+
7
+ Defined in: packages/modules/packages/witness/packages/model/dist/types/EventsModels/ObserveStart.d.ts:4
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md) = [`ModuleInstance`](../interfaces/ModuleInstance.md)
14
+
15
+ ### TIn
16
+
17
+ `TIn` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
@@ -0,0 +1,19 @@
1
+ [@xyo-network/sdk-js](../README.md) / OptionalConfigSchema
2
+
3
+ # Type Alias: OptionalConfigSchema\<TConfig\>
4
+
5
+ > **OptionalConfigSchema**\<`TConfig`\> = `Omit`\<`TConfig`, `"schema"`\> & `object`
6
+
7
+ Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Config.d.ts:14
8
+
9
+ ## Type declaration
10
+
11
+ ### schema?
12
+
13
+ > `optional` **schema**: `TConfig`\[`"schema"`\]
14
+
15
+ ## Type Parameters
16
+
17
+ ### TConfig
18
+
19
+ `TConfig` *extends* [`AnyConfigSchema`](AnyConfigSchema.md)\<[`ModuleConfig`](ModuleConfig.md)\> = [`AnyConfigSchema`](AnyConfigSchema.md)\<[`ModuleConfig`](ModuleConfig.md)\>
@@ -0,0 +1,13 @@
1
+ [@xyo-network/sdk-js](../README.md) / OverridablePayload
2
+
3
+ # Type Alias: OverridablePayload\<T\>
4
+
5
+ > **OverridablePayload**\<`T`\> = [`WithoutMeta`](WithoutMeta.md)\<`Omit`\<`T`, `"schema"`\> & [`PayloadFields`](../interfaces/PayloadFields.md)\>
6
+
7
+ Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:24
8
+
9
+ ## Type Parameters
10
+
11
+ ### T
12
+
13
+ `T` *extends* [`Payload`](Payload.md)
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / PackageManifestPayload
2
+
3
+ # Type Alias: PackageManifestPayload
4
+
5
+ > **PackageManifestPayload** = [`Payload`](Payload.md)\<[`PackageManifest`](../interfaces/PackageManifest.md), [`PackageManifestPayloadSchema`](PackageManifestPayloadSchema.md)\>
6
+
7
+ Defined in: packages/manifest/packages/model/dist/types/Payload.d.ts:15
@@ -0,0 +1,7 @@
1
+ [@xyo-network/sdk-js](../README.md) / PackageManifestPayloadSchema
2
+
3
+ # Type Alias: PackageManifestPayloadSchema
4
+
5
+ > **PackageManifestPayloadSchema** = *typeof* [`PackageManifestPayloadSchema`](../variables/PackageManifestPayloadSchema.md)
6
+
7
+ Defined in: packages/manifest/packages/model/dist/types/Payload.d.ts:3
@@ -0,0 +1,19 @@
1
+ [@xyo-network/sdk-js](../README.md) / Payload
2
+
3
+ # Type Alias: Payload\<T, S\>
4
+
5
+ > **Payload**\<`T`, `S`\> = `T` *extends* [`WithSchema`](WithSchema.md) ? `S` *extends* [`Schema`](Schema.md) ? [`WithPayload`](WithPayload.md)\<`Omit`\<`T`, `"schema"`\> & `object`\> : [`WithPayload`](WithPayload.md)\<`T`\> : `T` *extends* `object` ? `S` *extends* [`Schema`](Schema.md) ? [`WithPayload`](WithPayload.md)\<`T` & `object`\> : [`WithPayload`](WithPayload.md)\<`T` & [`PayloadFields`](../interfaces/PayloadFields.md)\> : [`WithPayload`](WithPayload.md)\<\{ `schema`: `S` *extends* [`Schema`](Schema.md) ? `S` : [`Schema`](Schema.md); \}\> & `Partial`\<[`PayloadMetaFields`](../interfaces/PayloadMetaFields.md)\>
6
+
7
+ Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:17
8
+
9
+ Base Type for Payloads
10
+
11
+ ## Type Parameters
12
+
13
+ ### T
14
+
15
+ `T` *extends* `void` \| `EmptyObject` \| [`WithSchema`](WithSchema.md) = `void`
16
+
17
+ ### S
18
+
19
+ `S` *extends* [`Schema`](Schema.md) \| `void` = `void`