@dxos/plugin-help 0.8.4-main.4a85c3132b → 0.8.4-main.51f1e5ca51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/dist/lib/browser/chunk-53QC3FTJ.mjs +34 -0
  2. package/dist/lib/browser/chunk-53QC3FTJ.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  4. package/dist/lib/browser/chunk-J5LGTIGS.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-RWK34XL5.mjs +31 -0
  6. package/dist/lib/browser/chunk-RWK34XL5.mjs.map +7 -0
  7. package/dist/lib/browser/index.mjs +331 -69
  8. package/dist/lib/browser/index.mjs.map +4 -4
  9. package/dist/lib/browser/meta.json +1 -1
  10. package/dist/lib/browser/meta.mjs +13 -3
  11. package/dist/lib/browser/meta.mjs.map +4 -4
  12. package/dist/lib/browser/operations/index.mjs +13 -0
  13. package/dist/lib/browser/operations/index.mjs.map +7 -0
  14. package/dist/lib/browser/start-JQ2LLVCT.mjs +23 -0
  15. package/dist/lib/browser/start-JQ2LLVCT.mjs.map +7 -0
  16. package/dist/lib/browser/translations.mjs +20 -0
  17. package/dist/lib/browser/translations.mjs.map +7 -0
  18. package/dist/lib/browser/types/index.mjs +4 -6
  19. package/dist/types/src/HelpPlugin.d.ts +1 -1
  20. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  21. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -0
  22. package/dist/types/src/capabilities/index.d.ts +18 -5
  23. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  24. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  25. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  26. package/dist/types/src/capabilities/{react-root/react-root.d.ts → react-root.d.ts} +1 -1
  27. package/dist/types/src/capabilities/react-root.d.ts.map +1 -0
  28. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -0
  29. package/dist/types/src/capabilities/state.d.ts.map +1 -0
  30. package/dist/types/src/components/Shortcuts/Key.d.ts.map +1 -1
  31. package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
  32. package/dist/types/src/components/Tooltip/Tooltip.d.ts +9 -9
  33. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts +1 -1
  34. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  35. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
  36. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts.map +1 -1
  37. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +25 -0
  38. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -0
  39. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts +1 -2
  40. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts.map +1 -1
  41. package/dist/types/src/containers/ShortcutsHints/index.d.ts +1 -2
  42. package/dist/types/src/containers/ShortcutsHints/index.d.ts.map +1 -1
  43. package/dist/types/src/containers/ShortcutsList/index.d.ts +1 -2
  44. package/dist/types/src/containers/ShortcutsList/index.d.ts.map +1 -1
  45. package/dist/types/src/hooks/useHelp.d.ts +1 -1
  46. package/dist/types/src/hooks/useHelp.d.ts.map +1 -1
  47. package/dist/types/src/index.d.ts +0 -2
  48. package/dist/types/src/index.d.ts.map +1 -1
  49. package/dist/types/src/operations/definitions.d.ts +4 -0
  50. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  51. package/dist/types/src/operations/index.d.ts +4 -0
  52. package/dist/types/src/operations/index.d.ts.map +1 -0
  53. package/dist/types/src/operations/start.d.ts +5 -0
  54. package/dist/types/src/operations/start.d.ts.map +1 -0
  55. package/dist/types/src/translations.d.ts +5 -6
  56. package/dist/types/src/translations.d.ts.map +1 -1
  57. package/dist/types/src/types/capabilities.d.ts.map +1 -1
  58. package/dist/types/src/types/schema.d.ts +1 -17
  59. package/dist/types/src/types/schema.d.ts.map +1 -1
  60. package/dist/types/tsconfig.tsbuildinfo +1 -1
  61. package/package.json +45 -34
  62. package/src/HelpPlugin.tsx +5 -5
  63. package/src/capabilities/{app-graph-builder/app-graph-builder.ts → app-graph-builder.ts} +15 -13
  64. package/src/capabilities/index.ts +11 -5
  65. package/src/capabilities/operation-handler.ts +16 -0
  66. package/src/capabilities/{react-root/react-root.tsx → react-root.tsx} +3 -3
  67. package/src/capabilities/{react-surface/react-surface.tsx → react-surface.tsx} +7 -7
  68. package/src/capabilities/{state/state.ts → state.ts} +2 -2
  69. package/src/components/Shortcuts/ShortcutsList.tsx +1 -1
  70. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +8 -8
  71. package/src/components/WelcomeTour/WelcomeTour.tsx +3 -1
  72. package/src/constants.ts +2 -2
  73. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +39 -0
  74. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +9 -10
  75. package/src/containers/ShortcutsDialogContent/index.ts +1 -3
  76. package/src/containers/ShortcutsHints/index.ts +1 -3
  77. package/src/containers/ShortcutsList/index.ts +1 -3
  78. package/src/hooks/useHelp.tsx +1 -1
  79. package/src/index.ts +0 -2
  80. package/src/meta.ts +1 -1
  81. package/src/operations/definitions.ts +19 -0
  82. package/src/operations/index.ts +9 -0
  83. package/src/operations/start.ts +21 -0
  84. package/src/translations.ts +5 -5
  85. package/src/types/capabilities.ts +2 -2
  86. package/src/types/schema.ts +1 -15
  87. package/dist/lib/browser/ShortcutsDialogContent-BETHLZYK.mjs +0 -36
  88. package/dist/lib/browser/ShortcutsDialogContent-BETHLZYK.mjs.map +0 -7
  89. package/dist/lib/browser/ShortcutsHints-Q4LKOCKH.mjs +0 -12
  90. package/dist/lib/browser/ShortcutsHints-Q4LKOCKH.mjs.map +0 -7
  91. package/dist/lib/browser/ShortcutsList-P334CJ7O.mjs +0 -12
  92. package/dist/lib/browser/ShortcutsList-P334CJ7O.mjs.map +0 -7
  93. package/dist/lib/browser/app-graph-builder-2O2CUPGU.mjs +0 -79
  94. package/dist/lib/browser/app-graph-builder-2O2CUPGU.mjs.map +0 -7
  95. package/dist/lib/browser/chunk-IM2QVQOH.mjs +0 -16
  96. package/dist/lib/browser/chunk-IM2QVQOH.mjs.map +0 -7
  97. package/dist/lib/browser/chunk-PNXUNKZW.mjs +0 -335
  98. package/dist/lib/browser/chunk-PNXUNKZW.mjs.map +0 -7
  99. package/dist/lib/browser/chunk-TS66J4C6.mjs +0 -58
  100. package/dist/lib/browser/chunk-TS66J4C6.mjs.map +0 -7
  101. package/dist/lib/browser/chunk-XAC3AYP4.mjs +0 -11
  102. package/dist/lib/browser/chunk-XAC3AYP4.mjs.map +0 -7
  103. package/dist/lib/browser/react-root-GK7XGIBN.mjs +0 -43
  104. package/dist/lib/browser/react-root-GK7XGIBN.mjs.map +0 -7
  105. package/dist/lib/browser/react-surface-KGND4ZJD.mjs +0 -42
  106. package/dist/lib/browser/react-surface-KGND4ZJD.mjs.map +0 -7
  107. package/dist/lib/browser/state-VRPLKT3F.mjs +0 -27
  108. package/dist/lib/browser/state-VRPLKT3F.mjs.map +0 -7
  109. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +0 -1
  110. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +0 -3
  111. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +0 -1
  112. package/dist/types/src/capabilities/operation-resolver/index.d.ts +0 -2
  113. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +0 -1
  114. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +0 -5
  115. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +0 -1
  116. package/dist/types/src/capabilities/react-root/index.d.ts +0 -6
  117. package/dist/types/src/capabilities/react-root/index.d.ts.map +0 -1
  118. package/dist/types/src/capabilities/react-root/react-root.d.ts.map +0 -1
  119. package/dist/types/src/capabilities/react-surface/index.d.ts +0 -3
  120. package/dist/types/src/capabilities/react-surface/index.d.ts.map +0 -1
  121. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +0 -1
  122. package/dist/types/src/capabilities/state/index.d.ts +0 -11
  123. package/dist/types/src/capabilities/state/index.d.ts.map +0 -1
  124. package/dist/types/src/capabilities/state/state.d.ts.map +0 -1
  125. package/src/capabilities/app-graph-builder/index.ts +0 -7
  126. package/src/capabilities/operation-resolver/index.ts +0 -5
  127. package/src/capabilities/operation-resolver/operation-resolver.ts +0 -23
  128. package/src/capabilities/react-root/index.ts +0 -7
  129. package/src/capabilities/react-surface/index.ts +0 -7
  130. package/src/capabilities/state/index.ts +0 -7
  131. /package/dist/types/src/capabilities/{app-graph-builder/app-graph-builder.d.ts → app-graph-builder.d.ts} +0 -0
  132. /package/dist/types/src/capabilities/{react-surface/react-surface.d.ts → react-surface.d.ts} +0 -0
  133. /package/dist/types/src/capabilities/{state/state.d.ts → state.d.ts} +0 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/plugin-help",
3
- "version": "0.8.4-main.4a85c3132b",
3
+ "version": "0.8.4-main.51f1e5ca51",
4
4
  "description": "Help plugin.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -12,6 +12,16 @@
12
12
  "author": "DXOS.org",
13
13
  "sideEffects": true,
14
14
  "type": "module",
15
+ "imports": {
16
+ "#capabilities": "./src/capabilities/index.ts",
17
+ "#components": "./src/components/index.ts",
18
+ "#containers": "./src/containers/index.ts",
19
+ "#hooks": "./src/hooks/index.ts",
20
+ "#meta": "./src/meta.ts",
21
+ "#operations": "./src/operations/index.ts",
22
+ "#translations": "./src/translations.ts",
23
+ "#types": "./src/types/index.ts"
24
+ },
15
25
  "exports": {
16
26
  ".": {
17
27
  "source": "./src/index.ts",
@@ -23,6 +33,17 @@
23
33
  "types": "./dist/types/src/meta.d.ts",
24
34
  "browser": "./dist/lib/browser/meta.mjs"
25
35
  },
36
+ "./operations": {
37
+ "source": "./src/operations/index.ts",
38
+ "types": "./dist/types/src/operations/index.d.ts",
39
+ "browser": "./dist/lib/browser/operations/index.mjs"
40
+ },
41
+ "./translations": {
42
+ "source": "./src/translations.ts",
43
+ "types": "./dist/types/src/translations.d.ts",
44
+ "browser": "./dist/lib/browser/translations.mjs",
45
+ "node": "./dist/lib/node-esm/translations.mjs"
46
+ },
26
47
  "./types": {
27
48
  "source": "./src/types/index.ts",
28
49
  "types": "./dist/types/src/types/index.d.ts",
@@ -30,16 +51,6 @@
30
51
  }
31
52
  },
32
53
  "types": "dist/types/src/index.d.ts",
33
- "typesVersions": {
34
- "*": {
35
- "meta": [
36
- "dist/types/src/meta.d.ts"
37
- ],
38
- "types": [
39
- "dist/types/src/types/index.d.ts"
40
- ]
41
- }
42
- },
43
54
  "files": [
44
55
  "dist",
45
56
  "src"
@@ -48,45 +59,45 @@
48
59
  "@effect-atom/atom": "^0.5.1",
49
60
  "@fluentui/react-tabster": "9.26.11",
50
61
  "react-joyride": "^2.7.2",
51
- "@dxos/app-framework": "0.8.4-main.4a85c3132b",
52
- "@dxos/app-toolkit": "0.8.4-main.4a85c3132b",
53
- "@dxos/effect": "0.8.4-main.4a85c3132b",
54
- "@dxos/debug": "0.8.4-main.4a85c3132b",
55
- "@dxos/app-graph": "0.8.4-main.4a85c3132b",
56
- "@dxos/echo": "0.8.4-main.4a85c3132b",
57
- "@dxos/keyboard": "0.8.4-main.4a85c3132b",
58
- "@dxos/operation": "0.8.4-main.4a85c3132b",
59
- "@dxos/plugin-client": "0.8.4-main.4a85c3132b",
60
- "@dxos/plugin-graph": "0.8.4-main.4a85c3132b",
61
- "@dxos/plugin-space": "0.8.4-main.4a85c3132b",
62
- "@dxos/react-client": "0.8.4-main.4a85c3132b",
63
- "@dxos/util": "0.8.4-main.4a85c3132b"
62
+ "@dxos/app-framework": "0.8.4-main.51f1e5ca51",
63
+ "@dxos/compute": "0.8.4-main.51f1e5ca51",
64
+ "@dxos/app-toolkit": "0.8.4-main.51f1e5ca51",
65
+ "@dxos/echo": "0.8.4-main.51f1e5ca51",
66
+ "@dxos/debug": "0.8.4-main.51f1e5ca51",
67
+ "@dxos/effect": "0.8.4-main.51f1e5ca51",
68
+ "@dxos/plugin-client": "0.8.4-main.51f1e5ca51",
69
+ "@dxos/keyboard": "0.8.4-main.51f1e5ca51",
70
+ "@dxos/app-graph": "0.8.4-main.51f1e5ca51",
71
+ "@dxos/react-client": "0.8.4-main.51f1e5ca51",
72
+ "@dxos/plugin-space": "0.8.4-main.51f1e5ca51",
73
+ "@dxos/util": "0.8.4-main.51f1e5ca51",
74
+ "@dxos/plugin-graph": "0.8.4-main.51f1e5ca51"
64
75
  },
65
76
  "devDependencies": {
66
77
  "@effect-atom/atom-react": "^0.5.0",
67
78
  "@effect/platform": "0.94.4",
68
79
  "@types/react": "~19.2.7",
69
80
  "@types/react-dom": "~19.2.3",
70
- "effect": "3.19.16",
81
+ "effect": "3.20.0",
71
82
  "react": "~19.2.3",
72
83
  "react-dom": "~19.2.3",
73
84
  "react-floater": "0.7.9",
74
85
  "type-fest": "4.10.1",
75
- "vite": "^7.1.11",
76
- "@dxos/plugin-testing": "0.8.4-main.4a85c3132b",
77
- "@dxos/storybook-utils": "0.8.4-main.4a85c3132b",
78
- "@dxos/react-ui": "0.8.4-main.4a85c3132b",
79
- "@dxos/ui-theme": "0.8.4-main.4a85c3132b",
80
- "@dxos/random": "0.8.4-main.4a85c3132b"
86
+ "vite": "^8.0.10",
87
+ "@dxos/plugin-testing": "0.8.4-main.51f1e5ca51",
88
+ "@dxos/random": "0.8.4-main.51f1e5ca51",
89
+ "@dxos/react-ui": "0.8.4-main.51f1e5ca51",
90
+ "@dxos/storybook-utils": "0.8.4-main.51f1e5ca51",
91
+ "@dxos/ui-theme": "0.8.4-main.51f1e5ca51"
81
92
  },
82
93
  "peerDependencies": {
83
94
  "@effect-atom/atom-react": "^0.5.0",
84
95
  "@effect/platform": "0.94.4",
85
- "effect": "3.19.16",
96
+ "effect": "3.20.0",
86
97
  "react": "~19.2.3",
87
98
  "react-dom": "~19.2.3",
88
- "@dxos/react-ui": "0.8.4-main.4a85c3132b",
89
- "@dxos/ui-theme": "0.8.4-main.4a85c3132b"
99
+ "@dxos/react-ui": "0.8.4-main.51f1e5ca51",
100
+ "@dxos/ui-theme": "0.8.4-main.51f1e5ca51"
90
101
  },
91
102
  "publishConfig": {
92
103
  "access": "public"
@@ -5,16 +5,16 @@
5
5
  import { ActivationEvents, Plugin } from '@dxos/app-framework';
6
6
  import { AppPlugin } from '@dxos/app-toolkit';
7
7
 
8
- import { AppGraphBuilder, HelpState, OperationResolver, ReactRoot, ReactSurface } from './capabilities';
9
- import { meta } from './meta';
10
- import { translations } from './translations';
11
- import { type Step } from './types';
8
+ import { AppGraphBuilder, HelpState, OperationHandler, ReactRoot, ReactSurface } from '#capabilities';
9
+ import { meta } from '#meta';
10
+ import { translations } from '#translations';
11
+ import { type Step } from '#types';
12
12
 
13
13
  export type HelpPluginOptions = { steps?: Step[] };
14
14
 
15
15
  export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
16
16
  AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
17
- AppPlugin.addOperationResolverModule({ activate: OperationResolver }),
17
+ AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
18
18
  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
19
19
  AppPlugin.addTranslationsModule({ translations }),
20
20
  Plugin.addModule({
@@ -5,29 +5,31 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities, Capability } from '@dxos/app-framework';
8
- import { GraphBuilder, NodeMatcher } from '@dxos/app-graph';
8
+ import { GraphBuilder, Node, NodeMatcher } from '@dxos/app-graph';
9
9
  import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
10
- import { Operation } from '@dxos/operation';
10
+ import { Operation } from '@dxos/compute';
11
11
 
12
- import { SHORTCUTS_DIALOG } from '../../constants';
13
- import { meta } from '../../meta';
14
- import { HelpCapabilities, HelpOperation } from '../../types';
12
+ import { meta } from '#meta';
13
+ import { HelpOperation } from '#operations';
14
+ import { HelpCapabilities } from '#types';
15
+
16
+ import { SHORTCUTS_DIALOG } from '../constants';
15
17
 
16
18
  export default Capability.makeModule(
17
19
  Effect.fnUntraced(function* () {
18
20
  const extensions = yield* GraphBuilder.createExtension({
19
- id: meta.id,
21
+ id: 'root',
20
22
  match: NodeMatcher.whenRoot,
21
23
  actions: () =>
22
24
  Effect.succeed([
23
- {
25
+ Node.makeAction({
24
26
  id: HelpOperation.Start.meta.key,
25
27
  data: Effect.fnUntraced(function* () {
26
28
  yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
27
29
  yield* Operation.invoke(HelpOperation.Start);
28
30
  }),
29
31
  properties: {
30
- label: ['open help tour', { ns: meta.id }],
32
+ label: ['open-help-tour.message', { ns: meta.id }],
31
33
  icon: 'ph--info--regular',
32
34
  keyBinding: {
33
35
  macos: 'shift+meta+/',
@@ -36,9 +38,9 @@ export default Capability.makeModule(
36
38
  },
37
39
  testId: 'helpPlugin.openHelp',
38
40
  },
39
- },
40
- {
41
- id: `${meta.id}/open-shortcuts`,
41
+ }),
42
+ Node.makeAction({
43
+ id: 'open-shortcuts',
42
44
  data: Effect.fnUntraced(function* () {
43
45
  yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
44
46
  yield* Operation.invoke(LayoutOperation.UpdateDialog, {
@@ -46,13 +48,13 @@ export default Capability.makeModule(
46
48
  });
47
49
  }),
48
50
  properties: {
49
- label: ['open shortcuts label', { ns: meta.id }],
51
+ label: ['open-shortcuts.label', { ns: meta.id }],
50
52
  icon: 'ph--keyboard--regular',
51
53
  keyBinding: {
52
54
  macos: 'meta+ctrl+/',
53
55
  },
54
56
  },
55
- },
57
+ }),
56
58
  ]),
57
59
  });
58
60
 
@@ -2,8 +2,14 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- export * from './app-graph-builder';
6
- export * from './operation-resolver';
7
- export * from './react-root';
8
- export * from './react-surface';
9
- export * from './state';
5
+ import { Capability } from '@dxos/app-framework';
6
+ import { OperationHandlerSet } from '@dxos/compute';
7
+
8
+ export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
9
+ export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
10
+ 'OperationHandler',
11
+ () => import('./operation-handler'),
12
+ );
13
+ export const ReactRoot = Capability.lazy('ReactRoot', () => import('./react-root'));
14
+ export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));
15
+ export const HelpState = Capability.lazy('HelpState', () => import('./state'));
@@ -0,0 +1,16 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capabilities, Capability } from '@dxos/app-framework';
8
+ import type { OperationHandlerSet } from '@dxos/compute';
9
+
10
+ import { HelpOperationHandlerSet } from '#operations';
11
+
12
+ export default Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
13
+ Effect.fnUntraced(function* () {
14
+ return Capability.contributes(Capabilities.OperationHandler, HelpOperationHandlerSet);
15
+ }),
16
+ );
@@ -8,9 +8,9 @@ import React from 'react';
8
8
  import { Capabilities, Capability } from '@dxos/app-framework';
9
9
  import { useAtomCapabilityState } from '@dxos/app-framework/ui';
10
10
 
11
- import { WelcomeTour } from '../../components';
12
- import { meta } from '../../meta';
13
- import { HelpCapabilities, type Step } from '../../types';
11
+ import { WelcomeTour } from '#components';
12
+ import { meta } from '#meta';
13
+ import { HelpCapabilities, type Step } from '#types';
14
14
 
15
15
  export default Capability.makeModule(
16
16
  Effect.fnUntraced(function* (steps?: Step[]) {
@@ -7,28 +7,28 @@ import React from 'react';
7
7
 
8
8
  import { Capabilities, Capability } from '@dxos/app-framework';
9
9
  import { Surface } from '@dxos/app-framework/ui';
10
+ import { AppSurface } from '@dxos/app-toolkit/ui';
10
11
 
11
- import { SHORTCUTS_DIALOG } from '../../constants';
12
- import { ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../../containers';
13
- import { meta } from '../../meta';
12
+ import { ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '#containers';
13
+
14
+ import { SHORTCUTS_DIALOG } from '../constants';
14
15
 
15
16
  export default Capability.makeModule(() =>
16
17
  Effect.succeed(
17
18
  Capability.contributes(Capabilities.ReactSurface, [
18
19
  Surface.create({
19
- id: `${meta.id}/hints`,
20
+ id: 'hints',
20
21
  role: 'hints',
21
22
  component: () => <ShortcutsHints />,
22
23
  }),
23
24
  Surface.create({
24
- id: `${meta.id}/keyshortcuts`,
25
+ id: 'keyshortcuts',
25
26
  role: 'keyshortcuts',
26
27
  component: () => <ShortcutsList />,
27
28
  }),
28
29
  Surface.create({
29
30
  id: SHORTCUTS_DIALOG,
30
- role: 'dialog',
31
- filter: (data): data is { component: string } => data.component === SHORTCUTS_DIALOG,
31
+ filter: AppSurface.component(AppSurface.Dialog, SHORTCUTS_DIALOG),
32
32
  component: () => <ShortcutsDialogContent />,
33
33
  }),
34
34
  ]),
@@ -7,8 +7,8 @@ import * as Effect from 'effect/Effect';
7
7
  import { Capability } from '@dxos/app-framework';
8
8
  import { createKvsStore } from '@dxos/effect';
9
9
 
10
- import { meta } from '../../meta';
11
- import { HelpCapabilities } from '../../types';
10
+ import { meta } from '#meta';
11
+ import { HelpCapabilities } from '#types';
12
12
 
13
13
  export default Capability.makeModule(() =>
14
14
  Effect.sync(() => {
@@ -8,7 +8,7 @@ import { Keyboard } from '@dxos/keyboard';
8
8
  import { toLocalizedString, useTranslation } from '@dxos/react-ui';
9
9
  import { mx } from '@dxos/ui-theme';
10
10
 
11
- import { meta } from '../../meta';
11
+ import { meta } from '#meta';
12
12
 
13
13
  import { Key } from './Key';
14
14
 
@@ -7,19 +7,19 @@ import React, { useState } from 'react';
7
7
 
8
8
  import { withPluginManager } from '@dxos/app-framework/testing';
9
9
  import { StorybookPlugin } from '@dxos/plugin-testing';
10
- import { faker } from '@dxos/random';
10
+ import { random } from '@dxos/random';
11
11
  import { Button, Icon } from '@dxos/react-ui';
12
12
  import { withTheme } from '@dxos/react-ui/testing';
13
13
 
14
- import { useHelp } from '../../hooks';
14
+ import { useHelp } from '#hooks';
15
15
 
16
16
  import { WelcomeTour, type WelcomeTourProps } from './WelcomeTour';
17
17
 
18
18
  const App = () => {
19
19
  const { running, start } = useHelp();
20
- const [items, setItems] = useState(() => Array.from({ length: 5 }).map(() => faker.lorem.sentence()));
20
+ const [items, setItems] = useState(() => Array.from({ length: 5 }).map(() => random.lorem.sentence()));
21
21
  const handleAdd = () => {
22
- setItems((items) => [...items, faker.lorem.sentence()]);
22
+ setItems((items) => [...items, random.lorem.sentence()]);
23
23
  };
24
24
 
25
25
  return (
@@ -76,25 +76,25 @@ export const Default: StoryObj<typeof WelcomeTour> = {
76
76
  {
77
77
  target: '[data-joyride="basic/1"]',
78
78
  title: 'plugins/Step 1',
79
- content: faker.lorem.paragraph(),
79
+ content: random.lorem.paragraph(),
80
80
  disableBeacon: true,
81
81
  placement: 'right',
82
82
  },
83
83
  {
84
84
  target: '[data-joyride="basic/2"]',
85
85
  title: 'plugins/Step 2',
86
- content: faker.lorem.paragraph(),
86
+ content: random.lorem.paragraph(),
87
87
  },
88
88
  {
89
89
  target: '[data-joyride="basic/3"]',
90
90
  title: 'plugins/Step 3',
91
- content: faker.lorem.paragraph(),
91
+ content: random.lorem.paragraph(),
92
92
  placement: 'right',
93
93
  },
94
94
  {
95
95
  target: '[data-joyride="basic/4"]',
96
96
  title: 'plugins/Step 4',
97
- content: faker.lorem.paragraph(),
97
+ content: random.lorem.paragraph(),
98
98
  placement: 'top-end',
99
99
  },
100
100
  ],
@@ -9,7 +9,8 @@ import { usePluginManager } from '@dxos/app-framework/ui';
9
9
  import { useLayout } from '@dxos/app-toolkit/ui';
10
10
  import { useAsyncEffect } from '@dxos/react-ui';
11
11
 
12
- import { HelpContext, type Step } from '../../types';
12
+ import { HelpContext, type Step } from '#types';
13
+
13
14
  import { Tooltip, floaterProps } from '../Tooltip';
14
15
 
15
16
  const addStepClass = (target: string | HTMLElement) => {
@@ -162,6 +163,7 @@ export const WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunni
162
163
  callback={callback}
163
164
  floaterProps={floaterProps}
164
165
  tooltipComponent={Tooltip}
166
+ spotlightPadding={0}
165
167
  />
166
168
  </HelpContext.Provider>
167
169
  );
package/src/constants.ts CHANGED
@@ -2,6 +2,6 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { meta } from './meta';
5
+ import { meta } from '#meta';
6
6
 
7
- export const SHORTCUTS_DIALOG = `${meta.id}/ShortcutsDialog`;
7
+ export const SHORTCUTS_DIALOG = `${meta.id}.ShortcutsDialog`;
@@ -0,0 +1,39 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
6
+ import React from 'react';
7
+
8
+ import { withPluginManager } from '@dxos/app-framework/testing';
9
+ import { Dialog } from '@dxos/react-ui';
10
+ import { withTheme } from '@dxos/react-ui/testing';
11
+
12
+ import { translations } from '#translations';
13
+
14
+ import { ShortcutsDialogContent } from './ShortcutsDialogContent';
15
+
16
+ const DefaultStory = () => (
17
+ <Dialog.Root defaultOpen>
18
+ <Dialog.Overlay>
19
+ <ShortcutsDialogContent />
20
+ </Dialog.Overlay>
21
+ </Dialog.Root>
22
+ );
23
+
24
+ const meta = {
25
+ title: 'plugins/plugin-help/containers/ShortcutsDialogContent',
26
+ component: ShortcutsDialogContent,
27
+ render: DefaultStory,
28
+ decorators: [withTheme(), withPluginManager()],
29
+ parameters: {
30
+ layout: 'fullscreen',
31
+ translations,
32
+ },
33
+ } satisfies Meta<typeof ShortcutsDialogContent>;
34
+
35
+ export default meta;
36
+
37
+ type Story = StoryObj<typeof meta>;
38
+
39
+ export const Default: Story = {};
@@ -4,26 +4,25 @@
4
4
 
5
5
  import React from 'react';
6
6
 
7
- import { Dialog, IconButton, useTranslation } from '@dxos/react-ui';
7
+ import { Dialog, useTranslation } from '@dxos/react-ui';
8
8
 
9
- import { ShortcutsList } from '../../components';
10
- import { meta } from '../../meta';
9
+ import { ShortcutsList } from '#components';
10
+ import { meta } from '#meta';
11
11
 
12
12
  export const ShortcutsDialogContent = () => {
13
13
  const { t } = useTranslation(meta.id);
14
14
 
15
15
  return (
16
16
  <Dialog.Content>
17
- <div role='none' className='flex justify-between mb-1 pt-3 ps-2 pe-3 @md:pt-4 @md:ps-4 @md:pe-5'>
18
- <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>
17
+ <Dialog.Header>
18
+ <Dialog.Title>{t('shortcuts-dialog.title')}</Dialog.Title>
19
19
  <Dialog.Close asChild>
20
- <IconButton icon='ph--x--bold' iconOnly size={3} label='Close' variant='ghost' autoFocus />
20
+ <Dialog.CloseIconButton />
21
21
  </Dialog.Close>
22
- </div>
23
-
24
- <div className='flex items-center justify-center'>
22
+ </Dialog.Header>
23
+ <Dialog.Body>
25
24
  <ShortcutsList />
26
- </div>
25
+ </Dialog.Body>
27
26
  </Dialog.Content>
28
27
  );
29
28
  };
@@ -2,6 +2,4 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { ShortcutsDialogContent } from './ShortcutsDialogContent';
6
-
7
- export default ShortcutsDialogContent;
5
+ export { ShortcutsDialogContent as default } from './ShortcutsDialogContent';
@@ -2,6 +2,4 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { ShortcutsHints } from './ShortcutsHints';
6
-
7
- export default ShortcutsHints;
5
+ export { ShortcutsHints as default } from './ShortcutsHints';
@@ -2,6 +2,4 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import { ShortcutsList } from './ShortcutsList';
6
-
7
- export default ShortcutsList;
5
+ export { ShortcutsList as default } from './ShortcutsList';
@@ -6,7 +6,7 @@ import { useContext } from 'react';
6
6
 
7
7
  import { raise } from '@dxos/debug';
8
8
 
9
- import { HelpContext } from '../types';
9
+ import { HelpContext } from '#types';
10
10
 
11
11
  export const useHelp = () => {
12
12
  return useContext(HelpContext) ?? raise(new Error('Missing HelpContext'));
package/src/index.ts CHANGED
@@ -5,7 +5,5 @@
5
5
  export { HelpCapabilities } from './types';
6
6
  export * from './components';
7
7
  export * from './constants';
8
- export * from './meta';
9
8
  export * from './HelpPlugin';
10
9
  export * from './hooks';
11
- export * from './types';
package/src/meta.ts CHANGED
@@ -6,7 +6,7 @@ import { type Plugin } from '@dxos/app-framework';
6
6
  import { trim } from '@dxos/util';
7
7
 
8
8
  export const meta: Plugin.Meta = {
9
- id: 'dxos.org/plugin/help',
9
+ id: 'org.dxos.plugin.help',
10
10
  name: 'Help',
11
11
  description: trim`
12
12
  Built-in help system with documentation, tutorials, and contextual assistance.
@@ -0,0 +1,19 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/compute';
9
+
10
+ import { meta } from '#meta';
11
+
12
+ const HELP_OPERATION = `${meta.id}.operation`;
13
+
14
+ export const Start = Operation.make({
15
+ meta: { key: `${HELP_OPERATION}.start`, name: 'Start Help' },
16
+ services: [Capability.Service],
17
+ input: Schema.Void,
18
+ output: Schema.Void,
19
+ });
@@ -0,0 +1,9 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { OperationHandlerSet } from '@dxos/compute';
6
+
7
+ export * as HelpOperation from './definitions';
8
+
9
+ export const HelpOperationHandlerSet = OperationHandlerSet.lazy(() => import('./start'));
@@ -0,0 +1,21 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capabilities } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/compute';
9
+
10
+ import { HelpCapabilities } from '../types';
11
+ import { Start } from './definitions';
12
+
13
+ const handler: Operation.WithHandler<typeof Start> = Start.pipe(
14
+ Operation.withHandler(
15
+ Effect.fnUntraced(function* () {
16
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
17
+ }),
18
+ ),
19
+ );
20
+
21
+ export default handler;
@@ -4,16 +4,16 @@
4
4
 
5
5
  import { type Resource } from '@dxos/react-ui';
6
6
 
7
- import { meta } from './meta';
7
+ import { meta } from '#meta';
8
8
 
9
9
  export const translations = [
10
10
  {
11
11
  'en-US': {
12
12
  [meta.id]: {
13
- 'plugin name': 'Help',
14
- 'open help tour': 'Show welcome tour',
15
- 'open shortcuts label': 'Show shortcuts',
16
- 'shortcuts dialog title': 'Shortcuts',
13
+ 'plugin.name': 'Help',
14
+ 'open-help-tour.message': 'Show welcome tour',
15
+ 'open-shortcuts.label': 'Show shortcuts',
16
+ 'shortcuts-dialog.title': 'Shortcuts',
17
17
  },
18
18
  },
19
19
  },
@@ -7,7 +7,7 @@ import * as Schema from 'effect/Schema';
7
7
 
8
8
  import { Capability } from '@dxos/app-framework';
9
9
 
10
- import { meta } from '../meta';
10
+ import { meta } from '#meta';
11
11
 
12
12
  export namespace HelpCapabilities {
13
13
  export const StateSchema = Schema.mutable(
@@ -20,5 +20,5 @@ export namespace HelpCapabilities {
20
20
 
21
21
  export type State = Schema.Schema.Type<typeof StateSchema>;
22
22
 
23
- export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
23
+ export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);
24
24
  }