@xyo-network/react-node 2.75.1 → 2.75.2

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 (48) hide show
  1. package/dist/browser/hooks/ModuleFromNodeConfig.d.cts +2 -2
  2. package/dist/browser/hooks/ModuleFromNodeConfig.d.cts.map +1 -1
  3. package/dist/browser/hooks/ModuleFromNodeConfig.d.mts +2 -2
  4. package/dist/browser/hooks/ModuleFromNodeConfig.d.mts.map +1 -1
  5. package/dist/browser/hooks/ModuleFromNodeConfig.d.ts +2 -2
  6. package/dist/browser/hooks/ModuleFromNodeConfig.d.ts.map +1 -1
  7. package/dist/browser/hooks/useModuleFromNode.d.cts +67 -1
  8. package/dist/browser/hooks/useModuleFromNode.d.cts.map +1 -1
  9. package/dist/browser/hooks/useModuleFromNode.d.mts +67 -1
  10. package/dist/browser/hooks/useModuleFromNode.d.mts.map +1 -1
  11. package/dist/browser/hooks/useModuleFromNode.d.ts +67 -1
  12. package/dist/browser/hooks/useModuleFromNode.d.ts.map +1 -1
  13. package/dist/browser/hooks/useWeakModuleFromNode.d.cts +56 -1
  14. package/dist/browser/hooks/useWeakModuleFromNode.d.cts.map +1 -1
  15. package/dist/browser/hooks/useWeakModuleFromNode.d.mts +56 -1
  16. package/dist/browser/hooks/useWeakModuleFromNode.d.mts.map +1 -1
  17. package/dist/browser/hooks/useWeakModuleFromNode.d.ts +56 -1
  18. package/dist/browser/hooks/useWeakModuleFromNode.d.ts.map +1 -1
  19. package/dist/browser/index.cjs +10 -9
  20. package/dist/browser/index.cjs.map +1 -1
  21. package/dist/browser/index.js +47 -46
  22. package/dist/browser/index.js.map +1 -1
  23. package/dist/node/hooks/ModuleFromNodeConfig.d.cts +2 -2
  24. package/dist/node/hooks/ModuleFromNodeConfig.d.cts.map +1 -1
  25. package/dist/node/hooks/ModuleFromNodeConfig.d.mts +2 -2
  26. package/dist/node/hooks/ModuleFromNodeConfig.d.mts.map +1 -1
  27. package/dist/node/hooks/ModuleFromNodeConfig.d.ts +2 -2
  28. package/dist/node/hooks/ModuleFromNodeConfig.d.ts.map +1 -1
  29. package/dist/node/hooks/useModuleFromNode.d.cts +67 -1
  30. package/dist/node/hooks/useModuleFromNode.d.cts.map +1 -1
  31. package/dist/node/hooks/useModuleFromNode.d.mts +67 -1
  32. package/dist/node/hooks/useModuleFromNode.d.mts.map +1 -1
  33. package/dist/node/hooks/useModuleFromNode.d.ts +67 -1
  34. package/dist/node/hooks/useModuleFromNode.d.ts.map +1 -1
  35. package/dist/node/hooks/useWeakModuleFromNode.d.cts +56 -1
  36. package/dist/node/hooks/useWeakModuleFromNode.d.cts.map +1 -1
  37. package/dist/node/hooks/useWeakModuleFromNode.d.mts +56 -1
  38. package/dist/node/hooks/useWeakModuleFromNode.d.mts.map +1 -1
  39. package/dist/node/hooks/useWeakModuleFromNode.d.ts +56 -1
  40. package/dist/node/hooks/useWeakModuleFromNode.d.ts.map +1 -1
  41. package/dist/node/index.cjs +10 -9
  42. package/dist/node/index.cjs.map +1 -1
  43. package/dist/node/index.js +47 -46
  44. package/dist/node/index.js.map +1 -1
  45. package/package.json +6 -5
  46. package/src/hooks/ModuleFromNodeConfig.ts +2 -2
  47. package/src/hooks/useModuleFromNode.ts +13 -9
  48. package/src/hooks/useWeakModuleFromNode.ts +13 -10
@@ -1,7 +1,8 @@
1
1
  /* eslint-disable import/no-deprecated */
2
2
  /* eslint-disable deprecation/deprecation */
3
+ import { TypeCheck } from '@xylabs/object'
3
4
  import { usePromise } from '@xylabs/react-promise'
4
- import { asModuleInstance, isModuleInstance, ModuleInstance } from '@xyo-network/module-model'
5
+ import { isModuleInstance, ModuleInstance } from '@xyo-network/module-model'
5
6
  import { useState } from 'react'
6
7
 
7
8
  import { ModuleFromNodeConfig, useModuleFromNodeConfigLogger } from './ModuleFromNodeConfig'
@@ -9,21 +10,24 @@ import { useModuleFilterOptions } from './useModuleFilterOptions'
9
10
  import { useNode } from './useNode'
10
11
 
11
12
  /** @deprecated use useWeakModuleFromNode */
12
- export const useModuleFromNode = (
13
- nameOrAddressOrInstance?: string | ModuleInstance,
14
- config?: ModuleFromNodeConfig,
15
- ): [ModuleInstance | undefined, Error | undefined] => {
13
+ export const useModuleFromNode = <T extends ModuleInstance | void = void>(
14
+ nameOrAddressOrInstance: string | (T extends ModuleInstance ? T : ModuleInstance) | undefined = undefined,
15
+ config?: T extends ModuleInstance ? ModuleFromNodeConfig<T> : ModuleFromNodeConfig | undefined,
16
+ ): [(T extends ModuleInstance ? T : ModuleInstance) | undefined, Error | undefined] => {
16
17
  const [node, nodeError] = useNode(config)
17
18
  const logger = useModuleFromNodeConfigLogger(config)
18
19
  const filterOptions = useModuleFilterOptions(config)
19
- const [result, setResult] = useState<ModuleInstance | undefined>()
20
+ const [result, setResult] = useState<(T extends ModuleInstance ? T : ModuleInstance) | undefined>()
20
21
  const [, error] = usePromise(async () => {
21
22
  logger?.debug('useModuleFromNode: resolving')
23
+ const identity: TypeCheck<T extends ModuleInstance ? T : ModuleInstance> = (config?.identity ?? isModuleInstance) as TypeCheck<
24
+ T extends ModuleInstance ? T : ModuleInstance
25
+ >
22
26
  if (node && nameOrAddressOrInstance) {
23
27
  node.on('moduleAttached', ({ module }) => {
24
28
  logger?.debug(`useModuleFromNode: moduleAttached [${module.config.name ?? module.address}]`)
25
29
  if (module.address === nameOrAddressOrInstance || module.config?.name === nameOrAddressOrInstance) {
26
- setResult(asModuleInstance(module))
30
+ setResult(identity(module) ? (module as T extends ModuleInstance ? T : ModuleInstance) : undefined)
27
31
  }
28
32
  })
29
33
  node.on('moduleDetached', ({ module }) => {
@@ -32,12 +36,12 @@ export const useModuleFromNode = (
32
36
  setResult(undefined)
33
37
  }
34
38
  })
35
- if (isModuleInstance(nameOrAddressOrInstance)) {
39
+ if (identity(nameOrAddressOrInstance)) {
36
40
  setResult(nameOrAddressOrInstance)
37
41
  } else {
38
42
  const result = await node.resolve(nameOrAddressOrInstance, filterOptions)
39
43
  logger?.debug(`Result: ${result?.address}`)
40
- setResult(result)
44
+ setResult(identity(module) ? (module as T extends ModuleInstance ? T : ModuleInstance) : undefined)
41
45
  }
42
46
  return result
43
47
  }
@@ -1,28 +1,31 @@
1
+ import { TypeCheck } from '@xylabs/object'
1
2
  import { usePromise } from '@xylabs/react-promise'
2
- import { asModuleInstance, isModuleInstance, ModuleInstance } from '@xyo-network/module-model'
3
+ import { isModuleInstance, ModuleInstance } from '@xyo-network/module-model'
3
4
  import { useState } from 'react'
4
5
 
5
6
  import { ModuleFromNodeConfig, useModuleFromNodeConfigLogger } from './ModuleFromNodeConfig'
6
7
  import { useModuleFilterOptions } from './useModuleFilterOptions'
7
8
  import { useNode } from './useNode'
8
9
 
9
- export const useWeakModuleFromNode = (
10
- nameOrAddressOrInstance?: string | ModuleInstance,
10
+ export const useWeakModuleFromNode = <T extends ModuleInstance | void = void>(
11
+ nameOrAddressOrInstance: string | (T extends ModuleInstance ? T : ModuleInstance) | undefined = undefined,
11
12
  config?: ModuleFromNodeConfig,
12
- ): [WeakRef<ModuleInstance> | undefined, Error | undefined] => {
13
+ ): [WeakRef<T extends ModuleInstance ? T : ModuleInstance> | undefined, Error | undefined] => {
13
14
  const [node, nodeError] = useNode(config)
14
15
  const logger = useModuleFromNodeConfigLogger(config)
15
16
  const filterOptions = useModuleFilterOptions(config)
16
- const [result, setResult] = useState<WeakRef<ModuleInstance> | undefined>()
17
+ const [result, setResult] = useState<WeakRef<T extends ModuleInstance ? T : ModuleInstance> | undefined>()
17
18
  const [, error] = usePromise(async () => {
18
19
  logger?.debug('useModuleFromNode: resolving')
20
+ const identity: TypeCheck<T extends ModuleInstance ? T : ModuleInstance> = (config?.identity ?? isModuleInstance) as TypeCheck<
21
+ T extends ModuleInstance ? T : ModuleInstance
22
+ >
19
23
  const nodeInstance = node
20
24
  if (nodeInstance && nameOrAddressOrInstance) {
21
25
  nodeInstance.on('moduleAttached', ({ module }) => {
22
26
  logger?.debug(`useModuleFromNode: moduleAttached [${module.config.name ?? module.address}]`)
23
27
  if (module.address === nameOrAddressOrInstance || module.config?.name === nameOrAddressOrInstance) {
24
- const instance = asModuleInstance(module)
25
- setResult(instance ? new WeakRef(instance) : undefined)
28
+ setResult(identity(module) ? new WeakRef(module as T extends ModuleInstance ? T : ModuleInstance) : undefined)
26
29
  }
27
30
  })
28
31
  nodeInstance.on('moduleDetached', ({ module }) => {
@@ -31,12 +34,12 @@ export const useWeakModuleFromNode = (
31
34
  setResult(undefined)
32
35
  }
33
36
  })
34
- if (isModuleInstance(nameOrAddressOrInstance)) {
35
- setResult(new WeakRef(nameOrAddressOrInstance))
37
+ if (identity(nameOrAddressOrInstance)) {
38
+ setResult(new WeakRef(nameOrAddressOrInstance as T extends ModuleInstance ? T : ModuleInstance))
36
39
  } else {
37
40
  const result = await nodeInstance.resolve(nameOrAddressOrInstance, filterOptions)
38
41
  logger?.debug(`Result: ${result?.address}`)
39
- setResult(result ? new WeakRef(result) : undefined)
42
+ setResult(identity(result) ? new WeakRef(result as T extends ModuleInstance ? T : ModuleInstance) : undefined)
40
43
  }
41
44
  return result
42
45
  }