@dxos/plugin-help 0.8.4-main.f9ba587 → 0.8.4-main.fffef41

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 (100) hide show
  1. package/dist/lib/browser/{app-graph-builder-IXCF4ZDE.mjs → app-graph-builder-L6GUMAIH.mjs} +17 -16
  2. package/dist/lib/browser/app-graph-builder-L6GUMAIH.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-AZJJLAG7.mjs +16 -0
  4. package/dist/lib/browser/chunk-AZJJLAG7.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-BCYK4LXW.mjs +16 -0
  6. package/dist/lib/browser/chunk-BCYK4LXW.mjs.map +7 -0
  7. package/dist/lib/browser/{chunk-WAN2NFYE.mjs → chunk-I7FKM6VC.mjs} +6 -8
  8. package/dist/lib/browser/chunk-I7FKM6VC.mjs.map +7 -0
  9. package/dist/lib/browser/{chunk-27RZVOIE.mjs → chunk-W4AUSEGO.mjs} +62 -62
  10. package/dist/lib/browser/chunk-W4AUSEGO.mjs.map +7 -0
  11. package/dist/lib/browser/index.mjs +10 -14
  12. package/dist/lib/browser/index.mjs.map +3 -3
  13. package/dist/lib/browser/meta.json +1 -1
  14. package/dist/lib/browser/meta.mjs +1 -3
  15. package/dist/lib/browser/{react-root-A32LXEU4.mjs → react-root-QJH33RNI.mjs} +11 -10
  16. package/dist/lib/browser/react-root-QJH33RNI.mjs.map +7 -0
  17. package/dist/lib/browser/{react-surface-DIIOUUMT.mjs → react-surface-OTMERRAV.mjs} +9 -9
  18. package/dist/lib/browser/react-surface-OTMERRAV.mjs.map +7 -0
  19. package/dist/lib/browser/{state-FWUZG6NL.mjs → state-5PVJCYWJ.mjs} +7 -7
  20. package/dist/lib/browser/state-5PVJCYWJ.mjs.map +7 -0
  21. package/dist/lib/browser/types/index.mjs +10 -0
  22. package/dist/types/src/HelpPlugin.d.ts +1 -1
  23. package/dist/types/src/HelpPlugin.d.ts.map +1 -1
  24. package/dist/types/src/capabilities/app-graph-builder.d.ts +1 -1
  25. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
  26. package/dist/types/src/capabilities/capabilities.d.ts.map +1 -1
  27. package/dist/types/src/capabilities/index.d.ts +5 -5
  28. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  29. package/dist/types/src/capabilities/react-root.d.ts +2 -2
  30. package/dist/types/src/capabilities/react-root.d.ts.map +1 -1
  31. package/dist/types/src/capabilities/react-surface.d.ts +1 -1
  32. package/dist/types/src/capabilities/state.d.ts +1 -1
  33. package/dist/types/src/capabilities/state.d.ts.map +1 -1
  34. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts +1 -1
  35. package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map +1 -1
  36. package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
  37. package/dist/types/src/components/Shortcuts/ShortcutsList.d.ts.map +1 -1
  38. package/dist/types/src/components/Tooltip/Tooltip.d.ts.map +1 -1
  39. package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
  40. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts +9 -4
  41. package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
  42. package/dist/types/src/meta.d.ts +0 -1
  43. package/dist/types/src/meta.d.ts.map +1 -1
  44. package/dist/types/src/types/index.d.ts +2 -0
  45. package/dist/types/src/types/index.d.ts.map +1 -0
  46. package/dist/types/src/{types.d.ts → types/schema.d.ts} +4 -5
  47. package/dist/types/src/types/schema.d.ts.map +1 -0
  48. package/dist/types/tsconfig.tsbuildinfo +1 -1
  49. package/package.json +37 -35
  50. package/src/HelpPlugin.tsx +45 -47
  51. package/src/capabilities/app-graph-builder.ts +13 -11
  52. package/src/capabilities/capabilities.ts +3 -3
  53. package/src/capabilities/react-root.tsx +6 -4
  54. package/src/capabilities/react-surface.tsx +3 -3
  55. package/src/capabilities/state.ts +3 -2
  56. package/src/components/Shortcuts/ShortcutsDialog.tsx +6 -8
  57. package/src/components/Shortcuts/ShortcutsHints.tsx +12 -5
  58. package/src/components/Shortcuts/ShortcutsList.tsx +3 -2
  59. package/src/components/Tooltip/Tooltip.tsx +28 -27
  60. package/src/components/WelcomeTour/WelcomeTour.stories.tsx +18 -17
  61. package/src/components/WelcomeTour/WelcomeTour.tsx +15 -18
  62. package/src/meta.ts +6 -4
  63. package/src/types/index.ts +5 -0
  64. package/src/{types.ts → types/schema.ts} +3 -4
  65. package/dist/lib/browser/app-graph-builder-IXCF4ZDE.mjs.map +0 -7
  66. package/dist/lib/browser/chunk-27RZVOIE.mjs.map +0 -7
  67. package/dist/lib/browser/chunk-3Y4CMOZP.mjs +0 -13
  68. package/dist/lib/browser/chunk-3Y4CMOZP.mjs.map +0 -7
  69. package/dist/lib/browser/chunk-LDRUZNSN.mjs +0 -16
  70. package/dist/lib/browser/chunk-LDRUZNSN.mjs.map +0 -7
  71. package/dist/lib/browser/chunk-WAN2NFYE.mjs.map +0 -7
  72. package/dist/lib/browser/react-root-A32LXEU4.mjs.map +0 -7
  73. package/dist/lib/browser/react-surface-DIIOUUMT.mjs.map +0 -7
  74. package/dist/lib/browser/state-FWUZG6NL.mjs.map +0 -7
  75. package/dist/lib/browser/types.mjs +0 -12
  76. package/dist/lib/node-esm/app-graph-builder-5QQRWRWG.mjs +0 -80
  77. package/dist/lib/node-esm/app-graph-builder-5QQRWRWG.mjs.map +0 -7
  78. package/dist/lib/node-esm/chunk-6JMO5FFN.mjs +0 -37
  79. package/dist/lib/node-esm/chunk-6JMO5FFN.mjs.map +0 -7
  80. package/dist/lib/node-esm/chunk-CXQ5LKQI.mjs +0 -17
  81. package/dist/lib/node-esm/chunk-CXQ5LKQI.mjs.map +0 -7
  82. package/dist/lib/node-esm/chunk-PU7X4MJO.mjs +0 -409
  83. package/dist/lib/node-esm/chunk-PU7X4MJO.mjs.map +0 -7
  84. package/dist/lib/node-esm/chunk-T523OGIV.mjs +0 -15
  85. package/dist/lib/node-esm/chunk-T523OGIV.mjs.map +0 -7
  86. package/dist/lib/node-esm/index.mjs +0 -115
  87. package/dist/lib/node-esm/index.mjs.map +0 -7
  88. package/dist/lib/node-esm/meta.json +0 -1
  89. package/dist/lib/node-esm/meta.mjs +0 -10
  90. package/dist/lib/node-esm/meta.mjs.map +0 -7
  91. package/dist/lib/node-esm/react-root-Q6PGYYYP.mjs +0 -35
  92. package/dist/lib/node-esm/react-root-Q6PGYYYP.mjs.map +0 -7
  93. package/dist/lib/node-esm/react-surface-QEIKNNW3.mjs +0 -37
  94. package/dist/lib/node-esm/react-surface-QEIKNNW3.mjs.map +0 -7
  95. package/dist/lib/node-esm/state-Y476FGII.mjs +0 -30
  96. package/dist/lib/node-esm/state-Y476FGII.mjs.map +0 -7
  97. package/dist/lib/node-esm/types.mjs +0 -13
  98. package/dist/lib/node-esm/types.mjs.map +0 -7
  99. package/dist/types/src/types.d.ts.map +0 -1
  100. /package/dist/lib/browser/{types.mjs.map → types/index.mjs.map} +0 -0
@@ -2,13 +2,14 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import React, { useState, useEffect } from 'react';
5
+ import React, { useState } from 'react';
6
6
  import Joyride, { ACTIONS, EVENTS } from 'react-joyride';
7
7
 
8
- import { usePluginManager, useLayout } from '@dxos/app-framework';
8
+ import { useLayout, usePluginManager } from '@dxos/app-framework/react';
9
+ import { useAsyncEffect } from '@dxos/react-ui';
9
10
 
10
- import { type Step, HelpContext } from '../../types';
11
- import { floaterProps, Tooltip } from '../Tooltip';
11
+ import { HelpContext, type Step } from '../../types';
12
+ import { Tooltip, floaterProps } from '../Tooltip';
12
13
 
13
14
  const addStepClass = (target: string | HTMLElement) => {
14
15
  const element = typeof target === 'string' ? document.querySelector(target) : target;
@@ -93,20 +94,16 @@ export const WelcomeTour = ({ steps: initialSteps, running: runningProp, onRunni
93
94
  }
94
95
  };
95
96
 
96
- useEffect(() => {
97
- const timeout = setTimeout(async () => {
98
- if (runningProp) {
99
- // This handles the case when the target is not yet in the document.
100
- // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.
101
- await waitForTarget(steps[stepIndex]);
102
- setStepIndex(0);
103
- setRunning(true);
104
- } else if (typeof runningProp !== 'undefined') {
105
- setRunning(false);
106
- }
107
- });
108
-
109
- return () => clearTimeout(timeout);
97
+ useAsyncEffect(async () => {
98
+ if (runningProp) {
99
+ // This handles the case when the target is not yet in the document.
100
+ // If the target is not in the document, when the joyride is turned on, it will not show the tooltip.
101
+ await waitForTarget(steps[stepIndex]);
102
+ setStepIndex(0);
103
+ setRunning(true);
104
+ } else if (typeof runningProp !== 'undefined') {
105
+ setRunning(false);
106
+ }
110
107
  }, [runningProp]);
111
108
 
112
109
  // https://docs.react-joyride.com/callback
package/src/meta.ts CHANGED
@@ -3,12 +3,14 @@
3
3
  //
4
4
 
5
5
  import { type PluginMeta } from '@dxos/app-framework';
6
-
7
- // TODO(burdon): Rename Guide? Help?
8
- export const HELP_PLUGIN = 'dxos.org/plugin/help';
6
+ import { trim } from '@dxos/util';
9
7
 
10
8
  export const meta: PluginMeta = {
11
- id: HELP_PLUGIN,
9
+ id: 'dxos.org/plugin/help',
12
10
  name: 'Help',
11
+ description: trim`
12
+ Built-in help system with documentation, tutorials, and contextual assistance.
13
+ Access keyboard shortcuts, feature guides, and support resources.
14
+ `,
13
15
  icon: 'ph--info--regular',
14
16
  };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export * from './schema';
@@ -2,13 +2,13 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { Schema } from 'effect';
5
+ import * as Schema from 'effect/Schema';
6
6
  import { type Context, createContext } from 'react';
7
7
  import { type Step as BaseStep } from 'react-joyride';
8
8
 
9
9
  import { type PluginContext } from '@dxos/app-framework';
10
10
 
11
- import { HELP_PLUGIN } from './meta';
11
+ import { meta } from '../meta';
12
12
 
13
13
  export type Step = BaseStep & {
14
14
  before?: (context: PluginContext) => void;
@@ -32,9 +32,8 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
32
32
  stop: () => {},
33
33
  });
34
34
 
35
- export const HELP_ACTION = `${HELP_PLUGIN}/action`;
36
35
  export namespace HelpAction {
37
- export class Start extends Schema.TaggedClass<Start>()(`${HELP_ACTION}/start`, {
36
+ export class Start extends Schema.TaggedClass<Start>()(`${meta.id}/action/start`, {
38
37
  input: Schema.Void,
39
38
  output: Schema.Void,
40
39
  }) {}
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport { Option, pipe } from 'effect';\n\nimport { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';\nimport { createExtension } from '@dxos/app-graph';\n\nimport { HelpCapabilities } from './capabilities';\nimport { SHORTCUTS_DIALOG } from '../components';\nimport { HELP_PLUGIN } from '../meta';\nimport { HelpAction } from '../types';\n\nexport default (context: PluginContext) =>\n contributes(\n Capabilities.AppGraphBuilder,\n createExtension({\n id: HELP_PLUGIN,\n actions: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : Option.none())),\n Option.map(() => [\n {\n id: HelpAction.Start._tag,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n const state = context.getCapability(HelpCapabilities.MutableState);\n state.showHints = true;\n await dispatch(createIntent(HelpAction.Start));\n },\n properties: {\n label: ['open help tour', { ns: HELP_PLUGIN }],\n icon: 'ph--info--regular',\n keyBinding: {\n macos: 'shift+meta+/',\n // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n windows: 'shift+ctrl+/',\n linux: 'shift+ctrl+?',\n },\n testId: 'helpPlugin.openHelp',\n },\n },\n {\n id: 'dxos.org/plugin/help/open-shortcuts',\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n const state = context.getCapability(HelpCapabilities.MutableState);\n state.showHints = true;\n await dispatch(\n createIntent(LayoutAction.UpdateDialog, {\n part: 'dialog',\n subject: SHORTCUTS_DIALOG,\n options: {\n blockAlign: 'center',\n },\n }),\n );\n },\n properties: {\n label: ['open shortcuts label', { ns: HELP_PLUGIN }],\n icon: 'ph--keyboard--regular',\n keyBinding: {\n macos: 'meta+ctrl+/',\n },\n },\n },\n ]),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n );\n"],
5
- "mappings": ";;;;;;;;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,cAAcC,aAAaC,cAAcC,oBAAwC;AAC1F,SAASC,uBAAuB;AAOhC,IAAA,4BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC;EACJC,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAO,SAASQ,OAAOE,KAAKP,KAAAA,IAAQK,OAAOG,KAAI,CAAA,GAC9EH,OAAOI,IAAI,MAAM;IACf;MACEZ,IAAIa,WAAWC,MAAMC;MACrBC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SAASO,aAAaZ,WAAWC,KAAK,CAAA;MAC9C;MACAY,YAAY;QACVC,OAAO;UAAC;UAAkB;YAAEC,IAAI3B;UAAY;;QAC5C4B,MAAM;QACNC,YAAY;UACVC,OAAO;;UAEPC,SAAS;UACTC,OAAO;QACT;QACAC,QAAQ;MACV;IACF;IACA;MACElC,IAAI;MACJgB,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SACJO,aAAaU,aAAaC,cAAc;UACtCC,MAAM;UACNC,SAASC;UACTC,SAAS;YACPC,YAAY;UACd;QACF,CAAA,CAAA;MAEJ;MACAf,YAAY;QACVC,OAAO;UAAC;UAAwB;YAAEC,IAAI3B;UAAY;;QAClD4B,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;MACF;IACF;GACD,GACDvB,OAAOkC,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
6
- "names": ["Rx", "Option", "pipe", "Capabilities", "contributes", "createIntent", "LayoutAction", "createExtension", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "HELP_PLUGIN", "actions", "node", "Rx", "make", "get", "pipe", "Option", "flatMap", "some", "none", "map", "HelpAction", "Start", "_tag", "data", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "state", "HelpCapabilities", "MutableState", "showHints", "createIntent", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "UpdateDialog", "part", "subject", "SHORTCUTS_DIALOG", "options", "blockAlign", "getOrElse"]
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/components/Shortcuts/Key.tsx", "../../../src/components/Shortcuts/styles.ts", "../../../src/components/Shortcuts/ShortcutsList.tsx", "../../../src/components/Shortcuts/ShortcutsDialog.tsx", "../../../src/components/Shortcuts/ShortcutsHints.tsx", "../../../src/components/Shortcuts/ShortcutsSection.tsx", "../../../src/components/Tooltip/Tooltip.tsx", "../../../src/components/WelcomeTour/WelcomeTour.tsx"],
4
- "sourcesContent": ["//\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/react-ui-theme';\n\nexport const shortcutKey = mx(\n 'inline-flex min-is-[24px] bs-[24px] pli-0.5 justify-center items-center text-xs',\n 'rounded 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/react-ui-theme';\n\nimport { Key } from './Key';\nimport { HELP_PLUGIN } from '../../meta';\n\nexport const ShortcutsList = () => {\n const { t } = useTranslation(HELP_PLUGIN);\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('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued select-none')}>\n {bindings.map((binding, i) => (\n <Fragment key={i}>\n <Key binding={binding.shortcut} />\n <span role='definition' className='mis-4' aria-labelledby={binding.shortcut}>\n {toLocalizedString(binding.data, t)}\n </span>\n </Fragment>\n ))}\n </dl>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';\n\nimport { ShortcutsList } from './ShortcutsList';\nimport { HELP_PLUGIN } from '../../meta';\n\nexport const SHORTCUTS_DIALOG = `${HELP_PLUGIN}/ShortcutsDialog`;\n\nexport const ShortcutsDialogContent = () => {\n const { t } = useTranslation(HELP_PLUGIN);\n\n return (\n <Dialog.Content classNames='p-0 bs-content max-bs-full md:max-is-[25rem] overflow-hidden'>\n <div role='none' className='flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5'>\n <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>\n\n <Dialog.Close asChild>\n <Button density='fine' variant='ghost' autoFocus>\n <Icon icon='ph--x--bold' size={3} />\n </Button>\n </Dialog.Close>\n </div>\n\n <div className='flex items-center justify-center'>\n <ShortcutsList />\n </div>\n </Dialog.Content>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type KeyBinding, Keyboard } from '@dxos/keyboard';\nimport { Button, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';\n\nimport { Key } from './Key';\n\nconst Shortcut = ({ binding }: { binding: KeyBinding }) => {\n const { t } = useTranslation('os');\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 <Button variant='ghost' classNames='p-0 cursor-pointer' onClick={onClose}>\n <Icon icon='ph--x--regular' size={4} />\n </Button>\n )}\n </div>\n );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React from 'react';\n\nimport { descriptionText } from '@dxos/react-ui-theme';\n\nimport { ShortcutsList } from './ShortcutsList';\n\nexport const ShortcutsSection = () => {\n return (\n <section className={descriptionText}>\n <ShortcutsList />\n </section>\n );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useArrowNavigationGroup, useFocusableGroup } from '@fluentui/react-tabster';\nimport { CaretLeft, CaretRight, Circle, X } from '@phosphor-icons/react';\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 TooltipRenderProps, type Props } 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 } from '@dxos/react-ui';\nimport { getSize, mx } from '@dxos/react-ui-theme';\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 is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-accentSurfaceText'\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 pli-2 plb-1 text-lg font-medium text-accentSurfaceText'>{title}</h2>\n <Button\n density='fine'\n variant='primary'\n onClick={closeProps.onClick}\n title={closeProps['aria-label']}\n data-testid='helpPlugin.tooltip.close'\n >\n <X weight='bold' className={getSize(4)} />\n </Button>\n </div>\n <div className='flex grow pli-4 mlb-2'>{content}</div>\n <div className='flex p-2 items-center justify-between' {...arrowNavigationAttrs}>\n {\n <Button\n variant='primary'\n onClick={backProps.onClick}\n title={backProps['aria-label']}\n classNames={[!(index > 0 && backProps) && 'invisible']}\n data-testid='helpPlugin.tooltip.back'\n >\n <CaretLeft className={getSize(5)} />\n </Button>\n }\n <div className='flex grow gap-2 justify-center'>\n <div className='flex'>\n {Array.from({ length: size }).map((_, i) => (\n <Circle\n key={i}\n weight={index === i ? 'fill' : 'regular'}\n className={mx(getSize(2), 'mli-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 <Button\n variant='primary'\n onClick={primaryProps.onClick}\n title={primaryProps['aria-label']}\n autoFocus\n data-testid='helpPlugin.tooltip.next'\n >\n <CaretRight className={getSize(6)} />\n </Button>\n )}\n </div>\n </div>\n );\n },\n);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { useState, useEffect } from 'react';\nimport Joyride, { ACTIONS, EVENTS } from 'react-joyride';\n\nimport { usePluginManager, useLayout } from '@dxos/app-framework';\n\nimport { type Step, HelpContext } from '../../types';\nimport { floaterProps, Tooltip } 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.context);\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 useEffect(() => {\n const timeout = setTimeout(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 });\n\n return () => clearTimeout(timeout);\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 />\n </HelpContext.Provider>\n );\n};\n"],
5
- "mappings": ";;;;;;;;;AAIA,OAAOA,WAAW;AAElB,SAASC,kBAAkB;;;ACF3B,SAASC,UAAU;AAEZ,IAAMC,cAAcC,GACzB,mFACA,4CAAA;;;ADEK,IAAMC,MAAM,CAAC,EAAEC,QAAO,MAAuB;;;AAClD,WACE,sBAAA,cAACC,QAAAA;MAAKC,MAAK;MAAOC,WAAU;MAAoBC,cAAYJ;MAASK,IAAIL;OACtEM,WAAWN,OAAAA,EAASO,IAAI,CAACC,GAAGC,MAC3B,sBAAA,cAACR,QAAAA;MAAKS,KAAKD;MAAGN,WAAWQ;OACtBH,CAAAA,CAAAA,CAAAA;;;;AAKX;;;;AEhBA,OAAOI,UAASC,gBAAgB;AAEhC,SAASC,gBAAgB;AACzB,SAASC,mBAAmBC,sBAAsB;AAClD,SAASC,MAAAA,WAAU;AAKZ,IAAMC,gBAAgB,MAAA;;;AAC3B,UAAM,EAAEC,EAAC,IAAKC,eAAeC,WAAAA;AAC7B,UAAMC,WAAWC,SAASC,UAAUC,YAAW;AAG/CH,aAASI,KAAK,CAACC,GAAGC,MAAAA;AAChB,aAAOC,kBAAkBF,EAAEG,MAAMX,CAAAA,GAAIY,YAAAA,EAAcC,cAAcH,kBAAkBD,EAAEE,MAAMX,CAAAA,GAAIY,YAAAA,CAAAA;IACjG,CAAA;AAEA,WACE,gBAAAE,OAAA,cAACC,MAAAA;MAAGC,WAAWC,IAAG,4FAAA;OACfd,SAASe,IAAI,CAACC,SAASC,MACtB,gBAAAN,OAAA,cAACO,UAAAA;MAASC,KAAKF;OACb,gBAAAN,OAAA,cAACS,KAAAA;MAAIJ,SAASA,QAAQK;QACtB,gBAAAV,OAAA,cAACW,QAAAA;MAAKC,MAAK;MAAaV,WAAU;MAAQW,mBAAiBR,QAAQK;OAChEd,kBAAkBS,QAAQR,MAAMX,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA;;;;AAM7C;;;;AC9BA,OAAO4B,YAAW;AAElB,SAASC,QAAQC,QAAQC,MAAMC,kBAAAA,uBAAsB;AAK9C,IAAMC,mBAAmB,GAAGC,WAAAA;AAE5B,IAAMC,yBAAyB,MAAA;;;AACpC,UAAM,EAAEC,EAAC,IAAKC,gBAAeH,WAAAA;AAE7B,WACE,gBAAAI,OAAA,cAACC,OAAOC,SAAO;MAACC,YAAW;OACzB,gBAAAH,OAAA,cAACI,OAAAA;MAAIC,MAAK;MAAOC,WAAU;OACzB,gBAAAN,OAAA,cAACC,OAAOM,OAAK,MAAET,EAAE,wBAAA,CAAA,GAEjB,gBAAAE,OAAA,cAACC,OAAOO,OAAK;MAACC,SAAAA;OACZ,gBAAAT,OAAA,cAACU,QAAAA;MAAOC,SAAQ;MAAOC,SAAQ;MAAQC,WAAAA;OACrC,gBAAAb,OAAA,cAACc,MAAAA;MAAKC,MAAK;MAAcC,MAAM;WAKrC,gBAAAhB,OAAA,cAACI,OAAAA;MAAIE,WAAU;OACb,gBAAAN,OAAA,cAACiB,eAAAA,IAAAA,CAAAA,CAAAA;;;;AAIT;;;;AC7BA,OAAOC,YAAW;AAElB,SAA0BC,YAAAA,iBAAgB;AAC1C,SAASC,UAAAA,SAAQC,QAAAA,OAAMC,qBAAAA,oBAAmBC,kBAAAA,uBAAsB;AAIhE,IAAMC,WAAW,CAAC,EAAEC,QAAO,MAA2B;;;AACpD,UAAM,EAAEC,EAAC,IAAKC,gBAAe,IAAA;AAC7B,WACE,gBAAAC,OAAA,cAACC,OAAAA;MAAIC,MAAK;MAAOC,WAAU;OACzB,gBAAAH,OAAA,cAACI,KAAAA;MAAIP,SAASA,QAAQQ;QACtB,gBAAAL,OAAA,cAACM,QAAAA;MAAKH,WAAU;OAAWI,mBAAkBV,QAAQW,MAAMV,CAAAA,CAAAA,CAAAA;;;;AAGjE;AAEO,IAAMW,iBAAiB,CAAC,EAAEC,QAAO,MAA4B;;;AAElE,UAAMC,WAAW;MAAC;MAAU;MAAU;;AACtC,UAAMC,WAAWC,UAASC,UAAUC,YAAW;AAC/C,UAAMC,QAAQJ,SAASK,OAAO,CAACpB,YAAYc,SAASO,SAASrB,QAAQQ,QAAQ,CAAA;AAE7E,WACE,gBAAAL,OAAA,cAACC,OAAAA;MAAIC,MAAK;MAAOC,WAAU;OACxBa,MAAMG,IAAI,CAACtB,YACV,gBAAAG,OAAA,cAACJ,UAAAA;MAASwB,KAAKvB,QAAQQ;MAAUR;SAElCa,WACC,gBAAAV,OAAA,cAACqB,SAAAA;MAAOC,SAAQ;MAAQC,YAAW;MAAqBC,SAASd;OAC/D,gBAAAV,OAAA,cAACyB,OAAAA;MAAKC,MAAK;MAAiBC,MAAM;;;;;AAK5C;;;;ACnCA,OAAOC,YAAW;AAElB,SAASC,uBAAuB;AAIzB,IAAMC,mBAAmB,MAAA;;;AAC9B,WACE,gBAAAC,OAAA,cAACC,WAAAA;MAAQC,WAAWC;OAClB,gBAAAH,OAAA,cAACI,eAAAA,IAAAA,CAAAA;;;;AAGP;;;;ACZA,SAASC,yBAAyBC,yBAAyB;AAC3D,SAASC,WAAWC,YAAYC,QAAQC,SAAS;AACjD,OAAOC,UAASC,kBAAkB;AASlC,SAASC,UAAAA,eAAc;AACvB,SAASC,SAASC,MAAAA,WAAU;AAIrB,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,UAAMC,uBAAuBC,wBAAwB;MAAEC,MAAM;IAAa,CAAA;AAC1E,UAAMC,sBAAsBC,kBAAkB;MAAEC,aAAa;IAAqB,CAAA;AAElF,WACE,gBAAAC,OAAA,cAACC,OAAAA;MACCC,WAAU;MACVC,MAAK;MACLC,eAAY;MACZC,aAAWlB,QAAQ;MAClB,GAAGU;MACJS,KAAKb;OAEL,gBAAAO,OAAA,cAACC,OAAAA;MAAIC,WAAU;OACb,gBAAAF,OAAA,cAACO,MAAAA;MAAGL,WAAU;OAA+DjB,KAAAA,GAC7E,gBAAAe,OAAA,cAACQ,SAAAA;MACCC,SAAQ;MACRC,SAAQ;MACRC,SAASpB,WAAWoB;MACpB1B,OAAOM,WAAW,YAAA;MAClBa,eAAY;OAEZ,gBAAAJ,OAAA,cAACY,GAAAA;MAAEC,QAAO;MAAOX,WAAWY,QAAQ,CAAA;UAGxC,gBAAAd,OAAA,cAACC,OAAAA;MAAIC,WAAU;OAAyBhB,OAAAA,GACxC,gBAAAc,OAAA,cAACC,OAAAA;MAAIC,WAAU;MAAyC,GAAGR;OAEvD,gBAAAM,OAAA,cAACQ,SAAAA;MACCE,SAAQ;MACRC,SAASrB,UAAUqB;MACnB1B,OAAOK,UAAU,YAAA;MACjByB,YAAY;QAAC,EAAE5B,QAAQ,KAAKG,cAAc;;MAC1Cc,eAAY;OAEZ,gBAAAJ,OAAA,cAACgB,WAAAA;MAAUd,WAAWY,QAAQ,CAAA;SAGlC,gBAAAd,OAAA,cAACC,OAAAA;MAAIC,WAAU;OACb,gBAAAF,OAAA,cAACC,OAAAA;MAAIC,WAAU;OACZe,MAAMC,KAAK;MAAExC,QAAQU;IAAK,CAAA,EAAG+B,IAAI,CAACC,GAAGC,MACpC,gBAAArB,OAAA,cAACsB,QAAAA;MACCC,KAAKF;MACLR,QAAQ1B,UAAUkC,IAAI,SAAS;MAC/BnB,WAAWsB,IAAGV,QAAQ,CAAA,GAAI,sBAAA;WAKjCzB,aACC,gBAAAW,OAAA,cAACQ,SAAAA;MACCE,SAAQ;MACRC,SAASpB,WAAWoB;MACpB1B,OAAOM,WAAW,YAAA;MAClBkC,WAAAA;MACArB,eAAY;OACb,MAAA,IAID,gBAAAJ,OAAA,cAACQ,SAAAA;MACCE,SAAQ;MACRC,SAASnB,aAAamB;MACtB1B,OAAOO,aAAa,YAAA;MACpBiC,WAAAA;MACArB,eAAY;OAEZ,gBAAAJ,OAAA,cAAC0B,YAAAA;MAAWxB,WAAWY,QAAQ,CAAA;;;;;AAM3C,CAAA;;;;ACzGF,OAAOa,UAASC,UAAUC,iBAAiB;AAC3C,OAAOC,WAAWC,SAASC,cAAc;AAEzC,SAASC,kBAAkBC,iBAAiB;AAK5C,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,UAAMC,UAAUC,iBAAAA;AAChB,UAAMC,SAASC,UAAAA;AACf,UAAM,CAACN,SAASO,UAAAA,IAAcC,SAAS,CAAC,CAACP,eAAe,CAAC,CAACrB,UAAUmB,aAAa,CAAA,CAAE,CAAA;AACnF,UAAM,CAACU,WAAWC,aAAAA,IAAiBF,SAAS,CAAA;AAC5C,UAAM,CAACV,OAAOa,QAAAA,IAAYH,SAAST,YAAAA;AAEnC,UAAMa,SAASP,OAAOQ;AAEtB,UAAMC,eAAe,CAACC,UAAAA;AACpB,UAAId,aAAa;AACf,cAAMpB,OAAOiB,MAAMiB,KAAAA;AACnBlC,cAAMmC,SAASb,QAAQc,OAAO;MAChC;AACAP,oBAAcK,KAAAA;IAChB;AAEA,UAAMG,oBAAoB,CAACC,UAAAA;AACzB,UAAI,OAAOlB,gBAAgB,aAAa;AACtCC,2BAAmBiB,KAAAA;MACrB,OAAO;AACL,YAAIA,OAAO;AACTL,uBAAa,CAAA;AACbP,qBAAW,IAAA;QACb,OAAO;AACLA,qBAAW,KAAA;QACb;MACF;IACF;AAEAa,cAAU,MAAA;AACR,YAAMC,UAAUC,WAAW,YAAA;AACzB,YAAIrB,aAAa;AAGf,gBAAMnB,cAAcgB,MAAMW,SAAAA,CAAU;AACpCK,uBAAa,CAAA;AACbP,qBAAW,IAAA;QACb,WAAW,OAAON,gBAAgB,aAAa;AAC7CM,qBAAW,KAAA;QACb;MACF,CAAA;AAEA,aAAO,MAAMgB,aAAaF,OAAAA;IAC5B,GAAG;MAACpB;KAAY;AAGhB,UAAMuB,WAAgC,OAAOC,YAAAA;AAC3C,YAAM,EAAEC,MAAMC,QAAQZ,OAAOa,KAAI,IAAKH;AACtC,cAAQC,MAAAA;QACN,KAAKG,OAAOC;AACV3D,uBAAasD,QAAQ5C,KAAKT,MAAM;AAChC;QACF,KAAKyD,OAAOE;AACV;QACF,KAAKF,OAAOG;AACVtD,4BAAkB+C,QAAQ5C,KAAKT,MAAM;AACrC,kBAAQuD,QAAAA;YACN,KAAKM,QAAQC;AACX,kBAAInB,QAAQa,OAAO,GAAG;AACpBd,6BAAaC,QAAQ,CAAA;cACvB;AACA;YACF,KAAKkB,QAAQE;AACX,kBAAIpB,QAAQ,GAAG;AACbD,6BAAaC,QAAQ,CAAA;cACvB;AACA;YACF,KAAKkB,QAAQG;AACXlB,gCAAkB,KAAA;AAClBJ,2BAAa,CAAA;AACb;UACJ;AACA;MACJ;IACF;AAEA,WACE,gBAAAuB,OAAA,cAACC,YAAYC,UAAQ;MACnBC,OAAO;QACLxC,SAASA,WAAW,CAACY;QACrBd;QACAa;QACA8B,UAAU3B;QACV4B,OAAO,MAAMxB,kBAAkB,IAAA;QAC/ByB,MAAM,MAAMzB,kBAAkB,KAAA;MAChC;OAEA,gBAAAmB,OAAA,cAACO,SAAAA,MACE;;UAEC,GAEJ,gBAAAP,OAAA,cAACQ,SAAAA;MACCC,YAAY;MACZhD;MACAW;MACAsC,KAAK/C,WAAW,CAACY;MACjBY;MACAwB;MACAC,kBAAkBC;;;;;AAI1B;",
6
- "names": ["React", "keySymbols", "mx", "shortcutKey", "mx", "Key", "binding", "span", "role", "className", "aria-label", "id", "keySymbols", "map", "c", "i", "key", "shortcutKey", "React", "Fragment", "Keyboard", "toLocalizedString", "useTranslation", "mx", "ShortcutsList", "t", "useTranslation", "HELP_PLUGIN", "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", "Button", "Dialog", "Icon", "useTranslation", "SHORTCUTS_DIALOG", "HELP_PLUGIN", "ShortcutsDialogContent", "t", "useTranslation", "React", "Dialog", "Content", "classNames", "div", "role", "className", "Title", "Close", "asChild", "Button", "density", "variant", "autoFocus", "Icon", "icon", "size", "ShortcutsList", "React", "Keyboard", "Button", "Icon", "toLocalizedString", "useTranslation", "Shortcut", "binding", "t", "useTranslation", "React", "div", "role", "className", "Key", "shortcut", "span", "toLocalizedString", "data", "ShortcutsHints", "onClose", "defaults", "bindings", "Keyboard", "singleton", "getBindings", "hints", "filter", "includes", "map", "key", "Button", "variant", "classNames", "onClick", "Icon", "icon", "size", "React", "descriptionText", "ShortcutsSection", "React", "section", "className", "descriptionText", "ShortcutsList", "useArrowNavigationGroup", "useFocusableGroup", "CaretLeft", "CaretRight", "Circle", "X", "React", "forwardRef", "Button", "getSize", "mx", "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", "Button", "density", "variant", "onClick", "X", "weight", "getSize", "classNames", "CaretLeft", "Array", "from", "map", "_", "i", "Circle", "key", "mx", "autoFocus", "CaretRight", "React", "useState", "useEffect", "Joyride", "ACTIONS", "EVENTS", "usePluginManager", "useLayout", "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", "context", "setRunningChanged", "state", "useEffect", "timeout", "setTimeout", "clearTimeout", "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"]
7
- }
@@ -1,13 +0,0 @@
1
- // src/meta.ts
2
- var HELP_PLUGIN = "dxos.org/plugin/help";
3
- var meta = {
4
- id: HELP_PLUGIN,
5
- name: "Help",
6
- icon: "ph--info--regular"
7
- };
8
-
9
- export {
10
- HELP_PLUGIN,
11
- meta
12
- };
13
- //# sourceMappingURL=chunk-3Y4CMOZP.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/meta.ts"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\n// TODO(burdon): Rename Guide? Help?\nexport const HELP_PLUGIN = 'dxos.org/plugin/help';\n\nexport const meta: PluginMeta = {\n id: HELP_PLUGIN,\n name: 'Help',\n icon: 'ph--info--regular',\n};\n"],
5
- "mappings": ";AAOO,IAAMA,cAAc;AAEpB,IAAMC,OAAmB;EAC9BC,IAAIF;EACJG,MAAM;EACNC,MAAM;AACR;",
6
- "names": ["HELP_PLUGIN", "meta", "id", "name", "icon"]
7
- }
@@ -1,16 +0,0 @@
1
- import {
2
- HELP_PLUGIN
3
- } from "./chunk-3Y4CMOZP.mjs";
4
-
5
- // src/capabilities/capabilities.ts
6
- import { defineCapability } from "@dxos/app-framework";
7
- (function(HelpCapabilities2) {
8
- HelpCapabilities2.State = defineCapability(`${HELP_PLUGIN}/capability/state`);
9
- HelpCapabilities2.MutableState = defineCapability(`${HELP_PLUGIN}/capability/state`);
10
- })(HelpCapabilities || (HelpCapabilities = {}));
11
- var HelpCapabilities;
12
-
13
- export {
14
- HelpCapabilities
15
- };
16
- //# sourceMappingURL=chunk-LDRUZNSN.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/capabilities.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineCapability } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from '../meta';\n\nexport namespace HelpCapabilities {\n export type State = { running: boolean; showHints: boolean; showWelcome: boolean };\n export const State = defineCapability<Readonly<State>>(`${HELP_PLUGIN}/capability/state`);\n export const MutableState = defineCapability<State>(`${HELP_PLUGIN}/capability/state`);\n}\n"],
5
- "mappings": ";;;;;AAIA,SAASA,wBAAwB;UAIhBC,mBAAAA;oBAEFC,QAAQC,iBAAkC,GAAGC,WAAAA,mBAA8B;oBAC3EC,eAAeF,iBAAwB,GAAGC,WAAAA,mBAA8B;AACvF,GAJiBH,qBAAAA,mBAAAA,CAAAA,EAAAA;;",
6
- "names": ["defineCapability", "HelpCapabilities", "State", "defineCapability", "HELP_PLUGIN", "MutableState"]
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/types.ts"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Schema } from 'effect';\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { type PluginContext } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from './meta';\n\nexport type Step = BaseStep & {\n before?: (context: PluginContext) => 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\nexport const HELP_ACTION = `${HELP_PLUGIN}/action`;\nexport namespace HelpAction {\n export class Start extends Schema.TaggedClass<Start>()(`${HELP_ACTION}/start`, {\n input: Schema.Void,\n output: Schema.Void,\n }) {}\n}\n"],
5
- "mappings": ";;;;;AAIA,SAASA,cAAc;AACvB,SAAuBC,qBAAqB;AAoBrC,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;AAEO,IAAMC,cAAc,GAAGC,WAAAA;UACbC,aAAAA;EACR,MAAMC,cAAcC,OAAOC,YAAW,EAAU,GAAGL,WAAAA,UAAqB;IAC7EM,OAAOF,OAAOG;IACdC,QAAQJ,OAAOG;EACjB,CAAA,EAAA;EAAI;cAHSJ,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;;",
6
- "names": ["Schema", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_ACTION", "HELP_PLUGIN", "HelpAction", "Start", "Schema", "TaggedClass", "input", "Void", "output"]
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/react-root.tsx"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Capabilities, contributes, useCapability } from '@dxos/app-framework';\n\nimport { HelpCapabilities } from './capabilities';\nimport { WelcomeTour } from '../components';\nimport { HELP_PLUGIN } from '../meta';\nimport { type Step } from '../types';\n\nexport default (steps: Step[]) =>\n contributes(Capabilities.ReactRoot, {\n id: HELP_PLUGIN,\n root: () => {\n const state = useCapability(HelpCapabilities.MutableState);\n return (\n <WelcomeTour\n steps={steps}\n running={state.running}\n onRunningChanged={(newState) => {\n state.running = newState;\n if (!newState) {\n state.showHints = false;\n }\n }}\n />\n );\n },\n });\n"],
5
- "mappings": ";;;;;;;;;;;;AAIA,OAAOA,WAAW;AAElB,SAASC,cAAcC,aAAaC,qBAAqB;AAOzD,IAAA,qBAAe,CAACC,UACdC,YAAYC,aAAaC,WAAW;EAClCC,IAAIC;EACJC,MAAM,MAAA;AACJ,UAAMC,QAAQC,cAAcC,iBAAiBC,YAAY;AACzD,WACE,sBAAA,cAACC,aAAAA;MACCX;MACAY,SAASL,MAAMK;MACfC,kBAAkB,CAACC,aAAAA;AACjBP,cAAMK,UAAUE;AAChB,YAAI,CAACA,UAAU;AACbP,gBAAMQ,YAAY;QACpB;MACF;;EAGN;AACF,CAAA;",
6
- "names": ["React", "Capabilities", "contributes", "useCapability", "steps", "contributes", "Capabilities", "ReactRoot", "id", "HELP_PLUGIN", "root", "state", "useCapability", "HelpCapabilities", "MutableState", "WelcomeTour", "running", "onRunningChanged", "newState", "showHints"]
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/react-surface.tsx"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Capabilities, contributes, createSurface } from '@dxos/app-framework';\n\nimport { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../components';\nimport { HELP_PLUGIN } from '../meta';\n\nexport default () =>\n contributes(Capabilities.ReactSurface, [\n createSurface({\n id: `${HELP_PLUGIN}/hints`,\n role: 'hints',\n component: () => <ShortcutsHints />,\n }),\n createSurface({\n id: `${HELP_PLUGIN}/keyshortcuts`,\n role: 'keyshortcuts',\n component: () => <ShortcutsList />,\n }),\n createSurface({\n id: SHORTCUTS_DIALOG,\n role: 'dialog',\n filter: (data): data is any => data.component === SHORTCUTS_DIALOG,\n component: () => <ShortcutsDialogContent />,\n }),\n ]);\n"],
5
- "mappings": ";;;;;;;;;;;;AAIA,OAAOA,WAAW;AAElB,SAASC,cAAcC,aAAaC,qBAAqB;AAKzD,IAAA,wBAAe,MACbC,YAAYC,aAAaC,cAAc;EACrCC,cAAc;IACZC,IAAI,GAAGC,WAAAA;IACPC,MAAM;IACNC,WAAW,MAAM,sBAAA,cAACC,gBAAAA,IAAAA;EACpB,CAAA;EACAL,cAAc;IACZC,IAAI,GAAGC,WAAAA;IACPC,MAAM;IACNC,WAAW,MAAM,sBAAA,cAACE,eAAAA,IAAAA;EACpB,CAAA;EACAN,cAAc;IACZC,IAAIM;IACJJ,MAAM;IACNK,QAAQ,CAACC,SAAsBA,KAAKL,cAAcG;IAClDH,WAAW,MAAM,sBAAA,cAACM,wBAAAA,IAAAA;EACpB,CAAA;CACD;",
6
- "names": ["React", "Capabilities", "contributes", "createSurface", "contributes", "Capabilities", "ReactSurface", "createSurface", "id", "HELP_PLUGIN", "role", "component", "ShortcutsHints", "ShortcutsList", "SHORTCUTS_DIALOG", "filter", "data", "ShortcutsDialogContent"]
7
- }
@@ -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 { HelpCapabilities } from './capabilities';\nimport { HELP_PLUGIN } from '../meta';\n\nexport default () => {\n const state = new LocalStorageStore<HelpCapabilities.State>(HELP_PLUGIN, {\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;AAKlC,IAAA,gBAAe,MAAA;AACb,QAAMC,QAAQ,IAAIC,kBAA0CC,aAAa;IACvEC,SAAS;IACTC,WAAW;IACXC,aAAa;EACf,CAAA;AAEAL,QACGM,KAAK;IAAEC,KAAK;IAAaC,MAAMP,kBAAkBQ,KAAI;EAAG,CAAA,EACxDH,KAAK;IAAEC,KAAK;IAAeC,MAAMP,kBAAkBQ,KAAI;EAAG,CAAA;AAE7D,SAAOC,YAAYC,iBAAiBC,OAAOZ,MAAMa,MAAM;AACzD;",
6
- "names": ["contributes", "LocalStorageStore", "state", "LocalStorageStore", "HELP_PLUGIN", "running", "showHints", "showWelcome", "prop", "key", "type", "bool", "contributes", "HelpCapabilities", "State", "values"]
7
- }
@@ -1,12 +0,0 @@
1
- import {
2
- HELP_ACTION,
3
- HelpAction,
4
- HelpContext
5
- } from "./chunk-WAN2NFYE.mjs";
6
- import "./chunk-3Y4CMOZP.mjs";
7
- export {
8
- HELP_ACTION,
9
- HelpAction,
10
- HelpContext
11
- };
12
- //# sourceMappingURL=types.mjs.map
@@ -1,80 +0,0 @@
1
- import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
2
- import {
3
- SHORTCUTS_DIALOG
4
- } from "./chunk-PU7X4MJO.mjs";
5
- import {
6
- HelpAction
7
- } from "./chunk-6JMO5FFN.mjs";
8
- import {
9
- HelpCapabilities
10
- } from "./chunk-CXQ5LKQI.mjs";
11
- import {
12
- HELP_PLUGIN
13
- } from "./chunk-T523OGIV.mjs";
14
-
15
- // src/capabilities/app-graph-builder.ts
16
- import { Rx } from "@effect-rx/rx-react";
17
- import { Option, pipe } from "effect";
18
- import { Capabilities, contributes, createIntent, LayoutAction } from "@dxos/app-framework";
19
- import { createExtension } from "@dxos/app-graph";
20
- var app_graph_builder_default = (context) => contributes(Capabilities.AppGraphBuilder, createExtension({
21
- id: HELP_PLUGIN,
22
- actions: (node) => Rx.make((get) => pipe(get(node), Option.flatMap((node2) => node2.id === "root" ? Option.some(node2) : Option.none()), Option.map(() => [
23
- {
24
- id: HelpAction.Start._tag,
25
- data: async () => {
26
- const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
27
- const state = context.getCapability(HelpCapabilities.MutableState);
28
- state.showHints = true;
29
- await dispatch(createIntent(HelpAction.Start));
30
- },
31
- properties: {
32
- label: [
33
- "open help tour",
34
- {
35
- ns: HELP_PLUGIN
36
- }
37
- ],
38
- icon: "ph--info--regular",
39
- keyBinding: {
40
- macos: "shift+meta+/",
41
- // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
42
- windows: "shift+ctrl+/",
43
- linux: "shift+ctrl+?"
44
- },
45
- testId: "helpPlugin.openHelp"
46
- }
47
- },
48
- {
49
- id: "dxos.org/plugin/help/open-shortcuts",
50
- data: async () => {
51
- const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
52
- const state = context.getCapability(HelpCapabilities.MutableState);
53
- state.showHints = true;
54
- await dispatch(createIntent(LayoutAction.UpdateDialog, {
55
- part: "dialog",
56
- subject: SHORTCUTS_DIALOG,
57
- options: {
58
- blockAlign: "center"
59
- }
60
- }));
61
- },
62
- properties: {
63
- label: [
64
- "open shortcuts label",
65
- {
66
- ns: HELP_PLUGIN
67
- }
68
- ],
69
- icon: "ph--keyboard--regular",
70
- keyBinding: {
71
- macos: "meta+ctrl+/"
72
- }
73
- }
74
- }
75
- ]), Option.getOrElse(() => [])))
76
- }));
77
- export {
78
- app_graph_builder_default as default
79
- };
80
- //# sourceMappingURL=app-graph-builder-5QQRWRWG.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport { Option, pipe } from 'effect';\n\nimport { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';\nimport { createExtension } from '@dxos/app-graph';\n\nimport { HelpCapabilities } from './capabilities';\nimport { SHORTCUTS_DIALOG } from '../components';\nimport { HELP_PLUGIN } from '../meta';\nimport { HelpAction } from '../types';\n\nexport default (context: PluginContext) =>\n contributes(\n Capabilities.AppGraphBuilder,\n createExtension({\n id: HELP_PLUGIN,\n actions: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : Option.none())),\n Option.map(() => [\n {\n id: HelpAction.Start._tag,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n const state = context.getCapability(HelpCapabilities.MutableState);\n state.showHints = true;\n await dispatch(createIntent(HelpAction.Start));\n },\n properties: {\n label: ['open help tour', { ns: HELP_PLUGIN }],\n icon: 'ph--info--regular',\n keyBinding: {\n macos: 'shift+meta+/',\n // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n windows: 'shift+ctrl+/',\n linux: 'shift+ctrl+?',\n },\n testId: 'helpPlugin.openHelp',\n },\n },\n {\n id: 'dxos.org/plugin/help/open-shortcuts',\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n const state = context.getCapability(HelpCapabilities.MutableState);\n state.showHints = true;\n await dispatch(\n createIntent(LayoutAction.UpdateDialog, {\n part: 'dialog',\n subject: SHORTCUTS_DIALOG,\n options: {\n blockAlign: 'center',\n },\n }),\n );\n },\n properties: {\n label: ['open shortcuts label', { ns: HELP_PLUGIN }],\n icon: 'ph--keyboard--regular',\n keyBinding: {\n macos: 'meta+ctrl+/',\n },\n },\n },\n ]),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n );\n"],
5
- "mappings": ";;;;;;;;;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,cAAcC,aAAaC,cAAcC,oBAAwC;AAC1F,SAASC,uBAAuB;AAOhC,IAAA,4BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC;EACJC,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAO,SAASQ,OAAOE,KAAKP,KAAAA,IAAQK,OAAOG,KAAI,CAAA,GAC9EH,OAAOI,IAAI,MAAM;IACf;MACEZ,IAAIa,WAAWC,MAAMC;MACrBC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SAASO,aAAaZ,WAAWC,KAAK,CAAA;MAC9C;MACAY,YAAY;QACVC,OAAO;UAAC;UAAkB;YAAEC,IAAI3B;UAAY;;QAC5C4B,MAAM;QACNC,YAAY;UACVC,OAAO;;UAEPC,SAAS;UACTC,OAAO;QACT;QACAC,QAAQ;MACV;IACF;IACA;MACElC,IAAI;MACJgB,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SACJO,aAAaU,aAAaC,cAAc;UACtCC,MAAM;UACNC,SAASC;UACTC,SAAS;YACPC,YAAY;UACd;QACF,CAAA,CAAA;MAEJ;MACAf,YAAY;QACVC,OAAO;UAAC;UAAwB;YAAEC,IAAI3B;UAAY;;QAClD4B,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;MACF;IACF;GACD,GACDvB,OAAOkC,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
6
- "names": ["Rx", "Option", "pipe", "Capabilities", "contributes", "createIntent", "LayoutAction", "createExtension", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "HELP_PLUGIN", "actions", "node", "Rx", "make", "get", "pipe", "Option", "flatMap", "some", "none", "map", "HelpAction", "Start", "_tag", "data", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "state", "HelpCapabilities", "MutableState", "showHints", "createIntent", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "UpdateDialog", "part", "subject", "SHORTCUTS_DIALOG", "options", "blockAlign", "getOrElse"]
7
- }
@@ -1,37 +0,0 @@
1
- import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
2
- import {
3
- HELP_PLUGIN
4
- } from "./chunk-T523OGIV.mjs";
5
-
6
- // src/types.ts
7
- import { Schema } from "effect";
8
- import { createContext } from "react";
9
- var HelpContext = createContext({
10
- running: false,
11
- steps: [],
12
- setSteps: () => {
13
- },
14
- setIndex: () => {
15
- },
16
- start: () => {
17
- },
18
- stop: () => {
19
- }
20
- });
21
- var HELP_ACTION = `${HELP_PLUGIN}/action`;
22
- (function(HelpAction2) {
23
- class Start extends Schema.TaggedClass()(`${HELP_ACTION}/start`, {
24
- input: Schema.Void,
25
- output: Schema.Void
26
- }) {
27
- }
28
- HelpAction2.Start = Start;
29
- })(HelpAction || (HelpAction = {}));
30
- var HelpAction;
31
-
32
- export {
33
- HelpContext,
34
- HELP_ACTION,
35
- HelpAction
36
- };
37
- //# sourceMappingURL=chunk-6JMO5FFN.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/types.ts"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Schema } from 'effect';\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { type PluginContext } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from './meta';\n\nexport type Step = BaseStep & {\n before?: (context: PluginContext) => 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\nexport const HELP_ACTION = `${HELP_PLUGIN}/action`;\nexport namespace HelpAction {\n export class Start extends Schema.TaggedClass<Start>()(`${HELP_ACTION}/start`, {\n input: Schema.Void,\n output: Schema.Void,\n }) {}\n}\n"],
5
- "mappings": ";;;;;;AAIA,SAASA,cAAc;AACvB,SAAuBC,qBAAqB;AAoBrC,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;AAEO,IAAMC,cAAc,GAAGC,WAAAA;UACbC,aAAAA;EACR,MAAMC,cAAcC,OAAOC,YAAW,EAAU,GAAGL,WAAAA,UAAqB;IAC7EM,OAAOF,OAAOG;IACdC,QAAQJ,OAAOG;EACjB,CAAA,EAAA;EAAI;cAHSJ,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;;",
6
- "names": ["Schema", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_ACTION", "HELP_PLUGIN", "HelpAction", "Start", "Schema", "TaggedClass", "input", "Void", "output"]
7
- }
@@ -1,17 +0,0 @@
1
- import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
2
- import {
3
- HELP_PLUGIN
4
- } from "./chunk-T523OGIV.mjs";
5
-
6
- // src/capabilities/capabilities.ts
7
- import { defineCapability } from "@dxos/app-framework";
8
- (function(HelpCapabilities2) {
9
- HelpCapabilities2.State = defineCapability(`${HELP_PLUGIN}/capability/state`);
10
- HelpCapabilities2.MutableState = defineCapability(`${HELP_PLUGIN}/capability/state`);
11
- })(HelpCapabilities || (HelpCapabilities = {}));
12
- var HelpCapabilities;
13
-
14
- export {
15
- HelpCapabilities
16
- };
17
- //# sourceMappingURL=chunk-CXQ5LKQI.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/capabilities.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineCapability } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from '../meta';\n\nexport namespace HelpCapabilities {\n export type State = { running: boolean; showHints: boolean; showWelcome: boolean };\n export const State = defineCapability<Readonly<State>>(`${HELP_PLUGIN}/capability/state`);\n export const MutableState = defineCapability<State>(`${HELP_PLUGIN}/capability/state`);\n}\n"],
5
- "mappings": ";;;;;;AAIA,SAASA,wBAAwB;UAIhBC,mBAAAA;oBAEFC,QAAQC,iBAAkC,GAAGC,WAAAA,mBAA8B;oBAC3EC,eAAeF,iBAAwB,GAAGC,WAAAA,mBAA8B;AACvF,GAJiBH,qBAAAA,mBAAAA,CAAAA,EAAAA;;",
6
- "names": ["defineCapability", "HelpCapabilities", "State", "defineCapability", "HELP_PLUGIN", "MutableState"]
7
- }