@dxos/plugin-help 0.8.4-main.9735255 → 0.8.4-main.9be5663bfe

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,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { ShortcutsHints as default } from './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,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { ShortcutsList as default } from './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/hooks/useHelp.tsx

@@ -6,7 +6,7 @@ import { useContext } from 'react';
 
 import { raise } from '@dxos/debug';
 
-import { HelpContext } from '../types';
+import { HelpContext } from '#types';
 
 export const useHelp = () => {
   return useContext(HelpContext) ?? raise(new Error('Missing HelpContext'));

package/src/index.ts

@@ -4,6 +4,7 @@
 
 export { HelpCapabilities } from './types';
 export * from './components';
+export * from './constants';
 export * from './meta';
 export * from './HelpPlugin';
 export * from './hooks';

package/src/meta.ts

@@ -6,7 +6,7 @@ import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
 export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/help',
+  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/translations.ts

@@ -4,16 +4,16 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
+import { meta } from '#meta';
 
 export const translations = [
   {
     'en-US': {
       [meta.id]: {
-        'plugin name': 'Help',
-        'open help tour': 'Show welcome tour',
-        'open shortcuts label': 'Show shortcuts',
-        'shortcuts dialog title': 'Shortcuts',
+        'plugin.name': 'Help',
+        'open-help-tour.message': 'Show welcome tour',
+        'open-shortcuts.label': 'Show shortcuts',
+        'shortcuts-dialog.title': 'Shortcuts',
       },
     },
   },

package/src/types/capabilities.ts

@@ -7,7 +7,7 @@ import * as Schema from 'effect/Schema';
 
 import { Capability } from '@dxos/app-framework';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
 
 export namespace HelpCapabilities {
   export const StateSchema = Schema.mutable(
@@ -20,5 +20,5 @@ export namespace HelpCapabilities {
 
   export type State = Schema.Schema.Type<typeof StateSchema>;
 
-  export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
+  export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);
 }

package/src/types/schema.ts

@@ -2,14 +2,10 @@
 // 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 { Capability, type CapabilityManager } from '@dxos/app-framework';
-import { Operation } from '@dxos/operation';
-
-import { meta } from '../meta';
+import { type CapabilityManager } from '@dxos/app-framework';
 
 export type Step = BaseStep & {
   before?: (capabilities: CapabilityManager.CapabilityManager) => void;
@@ -32,13 +28,3 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
   start: () => {},
   stop: () => {},
 });
-
-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-DX3VXARQ.mjs

@@ -1,79 +0,0 @@
-import {
-  SHORTCUTS_DIALOG
-} from "./chunk-W5XAZM46.mjs";
-import {
-  HelpCapabilities,
-  HelpOperation
-} from "./chunk-TS66J4C6.mjs";
-import {
-  meta
-} from "./chunk-IM2QVQOH.mjs";
-
-// src/capabilities/app-graph-builder/app-graph-builder.ts
-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";
-var app_graph_builder_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);
-}));
-export {
-  app_graph_builder_default as default
-};
-//# sourceMappingURL=app-graph-builder-DX3VXARQ.mjs.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/app-graph-builder/app-graph-builder.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Effect from 'effect/Effect';\n\nimport { Capability, Common } from '@dxos/app-framework';\nimport { GraphBuilder, NodeMatcher } from '@dxos/app-graph';\nimport { Operation } from '@dxos/operation';\n\nimport { SHORTCUTS_DIALOG } from '../../components';\nimport { meta } from '../../meta';\nimport { HelpCapabilities, HelpOperation } from '../../types';\n\nexport default Capability.makeModule(\n  Effect.fnUntraced(function* () {\n    const extensions = yield* GraphBuilder.createExtension({\n      id: meta.id,\n      match: NodeMatcher.whenRoot,\n      actions: () =>\n        Effect.succeed([\n          {\n            id: HelpOperation.Start.meta.key,\n            data: Effect.fnUntraced(function* () {\n              yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));\n              yield* Operation.invoke(HelpOperation.Start);\n            }),\n            properties: {\n              label: ['open help tour', { ns: meta.id }],\n              icon: 'ph--info--regular',\n              keyBinding: {\n                macos: 'shift+meta+/',\n                windows: 'shift+ctrl+/',\n                linux: 'shift+ctrl+?',\n              },\n              testId: 'helpPlugin.openHelp',\n            },\n          },\n          {\n            id: `${meta.id}/open-shortcuts`,\n            data: Effect.fnUntraced(function* () {\n              yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));\n              yield* Operation.invoke(Common.LayoutOperation.UpdateDialog, {\n                subject: SHORTCUTS_DIALOG,\n                blockAlign: 'center',\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    });\n\n    return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);\n  }),\n);\n"],
-  "mappings": ";;;;;;;;;;;;AAIA,YAAYA,YAAY;AAExB,SAASC,YAAYC,cAAc;AACnC,SAASC,cAAcC,mBAAmB;AAC1C,SAASC,iBAAiB;AAM1B,IAAA,4BAAeC,WAAWC,WACjBC,kBAAW,aAAA;AAChB,QAAMC,aAAa,OAAOC,aAAaC,gBAAgB;IACrDC,IAAIC,KAAKD;IACTE,OAAOC,YAAYC;IACnBC,SAAS,MACAC,eAAQ;MACb;QACEN,IAAIO,cAAcC,MAAMP,KAAKQ;QAC7BC,MAAad,kBAAW,aAAA;AACtB,iBAAOe,OAAOjB,WAAWkB,gBAAgBC,iBAAiBC,OAAO,CAACC,OAAO;YAAE,GAAGA;YAAGC,WAAW;UAAK,EAAA;AACjG,iBAAOC,UAAUC,OAAOX,cAAcC,KAAK;QAC7C,CAAA;QACAW,YAAY;UACVC,OAAO;YAAC;YAAkB;cAAEC,IAAIpB,KAAKD;YAAG;;UACxCsB,MAAM;UACNC,YAAY;YACVC,OAAO;YACPC,SAAS;YACTC,OAAO;UACT;UACAC,QAAQ;QACV;MACF;MACA;QACE3B,IAAI,GAAGC,KAAKD,EAAE;QACdU,MAAad,kBAAW,aAAA;AACtB,iBAAOe,OAAOjB,WAAWkB,gBAAgBC,iBAAiBC,OAAO,CAACC,OAAO;YAAE,GAAGA;YAAGC,WAAW;UAAK,EAAA;AACjG,iBAAOC,UAAUC,OAAOP,OAAOiB,gBAAgBC,cAAc;YAC3DC,SAASC;YACTC,YAAY;UACd,CAAA;QACF,CAAA;QACAb,YAAY;UACVC,OAAO;YAAC;YAAwB;cAAEC,IAAIpB,KAAKD;YAAG;;UAC9CsB,MAAM;UACNC,YAAY;YACVC,OAAO;UACT;QACF;MACF;KACD;EACL,CAAA;AAEA,SAAO9B,WAAWuC,YAAYtB,OAAOjB,WAAWwC,iBAAiBrC,UAAAA;AACnE,CAAA,CAAA;",
-  "names": ["Effect", "Capability", "Common", "GraphBuilder", "NodeMatcher", "Operation", "Capability", "makeModule", "fnUntraced", "extensions", "GraphBuilder", "createExtension", "id", "meta", "match", "NodeMatcher", "whenRoot", "actions", "succeed", "HelpOperation", "Start", "key", "data", "Common", "updateAtomValue", "HelpCapabilities", "State", "s", "showHints", "Operation", "invoke", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutOperation", "UpdateDialog", "subject", "SHORTCUTS_DIALOG", "blockAlign", "contributes", "AppGraphBuilder"]
-}

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

@@ -1,58 +0,0 @@
-import {
-  meta
-} from "./chunk-IM2QVQOH.mjs";
-
-// src/types/capabilities.ts
-import * as Schema from "effect/Schema";
-import { Capability } from "@dxos/app-framework";
-(function(HelpCapabilities2) {
-  HelpCapabilities2.StateSchema = Schema.mutable(Schema.Struct({
-    running: Schema.Boolean,
-    showHints: Schema.Boolean,
-    showWelcome: Schema.Boolean
-  }));
-  HelpCapabilities2.State = Capability.make(`${meta.id}/capability/state`);
-})(HelpCapabilities || (HelpCapabilities = {}));
-var HelpCapabilities;
-
-// src/types/schema.ts
-import * as Schema2 from "effect/Schema";
-import { createContext } from "react";
-import { Capability as Capability2 } from "@dxos/app-framework";
-import { Operation } from "@dxos/operation";
-var HelpContext = createContext({
-  running: false,
-  steps: [],
-  setSteps: () => {
-  },
-  setIndex: () => {
-  },
-  start: () => {
-  },
-  stop: () => {
-  }
-});
-var HELP_OPERATION = `${meta.id}/operation`;
-(function(HelpOperation2) {
-  HelpOperation2.Start = Operation.make({
-    meta: {
-      key: `${HELP_OPERATION}/start`,
-      name: "Start Help"
-    },
-    services: [
-      Capability2.Service
-    ],
-    schema: {
-      input: Schema2.Void,
-      output: Schema2.Void
-    }
-  });
-})(HelpOperation || (HelpOperation = {}));
-var HelpOperation;
-
-export {
-  HelpCapabilities,
-  HelpContext,
-  HelpOperation
-};
-//# sourceMappingURL=chunk-TS66J4C6.mjs.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/capabilities.ts", "../../../src/types/schema.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { type Atom } from '@effect-atom/atom-react';\nimport * as Schema from 'effect/Schema';\n\nimport { Capability } from '@dxos/app-framework';\n\nimport { meta } from '../meta';\n\nexport namespace HelpCapabilities {\n  export const StateSchema = Schema.mutable(\n    Schema.Struct({\n      running: Schema.Boolean,\n      showHints: Schema.Boolean,\n      showWelcome: Schema.Boolean,\n    }),\n  );\n\n  export type State = Schema.Schema.Type<typeof StateSchema>;\n\n  export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);\n}\n", "//\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 { Capability, type CapabilityManager } from '@dxos/app-framework';\nimport { Operation } from '@dxos/operation';\n\nimport { meta } from '../meta';\n\nexport type Step = BaseStep & {\n  before?: (capabilities: CapabilityManager.CapabilityManager) => 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\nconst HELP_OPERATION = `${meta.id}/operation`;\n\nexport namespace HelpOperation {\n  export const Start = Operation.make({\n    meta: { key: `${HELP_OPERATION}/start`, name: 'Start Help' },\n    services: [Capability.Service],\n    schema: { input: Schema.Void, output: Schema.Void },\n  });\n}\n"],
-  "mappings": ";;;;;AAKA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;UAIVC,mBAAAA;oBACFC,cAAqBC,eACzBC,cAAO;IACZC,SAAgBC;IAChBC,WAAkBD;IAClBE,aAAoBF;EACtB,CAAA,CAAA;oBAKWG,QAAQC,WAAWC,KAA2B,GAAGC,KAAKC,EAAE,mBAAmB;AAC1F,GAZiBZ,qBAAAA,mBAAAA,CAAAA,EAAAA;;;;ACPjB,YAAYa,aAAY;AACxB,SAAuBC,qBAAqB;AAG5C,SAASC,cAAAA,mBAA0C;AACnD,SAASC,iBAAiB;AAiBnB,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;AAEA,IAAMC,iBAAiB,GAAGC,KAAKC,EAAE;UAEhBC,gBAAAA;iBACFC,QAAQC,UAAUC,KAAK;IAClCL,MAAM;MAAEM,KAAK,GAAGP,cAAAA;MAAwBQ,MAAM;IAAa;IAC3DC,UAAU;MAACC,YAAWC;;IACtBC,QAAQ;MAAEC,OAAcC;MAAMC,QAAeD;IAAK;EACpD,CAAA;AACF,GANiBX,kBAAAA,gBAAAA,CAAAA,EAAAA;;",
-  "names": ["Schema", "Capability", "HelpCapabilities", "StateSchema", "mutable", "Struct", "running", "Boolean", "showHints", "showWelcome", "State", "Capability", "make", "meta", "id", "Schema", "createContext", "Capability", "Operation", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_OPERATION", "meta", "id", "HelpOperation", "Start", "Operation", "make", "key", "name", "services", "Capability", "Service", "schema", "input", "Void", "output"]
-}