@xyo-network/react-node 2.60.6 → 2.60.7

package/src/components/NodeDescriptionBox.tsx

@@ -0,0 +1,18 @@
+import { FlexBoxProps, FlexCol } from '@xylabs/react-flexbox'
+import { NodeInstance } from '@xyo-network/node-model'
+
+import { useNodeDescription } from '../hooks'
+
+export interface NodeDescriptionBoxProps extends FlexBoxProps {
+  node?: string | NodeInstance
+}
+
+export const NodeDescriptionBox: React.FC<NodeDescriptionBoxProps> = ({ node, ...props }) => {
+  const [description, error] = useNodeDescription({ node })
+
+  return (
+    <FlexCol {...props}>
+      <code color={error ? 'red' : undefined}>{error ? error.message : JSON.stringify(description, null, 2)}</code>
+    </FlexCol>
+  )
+}

package/src/components/NodeModulesBox.tsx

@@ -0,0 +1,18 @@
+import { FlexBoxProps, FlexCol } from '@xylabs/react-flexbox'
+import { NodeInstance } from '@xyo-network/node-model'
+
+import { useModulesFromNode } from '../hooks'
+
+export interface NodeDescriptionBoxProps extends FlexBoxProps {
+  node?: string | NodeInstance
+}
+
+export const NodeDescriptionBox: React.FC<NodeDescriptionBoxProps> = ({ node, ...props }) => {
+  const [description, error] = useModulesFromNode(undefined, { node })
+
+  return (
+    <FlexCol {...props}>
+      <code color={error ? 'red' : undefined}>{error ? error.message : JSON.stringify(description, null, 2)}</code>
+    </FlexCol>
+  )
+}

package/src/hooks/index.ts

@@ -1,4 +1,8 @@
 export * from './provided'
+export * from './useModuleFilterOptions'
 export * from './useModuleFromNode'
 export * from './useModulesFromNode'
+export * from './useNode'
+export * from './useNodeConfigNodeField'
+export * from './useNodeDescription'
 export * from './useNodeFromNode'

package/src/hooks/useModuleFilterOptions.ts

@@ -0,0 +1,6 @@
+import { ModuleFromNodeConfig } from './useModuleFromNode'
+
+export const useModuleFilterOptions = (config?: ModuleFromNodeConfig) => {
+  const { direction, identity, maxDepth, visibility } = config ?? {}
+  return { direction, identity, maxDepth, visibility }
+}

package/src/hooks/useModuleFromNode.ts

@@ -5,34 +5,40 @@ import { ModuleFilterOptions, ModuleInstance } from '@xyo-network/module-model'
 import { NodeInstance } from '@xyo-network/node-model'
 import { useState } from 'react'
 
-import { useProvidedNode } from './provided'
+import { useModuleFilterOptions } from './useModuleFilterOptions'
+import { useNode } from './useNode'
 
 export type ModuleFromNodeConfig = ModuleFilterOptions & {
   logger?: Logger
-  node?: NodeInstance
+  node?: NodeInstance | string
+}
+
+export const useModuleFromNodeConfigLogger = (config?: ModuleFromNodeConfig) => {
+  return config?.logger
 }
 
 export const useModuleFromNode = (nameOrAddress?: string, config?: ModuleFromNodeConfig): [ModuleInstance | undefined, Error | undefined] => {
-  const [providedNode] = useProvidedNode()
-  const { logger, node: paramNode, ...resolveConfig } = config ?? {}
+  console.log('useModuleFromNode')
+  const [node, nodeError] = useNode(config)
+  const logger = useModuleFromNodeConfigLogger(config)
+  const filterOptions = useModuleFilterOptions(config)
   const [result, setResult] = useState<ModuleInstance | undefined>()
   const [, error] = usePromise(async () => {
     logger?.debug('useModuleFromNode: resolving')
-    const activeNode = paramNode ?? providedNode
-    if (activeNode && nameOrAddress) {
-      activeNode.on('moduleAttached', ({ module }) => {
+    if (node && nameOrAddress) {
+      node.on('moduleAttached', ({ module }) => {
         logger?.debug(`useModuleFromNode: moduleAttached [${module.config.name ?? module.address}]`)
         if (module.address === nameOrAddress || module.config?.name === nameOrAddress) {
           setResult(asModuleInstance(module))
         }
       })
-      activeNode.on('moduleDetached', ({ module }) => {
+      node.on('moduleDetached', ({ module }) => {
         logger?.debug(`useModuleFromNode: moduleDetached [${module.config.name ?? module.address}]`)
         if (module.address === nameOrAddress || module.config?.name === nameOrAddress) {
           setResult(undefined)
         }
       })
-      const result = await activeNode.resolve(nameOrAddress, resolveConfig)
+      const result = await node.resolve(nameOrAddress, filterOptions)
       logger?.debug(`Result: ${result?.address}`)
       setResult(result)
       return result
@@ -40,6 +46,6 @@ export const useModuleFromNode = (nameOrAddress?: string, config?: ModuleFromNod
     logger?.debug('Result: No Node')
     return undefined
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [paramNode, providedNode, nameOrAddress])
-  return [result, error]
+  }, [node, nameOrAddress])
+  return [result, nodeError ?? error]
 }

package/src/hooks/useModulesFromNode.ts

@@ -3,34 +3,35 @@ import { ModuleFilter } from '@xyo-network/module'
 import { ModuleInstance } from '@xyo-network/module-model'
 import { useState } from 'react'
 
-import { useProvidedNode } from './provided'
+import { useModuleFilterOptions } from './useModuleFilterOptions'
 import { ModuleFromNodeConfig } from './useModuleFromNode'
+import { useNode } from './useNode'
 
 export const useModulesFromNode = (filter?: ModuleFilter, config?: ModuleFromNodeConfig): [ModuleInstance[] | undefined, Error | undefined] => {
-  const [providedNode] = useProvidedNode()
-  const { logger, node: paramNode, ...resolveConfig } = config ?? {}
+  const [node, nodeError] = useNode(config)
+  const logger = config?.logger
+  const filterOptions = useModuleFilterOptions()
   const [result, setResult] = useState<ModuleInstance[] | undefined>()
   const [, error] = usePromise(async () => {
     logger?.debug('useModuleFromNode: resolving')
-    const activeNode = paramNode ?? providedNode
-    if (activeNode) {
-      activeNode.on('moduleAttached', async ({ module }) => {
+    if (node) {
+      node.on('moduleAttached', async ({ module }) => {
         logger?.debug(`useModuleFromNode: moduleAttached [${module.config.name ?? module.address}]`)
-        const moduleInstances = await activeNode.resolve(filter, resolveConfig)
+        const moduleInstances = await node.resolve(filter, filterOptions)
         setResult(moduleInstances)
       })
-      activeNode.on('moduleDetached', async ({ module }) => {
+      node.on('moduleDetached', async ({ module }) => {
         logger?.debug(`useModuleFromNode: moduleDetached [${module.config.name ?? module.address}]`)
-        const moduleInstances = await activeNode.resolve(filter, resolveConfig)
+        const moduleInstances = await node.resolve(filter, filterOptions)
         setResult(moduleInstances)
       })
-      const moduleInstances = await activeNode.resolve(filter, resolveConfig)
+      const moduleInstances = await node.resolve(filter, filterOptions)
       setResult(moduleInstances)
       setResult(moduleInstances)
       return moduleInstances
     }
     console.log('Result: No Node')
     return undefined
-  }, [paramNode, providedNode, filter])
-  return [result, error]
+  }, [node, filter])
+  return [result, nodeError ?? error]
 }

package/src/hooks/useNode.ts

@@ -0,0 +1,17 @@
+import { usePromise } from '@xylabs/react-promise'
+import { asNodeInstance, NodeInstance } from '@xyo-network/node-model'
+
+import { useProvidedNode } from './provided'
+import { ModuleFromNodeConfig } from './useModuleFromNode'
+import { useNodeConfigNodeField } from './useNodeConfigNodeField'
+
+export const useNode = (config?: ModuleFromNodeConfig | undefined): [NodeInstance | undefined, Error | undefined] => {
+  const [nodeAddress, nodeInstance] = useNodeConfigNodeField(config)
+  const [providedNode] = useProvidedNode()
+  const [nodeAddressNode, error] = usePromise(async () => {
+    if (providedNode && nodeAddress) {
+      return asNodeInstance(await providedNode.resolve(nodeAddress), 'Module is not a node')
+    }
+  }, [providedNode, nodeAddress])
+  return [nodeAddressNode ?? nodeInstance ?? providedNode ?? undefined, error]
+}

package/src/hooks/useNodeConfigNodeField.ts

@@ -0,0 +1,10 @@
+import { NodeInstance } from '@xyo-network/node-model'
+import { useMemo } from 'react'
+
+import { ModuleFromNodeConfig } from './useModuleFromNode'
+
+export const useNodeConfigNodeField = (config?: ModuleFromNodeConfig | undefined): [string | undefined, NodeInstance | undefined] => {
+  const nodeAddress = useMemo(() => (typeof config?.node === 'string' ? config?.node : undefined), [config?.node])
+  const nodeInstance = useMemo(() => (typeof config?.node === 'object' ? config?.node : undefined), [config?.node])
+  return [nodeAddress, nodeInstance]
+}

package/src/hooks/useNodeDescription.ts

@@ -0,0 +1,13 @@
+import { usePromise } from '@xylabs/react-promise'
+import { ModuleDescription } from '@xyo-network/module-model'
+
+import { ModuleFromNodeConfig } from './useModuleFromNode'
+import { useNode } from './useNode'
+
+export const useNodeDescription = (config?: ModuleFromNodeConfig | undefined): [ModuleDescription | undefined, Error | undefined] => {
+  const [activeNode, nodeError] = useNode(config)
+  const [description, error] = usePromise(async () => {
+    return await activeNode?.describe()
+  }, [activeNode])
+  return [description, nodeError ?? error]
+}