@wix/monitoring-types 0.9.0 → 0.11.0

package/build/index.d.mts

@@ -62,10 +62,17 @@ interface Span {
     spanContext(): SpanContextData;
     end(): void;
 }
+interface ManualSpan {
+    end(): void;
+    fail(error: unknown): void;
+}
 interface SpanOptions {
     name: string;
     tags?: Tags;
 }
+interface EndSpanOptions {
+    name: string;
+}
 interface Breadcrumb {
     type?: string;
     category?: string;
@@ -83,14 +90,12 @@ interface MonitoringClient {
      * 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): void;
     /**
      * 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): void;
     /**
@@ -99,7 +104,19 @@ interface MonitoringClient {
      * @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): Promise<T>;
+    startSpan<T>(spanOptions: SpanOptions, callback: (span: Span | undefined) => T): T;
+    /**
+     * Starts a manual span. The span needs to be finished manually by either calling end() or fail() using the returned span object or by calling endSpanManual().
+     * @param spanOptions The options for the span
+     * @returns A span object that allows to end the span successfully or fail it.
+     */
+    startSpanManual(spanOptions: SpanOptions): ManualSpan;
+    /**
+     * Ends a manual span and sends it to Sentry. Spans can be ended using a MonitoringClient instance which wasn't necessarily used to start the span.
+     * Calling this method will end the last span with the same name that was started using startSpanManual() and will ignore the others.
+     * @param spanOptions The options for the span
+     */
+    endSpanManual(spanOptions: EndSpanOptions): void;
     /**
      * 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.
@@ -157,6 +174,15 @@ interface AppMonitoringSentryConfig {
         dsn: string;
     };
 }
+/**
+ * Represents the Panorama configuration for app's monitoring.
+ */
+interface AppMonitoringPanoramaConfig {
+    /**
+     * The type of monitoring provider.
+     */
+    type: 'PANORAMA';
+}
 interface AppMonitoringUnknownConfig {
     type: 'UNKNOWN_PROVIDER';
 }
@@ -165,6 +191,6 @@ interface AppMonitoringUnknownConfig {
  * The configuration includes the type of monitoring provider and its options.
  * Currently, only Sentry is supported as a monitoring provider.
  */
-type AppMonitoringConfig = AppMonitoringSentryConfig | AppMonitoringUnknownConfig;
+type AppMonitoringConfig = AppMonitoringSentryConfig | AppMonitoringPanoramaConfig | AppMonitoringUnknownConfig;
 
-export type { AppMonitoringConfig, AppMonitoringSentryConfig, AppMonitoringUnknownConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
+export type { AppMonitoringConfig, AppMonitoringPanoramaConfig, AppMonitoringSentryConfig, AppMonitoringUnknownConfig, Breadcrumb, CaptureContext, Context, Contexts, EndSpanOptions, EventContexts, EventData, EventTags, HostMonitoringContext, ManualSpan, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };

package/build/index.d.ts

@@ -62,10 +62,17 @@ interface Span {
     spanContext(): SpanContextData;
     end(): void;
 }
+interface ManualSpan {
+    end(): void;
+    fail(error: unknown): void;
+}
 interface SpanOptions {
     name: string;
     tags?: Tags;
 }
+interface EndSpanOptions {
+    name: string;
+}
 interface Breadcrumb {
     type?: string;
     category?: string;
@@ -83,14 +90,12 @@ interface MonitoringClient {
      * 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): void;
     /**
      * 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): void;
     /**
@@ -99,7 +104,19 @@ interface MonitoringClient {
      * @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): Promise<T>;
+    startSpan<T>(spanOptions: SpanOptions, callback: (span: Span | undefined) => T): T;
+    /**
+     * Starts a manual span. The span needs to be finished manually by either calling end() or fail() using the returned span object or by calling endSpanManual().
+     * @param spanOptions The options for the span
+     * @returns A span object that allows to end the span successfully or fail it.
+     */
+    startSpanManual(spanOptions: SpanOptions): ManualSpan;
+    /**
+     * Ends a manual span and sends it to Sentry. Spans can be ended using a MonitoringClient instance which wasn't necessarily used to start the span.
+     * Calling this method will end the last span with the same name that was started using startSpanManual() and will ignore the others.
+     * @param spanOptions The options for the span
+     */
+    endSpanManual(spanOptions: EndSpanOptions): void;
     /**
      * 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.
@@ -157,6 +174,15 @@ interface AppMonitoringSentryConfig {
         dsn: string;
     };
 }
+/**
+ * Represents the Panorama configuration for app's monitoring.
+ */
+interface AppMonitoringPanoramaConfig {
+    /**
+     * The type of monitoring provider.
+     */
+    type: 'PANORAMA';
+}
 interface AppMonitoringUnknownConfig {
     type: 'UNKNOWN_PROVIDER';
 }
@@ -165,6 +191,6 @@ interface AppMonitoringUnknownConfig {
  * The configuration includes the type of monitoring provider and its options.
  * Currently, only Sentry is supported as a monitoring provider.
  */
-type AppMonitoringConfig = AppMonitoringSentryConfig | AppMonitoringUnknownConfig;
+type AppMonitoringConfig = AppMonitoringSentryConfig | AppMonitoringPanoramaConfig | AppMonitoringUnknownConfig;
 
-export type { AppMonitoringConfig, AppMonitoringSentryConfig, AppMonitoringUnknownConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
+export type { AppMonitoringConfig, AppMonitoringPanoramaConfig, AppMonitoringSentryConfig, AppMonitoringUnknownConfig, Breadcrumb, CaptureContext, Context, Contexts, EndSpanOptions, EventContexts, EventData, EventTags, HostMonitoringContext, ManualSpan, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/monitoring-types",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Gili Shohat",
@@ -29,12 +29,12 @@
     "*.{js,ts}": "yarn lint"
   },
   "devDependencies": {
-    "@types/node": "^20.17.19",
+    "@types/node": "^20.17.30",
     "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
-    "tsup": "^8.3.6",
-    "type-fest": "^4.35.0",
-    "typescript": "^5.7.3"
+    "tsup": "^8.4.0",
+    "type-fest": "^4.39.1",
+    "typescript": "^5.8.3"
   },
   "eslintConfig": {
     "extends": "sdk"
@@ -53,5 +53,5 @@
       ]
     }
   },
-  "falconPackageHash": "20a6784fe7596565cccd81bf2cfe6c1a3a27963131b6b00c7218c19b"
+  "falconPackageHash": "bd7ab85ab0ea7b3081acd419ee43dfd3742c18e6bdc1f9bf7e4326bc"
 }