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

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 (155) hide show
  1. package/dist/lib/browser/ShortcutsDialogContent-SFEN5YKG.mjs +36 -0
  2. package/dist/lib/browser/ShortcutsDialogContent-SFEN5YKG.mjs.map +7 -0
  3. package/dist/lib/browser/ShortcutsHints-SUH2FE3T.mjs +12 -0
  4. package/dist/lib/browser/ShortcutsHints-SUH2FE3T.mjs.map +7 -0
  5. package/dist/lib/browser/ShortcutsList-4YPEJM33.mjs +12 -0
  6. package/dist/lib/browser/ShortcutsList-4YPEJM33.mjs.map +7 -0
  7. package/dist/lib/browser/app-graph-builder-5RXPFQPI.mjs +79 -0
  8. package/dist/lib/browser/app-graph-builder-5RXPFQPI.mjs.map +7 -0
  9. package/dist/lib/browser/chunk-HMLZFBYY.mjs +58 -0
  10. package/dist/lib/browser/chunk-HMLZFBYY.mjs.map +7 -0
  11. package/dist/lib/browser/chunk-P34WCEMS.mjs +11 -0
  12. package/dist/lib/browser/chunk-P34WCEMS.mjs.map +7 -0
  13. package/dist/lib/browser/chunk-TEXIV2IJ.mjs +16 -0
  14. package/dist/lib/browser/chunk-TEXIV2IJ.mjs.map +7 -0
  15. package/dist/lib/browser/chunk-VGW5FGD7.mjs +335 -0
  16. package/dist/lib/browser/chunk-VGW5FGD7.mjs.map +7 -0
  17. package/dist/lib/browser/index.mjs +62 -60
  18. package/dist/lib/browser/index.mjs.map +4 -4
  19. package/dist/lib/browser/meta.json +1 -1
  20. package/dist/lib/browser/meta.mjs +1 -3
  21. package/dist/lib/browser/react-root-JBHEZA5U.mjs +43 -0
  22. package/dist/lib/browser/react-root-JBHEZA5U.mjs.map +7 -0
  23. package/dist/lib/browser/react-surface-W5S45O6Y.mjs +42 -0
  24. package/dist/lib/browser/react-surface-W5S45O6Y.mjs.map +7 -0
  25. package/dist/lib/browser/state-SEPP77HO.mjs +27 -0
  26. package/dist/lib/browser/state-SEPP77HO.mjs.map +7 -0
  27. package/dist/lib/browser/types/index.mjs +8 -6
  28. package/dist/types/src/HelpPlugin.d.ts +2 -1
  29. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  30. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts +6 -0
  31. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +1 -0
  32. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +3 -0
  33. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +1 -0
  34. package/dist/types/src/capabilities/index.d.ts +5 -8
  35. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  36. package/dist/types/src/capabilities/operation-resolver/index.d.ts +2 -0
  37. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +1 -0
  38. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +5 -0
  39. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +1 -0
  40. package/dist/types/src/capabilities/react-root/index.d.ts +6 -0
  41. package/dist/types/src/capabilities/react-root/index.d.ts.map +1 -0
  42. package/dist/types/src/capabilities/react-root/react-root.d.ts +10 -0
  43. package/dist/types/src/capabilities/react-root/react-root.d.ts.map +1 -0
  44. package/dist/types/src/capabilities/react-surface/index.d.ts +3 -0
  45. package/dist/types/src/capabilities/react-surface/index.d.ts.map +1 -0
  46. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +5 -0
  47. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +1 -0
  48. package/dist/types/src/capabilities/state/index.d.ts +11 -0
  49. package/dist/types/src/capabilities/state/index.d.ts.map +1 -0
  50. package/dist/types/src/capabilities/state/state.d.ts +13 -0
  51. package/dist/types/src/capabilities/state/state.d.ts.map +1 -0
  52. package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
  53. package/dist/types/src/components/Shortcuts/ShortcutsList.d.ts.map +1 -1
  54. package/dist/types/src/components/Shortcuts/ShortcutsSection.d.ts.map +1 -1
  55. package/dist/types/src/components/Shortcuts/index.d.ts +0 -1
  56. package/dist/types/src/components/Shortcuts/index.d.ts.map +1 -1
  57. package/dist/types/src/components/Tooltip/Tooltip.d.ts.map +1 -1
  58. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  59. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts +9 -4
  60. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
  61. package/dist/types/src/constants.d.ts +2 -0
  62. package/dist/types/src/constants.d.ts.map +1 -0
  63. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts +3 -0
  64. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts.map +1 -0
  65. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts +3 -0
  66. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts.map +1 -0
  67. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts +2 -0
  68. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts.map +1 -0
  69. package/dist/types/src/containers/ShortcutsHints/index.d.ts +3 -0
  70. package/dist/types/src/containers/ShortcutsHints/index.d.ts.map +1 -0
  71. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts +2 -0
  72. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts.map +1 -0
  73. package/dist/types/src/containers/ShortcutsList/index.d.ts +3 -0
  74. package/dist/types/src/containers/ShortcutsList/index.d.ts.map +1 -0
  75. package/dist/types/src/containers/index.d.ts +5 -0
  76. package/dist/types/src/containers/index.d.ts.map +1 -0
  77. package/dist/types/src/index.d.ts +2 -1
  78. package/dist/types/src/index.d.ts.map +1 -1
  79. package/dist/types/src/meta.d.ts +2 -3
  80. package/dist/types/src/meta.d.ts.map +1 -1
  81. package/dist/types/src/types/capabilities.d.ts +21 -0
  82. package/dist/types/src/types/capabilities.d.ts.map +1 -0
  83. package/dist/types/src/types/index.d.ts +1 -0
  84. package/dist/types/src/types/index.d.ts.map +1 -1
  85. package/dist/types/src/types/schema.d.ts +17 -13
  86. package/dist/types/src/types/schema.d.ts.map +1 -1
  87. package/dist/types/tsconfig.tsbuildinfo +1 -1
  88. package/package.json +43 -34
  89. package/src/HelpPlugin.tsx +20 -47
  90. package/src/capabilities/app-graph-builder/app-graph-builder.ts +61 -0
  91. package/src/capabilities/app-graph-builder/index.ts +7 -0
  92. package/src/capabilities/index.ts +5 -8
  93. package/src/capabilities/operation-resolver/index.ts +5 -0
  94. package/src/capabilities/operation-resolver/operation-resolver.ts +23 -0
  95. package/src/capabilities/react-root/index.ts +7 -0
  96. package/src/capabilities/react-root/react-root.tsx +36 -0
  97. package/src/capabilities/react-surface/index.ts +7 -0
  98. package/src/capabilities/react-surface/react-surface.tsx +36 -0
  99. package/src/capabilities/state/index.ts +7 -0
  100. package/src/capabilities/state/state.ts +27 -0
  101. package/src/components/Shortcuts/ShortcutsHints.tsx +13 -5
  102. package/src/components/Shortcuts/ShortcutsList.tsx +6 -5
  103. package/src/components/Shortcuts/ShortcutsSection.tsx +1 -3
  104. package/src/components/Shortcuts/index.ts +0 -1
  105. package/src/components/Shortcuts/styles.ts +3 -3
  106. package/src/components/Tooltip/Tooltip.tsx +5 -6
  107. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +15 -9
  108. package/src/components/WelcomeTour/WelcomeTour.tsx +17 -19
  109. package/src/constants.ts +7 -0
  110. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +29 -0
  111. package/src/containers/ShortcutsDialogContent/index.ts +7 -0
  112. package/src/containers/ShortcutsHints/ShortcutsHints.tsx +5 -0
  113. package/src/containers/ShortcutsHints/index.ts +7 -0
  114. package/src/containers/ShortcutsList/ShortcutsList.tsx +5 -0
  115. package/src/containers/ShortcutsList/index.ts +7 -0
  116. package/src/containers/index.ts +9 -0
  117. package/src/index.ts +2 -1
  118. package/src/meta.ts +8 -6
  119. package/src/types/capabilities.ts +24 -0
  120. package/src/types/index.ts +1 -0
  121. package/src/types/schema.ts +12 -8
  122. package/dist/lib/browser/app-graph-builder-BYCMEBNG.mjs +0 -79
  123. package/dist/lib/browser/app-graph-builder-BYCMEBNG.mjs.map +0 -7
  124. package/dist/lib/browser/chunk-3Y4CMOZP.mjs +0 -13
  125. package/dist/lib/browser/chunk-3Y4CMOZP.mjs.map +0 -7
  126. package/dist/lib/browser/chunk-J2SJSGSX.mjs +0 -34
  127. package/dist/lib/browser/chunk-J2SJSGSX.mjs.map +0 -7
  128. package/dist/lib/browser/chunk-LDRUZNSN.mjs +0 -16
  129. package/dist/lib/browser/chunk-LDRUZNSN.mjs.map +0 -7
  130. package/dist/lib/browser/chunk-MNETJXKS.mjs +0 -409
  131. package/dist/lib/browser/chunk-MNETJXKS.mjs.map +0 -7
  132. package/dist/lib/browser/react-root-W6ZDEGBU.mjs +0 -34
  133. package/dist/lib/browser/react-root-W6ZDEGBU.mjs.map +0 -7
  134. package/dist/lib/browser/react-surface-SATVEWS5.mjs +0 -36
  135. package/dist/lib/browser/react-surface-SATVEWS5.mjs.map +0 -7
  136. package/dist/lib/browser/state-FWUZG6NL.mjs +0 -29
  137. package/dist/lib/browser/state-FWUZG6NL.mjs.map +0 -7
  138. package/dist/types/src/capabilities/app-graph-builder.d.ts +0 -4
  139. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +0 -1
  140. package/dist/types/src/capabilities/capabilities.d.ts +0 -10
  141. package/dist/types/src/capabilities/capabilities.d.ts.map +0 -1
  142. package/dist/types/src/capabilities/react-root.d.ts +0 -8
  143. package/dist/types/src/capabilities/react-root.d.ts.map +0 -1
  144. package/dist/types/src/capabilities/react-surface.d.ts +0 -4
  145. package/dist/types/src/capabilities/react-surface.d.ts.map +0 -1
  146. package/dist/types/src/capabilities/state.d.ts +0 -4
  147. package/dist/types/src/capabilities/state.d.ts.map +0 -1
  148. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts +0 -4
  149. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +0 -1
  150. package/src/capabilities/app-graph-builder.ts +0 -76
  151. package/src/capabilities/capabilities.ts +0 -13
  152. package/src/capabilities/react-root.tsx +0 -32
  153. package/src/capabilities/react-surface.tsx +0 -30
  154. package/src/capabilities/state.ts +0 -23
  155. package/src/components/Shortcuts/ShortcutsDialog.tsx +0 -34
package/package.json CHANGED
@@ -1,23 +1,30 @@
1
1
  {
2
2
  "name": "@dxos/plugin-help",
3
- "version": "0.8.4-main.c1de068",
3
+ "version": "0.8.4-main.c351d160a8",
4
4
  "description": "Help plugin.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/dxos/dxos"
10
+ },
7
11
  "license": "MIT",
8
12
  "author": "DXOS.org",
9
13
  "sideEffects": true,
10
14
  "type": "module",
11
15
  "exports": {
12
16
  ".": {
17
+ "source": "./src/index.ts",
13
18
  "types": "./dist/types/src/index.d.ts",
14
19
  "browser": "./dist/lib/browser/index.mjs"
15
20
  },
16
21
  "./meta": {
22
+ "source": "./src/meta.ts",
17
23
  "types": "./dist/types/src/meta.d.ts",
18
24
  "browser": "./dist/lib/browser/meta.mjs"
19
25
  },
20
26
  "./types": {
27
+ "source": "./src/types/index.ts",
21
28
  "types": "./dist/types/src/types/index.d.ts",
22
29
  "browser": "./dist/lib/browser/types/index.mjs"
23
30
  }
@@ -38,46 +45,48 @@
38
45
  "src"
39
46
  ],
40
47
  "dependencies": {
41
- "@fluentui/react-tabster": "^9.24.2",
42
- "@preact-signals/safe-react": "^0.9.0",
48
+ "@effect-atom/atom": "^0.5.1",
49
+ "@fluentui/react-tabster": "9.26.11",
43
50
  "react-joyride": "^2.7.2",
44
- "@dxos/app-framework": "0.8.4-main.c1de068",
45
- "@dxos/app-graph": "0.8.4-main.c1de068",
46
- "@dxos/echo": "0.8.4-main.c1de068",
47
- "@dxos/debug": "0.8.4-main.c1de068",
48
- "@dxos/echo-schema": "0.8.4-main.c1de068",
49
- "@dxos/keyboard": "0.8.4-main.c1de068",
50
- "@dxos/live-object": "0.8.4-main.c1de068",
51
- "@dxos/plugin-graph": "0.8.4-main.c1de068",
52
- "@dxos/plugin-client": "0.8.4-main.c1de068",
53
- "@dxos/plugin-space": "0.8.4-main.c1de068",
54
- "@dxos/react-client": "0.8.4-main.c1de068",
55
- "@dxos/local-storage": "0.8.4-main.c1de068"
51
+ "@dxos/app-framework": "0.8.4-main.c351d160a8",
52
+ "@dxos/app-graph": "0.8.4-main.c351d160a8",
53
+ "@dxos/debug": "0.8.4-main.c351d160a8",
54
+ "@dxos/app-toolkit": "0.8.4-main.c351d160a8",
55
+ "@dxos/echo": "0.8.4-main.c351d160a8",
56
+ "@dxos/effect": "0.8.4-main.c351d160a8",
57
+ "@dxos/keyboard": "0.8.4-main.c351d160a8",
58
+ "@dxos/operation": "0.8.4-main.c351d160a8",
59
+ "@dxos/plugin-client": "0.8.4-main.c351d160a8",
60
+ "@dxos/react-client": "0.8.4-main.c351d160a8",
61
+ "@dxos/util": "0.8.4-main.c351d160a8",
62
+ "@dxos/plugin-graph": "0.8.4-main.c351d160a8",
63
+ "@dxos/plugin-space": "0.8.4-main.c351d160a8"
56
64
  },
57
65
  "devDependencies": {
58
- "@effect-rx/rx-react": "0.38.0",
59
- "@effect/platform": "0.89.0",
60
- "@types/react": "~18.2.0",
61
- "@types/react-dom": "~18.2.0",
62
- "effect": "3.17.0",
63
- "react": "~18.2.0",
64
- "react-dom": "~18.2.0",
66
+ "@effect-atom/atom-react": "^0.5.0",
67
+ "@effect/platform": "0.94.4",
68
+ "@types/react": "~19.2.7",
69
+ "@types/react-dom": "~19.2.3",
70
+ "effect": "3.19.16",
71
+ "react": "~19.2.3",
72
+ "react-dom": "~19.2.3",
65
73
  "react-floater": "0.7.9",
66
74
  "type-fest": "4.10.1",
67
- "vite": "5.4.7",
68
- "@dxos/random": "0.8.4-main.c1de068",
69
- "@dxos/react-ui": "0.8.4-main.c1de068",
70
- "@dxos/storybook-utils": "0.8.4-main.c1de068",
71
- "@dxos/react-ui-theme": "0.8.4-main.c1de068"
75
+ "vite": "^7.1.11",
76
+ "@dxos/plugin-testing": "0.8.4-main.c351d160a8",
77
+ "@dxos/random": "0.8.4-main.c351d160a8",
78
+ "@dxos/react-ui": "0.8.4-main.c351d160a8",
79
+ "@dxos/storybook-utils": "0.8.4-main.c351d160a8",
80
+ "@dxos/ui-theme": "0.8.4-main.c351d160a8"
72
81
  },
73
82
  "peerDependencies": {
74
- "@effect-rx/rx-react": "^0.34.1",
75
- "@effect/platform": "^0.80.12",
76
- "effect": "^3.13.3",
77
- "react": "~18.2.0",
78
- "react-dom": "~18.2.0",
79
- "@dxos/react-ui": "0.8.4-main.c1de068",
80
- "@dxos/react-ui-theme": "0.8.4-main.c1de068"
83
+ "@effect-atom/atom-react": "^0.5.0",
84
+ "@effect/platform": "0.94.4",
85
+ "effect": "3.19.16",
86
+ "react": "~19.2.3",
87
+ "react-dom": "~19.2.3",
88
+ "@dxos/react-ui": "0.8.4-main.c351d160a8",
89
+ "@dxos/ui-theme": "0.8.4-main.c351d160a8"
81
90
  },
82
91
  "publishConfig": {
83
92
  "access": "public"
@@ -2,56 +2,29 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { createResolver, defineModule, definePlugin, Events, contributes, Capabilities } from '@dxos/app-framework';
5
+ import { ActivationEvents, Plugin } from '@dxos/app-framework';
6
+ import { AppPlugin } from '@dxos/app-toolkit';
6
7
 
7
- import { AppGraphBuilder, HelpState, ReactRoot, ReactSurface } from './capabilities';
8
- import { HelpCapabilities } from './capabilities/capabilities';
8
+ import { AppGraphBuilder, HelpState, OperationResolver, ReactRoot, ReactSurface } from './capabilities';
9
9
  import { meta } from './meta';
10
10
  import { translations } from './translations';
11
- import { type Step, HelpAction } from './types';
11
+ import { type Step } from './types';
12
12
 
13
13
  export type HelpPluginOptions = { steps?: Step[] };
14
14
 
15
- export const HelpPlugin = ({ steps = [] }: HelpPluginOptions) =>
16
- definePlugin(meta, [
17
- defineModule({
18
- id: `${meta.id}/module/state`,
19
- activatesOn: Events.Startup,
20
- activate: HelpState,
21
- }),
22
- defineModule({
23
- id: `${meta.id}/module/translations`,
24
- activatesOn: Events.SetupTranslations,
25
- activate: () => contributes(Capabilities.Translations, translations),
26
- }),
27
- defineModule({
28
- id: `${meta.id}/module/react-root`,
29
- activatesOn: Events.Startup,
30
- activate: () => ReactRoot(steps),
31
- }),
32
- defineModule({
33
- id: `${meta.id}/module/react-surface`,
34
- activatesOn: Events.SetupReactSurface,
35
- activate: ReactSurface,
36
- }),
37
- defineModule({
38
- id: `${meta.id}/module/intent-resolver`,
39
- activatesOn: Events.SetupIntentResolver,
40
- activate: (context) =>
41
- contributes(
42
- Capabilities.IntentResolver,
43
- createResolver({
44
- intent: HelpAction.Start,
45
- resolve: () => {
46
- const state = context.getCapability(HelpCapabilities.MutableState);
47
- state.running = true;
48
- },
49
- }),
50
- ),
51
- }),
52
- defineModule({
53
- id: `${meta.id}/module/app-graph-builder`,
54
- activatesOn: Events.SetupAppGraph,
55
- activate: AppGraphBuilder,
56
- }),
57
- ]);
15
+ export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
16
+ AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
17
+ AppPlugin.addOperationResolverModule({ activate: OperationResolver }),
18
+ AppPlugin.addSurfaceModule({ activate: ReactSurface }),
19
+ AppPlugin.addTranslationsModule({ translations }),
20
+ Plugin.addModule({
21
+ activatesOn: ActivationEvents.Startup,
22
+ activate: HelpState,
23
+ }),
24
+ Plugin.addModule(({ steps = [] }) => ({
25
+ id: 'react-root',
26
+ activatesOn: ActivationEvents.Startup,
27
+ activate: () => ReactRoot(steps),
28
+ })),
29
+ Plugin.make,
30
+ );
@@ -0,0 +1,61 @@
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 { GraphBuilder, NodeMatcher } from '@dxos/app-graph';
9
+ import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
10
+ import { Operation } from '@dxos/operation';
11
+
12
+ import { SHORTCUTS_DIALOG } from '../../constants';
13
+ import { meta } from '../../meta';
14
+ import { HelpCapabilities, HelpOperation } from '../../types';
15
+
16
+ export default Capability.makeModule(
17
+ Effect.fnUntraced(function* () {
18
+ const extensions = yield* GraphBuilder.createExtension({
19
+ id: meta.id,
20
+ match: NodeMatcher.whenRoot,
21
+ actions: () =>
22
+ Effect.succeed([
23
+ {
24
+ id: HelpOperation.Start.meta.key,
25
+ data: Effect.fnUntraced(function* () {
26
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
27
+ yield* Operation.invoke(HelpOperation.Start);
28
+ }),
29
+ properties: {
30
+ label: ['open help tour', { ns: meta.id }],
31
+ icon: 'ph--info--regular',
32
+ keyBinding: {
33
+ macos: 'shift+meta+/',
34
+ windows: 'shift+ctrl+/',
35
+ linux: 'shift+ctrl+?',
36
+ },
37
+ testId: 'helpPlugin.openHelp',
38
+ },
39
+ },
40
+ {
41
+ id: `${meta.id}.open-shortcuts`,
42
+ data: Effect.fnUntraced(function* () {
43
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));
44
+ yield* Operation.invoke(LayoutOperation.UpdateDialog, {
45
+ subject: SHORTCUTS_DIALOG,
46
+ });
47
+ }),
48
+ properties: {
49
+ label: ['open shortcuts label', { ns: meta.id }],
50
+ icon: 'ph--keyboard--regular',
51
+ keyBinding: {
52
+ macos: 'meta+ctrl+/',
53
+ },
54
+ },
55
+ },
56
+ ]),
57
+ });
58
+
59
+ return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
60
+ }),
61
+ );
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Capability } from '@dxos/app-framework';
6
+
7
+ export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
@@ -2,11 +2,8 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { lazy } from '@dxos/app-framework';
6
-
7
- export const AppGraphBuilder = lazy(() => import('./app-graph-builder'));
8
- export const ReactRoot = lazy(() => import('./react-root'));
9
- export const ReactSurface = lazy(() => import('./react-surface'));
10
- export const HelpState = lazy(() => import('./state'));
11
-
12
- export * from './capabilities';
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';
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export { default as OperationResolver } from './operation-resolver';
@@ -0,0 +1,23 @@
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 { OperationResolver } from '@dxos/operation';
9
+
10
+ import { HelpCapabilities, HelpOperation } from '../../types';
11
+
12
+ export default Capability.makeModule(
13
+ Effect.fnUntraced(function* () {
14
+ return Capability.contributes(Capabilities.OperationResolver, [
15
+ OperationResolver.make({
16
+ operation: HelpOperation.Start,
17
+ handler: Effect.fnUntraced(function* () {
18
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
19
+ }),
20
+ }),
21
+ ]);
22
+ }),
23
+ );
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Capability } from '@dxos/app-framework';
6
+
7
+ export const ReactRoot = Capability.lazy('ReactRoot', () => import('./react-root'));
@@ -0,0 +1,36 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+ import React from 'react';
7
+
8
+ import { Capabilities, Capability } from '@dxos/app-framework';
9
+ import { useAtomCapabilityState } from '@dxos/app-framework/ui';
10
+
11
+ import { WelcomeTour } from '../../components';
12
+ import { meta } from '../../meta';
13
+ import { HelpCapabilities, type Step } from '../../types';
14
+
15
+ export default Capability.makeModule(
16
+ Effect.fnUntraced(function* (steps?: Step[]) {
17
+ return Capability.contributes(Capabilities.ReactRoot, {
18
+ id: meta.id,
19
+ root: () => {
20
+ const [state, updateState] = useAtomCapabilityState(HelpCapabilities.State);
21
+ return (
22
+ <WelcomeTour
23
+ steps={steps ?? []}
24
+ running={state.running}
25
+ onRunningChanged={(newState) => {
26
+ updateState((s) => ({ ...s, running: newState }));
27
+ if (!newState) {
28
+ updateState((s) => ({ ...s, showHints: false }));
29
+ }
30
+ }}
31
+ />
32
+ );
33
+ },
34
+ });
35
+ }),
36
+ );
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Capability } from '@dxos/app-framework';
6
+
7
+ export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));
@@ -0,0 +1,36 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+ import React from 'react';
7
+
8
+ import { Capabilities, Capability } from '@dxos/app-framework';
9
+ import { Surface } from '@dxos/app-framework/ui';
10
+
11
+ import { SHORTCUTS_DIALOG } from '../../constants';
12
+ import { ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../../containers';
13
+ import { meta } from '../../meta';
14
+
15
+ export default Capability.makeModule(() =>
16
+ Effect.succeed(
17
+ Capability.contributes(Capabilities.ReactSurface, [
18
+ Surface.create({
19
+ id: `${meta.id}.hints`,
20
+ role: 'hints',
21
+ component: () => <ShortcutsHints />,
22
+ }),
23
+ Surface.create({
24
+ id: `${meta.id}.keyshortcuts`,
25
+ role: 'keyshortcuts',
26
+ component: () => <ShortcutsList />,
27
+ }),
28
+ Surface.create({
29
+ id: SHORTCUTS_DIALOG,
30
+ role: 'dialog',
31
+ filter: (data): data is { component: string } => data.component === SHORTCUTS_DIALOG,
32
+ component: () => <ShortcutsDialogContent />,
33
+ }),
34
+ ]),
35
+ ),
36
+ );
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Capability } from '@dxos/app-framework';
6
+
7
+ export const HelpState = Capability.lazy('HelpState', () => import('./state'));
@@ -0,0 +1,27 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { createKvsStore } from '@dxos/effect';
9
+
10
+ import { meta } from '../../meta';
11
+ import { HelpCapabilities } from '../../types';
12
+
13
+ export default Capability.makeModule(() =>
14
+ Effect.sync(() => {
15
+ const stateAtom = createKvsStore({
16
+ key: meta.id,
17
+ schema: HelpCapabilities.StateSchema,
18
+ defaultValue: () => ({
19
+ running: false,
20
+ showHints: true,
21
+ showWelcome: true,
22
+ }),
23
+ });
24
+
25
+ return Capability.contributes(HelpCapabilities.State, stateAtom);
26
+ }),
27
+ );
@@ -5,12 +5,13 @@
5
5
  import React from 'react';
6
6
 
7
7
  import { type KeyBinding, Keyboard } from '@dxos/keyboard';
8
- import { Button, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';
8
+ import { IconButton, toLocalizedString, useTranslation } from '@dxos/react-ui';
9
+ import { osTranslations } from '@dxos/ui-theme';
9
10
 
10
11
  import { Key } from './Key';
11
12
 
12
13
  const Shortcut = ({ binding }: { binding: KeyBinding }) => {
13
- const { t } = useTranslation('os');
14
+ const { t } = useTranslation(osTranslations);
14
15
  return (
15
16
  <div role='none' className='flex items-center gap-2 whitespace-nowrap'>
16
17
  <Key binding={binding.shortcut} />
@@ -31,9 +32,16 @@ export const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {
31
32
  <Shortcut key={binding.shortcut} binding={binding} />
32
33
  ))}
33
34
  {onClose && (
34
- <Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>
35
- <Icon icon='ph--x--regular' size={4} />
36
- </Button>
35
+ <IconButton
36
+ icon='ph--x--regular'
37
+ size={4}
38
+ label='Close'
39
+ iconOnly
40
+ noTooltip
41
+ variant='ghost'
42
+ classNames='p-0 cursor-pointer'
43
+ onClick={onClose}
44
+ />
37
45
  )}
38
46
  </div>
39
47
  );
@@ -6,13 +6,14 @@ import React, { Fragment } from 'react';
6
6
 
7
7
  import { Keyboard } from '@dxos/keyboard';
8
8
  import { toLocalizedString, useTranslation } from '@dxos/react-ui';
9
- import { mx } from '@dxos/react-ui-theme';
9
+ import { mx } from '@dxos/ui-theme';
10
+
11
+ import { meta } from '../../meta';
10
12
 
11
13
  import { Key } from './Key';
12
- import { HELP_PLUGIN } from '../../meta';
13
14
 
14
15
  export const ShortcutsList = () => {
15
- const { t } = useTranslation(HELP_PLUGIN);
16
+ const { t } = useTranslation(meta.id);
16
17
  const bindings = Keyboard.singleton.getBindings();
17
18
 
18
19
  // TODO(burdon): Get shortcuts from TextEditor.
@@ -21,11 +22,11 @@ export const ShortcutsList = () => {
21
22
  });
22
23
 
23
24
  return (
24
- <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')}>
25
26
  {bindings.map((binding, i) => (
26
27
  <Fragment key={i}>
27
28
  <Key binding={binding.shortcut} />
28
- <span role='definition' className='mis-4' aria-labelledby={binding.shortcut}>
29
+ <span role='definition' className='ms-4' aria-labelledby={binding.shortcut}>
29
30
  {toLocalizedString(binding.data, t)}
30
31
  </span>
31
32
  </Fragment>
@@ -4,13 +4,11 @@
4
4
 
5
5
  import React from 'react';
6
6
 
7
- import { descriptionText } from '@dxos/react-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';
@@ -2,9 +2,9 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { mx } from '@dxos/react-ui-theme';
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
  );
@@ -7,7 +7,7 @@ import React, { forwardRef } from 'react';
7
7
  // TODO(thure): This needed to be imported in the package.json specifically to pacify TS2742. See if this is resolved with typescript@5.5.x.
8
8
  // eslint-disable-next-line unused-imports/no-unused-imports
9
9
  import _floater from 'react-floater';
10
- import { type TooltipRenderProps, type Props } from 'react-joyride';
10
+ import { type Props, type TooltipRenderProps } from 'react-joyride';
11
11
  // TODO(thure): This needed to be imported in the package.json specifically to pacify TS2742. See if this is resolved with typescript@5.5.x.
12
12
  // eslint-disable-next-line unused-imports/no-unused-imports
13
13
  import _typefest from 'type-fest';
@@ -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
@@ -67,7 +67,6 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
67
67
  iconOnly
68
68
  label={backProps['aria-label']}
69
69
  onClick={backProps.onClick}
70
- size={5}
71
70
  variant='primary'
72
71
  data-testid='helpPlugin.tooltip.back'
73
72
  />
@@ -79,7 +78,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
79
78
  key={i}
80
79
  icon={index === i ? 'ph--circle--fill' : 'ph--circle--regular'}
81
80
  size={2}
82
- classNames='mli-1 cursor-pointer'
81
+ classNames='mx-1 cursor-pointer'
83
82
  />
84
83
  ))}
85
84
  </div>
@@ -2,18 +2,19 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import '@dxos-theme';
6
-
7
5
  import { type Meta, type StoryObj } from '@storybook/react-vite';
8
6
  import React, { useState } from 'react';
9
7
 
8
+ import { withPluginManager } from '@dxos/app-framework/testing';
9
+ import { StorybookPlugin } from '@dxos/plugin-testing';
10
10
  import { faker } from '@dxos/random';
11
11
  import { Button, Icon } from '@dxos/react-ui';
12
- import { withTheme } from '@dxos/storybook-utils';
12
+ import { withTheme } from '@dxos/react-ui/testing';
13
13
 
14
- import { WelcomeTour, type WelcomeTourProps } from './WelcomeTour';
15
14
  import { useHelp } from '../../hooks';
16
15
 
16
+ import { WelcomeTour, type WelcomeTourProps } from './WelcomeTour';
17
+
17
18
  const App = () => {
18
19
  const { running, start } = useHelp();
19
20
  const [items, setItems] = useState(() => Array.from({ length: 5 }).map(() => faker.lorem.sentence()));
@@ -31,7 +32,7 @@ const App = () => {
31
32
  <div>{String(running)}</div>
32
33
  </div>
33
34
  <div>
34
- <ul className='p-2 border border-blue-500 rounded-md' data-joyride='basic/2'>
35
+ <ul className='p-2 border border-primary-500 rounded-md' data-joyride='basic/2'>
35
36
  {items.map((item, i) => (
36
37
  <li key={i} className='flex items-center gap-2'>
37
38
  <Icon icon='ph--circle--regular' />
@@ -103,11 +104,16 @@ export const Default: StoryObj<typeof WelcomeTour> = {
103
104
  /**
104
105
  * IMPORTANT: Run in separate tab.
105
106
  */
106
- const meta: Meta<typeof WelcomeTour> = {
107
- title: 'plugins/plugin-help/WelcomeTour',
107
+ const meta = {
108
+ title: 'plugins/plugin-help/components/WelcomeTour',
108
109
  component: WelcomeTour,
109
110
  render: DefaultStory,
110
- decorators: [withTheme],
111
- };
111
+ decorators: [
112
+ withTheme(),
113
+ withPluginManager({
114
+ plugins: [StorybookPlugin({})],
115
+ }),
116
+ ],
117
+ } satisfies Meta<typeof WelcomeTour>;
112
118
 
113
119
  export default meta;