@dxos/plugin-observability 0.7.4 → 0.7.5-labs.071a3e2

package/dist/lib/node-esm/client-ready-NXRLOXLL.mjs

@@ -0,0 +1,104 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  ObservabilityAction
+} from "./chunk-DSC5SQ7W.mjs";
+import {
+  ClientCapability,
+  ObservabilityCapabilities
+} from "./chunk-KPH3N6JS.mjs";
+import {
+  OBSERVABILITY_PLUGIN
+} from "./chunk-HTL7V6A2.mjs";
+
+// packages/plugins/plugin-observability/src/capabilities/client-ready.ts
+import { Capabilities, contributes, createIntent, LayoutAction, SettingsAction } from "@dxos/app-framework";
+import { setupTelemetryListeners } from "@dxos/observability";
+var client_ready_default = async ({ context, namespace, observability }) => {
+  const manager = context.requestCapability(Capabilities.PluginManager);
+  const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);
+  const state = context.requestCapability(ObservabilityCapabilities.State);
+  const client = context.requestCapability(ClientCapability);
+  const sendPrivacyNotice = async () => {
+    const environment = client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;
+    const notify = environment && environment !== "ci" && !environment.endsWith(".local") && !environment.endsWith(".lan");
+    if (!state.notified && notify) {
+      await dispatch(createIntent(LayoutAction.AddToast, {
+        part: "toast",
+        subject: {
+          id: `${OBSERVABILITY_PLUGIN}/notice`,
+          title: [
+            "observability toast label",
+            {
+              ns: OBSERVABILITY_PLUGIN
+            }
+          ],
+          description: [
+            "observability toast description",
+            {
+              ns: OBSERVABILITY_PLUGIN
+            }
+          ],
+          duration: Infinity,
+          icon: "ph--info--regular",
+          actionLabel: [
+            "observability toast action label",
+            {
+              ns: OBSERVABILITY_PLUGIN
+            }
+          ],
+          actionAlt: [
+            "observability toast action alt",
+            {
+              ns: OBSERVABILITY_PLUGIN
+            }
+          ],
+          closeLabel: [
+            "observability toast close label",
+            {
+              ns: OBSERVABILITY_PLUGIN
+            }
+          ],
+          onAction: () => dispatch(createIntent(SettingsAction.Open, {
+            plugin: OBSERVABILITY_PLUGIN
+          }))
+        }
+      }));
+      state.notified = true;
+    }
+  };
+  manager.enabled.map((plugin) => observability?.setTag(`pluginEnabled-${plugin}`, "true", "errors"));
+  await dispatch(createIntent(ObservabilityAction.SendEvent, {
+    name: "page.load",
+    properties: {
+      href: window.location.href,
+      // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?
+      loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart
+    }
+  }));
+  const cleanup = setupTelemetryListeners(namespace, client, observability);
+  await Promise.all([
+    observability.setIdentityTags(client.services.services),
+    observability.startRuntimeMetrics(client),
+    observability.startNetworkMetrics(client.services.services),
+    observability.startSpacesMetrics(client, namespace)
+  ]);
+  if (client.halo.identity.get()) {
+    await sendPrivacyNotice();
+  } else {
+    const subscription = client.halo.identity.subscribe(async (identity) => {
+      if (identity && observability) {
+        await sendPrivacyNotice();
+        await observability.setIdentityTags(client.services.services);
+        subscription.unsubscribe();
+      }
+    });
+  }
+  return contributes(ObservabilityCapabilities.Observability, observability, async () => {
+    cleanup();
+    await observability.close();
+  });
+};
+export {
+  client_ready_default as default
+};
+//# sourceMappingURL=client-ready-NXRLOXLL.mjs.map

package/dist/lib/node-esm/client-ready-NXRLOXLL.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/capabilities/client-ready.ts"],
+  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport {\n  Capabilities,\n  contributes,\n  createIntent,\n  LayoutAction,\n  SettingsAction,\n  type PluginsContext,\n} from '@dxos/app-framework';\nimport { setupTelemetryListeners, type Observability } from '@dxos/observability';\n\nimport { ClientCapability, ObservabilityCapabilities } from './capabilities';\nimport { OBSERVABILITY_PLUGIN } from '../meta';\nimport { ObservabilityAction } from '../types';\n\ntype ClientReadyOptions = {\n  context: PluginsContext;\n  namespace: string;\n  observability: Observability;\n};\n\nexport default async ({ context, namespace, observability }: ClientReadyOptions) => {\n  const manager = context.requestCapability(Capabilities.PluginManager);\n  const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);\n  const state = context.requestCapability(ObservabilityCapabilities.State);\n  const client = context.requestCapability(ClientCapability);\n\n  const sendPrivacyNotice = async () => {\n    const environment = client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;\n    const notify =\n      environment && environment !== 'ci' && !environment.endsWith('.local') && !environment.endsWith('.lan');\n    if (!state.notified && notify) {\n      await dispatch(\n        createIntent(LayoutAction.AddToast, {\n          part: 'toast',\n          subject: {\n            id: `${OBSERVABILITY_PLUGIN}/notice`,\n            title: ['observability toast label', { ns: OBSERVABILITY_PLUGIN }],\n            description: ['observability toast description', { ns: OBSERVABILITY_PLUGIN }],\n            duration: Infinity,\n            icon: 'ph--info--regular',\n            actionLabel: ['observability toast action label', { ns: OBSERVABILITY_PLUGIN }],\n            actionAlt: ['observability toast action alt', { ns: OBSERVABILITY_PLUGIN }],\n            closeLabel: ['observability toast close label', { ns: OBSERVABILITY_PLUGIN }],\n            onAction: () => dispatch(createIntent(SettingsAction.Open, { plugin: OBSERVABILITY_PLUGIN })),\n          },\n        }),\n      );\n\n      state.notified = true;\n    }\n  };\n\n  // Ensure errors are tagged with enabled plugins to help with reproductions.\n  manager.enabled.map((plugin) => observability?.setTag(`pluginEnabled-${plugin}`, 'true', 'errors'));\n\n  await dispatch(\n    createIntent(ObservabilityAction.SendEvent, {\n      name: 'page.load',\n      properties: {\n        href: window.location.href,\n        // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?\n        loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,\n      },\n    }),\n  );\n\n  // Start client observability (i.e. not running as shared worker)\n  // TODO(nf): how to prevent multiple instances for single shared worker?\n  const cleanup = setupTelemetryListeners(namespace, client, observability);\n\n  await Promise.all([\n    observability.setIdentityTags(client.services.services),\n    observability.startRuntimeMetrics(client),\n    observability.startNetworkMetrics(client.services.services),\n    observability.startSpacesMetrics(client, namespace),\n  ]);\n\n  if (client.halo.identity.get()) {\n    await sendPrivacyNotice();\n  } else {\n    const subscription = client.halo.identity.subscribe(async (identity) => {\n      if (identity && observability) {\n        await sendPrivacyNotice();\n        await observability.setIdentityTags(client.services.services);\n        subscription.unsubscribe();\n      }\n    });\n  }\n\n  return contributes(ObservabilityCapabilities.Observability, observability, async () => {\n    cleanup();\n    await observability.close();\n  });\n};\n"],
+  "mappings": ";;;;;;;;;;;;;AAIA,SACEA,cACAC,aACAC,cACAC,cACAC,sBAEK;AACP,SAASC,+BAAmD;AAY5D,IAAA,uBAAe,OAAO,EAAEC,SAASC,WAAWC,cAAa,MAAsB;AAC7E,QAAMC,UAAUH,QAAQI,kBAAkBC,aAAaC,aAAa;AACpE,QAAM,EAAEC,iBAAiBC,SAAQ,IAAKR,QAAQI,kBAAkBC,aAAaI,gBAAgB;AAC7F,QAAMC,QAAQV,QAAQI,kBAAkBO,0BAA0BC,KAAK;AACvE,QAAMC,SAASb,QAAQI,kBAAkBU,gBAAAA;AAEzC,QAAMC,oBAAoB,YAAA;AACxB,UAAMC,cAAcH,QAAQI,QAAQC,OAAOC,SAASC,KAAKC,KAAKC;AAC9D,UAAMC,SACJP,eAAeA,gBAAgB,QAAQ,CAACA,YAAYQ,SAAS,QAAA,KAAa,CAACR,YAAYQ,SAAS,MAAA;AAClG,QAAI,CAACd,MAAMe,YAAYF,QAAQ;AAC7B,YAAMf,SACJkB,aAAaC,aAAaC,UAAU;QAClCC,MAAM;QACNC,SAAS;UACPC,IAAI,GAAGC,oBAAAA;UACPC,OAAO;YAAC;YAA6B;cAAEC,IAAIF;YAAqB;;UAChEG,aAAa;YAAC;YAAmC;cAAED,IAAIF;YAAqB;;UAC5EI,UAAUC;UACVC,MAAM;UACNC,aAAa;YAAC;YAAoC;cAAEL,IAAIF;YAAqB;;UAC7EQ,WAAW;YAAC;YAAkC;cAAEN,IAAIF;YAAqB;;UACzES,YAAY;YAAC;YAAmC;cAAEP,IAAIF;YAAqB;;UAC3EU,UAAU,MAAMlC,SAASkB,aAAaiB,eAAeC,MAAM;YAAEC,QAAQb;UAAqB,CAAA,CAAA;QAC5F;MACF,CAAA,CAAA;AAGFtB,YAAMe,WAAW;IACnB;EACF;AAGAtB,UAAQ2C,QAAQC,IAAI,CAACF,WAAW3C,eAAe8C,OAAO,iBAAiBH,MAAAA,IAAU,QAAQ,QAAA,CAAA;AAEzF,QAAMrC,SACJkB,aAAauB,oBAAoBC,WAAW;IAC1CC,MAAM;IACNC,YAAY;MACVC,MAAMC,OAAOC,SAASF;;MAEtBG,cAAcF,OAAOG,YAAYC,OAAOC,eAAeL,OAAOG,YAAYC,OAAOE;IACnF;EACF,CAAA,CAAA;AAKF,QAAMC,UAAUC,wBAAwB7D,WAAWY,QAAQX,aAAAA;AAE3D,QAAM6D,QAAQC,IAAI;IAChB9D,cAAc+D,gBAAgBpD,OAAOqD,SAASA,QAAQ;IACtDhE,cAAciE,oBAAoBtD,MAAAA;IAClCX,cAAckE,oBAAoBvD,OAAOqD,SAASA,QAAQ;IAC1DhE,cAAcmE,mBAAmBxD,QAAQZ,SAAAA;GAC1C;AAED,MAAIY,OAAOyD,KAAKC,SAASC,IAAG,GAAI;AAC9B,UAAMzD,kBAAAA;EACR,OAAO;AACL,UAAM0D,eAAe5D,OAAOyD,KAAKC,SAASG,UAAU,OAAOH,aAAAA;AACzD,UAAIA,YAAYrE,eAAe;AAC7B,cAAMa,kBAAAA;AACN,cAAMb,cAAc+D,gBAAgBpD,OAAOqD,SAASA,QAAQ;AAC5DO,qBAAaE,YAAW;MAC1B;IACF,CAAA;EACF;AAEA,SAAOC,YAAYjE,0BAA0BkE,eAAe3E,eAAe,YAAA;AACzE2D,YAAAA;AACA,UAAM3D,cAAc4E,MAAK;EAC3B,CAAA;AACF;",
+  "names": ["Capabilities", "contributes", "createIntent", "LayoutAction", "SettingsAction", "setupTelemetryListeners", "context", "namespace", "observability", "manager", "requestCapability", "Capabilities", "PluginManager", "dispatchPromise", "dispatch", "IntentDispatcher", "state", "ObservabilityCapabilities", "State", "client", "ClientCapability", "sendPrivacyNotice", "environment", "config", "values", "runtime", "app", "env", "DX_ENVIRONMENT", "notify", "endsWith", "notified", "createIntent", "LayoutAction", "AddToast", "part", "subject", "id", "OBSERVABILITY_PLUGIN", "title", "ns", "description", "duration", "Infinity", "icon", "actionLabel", "actionAlt", "closeLabel", "onAction", "SettingsAction", "Open", "plugin", "enabled", "map", "setTag", "ObservabilityAction", "SendEvent", "name", "properties", "href", "window", "location", "loadDuration", "performance", "timing", "loadEventEnd", "loadEventStart", "cleanup", "setupTelemetryListeners", "Promise", "all", "setIdentityTags", "services", "startRuntimeMetrics", "startNetworkMetrics", "startSpacesMetrics", "halo", "identity", "get", "subscription", "subscribe", "unsubscribe", "contributes", "Observability", "close"]
+}

package/dist/lib/node-esm/index.mjs

@@ -1,43 +1,30 @@
 import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  ObservabilityCapabilities
+} from "./chunk-KPH3N6JS.mjs";
 import {
   OBSERVABILITY_PLUGIN,
-  ObservabilityAction,
-  meta_default
-} from "./chunk-UVEE3XZO.mjs";
+  meta
+} from "./chunk-HTL7V6A2.mjs";
 
-// packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx
-import React2 from "react";
-import { resolvePlugin, parseIntentPlugin as parseIntentPlugin2, LayoutAction, SettingsAction, parsePluginHost } from "@dxos/app-framework";
-import { EventSubscriptions } from "@dxos/async";
-import { create } from "@dxos/live-object";
-import { LocalStorageStore } from "@dxos/local-storage";
-import { getTelemetryIdentifier, setupTelemetryListeners, isObservabilityDisabled, storeObservabilityDisabled, getObservabilityGroup } from "@dxos/observability";
-import { parseClientPlugin } from "@dxos/plugin-client";
+// packages/plugins/plugin-observability/src/capabilities/index.ts
+import { lazy } from "@dxos/app-framework";
+var ClientReady = lazy(() => import("./client-ready-NXRLOXLL.mjs"));
+var IntentResolver = lazy(() => import("./intents-resolver-PZS43GGV.mjs"));
+var ReactSurface = lazy(() => import("./react-surface-QYURTQNR.mjs"));
+var ObservabilitySettings = lazy(() => import("./settings-UNFUTWGX.mjs"));
+var ObservabilityState = lazy(() => import("./state-UXRA6NQC.mjs"));
 
-// packages/plugins/plugin-observability/src/components/ObservabilitySettings.tsx
-import React from "react";
-import { parseIntentPlugin, useResolvePlugin } from "@dxos/app-framework";
-import { Input, Message, useTranslation } from "@dxos/react-ui";
-import { DeprecatedFormInput } from "@dxos/react-ui-form";
-var ObservabilitySettings = ({ settings }) => {
-  const { t } = useTranslation(OBSERVABILITY_PLUGIN);
-  const intentPlugin = useResolvePlugin(parseIntentPlugin);
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, intentPlugin && /* @__PURE__ */ React.createElement(DeprecatedFormInput, {
-    label: t("observability enabled label"),
-    secondary: /* @__PURE__ */ React.createElement(Message.Root, {
-      valence: "info"
-    }, /* @__PURE__ */ React.createElement(Message.Body, null, t("observability description")))
-  }, /* @__PURE__ */ React.createElement(Input.Switch, {
-    checked: settings.enabled,
-    onCheckedChange: (checked) => intentPlugin.provides.intent.dispatch({
-      plugin: OBSERVABILITY_PLUGIN,
-      action: ObservabilityAction.TOGGLE,
-      data: {
-        state: !!checked
-      }
-    })
-  })));
-};
+// packages/plugins/plugin-observability/src/events.ts
+import { defineEvent, Events } from "@dxos/app-framework";
+var ObservabilityEvents;
+(function(ObservabilityEvents2) {
+  ObservabilityEvents2.StateReady = Events.createStateEvent(OBSERVABILITY_PLUGIN);
+})(ObservabilityEvents || (ObservabilityEvents = {}));
+var ClientReadyEvent = defineEvent("dxos.org/plugin/client/event/client-ready");
+
+// packages/plugins/plugin-observability/src/ObservabilityPlugin.ts
+import { allOf, Capabilities, contributes, defineModule, definePlugin, Events as Events2 } from "@dxos/app-framework";
 
 // packages/plugins/plugin-observability/src/translations.ts
 var translations_default = [
@@ -52,180 +39,70 @@ var translations_default = [
         "observability toast close label": "Okay",
         "observability enabled label": "Enable telemetry",
         // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.
-        "observability description": "When enabled, basic usage data will be sent to the DXOS team in order 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."
+        "observability description": "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."
       }
     }
   }
 ];
 
-// packages/plugins/plugin-observability/src/ObservabilityPlugin.tsx
-var parseObservabilityPlugin = (plugin) => (plugin?.provides).observability ? plugin : void 0;
-var ObservabilityPlugin = (options) => {
-  const settings = create({});
-  const state = new LocalStorageStore(OBSERVABILITY_PLUGIN);
-  const subscriptions = new EventSubscriptions();
-  let observability;
-  return {
-    meta: meta_default,
-    initialize: async () => {
-      settings.enabled = !await isObservabilityDisabled(options.namespace);
-      state.values.group = await getObservabilityGroup(options.namespace);
-      state.prop({
-        key: "notified",
-        type: LocalStorageStore.bool({
-          allowUndefined: true
-        })
-      });
-    },
-    ready: async (plugins) => {
-      const pluginHost = resolvePlugin(plugins, parsePluginHost);
-      const clientPlugin = resolvePlugin(plugins, parseClientPlugin);
-      const intentPlugin = resolvePlugin(plugins, parseIntentPlugin2);
-      const dispatch = intentPlugin?.provides?.intent?.dispatch;
-      if (!dispatch) {
-        return;
-      }
-      const sendPrivacyNotice = async () => {
-        const environment = clientPlugin?.provides?.client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;
-        const notify = environment && environment !== "ci" && !environment.endsWith(".local") && !environment.endsWith(".lan");
-        if (!state.values.notified && notify) {
-          await dispatch({
-            action: LayoutAction.SET_LAYOUT,
-            data: {
-              element: "toast",
-              subject: {
-                id: `${OBSERVABILITY_PLUGIN}/notice`,
-                // TODO(wittjosiah): Non-react translation utils.
-                title: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast label"],
-                description: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast description"],
-                duration: Infinity,
-                icon: "ph--info--regular",
-                actionLabel: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast action label"],
-                actionAlt: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast action alt"],
-                closeLabel: translations_default[0]["en-US"][OBSERVABILITY_PLUGIN]["observability toast close label"],
-                onAction: () => dispatch({
-                  action: SettingsAction.OPEN,
-                  data: {
-                    plugin: OBSERVABILITY_PLUGIN
-                  }
-                })
-              }
-            }
-          });
-          state.values.notified = true;
-        }
-      };
-      void options.observability().then(async (obs) => {
-        observability = obs;
-        pluginHost?.provides?.plugins?.enabled?.map((plugin) => observability?.setTag(`pluginEnabled-${plugin}`, "true", "errors"));
-        const client = clientPlugin?.provides?.client;
-        if (!client) {
-          return;
-        }
-        await dispatch({
-          action: ObservabilityAction.SEND_EVENT,
-          data: {
-            name: "page.load",
-            properties: {
-              href: window.location.href,
-              // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?
-              loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart
-            }
-          }
-        });
-        setupTelemetryListeners(options.namespace, client, observability);
-        await Promise.all([
-          observability.setIdentityTags(client.services.services),
-          observability.startRuntimeMetrics(client),
-          observability.startNetworkMetrics(client.services.services),
-          observability.startSpacesMetrics(client, options.namespace)
-        ]);
-        if (client.halo.identity.get()) {
-          await sendPrivacyNotice();
-        } else {
-          const subscription = client.halo.identity.subscribe(async (identity) => {
-            if (identity && observability) {
-              await sendPrivacyNotice();
-              await observability.setIdentityTags(client.services.services);
-              subscription.unsubscribe();
-            }
-          });
-        }
+// packages/plugins/plugin-observability/src/ObservabilityPlugin.ts
+var ObservabilityPlugin = (options) => definePlugin(meta, [
+  defineModule({
+    id: `${meta.id}/module/observability`,
+    activatesOn: Events2.Startup,
+    activate: async () => contributes(ObservabilityCapabilities.Observability, await options.observability())
+  }),
+  defineModule({
+    id: `${meta.id}/module/settings`,
+    activatesOn: Events2.SetupSettings,
+    activate: ObservabilitySettings
+  }),
+  defineModule({
+    id: `${meta.id}/module/state`,
+    activatesOn: Events2.Startup,
+    activatesAfter: [
+      ObservabilityEvents.StateReady
+    ],
+    activate: () => ObservabilityState({
+      namespace: options.namespace
+    })
+  }),
+  defineModule({
+    id: `${meta.id}/module/translations`,
+    activatesOn: Events2.SetupTranslations,
+    activate: () => contributes(Capabilities.Translations, translations_default)
+  }),
+  defineModule({
+    id: `${meta.id}/module/intent-resolver`,
+    activatesOn: Events2.SetupIntents,
+    activate: (context) => IntentResolver({
+      context,
+      namespace: options.namespace
+    })
+  }),
+  defineModule({
+    id: `${meta.id}/module/react-surface`,
+    activatesOn: Events2.SetupSurfaces,
+    activate: ReactSurface
+  }),
+  defineModule({
+    id: `${meta.id}/module/client-ready`,
+    activatesOn: allOf(Events2.DispatcherReady, ObservabilityEvents.StateReady, ClientReadyEvent),
+    activate: async (context) => {
+      const observability = await options.observability();
+      return ClientReady({
+        context,
+        observability,
+        namespace: options.namespace
       });
-    },
-    unload: async () => {
-      subscriptions.clear();
-      await observability?.close();
-    },
-    provides: {
-      intent: {
-        resolver: async (intent, plugins) => {
-          const client = resolvePlugin(plugins, parseClientPlugin)?.provides?.client;
-          if (!client || !observability) {
-            return;
-          }
-          switch (intent.action) {
-            case ObservabilityAction.TOGGLE:
-              settings.enabled = !settings.enabled;
-              observability.event({
-                identityId: getTelemetryIdentifier(client),
-                name: `${options.namespace}.observability.toggle`,
-                properties: {
-                  enabled: settings.enabled
-                }
-              });
-              observability.setMode(settings.enabled ? "basic" : "disabled");
-              await storeObservabilityDisabled(options.namespace, !settings.enabled);
-              return {
-                data: settings.enabled
-              };
-            case ObservabilityAction.SEND_EVENT: {
-              const data = intent.data;
-              const event = {
-                identityId: getTelemetryIdentifier(client),
-                name: `${options.namespace}.${data.name}`,
-                properties: {
-                  ...data.properties
-                }
-              };
-              observability.event(event);
-              return {
-                data: event
-              };
-            }
-            case ObservabilityAction.CAPTURE_USER_FEEDBACK: {
-              const feedback = intent.data;
-              observability.captureUserFeedback(feedback.email, feedback.name, feedback.message);
-              return {
-                data: true
-              };
-            }
-          }
-        }
-      },
-      observability: state.values,
-      settings,
-      surface: {
-        component: ({ role, data }) => {
-          switch (role) {
-            case "settings":
-              return data.plugin === meta_default.id ? /* @__PURE__ */ React2.createElement(ObservabilitySettings, {
-                settings
-              }) : null;
-          }
-          return null;
-        }
-      },
-      translations: translations_default
     }
-  };
-};
-
-// packages/plugins/plugin-observability/src/index.ts
-var src_default = ObservabilityPlugin;
+  })
+]);
 export {
+  OBSERVABILITY_PLUGIN,
+  ObservabilityCapabilities,
+  ObservabilityEvents,
   ObservabilityPlugin,
-  src_default as default,
-  parseObservabilityPlugin
+  meta
 };
 //# sourceMappingURL=index.mjs.map

package/dist/lib/node-esm/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../../src/ObservabilityPlugin.tsx", "../../../src/components/ObservabilitySettings.tsx", "../../../src/translations.ts", "../../../src/index.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport {\n  type Plugin,\n  type PluginDefinition,\n  type IntentResolverProvides,\n  type SettingsProvides,\n  type SurfaceProvides,\n  type TranslationsProvides,\n  resolvePlugin,\n  parseIntentPlugin,\n  LayoutAction,\n  SettingsAction,\n  parsePluginHost,\n} from '@dxos/app-framework';\nimport { EventSubscriptions } from '@dxos/async';\nimport { create } from '@dxos/live-object';\nimport { LocalStorageStore } from '@dxos/local-storage';\nimport {\n  type Observability,\n  getTelemetryIdentifier,\n  setupTelemetryListeners,\n  isObservabilityDisabled,\n  storeObservabilityDisabled,\n  getObservabilityGroup,\n} from '@dxos/observability';\nimport type { EventOptions } from '@dxos/observability/segment';\nimport { parseClientPlugin } from '@dxos/plugin-client';\n\nimport { ObservabilitySettings, type ObservabilitySettingsProps } from './components';\nimport meta, { OBSERVABILITY_PLUGIN, ObservabilityAction, type UserFeedback } from './meta';\nimport translations from './translations';\n\nexport type ObservabilityPluginState = {\n  group?: string;\n  notified?: boolean;\n};\n\nexport type ObservabilityPluginProvides = IntentResolverProvides &\n  SurfaceProvides &\n  SettingsProvides<ObservabilitySettingsProps> &\n  TranslationsProvides & {\n    observability: ObservabilityPluginState;\n  };\n\nexport const parseObservabilityPlugin = (plugin?: Plugin) =>\n  (plugin?.provides as any).observability ? (plugin as Plugin<ObservabilityPluginProvides>) : undefined;\n\nexport const ObservabilityPlugin = (options: {\n  namespace: string;\n  observability: () => Promise<Observability>;\n}): PluginDefinition<ObservabilityPluginProvides> => {\n  const settings = create<ObservabilitySettingsProps>({});\n  const state = new LocalStorageStore<ObservabilityPluginState>(OBSERVABILITY_PLUGIN);\n  const subscriptions = new EventSubscriptions();\n  let observability: Observability | undefined;\n\n  return {\n    meta,\n    initialize: async () => {\n      settings.enabled = !(await isObservabilityDisabled(options.namespace));\n      state.values.group = await getObservabilityGroup(options.namespace);\n      state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });\n    },\n    ready: async (plugins) => {\n      const pluginHost = resolvePlugin(plugins, parsePluginHost);\n      const clientPlugin = resolvePlugin(plugins, parseClientPlugin);\n      const intentPlugin = resolvePlugin(plugins, parseIntentPlugin);\n\n      const dispatch = intentPlugin?.provides?.intent?.dispatch;\n      if (!dispatch) {\n        return;\n      }\n\n      const sendPrivacyNotice = async () => {\n        const environment = clientPlugin?.provides?.client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;\n        const notify =\n          environment && environment !== 'ci' && !environment.endsWith('.local') && !environment.endsWith('.lan');\n        if (!state.values.notified && notify) {\n          await dispatch({\n            action: LayoutAction.SET_LAYOUT,\n            data: {\n              element: 'toast',\n              subject: {\n                id: `${OBSERVABILITY_PLUGIN}/notice`,\n                // TODO(wittjosiah): Non-react translation utils.\n                title: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast label'],\n                description: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast description'],\n                duration: Infinity,\n                icon: 'ph--info--regular',\n                actionLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action label'],\n                actionAlt: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action alt'],\n                closeLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast close label'],\n                onAction: () => dispatch({ action: SettingsAction.OPEN, data: { plugin: OBSERVABILITY_PLUGIN } }),\n              },\n            },\n          });\n\n          state.values.notified = true;\n        }\n      };\n\n      // Initialize asynchronously in the background, not in plugin initialization.\n      // Should not block application startup.\n      void options.observability().then(async (obs) => {\n        observability = obs;\n\n        // Ensure errors are tagged with enabled plugins to help with reproductions.\n        pluginHost?.provides?.plugins?.enabled?.map((plugin) =>\n          observability?.setTag(`pluginEnabled-${plugin}`, 'true', 'errors'),\n        );\n\n        // Start client observability (i.e. not running as shared worker)\n        // TODO(nf): how to prevent multiple instances for single shared worker?\n        const client = clientPlugin?.provides?.client;\n        if (!client) {\n          return;\n        }\n\n        await dispatch({\n          action: ObservabilityAction.SEND_EVENT,\n          data: {\n            name: 'page.load',\n            properties: {\n              href: window.location.href,\n              // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?\n              loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,\n            },\n          },\n        });\n\n        setupTelemetryListeners(options.namespace, client, observability);\n\n        await Promise.all([\n          observability.setIdentityTags(client.services.services),\n          observability.startRuntimeMetrics(client),\n          observability.startNetworkMetrics(client.services.services),\n          observability.startSpacesMetrics(client, options.namespace),\n        ]);\n\n        if (client.halo.identity.get()) {\n          await sendPrivacyNotice();\n        } else {\n          const subscription = client.halo.identity.subscribe(async (identity) => {\n            if (identity && observability) {\n              await sendPrivacyNotice();\n              await observability.setIdentityTags(client.services.services);\n              subscription.unsubscribe();\n            }\n          });\n        }\n      });\n    },\n    unload: async () => {\n      subscriptions.clear();\n      await observability?.close();\n    },\n    provides: {\n      intent: {\n        resolver: async (intent, plugins) => {\n          const client = resolvePlugin(plugins, parseClientPlugin)?.provides?.client;\n          if (!client || !observability) {\n            return;\n          }\n\n          switch (intent.action) {\n            case ObservabilityAction.TOGGLE:\n              settings.enabled = !settings.enabled;\n              observability.event({\n                identityId: getTelemetryIdentifier(client),\n                name: `${options.namespace}.observability.toggle`,\n                properties: {\n                  enabled: settings.enabled,\n                },\n              });\n              observability.setMode(settings.enabled ? 'basic' : 'disabled');\n              await storeObservabilityDisabled(options.namespace, !settings.enabled);\n              return { data: settings.enabled };\n\n            case ObservabilityAction.SEND_EVENT: {\n              const data = intent.data as EventOptions;\n              const event = {\n                identityId: getTelemetryIdentifier(client),\n                name: `${options.namespace}.${data.name}`,\n                properties: {\n                  ...data.properties,\n                },\n              };\n              observability.event(event);\n              return { data: event };\n            }\n\n            case ObservabilityAction.CAPTURE_USER_FEEDBACK: {\n              const feedback = intent.data as UserFeedback;\n\n              observability.captureUserFeedback(feedback.email, feedback.name, feedback.message);\n              return { data: true };\n            }\n          }\n        },\n      },\n      observability: state.values,\n      settings,\n      surface: {\n        component: ({ role, data }) => {\n          switch (role) {\n            case 'settings':\n              return data.plugin === meta.id ? <ObservabilitySettings settings={settings} /> : null;\n          }\n\n          return null;\n        },\n      },\n      translations,\n    },\n  };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { parseIntentPlugin, useResolvePlugin } from '@dxos/app-framework';\nimport { Input, Message, useTranslation } from '@dxos/react-ui';\nimport { DeprecatedFormInput } from '@dxos/react-ui-form';\n\nimport { OBSERVABILITY_PLUGIN, ObservabilityAction } from '../meta';\n\nexport type ObservabilitySettingsProps = {\n  enabled?: boolean;\n  // TODO(wittjosiah): Separate settings for each observability feature.\n  // metrics?: boolean;\n  // telemetry?: boolean;\n  // errors?: boolean;\n};\n\nexport const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {\n  const { t } = useTranslation(OBSERVABILITY_PLUGIN);\n  const intentPlugin = useResolvePlugin(parseIntentPlugin);\n\n  return (\n    <>\n      {intentPlugin && (\n        <DeprecatedFormInput\n          label={t('observability enabled label')}\n          secondary={\n            <Message.Root valence='info'>\n              <Message.Body>{t('observability description')}</Message.Body>\n            </Message.Root>\n          }\n        >\n          <Input.Switch\n            checked={settings.enabled}\n            onCheckedChange={(checked) =>\n              intentPlugin.provides.intent.dispatch({\n                plugin: OBSERVABILITY_PLUGIN,\n                action: ObservabilityAction.TOGGLE,\n                data: { state: !!checked },\n              })\n            }\n          />\n        </DeprecatedFormInput>\n      )}\n    </>\n  );\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { OBSERVABILITY_PLUGIN } from './meta';\n\nexport default [\n  {\n    'en-US': {\n      [OBSERVABILITY_PLUGIN]: {\n        'plugin name': 'Telemetry',\n        'observability toast label': 'Privacy Notice',\n        'observability toast description':\n          'Composer collects usage and performance metrics to improve the product. No user data is collected.',\n        'observability toast action label': 'Settings',\n        'observability toast action alt': 'Open settings to learn more or to disable.',\n        'observability toast close label': 'Okay',\n        'observability enabled label': 'Enable telemetry',\n        // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.\n        'observability description':\n          'When enabled, basic usage data will be sent to the DXOS team in order 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.',\n      },\n    },\n  },\n];\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { ObservabilityPlugin } from './ObservabilityPlugin';\n\nexport default ObservabilityPlugin;\n\nexport * from './ObservabilityPlugin';\n"],
-  "mappings": ";;;;;;;;AAIA,OAAOA,YAAW;AAElB,SAOEC,eACAC,qBAAAA,oBACAC,cACAC,gBACAC,uBACK;AACP,SAASC,0BAA0B;AACnC,SAASC,cAAc;AACvB,SAASC,yBAAyB;AAClC,SAEEC,wBACAC,yBACAC,yBACAC,4BACAC,6BACK;AAEP,SAASC,yBAAyB;;;AC3BlC,OAAOC,WAAW;AAElB,SAASC,mBAAmBC,wBAAwB;AACpD,SAASC,OAAOC,SAASC,sBAAsB;AAC/C,SAASC,2BAA2B;AAY7B,IAAMC,wBAAwB,CAAC,EAAEC,SAAQ,MAA4C;AAC1F,QAAM,EAAEC,EAAC,IAAKC,eAAeC,oBAAAA;AAC7B,QAAMC,eAAeC,iBAAiBC,iBAAAA;AAEtC,SACE,sBAAA,cAAA,MAAA,UAAA,MACGF,gBACC,sBAAA,cAACG,qBAAAA;IACCC,OAAOP,EAAE,6BAAA;IACTQ,WACE,sBAAA,cAACC,QAAQC,MAAI;MAACC,SAAQ;OACpB,sBAAA,cAACF,QAAQG,MAAI,MAAEZ,EAAE,2BAAA,CAAA,CAAA;KAIrB,sBAAA,cAACa,MAAMC,QAAM;IACXC,SAAShB,SAASiB;IAClBC,iBAAiB,CAACF,YAChBZ,aAAae,SAASC,OAAOC,SAAS;MACpCC,QAAQnB;MACRoB,QAAQC,oBAAoBC;MAC5BC,MAAM;QAAEC,OAAO,CAAC,CAACX;MAAQ;IAC3B,CAAA;;AAOd;;;AC3CA,IAAA,uBAAe;EACb;IACE,SAAS;MACP,CAACY,oBAAAA,GAAuB;QACtB,eAAe;QACf,6BAA6B;QAC7B,mCACE;QACF,oCAAoC;QACpC,kCAAkC;QAClC,mCAAmC;QACnC,+BAA+B;;QAE/B,6BACE;MACJ;IACF;EACF;;;;AF0BK,IAAMC,2BAA2B,CAACC,YACtCA,QAAQC,UAAiBC,gBAAiBF,SAAiDG;AAEvF,IAAMC,sBAAsB,CAACC,YAAAA;AAIlC,QAAMC,WAAWC,OAAmC,CAAC,CAAA;AACrD,QAAMC,QAAQ,IAAIC,kBAA4CC,oBAAAA;AAC9D,QAAMC,gBAAgB,IAAIC,mBAAAA;AAC1B,MAAIV;AAEJ,SAAO;IACLW;IACAC,YAAY,YAAA;AACVR,eAASS,UAAU,CAAE,MAAMC,wBAAwBX,QAAQY,SAAS;AACpET,YAAMU,OAAOC,QAAQ,MAAMC,sBAAsBf,QAAQY,SAAS;AAClET,YAAMa,KAAK;QAAEC,KAAK;QAAYC,MAAMd,kBAAkBe,KAAK;UAAEC,gBAAgB;QAAK,CAAA;MAAG,CAAA;IACvF;IACAC,OAAO,OAAOC,YAAAA;AACZ,YAAMC,aAAaC,cAAcF,SAASG,eAAAA;AAC1C,YAAMC,eAAeF,cAAcF,SAASK,iBAAAA;AAC5C,YAAMC,eAAeJ,cAAcF,SAASO,kBAAAA;AAE5C,YAAMC,WAAWF,cAAchC,UAAUmC,QAAQD;AACjD,UAAI,CAACA,UAAU;AACb;MACF;AAEA,YAAME,oBAAoB,YAAA;AACxB,cAAMC,cAAcP,cAAc9B,UAAUsC,QAAQC,QAAQtB,OAAOuB,SAASC,KAAKC,KAAKC;AACtF,cAAMC,SACJP,eAAeA,gBAAgB,QAAQ,CAACA,YAAYQ,SAAS,QAAA,KAAa,CAACR,YAAYQ,SAAS,MAAA;AAClG,YAAI,CAACtC,MAAMU,OAAO6B,YAAYF,QAAQ;AACpC,gBAAMV,SAAS;YACba,QAAQC,aAAaC;YACrBC,MAAM;cACJC,SAAS;cACTC,SAAS;gBACPC,IAAI,GAAG5C,oBAAAA;;gBAEP6C,OAAOC,qBAAa,CAAA,EAAG,OAAA,EAAS9C,oBAAAA,EAAsB,2BAAA;gBACtD+C,aAAaD,qBAAa,CAAA,EAAG,OAAA,EAAS9C,oBAAAA,EAAsB,iCAAA;gBAC5DgD,UAAUC;gBACVC,MAAM;gBACNC,aAAaL,qBAAa,CAAA,EAAG,OAAA,EAAS9C,oBAAAA,EAAsB,kCAAA;gBAC5DoD,WAAWN,qBAAa,CAAA,EAAG,OAAA,EAAS9C,oBAAAA,EAAsB,gCAAA;gBAC1DqD,YAAYP,qBAAa,CAAA,EAAG,OAAA,EAAS9C,oBAAAA,EAAsB,iCAAA;gBAC3DsD,UAAU,MAAM7B,SAAS;kBAAEa,QAAQiB,eAAeC;kBAAMf,MAAM;oBAAEnD,QAAQU;kBAAqB;gBAAE,CAAA;cACjG;YACF;UACF,CAAA;AAEAF,gBAAMU,OAAO6B,WAAW;QAC1B;MACF;AAIA,WAAK1C,QAAQH,cAAa,EAAGiE,KAAK,OAAOC,QAAAA;AACvClE,wBAAgBkE;AAGhBxC,oBAAY3B,UAAU0B,SAASZ,SAASsD,IAAI,CAACrE,WAC3CE,eAAeoE,OAAO,iBAAiBtE,MAAAA,IAAU,QAAQ,QAAA,CAAA;AAK3D,cAAMuC,SAASR,cAAc9B,UAAUsC;AACvC,YAAI,CAACA,QAAQ;AACX;QACF;AAEA,cAAMJ,SAAS;UACba,QAAQuB,oBAAoBC;UAC5BrB,MAAM;YACJsB,MAAM;YACNC,YAAY;cACVC,MAAMC,OAAOC,SAASF;;cAEtBG,cAAcF,OAAOG,YAAYC,OAAOC,eAAeL,OAAOG,YAAYC,OAAOE;YACnF;UACF;QACF,CAAA;AAEAC,gCAAwB9E,QAAQY,WAAWsB,QAAQrC,aAAAA;AAEnD,cAAMkF,QAAQC,IAAI;UAChBnF,cAAcoF,gBAAgB/C,OAAOgD,SAASA,QAAQ;UACtDrF,cAAcsF,oBAAoBjD,MAAAA;UAClCrC,cAAcuF,oBAAoBlD,OAAOgD,SAASA,QAAQ;UAC1DrF,cAAcwF,mBAAmBnD,QAAQlC,QAAQY,SAAS;SAC3D;AAED,YAAIsB,OAAOoD,KAAKC,SAASC,IAAG,GAAI;AAC9B,gBAAMxD,kBAAAA;QACR,OAAO;AACL,gBAAMyD,eAAevD,OAAOoD,KAAKC,SAASG,UAAU,OAAOH,aAAAA;AACzD,gBAAIA,YAAY1F,eAAe;AAC7B,oBAAMmC,kBAAAA;AACN,oBAAMnC,cAAcoF,gBAAgB/C,OAAOgD,SAASA,QAAQ;AAC5DO,2BAAaE,YAAW;YAC1B;UACF,CAAA;QACF;MACF,CAAA;IACF;IACAC,QAAQ,YAAA;AACNtF,oBAAcuF,MAAK;AACnB,YAAMhG,eAAeiG,MAAAA;IACvB;IACAlG,UAAU;MACRmC,QAAQ;QACNgE,UAAU,OAAOhE,QAAQT,YAAAA;AACvB,gBAAMY,SAASV,cAAcF,SAASK,iBAAAA,GAAoB/B,UAAUsC;AACpE,cAAI,CAACA,UAAU,CAACrC,eAAe;AAC7B;UACF;AAEA,kBAAQkC,OAAOY,QAAM;YACnB,KAAKuB,oBAAoB8B;AACvB/F,uBAASS,UAAU,CAACT,SAASS;AAC7Bb,4BAAcoG,MAAM;gBAClBC,YAAYC,uBAAuBjE,MAAAA;gBACnCkC,MAAM,GAAGpE,QAAQY,SAAS;gBAC1ByD,YAAY;kBACV3D,SAAST,SAASS;gBACpB;cACF,CAAA;AACAb,4BAAcuG,QAAQnG,SAASS,UAAU,UAAU,UAAA;AACnD,oBAAM2F,2BAA2BrG,QAAQY,WAAW,CAACX,SAASS,OAAO;AACrE,qBAAO;gBAAEoC,MAAM7C,SAASS;cAAQ;YAElC,KAAKwD,oBAAoBC,YAAY;AACnC,oBAAMrB,OAAOf,OAAOe;AACpB,oBAAMmD,QAAQ;gBACZC,YAAYC,uBAAuBjE,MAAAA;gBACnCkC,MAAM,GAAGpE,QAAQY,SAAS,IAAIkC,KAAKsB,IAAI;gBACvCC,YAAY;kBACV,GAAGvB,KAAKuB;gBACV;cACF;AACAxE,4BAAcoG,MAAMA,KAAAA;AACpB,qBAAO;gBAAEnD,MAAMmD;cAAM;YACvB;YAEA,KAAK/B,oBAAoBoC,uBAAuB;AAC9C,oBAAMC,WAAWxE,OAAOe;AAExBjD,4BAAc2G,oBAAoBD,SAASE,OAAOF,SAASnC,MAAMmC,SAASG,OAAO;AACjF,qBAAO;gBAAE5D,MAAM;cAAK;YACtB;UACF;QACF;MACF;MACAjD,eAAeM,MAAMU;MACrBZ;MACA0G,SAAS;QACPC,WAAW,CAAC,EAAEC,MAAM/D,KAAI,MAAE;AACxB,kBAAQ+D,MAAAA;YACN,KAAK;AACH,qBAAO/D,KAAKnD,WAAWa,aAAKyC,KAAK,gBAAA6D,OAAA,cAACC,uBAAAA;gBAAsB9G;mBAAyB;UACrF;AAEA,iBAAO;QACT;MACF;MACAkD;IACF;EACF;AACF;;;AGtNA,IAAA,cAAe6D;",
-  "names": ["React", "resolvePlugin", "parseIntentPlugin", "LayoutAction", "SettingsAction", "parsePluginHost", "EventSubscriptions", "create", "LocalStorageStore", "getTelemetryIdentifier", "setupTelemetryListeners", "isObservabilityDisabled", "storeObservabilityDisabled", "getObservabilityGroup", "parseClientPlugin", "React", "parseIntentPlugin", "useResolvePlugin", "Input", "Message", "useTranslation", "DeprecatedFormInput", "ObservabilitySettings", "settings", "t", "useTranslation", "OBSERVABILITY_PLUGIN", "intentPlugin", "useResolvePlugin", "parseIntentPlugin", "DeprecatedFormInput", "label", "secondary", "Message", "Root", "valence", "Body", "Input", "Switch", "checked", "enabled", "onCheckedChange", "provides", "intent", "dispatch", "plugin", "action", "ObservabilityAction", "TOGGLE", "data", "state", "OBSERVABILITY_PLUGIN", "parseObservabilityPlugin", "plugin", "provides", "observability", "undefined", "ObservabilityPlugin", "options", "settings", "create", "state", "LocalStorageStore", "OBSERVABILITY_PLUGIN", "subscriptions", "EventSubscriptions", "meta", "initialize", "enabled", "isObservabilityDisabled", "namespace", "values", "group", "getObservabilityGroup", "prop", "key", "type", "bool", "allowUndefined", "ready", "plugins", "pluginHost", "resolvePlugin", "parsePluginHost", "clientPlugin", "parseClientPlugin", "intentPlugin", "parseIntentPlugin", "dispatch", "intent", "sendPrivacyNotice", "environment", "client", "config", "runtime", "app", "env", "DX_ENVIRONMENT", "notify", "endsWith", "notified", "action", "LayoutAction", "SET_LAYOUT", "data", "element", "subject", "id", "title", "translations", "description", "duration", "Infinity", "icon", "actionLabel", "actionAlt", "closeLabel", "onAction", "SettingsAction", "OPEN", "then", "obs", "map", "setTag", "ObservabilityAction", "SEND_EVENT", "name", "properties", "href", "window", "location", "loadDuration", "performance", "timing", "loadEventEnd", "loadEventStart", "setupTelemetryListeners", "Promise", "all", "setIdentityTags", "services", "startRuntimeMetrics", "startNetworkMetrics", "startSpacesMetrics", "halo", "identity", "get", "subscription", "subscribe", "unsubscribe", "unload", "clear", "close", "resolver", "TOGGLE", "event", "identityId", "getTelemetryIdentifier", "setMode", "storeObservabilityDisabled", "CAPTURE_USER_FEEDBACK", "feedback", "captureUserFeedback", "email", "message", "surface", "component", "role", "React", "ObservabilitySettings", "ObservabilityPlugin"]
+  "sources": ["../../../src/capabilities/index.ts", "../../../src/events.ts", "../../../src/ObservabilityPlugin.ts", "../../../src/translations.ts"],
+  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { lazy } from '@dxos/app-framework';\n\nexport const ClientReady = lazy(() => import('./client-ready'));\nexport const IntentResolver = lazy(() => import('./intents-resolver'));\nexport const ReactSurface = lazy(() => import('./react-surface'));\nexport const ObservabilitySettings = lazy(() => import('./settings'));\nexport const ObservabilityState = lazy(() => import('./state'));\n\nexport * from './capabilities';\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineEvent, Events } from '@dxos/app-framework';\n\nimport { OBSERVABILITY_PLUGIN } from './meta';\n\nexport namespace ObservabilityEvents {\n  export const StateReady = Events.createStateEvent(OBSERVABILITY_PLUGIN);\n}\n\n// NOTE: This is cloned from the client plugin to avoid circular dependencies.\nexport const ClientReadyEvent = defineEvent('dxos.org/plugin/client/event/client-ready');\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { allOf, Capabilities, contributes, defineModule, definePlugin, Events } from '@dxos/app-framework';\nimport { type Observability } from '@dxos/observability';\n\nimport {\n  ClientReady,\n  IntentResolver,\n  ObservabilityCapabilities,\n  ObservabilitySettings,\n  ObservabilityState,\n  ReactSurface,\n} from './capabilities';\nimport { ObservabilityEvents, ClientReadyEvent } from './events';\nimport { meta } from './meta';\nimport translations from './translations';\n\nexport const ObservabilityPlugin = (options: { namespace: string; observability: () => Promise<Observability> }) =>\n  definePlugin(meta, [\n    defineModule({\n      id: `${meta.id}/module/observability`,\n      activatesOn: Events.Startup,\n      activate: async () => contributes(ObservabilityCapabilities.Observability, await options.observability()),\n    }),\n    defineModule({\n      id: `${meta.id}/module/settings`,\n      activatesOn: Events.SetupSettings,\n      activate: ObservabilitySettings,\n    }),\n    defineModule({\n      id: `${meta.id}/module/state`,\n      activatesOn: Events.Startup,\n      activatesAfter: [ObservabilityEvents.StateReady],\n      activate: () => ObservabilityState({ namespace: options.namespace }),\n    }),\n    defineModule({\n      id: `${meta.id}/module/translations`,\n      activatesOn: Events.SetupTranslations,\n      activate: () => contributes(Capabilities.Translations, translations),\n    }),\n    defineModule({\n      id: `${meta.id}/module/intent-resolver`,\n      activatesOn: Events.SetupIntents,\n      activate: (context) => IntentResolver({ context, namespace: options.namespace }),\n    }),\n    defineModule({\n      id: `${meta.id}/module/react-surface`,\n      activatesOn: Events.SetupSurfaces,\n      activate: ReactSurface,\n    }),\n    defineModule({\n      id: `${meta.id}/module/client-ready`,\n      activatesOn: allOf(Events.DispatcherReady, ObservabilityEvents.StateReady, ClientReadyEvent),\n      activate: async (context) => {\n        const observability = await options.observability();\n        return ClientReady({ context, observability, namespace: options.namespace });\n      },\n    }),\n  ]);\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { OBSERVABILITY_PLUGIN } from './meta';\n\nexport default [\n  {\n    'en-US': {\n      [OBSERVABILITY_PLUGIN]: {\n        'plugin name': 'Telemetry',\n        'observability toast label': 'Privacy Notice',\n        'observability toast description':\n          'Composer collects usage and performance metrics to improve the product. No user data is collected.',\n        'observability toast action label': 'Settings',\n        'observability toast action alt': 'Open settings to learn more or to disable.',\n        'observability toast close label': 'Okay',\n        'observability enabled label': 'Enable telemetry',\n        // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.\n        'observability description':\n          '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.',\n      },\n    },\n  },\n];\n"],
+  "mappings": ";;;;;;;;;;AAIA,SAASA,YAAY;AAEd,IAAMC,cAAcC,KAAK,MAAM,OAAO,6BAAA,CAAA;AACtC,IAAMC,iBAAiBD,KAAK,MAAM,OAAO,iCAAA,CAAA;AACzC,IAAME,eAAeF,KAAK,MAAM,OAAO,8BAAA,CAAA;AACvC,IAAMG,wBAAwBH,KAAK,MAAM,OAAO,yBAAA,CAAA;AAChD,IAAMI,qBAAqBJ,KAAK,MAAM,OAAO,sBAAA,CAAA;;;ACNpD,SAASK,aAAaC,cAAc;;UAInBC,sBAAAA;uBACFC,aAAaC,OAAOC,iBAAiBC,oBAAAA;AACpD,GAFiBJ,wBAAAA,sBAAAA,CAAAA,EAAAA;AAKV,IAAMK,mBAAmBC,YAAY,2CAAA;;;ACT5C,SAASC,OAAOC,cAAcC,aAAaC,cAAcC,cAAcC,UAAAA,eAAc;;;ACErF,IAAA,uBAAe;EACb;IACE,SAAS;MACP,CAACC,oBAAAA,GAAuB;QACtB,eAAe;QACf,6BAA6B;QAC7B,mCACE;QACF,oCAAoC;QACpC,kCAAkC;QAClC,mCAAmC;QACnC,+BAA+B;;QAE/B,6BACE;MACJ;IACF;EACF;;;;ADJK,IAAMC,sBAAsB,CAACC,YAClCC,aAAaC,MAAM;EACjBC,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAaC,QAAOC;IACpBC,UAAU,YAAYC,YAAYC,0BAA0BC,eAAe,MAAMX,QAAQY,cAAa,CAAA;EACxG,CAAA;EACAT,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAaC,QAAOO;IACpBL,UAAUM;EACZ,CAAA;EACAX,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAaC,QAAOC;IACpBQ,gBAAgB;MAACC,oBAAoBC;;IACrCT,UAAU,MAAMU,mBAAmB;MAAEC,WAAWnB,QAAQmB;IAAU,CAAA;EACpE,CAAA;EACAhB,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAaC,QAAOc;IACpBZ,UAAU,MAAMC,YAAYY,aAAaC,cAAcC,oBAAAA;EACzD,CAAA;EACApB,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAaC,QAAOkB;IACpBhB,UAAU,CAACiB,YAAYC,eAAe;MAAED;MAASN,WAAWnB,QAAQmB;IAAU,CAAA;EAChF,CAAA;EACAhB,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAaC,QAAOqB;IACpBnB,UAAUoB;EACZ,CAAA;EACAzB,aAAa;IACXC,IAAI,GAAGF,KAAKE,EAAE;IACdC,aAAawB,MAAMvB,QAAOwB,iBAAiBd,oBAAoBC,YAAYc,gBAAAA;IAC3EvB,UAAU,OAAOiB,YAAAA;AACf,YAAMb,gBAAgB,MAAMZ,QAAQY,cAAa;AACjD,aAAOoB,YAAY;QAAEP;QAASb;QAAeO,WAAWnB,QAAQmB;MAAU,CAAA;IAC5E;EACF,CAAA;CACD;",
+  "names": ["lazy", "ClientReady", "lazy", "IntentResolver", "ReactSurface", "ObservabilitySettings", "ObservabilityState", "defineEvent", "Events", "ObservabilityEvents", "StateReady", "Events", "createStateEvent", "OBSERVABILITY_PLUGIN", "ClientReadyEvent", "defineEvent", "allOf", "Capabilities", "contributes", "defineModule", "definePlugin", "Events", "OBSERVABILITY_PLUGIN", "ObservabilityPlugin", "options", "definePlugin", "meta", "defineModule", "id", "activatesOn", "Events", "Startup", "activate", "contributes", "ObservabilityCapabilities", "Observability", "observability", "SetupSettings", "ObservabilitySettings", "activatesAfter", "ObservabilityEvents", "StateReady", "ObservabilityState", "namespace", "SetupTranslations", "Capabilities", "Translations", "translations", "SetupIntents", "context", "IntentResolver", "SetupSurfaces", "ReactSurface", "allOf", "DispatcherReady", "ClientReadyEvent", "ClientReady"]
 }

package/dist/lib/node-esm/intents-resolver-PZS43GGV.mjs

@@ -0,0 +1,65 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  ObservabilityAction
+} from "./chunk-DSC5SQ7W.mjs";
+import {
+  ClientCapability,
+  ObservabilityCapabilities
+} from "./chunk-KPH3N6JS.mjs";
+import {
+  OBSERVABILITY_PLUGIN
+} from "./chunk-HTL7V6A2.mjs";
+
+// packages/plugins/plugin-observability/src/capabilities/intents-resolver.ts
+import { Capabilities, contributes, createResolver } from "@dxos/app-framework";
+import { getTelemetryIdentifier, storeObservabilityDisabled } from "@dxos/observability";
+var intents_resolver_default = ({ context, namespace }) => contributes(Capabilities.IntentResolver, [
+  createResolver({
+    intent: ObservabilityAction.Toggle,
+    resolve: async ({ state }) => {
+      const client = context.requestCapability(ClientCapability);
+      const observability = context.requestCapability(ObservabilityCapabilities.Observability);
+      const settings = context.requestCapability(Capabilities.SettingsStore).getStore(OBSERVABILITY_PLUGIN).value;
+      settings.enabled = state ?? !settings.enabled;
+      observability.event({
+        identityId: getTelemetryIdentifier(client),
+        name: `${namespace}.observability.toggle`,
+        properties: {
+          enabled: settings.enabled
+        }
+      });
+      observability.setMode(settings.enabled ? "basic" : "disabled");
+      await storeObservabilityDisabled(namespace, !settings.enabled);
+      return {
+        data: settings.enabled
+      };
+    }
+  }),
+  createResolver({
+    intent: ObservabilityAction.SendEvent,
+    resolve: (data) => {
+      const client = context.requestCapability(ClientCapability);
+      void context.waitForCapability(ObservabilityCapabilities.Observability).then((observability) => {
+        const event = {
+          identityId: getTelemetryIdentifier(client),
+          name: `${namespace}.${data.name}`,
+          properties: {
+            ...data.properties
+          }
+        };
+        observability.event(event);
+      });
+    }
+  }),
+  createResolver({
+    intent: ObservabilityAction.CaptureUserFeedback,
+    resolve: async (data) => {
+      const observability = context.requestCapability(ObservabilityCapabilities.Observability);
+      observability.captureUserFeedback(data.email, data.name, data.message);
+    }
+  })
+]);
+export {
+  intents_resolver_default as default
+};
+//# sourceMappingURL=intents-resolver-PZS43GGV.mjs.map

package/dist/lib/node-esm/intents-resolver-PZS43GGV.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/capabilities/intents-resolver.ts"],
+  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Capabilities, contributes, createResolver, type PluginsContext } from '@dxos/app-framework';\nimport { getTelemetryIdentifier, storeObservabilityDisabled } from '@dxos/observability';\n\nimport { ClientCapability, ObservabilityCapabilities } from './capabilities';\nimport { type ObservabilitySettingsProps } from '../components';\nimport { OBSERVABILITY_PLUGIN } from '../meta';\nimport { ObservabilityAction } from '../types';\n\nexport default ({ context, namespace }: { context: PluginsContext; namespace: string }) =>\n  contributes(Capabilities.IntentResolver, [\n    createResolver({\n      intent: ObservabilityAction.Toggle,\n      resolve: async ({ state }) => {\n        const client = context.requestCapability(ClientCapability);\n        const observability = context.requestCapability(ObservabilityCapabilities.Observability);\n        const settings = context\n          .requestCapability(Capabilities.SettingsStore)\n          .getStore<ObservabilitySettingsProps>(OBSERVABILITY_PLUGIN)!.value;\n        settings.enabled = state ?? !settings.enabled;\n        observability.event({\n          identityId: getTelemetryIdentifier(client),\n          name: `${namespace}.observability.toggle`,\n          properties: {\n            enabled: settings.enabled,\n          },\n        });\n        observability.setMode(settings.enabled ? 'basic' : 'disabled');\n        await storeObservabilityDisabled(namespace, !settings.enabled);\n        return { data: settings.enabled };\n      },\n    }),\n    createResolver({\n      intent: ObservabilityAction.SendEvent,\n      resolve: (data) => {\n        const client = context.requestCapability(ClientCapability);\n        // NOTE: This is to ensure that events fired before observability is ready are still sent.\n        // TODO(wittjosiah): If the intent dispatcher supports concurrent actions in the future,\n        //   then this could awaited still rather than voiding.\n        void context.waitForCapability(ObservabilityCapabilities.Observability).then((observability) => {\n          const event = {\n            identityId: getTelemetryIdentifier(client),\n            name: `${namespace}.${data.name}`,\n            properties: {\n              ...data.properties,\n            },\n          };\n          observability.event(event);\n        });\n      },\n    }),\n    createResolver({\n      intent: ObservabilityAction.CaptureUserFeedback,\n      resolve: async (data) => {\n        const observability = context.requestCapability(ObservabilityCapabilities.Observability);\n        observability.captureUserFeedback(data.email, data.name, data.message);\n      },\n    }),\n  ]);\n"],
+  "mappings": ";;;;;;;;;;;;;AAIA,SAASA,cAAcC,aAAaC,sBAA2C;AAC/E,SAASC,wBAAwBC,kCAAkC;AAOnE,IAAA,2BAAe,CAAC,EAAEC,SAASC,UAAS,MAClCC,YAAYC,aAAaC,gBAAgB;EACvCC,eAAe;IACbC,QAAQC,oBAAoBC;IAC5BC,SAAS,OAAO,EAAEC,MAAK,MAAE;AACvB,YAAMC,SAASX,QAAQY,kBAAkBC,gBAAAA;AACzC,YAAMC,gBAAgBd,QAAQY,kBAAkBG,0BAA0BC,aAAa;AACvF,YAAMC,WAAWjB,QACdY,kBAAkBT,aAAae,aAAa,EAC5CC,SAAqCC,oBAAAA,EAAuBC;AAC/DJ,eAASK,UAAUZ,SAAS,CAACO,SAASK;AACtCR,oBAAcS,MAAM;QAClBC,YAAYC,uBAAuBd,MAAAA;QACnCe,MAAM,GAAGzB,SAAAA;QACT0B,YAAY;UACVL,SAASL,SAASK;QACpB;MACF,CAAA;AACAR,oBAAcc,QAAQX,SAASK,UAAU,UAAU,UAAA;AACnD,YAAMO,2BAA2B5B,WAAW,CAACgB,SAASK,OAAO;AAC7D,aAAO;QAAEQ,MAAMb,SAASK;MAAQ;IAClC;EACF,CAAA;EACAjB,eAAe;IACbC,QAAQC,oBAAoBwB;IAC5BtB,SAAS,CAACqB,SAAAA;AACR,YAAMnB,SAASX,QAAQY,kBAAkBC,gBAAAA;AAIzC,WAAKb,QAAQgC,kBAAkBjB,0BAA0BC,aAAa,EAAEiB,KAAK,CAACnB,kBAAAA;AAC5E,cAAMS,QAAQ;UACZC,YAAYC,uBAAuBd,MAAAA;UACnCe,MAAM,GAAGzB,SAAAA,IAAa6B,KAAKJ,IAAI;UAC/BC,YAAY;YACV,GAAGG,KAAKH;UACV;QACF;AACAb,sBAAcS,MAAMA,KAAAA;MACtB,CAAA;IACF;EACF,CAAA;EACAlB,eAAe;IACbC,QAAQC,oBAAoB2B;IAC5BzB,SAAS,OAAOqB,SAAAA;AACd,YAAMhB,gBAAgBd,QAAQY,kBAAkBG,0BAA0BC,aAAa;AACvFF,oBAAcqB,oBAAoBL,KAAKM,OAAON,KAAKJ,MAAMI,KAAKO,OAAO;IACvE;EACF,CAAA;CACD;",
+  "names": ["Capabilities", "contributes", "createResolver", "getTelemetryIdentifier", "storeObservabilityDisabled", "context", "namespace", "contributes", "Capabilities", "IntentResolver", "createResolver", "intent", "ObservabilityAction", "Toggle", "resolve", "state", "client", "requestCapability", "ClientCapability", "observability", "ObservabilityCapabilities", "Observability", "settings", "SettingsStore", "getStore", "OBSERVABILITY_PLUGIN", "value", "enabled", "event", "identityId", "getTelemetryIdentifier", "name", "properties", "setMode", "storeObservabilityDisabled", "data", "SendEvent", "waitForCapability", "then", "CaptureUserFeedback", "captureUserFeedback", "email", "message"]
+}