@wix/monitoring-types 0.4.0 → 0.6.0

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 (3) hide show
  1. package/build/index.d.mts +16 -14
  2. package/build/index.d.ts +16 -14
  3. package/package.json +4 -4
package/build/index.d.mts CHANGED
@@ -36,14 +36,9 @@ interface HostMonitoringContext {
36
36
  */
37
37
  extensionData?: Record<string, unknown>;
38
38
  /**
39
- * The type of the subject.
40
- * Can be 'USER', 'MEMBER', or 'VISITOR'.
39
+ * The type of the platform the extension is running on.
41
40
  */
42
- subjectType?: 'USER' | 'MEMBER' | 'VISITOR';
43
- /**
44
- * The unique identifier for the subject.
45
- */
46
- subjectId?: string;
41
+ platform?: 'BACKEND' | 'DASHBOARD' | 'SITE_VIEWER' | 'SITE_EDITOR';
47
42
  /**
48
43
  * The type of the tenant.
49
44
  * Can be 'ACCOUNT' or 'SITE'.
@@ -144,24 +139,31 @@ interface EventData {
144
139
  }
145
140
 
146
141
  /**
147
- * Represents the configuration for app's monitoring.
148
- * The configuration includes the type of monitoring provider and its options.
149
- * Currently, only Sentry is supported as a monitoring provider.
142
+ * Represents the Sentry configuration for app's monitoring.
150
143
  */
151
- interface AppMonitoringConfig {
144
+ interface AppMonitoringSentryConfig {
152
145
  /**
153
146
  * The type of monitoring provider.
154
147
  */
155
- type: 'SENTRY' | 'UNKNOWN_PROVIDER';
148
+ type: 'SENTRY';
156
149
  /**
157
150
  * The options for the Sentry monitoring provider.
158
151
  */
159
- sentryOptions?: {
152
+ sentryOptions: {
160
153
  /**
161
154
  * The Data Source Name (DSN) for the Sentry monitoring provider.
162
155
  */
163
156
  dsn: string;
164
157
  };
165
158
  }
159
+ interface AppMonitoringUnknownConfig {
160
+ type: 'UNKNOWN_PROVIDER';
161
+ }
162
+ /**
163
+ * Represents the configuration for app's monitoring.
164
+ * The configuration includes the type of monitoring provider and its options.
165
+ * Currently, only Sentry is supported as a monitoring provider.
166
+ */
167
+ type AppMonitoringConfig = AppMonitoringSentryConfig | AppMonitoringUnknownConfig;
166
168
 
167
- export type { AppMonitoringConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
169
+ export type { AppMonitoringConfig, AppMonitoringSentryConfig, AppMonitoringUnknownConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
package/build/index.d.ts CHANGED
@@ -36,14 +36,9 @@ interface HostMonitoringContext {
36
36
  */
37
37
  extensionData?: Record<string, unknown>;
38
38
  /**
39
- * The type of the subject.
40
- * Can be 'USER', 'MEMBER', or 'VISITOR'.
39
+ * The type of the platform the extension is running on.
41
40
  */
42
- subjectType?: 'USER' | 'MEMBER' | 'VISITOR';
43
- /**
44
- * The unique identifier for the subject.
45
- */
46
- subjectId?: string;
41
+ platform?: 'BACKEND' | 'DASHBOARD' | 'SITE_VIEWER' | 'SITE_EDITOR';
47
42
  /**
48
43
  * The type of the tenant.
49
44
  * Can be 'ACCOUNT' or 'SITE'.
@@ -144,24 +139,31 @@ interface EventData {
144
139
  }
145
140
 
146
141
  /**
147
- * Represents the configuration for app's monitoring.
148
- * The configuration includes the type of monitoring provider and its options.
149
- * Currently, only Sentry is supported as a monitoring provider.
142
+ * Represents the Sentry configuration for app's monitoring.
150
143
  */
151
- interface AppMonitoringConfig {
144
+ interface AppMonitoringSentryConfig {
152
145
  /**
153
146
  * The type of monitoring provider.
154
147
  */
155
- type: 'SENTRY' | 'UNKNOWN_PROVIDER';
148
+ type: 'SENTRY';
156
149
  /**
157
150
  * The options for the Sentry monitoring provider.
158
151
  */
159
- sentryOptions?: {
152
+ sentryOptions: {
160
153
  /**
161
154
  * The Data Source Name (DSN) for the Sentry monitoring provider.
162
155
  */
163
156
  dsn: string;
164
157
  };
165
158
  }
159
+ interface AppMonitoringUnknownConfig {
160
+ type: 'UNKNOWN_PROVIDER';
161
+ }
162
+ /**
163
+ * Represents the configuration for app's monitoring.
164
+ * The configuration includes the type of monitoring provider and its options.
165
+ * Currently, only Sentry is supported as a monitoring provider.
166
+ */
167
+ type AppMonitoringConfig = AppMonitoringSentryConfig | AppMonitoringUnknownConfig;
166
168
 
167
- export type { AppMonitoringConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
169
+ export type { AppMonitoringConfig, AppMonitoringSentryConfig, AppMonitoringUnknownConfig, Breadcrumb, CaptureContext, Context, Contexts, EventContexts, EventData, EventTags, HostMonitoringContext, MonitoringClient, Primitive, Span, SpanContextData, SpanOptions, Tags };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/monitoring-types",
3
- "version": "0.4.0",
3
+ "version": "0.6.0",
4
4
  "license": "UNLICENSED",
5
5
  "author": {
6
6
  "name": "Gili Shohat",
@@ -29,11 +29,11 @@
29
29
  "*.{js,ts}": "yarn lint"
30
30
  },
31
31
  "devDependencies": {
32
- "@types/node": "^20.17.12",
32
+ "@types/node": "^20.17.16",
33
33
  "eslint": "^8.57.1",
34
34
  "eslint-config-sdk": "0.0.0",
35
35
  "tsup": "^7.3.0",
36
- "type-fest": "^4.32.0",
36
+ "type-fest": "^4.33.0",
37
37
  "typescript": "^5.7.3"
38
38
  },
39
39
  "eslintConfig": {
@@ -53,5 +53,5 @@
53
53
  ]
54
54
  }
55
55
  },
56
- "falconPackageHash": "f5b6aae3eca514279438277851c0c6ab98b89f570229a737e9274223"
56
+ "falconPackageHash": "a193a0f622373d57ad99339b9839a9daa0cdbced448852aec9c425d2"
57
57
  }