@dxos/plugin-help 0.8.4-main.84f28bd → 0.8.4-main.937b3ca

package/package.json

@@ -1,25 +1,32 @@
 {
   "name": "@dxos/plugin-help",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.937b3ca",
   "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",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs"
     },
     "./meta": {
+      "source": "./src/meta.ts",
       "types": "./dist/types/src/meta.d.ts",
       "browser": "./dist/lib/browser/meta.mjs"
     },
     "./types": {
-      "types": "./dist/types/src/types.d.ts",
-      "browser": "./dist/lib/browser/types.mjs"
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "browser": "./dist/lib/browser/types/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -29,7 +36,7 @@
         "dist/types/src/meta.d.ts"
       ],
       "types": [
-        "dist/types/src/types.d.ts"
+        "dist/types/src/types/index.d.ts"
       ]
     }
   },
@@ -38,48 +45,47 @@
     "src"
   ],
   "dependencies": {
-    "@fluentui/react-tabster": "^9.24.2",
-    "@preact-signals/safe-react": "^0.9.0",
+    "@effect-atom/atom": "^0.4.13",
+    "@fluentui/react-tabster": "9.26.11",
     "react-joyride": "^2.7.2",
-    "@dxos/app-framework": "0.8.4-main.84f28bd",
-    "@dxos/app-graph": "0.8.4-main.84f28bd",
-    "@dxos/debug": "0.8.4-main.84f28bd",
-    "@dxos/echo": "0.8.4-main.84f28bd",
-    "@dxos/keyboard": "0.8.4-main.84f28bd",
-    "@dxos/echo-schema": "0.8.4-main.84f28bd",
-    "@dxos/live-object": "0.8.4-main.84f28bd",
-    "@dxos/local-storage": "0.8.4-main.84f28bd",
-    "@dxos/plugin-client": "0.8.4-main.84f28bd",
-    "@dxos/plugin-graph": "0.8.4-main.84f28bd",
-    "@dxos/plugin-space": "0.8.4-main.84f28bd",
-    "@dxos/react-client": "0.8.4-main.84f28bd"
+    "@dxos/app-framework": "0.8.4-main.937b3ca",
+    "@dxos/app-graph": "0.8.4-main.937b3ca",
+    "@dxos/debug": "0.8.4-main.937b3ca",
+    "@dxos/echo": "0.8.4-main.937b3ca",
+    "@dxos/keyboard": "0.8.4-main.937b3ca",
+    "@dxos/effect": "0.8.4-main.937b3ca",
+    "@dxos/operation": "0.8.4-main.937b3ca",
+    "@dxos/plugin-graph": "0.8.4-main.937b3ca",
+    "@dxos/react-client": "0.8.4-main.937b3ca",
+    "@dxos/util": "0.8.4-main.937b3ca",
+    "@dxos/plugin-client": "0.8.4-main.937b3ca",
+    "@dxos/plugin-space": "0.8.4-main.937b3ca"
   },
   "devDependencies": {
-    "@effect-rx/rx-react": "0.38.0",
-    "@effect/platform": "0.88.0",
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "effect": "3.16.13",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
+    "@effect-atom/atom-react": "^0.4.6",
+    "@effect/platform": "0.93.6",
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "effect": "3.19.11",
+    "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.4-main.84f28bd",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd",
-    "@dxos/storybook-utils": "0.8.4-main.84f28bd"
+    "vite": "7.1.9",
+    "@dxos/random": "0.8.4-main.937b3ca",
+    "@dxos/plugin-testing": "0.8.4-main.937b3ca",
+    "@dxos/react-ui": "0.8.4-main.937b3ca",
+    "@dxos/storybook-utils": "0.8.4-main.937b3ca",
+    "@dxos/ui-theme": "0.8.4-main.937b3ca"
   },
   "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.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd"
+    "@effect-atom/atom-react": "^0.4.6",
+    "@effect/platform": "0.93.6",
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.937b3ca",
+    "@dxos/ui-theme": "0.8.4-main.937b3ca"
   },
   "publishConfig": {
     "access": "public"

package/src/HelpPlugin.tsx

@@ -2,56 +2,28 @@
 // Copyright 2023 DXOS.org
 //
 
-import { createResolver, defineModule, definePlugin, Events, contributes, Capabilities } from '@dxos/app-framework';
+import { Common, Plugin } from '@dxos/app-framework';
 
-import { AppGraphBuilder, HelpState, ReactRoot, ReactSurface } from './capabilities';
-import { HelpCapabilities } from './capabilities/capabilities';
+import { AppGraphBuilder, HelpState, OperationResolver, ReactRoot, ReactSurface } from './capabilities';
 import { meta } from './meta';
 import { translations } from './translations';
-import { type Step, HelpAction } from './types';
+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(
+  Plugin.addModule({
+    activatesOn: Common.ActivationEvent.Startup,
+    activate: HelpState,
+  }),
+  Common.Plugin.addTranslationsModule({ translations }),
+  Plugin.addModule(({ steps = [] }) => ({
+    id: 'react-root',
+    activatesOn: Common.ActivationEvent.Startup,
+    activate: () => ReactRoot(steps),
+  })),
+  Common.Plugin.addSurfaceModule({ activate: ReactSurface }),
+  Common.Plugin.addOperationResolverModule({ activate: OperationResolver }),
+  Common.Plugin.addAppGraphModule({ activate: AppGraphBuilder }),
+  Plugin.make,
+);

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

@@ -0,0 +1,61 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { GraphBuilder, NodeMatcher } from '@dxos/app-graph';
+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* Common.Capability.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* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
+              yield* Operation.invoke(Common.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(Common.Capability.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 { Capability, Common } from '@dxos/app-framework';
+import { OperationResolver } from '@dxos/operation';
+
+import { HelpCapabilities, HelpOperation } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Common.Capability.OperationResolver, [
+      OperationResolver.make({
+        operation: HelpOperation.Start,
+        handler: Effect.fnUntraced(function* () {
+          yield* Common.Capability.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 { Capability, Common } from '@dxos/app-framework';
+import { useAtomCapabilityState } from '@dxos/app-framework/react';
+
+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(Common.Capability.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,34 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capability, Common } from '@dxos/app-framework';
+
+import { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../../components';
+import { meta } from '../../meta';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Common.Capability.ReactSurface, [
+      Common.createSurface({
+        id: `${meta.id}/hints`,
+        role: 'hints',
+        component: () => <ShortcutsHints />,
+      }),
+      Common.createSurface({
+        id: `${meta.id}/keyshortcuts`,
+        role: 'keyshortcuts',
+        component: () => <ShortcutsList />,
+      }),
+      Common.createSurface({
+        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

@@ -4,25 +4,23 @@
 
 import React from 'react';
 
-import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
+import { Dialog, IconButton, useTranslation } from '@dxos/react-ui';
+
+import { meta } from '../../meta';
 
 import { ShortcutsList } from './ShortcutsList';
-import { HELP_PLUGIN } from '../../meta';
 
-export const SHORTCUTS_DIALOG = `${HELP_PLUGIN}/ShortcutsDialog`;
+export const SHORTCUTS_DIALOG = `${meta.id}/ShortcutsDialog`;
 
 export const ShortcutsDialogContent = () => {
-  const { t } = useTranslation(HELP_PLUGIN);
+  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>
-          <Button density='fine' variant='ghost' autoFocus>
-            <Icon icon='ph--x--bold' size={3} />
-          </Button>
+          <IconButton icon='ph--x--bold' iconOnly size={3} label='Close' variant='ghost' autoFocus />
         </Dialog.Close>
       </div>
 

package/src/components/Shortcuts/ShortcutsHints.tsx

@@ -5,12 +5,13 @@
 import React from 'react';
 
 import { type KeyBinding, Keyboard } from '@dxos/keyboard';
-import { Button, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';
+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} />
@@ -26,14 +27,21 @@ export const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {
   const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));
 
   return (
-    <div role='none' className='flex overflow-hidden px-2 gap-4'>
+    <div role='none' className='flex overflow-hidden pli-2 gap-4'>
       {hints.map((binding) => (
         <Shortcut key={binding.shortcut} binding={binding} />
       ))}
       {onClose && (
-        <Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>
-          <Icon icon='ph--x--regular' size={4} />
-        </Button>
+        <IconButton
+          icon='ph--x--regular'
+          size={4}
+          label='Close'
+          iconOnly
+          noTooltip
+          variant='ghost'
+          classNames='p-0 cursor-pointer'
+          onClick={onClose}
+        />
       )}
     </div>
   );

package/src/components/Shortcuts/ShortcutsList.tsx

@@ -6,13 +6,14 @@ 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';
 
 import { Key } from './Key';
-import { HELP_PLUGIN } from '../../meta';
 
 export const ShortcutsList = () => {
-  const { t } = useTranslation(HELP_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const bindings = Keyboard.singleton.getBindings();
 
   // TODO(burdon): Get shortcuts from TextEditor.

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',