@dxos/plugin-help 0.8.2-staging.7ac8446 → 0.8.3-main.672df60
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/{app-graph-builder-K5UJXROL.mjs → app-graph-builder-2TXP7S56.mjs} +12 -11
- package/dist/lib/browser/app-graph-builder-2TXP7S56.mjs.map +7 -0
- package/dist/lib/browser/{chunk-EMRPD2QX.mjs → chunk-ACLT6V7I.mjs} +2 -2
- package/dist/lib/browser/{chunk-EMRPD2QX.mjs.map → chunk-ACLT6V7I.mjs.map} +1 -1
- package/dist/lib/browser/{chunk-AIK64B2S.mjs → chunk-BZUIJQPN.mjs} +6 -6
- package/dist/lib/browser/chunk-BZUIJQPN.mjs.map +7 -0
- package/dist/lib/browser/chunk-JNDWLTUJ.mjs +408 -0
- package/dist/lib/browser/chunk-JNDWLTUJ.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +8 -8
- package/dist/lib/browser/index.mjs.map +3 -3
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/{react-root-L377AIYI.mjs → react-root-PRXEQ5QF.mjs} +4 -4
- package/dist/lib/browser/{react-surface-IKAPWUA2.mjs → react-surface-IDR3XY36.mjs} +3 -3
- package/dist/lib/browser/{state-K6TSL77G.mjs → state-UOKD6P5V.mjs} +2 -2
- package/dist/lib/browser/types.mjs +1 -1
- package/dist/types/src/HelpPlugin.d.ts.map +1 -1
- package/dist/types/src/capabilities/app-graph-builder.d.ts +2 -179
- package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
- package/dist/types/src/capabilities/index.d.ts +2 -178
- package/dist/types/src/capabilities/index.d.ts.map +1 -1
- package/dist/types/src/capabilities/react-root.d.ts.map +1 -1
- package/dist/types/src/capabilities/state.d.ts +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/WelcomeTour/WelcomeTour.d.ts.map +1 -1
- package/dist/types/src/types.d.ts +7 -7
- package/dist/types/src/types.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +26 -20
- package/src/HelpPlugin.tsx +1 -1
- package/src/capabilities/app-graph-builder.ts +59 -49
- package/src/components/Shortcuts/ShortcutsDialog.tsx +1 -1
- package/src/components/Shortcuts/ShortcutsList.tsx +1 -1
- package/src/components/Tooltip/Tooltip.tsx +2 -2
- package/src/types.ts +6 -6
- package/dist/lib/browser/app-graph-builder-K5UJXROL.mjs.map +0 -7
- package/dist/lib/browser/chunk-AIK64B2S.mjs.map +0 -7
- package/dist/lib/browser/chunk-J6SNIC5D.mjs +0 -361
- package/dist/lib/browser/chunk-J6SNIC5D.mjs.map +0 -7
- /package/dist/lib/browser/{react-root-L377AIYI.mjs.map → react-root-PRXEQ5QF.mjs.map} +0 -0
- /package/dist/lib/browser/{react-surface-IKAPWUA2.mjs.map → react-surface-IDR3XY36.mjs.map} +0 -0
- /package/dist/lib/browser/{state-K6TSL77G.mjs.map → state-UOKD6P5V.mjs.map} +0 -0
|
@@ -1,185 +1,9 @@
|
|
|
1
|
-
export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").
|
|
2
|
-
id: string;
|
|
3
|
-
position: import("@dxos/util").Position;
|
|
4
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
5
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
6
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
7
|
-
type?: string;
|
|
8
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
9
|
-
}> | Readonly<{
|
|
10
|
-
id: string;
|
|
11
|
-
position: import("@dxos/util").Position;
|
|
12
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
13
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
14
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
15
|
-
type?: string;
|
|
16
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
17
|
-
}>[] | (Readonly<{
|
|
18
|
-
id: string;
|
|
19
|
-
position: import("@dxos/util").Position;
|
|
20
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
21
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
22
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
23
|
-
type?: string;
|
|
24
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
25
|
-
}> | Readonly<{
|
|
26
|
-
id: string;
|
|
27
|
-
position: import("@dxos/util").Position;
|
|
28
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
29
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
30
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
31
|
-
type?: string;
|
|
32
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
33
|
-
}>[] | (Readonly<{
|
|
34
|
-
id: string;
|
|
35
|
-
position: import("@dxos/util").Position;
|
|
36
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
37
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
38
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
39
|
-
type?: string;
|
|
40
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
41
|
-
}> | Readonly<{
|
|
42
|
-
id: string;
|
|
43
|
-
position: import("@dxos/util").Position;
|
|
44
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
45
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
46
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
47
|
-
type?: string;
|
|
48
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
49
|
-
}>[] | (Readonly<{
|
|
50
|
-
id: string;
|
|
51
|
-
position: import("@dxos/util").Position;
|
|
52
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
53
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
54
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
55
|
-
type?: string;
|
|
56
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
57
|
-
}> | Readonly<{
|
|
58
|
-
id: string;
|
|
59
|
-
position: import("@dxos/util").Position;
|
|
60
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
61
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
62
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
63
|
-
type?: string;
|
|
64
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
65
|
-
}>[] | (Readonly<{
|
|
66
|
-
id: string;
|
|
67
|
-
position: import("@dxos/util").Position;
|
|
68
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
69
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
70
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
71
|
-
type?: string;
|
|
72
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
73
|
-
}> | Readonly<{
|
|
74
|
-
id: string;
|
|
75
|
-
position: import("@dxos/util").Position;
|
|
76
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
77
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
78
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
79
|
-
type?: string;
|
|
80
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
81
|
-
}>[] | (Readonly<{
|
|
82
|
-
id: string;
|
|
83
|
-
position: import("@dxos/util").Position;
|
|
84
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
85
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
86
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
87
|
-
type?: string;
|
|
88
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
89
|
-
}> | Readonly<{
|
|
90
|
-
id: string;
|
|
91
|
-
position: import("@dxos/util").Position;
|
|
92
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
93
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
94
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
95
|
-
type?: string;
|
|
96
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
97
|
-
}>[] | (Readonly<{
|
|
98
|
-
id: string;
|
|
99
|
-
position: import("@dxos/util").Position;
|
|
100
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
101
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
102
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
103
|
-
type?: string;
|
|
104
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
105
|
-
}> | Readonly<{
|
|
106
|
-
id: string;
|
|
107
|
-
position: import("@dxos/util").Position;
|
|
108
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
109
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
110
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
111
|
-
type?: string;
|
|
112
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
113
|
-
}>[] | (Readonly<{
|
|
114
|
-
id: string;
|
|
115
|
-
position: import("@dxos/util").Position;
|
|
116
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
117
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
118
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
119
|
-
type?: string;
|
|
120
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
121
|
-
}> | Readonly<{
|
|
122
|
-
id: string;
|
|
123
|
-
position: import("@dxos/util").Position;
|
|
124
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
125
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
126
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
127
|
-
type?: string;
|
|
128
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
129
|
-
}>[] | (Readonly<{
|
|
130
|
-
id: string;
|
|
131
|
-
position: import("@dxos/util").Position;
|
|
132
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
133
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
134
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
135
|
-
type?: string;
|
|
136
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
137
|
-
}> | Readonly<{
|
|
138
|
-
id: string;
|
|
139
|
-
position: import("@dxos/util").Position;
|
|
140
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
141
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
142
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
143
|
-
type?: string;
|
|
144
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
145
|
-
}>[] | (Readonly<{
|
|
146
|
-
id: string;
|
|
147
|
-
position: import("@dxos/util").Position;
|
|
148
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
149
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
150
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
151
|
-
type?: string;
|
|
152
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
153
|
-
}> | Readonly<{
|
|
154
|
-
id: string;
|
|
155
|
-
position: import("@dxos/util").Position;
|
|
156
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
157
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
158
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
159
|
-
type?: string;
|
|
160
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
161
|
-
}>[] | (any[] | Readonly<{
|
|
162
|
-
id: string;
|
|
163
|
-
position: import("@dxos/util").Position;
|
|
164
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
165
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
166
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
167
|
-
type?: string;
|
|
168
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
169
|
-
}> | Readonly<{
|
|
170
|
-
id: string;
|
|
171
|
-
position: import("@dxos/util").Position;
|
|
172
|
-
resolver?: import("@dxos/app-graph").ResolverExtension;
|
|
173
|
-
connector?: import("@dxos/app-graph").ConnectorExtension;
|
|
174
|
-
relation?: import("@dxos/app-graph").Relation;
|
|
175
|
-
type?: string;
|
|
176
|
-
filter?: (node: import("@dxos/app-graph").Node) => boolean;
|
|
177
|
-
}>[])[])[])[])[])[])[])[])[])[])[]> | import("@dxos/app-framework").AnyCapability[]>>;
|
|
1
|
+
export declare const AppGraphBuilder: (props?: import("@dxos/app-framework").PluginContext | undefined) => Promise<() => Promise<import("@dxos/app-framework").Capability<import("@dxos/app-graph").BuilderExtensions> | import("@dxos/app-framework").AnyCapability[]>>;
|
|
178
2
|
export declare const ReactRoot: (props?: import("..").Step[] | undefined) => Promise<() => Promise<import("@dxos/app-framework").Capability<Readonly<{
|
|
179
3
|
id: string;
|
|
180
4
|
root: import("react").FC<import("react").PropsWithChildren>;
|
|
181
5
|
}>> | import("@dxos/app-framework").AnyCapability[]>>;
|
|
182
6
|
export declare const ReactSurface: (props?: unknown) => Promise<() => Promise<import("@dxos/app-framework").Capability<import("@dxos/app-framework").Capabilities.ReactSurface> | import("@dxos/app-framework").AnyCapability[]>>;
|
|
183
|
-
export declare const HelpState: (props?: unknown) => Promise<() => Promise<import("@dxos/app-framework").Capability<import("@dxos/live-object").
|
|
7
|
+
export declare const HelpState: (props?: unknown) => Promise<() => Promise<import("@dxos/app-framework").Capability<import("@dxos/live-object").Live<import("./capabilities").HelpCapabilities.State>> | import("@dxos/app-framework").AnyCapability[]>>;
|
|
184
8
|
export * from './capabilities';
|
|
185
9
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/index.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,eAAe
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/index.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,eAAe,oOAA4C,CAAC;AACzE,eAAO,MAAM,SAAS;;;qDAAqC,CAAC;AAC5D,eAAO,MAAM,YAAY,gMAAwC,CAAC;AAClE,eAAO,MAAM,SAAS,0NAAgC,CAAC;AAEvD,cAAc,gBAAgB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"react-root.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/react-root.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"react-root.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/react-root.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,UAAU,CAAC;yBAErB,OAAO,IAAI,EAAE;;;;AAA7B,wBAkBK"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { HelpCapabilities } from './capabilities';
|
|
2
|
-
declare const _default: () => import("@dxos/app-framework").Capability<import("@dxos/live-object").
|
|
2
|
+
declare const _default: () => import("@dxos/app-framework").Capability<import("@dxos/live-object").Live<HelpCapabilities.State>>;
|
|
3
3
|
export default _default;
|
|
4
4
|
//# sourceMappingURL=state.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/Key.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,eAAO,MAAM,GAAG,
|
|
1
|
+
{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/Key.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,eAAO,MAAM,GAAG,GAAI,aAAa;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,sBAUnD,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ShortcutsHints.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsHints.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAiB1B,eAAO,MAAM,cAAc,
|
|
1
|
+
{"version":3,"file":"ShortcutsHints.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsHints.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAiB1B,eAAO,MAAM,cAAc,GAAI,aAAa;IAAE,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,sBAkBnE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WelcomeTour.d.ts","sourceRoot":"","sources":["../../../../../src/components/WelcomeTour/WelcomeTour.tsx"],"names":[],"mappings":"AAIA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAKnD,OAAO,EAAE,KAAK,IAAI,EAAe,MAAM,aAAa,CAAC;AAkDrD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC;CAC5C,CAAC;AAEF,eAAO,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"WelcomeTour.d.ts","sourceRoot":"","sources":["../../../../../src/components/WelcomeTour/WelcomeTour.tsx"],"names":[],"mappings":"AAIA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAKnD,OAAO,EAAE,KAAK,IAAI,EAAe,MAAM,aAAa,CAAC;AAkDrD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC;CAC5C,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,iEAAiE,gBAAgB,sBAwG5G,CAAC"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
+
import { Schema } from 'effect';
|
|
1
2
|
import { type Context } from 'react';
|
|
2
3
|
import { type Step as BaseStep } from 'react-joyride';
|
|
3
|
-
import { type
|
|
4
|
-
import { S } from '@dxos/echo-schema';
|
|
4
|
+
import { type PluginContext } from '@dxos/app-framework';
|
|
5
5
|
export type Step = BaseStep & {
|
|
6
|
-
before?: (context:
|
|
6
|
+
before?: (context: PluginContext) => void;
|
|
7
7
|
};
|
|
8
8
|
export type HelpContextType = {
|
|
9
9
|
running: boolean;
|
|
@@ -16,11 +16,11 @@ export type HelpContextType = {
|
|
|
16
16
|
export declare const HelpContext: Context<HelpContextType>;
|
|
17
17
|
export declare const HELP_ACTION = "dxos.org/plugin/help/action";
|
|
18
18
|
export declare namespace HelpAction {
|
|
19
|
-
const Start_base:
|
|
20
|
-
readonly _tag:
|
|
19
|
+
const Start_base: Schema.TaggedClass<Start, "dxos.org/plugin/help/action/start", {
|
|
20
|
+
readonly _tag: Schema.tag<"dxos.org/plugin/help/action/start">;
|
|
21
21
|
} & {
|
|
22
|
-
input: typeof
|
|
23
|
-
output: typeof
|
|
22
|
+
input: typeof Schema.Void;
|
|
23
|
+
output: typeof Schema.Void;
|
|
24
24
|
}>;
|
|
25
25
|
export class Start extends Start_base {
|
|
26
26
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,KAAK,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,KAAK,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIzD,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG;IAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,IAAI,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,eAAe,CAO/C,CAAC;AAEH,eAAO,MAAM,WAAW,gCAA0B,CAAC;AACnD,yBAAiB,UAAU,CAAC;;;;;;;IAC1B,MAAM,OAAO,KAAM,SAAQ,UAGzB;KAAG;;CACN"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"5.
|
|
1
|
+
{"version":"5.8.3"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/plugin-help",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.3-main.672df60",
|
|
4
4
|
"description": "Help plugin.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -32,41 +32,47 @@
|
|
|
32
32
|
],
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@fluentui/react-tabster": "^9.24.2",
|
|
35
|
-
"
|
|
35
|
+
"@preact-signals/safe-react": "^0.9.0",
|
|
36
36
|
"react-joyride": "^2.7.2",
|
|
37
|
-
"@dxos/app-framework": "0.8.
|
|
38
|
-
"@dxos/
|
|
39
|
-
"@dxos/
|
|
40
|
-
"@dxos/
|
|
41
|
-
"@dxos/
|
|
42
|
-
"@dxos/
|
|
43
|
-
"@dxos/
|
|
44
|
-
"@dxos/
|
|
45
|
-
"@dxos/
|
|
46
|
-
"@dxos/plugin-
|
|
47
|
-
"@dxos/
|
|
37
|
+
"@dxos/app-framework": "0.8.3-main.672df60",
|
|
38
|
+
"@dxos/debug": "0.8.3-main.672df60",
|
|
39
|
+
"@dxos/echo": "0.8.3-main.672df60",
|
|
40
|
+
"@dxos/app-graph": "0.8.3-main.672df60",
|
|
41
|
+
"@dxos/live-object": "0.8.3-main.672df60",
|
|
42
|
+
"@dxos/keyboard": "0.8.3-main.672df60",
|
|
43
|
+
"@dxos/echo-schema": "0.8.3-main.672df60",
|
|
44
|
+
"@dxos/plugin-client": "0.8.3-main.672df60",
|
|
45
|
+
"@dxos/local-storage": "0.8.3-main.672df60",
|
|
46
|
+
"@dxos/plugin-graph": "0.8.3-main.672df60",
|
|
47
|
+
"@dxos/plugin-space": "0.8.3-main.672df60",
|
|
48
|
+
"@dxos/react-client": "0.8.3-main.672df60"
|
|
48
49
|
},
|
|
49
50
|
"devDependencies": {
|
|
51
|
+
"@effect-rx/rx-react": "^0.34.1",
|
|
52
|
+
"@effect/platform": "0.80.12",
|
|
50
53
|
"@phosphor-icons/react": "^2.1.5",
|
|
51
|
-
"@types/lodash.get": "^4.4.7",
|
|
52
54
|
"@types/react": "~18.2.0",
|
|
53
55
|
"@types/react-dom": "~18.2.0",
|
|
56
|
+
"effect": "3.14.21",
|
|
54
57
|
"react": "~18.2.0",
|
|
55
58
|
"react-dom": "~18.2.0",
|
|
56
59
|
"react-floater": "0.7.9",
|
|
57
60
|
"type-fest": "4.10.1",
|
|
58
61
|
"vite": "5.4.7",
|
|
59
|
-
"@dxos/random": "0.8.
|
|
60
|
-
"@dxos/react-ui": "0.8.
|
|
61
|
-
"@dxos/react-ui-theme": "0.8.
|
|
62
|
-
"@dxos/storybook-utils": "0.8.
|
|
62
|
+
"@dxos/random": "0.8.3-main.672df60",
|
|
63
|
+
"@dxos/react-ui": "0.8.3-main.672df60",
|
|
64
|
+
"@dxos/react-ui-theme": "0.8.3-main.672df60",
|
|
65
|
+
"@dxos/storybook-utils": "0.8.3-main.672df60"
|
|
63
66
|
},
|
|
64
67
|
"peerDependencies": {
|
|
68
|
+
"@effect-rx/rx-react": "^0.34.1",
|
|
69
|
+
"@effect/platform": "0.80.12",
|
|
65
70
|
"@phosphor-icons/react": "^2.1.5",
|
|
71
|
+
"effect": "^3.13.3",
|
|
66
72
|
"react": "~18.2.0",
|
|
67
73
|
"react-dom": "~18.2.0",
|
|
68
|
-
"@dxos/react-ui": "0.8.
|
|
69
|
-
"@dxos/react-ui-theme": "0.8.
|
|
74
|
+
"@dxos/react-ui": "0.8.3-main.672df60",
|
|
75
|
+
"@dxos/react-ui-theme": "0.8.3-main.672df60"
|
|
70
76
|
},
|
|
71
77
|
"publishConfig": {
|
|
72
78
|
"access": "public"
|
package/src/HelpPlugin.tsx
CHANGED
|
@@ -43,7 +43,7 @@ export const HelpPlugin = ({ steps = [] }: HelpPluginOptions) =>
|
|
|
43
43
|
createResolver({
|
|
44
44
|
intent: HelpAction.Start,
|
|
45
45
|
resolve: () => {
|
|
46
|
-
const state = context.
|
|
46
|
+
const state = context.getCapability(HelpCapabilities.MutableState);
|
|
47
47
|
state.running = true;
|
|
48
48
|
},
|
|
49
49
|
}),
|
|
@@ -2,65 +2,75 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
5
|
+
import { Rx } from '@effect-rx/rx-react';
|
|
6
|
+
import { Option, pipe } from 'effect';
|
|
7
|
+
|
|
8
|
+
import { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';
|
|
9
|
+
import { createExtension } from '@dxos/app-graph';
|
|
7
10
|
|
|
8
11
|
import { HelpCapabilities } from './capabilities';
|
|
9
12
|
import { SHORTCUTS_DIALOG } from '../components';
|
|
10
13
|
import { HELP_PLUGIN } from '../meta';
|
|
11
14
|
import { HelpAction } from '../types';
|
|
12
15
|
|
|
13
|
-
export default (context:
|
|
16
|
+
export default (context: PluginContext) =>
|
|
14
17
|
contributes(
|
|
15
18
|
Capabilities.AppGraphBuilder,
|
|
16
19
|
createExtension({
|
|
17
20
|
id: HELP_PLUGIN,
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
21
|
+
actions: (node) =>
|
|
22
|
+
Rx.make((get) =>
|
|
23
|
+
pipe(
|
|
24
|
+
get(node),
|
|
25
|
+
Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : Option.none())),
|
|
26
|
+
Option.map(() => [
|
|
27
|
+
{
|
|
28
|
+
id: HelpAction.Start._tag,
|
|
29
|
+
data: async () => {
|
|
30
|
+
const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
|
|
31
|
+
const state = context.getCapability(HelpCapabilities.MutableState);
|
|
32
|
+
state.showHints = true;
|
|
33
|
+
await dispatch(createIntent(HelpAction.Start));
|
|
34
|
+
},
|
|
35
|
+
properties: {
|
|
36
|
+
label: ['open help tour', { ns: HELP_PLUGIN }],
|
|
37
|
+
icon: 'ph--info--regular',
|
|
38
|
+
keyBinding: {
|
|
39
|
+
macos: 'shift+meta+/',
|
|
40
|
+
// TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
|
|
41
|
+
windows: 'shift+ctrl+/',
|
|
42
|
+
linux: 'shift+ctrl+?',
|
|
43
|
+
},
|
|
44
|
+
testId: 'helpPlugin.openHelp',
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
id: 'dxos.org/plugin/help/open-shortcuts',
|
|
49
|
+
data: async () => {
|
|
50
|
+
const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
|
|
51
|
+
const state = context.getCapability(HelpCapabilities.MutableState);
|
|
52
|
+
state.showHints = true;
|
|
53
|
+
await dispatch(
|
|
54
|
+
createIntent(LayoutAction.UpdateDialog, {
|
|
55
|
+
part: 'dialog',
|
|
56
|
+
subject: SHORTCUTS_DIALOG,
|
|
57
|
+
options: {
|
|
58
|
+
blockAlign: 'center',
|
|
59
|
+
},
|
|
60
|
+
}),
|
|
61
|
+
);
|
|
62
|
+
},
|
|
63
|
+
properties: {
|
|
64
|
+
label: ['open shortcuts label', { ns: HELP_PLUGIN }],
|
|
65
|
+
icon: 'ph--keyboard--regular',
|
|
66
|
+
keyBinding: {
|
|
67
|
+
macos: 'meta+ctrl+/',
|
|
68
|
+
},
|
|
52
69
|
},
|
|
53
|
-
}
|
|
54
|
-
)
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
icon: 'ph--keyboard--regular',
|
|
59
|
-
keyBinding: {
|
|
60
|
-
macos: 'meta+ctrl+/',
|
|
61
|
-
},
|
|
62
|
-
},
|
|
63
|
-
},
|
|
64
|
-
],
|
|
70
|
+
},
|
|
71
|
+
]),
|
|
72
|
+
Option.getOrElse(() => []),
|
|
73
|
+
),
|
|
74
|
+
),
|
|
65
75
|
}),
|
|
66
76
|
);
|
|
@@ -21,7 +21,7 @@ export const ShortcutsList = () => {
|
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
return (
|
|
24
|
-
<dl className={mx('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued')}>
|
|
24
|
+
<dl className={mx('is-fit grid grid-cols-[min-content_minmax(12rem,1fr)] gap-2 mlb-4 text-subdued select-none')}>
|
|
25
25
|
{bindings.map((binding, i) => (
|
|
26
26
|
<Fragment key={i}>
|
|
27
27
|
<Key binding={binding.shortcut} />
|
|
@@ -40,7 +40,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
|
|
|
40
40
|
|
|
41
41
|
return (
|
|
42
42
|
<div
|
|
43
|
-
className='flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-
|
|
43
|
+
className='flex flex-col is-[15rem] min-bs-[10rem] overflow-hidden rounded-md shadow-xl bg-accentSurface text-accentSurfaceText'
|
|
44
44
|
role='tooltip'
|
|
45
45
|
data-testid='helpPlugin.tooltip'
|
|
46
46
|
data-step={index + 1}
|
|
@@ -48,7 +48,7 @@ export const Tooltip = forwardRef<HTMLDivElement, TooltipRenderProps>(
|
|
|
48
48
|
ref={forwardedRef}
|
|
49
49
|
>
|
|
50
50
|
<div className='flex p-2'>
|
|
51
|
-
<h2 className='grow pli-2 plb-1 text-lg font-medium text-
|
|
51
|
+
<h2 className='grow pli-2 plb-1 text-lg font-medium text-accentSurfaceText'>{title}</h2>
|
|
52
52
|
<Button
|
|
53
53
|
density='fine'
|
|
54
54
|
variant='primary'
|
package/src/types.ts
CHANGED
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
// Copyright 2023 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
+
import { Schema } from 'effect';
|
|
5
6
|
import { type Context, createContext } from 'react';
|
|
6
7
|
import { type Step as BaseStep } from 'react-joyride';
|
|
7
8
|
|
|
8
|
-
import { type
|
|
9
|
-
import { S } from '@dxos/echo-schema';
|
|
9
|
+
import { type PluginContext } from '@dxos/app-framework';
|
|
10
10
|
|
|
11
11
|
import { HELP_PLUGIN } from './meta';
|
|
12
12
|
|
|
13
13
|
export type Step = BaseStep & {
|
|
14
|
-
before?: (context:
|
|
14
|
+
before?: (context: PluginContext) => void;
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
export type HelpContextType = {
|
|
@@ -34,8 +34,8 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
|
|
|
34
34
|
|
|
35
35
|
export const HELP_ACTION = `${HELP_PLUGIN}/action`;
|
|
36
36
|
export namespace HelpAction {
|
|
37
|
-
export class Start extends
|
|
38
|
-
input:
|
|
39
|
-
output:
|
|
37
|
+
export class Start extends Schema.TaggedClass<Start>()(`${HELP_ACTION}/start`, {
|
|
38
|
+
input: Schema.Void,
|
|
39
|
+
output: Schema.Void,
|
|
40
40
|
}) {}
|
|
41
41
|
}
|
|
@@ -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 { Capabilities, contributes, createIntent, LayoutAction, type PluginsContext } from '@dxos/app-framework';\nimport { createExtension, type Node } 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: PluginsContext) =>\n contributes(\n Capabilities.AppGraphBuilder,\n createExtension({\n id: HELP_PLUGIN,\n filter: (node): node is Node<null> => node.id === 'root',\n actions: () => [\n {\n id: HelpAction.Start._tag,\n data: async () => {\n const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);\n const state = context.requestCapability(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.requestCapability(Capabilities.IntentDispatcher);\n const state = context.requestCapability(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 }),\n );\n"],
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;AAIA,SAASA,cAAcC,aAAaC,cAAcC,oBAAyC;AAC3F,SAASC,uBAAkC;AAO3C,IAAA,4BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC;EACJC,QAAQ,CAACC,SAA6BA,KAAKH,OAAO;EAClDI,SAAS,MAAM;IACb;MACEJ,IAAIK,WAAWC,MAAMC;MACrBC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKf,QAAQgB,kBAAkBd,aAAae,gBAAgB;AAC7F,cAAMC,QAAQlB,QAAQgB,kBAAkBG,iBAAiBC,YAAY;AACrEF,cAAMG,YAAY;AAClB,cAAMN,SAASO,aAAaZ,WAAWC,KAAK,CAAA;MAC9C;MACAY,YAAY;QACVC,OAAO;UAAC;UAAkB;YAAEC,IAAInB;UAAY;;QAC5CoB,MAAM;QACNC,YAAY;UACVC,OAAO;;UAEPC,SAAS;UACTC,OAAO;QACT;QACAC,QAAQ;MACV;IACF;IACA;MACE1B,IAAI;MACJQ,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKf,QAAQgB,kBAAkBd,aAAae,gBAAgB;AAC7F,cAAMC,QAAQlB,QAAQgB,kBAAkBG,iBAAiBC,YAAY;AACrEF,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,IAAInB;UAAY;;QAClDoB,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;MACF;IACF;;AAEJ,CAAA,CAAA;",
|
|
6
|
-
"names": ["Capabilities", "contributes", "createIntent", "LayoutAction", "createExtension", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "HELP_PLUGIN", "filter", "node", "actions", "HelpAction", "Start", "_tag", "data", "dispatchPromise", "dispatch", "requestCapability", "IntentDispatcher", "state", "HelpCapabilities", "MutableState", "showHints", "createIntent", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "UpdateDialog", "part", "subject", "SHORTCUTS_DIALOG", "options", "blockAlign"]
|
|
7
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/types.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { type PluginsContext } from '@dxos/app-framework';\nimport { S } from '@dxos/echo-schema';\n\nimport { HELP_PLUGIN } from './meta';\n\nexport type Step = BaseStep & {\n before?: (context: PluginsContext) => 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 S.TaggedClass<Start>()(`${HELP_ACTION}/start`, {\n input: S.Void,\n output: S.Void,\n }) {}\n}\n"],
|
|
5
|
-
"mappings": ";;;;;AAIA,SAAuBA,qBAAqB;AAI5C,SAASC,SAAS;AAiBX,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,EAAEC,YAAW,EAAU,GAAGL,WAAAA,UAAqB;IACxEM,OAAOF,EAAEG;IACTC,QAAQJ,EAAEG;EACZ,CAAA,EAAA;EAAI;cAHSJ,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;",
|
|
6
|
-
"names": ["createContext", "S", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_ACTION", "HELP_PLUGIN", "HelpAction", "Start", "S", "TaggedClass", "input", "Void", "output"]
|
|
7
|
-
}
|