@dxos/app-framework 0.8.4-main.b97322e → 0.8.4-main.bc674ce

package/src/plugin-settings/app-graph-builder.ts

@@ -2,156 +2,139 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Rx } from '@effect-rx/rx-react';
-import { Option, pipe } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import { createExtension, ROOT_ID } from '@dxos/app-graph';
-import { type SettingsStore, type SettingsValue } from '@dxos/local-storage';
+import { GraphBuilder, NodeMatcher } from '@dxos/app-graph';
+import { Operation } from '@dxos/operation';
 import { isNonNullable } from '@dxos/util';
 
-import { SETTINGS_ID, SETTINGS_KEY, SETTINGS_PLUGIN, SettingsAction } from './actions';
-import { Capabilities } from '../common';
-import { contributes, type PluginMeta, type PluginContext } from '../core';
-import { createIntent } from '../plugin-intent';
+import * as Common from '../common';
+import { Capability, type Plugin } from '../core';
 
-export default (context: PluginContext) =>
-  contributes(Capabilities.AppGraphBuilder, [
-    createExtension({
-      id: `${SETTINGS_PLUGIN}/action`,
-      actions: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => [
-              {
-                id: SETTINGS_PLUGIN,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  await dispatch(createIntent(SettingsAction.Open));
-                },
-                properties: {
-                  label: ['open settings label', { ns: SETTINGS_PLUGIN }],
-                  icon: 'ph--gear--regular',
-                  disposition: 'menu',
-                  keyBinding: {
-                    macos: 'meta+,',
-                    windows: 'alt+,',
-                  },
+import { SETTINGS_ID, SETTINGS_KEY, SettingsOperation } from './actions';
+import { meta } from './meta';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    // Get context for lazy capability access in callbacks.
+    const capabilities = yield* Capability.Service;
+    const managerAtom = capabilities.atom(Common.Capability.PluginManager);
+    const settingsAtom = capabilities.atom(Common.Capability.Settings);
+
+    const extensions = yield* Effect.all([
+      GraphBuilder.createExtension({
+        id: `${meta.id}/action`,
+        match: NodeMatcher.whenRoot,
+        actions: () =>
+          Effect.succeed([
+            {
+              id: meta.id,
+              data: () => Operation.invoke(SettingsOperation.Open, {}),
+              properties: {
+                label: ['open settings label', { ns: meta.id }],
+                icon: 'ph--gear--regular',
+                disposition: 'menu',
+                keyBinding: {
+                  macos: 'meta+,',
+                  windows: 'alt+,',
                 },
               },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-    createExtension({
-      id: `${SETTINGS_PLUGIN}/core`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => [
-              {
-                id: SETTINGS_ID,
-                type: SETTINGS_PLUGIN,
+            },
+          ]),
+      }),
+      GraphBuilder.createExtension({
+        id: `${meta.id}/core`,
+        match: NodeMatcher.whenRoot,
+        connector: () =>
+          Effect.succeed([
+            {
+              id: SETTINGS_ID,
+              type: meta.id,
+              properties: {
+                label: ['app settings label', { ns: meta.id }],
+                icon: 'ph--gear--regular',
+                disposition: 'pin-end',
+                position: 'hoist',
+                testId: 'treeView.appSettings',
+              },
+            },
+          ]),
+      }),
+      GraphBuilder.createExtension({
+        id: `${meta.id}/core-plugins`,
+        match: NodeMatcher.whenId(SETTINGS_ID),
+        connector: (node, get) => {
+          const [manager] = get(managerAtom);
+          const allSettings = get(settingsAtom);
+          return Effect.succeed([
+            ...manager
+              .getPlugins()
+              .filter((plugin: Plugin.Plugin) => manager.getCore().includes(plugin.meta.id))
+              .map((plugin: Plugin.Plugin): [Plugin.Meta, Common.Capability.Settings] | null => {
+                const settings = allSettings.find((s) => s.prefix === plugin.meta.id);
+                if (!settings) {
+                  return null;
+                }
+
+                return [plugin.meta, settings];
+              })
+              .filter(isNonNullable)
+              .map(([meta, settings]: [Plugin.Meta, Common.Capability.Settings]) => ({
+                id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,
+                type: 'category',
+                data: settings,
                 properties: {
-                  label: ['app settings label', { ns: SETTINGS_PLUGIN }],
-                  icon: 'ph--gear--regular',
-                  disposition: 'pin-end',
-                  position: 'hoist',
-                  testId: 'treeView.appSettings',
+                  label: meta.name ?? meta.id,
+                  icon: meta.icon ?? 'ph--circle--regular',
                 },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-    createExtension({
-      id: `${SETTINGS_PLUGIN}/core-plugins`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id !== SETTINGS_ID ? Option.none() : Option.some(node))),
-            Option.map(() => {
-              const manager = get(context.capability(Capabilities.PluginManager));
-              const [settingsStore] = get(context.capabilities(Capabilities.SettingsStore));
-              return [
-                ...manager.plugins
-                  .filter((plugin) => manager.core.includes(plugin.meta.id))
-                  .map((plugin): [PluginMeta, SettingsStore<SettingsValue>] | null => {
-                    const settings = settingsStore?.getStore(plugin.meta.id);
-                    if (!settings) {
-                      return null;
-                    }
+              })),
 
-                    return [plugin.meta, settings];
-                  })
-                  .filter(isNonNullable)
-                  .map(([meta, settings]) => ({
-                    id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,
-                    type: 'category',
-                    data: settings,
-                    properties: {
-                      label: meta.name ?? meta.id,
-                      icon: meta.icon ?? 'ph--circle--regular',
-                    },
-                  })),
+            {
+              id: `${SETTINGS_KEY}:custom-plugins`,
+              type: 'category',
+              properties: {
+                label: ['custom plugins label', { ns: meta.id }],
+                icon: 'ph--squares-four--regular',
+                role: 'branch',
+                disposition: 'collection',
+              },
+            },
+          ]);
+        },
+      }),
+      GraphBuilder.createExtension({
+        id: `${meta.id}/custom-plugins`,
+        match: NodeMatcher.whenId(`${SETTINGS_KEY}:custom-plugins`),
+        connector: (node, get) => {
+          const [manager] = get(managerAtom);
+          const allSettings = get(settingsAtom);
+          return Effect.succeed(
+            manager
+              .getPlugins()
+              .filter((plugin: Plugin.Plugin) => !manager.getCore().includes(plugin.meta.id))
+              .map((plugin: Plugin.Plugin): [Plugin.Meta, Common.Capability.Settings] | null => {
+                const settings = allSettings.find((s) => s.prefix === plugin.meta.id);
+                if (!settings) {
+                  return null;
+                }
 
-                {
-                  id: `${SETTINGS_KEY}:custom-plugins`,
-                  type: 'category',
-                  properties: {
-                    label: ['custom plugins label', { ns: SETTINGS_PLUGIN }],
-                    icon: 'ph--squares-four--regular',
-                    role: 'branch',
-                    disposition: 'collection',
-                  },
+                return [plugin.meta, settings];
+              })
+              .filter(isNonNullable)
+              .map(([meta, settings]: [Plugin.Meta, Common.Capability.Settings]) => ({
+                id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,
+                type: 'category',
+                data: settings,
+                properties: {
+                  label: meta.name ?? meta.id,
+                  icon: meta.icon ?? 'ph--circle--regular',
                 },
-              ];
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-    createExtension({
-      id: `${SETTINGS_PLUGIN}/custom-plugins`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) =>
-              node.id !== `${SETTINGS_KEY}:custom-plugins` ? Option.none() : Option.some(node),
-            ),
-            Option.map(() => {
-              const manager = get(context.capability(Capabilities.PluginManager));
-              const [settingsStore] = get(context.capabilities(Capabilities.SettingsStore));
-              return manager.plugins
-                .filter((plugin) => !manager.core.includes(plugin.meta.id))
-                .map((plugin): [PluginMeta, SettingsStore<SettingsValue>] | null => {
-                  const settings = settingsStore?.getStore(plugin.meta.id);
-                  if (!settings) {
-                    return null;
-                  }
+              })),
+          );
+        },
+      }),
+    ]);
 
-                  return [plugin.meta, settings];
-                })
-                .filter(isNonNullable)
-                .map(([meta, settings]) => ({
-                  id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,
-                  type: 'category',
-                  data: settings,
-                  properties: {
-                    label: meta.name ?? meta.id,
-                    icon: meta.icon ?? 'ph--circle--regular',
-                  },
-                }));
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  ]);
+    return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);
+  }),
+);

package/src/plugin-settings/meta.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Plugin } from '@dxos/app-framework';
+
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/settings',
+  name: 'Settings',
+};

package/src/plugin-settings/operation-resolver.ts

@@ -0,0 +1,55 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { OperationResolver } from '@dxos/operation';
+
+import * as Common from '../common';
+import { Capability } from '../core';
+
+import { SETTINGS_ID, SETTINGS_KEY, SettingsOperation } from './actions';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Common.Capability.OperationResolver, [
+      //
+      // Open Settings
+      //
+      OperationResolver.make({
+        operation: SettingsOperation.Open,
+        handler: (input) =>
+          Effect.gen(function* () {
+            const { invoke } = yield* Capability.get(Common.Capability.OperationInvoker);
+            yield* invoke(Common.LayoutOperation.SwitchWorkspace, { subject: SETTINGS_ID });
+            if (input.plugin) {
+              // Fire and forget the open operation.
+              yield* Effect.fork(
+                invoke(Common.LayoutOperation.Open, {
+                  subject: [`${SETTINGS_KEY}:${input.plugin.replaceAll('/', ':')}`],
+                }),
+              );
+            }
+          }),
+      }),
+
+      //
+      // Open Plugin Registry
+      //
+      OperationResolver.make({
+        operation: SettingsOperation.OpenPluginRegistry,
+        handler: () =>
+          Effect.gen(function* () {
+            const { invoke } = yield* Capability.get(Common.Capability.OperationInvoker);
+            yield* invoke(Common.LayoutOperation.SwitchWorkspace, { subject: SETTINGS_ID });
+            yield* Effect.fork(
+              invoke(Common.LayoutOperation.Open, {
+                subject: [`${SETTINGS_KEY}:plugins`],
+              }),
+            );
+          }),
+      }),
+    ]);
+  }),
+);

package/src/plugin-settings/translations.ts

@@ -1,15 +1,15 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-import { type Resource } from '@dxos/react-ui';
+import { type Resource } from '../common';
 
-import { SETTINGS_PLUGIN } from './actions';
+import { meta } from './meta';
 
 export const translations = [
   {
     'en-US': {
-      [SETTINGS_PLUGIN]: {
+      [meta.id]: {
         'open settings label': 'Open settings',
         'app settings label': 'Settings',
         'custom plugins label': 'Plugins',

package/src/react/App.stories.tsx

@@ -0,0 +1,63 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { withTheme } from '@dxos/react-ui/testing';
+
+import * as Common from '../common';
+import { Capability, Plugin } from '../core';
+
+import { useApp } from './useApp';
+
+// Minimal plugin that contributes a ReactRoot.
+const TestPlugin = Plugin.define({
+  id: 'dxos.org/plugin/test',
+  name: 'Test Plugin',
+}).pipe(
+  Plugin.addModule({
+    id: 'TestMain',
+    activatesOn: Common.ActivationEvent.Startup,
+    activate: () =>
+      Effect.succeed([
+        Capability.contributes(Common.Capability.ReactRoot, {
+          id: 'dxos.org/plugin/test/root',
+          root: () => (
+            <div className='fixed inset-0 flex items-center justify-center text-2xl'>App Started Successfully!</div>
+          ),
+        }),
+      ]),
+  }),
+  Plugin.make,
+);
+
+const plugins = [TestPlugin()];
+const core = [TestPlugin.meta.id];
+
+const DefaultStory = () => {
+  const App = useApp({
+    plugins,
+    core,
+    placeholder: () => <div className='fixed inset-0 flex items-center justify-center'>Loading...</div>,
+  });
+
+  return <App />;
+};
+
+const meta = {
+  title: 'sdk/app-framework/App',
+  render: DefaultStory,
+  decorators: [withTheme],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/react/App.tsx

@@ -0,0 +1,60 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { type PropsWithChildren } from 'react';
+
+import * as Common from '../common';
+import { topologicalSort } from '../helpers';
+
+import { type UseAppOptions } from './useApp';
+import { useCapabilities } from './useCapabilities';
+import { LoadingState, useLoading } from './useLoading';
+
+export type AppProps = Pick<UseAppOptions, 'placeholder' | 'debounce'> & {
+  ready: boolean;
+  error: unknown;
+};
+
+export const App = ({ placeholder: Placeholder, ready, error, debounce }: AppProps) => {
+  const reactContexts = useCapabilities(Common.Capability.ReactContext);
+  const reactRoots = useCapabilities(Common.Capability.ReactRoot);
+  const stage = useLoading(ready, debounce);
+
+  if (error) {
+    // This triggers the error boundary to provide UI feedback for the startup error.
+    throw error;
+  }
+
+  // TODO(wittjosiah): Consider using Suspense instead.
+  if (stage < LoadingState.Done) {
+    if (!Placeholder) {
+      return null;
+    }
+
+    return <Placeholder stage={stage} />;
+  }
+
+  const ComposedContext = composeContexts(reactContexts);
+  return (
+    <ComposedContext>
+      {reactRoots.map(({ id, root: Component }) => (
+        <Component key={id} />
+      ))}
+    </ComposedContext>
+  );
+};
+
+const composeContexts = (contexts: Common.Capability.ReactContext[]) => {
+  if (contexts.length === 0) {
+    return ({ children }: PropsWithChildren) => <>{children}</>;
+  }
+
+  return topologicalSort(contexts)
+    .map(({ context }) => context)
+    .reduce((Acc, Next) => ({ children }) => (
+      <Acc>
+        <Next>{children}</Next>
+      </Acc>
+    ));
+};

package/src/react/DefaultFallback.tsx

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+/**
+ * NOTE: Default fallback should not use tailwind or theme.
+ */
+export const DefaultFallback = ({ error }: { error: Error }) => {
+  return (
+    <div
+      style={{
+        margin: '1rem',
+        padding: '1rem',
+        overflow: 'hidden',
+        border: '4px solid teal',
+        borderRadius: '1rem',
+      }}
+    >
+      {/* TODO(wittjosiah): Link to docs for replacing default. */}
+      <h1 style={{ margin: '0.5rem 0', fontSize: '1.2rem' }}>ERROR: {error.message}</h1>
+      <pre style={{ overflow: 'auto', fontSize: '1rem', whiteSpace: 'pre-wrap', color: '#888888' }}>{error.stack}</pre>
+    </div>
+  );
+};

package/src/react/ErrorBoundary.tsx

@@ -2,38 +2,40 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { Component, type FC, type PropsWithChildren } from 'react';
+import React, { Component, type FC, type PropsWithChildren, type ReactNode } from 'react';
 
-type Props = PropsWithChildren<{ data?: any; fallback: FC<{ data?: any; error: Error; reset: () => void }> }>;
-type State = { error: Error | undefined };
+type State = {
+  error: Error | undefined;
+};
+
+export type ErrorBoundaryProps = PropsWithChildren<{
+  data?: any;
+  fallback?: FC<{ data?: any; error: Error }>;
+}>;
 
 /**
  * Surface error boundary.
- *
  * For basic usage prefer providing a fallback component to `Surface`.
  *
- * For more information on error boundaries, see:
- * https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
+ * Ref: https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
  */
-export class ErrorBoundary extends Component<Props, State> {
-  constructor(props: Props) {
-    super(props);
-    this.state = { error: undefined };
-  }
-
+export class ErrorBoundary extends Component<ErrorBoundaryProps, State> {
   static getDerivedStateFromError(error: Error): { error: Error } {
     return { error };
   }
 
-  override componentDidUpdate(prevProps: Props): void {
+  override state = { error: undefined };
+
+  override componentDidUpdate(prevProps: ErrorBoundaryProps): void {
     if (prevProps.data !== this.props.data) {
       this.resetError();
     }
   }
 
-  override render(): string | number | boolean | React.JSX.Element | Iterable<React.ReactNode> | null | undefined {
+  override render(): ReactNode {
     if (this.state.error) {
-      return <this.props.fallback data={this.props.data} error={this.state.error} reset={this.resetError} />;
+      const Fallback = this.props.fallback ?? DefaultFallback;
+      return <Fallback data={this.props.data} error={this.state.error} />;
     }
 
     return this.props.children;
@@ -43,3 +45,12 @@ export class ErrorBoundary extends Component<Props, State> {
     this.setState({ error: undefined });
   }
 }
+
+const DefaultFallback: NonNullable<ErrorBoundaryProps['fallback']> = ({ data, error }) => {
+  return (
+    <div className='flex flex-col gap-2 overflow-hidden border border-red-500 rounded-sm'>
+      <h1 className='p-2'>ERROR: {error.message}</h1>
+      <pre className='p-2 overflow-y-auto text-sm text-subdued'>{JSON.stringify(data, null, 2)}</pre>
+    </div>
+  );
+};