@dxos/plugin-deck 0.8.4-main.e8ec1fe → 0.8.4-main.effb148878

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

@@ -2,142 +2,126 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Atom } from '@effect-atom/atom-react';
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
+import * as Effect from 'effect/Effect';
 
-import { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { AppCapabilities, AppNode, LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
 import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { ROOT_ID, atomFromSignal, createExtension } from '@dxos/plugin-graph';
+import { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
+import { DeckCapabilities } from '#types';
 
-import { DeckCapabilities } from './capabilities';
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* Effect.all([
+      GraphBuilder.createExtension({
+        id: 'not-found',
+        match: NodeMatcher.whenRoot,
+        connector: () => Effect.succeed([AppNode.makeNotFound()]),
+      }),
 
-export default (context: PluginContext) =>
-  contributes(
-    Capabilities.AppGraphBuilder,
-    createExtension({
-      id: meta.id,
-      actions: (node) =>
-        Atom.make((get) =>
-          Function.pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => {
-              const state = context.getCapability(DeckCapabilities.MutableDeckState);
+      GraphBuilder.createExtension({
+        id: 'root',
+        match: NodeMatcher.whenRoot,
+        actions: (_node, get) =>
+          Effect.gen(function* () {
+            // NOTE(Zan): This is currently disabled.
+            // TODO(Zan): Fullscreen needs to know the active node and provide that to the layout part.
+            // const _fullscreen = {
+            //   id: `${LayoutAction.UpdateLayout._tag}/fullscreen`,
+            //   data: async () => {
+            //     const { dispatchPromise: dispatch } = context.get(Capabilities.IntentDispatcher);
+            //     await dispatch(
+            //       createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { mode: 'fullscreen' } }),
+            //     );
+            //   },
+            //   properties: {
+            //     label: ['toggle-fullscreen.label', { ns: meta.id }],
+            //     icon: 'ph--arrows-out--regular',
+            //     keyBinding: {
+            //       macos: 'ctrl+meta+f',
+            //       windows: 'shift+ctrl+f',
+            //     },
+            //   },
+            // };
 
-              // NOTE(Zan): This is currently disabled.
-              // TODO(Zan): Fullscreen needs to know the active node and provide that to the layout part.
-              // const _fullscreen = {
-              //   id: `${LayoutAction.UpdateLayout._tag}/fullscreen`,
-              //   data: async () => {
-              //     const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-              //     await dispatch(
-              //       createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { mode: 'fullscreen' } }),
-              //     );
-              //   },
-              //   properties: {
-              //     label: ['toggle fullscreen label', { ns: meta.id }],
-              //     icon: 'ph--arrows-out--regular',
-              //     keyBinding: {
-              //       macos: 'ctrl+meta+f',
-              //       windows: 'shift+ctrl+f',
-              //     },
-              //   },
-              // };
+            const closeCurrent = {
+              id: `${LayoutOperation.Close.meta.key}.current`,
+              data: Effect.fnUntraced(function* () {
+                const attention = yield* Capability.get(AttentionCapabilities.Attention);
+                const attended = attention.getCurrent().at(-1);
+                if (attended) {
+                  yield* Operation.invoke(LayoutOperation.Close, { subject: [attended] });
+                }
+              }),
+              properties: {
+                label: ['close-current.label', { ns: meta.id }],
+                icon: 'ph--x--regular',
+              },
+            };
 
-              const closeCurrent = {
-                id: `${LayoutAction.Close._tag}/current`,
-                data: async () => {
-                  const attention = context.getCapability(AttentionCapabilities.Attention);
-                  const attended = attention.current.at(-1);
-                  if (attended) {
-                    const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                    await dispatch(
-                      createIntent(LayoutAction.Close, {
-                        part: 'main',
-                        subject: [attended],
-                        options: { state: false },
-                      }),
-                    );
-                  }
-                },
-                properties: {
-                  label: ['close current label', { ns: meta.id }],
-                  icon: 'ph--x--regular',
-                },
-              };
+            const closeOthers = {
+              id: `${LayoutOperation.Close.meta.key}.others`,
+              data: Effect.fnUntraced(function* () {
+                const attention = yield* Capability.get(AttentionCapabilities.Attention);
+                const deck = yield* DeckCapabilities.getDeck();
+                const attended = attention.getCurrent().at(-1);
+                const ids = deck.active.filter((id: string) => id !== attended) ?? [];
+                yield* Operation.invoke(LayoutOperation.Close, { subject: ids });
+              }),
+              properties: {
+                label: ['close-others.label', { ns: meta.id }],
+                icon: 'ph--x-square--regular',
+              },
+            };
 
-              const closeOthers = {
-                id: `${LayoutAction.Close._tag}/others`,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  const attention = context.getCapability(AttentionCapabilities.Attention);
-                  const attended = attention.current.at(-1);
-                  const ids = state.deck.active.filter((id) => id !== attended) ?? [];
-                  await dispatch(
-                    createIntent(LayoutAction.Close, { part: 'main', subject: ids, options: { state: false } }),
-                  );
-                },
-                properties: {
-                  label: ['close others label', { ns: meta.id }],
-                  icon: 'ph--x-square--regular',
-                },
-              };
+            const closeAll = {
+              id: `${LayoutOperation.Close.meta.key}.all`,
+              data: Effect.fnUntraced(function* () {
+                const deck = yield* DeckCapabilities.getDeck();
+                yield* Operation.invoke(LayoutOperation.Close, { subject: deck.active });
+              }),
+              properties: {
+                label: ['close-all.label', { ns: meta.id }],
+                icon: 'ph--x-circle--regular',
+              },
+            };
 
-              const closeAll = {
-                id: `${LayoutAction.Close._tag}/all`,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  await dispatch(
-                    createIntent(LayoutAction.Close, {
-                      part: 'main',
-                      subject: state.deck.active,
-                      options: { state: false },
-                    }),
-                  );
-                },
-                properties: {
-                  label: ['close all label', { ns: meta.id }],
-                  icon: 'ph--x-circle--regular',
-                },
-              };
+            const state = get(yield* Capability.get(DeckCapabilities.State));
+            const deck = state.decks[state.activeDeck];
 
-              const toggleSidebar = {
-                id: `${LayoutAction.UpdateSidebar._tag}/nav`,
-                data: async () => {
-                  state.sidebarState = state.sidebarState === 'expanded' ? 'collapsed' : 'expanded';
+            const toggleSidebar = {
+              id: `${LayoutOperation.UpdateSidebar.meta.key}.nav`,
+              data: Effect.fnUntraced(function* () {
+                yield* Capabilities.updateAtomValue(DeckCapabilities.State, (s) => ({
+                  ...s,
+                  sidebarState: s.sidebarState === 'expanded' ? ('collapsed' as const) : ('expanded' as const),
+                }));
+              }),
+              properties: {
+                label: [
+                  state.sidebarState === 'expanded'
+                    ? 'collapse-navigation-sidebar.label'
+                    : 'open-navigation-sidebar.label',
+                  { ns: meta.id },
+                ],
+                icon: 'ph--sidebar--regular',
+                keyBinding: {
+                  macos: "meta+'",
                 },
-                properties: {
-                  label: [
-                    get(
-                      atomFromSignal(() =>
-                        state.sidebarState === 'expanded'
-                          ? 'collapse navigation sidebar label'
-                          : 'open navigation sidebar label',
-                      ),
-                    ),
-                    { ns: meta.id },
-                  ],
-                  icon: 'ph--sidebar--regular',
-                  keyBinding: {
-                    macos: "meta+'",
-                  },
-                  disposition: 'pin-end',
-                  position: 'hoist',
-                  l0Breakpoint: 'lg',
-                },
-              };
+                disposition: 'pin-end',
+                position: 'last',
+                l0Breakpoint: 'lg',
+              },
+            };
+
+            return !deck?.solo ? [closeCurrent, closeOthers, closeAll, toggleSidebar] : [toggleSidebar];
+          }),
+      }),
+    ]);
 
-              return get(
-                atomFromSignal(() =>
-                  !state.deck.solo ? [closeCurrent, closeOthers, closeAll, toggleSidebar] : [toggleSidebar],
-                ),
-              );
-            }),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  );
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions.flat());
+  }),
+);

package/src/capabilities/check-app-scheme.ts

@@ -2,39 +2,138 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
+import * as Effect from 'effect/Effect';
 
-import { meta } from '../meta';
-import { type DeckSettingsProps } from '../types';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { APP_SCHEME, AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
+import { runAndForwardErrors } from '@dxos/effect';
+import { isTauri } from '@dxos/util';
 
-const isSocket = !!(globalThis as any).__args;
+import { DeckCapabilities } from '#types';
 
-// TODO(mjamesderocher): Can we get this directly from Socket?
-const appScheme = 'composer://';
+/** Identifier for the native redirect dialog surface (defined in welcome plugin). */
+const NATIVE_REDIRECT_DIALOG = 'org.dxos.plugin.welcome.component.native-redirect-dialog';
 
-// TODO(mjamesderocher): Factor out as part of NavigationPlugin.
-const checkAppScheme = (url: string) => {
-  const iframe = document.createElement('iframe');
-  iframe.style.display = 'none';
-  document.body.appendChild(iframe);
+const SCHEME_TIMEOUT_MS = 500;
 
-  iframe.src = url + window.location.pathname.replace(/^\/+/, '') + window.location.search;
+const isSafari = (): boolean => {
+  const ua = navigator.userAgent;
+  return ua.includes('Safari') && !ua.includes('Chrome') && !ua.includes('Chromium');
+};
+
+/** Check if the current page URL can be converted to a valid custom scheme URL. */
+const canRedirectToScheme = (): boolean => {
+  try {
+    const schemeUrl = APP_SCHEME + window.location.pathname.replace(/^\/+/, '') + window.location.search;
+    new URL(schemeUrl);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+/**
+ * Try to open the native app via custom scheme.
+ * Resolves `true` if the app opened (page lost focus), `false` if it didn't within the timeout.
+ */
+const tryOpenNativeApp = (): Promise<boolean> => {
+  return new Promise((resolve) => {
+    let resolved = false;
+
+    const onBlur = () => {
+      if (!resolved) {
+        resolved = true;
+        cleanup();
+        resolve(true);
+      }
+    };
+
+    const cleanup = () => {
+      window.removeEventListener('blur', onBlur);
+      document.removeEventListener('visibilitychange', onVisibilityChange);
+    };
 
-  const timer = setTimeout(() => {
-    document.body.removeChild(iframe);
-  }, 3000);
+    const onVisibilityChange = () => {
+      if (document.hidden) {
+        onBlur();
+      }
+    };
 
-  window.addEventListener('pagehide', (event) => {
-    clearTimeout(timer);
-    document.body.removeChild(iframe);
+    window.addEventListener('blur', onBlur);
+    document.addEventListener('visibilitychange', onVisibilityChange);
+
+    // Try the scheme via hidden iframe.
+    const schemeUrl = APP_SCHEME + window.location.pathname.replace(/^\/+/, '') + window.location.search;
+    const iframe = document.createElement('iframe');
+    iframe.style.display = 'none';
+    iframe.src = schemeUrl;
+    document.body.appendChild(iframe);
+    setTimeout(() => iframe.remove(), 3000);
+
+    // If no blur within timeout, the app isn't running.
+    setTimeout(() => {
+      if (!resolved) {
+        resolved = true;
+        cleanup();
+        resolve(false);
+      }
+    }, SCHEME_TIMEOUT_MS);
   });
 };
 
-export default async (context: PluginContext) => {
-  const settings = context.getCapability(Capabilities.SettingsStore).getStore<DeckSettingsProps>(meta.id)?.value;
-  if (!isSocket && settings?.enableNativeRedirect) {
-    checkAppScheme(appScheme);
-  }
+/** Dispatch all NavigationHandler contributions with the current page URL. */
+const dispatchNavigationHandlers = Effect.fn(function* () {
+  const url = new URL(window.location.href);
+  const handlers = yield* Capability.getAll(AppCapabilities.NavigationHandler);
+  yield* Effect.all(
+    handlers.map((handler) => handler(url)),
+    { concurrency: 'unbounded' },
+  );
+});
 
-  return contributes(Capabilities.Null, null);
+/**
+ * Checks whether the native redirect setting is enabled and the redirect should be attempted.
+ * Exported for the URL handler to decide whether to defer NavigationHandler dispatch.
+ */
+export const shouldDeferNavigationHandlers = (): boolean => {
+  return !isTauri() && !isSafari() && !import.meta.env.DEV && canRedirectToScheme();
 };
+
+/**
+ * When running in a web browser (not Tauri) with native redirect enabled,
+ * tries to open the native app via custom scheme. Defers NavigationHandlers
+ * to prevent the web app from consuming one-time tokens before the native app.
+ *
+ * If the app opens: shows dialog with "Open here" callback that dispatches handlers.
+ * If the app doesn't open: dispatches handlers immediately.
+ * In Safari: universal links handle this natively, so the check is skipped.
+ */
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const capabilities = yield* Capability.Service;
+    const { invoke } = yield* Capability.get(Capabilities.OperationInvoker);
+    const settings = yield* Capabilities.getAtomValue(DeckCapabilities.Settings);
+
+    if (!settings?.enableNativeRedirect || !shouldDeferNavigationHandlers()) {
+      return;
+    }
+
+    const appOpened = yield* Effect.promise(() => tryOpenNativeApp());
+    if (appOpened) {
+      const onOpenHere = () =>
+        Effect.gen(function* () {
+          yield* dispatchNavigationHandlers();
+          yield* invoke(LayoutOperation.UpdateDialog, { state: false });
+        }).pipe(Effect.provideService(Capability.Service, capabilities), runAndForwardErrors);
+
+      yield* invoke(LayoutOperation.UpdateDialog, {
+        subject: NATIVE_REDIRECT_DIALOG,
+        type: 'alert',
+        overlayClasses: 'dark bg-neutral-950!',
+        props: { onOpenHere },
+      });
+    } else {
+      yield* dispatchNavigationHandlers();
+    }
+  }),
+);

package/src/capabilities/index.ts

@@ -2,18 +2,17 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
+import { OperationHandlerSet } from '@dxos/compute';
 
-export const AppGraphBuilder = lazy(() => import('./app-graph-builder'));
-export const CheckAppScheme = lazy(() => import('./check-app-scheme'));
-export const DeckSettings = lazy(() => import('./settings'));
-export const DeckState = lazy(() => import('./state'));
-export const LayoutIntentResolver = lazy(() => import('./intent-resolver'));
-export const ReactRoot = lazy(() => import('./react-root'));
-export const ReactSurface = lazy(() => import('./react-surface'));
-// export const Tools = lazy(() => import('./tools'));
-export const Toolkit = lazy(() => import('./toolkit'));
-export const UrlHandler = lazy(() => import('./url-handler'));
-
-export * from './capabilities';
-export * from './state';
+export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
+export const CheckAppScheme = Capability.lazy('CheckAppScheme', () => import('./check-app-scheme'));
+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 DeckSettings = Capability.lazy('DeckSettings', () => import('./settings'));
+export const DeckState = Capability.lazy('DeckState', () => import('./state'));
+export const UrlHandler = Capability.lazy('UrlHandler', () => import('./url-handler'));

package/src/capabilities/operation-handler.ts

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

package/src/capabilities/react-root.tsx

@@ -2,39 +2,46 @@
 // Copyright 2025 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
 import React, { useCallback } from 'react';
 
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { useCapability } from '@dxos/app-framework/react';
+import { Capabilities, Capability } from '@dxos/app-framework';
 
-import { DeckLayout } from '../components';
-import { meta } from '../meta';
+import { DeckLayout } from '#containers';
+import { useDeckState } from '#hooks';
+import { meta } from '#meta';
 
-import { DeckCapabilities } from './capabilities';
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactRoot, {
+      id: meta.id,
+      root: () => {
+        const { state, updateEphemeral } = useDeckState();
 
-export default () =>
-  contributes(Capabilities.ReactRoot, {
-    id: meta.id,
-    root: () => {
-      const layout = useCapability(DeckCapabilities.MutableDeckState);
+        const handleDismissToast = useCallback(
+          (id: string) => {
+            const index = state.toasts.findIndex((toast) => toast.id === id);
+            if (index !== -1) {
+              // Allow time for the toast to animate out.
+              // TODO(burdon): Factor out and unregister timeout.
+              setTimeout(() => {
+                updateEphemeral((s) => {
+                  const toastToRemove = s.toasts[index];
+                  const newCurrentUndoId = toastToRemove?.id === s.currentUndoId ? undefined : s.currentUndoId;
+                  return {
+                    ...s,
+                    currentUndoId: newCurrentUndoId,
+                    toasts: s.toasts.filter((_, i) => i !== index),
+                  };
+                });
+              }, 1_000);
+            }
+          },
+          [state.toasts, updateEphemeral],
+        );
 
-      const handleDismissToast = useCallback(
-        (id: string) => {
-          const index = layout.toasts.findIndex((toast) => toast.id === id);
-          if (index !== -1) {
-            // Allow time for the toast to animate out.
-            // TODO(burdon): Factor out and unregister timeout.
-            setTimeout(() => {
-              if (layout.toasts[index].id === layout.currentUndoId) {
-                layout.currentUndoId = undefined;
-              }
-              layout.toasts.splice(index, 1);
-            }, 1_000);
-          }
-        },
-        [layout.toasts],
-      );
-
-      return <DeckLayout onDismissToast={handleDismissToast} />;
-    },
-  });
+        return <DeckLayout onDismissToast={handleDismissToast} />;
+      },
+    }),
+  ),
+);

package/src/capabilities/react-surface.tsx

@@ -2,29 +2,35 @@
 // Copyright 2025 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
 import React from 'react';
 
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { SettingsStore } from '@dxos/local-storage';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface, useSettingsState } from '@dxos/app-framework/ui';
+import { NOT_FOUND_PATH } from '@dxos/app-toolkit';
+import { AppSurface, NotFoundArticle } from '@dxos/app-toolkit/ui';
 
-import { Banner, DeckSettings } from '../components';
-import { meta } from '../meta';
-import { type DeckSettingsProps } from '../types';
+import { DeckSettings } from '#components';
+import { meta } from '#meta';
+import { type Settings } from '#types';
 
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${meta.id}/plugin-settings`,
-      role: 'article',
-      filter: (data): data is { subject: SettingsStore<DeckSettingsProps> } =>
-        data.subject instanceof SettingsStore && data.subject.prefix === meta.id,
-      component: ({ data: { subject } }) => <DeckSettings settings={subject.value} />,
-    }),
-    createSurface({
-      id: `${meta.id}/banner`,
-      role: 'banner',
-      component: ({ data }) => {
-        return <Banner variant={data.variant} />;
-      },
-    }),
-  ]);
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: 'plugin-settings',
+        filter: AppSurface.settings(AppSurface.Article, meta.id),
+        component: ({ data: { subject } }) => {
+          const { settings, updateSettings } = useSettingsState<Settings.Settings>(subject.atom);
+          return <DeckSettings settings={settings} onSettingsChange={updateSettings} />;
+        },
+      }),
+      Surface.create({
+        id: 'not-found',
+        role: 'article',
+        filter: (data): data is { attendableId: string } => data.attendableId === NOT_FOUND_PATH,
+        component: () => <NotFoundArticle />,
+      }),
+    ]),
+  ),
+);