@dxos/plugin-observability 0.8.4-main.1068cf700f → 0.8.4-main.1c7ec43d41

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 (236) hide show
  1. package/dist/lib/browser/ObservabilitySettings-H6UKYDDT.mjs +27 -0
  2. package/dist/lib/browser/ObservabilitySettings-H6UKYDDT.mjs.map +7 -0
  3. package/dist/lib/browser/capture-user-feedback-NZ7EVG32.mjs +24 -0
  4. package/dist/lib/browser/capture-user-feedback-NZ7EVG32.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-DLBA63VM.mjs +83 -0
  6. package/dist/lib/browser/chunk-DLBA63VM.mjs.map +7 -0
  7. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  8. package/dist/lib/browser/chunk-J5LGTIGS.mjs.map +7 -0
  9. package/dist/lib/browser/chunk-LHGNFXDI.mjs +32 -0
  10. package/dist/lib/browser/chunk-LHGNFXDI.mjs.map +7 -0
  11. package/dist/lib/browser/chunk-QKJBQMIH.mjs +53 -0
  12. package/dist/lib/browser/chunk-QKJBQMIH.mjs.map +7 -0
  13. package/dist/lib/browser/components/index.mjs +45 -0
  14. package/dist/lib/browser/components/index.mjs.map +7 -0
  15. package/dist/lib/browser/index.mjs +27 -89
  16. package/dist/lib/browser/index.mjs.map +4 -4
  17. package/dist/lib/browser/meta.json +1 -1
  18. package/dist/lib/browser/operations/index.mjs +15 -0
  19. package/dist/lib/browser/operations/index.mjs.map +7 -0
  20. package/dist/lib/browser/send-event-FR24EMHF.mjs +22 -0
  21. package/dist/lib/browser/send-event-FR24EMHF.mjs.map +7 -0
  22. package/dist/lib/browser/toggle-7TDDJHZD.mjs +47 -0
  23. package/dist/lib/browser/toggle-7TDDJHZD.mjs.map +7 -0
  24. package/dist/lib/browser/translations.mjs +8 -0
  25. package/dist/lib/browser/translations.mjs.map +7 -0
  26. package/dist/lib/browser/types/index.mjs +4 -6
  27. package/dist/lib/node-esm/ObservabilitySettings-HXTWPHHR.mjs +28 -0
  28. package/dist/lib/node-esm/ObservabilitySettings-HXTWPHHR.mjs.map +7 -0
  29. package/dist/lib/node-esm/capture-user-feedback-5PTJL2ZD.mjs +25 -0
  30. package/dist/lib/node-esm/capture-user-feedback-5PTJL2ZD.mjs.map +7 -0
  31. package/dist/lib/node-esm/chunk-3B7HMSKM.mjs +84 -0
  32. package/dist/lib/node-esm/chunk-3B7HMSKM.mjs.map +7 -0
  33. package/dist/lib/node-esm/chunk-GOLFQ5RF.mjs +54 -0
  34. package/dist/lib/node-esm/chunk-GOLFQ5RF.mjs.map +7 -0
  35. package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +11 -0
  36. package/dist/lib/node-esm/chunk-HSLMI22Q.mjs.map +7 -0
  37. package/dist/lib/node-esm/chunk-J4EHZPH2.mjs +34 -0
  38. package/dist/lib/node-esm/chunk-J4EHZPH2.mjs.map +7 -0
  39. package/dist/lib/node-esm/components/index.mjs +46 -0
  40. package/dist/lib/node-esm/components/index.mjs.map +7 -0
  41. package/dist/lib/node-esm/index.mjs +27 -89
  42. package/dist/lib/node-esm/index.mjs.map +4 -4
  43. package/dist/lib/node-esm/meta.json +1 -1
  44. package/dist/lib/node-esm/operations/index.mjs +16 -0
  45. package/dist/lib/node-esm/operations/index.mjs.map +7 -0
  46. package/dist/lib/node-esm/send-event-JFFIX3IE.mjs +23 -0
  47. package/dist/lib/node-esm/send-event-JFFIX3IE.mjs.map +7 -0
  48. package/dist/lib/node-esm/toggle-45CNEDDK.mjs +48 -0
  49. package/dist/lib/node-esm/toggle-45CNEDDK.mjs.map +7 -0
  50. package/dist/lib/node-esm/translations.mjs +9 -0
  51. package/dist/lib/node-esm/translations.mjs.map +7 -0
  52. package/dist/lib/node-esm/types/index.mjs +4 -6
  53. package/dist/types/src/ObservabilityPlugin.d.ts +6 -0
  54. package/dist/types/src/ObservabilityPlugin.d.ts.map +1 -1
  55. package/dist/types/src/{cli/plugin.d.ts → ObservabilityPlugin.node.d.ts} +2 -1
  56. package/dist/types/src/ObservabilityPlugin.node.d.ts.map +1 -0
  57. package/dist/types/src/ObservabilityPlugin.test.d.ts +2 -0
  58. package/dist/types/src/ObservabilityPlugin.test.d.ts.map +1 -0
  59. package/dist/types/src/capabilities/app-graph-builder.d.ts +6 -0
  60. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -0
  61. package/dist/types/src/capabilities/{client-ready/client-ready.d.ts → client-ready.d.ts} +1 -1
  62. package/dist/types/src/capabilities/client-ready.d.ts.map +1 -0
  63. package/dist/types/src/capabilities/index.d.ts +17 -6
  64. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  65. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  66. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  67. package/dist/types/src/capabilities/react-surface.d.ts +5 -0
  68. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -0
  69. package/dist/types/src/capabilities/settings.d.ts +7 -0
  70. package/dist/types/src/capabilities/settings.d.ts.map +1 -0
  71. package/dist/types/src/capabilities/{state/state.d.ts → state.d.ts} +2 -2
  72. package/dist/types/src/capabilities/state.d.ts.map +1 -0
  73. package/dist/types/src/components/FeedbackForm/FeedbackForm.d.ts +9 -0
  74. package/dist/types/src/components/FeedbackForm/FeedbackForm.d.ts.map +1 -0
  75. package/dist/types/src/components/FeedbackForm/FeedbackForm.stories.d.ts +36 -0
  76. package/dist/types/src/components/FeedbackForm/FeedbackForm.stories.d.ts.map +1 -0
  77. package/dist/types/src/components/FeedbackForm/index.d.ts +2 -0
  78. package/dist/types/src/components/FeedbackForm/index.d.ts.map +1 -0
  79. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.d.ts +6 -0
  80. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.d.ts.map +1 -0
  81. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.stories.d.ts +36 -0
  82. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.stories.d.ts.map +1 -0
  83. package/dist/types/src/components/ObservabilitySettings/index.d.ts +2 -0
  84. package/dist/types/src/components/ObservabilitySettings/index.d.ts.map +1 -0
  85. package/dist/types/src/components/index.d.ts +2 -2
  86. package/dist/types/src/components/index.d.ts.map +1 -1
  87. package/dist/types/src/containers/HelpContainer/HelpContainer.d.ts.map +1 -0
  88. package/dist/types/src/containers/HelpContainer/index.d.ts +2 -0
  89. package/dist/types/src/containers/HelpContainer/index.d.ts.map +1 -0
  90. package/dist/types/src/containers/index.d.ts +3 -0
  91. package/dist/types/src/containers/index.d.ts.map +1 -0
  92. package/dist/types/src/index.d.ts +3 -2
  93. package/dist/types/src/index.d.ts.map +1 -1
  94. package/dist/types/src/meta.d.ts.map +1 -1
  95. package/dist/types/src/operations/capture-user-feedback.d.ts +5 -0
  96. package/dist/types/src/operations/capture-user-feedback.d.ts.map +1 -0
  97. package/dist/types/src/operations/definitions.d.ts +23 -0
  98. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  99. package/dist/types/src/operations/index.d.ts +5 -0
  100. package/dist/types/src/operations/index.d.ts.map +1 -0
  101. package/dist/types/src/operations/send-event.d.ts +5 -0
  102. package/dist/types/src/operations/send-event.d.ts.map +1 -0
  103. package/dist/types/src/operations/toggle.d.ts +5 -0
  104. package/dist/types/src/operations/toggle.d.ts.map +1 -0
  105. package/dist/types/src/translations.d.ts +17 -18
  106. package/dist/types/src/translations.d.ts.map +1 -1
  107. package/dist/types/src/types/Settings.d.ts +7 -0
  108. package/dist/types/src/types/Settings.d.ts.map +1 -0
  109. package/dist/types/src/types/capabilities.d.ts +9 -5
  110. package/dist/types/src/types/capabilities.d.ts.map +1 -1
  111. package/dist/types/src/types/events.d.ts.map +1 -1
  112. package/dist/types/src/types/index.d.ts +1 -1
  113. package/dist/types/src/types/index.d.ts.map +1 -1
  114. package/dist/types/tsconfig.tsbuildinfo +1 -1
  115. package/package.json +59 -38
  116. package/src/ObservabilityPlugin.node.ts +33 -0
  117. package/src/ObservabilityPlugin.test.ts +25 -0
  118. package/src/ObservabilityPlugin.ts +27 -11
  119. package/src/capabilities/app-graph-builder.ts +36 -0
  120. package/src/capabilities/{client-ready/client-ready.ts → client-ready.ts} +33 -11
  121. package/src/capabilities/index.ts +14 -6
  122. package/src/capabilities/operation-handler.ts +16 -0
  123. package/src/capabilities/react-surface.tsx +41 -0
  124. package/src/capabilities/{settings/settings.ts → settings.ts} +4 -5
  125. package/src/capabilities/{state/state.ts → state.ts} +3 -4
  126. package/src/components/{FeedbackForm.stories.tsx → FeedbackForm/FeedbackForm.stories.tsx} +13 -2
  127. package/src/components/FeedbackForm/FeedbackForm.tsx +49 -0
  128. package/src/components/FeedbackForm/index.ts +5 -0
  129. package/src/components/ObservabilitySettings/ObservabilitySettings.stories.tsx +34 -0
  130. package/src/components/ObservabilitySettings/ObservabilitySettings.tsx +34 -0
  131. package/src/components/ObservabilitySettings/index.ts +5 -0
  132. package/src/components/index.ts +4 -2
  133. package/src/{components → containers/HelpContainer}/HelpContainer.tsx +11 -10
  134. package/src/containers/HelpContainer/index.ts +5 -0
  135. package/src/containers/index.ts +7 -0
  136. package/src/index.ts +7 -2
  137. package/src/meta.ts +2 -1
  138. package/src/operations/capture-user-feedback.ts +22 -0
  139. package/src/operations/definitions.ts +76 -0
  140. package/src/operations/index.ts +14 -0
  141. package/src/operations/send-event.ts +24 -0
  142. package/src/operations/toggle.ts +47 -0
  143. package/src/translations.ts +17 -18
  144. package/src/types/Settings.ts +22 -0
  145. package/src/types/capabilities.ts +16 -6
  146. package/src/types/events.ts +3 -3
  147. package/src/types/index.ts +1 -1
  148. package/dist/lib/browser/app-graph-builder-7PBOGFFG.mjs +0 -45
  149. package/dist/lib/browser/app-graph-builder-7PBOGFFG.mjs.map +0 -7
  150. package/dist/lib/browser/chunk-3XZDP7JS.mjs +0 -16
  151. package/dist/lib/browser/chunk-3XZDP7JS.mjs.map +0 -7
  152. package/dist/lib/browser/chunk-T3EKFAAB.mjs +0 -138
  153. package/dist/lib/browser/chunk-T3EKFAAB.mjs.map +0 -7
  154. package/dist/lib/browser/chunk-UTYAG5Z3.mjs +0 -123
  155. package/dist/lib/browser/chunk-UTYAG5Z3.mjs.map +0 -7
  156. package/dist/lib/browser/cli/index.mjs +0 -24
  157. package/dist/lib/browser/cli/index.mjs.map +0 -7
  158. package/dist/lib/browser/client-ready-ZVLSHDH6.mjs +0 -103
  159. package/dist/lib/browser/client-ready-ZVLSHDH6.mjs.map +0 -7
  160. package/dist/lib/browser/operation-resolver-GJYJZPY3.mjs +0 -79
  161. package/dist/lib/browser/operation-resolver-GJYJZPY3.mjs.map +0 -7
  162. package/dist/lib/browser/react-surface-4RABGTCC.mjs +0 -38
  163. package/dist/lib/browser/react-surface-4RABGTCC.mjs.map +0 -7
  164. package/dist/lib/browser/settings-QQBXDLBH.mjs +0 -36
  165. package/dist/lib/browser/settings-QQBXDLBH.mjs.map +0 -7
  166. package/dist/lib/browser/state-SSUNAB2P.mjs +0 -31
  167. package/dist/lib/browser/state-SSUNAB2P.mjs.map +0 -7
  168. package/dist/lib/node-esm/app-graph-builder-D77CGMCQ.mjs +0 -46
  169. package/dist/lib/node-esm/app-graph-builder-D77CGMCQ.mjs.map +0 -7
  170. package/dist/lib/node-esm/chunk-2ECMMPZY.mjs +0 -18
  171. package/dist/lib/node-esm/chunk-2ECMMPZY.mjs.map +0 -7
  172. package/dist/lib/node-esm/chunk-PE6CKAA6.mjs +0 -124
  173. package/dist/lib/node-esm/chunk-PE6CKAA6.mjs.map +0 -7
  174. package/dist/lib/node-esm/chunk-VC5HVE77.mjs +0 -139
  175. package/dist/lib/node-esm/chunk-VC5HVE77.mjs.map +0 -7
  176. package/dist/lib/node-esm/cli/index.mjs +0 -25
  177. package/dist/lib/node-esm/cli/index.mjs.map +0 -7
  178. package/dist/lib/node-esm/client-ready-JXG727PH.mjs +0 -104
  179. package/dist/lib/node-esm/client-ready-JXG727PH.mjs.map +0 -7
  180. package/dist/lib/node-esm/operation-resolver-NB7XDO3M.mjs +0 -80
  181. package/dist/lib/node-esm/operation-resolver-NB7XDO3M.mjs.map +0 -7
  182. package/dist/lib/node-esm/react-surface-ZHTRUHHM.mjs +0 -39
  183. package/dist/lib/node-esm/react-surface-ZHTRUHHM.mjs.map +0 -7
  184. package/dist/lib/node-esm/settings-IZ2DBP4E.mjs +0 -37
  185. package/dist/lib/node-esm/settings-IZ2DBP4E.mjs.map +0 -7
  186. package/dist/lib/node-esm/state-3HUC5SJV.mjs +0 -32
  187. package/dist/lib/node-esm/state-3HUC5SJV.mjs.map +0 -7
  188. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts +0 -6
  189. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +0 -1
  190. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +0 -3
  191. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +0 -1
  192. package/dist/types/src/capabilities/client-ready/client-ready.d.ts.map +0 -1
  193. package/dist/types/src/capabilities/client-ready/index.d.ts +0 -4
  194. package/dist/types/src/capabilities/client-ready/index.d.ts.map +0 -1
  195. package/dist/types/src/capabilities/operation-resolver/index.d.ts +0 -5
  196. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +0 -1
  197. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +0 -7
  198. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +0 -1
  199. package/dist/types/src/capabilities/react-surface/index.d.ts +0 -3
  200. package/dist/types/src/capabilities/react-surface/index.d.ts.map +0 -1
  201. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +0 -5
  202. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +0 -1
  203. package/dist/types/src/capabilities/settings/index.d.ts +0 -7
  204. package/dist/types/src/capabilities/settings/index.d.ts.map +0 -1
  205. package/dist/types/src/capabilities/settings/settings.d.ts +0 -10
  206. package/dist/types/src/capabilities/settings/settings.d.ts.map +0 -1
  207. package/dist/types/src/capabilities/state/index.d.ts +0 -11
  208. package/dist/types/src/capabilities/state/index.d.ts.map +0 -1
  209. package/dist/types/src/capabilities/state/state.d.ts.map +0 -1
  210. package/dist/types/src/cli/index.d.ts +0 -2
  211. package/dist/types/src/cli/index.d.ts.map +0 -1
  212. package/dist/types/src/cli/plugin.d.ts.map +0 -1
  213. package/dist/types/src/components/FeedbackForm.d.ts +0 -6
  214. package/dist/types/src/components/FeedbackForm.d.ts.map +0 -1
  215. package/dist/types/src/components/FeedbackForm.stories.d.ts +0 -35
  216. package/dist/types/src/components/FeedbackForm.stories.d.ts.map +0 -1
  217. package/dist/types/src/components/HelpContainer.d.ts.map +0 -1
  218. package/dist/types/src/components/ObservabilitySettings.d.ts +0 -12
  219. package/dist/types/src/components/ObservabilitySettings.d.ts.map +0 -1
  220. package/dist/types/src/types/schema.d.ts +0 -63
  221. package/dist/types/src/types/schema.d.ts.map +0 -1
  222. package/src/capabilities/app-graph-builder/app-graph-builder.ts +0 -43
  223. package/src/capabilities/app-graph-builder/index.ts +0 -7
  224. package/src/capabilities/client-ready/index.ts +0 -9
  225. package/src/capabilities/operation-resolver/index.ts +0 -7
  226. package/src/capabilities/operation-resolver/operation-resolver.ts +0 -77
  227. package/src/capabilities/react-surface/index.ts +0 -7
  228. package/src/capabilities/react-surface/react-surface.tsx +0 -35
  229. package/src/capabilities/settings/index.ts +0 -7
  230. package/src/capabilities/state/index.ts +0 -7
  231. package/src/cli/index.ts +0 -5
  232. package/src/cli/plugin.ts +0 -28
  233. package/src/components/FeedbackForm.tsx +0 -31
  234. package/src/components/ObservabilitySettings.tsx +0 -53
  235. package/src/types/schema.ts +0 -84
  236. /package/dist/types/src/{components → containers/HelpContainer}/HelpContainer.d.ts +0 -0
@@ -0,0 +1,34 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type Meta, type StoryObj } from '@storybook/react-vite';
6
+
7
+ import { withLayout, withTheme } from '@dxos/react-ui/testing';
8
+
9
+ import { translations } from '#translations';
10
+
11
+ import { ObservabilitySettings } from './ObservabilitySettings';
12
+
13
+ const meta = {
14
+ title: 'plugins/plugin-observability/components/ObservabilitySettings',
15
+ component: ObservabilitySettings,
16
+ tags: ['settings'],
17
+ decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
18
+ parameters: {
19
+ layout: 'fullscreen',
20
+ translations,
21
+ },
22
+ } satisfies Meta<typeof ObservabilitySettings>;
23
+
24
+ export default meta;
25
+
26
+ type Story = StoryObj<typeof meta>;
27
+
28
+ export const Default: Story = {
29
+ args: {
30
+ settings: {
31
+ enabled: true,
32
+ },
33
+ },
34
+ };
@@ -0,0 +1,34 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import React from 'react';
6
+
7
+ import { type AppSurface } from '@dxos/app-toolkit/ui';
8
+ import { Message, useTranslation } from '@dxos/react-ui';
9
+ import { Settings as SettingsForm } from '@dxos/react-ui-form';
10
+
11
+ import { meta } from '#meta';
12
+ import { Settings } from '#types';
13
+
14
+ export type ObservabilitySettingsProps = AppSurface.SettingsArticleProps<Settings.Settings>;
15
+
16
+ export const ObservabilitySettings = ({ settings, onSettingsChange }: ObservabilitySettingsProps) => {
17
+ const { t } = useTranslation(meta.id);
18
+
19
+ return (
20
+ <SettingsForm.Viewport>
21
+ <SettingsForm.Section title={t('settings.title', { ns: meta.id })}>
22
+ <Message.Root valence='info'>
23
+ <Message.Content>{t('observability.description')}</Message.Content>
24
+ </Message.Root>
25
+ <SettingsForm.FieldSet
26
+ readonly={!onSettingsChange}
27
+ schema={Settings.Settings}
28
+ values={settings}
29
+ onValuesChanged={(values) => onSettingsChange?.(() => values)}
30
+ />
31
+ </SettingsForm.Section>
32
+ </SettingsForm.Viewport>
33
+ );
34
+ };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ export { ObservabilitySettings as default } from './ObservabilitySettings';
@@ -2,6 +2,8 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
+ import { type ComponentType, lazy } from 'react';
6
+
5
7
  export * from './FeedbackForm';
6
- export * from './HelpContainer';
7
- export * from './ObservabilitySettings';
8
+
9
+ export const ObservabilitySettings: ComponentType<any> = lazy(() => import('./ObservabilitySettings'));
@@ -5,21 +5,22 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
  import React, { useCallback, useState } from 'react';
7
7
 
8
- import { useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
8
+ import { useCapabilities, useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
9
9
  import { LayoutOperation } from '@dxos/app-toolkit';
10
10
  import { runAndForwardErrors } from '@dxos/effect';
11
11
  import { useAsyncEffect } from '@dxos/react-hooks';
12
12
  import { osTranslations } from '@dxos/ui-theme';
13
13
 
14
- import { meta } from '../meta';
15
- import { ObservabilityCapabilities, ObservabilityOperation, type UserFeedback } from '../types';
16
-
17
- import { FeedbackForm } from './FeedbackForm';
14
+ import { FeedbackForm } from '#components';
15
+ import { meta } from '#meta';
16
+ import { ObservabilityOperation, type UserFeedback } from '#operations';
17
+ import { ObservabilityCapabilities } from '#types';
18
18
 
19
19
  /** Renders the feedback form, disabling it when the feedback survey is unavailable. */
20
20
  export const HelpContainer = () => {
21
21
  const { invokePromise } = useOperationInvoker();
22
22
  const observability = useCapability(ObservabilityCapabilities.Observability);
23
+ const [downloadLogs] = useCapabilities(ObservabilityCapabilities.LogDownloader);
23
24
  const [feedbackAvailable, setFeedbackAvailable] = useState(false);
24
25
 
25
26
  useAsyncEffect(
@@ -41,16 +42,16 @@ export const HelpContainer = () => {
41
42
  await invokePromise(ObservabilityOperation.CaptureUserFeedback, values);
42
43
  await invokePromise(LayoutOperation.UpdateComplementary, { state: 'collapsed' });
43
44
  await invokePromise(LayoutOperation.AddToast, {
44
- id: `${meta.id}/feedback-success`,
45
+ id: `${meta.id}.feedback-success`,
45
46
  icon: 'ph--paper-plane-tilt--regular',
46
47
  duration: 3000,
47
- title: ['feedback toast label', { ns: meta.id }],
48
- description: ['feedback toast description', { ns: meta.id }],
49
- closeLabel: ['close label', { ns: osTranslations }],
48
+ title: ['feedback-toast.label', { ns: meta.id }],
49
+ description: ['feedback-toast.description', { ns: meta.id }],
50
+ closeLabel: ['close.label', { ns: osTranslations }],
50
51
  });
51
52
  },
52
53
  [invokePromise],
53
54
  );
54
55
 
55
- return <FeedbackForm onSave={handleSave} disabled={!feedbackAvailable} />;
56
+ return <FeedbackForm onSave={handleSave} disabled={!feedbackAvailable} onDownloadLogs={downloadLogs} />;
56
57
  };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export { HelpContainer as default } from './HelpContainer';
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type ComponentType, lazy } from 'react';
6
+
7
+ export const HelpContainer: ComponentType<any> = lazy(() => import('./HelpContainer'));
package/src/index.ts CHANGED
@@ -2,7 +2,12 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
+ import { Plugin } from '@dxos/app-framework';
6
+
7
+ import { meta } from './meta';
8
+
5
9
  export { ObservabilityCapabilities, ObservabilityEvents } from './types';
6
- export * from './components';
10
+ // TODO(wittjosiah): FeedbackForm should be factored out of plugin-observability into a shared UI package.
7
11
  export * from './meta';
8
- export * from './ObservabilityPlugin';
12
+ export const ObservabilityPlugin = Plugin.lazy(meta, () => import('#plugin'));
13
+ export { translations as observabilityTranslations } from './translations';
package/src/meta.ts CHANGED
@@ -6,11 +6,12 @@ import { type Plugin } from '@dxos/app-framework';
6
6
  import { trim } from '@dxos/util';
7
7
 
8
8
  export const meta: Plugin.Meta = {
9
- id: 'dxos.org/plugin/observability',
9
+ id: 'org.dxos.plugin.observability',
10
10
  name: 'Telemetry',
11
11
  description: trim`
12
12
  Application observability and telemetry collection for monitoring performance and usage patterns.
13
13
  Track metrics, logs, and traces for system health and analytics.
14
14
  `,
15
15
  icon: 'ph--eye--regular',
16
+ tags: ['system'],
16
17
  };
@@ -0,0 +1,22 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/compute';
9
+
10
+ import { ObservabilityCapabilities } from '../types';
11
+ import { CaptureUserFeedback } from './definitions';
12
+
13
+ const handler: Operation.WithHandler<typeof CaptureUserFeedback> = CaptureUserFeedback.pipe(
14
+ Operation.withHandler(
15
+ Effect.fnUntraced(function* (input) {
16
+ const observability = yield* Capability.get(ObservabilityCapabilities.Observability);
17
+ observability.feedback.captureUserFeedback({ message: input.message, includeLogs: input.includeLogs });
18
+ }),
19
+ ),
20
+ );
21
+
22
+ export default handler;
@@ -0,0 +1,76 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/compute';
9
+ import { Format } from '@dxos/echo';
10
+
11
+ import { meta } from '#meta';
12
+ import { translations } from '#translations';
13
+
14
+ const t = translations[0]['en-US'][meta.id];
15
+
16
+ export const UserFeedback = Schema.Struct({
17
+ message: Format.Text.pipe(
18
+ Schema.nonEmptyString(),
19
+ Schema.maxLength(4_096),
20
+ Schema.annotations({
21
+ title: t['feedback-textarea.label'],
22
+ description: t['feedback-textarea.placeholder'],
23
+ }),
24
+ ),
25
+ includeLogs: Schema.Boolean.pipe(
26
+ Schema.annotations({
27
+ title: t['include-debug-logs.label'],
28
+ }),
29
+ Schema.optional,
30
+ ),
31
+ });
32
+
33
+ export type UserFeedback = Schema.Schema.Type<typeof UserFeedback>;
34
+
35
+ const OBSERVABILITY_OPERATION = `${meta.id}.operation`;
36
+
37
+ /**
38
+ * Operations for the Observability plugin.
39
+ */
40
+ export const Toggle = Operation.make({
41
+ meta: {
42
+ key: `${OBSERVABILITY_OPERATION}.toggle`,
43
+ name: 'Toggle Observability',
44
+ description: 'Toggle observability on or off.',
45
+ },
46
+ services: [Capability.Service],
47
+ input: Schema.Struct({
48
+ state: Schema.optional(Schema.Boolean),
49
+ }),
50
+ output: Schema.Boolean,
51
+ });
52
+
53
+ export const CaptureUserFeedback = Operation.make({
54
+ meta: {
55
+ key: `${OBSERVABILITY_OPERATION}.capture-feedback`,
56
+ name: 'Capture User Feedback',
57
+ description: 'Capture user feedback.',
58
+ },
59
+ services: [Capability.Service],
60
+ input: UserFeedback,
61
+ output: Schema.Void,
62
+ });
63
+
64
+ export const SendEvent = Operation.make({
65
+ meta: {
66
+ key: `${OBSERVABILITY_OPERATION}.send-event`,
67
+ name: 'Send Event',
68
+ description: 'Send an observability event.',
69
+ },
70
+ services: [Capability.Service],
71
+ input: Schema.Struct({
72
+ name: Schema.String.annotations({ description: 'The name of the event.' }),
73
+ properties: Schema.optional(Schema.Any).annotations({ description: 'Event properties.' }),
74
+ }),
75
+ output: Schema.Void,
76
+ });
@@ -0,0 +1,14 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { OperationHandlerSet } from '@dxos/compute';
6
+
7
+ export * as ObservabilityOperation from './definitions';
8
+ export { UserFeedback } from './definitions';
9
+
10
+ export const ObservabilityOperationHandlerSet = OperationHandlerSet.lazy(
11
+ () => import('./capture-user-feedback'),
12
+ () => import('./send-event'),
13
+ () => import('./toggle'),
14
+ );
@@ -0,0 +1,24 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/compute';
9
+
10
+ import { ObservabilityCapabilities } from '../types';
11
+ import { SendEvent } from './definitions';
12
+
13
+ const handler: Operation.WithHandler<typeof SendEvent> = SendEvent.pipe(
14
+ Operation.withHandler(
15
+ Effect.fnUntraced(function* (input) {
16
+ // NOTE: This is to ensure that events fired before observability is ready are still sent.
17
+ const observability = yield* Capability.waitFor(ObservabilityCapabilities.Observability);
18
+ const properties = input.properties ?? {};
19
+ observability.events.captureEvent(input.name, properties);
20
+ }),
21
+ ),
22
+ );
23
+
24
+ export default handler;
@@ -0,0 +1,47 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capabilities, Capability } from '@dxos/app-framework';
8
+ import { AppCapabilities } from '@dxos/app-toolkit';
9
+ import { Operation } from '@dxos/compute';
10
+ import { Observability } from '@dxos/observability';
11
+
12
+ import { meta } from '#meta';
13
+
14
+ import { ObservabilityCapabilities, type Settings } from '../types';
15
+ import { Toggle } from './definitions';
16
+
17
+ const handler: Operation.WithHandler<typeof Toggle> = Toggle.pipe(
18
+ Operation.withHandler(
19
+ Effect.fnUntraced(function* (input) {
20
+ const namespace = yield* Capability.get(ObservabilityCapabilities.Namespace);
21
+ const observability = yield* Capability.get(ObservabilityCapabilities.Observability);
22
+ const capabilities = yield* Capability.Service;
23
+ const registry = capabilities.get(Capabilities.AtomRegistry);
24
+ const allSettings = capabilities.getAll(AppCapabilities.Settings);
25
+ const settingsObj = allSettings.find((s: AppCapabilities.Settings) => s.prefix === meta.id);
26
+ if (!settingsObj) {
27
+ return false;
28
+ }
29
+ const settings = registry.get(settingsObj.atom) as Settings.Settings;
30
+ const newEnabled = input.state ?? !settings.enabled;
31
+ registry.set(settingsObj.atom, { ...settings, enabled: newEnabled });
32
+ observability.events.captureEvent('observability.toggle', {
33
+ enabled: newEnabled,
34
+ });
35
+
36
+ if (newEnabled) {
37
+ yield* observability.enable();
38
+ } else {
39
+ yield* observability.disable();
40
+ }
41
+ yield* Effect.promise(() => Observability.storeObservabilityDisabled(namespace, !newEnabled));
42
+ return newEnabled;
43
+ }),
44
+ ),
45
+ );
46
+
47
+ export default handler;
@@ -4,32 +4,31 @@
4
4
 
5
5
  import { type Resource } from '@dxos/react-ui';
6
6
 
7
- import { meta } from './meta';
7
+ import { meta } from '#meta';
8
8
 
9
9
  export const translations = [
10
10
  {
11
11
  'en-US': {
12
12
  [meta.id]: {
13
- 'plugin name': 'Telemetry',
14
- 'settings title': 'Telemetry settings',
15
- 'observability toast label': 'Privacy Notice',
16
- 'observability toast description':
13
+ 'plugin.name': 'Telemetry',
14
+ 'settings.title': 'Telemetry settings',
15
+ 'observability-toast.label': 'Privacy Notice',
16
+ 'observability-toast.description':
17
17
  'Composer collects usage and performance metrics to improve the product. No user data is collected.',
18
- 'observability toast action label': 'Settings',
19
- 'observability toast action alt': 'Open settings to learn more or to disable.',
20
- 'observability toast close label': 'Okay',
21
- 'observability enabled label': 'Enable telemetry',
18
+ 'observability-toast-action.label': 'Settings',
19
+ 'observability-toast-action.alt': 'Open settings to learn more or to disable.',
20
+ 'observability-toast-close.label': 'Okay',
22
21
  // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.
23
- 'observability description':
22
+ 'observability.description':
24
23
  'When enabled, basic usage data will used to improve the product. This may include performance metrics, error logs, and usage data. No personally identifiable information, other than your public key, is included with this data and no private data ever leaves your devices.',
25
-
26
- 'help label': 'Feedback & Support',
27
- 'feedback textarea label': 'Feedback',
28
- 'feedback textarea placeholder': 'Please enter your feedback, technical issue, or feature request.',
29
- 'include debug logs label': 'Include debug logs',
30
- 'send feedback label': 'Send Feedback',
31
- 'feedback toast label': 'Thank you for your feedback!',
32
- 'feedback toast description': 'We will review your feedback and get back to you as soon as possible.',
24
+ 'help.label': 'Feedback & Support',
25
+ 'feedback-textarea.label': 'Feedback',
26
+ 'feedback-textarea.placeholder': 'Please enter your feedback, technical issue, or feature request.',
27
+ 'include-debug-logs.label': 'Include debug logs',
28
+ 'send-feedback.label': 'Send Feedback',
29
+ 'download-logs.label': 'Download logs',
30
+ 'feedback-toast.label': 'Thank you for your feedback!',
31
+ 'feedback-toast.description': 'We will review your feedback and get back to you as soon as possible.',
33
32
  },
34
33
  },
35
34
  },
@@ -0,0 +1,22 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ // @import-as-namespace
6
+
7
+ import * as Schema from 'effect/Schema';
8
+
9
+ export const Settings = Schema.mutable(
10
+ Schema.Struct({
11
+ enabled: Schema.Boolean.annotations({
12
+ title: 'Enable telemetry',
13
+ description: 'Send anonymous usage and performance data to help improve the product.',
14
+ }),
15
+ // TODO(wittjosiah): Separate settings for each observability feature.
16
+ // metrics?: boolean;
17
+ // telemetry?: boolean;
18
+ // errors?: boolean;
19
+ }),
20
+ );
21
+
22
+ export interface Settings extends Schema.Schema.Type<typeof Settings> {}
@@ -9,11 +9,14 @@ import { Capability } from '@dxos/app-framework';
9
9
  import { type Client } from '@dxos/client';
10
10
  import { type Observability } from '@dxos/observability';
11
11
 
12
- import { type ObservabilitySettingsProps } from '../components';
13
- import { meta } from '../meta';
12
+ import { meta } from '#meta';
13
+
14
+ import * as Settings from './Settings';
14
15
 
15
16
  export namespace ObservabilityCapabilities {
16
- export const Settings = Capability.make<Atom.Writable<ObservabilitySettingsProps>>(`${meta.id}/capability/settings`);
17
+ export const Namespace = Capability.make<string>(`${meta.id}.capability.namespace`);
18
+
19
+ export const Settings = Capability.make<Atom.Writable<Settings.Settings>>(`${meta.id}.capability.settings`);
17
20
 
18
21
  export const StateSchema = Schema.mutable(
19
22
  Schema.Struct({
@@ -24,11 +27,18 @@ export namespace ObservabilityCapabilities {
24
27
 
25
28
  export type State = Schema.Schema.Type<typeof StateSchema>;
26
29
 
27
- export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
30
+ export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);
31
+
32
+ export const Observability = Capability.make<Observability.Observability>(`${meta.id}.capability.observability`);
28
33
 
29
- export const Observability = Capability.make<Observability.Observability>(`${meta.id}/capability/observability`);
34
+ /**
35
+ * Optional capability — when contributed, the help/feedback UI exposes a "Download logs" action.
36
+ * The callback is responsible for the entire download (read store, encode, save file).
37
+ */
38
+ export type LogDownloader = () => void | Promise<void>;
39
+ export const LogDownloader = Capability.make<LogDownloader>(`${meta.id}.capability.log-downloader`);
30
40
  }
31
41
 
32
42
  // NOTE: This is cloned from the client plugin to avoid circular dependencies.
33
43
  // TODO(burdon): Figure out how to share defs.
34
- export const ClientCapability = Capability.make<Client>('dxos.org/plugin/client/capability/client');
44
+ export const ClientCapability = Capability.make<Client>('org.dxos.plugin.client.capability.client');
@@ -3,13 +3,13 @@
3
3
  //
4
4
 
5
5
  import { ActivationEvent } from '@dxos/app-framework';
6
- import { AppActivationEvents } from '@dxos/app-toolkit';
6
+ import { AppActivationEvents } from '@dxos/app-toolkit/events';
7
7
 
8
- import { meta } from '../meta';
8
+ import { meta } from '#meta';
9
9
 
10
10
  export namespace ObservabilityEvents {
11
11
  export const StateReady: ActivationEvent.ActivationEvent = AppActivationEvents.createStateEvent(meta.id);
12
12
  }
13
13
 
14
14
  // NOTE: This is cloned from the client plugin to avoid circular dependencies.
15
- export const ClientReadyEvent = ActivationEvent.make('dxos.org/plugin/client/event/client-ready');
15
+ export const ClientReadyEvent = ActivationEvent.make('org.dxos.plugin.client.event.client-ready');
@@ -4,4 +4,4 @@
4
4
 
5
5
  export * from './capabilities';
6
6
  export * from './events';
7
- export * from './schema';
7
+ export * as Settings from './Settings';
@@ -1,45 +0,0 @@
1
- import {
2
- meta
3
- } from "./chunk-3XZDP7JS.mjs";
4
-
5
- // src/capabilities/app-graph-builder/app-graph-builder.ts
6
- import * as Effect from "effect/Effect";
7
- import { Capability } from "@dxos/app-framework";
8
- import { AppCapabilities } from "@dxos/app-toolkit";
9
- import { GraphBuilder, NodeMatcher } from "@dxos/plugin-graph";
10
- var ATTENDABLE_PATH_SEPARATOR = "~";
11
- var DECK_COMPANION_TYPE = "dxos.org/plugin/deck/deck-companion";
12
- var app_graph_builder_default = Capability.makeModule(Effect.fnUntraced(function* () {
13
- const extensions = yield* Effect.all([
14
- GraphBuilder.createExtension({
15
- id: `${meta.id}/help`,
16
- match: NodeMatcher.whenRoot,
17
- connector: (node) => Effect.succeed([
18
- {
19
- id: [
20
- node.id,
21
- "help"
22
- ].join(ATTENDABLE_PATH_SEPARATOR),
23
- type: DECK_COMPANION_TYPE,
24
- data: null,
25
- properties: {
26
- label: [
27
- "help label",
28
- {
29
- ns: meta.id
30
- }
31
- ],
32
- icon: "ph--question--regular",
33
- disposition: "hidden",
34
- position: "hoist"
35
- }
36
- }
37
- ])
38
- })
39
- ]);
40
- return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
41
- }));
42
- export {
43
- app_graph_builder_default as default
44
- };
45
- //# sourceMappingURL=app-graph-builder-7PBOGFFG.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Effect from 'effect/Effect';\n\nimport { Capability } from '@dxos/app-framework';\nimport { AppCapabilities } from '@dxos/app-toolkit';\nimport { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';\n\nimport { meta } from '../../meta';\n\n// NOTE: Copied from @dxos/plugin-deck to break circular dependency.\nconst ATTENDABLE_PATH_SEPARATOR = '~';\n\nconst DECK_COMPANION_TYPE = 'dxos.org/plugin/deck/deck-companion';\n\nexport default Capability.makeModule(\n Effect.fnUntraced(function* () {\n const extensions = yield* Effect.all([\n GraphBuilder.createExtension({\n id: `${meta.id}/help`,\n match: NodeMatcher.whenRoot,\n connector: (node) =>\n Effect.succeed([\n {\n id: [node.id, 'help'].join(ATTENDABLE_PATH_SEPARATOR),\n type: DECK_COMPANION_TYPE,\n data: null,\n properties: {\n label: ['help label', { ns: meta.id }],\n icon: 'ph--question--regular',\n disposition: 'hidden',\n position: 'hoist',\n },\n },\n ]),\n }),\n ]);\n\n return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);\n }),\n);\n"],
5
- "mappings": ";;;;;AAIA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;AAC3B,SAASC,uBAAuB;AAChC,SAASC,cAAcC,mBAAmB;AAK1C,IAAMC,4BAA4B;AAElC,IAAMC,sBAAsB;AAE5B,IAAA,4BAAeC,WAAWC,WACjBC,kBAAW,aAAA;AAChB,QAAMC,aAAa,OAAcC,WAAI;IACnCC,aAAaC,gBAAgB;MAC3BC,IAAI,GAAGC,KAAKD,EAAE;MACdE,OAAOC,YAAYC;MACnBC,WAAW,CAACC,SACHC,eAAQ;QACb;UACEP,IAAI;YAACM,KAAKN;YAAI;YAAQQ,KAAKjB,yBAAAA;UAC3BkB,MAAMjB;UACNkB,MAAM;UACNC,YAAY;YACVC,OAAO;cAAC;cAAc;gBAAEC,IAAIZ,KAAKD;cAAG;;YACpCc,MAAM;YACNC,aAAa;YACbC,UAAU;UACZ;QACF;OACD;IACL,CAAA;GACD;AAED,SAAOvB,WAAWwB,YAAYC,gBAAgBC,iBAAiBvB,UAAAA;AACjE,CAAA,CAAA;",
6
- "names": ["Effect", "Capability", "AppCapabilities", "GraphBuilder", "NodeMatcher", "ATTENDABLE_PATH_SEPARATOR", "DECK_COMPANION_TYPE", "Capability", "makeModule", "fnUntraced", "extensions", "all", "GraphBuilder", "createExtension", "id", "meta", "match", "NodeMatcher", "whenRoot", "connector", "node", "succeed", "join", "type", "data", "properties", "label", "ns", "icon", "disposition", "position", "contributes", "AppCapabilities", "AppGraphBuilder"]
7
- }
@@ -1,16 +0,0 @@
1
- // src/meta.ts
2
- import { trim } from "@dxos/util";
3
- var meta = {
4
- id: "dxos.org/plugin/observability",
5
- name: "Telemetry",
6
- description: trim`
7
- Application observability and telemetry collection for monitoring performance and usage patterns.
8
- Track metrics, logs, and traces for system health and analytics.
9
- `,
10
- icon: "ph--eye--regular"
11
- };
12
-
13
- export {
14
- meta
15
- };
16
- //# sourceMappingURL=chunk-3XZDP7JS.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/meta.ts"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Plugin } from '@dxos/app-framework';\nimport { trim } from '@dxos/util';\n\nexport const meta: Plugin.Meta = {\n id: 'dxos.org/plugin/observability',\n name: 'Telemetry',\n description: trim`\n Application observability and telemetry collection for monitoring performance and usage patterns.\n Track metrics, logs, and traces for system health and analytics.\n `,\n icon: 'ph--eye--regular',\n};\n"],
5
- "mappings": ";AAKA,SAASA,YAAY;AAEd,IAAMC,OAAoB;EAC/BC,IAAI;EACJC,MAAM;EACNC,aAAaC;;;;EAIbC,MAAM;AACR;",
6
- "names": ["trim", "meta", "id", "name", "description", "trim", "icon"]
7
- }