@dxos/plugin-simple-layout 0.0.0 → 0.8.4-main.1068cf700f

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@dxos/plugin-simple-layout",
-  "version": "0.0.0",
+  "version": "0.8.4-main.1068cf700f",
   "description": "Simple layout plugin for minimal UI contexts like popover windows.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
   "exports": {
     ".": {
-      "source": "./src/index.ts",
-      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
-      "node": "./dist/lib/node-esm/index.mjs"
+      "node": "./dist/lib/node-esm/index.mjs",
+      "source": "./src/index.ts",
+      "types": "./dist/types/src/index.d.ts"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -22,43 +26,49 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
+    "@effect-atom/atom": "^0.5.1",
+    "@effect-atom/atom-react": "^0.5.0",
     "@radix-ui/react-context": "1.1.1",
-    "@dxos/app-framework": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/react-ui-menu": "0.8.3",
-    "@dxos/live-object": "0.8.3",
-    "@dxos/plugin-graph": "0.8.3",
-    "@dxos/operation": "0.0.0",
-    "@dxos/react-ui-searchlist": "0.8.3",
-    "@dxos/schema": "0.8.3",
-    "@dxos/react-ui-attention": "0.8.3",
-    "@dxos/react-ui-stack": "0.8.3",
-    "@dxos/util": "0.8.3",
-    "@dxos/react-ui-mosaic": "0.8.3"
+    "@tauri-apps/plugin-deep-link": "^2.2.0",
+    "@tauri-apps/plugin-haptics": "^2.3.2",
+    "@dxos/app-framework": "0.8.4-main.1068cf700f",
+    "@dxos/app-toolkit": "0.8.4-main.1068cf700f",
+    "@dxos/async": "0.8.4-main.1068cf700f",
+    "@dxos/log": "0.8.4-main.1068cf700f",
+    "@dxos/operation": "0.8.4-main.1068cf700f",
+    "@dxos/plugin-graph": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui-attention": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui-menu": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui-mosaic": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui-searchlist": "0.8.4-main.1068cf700f",
+    "@dxos/schema": "0.8.4-main.1068cf700f",
+    "@dxos/util": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui-stack": "0.8.4-main.1068cf700f"
   },
   "devDependencies": {
     "@types/react": "~19.2.7",
     "@types/react-dom": "~19.2.3",
-    "effect": "3.19.11",
+    "effect": "3.19.16",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
     "vite": "7.1.9",
-    "@dxos/echo-signals": "0.8.3",
-    "@dxos/plugin-search": "0.8.3",
-    "@dxos/plugin-client": "0.8.3",
-    "@dxos/plugin-space": "0.8.3",
-    "@dxos/plugin-testing": "0.0.0",
-    "@dxos/ui-theme": "0.0.0",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/storybook-utils": "0.8.3"
+    "@dxos/app-graph": "0.8.4-main.1068cf700f",
+    "@dxos/plugin-preview": "0.8.4-main.1068cf700f",
+    "@dxos/plugin-search": "0.8.4-main.1068cf700f",
+    "@dxos/plugin-client": "0.8.4-main.1068cf700f",
+    "@dxos/plugin-space": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui": "0.8.4-main.1068cf700f",
+    "@dxos/storybook-utils": "0.8.4-main.1068cf700f",
+    "@dxos/schema": "0.8.4-main.1068cf700f",
+    "@dxos/ui-theme": "0.8.4-main.1068cf700f",
+    "@dxos/plugin-testing": "0.8.4-main.1068cf700f"
   },
   "peerDependencies": {
-    "effect": "3.19.11",
+    "effect": "3.19.16",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/ui-theme": "0.0.0"
+    "@dxos/react-ui": "0.8.4-main.1068cf700f",
+    "@dxos/ui-theme": "0.8.4-main.1068cf700f"
   },
   "publishConfig": {
     "access": "public"

package/src/SimpleLayoutPlugin.ts

@@ -2,11 +2,13 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capability, Common, Plugin } from '@dxos/app-framework';
+import { ActivationEvent, ActivationEvents, Capability, Plugin } from '@dxos/app-framework';
+import { AppActivationEvents, AppPlugin } from '@dxos/app-toolkit';
 
-import { OperationResolver, ReactRoot, type SimpleLayoutStateOptions, State } from './capabilities';
+import { OperationResolver, ReactRoot, ReactSurface, SpotlightDismiss, State, UrlHandler } from './capabilities';
 import { meta } from './meta';
 import { translations } from './translations';
+import { SimpleLayoutEvents } from './types';
 
 export type SimpleLayoutPluginOptions = {
   /** Whether running in popover window context (hides mobile-specific UI). */
@@ -14,18 +16,33 @@ export type SimpleLayoutPluginOptions = {
 };
 
 export const SimpleLayoutPlugin = Plugin.define<SimpleLayoutPluginOptions>(meta).pipe(
+  AppPlugin.addOperationResolverModule({ activate: OperationResolver }),
+  AppPlugin.addTranslationsModule({ translations }),
   Plugin.addModule(({ isPopover = false }) => ({
     id: Capability.getModuleTag(State),
-    activatesOn: Common.ActivationEvent.Startup,
-    activatesAfter: [Common.ActivationEvent.LayoutReady],
-    activate: () => State({ initialState: { isPopover } } satisfies SimpleLayoutStateOptions),
+    activatesOn: ActivationEvents.Startup,
+    activatesAfter: [SimpleLayoutEvents.StateReady, AppActivationEvents.LayoutReady],
+    activate: () => State({ initialState: { isPopover } }),
+  })),
+  Plugin.addModule(({ isPopover = false }) => ({
+    id: Capability.getModuleTag(SpotlightDismiss),
+    activatesOn: ActivationEvents.Startup,
+    activate: () => SpotlightDismiss({ isPopover }),
   })),
   Plugin.addModule({
     id: Capability.getModuleTag(ReactRoot),
-    activatesOn: Common.ActivationEvent.Startup,
+    activatesOn: ActivationEvents.Startup,
     activate: ReactRoot,
   }),
-  Common.Plugin.addOperationResolverModule({ activate: OperationResolver }),
-  Common.Plugin.addTranslationsModule({ translations }),
+  Plugin.addModule({
+    id: Capability.getModuleTag(ReactSurface),
+    activatesOn: ActivationEvents.Startup,
+    activate: ReactSurface,
+  }),
+  Plugin.addModule({
+    id: Capability.getModuleTag(UrlHandler),
+    activatesOn: ActivationEvent.allOf(ActivationEvents.OperationInvokerReady, SimpleLayoutEvents.StateReady),
+    activate: UrlHandler,
+  }),
   Plugin.make,
 );

package/src/capabilities/index.ts

@@ -4,4 +4,7 @@
 
 export * from './operation-resolver';
 export * from './react-root';
+export * from './react-surface';
+export * from './spotlight-dismiss';
 export * from './state';
+export * from './url-handler';

package/src/capabilities/operation-resolver/operation-resolver.ts

@@ -4,43 +4,80 @@
 
 import * as Effect from 'effect/Effect';
 
-import { Capability, Common } from '@dxos/app-framework';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { LayoutOperation } from '@dxos/app-toolkit';
 import { Operation, OperationResolver } from '@dxos/operation';
+import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
 
-import { SimpleLayoutState } from '../../types';
+import { type SimpleLayoutState, SimpleLayoutState as SimpleLayoutStateCapability } from '../../types';
+
+/** Maximum number of items to keep in navigation history. */
+const MAX_HISTORY_LENGTH = 50;
+
+/** Parse entry ID to extract primary ID and variant. */
+const parseEntryId = (entryId: string) => {
+  const [id, variant] = entryId.split(ATTENDABLE_PATH_SEPARATOR);
+  return { id, variant };
+};
 
 export default Capability.makeModule(
   Effect.fnUntraced(function* () {
-    return Capability.contributes(Common.Capability.OperationResolver, [
+    const registry = yield* Capability.get(Capabilities.AtomRegistry);
+    const stateAtom = yield* Capability.get(SimpleLayoutStateCapability);
+
+    const getState = () => registry.get(stateAtom);
+    const updateState = (fn: (current: SimpleLayoutState) => SimpleLayoutState) => {
+      registry.set(stateAtom, fn(getState()));
+    };
+
+    return Capability.contributes(Capabilities.OperationResolver, [
+      //
+      // SetLayoutMode
+      //
+      // TODO(burdon): No-op for to fix startup bug?
+      OperationResolver.make({
+        operation: LayoutOperation.SetLayoutMode,
+        handler: Effect.fnUntraced(function* () {}),
+      }),
+
       //
       // UpdateSidebar - No-op for simple layout.
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.UpdateSidebar,
+        operation: LayoutOperation.UpdateSidebar,
         handler: () => Effect.void,
       }),
 
       //
-      // UpdateComplementary - No-op for simple layout.
+      // UpdateComplementary - Controls companion drawer.
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.UpdateComplementary,
-        handler: () => Effect.void,
+        operation: LayoutOperation.UpdateComplementary,
+        handler: Effect.fnUntraced(function* (input) {
+          if (input.state === 'closed') {
+            updateState((state) => ({
+              ...state,
+              drawerState: 'closed',
+            }));
+          }
+        }),
       }),
 
       //
       // UpdateDialog
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.UpdateDialog,
+        operation: LayoutOperation.UpdateDialog,
         handler: Effect.fnUntraced(function* (input) {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          layout.dialogOpen = input.state ?? Boolean(input.subject);
-          layout.dialogType = input.type ?? 'default';
-          layout.dialogBlockAlign = input.blockAlign ?? 'center';
-          layout.dialogOverlayClasses = input.overlayClasses;
-          layout.dialogOverlayStyle = input.overlayStyle;
-          layout.dialogContent = input.subject ? { component: input.subject, props: input.props } : null;
+          updateState((state) => ({
+            ...state,
+            dialogOpen: input.state ?? Boolean(input.subject),
+            dialogType: input.type ?? 'default',
+            dialogBlockAlign: input.blockAlign ?? 'center',
+            dialogOverlayClasses: input.overlayClasses,
+            dialogOverlayStyle: input.overlayStyle,
+            dialogContent: input.subject ? { component: input.subject, props: input.props } : undefined,
+          }));
         }),
       }),
 
@@ -48,23 +85,24 @@ export default Capability.makeModule(
       // UpdatePopover
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.UpdatePopover,
+        operation: LayoutOperation.UpdatePopover,
         handler: Effect.fnUntraced(function* (input) {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          layout.popoverOpen = input.state ?? Boolean(input.subject);
-          layout.popoverContent =
-            typeof input.subject === 'string'
-              ? { component: input.subject, props: input.props }
-              : input.subject
-                ? { subject: input.subject }
-                : undefined;
-          layout.popoverSide = input.side;
-          layout.popoverVariant = input.variant;
-          if (input.variant === 'virtual') {
-            layout.popoverAnchor = input.anchor;
-          } else {
-            layout.popoverAnchorId = input.anchorId;
-          }
+          updateState((state) => ({
+            ...state,
+            popoverOpen: input.state ?? Boolean(input.subject),
+            popoverKind: input.kind ?? 'base',
+            popoverTitle: input.kind === 'card' ? input.title : undefined,
+            popoverContent:
+              typeof input.subject === 'string'
+                ? { component: input.subject, props: input.props }
+                : input.subject
+                  ? { subject: input.subject }
+                  : undefined,
+            popoverSide: input.side,
+            popoverVariant: input.variant,
+            popoverAnchor: input.variant === 'virtual' ? input.anchor : state.popoverAnchor,
+            popoverAnchorId: input.variant !== 'virtual' ? input.anchorId : state.popoverAnchorId,
+          }));
         }),
       }),
 
@@ -72,16 +110,18 @@ export default Capability.makeModule(
       // SwitchWorkspace
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.SwitchWorkspace,
+        operation: LayoutOperation.SwitchWorkspace,
         handler: Effect.fnUntraced(function* (input) {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          // TODO(wittjosiah): This is a hack to prevent the previous deck from being set for pinned items.
-          //  Ideally this should be worked into the data model in a generic way.
-          if (!layout.workspace.startsWith('!')) {
-            layout.previousWorkspace = layout.workspace;
-          }
-          layout.workspace = input.subject;
-          layout.active = undefined;
+          updateState((state) => ({
+            ...state,
+            // TODO(wittjosiah): This is a hack to prevent the previous deck from being set for pinned items.
+            //  Ideally this should be worked into the data model in a generic way.
+            previousWorkspace: !state.workspace.startsWith('!') ? state.workspace : state.previousWorkspace,
+            workspace: input.subject,
+            active: undefined,
+            // Clear history when switching workspaces.
+            history: [],
+          }));
         }),
       }),
 
@@ -89,11 +129,11 @@ export default Capability.makeModule(
       // RevertWorkspace
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.RevertWorkspace,
+        operation: LayoutOperation.RevertWorkspace,
         handler: Effect.fnUntraced(function* () {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          yield* Operation.invoke(Common.LayoutOperation.SwitchWorkspace, {
-            subject: layout.previousWorkspace,
+          const state = getState();
+          yield* Operation.invoke(LayoutOperation.SwitchWorkspace, {
+            subject: state.previousWorkspace,
           });
         }),
       }),
@@ -102,10 +142,35 @@ export default Capability.makeModule(
       // Open
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.Open,
+        operation: LayoutOperation.Open,
         handler: Effect.fnUntraced(function* (input) {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          layout.active = input.subject[0];
+          const id = input.subject[0];
+          const { id: primaryId, variant } = parseEntryId(id);
+          const state = getState();
+
+          // Only treat as companion when opening a variant of the current workspace/active (e.g. object~comments).
+          // IDs like settings~spaceId are alternate-tree nodes and should navigate main content, not open the drawer.
+          // TODO(wittjosiah): Factor out the change-companion operation from deck to a common layout operation.
+          const isCompanionOfCurrent = variant && (primaryId === state.workspace || primaryId === state.active);
+          if (isCompanionOfCurrent) {
+            updateState((state) => ({
+              ...state,
+              companionVariant: variant,
+              drawerState: state.drawerState === 'closed' || !state.drawerState ? 'open' : state.drawerState,
+            }));
+          } else {
+            // Regular navigation - update active and history (use full id for alternate-tree nodes).
+            updateState((state) => {
+              const newHistory = state.active ? [...state.history, state.active] : state.history;
+              const trimmedHistory =
+                newHistory.length > MAX_HISTORY_LENGTH ? newHistory.slice(-MAX_HISTORY_LENGTH) : newHistory;
+              return {
+                ...state,
+                active: id,
+                history: trimmedHistory,
+              };
+            });
+          }
         }),
       }),
 
@@ -113,10 +178,25 @@ export default Capability.makeModule(
       // Close
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.Close,
+        operation: LayoutOperation.Close,
         handler: Effect.fnUntraced(function* () {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          layout.active = undefined;
+          updateState((state) => {
+            // Pop from history if available.
+            if (state.history.length > 0) {
+              const newHistory = [...state.history];
+              const previousActive = newHistory.pop();
+              return {
+                ...state,
+                active: previousActive,
+                history: newHistory,
+              };
+            }
+            // No history, just clear active.
+            return {
+              ...state,
+              active: undefined,
+            };
+          });
         }),
       }),
 
@@ -124,10 +204,12 @@ export default Capability.makeModule(
       // Set
       //
       OperationResolver.make({
-        operation: Common.LayoutOperation.Set,
+        operation: LayoutOperation.Set,
         handler: Effect.fnUntraced(function* (input) {
-          const layout = yield* Capability.get(SimpleLayoutState);
-          layout.active = input.subject[0];
+          updateState((state) => ({
+            ...state,
+            active: input.subject[0],
+          }));
         }),
       }),
     ]);

package/src/capabilities/react-root/react-root.tsx

@@ -5,14 +5,14 @@
 import * as Effect from 'effect/Effect';
 import React from 'react';
 
-import { Capability, Common } from '@dxos/app-framework';
+import { Capabilities, Capability } from '@dxos/app-framework';
 
 import { SimpleLayout } from '../../components';
 import { meta } from '../../meta';
 
 export default Capability.makeModule(() =>
   Effect.succeed(
-    Capability.contributes(Common.Capability.ReactRoot, {
+    Capability.contributes(Capabilities.ReactRoot, {
       id: meta.id,
       root: () => {
         return <SimpleLayout />;

package/src/capabilities/react-surface/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/react-surface/react-surface.tsx

@@ -0,0 +1,41 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/ui';
+import { Node } from '@dxos/plugin-graph';
+
+import { Home, Workspace } from '../../components';
+import { meta } from '../../meta';
+
+type SurfaceData = {
+  attendableId: string;
+  properties: Record<string, any>;
+};
+
+const ALLOWED_DISPOSITIONS = ['workspace', 'user-account', 'pin-end', 'alternate-tree'];
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: `${meta.id}/home`,
+        role: 'article',
+        filter: (data): data is SurfaceData => data.attendableId === Node.RootId,
+        component: () => <Home />,
+      }),
+      Surface.create({
+        id: `${meta.id}/workspace-article`,
+        role: 'article',
+        position: 'fallback',
+        filter: (data): data is SurfaceData =>
+          ALLOWED_DISPOSITIONS.includes((data.properties as Record<string, any>)?.disposition),
+        component: ({ data }) => <Workspace id={data.attendableId} />,
+      }),
+    ]),
+  ),
+);

package/src/capabilities/spotlight-dismiss/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+export const SpotlightDismiss = Capability.lazy('SpotlightDismiss', () => import('./spotlight-dismiss'));

package/src/{hooks/useSpotlightDismiss.ts → capabilities/spotlight-dismiss/spotlight-dismiss.ts}

@@ -5,14 +5,14 @@
 // Based on the frontend-driven dismiss pattern from:
 // https://github.com/Jedliu/tauri-template-demo
 
-import { useEffect } from 'react';
+import * as Effect from 'effect/Effect';
 
+import { Capabilities, Capability } from '@dxos/app-framework';
 import { log } from '@dxos/log';
 import { isTauri } from '@dxos/util';
 
 /**
  * Get the Tauri window API from the global object.
- * Returns undefined if not running in Tauri.
  */
 const getTauriWindow = (): any => {
   const tauri = (globalThis as any).__TAURI__;
@@ -21,60 +21,46 @@ const getTauriWindow = (): any => {
 
 /**
  * Get the Tauri core API (invoke) from the global object.
- * Returns undefined if not running in Tauri.
  */
 const getTauriCore = (): any => {
   const tauri = (globalThis as any).__TAURI__;
   return tauri?.core;
 };
 
+export type SpotlightDismissOptions = {
+  /** Whether running in popover window context. */
+  isPopover?: boolean;
+};
+
 /**
- * Hook to set up spotlight panel dismiss behavior.
+ * Capability that sets up spotlight panel dismiss behavior.
  * When running in Tauri popover mode, listens for focus loss and Escape key
- * to dismiss the spotlight panel.
+ * to dismiss the spotlight panel. Runs at startup before React renders.
  */
-export const useSpotlightDismiss = (isPopover: boolean | undefined) => {
-  // Handle blur (click outside) to dismiss spotlight.
-  useEffect(() => {
+export default Capability.makeModule(({ isPopover = false }: SpotlightDismissOptions = {}) =>
+  Effect.promise(async () => {
     if (!isPopover || !isTauri()) {
-      return;
+      return [];
     }
 
-    let cleanup: (() => void) | undefined;
-
-    const setup = async () => {
-      try {
-        const tauriWindow = getTauriWindow();
-        const tauriCore = getTauriCore();
-        if (!tauriWindow || !tauriCore) {
-          return;
-        }
-
+    // Set up focus listener.
+    let focusCleanup: (() => void) | undefined;
+    try {
+      const tauriWindow = getTauriWindow();
+      const tauriCore = getTauriCore();
+      if (tauriWindow && tauriCore) {
         const win = tauriWindow.getCurrentWindow();
-        const unlisten = await win.onFocusChanged(async ({ payload }: { payload: boolean }) => {
+        focusCleanup = await win.onFocusChanged(async ({ payload }: { payload: boolean }) => {
           if (!payload) {
             await tauriCore.invoke('hide_spotlight');
           }
         });
-        cleanup = unlisten;
-      } catch (err) {
-        log.catch(err);
       }
-    };
-
-    void setup();
-
-    return () => {
-      cleanup?.();
-    };
-  }, [isPopover]);
-
-  // Handle Escape key to dismiss spotlight.
-  useEffect(() => {
-    if (!isPopover || !isTauri()) {
-      return;
+    } catch (err) {
+      log.catch(err);
     }
 
+    // Set up Escape key listener.
     const handleKeyDown = async (event: KeyboardEvent) => {
       if (event.key === 'Escape') {
         event.preventDefault();
@@ -88,8 +74,13 @@ export const useSpotlightDismiss = (isPopover: boolean | undefined) => {
         }
       }
     };
-
     window.addEventListener('keydown', handleKeyDown);
-    return () => window.removeEventListener('keydown', handleKeyDown);
-  }, [isPopover]);
-};
+
+    return Capability.contributes(Capabilities.Null, null, () =>
+      Effect.sync(() => {
+        focusCleanup?.();
+        window.removeEventListener('keydown', handleKeyDown);
+      }),
+    );
+  }),
+);