@dxos/plugin-help 0.8.3-staging.0fa589b → 0.8.4-main.03d5cd7b56

package/package.json

@@ -1,78 +1,129 @@
 {
   "name": "@dxos/plugin-help",
-  "version": "0.8.3-staging.0fa589b",
+  "version": "0.8.4-main.03d5cd7b56",
   "description": "Help plugin.",
   "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"
+    },
+    "#containers": {
+      "source": "./src/containers/index.ts",
+      "types": "./dist/types/src/containers/index.d.ts",
+      "default": "./dist/lib/neutral/containers/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/HelpPlugin.tsx",
+      "types": "./dist/types/src/HelpPlugin.d.ts",
+      "default": "./dist/lib/neutral/HelpPlugin.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"
+      "default": "./dist/lib/neutral/index.mjs"
     },
-    "./types": {
-      "types": "./dist/types/src/types.d.ts",
-      "browser": "./dist/lib/browser/types.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",
-  "typesVersions": {
-    "*": {
-      "types": [
-        "dist/types/src/types.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@fluentui/react-tabster": "^9.24.2",
-    "@preact-signals/safe-react": "^0.9.0",
+    "@effect-atom/atom": "^0.5.1",
+    "@fluentui/react-tabster": "9.26.11",
     "react-joyride": "^2.7.2",
-    "@dxos/app-graph": "0.8.3-staging.0fa589b",
-    "@dxos/app-framework": "0.8.3-staging.0fa589b",
-    "@dxos/debug": "0.8.3-staging.0fa589b",
-    "@dxos/echo-schema": "0.8.3-staging.0fa589b",
-    "@dxos/echo": "0.8.3-staging.0fa589b",
-    "@dxos/keyboard": "0.8.3-staging.0fa589b",
-    "@dxos/live-object": "0.8.3-staging.0fa589b",
-    "@dxos/local-storage": "0.8.3-staging.0fa589b",
-    "@dxos/plugin-client": "0.8.3-staging.0fa589b",
-    "@dxos/plugin-space": "0.8.3-staging.0fa589b",
-    "@dxos/plugin-graph": "0.8.3-staging.0fa589b",
-    "@dxos/react-client": "0.8.3-staging.0fa589b"
+    "@dxos/app-graph": "0.8.4-main.03d5cd7b56",
+    "@dxos/app-framework": "0.8.4-main.03d5cd7b56",
+    "@dxos/debug": "0.8.4-main.03d5cd7b56",
+    "@dxos/app-toolkit": "0.8.4-main.03d5cd7b56",
+    "@dxos/echo": "0.8.4-main.03d5cd7b56",
+    "@dxos/effect": "0.8.4-main.03d5cd7b56",
+    "@dxos/keyboard": "0.8.4-main.03d5cd7b56",
+    "@dxos/compute": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-client": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-graph": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-space": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-client": "0.8.4-main.03d5cd7b56",
+    "@dxos/util": "0.8.4-main.03d5cd7b56"
   },
   "devDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@effect/platform": "0.80.12",
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "effect": "3.14.21",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
     "react-floater": "0.7.9",
     "type-fest": "4.10.1",
-    "vite": "5.4.7",
-    "@dxos/random": "0.8.3-staging.0fa589b",
-    "@dxos/react-ui": "0.8.3-staging.0fa589b",
-    "@dxos/react-ui-theme": "0.8.3-staging.0fa589b",
-    "@dxos/storybook-utils": "0.8.3-staging.0fa589b"
+    "vite": "^8.0.10",
+    "@dxos/random": "0.8.4-main.03d5cd7b56",
+    "@dxos/plugin-testing": "0.8.4-main.03d5cd7b56",
+    "@dxos/react-ui": "0.8.4-main.03d5cd7b56",
+    "@dxos/storybook-utils": "0.8.4-main.03d5cd7b56",
+    "@dxos/ui-theme": "0.8.4-main.03d5cd7b56"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@effect/platform": "0.80.12",
-    "@phosphor-icons/react": "^2.1.5",
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.3-staging.0fa589b",
-    "@dxos/react-ui-theme": "0.8.3-staging.0fa589b"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.03d5cd7b56",
+    "@dxos/ui-theme": "0.8.4-main.03d5cd7b56"
   },
   "publishConfig": {
     "access": "public"

package/src/HelpPlugin.test.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { ActivationEvents } from '@dxos/app-framework';
+import { createComposerTestApp } from '@dxos/plugin-testing/harness';
+
+import { HelpPlugin } from '#plugin';
+
+import { meta } from './meta';
+
+const moduleId = (name: string) => `${meta.id}.module.${name}`;
+
+describe('HelpPlugin', () => {
+  test('modules activate on the expected events', async ({ expect }) => {
+    await using harness = await createComposerTestApp({
+      plugins: [HelpPlugin({})],
+    });
+
+    expect(harness.manager.getActive()).toEqual(
+      expect.arrayContaining([moduleId('AppGraphBuilder'), moduleId('ReactSurface')]),
+    );
+
+    // Operation handlers are not loaded on startup — SetupOperationHandler fires lazily when an operation is invoked.
+    await harness.fire(ActivationEvents.SetupOperationHandler);
+    expect(harness.manager.getActive()).toContain(moduleId('OperationHandler'));
+  });
+});

package/src/HelpPlugin.tsx

@@ -2,56 +2,31 @@
 // Copyright 2023 DXOS.org
 //
 
-import { createResolver, defineModule, definePlugin, Events, contributes, Capabilities } from '@dxos/app-framework';
+import { ActivationEvents, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
 
-import { AppGraphBuilder, HelpState, ReactRoot, ReactSurface } from './capabilities';
-import { HelpCapabilities } from './capabilities/capabilities';
-import { meta } from './meta';
-import translations from './translations';
-import { type Step, HelpAction } from './types';
+import { AppGraphBuilder, HelpState, OperationHandler, ReactRoot, ReactSurface } from '#capabilities';
+import { meta } from '#meta';
+import { translations } from '#translations';
+import { type Step } from '#types';
 
 export type HelpPluginOptions = { steps?: Step[] };
 
-export const HelpPlugin = ({ steps = [] }: HelpPluginOptions) =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/state`,
-      activatesOn: Events.Startup,
-      activate: HelpState,
-    }),
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-root`,
-      activatesOn: Events.Startup,
-      activate: () => ReactRoot(steps),
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      activate: ReactSurface,
-    }),
-    defineModule({
-      id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: (context) =>
-        contributes(
-          Capabilities.IntentResolver,
-          createResolver({
-            intent: HelpAction.Start,
-            resolve: () => {
-              const state = context.getCapability(HelpCapabilities.MutableState);
-              state.running = true;
-            },
-          }),
-        ),
-    }),
-    defineModule({
-      id: `${meta.id}/module/app-graph-builder`,
-      activatesOn: Events.SetupAppGraph,
-      activate: AppGraphBuilder,
-    }),
-  ]);
+export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
+  AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule({
+    activatesOn: ActivationEvents.Startup,
+    activate: HelpState,
+  }),
+  Plugin.addModule(({ steps = [] }) => ({
+    id: 'react-root',
+    activatesOn: ActivationEvents.Startup,
+    activate: () => ReactRoot(steps),
+  })),
+  Plugin.make,
+);
+
+export default HelpPlugin;

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

@@ -2,75 +2,61 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Rx } from '@effect-rx/rx-react';
-import { Option, pipe } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';
-import { createExtension } from '@dxos/app-graph';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { GraphBuilder, Node, NodeMatcher } from '@dxos/app-graph';
+import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
 
-import { HelpCapabilities } from './capabilities';
-import { SHORTCUTS_DIALOG } from '../components';
-import { HELP_PLUGIN } from '../meta';
-import { HelpAction } from '../types';
+import { meta } from '#meta';
+import { HelpCapabilities, HelpOperation } from '#types';
 
-export default (context: PluginContext) =>
-  contributes(
-    Capabilities.AppGraphBuilder,
-    createExtension({
-      id: HELP_PLUGIN,
-      actions: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : Option.none())),
-            Option.map(() => [
-              {
-                id: HelpAction.Start._tag,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  const state = context.getCapability(HelpCapabilities.MutableState);
-                  state.showHints = true;
-                  await dispatch(createIntent(HelpAction.Start));
-                },
-                properties: {
-                  label: ['open help tour', { ns: HELP_PLUGIN }],
-                  icon: 'ph--info--regular',
-                  keyBinding: {
-                    macos: 'shift+meta+/',
-                    // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
-                    windows: 'shift+ctrl+/',
-                    linux: 'shift+ctrl+?',
-                  },
-                  testId: 'helpPlugin.openHelp',
-                },
+import { SHORTCUTS_DIALOG } from '../constants';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* GraphBuilder.createExtension({
+      id: 'root',
+      match: NodeMatcher.whenRoot,
+      actions: () =>
+        Effect.succeed([
+          Node.makeAction({
+            id: HelpOperation.Start.meta.key,
+            data: Effect.fnUntraced(function* () {
+              yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
+              yield* Operation.invoke(HelpOperation.Start);
+            }),
+            properties: {
+              label: ['open-help-tour.message', { ns: meta.id }],
+              icon: 'ph--info--regular',
+              keyBinding: {
+                macos: 'shift+meta+/',
+                windows: 'shift+ctrl+/',
+                linux: 'shift+ctrl+?',
               },
-              {
-                id: 'dxos.org/plugin/help/open-shortcuts',
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  const state = context.getCapability(HelpCapabilities.MutableState);
-                  state.showHints = true;
-                  await dispatch(
-                    createIntent(LayoutAction.UpdateDialog, {
-                      part: 'dialog',
-                      subject: SHORTCUTS_DIALOG,
-                      options: {
-                        blockAlign: 'center',
-                      },
-                    }),
-                  );
-                },
-                properties: {
-                  label: ['open shortcuts label', { ns: HELP_PLUGIN }],
-                  icon: 'ph--keyboard--regular',
-                  keyBinding: {
-                    macos: 'meta+ctrl+/',
-                  },
-                },
+              testId: 'helpPlugin.openHelp',
+            },
+          }),
+          Node.makeAction({
+            id: 'open-shortcuts',
+            data: Effect.fnUntraced(function* () {
+              yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
+              yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+                subject: SHORTCUTS_DIALOG,
+              });
+            }),
+            properties: {
+              label: ['open-shortcuts.label', { ns: meta.id }],
+              icon: 'ph--keyboard--regular',
+              keyBinding: {
+                macos: 'meta+ctrl+/',
               },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  );
+            },
+          }),
+        ]),
+    });
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);

package/src/capabilities/index.ts

@@ -2,11 +2,14 @@
 // 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 ReactRoot = lazy(() => import('./react-root'));
-export const ReactSurface = lazy(() => import('./react-surface'));
-export const HelpState = lazy(() => import('./state'));
-
-export * from './capabilities';
+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 HelpState = Capability.lazy('HelpState', () => import('./state'));

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 { HelpOperationHandlerSet } from '#operations';
+
+export default Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Capabilities.OperationHandler, HelpOperationHandlerSet);
+  }),
+);

package/src/capabilities/react-root.tsx

@@ -2,31 +2,35 @@
 // Copyright 2025 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
 import React from 'react';
 
-import { Capabilities, contributes, useCapability } from '@dxos/app-framework';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { useAtomCapabilityState } from '@dxos/app-framework/ui';
 
-import { HelpCapabilities } from './capabilities';
-import { WelcomeTour } from '../components';
-import { HELP_PLUGIN } from '../meta';
-import { type Step } from '../types';
+import { WelcomeTour } from '#components';
+import { meta } from '#meta';
+import { HelpCapabilities, type Step } from '#types';
 
-export default (steps: Step[]) =>
-  contributes(Capabilities.ReactRoot, {
-    id: HELP_PLUGIN,
-    root: () => {
-      const state = useCapability(HelpCapabilities.MutableState);
-      return (
-        <WelcomeTour
-          steps={steps}
-          running={state.running}
-          onRunningChanged={(newState) => {
-            state.running = newState;
-            if (!newState) {
-              state.showHints = false;
-            }
-          }}
-        />
-      );
-    },
-  });
+export default Capability.makeModule(
+  Effect.fnUntraced(function* (steps?: Step[]) {
+    return Capability.contributes(Capabilities.ReactRoot, {
+      id: meta.id,
+      root: () => {
+        const [state, updateState] = useAtomCapabilityState(HelpCapabilities.State);
+        return (
+          <WelcomeTour
+            steps={steps ?? []}
+            running={state.running}
+            onRunningChanged={(newState) => {
+              updateState((s) => ({ ...s, running: newState }));
+              if (!newState) {
+                updateState((s) => ({ ...s, showHints: false }));
+              }
+            }}
+          />
+        );
+      },
+    });
+  }),
+);

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 { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface } from '@dxos/app-toolkit/ui';
 
-import { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../components';
-import { HELP_PLUGIN } from '../meta';
+import { ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '#containers';
 
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${HELP_PLUGIN}/hints`,
-      role: 'hints',
-      component: () => <ShortcutsHints />,
-    }),
-    createSurface({
-      id: `${HELP_PLUGIN}/keyshortcuts`,
-      role: 'keyshortcuts',
-      component: () => <ShortcutsList />,
-    }),
-    createSurface({
-      id: SHORTCUTS_DIALOG,
-      role: 'dialog',
-      filter: (data): data is any => data.component === SHORTCUTS_DIALOG,
-      component: () => <ShortcutsDialogContent />,
-    }),
-  ]);
+import { SHORTCUTS_DIALOG } from '../constants';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: 'hints',
+        role: 'hints',
+        component: () => <ShortcutsHints />,
+      }),
+      Surface.create({
+        id: 'keyshortcuts',
+        role: 'keyshortcuts',
+        component: () => <ShortcutsList />,
+      }),
+      Surface.create({
+        id: SHORTCUTS_DIALOG,
+        filter: AppSurface.component(AppSurface.Dialog, SHORTCUTS_DIALOG),
+        component: () => <ShortcutsDialogContent />,
+      }),
+    ]),
+  ),
+);

package/src/capabilities/state.ts

@@ -2,22 +2,26 @@
 // Copyright 2025 DXOS.org
 //
 
-import { contributes } from '@dxos/app-framework';
-import { LocalStorageStore } from '@dxos/local-storage';
+import * as Effect from 'effect/Effect';
 
-import { HelpCapabilities } from './capabilities';
-import { HELP_PLUGIN } from '../meta';
+import { Capability } from '@dxos/app-framework';
+import { createKvsStore } from '@dxos/effect';
 
-export default () => {
-  const state = new LocalStorageStore<HelpCapabilities.State>(HELP_PLUGIN, {
-    running: false,
-    showHints: true,
-    showWelcome: true,
-  });
+import { meta } from '#meta';
+import { HelpCapabilities } from '#types';
 
-  state
-    .prop({ key: 'showHints', type: LocalStorageStore.bool() })
-    .prop({ key: 'showWelcome', type: LocalStorageStore.bool() });
+export default Capability.makeModule(() =>
+  Effect.sync(() => {
+    const stateAtom = createKvsStore({
+      key: meta.id,
+      schema: HelpCapabilities.StateSchema,
+      defaultValue: () => ({
+        running: false,
+        showHints: true,
+        showWelcome: true,
+      }),
+    });
 
-  return contributes(HelpCapabilities.State, state.values);
-};
+    return Capability.contributes(HelpCapabilities.State, stateAtom);
+  }),
+);