@dxos/plugin-help 0.8.4-main.3c1ae3b → 0.8.4-main.3eb6e50203

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@dxos/plugin-help",
-  "version": "0.8.4-main.3c1ae3b",
+  "version": "0.8.4-main.3eb6e50203",
   "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,
@@ -41,47 +45,48 @@
     "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-framework": "0.8.4-main.3c1ae3b",
-    "@dxos/debug": "0.8.4-main.3c1ae3b",
-    "@dxos/keyboard": "0.8.4-main.3c1ae3b",
-    "@dxos/echo": "0.8.4-main.3c1ae3b",
-    "@dxos/app-graph": "0.8.4-main.3c1ae3b",
-    "@dxos/live-object": "0.8.4-main.3c1ae3b",
-    "@dxos/local-storage": "0.8.4-main.3c1ae3b",
-    "@dxos/plugin-client": "0.8.4-main.3c1ae3b",
-    "@dxos/plugin-graph": "0.8.4-main.3c1ae3b",
-    "@dxos/plugin-space": "0.8.4-main.3c1ae3b",
-    "@dxos/react-client": "0.8.4-main.3c1ae3b",
-    "@dxos/util": "0.8.4-main.3c1ae3b"
+    "@dxos/app-graph": "0.8.4-main.3eb6e50203",
+    "@dxos/app-framework": "0.8.4-main.3eb6e50203",
+    "@dxos/app-toolkit": "0.8.4-main.3eb6e50203",
+    "@dxos/debug": "0.8.4-main.3eb6e50203",
+    "@dxos/echo": "0.8.4-main.3eb6e50203",
+    "@dxos/effect": "0.8.4-main.3eb6e50203",
+    "@dxos/operation": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-client": "0.8.4-main.3eb6e50203",
+    "@dxos/keyboard": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-space": "0.8.4-main.3eb6e50203",
+    "@dxos/react-client": "0.8.4-main.3eb6e50203",
+    "@dxos/plugin-graph": "0.8.4-main.3eb6e50203",
+    "@dxos/util": "0.8.4-main.3eb6e50203"
   },
   "devDependencies": {
-    "@effect-atom/atom-react": "^0.3.4",
-    "@effect/platform": "0.92.1",
-    "@types/react": "~19.2.2",
-    "@types/react-dom": "~19.2.2",
-    "effect": "3.18.3",
-    "react": "~19.2.0",
-    "react-dom": "~19.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.19.16",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
     "react-floater": "0.7.9",
     "type-fest": "4.10.1",
     "vite": "7.1.9",
-    "@dxos/plugin-storybook-layout": "0.8.4-main.3c1ae3b",
-    "@dxos/random": "0.8.4-main.3c1ae3b",
-    "@dxos/react-ui": "0.8.4-main.3c1ae3b",
-    "@dxos/storybook-utils": "0.8.4-main.3c1ae3b",
-    "@dxos/react-ui-theme": "0.8.4-main.3c1ae3b"
+    "@dxos/plugin-testing": "0.8.4-main.3eb6e50203",
+    "@dxos/random": "0.8.4-main.3eb6e50203",
+    "@dxos/ui-theme": "0.8.4-main.3eb6e50203",
+    "@dxos/react-ui": "0.8.4-main.3eb6e50203",
+    "@dxos/storybook-utils": "0.8.4-main.3eb6e50203"
   },
   "peerDependencies": {
-    "@effect-atom/atom-react": "^0.3.4",
-    "@effect/platform": "^0.80.12",
-    "effect": "^3.13.3",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "@dxos/react-ui": "0.8.4-main.3c1ae3b",
-    "@dxos/react-ui-theme": "0.8.4-main.3c1ae3b"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "effect": "3.19.16",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.3eb6e50203",
+    "@dxos/ui-theme": "0.8.4-main.3eb6e50203"
   },
   "publishConfig": {
     "access": "public"

package/src/HelpPlugin.tsx

@@ -2,54 +2,29 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Capabilities, Events, contributes, createResolver, defineModule, definePlugin } from '@dxos/app-framework';
+import { ActivationEvents, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
 
-import { AppGraphBuilder, HelpCapabilities, HelpState, ReactRoot, ReactSurface } from './capabilities';
+import { AppGraphBuilder, HelpState, OperationResolver, ReactRoot, ReactSurface } from './capabilities';
 import { meta } from './meta';
 import { translations } from './translations';
-import { HelpAction, type Step } from './types';
+import { type Step } from './types';
 
 export type HelpPluginOptions = { steps?: Step[] };
 
-export const HelpPlugin = definePlugin<HelpPluginOptions>(meta, ({ steps = [] }) => [
-  defineModule({
-    id: `${meta.id}/module/state`,
-    activatesOn: Events.Startup,
+export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
+  AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
+  AppPlugin.addOperationResolverModule({ activate: OperationResolver }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule({
+    activatesOn: ActivationEvents.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,
+  Plugin.addModule(({ steps = [] }) => ({
+    id: 'react-root',
+    activatesOn: ActivationEvents.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,
-  }),
-]);
+  })),
+  Plugin.make,
+);

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

@@ -0,0 +1,62 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { GraphBuilder, NodeMatcher } from '@dxos/app-graph';
+import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/operation';
+
+import { SHORTCUTS_DIALOG } from '../../components';
+import { meta } from '../../meta';
+import { HelpCapabilities, HelpOperation } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const extensions = yield* GraphBuilder.createExtension({
+      id: meta.id,
+      match: NodeMatcher.whenRoot,
+      actions: () =>
+        Effect.succeed([
+          {
+            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', { ns: meta.id }],
+              icon: 'ph--info--regular',
+              keyBinding: {
+                macos: 'shift+meta+/',
+                windows: 'shift+ctrl+/',
+                linux: 'shift+ctrl+?',
+              },
+              testId: 'helpPlugin.openHelp',
+            },
+          },
+          {
+            id: `${meta.id}/open-shortcuts`,
+            data: Effect.fnUntraced(function* () {
+              yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
+              yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+                subject: SHORTCUTS_DIALOG,
+                blockAlign: 'center',
+              });
+            }),
+            properties: {
+              label: ['open shortcuts label', { ns: meta.id }],
+              icon: 'ph--keyboard--regular',
+              keyBinding: {
+                macos: 'meta+ctrl+/',
+              },
+            },
+          },
+        ]),
+    });
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);

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

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

package/src/capabilities/index.ts

@@ -2,11 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
-
-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 * from './app-graph-builder';
+export * from './operation-resolver';
+export * from './react-root';
+export * from './react-surface';
+export * from './state';

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

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { default as OperationResolver } from './operation-resolver';

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

@@ -0,0 +1,23 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { OperationResolver } from '@dxos/operation';
+
+import { HelpCapabilities, HelpOperation } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Capabilities.OperationResolver, [
+      OperationResolver.make({
+        operation: HelpOperation.Start,
+        handler: Effect.fnUntraced(function* () {
+          yield* Capabilities.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
+        }),
+      }),
+    ]);
+  }),
+);

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

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

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

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { useAtomCapabilityState } from '@dxos/app-framework/ui';
+
+import { WelcomeTour } from '../../components';
+import { meta } from '../../meta';
+import { HelpCapabilities, type Step } from '../../types';
+
+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/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,35 @@
+//
+// 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 { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../../components';
+import { meta } from '../../meta';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      Surface.create({
+        id: `${meta.id}/hints`,
+        role: 'hints',
+        component: () => <ShortcutsHints />,
+      }),
+      Surface.create({
+        id: `${meta.id}/keyshortcuts`,
+        role: 'keyshortcuts',
+        component: () => <ShortcutsList />,
+      }),
+      Surface.create({
+        id: SHORTCUTS_DIALOG,
+        role: 'dialog',
+        filter: (data): data is { component: string } => data.component === SHORTCUTS_DIALOG,
+        component: () => <ShortcutsDialogContent />,
+      }),
+    ]),
+  ),
+);

package/src/capabilities/state/index.ts

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

package/src/capabilities/state/state.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { createKvsStore } from '@dxos/effect';
+
+import { meta } from '../../meta';
+import { HelpCapabilities } from '../../types';
+
+export default Capability.makeModule(() =>
+  Effect.sync(() => {
+    const stateAtom = createKvsStore({
+      key: meta.id,
+      schema: HelpCapabilities.StateSchema,
+      defaultValue: () => ({
+        running: false,
+        showHints: true,
+        showWelcome: true,
+      }),
+    });
+
+    return Capability.contributes(HelpCapabilities.State, stateAtom);
+  }),
+);

package/src/components/Shortcuts/ShortcutsDialog.tsx

@@ -16,7 +16,7 @@ export const ShortcutsDialogContent = () => {
   const { t } = useTranslation(meta.id);
 
   return (
-    <Dialog.Content classNames='p-0 bs-content max-bs-full md:max-is-[25rem] overflow-hidden'>
+    <Dialog.Content>
       <div role='none' className='flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5'>
         <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>
         <Dialog.Close asChild>

package/src/components/Shortcuts/ShortcutsHints.tsx

@@ -6,11 +6,12 @@ import React from 'react';
 
 import { type KeyBinding, Keyboard } from '@dxos/keyboard';
 import { IconButton, toLocalizedString, useTranslation } from '@dxos/react-ui';
+import { osTranslations } from '@dxos/ui-theme';
 
 import { Key } from './Key';
 
 const Shortcut = ({ binding }: { binding: KeyBinding }) => {
-  const { t } = useTranslation('os');
+  const { t } = useTranslation(osTranslations);
   return (
     <div role='none' className='flex items-center gap-2 whitespace-nowrap'>
       <Key binding={binding.shortcut} />

package/src/components/Shortcuts/ShortcutsList.tsx

@@ -6,7 +6,7 @@ import React, { Fragment } from 'react';
 
 import { Keyboard } from '@dxos/keyboard';
 import { toLocalizedString, useTranslation } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import { mx } from '@dxos/ui-theme';
 
 import { meta } from '../../meta';
 

package/src/components/Shortcuts/ShortcutsSection.tsx

@@ -4,7 +4,7 @@
 
 import React from 'react';
 
-import { descriptionText } from '@dxos/react-ui-theme';
+import { descriptionText } from '@dxos/ui-theme';
 
 import { ShortcutsList } from './ShortcutsList';
 

package/src/components/Shortcuts/styles.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { mx } from '@dxos/react-ui-theme';
+import { mx } from '@dxos/ui-theme';
 
 export const shortcutKey = mx(
   'inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs',

package/src/components/WelcomeTour/WelcomeTour.stories.tsx

@@ -6,7 +6,7 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
 import { withPluginManager } from '@dxos/app-framework/testing';
-import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
+import { StorybookPlugin } from '@dxos/plugin-testing';
 import { faker } from '@dxos/random';
 import { Button, Icon } from '@dxos/react-ui';
 import { withTheme } from '@dxos/react-ui/testing';
@@ -32,7 +32,7 @@ const App = () => {
         <div>{String(running)}</div>
       </div>
       <div>
-        <ul className='p-2 border border-blue-500 rounded-md' data-joyride='basic/2'>
+        <ul className='p-2 border border-primary-500 rounded-md' data-joyride='basic/2'>
           {items.map((item, i) => (
             <li key={i} className='flex items-center gap-2'>
               <Icon icon='ph--circle--regular' />
@@ -108,8 +108,12 @@ const meta = {
   title: 'plugins/plugin-help/WelcomeTour',
   component: WelcomeTour,
   render: DefaultStory,
-  // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
-  decorators: [withTheme, withPluginManager({ plugins: [StorybookLayoutPlugin({})] })],
+  decorators: [
+    withTheme(),
+    withPluginManager({
+      plugins: [StorybookPlugin({})],
+    }),
+  ],
 } satisfies Meta<typeof WelcomeTour>;
 
 export default meta;

package/src/components/WelcomeTour/WelcomeTour.tsx

@@ -5,7 +5,8 @@
 import React, { useState } from 'react';
 import Joyride, { ACTIONS, EVENTS } from 'react-joyride';
 
-import { useLayout, usePluginManager } from '@dxos/app-framework/react';
+import { usePluginManager } from '@dxos/app-framework/ui';
+import { useLayout } from '@dxos/app-toolkit/ui';
 import { useAsyncEffect } from '@dxos/react-ui';
 
 import { HelpContext, type Step } from '../../types';
@@ -76,7 +77,7 @@ export const WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunni
   const setStepIndex = (index: number) => {
     if (runningProp) {
       const step = steps[index];
-      step?.before?.(manager.context);
+      step?.before?.(manager.capabilities);
     }
     _setStepIndex(index);
   };

package/src/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-export { HelpCapabilities } from './capabilities';
+export { HelpCapabilities } from './types';
 export * from './components';
 export * from './meta';
 export * from './HelpPlugin';

package/src/meta.ts

@@ -2,10 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
+export const meta: Plugin.Meta = {
   id: 'dxos.org/plugin/help',
   name: 'Help',
   description: trim`

package/src/types/capabilities.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom } from '@effect-atom/atom-react';
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '../meta';
+
+export namespace HelpCapabilities {
+  export const StateSchema = Schema.mutable(
+    Schema.Struct({
+      running: Schema.Boolean,
+      showHints: Schema.Boolean,
+      showWelcome: Schema.Boolean,
+    }),
+  );
+
+  export type State = Schema.Schema.Type<typeof StateSchema>;
+
+  export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
+}

package/src/types/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2025 DXOS.org
 //
 
+export * from './capabilities';
 export * from './schema';

package/src/types/schema.ts

@@ -6,12 +6,13 @@ import * as Schema from 'effect/Schema';
 import { type Context, createContext } from 'react';
 import { type Step as BaseStep } from 'react-joyride';
 
-import { type PluginContext } from '@dxos/app-framework';
+import { Capability, type CapabilityManager } from '@dxos/app-framework';
+import { Operation } from '@dxos/operation';
 
 import { meta } from '../meta';
 
 export type Step = BaseStep & {
-  before?: (context: PluginContext) => void;
+  before?: (capabilities: CapabilityManager.CapabilityManager) => void;
 };
 
 export type HelpContextType = {
@@ -32,9 +33,12 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
   stop: () => {},
 });
 
-export namespace HelpAction {
-  export class Start extends Schema.TaggedClass<Start>()(`${meta.id}/action/start`, {
-    input: Schema.Void,
-    output: Schema.Void,
-  }) {}
+const HELP_OPERATION = `${meta.id}/operation`;
+
+export namespace HelpOperation {
+  export const Start = Operation.make({
+    meta: { key: `${HELP_OPERATION}/start`, name: 'Start Help' },
+    services: [Capability.Service],
+    schema: { input: Schema.Void, output: Schema.Void },
+  });
 }