@dxos/app-framework 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/src/ui/hooks/useApp.tsx

@@ -0,0 +1,213 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+import * as PubSub from 'effect/PubSub';
+import * as Queue from 'effect/Queue';
+import React, { type FC, useCallback, useEffect, useMemo, useRef, useState } from 'react';
+
+import { runAndForwardErrors } from '@dxos/effect';
+import { invariant } from '@dxos/invariant';
+import { log } from '@dxos/log';
+import { ErrorBoundary, ErrorFallback, type FallbackProps } from '@dxos/react-error-boundary';
+import { useAsyncEffect, useDefaultValue } from '@dxos/react-hooks';
+import { ContextProtocolProvider } from '@dxos/web-context-react';
+
+import { ActivationEvents, Capabilities } from '../../common';
+import { PluginManagerContext } from '../../context';
+import { type ActivationEvent, type Plugin, PluginManager } from '../../core';
+import { App, PluginManagerProvider } from '../components';
+
+const ENABLED_KEY = 'dxos.org/app-framework/enabled';
+
+export type UseAppOptions = {
+  pluginManager?: PluginManager.PluginManager;
+  pluginLoader?: PluginManager.ManagerOptions['pluginLoader'];
+  plugins?: Plugin.Plugin[];
+  core?: string[];
+  defaults?: string[];
+  /**
+   * Additional activation events to fire before startup.
+   * These are fired alongside SetupReactSurface before the Startup event.
+   */
+  setupEvents?: ActivationEvent.ActivationEvent[];
+  cacheEnabled?: boolean;
+  safeMode?: boolean;
+  debounce?: number;
+  timeout?: number;
+  fallback?: FC<FallbackProps>;
+  placeholder?: FC<{ stage: 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.cacheEnabled Whether to cache enabled plugins in localStorage.
+ * @param params.safeMode Whether to enable safe mode, which disables optional plugins.
+ * @param params.fallback Fallback component to render if an error occurs during startup.
+ * @param params.placeholder Placeholder component to render during startup.
+ */
+export const useApp = ({
+  pluginManager,
+  pluginLoader: pluginLoaderProp,
+  plugins: pluginsProp,
+  core: coreProp,
+  defaults: defaultsProp,
+  setupEvents: setupEventsProp,
+  placeholder,
+  fallback = ErrorFallback,
+  cacheEnabled = false,
+  safeMode = false,
+  debounce = 0,
+  timeout = 30_000,
+}: UseAppOptions) => {
+  const plugins = useDefaultValue(pluginsProp, () => []);
+  const core = useDefaultValue(coreProp, () => plugins.map(({ meta }) => meta.id));
+  const defaults = useDefaultValue(defaultsProp, () => []);
+  const setupEvents = useDefaultValue(setupEventsProp, () => []);
+
+  // TODO(wittjosiah): Provide a custom plugin loader which supports loading via url.
+  const pluginLoader = useMemo(
+    () =>
+      pluginLoaderProp ??
+      ((id: string) =>
+        Effect.sync(() => {
+          const plugin = plugins.find((plugin) => plugin.meta.id === id);
+          invariant(plugin, `Plugin not found: ${id}`);
+          return plugin;
+        })),
+    [pluginLoaderProp, plugins],
+  );
+
+  const readyRef = useRef(false);
+  const [ready, setReady] = useState(false);
+  const errorRef = useRef<unknown>(null);
+  const [error, setError] = useState<unknown>(null);
+  // TODO(wittjosiah): Migrate to Atom.kvs for isomorphic storage.
+  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 ?? PluginManager.make({ pluginLoader, plugins, core, enabled }),
+    [pluginManager, pluginLoader, plugins, core, enabled],
+  );
+
+  useEffect(() => {
+    if (!cacheEnabled) {
+      return;
+    }
+    return manager.registry.subscribe(manager.enabled, (value) => {
+      localStorage.setItem(ENABLED_KEY, JSON.stringify(value));
+    });
+  }, [cacheEnabled, manager]);
+
+  useEffect(() => {
+    setupDevtools(manager);
+  }, [manager]);
+
+  useAsyncEffect(async () => {
+    manager.capabilities.contribute({
+      interface: Capabilities.PluginManager,
+      implementation: manager,
+      module: 'dxos.org/app-framework/plugin-manager',
+    });
+
+    manager.capabilities.contribute({
+      interface: Capabilities.AtomRegistry,
+      implementation: manager.registry,
+      module: 'dxos.org/app-framework/atom-registry',
+    });
+
+    const fiber = Effect.gen(function* () {
+      const queue = yield* PubSub.subscribe(manager.activation);
+      const listener = yield* Effect.forkDaemon(
+        Queue.take(queue).pipe(
+          Effect.tap(({ event, state, error: error$ }) =>
+            Effect.sync(() => {
+              if (event === ActivationEvents.Startup.id && state === 'activated') {
+                clearTimeout(timeoutId);
+                setReady(true);
+                readyRef.current = true;
+              }
+              if (error$ && !readyRef.current) {
+                setError(error$);
+                errorRef.current = error$;
+              }
+            }),
+          ),
+          Effect.forever,
+        ),
+      );
+
+      yield* Effect.all([
+        ...setupEvents.map((event) => manager.activate(event)),
+        manager.activate(ActivationEvents.SetupReactSurface),
+        manager.activate(ActivationEvents.Startup),
+      ]);
+
+      return yield* Fiber.join(listener);
+    }).pipe(Effect.scoped, Effect.runFork);
+
+    // Set up a timeout for startup.
+    const timeoutId = setTimeout(() => {
+      if (!readyRef.current && !errorRef.current) {
+        log.warn('startup timeout diagnostic', {
+          eventsFired: manager.getEventsFired(),
+          activeModules: manager.getActive(),
+          pendingReset: manager.getPendingReset(),
+        });
+        void runAndForwardErrors(Fiber.interrupt(fiber));
+        setError(new Error(`Startup timed out after ${timeout}ms`));
+      }
+    }, timeout);
+
+    return () => {
+      clearTimeout(timeoutId);
+      void runAndForwardErrors(Fiber.interrupt(fiber));
+      manager.capabilities.remove(Capabilities.PluginManager, manager);
+      manager.capabilities.remove(Capabilities.AtomRegistry, manager.registry);
+    };
+  }, [manager]);
+
+  return useCallback(
+    () => (
+      <ErrorBoundary name='app' FallbackComponent={fallback}>
+        <PluginManagerProvider value={manager}>
+          <ContextProtocolProvider value={manager} context={PluginManagerContext}>
+            <RegistryContext.Provider value={manager.registry}>
+              <App placeholder={placeholder} ready={ready} error={error} debounce={debounce} />
+            </RegistryContext.Provider>
+          </ContextProtocolProvider>
+        </PluginManagerProvider>
+      </ErrorBoundary>
+    ),
+    [fallback, manager, placeholder, ready, error],
+  );
+};
+
+const setupDevtools = (manager: PluginManager.PluginManager) => {
+  (globalThis as any).composer ??= {};
+  (globalThis as any).composer.manager = manager;
+};

package/src/ui/hooks/useCapabilities.ts

@@ -0,0 +1,67 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom, useAtomValue } from '@effect-atom/atom-react';
+import { useCallback } from 'react';
+
+import { invariant } from '@dxos/invariant';
+
+import { Capabilities } from '../../common';
+import { type Capability } from '../../core';
+import { usePluginManager } from '../components';
+
+/**
+ * Hook to request capabilities from the plugin context.
+ * @returns An array of capabilities.
+ */
+export const useCapabilities = <T>(interfaceDef: Capability.InterfaceDef<T>) => {
+  const manager = usePluginManager();
+  return useAtomValue(manager.capabilities.atom(interfaceDef));
+};
+
+/**
+ * Hook to request a capability from the plugin context.
+ * @returns The capability.
+ * @throws If no capability is found.
+ */
+export const useCapability = <T>(interfaceDef: Capability.InterfaceDef<T>) => {
+  const capabilities = useCapabilities(interfaceDef);
+  invariant(capabilities.length > 0, `No capability found for ${interfaceDef.identifier}`);
+  return capabilities[0];
+};
+
+/**
+ * Hook to get the current value of an atom capability.
+ * Automatically subscribes to changes.
+ * @example const settings = useAtomCapability(ThreadCapabilities.Settings);
+ */
+export const useAtomCapability = <T>(atomCapability: Capability.InterfaceDef<Atom.Atom<T>>): T => {
+  const atom = useCapability(atomCapability);
+  return useAtomValue(atom);
+};
+
+/**
+ * Hook to get value and updater for an atom capability.
+ * Returns [currentValue, updateFn] similar to useState.
+ * @example const [settings, updateSettings] = useAtomCapabilityState(ThreadCapabilities.Settings);
+ */
+export const useAtomCapabilityState = <T>(
+  atomCapability: Capability.InterfaceDef<Atom.Writable<T>>,
+): [T, (fn: (current: T) => T) => void] => {
+  const registry = useCapability(Capabilities.AtomRegistry);
+  const atom = useCapability(atomCapability);
+  const value = useAtomValue(atom);
+  const update = useCallback(
+    (fn: (current: T) => T) => {
+      registry.set(atom, fn(registry.get(atom)));
+    },
+    [registry, atom],
+  );
+  return [value, update];
+};
+
+/**
+ * Hook to get the operation invoker capability.
+ */
+export const useOperationInvoker = (): Capabilities.OperationInvoker => useCapability(Capabilities.OperationInvoker);

package/src/ui/hooks/useLoading.tsx

@@ -0,0 +1,68 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useEffect, useState } from 'react';
+
+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 = (ready: boolean, debounce = 0) => {
+  const [stage, setStage] = useState<LoadingState>(LoadingState.Loading);
+  useEffect(() => {
+    if (!debounce) {
+      return;
+    }
+
+    const i = setInterval(() => {
+      setStage((stage) => {
+        switch (stage) {
+          case LoadingState.Loading: {
+            if (!ready) {
+              return LoadingState.FadeIn;
+            } else {
+              clearInterval(i);
+              return LoadingState.Done;
+            }
+          }
+
+          case LoadingState.FadeIn: {
+            if (ready) {
+              return LoadingState.FadeOut;
+            }
+            break;
+          }
+
+          case LoadingState.FadeOut: {
+            clearInterval(i);
+            return LoadingState.Done;
+          }
+        }
+
+        return stage;
+      });
+    }, debounce);
+
+    return () => clearInterval(i);
+  }, [debounce]);
+
+  if (!debounce) {
+    return ready ? LoadingState.Done : LoadingState.Loading;
+  }
+
+  return stage;
+};

package/src/ui/hooks/useOperationResolver.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useEffect, useMemo } from 'react';
+
+import { Capabilities } from '../../common';
+import { usePluginManager } from '../components';
+
+/**
+ * Hook to dynamically register an operation resolver (handler) within a React component.
+ * The resolver is added when the component mounts and removed when it unmounts.
+ *
+ * @example
+ * ```tsx
+ * const scrollHandler = useMemo(() => OperationResolver.make({
+ *   operation: LayoutOperation.ScrollIntoView,
+ *   handler: (input) => Effect.sync(() => {
+ *     // Handle scroll
+ *   }),
+ * }), [deps]);
+ *
+ * useOperationResolver(meta.id, scrollHandler);
+ * ```
+ */
+export const useOperationResolver = (module: string, resolver: Capabilities.OperationResolver) => {
+  const manager = usePluginManager();
+  // Wrap single resolver in array as the capability expects an array.
+  const resolverArray = useMemo(() => [resolver], [resolver]);
+
+  useEffect(() => {
+    manager.capabilities.contribute({
+      module,
+      interface: Capabilities.OperationResolver,
+      implementation: resolverArray,
+    });
+
+    return () => manager.capabilities.remove(Capabilities.OperationResolver, resolverArray);
+  }, [module, resolverArray]);
+};

package/src/ui/hooks/useSettingsState.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom, RegistryContext, useAtomValue } from '@effect-atom/atom-react';
+import { useCallback, useContext } from 'react';
+
+/**
+ * Hook to read and update a settings atom.
+ * Returns the current value and an update function.
+ */
+export const useSettingsState = <T>(
+  atom: Atom.Writable<T>,
+): { settings: T; updateSettings: (fn: (current: T) => T) => void } => {
+  const registry = useContext(RegistryContext);
+  const settings = useAtomValue(atom);
+
+  const updateSettings = useCallback(
+    (fn: (current: T) => T) => {
+      registry.set(atom, fn(registry.get(atom)));
+    },
+    [registry, atom],
+  );
+
+  return { settings, updateSettings };
+};

package/src/ui/hooks/useSurface.ts

@@ -0,0 +1,13 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useContext } from 'react';
+
+import { raise } from '@dxos/debug';
+
+import { Surface } from '../components';
+
+export const useSurface = (): Surface.Context => {
+  return useContext(Surface.Context) ?? raise(new Error('Missing SurfaceContext'));
+};

package/src/ui/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './components';
+export * from './hooks';

package/tsconfig.json

@@ -15,13 +15,10 @@
       "path": "../../common/debug"
     },
     {
-      "path": "../../common/invariant"
-    },
-    {
-      "path": "../../common/keys"
+      "path": "../../common/effect"
     },
     {
-      "path": "../../common/local-storage"
+      "path": "../../common/invariant"
     },
     {
       "path": "../../common/log"
@@ -33,50 +30,37 @@
       "path": "../../common/storybook-utils"
     },
     {
-      "path": "../../common/util"
-    },
-    {
-      "path": "../../core/ai"
+      "path": "../../common/test-utils"
     },
     {
-      "path": "../../core/blueprints"
-    },
-    {
-      "path": "../../core/echo/echo-schema"
+      "path": "../../common/util"
     },
     {
-      "path": "../../core/echo/echo-signals"
+      "path": "../../common/web-context"
     },
     {
-      "path": "../../core/echo/live-object"
+      "path": "../../common/web-context-react"
     },
     {
-      "path": "../../core/functions"
+      "path": "../../core/echo/echo"
     },
     {
-      "path": "../../ui/primitives/react-hooks"
+      "path": "../../core/echo/echo-db"
     },
     {
-      "path": "../../ui/react-ui"
+      "path": "../../core/operation"
     },
     {
-      "path": "../../ui/react-ui-syntax-highlighter"
+      "path": "../../ui/react-primitives/react-error-boundary"
     },
     {
-      "path": "../app-graph"
+      "path": "../../ui/react-primitives/react-hooks"
     },
     {
-      "path": "../client-protocol"
+      "path": "../../ui/react-ui"
     },
     {
-      "path": "../schema"
+      "path": "../../ui/ui-theme"
     }
-  ],
-  "ts-node": {
-    "compilerOptions": {
-      "module": "CommonJS"
-    },
-    "files": true,
-    "transpileOnly": true
-  }
+  ]
 }

package/tsconfig.node.json

@@ -5,7 +5,5 @@
     "moduleResolution": "Node",
     "allowSyntheticDefaultImports": true
   },
-  "include": [
-    "vite.config.ts"
-  ]
+  "include": ["vite.config.ts"]
 }

package/typedoc.json

@@ -1,7 +1,5 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "includeVersion": true,
-  "entryPoints": [
-    "src/index.ts"
-  ]
-}
+  "entryPoints": ["src/index.ts"]
+}

package/vitest.config.ts

@@ -2,11 +2,13 @@
 // Copyright 2024 DXOS.org
 //
 
-import { defineConfig, mergeConfig } from 'vitest/config';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-import { baseConfig } from '../../../vitest.base.config';
+import { createConfig } from '../../../vitest.base.config';
 
-export default mergeConfig(
-  baseConfig({ cwd: __dirname }),
-  defineConfig({}),
-);
+export default createConfig({
+  dirname: typeof __dirname !== 'undefined' ? __dirname : path.dirname(fileURLToPath(import.meta.url)),
+  node: true,
+  storybook: true,
+});