@wix/monitoring-types 0.2.0 → 0.4.0

package/build/index.d.mts

@@ -14,11 +14,11 @@ interface HostMonitoringContext {
     /**
      * The version of the application.
      */
-    appVersion: string;
+    appVersion?: string;
     /**
      * The unique identifier for the application instance.
      */
-    appInstanceId: string;
+    appInstanceId?: string;
     /**
      * The unique identifier for the extension.
      */
@@ -27,10 +27,6 @@ interface HostMonitoringContext {
      * The name of the extension.
      */
     extensionName?: string;
-    /**
-     * The platform the extension is on. (e.g. 'dashboard', 'editor', 'site', 'backend)
-     */
-    extensionPlatform?: string;
     /**
      * The type of the extension on the platform. (e.g. backend: ['api', 'events], dashboard: ['widget', 'page'], site: ['component', 'widget'])
      */
@@ -88,19 +84,41 @@ interface CaptureContext {
     contexts?: Contexts;
 }
 interface MonitoringClient {
-    captureException(error: unknown, context?: CaptureContext): void;
-    captureMessage(message: string, context?: CaptureContext): void;
-    startSpan<T>(options: SpanOptions, callback: (span: Span | undefined) => T): T;
+    /**
+     * Captures an exception event and sends it to Sentry.
+     * @param error The error to capture
+     * @param captureContext Optional additional data to attach to the Sentry e vent.
+     * @returns the id of the captured Sentry event.
+     */
+    captureException(error: unknown, captureContext?: CaptureContext): string;
+    /**
+     * Captures a message event and sends it to Sentry.
+     * @param message The message to capture
+     * @param captureContext Define the level of the message or pass in additional data to attach to the message.
+     * @returns the id of the captured message.
+     */
+    captureMessage(message: string, captureContext?: CaptureContext): string;
+    /**
+     * Wraps a function with a span and finishes the span after the function is done. The created span is the active span and will be used as parent by other spans created inside the function, as long as the function is executed while the scope is active.
+     * @param spanOptions The options for the span
+     * @param callback The function to wrap with a span
+     * @returns The return value of the callback
+     */
+    startSpan<T>(spanOptions: SpanOptions, callback: (span: Span | undefined) => T): T;
+    /**
+     * Records a new breadcrumb which will be attached to future events.
+     * Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.
+     * @param breadcrumb The breadcrumb to record.
+     */
     addBreadcrumb(breadcrumb: Breadcrumb): void;
 }
 
 interface EventTags extends Tags {
     'app.id': string;
-    'app.version': string;
-    'app.instanceId': string;
+    'app.version'?: string;
+    'app.instanceId'?: string;
     'extension.id'?: string;
     'extension.name'?: string;
-    'extension.platform'?: string;
     'extension.type'?: string;
 }
 interface EventContexts extends Contexts {
@@ -125,4 +143,25 @@ interface EventData {
     contexts: EventContexts;
 }
 
-export type { Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
+/**
+ * Represents the configuration for app's monitoring.
+ * The configuration includes the type of monitoring provider and its options.
+ * Currently, only Sentry is supported as a monitoring provider.
+ */
+interface AppMonitoringConfig {
+    /**
+     * The type of monitoring provider.
+     */
+    type: 'SENTRY' | 'UNKNOWN_PROVIDER';
+    /**
+     * The options for the Sentry monitoring provider.
+     */
+    sentryOptions?: {
+        /**
+         * The Data Source Name (DSN) for the Sentry monitoring provider.
+         */
+        dsn: string;
+    };
+}
+
+export type { AppMonitoringConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };

package/build/index.d.ts

@@ -14,11 +14,11 @@ interface HostMonitoringContext {
     /**
      * The version of the application.
      */
-    appVersion: string;
+    appVersion?: string;
     /**
      * The unique identifier for the application instance.
      */
-    appInstanceId: string;
+    appInstanceId?: string;
     /**
      * The unique identifier for the extension.
      */
@@ -27,10 +27,6 @@ interface HostMonitoringContext {
      * The name of the extension.
      */
     extensionName?: string;
-    /**
-     * The platform the extension is on. (e.g. 'dashboard', 'editor', 'site', 'backend)
-     */
-    extensionPlatform?: string;
     /**
      * The type of the extension on the platform. (e.g. backend: ['api', 'events], dashboard: ['widget', 'page'], site: ['component', 'widget'])
      */
@@ -88,19 +84,41 @@ interface CaptureContext {
     contexts?: Contexts;
 }
 interface MonitoringClient {
-    captureException(error: unknown, context?: CaptureContext): void;
-    captureMessage(message: string, context?: CaptureContext): void;
-    startSpan<T>(options: SpanOptions, callback: (span: Span | undefined) => T): T;
+    /**
+     * Captures an exception event and sends it to Sentry.
+     * @param error The error to capture
+     * @param captureContext Optional additional data to attach to the Sentry e vent.
+     * @returns the id of the captured Sentry event.
+     */
+    captureException(error: unknown, captureContext?: CaptureContext): string;
+    /**
+     * Captures a message event and sends it to Sentry.
+     * @param message The message to capture
+     * @param captureContext Define the level of the message or pass in additional data to attach to the message.
+     * @returns the id of the captured message.
+     */
+    captureMessage(message: string, captureContext?: CaptureContext): string;
+    /**
+     * Wraps a function with a span and finishes the span after the function is done. The created span is the active span and will be used as parent by other spans created inside the function, as long as the function is executed while the scope is active.
+     * @param spanOptions The options for the span
+     * @param callback The function to wrap with a span
+     * @returns The return value of the callback
+     */
+    startSpan<T>(spanOptions: SpanOptions, callback: (span: Span | undefined) => T): T;
+    /**
+     * Records a new breadcrumb which will be attached to future events.
+     * Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.
+     * @param breadcrumb The breadcrumb to record.
+     */
     addBreadcrumb(breadcrumb: Breadcrumb): void;
 }
 
 interface EventTags extends Tags {
     'app.id': string;
-    'app.version': string;
-    'app.instanceId': string;
+    'app.version'?: string;
+    'app.instanceId'?: string;
     'extension.id'?: string;
     'extension.name'?: string;
-    'extension.platform'?: string;
     'extension.type'?: string;
 }
 interface EventContexts extends Contexts {
@@ -125,4 +143,25 @@ interface EventData {
     contexts: EventContexts;
 }
 
-export type { Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
+/**
+ * Represents the configuration for app's monitoring.
+ * The configuration includes the type of monitoring provider and its options.
+ * Currently, only Sentry is supported as a monitoring provider.
+ */
+interface AppMonitoringConfig {
+    /**
+     * The type of monitoring provider.
+     */
+    type: 'SENTRY' | 'UNKNOWN_PROVIDER';
+    /**
+     * The options for the Sentry monitoring provider.
+     */
+    sentryOptions?: {
+        /**
+         * The Data Source Name (DSN) for the Sentry monitoring provider.
+         */
+        dsn: string;
+    };
+}
+
+export type { AppMonitoringConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/monitoring-types",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Gili Shohat",
@@ -29,12 +29,12 @@
     "*.{js,ts}": "yarn lint"
   },
   "devDependencies": {
-    "@types/node": "^20.17.9",
+    "@types/node": "^20.17.12",
     "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
     "tsup": "^7.3.0",
-    "type-fest": "^4.30.0",
-    "typescript": "^5.7.2"
+    "type-fest": "^4.32.0",
+    "typescript": "^5.7.3"
   },
   "eslintConfig": {
     "extends": "sdk"
@@ -53,5 +53,5 @@
       ]
     }
   },
-  "falconPackageHash": "82857561d35e1c7eec17ace7a7370e97f288aded7c93ce35dcc5be6e"
+  "falconPackageHash": "f5b6aae3eca514279438277851c0c6ab98b89f570229a737e9274223"
 }