ref(utils): drop export

Author: JonasBa

packages/core/src/api.ts

@@ -1,5 +1,5 @@
-import { Dsn, DsnLike, SdkMetadata } from '@sentry/types';
-import { makeDsn, urlEncode } from '@sentry/utils';
+import { DsnComponents, DsnLike, SdkMetadata } from '@sentry/types';
+import { dsnToString, makeDsn, urlEncode } from '@sentry/utils';
 
 const SENTRY_API_VERSION = '7';
 
@@ -12,7 +12,7 @@ export interface APIDetails {
   /** Metadata about the SDK (name, version, etc) for inclusion in envelope headers */
   metadata: SdkMetadata;
   /** The internally used Dsn object. */
-  readonly dsn: Dsn;
+  readonly dsn: DsnComponents;
   /** The envelope tunnel to use. */
   readonly tunnel?: string;
 }
@@ -32,7 +32,7 @@ export class API {
   public metadata: SdkMetadata;
 
   /** The internally used Dsn object. */
-  private readonly _dsnObject: Dsn;
+  private readonly _dsnObject: DsnComponents;
 
   /** The envelope tunnel to use. */
   private readonly _tunnel?: string;
@@ -46,7 +46,7 @@ export class API {
   }
 
   /** Returns the Dsn object. */
-  public getDsn(): Dsn {
+  public getDsn(): DsnComponents {
     return this._dsnObject;
   }
 
@@ -95,19 +95,19 @@ export function initAPIDetails(dsn: DsnLike, metadata?: SdkMetadata, tunnel?: st
 }
 
 /** Returns the prefix to construct Sentry ingestion API endpoints. */
-function getBaseApiEndpoint(dsn: Dsn): string {
+function getBaseApiEndpoint(dsn: DsnComponents): string {
   const protocol = dsn.protocol ? `${dsn.protocol}:` : '';
   const port = dsn.port ? `:${dsn.port}` : '';
   return `${protocol}//${dsn.host}${port}${dsn.path ? `/${dsn.path}` : ''}/api/`;
 }
 
 /** Returns the ingest API endpoint for target. */
-function _getIngestEndpoint(dsn: Dsn, target: 'store' | 'envelope'): string {
+function _getIngestEndpoint(dsn: DsnComponents, target: 'store' | 'envelope'): string {
   return `${getBaseApiEndpoint(dsn)}${dsn.projectId}/${target}/`;
 }
 
 /** Returns a URL-encoded string with auth config suitable for a query string. */
-function _encodedAuth(dsn: Dsn): string {
+function _encodedAuth(dsn: DsnComponents): string {
   return urlEncode({
     // We send only the minimum set of required information. See
     // https://github.com/getsentry/sentry-javascript/issues/2572.
@@ -117,7 +117,7 @@ function _encodedAuth(dsn: Dsn): string {
 }
 
 /** Returns the store endpoint URL. */
-function getStoreEndpoint(dsn: Dsn): string {
+function getStoreEndpoint(dsn: DsnComponents): string {
   return _getIngestEndpoint(dsn, 'store');
 }
 
@@ -126,12 +126,12 @@ function getStoreEndpoint(dsn: Dsn): string {
  *
  * Sending auth as part of the query string and not as custom HTTP headers avoids CORS preflight requests.
  */
-export function getStoreEndpointWithUrlEncodedAuth(dsn: Dsn): string {
+export function getStoreEndpointWithUrlEncodedAuth(dsn: DsnComponents): string {
   return `${getStoreEndpoint(dsn)}?${_encodedAuth(dsn)}`;
 }
 
 /** Returns the envelope endpoint URL. */
-function _getEnvelopeEndpoint(dsn: Dsn): string {
+function _getEnvelopeEndpoint(dsn: DsnComponents): string {
   return _getIngestEndpoint(dsn, 'envelope');
 }
 
@@ -140,15 +140,19 @@ function _getEnvelopeEndpoint(dsn: Dsn): string {
  *
  * Sending auth as part of the query string and not as custom HTTP headers avoids CORS preflight requests.
  */
-export function getEnvelopeEndpointWithUrlEncodedAuth(dsn: Dsn, tunnel?: string): string {
+export function getEnvelopeEndpointWithUrlEncodedAuth(dsn: DsnComponents, tunnel?: string): string {
   return tunnel ? tunnel : `${_getEnvelopeEndpoint(dsn)}?${_encodedAuth(dsn)}`;
 }
 
 /**
  * Returns an object that can be used in request headers.
  * This is needed for node and the old /store endpoint in sentry
  */
-export function getRequestHeaders(dsn: Dsn, clientName: string, clientVersion: string): { [key: string]: string } {
+export function getRequestHeaders(
+  dsn: DsnComponents,
+  clientName: string,
+  clientVersion: string,
+): { [key: string]: string } {
   // CHANGE THIS to use metadata but keep clientName and clientVersion compatible
   const header = [`Sentry sentry_version=${SENTRY_API_VERSION}`];
   header.push(`sentry_client=${clientName}/${clientVersion}`);

packages/core/src/request.ts

@@ -1,4 +1,5 @@
 import { Event, SdkInfo, SentryRequest, SentryRequestType, Session, SessionAggregates } from '@sentry/types';
+import { dsnToString } from '@sentry/utils';
 
 import { APIDetails, getEnvelopeEndpointWithUrlEncodedAuth, getStoreEndpointWithUrlEncodedAuth } from './api';
 

packages/types/src/client.ts

@@ -1,4 +1,4 @@
-import { Dsn } from './dsn';
+import { DsnLike } from './dsn';
 import { Event, EventHint } from './event';
 import { Integration, IntegrationClass } from './integration';
 import { Options } from './options';
@@ -55,7 +55,7 @@ export interface Client<O extends Options = Options> {
   captureSession?(session: Session): void;
 
   /** Returns the current Dsn. */
-  getDsn(): Dsn | undefined;
+  getDsn(): DsnLike | undefined;
 
   /** Returns the current options. */
   getOptions(): O;

packages/utils/src/dsn.ts

@@ -1,4 +1,4 @@
-import { Dsn, DsnComponents, DsnLike, DsnProtocol } from '@sentry/types';
+import { DsnComponents, DsnLike, DsnProtocol } from '@sentry/types';
 
 import { isDebugBuild } from './env';
 import { SentryError } from './error';
@@ -19,15 +19,15 @@ function isValidProtocol(protocol?: string): protocol is DsnProtocol {
  *
  * @param withPassword When set to true, the password will be included.
  */
-export function dsnToString(dsn: Dsn, withPassword: boolean = false): string {
+export function dsnToString(dsn: DsnComponents, withPassword: boolean = false): string {
   const { host, path, pass, port, projectId, protocol, publicKey } = dsn;
   return (
     `${protocol}://${publicKey}${withPassword && pass ? `:${pass}` : ''}` +
     `@${host}${port ? `:${port}` : ''}/${path ? `${path}/` : path}${projectId}`
   );
 }
 
-function dsnFromString(str: string): Dsn {
+function dsnFromString(str: string): DsnComponents {
   const match = DSN_REGEX.exec(str);
 
   if (!match) {
@@ -54,7 +54,7 @@ function dsnFromString(str: string): Dsn {
   return dsnFromComponents({ host, pass, path, projectId, port, protocol: protocol as DsnProtocol, publicKey });
 }
 
-function dsnFromComponents(components: DsnComponents): Dsn {
+function dsnFromComponents(components: DsnComponents): DsnComponents {
   // TODO this is for backwards compatibility, and can be removed in a future version
   if ('user' in components && !('publicKey' in components)) {
     components.publicKey = components.user;
@@ -72,7 +72,7 @@ function dsnFromComponents(components: DsnComponents): Dsn {
   };
 }
 
-function validateDsn(dsn: Dsn): boolean | void {
+function validateDsn(dsn: DsnComponents): boolean | void {
   if (!isDebugBuild()) {
     return;
   }
@@ -102,7 +102,7 @@ function validateDsn(dsn: Dsn): boolean | void {
 }
 
 /** The Sentry Dsn, identifying a Sentry instance and project. */
-export function makeDsn(from: DsnLike): Dsn {
+export function makeDsn(from: DsnLike): DsnComponents {
   const components = typeof from === 'string' ? dsnFromString(from) : dsnFromComponents(from);
 
   validateDsn(components);