@xyo-network/react-payload 2.26.34 → 2.26.37

package/src/components/Table/TableRow.tsx

@@ -1,104 +0,0 @@
-import { TableCell, TableCellProps, TableRow, TableRowProps, Typography } from '@mui/material'
-import { useBreakpoint } from '@xylabs/react-shared'
-import { XyoPayloadWithMeta, XyoPayloadWithPartialMeta, XyoPayloadWrapper, XyoPayloadWrapperValidator } from '@xyo-network/payload'
-import { useNetwork } from '@xyo-network/react-network'
-import { HashTableCell } from '@xyo-network/react-shared'
-import { DateTime } from 'luxon'
-import { MdClear, MdDone } from 'react-icons/md'
-
-import { PayloadTableColumnConfig, payloadTableColumnConfigDefaults, PayloadTableColumnSlug } from './PayloadTableColumnConfig'
-
-export interface PayloadTableRowProps extends TableRowProps {
-  payload?: XyoPayloadWithPartialMeta
-  exploreDomain?: string
-  columns?: PayloadTableColumnConfig
-  network?: string
-}
-
-export const PayloadTableRow: React.FC<PayloadTableRowProps> = ({ exploreDomain, network: networkProp, payload, columns = payloadTableColumnConfigDefaults(), ...props }) => {
-  const breakPoint = useBreakpoint()
-  const timeStamp = payload?._timestamp ? DateTime.fromMillis(payload?._timestamp) : undefined
-  const wrapper = payload ? new XyoPayloadWrapper(payload) : undefined
-  const { network } = useNetwork()
-
-  const archive: React.FC<TableCellProps> = (props) => (
-    <TableCell key="archive" align="center" {...props}>
-      <Typography fontFamily="monospace" variant="body2" noWrap>
-        {payload?._archive}
-      </Typography>
-    </TableCell>
-  )
-
-  const client: React.FC<TableCellProps> = (props) => (
-    <TableCell key="client" align="center" {...props}>
-      <Typography fontFamily="monospace" variant="body2" noWrap>
-        {payload?._client}
-      </Typography>
-    </TableCell>
-  )
-
-  const date: React.FC<TableCellProps> = (props) => (
-    <TableCell key="date" align="center" {...props}>
-      <Typography fontFamily="monospace" variant="body2" noWrap>
-        {timeStamp?.toLocaleString(DateTime.DATE_SHORT)}
-      </Typography>
-    </TableCell>
-  )
-
-  const hash: React.FC<TableCellProps> = (props) => (
-    <HashTableCell
-      key="hash"
-      width="100%"
-      value={payload?._hash}
-      archive={payload?._archive}
-      dataType="payload"
-      exploreDomain={exploreDomain}
-      network={networkProp ?? network?.slug}
-      {...props}
-    />
-  )
-
-  const schema: React.FC<TableCellProps> = (props) => (
-    <TableCell key="payloads" align="center" {...props}>
-      <Typography fontFamily="monospace" variant="body2" noWrap>
-        {payload?.schema}
-      </Typography>
-    </TableCell>
-  )
-
-  const time: React.FC<TableCellProps> = (props) => (
-    <TableCell key="time" align="center" {...props}>
-      <Typography fontFamily="monospace" variant="body2" noWrap>
-        {timeStamp?.toLocaleString(DateTime.TIME_SIMPLE)}
-      </Typography>
-    </TableCell>
-  )
-
-  const isValid = wrapper ? new XyoPayloadWrapperValidator(wrapper as XyoPayloadWrapper<XyoPayloadWithMeta>).validate().length === 0 : undefined
-
-  const valid: React.FC<TableCellProps> = (props) => (
-    <TableCell key="valid" align="center" {...props}>
-      <Typography fontFamily="monospace" variant="body2" noWrap>
-        {isValid === undefined ? <MdDone fontSize={18} color="yellow" /> : isValid ? <MdDone fontSize={18} color="green" /> : <MdClear color="red" fontSize={18} />}
-      </Typography>
-    </TableCell>
-  )
-
-  const tableCells: Record<PayloadTableColumnSlug, React.FC<TableCellProps>> = {
-    archive,
-    client,
-    date,
-    hash,
-    schema,
-    time,
-    valid,
-  }
-
-  return breakPoint ? (
-    <TableRow style={{ maxWidth: '100vw' }} {...props}>
-      {columns[breakPoint]?.map((column) => {
-        return tableCells[column]({})
-      })}
-    </TableRow>
-  ) : null
-}

package/src/components/Table/index.ts

@@ -1,3 +0,0 @@
-export * from './PayloadTableColumnConfig'
-export * from './Table'
-export * from './TableRow'

package/src/components/index.ts

@@ -1,2 +0,0 @@
-export * from './Details'
-export * from './Table'

package/src/contexts/Payload/Context.ts

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

package/src/contexts/Payload/Provider.tsx

@@ -1,31 +0,0 @@
-import { useAsyncEffect, WithChildren } from '@xylabs/react-shared'
-import { XyoPayload } from '@xyo-network/payload'
-import { useArchivist } from '@xyo-network/react-archivist'
-import { useState } from 'react'
-
-import { PayloadContext } from './Context'
-
-export interface PayloadProviderProps {
-  required?: boolean
-  hash?: string
-}
-
-export const PayloadProvider: React.FC<WithChildren<PayloadProviderProps>> = ({ required = false, hash, children }) => {
-  const { archivist } = useArchivist()
-  const [payload, setPayload] = useState<XyoPayload | null>()
-
-  useAsyncEffect(
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    async (mounted) => {
-      if (payload === undefined && hash) {
-        const loadedPayload = (await archivist?.get([hash]))?.pop()
-        if (mounted()) {
-          setPayload(loadedPayload)
-        }
-      }
-    },
-    [archivist, payload, hash]
-  )
-
-  return <PayloadContext.Provider value={{ payload, provided: true, setPayload }}> {payload ? children : required ? null : children}</PayloadContext.Provider>
-}

package/src/contexts/Payload/State.ts

@@ -1,8 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload'
-import { ContextExState } from '@xyo-network/react-shared'
-import { Dispatch } from 'react'
-
-export interface PayloadContextState extends ContextExState {
-  payload?: XyoPayload | null
-  setPayload?: Dispatch<XyoPayload>
-}

package/src/contexts/Payload/index.ts

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

package/src/contexts/Payload/use.ts

@@ -1,7 +0,0 @@
-import { useContextEx } from '@xyo-network/react-shared'
-
-import { PayloadContext } from './Context'
-
-export const usePayload = (required = false) => {
-  return useContextEx(PayloadContext, 'Payload', required)
-}

package/src/contexts/index.ts

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

package/src/hooks/ResolvePayloadArgs.ts

@@ -1,6 +0,0 @@
-import { XyoApiError } from '@xyo-network/api'
-import { XyoPayload } from '@xyo-network/payload'
-
-export type UsePayload = [XyoPayload?, boolean?, XyoApiError?]
-
-export type UseHuriOrHash = [...UsePayload, boolean?]

package/src/hooks/index.ts

@@ -1,6 +0,0 @@
-export * from './lib'
-export * from './ResolvePayloadArgs'
-export * from './useGetSchema'
-export * from './useHuriHash'
-export * from './useLoadPayload'
-export * from './useResolveHuri'

package/src/hooks/lib/FetchHuriHashOptions.ts

@@ -1,3 +0,0 @@
-export interface FetchHuriHashOptions {
-  changeActiveNetwork?: boolean
-}

package/src/hooks/lib/findHuriNetwork.ts

@@ -1,13 +0,0 @@
-import { XyoNetworkPayload } from '@xyo-network/network'
-import { Huri } from '@xyo-network/payload'
-
-export const findHuriNetwork = (huriInstance: Huri, networks?: XyoNetworkPayload[]) => {
-  // see if huri archivist matches any archivist in the network configs
-  return networks
-    ?.filter((network) =>
-      network.nodes?.find((node) => {
-        return node.type === 'archivist' && new URL(node.uri).hostname === huriInstance.archivist
-      })
-    )
-    .shift()
-}

package/src/hooks/lib/index.ts

@@ -1,2 +0,0 @@
-export * from './FetchHuriHashOptions'
-export * from './findHuriNetwork'

package/src/hooks/useGetSchema.stories.tsx

@@ -1,70 +0,0 @@
-import { FormControl, TextField, Typography } from '@mui/material'
-import { ComponentStory, Meta } from '@storybook/react'
-import { FlexCol, FlexRow } from '@xylabs/react-flexbox'
-import { XyoSchemaCache } from '@xyo-network/utils'
-import { lazy, Suspense, useEffect, useState } from 'react'
-
-import { useGetSchemaPayload } from './useGetSchema'
-
-const JsonView = lazy(() => import(/* webpackChunkName: "jsonView" */ 'react-json-view'))
-
-XyoSchemaCache.instance.proxy = 'https://beta.api.archivist.xyo.network/domain'
-
-const UseGetSchemaComponent: React.FC<{ schema: string }> = ({ schema }) => {
-  const exampleSchemas = ['network.xyo.domain', 'network.xyo.payload', 'network.xyo.schema']
-  const [schemaFieldValue, setSchemaFieldValue] = useState('')
-  const { schemaPayload } = useGetSchemaPayload(schemaFieldValue)
-
-  useEffect(() => {
-    if (schema) {
-      setSchemaFieldValue(schema)
-    }
-  }, [schema])
-
-  return (
-    <>
-      <Typography variant="body1" fontWeight="bold" mb={2}>
-        Example schemas to test:
-        {exampleSchemas.map((schema, index) => (
-          <Typography component="span" mx={1} key={index} onClick={() => setSchemaFieldValue(schema)} sx={{ cursor: 'pointer', textDecoration: 'underline' }}>
-            {schema}
-          </Typography>
-        ))}
-      </Typography>
-      <FormControl>
-        <TextField value={schemaFieldValue} label="Schema Name" onChange={(e) => setSchemaFieldValue(e.target.value)} />
-      </FormControl>
-      <FlexRow my={3} justifyContent="start">
-        <Suspense fallback={<FlexCol busy />}>
-          <JsonView src={schemaPayload || {}} />
-        </Suspense>
-      </FlexRow>
-    </>
-  )
-}
-
-const StorybookEntry: Meta = {
-  argTypes: {},
-  component: UseGetSchemaComponent,
-  parameters: {
-    docs: {
-      page: null,
-    },
-  },
-  title: 'payload/useGetSchema',
-}
-
-const Template: ComponentStory<typeof UseGetSchemaComponent> = ({ schema }) => {
-  return <UseGetSchemaComponent schema={schema} />
-}
-
-const Default = Template.bind({})
-Default.args = { schema: 'network.xyo.schema' }
-
-const Domain = Template.bind({})
-Domain.args = { schema: 'network.xyo.domain' }
-
-export { Default, Domain }
-
-// eslint-disable-next-line import/no-default-export
-export default StorybookEntry

package/src/hooks/useGetSchema.tsx

@@ -1,51 +0,0 @@
-import { useAsyncEffect } from '@xylabs/react-shared'
-import { XyoApiError } from '@xyo-network/api'
-import { XyoPayloadBuilder, XyoSchemaPayload } from '@xyo-network/payload'
-import { XyoSchemaCache, XyoSchemaCacheEntry } from '@xyo-network/utils'
-import { useState } from 'react'
-
-/**
- * Gets a Huri and schema payload from a schema string
- */
-const useGetSchemaPayload = (schema?: string) => {
-  const [notFound, setNotFound] = useState(false)
-  const [apiError, setApiError] = useState<XyoApiError>()
-  const [schemaCacheEntry, setSchemaCacheEntry] = useState<XyoSchemaCacheEntry | null | undefined>()
-  const [schemaLocal, setSchemaLocal] = useState<string>()
-
-  useAsyncEffect(
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    async (mounted) => {
-      const firstRequest = !notFound && !schemaCacheEntry && !apiError
-      const schemaChanged = schema !== schemaLocal
-
-      if ((schema && firstRequest) || (schema && schemaChanged)) {
-        try {
-          const schemaCacheEntry = await XyoSchemaCache.instance.get(schema)
-          if (mounted()) {
-            setSchemaCacheEntry(schemaCacheEntry)
-            setNotFound(schemaCacheEntry === null || schemaCacheEntry === undefined)
-          }
-        } catch (e) {
-          console.error(e)
-          if (mounted()) {
-            setApiError(e as XyoApiError)
-          }
-        }
-      }
-      if (schemaChanged) {
-        setSchemaLocal(schema)
-      }
-    },
-    [apiError, notFound, schema, schemaLocal, schemaCacheEntry]
-  )
-
-  return {
-    apiError,
-    notFound,
-    schemaHuri: schemaCacheEntry?.huri,
-    schemaPayload: schemaCacheEntry ? new XyoPayloadBuilder<XyoSchemaPayload>(schemaCacheEntry?.payload).fields(schemaCacheEntry.payload).build() : schemaCacheEntry,
-  }
-}
-
-export { useGetSchemaPayload }

package/src/hooks/useHuriHash.stories.tsx

@@ -1,108 +0,0 @@
-/* eslint-disable import/no-internal-modules */
-import { Alert, Typography } from '@mui/material'
-import { ComponentStory, Meta } from '@storybook/react'
-import { ButtonEx } from '@xylabs/react-button'
-import { FlexCol, FlexRow } from '@xylabs/react-flexbox'
-import { Huri } from '@xyo-network/payload'
-import { ArchivistApiProvider } from '@xyo-network/react-archivist-api'
-import { NetworkMemoryProvider } from '@xyo-network/react-network'
-import { XyoSchemaCache } from '@xyo-network/utils'
-import { lazy, Suspense, useState } from 'react'
-
-import { FetchHuriHashOptions } from './lib'
-import { useHuriHash } from './useHuriHash'
-
-const JsonView = lazy(() => import(/* webpackChunkName: "jsonView" */ 'react-json-view'))
-
-interface UseHuriHashComponentProps {
-  huriOrHash: string | Huri
-  huriUri?: string
-  options?: FetchHuriHashOptions
-  reTestable?: boolean
-}
-
-const apiDomain = 'https://beta.api.archivist.xyo.network'
-const hash = '5605fabad11b10bb5fb86b309ca0970894eda8f22362dda1a489817723bca992'
-XyoSchemaCache.instance.proxy = `${apiDomain}/domain`
-
-const mainApiDomain = 'https://api.archivist.xyo.network'
-const mainHash = 'd3a3936e31ba1d835c528784ab77c1eaaeedd6e16b7aad68a88241ce539853cb'
-
-const Wrapper: React.FC<UseHuriHashComponentProps> = (props) => (
-  <NetworkMemoryProvider>
-    <ArchivistApiProvider apiDomain={apiDomain}>
-      <UseHuriHashComponent {...props} />
-    </ArchivistApiProvider>
-  </NetworkMemoryProvider>
-)
-
-const UseHuriHashComponent: React.FC<UseHuriHashComponentProps> = ({ huriOrHash, huriUri, options, reTestable }) => {
-  const [trigger, setTrigger] = useState<string | Huri>(huriOrHash)
-  const [payload, notFound, , networkNotFound] = useHuriHash(trigger, huriUri, options)
-
-  return (
-    <>
-      <Typography variant="body1" fontWeight="bold">
-        Fetches the payload for a huriOrHash.
-      </Typography>
-      {reTestable ? (
-        <FlexRow columnGap={2}>
-          <ButtonEx variant="contained" onClick={() => setTrigger(hash)}>
-            Fetch Valid Hash
-          </ButtonEx>
-          <ButtonEx variant="contained" onClick={() => setTrigger('foo')}>
-            Hash Not Found
-          </ButtonEx>
-        </FlexRow>
-      ) : null}
-      <FlexCol my={3}>
-        {notFound === undefined && networkNotFound === undefined ? 'Loading...' : null}
-        {notFound ? <Alert severity="warning">Not Found</Alert> : null}
-        {networkNotFound ? <Alert severity="warning">Network Not Found</Alert> : null}
-        <Suspense fallback={<FlexCol busy />}>
-          <JsonView src={payload || {}} />
-        </Suspense>
-      </FlexCol>
-    </>
-  )
-}
-
-const StorybookEntry: Meta = {
-  argTypes: {},
-  component: UseHuriHashComponent,
-  parameters: {
-    docs: {
-      page: null,
-    },
-  },
-  title: 'payload/useHuriHash',
-}
-
-const Template: ComponentStory<typeof UseHuriHashComponent> = (props) => {
-  return <Wrapper {...props} />
-}
-
-const Default = Template.bind({})
-Default.args = { huriOrHash: hash }
-
-const NotFound = Template.bind({})
-NotFound.args = { huriOrHash: 'foo', reTestable: true }
-
-const WithHuri = Template.bind({})
-WithHuri.args = { huriOrHash: new Huri(`${apiDomain}/${hash}`) }
-
-const WithHuriUri = Template.bind({})
-WithHuriUri.args = { huriUri: `${mainApiDomain}/${mainHash}` }
-
-const WithHuriUriNetworkNotFound = Template.bind({})
-WithHuriUriNetworkNotFound.args = { huriUri: `http://badarchivisturl.com/${mainHash}` }
-
-// Note - story will work correctly once main net return 200 instead of 404 when payloads aren't found
-// Resolve huriUri when network is different from the current network
-const WithHuriUriNotFound = Template.bind({})
-WithHuriUriNotFound.args = { huriUri: `${mainApiDomain}/foo` }
-
-export { Default, NotFound, WithHuri, WithHuriUri, WithHuriUriNetworkNotFound, WithHuriUriNotFound }
-
-// eslint-disable-next-line import/no-default-export
-export default StorybookEntry

package/src/hooks/useHuriHash.tsx

@@ -1,38 +0,0 @@
-import { Huri } from '@xyo-network/payload'
-import { useCallback } from 'react'
-
-import { FetchHuriHashOptions } from './lib'
-import { UseHuriOrHash } from './ResolvePayloadArgs'
-import { useLoadPayload } from './useLoadPayload'
-import { useResolveHuri } from './useResolveHuri'
-
-/**
- * Resolve a hash or a huri regardless of network
- */
-const useHuriHash = (huriOrHash?: string | Huri, huriUri?: string, options?: FetchHuriHashOptions): UseHuriOrHash => {
-  const hash = useCallback((huriOrHash?: string | Huri) => {
-    if (huriOrHash) {
-      if (typeof huriOrHash === 'string') {
-        return huriOrHash
-      }
-      if (huriOrHash instanceof Huri) {
-        return huriOrHash.hash
-      }
-    }
-  }, [])
-
-  const providedHash = hash(huriOrHash)
-
-  // Optimistically try to grab the has from the current network and archive
-  const [payload, notFound, apiError] = useLoadPayload(providedHash)
-
-  // if a huriUri was passed, we can safely override the notFound from the hash only query
-  const notFoundOverride = huriUri ? true : notFound
-
-  // If payload isn't found, fallback to the huriUri
-  const [huriPayload, huriPayloadNotFound, huriApiError, networkNotFound] = useResolveHuri(huriUri, notFoundOverride, options)
-
-  return [payload ?? huriPayload, huriPayloadNotFound, apiError ?? huriApiError, networkNotFound]
-}
-
-export { useHuriHash }

package/src/hooks/useLoadPayload.stories.tsx

@@ -1,69 +0,0 @@
-/* eslint-disable import/no-internal-modules */
-import { ComponentStory, Meta } from '@storybook/react'
-import { ButtonEx } from '@xylabs/react-button'
-import { FlexCol } from '@xylabs/react-flexbox'
-import { ArchivistApiProvider, useArchivistApi } from '@xyo-network/react-archivist-api'
-import { lazy, Suspense, useState } from 'react'
-
-import { useLoadPayload } from './useLoadPayload'
-
-const JsonView = lazy(() => import(/* webpackChunkName: "jsonView" */ 'react-json-view'))
-
-const apiDomain = 'https://beta.api.archivist.xyo.network'
-const hash = '5605fabad11b10bb5fb86b309ca0970894eda8f22362dda1a489817723bca992'
-
-const Wrapper: React.FC<{ hash?: string }> = ({ hash }) => (
-  <ArchivistApiProvider apiDomain={apiDomain}>
-    <UsePayloadComponent hash={hash} />
-  </ArchivistApiProvider>
-)
-
-const UsePayloadComponent: React.FC<{ hash?: string }> = ({ hash }) => {
-  const { api } = useArchivistApi()
-  const [trigger, setTrigger] = useState<string>()
-  const [payload, notFound] = useLoadPayload(trigger)
-
-  return (
-    <>
-      {api ? (
-        <>
-          <ButtonEx variant="contained" marginBottom={2} onClick={() => setTrigger(hash)}>
-            Fetch Payload
-          </ButtonEx>
-          <ButtonEx variant="contained" onClick={() => setTrigger('foo')}>
-            Fetch Not Found
-          </ButtonEx>
-        </>
-      ) : null}
-      <FlexCol my={3}>
-        <Suspense fallback={<FlexCol busy />}>
-          {notFound ? 'Not Found' : null}
-          <JsonView src={payload || {}} />
-        </Suspense>
-      </FlexCol>
-    </>
-  )
-}
-
-const StorybookEntry: Meta = {
-  argTypes: {},
-  component: UsePayloadComponent,
-  parameters: {
-    docs: {
-      page: null,
-    },
-  },
-  title: 'payload/usePayload',
-}
-
-const Template: ComponentStory<typeof UsePayloadComponent> = (props) => {
-  return <Wrapper {...props} />
-}
-
-const Default = Template.bind({})
-Default.args = { hash }
-
-export { Default }
-
-// eslint-disable-next-line import/no-default-export
-export default StorybookEntry

package/src/hooks/useLoadPayload.tsx

@@ -1,60 +0,0 @@
-import { useAsyncEffect } from '@xylabs/react-shared'
-import { XyoApiError } from '@xyo-network/api'
-import { XyoPayload } from '@xyo-network/payload'
-import { useArchive } from '@xyo-network/react-archive'
-import { useArchivistApi } from '@xyo-network/react-archivist-api'
-import { useEffect, useState } from 'react'
-
-import { UsePayload } from './ResolvePayloadArgs'
-
-// I hate this name, would prefer loadPayload, but need use prefix to make it a 'hook'
-export const useLoadPayload = (hash?: string): UsePayload => {
-  const { api } = useArchivistApi()
-  const { archive } = useArchive()
-  const [localHash, setLocalHash] = useState<string>()
-  const [notFound, setNotFound] = useState<boolean>()
-  const [apiError, setApiError] = useState<XyoApiError>()
-  const [payload, setPayload] = useState<XyoPayload>()
-
-  const reset = () => {
-    setPayload(undefined)
-    setApiError(undefined)
-    setNotFound(undefined)
-  }
-
-  // allow for hash changes to retrigger the api call
-  useEffect(() => {
-    if (hash !== localHash) {
-      setLocalHash(hash)
-      reset()
-    }
-  }, [hash, localHash])
-
-  useAsyncEffect(
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    async (mounted) => {
-      if (api && localHash && localHash.length > 0 && notFound === undefined) {
-        reset()
-        try {
-          const result = await api?.archive(archive).payload.hash(localHash).get()
-          if (mounted()) {
-            if (result?.length) {
-              setPayload(result[0])
-              setNotFound(false)
-            } else if (result?.length === 0) {
-              setNotFound(true)
-              setPayload(undefined)
-            }
-          }
-        } catch (e) {
-          reset()
-          setNotFound(false)
-          setApiError(e as XyoApiError)
-          console.error(e)
-        }
-      }
-    },
-    [hash, api, archive, payload, notFound, localHash]
-  )
-  return [payload, notFound, apiError]
-}