@dxos/plugin-help 0.8.4-main.a4bbb77 → 0.8.4-main.abd8ff62ef

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-53QC3FTJ.mjs +34 -0
  2. package/dist/lib/browser/chunk-53QC3FTJ.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-EEXGETLQ.mjs +16 -0
  4. package/dist/lib/browser/chunk-EEXGETLQ.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  6. package/dist/lib/browser/chunk-J5LGTIGS.mjs.map +7 -0
  7. package/dist/lib/browser/chunk-RWK34XL5.mjs +31 -0
  8. package/dist/lib/browser/chunk-RWK34XL5.mjs.map +7 -0
  9. package/dist/lib/browser/index.mjs +13 -97
  10. package/dist/lib/browser/index.mjs.map +4 -4
  11. package/dist/lib/browser/meta.json +1 -1
  12. package/dist/lib/browser/meta.mjs +2 -1
  13. package/dist/lib/browser/operations/index.mjs +13 -0
  14. package/dist/lib/browser/operations/index.mjs.map +7 -0
  15. package/dist/lib/browser/start-JQ2LLVCT.mjs +23 -0
  16. package/dist/lib/browser/start-JQ2LLVCT.mjs.map +7 -0
  17. package/dist/lib/browser/translations.mjs +20 -0
  18. package/dist/lib/browser/translations.mjs.map +7 -0
  19. package/dist/lib/browser/types/index.mjs +4 -4
  20. package/dist/types/src/HelpPlugin.d.ts +4 -2
  21. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  22. package/dist/types/src/HelpPlugin.test.d.ts +2 -0
  23. package/dist/types/src/HelpPlugin.test.d.ts.map +1 -0
  24. package/dist/types/src/capabilities/app-graph-builder.d.ts +4 -2
  25. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
  26. package/dist/types/src/capabilities/index.d.ts +16 -6
  27. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  28. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  29. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  30. package/dist/types/src/capabilities/react-root.d.ts +5 -3
  31. package/dist/types/src/capabilities/react-root.d.ts.map +1 -1
  32. package/dist/types/src/capabilities/react-surface.d.ts +3 -2
  33. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
  34. package/dist/types/src/capabilities/state.d.ts +11 -2
  35. package/dist/types/src/capabilities/state.d.ts.map +1 -1
  36. package/dist/types/src/components/Shortcuts/Key.d.ts.map +1 -1
  37. package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
  38. package/dist/types/src/components/Shortcuts/ShortcutsSection.d.ts.map +1 -1
  39. package/dist/types/src/components/Shortcuts/index.d.ts +0 -1
  40. package/dist/types/src/components/Shortcuts/index.d.ts.map +1 -1
  41. package/dist/types/src/components/Tooltip/Tooltip.d.ts +9 -9
  42. package/dist/types/src/components/Tooltip/Tooltip.d.ts.map +1 -1
  43. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts +1 -1
  44. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  45. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
  46. package/dist/types/src/constants.d.ts +2 -0
  47. package/dist/types/src/constants.d.ts.map +1 -0
  48. package/dist/types/src/{components/Shortcuts/ShortcutsDialog.d.ts → containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts} +1 -2
  49. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.d.ts.map +1 -0
  50. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +25 -0
  51. package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -0
  52. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts +2 -0
  53. package/dist/types/src/containers/ShortcutsDialogContent/index.d.ts.map +1 -0
  54. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts +2 -0
  55. package/dist/types/src/containers/ShortcutsHints/ShortcutsHints.d.ts.map +1 -0
  56. package/dist/types/src/containers/ShortcutsHints/index.d.ts +2 -0
  57. package/dist/types/src/containers/ShortcutsHints/index.d.ts.map +1 -0
  58. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts +2 -0
  59. package/dist/types/src/containers/ShortcutsList/ShortcutsList.d.ts.map +1 -0
  60. package/dist/types/src/containers/ShortcutsList/index.d.ts +2 -0
  61. package/dist/types/src/containers/ShortcutsList/index.d.ts.map +1 -0
  62. package/dist/types/src/containers/index.d.ts +5 -0
  63. package/dist/types/src/containers/index.d.ts.map +1 -0
  64. package/dist/types/src/hooks/useHelp.d.ts +1 -1
  65. package/dist/types/src/hooks/useHelp.d.ts.map +1 -1
  66. package/dist/types/src/index.d.ts +5 -4
  67. package/dist/types/src/index.d.ts.map +1 -1
  68. package/dist/types/src/meta.d.ts +2 -2
  69. package/dist/types/src/meta.d.ts.map +1 -1
  70. package/dist/types/src/operations/definitions.d.ts +4 -0
  71. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  72. package/dist/types/src/operations/index.d.ts +4 -0
  73. package/dist/types/src/operations/index.d.ts.map +1 -0
  74. package/dist/types/src/operations/start.d.ts +5 -0
  75. package/dist/types/src/operations/start.d.ts.map +1 -0
  76. package/dist/types/src/translations.d.ts +5 -6
  77. package/dist/types/src/translations.d.ts.map +1 -1
  78. package/dist/types/src/types/capabilities.d.ts +21 -0
  79. package/dist/types/src/types/capabilities.d.ts.map +1 -0
  80. package/dist/types/src/types/index.d.ts +1 -0
  81. package/dist/types/src/types/index.d.ts.map +1 -1
  82. package/dist/types/src/types/schema.d.ts +2 -14
  83. package/dist/types/src/types/schema.d.ts.map +1 -1
  84. package/dist/types/tsconfig.tsbuildinfo +1 -1
  85. package/package.json +62 -45
  86. package/src/HelpPlugin.test.ts +30 -0
  87. package/src/HelpPlugin.tsx +21 -44
  88. package/src/capabilities/app-graph-builder.ts +53 -67
  89. package/src/capabilities/index.ts +10 -7
  90. package/src/capabilities/operation-handler.ts +16 -0
  91. package/src/capabilities/react-root.tsx +28 -25
  92. package/src/capabilities/react-surface.tsx +28 -22
  93. package/src/capabilities/state.ts +19 -16
  94. package/src/components/Shortcuts/ShortcutsHints.tsx +13 -5
  95. package/src/components/Shortcuts/ShortcutsList.tsx +4 -4
  96. package/src/components/Shortcuts/ShortcutsSection.tsx +1 -3
  97. package/src/components/Shortcuts/index.ts +0 -1
  98. package/src/components/Shortcuts/styles.ts +3 -3
  99. package/src/components/Tooltip/Tooltip.tsx +4 -5
  100. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +17 -13
  101. package/src/components/WelcomeTour/WelcomeTour.tsx +6 -3
  102. package/src/constants.ts +7 -0
  103. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +39 -0
  104. package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.tsx +28 -0
  105. package/src/containers/ShortcutsDialogContent/index.ts +5 -0
  106. package/src/containers/ShortcutsHints/ShortcutsHints.tsx +5 -0
  107. package/src/containers/ShortcutsHints/index.ts +5 -0
  108. package/src/containers/ShortcutsList/ShortcutsList.tsx +5 -0
  109. package/src/containers/ShortcutsList/index.ts +5 -0
  110. package/src/containers/index.ts +9 -0
  111. package/src/hooks/useHelp.tsx +1 -1
  112. package/src/index.ts +9 -4
  113. package/src/meta.ts +8 -3
  114. package/src/operations/definitions.ts +19 -0
  115. package/src/operations/index.ts +9 -0
  116. package/src/operations/start.ts +21 -0
  117. package/src/translations.ts +5 -5
  118. package/src/types/capabilities.ts +24 -0
  119. package/src/types/index.ts +1 -0
  120. package/src/types/schema.ts +2 -12
  121. package/dist/lib/browser/app-graph-builder-AR2S4WLE.mjs +0 -79
  122. package/dist/lib/browser/app-graph-builder-AR2S4WLE.mjs.map +0 -7
  123. package/dist/lib/browser/chunk-3WYHGOGD.mjs +0 -16
  124. package/dist/lib/browser/chunk-3WYHGOGD.mjs.map +0 -7
  125. package/dist/lib/browser/chunk-4KB36WUN.mjs +0 -34
  126. package/dist/lib/browser/chunk-4KB36WUN.mjs.map +0 -7
  127. package/dist/lib/browser/chunk-HUJHLAHD.mjs +0 -11
  128. package/dist/lib/browser/chunk-HUJHLAHD.mjs.map +0 -7
  129. package/dist/lib/browser/chunk-RZFM47PY.mjs +0 -407
  130. package/dist/lib/browser/chunk-RZFM47PY.mjs.map +0 -7
  131. package/dist/lib/browser/react-root-WTD4XPY6.mjs +0 -34
  132. package/dist/lib/browser/react-root-WTD4XPY6.mjs.map +0 -7
  133. package/dist/lib/browser/react-surface-ZFAK7QKZ.mjs +0 -36
  134. package/dist/lib/browser/react-surface-ZFAK7QKZ.mjs.map +0 -7
  135. package/dist/lib/browser/state-Y7EYMGFM.mjs +0 -29
  136. package/dist/lib/browser/state-Y7EYMGFM.mjs.map +0 -7
  137. package/dist/types/src/capabilities/capabilities.d.ts +0 -10
  138. package/dist/types/src/capabilities/capabilities.d.ts.map +0 -1
  139. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +0 -1
  140. package/src/capabilities/capabilities.ts +0 -13
  141. package/src/components/Shortcuts/ShortcutsDialog.tsx +0 -35
@@ -1,29 +0,0 @@
1
- import {
2
- HelpCapabilities
3
- } from "./chunk-3WYHGOGD.mjs";
4
- import {
5
- meta
6
- } from "./chunk-HUJHLAHD.mjs";
7
-
8
- // src/capabilities/state.ts
9
- import { contributes } from "@dxos/app-framework";
10
- import { LocalStorageStore } from "@dxos/local-storage";
11
- var state_default = (() => {
12
- const state = new LocalStorageStore(meta.id, {
13
- running: false,
14
- showHints: true,
15
- showWelcome: true
16
- });
17
- state.prop({
18
- key: "showHints",
19
- type: LocalStorageStore.bool()
20
- }).prop({
21
- key: "showWelcome",
22
- type: LocalStorageStore.bool()
23
- });
24
- return contributes(HelpCapabilities.State, state.values);
25
- });
26
- export {
27
- state_default as default
28
- };
29
- //# sourceMappingURL=state-Y7EYMGFM.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/state.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { contributes } from '@dxos/app-framework';\nimport { LocalStorageStore } from '@dxos/local-storage';\n\nimport { meta } from '../meta';\n\nimport { HelpCapabilities } from './capabilities';\n\nexport default () => {\n const state = new LocalStorageStore<HelpCapabilities.State>(meta.id, {\n running: false,\n showHints: true,\n showWelcome: true,\n });\n\n state\n .prop({ key: 'showHints', type: LocalStorageStore.bool() })\n .prop({ key: 'showWelcome', type: LocalStorageStore.bool() });\n\n return contributes(HelpCapabilities.State, state.values);\n};\n"],
5
- "mappings": ";;;;;;;;AAIA,SAASA,mBAAmB;AAC5B,SAASC,yBAAyB;AAMlC,IAAA,iBAAe,MAAA;AACb,QAAMC,QAAQ,IAAIC,kBAA0CC,KAAKC,IAAI;IACnEC,SAAS;IACTC,WAAW;IACXC,aAAa;EACf,CAAA;AAEAN,QACGO,KAAK;IAAEC,KAAK;IAAaC,MAAMR,kBAAkBS,KAAI;EAAG,CAAA,EACxDH,KAAK;IAAEC,KAAK;IAAeC,MAAMR,kBAAkBS,KAAI;EAAG,CAAA;AAE7D,SAAOC,YAAYC,iBAAiBC,OAAOb,MAAMc,MAAM;AACzD;",
6
- "names": ["contributes", "LocalStorageStore", "state", "LocalStorageStore", "meta", "id", "running", "showHints", "showWelcome", "prop", "key", "type", "bool", "contributes", "HelpCapabilities", "State", "values"]
7
- }
@@ -1,10 +0,0 @@
1
- export declare namespace HelpCapabilities {
2
- type State = {
3
- running: boolean;
4
- showHints: boolean;
5
- showWelcome: boolean;
6
- };
7
- const State: import("@dxos/app-framework").InterfaceDef<Readonly<State>>;
8
- const MutableState: import("@dxos/app-framework").InterfaceDef<State>;
9
- }
10
- //# sourceMappingURL=capabilities.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/capabilities.ts"],"names":[],"mappings":"AAQA,yBAAiB,gBAAgB,CAAC;IAChC,KAAY,KAAK,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,CAAC;IAC5E,MAAM,KAAK,6DAAmE,CAAC;IAC/E,MAAM,YAAY,mDAAyD,CAAC;CACpF"}
@@ -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,yBAoBlC,CAAC"}
@@ -1,13 +0,0 @@
1
- //
2
- // Copyright 2025 DXOS.org
3
- //
4
-
5
- import { defineCapability } from '@dxos/app-framework';
6
-
7
- import { meta } from '../meta';
8
-
9
- export namespace HelpCapabilities {
10
- export type State = { running: boolean; showHints: boolean; showWelcome: boolean };
11
- export const State = defineCapability<Readonly<State>>(`${meta.id}/capability/state`);
12
- export const MutableState = defineCapability<State>(`${meta.id}/capability/state`);
13
- }
@@ -1,35 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import React from 'react';
6
-
7
- import { Button, Dialog, Icon, 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 classNames='p-0 bs-content max-bs-full md:max-is-[25rem] overflow-hidden'>
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
-
23
- <Dialog.Close asChild>
24
- <Button density='fine' variant='ghost' autoFocus>
25
- <Icon icon='ph--x--bold' size={3} />
26
- </Button>
27
- </Dialog.Close>
28
- </div>
29
-
30
- <div className='flex items-center justify-center'>
31
- <ShortcutsList />
32
- </div>
33
- </Dialog.Content>
34
- );
35
- };