@dxos/plugin-simple-layout 0.0.0 → 0.8.4-main.03d5cd7b56

package/package.json

@@ -1,19 +1,74 @@
 {
   "name": "@dxos/plugin-simple-layout",
-  "version": "0.0.0",
+  "version": "0.8.4-main.03d5cd7b56",
   "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",
+  "imports": {
+    "#capabilities": {
+      "source": "./src/capabilities/index.ts",
+      "types": "./dist/types/src/capabilities/index.d.ts",
+      "default": "./dist/lib/neutral/capabilities/index.mjs"
+    },
+    "#components": {
+      "source": "./src/components/index.ts",
+      "types": "./dist/types/src/components/index.d.ts",
+      "default": "./dist/lib/neutral/components/index.mjs"
+    },
+    "#hooks": {
+      "source": "./src/hooks/index.ts",
+      "types": "./dist/types/src/hooks/index.d.ts",
+      "default": "./dist/lib/neutral/hooks/index.mjs"
+    },
+    "#meta": {
+      "source": "./src/meta.ts",
+      "types": "./dist/types/src/meta.d.ts",
+      "default": "./dist/lib/neutral/meta.mjs"
+    },
+    "#operations": {
+      "source": "./src/operations/index.ts",
+      "types": "./dist/types/src/operations/index.d.ts",
+      "default": "./dist/lib/neutral/operations/index.mjs"
+    },
+    "#plugin": {
+      "source": "./src/SimpleLayoutPlugin.ts",
+      "types": "./dist/types/src/SimpleLayoutPlugin.d.ts",
+      "default": "./dist/lib/neutral/SimpleLayoutPlugin.mjs"
+    },
+    "#translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
+    },
+    "#types": {
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "default": "./dist/lib/neutral/types/index.mjs"
+    }
+  },
   "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"
+      "default": "./dist/lib/neutral/index.mjs"
+    },
+    "./plugin": {
+      "source": "./src/plugin.ts",
+      "types": "./dist/types/src/plugin.d.ts",
+      "default": "./dist/lib/neutral/plugin.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -22,43 +77,53 @@
     "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.03d5cd7b56",
+    "@dxos/app-toolkit": "0.8.4-main.03d5cd7b56",
+    "@dxos/async": "0.8.4-main.03d5cd7b56",
+    "@dxos/context": "0.8.4-main.03d5cd7b56",
+    "@dxos/compute": "0.8.4-main.03d5cd7b56",
+    "@dxos/echo": "0.8.4-main.03d5cd7b56",
+    "@dxos/effect": "0.8.4-main.03d5cd7b56",
+    "@dxos/log": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-client": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui-attention": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui-list": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui-menu": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-graph": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui-mosaic": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui-search": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui-stack": "0.8.4-main.03d5cd7b56",
+    "@dxos/util": "0.8.4-main.03d5cd7b56",
+    "@dxos/schema": "0.8.4-main.03d5cd7b56"
   },
   "devDependencies": {
     "@types/react": "~19.2.7",
     "@types/react-dom": "~19.2.3",
-    "effect": "3.19.11",
+    "effect": "3.20.0",
     "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"
+    "vite": "^8.0.10",
+    "@dxos/app-graph": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-preview": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-space": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-testing": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-search": "0.8.4-main.03d5cd7b56",
+    "@dxos/schema": "0.8.4-main.03d5cd7b56",
+    "@dxos/storybook-utils": "0.8.4-main.03d5cd7b56",
+    "@dxos/ui-theme": "0.8.4-main.03d5cd7b56"
   },
   "peerDependencies": {
-    "effect": "3.19.11",
+    "effect": "3.20.0",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/ui-theme": "0.0.0"
+    "@dxos/ui-theme": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui": "0.8.4-main.03d5cd7b56"
   },
   "publishConfig": {
     "access": "public"

package/src/SimpleLayoutPlugin.ts

@@ -2,30 +2,58 @@
 // 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 { meta } from './meta';
-import { translations } from './translations';
+import {
+  AppGraphBuilder,
+  OperationHandler,
+  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). */
+  /** Determines if running in popover window context (hides mobile-specific UI). */
   isPopover?: boolean;
 };
 
 export const SimpleLayoutPlugin = Plugin.define<SimpleLayoutPluginOptions>(meta).pipe(
+  AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  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,
+    firesAfterActivation: [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,
 );
+
+export default SimpleLayoutPlugin;

package/src/capabilities/app-graph-builder.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities, AppNode } from '@dxos/app-toolkit';
+import { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* GraphBuilder.createExtension({
+      id: 'org.dxos.plugin.simpleLayout.not-found',
+      match: NodeMatcher.whenRoot,
+      connector: () => Effect.succeed([AppNode.makeNotFound()]),
+    });
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);

package/src/capabilities/index.ts

@@ -2,6 +2,16 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './operation-resolver';
-export * from './react-root';
-export * from './state';
+import { Capability } from '@dxos/app-framework';
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
+export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
+  'OperationHandler',
+  () => import('./operation-handler'),
+);
+export const ReactRoot = Capability.lazy('ReactRoot', () => import('./react-root'));
+export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));
+export const SpotlightDismiss = Capability.lazy('SpotlightDismiss', () => import('./spotlight-dismiss'));
+export const State = Capability.lazy('State', () => import('./state'));
+export const UrlHandler = Capability.lazy('UrlHandler', () => import('./url-handler'));

package/src/capabilities/operation-handler.ts

@@ -0,0 +1,14 @@
+// Copyright 2025 DXOS.org
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import type { OperationHandlerSet } from '@dxos/compute';
+
+import { SimpleLayoutOperationHandlerSet } from '#operations';
+
+export default Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Capabilities.OperationHandler, SimpleLayoutOperationHandlerSet);
+  }),
+);

package/src/capabilities/{react-root/react-root.tsx → 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';
+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.tsx

@@ -0,0 +1,50 @@
+//
+// 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 { NOT_FOUND_PATH } from '@dxos/app-toolkit';
+import { NotFoundArticle } from '@dxos/app-toolkit/ui';
+import { Node } from '@dxos/plugin-graph';
+
+import { Home, NavBranch } from '#components';
+
+type SurfaceData = {
+  attendableId: string;
+  properties: Record<string, any>;
+};
+
+const ALLOWED_DISPOSITIONS = ['workspace', 'user-account', 'pin-end'];
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: 'home',
+        role: 'article',
+        filter: (data): data is SurfaceData => data.attendableId === Node.RootId,
+        component: () => <Home />,
+      }),
+      Surface.create({
+        id: 'not-found',
+        role: 'article',
+        filter: (data): data is SurfaceData => data.attendableId === NOT_FOUND_PATH,
+        component: () => <NotFoundArticle />,
+      }),
+      Surface.create({
+        id: 'nav-branch',
+        role: 'article',
+        position: 'fallback',
+        filter: (data): data is SurfaceData => {
+          const props = data.properties as Record<string, any>;
+          return ALLOWED_DISPOSITIONS.includes(props?.disposition) || props?.role === 'branch';
+        },
+        component: ({ data }) => <NavBranch id={data.attendableId} />,
+      }),
+    ]),
+  ),
+);

package/src/{hooks/useSpotlightDismiss.ts → capabilities/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);
+      }),
+    );
+  }),
+);

package/src/capabilities/state.tsx

@@ -0,0 +1,51 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { Node } from '@dxos/plugin-graph';
+
+import { SimpleLayoutCapabilities } from '#types';
+
+const defaultState: SimpleLayoutCapabilities.SimpleLayoutState = {
+  dialogOpen: false,
+  workspace: Node.RootId,
+  previousWorkspace: Node.RootId,
+  history: [],
+  isPopover: false,
+  companionVariant: undefined,
+  drawerState: 'closed',
+};
+
+export type SimpleLayoutStateOptions = {
+  initialState?: Partial<SimpleLayoutCapabilities.SimpleLayoutState>;
+};
+
+export default Capability.makeModule(({ initialState }: SimpleLayoutStateOptions = {}) =>
+  Effect.sync(() => {
+    const stateAtom = Atom.make<SimpleLayoutCapabilities.SimpleLayoutState>({ ...defaultState, ...initialState });
+
+    const layoutAtom = Atom.make((get): AppCapabilities.Layout => {
+      const state = get(stateAtom);
+      return {
+        mode: 'simple',
+        dialogOpen: state.dialogOpen,
+        sidebarOpen: false,
+        complementarySidebarOpen: false,
+        workspace: state.workspace,
+        active: state.active ? [state.active] : [],
+        inactive: [],
+        scrollIntoView: undefined,
+      };
+    });
+
+    return [
+      Capability.contributes(SimpleLayoutCapabilities.State, stateAtom),
+      Capability.contributes(AppCapabilities.Layout, layoutAtom),
+    ];
+  }),
+);