@dxos/app-framework 0.8.4-main.7ace549 → 0.8.4-main.937b3ca

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 (397) hide show
  1. package/.storybook/main.mts +1 -1
  2. package/.storybook/preview.mts +2 -2
  3. package/dist/lib/browser/app-graph-builder-M2VPYQC6.mjs +149 -0
  4. package/dist/lib/browser/app-graph-builder-M2VPYQC6.mjs.map +7 -0
  5. package/dist/lib/browser/capability-7PCNSWBT.mjs +33 -0
  6. package/dist/lib/browser/capability-7PCNSWBT.mjs.map +7 -0
  7. package/dist/lib/browser/capability-KP3PFEXD.mjs +31 -0
  8. package/dist/lib/browser/capability-KP3PFEXD.mjs.map +7 -0
  9. package/dist/lib/browser/chunk-6Y7PZV72.mjs +77 -0
  10. package/dist/lib/browser/chunk-6Y7PZV72.mjs.map +7 -0
  11. package/dist/lib/browser/chunk-7IQHKD4U.mjs +170 -0
  12. package/dist/lib/browser/chunk-7IQHKD4U.mjs.map +7 -0
  13. package/dist/lib/browser/chunk-BLQJSGL3.mjs +732 -0
  14. package/dist/lib/browser/chunk-BLQJSGL3.mjs.map +7 -0
  15. package/dist/lib/browser/chunk-FHQTHCX7.mjs +8 -0
  16. package/dist/lib/browser/chunk-FHQTHCX7.mjs.map +7 -0
  17. package/dist/lib/browser/chunk-FMZN33N4.mjs +807 -0
  18. package/dist/lib/browser/chunk-FMZN33N4.mjs.map +7 -0
  19. package/dist/lib/browser/chunk-H4WPA7U7.mjs +77 -0
  20. package/dist/lib/browser/chunk-H4WPA7U7.mjs.map +7 -0
  21. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  22. package/dist/lib/browser/chunk-PKQT6C53.mjs +47 -0
  23. package/dist/lib/browser/chunk-PKQT6C53.mjs.map +7 -0
  24. package/dist/lib/browser/chunk-TCLLRCS3.mjs +145 -0
  25. package/dist/lib/browser/chunk-TCLLRCS3.mjs.map +7 -0
  26. package/dist/lib/browser/chunk-XYNO72GQ.mjs +746 -0
  27. package/dist/lib/browser/chunk-XYNO72GQ.mjs.map +7 -0
  28. package/dist/lib/browser/common/index.mjs +38 -0
  29. package/dist/lib/browser/core/activation-event.mjs +20 -0
  30. package/dist/lib/browser/core/activation-event.mjs.map +7 -0
  31. package/dist/lib/browser/core/capability.mjs +28 -0
  32. package/dist/lib/browser/core/capability.mjs.map +7 -0
  33. package/dist/lib/browser/core/plugin-manager.mjs +15 -0
  34. package/dist/lib/browser/core/plugin-manager.mjs.map +7 -0
  35. package/dist/lib/browser/core/plugin.mjs +27 -0
  36. package/dist/lib/browser/core/plugin.mjs.map +7 -0
  37. package/dist/lib/browser/index.mjs +163 -101
  38. package/dist/lib/browser/index.mjs.map +4 -4
  39. package/dist/lib/browser/invoker-capability-SZRSTHEH.mjs +32 -0
  40. package/dist/lib/browser/invoker-capability-SZRSTHEH.mjs.map +7 -0
  41. package/dist/lib/browser/meta.json +1 -1
  42. package/dist/lib/browser/operation-resolver-6MP2MYOY.mjs +64 -0
  43. package/dist/lib/browser/operation-resolver-6MP2MYOY.mjs.map +7 -0
  44. package/dist/lib/browser/react/index.mjs +20 -8
  45. package/dist/lib/browser/testing/index.mjs +68 -22
  46. package/dist/lib/browser/testing/index.mjs.map +4 -4
  47. package/dist/lib/node-esm/app-graph-builder-LROHGJEM.mjs +150 -0
  48. package/dist/lib/node-esm/app-graph-builder-LROHGJEM.mjs.map +7 -0
  49. package/dist/lib/node-esm/capability-CFLQ2QQU.mjs +34 -0
  50. package/dist/lib/node-esm/capability-CFLQ2QQU.mjs.map +7 -0
  51. package/dist/lib/node-esm/capability-RCUNM2M7.mjs +32 -0
  52. package/dist/lib/node-esm/capability-RCUNM2M7.mjs.map +7 -0
  53. package/dist/lib/node-esm/chunk-663A54LQ.mjs +171 -0
  54. package/dist/lib/node-esm/chunk-663A54LQ.mjs.map +7 -0
  55. package/dist/lib/node-esm/chunk-6WXBT3EC.mjs +747 -0
  56. package/dist/lib/node-esm/chunk-6WXBT3EC.mjs.map +7 -0
  57. package/dist/lib/node-esm/chunk-7OWSHPYK.mjs +48 -0
  58. package/dist/lib/node-esm/chunk-7OWSHPYK.mjs.map +7 -0
  59. package/dist/lib/node-esm/chunk-GQEBIGKD.mjs +733 -0
  60. package/dist/lib/node-esm/chunk-GQEBIGKD.mjs.map +7 -0
  61. package/dist/lib/node-esm/chunk-GT6OKM5I.mjs +146 -0
  62. package/dist/lib/node-esm/chunk-GT6OKM5I.mjs.map +7 -0
  63. package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +11 -0
  64. package/dist/lib/node-esm/chunk-HSLMI22Q.mjs.map +7 -0
  65. package/dist/lib/node-esm/chunk-STMXUEPO.mjs +78 -0
  66. package/dist/lib/node-esm/chunk-STMXUEPO.mjs.map +7 -0
  67. package/dist/lib/node-esm/chunk-UEWJDI2L.mjs +10 -0
  68. package/dist/lib/node-esm/chunk-UEWJDI2L.mjs.map +7 -0
  69. package/dist/lib/node-esm/chunk-XR6NMKEP.mjs +78 -0
  70. package/dist/lib/node-esm/chunk-XR6NMKEP.mjs.map +7 -0
  71. package/dist/lib/node-esm/chunk-XYQTBFPA.mjs +808 -0
  72. package/dist/lib/node-esm/chunk-XYQTBFPA.mjs.map +7 -0
  73. package/dist/lib/node-esm/common/index.mjs +39 -0
  74. package/dist/lib/node-esm/common/index.mjs.map +7 -0
  75. package/dist/lib/node-esm/core/activation-event.mjs +21 -0
  76. package/dist/lib/node-esm/core/activation-event.mjs.map +7 -0
  77. package/dist/lib/node-esm/core/capability.mjs +29 -0
  78. package/dist/lib/node-esm/core/capability.mjs.map +7 -0
  79. package/dist/lib/node-esm/core/plugin-manager.mjs +16 -0
  80. package/dist/lib/node-esm/core/plugin-manager.mjs.map +7 -0
  81. package/dist/lib/node-esm/core/plugin.mjs +28 -0
  82. package/dist/lib/node-esm/core/plugin.mjs.map +7 -0
  83. package/dist/lib/node-esm/index.mjs +163 -101
  84. package/dist/lib/node-esm/index.mjs.map +4 -4
  85. package/dist/lib/node-esm/invoker-capability-PNMA5JOS.mjs +33 -0
  86. package/dist/lib/node-esm/invoker-capability-PNMA5JOS.mjs.map +7 -0
  87. package/dist/lib/node-esm/meta.json +1 -1
  88. package/dist/lib/node-esm/operation-resolver-7YWDMTNU.mjs +65 -0
  89. package/dist/lib/node-esm/operation-resolver-7YWDMTNU.mjs.map +7 -0
  90. package/dist/lib/node-esm/react/index.mjs +20 -8
  91. package/dist/lib/node-esm/testing/index.mjs +68 -22
  92. package/dist/lib/node-esm/testing/index.mjs.map +4 -4
  93. package/dist/types/src/cli.d.ts +39 -0
  94. package/dist/types/src/cli.d.ts.map +1 -0
  95. package/dist/types/src/common/activation-event.d.ts +66 -0
  96. package/dist/types/src/common/activation-event.d.ts.map +1 -0
  97. package/dist/types/src/common/capability.d.ts +265 -0
  98. package/dist/types/src/common/capability.d.ts.map +1 -0
  99. package/dist/types/src/common/collaboration.d.ts +23 -17
  100. package/dist/types/src/common/collaboration.d.ts.map +1 -1
  101. package/dist/types/src/common/graph.d.ts +2 -2
  102. package/dist/types/src/common/graph.d.ts.map +1 -1
  103. package/dist/types/src/common/index.d.ts +4 -3
  104. package/dist/types/src/common/index.d.ts.map +1 -1
  105. package/dist/types/src/common/operations.d.ts +380 -0
  106. package/dist/types/src/common/operations.d.ts.map +1 -0
  107. package/dist/types/src/common/plugin.d.ts +201 -0
  108. package/dist/types/src/common/plugin.d.ts.map +1 -0
  109. package/dist/types/src/common/surface.d.ts +35 -9
  110. package/dist/types/src/common/surface.d.ts.map +1 -1
  111. package/dist/types/src/common/translations.d.ts +9 -0
  112. package/dist/types/src/common/translations.d.ts.map +1 -1
  113. package/dist/types/src/context.d.ts +5 -0
  114. package/dist/types/src/context.d.ts.map +1 -0
  115. package/dist/types/src/core/{events.d.ts → activation-event.d.ts} +6 -6
  116. package/dist/types/src/core/activation-event.d.ts.map +1 -0
  117. package/dist/types/src/core/capability-manager.d.ts +43 -0
  118. package/dist/types/src/core/capability-manager.d.ts.map +1 -0
  119. package/dist/types/src/core/capability-manager.test.d.ts +2 -0
  120. package/dist/types/src/core/capability-manager.test.d.ts.map +1 -0
  121. package/dist/types/src/core/capability.d.ts +150 -0
  122. package/dist/types/src/core/capability.d.ts.map +1 -0
  123. package/dist/types/src/core/index.d.ts +5 -4
  124. package/dist/types/src/core/index.d.ts.map +1 -1
  125. package/dist/types/src/core/plugin-manager.d.ts +66 -0
  126. package/dist/types/src/core/plugin-manager.d.ts.map +1 -0
  127. package/dist/types/src/core/plugin-manager.test.d.ts +2 -0
  128. package/dist/types/src/core/plugin-manager.test.d.ts.map +1 -0
  129. package/dist/types/src/core/plugin.d.ts +92 -34
  130. package/dist/types/src/core/plugin.d.ts.map +1 -1
  131. package/dist/types/src/index.d.ts +5 -2
  132. package/dist/types/src/index.d.ts.map +1 -1
  133. package/dist/types/src/playground/debug/Debug.d.ts +4 -2
  134. package/dist/types/src/playground/debug/Debug.d.ts.map +1 -1
  135. package/dist/types/src/playground/debug/plugin.d.ts +2 -1
  136. package/dist/types/src/playground/debug/plugin.d.ts.map +1 -1
  137. package/dist/types/src/playground/generator/Main.d.ts +4 -2
  138. package/dist/types/src/playground/generator/Main.d.ts.map +1 -1
  139. package/dist/types/src/playground/generator/Toolbar.d.ts +4 -2
  140. package/dist/types/src/playground/generator/Toolbar.d.ts.map +1 -1
  141. package/dist/types/src/playground/generator/generator.d.ts +17 -5
  142. package/dist/types/src/playground/generator/generator.d.ts.map +1 -1
  143. package/dist/types/src/playground/generator/plugin.d.ts +2 -1
  144. package/dist/types/src/playground/generator/plugin.d.ts.map +1 -1
  145. package/dist/types/src/playground/layout/Layout.d.ts +4 -2
  146. package/dist/types/src/playground/layout/Layout.d.ts.map +1 -1
  147. package/dist/types/src/playground/layout/plugin.d.ts +2 -1
  148. package/dist/types/src/playground/layout/plugin.d.ts.map +1 -1
  149. package/dist/types/src/playground/logger/Toolbar.d.ts +4 -2
  150. package/dist/types/src/playground/logger/Toolbar.d.ts.map +1 -1
  151. package/dist/types/src/playground/logger/plugin.d.ts +2 -1
  152. package/dist/types/src/playground/logger/plugin.d.ts.map +1 -1
  153. package/dist/types/src/playground/logger/schema.d.ts +14 -0
  154. package/dist/types/src/playground/logger/schema.d.ts.map +1 -1
  155. package/dist/types/src/playground/playground.stories.d.ts.map +1 -1
  156. package/dist/types/src/plugin-operation/OperationPlugin.d.ts +3 -0
  157. package/dist/types/src/plugin-operation/OperationPlugin.d.ts.map +1 -0
  158. package/dist/types/src/plugin-operation/history/capability.d.ts +7 -0
  159. package/dist/types/src/plugin-operation/history/capability.d.ts.map +1 -0
  160. package/dist/types/src/plugin-operation/history/errors.d.ts +5 -0
  161. package/dist/types/src/plugin-operation/history/errors.d.ts.map +1 -0
  162. package/dist/types/src/plugin-operation/history/history-tracker.d.ts +18 -0
  163. package/dist/types/src/plugin-operation/history/history-tracker.d.ts.map +1 -0
  164. package/dist/types/src/plugin-operation/history/history-tracker.test.d.ts +2 -0
  165. package/dist/types/src/plugin-operation/history/history-tracker.test.d.ts.map +1 -0
  166. package/dist/types/src/plugin-operation/history/index.d.ts +6 -0
  167. package/dist/types/src/plugin-operation/history/index.d.ts.map +1 -0
  168. package/dist/types/src/plugin-operation/history/types.d.ts +13 -0
  169. package/dist/types/src/plugin-operation/history/types.d.ts.map +1 -0
  170. package/dist/types/src/plugin-operation/history/undo-mapping.d.ts +93 -0
  171. package/dist/types/src/plugin-operation/history/undo-mapping.d.ts.map +1 -0
  172. package/dist/types/src/plugin-operation/history/undo-registry.d.ts +23 -0
  173. package/dist/types/src/plugin-operation/history/undo-registry.d.ts.map +1 -0
  174. package/dist/types/src/plugin-operation/history/undo-registry.test.d.ts +2 -0
  175. package/dist/types/src/plugin-operation/history/undo-registry.test.d.ts.map +1 -0
  176. package/dist/types/src/plugin-operation/index.d.ts +3 -0
  177. package/dist/types/src/plugin-operation/index.d.ts.map +1 -0
  178. package/dist/types/src/plugin-operation/invoker-capability.d.ts +6 -0
  179. package/dist/types/src/plugin-operation/invoker-capability.d.ts.map +1 -0
  180. package/dist/types/src/plugin-operation/meta.d.ts +3 -0
  181. package/dist/types/src/plugin-operation/meta.d.ts.map +1 -0
  182. package/dist/types/src/plugin-operation/testing.d.ts +109 -0
  183. package/dist/types/src/plugin-operation/testing.d.ts.map +1 -0
  184. package/dist/types/src/plugin-runtime/RuntimePlugin.d.ts +3 -0
  185. package/dist/types/src/plugin-runtime/RuntimePlugin.d.ts.map +1 -0
  186. package/dist/types/src/plugin-runtime/capability.d.ts +6 -0
  187. package/dist/types/src/plugin-runtime/capability.d.ts.map +1 -0
  188. package/dist/types/src/plugin-runtime/index.d.ts +2 -0
  189. package/dist/types/src/plugin-runtime/index.d.ts.map +1 -0
  190. package/dist/types/src/plugin-runtime/meta.d.ts +3 -0
  191. package/dist/types/src/plugin-runtime/meta.d.ts.map +1 -0
  192. package/dist/types/src/plugin-settings/SettingsPlugin.d.ts +2 -1
  193. package/dist/types/src/plugin-settings/SettingsPlugin.d.ts.map +1 -1
  194. package/dist/types/src/plugin-settings/actions.d.ts +36 -0
  195. package/dist/types/src/plugin-settings/actions.d.ts.map +1 -1
  196. package/dist/types/src/plugin-settings/app-graph-builder.d.ts +4 -2
  197. package/dist/types/src/plugin-settings/app-graph-builder.d.ts.map +1 -1
  198. package/dist/types/src/plugin-settings/meta.d.ts +2 -2
  199. package/dist/types/src/plugin-settings/meta.d.ts.map +1 -1
  200. package/dist/types/src/plugin-settings/operation-resolver.d.ts +6 -0
  201. package/dist/types/src/plugin-settings/operation-resolver.d.ts.map +1 -0
  202. package/dist/types/src/react/App.d.ts +3 -5
  203. package/dist/types/src/react/App.d.ts.map +1 -1
  204. package/dist/types/src/react/App.stories.d.ts.map +1 -1
  205. package/dist/types/src/react/PluginManagerContext.stories.d.ts +13 -0
  206. package/dist/types/src/react/PluginManagerContext.stories.d.ts.map +1 -0
  207. package/dist/types/src/react/PluginManagerProvider.d.ts +2 -2
  208. package/dist/types/src/react/PluginManagerProvider.d.ts.map +1 -1
  209. package/dist/types/src/react/Surface.d.ts +6 -4
  210. package/dist/types/src/react/Surface.d.ts.map +1 -1
  211. package/dist/types/src/react/Surface.stories.d.ts.map +1 -1
  212. package/dist/types/src/react/SurfaceInfo.d.ts +11 -0
  213. package/dist/types/src/react/SurfaceInfo.d.ts.map +1 -0
  214. package/dist/types/src/react/common.d.ts +13 -12
  215. package/dist/types/src/react/common.d.ts.map +1 -1
  216. package/dist/types/src/react/index.d.ts +1 -1
  217. package/dist/types/src/react/index.d.ts.map +1 -1
  218. package/dist/types/src/react/types.d.ts +5 -7
  219. package/dist/types/src/react/types.d.ts.map +1 -1
  220. package/dist/types/src/react/useApp.d.ts +6 -5
  221. package/dist/types/src/react/useApp.d.ts.map +1 -1
  222. package/dist/types/src/react/useCapabilities.d.ts +16 -3
  223. package/dist/types/src/react/useCapabilities.d.ts.map +1 -1
  224. package/dist/types/src/react/useLoading.d.ts +1 -2
  225. package/dist/types/src/react/useLoading.d.ts.map +1 -1
  226. package/dist/types/src/react/useOperationResolver.d.ts +19 -0
  227. package/dist/types/src/react/useOperationResolver.d.ts.map +1 -0
  228. package/dist/types/src/testing/index.d.ts +1 -0
  229. package/dist/types/src/testing/index.d.ts.map +1 -1
  230. package/dist/types/src/testing/service.d.ts +8 -0
  231. package/dist/types/src/testing/service.d.ts.map +1 -0
  232. package/dist/types/src/testing/withPluginManager.d.ts +3 -3
  233. package/dist/types/src/testing/withPluginManager.d.ts.map +1 -1
  234. package/dist/types/tsconfig.tsbuildinfo +1 -1
  235. package/moon.yml +5 -1
  236. package/package.json +92 -39
  237. package/src/cli.ts +107 -0
  238. package/src/common/activation-event.ts +99 -0
  239. package/src/common/capability.ts +343 -0
  240. package/src/common/collaboration.ts +22 -9
  241. package/src/common/graph.ts +2 -2
  242. package/src/common/index.ts +4 -3
  243. package/src/common/operations.ts +412 -0
  244. package/src/common/plugin.ts +364 -0
  245. package/src/common/surface.ts +45 -13
  246. package/src/common/translations.ts +20 -0
  247. package/src/context.ts +9 -0
  248. package/src/core/{events.ts → activation-event.ts} +5 -5
  249. package/src/core/capability-manager.test.ts +151 -0
  250. package/src/core/capability-manager.ts +171 -0
  251. package/src/core/capability.ts +236 -0
  252. package/src/core/index.ts +5 -4
  253. package/src/core/plugin-manager.test.ts +845 -0
  254. package/src/core/plugin-manager.ts +696 -0
  255. package/src/core/plugin.ts +221 -39
  256. package/src/index.ts +5 -2
  257. package/src/playground/debug/Debug.tsx +26 -16
  258. package/src/playground/debug/plugin.ts +8 -8
  259. package/src/playground/generator/Main.tsx +20 -10
  260. package/src/playground/generator/Toolbar.tsx +26 -16
  261. package/src/playground/generator/generator.ts +27 -27
  262. package/src/playground/generator/plugin.ts +11 -12
  263. package/src/playground/layout/Layout.tsx +11 -7
  264. package/src/playground/layout/plugin.ts +8 -8
  265. package/src/playground/logger/Toolbar.tsx +19 -16
  266. package/src/playground/logger/plugin.ts +24 -23
  267. package/src/playground/logger/schema.ts +10 -0
  268. package/src/playground/playground.stories.tsx +13 -5
  269. package/src/plugin-operation/OperationPlugin.ts +25 -0
  270. package/src/plugin-operation/history/capability.ts +37 -0
  271. package/src/plugin-operation/history/errors.ts +11 -0
  272. package/src/plugin-operation/history/history-tracker.test.ts +380 -0
  273. package/src/plugin-operation/history/history-tracker.ts +129 -0
  274. package/src/plugin-operation/history/index.ts +9 -0
  275. package/src/plugin-operation/history/types.ts +17 -0
  276. package/src/plugin-operation/history/undo-mapping.ts +132 -0
  277. package/src/plugin-operation/history/undo-registry.test.ts +73 -0
  278. package/src/plugin-operation/history/undo-registry.ts +54 -0
  279. package/src/plugin-operation/index.ts +6 -0
  280. package/src/plugin-operation/invoker-capability.ts +40 -0
  281. package/src/plugin-operation/meta.ts +11 -0
  282. package/src/plugin-operation/testing.ts +174 -0
  283. package/src/plugin-runtime/RuntimePlugin.ts +20 -0
  284. package/src/plugin-runtime/capability.ts +53 -0
  285. package/src/plugin-runtime/index.ts +5 -0
  286. package/src/plugin-runtime/meta.ts +11 -0
  287. package/src/plugin-settings/SettingsPlugin.ts +11 -26
  288. package/src/plugin-settings/actions.ts +39 -0
  289. package/src/plugin-settings/app-graph-builder.ts +122 -142
  290. package/src/plugin-settings/meta.ts +2 -2
  291. package/src/plugin-settings/operation-resolver.ts +55 -0
  292. package/src/react/App.stories.tsx +30 -0
  293. package/src/react/App.tsx +10 -9
  294. package/src/react/PluginManagerContext.stories.tsx +184 -0
  295. package/src/react/PluginManagerProvider.ts +2 -2
  296. package/src/react/Surface.stories.tsx +33 -17
  297. package/src/react/Surface.tsx +199 -41
  298. package/src/react/SurfaceInfo.tsx +107 -0
  299. package/src/react/common.ts +29 -5
  300. package/src/react/index.ts +1 -1
  301. package/src/react/types.ts +9 -20
  302. package/src/react/useApp.tsx +99 -55
  303. package/src/react/useCapabilities.ts +37 -5
  304. package/src/react/useLoading.tsx +4 -6
  305. package/src/react/useOperationResolver.ts +40 -0
  306. package/src/testing/index.ts +1 -0
  307. package/src/testing/service.ts +52 -0
  308. package/src/testing/withPluginManager.stories.tsx +5 -5
  309. package/src/testing/withPluginManager.tsx +20 -22
  310. package/tsconfig.json +17 -8
  311. package/.swc/plugins/linux_x86_64_19.0.0/fce1bdb8e20a094e4af08bad09cc81497ed0e2e7c51223b07d371063cca18429.wasmer-v7 +0 -0
  312. package/dist/lib/browser/app-graph-builder-OIEZZC45.mjs +0 -138
  313. package/dist/lib/browser/app-graph-builder-OIEZZC45.mjs.map +0 -7
  314. package/dist/lib/browser/chunk-6XKO24JP.mjs +0 -483
  315. package/dist/lib/browser/chunk-6XKO24JP.mjs.map +0 -7
  316. package/dist/lib/browser/chunk-SCPE4ZO2.mjs +0 -35
  317. package/dist/lib/browser/chunk-SCPE4ZO2.mjs.map +0 -7
  318. package/dist/lib/browser/chunk-WPW5VVAX.mjs +0 -1651
  319. package/dist/lib/browser/chunk-WPW5VVAX.mjs.map +0 -7
  320. package/dist/lib/browser/intent-dispatcher-LZ4AE66E.mjs +0 -11
  321. package/dist/lib/browser/intent-resolver-QVCKRX6G.mjs +0 -39
  322. package/dist/lib/browser/intent-resolver-QVCKRX6G.mjs.map +0 -7
  323. package/dist/lib/browser/store-CNPHOYTJ.mjs +0 -30
  324. package/dist/lib/browser/store-CNPHOYTJ.mjs.map +0 -7
  325. package/dist/lib/node-esm/app-graph-builder-EBU4NVWD.mjs +0 -139
  326. package/dist/lib/node-esm/app-graph-builder-EBU4NVWD.mjs.map +0 -7
  327. package/dist/lib/node-esm/chunk-3UPX5OIS.mjs +0 -484
  328. package/dist/lib/node-esm/chunk-3UPX5OIS.mjs.map +0 -7
  329. package/dist/lib/node-esm/chunk-XJZGUJ3H.mjs +0 -1653
  330. package/dist/lib/node-esm/chunk-XJZGUJ3H.mjs.map +0 -7
  331. package/dist/lib/node-esm/chunk-ZX63QUGE.mjs +0 -37
  332. package/dist/lib/node-esm/chunk-ZX63QUGE.mjs.map +0 -7
  333. package/dist/lib/node-esm/intent-dispatcher-MGOJ3CHD.mjs +0 -12
  334. package/dist/lib/node-esm/intent-resolver-URF3HN3G.mjs +0 -40
  335. package/dist/lib/node-esm/intent-resolver-URF3HN3G.mjs.map +0 -7
  336. package/dist/lib/node-esm/store-RK5B4XEL.mjs +0 -31
  337. package/dist/lib/node-esm/store-RK5B4XEL.mjs.map +0 -7
  338. package/dist/types/src/common/capabilities.d.ts +0 -195
  339. package/dist/types/src/common/capabilities.d.ts.map +0 -1
  340. package/dist/types/src/common/events.d.ts +0 -52
  341. package/dist/types/src/common/events.d.ts.map +0 -1
  342. package/dist/types/src/common/layout.d.ts +0 -279
  343. package/dist/types/src/common/layout.d.ts.map +0 -1
  344. package/dist/types/src/core/capabilities.d.ts +0 -117
  345. package/dist/types/src/core/capabilities.d.ts.map +0 -1
  346. package/dist/types/src/core/capabilities.test.d.ts +0 -2
  347. package/dist/types/src/core/capabilities.test.d.ts.map +0 -1
  348. package/dist/types/src/core/events.d.ts.map +0 -1
  349. package/dist/types/src/core/manager.d.ts +0 -126
  350. package/dist/types/src/core/manager.d.ts.map +0 -1
  351. package/dist/types/src/core/manager.test.d.ts +0 -2
  352. package/dist/types/src/core/manager.test.d.ts.map +0 -1
  353. package/dist/types/src/plugin-intent/IntentPlugin.d.ts +0 -2
  354. package/dist/types/src/plugin-intent/IntentPlugin.d.ts.map +0 -1
  355. package/dist/types/src/plugin-intent/actions.d.ts +0 -36
  356. package/dist/types/src/plugin-intent/actions.d.ts.map +0 -1
  357. package/dist/types/src/plugin-intent/errors.d.ts +0 -16
  358. package/dist/types/src/plugin-intent/errors.d.ts.map +0 -1
  359. package/dist/types/src/plugin-intent/index.d.ts +0 -6
  360. package/dist/types/src/plugin-intent/index.d.ts.map +0 -1
  361. package/dist/types/src/plugin-intent/intent-dispatcher.d.ts +0 -139
  362. package/dist/types/src/plugin-intent/intent-dispatcher.d.ts.map +0 -1
  363. package/dist/types/src/plugin-intent/intent-dispatcher.test.d.ts +0 -2
  364. package/dist/types/src/plugin-intent/intent-dispatcher.test.d.ts.map +0 -1
  365. package/dist/types/src/plugin-intent/intent.d.ts +0 -63
  366. package/dist/types/src/plugin-intent/intent.d.ts.map +0 -1
  367. package/dist/types/src/plugin-intent/meta.d.ts +0 -3
  368. package/dist/types/src/plugin-intent/meta.d.ts.map +0 -1
  369. package/dist/types/src/plugin-settings/intent-resolver.d.ts +0 -4
  370. package/dist/types/src/plugin-settings/intent-resolver.d.ts.map +0 -1
  371. package/dist/types/src/plugin-settings/store.d.ts +0 -5
  372. package/dist/types/src/plugin-settings/store.d.ts.map +0 -1
  373. package/dist/types/src/react/IntentContext.d.ts +0 -8
  374. package/dist/types/src/react/IntentContext.d.ts.map +0 -1
  375. package/dist/types/src/react/useIntentResolver.d.ts +0 -3
  376. package/dist/types/src/react/useIntentResolver.d.ts.map +0 -1
  377. package/src/common/capabilities.ts +0 -214
  378. package/src/common/events.ts +0 -79
  379. package/src/common/layout.ts +0 -277
  380. package/src/core/capabilities.test.ts +0 -136
  381. package/src/core/capabilities.ts +0 -263
  382. package/src/core/manager.test.ts +0 -516
  383. package/src/core/manager.ts +0 -604
  384. package/src/plugin-intent/IntentPlugin.ts +0 -20
  385. package/src/plugin-intent/actions.ts +0 -31
  386. package/src/plugin-intent/errors.ts +0 -40
  387. package/src/plugin-intent/index.ts +0 -9
  388. package/src/plugin-intent/intent-dispatcher.test.ts +0 -286
  389. package/src/plugin-intent/intent-dispatcher.ts +0 -342
  390. package/src/plugin-intent/intent.ts +0 -154
  391. package/src/plugin-intent/meta.ts +0 -10
  392. package/src/plugin-settings/intent-resolver.ts +0 -35
  393. package/src/plugin-settings/store.ts +0 -33
  394. package/src/react/IntentContext.tsx +0 -35
  395. package/src/react/useIntentResolver.ts +0 -22
  396. /package/dist/lib/browser/{intent-dispatcher-LZ4AE66E.mjs.map → chunk-J5LGTIGS.mjs.map} +0 -0
  397. /package/dist/lib/{node-esm/intent-dispatcher-MGOJ3CHD.mjs.map → browser/common/index.mjs.map} +0 -0
@@ -0,0 +1,364 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import type * as Command$ from '@effect/cli/Command';
6
+ import * as Effect from 'effect/Effect';
7
+
8
+ import { type Type } from '@dxos/echo';
9
+
10
+ import { Capability as Capability$, Plugin as Plugin$ } from '../core';
11
+
12
+ import { ActivationEvent } from './activation-event';
13
+ import { Capability } from './capability';
14
+ import { type Resource } from './translations';
15
+
16
+ type PluginModuleOptions = Partial<
17
+ Pick<Plugin$.PluginModuleOptions, 'id' | 'activatesOn' | 'activatesBefore' | 'activatesAfter'>
18
+ > &
19
+ Pick<Plugin$.PluginModuleOptions, 'activate'>;
20
+
21
+ /**
22
+ * Helper functions for creating common plugin module patterns.
23
+ */
24
+ export namespace Plugin {
25
+ // TODO(wittjosiah): Restrict type to only allow operation handlers.
26
+ export type OperationResolverModuleOptions = PluginModuleOptions;
27
+
28
+ /**
29
+ * Creates a module that contributes operation handlers.
30
+ *
31
+ * @param options Module options including the activate function and optional configuration
32
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * Plugin.define(meta).pipe(
37
+ * Common.Plugin.addOperationResolverModule({
38
+ * activate: (context) =>
39
+ * Capability.contributes(Common.Capability.OperationResolver, [{
40
+ * operation: MyOperation,
41
+ * handler: (input) => Effect.succeed(...)
42
+ * }])
43
+ * })
44
+ * )
45
+ * ```
46
+ */
47
+ export function addOperationResolverModule<T = void>(
48
+ options: OperationResolverModuleOptions,
49
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
50
+ return Plugin$.addModule({
51
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'operation-resolver',
52
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupOperationResolver,
53
+ activatesBefore: options.activatesBefore,
54
+ activatesAfter: options.activatesAfter,
55
+ activate: options.activate,
56
+ });
57
+ }
58
+
59
+ // TODO(wittjosiah): Restrict type to only allow surfaces.
60
+ export type SurfaceModuleOptions = PluginModuleOptions;
61
+
62
+ /**
63
+ * Creates a module that contributes React surfaces.
64
+ *
65
+ * @param options Module options including the activate function and optional configuration
66
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * Plugin.define(meta).pipe(
71
+ * Common.Plugin.addSurfaceModule({
72
+ * activate: (context) =>
73
+ * Capability.contributes(Common.Capability.ReactSurface, [
74
+ * Common.createSurface({ id: `${meta.id}/my-surface`, ... })
75
+ * ])
76
+ * })
77
+ * )
78
+ * ```
79
+ */
80
+ export function addSurfaceModule<T = void>(
81
+ options: SurfaceModuleOptions,
82
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
83
+ return Plugin$.addModule({
84
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'surfaces',
85
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupReactSurface,
86
+ activatesBefore: options.activatesBefore,
87
+ activatesAfter: options.activatesAfter,
88
+ activate: options.activate,
89
+ });
90
+ }
91
+
92
+ // TODO(wittjosiah): Restrict type to only allow react roots.
93
+ export type ReactRootModuleOptions = PluginModuleOptions;
94
+
95
+ /**
96
+ * Creates a module that contributes a React root.
97
+ */
98
+ export function addReactRootModule<T = void>(
99
+ options: ReactRootModuleOptions,
100
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
101
+ return Plugin$.addModule({
102
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'react-root',
103
+ activatesOn: options.activatesOn ?? ActivationEvent.Startup,
104
+ activatesBefore: options.activatesBefore,
105
+ activatesAfter: options.activatesAfter,
106
+ activate: options.activate,
107
+ });
108
+ }
109
+
110
+ // TODO(wittjosiah): Restrict type to only allow react contexts.
111
+ export type ReactContextModuleOptions = PluginModuleOptions;
112
+
113
+ /**
114
+ * Creates a module that contributes a React context.
115
+ */
116
+ export function addReactContextModule<T = void>(
117
+ options: ReactContextModuleOptions,
118
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
119
+ return Plugin$.addModule({
120
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'react-context',
121
+ activatesOn: options.activatesOn ?? ActivationEvent.Startup,
122
+ activatesBefore: options.activatesBefore,
123
+ activatesAfter: options.activatesAfter,
124
+ activate: options.activate,
125
+ });
126
+ }
127
+
128
+ // TODO(wittjosiah): Restrict type to only allow app graph builders.
129
+ export type AppGraphModuleOptions = PluginModuleOptions;
130
+
131
+ /**
132
+ * Creates a module that contributes app graph builder extensions.
133
+ *
134
+ * @param options Module options including the activate function and optional configuration
135
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
136
+ *
137
+ * @example
138
+ * ```ts
139
+ * Plugin.define(meta).pipe(
140
+ * Common.Plugin.addAppGraphModule({
141
+ * activate: Effect.fnUntraced(function* () {
142
+ * const extensions = yield* GraphBuilder.createExtension({
143
+ * id: meta.id,
144
+ * match: NodeMatcher.whenRoot,
145
+ * // All callbacks must return Effects.
146
+ * actions: () => Effect.succeed([{
147
+ * id: 'my-action',
148
+ * // Action data returns Effect for automatic context access.
149
+ * data: Effect.fnUntraced(function* () {
150
+ * yield* Operation.invoke(MyOperation, { ... });
151
+ * }),
152
+ * properties: { label: 'My Action', icon: 'ph--icon' },
153
+ * }]),
154
+ * connector: (node, get) => Effect.succeed([{ id: 'child', ... }]),
155
+ * });
156
+ * return Capability.contributes(Common.Capability.AppGraphBuilder, extensions);
157
+ * })
158
+ * })
159
+ * )
160
+ * ```
161
+ */
162
+ export function addAppGraphModule<T = void>(
163
+ options: AppGraphModuleOptions,
164
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
165
+ return Plugin$.addModule({
166
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'app-graph-builder',
167
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupAppGraph,
168
+ activatesBefore: options.activatesBefore,
169
+ activatesAfter: options.activatesAfter,
170
+ activate: options.activate,
171
+ });
172
+ }
173
+
174
+ export type TranslationsModuleOptions = Omit<PluginModuleOptions, 'activate'> & {
175
+ translations: Resource | Resource[];
176
+ };
177
+
178
+ /**
179
+ * Creates a module that contributes translations.
180
+ *
181
+ * @param options Module options including translations and optional configuration
182
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
183
+ *
184
+ * @example
185
+ * ```ts
186
+ * Plugin.define(meta).pipe(
187
+ * Common.Plugin.addTranslationsModule({
188
+ * translations: translations
189
+ * })
190
+ * )
191
+ * ```
192
+ */
193
+ export function addTranslationsModule<T = void>(
194
+ options: TranslationsModuleOptions,
195
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
196
+ return Plugin$.addModule({
197
+ id: options?.id ?? 'translations',
198
+ activatesOn: options?.activatesOn ?? ActivationEvent.SetupTranslations,
199
+ activatesBefore: options?.activatesBefore,
200
+ activatesAfter: options?.activatesAfter,
201
+ activate: Effect.fnUntraced(function* () {
202
+ return Capability$.contributes(
203
+ Capability.Translations,
204
+ Array.isArray(options.translations) ? options.translations : ([options.translations] as Resource[]),
205
+ );
206
+ }),
207
+ });
208
+ }
209
+
210
+ export type MetadataModuleOptions = Omit<PluginModuleOptions, 'activate'> & {
211
+ metadata: Capability.Metadata | Capability.Metadata[];
212
+ };
213
+
214
+ /**
215
+ * Creates a module that contributes metadata.
216
+ *
217
+ * @param options Module options including metadata and optional configuration
218
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
219
+ *
220
+ * @example
221
+ * ```ts
222
+ * Plugin.define(meta).pipe(
223
+ * Common.Plugin.addMetadataModule({
224
+ * metadata: {
225
+ * id: MyType.typename,
226
+ * metadata: { icon: 'ph--icon', ... }
227
+ * }
228
+ * })
229
+ * )
230
+ * ```
231
+ */
232
+ export function addMetadataModule<T = void>(
233
+ options: MetadataModuleOptions,
234
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
235
+ return Plugin$.addModule({
236
+ id: options.id ?? 'metadata',
237
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupMetadata,
238
+ activatesBefore: options.activatesBefore,
239
+ activatesAfter: options.activatesAfter,
240
+ activate: Effect.fnUntraced(function* () {
241
+ return (Array.isArray(options.metadata) ? options.metadata : [options.metadata]).map((m) =>
242
+ Capability$.contributes(Capability.Metadata, m),
243
+ );
244
+ }),
245
+ });
246
+ }
247
+
248
+ // TODO(wittjosiah): Restrict type to only allow settings.
249
+ export type SettingsModuleOptions = PluginModuleOptions;
250
+
251
+ /**
252
+ * Creates a module that contributes settings.
253
+ */
254
+ export function addSettingsModule<T = void>(
255
+ options: SettingsModuleOptions,
256
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
257
+ return Plugin$.addModule({
258
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'settings',
259
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupSettings,
260
+ activatesBefore: options.activatesBefore,
261
+ activatesAfter: options.activatesAfter,
262
+ activate: options.activate,
263
+ });
264
+ }
265
+
266
+ // TODO(wittjosiah): Restrict type to only allow blueprint definitions.
267
+ export type BlueprintDefinitionModuleOptions = PluginModuleOptions;
268
+
269
+ /**
270
+ * Creates a module that contributes blueprint definitions.
271
+ *
272
+ * @param options Module options including the activate function and optional configuration
273
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
274
+ *
275
+ * @example
276
+ * ```ts
277
+ * Plugin.define(meta).pipe(
278
+ * Common.Plugin.addBlueprintDefinitionModule({
279
+ * activate: (context) =>
280
+ * Capability.contributes(Common.Capability.BlueprintDefinition, [
281
+ * BlueprintDefinition.make({ key: 'my-blueprint', ... })
282
+ * ])
283
+ * })
284
+ * )
285
+ * ```
286
+ */
287
+ export function addBlueprintDefinitionModule<T = void>(
288
+ options: BlueprintDefinitionModuleOptions,
289
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
290
+ return Plugin$.addModule({
291
+ id: Capability$.getModuleTag(options.activate) ?? options.id ?? 'blueprint-definition',
292
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupArtifactDefinition,
293
+ activatesBefore: options.activatesBefore,
294
+ activatesAfter: options.activatesAfter,
295
+ activate: options.activate,
296
+ });
297
+ }
298
+
299
+ export type SchemaModuleOptions = Omit<PluginModuleOptions, 'activate'> & {
300
+ schema: ReadonlyArray<Type.Entity.Any>;
301
+ };
302
+
303
+ /**
304
+ * Creates a module that contributes schemas.
305
+ *
306
+ * @param options Module options including schema array and optional configuration
307
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
308
+ *
309
+ * @example
310
+ * ```ts
311
+ * Plugin.define(meta).pipe(
312
+ * Common.Plugin.addSchemaModule({
313
+ * schema: [MyType.Type, AnotherType.Type]
314
+ * })
315
+ * )
316
+ * ```
317
+ */
318
+ export function addSchemaModule<T = void>(
319
+ options: SchemaModuleOptions,
320
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
321
+ return Plugin$.addModule({
322
+ id: options.id ?? 'schema',
323
+ activatesOn: options.activatesOn ?? ActivationEvent.SetupSchema,
324
+ activatesBefore: options.activatesBefore,
325
+ activatesAfter: options.activatesAfter,
326
+ activate: Effect.fnUntraced(function* () {
327
+ return Capability$.contributes(Capability.Schema, options.schema);
328
+ }),
329
+ });
330
+ }
331
+
332
+ export type CommandModuleOptions = Omit<PluginModuleOptions, 'activate'> & {
333
+ commands: ReadonlyArray<Command$.Command<any, any, any, any>>;
334
+ };
335
+
336
+ /**
337
+ * Creates a module that contributes CLI commands.
338
+ *
339
+ * @param options Module options including commands and optional configuration
340
+ * @returns A function that can be used with Plugin.addModule() in a pipe chain
341
+ *
342
+ * @example
343
+ * ```ts
344
+ * Plugin.define(meta).pipe(
345
+ * Common.Plugin.addCommandModule({
346
+ * commands: [myCommand, anotherCommand]
347
+ * })
348
+ * )
349
+ * ```
350
+ */
351
+ export function addCommandModule<T = void>(
352
+ options: CommandModuleOptions,
353
+ ): (builder: Plugin$.PluginBuilder<T>) => Plugin$.PluginBuilder<T> {
354
+ return Plugin$.addModule({
355
+ id: options.id ?? 'cli-commands',
356
+ activatesOn: options.activatesOn ?? ActivationEvent.Startup,
357
+ activatesBefore: options.activatesBefore,
358
+ activatesAfter: options.activatesAfter,
359
+ activate: Effect.fnUntraced(function* () {
360
+ return options.commands.map((cmd) => Capability$.contributes(Capability.Command, cmd));
361
+ }),
362
+ });
363
+ }
364
+ }
@@ -2,11 +2,11 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import type { ComponentType, PropsWithChildren, ReactNode } from 'react';
5
+ import type { PropsWithChildren, ReactNode, RefCallback } from 'react';
6
6
 
7
- import { type MakeOptional, type Position } from '@dxos/util';
7
+ import type { MakeOptional, Position } from '@dxos/util';
8
8
 
9
- import { type ErrorBoundary } from '../react';
9
+ import type { ErrorBoundary } from '../react';
10
10
 
11
11
  /**
12
12
  * SurfaceProps are the props that are passed to the Surface component.
@@ -59,20 +59,22 @@ export type CoreSurfaceProps<T extends Record<string, any> = Record<string, unkn
59
59
  limit?: number | undefined;
60
60
  }>;
61
61
 
62
- export type SurfaceComponentProps<T extends Record<string, any> = Record<string, any>> = CoreSurfaceProps<T> &
63
- Record<string, any>;
62
+ export type SurfaceComponentProps<T extends Record<string, any> = Record<string, any>> = CoreSurfaceProps<T> & {
63
+ ref?: RefCallback<HTMLElement>;
64
+ } & Record<string, any>;
64
65
 
65
66
  /**
66
67
  * React component used to render a surface once is has matched.
67
68
  */
68
- export type SurfaceComponent<T extends Record<string, any> = Record<string, any>> = ComponentType<
69
- SurfaceComponentProps<T>
70
- >;
69
+ export type SurfaceComponent<T extends Record<string, any> = Record<string, any>> = (
70
+ props: SurfaceComponentProps<T>,
71
+ ) => ReactNode;
71
72
 
72
73
  /**
73
- * Definition of when a SurfaceComponent should be rendered.
74
+ * Definition of when a React SurfaceComponent should be rendered.
74
75
  */
75
- export type SurfaceDefinition<T extends Record<string, any> = any> = Readonly<{
76
+ export type ReactSurfaceDefinition<T extends Record<string, any> = any> = Readonly<{
77
+ kind: 'react';
76
78
  id: string;
77
79
  role: string | string[];
78
80
  position?: Position;
@@ -81,8 +83,38 @@ export type SurfaceDefinition<T extends Record<string, any> = any> = Readonly<{
81
83
  }>;
82
84
 
83
85
  /**
84
- * Creates a surface definition.
86
+ * Definition of when a Web Component surface should be rendered.
87
+ */
88
+ export type WebComponentSurfaceDefinition<T extends Record<string, any> = any> = Readonly<{
89
+ kind: 'web-component';
90
+ id: string;
91
+ role: string | string[];
92
+ position?: Position;
93
+ /**
94
+ * The tag name of the Web Component to render.
95
+ * The Web Component will receive the same props as React surfaces via properties/attributes.
96
+ */
97
+ tagName: string;
98
+ filter?: (data: Record<string, unknown>) => data is T;
99
+ }>;
100
+
101
+ /**
102
+ * Definition of when a surface (React or Web Component) should be rendered.
103
+ */
104
+ export type SurfaceDefinition<T extends Record<string, any> = any> =
105
+ | ReactSurfaceDefinition<T>
106
+ | WebComponentSurfaceDefinition<T>;
107
+
108
+ /**
109
+ * Creates a React surface definition.
85
110
  */
86
111
  export const createSurface = <T extends Record<string, any> = any>(
87
- definition: SurfaceDefinition<T>,
88
- ): SurfaceDefinition<T> => definition;
112
+ definition: Omit<ReactSurfaceDefinition<T>, 'kind'>,
113
+ ): ReactSurfaceDefinition<T> => ({ ...definition, kind: 'react' });
114
+
115
+ /**
116
+ * Creates a Web Component surface definition.
117
+ */
118
+ export const createWebSurface = <T extends Record<string, any> = any>(
119
+ definition: Omit<WebComponentSurfaceDefinition<T>, 'kind'>,
120
+ ): WebComponentSurfaceDefinition<T> => ({ ...definition, kind: 'web-component' });
@@ -4,6 +4,26 @@
4
4
 
5
5
  import * as Schema from 'effect/Schema';
6
6
 
7
+ /**
8
+ * A Label represents translatable text - either a simple string or a tuple of [key, options].
9
+ */
10
+ export const Label = Schema.Union(
11
+ Schema.String,
12
+ Schema.mutable(
13
+ Schema.Tuple(
14
+ Schema.String,
15
+ Schema.mutable(
16
+ Schema.Struct({
17
+ ns: Schema.String,
18
+ count: Schema.optional(Schema.Number),
19
+ defaultValue: Schema.optional(Schema.String),
20
+ }),
21
+ ),
22
+ ),
23
+ ),
24
+ );
25
+ export type Label = Schema.Schema.Type<typeof Label>;
26
+
7
27
  export const ResourceKey = Schema.Union(Schema.String, Schema.Record({ key: Schema.String, value: Schema.Any }));
8
28
  export type ResourceKey = Schema.Schema.Type<typeof ResourceKey>;
9
29
 
package/src/context.ts ADDED
@@ -0,0 +1,9 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { createContext } from '@dxos/web-context';
6
+
7
+ import { type PluginManager } from './core';
8
+
9
+ export const PluginManagerContext = createContext<PluginManager.PluginManager>('dxos.org/app-framework/plugin-manager');
@@ -16,7 +16,7 @@ export type ActivationEvent = {
16
16
  /**
17
17
  * An activation event that can be a single event, or a combination of events.
18
18
  */
19
- export type ActivationEvents =
19
+ export type Events =
20
20
  | ActivationEvent
21
21
  | { type: 'one-of'; events: ActivationEvent[] }
22
22
  | { type: 'all-of'; events: ActivationEvent[] };
@@ -24,7 +24,7 @@ export type ActivationEvents =
24
24
  /**
25
25
  * Helper to define an activation event.
26
26
  */
27
- export const defineEvent = (id: string, specifier?: string) => {
27
+ export const make = (id: string, specifier?: string) => {
28
28
  return { id, specifier } as ActivationEvent;
29
29
  };
30
30
 
@@ -46,16 +46,16 @@ export const allOf = (...events: ActivationEvent[]) => ({ type: 'all-of' as cons
46
46
  /**
47
47
  * Helper to check if an activation event is a one-of event.
48
48
  */
49
- export const isOneOf = (events: ActivationEvents): events is { type: 'one-of'; events: ActivationEvent[] } =>
49
+ export const isOneOf = (events: Events): events is { type: 'one-of'; events: ActivationEvent[] } =>
50
50
  'type' in events && events.type === 'one-of';
51
51
 
52
52
  /**
53
53
  * Helper to check if an activation event is an all-of event.
54
54
  */
55
- export const isAllOf = (events: ActivationEvents): events is { type: 'all-of'; events: ActivationEvent[] } =>
55
+ export const isAllOf = (events: Events): events is { type: 'all-of'; events: ActivationEvent[] } =>
56
56
  'type' in events && events.type === 'all-of';
57
57
 
58
58
  /**
59
59
  * Helper to get the events from an activation event.
60
60
  */
61
- export const getEvents = (events: ActivationEvents) => ('type' in events ? events.events : [events]);
61
+ export const getEvents = (events: Events) => ('type' in events ? events.events : [events]);
@@ -0,0 +1,151 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { describe, expect, it, onTestFinished } from '@effect/vitest';
6
+ import { Registry } from '@effect-atom/atom-react';
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
+ });