@dxos/plugin-help 0.8.4-main.9be5663bfe → 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.
- package/dist/lib/browser/{chunk-K4LQ2TR7.mjs → chunk-53QC3FTJ.mjs} +1 -1
- package/dist/lib/browser/{chunk-K4LQ2TR7.mjs.map → chunk-53QC3FTJ.mjs.map} +2 -2
- package/dist/lib/browser/{chunk-TEXIV2IJ.mjs → chunk-EEXGETLQ.mjs} +1 -1
- package/dist/lib/browser/{chunk-TEXIV2IJ.mjs.map → chunk-EEXGETLQ.mjs.map} +2 -2
- package/dist/lib/browser/{chunk-KUUIRJG5.mjs → chunk-RWK34XL5.mjs} +2 -2
- package/dist/lib/browser/chunk-RWK34XL5.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +9 -380
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/meta.mjs +1 -1
- package/dist/lib/browser/operations/index.mjs +3 -3
- package/dist/lib/browser/operations/index.mjs.map +3 -3
- package/dist/lib/browser/{start-YZBO346C.mjs → start-JQ2LLVCT.mjs} +4 -4
- package/dist/lib/browser/{start-YZBO346C.mjs.map → start-JQ2LLVCT.mjs.map} +1 -1
- package/dist/lib/browser/translations.mjs +20 -0
- package/dist/lib/browser/translations.mjs.map +7 -0
- package/dist/lib/browser/types/index.mjs +1 -1
- package/dist/types/src/HelpPlugin.d.ts +1 -0
- package/dist/types/src/HelpPlugin.d.ts.map +1 -1
- package/dist/types/src/HelpPlugin.test.d.ts +2 -0
- package/dist/types/src/HelpPlugin.test.d.ts.map +1 -0
- package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
- package/dist/types/src/capabilities/index.d.ts +1 -1
- package/dist/types/src/capabilities/index.d.ts.map +1 -1
- package/dist/types/src/capabilities/operation-handler.d.ts +1 -1
- package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -1
- package/dist/types/src/capabilities/react-root.d.ts.map +1 -1
- package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
- package/dist/types/src/capabilities/state.d.ts.map +1 -1
- package/dist/types/src/components/Shortcuts/Key.d.ts.map +1 -1
- package/dist/types/src/components/Shortcuts/ShortcutsHints.d.ts.map +1 -1
- package/dist/types/src/components/Tooltip/Tooltip.d.ts +9 -9
- package/dist/types/src/components/WelcomeTour/WelcomeTour.d.ts.map +1 -1
- package/dist/types/src/components/WelcomeTour/WelcomeTour.stories.d.ts.map +1 -1
- package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts +5 -5
- package/dist/types/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.d.ts.map +1 -1
- package/dist/types/src/index.d.ts +3 -3
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/operations/definitions.d.ts +1 -1
- package/dist/types/src/operations/definitions.d.ts.map +1 -1
- package/dist/types/src/operations/index.d.ts +1 -1
- package/dist/types/src/operations/index.d.ts.map +1 -1
- package/dist/types/src/operations/start.d.ts +1 -1
- package/dist/types/src/operations/start.d.ts.map +1 -1
- package/dist/types/src/translations.d.ts +5 -6
- package/dist/types/src/translations.d.ts.map +1 -1
- package/dist/types/src/types/capabilities.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +30 -35
- package/src/HelpPlugin.test.ts +30 -0
- package/src/HelpPlugin.tsx +3 -2
- package/src/capabilities/app-graph-builder.ts +1 -1
- package/src/capabilities/index.ts +1 -1
- package/src/capabilities/operation-handler.ts +1 -1
- package/src/capabilities/react-surface.tsx +1 -2
- package/src/components/WelcomeTour/WelcomeTour.tsx +1 -0
- package/src/containers/ShortcutsDialogContent/ShortcutsDialogContent.stories.tsx +2 -1
- package/src/index.ts +7 -3
- package/src/operations/definitions.ts +1 -1
- package/src/operations/index.ts +1 -1
- package/src/operations/start.ts +1 -1
- package/dist/lib/browser/chunk-KUUIRJG5.mjs.map +0 -7
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/plugin-help",
|
|
3
|
-
"version": "0.8.4-main.
|
|
3
|
+
"version": "0.8.4-main.abd8ff62ef",
|
|
4
4
|
"description": "Help plugin.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -13,12 +13,14 @@
|
|
|
13
13
|
"sideEffects": true,
|
|
14
14
|
"type": "module",
|
|
15
15
|
"imports": {
|
|
16
|
+
"#plugin": "./src/HelpPlugin.tsx",
|
|
16
17
|
"#capabilities": "./src/capabilities/index.ts",
|
|
17
18
|
"#components": "./src/components/index.ts",
|
|
18
19
|
"#containers": "./src/containers/index.ts",
|
|
19
20
|
"#hooks": "./src/hooks/index.ts",
|
|
20
21
|
"#meta": "./src/meta.ts",
|
|
21
22
|
"#operations": "./src/operations/index.ts",
|
|
23
|
+
"#translations": "./src/translations.ts",
|
|
22
24
|
"#types": "./src/types/index.ts"
|
|
23
25
|
},
|
|
24
26
|
"exports": {
|
|
@@ -37,6 +39,12 @@
|
|
|
37
39
|
"types": "./dist/types/src/operations/index.d.ts",
|
|
38
40
|
"browser": "./dist/lib/browser/operations/index.mjs"
|
|
39
41
|
},
|
|
42
|
+
"./translations": {
|
|
43
|
+
"source": "./src/translations.ts",
|
|
44
|
+
"types": "./dist/types/src/translations.d.ts",
|
|
45
|
+
"browser": "./dist/lib/browser/translations.mjs",
|
|
46
|
+
"node": "./dist/lib/node-esm/translations.mjs"
|
|
47
|
+
},
|
|
40
48
|
"./types": {
|
|
41
49
|
"source": "./src/types/index.ts",
|
|
42
50
|
"types": "./dist/types/src/types/index.d.ts",
|
|
@@ -44,19 +52,6 @@
|
|
|
44
52
|
}
|
|
45
53
|
},
|
|
46
54
|
"types": "dist/types/src/index.d.ts",
|
|
47
|
-
"typesVersions": {
|
|
48
|
-
"*": {
|
|
49
|
-
"meta": [
|
|
50
|
-
"dist/types/src/meta.d.ts"
|
|
51
|
-
],
|
|
52
|
-
"types": [
|
|
53
|
-
"dist/types/src/types/index.d.ts"
|
|
54
|
-
],
|
|
55
|
-
"operations": [
|
|
56
|
-
"dist/types/src/operations/index.d.ts"
|
|
57
|
-
]
|
|
58
|
-
}
|
|
59
|
-
},
|
|
60
55
|
"files": [
|
|
61
56
|
"dist",
|
|
62
57
|
"src"
|
|
@@ -65,19 +60,19 @@
|
|
|
65
60
|
"@effect-atom/atom": "^0.5.1",
|
|
66
61
|
"@fluentui/react-tabster": "9.26.11",
|
|
67
62
|
"react-joyride": "^2.7.2",
|
|
68
|
-
"@dxos/app-framework": "0.8.4-main.
|
|
69
|
-
"@dxos/app-toolkit": "0.8.4-main.
|
|
70
|
-
"@dxos/app-graph": "0.8.4-main.
|
|
71
|
-
"@dxos/
|
|
72
|
-
"@dxos/
|
|
73
|
-
"@dxos/
|
|
74
|
-
"@dxos/
|
|
75
|
-
"@dxos/keyboard": "0.8.4-main.
|
|
76
|
-
"@dxos/plugin-client": "0.8.4-main.
|
|
77
|
-
"@dxos/
|
|
78
|
-
"@dxos/plugin-space": "0.8.4-main.
|
|
79
|
-
"@dxos/
|
|
80
|
-
"@dxos/
|
|
63
|
+
"@dxos/app-framework": "0.8.4-main.abd8ff62ef",
|
|
64
|
+
"@dxos/app-toolkit": "0.8.4-main.abd8ff62ef",
|
|
65
|
+
"@dxos/app-graph": "0.8.4-main.abd8ff62ef",
|
|
66
|
+
"@dxos/compute": "0.8.4-main.abd8ff62ef",
|
|
67
|
+
"@dxos/echo": "0.8.4-main.abd8ff62ef",
|
|
68
|
+
"@dxos/debug": "0.8.4-main.abd8ff62ef",
|
|
69
|
+
"@dxos/effect": "0.8.4-main.abd8ff62ef",
|
|
70
|
+
"@dxos/keyboard": "0.8.4-main.abd8ff62ef",
|
|
71
|
+
"@dxos/plugin-client": "0.8.4-main.abd8ff62ef",
|
|
72
|
+
"@dxos/util": "0.8.4-main.abd8ff62ef",
|
|
73
|
+
"@dxos/plugin-space": "0.8.4-main.abd8ff62ef",
|
|
74
|
+
"@dxos/plugin-graph": "0.8.4-main.abd8ff62ef",
|
|
75
|
+
"@dxos/react-client": "0.8.4-main.abd8ff62ef"
|
|
81
76
|
},
|
|
82
77
|
"devDependencies": {
|
|
83
78
|
"@effect-atom/atom-react": "^0.5.0",
|
|
@@ -89,12 +84,12 @@
|
|
|
89
84
|
"react-dom": "~19.2.3",
|
|
90
85
|
"react-floater": "0.7.9",
|
|
91
86
|
"type-fest": "4.10.1",
|
|
92
|
-
"vite": "^
|
|
93
|
-
"@dxos/plugin-testing": "0.8.4-main.
|
|
94
|
-
"@dxos/
|
|
95
|
-
"@dxos/
|
|
96
|
-
"@dxos/
|
|
97
|
-
"@dxos/
|
|
87
|
+
"vite": "^8.0.10",
|
|
88
|
+
"@dxos/plugin-testing": "0.8.4-main.abd8ff62ef",
|
|
89
|
+
"@dxos/random": "0.8.4-main.abd8ff62ef",
|
|
90
|
+
"@dxos/react-ui": "0.8.4-main.abd8ff62ef",
|
|
91
|
+
"@dxos/storybook-utils": "0.8.4-main.abd8ff62ef",
|
|
92
|
+
"@dxos/ui-theme": "0.8.4-main.abd8ff62ef"
|
|
98
93
|
},
|
|
99
94
|
"peerDependencies": {
|
|
100
95
|
"@effect-atom/atom-react": "^0.5.0",
|
|
@@ -102,8 +97,8 @@
|
|
|
102
97
|
"effect": "3.20.0",
|
|
103
98
|
"react": "~19.2.3",
|
|
104
99
|
"react-dom": "~19.2.3",
|
|
105
|
-
"@dxos/react-ui": "0.8.4-main.
|
|
106
|
-
"@dxos/ui-theme": "0.8.4-main.
|
|
100
|
+
"@dxos/react-ui": "0.8.4-main.abd8ff62ef",
|
|
101
|
+
"@dxos/ui-theme": "0.8.4-main.abd8ff62ef"
|
|
107
102
|
},
|
|
108
103
|
"publishConfig": {
|
|
109
104
|
"access": "public"
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { describe, test } from 'vitest';
|
|
6
|
+
|
|
7
|
+
import { ActivationEvents } from '@dxos/app-framework';
|
|
8
|
+
import { createComposerTestApp } from '@dxos/plugin-testing/harness';
|
|
9
|
+
|
|
10
|
+
import { HelpPlugin } from '#plugin';
|
|
11
|
+
|
|
12
|
+
import { meta } from './meta';
|
|
13
|
+
|
|
14
|
+
const moduleId = (name: string) => `${meta.id}.module.${name}`;
|
|
15
|
+
|
|
16
|
+
describe('HelpPlugin', () => {
|
|
17
|
+
test('modules activate on the expected events', async ({ expect }) => {
|
|
18
|
+
await using harness = await createComposerTestApp({
|
|
19
|
+
plugins: [HelpPlugin({})],
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
expect(harness.manager.getActive()).toEqual(
|
|
23
|
+
expect.arrayContaining([moduleId('AppGraphBuilder'), moduleId('ReactSurface')]),
|
|
24
|
+
);
|
|
25
|
+
|
|
26
|
+
// Operation handlers are not loaded on startup — SetupOperationHandler fires lazily when an operation is invoked.
|
|
27
|
+
await harness.fire(ActivationEvents.SetupOperationHandler);
|
|
28
|
+
expect(harness.manager.getActive()).toContain(moduleId('OperationHandler'));
|
|
29
|
+
});
|
|
30
|
+
});
|
package/src/HelpPlugin.tsx
CHANGED
|
@@ -7,10 +7,9 @@ import { AppPlugin } from '@dxos/app-toolkit';
|
|
|
7
7
|
|
|
8
8
|
import { AppGraphBuilder, HelpState, OperationHandler, ReactRoot, ReactSurface } from '#capabilities';
|
|
9
9
|
import { meta } from '#meta';
|
|
10
|
+
import { translations } from '#translations';
|
|
10
11
|
import { type Step } from '#types';
|
|
11
12
|
|
|
12
|
-
import { translations } from './translations';
|
|
13
|
-
|
|
14
13
|
export type HelpPluginOptions = { steps?: Step[] };
|
|
15
14
|
|
|
16
15
|
export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
|
|
@@ -29,3 +28,5 @@ export const HelpPlugin = Plugin.define<HelpPluginOptions>(meta).pipe(
|
|
|
29
28
|
})),
|
|
30
29
|
Plugin.make,
|
|
31
30
|
);
|
|
31
|
+
|
|
32
|
+
export default HelpPlugin;
|
|
@@ -7,7 +7,7 @@ import * as Effect from 'effect/Effect';
|
|
|
7
7
|
import { Capabilities, Capability } from '@dxos/app-framework';
|
|
8
8
|
import { GraphBuilder, Node, NodeMatcher } from '@dxos/app-graph';
|
|
9
9
|
import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
|
|
10
|
-
import { Operation } from '@dxos/
|
|
10
|
+
import { Operation } from '@dxos/compute';
|
|
11
11
|
|
|
12
12
|
import { meta } from '#meta';
|
|
13
13
|
import { HelpOperation } from '#operations';
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
import { Capability } from '@dxos/app-framework';
|
|
6
|
-
import { OperationHandlerSet } from '@dxos/
|
|
6
|
+
import { OperationHandlerSet } from '@dxos/compute';
|
|
7
7
|
|
|
8
8
|
export const AppGraphBuilder = Capability.lazy('AppGraphBuilder', () => import('./app-graph-builder'));
|
|
9
9
|
export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import * as Effect from 'effect/Effect';
|
|
6
6
|
|
|
7
7
|
import { Capabilities, Capability } from '@dxos/app-framework';
|
|
8
|
-
import type { OperationHandlerSet } from '@dxos/
|
|
8
|
+
import type { OperationHandlerSet } from '@dxos/compute';
|
|
9
9
|
|
|
10
10
|
import { HelpOperationHandlerSet } from '#operations';
|
|
11
11
|
|
|
@@ -28,8 +28,7 @@ export default Capability.makeModule(() =>
|
|
|
28
28
|
}),
|
|
29
29
|
Surface.create({
|
|
30
30
|
id: SHORTCUTS_DIALOG,
|
|
31
|
-
|
|
32
|
-
filter: AppSurface.componentDialog(SHORTCUTS_DIALOG),
|
|
31
|
+
filter: AppSurface.component(AppSurface.Dialog, SHORTCUTS_DIALOG),
|
|
33
32
|
component: () => <ShortcutsDialogContent />,
|
|
34
33
|
}),
|
|
35
34
|
]),
|
|
@@ -9,7 +9,8 @@ import { withPluginManager } from '@dxos/app-framework/testing';
|
|
|
9
9
|
import { Dialog } from '@dxos/react-ui';
|
|
10
10
|
import { withTheme } from '@dxos/react-ui/testing';
|
|
11
11
|
|
|
12
|
-
import { translations } from '
|
|
12
|
+
import { translations } from '#translations';
|
|
13
|
+
|
|
13
14
|
import { ShortcutsDialogContent } from './ShortcutsDialogContent';
|
|
14
15
|
|
|
15
16
|
const DefaultStory = () => (
|
package/src/index.ts
CHANGED
|
@@ -2,10 +2,14 @@
|
|
|
2
2
|
// Copyright 2023 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
+
import { Plugin } from '@dxos/app-framework';
|
|
6
|
+
|
|
7
|
+
import { meta } from './meta';
|
|
8
|
+
|
|
5
9
|
export { HelpCapabilities } from './types';
|
|
6
|
-
export * from './components';
|
|
7
10
|
export * from './constants';
|
|
8
11
|
export * from './meta';
|
|
9
|
-
export * from './HelpPlugin';
|
|
10
|
-
export * from './hooks';
|
|
11
12
|
export * from './types';
|
|
13
|
+
|
|
14
|
+
export const HelpPlugin = Plugin.lazy(meta, () => import('#plugin'));
|
|
15
|
+
export type { HelpPluginOptions } from '#plugin';
|
package/src/operations/index.ts
CHANGED
package/src/operations/start.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import * as Effect from 'effect/Effect';
|
|
6
6
|
|
|
7
7
|
import { Capabilities } from '@dxos/app-framework';
|
|
8
|
-
import { Operation } from '@dxos/
|
|
8
|
+
import { Operation } from '@dxos/compute';
|
|
9
9
|
|
|
10
10
|
import { HelpCapabilities } from '../types';
|
|
11
11
|
import { Start } from './definitions';
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/operations/definitions.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\n\nimport { Capability } from '@dxos/app-framework';\nimport { Operation } from '@dxos/operation';\n\nimport { meta } from '#meta';\n\nconst HELP_OPERATION = `${meta.id}.operation`;\n\nexport const Start = Operation.make({\n meta: { key: `${HELP_OPERATION}.start`, name: 'Start Help' },\n services: [Capability.Service],\n input: Schema.Void,\n output: Schema.Void,\n});\n"],
|
|
5
|
-
"mappings": ";;;;;AAAA;;;;AAIA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;AAC3B,SAASC,iBAAiB;AAE1B,SAASC,YAAY;AAErB,IAAMC,iBAAiB,GAAGC,KAAKC,EAAE;AAE1B,IAAMC,QAAQC,UAAUC,KAAK;EAClCJ,MAAM;IAAEK,KAAK,GAAGN,cAAAA;IAAwBO,MAAM;EAAa;EAC3DC,UAAU;IAACC,WAAWC;;EACtBC,OAAcC;EACdC,QAAeD;AACjB,CAAA;",
|
|
6
|
-
"names": ["Schema", "Capability", "Operation", "meta", "HELP_OPERATION", "meta", "id", "Start", "Operation", "make", "key", "name", "services", "Capability", "Service", "input", "Void", "output"]
|
|
7
|
-
}
|