@dxos/plugin-help 0.8.4-main.937b3ca → 0.8.4-main.9be5663bfe

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 (142) 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 +2 -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 +2 -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 +2 -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} +20 -18
  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.tsx +37 -0
  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 +14 -14
  85. package/src/components/WelcomeTour/WelcomeTour.tsx +4 -2
  86. package/src/constants.ts +7 -0
  87. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +38 -0
  88. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +28 -0
  89. package/src/containers/ShortcutsDialogContent/index.ts +5 -0
  90. package/src/containers/ShortcutsHints/ShortcutsHints.tsx +5 -0
  91. package/src/containers/ShortcutsHints/index.ts +5 -0
  92. package/src/containers/ShortcutsList/ShortcutsList.tsx +5 -0
  93. package/src/containers/ShortcutsList/index.ts +5 -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/react-surface/react-surface.tsx +0 -34
  141. package/src/capabilities/state/index.ts +0 -7
  142. package/src/components/Shortcuts/ShortcutsDialog.tsx +0 -32
@@ -1,11 +0,0 @@
1
- import { Capability } from '@dxos/app-framework';
2
- export declare const HelpState: Capability.LazyCapability<void, Capability.Capability<Capability.InterfaceDef<import("@effect-atom/atom/Atom").Writable<{
3
- running: boolean;
4
- showHints: boolean;
5
- showWelcome: boolean;
6
- }, {
7
- running: boolean;
8
- showHints: boolean;
9
- showWelcome: boolean;
10
- }>>>, Error>;
11
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/capabilities/state/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,eAAO,MAAM,SAAS;;;;;;;;YAAwD,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../../src/capabilities/state/state.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;;;;;;;;;;AAMjD,wBAcE"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"ShortcutsDialog.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsDialog.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAQ1B,eAAO,MAAM,gBAAgB,QAA+B,CAAC;AAE7D,eAAO,MAAM,sBAAsB,yBAiBlC,CAAC"}
@@ -1,7 +0,0 @@
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'));
@@ -1,5 +0,0 @@
1
- //
2
- // Copyright 2025 DXOS.org
3
- //
4
-
5
- export { default as OperationResolver } from './operation-resolver';
@@ -1,23 +0,0 @@
1
- //
2
- // Copyright 2025 DXOS.org
3
- //
4
-
5
- import * as Effect from 'effect/Effect';
6
-
7
- import { Capability, Common } 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(Common.Capability.OperationResolver, [
15
- OperationResolver.make({
16
- operation: HelpOperation.Start,
17
- handler: Effect.fnUntraced(function* () {
18
- yield* Common.Capability.updateAtomValue(HelpCapabilities.State, (state) => ({ ...state, running: true }));
19
- }),
20
- }),
21
- ]);
22
- }),
23
- );
@@ -1,7 +0,0 @@
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'));
@@ -1,7 +0,0 @@
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'));
@@ -1,34 +0,0 @@
1
- //
2
- // Copyright 2025 DXOS.org
3
- //
4
-
5
- import * as Effect from 'effect/Effect';
6
- import React from 'react';
7
-
8
- import { Capability, Common } from '@dxos/app-framework';
9
-
10
- import { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../../components';
11
- import { meta } from '../../meta';
12
-
13
- export default Capability.makeModule(() =>
14
- Effect.succeed(
15
- Capability.contributes(Common.Capability.ReactSurface, [
16
- Common.createSurface({
17
- id: `${meta.id}/hints`,
18
- role: 'hints',
19
- component: () => <ShortcutsHints />,
20
- }),
21
- Common.createSurface({
22
- id: `${meta.id}/keyshortcuts`,
23
- role: 'keyshortcuts',
24
- component: () => <ShortcutsList />,
25
- }),
26
- Common.createSurface({
27
- id: SHORTCUTS_DIALOG,
28
- role: 'dialog',
29
- filter: (data): data is { component: string } => data.component === SHORTCUTS_DIALOG,
30
- component: () => <ShortcutsDialogContent />,
31
- }),
32
- ]),
33
- ),
34
- );
@@ -1,7 +0,0 @@
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'));
@@ -1,32 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import React from 'react';
6
-
7
- import { Dialog, IconButton, useTranslation } from '@dxos/react-ui';
8
-
9
- import { meta } from '../../meta';
10
-
11
- import { ShortcutsList } from './ShortcutsList';
12
-
13
- export const SHORTCUTS_DIALOG = `${meta.id}/ShortcutsDialog`;
14
-
15
- export const ShortcutsDialogContent = () => {
16
- const { t } = useTranslation(meta.id);
17
-
18
- return (
19
- <Dialog.Content>
20
- <div role='none' className='flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5'>
21
- <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>
22
- <Dialog.Close asChild>
23
- <IconButton icon='ph--x--bold' iconOnly size={3} label='Close' variant='ghost' autoFocus />
24
- </Dialog.Close>
25
- </div>
26
-
27
- <div className='flex items-center justify-center'>
28
- <ShortcutsList />
29
- </div>
30
- </Dialog.Content>
31
- );
32
- };