@dxos/plugin-help 0.8.4-main.422d1c7879 → 0.8.4-main.4f23b4e393

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 (122) hide show
  1. package/dist/lib/neutral/HelpPlugin.mjs +30 -0
  2. package/dist/lib/neutral/HelpPlugin.mjs.map +7 -0
  3. package/dist/lib/neutral/ShortcutsDialogContent-TB5PZWVY.mjs +17 -0
  4. package/dist/lib/neutral/ShortcutsDialogContent-TB5PZWVY.mjs.map +7 -0
  5. package/dist/lib/neutral/ShortcutsHints-ROTD5B7S.mjs +8 -0
  6. package/dist/lib/neutral/ShortcutsList-SK56WBBY.mjs +8 -0
  7. package/dist/lib/neutral/app-graph-builder-BJYIYNMN.mjs +75 -0
  8. package/dist/lib/neutral/app-graph-builder-BJYIYNMN.mjs.map +7 -0
  9. package/dist/lib/neutral/capabilities/index.mjs +17 -0
  10. package/dist/lib/neutral/capabilities/index.mjs.map +7 -0
  11. package/dist/lib/{browser/index.mjs → neutral/chunk-2COFFSNF.mjs} +9 -76
  12. package/dist/lib/neutral/chunk-2COFFSNF.mjs.map +7 -0
  13. package/dist/lib/neutral/chunk-BI3HKFKB.mjs +63 -0
  14. package/dist/lib/neutral/chunk-BI3HKFKB.mjs.map +7 -0
  15. package/dist/lib/neutral/chunk-GZL2J55W.mjs +8 -0
  16. package/dist/lib/neutral/chunk-GZL2J55W.mjs.map +7 -0
  17. package/dist/lib/neutral/chunk-MQQNHGDV.mjs +8 -0
  18. package/dist/lib/neutral/chunk-MQQNHGDV.mjs.map +7 -0
  19. package/dist/lib/{browser/chunk-TEXIV2IJ.mjs → neutral/chunk-NHTI7NEQ.mjs} +5 -2
  20. package/dist/lib/{browser/chunk-TEXIV2IJ.mjs.map → neutral/chunk-NHTI7NEQ.mjs.map} +3 -3
  21. package/dist/lib/neutral/components/index.mjs +20 -0
  22. package/dist/lib/neutral/components/index.mjs.map +7 -0
  23. package/dist/lib/neutral/containers/index.mjs +13 -0
  24. package/dist/lib/neutral/containers/index.mjs.map +7 -0
  25. package/dist/lib/neutral/hooks/index.mjs +13 -0
  26. package/dist/lib/neutral/hooks/index.mjs.map +7 -0
  27. package/dist/lib/neutral/index.mjs +24 -0
  28. package/dist/lib/neutral/index.mjs.map +7 -0
  29. package/dist/lib/neutral/meta.json +1 -0
  30. package/dist/lib/{browser → neutral}/meta.mjs +1 -1
  31. package/dist/lib/neutral/meta.mjs.map +7 -0
  32. package/dist/lib/neutral/operation-handler-F2JU4V62.mjs +13 -0
  33. package/dist/lib/neutral/operation-handler-F2JU4V62.mjs.map +7 -0
  34. package/dist/lib/neutral/operations/index.mjs +8 -0
  35. package/dist/lib/neutral/operations/index.mjs.map +7 -0
  36. package/dist/lib/neutral/plugin.mjs +16 -0
  37. package/dist/lib/neutral/plugin.mjs.map +7 -0
  38. package/dist/lib/neutral/react-root-PYPAXETF.mjs +38 -0
  39. package/dist/lib/neutral/react-root-PYPAXETF.mjs.map +7 -0
  40. package/dist/lib/neutral/react-surface-SNS4QQMR.mjs +33 -0
  41. package/dist/lib/neutral/react-surface-SNS4QQMR.mjs.map +7 -0
  42. package/dist/lib/neutral/start-XYUDZGXJ.mjs +21 -0
  43. package/dist/lib/neutral/start-XYUDZGXJ.mjs.map +7 -0
  44. package/dist/lib/neutral/state-5HQJG3KW.mjs +24 -0
  45. package/dist/lib/neutral/state-5HQJG3KW.mjs.map +7 -0
  46. package/dist/lib/neutral/translations.mjs +20 -0
  47. package/dist/lib/neutral/translations.mjs.map +7 -0
  48. package/dist/lib/neutral/types/index.mjs +12 -0
  49. package/dist/lib/neutral/types/index.mjs.map +7 -0
  50. package/dist/types/src/HelpPlugin.d.ts +1 -0
  51. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  52. package/dist/types/src/HelpPlugin.test.d.ts +2 -0
  53. package/dist/types/src/HelpPlugin.test.d.ts.map +1 -0
  54. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
  55. package/dist/types/src/capabilities/index.d.ts +1 -1
  56. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  57. package/dist/types/src/capabilities/operation-handler.d.ts +1 -1
  58. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -1
  59. package/dist/types/src/capabilities/react-root.d.ts.map +1 -1
  60. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
  61. package/dist/types/src/capabilities/state.d.ts.map +1 -1
  62. package/dist/types/src/components/Shortcuts/Key.d.ts.map +1 -1
  63. package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
  64. package/dist/types/src/components/Tooltip/Tooltip.d.ts +9 -9
  65. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  66. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
  67. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +5 -5
  68. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -1
  69. package/dist/types/src/index.d.ts +1 -4
  70. package/dist/types/src/index.d.ts.map +1 -1
  71. package/dist/types/src/meta.d.ts.map +1 -1
  72. package/dist/types/src/operations/index.d.ts +1 -2
  73. package/dist/types/src/operations/index.d.ts.map +1 -1
  74. package/dist/types/src/operations/start.d.ts +3 -3
  75. package/dist/types/src/operations/start.d.ts.map +1 -1
  76. package/dist/types/src/plugin.d.ts +5 -0
  77. package/dist/types/src/plugin.d.ts.map +1 -0
  78. package/dist/types/src/translations.d.ts +5 -6
  79. package/dist/types/src/translations.d.ts.map +1 -1
  80. package/dist/types/src/types/HelpCapabilities.d.ts +19 -0
  81. package/dist/types/src/types/HelpCapabilities.d.ts.map +1 -0
  82. package/dist/types/src/{operations/definitions.d.ts → types/HelpOperation.d.ts} +2 -2
  83. package/dist/types/src/types/HelpOperation.d.ts.map +1 -0
  84. package/dist/types/src/types/index.d.ts +2 -1
  85. package/dist/types/src/types/index.d.ts.map +1 -1
  86. package/dist/types/tsconfig.tsbuildinfo +1 -1
  87. package/package.json +74 -41
  88. package/src/HelpPlugin.test.ts +30 -0
  89. package/src/HelpPlugin.tsx +3 -2
  90. package/src/capabilities/app-graph-builder.ts +2 -3
  91. package/src/capabilities/index.ts +1 -1
  92. package/src/capabilities/operation-handler.ts +1 -1
  93. package/src/components/Shortcuts/ShortcutsHints.tsx +2 -2
  94. package/src/components/Tooltip/Tooltip.tsx +2 -2
  95. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +2 -1
  96. package/src/index.ts +1 -4
  97. package/src/meta.ts +1 -0
  98. package/src/operations/index.ts +1 -3
  99. package/src/operations/start.ts +3 -4
  100. package/src/plugin.ts +12 -0
  101. package/src/types/HelpCapabilities.ts +24 -0
  102. package/src/{operations/definitions.ts → types/HelpOperation.ts} +3 -1
  103. package/src/types/index.ts +2 -1
  104. package/dist/lib/browser/chunk-K4LQ2TR7.mjs +0 -34
  105. package/dist/lib/browser/chunk-K4LQ2TR7.mjs.map +0 -7
  106. package/dist/lib/browser/chunk-KUUIRJG5.mjs +0 -31
  107. package/dist/lib/browser/chunk-KUUIRJG5.mjs.map +0 -7
  108. package/dist/lib/browser/index.mjs.map +0 -7
  109. package/dist/lib/browser/meta.json +0 -1
  110. package/dist/lib/browser/operations/index.mjs +0 -13
  111. package/dist/lib/browser/operations/index.mjs.map +0 -7
  112. package/dist/lib/browser/start-YZBO346C.mjs +0 -23
  113. package/dist/lib/browser/start-YZBO346C.mjs.map +0 -7
  114. package/dist/lib/browser/types/index.mjs +0 -10
  115. package/dist/types/src/operations/definitions.d.ts.map +0 -1
  116. package/dist/types/src/types/capabilities.d.ts +0 -21
  117. package/dist/types/src/types/capabilities.d.ts.map +0 -1
  118. package/src/types/capabilities.ts +0 -24
  119. /package/dist/lib/{browser/chunk-J5LGTIGS.mjs.map → neutral/ShortcutsHints-ROTD5B7S.mjs.map} +0 -0
  120. /package/dist/lib/{browser/meta.mjs.map → neutral/ShortcutsList-SK56WBBY.mjs.map} +0 -0
  121. /package/dist/lib/{browser → neutral}/chunk-J5LGTIGS.mjs +0 -0
  122. /package/dist/lib/{browser/types/index.mjs.map → neutral/chunk-J5LGTIGS.mjs.map} +0 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/plugin-help",
3
- "version": "0.8.4-main.422d1c7879",
3
+ "version": "0.8.4-main.4f23b4e393",
4
4
  "description": "Help plugin.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -13,34 +13,67 @@
13
13
  "sideEffects": true,
14
14
  "type": "module",
15
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
- "#types": "./src/types/index.ts"
23
- },
24
- "exports": {
25
- ".": {
26
- "source": "./src/index.ts",
27
- "types": "./dist/types/src/index.d.ts",
28
- "browser": "./dist/lib/browser/index.mjs"
16
+ "#capabilities": {
17
+ "source": "./src/capabilities/index.ts",
18
+ "types": "./dist/types/src/capabilities/index.d.ts",
19
+ "default": "./dist/lib/neutral/capabilities/index.mjs"
29
20
  },
30
- "./meta": {
21
+ "#components": {
22
+ "source": "./src/components/index.ts",
23
+ "types": "./dist/types/src/components/index.d.ts",
24
+ "default": "./dist/lib/neutral/components/index.mjs"
25
+ },
26
+ "#containers": {
27
+ "source": "./src/containers/index.ts",
28
+ "types": "./dist/types/src/containers/index.d.ts",
29
+ "default": "./dist/lib/neutral/containers/index.mjs"
30
+ },
31
+ "#hooks": {
32
+ "source": "./src/hooks/index.ts",
33
+ "types": "./dist/types/src/hooks/index.d.ts",
34
+ "default": "./dist/lib/neutral/hooks/index.mjs"
35
+ },
36
+ "#meta": {
31
37
  "source": "./src/meta.ts",
32
38
  "types": "./dist/types/src/meta.d.ts",
33
- "browser": "./dist/lib/browser/meta.mjs"
39
+ "default": "./dist/lib/neutral/meta.mjs"
34
40
  },
35
- "./operations": {
41
+ "#operations": {
36
42
  "source": "./src/operations/index.ts",
37
43
  "types": "./dist/types/src/operations/index.d.ts",
38
- "browser": "./dist/lib/browser/operations/index.mjs"
44
+ "default": "./dist/lib/neutral/operations/index.mjs"
45
+ },
46
+ "#plugin": {
47
+ "source": "./src/HelpPlugin.tsx",
48
+ "types": "./dist/types/src/HelpPlugin.d.ts",
49
+ "default": "./dist/lib/neutral/HelpPlugin.mjs"
39
50
  },
40
- "./types": {
51
+ "#translations": {
52
+ "source": "./src/translations.ts",
53
+ "types": "./dist/types/src/translations.d.ts",
54
+ "default": "./dist/lib/neutral/translations.mjs"
55
+ },
56
+ "#types": {
41
57
  "source": "./src/types/index.ts",
42
58
  "types": "./dist/types/src/types/index.d.ts",
43
- "browser": "./dist/lib/browser/types/index.mjs"
59
+ "default": "./dist/lib/neutral/types/index.mjs"
60
+ }
61
+ },
62
+ "exports": {
63
+ ".": {
64
+ "source": "./src/index.ts",
65
+ "types": "./dist/types/src/index.d.ts",
66
+ "default": "./dist/lib/neutral/index.mjs"
67
+ },
68
+ "./plugin": {
69
+ "source": "./src/plugin.ts",
70
+ "types": "./dist/types/src/plugin.d.ts",
71
+ "default": "./dist/lib/neutral/plugin.mjs"
72
+ },
73
+ "./translations": {
74
+ "source": "./src/translations.ts",
75
+ "types": "./dist/types/src/translations.d.ts",
76
+ "default": "./dist/lib/neutral/translations.mjs"
44
77
  }
45
78
  },
46
79
  "types": "dist/types/src/index.d.ts",
@@ -52,19 +85,19 @@
52
85
  "@effect-atom/atom": "^0.5.1",
53
86
  "@fluentui/react-tabster": "9.26.11",
54
87
  "react-joyride": "^2.7.2",
55
- "@dxos/app-toolkit": "0.8.4-main.422d1c7879",
56
- "@dxos/app-graph": "0.8.4-main.422d1c7879",
57
- "@dxos/app-framework": "0.8.4-main.422d1c7879",
58
- "@dxos/keyboard": "0.8.4-main.422d1c7879",
59
- "@dxos/debug": "0.8.4-main.422d1c7879",
60
- "@dxos/echo": "0.8.4-main.422d1c7879",
61
- "@dxos/plugin-client": "0.8.4-main.422d1c7879",
62
- "@dxos/operation": "0.8.4-main.422d1c7879",
63
- "@dxos/plugin-space": "0.8.4-main.422d1c7879",
64
- "@dxos/plugin-graph": "0.8.4-main.422d1c7879",
65
- "@dxos/react-client": "0.8.4-main.422d1c7879",
66
- "@dxos/util": "0.8.4-main.422d1c7879",
67
- "@dxos/effect": "0.8.4-main.422d1c7879"
88
+ "@dxos/app-graph": "0.8.4-main.4f23b4e393",
89
+ "@dxos/app-framework": "0.8.4-main.4f23b4e393",
90
+ "@dxos/compute": "0.8.4-main.4f23b4e393",
91
+ "@dxos/echo": "0.8.4-main.4f23b4e393",
92
+ "@dxos/effect": "0.8.4-main.4f23b4e393",
93
+ "@dxos/keyboard": "0.8.4-main.4f23b4e393",
94
+ "@dxos/debug": "0.8.4-main.4f23b4e393",
95
+ "@dxos/plugin-graph": "0.8.4-main.4f23b4e393",
96
+ "@dxos/plugin-client": "0.8.4-main.4f23b4e393",
97
+ "@dxos/plugin-space": "0.8.4-main.4f23b4e393",
98
+ "@dxos/react-client": "0.8.4-main.4f23b4e393",
99
+ "@dxos/util": "0.8.4-main.4f23b4e393",
100
+ "@dxos/app-toolkit": "0.8.4-main.4f23b4e393"
68
101
  },
69
102
  "devDependencies": {
70
103
  "@effect-atom/atom-react": "^0.5.0",
@@ -76,12 +109,12 @@
76
109
  "react-dom": "~19.2.3",
77
110
  "react-floater": "0.7.9",
78
111
  "type-fest": "4.10.1",
79
- "vite": "^7.1.11",
80
- "@dxos/react-ui": "0.8.4-main.422d1c7879",
81
- "@dxos/random": "0.8.4-main.422d1c7879",
82
- "@dxos/storybook-utils": "0.8.4-main.422d1c7879",
83
- "@dxos/ui-theme": "0.8.4-main.422d1c7879",
84
- "@dxos/plugin-testing": "0.8.4-main.422d1c7879"
112
+ "vite": "^8.0.10",
113
+ "@dxos/plugin-testing": "0.8.4-main.4f23b4e393",
114
+ "@dxos/random": "0.8.4-main.4f23b4e393",
115
+ "@dxos/react-ui": "0.8.4-main.4f23b4e393",
116
+ "@dxos/storybook-utils": "0.8.4-main.4f23b4e393",
117
+ "@dxos/ui-theme": "0.8.4-main.4f23b4e393"
85
118
  },
86
119
  "peerDependencies": {
87
120
  "@effect-atom/atom-react": "^0.5.0",
@@ -89,8 +122,8 @@
89
122
  "effect": "3.20.0",
90
123
  "react": "~19.2.3",
91
124
  "react-dom": "~19.2.3",
92
- "@dxos/react-ui": "0.8.4-main.422d1c7879",
93
- "@dxos/ui-theme": "0.8.4-main.422d1c7879"
125
+ "@dxos/react-ui": "0.8.4-main.4f23b4e393",
126
+ "@dxos/ui-theme": "0.8.4-main.4f23b4e393"
94
127
  },
95
128
  "publishConfig": {
96
129
  "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
+ });
@@ -7,10 +7,9 @@ import { AppPlugin } from '@dxos/app-toolkit';
7
7
 
8
8
  import { AppGraphBuilder, HelpState, OperationHandler, ReactRoot, ReactSurface } from '#capabilities';
9
9
  import { meta } from '#meta';
10
+ import { translations } from '#translations';
10
11
  import { type Step } from '#types';
11
12
 
12
- import { translations } from './translations';
13
-
14
13
  export type HelpPluginOptions = { steps?: Step[] };
15
14
 
16
15
  export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
@@ -29,3 +28,5 @@ export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
29
28
  })),
30
29
  Plugin.make,
31
30
  );
31
+
32
+ export default HelpPlugin;
@@ -7,11 +7,10 @@ import * as Effect from 'effect/Effect';
7
7
  import { Capabilities, Capability } from '@dxos/app-framework';
8
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
12
  import { meta } from '#meta';
13
- import { HelpOperation } from '#operations';
14
- import { HelpCapabilities } from '#types';
13
+ import { HelpCapabilities, HelpOperation } from '#types';
15
14
 
16
15
  import { SHORTCUTS_DIALOG } from '../constants';
17
16
 
@@ -3,7 +3,7 @@
3
3
  //
4
4
 
5
5
  import { Capability } from '@dxos/app-framework';
6
- import { OperationHandlerSet } from '@dxos/operation';
6
+ import { OperationHandlerSet } from '@dxos/compute';
7
7
 
8
8
  export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
9
9
  export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
@@ -5,7 +5,7 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities, Capability } from '@dxos/app-framework';
8
- import type { OperationHandlerSet } from '@dxos/operation';
8
+ import type { OperationHandlerSet } from '@dxos/compute';
9
9
 
10
10
  import { HelpOperationHandlerSet } from '#operations';
11
11
 
@@ -13,7 +13,7 @@ import { Key } from './Key';
13
13
  const Shortcut = ({ binding }: { binding: KeyBinding }) => {
14
14
  const { t } = useTranslation(osTranslations);
15
15
  return (
16
- <div role='none' className='flex items-center gap-2 whitespace-nowrap'>
16
+ <div className='flex items-center gap-2 whitespace-nowrap'>
17
17
  <Key binding={binding.shortcut} />
18
18
  <span className='text-sm'>{toLocalizedString(binding.data, t)}</span>
19
19
  </div>
@@ -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 px-2 gap-4'>
30
+ <div className='flex overflow-hidden px-2 gap-4'>
31
31
  {hints.map((binding) => (
32
32
  <Shortcut key={binding.shortcut} binding={binding} />
33
33
  ))}
@@ -38,7 +38,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
38
38
 
39
39
  return (
40
40
  <div
41
- className='flex flex-col w-[15rem] min-h-[10rem] overflow-hidden rounded-md shadow-xl bg-accent-surface text-accent-surface-text'
41
+ className='flex flex-col w-[15rem] min-h-[10rem] overflow-hidden rounded-md shadow-xl bg-accent-surface text-accent-foreground'
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 px-2 py-1 text-lg font-medium text-accent-surface-text'>{title}</h2>
49
+ <h2 className='grow px-2 py-1 text-lg font-medium text-accent-foreground'>{title}</h2>
50
50
  <IconButton
51
51
  density='fine'
52
52
  icon='ph--x--bold'
@@ -9,7 +9,8 @@ import { withPluginManager } from '@dxos/app-framework/testing';
9
9
  import { Dialog } from '@dxos/react-ui';
10
10
  import { withTheme } from '@dxos/react-ui/testing';
11
11
 
12
- import { translations } from '../../translations';
12
+ import { translations } from '#translations';
13
+
13
14
  import { ShortcutsDialogContent } from './ShortcutsDialogContent';
14
15
 
15
16
  const DefaultStory = () => (
package/src/index.ts CHANGED
@@ -2,10 +2,7 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- export { HelpCapabilities } from './types';
6
- export * from './components';
7
5
  export * from './constants';
8
6
  export * from './meta';
9
- export * from './HelpPlugin';
10
- export * from './hooks';
7
+ export * from './operations';
11
8
  export * from './types';
package/src/meta.ts CHANGED
@@ -13,4 +13,5 @@ export const meta: Plugin.Meta = {
13
13
  Access keyboard shortcuts, feature guides, and support resources.
14
14
  `,
15
15
  icon: 'ph--info--regular',
16
+ tags: ['system'],
16
17
  };
@@ -2,8 +2,6 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { OperationHandlerSet } from '@dxos/operation';
6
-
7
- export * as HelpOperation from './definitions';
5
+ import { OperationHandlerSet } from '@dxos/compute';
8
6
 
9
7
  export const HelpOperationHandlerSet = OperationHandlerSet.lazy(() => import('./start'));
@@ -5,12 +5,11 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities } from '@dxos/app-framework';
8
- import { Operation } from '@dxos/operation';
8
+ import { Operation } from '@dxos/compute';
9
9
 
10
- import { HelpCapabilities } from '../types';
11
- import { Start } from './definitions';
10
+ import { HelpCapabilities, HelpOperation } from '../types';
12
11
 
13
- const handler: Operation.WithHandler<typeof Start> = Start.pipe(
12
+ const handler: Operation.WithHandler<typeof HelpOperation.Start> = HelpOperation.Start.pipe(
14
13
  Operation.withHandler(
15
14
  Effect.fnUntraced(function* () {
16
15
  yield* Capabilities.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
package/src/plugin.ts ADDED
@@ -0,0 +1,12 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { Plugin } from '@dxos/app-framework';
6
+
7
+ import { meta } from './meta';
8
+
9
+ export const HelpPlugin = Plugin.lazy(meta, () => import('#plugin'));
10
+ export type { HelpPluginOptions } from '#plugin';
11
+
12
+ export { HelpOperationHandlerSet } from './operations';
@@ -0,0 +1,24 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ // @import-as-namespace
6
+
7
+ import { type Atom } from '@effect-atom/atom-react';
8
+ import * as Schema from 'effect/Schema';
9
+
10
+ import { Capability } from '@dxos/app-framework';
11
+
12
+ import { meta } from '#meta';
13
+
14
+ export const StateSchema = Schema.mutable(
15
+ Schema.Struct({
16
+ running: Schema.Boolean,
17
+ showHints: Schema.Boolean,
18
+ showWelcome: Schema.Boolean,
19
+ }),
20
+ );
21
+
22
+ export type State = Schema.Schema.Type<typeof StateSchema>;
23
+
24
+ export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);
@@ -2,10 +2,12 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
+ // @import-as-namespace
6
+
5
7
  import * as Schema from 'effect/Schema';
6
8
 
7
9
  import { Capability } from '@dxos/app-framework';
8
- import { Operation } from '@dxos/operation';
10
+ import { Operation } from '@dxos/compute';
9
11
 
10
12
  import { meta } from '#meta';
11
13
 
@@ -2,5 +2,6 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- export * from './capabilities';
5
+ export * as HelpCapabilities from './HelpCapabilities';
6
+ export * as HelpOperation from './HelpOperation';
6
7
  export * from './schema';
@@ -1,34 +0,0 @@
1
- // src/types/capabilities.ts
2
- import * as Schema from "effect/Schema";
3
- import { Capability } from "@dxos/app-framework";
4
- import { meta } from "#meta";
5
- (function(HelpCapabilities2) {
6
- HelpCapabilities2.StateSchema = Schema.mutable(Schema.Struct({
7
- running: Schema.Boolean,
8
- showHints: Schema.Boolean,
9
- showWelcome: Schema.Boolean
10
- }));
11
- HelpCapabilities2.State = Capability.make(`${meta.id}.capability.state`);
12
- })(HelpCapabilities || (HelpCapabilities = {}));
13
- var HelpCapabilities;
14
-
15
- // src/types/schema.ts
16
- import { createContext } from "react";
17
- var HelpContext = createContext({
18
- running: false,
19
- steps: [],
20
- setSteps: () => {
21
- },
22
- setIndex: () => {
23
- },
24
- start: () => {
25
- },
26
- stop: () => {
27
- }
28
- });
29
-
30
- export {
31
- HelpCapabilities,
32
- HelpContext
33
- };
34
- //# sourceMappingURL=chunk-K4LQ2TR7.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/types/capabilities.ts", "../../../src/types/schema.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { type Atom } from '@effect-atom/atom-react';\nimport * as Schema from 'effect/Schema';\n\nimport { Capability } from '@dxos/app-framework';\n\nimport { meta } from '#meta';\n\nexport namespace HelpCapabilities {\n export const StateSchema = Schema.mutable(\n Schema.Struct({\n running: Schema.Boolean,\n showHints: Schema.Boolean,\n showWelcome: Schema.Boolean,\n }),\n );\n\n export type State = Schema.Schema.Type<typeof StateSchema>;\n\n export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);\n}\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { type CapabilityManager } from '@dxos/app-framework';\n\nexport type Step = BaseStep & {\n before?: (capabilities: CapabilityManager.CapabilityManager) => void;\n};\n\nexport type HelpContextType = {\n running: boolean;\n steps: Step[];\n setSteps: (steps: Step[]) => void;\n setIndex: (index: number) => void;\n start: () => void;\n stop: () => void;\n};\n\nexport const HelpContext: Context<HelpContextType> = createContext<HelpContextType>({\n running: false,\n steps: [],\n setSteps: () => {},\n setIndex: () => {},\n start: () => {},\n stop: () => {},\n});\n"],
5
- "mappings": ";AAKA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;AAE3B,SAASC,YAAY;UAEJC,mBAAAA;oBACFC,cAAqBC,eACzBC,cAAO;IACZC,SAAgBC;IAChBC,WAAkBD;IAClBE,aAAoBF;EACtB,CAAA,CAAA;oBAKWG,QAAQC,WAAWC,KAA2B,GAAGC,KAAKC,EAAE,mBAAmB;AAC1F,GAZiBZ,qBAAAA,mBAAAA,CAAAA,EAAAA;;;;ACPjB,SAAuBa,qBAAqB;AAkBrC,IAAMC,cAAwCC,cAA+B;EAClFC,SAAS;EACTC,OAAO,CAAA;EACPC,UAAU,MAAA;EAAO;EACjBC,UAAU,MAAA;EAAO;EACjBC,OAAO,MAAA;EAAO;EACdC,MAAM,MAAA;EAAO;AACf,CAAA;",
6
- "names": ["Schema", "Capability", "meta", "HelpCapabilities", "StateSchema", "mutable", "Struct", "running", "Boolean", "showHints", "showWelcome", "State", "Capability", "make", "meta", "id", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop"]
7
- }
@@ -1,31 +0,0 @@
1
- import {
2
- __export
3
- } from "./chunk-J5LGTIGS.mjs";
4
-
5
- // src/operations/definitions.ts
6
- var definitions_exports = {};
7
- __export(definitions_exports, {
8
- Start: () => Start
9
- });
10
- import * as Schema from "effect/Schema";
11
- import { Capability } from "@dxos/app-framework";
12
- import { Operation } from "@dxos/operation";
13
- import { meta } from "#meta";
14
- var HELP_OPERATION = `${meta.id}.operation`;
15
- var Start = Operation.make({
16
- meta: {
17
- key: `${HELP_OPERATION}.start`,
18
- name: "Start Help"
19
- },
20
- services: [
21
- Capability.Service
22
- ],
23
- input: Schema.Void,
24
- output: Schema.Void
25
- });
26
-
27
- export {
28
- Start,
29
- definitions_exports
30
- };
31
- //# sourceMappingURL=chunk-KUUIRJG5.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/operations/definitions.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\n\nimport { Capability } from '@dxos/app-framework';\nimport { Operation } from '@dxos/operation';\n\nimport { meta } from '#meta';\n\nconst HELP_OPERATION = `${meta.id}.operation`;\n\nexport const Start = Operation.make({\n meta: { key: `${HELP_OPERATION}.start`, name: 'Start Help' },\n services: [Capability.Service],\n input: Schema.Void,\n output: Schema.Void,\n});\n"],
5
- "mappings": ";;;;;AAAA;;;;AAIA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;AAC3B,SAASC,iBAAiB;AAE1B,SAASC,YAAY;AAErB,IAAMC,iBAAiB,GAAGC,KAAKC,EAAE;AAE1B,IAAMC,QAAQC,UAAUC,KAAK;EAClCJ,MAAM;IAAEK,KAAK,GAAGN,cAAAA;IAAwBO,MAAM;EAAa;EAC3DC,UAAU;IAACC,WAAWC;;EACtBC,OAAcC;EACdC,QAAeD;AACjB,CAAA;",
6
- "names": ["Schema", "Capability", "Operation", "meta", "HELP_OPERATION", "meta", "id", "Start", "Operation", "make", "key", "name", "services", "Capability", "Service", "input", "Void", "output"]
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/components/Shortcuts/ShortcutsHints.tsx", "../../../src/components/Shortcuts/Key.tsx", "../../../src/components/Shortcuts/styles.ts", "../../../src/components/Shortcuts/ShortcutsList.tsx", "../../../src/components/Shortcuts/ShortcutsSection.tsx", "../../../src/components/Tooltip/Tooltip.tsx", "../../../src/components/WelcomeTour/WelcomeTour.tsx", "../../../src/constants.ts", "../../../src/HelpPlugin.tsx", "../../../src/translations.ts", "../../../src/hooks/useHelp.tsx"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type KeyBinding, Keyboard } from '@dxos/keyboard';\nimport { IconButton, toLocalizedString, useTranslation } from '@dxos/react-ui';\nimport { osTranslations } from '@dxos/ui-theme';\n\nimport { Key } from './Key';\n\nconst Shortcut = ({ binding }: { binding: KeyBinding }) => {\n const { t } = useTranslation(osTranslations);\n return (\n <div role='none' className='flex items-center gap-2 whitespace-nowrap'>\n <Key binding={binding.shortcut} />\n <span className='text-sm'>{toLocalizedString(binding.data, t)}</span>\n </div>\n );\n};\n\nexport const ShortcutsHints = ({ onClose }: { onClose?: () => void }) => {\n // TODO(burdon): Display by context/weight/cycle.\n const defaults = ['meta+k', 'meta+/', 'meta+,'];\n const bindings = Keyboard.singleton.getBindings();\n const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));\n\n return (\n <div role='none' className='flex overflow-hidden px-2 gap-4'>\n {hints.map((binding) => (\n <Shortcut key={binding.shortcut} binding={binding} />\n ))}\n {onClose && (\n <IconButton\n icon='ph--x--regular'\n size={4}\n label='Close'\n iconOnly\n noTooltip\n variant='ghost'\n classNames='p-0 cursor-pointer'\n onClick={onClose}\n />\n )}\n </div>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { keySymbols } from '@dxos/keyboard';\n\nimport { shortcutKey } from './styles';\n\nexport const Key = ({ binding }: { binding: string }) => {\n return (\n <span role='term' className='inline-flex gap-1' aria-label={binding} id={binding}>\n {keySymbols(binding).map((c, i) => (\n <span key={i} className={shortcutKey}>\n {c}\n </span>\n ))}\n </span>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { mx } from '@dxos/ui-theme';\n\nexport const shortcutKey = mx(\n 'inline-flex min-w-[24px] h-[24px] px-0.5 justify-center items-center text-xs',\n 'rounded-sm bg-neutral-100 dark:bg-neutral-900',\n);\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React, { Fragment } from 'react';\n\nimport { Keyboard } from '@dxos/keyboard';\nimport { toLocalizedString, useTranslation } from '@dxos/react-ui';\nimport { mx } from '@dxos/ui-theme';\n\nimport { meta } from '#meta';\n\nimport { Key } from './Key';\n\nexport const ShortcutsList = () => {\n const { t } = useTranslation(meta.id);\n const bindings = Keyboard.singleton.getBindings();\n\n // TODO(burdon): Get shortcuts from TextEditor.\n bindings.sort((a, b) => {\n return toLocalizedString(a.data, t)?.toLowerCase().localeCompare(toLocalizedString(b.data, t)?.toLowerCase());\n });\n\n return (\n <dl className={mx('w-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 my-4 text-subdued select-none')}>\n {bindings.map((binding, i) => (\n <Fragment key={i}>\n <Key binding={binding.shortcut} />\n <span role='definition' className='ms-4' aria-labelledby={binding.shortcut}>\n {toLocalizedString(binding.data, t)}\n </span>\n </Fragment>\n ))}\n </dl>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { ShortcutsList } from './ShortcutsList';\n\nexport const ShortcutsSection = () => {\n return (\n <section className='text-description'>\n <ShortcutsList />\n </section>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useArrowNavigationGroup, useFocusableGroup } from '@fluentui/react-tabster';\nimport React, { forwardRef } from 'react';\n// 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.\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport _floater from 'react-floater';\nimport { type Props, type TooltipRenderProps } from 'react-joyride';\n// 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.\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport _typefest from 'type-fest';\n\nimport { Button, Icon, IconButton } from '@dxos/react-ui';\n\n// https://docs.react-joyride.com/styling\n// https://github.com/gilbarbara/react-floater\nexport const floaterProps: Props['floaterProps'] = {\n styles: {\n // Arrow color is set by joyride.\n arrow: {\n length: 8,\n spread: 16,\n },\n floater: {\n // TODO(burdon): Get tokens from theme.\n filter: 'drop-shadow(0 0 0.75rem rgba(0, 0, 0, 0.2))',\n },\n },\n};\n\n// TODO(burdon): Add info link to docs.\nexport const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(\n ({ step: { title, content }, index, size, isLastStep, backProps, closeProps, primaryProps }, forwardedRef) => {\n const arrowNavigationAttrs = useArrowNavigationGroup({ axis: 'horizontal' });\n const focusableGroupAttrs = useFocusableGroup({ tabBehavior: 'limited-trap-focus' });\n\n return (\n <div\n className='flex flex-col w-[15rem] min-h-[10rem] overflow-hidden rounded-md shadow-xl bg-accent-surface text-accent-surface-text'\n role='tooltip'\n data-testid='helpPlugin.tooltip'\n data-step={index + 1}\n {...focusableGroupAttrs}\n ref={forwardedRef}\n >\n <div className='flex p-2'>\n <h2 className='grow px-2 py-1 text-lg font-medium text-accent-surface-text'>{title}</h2>\n <IconButton\n density='fine'\n icon='ph--x--bold'\n iconOnly\n label={closeProps['aria-label']}\n onClick={closeProps.onClick}\n size={4}\n variant='primary'\n data-testid='helpPlugin.tooltip.close'\n />\n </div>\n <div className='flex grow px-4 my-2'>{content}</div>\n <div className='flex p-2 items-center justify-between' {...arrowNavigationAttrs}>\n {\n <IconButton\n classNames={[!(index > 0 && backProps) && 'invisible']}\n icon='ph--caret-left--regular'\n iconOnly\n label={backProps['aria-label']}\n onClick={backProps.onClick}\n variant='primary'\n data-testid='helpPlugin.tooltip.back'\n />\n }\n <div className='flex grow gap-2 justify-center'>\n <div className='flex'>\n {Array.from({ length: size }).map((_, i) => (\n <Icon\n key={i}\n icon={index === i ? 'ph--circle--fill' : 'ph--circle--regular'}\n size={2}\n classNames='mx-1 cursor-pointer'\n />\n ))}\n </div>\n </div>\n {isLastStep ? (\n <Button\n variant='primary'\n onClick={closeProps.onClick}\n title={closeProps['aria-label']}\n autoFocus\n data-testid='helpPlugin.tooltip.finish'\n >\n Done\n </Button>\n ) : (\n <IconButton\n autoFocus\n icon='ph--caret-right--regular'\n iconOnly\n label={primaryProps['aria-label']}\n onClick={primaryProps.onClick}\n size={6}\n variant='primary'\n data-testid='helpPlugin.tooltip.next'\n />\n )}\n </div>\n </div>\n );\n },\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { useState } from 'react';\nimport Joyride, { ACTIONS, EVENTS } from 'react-joyride';\n\nimport { usePluginManager } from '@dxos/app-framework/ui';\nimport { useLayout } from '@dxos/app-toolkit/ui';\nimport { useAsyncEffect } from '@dxos/react-ui';\n\nimport { HelpContext, type Step } from '#types';\n\nimport { Tooltip, floaterProps } from '../Tooltip';\n\nconst addStepClass = (target: string | HTMLElement) => {\n const element = typeof target === 'string' ? document.querySelector(target) : target;\n if (element) {\n element.classList.add('joyride-target');\n }\n};\n\nconst removeTargetClass = (target: string | HTMLElement) => {\n const element = typeof target === 'string' ? document.querySelector(target) : target;\n if (element) {\n element.classList.remove('joyride-target');\n }\n};\n\nconst getTarget = (step: Step) => {\n return typeof step.target === 'string' ? document.querySelector(step.target) : step.target;\n};\n\n/**\n * Wait for the target element to be in the document.\n */\nconst waitForTarget = async (step: Step) => {\n if (typeof step.target === 'string') {\n const target = step.target;\n const element = document.querySelector(target);\n if (element) {\n return;\n }\n\n await new Promise<void>((resolve) => {\n const observer = new MutationObserver((mutations) => {\n mutations.forEach((mutation) => {\n if (mutation.addedNodes.length > 0) {\n const element = document.querySelector(target);\n if (element) {\n observer.disconnect();\n resolve();\n }\n }\n });\n });\n\n observer.observe(document.body, { childList: true, subtree: true });\n });\n }\n};\n\nexport type WelcomeTourProps = {\n steps: Step[];\n running?: boolean;\n onRunningChanged?: (state: boolean) => any;\n};\n\nexport const WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunningChanged }: WelcomeTourProps) => {\n const manager = usePluginManager();\n const layout = useLayout();\n const [running, setRunning] = useState(!!runningProp && !!getTarget(initialSteps[0]));\n const [stepIndex, _setStepIndex] = useState(0);\n const [steps, setSteps] = useState(initialSteps);\n\n const paused = layout.dialogOpen;\n\n const setStepIndex = (index: number) => {\n if (runningProp) {\n const step = steps[index];\n step?.before?.(manager.capabilities);\n }\n _setStepIndex(index);\n };\n\n const setRunningChanged = (state: boolean) => {\n if (typeof runningProp !== 'undefined') {\n onRunningChanged?.(state);\n } else {\n if (state) {\n setStepIndex(0);\n setRunning(true);\n } else {\n setRunning(false);\n }\n }\n };\n\n useAsyncEffect(async () => {\n if (runningProp) {\n // This handles the case when the target is not yet in the document.\n // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.\n await waitForTarget(steps[stepIndex]);\n setStepIndex(0);\n setRunning(true);\n } else if (typeof runningProp !== 'undefined') {\n setRunning(false);\n }\n }, [runningProp]);\n\n // https://docs.react-joyride.com/callback\n const callback: Joyride['callback'] = async (options) => {\n const { type, action, index, size } = options;\n switch (type) {\n case EVENTS.STEP_BEFORE:\n addStepClass(options.step.target);\n break;\n case EVENTS.TOUR_END:\n break;\n case EVENTS.STEP_AFTER:\n removeTargetClass(options.step.target);\n switch (action) {\n case ACTIONS.NEXT:\n if (index < size - 1) {\n setStepIndex(index + 1);\n }\n break;\n case ACTIONS.PREV:\n if (index > 0) {\n setStepIndex(index - 1);\n }\n break;\n case ACTIONS.CLOSE:\n setRunningChanged(false);\n setStepIndex(0);\n break;\n }\n break;\n }\n };\n\n return (\n <HelpContext.Provider\n value={{\n running: running && !paused,\n steps,\n setSteps,\n setIndex: setStepIndex,\n start: () => setRunningChanged(true),\n stop: () => setRunningChanged(false),\n }}\n >\n <style>\n {`.joyride-target {\n --controls-opacity: 1;\n }`}\n </style>\n <Joyride\n continuous={true}\n steps={steps}\n stepIndex={stepIndex}\n run={running && !paused}\n callback={callback}\n floaterProps={floaterProps}\n tooltipComponent={Tooltip}\n spotlightPadding={0}\n />\n </HelpContext.Provider>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { meta } from '#meta';\n\nexport const SHORTCUTS_DIALOG = `${meta.id}.ShortcutsDialog`;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { ActivationEvents, Plugin } from '@dxos/app-framework';\nimport { AppPlugin } from '@dxos/app-toolkit';\n\nimport { AppGraphBuilder, HelpState, OperationHandler, ReactRoot, ReactSurface } from '#capabilities';\nimport { meta } from '#meta';\nimport { type Step } from '#types';\n\nimport { translations } from './translations';\n\nexport type HelpPluginOptions = { steps?: Step[] };\n\nexport const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(\n AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),\n AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),\n AppPlugin.addSurfaceModule({ activate: ReactSurface }),\n AppPlugin.addTranslationsModule({ translations }),\n Plugin.addModule({\n activatesOn: ActivationEvents.Startup,\n activate: HelpState,\n }),\n Plugin.addModule(({ steps = [] }) => ({\n id: 'react-root',\n activatesOn: ActivationEvents.Startup,\n activate: () => ReactRoot(steps),\n })),\n Plugin.make,\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Resource } from '@dxos/react-ui';\n\nimport { meta } from '#meta';\n\nexport const translations = [\n {\n 'en-US': {\n [meta.id]: {\n 'plugin.name': 'Help',\n 'open-help-tour.message': 'Show welcome tour',\n 'open-shortcuts.label': 'Show shortcuts',\n 'shortcuts-dialog.title': 'Shortcuts',\n },\n },\n },\n] as const satisfies Resource[];\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useContext } from 'react';\n\nimport { raise } from '@dxos/debug';\n\nimport { HelpContext } from '#types';\n\nexport const useHelp = () => {\n return useContext(HelpContext) ?? raise(new Error('Missing HelpContext'));\n};\n"],
5
- "mappings": ";;;;;;;;;;AAIA,OAAOA,YAAW;AAElB,SAA0BC,gBAAgB;AAC1C,SAASC,YAAYC,mBAAmBC,sBAAsB;AAC9D,SAASC,sBAAsB;;;ACJ/B,OAAOC,WAAW;AAElB,SAASC,kBAAkB;;;ACF3B,SAASC,UAAU;AAEZ,IAAMC,cAAcC,GACzB,gFACA,+CAAA;;;ADEK,IAAMC,MAAM,CAAC,EAAEC,QAAO,MAAuB;AAClD,SACE,sBAAA,cAACC,QAAAA;IAAKC,MAAK;IAAOC,WAAU;IAAoBC,cAAYJ;IAASK,IAAIL;KACtEM,WAAWN,OAAAA,EAASO,IAAI,CAACC,GAAGC,MAC3B,sBAAA,cAACR,QAAAA;IAAKS,KAAKD;IAAGN,WAAWQ;KACtBH,CAAAA,CAAAA,CAAAA;AAKX;;;ADRA,IAAMI,WAAW,CAAC,EAAEC,QAAO,MAA2B;AACpD,QAAM,EAAEC,EAAC,IAAKC,eAAeC,cAAAA;AAC7B,SACE,gBAAAC,OAAA,cAACC,OAAAA;IAAIC,MAAK;IAAOC,WAAU;KACzB,gBAAAH,OAAA,cAACI,KAAAA;IAAIR,SAASA,QAAQS;MACtB,gBAAAL,OAAA,cAACM,QAAAA;IAAKH,WAAU;KAAWI,kBAAkBX,QAAQY,MAAMX,CAAAA,CAAAA,CAAAA;AAGjE;AAEO,IAAMY,iBAAiB,CAAC,EAAEC,QAAO,MAA4B;AAElE,QAAMC,WAAW;IAAC;IAAU;IAAU;;AACtC,QAAMC,WAAWC,SAASC,UAAUC,YAAW;AAC/C,QAAMC,QAAQJ,SAASK,OAAO,CAACrB,YAAYe,SAASO,SAAStB,QAAQS,QAAQ,CAAA;AAE7E,SACE,gBAAAL,OAAA,cAACC,OAAAA;IAAIC,MAAK;IAAOC,WAAU;KACxBa,MAAMG,IAAI,CAACvB,YACV,gBAAAI,OAAA,cAACL,UAAAA;IAASyB,KAAKxB,QAAQS;IAAUT;OAElCc,WACC,gBAAAV,OAAA,cAACqB,YAAAA;IACCC,MAAK;IACLC,MAAM;IACNC,OAAM;IACNC,UAAAA;IACAC,WAAAA;IACAC,SAAQ;IACRC,YAAW;IACXC,SAASnB;;AAKnB;;;AG3CA,OAAOoB,UAASC,gBAAgB;AAEhC,SAASC,YAAAA,iBAAgB;AACzB,SAASC,qBAAAA,oBAAmBC,kBAAAA,uBAAsB;AAClD,SAASC,MAAAA,WAAU;AAEnB,SAASC,QAAAA,aAAY;AAId,IAAMC,gBAAgB,MAAA;AAC3B,QAAM,EAAEC,EAAC,IAAKC,gBAAeC,MAAKC,EAAE;AACpC,QAAMC,WAAWC,UAASC,UAAUC,YAAW;AAG/CH,WAASI,KAAK,CAACC,GAAGC,MAAAA;AAChB,WAAOC,mBAAkBF,EAAEG,MAAMZ,CAAAA,GAAIa,YAAAA,EAAcC,cAAcH,mBAAkBD,EAAEE,MAAMZ,CAAAA,GAAIa,YAAAA,CAAAA;EACjG,CAAA;AAEA,SACE,gBAAAE,OAAA,cAACC,MAAAA;IAAGC,WAAWC,IAAG,0FAAA;KACfd,SAASe,IAAI,CAACC,SAASC,MACtB,gBAAAN,OAAA,cAACO,UAAAA;IAASC,KAAKF;KACb,gBAAAN,OAAA,cAACS,KAAAA;IAAIJ,SAASA,QAAQK;MACtB,gBAAAV,OAAA,cAACW,QAAAA;IAAKC,MAAK;IAAaV,WAAU;IAAOW,mBAAiBR,QAAQK;KAC/Dd,mBAAkBS,QAAQR,MAAMZ,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA;AAM7C;;;AC/BA,OAAO6B,YAAW;AAIX,IAAMC,mBAAmB,MAAA;AAC9B,SACE,gBAAAC,OAAA,cAACC,WAAAA;IAAQC,WAAU;KACjB,gBAAAF,OAAA,cAACG,eAAAA,IAAAA,CAAAA;AAGP;;;ACVA,SAASC,yBAAyBC,yBAAyB;AAC3D,OAAOC,UAASC,kBAAkB;AASlC,SAASC,QAAQC,MAAMC,cAAAA,mBAAkB;AAIlC,IAAMC,eAAsC;EACjDC,QAAQ;;IAENC,OAAO;MACLC,QAAQ;MACRC,QAAQ;IACV;IACAC,SAAS;;MAEPC,QAAQ;IACV;EACF;AACF;AAGO,IAAMC,UAAUC,2BACrB,CAAC,EAAEC,MAAM,EAAEC,OAAOC,QAAO,GAAIC,OAAOC,MAAMC,YAAYC,WAAWC,YAAYC,aAAY,GAAIC,iBAAAA;AAC3F,QAAMC,uBAAuBC,wBAAwB;IAAEC,MAAM;EAAa,CAAA;AAC1E,QAAMC,sBAAsBC,kBAAkB;IAAEC,aAAa;EAAqB,CAAA;AAElF,SACE,gBAAAC,OAAA,cAACC,OAAAA;IACCC,WAAU;IACVC,MAAK;IACLC,eAAY;IACZC,aAAWlB,QAAQ;IAClB,GAAGU;IACJS,KAAKb;KAEL,gBAAAO,OAAA,cAACC,OAAAA;IAAIC,WAAU;KACb,gBAAAF,OAAA,cAACO,MAAAA;IAAGL,WAAU;KAA+DjB,KAAAA,GAC7E,gBAAAe,OAAA,cAACQ,aAAAA;IACCC,SAAQ;IACRC,MAAK;IACLC,UAAAA;IACAC,OAAOrB,WAAW,YAAA;IAClBsB,SAAStB,WAAWsB;IACpBzB,MAAM;IACN0B,SAAQ;IACRV,eAAY;OAGhB,gBAAAJ,OAAA,cAACC,OAAAA;IAAIC,WAAU;KAAuBhB,OAAAA,GACtC,gBAAAc,OAAA,cAACC,OAAAA;IAAIC,WAAU;IAAyC,GAAGR;KAEvD,gBAAAM,OAAA,cAACQ,aAAAA;IACCO,YAAY;MAAC,EAAE5B,QAAQ,KAAKG,cAAc;;IAC1CoB,MAAK;IACLC,UAAAA;IACAC,OAAOtB,UAAU,YAAA;IACjBuB,SAASvB,UAAUuB;IACnBC,SAAQ;IACRV,eAAY;MAGhB,gBAAAJ,OAAA,cAACC,OAAAA;IAAIC,WAAU;KACb,gBAAAF,OAAA,cAACC,OAAAA;IAAIC,WAAU;KACZc,MAAMC,KAAK;IAAEvC,QAAQU;EAAK,CAAA,EAAG8B,IAAI,CAACC,GAAGC,MACpC,gBAAApB,OAAA,cAACqB,MAAAA;IACCC,KAAKF;IACLV,MAAMvB,UAAUiC,IAAI,qBAAqB;IACzChC,MAAM;IACN2B,YAAW;SAKlB1B,aACC,gBAAAW,OAAA,cAACuB,QAAAA;IACCT,SAAQ;IACRD,SAAStB,WAAWsB;IACpB5B,OAAOM,WAAW,YAAA;IAClBiC,WAAAA;IACApB,eAAY;KACb,MAAA,IAID,gBAAAJ,OAAA,cAACQ,aAAAA;IACCgB,WAAAA;IACAd,MAAK;IACLC,UAAAA;IACAC,OAAOpB,aAAa,YAAA;IACpBqB,SAASrB,aAAaqB;IACtBzB,MAAM;IACN0B,SAAQ;IACRV,eAAY;;AAMxB,CAAA;;;AC1GF,OAAOqB,UAASC,gBAAgB;AAChC,OAAOC,WAAWC,SAASC,cAAc;AAEzC,SAASC,wBAAwB;AACjC,SAASC,iBAAiB;AAC1B,SAASC,sBAAsB;AAE/B,SAASC,eAAAA,oBAA8B;AAIvC,IAAMC,eAAe,CAACC,WAAAA;AACpB,QAAMC,UAAU,OAAOD,WAAW,WAAWE,SAASC,cAAcH,MAAAA,IAAUA;AAC9E,MAAIC,SAAS;AACXA,YAAQG,UAAUC,IAAI,gBAAA;EACxB;AACF;AAEA,IAAMC,oBAAoB,CAACN,WAAAA;AACzB,QAAMC,UAAU,OAAOD,WAAW,WAAWE,SAASC,cAAcH,MAAAA,IAAUA;AAC9E,MAAIC,SAAS;AACXA,YAAQG,UAAUG,OAAO,gBAAA;EAC3B;AACF;AAEA,IAAMC,YAAY,CAACC,SAAAA;AACjB,SAAO,OAAOA,KAAKT,WAAW,WAAWE,SAASC,cAAcM,KAAKT,MAAM,IAAIS,KAAKT;AACtF;AAKA,IAAMU,gBAAgB,OAAOD,SAAAA;AAC3B,MAAI,OAAOA,KAAKT,WAAW,UAAU;AACnC,UAAMA,SAASS,KAAKT;AACpB,UAAMC,UAAUC,SAASC,cAAcH,MAAAA;AACvC,QAAIC,SAAS;AACX;IACF;AAEA,UAAM,IAAIU,QAAc,CAACC,YAAAA;AACvB,YAAMC,WAAW,IAAIC,iBAAiB,CAACC,cAAAA;AACrCA,kBAAUC,QAAQ,CAACC,aAAAA;AACjB,cAAIA,SAASC,WAAWC,SAAS,GAAG;AAClC,kBAAMlB,WAAUC,SAASC,cAAcH,MAAAA;AACvC,gBAAIC,UAAS;AACXY,uBAASO,WAAU;AACnBR,sBAAAA;YACF;UACF;QACF,CAAA;MACF,CAAA;AAEAC,eAASQ,QAAQnB,SAASoB,MAAM;QAAEC,WAAW;QAAMC,SAAS;MAAK,CAAA;IACnE,CAAA;EACF;AACF;AAQO,IAAMC,cAAc,CAAC,EAAEC,OAAOC,cAAcC,SAASC,aAAaC,iBAAgB,MAAoB;AAC3G,QAAMC,UAAUC,iBAAAA;AAChB,QAAMC,SAASC,UAAAA;AACf,QAAM,CAACN,SAASO,UAAAA,IAAcC,SAAS,CAAC,CAACP,eAAe,CAAC,CAACrB,UAAUmB,aAAa,CAAA,CAAE,CAAA;AACnF,QAAM,CAACU,WAAWC,aAAAA,IAAiBF,SAAS,CAAA;AAC5C,QAAM,CAACV,OAAOa,QAAAA,IAAYH,SAAST,YAAAA;AAEnC,QAAMa,SAASP,OAAOQ;AAEtB,QAAMC,eAAe,CAACC,UAAAA;AACpB,QAAId,aAAa;AACf,YAAMpB,OAAOiB,MAAMiB,KAAAA;AACnBlC,YAAMmC,SAASb,QAAQc,YAAY;IACrC;AACAP,kBAAcK,KAAAA;EAChB;AAEA,QAAMG,oBAAoB,CAACC,UAAAA;AACzB,QAAI,OAAOlB,gBAAgB,aAAa;AACtCC,yBAAmBiB,KAAAA;IACrB,OAAO;AACL,UAAIA,OAAO;AACTL,qBAAa,CAAA;AACbP,mBAAW,IAAA;MACb,OAAO;AACLA,mBAAW,KAAA;MACb;IACF;EACF;AAEAa,iBAAe,YAAA;AACb,QAAInB,aAAa;AAGf,YAAMnB,cAAcgB,MAAMW,SAAAA,CAAU;AACpCK,mBAAa,CAAA;AACbP,iBAAW,IAAA;IACb,WAAW,OAAON,gBAAgB,aAAa;AAC7CM,iBAAW,KAAA;IACb;EACF,GAAG;IAACN;GAAY;AAGhB,QAAMoB,WAAgC,OAAOC,YAAAA;AAC3C,UAAM,EAAEC,MAAMC,QAAQT,OAAOU,KAAI,IAAKH;AACtC,YAAQC,MAAAA;MACN,KAAKG,OAAOC;AACVxD,qBAAamD,QAAQzC,KAAKT,MAAM;AAChC;MACF,KAAKsD,OAAOE;AACV;MACF,KAAKF,OAAOG;AACVnD,0BAAkB4C,QAAQzC,KAAKT,MAAM;AACrC,gBAAQoD,QAAAA;UACN,KAAKM,QAAQC;AACX,gBAAIhB,QAAQU,OAAO,GAAG;AACpBX,2BAAaC,QAAQ,CAAA;YACvB;AACA;UACF,KAAKe,QAAQE;AACX,gBAAIjB,QAAQ,GAAG;AACbD,2BAAaC,QAAQ,CAAA;YACvB;AACA;UACF,KAAKe,QAAQG;AACXf,8BAAkB,KAAA;AAClBJ,yBAAa,CAAA;AACb;QACJ;AACA;IACJ;EACF;AAEA,SACE,gBAAAoB,OAAA,cAACC,aAAYC,UAAQ;IACnBC,OAAO;MACLrC,SAASA,WAAW,CAACY;MACrBd;MACAa;MACA2B,UAAUxB;MACVyB,OAAO,MAAMrB,kBAAkB,IAAA;MAC/BsB,MAAM,MAAMtB,kBAAkB,KAAA;IAChC;KAEA,gBAAAgB,OAAA,cAACO,SAAAA,MACE;;UAEC,GAEJ,gBAAAP,OAAA,cAACQ,SAAAA;IACCC,YAAY;IACZ7C;IACAW;IACAmC,KAAK5C,WAAW,CAACY;IACjBS;IACAwB;IACAC,kBAAkBC;IAClBC,kBAAkB;;AAI1B;;;ACrKA,SAASC,QAAAA,aAAY;AAEd,IAAMC,mBAAmB,GAAGC,MAAKC,EAAE;;;ACF1C,SAASC,kBAAkBC,cAAc;AACzC,SAASC,iBAAiB;AAE1B,SAASC,iBAAiBC,WAAWC,kBAAkBC,WAAWC,oBAAoB;AACtF,SAASC,QAAAA,aAAY;;;ACFrB,SAASC,QAAAA,aAAY;AAEd,IAAMC,eAAe;EAC1B;IACE,SAAS;MACP,CAACC,MAAKC,EAAE,GAAG;QACT,eAAe;QACf,0BAA0B;QAC1B,wBAAwB;QACxB,0BAA0B;MAC5B;IACF;EACF;;;;ADHK,IAAMC,aAAaC,OAAOC,OAA0BC,KAAAA,EAAMC,KAC/DC,UAAUC,kBAAkB;EAAEC,UAAUC;AAAgB,CAAA,GACxDH,UAAUI,0BAA0B;EAAEF,UAAUG;AAAiB,CAAA,GACjEL,UAAUM,iBAAiB;EAAEJ,UAAUK;AAAa,CAAA,GACpDP,UAAUQ,sBAAsB;EAAEC;AAAa,CAAA,GAC/Cb,OAAOc,UAAU;EACfC,aAAaC,iBAAiBC;EAC9BX,UAAUY;AACZ,CAAA,GACAlB,OAAOc,UAAU,CAAC,EAAEK,QAAQ,CAAA,EAAE,OAAQ;EACpCC,IAAI;EACJL,aAAaC,iBAAiBC;EAC9BX,UAAU,MAAMe,UAAUF,KAAAA;AAC5B,EAAA,GACAnB,OAAOsB,IAAI;;;AEzBb,SAASC,kBAAkB;AAE3B,SAASC,aAAa;AAEtB,SAASC,eAAAA,oBAAmB;AAErB,IAAMC,UAAU,MAAA;AACrB,SAAOC,WAAWC,YAAAA,KAAgBC,MAAM,IAAIC,MAAM,qBAAA,CAAA;AACpD;",
6
- "names": ["React", "Keyboard", "IconButton", "toLocalizedString", "useTranslation", "osTranslations", "React", "keySymbols", "mx", "shortcutKey", "mx", "Key", "binding", "span", "role", "className", "aria-label", "id", "keySymbols", "map", "c", "i", "key", "shortcutKey", "Shortcut", "binding", "t", "useTranslation", "osTranslations", "React", "div", "role", "className", "Key", "shortcut", "span", "toLocalizedString", "data", "ShortcutsHints", "onClose", "defaults", "bindings", "Keyboard", "singleton", "getBindings", "hints", "filter", "includes", "map", "key", "IconButton", "icon", "size", "label", "iconOnly", "noTooltip", "variant", "classNames", "onClick", "React", "Fragment", "Keyboard", "toLocalizedString", "useTranslation", "mx", "meta", "ShortcutsList", "t", "useTranslation", "meta", "id", "bindings", "Keyboard", "singleton", "getBindings", "sort", "a", "b", "toLocalizedString", "data", "toLowerCase", "localeCompare", "React", "dl", "className", "mx", "map", "binding", "i", "Fragment", "key", "Key", "shortcut", "span", "role", "aria-labelledby", "React", "ShortcutsSection", "React", "section", "className", "ShortcutsList", "useArrowNavigationGroup", "useFocusableGroup", "React", "forwardRef", "Button", "Icon", "IconButton", "floaterProps", "styles", "arrow", "length", "spread", "floater", "filter", "Tooltip", "forwardRef", "step", "title", "content", "index", "size", "isLastStep", "backProps", "closeProps", "primaryProps", "forwardedRef", "arrowNavigationAttrs", "useArrowNavigationGroup", "axis", "focusableGroupAttrs", "useFocusableGroup", "tabBehavior", "React", "div", "className", "role", "data-testid", "data-step", "ref", "h2", "IconButton", "density", "icon", "iconOnly", "label", "onClick", "variant", "classNames", "Array", "from", "map", "_", "i", "Icon", "key", "Button", "autoFocus", "React", "useState", "Joyride", "ACTIONS", "EVENTS", "usePluginManager", "useLayout", "useAsyncEffect", "HelpContext", "addStepClass", "target", "element", "document", "querySelector", "classList", "add", "removeTargetClass", "remove", "getTarget", "step", "waitForTarget", "Promise", "resolve", "observer", "MutationObserver", "mutations", "forEach", "mutation", "addedNodes", "length", "disconnect", "observe", "body", "childList", "subtree", "WelcomeTour", "steps", "initialSteps", "running", "runningProp", "onRunningChanged", "manager", "usePluginManager", "layout", "useLayout", "setRunning", "useState", "stepIndex", "_setStepIndex", "setSteps", "paused", "dialogOpen", "setStepIndex", "index", "before", "capabilities", "setRunningChanged", "state", "useAsyncEffect", "callback", "options", "type", "action", "size", "EVENTS", "STEP_BEFORE", "TOUR_END", "STEP_AFTER", "ACTIONS", "NEXT", "PREV", "CLOSE", "React", "HelpContext", "Provider", "value", "setIndex", "start", "stop", "style", "Joyride", "continuous", "run", "floaterProps", "tooltipComponent", "Tooltip", "spotlightPadding", "meta", "SHORTCUTS_DIALOG", "meta", "id", "ActivationEvents", "Plugin", "AppPlugin", "AppGraphBuilder", "HelpState", "OperationHandler", "ReactRoot", "ReactSurface", "meta", "meta", "translations", "meta", "id", "HelpPlugin", "Plugin", "define", "meta", "pipe", "AppPlugin", "addAppGraphModule", "activate", "AppGraphBuilder", "addOperationHandlerModule", "OperationHandler", "addSurfaceModule", "ReactSurface", "addTranslationsModule", "translations", "addModule", "activatesOn", "ActivationEvents", "Startup", "HelpState", "steps", "id", "ReactRoot", "make", "useContext", "raise", "HelpContext", "useHelp", "useContext", "HelpContext", "raise", "Error"]
7
- }