@dxos/plugin-help 0.8.4-main.bc674ce → 0.8.4-main.bcb3aa67d6

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 (141) hide show
  1. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  2. package/dist/lib/browser/chunk-J5LGTIGS.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-K4LQ2TR7.mjs +34 -0
  4. package/dist/lib/browser/chunk-K4LQ2TR7.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-KUUIRJG5.mjs +31 -0
  6. package/dist/lib/browser/chunk-KUUIRJG5.mjs.map +7 -0
  7. package/dist/lib/browser/{chunk-IM2QVQOH.mjs → chunk-TEXIV2IJ.mjs} +2 -2
  8. package/dist/lib/browser/{chunk-IM2QVQOH.mjs.map → chunk-TEXIV2IJ.mjs.map} +1 -1
  9. package/dist/lib/browser/index.mjs +351 -67
  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-YZBO346C.mjs +23 -0
  16. package/dist/lib/browser/start-YZBO346C.mjs.map +7 -0
  17. package/dist/lib/browser/types/index.mjs +4 -6
  18. package/dist/types/src/HelpPlugin.d.ts +1 -1
  19. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  20. package/dist/types/src/capabilities/app-graph-builder.d.ts +6 -0
  21. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -0
  22. package/dist/types/src/capabilities/index.d.ts +18 -5
  23. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  24. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  25. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  26. package/dist/types/src/capabilities/{react-root/react-root.d.ts → react-root.d.ts} +2 -2
  27. package/dist/types/src/capabilities/react-root.d.ts.map +1 -0
  28. package/dist/types/src/capabilities/react-surface.d.ts +5 -0
  29. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -0
  30. package/dist/types/src/capabilities/{state/state.d.ts → state.d.ts} +1 -1
  31. package/dist/types/src/capabilities/state.d.ts.map +1 -0
  32. package/dist/types/src/components/Shortcuts/ShortcutsSection.d.ts.map +1 -1
  33. package/dist/types/src/components/Shortcuts/index.d.ts +0 -1
  34. package/dist/types/src/components/Shortcuts/index.d.ts.map +1 -1
  35. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts +1 -1
  36. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  37. package/dist/types/src/constants.d.ts +2 -0
  38. package/dist/types/src/constants.d.ts.map +1 -0
  39. package/dist/types/src/{components/Shortcuts/ShortcutsDialog.d.ts → containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts} +1 -2
  40. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts.map +1 -0
  41. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +25 -0
  42. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -0
  43. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts +3 -0
  44. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts.map +1 -0
  45. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts +2 -0
  46. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts.map +1 -0
  47. package/dist/types/src/containers/ShortcutsHints/index.d.ts +3 -0
  48. package/dist/types/src/containers/ShortcutsHints/index.d.ts.map +1 -0
  49. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts +2 -0
  50. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts.map +1 -0
  51. package/dist/types/src/containers/ShortcutsList/index.d.ts +3 -0
  52. package/dist/types/src/containers/ShortcutsList/index.d.ts.map +1 -0
  53. package/dist/types/src/containers/index.d.ts +5 -0
  54. package/dist/types/src/containers/index.d.ts.map +1 -0
  55. package/dist/types/src/hooks/useHelp.d.ts +1 -1
  56. package/dist/types/src/hooks/useHelp.d.ts.map +1 -1
  57. package/dist/types/src/index.d.ts +1 -0
  58. package/dist/types/src/index.d.ts.map +1 -1
  59. package/dist/types/src/operations/definitions.d.ts +4 -0
  60. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  61. package/dist/types/src/operations/index.d.ts +4 -0
  62. package/dist/types/src/operations/index.d.ts.map +1 -0
  63. package/dist/types/src/operations/start.d.ts +5 -0
  64. package/dist/types/src/operations/start.d.ts.map +1 -0
  65. package/dist/types/src/translations.d.ts +5 -5
  66. package/dist/types/src/translations.d.ts.map +1 -1
  67. package/dist/types/src/types/schema.d.ts +1 -17
  68. package/dist/types/src/types/schema.d.ts.map +1 -1
  69. package/dist/types/tsconfig.tsbuildinfo +1 -1
  70. package/package.json +46 -28
  71. package/src/HelpPlugin.tsx +12 -10
  72. package/src/capabilities/{app-graph-builder/app-graph-builder.ts → app-graph-builder.ts} +13 -12
  73. package/src/capabilities/index.ts +11 -5
  74. package/src/capabilities/operation-handler.ts +16 -0
  75. package/src/capabilities/{react-root/react-root.tsx → react-root.tsx} +6 -6
  76. package/src/capabilities/{react-surface/react-surface.tsx → react-surface.tsx} +11 -9
  77. package/src/capabilities/{state/state.ts → state.ts} +2 -2
  78. package/src/components/Shortcuts/ShortcutsHints.tsx +1 -1
  79. package/src/components/Shortcuts/ShortcutsList.tsx +3 -3
  80. package/src/components/Shortcuts/ShortcutsSection.tsx +1 -3
  81. package/src/components/Shortcuts/index.ts +0 -1
  82. package/src/components/Shortcuts/styles.ts +2 -2
  83. package/src/components/Tooltip/Tooltip.tsx +4 -4
  84. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +7 -7
  85. package/src/components/WelcomeTour/WelcomeTour.tsx +3 -2
  86. package/src/constants.ts +7 -0
  87. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +39 -0
  88. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +28 -0
  89. package/src/containers/ShortcutsDialogContent/index.ts +7 -0
  90. package/src/containers/ShortcutsHints/ShortcutsHints.tsx +5 -0
  91. package/src/containers/ShortcutsHints/index.ts +7 -0
  92. package/src/containers/ShortcutsList/ShortcutsList.tsx +5 -0
  93. package/src/containers/ShortcutsList/index.ts +7 -0
  94. package/src/containers/index.ts +9 -0
  95. package/src/hooks/useHelp.tsx +1 -1
  96. package/src/index.ts +1 -0
  97. package/src/meta.ts +1 -1
  98. package/src/operations/definitions.ts +19 -0
  99. package/src/operations/index.ts +9 -0
  100. package/src/operations/start.ts +21 -0
  101. package/src/translations.ts +5 -5
  102. package/src/types/capabilities.ts +2 -2
  103. package/src/types/schema.ts +1 -15
  104. package/dist/lib/browser/app-graph-builder-DX3VXARQ.mjs +0 -79
  105. package/dist/lib/browser/app-graph-builder-DX3VXARQ.mjs.map +0 -7
  106. package/dist/lib/browser/chunk-TS66J4C6.mjs +0 -58
  107. package/dist/lib/browser/chunk-TS66J4C6.mjs.map +0 -7
  108. package/dist/lib/browser/chunk-W5XAZM46.mjs +0 -360
  109. package/dist/lib/browser/chunk-W5XAZM46.mjs.map +0 -7
  110. package/dist/lib/browser/react-root-SZRF6EXG.mjs +0 -43
  111. package/dist/lib/browser/react-root-SZRF6EXG.mjs.map +0 -7
  112. package/dist/lib/browser/react-surface-DWNTJBVM.mjs +0 -37
  113. package/dist/lib/browser/react-surface-DWNTJBVM.mjs.map +0 -7
  114. package/dist/lib/browser/state-VRPLKT3F.mjs +0 -27
  115. package/dist/lib/browser/state-VRPLKT3F.mjs.map +0 -7
  116. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts +0 -6
  117. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +0 -1
  118. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +0 -3
  119. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +0 -1
  120. package/dist/types/src/capabilities/operation-resolver/index.d.ts +0 -2
  121. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +0 -1
  122. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +0 -5
  123. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +0 -1
  124. package/dist/types/src/capabilities/react-root/index.d.ts +0 -6
  125. package/dist/types/src/capabilities/react-root/index.d.ts.map +0 -1
  126. package/dist/types/src/capabilities/react-root/react-root.d.ts.map +0 -1
  127. package/dist/types/src/capabilities/react-surface/index.d.ts +0 -3
  128. package/dist/types/src/capabilities/react-surface/index.d.ts.map +0 -1
  129. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +0 -5
  130. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +0 -1
  131. package/dist/types/src/capabilities/state/index.d.ts +0 -11
  132. package/dist/types/src/capabilities/state/index.d.ts.map +0 -1
  133. package/dist/types/src/capabilities/state/state.d.ts.map +0 -1
  134. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +0 -1
  135. package/src/capabilities/app-graph-builder/index.ts +0 -7
  136. package/src/capabilities/operation-resolver/index.ts +0 -5
  137. package/src/capabilities/operation-resolver/operation-resolver.ts +0 -23
  138. package/src/capabilities/react-root/index.ts +0 -7
  139. package/src/capabilities/react-surface/index.ts +0 -7
  140. package/src/capabilities/state/index.ts +0 -7
  141. package/src/components/Shortcuts/ShortcutsDialog.tsx +0 -32
package/src/index.ts CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  export { HelpCapabilities } from './types';
6
6
  export * from './components';
7
+ export * from './constants';
7
8
  export * from './meta';
8
9
  export * from './HelpPlugin';
9
10
  export * from './hooks';
package/src/meta.ts CHANGED
@@ -6,7 +6,7 @@ import { type Plugin } from '@dxos/app-framework';
6
6
  import { trim } from '@dxos/util';
7
7
 
8
8
  export const meta: Plugin.Meta = {
9
- id: 'dxos.org/plugin/help',
9
+ id: 'org.dxos.plugin.help',
10
10
  name: 'Help',
11
11
  description: trim`
12
12
  Built-in help system with documentation, tutorials, and contextual assistance.
@@ -0,0 +1,19 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/operation';
9
+
10
+ import { meta } from '#meta';
11
+
12
+ const HELP_OPERATION = `${meta.id}.operation`;
13
+
14
+ export const Start = Operation.make({
15
+ meta: { key: `${HELP_OPERATION}.start`, name: 'Start Help' },
16
+ services: [Capability.Service],
17
+ input: Schema.Void,
18
+ output: Schema.Void,
19
+ });
@@ -0,0 +1,9 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { OperationHandlerSet } from '@dxos/operation';
6
+
7
+ export * as HelpOperation from './definitions';
8
+
9
+ export const HelpOperationHandlerSet = OperationHandlerSet.lazy(() => import('./start'));
@@ -0,0 +1,21 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capabilities } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/operation';
9
+
10
+ import { HelpCapabilities } from '../types';
11
+ import { Start } from './definitions';
12
+
13
+ const handler: Operation.WithHandler<typeof Start> = Start.pipe(
14
+ Operation.withHandler(
15
+ Effect.fnUntraced(function* () {
16
+ yield* Capabilities.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
17
+ }),
18
+ ),
19
+ );
20
+
21
+ export default handler;
@@ -4,16 +4,16 @@
4
4
 
5
5
  import { type Resource } from '@dxos/react-ui';
6
6
 
7
- import { meta } from './meta';
7
+ import { meta } from '#meta';
8
8
 
9
9
  export const translations = [
10
10
  {
11
11
  'en-US': {
12
12
  [meta.id]: {
13
- 'plugin name': 'Help',
14
- 'open help tour': 'Show welcome tour',
15
- 'open shortcuts label': 'Show shortcuts',
16
- 'shortcuts dialog title': 'Shortcuts',
13
+ 'plugin.name': 'Help',
14
+ 'open-help-tour.message': 'Show welcome tour',
15
+ 'open-shortcuts.label': 'Show shortcuts',
16
+ 'shortcuts-dialog.title': 'Shortcuts',
17
17
  },
18
18
  },
19
19
  },
@@ -7,7 +7,7 @@ import * as Schema from 'effect/Schema';
7
7
 
8
8
  import { Capability } from '@dxos/app-framework';
9
9
 
10
- import { meta } from '../meta';
10
+ import { meta } from '#meta';
11
11
 
12
12
  export namespace HelpCapabilities {
13
13
  export const StateSchema = Schema.mutable(
@@ -20,5 +20,5 @@ export namespace HelpCapabilities {
20
20
 
21
21
  export type State = Schema.Schema.Type<typeof StateSchema>;
22
22
 
23
- export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
23
+ export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);
24
24
  }
@@ -2,14 +2,10 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import * as Schema from 'effect/Schema';
6
5
  import { type Context, createContext } from 'react';
7
6
  import { type Step as BaseStep } from 'react-joyride';
8
7
 
9
- import { Capability, type CapabilityManager } from '@dxos/app-framework';
10
- import { Operation } from '@dxos/operation';
11
-
12
- import { meta } from '../meta';
8
+ import { type CapabilityManager } from '@dxos/app-framework';
13
9
 
14
10
  export type Step = BaseStep & {
15
11
  before?: (capabilities: CapabilityManager.CapabilityManager) => void;
@@ -32,13 +28,3 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
32
28
  start: () => {},
33
29
  stop: () => {},
34
30
  });
35
-
36
- const HELP_OPERATION = `${meta.id}/operation`;
37
-
38
- export namespace HelpOperation {
39
- export const Start = Operation.make({
40
- meta: { key: `${HELP_OPERATION}/start`, name: 'Start Help' },
41
- services: [Capability.Service],
42
- schema: { input: Schema.Void, output: Schema.Void },
43
- });
44
- }
@@ -1,79 +0,0 @@
1
- import {
2
- SHORTCUTS_DIALOG
3
- } from "./chunk-W5XAZM46.mjs";
4
- import {
5
- HelpCapabilities,
6
- HelpOperation
7
- } from "./chunk-TS66J4C6.mjs";
8
- import {
9
- meta
10
- } from "./chunk-IM2QVQOH.mjs";
11
-
12
- // src/capabilities/app-graph-builder/app-graph-builder.ts
13
- import * as Effect from "effect/Effect";
14
- import { Capability, Common } from "@dxos/app-framework";
15
- import { GraphBuilder, NodeMatcher } from "@dxos/app-graph";
16
- import { Operation } from "@dxos/operation";
17
- var app_graph_builder_default = Capability.makeModule(Effect.fnUntraced(function* () {
18
- const extensions = yield* GraphBuilder.createExtension({
19
- id: meta.id,
20
- match: NodeMatcher.whenRoot,
21
- actions: () => Effect.succeed([
22
- {
23
- id: HelpOperation.Start.meta.key,
24
- data: Effect.fnUntraced(function* () {
25
- yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({
26
- ...s,
27
- showHints: true
28
- }));
29
- yield* Operation.invoke(HelpOperation.Start);
30
- }),
31
- properties: {
32
- label: [
33
- "open help tour",
34
- {
35
- ns: meta.id
36
- }
37
- ],
38
- icon: "ph--info--regular",
39
- keyBinding: {
40
- macos: "shift+meta+/",
41
- windows: "shift+ctrl+/",
42
- linux: "shift+ctrl+?"
43
- },
44
- testId: "helpPlugin.openHelp"
45
- }
46
- },
47
- {
48
- id: `${meta.id}/open-shortcuts`,
49
- data: Effect.fnUntraced(function* () {
50
- yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({
51
- ...s,
52
- showHints: true
53
- }));
54
- yield* Operation.invoke(Common.LayoutOperation.UpdateDialog, {
55
- subject: SHORTCUTS_DIALOG,
56
- blockAlign: "center"
57
- });
58
- }),
59
- properties: {
60
- label: [
61
- "open shortcuts label",
62
- {
63
- ns: meta.id
64
- }
65
- ],
66
- icon: "ph--keyboard--regular",
67
- keyBinding: {
68
- macos: "meta+ctrl+/"
69
- }
70
- }
71
- }
72
- ])
73
- });
74
- return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);
75
- }));
76
- export {
77
- app_graph_builder_default as default
78
- };
79
- //# sourceMappingURL=app-graph-builder-DX3VXARQ.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Effect from 'effect/Effect';\n\nimport { Capability, Common } from '@dxos/app-framework';\nimport { GraphBuilder, NodeMatcher } from '@dxos/app-graph';\nimport { Operation } from '@dxos/operation';\n\nimport { SHORTCUTS_DIALOG } from '../../components';\nimport { meta } from '../../meta';\nimport { HelpCapabilities, HelpOperation } from '../../types';\n\nexport default Capability.makeModule(\n Effect.fnUntraced(function* () {\n const extensions = yield* GraphBuilder.createExtension({\n id: meta.id,\n match: NodeMatcher.whenRoot,\n actions: () =>\n Effect.succeed([\n {\n id: HelpOperation.Start.meta.key,\n data: Effect.fnUntraced(function* () {\n yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));\n yield* Operation.invoke(HelpOperation.Start);\n }),\n properties: {\n label: ['open help tour', { ns: meta.id }],\n icon: 'ph--info--regular',\n keyBinding: {\n macos: 'shift+meta+/',\n windows: 'shift+ctrl+/',\n linux: 'shift+ctrl+?',\n },\n testId: 'helpPlugin.openHelp',\n },\n },\n {\n id: `${meta.id}/open-shortcuts`,\n data: Effect.fnUntraced(function* () {\n yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (s) => ({ ...s, showHints: true }));\n yield* Operation.invoke(Common.LayoutOperation.UpdateDialog, {\n subject: SHORTCUTS_DIALOG,\n blockAlign: 'center',\n });\n }),\n properties: {\n label: ['open shortcuts label', { ns: meta.id }],\n icon: 'ph--keyboard--regular',\n keyBinding: {\n macos: 'meta+ctrl+/',\n },\n },\n },\n ]),\n });\n\n return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);\n }),\n);\n"],
5
- "mappings": ";;;;;;;;;;;;AAIA,YAAYA,YAAY;AAExB,SAASC,YAAYC,cAAc;AACnC,SAASC,cAAcC,mBAAmB;AAC1C,SAASC,iBAAiB;AAM1B,IAAA,4BAAeC,WAAWC,WACjBC,kBAAW,aAAA;AAChB,QAAMC,aAAa,OAAOC,aAAaC,gBAAgB;IACrDC,IAAIC,KAAKD;IACTE,OAAOC,YAAYC;IACnBC,SAAS,MACAC,eAAQ;MACb;QACEN,IAAIO,cAAcC,MAAMP,KAAKQ;QAC7BC,MAAad,kBAAW,aAAA;AACtB,iBAAOe,OAAOjB,WAAWkB,gBAAgBC,iBAAiBC,OAAO,CAACC,OAAO;YAAE,GAAGA;YAAGC,WAAW;UAAK,EAAA;AACjG,iBAAOC,UAAUC,OAAOX,cAAcC,KAAK;QAC7C,CAAA;QACAW,YAAY;UACVC,OAAO;YAAC;YAAkB;cAAEC,IAAIpB,KAAKD;YAAG;;UACxCsB,MAAM;UACNC,YAAY;YACVC,OAAO;YACPC,SAAS;YACTC,OAAO;UACT;UACAC,QAAQ;QACV;MACF;MACA;QACE3B,IAAI,GAAGC,KAAKD,EAAE;QACdU,MAAad,kBAAW,aAAA;AACtB,iBAAOe,OAAOjB,WAAWkB,gBAAgBC,iBAAiBC,OAAO,CAACC,OAAO;YAAE,GAAGA;YAAGC,WAAW;UAAK,EAAA;AACjG,iBAAOC,UAAUC,OAAOP,OAAOiB,gBAAgBC,cAAc;YAC3DC,SAASC;YACTC,YAAY;UACd,CAAA;QACF,CAAA;QACAb,YAAY;UACVC,OAAO;YAAC;YAAwB;cAAEC,IAAIpB,KAAKD;YAAG;;UAC9CsB,MAAM;UACNC,YAAY;YACVC,OAAO;UACT;QACF;MACF;KACD;EACL,CAAA;AAEA,SAAO9B,WAAWuC,YAAYtB,OAAOjB,WAAWwC,iBAAiBrC,UAAAA;AACnE,CAAA,CAAA;",
6
- "names": ["Effect", "Capability", "Common", "GraphBuilder", "NodeMatcher", "Operation", "Capability", "makeModule", "fnUntraced", "extensions", "GraphBuilder", "createExtension", "id", "meta", "match", "NodeMatcher", "whenRoot", "actions", "succeed", "HelpOperation", "Start", "key", "data", "Common", "updateAtomValue", "HelpCapabilities", "State", "s", "showHints", "Operation", "invoke", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutOperation", "UpdateDialog", "subject", "SHORTCUTS_DIALOG", "blockAlign", "contributes", "AppGraphBuilder"]
7
- }
@@ -1,58 +0,0 @@
1
- import {
2
- meta
3
- } from "./chunk-IM2QVQOH.mjs";
4
-
5
- // src/types/capabilities.ts
6
- import * as Schema from "effect/Schema";
7
- import { Capability } from "@dxos/app-framework";
8
- (function(HelpCapabilities2) {
9
- HelpCapabilities2.StateSchema = Schema.mutable(Schema.Struct({
10
- running: Schema.Boolean,
11
- showHints: Schema.Boolean,
12
- showWelcome: Schema.Boolean
13
- }));
14
- HelpCapabilities2.State = Capability.make(`${meta.id}/capability/state`);
15
- })(HelpCapabilities || (HelpCapabilities = {}));
16
- var HelpCapabilities;
17
-
18
- // src/types/schema.ts
19
- import * as Schema2 from "effect/Schema";
20
- import { createContext } from "react";
21
- import { Capability as Capability2 } from "@dxos/app-framework";
22
- import { Operation } from "@dxos/operation";
23
- var HelpContext = createContext({
24
- running: false,
25
- steps: [],
26
- setSteps: () => {
27
- },
28
- setIndex: () => {
29
- },
30
- start: () => {
31
- },
32
- stop: () => {
33
- }
34
- });
35
- var HELP_OPERATION = `${meta.id}/operation`;
36
- (function(HelpOperation2) {
37
- HelpOperation2.Start = Operation.make({
38
- meta: {
39
- key: `${HELP_OPERATION}/start`,
40
- name: "Start Help"
41
- },
42
- services: [
43
- Capability2.Service
44
- ],
45
- schema: {
46
- input: Schema2.Void,
47
- output: Schema2.Void
48
- }
49
- });
50
- })(HelpOperation || (HelpOperation = {}));
51
- var HelpOperation;
52
-
53
- export {
54
- HelpCapabilities,
55
- HelpContext,
56
- HelpOperation
57
- };
58
- //# sourceMappingURL=chunk-TS66J4C6.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 * as Schema from 'effect/Schema';\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { Capability, type CapabilityManager } from '@dxos/app-framework';\nimport { Operation } from '@dxos/operation';\n\nimport { meta } from '../meta';\n\nexport type Step = BaseStep & {\n before?: (capabilities: CapabilityManager.CapabilityManager) => void;\n};\n\nexport type HelpContextType = {\n running: boolean;\n steps: Step[];\n setSteps: (steps: Step[]) => void;\n setIndex: (index: number) => void;\n start: () => void;\n stop: () => void;\n};\n\nexport const HelpContext: Context<HelpContextType> = createContext<HelpContextType>({\n running: false,\n steps: [],\n setSteps: () => {},\n setIndex: () => {},\n start: () => {},\n stop: () => {},\n});\n\nconst HELP_OPERATION = `${meta.id}/operation`;\n\nexport namespace HelpOperation {\n export const Start = Operation.make({\n meta: { key: `${HELP_OPERATION}/start`, name: 'Start Help' },\n services: [Capability.Service],\n schema: { input: Schema.Void, output: Schema.Void },\n });\n}\n"],
5
- "mappings": ";;;;;AAKA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;UAIVC,mBAAAA;oBACFC,cAAqBC,eACzBC,cAAO;IACZC,SAAgBC;IAChBC,WAAkBD;IAClBE,aAAoBF;EACtB,CAAA,CAAA;oBAKWG,QAAQC,WAAWC,KAA2B,GAAGC,KAAKC,EAAE,mBAAmB;AAC1F,GAZiBZ,qBAAAA,mBAAAA,CAAAA,EAAAA;;;;ACPjB,YAAYa,aAAY;AACxB,SAAuBC,qBAAqB;AAG5C,SAASC,cAAAA,mBAA0C;AACnD,SAASC,iBAAiB;AAiBnB,IAAMC,cAAwCC,cAA+B;EAClFC,SAAS;EACTC,OAAO,CAAA;EACPC,UAAU,MAAA;EAAO;EACjBC,UAAU,MAAA;EAAO;EACjBC,OAAO,MAAA;EAAO;EACdC,MAAM,MAAA;EAAO;AACf,CAAA;AAEA,IAAMC,iBAAiB,GAAGC,KAAKC,EAAE;UAEhBC,gBAAAA;iBACFC,QAAQC,UAAUC,KAAK;IAClCL,MAAM;MAAEM,KAAK,GAAGP,cAAAA;MAAwBQ,MAAM;IAAa;IAC3DC,UAAU;MAACC,YAAWC;;IACtBC,QAAQ;MAAEC,OAAcC;MAAMC,QAAeD;IAAK;EACpD,CAAA;AACF,GANiBX,kBAAAA,gBAAAA,CAAAA,EAAAA;;",
6
- "names": ["Schema", "Capability", "HelpCapabilities", "StateSchema", "mutable", "Struct", "running", "Boolean", "showHints", "showWelcome", "State", "Capability", "make", "meta", "id", "Schema", "createContext", "Capability", "Operation", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_OPERATION", "meta", "id", "HelpOperation", "Start", "Operation", "make", "key", "name", "services", "Capability", "Service", "schema", "input", "Void", "output"]
7
- }
@@ -1,360 +0,0 @@
1
- import {
2
- HelpContext
3
- } from "./chunk-TS66J4C6.mjs";
4
- import {
5
- meta
6
- } from "./chunk-IM2QVQOH.mjs";
7
-
8
- // src/components/Shortcuts/Key.tsx
9
- import React from "react";
10
- import { keySymbols } from "@dxos/keyboard";
11
-
12
- // src/components/Shortcuts/styles.ts
13
- import { mx } from "@dxos/ui-theme";
14
- var shortcutKey = mx("inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs", "rounded bg-neutral-100 dark:bg-neutral-900");
15
-
16
- // src/components/Shortcuts/Key.tsx
17
- var Key = ({ binding }) => {
18
- return /* @__PURE__ */ React.createElement("span", {
19
- role: "term",
20
- className: "inline-flex gap-1",
21
- "aria-label": binding,
22
- id: binding
23
- }, keySymbols(binding).map((c, i) => /* @__PURE__ */ React.createElement("span", {
24
- key: i,
25
- className: shortcutKey
26
- }, c)));
27
- };
28
-
29
- // src/components/Shortcuts/ShortcutsList.tsx
30
- import React2, { Fragment } from "react";
31
- import { Keyboard } from "@dxos/keyboard";
32
- import { toLocalizedString, useTranslation } from "@dxos/react-ui";
33
- import { mx as mx2 } from "@dxos/ui-theme";
34
- var ShortcutsList = () => {
35
- const { t } = useTranslation(meta.id);
36
- const bindings = Keyboard.singleton.getBindings();
37
- bindings.sort((a, b) => {
38
- return toLocalizedString(a.data, t)?.toLowerCase().localeCompare(toLocalizedString(b.data, t)?.toLowerCase());
39
- });
40
- return /* @__PURE__ */ React2.createElement("dl", {
41
- className: mx2("is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued select-none")
42
- }, bindings.map((binding, i) => /* @__PURE__ */ React2.createElement(Fragment, {
43
- key: i
44
- }, /* @__PURE__ */ React2.createElement(Key, {
45
- binding: binding.shortcut
46
- }), /* @__PURE__ */ React2.createElement("span", {
47
- role: "definition",
48
- className: "mis-4",
49
- "aria-labelledby": binding.shortcut
50
- }, toLocalizedString(binding.data, t)))));
51
- };
52
-
53
- // src/components/Shortcuts/ShortcutsDialog.tsx
54
- import React3 from "react";
55
- import { Dialog, IconButton, useTranslation as useTranslation2 } from "@dxos/react-ui";
56
- var SHORTCUTS_DIALOG = `${meta.id}/ShortcutsDialog`;
57
- var ShortcutsDialogContent = () => {
58
- const { t } = useTranslation2(meta.id);
59
- return /* @__PURE__ */ React3.createElement(Dialog.Content, null, /* @__PURE__ */ React3.createElement("div", {
60
- role: "none",
61
- className: "flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5"
62
- }, /* @__PURE__ */ React3.createElement(Dialog.Title, null, t("shortcuts dialog title")), /* @__PURE__ */ React3.createElement(Dialog.Close, {
63
- asChild: true
64
- }, /* @__PURE__ */ React3.createElement(IconButton, {
65
- icon: "ph--x--bold",
66
- iconOnly: true,
67
- size: 3,
68
- label: "Close",
69
- variant: "ghost",
70
- autoFocus: true
71
- }))), /* @__PURE__ */ React3.createElement("div", {
72
- className: "flex items-center justify-center"
73
- }, /* @__PURE__ */ React3.createElement(ShortcutsList, null)));
74
- };
75
-
76
- // src/components/Shortcuts/ShortcutsHints.tsx
77
- import React4 from "react";
78
- import { Keyboard as Keyboard2 } from "@dxos/keyboard";
79
- import { IconButton as IconButton2, toLocalizedString as toLocalizedString2, useTranslation as useTranslation3 } from "@dxos/react-ui";
80
- import { osTranslations } from "@dxos/ui-theme";
81
- var Shortcut = ({ binding }) => {
82
- const { t } = useTranslation3(osTranslations);
83
- return /* @__PURE__ */ React4.createElement("div", {
84
- role: "none",
85
- className: "flex items-center gap-2 whitespace-nowrap"
86
- }, /* @__PURE__ */ React4.createElement(Key, {
87
- binding: binding.shortcut
88
- }), /* @__PURE__ */ React4.createElement("span", {
89
- className: "text-sm"
90
- }, toLocalizedString2(binding.data, t)));
91
- };
92
- var ShortcutsHints = ({ onClose }) => {
93
- const defaults = [
94
- "meta+k",
95
- "meta+/",
96
- "meta+,"
97
- ];
98
- const bindings = Keyboard2.singleton.getBindings();
99
- const hints = bindings.filter((binding) => defaults.includes(binding.shortcut));
100
- return /* @__PURE__ */ React4.createElement("div", {
101
- role: "none",
102
- className: "flex overflow-hidden pli-2 gap-4"
103
- }, hints.map((binding) => /* @__PURE__ */ React4.createElement(Shortcut, {
104
- key: binding.shortcut,
105
- binding
106
- })), onClose && /* @__PURE__ */ React4.createElement(IconButton2, {
107
- icon: "ph--x--regular",
108
- size: 4,
109
- label: "Close",
110
- iconOnly: true,
111
- noTooltip: true,
112
- variant: "ghost",
113
- classNames: "p-0 cursor-pointer",
114
- onClick: onClose
115
- }));
116
- };
117
-
118
- // src/components/Shortcuts/ShortcutsSection.tsx
119
- import React5 from "react";
120
- import { descriptionText } from "@dxos/ui-theme";
121
- var ShortcutsSection = () => {
122
- return /* @__PURE__ */ React5.createElement("section", {
123
- className: descriptionText
124
- }, /* @__PURE__ */ React5.createElement(ShortcutsList, null));
125
- };
126
-
127
- // src/components/Tooltip/Tooltip.tsx
128
- import { useArrowNavigationGroup, useFocusableGroup } from "@fluentui/react-tabster";
129
- import React6, { forwardRef } from "react";
130
- import { Button, Icon, IconButton as IconButton3 } from "@dxos/react-ui";
131
- var floaterProps = {
132
- styles: {
133
- // Arrow color is set by joyride.
134
- arrow: {
135
- length: 8,
136
- spread: 16
137
- },
138
- floater: {
139
- // TODO(burdon): Get tokens from theme.
140
- filter: "drop-shadow(0 0 0.75rem rgba(0, 0, 0, 0.2))"
141
- }
142
- }
143
- };
144
- var Tooltip = /* @__PURE__ */ forwardRef(({ step: { title, content }, index, size, isLastStep, backProps, closeProps, primaryProps }, forwardedRef) => {
145
- const arrowNavigationAttrs = useArrowNavigationGroup({
146
- axis: "horizontal"
147
- });
148
- const focusableGroupAttrs = useFocusableGroup({
149
- tabBehavior: "limited-trap-focus"
150
- });
151
- return /* @__PURE__ */ React6.createElement("div", {
152
- className: "flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-accentSurfaceText",
153
- role: "tooltip",
154
- "data-testid": "helpPlugin.tooltip",
155
- "data-step": index + 1,
156
- ...focusableGroupAttrs,
157
- ref: forwardedRef
158
- }, /* @__PURE__ */ React6.createElement("div", {
159
- className: "flex p-2"
160
- }, /* @__PURE__ */ React6.createElement("h2", {
161
- className: "grow pli-2 plb-1 text-lg font-medium text-accentSurfaceText"
162
- }, title), /* @__PURE__ */ React6.createElement(IconButton3, {
163
- density: "fine",
164
- icon: "ph--x--bold",
165
- iconOnly: true,
166
- label: closeProps["aria-label"],
167
- onClick: closeProps.onClick,
168
- size: 4,
169
- variant: "primary",
170
- "data-testid": "helpPlugin.tooltip.close"
171
- })), /* @__PURE__ */ React6.createElement("div", {
172
- className: "flex grow pli-4 mlb-2"
173
- }, content), /* @__PURE__ */ React6.createElement("div", {
174
- className: "flex p-2 items-center justify-between",
175
- ...arrowNavigationAttrs
176
- }, /* @__PURE__ */ React6.createElement(IconButton3, {
177
- classNames: [
178
- !(index > 0 && backProps) && "invisible"
179
- ],
180
- icon: "ph--caret-left--regular",
181
- iconOnly: true,
182
- label: backProps["aria-label"],
183
- onClick: backProps.onClick,
184
- variant: "primary",
185
- "data-testid": "helpPlugin.tooltip.back"
186
- }), /* @__PURE__ */ React6.createElement("div", {
187
- className: "flex grow gap-2 justify-center"
188
- }, /* @__PURE__ */ React6.createElement("div", {
189
- className: "flex"
190
- }, Array.from({
191
- length: size
192
- }).map((_, i) => /* @__PURE__ */ React6.createElement(Icon, {
193
- key: i,
194
- icon: index === i ? "ph--circle--fill" : "ph--circle--regular",
195
- size: 2,
196
- classNames: "mli-1 cursor-pointer"
197
- })))), isLastStep ? /* @__PURE__ */ React6.createElement(Button, {
198
- variant: "primary",
199
- onClick: closeProps.onClick,
200
- title: closeProps["aria-label"],
201
- autoFocus: true,
202
- "data-testid": "helpPlugin.tooltip.finish"
203
- }, "Done") : /* @__PURE__ */ React6.createElement(IconButton3, {
204
- autoFocus: true,
205
- icon: "ph--caret-right--regular",
206
- iconOnly: true,
207
- label: primaryProps["aria-label"],
208
- onClick: primaryProps.onClick,
209
- size: 6,
210
- variant: "primary",
211
- "data-testid": "helpPlugin.tooltip.next"
212
- })));
213
- });
214
-
215
- // src/components/WelcomeTour/WelcomeTour.tsx
216
- import React7, { useState } from "react";
217
- import Joyride, { ACTIONS, EVENTS } from "react-joyride";
218
- import { useLayout, usePluginManager } from "@dxos/app-framework/react";
219
- import { useAsyncEffect } from "@dxos/react-ui";
220
- var addStepClass = (target) => {
221
- const element = typeof target === "string" ? document.querySelector(target) : target;
222
- if (element) {
223
- element.classList.add("joyride-target");
224
- }
225
- };
226
- var removeTargetClass = (target) => {
227
- const element = typeof target === "string" ? document.querySelector(target) : target;
228
- if (element) {
229
- element.classList.remove("joyride-target");
230
- }
231
- };
232
- var getTarget = (step) => {
233
- return typeof step.target === "string" ? document.querySelector(step.target) : step.target;
234
- };
235
- var waitForTarget = async (step) => {
236
- if (typeof step.target === "string") {
237
- const target = step.target;
238
- const element = document.querySelector(target);
239
- if (element) {
240
- return;
241
- }
242
- await new Promise((resolve) => {
243
- const observer = new MutationObserver((mutations) => {
244
- mutations.forEach((mutation) => {
245
- if (mutation.addedNodes.length > 0) {
246
- const element2 = document.querySelector(target);
247
- if (element2) {
248
- observer.disconnect();
249
- resolve();
250
- }
251
- }
252
- });
253
- });
254
- observer.observe(document.body, {
255
- childList: true,
256
- subtree: true
257
- });
258
- });
259
- }
260
- };
261
- var WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunningChanged }) => {
262
- const manager = usePluginManager();
263
- const layout = useLayout();
264
- const [running, setRunning] = useState(!!runningProp && !!getTarget(initialSteps[0]));
265
- const [stepIndex, _setStepIndex] = useState(0);
266
- const [steps, setSteps] = useState(initialSteps);
267
- const paused = layout.dialogOpen;
268
- const setStepIndex = (index) => {
269
- if (runningProp) {
270
- const step = steps[index];
271
- step?.before?.(manager.capabilities);
272
- }
273
- _setStepIndex(index);
274
- };
275
- const setRunningChanged = (state) => {
276
- if (typeof runningProp !== "undefined") {
277
- onRunningChanged?.(state);
278
- } else {
279
- if (state) {
280
- setStepIndex(0);
281
- setRunning(true);
282
- } else {
283
- setRunning(false);
284
- }
285
- }
286
- };
287
- useAsyncEffect(async () => {
288
- if (runningProp) {
289
- await waitForTarget(steps[stepIndex]);
290
- setStepIndex(0);
291
- setRunning(true);
292
- } else if (typeof runningProp !== "undefined") {
293
- setRunning(false);
294
- }
295
- }, [
296
- runningProp
297
- ]);
298
- const callback = async (options) => {
299
- const { type, action, index, size } = options;
300
- switch (type) {
301
- case EVENTS.STEP_BEFORE:
302
- addStepClass(options.step.target);
303
- break;
304
- case EVENTS.TOUR_END:
305
- break;
306
- case EVENTS.STEP_AFTER:
307
- removeTargetClass(options.step.target);
308
- switch (action) {
309
- case ACTIONS.NEXT:
310
- if (index < size - 1) {
311
- setStepIndex(index + 1);
312
- }
313
- break;
314
- case ACTIONS.PREV:
315
- if (index > 0) {
316
- setStepIndex(index - 1);
317
- }
318
- break;
319
- case ACTIONS.CLOSE:
320
- setRunningChanged(false);
321
- setStepIndex(0);
322
- break;
323
- }
324
- break;
325
- }
326
- };
327
- return /* @__PURE__ */ React7.createElement(HelpContext.Provider, {
328
- value: {
329
- running: running && !paused,
330
- steps,
331
- setSteps,
332
- setIndex: setStepIndex,
333
- start: () => setRunningChanged(true),
334
- stop: () => setRunningChanged(false)
335
- }
336
- }, /* @__PURE__ */ React7.createElement("style", null, `.joyride-target {
337
- --controls-opacity: 1;
338
- }`), /* @__PURE__ */ React7.createElement(Joyride, {
339
- continuous: true,
340
- steps,
341
- stepIndex,
342
- run: running && !paused,
343
- callback,
344
- floaterProps,
345
- tooltipComponent: Tooltip
346
- }));
347
- };
348
-
349
- export {
350
- Key,
351
- ShortcutsList,
352
- SHORTCUTS_DIALOG,
353
- ShortcutsDialogContent,
354
- ShortcutsHints,
355
- ShortcutsSection,
356
- floaterProps,
357
- Tooltip,
358
- WelcomeTour
359
- };
360
- //# sourceMappingURL=chunk-W5XAZM46.mjs.map