@xyo-network/react-payload-diviner 2.32.0-rc.11

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 (131) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +70 -0
  3. package/dist/cjs/contexts/DivinedPayload/Context.d.ts +4 -0
  4. package/dist/cjs/contexts/DivinedPayload/Context.d.ts.map +1 -0
  5. package/dist/cjs/contexts/DivinedPayload/Context.js +6 -0
  6. package/dist/cjs/contexts/DivinedPayload/Context.js.map +1 -0
  7. package/dist/cjs/contexts/DivinedPayload/Provider.d.ts +10 -0
  8. package/dist/cjs/contexts/DivinedPayload/Provider.d.ts.map +1 -0
  9. package/dist/cjs/contexts/DivinedPayload/Provider.js +34 -0
  10. package/dist/cjs/contexts/DivinedPayload/Provider.js.map +1 -0
  11. package/dist/cjs/contexts/DivinedPayload/State.d.ts +9 -0
  12. package/dist/cjs/contexts/DivinedPayload/State.d.ts.map +1 -0
  13. package/dist/cjs/contexts/DivinedPayload/State.js +3 -0
  14. package/dist/cjs/contexts/DivinedPayload/State.js.map +1 -0
  15. package/dist/cjs/contexts/DivinedPayload/hooks/index.d.ts +2 -0
  16. package/dist/cjs/contexts/DivinedPayload/hooks/index.d.ts.map +1 -0
  17. package/dist/cjs/contexts/DivinedPayload/hooks/index.js +5 -0
  18. package/dist/cjs/contexts/DivinedPayload/hooks/index.js.map +1 -0
  19. package/dist/cjs/contexts/DivinedPayload/hooks/useBuildHuri.d.ts +2 -0
  20. package/dist/cjs/contexts/DivinedPayload/hooks/useBuildHuri.d.ts.map +1 -0
  21. package/dist/cjs/contexts/DivinedPayload/hooks/useBuildHuri.js +15 -0
  22. package/dist/cjs/contexts/DivinedPayload/hooks/useBuildHuri.js.map +1 -0
  23. package/dist/cjs/contexts/DivinedPayload/index.d.ts +4 -0
  24. package/dist/cjs/contexts/DivinedPayload/index.d.ts.map +1 -0
  25. package/dist/cjs/contexts/DivinedPayload/index.js +7 -0
  26. package/dist/cjs/contexts/DivinedPayload/index.js.map +1 -0
  27. package/dist/cjs/contexts/DivinedPayload/use.d.ts +2 -0
  28. package/dist/cjs/contexts/DivinedPayload/use.d.ts.map +1 -0
  29. package/dist/cjs/contexts/DivinedPayload/use.js +8 -0
  30. package/dist/cjs/contexts/DivinedPayload/use.js.map +1 -0
  31. package/dist/cjs/contexts/PayloadDiviner/Context.d.ts +5 -0
  32. package/dist/cjs/contexts/PayloadDiviner/Context.d.ts.map +1 -0
  33. package/dist/cjs/contexts/PayloadDiviner/Context.js +7 -0
  34. package/dist/cjs/contexts/PayloadDiviner/Context.js.map +1 -0
  35. package/dist/cjs/contexts/PayloadDiviner/Provider.d.ts +9 -0
  36. package/dist/cjs/contexts/PayloadDiviner/Provider.d.ts.map +1 -0
  37. package/dist/cjs/contexts/PayloadDiviner/Provider.js +21 -0
  38. package/dist/cjs/contexts/PayloadDiviner/Provider.js.map +1 -0
  39. package/dist/cjs/contexts/PayloadDiviner/State.d.ts +7 -0
  40. package/dist/cjs/contexts/PayloadDiviner/State.d.ts.map +1 -0
  41. package/dist/cjs/contexts/PayloadDiviner/State.js +3 -0
  42. package/dist/cjs/contexts/PayloadDiviner/State.js.map +1 -0
  43. package/dist/cjs/contexts/PayloadDiviner/index.d.ts +5 -0
  44. package/dist/cjs/contexts/PayloadDiviner/index.d.ts.map +1 -0
  45. package/dist/cjs/contexts/PayloadDiviner/index.js +8 -0
  46. package/dist/cjs/contexts/PayloadDiviner/index.js.map +1 -0
  47. package/dist/cjs/contexts/PayloadDiviner/use.d.ts +25 -0
  48. package/dist/cjs/contexts/PayloadDiviner/use.d.ts.map +1 -0
  49. package/dist/cjs/contexts/PayloadDiviner/use.js +79 -0
  50. package/dist/cjs/contexts/PayloadDiviner/use.js.map +1 -0
  51. package/dist/cjs/contexts/index.d.ts +3 -0
  52. package/dist/cjs/contexts/index.d.ts.map +1 -0
  53. package/dist/cjs/contexts/index.js +6 -0
  54. package/dist/cjs/contexts/index.js.map +1 -0
  55. package/dist/cjs/index.d.ts +2 -0
  56. package/dist/cjs/index.d.ts.map +1 -0
  57. package/dist/cjs/index.js +5 -0
  58. package/dist/cjs/index.js.map +1 -0
  59. package/dist/docs.json +1163 -0
  60. package/dist/esm/contexts/DivinedPayload/Context.d.ts +4 -0
  61. package/dist/esm/contexts/DivinedPayload/Context.d.ts.map +1 -0
  62. package/dist/esm/contexts/DivinedPayload/Context.js +3 -0
  63. package/dist/esm/contexts/DivinedPayload/Context.js.map +1 -0
  64. package/dist/esm/contexts/DivinedPayload/Provider.d.ts +10 -0
  65. package/dist/esm/contexts/DivinedPayload/Provider.d.ts.map +1 -0
  66. package/dist/esm/contexts/DivinedPayload/Provider.js +26 -0
  67. package/dist/esm/contexts/DivinedPayload/Provider.js.map +1 -0
  68. package/dist/esm/contexts/DivinedPayload/State.d.ts +9 -0
  69. package/dist/esm/contexts/DivinedPayload/State.d.ts.map +1 -0
  70. package/dist/esm/contexts/DivinedPayload/State.js +2 -0
  71. package/dist/esm/contexts/DivinedPayload/State.js.map +1 -0
  72. package/dist/esm/contexts/DivinedPayload/hooks/index.d.ts +2 -0
  73. package/dist/esm/contexts/DivinedPayload/hooks/index.d.ts.map +1 -0
  74. package/dist/esm/contexts/DivinedPayload/hooks/index.js +2 -0
  75. package/dist/esm/contexts/DivinedPayload/hooks/index.js.map +1 -0
  76. package/dist/esm/contexts/DivinedPayload/hooks/useBuildHuri.d.ts +2 -0
  77. package/dist/esm/contexts/DivinedPayload/hooks/useBuildHuri.d.ts.map +1 -0
  78. package/dist/esm/contexts/DivinedPayload/hooks/useBuildHuri.js +10 -0
  79. package/dist/esm/contexts/DivinedPayload/hooks/useBuildHuri.js.map +1 -0
  80. package/dist/esm/contexts/DivinedPayload/index.d.ts +4 -0
  81. package/dist/esm/contexts/DivinedPayload/index.d.ts.map +1 -0
  82. package/dist/esm/contexts/DivinedPayload/index.js +4 -0
  83. package/dist/esm/contexts/DivinedPayload/index.js.map +1 -0
  84. package/dist/esm/contexts/DivinedPayload/use.d.ts +2 -0
  85. package/dist/esm/contexts/DivinedPayload/use.d.ts.map +1 -0
  86. package/dist/esm/contexts/DivinedPayload/use.js +4 -0
  87. package/dist/esm/contexts/DivinedPayload/use.js.map +1 -0
  88. package/dist/esm/contexts/PayloadDiviner/Context.d.ts +5 -0
  89. package/dist/esm/contexts/PayloadDiviner/Context.d.ts.map +1 -0
  90. package/dist/esm/contexts/PayloadDiviner/Context.js +4 -0
  91. package/dist/esm/contexts/PayloadDiviner/Context.js.map +1 -0
  92. package/dist/esm/contexts/PayloadDiviner/Provider.d.ts +9 -0
  93. package/dist/esm/contexts/PayloadDiviner/Provider.d.ts.map +1 -0
  94. package/dist/esm/contexts/PayloadDiviner/Provider.js +17 -0
  95. package/dist/esm/contexts/PayloadDiviner/Provider.js.map +1 -0
  96. package/dist/esm/contexts/PayloadDiviner/State.d.ts +7 -0
  97. package/dist/esm/contexts/PayloadDiviner/State.d.ts.map +1 -0
  98. package/dist/esm/contexts/PayloadDiviner/State.js +2 -0
  99. package/dist/esm/contexts/PayloadDiviner/State.js.map +1 -0
  100. package/dist/esm/contexts/PayloadDiviner/index.d.ts +5 -0
  101. package/dist/esm/contexts/PayloadDiviner/index.d.ts.map +1 -0
  102. package/dist/esm/contexts/PayloadDiviner/index.js +5 -0
  103. package/dist/esm/contexts/PayloadDiviner/index.js.map +1 -0
  104. package/dist/esm/contexts/PayloadDiviner/use.d.ts +25 -0
  105. package/dist/esm/contexts/PayloadDiviner/use.d.ts.map +1 -0
  106. package/dist/esm/contexts/PayloadDiviner/use.js +70 -0
  107. package/dist/esm/contexts/PayloadDiviner/use.js.map +1 -0
  108. package/dist/esm/contexts/index.d.ts +3 -0
  109. package/dist/esm/contexts/index.d.ts.map +1 -0
  110. package/dist/esm/contexts/index.js +3 -0
  111. package/dist/esm/contexts/index.js.map +1 -0
  112. package/dist/esm/index.d.ts +2 -0
  113. package/dist/esm/index.d.ts.map +1 -0
  114. package/dist/esm/index.js +2 -0
  115. package/dist/esm/index.js.map +1 -0
  116. package/package.json +78 -0
  117. package/src/contexts/DivinedPayload/Context.tsx +5 -0
  118. package/src/contexts/DivinedPayload/Provider.tsx +46 -0
  119. package/src/contexts/DivinedPayload/State.ts +9 -0
  120. package/src/contexts/DivinedPayload/hooks/index.ts +1 -0
  121. package/src/contexts/DivinedPayload/hooks/useBuildHuri.tsx +12 -0
  122. package/src/contexts/DivinedPayload/index.ts +3 -0
  123. package/src/contexts/DivinedPayload/use.ts +5 -0
  124. package/src/contexts/PayloadDiviner/Context.ts +7 -0
  125. package/src/contexts/PayloadDiviner/Provider.tsx +32 -0
  126. package/src/contexts/PayloadDiviner/State.ts +7 -0
  127. package/src/contexts/PayloadDiviner/index.ts +4 -0
  128. package/src/contexts/PayloadDiviner/use.ts +95 -0
  129. package/src/contexts/index.ts +2 -0
  130. package/src/index.ts +1 -0
  131. package/src/types/images.d.ts +5 -0
@@ -0,0 +1,32 @@
1
+ import { XyoPayloadDiviner } from '@xyo-network/diviner'
2
+ import { ContextExProviderProps } from '@xyo-network/react-shared'
3
+ import { useEffect, useState } from 'react'
4
+
5
+ import { PayloadDivinerContext } from './Context'
6
+
7
+ export type PayloadDivinerProviderProps = ContextExProviderProps<{
8
+ /** Required */
9
+ diviner?: XyoPayloadDiviner
10
+ }>
11
+
12
+ export const PayloadDivinerProvider: React.FC<PayloadDivinerProviderProps> = ({ diviner: divinerProp, required = false, children }) => {
13
+ const [diviner, setDiviner] = useState<XyoPayloadDiviner | undefined>(divinerProp)
14
+
15
+ useEffect(() => {
16
+ if (divinerProp) {
17
+ setDiviner(divinerProp)
18
+ }
19
+ }, [divinerProp])
20
+
21
+ return (
22
+ <PayloadDivinerContext.Provider
23
+ value={{
24
+ diviner: diviner === divinerProp ? diviner : undefined,
25
+ provided: true,
26
+ setDiviner,
27
+ }}
28
+ >
29
+ {diviner ? children : required ? null : children}
30
+ </PayloadDivinerContext.Provider>
31
+ )
32
+ }
@@ -0,0 +1,7 @@
1
+ import { XyoPayloadDiviner } from '@xyo-network/diviner'
2
+ import { Dispatch } from 'react'
3
+
4
+ export interface PayloadDivinerState {
5
+ diviner?: XyoPayloadDiviner
6
+ setDiviner?: Dispatch<XyoPayloadDiviner>
7
+ }
@@ -0,0 +1,4 @@
1
+ export * from './Context'
2
+ export * from './Provider'
3
+ export * from './State'
4
+ export * from './use'
@@ -0,0 +1,95 @@
1
+ import { useAsyncEffect } from '@xylabs/react-shared'
2
+ import { XyoDivinerDivineQuerySchema, XyoHuriPayload, XyoHuriPayloadSchema } from '@xyo-network/diviner'
3
+ import { XyoPayload } from '@xyo-network/payload'
4
+ import { useContextEx } from '@xyo-network/react-shared'
5
+ import compact from 'lodash/compact'
6
+ import { Dispatch, useEffect, useState } from 'react'
7
+
8
+ import { PayloadDivinerContext } from './Context'
9
+
10
+ export const usePayloadDiviner = (required = false) => {
11
+ return useContextEx(PayloadDivinerContext, 'PayloadDiviner', required)
12
+ }
13
+
14
+ export const useDivinePayload = <T extends XyoPayload = XyoPayload>(
15
+ huri?: string,
16
+ ): [T | undefined | null, Dispatch<T | null | undefined>, Error | undefined] => {
17
+ const { diviner } = usePayloadDiviner()
18
+ const [payload, setPayload] = useState<T | null>()
19
+ const [error, setError] = useState<Error>()
20
+
21
+ useEffect(() => {
22
+ if (diviner) {
23
+ setPayload(undefined)
24
+ }
25
+ }, [diviner])
26
+
27
+ useAsyncEffect(
28
+ // eslint-disable-next-line react-hooks/exhaustive-deps
29
+ async (mounted) => {
30
+ if (huri && diviner && payload === undefined) {
31
+ try {
32
+ const huriPayload: XyoHuriPayload = { huri, schema: XyoHuriPayloadSchema }
33
+ const [, payloads] = (await diviner.query({ payloads: [huriPayload], schema: XyoDivinerDivineQuerySchema })) ?? []
34
+ if (mounted()) {
35
+ // if [0] returns undefined after the compact then no payloads were found so set payload state to null
36
+ const results = compact(payloads)[0] as T
37
+ setPayload(results ? results : null)
38
+ }
39
+ } catch (ex) {
40
+ if (mounted()) {
41
+ setError(ex as Error)
42
+ }
43
+ }
44
+ }
45
+ },
46
+ [diviner, huri, payload],
47
+ )
48
+
49
+ return [payload, setPayload, error]
50
+ }
51
+
52
+ export const useDivinePayloads = <T extends XyoPayload = XyoPayload>(
53
+ huriList: string[],
54
+ ): [(T | null)[] | undefined, Dispatch<(T | null)[] | undefined>, Error[] | undefined] => {
55
+ const { diviner } = usePayloadDiviner()
56
+ const [payloads, setPayloads] = useState<(T | null)[]>()
57
+ const [errors, setErrors] = useState<Error[]>()
58
+
59
+ useEffect(() => {
60
+ if (diviner) {
61
+ setPayloads(undefined)
62
+ }
63
+ }, [diviner])
64
+
65
+ useAsyncEffect(
66
+ // eslint-disable-next-line react-hooks/exhaustive-deps
67
+ async (mounted) => {
68
+ console.log(`huriList: ${JSON.stringify(huriList, null, 2)}`)
69
+ const payloads = await Promise.allSettled(
70
+ huriList.map(async (huri) => {
71
+ const huriPayload: XyoHuriPayload = { huri, schema: XyoHuriPayloadSchema }
72
+ const [, payloads] = (await diviner?.query({ payloads: [huriPayload], schema: XyoDivinerDivineQuerySchema })) ?? []
73
+ return compact(payloads)[0]
74
+ }),
75
+ )
76
+ if (mounted()) {
77
+ setPayloads([...payloads.values()].map((value) => (value.status === 'rejected' ? null : value.value)) as (T | null)[])
78
+ setErrors(
79
+ compact([...payloads.values()].map((value) => (value.status === 'rejected' ? Error('fivine failed', { cause: value.reason }) : undefined))),
80
+ )
81
+ if (mounted()) {
82
+ setPayloads([...payloads.values()].map((value) => (value.status === 'rejected' ? null : value.value)) as (T | null)[])
83
+ setErrors(
84
+ compact(
85
+ [...payloads.values()].map((value) => (value.status === 'rejected' ? Error('divine failed', { cause: value.reason }) : undefined)),
86
+ ),
87
+ )
88
+ }
89
+ }
90
+ },
91
+ [diviner, huriList, payloads],
92
+ )
93
+
94
+ return [payloads, setPayloads, errors]
95
+ }
@@ -0,0 +1,2 @@
1
+ export * from './DivinedPayload'
2
+ export * from './PayloadDiviner'
package/src/index.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './contexts'
@@ -0,0 +1,5 @@
1
+ declare module '*.png'
2
+ declare module '*.jpg'
3
+ declare module '*.svg'
4
+ declare module '*.gif'
5
+ declare module '*.webp'