meld default data into main SampleContext type so it appears in type hints

Author: lobsterkatie

packages/minimal/src/index.ts

@@ -207,7 +207,7 @@ export function _callOnClient(method: string, ...args: any[]): void {
  *
  * @param context Properties of the new `Transaction`.
  * @param customSampleContext Information given to the transaction sampling function (along with context-dependent
- * default values)
+ * default values). See {@link Options.tracesSampler}.
  */
 export function startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction {
   return callOnHub('startTransaction', { ...context }, customSampleContext);

packages/tracing/src/hubextensions.ts

@@ -1,5 +1,5 @@
 import { getActiveDomain, getMainCarrier, Hub } from '@sentry/hub';
-import { CustomSampleContext, DefaultSampleContext, SampleContext, TransactionContext } from '@sentry/types';
+import { CustomSampleContext, SampleContext, TransactionContext } from '@sentry/types';
 import {
   dynamicRequire,
   extractNodeRequestData,
@@ -100,8 +100,8 @@ function sample<T extends Transaction>(hub: Hub, transaction: T, sampleContext:
  *
  * @returns The default sample context
  */
-function getDefaultSampleContext(): DefaultSampleContext {
-  const defaultSampleContext: DefaultSampleContext = {};
+function getDefaultSampleContext(): SampleContext {
+  const defaultSampleContext: SampleContext = {};
 
   if (isNodeEnv()) {
     const domain = getActiveDomain();

packages/types/src/hub.ts

@@ -199,7 +199,7 @@ export interface Hub {
    *
    * @param context Properties of the new `Transaction`.
    * @param customSampleContext Information given to the transaction sampling function (along with context-dependent
-   * default values)
+   * default values). See {@link Options.tracesSampler}.
    */
   startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction;
 }

packages/types/src/index.ts

@@ -23,13 +23,7 @@ export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';
 export { Status } from './status';
-export {
-  CustomSampleContext,
-  DefaultSampleContext,
-  SampleContext,
-  Transaction,
-  TransactionContext,
-} from './transaction';
+export { CustomSampleContext, SampleContext, Transaction, TransactionContext } from './transaction';
 export { Thread } from './thread';
 export { Transport, TransportOptions, TransportClass } from './transport';
 export { User } from './user';

packages/types/src/options.ts

@@ -126,7 +126,8 @@ export interface Options {
    * Tracing is enabled if either this or `tracesSampleRate` is defined. If both are defined, `tracesSampleRate` is
    * ignored.
    *
-   * Will automatically be passed a context object of default and optional custom data. See {@link Hub.startTransaction}.
+   * Will automatically be passed a context object of default and optional custom data. See
+   * {@link Transaction.sampleContext} and {@link Hub.startTransaction}.
    *
    * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent).
    */

packages/types/src/transaction.ts

@@ -50,17 +50,6 @@ export interface Transaction extends TransactionContext, Span {
   setName(name: string): void;
 }
 
-/**
- * The context passed to the tracesSampler function by default.
- */
-export interface DefaultSampleContext {
-  /** Object representing the URL of the current page or woker script. Passed in a browser or service worker context */
-  location?: Location | WorkerLocation;
-
-  /** Object representing the incoming request to a node server. Passed when in a node server context. */
-  request?: ExtractedNodeRequestData;
-}
-
 /**
  * Context data passed by the user when starting a transaction, to be used by the tracesSampler method.
  */
@@ -69,7 +58,19 @@ export interface CustomSampleContext {
 }
 
 /**
- * The data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
- * Combination of default values (which differ per SDK/integration) and data passed to `startTransaction`.
+ * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
+ *
+ * Adds default data to data provided by the user. See {@link Hub.startTransaction}
  */
-export type SampleContext = DefaultSampleContext & CustomSampleContext;
+export interface SampleContext extends CustomSampleContext {
+  /**
+   * Object representing the URL of the current page or worker script. Passed by default in a browser or service worker
+   * context
+   */
+  location?: Location | WorkerLocation;
+
+  /**
+   * Object representing the incoming request to a node server. Passed by default in a node server context.
+   */
+  request?: ExtractedNodeRequestData;
+}