@sentry/browser 9.39.0 → 9.41.0

package/build/npm/types-ts3.8/integrations/webWorker.d.ts

@@ -0,0 +1,103 @@
+import { Integration, IntegrationFn } from '@sentry/core';
+export declare const INTEGRATION_NAME = "WebWorker";
+interface WebWorkerIntegration extends Integration {
+    addWorker: (worker: Worker) => void;
+}
+/**
+ * Use this integration to set up Sentry with web workers.
+ *
+ * IMPORTANT: This integration must be added **before** you start listening to
+ * any messages from the worker. Otherwise, your message handlers will receive
+ * messages from the Sentry SDK which you need to ignore.
+ *
+ * This integration only has an effect, if you call `Sentry.registerWorker(self)`
+ * from within the worker(s) you're adding to the integration.
+ *
+ * Given that you want to initialize the SDK as early as possible, you most likely
+ * want to add this integration **after** initializing the SDK:
+ *
+ * @example:
+ * ```ts filename={main.js}
+ * import * as Sentry from '@sentry/<your-sdk>';
+ *
+ * // some time earlier:
+ * Sentry.init(...)
+ *
+ * // 1. Initialize the worker
+ * const worker = new Worker(new URL('./worker.ts', import.meta.url));
+ *
+ * // 2. Add the integration
+ * const webWorkerIntegration = Sentry.webWorkerIntegration({ worker });
+ * Sentry.addIntegration(webWorkerIntegration);
+ *
+ * // 3. Register message listeners on the worker
+ * worker.addEventListener('message', event => {
+ *  // ...
+ * });
+ * ```
+ *
+ * If you initialize multiple workers at the same time, you can also pass an array of workers
+ * to the integration:
+ *
+ * ```ts filename={main.js}
+ * const webWorkerIntegration = Sentry.webWorkerIntegration({ worker: [worker1, worker2] });
+ * Sentry.addIntegration(webWorkerIntegration);
+ * ```
+ *
+ * If you have any additional workers that you initialize at a later point,
+ * you can add them to the integration as follows:
+ *
+ * ```ts filename={main.js}
+ * const webWorkerIntegration = Sentry.webWorkerIntegration({ worker: worker1 });
+ * Sentry.addIntegration(webWorkerIntegration);
+ *
+ * // sometime later:
+ * webWorkerIntegration.addWorker(worker2);
+ * ```
+ *
+ * Of course, you can also directly add the integration in Sentry.init:
+ * ```ts filename={main.js}
+ * import * as Sentry from '@sentry/<your-sdk>';
+ *
+ * // 1. Initialize the worker
+ * const worker = new Worker(new URL('./worker.ts', import.meta.url));
+ *
+ * // 2. Initialize the SDK
+ * Sentry.init({
+ *  integrations: [Sentry.webWorkerIntegration({ worker })]
+ * });
+ *
+ * // 3. Register message listeners on the worker
+ * worker.addEventListener('message', event => {
+ *  // ...
+ * });
+ * ```
+ *
+ * @param options {WebWorkerIntegrationOptions} Integration options:
+ *   - `worker`: The worker instance.
+ */
+export declare const webWorkerIntegration: IntegrationFn<WebWorkerIntegration>;
+interface RegisterWebWorkerOptions {
+    self: Worker & {
+        _sentryDebugIds?: Record<string, string>;
+    };
+}
+/**
+ * Use this function to register the worker with the Sentry SDK.
+ *
+ * @example
+ * ```ts filename={worker.js}
+ * import * as Sentry from '@sentry/<your-sdk>';
+ *
+ * // Do this as early as possible in your worker.
+ * Sentry.registerWorker({ self });
+ *
+ * // continue setting up your worker
+ * self.postMessage(...)
+ * ```
+ * @param options {RegisterWebWorkerOptions} Integration options:
+ *   - `self`: The worker instance you're calling this function from (self).
+ */
+export declare function registerWebWorker({ self }: RegisterWebWorkerOptions): void;
+export {};
+//# sourceMappingURL=webWorker.d.ts.map

package/build/npm/types-ts3.8/log.d.ts

@@ -1,6 +1,6 @@
 import { Log, ParameterizedString } from '@sentry/core';
 /**
- * @summary Capture a log with the `trace` level. Requires `_experiments.enableLogs` to be enabled.
+ * @summary Capture a log with the `trace` level. Requires the `enableLogs` option to be enabled.
  *
  * @param message - The message to log.
  * @param attributes - Arbitrary structured data that stores information about the log - e.g., { userId: 100, route: '/dashboard' }.
@@ -26,7 +26,7 @@ import { Log, ParameterizedString } from '@sentry/core';
  */
 export declare function trace(message: ParameterizedString, attributes?: Log['attributes']): void;
 /**
- * @summary Capture a log with the `debug` level. Requires `_experiments.enableLogs` to be enabled.
+ * @summary Capture a log with the `debug` level. Requires the `enableLogs` option to be enabled.
  *
  * @param message - The message to log.
  * @param attributes - Arbitrary structured data that stores information about the log - e.g., { component: 'Header', state: 'loading' }.
@@ -53,7 +53,7 @@ export declare function trace(message: ParameterizedString, attributes?: Log['at
  */
 export declare function debug(message: ParameterizedString, attributes?: Log['attributes']): void;
 /**
- * @summary Capture a log with the `info` level. Requires `_experiments.enableLogs` to be enabled.
+ * @summary Capture a log with the `info` level. Requires the `enableLogs` option to be enabled.
  *
  * @param message - The message to log.
  * @param attributes - Arbitrary structured data that stores information about the log - e.g., { feature: 'checkout', status: 'completed' }.
@@ -80,7 +80,7 @@ export declare function debug(message: ParameterizedString, attributes?: Log['at
  */
 export declare function info(message: ParameterizedString, attributes?: Log['attributes']): void;
 /**
- * @summary Capture a log with the `warn` level. Requires `_experiments.enableLogs` to be enabled.
+ * @summary Capture a log with the `warn` level. Requires the `enableLogs` option to be enabled.
  *
  * @param message - The message to log.
  * @param attributes - Arbitrary structured data that stores information about the log - e.g., { browser: 'Chrome', version: '91.0' }.
@@ -108,7 +108,7 @@ export declare function info(message: ParameterizedString, attributes?: Log['att
  */
 export declare function warn(message: ParameterizedString, attributes?: Log['attributes']): void;
 /**
- * @summary Capture a log with the `error` level. Requires `_experiments.enableLogs` to be enabled.
+ * @summary Capture a log with the `error` level. Requires the `enableLogs` option to be enabled.
  *
  * @param message - The message to log.
  * @param attributes - Arbitrary structured data that stores information about the log - e.g., { error: 'NetworkError', url: '/api/data' }.
@@ -137,7 +137,7 @@ export declare function warn(message: ParameterizedString, attributes?: Log['att
  */
 export declare function error(message: ParameterizedString, attributes?: Log['attributes']): void;
 /**
- * @summary Capture a log with the `fatal` level. Requires `_experiments.enableLogs` to be enabled.
+ * @summary Capture a log with the `fatal` level. Requires the `enableLogs` option to be enabled.
  *
  * @param message - The message to log.
  * @param attributes - Arbitrary structured data that stores information about the log - e.g., { appState: 'corrupted', sessionId: 'abc-123' }.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/browser",
-  "version": "9.39.0",
+  "version": "9.41.0",
   "description": "Official Sentry SDK for browsers",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/browser",
@@ -39,14 +39,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry-internal/browser-utils": "9.39.0",
-    "@sentry-internal/feedback": "9.39.0",
-    "@sentry-internal/replay": "9.39.0",
-    "@sentry-internal/replay-canvas": "9.39.0",
-    "@sentry/core": "9.39.0"
+    "@sentry-internal/browser-utils": "9.41.0",
+    "@sentry-internal/feedback": "9.41.0",
+    "@sentry-internal/replay": "9.41.0",
+    "@sentry-internal/replay-canvas": "9.41.0",
+    "@sentry/core": "9.41.0"
   },
   "devDependencies": {
-    "@sentry-internal/integration-shims": "9.39.0",
+    "@sentry-internal/integration-shims": "9.41.0",
     "fake-indexeddb": "^4.0.1"
   },
   "scripts": {