move report dialog options type to core & add to changelog

Author: mydea

docs/migration/v8-to-v9.md

@@ -226,6 +226,7 @@ Since v9, the types have been merged into `@sentry/core`, which removed some of
 - The `IntegrationClass` type is no longer exported - it was not used anymore. Instead, use `Integration` or `IntegrationFn`.
 - The `samplingContext.request` attribute in the `tracesSampler` has been removed. Use `samplingContext.normalizedRequest` instead. Note that the type of `normalizedRequest` differs from `request`.
 - `Client` now always expects the `BaseClient` class - there is no more abstract `Client` that can be implemented! Any `Client` class has to extend from `BaseClient`.
+- `ReportDialogOptions` now extends `Record<string, unknown>` instead of `Record<string, any>` - this should not affect most users.
 
 # No Version Support Timeline
 

packages/browser/src/exports.ts

@@ -13,12 +13,11 @@ export type {
   Thread,
   User,
   Session,
+  ReportDialogOptions,
 } from '@sentry/core';
 
 export type { BrowserOptions } from './client';
 
-export type { ReportDialogOptions } from './sdk';
-
 export {
   addEventProcessor,
   addBreadcrumb,

packages/browser/src/sdk.ts

@@ -1,4 +1,4 @@
-import type { Client, DsnLike, Integration, Options } from '@sentry/core';
+import type { Client, Integration, Options, ReportDialogOptions } from '@sentry/core';
 import {
   consoleSandbox,
   dedupeIntegration,
@@ -200,35 +200,6 @@ export function init(browserOptions: BrowserOptions = {}): Client | undefined {
   return initAndBind(BrowserClient, clientOptions);
 }
 
-/**
- * All properties the report dialog supports
- */
-export interface ReportDialogOptions {
-  [key: string]: unknown;
-  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;
-  /** Callback after reportDialog showed up */
-  onLoad?(this: void): void;
-  /** Callback after reportDialog closed */
-  onClose?(this: void): void;
-}
-
 /**
  * Present the user with a report dialog.
  *

packages/core/src/api.ts

@@ -1,3 +1,4 @@
+import type { ReportDialogOptions } from './report-dialog';
 import type { DsnComponents, DsnLike, SdkInfo } from './types-hoist';
 import { dsnToString, makeDsn } from './utils-hoist/dsn';
 
@@ -44,13 +45,7 @@ export function getEnvelopeEndpointWithUrlEncodedAuth(dsn: DsnComponents, tunnel
 }
 
 /** Returns the url to the report dialog endpoint. */
-export function getReportDialogEndpoint(
-  dsnLike: DsnLike,
-  dialogOptions: {
-    [key: string]: unknown;
-    user?: { name?: string; email?: string };
-  },
-): string {
+export function getReportDialogEndpoint(dsnLike: DsnLike, dialogOptions: ReportDialogOptions): string {
   const dsn = makeDsn(dsnLike);
   if (!dsn) {
     return '';

packages/core/src/index.ts

@@ -111,6 +111,7 @@ export {
 } from './fetch';
 export { trpcMiddleware } from './trpc';
 export { captureFeedback } from './feedback';
+export type { ReportDialogOptions } from './report-dialog';
 
 // eslint-disable-next-line deprecation/deprecation
 export { getCurrentHubShim, getCurrentHub } from './getCurrentHubShim';

packages/core/src/report-dialog.ts

@@ -0,0 +1,29 @@
+import type { DsnLike } from './types-hoist/dsn';
+
+/**
+ * All properties the report dialog supports
+ */
+export interface ReportDialogOptions extends Record<string, unknown> {
+  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;
+  /** Callback after reportDialog showed up */
+  onLoad?(this: void): void;
+  /** Callback after reportDialog closed */
+  onClose?(this: void): void;
+}