@dxos/plugin-help 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/src/components/WelcomeTour/WelcomeTour.tsx

@@ -2,13 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { useState, useEffect } from 'react';
+import React, { useState } from 'react';
 import Joyride, { ACTIONS, EVENTS } from 'react-joyride';
 
-import { usePluginManager, useLayout } from '@dxos/app-framework';
+import { usePluginManager } from '@dxos/app-framework/ui';
+import { useLayout } from '@dxos/app-toolkit/ui';
+import { useAsyncEffect } from '@dxos/react-ui';
 
-import { type Step, HelpContext } from '../../types';
-import { floaterProps, Tooltip } from '../Tooltip';
+import { HelpContext, type Step } from '../../types';
+import { Tooltip, floaterProps } from '../Tooltip';
 
 const addStepClass = (target: string | HTMLElement) => {
   const element = typeof target === 'string' ? document.querySelector(target) : target;
@@ -75,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);
   };
@@ -93,20 +95,16 @@ export const WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunni
     }
   };
 
-  useEffect(() => {
-    const timeout = setTimeout(async () => {
-      if (runningProp) {
-        // This handles the case when the target is not yet in the document.
-        // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.
-        await waitForTarget(steps[stepIndex]);
-        setStepIndex(0);
-        setRunning(true);
-      } else if (typeof runningProp !== 'undefined') {
-        setRunning(false);
-      }
-    });
-
-    return () => clearTimeout(timeout);
+  useAsyncEffect(async () => {
+    if (runningProp) {
+      // This handles the case when the target is not yet in the document.
+      // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.
+      await waitForTarget(steps[stepIndex]);
+      setStepIndex(0);
+      setRunning(true);
+    } else if (typeof runningProp !== 'undefined') {
+      setRunning(false);
+    }
   }, [runningProp]);
 
   // https://docs.react-joyride.com/callback

package/src/constants.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { meta } from './meta';
+
+export const SHORTCUTS_DIALOG = `${meta.id}/ShortcutsDialog`;

package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx

@@ -0,0 +1,29 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { Dialog, IconButton, useTranslation } from '@dxos/react-ui';
+
+import { ShortcutsList } from '../../components';
+import { meta } from '../../meta';
+
+export const ShortcutsDialogContent = () => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <Dialog.Content>
+      <div role='none' className='flex justify-between mb-1 pt-3 ps-2 pe-3 @md:pt-4 @md:ps-4 @md:pe-5'>
+        <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>
+        <Dialog.Close asChild>
+          <IconButton icon='ph--x--bold' iconOnly size={3} label='Close' variant='ghost' autoFocus />
+        </Dialog.Close>
+      </div>
+
+      <div className='flex items-center justify-center'>
+        <ShortcutsList />
+      </div>
+    </Dialog.Content>
+  );
+};

package/src/containers/ShortcutsDialogContent/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { ShortcutsDialogContent } from './ShortcutsDialogContent';
+
+export default ShortcutsDialogContent;

package/src/containers/ShortcutsHints/ShortcutsHints.tsx

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { ShortcutsHints } from '../../components';

package/src/containers/ShortcutsHints/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { ShortcutsHints } from './ShortcutsHints';
+
+export default ShortcutsHints;

package/src/containers/ShortcutsList/ShortcutsList.tsx

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { ShortcutsList } from '../../components';

package/src/containers/ShortcutsList/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { ShortcutsList } from './ShortcutsList';
+
+export default ShortcutsList;

package/src/containers/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const ShortcutsDialogContent: ComponentType<any> = lazy(() => import('./ShortcutsDialogContent'));
+export const ShortcutsHints: ComponentType<any> = lazy(() => import('./ShortcutsHints'));
+export const ShortcutsList: ComponentType<any> = lazy(() => import('./ShortcutsList'));

package/src/index.ts

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

package/src/meta.ts

@@ -2,13 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-// TODO(burdon): Rename Guide? Help?
-export const HELP_PLUGIN = 'dxos.org/plugin/help';
-
-export const meta: PluginMeta = {
-  id: HELP_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/help',
   name: 'Help',
+  description: trim`
+    Built-in help system with documentation, tutorials, and contextual assistance.
+    Access keyboard shortcuts, feature guides, and support resources.
+  `,
   icon: 'ph--info--regular',
 };

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

@@ -2,16 +2,17 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+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 },
+  });
 }

package/dist/lib/browser/app-graph-builder-BYCMEBNG.mjs

@@ -1,79 +0,0 @@
-import {
-  SHORTCUTS_DIALOG
-} from "./chunk-MNETJXKS.mjs";
-import {
-  HelpAction
-} from "./chunk-J2SJSGSX.mjs";
-import {
-  HelpCapabilities
-} from "./chunk-LDRUZNSN.mjs";
-import {
-  HELP_PLUGIN
-} from "./chunk-3Y4CMOZP.mjs";
-
-// src/capabilities/app-graph-builder.ts
-import { Rx } from "@effect-rx/rx-react";
-import { Option, pipe } from "effect";
-import { Capabilities, contributes, createIntent, LayoutAction } from "@dxos/app-framework";
-import { createExtension } from "@dxos/app-graph";
-var app_graph_builder_default = (context) => contributes(Capabilities.AppGraphBuilder, createExtension({
-  id: HELP_PLUGIN,
-  actions: (node) => Rx.make((get) => pipe(get(node), Option.flatMap((node2) => node2.id === "root" ? Option.some(node2) : 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"
-      }
-    },
-    {
-      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+/"
-        }
-      }
-    }
-  ]), Option.getOrElse(() => [])))
-}));
-export {
-  app_graph_builder_default as default
-};
-//# sourceMappingURL=app-graph-builder-BYCMEBNG.mjs.map

package/dist/lib/browser/app-graph-builder-BYCMEBNG.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/app-graph-builder.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport { Option, pipe } from 'effect';\n\nimport { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';\nimport { createExtension } from '@dxos/app-graph';\n\nimport { HelpCapabilities } from './capabilities';\nimport { SHORTCUTS_DIALOG } from '../components';\nimport { HELP_PLUGIN } from '../meta';\nimport { HelpAction } from '../types';\n\nexport default (context: PluginContext) =>\n  contributes(\n    Capabilities.AppGraphBuilder,\n    createExtension({\n      id: HELP_PLUGIN,\n      actions: (node) =>\n        Rx.make((get) =>\n          pipe(\n            get(node),\n            Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : Option.none())),\n            Option.map(() => [\n              {\n                id: HelpAction.Start._tag,\n                data: async () => {\n                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n                  const state = context.getCapability(HelpCapabilities.MutableState);\n                  state.showHints = true;\n                  await dispatch(createIntent(HelpAction.Start));\n                },\n                properties: {\n                  label: ['open help tour', { ns: HELP_PLUGIN }],\n                  icon: 'ph--info--regular',\n                  keyBinding: {\n                    macos: 'shift+meta+/',\n                    // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n                    windows: 'shift+ctrl+/',\n                    linux: 'shift+ctrl+?',\n                  },\n                  testId: 'helpPlugin.openHelp',\n                },\n              },\n              {\n                id: 'dxos.org/plugin/help/open-shortcuts',\n                data: async () => {\n                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n                  const state = context.getCapability(HelpCapabilities.MutableState);\n                  state.showHints = true;\n                  await dispatch(\n                    createIntent(LayoutAction.UpdateDialog, {\n                      part: 'dialog',\n                      subject: SHORTCUTS_DIALOG,\n                      options: {\n                        blockAlign: 'center',\n                      },\n                    }),\n                  );\n                },\n                properties: {\n                  label: ['open shortcuts label', { ns: HELP_PLUGIN }],\n                  icon: 'ph--keyboard--regular',\n                  keyBinding: {\n                    macos: 'meta+ctrl+/',\n                  },\n                },\n              },\n            ]),\n            Option.getOrElse(() => []),\n          ),\n        ),\n    }),\n  );\n"],
-  "mappings": ";;;;;;;;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,cAAcC,aAAaC,cAAcC,oBAAwC;AAC1F,SAASC,uBAAuB;AAOhC,IAAA,4BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC;EACJC,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAO,SAASQ,OAAOE,KAAKP,KAAAA,IAAQK,OAAOG,KAAI,CAAA,GAC9EH,OAAOI,IAAI,MAAM;IACf;MACEZ,IAAIa,WAAWC,MAAMC;MACrBC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SAASO,aAAaZ,WAAWC,KAAK,CAAA;MAC9C;MACAY,YAAY;QACVC,OAAO;UAAC;UAAkB;YAAEC,IAAI3B;UAAY;;QAC5C4B,MAAM;QACNC,YAAY;UACVC,OAAO;;UAEPC,SAAS;UACTC,OAAO;QACT;QACAC,QAAQ;MACV;IACF;IACA;MACElC,IAAI;MACJgB,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SACJO,aAAaU,aAAaC,cAAc;UACtCC,MAAM;UACNC,SAASC;UACTC,SAAS;YACPC,YAAY;UACd;QACF,CAAA,CAAA;MAEJ;MACAf,YAAY;QACVC,OAAO;UAAC;UAAwB;YAAEC,IAAI3B;UAAY;;QAClD4B,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;MACF;IACF;GACD,GACDvB,OAAOkC,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
-  "names": ["Rx", "Option", "pipe", "Capabilities", "contributes", "createIntent", "LayoutAction", "createExtension", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "HELP_PLUGIN", "actions", "node", "Rx", "make", "get", "pipe", "Option", "flatMap", "some", "none", "map", "HelpAction", "Start", "_tag", "data", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "state", "HelpCapabilities", "MutableState", "showHints", "createIntent", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "UpdateDialog", "part", "subject", "SHORTCUTS_DIALOG", "options", "blockAlign", "getOrElse"]
-}

package/dist/lib/browser/chunk-3Y4CMOZP.mjs

@@ -1,13 +0,0 @@
-// src/meta.ts
-var HELP_PLUGIN = "dxos.org/plugin/help";
-var meta = {
-  id: HELP_PLUGIN,
-  name: "Help",
-  icon: "ph--info--regular"
-};
-
-export {
-  HELP_PLUGIN,
-  meta
-};
-//# sourceMappingURL=chunk-3Y4CMOZP.mjs.map

package/dist/lib/browser/chunk-3Y4CMOZP.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\n// TODO(burdon): Rename Guide? Help?\nexport const HELP_PLUGIN = 'dxos.org/plugin/help';\n\nexport const meta: PluginMeta = {\n  id: HELP_PLUGIN,\n  name: 'Help',\n  icon: 'ph--info--regular',\n};\n"],
-  "mappings": ";AAOO,IAAMA,cAAc;AAEpB,IAAMC,OAAmB;EAC9BC,IAAIF;EACJG,MAAM;EACNC,MAAM;AACR;",
-  "names": ["HELP_PLUGIN", "meta", "id", "name", "icon"]
-}

package/dist/lib/browser/chunk-J2SJSGSX.mjs

@@ -1,34 +0,0 @@
-import {
-  meta
-} from "./chunk-3Y4CMOZP.mjs";
-
-// src/types/schema.ts
-import { Schema } from "effect";
-import { createContext } from "react";
-var HelpContext = createContext({
-  running: false,
-  steps: [],
-  setSteps: () => {
-  },
-  setIndex: () => {
-  },
-  start: () => {
-  },
-  stop: () => {
-  }
-});
-(function(HelpAction2) {
-  class Start extends Schema.TaggedClass()(`${meta.id}/action/start`, {
-    input: Schema.Void,
-    output: Schema.Void
-  }) {
-  }
-  HelpAction2.Start = Start;
-})(HelpAction || (HelpAction = {}));
-var HelpAction;
-
-export {
-  HelpContext,
-  HelpAction
-};
-//# sourceMappingURL=chunk-J2SJSGSX.mjs.map

package/dist/lib/browser/chunk-J2SJSGSX.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/schema.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Schema } from 'effect';\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { type PluginContext } from '@dxos/app-framework';\n\nimport { meta } from '../meta';\n\nexport type Step = BaseStep & {\n  before?: (context: PluginContext) => void;\n};\n\nexport type HelpContextType = {\n  running: boolean;\n  steps: Step[];\n  setSteps: (steps: Step[]) => void;\n  setIndex: (index: number) => void;\n  start: () => void;\n  stop: () => void;\n};\n\nexport const HelpContext: Context<HelpContextType> = createContext<HelpContextType>({\n  running: false,\n  steps: [],\n  setSteps: () => {},\n  setIndex: () => {},\n  start: () => {},\n  stop: () => {},\n});\n\nexport namespace HelpAction {\n  export class Start extends Schema.TaggedClass<Start>()(`${meta.id}/action/start`, {\n    input: Schema.Void,\n    output: Schema.Void,\n  }) {}\n}\n"],
-  "mappings": ";;;;;AAIA,SAASA,cAAc;AACvB,SAAuBC,qBAAqB;AAoBrC,IAAMC,cAAwCC,cAA+B;EAClFC,SAAS;EACTC,OAAO,CAAA;EACPC,UAAU,MAAA;EAAO;EACjBC,UAAU,MAAA;EAAO;EACjBC,OAAO,MAAA;EAAO;EACdC,MAAM,MAAA;EAAO;AACf,CAAA;UAEiBC,aAAAA;EACR,MAAMC,cAAcC,OAAOC,YAAW,EAAU,GAAGC,KAAKC,EAAE,iBAAiB;IAChFC,OAAOJ,OAAOK;IACdC,QAAQN,OAAOK;EACjB,CAAA,EAAA;EAAI;cAHSN,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;;",
-  "names": ["Schema", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HelpAction", "Start", "Schema", "TaggedClass", "meta", "id", "input", "Void", "output"]
-}

package/dist/lib/browser/chunk-LDRUZNSN.mjs

@@ -1,16 +0,0 @@
-import {
-  HELP_PLUGIN
-} from "./chunk-3Y4CMOZP.mjs";
-
-// src/capabilities/capabilities.ts
-import { defineCapability } from "@dxos/app-framework";
-(function(HelpCapabilities2) {
-  HelpCapabilities2.State = defineCapability(`${HELP_PLUGIN}/capability/state`);
-  HelpCapabilities2.MutableState = defineCapability(`${HELP_PLUGIN}/capability/state`);
-})(HelpCapabilities || (HelpCapabilities = {}));
-var HelpCapabilities;
-
-export {
-  HelpCapabilities
-};
-//# sourceMappingURL=chunk-LDRUZNSN.mjs.map

package/dist/lib/browser/chunk-LDRUZNSN.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/capabilities.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineCapability } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from '../meta';\n\nexport namespace HelpCapabilities {\n  export type State = { running: boolean; showHints: boolean; showWelcome: boolean };\n  export const State = defineCapability<Readonly<State>>(`${HELP_PLUGIN}/capability/state`);\n  export const MutableState = defineCapability<State>(`${HELP_PLUGIN}/capability/state`);\n}\n"],
-  "mappings": ";;;;;AAIA,SAASA,wBAAwB;UAIhBC,mBAAAA;oBAEFC,QAAQC,iBAAkC,GAAGC,WAAAA,mBAA8B;oBAC3EC,eAAeF,iBAAwB,GAAGC,WAAAA,mBAA8B;AACvF,GAJiBH,qBAAAA,mBAAAA,CAAAA,EAAAA;;",
-  "names": ["defineCapability", "HelpCapabilities", "State", "defineCapability", "HELP_PLUGIN", "MutableState"]
-}