@minecraft/diagnostics 1.0.0-beta.1.21.94-stable → 1.0.0-beta.1.26.0-preview.24

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/diagnostics`
-
-Contains diagnostics functionality for discovering and diagnosing issues with content.
-
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
-See full documentation for this module here:
-
+# `@minecraft/diagnostics`
+
+Contains diagnostics functionality for discovering and diagnosing issues with content.
+
+## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
+
+See full documentation for this module here:
+
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/diagnostics/minecraft-diagnostics

package/index.d.ts

@@ -24,15 +24,16 @@
 import * as minecraftcommon from '@minecraft/common';
 import * as minecraftserveradmin from '@minecraft/server-admin';
 /**
- * This defines the severity level of the breadcrumb. Levels
- * are used in the UI to emphasize and deemphasize the crumb.
- * The default is info.  See Sentry documentation for more
- * information:
+ * This defines the severity level of an error, event,
+ * exception, or breadcrumb. Levels are used in the UI to
+ * emphasize and deemphasize breadcrumbs. See Sentry
+ * documentation for more information:
  * https://docs.sentry.io/product/issues/issue-details/breadcrumbs/
  */
-export enum SentryBreadcrumbLevel {
+export enum SentryEventLevel {
     debug = 'debug',
     error = 'error',
+    fatal = 'fatal',
     info = 'info',
     warning = 'warning',
 }
@@ -50,8 +51,6 @@ export class Sentry {
      * up to an error.  See Sentry documentation for more details:
      * https://docs.sentry.io/product/issues/issue-details/breadcrumbs/
      *
-     * This function can't be called in read-only mode.
-     *
      * This function can be called in early-execution mode.
      *
      * @param message
@@ -62,15 +61,13 @@ export class Sentry {
      *
      * {@link SentryUninitializedError}
      */
-    addBreadcrumb(level: SentryBreadcrumbLevel, message: string, category?: string): void;
+    addBreadcrumb(level: SentryEventLevel, message: string, category?: string): void;
     /**
      * @remarks
      * Adds a tag to the Sentry session.  See Sentry documentation
      * for more details:
      * https://docs.sentry.io/platforms/javascript/enriching-events/tags/
      *
-     * This function can't be called in read-only mode.
-     *
      * This function can be called in early-execution mode.
      *
      * @throws This function can throw errors.
@@ -78,14 +75,28 @@ export class Sentry {
      * {@link SentryUninitializedError}
      */
     addTag(name: string, value: string): void;
+    /**
+     * @remarks
+     * Captures an exception event and send it to Sentry. Note that
+     * you can pass not only `Error` objects, but also other types
+     * of thrown objects - in that case, an attempt will be made to
+     * serialize the object for you, and stack traces are likely to
+     * be missing.  See Sentry documentation for more details:
+     * https://docs.sentry.io/platforms/javascript/apis/#capturing-events
+     *
+     * This function can be called in early-execution mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link SentryUninitializedError}
+     */
+    captureException(exception: unknown, captureContext?: SentryCaptureContext): void;
     /**
      * @remarks
      * Gets the list of all session tags.  See Sentry documentation
      * for more details:
      * https://docs.sentry.io/platforms/javascript/enriching-events/tags/
      *
-     * This function can't be called in read-only mode.
-     *
      * This function can be called in early-execution mode.
      *
      * @throws This function can throw errors.
@@ -98,8 +109,6 @@ export class Sentry {
      * Initializes Sentry for use.  This must be successfully
      * called before any other Sentry functions are called.
      *
-     * This function can't be called in read-only mode.
-     *
      * This function can be called in early-execution mode.
      *
      * @throws This function can throw errors.
@@ -115,8 +124,6 @@ export class Sentry {
      * documentation for more details:
      * https://docs.sentry.io/platforms/javascript/enriching-events/tags/
      *
-     * This function can't be called in read-only mode.
-     *
      * This function can be called in early-execution mode.
      *
      * @throws This function can throw errors.
@@ -126,6 +133,31 @@ export class Sentry {
     removeTag(name: string): void;
 }
 
+/**
+ * Context relating to a captured exception that should be sent
+ * to Sentry.
+ */
+export interface SentryCaptureContext {
+    /**
+     * @remarks
+     * Additional data that should be sent with the exception.
+     *
+     */
+    extraData?: Record<string, boolean | number | string>;
+    /**
+     * @remarks
+     * The indicated level of severity of the captured exception.
+     *
+     */
+    level?: SentryEventLevel;
+    /**
+     * @remarks
+     * Additional tags that should be sent with the exception.
+     *
+     */
+    tags?: Record<string, string>;
+}
+
 /**
  * Describes options for configuring Sentry for this scripting
  * module.

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/diagnostics",
-  "version": "1.0.0-beta.1.21.94-stable",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "dependencies": {
-    "@minecraft/common": "^1.0.0",
-    "@minecraft/server-admin": "^1.0.0-beta.1.21.94-stable"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/diagnostics",
+  "version": "1.0.0-beta.1.26.0-preview.24",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.0.0",
+    "@minecraft/server-admin": "^1.0.0-beta.1.26.0-preview.24"
+  },
+  "license": "MIT"
 }