@xyo-network/react-node 2.75.2 → 2.75.4

package/src/hooks/useNodeFromNode.tsx

@@ -1,12 +1,15 @@
 import { asNodeInstance, NodeInstance } from '@xyo-network/node-model'
 
 import { ModuleFromNodeConfig } from './ModuleFromNodeConfig'
+// eslint-disable-next-line import/no-deprecated
 import { useModuleFromNode } from './useModuleFromNode'
 
+/** @deprecated use useWeakNodeFromNode instead */
 export const useNodeFromNode = (
   nameOrAddressOrInstance?: string | NodeInstance,
   config?: ModuleFromNodeConfig,
 ): [NodeInstance | undefined, Error | undefined] => {
+  // eslint-disable-next-line import/no-deprecated, deprecation/deprecation
   const [module, error] = useModuleFromNode(nameOrAddressOrInstance, config)
   const instance = asNodeInstance(module)
   if (module && !instance) {

package/src/hooks/useNodesFromNode.tsx

@@ -2,9 +2,12 @@ import { ModuleFilter } from '@xyo-network/module-model'
 import { isNodeInstance, NodeInstance } from '@xyo-network/node-model'
 
 import { ModuleFromNodeConfig } from './ModuleFromNodeConfig'
+// eslint-disable-next-line import/no-deprecated
 import { useModulesFromNode } from './useModulesFromNode'
 
+/** @deprecated use useWeakNodesFromNode */
 export const useNodesFromNode = (filter?: ModuleFilter, config?: ModuleFromNodeConfig): [NodeInstance[] | null | undefined, Error | undefined] => {
+  // eslint-disable-next-line import/no-deprecated, deprecation/deprecation
   const [modules, error] = useModulesFromNode(filter, config)
   if (error) {
     return [null, error]

package/src/hooks/useWeakNode.ts

@@ -0,0 +1,18 @@
+import { usePromise } from '@xylabs/react-promise'
+import { asNodeInstance, NodeInstance } from '@xyo-network/node-model'
+
+import { useWeakProvidedNode } from './provided'
+import { useWeakNodeConfigNodeField } from './useWeakNodeConfigNodeField'
+import { WeakModuleFromNodeConfig } from './WeakModuleFromNodeConfig'
+
+export const useWeakNode = (config?: WeakModuleFromNodeConfig | undefined): [WeakRef<NodeInstance> | undefined, Error | undefined] => {
+  const [nodeAddress, nodeInstance] = useWeakNodeConfigNodeField(config)
+  const [providedNode] = useWeakProvidedNode()
+  const [nodeAddressNode, error] = usePromise(async () => {
+    const providedNodeInstance = providedNode?.deref()
+    if (providedNodeInstance && nodeAddress) {
+      return new WeakRef(asNodeInstance(await providedNodeInstance.resolve(nodeAddress), 'Module is not a node'))
+    }
+  }, [providedNode, nodeAddress])
+  return [nodeAddressNode ?? nodeInstance ?? providedNode ?? undefined, error]
+}

package/src/hooks/useWeakNodeDescription.ts

@@ -0,0 +1,15 @@
+import { usePromise } from '@xylabs/react-promise'
+import { ModuleDescription, ModuleDescriptionPayload, ModuleDescriptionSchema } from '@xyo-network/module-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import { useWeakNode } from './useWeakNode'
+import { WeakModuleFromNodeConfig } from './WeakModuleFromNodeConfig'
+
+export const useWeakNodeDescription = (config?: WeakModuleFromNodeConfig | undefined): [ModuleDescription | undefined, Error | undefined] => {
+  const [activeNode, nodeError] = useWeakNode(config)
+  const [description, error] = usePromise(async () => {
+    const state = await activeNode?.deref()?.state()
+    return state?.find<ModuleDescriptionPayload>(isPayloadOfSchemaType(ModuleDescriptionSchema))
+  }, [activeNode])
+  return [description, nodeError ?? error]
+}

package/src/hooks/useWeakNodeFromNode.tsx

@@ -0,0 +1,11 @@
+import { isNodeInstance, NodeInstance } from '@xyo-network/node-model'
+
+import { ModuleFromNodeConfig } from './ModuleFromNodeConfig'
+import { useWeakModuleFromNode } from './useWeakModuleFromNode'
+
+export const useWeakNodeFromNode = (
+  nameOrAddressOrInstance?: string | NodeInstance,
+  config?: ModuleFromNodeConfig,
+): [WeakRef<NodeInstance> | undefined, Error | undefined] => {
+  return useWeakModuleFromNode<NodeInstance>(nameOrAddressOrInstance, { identity: isNodeInstance, ...config })
+}

package/src/hooks/useWeakNodesFromNode.tsx

@@ -0,0 +1,25 @@
+import { exists } from '@xylabs/exists'
+import { ModuleFilter } from '@xyo-network/module-model'
+import { asNodeInstance, NodeInstance } from '@xyo-network/node-model'
+
+import { ModuleFromNodeConfig } from './ModuleFromNodeConfig'
+import { useWeakModulesFromNode } from './useWeakModulesFromNode'
+
+export const useWeakNodesFromNode = (
+  filter?: ModuleFilter,
+  config?: ModuleFromNodeConfig,
+): [WeakRef<NodeInstance>[] | null | undefined, Error | undefined] => {
+  const [modules, error] = useWeakModulesFromNode(filter, config)
+  if (error) {
+    return [null, error]
+  }
+  return modules ?
+      [
+        modules
+          .map((module) => asNodeInstance(module?.deref()))
+          .filter(exists)
+          .map((module) => new WeakRef(module)),
+        undefined,
+      ]
+    : [modules, error]
+}