@xyo-network/react-embed 2.27.28 → 2.27.31

package/src/contexts/XyoEmbedPluginContext/Provider.tsx

@@ -1,74 +1,40 @@
-import { FlexBoxProps, FlexCol } from '@xylabs/react-flexbox'
-import { useAsyncEffect, WithChildren } from '@xylabs/react-shared'
-import { delay } from '@xylabs/sdk-js'
-import { XyoApiError } from '@xyo-network/api'
-import { Huri, XyoPayload } from '@xyo-network/payload'
-import { XyoApiErrorRender } from '@xyo-network/react-auth-service'
+import { WithChildren } from '@xylabs/react-shared'
+import { XyoPayload } from '@xyo-network/payload'
 import { XyoPayloadRenderPlugin } from '@xyo-network/react-payload-plugin'
-import { ResultLoader } from '@xyo-network/react-webapp'
 import { useState } from 'react'
 
 import { XyoEmbedPluginContext } from './Context'
+import { XyoEmbedPluginBase } from './State'
 
-export interface XyoEmbedPluginProviderProps extends FlexBoxProps {
-  plugins?: XyoPayloadRenderPlugin[]
-  huri?: string
-  refreshTitle?: string
-  timestampLabel?: string
+export interface XyoEmbedPluginProviderProps extends XyoEmbedPluginBase {
+  /** string for huri to resolve and payload for bypassing huri resolution */
+  huriPayload?: string | XyoPayload
 }
 
+/** Expose passed embed plugin props and payload via context */
 export const XyoEmbedPluginProvider: React.FC<WithChildren<XyoEmbedPluginProviderProps>> = ({
   children,
   refreshTitle,
   timestampLabel,
-  huri,
+  hideElementsConfig,
   plugins,
-  ...props
+  embedPluginConfig,
 }) => {
-  const [payload, setPayload] = useState<XyoPayload>()
-  const [notFound, setNotFound] = useState<boolean>()
-  const [huriApiError, setHuriApiError] = useState<XyoApiError>()
   const [activePlugin, setActivePlugin] = useState<XyoPayloadRenderPlugin | undefined>(plugins ? plugins[0] : undefined)
-  const [refreshPayload, setRefreshPayload] = useState(0)
-
-  useAsyncEffect(
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    async (mounted) => {
-      if (huri && !refreshPayload) {
-        try {
-          const huriInstance = new Huri(huri)
-          const result = await huriInstance.fetch()
-          // ensure the busy state can stay for a moment to avoid flashing too quickly
-          await delay(500)
-
-          if (mounted()) {
-            setNotFound(result === null)
-            setPayload(result)
-            setRefreshPayload(1)
-          }
-        } catch (e) {
-          setHuriApiError(e as XyoApiError)
-        }
-      }
-    },
-    [huri, payload, refreshPayload],
-  )
-
-  const refreshHuri = () => {
-    setRefreshPayload(0)
-  }
 
   return (
     <XyoEmbedPluginContext.Provider
-      value={{ activePlugin, huri, payload, provided: true, refreshHuri, refreshTitle, setActivePlugin, timestampLabel }}
+      value={{
+        activePlugin,
+        embedPluginConfig,
+        hideElementsConfig,
+        provided: true,
+        refreshTitle,
+        setActivePlugin,
+        timestampLabel,
+      }}
     >
-      <ResultLoader searchResult={payload} notFound={!!notFound} apiError={huriApiError}>
-        <XyoApiErrorRender apiError={huriApiError}>
-          <FlexCol busy={Boolean(!refreshPayload && payload)} {...props}>
-            {children}
-          </FlexCol>
-        </XyoApiErrorRender>
-      </ResultLoader>
+      {children}
     </XyoEmbedPluginContext.Provider>
   )
 }

package/src/contexts/XyoEmbedPluginContext/State.ts

@@ -1,15 +1,35 @@
-import { XyoPayload } from '@xyo-network/payload'
 import { XyoPayloadRenderPlugin } from '@xyo-network/react-payload-plugin'
-import { ContextExState } from '@xyo-network/react-shared'
+import { ContextExState, ListMode } from '@xyo-network/react-shared'
 import { Dispatch, SetStateAction } from 'react'
 
-export interface XyoEmbedPluginState extends ContextExState {
-  activePlugin?: XyoPayloadRenderPlugin
-  setActivePlugin?: Dispatch<SetStateAction<XyoPayloadRenderPlugin | undefined>>
-  payload?: XyoPayload
+export interface EmbedPluginVisibilityConfig {
+  hideAvatar?: boolean
+  hideTitle?: boolean
+  hideRefreshButton?: boolean
+  hideTimestamp?: boolean
+  hideCardActions?: boolean
+  hideCardHeader?: boolean
+}
+
+/**
+ * Extend for custom plugin configuration
+ */
+export interface XyoPluginConfig {
+  listMode?: ListMode
+}
+
+export interface XyoEmbedPluginBase {
   plugins?: XyoPayloadRenderPlugin[]
-  refreshHuri?: () => void
+  /** XyoEmbedPlugin component configuration */
+  embedPluginConfig?: XyoPluginConfig
+  /** @deprecated use huriPayload */
   huri?: string
   refreshTitle?: string
   timestampLabel?: string
+  hideElementsConfig?: EmbedPluginVisibilityConfig
+}
+
+export interface XyoEmbedPluginState extends XyoEmbedPluginBase, ContextExState {
+  activePlugin?: XyoPayloadRenderPlugin
+  setActivePlugin?: Dispatch<SetStateAction<XyoPayloadRenderPlugin | undefined>>
 }

package/src/contexts/index.ts

@@ -1,2 +1,3 @@
+export * from './ResolvePayloadContext'
 export * from './ValidatePayloadContext'
 export * from './XyoEmbedPluginContext'

package/src/types/XyoEmbedPluginProps.ts

@@ -0,0 +1,11 @@
+import { CardProps } from '@mui/material'
+import { XyoPayload } from '@xyo-network/payload'
+
+import { EmbedPluginVisibilityConfig, XyoEmbedPluginBase } from '../contexts'
+
+export interface XyoEmbedPluginProps extends XyoEmbedPluginBase, CardProps {
+  /** string for huri to resolve and payload for bypassing huri resolution */
+  huriPayload?: string | XyoPayload
+  validateSchema?: boolean
+  hideElementsConfig?: EmbedPluginVisibilityConfig
+}

package/src/types/index.ts

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

package/src/components/RenderComponent.tsx

@@ -1,13 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload'
-import { XyoPayloadRenderPlugin } from '@xyo-network/react-payload-plugin'
-import { useListMode } from '@xyo-network/react-shared'
-
-interface RenderComponentProps {
-  ActivePlugin?: XyoPayloadRenderPlugin
-  payload?: XyoPayload
-}
-
-export const RenderComponent: React.FC<RenderComponentProps> = ({ ActivePlugin, payload }) => {
-  const { listMode } = useListMode()
-  return <>{ActivePlugin ? <ActivePlugin.components.box.details payload={payload} listMode={listMode} /> : null}</>
-}

package/src/components/XyoEmbedPluginProps.ts

@@ -1,10 +0,0 @@
-import { CardProps } from '@mui/material'
-import { XyoPayloadRenderPlugin } from '@xyo-network/react-payload-plugin'
-
-export interface XyoEmbedPluginProps extends CardProps {
-  plugins?: XyoPayloadRenderPlugin[]
-  huri?: string
-  refreshTitle?: string
-  timestampLabel?: string
-  validateSchema?: boolean
-}