feat(core)!: Remove standalone Client interface & deprecate BaseClient

Author: mydea

packages/browser-utils/test/utils/TestClient.ts

@@ -1,4 +1,4 @@
-import { BaseClient, createTransport, initAndBind } from '@sentry/core';
+import { Client, createTransport, initAndBind } from '@sentry/core';
 import { resolvedSyncPromise } from '@sentry/core';
 import type {
   BrowserClientReplayOptions,
@@ -10,7 +10,7 @@ import type {
 
 export interface TestClientOptions extends ClientOptions, BrowserClientReplayOptions {}
 
-export class TestClient extends BaseClient<TestClientOptions> {
+export class TestClient extends Client<TestClientOptions> {
   public constructor(options: TestClientOptions) {
     super(options);
   }

packages/browser/src/client.ts

@@ -10,7 +10,7 @@ import type {
   SeverityLevel,
   UserFeedback,
 } from '@sentry/core';
-import { BaseClient, applySdkMetadata, getSDKSource, logger } from '@sentry/core';
+import { Client, applySdkMetadata, getSDKSource, logger } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
 import { eventFromException, eventFromMessage } from './eventbuilder';
 import { WINDOW } from './helpers';
@@ -61,7 +61,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
  * @see BrowserOptions for documentation on configuration options.
  * @see SentryClient for usage documentation.
  */
-export class BrowserClient extends BaseClient<BrowserClientOptions> {
+export class BrowserClient extends Client<BrowserClientOptions> {
   /**
    * Creates a new Browser SDK instance.
    *

packages/core/src/asyncContext/stackStrategy.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import { getDefaultCurrentScope, getDefaultIsolationScope } from '../defaultScopes';
 import { Scope } from '../scope';
 import { isThenable } from '../utils-hoist/is';

packages/core/src/baseclient.ts renamed to packages/core/src/client.ts

@@ -64,33 +64,33 @@ const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing
  *
  * Call the constructor with the corresponding options
  * specific to the client subclass. To access these options later, use
- * {@link BaseClient.getOptions}.
+ * {@link Client.getOptions}.
  *
  * If a Dsn is specified in the options, it will be parsed and stored. Use
- * {@link BaseClient.getDsn} to retrieve the Dsn at any moment. In case the Dsn is
+ * {@link Client.getDsn} to retrieve the Dsn at any moment. In case the Dsn is
  * invalid, the constructor will throw a {@link SentryException}. Note that
  * without a valid Dsn, the SDK will not send any events to Sentry.
  *
  * Before sending an event, it is passed through
- * {@link BaseClient._prepareEvent} to add SDK information and scope data
+ * {@link Client._prepareEvent} to add SDK information and scope data
  * (breadcrumbs and context). To add more custom information, override this
  * method and extend the resulting prepared event.
  *
  * To issue automatically created events (e.g. via instrumentation), use
- * {@link BaseClient.captureEvent}. It will prepare the event and pass it through
+ * {@link Client.captureEvent}. It will prepare the event and pass it through
  * the callback lifecycle. To issue auto-breadcrumbs, use
- * {@link BaseClient.addBreadcrumb}.
+ * {@link Client.addBreadcrumb}.
  *
  * @example
- * class NodeClient extends BaseClient<NodeOptions> {
+ * class NodeClient extends Client<NodeOptions> {
  *   public constructor(options: NodeOptions) {
  *     super(options);
  *   }
  *
  *   // ...
  * }
  */
-export abstract class BaseClient<O extends ClientOptions> {
+export abstract class Client<O extends ClientOptions = ClientOptions> {
   /** Options passed to the SDK. */
   protected readonly _options: O;
 
@@ -960,7 +960,15 @@ export abstract class BaseClient<O extends ClientOptions> {
   ): PromiseLike<Event>;
 }
 
-export type Client<O extends ClientOptions = ClientOptions> = BaseClient<O>;
+/**
+ * @deprecated Use `Client` instead. This alias may be removed in a future major version.
+ */
+export type BaseClient = Client;
+
+/**
+ * @deprecated Use `Client` instead. This alias may be removed in a future major version.
+ */
+export const BaseClient = Client;
 
 /**
  * Verifies that return value of configured `beforeSend` or `beforeSendTransaction` is of expected type, and returns the value if so.

packages/core/src/currentScopes.ts

@@ -1,6 +1,6 @@
 import { getAsyncContextStrategy } from './asyncContext';
-import type { Client } from './baseclient';
 import { getGlobalSingleton, getMainCarrier } from './carrier';
+import type { Client } from './client';
 import { Scope } from './scope';
 import type { TraceContext } from './types-hoist';
 import { dropUndefinedKeys } from './utils-hoist/object';

packages/core/src/envelope.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import { getDynamicSamplingContextFromSpan } from './tracing/dynamicSamplingContext';
 import type { SentrySpan } from './tracing/sentrySpan';
 import type {

packages/core/src/fetch.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import type { Scope } from './scope';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
 import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';

packages/core/src/getCurrentHubShim.ts

@@ -1,5 +1,5 @@
-import type { Client } from './baseclient';
 import { addBreadcrumb } from './breadcrumbs';
+import type { Client } from './client';
 import { getClient, getCurrentScope, getIsolationScope, withScope } from './currentScopes';
 import {
   captureEvent,

packages/core/src/index.ts

@@ -51,8 +51,11 @@ export { Scope } from './scope';
 export type { CaptureContext, ScopeContext, ScopeData } from './scope';
 export { notifyEventProcessors } from './eventProcessors';
 export { getEnvelopeEndpointWithUrlEncodedAuth, getReportDialogEndpoint } from './api';
-export { BaseClient } from './baseclient';
-export type { Client } from './baseclient';
+export {
+  Client,
+  // eslint-disable-next-line deprecation/deprecation
+  BaseClient,
+} from './client';
 export { ServerRuntimeClient } from './server-runtime-client';
 export { initAndBind, setCurrentClient } from './sdk';
 export { createTransport } from './transports/base';

packages/core/src/integration.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import { getClient } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
 import type { Event, EventHint, Integration, IntegrationFn, Options } from './types-hoist';