ref: ReportDialogOptions (#1573)

* ref: Add ReportDialogOptions

* ref: Add doc comment

* feat: Add changelog

Author: HazAT

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- [browser] ref: Expose `ReportDialogOptions`
+
 ## 4.0.4
 
 - [browser] feat: Add `forceLoad` and `onLoad` function to be compatible with loader API

packages/browser/src/client.ts

@@ -3,6 +3,31 @@ import { DsnLike, SentryEvent, SentryEventHint } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils/misc';
 import { BrowserBackend, BrowserOptions } from './backend';
 
+/**
+ * All properties the report dialog supports
+ */
+export interface ReportDialogOptions {
+  [key: string]: any;
+  eventId?: string;
+  dsn?: DsnLike;
+  user?: {
+    email?: string;
+    name?: string;
+  };
+  lang?: string;
+  title?: string;
+  subtitle?: string;
+  subtitle2?: string;
+  labelName?: string;
+  labelEmail?: string;
+  labelComments?: string;
+  labelClose?: string;
+  labelSubmit?: string;
+  errorGeneric?: string;
+  errorFormEntry?: string;
+  successMessage?: string;
+}
+
 /**
  * The Sentry Browser SDK Client.
  *
@@ -27,28 +52,12 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
     return super.prepareEvent(event, scope, hint);
   }
 
-  /** JSDoc */
-  public showReportDialog(options: {
-    [key: string]: any;
-    eventId?: string;
-    dsn?: DsnLike;
-    user?: {
-      email?: string;
-      name?: string;
-    };
-    lang?: string;
-    title?: string;
-    subtitle?: string;
-    subtitle2?: string;
-    labelName?: string;
-    labelEmail?: string;
-    labelComments?: string;
-    labelClose?: string;
-    labelSubmit?: string;
-    errorGeneric?: string;
-    errorFormEntry?: string;
-    successMessage?: string;
-  }): void {
+  /**
+   * Show a report dialog to the user to send feedback to a specific event.
+   *
+   * @param options Set individual options for the dialog
+   */
+  public showReportDialog(options: ReportDialogOptions = {}): void {
     // doesn't work without a document (React Native)
     const document = (getGlobalObject() as Window).document;
     if (!document) {

packages/browser/src/index.ts

@@ -27,7 +27,7 @@ export {
 } from '@sentry/core';
 
 export { BrowserBackend, BrowserOptions } from './backend';
-export { BrowserClient } from './client';
+export { BrowserClient, ReportDialogOptions } from './client';
 export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog } from './sdk';
 export { SDK_NAME, SDK_VERSION } from './version';