@dxos/app-framework 0.8.4-main.a4bbb77 → 0.8.4-main.abd8ff62ef
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.storybook/main.mts +2 -4
- package/.storybook/preview.mts +2 -2
- package/dist/lib/browser/capability-Q5XRXRD2.mjs +38 -0
- package/dist/lib/browser/capability-Q5XRXRD2.mjs.map +7 -0
- package/dist/lib/browser/capability-V7LR4LQN.mjs +35 -0
- package/dist/lib/browser/capability-V7LR4LQN.mjs.map +7 -0
- package/dist/lib/browser/chunk-23D4SJUE.mjs +42 -0
- package/dist/lib/browser/chunk-23D4SJUE.mjs.map +7 -0
- package/dist/lib/browser/chunk-3JWJXGLK.mjs +79 -0
- package/dist/lib/browser/chunk-3JWJXGLK.mjs.map +7 -0
- package/dist/lib/browser/chunk-3ZS2A3DN.mjs +907 -0
- package/dist/lib/browser/chunk-3ZS2A3DN.mjs.map +7 -0
- package/dist/lib/browser/chunk-45CHLTBV.mjs +34 -0
- package/dist/lib/browser/chunk-45CHLTBV.mjs.map +7 -0
- package/dist/lib/browser/chunk-5LAIGWLU.mjs +467 -0
- package/dist/lib/browser/chunk-5LAIGWLU.mjs.map +7 -0
- package/dist/lib/browser/chunk-66IXTIVK.mjs +48 -0
- package/dist/lib/browser/chunk-66IXTIVK.mjs.map +7 -0
- package/dist/lib/browser/chunk-FJ4765WW.mjs +8 -0
- package/dist/lib/browser/chunk-FJ4765WW.mjs.map +7 -0
- package/dist/lib/browser/chunk-G7SDBRKH.mjs +1 -0
- package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
- package/dist/lib/browser/chunk-JXCBZSBJ.mjs +372 -0
- package/dist/lib/browser/chunk-JXCBZSBJ.mjs.map +7 -0
- package/dist/lib/browser/chunk-MX5DKEJH.mjs +584 -0
- package/dist/lib/browser/chunk-MX5DKEJH.mjs.map +7 -0
- package/dist/lib/browser/chunk-WBHCSOBW.mjs +80 -0
- package/dist/lib/browser/chunk-WBHCSOBW.mjs.map +7 -0
- package/dist/lib/browser/chunk-Z55LVAGN.mjs +213 -0
- package/dist/lib/browser/chunk-Z55LVAGN.mjs.map +7 -0
- package/dist/lib/browser/chunk-ZGJAZSNE.mjs +142 -0
- package/dist/lib/browser/chunk-ZGJAZSNE.mjs.map +7 -0
- package/dist/lib/browser/cli/index.mjs +74 -0
- package/dist/lib/browser/cli/index.mjs.map +7 -0
- package/dist/lib/browser/common/activation-events.mjs +24 -0
- package/dist/lib/browser/common/capabilities.mjs +46 -0
- package/dist/lib/browser/core/activation-event.mjs +20 -0
- package/dist/lib/browser/core/activation-event.mjs.map +7 -0
- package/dist/lib/browser/core/capability.mjs +30 -0
- package/dist/lib/browser/core/capability.mjs.map +7 -0
- package/dist/lib/browser/core/plugin-manager.mjs +17 -0
- package/dist/lib/browser/core/plugin-manager.mjs.map +7 -0
- package/dist/lib/browser/core/plugin.mjs +37 -0
- package/dist/lib/browser/core/plugin.mjs.map +7 -0
- package/dist/lib/browser/core/url-loader.mjs +20 -0
- package/dist/lib/browser/core/url-loader.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +95 -148
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/invoker-capability-LNX4CGIV.mjs +44 -0
- package/dist/lib/browser/invoker-capability-LNX4CGIV.mjs.map +7 -0
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing/index.mjs +227 -41
- package/dist/lib/browser/testing/index.mjs.map +4 -4
- package/dist/lib/browser/testing/react.mjs +78 -0
- package/dist/lib/browser/testing/react.mjs.map +7 -0
- package/dist/lib/browser/ui/index.mjs +48 -0
- package/dist/lib/browser/ui/index.mjs.map +7 -0
- package/dist/lib/node-esm/capability-EW5GJCI6.mjs +39 -0
- package/dist/lib/node-esm/capability-EW5GJCI6.mjs.map +7 -0
- package/dist/lib/node-esm/capability-YKBMMD53.mjs +36 -0
- package/dist/lib/node-esm/capability-YKBMMD53.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-37Z53PXZ.mjs +10 -0
- package/dist/lib/node-esm/chunk-37Z53PXZ.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-6XW6LET6.mjs +35 -0
- package/dist/lib/node-esm/chunk-6XW6LET6.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-D347W3KO.mjs +143 -0
- package/dist/lib/node-esm/chunk-D347W3KO.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-D5PO2WXX.mjs +373 -0
- package/dist/lib/node-esm/chunk-D5PO2WXX.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +11 -0
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-HTBJU5FX.mjs +214 -0
- package/dist/lib/node-esm/chunk-HTBJU5FX.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-KM2F6GH6.mjs +468 -0
- package/dist/lib/node-esm/chunk-KM2F6GH6.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-OZ7DZA5Z.mjs +2 -0
- package/dist/lib/node-esm/chunk-OZ7DZA5Z.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-Q7XBFII4.mjs +908 -0
- package/dist/lib/node-esm/chunk-Q7XBFII4.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-SBS2YMPT.mjs +43 -0
- package/dist/lib/node-esm/chunk-SBS2YMPT.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-SDJ4B2LU.mjs +80 -0
- package/dist/lib/node-esm/chunk-SDJ4B2LU.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-WFSRZKBP.mjs +81 -0
- package/dist/lib/node-esm/chunk-WFSRZKBP.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-WKTLE7MG.mjs +585 -0
- package/dist/lib/node-esm/chunk-WKTLE7MG.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-XOCUANHO.mjs +49 -0
- package/dist/lib/node-esm/chunk-XOCUANHO.mjs.map +7 -0
- package/dist/lib/node-esm/cli/index.mjs +75 -0
- package/dist/lib/node-esm/cli/index.mjs.map +7 -0
- package/dist/lib/node-esm/common/activation-events.mjs +25 -0
- package/dist/lib/node-esm/common/activation-events.mjs.map +7 -0
- package/dist/lib/node-esm/common/capabilities.mjs +47 -0
- package/dist/lib/node-esm/common/capabilities.mjs.map +7 -0
- package/dist/lib/node-esm/core/activation-event.mjs +21 -0
- package/dist/lib/node-esm/core/activation-event.mjs.map +7 -0
- package/dist/lib/node-esm/core/capability.mjs +31 -0
- package/dist/lib/node-esm/core/capability.mjs.map +7 -0
- package/dist/lib/node-esm/core/plugin-manager.mjs +18 -0
- package/dist/lib/node-esm/core/plugin-manager.mjs.map +7 -0
- package/dist/lib/node-esm/core/plugin.mjs +38 -0
- package/dist/lib/node-esm/core/plugin.mjs.map +7 -0
- package/dist/lib/node-esm/core/url-loader.mjs +21 -0
- package/dist/lib/node-esm/core/url-loader.mjs.map +7 -0
- package/dist/lib/node-esm/index.mjs +95 -148
- package/dist/lib/node-esm/index.mjs.map +4 -4
- package/dist/lib/node-esm/invoker-capability-O4T5PHLA.mjs +45 -0
- package/dist/lib/node-esm/invoker-capability-O4T5PHLA.mjs.map +7 -0
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing/index.mjs +227 -41
- package/dist/lib/node-esm/testing/index.mjs.map +4 -4
- package/dist/lib/node-esm/testing/react.mjs +79 -0
- package/dist/lib/node-esm/testing/react.mjs.map +7 -0
- package/dist/lib/node-esm/ui/index.mjs +49 -0
- package/dist/lib/node-esm/ui/index.mjs.map +7 -0
- package/dist/plugin/node-esm/index.mjs +832 -0
- package/dist/plugin/node-esm/index.mjs.map +7 -0
- package/dist/plugin/node-esm/meta.json +1 -0
- package/dist/types/src/cli/cli.d.ts +39 -0
- package/dist/types/src/cli/cli.d.ts.map +1 -0
- package/dist/types/src/cli/index.d.ts +2 -0
- package/dist/types/src/cli/index.d.ts.map +1 -0
- package/dist/types/src/common/activation-events.d.ts +27 -0
- package/dist/types/src/common/activation-events.d.ts.map +1 -0
- package/dist/types/src/common/capabilities.d.ts +110 -197
- package/dist/types/src/common/capabilities.d.ts.map +1 -1
- package/dist/types/src/common/index.d.ts +4 -8
- package/dist/types/src/common/index.d.ts.map +1 -1
- package/dist/types/src/common/operations.d.ts +19 -0
- package/dist/types/src/common/operations.d.ts.map +1 -0
- package/dist/types/src/common/translations.d.ts +8 -8
- package/dist/types/src/common/translations.d.ts.map +1 -1
- package/dist/types/src/context.d.ts +5 -0
- package/dist/types/src/context.d.ts.map +1 -0
- package/dist/types/src/core/{events.d.ts → activation-event.d.ts} +11 -11
- package/dist/types/src/core/activation-event.d.ts.map +1 -0
- package/dist/types/src/core/capability-manager.d.ts +48 -0
- package/dist/types/src/core/capability-manager.d.ts.map +1 -0
- package/dist/types/src/core/capability-manager.test.d.ts +2 -0
- package/dist/types/src/core/capability-manager.test.d.ts.map +1 -0
- package/dist/types/src/core/capability.d.ts +156 -0
- package/dist/types/src/core/capability.d.ts.map +1 -0
- package/dist/types/src/core/index.d.ts +8 -4
- package/dist/types/src/core/index.d.ts.map +1 -1
- package/dist/types/src/core/plugin-asset-cache.d.ts +71 -0
- package/dist/types/src/core/plugin-asset-cache.d.ts.map +1 -0
- package/dist/types/src/core/plugin-manager.d.ts +122 -0
- package/dist/types/src/core/plugin-manager.d.ts.map +1 -0
- package/dist/types/src/core/plugin-manager.test.d.ts +2 -0
- package/dist/types/src/core/plugin-manager.test.d.ts.map +1 -0
- package/dist/types/src/core/plugin-manifest.d.ts +76 -0
- package/dist/types/src/core/plugin-manifest.d.ts.map +1 -0
- package/dist/types/src/core/plugin-manifest.test.d.ts +2 -0
- package/dist/types/src/core/plugin-manifest.test.d.ts.map +1 -0
- package/dist/types/src/core/plugin.d.ts +207 -39
- package/dist/types/src/core/plugin.d.ts.map +1 -1
- package/dist/types/src/core/url-loader.d.ts +112 -0
- package/dist/types/src/core/url-loader.d.ts.map +1 -0
- package/dist/types/src/core/url-loader.test.d.ts +2 -0
- package/dist/types/src/core/url-loader.test.d.ts.map +1 -0
- package/dist/types/src/helpers.d.ts.map +1 -1
- package/dist/types/src/index.d.ts +3 -4
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/plugin-operation/OperationPlugin.d.ts +3 -0
- package/dist/types/src/plugin-operation/OperationPlugin.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/capability.d.ts +7 -0
- package/dist/types/src/plugin-operation/history/capability.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/errors.d.ts +32 -0
- package/dist/types/src/plugin-operation/history/errors.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/history-tracker.d.ts +18 -0
- package/dist/types/src/plugin-operation/history/history-tracker.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/history-tracker.test.d.ts +2 -0
- package/dist/types/src/plugin-operation/history/history-tracker.test.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/index.d.ts +6 -0
- package/dist/types/src/plugin-operation/history/index.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/types.d.ts +13 -0
- package/dist/types/src/plugin-operation/history/types.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/undo-mapping.d.ts +101 -0
- package/dist/types/src/plugin-operation/history/undo-mapping.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/undo-registry.d.ts +23 -0
- package/dist/types/src/plugin-operation/history/undo-registry.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/history/undo-registry.test.d.ts +2 -0
- package/dist/types/src/plugin-operation/history/undo-registry.test.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/index.d.ts +3 -0
- package/dist/types/src/plugin-operation/index.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/invoker-capability.d.ts +6 -0
- package/dist/types/src/plugin-operation/invoker-capability.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/meta.d.ts +3 -0
- package/dist/types/src/plugin-operation/meta.d.ts.map +1 -0
- package/dist/types/src/plugin-operation/testing.d.ts +59 -0
- package/dist/types/src/plugin-operation/testing.d.ts.map +1 -0
- package/dist/types/src/plugin-runtime/RuntimePlugin.d.ts +3 -0
- package/dist/types/src/plugin-runtime/RuntimePlugin.d.ts.map +1 -0
- package/dist/types/src/plugin-runtime/capability.d.ts +6 -0
- package/dist/types/src/plugin-runtime/capability.d.ts.map +1 -0
- package/dist/types/src/plugin-runtime/index.d.ts +2 -0
- package/dist/types/src/plugin-runtime/index.d.ts.map +1 -0
- package/dist/types/src/plugin-runtime/meta.d.ts +3 -0
- package/dist/types/src/plugin-runtime/meta.d.ts.map +1 -0
- package/dist/types/src/testing/harness.d.ts +67 -0
- package/dist/types/src/testing/harness.d.ts.map +1 -0
- package/dist/types/src/testing/index.d.ts +2 -0
- package/dist/types/src/testing/index.d.ts.map +1 -1
- package/dist/types/src/testing/react.d.ts +27 -0
- package/dist/types/src/testing/react.d.ts.map +1 -0
- package/dist/types/src/testing/react.test.d.ts +2 -0
- package/dist/types/src/testing/react.test.d.ts.map +1 -0
- package/dist/types/src/testing/service.d.ts +8 -0
- package/dist/types/src/testing/service.d.ts.map +1 -0
- package/dist/types/src/testing/withPluginManager.d.ts +7 -6
- package/dist/types/src/testing/withPluginManager.d.ts.map +1 -1
- package/dist/types/src/testing/withPluginManager.stories.d.ts.map +1 -1
- package/dist/types/src/ui/components/App/App.d.ts +9 -0
- package/dist/types/src/ui/components/App/App.d.ts.map +1 -0
- package/dist/types/src/ui/components/App/App.stories.d.ts +19 -0
- package/dist/types/src/ui/components/App/App.stories.d.ts.map +1 -0
- package/dist/types/src/ui/components/App/index.d.ts +2 -0
- package/dist/types/src/ui/components/App/index.d.ts.map +1 -0
- package/dist/types/src/ui/components/Placeholder/Placeholder.d.ts +64 -0
- package/dist/types/src/ui/components/Placeholder/Placeholder.d.ts.map +1 -0
- package/dist/types/src/ui/components/Placeholder/Placeholder.stories.d.ts +19 -0
- package/dist/types/src/ui/components/Placeholder/Placeholder.stories.d.ts.map +1 -0
- package/dist/types/src/ui/components/Placeholder/index.d.ts +2 -0
- package/dist/types/src/ui/components/Placeholder/index.d.ts.map +1 -0
- package/dist/types/src/{playground/playground.stories.d.ts → ui/components/PluginManager/PluginManagerContext.stories.d.ts} +5 -3
- package/dist/types/src/ui/components/PluginManager/PluginManagerContext.stories.d.ts.map +1 -0
- package/dist/types/src/ui/components/PluginManager/PluginManagerProvider.d.ts +10 -0
- package/dist/types/src/ui/components/PluginManager/PluginManagerProvider.d.ts.map +1 -0
- package/dist/types/src/ui/components/PluginManager/index.d.ts +2 -0
- package/dist/types/src/ui/components/PluginManager/index.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/SurfaceComponent.d.ts +24 -0
- package/dist/types/src/ui/components/Surface/SurfaceComponent.d.ts.map +1 -0
- package/dist/types/src/{components/App.stories.d.ts → ui/components/Surface/SurfaceComponent.stories.d.ts} +1 -1
- package/dist/types/src/ui/components/Surface/SurfaceComponent.stories.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/SurfaceInfo.d.ts +11 -0
- package/dist/types/src/ui/components/Surface/SurfaceInfo.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/SurfaceProfilerContext.d.ts +48 -0
- package/dist/types/src/ui/components/Surface/SurfaceProfilerContext.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/context.d.ts +5 -0
- package/dist/types/src/ui/components/Surface/context.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/index.d.ts +36 -0
- package/dist/types/src/ui/components/Surface/index.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/types.d.ts +197 -0
- package/dist/types/src/ui/components/Surface/types.d.ts.map +1 -0
- package/dist/types/src/ui/components/Surface/types.test.d.ts +2 -0
- package/dist/types/src/ui/components/Surface/types.test.d.ts.map +1 -0
- package/dist/types/src/ui/components/index.d.ts +5 -0
- package/dist/types/src/ui/components/index.d.ts.map +1 -0
- package/dist/types/src/ui/hooks/index.d.ts +6 -0
- package/dist/types/src/ui/hooks/index.d.ts.map +1 -0
- package/dist/types/src/ui/hooks/useApp.d.ts +88 -0
- package/dist/types/src/ui/hooks/useApp.d.ts.map +1 -0
- package/dist/types/src/ui/hooks/useApp.test.d.ts +2 -0
- package/dist/types/src/ui/hooks/useApp.test.d.ts.map +1 -0
- package/dist/types/src/ui/hooks/useCapabilities.d.ts +31 -0
- package/dist/types/src/ui/hooks/useCapabilities.d.ts.map +1 -0
- package/dist/types/src/{components → ui/hooks}/useLoading.d.ts +1 -2
- package/dist/types/src/ui/hooks/useLoading.d.ts.map +1 -0
- package/dist/types/src/ui/hooks/useSettingsState.d.ts +10 -0
- package/dist/types/src/ui/hooks/useSettingsState.d.ts.map +1 -0
- package/dist/types/src/ui/hooks/useSurface.d.ts +3 -0
- package/dist/types/src/ui/hooks/useSurface.d.ts.map +1 -0
- package/dist/types/src/ui/index.d.ts +3 -0
- package/dist/types/src/ui/index.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/boot-loader/BootLoader.stories.d.ts +34 -0
- package/dist/types/src/vite-plugin/boot-loader/BootLoader.stories.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/boot-loader/index.d.ts +52 -0
- package/dist/types/src/vite-plugin/boot-loader/index.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/composer/index.d.ts +34 -0
- package/dist/types/src/vite-plugin/composer/index.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/import-map/index.d.ts +28 -0
- package/dist/types/src/vite-plugin/import-map/index.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/index.d.ts +5 -0
- package/dist/types/src/vite-plugin/index.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/manifest.d.ts +37 -0
- package/dist/types/src/vite-plugin/manifest.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/manifest.test.d.ts +2 -0
- package/dist/types/src/vite-plugin/manifest.test.d.ts.map +1 -0
- package/dist/types/src/vite-plugin/packages.d.ts +13 -0
- package/dist/types/src/vite-plugin/packages.d.ts.map +1 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/moon.yml +25 -6
- package/package.json +112 -55
- package/src/cli/cli.ts +107 -0
- package/src/{components → cli}/index.ts +1 -1
- package/src/common/activation-events.ts +44 -0
- package/src/common/capabilities.ts +169 -210
- package/src/common/index.ts +4 -8
- package/src/common/operations.ts +35 -0
- package/src/common/translations.ts +18 -10
- package/src/context.ts +9 -0
- package/src/core/{events.ts → activation-event.ts} +10 -7
- package/src/core/capability-manager.test.ts +151 -0
- package/src/core/capability-manager.ts +192 -0
- package/src/core/capability.ts +247 -0
- package/src/core/index.ts +8 -4
- package/src/core/plugin-asset-cache.ts +60 -0
- package/src/core/plugin-manager.test.ts +1354 -0
- package/src/core/plugin-manager.ts +1025 -0
- package/src/core/plugin-manifest.test.ts +48 -0
- package/src/core/plugin-manifest.ts +102 -0
- package/src/core/plugin.ts +365 -45
- package/src/core/url-loader.test.ts +178 -0
- package/src/core/url-loader.ts +337 -0
- package/src/index.ts +3 -4
- package/src/plugin-operation/OperationPlugin.ts +24 -0
- package/src/plugin-operation/history/capability.ts +36 -0
- package/src/plugin-operation/history/errors.ts +7 -0
- package/src/plugin-operation/history/history-tracker.test.ts +374 -0
- package/src/plugin-operation/history/history-tracker.ts +128 -0
- package/src/plugin-operation/history/index.ts +9 -0
- package/src/plugin-operation/history/types.ts +17 -0
- package/src/plugin-operation/history/undo-mapping.ts +135 -0
- package/src/plugin-operation/history/undo-registry.test.ts +72 -0
- package/src/plugin-operation/history/undo-registry.ts +54 -0
- package/src/plugin-operation/index.ts +6 -0
- package/src/plugin-operation/invoker-capability.ts +55 -0
- package/src/plugin-operation/meta.ts +11 -0
- package/src/plugin-operation/testing.ts +155 -0
- package/src/plugin-runtime/RuntimePlugin.ts +19 -0
- package/src/plugin-runtime/capability.ts +53 -0
- package/src/{playground/layout → plugin-runtime}/index.ts +1 -1
- package/src/plugin-runtime/meta.ts +11 -0
- package/src/testing/harness.ts +229 -0
- package/src/testing/index.ts +2 -0
- package/src/testing/react.test.tsx +48 -0
- package/src/testing/react.tsx +113 -0
- package/src/testing/service.ts +52 -0
- package/src/testing/withPluginManager.stories.tsx +8 -9
- package/src/testing/withPluginManager.tsx +68 -40
- package/src/ui/components/App/App.stories.tsx +92 -0
- package/src/ui/components/App/App.tsx +81 -0
- package/src/{playground/debug → ui/components/App}/index.ts +1 -1
- package/src/ui/components/Placeholder/Placeholder.stories.tsx +77 -0
- package/src/ui/components/Placeholder/Placeholder.tsx +155 -0
- package/src/{playground/logger → ui/components/Placeholder}/index.ts +1 -1
- package/src/ui/components/PluginManager/PluginManagerContext.stories.tsx +185 -0
- package/src/{react → ui/components/PluginManager}/PluginManagerProvider.ts +3 -3
- package/src/ui/components/PluginManager/index.ts +5 -0
- package/src/ui/components/Surface/SurfaceComponent.stories.tsx +144 -0
- package/src/ui/components/Surface/SurfaceComponent.tsx +303 -0
- package/src/ui/components/Surface/SurfaceInfo.tsx +107 -0
- package/src/ui/components/Surface/SurfaceProfilerContext.tsx +207 -0
- package/src/ui/components/Surface/context.ts +12 -0
- package/src/ui/components/Surface/index.ts +54 -0
- package/src/ui/components/Surface/types.test.ts +126 -0
- package/src/ui/components/Surface/types.ts +269 -0
- package/src/ui/components/index.ts +8 -0
- package/src/ui/hooks/index.ts +9 -0
- package/src/ui/hooks/useApp.test.tsx +159 -0
- package/src/ui/hooks/useApp.tsx +413 -0
- package/src/ui/hooks/useCapabilities.ts +67 -0
- package/src/{components → ui/hooks}/useLoading.tsx +16 -10
- package/src/ui/hooks/useSettingsState.ts +26 -0
- package/src/ui/hooks/useSurface.ts +13 -0
- package/src/ui/index.ts +6 -0
- package/src/vite-plugin/boot-loader/BootLoader.stories.tsx +263 -0
- package/src/vite-plugin/boot-loader/boot-loader.css +294 -0
- package/src/vite-plugin/boot-loader/boot-loader.js +274 -0
- package/src/vite-plugin/boot-loader/index.ts +112 -0
- package/src/vite-plugin/composer/index.ts +277 -0
- package/src/vite-plugin/import-map/index.ts +524 -0
- package/src/vite-plugin/index.ts +10 -0
- package/src/vite-plugin/manifest.test.ts +24 -0
- package/src/vite-plugin/manifest.ts +50 -0
- package/src/vite-plugin/packages.ts +188 -0
- package/tsconfig.json +18 -15
- package/tsconfig.node.json +2 -4
- package/typedoc.json +2 -4
- package/vitest.config.ts +1 -1
- package/.swc/plugins/linux_x86_64_19.0.0/727453fb3a62f7f1d952a41e051ca8a6f88cadc45cee43c6a4d1aa45f9b75665.wasmer-v7 +0 -0
- package/.swc/plugins/linux_x86_64_19.0.0/fce1bdb8e20a094e4af08bad09cc81497ed0e2e7c51223b07d371063cca18429.wasmer-v7 +0 -0
- package/dist/lib/browser/app-graph-builder-XH4OYQLC.mjs +0 -137
- package/dist/lib/browser/app-graph-builder-XH4OYQLC.mjs.map +0 -7
- package/dist/lib/browser/chunk-6V54SRFL.mjs +0 -1638
- package/dist/lib/browser/chunk-6V54SRFL.mjs.map +0 -7
- package/dist/lib/browser/chunk-RGKMLI6U.mjs +0 -35
- package/dist/lib/browser/chunk-RGKMLI6U.mjs.map +0 -7
- package/dist/lib/browser/chunk-ZZVFNUHZ.mjs +0 -467
- package/dist/lib/browser/chunk-ZZVFNUHZ.mjs.map +0 -7
- package/dist/lib/browser/intent-dispatcher-VFMJVO2M.mjs +0 -11
- package/dist/lib/browser/intent-resolver-ICAPD4JL.mjs +0 -39
- package/dist/lib/browser/intent-resolver-ICAPD4JL.mjs.map +0 -7
- package/dist/lib/browser/store-7ZGMHOGB.mjs +0 -30
- package/dist/lib/browser/store-7ZGMHOGB.mjs.map +0 -7
- package/dist/lib/browser/worker.mjs +0 -77
- package/dist/lib/node-esm/app-graph-builder-C7H22SOL.mjs +0 -138
- package/dist/lib/node-esm/app-graph-builder-C7H22SOL.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-AXSZKZFD.mjs +0 -468
- package/dist/lib/node-esm/chunk-AXSZKZFD.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-LKPMRTRR.mjs +0 -37
- package/dist/lib/node-esm/chunk-LKPMRTRR.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-SOVTUUAY.mjs +0 -1640
- package/dist/lib/node-esm/chunk-SOVTUUAY.mjs.map +0 -7
- package/dist/lib/node-esm/intent-dispatcher-SAPOKSLZ.mjs +0 -12
- package/dist/lib/node-esm/intent-resolver-CRNJ6BMD.mjs +0 -40
- package/dist/lib/node-esm/intent-resolver-CRNJ6BMD.mjs.map +0 -7
- package/dist/lib/node-esm/store-H4F4RMYD.mjs +0 -31
- package/dist/lib/node-esm/store-H4F4RMYD.mjs.map +0 -7
- package/dist/lib/node-esm/worker.mjs +0 -78
- package/dist/types/src/common/collaboration.d.ts +0 -20
- package/dist/types/src/common/collaboration.d.ts.map +0 -1
- package/dist/types/src/common/events.d.ts +0 -52
- package/dist/types/src/common/events.d.ts.map +0 -1
- package/dist/types/src/common/file.d.ts +0 -14
- package/dist/types/src/common/file.d.ts.map +0 -1
- package/dist/types/src/common/graph.d.ts +0 -21
- package/dist/types/src/common/graph.d.ts.map +0 -1
- package/dist/types/src/common/layout.d.ts +0 -279
- package/dist/types/src/common/layout.d.ts.map +0 -1
- package/dist/types/src/common/surface.d.ts +0 -59
- package/dist/types/src/common/surface.d.ts.map +0 -1
- package/dist/types/src/components/App.d.ts +0 -10
- package/dist/types/src/components/App.d.ts.map +0 -1
- package/dist/types/src/components/App.stories.d.ts.map +0 -1
- package/dist/types/src/components/DefaultFallback.d.ts +0 -8
- package/dist/types/src/components/DefaultFallback.d.ts.map +0 -1
- package/dist/types/src/components/index.d.ts +0 -2
- package/dist/types/src/components/index.d.ts.map +0 -1
- package/dist/types/src/components/useApp.d.ts +0 -44
- package/dist/types/src/components/useApp.d.ts.map +0 -1
- package/dist/types/src/components/useLoading.d.ts.map +0 -1
- package/dist/types/src/core/capabilities.d.ts +0 -117
- package/dist/types/src/core/capabilities.d.ts.map +0 -1
- package/dist/types/src/core/capabilities.test.d.ts +0 -2
- package/dist/types/src/core/capabilities.test.d.ts.map +0 -1
- package/dist/types/src/core/events.d.ts.map +0 -1
- package/dist/types/src/core/manager.d.ts +0 -126
- package/dist/types/src/core/manager.d.ts.map +0 -1
- package/dist/types/src/core/manager.test.d.ts +0 -2
- package/dist/types/src/core/manager.test.d.ts.map +0 -1
- package/dist/types/src/playground/debug/Debug.d.ts +0 -6
- package/dist/types/src/playground/debug/Debug.d.ts.map +0 -1
- package/dist/types/src/playground/debug/index.d.ts +0 -2
- package/dist/types/src/playground/debug/index.d.ts.map +0 -1
- package/dist/types/src/playground/debug/plugin.d.ts +0 -2
- package/dist/types/src/playground/debug/plugin.d.ts.map +0 -1
- package/dist/types/src/playground/generator/Main.d.ts +0 -6
- package/dist/types/src/playground/generator/Main.d.ts.map +0 -1
- package/dist/types/src/playground/generator/Toolbar.d.ts +0 -6
- package/dist/types/src/playground/generator/Toolbar.d.ts.map +0 -1
- package/dist/types/src/playground/generator/generator.d.ts +0 -7
- package/dist/types/src/playground/generator/generator.d.ts.map +0 -1
- package/dist/types/src/playground/generator/index.d.ts +0 -3
- package/dist/types/src/playground/generator/index.d.ts.map +0 -1
- package/dist/types/src/playground/generator/plugin.d.ts +0 -2
- package/dist/types/src/playground/generator/plugin.d.ts.map +0 -1
- package/dist/types/src/playground/layout/Layout.d.ts +0 -8
- package/dist/types/src/playground/layout/Layout.d.ts.map +0 -1
- package/dist/types/src/playground/layout/index.d.ts +0 -2
- package/dist/types/src/playground/layout/index.d.ts.map +0 -1
- package/dist/types/src/playground/layout/plugin.d.ts +0 -2
- package/dist/types/src/playground/layout/plugin.d.ts.map +0 -1
- package/dist/types/src/playground/logger/Toolbar.d.ts +0 -6
- package/dist/types/src/playground/logger/Toolbar.d.ts.map +0 -1
- package/dist/types/src/playground/logger/index.d.ts +0 -2
- package/dist/types/src/playground/logger/index.d.ts.map +0 -1
- package/dist/types/src/playground/logger/plugin.d.ts +0 -2
- package/dist/types/src/playground/logger/plugin.d.ts.map +0 -1
- package/dist/types/src/playground/logger/schema.d.ts +0 -13
- package/dist/types/src/playground/logger/schema.d.ts.map +0 -1
- package/dist/types/src/playground/playground.stories.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/IntentPlugin.d.ts +0 -2
- package/dist/types/src/plugin-intent/IntentPlugin.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/actions.d.ts +0 -36
- package/dist/types/src/plugin-intent/actions.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/errors.d.ts +0 -16
- package/dist/types/src/plugin-intent/errors.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/index.d.ts +0 -6
- package/dist/types/src/plugin-intent/index.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/intent-dispatcher.d.ts +0 -139
- package/dist/types/src/plugin-intent/intent-dispatcher.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/intent-dispatcher.test.d.ts +0 -2
- package/dist/types/src/plugin-intent/intent-dispatcher.test.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/intent.d.ts +0 -63
- package/dist/types/src/plugin-intent/intent.d.ts.map +0 -1
- package/dist/types/src/plugin-intent/meta.d.ts +0 -3
- package/dist/types/src/plugin-intent/meta.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/SettingsPlugin.d.ts +0 -2
- package/dist/types/src/plugin-settings/SettingsPlugin.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/actions.d.ts +0 -25
- package/dist/types/src/plugin-settings/actions.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/app-graph-builder.d.ts +0 -4
- package/dist/types/src/plugin-settings/app-graph-builder.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/index.d.ts +0 -3
- package/dist/types/src/plugin-settings/index.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/intent-resolver.d.ts +0 -4
- package/dist/types/src/plugin-settings/intent-resolver.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/meta.d.ts +0 -3
- package/dist/types/src/plugin-settings/meta.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/store.d.ts +0 -5
- package/dist/types/src/plugin-settings/store.d.ts.map +0 -1
- package/dist/types/src/plugin-settings/translations.d.ts +0 -11
- package/dist/types/src/plugin-settings/translations.d.ts.map +0 -1
- package/dist/types/src/react/ErrorBoundary.d.ts +0 -30
- package/dist/types/src/react/ErrorBoundary.d.ts.map +0 -1
- package/dist/types/src/react/IntentContext.d.ts +0 -8
- package/dist/types/src/react/IntentContext.d.ts.map +0 -1
- package/dist/types/src/react/PluginManagerProvider.d.ts +0 -10
- package/dist/types/src/react/PluginManagerProvider.d.ts.map +0 -1
- package/dist/types/src/react/Surface.d.ts +0 -12
- package/dist/types/src/react/Surface.d.ts.map +0 -1
- package/dist/types/src/react/Surface.stories.d.ts +0 -17
- package/dist/types/src/react/Surface.stories.d.ts.map +0 -1
- package/dist/types/src/react/common.d.ts +0 -13
- package/dist/types/src/react/common.d.ts.map +0 -1
- package/dist/types/src/react/index.d.ts +0 -7
- package/dist/types/src/react/index.d.ts.map +0 -1
- package/dist/types/src/react/useCapabilities.d.ts +0 -13
- package/dist/types/src/react/useCapabilities.d.ts.map +0 -1
- package/dist/types/src/react/useIntentResolver.d.ts +0 -3
- package/dist/types/src/react/useIntentResolver.d.ts.map +0 -1
- package/dist/types/src/worker.d.ts +0 -4
- package/dist/types/src/worker.d.ts.map +0 -1
- package/src/common/collaboration.ts +0 -18
- package/src/common/events.ts +0 -79
- package/src/common/file.ts +0 -22
- package/src/common/graph.ts +0 -30
- package/src/common/layout.ts +0 -277
- package/src/common/surface.ts +0 -83
- package/src/components/App.stories.tsx +0 -33
- package/src/components/App.tsx +0 -59
- package/src/components/DefaultFallback.tsx +0 -26
- package/src/components/useApp.tsx +0 -164
- package/src/core/capabilities.test.ts +0 -136
- package/src/core/capabilities.ts +0 -259
- package/src/core/manager.test.ts +0 -516
- package/src/core/manager.ts +0 -597
- package/src/playground/debug/Debug.tsx +0 -39
- package/src/playground/debug/plugin.ts +0 -16
- package/src/playground/generator/Main.tsx +0 -71
- package/src/playground/generator/Toolbar.tsx +0 -47
- package/src/playground/generator/generator.ts +0 -48
- package/src/playground/generator/index.ts +0 -6
- package/src/playground/generator/plugin.ts +0 -22
- package/src/playground/layout/Layout.tsx +0 -33
- package/src/playground/layout/plugin.ts +0 -18
- package/src/playground/logger/Toolbar.tsx +0 -30
- package/src/playground/logger/plugin.ts +0 -41
- package/src/playground/logger/schema.ts +0 -12
- package/src/playground/playground.stories.tsx +0 -46
- package/src/plugin-intent/IntentPlugin.ts +0 -20
- package/src/plugin-intent/actions.ts +0 -31
- package/src/plugin-intent/errors.ts +0 -40
- package/src/plugin-intent/index.ts +0 -9
- package/src/plugin-intent/intent-dispatcher.test.ts +0 -279
- package/src/plugin-intent/intent-dispatcher.ts +0 -334
- package/src/plugin-intent/intent.ts +0 -154
- package/src/plugin-intent/meta.ts +0 -10
- package/src/plugin-settings/SettingsPlugin.ts +0 -34
- package/src/plugin-settings/actions.ts +0 -25
- package/src/plugin-settings/app-graph-builder.ts +0 -159
- package/src/plugin-settings/index.ts +0 -6
- package/src/plugin-settings/intent-resolver.ts +0 -35
- package/src/plugin-settings/meta.ts +0 -10
- package/src/plugin-settings/store.ts +0 -33
- package/src/plugin-settings/translations.ts +0 -19
- package/src/react/ErrorBoundary.tsx +0 -54
- package/src/react/IntentContext.tsx +0 -35
- package/src/react/Surface.stories.tsx +0 -101
- package/src/react/Surface.tsx +0 -86
- package/src/react/common.ts +0 -13
- package/src/react/index.ts +0 -10
- package/src/react/useCapabilities.ts +0 -31
- package/src/react/useIntentResolver.ts +0 -22
- package/src/worker.ts +0 -11
- /package/dist/lib/browser/{intent-dispatcher-VFMJVO2M.mjs.map → chunk-G7SDBRKH.mjs.map} +0 -0
- /package/dist/lib/browser/{worker.mjs.map → chunk-J5LGTIGS.mjs.map} +0 -0
- /package/dist/lib/{node-esm/intent-dispatcher-SAPOKSLZ.mjs.map → browser/common/activation-events.mjs.map} +0 -0
- /package/dist/lib/{node-esm/worker.mjs.map → browser/common/capabilities.mjs.map} +0 -0
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { Registry } from '@effect-atom/atom-react';
|
|
6
|
+
import { describe, expect, it, onTestFinished } from '@effect/vitest';
|
|
7
|
+
import * as Effect from 'effect/Effect';
|
|
8
|
+
|
|
9
|
+
import * as Capability from './capability';
|
|
10
|
+
import * as CapabilityManager from './capability-manager';
|
|
11
|
+
|
|
12
|
+
describe('CapabilityManager', () => {
|
|
13
|
+
it('should return empty array if no capabilities are contributed', () => {
|
|
14
|
+
const registry = Registry.make();
|
|
15
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
16
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
17
|
+
expect(capabilityManager.getAll(interfaceDef)).toEqual([]);
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
it('should throw when getCapability is called and no capability exists', () => {
|
|
21
|
+
const registry = Registry.make();
|
|
22
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
23
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
24
|
+
expect(() => capabilityManager.get(interfaceDef)).toThrow('No capability found');
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it.effect('Capability.get should fail when no capability exists', () =>
|
|
28
|
+
Effect.gen(function* () {
|
|
29
|
+
const registry = Registry.make();
|
|
30
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
31
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
32
|
+
|
|
33
|
+
const result = yield* Capability.get(interfaceDef).pipe(
|
|
34
|
+
Effect.provideService(Capability.Service, capabilityManager),
|
|
35
|
+
Effect.either,
|
|
36
|
+
);
|
|
37
|
+
|
|
38
|
+
expect(result._tag).toEqual('Left');
|
|
39
|
+
}),
|
|
40
|
+
);
|
|
41
|
+
|
|
42
|
+
it('should be able to contribute and request capabilities', () => {
|
|
43
|
+
const registry = Registry.make();
|
|
44
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
45
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
46
|
+
const implementation = { example: 'identifier' };
|
|
47
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation, module: 'test' });
|
|
48
|
+
expect(capabilityManager.getAll(interfaceDef)).toEqual([implementation]);
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it('should be able to remove capabilities', () => {
|
|
52
|
+
const registry = Registry.make();
|
|
53
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
54
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
55
|
+
const implementation = { example: 'identifier' };
|
|
56
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation, module: 'test' });
|
|
57
|
+
expect(capabilityManager.getAll(interfaceDef)).toEqual([implementation]);
|
|
58
|
+
capabilityManager.remove(interfaceDef, implementation);
|
|
59
|
+
expect(capabilityManager.getAll(interfaceDef)).toEqual([]);
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it('should be able to contribute and request multiple implementations', () => {
|
|
63
|
+
const registry = Registry.make();
|
|
64
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
65
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
66
|
+
const implementation1 = { example: 'first' };
|
|
67
|
+
const implementation2 = { example: 'second' };
|
|
68
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation: implementation1, module: 'test' });
|
|
69
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation: implementation2, module: 'test' });
|
|
70
|
+
expect(capabilityManager.getAll(interfaceDef)).toEqual([implementation1, implementation2]);
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
it('should be able to request multiple capabilities', () => {
|
|
74
|
+
const registry = Registry.make();
|
|
75
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
76
|
+
const interfaceDef1 = Capability.make<{ one: number }>('@dxos/app-framework/test/one');
|
|
77
|
+
const interfaceDef2 = Capability.make<{ two: number }>('@dxos/app-framework/test/two');
|
|
78
|
+
const implementation1 = { one: 1 };
|
|
79
|
+
const implementation2 = { two: 2 };
|
|
80
|
+
capabilityManager.contribute({ interface: interfaceDef1, implementation: implementation1, module: 'test' });
|
|
81
|
+
capabilityManager.contribute({ interface: interfaceDef2, implementation: implementation2, module: 'test' });
|
|
82
|
+
expect(capabilityManager.getAll(interfaceDef1)).toEqual([implementation1]);
|
|
83
|
+
expect(capabilityManager.getAll(interfaceDef2)).toEqual([implementation2]);
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it('should be reactive', () => {
|
|
87
|
+
const registry = Registry.make();
|
|
88
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
89
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
90
|
+
|
|
91
|
+
let count = 0;
|
|
92
|
+
const cancel = registry.subscribe(capabilityManager.atom(interfaceDef), () => {
|
|
93
|
+
count++;
|
|
94
|
+
});
|
|
95
|
+
onTestFinished(() => cancel());
|
|
96
|
+
expect(count).toEqual(0);
|
|
97
|
+
|
|
98
|
+
registry.get(capabilityManager.atom(interfaceDef));
|
|
99
|
+
expect(count).toEqual(1);
|
|
100
|
+
|
|
101
|
+
const implementation = { example: 'identifier' };
|
|
102
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation, module: 'test' });
|
|
103
|
+
expect(count).toEqual(2);
|
|
104
|
+
|
|
105
|
+
capabilityManager.remove(interfaceDef, implementation);
|
|
106
|
+
expect(count).toEqual(3);
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
it('should not be reactive to changes within the implementation', () => {
|
|
110
|
+
const registry = Registry.make();
|
|
111
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
112
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
113
|
+
|
|
114
|
+
let count = 0;
|
|
115
|
+
const cancel = registry.subscribe(capabilityManager.atom(interfaceDef), () => {
|
|
116
|
+
count++;
|
|
117
|
+
});
|
|
118
|
+
onTestFinished(() => cancel());
|
|
119
|
+
expect(count).toEqual(0);
|
|
120
|
+
|
|
121
|
+
registry.get(capabilityManager.atom(interfaceDef));
|
|
122
|
+
expect(count).toEqual(1);
|
|
123
|
+
|
|
124
|
+
const implementation = { example: 'identifier' };
|
|
125
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation, module: 'test' });
|
|
126
|
+
expect(count).toEqual(2);
|
|
127
|
+
|
|
128
|
+
implementation.example = 'updated';
|
|
129
|
+
expect(count).toEqual(2);
|
|
130
|
+
|
|
131
|
+
const capabilities = capabilityManager.getAll(interfaceDef);
|
|
132
|
+
expect(capabilities).toEqual([implementation]);
|
|
133
|
+
expect(capabilities[0].example).toEqual('updated');
|
|
134
|
+
expect(count).toEqual(2);
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
it.effect('should be able to wait for a capability', () =>
|
|
138
|
+
Effect.gen(function* () {
|
|
139
|
+
const registry = Registry.make();
|
|
140
|
+
const capabilityManager = CapabilityManager.make({ registry });
|
|
141
|
+
const interfaceDef = Capability.make<{ example: string }>('@dxos/app-framework/test/example');
|
|
142
|
+
|
|
143
|
+
expect(capabilityManager.getAll(interfaceDef)).toHaveLength(0);
|
|
144
|
+
const capability = capabilityManager.waitFor(interfaceDef);
|
|
145
|
+
|
|
146
|
+
const implementation = { example: 'identifier' };
|
|
147
|
+
capabilityManager.contribute({ interface: interfaceDef, implementation, module: 'test' });
|
|
148
|
+
expect(yield* capability).toEqual(implementation);
|
|
149
|
+
}),
|
|
150
|
+
);
|
|
151
|
+
});
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { Atom, type Registry } from '@effect-atom/atom-react';
|
|
6
|
+
import * as Deferred from 'effect/Deferred';
|
|
7
|
+
import * as Effect from 'effect/Effect';
|
|
8
|
+
|
|
9
|
+
import { invariant } from '@dxos/invariant';
|
|
10
|
+
import { log } from '@dxos/log';
|
|
11
|
+
|
|
12
|
+
import type * as Capability from './capability';
|
|
13
|
+
|
|
14
|
+
type CapabilityEntry<T> = {
|
|
15
|
+
moduleId: string;
|
|
16
|
+
implementation: T;
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Options for creating a capability manager.
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
export type CapabilityManagerOptions = {
|
|
24
|
+
registry: Registry.Registry;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Interface for the Capability Manager.
|
|
29
|
+
* Provides methods for contributing, removing, and accessing capabilities.
|
|
30
|
+
*/
|
|
31
|
+
export interface CapabilityManager {
|
|
32
|
+
contribute<T>(args: { module: string; interface: Capability.InterfaceDef<T>; implementation: T }): void;
|
|
33
|
+
|
|
34
|
+
remove<T>(interfaceDef: Capability.InterfaceDef<T>, implementation: T): void;
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Get the Atom reference to the available capabilities for a given interface.
|
|
38
|
+
* Primarily useful for deriving other Atom values based on the capabilities or
|
|
39
|
+
* for subscribing to changes in the capabilities.
|
|
40
|
+
* @returns An atom reference to the available capabilities.
|
|
41
|
+
*/
|
|
42
|
+
atom<T>(interfaceDef: Capability.InterfaceDef<T>): Atom.Atom<T[]>;
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Get capabilities from the capability manager.
|
|
46
|
+
* @returns An array of capabilities.
|
|
47
|
+
*/
|
|
48
|
+
getAll<T>(interfaceDef: Capability.InterfaceDef<T>): T[];
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Requests a single capability from the capability manager.
|
|
52
|
+
* @returns The capability.
|
|
53
|
+
* @throws If no capability is found.
|
|
54
|
+
*/
|
|
55
|
+
get<T>(interfaceDef: Capability.InterfaceDef<T>): T;
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Waits for a capability to be available.
|
|
59
|
+
* @returns The capability.
|
|
60
|
+
*/
|
|
61
|
+
waitFor<T>(interfaceDef: Capability.InterfaceDef<T>): Effect.Effect<T, Error>;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Get capabilities grouped by the module that contributed them.
|
|
65
|
+
* @returns An atom containing a record from module ID to capability implementations.
|
|
66
|
+
*/
|
|
67
|
+
atomByModule<T>(interfaceDef: Capability.InterfaceDef<T>): Atom.Atom<Record<string, T[]>>;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Internal implementation of CapabilityManager.
|
|
72
|
+
*/
|
|
73
|
+
class CapabilityManagerImpl implements CapabilityManager {
|
|
74
|
+
private readonly _registry: Registry.Registry;
|
|
75
|
+
|
|
76
|
+
private readonly _capabilityEntries = Atom.family<string, Atom.Writable<CapabilityEntry<unknown>[]>>(() => {
|
|
77
|
+
return Atom.make<CapabilityEntry<unknown>[]>([]).pipe(Atom.keepAlive);
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
readonly _capabilities = Atom.family<string, Atom.Atom<unknown[]>>((id: string) => {
|
|
81
|
+
return Atom.make((get) => {
|
|
82
|
+
const current = get(this._capabilityEntries(id));
|
|
83
|
+
return current.map((c) => c.implementation);
|
|
84
|
+
}).pipe(Atom.keepAlive);
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
readonly _capabilitiesByModule = Atom.family<string, Atom.Atom<Record<string, unknown[]>>>((id: string) => {
|
|
88
|
+
return Atom.make((get) => {
|
|
89
|
+
const entries = get(this._capabilityEntries(id));
|
|
90
|
+
const result: Record<string, unknown[]> = {};
|
|
91
|
+
for (const entry of entries) {
|
|
92
|
+
(result[entry.moduleId] ??= []).push(entry.implementation);
|
|
93
|
+
}
|
|
94
|
+
return result;
|
|
95
|
+
}).pipe(Atom.keepAlive);
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
readonly _capability = Atom.family<string, Atom.Atom<unknown>>((id: string) => {
|
|
99
|
+
return Atom.make((get) => {
|
|
100
|
+
const current = get(this._capabilities(id));
|
|
101
|
+
invariant(current.length > 0, `No capability found for ${id}`);
|
|
102
|
+
return current[0];
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
constructor({ registry }: CapabilityManagerOptions) {
|
|
107
|
+
this._registry = registry;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
contribute<T>({
|
|
111
|
+
module: moduleId,
|
|
112
|
+
interface: interfaceDef,
|
|
113
|
+
implementation,
|
|
114
|
+
}: {
|
|
115
|
+
module: string;
|
|
116
|
+
interface: Capability.InterfaceDef<T>;
|
|
117
|
+
implementation: T;
|
|
118
|
+
}): void {
|
|
119
|
+
const current = this._registry.get(this._capabilityEntries(interfaceDef.identifier));
|
|
120
|
+
const isDuplicate = current.some((c) => c.moduleId === moduleId && c.implementation === implementation);
|
|
121
|
+
if (isDuplicate) {
|
|
122
|
+
log('capability already contributed, skipping', { id: interfaceDef.identifier, moduleId });
|
|
123
|
+
return;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
const entry: CapabilityEntry<T> = { moduleId, implementation };
|
|
127
|
+
this._registry.set(this._capabilityEntries(interfaceDef.identifier), [...current, entry]);
|
|
128
|
+
log('capability contributed', {
|
|
129
|
+
id: interfaceDef.identifier,
|
|
130
|
+
moduleId,
|
|
131
|
+
count: current.length,
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
remove<T>(interfaceDef: Capability.InterfaceDef<T>, implementation: T): void {
|
|
136
|
+
const current = this._registry.get(this._capabilityEntries(interfaceDef.identifier));
|
|
137
|
+
if (current.length === 0) {
|
|
138
|
+
return;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
const next = current.filter((c) => c.implementation !== implementation);
|
|
142
|
+
if (next.length !== current.length) {
|
|
143
|
+
this._registry.set(this._capabilityEntries(interfaceDef.identifier), next);
|
|
144
|
+
log('capability removed', { id: interfaceDef.identifier, count: current.length });
|
|
145
|
+
} else {
|
|
146
|
+
log.warn('capability not removed', { id: interfaceDef.identifier });
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
atom<T>(interfaceDef: Capability.InterfaceDef<T>): Atom.Atom<T[]> {
|
|
151
|
+
// NOTE: This the type-checking for capabilities is done at the time of contribution.
|
|
152
|
+
return this._capabilities(interfaceDef.identifier) as Atom.Atom<T[]>;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
getAll<T>(interfaceDef: Capability.InterfaceDef<T>): T[] {
|
|
156
|
+
return this._registry.get(this.atom(interfaceDef));
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
get<T>(interfaceDef: Capability.InterfaceDef<T>): T {
|
|
160
|
+
const capabilities = this.getAll(interfaceDef);
|
|
161
|
+
invariant(capabilities.length > 0, `No capability found for ${interfaceDef.identifier}`);
|
|
162
|
+
return capabilities[0];
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
waitFor<T>(interfaceDef: Capability.InterfaceDef<T>): Effect.Effect<T, Error> {
|
|
166
|
+
return Effect.gen(this, function* () {
|
|
167
|
+
const [capability] = this.getAll(interfaceDef);
|
|
168
|
+
if (capability) {
|
|
169
|
+
return capability;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
const deferred = yield* Deferred.make<T, Error>();
|
|
173
|
+
const cancel = this._registry.subscribe(this.atom(interfaceDef), (capabilities) => {
|
|
174
|
+
if (capabilities.length > 0) {
|
|
175
|
+
Effect.runSync(Deferred.succeed(deferred, capabilities[0]));
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
const result = yield* Deferred.await(deferred);
|
|
179
|
+
cancel();
|
|
180
|
+
return result;
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
atomByModule<T>(interfaceDef: Capability.InterfaceDef<T>): Atom.Atom<Record<string, T[]>> {
|
|
185
|
+
return this._capabilitiesByModule(interfaceDef.identifier) as Atom.Atom<Record<string, T[]>>;
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Creates a new Capability Manager instance.
|
|
191
|
+
*/
|
|
192
|
+
export const make = (options: CapabilityManagerOptions): CapabilityManager => new CapabilityManagerImpl(options);
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { type Atom } from '@effect-atom/atom-react';
|
|
6
|
+
import * as Context from 'effect/Context';
|
|
7
|
+
import * as Effect from 'effect/Effect';
|
|
8
|
+
|
|
9
|
+
import type * as CapabilityManager from './capability-manager';
|
|
10
|
+
import type * as Plugin from './plugin';
|
|
11
|
+
|
|
12
|
+
//
|
|
13
|
+
// Capability Service Layer
|
|
14
|
+
//
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Effect Context.Tag for accessing CapabilityManager via the Effect layer system.
|
|
18
|
+
* This allows capability modules to access the capability manager without having it passed as an argument.
|
|
19
|
+
*/
|
|
20
|
+
export class Service extends Context.Tag('@dxos/app-framework/CapabilityManager')<
|
|
21
|
+
Service,
|
|
22
|
+
CapabilityManager.CapabilityManager
|
|
23
|
+
>() {}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Get a single capability from the capability manager.
|
|
27
|
+
* @param interfaceDef The interface definition of the capability.
|
|
28
|
+
* @returns The capability implementation.
|
|
29
|
+
* @throws If no capability is found.
|
|
30
|
+
*/
|
|
31
|
+
// TODO(wittjosiah): Add custom tagged errors (Data.TaggedError) for app-framework to enable
|
|
32
|
+
// type-safe error handling with Effect. Consider CapabilityNotFoundError, ModuleActivationError, etc.
|
|
33
|
+
export const get = <T>(interfaceDef: InterfaceDef<T>): Effect.Effect<T, Error, Service> =>
|
|
34
|
+
Effect.flatMap(Service, (manager) =>
|
|
35
|
+
Effect.try({
|
|
36
|
+
try: () => manager.get(interfaceDef),
|
|
37
|
+
catch: (error) => (error instanceof Error ? error : new Error(String(error))),
|
|
38
|
+
}),
|
|
39
|
+
);
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Get all capabilities from the capability manager for a given interface.
|
|
43
|
+
* @param interfaceDef The interface definition of the capability.
|
|
44
|
+
* @returns An array of capability implementations.
|
|
45
|
+
*/
|
|
46
|
+
export const getAll = <T>(interfaceDef: InterfaceDef<T>): Effect.Effect<T[], never, Service> =>
|
|
47
|
+
Effect.map(Service, (manager) => manager.getAll(interfaceDef));
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Wait for a capability to be available.
|
|
51
|
+
* @param interfaceDef The interface definition of the capability.
|
|
52
|
+
* @returns The capability implementation once available.
|
|
53
|
+
*/
|
|
54
|
+
export const waitFor = <T>(interfaceDef: InterfaceDef<T>): Effect.Effect<T, Error, Service> =>
|
|
55
|
+
Effect.flatMap(Service, (manager) => manager.waitFor(interfaceDef));
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Get the Atom reference to capabilities for reactive access.
|
|
59
|
+
* @param interfaceDef The interface definition of the capability.
|
|
60
|
+
* @returns An Atom containing the array of capability implementations.
|
|
61
|
+
*/
|
|
62
|
+
export const atom = <T>(interfaceDef: InterfaceDef<T>): Effect.Effect<Atom.Atom<T[]>, never, Service> =>
|
|
63
|
+
Effect.map(Service, (manager) => manager.atom(interfaceDef));
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Get capabilities grouped by the module that contributed them.
|
|
67
|
+
* @param interfaceDef The interface definition of the capability.
|
|
68
|
+
* @returns An Atom containing a record from module ID to capability implementations.
|
|
69
|
+
*/
|
|
70
|
+
export const atomByModule = <T>(
|
|
71
|
+
interfaceDef: InterfaceDef<T>,
|
|
72
|
+
): Effect.Effect<Atom.Atom<Record<string, T[]>>, never, Service> =>
|
|
73
|
+
Effect.map(Service, (manager) => manager.atomByModule(interfaceDef));
|
|
74
|
+
|
|
75
|
+
const InterfaceDefTypeId: unique symbol = Symbol.for('InterfaceDefTypeId');
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Symbol used to tag lazy capability functions with their module ID.
|
|
79
|
+
*/
|
|
80
|
+
export const ModuleTag: unique symbol = Symbol.for('@dxos/app-framework/ModuleTag');
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* The interface definition of a capability.
|
|
84
|
+
*/
|
|
85
|
+
export type InterfaceDef<T> = {
|
|
86
|
+
[InterfaceDefTypeId]: T;
|
|
87
|
+
identifier: string;
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
export namespace InterfaceDef {
|
|
91
|
+
export type Implementation<I extends InterfaceDef<any>> = I extends InterfaceDef<infer T> ? T : never;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Helper to define the interface of a capability.
|
|
96
|
+
*/
|
|
97
|
+
export const make = <T>(identifier: string) => {
|
|
98
|
+
return { identifier } as InterfaceDef<T>;
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* A unique string identifier with a Typescript type associated with it.
|
|
103
|
+
* When a capability is contributed to the application an implementation of the interface is provided.
|
|
104
|
+
*/
|
|
105
|
+
export type Capability<T> = {
|
|
106
|
+
/**
|
|
107
|
+
* The interface definition of the capability.
|
|
108
|
+
*/
|
|
109
|
+
readonly interface: InterfaceDef<T>;
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* The implementation of the capability.
|
|
113
|
+
*/
|
|
114
|
+
readonly implementation: T;
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Called when the capability is deactivated.
|
|
118
|
+
*/
|
|
119
|
+
readonly deactivate?: () => Effect.Effect<void, Error>;
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
export type Any = Capability<any>;
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Union type representing all valid return types for a capability module.
|
|
126
|
+
* Supports single capabilities, arrays, and tuples of different capability types.
|
|
127
|
+
*/
|
|
128
|
+
export type ModuleReturn = void | Any | Any[] | readonly Any[] | [Any, ...Any[]] | readonly [Any, ...Any[]];
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Helper to define the implementation of a capability.
|
|
132
|
+
*/
|
|
133
|
+
// TODO(dmaretskyi): Make the return type non-generic so capabilities are non-discernable.
|
|
134
|
+
export const contributes = <I extends InterfaceDef<any>>(
|
|
135
|
+
interfaceDef: I,
|
|
136
|
+
implementation: Capability<InterfaceDef.Implementation<I>>['implementation'],
|
|
137
|
+
deactivate?: Capability<InterfaceDef.Implementation<I>>['deactivate'],
|
|
138
|
+
): Capability<I> => {
|
|
139
|
+
return {
|
|
140
|
+
interface: interfaceDef,
|
|
141
|
+
implementation,
|
|
142
|
+
deactivate,
|
|
143
|
+
} satisfies Capability<I>;
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
type LoadCapability<Props, Capabilities extends ModuleReturn = ModuleReturn> = () => Promise<{
|
|
147
|
+
default: (props: Props) => Effect.Effect<Capabilities, Error, Service | Plugin.Service | never>;
|
|
148
|
+
}>;
|
|
149
|
+
type LoadCapabilities<Props, Capabilities extends ModuleReturn = ModuleReturn> = () => Promise<{
|
|
150
|
+
default: (props: Props) => Effect.Effect<Capabilities, Error, Service | Plugin.Service | never>;
|
|
151
|
+
}>;
|
|
152
|
+
|
|
153
|
+
type NormalizeReturn<R> = R extends readonly (infer A)[]
|
|
154
|
+
? A[]
|
|
155
|
+
: R extends (infer A)[]
|
|
156
|
+
? A[]
|
|
157
|
+
: R extends Any
|
|
158
|
+
? [R]
|
|
159
|
+
: Any[];
|
|
160
|
+
|
|
161
|
+
export type LazyCapability<Props = void, Capabilities extends ModuleReturn = ModuleReturn, E extends Error = Error> = (
|
|
162
|
+
props: Props,
|
|
163
|
+
) => Effect.Effect<NormalizeReturn<Capabilities>, E, Service | Plugin.Service | never>;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* Helper to define a lazily loaded implementation of a capability.
|
|
167
|
+
* Supports single capabilities, arrays, and tuples of different capability types.
|
|
168
|
+
* @param name The export name (e.g., 'AppGraphBuilder') - used to auto-compute module IDs.
|
|
169
|
+
* @param loader The lazy loader function.
|
|
170
|
+
* @returns A lazy capability function with ModuleTag symbol attached.
|
|
171
|
+
*/
|
|
172
|
+
export const lazy = <T = void, R extends ModuleReturn = ModuleReturn>(
|
|
173
|
+
name: string,
|
|
174
|
+
c: LoadCapability<T, R> | LoadCapabilities<T, R>,
|
|
175
|
+
): LazyCapability<T, R> => {
|
|
176
|
+
const lazyFn: LazyCapability<T, R> = (props: T) =>
|
|
177
|
+
Effect.gen(function* () {
|
|
178
|
+
const { default: getCapability } = yield* Effect.promise(() => c());
|
|
179
|
+
const result = yield* getCapability(props);
|
|
180
|
+
const normalized = result == null ? [] : Array.isArray(result) ? Array.from(result) : [result];
|
|
181
|
+
return normalized as NormalizeReturn<R>;
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
return Object.assign(lazyFn, { [ModuleTag]: name });
|
|
185
|
+
};
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Gets the module tag (export name) from a lazy capability function.
|
|
189
|
+
* @param capability The lazy capability function.
|
|
190
|
+
* @returns The module tag if present, undefined otherwise.
|
|
191
|
+
*/
|
|
192
|
+
// TODO(wittjosiah): Stricter type for capability.
|
|
193
|
+
export const getModuleTag = (capability: unknown): string | undefined => {
|
|
194
|
+
return capability && typeof capability === 'function' && ModuleTag in capability
|
|
195
|
+
? String(capability[ModuleTag])
|
|
196
|
+
: undefined;
|
|
197
|
+
};
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Helper to define a capability module with explicit typing.
|
|
201
|
+
* Wraps the default export function to provide better type inference and make the pattern explicit.
|
|
202
|
+
*
|
|
203
|
+
* This helper provides explicit typing for the module activation function,
|
|
204
|
+
* making it clear that the function should:
|
|
205
|
+
* - Access CapabilityManager via the Effect layer system (Capability.get, Capability.getAll, etc.)
|
|
206
|
+
* - Return a capability, array of capabilities, or tuple of different capability types (sync or async)
|
|
207
|
+
*
|
|
208
|
+
* Supports returning multiple capabilities of different types as a tuple, which will be normalized
|
|
209
|
+
* to an array at runtime for compatibility with the plugin system.
|
|
210
|
+
*
|
|
211
|
+
* @example
|
|
212
|
+
* ```ts
|
|
213
|
+
* // Module without options - single capability
|
|
214
|
+
* export default Capability.makeModule(
|
|
215
|
+
* Effect.fnUntraced(function* () {
|
|
216
|
+
* const client = yield* Capability.get(ClientCapabilities.Client);
|
|
217
|
+
* return contributes(Capabilities.SettingsStore, store);
|
|
218
|
+
* })
|
|
219
|
+
* );
|
|
220
|
+
*
|
|
221
|
+
* // Module with multiple capabilities
|
|
222
|
+
* export default Capability.makeModule(
|
|
223
|
+
* Effect.fnUntraced(function* () {
|
|
224
|
+
* return [
|
|
225
|
+
* contributes(Capabilities.SettingsStore, store),
|
|
226
|
+
* contributes(Capabilities.Translations, translations),
|
|
227
|
+
* ];
|
|
228
|
+
* })
|
|
229
|
+
* );
|
|
230
|
+
*
|
|
231
|
+
* // Module with required options (context accessed via layer)
|
|
232
|
+
* export default Capability.makeModule(
|
|
233
|
+
* Effect.fnUntraced(function* (props: { observability: boolean }) {
|
|
234
|
+
* const invoker = yield* Capability.get(Capabilities.OperationInvoker);
|
|
235
|
+
* return contributes(Capabilities.OperationHandler, ...);
|
|
236
|
+
* })
|
|
237
|
+
* );
|
|
238
|
+
* ```
|
|
239
|
+
*/
|
|
240
|
+
export const makeModule = <
|
|
241
|
+
TProps = void,
|
|
242
|
+
TReturn extends ModuleReturn = ModuleReturn,
|
|
243
|
+
E extends Error = Error,
|
|
244
|
+
R extends Service | Plugin.Service | never = Service,
|
|
245
|
+
>(
|
|
246
|
+
fn: (props: TProps) => Effect.Effect<TReturn, E, R>,
|
|
247
|
+
): ((props: TProps) => Effect.Effect<TReturn, E, R>) => fn;
|
package/src/core/index.ts
CHANGED
|
@@ -2,7 +2,11 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
export * from './
|
|
6
|
-
export * from './
|
|
7
|
-
export * from './manager';
|
|
8
|
-
export * from './plugin';
|
|
5
|
+
export * as ActivationEvent from './activation-event';
|
|
6
|
+
export * as Capability from './capability';
|
|
7
|
+
export * as CapabilityManager from './capability-manager';
|
|
8
|
+
export * as Plugin from './plugin';
|
|
9
|
+
export * as PluginAssetCache from './plugin-asset-cache';
|
|
10
|
+
export * as PluginManager from './plugin-manager';
|
|
11
|
+
export * as PluginManifest from './plugin-manifest';
|
|
12
|
+
export * as UrlLoader from './url-loader';
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import * as Effect from 'effect/Effect';
|
|
6
|
+
|
|
7
|
+
import { BaseError } from '@dxos/errors';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Tagged error for cache operations. Construction sites supply `context.operation`
|
|
11
|
+
* (one of `'cache' | 'evict' | 'resolve' | 'list'`) and `context.pluginId` so
|
|
12
|
+
* downstream handlers can route on the failed call without scanning the message.
|
|
13
|
+
*/
|
|
14
|
+
export class PluginAssetCacheError extends BaseError.extend(
|
|
15
|
+
'PluginAssetCacheError',
|
|
16
|
+
'Plugin asset cache operation failed',
|
|
17
|
+
) {}
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Per-platform offline cache for third-party plugin assets.
|
|
21
|
+
*
|
|
22
|
+
* Implementations live alongside their platform glue (composer-app's
|
|
23
|
+
* `asset-cache/{tauri,service-worker}.ts`); the no-op default is for tests
|
|
24
|
+
* and unsupported environments.
|
|
25
|
+
*/
|
|
26
|
+
export interface Cache {
|
|
27
|
+
/**
|
|
28
|
+
* Persist all listed URLs under the namespace of `pluginId`. Idempotent.
|
|
29
|
+
* The order of `urls` is significant — the first entry is treated as the entry module.
|
|
30
|
+
*/
|
|
31
|
+
cache(pluginId: string, urls: readonly string[]): Effect.Effect<void, PluginAssetCacheError>;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Drop all assets for a plugin (uninstall).
|
|
35
|
+
*/
|
|
36
|
+
evict(pluginId: string): Effect.Effect<void, PluginAssetCacheError>;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Resolves a plugin asset URL to a platform-specific cached URL when one is available.
|
|
40
|
+
* Returns the original URL when no cached copy exists or the platform serves cached
|
|
41
|
+
* responses transparently (e.g. service worker fetch interception on web).
|
|
42
|
+
*/
|
|
43
|
+
resolve(pluginId: string, url: string): Effect.Effect<string, PluginAssetCacheError>;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* List currently cached plugin ids (diagnostic).
|
|
47
|
+
*/
|
|
48
|
+
list(): Effect.Effect<readonly string[], PluginAssetCacheError>;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* No-op implementation. Used when no platform cache is registered (tests, unsupported environments).
|
|
53
|
+
* Plugins still load — they just have no offline guarantee.
|
|
54
|
+
*/
|
|
55
|
+
export const noop = (): Cache => ({
|
|
56
|
+
cache: () => Effect.void,
|
|
57
|
+
evict: () => Effect.void,
|
|
58
|
+
resolve: (_pluginId, url) => Effect.succeed(url),
|
|
59
|
+
list: () => Effect.succeed([] as readonly string[]),
|
|
60
|
+
});
|