@dxos/plugin-observability 0.8.4-main.ae835ea → 0.8.4-main.bc674ce

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 (191) hide show
  1. package/dist/lib/browser/app-graph-builder-6KDHLPUO.mjs +44 -0
  2. package/dist/lib/browser/app-graph-builder-6KDHLPUO.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-PYNLPSSZ.mjs +133 -0
  6. package/dist/lib/browser/chunk-PYNLPSSZ.mjs.map +7 -0
  7. package/dist/lib/browser/chunk-SN7DIHQG.mjs +102 -0
  8. package/dist/lib/browser/chunk-SN7DIHQG.mjs.map +7 -0
  9. package/dist/lib/browser/cli/index.mjs +23 -0
  10. package/dist/lib/browser/cli/index.mjs.map +7 -0
  11. package/dist/lib/browser/client-ready-YWKHC5S2.mjs +107 -0
  12. package/dist/lib/browser/client-ready-YWKHC5S2.mjs.map +7 -0
  13. package/dist/lib/browser/index.mjs +72 -102
  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-4ROZET3B.mjs +82 -0
  17. package/dist/lib/browser/operation-resolver-4ROZET3B.mjs.map +7 -0
  18. package/dist/lib/browser/react-surface-SJTESQAF.mjs +37 -0
  19. package/dist/lib/browser/react-surface-SJTESQAF.mjs.map +7 -0
  20. package/dist/lib/browser/settings-SQ4ICR7F.mjs +35 -0
  21. package/dist/lib/browser/settings-SQ4ICR7F.mjs.map +7 -0
  22. package/dist/lib/browser/state-IKCFXHYV.mjs +31 -0
  23. package/dist/lib/browser/state-IKCFXHYV.mjs.map +7 -0
  24. package/dist/lib/browser/types/index.mjs +12 -4
  25. package/dist/lib/node-esm/app-graph-builder-4YHKY4SP.mjs +45 -0
  26. package/dist/lib/node-esm/app-graph-builder-4YHKY4SP.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-4T4N2NJZ.mjs +134 -0
  30. package/dist/lib/node-esm/chunk-4T4N2NJZ.mjs.map +7 -0
  31. package/dist/lib/node-esm/chunk-HNMV7ZZZ.mjs +103 -0
  32. package/dist/lib/node-esm/chunk-HNMV7ZZZ.mjs.map +7 -0
  33. package/dist/lib/node-esm/cli/index.mjs +24 -0
  34. package/dist/lib/node-esm/cli/index.mjs.map +7 -0
  35. package/dist/lib/node-esm/client-ready-YLYG6F6H.mjs +108 -0
  36. package/dist/lib/node-esm/client-ready-YLYG6F6H.mjs.map +7 -0
  37. package/dist/lib/node-esm/index.mjs +72 -102
  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-UI7ZINXR.mjs +83 -0
  41. package/dist/lib/node-esm/operation-resolver-UI7ZINXR.mjs.map +7 -0
  42. package/dist/lib/node-esm/react-surface-D53VLGHY.mjs +38 -0
  43. package/dist/lib/node-esm/react-surface-D53VLGHY.mjs.map +7 -0
  44. package/dist/lib/node-esm/settings-WIRCHLWE.mjs +36 -0
  45. package/dist/lib/node-esm/settings-WIRCHLWE.mjs.map +7 -0
  46. package/dist/lib/node-esm/state-MQR4PNOT.mjs +32 -0
  47. package/dist/lib/node-esm/state-MQR4PNOT.mjs.map +7 -0
  48. package/dist/lib/node-esm/types/index.mjs +12 -4
  49. package/dist/types/src/ObservabilityPlugin.d.ts +2 -1
  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 +6 -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 +9 -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 +34 -0
  84. package/dist/types/src/components/FeedbackForm.stories.d.ts.map +1 -0
  85. package/dist/types/src/components/HelpContainer.d.ts.map +1 -1
  86. package/dist/types/src/components/ObservabilitySettings.d.ts +4 -2
  87. package/dist/types/src/components/ObservabilitySettings.d.ts.map +1 -1
  88. package/dist/types/src/index.d.ts +1 -2
  89. package/dist/types/src/index.d.ts.map +1 -1
  90. package/dist/types/src/meta.d.ts +2 -2
  91. package/dist/types/src/meta.d.ts.map +1 -1
  92. package/dist/types/src/translations.d.ts +2 -2
  93. package/dist/types/src/types/capabilities.d.ts +27 -0
  94. package/dist/types/src/types/capabilities.d.ts.map +1 -0
  95. package/dist/types/src/types/events.d.ts +6 -0
  96. package/dist/types/src/types/events.d.ts.map +1 -0
  97. package/dist/types/src/types/index.d.ts +2 -0
  98. package/dist/types/src/types/index.d.ts.map +1 -1
  99. package/dist/types/src/types/schema.d.ts +55 -307
  100. package/dist/types/src/types/schema.d.ts.map +1 -1
  101. package/dist/types/tsconfig.tsbuildinfo +1 -1
  102. package/package.json +43 -33
  103. package/src/ObservabilityPlugin.ts +45 -45
  104. package/src/capabilities/app-graph-builder/app-graph-builder.ts +42 -0
  105. package/src/capabilities/app-graph-builder/index.ts +7 -0
  106. package/src/capabilities/client-ready/client-ready.ts +97 -0
  107. package/src/capabilities/client-ready/index.ts +7 -0
  108. package/src/capabilities/index.ts +6 -10
  109. package/src/capabilities/operation-resolver/index.ts +7 -0
  110. package/src/capabilities/operation-resolver/operation-resolver.ts +82 -0
  111. package/src/capabilities/react-surface/index.ts +7 -0
  112. package/src/capabilities/react-surface/react-surface.tsx +34 -0
  113. package/src/capabilities/settings/index.ts +7 -0
  114. package/src/capabilities/settings/settings.ts +33 -0
  115. package/src/capabilities/state/index.ts +7 -0
  116. package/src/capabilities/state/state.ts +30 -0
  117. package/src/cli/index.ts +5 -0
  118. package/src/cli/plugin.ts +27 -0
  119. package/src/components/FeedbackForm.stories.tsx +33 -0
  120. package/src/components/FeedbackForm.tsx +11 -67
  121. package/src/components/HelpContainer.tsx +18 -23
  122. package/src/components/ObservabilitySettings.tsx +10 -5
  123. package/src/index.ts +1 -2
  124. package/src/meta.ts +2 -2
  125. package/src/translations.ts +2 -2
  126. package/src/types/capabilities.ts +34 -0
  127. package/src/types/events.ts +14 -0
  128. package/src/types/index.ts +2 -0
  129. package/src/types/schema.ts +56 -194
  130. package/dist/lib/browser/app-graph-builder-4VCXIPB7.mjs +0 -44
  131. package/dist/lib/browser/app-graph-builder-4VCXIPB7.mjs.map +0 -7
  132. package/dist/lib/browser/chunk-EC7HTFA5.mjs +0 -18
  133. package/dist/lib/browser/chunk-EC7HTFA5.mjs.map +0 -7
  134. package/dist/lib/browser/chunk-GJWFKBKM.mjs +0 -179
  135. package/dist/lib/browser/chunk-GJWFKBKM.mjs.map +0 -7
  136. package/dist/lib/browser/chunk-IFPEPNGO.mjs +0 -191
  137. package/dist/lib/browser/chunk-IFPEPNGO.mjs.map +0 -7
  138. package/dist/lib/browser/chunk-W7QWKVS3.mjs.map +0 -7
  139. package/dist/lib/browser/client-ready-4RGNCIGS.mjs +0 -102
  140. package/dist/lib/browser/client-ready-4RGNCIGS.mjs.map +0 -7
  141. package/dist/lib/browser/intent-resolver-3TZAFHGG.mjs +0 -77
  142. package/dist/lib/browser/intent-resolver-3TZAFHGG.mjs.map +0 -7
  143. package/dist/lib/browser/react-surface-NLKDFJBB.mjs +0 -32
  144. package/dist/lib/browser/react-surface-NLKDFJBB.mjs.map +0 -7
  145. package/dist/lib/browser/settings-27DLWAXK.mjs +0 -25
  146. package/dist/lib/browser/settings-27DLWAXK.mjs.map +0 -7
  147. package/dist/lib/browser/state-FJD6K3ZZ.mjs +0 -26
  148. package/dist/lib/browser/state-FJD6K3ZZ.mjs.map +0 -7
  149. package/dist/lib/node-esm/app-graph-builder-C4UWA6OD.mjs +0 -45
  150. package/dist/lib/node-esm/app-graph-builder-C4UWA6OD.mjs.map +0 -7
  151. package/dist/lib/node-esm/chunk-AVJTLRX5.mjs.map +0 -7
  152. package/dist/lib/node-esm/chunk-HACSZKXD.mjs +0 -19
  153. package/dist/lib/node-esm/chunk-HACSZKXD.mjs.map +0 -7
  154. package/dist/lib/node-esm/chunk-JNYBWNIA.mjs +0 -180
  155. package/dist/lib/node-esm/chunk-JNYBWNIA.mjs.map +0 -7
  156. package/dist/lib/node-esm/chunk-TXFKNLDI.mjs +0 -192
  157. package/dist/lib/node-esm/chunk-TXFKNLDI.mjs.map +0 -7
  158. package/dist/lib/node-esm/client-ready-4IKY5KJC.mjs +0 -103
  159. package/dist/lib/node-esm/client-ready-4IKY5KJC.mjs.map +0 -7
  160. package/dist/lib/node-esm/intent-resolver-5D5SXGKQ.mjs +0 -78
  161. package/dist/lib/node-esm/intent-resolver-5D5SXGKQ.mjs.map +0 -7
  162. package/dist/lib/node-esm/react-surface-SGL7HXM3.mjs +0 -33
  163. package/dist/lib/node-esm/react-surface-SGL7HXM3.mjs.map +0 -7
  164. package/dist/lib/node-esm/settings-P4EHRXYR.mjs +0 -26
  165. package/dist/lib/node-esm/settings-P4EHRXYR.mjs.map +0 -7
  166. package/dist/lib/node-esm/state-XNBMNLB7.mjs +0 -27
  167. package/dist/lib/node-esm/state-XNBMNLB7.mjs.map +0 -7
  168. package/dist/types/src/capabilities/app-graph-builder.d.ts +0 -4
  169. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +0 -1
  170. package/dist/types/src/capabilities/capabilities.d.ts +0 -12
  171. package/dist/types/src/capabilities/capabilities.d.ts.map +0 -1
  172. package/dist/types/src/capabilities/client-ready.d.ts +0 -10
  173. package/dist/types/src/capabilities/client-ready.d.ts.map +0 -1
  174. package/dist/types/src/capabilities/intent-resolver.d.ts +0 -7
  175. package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
  176. package/dist/types/src/capabilities/react-surface.d.ts +0 -4
  177. package/dist/types/src/capabilities/react-surface.d.ts.map +0 -1
  178. package/dist/types/src/capabilities/settings.d.ts +0 -4
  179. package/dist/types/src/capabilities/settings.d.ts.map +0 -1
  180. package/dist/types/src/capabilities/state.d.ts +0 -6
  181. package/dist/types/src/capabilities/state.d.ts.map +0 -1
  182. package/dist/types/src/events.d.ts +0 -5
  183. package/dist/types/src/events.d.ts.map +0 -1
  184. package/src/capabilities/app-graph-builder.ts +0 -47
  185. package/src/capabilities/capabilities.ts +0 -23
  186. package/src/capabilities/client-ready.ts +0 -98
  187. package/src/capabilities/intent-resolver.ts +0 -69
  188. package/src/capabilities/react-surface.tsx +0 -27
  189. package/src/capabilities/settings.ts +0 -21
  190. package/src/capabilities/state.ts +0 -22
  191. package/src/events.ts +0 -14
@@ -0,0 +1,33 @@
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 { FeedbackForm } from './FeedbackForm';
12
+
13
+ const meta = {
14
+ title: 'plugins/plugin-observability/FeedbackForm',
15
+ component: FeedbackForm,
16
+ decorators: [withTheme, withLayout({ layout: 'column' })],
17
+ parameters: {
18
+ layout: 'fullscreen',
19
+ translations,
20
+ },
21
+ } satisfies Meta<typeof FeedbackForm>;
22
+
23
+ export default meta;
24
+
25
+ type Story = StoryObj<typeof meta>;
26
+
27
+ export const Default: Story = {
28
+ args: {
29
+ onSave: (values) => {
30
+ console.log(values);
31
+ },
32
+ },
33
+ };
@@ -2,81 +2,25 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import React, { useCallback, useRef, useState } from 'react';
5
+ import React from 'react';
6
6
 
7
- import { getSnapshot } from '@dxos/echo/internal';
8
- import { IconButton, Input, useTranslation } from '@dxos/react-ui';
9
- import { FormProvider, useFormContext, useInputProps } from '@dxos/react-ui-form';
7
+ import { useTranslation } from '@dxos/react-ui';
8
+ import { Form, type FormRootProps } from '@dxos/react-ui-form';
10
9
 
11
10
  import { meta } from '../meta';
12
11
  import { UserFeedback } from '../types';
13
12
 
14
- const defaultValues: UserFeedback = { message: '' };
13
+ export type FeedbackFormProps = Pick<FormRootProps<UserFeedback>, 'onSave'>;
15
14
 
16
- const FormContent = () => {
15
+ export const FeedbackForm = ({ onSave }: FeedbackFormProps) => {
17
16
  const { t } = useTranslation(meta.id);
18
- const { handleSave, canSave } = useFormContext<UserFeedback>();
19
-
20
- const messageProps = useInputProps(['message']);
21
-
22
- return (
23
- <div role='form' className='p-3 flex flex-col gap-2'>
24
- <div role='none' className='space-b-1'>
25
- <Input.Root validationValence={messageProps.getStatus().status}>
26
- <Input.Label>{t('feedback text area label')}</Input.Label>
27
- <Input.TextArea
28
- classNames={'text-sm'}
29
- rows={5}
30
- cols={30}
31
- placeholder={t('feedback text area placeholder')}
32
- value={messageProps.getValue() ?? ''}
33
- onChange={(e) => messageProps.onValueChange('string', e.target.value)}
34
- // TODO(wittjosiah): This aggressively shows validation errors.
35
- onBlur={messageProps.onBlur}
36
- />
37
- <Input.DescriptionAndValidation>
38
- <Input.Validation>{messageProps.getStatus().error}</Input.Validation>
39
- </Input.DescriptionAndValidation>
40
- </Input.Root>
41
- </div>
42
-
43
- <div role='none' className='space-b-2'>
44
- <IconButton
45
- icon='ph--paper-plane-tilt--regular'
46
- label={t('send feedback label')}
47
- variant='primary'
48
- type='submit'
49
- classNames='is-full'
50
- disabled={!canSave}
51
- onClick={handleSave}
52
- />
53
- </div>
54
- </div>
55
- );
56
- };
57
-
58
- // TODO(wittjosiah): Use `Form`?
59
- export const FeedbackForm = ({ onSave }: { onSave: (values: UserFeedback) => void }) => {
60
- const formRef = useRef<HTMLDivElement>(null);
61
- const [_, update] = useState({});
62
- const forceRender = useCallback(() => update({}), [update]);
63
-
64
- const handleSave = useCallback(
65
- (values: UserFeedback) => {
66
- onSave(values);
67
- // TODO(wittjosiah): Force re-render to clear the form.
68
- forceRender();
69
- },
70
- [forceRender, onSave],
71
- );
72
-
73
- const initialValues = getSnapshot(defaultValues);
74
17
 
75
18
  return (
76
- <FormProvider formRef={formRef} schema={UserFeedback} initialValues={initialValues} onSave={handleSave}>
77
- <div ref={formRef}>
78
- <FormContent />
79
- </div>
80
- </FormProvider>
19
+ <Form.Root schema={UserFeedback} onSave={onSave}>
20
+ <Form.Content>
21
+ <Form.FieldSet />
22
+ <Form.Submit icon='ph--paper-plane-tilt--regular' label={t('send feedback label')} />
23
+ </Form.Content>
24
+ </Form.Root>
81
25
  );
82
26
  };
@@ -2,39 +2,34 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import * as Function from 'effect/Function';
6
5
  import React, { useCallback } from 'react';
7
6
 
8
- import { LayoutAction, chain, createIntent, useIntentDispatcher } from '@dxos/app-framework';
7
+ import { Common } from '@dxos/app-framework';
8
+ import { useOperationInvoker } from '@dxos/app-framework/react';
9
+ import { osTranslations } from '@dxos/ui-theme';
9
10
 
10
11
  import { meta } from '../meta';
11
- import { ObservabilityAction, type UserFeedback } from '../types';
12
+ import { ObservabilityOperation, type UserFeedback } from '../types';
12
13
 
13
14
  import { FeedbackForm } from './FeedbackForm';
14
15
 
15
16
  export const HelpContainer = () => {
16
- const { dispatchPromise: dispatch } = useIntentDispatcher();
17
+ const { invokePromise } = useOperationInvoker();
17
18
 
18
19
  const handleSave = useCallback(
19
- (values: UserFeedback) =>
20
- dispatch(
21
- Function.pipe(
22
- createIntent(ObservabilityAction.CaptureUserFeedback, values),
23
- chain(LayoutAction.UpdateComplementary, { part: 'complementary', options: { state: 'collapsed' } }),
24
- chain(LayoutAction.AddToast, {
25
- part: 'toast',
26
- subject: {
27
- id: `${meta.id}/feedback-success`,
28
- icon: 'ph--paper-plane-tilt--regular',
29
- duration: 3000,
30
- title: ['feedback toast label', { ns: meta.id }],
31
- description: ['feedback toast description', { ns: meta.id }],
32
- closeLabel: ['close label', { ns: 'os' }],
33
- },
34
- }),
35
- ),
36
- ),
37
- [dispatch],
20
+ async (values: UserFeedback) => {
21
+ await invokePromise(ObservabilityOperation.CaptureUserFeedback, values);
22
+ await invokePromise(Common.LayoutOperation.UpdateComplementary, { state: 'collapsed' });
23
+ await invokePromise(Common.LayoutOperation.AddToast, {
24
+ id: `${meta.id}/feedback-success`,
25
+ icon: 'ph--paper-plane-tilt--regular',
26
+ duration: 3000,
27
+ title: ['feedback toast label', { ns: meta.id }],
28
+ description: ['feedback toast description', { ns: meta.id }],
29
+ closeLabel: ['close label', { ns: osTranslations }],
30
+ });
31
+ },
32
+ [invokePromise],
38
33
  );
39
34
 
40
35
  return <FeedbackForm onSave={handleSave} />;
@@ -5,12 +5,12 @@
5
5
  import * as Schema from 'effect/Schema';
6
6
  import React from 'react';
7
7
 
8
- import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
8
+ import { useOperationInvoker } from '@dxos/app-framework/react';
9
9
  import { Input, Message, useTranslation } from '@dxos/react-ui';
10
10
  import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
11
11
 
12
12
  import { meta } from '../meta';
13
- import { ObservabilityAction } from '../types';
13
+ import { ObservabilityOperation } from '../types';
14
14
 
15
15
  export const ObservabilitySettingsSchema = Schema.mutable(
16
16
  Schema.Struct({
@@ -24,9 +24,14 @@ export const ObservabilitySettingsSchema = Schema.mutable(
24
24
 
25
25
  export type ObservabilitySettingsProps = Schema.Schema.Type<typeof ObservabilitySettingsSchema>;
26
26
 
27
- 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) => {
28
33
  const { t } = useTranslation(meta.id);
29
- const { dispatchPromise: dispatch } = useIntentDispatcher();
34
+ const { invokePromise } = useOperationInvoker();
30
35
 
31
36
  return (
32
37
  <ControlPage>
@@ -38,7 +43,7 @@ export const ObservabilitySettings = ({ settings }: { settings: ObservabilitySet
38
43
  <ControlItemInput title={t('observability enabled label')}>
39
44
  <Input.Switch
40
45
  checked={settings.enabled}
41
- onCheckedChange={(checked) => dispatch(createIntent(ObservabilityAction.Toggle, { state: !!checked }))}
46
+ onCheckedChange={(checked) => invokePromise(ObservabilityOperation.Toggle, { state: !!checked })}
42
47
  />
43
48
  </ControlItemInput>
44
49
  </ControlGroup>
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`
@@ -24,8 +24,8 @@ export const translations = [
24
24
  '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
25
 
26
26
  'help label': 'Feedback & Support',
27
- 'feedback text area label': 'Feedback',
28
- 'feedback text area placeholder': 'Please enter your feedback, technical issue, or feature request.',
27
+ 'feedback textarea label': 'Feedback',
28
+ 'feedback textarea placeholder': 'Please enter your feedback, technical issue, or feature request.',
29
29
  'send feedback label': 'Send Feedback',
30
30
  'feedback toast label': 'Thank you for your feedback!',
31
31
  '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>(`${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,14 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { ActivationEvent, Common } from '@dxos/app-framework';
6
+
7
+ import { meta } from '../meta';
8
+
9
+ export namespace ObservabilityEvents {
10
+ export const StateReady: ActivationEvent.ActivationEvent = Common.ActivationEvent.createStateEvent(meta.id);
11
+ }
12
+
13
+ // NOTE: This is cloned from the client plugin to avoid circular dependencies.
14
+ 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,213 +4,75 @@
4
4
 
5
5
  import * as Schema from 'effect/Schema';
6
6
 
7
- import { Type } 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';
12
+ import { translations } from '../translations';
10
13
 
11
- const nonEmpty = <S extends Schema.Schema.Any>(field: string) =>
12
- Schema.nonEmptyString<S>({ message: () => `Missing field: ${field}` });
13
-
14
- const maxLength = <S extends Schema.Schema.Any>(field: string, length: number) =>
15
- Schema.maxLength<S>(length, { message: () => `Exceeds max length (${length}): ${field}` });
14
+ const t = translations[0]['en-US'][meta.id];
16
15
 
17
16
  export const UserFeedback = Schema.Struct({
18
- message: Schema.String.pipe(nonEmpty('Feedback'), maxLength('Feedback', 32_768)),
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
+ ),
19
25
  });
20
26
 
21
27
  export type UserFeedback = Schema.Schema.Type<typeof UserFeedback>;
22
28
 
23
- export namespace ObservabilityAction {
24
- export class Toggle extends Schema.TaggedClass<Toggle>()(`${meta.id}/action/toggle`, {
25
- input: Schema.Struct({
26
- state: Schema.optional(Schema.Boolean),
27
- }),
28
- output: Schema.Boolean,
29
- }) {}
29
+ const OBSERVABILITY_OPERATION = `${meta.id}/operation`;
30
+
31
+ /**
32
+ * Operations for the Observability plugin.
33
+ */
34
+ export namespace ObservabilityOperation {
35
+ export const Toggle = Operation.make({
36
+ meta: {
37
+ key: `${OBSERVABILITY_OPERATION}/toggle`,
38
+ name: 'Toggle Observability',
39
+ description: 'Toggle observability on or off.',
40
+ },
41
+ services: [Capability.Service],
42
+ schema: {
43
+ input: Schema.Struct({
44
+ state: Schema.optional(Schema.Boolean),
45
+ }),
46
+ output: Schema.Boolean,
47
+ },
48
+ });
30
49
 
31
- export class CaptureUserFeedback extends Schema.TaggedClass<CaptureUserFeedback>()(
32
- `${meta.id}/action/capture-feedback`,
33
- {
50
+ export const CaptureUserFeedback = Operation.make({
51
+ meta: {
52
+ key: `${OBSERVABILITY_OPERATION}/capture-feedback`,
53
+ name: 'Capture User Feedback',
54
+ description: 'Capture user feedback.',
55
+ },
56
+ services: [Capability.Service],
57
+ schema: {
34
58
  input: UserFeedback,
35
59
  output: Schema.Void,
36
60
  },
37
- ) {}
38
-
39
- /** Base intent for sending events. */
40
- export class BaseSendEvent extends Schema.TaggedClass<BaseSendEvent>()(`${meta.id}/action/send-event`, {
41
- input: Schema.Struct({
42
- name: Schema.String,
43
- properties: Schema.optional(Schema.Object),
44
- }),
45
- output: Schema.Void,
46
- }) {}
61
+ });
47
62
 
48
- /** Intent with strict types for first-party events. */
49
- export class SendEvent extends Schema.TaggedClass<SendEvent>()(`${meta.id}/action/send-event`, {
50
- // NOTE: Sort alphabetically by name.
51
- input: Schema.Union(
52
- Schema.Struct({
53
- name: Schema.Literal('identity.create'),
54
- }),
55
- Schema.Struct({
56
- name: Schema.Literal('identity.join'),
57
- }),
58
- Schema.Struct({
59
- name: Schema.Literal('identity.recover'),
60
- }),
61
- Schema.Struct({
62
- name: Schema.Literal('identity.share'),
63
- }),
64
- Schema.Struct({
65
- name: Schema.Literal('navigation.activate'),
66
- properties: Schema.Struct({
67
- subjectId: Schema.String,
68
- typename: Schema.optional(Schema.String),
69
- }),
70
- }),
71
- Schema.Struct({
72
- name: Schema.Literal('page.load'),
73
- properties: Schema.Struct({
74
- loadDuration: Schema.Number,
75
- }),
76
- }),
77
- Schema.Struct({
78
- name: Schema.Literal('plugins.toggle'),
79
- properties: Schema.Struct({
80
- plugin: Schema.String,
81
- enabled: Schema.Boolean,
82
- }),
83
- }),
84
- Schema.Struct({
85
- name: Schema.Literal('space.create'),
86
- properties: Schema.Struct({
87
- spaceId: Type.SpaceId,
88
- }),
89
- }),
90
- Schema.Struct({
91
- name: Schema.Literal('space.join'),
92
- properties: Schema.Struct({
93
- spaceId: Type.SpaceId,
94
- }),
95
- }),
96
- Schema.Struct({
97
- name: Schema.Literal('space.limit'),
98
- properties: Schema.Struct({
99
- spaceId: Type.SpaceId,
100
- }),
101
- }),
102
- Schema.Struct({
103
- name: Schema.Literal('space.lock'),
104
- properties: Schema.Struct({
105
- spaceId: Type.SpaceId,
106
- }),
107
- }),
108
- Schema.Struct({
109
- name: Schema.Literal('space.migrate'),
110
- properties: Schema.Struct({
111
- spaceId: Type.SpaceId,
112
- targetVersion: Schema.optional(Schema.String),
113
- version: Schema.optional(Schema.String),
114
- }),
115
- }),
116
- Schema.Struct({
117
- name: Schema.Literal('space.schema.use'),
118
- properties: Schema.Struct({
119
- spaceId: Type.SpaceId,
120
- typename: Schema.String,
121
- }),
122
- }),
123
- Schema.Struct({
124
- name: Schema.Literal('space.schema.add'),
125
- properties: Schema.Struct({
126
- spaceId: Type.SpaceId,
127
- objectId: Schema.String,
128
- typename: Schema.String,
129
- }),
130
- }),
131
- Schema.Struct({
132
- name: Schema.Literal('space.object.add'),
133
- properties: Schema.Struct({
134
- spaceId: Type.SpaceId,
135
- objectId: Schema.String,
136
- typename: Schema.optional(Schema.String),
137
- }),
138
- }),
139
- Schema.Struct({
140
- name: Schema.Literal('space.share'),
141
- properties: Schema.Struct({
142
- spaceId: Type.SpaceId,
143
- }),
144
- }),
145
- Schema.Struct({
146
- name: Schema.Literal('space.unlock'),
147
- properties: Schema.Struct({
148
- spaceId: Type.SpaceId,
149
- }),
150
- }),
151
- Schema.Struct({
152
- name: Schema.Literal('threads.create'),
153
- properties: Schema.Struct({
154
- spaceId: Type.SpaceId,
155
- threadId: Schema.String,
156
- }),
157
- }),
158
- Schema.Struct({
159
- name: Schema.Literal('threads.delete'),
160
- properties: Schema.Struct({
161
- spaceId: Type.SpaceId,
162
- threadId: Schema.String,
163
- }),
164
- }),
165
- Schema.Struct({
166
- name: Schema.Literal('threads.message.add'),
167
- properties: Schema.Struct({
168
- spaceId: Type.SpaceId,
169
- threadId: Schema.String,
170
- threadLength: Schema.Number,
171
- messageId: Schema.String,
172
- messageLength: Schema.Number,
173
- }),
174
- }),
175
- Schema.Struct({
176
- name: Schema.Literal('threads.message.delete'),
177
- properties: Schema.Struct({
178
- spaceId: Type.SpaceId,
179
- threadId: Schema.String,
180
- messageId: Schema.String,
181
- }),
182
- }),
183
- Schema.Struct({
184
- name: Schema.Literal('threads.message.undo-delete'),
185
- properties: Schema.Struct({
186
- spaceId: Type.SpaceId,
187
- threadId: Schema.String,
188
- messageId: Schema.String,
189
- }),
190
- }),
191
- Schema.Struct({
192
- name: Schema.Literal('threads.message.update'),
193
- properties: Schema.Struct({
194
- spaceId: Type.SpaceId,
195
- messageId: Schema.String,
196
- messageLength: Schema.Number,
197
- }),
198
- }),
199
- Schema.Struct({
200
- name: Schema.Literal('threads.toggle-resolved'),
201
- properties: Schema.Struct({
202
- spaceId: Type.SpaceId,
203
- threadId: Schema.String,
204
- }),
205
- }),
206
- Schema.Struct({
207
- name: Schema.Literal('threads.undo-delete'),
208
- properties: Schema.Struct({
209
- spaceId: Type.SpaceId,
210
- threadId: Schema.String,
211
- }),
63
+ export const SendEvent = Operation.make({
64
+ meta: {
65
+ key: `${OBSERVABILITY_OPERATION}/send-event`,
66
+ name: 'Send Event',
67
+ description: 'Send an observability event.',
68
+ },
69
+ services: [Capability.Service],
70
+ schema: {
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.' }),
212
74
  }),
213
- ),
214
- output: Schema.Void,
215
- }) {}
75
+ output: Schema.Void,
76
+ },
77
+ });
216
78
  }
@@ -1,44 +0,0 @@
1
- import {
2
- meta
3
- } from "./chunk-W7QWKVS3.mjs";
4
-
5
- // src/capabilities/app-graph-builder.ts
6
- import { Rx } from "@effect-rx/rx-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) => Rx.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-4VCXIPB7.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 { Rx } from '@effect-rx/rx-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 Rx.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,UAAU;AACnB,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,GAAGC,KAAK,CAACC,QACEC,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": ["Rx", "Function", "Option", "Capabilities", "contributes", "ROOT_ID", "createExtension", "ATTENDABLE_PATH_SEPARATOR", "DECK_COMPANION_TYPE", "_context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "meta", "connector", "node", "Rx", "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