@xyo-network/react-node 2.45.0-rc.3 → 2.45.0-rc.4

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 (13) hide show
  1. package/dist/cjs/hooks/createUseModuleHook.js +6 -3
  2. package/dist/cjs/hooks/createUseModuleHook.js.map +1 -1
  3. package/dist/docs.json +356 -155
  4. package/dist/esm/hooks/createUseModuleHook.js +6 -3
  5. package/dist/esm/hooks/createUseModuleHook.js.map +1 -1
  6. package/dist/types/hooks/createUseModuleHook.d.ts +1 -0
  7. package/dist/types/hooks/createUseModuleHook.d.ts.map +1 -1
  8. package/dist/types/hooks/useModule.d.ts +11 -0
  9. package/dist/types/hooks/useModule.d.ts.map +1 -1
  10. package/dist/types/hooks/useNode.d.ts +1 -0
  11. package/dist/types/hooks/useNode.d.ts.map +1 -1
  12. package/package.json +2 -2
  13. package/src/hooks/createUseModuleHook.tsx +10 -3
package/dist/esm/hooks/createUseModuleHook.js CHANGED
@@ -2,7 +2,10 @@
2
2
  import { useAsyncEffect } from '@xylabs/react-shared';
3
3
  import { useState } from 'react';
4
4
  export const createUseModuleHook = (wrapFunc, useNodeHook) => {
5
- function use(nameOrAddress, wrap = false) {
5
+ function use(nameOrAddressOrWrapOrAccount, wrap = false) {
6
+ const shouldWrap = typeof nameOrAddressOrWrapOrAccount === 'boolean' ? nameOrAddressOrWrapOrAccount : wrap;
7
+ const account = typeof nameOrAddressOrWrapOrAccount === 'object' ? nameOrAddressOrWrapOrAccount : typeof wrap === 'boolean' ? undefined : wrap;
8
+ const nameOrAddress = typeof nameOrAddressOrWrapOrAccount === 'string' ? nameOrAddressOrWrapOrAccount : undefined;
6
9
  const [node, nodeError] = useNodeHook(nameOrAddress, true);
7
10
  const [module, setModule] = useState();
8
11
  const [error, setError] = useState();
@@ -16,7 +19,7 @@ export const createUseModuleHook = (wrapFunc, useNodeHook) => {
16
19
  }
17
20
  else {
18
21
  const module = await node?.resolve(nameOrAddress);
19
- const finalModule = wrap ? wrapFunc(module, typeof wrap === 'boolean' ? undefined : wrap) : module;
22
+ const finalModule = shouldWrap ? wrapFunc(module, account) : module;
20
23
  if (mounted()) {
21
24
  setModule(finalModule);
22
25
  }
@@ -28,7 +31,7 @@ export const createUseModuleHook = (wrapFunc, useNodeHook) => {
28
31
  setModule(undefined);
29
32
  }
30
33
  }
31
- }, [wrap, node, nameOrAddress, nodeError]);
34
+ }, [wrap, node, nameOrAddress, nodeError, shouldWrap, account]);
32
35
  return [module, error];
33
36
  }
34
37
  return use;
package/dist/esm/hooks/createUseModuleHook.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"createUseModuleHook.js","sourceRoot":"","sources":["../../../src/hooks/createUseModuleHook.tsx"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAOhC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAKjC,QAAmB,EACnB,WAA4G,EAC5G,EAAE;IAKF,SAAS,GAAG,CAAC,aAAsB,EAAE,OAA0B,KAAK;QAClE,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;QAC1D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,EAAsB,CAAA;QAC1D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAS,CAAA;QAC3C,cAAc;QACZ,uDAAuD;QACvD,KAAK,EAAE,OAAO,EAAE,EAAE;YAChB,IAAI;gBACF,IAAI,SAAS,EAAE;oBACb,QAAQ,CAAC,SAAS,CAAC,CAAA;oBACnB,SAAS,CAAC,SAAS,CAAC,CAAA;iBACrB;qBAAM;oBACL,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,OAAO,CAAU,aAAa,CAAC,CAAA;oBAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;oBAClG,IAAI,OAAO,EAAE,EAAE;wBACb,SAAS,CAAC,WAAW,CAAC,CAAA;qBACvB;iBACF;aACF;YAAC,OAAO,EAAE,EAAE;gBACX,IAAI,OAAO,EAAE,EAAE;oBACb,QAAQ,CAAC,EAAW,CAAC,CAAA;oBACrB,SAAS,CAAC,SAAS,CAAC,CAAA;iBACrB;aACF;QACH,CAAC,EACD,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,CAAC,CACvC,CAAA;QAED,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACxB,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA"}
1
+ {"version":3,"file":"createUseModuleHook.js","sourceRoot":"","sources":["../../../src/hooks/createUseModuleHook.tsx"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAOhC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAKjC,QAAmB,EACnB,WAA4G,EAC5G,EAAE;IAMF,SAAS,GAAG,CACV,4BAAyD,EACzD,OAA0B,KAAK;QAE/B,MAAM,UAAU,GAAG,OAAO,4BAA4B,KAAK,SAAS,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAA;QAC1G,MAAM,OAAO,GAAG,OAAO,4BAA4B,KAAK,QAAQ,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAA;QAC9I,MAAM,aAAa,GAAG,OAAO,4BAA4B,KAAK,QAAQ,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,SAAS,CAAA;QACjH,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;QAC1D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,EAAsB,CAAA;QAC1D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAS,CAAA;QAC3C,cAAc;QACZ,uDAAuD;QACvD,KAAK,EAAE,OAAO,EAAE,EAAE;YAChB,IAAI;gBACF,IAAI,SAAS,EAAE;oBACb,QAAQ,CAAC,SAAS,CAAC,CAAA;oBACnB,SAAS,CAAC,SAAS,CAAC,CAAA;iBACrB;qBAAM;oBACL,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,OAAO,CAAU,aAAa,CAAC,CAAA;oBAC1D,MAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;oBACnE,IAAI,OAAO,EAAE,EAAE;wBACb,SAAS,CAAC,WAAW,CAAC,CAAA;qBACvB;iBACF;aACF;YAAC,OAAO,EAAE,EAAE;gBACX,IAAI,OAAO,EAAE,EAAE;oBACb,QAAQ,CAAC,EAAW,CAAC,CAAA;oBACrB,SAAS,CAAC,SAAS,CAAC,CAAA;iBACrB;aACF;QACH,CAAC,EACD,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,CAC5D,CAAA;QAED,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACxB,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA"}
package/dist/types/hooks/createUseModuleHook.d.ts CHANGED
@@ -45,6 +45,7 @@ export declare const createUseModuleHook: <TModule extends Module<import("@xyo-n
45
45
  }>>, TWrapFunc extends WrapFunc<TModule, TWrapper> = WrapFunc<TModule, TWrapper>>(wrapFunc: TWrapFunc, useNodeHook: (nodeOrAddress: string | undefined, wrap: true) => [NodeWrapper | undefined, Error | undefined]) => {
46
46
  (name?: string): [TModule | undefined, Error | undefined];
47
47
  (name: string | undefined, wrap: true | Account): [TWrapper | undefined, Error | undefined];
48
+ (wrap: true | Account): [TWrapper | undefined, Error | undefined];
48
49
  (address: string): [TModule | undefined, Error | undefined];
49
50
  (address: string, wrap: true | Account): [TWrapper | undefined, Error | undefined];
50
51
  };
package/dist/types/hooks/createUseModuleHook.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"createUseModuleHook.d.ts","sourceRoot":"","sources":["../../../src/hooks/createUseModuleHook.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAG/C,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,EAAE,QAAQ,SAAS,aAAa,GAAG,aAAa,IAAI,CACtG,MAAM,CAAC,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,OAAO,KACd,QAAQ,GAAG,SAAS,CAAA;AAEzB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oIAMD,MAAM,GAAG,SAAS,QAAQ,IAAI,KAAK,CAAC,WAAW,GAAG,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC;YAExF,MAAM;WACP,MAAM,GAAG,SAAS,QAAQ,IAAI,GAAG,OAAO;cACrC,MAAM;cACN,MAAM,QAAQ,IAAI,GAAG,OAAO;CAgCnD,CAAA"}
1
+ {"version":3,"file":"createUseModuleHook.d.ts","sourceRoot":"","sources":["../../../src/hooks/createUseModuleHook.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAG/C,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,EAAE,QAAQ,SAAS,aAAa,GAAG,aAAa,IAAI,CACtG,MAAM,CAAC,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,OAAO,KACd,QAAQ,GAAG,SAAS,CAAA;AAEzB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oIAMD,MAAM,GAAG,SAAS,QAAQ,IAAI,KAAK,CAAC,WAAW,GAAG,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC;YAExF,MAAM;WACP,MAAM,GAAG,SAAS,QAAQ,IAAI,GAAG,OAAO;WACxC,IAAI,GAAG,OAAO;cACX,MAAM;cACN,MAAM,QAAQ,IAAI,GAAG,OAAO;CAsCnD,CAAA"}
package/dist/types/hooks/useModule.d.ts CHANGED
@@ -22,6 +22,17 @@ export declare const useModule: {
22
22
  } & {
23
23
  schema: string;
24
24
  }>> | undefined, Error | undefined];
25
+ (wrap: true | import("@xyo-network/account").Account): [ModuleWrapper<Module<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
26
+ name?: string | undefined;
27
+ security?: {
28
+ allowAnonymous?: boolean | undefined;
29
+ allowed?: Record<string, (string | import("@xyo-network/module").CosigningAddressSet)[]> | undefined;
30
+ disallowed?: Record<string, string[]> | undefined;
31
+ } | undefined;
32
+ storeQueries?: boolean | undefined;
33
+ } & {
34
+ schema: string;
35
+ }>> | undefined, Error | undefined];
25
36
  (address: string): [Module<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
26
37
  name?: string | undefined;
27
38
  security?: {
package/dist/types/hooks/useModule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"useModule.d.ts","sourceRoot":"","sources":["../../../src/hooks/useModule.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAK3D,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA0E,CAAA"}
1
+ {"version":3,"file":"useModule.d.ts","sourceRoot":"","sources":["../../../src/hooks/useModule.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAK3D,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA0E,CAAA"}
package/dist/types/hooks/useNode.d.ts CHANGED
@@ -2,6 +2,7 @@ import { NodeModule, NodeWrapper } from '@xyo-network/node';
2
2
  export declare const useNode: {
3
3
  (name?: string | undefined): [NodeModule | undefined, Error | undefined];
4
4
  (name: string | undefined, wrap: true | import("@xyo-network/account").Account): [NodeWrapper | undefined, Error | undefined];
5
+ (wrap: true | import("@xyo-network/account").Account): [NodeWrapper | undefined, Error | undefined];
5
6
  (address: string): [NodeModule | undefined, Error | undefined];
6
7
  (address: string, wrap: true | import("@xyo-network/account").Account): [NodeWrapper | undefined, Error | undefined];
7
8
  };
package/dist/types/hooks/useNode.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"useNode.d.ts","sourceRoot":"","sources":["../../../src/hooks/useNode.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAK3D,eAAO,MAAM,OAAO;;;;;CAGlB,CAAA"}
1
+ {"version":3,"file":"useNode.d.ts","sourceRoot":"","sources":["../../../src/hooks/useNode.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAK3D,eAAO,MAAM,OAAO;;;;;;CAGlB,CAAA"}
package/package.json CHANGED
@@ -21,7 +21,7 @@
21
21
  "@xyo-network/module-model": "^2.51.1",
22
22
  "@xyo-network/node": "^2.51.1",
23
23
  "@xyo-network/payload-model": "^2.51.1",
24
- "@xyo-network/react-shared": "^2.45.0-rc.3",
24
+ "@xyo-network/react-shared": "^2.45.0-rc.4",
25
25
  "@xyo-network/witness": "^2.51.1"
26
26
  },
27
27
  "devDependencies": {
@@ -83,6 +83,6 @@
83
83
  },
84
84
  "sideEffects": false,
85
85
  "types": "dist/types/index.d.ts",
86
- "version": "2.45.0-rc.3",
86
+ "version": "2.45.0-rc.4",
87
87
  "stableVersion": "2.44.1"
88
88
  }
package/src/hooks/createUseModuleHook.tsx CHANGED
@@ -20,9 +20,16 @@ export const createUseModuleHook = <
20
20
  ) => {
21
21
  function use(name?: string): [TModule | undefined, Error | undefined]
22
22
  function use(name: string | undefined, wrap: true | Account): [TWrapper | undefined, Error | undefined]
23
+ function use(wrap: true | Account): [TWrapper | undefined, Error | undefined]
23
24
  function use(address: string): [TModule | undefined, Error | undefined]
24
25
  function use(address: string, wrap: true | Account): [TWrapper | undefined, Error | undefined]
25
- function use(nameOrAddress?: string, wrap: boolean | Account = false): [TWrapper | TModule | undefined, Error | undefined] {
26
+ function use(
27
+ nameOrAddressOrWrapOrAccount?: string | boolean | Account,
28
+ wrap: boolean | Account = false,
29
+ ): [TWrapper | TModule | undefined, Error | undefined] {
30
+ const shouldWrap = typeof nameOrAddressOrWrapOrAccount === 'boolean' ? nameOrAddressOrWrapOrAccount : wrap
31
+ const account = typeof nameOrAddressOrWrapOrAccount === 'object' ? nameOrAddressOrWrapOrAccount : typeof wrap === 'boolean' ? undefined : wrap
32
+ const nameOrAddress = typeof nameOrAddressOrWrapOrAccount === 'string' ? nameOrAddressOrWrapOrAccount : undefined
26
33
  const [node, nodeError] = useNodeHook(nameOrAddress, true)
27
34
  const [module, setModule] = useState<TModule | TWrapper>()
28
35
  const [error, setError] = useState<Error>()
@@ -35,7 +42,7 @@ export const createUseModuleHook = <
35
42
  setModule(undefined)
36
43
  } else {
37
44
  const module = await node?.resolve<TModule>(nameOrAddress)
38
- const finalModule = wrap ? wrapFunc(module, typeof wrap === 'boolean' ? undefined : wrap) : module
45
+ const finalModule = shouldWrap ? wrapFunc(module, account) : module
39
46
  if (mounted()) {
40
47
  setModule(finalModule)
41
48
  }
@@ -47,7 +54,7 @@ export const createUseModuleHook = <
47
54
  }
48
55
  }
49
56
  },
50
- [wrap, node, nameOrAddress, nodeError],
57
+ [wrap, node, nameOrAddress, nodeError, shouldWrap, account],
51
58
  )
52
59
 
53
60
  return [module, error]