@dxos/app-framework 0.8.4-main.b97322e → 0.8.4-main.c4373fc

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 (211) hide show
  1. package/.storybook/main.mts +11 -0
  2. package/.storybook/preview.mts +8 -0
  3. package/.swc/plugins/linux_x86_64_19.0.0/727453fb3a62f7f1d952a41e051ca8a6f88cadc45cee43c6a4d1aa45f9b75665.wasmer-v7 +0 -0
  4. package/.swc/plugins/{v7_linux_x86_64_13.0.0/fce1bdb8e20a094e4af08bad09cc81497ed0e2e7c51223b07d371063cca18429 → linux_x86_64_19.0.0/fce1bdb8e20a094e4af08bad09cc81497ed0e2e7c51223b07d371063cca18429.wasmer-v7} +0 -0
  5. package/dist/lib/browser/{app-graph-builder-LYF7EKNN.mjs → app-graph-builder-77MY7KAY.mjs} +31 -30
  6. package/dist/lib/browser/app-graph-builder-77MY7KAY.mjs.map +7 -0
  7. package/dist/lib/browser/{chunk-FO2PH7M3.mjs → chunk-4NFLRSTX.mjs} +189 -137
  8. package/dist/lib/browser/chunk-4NFLRSTX.mjs.map +7 -0
  9. package/dist/lib/browser/{chunk-FMN65HSW.mjs → chunk-OKF2PAWO.mjs} +408 -281
  10. package/dist/lib/browser/chunk-OKF2PAWO.mjs.map +7 -0
  11. package/dist/lib/browser/{chunk-ORWHM7CO.mjs → chunk-SCPE4ZO2.mjs} +11 -8
  12. package/dist/lib/browser/chunk-SCPE4ZO2.mjs.map +7 -0
  13. package/dist/lib/browser/index.mjs +20 -28
  14. package/dist/lib/browser/index.mjs.map +3 -3
  15. package/dist/lib/browser/{intent-dispatcher-LSYQZSEB.mjs → intent-dispatcher-Y4LZNOBC.mjs} +2 -2
  16. package/dist/lib/browser/{intent-resolver-ZTNOSO3A.mjs → intent-resolver-XO5OYWVD.mjs} +7 -7
  17. package/dist/lib/browser/intent-resolver-XO5OYWVD.mjs.map +7 -0
  18. package/dist/lib/browser/meta.json +1 -1
  19. package/dist/lib/browser/{store-KML2R4IE.mjs → store-E3YSBPJQ.mjs} +4 -4
  20. package/dist/lib/browser/{store-KML2R4IE.mjs.map → store-E3YSBPJQ.mjs.map} +2 -2
  21. package/dist/lib/browser/testing/index.mjs +14 -19
  22. package/dist/lib/browser/testing/index.mjs.map +3 -3
  23. package/dist/lib/browser/worker.mjs +7 -9
  24. package/dist/lib/node-esm/{app-graph-builder-SAOWGJDK.mjs → app-graph-builder-WK7WBM6I.mjs} +31 -30
  25. package/dist/lib/node-esm/app-graph-builder-WK7WBM6I.mjs.map +7 -0
  26. package/dist/lib/node-esm/{chunk-ZEZ4FVEU.mjs → chunk-7DNZQ6H2.mjs} +408 -281
  27. package/dist/lib/node-esm/chunk-7DNZQ6H2.mjs.map +7 -0
  28. package/dist/lib/node-esm/{chunk-73HGSHKE.mjs → chunk-AHCD4UYO.mjs} +189 -137
  29. package/dist/lib/node-esm/chunk-AHCD4UYO.mjs.map +7 -0
  30. package/dist/lib/node-esm/{chunk-UMZQERLE.mjs → chunk-ZX63QUGE.mjs} +11 -8
  31. package/dist/lib/node-esm/chunk-ZX63QUGE.mjs.map +7 -0
  32. package/dist/lib/node-esm/index.mjs +20 -28
  33. package/dist/lib/node-esm/index.mjs.map +3 -3
  34. package/dist/lib/node-esm/{intent-dispatcher-6CYNGPSW.mjs → intent-dispatcher-R4CCPBHO.mjs} +2 -2
  35. package/dist/lib/node-esm/{intent-resolver-W7Z7WFFM.mjs → intent-resolver-NVYY6BQA.mjs} +7 -7
  36. package/dist/lib/node-esm/intent-resolver-NVYY6BQA.mjs.map +7 -0
  37. package/dist/lib/node-esm/meta.json +1 -1
  38. package/dist/lib/node-esm/{store-QEXGXLWZ.mjs → store-QA5DGTOS.mjs} +4 -4
  39. package/dist/lib/node-esm/{store-QEXGXLWZ.mjs.map → store-QA5DGTOS.mjs.map} +2 -2
  40. package/dist/lib/node-esm/testing/index.mjs +14 -19
  41. package/dist/lib/node-esm/testing/index.mjs.map +3 -3
  42. package/dist/lib/node-esm/worker.mjs +7 -9
  43. package/dist/types/src/common/capabilities.d.ts +85 -8
  44. package/dist/types/src/common/capabilities.d.ts.map +1 -1
  45. package/dist/types/src/common/collaboration.d.ts +10 -9
  46. package/dist/types/src/common/collaboration.d.ts.map +1 -1
  47. package/dist/types/src/common/events.d.ts.map +1 -1
  48. package/dist/types/src/common/file.d.ts +1 -1
  49. package/dist/types/src/common/file.d.ts.map +1 -1
  50. package/dist/types/src/common/index.d.ts +1 -1
  51. package/dist/types/src/common/index.d.ts.map +1 -1
  52. package/dist/types/src/common/layout.d.ts +1 -3
  53. package/dist/types/src/common/layout.d.ts.map +1 -1
  54. package/dist/types/src/common/surface.d.ts +7 -13
  55. package/dist/types/src/common/surface.d.ts.map +1 -1
  56. package/dist/types/src/common/translations.d.ts +1 -1
  57. package/dist/types/src/common/translations.d.ts.map +1 -1
  58. package/dist/types/src/components/App.d.ts +10 -0
  59. package/dist/types/src/components/App.d.ts.map +1 -0
  60. package/dist/types/src/components/App.stories.d.ts +14 -0
  61. package/dist/types/src/components/App.stories.d.ts.map +1 -0
  62. package/dist/types/src/components/DefaultFallback.d.ts +8 -0
  63. package/dist/types/src/components/DefaultFallback.d.ts.map +1 -0
  64. package/dist/types/src/components/index.d.ts +2 -0
  65. package/dist/types/src/components/index.d.ts.map +1 -0
  66. package/dist/types/src/{App.d.ts → components/useApp.d.ts} +7 -6
  67. package/dist/types/src/components/useApp.d.ts.map +1 -0
  68. package/dist/types/src/components/useLoading.d.ts +19 -0
  69. package/dist/types/src/components/useLoading.d.ts.map +1 -0
  70. package/dist/types/src/core/capabilities.d.ts +5 -2
  71. package/dist/types/src/core/capabilities.d.ts.map +1 -1
  72. package/dist/types/src/core/manager.d.ts +6 -2
  73. package/dist/types/src/core/manager.d.ts.map +1 -1
  74. package/dist/types/src/core/plugin.d.ts +4 -1
  75. package/dist/types/src/core/plugin.d.ts.map +1 -1
  76. package/dist/types/src/index.d.ts +1 -1
  77. package/dist/types/src/index.d.ts.map +1 -1
  78. package/dist/types/src/playground/debug/Debug.d.ts +1 -1
  79. package/dist/types/src/playground/debug/plugin.d.ts +1 -1
  80. package/dist/types/src/playground/debug/plugin.d.ts.map +1 -1
  81. package/dist/types/src/playground/generator/Main.d.ts +1 -1
  82. package/dist/types/src/playground/generator/Toolbar.d.ts +1 -1
  83. package/dist/types/src/playground/generator/Toolbar.d.ts.map +1 -1
  84. package/dist/types/src/playground/generator/generator.d.ts +1 -1
  85. package/dist/types/src/playground/generator/generator.d.ts.map +1 -1
  86. package/dist/types/src/playground/generator/plugin.d.ts +1 -1
  87. package/dist/types/src/playground/generator/plugin.d.ts.map +1 -1
  88. package/dist/types/src/playground/layout/Layout.d.ts +2 -2
  89. package/dist/types/src/playground/layout/plugin.d.ts +1 -1
  90. package/dist/types/src/playground/layout/plugin.d.ts.map +1 -1
  91. package/dist/types/src/playground/logger/Toolbar.d.ts +1 -1
  92. package/dist/types/src/playground/logger/Toolbar.d.ts.map +1 -1
  93. package/dist/types/src/playground/logger/plugin.d.ts +1 -1
  94. package/dist/types/src/playground/logger/plugin.d.ts.map +1 -1
  95. package/dist/types/src/playground/logger/schema.d.ts +1 -1
  96. package/dist/types/src/playground/logger/schema.d.ts.map +1 -1
  97. package/dist/types/src/playground/playground.stories.d.ts +5 -4
  98. package/dist/types/src/playground/playground.stories.d.ts.map +1 -1
  99. package/dist/types/src/plugin-intent/IntentPlugin.d.ts +1 -1
  100. package/dist/types/src/plugin-intent/IntentPlugin.d.ts.map +1 -1
  101. package/dist/types/src/plugin-intent/actions.d.ts +5 -7
  102. package/dist/types/src/plugin-intent/actions.d.ts.map +1 -1
  103. package/dist/types/src/plugin-intent/errors.d.ts.map +1 -1
  104. package/dist/types/src/plugin-intent/index.d.ts +1 -0
  105. package/dist/types/src/plugin-intent/index.d.ts.map +1 -1
  106. package/dist/types/src/plugin-intent/intent-dispatcher.d.ts +7 -7
  107. package/dist/types/src/plugin-intent/intent-dispatcher.d.ts.map +1 -1
  108. package/dist/types/src/plugin-intent/intent.d.ts +1 -1
  109. package/dist/types/src/plugin-intent/intent.d.ts.map +1 -1
  110. package/dist/types/src/plugin-intent/meta.d.ts +3 -0
  111. package/dist/types/src/plugin-intent/meta.d.ts.map +1 -0
  112. package/dist/types/src/plugin-settings/SettingsPlugin.d.ts +1 -1
  113. package/dist/types/src/plugin-settings/SettingsPlugin.d.ts.map +1 -1
  114. package/dist/types/src/plugin-settings/actions.d.ts +5 -7
  115. package/dist/types/src/plugin-settings/actions.d.ts.map +1 -1
  116. package/dist/types/src/plugin-settings/app-graph-builder.d.ts +1 -1
  117. package/dist/types/src/plugin-settings/app-graph-builder.d.ts.map +1 -1
  118. package/dist/types/src/plugin-settings/intent-resolver.d.ts +1 -1
  119. package/dist/types/src/plugin-settings/intent-resolver.d.ts.map +1 -1
  120. package/dist/types/src/plugin-settings/meta.d.ts +3 -0
  121. package/dist/types/src/plugin-settings/meta.d.ts.map +1 -0
  122. package/dist/types/src/plugin-settings/store.d.ts +1 -1
  123. package/dist/types/src/plugin-settings/store.d.ts.map +1 -1
  124. package/dist/types/src/plugin-settings/translations.d.ts +2 -1
  125. package/dist/types/src/plugin-settings/translations.d.ts.map +1 -1
  126. package/dist/types/src/react/ErrorBoundary.d.ts +13 -14
  127. package/dist/types/src/react/ErrorBoundary.d.ts.map +1 -1
  128. package/dist/types/src/react/IntentContext.d.ts.map +1 -1
  129. package/dist/types/src/react/Surface.d.ts +2 -2
  130. package/dist/types/src/react/Surface.d.ts.map +1 -1
  131. package/dist/types/src/react/Surface.stories.d.ts +6 -5
  132. package/dist/types/src/react/Surface.stories.d.ts.map +1 -1
  133. package/dist/types/src/react/common.d.ts.map +1 -1
  134. package/dist/types/src/react/useCapabilities.d.ts.map +1 -1
  135. package/dist/types/src/testing/withPluginManager.d.ts +6 -6
  136. package/dist/types/src/testing/withPluginManager.d.ts.map +1 -1
  137. package/dist/types/src/testing/withPluginManager.stories.d.ts +9 -3
  138. package/dist/types/src/testing/withPluginManager.stories.d.ts.map +1 -1
  139. package/dist/types/tsconfig.tsbuildinfo +1 -1
  140. package/moon.yml +4 -0
  141. package/package.json +34 -29
  142. package/src/common/capabilities.ts +109 -10
  143. package/src/common/collaboration.ts +6 -9
  144. package/src/common/events.ts +3 -1
  145. package/src/common/file.ts +1 -1
  146. package/src/common/index.ts +1 -1
  147. package/src/common/layout.ts +3 -4
  148. package/src/common/surface.ts +15 -18
  149. package/src/common/translations.ts +1 -1
  150. package/src/components/App.stories.tsx +33 -0
  151. package/src/components/App.tsx +59 -0
  152. package/src/components/DefaultFallback.tsx +26 -0
  153. package/src/components/index.ts +5 -0
  154. package/src/{App.tsx → components/useApp.tsx} +24 -136
  155. package/src/components/useLoading.tsx +70 -0
  156. package/src/core/capabilities.test.ts +2 -2
  157. package/src/core/capabilities.ts +12 -7
  158. package/src/core/manager.test.ts +22 -21
  159. package/src/core/manager.ts +139 -54
  160. package/src/core/plugin.ts +8 -2
  161. package/src/helpers.test.ts +1 -1
  162. package/src/index.ts +1 -1
  163. package/src/playground/debug/Debug.tsx +1 -1
  164. package/src/playground/debug/plugin.ts +7 -8
  165. package/src/playground/generator/Toolbar.tsx +2 -1
  166. package/src/playground/generator/generator.ts +4 -4
  167. package/src/playground/generator/plugin.ts +12 -13
  168. package/src/playground/layout/plugin.ts +10 -9
  169. package/src/playground/logger/Toolbar.tsx +2 -1
  170. package/src/playground/logger/plugin.ts +30 -25
  171. package/src/playground/logger/schema.ts +1 -1
  172. package/src/playground/playground.stories.tsx +20 -16
  173. package/src/plugin-intent/IntentPlugin.ts +13 -13
  174. package/src/plugin-intent/actions.ts +4 -6
  175. package/src/plugin-intent/errors.ts +1 -0
  176. package/src/plugin-intent/index.ts +1 -0
  177. package/src/plugin-intent/intent-dispatcher.test.ts +10 -3
  178. package/src/plugin-intent/intent-dispatcher.ts +16 -12
  179. package/src/plugin-intent/intent.ts +1 -1
  180. package/src/plugin-intent/meta.ts +10 -0
  181. package/src/plugin-settings/SettingsPlugin.ts +27 -28
  182. package/src/plugin-settings/actions.ts +9 -13
  183. package/src/plugin-settings/app-graph-builder.ts +20 -17
  184. package/src/plugin-settings/intent-resolver.ts +5 -4
  185. package/src/plugin-settings/meta.ts +10 -0
  186. package/src/plugin-settings/store.ts +1 -1
  187. package/src/plugin-settings/translations.ts +3 -3
  188. package/src/react/ErrorBoundary.tsx +26 -15
  189. package/src/react/IntentContext.tsx +3 -2
  190. package/src/react/Surface.stories.tsx +23 -18
  191. package/src/react/Surface.tsx +14 -5
  192. package/src/react/common.ts +2 -1
  193. package/src/react/useCapabilities.ts +2 -1
  194. package/src/testing/withPluginManager.stories.tsx +9 -5
  195. package/src/testing/withPluginManager.tsx +25 -29
  196. package/tsconfig.json +2 -9
  197. package/vitest.config.ts +8 -6
  198. package/.swc/plugins/v7_linux_x86_64_13.0.0/f45bdff002284d9e8f9ef3f0be909de12da36c049cbcf261ac78fc00abb09a2d +0 -0
  199. package/dist/lib/browser/app-graph-builder-LYF7EKNN.mjs.map +0 -7
  200. package/dist/lib/browser/chunk-FMN65HSW.mjs.map +0 -7
  201. package/dist/lib/browser/chunk-FO2PH7M3.mjs.map +0 -7
  202. package/dist/lib/browser/chunk-ORWHM7CO.mjs.map +0 -7
  203. package/dist/lib/browser/intent-resolver-ZTNOSO3A.mjs.map +0 -7
  204. package/dist/lib/node-esm/app-graph-builder-SAOWGJDK.mjs.map +0 -7
  205. package/dist/lib/node-esm/chunk-73HGSHKE.mjs.map +0 -7
  206. package/dist/lib/node-esm/chunk-UMZQERLE.mjs.map +0 -7
  207. package/dist/lib/node-esm/chunk-ZEZ4FVEU.mjs.map +0 -7
  208. package/dist/lib/node-esm/intent-resolver-W7Z7WFFM.mjs.map +0 -7
  209. package/dist/types/src/App.d.ts.map +0 -1
  210. /package/dist/lib/browser/{intent-dispatcher-LSYQZSEB.mjs.map → intent-dispatcher-Y4LZNOBC.mjs.map} +0 -0
  211. /package/dist/lib/node-esm/{intent-dispatcher-6CYNGPSW.mjs.map → intent-dispatcher-R4CCPBHO.mjs.map} +0 -0
@@ -2,20 +2,20 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import '@dxos-theme';
6
-
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
7
6
  import React, { useCallback, useState } from 'react';
8
7
 
9
8
  import { faker } from '@dxos/random';
10
9
  import { Button, List, ListItem } from '@dxos/react-ui';
11
- import { withLayout, withTheme } from '@dxos/storybook-utils';
10
+ import { withTheme } from '@dxos/react-ui/testing';
12
11
 
13
- import { PluginManagerProvider, usePluginManager } from './PluginManagerProvider';
14
- import { Surface, useSurfaces } from './Surface';
15
12
  import { Capabilities, createSurface } from '../common';
16
13
  import { type PluginManager } from '../core';
17
14
  import { setupPluginManager } from '../testing';
18
15
 
16
+ import { PluginManagerProvider, usePluginManager } from './PluginManagerProvider';
17
+ import { Surface, useSurfaces } from './Surface';
18
+
19
19
  const randomColor = (): string => {
20
20
  const hue = faker.number.int({ min: 0, max: 360 });
21
21
  const saturation = faker.number.int({ min: 50, max: 90 });
@@ -23,7 +23,7 @@ const randomColor = (): string => {
23
23
  return `hsl(${hue}, ${saturation}%, ${lightness}%)`;
24
24
  };
25
25
 
26
- const Story = () => {
26
+ const Component = () => {
27
27
  const manager = usePluginManager();
28
28
  const surfaces = useSurfaces();
29
29
  const [picked, setPicked] = useState('test');
@@ -77,20 +77,25 @@ const Story = () => {
77
77
  );
78
78
  };
79
79
 
80
- export default {
80
+ const DefaultStory = (props: { manager: PluginManager }) => {
81
+ return (
82
+ <PluginManagerProvider value={props.manager}>
83
+ <Component />
84
+ </PluginManagerProvider>
85
+ );
86
+ };
87
+
88
+ const meta = {
81
89
  title: 'sdk/app-framework/Surface',
82
- render: ({ manager }: { manager: PluginManager }) => {
83
- return (
84
- <PluginManagerProvider value={manager}>
85
- <Story />
86
- </PluginManagerProvider>
87
- );
88
- },
89
- // NOTE: Intentionally not using withPluginManager to try to reduce surface area of the story.
90
- decorators: [withTheme, withLayout()],
90
+ render: DefaultStory,
91
+ decorators: [withTheme],
91
92
  args: {
92
93
  manager: setupPluginManager(),
93
94
  },
94
- };
95
+ } satisfies Meta<typeof DefaultStory>;
96
+
97
+ export default meta;
98
+
99
+ type Story = StoryObj<typeof meta>;
95
100
 
96
- export const Default = {};
101
+ export const Default: Story = {};
@@ -2,16 +2,25 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import React, { memo, forwardRef, Suspense, useMemo, Fragment } from 'react';
5
+ import React, {
6
+ Fragment,
7
+ type NamedExoticComponent,
8
+ type RefAttributes,
9
+ Suspense,
10
+ forwardRef,
11
+ memo,
12
+ useMemo,
13
+ } from 'react';
6
14
 
7
15
  import { useDefaultValue } from '@dxos/react-hooks';
8
16
  import { byPosition } from '@dxos/util';
9
17
 
10
- import { ErrorBoundary } from './ErrorBoundary';
11
- import { useCapabilities } from './useCapabilities';
12
18
  import { Capabilities, type SurfaceDefinition, type SurfaceProps } from '../common';
13
19
  import { type PluginContext } from '../core';
14
20
 
21
+ import { ErrorBoundary } from './ErrorBoundary';
22
+ import { useCapabilities } from './useCapabilities';
23
+
15
24
  const DEFAULT_PLACEHOLDER = <Fragment />;
16
25
 
17
26
  /**
@@ -43,8 +52,8 @@ export const isSurfaceAvailable = (context: PluginContext, { role, data }: Pick<
43
52
  /**
44
53
  * A surface is a named region of the screen that can be populated by plugins.
45
54
  */
46
- export const Surface = memo(
47
- forwardRef<HTMLElement, SurfaceProps>(
55
+ export const Surface: NamedExoticComponent<SurfaceProps & RefAttributes<HTMLElement>> = memo(
56
+ forwardRef(
48
57
  ({ id: _id, role, data: _data, limit, fallback, placeholder = DEFAULT_PLACEHOLDER, ...rest }, forwardedRef) => {
49
58
  // TODO(wittjosiah): This will make all surfaces depend on a single signal.
50
59
  // This isn't ideal because it means that any change to the data will cause all surfaces to re-render.
@@ -2,9 +2,10 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { useCapability } from './useCapabilities';
6
5
  import { Capabilities } from '../common';
7
6
 
7
+ import { useCapability } from './useCapabilities';
8
+
8
9
  export const useIntentDispatcher = () => useCapability(Capabilities.IntentDispatcher);
9
10
 
10
11
  export const useAppGraph = () => useCapability(Capabilities.AppGraph);
@@ -6,9 +6,10 @@ import { useRxValue } from '@effect-rx/rx-react';
6
6
 
7
7
  import { invariant } from '@dxos/invariant';
8
8
 
9
- import { usePluginManager } from './PluginManagerProvider';
10
9
  import { type InterfaceDef } from '../core';
11
10
 
11
+ import { usePluginManager } from './PluginManagerProvider';
12
+
12
13
  /**
13
14
  * Hook to request capabilities from the plugin context.
14
15
  * @returns An array of capabilities.
@@ -2,15 +2,17 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
5
6
  import React from 'react';
6
7
 
7
- import { withTheme, type Meta } from '@dxos/storybook-utils';
8
+ import { withTheme } from '@dxos/react-ui/testing';
8
9
 
9
- import { withPluginManager } from './withPluginManager';
10
10
  import { Capabilities, createSurface } from '../common';
11
11
  import { contributes } from '../core';
12
12
  import { Surface } from '../react';
13
13
 
14
+ import { withPluginManager } from './withPluginManager';
15
+
14
16
  const DefaultStory = () => {
15
17
  console.log('Render');
16
18
  return (
@@ -21,7 +23,7 @@ const DefaultStory = () => {
21
23
  );
22
24
  };
23
25
 
24
- const meta: Meta = {
26
+ const meta = {
25
27
  title: 'sdk/app-framework/withPluginManager',
26
28
  render: DefaultStory,
27
29
  decorators: [
@@ -39,8 +41,10 @@ const meta: Meta = {
39
41
  ],
40
42
  }),
41
43
  ],
42
- };
44
+ } satisfies Meta<typeof DefaultStory>;
43
45
 
44
46
  export default meta;
45
47
 
46
- export const Default = {};
48
+ type Story = StoryObj<typeof meta>;
49
+
50
+ export const Default: Story = {};
@@ -6,26 +6,21 @@ import { type Decorator } from '@storybook/react';
6
6
  import React, { useEffect, useMemo } from 'react';
7
7
 
8
8
  import { raise } from '@dxos/debug';
9
+ import { useAsyncEffect } from '@dxos/react-hooks';
10
+ import { type MaybeProvider, getProviderValue } from '@dxos/util';
9
11
 
10
- import { useApp, type CreateAppOptions } from '../App';
11
12
  import { Capabilities, Events } from '../common';
13
+ import { type UseAppOptions, useApp } from '../components';
12
14
  import {
13
- contributes,
14
- defineModule,
15
- definePlugin,
16
15
  type ActivationEvent,
17
16
  type AnyCapability,
18
- PluginManager,
19
17
  type PluginContext,
18
+ PluginManager,
19
+ contributes,
20
+ defineModule,
21
+ definePlugin,
20
22
  } from '../core';
21
23
 
22
- // TODO(burdon): Factor out (use consistently in plugin framework?)
23
- export type Provider<C, R> = (context: C) => R;
24
- export type ProviderOrValue<C, R> = Provider<C, R> | R;
25
- export const getValue = <C, R>(providerOrValue: ProviderOrValue<C, R>, context: C): R => {
26
- return typeof providerOrValue === 'function' ? (providerOrValue as Provider<C, R>)(context) : providerOrValue;
27
- };
28
-
29
24
  /**
30
25
  * @internal
31
26
  */
@@ -34,16 +29,16 @@ export const setupPluginManager = ({
34
29
  plugins = [],
35
30
  core = plugins.map(({ meta }) => meta.id),
36
31
  ...options
37
- }: CreateAppOptions & Pick<WithPluginManagerOptions, 'capabilities'> = {}) => {
32
+ }: UseAppOptions & Pick<WithPluginManagerOptions, 'capabilities'> = {}) => {
38
33
  const pluginManager = new PluginManager({
39
34
  pluginLoader: () => raise(new Error('Not implemented')),
40
- plugins: [storyPlugin(), ...plugins],
41
- core: [STORY_PLUGIN, ...core],
35
+ plugins: [StoryPlugin(), ...plugins],
36
+ core: [StoryPlugin.meta.id, ...core],
42
37
  ...options,
43
38
  });
44
39
 
45
40
  if (capabilities) {
46
- getValue(capabilities, pluginManager.context).forEach((capability) => {
41
+ getProviderValue(capabilities, pluginManager.context).forEach((capability) => {
47
42
  pluginManager.context.contributeCapability({
48
43
  interface: capability.interface,
49
44
  implementation: capability.implementation,
@@ -55,8 +50,10 @@ export const setupPluginManager = ({
55
50
  return pluginManager;
56
51
  };
57
52
 
58
- export type WithPluginManagerOptions = CreateAppOptions & {
59
- capabilities?: ProviderOrValue<PluginContext, AnyCapability[]>;
53
+ export type WithPluginManagerOptions = UseAppOptions & {
54
+ /** @deprecated */
55
+ capabilities?: MaybeProvider<AnyCapability[], PluginContext>;
56
+ /** @deprecated */
60
57
  fireEvents?: (ActivationEvent | string)[];
61
58
  };
62
59
 
@@ -86,12 +83,8 @@ export const withPluginManager = (options: WithPluginManagerOptions = {}): Decor
86
83
  }, [pluginManager, context]);
87
84
 
88
85
  // Fire events.
89
- useEffect(() => {
90
- const timeout = setTimeout(async () => {
91
- await Promise.all(options.fireEvents?.map((event) => pluginManager.activate(event)) ?? []);
92
- });
93
-
94
- return () => clearTimeout(timeout);
86
+ useAsyncEffect(async () => {
87
+ await Promise.all(options.fireEvents?.map((event) => pluginManager.activate(event)) ?? []);
95
88
  }, [pluginManager]);
96
89
 
97
90
  // Create app.
@@ -101,10 +94,13 @@ export const withPluginManager = (options: WithPluginManagerOptions = {}): Decor
101
94
  };
102
95
  };
103
96
 
97
+ const storyMeta = {
98
+ id: 'dxos.org/app-framework/story',
99
+ name: 'Story',
100
+ };
101
+
104
102
  // No-op plugin to ensure there exists at least one plugin for the startup event.
105
103
  // This is necessary because `createApp` expects the startup event to complete before the app is ready.
106
- const STORY_PLUGIN = 'dxos.org/app-framework/story';
107
- const storyPlugin = () =>
108
- definePlugin({ id: STORY_PLUGIN, name: 'Story' }, [
109
- defineModule({ id: STORY_PLUGIN, activatesOn: Events.Startup, activate: () => [] }),
110
- ]);
104
+ const StoryPlugin = definePlugin(storyMeta, () => [
105
+ defineModule({ id: storyMeta.id, activatesOn: Events.Startup, activate: () => [] }),
106
+ ]);
package/tsconfig.json CHANGED
@@ -42,7 +42,7 @@
42
42
  "path": "../../core/blueprints"
43
43
  },
44
44
  {
45
- "path": "../../core/echo/echo-schema"
45
+ "path": "../../core/echo/echo"
46
46
  },
47
47
  {
48
48
  "path": "../../core/echo/echo-signals"
@@ -71,12 +71,5 @@
71
71
  {
72
72
  "path": "../schema"
73
73
  }
74
- ],
75
- "ts-node": {
76
- "compilerOptions": {
77
- "module": "CommonJS"
78
- },
79
- "files": true,
80
- "transpileOnly": true
81
- }
74
+ ]
82
75
  }
package/vitest.config.ts CHANGED
@@ -2,11 +2,13 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import { defineConfig, mergeConfig } from 'vitest/config';
5
+ import path from 'node:path';
6
+ import { fileURLToPath } from 'node:url';
6
7
 
7
- import { baseConfig } from '../../../vitest.base.config';
8
+ import { createConfig } from '../../../vitest.base.config';
8
9
 
9
- export default mergeConfig(
10
- baseConfig({ cwd: __dirname }),
11
- defineConfig({}),
12
- );
10
+ export default createConfig({
11
+ dirname: typeof __dirname !== 'undefined' ? __dirname : path.dirname(fileURLToPath(import.meta.url)),
12
+ node: true,
13
+ storybook: true,
14
+ });
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/plugin-settings/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 { createExtension, ROOT_ID } from '@dxos/app-graph';\nimport { type SettingsStore, type SettingsValue } from '@dxos/local-storage';\nimport { isNonNullable } from '@dxos/util';\n\nimport { SETTINGS_ID, SETTINGS_KEY, SETTINGS_PLUGIN, SettingsAction } from './actions';\nimport { Capabilities } from '../common';\nimport { contributes, type PluginMeta, type PluginContext } from '../core';\nimport { createIntent } from '../plugin-intent';\n\nexport default (context: PluginContext) =>\n contributes(Capabilities.AppGraphBuilder, [\n createExtension({\n id: `${SETTINGS_PLUGIN}/action`,\n actions: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n Option.map(() => [\n {\n id: SETTINGS_PLUGIN,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n await dispatch(createIntent(SettingsAction.Open));\n },\n properties: {\n label: ['open settings label', { ns: SETTINGS_PLUGIN }],\n icon: 'ph--gear--regular',\n disposition: 'menu',\n keyBinding: {\n macos: 'meta+,',\n windows: 'alt+,',\n },\n },\n },\n ]),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n createExtension({\n id: `${SETTINGS_PLUGIN}/core`,\n connector: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n Option.map(() => [\n {\n id: SETTINGS_ID,\n type: SETTINGS_PLUGIN,\n properties: {\n label: ['app settings label', { ns: SETTINGS_PLUGIN }],\n icon: 'ph--gear--regular',\n disposition: 'pin-end',\n position: 'hoist',\n testId: 'treeView.appSettings',\n },\n },\n ]),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n createExtension({\n id: `${SETTINGS_PLUGIN}/core-plugins`,\n connector: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) => (node.id !== SETTINGS_ID ? Option.none() : Option.some(node))),\n Option.map(() => {\n const manager = get(context.capability(Capabilities.PluginManager));\n const [settingsStore] = get(context.capabilities(Capabilities.SettingsStore));\n return [\n ...manager.plugins\n .filter((plugin) => manager.core.includes(plugin.meta.id))\n .map((plugin): [PluginMeta, SettingsStore<SettingsValue>] | null => {\n const settings = settingsStore?.getStore(plugin.meta.id);\n if (!settings) {\n return null;\n }\n\n return [plugin.meta, settings];\n })\n .filter(isNonNullable)\n .map(([meta, settings]) => ({\n id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,\n type: 'category',\n data: settings,\n properties: {\n label: meta.name ?? meta.id,\n icon: meta.icon ?? 'ph--circle--regular',\n },\n })),\n\n {\n id: `${SETTINGS_KEY}:custom-plugins`,\n type: 'category',\n properties: {\n label: ['custom plugins label', { ns: SETTINGS_PLUGIN }],\n icon: 'ph--squares-four--regular',\n role: 'branch',\n disposition: 'collection',\n },\n },\n ];\n }),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n createExtension({\n id: `${SETTINGS_PLUGIN}/custom-plugins`,\n connector: (node) =>\n Rx.make((get) =>\n pipe(\n get(node),\n Option.flatMap((node) =>\n node.id !== `${SETTINGS_KEY}:custom-plugins` ? Option.none() : Option.some(node),\n ),\n Option.map(() => {\n const manager = get(context.capability(Capabilities.PluginManager));\n const [settingsStore] = get(context.capabilities(Capabilities.SettingsStore));\n return manager.plugins\n .filter((plugin) => !manager.core.includes(plugin.meta.id))\n .map((plugin): [PluginMeta, SettingsStore<SettingsValue>] | null => {\n const settings = settingsStore?.getStore(plugin.meta.id);\n if (!settings) {\n return null;\n }\n\n return [plugin.meta, settings];\n })\n .filter(isNonNullable)\n .map(([meta, settings]) => ({\n id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,\n type: 'category',\n data: settings,\n properties: {\n label: meta.name ?? meta.id,\n icon: meta.icon ?? 'ph--circle--regular',\n },\n }));\n }),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n ]);\n"],
5
- "mappings": ";;;;;;;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,iBAAiBC,eAAe;AAEzC,SAASC,qBAAqB;AAO9B,IAAA,4BAAe,CAACC,YACdC,YAAYC,aAAaC,iBAAiB;EACxCC,gBAAgB;IACdC,IAAI,GAAGC,eAAAA;IACPC,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAOU,UAAUF,OAAOG,KAAKR,KAAAA,IAAQK,OAAOI,KAAI,CAAA,GAC/EJ,OAAOK,IAAI,MAAM;MACf;QACEb,IAAIC;QACJa,MAAM,YAAA;AACJ,gBAAM,EAAEC,iBAAiBC,SAAQ,IAAKrB,QAAQsB,cAAcpB,aAAaqB,gBAAgB;AACzF,gBAAMF,SAASG,aAAaC,eAAeC,IAAI,CAAA;QACjD;QACAC,YAAY;UACVC,OAAO;YAAC;YAAuB;cAAEC,IAAIvB;YAAgB;;UACrDwB,MAAM;UACNC,aAAa;UACbC,YAAY;YACVC,OAAO;YACPC,SAAS;UACX;QACF;MACF;KACD,GACDrB,OAAOsB,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;EACA/B,gBAAgB;IACdC,IAAI,GAAGC,eAAAA;IACP8B,WAAW,CAAC5B,SACVC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAOU,UAAUF,OAAOG,KAAKR,KAAAA,IAAQK,OAAOI,KAAI,CAAA,GAC/EJ,OAAOK,IAAI,MAAM;MACf;QACEb,IAAIgC;QACJC,MAAMhC;QACNqB,YAAY;UACVC,OAAO;YAAC;YAAsB;cAAEC,IAAIvB;YAAgB;;UACpDwB,MAAM;UACNC,aAAa;UACbQ,UAAU;UACVC,QAAQ;QACV;MACF;KACD,GACD3B,OAAOsB,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;EACA/B,gBAAgB;IACdC,IAAI,GAAGC,eAAAA;IACP8B,WAAW,CAAC5B,SACVC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAOgC,cAAcxB,OAAOI,KAAI,IAAKJ,OAAOG,KAAKR,KAAAA,CAAAA,GAChFK,OAAOK,IAAI,MAAA;AACT,YAAMuB,UAAU9B,IAAIX,QAAQ0C,WAAWxC,aAAayC,aAAa,CAAA;AACjE,YAAM,CAACC,aAAAA,IAAiBjC,IAAIX,QAAQ6C,aAAa3C,aAAa4C,aAAa,CAAA;AAC3E,aAAO;WACFL,QAAQM,QACRC,OAAO,CAACC,WAAWR,QAAQS,KAAKC,SAASF,OAAOG,KAAK/C,EAAE,CAAA,EACvDa,IAAI,CAAC+B,WAAAA;AACJ,gBAAMI,WAAWT,eAAeU,SAASL,OAAOG,KAAK/C,EAAE;AACvD,cAAI,CAACgD,UAAU;AACb,mBAAO;UACT;AAEA,iBAAO;YAACJ,OAAOG;YAAMC;;QACvB,CAAA,EACCL,OAAOO,aAAAA,EACPrC,IAAI,CAAC,CAACkC,MAAMC,QAAAA,OAAe;UAC1BhD,IAAI,GAAGmD,YAAAA,IAAgBJ,KAAK/C,GAAGoD,WAAW,KAAK,GAAA,CAAA;UAC/CnB,MAAM;UACNnB,MAAMkC;UACN1B,YAAY;YACVC,OAAOwB,KAAKM,QAAQN,KAAK/C;YACzByB,MAAMsB,KAAKtB,QAAQ;UACrB;QACF,EAAA;QAEF;UACEzB,IAAI,GAAGmD,YAAAA;UACPlB,MAAM;UACNX,YAAY;YACVC,OAAO;cAAC;cAAwB;gBAAEC,IAAIvB;cAAgB;;YACtDwB,MAAM;YACN6B,MAAM;YACN5B,aAAa;UACf;QACF;;IAEJ,CAAA,GACAlB,OAAOsB,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;EACA/B,gBAAgB;IACdC,IAAI,GAAGC,eAAAA;IACP8B,WAAW,CAAC5B,SACVC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UACdA,MAAKH,OAAO,GAAGmD,YAAAA,oBAAgC3C,OAAOI,KAAI,IAAKJ,OAAOG,KAAKR,KAAAA,CAAAA,GAE7EK,OAAOK,IAAI,MAAA;AACT,YAAMuB,UAAU9B,IAAIX,QAAQ0C,WAAWxC,aAAayC,aAAa,CAAA;AACjE,YAAM,CAACC,aAAAA,IAAiBjC,IAAIX,QAAQ6C,aAAa3C,aAAa4C,aAAa,CAAA;AAC3E,aAAOL,QAAQM,QACZC,OAAO,CAACC,WAAW,CAACR,QAAQS,KAAKC,SAASF,OAAOG,KAAK/C,EAAE,CAAA,EACxDa,IAAI,CAAC+B,WAAAA;AACJ,cAAMI,WAAWT,eAAeU,SAASL,OAAOG,KAAK/C,EAAE;AACvD,YAAI,CAACgD,UAAU;AACb,iBAAO;QACT;AAEA,eAAO;UAACJ,OAAOG;UAAMC;;MACvB,CAAA,EACCL,OAAOO,aAAAA,EACPrC,IAAI,CAAC,CAACkC,MAAMC,QAAAA,OAAe;QAC1BhD,IAAI,GAAGmD,YAAAA,IAAgBJ,KAAK/C,GAAGoD,WAAW,KAAK,GAAA,CAAA;QAC/CnB,MAAM;QACNnB,MAAMkC;QACN1B,YAAY;UACVC,OAAOwB,KAAKM,QAAQN,KAAK/C;UACzByB,MAAMsB,KAAKtB,QAAQ;QACrB;MACF,EAAA;IACJ,CAAA,GACAjB,OAAOsB,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;CACD;",
6
- "names": ["Rx", "Option", "pipe", "createExtension", "ROOT_ID", "isNonNullable", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "SETTINGS_PLUGIN", "actions", "node", "Rx", "make", "get", "pipe", "Option", "flatMap", "ROOT_ID", "some", "none", "map", "data", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "createIntent", "SettingsAction", "Open", "properties", "label", "ns", "icon", "disposition", "keyBinding", "macos", "windows", "getOrElse", "connector", "SETTINGS_ID", "type", "position", "testId", "manager", "capability", "PluginManager", "settingsStore", "capabilities", "SettingsStore", "plugins", "filter", "plugin", "core", "includes", "meta", "settings", "getStore", "isNonNullable", "SETTINGS_KEY", "replaceAll", "name", "role"]
7
- }