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

package/dist/types/src/meta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,eAAO,MAAM,oBAAoB,kCAAkC,CAAC;AAEpE,eAAO,MAAM,IAAI,EAAE,UAIlB,CAAC"}
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,IAQzB,CAAC"}

package/dist/types/src/translations.d.ts

@@ -1,22 +1,24 @@
-declare const _default: {
-    'en-US': {
-        "dxos.org/plugin/observability": {
-            'plugin name': string;
-            'observability toast label': string;
-            'observability toast description': string;
-            'observability toast action label': string;
-            'observability toast action alt': string;
-            'observability toast close label': string;
-            'observability enabled label': string;
-            'observability description': string;
-            'help label': string;
-            'feedback text area label': string;
-            'feedback text area placeholder': string;
-            'send feedback label': string;
-            'feedback toast label': string;
-            'feedback toast description': string;
+import { meta } from './meta';
+export declare const translations: [{
+    readonly 'en-US': {
+        readonly [meta.id]: {
+            readonly 'plugin name': "Telemetry";
+            readonly 'settings title': "Telemetry settings";
+            readonly 'observability toast label': "Privacy Notice";
+            readonly 'observability toast description': "Composer collects usage and performance metrics to improve the product. No user data is collected.";
+            readonly 'observability toast action label': "Settings";
+            readonly 'observability toast action alt': "Open settings to learn more or to disable.";
+            readonly 'observability toast close label': "Okay";
+            readonly 'observability enabled label': "Enable telemetry";
+            readonly '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.";
+            readonly 'help label': "Feedback & Support";
+            readonly 'feedback textarea label': "Feedback";
+            readonly 'feedback textarea placeholder': "Please enter your feedback, technical issue, or feature request.";
+            readonly 'include debug logs label': "Include debug logs";
+            readonly 'send feedback label': "Send Feedback";
+            readonly 'feedback toast label': "Thank you for your feedback!";
+            readonly 'feedback toast description': "We will review your feedback and get back to you as soon as possible.";
         };
     };
-}[];
-export default _default;
+}];
 //# sourceMappingURL=translations.d.ts.map

package/dist/types/src/translations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAMA,wBAyBE"}
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,eAAO,MAAM,YAAY;;QAGnB,SAAA,CAAC,IAAI,CAAC,EAAE,CAAC;;;;;;;;;;;;;;;;;UAqBR;;EAGwB,CAAC"}

package/dist/types/src/types/capabilities.d.ts

@@ -0,0 +1,27 @@
+import { type Atom } from '@effect-atom/atom-react';
+import * as Schema from 'effect/Schema';
+import { Capability } from '@dxos/app-framework';
+import { type Client } from '@dxos/client';
+import { type Observability } from '@dxos/observability';
+export declare namespace ObservabilityCapabilities {
+    const Settings: Capability.InterfaceDef<Atom.Writable<{
+        enabled: boolean;
+    }, {
+        enabled: boolean;
+    }>>;
+    const StateSchema: Schema.mutable<Schema.Struct<{
+        group: Schema.optional<typeof Schema.String>;
+        notified: Schema.optional<typeof Schema.Boolean>;
+    }>>;
+    type State = Schema.Schema.Type<typeof StateSchema>;
+    const State: Capability.InterfaceDef<Atom.Writable<{
+        group?: string | undefined;
+        notified?: boolean | undefined;
+    }, {
+        group?: string | undefined;
+        notified?: boolean | undefined;
+    }>>;
+    const Observability: Capability.InterfaceDef<Observability.Observability>;
+}
+export declare const ClientCapability: Capability.InterfaceDef<Client>;
+//# sourceMappingURL=capabilities.d.ts.map

package/dist/types/src/types/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../../src/types/capabilities.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAKzD,yBAAiB,yBAAyB,CAAC;IAClC,MAAM,QAAQ;;;;OAA+F,CAAC;IAE9G,MAAM,WAAW;;;OAKvB,CAAC;IAEF,KAAY,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpD,MAAM,KAAK;;;;;;OAAuE,CAAC;IAEnF,MAAM,aAAa,sDAAsF,CAAC;CAClH;AAID,eAAO,MAAM,gBAAgB,iCAAsE,CAAC"}

package/dist/types/src/types/events.d.ts

@@ -0,0 +1,6 @@
+import { ActivationEvent } from '@dxos/app-framework';
+export declare namespace ObservabilityEvents {
+    const StateReady: ActivationEvent.ActivationEvent;
+}
+export declare const ClientReadyEvent: ActivationEvent.ActivationEvent;
+//# sourceMappingURL=events.d.ts.map

package/dist/types/src/types/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/types/events.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAKtD,yBAAiB,mBAAmB,CAAC;IAC5B,MAAM,UAAU,EAAE,eAAe,CAAC,eAA+D,CAAC;CAC1G;AAGD,eAAO,MAAM,gBAAgB,iCAAoE,CAAC"}

package/dist/types/src/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './capabilities';
+export * from './events';
+export * from './schema';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/index.ts"],"names":[],"mappings":"AAIA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/dist/types/src/types/schema.d.ts

@@ -0,0 +1,63 @@
+import * as Schema from 'effect/Schema';
+import { Capability } from '@dxos/app-framework';
+export declare const UserFeedback: Schema.Struct<{
+    message: Schema.refine<string, Schema.filter<typeof Schema.String>>;
+    includeLogs: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+}>;
+export type UserFeedback = Schema.Schema.Type<typeof UserFeedback>;
+/**
+ * Operations for the Observability plugin.
+ */
+export declare namespace ObservabilityOperation {
+    const Toggle: Omit<{
+        readonly meta: {
+            readonly key: `${string}/toggle`;
+            readonly name: "Toggle Observability";
+            readonly description: "Toggle observability on or off.";
+        };
+        readonly services: readonly [typeof Capability.Service];
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                state: Schema.optional<typeof Schema.Boolean>;
+            }>;
+            readonly output: typeof Schema.Boolean;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
+    const CaptureUserFeedback: Omit<{
+        readonly meta: {
+            readonly key: `${string}/capture-feedback`;
+            readonly name: "Capture User Feedback";
+            readonly description: "Capture user feedback.";
+        };
+        readonly services: readonly [typeof Capability.Service];
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                message: Schema.refine<string, Schema.filter<typeof Schema.String>>;
+                includeLogs: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+            }>;
+            readonly output: typeof Schema.Void;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
+    const SendEvent: Omit<{
+        readonly meta: {
+            readonly key: `${string}/send-event`;
+            readonly name: "Send Event";
+            readonly description: "Send an observability event.";
+        };
+        readonly services: readonly [typeof Capability.Service];
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                name: Schema.SchemaClass<string, string, never>;
+                properties: Schema.optional<typeof Schema.Any>;
+            }>;
+            readonly output: typeof Schema.Void;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
+}
+//# sourceMappingURL=schema.d.ts.map

package/dist/types/src/types/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/types/schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AASjD,eAAO,MAAM,YAAY;;;EAevB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC,CAAC;AAInE;;GAEG;AACH,yBAAiB,sBAAsB,CAAC;IAC/B,MAAM,MAAM;;;;;;;;;;;;;;;KAajB,CAAC;IAEI,MAAM,mBAAmB;;;;;;;;;;;;;;;;KAW9B,CAAC;IAEI,MAAM,SAAS;;;;;;;;;;;;;;;;KAcpB,CAAC;CACJ"}