@dxos/app-framework 0.7.5-main.9d2a38b → 0.7.5-main.ff8607b

package/src/plugin-settings/actions.ts

@@ -2,10 +2,12 @@
 // Copyright 2023 DXOS.org
 //
 
-import { S } from '@dxos/echo-schema';
+import { Schema as S } from '@effect/schema';
 
 export const SETTINGS_PLUGIN = 'dxos.org/plugin/settings';
 export const SETTINGS_ACTION = `${SETTINGS_PLUGIN}/action`;
+export const SETTINGS_ID = 'dxos:settings';
+export const SETTINGS_KEY = 'settings';
 
 export namespace SettingsAction {
   export class Open extends S.TaggedClass<Open>()(`${SETTINGS_ACTION}/open`, {
@@ -14,4 +16,12 @@ export namespace SettingsAction {
     }),
     output: S.Void,
   }) {}
+
+  export class OpenPluginRegistry extends S.TaggedClass<OpenPluginRegistry>()(
+    `${SETTINGS_ACTION}/open-plugin-registry`,
+    {
+      input: S.Void,
+      output: S.Void,
+    },
+  ) {}
 }

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

@@ -0,0 +1,122 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { createExtension, type Node } from '@dxos/app-graph';
+import { type SettingsStore, type SettingsValue } from '@dxos/local-storage';
+import { nonNullable } from '@dxos/util';
+
+import { SETTINGS_ID, SETTINGS_KEY, SETTINGS_PLUGIN, SettingsAction } from './actions';
+import { Capabilities } from '../common';
+import { contributes, type PluginMeta, type PluginsContext } from '../core';
+import { createIntent } from '../plugin-intent';
+
+export default (context: PluginsContext) =>
+  contributes(Capabilities.AppGraphBuilder, [
+    createExtension({
+      id: `${SETTINGS_PLUGIN}/action`,
+      filter: (node): node is Node<null> => node.id === 'root',
+      actions: () => [
+        {
+          id: SETTINGS_PLUGIN,
+          data: async () => {
+            const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);
+            await dispatch(createIntent(SettingsAction.Open));
+          },
+          properties: {
+            label: ['open settings label', { ns: SETTINGS_PLUGIN }],
+            icon: 'ph--gear--regular',
+            keyBinding: {
+              macos: 'meta+,',
+              windows: 'alt+,',
+            },
+          },
+        },
+      ],
+    }),
+    createExtension({
+      id: `${SETTINGS_PLUGIN}/core`,
+      filter: (node): node is Node<null> => node.id === 'root',
+      connector: () => [
+        {
+          id: SETTINGS_ID,
+          type: SETTINGS_PLUGIN,
+          properties: {
+            label: ['app settings label', { ns: SETTINGS_PLUGIN }],
+            icon: 'ph--gear--regular',
+            disposition: 'pin-end',
+            position: 'fallback',
+            testId: 'treeView.appSettings',
+          },
+        },
+      ],
+    }),
+    createExtension({
+      id: `${SETTINGS_PLUGIN}/core-plugins`,
+      filter: (node): node is Node<null> => node.id === SETTINGS_ID,
+      connector: () => {
+        const manager = context.requestCapability(Capabilities.PluginManager);
+        const [settingsStore] = context.requestCapabilities(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(nonNullable)
+            .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: 'collection',
+            properties: {
+              label: ['custom plugins label', { ns: SETTINGS_PLUGIN }],
+              icon: 'ph--squares-four--regular',
+              role: 'branch',
+            },
+          },
+        ];
+      },
+    }),
+    createExtension({
+      id: `${SETTINGS_PLUGIN}/custom-plugins`,
+      filter: (node): node is Node<null> => node.id === `${SETTINGS_KEY}:custom-plugins`,
+      connector: () => {
+        const manager = context.requestCapability(Capabilities.PluginManager);
+        const [settingsStore] = context.requestCapabilities(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(nonNullable)
+          .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',
+            },
+          }));
+      },
+    }),
+  ]);

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

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { pipe } from 'effect';
+
+import { SETTINGS_ID, SETTINGS_KEY, SettingsAction } from './actions';
+import { Capabilities, LayoutAction } from '../common';
+import { contributes } from '../core';
+import { createResolver, createIntent, chain } from '../plugin-intent';
+
+export default () =>
+  contributes(
+    Capabilities.IntentResolver,
+    createResolver({
+      intent: SettingsAction.Open,
+      resolve: ({ plugin }) => {
+        return {
+          intents: [
+            pipe(
+              createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: SETTINGS_ID }),
+              chain(LayoutAction.Open, { part: 'main', subject: [`${SETTINGS_KEY}:${plugin.replaceAll('/', ':')}`] }),
+            ),
+          ],
+        };
+      },
+    }),
+  );

package/src/plugin-settings/store.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RootSettingsStore } from '@dxos/local-storage';
+
+import { Capabilities } from '../common';
+import { contributes, type PluginsContext } from '../core';
+
+export default (context: PluginsContext) => {
+  // TODO(wittjosiah): This should subscribe to capabilities and create stores for newly added settings objects.
+  const allSettings = context.requestCapabilities(Capabilities.Settings);
+  const settingsStore = new RootSettingsStore();
+
+  allSettings.forEach((setting) => {
+    settingsStore.createStore(setting as any);
+  });
+
+  return contributes(Capabilities.SettingsStore, settingsStore);
+};

package/src/plugin-settings/translations.ts

@@ -0,0 +1,17 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { SETTINGS_PLUGIN } from './actions';
+
+export default [
+  {
+    'en-US': {
+      [SETTINGS_PLUGIN]: {
+        'open settings label': 'Open settings',
+        'app settings label': 'Settings',
+        'custom plugins label': 'Plugins',
+      },
+    },
+  },
+];

package/src/{plugin-intent → react}/IntentContext.tsx

@@ -7,9 +7,9 @@ import { type Context, createContext, useContext, type Provider, useEffect } fro
 import { raise } from '@dxos/debug';
 import { pick } from '@dxos/util';
 
-import { type AnyIntentResolver, type IntentContext } from './intent-dispatcher';
+import { usePluginManager } from './PluginManagerProvider';
 import { Capabilities } from '../common';
-import { usePluginManager } from '../react';
+import { type AnyIntentResolver, type IntentContext } from '../plugin-intent';
 
 const IntentContext: Context<IntentContext | undefined> = createContext<IntentContext | undefined>(undefined);
 

package/src/react/Surface.stories.tsx

@@ -0,0 +1,96 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import '@dxos-theme';
+
+import React, { useCallback, useState } from 'react';
+
+import { faker } from '@dxos/random';
+import { Button, List, ListItem } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/storybook-utils';
+
+import { PluginManagerProvider, usePluginManager } from './PluginManagerProvider';
+import { Surface, useSurfaces } from './Surface';
+import { Capabilities, createSurface } from '../common';
+import { type PluginManager } from '../core';
+import { setupPluginManager } from '../testing';
+
+const randomColor = (): string => {
+  const hue = faker.number.int({ min: 0, max: 360 });
+  const saturation = faker.number.int({ min: 50, max: 90 });
+  const lightness = faker.number.int({ min: 40, max: 70 });
+  return `hsl(${hue}, ${saturation}%, ${lightness}%)`;
+};
+
+const Story = () => {
+  const manager = usePluginManager();
+  const surfaces = useSurfaces();
+  const [picked, setPicked] = useState('test');
+
+  const handleAdd = useCallback(() => {
+    const id = `test-${faker.number.int({ min: 0, max: 1_000_000 })}`;
+    const backgroundColor = randomColor();
+
+    manager.context.contributeCapability({
+      module: 'test',
+      interface: Capabilities.ReactSurface,
+      implementation: createSurface({
+        id,
+        role: id,
+        component: () => (
+          <div className='flex-1' style={{ backgroundColor }}>
+            {id}
+          </div>
+        ),
+      }),
+    });
+
+    setPicked(id);
+  }, [manager]);
+
+  const handlePick = useCallback(() => {
+    setPicked(faker.helpers.arrayElement(surfaces).id);
+  }, [surfaces]);
+
+  return (
+    <div className='flex flex-col gap-2'>
+      <div className='flex gap-2'>
+        <Button onClick={handleAdd}>Add</Button>
+        <Button onClick={handlePick}>Pick</Button>
+      </div>
+      <div className='flex gap-2'>
+        <div className='flex-1'>
+          <List itemSizes='one'>
+            {surfaces.map((surface) => (
+              <ListItem.Root key={surface.id} id={surface.id}>
+                <ListItem.Heading classNames='grow pbs-2'>{surface.id}</ListItem.Heading>
+              </ListItem.Root>
+            ))}
+          </List>
+        </div>
+        <div className='flex-1'>
+          <Surface role={picked} limit={1} />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default {
+  title: 'sdk/app-framework/Surface',
+  render: ({ manager }: { manager: PluginManager }) => {
+    return (
+      <PluginManagerProvider value={manager}>
+        <Story />
+      </PluginManagerProvider>
+    );
+  },
+  // NOTE: Intentionally not using withPluginManager to try to reduce surface area of the story.
+  decorators: [withTheme, withLayout({ tooltips: true })],
+  args: {
+    manager: setupPluginManager(),
+  },
+};
+
+export const Default = {};

package/src/react/Surface.tsx

@@ -5,14 +5,17 @@
 import React, { memo, forwardRef, Suspense, useMemo } from 'react';
 
 import { useDefaultValue } from '@dxos/react-hooks';
-import { byDisposition } from '@dxos/util';
+import { byPosition } from '@dxos/util';
 
 import { ErrorBoundary } from './ErrorBoundary';
 import { useCapabilities } from './useCapabilities';
 import { Capabilities, type SurfaceDefinition, type SurfaceProps } from '../common';
 import { type PluginsContext } from '../core';
 
-const useSurfaces = () => {
+/**
+ * @internal
+ */
+export const useSurfaces = () => {
   const surfaces = useCapabilities(Capabilities.ReactSurface);
   return useMemo(() => surfaces.flat(), [surfaces]);
 };
@@ -23,7 +26,7 @@ const findCandidates = (surfaces: SurfaceDefinition[], { role, data }: Pick<Surf
       Array.isArray(definition.role) ? definition.role.includes(role) : definition.role === role,
     )
     .filter(({ filter }) => (filter ? filter(data ?? {}) : true))
-    .toSorted(byDisposition);
+    .toSorted(byPosition);
 };
 
 /**
@@ -49,11 +52,9 @@ export const Surface = memo(
       const surfaces = useSurfaces();
       const data = useDefaultValue(_data, () => ({}));
 
-      const candidates = useMemo(() => {
-        const definitions = findCandidates(surfaces, { role, data });
-        return limit ? definitions.slice(0, limit) : definitions;
-      }, [surfaces, role, data, limit]);
-
+      // 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} />
       ));
@@ -70,3 +71,5 @@ export const Surface = memo(
     },
   ),
 );
+
+Surface.displayName = 'Surface';

package/src/react/common.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCapability } from './useCapabilities';
+import { Capabilities } from '../common';
+
+export const useIntentDispatcher = () => useCapability(Capabilities.IntentDispatcher);
+
+export const useAppGraph = () => useCapability(Capabilities.AppGraph);
+
+export const useLayout = () => useCapability(Capabilities.Layout);

package/src/react/index.ts

@@ -2,7 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './common';
 export * from './ErrorBoundary';
 export * from './PluginManagerProvider';
 export * from './Surface';
 export * from './useCapabilities';
+export * from './useIntentResolver';

package/src/react/useIntentResolver.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { useEffect } from 'react';
+
+import { Capabilities } from '../common';
+import { type AnyIntentResolver } from '../plugin-intent';
+import { usePluginManager } from '../react';
+
+export const useIntentResolver = (module: string, resolver: AnyIntentResolver) => {
+  const manager = usePluginManager();
+  useEffect(() => {
+    manager.context.contributeCapability({
+      module,
+      interface: Capabilities.IntentResolver,
+      implementation: resolver,
+    });
+
+    return () => manager.context.removeCapability(Capabilities.IntentResolver, resolver);
+  }, [module, resolver]);
+};

package/src/testing/withPluginManager.tsx

@@ -12,14 +12,14 @@ import { Capabilities, Events } from '../common';
 import { type AnyCapability, contributes, defineModule, definePlugin, PluginManager } from '../core';
 
 /**
- * Wraps a story with a plugin manager.
+ * @internal
  */
-export const withPluginManager = ({
+export const setupPluginManager = ({
   capabilities,
   plugins = [],
   core = plugins.map(({ meta }) => meta.id),
   ...options
-}: CreateAppOptions & { capabilities?: AnyCapability[] } = {}): Decorator => {
+}: CreateAppOptions & { capabilities?: AnyCapability[] } = {}) => {
   const pluginManager = new PluginManager({
     pluginLoader: () => raise(new Error('Not implemented')),
     plugins: [StoryPlugin(), ...plugins],
@@ -37,6 +37,14 @@ export const withPluginManager = ({
     });
   }
 
+  return pluginManager;
+};
+
+/**
+ * Wraps a story with a plugin manager.
+ */
+export const withPluginManager = (options: CreateAppOptions & { capabilities?: AnyCapability[] } = {}): Decorator => {
+  const pluginManager = setupPluginManager(options);
   const App = createApp({ pluginManager });
 
   return (Story, context) => {

package/src/worker.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// Entrypoint for using plugins in workers runtimes (e.g. Cloudflare Workers, etc.)
+// Excludes all frontend code & dependencies (e.g. localStorage, React, etc.)
+
+export * from './core';
+// NOTE: Common includes browser capabilities but they are types only.
+export * from './common';
+export * from './plugin-intent';

package/tsconfig.json

@@ -20,9 +20,6 @@
     {
       "path": "../../common/async"
     },
-    {
-      "path": "../../common/context"
-    },
     {
       "path": "../../common/debug"
     },
@@ -35,6 +32,9 @@
     {
       "path": "../../common/log"
     },
+    {
+      "path": "../../common/random"
+    },
     {
       "path": "../../common/storybook-utils"
     },