move Carrier interface to @sentry/types

Author: lobsterkatie

packages/hub/src/hub.ts

@@ -2,6 +2,7 @@
 import {
   Breadcrumb,
   BreadcrumbHint,
+  Carrier,
   Client,
   CustomSamplingContext,
   Event,
@@ -23,7 +24,7 @@ import {
 } from '@sentry/types';
 import { consoleSandbox, dateTimestampInSeconds, getGlobalObject, isNodeEnv, logger, uuid4 } from '@sentry/utils';
 
-import { Carrier, DomainAsCarrier, Layer } from './interfaces';
+import { DomainAsCarrier, Layer } from './interfaces';
 import { Scope } from './scope';
 import { Session } from './session';
 
@@ -552,10 +553,10 @@ function hasHubOnCarrier(carrier: Carrier): boolean {
  * @hidden
  */
 export function getHubFromCarrier(carrier: Carrier): Hub {
-  if (carrier && carrier.__SENTRY__ && carrier.__SENTRY__.hub) return carrier.__SENTRY__.hub;
+  if (carrier && carrier.__SENTRY__ && carrier.__SENTRY__.hub) return carrier.__SENTRY__.hub as Hub;
   carrier.__SENTRY__ = carrier.__SENTRY__ || {};
   carrier.__SENTRY__.hub = new Hub();
-  return carrier.__SENTRY__.hub;
+  return carrier.__SENTRY__.hub as Hub;
 }
 
 /**

packages/hub/src/index.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line deprecation/deprecation
-export { Carrier, DomainAsCarrier, Layer } from './interfaces';
+export { DomainAsCarrier, Layer } from './interfaces';
 export { addGlobalEventProcessor, Scope } from './scope';
 export { Session } from './session';
 export {
@@ -12,3 +12,6 @@ export {
   makeMain,
   setHubOnCarrier,
 } from './hub';
+
+// For backwards compatibillity
+export { Carrier } from '@sentry/types';

packages/hub/src/interfaces.ts

@@ -1,6 +1,5 @@
-import { Client } from '@sentry/types';
+import { Carrier, Client } from '@sentry/types';
 
-import { Hub } from './hub';
 import { Scope } from './scope';
 
 /**
@@ -12,28 +11,6 @@ export interface Layer {
   scope?: Scope;
 }
 
-/**
- * An object that contains a hub and maintains a scope stack.
- * @hidden
- */
-export interface Carrier {
-  __SENTRY__?: {
-    hub?: Hub;
-    /**
-     * Extra Hub properties injected by various SDKs
-     */
-    extensions?: {
-      /** Hack to prevent bundlers from breaking our usage of the domain package in the cross-platform Hub package */
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      domain?: { [key: string]: any };
-    } & {
-      /** Extension methods for the hub, which are bound to the current Hub instance */
-      // eslint-disable-next-line @typescript-eslint/ban-types
-      [key: string]: Function;
-    };
-  };
-}
-
 /**
  * @hidden
  * @deprecated Can be removed once `Hub.getActiveDomain` is removed.

packages/types/src/hub.ts

@@ -226,3 +226,29 @@ export interface Hub {
    */
   captureSession(endSession: boolean): void;
 }
+
+/**
+ * An object that contains a hub and maintains a scope stack.
+ * @hidden
+ */
+export interface Carrier {
+  __SENTRY__?: {
+    hub?: Hub;
+    /**
+     * Extra Hub properties injected by various SDKs
+     */
+    extensions?: {
+      /** Hack to prevent bundlers from breaking our usage of the domain package in the cross-platform Hub package */
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      domain?: { [key: string]: any };
+
+      /** Hack to prevent bundlers from breaking our usage of the these functions in the cross-platform Utils package */
+      unsafeToBase64?: (plaintext: string) => string;
+      unsafeFromBase64?: (base64String: string) => string;
+    } & {
+      /** Extension methods for the hub, which are bound to the current Hub instance */
+      // eslint-disable-next-line @typescript-eslint/ban-types
+      [key: string]: Function;
+    };
+  };
+}

packages/types/src/index.ts

@@ -8,7 +8,7 @@ export { Event, EventHint } from './event';
 export { EventProcessor } from './eventprocessor';
 export { Exception } from './exception';
 export { Extra, Extras } from './extra';
-export { Hub } from './hub';
+export { Carrier, Hub } from './hub';
 export { Integration, IntegrationClass } from './integration';
 export { LogLevel } from './loglevel';
 export { Mechanism } from './mechanism';

packages/utils/src/compat.ts

@@ -1,4 +1,4 @@
-import { Integration } from '@sentry/types';
+import { Carrier, Integration } from '@sentry/types';
 
 /**
  * Checks whether we're in the Node.js or Browser environment