@sentry/types 8.31.0 → 8.33.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 (6) hide show
  1. package/build/types/checkin.d.ts +44 -0
  2. package/build/types/checkin.d.ts.map +1 -1
  3. package/build/types/scope.d.ts +3 -3
  4. package/build/types-ts3.8/checkin.d.ts +44 -0
  5. package/build/types-ts3.8/scope.d.ts +3 -3
  6. package/package.json +1 -1
package/build/types/checkin.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { TraceContext } from './context';
2
2
  interface CrontabSchedule {
3
3
  type: 'crontab';
4
+ /** The crontab schedule string, e.g. 0 * * * *. */
4
5
  value: string;
5
6
  }
6
7
  interface IntervalSchedule {
@@ -10,18 +11,36 @@ interface IntervalSchedule {
10
11
  }
11
12
  type MonitorSchedule = CrontabSchedule | IntervalSchedule;
12
13
  export interface SerializedCheckIn {
14
+ /** Check-In ID (unique and client generated). */
13
15
  check_in_id: string;
16
+ /** The distinct slug of the monitor. */
14
17
  monitor_slug: string;
18
+ /** The status of the check-in. */
15
19
  status: 'in_progress' | 'ok' | 'error';
20
+ /** The duration of the check-in in seconds. Will only take effect if the status is ok or error. */
16
21
  duration?: number;
17
22
  release?: string;
18
23
  environment?: string;
19
24
  monitor_config?: {
20
25
  schedule: MonitorSchedule;
26
+ /**
27
+ * The allowed allowed margin of minutes after the expected check-in time that
28
+ * the monitor will not be considered missed for.
29
+ */
21
30
  checkin_margin?: number;
31
+ /**
32
+ * The allowed allowed duration in minutes that the monitor may be `in_progress`
33
+ * for before being considered failed due to timeout.
34
+ */
22
35
  max_runtime?: number;
36
+ /**
37
+ * A tz database string representing the timezone which the monitor's execution schedule is in.
38
+ * See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
39
+ */
23
40
  timezone?: string;
41
+ /** How many consecutive failed check-ins it takes to create an issue. */
24
42
  failure_issue_threshold?: number;
43
+ /** How many consecutive OK check-ins it takes to resolve an issue. */
25
44
  recovery_threshold?: number;
26
45
  };
27
46
  contexts?: {
@@ -29,27 +48,52 @@ export interface SerializedCheckIn {
29
48
  };
30
49
  }
31
50
  export interface HeartbeatCheckIn {
51
+ /** The distinct slug of the monitor. */
32
52
  monitorSlug: SerializedCheckIn['monitor_slug'];
53
+ /** The status of the check-in. */
33
54
  status: 'ok' | 'error';
34
55
  }
35
56
  export interface InProgressCheckIn {
57
+ /** The distinct slug of the monitor. */
36
58
  monitorSlug: SerializedCheckIn['monitor_slug'];
59
+ /** The status of the check-in. */
37
60
  status: 'in_progress';
38
61
  }
39
62
  export interface FinishedCheckIn {
63
+ /** The distinct slug of the monitor. */
40
64
  monitorSlug: SerializedCheckIn['monitor_slug'];
65
+ /** The status of the check-in. */
41
66
  status: 'ok' | 'error';
67
+ /** Check-In ID (unique and client generated). */
42
68
  checkInId: SerializedCheckIn['check_in_id'];
69
+ /** The duration of the check-in in seconds. Will only take effect if the status is ok or error. */
43
70
  duration?: SerializedCheckIn['duration'];
44
71
  }
45
72
  export type CheckIn = HeartbeatCheckIn | InProgressCheckIn | FinishedCheckIn;
46
73
  type SerializedMonitorConfig = NonNullable<SerializedCheckIn['monitor_config']>;
47
74
  export interface MonitorConfig {
75
+ /**
76
+ * The schedule on which the monitor should run. Either a crontab schedule string or an interval.
77
+ */
48
78
  schedule: MonitorSchedule;
79
+ /**
80
+ * The allowed allowed margin of minutes after the expected check-in time that
81
+ * the monitor will not be considered missed for.
82
+ */
49
83
  checkinMargin?: SerializedMonitorConfig['checkin_margin'];
84
+ /**
85
+ * The allowed allowed duration in minutes that the monitor may be `in_progress`
86
+ * for before being considered failed due to timeout.
87
+ */
50
88
  maxRuntime?: SerializedMonitorConfig['max_runtime'];
89
+ /**
90
+ * A tz database string representing the timezone which the monitor's execution schedule is in.
91
+ * See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
92
+ */
51
93
  timezone?: SerializedMonitorConfig['timezone'];
94
+ /** How many consecutive failed check-ins it takes to create an issue. */
52
95
  failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
96
+ /** How many consecutive OK check-ins it takes to resolve an issue. */
53
97
  recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
54
98
  }
55
99
  export {};
package/build/types/checkin.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"checkin.d.ts","sourceRoot":"","sources":["../../src/checkin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,UAAU,eAAe;IACvB,IAAI,EAAE,SAAS,CAAC;IAEhB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;CAC7D;AAED,KAAK,eAAe,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAG1D,MAAM,WAAW,iBAAiB;IAEhC,WAAW,EAAE,MAAM,CAAC;IAEpB,YAAY,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC;IAEvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE;QACf,QAAQ,EAAE,eAAe,CAAC;QAG1B,cAAc,CAAC,EAAE,MAAM,CAAC;QAGxB,WAAW,CAAC,EAAE,MAAM,CAAC;QAGrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,YAAY,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAE/B,WAAW,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAE/C,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAEhC,WAAW,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAE/C,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAE9B,WAAW,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAE/C,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IAEvB,SAAS,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAE5C,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;CAC1C;AAED,MAAM,MAAM,OAAO,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,eAAe,CAAC;AAE7E,KAAK,uBAAuB,GAAG,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAEhF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,eAAe,CAAC;IAG1B,aAAa,CAAC,EAAE,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;IAG1D,UAAU,CAAC,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;IAGpD,QAAQ,CAAC,EAAE,uBAAuB,CAAC,UAAU,CAAC,CAAC;IAE/C,qBAAqB,CAAC,EAAE,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;IAE3E,iBAAiB,CAAC,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;CACnE"}
1
+ {"version":3,"file":"checkin.d.ts","sourceRoot":"","sources":["../../src/checkin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,UAAU,eAAe;IACvB,IAAI,EAAE,SAAS,CAAC;IAChB,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;CAC7D;AAED,KAAK,eAAe,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAE1D,MAAM,WAAW,iBAAiB;IAChC,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,MAAM,EAAE,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC;IACvC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE;QACf,QAAQ,EAAE,eAAe,CAAC;QAC1B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,yEAAyE;QACzE,uBAAuB,CAAC,EAAE,MAAM,CAAC;QACjC,sEAAsE;QACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,YAAY,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,WAAW,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAC/C,kCAAkC;IAClC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,WAAW,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAC/C,kCAAkC;IAClC,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,wCAAwC;IACxC,WAAW,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAC/C,kCAAkC;IAClC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IACvB,iDAAiD;IACjD,SAAS,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC5C,mGAAmG;IACnG,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;CAC1C;AAED,MAAM,MAAM,OAAO,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,eAAe,CAAC;AAE7E,KAAK,uBAAuB,GAAG,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAEhF,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;IAC1D;;;OAGG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;IACpD;;;OAGG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAC,UAAU,CAAC,CAAC;IAC/C,yEAAyE;IACzE,qBAAqB,CAAC,EAAE,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;IAC3E,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;CACnE"}
package/build/types/scope.d.ts CHANGED
@@ -170,8 +170,8 @@ export interface Scope {
170
170
  /** Clears the current scope and resets its properties. */
171
171
  clear(): this;
172
172
  /**
173
- * Sets the breadcrumbs in the scope
174
- * @param breadcrumbs Breadcrumb
173
+ * Adds a breadcrumb to the scope
174
+ * @param breadcrumb Breadcrumb
175
175
  * @param maxBreadcrumbs number of max breadcrumbs to merged into event.
176
176
  */
177
177
  addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this;
@@ -180,7 +180,7 @@ export interface Scope {
180
180
  */
181
181
  getLastBreadcrumb(): Breadcrumb | undefined;
182
182
  /**
183
- * Clears all currently set Breadcrumbs.
183
+ * Clears all breadcrumbs from the scope.
184
184
  */
185
185
  clearBreadcrumbs(): this;
186
186
  /**
package/build/types-ts3.8/checkin.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { TraceContext } from './context';
2
2
  interface CrontabSchedule {
3
3
  type: 'crontab';
4
+ /** The crontab schedule string, e.g. 0 * * * *. */
4
5
  value: string;
5
6
  }
6
7
  interface IntervalSchedule {
@@ -10,18 +11,36 @@ interface IntervalSchedule {
10
11
  }
11
12
  type MonitorSchedule = CrontabSchedule | IntervalSchedule;
12
13
  export interface SerializedCheckIn {
14
+ /** Check-In ID (unique and client generated). */
13
15
  check_in_id: string;
16
+ /** The distinct slug of the monitor. */
14
17
  monitor_slug: string;
18
+ /** The status of the check-in. */
15
19
  status: 'in_progress' | 'ok' | 'error';
20
+ /** The duration of the check-in in seconds. Will only take effect if the status is ok or error. */
16
21
  duration?: number;
17
22
  release?: string;
18
23
  environment?: string;
19
24
  monitor_config?: {
20
25
  schedule: MonitorSchedule;
26
+ /**
27
+ * The allowed allowed margin of minutes after the expected check-in time that
28
+ * the monitor will not be considered missed for.
29
+ */
21
30
  checkin_margin?: number;
31
+ /**
32
+ * The allowed allowed duration in minutes that the monitor may be `in_progress`
33
+ * for before being considered failed due to timeout.
34
+ */
22
35
  max_runtime?: number;
36
+ /**
37
+ * A tz database string representing the timezone which the monitor's execution schedule is in.
38
+ * See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
39
+ */
23
40
  timezone?: string;
41
+ /** How many consecutive failed check-ins it takes to create an issue. */
24
42
  failure_issue_threshold?: number;
43
+ /** How many consecutive OK check-ins it takes to resolve an issue. */
25
44
  recovery_threshold?: number;
26
45
  };
27
46
  contexts?: {
@@ -29,27 +48,52 @@ export interface SerializedCheckIn {
29
48
  };
30
49
  }
31
50
  export interface HeartbeatCheckIn {
51
+ /** The distinct slug of the monitor. */
32
52
  monitorSlug: SerializedCheckIn['monitor_slug'];
53
+ /** The status of the check-in. */
33
54
  status: 'ok' | 'error';
34
55
  }
35
56
  export interface InProgressCheckIn {
57
+ /** The distinct slug of the monitor. */
36
58
  monitorSlug: SerializedCheckIn['monitor_slug'];
59
+ /** The status of the check-in. */
37
60
  status: 'in_progress';
38
61
  }
39
62
  export interface FinishedCheckIn {
63
+ /** The distinct slug of the monitor. */
40
64
  monitorSlug: SerializedCheckIn['monitor_slug'];
65
+ /** The status of the check-in. */
41
66
  status: 'ok' | 'error';
67
+ /** Check-In ID (unique and client generated). */
42
68
  checkInId: SerializedCheckIn['check_in_id'];
69
+ /** The duration of the check-in in seconds. Will only take effect if the status is ok or error. */
43
70
  duration?: SerializedCheckIn['duration'];
44
71
  }
45
72
  export type CheckIn = HeartbeatCheckIn | InProgressCheckIn | FinishedCheckIn;
46
73
  type SerializedMonitorConfig = NonNullable<SerializedCheckIn['monitor_config']>;
47
74
  export interface MonitorConfig {
75
+ /**
76
+ * The schedule on which the monitor should run. Either a crontab schedule string or an interval.
77
+ */
48
78
  schedule: MonitorSchedule;
79
+ /**
80
+ * The allowed allowed margin of minutes after the expected check-in time that
81
+ * the monitor will not be considered missed for.
82
+ */
49
83
  checkinMargin?: SerializedMonitorConfig['checkin_margin'];
84
+ /**
85
+ * The allowed allowed duration in minutes that the monitor may be `in_progress`
86
+ * for before being considered failed due to timeout.
87
+ */
50
88
  maxRuntime?: SerializedMonitorConfig['max_runtime'];
89
+ /**
90
+ * A tz database string representing the timezone which the monitor's execution schedule is in.
91
+ * See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
92
+ */
51
93
  timezone?: SerializedMonitorConfig['timezone'];
94
+ /** How many consecutive failed check-ins it takes to create an issue. */
52
95
  failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
96
+ /** How many consecutive OK check-ins it takes to resolve an issue. */
53
97
  recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
54
98
  }
55
99
  export {};
package/build/types-ts3.8/scope.d.ts CHANGED
@@ -170,8 +170,8 @@ export interface Scope {
170
170
  /** Clears the current scope and resets its properties. */
171
171
  clear(): this;
172
172
  /**
173
- * Sets the breadcrumbs in the scope
174
- * @param breadcrumbs Breadcrumb
173
+ * Adds a breadcrumb to the scope
174
+ * @param breadcrumb Breadcrumb
175
175
  * @param maxBreadcrumbs number of max breadcrumbs to merged into event.
176
176
  */
177
177
  addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this;
@@ -180,7 +180,7 @@ export interface Scope {
180
180
  */
181
181
  getLastBreadcrumb(): Breadcrumb | undefined;
182
182
  /**
183
- * Clears all currently set Breadcrumbs.
183
+ * Clears all breadcrumbs from the scope.
184
184
  */
185
185
  clearBreadcrumbs(): this;
186
186
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sentry/types",
3
- "version": "8.31.0",
3
+ "version": "8.33.0",
4
4
  "description": "Types for all Sentry JavaScript SDKs",
5
5
  "repository": "git://github.com/getsentry/sentry-javascript.git",
6
6
  "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/types",