@dxos/app-framework 0.8.4-main.2e9d522 → 0.8.4-main.3c1ae3b

package/src/react/Surface.tsx

@@ -2,26 +2,124 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { memo, forwardRef, Suspense, useMemo, Fragment } from 'react';
+import React, {
+  type ComponentType,
+  type Context,
+  Fragment,
+  type NamedExoticComponent,
+  type RefAttributes,
+  Suspense,
+  createContext,
+  forwardRef,
+  memo,
+  useContext,
+  useMemo,
+} from 'react';
 
+import { raise } from '@dxos/debug';
+import { log } from '@dxos/log';
 import { useDefaultValue } from '@dxos/react-hooks';
 import { byPosition } from '@dxos/util';
 
-import { ErrorBoundary } from './ErrorBoundary';
-import { useCapabilities } from './useCapabilities';
 import { Capabilities, type SurfaceDefinition, type SurfaceProps } from '../common';
 import { type PluginContext } from '../core';
 
+import { ErrorBoundary } from './ErrorBoundary';
+import { SurfaceInfo } from './SurfaceInfo';
+import { useCapabilities } from './useCapabilities';
+
 const DEFAULT_PLACEHOLDER = <Fragment />;
 
+const DEBUG = import.meta.env.VITE_DEBUG;
+
+export type SurfaceContext = Pick<SurfaceProps, 'id' | 'role' | 'data'>;
+
+// TODO(burdon): Use @radix-ui/react-context
+const SurfaceContext: Context<SurfaceContext | undefined> = createContext<SurfaceContext | undefined>(undefined);
+
 /**
- * @internal
+ * Wrapper component that provides context for a surface.
  */
-export const useSurfaces = () => {
-  const surfaces = useCapabilities(Capabilities.ReactSurface);
-  return useMemo(() => surfaces.flat(), [surfaces]);
+const SurfaceContextProvider = memo(
+  forwardRef<HTMLElement, SurfaceProps & { component: ComponentType<any> }>(
+    ({ id, role, data, limit, fallback = DefaultFallback, component: Component, ...rest }, forwardedRef) => {
+      const contextValue = useMemo(() => ({ id, role, data }), [id, role, data]);
+
+      // TODO(burdon): Remove from production build?
+      const active = DEBUG || '__DX_DEBUG__' in window;
+      if (active) {
+        return (
+          <ErrorBoundary data={data} fallback={fallback}>
+            <SurfaceContext.Provider value={contextValue}>
+              <SurfaceInfo ref={forwardedRef}>
+                <Component id={id} role={role} data={data} limit={limit} {...rest} />
+              </SurfaceInfo>
+            </SurfaceContext.Provider>
+          </ErrorBoundary>
+        );
+      }
+
+      return (
+        <ErrorBoundary data={data} fallback={fallback}>
+          <SurfaceContext.Provider value={contextValue}>
+            <Component id={id} role={role} data={data} limit={limit} {...rest} ref={forwardedRef} />
+          </SurfaceContext.Provider>
+        </ErrorBoundary>
+      );
+    },
+  ),
+);
+
+SurfaceContextProvider.displayName = 'SurfaceContextProvider';
+
+export const useSurface = (): SurfaceContext => {
+  const context = useContext(SurfaceContext) ?? raise(new Error('Missing SurfaceContext'));
+  return context;
 };
 
+/**
+ * A surface is a named region of the screen that can be populated by plugins.
+ */
+export const Surface: NamedExoticComponent<SurfaceProps & RefAttributes<HTMLElement>> = memo(
+  forwardRef(({ id: _id, role, data: dataParam, limit, placeholder = DEFAULT_PLACEHOLDER, ...rest }, forwardedRef) => {
+    const data = useDefaultValue(dataParam, () => ({}));
+
+    // TODO(wittjosiah): This will make all surfaces depend on a single signal.
+    //   This isn't ideal because it means that any change to the data will cause all surfaces to re-render.
+    //   This effectively means that plugin modules which contribute surfaces need to all be activated at startup.
+    //   This should be fine for now because it's how it worked prior to capabilities api anyway.
+    //   In the future, it would be nice to be able to bucket the surface contributions by role.
+    const surfaces = useSurfaces();
+
+    // NOTE: Memoizing the candidates makes the surface not re-render based on reactivity within data.
+    const definitions = findCandidates(surfaces, { role, data });
+    const candidates = limit ? definitions.slice(0, limit) : definitions;
+    if (DEBUG && candidates.length === 0) {
+      log.warn('no candidates for surface', { role, data });
+      return null;
+    }
+
+    return (
+      <Suspense fallback={placeholder}>
+        {candidates.map(({ id, component }) => (
+          <SurfaceContextProvider
+            key={id}
+            id={id}
+            role={role}
+            data={data}
+            limit={limit}
+            component={component}
+            ref={forwardedRef}
+            {...rest}
+          />
+        ))}
+      </Suspense>
+    );
+  }),
+);
+
+Surface.displayName = 'Surface';
+
 const findCandidates = (surfaces: SurfaceDefinition[], { role, data }: Pick<SurfaceProps, 'role' | 'data'>) => {
   return Object.values(surfaces)
     .filter((definition) =>
@@ -31,6 +129,35 @@ const findCandidates = (surfaces: SurfaceDefinition[], { role, data }: Pick<Surf
     .toSorted(byPosition);
 };
 
+// TODO(burdon): Make user facing, with telemetry.
+// TODO(burdon): Change based on dev/prod mode; infer subject type, id.
+const DefaultFallback = ({ data, error, dev }: { data: any; error: Error; dev?: boolean }) => {
+  if (dev) {
+    return (
+      <div className='flex flex-col gap-4 p-4 is-full overflow-y-auto'>
+        <h1 className='flex gap-2 text-sm mbs-2'>{error.message}</h1>
+        <pre className='overflow-auto text-xs text-description'>{JSON.stringify(data, null, 2)}</pre>
+      </div>
+    );
+  }
+
+  return (
+    <div className='flex flex-col gap-4 p-4 is-full overflow-y-auto border border-roseFill'>
+      <h1 className='flex gap-2 text-sm mbs-2 text-rose-500'>{error.message}</h1>
+      <pre className='overflow-auto text-xs text-description'>{error.stack}</pre>
+      <pre className='overflow-auto text-xs text-description'>{JSON.stringify(data, null, 2)}</pre>
+    </div>
+  );
+};
+
+/**
+ * @internal
+ */
+export const useSurfaces = () => {
+  const surfaces = useCapabilities(Capabilities.ReactSurface);
+  return useMemo(() => surfaces.flat(), [surfaces]);
+};
+
 /**
  * @returns `true` if there is a contributed surface which matches the specified role & data, `false` otherwise.
  */
@@ -39,39 +166,3 @@ export const isSurfaceAvailable = (context: PluginContext, { role, data }: Pick<
   const candidates = findCandidates(surfaces.flat(), { role, data });
   return candidates.length > 0;
 };
-
-/**
- * A surface is a named region of the screen that can be populated by plugins.
- */
-export const Surface = memo(
-  forwardRef<HTMLElement, SurfaceProps>(
-    ({ id: _id, role, data: _data, limit, fallback, placeholder = DEFAULT_PLACEHOLDER, ...rest }, forwardedRef) => {
-      // TODO(wittjosiah): This will make all surfaces depend on a single signal.
-      //   This isn't ideal because it means that any change to the data will cause all surfaces to re-render.
-      //   This effectively means that plugin modules which contribute surfaces need to all be activated at startup.
-      //   This should be fine for now because it's how it worked prior to capabilities api anyways.
-      //   In the future, it would be nice to be able to bucket the surface contributions by role.
-      const surfaces = useSurfaces();
-      const data = useDefaultValue(_data, () => ({}));
-
-      // NOTE: Memoizing the candidates makes the surface not re-render based on reactivity within data.
-      const definitions = findCandidates(surfaces, { role, data });
-      const candidates = limit ? definitions.slice(0, limit) : definitions;
-      const nodes = candidates.map(({ component: Component, id }) => (
-        <Component ref={forwardedRef} key={id} id={id} role={role} data={data} limit={limit} {...rest} />
-      ));
-
-      const suspense = <Suspense fallback={placeholder}>{nodes}</Suspense>;
-
-      return fallback ? (
-        <ErrorBoundary data={data} fallback={fallback}>
-          {suspense}
-        </ErrorBoundary>
-      ) : (
-        suspense
-      );
-    },
-  ),
-);
-
-Surface.displayName = 'Surface';

package/src/react/SurfaceInfo.tsx

@@ -0,0 +1,107 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, {
+  type ReactElement,
+  type Ref,
+  cloneElement,
+  forwardRef,
+  useCallback,
+  useLayoutEffect,
+  useState,
+} from 'react';
+import { createPortal } from 'react-dom';
+
+import { addEventListener, combine } from '@dxos/async';
+import { useMergeRefs } from '@dxos/react-hooks';
+
+import { useSurface } from './Surface';
+
+export type SurfaceInfoProps = {
+  children: ReactElement<{ ref?: Ref<HTMLElement> }>;
+};
+
+/**
+ * Debug wrapper for surfaces.
+ */
+export const SurfaceInfo = forwardRef<HTMLElement, SurfaceInfoProps>(({ children }, forwardedRef) => {
+  const [rect, setRect] = useState<DOMRect | null>(null);
+  const [expand, setExpand] = useState(false);
+  const info = useSurface();
+
+  const [root, setRoot] = useState<HTMLElement | null>(null);
+  const measureRef = useCallback((node: HTMLElement | null) => setRoot(node), []);
+  const mergedRef = useMergeRefs([measureRef, forwardedRef]);
+  const childWithRef = cloneElement(children, { ref: mergedRef });
+
+  useLayoutEffect(() => {
+    if (!root) {
+      setRect(null);
+      return;
+    }
+
+    const measure = () => {
+      setRect(root.getBoundingClientRect());
+    };
+
+    const observer = new ResizeObserver(measure);
+    observer.observe(root);
+    measure();
+
+    return combine(
+      addEventListener(window, 'scroll', measure, true),
+      addEventListener(window, 'resize', measure),
+      () => {
+        observer.disconnect();
+      },
+    );
+  }, [root]);
+
+  const padding = 0;
+  return (
+    <>
+      {childWithRef}
+      {rect &&
+        createPortal(
+          <div
+            role='none'
+            className='z-[100] fixed flex flex-col-reverse scrollbar-none overflow-auto pointer-events-none'
+            style={{
+              top: rect.top + padding,
+              left: rect.left + padding,
+              width: rect.width - padding * 2,
+              height: rect.height - padding * 2,
+            }}
+          >
+            {expand ? (
+              <div
+                className='absolute inset-0 bg-deckSurface border border-green-500 cursor-pointer pointer-events-auto overflow-auto'
+                onPointerDown={(ev) => ev.stopPropagation()}
+                onClick={(ev) => {
+                  ev.stopPropagation();
+                  setExpand(false);
+                }}
+              >
+                <pre className='p-2 text-xs text-description font-mono'>{JSON.stringify({ info }, null, 2)}</pre>
+              </div>
+            ) : (
+              <span
+                className='absolute right-1 bottom-0 flex items-center p-1 text-green-500 opacity-80 hover:opacity-100 text-xl cursor-pointer pointer-events-auto'
+                title={info.id}
+                onPointerDown={(ev) => ev.stopPropagation()}
+                onClick={(ev) => {
+                  ev.stopPropagation();
+                  setExpand(true);
+                }}
+              >
+                ⓘ
+              </span>
+            )}
+          </div>,
+          // TODO(burdon): Create well-known element to gather all debug portals.
+          document.body,
+        )}
+    </>
+  );
+});

package/src/react/common.ts

@@ -2,9 +2,10 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useCapability } from './useCapabilities';
 import { Capabilities } from '../common';
 
+import { useCapability } from './useCapabilities';
+
 export const useIntentDispatcher = () => useCapability(Capabilities.IntentDispatcher);
 
 export const useAppGraph = () => useCapability(Capabilities.AppGraph);

package/src/react/index.ts

@@ -3,8 +3,12 @@
 //
 
 export * from './common';
+export * from './types';
+
 export * from './ErrorBoundary';
 export * from './PluginManagerProvider';
 export * from './Surface';
+
+export * from './useApp';
 export * from './useCapabilities';
 export * from './useIntentResolver';

package/src/react/types.ts

@@ -0,0 +1,38 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { type Obj } from '@dxos/echo';
+
+export const SurfaceCardRole = Schema.Literal(
+  'card',
+  'card--popover',
+  'card--intrinsic',
+  'card--extrinsic',
+  'card--transclusion',
+);
+
+export type SurfaceCardRole = Schema.Schema.Type<typeof SurfaceCardRole>;
+
+// TODO(burdon): Define all roles.
+export type SurfaceRole =
+  | 'item'
+  | 'article'
+  | 'complementary' // (for companion?)
+  | 'section'
+  | SurfaceCardRole;
+
+/**
+ * Base type for surface components.
+ */
+// TODO(burdon): Standardize PluginSettings and ObjectProperties.
+// TODO(burdon): Include attendableId?
+// TODO(burdon): companionTo?
+export type SurfaceComponentProps<Subject extends Obj.Any = Obj.Any, Role extends string = string> = {
+  role?: Role;
+
+  /** The primary object being displayed. */
+  subject: Subject;
+};

package/src/react/useApp.tsx

@@ -0,0 +1,165 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import { effect } from '@preact/signals-core';
+import React, { type FC, useCallback, useEffect, useMemo } from 'react';
+
+import { invariant } from '@dxos/invariant';
+import { live } from '@dxos/live-object';
+import { useAsyncEffect, useDefaultValue } from '@dxos/react-hooks';
+
+import { Capabilities, Events } from '../common';
+import { type Plugin, PluginManager, type PluginManagerOptions } from '../core';
+
+import { App } from './App';
+import { DefaultFallback } from './DefaultFallback';
+import { ErrorBoundary } from './ErrorBoundary';
+import { PluginManagerProvider } from './PluginManagerProvider';
+
+const ENABLED_KEY = 'dxos.org/app-framework/enabled';
+
+export type UseAppOptions = {
+  pluginManager?: PluginManager;
+  pluginLoader?: PluginManagerOptions['pluginLoader'];
+  plugins?: Plugin[];
+  core?: string[];
+  defaults?: string[];
+  placeholder?: FC<{ stage: number }>;
+  fallback?: ErrorBoundary['props']['fallback'];
+  cacheEnabled?: boolean;
+  safeMode?: boolean;
+  debounce?: number;
+};
+
+/**
+ * Expected usage is for this to be the entrypoint of the application.
+ * Initializes plugins and renders the root components.
+ *
+ * @example
+ * const plugins = [LayoutPlugin(), MyPlugin()];
+ * const core = [LayoutPluginId];
+ * const default = [MyPluginId];
+ * const fallback = <div>Initializing Plugins...</div>;
+ * const App = useApp({ plugins, core, default, fallback });
+ * createRoot(document.getElementById('root')!).render(
+ *   <StrictMode>
+ *     <App />
+ *   </StrictMode>,
+ * );
+ *
+ * @param params.pluginLoader A function which loads new plugins.
+ * @param params.plugins All plugins available to the application.
+ * @param params.core Core plugins which will always be enabled.
+ * @param params.defaults Default plugins are enabled by default but can be disabled by the user.
+ * @param params.placeholder Placeholder component to render during startup.
+ * @param params.fallback Fallback component to render if an error occurs during startup.
+ * @param params.cacheEnabled Whether to cache enabled plugins in localStorage.
+ * @param params.safeMode Whether to enable safe mode, which disables optional plugins.
+ */
+export const useApp = ({
+  pluginManager,
+  pluginLoader: pluginLoaderParam,
+  plugins: pluginsParam,
+  core: coreParam,
+  defaults: defaultsParam,
+  placeholder,
+  fallback = DefaultFallback,
+  cacheEnabled = false,
+  safeMode = false,
+  debounce = 0,
+}: UseAppOptions) => {
+  const plugins = useDefaultValue(pluginsParam, () => []);
+  const core = useDefaultValue(coreParam, () => plugins.map(({ meta }) => meta.id));
+  const defaults = useDefaultValue(defaultsParam, () => []);
+
+  // TODO(wittjosiah): Provide a custom plugin loader which supports loading via url.
+  const pluginLoader = useMemo(
+    () =>
+      pluginLoaderParam ??
+      ((id: string) => {
+        const plugin = plugins.find((plugin) => plugin.meta.id === id);
+        invariant(plugin, `Plugin not found: ${id}`);
+        return plugin;
+      }),
+    [pluginLoaderParam, plugins],
+  );
+
+  const state = useMemo(() => live({ ready: false, error: null }), []);
+  const cached: string[] = useMemo(() => JSON.parse(localStorage.getItem(ENABLED_KEY) ?? '[]'), []);
+  const enabled = useMemo(
+    () => (safeMode ? [] : cacheEnabled && cached.length > 0 ? cached : defaults),
+    [safeMode, cacheEnabled, cached, defaults],
+  );
+  const manager = useMemo(
+    () => pluginManager ?? new PluginManager({ pluginLoader, plugins, core, enabled }),
+    [pluginManager, pluginLoader, plugins, core, enabled],
+  );
+
+  useEffect(() => {
+    return manager.activation.on(({ event, state: _state, error }) => {
+      // Once the app is ready the first time, don't show the fallback again.
+      if (!state.ready && event === Events.Startup.id) {
+        state.ready = _state === 'activated';
+      }
+
+      if (error && !state.ready && !state.error) {
+        state.error = error;
+      }
+    });
+  }, [manager, state]);
+
+  useEffect(() => {
+    effect(() => {
+      cacheEnabled && localStorage.setItem(ENABLED_KEY, JSON.stringify(manager.enabled));
+    });
+  }, [cacheEnabled, manager]);
+
+  useEffect(() => {
+    setupDevtools(manager);
+  }, [manager]);
+
+  useAsyncEffect(async () => {
+    manager.context.contributeCapability({
+      interface: Capabilities.PluginManager,
+      implementation: manager,
+      module: 'dxos.org/app-framework/plugin-manager',
+    });
+
+    manager.context.contributeCapability({
+      interface: Capabilities.AtomRegistry,
+      implementation: manager.registry,
+      module: 'dxos.org/app-framework/atom-registry',
+    });
+
+    await Promise.all([
+      // TODO(wittjosiah): Factor out such that this could be called per surface role when attempting to render.
+      manager.activate(Events.SetupReactSurface),
+      manager.activate(Events.Startup),
+    ]);
+
+    return () => {
+      manager.context.removeCapability(Capabilities.PluginManager, manager);
+      manager.context.removeCapability(Capabilities.AtomRegistry, manager.registry);
+    };
+  }, [manager]);
+
+  return useCallback(
+    () => (
+      <ErrorBoundary fallback={fallback}>
+        <PluginManagerProvider value={manager}>
+          <RegistryContext.Provider value={manager.registry}>
+            <App placeholder={placeholder} state={state} debounce={debounce} />
+          </RegistryContext.Provider>
+        </PluginManagerProvider>
+      </ErrorBoundary>
+    ),
+    [fallback, manager, placeholder, state],
+  );
+};
+
+const setupDevtools = (manager: PluginManager) => {
+  (globalThis as any).composer ??= {};
+  (globalThis as any).composer.manager = manager;
+};

package/src/react/useCapabilities.ts

@@ -2,20 +2,21 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useRxValue } from '@effect-rx/rx-react';
+import { useAtomValue } from '@effect-atom/atom-react';
 
 import { invariant } from '@dxos/invariant';
 
-import { usePluginManager } from './PluginManagerProvider';
 import { type InterfaceDef } from '../core';
 
+import { usePluginManager } from './PluginManagerProvider';
+
 /**
  * Hook to request capabilities from the plugin context.
  * @returns An array of capabilities.
  */
 export const useCapabilities = <T>(interfaceDef: InterfaceDef<T>) => {
   const manager = usePluginManager();
-  return useRxValue(manager.context.capabilities(interfaceDef));
+  return useAtomValue(manager.context.capabilities(interfaceDef));
 };
 
 /**

package/src/react/useLoading.tsx

@@ -0,0 +1,70 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useEffect, useState } from 'react';
+
+import { type AppProps } from './App';
+
+export enum LoadingState {
+  Loading = 0,
+  FadeIn = 1,
+  FadeOut = 2,
+  Done = 3,
+}
+
+/**
+ * To avoid "flashing" the placeholder, we wait a period of time before starting the loading animation.
+ * If loading completes during this time the placehoder is not shown, otherwise is it displayed for a minimum period of time.
+ *
+ * States:
+ * 0: Loading   - Wait for a period of time before starting the loading animation.
+ * 1: Fade-in   - Display a loading animation.
+ * 2: Fade-out  - Fade out the loading animation.
+ * 3: Done      - Remove the placeholder.
+ */
+export const useLoading = (state: AppProps['state'], debounce = 0) => {
+  const [stage, setStage] = useState<LoadingState>(LoadingState.Loading);
+  useEffect(() => {
+    if (!debounce) {
+      return;
+    }
+
+    const i = setInterval(() => {
+      setStage((stage) => {
+        switch (stage) {
+          case LoadingState.Loading: {
+            if (!state.ready) {
+              return LoadingState.FadeIn;
+            } else {
+              clearInterval(i);
+              return LoadingState.Done;
+            }
+          }
+
+          case LoadingState.FadeIn: {
+            if (state.ready) {
+              return LoadingState.FadeOut;
+            }
+            break;
+          }
+
+          case LoadingState.FadeOut: {
+            clearInterval(i);
+            return LoadingState.Done;
+          }
+        }
+
+        return stage;
+      });
+    }, debounce);
+
+    return () => clearInterval(i);
+  }, [debounce]);
+
+  if (!debounce) {
+    return state.ready ? LoadingState.Done : LoadingState.Loading;
+  }
+
+  return stage;
+};

package/src/testing/withPluginManager.stories.tsx

@@ -2,15 +2,17 @@
 // Copyright 2025 DXOS.org
 //
 
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
-import { withTheme, type Meta } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
-import { withPluginManager } from './withPluginManager';
 import { Capabilities, createSurface } from '../common';
 import { contributes } from '../core';
 import { Surface } from '../react';
 
+import { withPluginManager } from './withPluginManager';
+
 const DefaultStory = () => {
   console.log('Render');
   return (
@@ -21,7 +23,7 @@ const DefaultStory = () => {
   );
 };
 
-const meta: Meta = {
+const meta = {
   title: 'sdk/app-framework/withPluginManager',
   render: DefaultStory,
   decorators: [
@@ -39,8 +41,10 @@ const meta: Meta = {
       ],
     }),
   ],
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-export const Default = {};
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};