@xyo-network/react-panel 2.26.35 → 2.26.38

package/dist/docs.json

@@ -10,7 +10,7 @@
 			"fileName": "index.ts",
 			"line": 1,
 			"character": 0,
-			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/7efa6fa/packages/panel/src/index.ts#L1"
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/c31a96d/packages/panel/src/index.ts#L1"
 		}
 	]
 }

package/package.json

@@ -16,9 +16,9 @@
     "@xyo-network/boundwitness": "^2.22.15",
     "@xyo-network/panel": "^2.22.15",
     "@xyo-network/payload": "^2.22.15",
-    "@xyo-network/react-archive": "^2.26.35",
-    "@xyo-network/react-shared": "^2.26.35",
-    "@xyo-network/react-wallet": "^2.26.35",
+    "@xyo-network/react-archive": "^2.26.38",
+    "@xyo-network/react-shared": "^2.26.38",
+    "@xyo-network/react-wallet": "^2.26.38",
     "@xyo-network/systeminfo-witness": "^2.22.15",
     "@xyo-network/witnesses": "^2.22.15",
     "react": "^18.2.0",
@@ -80,5 +80,5 @@
   },
   "sideEffects": false,
   "types": "dist/esm/index.d.ts",
-  "version": "2.26.35"
+  "version": "2.26.38"
 }

package/src/contexts/Context.ts

@@ -0,0 +1,5 @@
+import { createContextEx } from '@xyo-network/react-shared'
+
+import { XyoPanelContextState } from './State'
+
+export const XyoPanelContext = createContextEx<XyoPanelContextState>()

package/src/contexts/Provider.tsx

@@ -0,0 +1,150 @@
+import { useAsyncEffect, WithChildren } from '@xylabs/react-shared'
+import { assertEx, delay } from '@xylabs/sdk-js'
+import { XyoApiConfig, XyoArchivistApi } from '@xyo-network/api'
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { XyoPanel } from '@xyo-network/panel'
+import { XyoPayload } from '@xyo-network/payload'
+import { useArchive } from '@xyo-network/react-archive'
+import { useAccount } from '@xyo-network/react-wallet'
+import { XyoSystemInfoWitness } from '@xyo-network/systeminfo-witness'
+import { XyoWitness } from '@xyo-network/witnesses'
+import { useEffect, useState } from 'react'
+
+import { XyoPanelContext } from './Context'
+import { XyoPanelReportProgress, XyoReportStatus } from './State'
+
+export interface XyoPanelProviderProps {
+  archivists?: XyoArchivistApi[]
+  inlinePayloads?: boolean
+  witnesses?: XyoWitness<XyoPayload>[]
+  required?: boolean
+  archive?: string
+}
+
+const getDefaultArchivists = () => {
+  const archivistConfigs: XyoApiConfig[] = [
+    {
+      apiDomain: process.env.API_DOMAIN || 'https://api.archivist.xyo.network',
+    },
+  ]
+
+  return archivistConfigs.map((config) => {
+    return new XyoArchivistApi(config)
+  })
+}
+
+export const XyoPanelProvider: React.FC<WithChildren<XyoPanelProviderProps>> = ({
+  inlinePayloads = false,
+  required = false,
+  archivists = getDefaultArchivists(),
+  witnesses = [new XyoSystemInfoWitness()],
+  children,
+}) => {
+  const { archive } = useArchive()
+  const [panel, setPanel] = useState<XyoPanel>()
+  const [history, setHistory] = useState<XyoBoundWitness[]>()
+  const [progress, setProgress] = useState<XyoPanelReportProgress>({})
+  const [status, setStatus] = useState(XyoReportStatus.Idle)
+  const [reportingErrors, setReportingErrors] = useState<Error[]>()
+
+  const { account } = useAccount()
+
+  useAsyncEffect(
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    async (mounted) => {
+      const panel = new XyoPanel({
+        account,
+        archive,
+        archivists,
+        inlinePayloads,
+        onArchivistSendEnd: (archivist: XyoArchivistApi, error?: Error) => {
+          const archivists = progress.archivists ?? {}
+          archivists[archivist.config.apiDomain] = {
+            archivist,
+            status: error ? XyoReportStatus.Failed : XyoReportStatus.Succeeded,
+          }
+          if (mounted()) {
+            setProgress({ archivists, witnesses: progress.witnesses })
+          }
+        },
+        onArchivistSendStart: (archivist: XyoArchivistApi) => {
+          const archivists = progress.archivists ?? {}
+          archivists[archivist.config.apiDomain] = {
+            archivist,
+            status: XyoReportStatus.Started,
+          }
+          if (mounted()) {
+            setProgress({ archivists, witnesses: progress.witnesses })
+          }
+        },
+        onHistoryAdd: () => {
+          if (mounted()) {
+            setHistory(assertEx(panel).history.map((item) => item))
+          }
+        },
+        onHistoryRemove: () => {
+          if (mounted()) {
+            setHistory(assertEx(panel).history.map((item) => item))
+          }
+        },
+        onReportEnd: (_, errors?: Error[]) => {
+          if (mounted()) {
+            setProgress({
+              archivists: progress.archivists,
+              witnesses: progress.witnesses,
+            })
+            setStatus(errors ? XyoReportStatus.Failed : XyoReportStatus.Succeeded)
+            setReportingErrors(errors)
+          }
+        },
+        onReportStart: () => {
+          if (mounted()) {
+            setProgress({ archivists: {}, witnesses: {} })
+            setStatus(XyoReportStatus.Started)
+          }
+        },
+        onWitnessReportEnd: (witness: XyoWitness, error?: Error) => {
+          const witnesses = progress.witnesses ?? {}
+          witnesses[witness.targetSchema] = {
+            status: error ? XyoReportStatus.Failed : XyoReportStatus.Succeeded,
+            witness,
+          }
+          if (mounted()) {
+            setProgress({
+              archivists: progress.archivists,
+              witnesses,
+            })
+          }
+        },
+        onWitnessReportStart: (witness: XyoWitness) => {
+          const witnesses = progress.witnesses ?? {}
+          witnesses[witness.targetSchema] = {
+            status: XyoReportStatus.Started,
+            witness,
+          }
+          if (mounted()) {
+            setProgress({
+              archivists: progress.archivists,
+              witnesses,
+            })
+          }
+        },
+        witnesses: witnesses.filter((witness) => !!witness),
+      })
+      setPanel(panel)
+      await delay(0)
+    },
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [account, archive, archivists, witnesses]
+  )
+
+  useEffect(() => {
+    setHistory(panel?.history)
+  }, [panel])
+
+  return (
+    <XyoPanelContext.Provider value={{ history, panel, progress, provided: true, reportingErrors, status }}>
+      {panel ? children : required ? null : children}
+    </XyoPanelContext.Provider>
+  )
+}

package/src/contexts/State.ts

@@ -0,0 +1,35 @@
+import { XyoArchivistApi } from '@xyo-network/api'
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { XyoPanel } from '@xyo-network/panel'
+import { XyoWitness } from '@xyo-network/witnesses'
+
+export enum XyoReportStatus {
+  Idle = 'idle',
+  Queued = 'queued',
+  Started = 'started',
+  Succeeded = 'succeeded',
+  Failed = 'failed',
+}
+
+export interface XyoWitnessReportProgress {
+  witness: XyoWitness
+  status: XyoReportStatus
+}
+
+export interface XyoArchivistApiReportProgress {
+  archivist: XyoArchivistApi
+  status: XyoReportStatus
+}
+
+export interface XyoPanelReportProgress {
+  witnesses?: Record<string, XyoWitnessReportProgress>
+  archivists?: Record<string, XyoArchivistApiReportProgress>
+}
+
+export interface XyoPanelContextState {
+  panel?: XyoPanel
+  history?: XyoBoundWitness[]
+  progress?: XyoPanelReportProgress
+  status?: XyoReportStatus
+  reportingErrors?: Error[]
+}

package/src/contexts/index.ts

@@ -0,0 +1,4 @@
+export * from './Context'
+export * from './Provider'
+export * from './State'
+export * from './use'

package/src/contexts/use.ts

@@ -0,0 +1,8 @@
+import { useContextEx } from '@xyo-network/react-shared'
+
+import { XyoPanelContext } from './Context'
+
+export const useXyoPanel = () => {
+  const { panel, history, progress, reportingErrors, status } = useContextEx(XyoPanelContext, 'XyoPanel')
+  return { history, panel, progress, reportingErrors, status }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './contexts'