@dxos/plugin-help 0.8.4-main.1068cf700f → 0.8.4-main.1c7ec43d41

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 (152) 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-IM2QVQOH.mjs → chunk-NHTI7NEQ.mjs} +6 -3
  6. package/dist/lib/browser/{chunk-IM2QVQOH.mjs.map → chunk-NHTI7NEQ.mjs.map} +3 -3
  7. package/dist/lib/browser/chunk-RWK34XL5.mjs +31 -0
  8. package/dist/lib/browser/chunk-RWK34XL5.mjs.map +7 -0
  9. package/dist/lib/browser/index.mjs +13 -101
  10. package/dist/lib/browser/index.mjs.map +4 -4
  11. package/dist/lib/browser/meta.json +1 -1
  12. package/dist/lib/browser/meta.mjs +2 -1
  13. package/dist/lib/browser/operations/index.mjs +13 -0
  14. package/dist/lib/browser/operations/index.mjs.map +7 -0
  15. package/dist/lib/browser/start-JQ2LLVCT.mjs +23 -0
  16. package/dist/lib/browser/start-JQ2LLVCT.mjs.map +7 -0
  17. package/dist/lib/browser/translations.mjs +20 -0
  18. package/dist/lib/browser/translations.mjs.map +7 -0
  19. package/dist/lib/browser/types/index.mjs +4 -6
  20. package/dist/types/src/HelpPlugin.d.ts +2 -1
  21. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  22. package/dist/types/src/HelpPlugin.test.d.ts +2 -0
  23. package/dist/types/src/HelpPlugin.test.d.ts.map +1 -0
  24. package/dist/types/src/capabilities/app-graph-builder.d.ts +6 -0
  25. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -0
  26. package/dist/types/src/capabilities/index.d.ts +18 -5
  27. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  28. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  29. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  30. package/dist/types/src/capabilities/{react-root/react-root.d.ts → react-root.d.ts} +2 -2
  31. package/dist/types/src/capabilities/react-root.d.ts.map +1 -0
  32. package/dist/types/src/capabilities/react-surface.d.ts +5 -0
  33. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -0
  34. package/dist/types/src/capabilities/{state/state.d.ts → state.d.ts} +1 -1
  35. package/dist/types/src/capabilities/state.d.ts.map +1 -0
  36. package/dist/types/src/components/Shortcuts/Key.d.ts.map +1 -1
  37. package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
  38. package/dist/types/src/components/Shortcuts/ShortcutsSection.d.ts.map +1 -1
  39. package/dist/types/src/components/Shortcuts/index.d.ts +0 -1
  40. package/dist/types/src/components/Shortcuts/index.d.ts.map +1 -1
  41. package/dist/types/src/components/Tooltip/Tooltip.d.ts +9 -9
  42. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts +1 -1
  43. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  44. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
  45. package/dist/types/src/constants.d.ts +2 -0
  46. package/dist/types/src/constants.d.ts.map +1 -0
  47. package/dist/types/src/{components/Shortcuts/ShortcutsDialog.d.ts → containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts} +1 -2
  48. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts.map +1 -0
  49. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +25 -0
  50. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -0
  51. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts +2 -0
  52. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts.map +1 -0
  53. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts +2 -0
  54. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts.map +1 -0
  55. package/dist/types/src/containers/ShortcutsHints/index.d.ts +2 -0
  56. package/dist/types/src/containers/ShortcutsHints/index.d.ts.map +1 -0
  57. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts +2 -0
  58. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts.map +1 -0
  59. package/dist/types/src/containers/ShortcutsList/index.d.ts +2 -0
  60. package/dist/types/src/containers/ShortcutsList/index.d.ts.map +1 -0
  61. package/dist/types/src/containers/index.d.ts +5 -0
  62. package/dist/types/src/containers/index.d.ts.map +1 -0
  63. package/dist/types/src/hooks/useHelp.d.ts +1 -1
  64. package/dist/types/src/hooks/useHelp.d.ts.map +1 -1
  65. package/dist/types/src/index.d.ts +4 -3
  66. package/dist/types/src/index.d.ts.map +1 -1
  67. package/dist/types/src/meta.d.ts.map +1 -1
  68. package/dist/types/src/operations/definitions.d.ts +4 -0
  69. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  70. package/dist/types/src/operations/index.d.ts +4 -0
  71. package/dist/types/src/operations/index.d.ts.map +1 -0
  72. package/dist/types/src/operations/start.d.ts +5 -0
  73. package/dist/types/src/operations/start.d.ts.map +1 -0
  74. package/dist/types/src/translations.d.ts +5 -6
  75. package/dist/types/src/translations.d.ts.map +1 -1
  76. package/dist/types/src/types/capabilities.d.ts.map +1 -1
  77. package/dist/types/src/types/schema.d.ts +1 -17
  78. package/dist/types/src/types/schema.d.ts.map +1 -1
  79. package/dist/types/tsconfig.tsbuildinfo +1 -1
  80. package/package.json +46 -34
  81. package/src/HelpPlugin.test.ts +30 -0
  82. package/src/HelpPlugin.tsx +7 -5
  83. package/src/capabilities/{app-graph-builder/app-graph-builder.ts → app-graph-builder.ts} +15 -14
  84. package/src/capabilities/index.ts +11 -5
  85. package/src/capabilities/operation-handler.ts +16 -0
  86. package/src/capabilities/{react-root/react-root.tsx → react-root.tsx} +3 -3
  87. package/src/capabilities/{react-surface/react-surface.tsx → react-surface.tsx} +7 -6
  88. package/src/capabilities/{state/state.ts → state.ts} +2 -2
  89. package/src/components/Shortcuts/ShortcutsHints.tsx +1 -1
  90. package/src/components/Shortcuts/ShortcutsList.tsx +3 -3
  91. package/src/components/Shortcuts/ShortcutsSection.tsx +1 -3
  92. package/src/components/Shortcuts/index.ts +0 -1
  93. package/src/components/Shortcuts/styles.ts +2 -2
  94. package/src/components/Tooltip/Tooltip.tsx +4 -4
  95. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +13 -13
  96. package/src/components/WelcomeTour/WelcomeTour.tsx +3 -1
  97. package/src/constants.ts +7 -0
  98. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +39 -0
  99. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +28 -0
  100. package/src/containers/ShortcutsDialogContent/index.ts +5 -0
  101. package/src/containers/ShortcutsHints/ShortcutsHints.tsx +5 -0
  102. package/src/containers/ShortcutsHints/index.ts +5 -0
  103. package/src/containers/ShortcutsList/ShortcutsList.tsx +5 -0
  104. package/src/containers/ShortcutsList/index.ts +5 -0
  105. package/src/containers/index.ts +9 -0
  106. package/src/hooks/useHelp.tsx +1 -1
  107. package/src/index.ts +8 -3
  108. package/src/meta.ts +2 -1
  109. package/src/operations/definitions.ts +19 -0
  110. package/src/operations/index.ts +9 -0
  111. package/src/operations/start.ts +21 -0
  112. package/src/translations.ts +5 -5
  113. package/src/types/capabilities.ts +2 -2
  114. package/src/types/schema.ts +1 -15
  115. package/dist/lib/browser/app-graph-builder-QSESB5XF.mjs +0 -80
  116. package/dist/lib/browser/app-graph-builder-QSESB5XF.mjs.map +0 -7
  117. package/dist/lib/browser/chunk-M5LBB7IY.mjs +0 -361
  118. package/dist/lib/browser/chunk-M5LBB7IY.mjs.map +0 -7
  119. package/dist/lib/browser/chunk-TS66J4C6.mjs +0 -58
  120. package/dist/lib/browser/chunk-TS66J4C6.mjs.map +0 -7
  121. package/dist/lib/browser/react-root-DTKS5AAE.mjs +0 -43
  122. package/dist/lib/browser/react-root-DTKS5AAE.mjs.map +0 -7
  123. package/dist/lib/browser/react-surface-2BPMM4KB.mjs +0 -38
  124. package/dist/lib/browser/react-surface-2BPMM4KB.mjs.map +0 -7
  125. package/dist/lib/browser/state-VRPLKT3F.mjs +0 -27
  126. package/dist/lib/browser/state-VRPLKT3F.mjs.map +0 -7
  127. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts +0 -6
  128. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +0 -1
  129. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +0 -3
  130. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +0 -1
  131. package/dist/types/src/capabilities/operation-resolver/index.d.ts +0 -2
  132. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +0 -1
  133. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +0 -5
  134. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +0 -1
  135. package/dist/types/src/capabilities/react-root/index.d.ts +0 -6
  136. package/dist/types/src/capabilities/react-root/index.d.ts.map +0 -1
  137. package/dist/types/src/capabilities/react-root/react-root.d.ts.map +0 -1
  138. package/dist/types/src/capabilities/react-surface/index.d.ts +0 -3
  139. package/dist/types/src/capabilities/react-surface/index.d.ts.map +0 -1
  140. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +0 -5
  141. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +0 -1
  142. package/dist/types/src/capabilities/state/index.d.ts +0 -11
  143. package/dist/types/src/capabilities/state/index.d.ts.map +0 -1
  144. package/dist/types/src/capabilities/state/state.d.ts.map +0 -1
  145. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +0 -1
  146. package/src/capabilities/app-graph-builder/index.ts +0 -7
  147. package/src/capabilities/operation-resolver/index.ts +0 -5
  148. package/src/capabilities/operation-resolver/operation-resolver.ts +0 -23
  149. package/src/capabilities/react-root/index.ts +0 -7
  150. package/src/capabilities/react-surface/index.ts +0 -7
  151. package/src/capabilities/state/index.ts +0 -7
  152. package/src/components/Shortcuts/ShortcutsDialog.tsx +0 -32
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/plugin-help",
3
- "version": "0.8.4-main.1068cf700f",
3
+ "version": "0.8.4-main.1c7ec43d41",
4
4
  "description": "Help plugin.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -12,6 +12,17 @@
12
12
  "author": "DXOS.org",
13
13
  "sideEffects": true,
14
14
  "type": "module",
15
+ "imports": {
16
+ "#plugin": "./src/HelpPlugin.tsx",
17
+ "#capabilities": "./src/capabilities/index.ts",
18
+ "#components": "./src/components/index.ts",
19
+ "#containers": "./src/containers/index.ts",
20
+ "#hooks": "./src/hooks/index.ts",
21
+ "#meta": "./src/meta.ts",
22
+ "#operations": "./src/operations/index.ts",
23
+ "#translations": "./src/translations.ts",
24
+ "#types": "./src/types/index.ts"
25
+ },
15
26
  "exports": {
16
27
  ".": {
17
28
  "source": "./src/index.ts",
@@ -23,6 +34,17 @@
23
34
  "types": "./dist/types/src/meta.d.ts",
24
35
  "browser": "./dist/lib/browser/meta.mjs"
25
36
  },
37
+ "./operations": {
38
+ "source": "./src/operations/index.ts",
39
+ "types": "./dist/types/src/operations/index.d.ts",
40
+ "browser": "./dist/lib/browser/operations/index.mjs"
41
+ },
42
+ "./translations": {
43
+ "source": "./src/translations.ts",
44
+ "types": "./dist/types/src/translations.d.ts",
45
+ "browser": "./dist/lib/browser/translations.mjs",
46
+ "node": "./dist/lib/node-esm/translations.mjs"
47
+ },
26
48
  "./types": {
27
49
  "source": "./src/types/index.ts",
28
50
  "types": "./dist/types/src/types/index.d.ts",
@@ -30,16 +52,6 @@
30
52
  }
31
53
  },
32
54
  "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
55
  "files": [
44
56
  "dist",
45
57
  "src"
@@ -48,45 +60,45 @@
48
60
  "@effect-atom/atom": "^0.5.1",
49
61
  "@fluentui/react-tabster": "9.26.11",
50
62
  "react-joyride": "^2.7.2",
51
- "@dxos/app-framework": "0.8.4-main.1068cf700f",
52
- "@dxos/debug": "0.8.4-main.1068cf700f",
53
- "@dxos/app-graph": "0.8.4-main.1068cf700f",
54
- "@dxos/app-toolkit": "0.8.4-main.1068cf700f",
55
- "@dxos/echo": "0.8.4-main.1068cf700f",
56
- "@dxos/effect": "0.8.4-main.1068cf700f",
57
- "@dxos/operation": "0.8.4-main.1068cf700f",
58
- "@dxos/plugin-client": "0.8.4-main.1068cf700f",
59
- "@dxos/plugin-graph": "0.8.4-main.1068cf700f",
60
- "@dxos/plugin-space": "0.8.4-main.1068cf700f",
61
- "@dxos/keyboard": "0.8.4-main.1068cf700f",
62
- "@dxos/react-client": "0.8.4-main.1068cf700f",
63
- "@dxos/util": "0.8.4-main.1068cf700f"
63
+ "@dxos/app-framework": "0.8.4-main.1c7ec43d41",
64
+ "@dxos/app-graph": "0.8.4-main.1c7ec43d41",
65
+ "@dxos/compute": "0.8.4-main.1c7ec43d41",
66
+ "@dxos/app-toolkit": "0.8.4-main.1c7ec43d41",
67
+ "@dxos/debug": "0.8.4-main.1c7ec43d41",
68
+ "@dxos/echo": "0.8.4-main.1c7ec43d41",
69
+ "@dxos/effect": "0.8.4-main.1c7ec43d41",
70
+ "@dxos/keyboard": "0.8.4-main.1c7ec43d41",
71
+ "@dxos/plugin-graph": "0.8.4-main.1c7ec43d41",
72
+ "@dxos/plugin-space": "0.8.4-main.1c7ec43d41",
73
+ "@dxos/plugin-client": "0.8.4-main.1c7ec43d41",
74
+ "@dxos/util": "0.8.4-main.1c7ec43d41",
75
+ "@dxos/react-client": "0.8.4-main.1c7ec43d41"
64
76
  },
65
77
  "devDependencies": {
66
78
  "@effect-atom/atom-react": "^0.5.0",
67
79
  "@effect/platform": "0.94.4",
68
80
  "@types/react": "~19.2.7",
69
81
  "@types/react-dom": "~19.2.3",
70
- "effect": "3.19.16",
82
+ "effect": "3.20.0",
71
83
  "react": "~19.2.3",
72
84
  "react-dom": "~19.2.3",
73
85
  "react-floater": "0.7.9",
74
86
  "type-fest": "4.10.1",
75
- "vite": "7.1.9",
76
- "@dxos/plugin-testing": "0.8.4-main.1068cf700f",
77
- "@dxos/react-ui": "0.8.4-main.1068cf700f",
78
- "@dxos/random": "0.8.4-main.1068cf700f",
79
- "@dxos/storybook-utils": "0.8.4-main.1068cf700f",
80
- "@dxos/ui-theme": "0.8.4-main.1068cf700f"
87
+ "vite": "^8.0.10",
88
+ "@dxos/random": "0.8.4-main.1c7ec43d41",
89
+ "@dxos/react-ui": "0.8.4-main.1c7ec43d41",
90
+ "@dxos/plugin-testing": "0.8.4-main.1c7ec43d41",
91
+ "@dxos/storybook-utils": "0.8.4-main.1c7ec43d41",
92
+ "@dxos/ui-theme": "0.8.4-main.1c7ec43d41"
81
93
  },
82
94
  "peerDependencies": {
83
95
  "@effect-atom/atom-react": "^0.5.0",
84
96
  "@effect/platform": "0.94.4",
85
- "effect": "3.19.16",
97
+ "effect": "3.20.0",
86
98
  "react": "~19.2.3",
87
99
  "react-dom": "~19.2.3",
88
- "@dxos/react-ui": "0.8.4-main.1068cf700f",
89
- "@dxos/ui-theme": "0.8.4-main.1068cf700f"
100
+ "@dxos/react-ui": "0.8.4-main.1c7ec43d41",
101
+ "@dxos/ui-theme": "0.8.4-main.1c7ec43d41"
90
102
  },
91
103
  "publishConfig": {
92
104
  "access": "public"
@@ -0,0 +1,30 @@
1
+ //
2
+ // Copyright 2026 DXOS.org
3
+ //
4
+
5
+ import { describe, test } from 'vitest';
6
+
7
+ import { ActivationEvents } from '@dxos/app-framework';
8
+ import { createComposerTestApp } from '@dxos/plugin-testing/harness';
9
+
10
+ import { HelpPlugin } from '#plugin';
11
+
12
+ import { meta } from './meta';
13
+
14
+ const moduleId = (name: string) => `${meta.id}.module.${name}`;
15
+
16
+ describe('HelpPlugin', () => {
17
+ test('modules activate on the expected events', async ({ expect }) => {
18
+ await using harness = await createComposerTestApp({
19
+ plugins: [HelpPlugin({})],
20
+ });
21
+
22
+ expect(harness.manager.getActive()).toEqual(
23
+ expect.arrayContaining([moduleId('AppGraphBuilder'), moduleId('ReactSurface')]),
24
+ );
25
+
26
+ // Operation handlers are not loaded on startup — SetupOperationHandler fires lazily when an operation is invoked.
27
+ await harness.fire(ActivationEvents.SetupOperationHandler);
28
+ expect(harness.manager.getActive()).toContain(moduleId('OperationHandler'));
29
+ });
30
+ });
@@ -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({
@@ -28,3 +28,5 @@ export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
28
28
  })),
29
29
  Plugin.make,
30
30
  );
31
+
32
+ export default HelpPlugin;
@@ -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 '../../components';
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,24 +38,23 @@ 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, {
45
47
  subject: SHORTCUTS_DIALOG,
46
- blockAlign: 'center',
47
48
  });
48
49
  }),
49
50
  properties: {
50
- label: ['open shortcuts label', { ns: meta.id }],
51
+ label: ['open-shortcuts.label', { ns: meta.id }],
51
52
  icon: 'ph--keyboard--regular',
52
53
  keyBinding: {
53
54
  macos: 'meta+ctrl+/',
54
55
  },
55
56
  },
56
- },
57
+ }),
57
58
  ]),
58
59
  });
59
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,27 +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, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../../components';
12
- import { meta } from '../../meta';
12
+ import { ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '#containers';
13
+
14
+ import { SHORTCUTS_DIALOG } from '../constants';
13
15
 
14
16
  export default Capability.makeModule(() =>
15
17
  Effect.succeed(
16
18
  Capability.contributes(Capabilities.ReactSurface, [
17
19
  Surface.create({
18
- id: `${meta.id}/hints`,
20
+ id: 'hints',
19
21
  role: 'hints',
20
22
  component: () => <ShortcutsHints />,
21
23
  }),
22
24
  Surface.create({
23
- id: `${meta.id}/keyshortcuts`,
25
+ id: 'keyshortcuts',
24
26
  role: 'keyshortcuts',
25
27
  component: () => <ShortcutsList />,
26
28
  }),
27
29
  Surface.create({
28
30
  id: SHORTCUTS_DIALOG,
29
- role: 'dialog',
30
- filter: (data): data is { component: string } => data.component === SHORTCUTS_DIALOG,
31
+ filter: AppSurface.component(AppSurface.Dialog, SHORTCUTS_DIALOG),
31
32
  component: () => <ShortcutsDialogContent />,
32
33
  }),
33
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(() => {
@@ -27,7 +27,7 @@ export const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {
27
27
  const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));
28
28
 
29
29
  return (
30
- <div role='none' className='flex overflow-hidden pli-2 gap-4'>
30
+ <div role='none' className='flex overflow-hidden px-2 gap-4'>
31
31
  {hints.map((binding) => (
32
32
  <Shortcut key={binding.shortcut} binding={binding} />
33
33
  ))}
@@ -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
 
@@ -22,11 +22,11 @@ export const ShortcutsList = () => {
22
22
  });
23
23
 
24
24
  return (
25
- <dl className={mx('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued select-none')}>
25
+ <dl className={mx('w-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 my-4 text-subdued select-none')}>
26
26
  {bindings.map((binding, i) => (
27
27
  <Fragment key={i}>
28
28
  <Key binding={binding.shortcut} />
29
- <span role='definition' className='mis-4' aria-labelledby={binding.shortcut}>
29
+ <span role='definition' className='ms-4' aria-labelledby={binding.shortcut}>
30
30
  {toLocalizedString(binding.data, t)}
31
31
  </span>
32
32
  </Fragment>
@@ -4,13 +4,11 @@
4
4
 
5
5
  import React from 'react';
6
6
 
7
- import { descriptionText } from '@dxos/ui-theme';
8
-
9
7
  import { ShortcutsList } from './ShortcutsList';
10
8
 
11
9
  export const ShortcutsSection = () => {
12
10
  return (
13
- <section className={descriptionText}>
11
+ <section className='text-description'>
14
12
  <ShortcutsList />
15
13
  </section>
16
14
  );
@@ -2,7 +2,6 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- export * from './ShortcutsDialog';
6
5
  export * from './ShortcutsHints';
7
6
  export * from './ShortcutsList';
8
7
  export * from './ShortcutsSection';
@@ -5,6 +5,6 @@
5
5
  import { mx } from '@dxos/ui-theme';
6
6
 
7
7
  export const shortcutKey = mx(
8
- 'inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs',
9
- 'rounded bg-neutral-100 dark:bg-neutral-900',
8
+ 'inline-flex min-w-[24px] h-[24px] px-0.5 justify-center items-center text-xs',
9
+ 'rounded-sm bg-neutral-100 dark:bg-neutral-900',
10
10
  );
@@ -38,7 +38,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
38
38
 
39
39
  return (
40
40
  <div
41
- className='flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-accentSurfaceText'
41
+ className='flex flex-col w-[15rem] min-h-[10rem] overflow-hidden rounded-md shadow-xl bg-accent-surface text-accent-surface-text'
42
42
  role='tooltip'
43
43
  data-testid='helpPlugin.tooltip'
44
44
  data-step={index + 1}
@@ -46,7 +46,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
46
46
  ref={forwardedRef}
47
47
  >
48
48
  <div className='flex p-2'>
49
- <h2 className='grow pli-2 plb-1 text-lg font-medium text-accentSurfaceText'>{title}</h2>
49
+ <h2 className='grow px-2 py-1 text-lg font-medium text-accent-surface-text'>{title}</h2>
50
50
  <IconButton
51
51
  density='fine'
52
52
  icon='ph--x--bold'
@@ -58,7 +58,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
58
58
  data-testid='helpPlugin.tooltip.close'
59
59
  />
60
60
  </div>
61
- <div className='flex grow pli-4 mlb-2'>{content}</div>
61
+ <div className='flex grow px-4 my-2'>{content}</div>
62
62
  <div className='flex p-2 items-center justify-between' {...arrowNavigationAttrs}>
63
63
  {
64
64
  <IconButton
@@ -78,7 +78,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
78
78
  key={i}
79
79
  icon={index === i ? 'ph--circle--fill' : 'ph--circle--regular'}
80
80
  size={2}
81
- classNames='mli-1 cursor-pointer'
81
+ classNames='mx-1 cursor-pointer'
82
82
  />
83
83
  ))}
84
84
  </div>
@@ -7,24 +7,24 @@ 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 (
26
- <div className='flex flex-col bs-full p-4 space-y-8'>
27
- <div className='flex items-center gap-2 plb-2'>
26
+ <div className='flex flex-col h-full p-4 space-y-8'>
27
+ <div className='flex items-center gap-2 py-2'>
28
28
  <Button data-joyride='basic/1' onClick={() => start()}>
29
29
  Start
30
30
  </Button>
@@ -41,13 +41,13 @@ const App = () => {
41
41
  ))}
42
42
  </ul>
43
43
  </div>
44
- <div className='flex items-center gap-2 plb-2'>
44
+ <div className='flex items-center gap-2 py-2'>
45
45
  <Button data-joyride='basic/3' onClick={handleAdd}>
46
46
  Add
47
47
  </Button>
48
48
  </div>
49
49
  <div className='flex grow' />
50
- <div className='flex items-center plb-2'>
50
+ <div className='flex items-center py-2'>
51
51
  <div className='grow' />
52
52
  <Icon icon='ph--circle--regular' data-joyride='basic/4' />
53
53
  <Icon icon='ph--circle--regular' />
@@ -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
  ],
@@ -105,7 +105,7 @@ export const Default: StoryObj<typeof WelcomeTour> = {
105
105
  * IMPORTANT: Run in separate tab.
106
106
  */
107
107
  const meta = {
108
- title: 'plugins/plugin-help/WelcomeTour',
108
+ title: 'plugins/plugin-help/components/WelcomeTour',
109
109
  component: WelcomeTour,
110
110
  render: DefaultStory,
111
111
  decorators: [
@@ -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
  );
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { meta } from '#meta';
6
+
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 = {};
@@ -0,0 +1,28 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import React from 'react';
6
+
7
+ import { Dialog, useTranslation } from '@dxos/react-ui';
8
+
9
+ import { ShortcutsList } from '#components';
10
+ import { meta } from '#meta';
11
+
12
+ export const ShortcutsDialogContent = () => {
13
+ const { t } = useTranslation(meta.id);
14
+
15
+ return (
16
+ <Dialog.Content>
17
+ <Dialog.Header>
18
+ <Dialog.Title>{t('shortcuts-dialog.title')}</Dialog.Title>
19
+ <Dialog.Close asChild>
20
+ <Dialog.CloseIconButton />
21
+ </Dialog.Close>
22
+ </Dialog.Header>
23
+ <Dialog.Body>
24
+ <ShortcutsList />
25
+ </Dialog.Body>
26
+ </Dialog.Content>
27
+ );
28
+ };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ export { ShortcutsDialogContent as default } from './ShortcutsDialogContent';