@dxos/plugin-help 0.8.4-main.70d3990 → 0.8.4-main.7996785055

package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx

@@ -0,0 +1,39 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Dialog } from '@dxos/react-ui';
+import { withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+
+import { ShortcutsDialogContent } from './ShortcutsDialogContent';
+
+const DefaultStory = () => (
+  <Dialog.Root defaultOpen>
+    <Dialog.Overlay>
+      <ShortcutsDialogContent />
+    </Dialog.Overlay>
+  </Dialog.Root>
+);
+
+const meta = {
+  title: 'plugins/plugin-help/containers/ShortcutsDialogContent',
+  component: ShortcutsDialogContent,
+  render: DefaultStory,
+  decorators: [withTheme(), withPluginManager()],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof ShortcutsDialogContent>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx

@@ -0,0 +1,28 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { Dialog, useTranslation } from '@dxos/react-ui';
+
+import { ShortcutsList } from '../../components';
+import { meta } from '../../meta';
+
+export const ShortcutsDialogContent = () => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <Dialog.Content>
+      <Dialog.Header>
+        <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>
+        <Dialog.Close asChild>
+          <Dialog.CloseIconButton />
+        </Dialog.Close>
+      </Dialog.Header>
+      <Dialog.Body>
+        <ShortcutsList />
+      </Dialog.Body>
+    </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,11 +2,11 @@
 // 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 = {
-  id: 'dxos.org/plugin/help',
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.help',
   name: 'Help',
   description: trim`
     Built-in help system with documentation, tutorials, and contextual assistance.

package/src/operations/definitions.ts

@@ -0,0 +1,19 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/operation';
+
+import { meta } from '../meta';
+
+const HELP_OPERATION = `${meta.id}.operation`;
+
+export const Start = Operation.make({
+  meta: { key: `${HELP_OPERATION}.start`, name: 'Start Help' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});

package/src/operations/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+export * as HelpOperation from './definitions';
+
+export const HelpOperationHandlerSet = OperationHandlerSet.lazy(() => import('./start'));

package/src/operations/start.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities } from '@dxos/app-framework';
+import { Operation } from '@dxos/operation';
+
+import { HelpCapabilities } from '../types';
+import { Start } from './definitions';
+
+const handler: Operation.WithHandler<typeof Start> = Start.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      yield* Capabilities.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
+    }),
+  ),
+);
+
+export default handler;

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,13 @@
 // Copyright 2023 DXOS.org
 //
 
-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 { meta } from '../meta';
+import { type CapabilityManager } from '@dxos/app-framework';
 
 export type Step = BaseStep & {
-  before?: (context: PluginContext) => void;
+  before?: (capabilities: CapabilityManager.CapabilityManager) => void;
 };
 
 export type HelpContextType = {
@@ -31,10 +28,3 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
   start: () => {},
   stop: () => {},
 });
-
-export namespace HelpAction {
-  export class Start extends Schema.TaggedClass<Start>()(`${meta.id}/action/start`, {
-    input: Schema.Void,
-    output: Schema.Void,
-  }) {}
-}

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

@@ -1,80 +0,0 @@
-import {
-  SHORTCUTS_DIALOG
-} from "./chunk-W4AUSEGO.mjs";
-import {
-  HelpAction
-} from "./chunk-I7FKM6VC.mjs";
-import {
-  HelpCapabilities
-} from "./chunk-AZJJLAG7.mjs";
-import {
-  meta
-} from "./chunk-BCYK4LXW.mjs";
-
-// src/capabilities/app-graph-builder.ts
-import { Atom } from "@effect-atom/atom-react";
-import * as Function from "effect/Function";
-import * as Option from "effect/Option";
-import { Capabilities, LayoutAction, contributes, createIntent } from "@dxos/app-framework";
-import { createExtension } from "@dxos/app-graph";
-var app_graph_builder_default = ((context) => contributes(Capabilities.AppGraphBuilder, createExtension({
-  id: meta.id,
-  actions: (node) => Atom.make((get) => Function.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: meta.id
-          }
-        ],
-        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: `${meta.id}/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: meta.id
-          }
-        ],
-        icon: "ph--keyboard--regular",
-        keyBinding: {
-          macos: "meta+ctrl+/"
-        }
-      }
-    }
-  ]), Option.getOrElse(() => [])))
-})));
-export {
-  app_graph_builder_default as default
-};
-//# sourceMappingURL=app-graph-builder-L6GUMAIH.mjs.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/app-graph-builder.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Atom } from '@effect-atom/atom-react';\nimport * as Function from 'effect/Function';\nimport * as Option from 'effect/Option';\n\nimport { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';\nimport { createExtension } from '@dxos/app-graph';\n\nimport { SHORTCUTS_DIALOG } from '../components';\nimport { meta } from '../meta';\nimport { HelpAction } from '../types';\n\nimport { HelpCapabilities } from './capabilities';\n\nexport default (context: PluginContext) =>\n  contributes(\n    Capabilities.AppGraphBuilder,\n    createExtension({\n      id: meta.id,\n      actions: (node) =>\n        Atom.make((get) =>\n          Function.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: meta.id }],\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: `${meta.id}/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: meta.id }],\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,YAAY;AACrB,YAAYC,cAAc;AAC1B,YAAYC,YAAY;AAExB,SAASC,cAAcC,cAAkCC,aAAaC,oBAAoB;AAC1F,SAASC,uBAAuB;AAQhC,IAAA,6BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC,KAAKD;EACTE,SAAS,CAACC,SACRC,KAAKC,KAAK,CAACC,QACAC,cACPD,IAAIH,IAAAA,GACGK,eAAQ,CAACL,UAAUA,MAAKH,OAAO,SAAgBS,YAAKN,KAAAA,IAAeO,YAAI,CAAA,GACvEC,WAAI,MAAM;IACf;MACEX,IAAIY,WAAWC,MAAMC;MACrBC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKtB,QAAQuB,cAAcrB,aAAasB,gBAAgB;AACzF,cAAMC,QAAQzB,QAAQuB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SAASO,aAAaZ,WAAWC,KAAK,CAAA;MAC9C;MACAY,YAAY;QACVC,OAAO;UAAC;UAAkB;YAAEC,IAAI1B,KAAKD;UAAG;;QACxC4B,MAAM;QACNC,YAAY;UACVC,OAAO;;UAEPC,SAAS;UACTC,OAAO;QACT;QACAC,QAAQ;MACV;IACF;IACA;MACEjC,IAAI,GAAGC,KAAKD,EAAE;MACde,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKtB,QAAQuB,cAAcrB,aAAasB,gBAAgB;AACzF,cAAMC,QAAQzB,QAAQuB,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,IAAI1B,KAAKD;UAAG;;QAC9C4B,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;MACF;IACF;GACD,GACMW,iBAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
-  "names": ["Atom", "Function", "Option", "Capabilities", "LayoutAction", "contributes", "createIntent", "createExtension", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "meta", "actions", "node", "Atom", "make", "get", "pipe", "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-AZJJLAG7.mjs

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

package/dist/lib/browser/chunk-AZJJLAG7.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 { meta } from '../meta';\n\nexport namespace HelpCapabilities {\n  export type State = { running: boolean; showHints: boolean; showWelcome: boolean };\n  export const State = defineCapability<Readonly<State>>(`${meta.id}/capability/state`);\n  export const MutableState = defineCapability<State>(`${meta.id}/capability/state`);\n}\n"],
-  "mappings": ";;;;;AAIA,SAASA,wBAAwB;UAIhBC,mBAAAA;oBAEFC,QAAQC,iBAAkC,GAAGC,KAAKC,EAAE,mBAAmB;oBACvEC,eAAeH,iBAAwB,GAAGC,KAAKC,EAAE,mBAAmB;AACnF,GAJiBJ,qBAAAA,mBAAAA,CAAAA,EAAAA;;",
-  "names": ["defineCapability", "HelpCapabilities", "State", "defineCapability", "meta", "id", "MutableState"]
-}

package/dist/lib/browser/chunk-BCYK4LXW.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';\nimport { trim } from '@dxos/util';\n\nexport const meta: PluginMeta = {\n  id: 'dxos.org/plugin/help',\n  name: 'Help',\n  description: trim`\n    Built-in help system with documentation, tutorials, and contextual assistance.\n    Access keyboard shortcuts, feature guides, and support resources.\n  `,\n  icon: 'ph--info--regular',\n};\n"],
-  "mappings": ";AAKA,SAASA,YAAY;AAEd,IAAMC,OAAmB;EAC9BC,IAAI;EACJC,MAAM;EACNC,aAAaC;;;;EAIbC,MAAM;AACR;",
-  "names": ["trim", "meta", "id", "name", "description", "trim", "icon"]
-}

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

@@ -1,34 +0,0 @@
-import {
-  meta
-} from "./chunk-BCYK4LXW.mjs";
-
-// src/types/schema.ts
-import * as Schema from "effect/Schema";
-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-I7FKM6VC.mjs.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/schema.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\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,YAAYA,YAAY;AACxB,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,cAAqBC,mBAAW,EAAU,GAAGC,KAAKC,EAAE,iBAAiB;IAChFC,OAAcC;IACdC,QAAeD;EACjB,CAAA,EAAA;EAAI;cAHSL,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;;",
-  "names": ["Schema", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HelpAction", "Start", "TaggedClass", "meta", "id", "input", "Void", "output"]
-}