@dxos/plugin-observability 0.8.4-main.3c1ae3b → 0.8.4-main.3eb6e50203

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 (193) hide show
  1. package/dist/lib/browser/app-graph-builder-7PBOGFFG.mjs +45 -0
  2. package/dist/lib/browser/app-graph-builder-7PBOGFFG.mjs.map +7 -0
  3. package/dist/lib/browser/{chunk-W7QWKVS3.mjs → chunk-3XZDP7JS.mjs} +1 -1
  4. package/dist/lib/browser/chunk-3XZDP7JS.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-T3EKFAAB.mjs +138 -0
  6. package/dist/lib/browser/chunk-T3EKFAAB.mjs.map +7 -0
  7. package/dist/lib/browser/chunk-UTYAG5Z3.mjs +123 -0
  8. package/dist/lib/browser/chunk-UTYAG5Z3.mjs.map +7 -0
  9. package/dist/lib/browser/cli/index.mjs +24 -0
  10. package/dist/lib/browser/cli/index.mjs.map +7 -0
  11. package/dist/lib/browser/client-ready-ZVLSHDH6.mjs +103 -0
  12. package/dist/lib/browser/client-ready-ZVLSHDH6.mjs.map +7 -0
  13. package/dist/lib/browser/index.mjs +74 -77
  14. package/dist/lib/browser/index.mjs.map +4 -4
  15. package/dist/lib/browser/meta.json +1 -1
  16. package/dist/lib/browser/operation-resolver-GJYJZPY3.mjs +79 -0
  17. package/dist/lib/browser/operation-resolver-GJYJZPY3.mjs.map +7 -0
  18. package/dist/lib/browser/react-surface-4RABGTCC.mjs +38 -0
  19. package/dist/lib/browser/react-surface-4RABGTCC.mjs.map +7 -0
  20. package/dist/lib/browser/settings-QQBXDLBH.mjs +36 -0
  21. package/dist/lib/browser/settings-QQBXDLBH.mjs.map +7 -0
  22. package/dist/lib/browser/state-SSUNAB2P.mjs +31 -0
  23. package/dist/lib/browser/state-SSUNAB2P.mjs.map +7 -0
  24. package/dist/lib/browser/types/index.mjs +12 -4
  25. package/dist/lib/node-esm/app-graph-builder-D77CGMCQ.mjs +46 -0
  26. package/dist/lib/node-esm/app-graph-builder-D77CGMCQ.mjs.map +7 -0
  27. package/dist/lib/node-esm/{chunk-AVJTLRX5.mjs → chunk-2ECMMPZY.mjs} +1 -1
  28. package/dist/lib/node-esm/chunk-2ECMMPZY.mjs.map +7 -0
  29. package/dist/lib/node-esm/chunk-PE6CKAA6.mjs +124 -0
  30. package/dist/lib/node-esm/chunk-PE6CKAA6.mjs.map +7 -0
  31. package/dist/lib/node-esm/chunk-VC5HVE77.mjs +139 -0
  32. package/dist/lib/node-esm/chunk-VC5HVE77.mjs.map +7 -0
  33. package/dist/lib/node-esm/cli/index.mjs +25 -0
  34. package/dist/lib/node-esm/cli/index.mjs.map +7 -0
  35. package/dist/lib/node-esm/client-ready-JXG727PH.mjs +104 -0
  36. package/dist/lib/node-esm/client-ready-JXG727PH.mjs.map +7 -0
  37. package/dist/lib/node-esm/index.mjs +74 -77
  38. package/dist/lib/node-esm/index.mjs.map +4 -4
  39. package/dist/lib/node-esm/meta.json +1 -1
  40. package/dist/lib/node-esm/operation-resolver-NB7XDO3M.mjs +80 -0
  41. package/dist/lib/node-esm/operation-resolver-NB7XDO3M.mjs.map +7 -0
  42. package/dist/lib/node-esm/react-surface-ZHTRUHHM.mjs +39 -0
  43. package/dist/lib/node-esm/react-surface-ZHTRUHHM.mjs.map +7 -0
  44. package/dist/lib/node-esm/settings-IZ2DBP4E.mjs +37 -0
  45. package/dist/lib/node-esm/settings-IZ2DBP4E.mjs.map +7 -0
  46. package/dist/lib/node-esm/state-3HUC5SJV.mjs +32 -0
  47. package/dist/lib/node-esm/state-3HUC5SJV.mjs.map +7 -0
  48. package/dist/lib/node-esm/types/index.mjs +12 -4
  49. package/dist/types/src/ObservabilityPlugin.d.ts +3 -2
  50. package/dist/types/src/ObservabilityPlugin.d.ts.map +1 -1
  51. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts +6 -0
  52. package/dist/types/src/capabilities/app-graph-builder/app-graph-builder.d.ts.map +1 -0
  53. package/dist/types/src/capabilities/app-graph-builder/index.d.ts +3 -0
  54. package/dist/types/src/capabilities/app-graph-builder/index.d.ts.map +1 -0
  55. package/dist/types/src/capabilities/client-ready/client-ready.d.ts +10 -0
  56. package/dist/types/src/capabilities/client-ready/client-ready.d.ts.map +1 -0
  57. package/dist/types/src/capabilities/client-ready/index.d.ts +4 -0
  58. package/dist/types/src/capabilities/client-ready/index.d.ts.map +1 -0
  59. package/dist/types/src/capabilities/index.d.ts +6 -16
  60. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  61. package/dist/types/src/capabilities/operation-resolver/index.d.ts +5 -0
  62. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +1 -0
  63. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +7 -0
  64. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +1 -0
  65. package/dist/types/src/capabilities/react-surface/index.d.ts +3 -0
  66. package/dist/types/src/capabilities/react-surface/index.d.ts.map +1 -0
  67. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +5 -0
  68. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +1 -0
  69. package/dist/types/src/capabilities/settings/index.d.ts +7 -0
  70. package/dist/types/src/capabilities/settings/index.d.ts.map +1 -0
  71. package/dist/types/src/capabilities/settings/settings.d.ts +10 -0
  72. package/dist/types/src/capabilities/settings/settings.d.ts.map +1 -0
  73. package/dist/types/src/capabilities/state/index.d.ts +11 -0
  74. package/dist/types/src/capabilities/state/index.d.ts.map +1 -0
  75. package/dist/types/src/capabilities/state/state.d.ts +13 -0
  76. package/dist/types/src/capabilities/state/state.d.ts.map +1 -0
  77. package/dist/types/src/cli/index.d.ts +2 -0
  78. package/dist/types/src/cli/index.d.ts.map +1 -0
  79. package/dist/types/src/cli/plugin.d.ts +3 -0
  80. package/dist/types/src/cli/plugin.d.ts.map +1 -0
  81. package/dist/types/src/components/FeedbackForm.d.ts +3 -3
  82. package/dist/types/src/components/FeedbackForm.d.ts.map +1 -1
  83. package/dist/types/src/components/FeedbackForm.stories.d.ts +2 -1
  84. package/dist/types/src/components/FeedbackForm.stories.d.ts.map +1 -1
  85. package/dist/types/src/components/HelpContainer.d.ts +1 -0
  86. package/dist/types/src/components/HelpContainer.d.ts.map +1 -1
  87. package/dist/types/src/components/ObservabilitySettings.d.ts +4 -2
  88. package/dist/types/src/components/ObservabilitySettings.d.ts.map +1 -1
  89. package/dist/types/src/index.d.ts +1 -2
  90. package/dist/types/src/index.d.ts.map +1 -1
  91. package/dist/types/src/meta.d.ts +2 -2
  92. package/dist/types/src/meta.d.ts.map +1 -1
  93. package/dist/types/src/translations.d.ts +1 -0
  94. package/dist/types/src/translations.d.ts.map +1 -1
  95. package/dist/types/src/types/capabilities.d.ts +27 -0
  96. package/dist/types/src/types/capabilities.d.ts.map +1 -0
  97. package/dist/types/src/types/events.d.ts +6 -0
  98. package/dist/types/src/types/events.d.ts.map +1 -0
  99. package/dist/types/src/types/index.d.ts +2 -0
  100. package/dist/types/src/types/index.d.ts.map +1 -1
  101. package/dist/types/src/types/schema.d.ts +56 -306
  102. package/dist/types/src/types/schema.d.ts.map +1 -1
  103. package/dist/types/tsconfig.tsbuildinfo +1 -1
  104. package/package.json +45 -33
  105. package/src/ObservabilityPlugin.ts +47 -46
  106. package/src/capabilities/app-graph-builder/app-graph-builder.ts +43 -0
  107. package/src/capabilities/app-graph-builder/index.ts +7 -0
  108. package/src/capabilities/client-ready/client-ready.ts +85 -0
  109. package/src/capabilities/client-ready/index.ts +9 -0
  110. package/src/capabilities/index.ts +6 -10
  111. package/src/capabilities/operation-resolver/index.ts +7 -0
  112. package/src/capabilities/operation-resolver/operation-resolver.ts +77 -0
  113. package/src/capabilities/react-surface/index.ts +7 -0
  114. package/src/capabilities/react-surface/react-surface.tsx +35 -0
  115. package/src/capabilities/settings/index.ts +7 -0
  116. package/src/capabilities/settings/settings.ts +34 -0
  117. package/src/capabilities/state/index.ts +7 -0
  118. package/src/capabilities/state/state.ts +30 -0
  119. package/src/cli/index.ts +5 -0
  120. package/src/cli/plugin.ts +28 -0
  121. package/src/components/FeedbackForm.stories.tsx +1 -1
  122. package/src/components/FeedbackForm.tsx +10 -5
  123. package/src/components/HelpContainer.tsx +40 -26
  124. package/src/components/ObservabilitySettings.tsx +19 -15
  125. package/src/index.ts +1 -2
  126. package/src/meta.ts +2 -2
  127. package/src/translations.ts +1 -0
  128. package/src/types/capabilities.ts +34 -0
  129. package/src/types/events.ts +15 -0
  130. package/src/types/index.ts +2 -0
  131. package/src/types/schema.ts +52 -188
  132. package/dist/lib/browser/app-graph-builder-3I6HZ5AR.mjs +0 -44
  133. package/dist/lib/browser/app-graph-builder-3I6HZ5AR.mjs.map +0 -7
  134. package/dist/lib/browser/chunk-EC7HTFA5.mjs +0 -18
  135. package/dist/lib/browser/chunk-EC7HTFA5.mjs.map +0 -7
  136. package/dist/lib/browser/chunk-RLY6UZDS.mjs +0 -123
  137. package/dist/lib/browser/chunk-RLY6UZDS.mjs.map +0 -7
  138. package/dist/lib/browser/chunk-RRMLEY35.mjs +0 -218
  139. package/dist/lib/browser/chunk-RRMLEY35.mjs.map +0 -7
  140. package/dist/lib/browser/chunk-W7QWKVS3.mjs.map +0 -7
  141. package/dist/lib/browser/client-ready-XT27JB7J.mjs +0 -102
  142. package/dist/lib/browser/client-ready-XT27JB7J.mjs.map +0 -7
  143. package/dist/lib/browser/intent-resolver-QRKGLMMT.mjs +0 -77
  144. package/dist/lib/browser/intent-resolver-QRKGLMMT.mjs.map +0 -7
  145. package/dist/lib/browser/react-surface-F5GY7AAC.mjs +0 -32
  146. package/dist/lib/browser/react-surface-F5GY7AAC.mjs.map +0 -7
  147. package/dist/lib/browser/settings-SAFMS6TG.mjs +0 -25
  148. package/dist/lib/browser/settings-SAFMS6TG.mjs.map +0 -7
  149. package/dist/lib/browser/state-FJD6K3ZZ.mjs +0 -26
  150. package/dist/lib/browser/state-FJD6K3ZZ.mjs.map +0 -7
  151. package/dist/lib/node-esm/app-graph-builder-KH2GA6G7.mjs +0 -45
  152. package/dist/lib/node-esm/app-graph-builder-KH2GA6G7.mjs.map +0 -7
  153. package/dist/lib/node-esm/chunk-AVJTLRX5.mjs.map +0 -7
  154. package/dist/lib/node-esm/chunk-HACSZKXD.mjs +0 -19
  155. package/dist/lib/node-esm/chunk-HACSZKXD.mjs.map +0 -7
  156. package/dist/lib/node-esm/chunk-JJBWCCSZ.mjs +0 -124
  157. package/dist/lib/node-esm/chunk-JJBWCCSZ.mjs.map +0 -7
  158. package/dist/lib/node-esm/chunk-T5OWY73X.mjs +0 -219
  159. package/dist/lib/node-esm/chunk-T5OWY73X.mjs.map +0 -7
  160. package/dist/lib/node-esm/client-ready-AXZXR5EX.mjs +0 -103
  161. package/dist/lib/node-esm/client-ready-AXZXR5EX.mjs.map +0 -7
  162. package/dist/lib/node-esm/intent-resolver-WXZEG7SP.mjs +0 -78
  163. package/dist/lib/node-esm/intent-resolver-WXZEG7SP.mjs.map +0 -7
  164. package/dist/lib/node-esm/react-surface-DNASLRFA.mjs +0 -33
  165. package/dist/lib/node-esm/react-surface-DNASLRFA.mjs.map +0 -7
  166. package/dist/lib/node-esm/settings-22NXJMTF.mjs +0 -26
  167. package/dist/lib/node-esm/settings-22NXJMTF.mjs.map +0 -7
  168. package/dist/lib/node-esm/state-XNBMNLB7.mjs +0 -27
  169. package/dist/lib/node-esm/state-XNBMNLB7.mjs.map +0 -7
  170. package/dist/types/src/capabilities/app-graph-builder.d.ts +0 -4
  171. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +0 -1
  172. package/dist/types/src/capabilities/capabilities.d.ts +0 -12
  173. package/dist/types/src/capabilities/capabilities.d.ts.map +0 -1
  174. package/dist/types/src/capabilities/client-ready.d.ts +0 -10
  175. package/dist/types/src/capabilities/client-ready.d.ts.map +0 -1
  176. package/dist/types/src/capabilities/intent-resolver.d.ts +0 -7
  177. package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
  178. package/dist/types/src/capabilities/react-surface.d.ts +0 -4
  179. package/dist/types/src/capabilities/react-surface.d.ts.map +0 -1
  180. package/dist/types/src/capabilities/settings.d.ts +0 -4
  181. package/dist/types/src/capabilities/settings.d.ts.map +0 -1
  182. package/dist/types/src/capabilities/state.d.ts +0 -6
  183. package/dist/types/src/capabilities/state.d.ts.map +0 -1
  184. package/dist/types/src/events.d.ts +0 -5
  185. package/dist/types/src/events.d.ts.map +0 -1
  186. package/src/capabilities/app-graph-builder.ts +0 -47
  187. package/src/capabilities/capabilities.ts +0 -23
  188. package/src/capabilities/client-ready.ts +0 -98
  189. package/src/capabilities/intent-resolver.ts +0 -69
  190. package/src/capabilities/react-surface.tsx +0 -27
  191. package/src/capabilities/settings.ts +0 -21
  192. package/src/capabilities/state.ts +0 -22
  193. package/src/events.ts +0 -14
@@ -5,21 +5,26 @@
5
5
  import React from 'react';
6
6
 
7
7
  import { useTranslation } from '@dxos/react-ui';
8
- import { Form, type FormRootProps } from '@dxos/react-ui-form';
8
+ import { Form, type FormRootProps, type FormSubmitProps } from '@dxos/react-ui-form';
9
9
 
10
10
  import { meta } from '../meta';
11
11
  import { UserFeedback } from '../types';
12
12
 
13
- export type FeedbackFormProps = Pick<FormRootProps<UserFeedback>, 'onSave'>;
13
+ export type FeedbackFormProps = Pick<FormRootProps<UserFeedback>, 'onSave'> & Pick<FormSubmitProps, 'disabled'>;
14
14
 
15
- export const FeedbackForm = ({ onSave }: FeedbackFormProps) => {
15
+ const defaultValues: UserFeedback = {
16
+ message: '',
17
+ includeLogs: true,
18
+ };
19
+
20
+ export const FeedbackForm = ({ onSave, disabled }: FeedbackFormProps) => {
16
21
  const { t } = useTranslation(meta.id);
17
22
 
18
23
  return (
19
- <Form.Root schema={UserFeedback} onSave={onSave}>
24
+ <Form.Root schema={UserFeedback} defaultValues={defaultValues} onSave={onSave}>
20
25
  <Form.Content>
21
26
  <Form.FieldSet />
22
- <Form.Submit icon='ph--paper-plane-tilt--regular' label={t('send feedback label')} />
27
+ <Form.Submit icon='ph--paper-plane-tilt--regular' label={t('send feedback label')} disabled={disabled} />
23
28
  </Form.Content>
24
29
  </Form.Root>
25
30
  );
@@ -2,41 +2,55 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import * as Function from 'effect/Function';
6
- import React, { useCallback } from 'react';
5
+ import * as Effect from 'effect/Effect';
6
+ import React, { useCallback, useState } from 'react';
7
7
 
8
- import { LayoutAction, chain, createIntent } from '@dxos/app-framework';
9
- import { useIntentDispatcher } from '@dxos/app-framework/react';
8
+ import { useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
9
+ import { LayoutOperation } from '@dxos/app-toolkit';
10
+ import { runAndForwardErrors } from '@dxos/effect';
11
+ import { useAsyncEffect } from '@dxos/react-hooks';
12
+ import { osTranslations } from '@dxos/ui-theme';
10
13
 
11
14
  import { meta } from '../meta';
12
- import { ObservabilityAction, type UserFeedback } from '../types';
15
+ import { ObservabilityCapabilities, ObservabilityOperation, type UserFeedback } from '../types';
13
16
 
14
17
  import { FeedbackForm } from './FeedbackForm';
15
18
 
19
+ /** Renders the feedback form, disabling it when the feedback survey is unavailable. */
16
20
  export const HelpContainer = () => {
17
- const { dispatchPromise: dispatch } = useIntentDispatcher();
21
+ const { invokePromise } = useOperationInvoker();
22
+ const observability = useCapability(ObservabilityCapabilities.Observability);
23
+ const [feedbackAvailable, setFeedbackAvailable] = useState(false);
24
+
25
+ useAsyncEffect(
26
+ async (controller) => {
27
+ const available = await observability.isAvailable('feedback').pipe(
28
+ Effect.catchAll(() => Effect.succeed(false)),
29
+ Effect.catchAllDefect(() => Effect.succeed(false)),
30
+ runAndForwardErrors,
31
+ );
32
+ if (!controller.signal.aborted) {
33
+ setFeedbackAvailable(available);
34
+ }
35
+ },
36
+ [observability],
37
+ );
18
38
 
19
39
  const handleSave = useCallback(
20
- (values: UserFeedback) =>
21
- dispatch(
22
- Function.pipe(
23
- createIntent(ObservabilityAction.CaptureUserFeedback, values),
24
- chain(LayoutAction.UpdateComplementary, { part: 'complementary', options: { state: 'collapsed' } }),
25
- chain(LayoutAction.AddToast, {
26
- part: 'toast',
27
- subject: {
28
- id: `${meta.id}/feedback-success`,
29
- icon: 'ph--paper-plane-tilt--regular',
30
- duration: 3000,
31
- title: ['feedback toast label', { ns: meta.id }],
32
- description: ['feedback toast description', { ns: meta.id }],
33
- closeLabel: ['close label', { ns: 'os' }],
34
- },
35
- }),
36
- ),
37
- ),
38
- [dispatch],
40
+ async (values: UserFeedback) => {
41
+ await invokePromise(ObservabilityOperation.CaptureUserFeedback, values);
42
+ await invokePromise(LayoutOperation.UpdateComplementary, { state: 'collapsed' });
43
+ await invokePromise(LayoutOperation.AddToast, {
44
+ id: `${meta.id}/feedback-success`,
45
+ icon: 'ph--paper-plane-tilt--regular',
46
+ duration: 3000,
47
+ title: ['feedback toast label', { ns: meta.id }],
48
+ description: ['feedback toast description', { ns: meta.id }],
49
+ closeLabel: ['close label', { ns: osTranslations }],
50
+ });
51
+ },
52
+ [invokePromise],
39
53
  );
40
54
 
41
- return <FeedbackForm onSave={handleSave} />;
55
+ return <FeedbackForm onSave={handleSave} disabled={!feedbackAvailable} />;
42
56
  };
@@ -5,13 +5,12 @@
5
5
  import * as Schema from 'effect/Schema';
6
6
  import React from 'react';
7
7
 
8
- import { createIntent } from '@dxos/app-framework';
9
- import { useIntentDispatcher } from '@dxos/app-framework/react';
8
+ import { useOperationInvoker } from '@dxos/app-framework/ui';
10
9
  import { Input, Message, useTranslation } from '@dxos/react-ui';
11
- import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
10
+ import { Settings } from '@dxos/react-ui-form';
12
11
 
13
12
  import { meta } from '../meta';
14
- import { ObservabilityAction } from '../types';
13
+ import { ObservabilityOperation } from '../types';
15
14
 
16
15
  export const ObservabilitySettingsSchema = Schema.mutable(
17
16
  Schema.Struct({
@@ -25,25 +24,30 @@ export const ObservabilitySettingsSchema = Schema.mutable(
25
24
 
26
25
  export type ObservabilitySettingsProps = Schema.Schema.Type<typeof ObservabilitySettingsSchema>;
27
26
 
28
- export const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {
27
+ export type ObservabilitySettingsComponentProps = {
28
+ settings: ObservabilitySettingsProps;
29
+ onSettingsChange: (fn: (current: ObservabilitySettingsProps) => ObservabilitySettingsProps) => void;
30
+ };
31
+
32
+ export const ObservabilitySettings = ({ settings }: ObservabilitySettingsComponentProps) => {
29
33
  const { t } = useTranslation(meta.id);
30
- const { dispatchPromise: dispatch } = useIntentDispatcher();
34
+ const { invokePromise } = useOperationInvoker();
31
35
 
32
36
  return (
33
- <ControlPage>
34
- <ControlSection title={t('settings title', { ns: meta.id })}>
37
+ <Settings.Root>
38
+ <Settings.Section title={t('settings title', { ns: meta.id })}>
35
39
  <Message.Root valence='info' classNames='container-max-width mbe-cardSpacingBlock'>
36
40
  <Message.Content>{t('observability description')}</Message.Content>
37
41
  </Message.Root>
38
- <ControlGroup>
39
- <ControlItemInput title={t('observability enabled label')}>
42
+ <Settings.Group>
43
+ <Settings.ItemInput title={t('observability enabled label')}>
40
44
  <Input.Switch
41
45
  checked={settings.enabled}
42
- onCheckedChange={(checked) => dispatch(createIntent(ObservabilityAction.Toggle, { state: !!checked }))}
46
+ onCheckedChange={(checked) => invokePromise(ObservabilityOperation.Toggle, { state: !!checked })}
43
47
  />
44
- </ControlItemInput>
45
- </ControlGroup>
46
- </ControlSection>
47
- </ControlPage>
48
+ </Settings.ItemInput>
49
+ </Settings.Group>
50
+ </Settings.Section>
51
+ </Settings.Root>
48
52
  );
49
53
  };
package/src/index.ts CHANGED
@@ -2,8 +2,7 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- export { ObservabilityCapabilities } from './capabilities';
6
- export { ObservabilityEvents } from './events';
5
+ export { ObservabilityCapabilities, ObservabilityEvents } from './types';
7
6
  export * from './components';
8
7
  export * from './meta';
9
8
  export * from './ObservabilityPlugin';
package/src/meta.ts CHANGED
@@ -2,10 +2,10 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { type PluginMeta } from '@dxos/app-framework';
5
+ import { type Plugin } from '@dxos/app-framework';
6
6
  import { trim } from '@dxos/util';
7
7
 
8
- export const meta: PluginMeta = {
8
+ export const meta: Plugin.Meta = {
9
9
  id: 'dxos.org/plugin/observability',
10
10
  name: 'Telemetry',
11
11
  description: trim`
@@ -26,6 +26,7 @@ export const translations = [
26
26
  'help label': 'Feedback & Support',
27
27
  'feedback textarea label': 'Feedback',
28
28
  'feedback textarea placeholder': 'Please enter your feedback, technical issue, or feature request.',
29
+ 'include debug logs label': 'Include debug logs',
29
30
  'send feedback label': 'Send Feedback',
30
31
  'feedback toast label': 'Thank you for your feedback!',
31
32
  'feedback toast description': 'We will review your feedback and get back to you as soon as possible.',
@@ -0,0 +1,34 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type Atom } from '@effect-atom/atom-react';
6
+ import * as Schema from 'effect/Schema';
7
+
8
+ import { Capability } from '@dxos/app-framework';
9
+ import { type Client } from '@dxos/client';
10
+ import { type Observability } from '@dxos/observability';
11
+
12
+ import { type ObservabilitySettingsProps } from '../components';
13
+ import { meta } from '../meta';
14
+
15
+ export namespace ObservabilityCapabilities {
16
+ export const Settings = Capability.make<Atom.Writable<ObservabilitySettingsProps>>(`${meta.id}/capability/settings`);
17
+
18
+ export const StateSchema = Schema.mutable(
19
+ Schema.Struct({
20
+ group: Schema.optional(Schema.String),
21
+ notified: Schema.optional(Schema.Boolean),
22
+ }),
23
+ );
24
+
25
+ export type State = Schema.Schema.Type<typeof StateSchema>;
26
+
27
+ export const State = Capability.make<Atom.Writable<State>>(`${meta.id}/capability/state`);
28
+
29
+ export const Observability = Capability.make<Observability.Observability>(`${meta.id}/capability/observability`);
30
+ }
31
+
32
+ // NOTE: This is cloned from the client plugin to avoid circular dependencies.
33
+ // TODO(burdon): Figure out how to share defs.
34
+ export const ClientCapability = Capability.make<Client>('dxos.org/plugin/client/capability/client');
@@ -0,0 +1,15 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { ActivationEvent } from '@dxos/app-framework';
6
+ import { AppActivationEvents } from '@dxos/app-toolkit';
7
+
8
+ import { meta } from '../meta';
9
+
10
+ export namespace ObservabilityEvents {
11
+ export const StateReady: ActivationEvent.ActivationEvent = AppActivationEvents.createStateEvent(meta.id);
12
+ }
13
+
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');
@@ -2,4 +2,6 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
+ export * from './capabilities';
6
+ export * from './events';
5
7
  export * from './schema';
@@ -4,7 +4,9 @@
4
4
 
5
5
  import * as Schema from 'effect/Schema';
6
6
 
7
- import { Format, Key } from '@dxos/echo';
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { Format } from '@dxos/echo';
9
+ import { Operation } from '@dxos/operation';
8
10
 
9
11
  import { meta } from '../meta';
10
12
  import { translations } from '../translations';
@@ -20,201 +22,63 @@ export const UserFeedback = Schema.Struct({
20
22
  description: t['feedback textarea placeholder'],
21
23
  }),
22
24
  ),
25
+ includeLogs: Schema.Boolean.pipe(
26
+ Schema.annotations({
27
+ title: t['include debug logs label'],
28
+ }),
29
+ Schema.optional,
30
+ ),
23
31
  });
24
32
 
25
33
  export type UserFeedback = Schema.Schema.Type<typeof UserFeedback>;
26
34
 
27
- export namespace ObservabilityAction {
28
- export class Toggle extends Schema.TaggedClass<Toggle>()(`${meta.id}/action/toggle`, {
29
- input: Schema.Struct({
30
- state: Schema.optional(Schema.Boolean),
31
- }),
32
- output: Schema.Boolean,
33
- }) {}
35
+ const OBSERVABILITY_OPERATION = `${meta.id}/operation`;
36
+
37
+ /**
38
+ * Operations for the Observability plugin.
39
+ */
40
+ export namespace ObservabilityOperation {
41
+ export const Toggle = Operation.make({
42
+ meta: {
43
+ key: `${OBSERVABILITY_OPERATION}/toggle`,
44
+ name: 'Toggle Observability',
45
+ description: 'Toggle observability on or off.',
46
+ },
47
+ services: [Capability.Service],
48
+ schema: {
49
+ input: Schema.Struct({
50
+ state: Schema.optional(Schema.Boolean),
51
+ }),
52
+ output: Schema.Boolean,
53
+ },
54
+ });
34
55
 
35
- export class CaptureUserFeedback extends Schema.TaggedClass<CaptureUserFeedback>()(
36
- `${meta.id}/action/capture-feedback`,
37
- {
56
+ export const CaptureUserFeedback = Operation.make({
57
+ meta: {
58
+ key: `${OBSERVABILITY_OPERATION}/capture-feedback`,
59
+ name: 'Capture User Feedback',
60
+ description: 'Capture user feedback.',
61
+ },
62
+ services: [Capability.Service],
63
+ schema: {
38
64
  input: UserFeedback,
39
65
  output: Schema.Void,
40
66
  },
41
- ) {}
67
+ });
42
68
 
43
- /** Base intent for sending events. */
44
- export class BaseSendEvent extends Schema.TaggedClass<BaseSendEvent>()(`${meta.id}/action/send-event`, {
45
- input: Schema.Struct({
46
- name: Schema.String,
47
- properties: Schema.optional(Schema.Object),
48
- }),
49
- output: Schema.Void,
50
- }) {}
51
-
52
- /** Intent with strict types for first-party events. */
53
- export class SendEvent extends Schema.TaggedClass<SendEvent>()(`${meta.id}/action/send-event`, {
54
- // NOTE: Sort alphabetically by name.
55
- input: Schema.Union(
56
- Schema.Struct({
57
- name: Schema.Literal('identity.create'),
58
- }),
59
- Schema.Struct({
60
- name: Schema.Literal('identity.join'),
61
- }),
62
- Schema.Struct({
63
- name: Schema.Literal('identity.recover'),
64
- }),
65
- Schema.Struct({
66
- name: Schema.Literal('identity.share'),
67
- }),
68
- Schema.Struct({
69
- name: Schema.Literal('navigation.activate'),
70
- properties: Schema.Struct({
71
- subjectId: Schema.String,
72
- typename: Schema.optional(Schema.String),
73
- }),
74
- }),
75
- Schema.Struct({
76
- name: Schema.Literal('page.load'),
77
- properties: Schema.Struct({
78
- loadDuration: Schema.Number,
79
- }),
80
- }),
81
- Schema.Struct({
82
- name: Schema.Literal('plugins.toggle'),
83
- properties: Schema.Struct({
84
- plugin: Schema.String,
85
- enabled: Schema.Boolean,
86
- }),
87
- }),
88
- Schema.Struct({
89
- name: Schema.Literal('space.create'),
90
- properties: Schema.Struct({
91
- spaceId: Key.SpaceId,
92
- }),
93
- }),
94
- Schema.Struct({
95
- name: Schema.Literal('space.join'),
96
- properties: Schema.Struct({
97
- spaceId: Key.SpaceId,
98
- }),
99
- }),
100
- Schema.Struct({
101
- name: Schema.Literal('space.limit'),
102
- properties: Schema.Struct({
103
- spaceId: Key.SpaceId,
104
- }),
105
- }),
106
- Schema.Struct({
107
- name: Schema.Literal('space.lock'),
108
- properties: Schema.Struct({
109
- spaceId: Key.SpaceId,
110
- }),
111
- }),
112
- Schema.Struct({
113
- name: Schema.Literal('space.migrate'),
114
- properties: Schema.Struct({
115
- spaceId: Key.SpaceId,
116
- targetVersion: Schema.optional(Schema.String),
117
- version: Schema.optional(Schema.String),
118
- }),
119
- }),
120
- Schema.Struct({
121
- name: Schema.Literal('space.schema.use'),
122
- properties: Schema.Struct({
123
- spaceId: Key.SpaceId,
124
- typename: Schema.String,
125
- }),
126
- }),
127
- Schema.Struct({
128
- name: Schema.Literal('space.schema.add'),
129
- properties: Schema.Struct({
130
- spaceId: Key.SpaceId,
131
- objectId: Schema.String,
132
- typename: Schema.String,
133
- }),
134
- }),
135
- Schema.Struct({
136
- name: Schema.Literal('space.object.add'),
137
- properties: Schema.Struct({
138
- spaceId: Key.SpaceId,
139
- objectId: Schema.String,
140
- typename: Schema.optional(Schema.String),
141
- }),
142
- }),
143
- Schema.Struct({
144
- name: Schema.Literal('space.share'),
145
- properties: Schema.Struct({
146
- spaceId: Key.SpaceId,
147
- }),
148
- }),
149
- Schema.Struct({
150
- name: Schema.Literal('space.unlock'),
151
- properties: Schema.Struct({
152
- spaceId: Key.SpaceId,
153
- }),
154
- }),
155
- Schema.Struct({
156
- name: Schema.Literal('threads.create'),
157
- properties: Schema.Struct({
158
- spaceId: Key.SpaceId,
159
- threadId: Schema.String,
160
- }),
161
- }),
162
- Schema.Struct({
163
- name: Schema.Literal('threads.delete'),
164
- properties: Schema.Struct({
165
- spaceId: Key.SpaceId,
166
- threadId: Schema.String,
167
- }),
168
- }),
169
- Schema.Struct({
170
- name: Schema.Literal('threads.message.add'),
171
- properties: Schema.Struct({
172
- spaceId: Key.SpaceId,
173
- threadId: Schema.String,
174
- threadLength: Schema.Number,
175
- messageId: Schema.String,
176
- messageLength: Schema.Number,
177
- }),
178
- }),
179
- Schema.Struct({
180
- name: Schema.Literal('threads.message.delete'),
181
- properties: Schema.Struct({
182
- spaceId: Key.SpaceId,
183
- threadId: Schema.String,
184
- messageId: Schema.String,
185
- }),
186
- }),
187
- Schema.Struct({
188
- name: Schema.Literal('threads.message.undo-delete'),
189
- properties: Schema.Struct({
190
- spaceId: Key.SpaceId,
191
- threadId: Schema.String,
192
- messageId: Schema.String,
193
- }),
194
- }),
195
- Schema.Struct({
196
- name: Schema.Literal('threads.message.update'),
197
- properties: Schema.Struct({
198
- spaceId: Key.SpaceId,
199
- messageId: Schema.String,
200
- messageLength: Schema.Number,
201
- }),
202
- }),
203
- Schema.Struct({
204
- name: Schema.Literal('threads.toggle-resolved'),
205
- properties: Schema.Struct({
206
- spaceId: Key.SpaceId,
207
- threadId: Schema.String,
208
- }),
209
- }),
210
- Schema.Struct({
211
- name: Schema.Literal('threads.undo-delete'),
212
- properties: Schema.Struct({
213
- spaceId: Key.SpaceId,
214
- threadId: Schema.String,
215
- }),
69
+ export const SendEvent = Operation.make({
70
+ meta: {
71
+ key: `${OBSERVABILITY_OPERATION}/send-event`,
72
+ name: 'Send Event',
73
+ description: 'Send an observability event.',
74
+ },
75
+ services: [Capability.Service],
76
+ schema: {
77
+ input: Schema.Struct({
78
+ name: Schema.String.annotations({ description: 'The name of the event.' }),
79
+ properties: Schema.optional(Schema.Any).annotations({ description: 'Event properties.' }),
216
80
  }),
217
- ),
218
- output: Schema.Void,
219
- }) {}
81
+ output: Schema.Void,
82
+ },
83
+ });
220
84
  }
@@ -1,44 +0,0 @@
1
- import {
2
- meta
3
- } from "./chunk-W7QWKVS3.mjs";
4
-
5
- // src/capabilities/app-graph-builder.ts
6
- import { Atom } from "@effect-atom/atom-react";
7
- import * as Function from "effect/Function";
8
- import * as Option from "effect/Option";
9
- import { Capabilities, contributes } from "@dxos/app-framework";
10
- import { ROOT_ID, createExtension } from "@dxos/plugin-graph";
11
- var ATTENDABLE_PATH_SEPARATOR = "~";
12
- var DECK_COMPANION_TYPE = "dxos.org/plugin/deck/deck-companion";
13
- var app_graph_builder_default = ((_context) => contributes(Capabilities.AppGraphBuilder, [
14
- createExtension({
15
- id: `${meta.id}/help`,
16
- connector: (node) => Atom.make((get) => Function.pipe(get(node), Option.flatMap((node2) => node2.id === ROOT_ID ? Option.some(node2) : Option.none()), Option.map((node2) => {
17
- return [
18
- {
19
- id: [
20
- node2.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
- }), Option.getOrElse(() => [])))
39
- })
40
- ]));
41
- export {
42
- app_graph_builder_default as default
43
- };
44
- //# sourceMappingURL=app-graph-builder-3I6HZ5AR.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Atom } from '@effect-atom/atom-react';\nimport * as Function from 'effect/Function';\nimport * as Option from 'effect/Option';\n\nimport { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';\nimport { ROOT_ID, createExtension } 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 (_context: PluginContext) =>\n contributes(Capabilities.AppGraphBuilder, [\n createExtension({\n id: `${meta.id}/help`,\n connector: (node) =>\n Atom.make((get) =>\n Function.pipe(\n get(node),\n Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n Option.map((node) => {\n return [\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 Option.getOrElse(() => []),\n ),\n ),\n }),\n ]);\n"],
5
- "mappings": ";;;;;AAIA,SAASA,YAAY;AACrB,YAAYC,cAAc;AAC1B,YAAYC,YAAY;AAExB,SAASC,cAAkCC,mBAAmB;AAC9D,SAASC,SAASC,uBAAuB;AAKzC,IAAMC,4BAA4B;AAElC,IAAMC,sBAAsB;AAE5B,IAAA,6BAAe,CAACC,aACdC,YAAYC,aAAaC,iBAAiB;EACxCC,gBAAgB;IACdC,IAAI,GAAGC,KAAKD,EAAE;IACdE,WAAW,CAACC,SACVC,KAAKC,KAAK,CAACC,QACAC,cACPD,IAAIH,IAAAA,GACGK,eAAQ,CAACL,UAAUA,MAAKH,OAAOS,UAAiBC,YAAKP,KAAAA,IAAeQ,YAAI,CAAA,GACxEC,WAAI,CAACT,UAAAA;AACV,aAAO;QACL;UACEH,IAAI;YAACG,MAAKH;YAAI;YAAQa,KAAKpB,yBAAAA;UAC3BqB,MAAMpB;UACNqB,MAAM;UACNC,YAAY;YACVC,OAAO;cAAC;cAAc;gBAAEC,IAAIjB,KAAKD;cAAG;;YACpCmB,MAAM;YACNC,aAAa;YACbC,UAAU;UACZ;QACF;;IAEJ,CAAA,GACOC,iBAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;CACD;",
6
- "names": ["Atom", "Function", "Option", "Capabilities", "contributes", "ROOT_ID", "createExtension", "ATTENDABLE_PATH_SEPARATOR", "DECK_COMPANION_TYPE", "_context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "meta", "connector", "node", "Atom", "make", "get", "pipe", "flatMap", "ROOT_ID", "some", "none", "map", "join", "type", "data", "properties", "label", "ns", "icon", "disposition", "position", "getOrElse"]
7
- }
@@ -1,18 +0,0 @@
1
- import {
2
- meta
3
- } from "./chunk-W7QWKVS3.mjs";
4
-
5
- // src/capabilities/capabilities.ts
6
- import { defineCapability } from "@dxos/app-framework";
7
- (function(ObservabilityCapabilities2) {
8
- ObservabilityCapabilities2.State = defineCapability(`${meta.id}/capability/state`);
9
- ObservabilityCapabilities2.Observability = defineCapability(`${meta.id}/capability/observability`);
10
- })(ObservabilityCapabilities || (ObservabilityCapabilities = {}));
11
- var ClientCapability = defineCapability("dxos.org/plugin/client/capability/client");
12
- var ObservabilityCapabilities;
13
-
14
- export {
15
- ClientCapability,
16
- ObservabilityCapabilities
17
- };
18
- //# sourceMappingURL=chunk-EC7HTFA5.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/capabilities.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineCapability } from '@dxos/app-framework';\nimport { type Client } from '@dxos/client';\nimport { type Observability } from '@dxos/observability';\n\nimport { meta } from '../meta';\n\nexport namespace ObservabilityCapabilities {\n export type State = {\n group?: string;\n notified?: boolean;\n };\n export const State = defineCapability<State>(`${meta.id}/capability/state`);\n\n export const Observability = defineCapability<Observability>(`${meta.id}/capability/observability`);\n}\n\n// NOTE: This is cloned from the client plugin to avoid circular dependencies.\n// TODO(burdon): Figure out how to share defs.\nexport const ClientCapability = defineCapability<Client>('dxos.org/plugin/client/capability/client');\n"],
5
- "mappings": ";;;;;AAIA,SAASA,wBAAwB;UAMhBC,4BAAAA;6BAKFC,QAAQC,iBAAwB,GAAGC,KAAKC,EAAE,mBAAmB;6BAE7DC,gBAAgBH,iBAAgC,GAAGC,KAAKC,EAAE,2BAA2B;AACpG,GARiBJ,8BAAAA,4BAAAA,CAAAA,EAAAA;AAYV,IAAMM,mBAAmBJ,iBAAyB,0CAAA;;",
6
- "names": ["defineCapability", "ObservabilityCapabilities", "State", "defineCapability", "meta", "id", "Observability", "ClientCapability"]
7
- }