@xyo-network/react-node 2.41.12 → 2.41.14

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 (106) hide show
  1. package/dist/cjs/components/Node.d.ts.map +1 -1
  2. package/dist/cjs/components/Node.js +10 -2
  3. package/dist/cjs/components/Node.js.map +1 -1
  4. package/dist/cjs/components/NodeQueryDiviner.d.ts +3 -0
  5. package/dist/cjs/components/NodeQueryDiviner.d.ts.map +1 -0
  6. package/dist/cjs/components/NodeQueryDiviner.js +21 -0
  7. package/dist/cjs/components/NodeQueryDiviner.js.map +1 -0
  8. package/dist/cjs/contexts/Provider.d.ts +2 -2
  9. package/dist/cjs/contexts/Provider.d.ts.map +1 -1
  10. package/dist/cjs/contexts/Provider.js.map +1 -1
  11. package/dist/cjs/contexts/State.d.ts +3 -3
  12. package/dist/cjs/contexts/State.d.ts.map +1 -1
  13. package/dist/cjs/contexts/index.d.ts +2 -0
  14. package/dist/cjs/contexts/index.d.ts.map +1 -1
  15. package/dist/cjs/contexts/index.js +2 -0
  16. package/dist/cjs/contexts/index.js.map +1 -1
  17. package/dist/cjs/contexts/useAddNamedModules.d.ts +5 -0
  18. package/dist/cjs/contexts/useAddNamedModules.d.ts.map +1 -0
  19. package/dist/cjs/contexts/useAddNamedModules.js +66 -0
  20. package/dist/cjs/contexts/useAddNamedModules.js.map +1 -0
  21. package/dist/cjs/contexts/useArchivistModule.d.ts +2 -1
  22. package/dist/cjs/contexts/useArchivistModule.d.ts.map +1 -1
  23. package/dist/cjs/contexts/useArchivistModule.js +2 -2
  24. package/dist/cjs/contexts/useArchivistModule.js.map +1 -1
  25. package/dist/cjs/contexts/useDivinerModule.d.ts +2 -1
  26. package/dist/cjs/contexts/useDivinerModule.d.ts.map +1 -1
  27. package/dist/cjs/contexts/useDivinerModule.js +2 -2
  28. package/dist/cjs/contexts/useDivinerModule.js.map +1 -1
  29. package/dist/cjs/contexts/useModuleAddresses.d.ts +1 -1
  30. package/dist/cjs/contexts/useModuleAddresses.d.ts.map +1 -1
  31. package/dist/cjs/contexts/useModules.d.ts +1 -1
  32. package/dist/cjs/contexts/useModules.d.ts.map +1 -1
  33. package/dist/cjs/contexts/useModules.js.map +1 -1
  34. package/dist/cjs/contexts/useNode.d.ts +8 -2
  35. package/dist/cjs/contexts/useNode.d.ts.map +1 -1
  36. package/dist/cjs/contexts/useNode.js +1 -1
  37. package/dist/cjs/contexts/useNode.js.map +1 -1
  38. package/dist/cjs/contexts/useNodeQueryDiviner.d.ts +3 -0
  39. package/dist/cjs/contexts/useNodeQueryDiviner.d.ts.map +1 -0
  40. package/dist/cjs/contexts/useNodeQueryDiviner.js +33 -0
  41. package/dist/cjs/contexts/useNodeQueryDiviner.js.map +1 -0
  42. package/dist/cjs/contexts/useWitnessModule.d.ts +2 -1
  43. package/dist/cjs/contexts/useWitnessModule.d.ts.map +1 -1
  44. package/dist/cjs/contexts/useWitnessModule.js +2 -2
  45. package/dist/cjs/contexts/useWitnessModule.js.map +1 -1
  46. package/dist/docs.json +526 -581
  47. package/dist/esm/components/Node.d.ts.map +1 -1
  48. package/dist/esm/components/Node.js +9 -2
  49. package/dist/esm/components/Node.js.map +1 -1
  50. package/dist/esm/components/NodeQueryDiviner.d.ts +3 -0
  51. package/dist/esm/components/NodeQueryDiviner.d.ts.map +1 -0
  52. package/dist/esm/components/NodeQueryDiviner.js +17 -0
  53. package/dist/esm/components/NodeQueryDiviner.js.map +1 -0
  54. package/dist/esm/contexts/Provider.d.ts +2 -2
  55. package/dist/esm/contexts/Provider.d.ts.map +1 -1
  56. package/dist/esm/contexts/Provider.js.map +1 -1
  57. package/dist/esm/contexts/State.d.ts +3 -3
  58. package/dist/esm/contexts/State.d.ts.map +1 -1
  59. package/dist/esm/contexts/index.d.ts +2 -0
  60. package/dist/esm/contexts/index.d.ts.map +1 -1
  61. package/dist/esm/contexts/index.js +2 -0
  62. package/dist/esm/contexts/index.js.map +1 -1
  63. package/dist/esm/contexts/useAddNamedModules.d.ts +5 -0
  64. package/dist/esm/contexts/useAddNamedModules.d.ts.map +1 -0
  65. package/dist/esm/contexts/useAddNamedModules.js +61 -0
  66. package/dist/esm/contexts/useAddNamedModules.js.map +1 -0
  67. package/dist/esm/contexts/useArchivistModule.d.ts +2 -1
  68. package/dist/esm/contexts/useArchivistModule.d.ts.map +1 -1
  69. package/dist/esm/contexts/useArchivistModule.js +2 -2
  70. package/dist/esm/contexts/useArchivistModule.js.map +1 -1
  71. package/dist/esm/contexts/useDivinerModule.d.ts +2 -1
  72. package/dist/esm/contexts/useDivinerModule.d.ts.map +1 -1
  73. package/dist/esm/contexts/useDivinerModule.js +2 -2
  74. package/dist/esm/contexts/useDivinerModule.js.map +1 -1
  75. package/dist/esm/contexts/useModuleAddresses.d.ts +1 -1
  76. package/dist/esm/contexts/useModuleAddresses.d.ts.map +1 -1
  77. package/dist/esm/contexts/useModules.d.ts +1 -1
  78. package/dist/esm/contexts/useModules.d.ts.map +1 -1
  79. package/dist/esm/contexts/useModules.js.map +1 -1
  80. package/dist/esm/contexts/useNode.d.ts +8 -2
  81. package/dist/esm/contexts/useNode.d.ts.map +1 -1
  82. package/dist/esm/contexts/useNode.js +1 -1
  83. package/dist/esm/contexts/useNode.js.map +1 -1
  84. package/dist/esm/contexts/useNodeQueryDiviner.d.ts +3 -0
  85. package/dist/esm/contexts/useNodeQueryDiviner.d.ts.map +1 -0
  86. package/dist/esm/contexts/useNodeQueryDiviner.js +27 -0
  87. package/dist/esm/contexts/useNodeQueryDiviner.js.map +1 -0
  88. package/dist/esm/contexts/useWitnessModule.d.ts +2 -1
  89. package/dist/esm/contexts/useWitnessModule.d.ts.map +1 -1
  90. package/dist/esm/contexts/useWitnessModule.js +2 -2
  91. package/dist/esm/contexts/useWitnessModule.js.map +1 -1
  92. package/package.json +13 -13
  93. package/src/components/Node.stories.tsx +37 -0
  94. package/src/components/Node.tsx +13 -2
  95. package/src/components/NodeQueryDiviner.stories.tsx +31 -0
  96. package/src/components/NodeQueryDiviner.tsx +28 -0
  97. package/src/contexts/Provider.tsx +3 -3
  98. package/src/contexts/State.ts +3 -3
  99. package/src/contexts/index.ts +2 -0
  100. package/src/contexts/useAddNamedModules.tsx +72 -0
  101. package/src/contexts/useArchivistModule.ts +3 -2
  102. package/src/contexts/useDivinerModule.ts +3 -2
  103. package/src/contexts/useModules.ts +2 -1
  104. package/src/contexts/useNode.ts +4 -4
  105. package/src/contexts/useNodeQueryDiviner.tsx +34 -0
  106. package/src/contexts/useWitnessModule.ts +3 -2
@@ -0,0 +1,28 @@
1
+ import { Button, TextField } from '@mui/material'
2
+ import { FlexCol } from '@xylabs/react-flexbox'
3
+ import { XyoPayload, XyoPayloadBuilder } from '@xyo-network/payload'
4
+ import { useState } from 'react'
5
+
6
+ import { useNodeQueryDiviner } from '../contexts'
7
+
8
+ export const NodeQueryDiviner: React.FC = () => {
9
+ const [query, setQuery] = useState<XyoPayload>()
10
+ const [address, setAddress] = useState('')
11
+ const [result, error] = useNodeQueryDiviner('AddressHistoryDiviner', query)
12
+
13
+ const onClick = () => {
14
+ const query = new XyoPayloadBuilder({ schema: 'network.xyo.diviner.address.query' }).fields({ address }).build()
15
+ setQuery(query)
16
+ }
17
+
18
+ return (
19
+ <FlexCol rowGap={2}>
20
+ <TextField placeholder="Address on localhost" onChange={(event) => setAddress(event.target.value)} />
21
+ <Button disabled={!address} variant={'contained'} onClick={onClick}>
22
+ divine
23
+ </Button>
24
+ <code style={{ overflowWrap: 'anywhere' }}>{JSON.stringify(result, null, 2)}</code>
25
+ <code style={{ overflowWrap: 'anywhere' }}>{JSON.stringify(error, null, 2)}</code>
26
+ </FlexCol>
27
+ )
28
+ }
@@ -1,19 +1,19 @@
1
1
  import { WithChildren } from '@xylabs/react-shared'
2
- import { AbstractNode } from '@xyo-network/node'
2
+ import { NodeModule } from '@xyo-network/node'
3
3
  import { useEffect, useState } from 'react'
4
4
 
5
5
  import { NodeContext } from './Context'
6
6
 
7
7
  export interface NodeProviderProps {
8
8
  required?: boolean
9
- node?: AbstractNode
9
+ node?: NodeModule
10
10
  }
11
11
 
12
12
  /** @deprecated use NodeProviderProps instead */
13
13
  export type XyoNodeProviderProps = NodeProviderProps
14
14
 
15
15
  export const NodeProvider: React.FC<WithChildren<NodeProviderProps>> = ({ node: nodeProp, required = false, children }) => {
16
- const [node, setNode] = useState<AbstractNode>()
16
+ const [node, setNode] = useState<NodeModule>()
17
17
 
18
18
  useEffect(() => {
19
19
  setNode(nodeProp)
@@ -1,7 +1,7 @@
1
- import { AbstractNode } from '@xyo-network/node'
1
+ import { NodeModule } from '@xyo-network/node'
2
2
  import { Dispatch } from 'react'
3
3
 
4
4
  export interface NodeContextState {
5
- node?: AbstractNode
6
- setNode?: Dispatch<AbstractNode>
5
+ node?: NodeModule
6
+ setNode?: Dispatch<NodeModule>
7
7
  }
@@ -3,6 +3,7 @@ export * from './MemoryProvider'
3
3
  export * from './NodeDrawerContext'
4
4
  export * from './Provider'
5
5
  export * from './State'
6
+ export * from './useAddNamedModules'
6
7
  export * from './useArchivistModule'
7
8
  export * from './useArchivistModules'
8
9
  export * from './useDivinerModule'
@@ -10,5 +11,6 @@ export * from './useDivinerModules'
10
11
  export * from './useModuleAddresses'
11
12
  export * from './useModules'
12
13
  export * from './useNode'
14
+ export * from './useNodeQueryDiviner'
13
15
  export * from './useWitnessModule'
14
16
  export * from './useWitnessModules'
@@ -0,0 +1,72 @@
1
+ import { useAsyncEffect } from '@xylabs/react-shared'
2
+ import { ApiConfig } from '@xylabs/sdk-js'
3
+ import { ArchivistWrapper } from '@xyo-network/archivist'
4
+ import { DivinerWrapper } from '@xyo-network/diviner'
5
+ import { HttpProxyModule } from '@xyo-network/http-proxy-module'
6
+ import { AbstractModuleConfigSchema, Module, ModuleWrapper } from '@xyo-network/module'
7
+ import { MemoryNode } from '@xyo-network/node'
8
+ import { useState } from 'react'
9
+
10
+ import { useNode } from './useNode'
11
+
12
+ type ModuleList = Record<string, symbol>
13
+
14
+ const addWrapper = (remoteModule: Module) => {
15
+ let wrapper: ModuleWrapper | undefined
16
+ if (remoteModule.config.schema.includes('divine')) {
17
+ wrapper = new DivinerWrapper(remoteModule)
18
+ } else if (remoteModule.config.schema.includes('archivist')) {
19
+ wrapper = new ArchivistWrapper(remoteModule)
20
+ }
21
+ return wrapper
22
+ }
23
+
24
+ const addToNode = (remoteModule: Module, name: string, memoryNode: MemoryNode) => {
25
+ const wrapper = addWrapper(remoteModule)
26
+ memoryNode.register(wrapper ?? remoteModule)
27
+ memoryNode.attach(remoteModule.address, name)
28
+ console.log('attached:', name)
29
+ }
30
+
31
+ const resolveNode = async (node: MemoryNode, reset?: boolean) => {
32
+ let localNode = node
33
+ if (reset) {
34
+ localNode = await MemoryNode.create()
35
+ }
36
+ return localNode
37
+ }
38
+
39
+ export const useAddNamedModules = (moduleList?: ModuleList, apiConfig?: ApiConfig, reset = false) => {
40
+ const [node, setNode] = useNode<MemoryNode>()
41
+ const [complete, setComplete] = useState(false)
42
+
43
+ useAsyncEffect(
44
+ // eslint-disable-next-line react-hooks/exhaustive-deps
45
+ async () => {
46
+ if (moduleList && apiConfig && node && !complete) {
47
+ const localNode = await resolveNode(node, reset)
48
+ await Promise.allSettled(
49
+ Object.entries(moduleList).map(async ([_key, { description }]) => {
50
+ try {
51
+ const remoteModule = await HttpProxyModule.create({
52
+ apiConfig,
53
+ config: { schema: AbstractModuleConfigSchema },
54
+ name: description,
55
+ })
56
+
57
+ addToNode(remoteModule, description ?? 'unknown', localNode)
58
+ // using .assign instead of spread because we need to keep the prototype chain intact for root node / module methods
59
+ const newNode = Object.assign(Object.create(Object.getPrototypeOf(node)), node)
60
+ setNode?.(newNode)
61
+ setComplete(true)
62
+ } catch (error) {
63
+ console.log(error)
64
+ }
65
+ }),
66
+ )
67
+ }
68
+ },
69
+ [apiConfig, complete, moduleList, node, reset, setNode],
70
+ )
71
+ return complete
72
+ }
@@ -1,9 +1,10 @@
1
1
  import { ArchivistWrapper } from '@xyo-network/archivist'
2
+ import { ModuleFilter } from '@xyo-network/module'
2
3
 
3
4
  import { useModules } from './useModules'
4
5
 
5
- export const useArchivistModule = (address?: string) => {
6
- const modules = useModules({ address: address ? [address] : undefined })
6
+ export const useArchivistModule = (filter?: ModuleFilter) => {
7
+ const modules = useModules(filter)
7
8
  const foundModule = modules?.shift()
8
9
  return foundModule ? new ArchivistWrapper(foundModule) : undefined
9
10
  }
@@ -1,9 +1,10 @@
1
1
  import { DivinerWrapper } from '@xyo-network/diviner'
2
+ import { ModuleFilter } from '@xyo-network/module'
2
3
 
3
4
  import { useModules } from './useModules'
4
5
 
5
- export const useDivinerModule = (address?: string) => {
6
- const modules = useModules({ address: address ? [address] : undefined })
6
+ export const useDivinerModule = (filter?: ModuleFilter) => {
7
+ const modules = useModules(filter)
7
8
  const foundModule = modules?.shift()
8
9
  return foundModule ? new DivinerWrapper(foundModule) : undefined
9
10
  }
@@ -1,11 +1,12 @@
1
1
  import { useAsyncEffect } from '@xylabs/react-shared'
2
2
  import { Module, ModuleFilter } from '@xyo-network/module'
3
+ import { AbstractNode } from '@xyo-network/node'
3
4
  import { useState } from 'react'
4
5
 
5
6
  import { useNode } from './useNode'
6
7
 
7
8
  export const useModules = (filter?: ModuleFilter) => {
8
- const [node] = useNode()
9
+ const [node] = useNode<AbstractNode>()
9
10
  const [modules, setModules] = useState<Module[]>()
10
11
 
11
12
  useAsyncEffect(
@@ -1,11 +1,11 @@
1
- import { AbstractNode } from '@xyo-network/node'
1
+ import { NodeModule } from '@xyo-network/node'
2
2
  import { useContextEx } from '@xyo-network/react-shared'
3
3
  import { Dispatch } from 'react'
4
4
 
5
5
  import { NodeContext } from './Context'
6
6
 
7
- export const useNode = (): [AbstractNode | undefined, Dispatch<AbstractNode> | undefined] => {
8
- const { node, setNode } = useContextEx(NodeContext, 'XyoNode')
7
+ export const useNode = <T extends NodeModule = NodeModule>(): [T | undefined, Dispatch<NodeModule> | undefined] => {
8
+ const { node, setNode } = useContextEx(NodeContext, 'Node')
9
9
 
10
- return [node, setNode]
10
+ return [node as T, setNode]
11
11
  }
@@ -0,0 +1,34 @@
1
+ import { useAsyncEffect } from '@xylabs/react-shared'
2
+ import { DivinerWrapper } from '@xyo-network/diviner'
3
+ import { MemoryNode } from '@xyo-network/node'
4
+ import { XyoPayload, XyoPayloads } from '@xyo-network/payload'
5
+ import { useState } from 'react'
6
+
7
+ import { useNode } from './useNode'
8
+
9
+ export const useNodeQueryDiviner = (moduleIdentifier?: string, query?: XyoPayload): [XyoPayloads | undefined, Error | undefined] => {
10
+ const [result, setResult] = useState<XyoPayloads>()
11
+ const [error, setError] = useState<Error>()
12
+ const [node] = useNode<MemoryNode>()
13
+
14
+ useAsyncEffect(
15
+ // eslint-disable-next-line react-hooks/exhaustive-deps
16
+ async () => {
17
+ if (moduleIdentifier && query) {
18
+ try {
19
+ const diviner = (await node?.tryResolve({ name: [moduleIdentifier] }))?.[0] as DivinerWrapper
20
+ const result = await diviner?.divine([query])
21
+ setResult(result)
22
+ setError(undefined)
23
+ } catch (e) {
24
+ console.error(e)
25
+ setResult(undefined)
26
+ setError(e as Error)
27
+ }
28
+ }
29
+ },
30
+ [moduleIdentifier, node, query],
31
+ )
32
+
33
+ return [result, error]
34
+ }
@@ -1,9 +1,10 @@
1
+ import { ModuleFilter } from '@xyo-network/module'
1
2
  import { WitnessWrapper } from '@xyo-network/witness'
2
3
 
3
4
  import { useModules } from './useModules'
4
5
 
5
- export const useWitnessModule = (address?: string) => {
6
- const modules = useModules({ address: address ? [address] : undefined })
6
+ export const useWitnessModule = (filter?: ModuleFilter) => {
7
+ const modules = useModules(filter)
7
8
  const foundModule = modules?.shift()
8
9
  return foundModule ? new WitnessWrapper(foundModule) : undefined
9
10
  }