feat(overlay): Allow to directly add sentry envelopes via trigger

getsentry · Aug 20, 2024 · 87ba9ff · 87ba9ff
1 parent 86055cc
commit 87ba9ff
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 1 deletion.
diff --git a/.changeset/blue-trees-repeat.md b/.changeset/blue-trees-repeat.md
@@ -0,0 +1,5 @@
+---
+'@spotlightjs/overlay': minor
+---
+
+feat: Allow to directly add sentry envelopes via trigger
diff --git a/packages/overlay/src/integrations/sentry/index.ts b/packages/overlay/src/integrations/sentry/index.ts
@@ -49,8 +49,19 @@ export default function sentryIntegration(options: SentryIntegrationOptions = {}
 
  on('sentry:showError', onRenderError as EventListener);
 
+ const onAddEnvelope = (e: CustomEvent) => {
+ if (!e.detail.envelope) return;
+ processEnvelope({
+ contentType: 'application/x-sentry-envelope',
+ data: e.detail.envelope,
+ });
+ };
+
+ on('sentry:addEnvelope', onAddEnvelope as EventListener);
+
  return () => {
  off('sentry:showError', onRenderError as EventListener);
+ off('sentry:addEnvelope', onAddEnvelope as EventListener);
  };
  },
 

diff --git a/packages/website/src/content/docs/reference/sentry.mdx b/packages/website/src/content/docs/reference/sentry.mdx
@@ -16,10 +16,18 @@ init({
 Additionally it includes an event to trigger synchronously rendering an error:
 
 ```js
-import { trigger } as Spotlight from '@spotlightjs/spotlight';
+import { trigger } from '@spotlightjs/spotlight';
 
 trigger("sentry:showError", {
  eventId: string,
  event?: Event,
 });
 ```
+
+You can also directly add envelopes to the Sentry integration:
+
+```js
+import { trigger } from '@spotlightjs/spotlight';
+
+trigger("sentry:addEnvelope", sentryEnvelope);
+```